Insert excerpt

	_Banners
	_Banners
name	actionflow
nopanel	true

Insert excerpt
_property_icon
_property_icon
nopanel true
Properties Tab

Parent Details

The name of the container that this item is within or belongs to, if applicable. See Parent Details

on

on Common Properties.

Basic Settings

Field	Description
Name	The name of the Actionflow.
Description	A 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

Insert excerpt

	_property_tabs
	_property_tabs
name	action
nopanel	true

.

Actionflow Icon

A custom icon for the Actionflow.

Upload a new icon by clicking the

Insert excerpt

	_add_icon
	_add_icon
nopanel	true

icon or choose an image already uploaded to the application by clicking

Insert excerpt

	_image_list
	_image_list
name	icon
nopanel	true

.

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

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

Connection Points.

Output Connections

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

API

FieldDescriptionAPI End-PointEnable the

Excerpt

-include_toggle_on_toggle_onnopaneltrueto setup the Actionflow as an API endpoint. Insert excerptPhixFlow Incoming APIPhixFlow Incoming APInameAPI_end_pointnopaneltrue

See PhixFlow Incoming API .

Allow Anonymous Connections

Available only when API End-Point is Insert excerpt_toggle_on_toggle_onnopaneltrue. Insert excerptPhixFlow Incoming APIPhixFlow Incoming APInameAllowAnonymousConnectionsnopaneltrue

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.Understanding Actionflows

name	LogFileRetentionSettings

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

Excerpt

name	PrioritiseThroughputOverOrdering

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.

Insert excerpt
_security_icon
_security_icon
nopanel true
Security

Insert excerpt

Understanding Actionflows

name
Actionflow Security and Permissions
	Actionflow Security and Permissions

security

intro
nopanel	true

Property pages related to Actionflows:

Versions Compared

Old Version 23

New Version Current

Key

Insert excerpt
_property_icon
_property_icon
nopanel true
Properties Tab

Parent Details

Basic Settings

Actions

Input Connections

Output Connections

API

Log File Retention Settings

System Messages

User Messages

Advanced

Insert excerpt
_security_icon
_security_icon
nopanel true
Security

See Also

Page Comparison

Versions Compared

Old Version 23

New Version Current

Key

Insert excerpt_property_icon_property_iconnopaneltrue Properties Tab

Parent Details

Basic Settings

Actions

Input Connections

Output Connections

API

Log File Retention Settings

System Messages

User Messages

Advanced

Insert excerpt_security_icon_security_iconnopaneltrue Security

See Also

Insert excerpt
_property_icon
_property_icon
nopanel true
Properties Tab

Insert excerpt
_security_icon
_security_icon
nopanel true
Security