...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
The table below is a comprehensive list of all Internal Variables and their meaning but as mentioned above, not all of these are available on all Expressions. Please refer to the individual form help pages for details of the Internal Variables available on each Expression. They are listed in alphabetical order.
...
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
- stream attribute expressions
- stream view attribute label expressions
- formatting rule expressions.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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
...
...
...
...
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.
...
When dragging a card on a kanban card container, _kanban contains information about the target card.
Value | Description |
|---|---|
value | The value of the kanban attribute in the target kanban column. |
attribute | The kanban attribute name of the card container. |
headingValue | The value of the kanban heading attribute in the kanban column. |
headingAttribute | The kanban heading attribute name of the card container. |
...
_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 9615724239 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 9615724239 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
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...