This page is for application designers. It explains the properties you can set for actions.
Creating Actions
To create an action:
Actions created this way appear in the repository in Actions. You can also export this type of action.
Optionally, you can also create an action that belongs to a stream. This option is available for backwards compatibility with applications designed with earlier versions of PhixFlow, that did not have micro-actions.
You can create actions on layout components, such as buttons. You can also create actions in grid cells that contain:
- strings
- numbers
- dates or date-times
- boolean true/false.
?? Once configured, an action can be dragged onto stream views associated with the Stream on which the Action is configured to create a set of Action Buttons which appear on the top of the Stream View. Actions can also be dragged into the menus belonging to an Application.
See Configuring Actions for related pages.
The following fields are configured for actions:
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
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 Context
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
A grid listing the context parameters. Double-click to open the properties for a context parameter
Confirmation Message
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:
Please confirm that you want to apply action Action Name
To provide a customised confirmation message, use the next field.
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.
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:
- any values entered on the Form View using:
Code Block |
---|
_prompt.<Form Field Name> |
- the values of any Context Parameters using:
Code Block |
---|
_context.<ContextParameter Name> |
- any attributes of any records selected on the view or dashboard from which the action was initiated using:
Code Block |
---|
<View name or alias>.<Attribute name or alias> |
List of names of uploaded files can be accessed through _files
variable.
Action Validation
The validation expression is evaluated at the start of any 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 A on A - this will stop the action from being completed 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. If none of the expressions evaluates to true, no dashboard will be opened.
For each dashboard rule define the following fields:
- Order: The order in which the rules are evaluated.
- Dashboard: The dashboard that will be opened if the accompanying expression evaluates to true.
- Expression: If this expression evaluates to true, this dashboard will be opened once the action has completed. A blank (null) expression counts as true.