Actionflow Properties

 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

FieldDescription
NameThe name of the Actionflow.
DescriptionA short explanation of the Actionflow's purpose.
Tooltip

Available in PhixFlow version 11.1 onwards.

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  Actions tab.

Actionflow Icon

Available in PhixFlow 11.1.1+

A custom icon for the Actionflow.

Upload a new icon by clicking the  icon or choose an image already uploaded to the application by clicking .

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 runningWhere 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 Adding 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 Actionflow Node Connections.

Output Connections

Displays the output connection points going out of the Actionflow, and their Type.

API

This section is visible in PhixFlow version 11.0.0 - 11.0.2. From PhixFlow version 11.1.1+, API Endpoints are a separate feature, see API Endpoint Properties.

FieldDescription
API End-Point

Enable the to setup the Actionflow as an API endpoint. API endpoints can be set up in PhixFlow to enable external systems to make calls to PhixFlow.

API endpoints have a  icon on the Actionflow home screen.

See PhixFlow Incoming API .

Allow Anonymous Connections

Available only when API End-Point is .

This allows anyone with the URL for the API to call it, the audit trail records the system as running performing the API call.

API Mode

(Available in PhixFlow version 11+)

Choose if the Actionflow should:

  • Wait for result (Synchronous) (Default): The API waits for the results or the timeout to occur. Note: If the timeout occurs the command is aborted.
  • Poll for result (Asynchronous): The API is called and a response is returned immediately including the process ID. Subsequent API calls can be made using the process ID to fetch the status of the action. The asynchronous mode can be thought of as “fire and forget”.

URL

(Available in PhixFlow version 11+)

Displays the URL for the API that is used to call it. This field is read only.

Advanced

FieldDescription
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

Property pages related to Actionflows:

Use Actionflows to configure functionality for applications made in 9.0 or later: Understanding Actionflows

For applications made in 8.3 or earlier, use table-actions: Configuring Actions.