You are on page 1of 45

SmartPlant Reference Data

How to Add Components for SmartPlant 3D

Version 2008.7 (6.3.8)

March 2010

DMAR1-PE-200139A

Copyright
Copyright 2010 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 ("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 Overview ....................................................................................................................................................... 7 Process Workflow Diagram ...................................................................................................................... 10 Creation of a New Component ................................................................................................................. 12 Analysis ................................................................................................................................................. 12 Commodity Group ................................................................................................................................. 12 Commodity Part .................................................................................................................................... 13 Commodity Rule ............................................................................................................................. 13 PartClass Sheet.............................................................................................................................. 15 Commodity Part Creation ............................................................................................................... 19 Object Parameter .................................................................................................................................. 20 Commodity Code (size-independent properties) .................................................................................. 20 Ident (size-dependent properties) ......................................................................................................... 24 Geometric ....................................................................................................................................... 24 Geometric Relation ......................................................................................................................... 27 Ident Creation ................................................................................................................................. 29 Operator ................................................................................................................................................ 30 New Operator Sheet ....................................................................................................................... 32 Template/Config Setup ................................................................................................................... 34 Item Mappings ................................................................................................................................ 38 Export to Excel Sheet................................................................................................................................ 40 Index ........................................................................................................................................................... 45

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Contents

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Preface
This document is a users guide for SmartPlant Reference Data 2008.7 (6.3.8). It describes the required actions to add a new component in SmartPlant Reference Data based on the SDB dataset, ready for SmartPlant 3D. The basic requirements will be explained and a comprehensive example will be given in order to provide a sufficient understanding of the necessary steps. Basic knowledge in SmartPlant Reference Data and in the SmartPlant 3D Excel Sheets/Codelists is required. The user has to be familiar with the SmartPlant Reference Data procedures for Commodity Code, Ident, and Geometric Table generation.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Preface

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Overview
This document describes the needed actions in SmartPlant Reference Data to add a new component with all required data for use in SmartPlant 3D. The process of adding a new component will be demonstrated using the example of a manufacturer specific Ball Valve with a lever operator as a special component. Ball valve (VCK-41) / #150 (AH-35) / Raised Face End (AB-21) / ANSI-B16.34 (AAT-64) / Lever operator (IQ-10305), Dimension Face to Face acc. to ASME B16.10-1986 (Long Pattern Dim. A page 7) / Dry Weight and Valve Height acc. to Velan (VEL-BV-93 page15-Full Port)

Dimensional data
Nom Size 1 0.5 0.75 1 1.25 1.5 2 2.5 3 4 6 8 10 Unit in in in in in in in in in in in in Nom Size 2 0.5 0.75 1 1.25 1.5 2 2.5 3 4 6 8 10 Unit in in in in in in in in in in in in FtF 4.25in 4.62in 5in 5.5in 6.5in 7in 7.5in 8in 9in 15.5in 18in 21in Height 3.49in 4.09in 4.21in 4.5in 4.85in 5.44in 6.97in 7.38in 10.33in 12.56in 13.06in 18.84in Dry Weight 4.4lbm 6.6lbm 8lbm 12lbm 14.9lbm 24lbm 44lbm 52lbm 90lbm 196lbm 420lbm 762lbm

These ball valves can have different operator types. Example (SymbolDefinition) = Operator10005.COperator10005

Operator Type 10005


0.5 - 1.25in 1.5 - 3in 4 - 6in 8in - 10in Operator Height = Valve Height + 0.525in Operator Height = Valve Height + 0.7in Operator Height = Valve Height + 1.05in Operator Height = Valve Height + 1.4in OpDim1 = 1.5in OpDim1 = 2in OpDim1 = 3in OpDim1 = 4in

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Overview

Overview of the needed SP3D sheets and their relations

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Overview

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Process Workflow Diagram

Process Workflow Diagram

10

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Process Workflow Diagram

SmartPlant Reference Data How to Add Components for SmartPlant 3D

11

Creation of a New Component

Creation of a New Component


Analysis
The type of the new component is Ball Valve. The valve has an operator of type lever. The component is described by multiple properties, grouped by: size-independent properties size-dependent properties operator size-dependent properties On the basis of the size-independent properties, and with the use of SPRD Explorer, the SDB data set must now be checked for existing and matching Commodity Groups and Parts.

Commodity Group

The existing Commodity Group VB is suitable to hold the new component.

12

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


To create new Commodity Groups, use screen S.10.02.

Commodity Part

The existing Commodity Parts in Group VB do not fulfill all requirements for the new component with regard to the assigned Commodity Rule and/or SP3D Partclass Sheet, so the new Part X with the description Ball Valve Special must be created.

Commodity Rule

A Commodity Rule must be assigned to the Part, so first check the existing records in S.10.01 to find any matching Commodity Rule that covers all the size-independent properties of the new component.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

13

Creation of a New Component


If no matching Commodity Rule is available, a new Rule must be created prior to the creation of the new Part.

The existing rule P_VLV_W_OP for Valves with Operator contains all needed size-independent properties.

14

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


These are the rule details:

PartClass Sheet

All Commodity Parts that are intended for the use in SmartPlant 3D must be assigned to a SP3D PartClass. Therefore, the next step is to check the existing Sheet definitions on screen SP3D 10.07. As there is no appropriate sheet available, we create a new PartClass sheet definition of category PART_DEFINITION for the new Part Ball Valve Special, using SP3D 10.02 and SP3D 10.07.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

15

Creation of a New Component


To create a new Sheet on SP3D 10.02, simply copy an existing Sheet that is similar to the new one. The cursor has to be positioned on the sheet to be copied, and then pressing F6 (new record) and F4 (duplicate record above) creates a copy of that record. Renaming and then saving it creates the new sheet BallValve Special of category PART_DEFINITION.

The screen SP3D 10.07 is used to maintain the Sheet Configs. These are named set of sheets with their attributes that will be assigned to export jobs. The new PartClass Sheet BallValve Special must be assigned to the relevant Sheet Config, with all needed attributes. For a PartClass, it would consist of a definition section, the column headers, and the lines with the column values. To keep it simple and to avoid entering the details manually, position the cursor in the second block on the original sheet youve used before on SP3D 10.02 to create the new sheet. Use F6 (new record) and F4 (duplicate record above) to create a copy of that record including all details. Before saving that record, the Sequence in field Seq has to be modified to make it unique. Then the Sheet has to be renamed by means of the LOV (List of values). Selecting the new Sheet Ball Valve Special and acknowledging with OK changes the Sheet to the new name.

16

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


After saving the record, the copied details of the new sheet are displayed in the third block.

On the basis of the existing PartClass sheet BallValve, the attribute properties and default values can be checked and modified when necessary.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

17

Creation of a New Component

Definition Section

Column Headers and Values

18

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Commodity Part Creation


Now the new Part X Ball Valve Special can be created in S.10.03, with the Commodity Rule P_VLV_W_OP and the SP3D Part Class BallValve Special assigned.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

19

Creation of a New Component

Object Parameter

The Object Parameter is a link between commodity code and geometric tables to define the needed set of size-dependent data for Ident creation. The size of the new part Ball Valve Special is exactly identified by the Nominal Size 1, so an Object Parameter with NPS1 as input value has to be assigned. We assign the existing Object Parameter P_1N_E to Part X.

Commodity Code (size-independent properties)

Creating a Commodity Code for the new component is the next step. The Commodity Code is a rule-based generated code identifying the size-independent properties of a component.

20

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


The new Commodity Code is built using the assigned rule P_VLV_W_OP on S.30.01. After selecting the table details corresponding to the required properties, the Commodity Code VBXXACDRFACACDZZZZZZ is generated with its description and layout.

The Ball Valve Special Commodity Codes have SP3D relevant and other (for example, purchasing relevant) properties. The sources of the SP3D relevant properties are listed below. Dimensional Standard S.20.02, table P_DIM_STD When table groups/details are not available to describe the Commodity Code property Dimensional Standard, they have to be created using S.20.01/S.20.02. The value entered for attribute Geostd identifies the Codelist Number of the Geometric Industry Standard. It is mapped to field GeometricIndustryStandard of BallValveSpecial PartClass sheet.

Materials S.20.02, table P_MATERIAL When table groups/details are not available to describe the Commodity Code property Material, they have to be created using S.20.01/S.20.02.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

21

Creation of a New Component


The value entered for attribute Base_Mat identifies the Codelist Number of the Materials Grade. It is mapped to field MaterialGrade of BallValveSpecial PartClass sheet.

Rating SP3D.10.04, independent mapping, Attribute PressureRating CommodityCodes with property Rating = D -> Class 150 are mapped to PressureRating CL150 -> Codelist Number 35. The value entered in field Cdlst Number identifies the Codelist Number of the Pressure Rating. It is mapped to field PressureRating[n] of BallValveSpecial PartClass sheet.

End Preparation SP3D.10.04, independent mapping, Attribute EndPreparation CommodityCodes with property EndPrep = RF -> raised face are mapped to EndPreparation Raised-face flanged end -> codelist Number 21. The value entered in field Cdlst Number identifies the Codelist Number of the End Preparation. It is mapped to field EndPreparation[n] of BallValveSpecial PartClass sheet.

22

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


Valve Operator S.20.08, PDS_MODIFIER The component property Valve Operator is linked to a table detail of table PDS_MODIFIER using S.20.08. Non existing table details of PDS_MODIFIER can be created in S.20.I.03. For example, we can create table detail 10005 within table group VALVES.

In S.20.08, this part table detail will be assigned to the part Ball Valve Special. Next a link will be created to the Commodity Code property P_VLV_OPERATOR, which identifies the type of operator.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

23

Creation of a New Component


Using the button Show Commodity Codes lists all matching Commodity Codes in the bottom block.

Ident (size-dependent properties)


Geometric

Standard Geometrics holding all size-dependent data are the basis for building Idents. The structures of the geometric tables are defined in screen A.50.03. For our example, we need a table name with the structure: NPS1 Face to Face Valve Height Dry Weight - Input_1 - Output_1 - Output_2 - Output_3

24

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


First, create a new table name of type GEOM_S4012 in A.50.02. Or use an existing table name which is similar to the new, copy it using F6 (new record) and F4 (duplicate record above), and rename the table name.

Attributes that are not available must be defined in A.50.01 underneath Attribute Group GEOM ATTRS.

Next define the structure of the table using A.50.03. Appropriate Attributes for the size-dependent properties must be assigned to database columns input_1 to _5 or output_1 to _15.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

25

Creation of a New Component


Finally, a geometric table has to be created using the before defined table name P_VB_SP_1NPS in S.40.12, and the geometric data must be filled in.

26

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Geometric Relation

To link the Commodity Code with the Geometric Table that is used for Ident Creation, the so-called Geometric Relation must be established. Define a Geometric Rule in S.40.21 and assign the Geometric P_VB_BVS_1 to Part X Ball Valve Special. Click Commodity Relation to create the relation.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

27

Creation of a New Component


Check the result in S.40.22.

28

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Ident Creation

Based on the geometric and the geometric relation created before, the Idents for the new Commodity Code can now be built using S.80.01.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

29

Creation of a New Component


Now all needed actions are done in SmartPlant Reference Data for the component Ball Valve itself, without the definition of the operator. To check the intermediate result, you can create an Export job in SP3D.20.01 and export the BallValve_Special sheet. The details of an Export job are described in the Export to Excel Sheet chapter. The result for the described example should look like the sheet below.

Operator
The definition of the Ball Valve itself is completed, and now the operator has to be configured. The Operator Type 10005 is needed, with SymbolDefinition Operator10005.COperator10005. 0.5 - 1.25in 1.5 - 3in 4 - 6in Operator Height = Valve Height + 0.525in Operator Height = Valve Height + 0.7in Operator Height = Valve Height + 1.05in OpDim1 = 1.5in OpDim1 = 2in OpDim1 = 3in

8in - 10in Operator Height = Valve Height + 1.4in OpDim1 = 4in For the Operator definition, these sheets are needed and have to be defined or updated:

30

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Operator10005

PipingCommodityMatlControlData

SmartPlant Reference Data How to Add Components for SmartPlant 3D

31

Creation of a New Component

ValveOperatorMatlControlData

New Operator Sheet


As there is no appropriate sheet available for the operator 10005, we create a new sheet definition of category GENERAL_LIST, using SP3D 10.02 and SP3D 10.07. To create a new Sheet in SP3D 10.02, simply copy an existing Sheet that is similar to the new one. The cursor has to be positioned on the sheet to be copied, and F6 (new record) and F4 (duplicate record above) creates a copy of that record. Renaming and then saving it creates the new sheet Operator10005 of category GENERAL_LIST.

32

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Assign Operator Sheet to Sheet Config


In screen SP3D 10.07, new Sheet Operator10005 has to be assigned to the relevant Sheet Config, with all needed attributes. To keep it simple and to avoid entering the details manually, position the cursor in the second block on the original sheet youve used before in SP3D 10.02 to create the new sheet. Use F6 (new record) and F4 (duplicate record above) to create a copy of that record including all details. Before saving that record, the Sequence in field Seq has to be modified to make it unique. Then the Sheet has to be renamed by means of the LOV (List of value). Selecting the new Sheet Operator10005 and acknowledging with OK changes the Sheet to the new name.

After saving the record, the copied details of the new sheet are displayed in the third block. When new attributes are required, these have to be added, and using LOV (List of Values) or F3 (duplicate filed above) eases the input.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

33

Creation of a New Component


Target: Sheet Operator10005

Template/Config Setup

ValveOperatorType Sheet
In SP3D.10.08, the new operator 10005 must be added to the sheet ValveOperatorType. Later it will be assigned to sheet ValveOperatorMatlControlData. See corresponding paragraph below.

34

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component


Target: Sheet ValveOperatorType

ValveOperatorGeometricIndStd Sheet
In SP3D.10.08, the new operator 10005 must be added to the sheet ValveOperatorGeometricIndStd.

Target: Sheet ValveOperatorGeometricIndStd

SmartPlant Reference Data How to Add Components for SmartPlant 3D

35

Creation of a New Component

ValveOperatorMatlControlData Sheet
In SP3D.10.08, the Commodity Code of the Ball Valve Special VBXXACDRFACACDZZZZZZ must be added to the sheet ValveOperatorMatlControlData, as OperatorPartNumber, and with ValveOperatorType 10005.

Target: Sheet ValveOperatorMatlControlData

36

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

Add Operator Sheet to Template


Next the sheet has to be added to the template, using SP3D.10.08. Select the correct template and create a new record in the Sheets block. Use the LOV to select the new sheet Operator10005.

After saving the record, the copied details of the new sheet are displayed in the Data block. These are the operator size-dependent properties, and the values can now be entered in that block.

SmartPlant Reference Data How to Add Components for SmartPlant 3D

37

Creation of a New Component

Item Mappings

PipingCommodityMatlControlData Sheet
ValveOperatorCatalogPartNumber
In SP3D.10.04, a new record has to be added with Attribute ValveOperatorCatalogPartNumber to map the Ball Valve CommodityCode with the correct operator, coming from ValveOperatorMatlControlData.

38

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Creation of a New Component

ValveOperatorGeoIndStd
In SP3D.10.04, a new record has to be added with Attribute ValveOperatorGeoIndStd to map the Ball Valve Commodity Code with the correct operator, coming from ValveOperatorGeoIndStd.

Target: Sheet PipingCommodityMatlControlData

SmartPlant Reference Data How to Add Components for SmartPlant 3D

39

Export to Excel Sheet

Export to Excel Sheet


To create the Excel Sheets for SmartPlant 3D import, an export job has to be defined and then launched in SP3D.20.01.

The Destinations are defined in SP3D.10.05. The Transfer Types are defined in SP3D.10.06. Item Mappings are defined in SP3D.10.04. Configs are defined in SP3D.10.01.

40

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Export to Excel Sheet


Clicking Start Job will launch the pre-defined export job.

The Progress of the job can be monitored in Progress tab folder rightmost. In case of job termination due to an error, open the tab folder Logfiles and double-click the logfile name to open and analyze it. For the details of possible error messages, read the document Troubleshooting SmartPlant 3D Export Jobs (STO-SP3D-ERRs.pdf).

To review the created Sheets, open tab folder Workbooks and double-click the file name in field Workbook. It will open the Excel Sheet in a separate window.

As defined in the job setup, the workbook contains the sheets:

SmartPlant Reference Data How to Add Components for SmartPlant 3D

41

Export to Excel Sheet

BallValve Special

Operator10005

PipingCommodityMatlControlData

42

SmartPlant Reference Data How to Add Components for SmartPlant 3D

Export to Excel Sheet

ValveOperatorMatlControlData

SmartPlant Reference Data How to Add Components for SmartPlant 3D

43

Index
A
Add Operator Sheet to Template 38 Analysis 12 Assign Operator Sheet to Sheet Config 34

V
ValveOperatorGeometricIndStd Sheet 36 ValveOperatorMatlControlData Sheet 37 ValveOperatorType Sheet 35

C
Commodity Code (size-independent properties) 21 Commodity Group 12 Commodity Part 13 Commodity Part Creation 19 Commodity Rule 13 Creation of a New Component 12

E
Export to Excel Sheet 41

G
Geometric 25 Geometric Relation 28

I
Ident (size-dependent properties) 25 Ident Creation 30 Item Mappings 38

N
New Operator Sheet 33

O
Object Parameter 20 Operator 31 Overview 7

P
PartClass Sheet 15 PipingCommodityMatlControlData Sheet 39 Preface 5 Process Workflow Diagram 10

T
Template/Config Setup 35

SmartPlant Reference Data How to Add Components for SmartPlant 3D

45