Smartplant Enterprise: Smartplant Adapter For Pds 3D
Smartplant Enterprise: Smartplant Adapter For Pds 3D
August 2012
DSPF1-PE-200102C
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
Index ........................................................................................................................................................... 21
Preface
This document describes details, functionality, and configuration of the SmartPlant Adapter for
®
PDS 3D.
Send documentation comments or suggestions to [email protected].
Integration Documentation
SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release
Bulletin - Provides information on new SmartPlant Foundation and integration features for
the current release.
SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and
integration concepts and data exchange among integrated SmartPlant Enterprise authoring
tools.
SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe
the exchange of data among SmartPlant Enterprise authoring tools. These graphics are also
included in the SmartPlant Enterprise Overview.
SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating
SmartPlant Enterprise and describes a typical example of full integration within SmartPlant
Enterprise, including publishing and retrieving plant information using SmartPlant authoring
tools and Aspen Basic Engineering™.
SmartPlant Enterprise Hardware and Software Recommendations - Provides information
about the hardware recommendations and software requirements of the authoring tools that
are part of the SmartPlant Enterprise suite.
Integration Setup Guide - Provides information about setting up and using SmartPlant
Enterprise products in an integrated environment. Also provides integration troubleshooting
information.
Integrated Line List Configuration and User's Guide - Provides configuration and user
information for creating, publishing, or retrieving line list documents in SmartPlant
Foundation and SmartPlant Materials.
SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and
resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and
integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize
data loss and downtime when restoring data in an integrated environment.
SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the
SmartPlant Foundation and integration software.
Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to
the SmartPlant schema and the data model that describes how the SmartPlant schema is
constructed.
Integration: A Gentle Introduction to SmartPlant Schema Patterns, Process & Practice -
Provides an introduction to patterns in the SmartPlant schema.
Integration User's Guide - Provides information about using SmartPlant Enterprise products
in an integrated environment. Also provides a basic understanding of integration and
common integration tasks.
Integration Administrator's Guide - Provides information for system administrators on how to
set up and configure an integrated environment.
Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and
extend the SmartPlant schema, view and modify authoring tool mapping, and compare
schema files.
SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of
mapping between the SmartPlant schema and integrated authoring tools.
SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to
®
load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation
database.
SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring
integrated SmartPlant® Enterprise applications to run in a Citrix environment.
Architecture
The following interfaces are supported.
Publish Adapter
IEFAdapter
Retrieve Adapter
IEFAdapter
Metadata Adapter
IInstructionsListener, IMetadataAdapter, IMetadataAdapterGUI, IMetadataAdapterGUI2,
IMetadataAdapterForeign, IMetadataAdapterIdentity
Publish
PDS 3D publishes documents and data using the PDS Material Data & SmartPlant Publisher
utility delivered by the PDSHELL product.
The PDS 3D Publish adapter supports the following drawing types:
Isometric
Orthographic
3D Model data.
PDS publishes hot-spotted isometrics for viewing and navigation in SmartPlant Foundation
Desktop Client. The PDS3D Adapter also converts MicroStation-based PDS isometric drawings
into SmartSketch-based .igr files, and then publishes the files as view files for isometric drawing
documents. PDS3D Adapter publishes a representation objects for piping items in the isometric
drawing documents. This provides the capability to hot spot items on published isometric
drawing documents in SmartPlant Foundation. The View item in drawing command in the
SmartPlant Foundation desktop client can be used to view graphically a piping item in the view
file corresponding to the PDS isometric. In addition a piping item in the view file can be
graphically selected and traverse to the original object and look at its properties, or view the
same item in model, and so forth.
The Start Data Publishing dialog box in PDS Material Data & SmartPlant Publisher provides
several publish options. You can publish documents immediately by using the Now option or at
a later time by using the Later options. All documents should be published to MDP before being
published to SmartPlant Foundation.
If you select Now, the Publish dialog in the SmartPlant integration environment appears.
If you select Later, the schedule job task in PDS Material Data & SmartPlant Publisher
appears. For more information, see the Plant Design System (PDS) Material Data
Publisher Guide.
A AutoLoadPublishWithMerge workflow is now available to make publishing large 3D models
more efficient. This consolidation workflow is delivered with steps to create the published 3D
composite document, load the 3D data in SmartPlant Foundation, and notify the appropriate
user. 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 2008 and higher, all administrative functions are performed in the Desktop Client.
Retrieve
The SmartPlant 3D Retrieve adapter supports retrieving of PBS.
Publish
Each model in PDS 3D is published as a document into SmartPlant Foundation. The
transformation of PDS 3D model data to SmartPlant objects happens in the tool adapter and the
graphic file is generated in a separate process along with the creation of the document object.
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.
Classes
A MapClassDef object exists in the tool schema for each PDS 3D class that needs to be
published.
General
1. UID – Must be unique. UID for the SPMapClassDef for PDS 3D classes is generated by the
PDS 3D MetadataAdapter. Typically it is of the format "pdtable_<PDS3D MDP table
number>_<Class Name>".
2. Name – The name for the SPMapClassDef for PDS 3D classes is generated by the PDS 3D
MetadataAdapter.
Mapping Relationships
A relationship must be defined between the MapClass and a ClassDef in the PDS Component
schema using the MapClassToClass relation if this class is to be published. Classes in the
delivered PDS3DToolMapSchema.xml file will be pre-mapped to the EFSchema.
Properties
In general, a MapPropertyDef exists in the tool schema for each PDS 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.
General
1. UID – Must be unique. The UID for MapPropertyDef for PDS 3D properties is generated by
PDS 3D Metadata Adapter. Typically it is of the format "<Class Name>_Attr_<PDS3D MDP
attribute number>".
2. Name – The PDS 3D MDP name for the property.
Mapping Relationships
A relationship must be defined between the MapPropertyDef and a PropertyDef in the PDS
Component schema using the MapPropertyToProperty relation if this property is to be
published. Properties in the delivered PDS3DToolMapSchema.xml file will be pre-mapped to the
EFSchema.
Enums
The PDS 3D name for an enum list is a Standard Note Table, and the name for an enum value
is a Standard Note Table entry.
Enum List
A MapEnumListDef object exists in the tool schema for each PDS 3D Standard Note Table
associated with properties that needs to be published.
General
1. UID – Must be unique. The UID for the tool SPMapEnumDef for PDS 3D standard note
tables is generated by PDS3D Metadata Adapter. Typically it is of the format
"PDS3DEnumList_<PDS3D Standard Note Table number>".
2. Name – The name is the name of the PDS 3D standard note table.
Mapping Relationships
A relationship must be defined between the MapEnumListDef and an EnumListType in the PDS
component schema using the MapEnumListToEnumList relation if this property is to be
published using this list. EnumLists in the delivered PDS3DToolMapSchema.xml file will be
pre-mapped to the EFSchema.
Enum Entry
A MapEnumDef object exists in the tool schema for each PDS 3D Standard Note Table entry.
General
1. UID – Must be unique. The UID for the tool SPMapEnumListDef for PDS 3D standard note
table entries is generated by PDS3D Metadata Adapter. Typically it is of the format
"<EnumList UID>_<PDS3D Standard Note number>".
2. Name – The Name is the PDS 3D Standard Note entry’s short description.
3. Description – The Description is the PDS 3D Standard Note entry’s long description.
Mapping Relationships
A relationship must be defined between the MapEnumDef and an EnumEnum in the PDS
Component schema using the MapEnumToEnum relation. Enum entries in the delivered
PDS3DToolMapSchema.xml file will be pre-mapped to the EFSchema.
UOMS
PDS3D Metadata Adapter does create UoM lists in the tool map schema. For the properties
scoped by those UoM lists to be published accurately, a mapping should exist between the
UOM lists in the tool schema and UoM lists in the EFSchema.
UoM List
A MapUoMListDef object exists in the tool schema for the UoMs associated with properties
that needs to be published.
General
1. UID – Must be unique. The UID for the tool SPMapUoMListDef for PDS 3D standard note
tables is generated by PDS3D Metadata Adapter. Typically it is of the format
"PDS3DUoM_<UoMList name>".
2. Name – The name is generated by PDS3D Metadata Adapter.
Mapping Relationships
A relationship must be defined between the MapUoMListDef and an UoMListType in the PDS
component schema using the MapEnumListToEnumList relation if this property is to be
published using this list. UoMLists in the delivered PDS3DToolMapSchema.xml file will be
pre-mapped to the EFSchema.
UOM Entry
There is a MapUoMDef object in the tool schema for each PDS 3D UoM entry.
General
1. UID – Must be unique. The UID for the tool SPMapUoMDef entries is generated by PDS3D
MetadataAdapter. Typically it is of the format "<UoMList UID>_<UoM entry number>".
2. Name – The Name is generated by PDS3D MetadataAdapter.
3. Description – The Description is generated by PDS3D MetadataAdapter.
Mapping Relationships
A relationship must be defined between the MapUoMDef and an UoMEnum in the PDS
Component schema using the MapEnumToEnum relation. UoM entries in the delivered
PDS3DToolMapSchema.xml file will be pre-mapped to the EFSchema.
Retrieve
Currently, PDS only retrieves the Plant Breakdown Structure (PBS).
UID Construction
The basic object UID used for publish is composed of a signature, a keyword identifying the type
of object, PDS 3D model identifier and the object identifier in PDS 3D all separated by ‘_’. The
relationship UID used for publish begins with a keyword identifying the type of relationship
followed by ‘%’ and then followed by identifier of the related object(s).
Object UID AAAW_PIPCOMP_111_58195997
NonDrawingItemRelation ND%AAAW_PIPSEG_111_58195977
DrawingItems Relation DI%AAAW_PIPCOMP_111_58195978_DWGREP
PDSRepresentation AAAW_PIPCOMP_111_58195978_DWGREP
DwgRepresentationComposition DR%AAAW_PIPCOMP_111_58195978_DWGREP
Document UID AAAW_M_1_176-Document
Metadata Adapter
The Tool Map Schema file delivered with PDS 3D out of the box is synchronized with the
application tool metadata (MDP database). Publishing of user-customized changes, such as
properties, standard note tables, and so forth, require modifications to the tool map and
SmartPlant Schema files. Creating new SPMap objects for properties, standard note tables,
standard note table entries, 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 PDS 3D admin user responsible for
mapping must track all the incremental custom changes to the MDP Schema to determine the
properties, standard note tables, and so on that should be added to the tool map schema. The
Metadata Adapter for PDS 3D makes the mapping experience easier.
Configuration
The client workstation should have the following installed based on the SmartPlant Enterprise
configuration deployed.
SmartPlant Client 2009 or greater
Schema Component 2009 (4.3) or greater
SmartPlant Desktop Client 2009 or greater
The PDS 3D plant must be registered with SmartPlant Foundation. (See detailed information
about the Connect to SPF workflow command in the Schema Editor).
Limitations
Synchronize will only update the tool map schema (PDS3DToolMapSchema.xml) file.
Application metadata (PDS 3D MDP database) cannot be synchronized with the changes to the
tool map schema file.
A T
Architecture • 7 Tool Schema Relationships • 12, 13, 14, 15
C U
Classes • 12 UID Construction • 17
Configuration • 19 UOM Entry • 15
UoM List • 14
D UOMS • 14
Data Transformation Logic • 11
E
Enum Entry • 14
Enum List • 13
Enums • 13
G
General • 12, 13, 14, 15
L
Limitations • 20
M
Mapping Relationships • 12, 13, 14, 15, 16
Metadata Adapter • 7, 19
Metadata Adapter Modes • 20
P
PDS 3D Publish-Retrieve Relationships • 9
Preface • 5
Properties • 12
Publish • 9, 11
Publish Adapter • 7
Publish Document Types • 9
R
Retrieve • 10, 16
Retrieve Adapter • 7
Retrieve Document Type Configuration • 10
Retrieve Document Types • 10
S
Synchronizing the Tool Map File • 19