UCO attribute reference table

BatchSize

The BatchSize that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Value must be greater than 0.

Yes

Supervisory User

CurrentOEEPercent

Displays the current OEE percent value.

No

Read-Only

CurrentPerformance
Percent

Displays the current performance percent value.

No

Read-Only

CurrentQuality
Percent

Displays the current quality percent value.

No

Read-Only

CurrentUtilization
Percent

Displays the current utilization percent value.

No

Read-Only

DefaultProductionBatchSize

This value is used by the Entity Model Builder to configure the entity's default batch size.

Default = 1

Yes

Read-Only

DefaultProduction
Rate

This value will be used by the Entity Model Builder to configure entity default production rate.

The value must be greater than 0.

Yes

Read-Only

DefaultProduction
RateUoM

This attribute will be used by the Entity Model Builder to configure entities. The possible values for this selectable drop-down list are:

• hours/batch (default)

• minutes/batch

• seconds/batch

• batches/hour

• batches/minute

• batches/second

Yes

Read-Only

EnableProduction
Attributes

Determines if the production attribute primitive should be created.

If set to True (checked) the Production Attribute primitive will be added.

If set to False (unchecked) the Production Attributes primitive will be deleted.

Default = False (unchecked).

Yes

Read-Only

ErrorCode

ProdAttrs.ErrorCode

RejectedMessages.
ErrorCode

Displays an integer value that represents an error that has occurred. A value of 0 indicates no error. This value is set in conjunction with the error message (ErrorMessage).

No

Read-Only

ErrorMessage

ProdAttrs.Error
Message

RejectedMessages.
ErrorMessage

Displays readable text indicating an error has occurred. This value is set in conjunction with the error code (ErrorCode).

No

Read-Only

InError.Condition

When an error occurs this attribute is set to True. Will change to False when it is no longer in error.

No

Read-Only

InputSource

<PAName>.InputSource

Displays the reference of the attribute you want to input for the value of the production attribute.

Whenever the production attribute input source changes the SetHandler is used in resolving the full tagname of the input reference.

Yes

Supervisory User

Item

The Item that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Yes

Supervisory User

ItemClass

The ItemClass that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

When a ItemClass is specified in the UCO, but does not match the configured ItemClass in the database, the configured ItemClass in the database will be used (the UCO configured ItemClass ignored) and a warning message is logged stating, ItemClass specified is different from the existing ItemClass for this item - ignoring ItemClass specified.

Yes

Supervisory User

ItemUOM

Item. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

When a ItemUoM is specified in the UCO, but does not match the configured ItemUoM in the database, the configured ItemUoM in the database will be used (the UCO configured ItemUoM ignored) and a warning message is logged stating, "Item UOM specified is different from the existing ItemUOM for this item - ignoring item UOM specified."

Yes

Supervisory User

LogUtilEvents

Allows for stopping the UCO from logging utilization events so that the events can be entered manually by an operator using a .NET controls-based UI (such as MES Operator or a custom UI) or using MES Web Portal.

If True, the UCO will automatically log utilization events.

If False, the UCO will stop logging utilization events. Utilization events can be logged manually. However, the UCO continues to evaluate raw reason codes and updates the object properties accordingly.

Yes

Supervisory User

Operation

Along with the WorkOrder attribute, defines the job to be created when the Start Job command is triggered. If left blank, the the default operation from the system parameter will be used.

Yes

Supervisory User

Operator

The Operator that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Yes

Supervisory User

PreviousRawReason
Code

Displays the name of the previous active raw reason code.

No

Read-Only

ProdAttrs.EndJob
Cmd

This command is available when you select the Enable Production Attributes check box in the Object Editor. Is used to end all running jobs on the related entity. When set to True it will trigger the MES middleware to do EndAllJobs on the related entity. This database request will be executed at the start of the next execution cycle.

Default value = False

The following rules apply:

• If set to True while another request is in progress, the set will be rejected. Request is a call to the middleware in order to start (data entry job) or end a job.

• Set to False will be ignored since the actual runtime routine will take care to reset it to False once the request completes.

• The ErrorMessage and ErrorCode attributes will reflect exceptions (only) raised by the middleware and will indicate the actual request (PrepareProductionAttributes or EndAllJobs)

• The ErrorMessage and ErrorCode are reset any time either one of these attributes is set to True.

• Informational (warning messages) will be logged to the Logger in case that some unusual behavior was encountered while completing the request.

No

Supervisory User

ProdAttrs.ResetCmd

If an error has occurred during a job command execution, resets the job commands and clears the error.

No

Supervisory User

ProdAttrs.StartJob
Cmd

This command is available when you select the Enable Production Attributes check box in the Object Editor. Is used to start a new data entry job. When set to True, the names and values of the configured production attributes will be marked to be logged to the MESDB at the start of the next execution cycle.

Default value = False

The following rules apply:

• If set to True while another request is in progress, the set will be rejected. Request is a call to the middleware in order to start (data entry job) or end a job.

• Set to False will be ignored since the actual runtime routine will take care to reset it to False once the request completes.

• The ErrorMessage and ErrorCode attributes will reflect exceptions (only) raised by the middleware and will indicate the actual request (PrepareProductionAttributes or EndAllJobs)

• The ErrorMessage and ErrorCode are reset any time either one of these attributes is set to True.

