SmartPlant Enterprise

SmartPlant Adapter for SmartPlant 3D

Version 2009 R4

August 2012

DSPF1-PE-200082D
Copyright
Copyright © 2009-2012 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret
law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph
Corporation.
U.S. Government Restricted Rights Legend
Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the
licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license
for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this
software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee
permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and
delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or
redistribution.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or
its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in
this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms
of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS
TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Contents
Preface .......................................................................................................................................................... 5

Architecture ................................................................................................................................................. 7
Publish Adapter ....................................................................................................................................... 7
Retrieve Adapter ..................................................................................................................................... 7
Metadata Adapter ................................................................................................................................... 7

SmartPlant 3D Publish-Retrieve Relationships ........................................................................................ 9

Publish Document Types ........................................................................................................................ 9
Publish Document Type Configuration ................................................................................................... 9
Publish .................................................................................................................................................... 9
Support for Handling Large Publishes............................................................................................ 10
Limitations ............................................................................................................................................. 11
Retrieve Document Types .................................................................................................................... 11
Retrieve Document Type Configuration ................................................................................................ 11
Retrieve ................................................................................................................................................. 11

Data Transformation Logic ....................................................................................................................... 13

Publish .................................................................................................................................................. 13
Classes ........................................................................................................................................... 15
Properties ....................................................................................................................................... 16
Map Edges ..................................................................................................................................... 17
Enums............................................................................................................................................. 18
UOMS ............................................................................................................................................. 19
Retrieve ................................................................................................................................................. 19
Classes ........................................................................................................................................... 20
Properties ....................................................................................................................................... 20
Enums............................................................................................................................................. 21
UOMS ............................................................................................................................................. 22
Correlate ............................................................................................................................................... 22
Classes ........................................................................................................................................... 22
Properties ....................................................................................................................................... 23
Map Edges ..................................................................................................................................... 24
Enums............................................................................................................................................. 24
UOMS ............................................................................................................................................. 24

UID Construction ....................................................................................................................................... 25

Metadata Adapter ...................................................................................................................................... 27

Configuration ......................................................................................................................................... 27
Synchronizing the Tool Map File........................................................................................................... 27
Metadata Adapter Modes ...................................................................................................................... 28
Limitations ............................................................................................................................................. 28

SmartPlant 3D Mapping Examples .......................................................................................................... 29

SmartPlant 3D and SmartMarine 3D Mapping Examples .................................................................... 29

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 3

Contents

Example: Mapping for Retrieve ...................................................................................................... 29

Example: Mapping for Publish ........................................................................................................ 47

Index ........................................................................................................................................................... 53

4 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

Preface
This document describes details, functionality, and configuration of the SmartPlant Adapter for
SmartPlant 3D.
Send documentation comments or suggestions to PPMdoc@intergraph.com.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 5

SECTION 1

Architecture
The following interfaces are supported.

Publish Adapter
IEFAdapter, IEFAdapter3, IEFAdapter7, IEFAdapter8

Retrieve Adapter
IEFAdapter, IEFAdapter2, IEFAdapter8

Metadata Adapter
IInstructionsListener, IMetadataAdapter, IMetadataAdapterGUI, ITransaction,
IMetadataAdapterGUI2

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 7

SECTION 2

SmartPlant 3D Publish-Retrieve
Relationships

Publish Document Types

 3D Model data
 Isometric
 Orthographic
 Reports

Publish Document Type Configuration

The Discipline property on the drawing sheet must be set prior to revising the document. This
property is on the Properties dialog box for a drawing sheet in Drawings and Reports task. The
select list for this property shows all the document types in the schema for the 3D Documents
document category.

Publish
All publishes in SmartPlant 3D are performed from the Drawings and Reports task. Drawing types
that the SmartPlant 3D Publish adapter supports are: Isometric, Orthographic, Reports, and 3D
Model data. Documents can be published either "in process" or "out of process" using the Publish
Now or Background Publish options on the Publish dialog box. All documents should be
revised and updated before being published to SmartPlant Foundation. Documents can now be
updated and published in one step using the Publish > UpdatePublish command.
A workflow is now available to make publishing large 3D models more efficient. You can publish
these object sets using a workflow based on the AutoLoadPublishWithMerge workflow. This
workflow has MergePublishedFile process step configured, which creates the published 3D
document, loads the 3D data in SmartPlant Foundation, then merges these object sets into a new
composite document that represents the entire 3D model. The name of the composite document
created is the same as the name of the workflow, for example, AutoLoadPublishWithMerge, to
which the published 3D model is submitted. To publish to different 3D model composite
documents, you can copy the AutoLoadPublishWithMerge workflow to a different document
name.
Using SmartPlant Foundation, you can configure the workflow with additional steps, to be used by
specific users, and to be the default publish workflow for 3D users. In SmartPlant Foundation
2007, workflow administration functions are performed in the Change Management
Administration. In SmartPlant Foundation 2008 and higher, all administrative functions are
performed in the Desktop Client.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 9

SmartPlant 3D Publish-Retrieve Relationships

Support for Handling Large Publishes

The number of objects published from SmartPlant 3D can become so large that the normal update
and publish processing uses up the resources such as memory and address space on the client
and server computers. To address these resource issues, SmartPlant 3D now supports the
concept of using a cache to keep track of objects that have changed and to only publish these
objects. Thus, the software avoids processing objects that have not changed. The mechanisms
for doing this are called delta update, delta publish, and auto-scoping. These processes are not
visible to the user.
 Delta update - Updates only the objects that are modified, deleted, or moved and then
process these. Because only changes are updated, you can produce larger XML and graphics
files without prior address space limitations.
 Delta publish - Leverages the cached information provided by delta update to determine
