The MachineModuleConfigurationType provides descriptions for settings, stop reasons and root causes as well as affordances to make modifications.
The MachineModuleConfigurationType is formally defined in the following table.
Table 15 – MachineModuleConfigurationType Definition
|
Attribute |
Value |
|||||
|
BrowseName |
MachineModuleConfigurationType |
|||||
|
IsAbstract |
False |
|||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node. |
||||||
|
0:HasProperty |
Variable |
DataSetList |
DataSetDefinitionType |
0:PropertyType |
O, RO |
|
|
0:HasComponent |
Method |
GetDataSetList |
See below. |
O |
||
|
0:HasComponent |
Method |
GetRootCauseGroupList |
See below. |
M |
||
|
0:HasComponent |
Method |
GetRootCauseList |
See below. |
M |
||
|
0:HasComponent |
Method |
GetStopReasonList |
See below. |
M |
||
|
0:HasProperty |
Variable |
LastChangeDate |
0:UtcTime |
0:PropertyType |
M, RO |
|
|
0:HasProperty |
Variable |
LongestMicroStopDuration |
0:Double |
0:PropertyType |
M, RW |
|
|
0:HasProperty |
Variable |
RootCauseGroupList |
RootCauseGroupType[] |
0:PropertyType |
M, RW |
|
|
0:HasProperty |
Variable |
RootCauseList |
RootCauseMessageType[] |
0:PropertyType |
M, RW |
|
|
0:HasProperty |
Variable |
RootCauseListInputIsMandatory |
0:Boolean |
0:PropertyType |
M, RW |
|
|
0:HasComponent |
Method |
SetDataSetListMESID |
See below. |
M |
||
|
0:HasComponent |
Method |
SetRootCauseLists |
See below. |
M |
||
|
0:HasProperty |
Variable |
StopReasonList |
MessageType[] |
0:PropertyType |
M, RO |
|
|
0:GeneratesEvent |
ObjectType |
RootCauseGroupListChangeLogType |
|
|
|
|
|
0:GeneratesEvent |
ObjectType |
RootCauseListChangeLogType |
|
|
|
|
|
0:GeneratesEvent |
ObjectType |
StopReasonListChangeLogType |
|
|
|
|
|
Conformance Units |
||||||
|
TMC Data Collection |
||||||
|
TMC Single PO Production |
||||||
|
TMC Multi PO Production |
||||||
The components of the MachineModuleConfigurationType are further described below.
|
BrowseName |
Description |
|
DataSetList |
The Property DataSetList of type DataSetDefinition contains the descriptors for all the parameters used to set up the machine. |
|
LastChangeDate |
The Property LastChangeDate is the date and time of the last change applied to the machine module configuration and the effective date of the modification. |
|
LongestMicroStopDuration |
The Property LongestMicroStopDuration is the maximum duration of a micro-stop in seconds, longer stops are not micro-stops. Operators are not required to enter a root cause for micro-stops. |
|
RootCauseGroupList |
The Property RootCauseGroupList is the list of groups that root causes can be grouped in. They are defined by the end user. Same as the RootCauseList property. The RootCauseGroupList is user defined. |
|
RootCauseList |
The Property RootCauseList is the complete list of the root causes that the end user has defined to classify and organize the downtime due to the machine module stops. The RootCauseList is user defined. |
|
RootCauseGroupListIsMandatory |
The Property RootCauseListInputIsMandatory is true when the operator is mandatorily required to select the root cause that best describes the current stop situation. For micro- stops such requirement does not apply. |
|
StopReasonList |
The Property StopReasonList is a list containing the descriptors for all the possible machine module messages, including alarms and warnings. Messages include their localization. The list is defined, created and maintained by the OEM. |
StopReasonList is defined by the OEM. RootCauseList and RootCauseGroupList are defined by the user.
For each StopReasonList item there is a corresponding RootCauseList item. Different RootCauseList items may provide the same contents indicating that the corresponding stop reasons have the same root cause. The RootCauseList is the default associated root cause and may be overridden by the operator at the machine with another root cause. Root causes are further organised by the user into groups e.g., electric, mechanical, product and so on and so forth in the RootCauseGroupList.
Upon first use, the server will default the RootCauseList to be equal to the StopReasonList.
At any time the user will change messages of the RootCauseList (but not their number) and the root cause groups without limitation.
The GetDatasetList Method returns the list of descriptions for parameters of the dataset filtered by the dependency and subset created by the user.
The GetDatasetList Method is typically used for clients to visualize the parameters’ descriptions and related metadata.
The signature of this Method is specified below. Table 16 specifies the Arguments representation.
Signature
GetDataSetList (
[in] ParameterDependencyEnumeration Dependency,
[in] 0:Boolean UserSubset,
[in] 0:Boolean CompleteSet,
[out] DataSetDefinitionType DataSetList,
[out] MethodExecutionFeedbackType ExecutionFeedback
);
Table 16 – GetDataSetList Method Arguments
|
Argument |
Description |
|
Dependency |
Dependency specifies how to select (filter) a subset of the dataset based on dependency. |
|
UserSubset |
UserSubset specifies how to select (filter) a subset of the dataset based on the user-defined UserSubset. |
|
CompleteSet |
If CompleteSet is True, then the method returns the complete dataset without considering the input parameters Dependency and UserSubset. |
|
DataSetList |
The list of parameters filtered as per the input arguments Dependency and UserSubset. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The GetRootCauseGroupList Method returns the complete list of root cause groups as persisted by the server.
The signature of this Method is specified below. Table 17 specifies the Arguments representation.
Signature
GetRootCauseGroupList(
[out] RootCauseGroupType[] RootCauseGroupList,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 17 – GetRootCauseGroupList Method Arguments
|
Argument |
Description |
|
RootCauseGroupList |
The complete list of root cause groups. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The GetRootCauseList Method returns the complete list of root causes as persisted by the server.
The signature of this Method is specified below. Table 18 specifies the Arguments representation.
Signature
GetRootCauseList(
[out] RootCauseMessageType[] RootCauseList,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 18 – GetRootCauseList Method Arguments
|
Argument |
Description |
|
RootCauseList |
The complete list of root cause messages. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The GetStopReasonList Method returns the complete list of stop reasons as persisted by the server.
The signature of this Method is specified below. Table 19 specifies the Arguments representation.
Signature
GetStopReasonList(
[out] MessageType[] StopReasonList,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 19 – GetStopReasonList Method Arguments
|
Argument |
Description |
|
StopReasonList |
The complete list of stop reason messages. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The SetDataSetListMESID Method sets the MES_ID of one or more items of the array Definitions contained in the DataSetList.
For clarity, the DataSetList is a Variable of type DataSetDefinitionType which contains Definitions, an array of structures of type DataDefinitionType. In turn DataDefinitionType is a subtype of DataDescriptionType, meaning it inherits MES_ID. The latter is set by SetDataSetListMESID.
Each item of Definitions is identified by its ID.
The signature of this Method is specified below. Table 20 specifies the Arguments representation.
Signature
SetDataSetListMESID (
[in] 0:String[] IDs,
[in] 0:String[] MESIDs,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 20 – SetDataSetListMESID Method Arguments
|
Argument |
Description |
|
IDs |
The IDs of the elements of the Definitions array whose MES_ID shall be changed if the method executes successfully. |
|
MESIDs |
The values of the MES_IDs to be set. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The SetRootCauseLists Method sets both the RootCauseList and RootCauseGroupList according to the input arguments. The RootCauseList and RootCauseGroupList properties are set together to ensure consistency of root causes with the relevant groups.
The signature of this Method is specified below. Table 21 specifies the Arguments representation.
Signature
SetRootCauseLists (
[in] RootCauseMessageType[] RootCauseList,
[in] RootCauseGroupType[] RootCauseGroupList,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 21 – SetRootCauseLists Method Arguments
|
Argument |
Description |
|
RootCauseList |
The list of root causes to be transferred to and used by the server. |
|
RootCauseGroupList |
The list of root cause groups to be transferred to and used by the server. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |