smartplant reference data add components for intergraph ...spmat.hec.co.kr/marian_webentry/pdfs/sprd...

SmartPlant Reference Data Add Components for Intergraph Smart™ 3D

Version 2011 R1 (7.1.0)

November 2013

DMAR1-PE-200139B

Copyright Copyright © 2010-2013 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.

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 300 Intergraph Way Huntsville, AL 35813

Documentation Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides, Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a particular software product.

Other Documentation Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support, SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for using a software product.

Terms of Use a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the

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

b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid licenseagreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such disclaimer. 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, Documentation and Other Documentation discussed in this document are furnished under a license and may be used or copied only in accordance with the terms of this license. 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.

2 SmartPlant Reference Data Add Components for Intergraph Smart™ 3D

Limitation of Damages IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2) YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.

IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:

a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries. b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce

Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S. Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S. Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.

c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive nuclear uses.

d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place. e. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export

Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN, 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.

SmartPlant Reference Data Add Components for Intergraph Smart™ 3D 3

Contents Preface .......................................................................................................................................................... 7

Documentation Comments ..................................................................................................................... 7

Overview ....................................................................................................................................................... 9

Necessary Smart 3D Sheets and Relationships ................................................................................... 10

Work Process Diagrams ........................................................................................................................... 13

Create a Sight Glass Component ............................................................................................................ 17

Analyze the Commodity and Identify the Symbol ................................................................................. 17 Analyze the Group, Part, and Detail Tables ......................................................................................... 19 Create the Commodity Rule .................................................................................................................. 20 Create the Commodity Group and Part ................................................................................................ 26 Check if Table Details Exist .................................................................................................................. 27 Create the First Commodity Code ........................................................................................................ 27 Link the Geometrics to the Commodity Code ....................................................................................... 30 Add Short Code and Smart 3D Short Code .......................................................................................... 38 Define the Smart 3D Short Code .......................................................................................................... 39 Create the Sight Glass Codelist ............................................................................................................ 41 Add the Component to the Specification .............................................................................................. 42 SmartPlant Reference Data to Smart 3D Sheet Mapping .................................................................... 44

Define the Sheet and Sheet Configuration ..................................................................................... 45 Copy Sheets ................................................................................................................................... 49 Item and Table Mappings ............................................................................................................... 50 Export and Check Results .............................................................................................................. 53

Create a Ball Valve Component ............................................................................................................... 55

Analysis ................................................................................................................................................. 56 Commodity Group ................................................................................................................................. 57 Commodity Part .................................................................................................................................... 58

Commodity Rule ............................................................................................................................. 58 PartClass Sheet .............................................................................................................................. 59 Commodity Part Creation ............................................................................................................... 63

Object Parameter .................................................................................................................................. 64 Commodity Code (size-independent properties) .................................................................................. 65 Ident (size-dependent properties) ......................................................................................................... 69

Geometric ....................................................................................................................................... 69 Geometric Relation ......................................................................................................................... 71 Ident Creation ................................................................................................................................. 74

Operator ................................................................................................................................................ 75 New Operator Sheet ....................................................................................................................... 76 Template/Config Setup ................................................................................................................... 78 Item Mappings ................................................................................................................................ 83


Contents Export to Excel Sheet ................................................................................................................................ 87

Index ........................................................................................................................................................... 91


This document describes how to add a new component in SmartPlant Reference Data based on the SDB dataset, ready for Intergraph Smart™ 3D. The basic requirements are explained, and comprehensive examples are provided.

Basic knowledge about SmartPlant Reference Data and Smart 3D Excel sheets/codelists is required. You must be familiar with the SmartPlant Reference Data procedures for commodity codes, idents, and geometric table generation.

Documentation Comments Send documentation comments or suggestions to [email protected] (mailto:[email protected]?subject=documentation comments).

Preface


mailto:[email protected]?subject=documentation%20comments

Preface


S E C T I O N 1

This document describes the necessary actions in SmartPlant Reference Data to add a new component with all required data for use in Smart 3D.

The process of adding a new component will be demonstrated using two examples: 1) a sight glass and 2) a manufacturer-specific ball valve with a lever operator as a special component.

Overview


Overview

Necessary Smart 3D Sheets and Relationships


Overview


S E C T I O N 2

Work Process Diagrams


S E C T I O N 3

This section describes how to create a new component from scratch in SmartPlant Reference Data, using the example of a sight flow glass or sight flow indicator.

Analyze the Commodity and Identify the Symbol Referring to the Piping 3D Symbols Reference Guide, search for symbols or items that represent a sight glass or sight flow indicator.

Scroll through the symbols and Part Design Basis (PDB) to locate the PDB that represents the symbol you need and most importantly, where the PDB data maps to the data that is available on the product sheet.

Create a Sight Glass Component


Create a Sight Glass Component PDB 481 requires a face-to-face and sight diameter, in line with the product sheet.

The next step is to locate an example sheet for this symbol / PDB. Unfortunately, there is no correlation between the type as listed in the symbol description and the PDB. This is only available in the sheets.

