Description
This function adds a new SCRIPT task definition during runtime. If this function is invoked with the same source item ID and module ID multiple times, multiple tasks will be invoked when the source item is changed. The execution of the tasks is in reverse order (the last added as first – the first added as last).
For example:
| Code Block |
|---|
nxa.AddScriptTask("NETx\\VAR\\Numeric\\Item001", "NETx\\VAR\\Numeric\\Item002", true, true, true, 0, "nxa.LogInfo(\"1\")", 1001)
nxa.AddScriptTask("NETx\\VAR\\Numeric\\Item001", "NETx\\VAR\\Numeric\\Item002", true, true, true, 0, "nxa.LogInfo(\"2\")", 1001)
nxa.AddScriptTask("NETx\\VAR\\Numeric\\Item001", "NETx\\VAR\\Numeric\\Item002", true, true, true, 0, "nxa.LogInfo(\"3\")", 1001) |
If item NETx\VAR\Numeric\Item001 is changed, the following system log entries will appear:
| Code Block |
|---|
3
2
1 |
The following code will delete all 3 tasks:
| Code Block |
|---|
nxa.RemoveScriptTask("NETx\\VAR\\Numeric\\Item001", 1001) |
Signature
nxa.AddScriptTask (string, string, bool, bool, bool, number, string, number)
...
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| sourceItemID | string | M | |
| destinationItemID | string | M | |
| triggerOnReceive | bool | M | corresponds to the OnReceive parameter of the task definition |
| triggerOnSend | bool | M | corresponds to the OnSend parameter of the task definition |
| triggerOnSet | bool | M | corresponds to the OnSet parameter of the task definition |
| delay | number | M | time interval in milliseconds that the task will be delayed when triggered |
| script | string | M | LUA script name that will be executed when the task is triggered |
| moduleID | number | O | Has to be > 1000. Can be referenced in the nxa.RemoveScriptTask function. |
Return
...
| Type | Description |
|---|---|
| string | TaskID that identifies the created task. |