You are on page 1of 188

iDB Catalogs for Standards 1

Administering project and


unit structures 2

Administering components 3
COMOS
Administering pipes 4
Process
P&ID Administration Administering connection of
objects 5

Administering functions 6
Operating Manual
Administering symbols with
extended elements 7
Administering the flow
direction 8
Administering the P&ID data
flow (attribute 9
synchronization)

Administering P&ID reports 10


P&ID functions for Graybox
and engineering task 11
Administering global symbol
colors (UseColorSets) 12
Administering the import /
export of plant components 13

Base data reference 14


Reference of script functions
for P&ID templates 15

03/2020 V 10.3.3
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
indicates that minor personal injury can result if proper precautions are not taken.

NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified
personnel are those who, based on their training and experience, are capable of identifying risks and avoiding
potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this
publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AG Copyright © Siemens AG 2013 - 2020.


Digital Industries Ⓟ 01/2020 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents

1 iDB Catalogs for Standards ..........................................................................................................................9


2 Administering project and unit structures ...................................................................................................11
2.1 Offered unit structures............................................................................................................11
2.2 Unit structures according to standard ....................................................................................11
3 Administering components .........................................................................................................................13
3.1 Global preset of component refreshing ..................................................................................13
3.2 Disabling automatic classification of components..................................................................13
3.3 Forcing action lines ................................................................................................................14
4 Administering pipes ....................................................................................................................................15
4.1 Base object for pipe structures...............................................................................................15
4.1.1 Preparing a base object of the pipe object.............................................................................15
4.1.2 Preparing a base object of the pipe section ...........................................................................16
4.1.3 Preparing a base object of the pipe segment.........................................................................17
4.1.4 Specifying references in the project properties ......................................................................18
4.2 Enabling selection of a standard pipe ....................................................................................18
4.3 Scripting a page reference for cross-page pipes ...................................................................19
4.4 Administering data flow via pipes and components ...............................................................20
4.5 Graphical properties of pipes .................................................................................................20
4.5.1 Note on standard pipe label ...................................................................................................20
4.5.2 Note on color settings for pipes..............................................................................................20
4.5.3 Apply graphical properties of a pipe.......................................................................................21
4.5.4 Enabling the user to set the graphical properties of pipe segments ......................................21
4.5.5 Applying properties of pipes to branches ...............................................................................22
4.6 Administering intersecting pipes ............................................................................................22
4.6.1 Administering representation of intersection ..........................................................................22
4.6.2 Customizing pipe priorities .....................................................................................................24
4.7 Deleting pipe / pipe section automatically ..............................................................................25
4.8 Administering automatic assignment of line types .................................................................26
4.8.1 Overview of automatic assignment of line types ....................................................................26
4.8.2 Specifying component types to be used ................................................................................26
4.8.3 Specifying the function used ..................................................................................................27
4.8.4 Specifying line types ..............................................................................................................27
4.8.5 Creating a "Line type class" attribute at objects used ............................................................28
4.9 Automatically placing T-pieces...............................................................................................29
4.10 Special features of reducers ..................................................................................................30
4.11 Connector symbol for pipe spec-relevant information............................................................30

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 3
Table of contents

4.12 Merging pipelines automatically .............................................................................................31


4.13 Administering jacket pipes .....................................................................................................32
5 Administering connection of objects ...........................................................................................................33
6 Administering functions ..............................................................................................................................35
6.1 Administering display of signal designations..........................................................................35
6.2 Preparing connection of functions and components ..............................................................36
6.3 Assigning function to a position..............................................................................................37
6.4 Administering process coupling and process connection ......................................................37
6.4.1 Assigning a process coupling to functions .............................................................................37
6.4.2 Interaction between process coupling and process connector ..............................................39
7 Administering symbols with extended elements.........................................................................................41
7.1 Overview of extended elements for P&ID drawing types .......................................................41
7.2 Using extended elements in the Symbol Editor .....................................................................42
7.3 Syntax of the *V*P test functions for extended elements.......................................................43
7.4 Controlling extended elements with placeholders from the outside .......................................44
7.5 Example with vessel and functions ........................................................................................45
7.6 Note on the interaction with functions ....................................................................................49
8 Administering the flow direction..................................................................................................................51
8.1 Administering the behavior of the flow direction.....................................................................51
8.2 Administering the behavior of the flow direction for multiway objects ....................................52
8.3 Administering a flow direction arrow ......................................................................................52
9 Administering the P&ID data flow (attribute synchronization).....................................................................53
9.1 Note on overview ...................................................................................................................53
9.2 Select attribute synchronization tool ......................................................................................53
9.3 Administering the data flow manager.....................................................................................53
9.3.1 Overview of the administration of the Data Flow Manager ....................................................53
9.3.2 Requirements for the report administration............................................................................54
9.3.3 Preparing general rules for a data flow break ........................................................................54
9.3.4 Preparing base data for the Data Flow Manager ...................................................................55
9.3.5 Preparing labels for the data flow break attribute...................................................................56
9.4 Administering the data flow via static attributes (UpdateConnected).....................................57
9.4.1 Introduction ............................................................................................................................57
9.4.2 Special consideration when calling the "UpdateConnected" function ....................................58
9.4.3 Data flow in detail...................................................................................................................58
9.4.4 Enabling data flow..................................................................................................................59
9.4.5 Configuring the "By connector" attribute link ..........................................................................59
9.4.6 Configuring how attribute families are handled ......................................................................60
9.4.7 Calling UpdateConnected ......................................................................................................62
9.4.8 Script call................................................................................................................................62

P&ID Administration
4 Operating Manual, 03/2020 V 10.3.3
Table of contents

10 Administering P&ID reports ........................................................................................................................65


10.1 Using and administering the context menu of the P&ID report ..............................................65
10.2 Administering Copy / Cut / Paste ...........................................................................................67
10.2.1 Scope of the chapter ..............................................................................................................67
10.2.2 Scheme for copying / cutting / pasting at pipes......................................................................68
10.2.3 Dependencies when copying and pasting objects .................................................................70
10.2.4 Interaction of copying/pasting with SortNewObjectsInCategories..........................................72
10.2.5 Interaction of cutting/pasting with SortNewObjectsInCategories ...........................................74
10.2.6 Enabling copying if the hierarchical structure up to a position ...............................................76
10.3 Administering Create new ......................................................................................................76
10.4 Administering hierarchies and references..............................................................................77
10.4.1 Administering the "Assign object" tool....................................................................................77
10.5 Interaction of a symbol change and the connectors...............................................................78
10.6 Administration of report templates .........................................................................................78
10.6.1 Automatically sorting objects into categories when placing them on the P&ID......................78
10.6.2 Extending the graphical settings ............................................................................................79
10.6.3 Locking editable text against editing ......................................................................................79
10.7 Editing the properties of the document object........................................................................80
10.7.1 Defining the base object for pipe sections .............................................................................80
10.7.2 "Equipment list" and "Pipe list" tabs .......................................................................................81
10.8 Administering symbols ...........................................................................................................82
10.8.1 Setting the size of connectors for P&ID objects .....................................................................82
10.8.2 Administering standard pipe labels ........................................................................................82
10.8.3 Administering pipe end symbols ............................................................................................83
10.8.4 Administering sheet reference symbols .................................................................................84
10.8.5 Administering a rotation correction for PFD symbols .............................................................85
10.8.6 Administering a scaling correction for PFD/P&ID symbols ....................................................86
10.8.7 Navigating to the owner in the symbol script..........................................................................86
10.9 Displaying coordinates of components ..................................................................................87
10.9.1 Quadrants/page areas ...........................................................................................................87
10.9.2 Creating zones .......................................................................................................................87
10.9.3 Displaying coordinates of page references ............................................................................87
10.9.4 Symbol script for page references (input) ..............................................................................88
10.10 Search functions for P&ID......................................................................................................89
10.10.1 GetDeviceConnectedToPipe..................................................................................................89
10.10.2 GetConnectorOfDeviceConnectedToPipe .............................................................................90
10.10.3 Search modes ........................................................................................................................90
11 P&ID functions for Graybox and engineering task......................................................................................95
11.1 Overview for administration of the "Graybox" function ...........................................................95
11.2 Preassign and disable "Select connection type" window .......................................................96
11.3 Use "A20 Placing and dissolving graybox P&ID" ...................................................................97
12 Administering global symbol colors (UseColorSets).................................................................................101
12.1 Aim and overview.................................................................................................................101

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 5
Table of contents

12.2 Administering queries for color configuration .......................................................................101


12.3 Specifying collision color ......................................................................................................103
12.4 Administering "ColorSets" in the report template .................................................................103
12.5 Administering properties of the engineering document........................................................104
12.6 Row report to represent the legend......................................................................................105
13 Administering the import / export of plant components ............................................................................107
13.1 Administering text recognition in AutoCAD drawings...........................................................107
13.1.1 Overview of the AutoCAD text recognition...........................................................................107
13.1.2 Sequence of the AutoCad text recognition...........................................................................108
13.1.3 Example for an implementation in the iDB ...........................................................................112
13.1.4 Class documentation DwgDxfInterface ................................................................................114
13.1.5 Script example .....................................................................................................................117
13.2 Administering a Conval interface .........................................................................................120
13.3 Administering a Microstation import (dgn, pid).....................................................................121
13.3.1 Configuration file "DGNImport1.xml" ....................................................................................121
13.3.2 Assigning a DGN line type to a COMOS line type ...............................................................122
13.3.3 Assigning a DGN layer to a COMOS layer ..........................................................................122
13.3.4 Assigning a DGN font to a Windows font .............................................................................123
13.3.5 Undoing an assignment .......................................................................................................124
13.3.6 Base objects from dgn data imports.....................................................................................124
13.4 Administering Pipe Easy ......................................................................................................124
13.4.1 Adding the "Show PipeEasy conversion settings" button to the toolbar ..............................124
13.4.2 Configuring tabs of the "Conversion settings" window .........................................................125
13.4.3 Creating base objects for text rules......................................................................................126
13.5 Administering Proteus import/export ....................................................................................128
13.5.1 Overview of the Proteus administration ...............................................................................128
13.5.2 Shared settings of import and export ...................................................................................129
13.5.2.1 Mapping COMOS attributes to Proteus attributes................................................................129
13.5.2.2 Standard tables ....................................................................................................................130
13.5.2.3 Reference of the "Proteus" tab.............................................................................................132
13.5.3 Configuring Proteus export ..................................................................................................134
13.5.3.1 Configuring the "Proteus export" category ...........................................................................134
13.5.3.2 Managing the "Proteus" tab .................................................................................................135
13.5.3.3 Hard-coded PlantItem types.................................................................................................137
13.5.3.4 Note on line types during export ..........................................................................................138
13.5.3.5 Reference of the included objects and graphics ..................................................................138
13.5.3.6 Reference to the included owner structure ..........................................................................140
13.5.4 Configuring Proteus import ..................................................................................................141
13.5.4.1 "Proteus" category: Defining search node ...........................................................................141
13.5.4.2 Creating "OnXMpLantImportDone" at COMOS objects .......................................................141
13.5.4.3 Base objects from Proteus data imports ..............................................................................142
13.5.4.4 Assigning COMOS line types to Proteus line types .............................................................142
13.6 Administering PDF import: String rule manager...................................................................143
13.7 Administering the "General P&ID export / import" interface .................................................145
13.7.1 Technical sequence of the interface ....................................................................................145
13.7.2 Editing project properties .....................................................................................................147

P&ID Administration
6 Operating Manual, 03/2020 V 10.3.3
Table of contents

13.7.3 Using the "Export" tab ..........................................................................................................148


13.7.4 Using the "Import" tab ..........................................................................................................149
13.7.5 Structure of the standard tables ...........................................................................................151
14 Base data reference .................................................................................................................................155
14.1 cDB master data for modular engineering ...........................................................................155
14.1.1 cDB master data for symbols and modules .........................................................................155
14.1.2 cDB master data for engineering tasks ................................................................................157
14.1.3 cDB master data for unit structure .......................................................................................160
14.2 Basic structure of the generic station description in the iDB ................................................160
14.3 Attributes with locally filtered units .......................................................................................160
14.4 Base object "@10 > A20 > A10 P&ID".................................................................................161
14.5 Base object "@10 > A20 > A10 > A10 Physical objects" .....................................................161
14.5.1 Labeling................................................................................................................................161
14.5.2 Symbol .................................................................................................................................161
14.5.3 Attributes, general ................................................................................................................164
14.5.4 "System data" tab.................................................................................................................164
14.6 Base object "@10 > A20 > A10 > A10 > A60 Elements and components"..........................164
14.6.1 Base object "@10 > A20 > A10 > A10 > A60 > A20 Nozzles and connections"..................165
14.7 Base object "@20 > A30 Functions" ....................................................................................166
14.7.1 Base object "@20 > A30 > A10 > A10 General functions" ..................................................166
14.7.2 Base object "@20 > A30 > A10 > A20 Measurement function" and "@20 > A30 > A10 >
A30 Actuating function". .......................................................................................................167
14.7.3 Scripts ..................................................................................................................................167
14.8 Base object "@20 > A80 > M22 > A10 Script library M22S00001 - M22S00050" ...............170
14.9 Base object "@20 > B20 > M20 > A20 Place and dissolve graybox P&ID" .........................170
14.10 Base object "@20 > D20 Base objects from external CAE data imports"............................170
14.11 Base object "@30 > M00 > A50 > A15 > A10 > A10 Vessels and tanks" ............................170
14.12 Base object "@30 > M00 > A50 > A15 > A30 Valves".........................................................171
14.13 Base object "@30 > M00 > A50 > A15 > A80 Add. graphics and symbol drawing".............171
14.13.1 Base object "@30 > M00 > A50 > A15 > A80 > A10 Text symbols P&ID" ..........................171
14.13.2 Base object "@30 > M00 > A50 > A15 > A80 > A30 Graphical symbols P&ID" ..................172
14.14 Base object "@30 > M00 > A50 > A15 ... ISO 10628:2012" ...............................................174
14.15 Base object "@30 > M00 > A80 > A10 Document library objects acc. to IEC 61355" .........175
14.16 Standard tables ....................................................................................................................175
14.17 Object classes of P&ID objects ............................................................................................177
15 Reference of script functions for P&ID templates.....................................................................................179
15.1 AllowMultipleDisplay ............................................................................................................179
15.2 AllowPrintingForDirectionArrow (Boolean)...........................................................................179
15.3 AutoConnectGrayboxes .......................................................................................................179
15.4 AutoPlaceTPiece (Integer) ...................................................................................................179

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 7
Table of contents

15.5 CheckAllOpenFunctionConns (Boolean) .............................................................................180


15.6 CheckAllOpenPipeConns (Boolean) ....................................................................................180
15.7 CheckPipeCutMode .............................................................................................................180
15.8 CObjectFullNameForPipe (String) .......................................................................................180
15.9 ConnectorRadius (Double)...................................................................................................181
15.10 CopyMainBranch (String).....................................................................................................181
15.11 CopyPipeConnectionAutoOff ...............................................................................................181
15.12 CreateDefaultPipeSegment (Boolean).................................................................................182
15.13 DrawPFDConnsUnderDocumentInBlue (Boolean) ..............................................................182
15.14 DrawPFDDevicesUnderDocumentInBlue (Boolean)............................................................183
15.15 DrawPipeEndSymbol (Boolean)...........................................................................................183
15.16 DrawPipeEndSymbolForSegment (Boolean).......................................................................183
15.17 DrawPipeConnectorSymbol (Boolean) ................................................................................183
15.18 DrawPipeEndSymbolForVertices (Boolean) ........................................................................184
15.19 EnableContinueDrawingConnection ....................................................................................184
15.20 EnableInteractiveEditableTexts............................................................................................185
15.21 SetImplementationByConcessionRI (Boolean) ....................................................................185
15.22 SetPipeFlagOnCreate (Boolean) .........................................................................................186
15.23 SortNewBranchUnderNewPipe (Boolean) ...........................................................................186
15.24 StdPipeFlagNoColor (Boolean)............................................................................................186
15.25 StdPipeNoReflect (Boolean) ................................................................................................186
15.26 SynchronizePipeConSymbol (Boolean) ...............................................................................187
15.27 SynchronizeStdPipeFlag (Boolean) .....................................................................................187

P&ID Administration
8 Operating Manual, 03/2020 V 10.3.3
iDB Catalogs for Standards 1
The following catalogs are prepared in the iDB:
● "@30 > M00 > A50 > A10 P&ID Catalog (in the style of ISO 10628:2000)"
● "@30 > M00 > A50 > A15 P&ID Catalog (in the style of ISO 10628:2012)"
● "@30 > M00 > A50 > A30 P&ID Catalog (in the style of ISA 5.x)"
The COMOS documentation prefers examples based on ISO 10628:2000. The statements in
the COMOS documentation regarding the base objects according to ISO 10628: 2000 also
apply to the use of the catalog ISO 10628: 2012. Deviations are documented separately.
For more on this topic, see also chapter Base object "@30 > M00 > A50 > A15 ... ISO
10628:2012" (Page 174).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 9
iDB Catalogs for Standards

P&ID Administration
10 Operating Manual, 03/2020 V 10.3.3
Administering project and unit structures 2
2.1 Offered unit structures
The unit structures that can are offered in the context menu when the "New" command is
selected depend on the project structure that was selected in the properties of an engineering
project. Category "General settings > Project", "Project structure" field
The unit structures are located in the base data under the base object node "@30 > M00 > A30
Units".
The structures according to EN follow the usual engineering structures of the chemical industry.

2.2 Unit structures according to standard

Structure according to EN
P&IDs are prepared for engineering within the unit structure. The unit structure according to EN
has an identical design, apart from a few P&IDs.
● "@30 > M00 > A30 > A20 > A10 > A10 > A10 Plant"
● "@30 > M00 > A30 > A20 > A10 > A20 > A10 Unit":
P&IDs can be created in the structures below the main unit.
● "@30 > M00 > A30 > A20 > A10 > A30 > A10 Subunit":
– P&IDs are created below the subunit.
– A number of category folders are created automatically below the subunit when a subunit
is created.
The Technique category creates a clearer structure for the engineering objects, for
example, by automatically collecting all pipes placed on a P&ID in one folder. You can
find additional information on this topic in the "P&ID Operation" manual, keyword
"Categories".
You do not usually need the "I&C (instrumentation & control)" folder until I&C
engineering. The positions are created below it, and the functions are created below. It
is sufficient for P&ID engineers to place functions on a P&ID.
You can find more information on this topic in the "EI&C Operation" manual, keyword
"Positions".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 11
Administering project and unit structures
2.2 Unit structures according to standard

P&ID Administration
12 Operating Manual, 03/2020 V 10.3.3
Administering components 3
3.1 Global preset of component refreshing
You can set up the project in such a way that COMOS automatically decides whether
components should be refreshed and whether pipe spec mapping should be carried out.

Default for refresh components


You set the default for the window to refresh the components, e.g., via the object debugger. Use
the following variable:
Workset.Globals.UpdateObject
● 1 = Show and hide the "Refresh components" window
● 3 = No window, always refresh components
● 4 = No window, never refresh components
You can find more information on this topic in the "P&ID Operation" manual, keyword "Overview
of data flow in the iDB".

Default for pipe spec mapping


You set the default for carrying out pipe spec mapping via the object debugger, for example.
Use the following variable:
Workset.Globals.ExecutePipeClass
1 = Show and reset the window for pipe mapping
3 = No window, always carry out pipe spec mapping
4 = No window, never carry out pipe spec mapping

3.2 Disabling automatic classification of components


Disable this function so that components are not automatically assigned to a pipe during
copying and pasting.

Procedure
1. Open the base project.
2. Open the "System data" tab in the properties of a component.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 13
Administering components
3.3 Forcing action lines

3. Place the following catalog attribute on the tab.


Path in the database: "@40 > A10 > Y00 > B10 > A90 > Y00A04713 Sorting locked"
You can find additional information on this topic in the "Administration" manual, keyword
"Placing catalog attributes on tabs".
4. Enable the newly created option.

See also
Dependencies when copying and pasting objects (Page 70)

3.3 Forcing action lines


To have an action line drawn instead of a pipe when you connect a component to other
components or pipes, set one of the following combinations of functional classification keys at
the component:
● 01C7; C160
● 01C7; C170
You can find more information on this topic in the "P&ID Operation" manual, keyword "Signal
lines".

P&ID Administration
14 Operating Manual, 03/2020 V 10.3.3
Administering pipes 4
4.1 Base object for pipe structures
Depending on the drawing type of the P&ID, a three-level pipe structure or a two-level pipe
structure is created when a user draws a pipe.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Pipe
structures".
To construct the pipe structure, first prepare the base objects, which will be used in the pipe
structure, and set the base object for pipe sections in the project properties.

4.1.1 Preparing a base object of the pipe object

Procedure
1. Open the base object properties of a pipe.
Path in the database: "@10 > A20 > A10 > A10 > A40 > A10 > A10 Pipe"
2. Make the following settings:
– "Class" = "Position"
– "Subclass" = "None"
– "Creation option" = "Normal"
– "Creation mode" = "Free"
3. Open the base object properties of a pipe.
Path in the database: "@30 > M00 > A50 > A10 > A40 > A10 > A10 Pipe"
4. Open the "System" tab.
5. Open the "Elements" tab.
6. Prepare a pipe section as an element.
7. Optional: Prepare additional elements.
You can find additional information on this topic in the "Administration" manual, keyword
"Creating elements at base objects".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 15
Administering pipes
4.1 Base object for pipe structures

4.1.2 Preparing a base object of the pipe section

Requirement
You have defined a pipe section as an element of a pipe in the base data. See also
chapter Preparing a base object of the pipe object (Page 15).

Procedure
1. Open the base object properties of the pipe section in the "@10" node.
Path in the database: "@10 > A20 > A10 > A10 > A40 > A10 > A20 Pipe section"
2. Open the "System" tab.
3. Make the following settings:
– "Class": "Position"
– "Subclass": "Pipe"
– "Creation option": "Normal"
– "Creation mode": "Free"
4. Open the "Connectors" tab.
5. Create an input "DI1" and an output "DQ1" of the type P&ID. The connectors must be named
"DI1" and "DQ1".
6. Open the properties of the pipe section in node "@30" which you created as element of the
pipe.
Path in the database: "@30 > M00 > A50 > A10 > A40 > A10 > A10 > A10 Pipe section"
7. Open the "Elements" tab.
8. Create a pipe segment named "SEG" as element.
Path in the database: "@30 > M00 > A50 > A10 > A40 > A10 > SEG Pipe segment"
You can find additional information on this topic in the "Administration" manual, keyword
"Adding elements".

Result
● If the user places a component with the attribute "Pipe cut mode" = "Segment separative"
on the pipe section, new pipe segments are created below the pipe section based on this
element. The branches are created below the pipe section and joined to the fitting by means
of their connectors.
If a pipe section is place on a P&ID, a pipe segment is created automatically below this pipe
section.
● If the user works in a P&ID with "M22_P1" drawing type, an engineering object of this pipe
section is created automatically below the pipe object when the pipe is drawn.

Sorting pipe sections automatically below objects


If the user places a pipe section on a P&ID, a pipe object is automatically created in the
Navigator and the pipe section is sorted below it.

P&ID Administration
16 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.1 Base object for pipe structures

To prevent pipe objects from being created automatically for pipe sections, create a base object
with the following properties for pipe sections:
● "Class": "Device"
● "Subclass": "Pipe"

See also
Preparing a base object of the pipe segment (Page 17)
Specifying references in the project properties (Page 18)

4.1.3 Preparing a base object of the pipe segment


Pipe segments are abstract objects that provide a logical view of the pipe.

Requirement
You have created a pipe segment as element of a pipe section. See also chapter Preparing a
base object of the pipe section (Page 16).

Procedure
1. Navigate to the inheritance source of the base object which you have created as element of
a pipe section.
Path in the database: "@10 > A20 > A10 > A10 > A40 > A10 > A30 Pipe segment"
2. Open the "System" tab in the properties.
3. Make the following settings:
Note
The name of the pipe segment must be "SEG". Do not change the name.

– "Class" = "Element"
– "Subclass" = "Pipe"
– "Creation option" = "Normal"
– "Creation mode" = "Free"
4. Open the "Connectors" tab.
5. Create an input "DI1" and an output "DO1" of the type P&ID. The connectors must be named
"DI1" and "DO1".
6. Open the properties of the base object which you have created as element of a pipe section.
Path in the database: "@30 > M00 > A50 > A10 > A40 > A10 > SEG Pipe segment"
7. Make the following settings:
– "Virtual" = "N times"
– "Inheritance mode" = "Active"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 17
Administering pipes
4.2 Enabling selection of a standard pipe

4.1.4 Specifying references in the project properties


You determine the base objects that can be used for forming the pipe structure in the project
properties:
"Process engineering" category, "Base object for pipe section" field
If no base object is specified in the engineering project, the link from the base project is used
automatically.

Requirement
You have prepared the base objects for pipe objects, pipe sections and pipe segments. See
also section:
● Preparing a base object of the pipe object (Page 15)
● Preparing a base object of the pipe section (Page 16)
● Preparing a base object of the pipe segment (Page 17)

Procedure
1. Open the "Process engineering" category in the project properties.
2. Drag&drop the "Pipe section" element into the "Base object for pipe section" field, which you
have created for the pipe object. See also section Preparing a base object of the pipe
section (Page 16).
Preset object in database: "@30 > M00 > A50 > A10 > A40 > A10 > A10 > A10 Pipe section"

Result
The pipe structure is built based on the structure that you have generated by creating the
elements.
● 1. level
Owner of the pipe section: Pipe
● 2. level
Pipe section
● 3. level
Element of the pipe section: Pipe segment

4.2 Enabling selection of a standard pipe


Customize the options script so that users are offered standard pipes for drawing a connection
in the context menu of an open P&ID with the command "Standard pipe for connecting".
You can find more information on this topic in the "P&ID Operation" manual, keyword "Selecting
a standard pipe".

P&ID Administration
18 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.3 Scripting a page reference for cross-page pipes

Making a pipe available as standard pipe


The "Standard pipe for connecting" command is only visible if at least two pipes are listed as
possible standard pipes.
1. Open the options script of a report template.
2. Search for the following code in the option script: Dim CObjectFullNameForPipes
3. To enter additional pipes as a possible standard pipes, increase the array
Example old: Dim CObjectFullNameForPipes(1)
Example new: Dim CObjectFullNameForPipes(2)
4. Enter a new line for CObjectFullNameForPipes(1) and enter SytsemFullName as the
value.
5. Example:
Set objAttPipeName = Document.Spec("Y00T00001.Y00A03023")
If Not objAttPipeName Is Nothing Then
Set objPipeLink = objAttPipeName.LinkObject
If Not objPipeLink Is Nothing Then
CObjectFullNameForPipes(0) = objPipeLink.SystemFullName
CObjectFullNameForPipes(1) = <SystemFullName of the
object>
End If
End If
This code offers users two base objects that they can select as standard pipe by means of
the context menu.
6. Optional: Specify additional base objects or extend the code.

4.3 Scripting a page reference for cross-page pipes

Objective
When you draw a pipe across several pages, the following data arise:
● On the report: Page references
● In the Navigator: Unconnected pipe segments
You can determine the counterpart of a page reference by means of a script.

Script command
● GetReferencedConnector
Transfer: The unconnected connector of a segment with a page reference
Return: The unconnected connector of the counterpart.
The segment searched for is the owner of the return object.

Example
Set Connector = a
Set PipeLib = CreateObject ("ComosPipeLib.PipeLib")

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 19
Administering pipes
4.5 Graphical properties of pipes

Set referencedCc = PipeLib.GetReferencedConnector (Connector)


If Not referencedCc Is Nothing Then
Set referencedSegment = referencedCc.Owner
Output referencedSegment.SystemFullName
End If

Other administration options


● See chapter Administering sheet reference symbols (Page 84).

4.4 Administering data flow via pipes and components


Two different functionalities are available in COMOS to regulate and automate the data flow
between pipes and components.
See chapter Administering the P&ID data flow (attribute synchronization) (Page 53).

4.5 Graphical properties of pipes

4.5.1 Note on standard pipe label


The color of the standard pipe labels can be administered. See also chapter Administering
standard pipe labels (Page 82).

4.5.2 Note on color settings for pipes


Color settings can also be selected for pipes. See also chapter Administering global symbol
colors (UseColorSets) (Page 101).

P&ID Administration
20 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.5 Graphical properties of pipes

4.5.3 Apply graphical properties of a pipe


Graphical properties are normally assigned to the pipe via the context menu. In the following
cases, the graphical properties of a pipe are automatically applied to other pipes:
● Connector of a branch
The following applies:
– CopyPipeConnectionAutoOff is not available or is False:
The graphical attributes are automatically taken over.
– CopyPipeConnectionAutoOff is True:
The user is asked whether a copy is required (graphical attributes are continued) or not
(a default pipe is generated).
● Connector at the component
The pipe is connected to a component that is connected to an existing pipe via a connector.
The following applies:
– The cut mode of the component is determined.
"Segment separative" cut mode A copy is generated and the graphical attributes are
continued
All other cut modes: No copy is created and a default pipe is created.

4.5.4 Enabling the user to set the graphical properties of pipe segments
As standard, users cannot change the graphical properties of pipe segments. You can make
this possible as follows.

Procedure
1. Navigate to the base object for pipe segments in the base project.
2. Open the "Attributes" tab in the properties.
3. Create a new "Graphical options" tab.
Path in the database: "@10 > A20 > A10 > A10 > A40 > A10 > A20 > Y00T00039 Graphical
options"

Result
Users can change the graphical properties of pipe segments.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Changing graphical properties of pipes".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 21
Administering pipes
4.6 Administering intersecting pipes

4.5.5 Applying properties of pipes to branches


When drawing a branch, you can either automatically apply all properties or only the pipe spec
and the nominal diameter of the connected pipe to the branch.

Note
CopyPipeConnectionAutoOff is ignored
If the script option CopyMainBranch is set, the script option CopyPipeConnectionAutoOff is
ignored.

Applying all properties


1. Open the script options of a report template.
2. Add the following to the script to apply the graphical properties of the connected pipe
automatically to the branch:
CopyPipeConnectionAutoOff = false
3. Write the following in the script to let users decide in a window whether the graphical
properties of the connected pipe should be applied:
CopyPipeConnectionAutoOff = true

Apply pipe spec and nominal diameter


1. Open the script options of a report template.
2. Write the script option CopyMainBranch with a corresponding value in the script. See also
chapter CopyMainBranch (String) (Page 181).

Result
If the user draws a branch on the P&ID away from a pipe, the selected action is executed.

4.6 Administering intersecting pipes

4.6.1 Administering representation of intersection

Objective
In the options script of report templates, you define how intersecting pipes are displayed.
You can find more information on this Proteus interface in the "P&ID Operation" manual,
keyword "Using intersecting pipes".

P&ID Administration
22 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.6 Administering intersecting pipes

I. Graphical intersection without connection


● IntersectionRadius <= 0
The pipes intersect.
Example:

II.a Graphical interruption with semicircle

● DrawIntersectionArc = True ● DrawIntersectionArc = True


● IntersectionRadius > 0 ● IntersectionRadius > 0
● CutHorizontal = False (Default) ● CutHorizontal = True
The horizontal connection receives the semi‐ The vertical connection receives the semicir‐
circle. cle.

One of the two pipes is drawn with a semicircle. The radius is defined by
IntersectionRadius.
Example:

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 23
Administering pipes
4.6 Administering intersecting pipes

II.a Graphical interruption with gap

● DrawIntersectionArc = False ● DrawIntersectionArc = False


● IntersectionRadius > 0 ● IntersectionRadius > 0
● CutHorizontal = False (Default) ● CutHorizontal = True
The horizontal connection receives the gap. The vertical connection receives the gap. This
case is in the style of the DIN standard.

One of the two pipes is cut visually by generating an invisible circle with the specified radius.
Example:

See also
Customizing pipe priorities (Page 24)

4.6.2 Customizing pipe priorities


