7.5 DocumentationType ObjectType Definition

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
BrowseNameDocumentationType
IsAbstractFalse
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:HasComponentObjectArrangements-0:FileTypeO
0:HasComponentVariableArrangementsLink0:String0:DataItemTypeO, RO
0:HasComponentObjectCertificates-0:FileTypeO
0:HasComponentVariableCertificatesLink0:String0:DataItemTypeO, RO
0:HasComponentObjectCircuitDiagram-0:FileTypeO
0:HasComponentVariableCircuitDiagramLink0:String0:DataItemTypeO, RO
0:HasComponentObjectComponentsList-0:FileTypeO
0:HasComponentVariableComponentsListLink0:String0:DataItemTypeO, RO
0:HasComponentObjectDetail-0:FileTypeO
0:HasComponentVariableDetailLink0:String0:DataItemTypeO, RO
0:HasComponentObjectDuringMaintenanceServicesRendered-0:FileTypeO
0:HasComponentVariableDuringMaintenanceServicesRenderedLink0:String0:DataItemTypeO, RO
0:HasComponentObjectImplementationDescription-0:FileTypeO
0:HasComponentVariableImplementationDescriptionLink0:String0:DataItemTypeO, RO
0:HasComponentObjectLayout-0:FileTypeO
0:HasComponentVariableLayoutLink0:String0:DataItemTypeO, RO
0:HasComponentObjectLocation-0:FileTypeO
0:HasComponentVariableLocationLink0:String0:DataItemTypeO, RO
0:HasComponentObjectLogicDiagram-0:FileTypeO
0:HasComponentVariableLogicDiagramLink0:String0:DataItemTypeO, RO
0:HasComponentObjectLubricationMap-0:FileTypeO
0:HasComponentVariableLubricationMapLink0:String0:DataItemTypeO, RO
0:HasComponentObjectMaintenanceManual-0:FileTypeO
0:HasComponentVariableMaintenanceManualLink0:String0:DataItemTypeO, RO
0:HasComponentObjectOperationManual-0:FileTypeO
0:HasComponentVariableOperationManualLink0:String0:DataItemTypeO, RO
0:HasComponentObjectPersonnelRecording-0:FileTypeO
0:HasComponentVariablePersonnelRecordingLink0:String0:DataItemTypeO, RO
0:HasComponentObjectPipeAndInstrumentDiagram-0:FileTypeO
0:HasComponentVariablePipeAndInstrumentDiagramLink0:String0:DataItemTypeO, RO
0:HasComponentObjectScopeOfWork-0:FileTypeO
0:HasComponentVariableScopeOfWorkLink0:String0:DataItemTypeO, RO
0:HasComponentObjectSingleLineDiagram-0:FileTypeO
0:HasComponentVariableSingleLineDiagramLink0:String0:DataItemTypeO, RO
0:HasComponentObjectSparePartReference-0:FileTypeO
0:HasComponentVariableSparePartReferenceLink0:String0:DataItemTypeO, RO
0:HasComponentObjectStaff-0:FileTypeO
0:HasComponentVariableStaffLink0:String0:DataItemTypeO, RO
0:HasComponentObjectTechnicalData-0:FileTypeO
0:HasComponentVariableTechnicalDataLink0:String0:DataItemTypeO, RO
0:HasComponentObjectTestProgramReport-0:FileTypeO
0:HasComponentVariableTestProgramReportLink0:String0:DataItemTypeO, RO
0:HasComponentObjectUnitMaintenanceReport-0:FileTypeO
0:HasComponentVariableUnitMaintenanceReportLink0:String0:DataItemTypeO, 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
ArrangementsDrawing showing replacement components layout for an item.
ArrangementsLinkDrawing showing replacement components layout for an item.
CertificatesSpecific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...).
CertificatesLinkSpecific safety and statutory regulations certificates for items (lifting equipment, steam boilers, pressure vessels,...).
CircuitDiagramOverall feeder and control circuits diagram.
CircuitDiagramLinkOverall feeder and control circuits diagram.
ComponentsListComprehensive list of items which constitute part of another one.
ComponentsListLinkComprehensive list of items which constitute part of another one.
DetailDrawing with part list to ensure dismantling, repair and assembly of items.
DetailLinkDrawing with part list to ensure dismantling, repair and assembly of items.
DuringMaintenanceServicesRenderedFinal and/or interim report on services provided
DuringMaintenanceServicesRenderedLinkFinal and/or interim report on services provided
ImplementationDescriptionExplanation of the work carried out
ImplementationDescriptionLinkExplanation of the work carried out
LayoutDrawing showing all areas of a particular plant.
LayoutLinkDrawing showing all areas of a particular plant.
LocationDrawing showing the position of all field items within the considered area.
LocationLinkDrawing showing the position of all field items within the considered area.
LogicDiagramSystem control diagram to clarify the overall system logic.
LogicDiagramLinkSystem control diagram to clarify the overall system logic.
LubricationMapDrawing showing position of each item lubrication point, with lubrication data and specifications.
LubricationMapLinkDrawing showing position of each item lubrication point, with lubrication data and specifications.
MaintenanceManualTechnical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function.
MaintenanceManualLinkTechnical instructions intended to preserve an item in, or restore it to, a state in which it can perform a required function.
OperationManualTechnical instructions to reach a proper item function performance according to its technical specifications and safety conditions.
OperationManualLinkTechnical instructions to reach a proper item function performance according to its technical specifications and safety conditions.
PersonnelRecordingList of all activities (work order) performed by a technician. This list includes a predefined time period
PersonnelRecordingLinkList of all activities (work order) performed by a technician. This list includes a predefined time period
PipeAndInstrumentDiagramOverall fluid conduction (air, steam, oil, fuel ...), and control diagram.
PipeAndInstrumentDiagramLinkOverall fluid conduction (air, steam, oil, fuel ...), and control diagram.
ScopeOfWorkThe hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc.
ScopeOfWorkLinkThe hours worked in the execution of the work order. The type of hours worked should be indicated: normal, in shifts, at night, overtime, etc.
SingleLineDiagramOverall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits.
SingleLineDiagramLinkOverall power distribution diagram (electrical, pneumatic, hydraulic). This kind of diagram includes switchboard circuits.
SparePartReferenceList of all spare parts used within the scope of the work order
SparePartReferenceLinkList of all spare parts used within the scope of the work order
StaffList of all maintenance workers involved in the execution of the work order
StaffLinkList of all maintenance workers involved in the execution of the work order
TechnicalDataManufacturer`s specification of the item.
TechnicalDataLinkManufacturer`s specification of the item.
TestProgramReportCommissioning report which demonstrates that an item is in compliance with specifications.
TestProgramReportLinkCommissioning report which demonstrates that an item is in compliance with specifications.
UnitMaintenanceReportList of work orders for a particular unit. The list is created for a specified period of time
UnitMaintenanceReportLinkList of work orders for a particular unit. The list is created for a specified period of time