1 Scope

This document provides a comprehensive overview of the document and information model structure of the OPC UA Companion Specification Mining. Crucially, use cases and information exchanges, which serve as the abstract foundation of the developed information models, are presented and explained in this document (see Chapter 5). As the OPC UA Companion Specification Mining spans several (multipart-) documents (see Chapter 4.2), this OPC 40560 – General document contains abstract type definitions that are relevant for type definitions in subsequent documents and parts of the OPC UA Companion Specification Mining. For a thorough overview of the OPC UA Companion Specification Mining, please refer to Chapter 4. The following is a brief description of organizations involved in the preparation of the documents for the OPC UA Companion Specification Mining.

2 Normative references

The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments and errata) applies.

OPC 10000-1, OPC Unified Architecture - Part 1: Overview and Concepts

http://www.opcfoundation.org/documents/10000-1/

OPC 10000-2, OPC Unified Architecture - Part 2: Security Model

http://www.opcfoundation.org/documents/10000-2/

OPC 10000-3, OPC Unified Architecture - Part 3: Address Space Model

http://www.opcfoundation.org/documents/10000-3/

OPC 10000-4, OPC Unified Architecture - Part 4: Services

http://www.opcfoundation.org/documents/10000-4/

OPC 10000-5, OPC Unified Architecture - Part 5: Information Model

http://www.opcfoundation.org/documents/10000-5/

OPC 10000-6, OPC Unified Architecture - Part 6: Mappings

http://www.opcfoundation.org/documents/10000-6/

OPC 10000-7, OPC Unified Architecture - Part 7: Profiles

http://www.opcfoundation.org/documents/10000-7/

OPC 10000-100, OPC Unified Architecture - Part 100: Devices

http://www.opcfoundation.org/documents/10000-100/

OPC 10000-200, OPC Unified Architecture - Part 200: Industrial Automation

http://www.opcfoundation.org/documents/10000-200/

OPC 40001-1, OPC UA for Machinery - Part 1: Basic Building Blocks

http://www.opcfoundation.org/documents/40001-1/

3 Terms, definitions and conventions

3.1 Overview

It is assumed that basic concepts of OPC UA information modelling OPC 10000-100 and OPC 40001‑1 are understood in this document. This document will use these concepts to describe the OPC 40560 Information Model. For the purposes of this document, the terms and definitions given in the documents referenced in Clause 2 apply.

Note that OPC UA terms and terms defined in this specification are italicized in the specification.

3.2 Conventions used in this document

3.2.1 Conventions for Node descriptions

3.2.1.1 Node definitions

Node definitions are specified using tables (see Table 2).

Attributes are defined by providing the Attribute name and a value, or a description of the value.

References are defined by providing the ReferenceType name, the BrowseName of the TargetNode and its NodeClass.

If the TargetNode is a component of the Node being defined in the table the Attributes of the composed Node are defined in the same row of the table.

The DataType is only specified for Variables; “[<number>]” indicates a single-dimensional array, for multi-dimensional arrays the expression is repeated for each dimension (e.g. [2][3] for a two-dimensional array). For all arrays the ArrayDimensions is set as identified by <number> values. If no <number> is set, the corresponding dimension is set to 0, indicating an unknown size. If no number is provided at all the ArrayDimensions can be omitted. If no brackets are provided, it identifies a scalar DataType and the ValueRank is set to the corresponding value (see OPC 10000-3). In addition, ArrayDimensions is set to null or is omitted. If it can be Any or ScalarOrOneDimension, the value is put into “{<value>}”, so either “{Any}” or “{ScalarOrOneDimension}” and the ValueRank is set to the corresponding value (see OPC 10000-3) and the ArrayDimensions is set to null or is omitted. Examples are given in Table 1.

The TypeDefinition is specified for Objects and Variables.

The TypeDefinition column specifies a symbolic name for a NodeId, i.e. the specified Node points with a HasTypeDefinition Reference to the corresponding Node.

The ModellingRule of the referenced component is provided by specifying the symbolic name of the rule in the ModellingRule column. In the AddressSpace, the Node shall use a HasModellingRule Reference to point to the corresponding ModellingRule Object.

If the NodeId of a DataType is provided, the symbolic name of the Node representing the DataType shall be used.

Note that if a symbolic name of a different namespace is used, it is prefixed by the NamespaceIndex (see 3.2.2.2).

Nodes of all other NodeClasses cannot be defined in the same table; therefore only the used ReferenceType, their NodeClass and their BrowseName are specified. A reference to another part of this document points to their definition. Table 2 illustrates the table. If no components are provided, the DataType, TypeDefinition and ModellingRule columns may be omitted and only a Comment column is introduced to point to the Node definition.

Each Type Node or well-known Instance Node defined shall have one or more ConformanceUnits defined in Table 2 that require the Node to be in the AddressSpace.

The relations between Nodes and ConformanceUnits are defined at the end of the tables defining Nodes, one row per ConformanceUnit. The ConformanceUnits are reflected in the Category element for the Node definition in the UANodeSet (see OPC 10000-6).

The list of ConformanceUnits in the UANodeSet allows Servers to optimize resource consumption by using a list of supported ConformanceUnits to select a subset of the Nodes in an Information Model.

When a Node is selected in this way, all dependencies implied by the References are also selected.

Dependencies exist if the Node is the source of HasTypeDefinition, HasInterface, HasAddIn or any HierarchicalReference. Dependencies also exist if the Node is the target of a HasSubtype Reference. For Variables and VariableTypes, the value of the DataType Attribute is a dependency. For DataType Nodes, any DataTypes referenced in the DataTypeDefinition Attribute are also dependencies.

For additional details see see OPC 10000-5.

Components of Nodes can be complex that is containing components by themselves. The TypeDefinition, NodeClass and DataType can be derived from the type definitions, and the symbolic name can be created as defined in 3.2.3.1. Therefore, those containing components are not explicitly specified; they are implicitly specified by the type definitions.

The Other column defines additional characteristics of the Node. Examples of characteristics that can appear in this column are show in Table 3.

If multiple characteristics are defined they are separated by commas. The name or the short name may be used.

3.2.1.2 Additional References

To provide information about additional References, the format as shown in Table 4 is used.

The components of the ObjectType have additional references which are defined in Table 4.

References can be to any other Node.

3.2.1.3 Additional sub-components

To provide information about sub-components, the format as shown in Table 5 is used.

3.2.1.4 Additional Attribute values

The type definition table provides columns to specify the values for required Node Attributes for InstanceDeclarations. To provide information about additional Attributes, the format as shown in Table 6 is used.

There can be multiple columns to define more than one Attribute.

3.2.2 NodeIds and BrowseNames

3.2.2.1 NodeIds

The NodeIds of all Nodes described in this standard are only symbolic names. Annex A defines the actual NodeIds.

The symbolic name of each Node defined in this document is its BrowseName, or, when it is part of another Node, the BrowseName of the other Node, a “.”, and the BrowseName of itself. In this case “part of” means that the whole has a HasProperty or HasComponent Reference to its part. Since all Nodes not being part of another Node have a unique name in this document, the symbolic name is unique.

The NamespaceUri for all NodeIds defined in this document is defined in Annex A. The NamespaceIndex for this NamespaceUri is vendor-specific and depends on the position of the NamespaceUri in the server namespace table.

Note that this document not only defines concrete Nodes, but also requires that some Nodes shall be generated, for example one for each Session running on the Server. The NodeIds of those Nodes are Server-specific, including the namespace. But the NamespaceIndex of those Nodes cannot be the NamespaceIndex used for the Nodes defined in this document, because they are not defined by this document but generated by the Server.

3.2.2.2 BrowseNames

The text part of the BrowseNames for all Nodes defined in this document is specified in the tables defining the Nodes. The NamespaceUri for all BrowseNames defined in this document is defined in Table 32.

For InstanceDeclarations of NodeClass Object and Variable that are placeholders (OptionalPlaceholder and MandatoryPlaceholder ModellingRule), the BrowseName and the DisplayName are enclosed in angle brackets (<>) as recommended in OPC 10000-3. If the BrowseName is not defined by this document, a namespace index prefix is added to the BrowseName (e.g., prefix '0' leading to ‘0:EngineeringUnits’ or prefix '2' leading to ‘2:DeviceRevision’). This is typically necessary if a Property of another specification is overwritten or used in the OPC UA types defined in this document. Table 32 provides a list of namespaces and their indexes as used in this document.

3.2.3 Common Attributes

3.2.3.1 General

The Attributes of Nodes, their DataTypes and descriptions are defined in OPC 10000-3. Attributes not marked as optional are mandatory and shall be provided by a Server. The following tables define if the Attribute value is defined by this specification or if it is server-specific.

For all Nodes specified in this specification, the Attributes named in Table 7 shall be set as specified in the table.

3.2.3.2 Objects

For all Objects specified in this specification, the Attributes named in Table 8 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

3.2.3.3 Variables

For all Variables specified in this specification, the Attributes named in Table 9 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

3.2.3.4 VariableTypes

For all VariableTypes specified in this specification, the Attributes named in Table 10 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

3.2.3.5 Methods

For all Methods specified in this specification, the Attributes named in Table 11 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

4 General information to OPC 40560: OPC UA for Mining - General and OPC UA

4.1 Introduction to the OPC UA Companion Specification Mining

In the mining industry, the increasing demand for machine- and systems-level connectivity and interoperability has led to the requirement of communication protocols that are capable of standardized information exchange. OPC Unified Architecture allows to define instantiable, SDK-agnostic information models, thereby fulfilling this requirement. At its core, the OPC UA Companion Specification Mining provides type definitions for mining machines, equipment, systems and services. Making use of the object-oriented nature of OPC UA information models, similar mining machine and system type definitions may also inherit their common features, such as variables, objects, events etc., from parent types. Furthermore, OPC UA is capable of integrating horizontal (Machine-To-Machine) as well as vertical (Machine-To-Superordinate System) communication patterns and exchanges. An overview of the CS Mining document structure is given in Chapter 4.2. An overview of the OPC UA Companion Specification Mining Use Cases is provided in Chapter 5. These will be heavily extended in future revisions of this OPC UA Companion Specification.

4.2 Introduction to the OPC UA CS Mining Document Structure

This section briefly introduces the multi-level document structure of the OPC UA Companion Specification Mining. The multi-level document structure is shown Figure 1. From this figure it becomes apparent, that the companion specification’s structure follows a three-level hierarchy. Every document in this hierarchy corresponds to precisely one OPC UA information model. Notably, the document hierarchy reflects the direction of type inheritance in this companion specification. Examples of this inheritance pattern are given further below.

The document numbering of the OPC UA Companion Specification Mining ranges from 40560 to 40569. Parts 40561 to 40569 make use of a multi-part numbering scheme, meaning these documents consist of sub-parts. For example, part 40561-1 and 40561-2 are sub-parts of 40561. Furthermore, the parts 40561 to 40568 are used to classify similar type of mining machines and systems into disjunct groups which are structured regarding the core process steps of mining. The machines are integrated into this structure according to the main task performed by the machine. For instance, loading machines, such as hydraulic excavators or mining shovels, are classified to be sub-part documents of the OPC 40562 Loading Equipment multi-part document. Within the OPC UA Companion Specification Mining, there are nine such multi-part documents which are presented in Annex B as machine- and system-category-level documents. Figure 2 shows the relationship between the automation pyramid and the document structure, illustrating the possibility of integrating horizontal and vertical communication elements within the OPC UA Companion Specification Mining. The Numbering of the different machine level categories is based on the mining core process steps beginning with extraction.

By definition, the first sub-part of any multi-part document, e.g. OPC 40561-1, 40562-1 or 40567-1, serves as an introduction to a set of similar type of mining machinery or systems and therefore defines parent types common to all such machines and systems. For instance, the Hydraulic Excavator machine, as defined by the HydraulicExcavatorType in OPC 40562-2, makes use of some methods, variables etc. of a parent type, called LoadingMachineType, that is defined in the machine-category document OPC 40562-1. The Hydraulic Excavator is defined as loading equipment even if it is also used for extraction purposes. The main criteria of classification depend upon the main purpose of a machine, which is loading in case of the Hydraulic Excavator. An overview of the existing multi-part documents is provided in Annex B.

Following the same logic as above, the industry-level document OPC 40560 at the top of the hierarchy in Figure 1 defines terms, types and conventions used throughout and available to all subsequent machine-category- and machine-level documents. An example of this inheritance pattern is the abstract MiningEquipmentType, as defined in Chapter 7.1 of this document, which serves as a parent type for any machine-level types.

One exception to the above stated rules is OPC 40569 which describes the Application and Use Cases of the machines and systems covered in this Companion Specification.

4.3 Introduction to Security in the OPC UA CS Mining

As mentioned above, OPC UA offers state-of-the art security mechanisms to prevent information sent via the OPC UA protocol to become compromised. OPC 10000-2 describes security measures and possible attack vectors. As OPC UA is aiming to be used throughout all levels of automation, the need for a strict information security architecture becomes apparent.

Measures OPC UA takes to ensure the authenticity and authorization of client users to, e.g. read certain variables in an OPC UA Server, as well as measures to secure the confidentially of message exchange, i.e. to use encryption, are outlined in OPC 10000-2.

We strongly advise users of OPC UA Server and Client protocol implementations to check whether their chosen OPC UA protocol implementation complies with the measures mentioned in OPC 10000-2.

To alert users of the OPC UA CS Mining to security, we include Server and Client Security Profiles in all of our Information Models.

4.3.1 What is OPC UA?

OPC UA is an open and royalty free set of standards designed as a universal communication protocol. While there are numerous communication solutions available, OPC UA has key advantages:

A state of art security model (see OPC 10000-2).

A fault tolerant communication protocol.

An information modelling framework that allows application developers to represent their data in a way that makes sense to them.

OPC UA has a broad scope which delivers for economies of scale for application developers. This means that a larger number of high-quality applications at a reasonable cost are available. When combined with semantic models such as the ones defined in the OPC UA CS Mining, OPC UA makes it easier for end users to access data via generic commercial applications.

The OPC UA model is scalable from small devices to ERP systems. OPC UA Servers process information locally and then provide that data in a consistent format to any application requesting data - ERP, MES, PMS, Maintenance Systems, HMI, Smartphone or a standard Browser, for examples. For a more complete overview see OPC 10000-1.

4.3.2 Basics of OPC UA

As an open standard, OPC UA is based on standard internet technologies, like TCP/IP, HTTP, Web Sockets.

As an extensible standard, OPC UA provides a set of Services (see OPC 10000-4) and a basic information model framework. This framework provides an easy manner for creating and exposing vendor defined information in a standard way. More importantly all OPC UA Clients are expected to be able to discover and use vendor-defined information. This means OPC UA users can benefit from the economies of scale that come with generic visualization and historian applications. This specification is an example of an OPC UA Information Model designed to meet the needs of developers and users.

OPC UA Clients can be any consumer of data from another device on the network to browser based thin clients and ERP systems. The full scope of OPC UA applications is shown in Figure 3.

OPC UA provides a robust and reliable communication infrastructure having mechanisms for handling lost messages, failover, heartbeat, etc. With its binary encoded data, it offers a high-performing data exchange solution. Security is built into OPC UA as security requirements become more and more important especially since environments are connected to the office network or the internet and attackers are starting to focus on automation systems.

4.3.3 Information modelling in OPC UA

4.3.3.1 Concepts

OPC UA provides a framework that can be used to represent complex information as Objects in an AddressSpace which can be accessed with standard services. These Objects consist of Nodes connected by References. Different classes of Nodes convey different semantics. For example, a Variable Node represents a value that can be read or written. The Variable Node has an associated DataType that can define the actual value, such as a string, float, structure etc. It can also describe the Variable value as a variant. A Method Node represents a function that can be called. Every Node has a number of Attributes including a unique identifier called a NodeId and non-localized name called as BrowseName. An Object representing a ‘Reservation’ is shown in Figure 4.

Object and Variable Nodes represent instances and they always reference a TypeDefinition (ObjectType or VariableType) Node which describes their semantics and structure. Figure 5 illustrates the relationship between an instance and its TypeDefinition.

The type Nodes are templates that define all of the children that can be present in an instance of the type. In the example in Figure 5 the PersonType ObjectType defines two children: First Name and Last Name. All instances of PersonType are expected to have the same children with the same BrowseNames. Within a type the BrowseNames uniquely identify the children. This means Client applications can be designed to search for children based on the BrowseNames from the type instead of NodeIds. This eliminates the need for manual reconfiguration of systems if a Client uses types that multiple Servers implement.

OPC UA also supports the concept of sub-typing. This allows a modeller to take an existing type and extend it. There are rules regarding sub-typing defined in OPC 10000-3, but in general they allow the extension of a given type or the restriction of a DataType. For example, the modeller may decide that the existing ObjectType in some cases needs an additional Variable. The modeller can create a subtype of the ObjectType and add the Variable. A Client that is expecting the parent type can treat the new type as if it was of the parent type. Regarding DataTypes, subtypes can only restrict. If a Variable is defined to have a numeric value, a sub type could restrict it to a float.

References allow Nodes to be connected in ways that describe their relationships. All References have a ReferenceType that specifies the semantics of the relationship. References can be hierarchical or non-hierarchical. Hierarchical references are used to create the structure of Objects and Variables. Non-hierarchical are used to create arbitrary associations. Applications can define their own ReferenceType by creating subtypes of an existing ReferenceType. Subtypes inherit the semantics of the parent but may add additional restrictions. Figure 6 depicts several References, connecting different Objects.

The figures above use a notation that was developed for the OPC UA specification. The notation is summarized in Figure 7. UML representations can also be used; however, the OPC UA notation is less ambiguous because there is a direct mapping from the elements in the figures to Nodes in the AddressSpace of an OPC UA Server.

A complete description of the different types of Nodes and References can be found in OPC 10000-3 and the base structure is described in OPC 10000-5.

OPC UA specification defines a very wide range of functionality in its basic information model. It is not required that all Clients or Servers support all functionality in the OPC UA specifications. OPC UA includes the concept of Profiles, which segment the functionality into testable certifiable units. This allows the definition of functional subsets (that are expected to be implemented) within a companion specification. The Profiles do not restrict functionality, but generate requirements for a minimum set of functionality (see OPC 10000-7)

4.3.3.2 Namespaces

OPC UA allows information from many different sources to be combined into a single coherent AddressSpace. Namespaces are used to make this possible by eliminating naming and id conflicts between information from different sources. Each namespace in OPC UA has a globally unique string called a NamespaceUri which identifies a naming authority and a locally unique integer called a NamespaceIndex, which is an index into the Server's table of NamespaceUris. The NamespaceIndex is unique only within the context of a Session between an OPC UA Client and an OPC UA Server- the NamespaceIndex can change between Sessions and still identify the same item even though the NamespaceUri's location in the table has changed. The Services defined for OPC UA use the NamespaceIndex to specify the Namespace for qualified values.

There are two types of structured values in OPC UA that are qualified with NamespaceIndexes: NodeIds and QualifiedNames. NodeIds are locally unique (and sometimes globally unique) identifiers for Nodes. The same globally unique NodeId can be used as the identifier in a node in many Servers – the node's instance data may vary but its semantic meaning is the same regardless of the Server it appears in. This means Clients can have built-in knowledge of of what the data means in these Nodes. OPC UA Information Models generally define globally unique NodeIds for the TypeDefinitions defined by the Information Model.

QualifiedNames are non-localized names qualified with a Namespace. They are used for the BrowseNames of Nodes and allow the same names to be used by different information models without conflict. TypeDefinitions are not allowed to have children with duplicate BrowseNames; however, instances do not have that restriction.

4.3.3.3 Companion Specifications

An OPC UA companion specification for an industry specific vertical market describes an Information Model by defining ObjectTypes, VariableTypes, DataTypes and ReferenceTypes that represent the concepts used in the vertical market, and potentially also well-defined Objects as entry points into the AddressSpace.

5 Use Cases and Scope of Information Exchange

This chapter outlines the Use Cases occurring within OPC UA Companion Specification Mining. These have been defined and modelled by the members of the Specialist Working Groups of the OPC UA Companion Specification Mining. To logically classify Use Cases according to their affiliation to mining processes, so-called Application Cases were defined and formulated. Any Application Case corresponds to a specific mining process. For example, ‘Discontinuous Loading’ or ‘Drill and Blast’ in surface mining. Furthermore, an Application Case is composed of multiple Use Cases which are understood to be the atomic, process-oriented constituents of an Application Case. The precise definition of a machine or system participating in a specific Use Case is provided in the respective machine and system-level document (see Annex B).

Within each Use Case of a given Application Case, a sequence of information, between two or more participants (e.g. two machines), is defined to be exchanged. As each Use Case serves a specific goal, e.g. two autonomous mobile machines need to successfully exchange their trajectories, the information defined in a Use Case constitutes the communication interface of a machine or system, e.g. variables or methods required to reach the specific goal of the Use Case, and is thus contained in the OPC UA Information Models presented in this OPC UA Companion Specification. This allows for lightweight and goal-oriented OPC UA Information Models that shall be extended using the object-oriented feature set of OPC UA as further elaborated in the next paragraph.

The fact that only basic elements of information, e.g. variables or methods taken from the defined Use Cases, are included in the type definitions presented in this OPC UA Companion Specification, means that machine and system manufacturers or operators may need to extend the type definitions presented in order to meet their custom Use Case requirements. However, the OPC UA type definitions presented in this OPC UA Companion Specification are designed in such a way that additional information can easily be included. Moreover, the OPC UA Mining type definitions allow to exchange meta-information about machines and systems, e.g. device class or manufacturer name, by default. As OSI Layer 5-7 Edge-Server running on PLC hardware typically contain hundreds of variables, alarms, etc., to represent I/O signals, the OPC UA Information Models presented in this OPC UA Companion Specification may be heavily extended by machine manufacturers or operators. Table 12 gives an overview of the Application Cases included in the OPC UA Companion Specification Mining. The constituent Use Cases of the Application Cases can be taken from the corresponding documents.

6 OPC UA CS Mining Information Model Overview

The OPC UA Companion Specification Mining is following a modular approach, meaning it makes extensive use of the modelling concepts of type inheritance and type composition. More specifically, type composition is implemented using the AddIn-Model from OPC 10000-7. As further explained in later chapters and parts, any ObjectType definition of mining machinery, equipment, system or service, specified within the machine- and system-level documents of this OPC UA Companion Specification, uses the abstract MiningEquipmentType as its parent type defined in this industry level document. Moreover, any such ObjectType and can further be composed of ObjectType definitions from machine- and system-category-level documents using the AddIn-Model. It shall also be highlighted, that any type definition within the OPC UA Companion Specification Mining can further be extended according to the requirements of the entity (OEM, mine operator, etc.) implementing the type. Figure 8 shows the relationship between the models of the OPC UA Companion Specification Mining.

7 OPC UA ObjectTypes

7.1 MiningEquipmentIdentificationType ObjectType definition

7.1.1 Overview

The MiningEquipmentIdentificationType represents identification parameters for a mining machine, equipment, system or service. Intended to be used as an AddIn, as defined in OPC 10000-5, this ObjectType can serve as a type definition of an Object instance declaration called MiningEquipmentIdentification by definition. The value attribute of each identification variable or equipment meta-information of such an instance declaration can be set at OPC UA Server runtime by the equipment’s OEM. Figure 9 shows the hierarchical and compositional structure of the AddressSpace of this ObjectType.

7.1.2 ObjectType Definition

The MiningEquipmentIdentificationType is formally defined in Table 13.

The component Variables of the MiningEquipmentIdentificationType have additional Attributes defined in Table 14.

7.1.3 ObjectType Description

The DefaultInstanceBrowseName Variable indicates the BrowseName of any instance of this ObjectType, if referenced using the AddIn-Model described in OPC 10000-5.

The DeviceClass Variable indicates in which domain or for what purpose this mining equipment is used.

The DeviceTypeImage Object exposes device or equipment pictures as variables. There may be multiple images of different resolutions. Each image is a separate variable.

The Documentation Object exposes documents as variables. In most cases they will represent a product manual, which can exist as a set of individual documents.

The ImageSet Object aggregates all UIElement image variables.The UIElement shall specify an image by its name that is also the BrowseName of the image variable. Clients can cache images so they don’t have to be transferred more than once.

The ManufacturerUri variable provides a unique identifier for this company. This identifier should be a fully qualified domain name; however, it may be a GUID or similar construct that ensures global uniqueness.

The Model variable provides the name of the product.

The ProtocolSupport Object exposes protocol support files. They may represent various types of information as defined by a protocol. Examples are a GSD or a CFF file.

Please refer to OPC 10000-100 and OPC 40001-1 for the descriptions of other inherited instance declarations.

7.2 MiningEquipmentType ObjectType

7.2.1 Overview

This ObjectType represents an abstract type that any mining equipment, machine, system or service can inherit instance declarations from. Therefore, it acts as a blueprint for more specialized type definitions. For example, any type of mining machine, system or service shall contain an identification Object of ObjectType MiningEquipmentIdentificationType (see Chapter 7.2) to be able to serve identification information and meta-information about the machine such as model name, manufacturer name or machine images. Therefore, any type of mining machine, system or service may inherit from the MiningEquipmentType ObjectType as this abstract ObjectType already uses the MiningEquipmentIdentificationType. Moreover, both instance declarations of the MiningEquipmentType make use of the AddIn-Model defined in OPC 10000-5. Figure 10 shows the hierarchical and compositional structure of the AddressSpace of this ObjectType.

7.2.2 ObjectType Definition

The MiningEquipmentType is formally defined in Table 15.

The components of the MiningEquipmentType have additional references which are defined in Table 16.

7.2.3 ObjectType Description

The Components Object of type MachineComponentsType is an AddIn-Feature, allowing a structured way to represent hierarchies of machine components. It is usually populated at the time of type instantiation. To inspect the constituent instance declarations of the MachineComponentsType, please refer to OPC 40001-1.

The Identification Object of type MiningEquipmentIdentificationType is an AddIn-Feature, allowing a structured way to represent machine identification and meta-information within the context of an equipment type definition.

8 OPC UA VariableTypes

8.1 Overview

The VariableTypes StructuredArrayItemType and LongwallShieldOffsetArrayItemType contain the necessary properties to support the traits of the introduced mining equipment. The relation between these two VariableTypes is displayed in Figure 11.

8.2 StructuredArrayItemType VariableType

The StructuredArrayItemType VariableType is a subtype of the DataItemType. It is formally defined in Table 17.

8.3 LongwallShieldOffsetArrayItemType Variable Type

The LongwallShieldOffsetArrayItemType VariableType is a subtype of the StructuredArrayItemType. It is formally defined in Table 18 .

NOTE:
The LongwallShieldOffsetArrayItemType is a VariableType, which is only used in OPC 40567-2. When the OPC 40567-2 is revised, this VariableType will be added there. If a major revision of the OPC 40560 is done in the future, the LongwallShieldOffsetArrayItemType will be removed here. For this reason, it is already recommended not to use this VariableType in an implementation.

9 OPC UA DataTypes

9.1 LongwallShieldOffsetDataType Structure

This structure contains information regarding the Number of Shield and the Offset of the Shield. The structure is formally defined in Table 19.

10 Profiles and Conformance Units

This chapter defines the corresponding profiles and conformance units for the OPC UA Information Model for OPC 40560. Profiles are named groupings of conformance units. Facets are profiles that will be combined with other Profiles to define the complete functionality of an OPC UA Server or Client. The following tables specify the facets available for Servers that implement the OPC 40560 Information Model companion specification.

NOTE: The names of the supported profiles are available in the Server Object under ServerCapabilities.ServerProfileArray.

10.1 Conformance Units

Table 20 defines the corresponding Conformance Units for the OPC UA Information Model for Mining- General.

10.2 Profiles

10.2.1 Profile list

Table 21 lists all Profiles defined in this document and defines their URIs.

10.2.2 Server Facets

10.2.2.1 Overview

The following sections specify the Facets available for Servers that implement the OPC 40560: OPC UA for Mining - General companion specification. Each section defines and describes a Facet or Profile.

10.2.2.2 Mining Core Server Facet

Table 22 defines a Facet that describes the fundamental base functionalities an OPC UA Server is expected to possess for serving OPC UA Mining Information Models. However, this will not allow to serve meaningful OPC UA CS Mining Information Models and purely serves to describe the fundamental Profiles and Facets required for basic Server operation. This Facet also includes Facets from other OPC UA Companion Specifications.

10.2.2.3 Mining Base Server Profile

Table 23 defines a Profile that describes the functionalities of an OPC UA Server that is used to serve OPC UA CS Mining Information Models. Servers complying to this Profile can be used to serve OPC UA CS Mining Information Models.

10.2.2.4 Mining Identification Server Facet

Table 24 defines a Facet that describes the functionalities an OPC UA CS Mining Server is expected to possess in regards to being able to serve meta-information of Object instances. This includes all information provided by the MiningEquipmentIdentificationType which is part of the MiningEquipmentType definition provided in Chapter 7.1.

10.2.2.5 Mining Equipment Server Facet

Table 25 defines a Facet that describes the functionalities an OPC UA CS Mining Server is expected to possess in regards to being able to serve a component recursion of Object instances. Specifically, this is referring to the Components Instance-Declaration of the MiningEquipmentType definition provided in Chapter 7.1.

10.2.3 Client Facets

10.2.3.1 Overview

The following tables specify the Facets available for Clients that implement the OPC 40560: Mining General companion specification.

10.2.3.2 Mining Core Client Facet

Table 26 defines a Facet that describes the base characteristics for all OPC UA Clients that make use of this companion specification. Additional Facet will define support for various information models that are part of this document. This Facet also includes Facet from other OPC UA Companion Specifications.

10.2.3.3 Mining Base Client Profile

Table 27 – Mining Base Client Profile defines a Facet that describes the functionalities of an OPC UA Client that is used to query an OPC UA Server that has implemented the Mining Server Profile.

10.2.3.4 Mining Identification Client Facet

Table 28 defines a Profile that describes the functionalities an OPC UA CS Mining Client is expected to possess in regards to being able to query meta-information provided by Object instances on the Server. This includes all information provided by the MiningEquipmentIdentificationType which is part of the MiningEquipmentType definition provided in Chapter 7.1.

10.2.3.5 Mining Equipment Client Facet

Table 29 defines a Profile that describes the functionalities of an OPC UA CS Mining Client to query information provided by an OPC UA CS Mining Server serving a component recursion of Object instances. Specifically, this is referring to the Components Instance-Declaration of the MiningEquipmentType definition provided in Chapter 7.1.

11 Namespaces

11.1 Namespace Metadata

Table 30 defines the namespace metadata for this document. The Object is used to provide version information for the namespace and an indication about static Nodes. Static Nodes are identical for all Attributes in all Servers, including the Value Attribute. See OPC 10000-5 for more details.

The information is provided as Object of type NamespaceMetadataType. This Object is a component of the Namespaces Object that is part of the Server Object. The NamespaceMetadataType ObjectType and its Properties are defined in OPC 10000-5.

The version information is also provided as part of the ModelTableEntry in the UANodeSet XML file. The UANodeSet XML schema is defined in OPC 10000-6.

Note: The IsNamespaceSubset Property is set to False as the UANodeSet XML file contains the complete Namespace. Servers only exposing a subset of the Namespace need to change the value to True.

11.2 Handling of OPC UA Namespaces

Namespaces are used by OPC UA to create unique identifiers across different naming authorities. The Attributes NodeId and BrowseName are identifiers. A Node in the UA AddressSpace is unambiguously identified using a NodeId. Unlike NodeIds, the BrowseName cannot be used to unambiguously identify a Node. Different Nodes may have the same BrowseName. They are used to build a browse path between two Nodes or to define a standard Property.

Servers may often choose to use the same namespace for the NodeId and the BrowseName. However, if they want to provide a standard Property, its BrowseName shall have the namespace of the standards body although the namespace of the NodeId reflects something else, for example the EngineeringUnits Property. All NodeIds of Nodes not defined in this document shall not use the standard namespaces.

Table 31 provides a list of mandatory and optional namespaces used in an OPC 40560 OPC UA Server.

Table 32 provides a list of namespaces and their indices used for BrowseNames in this document. The default namespace of this document is not listed since all BrowseNames without prefix use this default namespace.

Annex A OPC UA for Mining – General Namespace and mappings (Normative)

A.1 NodeSet and supplementary files for OPC UA for Mining - General Information Model

The OPC UA for Mining – General Information Model is identified by the following URI:

http://opcfoundation.org/UA/Mining/General/

Documentation for the NamespaceUri can be found here.

The NodeSet associated with this version of specification can be found here:

https://reference.opcfoundation.org/nodesets/?u=http://opcfoundation.org/UA/Mining/General/&v=1.01.0&i=1

The NodeSet associated with the latest version of the specification can be found here:

https://reference.opcfoundation.org/nodesets/?u=http://opcfoundation.org/UA/Mining/General/&i=1

The supplementary files associated with this version of specification can be found here:

https://reference.opcfoundation.org/nodesets/?u=http://opcfoundation.org/UA/Mining/General/&v=1.01.0&i=2

The supplementary files associated with the latest version of the specification can be found here:

https://reference.opcfoundation.org/nodesets/?u=http://opcfoundation.org/UA/Mining/General/&i=2

_____________

Annex B Subdocuments of the OPC UA Companion Specification Mining (Informative)

This appendix gives an overview of the constituent documents of the OPC UA Companion Specification Mining. The OPC UA Companion Specification Mining follows a multi-level document structure in Figure 1 and Figure 2 and explained in Chapter 4.2.

B.1 Extraction Equipment

B.2 Loading Equipment

B.3 Transport and Dumping Equipment

B.4 Mineral Processing Equipment

B.5 Development and Support Equipment

B.6 Monitoring and Supervision Services

B.7 Planning, Execution, Logistics and Operation (PELO) Services

B.8 External Standards

B.9 Companion Specification Mining: Application and Use Cases

___________

Agreement of Use

COPYRIGHT RESTRICTIONS

This document is provided "as is" by the OPC Foundation and VDMA.

Right of use for this specification is restricted to this specification and does not grant rights of use for referred documents.

Right of use for this specification will be granted without cost.

This document may be distributed through computer systems, printed or copied as long as the content remains unchanged and the document is not modified.

OPC Foundation and VDMA do not guarantee usability for any purpose and shall not be made liable for any case using the content of this document.

The user of the document agrees to indemnify OPC Foundation and VDMA and their officers, directors and agents harmless from all demands, claims, actions, losses, damages (including damages from personal injuries), costs and expenses (including attorneys' fees) which are in any way related to activities associated with its use of content from this specification.

The document shall not be used in conjunction with company advertising, shall not be sold or licensed to any party.

The intellectual property and copyright is solely owned by the OPC Foundation and VDMA.

PATENTS

The attention of adopters is directed to the possibility that compliance with or adoption of OPC or VDMA specifications may require use of an invention covered by patent rights. OPC Foundation or VDMA shall not be responsible for identifying patents for which a license may be required by any OPC or VDMA specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OPC or VDMA specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents.

WARRANTY AND LIABILITY DISCLAIMERS

WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN ERRORS OR MISPRINTS. THE OPC FOUDATION NOR VDMA MAKES NO WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT SHALL THE OPC FOUNDATION NOR VDMA BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The entire risk as to the quality and performance of software developed using this specification is borne by you.

RESTRICTED RIGHTS LEGEND

This Specification is provided with Restricted Rights. Use, duplication or disclosure by the U.S. government is subject to restrictions as set forth in (a) this Agreement pursuant to DFARs 227.7202-3(a); (b) subparagraph (c)(1)(i) of the Rights in Technical Data and Computer Software clause at DFARs 252.227-7013; or (c) the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2), as applicable. Contractor / manufacturer are the OPC Foundation, 16101 N. 82nd Street, Suite 3B, Scottsdale, AZ, 85260-1830.

COMPLIANCE

The combination of VDMA and OPC Foundation shall at all times be the sole entities that may authorize developers, suppliers and sellers of hardware and software to use certification marks, trademarks or other special designations to indicate compliance with these materials as specified within this document. Products developed using this specification may claim compliance or conformance with this specification if and only if the software satisfactorily meets the certification requirements set by VDMA or the OPC Foundation. Products that do not meet these requirements may claim only that the product was based on this specification and must not claim compliance or conformance with this specification.

TRADEMARKS

Most computer and software brand names have trademarks or registered trademarks. The individual trademarks have not been listed here.

GENERAL PROVISIONS

Should any provision of this Agreement be held to be void, invalid, unenforceable or illegal by a court, the validity and enforceability of the other provisions shall not be affected thereby.

This Agreement shall be governed by and construed under the laws of Germany.

This Agreement embodies the entire understanding between the parties with respect to, and supersedes any prior understanding or agreement (oral or written) relating to, this specification.