The user can select a priority in the properties of pipe sections in the "Pipe priority" field of the
"Attributes > Graphical options" tab. The pipe priorities influence the positioning on the P&ID for
intersecting pipes (foreground/background) as well as the line type, line strength, and the line
color.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Setting
pipes to foreground/background via properties".
You can adapt the pipe priorities offered in the following standard table:
● "@40 > Y00 > A10 > C20 > Y00N00481 Pipe section"

P&ID Administration
24 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.7 Deleting pipe / pipe section automatically

You can add to the standard table and modify values.

Column Description
"Description" Entry that is offered to the user for selection in the "Pipe priority" list.
"Value 1" Applies to the main pipe and to parallel pipes.
Determines whether a pipe is located in the foreground or the background when
two pipes cross one another.
A pipe with a higher value is located further in the foreground than a pipe with a
lower value. If two pipes with the same value cross one another, the script
option CutHorizontal makes the decision.
See chapter Administering representation of intersection (Page 22).
"Value 2" Defines the line color of the main pipe. The color is specified in Windows format
BGR.
"Value 3" Defines the line width of the main pipe.
"Value 4" Defines the line type of the main pipe. You can take the available values from the
standard table "Y10 > M20 > A10 > Y10M20N00008 Media line types", "Value
1" column.
"Value 5" Defines the line color of parallel pipes. The color is specified in the Windows
format BGR for the line color.
"Value 6" Defines the line width of parallel pipes.
"Value 7" Defines the line type of parallel pipes.
You can take the available values from the standard table "Y10 > M20 > A10 >
Y10M20N00008 Media line types", "Value 1" column.

Converting RGB color to BGR color


To convert the RGB color to a BGR color, use the following formula:
BGR = (blue * 65536) + (green * 256) + red
Example with orange: RGB: 255, 128, 64 0 ⇒ BGR: (64*65536) + (128*256)+255 = 4227327

4.7 Deleting pipe / pipe section automatically

Deleting pipe automatically


By default, the pipes are configured so that they are not deleted automatically if the user deletes
the last pipe section below the pipe.
1. Open the base object properties of a pipe.
2. Select the "Attributes > System data" tab.
3. Edit the "Autodelete" option.
4. Confirm your entries.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 25
Administering pipes
4.8 Administering automatic assignment of line types

Deleting pipe sections automatically


By default, pipes sections are configured so that they are deleted automatically if the user
deletes the last pipe segment below the pipe section.
1. Open the base object properties of a pipe section.
2. Select the "Attributes > System data" tab.
3. Edit the "Autodelete" option.
iDB: Y00T00001.Y00A04711
cDB: RI.AutoDelete
4. Confirm your entries.

4.8 Administering automatic assignment of line types

4.8.1 Overview of automatic assignment of line types

Using automatic line types


You can automatically set the line type depending on the connected component when drawing
a connection. Following these steps to do this:
1. Set condition: Determine the source and destination of the connection
At least one of the two objects must be a component. An object may also be a function.
See chapter Specifying component types to be used (Page 26).
See chapter Specifying the function used (Page 27).
2. Set effect: Determine the graphic style of the line if the condition in step 1 is fulfilled.
See Specifying line types (Page 27).
3. Optional: Add the "Device type" attribute in the attributes of the base objects of the
components and functions.
See also Creating a "Line type class" attribute at objects used (Page 28).

Application
You can find additional information on this topic in the "P&ID Operation" manual, keyword
"Using automatic assignment of line types".

4.8.2 Specifying component types to be used

Requirement
● You are familiar with automatic assignment of line types.
For more, see chapter Overview of automatic assignment of line types (Page 26).

P&ID Administration
26 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.8 Administering automatic assignment of line types

Procedure
To specify the component types to be used, follow these steps:
1. Select the "Assign line types" command in the "Plugins > Basic" menu.
The "Assign line types" window opens.
2. Select the "Component types > Equipment" tab.
3. Click the "Add component type" button.
The "Add component type" window opens.
4. Enter the key of the component, e.g. ARM.
5. Enter a description of the component if needed.
6. Close the dialog box by clicking "OK".
Repeat the procedure if the line type is planned for the connection between two components.
Define a function when the line type is planned for the connection between the component and
function. For more, see chapter Specifying the function used (Page 27).

4.8.3 Specifying the function used

Requirement
● A component is defined as a source or destination
For more, see chapter Specifying component types to be used (Page 26).

Procedure
To specify the function used, follow these steps:
1. Select the "Assign line types" command in the "Plugins > Basic" menu.
The "Assign line types" window opens.
2. Select the "Component types > Functions" tab.
3. Click the "Add component type" button.
The "Add component type" window opens.
4. Enter the key of the function, for example ARM.
5. Enter a description of the function if needed.
6. Close the dialog box by clicking "OK".

4.8.4 Specifying line types

Requirement
● The used component types are created.
For more, see chapter Specifying component types to be used (Page 26).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 27
Administering pipes
4.8 Administering automatic assignment of line types

Specifying the connection type


To specify the connection type, follow these steps:
1. Select the "Assign line types" command in the "Plugins > Basic" menu.
The "Assign line types" window opens.
2. Select the "Connection types" tab.
3. In the "Drawing type" list, select the reports to which the connection type should apply.
The list types shows connections types that are prepared for this drawing type.
4. Click on the "Add function type" button.
The "Add connection type" window opens.
5. Enter the source and target object of the desired connection.
Optional: Change the entry in the "Drawing type" list.
6. Close the dialog box by clicking "OK".
Now edit the graphical properties of the connection type.

Setting the graphic properties of the connection type


To specify the line type of the connection, follow these steps:
1. Select the desired connection type in the top table.
2. In the "Line settings" area, specify the line type, line width, line color and the level of
connection.

Result
The line types are specified. COMOS generates the following standard tables:
● "Standard tables > Y10 > M20 > A10 > Y10M20N00003 > Y10M20N00003A01 Equipment
types for line type assignment"
● "Standard tables > Y10 > M20 > A10 > Y10M20N00003 > Y10M20N00003A02 Function
types for line type assignment"
● "Standard tables > Y10 > M20 > A10 > Y10M20N00003 > Y10M20N00003A03 Line types
for line type assignment"

4.8.5 Creating a "Line type class" attribute at objects used

Procedure
To add the "Line type class" attribute to the attributes of the base objects, follow these steps:
1. Navigate in the base project to the base object of the P&ID object, for which you want to use
automatic line types.
2. Open the base object properties.
3. Select the "Attributes > System data" tab.

P&ID Administration
28 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.9 Automatically placing T-pieces

4. Select the "Design mode" command in the context menu of the tab.
The design mode is activated.
5. Select the "New > Attribute" menu command in the context menu in the tab.
6. Enter "Y00A04485" as the name.
7. Enter "Line type class" as the description.
8. Link this attribute with the standard table:
Note
Remove lock
In order to use the "Assign line types" interface, remove the lock on the standard tables.

– For components:
"Standard tables > Y10 > M20 > A10 > Y10M20N00003 > Y10M20N00003A01
Equipment types for line type assignment"
– For measuring functions
"Standard tables > Y10 > M20 > A10 > Y10M20N00003 > Y10M20N00003A02 Function
types for line type mapping"
9. Close the dialog box by clicking "OK".
10.Activate working mode.
11.In the newly created attribute, select a value that specifies the component or measurement
function.
12.Save the base object.

4.9 Automatically placing T-pieces


You can specify whether a T-piece or a dynamic connection is automatically placed when you
draw branches or whether this can be defined by the user.
The following steps are required:
● Create the "Link to base object T-piece" attribute at the pipe, if it does not exist.
● Insert a script option in the option script of a report template.

Create "Link to base object T-piece" attribute at the pipe


1. Open the "Base objects" tab in the base project.
2. Open the properties of the pipe for which you want to set automatic placement of the T-piece.
3. Open the "Attributes > System data" tab.
4. Go to design mode.
5. Create the "Link to base object T-piece" attribute on the tab.
Path in the database: "@40 > A20 > Y00 > A10 > A10 > Y00T00001 > A06 > B01 > C01 >
Y00T00001 > Y00A03023 Link to base object T-piece"
6. Change to working mode.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 29
Administering pipes
4.11 Connector symbol for pipe spec-relevant information

7. Drag&drop the base object of a T-piece into the newly created field.
8. Confirm your entries.

Inserting a script option


1. Open the options script of a report template.
2. Insert the script option "AutoPlaceTPiece = True" in the script.
See also section AutoPlaceTPiece (Integer) (Page 179).
3. Confirm your entries.

Result
Depending on the setting of the "AutoPlaceTPiece" script option, either a T-piece is placed
automatically, a dynamic connection is created or a window with a query opens up. This
happens if the following conditions are met:
● The user draws a pipe which has the "Link to base object T-piece" attribute as branch to
another pipe.
● The user works on a P&ID which is based on the edited report template.

4.10 Special features of reducers


Reducers have the following attributes:
● "Design data" tab: "Nominal diameter 1" and "Nominal diameter 2"
The following applies on P&ID reports: The reducer is automatically rotated, if necessary, to
perfectly match the existing nominal diameters of the pipe and the components. For technical
reasons, the attributes "Nominal diameter 1" and "Nominal diameter 2" are also swapped in this
case. This means the larger nominal diameter can be entered in "Nominal diameter 1" as well
as "Nominal diameter 2".
The following applies to isometric reports and pipe spec mapping: "Nominal diameter 1" always
contains the larger nominal diameter.
If the "P&ID" module is used together with one of the "Isometrics" or "Pipe spec mapping"
modules, you must ensure that the larger nominal diameter is entered in "Nominal diameter 1"
for all reducers.

4.11 Connector symbol for pipe spec-relevant information


A connector symbol is a flag that evaluates the connection information of components. It
indicates on P&IDs whether connected objects deviate from each other in pipe spec-relevant
attributes.
A symbol script is evaluated in the base project to display the connector symbol. In the
database, the script icon in the standard table "Standard tables > Y10 > M00 > A10 >
Y10M00N00020 Connection symbol (spec break)" is set for the corresponding drawing type.

P&ID Administration
30 Operating Manual, 03/2020 V 10.3.3
Administering pipes
4.12 Merging pipelines automatically

In the database, the script for the "M22_P1" drawing type is configured in such a way that it
compares the values of the following attributes:
● Nominal diameter (Y00T00003.Y00A03451), flag text: "Size"
● Nominal pressure (Y00T00003.Y00A03449), flag text: "Rating"
● Pipe spec (Y00T00003.Y00A03453), flag text: "Class"
Customize the symbol script to evaluate other attributes.

4.12 Merging pipelines automatically

Requirement
● The graphical merger of two half-open pipelines on the report is familiar.
You can find additional information on this topic in the "P&ID Application" manual, keyword
"Merging pipelines graphically".

Using "PipeLib"
"PipeLib":
public int MergePipes(IComosDDevice TargetPipe, IComosDDevice
SourcePipe, bool deleteSourcePipe = false, bool showDialog = true)
Parameter:
● TargetPipe
The selected and therefore pipeline to be retained . This pipeline is also used in background
mode, i.e. when no dialog appears (showDialog = False).
● SourcePipe
The pipeline to be discarded.
● deleteSourcePipe
This switch determines whether the pipeline to be discarded, <SourcePipe>, will also be
deleted in the Navigator.
● showDialog
Switches between background mode and the user dialog.
– True (default): The user dialog appears. The user decides which pipe is retained.
– False: Background mode. The use of the pipeline is controlled by <TargetPipe> and
<SourcePipe>.
Return:
● 0: Merger is not possible. Function aborts without merger.
● 1: Merge was performed.

Example script
Set PipeLib=CreateObject("ComosPipeLib.PipeLib")
If Not PipeLib Is Nothing Then

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 31
Administering pipes
4.13 Administering jacket pipes

PipeLib.MergePipes a, b, false, false


End If
Parameter:
● "a": <TargetPipe>
● "b": <SourcePipe>
● First "False": Discarded pipeline "b" is retained in the Navigator.
● Second "False": Background mode. No user dialog

4.13 Administering jacket pipes

Procedure
1. Switch to the base project.
2. Open the base object properties of the pipe segment.
3. Create the following attribute:
– cDB: "RI" tab, "JACKET" attribute
Suggestion for attribute description: "Jacket pipe"
– iDB: "Y00T00039 Graphical options" tab, "Y00A02186" attribute type: "Checkbox"
Suggestion for attribute description: "Jacket pipe"
4. Confirm your entries.

P&ID Administration
32 Operating Manual, 03/2020 V 10.3.3
Administering connection of objects 5
Pipes: "Sub Connect(Connector)" script
When you connect a component to pipes, the Sub Connect(Connector) script is called
either at the pipe section or on the pipe segment.
The script contains the GetDeviceConnectedToPipe call and optionally the
GetConnectorOfDeviceConnectedToPipe call. These calls determine the connected
components. See also chapter Search modes (Page 90).
If connecting the pipes takes too much time, you should check whether the script "Connect" is
necessary. The following is an example for the pipe segment:
1. Navigate to the base object of the pipe section in the base data.
2. Select the pipe segment in the "Elements" tab.
3. Open the properties of the pipe segment.
4. Select the "Script" tab.
5. Check whether the "Connect" script is necessary.
6. If the script is not always necessary, create a pipe base object in which this script is not
always called.
See also GetDeviceConnectedToPipe (Page 89) and
GetConnectorOfDeviceConnectedToPipe (Page 90).

Pipes: Automatic T-pieces


See chapter Automatically placing T-pieces (Page 29).

Functions: Link to the component


See chapter Preparing connection of functions and components (Page 36).

Extended elements / intelligent subsymbols


See chapter Using extended elements in the Symbol Editor (Page 42).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 33
Administering connection of objects

P&ID Administration
34 Operating Manual, 03/2020 V 10.3.3
Administering functions 6
6.1 Administering display of signal designations

Requirement
● The display of signal designations is known at the function symbol.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Showing signal designations at the function symbol".

Database adjustments
● Script library:
"@20 > A80 > M00 > A20 > M00S00075 PlaceSignalsSymbol"
● The script evaluates the following attributes:
"Y00T00001 System data" tab:
– "Y00A00523 Display signals" attribute
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Showing signal designations at the function symbol".
– "Y00A05704 Sort order of signals" attribute
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Sort signal designations at the function symbol".
– "Y00A05705 Pre-configuration of signals" attribute
This attribute controls which signals are always visible.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Showing signal designations at the function symbol".
● Example database:
– "@30 > M00 > A60 > A10 Function structure (in relation to DIN 19227-1:1993)"
– "@30 > M00 > A60 > A30 Function structure (in relation to IEC 62424:2008)"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 35
Administering functions
6.2 Preparing connection of functions and components

6.2 Preparing connection of functions and components

Alternative 1: Usage of a general function and evaluation of the classification


You can connect functions with components using drag&drop. In this case, a valve, a nozzle or
similar component may be created if needed. Such engineering objects to be placed in addition
are determined as follows:
1. Function: Tab "Y00T00001 System data", attribute "Y00A03278 Link to component"
This attribute defines the general engineering object for the function. The general
engineering object provides the classifications by means of which the function is identified.
First, the user-defined functional classification is evaluated, then the system-specific
functional classification.
2. Project properties, category "Process Development" option "Standard table for replacing
general with specific elements"
A search is made for a specific engineering object in the standard table derived from the
general engineering object of the function. This concrete engineering object is placed on the
report.
Default in the iDB: The standard table "Y10 > M00 > A20 > Y10M00N00033 Symbol bar
elements" is used.
3. Component / pipeline: an element must be created on the base object to serve as a process
connection, when the function is connected.
– This element must have a functional classification that matches the determined
classification from step 1.
– This element must have suitable connectors.

Alternative 2: Usage of a specific function


When you connect the function to the component or the pipe, the object entered in the
"Y00A03278 Link to component" attribute is placed without further search.

Deleting unnecessary dynamic connectors


Connection objects that are not being used can arise in the standard database. Example:
1. There are three measurement functions on the report.
2. The two measurement functions 1 and 2 are connected.
The connection creates an action line on the report.
3. The measurement function 3 is connected to the action line.
This creates a dynamic connector for measurement function 1 as well as for measurement
function 2. Measurement function 3 is connected to one of the two dynamic connectors. The
other dynamic connector remains unconnected.
The additional dynamic connection objects are also referred to as "auxiliary connectors". You
can find further information on this topic in the "Operation" manual, keyword "Working with
auxiliary connectors".

P&ID Administration
36 Operating Manual, 03/2020 V 10.3.3
Administering functions
6.4 Administering process coupling and process connection

Auxiliary connectors that are not required for measuring functions can be deleted with a
COMOS attribute:
● "System data" tab, "Autodelete for not-connected connectors".
If necessary, you can also delete excess auxiliary connectors in the script with
AutoDeleteFreeConnectors. See also chapter Scripts (Page 167).

Similar functions
See chapter Administering process coupling and process connection (Page 37).

6.3 Assigning function to a position

Objective
In some cases, positions are created automatically when you work with functions. You can find
more information on this topic in the "P&ID Operation" manual, keyword "Create positions
automatically".
In order for positions to be created automatically, the base object for positions must be specified
in the PositionCDeviceFullName script variable of the function.

Procedure
1. Navigate to the base object of a function.
2. Open the "Script" tab in the properties.
3. Edit the PositionCDeviceFullName script variable.
Default in the iDB:
The script block "UserScriptBlock2" is used.
The script variable uses the following attribute: "System data" tab, "Y00A03023 Link to
position" attribute.

6.4 Administering process coupling and process connection

6.4.1 Assigning a process coupling to functions


For a process coupling to be created in addition when a measurement function or actuating
function is created, you need to configure the base object of the function.

Requirement
The following parameter is set in the options script of the report template:
EnableProcessConnection = TRUE

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 37
Administering functions
6.4 Administering process coupling and process connection

The automatic creation of the process coupling can also be set separately for measurement
functions and actuating functions:
● Only generate for measurement functions:
EnableProcessConnectionSensor = True
● Only generate for actuating functions:
EnableProcessConnectionActor = True

Procedure
1. On the base data end, open the "Attributes > System data" tab in the properties of a function.
2. Go to design mode.
3. Navigate to the following attribute:
"@40 > A10 > Y00 > A70 > B30 > Y00A03278 > Y00A03278 Component for process
coupling".
4. Drag&drop the attribute into the "System data" tab.
5. Set the value "Reference" in the "Type of display" list in the attribute properties.
6. Confirm your entries.
7. Change to working mode.
8. Drag&drop a process coupling to the "Component for process coupling" field.
Example: "@30 > M00 > A50 > A10 > A60 > A20 > A10 > A30 Nozzle for functions"
Note
Changing the process coupling
For the user to be able to change the process coupling, the "Y00T00001.Y00A03278"
attribute must also exist at the nozzle that you dragged to the "Component for process
coupling" field. You can refer to an inline device there, for example. In the inline device, you
then refer back to the nozzle so that the user can switch between the inline device and the
nozzle.

Result
If the function is created on the engineering end, the process coupling is also created.
In the case of measurement functions, the process coupling is automatically connected not only
visually on the report but also to the function (via its connectors). That is not the case for
actuating functions. Reason: The valve still needs to be prepared further and will be assigned
a drive. The function then needs to be connected with the drive.

See also
Interaction between process coupling and process connector (Page 39)

P&ID Administration
38 Operating Manual, 03/2020 V 10.3.3
Administering functions
6.4 Administering process coupling and process connection

6.4.2 Interaction between process coupling and process connector

Requirement
● You are familiar with the process coupling for functions.
See chapter Assigning a process coupling to functions (Page 37).

Process connection via tabs and connectors


In order to be able to connect a function to the process, the function needs a process connector.
The process connector is implemented using several tabs that are created with the function.
The tabs save information about the process connector and are updated via VSUI attributes or
statically linked attributes. The number of tabs a function possesses depends on how often it
is connected to the process.

Tabs at a measurement function


In the case of measurement functions with an inline device the number of tabs is fixed; for
measurement functions with a nozzle the number of tabs is variable.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Process
connector measurement function".

Tabs at an actuating function


The tabs are created on connection to a process connector. The number of tabs depends on
the concrete actuating function and is strictly defined for this.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 39
Administering functions
6.4 Administering process coupling and process connection

P&ID Administration
40 Operating Manual, 03/2020 V 10.3.3
Administering symbols with extended elements 7
7.1 Overview of extended elements for P&ID drawing types

Requirement
● You are familiar with the operation of the Symbol Editor.
You can find additional information on this topic in the "Administration" manual, keyword
"Configuring symbols".
● You are familiar with placing text in the Symbol Editor.
You can find additional information on this topic in the "Administration" manual, keyword
"Placing "text" in the symbol".
● For this you use a P&ID drawing type.

Objective
The "Extended elements" function comprises the following components:
● Text function "*V*P EXE: ..."
This text function can either define a nozzle or a dynamic connector.
● Text "*V*P IM: ..."
This text function recognizes the associated text function "*V*P EXE: ..." by its ID and
generates a connection line, if necessary.

Overview
● Using extended elements in the Symbol Editor
See chapter Using extended elements in the Symbol Editor (Page 42).
● Syntax of the *V*P test functions for extended elements
See chapter Syntax of the *V*P test functions for extended elements (Page 43).
● Controlling extended elements from the outside: Usage of a placeholder
See chapter Controlling extended elements with placeholders from the outside (Page 44).
● Example of extended elements
See chapter Example with vessel and functions (Page 45).
● Special cases when using extended elements
You can find more information on this topic in the "P&ID Operation" manual, keyword "Using
symbols with extended elements".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 41
Administering symbols with extended elements
7.2 Using extended elements in the Symbol Editor

7.2 Using extended elements in the Symbol Editor

Requirement
● Objective and overview are known.
See chapter Overview of extended elements for P&ID drawing types (Page 41).
● For this you use a P&ID drawing type.

Creating extended elements using the text tool


1. Place a text.
2. Open the properties of the text.
3. Select the entry "Element > Extended element" in the left-hand list.
The "Extended element properties" window opens.
– "Element name": Enter a text.
– "ID": Enter a unique string. Remember the string.
– "Connection type": Select "Create nozzle" or "Create connection".
– "Create nozzle": COMOS creates a nozzle at the position of the "Extended element
connector". A corresponding connector element must be prepared at the base object. If
no "Nozzle" element with the name "NOZZLE" has been prepared at the base object, no
connection is created. For more on this, see Base object "@10 > A20 > A10 > A10 > A60
> A20 Nozzles and connections" (Page 165).
– "Create connection" COMOS creates a dynamic connection at the position of the
"Extended element connector".
4. Select the entry "Element > Extended element connector" in the left-hand list.
The "Properties" window opens.
– "ID": Enter the same ID as for the "Extended element" element.
There is currently no check for duplicate IDs. Make sure that each pair of "Extended
element" and "Extended element connector" has its own ID.
– "Connector name": Enter a text.
5. You can also move the two text functions to any position of the symbol later.

See also
Syntax of the *V*P test functions for extended elements (Page 43)

P&ID Administration
42 Operating Manual, 03/2020 V 10.3.3
Administering symbols with extended elements
7.3 Syntax of the *V*P test functions for extended elements

7.3 Syntax of the *V*P test functions for extended elements

Requirement
● Objective and overview are known.
See chapter Overview of extended elements for P&ID drawing types (Page 41).
● For this you use a P&ID drawing type.

Syntax
Extended element:
● *V*P EXE:Symbol("ElementName");ID=<0815>;ConType=[NOZZLE;DynCon]*
– "ElementName"
"ElementName" identifies the element that is to be placed at the base object. You can
also enter a path for "ElementName". See chapter Navigating to the owner in the symbol
script (Page 86).
– ID
String. The ID must match the ID of "*V*P IM: ...".
– ConType: "NOZZLE"
Default is no ConType is set.
COMOS creates a nozzle at the position of the "Extended element connector". A
corresponding connector element must be prepared at the base object. If no "Nozzle"
element with the name "NOZZLE" has been prepared at the base object, no connection
is created. For more on this, see Base object "@10 > A20 > A10 > A10 > A60 > A20
Nozzles and connections" (Page 165).
– ConType: "DynCon"
COMOS creates a dynamic connection at the position of the "Extended element
connector".
Example: *V*P EXE:Symbol("M1");ID=1234;ConType=Nozzle. The placed element
symbol has the name "M1" and the ID "1234". The connection type "Nozzle" is specified for
"Extended element connector".
Extended element connector:
● *V*P IM:<ID>;<TargetConnector>*
– ID
String. The ID must match the ID of "*V*P EXE: ...".
– TargetConnector
Name of the connector to be connected.
Example: *V*P IM:1234;DI3*. This text item connects with the connector "DI3" of the
extended element "1234".

See also
Example with vessel and functions (Page 45)

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 43
Administering symbols with extended elements
7.4 Controlling extended elements with placeholders from the outside

7.4 Controlling extended elements with placeholders from the outside

Requirement
● Objective and overview are known.
See chapter Overview of extended elements for P&ID drawing types (Page 41).
● For this you use a P&ID drawing type.

Objective
Extended elements of a symbol can be controlled without having to administer the symbol text.
To do this a placeholder is used that reads an attribute value. If the attribute is edited, the
extended element changes accordingly.

Administering placeholders
1. Open the properties of the base object at which you want to create a symbol with an
extended element.
Example:
"@30 > A50 > A15 > A10 > A10 > A10 > A10 Vessel, general, with optional agitator"
2. Select the "Y00T00039 Graphical options" tab.
3. Create the following attribute:
Name: "Y00A01464AA01"
Description: "Subsymbol #AA01 ="
Display type: Edit field
Type: Alphanumeric
4. If required, create additional incremented attributes.
Example: Name: "Y00A01464AA02" / Description: "Subsymbol #AA02 ="
Maximum: 99
5. Alternative: Navigate to the inheritance source of the "Y00T00039 Graphical options" tab
and edit the source.
In this case all base objects that use this tab contain the new attributes.
6. Confirm your entries.
7. Open the symbol.
8. For example, generate the following symbol text:
*V*P EXE:Symbol("#AA01");ID=123;ConType=DynCon*

P&ID Administration
44 Operating Manual, 03/2020 V 10.3.3
Administering symbols with extended elements
7.5 Example with vessel and functions

9. Confirm your entries.


10.Write the path information and element name in the value of the Y00A01464AA01 attribute.
– The pipe character | is prohibited in the attribute value.
– Use a backslash \ instead.
COMOS automatically replaces the backslash with the pipe character when transferring
the string into the symbol text.
Example for an attribute value:
..\..\A50\001\001
In the symbol text, #AA02 is replaced exactly by the string of the attribute value (with the
exception of the character replacement for the backslash). Therefore the path information
in the attribute value does not have quotation marks.

Implementation in the cDB


1. Open the properties of the base object at which you want to create a symbol with an
extended element.
Example:
"@01 > PID > 01 > 01 > 03 > 01 B Single-chamber container"
2. Select the "RI P&ID options" tab.
3. Create the following attribute:
Name: "Y00A01464AA01"
Description: "Subsymbol #AA01 ="
Display type: Edit field
Type: Alphanumeric
4. If required, create additional incremented attributes.
Example: Name: "Y00A01464AA02" / Description: "Subsymbol #AA02 ="
Maximum: 99

7.5 Example with vessel and functions

Requirement
● Objective and overview are known.
See chapter Overview of extended elements for P&ID drawing types (Page 41).
● For this you use a P&ID drawing type.

Preparing test data


The following example applies to the iDB for COMOS 10.3.
1. Create either a test database or test working layers for engineering project and base project.
2. Create the following object in the "Units" tab:
"Neu > A40 Plant (general)"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 45
Administering symbols with extended elements
7.5 Example with vessel and functions

3. Create the following object for the "Plant" object using the context menu:
"New > A10 Plant"
4. Create the following object for the created "Plant" object using the context menu:
"New > A10 Subunit"
5. Create the following report for the created "Subunit" object using the context menu:
"New > FB.04? P&ID Flow chart in the style of EN 10628, DIN A3"
6. Open the node "A10 Subunit".
7. Create the following object in the "A10 Equipment" category folder:
"New > A10 Vessels and tanks > A10 Vessels and tanks with agitator > A10 Vessels general
with optional agitator"
8. Create the following objects in the "A50 EI&C" category folder:
"New > D Density"
"New > D Density"
9. Create the following object in the context menu of "001 Density" and "002 Density":
"New > D Density"

Preparing the symbol


The following object was created while preparing the test data: "A10 Equipment" category
folder: Engineering object "B001 Vessel general, with optional agitator".
1. Use the following command in the context menu of the "B001 Vessel general, with optional
agitator" engineering object:
"Navigate > Base object in base project"
2. Open the base object properties.
3. Switch to the "Symbols" tab.
4. Select the row "M22_P1 R&I (ISO 10268)".
5. Click on the "Show symbol script" button in the "Symbols" tab.
– If available: Deactivate the "Graphically write-protected" option in the script editor below.
This removes the following script row: "' @DO NOT EDIT@"
6. Confirm your entries and close the script editor.
7. Double-click the symbol in the "Symbol" column of row "M22_P1 R&I (ISO 10268)".
The Symbol Editor opens.
8. Enlarge the symbol until you can see the vessel wall very clearly.
9. Select the text tool and click on the line of the vessel wall with the mouse cursor.
10.Right-click on the working area to exit the text function.
11.Create a second text function in the same way and place it on the opposite vessel wall.
12.Create two additional text functions with a noticeable gap from the vessel wall.

P&ID Administration
46 Operating Manual, 03/2020 V 10.3.3
Administering symbols with extended elements
7.5 Example with vessel and functions

13.Open the text properties one after the other. Edit the text functions as follows:

① On the vessel wall: "Element > Extended ele‐ ID: Test_123


ment connector" Connector name: DI3
② On the vessel wall: "Element > Extended ele‐ ID: Test_456
ment connector" Connector name: DI3
③ Next to the vessel: "Element > Extended ele‐ Element name: ..|..|A50|001|001
ment" (note syntax of the items)
ID: Test_123
Connection type from: "Create connection"
④ Next to the vessel: "Element > Extended ele‐ Element name: ..|..|A50|002|001
ment" (note syntax of the items)
ID: Test_456
Connection type from: "Create nozzle"

14.Check the result in the Symbol Editor.

