Document Types   latest update: 2008-03-02

                             

A few seconds patience please!!

What is a Document?

Next to what you normally understand under a document (e.g. data sheet, P&ID, Instrument Index) other collections of data are included as well, such as an input file to a calculation program. A special case is a document that represents the complete database schema of an application (or parts thereof).  

A Document in ISO 15926-7 is represented by an ontology that only represents the structure of the document and its prompts. The actual information content is kept external of the document. From the "Document" and its "DocumentCell"s reference is made to template instances that represent the information. This is done because the same information may, and most often will, be used in other documents. A document is a view on all information for an object that is available in your own Façade and in zero to many other Façades.

Topics

Click here and here to see two Topics about documents.

What is a Document Type?

Document Types are ontologies for documents. A document type defines the structure and constraints of a document instance.

Document Types are defined by the organizations and companies that use ISO 15926-7. Examples are: a Purchase Order form, a specification for centrifugal pump, an Instrument Index, a Line List, a Cable Schedule, and an input data set for the sizing of a shell & tube heat exchanger.

Since everything has its roots in the ISO standardized ontologies, this provides these organizations and companies great freedom in what information they want represented on a document.

All document types are listed in an OWL ontology for document types in a Façade of the defining user organization. Access to and use of this ontology is under the control of that organization.

In its OWL Ontology for Document Types a user organization can define its (corporate) types of document.

Parts of that user organization can define in their own Façade:

  • specializations of the (corporate) document types, such as in a situation where a corporate data sheet is in imperial units, but the subsidiary in Europe requires that same data sheet in SI units.

  • instances of documents, such as a data sheet for pump P104, rev. 2

Basic Document Model

The basic model for any document is shown in Figure 2 below.

Figure 2 - Basic document structure

ST-0098 (rdf:)properties

describes

The template describes all meta data of a particular document type, that is an instance of a subClassOf part4:Document. In most cases these subclasses are defined by a user organization.

isValidAt

The document will present the information that was valid at the date and time given here. This is done by fetching, using the SPARQL query scripts, the template instance of the 'hasAsInfo' template class defined for each of the various document cells of the document.

hasDescription

The document can have zero or more text strings, such as for the title.

hasAsContext

The "context template(s)" shown in Figure 4 fill the "information gap" between the document's (usually) "implicit" information representation and an "explicit" representation (as explicit as is dictated by the business needs). Implicit representations leave out a lot of detail, because a human being who is reading a document fills in that gap because he/she knows the subject. Computers are dumber, and need to have it all.

The context templates provide a basis for integrating the information shown on the document with the other lifecycle information in the Facade(s). At instance level these context templates usually are available already somewhere on the Internet, and the software shall fetch them automatically when generating a document instance. Their contents are then used for navigation by the SPARQL queries of the document cells.

hasPresentationScript

ISO 15926-7 is not about neat presentations of documents, with boxes, font types and sizes, colors, etc. It deals primarily with information representation. But of course presentation on paper or screen is important, because in the end human beings shall be able to read and interpret the information.

The rdf:Property 'hasPresentationScript', that points at zero or more instances of ClassOfInformationRepresentation, will be used to store presentation scripts in PHP.

Provided that the organization, that owns their own Ontology of Document Types of which this document type is a part, makes this accessible from the Internet, any recipient of an instance of this schema can use the Presentation Script referred to in that instance and display and/or print the document.

NOTE - If that recipient does not have the means to do that, he still has the full information content in the form of the references to the template instances, made from the document cells.

ST-0097 properties

isDocPartOf

An instance of part4:DOCUMENT_PART is can be a part of an instance of part4:DOCUMENT or of another DocumentPart (e.g. subsection of a section).

describes

The template describes all meta data of a particular document part, that is an instance of a subClassOf part4:DocumentPart. In most cases these subclasses are defined by a user organization.

hasDescription

A document part can have zero or more text strings, such as for the title of a section.

hasAsContext

The "context template(s)" shown in Figure 4 fill the "information gap" between the document part's (usually) "implicit" information representation and an "explicit" representation (as explicit as is dictated by the business needs). Implicit representations leave out a lot of detail, because a human being who is reading a document mentally fills in that gap because he/she knows the subject. Computers are dumber, and need to have it all.

The context templates provide a basis for integrating the information shown on the document with the other lifecycle information in the Facade(s). At instance level these context templates usually are available already somewhere on the Internet, and the software shall fetch them automatically when generating a document instance. Their contents are then used for navigation by the SPARQL queries of the document cells.