• Informational (warning messages) will be logged to the Logger in case that some unusual behavior was encountered while completing the request.

No

Supervisory User

ProdAttrs.StartJobOn
Deploy

This command is available when you select the Enable Production Attributes check box in the Object Editor. When set to True, on deploy, the object will automatically handle starting a new data entry job. This attribute can only be set at config time.

Default = False

Yes

Read-Only

RawReasonCode

Used to display the name of the selected active raw reason code.

No

Read-Only

RawReasonCode
DefaultReason

Displays the default reason for the current active raw reason code.

No

Read-Only

RawReasonCode
Delay

Displays the minimum time before activation for the current active raw reason code.

No

Read-Only

RawReasonCode
Description

Displays the description of the current active raw reason code.

No

Read-Only

ReadStatus

<PAName>.ReadStatus

The status of the Input using the reference stored in <PAName>.InputSource.

No

Read-Only

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

No

Read-Only

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 values is 1 to 100. The default is 100. However, any values greater than 24 will cause the filter to behave as if the value is 24. This is because, every hour, the UCO resets the Time filter to the previous 24 hours.

No

Read-Only

RejectedMessages. Filter.MsgType

The message type by which to filter the rejected messages that will be retrieved. For example, for a UCO, this filter will be set to raw reason code change events.

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, this time stamp is checked to see whether it is older than 24 hours. If it is, it is reset to ensure that rejected messages older than 24 hours are not retrieved.

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). Time stamps are in the object’s local time.

No

Read-Only

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.

No

Supervisor User

RequiredQuantity

The RequiredQuantity that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Value must be greater than or equal
to 0.

Yes

Supervisory User

Reset

Note: In this version of the UCO, the Reset command is not available.

No

Supervisory User

ResumeOnError

Determines whether raw reason code expression errors are ignored at runtime. Default = False (unchecked).

If False, and an error/warning occurs when evaluating a raw reason code’s expression, no more raw reason code expressions will be evaluated until the next scan.

If True (checked), the error/warning will be ignored and the raw reason code’s expression will evaluate to False.

Yes

Supervisory User

Spare1
Spare2
Spare3
Spare4

These four spare attributes can be used for additional context when logging utilization events at run time. The user can configure the security classification for each spare in the object editor.

Yes

Supervisory User

StartQuantity

The StartQuantity that is currently associated with the Entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Value must be greater than or equal to 0.

Yes

Supervisory User

Status

RejectedMessages.
Status

Displays the current status of the UCO. If the status is in error the user must fix the error and set the reset attribute to True.

More information about what caused the status error can be retrieved from the ErrorMessage attribute.

No

Read-Only

TargetJobProdRate

The TargetJobProdRate that is currently associated with the entity. Quality is calculated when input source is used. Quality will be Bad if unable to read from the input source.

Value must be greater than 0.

Yes

Supervisory User

TargetJobProdRateUoM

The Target Job Production Rate Unit of Measure value must be one of the following predefined values:

• hours/batch

• minutes/batch

• seconds/batch

• batches/hour

• batches/minute

• batches/second

  If the TargetJobProdRateUoM attribute uses an InputSource to retrieve the value the string value must match exactly, or the ordinal value must be between 1 and 6.

  If the string value cannot be coerced into one of the six predefined values, or if the ordinal value is less than 1 or greater than 6, the TargetJobProdRateUoM quality will be set to Bad, and the Job will not be able to be started from that UCO instance.

Yes

Supervisory User

TargetOEEPercent

This value will be used by the Entity Model Builder to configure entity target OEE percentage. Value must be 0 to 100 percent in decimal form.

Default = 0.0.

Yes

Read-Only

TargetPerformance
Percent

This value will be used by the Entity Model Builder to configure entity target performance percentage.
Value must be 0 to 100 percent in decimal form.

Default = 0.0.

Yes

Read-Only

TargetQualityPercent

This value will be used by the Entity Model Builder to configure entity target quality percentage. Value must be 0 to 100 percent in decimal form.

Default = 0.0.

Yes

Read-Only

TargetUtilizationPercent

This value will be used by the Entity Model Builder to configure entity target utilization percentage. Value must be 0 to 100 percent in decimal form.

Default = 0.0.

Yes

Read-Only

TimeEntered

Displays the UTC time that current active raw reason code changed.

For raw reason codes for which a minimum time before activation has been set, the TimeEntered is the same as the time at which the raw reason code became active.

Some clients such as Object Viewer might convert the time to local for display purposes.

No

Read-Only

TimeInRawReason
Code

Displays the total time the current raw reason code has been active. This is the amount of time from the TimeEntered value and the current time.

No

Read-Only

UseInputSource

<PAName>
.UseInputSource

If set to True, the production attribute will be set to the input value every scan cycle and the input source reference is used to retrieve the production attribute value.

If set to False (the default), the user will be expected to set the attribute value since the input source reference is not being used.

Yes

Supervisory User

UtilOEEDataRefresh
Rate

Sets the rate in which utilization and OEE data will be refreshed in the UCO.

While this sets the rate at which the UCO will poll for new data, no new data may be available.

The minimum value is 15 seconds.

The default value is 00:01:00.0000000 (1 min).

Yes

Supervisory User

WorkOrder

Along with the Operation attribute, defines the job to be created when the Start Job command is triggered. If left blank, the the default work order from the system parameter will be used.

Yes

Supervisory User