Referring to Intergraph Smart Support Online (https://smartsupport.intergraph.com), find the Sight Glass / Flow indicator example sheets.

In the Piping\In-Line Fittings\In-line Instruments\Sight Flow Indicator folder, you will find sample data and images.

So based on PDB = 481, we need to review the Excel sample data to identify the sheet layout to be used.


https://smartsupport.intergraph.com/

Create a Sight Glass Component Check that this sheet is available in SmartPlant Reference Data on SP3D 10.02 Sheets and on SP3D 10.07 Sheet Configs.

Analyze the Group, Part, and Detail Tables A commodity codes in SmartPlant Reference Data is built based on a rule, which determines which table details are used to construct the commodity code.

A commodity code has the following important technical aspects that impact either the size of the fitting or its ability to connect to other items in a specification:

NPS

Dimension Standard or Manufacturer (P_DIM_STD)

Facing - End Connections (P_END_PREP)

Rating (P_RATING)

Material (P_MATERIAL)

Because these properties are key bits of data, they should reside within the commodity code.

In this example, the body consists of a glass tube, rings, seals, and rods, all of which can be made from various materials. But because none of this is important for the model or


Create a Sight Glass Component connections, all of this could be detailed in an alias code (one detail code for combinations of less important data).

Geometrics supplied by this one possible manufacturer are going to be used as a generic example. Clearly, if the sight glasses from various manufacturers differ in dimensions, the source of the dimensions should also form part of the commodity code.

Review the commodity groups and parts on S.10.03 Commodity Part.

A logical group for the sight glass could be Miscellaneous Piping MP.

Create the Commodity Rule Standard Database for SmartPlant Reference Data (SDB) has a set of commodity rules that cover over a million items. Review the existing rules on S.10.01

The SDB rules always contain two table details:

P_SYSTEM to indicate the “country” of the standards

P_MAT_SYSTEM to indicate the “country” of the material codes

In addition, the sight glass requires:

P_END_PREP for end preparation Raised Face Flange End

P_DIM_STD for the dimensional standard

P_MATERIAL for the material code

P_RATING for the rating of the flange

P_ALIAS for the other information, such as glass material

1. Open the S.10.01 Commodity Rules screen.

2. Click Run Query so that you see all the rules delivered in SDB

3. Scroll through the various rules to see if any of the rules fits the table detail requirements.



The P_RAT_FITT (Rating Fittings) rule could be used because it has all the required tables, assuming we put all the sight glass body material details in an alias table.

Before deciding on the rule, consider the rule structure (in particular, the number of

characters) and the group and part you are going to use.

4. Open the S.10.03 Commodity Part screen.

Looking at the commodity groups and parts, it would be best to add the sight glass under the Miscellaneous Piping (MP) group, with a new Part (SG).

There will be two characters for the commodity group and two characters for the

commodity part.

5. Return to the S.10.01 Commodity Rules screen, and select the P_RAT_FITT rule.



6. Click Go to next block twice to open Window 2.

This rule structure (commodity keys) does not suit us as it takes only one character from the commodity group and three characters from the commodity part, whereas the commodity group (MP) and the commodity part (SG) in our example have two characters. Because this might cause an inconsistency, we create a new rule.

7. Click Go to previous block twice to go back to Window 1.

8. To copy the existing rule, select the P_RAT_FITT rule and click New record (or press F6).

9. Press F4 to copy the previous rule, change the rule name to P_SIGHT_GL, and change the short description and the description to Sight Glass.



10. Click Save (or press F10).

11. Click Enter query (or press F7) and then press Run query (or press F8) to re-query the data to see the copied table details on the Commodity Attributes tab.

12. To assign table names to the rule, click Go to next block twice to open Window 2.


Create a Sight Glass Component 13. Select the second record with Digit Id = 2, click in the Tablename box, and

select M_COMMODITY_GROUPS from the LOV. Or, press F3 to copy the table name from the box above.

The P_ALIAS table was defined with Z in the Ins Char box. The assignment of a

P_ALIAS table detail is not required when defining a commodity code. If P_ALIAS is not assigned, Z will be used instead for digit 17 and 18 of the commodity code. (SDB has expanded P_ALIAS codes from three to four characters, and as a result, you will see commodity codes with ZZZ and others with ZZZZ).

14. Click Save (or press F10) to save the rule.



15. Click Go to next block to open Window 3 where you can view and edit the commodity code layout text.

16. Review the layout by removing unnecessary text (P_SYSTEM_SHORT/_LONG) and adding

commas.

17. Click Save (or press F10) to save the rule.

18. On the update message, click Yes.

You can use this functionality to update all commodity code descriptions if you decide to change the layout, but this will take time depending on how many commodity codes have been created with this rule.



Create the Commodity Group and Part If necessary, create the new commodity group on S10.02. The commodity groups are independent of disciplines; that is, the commodity groups must be unique across all disciplines.

From the analysis, we decided to add the SG commodity part to the existing MP commodity group.

1. Open the S.10.03 Commodity Part screen.

Ensure the screen is in query mode; that is, the fields in the first block are displayed with a yellow background.

2. Click List of values (or press F9) to select MP - Miscellaneous Piping from the list.

3. Click Run query (or press F8).

4. Click in the second (Commodity Parts) block.

5. Click New record (or press F6).

6. Type SG in the Part box.

7. Select the P_SIGHT_GLASS rule from the LOV in the Rule box.

8. Type Sight Glass in the Short Desc and Description boxes.

9. Scroll to the right, and click in the SP3D PartClass box.

10. Click List of values (or press F9), and select SightFlowIndicatorTy3 from the list.

The software maps the SG part to the SightFlowIndicatorTy3 part sheet.

11. Click Save (or press F10) to save the new part.



Check if Table Details Exist You can either check that all the relevant table details exist for the commodity codes you are going to create, or you can create them when you build the commodity codes.

Check to see if the following tables have detail entries for the values you require:

P_MATERIAL (Flange material)

P_RATING (Value for 150#)

P_END_PREP (Value for raised face)

P_DIM_STD (Value for the dimensional standard)

P_SYSTEM A (for US)

P_MAT_SYS A (for US material)

P_ALIAS This table is used to store the details not covered in the other tables. The alias can be created by choosing a unique code and then completing the required description (For example, Glass Tube - Borosilicate; O-Rings Seal – Viton; Tie-Rods – Stainless Steel; Fasteners – A2 Stainless Steel).

Create the First Commodity Code 1. Open the S.30.01 Commodity Codes screen.

2. Click Cancel query to place the screen in data entry mode; that is, the fields in the first block are displayed with a green background.

3. Click List of values (or press F9) to select MP - Miscellaneous Piping in the Group box.



4. Click List of values to select SG – Sight Glass in the Part box.

A temporary commodity code in CCnnnnn format is displayed as a placeholder.

Based on the rule attached to the commodity group or part, the tablenames assigned to the rule appear on the Details tab.

5. For each table, select the table group and detail using the LOV.

If only one table detail exists for the selected group, the software automatically inserts that detail and proceeds to the next table.

The P_ALIAS table is not displayed, because it was defined as optional (Required check box not selected in the commodity rule).

6. Click in the row below P_MATERIAL, and open the LOV. The optional tables are displayed.

7. Select P_ALIAS from the list, and click OK.

8. Select the group from the LOV. Because there is only one record in this group, it is added.

9. Select any detail from the list. We will change it in the next step.

10. Click Save (or press F10) to save the row.

11. Double-click P_ALIAS in the Tablenames box.

The S.20.02 Tablenames with Details screen opens where you can edit the table details.



12. Click New record (or press F6).

13. Type a table detail code.

14. Type a description in the Short Desc and Description boxes to match the required data.

15. Click Save (or press F10) to save the row.

16. Close S.20.02 to go back to commodity code screen.

17. In the Group and Detail boxes, select the new table detail for the P_ALIAS table.

18. Click Save (or press F10) to save the changes.

19. Click .

The commodity code is built and appears in the Commodity Code box.

We must link this commodity code to an object parameter to indicate how many NPS

(nominal pipe size) and SCH (schedule) values are required. In this case, one NPS is required, NPS2 = NPS1.



20. Click List of values (or press F9) in the Object box and select P1N_E from the list.


The message "Do you want to assign this object parameter to your part?" appears.

22. Click Yes.

Link the Geometrics to the Commodity Code Geometrics must be linked to the commodity code.

1. Open the S.30.01 Commodity Codes screen.

2. Select the new commodity code you have created in the previous topic.

3. Select the Commodity Geometric Relations tab.



4. Click List of values (or press F9) in the Geometric box to select P_BI_1NPS.

5. In the Input_1 box, enter size range limits .5 to 8 (to limit the idents to the available range).


Face to Face Further geometrics are needed for the Smart 3D symbol: Face to Face and Glass Diameter.

1. Open the A.50.01 Attributes screen.



2. Select GEOM ATTRS from the LOV in the Group box, and click Run query (or press F8) to display the geometric attributes.

3. Identify the attributes to be used for Face to Face.

For most items in SDB, face to face is stored as P_F_TO_F (with unit in).

There is a face to face. but with unit -. It cannot be converted to other units on export to Smart 3D; therefore, use P_F_TO_F.

For the glass tube diameter, P_BODY_DIA attribute (whose unit is in) can be used.

4. Open the A.50.02 Tables screen, where the table structure can be created using these

attributes.

5. Select GEOM_S4010 from the Type drop-down list, and click Run query .

6. Click in the Name box in the second block, and click New record (or press F6) to create a new table.

7. Type P_SIGHT_GLASS in the Name box.

8. Type Sight Glass in the Short Desc and Description boxes.

9. Open the A.50.03 Tables/Attributes screen.


Create a Sight Glass Component 10. Query for the new table P-SIGHT_GLASS.

11. In the Attributes block, add records for these attributes (as displayed in the picture above):

Attr Name Physical Attribute Kind of Attribute

NPS1 GD.IN1 1. Nominal Size

P_F_TO_F GD.OUT1 Others

B_BODY_DIA GD.OUT2 Others

The attributes must have units of measure assigned to enable the conversions to take place on exports.


This creates a table layout that can be used to create geometrics tables of the same structure.

13. Open the S.40.10 Standard Geometrics screen.

14. Type P_SIGHT_GLSAA_PF in the Geometric box.

15. Click List of values (or press F9) in the Tablename box, and select P_SIGHT_GLASS from the list.

16. Click List of values (or press F9) in the Standard box, and select ANSI.

17. Click Save (or press F10) to save the new geometric.



18. Click Go to next block to open Window 2 where you can enter the geometric details.

19. Type .5 in the NPS1 box, and click Save to save this dummy record.

20. Click Print to File to export a blank workbook to Excel that can be modified and then re-imported.

21. Click Select in the Blocks to Write section.

22. Select Geom Details as shown below.

23. Click OK.


Create a Sight Glass Component 24. Select the Re-Importable check box.

25. Click OK.

A message prompts you to open the Excel workbook.

Make sure you have NPS1, P_F_TO_ F, and P_BODY_DIA in the correct columns.

Do not overwrite the [ ] and data within [ ].

26. Copy the IMP/MET to all rows you want to edit.

27. Type proper values in the NPS1, P_F_TO, and P_BODY_DIA cells.

28. Type 1 in the Ctrl cells.

29. Save the workbook in csv format and close Excel.


Create a Sight Glass Component 30. To re-import the geometric, make sure S.40.10 is opened and the correct geometric is

selected.

31. Click Print to File .

32. Select the Import tab.

33. Click Browse.

34. On the browser page, click Browse to find the import file.

35. Select the file and click Open.

36. On the browser page, click Submit Query to upload the file from the selected source folder to the application server for loading.

37. Select Insert, Update, and Ignore Error, and click OK.


Create a Sight Glass Component 38. Re-query to view the imported data.

39. Open the S.30.01 Commodity Codes screen, where you link this geometric to the

commodity code.

40. Select the Geometric tab.

41. Clear the Ident? check box.

42. Click List of values (or press F9) in the Geometric box, and select P_SIGHT_GLASS_PF from the list.

43. Click Save (or press F10) to save the new record.

The details of the geometric appear in the Geom Details block.



Add Short Code and Smart 3D Short Code Before you can add the commodity codes to the specification, SmartPlant Reference Data short codes and Smart 3D short codes must be available.

1. Open the S.10.08 Short Codes screen.

2. Click Run query and look for a short code for a sight glass.

3. If you do not find an appropriate short code, click New record (or press F6) to add a new row.

4. Type SGL in the Short Code box and Sight Glass in the Short Desc and Description boxes.

5. Click Go to next block to open Window 2.

6. On the Parts to Short Codes tab, select MP from the LOV in the Group box and SG from the LOV in the Part box.

This maps the SGL short code to the SG part.

7. On the Allowed Option Codes tab, select 1 from the LOV in the Option Code box

and SP3D from the LOV in the Usage box.

8. Select the SP3D Short Codes tab.



The software enters SGL by default, but this is not a valid Smart 3D short code.

9. Click List of values (or press F9) in the SP3D Short Code box, and select Sight Glass from the list.

If you don’t find the appropriate Smart 3D short code, follow the instructions in Define the Smart 3D Short Code (on page 39) to create a new short code.


Define the Smart 3D Short Code If the Smart 3D short code does not exist, create the short code as described in this topic.

1. Open the SP3D 10.08 Templates screen.

2. Query for the SDB_CODELISTS template.

3. In the Sheets block, click Enter query (or press F7), type Short% in the Sheet box,

and click Run query (or press F8).



The ShortCodeHierarchy and ShortCodeHierarchyRule sheets appear.

4. Review the ShortCodeHierarchy sheet, to see under which Short Code Hierarchy Class

this fits (Inline Fittings or Miscellaneous).

5. Scroll to the right to view the Short Code Hierarchy Type value.

It’s recommended to use Other Inline Fittings so we do not need to add anything more here.

6. Select the ShortCodeHierarchyRule sheet in the Sheets block.

No data appears in the Data block, because this sheet is maintained in the SDB_TEMPLATE template.

7. Click in the Template box and query for SDB_TEMPLATE.



8. In the Sheets block, click Enter query (or press F7), type Short% in the Sheet box,


The ShortCodeHierarchyRule sheet appears.

9. In the Data block, find short codes with Other Inline Fittings as the ShortCodeHierarchyType value.

10. Press F6 to insert a new row, press F4 to copy the row above, update the sequence number in the Seq box, and type Sight Glass in the ShortCode box.


Due to this change, you must export and load the sheet.

Create the Sight Glass Codelist Check to see if the sight class codelist is defined on the PipingCommodity sheet.

1. Open the SP3D 10.08 Templates screen.

2. Query for the SDB_CODELISTS template.

3. In the Sheets block, click Enter query (or press F7), type Piping% in the Sheet box,


The PipingCommodityOverrideOption and PipingCommodityTypes sheets appear.

4. Select the PipingCommodityTypes sheet.

5. Click in the Data block, click List of values in the Codelist Number box, and select 8865 from the list.



6. Click Run query (or press F8).

Add the Component to the Specification 1. Open the S.50.06 Specification Management screen.

2. Select the 1CA1S01 specification (or your copy of this specification).

3. Double-click in the Spec Code box to open Window 2.

4. Click New record (or press F6) to add a new row.

5. Type 900 in the Seq box, select SGL from the LOV in the Short Code box, select MP from the LOV in the Group box, select SG from the LOV in the Part box, select 1 from the LOV in the Option box, and select the commodity code displayed in the picture below from the LOV in the Commodity Code box.

6. Type .75 in the From 1 box and 8 in the To 1 box.




8. Click Build Idents to build the idents for the selected specification item.


The specification is now ready to export.



SmartPlant Reference Data to Smart 3D Sheet Mapping

Review the sheets you require based on the Smart 3D sample data.

Compare this to the corresponding sheets and configs in SmartPlant Reference Data:

SP3D 10.02 Sheets - Defined as GENERAL_LIST, not as PART_DEFINITION

SP3D 10.07 Sheet Configs - not yet defined



Define the Sheet and Sheet Configuration Before proceeding with the export operation, you must correct the SDB information in the sheets.

1. Open the SP3D 10.02 Sheets screen.

2. Click Enter query (or press F7), type Sight% in the Sheet box, and click Run query

(or press F8).

The SightFlowIndicator and the SightGlass sheets appear.

3. Change the Category value for all sheets to PART_DEFINITION.


5. Open the SP3D 10.07 Sheet Configs screen.

6. Query for the SDB_SHT_CONFIG configuration.

7. In the second (Sheets) block, query for SightFlowIndicatorTy3.

8. On the Attributes tab, review the Default Value and Source columns, which indicate the sheet has not been configured.

Reviewing the sample data, you can see there are a number of items that are constant for the sheet:



Commodity type = 8865

Geometry type = 15

SymbolDefinition = SP3DSightFlowIndicator.SightIndicator

On the sheet header:

SymbolIcon = SymbolIcons\SP3DSightFlowIndicatorPDB481.gif

PartClassType = PipeComponentClass

9. Select the Definition Attributes tab.

10. Check that the correct PartClassType and SymbolIcon values are set as displayed below.

11. Select the Attributes tab.

12. Set the Default Value box as described below and displayed in the pictures (null means empty).

CommodityType = 8865

GeometryType = 15 (Codelist Number selected)

TechDeliveryConditions = null (Codelist Number selected)

SymbolDefinition = SP3DSightFlowIndicator.SightIndicator

LiningMaterial = null (Codelist Number selected)

PartDataBasis = 481 (Codelist Number selected)



SurfacePreparation = null (Codelist Number selected)

ManufacturingMethod = null (Codelist Number selected)

PipingPointBasis[1] = 15 (Codelist Number selected)

Id[1] = null

PressureRating[1] = null (Will be done by mappings)

EndPreparation[1] = null (Codelist Number selected)

EndStandard[1] = null (Codelist Number selected)

ScheduleThickness [1] = null

FlowDirection[1] = 3

PipingPointBasis[2] = 15

PressureRating[2] = null (Will be done by mappings)

EndPreparation[2] = null (Codelist Number selected)

EndStandard[2] = null (Codelist Number selected)

ScheduleThickness[2] = null

FlowDirection[2] = 3

The rest of the defaults are empty.

13. Scroll to the right until you can see the Retrieval Method and Source columns.


Create a Sight Glass Component 14. Adjust the Retrieval Method and Source values as displayed in the pictures below.


Create a Sight Glass Component 15. For ScheduleThickness[2], enter the same as for ScheduleThickness[1] as shown in

the Editor box above.

Npd[1] = m_pck_sp3d_custom.get_nps_converted(cc.commodity_id,1,i.input_1)

NpdUnitType[1] = m_pck_sp3d_custom.get_sp3d_uom

Npd[2] = m_pck_sp3d_custom.get_nps_converted(cc.commodity_id,1,i.input_1)

NpdUnitType[2] = m_pck_sp3d_custom.get_sp3d_uom

FacetoFace = m_pck_sp3d_custom.get_cgr_attr_value(i.ident,'P_F_TO_F',null)

SightDiameter = m_pck_sp3d_custom.get_cgr_attr_value(i.ident,'P_BODY_DIA',null)

16. Make sure all Suppress Repetition boxes are cleared.


Copy Sheets If you require new sheets that do not already exist in SDB, use the Copy function.

1. Create the new sheet on SP3D 10.02 Sheets.

2. Open SP3D 10.07 Sheet Configs,


Create a Sight Glass Component 3. Select the sheet you want to copy, right-click it, and select Copy Sheet.

The sheet to copy appears in the first (Copy sheet from) row.

4. In the second (to) row, use the LOV to select the config and the sheet where the selected

sheet should be copied.

5. Click Copy to copy the selected sheet.

Item and Table Mappings The remaining data must come from the commodity codes or their table details (properties). For this purpose, the item and table mapping must be defined.

1. Open the SP3D 10.04 Items Mappings screen.

2. In the first (Item Mappings) block, query for SDB_ITEM_MAPPINGS.

3. On the Sheet Dependent tab, query for SightFlowIndicatorTy3.

4. If it does not exist, click New record (or press F6) to add a new row, select SightFlowIndicatorTy3 from the LOV in the Sheet box, and select PART_DEFINITION from the Category drop-down list.


6. On the Sheet Mapping tab, use the LOVs to select MP in the Group box and SG in the Part box.



This creates the mapping of the SG part to the SightFlowIndicatorTy3 sheet.

7. Open the Independent tab.

8. Based on what you have selected for your commodity code details, check the mappings for End Prep, End Standard, Pressure Rating[1] and [2].

The part sheet is now covered, but there are other sheets that need items mapped.


Create a Sight Glass Component 9. On SP3D 10.04 Items Mappings, query for the PipingCommodityFilter sheet.

10. Select the Attribute Mapping tab.

11. Click New record (or press F6) to add a new row, select SelectionBasis from the LOV in the Attribute box, enter MP in the Group box and SG in the Part box, and type 5 in the Cdlst Number box.

Setting SelectionBasis to 5 means the flange selection logic is enabled. That is, a mating flange will be selected automatically when placing a single flange in Smart 3D.

12. In the same way, add a new row for the BendRadiusMultiplier attribute and type 5, 10, or 15 (depending on the project requirement) in the Cdlst Number box.

13. On SP3D 10.04 Items Mappings, query for the PipingCommodityMatlControlData sheet.

14. Select the Attribute Mapping tab.

15. Add rows for the following attributes, with codelist numbers as listed below.

Attribute Codelist Number Comment

BoltingRequirements 5 bolting required

GasketRequirement 5 gasket required

WeldingRequirement 50 none of the ends require welding

FabricationType 5 by pipe fabricator

FirstSizeFrom .5

FirstSizeTo 8

FirstSizeUnits in



Export and Check Results The best way to review the results is to export the relevant sheets to a test destination, using the workbook only.

1. Open the SP3D 20.01 Export Jobs screen.

2. Click New record (or press F6) to create a new job.

3. Type a name in the Job box.

4. Select a destination, transfer type, item mapping, template, and config from the LOVs in the corresponding boxes.

5. Select WRITE_TO_FILE from the Job Goal drop-down list.

6. Click Save (or press F10) to save the new job.

A message appears, asking whether the sheets belonging to the transfer type should be inserted.

7. Click No.



8. On the Selected Sheets tab, click List of values in the Sheet box, and select the following sheets.

9. On the Selected Spec Items tab, click List of values in the Spec Code box, and select your specification from the list.


11. Click Start Job to run the export job.

After the job completes, review the exported sheet to confirm all is as expected.

12. Go to the last export job using the API and create a new export.

Or, bulk load into Smart 3D.


S E C T I O N 4

The following section shows how to create a component using the example of a manufacturer-specific ball valve with a lever operator as a special component.

Component description 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 Unit Nom Size 2 Unit FtF Height Dry Weight

0.5 in 0.5 in 4.25in 3.49in 4.4lbm

0.75 in 0.75 in 4.62in 4.09in 6.6lbm

1 in 1 in 5in 4.21in 8lbm

1.25 in 1.25 in 5.5in 4.5in 12lbm

1.5 in 1.5 in 6.5in 4.85in 14.9lbm


2.5 in 2.5 in 7.5in 6.97in 44lbm



6 in 6 in 15.5in 12.56in 196lbm

8 in 8 in 18in 13.06in 420lbm

10 in 10 in 21in 18.84in 762lbm

These ball valves can have different operator types.

Example (SymbolDefinition) = Operator10005.COperator10005

Operator Type 10005

0.5 - 1.25in Operator Height = Valve Height + 0.525in OpDim1 = 1.5in

Create a Ball Valve Component


Create a Ball Valve Component 1.5 - 3in Operator Height = Valve Height + 0.7in OpDim1 = 2in

4 - 6in Operator Height = Valve Height + 1.05in OpDim1 = 3in

8in - 10in Operator Height = Valve Height + 1.4in OpDim1 = 4in

Analysis The type for 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


Create a Ball Valve Component On the basis of the size-independent properties, and with the use of SmartPlant Reference Data Explorer, the SDB data set must be checked for existing and matching commodity groups and parts.

Commodity Group The existing commodity group, VB, is suitable for the new component.

To create new commodity groups, use 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 Smart 3D part class sheet, so a 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 on S.10.01 to find any matching commodity rule that covers all the size-independent properties of the 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 the necessary size-independent properties.


Create a Ball Valve Component Here are the rule details:

PartClass Sheet All commodity parts intended for use in Smart 3D must be assigned to a part class. Therefore, the next step is to check the existing sheet definitions on SP3D 10.07.

Because there is no appropriate sheet available, we create a new part class sheet definition with category PART_DEFINITION for the new part Ball Valve Special, using SP3D 10.02 and SP3D 10.07.


Create a Ball Valve Component To create a new sheet on SP3D 10.02, simply copy an existing sheet that is similar to the new one. Position the cursor on the sheet to be copied, and then press F6 (new record) and F4 (duplicate record above) to create a copy of that record. Rename and then save it to create the new sheet called BallValve Special with category PART_DEFINITION.

SP3D 10.07 is used to maintain the sheet configurations, which are named sets of sheets with attributes that will be assigned to export jobs. The new part class sheet BallValve Special must be assigned to the relevant sheet configuration, with all necessary attributes. For a part class, the sheet configuration consists of a definition section, column headers, and 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 you’ve 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 the Seq box must be modified to make it unique. Then the sheet must 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.


Create a Ball Valve Component After the record is saved, the copied details of the new sheet are displayed in the third block.

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


Create a Ball Valve Component Definition Section

Column Headers and Values



Commodity Part Creation Now the new part X with description Ball Valve Special can be created on S.10.03, with the commodity rule P_VLV_W_OP and the part class BallValve Special assigned.



Object Parameter The object parameter is a link between a commodity code and geometric tables to define the necessary 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 the input value must be assigned. We assign the existing object parameter P_1N_E to part X.



Commodity Code (size-independent properties) The next step is to create a commodity code for the new component. A commodity code is a rule-based generated code identifying the size-independent properties of a component.

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

The Ball Valve Special commodity codes have Smart 3D relevant and other (for example, purchasing relevant) properties. The sources of the Smart 3D 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 must be created using S.20.01/S.20.02.



The value entered for the attribute Geostd identifies the Codelist Number of the Geometric Industry Standard. It is mapped to field GeometricIndustryStandard of the BallValveSpecial part class sheet.

Materials (S.20.02, table P_MATERIAL)

When table groups/details are not available to describe the commodity code property Material, they must be created using S.20.01/S.20.02.

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

Rating (SP3D.10.04, independent mapping, Attribute PressureRating)

Commodity codes 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 the BallValveSpecial part class sheet.

End Preparation (SP3D.10.04, independent mapping, Attribute EndPreparation)

Commodity codes 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 the BallValveSpecial part class sheet.

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 on S.20.I.03. For example, we can create table detail 10005 in table group VALVES.

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



Click the Show Commodity Codes button to view all matching commodity codes in the bottom block.

Ident (size-dependent properties) Geometric

Standard geometrics with all size-dependent data are the basis for building idents. The structures of the geometric tables are defined on A.50.03.

For our example, we need a table name with the structure:

NPS1 Input_1

Face to Face Output_1

Valve Height Output_2

Dry Weight Output_3


Create a Ball Valve Component First, create a new table name of type GEOM_S4012 on A.50.02. Or use an existing table name that is similar to the new one, copy it using F6 (new record) and F4 (duplicate record above), and rename the table name.

Attributes that are not available must be defined on A.50.01 in the 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.


Create a Ball Valve Component Finally, a geometric table must be created using the previously defined table name P_VB_SP_1NPS on S.40.12, and the geometric data must be filled in.

Geometric Relation To link the commodity code with the geometric table used for ident creation, a geometric relation must be established.


Create a Ball Valve Component Define a geometric rule on S.40.21 and assign the geometric P_VB_BVS_1 to the part X (Ball Valve Special). Click Commodity Relation to create the relation.


Create a Ball Valve Component Check the result on S.40.22.



Ident Creation Based on the geometric and the geometric relation, the idents for the new commodity code can now be built on S.80.01.

Now all necessary actions are completed 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 on SP3D.20.01 and export the BallValve_Special sheet. The details of an export job are described in Export to Excel Sheet (on page 87). The result for the described example should look like the sheet below.



Operator The definition of the ball valve itself is complete, and now the operator must be configured.

Operator Type 10005 is needed, with SymbolDefinition Operator10005.COperator10005.

0.5 - 1.25in Operator Height = Valve Height + 0.525in OpDim1 = 1.5in

1.5 - 3in Operator Height = Valve Height + 0.7in OpDim1 = 2in

4 - 6in Operator Height = Valve Height + 1.05in OpDim1 = 3in

8in - 10in Operator Height = Valve Height + 1.4in OpDim1 = 4in

For the operator definition, these following sheets are needed and must be defined or updated:

Operator10005

PipingCommodityMatlControlData


Create a Ball Valve Component ValveOperatorMatlControlData

New Operator Sheet Because there is no appropriate sheet available for operator 10005, we need to create a new sheet definition with category GENERAL_LIST, using SP3D 10.02 and SP3D 10.07.

To create a new sheet on SP3D 10.02, simply copy an existing sheet that is similar to the new one. Position the cursor on the sheet to be copied, and press F6 (new record) and F4 (duplicate record above) to create a copy of the record. Rename and then save it to create the new sheet Operator10005 with category GENERAL_LIST.



Assign Operator Sheet to Sheet Configuration On SP3D 10.07, the new sheet Operator10005 must be assigned to the relevant sheet configuration with all the necessary attributes.

To keep it simple and to avoid entering the details manually, position the cursor in the second block on the original sheet you’ve 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 number in the Seq box must be modified to make it unique. Then the sheet must be renamed by means of the LOV (list of value). Select the new sheet Operator10005 and acknowledge with OK to change the sheet to the new name.

After the record is saved, the copied details of the new sheet are displayed in the third block. When new attributes are required, these must be added, using the LOV (List of Values) or F3 (duplicate field above).


Create a Ball Valve Component Target: Sheet Operator10005

Template/Config Setup

ValveOperatorType Sheet On 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.


Create a Ball Valve Component Target: Sheet ValveOperatorType

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


Create a Ball Valve Component Target: Sheet ValveOperatorGeometricIndStd

ValveOperatorMatlControlData Sheet On SP3D 10.08, the commodity code for the Ball Valve Special, VBXXACDRFACACDZZZZZZ, must be added to the sheet ValveOperatorMatlControlData, as OperatorPartNumber, and with ValveOperatorType 10005.


Create a Ball Valve Component Target: Sheet ValveOperatorMatlControlData

Add Operator Sheet to Template Next, the sheet must 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.


Create a Ball Valve Component After the record is saved, the copied details of the new sheet are displayed in the Data block. These details are the operator size-dependent properties, and the values can now be entered in that block.



Item Mappings

PipingCommodityMatlControlData Sheet

ValveOperatorCatalogPartNumber On SP3D 10.04, a new record must be added with attribute ValveOperatorCatalogPartNumber to map the Ball Valve commodity code with the correct operator, coming from ValveOperatorMatlControlData.


Create a Ball Valve Component ValveOperatorGeoIndStd On SP3D 10.04, a new record must be added with attribute ValveOperatorGeoIndStd to map the Ball Valve commodity code with the correct operator, coming from ValveOperatorGeoIndStd.

Target: Sheet PipingCommodityMatlControlData


S E C T I O N 5

To create the Excel sheets for Smart 3D import, an export job must be defined and then launched on SP3D 20.01.

The destinations are defined on SP3D 10.05.

The transfer types are defined on SP3D 10.06.

Item mappings are defined on SP3D 10.04.

Configurations are defined on SP3D 10.01.

Export to Excel Sheet


Export to Excel Sheet Clicking Start Job launches the pre-defined export job.

The progress of the job can be monitored on the Progress tab on the right.

If the job terminates due to an error, open the Logfiles tab, and double-click the logfile name to open and analyze it. For more information about error messages, see Export Job Troubleshooting in the SmartPlant Reference Data Intergraph Smart™ 3D Interface User's Guide, available from the Printable Guides page in the software.

To review the created sheets, open the Workbooks tab, and double-click the file name in the Workbook box. The software opens the Excel sheet in a separate window.

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


Export to Excel Sheet BallValve Special

Operator10005


Export to Excel Sheet PipingCommodityMatlControlData

ValveOperatorMatlControlData


A Add Operator Sheet to Template • 81 Add Short Code and Smart 3D Short Code •

38 Add the Component to the Specification •

42 Analysis • 56 Analyze the Commodity and Identify the

Symbol • 17 Analyze the Group, Part, and Detail Tables

• 19 Assign Operator Sheet to Sheet

Configuration • 77

C Check if Table Details Exist • 27 Commodity Code (size-independent

properties) • 65 Commodity Group • 57 Commodity Part • 58 Commodity Part Creation • 63 Commodity Rule • 58 Copy Sheets • 49 Create a Ball Valve Component • 55 Create a Sight Glass Component • 17 Create the Commodity Group and Part • 26 Create the Commodity Rule • 20 Create the First Commodity Code • 27 Create the Sight Glass Codelist • 41

D Define the Sheet and Sheet Configuration •

45 Define the Smart 3D Short Code • 39

E Export and Check Results • 53 Export to Excel Sheet • 87

G Geometric • 69 Geometric Relation • 71

I Ident (size-dependent properties) • 69 Ident Creation • 74 Item and Table Mappings • 50 Item Mappings • 83

L Link the Geometrics to the Commodity

Code • 30

N Necessary Smart 3D Sheets and

Relationships • 10 New Operator Sheet • 76

O Object Parameter • 64 Operator • 75 Overview • 9

P PartClass Sheet • 59 PipingCommodityMatlControlData Sheet •

83 Preface • 7

S SmartPlant Reference Data to Smart 3D

Sheet Mapping • 44

T Template/Config Setup • 78

V ValveOperatorGeometricIndStd Sheet • 79 ValveOperatorMatlControlData Sheet • 80 ValveOperatorType Sheet • 78

W Work Process Diagrams • 13

Index


smartplant reference data add components for intergraph ...spmat.hec.co.kr/marian_webentry/pdfs/sprd...

Documents