– *V*P EXE:Symbol("..|..|A50|001|
001");ID=Test_123;ConType=Nozzle*
– *V*P EXE:Symbol("..|..|A50|002|
001");ID=Test_456;ConType=DynCon*
– *V*P IM:Test_123;DI3*
– *V*P IM:Test_456;DI3*

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 47
Administering symbols with extended elements
7.5 Example with vessel and functions

15.Explanation of the example syntax of the element name: "..|..|A50|001|001" or


"..|..|A50|002|001":
This syntax maps the hierarchical structure of the test data:
– Navigate two layers up starting from the vessel
– Then address the density function in the folder "A50" in the density object "001" or "002".
– See also chapter Navigating to the owner in the symbol script (Page 86).

16.Optional: Set the font size to "4" for all text functions. This approach makes it easier to work
in the Symbol Editor because the symbol is more clearly displayed.
17.Click on "Save" in the Symbol Editor and close the Symbol Editor.
18.Save the changes of the base object.

Checking the result


1. Open the P&ID report.
2. Place the vessel.

P&ID Administration
48 Operating Manual, 03/2020 V 10.3.3
Administering symbols with extended elements
7.6 Note on the interaction with functions

See also
Note on the interaction with functions (Page 49)

7.6 Note on the interaction with functions


If you create your own symbols for equipment, you also have to edit the "System data" tab.
The system data are a prerequisite for the automatic coupling between the process elements.
● For more on this, see Preparing connection of functions and components (Page 36).
● For more on this, see Assigning function to a position (Page 37).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 49
Administering symbols with extended elements
7.6 Note on the interaction with functions

P&ID Administration
50 Operating Manual, 03/2020 V 10.3.3
Administering the flow direction 8
8.1 Administering the behavior of the flow direction
The "Cancel requirements" attribute changes the behavior of the flow direction.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Changing the flow direction of multiple objects".

Procedure
1. Open the properties of a base object on which you would like to set the attribute.
2. Select the "Attributes > System data" tab.
3. Go to design mode.
4. In the base data, navigate to the attribute "@40 > A10 > Y00 > A20 > C20 > Y00A00992 >
Y00A00992 Cancel requirements".
5. Place the attribute on the selected tab.
6. Confirm your entries.

Result
The standard table "Y10 > M20 > A10 > Y10M20N00011 Cancel conditions for flow direction"
is stored at the "Cancel requirements" attribute. Depending on which value the user selects at
the engineering end, the attribute has the following effects:

"Name" column "Description" column Column Result


"Value 1"
A000 - A000 This is the default setting. Ap‐
plies if no value or an invalid
value has been entered.
Symbol is mirrored; the pipe
run is processed further.
A010 Cancel A010 Start or target; flow direction is
not changed; the pipe run is
not processed any further.
A020 Multiway object A020 Flow direction is not changed;
the pipe run is processed fur‐
ther.

COMOS uses the "Cancel requirement = 0" attribute to check whether there are several flows
for a component that have been defined with the following attribute: "Multiway object". See also
section Administering the behavior of the flow direction for multiway objects (Page 52).
If the flow direction changes, COMOS only mirrors the connectors affected by the change in
flow direction.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 51
Administering the flow direction
8.3 Administering a flow direction arrow

8.2 Administering the behavior of the flow direction for multiway objects
You use this attribute on multiway objects. The "Multiway object" attribute can be set at the
component so that multiple connectors dependent on the flow direction can be used.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Change
in flow direction for multi-way objects".

Procedure
1. Open the properties of a base object on which you would like to set the attribute.
2. Select the "Attributes > System data" tab.
3. Go to design mode.
4. In the base data, navigate to the attribute "@40 > A10 > Y00 > A90 > C20 > Y00A04491
Multiway object".
5. Place the attribute on the selected tab.
6. Confirm your entries.

Defining the flow direction


After you have set the "Multiway object" attribute on the component, you can define the flow
direction in the attribute. Define the flow directions by defining the connector pairs.
Separate the associated connectors of the multiway objects with a semicolon.
Example: "Multiway object = DI1>DO1;DI2>DO2"

Result
When the flow direction at a connector changes, the connector is swapped with its partner
connector. The change of flow direction is passed on to the connected pipe.

8.3 Administering a flow direction arrow


The representation of the flow direction is controlled by an attribute.
1. Open the base object properties.
2. Switch to the "Y00T00039 Graphical options" tab
3. Create the following attribute:
– Visual type: Check box
– Name: Y00A01223
– Description: "Show flow direction arrow"
– Value 0: Hide flow direction arrow, value 1: Show flow direction arrow

P&ID Administration
52 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute
synchronization) 9
9.1 Note on overview
The overview of the P&ID data flow in the iDB is described in the "P&ID Operation" manual,
keyword "Overview of the data flow in the iDB".

9.2 Select attribute synchronization tool

Procedure
1. Open the project properties.
2. Select the category "Process engineering > Attribute synchronization tool".
3. Select one of the two entries:
– "Refresh components"
– "Data Flow Manager"
4. Confirm your entries.

Usage
● Data Flow Manager
See chapter Administering the data flow manager (Page 53).
● Refresh components / UpdateConnected
See chapter Administering the data flow via static attributes (UpdateConnected) (Page 57).

9.3 Administering the data flow manager

9.3.1 Overview of the administration of the Data Flow Manager

Overview
● Check the project properties.
See section Select attribute synchronization tool (Page 53).
● Check the report options.
See section Requirements for the report administration (Page 54).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 53
Administering the P&ID data flow (attribute synchronization)
9.3 Administering the data flow manager

● Edit the general data break rules.


See section Preparing general rules for a data flow break (Page 54).
● Edit the base data.
See section Preparing base data for the Data Flow Manager (Page 55).
● Optional: Edit the display of break labels.
See section Preparing labels for the data flow break attribute (Page 56).

9.3.2 Requirements for the report administration

Requirement
● You are familiar with the overview of the administration.
See section Overview of the administration of the Data Flow Manager (Page 53).

EnableVSUI2
The option script of the report template for P&ID contains the "EnableVSUI2 = TRUE" variable.
If the value is set to "True", the properties tree is displayed automatically when you open the
report.
You can find additional information on the attribute filters in the properties tree in the
"Administration" manual, keyword "Preparing attribute filters".

9.3.3 Preparing general rules for a data flow break

Requirement
● You are familiar with the overview of the administration.
See section Overview of the administration of the Data Flow Manager (Page 53).

P&ID Administration
54 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute synchronization)
9.3 Administering the data flow manager

Procedure
1. Open the base project.
2. Select the following standard table:
"Standard tables > Y10 > M22 > A10 > Y10M22N00013 General rules for data flow break"
3. Edit the standard table according to the following scheme:
– "Name" column: Unique string.
Recommendation: Use the iDB-compliant enumeration [A10, A20, ...]
– "Description of the break attribute" column For free use.
Recommendation: Enter the "Description" property of the attribute here.
– "Nested name of the break attribute" column: Identification of the attribute according to
the scheme "Tab name.Attribute name".
– "Classifications of break objects" column: You use this information to determine which
objects are searched and used for the attribute. The classification can be found in the
properties of the base objects in the "Classification" tab, "Hierarchical classification" field.
If each classification is valid, enter the asterisk "*" as a wildcard.
Multiple classifications are separated by semicolons without spaces.

Effect
The Data Flow Manager breaks the data flow for the identified attribute if the target object has
the specified classification.

9.3.4 Preparing base data for the Data Flow Manager

Requirement
● You are familiar with the overview of the administration.
See section Overview of the administration of the Data Flow Manager (Page 53).

Base objects

Note
Synonyms
For reasons of legibility, the following pairs of terms are used synonymously in this Chapter:
● Data flow break flag / data break flag
● Data flow break object / data break object

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 55
Administering the P&ID data flow (attribute synchronization)
9.3 Administering the data flow manager

The Data Flow Manager considers the following objects:


● "@30 > M00 > A50 > A15 > A80 > A30 >B70 Data flow break flag"
The data break flag does not generate an engineering object and has no connectors. The
data break flag exists only graphically on the report. The context menu of the data break flag
on the report contains the "Navigate >" command. This "Navigate >" command contains a
navigation to the engineering object of the component to which the data break flag belongs.
– Attribute "Y00T00001.Y00A02625 VSUI attributes"
The attribute remains empty in the base data. Because the data break flag does not
generate an engineering object, COMOS uses the VSUI attribute of the component or
the pipe section to which the data break flag is assigned.
– Attribute "Y00T00001.Y00A05706 Data flow break"
The attribute is only processed by COMOS. The attribute remains empty in the base
data.
Because the data break flag does not generate an engineering object, COMOS uses the
attribute of the same name of the component or pipe section to which the data break flag
is assigned.
● "@30 > M00 > A50 > A15 > A80 > A30 >B80 Data flow break object"
The data break object generates an engineering object and has connectors of its own. The
connectors are automatically attached to the connectors on the segments of the pipe when
the data break object is used.
– Attribute "Y00T00001.Y00A02625 VSUI attributes"
The attribute is edited in the base data.
– Attribute "Y00T00001.Y00A05706 Data flow break"
The attribute is only processed by COMOS. The attribute remains empty in the base
data.

Additional information about the attributes


● "Y00A02625 VSUI attributes"
The attribute contains the maximum list of attributes that can be offered in the "Data Flow
Manager: Break attributes" window. In order for an attribute to actually be offered in the
window, it must also be available as a VSUI attribute for the source object.
● "Y00A05706 Data flow break"
With engineering objects, the attribute contains the specification about the attributes for
which the user has interrupted the data flow in the "Data Flow Manager: Break attributes"
window.

9.3.5 Preparing labels for the data flow break attribute

Requirement
● You are familiar with the overview of the administration.
See section Overview of the administration of the Data Flow Manager (Page 53).

P&ID Administration
56 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

Procedure
1. Open the base project.
2. Select the following standard table:
"Standard tables > Y10 > M22 > A10 > Y10M22N00014 Labels for data flow break attribute"
3. Edit the standard table according to the following scheme:
– "Name" column: Unique string.
Recommendation: Use the iDB-compliant enumeration [A10, A20, ...]
– "Description of the break attribute" column For free use.
Recommendation: Enter the "Description" property of the attribute here.
– "Nested name of the break attribute" column: Identification of the attribute according to
the scheme "Tab name.Attribute name".
– "Indicator" column: This string is displayed in the flag.

Effect
1. The standard table is evaluated when data break flags or data break objects are used.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Using
data break flags and data break objects".
2. COMOS checks whether there is an entry in the standard table above for each affected
VSUI attribute.
3. COMOS checks whether an attribute is set for the data flow break in the "Data Flow
Manager: Break attributes" window.
4. If a data flow break is set, an additional diamond is created and the text in "Indicator" column
is displayed in the diamond.
5. If a data flow break is canceled, the diamond is hidden again.

9.4 Administering the data flow via static attributes (UpdateConnected)

9.4.1 Introduction

Requirement
● You are using the synchronization tool attribute "Refresh components".
See chapter Select attribute synchronization tool (Page 53).

Objective
Perform attribute changes via static links manually and individually.
The "UpdateConnected" function automates attribute changes based on static links and also
offers the option to influence updating. The passing of attributes to connected components is
conducted in one direction until it is ended by stop criteria.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 57
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

You can find additional information on this topic in the "P&ID Operation" manual, keyword "Data
flow between P&ID objects".

9.4.2 Special consideration when calling the "UpdateConnected" function

Updating objects
The "UpdateConnected" function updates all the connected objects starting from a P&ID start
object.
The "UpdateConnected" function is triggered in the following cases:
● Editing of a P&ID object in the properties
● Editing of a P&ID object in the properties tree
You can specify that the properties tree should be displayed automatically when you open
a P&ID. To do this, set the EnableVSUI2 = True report option in the report template.
You can find additional information on the properties tree in the "Administration" manual,
keyword "Functions for the options script".
● Special case: Properties in the toolbar
If you set the EnableVSUI2 = False report option in the report template, the attributes
are displayed in the toolbar and not in the properties tree. When you edit the attributes in the
toolbar of the P&ID, COMOS updates the connections of valves only if you assign the script
"GetConnectorSpecification" to the valve.
The attributes in the toolbar are only available if the properties tree is hidden.
You can find more information about this script under Configuring how attribute families are
handled (Page 60).

Additional information
The "UpdateConnected" function calls up the "Update devices" window. You can find more
information on this topic in the "P&ID user" manual, keyword "Updating connected components
and pipe sections".

9.4.3 Data flow in detail


The "UpdateConnected" function is executed recursively for all connectors of the start object;
in other words, data flows in all directions and via multiple objects.
The following applies per step:
● Connected components are found through connections.
● Each connected component is searched for attributes that are connected statically via a
connector: Depending on how you call "UpdateConnected", the search is performed only for
attributes appearing in the attributes filter in the properties tree or for all attributes connected
statically via a connector.
● For each target attribute, the search looks for the counter connection of the connection
entered in the "Connection name" field.

P&ID Administration
58 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

● If the object of the counter connection has the "GetConnectorSpecification" script block, this
script block is executed. All objects that have attributes from an attribute family have to
implement this script block.
● Attributes from an attribute family further serve as a stop criteria. Their value is only
forwarded if the object implements the "GetConnectorSpecification" script block.
See also section Configuring how attribute families are handled (Page 60).
● If the object of the counter connection does not have this script block, the search looks for
the source attribute specified for the object in the "Attribute" field, and its value is written to
the target attribute.
● If it is not possible to forward a value (because the attribute on the connected object does
not exist, for example, or because the attribute is not linked), the data flow for this attribute
is stopped at this level.
● If key attributes for pipe spec mapping were updated using the "UpdateConnected" function,
the user has the option to start pipe spec mapping once the data has been forwarded.

9.4.4 Enabling data flow


You must perform the following actions to enable the data flow:
1. Perform an action that calls the "UpdateConnected" function.
See also section Calling UpdateConnected (Page 62).
2. Set a "By connector" static link for all attributes of components connected with the start
object which are to be updated.
See also section Configuring the "By connector" attribute link (Page 59).
3. If an attribute on a component exists in different forms and the attribute is, therefore, part of
an attribute family, you must implement the "GetConnectorSpecification" script block at the
component.
Example: The two nominal width attributes of a reducer.
See also section Configuring how attribute families are handled (Page 60).
4. When the dialog is opened via "UpdateConnected", the user must confirm that data flow is
to take place.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Updating connected components and pipe sections".

9.4.5 Configuring the "By connector" attribute link

Requirement
The link is set up in the base data.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 59
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

Procedure
Data transfer is implemented using the COMOS attribute link method. To implement data
transfer, you must proceed as follows to configure all attributes on P&ID components that are
updated through data flow:
1. Open the properties of the attribute.
2. Select the "Link" tab.
3. Select "By connector" from the "Link type" list.
4. From the "Connector name" list, select the name of one or more connectors which transfers
the attribute value to the component.
5. Enter the NestedName of the required attribute in the "Attribute" field.
Example: Attribute = "Y00T00003.Y00A00744"
If the attribute value can be linked to the component by a number of connectors, use
commas to separate each of them.
6. Select "Static" from the "Value" control group.
7. Click "OK" to save your inputs and close the dialog window.

Example
Valve: Attribute "Y00T00003.Y00A00744 Nominal diameter (DN)",
link type = "By connection", value = "Static",
Connector name = "DI1,DO1", Attribute = "Y00T00003.Y00A00744"
The valve is added to a the pipe section. The nominal diameter of the pipe changes, thereby
calling the "UpdateConnected" function. Regardless of whether the update is performed via the
valve input or output, the value entered for the pipe section in the "Nominal diameter (DN)"
attribute from the nominal diameter attribute of the valve.

9.4.6 Configuring how attribute families are handled


There are objects that own attributes with different characteristics. Such attributes are part of
an attribute family.
Example: The two nominal width attributes of a reducer or the two nominal pressure attributes
of a pump.

P&ID Administration
60 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

Special features for "UpdateConnected"