which objects need to be published. Because only changes are published, you can produce
larger files in the data warehouse.
Since the complete set of objects will not be published each time, it is up to SmartPlant 3D to
keep track of deleted and moved objects. These moved or deleted objects will be sent with the
published objects, eliminating the need to probe the adapter for the existence of missing
objects.
When you publish a 3D model, you must now enable the Scheduler and Loader
in SmartPlant Foundation to make the 3D model data document retrievable. The load,
consolidate, and merge tasks must complete successfully before the 3D model document can
be retrieved.
Both delta update and delta publish can publish larger documents by automatically splitting the
data into smaller sections in SmartPlant 3D. If your publish data is split into smaller sections, the
document version number increments for each section.
For example, if you publish a document that is split into four smaller sections, the Version field
contains all resulting version numbers. In the following dialog box, the published documents are
published to SmartPlant Foundation as 4 different versions (11-14). The last version contains all of
the updated information from the publish.

10 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Publish-Retrieve Relationships

Limitations
The SmartPlant 3D adapter does not support Plug and Play.

Retrieve Document Types

 PBS Document (PBS)
 P&ID (PID)
 Dimension Data Sheets (DDP)
 Cable Schedule
 Deleted and Unclaimed Objects
 Project List
 Project Breakdown
Project List and Project Breakdown are not supported in the SmartPlant Integration
mode.

Retrieve Document Type Configuration

IEFAdapter_GetRetrievableDocTypes – This function is used to return the supported document
types. These document types are defined in the registry. SmartPlant 3D does not support "Plug
and Play" functionality.

Retrieve
The SmartPlant 3D Retrieve adapter supports retrieving of PBS, PID, DDP, Cable Schedules, and
Deleted and Unclaimed Objects.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 11

SECTION 3

Data Transformation Logic

Publish
SmartPlant 3D data is transformed to SmartPlant objects as follows:
1. The update step: Publishable objects are created from SmartPlant 3D objects and are stored
in a data file. A graphics view file is also created. These files can be stored back to the
SmartPlant 3D database. Optionally, the xml and graphic files can be saved to a disk.
2. The publish step: The data xml file and graphic file generated during the update step are sent
to the SmartPlant Foundation server. The XML data is validated. The document that is
currently being published to SmartPlant Foundation is compared with the previous version of
the same document. The tool adapter is probed for the existence of all objects and
relationships missing from the current document. Delete instructions are generated for all
missing objects and relationships in the currently publishing data container.
Published data in SmartPlant Foundation can be viewed either in SmartPlant Markup Plus or in
SmartPlant Review.

Publish Processing in Details

See the following for details of the publish processes.

Generating Objects List

1. The Drawings component does a query using a specified filter. This query produces a list of
objects.
2. Expansion processing is done in a separate process to determine if all objects necessary for
the update are in the list. This process involves checking relationship settings. A relationship
setting can be one of the following:
 RELATION_AND_OBJECT
 RELATION_ONLY
 Nothing

Generating XML Data

XML data is generated in a separate process using the updated object list. The container can be
flushed during this process to keep the executable from running out of address space. SmartPlant
3D commits will also be done during this time for the same reason. The process to generate XML
has two options:
Place the document object in the container. If there are no objects in the list from step 2 above, this
process is complete.
If objects appear in the updated list from step 2 above, do the following:
 Sort each object into its class
 Cache each object
Complete the following for each object:
1. Determine class mapping. A MapClassDef must be mapped in the tool schema file for it to be
processed.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 13

Data Transformation Logic

a. Search for a matching MapClassDef class.

b. Once a MapClassDef is found, a check is made for a MapClassToClass mapping relation
pointing to a ClassDef class.
c. Once a mapping has been found, the ProcessClassCriteria property is checked to
determine if there is a callback. The callback has three options.
i. Change the mapping to specify a different ClassDef.
ii. Specify that the ClassDef is not to be published.
iii. Do nothing.
d. Cache information about interface and property mapping to be used later.
2. Process relations for each of the SmartPlant 3D object instances.
a. If the relation is SP3DCorrelationToDesignBasis on the SmartPlant 3D object, create a
SameAs relation and go to the next relation.
i. Determine the SameAs relation by using the Sharing relation.
ii. If a callback is defined in the ProcessClassCriteria property, it is called to determine
the SameAs relation.
b. Search for a matching MapRelDef.
c. Once a MapRelDef is found, a check is made for a MapRelDefToRelDef mapping relation
pointing to a RelDef class.
d. Once a mapping has been found, the ProcessRelCriteria property is checked to determine
if there is a callback. The callback has five options.
i. Change the origin ClassDef.
ii. Change the destination ClassDef.
iii. Change the RelDef.
iv. Specify that the relation is not to be published.
v. Do nothing.
e. If the RELATION_AND_OBJECT value is set on the relation, a check is made for the
destination object. If it is not mapped in the tool schema, the relation is not publishable.
f. At this point a check is made on the ProcessRelCriteria property for a SameAs callback.
This callback determines if the relation should be converted to a SameAs relation.
If the callback returns true, then a SameAs relation is created and the SameAs relation is
determined as described above; otherwise, the relation is created as given.
3. Process properties for each of the SmartPlant 3D object instances.
a. Create an instance of the ClassDef in the output container. For example, P3DEquipment.
b. For each MapClassDef, follow the MapClassRealizesMapClass relation to determine
which interfaces are realized by the MapClass.
c. For each MapClass, follow the MapClassMapProperties relation to determine which
properties are to be published. A special case is for I3DRange. This mapping is
hard-coded, and there is not a mapping for it in the tool schema.
d. For each MapPropertyDef in a MapPropertyToProperty relation, find the PropertyDef and
the InterfaceDef that exposes it.
If the InterfaceDef found is not realized by the ClassDef, then check the SelectClassCriteria
property for information on what additional ClassDef objects to check. If a ClassDef and
InterfaceDef object is given, use it for the property. If nothing is given, do not publish the
property.
e. Check the ProcessPropertyCriteria property to determine if there is a callback. The
callback has four options.

