Publisher 1

Using the Generic Data

Mapper 2
Exchanging process data
COMOS with OpenPlant Modeler 3
Export process data to
PlantWise 4
Platform
Generic Data Mapper Data Transfer with
ProjectWise 5
Exporting COMOS pipe
Operating Manual specs to PDMS 6

Importing eCl@ss information 7

06/2019 V10.3.2
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 2017 - 2019.

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

1 Publisher.......................................................................................................................................................7
2 Using the Generic Data Mapper ...................................................................................................................9
2.1 Introduction ..............................................................................................................................9
2.2 Simplified representation of the operation................................................................................9
2.3 General workflow ...................................................................................................................10
2.4 Interface description: Generic Data Mapper ..........................................................................11
2.5 Open Generic Data Mapper ...................................................................................................14
2.6 Switching views of the Generic Data Mapper ........................................................................14
2.7 Mapping definitions ................................................................................................................15
2.7.1 Creating a mapping definition ................................................................................................15
2.7.2 Load a mapping definition ......................................................................................................15
2.8 Schema provider ....................................................................................................................16
2.8.1 Selecting a schema provider..................................................................................................16
2.8.2 Configuring a schema provider ..............................................................................................17
2.9 Views of the scheme definition...............................................................................................17
2.9.1 "Classes" view........................................................................................................................18
2.9.2 "Relations" view .....................................................................................................................19
2.9.3 "Units" view ............................................................................................................................20
2.9.4 "Mapped" view .......................................................................................................................21
2.9.5 "Search" view .........................................................................................................................21
2.10 Preparing structures...............................................................................................................22
2.10.1 Affect of structures on the export ...........................................................................................22
2.10.2 Structure types .......................................................................................................................25
2.10.3 Working with structure mapping definitions............................................................................27
2.10.3.1 Creating structure mapping definitions automatically.............................................................28
2.10.3.2 Creating structure mapping definitions manually ...................................................................29
2.10.3.3 Editing structure mapping definitions .....................................................................................30
2.10.3.4 Copy structure mapping definitions........................................................................................30
2.10.4 Control elements of structures ...............................................................................................31
2.10.5 Creating complex structures ..................................................................................................31
2.10.6 Creating variable structure elements .....................................................................................35
2.10.7 Modifying structures ...............................................................................................................35
2.10.7.1 Setting relations .....................................................................................................................35
2.10.7.2 Setting the cardinality.............................................................................................................36
2.10.7.3 Setting the recursion ..............................................................................................................39
2.10.7.4 Setting the global search........................................................................................................40
2.10.7.5 Setting polymorphism.............................................................................................................42
2.10.7.6 Creating attribute-based conditions .......................................................................................43
2.10.8 Creating comments ................................................................................................................44
2.11 Mapping structure components..............................................................................................45

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 3
Table of contents

2.11.1 Mapping elements within structures.......................................................................................45

2.11.2 Example 1 - Mapping elements within structures...................................................................46
2.11.3 Example 2 - Mapping elements within structures...................................................................48
2.11.4 Using the "Any" element ........................................................................................................51
2.11.5 Example: Using the "Any" element ........................................................................................52
2.11.6 The "Mapped" element...........................................................................................................52
2.11.7 Using the "Mapped" element..................................................................................................54
2.11.8 Example - using the "Mapped" element .................................................................................55
2.11.9 Structure-specific attributes....................................................................................................56
2.11.9.1 Mapping attributes within structures.......................................................................................56
2.11.9.2 Example - Mapping attributes within structures .....................................................................58
2.11.9.3 Defining the initial value for attributes of the target structure .................................................60
2.11.9.4 Creating an initial value with automatic counter.....................................................................61
2.11.9.5 Example - Mapping units........................................................................................................62
2.11.10 Mapping types and status of mappings..................................................................................63
2.11.11 Editing structure element associations...................................................................................65
2.11.11.1 Deleting or commenting associations ....................................................................................65
2.11.11.2 Changing elements or attributes ............................................................................................65
2.11.11.3 Setting the unit conversion.....................................................................................................65
2.11.11.4 Setting language conversion..................................................................................................67
2.11.11.5 Setting the string transformation ............................................................................................69
2.11.11.6 String conversion using regular expressions .........................................................................69
2.11.11.7 Reference to attribute values in the conversion pattern.........................................................71
2.11.12 Labeling identical objects .......................................................................................................72
2.11.12.1 Identical target objects that are independent of a COMOS object .........................................74
2.11.12.2 Identical target objects that are based on the same COMOS object .....................................76
2.11.13 Assigning specific connectors of a COMOS object................................................................80
2.11.14 Assigning a general connector...............................................................................................81
2.11.15 Searching for assigned elements...........................................................................................82
2.11.16 Correcting invalid references .................................................................................................83
2.12 Global attributes .....................................................................................................................84
2.12.1 Enable use of global attributes without structure element associations.................................85
2.12.2 Editing global attribute associations.......................................................................................86
2.12.3 Tabs of the "Attributes of the object <selected element>" control group ...............................86
3 Exchanging process data with OpenPlant Modeler....................................................................................87
3.1 Overview of the work sequence .............................................................................................88
3.2 User interface description for the export ................................................................................90
3.3 User interface description for the import ................................................................................92
3.4 Administration of the OpenPlant Modeler interface................................................................93
3.4.1 Example data for OpenPlant Modeler ....................................................................................93
3.4.2 Structure of a mapping definition ...........................................................................................94
3.4.3 Editing an example mapping definition ..................................................................................95
3.4.4 Setting up the ODBC connection for OpenPlant Modeler ......................................................96
3.4.5 Configuring the process data exchange.................................................................................97
3.5 Exporting process data ..........................................................................................................98
3.5.1 Open "COMOS P&ID process data export" ...........................................................................98
3.5.2 Creating a workpackage file...................................................................................................98
3.5.3 Loading workpackage file.......................................................................................................98
3.5.4 Creating workpackages..........................................................................................................99

Generic Data Mapper

4 Operating Manual, 06/2019 V10.3.2
 Table of contents

3.5.5 Editing workpackages ............................................................................................................99

3.5.6 Exporting workpackages ......................................................................................................100
3.6 Referencing process data in OpenPlant Modeler ................................................................100
3.7 Importing process data and consistency information in COMOS.........................................101
3.7.1 Importing data ......................................................................................................................102
3.7.2 Checking and editing imported data.....................................................................................102
3.7.3 Editing inconsistent attribute values.....................................................................................104
3.7.4 Assigning objects .................................................................................................................105
3.7.5 Creating new objects............................................................................................................105
3.7.6 Check status ........................................................................................................................106
3.7.7 Navigating ............................................................................................................................106
4 Export process data to PlantWise ............................................................................................................109
4.1 Overview of the workflow .....................................................................................................109
4.2 Administration of the PlantWise interface ............................................................................111
4.2.1 Example data for PlantWise.................................................................................................111
4.2.2 Configuring PlantWise process data export .........................................................................111
4.3 Exporting process data ........................................................................................................112
4.3.1 Matching connector objects .................................................................................................112
4.3.2 Creating workpackages........................................................................................................113
4.3.3 Exporting workpackages ......................................................................................................113
5 Data Transfer with ProjectWise ................................................................................................................115
5.1 Linking COMOS OPM import with Bentley ProjectWise environment..................................115
5.2 Linking COMOS OPM export to the Bentley ProjectWise environment ...............................115
5.3 Data transfer with ProjectWise.............................................................................................116
6 Exporting COMOS pipe specs to PDMS ..................................................................................................119
6.1 Overview of the work sequence ...........................................................................................120
6.2 Administration of pipe spec export .......................................................................................120
6.2.1 Receiving the COMOS template catalog .............................................................................120
6.2.2 Exporting the schema of a template catalog from PDMS ....................................................121
6.2.3 Integrating the schema in the Generic Data Mapper ...........................................................122
6.2.4 Special features of the PDMS schema ................................................................................123
6.2.5 Content and structure of the example mapping definition "Tee mapp" ................................124
6.2.6 Editing an example mapping definition ................................................................................129
6.2.7 Configuring PDMS pipe spec export ....................................................................................132
6.3 Exporting pipe specs............................................................................................................132
6.3.1 Opening "PDMS pipe spec export" ......................................................................................133
6.3.2 Creating a workpackage file.................................................................................................133
6.3.3 Loading workpackage file.....................................................................................................133
6.3.4 Creating workpackages........................................................................................................133
6.3.5 Editing workpackages ..........................................................................................................134
6.3.6 Exporting workpackages ......................................................................................................134
6.3.7 Using export preview............................................................................................................135
6.4 Importing COMOS pipe specs to PDMS specs....................................................................137

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 5
Table of contents

7 Importing eCl@ss information ..................................................................................................................139

7.1 Introduction ..........................................................................................................................139
7.2 Administering eCl@ss..........................................................................................................140
7.2.1 Setting project properties .....................................................................................................140
7.2.2 Project properties .................................................................................................................141
7.2.3 Storing available catalogs ....................................................................................................141
7.2.4 Availability of additional documents .....................................................................................142
7.2.5 Languages ...........................................................................................................................143
7.2.6 Creating mappings ...............................................................................................................143
7.2.6.1 Creating an eCl@ss mapping ..............................................................................................143
7.2.6.2 Assigning connectors ...........................................................................................................145
7.2.6.3 Converting units ...................................................................................................................146
7.3 Using eCl@ss in engineering...............................................................................................146
7.3.1 Calling the eCl@ss catalog ..................................................................................................146
7.3.2 Select product ......................................................................................................................147
7.3.3 Reset device data ................................................................................................................148
7.3.4 Creating product data...........................................................................................................149
7.3.5 Additional documents...........................................................................................................149

Generic Data Mapper

6 Operating Manual, 06/2019 V10.3.2
Publisher 1
Aveva
AVEVA PDMS™ and Everything3D™ (E3D) are software products from AVEVA and are
hereinafter referred to simply as PDMS or E3D.

Bentley
Bentley OpenPlant and PlantWise are software products from Bentley Systems and are
hereinafter referred to as OpenPlant Modeler and PlantWise.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 7
Publisher

Generic Data Mapper

8 Operating Manual, 06/2019 V10.3.2
Using the Generic Data Mapper 2
2.1 Introduction
This chapter describes working with the Generic Data Mapper in general and is intended for
administrators and system integrators.
The procedures and settings can deviate from the general behavior for specific application
cases in which concrete data is exchanged between COMOS and another application. You can
find this information in the chapter of the respective application case.
● See also chapter Exchanging process data with OpenPlant Modeler (Page 87).
● See also chapter Export process data to PlantWise (Page 109).
● See also chapter Exporting COMOS pipe specs to PDMS (Page 119).
● See also chapter Importing eCl@ss information (Page 139).

2.2 Simplified representation of the operation

The Generic Data Mapper is a tool for creating mapping rules to map the data schemes of two
systems to each other. This procedure is referred to as data mapping. Data mapping is the
basis for data exchange between COMOS and another application.
For actual data exchange, COMOS users have access to corresponding, application-specific
interfaces in the "Plugins" menu.
In Generic Data Mapper, you access the data schema of both systems. By mapping schema
elements of the source and the target system as well as additional rules, you control the
following behavior for any amount of input data:
● Which objects are exported and which objects are generated in the target system
● Which objects are generated how many times in the target system during export from the
source system
● Which attribute values are transferred to the objects in the target system
● How the objects created in the target system are interrelated

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 9
Using the Generic Data Mapper
2.3 General workflow

6RXUFHV\VWHP 7DUJHWV\VWHP

