Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Action Properties
Basic Settings
A stream view can have a default action configured. PhixFlow runs the action when the user double-clicks on a record in the stream view.
Enter the name for the default action. PhixFlow displays this action name on a Stream View.
Progress Indicator Settings
Context Parameters
Use context parameters to specify conditions that apply to the action
Update Parent Context not send any context parameter values to the dashboard that initiated the actiontickedticked to send context parameter values to the dashboard that initiated the action.
This property has a toolbar with standard buttons. The grid contains a list of context parameters that affect whether or not the action runs.
To edit the properties of a context parameter, double-click its name. To add a stream item action to the list, clickConfirmation Message
Please confirm that you want to apply action Action Name
To provide a customised confirmation message, use the Confirmation Message property.
File Upload
Use this property for an action that will upload a file.
Enter 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:
_prompt.<Form Field Name>
- the values of any Context Parameters using:
_context.<ContextParameter Name>
- any attributes of any records selected on the view or dashboard from which the action was initiated using:
<View name or alias>.<Attribute name or alias>
You can return a list of the names of uploaded files using the _files
variable.
Action Validation
Enter a validation expression. This 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 them in a do()
clause. A number of internal variables are available in these expressions:
- _this: a reference to all the selected records within the view to perform the action on.
- _prompt: a reference to all the user prompted action attributes.
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.
Note |
---|
Be careful when using the error(message) function. When the action generates an error message it stops running, so does not complete. |
Example 1
Validate that the sum of the selected record amounts equate to zero before allowing the action to be executed.
Code Block |
---|
if(sum(_this.amount) == 0, info('OK'), error('Not performing Action as the Sum does not equate to zero')) |
Example 2
Validate that the user entered comment is at least 10 characters long, else write a warning to the log.
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")} |
Access Permissions
For details about how to control access to an action, see Common Properties → Access Permissions.
Advanced
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> |
For example, if there is a field on the form with the label Name
, then the value entered in that field by the user can be referenced in subsequent expressions as
Code Block |
---|
_prompt.Name |
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
Minimum Items Expr.
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.
Using Variables in Expressions
In actions, the _form, _grid and _gridRow act on a specific record. The record depends on the structure of layout components on the dashboard.
_form
acts on the recordcurrently selected in the view
currently displayed on the form
_grid
acts on the record_gridRow
acts on the record