ST-0096 properties

isDocCellOf

An instance of part4:DOCUMENT_CELL can be a part of an instance of part4:DOCUMENT_PART or directly of an instance of part4:DOCUMENT.

describes

The template describes all meta data of a particular document cell, that is an instance of a subClassOf part4:DocumentCell. In most cases these subclasses are defined by a user organization.

hasPrompt

A document cell can have zero or more text strings, mostly as prompt for a data field, such as something like: Vapor Pressure Pv               barg

hasAsInfo

Any instance of a Document Cell points at zero or one applicable instance of a template class defined here for the Document Cell class.

hasQueryScript

An instance of a Document Cell points to an instance of the template class listed under hasAsInfo (above). The SPARQL query script fetches from that template instance ONLY the data that must be displayed in the cell. It includes the script to fetch the data that is valid at the date-time given for the property isValidAt of the entire document.

Analysis Diagrams

Click to see analysis diagrams that spell out how templates 0096, 0097, and 0098 are defined in terms of ISO 15926-2 entity data types.

Listing

Click here for a listing of an example of a Document Type.

NOTE   Please don't get confused by the fact that this example has nothing to do with the data sheet shown in the rest of this page.

Document Types

Now companies and organizations, such as ISA - The Instrumentation, Systems, and Automation Society, that want to use ISO 15926 can develop the listings for their document types, such as the one shown below:

Disclaimer - The fact that we analysed the ISA Control Valve Data Sheet (below) does not, in any way, construe that ISA endorses this activity.

It just happens to be a data sheet that many in the process industries know and can relate to.

Figure 3 - ISA Control Valve Data Sheet

