Tasks
This display allows you to monitor calculation tasks. We do not recommend configuring any settings on this display.
| Property | Data type | Description |
|---|---|---|
| Name | String | Name of calculation form. |
| Description | String | Optional description for the calculation task. Defines the calculation logic. |
| Process | CalcProcess | Process in which calculation task runs. Includes calculation name and unique process number of Equipment model calculations. |
| Constructor parameters | String | Optional constructor parameters for the definition code constructor, if the code takes them. |
| Error Message | String | Will contain any errors encountered during the execution of the task or fetching the mapped values. In case of a successful execution, it will be empty . |
| Batch Target | CalcMapping | The batch job variable mapping, meaning the name of equipment property or variable name used as batch indicator. Shows variable name or equipment model path and instance. |
| Batch Property | String | Specifies an equipment property, if batch job variable is equipment instance. |
| Calc Period | Int32 | Defines the calculation period for calculation task. Have to be larger than 0. If calculation period does not need to be set separately from scheduler trigger, this may be same as scheduler trigger. E.g. 1 min. |
| Calc Period Unit | Enum | Defines the time unit of calculation period. |
| Period Offset | Int32 | If set, delays the invocation of calculation code. |
| Period Offset Unit | Enum | Defines the time unit of offset. If not set, the total offset will be takes as the calculation period multiplied by value of PeriodOffset. For example, if the period of the calculation is 10 seconds, the period offset of -2 (PeriodOffset is -2 and PeriodOffsetUnit is None) will result in -20 seconds offset. |
| Base Time | DateTime | Sets the alignment of calculation periods. |
| Enabled Timeframe Start | DateTime | The calculation task is only enabled for calculation periods after this time (inclusive). |
| Enabled Timeframe End | DateTime | The calculation task is only enabled for calculation periods before this time (exclusive). |
| Skip Missed | Boolean | Whether intervals missed for any reason should be skipped or calculated. If enabled, don't calculate missed values. |
| Diag Update Interval Seconds | Int32 | Represents how often the CalcDiagnostics row for this task should be updated. Setting this to a low value for many CalcTasks can have negative effects on system performance. |
| Disabled | Boolean | When set to true, calculation task is disabled. |
| Continue on Error | Boolean | If true, task will run for the next execution context, even if there is an error on previous execution. |
| Max Run Seconds Before Killed | Int32 | The maximum time in seconds this task is allowed to execute for. 0 is unlimited. 120 seconds is the default value. |
| Group | String | The name of the group to which this calculation definition belongs to. For non admin user, they need to be part of the member group they are putting into this property. |
Updated 2 days ago