General attributes available at run time

ResponseType

Specifies whether the calls to the MES middleware are to be executed synchronously or asynchronously.

Exists at config time and run time. Has a default value of With Response.

SelectedChars

List of characteristic object attribute names contained within the sample recording object.

Exists at config time and run time. Updated automatically at config time as the user changes the set of selected characteristics.

SelectedAttrs

List of MES sample attribute names contained within the sample recording object.

Exists at config time and run time. Updated automatically at config time as the user changes the set of selected MES sample attributes.

SelectedResult
Attrs

List of MES result attribute names contained within this sample recording object.

Exists at config time and run time. Updated automatically at config time as the user changes the set of selected MES result attributes.

DefaultDelay
Timer

Specifies the duration between two consecutive measurement data of an automatically collected characteristic within a sample.

Exists only at config time, and writeable at config time.

AutoReset

Specifies whether the status attribute is reset to Ready or left at Done after completing a successful call to the MES middleware.

Exists at config time and run time. Writeable only at config time.

ErrorCode

Specifies an integer value to indicate that an error has occurred while processing the MES middleware call.

Not configurable at config time, but writeable only by the object at run time.

ErrorMessage

Specifies the description of an error that occurs while processing the MES middleware call.

Not configurable at config time, but writeable only by the object at run time.

Status

Specifies the status of an attribute as Ready, Busy, or Error.

Not configurable at config time, but writeable only by the object at run time.

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.

Not configurable at config time, but writeable at runtime.

RejectedMessages.Count

The number of rejected messages that match the current filter attribute values.

Not configurable at config time, but writeable only by the object at runtime.

RejectedMessages.
Filter.Entity

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 SRO. Its value should not be changed to ensure correct retrieval of rejected messages.

Not configurable at config time, but writeable only by the object at runtime.

RejectedMessages.
Filter.MaxHours

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.

Exists at config time and runtime. Writeable only at config time.

RejectedMessages. Filter.MsgType

The message type by which to filter the rejected messages that will be retrieved.

This attribute is auto-set by the SRO to retrieve all Without Response events that the SRO can generate. Its value should not be changed to ensure correct retrieval of rejected messages.

Not configurable at config time, but writeable only by the object at runtime.

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.

Not configurable at config time, but writeable at runtime.

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).

Not configurable at config time, but writeable only by the object at runtime.

RejectedMessages.ResetCmd

Used to clear a rejected messages retrieval error condition. The command does the following:

• Clears the ErrorCode and ErrorMessage attributes.

• Sets the Status attribute to Ready.

• Re-subscribes to rejected message events if the subscription has become invalid due to the error.

Not configurable at config time, but writeable at runtime.