14 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 Data Transformation Logic

i. Change the value of the property.

ii.Specify that the property is not to be published.
iii.
Do nothing.
iv.If the property is not mapped, it may be a type of property that is not mappable at this
time. For example, the IJDPosition and IJDVector objects do not expose the
individual properties so they cannot be mapped to x, y, and z (or i, j, and k). This
callback processes them and produces the x, y, and z properties for the properties. If
this callback produces output, then no more processing is done for the property.
f. Create an instance of the InterfaceDef if it does not exist.
g. Create an instance of the PropertyDef, and store the property using the property scoping.
4. Process MapEdgeDef objects to specify additional property mappings. Once the property has
been found it is processed as previously described. The SelectEdgeCriteria property is used
to match a SmartPlant 3D relation path with a MapEdgeDef path.

Generating Graphic View Data

Graphic view data is generated in a separate process.
1. For each drawable object, get the graphics for each of the aspects specified.
a. Nozzles are not drawable, but to query nozzles in SmartPlant Review or SmartPlant
Foundation, they must be separate entities. Therefore, the software checks for nozzles in
our object list. If one is found, then it forces it to be drawable so that it can be process
separately and added to the output list.
b. Apply style rules to each object.
c. Add object to output list.
2. Create the graphics view file. This file can have two formats.
 ZVF format, which is a compressed streaming format. This file is published to SmartPlant
Foundation along with the XML data file.
 VUE format, which is one large file. This file goes directly to SmartPlant Review.

Classes
There is a MapClassDef object in the tool schema for each SmartPlant 3D class that needs to be
published. However, not all SmartPlant 3D interfaces are included in the tool schema. Three that
are missing are IJRange, IJDPosition, and IJDVector.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 15

Data Transformation Logic

General
1. UID – Must be unique. UID for the SPMapClassDef for SmartPlant 3D classes and interfaces
must be the OID in the Catalog Schema database.
2. Name – The name is derived from the SmartPlant 3D class name.
3. ProcessClassCriteria – If defined, it must be the ProgID of a callback.
4. SelectClassCriteria – If defined, it can be one of the following:
a. SmartPlant 3D class to be used to determine class to property mapping for
IncludeRealized.
b. ClassDef:InterfaceDef to be used to determine what class supports a property that is
exposed by an interface that is not realized by the currently open ClassDef. For example,
P3DProcessPoint:IProcessPoint. This generally represents a one-to-many situation
where one SmartPlant 3D object has properties that go on two SmartPlant objects.
c. It may also contain other information that can be used by callbacks.

Tool Schema Relationships

The map properties associated with the MapClass must be defined, and a relationship between
the MapClass and the MapClassMapProperties relation must be created.

Mapping Relationships
A relationship must be defined between the MapClass and a ClassDef in the SmartPlant schema
using the MapClassToClass relation if this class is to be published.

Properties
In general, there is a MapPropertyDef in the tool schema for each SmartPlant 3D property that
needs to be published. These properties must also have a MapPropertyToProperty relationship
with a PropertyDef if the property is to be published. This is not true in all cases since there are a
small number of hard-coded properties and interfaces.

General
1. UID – Must be unique. The UID for MapPropertyDef must be in the format:
<SmartPlant 3D Package>:P:<interface>:<property>.
2. Name – The SmartPlant 3D name for the property.
3. ProcessPropertyCriteria – If defined, it must be the ProgID of a callback.
4. SelectPropertyCriteria – May contain information that can be used by callbacks.
5. MapPropType – The scoping of the property. Examples are: MapEnum, MapUoM, MapString,
and MapDouble.

16 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 Data Transformation Logic

Tool Schema Relationships

1. Exposed by map classes – The MapPropertyDef objects associated with the MapClassDef
must be defined, and a relationship between the MapClassDef and the
MapClassMapProperties relation must be created.
2. Scoped by enumeration – If the data type of the property is enumerated, the MapPropertyDef
must be related to a MapEnumListDef. If the property is UoM, the MapPropertyDef must be
related to a MapUoMListDef. Both of these definitions are related using the
MapPropertyMapEnumList relation.

Mapping Relationships
A relationship must be defined between the MapPropertyDef and a PropertyDef in the SmartPlant
schema using the MapPropertyToProperty relation if this property is to be published. There are
exceptions to this for IJRange, IJDPosition, and IJDVector.

Map Edges
There are many properties in SmartPlant 3D that are on secondary or catalog objects, and these
properties are mapped by providing a description or path of where to find them. The MapEdgeDef
provides a link between a MapClassDef and a MapPropertyDef.

General
1. UID – Must be unique. The UID for the delivered exported classes is a GUID. There are no
special requirements for user-defined classes.
2. Name – The name is a descriptive name created by the user or developer when the
MapEdgeDef is created.
3. ProcessEdgeCriteria – Not used.
4. SelectClassCriteria – It must contain a relation path that gives the location of the property. The
format is <relation1>:1|0%<relation2>:1|0 where 1 represents the relation origin and 0
represents the relation destination.

Tool Schema Relationships

The MapClassDef is associated with the MapPropertyDef by specifying the EndMapEdgeDef
property on the IMapRel interface in the MapPropertyToProperty relation.

Mapping Relationships
A relationship must be defined between the MapClassDef and a ClassDef in the SmartPlant
schema using the MapClassToClass relation if this class is to be published.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 17

Data Transformation Logic

Enums
The SmartPlant 3D name for an enum list is a Codelist Table, and the name for an enum value is
a Codelist value.

Enum List
There is a MapEnumListDef object in the tool schema for each SmartPlant 3D enumerated list
associated with a property that needs to be published. Because a Codelist table is exported
whether or not it is used by a property, there can be enum lists in the tool schema that are not used
by any property.

General
1. UID – Must be unique. The UID for the tool SPMapEnumListDef must be in the format
<Package>:T:<Codelist Table>.
2. Name – The name is the name of the Codelist table.

Tool Schema Relationships

1. Scoped map properties – A MapPropertyDef is related to a MapEnumListDef by a
MapPropertyMapEnumList relation.
2. Contains – A MapEnumListDef can contain any number of MapEnumDef objects related by
the MapEnumListMapEnum relation.
3. Constrains – For hierarchical enum lists, the MapEnumListDef must be related to the lower
level list with the MapEnumListMapEnumList relation.
4. Constrained by – For hierarchical enum lists, the MapEnumListDef must be related to the
higher level list by the MapEnumListMapEnumList relation.

Mapping Relationships
SmartPlant 3D 2008 and higher supports mapping the codelist. If the SPMapEnumListDef is not
mapped to an EnumListType, then it assumes that the codelist matches between SmartPlant 3D
and the EFSchema. Codelists in the delivered SP3DPublishMap.xml file will be pre-mapped to the
EFSchema.
A relationship can be defined between the MapEnumListDef and an EnumListType in the
SmartPlant schema using the MapEnumListToEnumList relation if this property is to be published
using this list. If this relation is not defined, the enum list value is assumed to be one-to-one.

18 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 Data Transformation Logic

Enum Entry
There is a MapEnumDef object in the tool schema for each SmartPlant 3D list entry. Because all
Codelist values in a table are exported whether or not it is used by a property, there can be enum
values in the tool schema that are not used by any property.

General
1. UID – Must be unique. The UID for the SPMapEnumDef must be in the format
<Package>:V:<Codelist Table>:<Codelist Value>.
2. Name – Not all of them are named. If it is named, it is usually a description of the enum value.

Tool Schema Relationships

Contained in – A MapEnumListDef can contain any number of MapEnumDef objects related by
the MapEnumListMapEnum relation.

Mapping Relationships
A relationship can be defined between the MapEnumDef and an EnumEnum in the SmartPlant
schema using the MapEnumToEnum relation. Codelist values must match between the
SmartPlant 3D Catalog Schema and the SmartPlant EFSchema.
SmartPlant 3D 2008 and higher supports mapping the codelist values. If the SPMapEnumDef is
not mapped to an EnumEnum, then it assumes that the codelist values match between
SmartPlant 3D and the EFSchema. Codelist values in the delivered SP3DPublishMap.xml file do
not have the mapping because they match on codelist numbers between SmartPlant 3D and
EFSchema.

UOMS
Values for all properties that are of the UoM data type are persisted in SI (double) in SmartPlant
3D. UoM properties are published as double (SI). No mapping exists in the tool map schema for
UoMs.

Retrieve
Retrieve is the transformation of SmartPlant objects into SmartPlant 3D design basis objects. This
transformation is achieved by means of the Design Basis and the Design Basis map. The design
basis (SCEF) is a SmartPlant 3D Catalog package that is created by converting all the document
types listed for retrieve into the package format supported by the SmartPlant 3D Package
Manager. For example, the Design Basis package contains a class called PIDProcessEquipment,
which supports the same interfaces and properties as the SmartPlant PIDProcessEquipment.
Normal SmartPlant 3D objects interact with Design Basis objects by means of the
SP3DCorrelationToDesignBasis relation. Although the Design Basis map contains mapping
relations between classes and properties, they are all one-to-one, so the ClassDef
PIDProcessEquipment is in a ClassToMapClass relation with MapClassDef
PIDProcessEquipment. The Design Basis map also contains information on how the Design Basis
instances are stored in the model database. Although the Design Basis map can be read and
processed by the Schema Editor, it is a generated map and any changes made to it should be
made by running the GenerateDesignBasis command in the SmartPlant 3D Project Management
task. Because it does contain information about how Design Basis data is stored in the model

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 19

Data Transformation Logic

database, it cannot be deleted and re-created. If the Design Basis map is deleted, all Design Basis
model data could be lost.
Here is a more detailed description.
1. For each document to be retrieved, select the Design Basis adapter.
2. Start the Schema Component Loader to process the document.
3. For each object or relation received from the Loader, do add, delete, or update.
4. Callbacks are available for each of these cases.

Classes
There is a MapClassDef object in the tool schema for each SmartPlant 3D class that needs to be
retrieved.

General
1. UID – Must be unique. The UID for the classes is a GUID. It will be used as the identifier OID
for the class in the SmartPlant 3D catalog. Users should not change this value.
2. Name – The name is derived from the ClassDef UID.

Tool Schema Relationships

The map properties associated with the MapClassDef must be defined, and a relationship
between the MapClassDef and the MapClassMapProperties relation must be created.

Mapping Relationships
A relationship must be defined between the MapClassDef and a ClassDef in the SmartPlant
schema using the ClassToMapClass relation if this class is to be retrieved.

Properties
In general, there is a MapPropertyDef in the tool schema for each SmartPlant 3D property that
needs to be retrieved. These properties must also have a PropertyToMapProperty relationship
with a PropertyDef if the property is to be retrieved.

General
1. UID – Must be unique. The UID for the delivered properties is a GUID.
2. Name – The SmartPlant 3D name for the property. Due to length limitations, the name could
be a shorter form of the name.
3. ProcessPropertyCriteria – Contains the display identifier or DISPID for the property. This
property must not be changed by the user.

