Characteristic attributes available at run time

<CharacteristicName>.
Characteristic
Name

The name of the characteristic as it exists in the MES database. The name may differ from the object attribute name as expressed by <Characteristic Name>.

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

<CharacteristicName>.
SampleID

The ID of the sample for manually collected characteristics. You can set this attribute at run time to enter results for the characteristic. For automatically collected characteristics, the object writes the current SampleID to this attribute and automatically saves the result data.

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

<CharacteristicName>.
CanCollectResultData

A Boolean value that enables or disables measurements collection for the characteristic at run time.

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

<CharacteristicName>.
CanCollectAutomatic
Data

A Boolean value that specifies whether the characteristic should always, or never, collect automatic data. Also specifies if the characteristic should use the specification configuration of a sample to determine whether it should collect automatic data at run time.

Exists at config time and run time. Writeable only at config time. A value for this attribute at run time is either Always, Never, or Use Configuration.

<CharacteristicName>.
DelayTimer

The time interval between each measurement data for a characteristic.

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

<CharacteristicName>.
SampleSize

The count of result values that are exposed for the characteristic (that is, how many ValueNumber## attributes exists for the SRO).

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

<CharacteristicName>.
Note

Additional information that you can record in the MES database while recording data for the characteristic.

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

<CharacteristicName>.
CauseGroup

The cause group for the characteristic.

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

<CharacteristicName>.
Cause

The cause for why the characteristic is unexpected. The named cause must exist with the named cause group.

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

<CharacteristicName>.
ControlMove

A Boolean value that specifies whether there is a change to an environmental factor for the sample. When the value is set to True, the count for consecutive control rule evaluation restarts.

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

<CharacteristicName>.
IgnoreSample

A Boolean value that specifies whether calculating statistics should ignore the sample record.

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

<CharacteristicName>.
Equipment

A string that is the equipment used to measure the sample characteristic data.

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

<CharacteristicName>.
Expose
Statistics

A Boolean value that specifies whether the statistic attributes for the characteristic are exposed at run time.

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

<CharacteristicName>.
ValueNumber<N>

A value of the characteristic that is measured for the sample. Exists only if the characteristic type is a variable.

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

<CharacteristicName>.
ValueNumber.Value

The value for the characteristic that is measured for the sample. Exists only if the characteristic type is binary or counted.

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

<CharacteristicName>.
ValueNumber.
ActualSampleSize

An integer that is the actual sample size for the sample characteristic. Exists only if the characteristic type is binary or counted.

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

<CharacteristicName>.
ValueNumberForResult
Attributes

The number of the measurement result of a characteristic of a sample for which MES result attribute data is added.
The result_attr table requires the SampleID, the characteristicID, and the ValueNumber to which the MES attribute is linked.

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

<CharacteristicName>.
Operator

The operator who measured the sample characteristic.

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

<CharacteristicName>.
<ResultAttributeName>.
AttributeDesc

The actual MES Result attribute name from the MES database during the configuration time.

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

<CharacteristicName>.
<ResultAttributeName>.
Value

The value for the MES Result attribute that is recorded against this characteristic sample and value number.

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

<CharacteristicName>. <ResultAttributeName>.
Notes

A note for the MES Result attribute that is recorded against this characteristic sample and value number.

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

<CharacteristicName>.
RecordSample
CharateristicDataCmd

Updates any contextual data for this characteristic.

Exists only at run time and writeable at run time.

<CharacteristicName>.
RecordResultDataCmd

Records the measurement data for this characteristic using the provided sample ID.

Exists only at run time and writeable at run time.

<CharacteristicName>.
RecordMESResult
AttributeDataCmd

Records the MES Result attribute data for this characteristic using the provided sample ID and value number for result attributes.

Exists only at run time and writeable at run time.

Note: In the current version of MES, this attribute is disabled.

<CharacteristicName>.
ResetCmd

Resets the object state for a characteristic to Ready so that the next request is processed.

Exists only at run time and writeable at run time.

<CharacteristicName>.
<AttributeName>.
Use
InputSource

A Boolean value that, if set toTrue, specifies that the object reads the data for an attribute from the I/O reference, using the InputSource reference value configured for that attribute.

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

<CharacteristicName>.
<AttributeName>.
Input
Source

If UseInputSource is set to True, specifies the location of the input source from which the data will be read.

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

<CharacteristicName>.
<AttributeName>.
ReadStatus

The MxStatus value when an attribute fails to read a value from the I/O reference from its last data.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
ErrorCode

The error number returned from the stateless API after submitting a call to the MES middleware, or an error code from the object.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
ErrorMessage

The error message received from the stateless API after submitting a call to the MES middleware, or an error message from the object.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Status

The status of this characteristic instance. The status is either Ready, Busy, Done, or Error.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
ControlRuleViolations

The control rule violations that occurred, if any, while recording the measurement data.

The format of this attribute is:

[ChartType]:ID(RuleID):
RuleName;ID(RuleID):RuleName;[ChartType]:ID(RuleID):
RuleName;

where:

• ChartType is the name of the chart type that was used in triggering the rule violation

• RuleID is the RuleID number from SPC_Rule table

• RuleName is the text rule description from SPC_Rule table.

It is possible to have multiple chart types and rules within the string.

For example:

[Moving Range Chart]: ID(5):
7 of 7 on one side of center line; ID(9): 10 of 11 on one side of center line.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.RecentSampleID

The ID of the most recent sample (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.SpecName

The name of the specification that is used to generate this sample characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.StartEffDate

The start effective date of the specification that is used to generate this sample characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.Type

The type of this characteristic (retrieved from the MES database). The possible values are variable, binary, or counted attributes.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.TypeID

The type code for this characteristic (retrieved from the MES database).

The possible values are:

• 0 is variable

• 1 is binary

• 2 is counted

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.
UnitofMeasurement

The unit of measurement for this characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.MinSampleSize

The minimum number of measurements in a sample for this characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.NormalSampleSize

The normal sample size for this characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.MaxSampleSize

The maximum number of measurements in a sample for this characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.Severity

The severity for this characteristic (retrieved from the MES database). The possible values depend on the default language of the system. The possible values for English are Non-Key, Key, Critical, and Not Monitored.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.SeverityCd

The severity code for this characteristic (retrieved from the MES database). The possible values are:

• 1 is Not Monitored (run rule violations are not checked)

• 2 is Non-Key (default)

• 3 is Key

• 4 is Critical

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.DefaultChart

The default chart name for this characteristic (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.DefaultChartCd

The default chart code for this characteristic (retrieved from the MES database). The possible values are:

• 2 is Xbar + Range

• 3 is Xbar + Sigma

• 5 (default) is IX + MR

• 7 is MA + Range

• 8 is MA + Sigma

• 16 is p

• 17 is np

• 18 is u

• 19 is c

• 20 is DPMO (coding per QI Analyst)

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.LRL

The lower reasonable limits for this sample (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.URL

The upper reasonable limits for this sample (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Act
PercentOutofSL

The percentage of measurement data outside the specification limits.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Cp

The process capability, which is based on the upper and lower specification limits.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.CpK

The process capability index of the sample mean, which is based on the upper or lower specification limit.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Mean

The average of a set of data.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Pp

The process performance, which is based on the upper and lower specification limits.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.PpK

The process performance index of the sample mean, which is based on the upper or lower specification limit.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object

<CharacteristicName>.
Statistics.Range

The range between the highest data point and the lowest data point. This is calculated as the difference between the maximum individual reading and the minimum individual reading.

Exists only at run time. Writeable at run time only by the object

<CharacteristicName>.
Statistics.RBar

The average range of values from various samples of equal sample size.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Rows

The total number of rows (result data) involved in calculating the process statistics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.StdDev

The statistical measure of spread or variability of the individual results.

Exists only at run time. Writeable at run time only by the object

<CharacteristicName>. Statistics.EstSigma

The statistical measure of spread or variability estimated based on sample variability.

This attribute is only available for variable characteristics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Total

The total number of samples involved in calculating the process statistics.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Min

The minimum individual reading among the set of sample measurements.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.Max

The maximum individual reading among the set of sample measurements.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.LSL

The lower specification limit for a specification that is obtained from the most recent sample.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Statistics.USL

The upper specification limit for a specification that is obtained from the most recent sample.

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.ErrorCode

The error code returned by the Stateless API after submitting a call to the MES middleware (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.ErrorMessage

An error message returned by the Stateless API after submitting a call to the MES middleware (retrieved from the MES database).

Exists only at run time. Writeable at run time only by the object.

<CharacteristicName>.
Output.Status

The status of the characteristic instance (retrieved from the MES database). The status is either Ready, Busy, Done, or Error.

Exists only at run time. Writeable at run time only by the object.