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

<WorkspaceDirectory>\EventFiles\nxaXLogicEvents.dat

Changes within this definition file are taking effect immediately. No server restart is required.

Col#	Name	Description
1	Name	This parameter defines the name of the XCommand instance. The name must be unique.
2	Variable group	This parameter defines the scope where the used internal variables of XCommand are valid. All XCommand instances that are using the same variable group are accessing the same internal variables. This means that all XCommand instances are sharing the same internal variables. If left empty, the instance name (column 1) is used as variable group.
3	Type	This attribute defines when the XCommand shall be triggered. The following types are possible: "ON_START" means that the XCommand is executed once when the NETx BMS Core Server starts. "ON_TIMER" triggers the XCommand cyclically (the interval in seconds can be specified in "Options" column). "ON_INPUT" executes the XCommand whenever one input item changes its value. "ON_TIMER_AND_INPUT" is used for XCommands that shall be triggered cyclically and whenever one input item changes. "ON_STOP" means that the XCommand is executed once when the NETx BMS Core Server stops. "ON_VALUE_CHANGE" means that the XCommand is only executed when one of the input items are changing. "ON_VALUE_RISING" means that the XCommand is only executed when one of the input items are changing and the new value is greater than the last one. When working with boolean values, TRUE is higher than FALSE. "ON_VALUE_FALLING" means that the XCommand is only executed when one of the input items are changing and the new value is lower than the last one. When working with boolean values, TRUE is higher than FALSE. "ON_ABOVE_LIMIT" means that the XCommand is only executed when one of the input items is above a limit. "ON_BELOW_LIMIT" means that the XCommand is only executed when one of the input items is below a limit.
4	Options	Depending on the selected type, different options can be specified here: "ON_START": no options. "ON_TIMER": Timer type (cyclic or time). If "cyclic" is selected, the logic will be triggered in a cyclic interval. The interval (in seconds) has to be specified. If "time" is chosen, the logic will be triggered every day at a defined point in time. "ON_INPUT": trigger on start (default is false). If true, the logic is also executed on server start-up. Synchronous call (default is false). If true, the logic is executed synchronous i.e. no other server tasks or events are triggered until the execution is finished. "ON_TIMER_AND_INPUT": Timer type (cyclic or time). If "cyclic" is selected, the logic will be triggered in a cyclic interval. The interval (in seconds) has to be specified. If "time" is chosen, the logic will be triggered every day at a defined point in time. "ON_STOP": no options. "ON_VALUE_CHANGE": tolerance which must be exceeded between two values. "ON_VALUE_RISING": tolerance which must be exceeded between two values. "'Once"' means that the command is only executed once after it begins to rise. Trigger on start (default is false). If true, the logic is also executed on server start-up. "ON_VALUE_FALLING": tolerance which must be exceeded between two values. "'Once"' means that the command is only executed once after it begins to fall. "ON_ABOVE_LIMIT": "'limit"' which must be exceeded. "'Once"' means that the command is only executed once after the limit is exceeded. In addition, a hysteresis can be specified too. "ON_BELOW_LIMIT": "'limit"' which must be underrun. "'Once"' means that the command is only executed once after the limit is underrun. In addition, a hysteresis can be specified too.
5	XCommand	The parameter defines 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	This parameter defines the inputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.
7	Outputs	This parameter defines the outputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.
8	Parameters	This parameter defines the parameters of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.