Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Manufacturing Execution System 2023 R2

Sample attributes available at run time

  • Last UpdatedNov 04, 2024
  • 7 minute read

The attributes that are available at run time for any SRO instance are described in the following table.

Attribute Name

Description

Note

RecentSample.
Number
ofRecent
Samples
ToView

The number of recent samples that can be viewed at a time.

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

Sample.
SampleID

An integer value that is the ID of the sample for which the data is to be recorded in the MES database.

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

Sample.
QMSpecName

The QM specification to be used when generating on-demand samples with the Generate Sample command.The QM specification specifies which characteristics and sample plan should be considered in the on-demand sample.

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

Sample.Segment
RequirementID

The segment requirement value for the sample.

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

Sample.Segment
ResponseID

The segment response value for the sample.

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

Sample.Lot

The lot number for the sample.

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

Sample.Sublot

The sublot number for the sample.

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

Sample.Operator

The user/operator who pulls the sample from the production line.

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

Sample.Final

A Boolean value that indicates whether the sample data is final or not.

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

Sample.
Priority

An integer value that identifies the priority for the sample.

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

Sample.Spare1

Additional information about the sample.

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

Sample.Spare2

Additional information about the sample.

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

Sample.Spare3

Additional information about the sample.

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

Sample.Spare4

Additional information about the sample.

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

Sample.Event
DateTime

The date and time when a sample is pulled or finalized.

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

Sample.Event
DateTime.
AutoGenerate

A Boolean value that specifies whether the EventDateTime value in the object is generated automatically.

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

Sample.
<SampleAttribute
Name>.
AttributeDesc

The MES sample attribute name from the MES database that was defined during configuration.

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

Sample.
<SampleAttribute
Name>.Value

The sample attribute value to send to the MES database.

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

Sample.
<SampleAttribute
Name>.Notes

Sample attribute notes to send to the MES database.

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

Sample.Record
SampleDataCmd

Updates the sample record, the pulled_by and pulled_at fields, and the sample attribute data for the sample ID.

Exists only at run time and writeable at run time.

Sample.
RecordMES
Sample
AttributeDataCmd

Records the MES sample attribute data for a sample using the sample ID attribute.

Exists only at run time and writeable at run time.

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

Sample.Generate
SampleCmd

Generates samples on demand. Uses the Sample.QMSpecName attribute to determine which characteristics and sample plan should be considered in the on-demand sample.

Exists only at run time and writeable at run time.

Sample.Finalize
SampleDataCmd

Finalizes the sample and its data to prevent further editing.

Exists only at run time and writeable at run time.

Sample.Reset
Cmd

Clears the error code, error message, and sets status to Ready.

Exists only at run time and writeable at run time.

Sample.
<AttributeName>.UseInputSource

A Boolean value that, if set to True, 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.

Sample.
<AttributeName>.
InputSource

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.

Sample.
<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 and writeable at run time only by the object.

Sample.Error
Code

An integer value that is the error code for an error that occurs while processing the last MES middleware call to the database.

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

Sample.
ErrorMessage

The description of an error that occurs while processing the last MES middleware call to the database.

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

Sample.Status

The status of an attribute: Ready, Busy, or Error. This attribute can also have a value of Done if it is not in AutoReset mode.

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

Recent
Sample<N>.
SampleID

The sample ID of the sample retrieved from the MES database. This is used for updating the sample record from the sample commands (Sample.RecordSampleDataCmd) or for writing in one of the characteristics within the sample (<Characteristic>.Record
SampleCharacteristic
DataCmd).

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

Recent
Sample<N>.
SampleName

The name of the sample retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Characteristic
Names

A list of characteristic names from the MES database for the sample ID.

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

Recent
Sample<N>.
WorkOrder

The work order retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Operation

The operation retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Sequence
Number

The job sequence number retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.Item

The item retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
RequestedTime

The requested time of the sample retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
ExpiryTime

The expiry time of the sample retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
WarningTime

The warning time of the sample retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
SampleStatus

The status of the sample request, such as InProcess, Late, which are retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
SampleStatusID

The ID value of the sample status retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
SampleResult

The result of the sample, such as OOC, OOS Critical, which are retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
SampleResultID

The ID value of the sample result retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
FrequencyName

The frequency name used to generate the sample record retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Frequency
TypeID

The enumeration value of the frequency type retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
FrequencyType

The type of frequency used to generate the sample record retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Priority

The priority of the sample used for the sample record retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
VerifiedBy

The user who verified the sample retrieved from the MES database for the sample ID.

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

Recent
Sample<N>.
Spare1

Any additional value of the sample retrieved from the MES database.

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

Recent
Sample<N>.
Spare2

Any additional value of the sample retrieved from the MES database.

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

Recent
Sample<N>.
Spare3

Any additional value of the sample retrieved from the MES database.

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

Recent
Sample<N>.
Spare4

Any additional value of the sample retrieved from the MES database.

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

RecentSample.
ErrorCode

The error code from the MES middleware if the last data read is unsuccessful.

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

RecentSample.
ErrorMessage

The error string received from the MES middleware if the last data read is unsuccessful.

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

RecentSample.
Status

The status of the last data read for the sample: Ready, Busy, or Error.

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

Related Links
TitleResults for “How to create a CRG?”Also Available in