Insert excerpt |
---|
| _Banners |
---|
| _Banners |
---|
name | TableActions |
---|
nopanel | true |
---|
|
Action Properties
Insert excerpt |
---|
_standard_settings | _standard_settings | nopanel | true |
---|
Basic Settings
Field | Description |
---|
Name | Enter the name of the action. |
Display Name | 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
Field | Description |
---|
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 | Insert excerpt |
---|
_check_box_untick | _check_box_untick | nopanel | true |
ignore any context parameter that were sent to the screen when it was opened.ticktick include the context parameters that were sent to the screen when it was opened. If the action specifies a new context parameter of the same name, the new context parameter will supersede the previous one.
Update Parent Context | Insert excerpt |
untick_check_box_untick to not send any context parameter values to the screen that initiated the action. Insert excerpt |
---|
_check_box_tick | _check_box_tick | nopanel | true |
to send context parameter values to the screen that initiated the action.Context parameters | 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, click Insert excerpt |
---|
_new | _new | nopanel | true |
. PhixFlow opens the Context Parameter properties tab.To remove a context parameter from the action, select it and click Insert excerpt |
---|
_delete | _delete | nopanel | true |
in the toolbar.Confirmation Message
Field | Description |
---|
Ask for Confirmation | Insert excerpt |
---|
_check_box_untick | _check_box_untick | nopanel | true |
to run an action without requesting user confirmation. Insert excerpt |
---|
_check_box_tick | _check_box_tick | nopanel | true |
when a user triggers an action, PhixFlow displays a pop-up message asking them to confirm. By default, the message is:Please confirm that you want to apply action Action Name
To provide a customised confirmation message, use the Confirmation Message property.
Confirmation Message | Optionally, enter your own text to display as the confirmation message. Use the text formatting 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 | Use this property for an action that will upload a file.
Insert excerpt |
---|
_check_box_tick | _check_box_tick | nopanel | true |
to prompt the user to browse to and select the file they want to upload.Tag Expr. | 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 screen 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
Field | Description |
---|
Validation Expression | 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) == Stream Item stream item stream item stream item stream item listed Stream-item-actions will run: see Stream-item-action RuleStream stream Reference Information Reference Information Reference Information Action evaluating Form Context Parameters Records this Task Plan Action Stream 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 ActionAccess Permissions
For details about how to control access to an action, see Common Properties → Access Permissions.
Advanced
Field | Description |
Prevent Parallel ProcessingExample message showing the number of errors and warnings | 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 |
---|
title | Example of different messages around a threshold value |
---|
|
{if(_context.balance < 0,"Money still owed", "Balance paid")} |
a user action multiple times, even if the previous run has not completed_check_box_tick | nopanel | true |
so that a single user cannot run this action more than once at the same time. For example, if a user has started this action, they will not be able to start it again until the first action has finished.Wait for Selection | Insert excerpt |
---|
_check_box_untick | _check_box_untick | nopanel | true |
so that the action can run immediately. Only untick this check box if your action does not depend on any data or context parameters from the screen.checkbox_tickcheckbox_tick so that PhixFlow runs the action after completing any outstanding screenrefresh. This check box is ticked by default to make sure that the action uses the data or context parameters related to the data record selected by the application user.Target view | Enter the name of the stream view to which this action will apply. |
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
either from the drop-down list of all forms views in PhixFlow
or click Insert excerpt |
---|
_table_show | _table_show | nopanel | true |
to open the repository showing all the streams. From the repository, drag a form view from the stream into this field.Values 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
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 expressions screenfrom this greater 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 screenfrom 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.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 screen.
Action expression variable | Where |
---|
Stream view directly on a screen | form on a screen | stream view on a form | form on a card | grid on a card |
---|
_form acts on the record | currently selected in the view
currently displayed on the form
currently displayed on the form | currently displayed on the cardbacking the card | _grid acts on the record | currently selected in the view | currently selected in the view |
_gridRow acts on the record | current record