The DocumentationType provides various FileType Objects for documents and Variables for links to documents that are used for maintenance operations. It is formally defined in Table 17.
Table 17 – DocumentationType Definition
Attribute |
Value |
||||
BrowseName |
DocumentationType |
||||
IsAbstract |
False |
||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
Subtype of the 2:FunctionalGroupType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node. |
|||||
0:HasComponent |
Object |
Arrangements |
- |
0:FileType |
O |
0:HasComponent |
Variable |
ArrangementsLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
Certificates |
- |
0:FileType |
O |
0:HasComponent |
Variable |
CertificatesLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
CircuitDiagram |
- |
0:FileType |
O |
0:HasComponent |
Variable |
CircuitDiagramLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
ComponentsList |
- |
0:FileType |
O |
0:HasComponent |
Variable |
ComponentsListLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
Detail |
- |
0:FileType |
O |
0:HasComponent |
Variable |
DetailLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
DuringMaintenanceServicesRendered |
- |
0:FileType |
O |
0:HasComponent |
Variable |
DuringMaintenanceServicesRenderedLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
ImplementationDescription |
- |
0:FileType |
O |
0:HasComponent |
Variable |
ImplementationDescriptionLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
Layout |
- |
0:FileType |
O |
0:HasComponent |
Variable |
LayoutLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
Location |
- |
0:FileType |
O |
0:HasComponent |
Variable |
LocationLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
LogicDiagram |
- |
0:FileType |
O |
0:HasComponent |
Variable |
LogicDiagramLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
LubricationMap |
- |
0:FileType |
O |
0:HasComponent |
Variable |
LubricationMapLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
MaintenanceManual |
- |
0:FileType |
O |
0:HasComponent |
Variable |
MaintenanceManualLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
OperationManual |
- |
0:FileType |
O |
0:HasComponent |
Variable |
OperationManualLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
PersonnelRecording |
- |
0:FileType |
O |
0:HasComponent |
Variable |
PersonnelRecordingLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
PipeAndInstrumentDiagram |
- |
0:FileType |
O |
0:HasComponent |
Variable |
PipeAndInstrumentDiagramLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
ScopeOfWork |
- |
0:FileType |
O |
0:HasComponent |
Variable |
ScopeOfWorkLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
SingleLineDiagram |
- |
0:FileType |
O |
0:HasComponent |
Variable |
SingleLineDiagramLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
SparePartReference |
- |
0:FileType |
O |
0:HasComponent |
Variable |
SparePartReferenceLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
Staff |
- |
0:FileType |
O |
0:HasComponent |
Variable |
StaffLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
TechnicalData |
- |
0:FileType |
O |
0:HasComponent |
Variable |
TechnicalDataLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
TestProgramReport |
- |
0:FileType |
O |
0:HasComponent |
Variable |
TestProgramReportLink |
0:String |
0:DataItemType |
O, RO |
0:HasComponent |
Object |
UnitMaintenanceReport |
- |
0:FileType |
O |
0:HasComponent |
Variable |
UnitMaintenanceReportLink |
0:String |
0:DataItemType |
O, RO |
The InstanceDeclarations of the DocumentationType have additional Attributes defined in Table 18. The Variables and the associated Descriptions are based on the standard DIN EN 13460.
Table 18 – DocumentationType Attribute values for child Nodes
BrowsePath |
Description Attribute |
Arrangements |
Drawing showing replacement components layout for an item. |
ArrangementsLink |
Drawing showing replacement components layout for an item. |
Certificates |
Specific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...). |
CertificatesLink |
Specific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...). |
CircuitDiagram |
Overall feeder and control circuits diagram. |
CircuitDiagramLink |
Overall feeder and control circuits diagram. |
ComponentsList |
Comprehensive list of items which constitute part of another one. |
ComponentsListLink |
Comprehensive list of items which constitute part of another one. |
Detail |
Drawing with part list to ensure dismantling, repair and assembly of items. |
DetailLink |
Drawing with part list to ensure dismantling, repair and assembly of items. |
DuringMaintenanceServicesRendered |
Final and/or interim report on services provided |
DuringMaintenanceServicesRenderedLink |
Final and/or interim report on services provided |
ImplementationDescription |
Explanation of the work carried out |
ImplementationDescriptionLink |
Explanation of the work carried out |
Layout |
Drawing showing all areas of a particular plant. |
LayoutLink |
Drawing showing all areas of a particular plant. |
Location |
Drawing showing the position of all field items within the considered area. |
LocationLink |
Drawing showing the position of all field items within the considered area. |
LogicDiagram |
System control diagram to clarify the overall system logic. |
LogicDiagramLink |
System control diagram to clarify the overall system logic. |
LubricationMap |
Drawing showing position of each item lubrication point, with lubrication data and specifications. |
LubricationMapLink |
Drawing showing position of each item lubrication point, with lubrication data and specifications. |
MaintenanceManual |
Technical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function. |
MaintenanceManualLink |
Technical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function. |
OperationManual |
Technical instructions to reach a proper item function performance according to its technical specifications and safety conditions. |
OperationManualLink |
Technical instructions to reach a proper item function performance according to its technical specifications and safety conditions. |
PersonnelRecording |
List of all activities (work order) performed by a technician. This list includes a predefined time period |
PersonnelRecordingLink |
List of all activities (work order) performed by a technician. This list includes a predefined time period |
PipeAndInstrumentDiagram |
Overall fluid conduction (air, steam, oil, fuel ...), and control diagram. |
PipeAndInstrumentDiagramLink |
Overall fluid conduction (air, steam, oil, fuel ...), and control diagram. |
ScopeOfWork |
The hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc. |
ScopeOfWorkLink |
The hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc. |
SingleLineDiagram |
Overall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits. |
SingleLineDiagramLink |
Overall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits. |
SparePartReference |
List of all spare parts used within the scope of the work order |
SparePartReferenceLink |
List of all spare parts used within the scope of the work order |
Staff |
List of all maintenance workers involved in the execution of the work order |
StaffLink |
List of all maintenance workers involved in the execution of the work order |
TechnicalData |
Manufacturer`s specification of the item. |
TechnicalDataLink |
Manufacturer`s specification of the item. |
TestProgramReport |
Commissioning report which demonstrates that an item is in compliance with specifications. |
TestProgramReportLink |
Commissioning report which demonstrates that an item is in compliance with specifications. |
UnitMaintenanceReport |
List of work orders for a particular unit. The list is created for a specified period of time |
UnitMaintenanceReportLink |
List of work orders for a particular unit. The list is created for a specified period of time |