General attributes available at run time
- Last UpdatedFeb 10, 2025
- 3 minute read
The attributes that are available at run time for any OCO instance are described in the following table.
|
Attribute Name |
Description |
Configura- |
Run Time Access |
|---|---|---|---|
|
CanRunJobs |
Specifies whether the entity can run jobs. When you select this option, job execution attributes are enabled in the Object Editor. |
No |
Read-Only |
|
JobExec. |
Specifies attributes and commands to create a new job. Available only if CanRunJobs is True. |
No |
Read-Only |
|
JobExec. |
Specifies whether production counters are enabled at run time to track production. Available only if CanRunJobs is True. |
No |
Read-Only |
|
JobExec. |
Comma separated list of production counter names. |
No |
Read-Only |
|
JobExec. |
Specifies whether consumption counters are enabled at run time to track consumption. Available only if CanRunJobs is True. |
No |
Read-Only |
|
JobExec. |
Comma separated list of consumption counter names. |
No |
Read-Only |
|
CanSchedule Jobs |
Specifies whether the jobs can be scheduled to the entity. |
No |
Read-Only |
|
Enable Specifications |
Specifies whether specifications can be configured. |
No |
Read-Only |
|
EnablePEMAttributes |
Specifies whether PEM attributes are enabled at run time. |
No |
Read-Only |
|
CanStore |
Specifies whether the materials can be stored or transferred to this entity. |
No |
Read-Only |
|
ResponseType |
Specifies whether the configured object instance must have a |
No |
Read-Only |
|
ErrorMessage |
Specifies the description of an error that occurs while processing the middleware call. |
No |
Read-Only |
|
ErrorCode |
Specifies an integer value to indicate that an error has occurred while processing the middleware call. |
No |
Read-Only |
When the OCO ResponseType mode is Without Response, then the following attributes are available.
|
Attribute Name |
Description |
Configura- |
Run Time Access |
|---|---|---|---|
|
RejectedMessages. AckRejectedMessagesCmd |
If True, acknowledges that the rejected messages have been viewed. The active rejected message subscription is removed and a new one is established. Also, the time stamp filter is set to the current time, effectively clearing any previous rejected messages. The command value is automatically toggled back to False. |
No |
Supervisor User |
|
RejectedMessages.Count |
The number of rejected messages that match the current filter attribute values. |
No |
Read-Only |
|
RejectedMessages. |
The MES entity by which to filter the rejected messages that will be retrieved. This will be the object's parent entity. This attribute is auto-set at run time by the OCO. Its value should not be changed to ensure correct retrieval of rejected messages. |
No |
Read-Only |
|
RejectedMessages. |
The rejected messages that occurred up to the number of previous hours entered for this attribute will be retrieved. The range of allowable values is from 1 to 100. The default value is 72. Every hour, the object will set the Time filter to a value in the past that is the MaxHours from the current time. This value is expected to be set by the user at configuration time. |
Yes |
Read-Only |
|
RejectedMessages. Filter.MsgType |
The message type by which to filter the rejected messages that will be retrieved. This attribute is auto-set by the OCO to retrieve all Without Response events that the OCO can generate. Its value should not be changed to ensure correct retrieval of rejected messages. |
No |
Read-Only |
|
RejectedMessages.Filter.Time |
Only rejected messages that are more recent than this time stamp value will be retrieved. At OnScan, the time stamp value is set to the current time. During execution, the difference between Filter.Time and the current time is compared against the Filter.MaxHours value. If exceeded, Filter.Time is reset an hour forward, ensuring that rejected messages older than Filter.MaxHours are never retrieved. When this value is set by the user at run time, it will remove the current subscription and establish a new one. It is recommended that this value not be set frequently to avoid the performance overhead of recreating subscriptions. |
No |
Supervisor User |
|
RejectedMessages.Messages |
The string array of the rejected messages that match the current filter attribute values. The array is ordered with the most recent message at the top (that is, with the first index value). |
No |
Read-Only |
|
RejectedMessages.ResetCmd |
Used to clear a rejected messages retrieval error condition. The command does the following:
|
No |
Supervisor User |