Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Basic Settings
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??
A stream view can have a default action set against it
When the user double-clicks on a record in the stream view, PhixFlow runs the default action.
You can configure the action behaviour based on the data in the record.
Progress Indicator Settings
Context Parameters
Use context parameters to specify conditions that apply to the action
Update Parent Contextcheck_box_untickcheck_box_untick to not send any context parameter values to the dashboard that initiated the action.tickedticked send context parameter values to the dashboard that initiated the action.
A grid listing the context parameters. Double-click to open the properties for a context parameter
Confirmation Message
Example 1
Validate dashboard dashboard element dashboard view with database elementWhen the action runs, PhixFlow
A which of the listed Stream Item Actions will run. Double-click a rule to open its properties and specify rule details and attributes: see Stream Item 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 action rules in order. For each action rule that evaluates to true, PhixFlow will run that action.
The action type of the first action rule is overwritten if the button that initiates the action has both an Action Type and an Action; see Layout.
The grid contains a list of task plans and their associated expression. The expression is the rule to determine whether the task plan runs.
To add a task plan to the list:
ClickTo add an expression, double-click the task plan in the grid to open a task plan rule property tab.
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:
- Order: The order in which the rules are evaluated.
- Task Plan: The task plan that will be run if the accompanying expression evaluates to true.
- Expression: If this expression evaluates to true, this task plan will be run. A blank (null) expression counts as true.
See Task Plans for details.
Action Completion
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.
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 dashboard openedFor each dashboard rule define the following fieldsDashboard dashboard opened dashboard opened once the action has completedResultAccess Permissions
For details about how to control access to an action, see Common Properties → Access Permissions.
Advanced
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 { }
. PhixFlow evaluates each expression in turn before displaying the message.
For result messages that report on the status of the action, you can use the following internal variables in the expressions:
- _error: Details of the error messages generated.
- _errors: The number of error messages generated.
- _warning: Details of the warning messages generated.
- _warnings: The number of warning messages generated.
- _messages: The number of warning messages generated.
- _taskPlan: The name of the Task Plan that the Action ran (may be null)
- _runId: The runId of any Stream data generated by this Action (may be null).
- _action: The name of the Action.
- _file: Details of files processed (imported or exported) by the Action.
- _fileCount: The number of files processed by the Action.
Code Block | ||
---|---|---|
| ||
Action {_action} failed with {_errors} errors and {_warnings} warnings. |
You can also use context parameters and values to report different messages. For example if you have a context parameter (called balance
) that calculates the outstanding balance, you can use an expression that reports different messages depending on the calculated value.
Code Block | ||
---|---|---|
| ||
{if(_context.balance < 0,"Money still owed", "Balance paid")} |
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
either from the drop-down list of all forms views in PhixFlow
or clickValues entered in the form view are referenced in expressions in the action with the form.
Code Block |
---|
_prompt.<form field name> |
Name
, then the Form View dashboard Context Parameters dashboard