Flow Chart Action

Exports a new flow chart to an engine. The flow chart can be loaded from a flow chart XML file or the repository. The newly created flow chart can be populated with flow chart variables. The newly created flow chart overwrites any existing flow chart with the same name that may already exist.

At the end of the Flow Chart Action, the current database transaction is committed implicitly. Assuming a fatal error does not occur, the new flow chart is committed to the database at the end of execution of the Flow Chart Action. Once committed to the database, the newly exported flow chart is eligible for execution by an engine.

By default, the newly spun off flow chart runs synchronously, until it completes, before this flow chart action finishes. However, the Flow Chart Action can be configured to create the new flow chart and continue executing immediately, without waiting for the new flow chart to finish running first.

Properties

Asynchronous

Indicates whether this flow chart action waits synchronously — or does not wait (asynchronous) — for the newly spun off flow chart to finish running before this flow chart action completes. By default, the newly spun off flow chart runs synchronously, until it completes, before this flow chart action finishes.

Filename

The filename of a flow chart XML file to use when exporting a new flow chart to an engine. The filename can be an absolute or relative pathname to a file. At runtime, the engine first checks the class path for the flow chart XML file. If it cannot be found, then the file system is checked next.

Typically your flow chart XML file will have the extension .ffc, for example: MyFlowChart.ffc.

You must set either this property or the repository namespace property for this action to execute (to instruct Flux on where to find the flow chart that this action will run).

Namespace

The namespace that the new flow chart will use when it runs. When the Flow Chart Action executes, it will create the new flow chart, assign it a name according to this property, and export the flow chart.

This can be an absolute namespace like the following:

/MyBranch/MyFlowChart

Or it can be relative, which means the new namespace will be assigned based on the namespace of the flow chart where the Flow Chart Action runs.To set a relative namespace instead of an absolute namespace, just remove the leading "/" character from the namespace property.

For example, if the Flow Chart Action runs from the namespace:

/MyFlowChartActionBranch/

And the namespace property on the Flow Chart Action is set to:

NewFlowChart

Then the new flow chart will run with the full namespace:

/MyFlowChartActionBranch/NewFlowChart

This property is not required. If you do not set a namespace, the namespace of the new flow chart will be taken instead from the name of the flow chart as retrieved from the file system or the repository.

Note that the namespace is not used to look up the flow chart that will be executed - it is only used to assign a name to the flow chart, after it has already been loaded (from either the file system or the repository).

Overwrite

Indicates whether the new flow chart exported to an engine will overwrite an existing flow chart or simply modify an existing flow chart.

If no flow chart exists at the location where the new flow chart will be exported, this property has no effect.

However, if such a flow chart does exist and overwrite is enabled, this Flow Chart Action first removes that flow chart before exporting the new flow chart.

On the other hand, if such a flow chart does exist and overwrite is disabled, this Flow Chart Action attempts to modify that existing flow chart using the properties of the new flow chart.

By default, the overwrite property is enabled.

Repository Namespace

The repository location of the flow chart to use when exporting a new flow chart to an engine. This should be the full namespace (including the flow chart name) of a flow chart that is stored in the repository. For example:

/MyFlowChart

or

/MyNamespace/MySubNamespace/MyFlowChart

You must set either this property or the filename property for this action to execute (to instruct Flux on where to find the flow chart that this action will run).

Variables

The variables used to initialize the flow chart variables of the created flow chart.

Result Properties

Result

The fully qualified name of the new flow chart that this Flow Chart Action exported to an engine.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.