Smart 3D Equipment Reference Data

Student Workbook

Version 2016 December 2016 DSP3D-TP-100109A

Copyright
Copyright © 2014 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
Street address: 170 Graphics Drive, Madison, AL 35758

Terms of Use
Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("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.
 Table of Contents

Table of Contents
Preface ...............................................................................................................................4

Lab 1: Creating a new Catalog Database .................................................................5

Lab 2: Catalog Hierarchy ..............................................................................................7

Lab 3: Equipment Catalog Hierarchy.......................................................................14

Lab 4: Working with the Custom Interface Sheet ................................................21

Smart 3D Equipment Reference Data Student Workbook 3

Preface

Preface
This document is designed as an aid for students attending the SmartPlant 3D Reference Data
class presented by Intergraph Corporation, and it’s a supplement to the standard product
documentation.

Objective

This document is designed to provide comprehensive information of what is in Smart 3D

Reference Data 2014R1.

Course description

Upon completing this course, you will be able to:

 Provide an overview of the SmartPlant 3D reference data. It describes general

information about the catalog schema, terms, and the delivered equipment reference data.

Course Reference Material

• SmartPlant 3D Reference Data Guide

• Equipment 3D Symbols Reference Data Guide

• Equipment and Furnishing Reference Data Guide

• Catalog User’s Guide

Questions or suggestions relating to this document should be directed to:

SmartPlant 3D Training Services

4 Smart 3D Equipment Reference Data Student Workbook

 Lab 1: Creating a new Catalog Database

Lab 1: Creating a new Catalog Database

Objective
After completing this lab, you will be able to:

 Create a new template catalog database using Project Management tool

Creating a new Catalog Database

1. Start the Project Management application. Click on Start-> Programs -> Intergraph
SmartPlant 3D-> Project Management to run the application.

2. Go to the main menu and select Database -> New -> Catalog to open the New Catalog
dialog

3. In the Catalog Database Server box, select the name of the server where the Catalog
Database and schema will be created.

4. To create a new database, key-in Sample1_Cat in the Database Name box.

5. Under Template options, Check “Create an empty catalog” option and make sure the template
file to be used to create the catalog schema is the Application Repository database delivered
in the product. Select AppRepos.dat for SQL Server or Select APPREPOS.DMP for Oracle.

Smart 3D Equipment Reference Data Student Workbook 5

Lab 1: Creating a new Catalog Database

6. Under “Paths for catalog database files” area, type the symbol share location.

7. Click OK button.

6 Smart 3D Equipment Reference Data Student Workbook

 Lab 2: Catalog Hierarchy

Lab 2: Catalog Hierarchy

Objective

After completing this lab, you will be able to:

 Add/Modify Module Type Hierarchy

Module Hierarchy

In this lab, you will add two new module classes called TransformerType1 and PipeRackType1
into the Module Type catalog hierarchy. To create the classification folders as shown below, you
must edit the ModuleType Excel workbook, which contain three sheets that control the hierarchy:
ClassNodeType, R-Hierarchy, and R-ClassNodeDescribes. When you add a module class to
the catalog hierarchy, you must update these sheets, where necessary, in order to see the data in
the Catalog task or Catalog browser dialog box.

CatalogRoot is the RootNode of the ReferenceData Catalog Browser. It cannot have a parent
node. It is a named-object. Similarly, RefDataModulesRoot is the root for the module hierarchy
which appears as a child of the CatalogRoot. Electrical, Transfomers, Structure and PipeRacks
are the nodes to facilitate the easy browsing. TransformerType1 and PipeRackType1 are the
Module Classes.

1. Open the ModuleTypes.xls Excel workbook. The ModuleTypes.xls can be found at

C:\Program Files (x86)\Smart3D\CatalogData\BulkLoad\DataFiles

2. Go the ClassNodeType sheet and add the following entries. Remember to add the letter A to
all new records.

Note: This sheet describes the nodes used to navigate the CatalogBrowser hierarchy.

ObjectName should be unique across the entire database to identify a node uniquely.
Name is the displayed name which appears in the CatalogBrowser hierarchy.

Smart 3D Equipment Reference Data Student Workbook 7

Lab 2: Catalog Hierarchy

3. Go the R-Hierarchy sheet and add the following entries. Remember to add the letter A to all
new records.

Note: RelationSource and RelationDestination entries are ObjectNames of the objects

participating in the relationship. A relationship can’t be made unless the objects mentioned
in Relationsource / RelationDestination columns are already created.

4. Go the R-ClassNodeDescribes sheet and add the following entry. Remember to add the letter
A to all new records.

Note: 'R-ClassNodeDescribes' is the relationship between an object from ClassNodeType

worksheet as RelationSource and another object which is a PartClass as
RelationDestination. RelationSource entries are ObjectNames of the objects participating in
the relationship. RelationDestination entries are names of the PartClasses sheets
participating in the relationship.

8 Smart 3D Equipment Reference Data Student Workbook

 Lab 2: Catalog Hierarchy

5. Copy the Vent Arrangement Class by doing the following:

Select the Vent Arrangement Sheet. Right Click to open the Move or Copy dialog box.
Enable the copy option. Select the OK button to copy the sheet before the GUIDs sheet.

6. Rename the sheet as TransformerType1.

Note: Make sure you do not add any blank space or special characters for the name.

7. Repeat the above steps to create the PipeRackType1 class.

8. Add ‘A’ on both classes as follows:

9. Save the changes to a new workbook called ModuleTypes1.xls. Remember to add the letter A
to all new records.

Smart 3D Equipment Reference Data Student Workbook 9

Lab 2: Catalog Hierarchy

10. Select Start -> All Programs -> Intergraph SmartPlant -> Database Tools -> Bulkload
Reference Data to run the Bulkload Utility.

11. Select the ModuleTypes1.xls Excel file under Excel files using the Add button.

12. Under Bulkload Mode options, select the A/M/D bulkload mode and uncheck “Update
Object Type Hierarchy and Catalog Views” option.

Note: “Update Object Type Hierarchy and Catalog Views” option is provided that will allow
the catalog administrator to choose when the Business Object Classification Hierarchy (BOC)
and catalog views are updated.

10 Smart 3D Equipment Reference Data Student Workbook

 Lab 2: Catalog Hierarchy

13. Under Catalog information area, select the server name and select the training catalog
databases. Last, define the path for the error log file and key in the symbol share location.

14. Select Load button to start the process.

15. Once the process is complete, go to the Common Task and run the Copy to Catalog command
to check the results.

Smart 3D Equipment Reference Data Student Workbook 11

Lab 2: Catalog Hierarchy

Note: The following steps should be performed if you skipped the Business Object
Classification Hierarchy (BOC) and catalog views update.

16. Open a session and go to the catalog task. Select the Catalog -> Generate Views option. The
system will display a message dialog. Select Yes button to continue.

Note: The following needs to be performed on a production catalog to ensure that the data set
is correct and consistent.

17. Run the Project Management Task. Select the Model in the hierarchy.

18. Select Tools -> Synchronize Model with the Catalog.

19. Uncheck the Synchronize Model with the Catalog option.

Note: You just need to update the views in the model.

12 Smart 3D Equipment Reference Data Student Workbook

 Lab 2: Catalog Hierarchy

20. Hit “OK” Button.

21. Once the process is complete. Right click on the model and select regenerate the report
database.

22. Hit “OK” Button.

Smart 3D Equipment Reference Data Student Workbook 13

Lab 3: Equipment Catalog Hierarchy

Lab 3: Equipment Catalog Hierarchy

Objective

After completing this lab, you will be able to:

 Add/Modify Equipment Catalog Hierarchy

Equipment Hierarchy
All the nodes (Classification folders) are ClassNodeType objects except for the leaf nodes which
are Smart Classes. A relation between two nodes can be created in the 'R-Hierarchy' worksheet.
A relation between a ClassNodeType object and a Smart Class can also be created in the 'R-
Hierarchy' worksheet.

In this lab, you will add a new smart class called Boiler Type1 into the equipment catalog
hierarchy. To create the classification folders as shown below, you must edit the Equipment
Excel workbook, which contain two sheets that control the hierarchy: ClassNodeType and R-
Hierarchy. When you add a smart class to the catalog hierarchy, you must update these sheets,
where necessary, in order to see the data in the Catalog task or Catalog browser dialog box.

CatalogRoot is the RootNode of the ReferenceData Catalog Browser. It cannot have a parent
node. It is a named-object. Similarly, Equipment is the root for the equipment hierarchy which
appears as a child of the CatalogRoot. Process (Customer) and Boilers Asm are the nodes to
facilitate the easy browsing. Boiler Type1 is the Smart Class.

1. Open the Equipment.xls Excel workbook. The Equipment.xls can be found at C:\Program
Files (x86)\Smart3D\CatalogData\BulkLoad\DataFiles

2. Go the ClassNodeType sheet and add the following entries. Remember to add the letter A to
all new records.

Note: This sheet describes the nodes used to navigate the CatalogBrowser hierarchy.

ObjectName should be unique across the entire database to identify a node uniquely.

14 Smart 3D Equipment Reference Data Student Workbook

 Lab 3: Equipment Catalog Hierarchy

Name is the displayed name which appears in the CatalogBrowser hierarchy.

3. Go the R-Hierarchy sheet and add the following entries. Remember to add the letter A to all
new records.

Note: RelationSource and RelationDestination entries are ObjectNames of the objects

participating in the relationship. A relationship can’t be made unless the objects mentioned
in Relationsource / RelationDestination columns are already created.

4. Copy the StorageTankAsm sheet by doing the following:

Select the StorageTankAsm Sheet. Right Click to open the Move or Copy dialog box. Enable
the copy option. Select the OK button to copy the sheet before the GUIDs sheet.

5. Rename the sheet as BoilerType1.

Note: Make sure you do not add any blank space or special characters for the name.

Smart 3D Equipment Reference Data Student Workbook 15

Lab 3: Equipment Catalog Hierarchy

6. Edit the Partclass definition as follows:

Definition PartClassType SymbolDefinition UserClassName OccClassName

a EquipmentAssemblyClass Boiler Type 1 Boiler Type 1

Note: The UserClassName is also known as a definition class name. You can use this field to
provide a more meaningful name for the class or a name with blank spaces in it. This name
appears in the Catalog task and Catalog browser dialog box. The OccClassName appears in
the business object hierarchy on the Object Type tab on the Filter Properties dialog boxes.

7. For the parts, rename the name and description for both parts as follows:

Head Name PartDescription

Start
a BoilerType1 001A-E BoilerType1
a BoilerType1 001A_IMP-E BoilerType1

Also change the SymbolDefinition and Definition fields to use the Visual Basic symbol:

SymbolDefinition Definition

SP3DStorageTankAsm.CSTankSym SP3DStorageTankAsm.CSTankDef
SP3DStorageTankAsm.CSTankSym SP3DStorageTankAsm.CSTankDef

8. Save the changes to a new workbook called BoilerTypes.xls. Remember to add the letter A to
all new records.

Definition PartClassType SymbolDefinition

a EquipmentAssemblyClass

Head Name PartDescription

Start
a BoilerType1 001A-E BoilerType1
a BoilerType1 001A_IMP-E BoilerType1

9. Select Start -> All Programs -> Intergraph SmartPlant -> Database Tools -> Bulkload
Reference Data to run the Bulkload Utility.

16 Smart 3D Equipment Reference Data Student Workbook

 Lab 3: Equipment Catalog Hierarchy

10. Select the BoilerTypes.xls file under Excel files using the Add button.

11. Under Bulkload Mode options, select the A/M/D bulkload mode and uncheck “Update
Object Type Hierarchy and Catalog Views” option.

Note: “Update Object Type Hierarchy and Catalog Views” option is provided that will allow
the catalog administrator to choose when the Business Object Classification Hierarchy (BOC)
and catalog views are updated.

Smart 3D Equipment Reference Data Student Workbook 17

Lab 3: Equipment Catalog Hierarchy

12. Under Catalog information area, select the server name and select the training catalog
databases. Last, define the path for the error log file and key in the symbol share location.

13. Select Load button to start the process.

14. Once the process is complete, go to the Equipment Task and place the Boiler Type1.

18 Smart 3D Equipment Reference Data Student Workbook

 Lab 3: Equipment Catalog Hierarchy

Note: The following steps should be performed if you skipped the Business Object
Classification Hierarchy (BOC) and catalog views update.

15. Open a session and go to the catalog task. Select the Catalog -> Generate Views option. The
system will display a message dialog. Select Yes button to continue.

Note: The following needs to be performed on a production catalog to ensure that the data set
is correct and consistent.

16. Run the Project Management Task. Select the Model in the hierarchy.

17. Select Tools -> Synchronize Model with the Catalog.

18. Uncheck the Synchronize Model with the Catalog option.

Note: You just need to update the views in the model.

Smart 3D Equipment Reference Data Student Workbook 19

Lab 3: Equipment Catalog Hierarchy

19. Hit “OK” Button.

20. Once the process is complete. Right click on the model and select regenerate the report
database.

21. Hit “OK” Button.

20 Smart 3D Equipment Reference Data Student Workbook

 Lab 4: Working with the Custom Interface Sheet

Lab 4: Working with the Custom Interface Sheet

Objective

After completing this lab, you will be able to:

 Add User Defined Code List

 Add User Interfaces

Custom Interfaces
The Custom Interfaces sheet allows you to load a custom schema into the metadata of a catalog.
This sheet defines the customized user interfaces and attributes (properties) for the smart/part
classes in the workbook.

In this lab, you will add a new custom interface and three attributes for a smart class called
BoilerType2. Also, you will create a new code list table namespace called Inspection Points in
the catalog schema. Use the Custom Interfaces sheet to define the attributes names with
associated data type, unit type and code list table namespace as shown below:

Smart 3D Equipment Reference Data Student Workbook 21

Lab 4: Working with the Custom Interface Sheet

1. Open the AllCodeList.xls Excel workbook. The AllCodeList.xls can be found at C:\Program
Files (x86)\Smart3D\CatalogData\BulkLoad\DataFiles

2. Copy the WasherType worksheet into a new workbook by doing the following:
Select the WasherType sheet. Right Click to open the Move or Copy dialog box. In the “To
book:” field, select (new book). Enable the copy option. Select the OK button.

3. Create a User defined Code List as follows:

Note: The limit for a codelist name is 64 characters. You cannot use blanks or special
characters for the codelist name.

4. Save the workbook as InspectionPointsCodelist.xls.

5. Open the BoilerTypes.xls Workbook.

22 Smart 3D Equipment Reference Data Student Workbook

 Lab 4: Working with the Custom Interface Sheet

6. Go the R-Hierarchy sheet and add the following entry.

7. Copy the BoilerType1 Smart Class by doing the following:

Select the BoilerType1 Sheet. Right Click to open the Move or Copy dialog box. Enable the
copy option. Copy the sheet next to GUIDs sheet.

8. Rename the sheet as BoilerType2

9. Rename UserClassName and OccClassName in the partclass Definition as follows:

UserClassName OccClassName

Boiler Type 2 Boiler Type 2

10. Change the name and description for both parts as follows:

Head Name PartDescription

Start
a BoilerType2 001A-E BoilerType2
a BoilerType2 001A_IMP-E BoilerType2

Smart 3D Equipment Reference Data Student Workbook 23

Lab 4: Working with the Custom Interface Sheet

11. Create a new interface called IJUABoilerSpecs. Go to the Custom Interface sheet and add the
following entries

InterfaceName CategoryName AttributeName AttributeUserName Type

IJUABoilerSpecs Equipment Dimension MaxPressure Maximum Allowable Pressure Double

MaxTemp Maximum Allowable Temperature Double
InspectionPoints Inspection Points Long

UnitsType PrimaryUnits CodeList codelistt OnPropertyPage ReadOnly SymbolParameter

27 182 TRUE FALSE

5 104 TRUE FALSE
0 0 InspectionPoints UDP TRUE FALSE

Note: Values for UnitsType and PrimaryUnits can be found on the UOM worksheet in
AllCommon.xls found in <SP3D Installation Folder>\CatalogData\Bulkload\Datafiles.

Note: An interface is a collection of attributes. A complete interface definition includes one

or more attribute names with associated data type, unit type, and optional symbol parameter.
The appropriate unit type and the primary unit values are found using the AllCommon.xls
workbook. The Category Names are listed in the Property Categories codelist. The codelist
namespace for user-defined codelists is UDP.

12. Go to the BoilerType2 Smart Class Definition and insert the following data:

Note: Occurrence attributes are interpreted by the identifier ‘OA:’ and are defined along
with the definition of the SmartClass in the SmartClass worksheets.
An attribute with the same name can exist on more than one interface. On our smart class
sheet, you can scope the user attributes based on their interfaces and symbol parameters.
The scoping syntax is Interface::UserAttribute<Symbol Parameter>.

NOTE: The OA:MaxPressure and the MaxPressure DO NOT have to be on the same
columns. Add the OA’s to first available Column in the Part Class Row and add the
MaxPressure in the first available column for the Headers.

24 Smart 3D Equipment Reference Data Student Workbook

 Lab 4: Working with the Custom Interface Sheet

13. Save the changes and use the Bulkload Utility to load the new class and codelist.
Remember to add the letter A to all sheets.

Server_name

Server_name

\\Server_name\SharedContent

14. Once the bulkload process is complete, run the Project Management Task. Select the
Model in the hierarchy.

Smart 3D Equipment Reference Data Student Workbook 25

Lab 4: Working with the Custom Interface Sheet

15. Select Tools -> Synchronize Model with the Catalog.

16. Uncheck the Synchronize Model with the Catalog option.
Note: You just need to update the views in the model.

17. Hit “OK” Button.

18. Once the process is complete. Right click on the model and select regenerate the report
database.

19. Hit “OK” Button.

26 Smart 3D Equipment Reference Data Student Workbook

 Lab 4: Working with the Custom Interface Sheet

20. Go to the Equipment Task and place the BoilerType2. Use the Equipment Properties page
and review the attributes.

Smart 3D Equipment Reference Data Student Workbook 27