$VVLJQPHQW
(OHPHQWLQWKHVRXUFHVFKHPD (OHPHQWLQWKHWDUJHWVFKHPD

'HILQLWLRQ 'HILQLWLRQ

([SRUW
2EMHFW 2EMHFW

When an object from the source system generated on the basis of an assigned source element
is exported to a target system, the assigned element of the target schema is used as a basis for
creating the object in the target system.
Export and import are not functions of the data mapping tool in the sense of workflows, but they
are important for understanding the creation of mapping rules. See also chapter Affect of
structures on the export (Page 22).

See also
Exporting pipe specs (Page 132)

2.3 General workflow

1. Create a new mapping definition or load an existing mapping definition.
See also chapter Mapping definitions (Page 15).
2. If you have created a new mapping definition, select a schema provider. See also
chapter Selecting a schema provider (Page 16).
Configure the schema provider. See also chapter Configuring a schema provider
(Page 17).
3. Create or edit the structure mapping definitions.
General procedure: See also chapter Preparing structures (Page 22).
4. Assign the structure elements and attributes. See also chapter Mapping structure
components (Page 45).
5. Optional: Assign attributes globally. See also chapter Global attributes (Page 84).

Generic Data Mapper

10 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.4 Interface description: Generic Data Mapper

6. If you continue with an interface from the "CAE Apps" plugin: Specify the completed
mapping definition as the basis for export and import.
– See also chapter Configuring PDMS pipe spec export (Page 132).
– See also chapter Configuring PlantWise process data export (Page 111).
– See also chapter Configuring the process data exchange (Page 97).
7. Follow the instructions for the corresponding interface.
– See also chapter Exporting pipe specs (Page 132).
– See also chapter on OpenPlant Modeler Exporting process data (Page 98).
– See also chapter on PlantWise Exporting process data (Page 112).

2.4 Interface description: Generic Data Mapper

User interface
The interface of the tool is divided into two areas.
● On the left: Information of the source system
● On the right: Information of the target system

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 11
Using the Generic Data Mapper
2.4 Interface description: Generic Data Mapper

 


 

 

 

 

Generic Data Mapper

12 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.4 Interface description: Generic Data Mapper

Number Description
1 "Mapping definition" field
Here you create or load a mapping definition.
2 Toolbar for editing the mapping definition with the following buttons:
● "Load mapping definition"
● "Save mapping definition"
● "Save mapping definition as"
● "Create new mapping definition"
3 ● "Find" button
Opens a window in which you can find elements and their use in a mapping structure
definition. You can search for elements from the source schema or the target schema.
See also chapter Searching for assigned elements (Page 82).
● Buttons for the selection of different views
This allows you to show or hide the control groups of the Generic Data Mapper
according to your tasks. See also chapter Switching views of the Generic Data Mapper
(Page 14).
4 "Schema provider" control group
Selection and setting of the available schema providers for source and target system.
5 "Schema" control group
Shows the schema of the source system and target system. Contains registry information
that provides you an overview of the schema and associated elements. See also chap‐
ter Views of the scheme definition (Page 17).
6 "Mapping" control group
This is where you perform the structure mapping and attribute mapping.
7 "Structure mapping" main tab
The structure mapping and the structure-specific attribute mapping is performed in this tab.
8 "Global attribute mapping" main tab
The global attribute mapping takes place on this tab.
9 "Source structure" control group
Here you can create and modify the source structures.
10 "Target structure" control group
Here you can create and modify the target structures.
11 Attributes <selected element of the source system>
● If you have selected a schema element in the "Source schema" control group in the
"Classes" tab, the attributes of the schema element are displayed here. The attributes
are read only.
● If you have selected a structure element in the "Source structure" control group, the
attributes of the structure element are displayed here. You can map attributes with
drag&drop and assign them an initial value.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 13
Using the Generic Data Mapper
2.6 Switching views of the Generic Data Mapper

Number Description
12 Attributes <selected element of the target system>
● If you have selected a schema element in the "Target schema" control group in the
"Classes" tab, the attributes of the schema element are displayed here. The attributes
are read only.
● If you have selected a structure element in the "Target structure" control group, the
attributes of the structure element are displayed here. You can map attributes with
drag&drop and assign them an initial value.
13 "Structure element associations" tab
All associations of structure elements and attributes of the selected structure mapping
definition are displayed here.
14 "Attribute-based conditions of the source structure" tab
Here you create the conditions for structure elements of the source structure that are linked
to specific attribute values.

2.5 Open Generic Data Mapper

Procedure
Click the "Plugins > Basic > Generic Data Mapper" entry in the menu.

2.6 Switching views of the Generic Data Mapper

You can use the toolbar for selecting the various views to show or hide the control groups of the
Generic Data Mapper according to your tasks. See also chapter Interface description: Generic
Data Mapper (Page 11).
The following buttons are available for this:
● "Fit view vertically to window size"
Displays all control groups.
● "View for configuration of the schema provider"
Displays the "Scheme provider "and" Scheme" control groups.
● "View for configuration of the structure associations"
Displays the "Scheme" and "Mapping" control groups.
● "View for configuration of the attribute associations"
Displays the "Mapping" control group.

Procedure
Click one of the buttons.

Generic Data Mapper

14 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.7 Mapping definitions

2.7 Mapping definitions

A mapping definition is a file in GMAD format which includes schema mappings of two data
models. You can save and reload mapping definitions.
The data exchange is controlled and executed based on the mapping definition. Executed in
this context means that objects from the source system are transformed into objects of the
target system and created.
The GMAD format is COMOS-specific and cannot be opened with external applications.

2.7.1 Creating a mapping definition

When you open the Generic Data Mapper, an empty mapping definition is opened initially. To
create a new mapping definition while working, follow these steps.

Procedure

Note
Unsaved changes will be lost
If you have already opened a mapping definition and create a new definition, you will lose all
unsaved changes to the open definition.

Click the "Create new mapping definition" button.

2.7.2 Load a mapping definition

Requirement
You have created and saved a mapping definition.

Procedure

Note
Loss of data possible
If you use a scheme definition for a project other than the one for which the definition was
originally created, data can be lost or overwritten.

1. Click the "Load mapping definition" button.

2. Select a file in GMAD format.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 15
Using the Generic Data Mapper
2.8 Schema provider

2.8 Schema provider

2.8.1 Selecting a schema provider

In the Generic Data Mapper, the schema provider provides the data schema on which your
work is based. By selecting a schema provider, you also determine which is the source system
and which is the target system.
Load schema files from the source system and target system in the Generic Data Mapper.
Providers offered by default:

Schema provider Area of application

"ComosSchemaProvider" Maps the COMOS schema in the form of the COMOS base
project.
"FileSchemaProvider" Pipe spec export to PDMS
Maps the schema of generic schema files once you have in‐
tegrated a .provider file.
You create generic schema files in the "COMOS PDMS/E3D
Engineering Interface". See also chapter Exporting the sche‐
ma of a template catalog from PDMS (Page 121).
"ECXMLSchemaProvider" Process data export to OpenPlant Modeler
Maps the schema of the OpenPlant Modeler once you have
integrated an XML schema file in this provider.
"eClassSchemaProvider" With this schema provider, you can create the mapping of the
eClass data to the COMOS data structure. See chapter Im‐
porting eCl@ss information (Page 139).
For the "eCalssSchemaProvider" entry to be displayed, the
necessary eClass catalogs must be on file. See chapter Set‐
ting project properties (Page 140).

Procedure
1. Select the "ComosSchemaProvider" in the "Source schema provider" or "Target schema
provider" control group.
The COMOS data structure and a generic connector object are displayed in the "Schema"
section.
2. Select the other required provider in the respective other control group.
3. Configure the providers. See also chapter Configuring a schema provider (Page 17).

Generic Data Mapper

16 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.9 Views of the scheme definition

2.8.2 Configuring a schema provider

"FileSchemaProvider"
Requirement: You have created a .PROVIDER file. See also chapter Exporting the schema of
a template catalog from PDMS (Page 121).
1. Select the path to a .PROVIDER file in the "FilePath" field.
2. Optional: Select whether the file is to be embedded in the schema provider in the
"EmbedDataSource" field:
– True: The file is embedded in the schema provider. The schema provider no longer
needs the original file to display the schema.
– False: The file is called via the relative path each time the schema provider is used. This
means the file must remain available in the specified directory.

"ECXMLSchemaProvider"
Requirement: The schema of the OpenPlant Modeler is available. See also chapter Example
data for OpenPlant Modeler (Page 93).
1. Select the path to an XML schema file in the "FilePath" field.
2. Optional: Select whether the file is to be embedded in the schema provider in the
"EmbedDataSource" field:
– True: The file and all associated schema files are embedded in the schema provider. The
schema provider no longer needs the original files to display the schema.
– False: The file is called via the relative path each time the schema provider is used. The
file and all associated schema files must remain available in the specified directory.
3. Optional: In the "ShowInheritanceSourceClasses" field, select if the inheritance structure of
the classes is to be displayed:
– True: The inheritance structure of the classes in the main schema file is displayed in the
"Schema" control group.
– False: The classes of the main schema file and all associated schema files are displayed
one below the other on a single level in the "Schema" control group.

Result
The scheme definition is displayed in the "Source schema" or "Target schema" control group
in the "Classes" tab according to your settings.

2.9 Views of the scheme definition

Once you have loaded a schema, the corresponding schema definition is displayed in the
"Source schema" or "Target schema" control group. You have different views for the schema
definition.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 17
Using the Generic Data Mapper
2.9 Views of the scheme definition

Each view of the schema definition is displayed in a separate tab.

● Views of the schema element structure
See also chapter "Classes" view (Page 18).
● View of the relations
See also chapter "Relations" view (Page 19).
● View of the unit system
You only need the functionality for a special case. See also "Units" view (Page 20).
● View of the mapped schema elements
See also chapter "Mapped" view (Page 21).
● In the "Search" view, browse the schema definition according to certain schema elements.
See also "Search" view (Page 21).

2.9.1 "Classes" view

You see the schema elements structure in the "Classes" view. Each node represents an
individual schema element.
If the display of the inheritance is enabled in the properties of the schema provider, you can see
the inheritance structure of the schema elements and the parent-child relationship between the
schema elements. See also chapter Configuring a schema provider (Page 17).
If the inheritance is disabled, the schema elements are arranged with one below the other on
a single level.

Opening a view
Select the "Classes" tab.

Generic Data Mapper

18 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.9 Views of the scheme definition

Displaying attributes of the schema element

To display the attributes of a schema element, select an element in the "Classes" tab.
The attributes are shown in the "Attributes" control group.

Displaying more information

More information about a schema element is displayed in tooltips.
Tooltips are displayed at the following locations:
● Name of the element
● Description of the element
The information displayed in the tooltip depends on the schema provider.
For example, the "SystemFullName" of the schema element is displayed for the COMOS
schema.

2.9.2 "Relations" view

In this view, you see a list of all relations that are defined in the schema. The schema provider
determines which relations are displayed and whether or not the columns include information.
If no values are entered in the "Source" and "Target" columns, there is no type restriction for
source and target in the relations.

Opening a view
Select the "Relations" tab.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 19
Using the Generic Data Mapper
2.9 Views of the scheme definition

Column Description
"Name" Name of the relation
"Source" Element type on which the relation is based
Not used for the "ComosSchemaProvider" schema provider.
"Source cardinality" Specifies how often the element type on which the relation is based may occur in
a relation.
● * = Any number of times
● 0.1 = Never or once
● etc.
"Target" Element type to which the relation refers
Not used for the "ComosSchemaProvider" schema provider.
"Target cardinality" Specifies how often the element type to which the relation refers may occur in a
relation.
● * = Any number of times
● 0.1 = Never or once
● etc.
"Description" Description of the relation

Displaying more information

More information about a relation is displayed in tooltips.
If the respective cell is filled, tooltips are displayed in the following columns:
● "Source"
● "Target"

Sorting columns
To sort a column in ascending or descending order, click once respectively in the column
header.

2.9.3 "Units" view

The view shows the complete system of units from the source and target schema. For an
external schema, the unit system must be contained in the imported schema file or be available
as a separate unit schema file, otherwise there is no display.

Objective
The view can be used to map units between the source and target schema. The procedure and
the display in the user interface are the same as for structure elements. See also
chapters Mapping elements within structures (Page 45) and Example - Mapping units
(Page 62).

Generic Data Mapper

20 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.9 Views of the scheme definition

Unit mapping may be necessary if the reference unit is configurable for a physical quantity in
one or both systems and may differ from the SI unit. In this case, it is not ensured that the display
value for a unit is always available as a value in the respective SI unit.
If SI units and value conversion are transferred without errors and unambiguously during data
exchange, you do not need additional unit mapping.

2.9.4 "Mapped" view

In this view, you see a list of the root elements of all structure mapping definitions.

Opening a view
Select the "Mapped" tab.

Actions
The following buttons are visible when you move your mouse across a cell in the "Actions"
column:
● "Activate/deactivate corresponding structure mapping definition"

Shows the structure mapping definitions in which the element was used as root node.
You can open any definition by navigating to it.
● "Navigate to schema element"

Navigates to the corresponding schema element in the "Classes" tab.

2.9.5 "Search" view

Here you search for the name or description of a schema element, respectively in the source
and target schema..

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 21
Using the Generic Data Mapper
2.10 Preparing structures

Opening a view
Select the "Search" tab.

Search
1. Select the "Search" tab in the "Source schema" or "Target schema" control group.
2. Enter the name or description of a schema element in the search box.
3. Click the "Search" button.

Result
All search results are listed one below the other on a single level.
You can Drag&Drop elements from the search result into the respective source or target
structure.

Navigating to the schema element

Click "Navigate to schema element" to the left of an element that has been found.

2.10 Preparing structures

2.10.1 Affect of structures on the export

Prepare the export in the Generic Data Mapper. For the actual export of objects you use a
corresponding specific interface of the "Engineering Adapter" plugin.

Generic Data Mapper

22 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

To create suitable structures in the mapper, you must be familiar with how the export works.
See also chapters Simplified representation of the operation (Page 9) and General workflow
(Page 10).
All objects from the source system being exported were generated based on a specific schema
element.

6RXUFHVFKHPH 2EMHFWVRIWKHVRXUFHV\VWHP

6(OHPHQW
6(OHPHQW 6(
6(OHPHQW
6(OHPHQW
6(OHPHQW 6(
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(
6(OHPHQW
6(OHPHQW

6(

6(

6(
/HJHQG
66RXUFH
((OHPHQW

Example: If COMOS is the source system and you are exporting from an engineering project:
● Schema elements = base objects
● Objects = engineering objects

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 23
Using the Generic Data Mapper
2.10 Preparing structures

Export sequence
When you export a set of objects from the source system, the following occurs:
● The basis for the schema element is determined for each object.
● The relations of the objects within the set of objects are analyzed and compared to all known
source structures.
2EMHFWDPRXQW[WREHH[SRUWHG &KHFN,VWKHUHDVXLWDEOHVRXUFH ,GHQWLI\H[SRUWDEOH
  
VWUXFWXUH" REMHFWV

2EMHFWVRIWKHVRXUFHV\VWHP 6RXUFHVWUXFWXUH

6(
6( 6( 6(

6(
6(
6( 6(
6(

6(
6(
6(
&KHFN
6(
6(
6( 6(

6(

6( 6(
6(

6( 6( 6(

Legend
S: Source
E: Element

● All objects for which a matching source structure is found are eligible for export. The other
objects are excluded from the export.

Generic Data Mapper

24 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

● The associated target structures are determined for all matching source structures.
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(
6(

6( 7(

6( 7(
6(

Legend
S: Source
T: Target
E: Element

● The engineering data of the target system are created based on the target structures.
7DUJHWVWUXFWXUH 2EMHFWVRIWKHWDUJHWV\VWHPDUH
JHQHUDWHG

7(

7( 7(

7(
7(

/HJHQG 7(
77DUJHW
((OHPHQW

2.10.2 Structure types

You can create simple or complex structures with unique or ambiguous structure elements.
Structures can consist of any number of schema elements. The elements are related in a
specified way and have certain relations to each other.

Requirement
You know how this works in general. See also chapter Simplified representation of the
operation (Page 9).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 25
Using the Generic Data Mapper
2.10 Preparing structures

Simple structures
Simple structures consist of a single structure element.

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

Legend
T: Target
S: Source

Complex structures
Complex structures consist of several interrelated structure elements.

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

6( 7(

6( 7(

See also chapter Creating complex structures (Page 31).

Variable structure elements

Variable structure elements contain several schema elements. This means that the structure
takes effect for each possible combination of the contained schema elements for an export.

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(
6(

6( 7(

6( 7(
6(

See also chapter Creating variable structure elements (Page 35).

Generic Data Mapper

26 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

Unique structure elements

Unique structure elements each contain one schema element only. They take effect only for
objects that are based on the schema element given here.

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

6( 7(

6( 7(

2.10.3 Working with structure mapping definitions

A structure mapping definition describes a set of two structures, which are associated with each
other. To create new structures, you first have to create a structure mapping definition.
You have the following options for creating a structure mapping definition:
● Automatically:
See chapter Creating structure mapping definitions automatically (Page 28).
● Manually:
See chapter Creating structure mapping definitions manually (Page 29).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 27
Using the Generic Data Mapper
2.10 Preparing structures

2.10.3.1 Creating structure mapping definitions automatically

Procedure
1. Drag&drop an element on another element.
6RXUFHVFKHPH 7DUJHWVFKHPH

6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW

The direction in which you assign the elements to each other does not matter.
6RXUFHVFKHPH 7DUJHWVFKHPH

6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW

2. Optionally: Enter a new name for the structure mapping definition. See also chapter Editing
structure mapping definitions (Page 30).

Result
● You have created a new structure mapping definition.
It is added to the "Structure mapping definition" list and consists of the names of the
associated elements.
● The structures generated are displayed in the "Source structure" and "Target structure"
control groups.

6WUXFWXUHPDSSLQJGHILQLWLRQ 6(OHPHQW !7(OHPHQW

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

Generic Data Mapper

28 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

2.10.3.2 Creating structure mapping definitions manually

Procedure
1. Click the following button:
① "Add structure mapping definition"
A new structure mapping definition is created. The name of the structure mapping definition
corresponds to the recently opened structure mapping.
2. To fill the structure mapping definition, drag-and-drop elements from the "Source schema"
and "Target schema" control groups into the "Source structure" and "Target structure" areas.
6RXUFHVFKHPD 7DUJHWVFKHPD

6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

3. Optionally: Enter a new name for the structure mapping definition. See also chapter Editing
structure mapping definitions (Page 30).

Displaying more information

More information on the elements in the areas "Source structure" and "Target structure" is
available in the tooltips, whereby type and scope depend on the schema provider.
For elements from the COMOS schema, for example, description and "SystemFullName" are
displayed.

Alternative procedure
If COMOS is the target or source schema, you can alternatively drag the required COMOS base
objects from the COMOS Navigator to the respective "Target structure" or "Source structure"
control group.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 29
Using the Generic Data Mapper
2.10 Preparing structures

2.10.3.3 Editing structure mapping definitions

Delete structure mapping definitions

1. Select an entry in the "Structure mapping definition" list .
2. Click the "Delete structure mapping definition" button.

Rename structure mapping definitions

1. Select an entry in the "Structure mapping definition" list .
2. Click the "Rename structure mapping definition" button.
A window opens in which you can edit the name of the structure mapping.
3. Enter a new name.
4. Confirm your entries.

Adding a comment
1. Select an entry in the "Structure mapping definition" list .
2. Click the "Comment" button.
A window opens in which you can enter text of your choosing and format it.
3. Enter a comment for the current structure mapping definition.
4. Save the mapping definition.

2.10.3.4 Copy structure mapping definitions

Procedure
1. Select an entry in the "Structure mapping definition" list .
2. Click "Duplicate structure mapping".
The structure mapping definition is copied and saved. The name of the new definition
corresponds to the name of the copied source.
3. Rename the new structure mapping definition.

Generic Data Mapper

30 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

2.10.4 Control elements of structures

 

1
(
( 1
+DV&KLOG (

3
+DV&KLOG
(
1
%UDQFK+DV'HYLFH
(

States E: Element
   
Activated:
Off:

Number Description
① Cardinality
See also chapter Setting the cardinality (Page 36).
② Deleting
③ Relation
See also chapter Setting relations (Page 35).
④ Toggle polymorph on/off
See also chapter Setting polymorphism (Page 42).
⑤ Toggle global search on/off
See also chapter Setting the global search (Page 40).
⑥ Toggle recursive on/off
See also chapter Setting the recursion (Page 39).
⑦ Comment
See also chapter Creating comments (Page 44).

2.10.5 Creating complex structures

The procedure is the same for source structures and target structures.

Procedure
1. Drag a schema element under a structure element until a blue line appears and then drop
it.
2. Place the element.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 31
Using the Generic Data Mapper
2.10 Preparing structures

3. Repeat the steps to add more elements at the same level.

6RXUFHVFKHPD

6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH

6(

6(

6(

Generic Data Mapper

32 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

4. To add an element to a level below, drag-and-drop it below the corresponding structure

element.
6RXUFHVFKHPD

6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH

6(

6(

6(

6(

5. Create a target structure in same way.

Example:
6RXUFHVFKHPD 7DUJHWVFKHPD

6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6( 7(

6( 7(

6( 7(

6( 7(

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 33
Using the Generic Data Mapper
2.10 Preparing structures

Deleting a structure element

To delete a structure element, click the corresponding "Delete node" button.

6RXUFHVFKHPD

6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH

6(

6(

6( 

6(

Generic Data Mapper

34 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

2.10.6 Creating variable structure elements

Procedure
Drag-and-drop a schema element onto a schema element within a structure element.

6RXUFHVFKHPD

6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW
6(OHPHQW

6WUXFWXUHPDSSLQJGHILQLWLRQ

6RXUFHVWUXFWXUH

6(

6(

6(
6(

2.10.7 Modifying structures

You can use modifiers to specify structures in order to limit or expand the number of exported
objects for an export.
All modifiers are available to you for source structures. Only some of the modifiers are available
to you for target structures.
During an export, modifiers are taken into account to check whether there are object
constellations in the export set that correspond to the defined source structures.
If a valid object constellation it is found in the export set, the target structure of the
corresponding source structure is determined. The objects are created in the target system
according to the mapping. See also chapter Mapping elements within structures (Page 45).
All modifiers available in source structures are described in the following chapters. COMOS is
used as the source system in the examples.

2.10.7.1 Setting relations

A relation indicates the relationship a structure element has to its parent element.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 35
Using the Generic Data Mapper
2.10 Preparing structures

Procedure
1. To set a relation, expand the list of relations for a structure element.

2. Depending on the direction in which you build the structure, select a relation.

Example: "HasChild"

8QLW

+DV&KLOG 6XEXQLW

+DV&KLOG 3 ,'

Example: "HasParent"

3 ,'

+DV3DUHQW 6XEXQLW

+DV3DUHQW 8QLW

2.10.7.2 Setting the cardinality

The cardinality indicates how often an element can occur in the given relation.

Generic Data Mapper

36 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

Procedure
1. Click on the preset information for the cardinality.

The settings open.

You have the following options to set the cardinality:

 

① Manual
② Predefined values
– 1: The object must occur exactly once.
– 0.1: The object must occur zero times or once.
– 1.*: The object must occur at least once or more than once.
– *: The object may occur zero times or any number of times
2. Set the cardinality using the buttons.
Example: "4.6": The object must occur 4, 5 or 6 times.

Example

6RXUFHVWUXFWXUH


6(

+DV&KLOG 6(

+DV&KLOG 6(

+DV&KLOG
6(

Element Explanation
(S)E2 Element (Q)E2 must occur exactly once.
(S)E4 Element (S)E4 must occur exactly once or twice.
(S)E5 Element (Q)E5 must occur exactly once.
(S)E6 Element (S)E6 can occur any number of times. This means it may also occur zero
times.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 37
Using the Generic Data Mapper
2.10 Preparing structures

2EMHFWFRQVWHOODWLRQVYDOLGIRUH[SRUW 2EMHFWFRQVWHOODWLRQVLQYDOLGIRUH[SRUW

D E G
6( 6( 6(

6( 6( 6(

6( 6( 6(

F
6(
6( H

6(
6(
6(

6( 6(

6(
6(

6(

6(
6(

Object constellation Explanation

d) Element E 4 does not occur once or twice.
e) Element E 5 occurs more than once.

Generic Data Mapper

38 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

2.10.7.3 Setting the recursion

Procedure
1. Click on the symbol for the recursion. See also chapter Control elements of structures
(Page 31).
The symbol is dark red and a check mark is displayed under the display for the cardinality.
6RXUFHVWUXFWXUH

1
6(
1
+DV&KLOG 6(
1
+DV&KLOG
6(
1
+DV&KLOG ^
6(

2. To adjust how far the recursion should extend, set the search depth.
Click on the check mark under the cardinality.
The settings open. You have the following options to set the search depth:

 

① Manual
② Predefined values
– 1: The recursion runs through one level up or down, depending on the relation.
– *: The recursion runs through all levels up or down, depending on the relation.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 39
Using the Generic Data Mapper
2.10 Preparing structures

Example
The set of objects for an export from COMOS are highlighted in the following graphic.

Specified source structure:

6RXUFHVWUXFWXUH

1
3 ,'
*
2.3
+DV&KLOG 0RWRU

COMOS finds a valid object constellation. This is valid because any number of motors are
located two or three levels below the P&IDs.

2.10.7.4 Setting the global search

Global search means a search is made for objects throughout the engineering data of the
current project for an export and not only within the exported set of objects.
● Deactivated: The element must be in the export set.
● Activated: The element may be inside or outside the export set.

Generic Data Mapper

40 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

Procedure
Click on the symbol for the global search.

If the symbol is green, the global search is activated.

Example
The export set is highlighted in the following graphic.

Specified source structure:

6RXUFHVWUXFWXUH

1
3 ,'
*
2.3
+DV&KLOG 0RWRU

COMOS starts searching from the motor to the top of the structure. COMOS finds a valid object
constellation, because the following is true:
● The motor is included in the export set.
● The P&ID is located two levels above the motor.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 41
Using the Generic Data Mapper
2.10 Preparing structures

2.10.7.5 Setting polymorphism

If you set polymorphism for a schema element, the specified schema element and all child
elements of the schema element within the schema are considered a valid basis for an object
to be exported.

Procedure
Click on the symbol for the polymorphism.

A green symbol means that polymorphism is activated.

Example
There is the following source structure from which the specified source schema has been
generated.
COMOS searches the set of objects to be exported for object constellations that correspond to
the source structure.

Generic Data Mapper

42 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.10 Preparing structures

6RXUFHVFKHPD 2EMHFWFRQVWHOODWLRQVYDOLGIRUDQH[SRUW

6(OHPHQW
6(OHPHQW
6(OHPHQW 6( 6(
6(OHPHQW
6(OHPHQW
6(OHPHQW 6( 6(
6(OHPHQW
6(OHPHQW
6(OHPHQW 6( 6(

6RXUFHVWUXFWXUH 6( 6(

6(
6(

6(
6(

6(
6(
6(

6(

The object constellations shown are valid because the schema element (S)E4 itself or one of
its child elements occurs as a basis at the location marked with the polymorphism. Every other
element would be invalid.

2.10.7.6 Creating attribute-based conditions

You can limit the objects for which a structure image mapping is to become effective by defining
attribute-based conditions. With the help of attribute-based conditions, you create a permitted
attribute value or a permitted value range in which an attribute value must be located.
You can create any number of conditions for structure elements of a structure mapping
definition. All conditions are linked to each other with an AND operator. This means that each
condition in a structure mapping definition must be met for the structure mapping definition to
be effective.

Procedure
1. Select a structure element in the source structure.
2. Select the "Attribute-based conditions of the source structure" tab in the detail area of the
"Mapping" control group.
3. Click the "Add" button in the "Actions" column.
4. A new condition is created.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 43
Using the Generic Data Mapper
2.10 Preparing structures

5. In the "Attribute" column select the attribute to which the condition applies.
If you have selected an element-specific attribute, such as "Nominal diameter", a second list
is offered with the system properties of the attribute.
Select a system property.
6. Select an operator in the "Comparison operator" column.
7. Select one or more comparison values.

%! &!
%! &!
%! %Q!

Comparison operator Description

"B<=A<=C" For these operators, the value of the selected attribute is the operand A.
"A<B OR A>C"
"Is one of" For this operator, you can add any number of comparison values. Strings
and numbers (int, float) are possible comparison values.
The condition is met when the value of the selected attribute is equivalent
to one of the comparison values.
"Is none of" For this operator, you can add any number of comparison values. Strings
and numbers (int, float) are possible comparison values.
The condition is met when the value of the selected attribute is equivalent
to none of the comparison values.

8. To delete a condition, click the "Delete" button in the "Actions" tab.

To delete all conditions of the structure element, click the "Remove all" button in the right
screen margin.

2.10.8 Creating comments

Procedure
1. Click on the symbol for the comments.

A window opens in which you can enter text of your choosing and format it.
2. Enter a comment.

Generic Data Mapper

44 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

2.11 Mapping structure components

2.11.1 Mapping elements within structures

You can also map each individual structure element to any number of structure elements of the
opposite side. The behavior for an export is changed by this, see Example 1 - Mapping
elements within structures (Page 46) and Example 2 - Mapping elements within structures
(Page 48).

Requirement
You have created a structure mapping definition. See also chapter Working with structure
mapping definitions (Page 27).

Procedure
Drag&Drop a structure element of the source structure or the target structure onto one or more
structure elements of the other control group.
The direction in which you drag the elements does not matter. Technically, only the direction of
the source structure to the target structure is saved.

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU
3XPS
SXPS

5RWDU\
SXPS

Result
The mapped structure element pairs are displayed in the "Structure element associations"
control group.
If you select a structure element, the structure elements mapped to it are highlighted in color.
The element itself is highlighted with the same color in the "Structure element associations"
control group.
● Source element: green
● Target element: blue

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 45
Using the Generic Data Mapper
2.11 Mapping structure components

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU
3XPS
SXPS

5RWDU\
SXPS 

6WUXFWXUHHOHPHQWDVVLJQPHQW
6RXUFHHOHPHQW  7DUJHWHOHPHQW 
P&ID P&ID
Gear pump Pump
Rotary pump Pump

Global attribute associations are applied to the structure element association.

Editing the mapping

See chapter Changing elements or attributes (Page 65).

2.11.2 Example 1 - Mapping elements within structures

Export set:







Specified associations:

Generic Data Mapper

46 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU
3XPS
SXPS

5RWDU\
0RWRU
SXPS

0RWRU

Export result:

3 ,'

3XPS

3XPS

3XPS

0RWRU

3 ,'

3XPS

3XPS

0RWRU

0RWRU

Number Explanation
① Because P&IDs are mapped explicitly in the structure, the number of these objects is also shown in export
results, if all conditions of the structure are met.
② The rotary pumps have a motor as child element and therefore meet the condition. Because rotary pumps are
mapped explicitly, a pump is created in the target structure for each rotary pump which meets the condition.
③ The gear pump has a motor as child element and therefore does not meet the condition. A pump is not created.
④ The motor is ignored because its parent element does not meet the condition and is not created in the target
system.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 47
Using the Generic Data Mapper
2.11 Mapping structure components

Number Explanation
⑤ The gear pump does not have a motor as child element and therefore meets the condition. Because gear pumps
are mapped explicitly, a pump is created in the target structure for each gear pump which meets the condition.
⑥ The rotary pump has motors as child element. The condition is met.
Because rotary pumps are mapped explicitly, a pump is created in the export result for each rotary pump which
satisfies the condition.
⑦ Because motors are mapped explicitly, a motor is created in the target structure below the corresponding pump
for each motor located under a gear pump.

2.11.3 Example 2 - Mapping elements within structures

Example 2.1
Export set:







Specified associations:

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU 1
3XPS
SXPS

5RWDU\ 0-2 0RWRU

SXPS

*
0RWRU

Export result:

Generic Data Mapper

48 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

3 ,'

3XPS

0RWRU

3XPS

0RWRU

3 ,'

3XPS

0RWRU

Number Explanation
① Because P&IDs are mapped explicitly in the structure, the number of these objects is also shown in export
results, if all conditions of the structure are met.
② 0-2 Rotary pumps with 0 or any number of motors are present. The condition is met.
Because rotary pumps are mapped explicitly, a pump with a motor is created for each rotary pump which
satisfies the condition in the target structure.
③ Exactly 1 gear pump is available. The condition is met.
Since the gear pump is not mapped explicitly, no pump is created in the target system.
④ Child elements of the gear pump play no role in the fulfillment of the condition, since they are not specified in the
structure. The motor is ignored.
⑤ Exactly 1 gear pump is available. The condition is met. Since the gear pump is not mapped explicitly, no pump
is created in the export result.
⑥ 0-2 Rotary pumps with 0 or any number of motors are present. The condition is met.
Because rotary pumps are mapped explicitly, a pump with a motor is created for each rotary pump which
satisfies the condition in the export result.
⑦ Since the motor is not mapped explicitly, the number of motors is ignored in export results.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 49
Using the Generic Data Mapper
2.11 Mapping structure components

Example 2.2
Export set:







Specified associations:

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU 1
3XPS
SXPS

5RWDU\ 1 0RWRU
SXPS

2
0RWRU

Export result:

3 ,'

3XPS

0RWRU

Number Explanation
① The top P&ID is ignored because not all conditions of the structure are met.
② More than 1 rotary pump is available. The condition is not met.
③ Exactly one gear pump is available. The condition is met.
The gear pump is not shown, however, because the structure is not satisfied as a
whole.
④ -
⑤ Exactly 1 gear pump is available. The condition is met. Since the gear pump is not
mapped explicitly, no pump is created in the export result.

Generic Data Mapper

50 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

Number Explanation
⑥ Exactly 1 rotary pump with 2 motors are available. The condition is met.
Because rotary pumps are mapped explicitly, a pump with a motor is created for each
rotary pump which satisfies the condition in the export result.
⑦ Since the motor is not mapped explicitly, the number of motors is ignored in export
results.

2.11.4 Using the "Any" element

The universal scheme structure element "Any" is available in the Generic Data Mapper. This
allows you to create mappings between any structure elements without determining a specific
type of a specific object.

Characteristics
"Any" is displayed in the "Scheme" control group, in the uppermost point of the source and
target schema respectively. It is created by the COMOS software and therefore does not form
part of the respectively selected schema provider.
The element "Any"
● Can be placed by using Drag&Drop in the "Mapping" control group both in the source and
the target structure, like any other schema structure element.
● Can be used as a placeholder for any type at a structure mapping definition, in both the
source and the target structure.
● Can be used as an own structure node in a mapping definition or as an element of an
existing variable structure. See also chapter Structure types (Page 25).
● Does not have any attribute with the exception of the "ID" attributes and the "Any" attribute.

Note
Use in a variable structure
If you use "Any" in an existing variable structure with other elements, these are ignored and not
evaluated.
Polymorphism
The activation and deactivation of polymorphism is not available for "Any".

Requirement

● You are familiar with the creation of a structure mapping definition and the mapping of
structure elements. See also chapter General workflow (Page 10).
● The examples are known to you. See also chapter Example: Using the "Any" element
(Page 52).
● You have loaded one source scheme and one target schema.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 51
Using the Generic Data Mapper
2.11 Mapping structure components

Procedure
● Drag&Drop the element "Any" into the "Mapping" control group, either into the source
structure or the target structure or both.
● Map "Any" from the source structure to an element in the target structure. The target
element can be any element that describes a technical or a structuring object or also an
"Any" element.

2.11.5 Example: Using the "Any" element

The examples illustrate which result and which export quantity you obtain when you use the
"Any" element.
See also chapter Using the "Any" element (Page 51).

Example 1

Objects in the source system Mapping definition Export result: Resulting objects in the
target system
● Pipe "Any" to "Pipe" ● Pipe
● Unit ● Pipe
● Subunit ● Pipe

Each of the three objects in the source system fulfills the mapping definition. Therefore three
"Pipe" objects are created in the target system.

Example 2

Objects in the source system Mapping definition Export result: Resulting objects in the
target system
● Pipe "Any" with "HasChild = Any" to "Pipe". ● Pipe
● Unit
● Subunit with "HasChild = Pipe"

Only one object in the source system has a "HasChild" relation and thus fulfills the mapping
definition. This one object is created in the target system as a "Pipe" object. The other two
objects in the source system do not fulfill the definition and are ignored.

2.11.6 The "Mapped" element

Aim
The "Mapped" element is foreseen for usage in a structure mapping definition with several
mapping rules.

Generic Data Mapper

52 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

It is not possible to use "Mapped" in a structure mapping definition that contains only one
mapping.
In a structure mapping definition and within a mapping rule with relations "Mapped" in the target
schema serves as a placeholder for elements that have already been assigned.
Example:
You have created an elementary mapping for the elements "Plant (source)" and "Plant (target)".
You create further mappings with Child relations that also contain "Plant (source). You had to
create mappings for "Plant (target)" again. During the evaluation and export of source objects
this construct can have the result that several target objects "Plant (target)" are created from
one source object "Plant (source)". "Mapped" prevents the generation of superfluous or
unwanted target objects.
See also chapter Example - using the "Mapped" element (Page 55).

Interpretation and logic during data export

During the evaluation of the mapping rules the element is interpreted as follows by the software:
● The software determines to which element in the source system and thus to which source
object the element "Mapped" is assigned.
● The software determines which target object has already been generated for this source
object. If a target object could not be determined, execution of the rule is deferred because
there could be other rules that have not yet been executed and that could possible generate
objects for this source object.
● The software checks whether the target object corresponds to the type limitation as
specified in the "Mapped" node. If not, the execution of the rule is is deferred.
● If the "Mapped" node is a "Child" node and a mapping exists, two cases are possible:
– The parent node is a normal node.
– The parent node is also a "Mapped" node.
In both cases the rule determines whether an object for the types of the target object pair
is generated. If one or both structure element nodes is a "Mapped" node, several target
objects may exist for each structure element node that fulfill the node condition. In this
case an object pair in the source and target schema is to be determined that also fulfills
the relation mapping.
If this object pair is unique, the target objects and the relation for the pair object is to be
generated. Otherwise no relation is to be generated and the software is to display a
message with regard to the ambivalence
● All the attribute mappings between the source structure element and the target structure
element "Mapped" are applied.
● The cardinality of source structure elements is taken into consideration and processed
correspondingly.
See also chapter Using the "Mapped" element (Page 54).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 53
Using the Generic Data Mapper
2.11 Mapping structure components

2.11.7 Using the "Mapped" element

In the Generic Data Mapper the universal scheme structure element "Mapped" is available that
serves as a placeholder in a structure mapping definition similar to "Any". See also
chapter Using the "Any" element (Page 51).

Characteristics
"Mapped" is displayed in the "Schema" control group in the target schema under "Any". It is
created by the COMOS software and therefore does not form part of the respectively selected
schema provider.
The element "Mapped"
● Can only be used in the target structure in the "Mapping" control group.
● Can be placed by using Drag&Drop in the target structure, like any other schema structure
element.
● Contains a variable structure with "Any", where "Any" can be deleted and be replaced by any
other types. See also chapter Structure types (Page 25).
● Can have relations like every scheme structure image element.
● Does not have any attribute with the exception of the "ID" attributes and the "Any" attribute.

Requirement
● You are familiar with the creation of a structure mapping definition and the mapping of
structure elements. See also chapter General workflow (Page 10).
● The targets and example are known. See also chapters The "Mapped" element (Page 52)
and Example - using the "Mapped" element (Page 55).
● You have loaded one source scheme and one target schema.

Procedure
● Drag&Drop the required elements into the source structure.
● Drag&Drop the required elements and the element "Mapped" into the target structure.
● Optional: Insert a type into the element "Mapped", thus creating a variable structure.
● Insert the desired relations into the source and target structure.
● Map the elements.

Generic Data Mapper

54 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

2.11.8 Example - using the "Mapped" element

The examples illustrate which export results you obtain when you use the "Mapped" element.
See also chapters The "Mapped" element (Page 52) and Using the "Mapped" element
(Page 54).

Example 1
Given mappings with three structure mapping definitions:

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

8QLW 8QLW

6XEXQLW 6XEXQLW

8QLW 0DSSHG

6XEXQLW 0DSSHG
+DV&KLOG 8QLW+DV6XE8QLW

Objects to be exported and export result:

Objects in the source system Export result: Resulting objects in the target system
● Unit ● Unit:
● Subunit ● Subunit
● Unit 2 with "HasChild = Subunit 2" ● Unit 2 with "UnitHasSubUnit = Subunit 2"

Three objects are generated in the target system. Mapping definitions 1 and 2 are elementary
mappings and generate one one-to-one "Unit" and one "Subunit" each.
Structure mapping definition 3 does not generate new object types, but solely the structure and
the relation with objects to the previously mapped object types "Unit" and "Subunit".

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 55
Using the Generic Data Mapper
2.11 Mapping structure components

Example 2
Given mappings with four structure mapping definitions:

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

8QLW 8QLW

8QLW 6WRUDJH
REMHFW

6XEXQLW 6XEXQLW

0DSSHG
$Q\
8QLW

6XEXQLW 0DSSHG
+DV&KLOG 8QLW+DV6XE8QLW

Objects to be exported and export result:

Objects in the source system Export result: Resulting objects in the target system
● Unit 1 ● Unit 1
● Subunit 1 ● Storage object 1
● Unit 2 with "HasChild = Subunit 2" ● Subunit 1
● Unit 2 with "UnitHasSubUnit = Subunit 2"
● Storage object 2

Two objects are generated in the target system for the object "Unit 1" because two elementary
mappings exist.
"Subunit 1" is generated one-to-one in the target system.
The "Any" element in Structure mapping definition 4 would allow any source object. However,
the use of "Mapped" in the target structure restricts the rule. Allowed objects in the target
structure can only be such objects that have a mapping to "Unit". In the example these are the
"Unit" and "Storage object" from Structure mapping definitions 1 and 2.
Thus for "Unit 2" a "Unit 2" with a relation to a previously mapped "Subunit" is generated in the
target system. In accordance with Structure mapping definition 2 a "Storage object 2" is also
generated for "Unit 2".

2.11.9 Structure-specific attributes

2.11.9.1 Mapping attributes within structures

They assign attributes of the source structure and target structure to each other, so that
attribute values of the source objects are transferred to the objects created in the target system
for an export.

Generic Data Mapper

56 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

If an associated attribute of the object in the source system is present for an export, the attribute
value of the source object is transferred to the associated attribute of the target object.

Note
Attribute mapping for structure elements with a cardinality of 1 or higher
If you create an attribute mapping for a structure element for which a cardinality of 1 or higher
is set, the attribute of the first found object is transferred into the target system.

Exception: You have globally defined the mapping in the "Global attribute mapping" main tab.
See also chapter Global attributes (Page 84).
You can display the attributes of the following elements in the "Attributes of the object <selected
element>" control group:
● Schema elements
Schema elements are available in the "Source schema" or "Target schema" control group.
All attributes of schema elements are read-only.
● Structure element
You can find structure elements in the "Source structure" or "Target structure" control group.
You can assign attributes to each other via Drag&Drop and edit the initial value of target
attributes.

Requirement
● The "Structure mapping" main tab is open.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 57
Using the Generic Data Mapper
2.11 Mapping structure components

Procedure
1. Select the structure element of the source structure.
2. Select the structure element of the target structure.
The attributes of each structure element are displayed below in several tabs. See also
chapter Tabs of the "Attributes of the object <selected element>" control group (Page 86).
3. Drag&Drop an attribute onto the desired attribute.
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDU
3XPS
SXPS

5RWDU\
SXPS 


$WWULEXWHRIWKHREMHFW $WWULEXWHRIWKHREMHFW
1DPH    1DPH   
Name Name
Description Location
SystemFullName

The mapped attributes are displayed in the "Structure element associations" tab.
Alternatively, you can create self-defined attribute values in the "Structure element
associations" control group. See also chapter Defining the initial value for attributes of the
target structure (Page 60).

Result
At all objects whose structure elements were mapped to each other and that contain the source
attribute and the target attribute, the attribute value of the source attribute is transferred into the
corresponding attribute of the generated objects in the target system.

Editing the mapping

See chapter Changing elements or attributes (Page 65).

See also
Enable use of global attributes without structure element associations (Page 85)
Mapping types and status of mappings (Page 63)

2.11.9.2 Example - Mapping attributes within structures

This example is based on a previously described example. See also chapter Example 2 -
Mapping elements within structures (Page 48).
Specified associations:

Generic Data Mapper

58 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 3 ,'

*HDUHG
3XPS
SXPS

&HQWULIX
JDOSXPS

$WWULEXWHVRIWKH&HQWULIXJDOSXPS $WWULEXWHVRIWKH3XPSREMHFW
REMHFW
1DPH    1DPH   
Name Name
Description Location
SystemFullName

The attribute value of the "Name" attribute of the following objects is exported:

The attribute value is written to the following objects created in the target system in the "Name"
attribute, if the attribute is present there:

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 59
Using the Generic Data Mapper
2.11 Mapping structure components

3 ,'

3XPS

0RWRU

3XPS

0RWRU

3 ,'

3XPS

0RWRU

If the "Name" attribute does not exist, the attribute value is not transferred.

2.11.9.3 Defining the initial value for attributes of the target structure
You can define an initial value for each attribute in the target structures on structure elements.
If objects are created in the target system based on these structure elements, the value is
transferred to the objects.

Requirement
The "Structure mapping" main tab is open.

Procedure
1. Select a structure element in the "Target structure" control group.
The attributes of the structure element are displayed.
2. Enter a value in the "Initial value" column of an attribute.
3. Save your entries.

Result
The entered value is entered for each export as a value.

Generic Data Mapper

60 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

See also
Creating an initial value with automatic counter (Page 61)

2.11.9.4 Creating an initial value with automatic counter

You can have a fixed initial value of an attribute supplemented by a counter. All the generated
objects below the same owner then do not receive the same value, but rather differ by the
attached index.
This makes sense, for example, when you want to specify the name of connectors or nozzles.
Supplement the fixed name by a placeholder so that the names of the objects differ.
Placeholder: ${EntityIndex}

Requirement
● You know the principle of initial names. See also chapter Defining the initial value for
attributes of the target structure (Page 60).
● You have created a structure mapping definition.

Procedure
1. Display the attributes of the structure element in the target structure for which you want to
insert a counter.
2. Enter an initial value into the "Initial value" column in the target structure.
Example: You enter the value "EA".

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 61
Using the Generic Data Mapper
2.11 Mapping structure components

3. Supplement the fixed value with the placeholder in the "Initial value" column.
The entry is then as follows: EA${EntityIndex}
If, for example, you export a motor with three connectors, the following names are entered
at the generated objects: EA1; EA2; EA3
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

0RWRU 0RWRU

&RQQHFWRU &RQQHFWRU ,QLWLDOYDOXHIRU

1DPH
DWWULEXWH
($^(QWLW\,QGH[`

([SRUWTXDQWLW\ ([SRUWUHVXOW

0RWRU 0RWRU

1DPH 
($

&RQQHFWRU &RQQHFWRU

1DPH 
($

&RQQHFWRU &RQQHFWRU

1DPH 
($

&RQQHFWRU &RQQHFWRU

The index applies only to connectors and is re-calculated for each motor.
4. When the placeholder is replaced, it is replaced by default by a one-digit number. To have
it replaced by a two-digit number, enter the suffix "00" at the end of the placeholder.
Example: EA${EntityIndex:00}
Result: EA01; EA02; EA03

2.11.9.5 Example - Mapping units

The procedure is provided as an example and only contains basic steps and explanations.

Requirement
● The objective of the unit mapping is known. See also chapter "Units" view (Page 20).
● Source schema: COMOS, target schema: "ECXMLSchema" from Bentley
● The schema file for the Bentley unit system is available.
● A mapping definition is loaded.
● The mapping of structure elements is known.

Generic Data Mapper

62 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

Procedure
● In the "Target schema providers" area, load the unit system under "UnitSchemaPath".
● In the "Schema area", select the "Units" tabs for both schemas.
● Map the desired units using Drag&Drop. The respective assignment is displayed as a line
in the "Mapping" area of the "Unit mapping" tab.
● Optional: To delete the assignment, select the button of the same name in the "Action"
column.
● In the "Schema" area, select the "Classes" tab for both schemas.
● In the source and target schema, select an assigned element that represents a technical
device, such as a vessel. In the "Attributes of selected pattern structure element" area, the
attributes and, if available, their respective units are displayed.
● Expand a COMOS attribute, for example diameter, so that its sub-characteristics are
displayed. The characteristics "SIValue" and "SIValueUnit" are listed for each attribute with
units.
● Use Drag&Drop to map the "SIValueUnit" characteristic to the corresponding
"ValueWithUnit" characteristic for the diameter of a vessel in the target schema. The
assignment is displayed as a row in the "Structure element associations" tab.
● Optional: To delete the assignment, select the button of the same name in the "Action"
column.

Result
In terms of data technology, the attributes are linked in such a way that a specific value in SI unit
plus unit is transferred from COMOS to the appropriate value in the target system and correctly
converted.

2.11.10 Mapping types and status of mappings

A status is display for each association in the "Structure element associations" control group.
Example:

6WUXFWXUHHOHPHQWDVVRFLDWLRQV
6RXUFHHOHPHQW 6RXUFHDWWULEXWH 7DUJHWHOHPHQW 7DUJHWDWWULEXWH 7UDQVIRUPDWLRQ $FWLRQV
 P&ID Name Name
P&ID
 Gear pump Name Pump
Rotary pump Pump


Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 63
Using the Generic Data Mapper
2.11 Mapping structure components

Position number Description

① Attribute association
Indicates that there is a valid attribute association for the structural element
association.
You can specify an "attribute value transformation" for valid attribute associ‐
ations:
● Unit conversion
See also chapter Setting the unit conversion (Page 65).
● Language conversion
See also chapter Setting language conversion (Page 67).
② Invalid
Indicates that there is an invalid attribute association for the structural element
association. This is the case when only the source attribute or target attribute
has been selected.
③ Structure element association
Indicates that there a structure element association exists. Global attribute
associations are used for each structure element association, if available.

Only attribute associations are shown in the "Attribute associations" control group of the
"Global attribute mapping" main tab.

Note
Representation of attribute mappings that have become invalid

When you replace a structure element in the source or target structure and when the new
structure element does not have the originally mapped attribute, a previously valid attribute
mapping becomes invalid. In this case, the attribute is not removed from the attribute mapping,
but rather displayed in red.

Generic Data Mapper

64 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

2.11.11 Editing structure element associations

2.11.11.1 Deleting or commenting associations

Procedure
1. To delete or comment a mapping, move the mouse pointer over it.
The buttons for these actions are displayed in the "Actions" column.
6WUXFWXUHHOHPHQWDVVRFLDWLRQV
6RXUFHHOHPHQW 6RXUFHDWWULEXWH 7DUJHWHOHPHQW 7DUJHWDWWULEXWH 7UDQVIRUPDWLRQ $FWLRQV
P&ID Name P&ID Name
Gear pump Name Pump
Rotary pump Pump

2. Click one of the buttons.

2.11.11.2 Changing elements or attributes

Procedure
1. To select other elements or attributes in a mapping, expand the list.
– For elements:
All elements of the structure are offered in the list.
– For attribute:
All attributes of the selected element are offered in the list.
2. Select a value.
6WUXFWXUHHOHPHQWDVVRFLDWLRQV
6RXUFHHOHPHQW 6RXUFHDWWULEXWH 7DUJHWHOHPHQW 7DUJHWDWWULEXWH 7UDQVIRUPDWLRQ $FWLRQV
P&ID Name P&ID Name
Gear pump Name Pump
Rotary pump Pump

3. If you have selected an element-specific attribute in the "Source attribute" column, such as
"Nominal diameter", a second list is offered in which you can select a system property of the
attribute.
If you have already selected a system property in the first list, such as "SystemUID", a
second list is not offered.

2.11.11.3 Setting the unit conversion

Requirement
You have created an attribute association.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 65
Using the Generic Data Mapper
2.11 Mapping structure components

Procedure
1. Move your mouse over the "Transformation" column of the attribute association.
The "Adds an attribute value transformation to the chain" button is displayed.
2. Click this button.

A menu opens.
3. Select the "Unit converter" entry.
A button for the unit conversion is displayed in the "Transformation" column.

The red border of the button indicates that the source unit, the target unit or both units have
not yet been set.
4. Move the mouse over the button.
Additional buttons for editing the transformation are displayed.

5. Click "Configures the attribute value transformation".

The "Configure unit converter" window opens.
6. In the "Dimension" list, select the dimension for which you want to specify a unit conversion.
If units have already been set for the source attribute or the target attribute in the dataset and
their spelling matches the spelling of the units in COMOS, the correct units are pre-selected.
If no units or units with another spelling were specified, assign the units to each other
manually.
7. Optionally: Change the unit of the source attribute in the "Source unit" list.
8. Select the unit of the target attribute in the "Target unit" list.
9. Confirm your entries.
The red border disappears.

Setting multiple rules for a unit conversion

If you make multiple rules for the unit conversion, the rule in which the specified source unit
corresponds to the source unit at the attribute automatically takes effect.
Example:

● Rule "mm" is converted to "m"

● Rule "m" is converted to "km"

Generic Data Mapper

66 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

If the unit "m" is set at the source attribute in the dataset, the second rule takes effect.
If the no unit or another unit is set at the source attribute, no rule takes effect. The button for the
"Unit converter" is outlined in red.

Deleting a unit conversion

Click "Removes the attribute value transformation from the chain".

2.11.11.4 Setting language conversion

Language conversion enables you to specify the language of the attribute value to transferred
to the target system for multilingual attributes.

Note
Language conversion only possible if the source attribute is the type "MultiLanguageString"
The language conversion will not work correctly if the type of the source attribute is not
"MultiLanguageString". The type of an attribute is shown in the "Mapping" control group under
"Attributes of the object ...".

Requirement
You have created an attribute association that has a "MultiLanguageString" type attribute as
the source attribute.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 67
Using the Generic Data Mapper
2.11 Mapping structure components

Procedure
1. Move your mouse over the "Transformation" column of the attribute association.
The "Adds an attribute value transformation to the chain" button is displayed.
2. Click this button.

The red arrow indicates the attributes that are associated with each other in this example.
A menu opens.
3. Select the "Select language" entry.
A button for the language conversion is displayed in the "Transformation" column.

4. The red border of the button indicates that the language has not yet been set.
5. Move the mouse over the button.
Additional buttons for editing the transformation are displayed.

6. Click "Configures the attribute value transformation".

A window opens.
7. Select a language in the "Language" list.
8. Confirm your entries.
The red border disappears.

Deleting a language conversion

Click "Removes the attribute value transformation from the chain".

Generic Data Mapper

68 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

2.11.11.5 Setting the string transformation

Requirement
● You have basic knowledge of calling and handling the transformation functions. See also
chapter Setting the unit conversion (Page 65).
● You have created an attribute mapping, for example, in which strings are mapped for a
name or a complete path.

Procedure
1. Click the "Adds an attribute value transformation to the chain" button in the "Transformation"
column.
2. To define the delimiter, select the entry "Split Transformer" from the menu.
The following button appears:

3. Move the mouse to the button and click "Configure attribute transformation".
A window opens.
4. Enter the required delimiters.
Optionally: Select an option for the separation from the drop-down list.
5. Confirm your entries.
6. Click this button:

7. To define the position and the required number, select the entry "ElementAt Transformer"
from the menu.
8. Move the mouse to the button and click "Configure attribute transformation".
A window opens.
9. Enter how many characters are to be included and whether the inclusion takes place before
or after the delimiter.
10.Confirm your entries.

2.11.11.6 String conversion using regular expressions

In the Generic Data Mapper, you can convert and replace character strings by using regular
expressions.
The Microsoft standard for the so-called "Regex" was implemented.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 69
Using the Generic Data Mapper
2.11 Mapping structure components

Usage
● Click the "Adds an attribute value transformation to the chain" button in the "Transformation"
column.
● Select the "Regular expression replacer". The "Miscellaneous" table opens.

Replacement pattern $0
Options None
Regular expression ^.*$

Replacement pattern defines the desired result. The regular expression defines how the
incoming or original character string is read and evaluated.
The default is identity transformation; what is found is replaced by itself.
Regular expression is always a regular expression, which means: Characters that are to be
specially interpreted and searched for must end with "\".

Operators and detailed documentation of the Regex

See Regex options: (https://docs.microsoft.com/de-de/dotnet/api/
system.text.regularexpressions.regexoptions?
redirectedfrom=MSDN&view=netframework-4.7.2) and Syntax for Regex (https://
docs.microsoft.com/de-de/dotnet/standard/base-types/regular-expression-language-quick-
reference)

Examples
Search for dot "." Must then be "\.".
To search for a backslash: "\\".
Example 1
Parsing names
V001.D003 Name is mapped. And part of the name is needed and possibly in a different order
Regular expression: ([A-Z])([0-9]+)\.([A-Z])([0-9]+)
Replaces the complete name. Replacement pattern: K$4\-N$2
Would return K003-N001 as a result
Example 2
Parsing names
V001.D003X004 Name is mapped. And part of the name is needed and possibly in a different
order
Regular expression: ([A-Z])([0-9]+)\.([A-Z])([0-9]+)
Replaces the complete name. Replacement pattern: K$4\-N$2
Would return K003-N001X004 as a result
Example 3
V001.D003

Generic Data Mapper

70 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

Regular expression: ([0-9]+)

Replacement pattern: Test
Result: VTest.DTest

2.11.11.7 Reference to attribute values in the conversion pattern

The string conversion can use an existing string from an attribute of the source or target.

Procedure
When converting units or replacing them with regular expressions, you use curly brackets to
define the desired attribute:
${Source:InternalAttributeName}
or
${Target:InternalAttributeName}
The references are replaced by the value of the attribute of the source or target object. The
references can be placed any number of times and anywhere in the replacement pattern, such
as the group references $0-$N.
If you place the mouse pointer on an entry in the "Name" column, the internal attribute name is
displayed as a Tooltip.

Example
${Source:Y00A10.Y00A20}

The display name is "Customer mapping 2", the internal "Y00A10.Y00A20".

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 71
Using the Generic Data Mapper
2.11 Mapping structure components

Initial values
When referring to the target object, note that the initial values that can be entered in the "Initial
value" column of the target attribute list are set first. The attribute assignments are then applied
first. This means: You can refer to attributes that were initialized in the target object via the
"Initial value" column. The value may be undefined for other target attributes.

2.11.12 Labeling identical objects

You often use the objects within one or more structure mapping definitions that are to be
represented by the same object in the target system. To avoid having to create this object in the
target system in each instance, label the object within a structure or across structures with an
ID when an appropriate object constellation is found. This allows COMOS to recognize that this
is the same object and it only has to be created once.

Example
The following example shows the export results obtained for the listed export set and the
specified structure mapping definitions without an ID.
Export set:

Given structure mapping definitions:

Generic Data Mapper

72 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

6WUXFWXUHPDSSLQJGHILQLWLRQ
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 8QLW

3XPS 3 ,'

3XPS

)ROGHU

3XPS

6WUXFWXUHPDSSLQJGHILQLWLRQ
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6XEXQLW 8QLW

6XEXQLW

Export result:

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 73
Using the Generic Data Mapper
2.11 Mapping structure components

8QLW

3 ,'

3XPS

)ROGHU

3XPS

8QLW

3 ,'

3XPS

)ROGHU

3XPS

8QLW

6XEXQLW

● The unit is created three times in the export result.

● Two pumps each are created for structure mapping definition 1.
For example, to create only one unit and only one pump for each structure mapping definition
1, use IDs:
● See chapter Identical target objects that are based on the same COMOS object (Page 76).
● See chapter Identical target objects that are independent of a COMOS object (Page 74).

2.11.12.1 Identical target objects that are independent of a COMOS object

If you label identical target objects that are independent of a COMOS object, only one object is
generally created in the target system for one structure element.
This label can be used across multiple structures. You can label objects by entering a fixed
value in the "IdCreation" attribute at the structure element in the target structure.

Generic Data Mapper

74 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

The example below shows how to use a fixed ID for the PDMS target system.

Aim
This aim is based on a previously described example. See also chapter Labeling identical
objects (Page 72).
You want to create only one unit in the export result. All objects are to be arranged below this
unit.

Procedure
1. In structure mapping definition 1, select the structure element for the unit in the target
structure.
2. In the "Initial value" column, enter a fixed value in the "IdCreation" attribute.
3. In structure mapping definition 2, select the structure element for the unit in the target
structure.
4. In the "Initial value" column, enter the same value as before in the "IdCreation" attribute.
6WUXFWXUHPDSSLQJGHILQLWLRQ
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 8QLW

3XPS 3 ,'

3XPS

)ROGHU

3XPS

6WUXFWXUHPDSSLQJGHILQLWLRQ
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

6XEXQLW 8QLW

6XEXQLW

$WWULEXWHVRIWKHREMHFW $WWULEXWHVRIWKHREMHFW
1DPH    1DPH ,QLWLDOYDOXH
[IdCreation] *HQHUDOBXQLW

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 75
Using the Generic Data Mapper
2.11 Mapping structure components

Result
Export set:

Export result:

8QLW

3 ,'

3XPS

)ROGHU

3XPS

3 ,'

3XPS

)ROGHU

3XPS

6XEXQLW

● The unit is created only once.

● All objects are created below the unit.

2.11.12.2 Identical target objects that are based on the same COMOS object
Use a variable ID to label identical target objects that are based on the same COMOS object.

Generic Data Mapper

76 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

This label can be used across multiple structures. You can label objects by assigning a COMOS
attribute with a unique value to the "IdCreation" attribute at a structure element in the target
structure.
Example: SystemUID
In this case, only one object is created in the target system for each object with the same
SystemUID.
The example below shows how to use a variable ID for the "PDMS" target system.

Aim
This aim is based on a previously described examples.
See also chapters Labeling identical objects (Page 72) and Identical target objects that are
independent of a COMOS object (Page 74).
You want to create only one pump for each object constellation found in the export result that
matches structure mapping definition 1 .

Procedure
1. In structure mapping definition 1, select the structure element for the pump in the source
structure.
2. Select the first structure element for the pump in the target structure.
3. Drag&Drop the "SystemUID" attribute onto the "IdCreation" attribute of the target structure.
A line for the new association is inserted in the "Structure element associations" control
group.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 77
Using the Generic Data Mapper
2.11 Mapping structure components

4. Select the second structure element for the pump in the target structure.
5. Drag&Drop the "SystemUID" attribute onto the "IdCreation" attribute of the target structure.
6WUXFWXUHPDSSLQJGHILQLWLRQ
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

3 ,' 8QLW

3XPS 3 ,'

3XPS

)ROGHU

3XPS

$WWULEXWHVRIWKHREMHFW $WWULEXWHVRIWKHREMHFW
1DPH    1DPH ,QLWLDOYDOXH
SystemUID [IdCreation]

A line for the new association is inserted in the "Structure element associations" control
group.

Result
Export set:

Export result:

Generic Data Mapper

78 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

8QLW

3 ,'

3XPS

)ROGHU

3 ,'

3XPS

)ROGHU

6XEXQLW

By default, the pump is only created once in the target system, if an object constellation is found
that matches structure mapping definition 1. Where the pump is created physically in the object
tree depends on your target system.
Possibilities:
● Under the P&ID
● Under the folder
● Under both objects
In the case of "PDMS":
Change the relation in the target structure at one of the two pumps to "has reference attribute
<object type of pump>". The pump is then physically created under the object with the relation
"has child <pump>". Only a reference to the pump is created under the object with the relation
"has reference attribute <object type of the pump>".

See also
Mapping attributes within structures (Page 56)

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 79
Using the Generic Data Mapper
2.11 Mapping structure components

2.11.13 Assigning specific connectors of a COMOS object

Connectors are displayed as usual under the request objects in the COMOS schema.
Example: Connectors for input and output
You can insert these connectors in structure mapping definitions and assign them. The
assigned connector in the target system is then generated for each input connector and output
connector during an export or import.
Instead of different specific connectors, you can also use a general connector. See also chapter
Assigning a general connector (Page 81).

Requirement
You have created a structure mapping definition. See also chapter Creating structure mapping
definitions automatically (Page 28).

Procedure
1. Add the required connectors to the structure mapping definition of the source system and of
the target system.
Example on COMOS side:
From the COMOS schema, drag the connectors "EA01" and "EA02" of an object into the
structure.
2. To generate an output connector for each found input connector, assign the connectors to
each other.
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH

0RWRU 0RWRU

&RQQHFWRU &RQQHFWRU
,QSXW ,QSXW

&RQQHFWRU &RQQHFWRU
2XWSXW 2XWSXW

3. Optional: Assign the attributes of the connectors to each other. See also chapter Mapping
attributes within structures (Page 56).

Result
● If you have not assigned the names of the connectors to each other, the names entered in
the base object are used during an import to COMOS.
Example: The names "EA01" and "EA02" are assigned to imported connectors.
● The assigned connector objects are generated for input and output during an import or
export. Other connectors are not taken into account.

Generic Data Mapper

80 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

This structure is only an example. You can limit the conditions of the structures as you wish or
assign attributes.
● See also chapter Modifying structures (Page 35).
● See also chapter Structure-specific attributes (Page 56).

2.11.14 Assigning a general connector

You can use a general connector alternatively to the specific COMOS connectors. See also
chapter Assigning specific connectors of a COMOS object (Page 80).
The general connector has the following advantages compared to the specific COMOS
connectors:
● You require only one structure element instead of one for the input and one for the output.
● When you set "Polymorph" at the connector, all the connector types of an object are taken
into consideration during an import or export.
The general connector is located in the COMOS schema on the highest level of the tree.

Name of the object: "ComosBaseConnector"

Requirement
You have created a structure mapping definition. See also chapter Creating structure mapping
definitions automatically (Page 28).

Procedure

Note
In the following section, the structure of a possible structure mapping definition is shown as an
example.
You can limit the conditions of the structures as you wish, assign attributes or interchange
source system and target system.
● See also chapter Modifying structures (Page 35).
● See also chapter Structure-specific attributes (Page 56).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 81
Using the Generic Data Mapper
2.11 Mapping structure components

1. Add a general connector to the structure mapping definition on the COMOS side.
2. Add a desired connector to the structure mapping definition on the other side.
3. To ensure that the source structure functions at objects with any number of connectors, set
the cardinality "*" at the connector. See also chapter Setting the cardinality (Page 36).
4. To ensure that the source structure functions at objects with any connector types, set the
"Polymorph" setting at the connector. See also chapter Setting polymorphism (Page 42).
5. To generate a connector in the target system for each found connector, assign the
connectors to each other.
Example:
6RXUFHVWUXFWXUH 7DUJHWVWUXFWXUH&2026

0RWRU 0RWRU

*HQHUDO
&RQQHFWRU
FRQQHFWRU

Result
A general connector is then generated in the target system for each found connector during an
export or import.

2.11.15 Searching for assigned elements

You can search within a mapping definition. To do so, specify an element from the source
schema and find the locations in the structure mapping definitions where the element is used.
The functionality and the procedure are the same for source schema and target schema.

Requirement
● You are familiar with the user interface of the Generic Data Mapper. See also
chapter Interface description: Generic Data Mapper (Page 11).
● Schemas and a mapping definition are loaded.

Generic Data Mapper

82 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.11 Mapping structure components

User interface

Procedure
1. To open the search window, click "Search" in the toolbar.
2. Drag the required element of the source schema from the "Schema" control group and the
"Classes" view to the "Class" field. Alternative procedure: Drag the desired COMOS base
object from the Navigator into the "Class" field. Multiple selection allows you to insert
multiple objects.
3. Activate "Toggle polymorph on/off" for each element in the "Class" field.
4. Click "Start".
5. If one or more elements are displayed as result, decide which element you want to navigate
to and click the corresponding "Navigate" symbol.

Result
● The required element is shown in color in the source structure in the "Structure mapping" tab
of the "Mapping" control group.

2.11.16 Correcting invalid references

References can become inconsistent through subsequent database modifications.
Data export is aborted with an error message as of the occurrence of a single incorrect
reference.
This means you must find the invalid references manually and reassign them.

Finding and correcting inconsistencies

1. Open the search function with the "Search" button in the toolbar.
2. In the standard table select the entry "Invalid schema element references".

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 83
Using the Generic Data Mapper
2.12 Global attributes

3. Select the desired reference classes via the options.

4. Start the search.
5. Inconsistent references are displayed under Result. From here you can navigate back to the
mapping definition.
The missing element is marked in red in the Mapper in the "Structure mapping" section.
6. Reassign a new element.
COMOS: Via drag&drop from within the Navigator (engineering project or base project)
Bentley Open Plant schema: Select a new element in the loaded structure.

Result
Data export is possible once again.

2.12 Global attributes

Create a global association so that you do not have to set frequently used attribute mappings
for each structure element association.
You create global attributes in the "Global attribute mapping" main tab.

Note
Application with structure element associations only
Globally mapped attributes are only applied for structure element associations. Globally
mapped attributes are not transferred for structure elements that are not mapped.
See also chapter Enable use of global attributes without structure element associations
(Page 85).

Globally mapped attributes are executed in addition to the structure-specific attribute

mappings. When the two mapping types are contradictory, the structure-specific attribute
mapping has priority.
Globally assigned attributes are independent of structures and are defined at schema
elements. They are inherited down in the schema and are valid for all child elements of the
schema element.
If objects in the export set have a globally mapped attribute, the attribute value of each object
is exported and transferred to the corresponding attribute of the object created in the target
system.

Requirement
The "Global attribute mapping" main tab is open.

Generic Data Mapper

84 Operating Manual, 06/2019 V10.3.2
 Using the Generic Data Mapper
2.12 Global attributes

Procedure
1. Select a schema element in the "Source schema" and "Target schema" area.
The attributes of the schema elements are displayed in the control groups below.
2. Use drag&drop to drag one attribute onto another.
6RXUFHVFKHPD 7DUJHWVFKHPD

6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW  7(OHPHQW
6(OHPHQW 7(OHPHQW
6(OHPHQW 7(OHPHQW
7(OHPHQW

$WWULEXWHVRIWKHREMHFW $WWULEXWHVRIWKHREMHFW
1DPH    1DPH   
Name Name
Description Location
SystemFullName

Result
The association is displayed in the "Attribute associations" control group.

$WWULEXWHPDSSLQJV
6RXUFHDWWULEXWH 7DUJHWDWWULEXWH
Name Name

2.12.1 Enable use of global attributes without structure element associations

You can also transfer globally mapped attributes for objects for which you have not created a
structure element association. This may be necessary in individual cases.

Procedure
1. Open the "Structure mapping" main tab.
2. Select a structure element in the source structure.
3. Select a structure element in the target structure.
4. Drag&drop the "[Any]" attribute onto the "[Any]" attribute of the target structure.
See also chapter Mapping attributes within structures (Page 56).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 85
Using the Generic Data Mapper
2.12 Global attributes

Result
The global attribute mapping is applied to objects that match the two selected structure
elements.

2.12.2 Editing global attribute associations

You can delete or comment attribute associations.

Requirement
The "Global attribute mapping" main tab is open.

Procedure
See section Editing structure element associations (Page 65).

2.12.3 Tabs of the "Attributes of the object <selected element>" control group
Different types of tabs are displayed in these control groups.

Types of tabs
● "All" tab
Includes the attributes of all tabs
● Tabs in brackets
These tabs are system tabs.
Source of the attributes:
– Schema provider
– System properties of the element
● Plain text
These tabs include object properties.

Show subordinate attributes

You expand an attribute by clicking on the white arrow tip.

Generic Data Mapper

86 Operating Manual, 06/2019 V10.3.2
Exchanging process data with OpenPlant Modeler 3
You can export process data from COMOS, save it in an i-model and import them into
OpenPlant Modeler. In doing so, you transfer the following information to an I.DGN file:
● P&IDs with the placed P&ID objects
● Selected object properties of the placed P&ID objects
You reference this file in the OpenPlant Modeler. You place corresponding 3D objects for the
referenced P&ID objects there.
If you create a consistency report of the edited data in the OpenPlant Modeler, you can import
it into COMOS.
You export process data from COMOS with the "COMOS P&ID process data export" plugin. In
this plugin, you specify the P&IDs that are to be exported. You have previously created the
mapping definition required for this purpose in the Generic Data Mapper or have copied it from
the included example data.
In this chapter we describe in reference to the Generic Data Mapper what you must observe for
a mapping definition for export to OpenPlant Modeler.
You can find basic information on working with the Generic Data Mapper in the chapter Using
the Generic Data Mapper (Page 9).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 87
Exchanging process data with OpenPlant Modeler
3.1 Overview of the work sequence

3.1 Overview of the work sequence

The following graphic shows the schematic workflow.

&2026 2SHQ3ODQW0RGHOHU

*HQHULF'DWD0DSSHU

,PSRUW2SHQ3ODQWVFKHPDLQWR 3URYLGH2SHQ3ODQWVFKHPD
WKH3URYLGHU ILOHVIRU&2026

&UHDWHRUHGLWPDSSLQJ
GHILQLWLRQVIRULPSRUWH[SRUW

&RQILJXUHSURMHFWSURSHUWLHV

3URFHVVGDWDH[FKDQJHIRU
2SHQ3ODQW0RGHOHU

&UHDWHZRUNSDFNDJHDQGDGG
3 ,'V

([SRUWZRUNSDFNDJH ,'*1 ,PSRUWDQGHGLWLPRGHO

,PSRUW;0/ILOH ;0/ ([SRUW&RQVLVWHQF\&KHFNHU

5HSRUW

(OLPLQDWHLQFRQVLVWHQFLHV

Generic Data Mapper

88 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.1 Overview of the work sequence

Requirement
An engineering project exists in COMOS that contains at least one P&ID with placed objects.

Procedure
1. As COMOS administrator, import the schema files and create the mapping definitions for
export and import with the "Generic Data Mapper" plugin. Alternatively: Use the included
example data which you can expand, if necessary. See also chapter Administration of the
OpenPlant Modeler interface (Page 93).
2. When you work with the "COMOS P&ID process data export" plugin for the first time,
configure the project properties of the COMOS engineering project accordingly.
3. As COMOS user, create workpackages with P&IDs in the "COMOS P&ID process data
export" plugin that you want to export. See also chapter Exporting process data (Page 98).
4. Export the COMOS data as i-model in the I.DGN format.
5. Open the OpenPlant Modeler.
6. Reference the I.DGN file. See also chapter Referencing process data in OpenPlant Modeler
(Page 100).
7. Activate the Consistency Checker.
8. Place corresponding 3D objects for all referenced P&ID objects according to the user
documentation of the OpenPlant Modeler.
9. Export the 3D process data in form of a Consistency Checker Reports as XML file.
10.Import the XML file into COMOS. See also chapter Importing process data and consistency
information in COMOS (Page 101).
11.If necessary, check the imported data for inconsistencies and edit them accordingly. See
also chapter Checking and editing imported data (Page 102).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 89
Exchanging process data with OpenPlant Modeler
3.2 User interface description for the export

3.2 User interface description for the export

 

Menu bar

Number Description
1 Buttons:
If you have previously created a workpackage file, you can load it now. The path and the
name of the loaded file is shown in the field.
If you have created a workpackage in the "Workpackages" area, you can save it to a file.
See Chapter Creating a workpackage file (Page 98) and Loading workpackage file
(Page 98).

Generic Data Mapper

90 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.2 User interface description for the export

"Workpackages" area

Number Description
2 ● "New workpackage" button
Creates a new workpackage the shows up as a new cell in the workspace.
See chapter Creating workpackages (Page 99).
● "Export all workpackages" button
See chapter Exporting workpackages (Page 100).

● "Name" column
Displays the name of the workpackages. Initially always contains the "Scope"
package as placeholder; you can rename and edit it as needed.
See chapter Editing workpackages (Page 99).

● "Actions" column
When you guide the mouse pointer to a workpackage, the entire row is marked and
additional, self-explanatory buttons for exporting, editing and deleting appear in the
"Actions" column.

"Log" area

Number Description
3 Shows the status of the actions that you have started.

"Detail view of workpackages" area

Number Description
4 ● "Export opened workpackages" button
Exports all workpackages that are displayed as tab in this view.

● "Close all" button

Clears the entire view. To show contents once again, select the "Edit workpackage"
action in the "Workpackages" area.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 91
Exchanging process data with OpenPlant Modeler
3.3 User interface description for the import

3.3 User interface description for the import

 

"OpenPlant Modeler" area

Number Description
1 ● "Load workspace" button
Opens a dialog window for loading an XML file with 3D data "OpenPlant Modeler
workspace". See also chapter Importing data (Page 102).
● "Check status" button
Checks the status of all objects in the object tree. See also chapter Check status
(Page 106).
2 "OpenPlant Modeler workspace" control group
Displays the requested 3D data as an object tree.

"Event log" area

Number Description
3 Shows the status of the actions that you have started.

Generic Data Mapper

92 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.4 Administration of the OpenPlant Modeler interface

"Attributes of object selected in workspace" area

Number Description
4 Shows the attributes of the object that is selected in the "OpenPlant Modeler workspace"
area.
Columns
● "Attribute"
Name of the attribute
● "OpenPlant Modeler"
Attribute value from OpenPlant Modeler
● Double-arrow symbol
If an arrow symbol is displayed in a line, this indicates differing attribute values. If you
want to synchronize the values, click the arrow symbol. The direction of the arrow
indicates the direction of the transfer.
● "COMOS"
Attribute value from COMOS

Buttons
● "Update all"
If you want to synchronize all lines with differing attribute values, click this button.
Preceding marking of the rows is not required.
● "Update selected"
If you have marked several rows with differing attribute values and want to
synchronize these, click this button.
See also chapter Editing inconsistent attribute values (Page 104).
5 "Inconsistencies of object selected in workspace" control group
Shows the inconsistencies between the COMOS data and the 3D data. The inconsis‐
tencies are determined recursively and displayed accordingly. See also chapter Check‐
ing and editing imported data (Page 102).

3.4 Administration of the OpenPlant Modeler interface

3.4.1 Example data for OpenPlant Modeler

Siemens provides you with example data for the OpenPlant Modeler and PlantWise interfaces
which include mapping definitions and diagrams. See also chapters Configuring the process
data exchange (Page 97) and Configuring PlantWise process data export (Page 111).

Access to the example data

You can find the example data in form of GMAD files in your COMOS installation directory in the
following folders:
<COMOS installation directory>/config/MappingFiles/OpenPlant/>

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 93
Exchanging process data with OpenPlant Modeler
3.4 Administration of the OpenPlant Modeler interface

<COMOS installation directory>/config/MappingFiles/PlantWise/>

The names of the GMAD files are structured so that the source system is listed first. This
information provides you with the direction of the data exchange.
Example for the export of OpenPlant Modeler to COMOS:
Example_OpenPlantModelerV8.11_COMOSV10.2iDB-PID_*.gmad

Content of the example data

The GMAD files contain the mapping definitions and necessary schema data from the
OpenPlant Modeler.
Version used: OpenPlant.01.07.

General information on handling

● To avoid deleting or overwriting the example data unintentionally, copy them to a different
suitable storage location.
● For all users to use the same example data, you should choose a central storage location
that permits access by all users.
● All users should only use one valid mapping definition within a COMOS engineering project.

3.4.2 Structure of a mapping definition

Basic structure mapping definitions

The structure mapping definitions in the table below are included in the example mapping
definitions provided to you. These structure mapping definitions are necessary to enable a
meaningful process data export from COMOS to OpenPlant Modeler.

Note
Changes can lead to an incorrect process data export.
● Do not delete these definitions.
● Do not delete the assignments contained therein. Optionally, you can change the structure
mapping definitions by using other schema elements.

Structure mapping definition Description

Mandatory: FB => PID_DOCUMENT This assignment is needed in order to be able to create a P&ID document in
OpenPlant Modeler.
Without this assignment the process data export will fail.
Mandatory: A10 => PIPING_NET‐ This assignment is needed to map a unit structure with pipes between COMOS
WORK_SYSTEM and OpenPlant Modeler.

Generic Data Mapper

94 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.4 Administration of the OpenPlant Modeler interface

Structure mapping definition Description

Mandatory: COMOS_PLANT => This assignment is needed to map the "Plant" object in both systems.
PLANT_AREA
Mandatory: ... All other assignments that are basically needed to map pipes to structuring ob‐
jects in OpenPlant Modeler.
OPM_Relation: ... These rules are necessary to only map the relations between the objects.

You can expand the structures to include additional structure elements and your own attribute
assignments. See also chapter Editing an example mapping definition (Page 95).

3.4.3 Editing an example mapping definition

No additional editing is required to use an example mapping definition. Optionally, you can edit
and expand this definition in the Generic Data Mapper.

Requirement
● You have experience in creating mapping definitions with the "Generic Data Mapper" plugin.
● You are familiar with the contents of the example mapping definition for OpenPlant Modeler.
See also chapter Structure of a mapping definition (Page 94).

Procedure
1. Open the example structure mapping definition.
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.
8. Save the structure mapping definition.
See also chapters Preparing structures (Page 22) and Mapping structure components
(Page 45).

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 included example mapping definition.
4. Save the structure mapping definition.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 95
Exchanging process data with OpenPlant Modeler
3.4 Administration of the OpenPlant Modeler interface

3.4.4 Setting up the ODBC connection for OpenPlant Modeler

To exchange process data between COMOS and OpenPlant Modeler, the objects from both
systems must have unique identification keys and unique relations to each other at all times.
These identification keys and relations are created and administered in their own "SQL Server"
database that must be provided by you as COMOS administrator as ODBC data source.

Requirement
● You are familiar with setting up a database instance on an SQL server.
● You are familiar with creating an ODBC data source. You can find additional information on
this topic in the "Installation" manual, keyword "Administering ODBC data source for SQL
client".

Procedure
1. Open the "ODBC data sources administrator" window and click "Add".
2. Select the following driver: "SQL Server".
3. Click "Finish".
4. Enter the following in the "Create new data source for SQL server" window:
– Name: The required data source name, also referred to as "DSN"
– Optional: Description
– SQL Server: Name of the SQL server on which the database for administration of the
keys is made available.
5. Save your entries.
6. Set up access rights for your COMOS users to the data source. Recommendation: To do so,
use the Windows authentication. This way you prevent that COMOS users are prompted to
enter login credentials for the created data source.

Result
● The ODBC connection is created under a unique name and is available for the project
configuration. See also chapter Configuring the process data exchange (Page 97).
● COMOS users can access the connection and the data source.

Note
Windows logon dialog
When the ODBC connection is established during the process data exchange of COMOS, a
logon dialog appears every time when you are not using a Windows authentication.
If the COMOS user enters the correct login credentials for the ODBC data source in this dialog
and enables the "Save credentials" option, the dialog appears only once for this user.

Generic Data Mapper

96 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.4 Administration of the OpenPlant Modeler interface

3.4.5 Configuring the process data exchange

Requirement
● You are familiar with the access to the example data. See also Example data for OpenPlant
Modeler (Page 93).
● You have access to a suitable DGN template file. This file is included in the project folder
structure of an OpenPlant Modeler installation. File and folder can typically be identified by
the "seed" part in their names.
● You have created an ODBC connection. See also chapter Setting up the ODBC connection
for OpenPlant Modeler (Page 96).
● The desired COMOS engineering project is opened.

Procedure
1. In the project properties open the category "Process engineering > Engineering Adapter >
COMOS P&ID process data export".
2. In the "ODBC data sources name of the mapping database" field select the name of your
ODBC connection from the drop-down list.
3. In the "Path for exported workpackages" field, select the directory to which the exported
workpackages are to be saved.
4. 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 exported
workpackages 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)
5. In the "Bentley seed file" field, select the corresponding DGN template file. Optional: To load
the file to the database, click the "Import" button.
6. In the "Export mapping definition" field, select the corresponding GMAD file from the
example data. Optional: To load the file to the database, click the "Import" button.
7. In the "Mapping definition for import" field in the "Import" control group, select the
corresponding GMAD file from the example data. Optional: To load the file to the database,
click the "Import" button.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 97
Exchanging process data with OpenPlant Modeler
3.5 Exporting process data

Result
● The storage location for the data export from COMOS has been defined.
● The example mapping definitions for export and import and a DGN template file are
available in the COMOS engineering project.

3.5 Exporting process data

You export process data to the OpenPlant Modeler with the "COMOS P&ID process data
export" plugin.
You create a workpackage file with one or multiple workpackages in this plugin. The
workpackage contains one or multiple P&IDs which can be exported in bundles.
Each workpackage is saved in a separate I.DGN file, which you can reference in the OpenPlant
Modeler.
The COMOS administrator must prepare and administer the export accordingly. See chapter
Administration of the OpenPlant Modeler interface (Page 93).

3.5.1 Open "COMOS P&ID process data export"

Procedure
In the COMOS menu, select the entry "CAE Apps > Bentley > COMOS P&ID process data
export".

3.5.2 Creating a workpackage file

When you open the "COMOS P&ID process data export" plugin, an empty workpackage file is
opened initially. To create a new workpackage file while working, follow these steps.

Procedure
1. Edit the opened workpackage file.
2. Click "Save workpackage file".
3. Enter a different name for the file.

3.5.3 Loading workpackage file

Requirement
You have created and saved a workpackage file.

Generic Data Mapper

98 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.5 Exporting process data

Procedure
1. Click the "Load workpackage file" button.
2. Select a workpackage file in SCD format that you have previously saved.
The workpackages of the file are displayed in the "Workpackages for pipe specs" control
group.

3.5.4 Creating workpackages

Requirement
The COMOS engineering project from which the process data is going to be exported must be
open.

Procedure
1. Click the "New workpackage" button.
A new workpackage is created. An empty detail view is displayed in the "Detail view of
workpackages" control group.
2. Use drag&drop to move one or more P&IDs from the Navigator to the detail view of the
workpackage.

3.5.5 Editing workpackages

Requirement
You have created at least one workpackage and inserted P&IDs in it.

Remove P&IDs from workpackages

1. Move your mouse over a P&ID in the "Detail view of workpackage" control group.
The buttons are displayed in the "Actions" column.
2. Click "Remove workpackage entry".

Renaming workpackages
1. Move your mouse over a workpackage in the "Workpackages" control group.
The buttons are displayed in the "Actions" column.
2. Click "Edit workpackage".
3. Enter the desired name.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 99
Exchanging process data with OpenPlant Modeler
3.6 Referencing process data in OpenPlant Modeler

Opening workpackages

1. Move your mouse over a workpackage in the "Workpackages" control group.

The buttons are displayed in the "Actions" column.
2. Click "Edit workpackage". The P&IDs contained are displayed in the "Detail view of
workpackages" control group.
Alternatively:
Double-click the workpackage in the "Workpackages" control group.

3.5.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
"Workpackages" 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
An I.DGN file is created for each exported workpackage in the directory that you have specified
in the project properties. See also chapter Configuring the process data exchange (Page 97).

3.6 Referencing process data in OpenPlant Modeler

Requirement
You have exported at least one workpackage with at least one P&ID. See also
chapter Exporting process data (Page 98).

Procedure
1. Start the OpenPlant Modeler.
2. In the "File Open" dialog select the required project in the "Project" field. When you start
OpenPlant Modeler for the first time, click the "New file" button to create a new, empty 3D-
DGN file.
3. Click "Open".
4. Set a reference from the empty 3D-DGN file to the I.DGN file that you have exported from
COMOS according to the user manual of the OpenPlant Modeler.
The COMOS data is displayed in the "Items" view in the "Active" area.

Generic Data Mapper

100 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

5. Place the objects as 3D-model according to the user manual of the OpenPlant Modeler.
6. To obtain the consistency information, open the "Consistency Checker" area in the "Items"
view.
7. Click the "2D-3D Consistency Checker Report" button. A window opens.
8. Make sure that the following options are selected:
– "Ignore properties missing in target instances"
– "Differences"
– "Missing"
– "Matches"
1. Select a storage location and file name and click the "Generate Report" button.

Result
● You can view and edit process data from COMOS in OpenPlant Modeler.
● If necessary, you can save the consistency information as XML file.

Note
Project configuration for Consistency Checker
For the Consistency Checker to process the imported data correctly, the configuration file
(*.pcf) of the required project must contain the following rows and settings in OpenPlant
Modeler:
OPM_2D3D_2D_PRIMARY_SCHEMA_NAME = OpenPlant
OPM_ALWAYS_USE_LOCAL_OP_SCHEMA = 1

3.7 Importing process data and consistency information in COMOS

After the COMOS process data is imported, it can be processed further with the OpenPlant
Modeler. For example, engineering objects can be deleted or added and attribute values can
be changed.
The transfer of 3D process data and consistency information in the form of an XML file from the
OpenPlant Modeler to COMOS is provided so that the process data in COMOS and OpenPlant
Modeler remains consistent. P&IDs in form of I.DGN files are not transferred in the process.
The 3D process data is imported over a specific user interface which provides the import
objects and functionalities for checking and editing. See also chapters User interface
description for the import (Page 92) and Checking and editing imported data (Page 102).

The COMOS administrator must prepare and administer the import accordingly. See also
chapter Administration of the OpenPlant Modeler interface (Page 93).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 101
Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

3.7.1 Importing data

Requirement
● The workflow is known. See also chapter Overview of the work sequence (Page 88).
● A Consistency Checker Report from the OpenPlant Modeler is saved in form of an XML file.
See also chapter Referencing process data in OpenPlant Modeler (Page 100).
● The COMOS engineering project from which the process data was exported must be open.

Procedure
1. Open the "CAE Apps > Bentley > COMOS P&ID process data import" plugin in COMOS.
2. Click the "Load workspace" button in the menu bar of the "OpenPlant Modeler" control
group.
Alternatively: Open the context menu in the "OpenPlant Modeler workspace" control group
and select "Load workspace".
3. Select the XML file.
4. Confirm your input.

Result
● Information on and status of the individual import steps are displayed in the "Event log"
control group.
● The 3D process data was checked initially against the current data of the COMOS
engineering project during the import and treated as follows:
– Sorting below the "Available" or "Not available" nodes in the "OpenPlant Modeler
workspace" control group.
– Display as simple listing without hierarchical structure
– Labeling with a status icon

3.7.2 Checking and editing imported data

Requirement
● 3D process data is imported.
● The objects that are represented by the 3D process data are initially sorted into one or two
folders and marked with status icons. See also chapter Importing data (Page 102).

Generic Data Mapper

102 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

Procedure
To resolve a potential inconsistency for an object, proceed as follows depending on the status
icon:

Status icon Description Procedure

Attributes are consistent and synchron‐ No action is required.
ized.
Attributes are consistent and synchron‐ Manually change the base object in COMOS.
ized. COMOS base object is inconsis‐
tent.
Objects are mapped but attributes are Update the attribute values. See also
inconsistent. chapter Editing inconsistent attribute values
(Page 104).
Objects are mapped but attributes are Update the attribute values and change the
inconsistent. COMOS base object is in‐ base object in COMOS manually.
consistent.
Object was newly created in the 3D- Create the corresponding COMOS object us‐
model and does not exist in COMOS. ing the shortcut menu of the object. See also
chapter Creating new objects (Page 105).
Information is consistent but the CO‐ Cancel the existing mapping and map the ob‐
MOS object was moved in the COMOS jects again. See also chapter Assigning ob‐
Navigator. jects (Page 105).
Object was deleted in COMOS and was Map the object once again.
newly created at the same position with
the same name.
The object was deleted in COMOS. Create the object again or map the object to a
different COMOS object.
Objects are not mapped uniquely. Map the object to the respective COMOS ob‐
There are two possible COMOS objects ject or create a new one.
for one 3D object. Possible reason: A
mapped 3D object was copied in Open‐
Plant Modeler.

Optional: To update the display of the status icons at any time, click the "Check status" button
in the menu bar. See also chapter Check status (Page 106).
Optional: When you have selected an object, also note the information in the control groups
"Attributes of object selected in workspace" and "Inconsistencies of object selected in
workspace". See also chapter User interface description for the import (Page 92).

Result
● The imported 3D process data is synchronized with the COMOS data.
● The "Not available" folder does not contain any objects.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 103
Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

3.7.3 Editing inconsistent attribute values

Requirement
● 3D process data is imported. See chapter Importing data (Page 102).
● An object is selected in the "OpenPlant Modeler workspace" control group.
● The "Attributes of object selected in the workspace" control group shows attributes and
values that differ in COMOS and OpenPlant Modeler. An explanation is visible in the
"Inconsistencies of object selected in workspace" control group.

Procedure
1. Perform one of the following steps in the "Attributes of object selected in workingspace"
control group:
– To resolve an inconsistent attribute value, click the arrow button in the corresponding
row. You always transfer the value from OpenPlant Modeler to COMOS. Once you have
executed the action, the arrow button is no longer displayed.
– To resolve multiple, inconsistent attribute values, select the corresponding rows with
<Ctrl> and mouse click, and click the "Refresh selected" button.
– To resolve all inconsistent attribute values, click the "Update all" button.

Result
● Inconsistent attribute values are resolved and synchronized.
● The status icons of the attributes have been updated.
● When all attribute values and all other information of the selected object is consistent, the
status icon of the object changes as well. See chapter Check status (Page 106).

Note
Additional inconsistencies
Inconsistencies between objects are processed by mapping or generation. See
Chapter Assigning objects (Page 105) and Creating new objects (Page 105).
In order to edit other inconsistent data manually in COMOS navigate to the respective COMOS
object. See chapter Navigating (Page 106).

Generic Data Mapper

104 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

3.7.4 Assigning objects

Requirement
● The engineering project whose data was exported beforehand is opened in the COMOS
Navigator.
● 3D process data is imported. See also chapter Importing data (Page 102).
● The "Not available" folder in the OpenPlant Modeler workspace contains objects.

Procedure
1. Open the "Not available" folder.
2. Choose an object that you want to map.
3. For this object select the desired corresponding COMOS object in the COMOS Navigator
4. Select the object in the OpenPlant Modeler workspace and from its shortcut menu select the
command "Map to selected".

Result
● The objects are mapped to each other.
● The object in the workspace has been moved into the "Available" folder.
● Status icon of the object has been updated.

Cancel mapping
To cancel a mapping, select the object in the OpenPlant Modeler workspace and from its
context menu select the command "Cancel mapping".

3.7.5 Creating new objects

Requirement
● The engineering project whose data was exported beforehand is opened in the COMOS
Navigator.
● 3D process data is imported. See also chapter Importing data (Page 102).
● The "Not available" folder in the OpenPlant Modeler workspace contains objects.

Procedure
1. Open the "Not available" folder.
2. Choose an object that you want to create in COMOS.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 105
Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

3. In the COMOS Navigator select a structuring object, for example a category folder under
which the corresponding COMOS object is to be created.
4. Select the object in the workspace and from its shortcut menu select the command "Create
below".

Result
● The new COMOS object exists at the desired position in the plant structure.
● The object in the workspace has been moved into the "Available" folder.
● Status icon of the object has been updated.

3.7.6 Check status

Requirement
● You are familiar with the user interface for the import. See chapter User interface description
for the import (Page 92).
● 3D process data is imported. See chapter Importing data (Page 102).

Procedure
To check your changes to COMOS objects and update the status icons, proceed as follows:
1. Select the "Check status" command at one of these locations in the user interface:
– As button in the menu bar of the "OPM" control group.
– In the context menu in the "OpenPlant Modeler workspace" control group.
– In the context menu of a selected object.
The first two cases check all objects; the last one only checks the selected object.

3.7.7 Navigating

Requirement
● 3D process data is imported. See chapter Importing data (Page 102).
● An object is selected in the "OpenPlant Modeler workspace" control group.

Generic Data Mapper

106 Operating Manual, 06/2019 V10.3.2
 Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

Procedure
1. Open the context menu of the object.
– To navigate to the P&ID object in the Navigator, select "Navigate to COMOS".
– To open the P&ID and navigate to the placed P&ID object, select "Navigate to COMOS
P&ID", and then select the P&ID offered in the submenu.

Note
Navigating in case of information that is not unique
● The "Navigate" commands cannot be executed for an object that is unknown in COMOS.
● "Navigate to COMOS P&ID" cannot be executed for an object that is not placed in a R&I.
● For an object that cannot be clearly mapped to a COMOS object or P&ID, the possible
navigation targets are offered for selection in the submenu of the "Navigate" commands.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 107
Exchanging process data with OpenPlant Modeler
3.7 Importing process data and consistency information in COMOS

Generic Data Mapper

108 Operating Manual, 06/2019 V10.3.2
Export process data to PlantWise 4
You can export process data from COMOS and make it available for import to PlantWise.
In doing so, you transfer the following information:
● PFDs with the placed PFD objects
● Selected object properties of the placed PFD objects
The exported information is saved in form of XML files in a directory structure on a drive.
You export process data from COMOS with the "COMOS FEED process data export" plugin.
In this plugin, you specify the PFDs that are to be exported. You have previously created the
mapping definition required for this purpose in the Generic Data Mapperor have copied it from
the included example data.
You can find basic information on working with the Generic Data Mapper in the chapter Using
the Generic Data Mapper (Page 9).
Because the basic procedure for export to PlantWise and OpenPlant Modeler is very similar,
you can also use the information in chapter Exchanging process data with OpenPlant Modeler
(Page 87).

4.1 Overview of the workflow

The following graphic shows the schematic workflow.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 109
Export process data to PlantWise
4.1 Overview of the workflow

&2026 3ODQW:LVH

*HQHULF'DWD0DSSHU

,PSRUW3ODQW:LVHVFKHPDLQWR 3URYLGH3ODQW:LVHVFKHPD
WKH3URYLGHU ILOHVIRU&2026

&UHDWHRUHGLWPDSSLQJ
GHILQLWLRQIRUH[SRUW

&RQILJXUHSURMHFWSURSHUWLHV

%HQWOH\SURFHVVGDWDH[SRUW

&UHDWHZRUNSDFNDJHDQGDGG
3)'V

([SRUWZRUNSDFNDJH

;0/

Procedure
1. As COMOS administrator, import the schema files and create a mapping definition for
export with the "Generic Data Mapper" plugin. Alternatively: Use the included example data
which you can expand, if necessary.
2. When you work with the "COMOS FEED process data export" plugin for the first time,
configure the project properties accordingly. See also chapter Configuring PlantWise
process data export (Page 111).
3. Create workpackages with PFDs that you want to export in the "COMOS FEED process
data export" plugin. See also chapter Creating workpackages (Page 113).
4. Export the COMOS data. See also chapter Exporting workpackages (Page 113).

Generic Data Mapper

110 Operating Manual, 06/2019 V10.3.2
 Export process data to PlantWise
4.2 Administration of the PlantWise interface

4.2 Administration of the PlantWise interface

4.2.1 Example data for PlantWise

Siemens provides you with example data for the PlantWise interface which includes mapping
definitions and diagrams.

Procedure
1. Save the GMAD file for the PlantWise interface at a location to which you have access.
For the basic procedure and notes, see chapter Example data for OpenPlant Modeler
(Page 93).
2. Optional: If necessary, expand the mapping definition in the Generic Data Mapper to meet
your requirements.
For the basic procedure and notes, see chapters Exchanging process data with OpenPlant
Modeler (Page 87) and Editing an example mapping definition (Page 95).

4.2.2 Configuring PlantWise process data export

Requirement
● You are familiar with the general access to the example data for PlantWise and OpenPlant
Modeler. See also chapter Example data for OpenPlant Modeler (Page 93).
● You have access to the GMAD file for PlantWise. See also chapter Example data for
PlantWise (Page 111).
● The desired COMOS engineering project is opened.

Procedure
1. Open the "Process engineering > Engineering adapter > Bentley PlantWise data exchange"
category in the project options.
2. In the "Path for exported workpackages" field, select the directory to which the exported
workpackages are to be saved.
3. Optional: In the "Pattern for folder names of exported workpackages" field, change the
specification of the pattern by which the folders are named. See also chapter Configuring
the process data exchange (Page 97).
4. In the "Mapping definition for export" field, select the GMAD file and click the "Import" button.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 111
Export process data to PlantWise
4.3 Exporting process data

Result
● The storage location for the export data from COMOS has been defined.
● The example mapping definition for the export is available in the COMOS engineering
project.

4.3 Exporting process data

You export process data to PlantWise with the "COMOS FEED process data export" plugin.
You create a workpackage file with one or multiple workpackages in this plugin. A workpackage
contains one or multiple PFDs which can be exported in bundles.
Each workpackage is saved in form of XML files in a directory structure that can be accessed
by PlantWise.
The COMOS administrator must prepare and administer the export accordingly. See chapter
Administration of the PlantWise interface (Page 111).

4.3.1 Matching connector objects

COMOS distinguishes between connectors of PFD objects as "Input" and "Output" without any
additional subdivision. A PFD object, such as a column, can have multiple inputs and outputs.
Connectors in PlantWise are specifically distinguished by their functions and labeled
accordingly. In the delivery state of COMOS, the connectors of both systems are only
categorized as "Input" and "Output" and they are matched.
To match the connectors in COMOS and PlantWise for an application more specifically,
proceed as follows.

Procedure
1. In the COMOS engineering project, change to the desired PFD object whose connectors
you want to edit.
2. Open the properties of the desired connector and click the "Advanced/Extended" button.
3. In the "Extended attributes" window, select the desired PlantWise name in the "Value"
column. This name originates in the standard table that is listed in the column of the same
name. If necessary, a COMOS administrator can expand this standard table.
4. Confirm your entry.

Generic Data Mapper

112 Operating Manual, 06/2019 V10.3.2
 Export process data to PlantWise
4.3 Exporting process data

4.3.2 Creating workpackages

Requirement
● You are familiar with the basic handling of workpackage files and workpackages. See
chapter Exchanging process data with OpenPlant Modeler (Page 87), keyword "Exporting
process data".
● The COMOS engineering project from which the process data is going to be exported must
be open.

Procedure
1. In the COMOS menu, select the entry "Plugins > 3D Engineering Adapter > Bentley >
COMOS FEED process data export".
2. Click the "New workpackage" button. A new workpackage is created. An empty detail view
is displayed in the "Detail view of workpackages" control group.
3. Use drag&drop to move one or more PFDs from the Navigator to the detail view of the
workpackage.
4. Move your mouse over the workpackage in the "Workpackages" control group. The buttons
are displayed in the "Actions" column. Click "Edit workpackages".
Alternatively: Double-click the workpackage.
5. Enter a name for the workpackage.
6. Click the "Save workpackage file" button.
7. Enter a file name and save the SCD file on your drive.

Result
● The scope of the export is defined in form of a workpackage which contains the desired
PFDs.
● The workpackage is saved as file.

4.3.3 Exporting workpackages

Requirement
● A workpackage file (format: SCD) is saved on your drive.
● The "COMOS FEED process data export" plugin is open.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 113
Export process data to PlantWise
4.3 Exporting process data

Procedure
1. Click the "Load workpackage file" button.
2. Select the SCD file you have created beforehand.
3. To display the PFDs in the "Detail view of workpackages" control group, double-click the
respective workpackages.
4. Execute one of these steps:
– "Workpackages" control group: To export all workpackages of the workpackage file, click
"Export all workpackages".
– "Workpackages" control group: To export an individual workpackage, place your mouse
on the workpackage. The buttons are displayed in the "Actions" column. Click "Export
workpackage".
– "Detail view of workpackages" control group: To export only open workpackages, click
"Export opened workpackages".

Result
● Each exported workpackage is saved in form of XML files in a defined directory structure.
● An "FSR" folder exists for each exported PFD in the directory structure; it is required as
source for the import in PlantWise.

Generic Data Mapper

114 Operating Manual, 06/2019 V10.3.2
Data Transfer with ProjectWise 5
5.1 Linking COMOS OPM import with Bentley ProjectWise environment
The purpose of this function is to save exported OpenPlant working areas in the ProjectWise
Document Management System (DMS) from Bentley.

Requirements
● The COMOS administrator has configured the connection to ProjectWise, including the data
source and path of the DMS base directory to be used for the export.
● An OPM export working area has been created.
● ProjectWise is installed on the user's local computer.
● ProjectWise Server has been configured in the "Network Configuration Settings" of the
ProjectWise Explorer.

Sequence
1. Initiate the export to OPM in working area.
2. Enter the login information to access the mapping database (if not saved).
3. Enter the login information to access the pre-configured ProjectWise data source.
4. In addition to the usual checks, the system checks whether the connection to the project-
related server is possible.
5. The system creates the i.dgn iModel, which is exported as usual.
6. The system logs into the pre-configured ProjectWise data source with the login information
of the user.
7. The system lets ProjectWise create a new folder under the pre-configured root directory
path. The folder is named according to the pattern defined in the project options (as usual).
8. The system lets ProjectWise create each i.dgn file of the working area and upload it to the
folder.
9. The system logs out of ProjectWise.

5.2 Linking COMOS OPM export to the Bentley ProjectWise environment

The goal is to load an iModel i.dgn file exported from OpenPlant from the ProjectWise
Document Management System (DMS) from Bentley.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 115
Data Transfer with ProjectWise
5.3 Data transfer with ProjectWise

Requirements
● The COMOS administrator has configured the connection to ProjectWise, including the data
source and standard DMS directory to be used for the import.
● An iModel file has been exported from OPM and uploaded to ProjectWise.
● ProjectWise is installed on the user's local computer.
● ProjectWise Server has been configured in the "Network Configuration Settings" of the
ProjectWise Explorer.

Sequence
1. Loading a working area from ProjectWise
2. The user enters the login information to access the mapping database (if not saved).
3. The user enters the login information to access the pre-configured ProjectWise data source.
4. In addition to the usual checks, the system checks whether the connection to the project-
related server is possible.
5. The system shows a dialog with the available documents in ProjectWise. The standard
directory is selected as the default.
6. The user selects the iModel document to be loaded.
7. The system lets ProjectWise download the selected document.
8. The system creates the working area view as usual and displays it.
9. The system logs out of ProjectWise.

5.3 Data transfer with ProjectWise

Tested under ProjectWise version 10.00.01.67

Requirement
ProjectWise server configuration. In ProjectWise, open "Network Configuration Settings" and
set up your data source.

Procedure for exporting from COMOS

1. Configure COMOS export. In the project options, open "Process Engineering > Engineering
Adapter > Bentley OpenPlant Modeler data exchange".
2. Define the ProjectWise export folder under "Data Sink".
3. Open the plugin for export from COMOS "Plugins > CAE Apps > Bentley > COMOS P&ID
process data export".
4. Log on to the ProjectWise data source.
5. Export the data. The status is displayed in the log.
6. An *.i.dgn file is created in ProjectWise.

Generic Data Mapper

116 Operating Manual, 06/2019 V10.3.2
 Data Transfer with ProjectWise
5.3 Data transfer with ProjectWise

Procedure for importing from ProjectWise

1. Configure COMOS import. In the project options, open "Process Engineering > Engineering
Adapter > Bentley OpenPlant Modeler data exchange".
2. Define the ProjectWise data source under "Import".
3. Open the plugin for export with COMOS "Plugins > CAE Apps > Bentley > COMOS P&ID
process data import".
4. If the data source and folder are specified in the configuration, this data source is mandatory
for the import but the folder in it can be selected. Or the data source is generally defined in
the ProjectWise Explorer "Network Configuration Settings" for COMOS imports.
5. Select the file you want to import and perform the import.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 117
Data Transfer with ProjectWise
5.3 Data transfer with ProjectWise

Generic Data Mapper

118 Operating Manual, 06/2019 V10.3.2
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.
The basic work with the Generic Data Mapper is described at the following location in the
manual. You can find additional information on this topic in the "Generic Data Mapper (Page 9)"
manual.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 119
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.

Generic Data Mapper

120 Operating Manual, 06/2019 V10.3.2
 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 120).

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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 121
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 122).
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 123).

6.2.3 Integrating the schema in the Generic Data Mapper

Procedure
1. Open the Generic Data Mapper. See also chapter Open Generic Data Mapper (Page 14).
2. Create a new mapping definition or load an existing one.
See also chapter Mapping definitions (Page 15).
3. If you have created a new mapping definition, select the following as the schema provider:
"ECXMLSchemaProvider". See also chapter Selecting a schema provider (Page 16).
4. Configure the source provider and target provider. See also chapter Configuring a schema
provider (Page 17).

Result
The schema is mapped in the "Target schema" control group on the "Classes" tab.

Generic Data Mapper

122 Operating Manual, 06/2019 V10.3.2
 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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 123
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 129).
The following section provides a description of the structure of structure mapping definitions
based on the structure mapping definition "Tee mapp".

Requirement
● You understand the special features that relate to mapping the PDMS schema in Generic
Data Mapper. See also chapter Special features of the PDMS schema (Page 123)
● You have opened the example mapping definition and selected the structure mapping
definition "Tee mapp".
See also chapter Working with structure mapping definitions (Page 27).

Generic Data Mapper

124 Operating Manual, 06/2019 V10.3.2
 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 129).

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.
See also chapter Labeling identical objects (Page 72).
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 and Example: SystemUID + #ID_1 SystemUID+#ID_1
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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 125
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. See also chapter Labeling identical
objects (Page 72).
● "TANS": You can find this target attribute at selectors. The value assigned to this attribute
determines 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"
pattern "#ID_<coun‐ attribute 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.

Generic Data Mapper

126 Operating Manual, 06/2019 V10.3.2
 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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 127
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
SystemUID.
● Question for next selector: The question for identification of the selector is entered manually in the
"InitialValue" 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
"InitialValue" 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
"InitialValue" 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
"InitialValue" 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.

Generic Data Mapper

128 Operating Manual, 06/2019 V10.3.2
 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 124).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 129
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. See also chapter Identical target objects that are independent of a COMOS
object (Page 74).
● 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 124).
Both structure elements are based on the same schema element.

Generic Data Mapper

130 Operating Manual, 06/2019 V10.3.2
 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 Labeling identical objects (Page 72).
● See also chapter Content and structure of the example mapping definition "Tee mapp"
(Page 124).

1. Open a structure mapping definition.

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.
See also chapters Preparing structures (Page 22) and Mapping structure components
(Page 45).

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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 131
Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

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.
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.

Generic Data Mapper

132 Operating Manual, 06/2019 V10.3.2
 Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

6.3.1 Opening "PDMS pipe spec export"

Procedure
In the COMOS menu, select the entry "Plugins > CAE Apps > Aveva > PDMS pipe spec export".

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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 133
Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

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".

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 132).
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 137).

Generic Data Mapper

134 Operating Manual, 06/2019 V10.3.2
 Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

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 132).

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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 135
Exporting COMOS pipe specs to PDMS
6.3 Exporting pipe specs

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

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."

Generic Data Mapper

136 Operating Manual, 06/2019 V10.3.2
 Exporting COMOS pipe specs to PDMS
6.4 Importing COMOS pipe specs to PDMS specs

6.4 Importing COMOS pipe specs to PDMS specs

Requirement
You have exported pipe specs from COMOS. See also chapter Exporting workpackages
(Page 134).

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.
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.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 137
Exporting COMOS pipe specs to PDMS
6.4 Importing COMOS pipe specs to PDMS specs

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.

Generic Data Mapper

138 Operating Manual, 06/2019 V10.3.2
Importing eCl@ss information 7
7.1 Introduction

eCl@ss
eCl@ss is an industry-wide standard for the classification of products with the goal of
simplifying the electronic trading of classified products. eCl@ss maps a hierarchical system
that classifies products.
In COMOS, you can store catalogs classified according to eCl@ss in BMEcat format and model
the mapping of the eCl@ss data model to the COMOS data model with the "Generic Data
Mapper" plugin. You can find additional information on this topic in the "Generic Data Mapper
and eCl@ss" manual, keyword "Generic Data Mapper (Page 9)".

Note
General eCl@ss terms of use
The use of the eCl@ss standard is under license and requires registration and an order in the
DownloadPortal (www.eclassdownload.com).

Product workflow
COMOS supports you in the neutral specification of the requirement data. This means you can
make a suitable product selection later in the workflow.

Requirements for use of eCl@ss

● You have downloaded the required eCl@ss data sources from eCl@ss.
● You have basic expertise in the use of the "Generic Data Mapper" plugin.
● You have configured the required settings in the project properties in the "General settings
> eCl@ss mapping" category. See also chapter Setting project properties (Page 140).

Supported data sources

COMOS supports classified products of the BMEcat 2005.1 catalog according to the eCl@ss
9.0 Advanced standard.
COMOS supports the following parts of the data model:
● Commercial characteristics
● Additional documentation (files, e.g. data sheets)
● Mechanical constructions

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 139
Importing eCl@ss information
7.2 Administering eCl@ss

● Parts of the functional structures

● Technical characteristics

Exceptions
You can import eCl@ss data into COMOS, but the data cannot be exported.

7.2 Administering eCl@ss

7.2.1 Setting project properties

Requirement
You have downloaded the corresponding XML files for ontologies (eCl@ss OntoML) and units
(eCl@ss UnitsML) from eCl@ss:
● Example XML file for ontologies: "eClass9_0_ADVANCED_DE_SG_27.xml"
● Example XML file for units: "eClass9_0_UnitsML_EN_DE.xml"

Procedure
1. Open the project properties.
2. Select the "General settings > Product data mapping" category
3. To store the eCl@ss ontologies, click the "..." button next to the "File path to OntoML" field
and select the file. See chapter Project properties (Page 141).
4. To import the eCl@ss ontologies, click the "Import" button next to the "File path to OntoML"
field.
5. To store the eCl@ss units, click the "..." button next to the "File path to UnitsML" field and
select the file. See chapter Project properties (Page 141).
6. To import the eCl@ss units, click the "Import" button next to the "File path to UnitsML" field.
Note
Export not possible
The export of eCl@ss data from COMOS is not necessary and therefore not included.

7. Confirm your entries.

Result
The settings apply to all users of the project.

Generic Data Mapper

140 Operating Manual, 06/2019 V10.3.2
 Importing eCl@ss information
7.2 Administering eCl@ss

7.2.2 Project properties

"General settings > Product data mapping" category:

Field Description
"File path of the mapping definition file" You can store and import a definition file in this field. An ex‐
ample file is supplied with COMOS. You can find the file in the
following folder in the COMOS installation directory:
"config/MappingFiles/eCl@ss"
You can edit the example file or create your own definition file.
The definition file has the COMOS-specific format GMAD.
"File path to the OntoML" In this field, you store and import the eCl@ss ontologies
("eCl@ss OntoML"). Download the XML files from eCl@ss.
Example: The dictionary file "eClass9_0_AD‐
VANCED_DE_SG_27" contains the automation technology in
German.
Files in other languages are also supported.
Once you have stored the XML file in this field, the "Import"
button becomes active.
"File path to the UnitsML" In this field, you store and import the eCl@ss units ("eCl@ss
UnitsML"). Download the XML file from eCl@ss.
Once you have stored the XML file in this field, the "Import"
button becomes active.
"Folder for additional documentation" If you want to import additional documents, this is where you
determine the storage location. Drag&drop a document group
to this field.
The imported documents must be based on the following
base object:
"@30 > M00 > A90 > A10 > A10 Document groups according
to IEC 61355"
Once you have imported a device from the catalog, the addi‐
tional documents are stored in the document group entered
here. See also chapter Additional documents (Page 149).

7.2.3 Storing available catalogs

You can assign catalogs to other users. For a catalog to be displayed in the "Look up
manufacturer device for <device name>" window, add the catalog for each base project.

Procedure
1. Open the base project.
2. Open the properties of a device base object.
3. Select the "Attributes > Order data" tab.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 141
Importing eCl@ss information
7.2 Administering eCl@ss

4. Drag&drop the required catalog to the "Available catalogs" control group in the "Attributes
> Order data" tab.
Examples are available in the node "@30 > M00 > A90 > A10 > A10 Document groups
according to IEC 61355".
5. Confirm your entries.

Result
In the engineering project in the device properties, the eCl@ss catalog is displayed in the
"Available catalogs" control group of the "Attributes > Order data" tab. The catalog is listed with
its description in the "Look up manufacturer device for <device name>". See also
chapter Calling the eCl@ss catalog (Page 146).

Note
Displaying the description
For the stored catalogs to be displayed with their description, make sure that the "Name of the
link object" option is selected in the "Attribute display" window. You can find more information
on this topic in the "COMOS Platform Administration" manual, keyword "Control attribute
display".

Recommendation
To ensure better performance, define the catalogs and the corresponding rules in such a way
that there is a maximum of 50 devices to be compared to one another.

7.2.4 Availability of additional documents

Additional imported documents

The additionally imported documents must be based on the following base object:
"@30 > M00 > A90 > A10 > A10 Document groups according to IEC 61355"
Store the documents together with the catalog either in the base project or by using the file
system. When you store documents in the base project, structure the documents as specified
in the catalog. See also chapter Storing available catalogs (Page 141).

Example
If there is a subfolder with the name "SubFolder", create a document with this name in COMOS
in addition to the XML file. The document can be of the type "Undefined document".
Copy the documents to this file.

Generic Data Mapper

142 Operating Manual, 06/2019 V10.3.2
 Importing eCl@ss information
7.2 Administering eCl@ss

7.2.5 Languages

Language dependency of the ontologies

The ontology and the catalogs are available in different languages. You can create the mapping
definition based on the different languages. In doing so, you can configure the system so that
you are supported in your native language.

Transferring language-dependent values to characteristics

When you create a catalog, you can transfer language-dependent values to the characteristics.
These are configured as follows:
The eCl@ss catalogs can contain values in different languages. COMOS attributes are
monolingual. If you want to transfer values with different languages, assign a COMOS text
attribute and "InternationalValue" as sub-attribute to the eCl@ss attributes in the "Generic Data
Mapper" plugin.
The setting is visible, for example, in the document properties in the "Language" field in the
"Attributes > Text field" tab in the "Text field" control group.
When you change the language in the project properties, the display of the document attributes
changes.
See also chapter Setting language conversion (Page 67).

Note
"InternationalValue" value
The value "InternationalValue" is only available for attributes that include text. You cannot set
this value for alphanumeric attributes.

7.2.6 Creating mappings

7.2.6.1 Creating an eCl@ss mapping

Requirement
● The project properties are configured for the use of eCl@ss. See chapter Setting project
properties (Page 140).
● You have experience using the "Generic Data Mapper" plugin. You can find additional
information on this topic in the "Generic Data Mapper and eCl@ss" manual, keyword
"Generic Data Mapper (Page 9)".

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 143
Importing eCl@ss information
7.2 Administering eCl@ss

Procedure
1. Call the "Generic Data Mapper" plugin. You can find additional information on this topic in
the "Generic Data Mapper and eCl@ss" manual, keyword "Generic Data Mapper (Page 9)".
2. Select the entry "eClassSchemaProvider" from the "Source schema provider" list in the
"Schema provider" control group. See also chapter Schema provider (Page 16).
3. Select the entry "ComosSchemaProvider" from the "Target schema provider" list, see also
chapter Selecting a schema provider (Page 16).
The content of the eClass OntoML file that you have stored in the project properties is
displayed in the "Classes" tab in the "Schema > Source schema" control group. See
section Project properties (Page 141).
Example: The "eClass9_0_ADVANCED_DE_SG_27.xml" file is stored in the project
properties. The entry "{de-DE "27000000"}" is displayed in the "Classes" tab.

4. Structure mapping: You can create your own structure mapping definition and specify the
relationship that a structure element has to its parent element. See section Working with
structure mapping definitions (Page 27) and section Modifying structures (Page 35).
Cardinality and polymorphism: The cardinality indicates how often an element can occur in
the given relation. You set the cardinality in the "Structure mapping" tab in the "Mapping"
control group. See chapter Setting the cardinality (Page 36).
If you set polymorphism for a schema block, the specified schema block and all child
elements of the schema block within the schema are considered a valid basis for an object.
You set the polymorphism in the "Structure mapping" tab in the "Mapping" control group.
See chapter Setting polymorphism (Page 42).
5. Map the structure-specific attributes. See chapter Structure-specific attributes (Page 56).
6. Create global attributes in the "Global attribute mapping" tab.
Globally mapped attributes are executed in addition to the structure-specific attribute
mappings. Global attributes are independent of structures and are defined at schema
blocks. See chapter Global attributes (Page 84).
7. To limit the objects for which structure mapping is to become effective, create attribute-
based conditions. See chapter Creating attribute-based conditions (Page 43).

Result
The mapping of eCl@ss elements to the COMOS object is displayed in the "Mapping" control
group. You can now edit the structure element association. See chapter Editing structure
element associations (Page 65).

See also
Open Generic Data Mapper (Page 14)
Mapping structure components (Page 45)

Generic Data Mapper

144 Operating Manual, 06/2019 V10.3.2
 Importing eCl@ss information
7.2 Administering eCl@ss

7.2.6.2 Assigning connectors

When using design representations it can make sense to also see connectors and their
connector information.
Example: The identification of a connector at the device is also to be mapped to design
representations in order to identify the connector more easily.
For this purpose, connectors of devices from the eCl@ss catalogs have to be imported to
COMOS. To transfer device connectors, assign the connectors in the Generic Data Mapper to
each other.
On the COMOS side, you have the following possibilities for using connectors in structures:
● Using a general connector object for creating all connectors
● Using specific connectors for input and output

Requirement
You have created a structure mapping definition with devices whose connectors are to be
transferred to COMOS.

Procedure
1. Place a general connector or specific connectors under a device on the COMOS side.
– See also chapter Assigning a general connector (Page 81).
– See also chapter Assigning specific connectors of a COMOS object (Page 80).
2. In order to transfer the identifier of an eCl@ss connector to a COMOS connector, map the
corresponding attributes of the connectors to each other.
See also chapter Mapping attributes within structures (Page 56).
3. Optionally, you can have the names of the connectors supplemented by a counter during
the generation in COMOS. See also chapter Creating an initial value with automatic counter
(Page 61).
4. To use the COMOS symbols, the predefined COMOS connectors at the base object are
used.

Result
The device connectors are imported during an import from eCl@ss catalogs.
If the device requirement already has connectors, the values are transferred from the device
catalog to these connectors.
If more connectors exist in the device catalog than are specified in the device requirement,
these are added.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 145
Importing eCl@ss information
7.3 Using eCl@ss in engineering

7.2.6.3 Converting units

Requirement
The eCl@ss specification is not the same as for the units of the COMOS objects.

Procedure
1. Select the "Structure element associations" tab.
2. Click the button in the "Conversion" column.

3. Select the entry "Unit conversion".

4. Proceed in the same way as described above. See chapter Setting the unit conversion
(Page 65).

7.3 Using eCl@ss in engineering

7.3.1 Calling the eCl@ss catalog

Requirement
● The project properties for the use of eCl@ss are set. See chapter Setting project properties
(Page 140).
● The mappings of eCl@ss elements to COMOS objects were created. See chapter Creating
mappings (Page 143).

Generic Data Mapper

146 Operating Manual, 06/2019 V10.3.2
 Importing eCl@ss information
7.3 Using eCl@ss in engineering

Procedure
1. Create a device request in the Navigator.
2. Open the properties of the device request.
3. On the "General" tab, click the "..." button next to the "Base object" field.
The "Look up manufacturer device for <device name>" window is displayed. If an eCl@ss
catalog has already been mapped, it is displayed in the bottom part of the "Search
manufacturer devices for <device name>" window.
Select one of the following options:
– Click the "Load eCl@ss catalog" button.
If the XML files were not stored in the project properties, you are prompted to select the
missing files. These can be the following files: UnitsML, OntoML and GMAD
See also chapter Project properties (Page 141).
– Select the mapped eCl@ss catalog in the bottom part of the "Search manufacturer
devices for <device name>" window.

Result
The "eCl@ss catalog" window is displayed. The found products are displayed in the top part of
the window.

7.3.2 Select product

Procedure
1. Call the eCl@ss catalog for a device. See also chapter Calling the eCl@ss catalog
(Page 146).
The products are listed with the following information in the top part of the "eCl@ss catalog"
window:
– Manufacturer
– Description
– Article number
2. Select different products in the top part of the "eCl@ss catalog" window.

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 147
Importing eCl@ss information
7.3 Using eCl@ss in engineering

3. Select one of the following options:

– Select the "Only consider product relevant differences" option to display product-related
differences. You can find more information on this topic in the "COMOS EI&C
Administration" manual, keyword "Control display of product-related attributes".
– Select the "Consider all differences" option to display all differences.
A list with product details is displayed in the bottom part of the "eCl@ss catalog" window. A
selected product is listed for each column. The list shows all attributes with the following
criteria:
– The value in the "Requirements" column is not empty.
– The imported value is not empty because a mapping took place. See also
chapter Creating mappings (Page 143).
– The attribute is relevant to the product.
Differences between the products are marked in red.
4. Click the "Apply and close" button in the column of the product that you want to select.
5. Click on the "OK" button to confirm your entries.

Result
The catalog data is imported for the COMOS object. The "Look up manufacturer device for
<device name>" window is closed. The values of the attributes of the COMOS object now have
the values of the device that you have called in the "eCl@ss catalog" window.
The object status is set from request to manufacturer device, regardless of the base object
status.
In the object properties, the "Attributes > Technical data" is filled with the data of the selected
product. The attributes are locked so that the data of the eCl@ss entry cannot be changed. You
can find more information on this topic in the "COMOS Platform Administration" manual,
keyword "Function right: Lock object".
Elements, such as contacts, are imported as well. When a product has an element with a name
that already exists for the requirement object, this element is combined recursively.
Additional documents are copied to the storage location that was specified in the project
properties. See chapter Project properties (Page 141). The device has a reference to the
additional document.

7.3.3 Reset device data

Requirement
You have selected a product. See section Select product (Page 147).

Generic Data Mapper

148 Operating Manual, 06/2019 V10.3.2
 Importing eCl@ss information
7.3 Using eCl@ss in engineering

Procedure
1. Open the object properties.
2. Click the button on the toolbar.

Result
The data is reset to the requirement data that existed before the device selection. You can find
additional information on this topic in the "COMOS Platform Operation" manual, keyword
"Toolbar for engineering objects".
Manual expansions that are not found in the catalog are retained. You can delete them, if
necessary.
The requirement object is once again marked with an orange triangle in the Navigator.

Example of a requirement object symbol in the Navigator

You can find additional information on this topic in the "Operation" manual, keyword "Reference
of the object icons".

7.3.4 Creating product data

Procedure
1. Open the properties of the requirement object.
2. Click the following button:

3. In the window "Class 'Device': extended functions", click "Yes".

Result
Product data is created from the requirement object.
You can find additional information on this topic in the "Operation" manual, keyword "Toolbar
for engineering objects".

7.3.5 Additional documents

Requirement
The catalog includes documents. See sections Storing available catalogs (Page 141)
and Availability of additional documents (Page 142).

Generic Data Mapper

Operating Manual, 06/2019 V10.3.2 149
Importing eCl@ss information
7.3 Using eCl@ss in engineering

Behavior of documents
Once you have imported a device from the catalog, the additional documents are stored in the
document group entered in the project properties. See also chapter Select product (Page 147).
The imported device includes a reference to the documents. When you move or rename the
original document, the reference remains intact. When you delete the original document, the
reference to the document is also deleted.
When the catalog with the documents is deleted, the device keeps the reference to the copy of
the documents. Additional metadata, such as the document type, is also retained in the
document copy.

Generic Data Mapper

150 Operating Manual, 06/2019 V10.3.2