Operator Tasks Template Configuration (JSON) File
A tasks template is a JSON file that allows specifying some important data required to create a task.
NOTE:
If an existing template is modified, any related created tasks prior to the changes are not affected by the modifications since template data is copied to those tasks. In case of issues or if you want to modify a template, delete the tasks created from this template prior to the changes.
See the following for details on the attributes.
Template Attributes | |||
Parameter | Description | Use | Example |
Duration | Default task duration, expressed in gg:hh:mm. | Optional |
|
NotesRequired | Specifies whether or not the operator notes are required. Valid values are | Optional |
|
RevertActionMode | The revert actions mode. Valid values are | Optional |
|
TimeoutForConditions | The maximum timeout (in seconds) to wait for before checking the conditions, after the execution of the revert commands. The default value is 30 seconds. | Optional |
|
Task Actions | An array of task actions. For details, see the table below. | Mandatory | For examples, see the table below. |
Task Actions Attributes | |||
Parameter | Description | Use | Examples |
ObjectModels | Name or array of the names of the object models of the system object that will be commanded. If equal to “*” or not specified (default), the task action will apply to all the task target objects. | Optional |
"ObjectModels": |
ObjectModelsExcluded | Name or array of names of the object models to exclude from the task action. This attribute can be specified only if ObjectModels is equal to "*":
| Optional | Do not execute the task action on all the object models explicitly defined in all the other task actions:
Do not execute the task action on all the object models explicitly defined in all the other task actions and in the specified area and zone objects:
Do not execute the task action on the specified area and zone objects:
|
Property CommandName | Name of the property to command and name of the command to execute. | The pair Property/CommandName is alternative to the alias ID of the command. | Exclude an area/zone
Suppress alarms on a subtree
Suppress alarms on a specific node |
CommandAlias | The ID of the alias representing the command to execute. | This attribute is alternative to the Property/CommandName pair. | Exclude an FS20EN Fire Detector (15 is the alias for "ObjectModels": ["GMS_FS20EN_EOT_FI_FireDetector"], “CommandAlias" : 15 Suppress alarms on a specific node (specifying the alias 76, which is the alias for
|
Parameters | Array of command parameters with their values. | This attribute must be specified only if the command requires parameters. |
|
RevertAction | The definition of the revert action, that is, returning to a former state. For details, see the table below. | Optional | For examples, see the table below. |
Condition | The condition must include a value that allows the task to pass to the status This condition is evaluated when the task expires or after the execution of the revert action. For details, see the table below. | Mandatory | For examples, see the table below. |
ExecutionOrder | The execution order of the action. This attribute should be specified only if it is necessary to guarantee that the task actions are executed in a specific order. | Optional |
|
RevertActions Attributes | |||
Parameter | Description | Use | Examples |
Property CommandName | Name of the property to command and name of the revert command to execute. | The Property/CommandName pair is alternative to the alias ID of the command. | Include a zone "Property": "Mode", "CommandName": "Enable"
Unsuppress alarms on a subtree "Property": "SuppressAlarms", "CommandName": "DisableAll"
Unsuppress alarms on a specific node "Property": "SuppressAlarms", |
CommandAlias | The ID of the alias representing the revert command to execute. | This attribute is alternative to the | Include an FS20EN Zone (16 is the alias for “Include”)
Unsuppress alarms on a specific node (specifying the alias 77, which is the alias for “UnsuppressAlarm”)
|
Parameters | Array of command parameters with their values. | This attribute must be specified only if the command requires parameters. | "Parameters": {"Value": 1, "Priority": 8} |
Property | Name of the property that the condition will verify. If not specified, the name of the property commanded by the task action will be used instead. | Optional | Ensure a zone is not disabled "Condition": { "Property" : "Mode", "Operator": "<>", "Value": 0 } |
Operator | Comparison operator of the condition. Allowed values are:
| Mandatory | Ensure the alarm suppression is disabled (For the “SuppressAlarms” property 0 = Disabled, 1 = Enabled) "Condition": { "Property" : "SuppressAlarms", "Operator": "=", "Value": 0 } |
Value | The value to use for the comparison of a condition. The value type must be coherent with the property type. | Mandatory | |
MaxAge | Condition for retrieving data from the field. If the value from the field is older than this number in milliseconds, it will be retrieved again and the most updated value will be provided. If this parameter is -1 (default) this means that the value will be always retrieved from the process image. | Optional | |
Examples of Operator Tasks Templates
Template that allows suppressing alarms on a subtree for one day, six hours, and thirty minutes
When a task created out of this template expires, it is verified that the "SuppressAlarms" property of the target objects associated to this task is ‘0’. This means that alarm suppression is disabled.
{
"Template":
{
"Duration": "01:06:30",
"TaskActions":
[
{
"Property": "SuppressAlarms",
"CommandName": "EnableAll",
"Condition":
{
"Operator": "=",
"Value": 0
}
}
]
}
}
Template that allows suppressing alarms on a specific system object for two hours
When a task created out of this template expires, it is verified that the "SuppressAlarms" property of the target objects associated to this task is ‘0’. This means that alarm suppression is disabled.
{
"Template":
{
"Duration": "00:02:00",
"TaskActions":
[
{
"Property": "SuppressAlarms",
"CommandName": "Enable",
"Condition":
{
"Operator": "=",
"Value": 0
}
}
]
}
}
Template that allows suppressing alarms on a subtree, executing automatically the revert action after two days
This template allows creating tasks that suppress alarms on the target objects associated to this task, expire in two days, do not require any operator notes, and execute the revert action automatically.
After the execution of the revert action, it is checked that the alarm suppression is disabled (SuppressAlarms property equal to 0) on the target objects associated to this task.
{
"Template":
{
"Duration" : "02:00:00",
"NotesRequired": "No",
"RevertActionMode": "Automatic",
"TaskActions": [
{
"Property": "SuppressAlarms",
"CommandName": "EnableAll",
"RevertAction":
{
"CommandName" : "DisableAll"
},
"Condition":
{
"__comment": "0 = Disabled; 1 = Enabled",
"Operator": "=",
"Value": 0
},
},
]
}
}
Template that allows excluding an area of type "GMS_FS20EN_EOT_FI_Area" and a zone of type “GMS_FS20EN_EOT_FI_ManualZone” for forty-five minutes
When a task created out of this template expires, it is verified that the "Mode" property of the target objects associated to this task is 1.
{
"Template":
{
"Duration": "00:00:45",
"TaskActions" :
[
{
"ObjectModels": ["GMS_FS20EN_EOT_FI_Area", "GMS_FS20EN_EOT_FI_ManualZone"],
"Property": "Mode",
"CommandName": "Disable",
"Condition":
{
"Operator": "=",
"Value": 1
}
}
]
}
}
Template that allows fire exclusion, executing automatically the revert action after five hours
This template allows creating tasks that exclude the target objects, expire in five hours, and execute the revert action automatically.
After the execution of the revert action, it is checked, with a maximum timeout of 60 seconds, that the target objects associated to the task are not disabled ("Mode" property equal to 0).
This template prevents the exclusion of target objects of type "GMS_FS20EN_EOT_FI_Area".
{
"Template":
{
"Duration" : "00:05:00",
"RevertActionMode": "Automatic",
"TimeoutForConditions" : 60,
"TaskActions" :
[
{
"ObjectModelsExcluded": "GMS_FS20EN_EOT_FI_Area",
"CommandAlias" : 15,
"RevertAction" :
{
"CommandAlias" : 16,
},
"Condition":
{
"Property" : "Mode",
"Operator" : "<>",
"__comment" : "0 = Disabled",
"Value" : 0
}
},
]
}
}
Template that allows executing multiple commands on the same objects
This template allows executing both the DisableInput (ExcludeIn) and DisableOutput (ExcludeOut) commands when the task is started. When the task expires, both the EnableInput (IncludeIn) and EnableOutput (IncludeOut) commands are executed like revert actions.
After the execution of the revert action, it is checked, with a maximum timeout of 60 seconds, that the target objects associated to the task are not disabled (“Status.Mode” property equal to 0).
{
"Template":
{
"Duration": "00:05:00",
"RevertActionMode": "Automatic",
"TimeoutForConditions" : 60,
"TaskActions":
[
{
"ObjectModels": ["GMS_7_FI_MXL_Detector_Device", "GMS_7_FI_MXL_Fire_Detector_Device"],
"__comment": "47 = ExcludeIn",
"CommandAlias": 47,
"RevertAction":
{
"__comment": "49 = IncludeIn",
"CommandAlias": 49,
},
"Condition":
{
"Property": "Status.Mode",
"Operator": "<>",
"__comment": "0 = Disabled",
"Value": 0
}
},
{
"ObjectModels": ["GMS_7_FI_MXL_Detector_Device", "GMS_7_FI_MXL_Fire_Detector_Device"],
"__comment": "48 = ExcludeOut",
"CommandAlias": 48,
"RevertAction":
{
"__comment": "50 = IncludeOut",
"CommandAlias": 50,
},
"Condition":
{
"Property": "Status.Mode",
"Operator": "<>",
"__comment": "0 = Disabled",
"Value": 0
}
},
]
}
}
