Page Comparison

_action is available on any Expression within Stream Action objects and gives the name of the Action.

Within Expressions evaluated for CalculateBySet Stream and Aggregate Stream, it is possible to set up Cached Attributes which can be used to store and retrieve cached data while processing a Candidate Set. To refer to a cached attribute value, e.g. the sum of invoice values so far while processing a Candidate Set, use an expression like _cache.invoiceTot + _current.invoiceValue

This variable is available when using the an in-memory Stream and contains the record matching the key attributes.

When using the attribute function cache _cacheValue contains the value retrieved from the cache associated with the key value supplied. This variable is only available within the function evaluation; that is, the value retrieved is only available in the list of expressions used in the call to the function cache.

Used as a prefix to reference the context parameter values that have been configured within a Stream Action using the notation _context.<ContextParameter Name>. Please see Stream Action Form for more details on how to use it.

_count provides the number of Stream Items in the current Candidate Set. _count is used on CalculateBySet and Aggregate Streams.

If you want to know how many items have been returned by a Lookup Pipe or the number of items returned by a specific Pipe for the current Candidate Set then use the countElements() function.

_current is only available when a Stream is configured to carry out Calculate by Set processing. _current refers to the current input Stream Item being processed within the Candidate Set. Note that _current is needed because if you attempt to refer to the Stream Item using the name of the Pipe e.g. in.accountNum that Expression would return an Array of all the values of accountNum in the current Candidate Set for Pipe in. Instead of using in.accountNum you should use _current.accountNum.

_current is most often used in Stream Attribute Expressions but is also used in objects connected to Streams e.g. Pipes, Database Collectors and File Collectors.connected to Streams e.g. Pipes, Database Collectors and File Collectors.

_error contains the details of one or more error messages, and may be used in various contexts.

The detail fields are:

_errors contains the number of error messages generated during the running of a Task Plan.

This variable can be used in the Task Plan user notification rules to specify for example that an email should only be sent if there are more than a certain number of error messages.

This variable can also be used in the subject line and email body expressions.

_fieldName can be used within Stream Attribute Expressions. It represents currently processed stream attribute.

_fieldName contains the name of the field (stream attribute name) whose expression is currently being evaluated. This can be helpful for debug messages or user generated error messages.

_file contains the details of one or more files that have been processed.

The file details are:

_fileCount contains the number of files processed during the running of a Task Plan.

This variable can be used in the Stream Action result message.

_fileName can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_fileName contains the name of the file that provided the current input Stream Item.

_fileName must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._fileName.

_filePathList is set to a list of the files that were received as attachments to the same email as that of the attachment currently being processed.

The full path of each file is shown. Individual file paths are separated by semi-colons (;).

This variable is only populated when reading from a File Collector with the Source Type set to Managed File

Contains a list of names of files that have been uploaded by the Stream Action.

Available when a user is entering values in a form - a type of stream view. Current form view values can be referred in Selection Views by using the _form variable (e.g. in background filters). Can be also referred in Stream Actions.

_fromAddr is set to the email address from which this email was sent.

This variable is only populated when reading from a File Collector with the Source Type set to Managed File

Refers to the start date and time of the Stream Set currently being referenced / calculated. For Periodic Streams the time element will be zero (i.e. midnight at the start of the day).

_fromDate is most often used in the SQL field of Database Collectors to restrict the query to return data based on the dates being processed. It is also used in the Name field of File Collectors, File Exporters etc. to generate date specific names.

_importedDate is set to the date and time that the file was received by or uploaded to PhixFlow

It is only populated when reading from a File Collector with the Source Type set to Managed File

An Input Multiplier Array can be generated by entering an Expression into the Input Multiplier field for a Stream. This causes the Stream to repeat its entire processing cycle for each entry in the Input Multiplier Array to create a single Stream Set. During this processing, _inputMultiplier refers to the element in the Input Multiplier Array that has initiated the current processing cycle.

_inputMultiplier is most often used in Stream Attribute Expressions but is also used in objects connected to Streams especially the SQL field on a Database Collector.

This provides the position of the current Stream Item within the Candidate Set being processed.

_itemNumber is used within Expressions on Calculate by Set Streams and is especially useful for de-duplicating data.

_key is made available on Merge, Calculate by Set and Aggregating Streams. _key is an Array of the values of the current Group By Attributes which were used to construct the Candidate Set. E.g if the Group By Attributes were AccountNum and InvoiceNum then _key[1] would refer to the AccountNum and _key[2] to the InvoiceNum for the current Candidate Set.

_key is most often used in Stream Attribute Expressions.

_keyList is made available in Collector statements when a Collector is connected using a Directed Pipe as an input into a Merge or Aggregating Stream. _keyList is an Array of the first elements of many Group-By Attribute values which are being used to construct the Candidate Set.

E.g if the Group By Attribute was AccountNum, then _keyList would be set to an array of account numbers: ['ac1','ac2','ac3'] - the number of elements in the array is variable, up to the workerSize specified on the pipe from the collector to the Merge/Aggregating Stream.

The _keyList would then be used in the Collector statement, e.g.

	select * from a_table
	where a_field in ({_keyList})
	order by a_field

_lineNumber can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_lineNumber contains the position of the current input Stream Item within the file.

The _lineNumber attribute is not available for File Collectors of Type File Details Only

_lineNumber must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._lineNumber.

_messages contains the total number of messages generated during the running of a Task Plan.

This variable can be used in the Task Plan user notification rules.

This variable can also be used in the subject line and email body expressions.

_modifiedDate can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_modifiedDate contains the datetime of when the file that provided the current input Stream Item was last modified.

The last modified time of a single file residing within a .gz or a .tgz container can not be determined by phixflow, instead the datetime of when the corresponding gz/tgz container was created will be returned.