20 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 Data Transformation Logic

Tool Schema Relationships

1. Exposed by map classes – The MapPropertyDef objects associated with the MapClassDef
must be defined, and a relationship between the MapClassDef and the
MapClassMapProperties relation must be created.
2. Scoped by enumeration – If the data type of the property is enumerated, the MapPropertyDef
must be related to a MapEnumListDef. If the property is UoM, the MapPropertyDef must be
related to a MapUoMListDef. Both of these definitions are related using the
MapPropertyMapEnumList relation.

Mapping Relationships
A relationship must be defined between the MapPropertyDef and a PropertyDef in the SmartPlant
schema using the PropertyToMapProperty relation if this property is to be retrieved.

Enums
Enum List
There is a MapEnumListDef object in the tool schema for each EnumListType.

General
1. UID – Must be unique. The UID for enums is a GUID.
2. Name – The name is the name of the EnumListDef.

Tool Schema Relationships

1. Scoped map properties – A MapPropertyDef is related to a MapEnumListDef by a
MapPropertyMapEnumList relation.
2. Contains – A MapEnumListDef can contain any number of MapEnumDef objects related by
the MapEnumListMapEnum relation.
3. Constrains – For hierarchical enum lists, the MapEnumListDef must be related to the lower
level list with the MapEnumListMapEnumList relation.
4. Constrained by – For hierarchical enum lists, the MapEnumListDef must be related to the
higher level list by the MapEnumListMapEnumList relation.

Mapping Relationships
A relationship must be defined between the MapEnumListDef and an EnumListType in the
SmartPlant schema using the EnumListToMapEnumList relation if this property is to be retrieved
using this list.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 21

Data Transformation Logic

Enum Entry
There is a MapEnumDef object in the tool schema for each EnumEnum entry.

General
1. UID – Must be unique. The UID for the enum is a GUID.
2. Name – The name is the name of the EnumEnum.
3. ProcessEnumCriteria – Contains the value of the enum.

Tool Schema Relationships

Contained in – A MapEnumListDef can contain any number of MapEnumDef objects related by
the MapEnumListMapEnum relation.

Mapping Relationships
A relationship must be defined between the MapEnumDef and an EnumEnum in the SmartPlant
schema using the MapEnumToEnum relation.

UOMS
SmartPlant 3D retrieves the SI value for UoMs. The values are persisted in the database as
doubles in the SmartPlant 3D database for the SmartPlant 3D design basis data.

Correlate
Use of the SmartPlant 3D adapter to support correlation is only available with SmartPlant 3D 2008
and higher.
Once the data has been retrieved into SmartPlant 3D, there needs to be a mapping between the
3D data and the Design Basis data. This information is stored in the Publish map and can be
modified by users. There are no MapClassDef or MapPropertyDef objects created for this
functionality. They are all created when the publish map is exported from the SmartPlant 3D
Catalog so they conform to what publish functionality needs. Any correlation-specific entries in the
map are the relations to the MapClassDef and MapPropertyDef objects and to the MapEdgeDef
objects created for correlation.

Classes
There is a MapClassDef object in the tool schema for each SmartPlant 3D class that needs to be
correlated.

22 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 Data Transformation Logic

General
1. UID – Must be unique. The UID for the delivered exported classes is a GUID. There are no
special requirements for user-defined classes.
2. Name – The name is derived from the SmartPlant 3D class name.
3. ProcessClassCriteria – Not used. May contain information for publish.
4. SelectClassCriteria – Not used. May contain information for publish.

Tool Schema Relationships

The map properties associated with the MapClassDef must be defined, and a relationship
between the MapClassDef and the MapClassMapProperties relation must be created.

Mapping Relationships
A relationship must be defined between the MapClassDef and a ClassDef in the SmartPlant
schema using the ClassToMapClass relation if this class is to be correlated.

Properties
There is a MapPropertyDef in the tool schema for each SmartPlant 3D property that needs to be
correlated. These properties must also have a PropertyToMapProperty relationship with a
PropertyDef.

General
1. UID – Must be unique. The UID for the delivered properties is a generated string with the
format <SmartPlant 3D Package>:P:<interface>:<property>. There are no special
requirements for user-defined property formats.
2. Name – The SmartPlant 3D name for the property.
3. ProcessPropertyCriteria – Not used. May contain information for publish.
4. SelectPropertyCriteria – Not used. May contain information for publish.

Tool Schema Relationships

1. Exposed by map classes – The MapPropertyDef objects associated with the MapClassDef
must be defined, and a relationship between the MapClassDef and the
MapClassMapProperties relation must be created.
2. Scoped by enumeration – This information is currently not used by the correlate.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 23

Data Transformation Logic

Mapping Relationships
A relationship must be defined between the MapPropertyDef and a PropertyDef in the SmartPlant
schema using the MapPropertyToProperty relation if this property is to be correlated.

Map Edges
There are many relationship between SmartPlant 3D properties and SmartPlant properties that
can be quite complex. The MapEdgeDef provides a link between a MapClassDef and a
MapPropertyDef that handles the more complex relationships. It is expected that the complex
relationships will be not be created or modified by users.

General
1. UID – Must be unique. The UID for the delivered exported classes has a format of
<SmartPlant 3D class>:<SmartPlant 3D interface>:SmartPlant 3D property>:M:<SmartPlant
3D relationship>. There are no special requirements for user-defined classes.
2. Name – The name is a descriptive name created by the user or developer when the
MapEdgeDef is created.
3. ProcessEdgeCriteria – Can contain the following separated by a % sign.
a. ConvertPROGID=<ProgID of callback>
b. Updatable=True|False
c. Compare=TRUE
4. SelectClassCriteria – Can contain the following separated by a % sign.
a. RelationshipPath=<SmartPlant 3D interface>:<SmartPlant 3D relationship> ; …
b. MappedRelationshipPath=<EF interface>:<EF role>

