Publisher 1

PDMS/E3D Engineering
Interface 2
References for PDMS/E3D
Engineering Interface 3
COMOS

COMOS PDMS interface 4

Lifecycle
3D Integration Administration Reference to "COMOS 3D
Viewing" 5
Exporting COMOS pipe
Operating Manual specs to PDMS 6

03/2021 V10.4
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 - 2021.

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

1 Publisher .............................................................................................................................................. 11
2 PDMS/E3D Engineering Interface ........................................................................................................ 13
2.1 Software requirements PDMS/E3D...................................................................................... 13
2.2 Overview of the administration .......................................................................................... 13
2.3 Basic knowledge for PDMS/E3D administrators ................................................................... 15
2.3.1 Implementation types in the multi-user system .................................................................. 15
2.3.2 Shared data ....................................................................................................................... 18
2.3.3 Individually used data ........................................................................................................ 18
2.3.4 Supported communication protocols.................................................................................. 19
2.4 Installing software ............................................................................................................. 20
2.4.1 Overview of the installation modes .................................................................................... 20
2.4.2 Local/client installation ...................................................................................................... 20
2.4.3 Terminal server installation ................................................................................................ 23
2.4.4 Installing a new user (user installation) .............................................................................. 24
2.4.5 Updating to a new COMOS version ..................................................................................... 26
2.4.6 Install in silent mode.......................................................................................................... 27
2.5 Preprocessing in COMOS and PDMS/E3D for coupling.......................................................... 29
2.5.1 Specifying the path to the initialization file ......................................................................... 29
2.5.2 Creating UDAs ................................................................................................................... 30
2.5.3 Entering COMOS PDMS/E3D Engineering Interface as an add-in .......................................... 31
2.5.4 Using your own icons for objects in the 2D workspace ........................................................ 31
2.5.5 Setting up network mode................................................................................................... 32
2.5.5.1 Creating configuration files................................................................................................. 32
2.5.5.2 Editing the initialization file ................................................................................................ 33
2.5.5.3 "ComosPDMSInterfaceNetworkConfig.xml" file.................................................................... 33
2.5.5.4 Editing the network configuration file ................................................................................. 35
2.5.5.5 Establishing network communication ................................................................................. 36
2.5.5.6 Using the Server Directory Service...................................................................................... 36
2.6 Special preprocessing in COMOS ........................................................................................ 67
2.6.1 Overview of the COMOS preprocessing .............................................................................. 67
2.6.2 Objective of the classes and subclasses............................................................................... 68
2.6.3 Minimum configuration of the E3D tab: Create subclass...................................................... 69
2.6.4 Minimum configuration of a subclass in COMOS ................................................................. 71
2.6.5 Assigning a subclass to COMOS objects .............................................................................. 74
2.6.6 Creating folders for definitions with class objects ................................................................ 74
2.6.7 Using consistent pipe engineering...................................................................................... 76
2.6.8 Assigning COMOS projects and PDM/E3D projects............................................................... 76
2.7 Setting up workspaces ....................................................................................................... 77
2.7.1 Defining 2D workspaces ..................................................................................................... 78
2.7.2 Implementing the !!SAGGetScopeID() macro (2D workspace).............................................. 78
2.7.3 Rules for collection and representation of objects in the 2D workspace ............................... 79
2.7.3.1 Collecting TIOs................................................................................................................... 80

3D Integration Administration
Operating Manual, 03/2021 V10.4 3
Table of contents

2.7.3.2 Definition of a 2D workspace for TIOs ................................................................................. 80

2.7.3.3 Rules for the representation of TIOs in the 2D workspace.................................................... 80
2.7.3.4 Representation of TIOs and TL/SL structures in the 2D workspace........................................ 81
2.7.3.5 Definition of a 2D workspace for TL and SL structures ......................................................... 83
2.7.4 Rules for collection and representation of objects in the 3D workspace ............................... 85
2.7.4.1 Independent objects (TIOs) in the 3D workspace ................................................................ 85
2.7.4.2 TL/SL structures (3D workspace)......................................................................................... 86
2.7.4.3 Filtering objects with the "3D workspace filter" option......................................................... 87
2.7.4.4 Representation of TIOs and TL/SL structures in the 3D workspace........................................ 87
2.8 Definitions and terminology for the interface operations..................................................... 88
2.8.1 Technical definition of the interface objects ........................................................................ 88
2.8.2 Tasks of the "Folders for definitions" object ......................................................................... 89
2.8.3 Definitions for classes and subclasses in the iDB.................................................................. 89
2.8.3.1 Class definition objects....................................................................................................... 91
2.8.3.2 Subclass definition objects of "Cables" and "Devices with labels" classes............................... 91
2.8.3.3 Subclass definition objects of the "Queries" class................................................................. 92
2.8.3.4 Subclass definition objects of the "Documents" class ........................................................... 93
2.8.4 Definitions for name mapping ............................................................................................ 94
2.8.4.1 Level rules of name mapping ............................................................................................. 94
2.8.4.2 Structural behavior ............................................................................................................ 95
2.8.5 Definition and tasks of the area pipes ................................................................................. 96
2.8.6 "String parameter" definition .............................................................................................. 97
2.8.7 "Owner restriction rules" definition ..................................................................................... 98
2.8.8 Definition of the model information ................................................................................... 99
2.8.9 "Pre/post executables" definition....................................................................................... 100
2.8.10 "Character mapping" definition......................................................................................... 100
2.8.11 "Unit mapping" definition ................................................................................................. 100
2.8.12 "ZONE mapping" and "SITE mapping" definition ................................................................ 101
2.8.13 Definition of the process log............................................................................................. 101
2.8.14 "Connected objects" definition.......................................................................................... 102
2.9 Configuring interface operations ...................................................................................... 102
2.9.1 Implementing the PML macro !!SAGPickUpQueryResult(!p is STRING)................................ 104
2.9.2 Task-based administration ................................................................................................ 104
2.9.2.1 Performing the basic configuration................................................................................... 105
2.9.2.2 Configuring the use of COMOS queries in PDMS................................................................ 106
2.9.2.3 Configuring the use of pre/post executables ..................................................................... 107
2.9.2.4 Configuring the import of DocLinks .................................................................................. 107
2.9.2.5 Configuring the import of AVEVA templates...................................................................... 107
2.9.3 Administering standard tables for classes and subclasses .................................................. 108
2.9.4 Administering the standard table for PDMS element types ................................................ 110
2.9.5 Note on the "Folders for class/subclass definitions" object.................................................. 111
2.9.6 Configuring the "Folders for class/subclass definitions" object ............................................ 112
2.9.6.1 Note: Reference of "General" tab ...................................................................................... 112
2.9.6.2 Assigning pipe disconnecting equipment ......................................................................... 112
2.9.6.3 Activating operation messages......................................................................................... 113
2.9.6.4 Using the name directory: Defining global variables.......................................................... 113
2.9.6.5 Using pre/post executables............................................................................................... 114
2.9.6.6 Using character mapping ................................................................................................. 116
2.9.6.7 Using unit mapping ......................................................................................................... 116
2.9.6.8 Using ZONE mapping and SITE mapping........................................................................... 117
2.9.7 Creating a class definition object ...................................................................................... 119

3D Integration Administration
4 Operating Manual, 03/2021 V10.4
 Table of contents

2.9.8 Creating subclass definition objects .................................................................................. 120

2.9.9 Configure subclass definition objects of classes "Cable" and "Tagged item" ......................... 121
2.9.9.1 Defining PDMS element types........................................................................................... 121
2.9.9.2 Defining structural behavior ............................................................................................. 121
2.9.9.3 Defining the base object for the creation of interface objects ............................................ 122
2.9.9.4 Automatically inserting additional hierarchy levels............................................................ 123
2.9.9.5 Specifying restriction rules for owners .............................................................................. 125
2.9.9.6 Configuring the model ..................................................................................................... 126
2.9.9.7 COMOS rules ................................................................................................................... 128
2.9.9.8 PDMS/E3D rules ............................................................................................................... 128
2.9.10 Configure 'MTO (PDMS)' class ........................................................................................... 128
2.9.11 Using the "Name directory" tab ........................................................................................ 129
2.9.11.1 Objective of the name directory and the String parameters............................................... 129
2.9.11.2 Opening the "Name directory" tab .................................................................................... 130
2.9.11.3 Structure of a String Parameter......................................................................................... 131
2.9.11.4 Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns ..................................................................................................... 132
2.9.11.5 "Xvalue" column .............................................................................................................. 134
2.9.11.6 "Admin" column: Generate additional control elements .................................................... 134
2.9.11.7 "Check status" column: Configuring a value comparison.................................................... 135
2.9.11.8 "Rule" column: Checking an owner ................................................................................... 135
2.9.11.9 Export application: Export COMOS value to PDMS object .................................................. 136
2.9.11.10 Import application: Import PDMS value into COMOS attribute ........................................... 137
2.9.11.11 Application: Using a nominal diameter ............................................................................. 137
2.9.12 Configuring site mapping and location mapping in name mapping ................................... 138
2.9.12.1 Structure of the tables for unit mapping and location mapping ......................................... 138
2.9.12.2 Mapping for the COMOS PDMS Interface .......................................................................... 140
2.9.12.3 Mapping for the COMOS PDMS Engineering Interface ....................................................... 140
2.9.12.4 Algorithm for generating a PDMS name............................................................................ 140
2.9.12.5 Configuring generation of a PDMS name .......................................................................... 141
2.9.12.6 Algorithm for generating a COMOS object path ................................................................ 144
2.9.12.7 Configuring the generation of a COMOS object path ......................................................... 145
2.9.13 Creating and configuring query subclasses ....................................................................... 146
2.9.13.1 Workflow ......................................................................................................................... 146
2.9.13.2 Creating and configuring query subclasses ....................................................................... 147
2.9.13.3 Creating class and subclass definitions for queries............................................................. 147
2.9.13.4 Configuring a subclass definition object for queries ........................................................... 148
2.9.14 Configuring "Import DocLinks".......................................................................................... 149
2.9.14.1 Defining the entry for the target document in PDMS ......................................................... 149
2.9.14.2 Configuring "Import DocLinks" operation in COMOS.......................................................... 150
2.9.14.3 Defining the String Parameter for the document name...................................................... 150
2.9.14.4 Configuring general settings ............................................................................................ 150
2.9.14.5 Defining owner restriction rules for draft objects .............................................................. 151
2.9.15 Synchronizing classes and subclasses in COMOS and PDMS............................................... 151
2.9.16 Importing classes, subclasses and "Folders for classes/subclasses" object from XML file ...... 152
2.9.17 Importing AVEVA design templates .................................................................................. 153
2.9.18 Configuring COMOS interface objects ............................................................................... 154
2.9.18.1 Assigning the class, subclass, and PDMS element type ...................................................... 154
2.9.18.2 Overwriting the inherited model information ................................................................... 155
2.9.18.3 Attributes of the "External 3D Interface" tab...................................................................... 157
2.10 Using pmlib macros ......................................................................................................... 158
2.10.1 Using pmlib macros ......................................................................................................... 158

3D Integration Administration
Operating Manual, 03/2021 V10.4 5
Table of contents

2.10.2 !!STBCheckStatusIn2DWS ................................................................................................. 159

2.10.3 !!STBGetCurrentIn2DWS ................................................................................................... 160
2.11 Administering Material Management (MTO) with PDMS/E3D............................................. 160
2.11.1 Create object "MTO Class - MTO (PDMS)" .......................................................................... 160
2.11.2 Creating the "Configuration for csv import" class............................................................... 161
2.11.3 Managing a CSV import ................................................................................................... 161
2.11.3.1 Structure of a CSV file....................................................................................................... 161
2.11.3.2 Editing configurations for the CSV import ......................................................................... 163
2.11.3.3 Algorithm for generating a COMOS path name ................................................................. 163
3 References for PDMS/E3D Engineering Interface .............................................................................. 165
3.1 Category "Process engineering > PDMS/E3D Engineering Interface"................................... 165
3.2 Reference to the standard table for PDMS element types .................................................. 165
3.3 Reference to the standard table for classes ....................................................................... 165
3.4 Reference to the standard table for subclasses .................................................................. 165
3.5 Attributes of the "Folders for class/subclass definitions" object........................................... 166
3.5.1 "General" tab ................................................................................................................... 166
3.5.2 "Name directory" tab........................................................................................................ 168
3.5.3 "Pre/post executables" tab ................................................................................................ 168
3.5.4 "Character mapping" tab .................................................................................................. 168
3.5.5 "Unit mapping" tab .......................................................................................................... 169
3.5.6 "SITE mapping" and "ZONE mapping" tabs ........................................................................ 169
3.5.7 "Attributes for global name directory" tab ......................................................................... 169
3.6 "Class - Documents (PDMS) > A01 Document subclasses definition"................................... 169
3.6.1 "General" tab ................................................................................................................... 169
3.6.2 "Owner restriction rules" tab ............................................................................................ 170
3.6.3 "Name directory" tab........................................................................................................ 170
3.7 "Class - Lines (PDMS) > A01 Pipe subclass definition" ......................................................... 171
3.7.1 "General" tab ................................................................................................................... 171
3.7.2 "Name directory" tab........................................................................................................ 172
3.7.3 "Name mapping" tab ........................................................................................................ 172
3.7.4 "Owner restriction rules" tab ............................................................................................ 172
3.7.5 "Model" tab...................................................................................................................... 173
3.8 "Class - Queries (PDMS) > A01 Query subclass definition" .................................................. 174
3.8.1 The "General" tab ............................................................................................................. 174
3.8.2 "Dynamic attributes" tab................................................................................................... 175
3.9 "Class - Devices with Label > A01 Device with subclass labeling definition" ........................ 175
3.9.1 "General" tab ................................................................................................................... 175
3.9.2 "Name directory" tab........................................................................................................ 176
3.9.3 "Name mapping" tab ........................................................................................................ 177
3.9.4 "Owner restriction rules" tab ............................................................................................ 177
3.9.5 "Model" tab...................................................................................................................... 177
3.10 "Class - MTO (PDMS) > A01 Configuration for csv import" .................................................. 178
3.10.1 "General settings" tab....................................................................................................... 178
3.11 Interface objects: "External 3D interface" tab .................................................................... 179
3.12 Design template objects: "External 3D interface" tab ......................................................... 179

3D Integration Administration
6 Operating Manual, 03/2021 V10.4
 Table of contents

3.13 Structure of the initialization file "ComosPDMSInterfaceInitialization.xml" ......................... 180

4 COMOS PDMS interface ..................................................................................................................... 183
4.1 Software requirements COMOS PDMS interface ................................................................ 183
4.2 Activating and deactivating the COMOS PDMS interface ................................................... 183
4.3 Installation ...................................................................................................................... 184
4.3.1 Introduction..................................................................................................................... 184
4.3.2 Installation modes ........................................................................................................... 184
4.3.3 Communication modes .................................................................................................... 184
4.3.4 Local installation.............................................................................................................. 184
4.3.5 Installing on a Citrix server ............................................................................................... 186
4.3.6 Installing on a Citrix client ................................................................................................ 186
4.3.7 Installing on a Citrix client in silent mode ......................................................................... 188
4.3.8 Example text file for installation in silent mode ................................................................. 188
4.3.9 Initialization file ............................................................................................................... 189
4.4 Configuration basics for interface operations .................................................................... 190
4.4.1 Interface objects .............................................................................................................. 190
4.4.2 Classes and subclasses ..................................................................................................... 190
4.4.2.1 Classes and subclasses ..................................................................................................... 190
4.4.2.2 Class definition objects..................................................................................................... 192
4.4.2.3 Subclass definition objects of "Cables" and "Devices with labels" classes............................. 192
4.4.2.4 Subclass definition objects of the "Queries" class............................................................... 193
4.4.2.5 Subclass definition objects of the "Documents" class ......................................................... 193
4.4.2.6 "Folders for class/subclass definitions" object .................................................................... 194
4.4.3 Name mapping ................................................................................................................ 195
4.4.3.1 Name mapping ................................................................................................................ 195
4.4.3.2 Level rules of name mapping ........................................................................................... 195
4.4.3.3 Structural behavior .......................................................................................................... 196
4.4.4 Working with area pipes................................................................................................... 197
4.4.5 String Parameters ............................................................................................................ 197
4.4.6 Restriction rules for owners.............................................................................................. 198
4.4.7 Model information ........................................................................................................... 199
4.4.8 Pre/post executables ........................................................................................................ 200
4.4.9 Character mapping .......................................................................................................... 200
4.4.10 Units mapping ................................................................................................................. 200
4.4.11 ZONE mapping and SITE mapping .................................................................................... 201
4.4.12 Operation messages ........................................................................................................ 201
4.4.13 Connection information ................................................................................................... 202
4.5 Configuring interface operations ...................................................................................... 202
4.5.1 Workflow ......................................................................................................................... 202
4.5.2 Note regarding changes to attribute properties................................................................. 203
4.5.3 Task-based administration ................................................................................................ 204
4.5.3.1 Introduction..................................................................................................................... 204
4.5.3.2 Performing the basic configuration................................................................................... 204
4.5.3.3 Configuring the use of COMOS queries in PDMS................................................................ 206
4.5.3.4 Configuring the use of pre/post executables ..................................................................... 206
4.5.3.5 Configuring the import of DocLinks .................................................................................. 207
4.5.3.6 Configuring the import of AVEVA templates...................................................................... 207
4.5.4 Maintaining the standard table for PDMS element types ................................................... 207
4.5.5 Standard tables for classes and subclasses ........................................................................ 208

3D Integration Administration
Operating Manual, 03/2021 V10.4 7
Table of contents

4.5.6 Creating the "Folders for class/subclass definitions" object ................................................. 208
4.5.7 Configuring the "Folders for class/subclass definitions" object ............................................ 209
4.5.7.1 Activating operation messages......................................................................................... 209
4.5.7.2 Defining global variables .................................................................................................. 209
4.5.7.3 Using pre/post executables............................................................................................... 210
4.5.7.4 Using character mapping ................................................................................................. 211
4.5.7.5 Using unit mapping ......................................................................................................... 212
4.5.7.6 Using ZONE mapping and SITE mapping........................................................................... 213
4.5.8 Creating a class definition object ...................................................................................... 214
4.5.9 Creating subclass definition objects .................................................................................. 214
4.5.10 Configuring the subclass definition objects of the classes "Pipe" and "Equipment" .............. 215
4.5.10.1 Defining PDMS element types........................................................................................... 215
4.5.10.2 Defining structural behavior ............................................................................................. 215
4.5.10.3 Defining the base object for the creation of interface objects ............................................ 216
4.5.10.4 Automatically inserting additional hierarchy levels............................................................ 217
4.5.10.5 Specifying restriction rules for owners .............................................................................. 219
4.5.10.6 Configuring the model ..................................................................................................... 220
4.5.11 Configure 'MTO (PDMS)' class ........................................................................................... 221
4.5.12 Working with string parameters in the name directory...................................................... 222
4.5.12.1 Name directory ................................................................................................................ 222
4.5.12.2 Tasks of the String parameter: .......................................................................................... 222
4.5.12.3 Structure of a String Parameter......................................................................................... 223
4.5.12.4 Configuring String Parameters .......................................................................................... 224
4.5.12.5 Assigning a COMOS value to a variable ............................................................................. 224
4.5.12.6 Assigning a PDMS value to a variable................................................................................ 225
4.5.12.7 Writing a PDMS value to a COMOS attribute (import) ........................................................ 225
4.5.12.8 Writing a COMOS value to a PDMS object (export) ............................................................ 226
4.5.12.9 Generating a component of the name mapping ............................................................... 226
4.5.12.10 Configuring a value comparison ....................................................................................... 227
4.5.12.11 Checking an owner .......................................................................................................... 227
4.5.12.12 Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns ..................................................................................................... 228
4.5.13 Configuring site mapping and location mapping in name mapping ................................... 229
4.5.13.1 Structure of the tables for unit mapping and location mapping ......................................... 229
4.5.13.2 Algorithm for generating a PDMS name............................................................................ 231
4.5.13.3 Configuring generation of a PDMS name .......................................................................... 232
4.5.13.4 Algorithm 1 for generating a COMOS object path ............................................................. 235
4.5.13.5 Algorithm 2 for generating a COMOS object path ............................................................. 236
4.5.13.6 Configuring the generation of a COMOS object path ......................................................... 237
4.5.13.7 Configuring level rules ..................................................................................................... 238
4.5.14 Configuring subclasses for PDMS queries .......................................................................... 238
4.5.14.1 Workflow ......................................................................................................................... 238
4.5.14.2 Creating and configuring query subclasses ....................................................................... 239
4.5.14.3 Creating class and subclass definitions for queries............................................................. 239
4.5.14.4 Configuring a subclass definition object for queries ........................................................... 240
4.5.15 Configuring "Import DocLinks".......................................................................................... 241
4.5.15.1 Defining the entry for the target document in PDMS ......................................................... 241
4.5.15.2 Configuring "Import DocLinks" operation in COMOS.......................................................... 242
4.5.15.3 Defining the String Parameter for the document name...................................................... 242
4.5.15.4 Configuring general settings ............................................................................................ 243
4.5.15.5 Defining owner restriction rules for draft objects .............................................................. 243
4.5.16 Synchronizing classes and subclasses in COMOS and PDMS............................................... 244

3D Integration Administration
8 Operating Manual, 03/2021 V10.4
 Table of contents

4.5.17 Importing classes, subclasses and "Folders for classes/subclasses" object from XML file ...... 244
4.5.18 Importing AVEVA design templates .................................................................................. 245
4.5.19 Configuring COMOS interface objects ............................................................................... 246
4.5.19.1 Assigning the class, subclass, and PDMS element type ...................................................... 246
4.5.19.2 Overwriting the inherited model information ................................................................... 247
5 Reference to "COMOS 3D Viewing" .................................................................................................... 251
6 Exporting COMOS pipe specs to PDMS .............................................................................................. 253
6.1 Overview of the work sequence ....................................................................................... 254
6.2 Administration of pipe spec export................................................................................... 254
6.2.1 Receiving the COMOS template catalog ............................................................................ 254
6.2.2 Exporting the schema of a template catalog from PDMS ................................................... 255
6.2.3 Integrating the schema in the Generic Data Mapper ......................................................... 256
6.2.4 Special features of the PDMS schema ............................................................................... 257
6.2.5 Content and structure of the example mapping definition "Tee mapp"............................... 258
6.2.6 Editing an example mapping definition............................................................................. 263
6.2.7 Configuring PDMS pipe spec export .................................................................................. 265
6.3 Exporting pipe specs ........................................................................................................ 266
6.3.1 Opening "PDMS pipe spec export" .................................................................................... 266
6.3.2 Creating a workpackage file.............................................................................................. 267
6.3.3 Loading workpackage file ................................................................................................. 267
6.3.4 Creating workpackages .................................................................................................... 267
6.3.5 Editing workpackages ...................................................................................................... 267
6.3.6 Exporting workpackages .................................................................................................. 268
6.3.7 Using export preview ....................................................................................................... 268
6.4 Importing COMOS pipe specs to PDMS specs .................................................................... 270

3D Integration Administration
Operating Manual, 03/2021 V10.4 9
Table of contents

3D Integration Administration
10 Operating Manual, 03/2021 V10.4
Publisher 1
AVEVA
PDMS™ and Everything3D™ (E3D) are software products of the AVEVA company and are
hereinafter referred to simply as PDMS or E3D.

Bentley
OpenPlant Modeler is a software product from Bentley® and is hereinafter referred to simply as
OpenPlant Modeler.
You can find additional information on this topic in the "3D Integration Administration" manual,
keyword "Scope of the "3D Integration" solution".

3D Integration Administration
Operating Manual, 03/2021 V10.4 11
Publisher

3D Integration Administration
12 Operating Manual, 03/2021 V10.4
PDMS/E3D Engineering Interface 2
2.1 Software requirements PDMS/E3D

COMOS PDMS/E3D Engineering Interface

General requirements
• PDMS 12.0 and higher
• Releases for E3D:
E3D 1.1
E3D 2.1
E3D 3.1
The methods for installing COMOS PDMS Integration involve file-based or network-based
communication. See also chapter Supported communication protocols (Page 19). Different
software requirements apply depending on which type of communication is used:
• File-based communication
Citrix: up to and including 4.5
• Network-based communication
Citrix: up to and including 7.6

Specification import to COMOS (PDMS/E3D pipe spec import/export)

• PDMS 12.0 and higher
• Releases for E3D:
E3D 1.1
E3D 2.1
E3D 3.1

COMOS PDMS interface

• PDMS 12.0 and higher

2.2 Overview of the administration

Set-up
The set up of the interface in a multi-user system is done in several coordinated phases. A
preceding set-up phase lays the foundation for the implementation in the next set-up phase.
Therefore transition criteria that determine the completion of the phase must be defined for
each phase.

3D Integration Administration
Operating Manual, 03/2021 V10.4 13
PDMS/E3D Engineering Interface
2.2 Overview of the administration

The set-up phases are therefore clearly defined through their transition criteria or targets and the
target of the preceding set-up phase and form a natural structuring of the following chapters.

Set up phase Transition criteria

Basic knowledge for PDMS/E3D administrators You know the difference between individually and centrally used data as
(Page 15) well as the communication modes.
Installing software (Page 20) The data delivered by Siemens is installed at the intended location with the
help of installation routines.
The add-in can be started on the PDMS/E3D page and the COMOS menu is
displayed in the PDMS/E3D main menu.
Preprocessing in COMOS and PDMS/E3D for cou‐ The goal is to establish the communication between the systems. To do
pling (Page 29) this, both systems must look on the same environment, this means shared
date:
• "ComosPDMSInterfaceInitialization.xml" initialization file is adminis‐
tered
• "ComosPDMSInterfaceNetworkConfig.xml" network configuration file is
administered
In the end, users should be able to establish the communication between
the two applications COMOS and PDMS/E3D without any problems.
Special preprocessing in COMOS (Page 67) COMOS objects relevant for the interface should be pre-configured. A tag is
assigned to each configured object
Setting up workspaces (Page 77) After communication setup it is possible for the user to correctly display
workspaces in the add-in in PDMS/E3D.
Configuration of the interface: The users can use the interface in complete accordance with the specifica‐
• Definitions and terminology for the interface tions of the administrator.
operations (Page 88)
• Configuring interface operations (Page 102)

3D Integration Administration
14 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.3 Basic knowledge for PDMS/E3D administrators

2.3 Basic knowledge for PDMS/E3D administrators

2.3.1 Implementation types in the multi-user system

Limitation: "Local implementation" and "Terminal server implementation"

The following types of implementation are available in a multi-user system:
• Local implementation:
– COMOS is installed locally on the computers of the users.
– PDMS/E3D is installed locally on the computers of the users.
– The configuration files are stored in a shared directory.
• Terminal server implementation:
– COMOS is installed on one or more terminal servers and is started by the users as a client
on the computer.
– PDMS/E3D is installed locally on the computer.
– The configuration files are stored in a shared directory.
By using the shared configuration files, each user has access to the same environment and
changes to the configuration become effective for all users. Shared data is stored in the network
so that each interface user can access it. Individually used data is stored locally.

Local implementation in detail and user installation

The first user is set up through the local/client installation. Before the next user is set up, the
first user has to be installed to such an extent that they can at least establish communication
between COMOS and PDMS/E3D without problems or can also display a working area in PDMS/
E3D. See chapter Overview of the administration (Page 13).
When a new user is added, only the data used individually for this user must be installed (red
area). This means a user installation is required in addition to the local installation.
See also chapters Local/client installation (Page 20) and Installing a new user (user installation)
(Page 24).

3D Integration Administration
Operating Manual, 03/2021 V10.4 15
PDMS/E3D Engineering Interface
2.3 Basic knowledge for PDMS/E3D administrators

Terminal server implementation in detail

Any number of Terminal servers that have COMOS installations can be integrated into the
environment. The terminal server installation must be executed on each of these terminal
servers. Shared data can also be stored on a terminal server.
See also chapter Terminal server installation (Page 23).

3D Integration Administration
16 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.3 Basic knowledge for PDMS/E3D administrators

3D Integration Administration
Operating Manual, 03/2021 V10.4 17
PDMS/E3D Engineering Interface
2.3 Basic knowledge for PDMS/E3D administrators

2.3.2 Shared data

Files Description
Initialization file Contains paths that are used by the interface as well as other system set‐
tings. To guarantee that COMOS and PDMS/E3D use the same configura‐
tion, the configuration is saved in an initialization file.
• This initialization file is created during installation of the interface.
See chapter Local/client installation (Page 20).
• COMOS and PDMS/E3D use this file for communication and data ex‐
change during an interface operation.
See chapter Specifying the path to the initialization file (Page 29).
See chapter Structure of the initialization file "ComosPDMSInterfaceIni‐
tialization.xml" (Page 180).
Configuration directory Is created during the installation.
The configuration file is stored here. It should be the directory for shared
data or one of its subdirectories.
Configuration file Is located in the configuration directory and contains the interface config‐
uration that is used for the operations that are called by the user while
working with the interface.
Network configuration file Contains settings that are used for communication in a network.
(only for network communication) • See chapter Editing the network configuration file (Page 35).
PMLLib (macro library) Library supplied by Siemens with PML macros that are required for opera‐
tion of the interface and that must be integrated into the AVEVA environ‐
ment.

2.3.3 Individually used data

Name Description
Working directory Is created during the installation.
One directory for storing temporary data must exist per user on their re‐
spective computer.
Help files Are copied during the installation.
These are stored locally so that the COMOS help files are also available to
users when COMOS itself is not installed locally.
COMOS components Are copied during the installation.
COMOS binary components have to be available in the PDMS/E3D installa‐
tion directory so that the interface can be used. These components are
required to operate the PDMS/E3D side of the interface as an add-in.

3D Integration Administration
18 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.3 Basic knowledge for PDMS/E3D administrators

Name Description
Add-in registration Is performed optionally during the installation.
The add-ins for starting the interface in PDMS/E3D must be registered in the
two files "DesignAddins.xml" and "ParagonAddins.xml".
See also chapter Entering COMOS PDMS/E3D Engineering Interface as an
add-in (Page 31).
E3D menu files Are copied and registered.
For PDMS/E3D installations, COMOS menu files (.uic) for AVEVA E3D and
Catalogue must be available in the E3D installation directory. In addition,
the menu files must be registered in the file "DesignCustomization.xml" or
"ParagonCustomization.xml".

2.3.4 Supported communication protocols

Description of the communication modes

File-based
Files are exchanged between COMOS and PDMS/E3D. This communication only works if both
systems, COMOS and PDMS/E3D, are implemented locally. See also chapter Implementation
types in the multi-user system (Page 15).

TCP/IP-based
Data is transferred over the network. No files are written for the data exchange, only log files are
generated. To keep the work required for configuring network communication to a minimum,
this type of communication should only be used for local operation.
See also chapter Setting up network mode (Page 32).

WCF-based
The data is also transferred via the network, however, communication is established by means
of the Server Directory Service (SDS). It is set up via a supplied installation. WCF Port Sharing
must be activated so that all users exchange data through one port only. This reduces the work
required for networking significantly since all users use the same network configuration file.
Another important advantage is that it is clearly specified for each communication setup which
COMOS instance is communicating with which PDMS/E3D instance. Instances are created every
time COMOS and the interface are started.
The following principle applies: each COMOS instance registers itself in the SDS after the start
of the interface. If a user starts an interface in PDMS/E3D, the SDS is asked for the registered
COMOS instances by the same user. The SDS delivers a list of the COMOS instances registered by
this user, without instances already communicating with another PDMS/E3D instance. Only the
free COMOS instances are thus displayed. By selecting a list entry, the communication to this
COMOS instance that is then occupied is established. The advantage of this method is that the
instances of COMOS and PDMS/E3D can be clearly assigned to each other.
WCF-based communication should always be used when COMOS and/or PDMS/E3D are started
on a terminal server. However, it can also make sense to use this type of communication for local
communication. The usage is also possible in mixed operation, local and terminal server
implementations in a multi-user system.

3D Integration Administration
Operating Manual, 03/2021 V10.4 19
PDMS/E3D Engineering Interface
2.4 Installing software

See also chapter Using the Server Directory Service (Page 36).

Recommendation for the terminal server operation

In terminal server operation, we recommend setting up WCF-based communication in
combination with the Server Directory Service.

2.4 Installing software

2.4.1 Overview of the installation modes

You can start the installation in the COMOS setup browser if the installation routines are
otherwise not available.
The following installation modes are available:
• Full installation
– Local/client installation
Local/client installation (Page 20)
– Terminal server installation
Terminal server installation (Page 23)
• Installing a new user (user installation)
Installing a new user (user installation) (Page 24)
• Updating to a new COMOS version
Updating to a new COMOS version (Page 26)
• Silent mode
Install in silent mode (Page 27)

Sequence of the installation modes

The installation of a multi-user system begins with local/client installation. Next, the remaining
users are added by using the "Install new user" function. If a terminal server is used, the terminal
server installation has to be carried out on each server that is used.

2.4.2 Local/client installation

Requirement
COMOS and PDMS/E3D are already installed.

3D Integration Administration
20 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.4 Installing software

Scheme

/RFDOFOLHQWLQVWDOODWLRQ

6HOHFWLQJWKHLQVWDOODWLRQGLUHFWRU\
30//LE
:RUNLQJGLUHFWRU\
&RQILJXUDWLRQ
8VHU 6SHFLI\LQJGLUHFWRULHVDQGLQVWDOODWLRQ GLUHFWRU\
LQSXWV RSWLRQV
,QVWDOOLQJ30//LE
5HJLVWHULQJ3'06('
DGGLQV
6HOHFWLQJ$9(9$YHUVLRQ
RSWLRQDO

&UHDWLQJWKHLQLWLDOL]DWLRQILOH

,QVWDOOLQJ30//LE
,QVWDOOLQJ30//LE
RSWLRQDO 5HJLVWHULQJ3'06('
DGGLQV

&RS\LQJKHOSILOHV

,QVWDOODWLRQ

&RS\LQJ&2026FRPSRQHQWVDQG
('PHQXILOHV

,QVWDOOLQJ30//LE
5HJLVWHULQJ3'06('DGGLQV
RSWLRQDO 5HJLVWHULQJ3'06('
DGGLQV

5HJLVWHULQJ('PHQXILOHV

Procedure
1. Run the "setup.exe" file.
2. Select the installation mode "Full installation" and then "Local/Client installation".

3D Integration Administration
Operating Manual, 03/2021 V10.4 21
PDMS/E3D Engineering Interface
2.4 Installing software

3. Click "Next".
4. Select the installation directory.
Note
Path of the installation directory
The installation directory name may not contain any blanks. This applies to the entire path.

5. Specify the working directory, configuration directory and PMLLib directory as well as the
following installation options:
– If all PDMS/E3D users use a shared macro library (PMLLib), it only has to be installed during
the first installation.
– The PDMS/E3D add-in can also be registered manually by using the
entry <string>Comos.PDMSInterface.ComosAddin</string> if the
corresponding option is disabled.
6. Click "Next".
7. To start the installation, click "Install".
Note
AVEVA versions
If several AVEVA versions (PDMS or E3D) are installed, you are prompted to select the version
for which you want to carry out this installation.

8. Click "Finish".

Result
• An initialization file has been created and stored in the installation directory.
The initialization file contains the data that was entered during installation.
– See also chapter Shared data (Page 18).
– See also chapter Specifying the path to the initialization file (Page 29).
• The configuration directory and working directory were created.
• The macro library is located in the specified directory if the "Install PMLLib" option was
enabled.
• The help files were copied in parallel to the working directory.
• The current COMOS components for the selected AVEVA version were copied to the
installation directory of the AVEVA version. If a PDMS version was selected, the
corresponding menu files were also copied.
• The add-in for using the interface on the AVEVA side was registered when the "Register PDMS/
E3D add-ins" option was activated.
• The menu files were registered when an E3D version was selected.

3D Integration Administration
22 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.4 Installing software

2.4.3 Terminal server installation

Scheme

7HUPLQDOVHUYHULQVWDOODWLRQ

6HOHFWLQJWKHLQVWDOODWLRQGLUHFWRU\

8VHU
LQSXWV
:RUNLQJGLUHFWRU\
6HOHFWLQJZRUNLQJDQGFRQILJXUDWLRQ
GLUHFWRU\ &RQILJXUDWLRQ
GLUHFWRU\

&UHDWLQJWKHLQVWDOODWLRQGLUHFWRU\

,QVWDOODWLRQ &UHDWLQJWKHLQLWLDOL]DWLRQILOH

&UHDWLQJWKHZRUNLQJDQGFRQILJXUDWLRQ
GLUHFWRU\

Procedure
1. Run the "setup.exe" file.
2. Select the "Full installation" installation mode.
3. Select the "Terminal Server Installation" option.
4. Select the installation directory.
Note
Path of the installation directory
The installation directory name may not contain any blanks. This applies to the entire path.

5. Specify the working directory and the configuration directory.

6. Click "Install" to start the installation.
7. Click "Finish".

3D Integration Administration
Operating Manual, 03/2021 V10.4 23
PDMS/E3D Engineering Interface
2.4 Installing software

Result
• An initialization file has been created and stored in the installation directory.
• The configuration directory and the working directory have been created.

2.4.4 Installing a new user (user installation)

Requirement
• The interface has already been installed for a different user as a local/client installation.
See chapter Local/client installation (Page 20).
• Shared data is available and you can access it.
See chapter Shared data (Page 18).

3D Integration Administration
24 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.4 Installing software

Scheme

8VHULQVWDOODWLRQ

,QLWLDOL]DWLRQILOH
/RFDOL]LQJWKHLQLWLDOL]DWLRQILOH
5HJLVWHULQJ3'06('
DGGLQV

8VHU 6HOHFWLQJ$9(9$YHUVLRQ
LQSXWV RSWLRQDO

&UHDWLQJZRUNLQJGLUHFWRU\

&RS\LQJKHOSILOHV

&RS\LQJ&2026FRPSRQHQWVDQG
('PHQXILOHV

,QVWDOODWLRQ

5HJLVWHULQJ3'06('DGGLQV
RSWLRQDO

5HJLVWHULQJ('PHQXILOHV

Procedure
1. Run the "setup.exe" file.
2. Select the "Install new user (user installation)" installation mode.
3. Select the directory and the name of the initialization file.
4. Click "Install" to start the installation.
Note
AVEVA versions
If multiple AVEVA versions (PDMS or E3D) are installed, you must select the version for which
the installation is to be executed.

5. Click "Finish".

3D Integration Administration
Operating Manual, 03/2021 V10.4 25
PDMS/E3D Engineering Interface
2.4 Installing software

Result
• The working directory has been created.
• The help files were copied in parallel to the working directory.
• The current COMOS components for the selected AVEVA version were copied to the
installation directory of the AVEVA version. If an E3D version was selected, the corresponding
menu files were also copied.
• The add-in for using the interface of the AVEVA side was registered when the corresponding
option was selected.
• The menu files were registered when an E3D version was selected.

2.4.5 Updating to a new COMOS version

Requirement
• The interface has already been installed for the current user.
See chapter Local/client installation (Page 20).
See chapter Installing a new user (user installation) (Page 24).

Scheme

8SGDWLQJWRDQHZ&2026YHUVLRQ

30//LE
6SHFLILQJSDWKWR30//LE
DQGVHOHFWLQJLQVWDOODWLRQRSWLRQV ,QVWDOOLQJ30//LE

8VHU
LQSXWV

6HOHFWLQJ$9(9$YHUVLRQ 30//LE
RSWLRQDO
,QVWDOOLQJ30//LE

,QVWDOODWLRQ &RS\LQJ&2026FRPSRQHQWVDQG ,QVWDOOLQJ30//LE

('PHQXILOHV

&RS\LQJ&2026FRPSRQHQWVDQG
('PHQXILOHV

3D Integration Administration
26 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.4 Installing software

Procedure
1. Run the "setup.exe" file.
2. Select the option "Modify program".
3. Specify whether the macro library (PMLLib) is to be copied and specify the storage location.
Note
Sharing a macro library
If all PDMS/E3D users use a shared macro library, it only has to be installed during one
installation.

4. Enter the path to the initialization file See chapter Specifying the path to the initialization file
(Page 29).
5. Click "Install" to start the installation.
Note
AVEVA versions
If multiple AVEVA versions (PDMS or E3D) are installed, you must select the version for which
the installation is to be executed.

6. Click "Finish".

Result
• The PMLLib has been copied to the specified directory, if the "Install MLLib" option was
activated.
• The help files were copied in parallel to the working directory.
• The current COMOS components for the selected AVEVA version were copied to the
installation directory of the AVEVA version. If an E3D version was selected, the corresponding
menu files were also copied.

2.4.6 Install in silent mode

Installation in silent mode runs in the background and is controlled by a text file in which the
administrator has entered all of the relevant information in advance. You do not need to make
any further entries during installation.
The installation is available for the following variants:
• Local/client installation
• User installation

Content of the control file

<?xml version="1.0" encoding="UTF-8"?>
<COMOSPDMS_Installation>
<InstallationFolder path=""/>

3D Integration Administration
Operating Manual, 03/2021 V10.4 27
PDMS/E3D Engineering Interface
2.4 Installing software

<WorkingFolder path="" />

<ConfigurationFolder path="" />
<PMLLibFolder path="" install="{0,1}" />
<PDMSInstallationFolder path="" register="{0,1}" />
<PDMSVersion version="" />
<InstallMode value="{1,2}"/>
</COMOSPDMS_Installation>

Folder/file Actions
InstallationFolder Here you specify the installation directory.
The initialization file is stored in this directory.
WorkingFolder Here you specify the working directory.
ConfigurationFolder Here you specify the location at which the interface
configuration is stored.
PMLLibFolder Here you specify the directory in which the PMLLib
is to be stored when the value "install=1".
install=1: The PMLLib is copied.
install=0: The PMLLib is not copied.
PDMSInstallationFolder Here you specify where the PDMS or E3D version is
installed for which you want to use the interface.
You can use "register" to control whether the CO‐
MOS add-in is to be registered for Design (PDMS),
Model (E3D) and Paragon:
register=0: Do not register
register=1: Register.
PDMSVersion Here you specify the PDMS or E3D version for
which you want to use the interface.
InstallMode Here you define the installation mode in which the
interface is to be installed:
value=1: Local/client installation
value=2: User installation

Requirement
COMOS and PDMS/E3D are already installed.

Procedure
1. Start the setup with the following parameters:
<Path to setup.exe>\setup.exe /s /v"/qn CONFIGFILE=<Path to
control file>\<Name of control file> LOGFILE=<Path to log file>
\<Name of log file>.txt"
2. Check in the log file whether the installation was successful.

3D Integration Administration
28 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Result
The installation executes the same steps as the local/client installation. See also chapter Local/
client installation (Page 20).

2.5 Preprocessing in COMOS and PDMS/E3D for coupling

2.5.1 Specifying the path to the initialization file

Requirement
• You are familiar with the function of the initialization file.
See chapter Shared data (Page 18).

Specifying the path to the initialization file in COMOS

1. Select the "Process engineering > PDMS/E3D Engineering Interface" category in the project
properties.
See also chapter Category "Process engineering > PDMS/E3D Engineering Interface"
(Page 165).
2. Click the "..." button of the "Initialization file" field.
3. In the file explorer, select the initialization file that was created automatically during
installation with your information.
Default: "ComosPDMSInterfaceInitialization.xml"

Specifying the path to the initialization file in PDMS

1. Specify the file location for the initialization file in the environment
variables COMOSPDMSINTERFACECONFIGURATION in PDMS/E3D.
2. Define the environment variable as follows:
set COMOSPDMSINTERFACECONFIGURATION=<path>/<name of ini file>

See also
Structure of the initialization file "ComosPDMSInterfaceInitialization.xml" (Page 180)

3D Integration Administration
Operating Manual, 03/2021 V10.4 29
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

2.5.2 Creating UDAs

In order to use the interface UDAs must be generated in PDMS/E3D that contain the following
information about the COMOS object:
• Connection status
• Configuration information
• Connection information

List of the required UDAs

The following UDAs must be available in PDMS/E3D:
• ":ComosUID"
Contains the SystemUID of the corresponding COMOS object.
• ":ComosCRefNo"
Corresponds to the RefNo of the PDMS object.
• ":ComosStatus"
Saves the object status.
• ":ComosName"
Is the label of the corresponding COMOS object.
• ":ComosBaseOb"
Saves the SystemFullName of the base object of the corresponding COMOS object. During an
"Export to Comos" operation, this base object is used to create the corresponding COMOS
object.
• ":ComosSClass"
The name of the subclass to which this object belongs.

Create the UDAs

Create the UDAs in a project-related dictionary database. If no appropriate database is available,
create the database with the help of the "!!!FCreateDictDB" macro. The following parameters
must be passed to this macro in the form of a string:
• "MDB": Name of the MDB
• "TEAM": Name of the TEAM
• "DictDB": Name of the to be created database
• "DBNumber": Database number (must be specified by the administrator)
This macro does not create an MDB, but a TEAM, insofar this is necessary. Once the database has
been created, the macro sets this. If you do not create the database with the macro, set the
specified dictionary database to currently active to subsequently create the UDAs in the Lexicon
module.
Once you have switched to the Lexicon module, create the UDAs with the !!ITSetComosUDAs
macro underneath the UWRL.

3D Integration Administration
30 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

UDAs created by default

UDAs are created by default for the following types:
• EQUI
• PIPE
• BRAN
• NOZZ
• ALLP
• SCOM
• SPCO
If you want to use additional types with the interface you can add them later.

2.5.3 Entering COMOS PDMS/E3D Engineering Interface as an add-in

The COMOS PDMS/E3D Engineering Interface is started as an add-in on the PDMS/E3D side. This
add-in must be registered in PDMS/E3D.

Procedure
1. In the PDMS/E3D installation directory, open the "DesignAddins.xml" file.
2. Enter the following node in the XML file:
<string>Comos.PDMSInterface.ComosAddin</string>

Result
You can open the COMOS PDMS/E3D Engineering Interface. You can find additional information
on this topic in the "3D Integration Operation" manual, keyword "Opening the COMOS PDMS/
E3D Engineering Interface".

2.5.4 Using your own icons for objects in the 2D workspace

You can define your own icons if you do not want to use the standard icons in the 2D workspace.

Procedure
1. Open the exchange directory.
You can see the exchange directory path in the project properties in the tab "PDMS/E3D
Engineering Interface".
2. Navigate to the "Icons" folder. It is in the file directory in the folder "config" along with the file
"Subclasses.xml". Create it if it does not exist.
3. Add graphics to the folder "Icons". The files must have the same name as the PDMS type of the
object for which the icon is to be displayed.

3D Integration Administration
Operating Manual, 03/2021 V10.4 31
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

2.5.5 Setting up network mode

As of Citrix 6.0, there may be some long waiting with file-based communication between client
and server. To avoid these wait times, you can set up network communication as an alternative.
You can use network communication for the COMOS PDMS/E3D engineering interface.

Note
Protecting configuration files from changes
Make sure that users cannot edit or delete the configuration files.

Requirements
• See chapter Software requirements PDMS/E3D (Page 13).
• COMOS PDMS Integration is installed on the Citrix client and Citrix Server.

2.5.5.1 Creating configuration files

Procedure
1. Open the following file in the command line:
"<PDMS installation directory>\bin\PDMSInterfaceIniFileGeneration.exe"
2. Use the following call parameters:
PDMSInterfaceIniFileGeneration.exe <installation directory> network <working directory>
<configuration directory> <server address>

Example
PDMSInterfaceIniFileGeneration.exe C:\PDMSInterface\ network C:\PDMSInterface\Work\
C:\PDMSInterface\Config\ 127.0.0.1

Result
The following files are created.
• In the installation directory: "ComosPDMSInterfaceInitialization.xml"
See also section Structure of the initialization file "ComosPDMSInterfaceInitialization.xml"
(Page 180).
• In configuration directory: "ComosPDMSInterfaceNetworkConfig.xml"
Edit the configuration files.
• See section Editing the initialization file (Page 33).
• See section Editing the network configuration file (Page 35).

3D Integration Administration
32 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

2.5.5.2 Editing the initialization file

You have the following options to adapt the initialization file for network mode:
• You replace your existing initialization file with the newly created initialization file. See also
chapter Creating configuration files (Page 32).
• You copy the lines required for network mode to your existing initialization file.
To copy the required lines to your initialization file, follow these steps:

Procedure
1. Open the "ComosPDMSInterfaceInitialization.xml" file in the PDMS/E3D installation directory.
2. Insert the following lines:
<NetworkConfigFile path="<PDMS installation directory>\Config
\ComosPDMSInterfaceNetworkConfig.xml" />
<UseNetworkCommunication value="True" />

Configuration parameters Description

UseNetworkCommunication "True": Network communication is used
"False": Network communication is not used
NetworkConfigFile Path to the configuration file "ComosPDMSInter‐
faceNetworkConfig.xml" that includes the details
for setting up network communication and the
user port mappings.
This parameter can remain empty
if UseNetworkCommunication has the value
"False".

Note
Do not delete existing XML elements of the initialization file
The CommunicationFolder, ExchangeFolder and SubclassesFile directories will
continue to be used by the interface in network mode as well. Do not delete this information.

See also
Editing the network configuration file (Page 35)
Structure of the initialization file "ComosPDMSInterfaceInitialization.xml" (Page 180)

2.5.5.3 "ComosPDMSInterfaceNetworkConfig.xml" file

You configure the network connections in the "ComosPDMSInterfaceNetworkConfig.xml" file.
The file has the same structure on the server and client sides. Some attributes are interpreted
differently.
<ComosPDMSInterfaceNetworkConfiguration>
<!-- HostAddress is local address on server, remote address on
client -->

3D Integration Administration
Operating Manual, 03/2021 V10.4 33
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

<!-- ConnectionTimeout and PingInterval values are in milliseconds

-->
<Connection HostAddress="127.0.0.1" ConnectionTimeout="3000"
PingInterval="30000" MaxPingsToDisconnect="4"/>
<Users>
<!-- Port is local port on server, remote port on client -->
<!-- Example: -->
<!-- <User ComosName="ComosUser1" PDMSName="PDMSUser1"
Port="12345"/> -->
</Users>
</ComosPDMSInterfaceNetworkConfiguration>

Explanation
"Connection" node
• "HostAddress" attribute:
On the client (PDMS/E3D): Local host or IP address of a network adapter of the client.
On the server (COMOS): Local host or IP address of the network adapter to be used. If there
is only one network adapter, the attribute on the server can remain empty.
• "ConnectionTimeout" attribute:
Time interval in milliseconds in which the client tries to establish a connection to the server.
Once this time has expired, the attempt to establish a connection is canceled.
• "PingInterval" attribute:
The value specifies the time interval in seconds that passes between two pings.
• "MaxPingsToDisconnect" attribute:
Maximum number of pings without answer after which the network connection is
interrupted.
• Attribute "ConnectionType"
Values:
– "TCP": Network communication via TCP/IP
– "WCF": Network communication via WCF
If the attribute is missing, WCF is enabled by default.
• Attribute "PortSharingEnabled"
– "False": A single port must be defined for each user. If you are using TCP/IP, you must select
the value "False".
– "True": Multiple users can share a port. Use "True" if you use the Server Directory Service.
"Users" node

3D Integration Administration
34 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

This node must include a "User" subnode for each COMOS user and PDMS/E3D user who is to use
the interface via the network. You can specify as many users as you like as long as you assign a
separate network port to each user.
• "User" node: These entries assign each user of the interface a network port of the server via
which network communication is to take place.
Note
Separate port for each user
Assign a separate port for each user. A port may be assigned multiple times only if it is
ensured that the assigned users will not work in parallel and be connected to the server
simultaneously.
Exception: If you work with the Server Directory Service, multiple users can share a port.

• "ComosName" attribute:
User name of the user in COMOS
• "PDMSName" attribute:
User name of the user in PDMS/E3D.
• "Port" attribute:
The network port that is assigned to the user on the server.

2.5.5.4 Editing the network configuration file

Depending on the number of network adapters, you need one or more network configuration
files for server and clients. If you have several network adapters, use the HostAddress to select
at the server end which network adapter of the server is to be used.

Requirement
You have created the "ComosPDMSInterfaceNetworkConfig.xml" file. See also chapter Creating
configuration files (Page 32).

Procedure
1. Open the "ComosPDMSInterfaceNetworkConfig.xml" file.
2. Optional: Change the HostAddress.
3. Create a "User" node for each user of the interface.
See also chapter "ComosPDMSInterfaceNetworkConfig.xml" file (Page 33).
4. Enter the following in the "Connection" node:
Type="TCP"
5. Store the file in the directory that you have specified in the following node in the initialization
file:
<NetworkConfigFile>

3D Integration Administration
Operating Manual, 03/2021 V10.4 35
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

2.5.5.5 Establishing network communication

Requirement
You have performed the previously described steps:
• Creating configuration files (Page 32)
• Editing the initialization file (Page 33)
• Editing the network configuration file (Page 35)
• "ComosPDMSInterfaceNetworkConfig.xml" file (Page 33)

Procedure
To establish the connection, you have to first open the interface at the COMOS end.

2.5.5.6 Using the Server Directory Service

The "Server Directory Service" (SDS) is a service that manages communication between COMOS
and PDMS/E3D and is based on WCF.
The SDS can coordinate the communication within a network, between several networks, or in
a Citrix environment. You can install the SDS on a server or on a separate computer. You specify
the IP address and the port for the SDS in the network communication files that COMOS and
PDMS/E3D access.
All the COMOS instances register themselves on the SDS. Their physical location is irrelevant.
They may be physically located on several computers or on the same computer.
When a user starts PDMS/E3D, the SDS checks which COMOS instances have registered
themselves and are available for this user. All the COMOS instances with which the PDMS/E3D
user may connect are offered for selection. When the user selects an instance, the SDS
establishes the connection between the two applications.

Terminology
• Server Directory Service (SDS)
• Server and client
The terms "server" and "client" are considered from two different points of view in the context
of the Server Directory Service.
– Physical point of view
From a physical point of view, the term "server" means a computer in a network.
Example: A Citrix server from which COMOS is started by several users. The started
COMOS instances are the COMOS clients.
– Logical point of view:
In the case of communication between COMOS and PDMS/E3D via the "PDMS/E3D
Engineering Interface", each COMOS instance is regarded as a server. PDMS/E3D is a client
of COMOS.
The term "Server" in "Server Directory Service" refers to the logical point of view.

3D Integration Administration
36 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

WCF
Terminology: WCF = Windows Communication Foundation
WCF is a framework by Microsoft. Additional information is available on the Microsoft website.
If you are working in network mode with TCP/IP, data is transmitted unencrypted by default. In
order to increase data security, use WCF. You can expand and configure the security concepts
provided by WCF.
WCF enables the following:
• Authentication between client and server
• Encryption of the data transmission

Installing the Server Directory Service

Install the Server Directory Service on a computer that can be accessed from all the computers
that are to communicate with each other. You can install the service independent of COMOS.
If you work in more than one network, install the SDS in the network in which the COMOS
instances are opened.

Procedure
1. Start the COMOS installation wizard.
2. Select "Setup language: German" or "Setup language: English". Click "Next".
3. Read the note and click "Next".
4. Click "Next".
5. Mark the option "I accept the terms of the license agreement. I confirm that I have read and
understood the security information." and click "Next".
6. Select the setup type "Install". Click "Next".
7. In the component overview under "COMOS Main" select the "Directory Service" checkbox.
Click "Next".
8. When you are ready to start the installation, click "Install".

Starting the Server Directory Service

Requirement
You have installed SDS. See also chapter Installing the Server Directory Service (Page 37).

Procedure
1. Open "Control Panel > Administrative Tools > Services".
2. Search for "Comos.MessageSystem.ServerDirectoryService".
3. Open the properties.

3D Integration Administration
Operating Manual, 03/2021 V10.4 37
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

4. In the "Start type" list, select the entry "Manual" or "Automatic".

If you select "Automatic", the service starts automatically when you restart the computer.
5. Click the "Start" button.

Setting the port and host of the SDS

If you do not specify a host address or a port for the Server Directory Service, the following is
used by default:
• Host address: Localhost
The SDS can be accessed through all network adapters of the host system.
• Port: 8884
You have several options for specifying a different host address or a different port.

Option 1: Creating an exe.config fie

1. Create a file called "Comos.External.Communication.ServerDirectoryService.exe.config".
The file has to be located parallel to the following
file: "Comos.External.Communication.ServerDirectoryService.exe"
See also Configuring .NET programs (https://msdn.microsoft.com/en-us/library/
aa374182(v=vs.85).aspx).
2. Add the following content:
Example:
<configuration>
<appSettings>
<add key="TcpHost" value="<IP address|localhost>"/>
<add key="TcpPort" value="<Port number>"/>
</appSettings>
</configuration>

Option 2: Specifying start parameters

You can set the parameters for the host and port in the properties dialog of the service.
1. Open "Control Panel > Administrative Tools > Services".
2. Search for "Comos.MessageSystem.ServerDirectoryService".
3. Open the properties.
4. Enter the host and port in the "Start parameter" field of the "General" tab.
Example:
-tcphost localhost -tcpport 8000

Option 3: Editing the registry

You can specify the parameters for the host and port in the registry.
1. Under "HKEY_LOCAL_MACHINE", create a "SOFTWARE\INNOTEC\COMOS
\ServerDirectoryService" node.
2. Create a TcpHost value of the type string.

3D Integration Administration
38 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

3. Specify the host address.

4. Create a TcpPort value of the type dword.
5. Specify the port.

Activating Portsharing
Activate port sharing if several COMOS instances are to be started on the same computer
together with the PDMS/E3D engineering interface and you do not want to specify a single port
for each COMOS user or Windows user.
For example it makes sense to use port sharing if COMOS is started on a Citrix server.

Procedure
1. Enable the .NET WCF port sharing service on the computer on which COMOS is installed. See
also Enabling .Net TCP Port Sharing Service (https://msdn.microsoft.com/en-us/library/
ms733925(v=vs.110).aspx).
2. By default, only system and network accounts have access to the .NET WCF port sharing
service. However, if you use the SDS, all the COMOS users must have access. Assign the
access rights.
Additional information about the configuration of the .NET WCF port sharing service:
• See also Configuring the Net.TCP Port Sharing Service (https://msdn.microsoft.com/en-us/
library/aa702669(v=vs.110).aspx).
• See also Well-known SIDs (https://msdn.microsoft.com/en-us/library/windows/desktop/
aa379649(v=vs.85).aspx).

Result
Port sharing is activated at the operating system end. You also need to activate it in the network
configuration file that COMOS accesses. See also chapter Preparing the network configuration
file for working with the SDS (Page 40).

Enable use of the SDS for the engineering interface

In order to use SDS when you open the COMOS PDMS Engineering Interface, you have to edit the
configuration files.

Procedure
1. In the installation directory of the COMOS PDMS Engineering Interface, open the
"ComosPDMSInterfaceConfiguration.xml" initialization file.
The installation directory can always be found under the name "PDMSInterface".
2. Enter the following:
<UseNetworkCommunication value="True"/>
<NetworkConfigFile path="<path to the file "ComosPDMSInterfaceNetworkConfig.xml>"/>
You can find the file in the installation directory of the COMOS PDMS Engineering Interface.

3D Integration Administration
Operating Manual, 03/2021 V10.4 39
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

3. Ensure that all computers that are to communicate with each other via the SDS have access
to the following files:
– "ComosPDMSInterfaceConfiguration.xml"
– "ComosPDMSInterfaceNetworkConfig.xml"
4. Ensure that the path to the following file is specified in the "Initialization file" field for the
"PDMS/E3D Engineering Interface" category in the COMOS project properties:
"ComosPDMSInterfaceConfiguration.xml"

Preparing the network configuration file for working with the SDS
Depending on how you structure the network configuration file, you use a common network
configuration file or different network configuration files for servers (COMOS) and clients (PDMS/
E3D).
If you use the SDS, the network configuration files have the following structure:

3D Integration Administration
40 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ!

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)3RUW6KDULQJ(QDEOHG WUXH! 

8VHUV!
8VHU&RPRV1DPH  3'061DPH  3RUW ! 
8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ! 
6HUYHU'LUHFWRU\6HUYLFHV!

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ!

① "Connection" node
COMOS and PDMS/E3D use the specifications in this node in the following cases:
• If no SDS was configured
• If the SDS does not respond or is not configured correctly
• If no COMOS instance with which the PDMS/E3D can connect is found via the SDS
• If it is not possible to establish a connection to a COMOS instance that you have selected via
the SDS
If one of these cases occurs, the connection between COMOS and PDMS/E3D is established with‐
out the support of SDS. The connection is then established via the specifications in the "Connec‐
tion" and "Users" nodes.

Possible values for HostAddress:

• "localhost"
– In the network configuration file of COMOS:
COMOS is accessible for PDMS/E3D via all the network adapters of the computer on which
it is installed.
– In the network configuration file of PDMS/E3D:
PDMS/E3D connects to a COMOS instance that is installed on the same computer and has
been started.
• IP address
– Effects in the network configuration file of COMOS:
If you specify the IP address of a network adapter of the computer, COMOS can only be
accessed via this network adapter by PDMS/E3D.
– Effects in the network configuration file of PDMS/E3D:
PDMS/E3D connects to a COMOS instance that can be accessed under the specified IP
address.
Recommendation: Enter "localhost" as the HostAddress.
In order to use port sharing, the value in the attribute "PortSharingEnabled" has to have the value
"True".

3D Integration Administration
Operating Manual, 03/2021 V10.4 41
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

② "Users" node
• If you use port sharing, the attributes "ComosName" and "PDMSName" must have the place‐
holder "*" as their value.
• "Port" attribute:
The value determines the port through which PDMS/E3D and COMOS connect. These speci‐
fications have to match in the network configuration file for COMOS and PDMS/E3D.
This value is used both when you use the SDS and when communication via the SDS does not
work and the specifications in the "Connection" node are used instead.
③ "ServerDirectoryServices" node
You can create a child node "ServerDirectoryService" for each SDS that is to be used. As a rule, you
use only one SDS.
Possible values of the "Address" attribute:
• "localhost:8884"
– Effects in the network configuration file for COMOS:
COMOS instances log on at the SDS that is installed locally.
– Effects in the network configuration file for PDMS/E3D:
PDMS/E3D asks for available COMOS instances at the locally installed SDS. As a rule, the
SDS is not installed on the same computer as PDMS/E3D.
• IP address
– In the network configuration file for COMOS:
Specify an IP address if you have assigned a specific network adapter of the computer to the
SDS or if the SDS is installed on a different computer than COMOS.
– In the network configuration file for PDMS/E3D:
As a rule, the SDS is installed on a different computer than PDMS/E3D. You then specify the
IP address of the computer on which the SDS is installed.

Requirement
You have carried out the pre-settings in the network configuration file. See also chapter Enable
use of the SDS for the engineering interface (Page 39).

Procedure
1. Open the network communication file "ComosPDMSInterfaceNetworkConfig.xml".
2. Optional: In order to use port sharing add the following attribute to the <Connection> node:
PortSharingEnabled="true"
Activate the port sharing service. See also Chapter Activating Portsharing (Page 39).
3. Optional: If communication between PDMS/E3D and COMOS is to take place via TCP/IP, add
the following attribute to the <Connection> node: Type="TCP"
In this case, the network configuration files have to be configured in accordance with the
default network communication. A separate port is assigned under each user. See also
chapter "ComosPDMSInterfaceNetworkConfig.xml" file (Page 33).
Possible values for "Type":
– "TCP"
– "WCF"
If the "Type" attribute does not exist, communication takes place via WCF by default.

3D Integration Administration
42 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

4. Enter one of the following values in the "HostAddress" attribute:

– "localhost"
– IP address of a network adapter or of a different computer
5. Enter the IP address and port of the SDS so that PDMS/E3D can query for available COMOS
instances at the SDS.
<ServerDirectoryServices>
<ServerDirectoryService Address="<Localhost or IP
address:8884>"/>
</ServerDirectoryServices>
6. Enter the following in the <User> node to enable communication regardless of the user
name:
– PDMSName="*"
– ComosName="*"
7. Enter the port through which COMOS and PDMS/E3D are to communicate with each other in
the <User> node.

Example
<ComosPDMSInterfaceNetworkConfiguration>
<Connection HostAddress="localhost" Type"WCF"
PortSharingEnabled="true"/>
<Users>
<User Port="2700" PDMSName="*" ComosName="*"/>
</Users>

<ServerDirectoryServices>
<ServerDirectoryService Address="localhost:8884"/>
</ServerDirectoryServices>

</ComosPDMSInterfaceNetworkConfiguration>

Work environment variants

You can enable communication via the SDS in different working environment variants:
• In one network
See also chapter Working in a network (Page 44).
• In multiple networks
See also chapter Working in multiple networks (Page 52).
• Via Citrix
See also chapter Working via Citrix (Page 53).

3D Integration Administration
Operating Manual, 03/2021 V10.4 43
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Depending on the work environment variant, PDMS/E3D users have access to COMOS instances
started by them or to instances started by other users. You can define detailed access in the
network configuration file and the WCF security options.
In all the following examples, it is assumed that you have not changed the default values for host
and port. See also chapter Setting the port and host of the SDS (Page 38).

Working in a network

Example 1: A COMOS server

With this simplified representation, the SDS is installed on a server on which COMOS is installed.
PDMS/E3D is installed in the same network on another computer.
The "ComosPDMSInterfaceNetworkConfig.xml" network configuration file that is used by both
applications is located in a shared directory.
The file includes the following specifications:
• Host address="localhost"
If the SDS cannot establish a connection between a COMOS client and PDMS/E3D, PDMS/E3D
connects to a locally installed COMOS. This COMOS is not shown in the following graphic.
• Address="<IP address of the computer on which the SDS is installed>:8884"
– All COMOS clients of the COMOS server log on at the SDS via this address.
– All the PDMS/E3D instances query for free COMOS instances via this address at the SDS.

3D Integration Administration
44 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

&2026VHUYHU 3'06('

6HUYHU'LUHFWRU\
6HUYLFH

&2026VHUYHUDFFHVVHVILOH 3'06('DFFHVVHVILOH

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV /RFDOKRVW3RUW6KDULQJ(QDEOHG 7UXH!

8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV!
6HUYHU'LUHFWRU\6HUYLFHV!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV!!
6HUYHU'LUHFWRU\6HUYLFHV!

If the Engineering Interface is started in COMOS and PDMS/E3D, both applications connect with
the SDS. The COMOS instance is offered for selection to the PDMS/E3D user. Once selected by the
user, the SDS makes the connection between COMOS and PDMS/E3D.
If several COMOS instances exist, all of them are offered to the PDMS/E3D user for selection.

Example 2: Server with multiple network adapters

If you have multiple network adapters on a server and a COMOS server or SDS should only be
accessible via one network adapter, specify the network adapter based on its IP address.
In this example, one network adapter exists for the Intranet and one for the Internet. COMOS and
PDMS/E3D are to communicate via the Intranet.
"HostAddress" attribute:
• If you specify the IP address of the network adapter on the server COMOS side in the
"HostAddress" attribute, COMOS can only be accessed via this network adapter by PDMS/E3D
in the case of a connection without use of the SDS.
• If you specify the IP address of the network adapter on the PDMS/E3D side in the
"HostAddress" attribute, PDMS/E3D connects with a COMOS client of the COMOS servers that
can be accessed under this network adapter.

3D Integration Administration
Operating Manual, 03/2021 V10.4 45
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

6HUYHU
1HWZRUNDGDSWHUV


&2026 ,QWHUQHW
3'06('

6HUYHU'LUHFWRU\  3'06('

6HUYLFH ,QWUDQHW

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO &RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV 7\SH :&) &RQQHFWLRQ+RVW$GGUHVV 7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH! 3RUW6KDULQJ(QDEOHG WUXH!

8VHUV! 8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  ! 8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV! 8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV! 6HUYHU'LUHFWRU\6HUYLFHV!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ORFDOKRVW!! 6HUYHU'LUHFWRU\6HUYLFH$GGUHVV !!
6HUYHU'LUHFWRU\6HUYLFHV! 6HUYHU'LUHFWRU\6HUYLFHV!

"Address" attribute:
• If you specify the value "localhost" on the COMOS side in the "Address" attribute, all COMOS
clients of the COMOS server log on at the SDS that is installed on the same computer as the
COMOS server.
• If you specify the IP address of the network adapter on the PDMS/E3D side in the "Address"
attribute, PDMS/E3D connects with the SDS that can be accessed under this network adapter.

3D Integration Administration
46 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

6HUYHU
1HWZRUNDGDSWHUV


&2026 ,QWHUQHW
3'06('

6HUYHU'LUHFWRU\  3'06('

6HUYLFH ,QWUDQHW

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO &RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV 7\SH :&) &RQQHFWLRQ+RVW$GGUHVV 7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH! 3RUW6KDULQJ(QDEOHG WUXH!

8VHUV! 8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  ! 8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV! 8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV! 6HUYHU'LUHFWRU\6HUYLFHV!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ORFDOKRVW!! 6HUYHU'LUHFWRU\6HUYLFH$GGUHVV !!
6HUYHU'LUHFWRU\6HUYLFHV! 6HUYHU'LUHFWRU\6HUYLFHV!

All the COMOS clients that are derived from the COMOS server that logged on to SDS are offered
to the PDMS/E3D user to establish a connection.

Example 3: Multiple server, multiple SDS (local host)

You can also install the SDS on multiple servers. Depending on the configuration, all the servers
can use the same network configuration file.

Network configuration file at the server end (COMOS)

If you specify the following settings, you can use a single network configuration file for all
servers:
• In the "Connection" node: HostAddress="localhost"
• In the "ServerDirectoryService" node: Adress="localhost:8884"
If you specify the value "localhost" in the "Address" attribute, every COMOS client of the
COMOS server only registers at the SDS on the same server. If a PDMS/E3D user is connected
with one of the SDSs, the user sees only those COMOS clients that have registered at this SDS.
COMOS instances that have registered at other SDSs are not offered to the PDMS/E3D user.

3D Integration Administration
Operating Manual, 03/2021 V10.4 47
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

6HUYHU
&2026

6HUYHU'LUHFWRU\
6HUYLFH

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH!
8VHUV!
6HUYHU
8VHU3RUW &RPRV1DPH  3'061DPH  !
&2026
8VHUV!
6HUYHU'LUHFWRU\ 6HUYHU'LUHFWRU\6HUYLFHV!
6HUYLFH 6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ORFDOKRVW!
6HUYHU'LUHFWRU\6HUYLFHV!

6HUYHU
&2026

6HUYHU'LUHFWRU\
6HUYLFH

3D Integration Administration
48 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Network configuration files at the client end (PDMS/E3D)

Each PDMS/E3D network configuration file contains the IP addresses of the SDSs at which this
PDMS/E3D instance is to ask for free COMOS clients.

6HYHUDO1HWZRUN&RQILJILOHVDWWKH3'06HQG

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH!
8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV! 3'06
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV6HUYHU!!
6HUYHU'LUHFWRU\6HUYLFHV!

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH!
8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV! 3'06
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV6HUYHU!!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV6HUYHU!!
6HUYHU'LUHFWRU\6HUYLFHV!

&RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH!
8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV!

6HUYHU'LUHFWRU\6HUYLFHV! 3'06
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV6HUYHU!!
6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3DGGUHVV6HUYHU!!
6HUYHU'LUHFWRU\6HUYLFHV!

3D Integration Administration
Operating Manual, 03/2021 V10.4 49
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Result

8VHU$

&OLHQW
&2026
6HUYHU
&2026
8VHU%
6HUYHU'LUHFWRU\
6HUYLFH
&OLHQW
8VHU$
&2026

8VHU% 3'06('

&OLHQW
6HUYHU &2026
&2026
8VHU&
6HUYHU'LUHFWRU\ 8VHU$
6HUYLFH

&OLHQW 3'06('
&2026

8VHU&
8VHU%

6HUYHU &OLHQW
&2026 &2026 3'06('
6HUYHU'LUHFWRU\
6HUYLFH
8VHU%

&OLHQW
&2026

Server 1
• User A and User B open a COMOS instance on Server 1.
• Both COMOS instances log on at the local SDS (Server Directory Service 1) with the port 8884.
Reason: The following is specified for the SDS in the network configuration file of Server 1:
Adress="localhost:8884"
• User A opens PDMS/E3D.
• PDMS/E3D asks Server Directory Service 1 which COMOS instances are available.
Reason: The following is specified in the network configuration file of PDMS/E3D 1:
Adress=<IP address Server 1>:8884"
• All the COMOS instances of Server 1 are offered to User A for a connection.

3D Integration Administration
50 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Server 2:
• Similar principle.
• User C is offered all COMOS instances of Server 1 and Server 2 because the SDSs of both
servers are specified in the network configuration file of this user's PDMS/E3D installation.
Server 3:
• Similar principle.

Example 4: Several servers, 1 SDS

If a single SDS is to be used by several servers, address the SDS via the IP address of the computer
on which it is installed. Since the address is persistent, you can use the network configuration
file for all the servers and clients (PDMS/E3D) with the following settings:

8VHU
6HUYHU
3'06('
&2026

6HUYHU'LUHFWRU\
6HUYLFH &RPRV3'06,QWHUIDFH1HWZRUN&RQILJXUDWLRQ[PO

&RQQHFWLRQ+RVW$GGUHVV ORFDOKRVW7\SH :&)

3RUW6KDULQJ(QDEOHG WUXH!
8VHUV!
8VHU3RUW &RPRV1DPH  3'061DPH  !
8VHUV!
6HUYHU'LUHFWRU\6HUYLFHV!
6HUYHU 6HUYHU'LUHFWRU\6HUYLFH$GGUHVV ,3$GGUHVV6HUYHU!!
&2026 6HUYHU'LUHFWRU\6HUYLFHV!

6HUYHU
8VHU
&2026
3'06('

Example:
• One COMOS client is started on Server 1
• Two COMOS clients are started on Server 2
• One COMOS client is started on Server 3
All COMOS clients log on to the SDS. If User 1 or User 2 start PDMS/E3D, all four logged-on
COMOS clients are offered for a connection.

3D Integration Administration
Operating Manual, 03/2021 V10.4 51
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

User 1 chooses that he wishes to connect to the client of Server 1. The connection is established.
User 1 opens a second PDMS/E3D instance. The client already assigned is no longer offered for
a connection. User 1 selects a connection to a client of Server 2. The connection is established.
User 2: Analog to User 1

8VHU
6HUYHU
 3'06('
&2026
 8VHU &RPSXWHU
8VHU &RPSXWHU
8VHU 6HUYHU
6HUYHU'LUHFWRU\ 8VHU 6HUYHU
6HUYLFH 8VHU 6HUYHU
8VHU 6HUYHU
8VHU 6HUYHU
8VHU 6HUYHU


6HUYHU 8VHU &RPSXWHU
&2026
8VHU 6HUYHU
8VHU 6HUYHU

6HUYHU
8VHU
&2026
3'06('

① List of all connections that the SDS has established

② List of all connections on the computer of User 1
③ List of all connections on the computer of User 2

Working in multiple networks

Note
If you work in different networks, the Server Directory Service must be hosted on a computer in
the network in which the PDMS/E3D instances are located.
Specify one or more hosts of the Server Directory Service in the
"ComosPDMSInterfaceNetworkConfig.xml" file.

3D Integration Administration
52 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Requirement
You have started the SDS on a computer in the network in which the PDMS/E3D instances are
located.

Procedure
Edit the network configuration files that COMOS accesses. See chapter Preparing the network
configuration file for working with the SDS (Page 40).
Edit the network configuration files that PDMS/E3D accesses. See chapter Working in a network
(Page 44).

Example
The local address (192.168.1.41) of the Citrix server from Network A is resolved to the external
address (142.138.1.5) in Network B.
(This external address is registered in the Server Directory Service. When a PDMS/E3D instance
from Network A attempts to connect to a COMOS client, the connection is established via the
external address.)

1HWZRUN$ 1HWZRUN%

&LWUL[&OLHQW 6HUYHU'LUHFWRU\
6HUYLFH
([WHUQDODGGUHVV /RFDODGGUHVV
&LWUL[6HUYHU  
&2026
/RFDODGGUHVV
 ([WHUQDODGGUHVV

3'06('

• COMOS network configuration file:

– HostAddress="192.168.1.41" (local address of the Citrix machine in network A)
– Address="126.128.1.53 : 8884" (External address of the SDS)
• Network configuration file of PDMS/E3D:
– HostAddress="142.138.1.5" (external address of the Citrix computer in network A that
can be reached from network B)
– Address="192.168.1.21 : 8884" (Local address of the SDS)

Working via Citrix

The way communication works via Citrix and the structure of the network communication files
is the same as that for communication in a network. See also chapter Working in a network
(Page 44).

3D Integration Administration
Operating Manual, 03/2021 V10.4 53
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Only difference: When working via Citrix, PDMS/E3D users are only offered such COMOS
instances for connection that have been started from the same computer as PDMS/E3D.

Procedure
Edit the network configuration files which COMOS and PDMS/E3D access. See chapter Preparing
the network configuration file for working with the SDS (Page 40).

3D Integration Administration
54 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Example
Initial situation: The constellation and content of network communication files correspond to
those described for working in a network. See Chapter Example 3: Multiple server, multiple SDS
(local host) (Page 47).
• Access options for working in a network:
Users may connect to all the COMOS clients whose COMOS server logs into the same SDS at
which PDMS/E3D also requests.

8VHU$

&OLHQW
&2026
6HUYHU
&2026
8VHU%
6HUYHU'LUHFWRU\
6HUYLFH
&OLHQW
8VHU$
&2026

8VHU% 3'06('

&OLHQW
6HUYHU &2026
&2026
8VHU&
6HUYHU'LUHFWRU\ 8VHU$
6HUYLFH

&OLHQW 3'06('
&2026

8VHU&
8VHU%

6HUYHU &OLHQW
&2026 &2026 3'06('
6HUYHU'LUHFWRU\
6HUYLFH
8VHU%

&OLHQW
&2026

• Access options for working via Citrix:

For the purposes of clarity, User C was excluded here.
– User A may connect to the COMOS clients of Server 1 in accordance with the
configuration.
– User B may connect to the COMOS clients of Server 2 and 3 in accordance with the
configuration.

3D Integration Administration
Operating Manual, 03/2021 V10.4 55
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

However, since PDMS/E3D may only connect with COMOS clients that were started by the
same user in a Citrix environment, only the corresponding clients are offered to User A and
B for a connection. The clients offered are highlighted in color.

8VHU$

&LWUL[&OLHQW
&2026
&LWUL[6HUYHU
&2026
8VHU%
6HUYHU'LUHFWRU\
6HUYLFH
&LWUL[&OLHQW
8VHU$
&2026

8VHU% 3'06('

&LWUL[&OLHQW
&LWUL[6HUYHU &2026
&2026

6HUYHU'LUHFWRU\ 8VHU$
6HUYLFH

&LWUL[&OLHQW
&2026

8VHU&
8VHU%

&LWUL[6HUYHU &LWUL[&OLHQW
&2026 &2026 3'06('
6HUYHU'LUHFWRU\
6HUYLFH
8VHU%

&LWUL[&OLHQW
&2026

3D Integration Administration
56 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

WCF security options

Operation without security options

If you do not make any security settings, data is still encrypted during transmission by standard
WCF functionality.
• If you do not make any settings for the authorization, any authenticated PDMS/E3D instance
in the same domain can connect to the server on which COMOS is started.
• If PDMS/E3D and the server are located in different domains and a trust status does not exist
between the domains, COMOS and PDMS/E3D cannot connect.
• If PDMS/E3D and the server are located in different domains and a trust status exists between
the domains, COMOS and PDMS/E3D can connect, if no special settings with regard to the
authorization were carried out.

Overview of WCF security options

By default the following security option is preset for the SDS:
• WithoutGroupBasedAuthorization
User groups are not checked.
You can use the following security options for the SDS and for communication between COMOS
and PDMS/E3D:
• ServiceClientUserMustMatchServiceHostUser
If this option is set, COMOS and PDMS/E3D have to be started under the same Windows user
account, so that a connection can be established between PDMS/E3D and COMOS.
• ManualWindowsClientCredentialEntry
Displays a window in which users must enter their logon information when PDMS/E3D is
started. The manually entered access data are used for identification toward the server / SDS.
• GroupBasedAuthorization
Configures the host of the SDS in such a way that Windows user groups are used for
authorization.
• TransportBasedWindowsAuthentification
The Windows authentication is carried out once when the connection is established.
• MessageBasedWindowsAuthentification
The Windows authentication is carried out on the message level. It is carried out every time
when a message is sent between COMOS and PDMS/E3D.

Combining security options

If the following security options are used together, PDMS/E3D can only connect to the COMOS
instance if the COMOS has been started with the same user access as PDMS/E3D.
• ServiceClientUserMustMatchServiceHostUser
• One of the following options:
– TransportBasedWindowsAuthentification (better performance)
– MessageBasedWindowsAuthentification (secure data exchange)

3D Integration Administration
Operating Manual, 03/2021 V10.4 57
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

If you use the following security settings, the user is prompted at the PDMS/E3Dside to enter a
user name and a password when the connection is established between PDMS/E3D and COMOS.
The connection is only established if the user enters the same access data as when starting
COMOS. The access data can differ from those used when starting PDM/E3D.
• ServiceClientUserMustMatchServiceHostUser
• ManualWindowsClientCredentialEntry
• TransportBasedWindowsAuthentification

Specifying WCF security options for the SDS

Note
Security options for SDS COMOS and PDMS/E3D have to agree
If you use security options, the security options for the SDS, COMOS and PDMS/E3D have to
agree.

You can specify the security options for the SDS in different ways.
See also Chapter WCF security options (Page 57).

As the start parameter of the SDS

Example:
-tcphost localhost –tcpport 8000 –wcfsecurityoptions
"TransportBasedWindowsAuthentification|
ServiceClientUserMustMatchServiceHostUser|GroupBasedAuthorization"

In a file in the format "exe.config"

If you have created an "exe.config" file, you can specify the security options directly in this file.
See also Chapter Setting the port and host of the SDS (Page 38).

Note
Protecting configuration files against changes
All the configuration files that contain security settings have to be secured by the Administrator
against unauthorized changes.

Example:
<configuration>
<appSettings>
<add key="TcpHost" value="localhost"/>
<add key="TcpPort" value="8000"/>
<add key="WcfSecurityOptions"

3D Integration Administration
58 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

value="TransportBasedWindowsAuthentification|
ServiceClientUserMustMatchServiceHostUser|
ManualWindowsClientCredentialEntry"/>
</appSettings>
</configuration>

In the registry
1. Create a "SOFTWARE\INNOTEC\COMOS\ServerDirectoryService" node under
HKEY_LOCAL_MACHINE.
2. Create a "WcfServiceOptions" value of the type string.
3. Specify the security options. Separate the security options with "|".

In a service configuration file

See Chapter Specify the security settings for communication with the SDS via the service
configuration file (Page 60).

Specifying WCF security options for COMOS and PDM/E3D client

Note
Security options for SDS COMOS and PDMS/E3D have to agree
If you use security options, the security options for the SDS, COMOS and PDMS/E3D have to
agree.

Note
Protecting configuration files against changes
All the configuration files that contain security settings have to be secured by the Administrator
against unauthorized changes.

You can specify the security options for COMOS and PDMS/E3D in different ways.
See also Chapter WCF security options (Page 57).

In the network configuration files

1. Open the "ComosPDMSInterfaceNetworkConfig.xml" file which PDMS/E3D accesses.
2. In a "WcfSecurityOptions" attribute of the <Connection> node, specify which WCF security
options should be used. You can specify a combination of the security options. See
Chapter WCF security options (Page 57).

3D Integration Administration
Operating Manual, 03/2021 V10.4 59
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

3. Separate the security options with "|".

Example:
<Connection Type="WCF" HostAddress="127.0.0.1"
WcfSecurityOptions="TransportBasedWindowsAuthentification|
ServiceClientUserMustMatchServiceHostUser|
ManualWindowsClientCredentialEntry"
/>
4. If you use different network configuration files: Open the
"ComosPDMSInterfaceNetworkConfig.xml" file which COMOS accesses.
5. Proceed analogously.

In a service configuration file

See also chapter Specify the security settings for communication between COMOS and PDMS/
E3D via configuration file (Page 62).
You reference the file in the network configuration file.

Specify the security settings for communication with the SDS via the service configuration file
Alternatively to the options described you can specify the security options in a service
configuration file. The file allows you to define security settings more finely than with the security
options described here by means of WCF default means. See also Chapter WCF security options
(Page 57).
• File name: Any
• File format: .config

Content of the file

The file shown here does not contain any security settings. It serves as the basis for your work
and can be extended with security-relevant entries.
The file must contain at least the following information:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<system.serviceModel>
<bindings>
<netTcpBinding>
<binding
name="MessageSystem.ServerDirectoryService.Binding"/>
</netTcpBinding>
</bindings>
<services>
<service name="MessageSystem.ServerDirectoryService">

3D Integration Administration
60 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

<endpoint
address="Comos.External.Communication.ServerDirectoryService"
binding="netTcpBinding"
bindingConfiguration="MessageSystem.ServerDirectoryService.Binding"

contract="Comos.External.Communication.Services.IServerDirectory"/>
</service>
</services>
<client>
<endpoint
name="MessageSystem.ServerDirectoryService.EndPoint"

address="Comos.External.Communication.ServerDirectoryService"
binding="netTcpBinding"

bindingConfiguration="MessageSystem.ServerDirectoryService.Binding"

contract="Comos.External.Communication.Services.IServerDirectory"/>
</client>
</system.serviceModel>
</configuration>

Editing a service configuration file

The processing of service configuration files is WCF-specific. A documentation of this topic is
available on the Microsoft website:
• See Configuring services with configuration files (https://msdn.microsoft.com/en-us/library/
ms733932(v=vs.110).aspx).
• See WCF Security Fundamentals (https://msdn.microsoft.com/en-us/library/ff649233.aspx).
The following information must be included:
• <netTcpBinding> node
• Service name: "MessageSystem.ServerDirectoryService"
• Client endpoint configuration name: "MessageSystem.ServerDirectoryService.Endpoint"
• Relative endpoint address: "Comos.External.Communication.ServerDirectoryService"
• Contract name: "Comos.External.Communication.Services.IServerDirectory"

3D Integration Administration
Operating Manual, 03/2021 V10.4 61
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Integrating the service configuration file

• Option 1: If you have created an "exe.config" file, you can integrate the service configuration
file there.
Example:
<configuration>
<appSettings>
<add key="TcpHost" value="localhost"/>
<add key="TcpPort" value="8000"/>
<add key="WcfServiceConfigurationFile"
value="ServerDirectoryService.config"/>
</appSettings>
</configuration>
See also Chapter Setting the port and host of the SDS (Page 38).
• Option 2: Including as a start parameter
Example:
-tcphost localhost –tcpport 8000 –wcfserviceconfigurationfile
ServerDirectoryService.config
See also Chapter Setting the port and host of the SDS (Page 38).
• Option 3: Including in the registry
– Under "HKEY_LOCAL_MACHINE", create a "SOFTWARE\INNOTEC\COMOS
\ServerDirectoryService" node.
– Create a "WcfServiceConfigurationFile" value of the string type.
– Enter the path to the service configuration file.

Specify the security settings for communication between COMOS and PDMS/E3D via configuration
file
Alternatively to the options described you can specify the security options in a service
configuration file. The file allows you to define security settings more finely than with the security
options described here by means of WCF default means. See also Chapter WCF security options
(Page 57).
• File name: any
• File format: .config

Content of the file

The file shown here does not contain any security settings. It serves as the basis for your work
and can be extended with security-relevant entries.
The file must contain at least the following information:
<configuration>
<system.serviceModel>
<bindings>

<netTcpBinding>

3D Integration Administration
62 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

<binding name="MessageSystem.MessengerService.Binding"
maxReceivedMessageSize="2147483647">
<readerQuotas maxStringContentLength="2147483647"/>
</binding>
</netTcpBinding>

</bindings>
<services>
<service name="MessageSystem.MessengerService">
<endpoint
address="Comos.External.Communication.MessageSystemWcf"
binding="netTcpBinding"

bindingConfiguration="MessageSystem.MessengerService.Binding"

contract="Comos.External.Communication.Services.IMessenger"/>
</service>
</services>
<client>
<endpoint name="MessageSystem.MessengerService.EndPoint"
address=
"Comos.External.Communication.MessageSystemWcf"
binding="netTcpBinding"
bindingConfiguration="MessageSystem.MessengerService.Binding"

contract="Comos.External.Communication.Services.IMessenger"/>
</client>
</system.serviceModel>
</configuration>

Editing a service configuration file

The processing of service configuration files is WCF-specific. A documentation of this topic is
available on the Microsoft website:
• See Configuring services with configuration files (https://msdn.microsoft.com/en-us/library/
ms733932(v=vs.110).aspx).
• See WCF Security Fundamentals (https://msdn.microsoft.com/en-us/library/ff649233.aspx).

3D Integration Administration
Operating Manual, 03/2021 V10.4 63
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

The following information must be included:

• <netTcpBinding> node
Maximum message and string size: "2147483647"
This is the maximum value that can be represented as a signed 32-bit integer
• Service name: "MessageSystem.MessengerService"
• Client endpoint configuration name: "MessageSystem.MessengerService.Endpoint"
• Relative endpoint address: "Comos.External.Communication.MessageSystemWcf"
• Contract name: "Comos.External.Communication.Services.IMessenger"

Integrating the configuration file

1. Open the "ComosPDMSInterfaceNetworkConfig.xml" file.
2. In a "WcfServiceConfigurationFile" attribute in the <Connection> node, enter the path to the
file.
Example:
<Connection Type="WCF" HostAddress="127.0.0.1"
WcfServiceConfigurationFile="MessengerService.config"/>

Extending the configuration files for SDS

When you define the security settings for communication via configuration files, you have to
extend the configuration files.

Note
The configuration files cannot be used without the extensions.

Affected chapter:
Specify the security settings for communication with the SDS via the service configuration file
(Page 60)
Specify the security settings for communication between COMOS and PDMS/E3D via
configuration file (Page 62)

3D Integration Administration
64 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Extensions:
• "receieveTimeout" attribute in the "binding" element
Example: <receiveTimeout="1.00:00:00">
You can change the value.
If a PDMS/E3D instance does not send a query to COMOS within the period specified here, the
connection is disconnected automatically.
Example: If a user starts PDMS/E3D and connects to COMOS, the connection is disconnected
automatically if the user does not carry out any action in the interface within the specified
period.
If you do not define the security options via configuration files, the timeout amounts to 1 day.
• "reliableSesssion" element
<reliableSession enabled="true"/>
The element "reliableSession" activates a reliable connection session.
Note
Do not change the "true" value
The value of the "reliableSession" element must always be "true".
If you do not define the security options via configuration files, a reliable connection session
is activated by default.

Example of the netTcpBinding element in the configuration file for COMOS and PDMS/E3D with
the specified extensions:
<netTcpBinding>
<binding name="MessageSystem.MessengerService.Binding"
maxReceivedMessageSize="2147483647"
receiveTimeout="1.00:00:00">
<readerQuotas maxStringContentLength="2147483647"/>
</binding>
<reliableSession enabled="true"/>
</netTcpBinding>

Example of the netTcpBinding element in the configuration file for the SDS with the specified
extensions:
<netTcpBinding>
<binding name="MessageSystem.ServerDirectoryService.Binding"
receiveTimeout="1.00:00:00"/>
<reliableSession enabled="true"/>
</netTcpBinding>

3D Integration Administration
Operating Manual, 03/2021 V10.4 65
PDMS/E3D Engineering Interface
2.5 Preprocessing in COMOS and PDMS/E3D for coupling

Using user groups

Use user groups to ensure that only certain users have access to the SDS.

Procedure
1. Create a Windows user group for users who are to use the SDS.
The name of the user group must be "Comos.ServerDirectory.User".
2. Determine the users of the user group.
3. Use the "GroupBasedAuthorization" option when setting the WCF security options. See also
chapter Specifying WCF security options for the SDS (Page 58).

Using PDMS Engineering Interface with SDS

Requirement
You have performed all settings described.

Procedure
1. Open the PDMS Engineering Interface in COMOS.
2. Open the PDMS Engineering Interface in PDMS/E3D.
The "Select server" window opens. It displays all unassigned COMOS instances to which you
have access.
3. Select a COMOS instance to which PDMS/E3D should connect.

Result
COMOS and PDMS are interconnected.
The selected PDMS/E3D instance is no longer available to other users as long as you are using it.

3D Integration Administration
66 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

2.6 Special preprocessing in COMOS

2.6.1 Overview of the COMOS preprocessing

Additional procedure
In this chapter, you will create a minimum executable work environment. The special COMOS
preprocessing has the following process scheme:
1. Acquire basic knowledge
Read the chapter on the objective of classes and subclasses.
See chapter Objective of the classes and subclasses (Page 68).
2. Create subclass using the E3D tab
The existence and minimum configuration of the E3D tab creates subclasses that initially
serve as placeholders. You can use the subclasses included in the supplied iDB or define your
own subclasses. A new, customer-specific subclass cannot be used at this time but only an
empty container.
See chapter Minimum configuration of the E3D tab: Create subclass (Page 69).
3. Minimum description of the subclass
The new, customer-specific subclasses are given minimum information. This makes the
subclasses usable for COMOS engineering objects. During the project, the subclasses may be
altered or amended. But in this step, you create at least one usable subclass from an empty
placeholder.
See chapter Minimum configuration of a subclass in COMOS (Page 71).
4. Assigning a subclass to the COMOS objects
See chapter Assigning a subclass to COMOS objects (Page 74).
5. Making subclasses available in the engineering project
The subclasses are collected below a folder object. In the engineering project, create the
folder and all required class objects and subclass objects.
After this step, you can create the first engineering objects. Later extensions of the subclass
are transferred to the engineering objects that were already created.
See chapter Creating folders for definitions with class objects (Page 74).
6. In addition to the points listed above, it is useful to enter associated PDMS/E3D projects in
COMOS at this time:
See chapter Assigning COMOS projects and PDM/E3D projects (Page 76).

See also
Using consistent pipe engineering (Page 76)

3D Integration Administration
Operating Manual, 03/2021 V10.4 67
PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

2.6.2 Objective of the classes and subclasses

Classes and subclasses

The "PDMS/E3D Engineering Interface" needs the following information for COMOS objects:
1. Element type of the corresponding PDMS/E3D object
2. Element type of owner of the corresponding PDMS/E3D object
3. Forming the name of the corresponding PDMS/E3D object
This information is configured and assigned in COMOS using "Class objects" and "Subclass
objects":
• As a rule classes are grouping objects for subclasses.
In exceptional cases, the class objects have their own configuration.
• Subclasses determine the configuration for a certain class or quantity of objects.
The COMOS objects that are relevant for the interface must be assigned to the subclasses so
that the local configuration with subclasses becomes effective. The subclass of an object
determines the behavior of the object for interface interactions.
Subclasses are also one of the requirements for creating working areas.
The detailed description of the classes and subclasses supplied in the iDB is available in the
chapter Definitions for classes and subclasses in the iDB (Page 89).

Assignment of subclasses to PDMS/E3D types: Subclasses.xml

As a rule one or more PDMS/E3D types are assigned to a subclass. This is how the amount of the
PDMS/E3D objects that belongs to this subclass is specified.
• The configuration is carried out in COMOS and stored in the Subclasses.xml file.
• Subclasses.xml is known in both applications through the initialization file.
See chapter Specifying the path to the initialization file (Page 29).

6KDUHGGDWD

,QLWLDOL]DWLRQILOH

&2026 3'06('

6XEFODVVHV)LOHSDWK ?6XEFODVVHV[PO!

&RQILJXUDWLRQILOH

3D Integration Administration
68 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

2.6.3 Minimum configuration of the E3D tab: Create subclass

Requirement
• The objective of the classes and subclasses is known.
See chapter Objective of the classes and subclasses (Page 68).

Purpose of the E3D tab

The E3D tab at the base object controls the following information for the engineering objects:
1. The object is relevant for the interface and is included in the user interactions in the interface.
Exception: "Undef" class name.
2. The object knows its own class.
3. The object knows its own subclass. This is how the object also knows the configuration that
determines its behavior for interactions.
4. The object knows the type of the corresponding PDMS/E3D object.

Master data path of the E3D tab

SystemFullName of the folder @40|A20|Y00|A10|A10|Y00T00012|A03

This folder contains tabs that are assigned to the COMOS objects to assign them to a
subclass.
Description External 3D interface (PDMS integration)
Name of the tab Y00T00012 | External 3D interface
In the section below this tab is called the "E3D tab".

3D Integration Administration
Operating Manual, 03/2021 V10.4 69
PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

The catalog can be extended if required.

Mandatory attributes and assigned standard tables

All E3D tabs must have the following "Class Settings" attribute group. This attribute group must
be available when you extend the catalog of the E3D tabs.

Class Class name Used standard table:

Y10|M27|A10|Y10M27N00002|Y10M27N00002A01
Subclass Subclass name Used standard table:
Y10|M27|A10|Y10M27N00002|Y10M27N00002A02
PDMS element type PDMS/E3D element type of the corre‐ Used standard table:
sponding object on the PDMS/E3D side @40|Y00|A10|C10|Y00N00465

3D Integration Administration
70 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

In the preprocessing phase, start by using the unchanged iDB standard tables. Later you can
adapt the standard tables to meet the customer-specific requirements:
• See chapter Administering standard tables for classes and subclasses (Page 108).
• See chapter Administering the standard table for PDMS element types (Page 110).

Additional configuration of the E3D tab

The further configuration takes place in a later step.
• See chapter Attributes of the "External 3D Interface" tab (Page 157).
• See chapter Configuring COMOS interface objects (Page 154).

2.6.4 Minimum configuration of a subclass in COMOS

Requirement
• The objective of the subclasses is known.
See chapter Objective of the classes and subclasses (Page 68).

3D Integration Administration
Operating Manual, 03/2021 V10.4 71
PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

Procedure
As an example, a pipe was selected but this configuration can be applied to all element types.
1. Specify the type of the corresponding PDMS/E3D object in the "General" tab.

2. Create a variable in the "Name directory" tab.

3. Use the value of the variable that you created in the "Name mapping" tab.
This way the label of the COMOS objects that belong to this subclass are created.

3D Integration Administration
72 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

4. Prefix the variable with an exclamation mark.

5. Specify the type of owner in the "Owner restriction rules" tab.

Overview of the complete control of the subclasses using tabs

• General
General settings
• Name directories
For the generation of variables and attribute relations.
See also chapter Objective of the name directory and the String parameters (Page 129).
– Local variables
See also chapter Using the "Name directory" tab (Page 129).
– Global variables
See also chapter Using the name directory: Defining global variables (Page 113).
• Name mapping
Rules for the generation of labels and for the formation of COMOS structures.
See also chapter Configuring site mapping and location mapping in name mapping
(Page 138).
• Owner restriction rules
Rules for the protection of the creation of objects under the wrong owner
See also chapter Specifying restriction rules for owners (Page 125).
• Models
Is no longer used.
See also chapter Configuring the model (Page 126).

3D Integration Administration
Operating Manual, 03/2021 V10.4 73
PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

2.6.5 Assigning a subclass to COMOS objects

Requirement
• The objective of the subclasses is known.
See chapter Objective of the classes and subclasses (Page 68).

Procedure
1. Optional: Supplement the standard table with the subclasses with those subclasses planned
in the short term.
In the standardized worflow, this step is scheduled for a later time. See chapter Administering
standard tables for classes and subclasses (Page 108).
2. Optional: Supplement the standard table with the PDMS/E3D element types with those types
that you want to use.
In the standardized worflow, this step is scheduled for a later time. See chapter Administering
the standard table for PDMS element types (Page 110).
3. Assign a corresponding E3D tab from the catalog to the base objects whose characteristics
on the engineering side are relevant for the interface. Make sure to assign the appropriate
E3D tab to the object.
4. If you want to work with pipes, assign an E3D tab to the pipe sections.
Set the class to "Undef" if you do not want to work with pipe sections.
5. If necessary, correct the subclass or the PDMS/E3D element type on the assigned tabs at the
base objects.

Result
Existing and newly created objects on the engineering side know your configuration and the
types of the corresponding object on the PDMS/E3D side.

2.6.6 Creating folders for definitions with class objects

Requirement
• The objective of the subclasses is known.
See chapter Objective of the classes and subclasses (Page 68).

3D Integration Administration
74 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

User interface

Objective
For better management, all class objects and their associated subclass objects are collected
below the "A70 Folders for class/subclass definitions (PDMS)" object. In addition, the object
offers its own global settings. For a detailed description of the tasks of the "Folders for
definitions" object, see chapter Tasks of the "Folders for definitions" object (Page 89).

Procedure
1. Select the project root in the supplied database.
2. Select the context menu "New > "A70 Folders for class/subclass definitions (PDMS)".
Other names used here: "PDMSMAP object", "Folders for definitions".
In the preprocessing phase, start by using the unchanged iDB object. Later you can adapt the
"Folders for definitions" object to meet the customer-specific requirements:
See chapter Configuring the "Folders for class/subclass definitions" object (Page 112).
3. Use the context menu at the "Folders for definitions" object to create the objects for the
classes.
You can also add missing classes later. See chapter Creating a class definition object
(Page 119).
4. Use the context menu at the class objects to create the required subclass objects.
You can also add missing subclass objects later. See chapter Creating subclass definition
objects (Page 120).
5. Configure the desired subclasses. See chapter Minimum configuration of a subclass in
COMOS (Page 71).
Note
Name matching
Name the subclass objects exactly as they were named in the standard table for subclasses
in the "Value 1" column.

3D Integration Administration
Operating Manual, 03/2021 V10.4 75
PDMS/E3D Engineering Interface
2.6 Special preprocessing in COMOS

6. Start the interface.

You must start the interface to activate the context menu that you need in the next step. You
can stop the interface again after you have used the context menu.
7. Save the configuration via the context menu at the "Folders for definitions" object with the
command "Save subclasses".
Note
Activating a menu item
This menu item only becomes visible after you have started the interface in COMOS.
The command "Save subclasses" is required in this step to create a minimum executable
configuration. The detailed description of the "Save subclasses" step is available in the
chapter Synchronizing classes and subclasses in COMOS and PDMS (Page 151).

Assigned master data

Object SystemFullName
"A70 Folders for class/subclass defi‐ "@20 > D30 > A20 > Y00R00033 @PDMSMAP Folders for class/subclass definitions
nitions (PDMS)" (PDMS)"
(other name used here: PDMSMAP
object)
Class objects @30|M00|A20|A10|A10!A70!Y00R00035 (cable)
@30|M00|A20|A10|A10!A70!Y00R00037 (TaggedItem)
Subclass objects @30|M00|A20|A10|A10!A70!Y00R00035!A10 (cable)
@30|M00|A20|A10|A10!A70!Y00R00037!A10 (TaggedItem)

2.6.7 Using consistent pipe engineering

Requirement
• You are familiar with the overview of the COMOS preprocessing.
See chapter Overview of the COMOS preprocessing (Page 67).

Different rules in COMOS and PDMS/E3D

COMOS offers users significantly more options to structure and link objects. When exchanging
information, the COMOS user must only use the options that are also supported in PDMS/E3D.
See also chapter Assigning pipe disconnecting equipment (Page 112).

2.6.8 Assigning COMOS projects and PDM/E3D projects

In the "Process development" category under "COMOS PDMS/E3D Engineering Interface" you
can specify in the project options which PDMS/E3D projects can exchange data with this COMOS
project.

3D Integration Administration
76 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

In the edit field "PDMS/E3D Project Codes" you can specify any number of PDMS/E3D projects by
specifying the project code separated through blanks.
When a 2D workspace or a 3D workspace is requested, a check is carried out whether the project
code is contained in the "PDMS/E3D Project Codes" edit field. If the project code is missing, a
corresponding error message is output and the user is prompted to request matching projects.

See also
Category "Process engineering > PDMS/E3D Engineering Interface" (Page 165)

2.7 Setting up workspaces

After the communication setup it is possible for the users to correctly display workspaces in the
user interface in PDMS/E3D.
A workspace is a set of objects that you can request in the source system and that is displayed
in a user interface in the target system. You can find additional information on this topic in the
"3D Integration Administration" manual, keyword "Workspaces" and "Hierarchy relations".
While 3D workspaces are defined by the user, 2D workspaces must be defined by the
administrator in COMOS. See also chapter Defining 2D workspaces (Page 78).

Main statement
If a workspace is requested, the object amount specified by the workspace definition is evaluated
according to the configured rules. The result is the result collection of the workspace. The objects
in the result collection are displayed in the workspace window according to their display
patterns. See also chapter Implementing the !!SAGGetScopeID() macro (2D workspace)
(Page 78).

Display patterns in the 2D workspace

• Top-level/sublevel structures
– Navigator patterns
– Patterns for pipes
– Area Engineering patterns
• Independent objects
– Patterns for independent objects

3D Integration Administration
Operating Manual, 03/2021 V10.4 77
PDMS/E3D Engineering Interface
2.7 Setting up workspaces

Display patterns in the 3D workspace

• Top-level structures with/without references
– Patterns for unit structures
– Patterns for location structures
– Area Engineering patterns
• Independent objects
– Patterns for independent objects
You can find additional information on this topic in the "3D Integration Administration" manual,
keyword "Request PDMS/E3D objects".

2.7.1 Defining 2D workspaces

2D workspaces are defined in the form of COMOS queries. You can define any number of 2D
workspaces that determine the content, responsibility of the users, subdivision of the COMOS
project into systems, subprojects, etc.

Procedure
1. Create a COMOS query.
2. Configure the COMOS query so that the required top-level objects and Collection Points are
included in the query result.
– The name of the query then becomes the name of the workspace definition.
– The object amount of the workspace only includes the top-level objects and Collection
Points from the query result.
3. Save the COMOS query to the folder that contains all workspace definitions.

Result
You have created a workspace definition.

2.7.2 Implementing the !!SAGGetScopeID() macro (2D workspace)

You must implement the !!SAGGetScopeID() macro to define the 2D workspace. This macro
is not copied during installation of the interface and must be created during implementation of
the interface.

On the user side

After the user has requested COMOS data in PDMS/E3D, the PML macro !!SAGGetScopeID()
is called in the background. The user then selects the name of the workspace. Afterwards, the
result collection of the workspace is calculated for the user and shown in the 2D workspace.

3D Integration Administration
78 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

On the administrator side

Implement the macro so that the user can select the name of a workspace. This name is the
return value of the macro. The return value is forwarded to COMOS and includes the name of a
valid 2D workspace definition, which means the name of an existing COMOS query.

2.7.3 Rules for collection and representation of objects in the 2D workspace

The administrator specifies the following points by means of different rules:

• Which objects of a specified subclass are collected below a top-level object
• How the object hierarchy is formed
• How objects are represented in the 2D workspace
In addition, the administrator can specify whether objects of a subclass are integrated into a top-
level structure or a sublevel structure or whether they are independent.
These attributes are located in the "General" tab in the "Hierarchy options" attribute group.

With the "Independent object" option you can specify whether the objects that are assigned to
this subclass are treated as top-level independent objects (TIOs) or are integrated into a top-level/
sublevel structure.
• If the option is activated, objects of this subclass become top-level independent objects.
• If the option is deactivated, objects of this subclass are integrated into a top-level/sublevel
structure.
You can find additional information on the topic of "Independent objects" in the "3D Integration
Operation" manual, keyword "Object categories and object classes".

3D Integration Administration
Operating Manual, 03/2021 V10.4 79
PDMS/E3D Engineering Interface
2.7 Setting up workspaces

2.7.3.1 Collecting TIOs

Collection Points
Organizationally speaking, TIOs are located below Collection Points. Collection Points are points
under which the interface searches recursively for independent objects. Collection Points only
exist in COMOS and serve as collection points for TIOs in COMOS. Collection points are defined
by setting the "Collection Point" class.

2.7.3.2 Definition of a 2D workspace for TIOs

A workspace that was only defined via Collection Points is a collection of hierarchy-independent
objects. You can also use top-level objects and Collection Points in a mixed form when defining
workspaces.

Requirement
The workspace query contains at least one Collection Point and at least one independent object
(TIO) below it.

Procedure
1. Define objects of the "Collection Point" class in COMOS.
2. Add Collection Points to a workspace query.

Result
• When the 3D Designer requests this workspace, this workspace contains all TIOs that are
located below the Collection Points.
• TIO hierarchies are not formed. TIOs that are located below TIOs are not taken into
consideration. The Collection Points do not belong to the workspace.

2.7.3.3 Rules for the representation of TIOs in the 2D workspace

TIOs are represented in the 2D workspace in a three-level hierarchy. All hierarchy levels belong
to the "Grouping object" object class. You can find additional information on this topic in the "3D
Integration Operation" manual, keyword "Object categories and object classes".

3D Integration Administration
80 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

Display
The type and name have to be specified for these objects:




1) Definition in the SITE mapping (You can find additional information on this topic in the "3D
Integration Operation" manual, keyword "PDMS/E3D object tree").
The SITE mapping is evaluated at the TIO (type = SITE).
2) Definition in the ZONE mapping (You can find additional information on this topic in the "3D
Integration Operation" manual, keyword "PDMS/E3D object tree").
The ZONE mapping is evaluated at the TIO (type = ZONE).
3) Definition in a TIO Owner subclass.
This subclass is registered in the TIO subclass as an Owner subclass. The name mapping of the
TIO Owner subclass is evaluated in order to obtain the name for this level. The type is defined via
the PDMS/E3D element type of the TIO Owner subclass. In this case it is possible to define and
assign user-defined types. An icon can also be assigned through the name of the type. See also
chapter "String parameter" definition (Page 97).
TIOs that form the same TIO Owner name are combined under this name.

2.7.3.4 Representation of TIOs and TL/SL structures in the 2D workspace

You can find additional information on this topic in the "3D Integration Administration" manual,
keyword "Object tree".

Independent objects
The objects below the Collection Point are collected in accordance with the rules described
above. TIO subclasses exist for objects of the type FLOOR, WALL and HANDRA. Only objects with
this type are collected and represented sorted by the structure levels SITE, ZONE, TIOOwner.

3D Integration Administration
Operating Manual, 03/2021 V10.4 81
PDMS/E3D Engineering Interface
2.7 Setting up workspaces

Top-level/sublevel structures
Subclasses are defined for the following types:
• PIPE Collect recursively = FALSE, Strict hierarchy = TRUE
• EQUI: Collect recursively = TRUE, Strict hierarchy = FALSE
• NOZZ: Strict hierarchy = TRUE
Starting from the structure in COMOS, the objects are collected and the corresponding hierarchy
generated in the first step. In the next step the "Strict hierarchy" rule is applied.

The options "Collect recursively" and "Strict hierarchy" are only applicable to top-level structures
and sublevel structures and do not apply to top-level independent objects (TIOs).
The "Collect recursively" option is used to define what is potentially represented in a top-level/
sublevel structure. With the "Strict hierarchy" option these objects are filtered once more in a
post-processing process. See also chapter Definition of a 2D workspace for TL and SL structures
(Page 83).

3D Integration Administration
82 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

2.7.3.5 Definition of a 2D workspace for TL and SL structures

&ROOHFWLQJUHFXUVLYHO\YVVWULFWKLHUDUFK\

&ROOHFWLQJUHFXUVLYHO\"

<(6 12

&ROOHFWDOOREMHFWVUHFXUVLYHO\
IRUZKLFK (OHPHQWW\SH 3,3("
('WDEH[LVWV
&ODVVLVQRW8QGHI <(6 12

&UHDWHKLHUDUFK\ &ROOHFWSLSHVDQG &ROOHFWDOOREMHFWVOHYHOE\OHYHO

2EMHFWVZLWKRXWRZQHUULVHWRWKHWRS SLSHVHFWLRQV IRUZKLFK
&ROOHFWSLSHFRPSRQHQWV ('WDEH[LVWV
DFFRUGLQJWRFRQQHFWRUV &ODVVLVQRW8QGHI

&UHDWHKLHUDUFK\ &UHDWHKLHUDUFK\
$GGYLUWXDOEUDQFKHVZKHQ $VH[LVWLQJLQ&2026
FODVVIRUSLSHFODVVVHFWLRQV
LV8QGHI

3RVWSURFHVV
6WULFWKLHUDUFK\

3D Integration Administration
Operating Manual, 03/2021 V10.4 83
PDMS/E3D Engineering Interface
2.7 Setting up workspaces

3RVWSURFHVV6WULFWKLHUDUFK\

&KURQRORJLFDOO\JRWKURXJKWKLVKLHUDUFK\IRUHDFKREMHFW

6WULFWKLHUDUFK\"
<(6 12

2ZQHUW\SHLQWKHVXEFODVV
(OHPHQWW\SHRIWKHRZQHU"

<(6 12

'HOHWLQJWKHHQWLUHVXEWUHH
LQFOXGLQJWKHREMHFW

3RVWSURFHVV
6WULFWKLHUDUFK\

Procedure
1. Depending on the selection of the "Collect recursively" option, there are two procedures:
– If you have activated the option, the objects are collected recursively under the top-level
objects.
– If you have deactivated the option, the objects are collected level by level until no more
objects are found.
In the case of pipes ("PIPE" object type), the system branches at the pipe section and the
components are collected based on their connectors and are inserted below the pipe
section in the order of the pipe run.

Result
• The hierarchies have been created as specified in the COMOS Navigator. Exceptions are pipes.
• In the case of pipes, virtual branches were inserted at the pipe sections if the class is set to
"UNDEF".
• In the post-processing process the top-level object hierarchies were passed through from top
to bottom (see above: graphic "Postprocess").
– If you have activated the "Strict hierarchy" option, a check is carried out whether the
Owner type in the subclass agrees with the element type of the Owner.
If this is not the case, the complete subtree under the object and the object itself are
deleted.
– In all other cases, no further actions are executed.

3D Integration Administration
84 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

2.7.4 Rules for collection and representation of objects in the 3D workspace

The following options influence the collection of objects in PDMS/E3D:

• Independent object (TIO)
• Filter 3D workspace
• UDAs in PDMS/E3D at top-level objects
You can set the first two options in the "General" tab of the subclass objects.

2.7.4.1 Independent objects (TIOs) in the 3D workspace

The "Independent object" option is for collecting objects that are treated independently of their
Owner object. Objects that belong to a subclass at which this option is set are called top-level
independent objects (TIOs). Subclasses for which the "Independent object" option is set are
called TIO subclasses.
If TIO subclasses are selected when requesting a 3D workspace, TIOS are collected recursively in
PDMS/E3D below the start object (Current Element) for each type specified in the subclass. Here
the PML command Collect all <Type in the subclass> for CE is executed for all
the selected TIO subclasses.

3D Integration Administration
Operating Manual, 03/2021 V10.4 85
PDMS/E3D Engineering Interface
2.7 Setting up workspaces

2.7.4.2 TL/SL structures (3D workspace)

Collecting for the 3D workspace

Through the selection of top-level or sublevel subclasses you can define which objects are to be
added to the 3D workspace. If you select only top-level subclasses, all objects are added to the
3D workspace below the top-level objects whose type is set in any sublevel subclass. The
hierarchy is formed in the same way for the representation. If additional sublevel subclasses are
selected, their types are used as filters in the sense that only such objects are added to the 3D
workspace whose type also occurs in a selected subclass.

&ROOHFWLQJIRU'ZRUNVSDFH

&ROOHFWLQJ7/2VEHORZWKH
&XUUHQW(OHPHQW

6/2VXEFODVVHVVHOHFWHG"
<(6 12

)LOWHUFKLOGREMHFWVIRUZKLFKQR )LOWHUFKLOGREMHFWVIRUZKLFKQR
VXEFODVVLVGHILQHG VXEFODVVZDVVHOHFWHG

&ROOHFWLQJ7,2VEHORZWKH
&XUUHQW(OHPHQW

$SSO\LQJILOWHUPDFURRQDOO
REMHFWV

&UHDWLQJKLHUDUFK\
$VVLJQLQJ7/2VDQG7,2VWRWKHLUSDWK
'LVWULEXWLQJ7/2REMHFWVWUXFWXUHVDQG
7,2VEHORZWKHSDWKV

Through UDAs you can control the object class and the behavior of top-level objects in the 3D
workspace. If the COMOS UDAs exist at the PDMS/E3D objects, they are two-sided objects;
otherwise, they are one-side objects. The consequence in the second case is that the top-level

3D Integration Administration
86 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.7 Setting up workspaces

objects only serve to collect the sublevel objects in PDMS. In the 3D workspace they appear as
single-sided objects of the object class "Single-sided". See also chapter Creating UDAs (Page 30).

Note
For selection as a top-level subclass when requesting a 3D workspace, a subclass must be
defined for these types.

2.7.4.3 Filtering objects with the "3D workspace filter" option

With the "3D workspace filter" option you can specify a PML macro that is called for each object
with a type of this subclass.
• If the function returns the return value "TRUE", the object belongs to the workspace.
• If the function returns the return value "FALSE", the object does not belong to the workspace.
Before the function is called, the currently viewed object is set as the Current Element in PDMS/
E3D. The name of the subclass of the currently viewed PDMS/E3D object is handed over to the
macro as the parameter:
Define function !!<Function name>(!subclass is STRING) is BOOLEAN
This macro is called for TLOs, SLOs and for TIOs.

2.7.4.4 Representation of TIOs and TL/SL structures in the 3D workspace

The representation depends on which subclasses were selected, meaning TLO, SLO und TIO
subclasses, and which SLO subclasses exist. See also chapter Definition of a 2D workspace for TL
and SL structures (Page 83).

Independent objects
• TIO subclasses selected for the element types FLOOR and PJOI

You can find additional information on this topic in the "3D Integration Administration" manual,
keyword "Object tree".

3D Integration Administration
Operating Manual, 03/2021 V10.4 87
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

Top-level/sublevel structures
• TLO subclasses selected for the PIPE element types
• SLO subclasses exist for the element types VALV, REDU

You can find additional information on this topic in the "3D Integration Administration" manual,
keyword "Object tree".

2.8 Definitions and terminology for the interface operations

2.8.1 Technical definition of the interface objects

Definition of Interface Objects

Interface objects are engineering objects which can be processed by the interface operations.
An object counts as an interface object if it has the following properties:
• In COMOS:
– "External 3D interface" tab
– Assignment to a class
– Assignment to a subclass
The class must differ from UNDEF.
– PDMS element type
• In PDMS: UDA ":ComosSClass"
If the devices of your device catalog have these properties, they are processed by COMOS PDMS
Interface.

See also
Configuring COMOS interface objects (Page 154)

3D Integration Administration
88 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.2 Tasks of the "Folders for definitions" object

Requirement
• The object is created.
See chapter Creating folders for definitions with class objects (Page 74).

Function
This object fulfills the following functions:
• The class and subclass definition objects are managed below the object.
See chapter Definitions for classes and subclasses in the iDB (Page 89).
• At this object, you make general settings which apply to the entire interface and not only to a
specific class or subclass.
– Interface operations after which feedback messages are displayed to users.
See chapter Definition of the process log (Page 101).
– Use and configuration of the site mapping and zone mapping.
See chapter "ZONE mapping" and "SITE mapping" definition (Page 101).
– Configuration of the character mapping
See chapter "Character mapping" definition (Page 100).
– Configuration of the unit mapping
See chapter "Unit mapping" definition (Page 100).
– Registered pre/post executables
See chapter "Pre/post executables" definition (Page 100).
– Global String parameters
See chapter "String parameter" definition (Page 97).
• In the context menu of the object, you can save the configuration of the subclass definition
objects in a file and refresh the standard table used to save the subclasses.
See chapter Synchronizing classes and subclasses in COMOS and PDMS (Page 151).

2.8.3 Definitions for classes and subclasses in the iDB

There are two groups of classes and subclasses:

3D Integration Administration
Operating Manual, 03/2021 V10.4 89
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

Group 1: Classes and subclasses for categorizing the interface objects

The following classes and their subclasses belong to this group:
• "Cables (PDMS)":
Interface objects with this class are used for example as:
– Pipe or pipe branch
– HVAC
– DUCT
– CABLES
• "Devices with label (PDMS)":
Interface objects with this class are equivalent to PDMS objects which can be positioned in 3D
space.
You can use subclasses to differentiate the behavior of interface objects on the same class. The
subclass determines how an interface object is processed during an interface operation.

Group 2: Classes and subclasses for configuration of the interface execution

The following classes and their subclasses belong to this group:
• "Queries (PDMS)" class and their subclasses: They are used to configure COMOS queries and
make them accessible and executable in PDMS.
• "Document (PDMS)" class and its subclasses: A DocLink is generated for the interface object.
• "MTO (PDMS)" class: Configure the import of MTO data from PDMS/E3D to COMOS. This class
has no subclasses.
See also chapter Configure 'MTO (PDMS)' class (Page 128).

Properties of classes
Classes have the following properties:
• Classes structure the subclasses.
• The number and name of classes are fixed. They are specified by the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"
• A class can have any number of subclasses.

Properties of the subclasses

Subclasses have the following properties:
• The function performed by a subclass is determined by the class to which it belongs. See
above.
• The number and names of subclasses are specified by the subclass definition objects and are
dynamically saved in the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A02 Subclasses"

3D Integration Administration
90 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.3.1 Class definition objects

Function
Class definition objects are engineering objects which are located directly below the "Folders for
class/subclass definitions" object.
Class definition objects have the following functions:
• They represent a class from the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"
See chapter Administering standard tables for classes and subclasses (Page 108).
• They structure the subclass definition objects.

See also
Creating a class definition object (Page 119)

2.8.3.2 Subclass definition objects of "Cables" and "Devices with labels" classes

Function
The subclass definition objects of classes "Tagged item" and "Cable" fulfill the following functions:
• They represent the subclasses of these classes in the engineering view.
• They are used to save and configure the properties of the corresponding members of this
subclass.

Defining interface object properties

One subclass definition object defines the following properties for all interface objects of the
subclass:
• PDMS element types
• Base object that is used when the interface object is created in COMOS
The user defines two base objects:
– One is used when the interface object is created in the unit tree
– One is used when the interface object is created in the location tree
• Structural behavior:
– Whether the PDMS interface object is connected to a COMOS object from the unit tree or
from the location tree
– Whether the COMOS interface object is to have a pointer to another COMOS object and
whether this object is located in the unit tree or in the location tree

3D Integration Administration
Operating Manual, 03/2021 V10.4 91
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

• Regarding name mapping:

– Generation of the object name on PDMS
– Rule governing how the interface for a given PDMS object finds the location at which the
corresponding COMOS object will be created in the COMOS structure
• Regarding the name directory:
– Values that are evaluated by the interface operations when you process the interface
object
– Assignment between COMOS attribute and PDMS attribute
– String parameters that are available in the subclass.
• Regarding the owner restriction rules: Conditions that the owner must fulfill so that an
interface object can be created below it
• Which 3D model the interface object obtains
• How the object is initialized during the export if "Function" is set as model

See also
Creating subclass definition objects (Page 120)
Configure subclass definition objects of classes "Cable" and "Tagged item" (Page 121)

2.8.3.3 Subclass definition objects of the "Queries" class

Working with COMOS queries in PDMS

The interface allows users to work with COMOS queries in PDMS. Users have the following
options:
• They select a query in PDMS from a range of predefined COMOS queries.
• Optional: They define filters for the query.
• Optional: They define the start object.
• They start the query in PDMS.
• They see the result of the query in PDMS or in an external program such as Excel.
This functionality is implemented with the help of COMOS queries and subclass definition
objects of the "Query" class.
The subclass definition objects of the "Query" class define the following:
• Queries that are available in PDMS
• Base objects of the objects in the result list
• Preset start object
• Output format in which the result list will be transferred

3D Integration Administration
92 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

See also
Definitions for classes and subclasses in the iDB (Page 89)
Creating subclass definition objects (Page 120)
Creating and configuring query subclasses (Page 146)

2.8.3.4 Subclass definition objects of the "Documents" class

The interface allows users to create DocObjs for draft objects in COMOS.

Requirement
• The draft objects have a DDNM attribute.
• The DDNM attribute references a design object which is connected to a COMOS object.
• A COMOS document under which the DocObjs are imported has been specified in the draft
structure.

Function
In the subclass definition objects of the "Document" class, you define all settings which are
necessary to create DocObjs for draft objects.
These include:
• Place in the PDMS draft structure at which the COMOS document for which DocObjs will be
created is specified.
As you are able create any number of subclass definition objects, you can configure the
interface in such a way that "Import DocLinks" can be started at different levels of the draft
structure according to the requirements.
• Filter criteria that restrict the COMOS document for which the DocObjs can be created.
• Setting indicating whether DocObjs are created only for draft objects with names or also for
draft objects without names.
• Owner restrictions for the draft objects for which DocObjs are created.

See also
Creating subclass definition objects (Page 120)
Administering standard tables for classes and subclasses (Page 108)
Configuring "Import DocLinks" (Page 149)

3D Integration Administration
Operating Manual, 03/2021 V10.4 93
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.4 Definitions for name mapping

Function
Name mapping fulfills the following functions:
• It generates a PDMS/E3D name for a COMOS interface object.
The interface uses the PDMS/E3D name to identify the PDMS/E3D interface object to which
the COMOS object is connected.
• It uses the PDMS/E3D name of a PDMS/E3D interface object to ascertain the path to the
COMOS interface object to which it is connected.
• If the structural behavior of the subclass definition object prescribes that a COMOS interface
object references another COMOS object, the name mapping derives the referenced object
from the PDMS/E3D name.
• Optional:
If the COMOS interface object that is to be connected to a PDMS/E3D object does not exist yet:
The name mapping determines the base object used to create the COMOS interface object.
• If the owner structure of the COMOS interface object that is to be connected to a PDMS/E3D
object is incomplete or missing, the name mapping specifies which owners are created.

Site mapping and location mapping

The unit tree and the location tree do not usually share the same object structure. This is why it
is necessary to manage two mapping tables:
• Site mapping: Table which defines name mapping in the unit tree
• Location mapping: Table which defines name mapping in the location tree
You can find information on the structure of the tables, their configuration, and the algorithm
on which the name mapping is based in chapter Configuring site mapping and location mapping
in name mapping (Page 138).

See also
Structural behavior (Page 95)
Level rules of name mapping (Page 94)

2.8.4.1 Level rules of name mapping

Function
You can define deviations from the standard evaluation model for site mapping and location
mapping.
These deviations are particularly required in the following cases:
• Your project uses an alias structure.
• Your project uses different hierarchy depths.

3D Integration Administration
94 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

Rule "Take alias rather than object"

If this rule is activated, the alias structure is used to generate the PDMS names.
If no alias is available, the name or description of the object is used.

Rule "Skip level if data part empty"

If this rule is activated, you can map hierarchies of different depths in name mapping. The
maximum number of mapping entries in the name mapping is determined by the hierarchy with
the deepest level.
If the evaluation of the data item or fixed name of a mapping entry returns an empty string, the
process continues with the next mapping entry.
Application example: Your equipment is located in the "Equipment" folder. Only pumps are not
directly located in the folder; these are to be found in its "Pumps" subfolder.

Rule "Skip level if unable to create object"

If a COMOS object cannot be created because of its configuration - because the potential owner
only permits certain elements as subobjects, for example - the name mapping does not abort.
It jumps to the next mapping entry. The entry is processed with the next PDMS name part.
Result: This rule allows you to use name mapping in COMOS to create object structures with
hierarchy levels of different depths.

Rule "Use label for fixed name"

If this rule is activated, the label of a COMOS object rather than its name is used in the "Fixed
name" range.

See also
Configuring level rules (Page 238)
Definitions for name mapping (Page 94)

2.8.4.2 Structural behavior

Function
The structural behavior of a subclass definition object defines the following points:
• Creation mode: Whether the COMOS interface object to be connected to the PDMS object is
located in the unit tree or in the location tree
• Assign mode: Whether the COMOS interface object references another COMOS object and
whether the referenced object is located in the unit tree or in the location tree

3D Integration Administration
Operating Manual, 03/2021 V10.4 95
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

Depending on how you define the structural behavior, either site mapping or location mapping
is evaluated during name mapping to fulfill one of the following tasks:
• Find or create an interface object in order to connect it with a PDMS object.
• Find or create the COMOS object referenced by the COMOS interface object.

See also
Definitions for name mapping (Page 94)
Definition and tasks of the area pipes (Page 96)
Defining structural behavior (Page 121)

2.8.5 Definition and tasks of the area pipes

Definition
An area pipe is an object which is generated whenever an interface operation processes an
object whose subclass has the following structural behavior:
• Creation mode: "Create in location tree"
• Assign mode: "Assign to object in unit tree"
The aim of this setting is to map multiple PDMS objects to a single COMOS object. For this
purpose, the area pipe level is inserted between the PDMS objects and the COMOS object.

Application case
A pipe runs across different zones in PDMS, meaning that there are several pipe objects, but
logically these represent the same pipe. There is only one pipe object in the COMOS unit tree.
Area pipes are created for the PDMS pipes in the location tree and connected to the PDMS pipes.
The area pipes get a reference to the same COMOS pipe object.

Properties
Area pipes have the following properties:
• Area pipes are connected to the PDMS object.
• Area pipes get a unit link to an interface object from the unit tree.
• The full name of the corresponding PDMS object is written to the "Name" property of the area
pipe.
In contrast, only the last name part of the PDMS name is written to the name of the
referenced unit object. Depending on how the name mapping is configured, the name part
can even be truncated before it is written to the "Name" property.
• Data exchange can take place between the unit object and the assigned PDMS objects.

3D Integration Administration
96 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

See also
Structural behavior (Page 95)

2.8.6 "String parameter" definition

Definition
A String parameter is a variable which returns or processes a string:
• A String parameter reads a COMOS value or a fixed string. If the String parameter is
configured accordingly, it writes the value to PDMS.
• A String parameter reads out a PDMS value or a fixed string. If the String parameter is
configured accordingly, it writes the value to PDMS.

Global String parameters

Availability:
These String parameters are available everywhere in the interface operations area. They are
defined at the "Folders for class/subclass definitions" object.
In PDMS, global String parameters are evaluated independently of the current element.
In COMOS, they are evaluated at the following objects:
• In the project
• In the workset
• At the "Folders for class/subclass definitions" object
Purpose:
• To define variables which are globally available in the interface operations area.
• To prevent interface operations from being executed if a COMOS value and a PDMS value
defined by the String parameter do not match.

Local String parameters

Availability:
These String parameters are only available for subclasses. They are defined in the subclass
definition objects and evaluated at the interface object.

3D Integration Administration
Operating Manual, 03/2021 V10.4 97
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

Purpose:
• To define variables that are locally available in a subclass.
• To perform one of the following actions during the interface operations:
– Export: Write a COMOS value to PDMS.
– Import: Write a PDMS value to COMOS.
– Check: Compare a COMOS value with a PDMS value.
Without these actions it is not possible to make an assignment between the attributes of an
interface object in COMOS and PDMS.
• Optional: To stop objects from being created for the export if a COMOS value and a PDMS
value are different.

See also
Using the name directory: Defining global variables (Page 113)
Using the "Name directory" tab (Page 129)

2.8.7 "Owner restriction rules" definition

Definition
With the restriction rules for owners you can define rules for the subclass definition objects. The
rules determine which owners are permitted in PDMS for objects of this subclass.
The interface evaluates the restriction rules for owners before it creates an object in PDMS or
makes an assignment between a COMOS object and a PDMS object. If an action violates one of
the rules, the object is not created or no assignment is made.

Example
With the restriction rules for owners, the following rules can be implemented, for example:
• In PDMS, the exported interface objects are only created under zones whose purpose
attribute is set to "TAG".
• In PDMS, pipes and branches are only created under zones whose purpose attribute is set to
"PIP".
• In PDMS, the equipment is only created under zones whose purpose attribute is set to "EQU".

3D Integration Administration
98 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.8 Definition of the model information

Model types
The following model types are available for interface objects:
• Design template:
– The model is defined via a design template. The template has been imported from PDMS
to COMOS.
– The user defines one main template and up to five templates for secondary equipment.
• PDMS element:
The model of an existing PDMS element is used.
• Function:
The model is defined via a PML function.
• None:
A box is created.

Possible sources
You have the following options for defining which model type an interface object uses:
• The model is inherited from the base object
• The model is taken from the subclass definition object
• The settings inherited from the base object or the subclass definition object are over-defined
in the properties of the interface object.

Export
When an interface object is exported to PDMS, the model information defined in COMOS is also
exported.
The object is displayed in PDMS with the corresponding model.

See also
Configuring the model (Page 126)
Overwriting the inherited model information (Page 155)

3D Integration Administration
Operating Manual, 03/2021 V10.4 99
PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.9 "Pre/post executables" definition

Definition
Pre/post executables are user-defined PML functions which are called prior to starting or after
completion of an interface operation.
• Pre executables execute steps serving the purpose of initialization and have an effect on the
entire interface operation.
• Post executables execute concluding steps.

See also
Using pre/post executables (Page 114)

2.8.10 "Character mapping" definition

Maintaining the naming convention

Some characters, such as blanks, are not allowed to form part of a PDMS name.
If the name mapping in COMOS generates a PDMS name, the generated string may contain one
or more characters that are not permitted in PDMS.
You define which characters are to replace these illegal characters in PDMS in the character
mapping of the "Folders for class/subclass definitions" object.

See also
Using character mapping (Page 116)

2.8.11 "Unit mapping" definition

Unit conversion
It may be that an attribute was assigned a different unit in COMOS than in PDMS.
Units mapping enables you to map these units. When an attribute of this type is exported or
imported, the attribute value is converted as defined in the units mapping settings.

See also
Using unit mapping (Page 116)

3D Integration Administration
100 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.8 Definitions and terminology for the interface operations

2.8.12 "ZONE mapping" and "SITE mapping" definition

The SITE mapping and ZONE mapping is evaluated when you call the command "Create" or
"Create hierarchy" at an object in the working area. You use ZONE mapping and SITE mapping
to specify under which SITE and ZONE objects are to be created in PDMS/E3D. The objects in the
"3D work area" are sorted according to the mapping.
The mapping is defined in two tables at the "Folders for class/subclass definitions (PDMS)" object:
• The SITE mapping supplies the PDMS name of a SITE
• The ZONE mapping supplies the PDMS name of a ZONE
When the specified SITE cannot be found, the object is not created.
When the specified ZONE cannot be found, the ZONE is created and the object is created.

Condition
SITE mapping and ZONE mapping is performed only in the following case:
• SITE mapping and ZONE mapping are activated. See also chapter Using ZONE mapping and
SITE mapping (Page 117).
• The interface operation "Create" or "Create hierarchy" is called.
• The subclass definition object of an interface object stipulates that the object has a ZONE as
its owner in PDMS/E3D.

2.8.13 Definition of the process log

Definition
Short operation messages are available for the following interface operations:
• "Assign"
• "Export" from PDMS and COMOS
• "Refresh"
• "Unassign"
If you activate a history log for these operations, a window opens once the interface operation
is complete containing information regarding the history of the operation for the user.

See also
Activating operation messages (Page 113)

3D Integration Administration
Operating Manual, 03/2021 V10.4 101
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.8.14 "Connected objects" definition

Definition
A COMOS interface object and a PDMS interface object are connected when their connection
information matches.

COMOS object PDMS object

"SystemUID" = ":ComosUID"
"Y00T00012.Y00A01244" = "RefNo"
"PDMS reference number"

COMOS object COMOS object

"SystemUID" = "Y00T00012.Y00A00730"
"SystemUID"

PDMS object PDMS object

"RefNo" = ":ComosCRefNo"
":ComosUID" = "SystemUID"

These properties are set during the following interface operations:

• PDMS and COMOS: "Export"
• COMOS: "Export to CE"
• COMOS: "Assign"

Name matching
If the name mapping of a COMOS object generates a name that matches the name of a PDMS
object, the two objects are regarded as connected.
Name matching is the assignment criterion for the "Assign > Match Names" interface operation.

2.9 Configuring interface operations

The following approaches are possible for the administration of the interface operations area:

3D Integration Administration
102 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Task-based administration
Use task-based administration if you do not yet have extensive experience in administering the
interface.
1. You start by only making the settings which are necessary for a specific task.
2. Then you check your entries by executing the corresponding interface operations.
3. After this you configure the next task, and so on.
See chapter Task-based administration (Page 104).

Object-based administration
Use object-based administration if you have extensive experience in administering the interface.
1. Create the "Folders for class/subclass definitions" object and, below it, the class definition
objects and the subclass definition objects. See also chapter Definitions for classes and
subclasses in the iDB (Page 89).
The interface objects are or have been created by users during project planning.
2. You then configure the objects in the following sequence:
– "Y00R00033 @PDMSMAP Folder for class/subclass definitions (PDMS)" object
– Subclass definition objects
– Base objects of the interface objects

Note
Configuration of the attributes
The properties of the attributes listed in the following have already been fully configured in the
database.
Only change the pre-configured settings if the documentation explicitly indicates that such a
change is permitted or necessary.
In particular:
• Do not change or modify any scripts.
• Do not modify or delete any links.
• Do not delete standard table assignments.

Note
Updating the attributes automatically
For attributes, you can specify that each inconsistency cleanup of the objects ("Resolve",
"Synchronize", "Create", "Assign") also automatically updates the attributes of the objects. See
also chapter "General" tab (Page 166).

3D Integration Administration
Operating Manual, 03/2021 V10.4 103
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

See also
Attributes of the "Folders for class/subclass definitions" object (Page 166)
"Class - Lines (PDMS) > A01 Pipe subclass definition" (Page 171)
"Class - Queries (PDMS) > A01 Query subclass definition" (Page 174)
"Class - Documents (PDMS) > A01 Document subclasses definition" (Page 169)

2.9.1 Implementing the PML macro !!SAGPickUpQueryResult(!p is STRING)

The macro "!!SAGPickUpQueryResult(!p is STRING)" is called automatically once you have
executed the macro "!!SAGRunCOMOSQuery()" and generated a CSV file. You can find additional
information on this topic in the "3D Integration Operation" manual, keyword "Executing COMOS
query in PDMS/E3D".
The absolute path to the CSV file is transferred as argument to the macro "!!
SAGPickUpQueryResult(!p is STRING)" in this process.

Procedure
1. Create a macro with the name "!!SAGPickUpQueryResult(!p is STRING)".
The argument !p includes the absolute path to the CSV file as string.
2. Define how the query results are to be processed further or displayed.

2.9.2 Task-based administration

Task-based administration of the interface operations is described in the following:

1. Basic configuration:
Configuration of the "Folders for class/subclass definitions" object, the subclass definition
objects of the "Cable" and "Tagged item" classes, and the interface objects.
See also chapter Performing the basic configuration (Page 105).
2. Use of COMOS queries in PDMS
See also chapter Configuring the use of COMOS queries in PDMS (Page 106).
3. Use of pre/post executables
See also chapter Configuring the use of pre/post executables (Page 107).
4. Importing DocLinks
See also chapter Configuring the import of DocLinks (Page 107).
5. Importing AVEVA templates
See also chapter Configuring the import of AVEVA templates (Page 107).

3D Integration Administration
104 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.2.1 Performing the basic configuration

Procedure
1. Insert the "External 3D interface" tab for the base objects of the interface objects.
2. Optional: Enter additional element types in the "PDMS element types" standard table.
3. Create the "Folders for class/subclass definitions" object below the root node.
4. Optional: To configure the use of pre/post executables, go to the following
chapter Configuring the use of pre/post executables (Page 107).
5. Create the necessary class definition objects.
6. Create the necessary subclass definition objects below the class definition objects.
7. Optional: To configure the import of AVEVA templates, go to the following
chapter: Configuring the import of AVEVA templates (Page 107).
8. Edit the subclass definition objects of classes "Cable" and "Tagged item":
– Define the structural behavior.
– Define the PDMS element types.
– Define the restriction rules for owners by selecting the element type of the owner.
Optional: Define additional restrictions.
– Define the site mapping and location mapping.
– Define the model information.
– In the name directory, define how values are mapped to one another in COMOS and PDMS.
Optional:
– Define local variables in the name directory.
– Define the level rules.
9. Optional: To configure the use of COMOS queries in PDMS, go to the following
chapter Configuring the use of COMOS queries in PDMS (Page 106).
10.Optional: Configure the "External 3D interface" tab.
11.Edit the "Folders for class/subclass definitions" object.
– Define the character mapping.
– If the "Export" operation is to be used: Define the site mapping and zone mapping.
– Optional: Define the global variables.
– Optional: Activate the history logs.
– Define the unit mapping.
12.Optional: To configure the import of DocLinks, go to the following chapter: Configuring the
import of DocLinks (Page 107).
13.Synchronize the settings between COMOS and PDMS.

3D Integration Administration
Operating Manual, 03/2021 V10.4 105
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

14.Test the settings:

In COMOS:
Select "PDMS > 3D-View > Select > By Name":
– If the object is found in PDMS: Run "PDMS > Assign> Selected object".
– If the object is not found in PDMS: Run "PDMS > Export" and check the generated name
in PDMS.
In PDMS:
Select "Comos > CE > Navigate".
15.Open the "General" tab for the subclass definition objects of classes "Cable" and "Tagged
item".
Specify the base objects for creating objects.
16.Synchronize the settings between COMOS and PDMS.
17.Use the following interface operations to test the settings in COMOS:
– "Refresh"
– "Custom Refresh"
– "Check status"
– "Export" (with attribute values)
18.Synchronize the settings between COMOS and PDMS.
19.Use the "Export" interface operation to test the settings in PDMS.

2.9.2.2 Configuring the use of COMOS queries in PDMS

Requirement
You have performed steps 1 - 6 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 105).

Procedure
1. Create and configure the main queries that are to be called from within PDMS.
Optional: Create and configure start queries for the main queries.
2. Configure the subclass definition objects of the "Query" class.
3. Synchronize the settings between COMOS and PDMS for the "Folders for class/subclass
definitions" object.
4. Test the settings in PDMS in the "Query Comos data" window.

3D Integration Administration
106 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.2.3 Configuring the use of pre/post executables

Requirement
You have performed steps 1 - 3 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 105).

Procedure
1. Declare and implement PML functions.
2. Register the PML functions as pre/post executables for the "Folders for class/subclass
definitions" object.
3. Synchronize the settings between COMOS and PDMS.
4. Test the settings by executing the interface operation for which you registered a PML
function as pre/post executables.

2.9.2.4 Configuring the import of DocLinks

Requirement
You have performed steps 1 - 11 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 105).

Procedure
1. Define the attribute or the UDA for the name of the COMOS document in the draft structure
in PDMS.
2. Configure the subclass definition objects of the "Document" class.
3. Test the settings:
– Create a document in COMOS.
– Enter the name of the document in PDMS in the attribute defined at the beginning or the
UDA.
– Execute the "Import DocLinks" operation in PDMS.

2.9.2.5 Configuring the import of AVEVA templates

Requirement
You have performed steps 1 - 6 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 105).

3D Integration Administration
Operating Manual, 03/2021 V10.4 107
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Navigate to the following base object: "@20 > D30 > A30 > Y00R00038 @TPL Objects for
design template structure".
2. Call the "Update design templates" command from the context menu of the node.
GType folders are created in the base data.
3. Assign references to the device catalog to the created GType folder.

2.9.3 Administering standard tables for classes and subclasses

Requirement
• The E3D tab is known.
See chapter Minimum configuration of the E3D tab: Create subclass (Page 69).

COMOS management of the standard tables

Do not edit any standard tables in the engineering project. Only edit standard tables in the base
project.

"Y10M27N00002A01 | Classes"
• "Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"
This standard table must not be changed. Only the first three classes are discussed below.

3D Integration Administration
108 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Class Description
Undef By setting this class, the objects are excluded selectively from the interface
TaggedItem Contains subclasses that have a position in PDMS/E3D: Equipment, nozzles, pipe com‐
ponents, consumers, etc.
Pipe Contains subclasses that have no position in PDMS/E3D: Pipes, cables, etc.

Column name Function

"Name" • Index number
• Used internally
• Starts with 1
"Description" Is displayed as a value in the interface for attributes
to which the standard table has been assigned.
"Value 1" • Class name
• Used system internally
"Value 2" Letter code:
The letter entered here is used in the standard table
for subclasses to assign a class to a subclass.

Each class has its own base object with attributes:

• Attributes of the "Folders for class/subclass definitions" object (Page 166)
• "Class - Lines (PDMS) > A01 Pipe subclass definition" (Page 171)
• "Class - Queries (PDMS) > A01 Query subclass definition" (Page 174)
• "Class - Documents (PDMS) > A01 Document subclasses definition" (Page 169)

"Y10M27N00002A02 | Subclasses"
• "Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A02 Subclasses"
Recommendation: If possible, extend the standard table of the subclasses early. This way, the
new subclass can already be set at the base objects of the interface-relevant objects and is
available during the configuration on the engineering side.

3D Integration Administration
Operating Manual, 03/2021 V10.4 109
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Column Description
Name iDB name
Description Appears in the list at the subclass attribute.
Value 1 Subclass name
• Must always be the name of the subclass object
Value 2 Letter code which assigns a class to the subclass:
• T = TaggedItem
• P = Pipe (Pipe)
Only letters entered in the class standard table in the "Value 2" column are permitted.

The standard table is dynamically updated: When you call the "PDMS > Save subclasses" context
command at the "Folders for class/subclass definitions" folder, COMOS synchronizes the
structure of the subclass definition objects underneath the class definition objects with the
entries of the standard table.

2.9.4 Administering the standard table for PDMS element types

Requirement
• The E3D tab is known.
See chapter Minimum configuration of the E3D tab: Create subclass (Page 69).

Purpose
The most important PDMS element types are listed in the standard table.
You can add the following to the standard table:
• Missing PDMS element types
• PDMS Version 12 and higher: User-defined PDMS element types

3D Integration Administration
110 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

"Y00N00465 | PDMS element types"

• "Standard tables > @40 > Y00 > A10 > C10 > Y00N00465 PDMS element types"
The standard PDMS/E3D element types are supplied in the iDB. Missing types can be added later.

Column Description
Name iDB name
Description Standard description of AVEVA
Value 1 Type as it is used in PDMS/E3D. Notation as in PDMS.
Value 2 PDMS/E3D module in which the type is used.
Possible values:
• "Design"
• "Draft"

"LISTTYPES" element type

The list of element types controls the actual element type or which element type should be used.
The "LISTTYPES" element type is a special case: In this case, all element types are permissible in
PDMS/E3D. The "LISTTYPES" element type is used in the function "Owner restriction rules". See
chapter Specifying restriction rules for owners (Page 125).

2.9.5 Note on the "Folders for class/subclass definitions" object

This object was already created in the step "Special preprocessing for COMOS". See
chapter Creating folders for definitions with class objects (Page 74).

3D Integration Administration
Operating Manual, 03/2021 V10.4 111
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.6 Configuring the "Folders for class/subclass definitions" object

2.9.6.1 Note: Reference of "General" tab

Requirement
• The "Folders for class/subclass definitions (PDMS)" object is created in the project.
See chapter Creating folders for definitions with class objects (Page 74).

Reference
Base object "@20 > D30 > A20 > Y00R00033 @PDMSMAP Folders for class/subclass definitions
(PDMS)":
See chapter "General" tab (Page 166).

2.9.6.2 Assigning pipe disconnecting equipment

Introduction
Equipment for pipes can have the "Pipe disconnecting" property. Equipment with this property
is by definition installed at the beginning or at the end of a pipe but never in a pipe. If the pipe
disconnecting equipment is connected at both sides (meaning that it does not describe the end
of a pipe), the following applies:
• In COMOS, a pipe is always set as the owner of the pipe disconnecting equipment.
• In the default setting, COMOS sets the pipe that is connected to the input of the equipment
as the owner.
The following section describes how the following other owners can be assigned in COMOS:
• In general, the direction of flow is evaluated in a three-way valve to determine the owners.
Note
Technically possible but logically false states in COMOS
It is technically possible in COMOS to construct a three-way valve with three input flows and
three output flows. This case is not plausible from a pipe engineering view and COMOS users
must avoid it.

• COMOS sets the particular pipe that is connected to the output of the equipment as the
owner.
• In case of three or more connections (T-piece, cross), COMOS also sets a secondary line as the
owner.

Controlling the assignment of an owner to pipe disconnecting equipment

1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > General" tab.

3D Integration Administration
112 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

3. Search for the option "Attribute with owner name".

– In the entry field, enter an attribute name in accordance with the following notation:
<Name of the tab><Name of the attribute>.
COMOS sets the particular pipe which is specified in the attribute as the owner.
4. Search for the option "In backward direction".
Activated (specification): COMOS sets the pipe that is connected to the output of the
equipment as the owner.

2.9.6.3 Activating operation messages

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

Procedure
To activate/deactivate operation messages, proceed as follows:
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > General" tab.
3. Search for the "Operation messages" control group.
The control group contains a table with the following columns:
– "Operation" column: Interface operations for which operation messages are available
– "Show information" column: To activate/deactivate operation messages
4. Select an entry from the lists in the "Show information" column.
Possible values:
– "Yes": Activates operation messages for the corresponding operation based on the row
you have selected.
– "No": Operation messages are deactivated for this operation.

See also
Definition of the process log (Page 101)

2.9.6.4 Using the name directory: Defining global variables

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

3D Integration Administration
Operating Manual, 03/2021 V10.4 113
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Navigate to the "Folders for class/subclass definitions" object
2. Select the "Name directory" tab.
3. When defining global variables, proceed in exactly the same way as when defining a local
variable in a String parameter for the subclass definition objects. See also chapter Using the
"Name directory" tab (Page 129).

Structure of the "Name directory" table

The global variables are defined in the "Name directory" table. The table structure is virtually
identical to the subclass definition objects.
Differences:
• No COMOS unit
• No "SetFunction" column
• Only one flag: "Rule"
Because only global variables are defined in the name directory of the "Folders for class/subclass
definitions" object, there is no "SetFunction" column and only the "Rule" flag.

Using the "Rule" flag

If you activate the "Rule" flag, you have to configure the String parameter in such a way that it
returns both a COMOS value and a PDMS value.
Result: The interface compares the two values before every interface operation and only
executes the operation if the values are identical.

2.9.6.5 Using pre/post executables

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

3D Integration Administration
114 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
To execute a PML function before an interface operation is executed or after it has been
completed, proceed as follows:
1. Declare the PML function.
– Signature:
If "Uses query" = "Yes"
!!NamePMLFunktion(!InterfaceOp is String, !config is Boolean, !
arg1 is String, !arg2 is String, ...)
If "Uses query" = "No"
!!NamePMLFunktion(!InterfaceOp is String, !arg1 is String, !
arg2 is String, ...)
– Parameter InterfaceOp: The name of the interface operation before or after which the
PML function is executed.
– Parameter !config: Required only if you select the value "Yes" in the "Before call" or
"After call" table in the "Uses query" column.
– Parameter arg1, arg2, ...: Name of any number of global String parameters:
optional parameter
2. Implement the PML function.
3. Open the properties of the "Folders for class/subclass definitions" object.
4. Switch to the "Attributes > Pre/Post executables" tab.
5. If the PML function is executed before the start of the interface operation, register it in the
"Pre executables" table.
If the PML function is executed after completion of the interface operation, register it in the
"Post executables" table.
To register a PML function for an interface operation, proceed as follows:
– "Executable" column:
Enter the name of the PML function from step 1.
– "Query" column:
Select "Yes" if the PML function is to execute a COMOS query. The function must have been
implemented accordingly.
The PML function is then called twice. Initially with !config = TRUE:
Implement the function in such a way that the config file for the query is configured in the
function and sent to COMOS.
COMOS then executes the query and the function retrieves the results.
For the second time with !config = FALSE:
Function operates with results
Select "No" if the PML function does not use a COMOS query.
– "Export", "Assign", "Refresh", "Check status", "Import ", "MTO import" columns:
Select "Yes" to register the PML function for these interface operations.
You can find additional information on this topic in the "3D Integration Operation" manual,
keyword "List of interface operations and internal names".

3D Integration Administration
Operating Manual, 03/2021 V10.4 115
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

See also
"Pre/post executables" tab (Page 168)
"Pre/post executables" definition (Page 100)

2.9.6.6 Using character mapping

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

Procedure
To define those characters which are permitted in COMOS but not in PDMS and are replaced
during character mapping, proceed as follows:
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > Character mapping" tab.
3. Configure the table which you find on this tab.
For each line, define an illegal character along with the character which is to replace the
illegal character in PDMS. Proceed as follows:
– "Comos" column: Enter the illegal character.
– "PDMS" column: Enter the character which is to replace the illegal character.
Enclose the characters in single quotation marks.

See also
"Character mapping" tab (Page 168)
"Character mapping" definition (Page 100)

2.9.6.7 Using unit mapping

With the unit mapping, you define how units in PDMS and COMOS are mapped to one another
if a different unit has been assigned to an attribute in COMOS than in PDMS.

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

3D Integration Administration
116 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Open the properties of the "@PDMSMAP Folders for class/subclass definitions (PDMS)" object.
2. Select the "Attributes > Unit mapping" tab.
3. Configure the table which you find on this tab:
– "Name" column: The name of the mapping entry
The name is displayed in the name directory in the "Unit" column.
– "Unit in PDMS" column: No longer used.
– "Unit group in COMOS" column: The unit group to which the unit entered in "Unit in
COMOS" belongs.
The unit group establishes the connection between the unit at the COMOS attribute and
unit, which is specified in PDMS or expected during an exporting to PDMS.
– "Unit in Comos" column:
With export to PDMS: The unit into which the values registered in COMOS attributes are
to be converted. This is the unit that is expected in PDMS.
With import from PDMS: The unit of imported PDMS values, which is to be converted into
the unit of a COMOS attribute.
Note: During the import/export there is no explicit check whether the attribute actually
uses the unit specified in the unit mapping in PDMS. The interface assumes that the
correct unit has been entered.

Result
The mapping entries defined here are available in the name directory.
• During import:
The value from PDMS is converted to the unit that exists for the COMOS attribute.
• During export:
The value from COMOS is converted to the unit, that is specified in the "Unit in COMOS"
column.

See also
"Unit mapping" tab (Page 169)
"Unit mapping" definition (Page 100)

2.9.6.8 Using ZONE mapping and SITE mapping

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Note on the "Folders for class/subclass definitions" object (Page 111).

3D Integration Administration
Operating Manual, 03/2021 V10.4 117
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > General" tab.
3. Enable the "Use ZONE and SITE mapping" option in the "General properties" control group.
Note
Deactivation locks the "Export" menu
If you deactivate the option and the subclass of an interface object prescribes that the object
is located under a site or a zone in PDMS, the "PDMS > Export" command will be locked in the
context menu of the COMOS interface object. You cannot create any SITES or ZONES.

4. SITE mapping: Switch to the "SITE mapping" tab.

5. ZONE mapping: Switch to the "ZONE mapping" tab.
6. Configure the mapping table. The configuration is similar to that of the name mapping for the
subclass definition object.
Differences:
– Configure the table in such a way that the mapping entries generate the name of a SITE
or ZONE.
– Mapping is only performed for one direction: It generates the PDMS name of a SITE or
ZONE.
– There are no level rules.
– The structural behavior has no influence.

Result
If a user requests COMOS objects in the COMOS PDMS Interface, names for PDMS SITES and
ZONES are created for cables and devices based on the defined rules. The SITES and ZONES are
created in COMOS PDMS Interface and the COMOS objects are sorted underneath them.

Note
Display in the "COMOS objects" area depends on mapping
If you do not configure SITE mapping and ZONE mapping, all objects are stored parallel to one
another in the "COMOS objects" area of the PDMS/E3D Engineering Interface.
If you have only configured one of the two tables or the configurations cannot be evaluated, the
objects are created under a "Not categorized" node.

See also
"SITE mapping" and "ZONE mapping" tabs (Page 169)
Configuring the generation of a COMOS object path (Page 237)
"ZONE mapping" and "SITE mapping" definition (Page 101)

3D Integration Administration
118 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.7 Creating a class definition object

Requirement
• The "Folders for class/subclass definitions" object is created.
See chapter Creating folders for definitions with class objects (Page 74).
• You are familiar with the terminology.
See chapter Definitions for classes and subclasses in the iDB (Page 89).

Procedure
You can only create one class definition object for each class.
To create a class definition object, proceed as follows:
1. Click the "Units" tab in the Navigator.
2. Select the "Folders for class/subclass definitions" object in the Navigator.
3. Select the "New" command from the context menu and select the required class.
If you have already created a class definition object for the class, the class will no longer be
available in the context menu.

Defining the properties of the class

You define the subclass for the class by creating subclass definition objects under a class
definition object.

Name of the class definition object

You recognize the mapping of a class definition object to a class based on its name.
When creating the object, COMOS automatically enters a name - depending on which class you
selected under "New" in the context menu.
Do not change the name of the class definition object.

See also
Creating subclass definition objects (Page 120)

3D Integration Administration
Operating Manual, 03/2021 V10.4 119
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.8 Creating subclass definition objects

Requirement
• The class definition objects supplied with the iDB are created.
See chapter Creating folders for definitions with class objects (Page 74).
• Alternatively, you have created your own class definition objects.
See chapter Creating a class definition object (Page 119).

Procedure
To create a subclass definition object, proceed as follows:
1. Click the "Units" tab in the Navigator.
2. Open the "Folders for class/subclass definitions" object in the Navigator.
3. Select the class definition object under which you want to create a subclass definition object.
4. Select the "New > <Subclass definition object>" command from the context menu.
5. Open the properties of the subclass definition object.
6. In the "Name" property, enter the name of the subclass which describes the objects that
belong to the subclass. See also chapter Reference to the standard table for subclasses
(Page 165).
7. Enter a description in the "Description" property.

Result
• The subclass definition object is created.
• The subclass definition object is automatically assigned the class that is entered as the name
of its class definition object.

Adding a subclass to a standard table

Subclasses can be added to the standard table for subclasses. See also chapter Administering
standard tables for classes and subclasses (Page 108).

3D Integration Administration
120 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.9 Configure subclass definition objects of classes "Cable" and "Tagged item"

2.9.9.1 Defining PDMS element types

Procedure
To define which PDMS element types are permitted for interface objects of this subclass, proceed
as follows:
1. Open the properties of the subclass definition object.
2. Switch to the "Attributes > General" tab.
3. Click on a field in the "Name" column in the "PDMS element types" table.
A list is displayed in the field.
4. Open the list and select the required element type from the list.
The type is entered in the field. COMOS automatically adds a new line to the bottom of the
table.
5. Repeat step 3 until you have entered all required element types.

Result
Only PDMS element types defined in this way are available to the user in the interface objects of
this subclass.

2.9.9.2 Defining structural behavior

Procedure
To define the structural behavior of an interface object of this subclass, proceed as follows:
1. Open the properties of the subclass definition object.
2. Switch to the "Attributes > General" tab.

3D Integration Administration
Operating Manual, 03/2021 V10.4 121
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

3. In the "Structural behavior" control group, "Creation mode" list, define whether the COMOS
object connected to the PDMS interface object is located in the unit tree or in the location
tree.
Possible values:
– "Create in unit tree": Site mapping is performed to find or create the COMOS interface
object.
– "Creation in location tree": Location mapping is performed to find or create the COMOS
interface object.
– "None": You can find information on this in the reference part of this document, in
chapter "General" tab (Page 166).
4. "Structural behavior" control group, "Assign mode" list:
Define whether the COMOS interface object references another COMOS object and if the
referenced object is located in the unit tree or in the location tree.
The values that are offered to you are determined by which "Creation mode" you have set.
Possible values in the "Assignment mode" list:
– "Assign object in the unit tree": The COMOS interface object gets a unit reference. The
referenced object is determined by means of site mapping.
– "Assign location in the location tree": The COMOS interface object gets a location
reference. The referenced object is determined by means of location mapping.
– "None": The interface object gets no reference.

See also
Definition and tasks of the area pipes (Page 96)

2.9.9.3 Defining the base object for the creation of interface objects

Possible alternatives
There are three ways of defining which base object is used to create an interface object in
COMOS:
1. Specify the base object on the "General" tab of the corresponding subclass definition object.
2. Specify the base object by mapping the name of the corresponding subclass definition object.
This is the method used in this document.
3. Enter the SystemFullName of the base object in the following UDA ":ComosBaseOb" of the
PDMS interface object.
This method offers you the most flexibility but it is also the most complex, since the UDA is
set manually for each PDMS interface object.

3D Integration Administration
122 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
To define which base object is used to create the interface objects of this subclass in COMOS,
proceed as follows:
1. If PDMS interface objects of this subclass already exist: Make sure that the ":ComosBaseOb"
UDA of the PDMS interface object is empty. If not, the interface will use the base object that
is entered in the UDA.
2. Open the properties of the subclass definition object.
3. Go to the "Attributes > Name mapping" tab.
Make sure that no base object has been defined for the mapping entry on the far right in the
site mapping or location mapping.
4. Switch to the "Attributes > General" tab.
5. "Base object for creating objects" control group, "Create in unit tree" reference:
In order to create the interface object in COMOS, you define which base object will be used
during the site mapping with a drag-and-drop operation.
If one of the following values is set in the "Structural behavior" control group, set a base object
reference:
– Creation mode: "Create in unit tree"
– Assign mode: "Assign to object in unit tree"
6. "Base object for creating objects" control group, "Create in location tree" reference:
Using drag&drop, specify which base object is used during location mapping to create the
interface object in COMOS.
Has to be set if one of the following values is set in the "Structural behavior" control group:
– Creation mode: "Create in location tree"
– Assign mode: "Assign to location in location tree"

See also
Algorithm 1 for generating a COMOS object path (Page 235)

2.9.9.4 Automatically inserting additional hierarchy levels

You can specify that a hierarchy level will be added in the "COMOS objects" area of the PDMS/E3D
Engineering Interface for COMOS objects that are assigned to a specific subclass and have a two-
level structure.

Note
The functionality only works if the top object of the three-level structure in the PDMS/E3D
Engineering Interface is located below a ZONE.
Top-level objects are objects that can be created directly below ZONEs.

3D Integration Administration
Operating Manual, 03/2021 V10.4 123
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

You can use this function for the following objects:

• Equipment with nozzles, such as vessels
When you request equipment with nozzles from COMOS in the interface, you can specify that
a three-stage structure is automatically created in the interface.
Example:

COMOS PDMS/E3D Engineering Interface

Containers Containers
PDMS type: EQUI
SUBE
The SUBE is created by the "Owner subclass" function.
Nozzles Nozzles
PDMS type: NOZZ

• When working with KKS: for pipe parts, such as valves

When you are working with the KKS labeling system and request pipe parts in the interface
which are included in a two-stage structure in COMOS, you can specify that a three-stage
structure is automatically created in the interface.
Example:

COMOS PDMS/E3D Engineering Interface

Pipe branch PIPE
Pipe branch
PDMS type: BRAN
The pipe branch is created by the "Owner subclass" function.
Valve Valve
PDMS type: VALV

Procedure
1. Open the properties of a subclass for nozzles or for pipe parts.
2. Open the "Attributes > General" tab.
3. For nozzles:
In the "Owner subclass" list, select a subclass that has a "SUBE - Sub equipment" entry as
"PDMS element type". Make sure that the element type of all objects of the structure involved
adhere to the PDMS rules.
For pipe parts:
In the "Owner subclass" list, select a subclass that has a "BRAN - Branch" entry as "PDMS
element type". Make sure that the element type of all objects of the structure involved adhere
to the PDMS rules.
4. Open the "Attributes > Owner restriction rules" tab.
5. For nozzles:
Select the "SUBE - Sub equipment" entry from the "Element type of owner" list.
For pipe parts:
Select the "BRAN - Branch" entry from the "Element type of owner" list.

3D Integration Administration
124 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Result
When objects listed above that are contained in a two-level structure in COMOS are requested
in the interface, a three-level structure is automatically created in the PDMS/E3D Engineering
Interface. An object is created for the object that is missing in the COMOS structure; this object
has the PDMS element type "SUBE" or "BRAN".
You can create virtual objects and the underlying hierarchies in PDMS. You can find additional
information on this topic in the "3D Integration Operation" manual, keyword "Creating objects
in PDMS".

2.9.9.5 Specifying restriction rules for owners

Requirement
You are familiar with the objective of the restriction rules for owners. See also chapter "Owner
restriction rules" definition (Page 98).

Rule types
The following rule types exist:
• The PDMS element type that the owner must have in PDMS.
• An expression which is evaluated by the owner and must be true.
• A filter which checks whether a given owner attribute contains a specific occur string.

Rule type "Defining PDMS element types"

1. Open the properties of a subclass definition object.
2. Go to the "Attributes > Owner restriction rules" tab.
3. In the "Element type of owner" list, select the PDMS element type that the owner of the
interface object must have in PDMS.
In PDMS/E3D, the object is exclusively created below the owner with this element type.
4. Special case: Element type is "LISTTYPES"
– In PDMS/E3D, all element types are permissible as owner.
– PDMS/E3D controls the owners under which the object is created.
– In the end, the object may have been created below many owners in PDMS/E3D.
5. Optional: In the "Conditions" control group, define any number of expressions and/or filters
which are applied to the potential owner. See section "Defining filters".
Result:
When the potential owner conforms to the rules, the object can be created below the owner.

3D Integration Administration
Operating Manual, 03/2021 V10.4 125
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Rule type "Defining expressions"

1. In the top table in the "Conditions" control group, click in the "Expression" column.
2. Enter an expression for which the following applies:
– Expression is compatible with a PDMS block object
– Expression returns a boolean type value
3. Press <Enter> to confirm your entry.
Result:
When the potential owner conforms to the rules, the object can be created below the owner.
• The expression is evaluated in PDMS at the potential owner.
– Return value "True": The owner meets the condition.
– Return value "False": The owner does not meet the condition.
• A line for another expression is added to the table.
Example:
name.Substring(1,2).eq('EP')

Rule type "Defining filters"

1. In the bottom table in the "Conditions" control group, click in the "Attribute" column.
2. Enter the name of the attribute as it is defined in PDMS.
3. Click in the "Occur string" column.
4. Enter a value which is to be evaluated at the attribute.
You can enter the following values:
– String
– Local or global variable
Exception: Do not use local variables which get their value from PDMS.
5. Press <ENTER> to confirm your entry.
Result:
The filter is evaluated in PDMS at the potential owner.
• If you have entered a string: The object can be created below the owner if the string is a
substring of the attribute.
• If you have entered a variable: The object can be created below the owner if the value of the
variable is a substring of the attribute.

2.9.9.6 Configuring the model

Requirement
If you are using design templates, the design templates must be imported from PDMS.

3D Integration Administration
126 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

You can find information about importing design templates in chapter Importing AVEVA design
templates (Page 153).

Inheritance of model information to interface objects

The database is configured in such a way that the interface objects apply the model information
from their subclass.
If the interface objects are to use different model information from what is specified by their
subclass: Define different model information in the base objects of the interface objects.
Users can overwrite the settings taken from the subclass or the base objects in the engineering
view.

Procedure
To define model information at the subclass definition object, proceed as follows:
1. Open the properties of the subclass definition object and switch to the "Attributes > Model"
tab.
2. If the geometry is based on a design template: Enter the GTypes in the "GTypes for filtering"
field. Define the GTypes that are available for selection in design templates.
If you enter multiple GTypes, use ";" as a separator.
3. In the "Mode" list, define how the model is generated. Select one of the following modes:

Mode Subclass of "Cable" Subclass of "Tag‐ Result

class ged item" class
"Design template" / Available for sub‐ The geometry is based on a design
classes with the template.
"EQUI" PDMS ele‐
ment type
"PDMS element" / Available The geometry is copied from an ex‐
isting PDMS element.
"Function" Available Available The geometry is generated by a
function which is also performs oth‐
er initializations.
"None" Available Available A box is generated.

4. You define the details for the generation of the model based on which mode you have
selected. See also chapter Overwriting the inherited model information (Page 155).

See also
"Model" tab (Page 173)

3D Integration Administration
Operating Manual, 03/2021 V10.4 127
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.9.7 COMOS rules

2.9.9.8 PDMS/E3D rules

2.9.10 Configure 'MTO (PDMS)' class

Procedure
1. Create the "Folder for class/subclass definitions (PDMS)" object.
You can find more information on this topic in the manual "3D Integration Administration",
keyword "object "Create folder for classes / subclasses definitions" (Page 111)".
2. Use the context menu to create the "Class - MTO (PDMS)" object below this.
3. Open the "Attributes > General" tab in the properties of the object.
4. Optional: Edit the paths to the base objects.
– Select another object in the "Base object for MTO object" field.
This base object is used to generate imported MTO objects.
– Select another object in the "Base object for bolts" field.
This base object is used to generate imported bolts.
– Select another object in the "Base object for revision folder" field.
This base object is used to generate imported revision folders.
5. From the "Subclass for generating pipelines" list, select a subclass to be used for generating
pipelines after the import.
6. Optional: Configure the import of pipe lengths.
Activate the option "Import pipe length".
Enter the NestedName of the COMOS attribute you want to use in the "Pipe length attribute”
field. The representation type has to be “List” in the properties of the attribute.
7. Optional: Activate the option "Import PDF from Isodraft".
– During each offline import of MTO material in COMOS, a PDF file is searched for and
imported if available.
The name of the PDF file is the name of the pipe in PDMS/E3D.
– During each online import of MTO material, a PDF is also generated and imported in PMDS/
E3D.
For each pipe of which the material is determined, the isometric drawing is exported to
a PDF file. The name of the PDF file is the name of the pipe in PDMS/E3D.
The name of the PDF file is saved in the "PDFFile" attribute. The import is controlled in the
following function: "SAGExportIsoPDF".
You can find more information on the import of material from PDMS/E3D in the manual "3D
Integration Operation", keyword "Generate material (MTO) from PDMS/E3D".

3D Integration Administration
128 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

8. Optional: In the "Bolting" table, change the attributes in which the properties of imported
objects are to be stored.
9. Select the "Name directory" tab.
Configure the table.
See also chapter Using the "Name directory" tab (Page 129).

2.9.11 Using the "Name directory" tab

2.9.11.1 Objective of the name directory and the String parameters

Requirement
• The definition of "String parameter" is known.
See chapter "String parameter" definition (Page 97).

Tasks of the "Name directory" tab or the "String parameter" tab

The name directory is a table in which each line defines a string parameter.

Note
Different meaning of "String"
A "String parameter" does not require that the PDMS type "String" is used in the "Name directory"
tab. The term "String parameter" is also used when any other PDMS type is used.

"String parameter" is used to carry out the following tasks:

• Saving a COMOS value in a PDMS object (export)
• Saving a PDMS value in a COMOS attribute (import)
• Generation of a mapping component in the name mapping (variable definition)
• Comparison of a COMOS value delivered in the String parameter with the PDMS value
delivered in the String parameter ("Check status")
• Check during the export using the String parameter whether it is permissible to create an
object below a specific owner.

3D Integration Administration
Operating Manual, 03/2021 V10.4 129
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Variants of a String Parameter

To solve the above tasks, a String parameter can have the following contents:

Value comes from COMOS Value comes from PDMS

• Attribute value of the interface object that is currently be‐ • Attribute value of the PDMS Interface object that is set as
ing processed by the interface operation that is evaluating the current element.
the name directory. • Value that is returned by a PDMS expression. The PDMS
• Any other property of an object other than the interface expression is evaluated once the currently examined
object, such as the name or the label. PDMS Interface object has been set as the current element.
• Fixed string • Fixed string
• Special case: Attribute value of an object other than the
interface object.

Evaluation of the String parameter

The name directory is evaluated in the following cases:
• During the following interface operations: compare values, export or import values. These
are usually attribute values.
• If a string parameter is used in a subclass definition object on the "Name mapping" tab to
generate one of the following components of a PDMS name part:
– Prefix
– Postfix
– Data item
– Base object
• If objects are filtered in the "Export to Comos" PDMS mask.
• If a string parameter is transferred to a PML function as a parameter. For example, if a String
parameter is used in an initialization function in a subclass definition object on the "Model"
tab.

2.9.11.2 Opening the "Name directory" tab

Requirement
• You are familiar with the purpose.
See chapter Objective of the name directory and the String parameters (Page 129).

3D Integration Administration
130 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

User interface

Procedure
1. Open the properties of the subclass definition object.
See chapter Creating subclass definition objects (Page 120).
2. Switch to the "Attributes > Name directory" tab.
3. Configure the "Name directory" table:
The number and order of the columns can change to a small degree depending on the object
type.
– Enter the unique name used to address the String parameter in the "Name" column.
– Configure the remaining columns according to the task of the string parameters.
See chapter Structure of a String Parameter (Page 131).

2.9.11.3 Structure of a String Parameter

Requirement
• The purpose of the String parameters is known.
See chapter Objective of the name directory and the String parameters (Page 129).
• The "Name directory" tab is open.
See chapter Opening the "Name directory" tab (Page 130).

3D Integration Administration
Operating Manual, 03/2021 V10.4 131
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Overview
Each line defines a String parameter. The number and order of the columns can change to a small
degree depending on the object type.

Task / Name of the column Meaning of the column

Col‐
umn
group
Name Column: "Name" Displayed in the interface for identification.
Value Columns: "COMOS attrib‐ The value is determined or set by combining the columns on the left in different ways. The allowed
of the ute", "Xvalue" combinations can be found in chapter Configuring the "Comos attribute", "PDMS attribute/expression",
String Columns: "PDMS attribute/ "GetFunction", and "SetFunction" columns (Page 132).
param‐ expression", "PDMS type"
eter
"GetFunction" column
"SetFunction" column
"Xvalue" column Xvalues are used in COMOS to technically combine several values which belong together in their con‐
tent. See chapter "Xvalue" column (Page 134).
"PDMS type" column Data type transferred to the PLM function in PDMS and into which the string of the string parameter is
converted in PDMS If no PLM function is used, the type of the PDMS attribute is used.
• "BORE"
This type was introduced especially for processing nominal diameters. The "BORE" type is used in
PDMS for this purpose and a standard table is evaluated in COMOS. See chapter Application: Using
a nominal diameter (Page 137).
"Unit" column Defines the unit that is expected by or will be transferred by COMOS and PDMS. Values can be converted
as appropriate.
You are offered the entries from the unit mapping in the "Folders for class/subclass definitions" folder.
See also chapter Using unit mapping (Page 116).
"Column" column • Application: Transfer of nominal diameter to the "BORE" PMDS type.
• Planned application for future versions: Access to a COMOS attribute of the "List" representation
type.
Flags Flags control the behavior of the interface.
"Check status" column See chapter "Check status" column: Configuring a value comparison (Page 135).
"Export", "Import" column: See chapter Export application: Export COMOS value to PDMS object (Page 136) and chapter Import
application: Import PDMS value into COMOS attribute (Page 137).
"Admin" column See chapter "Admin" column: Generate additional control elements (Page 134).
"Number of decimal pla‐ Number of decimal places defines the tolerance up to which a comparison of a COMOS value and a
ces" column PDMS/E3D value is treated as consistent. Assumes the "REAL" PDMS type.
"Filter" column Not used
"Rule" column See chapter "Rule" column: Checking an owner (Page 135).

2.9.11.4 Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and

"SetFunction" columns

Requirement
• The structure of the string parameters is known.
See chapter Structure of a String Parameter (Page 131).

3D Integration Administration
132 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Permissible entries
Which of these columns you configure and which entries are permitted depends on the purpose
for which you are using the String Parameter.

Action Column Permissible entries

Get value from COMOS Column: "Comos attribute": • Attribute name
(if required: with evaluation of "Xval‐ • Fixed string
ue")
• Call of an owner method
Set value in COMOS Column: "Comos attribute": • Attribute name
(if required: with evaluation of "Xval‐
ue")
Get value from PDMS "PDMS attribute/expression" column: • Attribute name
or • Expression
• Fixed string
"GetFunction" column: • Name of a GetFunction
Set value in PDMS Column: "PDMS attribute/expression": • Attribute name
or
"SetFunction" column: • Name of a SetFunction

Notation
Use the following notation:

Column Notation
"Comos attribute" • Attribute name:
Use the NestedName: "<TabName>.<AttributeName>"
The String Parameter returns the DisplayValue of the attribute.
• Fixed string:
Set the fixed string inside double quotation marks.
• Call of an owner method:
Enter an instruction in the field that outputs the desired value. Use the key
word Owner. The same functions and properties are available as in the CO‐
MOS Object Debugger.
Example: The String Parameter should return the label of the owner of the
currently processed interface object: "Owner.Label"
"PDMS attribute/ • Attribute name:
expression" Enter the name of the PDMS attribute.
• Expression:
Enter the PDMS expression.
• Fixed string:
Set the fixed string inside single quotation marks.

3D Integration Administration
Operating Manual, 03/2021 V10.4 133
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Column Notation
"GetFunction" Enter the name of the GetFunction which is to be executed in PDMS. The Get‐
Function returns a PDMS value.
Example: "!!GetPurpose()"
"SetFunction" Enter the name of the SetFunction which is to be executed in PDMS. The Set‐
Function writes a value to PDMS.
Example: "!!SetPurpose()"

2.9.11.5 "Xvalue" column

Requirement
• The "COMOS attribute" column is known.
See chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction",
and "SetFunction" columns (Page 132).

Overview
Xvalues are used in COMOS to technically combine several values which belong together in their
content. Main application areas:
• Range attributes: Attributes that have a minimum value and a maximum value
Minimum: Xvalue = 0. Maximum: Xvalue = 1
• List attributes: Attributes that can store any number of values in the form of a list
First list value: Xvalue = 0
nth list value: Xvalue = n-1
• Memo field
The XValue index starts with "0". If the "Index" field is empty, the Value is used.
In the interface described here, using the "Xvalue" column is supported if the following PDMS
type is set:
• REAL

See also
Import application: Import PDMS value into COMOS attribute (Page 137)
Export application: Export COMOS value to PDMS object (Page 136)

2.9.11.6 "Admin" column: Generate additional control elements

Follow the procedure below so that the String parameter generates one of the following
components of a mapping entry in the name mapping.
• "Data item"
• "Prefix"

3D Integration Administration
134 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

• "Postfix"
• "Fixed name"

Procedure
Configure the following columns of the String parameter:
1. Select the "Yes" entry in the "Admin" column.
2. Define which string the String parameter returns in one of the following columns:
– "COMOS attribute" (if required: with evaluation of "Xvalue")
– "PDMS attribute/expression"
– "GetFunction"
If more than one column is set, following priority applies:
"Comos attribute" > "GetFunction" > "PDMS attribute/expression"
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 132).
3. Select a data type in the "PDMS type" column.

2.9.11.7 "Check status" column: Configuring a value comparison

Follow the procedure below so that an interface operation compares the values of a COMOS
object returned by the String parameter with the values of the PDMS object connected to it.

Procedure
1. Select the "Yes" entry in the "Check" column.
2. You access a COMOS value and a PDMS value by setting a value in the columns "Comos
attribute" (if required: with evaluation of "Xvalue") and "PDMS attribute/expression" or in the
"GetFunction" column.
Note
When the "GetFunction" and "PDMS attribute/expression" columns are set, GetFunction has
a higher priority.
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 132).
3. Select a data type in the "PDMS type" column.

2.9.11.8 "Rule" column: Checking an owner

Follow the procedure below so that the "Export" interface operation uses the String parameters
to check whether it is permissible to create an object below a specific owner.

3D Integration Administration
Operating Manual, 03/2021 V10.4 135
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Select the "Yes" entry in the "Rule" column.
2. You access a COMOS value and a PDMS value by setting a value in the columns "Comos
attribute" (if required: with evaluation of "Xvalue") and "PDMS attribute/expression" or in the
"GetFunction" column.
The PDMS expression GetFunction is called at the potential owner of the object that is to be
created in PDMS.
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 132).
3. Select a data type in the "PDMS type" column.
The object is only created if the values are the same.

2.9.11.9 Export application: Export COMOS value to PDMS object

Procedure
1. Configure the "Comos attribute" column.
Permitted values:
– Attribute name
– Fixed string
– Call of an owner method
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 132).
2. If required: Set a natural number in the "Xvalue" column.
The index starts at "0". See chapter "Xvalue" column (Page 134).
3. Configure the "SetFunction" or "PDMS attribute/expression" column: See also
chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns (Page 132).
Note
When the "SetFunction" and "PDMS attribute/expression" columns are set, SetFunction has a
higher priority.

4. Select a suitable entry in the "Unit" column.

You are offered the entries from the unit mapping in the "Folders for class/subclass
definitions" folder. See also chapter Using unit mapping (Page 116).
5. Specify the data type that is to be transferred to the PML function in the "PDMS type" column.
6. Select the "Yes" entry in the "Export" column.
Note
If the "Export" and "Import" columns are activated, the "Export" column has a higher priority.
The "Import" column is not evaluated.

3D Integration Administration
136 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.11.10 Import application: Import PDMS value into COMOS attribute

Procedure
1. Enter an attribute name in the "Comos attribute" column. See also chapter Configuring the
"Comos attribute", "PDMS attribute/expression", "GetFunction", and "SetFunction" columns
(Page 132).
2. If required: Set a natural number in the "Xvalue" column.
The index starts at "0". See chapter "Xvalue" column (Page 134).
3. Configure the "PDMS attribute/expression" or "GetFunction" column. See also
chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns (Page 132).
Note
When the "GetFunction" and "PDMS attribute/expression" columns are set, GetFunction has
a higher priority.

4. Select a suitable entry in the "Unit" column.

You are offered the entries from the unit mapping in the "Folders for class/subclass
definitions" folder. See also chapter Using unit mapping (Page 116).
5. Specify the data type that is to be transferred to the PML function in the "PDMS type" column.
6. Select the "Yes" entry in the "Import" column.
Note
If the "Export" and "Import" columns are activated, the "Export" column has a higher priority.
The "Import" column is not evaluated.

2.9.11.11 Application: Using a nominal diameter

Requirement
• The "PDMS Type" column and the "Column" column are known.
See chapter Structure of a String Parameter (Page 131).

Procedure
There is a standard to avoid rounding errors when converting nominal diameters into other
units. This standard contains a list of selected nominal diameters in inches and the assignment
of nominal diameters in other units, for example in mm.
• In COMOS, there is a standard table with these standardized assignments of nominal
diameters in the various units.
• In PDMS/E3D, nominal diameters are stored as the "Bore" type.

3D Integration Administration
Operating Manual, 03/2021 V10.4 137
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

To exchange nominal diameters between COMOS and PDMS/E3D, proceed as follows:

1. Open the "Name directory" tab.
2. "PDMS type" column: Select the "BORE" list entry.
3. "COMOS attribute" column Enter a COMOS attribute with a standard table.
Standard case:
– Display type: "Edit field"
– Type: "Alphanumeric"
– "Standard table": "Y10 > M20 > Y30 > A10 > 10 > ANSI/ASME > A50 Nominal diameters"
COMOS automatically displays the edit field as an edit field.
4. "Column" column: Enter the index with which a column is called up in the COMOS standard
table.
– The index starts with "0".
Example: If you want to call up the "Value 1" column in the COMOS standard table, enter
the value "0" in the "Column" column in the "Name directory" tab.
– If no index is specified in the "Column" column, the "Description" column is provided from
the COMOS standard table.

2.9.12 Configuring site mapping and location mapping in name mapping

2.9.12.1 Structure of the tables for unit mapping and location mapping
You will find the tables for unit mapping and location mapping at the subclass definition objects
of the "Cable" and "Tagged item" classes in the "Name mapping" tab.
Each table has two purposes:
• Generate a PDMS/E3D name
• Generate a COMOS object path
– Derive COMOS hierarchy and name of the COMOS object to be created.
– Define base objects for generating the hierarchy and the COMOS object.
– Assign a reference from one COMOS object to another COMOS object.
The tables are also used for the following operations in the Engineering Interface:
• "Assign by matching names" operation
• When updating the PDMS/E3D name: "Update names" operation

3D Integration Administration
138 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Number Description
1 The columns show the name components of a PDMS name.
2 These rows are used for generating a PDMS/E3D name.
3 These rows are used for generating a COMOS object path and for creating the objects.
4 The columns show the hierarchy levels of the COMOS object path.

The mapping function is different in the plugins "COMOS PDMS Engineering Interface" and
"COMOS PDMS Interface".
• See also chapter Mapping for the COMOS PDMS Interface (Page 140).
• See also chapter Mapping for the COMOS PDMS Engineering Interface (Page 140).

3D Integration Administration
Operating Manual, 03/2021 V10.4 139
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Use of unit mapping or location mapping

The creation mode set at the subclass determines which table is evaluated: "General" tab,
"Structural behavior" control group, "Creation mode" list
• "Create in unit tree":
Unit mapping is performed.
• "Create in location tree":
Location mapping is performed.

Creation mode Assignment mode Usage

"Create in unit tree" "Assign to location in location Unit mapping and location mapping
tree"
"Create in unit tree" "None" Unit mapping
"Create in location tree" "Assign to location in unit Unit mapping and location mapping
tree"
"Create in location tree" "None" Location mapping

2.9.12.2 Mapping for the COMOS PDMS Interface

2.9.12.3 Mapping for the COMOS PDMS Engineering Interface

2.9.12.4 Algorithm for generating a PDMS name

A PDMS name comprises a number of name parts. Each column of the "Unit mapping" and
"Location mapping" tables creates a name part. When put together, the entries produce a full
PDMS name.

Elements of a PDMS name part

The PDMS name is defined by the following elements:

Row Description
"Prefix" Optional: The prefix of the PDMS name part.
"Suffix" Optional: The suffix of the PDMS name part.
"Data item" The data item of the PDMS name part.
"Start index" The point where a name part is inserted in the full PDMS name.
"Number of charac‐ The number of characters of the data item that are applied for the name part.
ters"

3D Integration Administration
140 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Algorithm
To generate the name of the PDMS object to which a COMOS object is to be connected, the
interface proceeds as follows:
1. The interface checks which subclass the COMOS object has and evaluates the creation mode
of the subclass definition object:
– "Create in unit tree": Unit mapping is performed.
– "Create in location tree": Location mapping is performed.
2. The columns are evaluated. The following algorithm is executed for each column:
– The data item is evaluated.
– If no data item was defined, the column is skipped. The algorithm continues with the next
column.
– If the data item is longer than is permitted by the "Number of characters" cell, it is
truncated.
– Prefix (if necessary truncated), data item and postfix are combined to form a character
string. The character string represents a name part.
3. All PDMS name parts are combined to form a string which cannot be modified. Each name
part is copied to the position in the string defined by its start index.
4. If the index ranges of two name parts overlap, the name part of the name part evaluated later
overwrites the name part evaluated first.

2.9.12.5 Configuring generation of a PDMS name

Requirement
• You have defined the structural behavior.
• You are familiar with the algorithm for generating the PDMS name. See also
chapter Algorithm for generating a PDMS name (Page 140).

Elements of a PDMS name part

Each PDMS name part is defined by the following elements:

Row Description
"Prefix" Prefix of the PDMS name part.
• Optionally:
• Any number of characters
"Suffix" The suffix of the PDMS name part.
• Optionally:
• Any number of characters

3D Integration Administration
Operating Manual, 03/2021 V10.4 141
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Row Description
"Data item" The data item of the PDMS name part.
Permitted items:
• Composed expression which returns the name or label of an object from the unit tree or location
tree
• String parameter
"Start index" The point where a name part is inserted in the full PDMS name.
If nothing is entered, the name part is appended to the name parts composed up to this point.
"Number of charac‐ The number of characters of the data item that are applied for the name part.
ters" • Number
• Any number of characters permitted

Procedure
1. Open the properties of the subclass definition object of the "Cable" or "Tagged item" class.
2. Select the "Attributes > Name mapping" tab.
3. Identify where objects of the subclass are located or need to be created in your COMOS object
structure. Split the overall path into its individual nodes.
4. Analyze how the PDMS name for objects of the subclass is to be structured. You decide how
many name parts and therefore columns you are using.

3D Integration Administration
142 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

5. Enter a data item in at least one column.

The data item of a mapping entry contains either COMOS data or PDMS data. The following
data is permitted:

COMOS data PDMS data

• Return value of a String parameter which re‐ Return value of a String parameter which returns
turns COMOS data. PDMS data.
• An expression which returns the name or la‐ /
bel of an object in the unit tree.
• An expression which returns the name or la‐ /
bel of an object in the location tree.
Notation of the data item:

Notation of the String Notation of the composed expression

parameter
"!<Name of a local String First element:
parameter>" example: • In unit mapping: "U"
"!Area" • In location mapping: "L"
"!!<Name of a global Second element:
String parameter>" • "<Number>": Structure level in the tree on which the object is located
In unit mapping: Starting from the project root
In location mapping: Starting from the object "Folders for class/
subclass definitions (PDMS)"
Third element:
• "N" or "L": Use the name or label of the object
Example:
"U2L": Use the label of an object on the second level underneath the
project root in the unit tree.

6. Enter a start index and a number of characters in the same column.

7. Optional: Enter a prefix and a postfix.
8. Check which COMOS nodes and PDMS name parts can be mapped directly to one another.
Configure a shared column for these nodes and name parts.
9. Check which COMOS node does not have a corresponding PDMS name part and vice versa.
Configure a separate column for each of these nodes and name parts.
Examples of COMOS nodes which do not have a corresponding PDMS name part:
– Folder
– The PDMS root object in the "Locations" tab
– Other objects that are only used to structure the COMOS data
10.Configure the columns as described in the table below.

3D Integration Administration
Operating Manual, 03/2021 V10.4 143
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.12.6 Algorithm for generating a COMOS object path

To find the COMOS object to which a PDMS/E3D object is to be connected, the "Name mapping"
tab is evaluated at the used subclasses.
• To create an object in COMOS and complete its owner structure, the base objects that are to
be used must be known for each hierarchy level.
• To create the owner structure, COMOS evaluates the "Base object" or "Base object from
structure" row.
• To create the object which is actually searched for, the interface evaluates the UDS
":ComosBaseOb" of the PDMS object.
If the UDA is empty, the interface evaluates the "Base object for creating objects" control
group in the "General" tab of the subclass definition object.
If no base objects are specified in the "Base object for creating objects" control group, the
interface evaluates the "Base object" or "Base object from structure" row in name mapping.
This documentation assumes that this setting is made in the "General" tab.

Algorithm
1. The interface checks the subclass of the PDMS/E3D object.
2. The interface evaluates the creation mode of the corresponding subclass definition object:
"General" tab, "Structural behavior" control group, "Creation mode" list:
– "Create in unit tree": Unit mapping is performed.
– "Create in location tree": Location mapping is performed.
The execution of the mapping tables involves the following steps:
1. If the list entry "Yes" is selected in the "Base object from structure" row:
– The interface assumes that you are working in a KKS structure.
– COMOS navigates to the project structure level that is specified in the current column.
– In a project structure, several objects with different base objects can be prepared for a
single level. The interface compares the data item or fixed name of the column with the
name mask of the possible base objects.
– The object is created with the base object whose name mask matches the data item or
fixed name.
– The data item or fixed name is entered in the "Name" property of the new object.
If the list entry "No" is selected in the "Base object from structure" row:
COMOS navigates to the base object that is specified in the "Base object" row of the current
column.
2. The base object that is to be used for creating the current hierarchy level is derived from the
"Base object" row.
3. The name of the COMOS object to be created is derived from the "Fixname" row.
The entire COMOS hierarchy of the object is composed according to this principle.

3D Integration Administration
144 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Result
• The string written to the path list produces the path to the COMOS interface object you are
looking for.
• If the object does not exist yet, the mapping table returns all needed information in order to
create it. The name part of the last mapping entry is written to the "Name" property of the
COMOS object.
• If the interface detects that the owner structure of the object you are looking for is
incomplete: The mapping table returns all information required to complete the owner
structure.

2.9.12.7 Configuring the generation of a COMOS object path

The next chapter describes the generation of a COMOS object path.

Requirement
• You have defined the structural behavior.
• You are familiar with the algorithm for generating the COMOS object path. See also
chapter Algorithm for generating a COMOS object path (Page 144).

Elements for generating a COMOS path

Row Function Description

"Base object" Base object used to create an object. Used to complete the owner
"Base object from This row is only used for KKS structures. structure of the COMOS object or
structure" to create the object in COMOS.
Specifies whether the base object from the KKS base data struc‐
ture is to be used. You only use one of the two rows.
• "Yes": If the project is linked to a project structure, the project
structure is used for the generation of the COMOS objects.
• "No": Even if a project structure is available and linked, it is not
used.
"Fixname" Name of a COMOS object within the path to a COMOS object.

Procedure
1. Open the properties of the subclass definition object of the "Cable" or "Tagged item" class.
2. Select the "Attributes > Name mapping" tab.
3. To define the base object of the first hierarchy level, enter the following in column "1":
4. When you are working in a KKS structure: In the "Base object from structure" row, select
whether the project structure is to be used when generating the COMOS objects.

3D Integration Administration
Operating Manual, 03/2021 V10.4 145
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

5. If you have selected "No" or are not working in a KKS structure: Enter which base object is to
be used for generating the object.
Possible values:
– SystemFullName of a base object
Use "\" to separate the individual nodes. Without quotation marks
– Local String parameter: "!<Name of a local String parameter>"
– Global String parameter: "!!<Name of a global String parameter>"
6. To define a name for the object that is to be created, enter a value in the "Fixname" column.
Possible values:
– Local String parameter: "!<Name of a local String parameter>"
– Global String parameter: "!!<Name of a global String parameter>"
– Fixed string: Without quotation marks
7. Repeat the steps for the remaining hierarchy levels.
The column that is used last represents the object that is actually going to be created.
This documentation assumes that the base object is defined in the "Base objects for creating
objects" control group in the "General" tab of the subclass definition object. This means you
do not define a base object in the mapping tables in the column that was used last.

2.9.13 Creating and configuring query subclasses

2.9.13.1 Workflow
Users who wish to execute and view COMOS queries in PDMS first have to complete the following
preparatory steps:
• Create however many COMOS queries the user is to execute in PDMS.
These queries are called main queries in the interface.
• Configure the main queries in the usual COMOS way.
• Create a class definition object for the "Query" class.
• For each main query: Create a subclass definition object.
• Configure the subclass definition objects.
• If the user should have the option to select the start object of a main query from a list of
objects in PDMS:
– Create a COMOS query whose result list returns the possible start objects
This query is called the start object query in the interface.
– Configure the start object query.
– Configure the access to the start object query for the subclass definition object.

3D Integration Administration
146 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.13.2 Creating and configuring query subclasses

Procedure
1. For each query that is started from PDMS and viewed, create a main query.
2. Configure the main query.
If you are using an already existing query as the main query, this step is not necessary.
3. If the user should have the option to select the start object of a main query from a list of
objects in PDMS:
Create a start object query and configure it in such a way that it returns useful start objects
for the main query.
If you are using an already existing query as the start object query, this step is not necessary.

2.9.13.3 Creating class and subclass definitions for queries

Creating class for queries

1. Click the "Units" tab in the Navigator.
2. Select the "Folders for class/subclass definitions" object.
3. Select "New > Class - queries (PDMS)" from the context menu.

Creating query subclass definitions

To create a subclass definition object you use to manage a main query and its start object query,
proceed as follows:
1. Select the object "Class - queries (PDMS)" in the Navigator.
2. Select the command "New > Query subclass definition" from the context menu.
A subclass definition for queries is created.
3. Open the "Attributes > General" tab in the properties of the subclass definition.
"PDMS settings" control group:
– "PDMS name" field:
Enter a name for the subclass.
– "Description" field:
Enter a description. If the user has selected the query in PDMS, the description is displayed
in PDMS: "Query Comos" window, "Query" tab, "Description" field

3D Integration Administration
Operating Manual, 03/2021 V10.4 147
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.13.4 Configuring a subclass definition object for queries

Procedure
To configure the subclass definition object you use to manage the main query and the start
object query, proceed as follows:
1. Open the properties of the subclass definition object.
See also chapter Creating class and subclass definitions for queries (Page 147).
2. Switch to the "Attributes > General" tab.
3. In the "Output format" control group, select the format in which the result list of the query
is transferred to PDMS.
– CSV
– XML
4. If CSV is set as the output format, define the column separator in the "Separator" field. You can
define any character as separator.
5. Drag&drop the main query from the Navigator into the "Main query" control group, "Query
object" field.
6. Drag&drop an object into the "Start object" field.
The name of the referenced start object is displayed to the user in PDMS: "Comos Query"
window, "Query" tab, "Start object" field
If you are using an already existing query as the main query, you can define a different start
object than the one set in the main query.
7. Drag&drop the base objects according to which the query is to filter the result list from the
Navigator to the "Base objects" column.
If you are using an already existing query as the main query, you can have the query filtered
in PDMS by base objects other than those defined by the main query in COMOS.
8. "Query for start objects" control group:
9. If the user is to have the option of selecting the start object of a main query from a list of
objects in PDMS, configure the "Query for start objects" control group.
– Drag&drop the query for start objects from the Navigator into the "Query object" field.
The start object query returns the list of possible start objects in PDMS.
– Drag&drop an object into the "Start object" field.
– Drag&drop the base objects according to which the query is to filter the result list from the
Navigator to the "Base objects" column.
If you are using an already existing query as the start object query: You can filter the query
in PDMS on the basis of base objects other than those defined by the main query in
COMOS.

Evaluation priority for the start object

You can define the start object of the query at various places. The following table lists these
places.

3D Integration Administration
148 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

If a start object has been defined in multiple places, the places which appear further down the
table overwrite those above them.

Start object of the main query Start object of the query for start objects
Start object that is set in the COMOS query Start object that is set in the COMOS query
Start object that was set for the subclass definition Start object that was set for the subclass definition
object object
Start object that the user defined in PDMS: /
"Comos Query" window, "Execute" tab

2.9.14 Configuring "Import DocLinks"

2.9.14.1 Defining the entry for the target document in PDMS

The "Import DocLinks" operation is called in PDMS. It creates DocObjs for draft objects under a
COMOS document specified in the draft structure.
To import draft objects into COMOS as DocObjs, the COMOS document for which the DocObjs
are being created must be known.
For this purpose, you should define an attribute or a UDA in which the user will subsequently
enter the name or the SystemUID of the target document.
You decide the levels of the draft structure at which it is possible to specify target documents.

Defining target documents on different levels of the draft structure

You can specify a target document at more than one level of the draft structure. This enables the
user to start the DocLink import as required at different levels of the draft structure, e.g. for all
draft objects of a region, for an individual view or for an individual drawing.
To do this, repeat the below described procedure for all levels for which the "Import DocLinks"
operation needs to be available.

Procedure
To define where the target document is specified, proceed as follows:
1. Define whether the user enters the name of the target document in an attribute or in a UDA
and which attribute or UDA is used.
2. Define the level of the draft structure on which the user specifies the name of the target
document.
3. If you are using a UDA, create the UDA.

3D Integration Administration
Operating Manual, 03/2021 V10.4 149
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

2.9.14.2 Configuring "Import DocLinks" operation in COMOS

Procedure
1. Create a "Document subclass definition" object.
2. Define a String parameter in the name directory of the subclass definition object. The String
parameter is to access the attribute or UDA in which the name or SystemUID of the target
document is entered. See also chapter Defining the String Parameter for the document name
(Page 150).
3. Configure the general properties of the subclass definition object. See also
chapter Configuring general settings (Page 150).
4. Optional: On the "Owner restriction rules" tab, specify whether the owners of the template
objects for which DocObjs are being created have to meet certain conditions.

2.9.14.3 Defining the String Parameter for the document name

Define a String parameter which, from PDMS, reads out the name of the COMOS document
under which the DocObjs are imported.

Procedure
1. Open the properties of the "Document subclass definition" object and switch to the "Name
directory" tab.
2. Configure the "Name directory" table:
– "Name" column: Enter the name of the String parameter.
– "PDMS attribute/expression" or "GetFunction" column: Access the value of the attribute or
the UDA in which the document name or the SystemUID is saved in PDMS. See also
chapter Using the "Name directory" tab (Page 129).
– "PDMS type" column: Enter "String".

2.9.14.4 Configuring general settings

Procedure
To define the general settings of the "Document subclass definition" object, proceed as follows:
1. Open the properties of the "Document subclass definition" object.
2. Switch to the "Attributes > General" tab.
3. "Document ID" field:
– Enter the name of the String parameter which reads out the document name from PDMS.
– Do not precede the name of the String parameter with a "!" character.

3D Integration Administration
150 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

4. Optional: Define filters in the "Base object for document search" control group:
During the search, the interface restricts itself to documents which meet the criteria defined
here. This speeds up the search.
The following filters are possible:
– "Document type" list: Define the document type of the document.
– "Base object for document search" field: Define the base object the document uses.
– "Base object" field: Define the node below which the document is searched.
5. Optional: Activate the "Filter unnamed objects" option:
In PDMS, only objects with a name are displayed in the result list in the "Export to Comos"
window.
6. Enter the PDMS element types of the following template objects in the table: Template
objects with a DDNM attribute that references a design object that is connected to a COMOS
object.

2.9.14.5 Defining owner restriction rules for draft objects

Procedure
You can define owner restriction rules which the template objects have to meet to be imported
as DocObjs.
For this purpose, proceed in the same way as with the definition of owner restriction rules on
subclass definition objects of the "Cable" and "Tagged item" classes. See also chapter Specifying
restriction rules for owners (Page 125).

2.9.15 Synchronizing classes and subclasses in COMOS and PDMS

Requirement
• The "Folders for class/subclass definitions" object is created.
See chapter Creating folders for definitions with class objects (Page 74).

Initial situation
To ensure that COMOS and PDMS use the same settings, the interface does not directly access
the settings for the "Folders for class/subclass definitions" object and for the class and subclass
definition objects. Instead, the settings are written to an XML file in the exchange directory.
COMOS and PDMS load the settings from the file to the working memory of your computer.
When an interface operation is called, the current version number of the "Folders for class/
subclass definitions" object is transferred. The operation checks whether the number is identical
to the version number of the settings stored in the work memory.
• Yes: The settings stored in the work memory are used.
• No: The file is loaded to the work memory again. The settings are synchronized.

3D Integration Administration
Operating Manual, 03/2021 V10.4 151
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

If synchronization was successful, ensure that the file in the exchange directory contains the
current settings.
Update the file whenever you have performed one of the following actions:
• You changed the settings of the "Folders for class/subclass definitions" object.
• You created a new class or subclass definition object.
• You changed the settings of a subclass definition object.

Procedure
To update the file in which the settings for the "Folders for class/subclass definitions" object and
the class and subclass definition objects are saved, proceed as follows:
1. Select the "Folders for class/subclass definitions" object in the Navigator.
2. Select the following command from the context menu: "PDMS > Save subclasses".
This command is also used in the step "Special preprocessing in COMOS". See also
chapter Creating folders for definitions with class objects (Page 74).

Result
• The version number at the "Folders for class/subclass definitions" object is incremented.
• The standard table for subclasses is updated.
• The settings for the "Folders for class/subclass definitions" object and for the class and
subclass definition objects are written to the file in the exchange directory.

2.9.16 Importing classes, subclasses and "Folders for classes/subclasses" object from
XML file

Objective
If you are working in different project structures with different requirements, the classes,
subclasses and the "Folders for classes/subclasses" object must be configured according to the
respective requirements. To avoid having to edit the objects every time you switch to a new
project structure, you can import the completely configured objects from an XML file and have
them created in COMOS.
This means you can create an XML file for each project structure and import it as needed.

Requirement
• The "Folders for class/subclass definitions" object is created.
See chapter Creating folders for definitions with class objects (Page 74).
• You have access to at least one XML file which was previously created or updated using the
"Save subclass" function. You can name the file as you wish.
The XML files are located in the directory that is specified in the SubclassesFile node in
the initialization file.

3D Integration Administration
152 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Procedure
1. Select the "Folders for class/subclass definitions" object in the Navigator.
2. Select the following command from the context menu: "PDMS > Import subclasses".
3. Select the following command from the context menu: "PDMS > Save subclasses".

Result
• If a "Folders for classes/subclasses" object already exists, the object is deleted with all its
classes and subclasses.
• The "Folders for classes/subclasses" object from the XML file is created in the Navigator
together with its classes and subclasses.

2.9.17 Importing AVEVA design templates

Initial situation
You can assign an AVEVA design template to an interface object as a model.
To do this, you need to import the design templates from PDMS into COMOS.

Procedure
1. Switch to the "Base objects" tab in the Navigator.
2. Select the following node: "@20 > D30 > A30 > Y00R00038 Objects for design template
structure".
3. In the context menu, select the following command: "PDMS > Update design templates".

Result
• The GTypes of all templates are evaluated in PDMS.
• The templates are imported from PDMS to COMOS. During this process, the interface
proceeds as described below.

Managing the design templates in the base data

The design templates are managed under the following node in the base data:
"@20 > D30 > A30 > Y00R00038 Objects for design template structure"
The design templates are managed sorted by GType:
• Nodes which represent the GTypes of the templates are located on the first level below the
"Objects for design template structure" object.
• The nodes for the templates are located on the second level. A node is created for each
template.

3D Integration Administration
Operating Manual, 03/2021 V10.4 153
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Algorithm for importing the design templates into the base data
• For each GType found in PDMS, a search is performed below the "Objects for design template
structure" object for a node whose name matches the name of the GType.
• If a node of this type does not exist yet, it is created. The name of the GType is entered in the
"Name" property of the node.
• A node for the design template is created underneath the GType node.
• If the design template already exists, it is updated. No data is deleted during the update
operation.
Example:
– A sub template was deleted in PDMS.
– The sub template remains available in COMOS even after the update.
• The attributes of the template node are automatically set when the template node is created
or during the update.

2.9.18 Configuring COMOS interface objects

2.9.18.1 Assigning the class, subclass, and PDMS element type

Procedure
To assign a class, a subclass, and PDMS element types to an interface object, proceed as follows:
1. Click on the "Base objects" tab in the Navigator.
2. Navigate to an interface base object.
3. Open the properties of the interface base object.
4. Switch to the "Attributes > External 3D Interface" tab.
5. Configure the tab as described below.
6. "Class" list:
– Select a class.
– Do not select the "Undef" value. Otherwise, the object will not be recognized as an
interface object.
7. "Subclass" list:
Select a subclass. Only subclasses permitted for the selected class are offered.
8. "PDMS element type" list:
Select a PDMS element type. Only those element types entered for the selected subclass are
offered.
This workflow has already been mentioned in the chapter "Special preprocessing in COMOS". For
more on this, see Attributes of the "External 3D Interface" tab (Page 157).

3D Integration Administration
154 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Overwriting the preselection in the engineering view

In the database, the edit mode of these attributes is configured in such a way that users can
overwrite the inherited settings in the engineering view, if this is necessary.

See also
Minimum configuration of the E3D tab: Create subclass (Page 69)

2.9.18.2 Overwriting the inherited model information

Requirements
• The following has already been assigned to the interface object:
– Class
– Subclass
– PDMS element type
• AVEVA templates have been imported.

Inheritance of subclasses
The database is configured in such a way that the interface objects apply the model information
settings from their subclass. For this purpose, the model attributes of the interface objects are
linked to those of the subclass definition objects.
Link type: Static link via the "GetLinkedSpecification" script function.
You can overwrite the settings for the base objects of the interface objects taken from the
subclass.

Procedure
To define the model information at the base object of the interface object, proceed as follows:
1. Click on the "Base objects" tab in the Navigator.
2. Navigate to an interface base object.
3. Open the properties of the interface base object and switch to the "Attributes > External 3D
Interface" tab.

3D Integration Administration
Operating Manual, 03/2021 V10.4 155
PDMS/E3D Engineering Interface
2.9 Configuring interface operations

4. Define how the model will be generated in the "Model" control group, "Mode" list. Select one
of the following modes:

Mode Interface object has sub‐ Interface object has Result

class of "Cable" class subclass of "Tagged
item" class
"Design tem‐ / Available if the sub‐ The geometry is based on a de‐
plate" class has the "EQUI" sign template.
PDMS element type
"PDMS ele‐ / Available The geometry is copied from an
ment" existing PDMS element.
"Function" Available Available The geometry is generated by a
function which is also performs
other initializations.
"None" Available Available A box is generated.

5. Depending on which mode you have selected, you now need to define the details for the
generation of the model:
– "Function" mode:
Enter the function call in the "Function" field.
– "PDMS element" mode:
Enter the name of the PDMS element whose geometry is being copied in the "Element"
field.
– "Design template" mode:
Define the main template in the "Design template" control group, along with the used sub
templates which, if applicable.

Defining design templates

If the following conditions are met, you can select design templates as the basis for your model:
• The subclass of the interface object has the "Tagged item" class.
• The subclass has the "EQUI" PDMS element type.
If you select a design template as the basis for your model, you need to configure the "Design
template" control group.
Proceed as follows:
1. Select the main document template in the "Main document template" list.
Only those templates whose GType has been entered in the subclass in the "GTypes for
filtering" field are offered for selection.
If the the "EQUI" PDMS element type is missing at the subclass, the list remains empty.
2. You can define up to five templates for secondary equipment in the "Sub template 1" to "Sub
template 5" lists:
Which templates are offered depends on the main template you selected.

3D Integration Administration
156 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.9 Configuring interface operations

Design templates in the engineering view

When COMOS creates an interface object in the engineering view, it automatically checks
whether the interface object uses a design template. If it does, COMOS creates the main
document template underneath the interface object and the sub templates underneath that.
COMOS creates the template objects when you assign a design template to an existing interface
object.
• Name of the template object: "Y00R00038"
• Description of the template object: As defined at the base object of the template object
You can change the design parameters of the template objects in the engineering view:
Properties of the template object, "Attributes > External 3D Interface" tab, attributes
"Y00A02118AA01 DP 01" through "Y00A02118AA10 DP 10".

Overwriting the base object settings in the engineering view

Users can overwrite both the settings inherited from the subclass and the settings predefined at
the base object in the engineering view.

Restoring the default settings

The settings inherited from the subclass can be restored in the engineering view using the
"Refresh static links on tab" context menu.

See also
Attributes of the "External 3D Interface" tab (Page 157)

2.9.18.3 Attributes of the "External 3D Interface" tab

Function
COMOS objects require the "External 3D Interface" tab in order to be used as an interface object.
The COMOS PDMS Interface evaluates this tab whenever it processes interface objects. Without
this tab, the object is not processed.

Database
In the database, tabs have been prepared for the following interface objects:
• Objects of "Tagged item" class
• Objects of "Cable" class
• For nozzles
The tabs for these objects are located in the following catalog:
"@40 > A20 > Y00 > A10 > A10 > Y00T00012 > A03 > B01 Tabs PI-objects"
From there, they are passed on to the PID device catalog in the database.

3D Integration Administration
Operating Manual, 03/2021 V10.4 157
PDMS/E3D Engineering Interface
2.10 Using pmlib macros

System-internal attributes
The following attributes are used system-internally. Do not configure or delete them:
• "ComosCheckUID Check SystemUID"
• "PDMSNAME Name of the corresponding object in PDMS"
• "PDMSRefNo Reference number"

Remaining attributes
Define the following properties of the interface object on the "External 3D Interface" tab:
• The class and subclass
• The PDMS element type
• The model of the object
Details regarding the corresponding attributes and their configuration: See the links below.

See also
Assigning the class, subclass, and PDMS element type (Page 154)
Overwriting the inherited model information (Page 155)

2.10 Using pmlib macros

2.10.1 Using pmlib macros

Objective
The "PDMS/E3D-COMOS" interface is controlled by macros. The basic macros can be recognized
by the following prefix: "SAG" or in the macro notation "!!SAG".
In addition, macros are made available in pmlib that can be used as a tool. pmlib can only be
used in PDMS/E3D.

Used objects
All pmlib macros of this interface have the prefix "STB" for "Standard Tool Box". This means "!!
STB" will be the prefix in the macro notation.
pmlib\SDK:
• Macros: pmlib\ToolBox\Functions
• Objects: pmlib\ToolBox\Objects

3D Integration Administration
158 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.10 Using pmlib macros

The STB macros use the following objects:

• STBSearchObject
Members:
– !COMOSUID is STRING
– !RefNo is STRING
– !COMOS-TAG is STRING
– Note: First, a search is conducted for an object with COMOSUID in the 2D working area.
If no object with COMOSUID is found, RefNo is checked.
If this, too, does not result in a hit, COMOS-TAG is checked.
If no object is found in the end, "NOT_AN_OBJECT" is returned.
• STBObject
Members:
– !COMOSUID is STRING
– !COMOS-TAG is STRING
– !RefNo is STRING
– !PDMS-TAG is STRING
– !Type is STRING
– !StatusClass is INTEGER
– !StatusClassDescription is STRING
– !ObjectType is INTEGER
ObjectType can take on the following values:
1: TWO-SIDE-OBJECT
2: ONE-SIDE-OBJECT
3: NOT_AN_OBJECT
– !ErrorCode is INTEGER
– !ErrorDescription is STRING

Overview of the STB macros

• !!STBCheckStatusIn2DWS (Page 159)
• !!STBGetCurrentIn2DWS (Page 160)

2.10.2 !!STBCheckStatusIn2DWS
!! STBCheckStatusIn2DWS(!Search is STBSearchObject)
• STBSearchObject
See chapter Using pmlib macros (Page 158).
• Return value: STBObject
See chapter Using pmlib macros (Page 158).

3D Integration Administration
Operating Manual, 03/2021 V10.4 159
PDMS/E3D Engineering Interface
2.11 Administering Material Management (MTO) with PDMS/E3D

Returns the status class of an individual object in the 2D working area.

IDs of the status classes:
0: Not relevant
1: New
2: Different TAG
3: Attributes not part of the synchronization
4: Synchronized
5: Not assigned
6: Inaccurately assigned

2.10.3 !!STBGetCurrentIn2DWS
!!STBGetCurrentIn2DWS()
• Return value: STBObject
See chapter Using pmlib macros (Page 158).
Returns the properties of the currently selected object (properties of STBObject).
ErrorDescription serves as general return string of the state:
• L2-assigned object selected: ErrorDescription = "Successful, Found Two-
Side-Object".
• Object selected but not L2-assigned: ErrorDescription = "Successful, Found
One-Side-Object".
• No object selected: ErrorDescription = "Operation failed, No object
selected in 2D work space".

2.11 Administering Material Management (MTO) with PDMS/E3D

2.11.1 Create object "MTO Class - MTO (PDMS)"

Requirement
You are working in an engineering project.

Procedure
1. In the "Base objects" tab of the Navigator, navigate to the following node:
"@30 > M27 > A30 > Y00R00033 Folder for class/subclass definitions (PDMS)"
See also chapter Note on the "Folders for class/subclass definitions" object (Page 111).
2. Drag&Drop the object under the project root or under an unit in the "Units" tab.

3D Integration Administration
160 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.11 Administering Material Management (MTO) with PDMS/E3D

3. Select the newly created object.

4. Select the "New > Y00R00056 Class - MTO (PDMS)" command in the context menu.
5. Confirm your entries.

2.11.2 Creating the "Configuration for csv import" class

Requirement
• The "MTO Class - (PDMS)" object is configured.
See chapter Create object "MTO Class - MTO (PDMS)" (Page 160).

Procedure
1. Select the "MTO Class - MTO (PDMS)" object.
2. Select the "New > A91 Configuration for csv import?" command in the context menu.
3. Confirm your entries.

2.11.3 Managing a CSV import

2.11.3.1 Structure of a CSV file

To import CSV files, they must have the following structure. The separator between the
individual entries in the CSV file must be a semicolon.

Example
This is a representation of the CSV file in Microsoft Excel.

3D Integration Administration
Operating Manual, 03/2021 V10.4 161
PDMS/E3D Engineering Interface
2.11 Administering Material Management (MTO) with PDMS/E3D

Row 1
This row contains settings which it is mandatory to make.

Column Description
1 This value specifies whether the material will be created in the "Estimated", "Current", or
"Released" folder during import.
Possible values:
• "Estimated"
• "Current"
• "Released"
Make sure that the spelling is correct.
2 You enter a timestamp here, which can take any format you wish.
3 You enter a unique ID for the CSV file here.
Each file must have an ID.
• If a file with the same ID is imported again, existing imported data in COMOS will be
overwritten.
• If an MTO document has been created from previously imported data and has undergone
a revision, a new "Estimated", "Current", and "Released" folder is created when the import
is repeated. The folder name is automatically incremented.

Row 2
This row contains the column headers for the table which describes the material. Please note
that the names of the columns are case-sensitive; if the spelling and case do not exactly match
the original, errors will occur during the import.
Mandatory columns:

Column Description
"Subsection" Name of the "Configuration for CSV import" object that you have created
below the configuration object. The assignment of the SystemFullName and
the storage position of the MTO objects, for example, are defined in this
object.
See also chapter Creating the "Configuration for csv import" class (Page 161).
"Owner" Name of the object below which an MTO object is to be created. The name
of the owner is decoded using the assignment table in the subsection. See
also chapter Editing configurations for the CSV import (Page 163).
"ItemCode" Identification code
"Shop" Workshop or construction site production
Possible values:
• true
• false
"Quantity" Amount of material
"Description" Description of material
"Type" Type of material
"Unit" Unit of the value in the "Quantity" column.

Optional columns:

3D Integration Administration
162 Operating Manual, 03/2021 V10.4
 PDMS/E3D Engineering Interface
2.11 Administering Material Management (MTO) with PDMS/E3D

You can create as many other columns as you wish. The header of every additional column must
contain the exact name of an attribute which is already available at the base object of the MTO
object and whose value you want to enter via the CSV import.

Row 3 - n
The material being imported is described here. Each row corresponds to one component.

2.11.3.2 Editing configurations for the CSV import

Configurations for the CSV import are objects that are used to provide various settings for the
CSV import. They have the following purposes:
• Derivation of the path where an MTO object is to be created from the name of the owner
specified in the "Owner" column in the CSV file.
• Completion of the owner structure of the MTO object corresponding to the information in the
"Owner" column.
• Creation of the MTO object.

Requirement
• The "A01 Configuration for csv import" object is created.
See chapter Creating the "Configuration for csv import" class (Page 161).

Procedure
1. Select the object "A01 Configuration for csv import".
2. Open the "Attributes > General settings" tab.
3. Drag&drop a base object to the "Base object for revision folder" field.
4. Drag&drop the following base object to the "Base object for MTO objects" field:
"@30 > M28 > A10 > A20 > A20 MTO object for current/released"
5. Enter the desired settings in the "Name mapping for revision folders (MTO owner)" table. See
chapter Algorithm for generating a COMOS path name (Page 163).

2.11.3.3 Algorithm for generating a COMOS path name

Requirement
• The configurations for csv import are known.
See chapter Editing configurations for the CSV import (Page 163).

3D Integration Administration
Operating Manual, 03/2021 V10.4 163
PDMS/E3D Engineering Interface
2.11 Administering Material Management (MTO) with PDMS/E3D

Introduction
The path to the MTO object to be created is determined as follows:
• COMOS beaks down the information in the "Owner" column of the CSV file into its name part
using the "Name mapping for revision folder" table for the "Configuration for CSV import"
object.
• From the name parts, the interface derives the path to the correct node in the tree structure
where an MTO object is to be created.

Algorithm
The following steps are performed when executing the mapping table:
COMOS extracts the SystemFullname from the information in the "Owner" column. The
interface processes the individual mapping entries, starting with the one on the far left.
• First name part: COMOS evaluates the start index and the number of characters of the
associated mapping entry.
• Last name part: The mapping entry on the right is evaluated.
• Next to last name part: The second mapping entry from the right is evaluated.
And so on.
The following algorithm is executed for each mapping entry:
1. COMOS checks what is entered in the "Data item" row:
– Name of a String Parameter:
A corresponding COMOS node does not exist for the name part. Continue with step 2.
– Name or label of a COMOS object:
If there is one: The prefix and postfix are removed from the part of the name.
The remainder of the string represents the name or the label of an MTO object. It is copied
to the path list.
– Nothing entered: COMOS continues with step 2.
2. If the "Data item" row is empty or contains a String Parameter, a check is made whether the
"Fixed name" row has been configured:
– "Fixed name" not set: The processing of the mapping table is aborted for the object.
– "Fixed name" set: The entered or resulting string is written to the path list.
Once all mapping entries have been processed, the sequence of the entries in the path list is
reversed.

Result
• The string entered in the path list produces the path to the MTO object to be created.
• If the object does not exist, the mapping table returns all information needed to create it. The
name part of the last mapping entry is written to the "Name" property of the COMOS object.
• If the owner structure of the object you are looking for is incomplete: The mapping table
provides all information needed to complete the owner structure, provided that a base object
has been specified for every hierarchy level.

3D Integration Administration
164 Operating Manual, 03/2021 V10.4
References for PDMS/E3D Engineering Interface 3
3.1 Category "Process engineering > PDMS/E3D Engineering Interface"
The category defines the following project parameters:

Description Purpose
"Initialization file" field Directory containing the initialization file.
See also chapters Specifying the path to the initialization file
(Page 29) and Structure of the initialization file "ComosPDMSIn‐
terfaceInitialization.xml" (Page 180).
"Exchange directory" field Are not used.
"Communication directory" field
"Document index" field
"Configuration path" field
"Interface active" option Button to activate the old interface (COMOS-PDMS interface)
"PDMS/E3D project codes" field Project Codes of the AVEVA projects that are assigned to the
COMOS project.
See also chapter Assigning COMOS projects and PDM/E3D
projects (Page 76).

3.2 Reference to the standard table for PDMS element types

For information on the structuring of the standard table "Standard tables > @40 > Y00 > A10 >
C10 > Y00N00465 PDMS element types", see chapter Administering the standard table for PDMS
element types (Page 110).

3.3 Reference to the standard table for classes

For information on the structuring of the standard table "Standard tables > Y10 > M27 > A10 >
Y10M27N00002 > Y10M27N00002A01 Classes", see chapter Administering standard tables for
classes and subclasses (Page 108).

3.4 Reference to the standard table for subclasses

For information on the structuring of the standard table "Standard tables > Y10 > M27 > A10 >
Y10M27N00002 > Y10M27N00002A02 Subclasses", see chapter Administering standard tables
for classes and subclasses (Page 108).

3D Integration Administration
Operating Manual, 03/2021 V10.4 165
References for PDMS/E3D Engineering Interface
3.5 Attributes of the "Folders for class/subclass definitions" object

3.5 Attributes of the "Folders for class/subclass definitions" object

3.5.1 "General" tab

Requirement
• The use of the object "Folders for class/subclass definitions" is known.
See chapter Configuring the "Folders for class/subclass definitions" object (Page 112).

Content

General properties
"Use zone and site mapping" option Activates zone and site mapping.
"Update after assignment" option For attributes, you can specify that each inconsistency cleanup of
the objects ("Resolve", "Synchronize", "Create", "Assign") also au‐
tomatically updates the attributes of the objects. See the para‐
graph "Update after assignment" below for more on this.
"Feedback mode" option Activated: The two applications can access and write to the data bi-
directionally.
Deactivated: Only COMOS can access and write to data from Wal‐
kinside.
"Subclass for pipe" list Application case: COMOS works with a two-stage KKS structure
which uses pipe sections and segments.
This subclass determines in PDMS the pipes under which the sec‐
tions are located. The pipe is found or generated in PDMS. The
"Subclass for pipe" list is evaluated as follows:
• Creation mode and assign mode: "None"
The "Subclass for pipe" list is not evaluated. The pipes are not
automatically generated or assigned.
• Creating and assigning via location tree:
– Creation mode: "Create in location tree"
and
– Assign mode of the subclass for pipe sections: "Assign to
object in location tree"
and
– Location mapping of the subclass for pipe sections
Addresses objects of the subclass entered in the "Subclass for
pipes" subclass in the object tree. A object is generated, if re‐
quired.
"Folder for project scope queries" / Drag&drop the folder containing the queries for the project scope
"Folder for scope queries" field into this field.

3D Integration Administration
166 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.5 Attributes of the "Folders for class/subclass definitions" object

Sequence caching
"Sequence caching mode" option When you use the display of a cached sequence, you do not see the
"Automatic caching during extract‐ latest data.
ing" option You can find additional information on this topic in the "3D Inte‐
gration Administration" manual, keyword "Activate "Cache se‐
quence" function".

Assignment of the pipe components

"In backward direction" option See chapter Assigning pipe disconnecting equipment (Page 112).
"Attribute with owner name" list

Operation messages
"Operation messages" table • "Operation" column
Interface operations for which operation messages are availa‐
ble
• "Show information" column
Activates and deactivates the process logs.
See chapter Activating operation messages (Page 113).

"Update after assignment" option

To update existing databases, proceed as follows:
1. Switch to the base project.
2. Open the base object properties "Y00R00033 Folders for class/subclass definitions".
3. Select the "General" attribute tab.
4. Create the following attribute:
– iDB
"Y00A01539 Update after assignment"
– cDB
"MAP001 Update after assignment"
If the attribute is missing, automatic updating is switched off.
Effect: Each inconsistency cleanup of the objects ("Resolve", "Synchronize", "Create", "Assign")
automatically updates the attributes of the objects. You can find additional information on this
topic in the "3D Integration Administration" manual, keyword "Update attributes".

See also
Synchronizing classes and subclasses in COMOS and PDMS (Page 151)

3D Integration Administration
Operating Manual, 03/2021 V10.4 167
References for PDMS/E3D Engineering Interface
3.5 Attributes of the "Folders for class/subclass definitions" object

3.5.2 "Name directory" tab

Content
The tab contains the following table:

"Name directory" Each line in the table defines a String parameter. The String parameters
define variables which are globally available in the interface operations
area.

See chapter Using the name directory: Defining global variables (Page 113).
You configure an assignment between COMOS attributes and PDMS attributes in the subclass
definition objects.

3.5.3 "Pre/post executables" tab

Content
The tab contains the following tables:

Table Description
"Pre executable" Registers the PML functions which are called before an interface oper‐
ation is executed.
"Post executable" Registers the PML functions which are called after an interface opera‐
tion has been executed.

You can find information on the structure of the table and the configuration of the tab in chapter
Using pre/post executables (Page 114).

3.5.4 "Character mapping" tab

Content
The tab contains the following table:

Table Description
/ Defines which characters are permitted in COMOS but not in PDMS and
are replaced during name mapping.

You can find information on the structure of the table and the configuration of the tab in chapter
Using character mapping (Page 116).

3D Integration Administration
168 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.6 "Class - Documents (PDMS) > A01 Document subclasses definition"

3.5.5 "Unit mapping" tab

If a different unit has been assigned to an attribute in COMOS than in PDMS, the table defines
how units in PDMS and COMOS are mapped to one another.
You can find information on the structure of the table and the configuration of the tab in chapter
Using unit mapping (Page 116).

3.5.6 "SITE mapping" and "ZONE mapping" tabs

Content
The tabs contain the following tables:

Table Description of the table

Table for site mapping Defines how the SITE is found in PDMS for a COMOS
object under which the object may be located.
Table for zone mapping Defines how the ZONE is found in PDMS for a CO‐
MOS object under which the object may be located.

You can find information on the structure of the tables and the configuration of the tabs in
chapter Using ZONE mapping and SITE mapping (Page 117).

3.5.7 "Attributes for global name directory" tab

• "Total value 1"
• "Total value 2"
Reserved for future developments.

3.6 "Class - Documents (PDMS) > A01 Document subclasses definition"

3.6.1 "General" tab

Content

Control element Description

"Document ID" field Name of the string parameter which
reads out from PDMS the name of the COMOS
document under which the DocLinks are imported.
"Document type" list The document types are used as filters to speed up
the search for the COMOS
document.

3D Integration Administration
Operating Manual, 03/2021 V10.4 169
References for PDMS/E3D Engineering Interface
3.6 "Class - Documents (PDMS) > A01 Document subclasses definition"

Control element Description

"Base object for document search" field Reference to the base object of the COMOS docu‐
ment.
The base object is used as a filter to speed up the
search for the COMOS document.
"Base object" field Reference to the start object under which the
search for the COMOS document is carried out.
The base object is used as a filter to speed up the
search for the COMOS document.
"Filter unnamed objects" option Option for filtering the result list of the "Export to
Comos" window.
Activated: The result list contains only objects with
names.
Table "PDMS element type" column:
List with the PDMS element types which are per‐
mitted for the draft objects for which DocLinks are
created.
"Name" column:
Types of PDMS objects to which the subclass is ap‐
plied.
See also chapter Defining PDMS element types
(Page 121).

3.6.2 "Owner restriction rules" tab

Content
The tab contains the following attributes:

Control element Purpose

"Element type of owner" List in which you define the element type of the owner of the connected
list PDMS object.
Table 1 Table in which you define expressions which must evaluate as "True" at the
owner.
Table 2 Table in which you define filters which check whether a given owner attribute
contains a specific string.

You can find information on the structure of both tables and the configuration of the tab in the
chapter Specifying restriction rules for owners (Page 125).

3.6.3 "Name directory" tab

See also chapter "Name directory" tab (Page 172).

3D Integration Administration
170 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.7 "Class - Lines (PDMS) > A01 Pipe subclass definition"

3.7 "Class - Lines (PDMS) > A01 Pipe subclass definition"

3.7.1 "General" tab

"Base object for creating objects" control group

Field Description
"Create in unit tree" Master object, e.g. which is to be used for the im‐
port from PDMS to generate objects of this subclass
in COMOS.
"Create in location tree" Master object, e.g. which is to be used for the im‐
port from PDMS to generate objects of this subclass
in COMOS.

See also chapter Defining the base object for the creation of interface objects (Page 122).

"Structural behavior" control group

Control element Description

"Creation mode" list This is where you define whether the COMOS ob‐
ject connected to the PDMS interface object is lo‐
cated in the unit tree or in the location tree.
See also chapter Defining structural behavior
(Page 121).
"Assign mode" list This is where you define whether the COMOS inter‐
face object references another COMOS object and
if the referenced object is located in the unit tree or
in the location tree.
See also chapter Defining structural behavior
(Page 121).
Table "PDMS element type" column:
List with the PDMS element types which are per‐
mitted for the draft objects for which DocLinks are
created.
"Name" column:
Types of PDMS objects to which the subclass is ap‐
plied.
See also chapter Defining PDMS element types
(Page 121).

3D Integration Administration
Operating Manual, 03/2021 V10.4 171
References for PDMS/E3D Engineering Interface
3.7 "Class - Lines (PDMS) > A01 Pipe subclass definition"

3.7.2 "Name directory" tab

Content
The tab contains the following table:

Description of the table Purpose

"Name directory" Definition of String parameters

You can find information on the structure of the table and the configuration of the tab in chapter
Using the "Name directory" tab (Page 129).

3.7.3 "Name mapping" tab

Content
The tab contains the following tables:

Table Purpose
"Site mapping" Table which defines site mapping.
"Location mapping" Table which defines location mapping.
"Level rules" Table which defines deviations from the standard procedures for site map‐
ping and location mapping.

Information on the structure and configuration of the tables:

• Chapter Definitions for name mapping (Page 94)
• Chapter Configuring level rules (Page 238)
• Chapter Configuring site mapping and location mapping in name mapping (Page 138)

3.7.4 "Owner restriction rules" tab

Content
The tab contains the following attributes:

Control element Purpose

"Element type of owner" List in which you define the element type of the owner of the connected
list PDMS object.
Table 1 Table in which you define expressions which have to be evaluated to "True" at
the owner.
Table 2 Table in which you define filters which check whether a given owner attribute
contains a specific occur string.

3D Integration Administration
172 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.7 "Class - Lines (PDMS) > A01 Pipe subclass definition"

You can find information on the structure of both tables and the configuration of the tab in
section Specifying restriction rules for owners (Page 125).

3.7.5 "Model" tab

Content
The tab contains the following attributes:

Control element Purpose

"Mode" list You specify the model type here.
"Function" field Function call for generating the model.
"Element" field Name of the PDMS element whose model is copied.
"GTypes for filtering" GTypes of the design templates offered for this subclass.
Separator: ";"

"Design templates" control group

List Description
Main document template List from which you select a design template for the main equipment.
The entries in the list are filtered based on the entries in "TMPFILTER".
The list is empty if the entry "EQUI" is missing in "TMPFILTER".
"Sub template" Sub templates are design templates for the secondary equipment.
The entries in the list are determined by the main template set in
"PDMS004".

See also
Configuring the model (Page 126)

3D Integration Administration
Operating Manual, 03/2021 V10.4 173
References for PDMS/E3D Engineering Interface
3.8 "Class - Queries (PDMS) > A01 Query subclass definition"

3.8 "Class - Queries (PDMS) > A01 Query subclass definition"

3.8.1 The "General" tab

"PDMS settings" control group

Control element Description

"PDMS name" field Name which users will see when the query is of‐
fered for execution in PDMS.
"Description" field Description with which the query is displayed in
PDMS once the user has selected it for execution.

"Output format" control group

Control element Description

"Output format" list Output format in which the result list of the query
will be transferred to PDMS.
"Separator" field Use a separator only If the output format is "CSV".
The separator can be chosen at will.

"Main query" control group

Control element Description

"Query object" field Reference to the query object whose content is to
be displayed in PDMS.
"Start object" field Optional: Reference to a start object.
Overwrites the start object set in the query refer‐
enced in the "Name" field.
"Base objects" table Optional: References to the base objects by which
the query filters the result list.
You can set other base objects than those set in the
query referenced in the "Name" field.

3D Integration Administration
174 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.9 "Class - Devices with Label > A01 Device with subclass labeling definition"

"Query for start objects" control group

Control element Description

"Query object" field Reference to the query returned by the list of pos‐
sible start objects for the main query in PDMS.
"Start object" field Optional: Reference to a start object for the start
object query.
Overwrites the start object set in the query refer‐
enced in the "Name" field.
"Base objects" table Optional: References to the base objects according
to which the query filters the result list.
See "BaseObjectsMQ".

See also
Configuring a subclass definition object for queries (Page 148)

3.8.2 "Dynamic attributes" tab

Reserved for future development.

3.9 "Class - Devices with Label > A01 Device with subclass labeling
definition"

3.9.1 "General" tab

"Base object for creating objects" control group

Field Description
"Create in unit tree" Master object, e.g. which is to be used for the im‐
port from PDMS to generate objects of this subclass
in COMOS.
"Create in location tree" Master object, e.g. which is to be used for the im‐
port from PDMS to generate objects of this subclass
in COMOS.

See also chapter Defining the base object for the creation of interface objects (Page 122).

3D Integration Administration
Operating Manual, 03/2021 V10.4 175
References for PDMS/E3D Engineering Interface
3.9 "Class - Devices with Label > A01 Device with subclass labeling definition"

"Structural behavior" control group

Control element Description

"Creation mode" list This is where you define whether the COMOS ob‐
ject connected to the PDMS interface object is lo‐
cated in the unit tree or in the location tree.
See also chapter Defining structural behavior
(Page 121).
"Assign mode" list This is where you define whether the COMOS inter‐
face object references another COMOS object and
if the referenced object is located in the unit tree or
in the location tree.
See also chapter Defining structural behavior
(Page 121).
Table "PDMS element type" column:
List with the PDMS element types which are per‐
mitted for the draft objects for which DocLinks are
created.
"Name" column:
Types of PDMS objects to which the subclass is ap‐
plied.
See also chapter Defining PDMS element types
(Page 121).

3.9.2 "Name directory" tab

Content
The tab contains the following table:

Description of the table Purpose

"Name directory" Definition of String parameters

You can find information on the structure of the table and the configuration of the tab in chapter
Using the "Name directory" tab (Page 129).

3D Integration Administration
176 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.9 "Class - Devices with Label > A01 Device with subclass labeling definition"

3.9.3 "Name mapping" tab

Content
The tab contains the following tables:

Table Purpose
"Site mapping" Table which defines site mapping.
"Location mapping" Table which defines location mapping.
"Level rules" Table which defines deviations from the standard procedures for site map‐
ping and location mapping.

Information on the structure and configuration of the tables:

• Chapter Definitions for name mapping (Page 94)
• Chapter Configuring level rules (Page 238)
• Chapter Configuring site mapping and location mapping in name mapping (Page 138)

3.9.4 "Owner restriction rules" tab

Content
The tab contains the following attributes:

Control element Purpose

"Element type of owner" List in which you define the element type of the owner of the connected
list PDMS object.
Table 1 Table in which you define expressions which have to be evaluated to "True" at
the owner.
Table 2 Table in which you define filters which check whether a given owner attribute
contains a specific occur string.

You can find information on the structure of both tables and the configuration of the tab in
section Specifying restriction rules for owners (Page 125).

3.9.5 "Model" tab

Content
The tab contains the following attributes:

Control element Purpose

"Mode" list You specify the model type here.
"Function" field Function call for generating the model.

3D Integration Administration
Operating Manual, 03/2021 V10.4 177
References for PDMS/E3D Engineering Interface
3.10 "Class - MTO (PDMS) > A01 Configuration for csv import"

Control element Purpose

"Element" field Name of the PDMS element whose model is copied.
"GTypes for filtering" GTypes of the design templates offered for this subclass.
Separator: ";"

"Design templates" control group

List Description
Main document template List from which you select a design template for the main equipment.
The entries in the list are filtered based on the entries in "TMPFILTER".
The list is empty if the entry "EQUI" is missing in "TMPFILTER".
"Sub template" Sub templates are design templates for the secondary equipment.
The entries in the list are determined by the main template set in
"PDMS004".

See also
Configuring the model (Page 126)

3.10 "Class - MTO (PDMS) > A01 Configuration for csv import"

3.10.1 "General settings" tab

You create the object in the engineering view using the context menu of the configuration
object.
The object has the "Attribute > General settings" tab

"Base objects" control group

Field Description
"Base object for revision folder" Base object of the owner of the MTO object in the Navigator.
If the folder specified as the owner in the CSV file does not exist in
COMOS, it is created.
"Base object for MTO object" Base object of the MTO object being created.

3D Integration Administration
178 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.12 Design template objects: "External 3D interface" tab

Table "Name mapping for revision folder"

Row name Function Comment

"Prefix" The prefix in the "Owner" column. Used to break down the specification in the
"Postfix" The postfix in the "Owner" col‐ "Owner" column of the CSV file.
umn.
"Data item" The basis for generating names.
For example: "U2L"
Meaning: unit tree, level 2, label.
Stands for the label of the object
at the second level of the unit tree.
"Start index" The insertion point for the System‐
FullName within the full specifica‐
tion in the "Owner" column of the
CSV file.
"Number of char‐ The length of a data item at the
acters" corresponding hierarchy level.
"Base object" Only used to complete the owner structure of
"Base object from the MTO object or to create the MTO object.
structure"
"Fixed name" The name of a COMOS object Only used to generate a path to a COMOS ob‐
used to structure the COMOS data. ject.

The table columns represent the hierarchy levels of the objects in the Navigator.

3.11 Interface objects: "External 3D interface" tab

See chapter Attributes of the "External 3D Interface" tab (Page 157).

3.12 Design template objects: "External 3D interface" tab

Content
The tab contains the following attributes:

Field Description
"PDMS GTYPE" GType of the design template
"Purpose" Purpose of the design template

3D Integration Administration
Operating Manual, 03/2021 V10.4 179
References for PDMS/E3D Engineering Interface
3.13 Structure of the initialization file "ComosPDMSInterfaceInitialization.xml"

"Design parameter" control group

Field Description
"DP 01" to Field in which the value of the corresponding design parameter is entered.
"DP 10" Can be modified by the user in the engineering data.
/ Field for the description of the design parameter from PDMS.

The following attributes are dynamically created while the template object is being created in
the engineering data:

Field Description
/ Is only generated if one or more design templates for secondary equipment
were specified for an interface object:
• "<x>": Defines which of the five possible sub templates the current sub tem‐
plate belongs to.
• "<y>": Several templates are available for selection for each item of secon‐
dary equipment. "<y>" defines which template the attribute refers to.
• Value: The Catref of the sub template selected at the interface object.

3.13 Structure of the initialization file

"ComosPDMSInterfaceInitialization.xml"
To guarantee that COMOS and PDMS/E3D use the same configuration, the configuration is saved
in an initialization file. This initialization file is created during installation of the interface.
COMOS and PDMS/E3D use this file for communication and data exchange during an interface
operation.
See also chapter Specifying the path to the initialization file (Page 29).

Structure
The initialization file is in XML format and has the following structure:

<ComosPDMSInterfaceConfiguration>
<CommunicationFolder path="<path>"/>
<ExchangeFolder path="<path>"/>
<SubclassesFile path="<path>"/>
<Logfile path="<path>"/>
<DocumentFolder path="<path>"/>
<UseNetworkCommunication value="<Boolean>"/>
<NetworkConfigFile path="<path>"/>
<ShowMessageWindow value="<Boolean>"/>
<ReviewPath path="C:\AVEVA\PDMSInterface\Work\Review\"/>
<MTOTransferConfigurationFile path="<path>"/>
</ComosPDMSInterfaceConfiguration>

3D Integration Administration
180 Operating Manual, 03/2021 V10.4
 References for PDMS/E3D Engineering Interface
3.13 Structure of the initialization file "ComosPDMSInterfaceInitialization.xml"

Note
Deviating structure of the initialization file
Further entries can occur in older implementations. These are not relevant for the operation of
this interface.

Description of the individual nodes

Node Description
CommunicationFolder • Mandatory information
• Entered data is no longer used.
ExchangeFolder • Mandatory information
• Directory containing the XML files that are used for data
exchange. Created automatically, if not already present.
• Synonymous to the working directory, see also chap‐
ter Individually used data (Page 18).
SubclassesFile • Mandatory information
• Configuration directory and name of the configuration
file
• See also chapter Shared data (Page 18).
Logfile • Mandatory information
• Path to the log file
• Name and complete path to the log file that was written
while using the interface. This file is written individually
for each user and must therefore be stored in the work‐
ing directory.
DocumentFolder Path to the document directory
If this path is not specified, you cannot export any docu‐
ments from the draft module. Created automatically, if not
already present.
UseNetworkCommunication Label that shows whether the interface is operated in net‐
work mode. See chapter Setting up network mode
(Page 32).
Possible values:
• true
• false
If the value is "true", the path to the network configuration
file must be set.

3D Integration Administration
Operating Manual, 03/2021 V10.4 181
References for PDMS/E3D Engineering Interface
3.13 Structure of the initialization file "ComosPDMSInterfaceInitialization.xml"

Node Description
NetworkConfigFile Path to network configuration file. See also chapter Shared
data (Page 18).
The complete path must be specified with the file name.
See also chapters Editing the network configuration file
(Page 35) and Specifying the path to the initialization file
(Page 29).
ShowMessageWindow Label that indicates whether an information window is dis‐
played during the start of the interface in COMOS and
PDMS/E3D. This window shows the current status of the
communication.
Possible values:
• true
• false
ReviewPath Directory where the files that are exported for the "Dump"
attribute are stored.
MTOTransferConfigurationFile Path to the MTOExportSettings.dat file. Any file name can
be selected.
If this path is not specified, you cannot transfer any MTO
data to COMOS.
You can find additional information on this topic in the
manual "Material Management", keyword "MTOExportSet‐
tings.dat".

3D Integration Administration
182 Operating Manual, 03/2021 V10.4
COMOS PDMS interface 4
The following chapters only deal with the obsolete interface COMOS PDMS Interface.

4.1 Software requirements COMOS PDMS interface

COMOS PDMS Interface

• PDMS 12.0 and higher
• Citrix XenApp versions up to and including 4.5

4.2 Activating and deactivating the COMOS PDMS interface

In COMOS, you activate and deactivate the interface on a project-specific basis.
You only need to activate the interface once for each project. The interface remains activated,
even in subsequent sessions, until you deactivate it.
To work with COMOS PDMS Interface, you must activate the interface in PDMS every time you
restart PDMS. You can find additional information on this topic in the "3D Integration Operation"
manual, keyword "Activating COMOS PDMS Interface for PDMS".

Activating COMOS PDMS Integration

1. Start COMOS.
2. Open the project in which you will work.
3. Open the project properties and go to the "PDMS" category.
4. Activate the "Interface active" option.
COMOS PDMS Interface is being activated and made available in the COMOS menu.

Deactivating COMOS PDMS Integration

1. Start COMOS.
2. Open the project for which you want to deactivate the interface.
3. Open the project properties and go to the "PDMS" category.
4. Deactivate the "Interface active" option.

3D Integration Administration
Operating Manual, 03/2021 V10.4 183
COMOS PDMS interface
4.3 Installation

4.3 Installation

4.3.1 Introduction
COMOS PDMS Integration consists of the following interfaces:
• COMOS PDMS interface
• PDMS/E3D Engineering Interface
The procedures described as follows only refer to the installation of the PDMS/E3D Engineering
Interface.
You can start the installation in the COMOS setup browser if the installation routines are
otherwise not available.

4.3.2 Installation modes

The following installation modes are available:
• Local installation
• Installation on the Citrix server
• Installation on the Citrix client
• Installation on the Citrix client in silent mode

4.3.3 Communication modes

COMOS PDMS interface

Installation type Communication type

Local installation File-based communication and inter-process communication
Citrix client installation File-based communication
Citrix server installation File-based communication

4.3.4 Local installation

Requirement
COMOS and PDMS are already installed.

3D Integration Administration
184 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.3 Installation

Procedure
1. Insert the installation CD and start "setup.exe".
2. Select the "Local" installation mode:
3. Click "Next".
4. Select the installation directory.
The following will be saved here:
– Program files of the "COMOS PDMS Interface"
– Program files of the "COMOS PDMS/E3D Engineering Interface"
– Initialization file
See also chapter Initialization file (Page 189).
5. Specify the PDMS directories:
You can change the default settings of the PDMS directories:
– "PML-Lib":
If the "Install PML-Lib" option is activated: The PML-Lib supplied with the installation CD is
copied to this folder.
– "Working directory":
The path to the directory that will be used for data exchange. This directory can also be
specified at a later time in COMOS in the project properties.
– "Configuration directory":
The path to the directory that is used to exchange command files. This directory can also
be specified at a later time in COMOS in the project properties.
– "Executable":
The path to the folder where "TalkToComos.exe" is saved. The Windows environment
variable PATH should point to this directory. If not, the directory is attached to the
Windows environment variable PATH.
– "Install PML-Lib" option: See above.
– "Register PDMS components" option:
If you do not select the option, you must edit the "DesignAddins.xml" file in the installation
directory of PDMS:
Insert the following XML node: <string>Comos.PDMSInterface.ComosAddin</
string>
6. Click "Next".
7. Select the installation directory.
8. To start the installation, click "Install".
During installation, entries are made in the registry and the PDMS-Lib is installed.
9. Click "Finish".

3D Integration Administration
Operating Manual, 03/2021 V10.4 185
COMOS PDMS interface
4.3 Installation

4.3.5 Installing on a Citrix server

Requirement
COMOS is already installed on the Citrix server.

Procedure
1. Insert the installation CD and start "setup.exe".
The start dialog field of the InstallShield Wizard opens.
2. Click "Next".
3. Select the "Citrix server" installation mode.
4. Click "Next".
5. Select the installation directory.
The following will be saved here:
– Program files of the "COMOS PDMS Interface"
– Program files of the "COMOS PDMS/E3D Engineering Interface"
– Initialization file
See also chapter Initialization file (Page 189).
6. Click "Next".
7. Optional: Change the default settings of the PDMS directories:
– "Working directory" field:
The path to the directory that will be used for data exchange. Must point to the same
folder that is entered during the Client installation.
Input required.
– "Configuration directory" field:
The path to the directory that is used to exchange command files. Must point to the same
folder that is entered during the Client installation.
Input required.
8. Click "Next".
9. Click "Install".
During the installation entries are made in the registry.
10.Click "Finish".

4.3.6 Installing on a Citrix client

Requirement
• PDMS is installed on the Citrix client.
• COMOS is installed on the Citrix server.

3D Integration Administration
186 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.3 Installation

Procedure
1. Insert the installation CD and start "setup.exe".
2. Select the "Citrix client" installation mode.
3. Click "Next".
4. Select the installation directory.
The following will be saved here:
– Program files of the "COMOS PDMS Interface"
– Program files of the "COMOS PDMS/E3D Engineering Interface"
– Initialization file
See also chapter Initialization file (Page 189).
5. Click "Next".
6. Specify the communication directory into which the COMOS components of the PDMS/E3D
side are to be copied.
7. Click "Next".
8. Optional: Change the default settings of the PDMS directories on the client system:
– "PML-Lib":
If the "Install PML-Lib" option is activated: The PML-Lib supplied with the installation CD is
copied to this folder.
– "Working directory":
The path to the directory that will be used for data exchange. You can change this
directory at a later time in the initialization file.
– "Configuration directory":
The path to the directory that is used to exchange command files. This directory can also
be specified at a later time in COMOS in the project properties.
– "Executable":
The path to the folder where "TalkToComos.exe" is saved. The Windows environment
variable PATH should point to this directory. If not, the directory is attached to the
Windows environment variable PATH.
– "Install PML-Lib" option: See above.
– "Register PDMS components" option:
Registers the COMOS interface in PDMS.
If you do not select the option, you must edit the "DesignAdmin.xml" file in the installation
directory of PDMS.
Insert the following XML node: <string>Comos.PDMSInterface.ComosAddin</
string>
9. Click "Next".
10.To start the installation, click "Install".
During installation, entries are made in the registry and the PDMS-Lib is installed.
11.Click "Finish".

3D Integration Administration
Operating Manual, 03/2021 V10.4 187
COMOS PDMS interface
4.3 Installation

4.3.7 Installing on a Citrix client in silent mode

Installation in silent mode runs in the background and is controlled by a text file in which the
administrator has entered all of the relevant information in advance. You do not need to make
any further entries during installation.

Requirement
PDMS is installed on the Citrix client.

Procedure
1. Create a new text file.
2. Save the file in a local directory.
3. Enter the following paths in the file:
See also chapter Example text file for installation in silent mode (Page 188).
– Line 1: <Path to installation directory (storage location for INI file)>;<0 or 1>
0: Directory will not be created.
1: If the directory does not exist, it will be created
– Line 2: <Path to working directory (communication directory and replacement directory)>
– Line 3: <Path to configuration directory (document path and configuration path)>
– Line 4: <Path to PMLLib directory>;<0 or 1>
0: The directory is not created; the PMLLib is not copied.
1: The directory is created; the PMLLib is copied.
– Line 5: <Path to PDMS installation directory>;<0 or 1>
1: COMOS PDMS interface is entered in the PDMS DesignAddins.xml file.
0: COMOS PDMS interface is not entered in the DesignAddins.xml file of PDMS.
In this case, you must insert the entry manually. See also chapter Entering COMOS PDMS/
E3D Engineering Interface as an add-in (Page 31).
4. Use the command line to call the setup with the path to the created text file as a parameter.

Result
The installation carries out the same steps as for the client installation. See also
chapter Installing on a Citrix client (Page 186).

4.3.8 Example text file for installation in silent mode

D:\PDMSInterface\;1
D:\PDMSInterface\Work\
D:\PDMSInterface\Configuration\
D:\PDMSInterface\PMLLib\;1
D:\AVEVA\Plant\PDMS12.0.SP6\;0

3D Integration Administration
188 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.3 Installation

4.3.9 Initialization file

To guarantee that COMOS and PDMS use the same configuration, the configuration is saved in
an initialization file. This initialization file is created during the installation of COMOS PDMS
Interface. COMOS and PDMS use this file for communication and data exchange during an
interface operation.
The initialization file is in XML format and has the following structure:
<ComosPDMSInterfaceConfiguration>
<CommunicationFolder path="<path>"/>
<ExchangeFolder path="<path>"/>
<SubclassesFile path="<path>"/>
<TalkToComos path="<path>"/>
<Logfile path="<path>"/>
<DocumentFolder path="<path>"/>
<MTOTransferConfigurationFile path="<path>"/>
<StartupFunctionsFile path="<path>"/>
<ClientCommandService path="<path>"/>
<StartClientCommandService value="<Boolean>"/>
</ComosPDMSInterfaceConfiguration>
The following nodes are included:

Node Description
CommunicationFolder • Mandatory information
• Directory containing the XML files for command ex‐
change. Created automatically, if not already present.
ExchangeFolder • Mandatory information
• Directory containing the XML files that are used for data
exchange. Created automatically, if not already present.
SubclassesFile • Mandatory information
• Path to the Subclasses.xml configuration file
TalkToComos • Mandatory information
• Path to talkToComos.exe
Logfile • Mandatory information
• Path to the log file
DocumentFolder Path to the document directory
If this path is not specified, you cannot export any docu‐
ments from the draft module. Created automatically, if not
already present.
MTOTransferConfigurationFile Path to file MTOExportSettings.dat. The file name here is an
example only; you can choose any file name.
If this path is not specified, you cannot transfer any MTO
data to COMOS.
You can find additional information on this topic in the
manual "Material Management", keyword "MTOExportSet‐
tings.dat".
StartupFunctionsFile Path to the file containing the StartupFunctions

3D Integration Administration
Operating Manual, 03/2021 V10.4 189
COMOS PDMS interface
4.4 Configuration basics for interface operations

Node Description
ClientCommandService Path to ClientCommandService.exe
StartClientCommandService Flag which indicates whether ClientCommandService.exe
is to be executed when AVEVA PDMS starts
Possible values:
• true
• false

4.4 Configuration basics for interface operations

4.4.1 Interface objects

Definition of Interface Objects

Interface objects are engineering objects which can be processed by the interface operations.
An object counts as an interface object if it has the following properties:
• In COMOS:
– "External 3D interface" tab
– Assignment to a class
– Assignment to a subclass
The class must differ from UNDEF.
– PDMS element type
• In PDMS: UDA ":ComosSClass"
If the devices of your device catalog have these properties, they are processed by COMOS PDMS
Interface.

4.4.2 Classes and subclasses

4.4.2.1 Classes and subclasses

Definition
There are two groups of classes and subclasses:
1. Classes and subclasses which categorize interface objects
2. Classes and subclasses which are used to configure the execution of an interface operation

3D Integration Administration
190 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

Group 1
The following classes and their subclasses belong to this group:
• "Cables (PDMS)":
Interface objects with this class are used for example as:
– Pipe or pipe branch
– HVAC
– DUCT
– CABLES
• "Devices with label (PDMS)":
Interface objects with this class are equivalent to PDMS objects which can be positioned in 3D
space.
You can use subclasses to differentiate the behavior of interface objects on the same class. The
subclass determines how an interface object is processed during an interface operation.

Group 2
The following classes and their subclasses belong to this group:
• "Queries (PDMS)" class and their subclasses: They are used to configure COMOS queries and
make them accessible and executable in PDMS.
• "Document (PDMS)" class and its subclasses: A DocLink is generated for the interface object.
• "MTO (PDMS)" class: Configure the import of MTO data from PDMS/E3D to COMOS. This class
has no subclasses.
See also chapter Configure 'MTO (PDMS)' class (Page 221).

Properties of classes
Classes have the following properties:
• Classes structure the subclasses.
• The number and name of classes are fixed. They are specified by the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"
• A class can have any number of subclasses.

Properties of the subclasses

Subclasses have the following properties:
• The function performed by a subclass is determined by the class to which it belongs. See
above.
• The number and names of subclasses are specified by the subclass definition objects and are
dynamically saved in the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A02 Subclasses"

3D Integration Administration
Operating Manual, 03/2021 V10.4 191
COMOS PDMS interface
4.4 Configuration basics for interface operations

4.4.2.2 Class definition objects

Function
Class definition objects are engineering objects which are located directly below the "Folders for
class/subclass definitions" object.
Class definition objects have the following functions:
• They represent a class from the following standard table:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"
• They structure the subclass definition objects.

4.4.2.3 Subclass definition objects of "Cables" and "Devices with labels" classes

Function
The subclass definition objects of classes "Tagged item" and "Cable" fulfill the following functions:
• They represent the subclasses of these classes in the engineering view.
• They are used to save and configure the properties of the corresponding members of this
subclass.

Defining interface object properties

One subclass definition object defines the following properties for all interface objects of the
subclass:
• PDMS element types
• Base object that is used when the interface object is created in COMOS
The user defines two base objects:
– One is used when the interface object is created in the unit tree
– One is used when the interface object is created in the location tree
• Structural behavior:
– Whether the PDMS interface object is connected to a COMOS object from the unit tree or
from the location tree
– Whether the COMOS interface object is to have a pointer to another COMOS object and
whether this object is located in the unit tree or in the location tree
• Regarding name mapping:
– Generation of the object name on PDMS
– Rule governing how the interface for a given PDMS object finds the location at which the
corresponding COMOS object will be created in the COMOS structure

3D Integration Administration
192 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

• Regarding the name directory:

– Values that are evaluated by the interface operations when you process the interface
object
– Assignment between COMOS attribute and PDMS attribute
– String parameters that are available in the subclass.
• Regarding the owner restriction rules: Conditions that the owner must fulfill so that an
interface object can be created below it
• Which 3D model the interface object obtains
• How the object is initialized during the export if "Function" is set as model

4.4.2.4 Subclass definition objects of the "Queries" class

Working with COMOS queries in PDMS

The interface allows users to work with COMOS queries in PDMS. Users have the following
options:
• They select a query in PDMS from a range of predefined COMOS queries.
• Optional: They define filters for the query.
• Optional: They define the start object.
• They start the query in PDMS.
• They see the result of the query in PDMS or in an external program such as Excel.
This functionality is implemented with the help of COMOS queries and subclass definition
objects of the "Query" class.
The subclass definition objects of the "Query" class define the following:
• Queries that are available in PDMS
• Base objects of the objects in the result list
• Preset start object
• Output format in which the result list will be transferred

4.4.2.5 Subclass definition objects of the "Documents" class

The interface allows users to create DocObjs for draft objects in COMOS.

Requirement
• The draft objects have a DDNM attribute.
• The DDNM attribute references a design object which is connected to a COMOS object.
• A COMOS document under which the DocObjs are imported has been specified in the draft
structure.

3D Integration Administration
Operating Manual, 03/2021 V10.4 193
COMOS PDMS interface
4.4 Configuration basics for interface operations

Function
In the subclass definition objects of the "Document" class, you define all settings which are
necessary to create DocObjs for draft objects.
These include:
• Place in the PDMS draft structure at which the COMOS document for which DocObjs will be
created is specified.
As you are able create any number of subclass definition objects, you can configure the
interface in such a way that "Import DocLinks" can be started at different levels of the draft
structure according to the requirements.
• Filter criteria that restrict the COMOS document for which the DocObjs can be created.
• Setting indicating whether DocObjs are created only for draft objects with names or also for
draft objects without names.
• Owner restrictions for the draft objects for which DocObjs are created.

4.4.2.6 "Folders for class/subclass definitions" object

Path in the data base: "@20 > D30 > A20 > Y00R00033 @PDMSMAP Folder for class/subclass
definitions (PDMS)"

Function
This object fulfills the following functions:
• At this object, you make general settings which apply to the entire interface and not only to a
specific class or subclass.
• The class and subclass definition objects are managed below the object.
• In the context menu of the object, you can save the configuration of the subclass definition
objects in a file and refresh the standard table used to save the subclasses.

Overview of the general interface settings

The following general interface settings are configured in the "Folders for class/subclass
definitions" object:
• Interface operations after which feedback messages are displayed to users.
• Use and configuration of the site mapping and zone mapping.
See also chapter ZONE mapping and SITE mapping (Page 201).
• Configuration of the character mapping
See also chapter Character mapping (Page 200).
• Configuration of the unit mapping
See also chapter Units mapping (Page 200).
• Registered pre/post executables
See also chapter Pre/post executables (Page 200).
• Global String parameters
See also chapter String Parameters (Page 197).

3D Integration Administration
194 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

4.4.3 Name mapping

4.4.3.1 Name mapping

Function
Name mapping fulfills the following functions:
• It generates a PDMS/E3D name for a COMOS interface object.
The interface uses the PDMS/E3D name to identify the PDMS/E3D interface object to which
the COMOS object is connected.
• It uses the PDMS/E3D name of a PDMS/E3D interface object to ascertain the path to the
COMOS interface object to which it is connected.
• If the structural behavior of the subclass definition object prescribes that a COMOS interface
object references another COMOS object, the name mapping derives the referenced object
from the PDMS/E3D name.
• Optional:
If the COMOS interface object that is to be connected to a PDMS/E3D object does not exist yet:
The name mapping determines the base object used to create the COMOS interface object.
• If the owner structure of the COMOS interface object that is to be connected to a PDMS/E3D
object is incomplete or missing, the name mapping specifies which owners are created.

Site mapping and location mapping

The unit tree and the location tree do not usually share the same object structure. This is why it
is necessary to manage two mapping tables:
• Site mapping: Table which defines name mapping in the unit tree
• Location mapping: Table which defines name mapping in the location tree
You can find information on the structure of the tables, their configuration, and the algorithm
on which the name mapping is based in chapter Configuring site mapping and location mapping
in name mapping (Page 229).

4.4.3.2 Level rules of name mapping

Function
You can define deviations from the standard evaluation model for site mapping and location
mapping.
These deviations are particularly required in the following cases:
• Your project uses an alias structure.
• Your project uses different hierarchy depths.

Rule "Take alias rather than object"

If this rule is activated, the alias structure is used to generate the PDMS names.

3D Integration Administration
Operating Manual, 03/2021 V10.4 195
COMOS PDMS interface
4.4 Configuration basics for interface operations

If no alias is available, the name or description of the object is used.

Rule "Skip level if data part empty"

If this rule is activated, you can map hierarchies of different depths in name mapping. The
maximum number of mapping entries in the name mapping is determined by the hierarchy with
the deepest level.
If the evaluation of the data item or fixed name of a mapping entry returns an empty string, the
process continues with the next mapping entry.
Application example: Your equipment is located in the "Equipment" folder. Only pumps are not
directly located in the folder; these are to be found in its "Pumps" subfolder.

Rule "Skip level if unable to create object"

If a COMOS object cannot be created because of its configuration - because the potential owner
only permits certain elements as subobjects, for example - the name mapping does not abort.
It jumps to the next mapping entry. The entry is processed with the next PDMS name part.
Result: This rule allows you to use name mapping in COMOS to create object structures with
hierarchy levels of different depths.

Rule "Use label for fixed name"

If this rule is activated, the label of a COMOS object rather than its name is used in the "Fixed
name" range.

4.4.3.3 Structural behavior

Function
The structural behavior of a subclass definition object defines the following points:
• Creation mode: Whether the COMOS interface object to be connected to the PDMS object is
located in the unit tree or in the location tree
• Assign mode: Whether the COMOS interface object references another COMOS object and
whether the referenced object is located in the unit tree or in the location tree
Depending on how you define the structural behavior, either site mapping or location mapping
is evaluated during name mapping to fulfill one of the following tasks:
• Find or create an interface object in order to connect it with a PDMS object.
• Find or create the COMOS object referenced by the COMOS interface object.

3D Integration Administration
196 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

4.4.4 Working with area pipes

Definition
An area pipe is an object which is generated whenever an interface operation processes an
object whose subclass has the following structural behavior:
• Creation mode: "Create in location tree"
• Assign mode: "Assign to object in unit tree"
The aim of this setting is to map multiple PDMS objects to a single COMOS object. For this
purpose, the area pipe level is inserted between the PDMS objects and the COMOS object.

Application case
A pipe runs across different zones in PDMS, meaning that there are several pipe objects, but
logically these represent the same pipe. There is only one pipe object in the COMOS unit tree.
Area pipes are created for the PDMS pipes in the location tree and connected to the PDMS pipes.
The area pipes get a reference to the same COMOS pipe object.

Properties
Area pipes have the following properties:
• Area pipes are connected to the PDMS object.
• Area pipes get a unit link to an interface object from the unit tree.
• The full name of the corresponding PDMS object is written to the "Name" property of the area
pipe.
In contrast, only the last name part of the PDMS name is written to the name of the
referenced unit object. Depending on how the name mapping is configured, the name part
can even be truncated before it is written to the "Name" property.
• Data exchange can take place between the unit object and the assigned PDMS objects.

4.4.5 String Parameters

Definition
A String parameter is a variable which returns or processes a string:
• A String parameter reads a COMOS value or a fixed string. If the String parameter is
configured accordingly, it writes the value to PDMS.
• A String parameter reads out a PDMS value or a fixed string. If the String parameter is
configured accordingly, it writes the value to PDMS.

3D Integration Administration
Operating Manual, 03/2021 V10.4 197
COMOS PDMS interface
4.4 Configuration basics for interface operations

Global String parameters

Availability:
These String parameters are available everywhere in the interface operations area. They are
defined at the "Folders for class/subclass definitions" object.
In PDMS, global String parameters are evaluated independently of the current element.
In COMOS, they are evaluated at the following objects:
• In the project
• In the workset
• At the "Folders for class/subclass definitions" object
Purpose:
• To define variables which are globally available in the interface operations area.
• To prevent interface operations from being executed if a COMOS value and a PDMS value
defined by the String parameter do not match.

Local String parameters

Availability:
These String parameters are only available for subclasses. They are defined in the subclass
definition objects and evaluated at the interface object.
Purpose:
• To define variables that are locally available in a subclass.
• To perform one of the following actions during the interface operations:
– Export: Write a COMOS value to PDMS.
– Import: Write a PDMS value to COMOS.
– Check: Compare a COMOS value with a PDMS value.
Without these actions it is not possible to make an assignment between the attributes of an
interface object in COMOS and PDMS.
• Optional: To stop objects from being created for the export if a COMOS value and a PDMS
value are different.

4.4.6 Restriction rules for owners

Definition
With the restriction rules for owners you can define rules for the subclass definition objects. The
rules determine which owners are permitted in PDMS for objects of this subclass.
The interface evaluates the restriction rules for owners before it creates an object in PDMS or
makes an assignment between a COMOS object and a PDMS object. If an action violates one of
the rules, the object is not created or no assignment is made.

3D Integration Administration
198 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

Example
With the restriction rules for owners, the following rules can be implemented, for example:
• In PDMS, the exported interface objects are only created under zones whose purpose
attribute is set to "TAG".
• In PDMS, pipes and branches are only created under zones whose purpose attribute is set to
"PIP".
• In PDMS, the equipment is only created under zones whose purpose attribute is set to "EQU".

4.4.7 Model information

Model types
The following model types are available for interface objects:
• Design template:
– The model is defined via a design template. The template has been imported from PDMS
to COMOS.
– The user defines one main template and up to five templates for secondary equipment.
• PDMS element:
The model of an existing PDMS element is used.
• Function:
The model is defined via a PML function.
• None:
A box is created.

Possible sources
You have the following options for defining which model type an interface object uses:
• The model is inherited from the base object
• The model is taken from the subclass definition object
• The settings inherited from the base object or the subclass definition object are over-defined
in the properties of the interface object.

Export
When an interface object is exported to PDMS, the model information defined in COMOS is also
exported.
The object is displayed in PDMS with the corresponding model.

3D Integration Administration
Operating Manual, 03/2021 V10.4 199
COMOS PDMS interface
4.4 Configuration basics for interface operations

4.4.8 Pre/post executables

Definition
Pre/post executables are user-defined PML functions which are called prior to starting or after
completion of an interface operation.
• Pre executables execute steps serving the purpose of initialization and have an effect on the
entire interface operation.
• Post executables execute concluding steps.

4.4.9 Character mapping

Maintaining the naming convention

Some characters, such as blanks, are not allowed to form part of a PDMS name.
If the name mapping in COMOS generates a PDMS name, the generated string may contain one
or more characters that are not permitted in PDMS.
You define which characters are to replace these illegal characters in PDMS in the character
mapping of the "Folders for class/subclass definitions" object.

4.4.10 Units mapping

Unit conversion
It may be that an attribute was assigned a different unit in COMOS than in PDMS.
Units mapping enables you to map these units. When an attribute of this type is exported or
imported, the attribute value is converted as defined in the units mapping settings.
COMOS has a function to determine a tolerance for the comparison of REAL values between
COMOS and PDMS/E3D attributes. Requirement for this function is that the tolerance is
specified, among other things, in the Units mapping in the "PDMS MAP" object.
To do this, enter the tolerance in the "Number of decimal places" field in the "Unit mapping" tab.
Enter the label of the PDMS/E3D unit in the "Unit in PDMS" field.
When an attribute pair is made up of REAL values, the associated label is displayed in the
attribute window of the interface. A tolerance is taken into account when comparing the two
values. If the difference between the values is within this tolerance range, the values are
consistent.

3D Integration Administration
200 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.4 Configuration basics for interface operations

4.4.11 ZONE mapping and SITE mapping

The SITE mapping and ZONE mapping is evaluated when you call the command "Create" or
"Create hierarchy" at an object in the working area. You use ZONE mapping and SITE mapping
to specify under which SITE and ZONE objects are to be created in PDMS/E3D. The objects in the
"3D work area" are sorted according to the mapping.
The mapping is defined in two tables at the "Folders for class/subclass definitions (PDMS)" object:
• The SITE mapping supplies the PDMS name of a SITE
• The ZONE mapping supplies the PDMS name of a ZONE
When the specified SITE cannot be found, the object is not created.
When the specified ZONE cannot be found, the ZONE is created and the object is created.

Condition
SITE mapping and ZONE mapping is performed only in the following case:
• SITE mapping and ZONE mapping are activated. See also chapter Using ZONE mapping and
SITE mapping (Page 213).
• The interface operation "Create" or "Create hierarchy" is called.
• The subclass definition object of an interface object stipulates that the object has a ZONE as
its owner in PDMS/E3D.

4.4.12 Operation messages

Definition
Short operation messages are available for the following interface operations:
• "Assign"
• "Export" from PDMS and COMOS
• "Refresh"
• "Unassign"
If you activate a history log for these operations, a window opens once the interface operation
is complete containing information regarding the history of the operation for the user.

3D Integration Administration
Operating Manual, 03/2021 V10.4 201
COMOS PDMS interface
4.5 Configuring interface operations

4.4.13 Connection information

Definition
A COMOS interface object and a PDMS interface object are connected when their connection
information matches.

COMOS object PDMS object

"SystemUID" = ":ComosUID"
"Y00T00012.Y00A01244" = "RefNo"
"PDMS reference number"

COMOS object COMOS object

"SystemUID" = "Y00T00012.Y00A00730"
"SystemUID"

PDMS object PDMS object

"RefNo" = ":ComosCRefNo"
":ComosUID" = "SystemUID"

These properties are set during the following interface operations:

• PDMS and COMOS: "Export"
• COMOS: "Export to CE"
• COMOS: "Assign"

Name matching
If the name mapping of a COMOS object generates a name that matches the name of a PDMS
object, the two objects are regarded as connected.
Name matching is the assignment criterion for the "Assign > Match Names" interface operation.

4.5 Configuring interface operations

4.5.1 Workflow
The following approaches are possible for the administration of the interface operations area:

3D Integration Administration
202 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Task-based administration
Use task-based administration if you do not yet have extensive experience in administering the
interface.
1. You start by only making the settings which are necessary for a specific task.
2. Then you check your entries by executing the corresponding interface operations.
3. After this you configure the next task, and so on.

Object-based administration
Use object-based administration if you have extensive experience in administering the interface.
1. Create the "Folders for class/subclass definitions" object and, below it, the class definition
objects and the subclass definition objects. See also chapter Creating a class definition object
(Page 214).
The interface objects are or have been created by users during project planning.
2. You then configure the objects in the following sequence:
– "Y00R00033 @PDMSMAP Folder for class/subclass definitions (PDMS)" object
– Subclass definition objects
– Base objects of the interface objects

4.5.2 Note regarding changes to attribute properties

Note
Configuration of the attributes
The properties of the attributes listed in the following have already been fully configured in the
database.
Only change the preconfigured settings if the documentation explicitly indicates that such a
change is permitted or necessary.
In particular:
• Do not change or modify any scripts.
• Do not modify or delete any links.
• Do not delete standard table assignments.

3D Integration Administration
Operating Manual, 03/2021 V10.4 203
COMOS PDMS interface
4.5 Configuring interface operations

4.5.3 Task-based administration

4.5.3.1 Introduction
Task-based administration of the interface operations is described in the following:
1. Basic configuration:
Configuration of the "Folders for class/subclass definitions" object, the subclass definition
objects of the "Cable" and "Tagged item" classes, and the interface objects.
See also chapter Configuring the "Folders for class/subclass definitions" object (Page 209).
2. Use of COMOS queries in PDMS
See also chapter Configuring the use of COMOS queries in PDMS (Page 206).
3. Use of pre/post executables
See also chapter Configuring the use of pre/post executables (Page 206).
4. Importing DocLinks
See also chapter Configuring the import of DocLinks (Page 207).
5. Importing AVEVA templates
See also chapter Configuring the import of AVEVA templates (Page 207).

4.5.3.2 Performing the basic configuration

Procedure
1. Insert the "External 3D interface" tab for the base objects of the interface objects.
2. Optional: Enter additional element types in the "PDMS element types" standard table.
3. Create the "Folders for class/subclass definitions" object below the root node.
4. Optional: To configure the use of pre/post executables, go to the following
chapter Configuring the use of pre/post executables (Page 206).
5. Create the necessary class definition objects.
6. Create the necessary subclass definition objects below the class definition objects.
7. Optional: To configure the import of AVEVA templates, go to the following
chapter: Configuring the import of AVEVA templates (Page 207).

3D Integration Administration
204 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

8. Edit the subclass definition objects of classes "Cable" and "Tagged item":
– Define the structural behavior.
– Define the PDMS element types.
– Define the restriction rules for owners by selecting the element type of the owner.
Optional: Define additional restrictions.
– Define the site mapping and location mapping.
– Define the model information.
– In the name directory, define how values are mapped to one another in COMOS and PDMS.
Optional:
– Define local variables in the name directory.
– Define the level rules.
9. Optional: To configure the use of COMOS queries in PDMS, go to the following
chapter Configuring the use of COMOS queries in PDMS (Page 206).
10.Optional: Configure the "External 3D interface" tab.
11.Edit the "Folders for class/subclass definitions" object.
– Define the character mapping.
– If the "Export" operation is to be used: Define the site mapping and zone mapping.
– Optional: Define the global variables.
– Optional: Activate the history logs.
– Define the unit mapping.
12.Optional: To configure the import of DocLinks, go to the following chapter: Configuring the
import of DocLinks (Page 207).
13.Synchronize the settings between COMOS and PDMS.
14.Test the settings:
In COMOS:
Select "PDMS > 3D-View > Select > By Name":
– If the object is found in PDMS: Run "PDMS > Assign> Selected object".
– If the object is not found in PDMS: Run "PDMS > Export" and check the generated name
in PDMS.
In PDMS:
Select "Comos > CE > Navigate".
15.Open the "General" tab for the subclass definition objects of classes "Cable" and "Tagged
item".
Specify the base objects for creating objects.
16.Synchronize the settings between COMOS and PDMS.

3D Integration Administration
Operating Manual, 03/2021 V10.4 205
COMOS PDMS interface
4.5 Configuring interface operations

17.Use the following interface operations to test the settings in COMOS:

– "Refresh"
– "Custom Refresh"
– "Check status"
– "Export" (with attribute values)
18.Synchronize the settings between COMOS and PDMS.
19.Use the "Export" interface operation to test the settings in PDMS.

4.5.3.3 Configuring the use of COMOS queries in PDMS

Requirement
You have performed steps 1 - 6 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 204).

Procedure
1. Create and configure the main queries that are to be called from within PDMS.
Optional: Create and configure start queries for the main queries.
2. Configure the subclass definition objects of the "Query" class.
3. Synchronize the settings between COMOS and PDMS for the "Folders for class/subclass
definitions" object.
4. Test the settings in PDMS in the "Query Comos data" window.

4.5.3.4 Configuring the use of pre/post executables

Requirement
You have performed steps 1 - 3 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 204).

Procedure
1. Declare and implement PML functions.
2. Register the PML functions as pre/post executables for the "Folders for class/subclass
definitions" object.
3. Synchronize the settings between COMOS and PDMS.
4. Test the settings by executing the interface operation for which you registered a PML
function as pre/post executables.

3D Integration Administration
206 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.3.5 Configuring the import of DocLinks

Requirement
You have performed steps 1 - 11 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 204).

Procedure
1. Define the attribute or the UDA for the name of the COMOS document in the draft structure
in PDMS.
2. Configure the subclass definition objects of the "Document" class.
3. Test the settings:
– Create a document in COMOS.
– Enter the name of the document in PDMS in the attribute defined at the beginning or the
UDA.
– Execute the "Import DocLinks" operation in PDMS.

4.5.3.6 Configuring the import of AVEVA templates

Requirement
You have performed steps 1 - 6 as part of the basic configuration.
See also chapter Performing the basic configuration (Page 204).

Procedure
1. Navigate to the following base object: "@20 > D30 > A30 > Y00R00038 @TPL Objects for
design template structure".
2. Call the "Update design templates" command from the context menu of the node.
GType folders are created in the base data.
3. Assign references to the device catalog to the created GType folder.

4.5.4 Maintaining the standard table for PDMS element types

Purpose
The following standard table is supplied with the database:
"Standard tables > @40 > Y00 > A10 > C10 > Y00N00465 PDMS element types"
The most important PDMS element types are listed in the standard table.

3D Integration Administration
Operating Manual, 03/2021 V10.4 207
COMOS PDMS interface
4.5 Configuring interface operations

You can add the following to the standard table:

• Missing PDMS element types
• PDMS Version 12 and higher: User-defined PDMS element types

4.5.5 Standard tables for classes and subclasses

System-internal management
The standard tables in which classes and subclasses are listed are managed system-internally in
the engineering projects. This means that you are not permitted to edit the standard tables in the
engineering project.
You may edit the standard table in the base project.

Standard table for classes

You find the standard table in the following node:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A01 Classes"

Standard table for subclasses

You find the standard table in the following node:
"Standard tables > Y10 > M27 > A10 > Y10M27N00002 > Y10M27N00002A02 Subclasses"
The standard table is dynamically updated: When you call the "PDMS > Save subclasses" context
command at the "Folders for class/subclass definitions" folder, COMOS synchronizes the
structure of the subclass definition objects underneath the class definition objects with the
entries of the standard table.

4.5.6 Creating the "Folders for class/subclass definitions" object

In the database supplied, you create the object directly underneath the project root.

Procedure
Create the "Folders for class/subclass definitions" object via the "New" entry in the context menu.

Note
If you create the folder using drag&drop from the base data, enter the following value in the
"Name" property: "Y00R00033"

3D Integration Administration
208 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.7 Configuring the "Folders for class/subclass definitions" object

4.5.7.1 Activating operation messages

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
To activate/deactivate operation messages, proceed as follows:
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > General" tab.
3. Search for the "Operation messages" control group.
The control group contains a table with the following columns:
– "Operation" column: Interface operations for which operation messages are available
– "Show information" column: To activate/deactivate operation messages
4. Select an entry from the lists in the "Show information" column.
Possible values:
– "Yes": Activates operation messages for the corresponding operation based on the row
you have selected.
– "No": Operation messages are deactivated for this operation.

4.5.7.2 Defining global variables

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
1. Navigate to the "Folders for class/subclass definitions" object
2. Select the "Name directory" tab.
3. When defining global variables, proceed in exactly the same way as when defining a local
variable in a String parameter for the subclass definition objects. See also chapter Creating
subclass definition objects (Page 214).

3D Integration Administration
Operating Manual, 03/2021 V10.4 209
COMOS PDMS interface
4.5 Configuring interface operations

Structure of the "Name directory" table

The global variables are defined in the "Name directory" table. The table structure is virtually
identical to the one for the subclass definition objects.
Differences:
• No COMOS unit
• No SetFunction
• Only one flag: "Rule"
Since only global variables are defined in the name directory of the "Folders for class/subclass
definitions" object, there is no SetFunction and only the "Rule" flag.

Using the "Rule" flag

If you activate the "Rule" flag, you have to configure the String parameter in such a way that it
returns both a COMOS value and a PDMS value.
Result: The interface compares the two values before every interface operation and only
executes the operation if the values are identical.

4.5.7.3 Using pre/post executables

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
To execute a PML function before an interface operation is executed or after it has been
completed, proceed as follows:
1. Declare the PML function.
– Signature:
If "Uses query" = "Yes"
!!NamePMLFunktion(!InterfaceOp is String, !config is Boolean, !
arg1 is String, !arg2 is String, ...)
If "Uses query" = "No"
!!NamePMLFunktion(!InterfaceOp is String, !arg1 is String, !
arg2 is String, ...)
– Parameter InterfaceOp: The name of the interface operation before or after which the
PML function is executed.
– Parameter !config: Required only if you select the value "Yes" in the "Before call" or
"After call" table in the "Uses query" column.
– Parameter arg1, arg2, ...: Name of any number of global String parameters:
optional parameter
2. Implement the PML function.

3D Integration Administration
210 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

3. Open the properties of the "Folders for class/subclass definitions" object.

4. Switch to the "Attributes > Pre/Post executables" tab.
5. If the PML function is executed before the start of the interface operation, register it in the
"Pre executables" table.
If the PML function is executed after completion of the interface operation, register it in the
"Post executables" table.
To register a PML function for an interface operation, proceed as follows:
– "Executable" column:
Enter the name of the PML function from step 1.
– "Query" column:
Select "Yes" if the PML function is to execute a COMOS query. The function must have been
implemented accordingly.
The PML function is then called twice. Initially with !config = TRUE:
Implement the function in such a way that the config file for the query is configured in the
function and sent to COMOS.
COMOS then executes the query and the function retrieves the results.
For the second time with !config = FALSE:
Function operates with results
Select "No" if the PML function does not use a COMOS query.
– "Export", "Assign", "Refresh", "Check status", "Import ", "MTO import" columns:
Select "Yes" to register the PML function for these interface operations.
You can find additional information on this topic in the "3D Integration Operation" manual,
keyword "List of interface operations and internal names".

4.5.7.4 Using character mapping

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
To define those characters which are permitted in COMOS but not in PDMS and are replaced
during character mapping, proceed as follows:
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > Character mapping" tab.
3. Configure the table which you find on this tab.
For each line, define an illegal character along with the character which is to replace the
illegal character in PDMS. Proceed as follows:
– "Comos" column: Enter the illegal character.
– "PDMS" column: Enter the character which is to replace the illegal character.
Enclose the characters in single quotation marks.

3D Integration Administration
Operating Manual, 03/2021 V10.4 211
COMOS PDMS interface
4.5 Configuring interface operations

4.5.7.5 Using unit mapping

With the unit mapping, you define how units in PDMS and COMOS are mapped to one another
if a different unit has been assigned to an attribute in COMOS than in PDMS.

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
1. Open the properties of the "@PDMSMAP Folders for class/subclass definitions (PDMS)" object.
2. Select the "Attributes > Unit mapping" tab.
3. Configure the table which you find on this tab:
– "Name" column: The name of the mapping entry
The name is displayed in the name directory in the "Unit" column.
– "Unit in PDMS" column: No longer used.
– "Unit group in COMOS" column: The unit group to which the unit entered in "Unit in
COMOS" belongs.
The unit group establishes the connection between the unit at the COMOS attribute and
unit, which is specified in PDMS or expected during an exporting to PDMS.
– "Unit in Comos" column:
With export to PDMS: The unit into which the values registered in COMOS attributes are
to be converted. This is the unit that is expected in PDMS.
With import from PDMS: The unit of imported PDMS values, which is to be converted into
the unit of a COMOS attribute.
Note: During the import/export there is no explicit check whether the attribute actually
uses the unit specified in the unit mapping in PDMS. The interface assumes that the
correct unit has been entered.

Result
The mapping entries defined here are available in the name directory.
• During import:
The value from PDMS is converted to the unit that exists for the COMOS attribute.
• During export:
The value from COMOS is converted to the unit, that is specified in the "Unit in COMOS"
column.

3D Integration Administration
212 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.7.6 Using ZONE mapping and SITE mapping

Requirement
You have created the "Folders for class/subclass definitions" object in the engineering data. See
also chapter Creating the "Folders for class/subclass definitions" object (Page 208).

Procedure
1. Open the properties of the "Folders for class/subclass definitions" object.
2. Select the "Attributes > General" tab.
3. Enable the "Use ZONE and SITE mapping" option in the "General properties" control group.
Note
Deactivation locks the "Export" menu
If you deactivate the option and the subclass of an interface object prescribes that the object
is located under a site or a zone in PDMS, the "PDMS > Export" command will be locked in the
context menu of the COMOS interface object. You cannot create any SITES or ZONES.

4. SITE mapping: Switch to the "SITE mapping" tab.

5. ZONE mapping: Switch to the "ZONE mapping" tab.
6. Configure the mapping table. The configuration is similar to that of the name mapping for the
subclass definition object.
Differences:
– Configure the table in such a way that the mapping entries generate the name of a SITE
or ZONE.
– Mapping is only performed for one direction: It generates the PDMS name of a SITE or
ZONE.
– There are no level rules.
– The structural behavior has no influence.

Result
If a user requests COMOS objects in the COMOS PDMS Interface, names for PDMS SITES and
ZONES are created for cables and devices based on the defined rules. The SITES and ZONES are
created in COMOS PDMS Interface and the COMOS objects are sorted underneath them.

Note
Display in the "COMOS objects" area depends on mapping
If you do not configure SITE mapping and ZONE mapping, all objects are stored parallel to one
another in the "COMOS objects" area of the PDMS/E3D Engineering Interface.
If you have only configured one of the two tables or the configurations cannot be evaluated, the
objects are created under a "Not categorized" node.

3D Integration Administration
Operating Manual, 03/2021 V10.4 213
COMOS PDMS interface
4.5 Configuring interface operations

4.5.8 Creating a class definition object

You can only create one class definition object for each class.

Procedure
To create a class definition object, proceed as follows:
1. Click the "Units" tab in the Navigator.
2. Select the "Folders for class/subclass definitions" object in the Navigator.
3. Select the "New" command from the context menu and select the required class.
If you have already created a class definition object for the class, the class will no longer be
available in the context menu.

Defining the properties of the class

You define the subclass for the class by creating subclass definition objects under a class
definition object.

Name of the class definition object

You recognize the mapping of a class definition object to a class based on its name.
When creating the object, COMOS automatically enters a name - depending on which class you
selected under "New" in the context menu.
Do not change the name of the class definition object.

4.5.9 Creating subclass definition objects

Procedure
To create a subclass definition object, proceed as follows:
1. Click the "Units" tab in the Navigator.
2. Open the "Folders for class/subclass definitions" object in the Navigator.
3. Select the class definition object under which you want to create a subclass definition object.
4. Select the "New > <Subclass definition object>" command from the context menu.
5. Open the properties of the subclass definition object.
6. In the "Name" property, enter the name of the subclass which describes the objects that
belong to the subclass. See also chapter Creating a class definition object (Page 214).
7. Enter a description in the "Description" property.

3D Integration Administration
214 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Result
• The subclass definition object is created.
• The subclass definition object is automatically assigned the class that is entered as the name
of its class definition object.

Adding a subclass to a standard table

Subclasses can be added to the standard table for subclasses. See also chapter Standard tables
for classes and subclasses (Page 208).

4.5.10 Configuring the subclass definition objects of the classes "Pipe" and
"Equipment"

4.5.10.1 Defining PDMS element types

Procedure
To define which PDMS element types are permitted for interface objects of this subclass, proceed
as follows:
1. Open the properties of the subclass definition object.
2. Switch to the "Attributes > General" tab.
3. Click on a field in the "Name" column in the "PDMS element types" table.
A list is displayed in the field.
4. Open the list and select the required element type from the list.
The type is entered in the field. COMOS automatically adds a new line to the bottom of the
table.
5. Repeat step 3 until you have entered all required element types.

Result
Only PDMS element types defined in this way are available to the user in the interface objects of
this subclass.

4.5.10.2 Defining structural behavior

Procedure
To define the structural behavior of an interface object of this subclass, proceed as follows:
1. Open the properties of the subclass definition object.
2. Switch to the "Attributes > General" tab.

3D Integration Administration
Operating Manual, 03/2021 V10.4 215
COMOS PDMS interface
4.5 Configuring interface operations

3. In the "Structural behavior" control group, "Creation mode" list, define whether the COMOS
object connected to the PDMS interface object is located in the unit tree or in the location
tree.
Possible values:
– "Create in unit tree": Site mapping is performed to find or create the COMOS interface
object.
– "Creation in location tree": Location mapping is performed to find or create the COMOS
interface object.
– "None": You can find information on this in the reference part of this document, in
chapter "General" tab (Page 171).
4. "Structural behavior" control group, "Assign mode" list:
Define whether the COMOS interface object references another COMOS object and if the
referenced object is located in the unit tree or in the location tree.
The values that are offered to you are determined by which "Creation mode" you have set.
Possible values in the "Assignment mode" list:
– "Assign object in the unit tree": The COMOS interface object gets a unit reference. The
referenced object is determined by means of site mapping.
– "Assign location in the location tree": The COMOS interface object gets a location
reference. The referenced object is determined by means of location mapping.
– "None": The interface object gets no reference.

4.5.10.3 Defining the base object for the creation of interface objects

Possible alternatives
There are three ways of defining which base object is used to create an interface object in
COMOS:
1. Specify the base object on the "General" tab of the corresponding subclass definition object.
2. Specify the base object by mapping the name of the corresponding subclass definition object.
This is the method used in this document.
3. Enter the SystemFullName of the base object in the following UDA ":ComosBaseOb" of the
PDMS interface object.
This method offers you the most flexibility but it is also the most complex, since the UDA is
set manually for each PDMS interface object.

Procedure
To define which base object is used to create the interface objects of this subclass in COMOS,
proceed as follows:
1. If PDMS interface objects of this subclass already exist: Make sure that the ":ComosBaseOb"
UDA of the PDMS interface object is empty. If not, the interface will use the base object that
is entered in the UDA.
2. Open the properties of the subclass definition object.

3D Integration Administration
216 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

3. Go to the "Attributes > Name mapping" tab.

Make sure that no base object has been defined for the mapping entry on the far right in the
site mapping or location mapping.
4. Switch to the "Attributes > General" tab.
5. "Base object for creating objects" control group, "Create in unit tree" reference:
In order to create the interface object in COMOS, you define which base object will be used
during the site mapping with a drag-and-drop operation.
If one of the following values is set in the "Structural behavior" control group, set a base object
reference:
– Creation mode: "Create in unit tree"
– Assign mode: "Assign to object in unit tree"
6. "Base object for creating objects" control group, "Create in location tree" reference:
Using drag&drop, specify which base object is used during location mapping to create the
interface object in COMOS.
Has to be set if one of the following values is set in the "Structural behavior" control group:
– Creation mode: "Create in location tree"
– Assign mode: "Assign to location in location tree"

4.5.10.4 Automatically inserting additional hierarchy levels

You can specify that a hierarchy level will be added in the "COMOS objects" area of the PDMS/E3D
Engineering Interface for COMOS objects that are assigned to a specific subclass and have a two-
level structure.

Note
The functionality only works if the top object of the three-level structure in the PDMS/E3D
Engineering Interface is located below a ZONE.
Top-level objects are objects that can be created directly below ZONEs.

3D Integration Administration
Operating Manual, 03/2021 V10.4 217
COMOS PDMS interface
4.5 Configuring interface operations

You can use this function for the following objects:

• Equipment with nozzles, such as vessels
When you request equipment with nozzles from COMOS in the interface, you can specify that
a three-stage structure is automatically created in the interface.
Example:

COMOS PDMS/E3D Engineering Interface

Containers Containers
PDMS type: EQUI
SUBE
The SUBE is created by the "Owner subclass" function.
Nozzles Nozzles
PDMS type: NOZZ

• When working with KKS: for pipe parts, such as valves

When you are working with the KKS labeling system and request pipe parts in the interface
which are included in a two-stage structure in COMOS, you can specify that a three-stage
structure is automatically created in the interface.
Example:

COMOS PDMS/E3D Engineering Interface

Pipe branch PIPE
Pipe branch
PDMS type: BRAN
The pipe branch is created by the "Owner subclass" function.
Valve Valve
PDMS type: VALV

Procedure
1. Open the properties of a subclass for nozzles or for pipe parts.
2. Open the "Attributes > General" tab.
3. For nozzles:
In the "Owner subclass" list, select a subclass that has a "SUBE - Sub equipment" entry as
"PDMS element type". Make sure that the element type of all objects of the structure involved
adhere to the PDMS rules.
For pipe parts:
In the "Owner subclass" list, select a subclass that has a "BRAN - Branch" entry as "PDMS
element type". Make sure that the element type of all objects of the structure involved adhere
to the PDMS rules.
4. Open the "Attributes > Owner restriction rules" tab.
5. For nozzles:
Select the "SUBE - Sub equipment" entry from the "Element type of owner" list.
For pipe parts:
Select the "BRAN - Branch" entry from the "Element type of owner" list.

3D Integration Administration
218 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Result
When objects listed above that are contained in a two-level structure in COMOS are requested
in the interface, a three-level structure is automatically created in the PDMS/E3D Engineering
Interface. An object is created for the object that is missing in the COMOS structure; this object
has the PDMS element type "SUBE" or "BRAN".
You can create virtual objects and the underlying hierarchies in PDMS. You can find additional
information on this topic in the "3D Integration Operation" manual, keyword "Creating objects
in PDMS".

4.5.10.5 Specifying restriction rules for owners

Requirement
You are familiar with the objective of the restriction rules for owners. See also chapter Restriction
rules for owners (Page 198).

Rule types
The following rule types exist:
• The PDMS element type that the owner must have in PDMS.
• An expression which is evaluated by the owner and must be true.
• A filter which checks whether a given owner attribute contains a specific occur string.

Defining PDMS element types

1. Open the properties of a subclass definition object.
2. Go to the "Attributes > Owner restriction rules" tab.
3. In the "Element type of owner" list, select the PDMS element type that the owner of the
interface object must have in PDMS.
4. Optional: In the "Conditions" control group, define any number of expressions and/or filters
which are applied to the potential owner. See section "Defining filters".

Result
When the potential owner conforms to the rules, the object can be created below the owner.

Defining expressions
1. In the top table in the "Conditions" control group, click in the "Expression" column.
2. Enter an expression for which the following applies:
– it is compatible with a PDMS block object
– it returns a boolean type value
3. Press <Enter> to confirm your entry.

3D Integration Administration
Operating Manual, 03/2021 V10.4 219
COMOS PDMS interface
4.5 Configuring interface operations

Result
When the potential owner conforms to the rules, the object can be created below the owner.
• The expression is evaluated in PDMS at the potential owner.
– Return value "True": The owner meets the condition.
– Return value "False": The owner does not meet the condition.
• A line for another expression is added to the table.
Example:
name.Substring(1,2).eq('EP')

Defining filters
1. In the bottom table in the "Conditions" control group, click in the "Attribute" column.
2. Enter the name of the attribute as it is defined in PDMS.
3. Click in the "Occur string" column.
4. Enter a value which is to be evaluated at the attribute.
You can enter the following values:
– String
– Local or global variable
Exception: Do not use local variables which get their value from PDMS.
5. Press <ENTER> to confirm your entry.

Result
The filter is evaluated in PDMS at the potential owner.
• If you have entered a string: The object can be created below the owner if the string is a
substring of the attribute.
• If you have entered a variable: The object can be created below the owner if the value of the
variable is a substring of the attribute.

4.5.10.6 Configuring the model

Requirement
If you are using design templates, the design templates must be imported from PDMS.
You can find information about importing design templates in chapter Importing AVEVA design
templates (Page 245).

Inheritance of model information to interface objects

The database is configured in such a way that the interface objects apply the model information
from their subclass.

3D Integration Administration
220 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

If the interface objects are to use different model information from what is specified by their
subclass: Define different model information in the base objects of the interface objects.
Users can overwrite the settings taken from the subclass or the base objects in the engineering
view.

Procedure
To define model information at the subclass definition object, proceed as follows:
1. Open the properties of the subclass definition object and switch to the "Attributes > Model"
tab.
2. If the geometry is based on a design template: Enter the GTypes in the "GTypes for filtering"
field. Define the GTypes that are available for selection in design templates.
If you enter multiple GTypes, use ";" as a separator.
3. In the "Mode" list, define how the model is generated. Select one of the following modes:

Mode Subclass of "Cable" Subclass of "Tag‐ Result

class ged item" class
"Design template" / Available for sub‐ The geometry is based on a design
classes with the template.
"EQUI" PDMS ele‐
ment type
"PDMS element" / Available The geometry is copied from an ex‐
isting PDMS element.
"Function" Available Available The geometry is generated by a
function which is also performs oth‐
er initializations.
"None" Available Available A box is generated.

4. You define the details for the generation of the model based on which mode you have
selected. See also chapter Overwriting the inherited model information (Page 247).

4.5.11 Configure 'MTO (PDMS)' class

Procedure
1. Create the "Folder for class/subclass definitions (PDMS)" object.
You can find more information on this topic in the manual "3D Integration Administration",
keyword "Create folder for classes / subclasses definitions" object".
2. Use the context menu to create the "Class - MTO (PDMS)" object below this.
3. Open the "Attributes > General" tab in the properties of the object.
4. From the "Subclass for generating pipelines" list, select a subclass to be used for generating
pipelines after the import.
5. Optional: Select another object in the "Base object for MTO object" field.
This base object is used to generate imported MTO objects.

3D Integration Administration
Operating Manual, 03/2021 V10.4 221
COMOS PDMS interface
4.5 Configuring interface operations

6. Optional: Select another object in the "Base object for bolts" field.
This base object is used to generate imported bolts.
7. Optional: In the "Bolting" table, change the attributes in which the properties of imported
objects are to be stored.
8. Optional: Configure the import of pipe lengths.
Activate the option "Import pipe length".
Enter the NestedName of the COMOS attribute you want to use in the "Pipe length attribute”
field. The representation type has to be “List” in the properties of the attribute.
9. Select the "Name directory" tab.
Configure the table.
See also chapter Overwriting the inherited model information (Page 247).

4.5.12 Working with string parameters in the name directory

4.5.12.1 Name directory

Definition
The name directory is a table in which each line defines a string parameter.
See also chapter Structure of a String Parameter (Page 223).

Evaluation
The name directory is evaluated in the following cases:
• During an interface operation if values are compared, exported or imported. These are
usually attribute values.
• If a string parameter is used in a subclass definition object on the "Name mapping" tab to
generate one of the following components of a PDMS name part:
– Prefix
– Postfix
– Data item
– Base object
• If objects are filtered in the "Export to Comos" PDMS mask.
• If a string parameter is transferred to a PML function as a parameter. For example, if a String
parameter is used in an initialization function in a subclass definition object on the "Model"
tab.

4.5.12.2 Tasks of the String parameter:

The tasks marked with "*" provide the basis for the remaining tasks.

3D Integration Administration
222 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

A String parameter can fulfill the following tasks:

• Assign a COMOS value to a variable*
• Assign a PDMS value to a variable*
• Write a PDMS value to a COMOS attribute (import)
• Write a COMOS value to a PDMS object (export)
• Generate a component of a mapping entry in the name mapping (variable definition)
• An interface operation compares the value of a COMOS interface object returned by the
String parameter with the value of the connected PDMS object returned by the String
parameter (check).
• The "Export" interface operation uses the String parameters to check whether it is permissible
to create an object below a specific owner.

4.5.12.3 Structure of a String Parameter

String parameters are defined in the mapping table on the "Name directory" tab. Each line
defines a String parameter.
A String parameter has the following constituent parts:

Constituent Description
Name Displayed in the interface for identification.
Value of the String data type The value is calculated/set by evaluating one of the
following columns:
• "COMOS attribute"
• "PDMS attribute/expression"
• "GetFunction"
• "SetFunction"
See also section "Value of String data type" below.
Flags which define how the String parameter is pro‐ The flags are set in the following columns:
cessed by interface operations • "Check status"
• "Export"
• "Import"
• "Admin"
• "Rule"
Entry from the unit mapping of the "Folders for Defines the unit that is expected by or will be trans‐
class/subclass definitions" object ferred by COMOS and PDMS. Values can be conver‐
ted as appropriate.
Data type transferred to the PLM function in PDMS If no PLM function is used, the type of the PDMS
and into which the string of the string parameter is attribute is used.
converted in PDMS

3D Integration Administration
Operating Manual, 03/2021 V10.4 223
COMOS PDMS interface
4.5 Configuring interface operations

Value of String data type

A string involves one of the following values:

Value comes from COMOS Value comes from PDMS

Attribute value of the interface object that is cur‐ Attribute value of the PDMS Interface object that is
rently being processed by the interface operation set as the current element.
that is evaluating the name directory.
Any other property of an object other than the in‐ Value that is returned by a PDMS expression.
terface object, such as the name or the label. The PDMS expression is evaluated once the cur‐
rently examined PDMS Interface object has been
set as the current element.
Fixed string Fixed string
Special case: Attribute value of an object other than /
the interface object.

4.5.12.4 Configuring String Parameters

Procedure
1. Open the properties of the subclass definition object.
2. Switch to the "Attributes > Name directory" tab.
3. Configure the "Name directory" table:
– Enter the name used to address the String parameter in the "Name" column.
– Configure the other columns of the String parameter depending on which task the String
parameter is to fulfill. The individual configuration options can be combined so that a
String parameter fulfils different tasks.

4.5.12.5 Assigning a COMOS value to a variable

Procedure
1. Configure the "Comos attribute" column.
See also chapter Writing a PDMS value to a COMOS attribute (import) (Page 225).
Permitted values:
– Attribute name
– Fixed string
– Call of an owner method
2. Select any data type in the "PDMS type" column.

3D Integration Administration
224 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.12.6 Assigning a PDMS value to a variable.

Procedure
1. Configure the "PDMS attribute/expression" or "GetFunction" column. See also
chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns (Page 228).
Note
When the "GetFunction" and "PDMS attribute/expression" columns are set, GetFunction has
a higher priority.

2. Select a data type in the "PDMS type" column.

4.5.12.7 Writing a PDMS value to a COMOS attribute (import)

Procedure
1. Enter an attribute name in the "Comos attribute" column.
2. Configure the "PDMS attribute/expression" or "GetFunction" column. See also
chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns (Page 228).
Note
When the "GetFunction" and "PDMS attribute/expression" columns are set, GetFunction has
a higher priority.

3. Select a suitable entry in the "Unit" column.

You are offered the entries from the unit mapping in the "Folders for class/subclass
definitions" folder.
4. Specify the data type that is to be transferred to the PML function in the "PDMS type" column.
5. Select the "Yes" entry in the "Import" column.
Note
If the "Export" and "Import" columns are activated, the "Export" column has a higher priority.
The "Import" column is not evaluated.

3D Integration Administration
Operating Manual, 03/2021 V10.4 225
COMOS PDMS interface
4.5 Configuring interface operations

4.5.12.8 Writing a COMOS value to a PDMS object (export)

Procedure
1. Configure the "Comos attribute" column.
Permitted values:
– Attribute name
– Fixed string
– Call of an owner method
2. Configure the "SetFunction" or "PDMS attribute/expression" column: See also
chapter Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and
"SetFunction" columns (Page 228).
Note
When the "SetFunction" and "PDMS attribute/expression" columns are set, SetFunction has a
higher priority.

3. Select a suitable entry in the "Unit" column.

You are offered the entries from the unit mapping in the "Folders for class/subclass
definitions" folder.
4. Specify the data type that is to be transferred to the PML function in the "PDMS type" column.
5. Select the "Yes" entry in the "Export" column.
Note
If the "Export" and "Import" columns are activated, the "Export" column has a higher priority.
The "Import" column is not evaluated.

4.5.12.9 Generating a component of the name mapping

Follow the procedure below so that the String parameter generates one of the following
components of a mapping entry in the name mapping.
• "Data item"
• "Prefix"
• "Postfix"
• "Fixed name"

3D Integration Administration
226 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Procedure
Configure the following columns of the String parameter:
1. Select the "Yes" entry in the "Admin" column.
2. Define which string the String parameter returns in one of the following columns:
– "Comos attribute"
– "PDMS attribute/expression"
– "GetFunction"
If more than one column is set, following priority applies:
"Comos attribute" > "GetFunction" > "PDMS attribute/expression"
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 228).
3. Select a data type in the "PDMS type" column.

4.5.12.10 Configuring a value comparison

Follow the procedure below so that an interface operation compares the values of a COMOS
object returned by the String parameter with the values of the PDMS object connected to it.

Procedure
1. Select the "Yes" entry in the "Check" column.
2. Access a COMOS value and a PDMS value by setting a value in the "Comos attribute" and
"PDMS attribute/expression" columns or in the "GetFunction" column.
Note
When the "GetFunction" and "PDMS attribute/expression" columns are set, GetFunction has
a higher priority.
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 228).
3. Select a data type in the "PDMS type" column.

4.5.12.11 Checking an owner

Follow the procedure below so that the "Export" interface operation uses the String parameters
to check whether it is permissible to create an object below a specific owner.

3D Integration Administration
Operating Manual, 03/2021 V10.4 227
COMOS PDMS interface
4.5 Configuring interface operations

Procedure
1. Select the "Yes" entry in the "Rule" column.
2. Access a COMOS value and a PDMS value by setting a value in the "Comos attribute" and
"PDMS attribute/expression" columns or in the "GetFunction" column.
The PDMS expression GetFunction is called at the potential owner of the object that is to be
created in PDMS.
See also chapter Configuring the "Comos attribute", "PDMS attribute/expression",
"GetFunction", and "SetFunction" columns (Page 228).
3. Select a data type in the "PDMS type" column.
The object is only created if the values are the same.

4.5.12.12 Configuring the "Comos attribute", "PDMS attribute/expression", "GetFunction", and

"SetFunction" columns
Which of these columns you configure and which entries are permitted depends on the purpose
for which you are using the String Parameter.

Permissible entries

Action Column Permissible entries

Get value from COMOS Column: "Comos attribute": • Attribute name
• Fixed string
• Call of an owner method
Set value in COMOS Column: "Comos attribute": • Attribute name
Get value from PDMS "PDMS attribute/expression" column: • Attribute name
or • Expression
• Fixed string
"GetFunction" column: • Name of a GetFunction
Set value in PDMS Column: "PDMS attribute/expression": • Attribute name
or
"SetFunction" column: • Name of a SetFunction

3D Integration Administration
228 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Notation
Use the following notation:

Column Notation
"Comos attribute" • Attribute name:
Use the NestedName: "<TabName>.<AttributeName>"
The String Parameter returns the DisplayValue of the attribute.
• Fixed string:
Set the fixed string inside double quotation marks.
• Call of an owner method:
Enter an instruction in the field that outputs the desired value. Use the key
word Owner. The same functions and properties are available as in the CO‐
MOS Object Debugger.
Example: The String Parameter should return the label of the owner of the
currently processed interface object: "Owner.Label"
"PDMS attribute/ • Attribute name:
expression" Enter the name of the PDMS attribute.
• Expression:
Enter the PDMS expression.
• Fixed string:
Set the fixed string inside single quotation marks.
"GetFunction" Enter the name of the GetFunction which is to be executed in PDMS. The Get‐
Function returns a PDMS value.
Example: "!!GetPurpose()"
"SetFunction" Enter the name of the SetFunction which is to be executed in PDMS. The Set‐
Function writes a value to PDMS.
Example: "!!SetPurpose()"

4.5.13 Configuring site mapping and location mapping in name mapping

4.5.13.1 Structure of the tables for unit mapping and location mapping
You will find the tables for unit mapping and location mapping at the subclass definition objects
of the "Cable" and "Tagged item" classes in the "Name mapping" tab.
Each table has two purposes:
• Generate a PDMS/E3D name
• Generate a COMOS object path
– Derive COMOS hierarchy and name of the COMOS object to be created.
– Define base objects for generating the hierarchy and the COMOS object.
– Assign a reference from one COMOS object to another COMOS object.

3D Integration Administration
Operating Manual, 03/2021 V10.4 229
COMOS PDMS interface
4.5 Configuring interface operations

The tables are also used for the following operations in the Engineering Interface:
• "Assign by matching names" operation
• When updating the PDMS/E3D name: "Update names" operation

Number Description
1 The columns show the name components of a PDMS name.
2 These rows are used for generating a PDMS/E3D name.
3 These rows are used for generating a COMOS object path and for creating the objects.
4 The columns show the hierarchy levels of the COMOS object path.

The mapping function is different in the plugins "COMOS PDMS Engineering Interface" and
"COMOS PDMS Interface".
• See also chapter Mapping for the COMOS PDMS Interface (Page 140).
• See also chapter Mapping for the COMOS PDMS Engineering Interface (Page 140).

3D Integration Administration
230 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Use of unit mapping or location mapping

The creation mode set at the subclass determines which table is evaluated: "General" tab,
"Structural behavior" control group, "Creation mode" list
• "Create in unit tree":
Unit mapping is performed.
• "Create in location tree":
Location mapping is performed.

Creation mode Assignment mode Usage

"Create in unit tree" "Assign to location in location Unit mapping and location mapping
tree"
"Create in unit tree" "None" Unit mapping
"Create in location tree" "Assign to location in unit Unit mapping and location mapping
tree"
"Create in location tree" "None" Location mapping

4.5.13.2 Algorithm for generating a PDMS name

A PDMS name comprises a number of name parts. Each column of the "Unit mapping" and
"Location mapping" tables creates a name part. When put together, the entries produce a full
PDMS name.

Elements of a PDMS name part

The PDMS name is defined by the following elements:

Row Description
"Prefix" Optional: The prefix of the PDMS name part.
"Suffix" Optional: The suffix of the PDMS name part.
"Data item" The data item of the PDMS name part.
"Start index" The point where a name part is inserted in the full PDMS name.
"Number of charac‐ The number of characters of the data item that are applied for the name part.
ters"

3D Integration Administration
Operating Manual, 03/2021 V10.4 231
COMOS PDMS interface
4.5 Configuring interface operations

Algorithm
To generate the name of the PDMS object to which a COMOS object is to be connected, the
interface proceeds as follows:
1. The interface checks which subclass the COMOS object has and evaluates the creation mode
of the subclass definition object:
– "Create in unit tree": Unit mapping is performed.
– "Create in location tree": Location mapping is performed.
2. The columns are evaluated. The following algorithm is executed for each column:
– The data item is evaluated.
– If no data item was defined, the column is skipped. The algorithm continues with the next
column.
– If the data item is longer than is permitted by the "Number of characters" cell, it is
truncated.
– Prefix (if necessary truncated), data item and postfix are combined to form a character
string. The character string represents a name part.
3. All PDMS name parts are combined to form a string which cannot be modified. Each name
part is copied to the position in the string defined by its start index.
4. If the index ranges of two name parts overlap, the name part of the name part evaluated later
overwrites the name part evaluated first.

4.5.13.3 Configuring generation of a PDMS name

Requirement
• You have defined the structural behavior.
• You are familiar with the algorithm for generating the PDMS name. See also
chapter Algorithm for generating a PDMS name (Page 231).

Elements of a PDMS name part

Each PDMS name part is defined by the following elements:

Row Description
"Prefix" Prefix of the PDMS name part.
• Optionally:
• Any number of characters
"Suffix" The suffix of the PDMS name part.
• Optionally:
• Any number of characters

3D Integration Administration
232 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Row Description
"Data item" The data item of the PDMS name part.
Permitted items:
• Composed expression which returns the name or label of an object from the unit tree or location
tree
• String parameter
"Start index" The point where a name part is inserted in the full PDMS name.
If nothing is entered, the name part is appended to the name parts composed up to this point.
"Number of charac‐ The number of characters of the data item that are applied for the name part.
ters" • Number
• Any number of characters permitted

Procedure
1. Open the properties of the subclass definition object of the "Cable" or "Tagged item" class.
2. Select the "Attributes > Name mapping" tab.
3. Identify where objects of the subclass are located or need to be created in your COMOS object
structure. Split the overall path into its individual nodes.
4. Analyze how the PDMS name for objects of the subclass is to be structured. You decide how
many name parts and therefore columns you are using.

3D Integration Administration
Operating Manual, 03/2021 V10.4 233
COMOS PDMS interface
4.5 Configuring interface operations

5. Enter a data item in at least one column.

The data item of a mapping entry contains either COMOS data or PDMS data. The following
data is permitted:

COMOS data PDMS data

• Return value of a String parameter which re‐ Return value of a String parameter which returns
turns COMOS data. PDMS data.
• An expression which returns the name or la‐ /
bel of an object in the unit tree.
• An expression which returns the name or la‐ /
bel of an object in the location tree.
Notation of the data item:

Notation of the String Notation of the composed expression

parameter
"!<Name of a local String First element:
parameter>" example: • In unit mapping: "U"
"!Area" • In location mapping: "L"
"!!<Name of a global Second element:
String parameter>" • "<Number>": Structure level in the tree on which the object is located
In unit mapping: Starting from the project root
In location mapping: Starting from the object "Folders for class/
subclass definitions (PDMS)"
Third element:
• "N" or "L": Use the name or label of the object
Example:
"U2L": Use the label of an object on the second level underneath the
project root in the unit tree.

6. Enter a start index and a number of characters in the same column.

7. Optional: Enter a prefix and a postfix.
8. Check which COMOS nodes and PDMS name parts can be mapped directly to one another.
Configure a shared column for these nodes and name parts.
9. Check which COMOS node does not have a corresponding PDMS name part and vice versa.
Configure a separate column for each of these nodes and name parts.
Examples of COMOS nodes which do not have a corresponding PDMS name part:
– Folder
– The PDMS root object in the "Locations" tab
– Other objects that are only used to structure the COMOS data
10.Configure the columns as described in the table below.

3D Integration Administration
234 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.13.4 Algorithm 1 for generating a COMOS object path

Algorithm
• To create an object in COMOS and complete its owner structure, the base objects that are to
be used must be known for each hierarchy level.
• To create the owner structure, COMOS evaluates the "Base object" or "Base object from
structure" row.
• To create the object which is actually searched for, the interface evaluates the UDS
":ComosBaseOb" of the PDMS object.
If the UDA is empty, the interface evaluates the "Base object for creating objects" control
group in the "General" tab of the subclass definition object.
If no base objects are specified in the "Base object for creating objects" control group, the
interface evaluates the "Base object" or "Base object from structure" row in name mapping.
This documentation assumes that this setting is made in the "General" tab.
If you define the base object via name mapping, the algorithm described below is used.

Evaluation of the "Base object" row

The here specified base object is used.

Evaluation of the "Base object from structure" row

Only activate the "Base object from structure" setting if the project is linked to a project structure
for KKS.
If the setting is activated, the interface proceeds as follows:
• It navigates to the project structure level specified in the current column.
• In a project structure, several objects with different base objects can be prepared for a single
level. The interface compares the data item or fixed name of the column with the name mask
of the possible base objects.
• The object is created with the base object whose name mask matches the data item or fixed
name.
• The data item or fixed name is entered in the "Name" property of the new object.

See also
Defining the base object for the creation of interface objects (Page 122)

3D Integration Administration
Operating Manual, 03/2021 V10.4 235
COMOS PDMS interface
4.5 Configuring interface operations

4.5.13.5 Algorithm 2 for generating a COMOS object path

Algorithm
1. The interface checks the subclass of the PDMS object.
2. The interface evaluates the creation mode of the corresponding subclass definition object:
"General" tab, "Structural behavior" control group, "Creation mode" list:
– "Create in unit tree": Unit mapping is performed.
– "Create in location tree": Location mapping is performed.
The execution of the mapping tables involves the following steps:
1. The interface extracts the PDMS name parts from the PDMS name. To do this, it evaluates the
start index and the number of characters of the corresponding mapping entry.
For the last name part, the mapping entry on the far right is used; for the penultimate name
part, the second mapping entry from the right is used, and so on.
2. The entire COMOS hierarchy of the object is composed according to this principle.
The following algorithm is executed for each mapping entry:
1. The interface checks what is entered in the "Data item" row:
– Name of a String Parameter:
Consequence: A corresponding COMOS node does not exist for the name part. Continue
with step 2.
– Name or label of a COMOS object:
If there is one: The prefix and postfix are removed from the PDMS name part. The
remaining string consists of the name or the label of a COMOS object. It is copied to the
path list.
– No entry: Continue with step 2.
2. If the "Data item" row is empty or contains a String parameter, a check is made as to whether
the "Fixname" row has been configured:
– "Fixname" is not set: The processing of the mapping table is aborted.
– "Fixname" is set: The entered or resulting string is written to the path list.
Once all mapping entries have been processed, the sequence of the entries in the path list is
reversed.

Result
• The string written to the path list produces the path to the COMOS object you are looking for.
• If the object does not exist yet, the mapping table returns all needed information in order to
create it. The name part of the last mapping entry is written to the "Name" property of the
COMOS object.
• If the interface detects that the owner structure of the object you are looking for is
incomplete: The mapping table returns all information required to complete the owner
structure.

3D Integration Administration
236 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

See also
Algorithm 1 for generating a COMOS object path (Page 235)

4.5.13.6 Configuring the generation of a COMOS object path

The next chapter describes the generation of a COMOS object path according to algorithm 1.

Requirement
• You have defined the structural behavior.
• You are familiar with the algorithm for generating the COMOS object path. See also
chapter Algorithm 1 for generating a COMOS object path (Page 235).

Elements for generating a COMOS path

Row Function Description

"Base object" Base object used to create an object. Used to complete the owner
"Base object from This row is only used for KKS structures. structure of the COMOS object or
structure" to create the object in COMOS.
Specifies whether the base object from the KKS base data struc‐
ture is to be used. You only use one of the two rows.
• "Yes": If the project is linked to a project structure, the project
structure is used for the generation of the COMOS objects.
• "No": Even if a project structure is available and linked, it is not
used.
"Fixname" Name of a COMOS object within the path to a COMOS object.

Procedure
1. Open the properties of the subclass definition object of the "Cable" or "Tagged item" class.
2. Select the "Attributes > Name mapping" tab.
3. To define the base object of the first hierarchy level, enter the following in column "1":
4. When you are working in a KKS structure: In the "Base object from structure" row, select
whether the project structure is to be used when generating the COMOS objects.
5. If you have selected "No" or are not working in a KKS structure: Enter which base object is to
be used for generating the object.
Possible values:
– SystemFullName of a base object
Use "\" to separate the individual nodes. Without quotation marks
– Local String parameter: "!<Name of a local String parameter>"
– Global String parameter: "!!<Name of a global String parameter>"

3D Integration Administration
Operating Manual, 03/2021 V10.4 237
COMOS PDMS interface
4.5 Configuring interface operations

6. To define a name for the object that is to be created, enter a value in the "Fixname" column.
Possible values:
– Local String parameter: "!<Name of a local String parameter>"
– Global String parameter: "!!<Name of a global String parameter>"
– Fixed string: Without quotation marks
7. Repeat the steps for the remaining hierarchy levels.
The column that is used last represents the object that is actually going to be created.
This documentation assumes that the base object is defined in the "Base objects for creating
objects" control group in the "General" tab of the subclass definition object. This means you
do not define a base object in the mapping tables in the column that was used last.

4.5.13.7 Configuring level rules

Procedure
To define a deviation from the standard evaluation of site mapping and location mapping,
proceed as follows:
1. Open the properties of the subclass definition object.
2. Activate the "Attributes > Name mapping" tab.
3. Right-click a field in the right-hand column of the "Level rules" table.
Result: The field is activated and highlighted in color.
4. Right-click the field a second time with the mouse.
Result: A list is displayed in the field.
5. To activate the rule, select "Yes".
To deactivate the rule, select "No".

See also
Level rules of name mapping (Page 94)

4.5.14 Configuring subclasses for PDMS queries

4.5.14.1 Workflow
Users who wish to execute and view COMOS queries in PDMS first have to complete the following
preparatory steps:
• Create however many COMOS queries the user is to execute in PDMS.
These queries are called main queries in the interface.
• Configure the main queries in the usual COMOS way.
• Create a class definition object for the "Query" class.
• For each main query: Create a subclass definition object.

3D Integration Administration
238 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

• Configure the subclass definition objects.

• If the user should have the option to select the start object of a main query from a list of
objects in PDMS:
– Create a COMOS query whose result list returns the possible start objects
This query is called the start object query in the interface.
– Configure the start object query.
– Configure the access to the start object query for the subclass definition object.

4.5.14.2 Creating and configuring query subclasses

Procedure
1. For each query that is started from PDMS and viewed, create a main query.
2. Configure the main query.
If you are using an already existing query as the main query, this step is not necessary.
3. If the user should have the option to select the start object of a main query from a list of
objects in PDMS:
Create a start object query and configure it in such a way that it returns useful start objects
for the main query.
If you are using an already existing query as the start object query, this step is not necessary.

4.5.14.3 Creating class and subclass definitions for queries

Creating class for queries

1. Click the "Units" tab in the Navigator.
2. Select the "Folders for class/subclass definitions" object.
3. Select "New > Class - queries (PDMS)" from the context menu.

3D Integration Administration
Operating Manual, 03/2021 V10.4 239
COMOS PDMS interface
4.5 Configuring interface operations

Creating query subclass definitions

To create a subclass definition object you use to manage a main query and its start object query,
proceed as follows:
1. Select the object "Class - queries (PDMS)" in the Navigator.
2. Select the command "New > Query subclass definition" from the context menu.
A subclass definition for queries is created.
3. Open the "Attributes > General" tab in the properties of the subclass definition.
"PDMS settings" control group:
– "PDMS name" field:
Enter a name for the subclass.
– "Description" field:
Enter a description. If the user has selected the query in PDMS, the description is displayed
in PDMS: "Query Comos" window, "Query" tab, "Description" field

4.5.14.4 Configuring a subclass definition object for queries

Procedure
To configure the subclass definition object you use to manage the main query and the start
object query, proceed as follows:
1. Open the properties of the subclass definition object.
See also chapter Creating class and subclass definitions for queries (Page 239).
2. Switch to the "Attributes > General" tab.
3. In the "Output format" control group, select the format in which the result list of the query
is transferred to PDMS.
– CSV
– XML
4. If CSV is set as the output format, define the column separator in the "Separator" field. You can
define any character as separator.
5. Drag&drop the main query from the Navigator into the "Main query" control group, "Query
object" field.
6. Drag&drop an object into the "Start object" field.
The name of the referenced start object is displayed to the user in PDMS: "Comos Query"
window, "Query" tab, "Start object" field
If you are using an already existing query as the main query, you can define a different start
object than the one set in the main query.
7. Drag&drop the base objects according to which the query is to filter the result list from the
Navigator to the "Base objects" column.
If you are using an already existing query as the main query, you can have the query filtered
in PDMS by base objects other than those defined by the main query in COMOS.

3D Integration Administration
240 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

8. "Query for start objects" control group:

9. If the user is to have the option of selecting the start object of a main query from a list of
objects in PDMS, configure the "Query for start objects" control group.
– Drag&drop the query for start objects from the Navigator into the "Query object" field.
The start object query returns the list of possible start objects in PDMS.
– Drag&drop an object into the "Start object" field.
– Drag&drop the base objects according to which the query is to filter the result list from the
Navigator to the "Base objects" column.
If you are using an already existing query as the start object query: You can filter the query
in PDMS on the basis of base objects other than those defined by the main query in
COMOS.

Evaluation priority for the start object

You can define the start object of the query at various places. The following table lists these
places.
If a start object has been defined in multiple places, the places which appear further down the
table overwrite those above them.

Start object of the main query Start object of the query for start objects
Start object that is set in the COMOS query Start object that is set in the COMOS query
Start object that was set for the subclass definition Start object that was set for the subclass definition
object object
Start object that the user defined in PDMS: /
"Comos Query" window, "Execute" tab

4.5.15 Configuring "Import DocLinks"

4.5.15.1 Defining the entry for the target document in PDMS

The "Import DocLinks" operation is called in PDMS. It creates DocObjs for draft objects under a
COMOS document specified in the draft structure.
To import draft objects into COMOS as DocObjs, the COMOS document for which the DocObjs
are being created must be known.
For this purpose, you should define an attribute or a UDA in which the user will subsequently
enter the name or the SystemUID of the target document.
You decide the levels of the draft structure at which it is possible to specify target documents.

Defining target documents on different levels of the draft structure

You can specify a target document at more than one level of the draft structure. This enables the
user to start the DocLink import as required at different levels of the draft structure, e.g. for all
draft objects of a region, for an individual view or for an individual drawing.

3D Integration Administration
Operating Manual, 03/2021 V10.4 241
COMOS PDMS interface
4.5 Configuring interface operations

To do this, repeat the below described procedure for all levels for which the "Import DocLinks"
operation needs to be available.

Procedure
To define where the target document is specified, proceed as follows:
1. Define whether the user enters the name of the target document in an attribute or in a UDA
and which attribute or UDA is used.
2. Define the level of the draft structure on which the user specifies the name of the target
document.
3. If you are using a UDA, create the UDA.

4.5.15.2 Configuring "Import DocLinks" operation in COMOS

Procedure
1. Create a "Document subclass definition" object.
2. Define a String parameter in the name directory of the subclass definition object. The String
parameter is to access the attribute or UDA in which the name or SystemUID of the target
document is entered. See also chapter Defining the String Parameter for the document name
(Page 242).
3. Configure the general properties of the subclass definition object. See also
chapter Configuring general settings (Page 243).
4. Optional: On the "Owner restriction rules" tab, specify whether the owners of the template
objects for which DocObjs are being created have to meet certain conditions.

4.5.15.3 Defining the String Parameter for the document name

Define a String parameter which, from PDMS, reads out the name of the COMOS document
under which the DocObjs are imported.

Procedure
1. Open the properties of the "Document subclass definition" object and switch to the "Name
directory" tab.
2. Configure the "Name directory" table:
– "Name" column: Enter the name of the String parameter.
– "PDMS attribute/expression" or "GetFunction" column: Access the value of the attribute or
the UDA in which the document name or the SystemUID is saved in PDMS. See also
chapter Configuring general settings (Page 243).
– "PDMS type" column: Enter "String".

3D Integration Administration
242 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

4.5.15.4 Configuring general settings

Procedure
To define the general settings of the "Document subclass definition" object, proceed as follows:
1. Open the properties of the "Document subclass definition" object.
2. Switch to the "Attributes > General" tab.
3. "Document ID" field:
– Enter the name of the String parameter which reads out the document name from PDMS.
– Do not precede the name of the String parameter with a "!" character.
4. Optional: Define filters in the "Base object for document search" control group:
During the search, the interface restricts itself to documents which meet the criteria defined
here. This speeds up the search.
The following filters are possible:
– "Document type" list: Define the document type of the document.
– "Base object for document search" field: Define the base object the document uses.
– "Base object" field: Define the node below which the document is searched.
5. Optional: Activate the "Filter unnamed objects" option:
In PDMS, only objects with a name are displayed in the result list in the "Export to Comos"
window.
6. Enter the PDMS element types of the following template objects in the table: Template
objects with a DDNM attribute that references a design object that is connected to a COMOS
object.

4.5.15.5 Defining owner restriction rules for draft objects

Procedure
You can define owner restriction rules which the template objects have to meet to be imported
as DocObjs.
For this purpose, proceed in the same way as with the definition of owner restriction rules on
subclass definition objects of the "Cable" and "Tagged item" classes. See also chapter Specifying
restriction rules for owners (Page 219).

3D Integration Administration
Operating Manual, 03/2021 V10.4 243
COMOS PDMS interface
4.5 Configuring interface operations

4.5.16 Synchronizing classes and subclasses in COMOS and PDMS

Initial situation
To ensure that COMOS and PDMS use the same settings, the interface does not directly access
the settings for the "Folders for class/subclass definitions" object and for the class and subclass
definition objects. Instead, the settings are written to an XML file in the exchange directory.
COMOS and PDMS load the settings from the file to the working memory of your computer.
When an interface operation is called, the current version number of the "Folders for class/
subclass definitions" object is transferred. The operation checks whether the number is identical
to the version number of the settings stored in the work memory.
• Yes: The settings stored in the work memory are used.
• No: The file is loaded to the work memory again. The settings are synchronized.
If synchronization was successful, ensure that the file in the exchange directory contains the
current settings.
Update the file whenever you have performed one of the following actions:
• You changed the settings of the "Folders for class/subclass definitions" object.
• You created a new class or subclass definition object.
• You changed the settings of a subclass definition object.

Procedure
To update the file in which the settings for the "Folders for class/subclass definitions" object and
the class and subclass definition objects are saved, proceed as follows:
1. Select the "Folders for class/subclass definitions" object in the Navigator.
2. Select the following command from the context menu: "PDMS > Save subclasses".

Result
• The version number at the "Folders for class/subclass definitions" object is incremented.
• The standard table for subclasses is updated.
• The settings for the "Folders for class/subclass definitions" object and for the class and
subclass definition objects are written to the file in the exchange directory.

4.5.17 Importing classes, subclasses and "Folders for classes/subclasses" object from
XML file
If you are working in different project structures with different requirements, the classes,
subclasses and the "Folders for classes/subclasses" object must be configured according to the
respective requirements. To avoid having to edit the objects every time you switch to a new
project structure, you can import the completely configured objects from an XML file and have
them created in COMOS.

3D Integration Administration
244 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

This means you can create an XML file for each project structure and import it as needed.

Requirement
You have access to at least one XML file which was previously created or updated using the "Save
subclass" function. You can name the file as you wish.
The XML files are located in the directory that is specified in the SubclassesFile node in the
initialization file.

Procedure
1. Select the "Folders for class/subclass definitions" object in the Navigator.
2. Select the following command from the context menu: "PDMS > Import subclasses".
3. Select the following command from the context menu: "PDMS > Save subclasses".

Result
• If a "Folders for classes/subclasses" object already exists, the object is deleted with all its
classes and subclasses.
• The "Folders for classes/subclasses" object from the XML file is created in the Navigator
together with its classes and subclasses.

4.5.18 Importing AVEVA design templates

Initial situation
You can assign an AVEVA design template to an interface object as a model.
To do this, you need to import the design templates from PDMS into COMOS.

Procedure
1. Switch to the "Base objects" tab in the Navigator.
2. Select the following node: "@20 > D30 > A30 > Y00R00038 Objects for design template
structure".
3. In the context menu, select the following command: "PDMS > Update design templates".

Result
• The GTypes of all templates are evaluated in PDMS.
• The templates are imported from PDMS to COMOS. During this process, the interface
proceeds as described below.

3D Integration Administration
Operating Manual, 03/2021 V10.4 245
COMOS PDMS interface
4.5 Configuring interface operations

Managing the design templates in the base data

The design templates are managed under the following node in the base data:
"@20 > D30 > A30 > Y00R00038 Objects for design template structure"
The design templates are managed sorted by GType:
• Nodes which represent the GTypes of the templates are located on the first level below the
"Objects for design template structure" object.
• The nodes for the templates are located on the second level. A node is created for each
template.

Algorithm for importing the design templates into the base data
• For each GType found in PDMS, a search is performed below the "Objects for design template
structure" object for a node whose name matches the name of the GType.
• If a node of this type does not exist yet, it is created. The name of the GType is entered in the
"Name" property of the node.
• A node for the design template is created underneath the GType node.
• If the design template already exists, it is updated. No data is deleted during the update
operation.
Example:
– A sub template was deleted in PDMS.
– The sub template remains available in COMOS even after the update.
• The attributes of the template node are automatically set when the template node is created
or during the update.

4.5.19 Configuring COMOS interface objects

4.5.19.1 Assigning the class, subclass, and PDMS element type

Procedure
To assign a class, a subclass, and PDMS element types to an interface object, proceed as follows:
1. Click on the "Base objects" tab in the Navigator.
2. Navigate to an interface base object.
3. Open the properties of the interface base object.
4. Switch to the "Attributes > External 3D Interface" tab.
5. Configure the tab as described below.

3D Integration Administration
246 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

6. "Class" list:
– Select a class.
– Do not select the "Undef" value. Otherwise, the object will not be recognized as an
interface object.
7. "Subclass" list:
Select a subclass. Only subclasses permitted for the selected class are offered.
8. "PDMS element type" list:
Select a PDMS element type. Only those element types entered for the selected subclass are
offered.

Overwriting the preselection in the engineering view

In the database, the edit mode of these attributes is configured in such a way that users can
overwrite the inherited settings in the engineering view, if this is necessary.

4.5.19.2 Overwriting the inherited model information

Requirements
• The following has already been assigned to the interface object:
– Class
– Subclass
– PDMS element type
• AVEVA templates have been imported.

Inheritance of subclasses
The database is configured in such a way that the interface objects apply the model information
settings from their subclass. For this purpose, the model attributes of the interface objects are
linked to those of the subclass definition objects.
Link type: Static link via the "GetLinkedSpecification" script function.
You can overwrite the settings for the base objects of the interface objects taken from the
subclass.

Procedure
To define the model information at the base object of the interface object, proceed as follows:
1. Click on the "Base objects" tab in the Navigator.
2. Navigate to an interface base object.
3. Open the properties of the interface base object and switch to the "Attributes > External 3D
Interface" tab.

3D Integration Administration
Operating Manual, 03/2021 V10.4 247
COMOS PDMS interface
4.5 Configuring interface operations

4. Define how the model will be generated in the "Model" control group, "Mode" list. Select one
of the following modes:

Mode Interface object has sub‐ Interface object has Result

class of "Cable" class subclass of "Tagged
item" class
"Design tem‐ / Available if the sub‐ The geometry is based on a de‐
plate" class has the "EQUI" sign template.
PDMS element type
"PDMS ele‐ / Available The geometry is copied from an
ment" existing PDMS element.
"Function" Available Available The geometry is generated by a
function which is also performs
other initializations.
"None" Available Available A box is generated.

5. Depending on which mode you have selected, you now need to define the details for the
generation of the model:
– "Function" mode:
Enter the function call in the "Function" field.
– "PDMS element" mode:
Enter the name of the PDMS element whose geometry is being copied in the "Element"
field.
– "Design template" mode:
Define the main template in the "Design template" control group, along with the used sub
templates which, if applicable.

Defining design templates

If the following conditions are met, you can select design templates as the basis for your model:
• The subclass of the interface object has the "Tagged item" class.
• The subclass has the "EQUI" PDMS element type.
If you select a design template as the basis for your model, you need to configure the "Design
template" control group.
Proceed as follows:
1. Select the main document template in the "Main document template" list.
Only those templates whose GType has been entered in the subclass in the "GTypes for
filtering" field are offered for selection.
If the the "EQUI" PDMS element type is missing at the subclass, the list remains empty.
2. You can define up to five templates for secondary equipment in the "Sub template 1" to "Sub
template 5" lists:
Which templates are offered depends on the main template you selected.

3D Integration Administration
248 Operating Manual, 03/2021 V10.4
 COMOS PDMS interface
4.5 Configuring interface operations

Design templates in the engineering view

When COMOS creates an interface object in the engineering view, it automatically checks
whether the interface object uses a design template. If it does, COMOS creates the main
document template underneath the interface object and the sub templates underneath that.
COMOS creates the template objects when you assign a design template to an existing interface
object.
• Name of the template object: "Y00R00038"
• Description of the template object: As defined at the base object of the template object
You can change the design parameters of the template objects in the engineering view:
Properties of the template object, "Attributes > External 3D Interface" tab, attributes
"Y00A02118AA01 DP 01" through "Y00A02118AA10 DP 10".

Overwriting the base object settings in the engineering view

Users can overwrite both the settings inherited from the subclass and the settings predefined at
the base object in the engineering view.

Restoring the default settings

The settings inherited from the subclass can be restored in the engineering view using the
"Refresh static links on tab" context menu.

3D Integration Administration
Operating Manual, 03/2021 V10.4 249
COMOS PDMS interface
4.5 Configuring interface operations

3D Integration Administration
250 Operating Manual, 03/2021 V10.4
Reference to "COMOS 3D Viewing" 5
You can find documentation on this topic in the Installation Package of the "COMOS Walkinside"
software. You can find additional information on this topic in the "COMOS Walkinside" manual,
keyword "COMOS Walkinside Integration".

3D Integration Administration
Operating Manual, 03/2021 V10.4 251
Reference to "COMOS 3D Viewing"

3D Integration Administration
252 Operating Manual, 03/2021 V10.4
Exporting COMOS pipe specs to PDMS 6
You export pipe specs to PDMS with the "PDMS pipe spec export" plugin. In this plugin, you
specify the pipe specs that are to be exported from COMOS based on a mapping definition. You
have created or adjusted the mapping definition beforehand in the Generic Data Mapper.
Structure mapping definitions for PDMS have a special structure. We are using the Generic Data
Mapper in this chapter to describe which rules are in effect for structure mapping definitions,
how the supplied structure mapping definitions are structured, and what you need to observe
when you edit or create a new definition.
You can find additional information on this topic in the "Generic Data Mapper" manual.

3D Integration Administration
Operating Manual, 03/2021 V10.4 253
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

6.1 Overview of the work sequence

Some preparatory steps are required before the export can take place. The diagram below gives
you an overview of the process.

&2026 3'063DUDJRQ

*HQHULF'DWD0DSSHU

,PSRUWWKHWHPSODWHFDWDORJ ([SRUWDWHPSODWHFDWDORJ
VFKHPDLQWRWKH3URYLGHU VFKHPD

&UHDWHRUHGLWPDSSLQJ
GHILQLWLRQ

(QWHUPDSSLQJGHILQLWLRQLQWKH
SURMHFWSURSHUWLHV

3'06SLSHVSHFH[SRUW

&UHDWHZRUNSDFNDJHILOHZLWK
ZRUNSDFNDJHV ,PSRUWSLSHVSHFV
IURPWKHZRUNSDFNDJHV

([SRUWZRUNSDFNDJHV &UHDWHSLSHFODVVHVDQG
SLSHSDUWFDWDORJ

6.2 Administration of pipe spec export

6.2.1 Receiving the COMOS template catalog

You receive the COMOS template catalog via the Setup browser.

3D Integration Administration
254 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Procedure
1. Open the Setup browser. You can find additional information on this topic in the "Installation
and Configuration" manual, keyword "Installing COMOS with the installation wizard".
2. Select the menu "COMOS Portfolio > COMOS 3D Integration".
3. Copy the COMOS template catalog to your drive.
4. Import the catalog in PDMS/E3D.

6.2.2 Exporting the schema of a template catalog from PDMS

You must export the schema of an existing template catalog from PDMS/E3D so that you can
work with the Generic Data Mapper. The schema is saved in a .PROVIDER file after the export.
A template catalog is only exported when one of the following requirements is met:
• Only one "SCOM" element is located below a "CATE" element.
• If there are multiple "SCOM" elements below a "CATE":
– The number of parameters of all "SCOM" elements must be the same.
– The types of parameters of all "SCOM" elements must be the same.
– The references in the "Ptref", "Gmref" and Dtref" properties of all "SCOM" elements must
match.

Requirement
You have imported the COMOS template catalog in PDMS/E3D. See also chapter Receiving the
COMOS template catalog (Page 254).

Procedure
1. Start PDMS/E3D.
2. Open the COMOS PDMS/E3D Engineering Interface plugin. You can find additional
information on this topic in the "3D Integration Operation" manual, keyword "Opening the
COMOS PDMS/E3D Engineering Interface".
3. Click the "COMOS > Export PDMS Schema" menu.
4. Select a template catalog.
5. Click "Set template catalog".
6. Click "Export schema".
7. Select a file name and a storage location for the created .PROVIDER file.
8. Confirm your entries.

Result
A file "<file name>.provider" is created.

3D Integration Administration
Operating Manual, 03/2021 V10.4 255
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

You can integrate the schema in the Generic Data Mapper in order to create and edit mapping
definitions. See also chapter Integrating the schema in the Generic Data Mapper (Page 256).
It includes the following:
• SCOM database objects of the exported template catalog
• Types of the PDMS objects
• Default attributes
• User-defined attributes
• Data types of attributes
• Dimensions
• Units
• References
• Relations
See also chapter Special features of the PDMS schema (Page 257).

6.2.3 Integrating the schema in the Generic Data Mapper

Requirement
As administrator, you are familiar with the "Generic Data Mapper" plugin.

Procedure
1. Open the "Generic Data Mapper" plugin.
2. Create a new mapping definition or load an existing one.
3. If you have created a new mapping definition, select the following as the schema provider:
"ECXMLSchemaProvider".
4. Configure the source provider and target provider.

Result
The schema is mapped in the "Target schema" control group on the "Classes" tab.

3D Integration Administration
256 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

6.2.4 Special features of the PDMS schema

Structure of the schema

6\VWHP

:RUOG

(OHPHQWW\SHV
$UHDUUDQJHGLQDWUHH
DFFRUGLQJWRWKHLUUHODWLRQV

7HPSODWH

&DWDORJGHYLFHV
&DWDORJGHYLFHVQRWUROOHGRXW
ZKLFKFDQEHXVHGDV
WHPSODWHIRUSLSHSDUWFDWDORJV

Note
Only one relation at a time is visible in the tree view
Element types can have many relations. However, elements can only be displayed within one of
their relations in the tree view. To view all relations of an element type, select the "Relations" tab
in the "Target schema" control group.

Representation of references
References are mapped using Relation <A> has reference attribute <B> and not as attributes in
the Generic Data Mapper.

3D Integration Administration
Operating Manual, 03/2021 V10.4 257
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Relations
The following relations are part of the PDMS schema:
• <A> has child <B>
Meaning: <B> is a child element of <A>
• <A> has reference attribute <B>
Meaning: In PDMS, an object of the type <A> can have attributes <B> which include a
reference to another object.
The name of the referenced object must be specified in attribute <B>. If the object does not
yet exist in PDMS, the hierarchy of the object must be specified in the target structure so that
it can be created.
• <A> is templated by <B>
Meaning: <A> is created based on object <B> from the template catalog.
You use this relation for objects of the type "SComponent", which are to be created on the
basis of a template object from the COMOS template catalog.

6.2.5 Content and structure of the example mapping definition "Tee mapp"
You an request an example mapping definition from your client manager.
The example mapping definition includes structure mapping definitions for the mapping of
pipes, T-pieces and other frequently used components.
To use the mapping definition productively, adapt it to meet your project data. See also chapter
Editing an example mapping definition (Page 263).
The following section provides a description of the structure of structure mapping definitions
based on the structure mapping definition "Tee mapp".

Requirement
• You know the special features for mapping the PDMS scheme. See also chapter Special
features of the PDMS schema (Page 257)
• You have opened the example mapping definition in the Generic Data Mapper and selected
the structure mapping definition "Tee mapp".

3D Integration Administration
258 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Rules for selectors

The target attributes "IdCreation" and "TANS" must be assigned the same source attribute with
the same display option for correct data to be generated.
• Assignment of an IdCreation: Causes selectors to be created during the current export
depending on the number of found T-pieces and that they are recognized as being related.
• Assignment of the TANS:
– A check is performed during import in PDMS if a selector with the same TANS already
exists. If it does, both selectors are considered to be identical. A new selector is not created
in PDMS.
If no selector with this TANS exists, a new selector is created.
– The value serves as a response of the higher-level selector in PDMS.
Further rules: See chapter Editing an example mapping definition (Page 263).

Fixed and variable values for "IdCreation"

Special rules apply to "IdCreation" in connection with fixed and variable values in PDMS which
deviate from the standard behavior.
If you use IDs, an additional ID is appended to the target object which originates from the parent
node. You can overwrite this parent ID by entering a fixed ID with the prefix "#".

What to specify as value for "IdCreation" Result

Variable ID (assignment) Example: SystemUID SystemUID+ParentID
Fixed ID (manual) Example: ID_1 ID_1+ParentID
Fixed ID with # (manual) Example: #ID_1 #ID_1
Variable ID + ID (assignment and Example: SystemUID + ID_1 SystemUID+ID_1+ParentID
manual)
Variable ID + #ID (assignment Example: SystemUID + #ID_1 SystemUID+#ID_1
and manual)

Structure mapping definition "Tee mapp"

Source structure:
• COMOS components, such as the T-piece, are instantiated components. The structure must
include two structure elements "T-piece" so that an individual T-piece can be created for each
nominal diameter within the nominal diameter range of the T-piece in PDMS. Both structure
elements are based on the same schema element.
Target structure:
• The exported data are created under the "SPWLD" node.
• New catalog objects are created or existing catalog objects are updated under the "Catalog"
node.

3D Integration Administration
Operating Manual, 03/2021 V10.4 259
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Picture elements Description

Gray arrows: Display the attribute associations of the following target attributes:
• "IdCreation": These attribute associations play a central role because they identify identical objects
and therefore control the number of created objects.
• "TANS": You can find this target attribute at selectors. The value assigned to this attribute deter‐
mines the scope of the selector.
• Parameter values to be transferred from COMOS to the template object.
To the right of the structure element, you can see the attribute associations displayed with an arrow.
Other attribute associations are not shown in this graphic.
Red arrows: Display element associations. Element associations can also include attribute associations.
Blue label: Displays relations between structure elements which have a special effect. These are explained below.
All other structure elements have a "has child" relation. They are not shown in the graphic.
IDs according to the These IDs are fixed IDs. They are entered manually at the structure element in the "IdCreation" attrib‐
pattern "#ID_<coun‐ ute in the "Initial value" column. The label of the IDs does not correspond to the original ID in the
ter>" mappings and is only an example.

3D Integration Administration
260 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

6WUXFWXUHPDSSLQJGHILQLWLRQ 7HHPDSS
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH


7HPSODWHREMHFW :RUOG ,'B
IRUSLSHVSHF

63:/' ,'B

7SLHFH 
6SHFLILFDWLRQ 6\VWHP8,'!,G&UHDWLRQ

 3DUWGHVFULSWLRQ 'LVSOD\9DOXH !,G&UHDWLRQ

7SLHFH 6HOHF
3DUWGHVFULSWLRQ 'LVSOD\9DOXH !7$16

1RPLQDOGLDPHWHU 'LVSOD\9DOXH !,G&UHDWLRQ
6HOHF
1RPLQDOGLDPHWHU 'LVSOD\9DOXH !7$16

6HOHF 1RPLQDOGLDPHWHU 'LVSOD\9DOXH !,G&UHDWLRQ
1RPLQDOGLDPHWHU 'LVSOD\9DOXH !7$16

6HOHF 0DWHULDOQR 'LVSOD\9DOXH !,G&UHDWLRQ
0DWHULDOQR 'LVSOD\9DOXH !7$16

63&RPSRQHQW 6\VWHP)XOO1DPH!,G&UHDWLRQ
6\VWHP8,'!7$16

KDVUHIHUHQFHDWWULEXWH
6&RPSRQHQW 6\VWHP8,'!,G&UHDWLRQ
&$75 ,'B

&DWDORJXH ,'B


6HFWLRQ ,'B


&DWHJRU\ 1DPH!,G&UHDWLRQ


6\VWHP8,'!,G&UHDWLRQ
KDVFKLOG 6&RPSRQHQW
,'B

LVWHPSODWHGE\ &,6B7HH6&20 $VVLJQPHQWRIWKHSDUDPHWHU
&,6B7HH6&20
YDOXHV

6'7H[W

Number Description
① "World" must be the root node of all target structures so that the export to PDMS works properly.
Fixed ID "#ID_1": Entered in all structure mapping definitions at the "World" node. Ensures that "World" is only
created once in PDMS. If an object with the name that was assigned to the "World" structure element already
exists in PDMS, a new object is not created.
② Fixed ID "#ID_2": Entered in all structure mapping definitions at the "SPWLD" node. Ensures that "SPWLD" is only
created once in PDMS. If an object with the name that was assigned to the "SPWLD" structure element already
exists in PDMS, a new object is not created.

3D Integration Administration
Operating Manual, 03/2021 V10.4 261
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Number Description
③ A "Specification" object is created in PDMS for each "Template object for pipe spec" object with the same Sys‐
temUID.
• Question for next selector: The question for identification of the selector is entered manually in the "Initial‐
Value" column in the "TQUES" attribute of the structure element: TYPE
④ See "Special features of structure mapping definitions for PDMS".
DisplayValue of the "Part description" attribute is assigned to the "IdCreation" attribute. It ensures that the
selector is exported only once for the same part description.
• Answer: DisplayValue of the "Part description" attribute is assigned to the "TANS" attribute.
• Question for next selector: The question for identification of the selector is entered manually in the "Initial‐
Value" column in the "TQUES" attribute of the structure element: PBOR
⑤ See "Special features of structure mapping definitions for PDMS".
DisplayValue of the "Nominal diameter2" attribute is assigned to the "IdCreation" attribute. It ensures that the
selector is exported only once for the same nominal diameter2.
• Answer: DisplayValue of the "Nominal diameter2" attribute is assigned to the "TANS" attribute.
• Question for next selector: The question for identification of the selector is entered manually in the "Initial‐
Value" column in the "TQUES" attribute of the structure element: PBOR
⑥ See "Special features of structure mapping definitions for PDMS".
DisplayValue of the "Nominal diameter1" attribute is assigned to the "IdCreation" attribute. It ensures that the
selector is exported only once for the same nominal diameter1.
• Answer: DisplayValue of the "Nominal diameter1" attribute is assigned to the "TANS" attribute.
• Question for next selector: The question for identification of the selector is entered manually in the "Initial‐
Value" column in the "TQUES" attribute of the structure element: PBOR
⑦ See "Special features of structure mapping definitions for PDMS".
DisplayValue of the "Material number" attribute is assigned to the "IdCreation" attribute. It ensures that the
selector is exported only once for the same material number.
• Answer: DisplayValue of the "Material number" attribute is assigned to the "TANS" attribute.
⑧ For each "T-piece" object with the same SystemUID: A "SPComponent" object is created in PDMS.
The "SPComponent" object references the "SComponent" object in the catalog by means of the CATR attribute.
⑨ This structure element is a reference to the "SComponent" catalog component.
A reference to a SComponent catalog object with the same SystemUID is created for each "T-piece" object in the
CATR attribute of the SPComponent.
A search is started for an "SComponent" object with the same fixed ID under the "Catalogue" node when you
created the reference. If it is not found, it is created. The fixed ID "#ID_3" connects the referenced SComponent
with the SComponent in the catalog and identifies the objects as being identical.
⑩ Fixed ID "#ID_4": Entered in all structure mapping definitions at the "Catalog" node. Ensures that "Catalog" is only
created once in PDMS. If an object with the name that was assigned to the "Catalog" structure element already
exists in PDMS, a new object is not created.
⑪ Fixed ID "#ID_5": Entered in all structure mapping definitions at the "Section" node. Ensures that "Section" is only
created once in PDMS. If an object with the name that was assigned to the "Section" structure element already
exists in PDMS, a new object is not created.
⑫ A "Category" object is created for each "T-piece" object with the same name in PDMS. The created object serves
as folder for the T-pieces that are created in the next step.

3D Integration Administration
262 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Number Description
⑬ For each "T-piece" object with the same SystemUID: An "SComponent" object is created in the catalog in PDMS
for each nominal diameter in the nominal diameter range of the T-piece.
The created T-pieces are formed on the basis of an object from the COMOS template catalog.
⑭ Reference to the object from the COMOS template catalog on the basis of which all T-pieces in the catalog are
formed. The template component includes the parameters that a T-piece can have.
All attributes of the T-piece from COMOS which are to be applied in PDMS as parameters are assigned to this
structure element. The default values in the template are overwritten.

6.2.6 Editing an example mapping definition

To adapt a mapping definition to your project data, you must edit its structure mapping
definitions.

Note
Make sure that names and attribute values comply with the PDMS rules
The Generic Data Mapper does not check if the object name or other values you would like to
export comply with the PDMS rules. This means you have to make sure that you are exporting
valid values to PDMS. If values do not comply with the PDMS rules, an error is displayed in the
"Status" area during import in PDMS.
Example: Names may not include any spaces.
• With errors in names:
PDMS creates the object and specifies a standard name.
• With errors in other values:
PDMS creates the object and the attribute value remains empty.

Requirement
You understand the structure of the supplied structure mapping definitions. See also
chapter Content and structure of the example mapping definition "Tee mapp" (Page 258).

3D Integration Administration
Operating Manual, 03/2021 V10.4 263
Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Rules for editing the mapping definitions

• When you edit the structure mapping definitions or create new structure mapping
definitions, you must map the complete path up to the root node "World" in the target
structure.

• Objects whose structure elements were not assigned a name through an attribute
association or whose name does not yet exist in PDMS are created again in PDMS.
Objects whose name already exists in PDMS, are not created again in PDMS. The existing
PDMS objects are updated.
Exception: If objects of the type "SELEC" are not found based on their names in PDMS, the
selectors are determined based on the values in their "TANS" property. If no matching
selectors are found, they are created in PDMS.
• Objects with a "has reference attribute" relation whose catalog object cannot be found based
on the name in PDMS, must be created with the help of the structure mapping definition. The
referenced object is located under the node "SPWLD" in this case and the catalog object below
the node "Catalog". The following information is required for the referenced object and the
template object to be identified as related:
– The same unique value must be assigned to the "IdCreation" attribute at both structure
elements by an attribute association.
– Both structure elements must have the same fixed ID with "#" as prefix in the "IdCreation"
attribute.
• Parameter values are assigned to the structure element which specifies the template object
and has the relation "is templated by". Other attribute values are assigned to the
"SComponent" catalog object.
When the "SComponent" catalog object is created with the help of the template object, the
assigned parameter values are transferred to the SComponent.
• Source structure:
The structure must include two structure elements for the same components for which there
is a parent-child relation, so that an individual component can be created for each nominal
diameter within the nominal diameter range of the component in PDMS. See also
chapter Content and structure of the example mapping definition "Tee mapp" (Page 258).
Both structure elements are based on the same schema element.

3D Integration Administration
264 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.2 Administration of pipe spec export

Editing structure mapping definition

Note
Changes to relations in the target structure can cause creation of incorrect data in PDMS.
When you change relations, you may have to adjust the data in PDMS so that the export still
creates correct data.

Note
Changes to fixed and assigned values for "IdCreation" can cause creation of incorrect data
in PDMS
"IdCreation" is mainly responsible for creating the correct tree structure in PDMS. When you
change values for IdCreation, make sure that you understand the logic of the functionality.
• See also chapter Content and structure of the example mapping definition "Tee mapp"
(Page 258).

1. Open a structure mapping definition in the "Generic Data Mapper" plugin.

2. Optional: Replace the schema elements within the structure elements with other elements.
3. Optional: Insert additional schema elements in a structure element.
4. Optional: Change initial attribute values or specify new initial values.
5. Optional: Remove the structure levels in the target structure or add new ones.
6. Optional: Modify the structures using the modifiers.
7. Optional: Change, remove or add new attribute associations.

Create a new structure mapping definition

1. Click "Add structure mapping definition".
2. Rename the definition.
3. Create structures according to the sample in the supplied example mapping definition.

6.2.7 Configuring PDMS pipe spec export

Procedure
1. iDB: In the project properties select the category "Process engineering > Engineering Adapter
> PDMS pipe class export".
cDB: In the menu, click the entry "Plugins > 3D Engineering Adapter > Engineering Adapter
Configuration". Select the category "PDMS pipe spec export".
2. In the "Path for exported workpackages" field, select the directory to which the exported
workpackages are to be saved.

3D Integration Administration
Operating Manual, 03/2021 V10.4 265
Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

3. Optional: In the "Pattern for folder names of exported workpackages" field, change the
specification of the pattern by which the folders are named to the location where export pipe
specs are saved.
Example:
– Preselected pattern: ${CurrentScope.Name}_${CurrentUser.Name}_$
{CurrentDateTime:yyyy-MM-dd_HH-mm-ss.ffff}
– Name of created folders: "Workpackage1_WindowsUser1_2015-03-15_23-30-15.2345"
The date and time information corresponds to the .NET formatting of
the DateTime.ToString().
Additional information is available at:DateTime.ToString (http://msdn.microsoft.com/en-us/
library/zdtaw1bw(v=vs.110).aspx)
4. In the "Mapping definition for export" field, select a mapping definition which you have
created in the Generic Data Mapper. File format: GMAD
5. In the "Mapping result validation" field, select whether you want to display a preview of the
exported data.
– "Verification":
Displays a preview once you have exported one or more workpackages. The
workpackages are only exported and saved in the exchange directory once you have
confirmed the preview.
– "None":
No preview is displayed. The workpackages are exported and saved in the exchange
directory.
– "Information":
Displays a preview for information purposes after the export. The workpackages are
exported and saved in the exchange directory.

6.3 Exporting pipe specs

You are carrying out the pipe spec export in the "PDMS pipe spec export".
You compile the export set in this plugin and save it in a file. This file can contain any number or
workpackages.
A workpackage contains a set of pipe specs which you have exported as a bundle. Each pipe spec
is saved after the export in a separate .SPEC file which you can import into PDMS.

6.3.1 Opening "PDMS pipe spec export"

Procedure
In the COMOS menu, select the entry "Plugins > CAE Apps > Aveva > PDMS pipe spec export".

3D Integration Administration
266 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

6.3.2 Creating a workpackage file

When you open the "PDMS pipe spec export" plugin, there is initially an empty workpackage file
in which the workpackage is stored. To create a new file while working, follow these steps.

Procedure
1. Edit the contents or the number of workpackages in the open file.
2. Click "Save workpackage file".
3. Enter a different name for the file.

6.3.3 Loading workpackage file

Procedure
1. Click the "Load workpackage file" button.
2. Select an scd file you have created beforehand.
The workpackages of the file are displayed in the "Workpackages for pipe specs" control
group.

6.3.4 Creating workpackages

Procedure
1. Click the "New workpackage" button.
A new workpackage is created. A detail view is displayed in the "Detail view of workpackages"
control group.
2. Drag&drop the pipe specs from the pipe spec catalog to the detail view of the workpackage.

6.3.5 Editing workpackages

Requirement
You have created at least one workpackage and inserted pipe specs in it.

Removing pipe specs from workpackages

1. Move your mouse over a pipe spec in the "Detail view of workpackage" control group.
2. The buttons are displayed in the "Actions" column.
3. Click "Remove workpackage entry".

3D Integration Administration
Operating Manual, 03/2021 V10.4 267
Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

Renaming workpackages
1. Move your mouse over a workpackage in the "Workpackage with pipe specs" control group.
The buttons are displayed in the "Actions" column.
2. Click "Edit workpackage".
3. Edit the name.

6.3.6 Exporting workpackages

Procedure
• To export all workpackages of the workpackage file, click "Export all workpackages".
• To export an individual workpackage, place your mouse on the workpackage in the
"Workpackage for pipe specs" control group.
The buttons for editing the workpackage are displayed in the "Actions" column.
Click "Export workpackage".
• To export all workpackages that are open in the control group, click "Export opened
workpackages".

Result
A folder is created for each exported workpackage in the directory that you have specified in the
"Path for exported workpackage" field in the project properties. See also chapter Configuring
PDMS pipe spec export (Page 265).
Each pipe spec of the workpackage is included in a SPEC file in the respective folder.
You import the .SPEC files when you import the COMOS pipe specs into PDMS later. See also
chapter Importing COMOS pipe specs to PDMS specs (Page 270).

6.3.7 Using export preview

The export preview is displayed if the export was successful.

Requirement
You have set one of the following values in the "Mapping result validation" field in the project
properties:
• "Verification"
• "Information"
See also chapter Configuring PDMS pipe spec export (Page 265).

3D Integration Administration
268 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

Color legend
The entries in the export preview have different background colors in the "Objects" area:

Color Meaning
Gray Schema element of the PDMS schema on the basis of which the object is created in
PDMS.
This schema element was used in the structure mapping definition to map the object
to be created in the target structure.
Green Objects that are created in PDMS.
Yellow Relations between two objects.

Procedure
1. Select a view in the toolbar. The views are described further below.
2. Select an object in the "Objects" area. Objects have a green background.
All attributes of the object which have received a value by assignment or setting an initial
value are displayed in the "Attribute" area.
3. If you have selected the value "Verification" in the project properties, click "Accept" to confirm
the preview and execute the export.
Click "Cancel" to cancel the export.

Result
• If you have selected the value "Information" in the project properties:
The workpackages are exported and saved in the workpackage base directory that you have
specified in the project properties.
• If you have selected the value "Verification" in the project properties:
The workpackages are first exported and saved once you have confirmed the preview. The
data is not exported without confirmation.

List view

The list view displays all objects in a flat hierarchy that were created in PDMS by the export.
• "Object" column: Name of the objects that are created in PDMS by the export.
Tooltip: Description of the object
• "Definition" column: Schema element of the PDMS schema on the basis of which the object
is created in PDMS.
Tooltip: Description and path of the schema element in the schema of the target provider.

Structured view

3D Integration Administration
Operating Manual, 03/2021 V10.4 269
Exporting COMOS pipe specs to PDMS
6.4 Importing COMOS pipe specs to PDMS specs

The structured view displays the objects sorted by their underlying structure element.

The objects and their relations to each other are displayed in a tree view.

Recurring structures

If you have selected structured view, you can show or hide recurring structures.
Recurring structures occur when, due to its relations, a tree chain leads back to a node that is
located at a higher level in the same chain.
When you activate the "Show/Hide recurring structures" button, the following text is shown in
red at the location at which a recurrence would be displayed:
"A recurring structure is located at this point."

6.4 Importing COMOS pipe specs to PDMS specs

Requirement
You have exported pipe specs from COMOS. See also chapter Exporting workpackages
(Page 268).

Procedure
1. Open the PDMS/E3D Engineering Interface.
You can find additional information on this topic in the "3D Integration Operation" manual,
keyword "Opening the COMOS PDMS/E3D Engineering Interface".
2. Click the "COMOS > Import PipeSpecs and Catalog" menu in the PDMS/E3D Engineering
Interface.
The "COMOS PDMS PipeSpec import options" window opens.
3. Select a folder from the base directory of the workpackage export in the "Import
workpackage folder" field that includes exported pipe specs in the form of .SPEC files.

3D Integration Administration
270 Operating Manual, 03/2021 V10.4
 Exporting COMOS pipe specs to PDMS
6.4 Importing COMOS pipe specs to PDMS specs

4. In the "World node" field, select a node of the type "World" under which the imported pipe
specs are to be created.
The node must be a catalog database to which you have write rights.
5. Click "Start import".
New and modified data are read-only (claimed) in PDMS after the import. The data are not
saved.
6. Check the import result after the import.
7. Save the imported data.
8. Select the command unclaim.

Result
The pipe specs exported from COMOS with the included pipe parts as well as the selectors and
catalog components are created or updated in PDMS/E3D below the specified World node.
• Objects whose structure elements were not assigned a name through an attribute
association or whose name does not yet exist in PDMS/E3D are created again in PDMS.
Objects whose name already exists in PDMS/E3D are not created again in PDMS. The existing
PDMS/E3D objects are updated.
Exception: If objects of type "SELEC" are not found in PDMS/E3D using their names, the
interface tries to determine the selectors based on the values in the "TANS" property. If no
matching selectors are found, they are created in PDMS/E3D.
• When a pipe spec (SPComponent) is imported in PDMS/E3D:
SPComponents on the PDMS/E3D side are matched with the imported SPComponents by
their names. If an SPComponent is present in PDMS/E3D that is not contained in the current
COMOS import, this SPComponent will be moved below the "SPEC LIMBO" node in PDMS/
E3D. This is the case, for example, for SPComponents that you have created manually in
PDMS/E3D.
• When a pipe spec is imported in PDMS/E3D again:
If objects were deleted on the COMOS side, these objects are moved below the "SPEC LIMBO"
node on the PDMS/E3D side.

3D Integration Administration
Operating Manual, 03/2021 V10.4 271
Exporting COMOS pipe specs to PDMS
6.4 Importing COMOS pipe specs to PDMS specs

3D Integration Administration
272 Operating Manual, 03/2021 V10.4