The attributes of an attribute family are of particular significance with regard to data exchange:
● A component that is connected to a component, which owns an attribute with several
characteristics, needs to know from which attribute it has to apply the value.
If a component has two attributes of one attribute family, the names of the target attribute
and the source attribute will not always be identical. The name of the source attribute may
differ dependent upon which connector forwards the attribute value to a component.
However, you can only enter one attribute name in the "Attribute" field on the "Link" tab.
You must therefore implemented the "GetConnectorSpecification" script block to
components with attribute families. It explicitly maps the connection and attributes to each
other.
Example:
– A reducer is built into a pipeline with a nominal diameter of 100.
– "Y00A03452 Nominal diameter at inlet": Nominal diameter 100
– "Y00A03451 Nominal diameter at outlet": Nominal diameter 125
Result:
The pipeline is divided into two pipeline sections. Pipe section A (connected to the input of
the reducer) must apply the "Y00A03452 Nominal diameter at inlet" value; pipe section B
(connected to the output of the reducer), on the other hand, must apply the value from
"Y00A03451 Nominal diameter at outlet".
● Attributes of an attribute family serve as stop criterion in the context of data transfer.
Example:
A reducer connects pipe section A with pipe section B. The nominal diameter of pipe section
A changes. Up to the reducer, all components connected to A apply the new nominal
diameter. The following applies to reducers: The input adopts the new nominal diameter
("Y00A03452 Nominal diameter at inlet"), the output ("Y00A03451 Nominal diameter at
outlet") does not.
Result:
All objects connected directly or indirectly to the output of the reducer retain their old nominal
diameter value.

"GetConnectorSpecification" script block


Components with attributes from attribute families must have the "GetConnectorSpecification"
script block.
If a component has this script block, the "Connector name" field is no longer evaluated.
Implement the script block at the base object of a component so that attributes which do not
belong to an attribute family are also taken into account.

Name GetConnectorSpecification
Parameter: Device:
Owner of the connector via which the attribute arrives at the component.
ConnectorName:
The name of the connector via which the attribute value arrives at the component (= counter connection of
the component which is to be updated).
SpecName:
Attribute name in the link.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 61
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

Example: GetConnectorSpecification for "@30 > M00 > A50 > A10 > A30 > A10 > A20
> A10 > A10 General 3-way valve"
Set GetConnectorSpecification =
Project.Workset.Lib.CallScriptLib("@20|A80|M22|A10|M22S00002",_
"GetConnectorLinkedAttribute3Way", Device, ConnectorName, SpecName,
objThisDev)
You can find additional information on this topic in the "Administration" manual, keyword
"GetConnectorSpecification (Device, ConnectorName, SpecName)".

9.4.7 Calling UpdateConnected


The "UpdateConnected" function starts and controls data transfer. "UpdateConnected" is
called in the following cases:
1. If you enter a new value on the toolbar and then click the "Apply" button.
All attributes of the start object that appear on the toolbar are forwarded. These attributes
are automatically passed on as parameters when the function is called.
When you call "UpdateConnected" via the toolbar, the call to "UpdateConnected" via the
"OnEditOk" script block is ignored.
2. If a called script block calls the "UpdateConnected" function.
In the COMOS DB, many P&ID components are configured so that their "OnEditOk" script
block explicitly calls "UpdateConnected".
Consequence:
Data transfer starts when you click "OK" or "Apply" in the properties of a component.
All component attributes that have a "By connector" static link are updated, not just those
that were edited at the start object.
3. If a base object is placed on a P&ID and is therefore connected with other components.
All component attributes that have a "By connector" static link are updated.
"UpdateConnected" is not called when you place and connect a component from the
engineering data on a P&ID for the first time.

9.4.8 Script call


The script calls of the UpdateConnected function are listed below.

Standard call
This call checks all attributes:
Workset.Lib.RI.UpdateConnected ThisObj

Alternative calls
This call checks all attributes:
Set CInst = CreateObject("ComosPIDUpdate.Lib")
CInst.PIDUpdate. UpdateConnected StartDev, ""

P&ID Administration
62 Operating Manual, 03/2020 V 10.3.3
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

This call only checks the attributes for which you have specified their NestedName:
Set CInst = CreateObject("ComosPIDUpdate.Lib")
CInst.PIDUpdate. UpdateConnected StartDev, "<NestedName
A>;<NestedName B>"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 63
Administering the P&ID data flow (attribute synchronization)
9.4 Administering the data flow via static attributes (UpdateConnected)

P&ID Administration
64 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports 10
10.1 Using and administering the context menu of the P&ID report

Context menu of the P&ID


When the context menu for the P&ID is called (i.e. no object has been selected), the following
commands are available:
● "Options > Set point of origin"
Determines the point of origin of the P&ID (default point of origin: top left corner). This is
evaluated, for example, if a P&ID is placed on another P&ID: P&ID A will be placed with its
point of origin at the location of P&ID B, which the user has designated with the mouse.
● "Options > Scale"
Changes the scale of P&ID. The symbols are scaled accordingly.
● "Options > Construction"
Two new switches have been added to the toolbar:
– "Dimension"
A purely graphical dimensioning line that can be controlled in the report script using the
following options: DimensionSymbol, DimensionTextHeight, DimensionUnit.
Note
Changed dimensioning text without underscore
Use the following script option to turn off the underscore for changed dimensioning texts:
DoNotUnderlineDimensionOverwriteText = True
You can find additional information on this topic in the "Administration" manual, keyword
"Functions for the options script".
– "Hatching"
Functions in the same way as the hatching tool of the Report Designer. You can find
additional information on this topic in the "Administration" manual, keyword "General
rules for designing symbols".
● "Options > Autogrouping mode"
In this mode, P&ID objects that are connected with each other are automatically assembled
into a group.
If you connect two groups together, the two groups merge into one group.
If you connect an "Element" type component to another P&ID object, the owner of the device
is automatically included in the group.
If you cut a pipe, which was created when autogrouping mode was disabled, the P&ID
objects at the end of the pipe are not added to the new group.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 65
Administering P&ID reports
10.1 Using and administering the context menu of the P&ID report

● "Options > Import"


To import drawings. Opens the "Import and dissolve drawing" dialog:
Select a drawing type from the drop-down list and determine the import file. Confirm with
"OK".
In the dialog that follows, you can specify the unit conversion and stipulate whether the
drawing is to be imported into the engineering data and placed on the P&ID, or whether only
suitable base objects are to be generated:
● "Connect automatically"
If two engineering objects are connected in the Navigator by means of a pipe, but the
connection no longer exists in the P&ID, this command automatically draws the connection
(the pipe) on the P&ID as well.
● "Select color settings..."
See chapter Administering global symbol colors (UseColorSets) (Page 101).
● "Updating color settings"
See chapter Administering global symbol colors (UseColorSets) (Page 101).
● "Place template"
You can find additional information on this topic in the "Operation" manual, keyword
"Placing objects by inserting a template".
● "Check"
Compares the report objects and DocObjs of a P&ID and thus detects any inconsistent
references. (This refers to cases in which the DocOb still exists but the report object has
been deleted.).
● "Inconsistency > ..."
"...> Show previous", "... > Show next", "... > Analyze", "... > Delete all inconsistent objects"
Analyzes the diagram and verifies whether there are any inconsistencies (missing report
objects, wrong flow direction, etc.). You can find additional information on this topic in the
"Administration" manual, keyword "Deletion in interactive reports".

Context menu of a selected object


Varies according to the number and type of the selected objects.
● Cut/copy and paste
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Cutting/copying and pasting on P&IDs".
● Multiple objects selected: "Grouping > ...":
– "... > Create", "... > Cancel", "... > Restore", "... > Remove from group": self-explanatory
● Pipe and device selected: "Connection > ..."
"... Delete": Deletes the selected pipe on the P&ID and in the Navigator, and deletes the
connection made by the COMOS connectors.
"... Options" and "... Settings": Access to the pipe context menu commands of the same
name.
● Pipe and a device selected: "Device > ..."
"... Delete": Deletes the selected device on the P&ID and in the Navigator, and deletes the
connection made by the COMOS connectors.
"... Options", "...> Settings", and "...> Graphical settings": Access to the device context menu
commands of the same name.

P&ID Administration
66 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

● "Options > ..."


– "... > Delete free connectors"
Deletes connectors that were created dynamically and are no longer needed.
Example: A vessel is connected to a pipe via a connector. Then, the pipe is deleted. The
dynamic connector of the vessel is also deleted.
– Various menu items for the editing and mirroring of the symbol and to restore the original
symbol.
– " ... > Lock"
The symbol cannot be changed on the P&ID until it has been released again via "Options
> Release". (No move or delete, many commands are deactivated.)
– " ... > Graphical properties"
Graphical properties of the symbol such as color, line type, and line thickness can be set
here.
● "Settings > ..."
– "... Solid" and "... Search text"
– "... Connector labels visible"
● "Graphical settings"
Use this context menu to set attributes of the selected object, with their form being displayed
by means of the symbol. Example: The outer wall of a vessel.
Exactly which attributes are offered here is determined by the system to some extent. The
administrator can change the selection with the script option AddToGraficalParameter.
See also chapter Extending the graphical settings (Page 79).

10.2 Administering Copy / Cut / Paste

10.2.1 Scope of the chapter


Note on terminology: Fitting

Interaction of the factors relevant for pasting


The exact behavior of pipes and functions during cutting and pasting is not part of this overview.
Information regarding this can be found in separate sections:
● With regard to pipes: You can find more information on this topic in the "P&ID Operation"
manual:
– Keyword "Pipe segments and pipe sections when copying"
– Keyword "Pipe segments and pipe sections when cutting"
● With regard to functions: You can find more information on this topic in the "P&ID Operation"
manual:
– Keyword "Functions and positions when copying"
– Keyword "Functions and positions when cutting"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 67
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

If an object is placed on a pipe when pasted, the pipe is separated according to the pipe cut
mode of the object.
If the component is to be pasted parallel to the connected pipe and the pipe is located in a
category, a search is made for a category located in parallel into which the component can be
sorted.

See also
Scheme for copying / cutting / pasting at pipes (Page 68)

10.2.2 Scheme for copying / cutting / pasting at pipes

Requirement
● You are familiar with the delimitation.
See chapter Scope of the chapter (Page 67).

P&ID Administration
68 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

Scheme

&3 &RPSRQHQW
<$RSWLRQ 6RUWSDUDOOHOWRWKHGLVFRQ
,QVHUWFXWRXW&3 QHFWHGSLSHVHJPHQW

,VWKH&3FRQQHFWHGWRDSLSHGXULQJSDVWLQJ" &RQQHFW
VFULSWRIWKHSLSHLVFDOOHG

1R <HV

&DOOVFRQQHFWVFULSW

6HW'HYLFH2ZEHU%\&RQQHFWRU
"

1R <HV

<$RSWLRQDFWLYDWHG"

1R <HV

,QVHUW&3DFFRUGLQJWRSDVWH ,QVHUW&3SDUDOOHOWR ,QVHUW&3XQGHUFRQQHFWHG


PRGH FRQQHFWHGSLSH SLSH

"SetDeviceOwnerByConnector" script
This script determines where a pipe separating component is inserting:
● For components that separate piping sections: Next to the connected pipe object
● For components that separate piping segments: Under to the connected pipe object
Pipe separation components are moved to the same unit structure in which the pipe is located.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 69
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

10.2.3 Dependencies when copying and pasting objects


Note on terminology: Fitting
The dependencies that exist when you paste objects are listed below. These dependencies
have an effect on the paste behavior and the paste location.
The copied objects are inserted according to the paste mode if they were connected with a pipe
during pasting, but the pipe does not call the SetOwnerbyDeviceConnector function in the
Connect script.

1HZFRS\PRYH

7DUJHWLVSLSH &RS\DVSHUSDVWH
SLSH&RQQHFWFDOOHG " PRGH (QG
1R

&RQQHFWFDOOV &RQQHFWFDOOV
<HV 6HW'HYLFH2ZQHU%\ <HV  6HW'HYLFH2ZQHU%\
&RQQHFWRU" &RQQHFWRU"

Which objects were selected?


A number of object types have a special form of paste behavior:
● Objects with the class: "Function", subclass: "None"
● Components identified as fittings:
"System data" tab, enable "Sort parallel to the disconnected pipe branch" option
Example: Valves and reductions
Some objects require a specific owner structure.
Example: Functions and pipes.
In this case, in addition to a copy of the original being pasted, a copy of the owner structure is
created as well.

P&ID Administration
70 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

Which paste mode was selected?


The diagram below gives you an overview of the interaction between these factors. The exact
behavior of pipes and functions during copying and pasting is not part of this overview.
Information regarding this can be found in separate sections:
● With regard to pipes: You can find more information on this topic in the "P&ID Operation"
manual, keyword "Pipe segments and pipe sections" and keyword "Pipe cut mode".
If an object is placed on a pipe when pasted, the pipe is separated according to the pipe cut
mode of the object.
● With regard to functions: You can find more information on this topic in the "P&ID Operation"
manual, keyword "Working with functions".
<$RSWLRQ 6RUWSDUDOOHOWRWKHGLVFRQ
8QGHILQHG QHFWHGSLSHVHJPHQW

VWDWH

1R

/D\FRPSRQHQW
<$ 3LSHFXWPRGH &XWVSLSH" SDUDOOHOWRWKH
<HV DYDLODEOH" <HV 1R VHSDUDWHG
RSWLRQDFWLYH
HOHPHQW

1R <HV

0RYHFRPSRQHQW
6RUWLQJLQ &RPSRQHQWILWV WRWKH
FDWHJRULHV <HV RQHRI <HV FDWHJRU\IROGHU (QG
DFWLYDWHG" WKHFDWHJRULHV"

&RPSRQHQWLV
1R 1R FUHDWHGXQGHUWKH
GRFXPHQW

Is the object connected with a pipe during pasting?


In this case, the Connect event of the pipe is triggered and the
function SetDeviceOwnerbyConnector is called in the event.
Function call:
Workset.lib.ri.SetDeviceOwnerbyConnector connector,true

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 71
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

You can prevent the automatic classification of components. See also section Disabling
automatic classification of components (Page 13).

Move
Components are moved automatically in the following cases:
● The component is located below the P&ID.
● The component is connected to a pipe.
● The pipe is assigned to a unit.
Example: A fitting is loosely placed on the P&ID. The fitting is later incorporated into a pipe.
See also section Scope of the chapter (Page 67).

See also
Interaction of copying/pasting with SortNewObjectsInCategories (Page 72)

10.2.4 Interaction of copying/pasting with SortNewObjectsInCategories


A distinction is made between two possible statuses in the examples.
● The automatic sorting of new objects on the P&ID into categories is activated.
SortNewObjectsInCategories = TRUE
● The automatic sorting of new objects on the P&ID into categories is deactivated.
SortNewObjectsInCategories = False
See also chapter Automatically sorting objects into categories when placing them on the P&ID
(Page 78).

Example 1
Initial situation:
● A subunit with P&ID and categories has been created.
● A pump and its connected pipe are located underneath the main unit. They have been
placed on the P&ID.
Action:
The pump and one of its connected pipe sections is copied to the P&ID. They are pasted using
the command "Paste > Below document". The copies are not connected to another pipe when
they are pasted.
● Result 1: SortNewObjectsInCategories = FALSE
Since the copied objects were not connected to a pipe when they were pasted, they are
pasted in the Navigator according to the paste mode – i.e. in the Navigator under the P&ID.
● Result 2: SortNewObjectsInCategories = TRUE
SortNewObjectsInCategories overwrites the paste mode – the pasted objects are
sorted in the Navigator into the category folders located parallel to the P&ID.

P&ID Administration
72 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

Example 2
Initial situation:
● A subunit with P&ID and categories has been created.
● A valve without the activated "Sort parallel to the disconnected pipe segment" option that is
not connected is located underneath the main unit.
● A pipe with a pipe section is located below the main unit.
● All objects have been placed on the P&ID.
Action:
The valve is copied and pasted using the command "Paste > Below document". It is placed on
the pipe section when it is pasted.
● Result 1: SortNewObjectsInCategories = FALSE
Because the Connect script of the pipe section is called and the valve is not a fitting, it is
pasted in the Navigator parallel to the connected pipe.
● Result 2: SortNewObjectsInCategories = TRUE
The valve is sorted into a category underneath the subunit. The pipe, which was not part of
the paste set, remains underneath the main unit.

Example 3
Initial situation:
● A subunit with P&ID and categories has been created.
● A valve that has a fitting and has not been connected is located underneath the main unit.
● A pipe with a pipe section is located below the main unit.
● All objects have been placed on the P&ID.
Action:
The valve is copied and pasted using the command "Paste > Below document". It is placed on
the pipe section when it is pasted.
Because the Connect script is called, the valve is a fitting and the
SetDeviceOwnerByConnector call is in the script, it is sorted below the connected pipe
regardless of the result in the Navigator.

Fitting: Assignment to pipe sections


If the component meets the following criteria, there is no move to the new pipe when you dock
a new pipe to this component:
● The "Sort parallel to the disconnected pipe branch" option is available and enabled at the
component in the "System data".
● The component is placed in accordance with the "Sort parallel to the disconnected pipe
branch" option.
● The component is already connected to a pipe section.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 73
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

See also
"System data" tab (Page 164)
Dependencies when copying and pasting objects (Page 70)

10.2.5 Interaction of cutting/pasting with SortNewObjectsInCategories


Notes on terminology: Fitting = Fitting
A distinction is made between two possible statuses in the examples.
● The automatic sorting of new objects on the P&ID into categories is activated.
SortNewObjectsInCategories = TRUE
● The automatic sorting of new objects on the P&ID into categories is deactivated.
SortNewObjectsInCategories = FALSE
See also section Automatically sorting objects into categories when placing them on the P&ID
(Page 78).

Example 1
Initial situation:
● A subunit with P&ID and categories has been created.
● A pump and its connected pipes are located underneath the main unit. There is an additional
pipe underneath the main unit.
● All objects have been placed on the P&ID.
Action:
The pump is cut and pasted using the command "Paste > Below document". It is placed on the
second pipe when it is pasted.
Pipe cut mode: "Pipe separative"
● Result 1: SortNewObjectsInCategories = TRUE
The user is prompted to decide which pipe is to be retained. The redundant pipe is deleted,
together with its pipe section. The pump is sorted into a category that is located parallel to
the P&ID.
When placed on the second pipe, the pipe is separated into two pipes. The new pipe and its
pipe section are created parallel to the old pipe, i.e. below the main unit.
● Result 2: SortNewObjectsInCategories = FALSE
The position of the pump in the Navigator remains the same.

P&ID Administration
74 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.2 Administering Copy / Cut / Paste

Example 2
Initial situation:
● A subunit with P&ID and categories has been created.
● Two pipes are located underneath the main unit. A valve is located underneath pipe A. The
"Sort parallel to the disconnected pipe branch" option is enabled at the valve in the "System
data". It is connected to the pipe segments of pipe A.
● All objects have been placed on the P&ID.
Action:
The valve is cut from pipe A and pasted using the command "Paste > Below document". It is
placed on pipe B when it is pasted.
The second pipe segment below pipe A is deleted as a result of cutting the valve. Pipe B is
segmented when the valve is pasted. Because the valve is connected with the pipe and is a
fitting, it is sorted parallel to the pipe segment that it is connected to, that is, below the pipe,
regardless of the result.

Example 3
Initial situation:
● Subunit with P&ID and categories.
● Two pipes are located underneath the main unit. Pipe A is located underneath the main unit.
A valve is located underneath the pipe. The valve is a fitting and is connected with the pipe
segments of the pipe.
● All objects have been placed on the P&ID.
Action:
The valve and one of its connected pipe segments, pipe segment B, is cut and pasted using the
command "Paste > Below document". The objects are not connected with another pipe when
they are pasted.
● Result 1: SortNewObjectsInCategories = TRUE
The valve and pipe segment B are deleted from the structure below pipe A. Then they are
sorted into the categories underneath the subunit. Because the pipe segment must be
located below a correct pipe structure, the pipes and the pipe section are copied beforehand
and pasted as the owners of pipe segment B into the category for pipes.
● Result 2: SortNewObjectsInCategories = FALSE
The valve and pipe segment B are deleted from the structure below pipe A. In the same way
as above, the pipe and the pipe section are also copied; they are pasted as the owner of pipe
segment B according to the paste mode, i.e. below the document.

See also
"System data" tab (Page 164)
Scope of the chapter (Page 67)

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 75
Administering P&ID reports
10.3 Administering Create new

10.2.6 Enabling copying if the hierarchical structure up to a position

Procedure
To automatically create the complete hierarchical structure from a value up to the position when
copying, proceed as follows:
1. Open the base object of a valve.
2. Open the "Attributes > System data" tab.
3. Go to design mode.
4. In the "@40" node of the "Base objects" tab, search for the attribute "Y00A04533 Copy
structure up to position".
5. Drag&drop the attribute into the "System data" tab.
6. Change the display type to "Checkbox" in the properties of the attribute.
7. Change to working mode.
8. Enable the option.
9. Confirm your entries.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Special
features of functions and positions".

10.3 Administering Create new


When objects are created new on a P&ID report, the objects are sorted into one of the two
following positions:
● Under the document
SortNewObjectsInCategories = False
Color in report: Blue
● In a category folder
SortNewObjectsInCategories = True
Color in report: Black
Scheme of the software-specific processing:
1. The new object is initially sorted in under the document and is thus a component of the
document-specific Collection.
2. If SortNewObjectsInCategories is activated, the object is moved from the document
to the corresponding category folder in the next step:
– The object is deleted from the document-specific Collection
– In the next step, the object is added to the Collection of the category folder.
This means: If the option SortNewObjectsInCategories is activated, users also require
the object right "Delete" to create new objects.
You can find additional information on the user view on this topic in the "P&ID Operation"
manual, keyword"Using categories".

P&ID Administration
76 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.4 Administering hierarchies and references

10.4 Administering hierarchies and references

10.4.1 Administering the "Assign object" tool

Overview
The entries in the drop-down list of the "Assign object" tool come from two sources:
● Permanently available entries ("hard-coded")
● Entries that were entered in the options script of the report template

Example script for the options script of the report templates


Dim AddAssignObjectMode(3)
strAssignObjectMode0 = "#UNIT|"
strAssignObjectMode1 = "#LOCATION|"
strAssignObjectMode2 = "#SPEC|PI010.PIA902|"

Set objAttMode0 = Document.Spec("SYS.PIA906")


Set objAttMode1 = Document.Spec("SYS.PIA906a")
Set objAttMode2 = Document.Spec("SYS.PIA906b")

If objAttMode0 Is Nothing Then


strAssignObjectMode0 = strAssignObjectMode0 & "Assign unit"
Else strAssignObjectMode0 = strAssignObjectMode0 &
objAttMode0.DisplayValue
End If

If objAttMode1 Is Nothing Then


strAssignObjectMode1 = strAssignObjectMode1 & "Assign location"
Else strAssignObjectMode1 = strAssignObjectMode1 &
objAttMode1.DisplayValue
End If

If objAttMode2 Is Nothing Then


strAssignObjectMode2 = strAssignObjectMode2 & "Assign process
stream"
Else strAssignObjectMode2 = strAssignObjectMode2 &
objAttMode2.DisplayValue
End If

AddAssignObjectMode(0) = strAssignObjectMode0
AddAssignObjectMode(1) = strAssignObjectMode1
AddAssignObjectMode(2) = strAssignObjectMode2

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 77
Administering P&ID reports
10.6 Administration of report templates

10.5 Interaction of a symbol change and the connectors

Automatic connection when changing symbols


If a symbol is replaced by another symbol on the P&ID, a check is made to ascertain whether
the new symbol has connectors that can be connected as per the specifications for COMOS
connectors.
If an object was connected both in the database and on the P&ID, once the symbols have been
swapped, the system tries to restore the connectors of the symbol on the basis of the joined
connectors in the database.

Note
Unopened P&IDs
This happens even if the P&ID was closed when the symbol change took place.

Such a symbol change can take place as the result of a change in an attribute. When the
attribute changes its value, a symbol adjusts itself accordingly on the P&ID.

10.6 Administration of report templates

10.6.1 Automatically sorting objects into categories when placing them on the P&ID

Categories
You can find information on this topic in the "P&ID Operation" manual, keyword "Categories".

Procedure
1. Open a report template.
2. Select the "Options" command in the context menu.
The options script opens.
3. Search for the following script option:
SortNewObjectsInCategories
You can find additional information on this topic in the "Administration" manual, keyword
"SortNewObjectsInCategories".
4. Enter the value True for the script option.

Result
Components are automatically sorted into categories when they are placed on the P&ID.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Sorting
components into the categories".

P&ID Administration
78 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.6 Administration of report templates

10.6.2 Extending the graphical settings


You can expand the "Graphical settings" context menu of a component that is placed on a
P&ID.
You can find additional information on this topic in the "Administration" manual, keyword
"AddToGraficalParamater<drawing type>(Num)".

Procedure
1. Open the "Script" tab of a base object for which you would like to expand the context menu.
2. Open the UserScriptBlock1.
– To expand the context menu for the "M22_P2" drawing type, insert the following script
option:
AddToGraficalParameterM22_P2
– To expand the context menu for the "M22_P1" drawing type, insert the following script
option:
AddToGraficalParameterM22_P1

Result
Use these script options to define attributes to the standard tables of which additional symbols
have been assigned. This means that you can use the context menu to show or hide additional
P&ID symbols that define the properties of the object more precisely.

Example
Script option for a valve:
Dim AddToGraficalParameterM22_P1(3)

'### Driveb
AddToGraficalParameterM22_P1(0) = "Y00T00037.Y00A00457"

'### Position feedback


AddToGraficalParameterM22_P1(1) = "Y00T00037.Y00A01186"

'### Label
AddToGraficalParameterM22_P1(2) = "Y00T00039.Y00A00176"

10.6.3 Locking editable text against editing


You have the option of locking editable text using a script option in the report template of a P&ID
so that it cannot be edited.
See also section EnableInteractiveEditableTexts (Page 185).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 79
Administering P&ID reports
10.7 Editing the properties of the document object

10.7 Editing the properties of the document object


● Base object in the iDB
Group nodes for all base objects for P&ID reports: "@30 > M00 > A80 > A10 > F > FB Flow
diagrams"
● "System data" tab
See chapter Defining the base object for pipe sections (Page 80).
● "Text field" tab
– "Order" group and "Designation" group
This information is applied from the project properties.
– "Change notes" group
This information is applied from the document revision.
● "Document options" tab
– "Show default pipe label"
Activates the automatic display of the default pipe label when generating a pipe.
See chapter SetPipeFlagOnCreate (Boolean) (Page 186).
– "Color settings"
Activates the function "Select color set..." in the context menu.
See chapter Administering "ColorSets" in the report template (Page 103).
– "Use old search logic"
Compatibility setting for inventory databases with customizing. Use this setting only if the
sheet reference arrows are missing from the P&ID report. See chapter Administering
sheet reference symbols (Page 84).
● "Proteus" tab
See chapter Administering Proteus import/export (Page 128).
● "Equipment list" tab and "Pipe list" tab
See chapter "Equipment list" and "Pipe list" tabs (Page 81).

10.7.1 Defining the base object for pipe sections

Requirement
● You are familiar with the overview of the tabs of the P&ID report.
See chapter Editing the properties of the document object (Page 80).

P&ID Administration
80 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.7 Editing the properties of the document object

Procedure
1. Open the properties of a P&ID report template.
2. Select the "Attributes > System data" tab.
3. In the "Link to base object for pipe sections" field, define the base object to use to create the
connections that are drawn with the "Connection" tool.
Note
The value set here overwrites the setting from the project properties, "Process
development" category, "Base object for pipe section" field. See also chapter Specifying
references in the project properties (Page 18).

Result:
In the database, the options script of the report template is set up so that the variable
CObjectFullNameForPipe reads the base object that is input here. See also chapter
CObjectFullNameForPipe (String) (Page 180).
This allows the user to determine the base object for pipe sections easily via the properties
window.

10.7.2 "Equipment list" and "Pipe list" tabs

Requirement
● You are familiar with the overview of the tabs of the P&ID report.
See chapter Editing the properties of the document object (Page 80).

Terminology
● Designation in the cDB: Apparatus head or apparatus bar
Designation in the iDB: "Equipment list"
● Designation in the cDB: Material flow bar
Designation in the iDB: "Pipe list"

Procedure
1. Activate the "Display equipment bar" or "Display piping list".
2. Edit the "Row headers" list
If you leave fields in these lists empty, less information is displayed correspondingly on the
P&ID.
This procedure replaces the selection between a detailed version and a brief summary in
older COMOS versions.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 81
Administering P&ID reports
10.8 Administering symbols

10.8 Administering symbols

10.8.1 Setting the size of connectors for P&ID objects


COMOS offers the possibility of adapting the size of the connectors for P&ID objects to your
needs.

Requirement
A P&ID has been created.

Procedure
1. Select the command "Report template > Open report template" in the context menu of the
P&ID in the Navigator.
The report template opens.
2. Select the "Options" command from the context menu of the report template's working area.
The "Options" window opens.
3. Add a line at the end of the script, in which you assign the desired value to
the ConnectorRadius property.
Example: ConnectorRadius = 5
4. Close the dialog box by clicking "OK" and save the report template.

10.8.2 Administering standard pipe labels

Procedure
The standard pipe label is entered as text symbol:
1. Open the base project.
2. Open the properties of the pipe section.
3. Select the "Symbols" tab.
4. In the list select the entry with the matching drawing type.
5. Click the "Show symbol script" button in the "Text" option group.
6. Edit the symbol script.
In the standard iDB, the pipe label provides the following information:
– AliasFullLabel of the corresponding pipe
– Nominal diameter according to attribute Y00A00744
– Nominal pressure according to attribute Y00A00746
– Pipe spec according to attribute Y00A00052

P&ID Administration
82 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.8 Administering symbols

Options script of the report template


● SetPipeFlagOnCreate
Note
Dependency of properties of the report
The SetPipeFlagOnCreate option depends on the "Show standard pipe label" attribute
in the "Attributes > Document options" tab of the R&I properties. When the "Show standard
pipe label" option is activated, the option script is automatically set to TRUE.
By default, the SetPipeFlagOnCreate option script of the report template has the
value False. If the SetPipeFlagOnCreate option script of the report template has the
value TRUE, the script is automatically evaluated when drawing a pipe and the pipe label is
shown.
The options script of the report template provides a number of options for controlling the
behavior of the standard pipe label. See also chapter Enabling selection of a standard pipe
(Page 18).
● StdPipeFlagNoColor
See chapter StdPipeFlagNoColor (Boolean) (Page 186).

Additional pipe labels


See also chapter Base object "@30 > M00 > A50 > A15 > A80 > A10 Text symbols P&ID"
(Page 171).

10.8.3 Administering pipe end symbols

Objective
The user can show and hide end symbols on a P&ID. You can find more information on this
topic in the "P&ID Operation" manual, keyword "Showing and hiding additional pipe symbols".

Standard table "Pipe: termination symbols"


The presentation of termination symbols on pipes is defined in the following standard table:
"Y10 > M20 > A10 > Y10M20N00006 Pipe: termination symbols"
Whether this standard table is evaluated depends on the "Pipe cut mode" attribute in the
"Attributes > System data" tab at components.
Case 1: With pipe cut mode
● "Pipe cut mode" with value <> 1
Meaning: The pipe is connected to a non-segmenting component. This corresponds to the
"Pipe section separative" or "Pipe separative" behavior.
Behavior: The end symbol script is evaluated.
● "Pipe cut mode" with value = 1
Meaning: The pipe is connected to a segmenting component.
Behavior: The end symbol script is not considered.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 83
Administering P&ID reports
10.8 Administering symbols

Case 2: Without pipe cut mode


"Pipe cut mode" attribute not available
● The old state is queried due to compatibility reasons.
Old state:
If the pipe is connected to a component which is not a PipeFitting component (Dev.RIClass
<> RIClassFitting), the end symbol script is evaluated.

Additional information
● You can find more information on this topic in the "P&ID Operation" manual, keyword
"Presenting pipe symbols".
● Also note the additional administration options using the tab "Document options" of the
report. See chapter Editing the properties of the document object (Page 80).

10.8.4 Administering sheet reference symbols

Purpose
If a pipe component is placed on two different reports, the corresponding pipe component is not
duplicated, but only a sheet reference is created. The sheet reference is not relevant for the
component list.
For application, see chapter AUTOHOTSPOT.

Selection list "Sheet reference for pipelines"


Database: "Y10 > M20 > A10 > Y10M20N00010 Sheet references > Y10M20N00002 Sheet
reference for pipes, multipage"
The selection list contains the sheet reference symbols for all drawing types in the "Process"
area.
Click in the header of the standard table and select "Select drawing type" from the context
menu.

Document option "Use old search logic"


Compatibility setting for inventory databases with customizing. Use this setting only if your
customer database relies on the old search logic.
● iDB: "Y00T00162 Document options" tab, attribute "Y00A04683 Use old search logic"
● cDB "DO Document options" tab, attribute "ASOPC Use old search logic"

P&ID Administration
84 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.8 Administering symbols

For sheet references, the segment names determine the order of the segments. Example:
Below a pipe there are the segments "Seg1", "Seg2" and "Seg4". The following applies if you
are working according to the COMOS standard:
● "Seg1" is connected to "Seg2". The medium flows from "Seg1" to "Seg2".
● "Seg2" is not connected to "Seg4". There is a gap between "Seg2" and "Seg4".
Old search logic:
● A half-open segment was found on the P&ID report. Example: "Seg4"
● According to the segment name, any other placed segment of the pipe is searched
backwards. If "Seg3" is found, a sheet reference to this segment is generated.
● If "Seg3" is not found, but "Seg2" is, a sheet reference to this segment is generated.
New search logic
● A half-open segment was found on the P&ID report. Example: "Seg4"
● The predecessor segment is searched for according to the segment name. If "Seg3" is
found, a sheet reference to this segment is generated.
● If "Seg3" is not found, no sheet reference is generated.

See also
Scripting a page reference for cross-page pipes (Page 19)

10.8.5 Administering a rotation correction for PFD symbols

Procedure
To activate rotation correction for PFD symbols when opening a P&ID, proceed as follows:
1. Click the "Extra > Object debugger" menu.
The object debugger opens.
2. Drag&drop the project from the Navigator into the "Object A" field.
3. Enter the following in the "Script" field:
private bool IsRotationIncorrect()
{
// TRUE, if the following entry has been entered by the PT user via
the script debugger !!!
// This flag should be removed by the user only by restarting the
application !!!
return (Singletons.Globals.ItemExist("CorrectRIRotation") != 0);
}
4. Click on the "Execute" button.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 85
Administering P&ID reports
10.8 Administering symbols

Result
When you open a P&ID, rotation correction is applied for PFD symbols. Once you terminate
COMOS, this setting is not applied the next time you start the program.

10.8.6 Administering a scaling correction for PFD/P&ID symbols

Procedure
To mount a scaling correction for PFD/P&ID symbols when loading a P&ID symbol script,
proceed as follows:
1. Click the "Extra > Object debugger" menu.
The object debugger opens.
2. Drag&drop the project from the Navigator into the "Object A" field.
3. Enter the following line in the "Script" field:
A.workset.globals.RiConversionScale = <Scaling value>
4. Click on the "Execute" button.

Result
When you load a P&ID symbol script, scaling correction is applied for PFD/P&ID symbols. Once
you terminate COMOS, this setting is not applied the next time you start the program.

10.8.7 Navigating to the owner in the symbol script


This function is only available for P&ID reports.
The following string generates a navigation step to the owner:
● "..|"
The navigation step can be repeated as often as necessary: The string "..|..|" moves two
levels up in the owner structure.
● Example: *V*P E:Symbol("..|..|A30|V002|V001|M001")
– The symbol is placed on a report.
– This creates an engineering object for the symbol.
– Starting from this engineering object, a switch is made in the Navigator of two levels up
in the owner structure.
– Then a search is started for the child object "A30|V002|V001|M001" (a motor).
– The symbol is used by this child object and placed as a subsymbol.

Note
The following procedure will trigger a script error:

P&ID Administration
86 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.9 Displaying coordinates of components

Using "..|" (or multiple use of this string) to move up in the owner structure and then move
down again in the child objects until the actual symbol is reached again.
In other words: Navigating up and then back to the symbol itself is not supported. There is also
no application for such a procedure because the actual symbol object can be used immediately
in the script.

10.9 Displaying coordinates of components

10.9.1 Quadrants/page areas


You can separate P&IDs into quadrants. The quadrants are referred to as zones.
The coordinates of objects placed on the P&ID are automatically displayed in a text flag.
You can also use the symbol script to display the coordinates of page references.
The coordinates are evaluated by the following functions:
● DocObj.XQuadrant and DocObj.YQuadrant for components
● %NToDOcObj.XQuadrant% for page references
ToDocObj.X and ToDocObj.Y are likewise evaluated.

10.9.2 Creating zones

The options are as follows:


● Constant dimensions:
– All zones have the same height.
– All zones have the same width.
You can find additional information on this topic in the "EI&C Administration" manual,
keyword "Paths and zones with constant size".
● Variable dimensions:
– The width of all zones is specified individually.
– The height of all zones is specified individually.
You can find additional information on this topic in the "EI&C Administration" manual,
keyword "Paths and zones with variable size".

10.9.3 Displaying coordinates of page references


The coordinates for all placed objects are displayed automatically in a text flag. By default, the
coordinates of page references are not displayed.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 87
Administering P&ID reports
10.9 Displaying coordinates of components

Procedure
To display the coordinates of page references, proceed as follows:
1. In the base data, open a standard table under the node "Y10 > M20 > A10 > Y10M20N00010
Page references".
2. Open the context menu of the column header for the drawing type.
3. Under "Select drawing type", select a drawing type on which you want to display the
coordinates for page references.
Possible drawing types:
– M21_P1 - (PFD)
– M22_P1 - (P&ID (ISO 10628))
– M22_P2 – (P&ID (DIN 2481))
4. Click "Show symbol script" in the context menu of the page reference input.
5. Copy the following code to the symbol script.
See also chapter Symbol script for page references (input) (Page 88).
6. Open the symbol script of the page reference output.
7. Copy the same code to the symbol script that you have used for the input.
Replace the entry Item("DI1") with Item("DO1") in the following line:
Set Connector = Param.Connectors ().Item("DI1")

Result
For page references, the coordinates of the other reference partner are displayed in a text flag.

10.9.4 Symbol script for page references (input)


Function Geometrie (PARAM)
...
<Tag definitions>
...
If Not Param Is Nothing Then
If Param.SystemType = 8 Then
Set Connector = Param.Connectors ().Item ("DI1")
Set PipeLib = CreateObject ("ComosPipeLib.PipeLib")
Set referencedCc = PipeLib.GetReferencedConnector (Connector,
2000) ' the Value 2000 identify the PFD
XQuad = PipeLib.GetXQuadrantForConnector (referencedCc)

YQuad = PipeLib.GetYQuadrantForConnector (referencedCc)

If XQuad = "" Or YQuad = "" Then


Set p9 = Coord(-7.5,-12.5)
DrawText p9, "%N FromDoc.Description%", 0, 2
Set p10 = Coord(-7.5,-7.5)
DrawText p10, "%N FromDoc.FullLabel%\n", 0, 2

P&ID Administration
88 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.10 Search functions for P&ID

Else

Set othersegment = referencedCc.owner


Set docobj = othersegment.BackPointerPlacedDocObjs.Item (1)
Set Document = docobj.owner

If Not Document Is Nothing Then


Set p9 = Coord(-7.5,-12.5)
Font.Height = 10
DrawText p9, Document.Description,0,2
Set p10 = Coord(-7.5,-7.5)
Font.Height = 10
DrawText p10, Document.FullLabel, 0, 2
Set p11 = Coord (-7.5, -17.5)
DrawText p11, "Field " & XQuad & "/" & YQuad, 0, 2
End If
End If

End If

End If
End Function

10.10 Search functions for P&ID

10.10.1 GetDeviceConnectedToPipe

Use
This function is called by default in the following script: "@20 > A80 > M22 > A10 > M22S00004
CheckConnection"
The function gets a component that is connected to the specified connector of a pipe object.
GetDeviceConnectedToPipe(ByVal Pipe As IComosDDevice, ByVal
StrConnectorName As String, ByVal SearchMode As Integer) As
IComosDDevice
The following table shows the meaning of the parameters used:

Parameter Description
Pipe Pipe object for which the search is conducted.
StrConnectorName Specifies whether to search for a connected com‐
ponent at the input or output of a pipe object.
DI1: Input of the pipe object
DO1: Output of the pipe object
SearchMode Number of the desired search mode.
COMOS provides three search modes.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 89
Administering P&ID reports
10.10 Search functions for P&ID

See also
Search modes (Page 90)

10.10.2 GetConnectorOfDeviceConnectedToPipe

Use
This function is called by default in no script: You can enter the call in a script yourself.
The function gets the component connector that is connected to the specified connector of a
pipe object.
GetConnectorOfDeviceConnectedToPipe (ByVal Pipe As IComosDDevice,
ByVal StrConnectorName As String, ByVal SearchMode As Integer) As
IComosDDevice
The following table shows the meaning of the parameters used:

Parameter Description
Pipe Pipe object for which the search is conducted.
StrConnectorName Specifies whether to search for a connected com‐
ponent at the input or output of a pipe object.
DI1: Input of the pipe object
DO1: Output of the pipe object
SearchMode Number of the desired search mode.
COMOS provides three search modes.

See also
Search modes (Page 90)

10.10.3 Search modes


COMOS provides three different search modes for the GetDeviceConnectedToPipe
and GetConnectorOfDeviceConnectedToPipe calls.

P&ID Administration
90 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.10 Search functions for P&ID

COMOS searches in all three search modes for the components that are connected to the input
or output of a pipe object.
● Search mode 1:
COMOS determines the components that are connected to the input or the output of a
simple pipe section.
● Search mode 2:
COMOS determines the components that are connected to the input or the output of a main
pipe section.
● Search mode 3:
COMOS determines the main equipment connected to the input or the output of a main pipe
section.
The following table shows the pipe objects that can be passed in a given search mode.

Search mode Pipe Pipe branch Pipe segment


1 Yes Yes Yes
2 Yes 1
No No
3 Yes1,2 Yes2 Yes2
1
COMOS only considers the pipe sections of the pipe, which are identified as a main pipe section. COMOS returns only those
components that are connected to a main pipe section.
2
COMOS only returns the components for which the "Main equipment class" attribute is enabled. You enable the "Main
equipment class" attribute (attribute: Y00T00001.Y00A04292) in the "Attributes > System data" tab.

The following provides an example of how the search mode is set by calling
"GetDeviceConnectedToPipe".

Set search mode 1


1. Navigate to the following base object:
"@20 > A80 > M22 > A10 > M22S00004 CheckConnection"
2. In the "Script" tab, open the script that contains the following call:
Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe
3. Add the following to the string:
Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe(<Pipe object>,<"Name of the
connector">, 1)

Set search mode 2


This search mode is useful when a pipe has branches. You define a pipe section as the main
pipe section here. The search for components is performed on the main pipe section.
1. Navigate to the following base object:
2. "@20 > A80 > M22 > A10 > M22S00004 CheckConnection"
3. In the "Script" tab, open the script that contains the following call:
Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 91
Administering P&ID reports
10.10 Search functions for P&ID

4. Add the following to the string:


Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe(<Pipe object>,<"Name of the
connector">, 2)
5. To define a pipe section as the main pipe section, select the "Attributes > System data" tab
of the pipe section.
6. In the "Main pipe section" field, enter a numeric value that is greater than the value of the
other branches of the pipe.

Set search mode 3


1. Navigate to the following base object:
2. "@20 > A80 > M22 > A10 > M22S00004 CheckConnection"
3. In the "Script" tab, open the script that contains the following call:
Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe
4. Add the following to the string:
Set objDev.spec("Y00T00001.Y00A02607").LinkObject =
PipeLib.GetDeviceConnectedToPipe(<Pipe object>,<"Name of the
connector">, 3)
5. To define a pipe section as the main pipe section, select the "Attributes > System data" tab
of the pipe section.
6. In the "Main pipe section" field, enter a numeric value that is greater than the value of the
other branches of the pipe.
7. To label a piece of equipment as the main equipment, select the properties of the equipment
in the "Attributes > Options" tab.
8. Select the "Main equipment class" option.
If the option does not exist, create it. You can find the attribute at the following location in the
database:
"@40 > A20 > Y00 > A10 > A10 > Y00T00001 > A06 > B01 > C02 > Y00T00001 >
Y00A04292 Main pipe section"
This search mode is useful when a pipe has branches. You define a pipe section as the main
pipe section here. The search for components is performed on the main pipe section.

Result
The corresponding components are determined depending on the search mode. You connect
these components to a pipe section. The name of the component is entered in the following
fields of the "Attributes > P&IC options" tab section for the pipe section:
● "From equipment:"
● "To equipment:"

Example
This example shows the two search functions for search mode 1.

P&ID Administration
92 Operating Manual, 03/2020 V 10.3.3
Administering P&ID reports
10.10 Search functions for P&ID

The following graphic shows an example of the parameters that are specified for the search
function.

 

3LSHB%UDQFKB

3LSHB%UDQFKB 3LSHB6HJPHQWB 3LSHB6HJPHQWB

9 9 9 9


① Parameter "StrConnectorName"
② Parameter "Pipe"

Function calls:
● GetDeviceConnectedToPipe(Pipe_Branch_02, "DI1",1)
Search result: Component "V002"
● GetConnectorOfDeviceConnectedToPipe(Pipe_Branch_02, "DI1",1)
Search result: Component connector "DO1" of component "V002".

See also
GetDeviceConnectedToPipe (Page 89)
GetConnectorOfDeviceConnectedToPipe (Page 90)

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 93
Administering P&ID reports
10.10 Search functions for P&ID

P&ID Administration
94 Operating Manual, 03/2020 V 10.3.3
P&ID functions for Graybox and engineering task 11
11.1 Overview for administration of the "Graybox" function

Requirement
● You are familiar with the definition and limitation for placed documents.
You can find additional information on this topic in the "Administration" manual, keyword
"Definition and limitation for placed documents".

Technical overview
When solving a graybox, the associated COMOS document is opened in the background,
all ReportItems are cut and pasted into the main document.
● ReportItems are identified by means of LID. However, this LID is only unique within a
report. Therefore: If necessary, the ReportItems receive a new LID in the main document.
● The COMOS document of the graybox is deleted and therefore also its crp file.
● Pipe segmentation through individual components
● Representation of pipe breaks
● Objects under the source report are moved under the target report during dissolution.
● A pipe is connected to another pipe by means of a dynamic connector.
Requirement: One end of a pipe meets exactly one other pipe.
● Connect two components (e.g. pump and valve) if these are placed so that the connectors
are located on top of each other.
This function is already available within two grayboxes prior to dissolution.
● Inconsistency detection when connecting a pipe with incorrect flow direction
● Customize search strings
● Fixdependencies for objects that have connectors and can be connected (pipes/
components)

Implementation
● Use of grayboxes on the P&ID report
You can find more information on this topic in the "P&ID operation" manual, keyword "Using
a graybox on a P&ID".
● Preassign and disable "Select connection type" window
See chapter Preassign and disable "Select connection type" window (Page 96).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 95
P&ID functions for Graybox and engineering task
11.2 Preassign and disable "Select connection type" window

Similar COMOS functions that are not dissolved with "Resolve graybox"
● Connecting a pipe to a vessel over a nozzle or a dynamic connector
● No data forwarding over Updateconnected
● Pipe segmentation via a component group

Reference: cDB master data for modular engineering


See chapter cDB master data for modular engineering (Page 155).

11.2 Preassign and disable "Select connection type" window

Requirement
● You are familiar with the technical overview.
See chapter Overview for administration of the "Graybox" function (Page 95).

Preassign and disable "Select connection type" window


When dissolving a graybox, COMOS evaluates whether or not connections must be generated.
When the open end of a pipe encounters a vessel wall, the "Select connection type" window
opens. You can find more information on this topic in the "P&ID Operation" manual, keyword
""Select connection type" window". When grayboxes are placed and dissolved by means of an
engineering task, this dialog can be preassigned and disabled with an action.
1. Switch to the base project.
2. Select the following base object:
"@20 > B20 > M20 > A20 Place and dissolve graybox P&ID"

P&ID Administration
96 Operating Manual, 03/2020 V 10.3.3
P&ID functions for Graybox and engineering task
11.3 Use "A20 Placing and dissolving graybox P&ID"

3. Edit the following attribute:


"Y00T00005 System" tab, "Y00A01135 Default connection type" attribute
4. Choose one of the following entries:
– "Interactive - Decision made by user"
This option cannot be used in any meaningful manner with the "Graybox" function.
Note
Remove the "Interactive - Decision made by user" option
Proceed as follows to remove this option that cannot be used, if necessary:
● Copy the standard table "@40 > Y00 > A20 > A80 > Y00N00729 Default setting
connection type for graybox objects".
● In the copied standard table, delete the first value A10.
The original standard table is required unchanged by COMOS and may not be edited.
● Assign the new standard table to the "Y00A01135 Default connection type" attribute.

– "Do not create connection"


The "Select connection type" window is disabled. The connection does not create a
connector.
– "Create connection"
The "Select connection type" window is disabled. The connection automatically creates
a dynamic connector.
– "Create nozzle"
The "Select connection type" window is disabled. The connection automatically creates
a nozzle.
For meaning of the entries, see "P&ID Operation" manual, keyword ""Select connection
type" window".

11.3 Use "A20 Placing and dissolving graybox P&ID"

Requirement
● You are familiar with the terminology regarding "Placeable documents".
Background: A graybox is created by using an interactive report in an interactive report. You
can find additional information on the term "Assemblies" or "Graybox" in the "Administration"
manual, keyword "Definition and limitation for placed documents".

P&ID-specific attributes of the engineering task


"@20 > B20 > M20 > A20 Place and dissolve graybox P&ID"
For general information on the attributes of an engineering task, see the "Administration"
manual, keyword "Preparing engineering tasks".
● Properties of the engineering task, "Attributes > System data" tab: "Connection type default"
Default for the "Select connection type" window. The window is suppressed on the
engineering side and the value set here is used.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 97
P&ID functions for Graybox and engineering task
11.3 Use "A20 Placing and dissolving graybox P&ID"

No screwing in of components into a pipe


The graybox defines the position and orientation of the components. This is true when placing
as well as dissolving the graybox.
● When the place the graybox, the components are connected, if necessary. This means, for
example, that a pump from the graybox can be installed into a pipe of the report in which it
is placed.
But the component is not rotated during installation. In case of a different flow direction, the
pipe in the report in which the pump is placed is marked as inconsistent.
● This behavior is true even if the graybox is dissolved afterwards.
Note: When an equipment is placed directly (without graybox) on an P&ID report and
encounters a pipe, the equipment is turned into the flow direction, if necessary.

General condition for undoing


Engineering tasks can be undone. This undoing is used, for example, in the "Modular
engineering" module.

Note
Using "A20 Placing and dissolving graybox P&ID" ensures the undoing of an engineering task.
When grayboxes are used in combination with an engineering task on P&ID reports, complex
changes can be triggered. The undoing of such an engineering task is therefore rather time-
consuming and is controlled by the hidden template pointer ("@TplM"). The engineering task
"A20 Placing and dissolving graybox P&ID" ensures that undoing takes place automatically.
● Recommendation: Use only the engineering task "A20 Placing and dissolving graybox
P&ID" for P&ID reports.
If you are using the engineering task "B60 Own script" or "B30 Dissolve graybox", you must
implement the undoing yourself. Loss of data is possible in case of a faulty implementation.

Note
Manual changes interfere with undoing an engineering task.
Undoing requires that the content of a graybox is not changed after it has been dissolved. This
mainly affects:
● No disconnection of pipes
● No change to the flow direction
● No deletion or installation of components

Undoing of the engineering task involves the following steps:


● Deleting objects that are no longer required elsewhere on the report
● Deleting objects that are no longer required elsewhere in the Navigator
● Deleting connections, dynamic connectors and nozzles

P&ID Administration
98 Operating Manual, 03/2020 V 10.3.3
P&ID functions for Graybox and engineering task
11.3 Use "A20 Placing and dissolving graybox P&ID"

● Restoration of the place position (of the placeholder)


You can find additional information on this topic in the "EI&C Administration" manual,
keyword "Preparing grayboxes".
● Closing the pipe gaps without asking and restoring the routing
In doing so, the objects that were created when placing the graybox and disconnecting the
pipe are deleted. Only the pipes that existed prior to placing and disconnecting remain.
For information on the standard behavior of the graybox, see the "P&ID Operation" manual,
keyword "Using a graybox on a P&ID".

Note
No undoing from a data-specific point of view
The undoing of engineering tasks refers to the restoration of the object structures on the
engineering side. The restoration does not mean that the original datasets are restored again
in the database. You can find more information on this topic in the "Modular engineering"
manual, keyword "Objective of the engineering tasks".

Interaction with paste mode


When the engineering task "A20 Placing and dissolving graybox P&ID" woks together with the
"Modular engineering" module, an uninterrupted workflow is the main focus. Additional user
dialogs are undesirable. To do so, note this recommendation:
● When reports are pasted, COMOS also creates engineering objects, if needed, or sorts
engineering objects.
● If COMOS cannot detect the node in which the engineering objects are created or sorted
into, the user dialog "Define paste mode for objects" opens.
You can find additional information on this topic in the "Operation" manual, keyword ""Define
paste mode for objects" window".
● You avoid this dialog in P&ID reports as follows:
– Create a standardized template.
You can find additional information on this topic in the "Administration" manual, keyword
"Create template".
– Create the prepared objects under the P&ID report
or (exclusive)
– Use category folders parallel to the P&ID report.

Reference: cDB master data for modular engineering


See chapter cDB master data for modular engineering (Page 155).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 99
P&ID functions for Graybox and engineering task
11.3 Use "A20 Placing and dissolving graybox P&ID"

P&ID Administration
100 Operating Manual, 03/2020 V 10.3.3
Administering global symbol colors (UseColorSets) 12
12.1 Aim and overview
You can specify rules with which the user can change the color of the report objects on an P&ID
flowchart in bulk. You can find more information on this topic in the "P&ID Operation" manual,
keyword "Using bulk color setting of the symbols".

Note
Default colors are not changed.
Only the standard color (delivery state: black) is changed. Blue, pink and orange are retained.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Default
colors in P&ID".

The following administration steps are required:


● Administering queries for color configuration (Page 101)
● Specifying collision color (Page 103)
● Administering "ColorSets" in the report template (Page 103)
● Administering properties of the engineering document (Page 104)
● Row report to represent the legend (Page 105)

12.2 Administering queries for color configuration

Requirement
● You are familiar with the aim and the overview.
See chapter Aim and overview (Page 101).

Procedure
1. Open the base project.
2. Open the following node: "@20 > A70 > Y10 > M00 > A20 > M22_P1 R&I (ISO 10628)".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 101
Administering global symbol colors (UseColorSets)
12.2 Administering queries for color configuration

3. Select one of the container objects:


– "A10 Equipment"
– "A20 Pipes and pipe parts"
– "A30 Machines"

4. For the container object, open the branch below.


You see a query below the container object.
5. Optional: Create an additional container object with query.
– Copy a container object with query and add the copies below the node "M22_P1 R&I
(ISO 10628)".
– Edit the description of the container object. In deviation from the COMOS standard, each
container object needs a unique description.
If a description occurs twice, the corresponding entry in the "Color settings" window is
missing.
6. Open the properties of the query.
– Select the "Attributes > Color selection" tab.
– In working mode, click the "Select color" button and select a color.
– Close the properties.

P&ID Administration
102 Operating Manual, 03/2020 V 10.3.3
Administering global symbol colors (UseColorSets)
12.4 Administering "ColorSets" in the report template

7. Open the query.


– Select the "Properties" command in the context menu of the "Classification" column.
– Select the "Value calculation" tab.
– Edit the entry "ClassificationExists(1, "...")".
This entry specifies the objects on which the color has an effect.
– Example: ClassificationExists(1, "M22.A010")
Effect: The color has an effect on the report objects with the classification "M22.A010",
that is, the P&ID equipment.
8. Proceed in the same way for the other container objects with the associated queries.
See also chapter Administering "ColorSets" in the report template (Page 103).

12.3 Specifying collision color

Requirement
● You are familiar with the aim and the overview.
See chapter Aim and overview (Page 101).

Procedure
1. Select the node "@20 > A70 > Y10 > M00 > A20 > M22_P1 R&I (ISO 10628)".
2. Open the properties.
3. Select the "Attributes > Color selection" tab.
4. In working mode, click the "Select collision color" button and select a color.
5. Confirm your entries.
If multiple color settings are valid for an object at one time, the collision color applies.

12.4 Administering "ColorSets" in the report template

Requirement
● You are familiar with the aim and the overview.
See chapter Aim and overview (Page 101).

Procedure
1. Open the report template for the P&ID for which you wish to activate the mode.
2. Right-click on the working area of the report template.
The context menu opens.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 103
Administering global symbol colors (UseColorSets)
12.5 Administering properties of the engineering document

3. Select the "Options" command from the context menu.


4. For example, insert the following script:
Dim mspec
UseColorSets = True
Set mspec = Document.Spec("Y00T00162.Y00A05665")
If Not mspec Is Nothing
Then UseColorSets = (mspec.value = "1")
End If
Note for UseColorSets = True: This option sets the default when the attribute is
missing. When the attribute exists, only the setting made there applies according to the
script.
The report template for P&ID flowcharts has already been prepared in the standard iDB.
5. Confirm your entries.
6. Switch to the properties of the report.
7. If necessary, create the tab with the attributes.
Tab and attributes must match the information in the script.
8. Standard iDB: The tab "Y00T00162 Document options" has already been prepared.
9. Standard iDB: The attribute "Y00A05665 Activate color settings" has already been
prepared.
10.Standard iDB: The attribute "Y00A00750 List of activated color settings" has already been
prepared.
Note: The "List of activated color settings" field is filled, when using the "Select color
settings" context menu command is used on the report.

12.5 Administering properties of the engineering document

Requirement
● You are familiar with the aim and the overview.
See chapter Aim and overview (Page 101).

Procedure
1. Change to the engineering project.
2. Open the properties of the engineering document.
3. Select the "Attributes > Document options" tab.
4. Select the option "Activate color settings".
The context menu "Select color settings..." is visible in the report.
A legend of the colors appears in the lower right corner of the report in the document footer. See
chapter Row report to represent the legend (Page 105).

P&ID Administration
104 Operating Manual, 03/2020 V 10.3.3
Administering global symbol colors (UseColorSets)
12.6 Row report to represent the legend

12.6 Row report to represent the legend

Requirement
● You are familiar with the aim and the overview.
See chapter Aim and overview (Page 101).

Implementation of the legend in the iDB


Row reports:
● .A30.F.FB.FB_A10.FB_A10_A50 ColorLineHeader
● .A30.F.FB.FB_A10.FB_A10_A60 Color line for foot
● .A30.F.FB.FB_A10.FB_A10_A70 Color line blank
● .A30.F.FB.FB_A10.FB_A10_A80 Color line 1
Associated list in the report template: "ColorQueryLegendList".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 105
Administering global symbol colors (UseColorSets)
12.6 Row report to represent the legend

P&ID Administration
106 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components 13
13.1 Administering text recognition in AutoCAD drawings

13.1.1 Overview of the AutoCAD text recognition

Objective
The AutoCAD text recognition function is a script-based interface.
The function places an AutoCAD file on a report. The AutoCad file is visible as a background
image on the report. The coordinates of the text objects are identified in the AutoCAD file.
Invisible links are created on the report above the AutoCAD background image with the help of
these coordinates. This gives users the impression that it is possible to open a navigation menu
for a text of the placed AutoCAD file.
In the screenshot below the report is marked with (1).
The AutoCAD text recognition detects individual texts of an AutoCAD file as a concatenated
text block. The following elements are created for every concatenated text block:
● In the Navigator: An engineering object whose description includes the text of the text block.
This engineering object is called the text block object. In the screenshot below the text block
object is marked with (2).
● In the Navigator: An object in which the placement information for the recognized text block
is stored. The placement object in the navigator is called DocObj. In the figure below
the DocObj is marked with (3).
● On the report: A text block frame. This frame is called BoundingBox in this chapter. In the
following figure the BoundingBox is marked with (4).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 107
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

● When you double-click DocObj, the report opens and zooms onto the BoundingBox.
● The context menu of the BoundingBox contains the context menu "Navigate > Object".
With this context menu you can navigate to the text block object:

As a result the AutoCAD text recognition function allows you the navigation between an object
in the navigator and a text in a placed AutoCAD file.

Notes on the AutoCAD file as background image


The AutoCad file is visible as a background image on the report.
● The AutoCAD file is not broken up and the texts remain part of the AutoCAD file. Therefore
it is not possible to select the actual texts on the report and place the text in the clipboard,
for example.
● The display of the AutoCAD file is calculated by the third-party component TeighaX.
TeighaX also determines the zoom factor of the background image and thus the zoom
factor of the AutoCAD file on the report.
The AutoCAD text recognition works even if TeighaX has selected a small zoom factor and
a part of the report area therefore remains unused.

Implementation
See chapter Sequence of the AutoCad text recognition (Page 108).

Similar functions
You can find more information on AutoCAD import in the "Basic interfaces" manual, keyword
"Importing AutoCAD file (dwg, dxf) into an interactive report".

13.1.2 Sequence of the AutoCad text recognition

Requirement
● You are familiar with the overview of the AutoCad text recognition.
See chapter Overview of the AutoCAD text recognition (Page 107).

P&ID Administration
108 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

Terminology
To ensure that a term is unique, the designation in accordance with the interface is used with
AutoCAD terminology.
Examples:
● Designation according to German AutoCAD user interface: Block reference Designation
used here: Blockreference
● Designation according to German AutoCAD user interface: "Text". Designation used
here: AutoCADText
● Designation according to German AutoCAD user interface: "Attributes" (values of a block
reference) Designation used here: AttributeValue

Effect of CleanUpDwgDxfFile (delete hidden objects)


dwg and dxf files can contain hidden objects that distort the workspace during
import. CleanUpDwgDxfFile can be used to delete hidden objects during import.

Note
CleanUpDwgDxfFile can double the time needed for the import
In particular, dxf files require a lot of time to import since they are text-based. Importing a 100
MB dxf file can take several hours.
Using CleanUpDwgDxfFile can double the time needed for import.

If you use CleanUpDwgDxfFile, you need to use the


AutoPlaceAndScaleDwgDxfByFileName command instead of
AutoPlaceAndScaleDwgDxf.

Scope of the interface: Recognized text types


Notation:
● Text recognition: Identification of an AutoCAD element (IAcadText, IAcadMText
or IAcadAttributeReference) as text.
These AutoCAD elements are also recognized when they are located in BlockReference.
● Application of the text recognition rules: Evaluation of the COMOS rules, how the texts are
assembled in COMOS.
As of COMOS 10.3.2 the following scope of delivery applies:
● IAcadText, IAcadMText, IAcadAttributeReference: Text recognition and
application of the text recognition rules

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 109
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

Principle of text grouping


1. Only identical text types are generally grouped: IAcadText with IAcadText
and IAcadAttributeReference with IAcadAttributeReference.
2. IAcadMText is never grouped. Each IAcadMText results in its own text block.
3. All settings for text grouping (TextDistanceFactor, etc.) apply identically for all text
elements. This means you cannot enter different information for IAcadText
and IAcadAttributeReference.

Prototypical sequence of the AutoCad text recognition


1. The user defines an AutoCad file.
2. The user defines the framework of the text block detection.
See chapter Example for an implementation in the iDB (Page 112) for an example.
3. The user defines a COMOS report.
4. Optional: Hidden objects are deleted.
AutoCAD files can contain hidden objects. The hidden objects are not imported into
COMOS but interfere with the import:
– For technical reasons, hidden objects have an effect on the working area of the AutoCAD
file. If hidden objects are located far away from the visible objects, the working area is
significantly increased. As a result, the imported AutoCAD file is shown in a very small
format so that the entire AutoCAD working area fits into the report. The user has no idea
why this is the case.
– Hidden objects can cause displacement of created BoundingBox objects during the
import and BoundingBox objects may not be shown exactly above the correct area of
the AutoCAD background image on the COMOS report any longer.
This is why CleanUpDwgDxfFile is available:
– COMOS creates a temporary copy of the AutoCAD file.
– All hidden objects are deleted in the copy, limiting the AutoCAD working area to the
visible objects.
– The copy is processed further.
If the function is used to delete hidden objects, you must
use AutoPlaceAndScaleDwgDxfByFileName.
Below we are always referring to the copy when the term "AutoCAD-Datei" is used.
5. The AutoCAD file is placed on the report via script.
Depending on the sequence
– AutoPlaceAndScaleDwgDxf
(without CleanUpDwgDxfFile)
or
– AutoPlaceAndScaleDwgDxfByFileName
(with CleanUpDwgDxfFile)

P&ID Administration
110 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

6. The AutoCAD file is checked for the following elements:


– AutoCADText
– MText
– IAcadAttributeReference
– BlockReference
7. Blockreference
A Blockreference creates exactly one COMOS device. The Blockreference
contains 1 to n AttributeValues.
Depending on the ConcatenateBlockTexts option:
– True: All visible AttributeValue of a Blockreference are grouped.
– False: The AttributeValue are grouped according to text recognition rules and
multiple text blocks are created.
The following factors influence the text assignment via the bounding box of the texts:
The user defines the TextDistanceFactor separately for the X-direction and Y-
direction.
A BoundingBox is created for every individual text: TextDistanceFactor
* Text.Height
Concatenated: At least one corner point of a single text BoundingBox has to lie within
the BoundingBox of a different individual text.
8. AutoCADText: Text assignment via the bounding box of the texts
Every AutoCADText includes a single-line TextValue. Multiple items of
the AutoCADText type can be combined graphically to one text block.
The following factors influence the text assignment via the bounding box of the texts:
– The user defines the TextDistanceFactor separately for the X-direction and Y-
direction.
– A BoundingBox is created for every individual text: TextDistanceFactor
* Text.Height
– Concatenated: At least one corner point of a single text BoundingBox has to lie within
the BoundingBox of a different individual text.
9. AutoCADText: Text assignment via the placing point of the texts
Every AutoCADText includes a single-line TextValue. Multiple items of
the AutoCADText type can be combined graphically to one text block.
Requirement for this function:
– Both texts must have the same text size.
– The alignment of the placing point must be "central / centered".
The following factors influence the text assignment via placing points of the texts:
– The user activates the text assignment
via ConsiderDistanceOfTextInsertionPointsXY.
– The user defines the DistanceOfTextInsertionPointsFactorX
and DistanceOfTextInsertionPointsFactorY.
– Concatenated: The placing points are not further away from each other than X-Y.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 111
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

10.MText
A text block is created for every MText. It is irrelevant whether the MText contains a single-
line or multi-line TextValue.
11.IAcadAttributeReference
In the standard, there is no IAcadAttributeReference that is placed directly in the
AutoCAD file. Rather, IAcadAttributeReference is part of a Blockreference.
Technically speaking, however, free IAcadAttributeReference are possible. In this
case, the following applies: A text block is created for every IAcadAttributeReference.
12.A text block frame (BoundingBox) is generated for each text block on the report (Position
[4] in the figure.)
13.For every text block one text block object is created in the Navigator (Position [2] in the
figure):
– Name: Consecutive number
– Description: The summary of the values read from the AutoCAD file
(AttributeValue, TextValue). The values that are taken into consideration
depends on the generated text block.
14.A context menu "Navigation" is provided for the BoundingBox.
The navigation references the created text block object.
15.Optional: Moving the DocObj
The DocObj of the BoundingBox is located in the default under the report. The DocObj
objects store placing information. You can navigate to the report on which the engineering
object is placed via the context menu of the DocObj object. If one moves the DocObj under
the engineering objects, the DocObj can be used to move from the engineering object to the
text on the report.
You can find additional information on this topic in the "Operation" manual, keyword
"DocObj objects".

See also
Class documentation DwgDxfInterface (Page 114)

13.1.3 Example for an implementation in the iDB

Requirement
● You are familiar with the overview of the AutoCad text recognition.
See chapter Overview of the AutoCAD text recognition (Page 107).

P&ID Administration
112 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

User interface (example)

Systematic procedure
1. "Merge Block Text", "ConcatenationDelimiter", "Export Invisible Text",
"RecognizeMultiLineTexts", "Text distance factor X", "Text distance factor Y"
These attributes do not have a script and a feature. The attributes represent the setting
options in the DwgDxfInterface and are evaluated in the further course of the script.
If DwgDxfInterface is extended and contains new setting options, add corresponding
attributes as required. See chapter Class documentation DwgDxfInterface (Page 114) for
the setting options in DwgDxfInterface.
2. "Mapped base object", "Document Template", "Folder", "Document pointer"
The DwgDxfInterface function requires three details:
– The AutoCAD file.
– A COMOS engineering object as the starting point for a base object. The base object is
required to create the text block objects.
– A COMOS report on which the AutoCAD file is placed.
In which form these three specifications are determined and which additional specifications
are determined for further automation depends on the customer DB.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 113
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

3. The function is triggered via the "Create View" interface. The attribute of this button owns the
script with which all other attributes are sampled.
In this script the settings for DwgDxfInterface are set on the basis of the sampled
attribute values. Subsequently the AutoCAD text recognition is carried out
in DwgDxfInterface.
4. "AutoCAD Mapping" is not a component of the AutoCad text recognition.
This attribute is an extension of the application and serves to move the generated DocObj
to the existing planning objects. This allows existing engineering data to be assigned to
the BoundingBox objects on the AutoCAD file. As a result the user can navigate from the
engineering objects to the BoundingBox on the AutoCAD file.

13.1.4 Class documentation DwgDxfInterface

Requirement
● You are familiar with the overview of the AutoCad text recognition.
See chapter Overview of the AutoCAD text recognition (Page 107).

Call
Namespace:
Set objDwgDxfInterface =
CreateObject("Siemens.Comos.DwgDxfInterface.ComWrapper")
Name of the dll:
Comos.AutoCadIntegrator.ComWrapper

Variables used in this example


● a: AutoCAD file (dwg or dxf)
● b: A COMOS engineering object as the starting point for a base object. The base object is
required to create the text block objects.
● c: COMOS Report on which the AutoCAD file is placed

Deleting hidden objects


● objDwgDxfInterface.DwgDxfFilename = a.FullFileName
The file name is transferred internally to CleanUpDwgDxfFile.
● objDwgDxfInterface.CleanUpDwgDxfFile()
A temporary AutoCAD file is created in this function. The hidden objects are deleted in the
temporary copy. The temporary copy is made available in DwgDxfTempFilename.
If the function is used to delete hidden objects, you must use
AutoPlaceAndScaleDwgDxfByFileName.

P&ID Administration
114 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

Placing an AutoCAD file on the report (using CleanUpDwgDxfFile)


● objDwgDxfInterface.AutoPlaceAndScaleDwgDxfByFileName c,
objDwgDxfInterface.DwgDxfTempFilename
This function places and scales the AutoCAD file. The scale factor influences the
coordinates during the placement of the DocObj for the text blocks.
This method makes a property AutoPlaceResult available. This property contains the
following information:
● objDwgDxfInterface.AutoPlaceAndScaleDwgDxf c, a
Set AutoPlaceResult = objDwgDxfInterface.AutoPlaceResult
Output "Placed successful : " &
AutoPlaceResult.DocumentPlacedSuccessful
Output "ScaleFactorX : " & AutoPlaceResult.ScaleFactorX
Output "ScaleFactorY : " & AutoPlaceResult.ScaleFactorY
Output "ScaleFactorOverall: " & AutoPlaceResult.ScaleFactorOverall

Placing an AutoCAD file on the report (without using CleanUpDwgDxfFile)


● objDwgDxfInterface.AutoPlaceAndScaleDwgDxf c, a
This function places and scales the AutoCAD file. The scale factor influences the
coordinates during the placement of the DocObj for the text blocks.
This method makes a property AutoPlaceResult available. This property contains the
following information:
● objDwgDxfInterface.AutoPlaceAndScaleDwgDxf c, a
Set AutoPlaceResult = objDwgDxfInterface.AutoPlaceResult
Output "Placed successful : " &
AutoPlaceResult.DocumentPlacedSuccessful
Output "ScaleFactorX : " & AutoPlaceResult.ScaleFactorX
Output "ScaleFactorY : " & AutoPlaceResult.ScaleFactorY
Output "ScaleFactorOverall: " & AutoPlaceResult.ScaleFactorOverall

Configuration
● objDwgDxfInterface.OpenReportAutomatically = true
Optional.
Default: True
Determines whether the report is opened automatically.
● objDwgDxfInterface.CsvFilename = "C:\text.csv"
Optional.
Default: Path specification and file name of the AutoCAD file with the file extension ".csv"
● objDwgDxfInterface.ExportTextsToCsv
Optional.
Is required if CsvFilename is set. Writes the output of the GetCsvTexts method into a csv
file whose file name was determined by means of the CsvFilename property.
● objDwgDxfInterface.DwgDxfFilename = a.FullFileName
Determines the AutoCad file to be evaluated.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 115
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

● objDwgDxfInterface.ConcatenateBlockTexts = true
Optional.
Default: True
Determines whether all the AttributeValues of a Blockreference are combined into one text
block.
● objDwgDxfInterface.ConcatenationDelimiter = "_"
Optional.
Default setting: "_"
Separators of individual texts in the collection of texts (Blockreference, AutoCADText).
● objDwgDxfInterface.ExportInvisibleAttributes = false
Optional.
Determines whether invisible AutoCAD attributes are considered.
● objDwgDxfInterface.ExportHeaderLine = false
Optional.
Support in troubleshooting.
Determines whether the column descriptions are to be included as the first row in the
semicolon-separated csv-file.
● objDwgDxfInterface.AutomaticallyRecognizeMultineTexts = true
Optional.
Determines whether the single-line AutoCADText elements (IAcadText) are recognized
by means of graphical assignment as a concatenated text block.

Text assignment via the bounding box of the texts


● objDwgDxfInterface.TextDistanceFactorX = 1
Optional.
Determines the distance in X-direction (mm / pt), until which the AutoCADText is detected
as a concatenated text block.
● objDwgDxfInterface.TextDistanceFactorY = 1
Optional.
Determines the distance in Y-direction (mm / pt), until which the AutoCADText is detected
as a concatenated text block.
● objDwgDxfInterface.CompareTextHeights = true
Optional.
Default: True
Determines whether the font size is considered during the detection of text blocks.
● objDwgDxfInterface.CompareTextHeightsToleranceFactor = 1
Optional.
Default: 0.1
Dependency: CompareTextHeights
Determines the scale factor until which a differently-sized font is considered during the
detection of text blocks.

P&ID Administration
116 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

Optional: Text assignment via the placing points of the texts


Requirement for this function:
● Both texts must have the same text size.
● The alignment of the placing point must be "central / centered".
Variables:
● objDwgDxfInterface.ConsiderDistanceOfTextInsertionPointsXY = true
Activates the text assignment via placing points of the texts. The text assignment via
bounding box is performed nevertheless.
● objDwgDxfInterface.DistanceOfTextInsertionPointsFactorX = x
Determines the distance of the placing points in the X-direction (mm / pt) until which
the AutoCADText is detected as a concatenated text block.
● objDwgDxfInterface.DistanceOfTextInsertionPointsFactorY = y
Determines the distance of the placing points in the Y-direction (mm / pt), until which
the AutoCADText is detected as a concatenated text block.

Create BoundingBox objects and DocObj


● strCsvAllText = objDwgDxfInterface.GetCsvTexts
Base for CreateComosObjectsByCsvLine.
● count =
objDwgDxfInterface.CreateComosObjectsByCsvLine(strCsvAllText,
b.CDevice, c)
Creates BoundingBox, Textblock object and DocObj.
The counter is only important in case of faults or checking.

See also
Script example (Page 117)

13.1.5 Script example


*** Prerequisites for running this script ***
'a: AutoCAD Drawing
'b: EngineeringObject with CDevice i.e. a vessel
'c: ComosDocument that will contain the AutoCAD drawing

'*** Instantiate Interface


Set objDwgDxfInterface =
CreateObject("Siemens.Comos.DwgDxfInterface.ComWrapper")
If objDwgDxfInterface Is Nothing Then
Output "Error creating interface"
Else

'************ STEP 0 ************


'*** Global settings

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 117
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

objDwgDxfInterface.OpenReportAutomatically = true ' optional: open


report automatically (default true)

'************ STEP 1 ************


'*** Clean up dwg file. Remove invisible stuff
objDwgDxfInterface.DwgDxfFilename = a.FullFileName
objDwgDxfInterface.CleanUpDwgDxfFile()

'************ STEP 2 ************


'*** Call the function to place the chosen AutoCAD file onto the
COMOS document
objDwgDxfInterface.AutoPlaceAndScaleDwgDxfByFileName c,
objDwgDxfInterface.DwgDxfTempFilename

'*** After placing the drawing and scaling it to document size, a


resultset "DwgDxfAutoPlaceResult" is created
'*** which contains information about scaling factors.
'*** This is important for generating the COMOS DocObj's
'*** since they have to calculate where their counterpart of the
AutoCAD drawing should be located on the document.
'*** In this example the resultset is handed over to the
CreateComosObjectsByCsvLine function internally,
'*** though there is the possibility to fetch this result AFTER
calling AutoPlaceAndScaleDwgDxf:
'*** objDwgDxfInterface.AutoPlaceAndScaleDwgDxf c, a
'*** Set AutoPlaceResult = objDwgDxfInterface.AutoPlaceResult
'*** Output "Placed successful : " &
AutoPlaceResult.DocumentPlacedSuccessful
'*** Output "ScaleFactorX : " & AutoPlaceResult.ScaleFactorX
'*** Output "ScaleFactorY : " & AutoPlaceResult.ScaleFactorY
'*** Output "ScaleFactorOverall: " &
AutoPlaceResult.ScaleFactorOverall

'************ STEP 3 ************


'*** Preparation of AutoCAD file analysis and generating the csv
string/file for the included texts.
'*** Example for exporting to a text file:
objDwgDxfInterface.CsvFilename = "C:\text.csv"
'*** This step is optional since the default filename is the path and
name of the DwgDxf suffixed by ".csv"
'*** objDwgDxfInterface.ExportTextsToCsv

'*** mandatory: need to know which AutoCAD file to analyse


objDwgDxfInterface.DwgDxfFilename = a.FullFileName

'*** optional: switch export of column descriptions in the first line


of the csv on or off (default false)
objDwgDxfInterface.ExportHeaderLine = false

'*** optional: set the separator character of the character separated


values (csv) file (default';').
objDwgDxfInterface.CsvSeparator = ";"

P&ID Administration
118 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.1 Administering text recognition in AutoCAD drawings

'*** optional: set the replacement character for strings containing


the CsvSeparator character (default '_')
objDwgDxfInterface.CsvSeparatorReplacement = "_"

'*** optional: switch block attribute value concatenation


objDwgDxfInterface.ConcatenateBlockTexts = true

'*** optional: separator for concatenation (default '-')


objDwgDxfInterface.ConcatenationDelimiter = "-"

'*** optional: switch export of invisible attributes on or off


(default false)
objDwgDxfInterface.ExportInvisibleAttributes =
false

'*** optional: switch single line text concatenation on or off


(default true)
objDwgDxfInterface.AutomaticallyRecognizeMultineTexts =
true

'*** optional: every text inside an area (TextDistanceFactor *


analysedText.Height) around analysedText.BoundingBox
'*** will be recognized as belonging text.
'*** One of the four otherText.BoundingBox edge points must be inside
this area to be recognized.
'*** The TextDistanceFactor has To be specified For X and Y direction
separately. (default 1 Each)
objDwgDxfInterface.TextDistanceFactorX = 1
objDwgDxfInterface.TextDistanceFactorY = 1

objDwgDxfInterface.ConsiderDistanceOfTextInsertionPoint = false '


optional: (default false)
objDwgDxfInterface.DistanceOfTextInsertionPointsFactorX = 1 '
optional: (default 1)
objDwgDxfInterface.DistanceOfTextInsertionPointsFactorY = 2 '
optional: (default 1)

'*** optional: switch to take the text height into account during
recognition on or off (default true)
objDwgDxfInterface.CompareTextHeights = true

'*** optional: tolerance factor to be able to detect slightly


different text heights anyway (default 0.1).
objDwgDxfInterface.CompareTextHeightsToleranceFactor = 0.1

strCsvAllText = objDwgDxfInterface.GetCsvTexts ' mandatory: main


function to get the csv string

'************ STEP 4 ************


'*** Create Comos docObj's

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 119
Administering the import / export of plant components
13.2 Administering a Conval interface

Count =
objDwgDxfInterface.CreateComosObjectsByCsvLine(strCsvAllText,
b.CDevice, c)
Output "Created Devices: " & Count

'************ STEP 5 ************


'*** Shutdown
End If
Set objDwgDxfInterface = Nothing

13.2 Administering a Conval interface


The Conval calculation program has a bidrectional link with COMOS. The interface for Conval
is addressed via the corresponding base objects.
The following objects can be calculated:
● Control valves and security valves
● Covers
● Breaker plates
● Pipes

Supported versions
COMOS supports the versions Conval 8 and Conval 9. COMOS supports the following
functions:
● Security valve dimensioning and pressure loss calculations
● Calculation of valve/pipe/vessel dimensions
● Wall thickness/substance data calculations

Request via document


To call Conval via document, you must first create a document with the required Conval type
in the base data. Use the script block "UserScriptblock" at the base object and insert the two
procedures:
Sub ConvalExport( Calcer)
...
End Sub
Sub ConvalImport( Calcer)
...
End Sub
You can find additional information on this topic in the "COMOS Platform Operation" manual,
keyword "Document types".

Control of Calcer
To transfer texts, use the following script:

P&ID Administration
120 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.3 Administering a Microstation import (dgn, pid)

calcer.cvcalculation.CalculationData.ParamByName("IDENTIFIER").text
= calcer.bobj.FullName + " " + calcer.bobj.Description
To transfer attribute values and units, use the following script:
calcer.copyval "","Y00T00041.Y00A01182","Qm", False ' volumeflow
True = Comos - Conval;
False = Conval - Comos;
To check the "Volumeflow" option in Conval, use the following script:
calcer.cvCalculation.CalculationData.paramByname("QmorQv").SwitchSta
te = 2 'volumeflow - Radio button in Conval is set

Identifying field names


To display a field name, click in a Conval field and press <Ctrl + Shift> or <Ctrl>.

Application
When you open document with a Conval document type, Conval itself starts up with the default
settings. You can then input data in the usual way. When you close Conval, the data are
automatically transferred from Conval to COMOS.

13.3 Administering a Microstation import (dgn, pid)

13.3.1 Configuration file "DGNImport1.xml"

Path to the configuration file


The standard configuration file "DGNImport1.xml" can be found in the COMOS installation
directory under the following path:
"<COMOS installation directory>\Current\Bin\OCX\WSP"
If you have deleted or renamed the configuration file, you can generate it automatically. To do
this, proceed as follows:
1. Open the "Convert DGN drawing to engineering objects" window. You can find additional
information on this topic in the "P&ID Operation" manual, keyword "Importing DGN file".
2. Click the "Options" button.
3. Click on the "Save" button in the "Options" window,
but do not make an entry in the "Configuration file" field on the "Common" tab.
4. Click "Save".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 121
Administering the import / export of plant components
13.3 Administering a Microstation import (dgn, pid)

13.3.2 Assigning a DGN line type to a COMOS line type

Introduction
Assign the DGN line types to the line types available for selection in COMOS on the "Line types"
tab of the "Options" window. You can usually use the operating system line types you selected
on the P&ID (using the context menu command "Options > Graphical properties").

Requirement
The "Options" window is open. See also section Configuration file "DGNImport1.xml"
(Page 121).

Procedure
1. Select the "Line types" tab.
2. Select the required line type from the "COMOS line types" table.
3. Select the required DGN line type from the "Used DGN line types" table.
Repeat steps one and two for each DGN line type to which you wish to assign a COMOS line
type. Multiple selection is not possible.
4. To assign the selected line types to one another, click the "<<Assign" button.
5. Select one of the following options:
– Click "Save" to save the settings in the existing configuration file.
– Click "Save As" to save the settings in a new configuration file. Select the required
directory. Enter a file name. Click "Save".

Result
Both line types are assigned to each other and added to the "Assigned line types" list. The
settings are written to the configuration file and saved as the default settings for DGN imports.

13.3.3 Assigning a DGN layer to a COMOS layer

Introduction
Assign the DGN layers to the COMOS layers available in the drawing type currently in use on
the "Layers" tab of the "Options" window.

Requirement
The "Options" window is open. See also section Configuration file "DGNImport1.xml"
(Page 121).

P&ID Administration
122 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.3 Administering a Microstation import (dgn, pid)

Procedure
1. Select one or more DGN layers from the "Used DGN layers" table.
2. Select the required COMOS layer from the "Layers for the current symbol type" table.
3. To assign the selected layers to one another, click the "<<Assign" button.
4. Select one of the following options:
– Click "Save" to save the settings in the existing configuration file.
– Click "Save As" to save the settings in a new configuration file. Select the required
directory. Enter a file name. Click "Save".

Result
The layers are assigned to each other and added to the "Assigned layers" list. The settings are
written to the configuration file and saved as the default settings for DGN imports.

13.3.4 Assigning a DGN font to a Windows font

Introduction
Assign the DGN fonts to the selected Windows fonts on the "Fonts" tab of the "Options" window

Requirement
The "Options" window is open. See also section Configuration file "DGNImport1.xml"
(Page 121).

Procedure
1. Click the "..." button next to the "Path to the font resource files:" field.
The "Search folder" window opens.
2. Select the directory in which the DGN fonts are saved.
3. Click "OK".
You return to the "Fonts" tab. The DGN fonts in the selected directory are listed in the table
on the right.
4. Click "..." next to the mapping table.
The "Font" window opens.
5. Select the required font.
6. If applicable, select the required font mode and font size.
7. Click "OK".
You return to the "Fonts" tab.
8. Select one or more DGN fonts from the table on the right.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 123
Administering the import / export of plant components
13.4 Administering Pipe Easy

9. To assign the selected DGN fonts to the selected Windows font, click the "<<Assign" button.
10.Select one of the following options:
– Click "Save" to save the settings in the existing configuration file.
– Click "Save As" to save the settings in a new configuration file. Select the required
directory. Enter a file name. Click "Save".

Result
The fonts are assigned to one another and displayed in the mapping table. The settings are
written to the configuration file and saved as the default settings for DGN imports.

13.3.5 Undoing an assignment

Requirement
You have made assignments in the "Options" window.

Procedure
To undo the assignment of the entries in the mapping table, proceed as follows:
1. Select one or more entries in the mapping table.
2. Click on the ">> Detach" button.

Result
The selected entries are removed from the assignment list.

13.3.6 Base objects from dgn data imports


dgn data imports create base objects in COMOS. See chapter Base object "@20 > D20 Base
objects from external CAE data imports" (Page 170).

13.4 Administering Pipe Easy

13.4.1 Adding the "Show PipeEasy conversion settings" button to the toolbar
"Show PipeEasy conversion settings" button:

P&ID Administration
124 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.4 Administering Pipe Easy

This button is not displayed on the toolbar of the P&ID by default. Use a script to add the button
to the toolbar.

Requirement
The "std_PipeEasy" icon is available in the pictures library.

Procedure
1. Open the report template for the P&ID containing the toolbar you wish to add the button to.
2. Right-click in the white area of the report template.
3. Select the "Options" command from the context menu.
The "Options" window opens.
4. Enter the following script at the end of the '**PipeEasy Script section:
UIObject.AddMenu
UIObject.AddMenu
"ComosImportUtilities.ImportUtilities:ShowSetupForm", "",
"std_PipeEasy", MenuText
Note
XXDocProgID = "ComosPKBXXDoc.XXDoc" instruction
If the XXDocProgID = "ComosPKBXXDoc.XXDoc" instruction exists, delete it.

5. Click "OK" to save your input and close the "Options" window.

Result
The "Show PipeEasy conversion settings" button is added to the P&ID toolbar.
You can find additional information on this topic in the "Administration" manual, keyword
"Inserting button (icon) in the report toolbar".

13.4.2 Configuring tabs of the "Conversion settings" window

Overview
The "Conversion settings window comprises four tabs. You can hide tabs and define standard
actions for text rules in the options script of the report template.

Example
When you run the following script, only the "Assign texts" tab is displayed:
UIObject.AddMenu
"ComosImportUtilities.ImportUtilities:ShowSetupForm",
"DisabledTabs:0;2;3|DEFAULTACTION:1", "std_PipeEasy",
"Show conversion form"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 125
Administering the import / export of plant components
13.4 Administering Pipe Easy

13.4.3 Creating base objects for text rules

Introduction
First create an action base object under which the base objects for text rules are collected.
Underneath this, create the number of base objects you require, with scripts describing texts.

Requirement
The base project is open.

Creating an action base object


To create an action base object for text rules, proceed as follows:
1. Select the "Base objects" tab in the Navigator.
2. To do this, right-click on the node below which you wish to create the base object and select
the "New > New base object" command from the context menu.
The properties of the new object open.
3. Select "Action" from the "Class" list.
4. Select "Script" from the "Subclass" list.
5. Enter the desired name for the object, e.g. "T", in the "Name" field.
6. Enter the desired description for the object, e.g. "Text assignment rules", in the "Description"
field.
7. Click "OK" to create the object and close the properties window.

Creating base objects with scripts describing texts


To create a base object with scripts describing texts, proceed as follows:
1. Select the "Base objects" tab in the Navigator.
2. Right-click on the desired node of the action base object.
3. Select the "New > New base object" command from the context menu.
The properties of the new object open.
4. Select "Action" from the "Class" list.
5. Select "Script" from the "Subclass" list.
6. Enter the desired name for the object in the "Name" field.
Every base object must have the same name as its script function. Example: The base
object "SetName" must have a script function called "SetName".
7. Enter the desired description for the object, e.g. "Rename object", in the "Description" field.

P&ID Administration
126 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.4 Administering Pipe Easy

8. Add the required script to the "Script" tab.


Make sure that the script function has exactly the same name as the base object.
The script function must have a parameter array:
– Params(1): Comos object of the symbol
– Params(2): Text
– Params(3): ReportObject
– Params(4) ReportText (if selected) or Nothing (if name of an attribute is set)
9. Click "OK" to create the object and close the properties window.

Result
The base object is created. If the function is completed successfully, an empty string ("") is
returned. If the function is not completed successfully, a text is returned describing the error.

Script example 1:
ChangeOwner: moves the object to unit UJ50
Function ChangeOwner(Params)
ChangeOwner = ""

Set Device = Params(1)


Text= Params(2)

' Device->Document->DocFolder->Unit
Set StartDev = Device.owner.owner.owner

For i = 1 To Len(Text)
s = Mid(Text, i, 1)

If IsNumeric(s) Then
s = Mid(Text, i)
Set StartDev = StartDev.Devices.Item(s)
If StartDev Is Nothing Then
ChangeOwner = "Unit " & Text & " not found"
Exit Function
Else
Exit For
End If

End If

Set StartDev = StartDev.Devices.Item(s)


If StartDev Is Nothing Then
ChangeOwner = "Unit " & Text & " not found"
Exit Function
End If
Next

Device.OwnerCollection.Remove Device

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 127
Administering the import / export of plant components
13.5 Administering Proteus import/export

StartDev.Devices.Add Device
End Function

Script example 2:
SetName: Rename COMOS object
Function SetName(Params)
SetName = ""
Set Device = Params(1)
Text= Params(2)

Device.Name = Text
If Device.Check <> 0 Then
SetName = "Invalid name"
End If
End Function

13.5 Administering Proteus import/export

13.5.1 Overview of the Proteus administration

Requirement
● You are familiar with the Proteus scheme and the DEXPI convention.
You are familiar with the terms "Verification" and "Validation" according to the Proteus
interface.
You can find more information on this topic in the "P&ID Operation" manual, keyword
"Proteus scheme and DEXPI convention".
● You are familiar with the compatibility matrix.
You can find additional information on this topic in the "Installation and Configuration"
manual, keyword "Compatibility matrix".
● The version of the Proteus scheme must be identical in COMOS and in the target
application.
● You are familiar with using Proteus import and Proteus export.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Using
Proteus import/export".

P&ID Administration
128 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

Requirement for database maintenance


● Generally valid assignments
– If an RDL database is available, you can link the COMOS attributes to the Proteus
attributes stored in the RDL database beforehand. See also chapter Mapping COMOS
attributes to Proteus attributes (Page 129).
– See chapter Reference of the "Proteus" tab (Page 132).
– The "Proteus" category is edited in the project properties.
● Configuring Proteus export
See chapter Configuring Proteus export (Page 134).
– There is also the option for exporting to Proteus for PFD reports. The customer database
must first be prepared in order for PFD reports to be exported to Proteus. Talk to
Siemens Sales about the topic customization.
– For the export of user-defined metadata the "Proteus" tab has to exist and the selection
lists used there have to be populated in the base data:
The base objects of the objects which are to be placed on the P&ID are equipped with the
"Proteus" tab.
The required attributes are created in the "Proteus" tab and they are provided with
attribute values.
● Configuring Proteus import
See chapter Configuring Proteus import (Page 141).
Assignment using the component class:
During the Proteus import COMOS searches for all available base objects that have a
ComponentClass. You have to configure the following properties so that the imported base
objects can be linked to the existing base objects of the same component class:
– The component class has to be set on the "Attributes > Proteus" tab at the base objects
so that imported objects are linked automatically to existing COMOS base objects.
See chapter Reference of the "Proteus" tab (Page 132).
– Project properties, category "Proteus", group "Search nodes for base objects with
ComponentClass": "Search node 1" to "Search node 10"
If you specify an object here, COMOS searches under the specified object.
The more specific the search objects you enter here, the faster the import.
If no object is specified, COMOS searches in the entire base project.

13.5.2 Shared settings of import and export

13.5.2.1 Mapping COMOS attributes to Proteus attributes

Requirement
● The general requirements have been fulfilled.
You can find additional information on this topic in the "P&ID Operation" manual, keyword
"Requirements / Versions".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 129
Administering the import / export of plant components
13.5 Administering Proteus import/export

Procedure
1. Open the base project.
2. Search for the following base object in the "Base objects" tab:
"@20 > B60 > M22 > A10 > A10 Configurator for attribute mapping"
3. Open the properties and select the "Attributes > Proteus" tab.
4. Drag the base object of P&ID equipment into the "Link to base object" field.
The attributes of this base object appear in the "Attributes" list.
5. In the "Select database" field, select a database with RDL data.
6. Drag a standard table suitable for the equipment into the "Link to standard table" field.
Standard tables for Proteus attributes are prepared in the iDB at the following location:
"Y40 > M22 > A10 > Y40M22N00001 Proteus mapping"
Entries prepared in the standard table appear in the "Mapping table".
7. Select the entries to be linked in the "Attributes" list.
8. Click on the "Create entries" button.
Additional entries are created in the "Mapping table" list as needed.
9. Click on the "Create dummy assignment" button.
The wildcard entry has the following syntax:
– "ISO 15926" column: Blank
– "Proteus class" column: <CamelClassified attribute description>
– "Sandbox ID" column: SAGTBD<attribute.nestedname>
– "Sandbox URI" column: SAGTBD<attribute.nestedname>
– "Value" column: Value = 0 causes suffix "_Min"; Value = 1 causes suffix "_Max"
10.Click on the "Search sandbox" button.
The attributes are linked.
11.Confirm your entries.

13.5.2.2 Standard tables

Principle
For certain attributes in the PlantItem node, the Proteus standard does not permit free text, but
rather expects a specific, predefined series of values.
To prevent users from making incorrect entries, the attributes are stored in the database with
standard tables that only contain permitted values.
Because Proteus expects the values in English, these standard tables are available in English
only.

Standard table "ComponentType XMpLant"


You can find the standard table in the following node in the database:

P&ID Administration
130 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

"Standard tables > Y10 > M22 > A10 > Y10M22N00004 > Y10M22N00004A01
ComponentType XMpLant"
The standard table has the following values:

Name Description Value 1 Comment


"A000" "<default>" "<default>" Default value: "Normal"
"A001" "Unique" "Explicit" The symbol definition takes
place explicitly.
"A002" "Normal" "Normal" The symbol definition from
the shape catalog is used.
"A003" "Parametric" "Parametric" The symbol definition is as‐
signed parameters.

Standard table "XML class" (old: PlantItemNodeName)


You can find the standard table in the following node in the database:
"Standard tables > Y10 > M22 > A10 > Y10M22N00004 > Y10M22N00004A02 XML class"
The standard table has the following values:

Name Description Value 1 Comment


"A000" "<default>" "<default>" Default value: "Equipment"
"A001" "Component" "Component" ‑
"A002" "Equipment" "Equipment" ‑
"A003" "InstrumentLoop" "InstrumentLoop" Always used for positions
"A004" "Nozzle" "Nozzle" ‑
"A005" "PipeConnector" "PipeConnector" ‑
"A006" "PipeFlowArrow" "PipeFlowArrow" ‑
"A007" "PipingComponent" "PipingComponent" Always used for pipes
"A008" "PipingNetworkSegment" "PipingNetworkSegment" Always used for pipe sec‐
tions.
"A009" "PiningNetworkSystem" "PiningNetworkSystem" ‑
"A010" "PlantArea" "PlantArea" ‑
"A011" "ProcessInstrument" "ProcessInstrument" Always used for functions
"A012" "SignalConnectorSymbol" "SignalConnectorSymbol" ‑
"A013" "SignalLine" "SignalLine" Data lines and effect lines are
detected by the software dur‐
ing export and are exported
as PlantItems of the type "Sin‐
galLine".

Standard table "Status Proteus"


You can find the standard table in the following node in the database:
"Standard tables > Y10 > M22 > A10 > Y10M22N00004 > Y10M22N00004A03 Status Proteus"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 131
Administering the import / export of plant components
13.5 Administering Proteus import/export

The standard table has the following values:

Name Description Value 1 Comment


"A000" "<default>" "<default>" Default value: "Current"
"A001" "Current" "Current" ‑
"A002" "Removed" "Deleted" ‑
"A003" "Changed" "Modified" ‑
"A004" "New" "New" ‑

13.5.2.3 Reference of the "Proteus" tab

Requirement
● You are familiar with the overview of the Proteus administration.
See chapter Overview of the Proteus administration (Page 128).

"XML scheme" control group

"XML class" field Component of the Proteus import See chapter Standard tables (Page 130).
When you use an unknown XML class, a warning is displayed during the Proteus
export.

"Attributes" control group

Control element Description


"Component class" field Defines the component class of the object. If you specify the com‐
ponent class of the COMOS base object, base objects imported
from Proteus and newly created base objects with the same com‐
ponent class are linked automatically to the COMOS base object.
Default value: Entry from RDL library
"Specification" field Contains a unique identification key across all projects.
"StockNumber" field Contains the stock number of the object.
Default value: Base object of the object, "SystemFullName" prop‐
erty
"Revision" field Contains the revision state of the object.
"Status" list Contains the working status of the object. See chapter Standard
tables (Page 130).
"PersistentID" field Filled out automatically during the import of Proteus files.
"TagName" field Name of the equipment. Corresponds to the "Name" or "Label"
field in the "General" tab.
"Registration number" field

P&ID Administration
132 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

Control element Description


"ComponentName" field Value is set by script. Used to identify the shape in the ShapeCa‐
talogue.
Default value: SystemFullName of the base object of the exported
engineering object and graphical properties of the object.
"ComponentType" list Specifies how the symbol definition is to be carried out.
Default value:
● ShapeCatalog item: "Explicit"
● Outside the shape catalog: "Normal"
See chapter Standard tables (Page 130).

"Attribute assignment" control group

Column Description
"COMOS nested name" -
"Proteus attribute name" -

"Filter for attribute export" control group

Control element Description


Option: "Only export following attributes" Specifies which P&ID object attributes from the
lower-level tabs of the "Attributes" tab are exported
as generic attributes.
● Deactivated (default setting): All attributes
whose "Value" is set are exported.
● Activated: Only attributes that are part of the
"AttributesList" are exported.
Values:
● 0 = deactivated
● 1 = activated
Table "COMOS interconnected name" column:
Contains attributes which are to be exported as
generic attributes.
Values:
"NestedName" of the attributes.
<tab name>.<attribute name>

"Sandbox references" control group

"RDL - URI" field Link to a website with the RDL Library


"Sandbox ID" field ID of the component in the RDL Library.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 133
Administering the import / export of plant components
13.5 Administering Proteus import/export

Link to mapping table

"Link to mapping table" field Component of the Proteus import

See also
Managing the "Proteus" tab (Page 135)

13.5.3 Configuring Proteus export

13.5.3.1 Configuring the "Proteus export" category

Requirement
● The base project is open.
The following project properties must be read from the base project or the base project
working layer.

"Export" group: "Target directory"


Defines the directory in which the exported files are saved.

"Export" group: "File name pattern"


Defines the name of the exported file.
Permitted placeholders:
● ${AliasFullLabel}
● ${Description}
● ${FullLabel}
● ${FullName}
● ${Label}
● ${Name}
● ${PathFullName}
● ${SystemUID}
● ${DateTime(<DateTime format string>)}
Retrieving the date in the .NET Framework. You can find the documentation in the . NET
help, keyword: "Working with base types in .NET: Formatting types: Standard format strings
type for date and time.
Example: ${DateTime(yyyy_MM_dd_hh_mm)}_${Label}.xml
Result: 2019_07_08_06_54_FB.001.xml

P&ID Administration
134 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

Replacing special characters:


● < > : / \ | ? *
are replaced with _
● ASCII control characters (char)0 to (char)31
are replaced with _
Multiple blank characters are permitted.
Example:
● ${PathFullName} . ${Name} ${Description}
Default:
● ${FullName} (${SystemUID})

"Export" group: "Schema file directory"


Determines the schema file. The Proteus scheme is read from this file.

"Proteus schema version" group


● "4.0.1"
Generates files during export according to schema 4.0.1.
A schema according to 4.0.1 must be entered in the "Schema file directory" field.
● "3.6.0"
Generates files during export according to schema 3.6.0.
A schema according to 3.6.0 must be entered in the "Schema file directory" field.

13.5.3.2 Managing the "Proteus" tab

Requirement
● You are familiar with the reference of the "Proteus" tab.
See chapter Reference of the "Proteus" tab (Page 132).

Objective
In the Proteus scheme, P&ID objects are saved as PlantItem nodes. In order to export objects
in compliance with the standard, the interface requires certain metadata types from the P&ID
objects. You have the possibility to choose from the following values for the metadata:
● Hard-coded default values in the software
● User-defined values
When using user-defined values, you must define them on the following tab:
● Name: "Y00T00277"
● Description: "Proteus"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 135
Administering the import / export of plant components
13.5 Administering Proteus import/export

Inheritance source of the "Proteus" tab


In the database, the tab attributes are defined below the following node:
"@10 > A20 > A10 > A10 > Y00T00277 Proteus".

Adding the "Proteus" tab to the base data


If a P&ID base object does not include the "Proteus" tab, add it in the properties.
You can find additional information on this topic in the "Administration" manual, keyword
"Adding tabs to base objects".
In the database, the tab is inherited to the following nodes:
● "@10 > A20 > A10 > A10 Physical objects":
Result: All objects placed on a P&ID have the tab.
No attribute values are set at this level. The configuration was not adapted to the component
types until the below located levels.
● "@20 > A30 Functions":
The configuration corresponds to the Function type.

Creating additional attributes in the "Proteus" tab


Rather than using the tab that has been pre-configured in the "@10 > A20 > A10 > A10 >
Y00T00277 Proteus" node, you have the option of determining the attributes used on the
"Proteus" tab yourself.
You can find additional information on this topic in the "Administration" manual, keyword
"Creating an attribute".
The following applies:
● Default values are hard-coded in the software for all attributes of the "Proteus" tab. When
exporting an object, the default value of an attribute is only overwritten if the object has the
corresponding attribute.
● You should configure the "PlantItemNodeName" attribute as high up in the base data as
possible.
In the database, a value is assigned to the attribute at the following levels:
– On the levels below "@10 > A20 > A10 > A10 Physical objects"
– "@20 > A30 Functions"
● Create all other attributes at the below located levels, depending on the respective project
requirements.

P&ID Administration
136 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

Configuring attribute values


Following applies when configuring attributes:
● Either you specify the attribute values in the base data or the users set the attribute values
at the engineering end.
● With an export, values set on the engineering object in the "Proteus" tab are always written
to the Proteus file.
● If no value was assigned to an attribute, an empty string is written to the export file.

Export without the "Proteus" tab


If an object placed on the P&ID does not have an "Proteus" tab: COMOS determines which
PlantItem type corresponds to this object based on the "Class" and "Subclass" properties of the
associated base object.
You will find these properties on the "General" tab of the base object.

Result
● A PlantItem node of the corresponding type is created for the object in the export file.
● Objects whose class and subclass have no corresponding "PlantItem type" are exported as
equipment (for example: revision clouds).
● The hard-coded default values are assigned to the PlantItem node attributes.

13.5.3.3 Hard-coded PlantItem types


For certain objects, hard-coded PlantItem types are used regardless of the value the
"PlantItemNodeName" attribute has on the "Proteus" tab.

Pipes
The following PlantItem types are used for pipes:

Three-level pipe structure Two-level pipe structure (pipe sec‐


tion and pipe segment)
Pipe "PipingNetworkSystem" "PipingNetworkSystem" dummy
node
Pipe section "PipingNetworkSegment" See three-level structure
Pipe segment Not an own PlantItem node. A Cen‐ See three-level structure
terline node is created underneath
the corresponding PipingSegment
node. The Centerline can have any
number of coordinate nodes.

Functions and positions


The following PlantItem types are used for functions: "ProcessInstrument"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 137
Administering the import / export of plant components
13.5 Administering Proteus import/export

13.5.3.4 Note on line types during export


There is no assignment file for line types in the iDB for the Proteus export.
COMOS writes the names of the line types into an export file. You can create an assignment
file for line types in the target software.
Alternative:
● Workset.globals.Proteus_UseOldLineTypeDefault = True
Activates the setting used prior to COMOS 10.3: All line types are exported as line type "0
Continuous line".

13.5.3.5 Reference of the included objects and graphics

Overview of the export scope


The following data is exported:
1. The on the P&ID placed objects:
– Equipment
– Instrumentation
– Functions and their positions
– Pipes, pipe sections and pipe segments
– Pipe parts
– Intelligent texts
– All other graphics placed on the P&ID for which an object exists in the Navigator
2. Data lines and effect lines
3. Purely graphical elements of the P&ID:
– Texts
– Lines
– Circles
– Elbows
4. Data from the P&ID itself

1. Data from the objects placed on the P&ID


The on the P&ID placed objects are exported as PlantItems. The owner structure of the objects
is retained.
The following data is exported:
● "Label" property
● The "SystemFullName" property

P&ID Administration
138 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

● Export relevant metadata


The software uses hard-coded default values or user-defined values for metadata.
● The attributes which are located on the subtabs of the "Attributes" tab and whose "Value" is
set.
There are two options:
– Export all attributes
– Exporting user-defined attributes
● Intelligent texts: Attributes placed with drag&drop
When attributes are placed on the P&ID with drag&drop, these texts are exported as
Proteus text element with the properties "DependantAttribute" and "ItemID".
When such attributes are imported, the current value of the attribute is read during the
import and displayed on the report.
● Special case for range attributes: The expressions Min, value, Max are each exported as an
individual attribute:
– Minimum value: Name_0
– Value: Name
– Maximum value: Name_1
● P&ID coordinates of the object
● Symbol graphic
– Inherited symbols
Inherited symbols are exported through the ComponentName as reference to the
ShapeCatalogue.
– Local symbols
Local symbols are exported as part of the PlantItems.

2. Data of the data lines and effect lines


Data lines and effect lines are exported as PlantItems of the "SignalLine" type.
The P&ID coordinates are exported.

3. Graphical elements of the P&ID


The purely graphical elements are exported as ShapeItems.
The following data of the purely graphical elements is exported.
● P&ID coordinates
● Graphics and/or text

4. P&ID data
The P&ID is exported as a Drawing .

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 139
Administering the import / export of plant components
13.5 Administering Proteus import/export

The following P&ID data is exported:


● "SystemFullName" property
● "Description" property
● Drawing type
● Report frame
● Report header

13.5.3.6 Reference to the included owner structure

Owner structure retained


If an object placed on the P&ID is located in the Navigator below another object placed on the
P&ID, this owner structure is retained in the Proteus file.

Pipe structure
The pipe structure is retained if:
● The pipe segment is saved below the PlantItem node of the pipe section.
● The pipe section is saved below the PlantItem node of the pipe.

Functions and positions


When a function is placed on the P&ID, the following data is exported:
● The function
● The position below which the function is located
In the Proteus file, the PlantItem node of the function is created below the PlantItem node of the
position.

Other objects
Assemblies and accessories are saved below the same owner as in the COMOS Navigator.
Examples:
● In COMOS, a valve is located below a pipe section. In the Proteus file, the PlantItem node
of the valve is located below the PlantItem node of the corresponding pipe section.
● In COMOS, a nozzle is located below a vessel. In the Proteus file, the PlantItem node of the
nozzle is located below the PlantItem node of the vessel.

P&ID Administration
140 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.5 Administering Proteus import/export

13.5.4 Configuring Proteus import

13.5.4.1 "Proteus" category: Defining search node

Component class
Project properties, category "Proteus", group "Search nodes for base objects with
ComponentClass":
The search nodes speed up the import, because fewer objects must be searched in COMOS
during the import. Therefore, the more search nodes set and the more specific the search
nodes, the faster the import.
P&ID objects to be linked to the imported objects must be located under the search nodes.

Note
Replacing the default value of versions prior to 10.1 SP2
The default value in all versions prior to 10.1 SP2 is no longer valid for the current version.
For the Proteus export to work correctly, you need to replace the old default value with the "@30
> M00 COMOS general" value.

13.5.4.2 Creating "OnXMpLantImportDone" at COMOS objects


You can insert the OnXMpLantImportDone subprogram at the following base objects:
● P&ID objects
If you specify a component class in the properties of a P&ID base object in the "Attributes
> Proteus" tab and this coincides with the component class of imported base objects, the
objects are linked together. The imported base objects obtain the properties and scripts of
the existing base object with which they are linked.
If engineering objects are created during the Proteus import, the OnXMpLantImportDone
subprogram is passed to them. Once the import is complete, the subprogram is executed for
each engineering object.
● P&IDs
When you perform an Proteus import in a P&ID that has the OnXMpLantImportDone
subprogram, the subprogram is executed as soon as the import is completed.

Procedure
1. In the base project, navigate to the base object in which you want to insert this script.
2. Open the "Script" tab in the properties.
3. Open a function.
4. Insert the following subprogram:
Sub OnXMpLantImportDone
...
End Sub

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 141
Administering the import / export of plant components
13.5 Administering Proteus import/export

5. Specify the contents of the script.


6. Click "OK".
7. If the function is not yet implemented, enable the option in the "Implemented" column.
8. Confirm your entries.

13.5.4.3 Base objects from Proteus data imports


An import from a CAE third-party software creates master data in COMOS. During the import,
COMOS creates the master data in the following node:
● "@20 > D20 Base objects from external CAE data imports > Proteus imports"

13.5.4.4 Assigning COMOS line types to Proteus line types

Requirement
● You are familiar with the overview of the Proteus administration.
See chapter Overview of the Proteus administration (Page 128).

Procedure

Note
No global mapping
The mapping applies for the COMOS line type valid in the respective P&ID report. Note that you
have different options to define line types in COMOS. See the "Administration" manual,
keyword "Administering line types". If the COMOS line type "1" is replaced, for example, line
type "1" can look different in various P&ID reports but still be mapped to the same Proteus line
type.

1. Open the base project.


2. Search for the following standard table in the "Base objects" tab:
"Standard tables > Y40 > M22 > A10 > Y40M22N00003 Proteus line type assignment"
3. Open the properties of the standard table.
4. Edit the standard table as follows:
– "Name": Current, unique counter according to iDB notation.
– "Description": Meaningful description
– "Value 1": COMOS line type in accordance with the following standard table:
"Standard tables > Y10 System tables > M00 COMOS general system tables > A10
System tables 00001 - 00025 > Y10M00N00002 line type"
– "Value 2": Proteus line type according to Proteus documentation.
5. You can assign multiple Proteus line types to a COMOS line type.

P&ID Administration
142 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.6 Administering PDF import: String rule manager

6. Optional: For the sake of completeness, you can enter which Proteus line types you wish to
ignore in the standard table.
Generate the standard table value as normal and enter "x" in the "Value 1" column. In this
case you see the entry in the standard table, but the Proteus line type is ignored during the
import.
7. Confirm your entries.
8. Optional: Usage of the hardcoding object in the iDB
– Hardcoding object: Base object "@99 > A90 > Y00R00070 Hardcoding object"
– Use the following hardcoding entry:
"A00242 Standard table for Proteus line types"
Module: "M22"
Hardcoding object: "Y40M22N00003"
Locked: "True"

Implementation in the cDB


"Standard tables > @SYSTEM tables for COMOS > @ XMpLant XMpLant configuration >
LineTypeMapping"

13.6 Administering PDF import: String rule manager

Requirement
● The PDF import is known.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Using
PDF import".

Open the string rule manager


Open: COMOS menu "Administrator > Base data > String rule manager"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 143
Administering the import / export of plant components
13.6 Administering PDF import: String rule manager

User interface

"Rulesets" control group

Control element Description


"Selected ruleset" list Contains all existing rulesets.
"New" button Opens the "Create new ruleset" window.
In this window, enter the name of a new ruleset and confirm your entries.
This name appears during PDF import in the "Ruleset" window in the
"Ruleset" list.
"Delete" button Deletes the ruleset that was selected in the "Selected ruleset" list.
Rules of the rule set This section contains the rules that were added to the ruleset.
"Up", "Down" buttons You can use these buttons to change the order of the rules within a rule set.
"Right", "Left" buttons You can use these buttons to assign and remove rules from the "All rules"
area to a ruleset.
"Preview" area You can use example texts here to check whether the rules in the ruleset
recognize the texts.
Enter the example text in the "Text" column. If a rule applies, the name of
the rule is entered in the "Matching rule" column.
"Load" button Loads a previously saved CSV file with example texts for the preview.
"Save" button Saves all example texts to a CSV file.

"All rules" control group

Control element Description


"All rules" area Displays a collection of all the rules that you have previously defined.
"New" button Opens the "Create new rule" window.
"Edit" button Opens the "Edit rule" window.
"Delete" button Deletes the selected rule.

P&ID Administration
144 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

Creating or editing a rule


The string rule manager is an auxiliary tool for the PDF import. During a PDF import, all the texts
of a PDF are imported into COMOS. COMOS creates objects for each text in a text field in
accordance with the rules defined here. The created objects are placed on the P&ID in
accordance with the position of the texts in the PDF. During the PDF import, the ruleset defined
here is loaded in the "Ruleset" window.
1. In the "Ruleset" area select an entry in the "Selected ruleset" list.
Alternative: Use "New" to create a new ruleset.
2. Click "Creates a new rule" in the "All rules" area.
Alternative: In the "All rules" area, select a rule and click "Edits the currently selected rule".
The "Create new rule" window or "Edit rule" window opens.
3. Right-click "Create empty rule" in the "Rule" area.
4. Select a base object on the left in the "Rule" area and drag the base object to the right to the
"Base object" field.
5. Right-click "Edit rule" in the "Rule" area.
The "Edit rule" window opens.
You can find additional information on this topic in the "Automation interfaces" manual,
keyword "Working with rules".

13.7 Administering the "General P&ID export / import" interface

13.7.1 Technical sequence of the interface


The "General P&ID export/import" interface is an XML-based interface for exporting and
importing process-oriented plant data.
The technical sequence when using the interface is described below.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 145
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

Technical sequence when exporting


1. The placed elements of a COMOS P&ID report are transferred to the Proteus interface of
COMOS.
The result of this work step is an XML file according to the Proteus standard
2. The customer creates their own custom standard tables in which the elements of a CAE
third-party system are assigned to the COMOS objects. The XML file is extended with this
information according to the Proteus standard by COMOS.
You can request the list of supported third-party systems from your Siemens sales team.
3. The following files will be stored in an exchange folder:
A ZIP file with the following name: NestedName-SystemUID of the COMOS P&ID report
The ZIP file includes:
– A PDF file of the COMOS P&ID report
– The XML file of the COMOS P&ID report according to the extended Proteus standard
– An XML file with the metadata of the COMOS P&ID report
– An XML file with symbol assignments
– Additional XML files according to the requirements of the third-party system
With the creation of these files, the function of the COMOS interface is finished. The actual
import into the third-party software is not a part of the "General P&ID export/import".
A CAE third-party software can import the created files. For this, the third-party software must
support the import of XML-based process data.

Technical sequence when importing


COMOS can import files from a CAE third-party software. For this, the third-party software must
support the export of XML-based process data.
The function of the COMOS interface starts with the supplied files. The actual export from the
third-party software is not a part of the "General P&ID export/import".
1. The following files are expected in an exchange folder:
– A ZIP file with the P&ID information of the third-party system (e.g. a "workshare file")
The contents contained in this ZIP file is determined by the third-party system.
2. The customer creates their own custom standard tables in which the elements of a CAE
third-party system are assigned to the COMOS objects.
Export and import can use the same standard table.
3. COMOS extracts a part of the data from the ZIP file:
– The XML file of a P&ID document
– An XML file with the metadata of the document
– An XML file with symbol assignments
– Optionally, if an assignment is possible: A PDF file of a COMOS P&ID report
The result of this work step is a "COMOS package".

P&ID Administration
146 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

4. The user defines a template for a P&ID report.


5. The "COMOS package" is transferred to the Proteus interface of COMOS. A P&ID report is
created together with the customer standard table and the P&ID template.
The result of this work step is a COMOS P&ID report.

No reimport
The "General P&ID export/import" interface is not intended for export and reimport of a P&ID
report without loss. If you export a P&ID report to a CAE third-party system and then reimport
it, there can be differences between the original report and the reimported report.

See also
Editing project properties (Page 147)
Using the "Export" tab (Page 148)
Using the "Import" tab (Page 149)
Structure of the standard tables (Page 151)

13.7.2 Editing project properties

Requirement
● You are familiar with the interface overview.
See chapter Technical sequence of the interface (Page 145).

Exporting a configuration
1. Open the project properties.
2. Select the "Process engineering > General P&ID export > P&ID Interface" category.
3. Edit the "Export directory" option.
The set folder will be evaluated at the following location:
"General P&ID export/import" tool, "Export" tab, "Set export directory" field.

Importing a configuration
1. Open the project properties.
2. Select the "Process engineering > General P&ID export > P&ID Interface" category.
3. Edit the "Import directory" option.
The set folder will be evaluated at the following location:
"General P&ID export/import" tool, "Import" tab, "Set import directory" field.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 147
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

4. Edit the "Workshare directory" option


The set folder will be evaluated at the following location:
– "General P&ID export/import" tool, "Import" tab, "Show workshare directory" field.
– "General P&ID export/import" tool, "Import" tab, "Convert to COMOS package" field.
5. Edit the "Default P&ID template" option
The set report will be evaluated at the following location:
"General P&ID export/import" tool, "Import" tab.

13.7.3 Using the "Export" tab

Requirement
● You are familiar with the interface overview.
See chapter Technical sequence of the interface (Page 145).
● The customer-specific standard tables for link information have been processed.
See chapter Structure of the standard tables (Page 151).

User interface

"Set export directory" button

"Show export directory" button

"Show/hide area" button

Procedure
1. Select the following entry in the COMOS menu:
"Plugins > CAE Apps > P&ID > General P&ID export/import"
The "General P&ID export/import" tab opens.
2. Select the "Export" tab.
3. Optional: Click the "Show/hide area" button on the "Event log" row.
The "Event log" area is displayed. In this area, each work step of the user and COMOS is
logged.
4. Optional: Click on the "Set export directory" button and select a local directory.
Default: Use the default setting in the project properties. See chapter Editing project
properties (Page 147).

P&ID Administration
148 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

5. Optional: Check the export directory.


Existing ZIP files in the export directory appear automatically in the "Exported P&ID: ..." area.
– Click on the "Show export directory" button.
– Check the contents of the ZIP files in the export directory. The naming system of the ZIP
files is NestedName-SystemUID.
– Archive or delete the existing ZIP files if necessary.
6. Optional: Check the P&ID report of an existing export package.
– Select an entry in the "Exported P&ID: ..." area.
– Select the "Show P&ID" entry in the context menu.
– In the ZIP file, the PDF file is called and displayed in the "PDF viewer" area.
Depending on the configuration, a security message from Adobe is displayed in the "PDF
viewer" area. This automatic security message cannot be prevented by COMOS.
– Confirm the security message to completely check the PDF file.
7. Drag&drop an P&ID report from the Navigator into the "P&ID" field.
8. Check the metadata of the P&ID report set in the "Package metadata" area.
Click the "Show the metadata..." button if necessary.
The metadata is written to its own XML file during the export.
9. Click the "Exports the currently selected P&ID" button.
COMOS displays the following message: "Operation pending. Please wait."
10.A new entry appears in the "Exported P&ID: ..." area.
The ZIP file was created in the export folder.

13.7.4 Using the "Import" tab

Requirement
● You are familiar with the interface overview.
See chapter Technical sequence of the interface (Page 145).
● The customer-specific standard tables for link information have been processed.
See chapter Structure of the standard tables (Page 151).

User interface

"Set import directory" button

"Show import directory" button

"Show workshare directory" button

"Show/hide area" button

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 149
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

Procedure
1. Select the following entry in the COMOS menu:
"Plugins > CAE Apps > P&ID > General P&ID export/import"
The "General P&ID export/import" tab opens.
2. Select the "Import" tab.
3. Optional: Click the "Show/hide area" button on the "Event log" row.
The "Event log" area is displayed. In this area, each work step of the user and COMOS is
logged.
4. Optional: Click the "Search folder" button next to the "Convert to COMOS package" field and
select a local directory.
Default: Use the "Workshare directory" default setting in the project properties. See
chapter Editing project properties (Page 147).
5. Optional: Check the Workshare directory.
– Click the "Show workshare directory" button.
– Check the contents of the ZIP file in the workshare directory.
6. Optional: Click on the "Set import directory" button and select a local directory.
Default: Use the "Set import directory" default setting in the project properties. See
chapter Editing project properties (Page 147).
7. Optional: Check the import directory.
– Click the "Show import directory" button.
– Check the contents of the files in the import directory.
– Archive or delete the existing files, if necessary.
8. Click the "Convert" button next to the "Convert to COMOS package" field.
The "COMOS package" is created in the set import directory.
– An entry appears in the "Import P&ID" area.
– The name of the "COMOS package" corresponds to the names of the ZIP file in the
workshare directory.
– If there is a PDF file with the name of the created "COMOS package" in the same
directory, then the PDF file will be added to the "COMOS package".
The PDF file can be shown in the "PDF viewer" area.
– An existing "COMOS package" with the same name will be overwritten.
9. Drag a node from the Navigator to the "Import COMOS package" field.
This node will be the owner of the final, created P&ID report.
10.Click the "Import" button next to the "Import COMOS package" field.
A P&ID report is created.

P&ID Administration
150 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

Managing "COMOS packages" in the "Import" tab


The "COMOS packages" available in the import directory are shown in the "Import P&ID" area.
1. Select an entry in the "Import P&ID" area.
2. Select the "Show P&ID" command in the context menu.
If the "COMOS package" contains a PDF file, it will be shown in the "PDF viewer" area.
3. Select the "Delete package" command in the context menu.
The "COMOS package" is deleted.

13.7.5 Structure of the standard tables

Requirement
● You are familiar with the interface overview.
See chapter Technical sequence of the interface (Page 145).

Hardcoding in the iDB


The "General P&ID export" interface is a variant of the Proteus-based interfaces. The standard
tables in the iDB are created at the following location:
● Standard tables: "Y40 > M22 P&ID > A10 > Y40M22N00003 Proteus line type assignment"
Below this node, its own standard table is created for each required drawing type. The
standard table must adhere to the following naming syntax:
– "Name" field: iDB-compliant name for variants, e.g. Y40M22N00003A01,
Y40M22N00003A02
– "Description" field: COMOS drawing type<space><!><space>name of the standard
Example: M22_P1 ! P&ID (ISO 10628)
The COMOS drawing type must correspond to the following entry: CDevice, "Symbols"
tab, "Type" column.
The description is hardcode queried and must conform to the syntax above.

Column definitions
● Name
Any, but with unique number.
● Description
Name of the report element according to the Proteus standard.
Example: 2-way valve (actuating function)

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 151
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

● Value 1
– Path to the COMOS base object
Example: @30\M00\A60\A30\A20\01
or
– "Default"
The "Default" entry means that no assignment is made between a COMOS base object
and an object in the third-part system. An unchanged object in the third-party system is
used instead.
This case is standard for report elements for which no COMOS base object exists but a
symbol exists in the third-party system. Examples: Connection interruptions, signal lines,
connectors of connections.
● Value 2
Optional: Call of a COMOS script according to the following syntax: Call of the script base
object from the COMOS script library <comma> name of the script block.
Example: @20\A80\M27\A20\M27S00052, GetInstrumentType
● Value 3
Class of the process element according to the COMOS system.
Example: Measuring function
● Value 4
Optional. Example: String of a bitmap, parameter.
● Value 5
Name of the process element according to the third-party system.
● Value 6
Class of the process element according to the third-party system.
Example: Instrument
● Value 7
Optional. Examples: String of a bitmap, parameter ("1", "2", ...).
● Value 8
Path and name of a symbol in the third-party system. The separator is "\". The path
information begins with a separator.
● Value 9
Optional: Call of a COMOS script according to the following syntax: Call of the script base
object from the COMOS script library <comma> name of the script block.

Call of a text example


If the standard tables described in the chapter are missing or empty, the "General P&ID export"
interface will write an error message in the "Event log" area and cancel the export.
1. Create a standard table in the base project according to the specifications in the
"Hardcoding in the iDB" section.
2. Open the standard table.

P&ID Administration
152 Operating Manual, 03/2020 V 10.3.3
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

3. Create a new standard table value with the following information.


– Name: "500"
– Description: "Pipe"
– Value 1: "Default"
– Value 2: <empty>
– Value 3: "Pipe"
– Value 4: "1"
– Value 5: "SP pipe"
– Value 6: "PipeRun"
– Value 7: "1"
– Value 8: "\A\B\C\D.xxx"
4. Save your entries.
This one placeholder is already enough for COMOS to create an export package. The export
package has no useful assignments and also cannot be imported into third-party software.
However, this way you can easily test which files and information are created by COMOS
during the export. You can open the files created and inspect the XML structure.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 153
Administering the import / export of plant components
13.7 Administering the "General P&ID export / import" interface

P&ID Administration
154 Operating Manual, 03/2020 V 10.3.3
Base data reference 14
14.1 cDB master data for modular engineering

14.1.1 cDB master data for symbols and modules

Editing a placeholder (Graybox) "01 Path position"


1. Open the properties of the following base object:
"@02 > 200 > BAS > A > G Placeholder > 01 Path position"
2. Switch to the "Symbols" tab.
3. Deactivate the "Hide unused drawing types" option.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 155
Base data reference
14.1 cDB master data for modular engineering

4. In the list select the row "RI2 P&ID (ISO 10628)".


5. Copy the symbol script from a different drawing type and insert it into this drawing type.
Alternatively, use the following script:
Function Geometry (PARAM)
ResetToDefaults
Header.Layer = "205"
Header.Class = "HID"
Set p1 = Coord(0,-0.25)
Set p2 = Coord(0,0)
Font.Height = 10
Font.Transparent = 1
DrawText p1, "*V*P E:GRAYBOX*", 1, 0
Header.Color = 8421376
Header.Class = "e71"
Set p3 = Coord(0,-8.25)
Font.Height = 10
Font.Italic = 1
Font.Bold = 1
Font.Weight = 700
DrawText p3, "%N Device.Description%", 1, 1
Header.Width = 0.35
Header.LineTyp = 1
Header.Color = 0
Header.Class = "HID"
Set p4 = Coord(0,-4.25)
DrawLine p1, p4
Set p5 = Coord(-8,-4.25)
DrawLine p4, p5
Set p6 = Coord(-8,-12.25)
DrawLine p5, p6
Set p7 = Coord(8,-12.25)
DrawLine p6, p7
Set p8 = Coord(8,-4.25)
DrawLine p7, p8
DrawLine p8, p4
End Function

General use of the "Path position" object


You can find additional information on this topic in the "EI&C Administration" manual, keyword
"Base object in the database".

P&ID Administration
156 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.1 cDB master data for modular engineering

14.1.2 cDB master data for engineering tasks

Standard table "DetailOCX" for engineering tasks


1. Open the following standard table:
"@SYSTEM > Tables for COMOS > @eBlock Tables for eBlocks > DetailOCX configuration
tab"
2. Enter the following standard table value:
– Name "180"
– "Placing and dissolving graybox P&ID" description
– Value 1 "200"

Editing the "Action" standard table


1. Open the following standard table:
"@10 > BAS > SYS System node > A Action"
2. Enter the following standard table value:
– Name "180"
– "Placing and dissolving graybox P&ID" description
– Value 1 "200"

Standard table "Connection type default for graybox objects"


1. Create the following standard table:
"@10 > BAS > SYS System node > Y00N00729 Connection type default for graybox
objects"
2. Enter the following standard table values:
– Name "A20"
"No connection" description
Value 1 "1"
– Name "A30"
"Dynamic connector" description
Value 1 "2"
– Name "A40"
"Nozzle" description
Value 1 "3"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 157
Base data reference
14.1 cDB master data for modular engineering

"Connection type default"attribute


1. Select the node in which the attribute master data for the engineering tasks are located.
According to the standard database this is the following path:
"@10 > BAS > 3 > 27 @Y eBlock task"
2. Create the following attribute:
"SYS System data" tab:
– Name "Y00A01135"
– Description "Connection type default"
– "Input field" display type
– Standard table "Y00N00729 Connection type default for graybox objects"

Base object of the engineering task "A10 Create sheet macro"


1. Select the following node in the cDB:
"@02 > 200 > BAS > A > C Tasks"
2. If required, generate the following base object:
– Class "Action"
– Name "20 Process general"
– You apply all other properties from the other action objects. Recommendation: Copy an
existing action object and rename it.
3. Under the base object "20 Process general" create the following base object:
– Class "Action"
– Name "A10 Create sheet macro"
– "Create assembly" function
– Detail area "Target search"
– "Attributes > SYS System data" tab: Use the extended tab on which the "Connection type
default" attribute is available.

P&ID Administration
158 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.1 cDB master data for modular engineering

Base object of the engineering task "A20 Placing and dissolving graybox P&ID"
1. Select the following node in the cDB:
"@02 > 200 > BAS > A > C Tasks"
2. If required, generate the following base object:
– Class "Action"
– Name "20 Process general"
– You apply all other properties from the other action objects. Recommendation: Copy an
existing action object and rename it.
3. Under the base object "20 Process general" create the following base object:
– Class "Action"
– Name "A20 Placing and dissolving graybox P&ID"
– "Placing and dissolving graybox P&ID" function
– Detail area "Target search"
– Working area: "ABCDWEFGHJK"
– "Attributes > SYS System data" tab: Use the extended tab on which the "Connection type
default" attribute is available.

Example

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 159
Base data reference
14.3 Attributes with locally filtered units

14.1.3 cDB master data for unit structure

Base object "01 Plant"


1. Open the base object properties of your plant.
According to the standard database, this is the following base object:
"@02 > 010 > 1 > PID > 01 Plant"
2. Select the "Elements" tab.
3. Drag the following base object onto the "Elements" tab:
"A20 Placing and dissolving graybox P&ID"
Virtual "N times"
Dereference "No"

Base object "03 Subunit"


1. Open the base object properties of your subunit.
According to the standard database, this is the following base object:
"@02 > 010 > 1 > PID > 03 Subunit"
2. Select the "Elements" tab.
3. Drag the following base object onto the "Elements" tab:
"A20 Placing and dissolving graybox P&ID"
Virtual "N times"
Dereference "No"

14.2 Basic structure of the generic station description in the iDB


The device structure is prepared in the branch "@30 > M00 COMOS general" and is
subsequently used in the branch "@30 > M22 P&ID".
Two catalogs have been prepared in COMOS:
● P&ID Catalog (in the style of EN ISO 10628:2000)
● P&ID Catalog (in the style of ISO 10628:2012)
The catalog in the style of ISO 10628:2012 is preferred in the supplied example database iDB.
See chapter Base object "@30 > M00 > A50 > A15 ... ISO 10628:2012" (Page 174).

14.3 Attributes with locally filtered units


COMOS has a function to filter the units on an attribute. The user can thereby select only the
units needed in a particular work situation. Depending on the version of your database, the
base data provided is already equipped with attributes in which the units are filtered.
You can find additional information on this topic in the "COMOS Administration" manual,
keyword "Filtering the units at the attribute".

P&ID Administration
160 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.5 Base object "@10 > A20 > A10 > A10 Physical objects"

14.4 Base object "@10 > A20 > A10 P&ID"


The "@10 > A20 > A10 P&ID" base object node contains devices and administration objects
that are required exclusively for pipes and instrumentation.

14.5 Base object "@10 > A20 > A10 > A10 Physical objects"
Base object node "@10 > A20 > A10 > A10 Physical objects" is a general catalog for devices.
All of the devices contained in this base object node have certain basic properties.
Furthermore, there are objects that bring along additional properties and abilities.

14.5.1 Labeling

"Objects available for order" catalog


The sorting does not directly comply with the standard, but instead attempts to offer the most
important sections of 26004 and 2401. The "Objects available for order" catalog does not
constitute a complete labeling system that can be used immediately.

14.5.2 Symbol

Drawing types
All simple devices have one or more symbols on the "Symbols" tab. As a rule, the drawing types
"M21_P1", "M22_P1", "M22_P2" "M22_P3" and "M22_P4" feature symbols:

● "M21_P1" drawing type: Main area of application in PFDs.


● "M22_P1" drawing type: Main area of application in chemical plants/based on DIN 28004 or
new: ISO 10628.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 161
Base data reference
14.5 Base object "@10 > A20 > A10 > A10 Physical objects"

● "M22_P2" and "M22_P3" drawing types: Main area of application in power plant
construction/based on DIN 2481.
● "M22_P4" drawing type: Main area of application in Anglo-American units of measurement
based on ISA 5.x.
You can modify the symbols to suit your requirements. Symbols are hierarchically inherited
downwards.

Graphical symbol
You can change the graphical symbols in the properties of the base object, on the "Symbols"
tab. To open the Symbol Editor, double-click in the symbol column.
In the Symbol Editor, you can modify the graphical elements of the symbol using various
drawing tools. You can find additional information on this topic in the "Administration" manual,
keyword "Configuring symbols".
The drawing type symbols have a fixed size and are optimized for a grid and a scale. Various
options enable the symbols to also be used on P&IDs with a different grid and scale.
Each symbol has a placing point which is used for positioning on the grid. The green circles in
the figure above identify the point of origin. The placement point only seldom coincides with the
top left-hand corner, instead it is designed in such a way that the connectors can lie on the grid.
To extend a graphical symbol, insert functions. The following function types are available:
● Functions that determine which connector points a symbol has and where they are attached
to the symbol:

You can find additional information on this topic in the "Administration" manual, keyword
"Configuring connectors".
● Functions that attach subsymbols, i.e. additional symbols, to the graphical main symbol.
Example:
A valve can receive a drive. If you have specified a drive, it should be added to the main
symbol of the valve as a subsymbol.
Whether or not the subsymbol has its own DocObj depends on which function is used to
create the subsymbol.
You can find additional information on this topic in the "Administration" manual, keyword
"Reference of subsymbols / additional symbols".

P&ID Administration
162 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.5 Base object "@10 > A20 > A10 > A10 Physical objects"

Text symbols
You call text symbols in the properties of a base object, on the "Symbols" tab. To do this, double-
click in the "Text" column. Define a text symbol that is attached to the graphical symbol of the
object by means of *V* P Textpkt1*.
Many objects from the base object node "@10 > A20 > A10 > A10 Objects available for order"
already have a text symbol on the top level.
This text symbol is inherited to all base objects below. It is only evaluated at the base objects
that call the text symbol by means of *V* P Textpkt1*. You can find additional information
on this topic in the "Administration" manual, keyword "Text symbol".
The P&ID text symbol outputs the position of the device.
The header of the script for the text symbol contains blind entries:
Header.Layer = "10"
Header.Class = "e72"
Layer "10" is a random number; it is used to bundle specific information. You can also enter
another random layer. Depending on the individual data structure, it is necessary to ensure that
you do not inadvertently use a layer that is already being used for some other purpose.
Header "e72" is a random description that is only used to bundle specific items of information.
You can also enter another random header. Please note that a number of headers have been
pre-assigned by the system. Thus, for example, Header.Class = "eZ" means that the text
cannot be moved.

Duplicate connectors in the symbol


When you evaluate a P&ID symbol on a P&ID, a search is run for duplicate connectors. If
COMOS finds a duplicate connector, the symbol on the P&ID is displayed as inconsistent (red)
and a corresponding error entry is made in the error list.
A duplicate connector exists if there are at least two connectors in the symbol at the same
position.
You can declare connectors with duplicate graphic links to be valid (so that no red connector
point is drawn) by implementing a script function in "UserScriptBlock1" at the base object. For
example, an inconsistency of this type caused by duplicate connector assignment by a process
stream and a reference stream can be removed using the script.
Function IsPartnerConnectionValid( cc1, cc2, ValidationCode)
cc1 (input): COMOS connector of the dedicated engineering object.
cc2 (input): COMOS connector of the graphically linked partner engineering object.
ValidationCode (input): The status of the two COMOS connectors in relation to one another,
where 1 means that the COMOS connectors are not interconnected because at least one of the
two connectors may be linked to another connector.
IsPartnerConnectionValid (Output): Bool
● TRUE:
The graphical connection is valid (no red connector).
Con2 (a piece of equipment) connected to Con1 of the stream is not displayed in red.
● FALSE (default):
The graphical connection is invalid (red connector).

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 163
Base data reference
14.6 Base object "@10 > A20 > A10 > A10 > A60 Elements and components"

14.5.3 Attributes, general

Device attributes
Each device is provided with its own special attributes on the "Attributes" tab. The attributes are
inherited hierarchically; if necessary, they are supplemented or modified by additional
attributes at each level.
All attributes are managed centrally. The base object node "@40 > A10 Attributes catalog" is
used for this purpose.

14.5.4 "System data" tab


A description of some selected attributes in the "System data" tab is provided below.

"Sort parallel to the disconnected pipe branch" attribute


Pipe components can obtain the following attribute:
"Y00T00001.Y00A01089 Sort parallel to the disconnected pipe branch"
This attribute has the following properties:
● Visual type: "Checkbox".
● Value: "0"
● Inheritance source: "@40 > A20 > Y00 > A10 > A10 > Y00T00001 > A06 > B02 >
Y00T00001 > Y00A01089 Sort parallel to the disconnected pipe segment"
If you select this option, the inserted component is always sorted parallel to the connected pipe
section or pipe segment in the engineering view. This makes it part of the pipe structure.
If you deselect this option, the fitting is sorted either directly below the P&ID or into its
designated category. How the fitting is sorted depends upon the options script of the report
template or the unit configuration respectively.
You can find more information on this topic in the "P&ID Operation" manual, keyword "Sorting
components under pipe elements by pipe cut mode".

Quick access to attributes


By default, you have quick access to the attributes of a selected object in the "Attribute filter"
view of the properties tree. You can find additional information on this topic in the
"Administration" manual, keyword "Editing multiple objects in the properties tree".

14.6 Base object "@10 > A20 > A10 > A10 > A60 Elements and
components"
Under this base object node there are objects that, as a rule, are used as constituent parts of
another object (the drives for valves, nozzles, and column fittings, for example).

P&ID Administration
164 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.6 Base object "@10 > A20 > A10 > A10 > A60 Elements and components"

These objects are then entered on the "Elements" tab for the main objects, making them
available when you select the "New" command from the context menu.

14.6.1 Base object "@10 > A20 > A10 > A10 > A60 > A20 Nozzles and connections"

General
Nozzles are used to connect pipes to objects or objects to pipes.

Using nozzles
For a component to be connected automatically via a nozzle, the nozzle must have been input
in the base data as an element of the component and must have the name "NOZZLE". Please
note that the name is case-sensitive (all letters upper case)! You can find an example at the
base object for vessels in chapter Base object "@30 > M00 > A50 > A15 > A10 > A10 Vessels
and tanks" (Page 170).
You can create nozzles on the P&ID. Make a connection to the object on the P&ID. Select the
"Create nozzle" option in the "Select connection type" window.
The option is deactivated if the object does not have a "NOZZLE" element.
You can find additional information on this topic in the "PI&D Administration" manual, keyword
"".

Nozzles with two connectors


A nozzle can also have two connectors instead of one.
If a nozzle with two connectors is used, the dynamic connector that is generated when creating
the vessel is not deleted.
The one connector of the nozzle is joined with the pipe in the usual way. The second connector
has to be created in such a way that it lies on the edge of the vessel in graphical terms and
moreover, precisely at the point at which the dynamic connector of the vessel is created.
In this case the vessel connector is joined with the second connector of the nozzle.
Standard graphical P&ID mapping is used in this case. The connector from the vessel and the
connector from the nozzle can find one another because they are located on top of one another.
The connection is broken if you move the nozzle. However, this cannot be seen at once on the
P&ID, because the connector is located on the nozzle and continues to be displayed.

"Process data" tab


Information on the medium to be transported is collected here. Many of these attributes are
linked and pass on their information via their connected components.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 165
Base data reference
14.7 Base object "@20 > A30 Functions"

"Graphical options" tab


Information that is evaluated on the P&ID is stored here (e.g. description).

14.7 Base object "@20 > A30 Functions"


In the database, you find the functions below the base object "@20 > A30 Functions".
Objects for measurement functions and actuating functions have been predefined under this
node.
● You can find objects for measurement functions under "@20 > A30 > A10 > A20
Measurement function".
● You can find objects for actuating functions under "@20 > A30 > A10 > A30 Actuating
function".
See also section Base object "@20 > A30 > A10 > A20 Measurement function" and "@20 > A30
> A10 > A30 Actuating function". (Page 167).

14.7.1 Base object "@20 > A30 > A10 > A10 General functions"

Placeholders
When the user creates functions in the engineering project on level A1, these are
"placeholders" of the "measurement function" or "actuating function" function type. A detailed
specification of the function has not yet been drawn up or will not be drawn up. These functions
are described as neutral or general functions. They are replaced by more concrete functions in
I&C planning.

Function code
The functions of this level have no function code. The base object does not change when you
enter function codes.

Process connector
Connecting a wildcard function on a report to the process does not create a process connector.

Creating reports
Various evaluating reports can be created below functions on this and the following level.
Reports are not needed until I&C planning.

P&ID Administration
166 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.7 Base object "@20 > A30 Functions"

14.7.2 Base object "@20 > A30 > A10 > A20 Measurement function" and "@20 > A30 >
A10 > A30 Actuating function".
Functions already have a function type from this level onwards.

"@20 > A30 > A10 > A20 Measurement function"


Path in the database: "@30 > M00 > A60 > A10 > A10 Measurement functions"
The objects are based on DIN 19227.
A measurement function with this base object does not initially have a function code. When it
is placed on the P&ID and connected with the process, it does not receive a process connector
or any new tabs.
If you input a function code, a base object change takes place from this level onwards. If the
function was connected with the process before the function code was input, it gets a process
connector afterwards.
On this level of the unit structure according to KKS you can find a structure that improves the
bundling of the underlying measurement functions.
Levels below "@02 > 030 > 00 > 01 Measurement functions": The specific functions as required
for I&C planning start from this level.

"@20 > A30 > A10 > A30 Actuating function"


This base object is a structure below which the actually creatable actuating functions are
collected.
In the database, there are numerous structures under the functions from this level onwards.
These structures are then made available in the engineering view via the "New" context menu.
However, they are not required until the I&C planning stage and hence are covered in the I&C
section. You can find additional information on this topic in the "EI&C Administration" manual,
keyword "Creating and designing functions".

14.7.3 Scripts
The following scripts have been input at the base object of a function on the "Script" tab:

Connect
Call: when joining the connectors, thus, for example, when connecting the function on the
P&ID.
Task:
Measurement function: Connect only calls function SetCDev from UserScriptBlock1. If a
function is connected to a piece of equipment or a pipe, the process connector is dynamically
created and connected. Thus in this case Connect is also called.
Actuating function: Connect calls ConnectedObjectAsChild. An "DI" connector or a "CS"
connector is created at the function, depending on the context.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 167
Base data reference
14.7 Base object "@20 > A30 Functions"

You can find more information on this topic in the "P&ID Operation" manual, keyword "Process
coupling for measurement function".

DisConnect
Call: When disconnecting two connectors. If you reduce the number of process connectors, the
connectors are separated as well. Thus DisConnect is called as well. Only with measurement
functions.
When the call is made, the "SYS.AutoDeleteFreeConnectors" attribute (type: Boolean, i.e.
checkbox) is queried on P&IDs at measurement functions. If the attribute exists and is set to "1",
measurement function connectors which are not connected or are free are deleted. If you wish
to use the attribute, you must create it yourself.
Task:
DisConnect calls function SetCDev from UserScriptBlock1.

OnEditOk
Call: Whenever "OK" or "Apply" is pressed in the properties window. Only with measurement
functions.
Task:
Measurement function: OnEditOk only calls function SetCDev from UserScriptBlock1.

OnReferencedByDevice
Call: When creating the function and on every change of base object.
Task:
Measurement function: When the function is created, it takes the first letter of the label of the
position and thus becomes a suitable measurement function. If a mask is defined for the label
at the base object, the mask wins out.
Thereafter, SetCDev is called from UserScriptBlock1. The base data can be simplified in
this way: The same neutral functions are always located below the positions and the
appropriate measurement function is created as a result of automatically taking over the label
(and the subsequent change of base object in UserScriptBlock1).
Actuating function: Same as the measurement function, but here the actuating function takes
the first letter from the label of the position and appends a "V".

P&ID Administration
168 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.7 Base object "@20 > A30 Functions"

UserScriptBlock1
This script block sets script variables and implements the SetCDevice function. The script
variables do not necessarily have to be located in UserScriptBlock1.
1. PositionCDevFullName
Automatically generates a position below the P&ID if a function is placed on the P&ID from
the base data. The measurement function lies below the position. In order to put the
mechanism into effect following prerequisites have to be met:
– This function needs to have a valid function letter in the label. If you use the base object
of a very general function in the database, it will not have any function letters. Function
letters are not added to the labels until lower levels. If you use a base object with function
letters (and the other prerequisites are met), then the position is generated at the time the
engineering object is created. If this is a general object you have to enter a function label
at the engineering end. A base object change (pressure, temperature, etc.) takes place
in response to the new function letter and the position is created.
– The function has to have the global variable PositionCDevFullName set in the script.
It does not matter in which script block this global variable was set. The global variable
states which position is used.
2. PositionCDevice
Defines which base object the owner position of the function gets. You can find more
information on this topic in the "P&ID Operation" manual, keyword "Function is created by
placing on the P&ID".
3. SetCDevice:
Only for measurement function:
– Call:
If the label is changed. The entered label is automatically written to the "@40 > A10 > Y00
> A10 > B60 > Y00A00365 Function" object. This attribute is queried in SetCDev.
If the number of process connectors has been changed. The process connectors are
controlled by the CProcess number of process connectors attribute.
– Task: SetCDevice checks whether the base object needs to change and determines
the new base object.
The Variable BaseCDevFullName identifies the base object node under which the
search for the function base object should be carried out.
SetCDevice then passes the label and the number of process connectors to
the SetCDevBySpecs function. SetCDeviceBySpecs evaluates these parameters
and changes the base object if necessary:
First level below the node specified by BaseCDevFullName: depending on the function
code.
Second level: depending on the number of process connectors.

UserScriptBlock2
AddToGraficalParameter: Adds the following attributes to the functions context menu:
● "Y00A03310 Function type"
● "Y00A00305 Output and operation"

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 169
Base data reference
14.11 Base object "@30 > M00 > A50 > A15 > A10 > A10 Vessels and tanks"

14.8 Base object "@20 > A80 > M22 > A10 Script library M22S00001 -
M22S00050"
Base objects whose only purpose is to archive a script are managed in this branch. Therefore,
these base objects have a script block on the "Script" tab but no other settings.

14.9 Base object "@20 > B20 > M20 > A20 Place and dissolve graybox
P&ID"
This engineering task can only be used on P&ID reports and is used in the Modular Configurator
module, among other things. The engineering task is used to place a graybox on a P&ID report
and dissolve the graybox into objects. The typical P&ID automatic processes are used for
dissolving the graybox. When undoing the engineering task, the created objects are completely
removed from the report again.
See chapter Overview for administration of the "Graybox" function (Page 95).

14.10 Base object "@20 > D20 Base objects from external CAE data
imports"
An import from CAE third-party software creates base in COMOS. During the import, COMOS
creates the base data in the branch "@20 > D20 Base objects from external CAE data imports"
in the following node:
● "DGN DGN imports"
See chapter Administering a Microstation import (dgn, pid) (Page 121).
● "DXF DXF imports"
You can find more information on this topic in the "Basic interfaces" manual, keyword
"Importing AutoCAD data".
● "Proteus Proteus imports"
See chapter Configuring Proteus import (Page 141).

14.11 Base object "@30 > M00 > A50 > A15 > A10 > A10 Vessels and tanks"

Elements of the vessel


PFD vessels can have hierarchically subordinate objects such as nozzles. These objects are
created as elements of the vessel.
The base object of the vessel must have a nozzle with the name "NOZZLE" as an element so
that the nozzle can be created automatically on connection. See also chapter Base object
"@10 > A20 > A10 > A10 > A60 > A20 Nozzles and connections" (Page 165).

P&ID Administration
170 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.13 Base object "@30 > M00 > A50 > A15 > A80 Add. graphics and symbol drawing"

Identification of a container
In the database, vessels have the "Position" class and the "Equipment" subclass. You can find
more information on this topic in the "P&ID Operation" manual, keyword "Positions".

Symbols in the style of ISO 10628-2:2012


The P&ID catalog is also available in the style of ISO 10628-2:2012. See chapter Base object
"@30 > M00 > A50 > A15 ... ISO 10628:2012" (Page 174).

14.12 Base object "@30 > M00 > A50 > A15 > A30 Valves"

Valves
The valves are prepared in COMOS so that they can also be used as actuators. The actuators
belong to the actuating functions. You can find more information on this topic in the "P&ID
Operation" manual, keyword "Functions".
In the database, you can use the context menu to supplement the symbol for valves in the
P&ID. You can display flange connectors and map safety positions, for example. To do this, set
the attributes provided in the "UserScriptBlock1" script block. See also chapter Extending the
graphical settings (Page 79).

Symbols in the style of ISO 10628-2:2012


The P&ID catalog is also available in the style of ISO 10628-2:2012. See chapter Base object
"@30 > M00 > A50 > A15 ... ISO 10628:2012" (Page 174).

14.13 Base object "@30 > M00 > A50 > A15 > A80 Add. graphics and
symbol drawing"

14.13.1 Base object "@30 > M00 > A50 > A15 > A80 > A10 Text symbols P&ID"
Objects for pipe flags are prepared below this base object in the database.
Class: "Data set"
These objects create a text flay if they are dragged onto a P&ID. When the text flag is dragged
onto a pipe, it then docks to the pipe and is automatically moved or deleted along with it.
These objects do not create objects in the engineering view but are only found on the P&ID. The
objects of this base object node belong to pipes and must be placed in such a way that a
connector to a pipeline is created.
When you select a flag on the P&ID, the menu for the pipe is offered for selection from the
context menu.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 171
Base data reference
14.13 Base object "@30 > M00 > A50 > A15 > A80 Add. graphics and symbol drawing"

Attributes
"P&ID Options" tab:
● Inheritance source: "@10 > A20 > A10 > A20 > A10 > Y00T00039 Graphical options"
● "Y00T00039.Y00A00952 Graphical mirroring permitted"
Activated: The text flag is turned around if the text flag is connected to a pipe and the flow
direction is changed.
Default = FALSE,
Graphical flags (without text): TRUE
Text flags: FALSE, otherwise there could be errors in the text assignment.
● "Y00T00039.Y00A01620 Automatic rotation permitted"
Activated: The symbol is aligned to the symbol of the pipe. If the pipe is located vertically,
the symbol is also placed vertically, and so forth. The texts within the symbol are rotated
automatically in the appropriate direction.
In this case the manual rotation is disabled. Although the rotation grab is still displayed,
rotation does not have any effect and the flag always jumps back to the direction specified
by the pipe.
Default = FALSE,
Graphical flags (without text): TRUE
Text flags: FALSE, otherwise there could be errors in the text assignment.
● "Y00T00039.Y00A01621 Automatic selection permitted"
Activated: Only takes effect if the text flag is connected to a pipe. When the pipe is selected,
the text flag is automatically selected as well, even if the text flag no longer has any direct
contact with the pipe.
Default = FALSE
Objects that can be selected along with their main object (i.e. their device is selected): TRUE
Text flags (e.g. legends, etc.): FALSE

Text flags without direct contact to the pipe


The text flag can also be torn off after docking onto the pipe. The logical connection is retained
and the text flag continues to output the pipe information.
Alternatively, the text flag can be freely positioned right from the beginning. The flag is then
connected to the pipe as follows:
● Select pipe, "Copy" command from context menu
● Select text flag, "Reference > Connect with" command from context menu

Symbols in the style of ISO 10628-2:2012


The P&ID catalog is also available in the style of ISO 10628-2:2012. See chapter Base object
"@30 > M00 > A50 > A15 ... ISO 10628:2012" (Page 174).

14.13.2 Base object "@30 > M00 > A50 > A15 > A80 > A30 Graphical symbols P&ID"
Class: "Element"
Subclass: "Graphic"

P&ID Administration
172 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.13 Base object "@30 > M00 > A50 > A15 > A80 Add. graphics and symbol drawing"

Objects that are based on these base objects are always created below the P&ID.
They are colored black by default. Later on these objects are not be sorted into one of the
categories that are available under the unit.
The color set on the P&ID can be changed by selecting "Options > Graphical properties" from
the context menu.
Most of the objects from this base object node are placed on pipes. If the symbols touch a pipe,
the pipe turns yellow.
Most of the objects that are created in the engineering view do not have any attributes.
However, some of the objects have connectors and are connected to the pipe with these
connectors when placed on a pipe.
Therefore some of the graphic symbols are introduced below.

Base object "@10 > A20 > A10 > A20 > A10 > A30 > A10 Pipe break"
A pipe break is a symbol for a graphic break.
If you drag the base object onto the pipe, the pipe is interrupted visually and two break symbols
are displayed.
The symbols have two grab points:

The grab point that is located on the arm of the break (figure on the left) scales the break
symbols.
The grab point that is located on the pipe (figure on the right) increases the distance between
the break.
The pipe is retained as a whole in the database, but it is segmented and joined with the
connectors of the pipe break via its connectors.

Base object "@10 > A20 > A10 > A20 > A10 > A30 > A20 Page reference"
A page reference is a symbol that groups connections across pages visually in one place on the
P&ID. This page reference is created manually by the user on P&IDs. You can find more
information on this topic in the "P&ID Operation" manual, keyword "Creating page references
for two pipes".

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 173
Base data reference
14.14 Base object "@30 > M00 > A50 > A15 ... ISO 10628:2012"

Base object "@10 > A20 > A10 > A20 > A10 > A30 > B50 Revision cloud"
A revision cloud is also a purely graphic piece of information. However, unlike the other base
objects below "@10 > A20 > A10 > A20 > A10 > A30 Graphical symbols P&ID", the revision
cloud does not belong to a pipe.
This object has a large number of freely movable grab points that you can use to shape the
"cloud" in such a way that all required objects are included in it visually.
The revision cloud has no effect on the COMOS revision.

Symbols in the style of ISO 10628-2:2012


The P&ID catalog is also available in the style of ISO 10628-2:2012. See chapter Base object
"@30 > M00 > A50 > A15 ... ISO 10628:2012" (Page 174).

14.14 Base object "@30 > M00 > A50 > A15 ... ISO 10628:2012"

Use of ISO 10628:2000 and ISO 10628:2012


The following catalog is prepared in the iDB:
● "@30 > M00 > A50 > A15 P&ID Catalog (in the style of ISO 10628:2012)"
This catalog is preferred in the supplied example database iDB.
The COMOS documentation prefers examples based on ISO 10628:2000. See example:
● Chapter Base object "@30 > M00 > A50 > A15 > A80 > A30 Graphical symbols P&ID"
(Page 172)
● Chapter Base object "@30 > M00 > A50 > A15 > A80 > A10 Text symbols P&ID" (Page 171)
● Chapter Base object "@30 > M00 > A50 > A15 > A30 Valves" (Page 171)
● Chapter Base object "@30 > M00 > A50 > A15 > A10 > A10 Vessels and tanks" (Page 170)
The statements in the COMOS documentation regarding the base objects according to ISO
10628: 2000 also apply to the use of the catalog ISO 10628: 2012. Deviations are documented
separately.

Switching the catalog used on CDevice or Device


" Graphical options" tab, "Version of standard" attribute.

Interaction with the Proteus import


The following attribute is used in the Proteus import:
"Proteus" tab, "Attributes" option group, "Registration number" attribute.
The registration number is stored in this attribute in accordance with the catalog ISO
10628:2012.

P&ID Administration
174 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.16 Standard tables

14.15 Base object "@30 > M00 > A80 > A10 Document library objects acc.
to IEC 61355"
Base objects of the report templates for P&ID. See also section Administering P&ID reports
(Page 65).

14.16 Standard tables


The following table describes the relevant standard tables:

Standard table Description


"Standard tables > Y10 > M22 > A10 > Y10M22N00008 Pipe A connection to a P&ID is represented in the engineering data
cut mode" through a three-level structure. This value controls what hap‐
pens in the engineering data if a component is placed on a
pipe in the P&ID.
You can find additional information on this topic in the "P&ID
Operation" manual, keyword "Pipe cut mode".
"Standard tables > Y10 > M20 > A10 > Y10M20N00006 Pipe: See also chapter DrawPipeEndSymbol (Boolean)
termination symbols" (Page 183).
"Standard tables > Y10 > M00 > A10 > Y10M00N00008 User- Used to manage user-defined line types.
defined line type" You can find additional information on this topic in the
"Administration" manual, keyword
"Line type depending on user, connector or drawing type".
"Standard tables > Y10 > M00 > A10 > Y10M00N00009 For the assignment of user-defined line types to drawing
Drawing type specific line types> types. You can find information on this topic in the "Adminis‐
tration" manual, keyword "Line type depending on user, con‐
nector or drawing type".
"Standard tables > Y10 > M00 > A10 > Y10M00N00020 Con‐ Contains drawing type specific scripts that compare whether
nection symbol (spec break)" two objects that are joined via their connectors match the
attributes specified in the script.
Only the attributes that are linked by their connectors are
evaluated:
The script is automatically evaluated when an object placed
on the P&ID is evaluated. The script is called only once for
each connector pair.
It is implemented for the P&ID module for changes to pipe
classes, nominal pressure and nominal diameter on a P&ID
diagram.
You can find additional information on this topic in the "P&ID
Operation" manual, keyword "Standard pipe flags (Page 82)".

"Standard tables > @40 > Y00 > A10 > B70 > Y00N00390 Standard table for the management of text functions that are
Text selection P&ID" made available in the symbol editor.
"Standard tables > @40 > Y00 > A10 > B50 > Y00N00337 Specifies the line widths of PFD/P&I objects. Pipes also use
Line widths" this entry.
"Standard tables > @40 > Y00 > A10 > B50 > Y00N00338 Specifies the colors of PFD/P&I objects. Pipes also use this
Colors" entry.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 175
Base data reference
14.16 Standard tables

Standard table Description


"Standard tables > @40 > Y00 > A10 > A30 > Y00N00056 Stores symbols for the failure mode. For example, the stand‐
Failure behavior" ard table is assigned to attribute "Y00A00449.Y00A00449
Security position" so that it can be shown on the report as an
additional symbol for the valve.
"Standard tables > Y10 > M20 > A10 > Y10M20N00008 Me‐ A table of line types that are available
dia line types" on the P&IDs.
The system uses this standard table internally. The standard
table contains the example entries. You can add line types to
the standard table: You can delete unused line types.
You can find additional information on this topic in the "Ad‐
ministration" manual, keyword "Y10 Standard tables for line
types".
"Standard tables > @40 > Y00 > A10 > B70 > Y00N00400 Stores symbols for the flanges of valves and pumps. As‐
Flange display valves, pumps" signed to attributes "Y00T00037.Y00A00886AA01 Flange
joint 1", "Y00T00037.Y00A00886AA02 Flange joint 2" etc.,
which can be used to show and hide the flanges of the valve/
pump on the report.
"Standard tables > Y10 > M00 > A10 > Y10M00N00010 Line A list of action line types that are made available in P&I dia‐
types for action lines" grams.
The system accesses this standard table internally. You may
extend but not modify or delete this table.
"Standard tables > @40 > Y00 > A10 > C20 > Y00N00481 Defines the templates for pipe sections and the attribute val‐
Pipe branch ues defined therein for the line type, the line width and the line
color.
"Standard tables > @40 > Y00 > A10 > B80 > Y00N00401 The "%N position" function is used in the script of a symbol for
P&ID measuring position lettering" an P&I measurement device. A search is also performed for
the "PI > TEXTMOD" attribute in the script of the measure‐
ment device on the measurement device. This attribute uses
the standard table "P&ID measuring position lettering". If the
attribute is there, the set value is read and formed in accord‐
ance with the text from "%N" position.
"Standard tables > Y10 > M00 > A10 > Y10M00N00006 Con‐ You can find a standard table under this node information for
nection types" each connection type.
You can find additional information on this topic in the "Ad‐
ministration" manual, keyword "Specifying line types for a
connector".

Hiding values from standard tables


Using the "Obsolete" column, you can hide values from standard tables at attributes of newly
created objects at which the standard table is stored. You can find more information on this
topic in the "PipeSpec Designer" manual, keyword "Inserting the "Obsolete" column in standard
tables",

P&ID Administration
176 Operating Manual, 03/2020 V 10.3.3
Base data reference
14.17 Object classes of P&ID objects

14.17 Object classes of P&ID objects

Classes
● Action
● Unit
● Connector
● Data record
● Document
● Document group
● Element
● Function
● Device
● Device request
● Location
● Position
● Revision

Subclasses
● Equipment
● Blackbox
● Graphic
● Instrumentation
● Category
● Object query
● Pipe
● Nozzles
● Symbol

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 177
Base data reference
14.17 Object classes of P&ID objects

P&ID Administration
178 Operating Manual, 03/2020 V 10.3.3
Reference of script functions for P&ID templates 15
P&IDs are assigned to the PFD application (options script, application = "PFD"). If you have
selected this, specific script functions are available for you to use in the options script.

15.1 AllowMultipleDisplay

Usage
The AllowMultipleDisplay report option is not supported anymore and is only available
for reasons of interface compatibility.

15.2 AllowPrintingForDirectionArrow (Boolean)


TRUE: The blue direction arrow at the connecting lines is printed as well.
FALSE (default): The direction arrow does not appear on the printout.

15.3 AutoConnectGrayboxes
● AutoConnectGrayboxes = True (default value)
Pipes can be separated automatically by components within moved grayboxes.
● AutoConnectGrayboxes = False
Pipes cannot be separated automatically by components within moved grayboxes.

15.4 AutoPlaceTPiece (Integer)


Option for P&ID reports:
● AutoPlaceTPiece = 1
When you draw a branch, the T-piece is always placed automatically.
● AutoPlaceTPiece = 2
The T-piece is never placed automatically.
● AutoPlaceTPiece = 3
The user is asked whether the T-piece should be placed.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 179
Reference of script functions for P&ID templates
15.8 CObjectFullNameForPipe (String)

15.5 CheckAllOpenFunctionConns (Boolean)


TRUE: Each measurement function that does not have a partner is regarded as inconsistent;
this also includes any connections that the user has created but has failed to connect.
FALSE: Measurement function connections are only regarded as inconsistent if they have not
been explicitly disconnected on the report by the user.

15.6 CheckAllOpenPipeConns (Boolean)


TRUE : Each pipe that is not connected at both ends is regarded as inconsistent and shown in
red.
FALSE (default): The pipe remains black.

15.7 CheckPipeCutMode

Core statement
BOOLEAN
Default = False
True: The "Check > Document" additionally recognizes inconsistent structures for the use of
separating components. The pipe cut mode is evaluated. Inconsistent components are colored
red.
False: Only the default checks are carried out.
You can find additional information on this topic in the "P&ID Operation" manual, keyword
"Setting the pipe cut mode".

15.8 CObjectFullNameForPipe (String)


Specifies which base object is used if the "Connection" tool is used on a P&ID or PFD.
Overwrites the setting from the project properties on the "Module options > Process
engineering" tab. The base object that is set in the script is then used in all reports based on the
report template.
Syntax:
"CObjectFullNameForPipe = "Obj.SystemFullName""

Examples:
● For P&IDs:
CObjectFullNameForPipe = "@30|M00|A50|A10|A40|A10|A10"
● For PFDs:
CObjectFullNameForPipe = "@10|A10|A10|A10|A40|A90"

P&ID Administration
180 Operating Manual, 03/2020 V 10.3.3
Reference of script functions for P&ID templates
15.11 CopyPipeConnectionAutoOff

You find more information on this topic in the "P&ID" manual, keywords "Start configurations"
and "Document base objects".

15.9 ConnectorRadius (Double)


Specifies the radius of the connectors.
Default=1

15.10 CopyMainBranch (String)

Use
Use the CopyMainBranch report option to specify how COMOS should behave when a pipe
branch is created. If the report option CopyMainBranch is set, the report
option CopyPipeConnectionAutoOff is ignored.
You can make the following settings (the values have to be specified in quotation marks):
● CopyMainBranch = "Always"
Specifies that the pipe substance data should always be applied to a pipe branch.
● CopyMainBranch = "Never"
Specifies that the pipe substance data should never be applied to a pipe branch. COMOS
inserts a standard pipe for the pipe branch.
● CopyMainBranch = "Ask"
Specifies that the user is able to determine the desired behavior via a dialog when creating
a pipe branch.
You can find additional information on this topic in the "P&ID" manual, keyword
"CopyPipeConnectionAutoOff".

15.11 CopyPipeConnectionAutoOff

Use
The report option CopyPipeConnectionAutoOff is used to specify that the user can select
the behavior of COMOS when creating a a pipe branch using the dialog "Create connection" .
To use the settings of the report option CopyPipeConnectionAutoOff, deactivate the
report option CopyMainBranch or set it to Ask.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 181
Reference of script functions for P&ID templates
15.13 DrawPFDConnsUnderDocumentInBlue (Boolean)

The following settings can be made:


● CopyPipeConnectionAutoOff = False (default)
The "Create connection" dialog is not displayed when a pipe section is created. COMOS
inserts a copy of the pipe as a pipe section.
● CopyPipeConnectionAutoOff = True
When you connect a pipe branch to a pipe, the "Create connection" dialog is displayed.
The user has the following selection options in the "Create connection" dialog.
– "Yes"
Creates a standard pipe. You can specify which one it is in the context menu.
– "None":
As before, a copy is made of the pipe that is connected at the "From" side.
– "Memorize the answer for the current session"
Saves the selected setting for the current COMOS session.

15.12 CreateDefaultPipeSegment (Boolean)


Default = False
Determines whether a newly created pipe section should also be assigned a default pipe
segment automatically.

15.13 DrawPFDConnsUnderDocumentInBlue (Boolean)

Use
In COMOS, you can make a setting so that the objects associated with a P&ID plan are placed
directly below the document in the Navigator.
Use the DrawPFDConnsUnderDocumentInBlue report option to specify whether P&ID
connections should be displayed in blue in the Navigator if these connections are located
directly under the document.
The following settings can be made:
● DrawPFDConnsUnderDocumentInBlue = true
Specifies that the connections should be shown in blue in the Navigator.
● DrawPFDConnsUnderDocumentInBlue = false
Specifies that the connections should not be shown in blue in the Navigator.

P&ID Administration
182 Operating Manual, 03/2020 V 10.3.3
Reference of script functions for P&ID templates
15.17 DrawPipeConnectorSymbol (Boolean)

15.14 DrawPFDDevicesUnderDocumentInBlue (Boolean)

Use
In COMOS, you can make a setting so that the objects associated with a P&ID are placed
directly below the document in the Navigator. By default, these P&ID objects are displayed in
the Navigator in blue.
Use the DrawPFDDevicesUnderDocumentInBlue report option if you want to stop the
objects being shown in blue.
The following settings can be made:
● DrawPFDDevicesUnderDocumentInBlue = true (default)
Specifies that the P&ID objects should be shown in blue in the Navigator.
● DrawPFDDevicesUnderDocumentInBlue = false
Specifies that the P&ID objects should not be shown in blue in the Navigator.

15.15 DrawPipeEndSymbol (Boolean)


Example / Syntax: DrawPipeEndSymbol = True
The default value is FALSE.
Default setting when creating new pipe sections.
● TRUE: The end symbols (e.g. a needle at the input connector or output connector) that are
contained in the standard table "Y10 > M20 > A10 > Y10M20N00006 Pipe: termination
symbols", are output at the newly created pipe section.
● FALSE: The end symbols are not output to the newly created pipe section. However, this
only applies until the user calls the "Show start and end symbol" command from the context
menu to display the symbols for the selected pipe sections again on the document.
The option does not apply to pipe segments or when DrawPipeEndSymbolForSegment
= TRUE is also set.

15.16 DrawPipeEndSymbolForSegment (Boolean)


Example / Syntax: DrawPipeEndSymbolForSegment = True
The default value is FALSE.
Default setting when creating new pipe segments. This is an extension of
DrawPipeEndSymbol and only takes effect if DrawPipeEndSymbol = TRUE .
If the value is TRUE and DrawPipeEndSymbol = TRUE, the end symbols are also displayed
at pipe segments. See also section DrawPipeEndSymbol (Boolean) (Page 183).

15.17 DrawPipeConnectorSymbol (Boolean)


Example / Syntax: DrawPipeConnectorSymbol = True

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 183
Reference of script functions for P&ID templates
15.19 EnableContinueDrawingConnection

The default value is True.


Default setting when creating new pipe segments:
● TRUE: The sheet reference symbol entered in the standard table "Y10 > M20 > A10 >
Y10M20N00010 > Y10M20N00010A02 Sheet reference for pipes, multipage", is displayed
on the newly created pipe segment, and another segment of the same pipe section is placed
on a different document.
● FALSE: The sheet reference symbol is never output at the newly created pipe segment.
However, this only applies to the pipe segments until the user calls the "Page link symbol
visible" command from the context menu to display the symbol again on the document.

15.18 DrawPipeEndSymbolForVertices (Boolean)


TRUE: The end symbol for the "corners" of the pipe is output on the entire report. The
corresponding symbol script is taken from the following standard table:
Base project, "Standard tables > Y10 > M20 > A10 > Y10M20N00006 Pipe: termination
symbols"
Name: 3
Description: Any
Drawing type: M22_* (symbol script)
Value 1: 3
False = Default

15.19 EnableContinueDrawingConnection

Introduction
If the EnableContinueDrawingConnection report option is activated, the user can use the
"Connection" tool to extend a pipe or channel structure.

Procedure
To activate EnableContinueDrawingConnection mode, proceed as follows:
1. Open the report template for the report for which you wish to activate the mode.
2. Right-click on the working area of the report template.
The context menu opens.
3. Select the "Options" command from the context menu.
The "Options" window opens.
4. Find the EnableContinueDrawingConnection entry.
5. Comment in the EnableContinueDrawingConnection report option.
If the value of the option is set to False, change it to True.

P&ID Administration
184 Operating Manual, 03/2020 V 10.3.3
Reference of script functions for P&ID templates
15.21 SetImplementationByConcessionRI (Boolean)

6. Click "OK" to save your input and close the "Options" window.
7. Click "Save" in the report template.

Result
The EnableContinueDrawingConnection report option is activated for all reports which
are based on the selected report template. The next time the user opens a corresponding
report, the mode is available.

15.20 EnableInteractiveEditableTexts
Default = True
● EnableInteractiveEditableTexts = True
You can edit editable texts on a P&ID.
● EnableInteractiveEditableTexts = False
The texts cannot be edited.
For additional information on this topic, refer to the "P&ID" manual, keyword "Lock editable
texts for editing".

15.21 SetImplementationByConcessionRI (Boolean)


TRUE (default): Automatic setting of the implementation pointer for streams, if required.
Requirement: The ConcessionRI = TRUE command has been set beforehand in the options
script.
This method is used in the area of concession documents (acceptance documents).
Background: In the P&ID, all objects are usually placed on exactly one report. If the objects are
placed and connected on a second report, then new connections are generated which
overwrite the connections in the database.
If the ConcessionRI = TRUE option is activated, no connection is made in the database as
a result of the duplicate placement, and the original connection information is thus retained.
To display the relationship between the connectors correctly in the Navigator, an
implementation reference that shows the original connection is generated. Use
SetImplementationByConcessionRI to disable the process for generating this
implementation reference so that nothing is displayed in the Navigator.
The master report is opened for multiplacements while the "ConcessionRI" script option is
being checked.
Background: The "ConcessionRI" script option is no longer valid for databases in which the
"Y00T00001.Y00A04522 Setting of connection logic" attribute has been set at the base object
of the documents. Therefore, no other documents need to be opened to determine the
concession status.

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 185
Reference of script functions for P&ID templates
15.25 StdPipeNoReflect (Boolean)

15.22 SetPipeFlagOnCreate (Boolean)

Note
Dependency of properties of the report
The SetPipeFlagOnCreate option depends on the "Show standard pipe label" attribute in
the "Attributes > Document options" tab of the R&I properties. When the "Show standard pipe
label" option is activated, the option script is automatically set to TRUE.

TRUE: The standard pipe flag is displayed automatically when a pipe is created. This means,
the text script defined at the base object of the pipe section in the "Symbols" tab for the current
drawing type is evaluated and displayed.
FALSE = Default

15.23 SortNewBranchUnderNewPipe (Boolean)

Use
Use the SortNewBranchUnderPipe report option to specify how COMOS should sort new
pipe sections in the Navigator when these are drawn onto an existing pipe.
The following settings can be made:
● SortNewBranchUnderPipe = False (default)
COMOS sorts the new pipe section under the existing pipe in the Navigator.
● SortNewBranchUnderPipe = True
COMOS creates a new pipe structure in the Navigator for the new pipe section.

15.24 StdPipeFlagNoColor (Boolean)


Example / Syntax: StdPipeFlagNoColor = True
This option determines whether or not the standard pipe label adopts the color of the pipe.
Default value: False.
● True: The standard pipe label is black.
● False: The standard pipe label has the same color as the pipe.
See also Administering standard pipe labels (Page 82).

15.25 StdPipeNoReflect (Boolean)


Example / Syntax: StdPipeNoReflect = True
True switches off the mirroring (reflection) of pipe flags at a reversal of flow direction, if the flow
direction in the pipe is changed.

P&ID Administration
186 Operating Manual, 03/2020 V 10.3.3
Reference of script functions for P&ID templates
15.27 SynchronizeStdPipeFlag (Boolean)

The default value is False.

Note
Standard pipe flags
Only applies to standard pipe flags. If you have placed them manually, you can define the
behavior of the flags via the attribute Y00T00039. Y00A00952.

15.26 SynchronizePipeConSymbol (Boolean)


TRUE: The page reference symbol is always aligned in the direction of the pipe (for oblique
pipes, for example).
Changing the script option from FALSE to TRUE for objects that have already been placed can
cause symbols or texts to move due to the resulting transformation.
FALSE = Default

15.27 SynchronizeStdPipeFlag (Boolean)


TRUE: The standard flag is always aligned in the direction of the pipe (in particular for oblique
pipes).
FALSE = Default

P&ID Administration
Operating Manual, 03/2020 V 10.3.3 187
Reference of script functions for P&ID templates
15.27 SynchronizeStdPipeFlag (Boolean)

P&ID Administration
188 Operating Manual, 03/2020 V 10.3.3

You might also like