Tool Schema Relationships

The MapClassDef is associated with the MapPropertyDef by specifying the EndMapEdgeDef
property on the IMapRel interface in the PropertyToMapProperty relation.

Mapping Relationships
A relationship must be defined between the MapClassDef and a ClassDef in the SmartPlant
schema using the PropertyToMapProperty relation if this class is to be published.

Enums
Codelist mapping is not supported on the retrieve side of mapping yet.

UOMS
UoM properties are retrieved and compared as SI values in double.

24 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

SECTION 4

UID Construction
The basic object UID used for publish is composed of a signature, a model connection string, and
a moniker separated by colons. The relation UID used for publish begins with the letter R followed
by a 0 or 1 representing the origin or destination and is completed by a GUID. UIDs for linking the
object back to the document are built from the object UID. The SameAs UID is also constructed
from the base object and the external object UID.
Object UID AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830
Relation UID R1{D5314939-55FF-411B-AE2A-B34772D78644}
NonDrawingItemRelation ND%AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830%0122e88089ab
cdef0d239065deedfeeb
DrawingItems Relation DI%AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830%0122e88089ab
cdef0d239065deedfeeb
P3DDrawingRepresentation RP%AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830%0122e88089ab
cdef0d239065deedfeeb
DwgRepresentationComposition DR%AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830%0122e88089ab
cdef0d239065deedfeeb
SameAs %AABA:model{175eeb0a-4cb1-4419-850d-855f57f8df4c}:
@a=0029!!1090063##299285149656088830%{00013885-00
00-0000-8440-2AF8B3461B04}
Document UID {0001ADE7-0000-0000-0C00-D50257463304}

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 25

SECTION 5

Metadata Adapter
The Map Schema file delivered with SmartPlant 3D out of the box is synchronized with the
application tool metadata (Catalog Schema database). Publishing of user-customized changes
such as properties, codelists, and so forth require modifications to the tool map and EF Schema
files. Creating new SPMap objects for tool classes, interfaces, properties, codelists, codelist
values, and so forth is not trivial. Users must very carefully follow the specific syntax used for
various attributes such as UID, Name, and so on when creating SPMap objects in the tool map
schema. Details about the syntax for UID and Name are described in the Data Transformation
section of this document. Also, the SmartPlant 3D admin user responsible for mapping must track
all the incremental custom changes to the Catalog Schema to determine the properties, codelists,
and so on that should be added to the tool map schema. The Metadata Adapter for SmartPlant 3D
makes the mapping experience easier.

Configuration
The client workstation should have the following installed based on the SmartPlant Enterprise
configuration deployed.
 SmartPlant 3D Client 2007 or greater
 Schema Component 2007 (3.8) or greater
 SmartPlant Desktop Client 2008 or greater
Schema Editor is launched from the SmartPlant Desktop Client in the 2008 release.
The SmartPlant 3D plant must be registered with SmartPlant Foundation. (See detailed
information about the Connect to SPF workflow command in the Schema Editor.)

Synchronizing the Tool Map File

The following basic steps synchronize the tool map schema with the tool application metadata.
1. Connect to SmartPlant 3D Catalog Schema database.
2. Transform application metadata for classes, interfaces, properties, codelists, and codelist
values to tool map schema objects SPMapClassDefs, PropertyDefs, EnumListDefs, and
SPMapEnumDefs.
3. Compare the exported tool map schema objects with the existing tool map file and report
differences on the Synchronize dialog box.
Synchronizing the tool map file merges the changes from the SmartPlant 3D Catalog Schema
database into the tool map (SP3DPublishMap.xml) file in the symbol share path. Note that the
Synchronize step in the Metadata Adapter does not make modifications to the SmartPlant 3D
Catalog Schema database.
4. Once the tool map file is synchronized with changes from the Catalog Schema, the user can
create new SPMap objects in the Schema Editor. Upon saving the tool map file in the Schema
Editor, the software creates the corresponding application objects (interfaces, properties,
codelists, and codelist values) in the SmartPlant 3D Catalog Schema database.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 27

Metadata Adapter

Metadata Adapter Modes

The SmartPlant 3D Metadata Adapter supports the following modes:
1. Connected and Synchronized
2. Cancel Synchronize
3. Disconnected
The SmartPlant 3D Metadata Adapter has the basic support for Cancel Synchronize and
Disconnected in SmartPlant Enterprise 2008 and higher. In both of these modes, SPMap objects
are read-only in the Schema Editor. The only modifications allowed in these two modes are:
 Modifications to objects in the SmartPlant schema
 Modifications to relations between SPMap object to objects in the SmartPlant schema
Modifications to SPMap objects such as SPMapClassDef for interfaces, SPMapPropertyDefs,
SPMapEnumListDefs, and SPMapEnumDefs are allowed only in the Connected and
Synchronized mode.

Limitations
 Synchronize will only update the tool map schema (SP3DPublishMap.xml) file. Application
metadata cannot be synchronized with the changes to the tool map schema file.
 Modifications to the SmartPlant 3D Catalog Schema do not support database transactions.
Each modification to SPMap objects is committed as it is processed while saving the tool map
file in the Schema Editor.

28 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

SECTION 6

SmartPlant 3D Mapping Examples

The sections that follow provide mapping examples for in SmartPlant 3D. For more information
and mapping examples, see the SmartPlant Mapping User's Guide.

SmartPlant 3D and SmartMarine 3D Mapping

