Basic Settings
Field | Description |
---|---|
Name | Enter the name of the action. |
Display Name | Enter the name that will be used to display this action on a Stream View ??Where and why does a stream view display an action?? |
Show progress indicator after (ms) | Enter the number of milliseconds which need to pass after the action is submitted before PhixFlow displays a progress indicator. |
In Progress Message | Enter a message that you want the user to see with the progress indicator. If not specified, PhixFlow displays a default progress message. |
In Progress Popup Message | Enter a message to display in a pop-up window. Use the toolbar to format the message text. You can provide additional information to the user to explain what the action is doing. |
Context Parameters
Use context parameters to specify conditions that apply to the action
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Include Previous Context Parameters |
| ||||||||||||||||
Update Parent Context |
| ||||||||||||||||
Context parameters | A grid listing the context parameters. Double-click to open the properties for a context parameter |
Confirmation Message
Field | Description |
---|---|
Ask for Confirmation | If this flag is ticked, a message will pop up asking the user if they want to proceed with the action. By default, the message is:
To provide a customised confirmation message, use the next field. |
Confirmation Message | Optionally, enter your own text to display as the confirmation message. Use the toolbar to format the message. The maximum length for a message string is determined by System Configuration → System Tuning → Maximum Bigstring Size. |
File Upload
Field | Description | ||||||
---|---|---|---|---|---|---|---|
File Upload | If this flag is ticked, users will be prompted to browse to a file and select it for upload when they run this action. | ||||||
Tag Expr. | An expression that sets the value of the tag for the file. You can use this tag in a file collector to read into PhixFlow files that the action has uploaded. The tag expression can refer to:
List of names of uploaded files can be accessed through |
Action Validation
Field | Description | ||||||
---|---|---|---|---|---|---|---|
Validation Expression | The validation expression is evaluated at the start of any stream item Insert or Update actions. If the validation expression generates any error messages (using the error function) then the action is abandoned. The validation expression is not used to decide whether or not to run the selected Task Plan. The validation expression can include multiple statements by wrapping them in a do() clause. A number of internal variables are available in these expressions:
The usual message functions debug(message), info(message), warning(message), and error(message) are all available to be used in these expressions and will result in messages being written to the system console logs. Be careful when using the error(message) function - this will stop the action from being completed. Example 1 Validate that the sum of the selected record amounts equate to zero before allowing the action to be executed.
Example 2 Validate that the user entered comment is at least 10 characters long, else write a warning to the log.
Using values from other views You can also refer to records selected in other dashboard views by using their dashboard element names. E.g. if the dashboard also contains a view with database element name
|
Stream Item Action Rules
When the action runs, PhixFlow
A list of rules that determine which of the listed Stream Item Action (SIA) Micro-Action will run. Double-click a rule to open its properties and specify rule details and attributes: see SIA Micro-Action Rule. This grid displays:
- Order: The order in which the rules are evaluated.
- Stream: The backing stream.
- Name: The rule name.
- Expression: If this expression evaluates to true, this action will be run. A blank (null) expression counts as true.
When the action runs, PhixFlow evaluates the SIA rules in order. The first For each SIA rule that evaluates to true, PhixFlow will run that SIA. Subsequent SIA rules are not evaluated and their SIA are not run.
Note | ||||||||
---|---|---|---|---|---|---|---|---|
The action type of the first stream item action rule is overwritten if the button that initiates the action has both an Action Type and an Action; see Layout.
|
Run Task Plan
Field | Description |
---|---|
Run Selected TaskPlan | Tick this flag if you want to run a task plan as part of the action. Any expression evaluated during this task plan can reference any Context Parameter. |
Task Plan Rules | A list of task plans that can be run for this action, for each one a rule to determine whether the task plan is actually run. The first task plan whose expression evaluates to true will be run. Only this task plan will be run. If none of the expressions evaluates to true, no task plan will be run. Double-click a task plan rule to specify:
See Task Plans for details. |
Action Completion
Field | Description |
---|---|
Close Parent Dashboard | If you tick this flag, the initiating dashboard will be closed once the action has completed. |
Open Post Dashboard | If you tick this flag, a separate dashboard will be opened once the action has completed. The dashboard to open is determines by the Dashboard Rules. These are only available if you have ticked this flag. Any filter of any view on the post dashboard can reference any Context Parameters set on this action. If the specified dashboard is already open it will be brought to the front and refreshed, rather than a second instance of the dashboard opening. |
URL Expression | A URL which will be opened when the Action has completed. This may be provided as a fixed URL or as an expression evaluating to a plain text string. The expression can reference the Form fields, Context Parameters or attributes of Records selected on the view or dashboard from which the action was initiated. |
Dashboard Rules available if Open Post Dashboard | This field is only available if the Open Post Dashboard is ticked. A list of dashboards that can be opened after this action, for each one a rule to determine whether this is the dashboard that will be opened. The first dashboard whose expression evaluates to true will be opened. Only this dashboard will be opened. If none of the expressions evaluates to true, no dashboard will be opened. For each dashboard rule define the following fields:
|
Result
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Result includes Warnings | If ticked, warning messages generated by the Action in the Console log will be displayed as part of the result message. | ||||||||||||||||
Result includes Errors | If ticked, error messages generated by the Action in the Console log will be displayed as part of the result message. | ||||||||||||||||
Result Message Timeout (s) | If specified, the result message will disappear after the given number of seconds. | ||||||||||||||||
| Enter the text for a message that PhixFlow will display when the action has completed. Use the toolbar to format the message. You can use the message to notify the user of a summary of the action, or the to provide information about the completed state. You can include expressions within the message by enclosing each expression in curly brackets For result messages that report on the status of the action, you can use the following internal variables in the expressions:
number of You can also use context parameters and values to report different messages. For example if you have a context parameter (called
|
Access Permissions
Field | Description |
---|---|
All Users Can Run Action | If you tick this box, all users can run this Action, provided they have the basic privilege to run stream actions. If you untick this box, then access to the stream action is controlled by associating the action with user groups. |
User Groups | This field only appears if the All Users Can Run Action box is not ticked. This is a list of the User Groups permitted to run this Action. This list provides the button - press this to bring up the list of user groups. Drag user groups into the list as needed. |
Advanced
Field | Description | ||||
---|---|---|---|---|---|
Prevent Parallel Processing | If you tick this box, a single user will not be able to run this action more than once at the same time. I.e. if a user has started this action, they will not be able to start it again until the first action has finished. | ||||
Form View | You can specify a form view to appear when the user starts the action.They will be able to enter values on this form view, and the values can be used to update selected records for an update action, or populate fields for an insert action. Select a form view from the drop-down list of all forms views in PhixFlow, or by pressing - this brings up the list of streams in PhixFlow; you can select a form view from a stream, and drag it into the form view field. Values entered in the form view are referenced in expressions in the action with the form
For example, if there is a field on the form with the label
If this is an update action, then the form will be pre-populated with the values from the selected record. Where multiple records are selected, then only those values which are common to all the selected records will be displayed. For insert action, when the form pops up all fields will be blank. |
Additional Properties for Update or Delete Actions
Field | Description |
---|---|
Maximum Items Expr. | This field appears if the update action selected is Update or Delete. The expressions entered here must evaluate to a positive whole number. The expression can reference any fields entered on the Form View associated with this action, any attributes of any records selected on the view or dashboard from which the action was initiated and any of the Context Parameters configured for this action. If the number of items selected on the view from which this action is initiated, or retrieved by the filter configured on this action, is greater than this number then an error message will be generated and no updates or deletes will take place. |
Minimum Items Expr. | This field appears if the update action selected is Update or Delete. The expression entered here must evaluate to a positive whole number. The expression can reference any fields entered on the Form View associated with this action, any attributes of any records selected on the view or dashboard from which the action was initiated and any of the Context Parameters configured for this action. If the number of items selected on the view from which this action is initiated, or retrieved by the filter configured on this action, is less than this number then an error message will be generated and no updates or deletes will take place. |