(source: http://www.ccivalve.com/pdf/350.pdf)

Analysis

In the spreadsheet below this control valve data sheet is analyzed line by line.

The top part represents information about the control valve as an individual, and the second (largest) part represents membership criteria for a control valve class, of which the individual control valve is a member.

This means that when we send this for quotation to suppliers they are expected to offer a member of one of their classes, shown in their catalog. Naively one could claim that the data sheet class shall be either the same as the offered class or, most likely, a subclass of the offered class. However, there are topics that do not easily lend themselves to specialization. For example, when analyzing the body and trim material selection one cannot say that carbon steel is a subclass of stainless steel. There are circumstances where carbon steel is suitable and stainless steel is not. The solution will be in the realm of expert systems. The difference with the pre-15926 times is that all information will be available to those expert systems in a standard format.

ISA DATA SHEET FOR CONTROL VALVES
http://www.ccivalve.com/pdf/350.pdf
defining information about the individual control valve specified in the second part of this data sheet
Col Individual Relationship Level1 Relationship Level2 Relationship Level3        
N/A myValve isHandledUnder Project             = implicit information
N/A     Project hasProjectNumber String            
N/A     Project isHandledUnder Contract            
N/A         Contract hasContractNumber String        
N/A   isPartOf ProcessUnit                
N/A     ProcessUnit hasUnitNumber String            
N/A   isPurchasedWith PurchaseOrder                
N/A     PurchaseOrder hasPONumber String            
N/A   isReferredToIn PO-Item                
N/A     PO-Item hasPOItemNumber Integer            
N/A   isMaterializedBy myMaterialValve                
N/A     myMaterialValve hasSerialNumber String            
N/A   isReferredToIn DataSheet                
N/A     DataSheet hasDocumentNo String            
N/A     DataSheet hasSpecNumber String            
N/A   hasTagNumber String                
N/A   isReferredToIn Drawing                
N/A     Drawing hasDocumentNo String            
N/A   isUsedIn Service                
N/A     Service hasServiceDescription String            
defining the class criteria that the specified control valve shall adhere to
Col Class Relationship Level1 Relationship Level2 Relationship Level3 Relationship Level4 Rel Level5
N/A ControlValve contains Stream             = implicit information
1a     Stream type FluidType            
1b     Stream hasIndirectProperty CriticalPressure            
11a1     Stream hasIndirectProperty AllowableSPL atConditionOf MaximumFlow        
2a     Stream hasIndirectProperty FlowRate atConditionOf MaximumFlow        
3a     Stream hasIndirectProperty InletPressure atConditionOf MaximumFlow        
5a     Stream hasIndirectProperty InletTemperature atConditionOf MaximumFlow        
6a3     Stream hasIndirectProperty MolecularWeight atConditionOf MaximumFlow        
4a     Stream hasIndirectProperty OutletPressure atConditionOf MaximumFlow        
11a2     Stream hasIndirectProperty PredictedSPL atConditionOf MaximumFlow        
6a2     Stream hasIndirectProperty SpecificGravity atConditionOf MaximumFlow        
7a2     Stream hasIndirectProperty SpecificHeatRatio atConditionOf MaximumFlow        
6a1     Stream hasIndirectProperty SpecificWeight atConditionOf MaximumFlow        
8a     Stream hasIndirectProperty VapourPressure atConditionOf MaximumFlow        
7a1     Stream hasIndirectProperty Viscosity atConditionOf MaximumFlow        
11b1     Stream hasIndirectProperty AllowableSPL atConditionOf NormalFlow        
2b     Stream hasIndirectProperty FlowRate atConditionOf NormalFlow        
3b     Stream hasIndirectProperty InletPressure atConditionOf NormalFlow        
5b     Stream hasIndirectProperty InletTemperature atConditionOf NormalFlow        
6b3     Stream hasIndirectProperty MolecularWeight atConditionOf NormalFlow        
4b     Stream hasIndirectProperty OutletPressure atConditionOf NormalFlow        
11b2     Stream hasIndirectProperty PredictedSPL atConditionOf NormalFlow        
6b2     Stream hasIndirectProperty SpecificGravity atConditionOf NormalFlow        
7b2     Stream hasIndirectProperty SpecificHeatRatio atConditionOf NormalFlow        
6b1     Stream hasIndirectProperty SpecificWeight atConditionOf NormalFlow        
8b     Stream hasIndirectProperty VapourPressure atConditionOf NormalFlow        
7b1     Stream hasIndirectProperty Viscosity atConditionOf NormalFlow        
11c1     Stream hasIndirectProperty AllowableSPL atConditionOf MinimumFlow        
2c     Stream hasIndirectProperty FlowRate atConditionOf MinimumFlow        
3c     Stream hasIndirectProperty InletPressure atConditionOf MinimumFlow        
5c     Stream hasIndirectProperty InletTemperature atConditionOf MinimumFlow        
6c3     Stream hasIndirectProperty MolecularWeight atConditionOf MinimumFlow        
4c     Stream hasIndirectProperty OutletPressure atConditionOf MinimumFlow        
11c2     Stream hasIndirectProperty PredictedSPL atConditionOf MinimumFlow        
6c2     Stream hasIndirectProperty SpecificGravity atConditionOf MinimumFlow        
7c2     Stream hasIndirectProperty SpecificHeatRatio atConditionOf MinimumFlow        
6c1     Stream hasIndirectProperty SpecificWeight atConditionOf MinimumFlow        
8c     Stream hasIndirectProperty VapourPressure atConditionOf MinimumFlow        
7c1     Stream hasIndirectProperty Viscosity atConditionOf MinimumFlow        
3d     Stream hasIndirectProperty InletPressure atConditionOf ShutOff        
5d     Stream hasIndirectProperty InletTemperature atConditionOf ShutOff        
4d     Stream hasIndirectProperty OutletPressure atConditionOf ShutOff        
65 ControlValve hasAsBehaviour ActionAtAirFailure                
N/A ControlValve isConnectedTo InletLine                
13a     InletLine hasIndirectProperty Size            
13b     InletLine hasIndirectProperty Schedule            
N/A     InletLine isContainedIn Insulation            
15a         Insulation type InsulationType        
N/A ControlValve isConnectedTo OutletLine                
14a     OutletLine hasIndirectProperty Size            
14b     OutletLine hasIndirectProperty Schedule            
N/A     OutletLine isContainedIn Insulation            
15         Insulation type InsulationType        
N/A ControlValve isSubjectedTo HydrostaticTest                
83     HydrostaticTest type HydrostaticTestType            
N/A ControlValve isSubjectedTo LeakageTest                
84     LeakageTest type LeakageTestType            
N/A ControlValve hasAsPart ValveBody                
16     ValveBody type BodyStyle            
17b     ValveBody type Class            
19b     ValveBody type ModelNumber            
18a     ValveBody hasIndirectProperty MaximumPressure            
18b     ValveBody hasIndirectProperty MaximumTemperature            
17a     ValveBody hasIndirectProperty Size            
19a     ValveBody isMadeBy Manufacturer            
20a     ValveBody hasAsMaterial Material            
N/A     ValveBody hasAsPart Bonnet            
27         Bonnet type BonnetType        
20b         Bonnet hasAsMaterial Material        
N/A         Bonnet hasAsPart Packing        
30             Packing type PackingType    
29             Packing hasAsMaterial Material    
28           hasAsPart Lub&IsoValve isRequired Yes/No    
N/A     ValveBody hasAsPart InletConnection            
22         InletConnection type Type        
22         InletConnection type Class        
22         InletConnection hasIndirectProperty Size        
N/A         InletConnection hasAsFeature Finish        
24a             Finish type FinishType    
25a         InletConnection hasAsFeature Extension isRequired Yes/No    
25a             Extension hasAsMaterial Material    
N/A     ValveBody hasAsPart OutletConnection            
23         OutletConnection type Type        
23         OutletConnection type Class        
23         OutletConnection hasIndirectProperty Size        
N/A         OutletConnection hasAsFeature Finish        
24b             Finish type FinishType    
25b         OutletConnection hasAsFeature Extension isRequired Yes/No    
25b             Extension hasAsMaterial Material    
N/A     ValveBody hasAsPart Lining            
21b         Lining hasDimension InnerDiameter        
21a         Lining hasAsMaterial Material        
N/A     ValveBody hasAsPart Trim            
32         Trim type TrimType        
34         Trim type Characteristic        
35         Trim type BalancedOrUnbalanced        
36a         Trim hasIndirectProperty RatedCv        
36b         Trim hasIndirectProperty RatedFL        
36c         Trim hasIndirectProperty RatedXT        
9a         Trim hasIndirectProperty RequiredCv atConditionOf MaximumFlow    
9b         Trim hasIndirectProperty RequiredCv atConditionOf NormalFlow    
9c         Trim hasIndirectProperty RequiredCv atConditionOf MinimumFlow    
33         Trim hasIndirectProperty Size        
N/A         Trim hasAsPart CageOrGuide        
N/A             CageOrGuide type Type    
39             CageOrGuide hasAsMaterial Material    
N/A         Trim hasAsPart ClosingPart        
37             ClosingPart hasAsMaterial Material    
N/A         Trim hasAsPart Seat        
38             Seat hasAsMaterial Material    
N/A         Trim hasAsPart Stem        
40             Stem hasAsMaterial Material    
33a             Stem hasIndirectProperty RatedTravel    
10a             Stem hasIndirectProperty StemTravel atConditionOf MaximumFlow
10b             Stem hasIndirectProperty StemTravel atConditionOf NormalFlow
10c             Stem hasIndirectProperty StemTravel atConditionOf MinimumFlow
N/A ControlValve hasAsPart Actuator                
53     Actuator type Type            
54b     Actuator type ModelNumber            
62     Actuator hasIndirectProperty BenchRange            
58     Actuator hasIndirectProperty MaxAllowablePressure            
61a     Actuator hasIndirectProperty MaxAvailableAirPressure            
61b     Actuator hasIndirectProperty MinAvailableAirPressure            
59     Actuator hasIndirectProperty MinRequiredPressure            
63     Actuator hasIndirectProperty Orientation            
55     Actuator hasIndirectProperty Size            
54a     Actuator isMadeBy Manufacturer            
N/A     Actuator hasAsPart Handwheel            
63         Handwheel type HandwheelType        
N/A     Actuator hasAsPart Spring            
57         Spring hasAsBehaviour SpringAction        
N/A ControlValve hasAsPart AirSet                
79b     AirSet type ModelNumber            
80     AirSet hasIndirectProperty SetPressure            
79a     AirSet isMadeBy Manufacturer            
81a     AirSet hasAsPart AirFilter isRequired Yes/No        
81b     AirSet hasAsPart Gauge isRequired Yes/No        
N/A ControlValve hasAsPart Positioner                
68     Positioner type PositionerType            
69b     Positioner type ModelNumber            
70     Positioner hasAsBehaviour DirectOrReverseActing            
69a     Positioner isMadeBy Manufacturer            
71b     Positioner hasAsPart Bypass isRequired Yes/No        
71a     Positioner hasAsPart Gauges isRequired Yes/No        
72     Positioner hasAsPart Cam            
72         Cam type Characteristic        
N/A     Positioner hasAsInput InputSignal