This OPC UA MachineModuleConfigurationType ObjectType contains the descriptions for settings, stop reasons and root causes as well as affordances to make modifications.

Figure 10 shows an overview for the MachineModuleConfigurationType with related Objects. It is formally defined in Table 14.

Figure 10 – MachineModuleConfigurationType overview

The MachineModuleConfigurationType is formally defined in Table 14.

Table 14 – MachineModuleConfigurationType Definition

Attribute	Value
BrowseName	MachineModuleConfigurationType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of BaseObjectType defined in OPC 10000-5.
HasProperty	Variable	DataSetList	DataSetListType	PropertyType	Mandatory
HasProperty	Variable	UserMachineName	String	PropertyType	Mandatory
HasProperty	Variable	LocationName	String	PropertyType	Mandatory
HasProperty	Variable	TimeZone	UtcTime	PropertyType	Mandatory
HasProperty	Variable	StopReasonList	MessageType[]	PropertyType	Mandatory
HasProperty	Variable	RootCauseList	MessageType[]	PropertyType	Mandatory
HasProperty	Variable	RootCauseGroupList	RootCauseGroupType[]	PropertyType	Mandatory
HasProperty	Variable	RootCauseListInputIsMandatory	Boolean	PropertyType	Mandatory
HasProperty	Variable	LongestMicroStopDuration	Double	PropertyType	Mandatory
HasProperty	Variable	LastChangeDate	UtcTime	PropertyType	Mandatory
HasComponent	Method	GetDataSetList			Mandatory
HasComponent	Method	GetRootCauseList			Mandatory
HasComponent	Method	GetRootCauseGroupList			Mandatory
HasComponent	Method	GetStopReasonList			Mandatory
HasComponent	Method	SetRootCauseLists			Mandatory
GeneratesEvent	ObjectType	RootCauseGroupListChangeLogType
GeneratesEvent	ObjectType	RootCauseListChangeLogType
GeneratesEvent	ObjectType	StopReasonListChangeLogType

The MachineModuleConfigurationType ObjectType is a concrete type and can be used directly.

The Property UserMachineName of type String contains the name used by the user to identify the machine module.

The Property LocationName of type String contains the location of the machine module within the user production site. The Property LocationName will contain the following: Country/City/Department/Floor/Bay/Position.


The Property DataSetList of type DataSetListType contains the descriptors for all the parameters uset to set up the machine.

The type DataSetListType is defined inFigure 15..

Table 15 – DataSetListType Definition

Name	Type	Description
DataSetListType	Structure
DataSetListID	String	Unique identifier for the whole data set list.
DataSetListDescription	LocalizedText	Plain English description of the whole data set.
DataDescriptions	DataDescriptionType[]	Set (array) of data descriptions.

The type DataDescriptionTyp e is defined in Table 16.

Table 16 – DataDescriptionType Definition

Name	Type	Description
DataDescriptionType	Structure	Metadata about the parameter.
ID	String	Unique identifier for the parameter description.
MES_ID	String	Unique identifier for the parameter description in an external system, e.g. MES.
EngineeringUnits	EUInformation	Unit of measure
DisplayFormat	String	Display format for visualisation. The same display format shall be used in the HMI.
Dependency	ParameterDependencyEnumeration	The type of dependency of the parameter.
DataType	NodeId	The NodeId identifying the OPC UA Base Data Type node.
UserSubet	Boolean	UserSubset is True when the machine module end user identifies it.
ControlRange	Range	The parameter shall have values within this range.
AlarmRange	Range	When the value of the parameter is outside the range, then the underlying system shall generate an alarm.

The types EUInformation and Range are defined in OPC 10000-8. The enumeration ParameterDependencyEnumeration is defined in Table 17.

The UserSubset and Dependency allow identifying commonly used subset of parameters as shown in below in Figure 11.

Figure 11 – Subsetting with UserSubset and Dependency