Examples
The following publish and retrieve mapping examples describe mapping for SmartPlant 3D and
SmartMarine 3D.
Example: Mapping for Retrieve (on page 29)
Example: Mapping for Publish (on page 47)
These examples illustrate how to create mapping relationships to properties that have already
been created in the SmartPlant Schema for mapping with other authoring tools. For more example
about creating these custom properties, enumerated lists, and enumerated list items in the
SmartPlant Schema, see the Schema Editor User's Guide.

Example: Mapping for Retrieve

This example describes how to extend two existing enumerated lists (also called codelists or
select lists) and an existing property definition, and how to update the retrieve mapping for
SmartPlant 3D.
The following is an overview of the steps in this example.
1. Verify the enumerated lists and the property definitions in the SmartPlant schema.
 Enumerated Lists: Fluid system, EngSys
 Property Definitions: SystemCode, EngineeringSys
2. Regenerate component schemas.
3. Add the new information to the SmartPlant 3D Catalog.
4. Generate the design basis, and regenerate views and the Reports database.
5. Check the properties in SmartPlant 3D.

Verify Information in the SmartPlant Schema

1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and select Launch Schema Editor.
3. On the Set Active Configuration dialog box, select the version of the schema that you want
to view.
4. Click OK to set the configuration, and open the Schema Editor.
5. In the Schema Editor, click Workflows > Overall Workflows.
6. Beside the Another Schema File button, click View, and then open the schema in one of the
editors. In this example, choose Editor.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 29

SmartPlant 3D Mapping Examples

7. Expand EnumListType, and find the Fluid system node.

30 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

8. Right-click Fluid system, and select View Fluid system on the shortcut menu.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 31

SmartPlant 3D Mapping Examples

9. Expand the Corrosive node, and verify the four fluid codes.

For SmartPlant 3D retrieve mapping, the Name and Long description provided
here for the enumerate list values do not matter. However, the value provided in the Number
field for each must match the corresponding codelist value for the associated list entry in the
SmartPlant 3D Catalog.

Short Description Long Description Number

KA (KA) Ammonia, Anhydrous 10101
KC (KC) Caustic 10102
KP (KP) Process Chemical 10103
KW (KW) Ammonia, Aqueous 10104
10. Click Cancel to close the Edit Enumerated List dialog box.
11. In the tree view, expand EnumListType.
12. Right-click EngSys, and select Edit EngSys on the shortcut menu.

32 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

13. Verify the properties for the EngSys enumerated list, and then click Cancel.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 33

SmartPlant 3D Mapping Examples

14. Click Filter in the tree view, and select Properties from the Select list.

15. In the tree view, expand the Property Def list.

16. Right-click SystemCode, and select Edit System Code on the shortcut menu.

34 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

17. Verify the attributes of the system code property, and then click Cancel.

18. In the tree view, find the EngineeringSys property.

19. Right-click EngineeringSys, and select Edit Engineering System property on the shortcut
menu.
20. Verify the attributes of the engineering system property, such as that it is scoped by the
enumerated list EngSys, and then click Cancel.
21. Click File > Close to close the Schema Editor.

Regenerate the Component Schemas

The component schemas of other authoring tools are used to create the retrieve map file for
SmartPlant 3D. To ensure that the new properties and enumerated lists are included in the
appropriate component schema or schemas, regenerate the component schemas from the
SmartPlant Foundation Desktop Client.
1. In the Desktop Client, click Find > Integration > Schema Documents.
2. Click OK to find all schema documents.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 35

SmartPlant 3D Mapping Examples

3. Right-click the CMF file, and select Regenerate Schema Files on the shortcut menu.

Add Information to the Catalog Database

This section describes modifying the Catalog Database by editing Excel workbooks and
bulkloading the changes. You can also add or modify Catalog data using the Catalog task user
interface. For more information, see the Catalog User's Guide.
1. Make a copy of the original AllCodeLists.xls file, which is located at [Product
Directory]\CatalogData\BulkLoad\DataFiles on the SmartPlant 3D server.
2. Open the copy of AllCodeLists.xls to add the new fluid code object.

36 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

3. Locate the Fluid Code worksheet.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 37

SmartPlant 3D Mapping Examples

4. Under Gas Fluid System, insert the following Corrosive data:

5. Be sure to add an A in the first column on the left. The letter A indicates the Bulkload utility will
add the value during the bulkload process.
6. When you are finished, save the file.
7. Add two properties called SystemCode and EngineeringSystem to a custom interface file.
In this example, this file is named EFCustomProps.xls and looks like the illustration below:

38 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

The CustomClassInterfaceList sheet is shown below:

8. Add the EngineeringSystem codelist. In this example, the file name is

EFCustomCodeList.xls.

9. Save the changes, and close Excel.

Bulk Load Data

1. Click Start > All Programs > Intergraph SmartPlant 3D > Database Tools > Bulkload
Reference Data to open the Bulkload utility.
2. In the Bulkload utility, click Add beside the Excel codelist files field. Browse to the directory
where your codelist files are located. In this example, the file names are AllCodeLists.xls
and EFCustomCodeLists.xls.
3. Under Bulkload mode, select Append, modify, or delete records in existing catalog.
4. Under Catalog information and Schema information, select your Catalog database
server, Catalog database, Catalog schema database server, and Catalog schema
database.
5. Specify a path and file name for the log file.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 39

SmartPlant 3D Mapping Examples

6. Specify the SharedContent folder in the Symbol and custom program file location field.

7. Click Load.

40 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

8. After the first load operation is complete, run the bulkload utility again for the custom
properties file. Remove the two codelist files from the window using the Delete button, and
add the property file to the Excel files section using the Add button. The file name is
EFCustomProps.xls.

9. Change the mode to Append to existing catalog. The other settings will remain the same.
10. Click Load.
11. After the bulkload process is complete, click Close.
For more information about Bulkloading, see the SmartPlant 3D Reference Data
Guide.

