Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
indent14px
stylenone

...

  • the file exporter name in the repository browser
  • the file exporter icon in a model.

...

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
NameEnter a name for this file exporter.
Enabled
Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to indicate you have completed the settings and the file exporter is ready to use.
File Name (Expr)Enter an expression to generate the name of the file being exported. It must evaluate to a plain text string, and can include text expressions. You can use the internal variables:
  • _fromDate: the start date of the period of the stream being processed.
  • _toDate: the end date of the period of the the stream being processed.
  • _inputMultiplier: the value returned by the input multiplier, if one is being used.
Output Directory (Expr)

Optionally, enter anexpressionto generate the name of the directory into which generated files should be written. It must evaluate to a plain text string.

Note

As this is an expression field, you must surround plain text paths with quotes.

Directory separators must always be a forward slash /, for example  "C:/data/address/export/". Never use a backslash \ even if the output file will be written to a directory on a Windows operating system.

You can use the internal variables:

  • _fromDate: the start date of the period of the stream being processed.
  • _toDate: the end date of the period of the the stream being processed.
  • _inputMultiplier: the value returned by the input multiplier, if one is being used.

If you do not enter an expression or if the expression evaluates to blank, when you run the analysis model:

  • PhixFlow does not save the generated file to disk
  • PhixFlow checks that you have completed the options in the Send By Email section.
FTP Site

Select an FTP site to which the generated file will be moved. For details about how to add sites to this list, see FTP Site. FTP directory paths must be the full path to the file because PhixFlow ignores the local machine's base directory specified in System Configuration.

If you do not select a site, PhixFlow assumes the output file will be saved on the local machine.

Ignore Base Directory

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to prepend the base directory to the location specified in Output Directory.  The local machine's base directory is set in the System Configuration tab → System Directories section.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 PhixFlow uses the location specified in Output Directory as the full path for the export file.

Export File As

You can export files in the following formats:

Comma Separated Values: Data will be read from a single push pipe and written to CSV files.

Excel Spreadsheet: Data will be read from a single push pipe and written to Excel Spreadsheet files.

If the push pipe has a drill-down view with an Excel template specified, this will be used to export the data. Optionally, use the Excel Template field for this file exporter. Specify an Excel template, which will supersede any template specified on the push pipe drill-down view.

If you specify an Excel Template, each output file is generated by copying the Excel template file and overwriting the values in the first worksheet. In this case, the type of file generated is the same as that of the template.

If you do not specify an Excel Template, each output file is generated by creating a new, empty Excel file and writing values to the first and only worksheet. In this case, the file type is the extension generated by the File Name Expression field.

.xls will generate a file in Microsoft Office 2003 Excel format.

.xlsx or .xlsm will generate a file in Microsoft Office 2007 Excel format.

Any other extension will generate a file in the format configured in System Configuration →  Default Export Excel Version..

Excel Spreadsheet (Multiple Inputs): Data will be read from all input pipes and written to Excel spreadsheet files. At least one input pipe must be a push pipe.

The Excel Template Expression must evaluate to the name of an Excel template file. The Excel template must be annotated with instructions to the exporter to insert data from any of the input pipes into specific ranges of cells. See File Exporter Excel Multi-input.

HTML File: Data will be read from a single push pipe and written to HTML files.

If the push pipe has a drill-down view with an Excel template specified, this will be used to export the data. Optionally, use the Excel Template field for this file exporter. Specify an Excel template, which will supersede any template specified on the push pipe drill-down view.

If you specify an Excel Template, each output file is generated by copying the Excel  template file and overwriting the values in the first worksheet. In this case, the type of file generated is the same as that of the template.

If you do not specify an Excel Template, each output file is generated by creating a new, empty Excel file and writing values to the first and only worksheet, then writing that worksheet out as HTML.

Overwrite existing fileThe file exporter overwrites existing files with the same name as the file to be generated. This can be useful where you want PhixFlow to replace a file at regular intervals, for example to update the content of an HTML page on an intranet.
Maximum Records per FileEnter the maximum number of records that will be written to each file.
Header
Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to include a header line in the exported files. The header row contains the name of each field.
Character Set
Insert excerpt
_character_set
_character_set
nopaneltrue
Other Character SetAvailable when Character Set is Other. Enter a different character set. For the full list of available character sets, see the Oracle Java documentation about encoding; you can use the canonical names from either column.
Line Separator Style

When PhixFlow generates the file, it uses the line separator configured in System Configuration →  Advanced section → Line Separator Style. If this is not set, Phixflow uses the default for the operating system on which the PhixFlow server is running.

You may want to generate an export file that uses a different line separator, for example if PhixFlow runs on Linux, but the file will be sent to Windows users. To set a different line separator, select:

  • Windows
  • Unix
  • Other -  see Line Separator Chars, below
Line Separator Chars

Available when Line Separator Style is Other. Enter either a single character or multiple characters to use as a new line separator. The characters may be the literal characters or a sequence from the table below. These sequences are useful if the required separator character is not valid to be stored in the database.

SequenceDescription
\ttab
\nnewline
\rcarriage return
\fform feed
\u + hexadecimal codeunicode character specified by the hexadecimal code


Column Separator
Insert excerpt
_column_separator
_column_separator
nopaneltrue
Separator Character
Insert excerpt
_separator_character
_separator_character
nopaneltrue
Excel Template

Available when Export File As is one of following:

  • Excel Spreadsheet (Multiple Inputs): enter an expressionthat evaluates to an Excel template.
  • Excel Spreadsheet or HTML File: enter the name of the Excel template.
Evaluate Formulae Before Saving File
Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to generate the export file and then to evaluate any formula in the spreadsheet before saving the file. When a user opens the file in Excel, the calculations have already been done.
Quote Style
Insert excerpt
_quote_style
_quote_style
nopaneltrue
Quote Character
Insert excerpt
_quote_character
_quote_character
nopaneltrue

...

FieldDescription
TO Expression

Enter a PhixFlow expression to calculate the recipients for the email. The recipients returned by this expression will be added to the list of recipients returned by the individual User Notification Rule on the Email Recipients section.

For example to simply enter a list of email addresses, you can enter an expression such as: ["john.smith@acme.com","jane.doe@corp.com"]
The result of the expression must be:

  • either a single plain text string that should be a valid email address
  • or a list object that contains one or more strings, each of which must be a valid email address.
CC ExpressionAs in the TO Expression, the list of users returned by this expression will be included on the CC line on the email.
BCC ExpressionAs in the TO Expression, the list of users returned by this expression will be included in the BCC line on the email.


For help about other settings, see Form Descriptions.