Table 17 – ParameterDependencyEnumeration Definition

Enumstring	Value	Description
Machine	0	The parameter depends solely from the machine and does not vary with the brand.
Brand	1	The parameter depends solely from the brand being produced and does not vary with the machine.
Machine and Brand	2	The parameter depends both from the machine and the brand being produced.

The Property StopReasonList is a list containing the descriptors for all the possible machine module stop messages or warning messages. The list is created by the OEM. The Property StopReasonList is a list of MessageType objects. The MessageType is defined in Table 13.

The Property RootCauseList is a list containing all of the root causes that the end user has defined to classify and organise the downtime due to the machine module stops. The Property RootCauseList is a list of RootCauseMessageType objects. The type RootCauseMessageType is defined in Table 18.

Table 18 – RootCauseMessageType Definition

Name	Type	Description
RootCauseMessageType	Structure
GroupID	String	Root causes are grouped in familiies, e.g. electrical, mechanical, controls, etc. GroupID identifies uniquely each group.

The Property RootCauseGroupList is the list of groups that root causes can be grouped in. They are defined by the end user as well as the RootCauseList property.

The Property RootCauseGroupList is a list of RootCauseGroupType objects. The type RootCauseGroupType is defined in Table 19.

Table 19 – RootCauseGroupType Definition

Name	Type	Description
RootCauseGroupType	Structure
ID	String	Unique identifier for the root cause group.
ParentID	String	The ID of the group containing the present RootCauseGroupType. By means of the ParentID, multiple nested groups are allowed.
Description	LocalizedText	The human-readable description of the RootCauseGroupType.

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.

The Property LastChangeDate is the date and time of the last change applied to the machine module configuration.

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.

The Method GetDatasetList returns the list of descriptions for parameters of the dataset filtered by the dependency and subset created by the user. Typically, the method GetDatasetList is used for clients to visualise the parmeters’ descriptions and other metadata.

Signature

GetDatasetList (

[in]Boolean CompleteSet

[in]ParameterDependencyEnumeration Dependency

[in]Boolean UserSubset

[out]DatasetListType DatasetList

[out]MethodExecutionFeedbackType ExecutionFeedback

);

Argument	Description
CompleteSet	If CompleteSet is True then the method returns the complete dataset without considering the input parameters Dependency and UserSubset.
Dependency	The method filters parameters that have the required dependency and per this input parameter.
UserSubset	The method filters parameters that are in the user subset as required by this input parameter.
DatasetList	The list of parameter descriptions filtered by the input parameters: dependency, user subset.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

The Method GetRootCauseList returns the complete list of root causes as stored in the OPC UA Server.

Signature

GetRootCauseList (

[out]RootCauseMessageType[] RootCauseList

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound

Argument	Description
RootCauseList	The complete list of root cause messages.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

The method GetStopReasonList returns the complete list of stop reasons as stored in the OPC UA Server.

Signature

GetStopReasonList (

[out]MessageType[] StopReasonList

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound

Argument	Description
StopReasonList	The complete list of stop reason messages.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

The Method GetRootCauseGroupList returns the complete list of root causes groups as stored in the OPC UA Server.

Signature

GetRootCauseGroupList (

[out]RootCauseGroupType[] RootCauseGroupList

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound

Argument	Description
RootCauseGroupList	The list of groups the root causes are grouped in.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

The Method SetRootCauseLists sets both the RootCauseList and RootCauseGroupList according to the input arguments. The Properties RootCauseList and RootCauseGroupList are set together to ensure consistency of root causes with the relevant groups.

Signature

SetRootCauseLists (

[in]RootCauseMessageType[] RootCauseList

[in]RootCauseGroupType[] RootCauseGroupList

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound

Argument	Description
RootCauseList	The list of root causes to be transferred to the OPC UA Server.
RootCauseGroupList	The list of root cause groups to be transferred to the OPC UA Server.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound