This section provides guidance on creation of modified and composite objects for use in compliance with MDIS standards. Standard MDIS Objects defined in Section 5 shall be used wherever possible. In the event that standard Objects cannot represent a given subsea component or piece of equipment, a new Object shall be developed by collection, aggregation or extension of existing Objects. Use of collection, aggregation or extension to model subsea equipment is dependent on vendor implementations.
Object collection shall be implemented using folders or Objects derived from MDISAggregateObjectType and should be used to group components or equipment that are physically grouped together in a common structure. Several examples of where object collection could be utilised would include modelling Subsea Electronics Modules, Electronic Power Units and Wells.
Object aggregation shall be implemented by creating a new type or subtype and should be used to group relevant objects to represent a complex piece of equipment that cannot be represented by a single MDIS Object. Specific examples of where Object aggregation could be used include modelling Multiphase Flow Meters (MPFMs) or Chemical Injection Metering Valves (CIMVs). Aggregated Objects have specific rules, defined below, to allow Clients to be able to discover them and easily support them.
Object extension shall be implemented by creating a subtype of an existing MDIS Object and should be used when an existing MDIS Object, such as a valve Object, has additional information or functionality that needs to be represented. Extension of Objects applies to all models defined in section 5 (i.e. MDISDiscreteInstrumentObjectType, MDISDigitalInstrumentObjectType, MDISInstrumentObjectType, MDISValveObjectType, MDISChokeObjectType or any subtype of these types). Subtyping MDISBaseObjectType is not allowed.
Rules for developing aggregated and extended objects are provided in Table 52. To minimise variability, when aggregating or extending objects only instances of the following VariableTypes and ObjectTypes shall be used:
- Standard MDIS Objects defined in section 5.
- BaseDataVariableType
- DiscreteItemType (Variable)
- AnalogItemType (Variable)
Table 52 - Aggregation and Extension Decision Matrix
Description |
Aggregation |
Extension |
Require new NodeId on TypeDefinition level |
Yes |
Yes |
0) Define new ObjectType with any non-MDIS parent |
No |
No |
1) Define new ObjectType with any MDIS parent (subtyping MDIS ObjectTypes - MDISValveObjectType, MDISChokeObjectType, MDISDigitalInstrumentObjectType, MDISInstrumentObjectType, MDISDiscreteInstrumentObjectType or any subtype of these types) |
No |
Yes |
2) Define new ObjectType with MDISAggregateObjectType as parent |
Yes |
No |
The operations described in Table 53 are valid operations in a generic OPC UA Server, but for an MDIS Server they are restricted as described in the table. All changes shall be based on type changes. Instance specific changes are not allowed.
Table 53 - General rules that apply to existing MDIS types
Description |
Aggregation |
Extension |
Add MDIS Object instance to an instance of an existing MDIS ObjectType (or subtype). |
No |
No |
Add non-MDIS Object instance to existing MDIS ObjectType (or subtype). |
No |
No |
Add non-MDIS Object instance to an instance of an existing MDIS ObjectType (or subtype). |
No |
No |
Add Method to an existing MDIS ObjectType (or subtype). |
No |
No |
Add a Variable instance to an instance of an existing MDIS ObjectType (or subtype). |
No |
No |
Add a Variable instance to an existing MDIS ObjectType. |
No |
No |
Base MDIS Object’s compliance to MDIS OPC UA specs shall be demonstrable (CTT). |
Yes |
Yes |
When extending an existing ObjectType, the rules described in
Table 54 apply to the MDIS Objects defined in Section 5. These rules apply to MDISValveObjectType, MDISChokeObjectType, MDISInstrumentObjectType, MDISDigitalInstrumentObjectType, MDISDiscreteInstrumentObjectType or any subtype of these types; they do not apply to the MDISBaseObjectType and the MDISAggregateObjectType. The MDISBaseObjectType cannot be extended or subtyped by a vendor or project. Only the MDIS working group can extend the MDISBaseObjectType or create new a subtype of it. The MDISAggregateObjectType has its own set of rules. Extending existing ObjectTypes are restricted to limit available additions to allow Clients to pick up the new types without requiring coding changes to the Client.
Description |
Extension |
Add a BaseDataVariableType instance to the newly create subtype of an MDIS ObjectType (MDISValveObjectType, MDISChokeObjectType, MDISDigitalInstrumentObjectType, MDISDiscreteInstrumentObjectType, MDISInstrumentObjectType or any subtype of these types), with a DataType of one of the OPC BaseDataType excluding structure. |
Yes |
Add an instance of an AnalogItemType to the newly created subtype of an MDIS ObjectType. |
Yes |
Add an instance of a DiscreteItemType to the newly created subtype of an MDIS ObjectType. |
Yes |
Change ModellingRule from Optional -> Mandatory for any of existing properties or components. |
Yes |
Table 55 describes rules for creating an aggregate object. They only apply as described.
Table 55 - Aggregation Related Rules
Description |
Aggregate |
Add MDIS Object InstanceDeclaration to the newly created subtype of MDISAggregateObjectType |
Yes |
Add a MDIS Variable instance to the newly created sub type of the MDISAggregateObjectType |
Yes |
Add a MDIS defined Reference to the newly created subtype of MDISAggregateObjectType. |
Yes |
Clients are expected to be able to handle new aggregate Objects, even if the Client only lists them as separate MDIS Objects and Variables of which they are composed. Clients are not required to handle an extension Object’s additional Variables, but they are required to support instances of the extension object. Clients that are unable to handle the extension Object’s additional Variables shall treat the extension object as an instance of the parent standard MDIS ObjectType. It is expected that some projects will require supporting the additional Variables defined in an extension Object.
ObjectTypes that are not an aggregated, extended or collection ObjectType can only be defined by the MDIS organisation. If a vendor (or group of vendors) determines that an ObjectType might be a candidate for creation as a new ObjectType, the proposed ObjectType needs to be submitted to or proposed to the MDIS organisation. If the MDIS organisation determines that a new ObjectType is to be created, it will be incorporated into the MDIS OPC UA Companion Specification. These new Objects shall be reviewed and validated by the MDIS organisation members.
The following is an example for creating an aggregated model of a simple CIMV Object. A generic model of a CIMV could have the following items:
- Valve Position Target (32 bit, float) – Read / Write
- Valve Flow Target (32 bit, float) – Read / Write
- Valve Status (8 bit, word) – Read Only
- Valve Device State (8 bit, word) – Read Only
The following figure illustrates the resulting TypeDefinition with example Object instances. It includes two instances of MDISDiscreteInstrumentObjectType Objects that represent the Valve Status and the Valve Device State, two instances of MDISInstrumentOutObjectType Objects that provide the ability to set the Position and Flow target values and two instances of MDISInstrumentObjectType Objects that provide feedback on the set Position and Flow target. As can be seen in the example figure, a common type definition allows for multiple identical Object instances to be created.
Figure 21 - Aggregated Object Type Definition
A vendor does not have to generate aggregate Objects; it can just provide a list of the base MDIS Objects that are being exposed. For example, a Well might not be configured as a subtype of MDISAggregateObjectType it might be a folder that contains the MDIS Objects that comprise the Well. If a structure is to be repeated, generating a subtype of the MDISAggregateObjectType for the structure can simplify testing and Client configuration work.