XenoGuard Documentation

Start

Actions » Programming » Action Script » Start 

The action Start runs a specified action script in the workspace. The action scripts executed by this action are considered child scripts. Note that a called action script must be in its own workspace.

XenoGuard distinguishes between two types of script execution: synchronous and asynchronous execution. In synchronous execution (preset by default), the calling script waits until the child script has been completely processed and terminated. Then, the caller executes its next actions.

Asynchronous execution allows for true concurrent (parallel) execution of scripts. Here, the caller starts the child script but does not wait for it to finish and continues to execute its next actions. The child script runs independently of the caller. For this execution mode, you need at least the Plus or Premium variant of XenoGuard.


[-] Hide
  1. Open the Programming node in the Workspace Explorer.
  2. Open the Action Script node, select the Start action.

Parameters:

The action has the following input parameters:


name Description
File Path
Specifies the path of the ActionScript to start.

Allowed Context Scope
 [Fixed]
Execution Mode
The mode of execution of the child script.

Allowed Context Scope [Fixed]
Allowed Values [Synchronously, Asynchronously]
Carry Over Error State
Specifies whether a child script error should be passed up to the parent script.

Allowed Context Scope
 [Fixed]
Allowed Context Type [Boolean]
Result to Parent
Specifies whether all result parameters should be transferred from the child script to the parent script.

Allowed Context Scope
 [Fixed]
Allowed Context Type [Boolean]
Action Script Parameters
The parameters passed to the action script.

Allowed Context Scopes
 [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Results:

The action returns the following results:

name
description
Action Script Result Contains the result of the action script.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types 
[Variable, Parameter] 

Information

The node Action Script Parameters contains all input parameters from the child action script. These are defined with Define Parameter.
The node Action Script Results stores the results from the child script. These are defined with Define Result.

Example 1 (Synchronously calculate the sum in a child script):

This example assigns the value of two local variables, numValue 1 and numValue 2, as action script parametersBoth have Number as data types. The Result after calling the child action script is then output via Message Box.

The master action script:


This is the child action script that will be called by the master action script:



Example 2 (Start two action scripts asynchronously):

In this example, the action script add_profiledata.xen is started asynchronously twice. Then, the Wait action is used to wait until the asynchronous action scripts finish their execution before another script is executed.

The master action script:

This is the action script that is started asynchronously:

This is the second action script that is started synchronously:


See other action script operations:

Wait
Return
Cancel
Write Error
Write Result
Append Result