_modifiedDate must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._modifiedDate.

Refers to the Stream Item currently being created. E.g. to use the value of a Stream Attribute "account" that has already been calculated, use _out.account.

Note that you should ensure that the Stream Attribute will have been evaluated before it is referred to.

_out is most often used in Stream Attribute Expressions but is also used in objects connected to Streams e.g. Pipes, Database Collectors and File Collectors.

An Output Multiplier Array can be generated by entering an Expression into the Output Multiplier field for a Stream. The Output Multiplier is calculated at the start of each Candidate Set and causes the Stream to repeat its output Stream Item generation processing step for each entry in the Output Multiplier Array.

Note that unlike the _inputMultiplier which repeats the entire Stream processing for each Array entry (e.g. refetching data from Input Pipes) the Output Multiplier just repeats the final output Stream Item calculation. During this processing, _outputMultiplier refers to the element in the Output Multiplier Array that is being used for the current output Stream Item.

Currently this internal variable can only be used in Stream Action Validation Expressions. It refers to the prompted action attribute values that are manually entered by the user when an action is executed.

%PASSWORD% is an internal variable designed to enable a collector (or exporter) to pass a stored value to an external location - in this instance the Password which is stored with the httpDatasourceInstance.

_path can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_path contains the full path of the file that provided the current input Stream Item.

_path must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._path.

_pipeItemNumber is available on Calculate by Set Streams and is useful when the Stream has two or more Input Pipes.

_pipeItemNumber is similar to _itemNumber but returns the position of the current input Stream Item within the Pipe being processed.

_pipeName contains the name of the current pipe when processing Input Stream Items for Calculate by Set and Calculate Streams. Note that this is useful since these Stream functions process their Input Pipes sequentially and it may be necessary to know which Pipe is being processed (e.g. because their Stream Attributes have different names).

Used within Filters with notation _prompt.LABELNAME to indicate that a value will be prompted for in a user popup window. The popup window will display the LABELNAME for which the corresponding value must be entered before the filter is fully evaluated. Note that the LABELNAME must contain all English alphanumeric characters or underscore and must begin with an alpha character.

Note that each popup field will only accept a single string literal. Hence the other available phixflow functions must be used within the filter expression itself to correctly evaluate the user input to other datatypes/arrays i.e toNumber(_prompt.USERINPUTNUMBER) or split(_prompt.USERINPUTARRAY,",")

It is only used within the context of filters.

_response contains the response (success or failure) returned from an HTTP Export.

It is only populated in this context.

_rootDirectory can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_rootDirectory contains the root base directory (if specified) of the file that provided the current input Stream Item concatenated with the value evaluated in the Collector's 'Input Directory Expr' field.

_rootDirectory must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._rootDirectory.

_runId contains a unique identifier of an individual stream set

_sentDate is set to the date and time that the file was sent to PhixFlow

It is only populated when reading from a File Collector with the Source Type set to Managed File

_size can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_size contains the size of the file that provided the current input Stream Item in bytes.

The size of a single file residing within a .gz or a .tgz container can not be determined by phixflow, instead a size of -1 will be returned.

_size must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._size.

_source contains the source of the set of files being collected. Possible values are:

It is only populated when reading from a File Collector with the Source Type set to Managed File

_subDirectory can be used within Stream Attribute Expressions in cases where the Stream has data coming from a File Collector.

_subDirectory contains the sub directory relative to the _rootDirectory in which the corresponding file that provided the current input Stream Item resides.

_subDirectory must be prefixed with the name of the Pipe linking the File Collector to the Stream e.g. in._subDirectory.

_subject is set to the subject of the email when a File Collector is processing a file received as an attachment to an email.

This variable is only populated when reading from a File Collector with the Source Type set to Managed File

_success contains a true or false value depending on the outcome of an HTTP Export.

It is only populated in this context.

_suspended contains the suspended status of a Task Plan when it has finished running.

This variable can be used in the Task Plan user notification rules to specify for example that an email be sent to a user to tell them that a problem needs to be investigated and the Task Plan must be un-suspended before it can run again.

This variable can also be used in the subject line and email body expressions.

_taskPlan contains the name of a Task Plan and can be used to include the name of the task plan in the user notification rules, subject line or body of emails generated by the task plan.

This variable refers to the entire Candidate Set. Within a Merge the expression '_this.name' would retrieve the name field from all records from all pull pipes. For a Merge this is equivalent to referring to the 'name' attribute without specifying a pipe.

For a Calculate with multiple Input Pipes the expression '_this.name' would retrieve the name field from all records on the pull pipe currently being processed (since each pipe on a calculate is processed separately).

_toAddress is set to a list of the email addresses to which this email was sent. The addresses are separated by semi-colons (;).

This variable is only populated when reading from a File Collector with the Source Type set to Managed File

Refers to the end date and time of the Stream Set currently being referenced / calculated and is used in a similar way to _fromDate.

This has been renamed to _outputMultiplier

The _url internal variable is set for Http Collector and Exporter Url expressions to the value of the Url field on the httpDatasourceInstance used.

It is only populated in this context.

The _user internal variable is set in all contexts to the details of the current logged in user.

_user has the following attributes:

eg : _user.name

%USERNAME% is an internal variable designed to enable a collector (or exporter) to pass a stored value to an external location - in this instance the Username which is stored with the httpDatasourceInstance.

_warning contains the details of one or more warning messages, and may be used in various contexts.

See _error for message properties.

_warning contains the number of warning messages generated during the running of a Task Plan.

This variable can be used in the Task Plan user notification rules to specify for example that an email should only be sent if there are more than a certain number of warning messages.

This variable can also be used in the subject line and email body expressions.