Actionflow Properties
- Fiona Sargeant (Unlicensed)
- Zoe Baldwin
- Anthony George
Properties Tab
Parent Details
The name of the container that this item is within or belongs to, if applicable. See Parent Details on Common Properties.
Basic Settings
| Field | Description |
|---|---|
| Name | The name of the Actionflow. |
| Description | A short explanation of the Actionflow's purpose. |
| Tooltip | Specify a custom tooltip that displays where the Actionflow is used in grid cells. This tooltip can be overridden by a tooltip set on the View Attribute |
Actionflow Icon | A custom icon for the Actionflow. Upload a new icon by clicking the |
Show in the Repository | Turns on or off if the Actionflow appears in the Repository. |
Exclusion Group | This field is case insensitive. If this field is populated, only one Actionflow with this Exclusion Group can be running at any one time. Attempting to run a second Actionflow with the same exclusion group will return a warning and the Actionflow will not run. This applies whether the Actionflow is run manually or automatically using a schedule. Exclusion Group are evaluated before any Actionflows are started. If there is no Actionflow already running with this exclusion group then the Actionflow will continue. The action will be considered to be using this exclusion group from this point until the Actionflow has completed. |
| Validate before running | Where validation has been set on form fields, switching this on performs the validation check before the Actionflow runs. If the validation fails, the Actionflow does not run and informs the user of the error(s). See Validation. |
Allow to Run with Validation Errors | Where validation fails, the user is informed of the error(s) and is given the option to still run the Actionflow. |
Actions
Displays the actions in the Actionflow, e.g. Calculate, Open Screen.
Input Connections
Displays the input connection points coming into the Actionflow, and their Type. See Understanding Connection Points.
Output Connections
Displays the output connection points going out of the Actionflow, and their Type.
Log File Retention Settings
Use the Log File Retention Settings to decide how log files are treated.
Note: Whilst actions are running the entire log file is available, but when the action completes, the log file is deleted or retained depending on the below settings.
System Messages
| Field | Description |
|---|---|
| Always Retain | Log files are never deleted upon completion. |
| Retain if Warning or Error message received | Log files are automatically deleted upon completion, unless a warning or error message was written to the log. |
| Retain if Error message received | Log files are automatically deleted upon completion, unless an error message was written to the log. |
| Never retain | Log files are always deleted upon completion. |
User Messages
| Field | Description |
|---|---|
| Always Retain | Log files are never deleted upon completion. |
| Retain if Info, Warning or Error message received | Log files are automatically deleted upon completion, unless an info, warning or error message was written to the log. |
| Retain if Warning or Error message received | Log files are automatically deleted upon completion, unless a warning or error message was written to the log. |
| Retain if Error message received | Log files are automatically deleted upon completion, unless an error message was written to the log. |
| Never retain | Log files are always deleted upon completion. |
Advanced
| Field | Description |
|---|---|
| Prioritise throughput over ordering | When enabled, records are processed in parallel to optimise performance. This means the order records are processed is nondeterministic. When disabled (default), records are processed in the order they are provided. |
| Allow Parallel Runs from One Client | When enabled, allows an Actionflow to be run multiple times in parallel from the same client, i.e. another run can be started while the previous run is still being processed. This option is disabled by default. |
Security
Security can be applied to Actionflows so that only those with sufficient permissions can run the Actionflow. In addition, if an Actionflow is assigned to a button and the user does not have permission to run the Actionflow, the button will not be displayed on a screen.
Permissions can also be set on form fields, table attributes and screens. For example, if a user does not have permission to view the form fields but runs an Actionflow that uses these fields, the Actionflow will show an error.