XCommand event definitions
The definition of XCommands provides the possible linkage of logical functions between multiple different server items. The defined XCommands can be executed by defining events which react on input value of the involved server items.
File location of configuration:
<WorkspaceDirectory>\EventFiles\nxaXLogicEvents.dat
Changes within this definition file are immediately effective after saving. Server restart is not required.
Col# | Name | Description |
---|---|---|
1 | Name | The name of the XCommand instance. Must be unique. |
2 | Variable group | The scope in which the used internal variables of the XCommand are valid. All XCommand instances that are configured for the same variable group access the same internal variables. This means that all XCommand instances share the same internal variables. If left empty, the instance name (column 1) is used as variable group. |
3 | Type | Specifies under which conditions and circumstances the XCommand shall be triggered. The following types are available:
Types that are marked with an * require XCommands with an input field that gets tracked. E.g. XCommand SCRIPT will not work with these types (on saving the definitions, an error message will be logged). |
4 | Options | Depending on the selected type, different options can be specified here:
Types that are marked with an * require XCommands with an input field that gets tracked. E.g. XCommand SCRIPT will not work with these types (on saving the definitions, an error message will be logged). |
5 | XCommand | The XCommand that shall be executed. To assist in selecting the inputs, outputs, and parameters, a dialog is available which can be open via the "..." button. |
6 | Inputs | The inputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically. |
7 | Outputs | The outputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically. |
8 | Parameters | Parameters of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically. |
9 | Description | Optional description of the XCommand. The value is only used for documentation purposes. |
10 | Comment | Optional comment of the XCommand. The value is only used for documentation purposes. |