Generate Design Basis and Views

1. Click Start > All Programs > Intergraph SmartPlant 3D > Project Management.
2. Expand Reference Data.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 41

SmartPlant 3D Mapping Examples

3. Right-click the catalog, and select Generate Design Basis on the shortcut menu.

4. Click in the Select Component Schemas Path dialog box to browse to the directory
where the component schemas are located, and click OK.

Remove the read-only properties of all the xml files located at

\\server\SharedContent\Xml\DesignBasisSchemas

42 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

5. When the regeneration of the design basis is complete, generate the views for the database
by selecting the plant, and clicking Tools > Synchronize Model with Catalog.

6. On the View Generator dialog box, review the information for the Model database and the
Catalog Schema database.

7. Click OK.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 43

SmartPlant 3D Mapping Examples

8. When the process is complete, right-click the plant, and select Regenerate Reports
Database.

9. Confirm the information for the Reports database and the Reports schema database, and
click OK.

44 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

The following message appears when the process is complete.

10. Click File > Exit to close the Project Management task.

Check the Properties in the Model

1. Click All Programs > Intergraph SmartPlant 3D > SmartPlant 3D.
2. Open a session that includes pipe runs.
3. Switch the locate filter in the upper left to Piping Runs.

4. Right-click a pipe run in the model, and select Properties on the shortcut menu.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 45

SmartPlant 3D Mapping Examples

5. In the Standard category, verify that the System Code and the Engineering System
properties appear in the dialog box. Make sure that for Engineering System, the codelist
entries appear.

6. Click OK to close the properties dialog box.

7. To check the Fluid System, switch the locate filter in the upper left to Pipelines.

46 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

8. Right-click a pipeline in the model, and select Properties on the shortcut menu. Verify that
Corrosive appears in the Fluid Requirement box and that the added values are available in
the Fluid Type box.

Example: Mapping for Publish

This example describes how to create publish mapping for two properties between SmartPlant
Foundation and SmartPlant 3D.

Launch Schema Editor and Load the SmartPlant 3D Tool Map Schema
If you are creating mapping relationships but not extending the SmartPlant Schema, it is
not necessary to check out the CMF file. However, you do need to open the CMF file along with
the tool map schema to create the mapping relationships.
1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and select Launch Schema Editor.
3. On the Set Active Configuration dialog box, select the version of the schema that you want
to view.
4. Click OK to set the configuration, and open the Schema Editor.
5. In the Schema Editor, click File > SmartPlant Edit Engineering Tool Options, and select
SmartPlant 3D in the list of authoring tools to load the SmartPlant 3D tool map schema.
6. Under Startup options, select the Load map schema and Connect to application schema
check boxes, and click OK.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 47

SmartPlant 3D Mapping Examples

7. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.

 Each row represents a discrepancy between the tool database and the tool map schema.
 Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.
 In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata adapter
can add the property to the tool map schema, but it cannot remove the property from the
tool database.

48 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

Map the New Custom Properties

1. In the Map Environment, expand SmartPlant 3D > Loaded Map Schemas > SmartPlant
3D Tool Schema.

2. Expand the Map Classes node, and right-click IUCustom.

3. On the shortcut menu, select Edit IUCustom.
4. In the Edit Map Class Definition dialog box, click the browse button beside the Publish to
SmartPlant class/interface field.

5. Find ICustomInterface, which is the SmartPlant Schema interface definition on which the
custom properties are exposed. Select the check box beside ICustomInterface, and click
OK.
6. Select the Publish tab.
7. Under Unmapped application properties, select EngineeringSystem.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 49

SmartPlant 3D Mapping Examples

8. Under Unmapped SmartPlant properties, select EngineeringSys.

9. Click Map .

50 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D

 SmartPlant 3D Mapping Examples

10. Repeat steps 7-9 to map the SystemCode property.

11. Confirm that both properties have been mapped at the bottom of the window.

12. Click OK.

To create mapping for correlation in SmartPlant 3D, repeat steps 4 - 12 using the Retrieve
from SmartPlant class/interface field and the Retrieve tab.

Save the Tool Map Schema

1. Click File > Save All Modified Files to save the changes to the tool map schema.
Because you did not change the SmartPlant schema, you do not need to save the CMF file.
When you close the Schema Editor, the software offers to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes in
the message box to save the session files so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from the
Desktop Client.

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 51

Index
Retrieve Document Type Configuration • 11
A Retrieve Document Types • 11
Architecture • 7
S
C SmartPlant 3D and SmartMarine 3D
Mapping Examples • 29
Classes • 15, 20, 22 SmartPlant 3D Mapping Examples • 29
Configuration • 27 SmartPlant 3D Publish-Retrieve
Correlate • 22 Relationships • 9
Support for Handling Large Publishes • 10
D Synchronizing the Tool Map File • 27
Data Transformation Logic • 13
T
E Tool Schema Relationships • 16, 17, 18, 19,
Enum Entry • 19, 22 20, 21, 22, 23, 24
Enum List • 18, 21
Enums • 18, 21, 24 U
Example UID Construction • 25
Mapping for Publish • 47 UOMS • 19, 22
Mapping for Retrieve • 29

G
General • 16, 17, 18, 19, 20, 21, 22, 23, 24

L
Limitations • 11, 28

M
Map Edges • 17, 24
Mapping Relationships • 16, 17, 18, 19, 20,
21, 22, 23, 24
Metadata Adapter • 7, 27
Metadata Adapter Modes • 28

P
Preface • 5
Properties • 16, 20, 23
Publish • 9, 13
Publish Adapter • 7
Publish Document Type Configuration • 9
Publish Document Types • 9

R
Retrieve • 11, 19
Retrieve Adapter • 7

SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D 53