Reference Data Best Practices Changes

Reference Data and Catalog Change Management Best Practices

Version S3D 2014

April 2014

N/A

© 2009 Intergraph Corporation. All rights reserved. The content of this document is proprietary work of Intergraph Corporation, or relevant third parties, and is protected by copyright law and international treaty. Any use, duplication, distribution or disclosure of such, other than as specified herein, is unauthorized and in violation of applicable copyright law and international treaty. All rights in content or materials bearing copyright notice or other attribution of third party rights are reserved to the relevant third party. United States Government li cense rights are limited to those mandatory rights identified in DFARS 252.227-7015(b). Intergraph may make improvements and/or changes in the products and/or the programs described in th is publication at any time without notice. Any content or materials supplied hereunder are provided "as is," without warranty of any kind, either expressed or implied, including, but not limited to, any implied warranties of merchantability, fitness for a particular purpose, or against infringement. In no event shall Intergraph be liable for any damages arising out of, or in connection with the downloading, viewing, use, duplication, distribution or disclosure of any co ntent or material published by Intergraph, including but not limited to any direct, indirect, incidental, s pecial, punitive or consequential damages, or loss or corruption of data. Some jurisdictions do not allow the exclusions or limitations set forth above, so the above may not apply to you. The exclusions or limitations shall apply in all jurisdictions to t he maximum extent allowed by law.

Intergraph Corporation 170 Graphics Drive Madison, AL 35758 Phone: +1.256.730.2000 Toll Free USA: +1.800.345.4856 Fax: +256.730.2048

Contents 1

Introduction ........................................................................................................................................... 5

2

Terminology .......................................................................................................................................... 5

3

Tools ...................................................................................................................................................... 6

4

5

6

7

8

3.1

Bulkload Utility ............................................................................................................................... 6

3.2

Verify Consistency Report Command ........................................................................................... 6

3.3

Catalog Checker Utility.................................................................................................................. 7

3.4

Synchronize Model with Catalog Command ................................................................................. 8

3.5

Synchronize Workspace Command .............................................................................................. 8

3.6

TO DO List tool.............................................................................................................................. 8

3.7

Update Custom Symbol Configuration Command ........................................................................ 9

3.8

Smart3D Schema Browser Utility .................................................................................................. 9

3.9

Catalog Task ............................................................................................................................... 10

Procedure ............................................................................................................................................ 11 4.1

Reference Data Changes ............................................................................................................ 11

4.2

Symbol Definition Changes ......................................................................................................... 12

4.3

Catalog Schema Changes .......................................................................................................... 12

Examples of Piping Component Data Changes .............................................................................. 13 5.1

Change Contractor Commodity Code in the Piping Commodity Filter sheet .............................. 13

5.2

Add an Optional Short Code in the Piping Commodity Filter sheet ............................................ 13

5.3

Change Nominal Pipe Diameter Range in the Piping Commodity Filter sheet ........................... 14

5.4

Change Maximum Temperature in the Piping Commodity Filter sheet ...................................... 15

5.5

Change Dimensional Parameter in the User Defined Part Class sheet ..................................... 15

5.6

Add/Change Dry Weight in the User Defined Part Class sheet .................................................. 16

5.7

Change End Standard in the User Defined Part Class sheet ..................................................... 16

5.8

Change Short Description in the Piping Commodity Material Control Data sheet ...................... 17

Examples of Pipe Branch Rule Changes ......................................................................................... 18 6.1

Change Branch Size in the Pipe Branch Rule sheet .................................................................. 18

6.2

Change ShortCode in the Pipe Branch Rule sheet..................................................................... 18

Examples of Valve Operator Changes ............................................................................................. 19 7.1

Change Valve Operator Part Number in the Piping Commodity Material Control Data sheet ... 19

7.2

Change Dimensional Parameter in the User Defined Part Class sheet ..................................... 22

Examples of Generic Dimensional Data Changes .......................................................................... 23 8.1

Change Flange Thickness in the Piping Generic Data Bolted sheet .......................................... 23

8.2

Add new size for schedule thickness S-5S in the Plain Piping Generic Data sheet ................... 23

3

9

Examples of Gasket Data Changes .................................................................................................. 24 9.1

Change Gasket Commodity Code in the Gasket Selection Filter sheet ..................................... 24

9.2

Change Nominal Pipe Diameter Range in the Gasket Selection Filter sheet ............................. 25

9.3

Add an Optional Gasket Commodity Code in the Gasket Selection Filter sheet ........................ 25

9.4

Change Gasket Thickness in the Gasket Part Data sheet ......................................................... 26

9.5

Change Short Description in the Piping Commodity Material Control Data sheet ...................... 26

9.6

Change Reporting Type in the Piping Commodity Material Control Data sheet ......................... 27

10 Examples of Bolt Data Changes ....................................................................................................... 27 10.1

Change Bolt Commodity Code in the Bolt Selection Filter sheet ............................................ 27

10.2

Change Nominal Pipe Diameter Range in the Bolt Selection Filter sheet .............................. 28

10.3

Add an Optional Bolt Commodity Code in the Bolt Selection Filter sheet .............................. 29

10.4

Change Short Description in the Piping Commodity Material Control Data sheet .................. 29

10.5

Change Reporting Type in the Piping Commodity Material Control Data sheet ..................... 30

10.6

Change Bolt Extension for Studs/Machine Bolts in the Bolt Extension sheet ........................ 31

11 Examples of .NET Symbol Definition Changes ............................................................................... 31 11.1

Changing the Inputs of a Symbol Definition ............................................................................ 32

11.2

Changing the Outputs of a Symbol Definition ......................................................................... 32

11.3

Changing Code for Generating Outputs of a Symbol Definition ............................................. 33

12 Appendix - Unique ID Definition........................................................................................................ 34

4

1

Introduction This document provides best practices guidance on how to manage changes to the Smart 3D (S3D) catalog and reference data during life cycle phases of a project. Once modeling begins, required changes to the catalog or reference data must be properly made in order to avoid project delay and cost overrun. To narrow the scope on this subject, this paper does not include the benefits of using SmartPlant Reference Data (SPRD) to manage corporate specifications in a global environment. The general procedure described here includes management of specification data, symbol definition, rules and parts data, as well as changes to the catalog schema required to support the life cycle phases of a project.

2

Terminology Part definition is a persistent object in the catalog database that contains part data. Part occurrence is an instance of a part persisted in the model database. Symbol definition is a persistent object in the model database that holds the definition of the inputs and outputs used to create the graphical representation of the object. Symbol is a program (dll) that creates a set of outputs for a given set of inputs. Symbol occurrence is a persistent object that has a transformation matrix of the flavor. Flavor holds and caches the actual graphical representation of the object. Proxy represents an object from another database.

Model Database Proxy of part Part Occurrence Symbol Occurrence Symbol Definition

Catalog Database Part definition

Flavor SharedContent Symbol dll

Unique ID definition is a unique string created from a combination of certain properties of a rule that defines the uniqueness of catalog object. For example,

5

3

Tools The process to manage catalog and reference data changes during life cycle phases of a project involves the use of different tools and commands. The following list briefly summarizes all the major tools and commands involved in this process.

3.1

Bulkload Utility This tool permits loading the changes from Excel sheets into the catalog database. Several options are available to load the data into the catalog. The Add/Modify/Delete option is best used when you are modifying pre-existing data in the catalog. In this option, the utility scans the Excel sheet for the characters “A”, “M”, or “D” at the beginning of each row to perform the appropriate action in the catalog and catalog schema databases. For more information refer to the Reference Data Guide.

3.2

Verify Consistency Report Command The Verify Consistency report command, available from the “Tools” menu in the catalog task, provides users with the means to check the piping specification rules and the required data to place the part occurrences. Once the consistency check is complete, the system generates an Excel report detailing the discrepancies. For more information refer to the Catalog User’s Guide.

6

3.3

Catalog Checker Utility The catalog checker utility helps to determine and assess the impact to the 3D model resulting from changes to the specification rules and part data in the catalog. The utility reports the objects in the 3D model impacted by the proposed changes. For more information refer to the Smart3D Customer Support Site under the Freeware Tools and Utilities web page in https://smartsupport.intergraph.com

7

3.4

Synchronize Model with Catalog Command Due to a reference data or catalog change, the objects in the model can end up in out of date with the catalog. The Synchronize Model with Catalog command updates all objects in the model database with all catalog changes, such as part definition, specification, rules, and symbol definition changes. The “Mark out-of-date occurrences” option checked and the “Update out-ofdate occurrences” option unchecked is best setup to run this command. For example, in a global work share configuration, system places items at satellite locations that need updating on the To Do List. For more information, refer to the Project Management User’s Guide.

3.5

Synchronize Workspace Command The Synchronize Workspace command updates selected out-of-date objects in the model with all changes from the catalog. If no objects are selected, then the command searches and updates all out-of-date objects in the workspace instead. You access this command by selecting the Tools > Utilities > Synchronize with Catalog option. For more information, refer to the Project Management User’s Guide.

3.6

TO DO List tool The To Do List command, available from the “View” menu in any modeling task, provides you with a dialog box to see objects in the workspace that have inconsistent data. The note column

8

indicates the description of the problem. For more information, refer to the Common User’s Guide.

3.7

Update Custom Symbol Configuration Command The Update Custom Symbol Configuration command, available from the “Tool” menu in Project Management task, updates the CustomSymbolConfig.xml file. This CustomSymbolConfig.xml file contains entries of program ID (ProgID), the CLSID and DLL name for each custom symbol dll located under [SharedContent Directory]\Custom Symbols folder. S3D uses this CustomSymbolConfig.xml file to find the symbol dll when the system creates the symbol definition object for the first time in the model database. For more information, refer to the Common User’s Guide.

3.8

Smart3D Schema Browser Utility This Smart3D Schema Browser utility is a very useful tool for checking the success of an intended schema change and diagnosing problems with the Catalog schema. This tool is located in [Product Directory]\Core\Tools\Administrator\Bin\MetaDataBrowser.exe.

9

3.9

Catalog Task Avoid using the catalog task to make changes to the catalog database, as no easy mechanism exists for exporting your changes from the catalog database back into a Microsoft Excel workbook.

10

4

Procedure Changes to the catalog and reference data are grouped into five categories:     

4.1

Reference data changes Symbol definition changes Catalog schema changes Smart occurrence rule changes Naming rule changes

Reference Data Changes Reference data changes refer to data used to define the part definition, specifications, and other reference data rules for placing the part occurrences. No single procedure exists to suit all situations. However, to make successful reference data changes, we recommend the following actions:

START Add a new Record

Find corresponding Sheet

START Delete an existing record


Add "A" at the beginning of the new record

Add "D" at the beginning of the record

No

START Change Attribute Value


Is it used in unique id definition that uniquely identifies the record?

Is it an occurrence attribute? No

Yes

Yes

Add "M" at the beginning of the record and perform the changes

Duplicate the records. Add "D" at beginning of the first record. Add "A" at the beginning of the second record and perform the changes


Verify Changes and/or Resolve any discrepancies

Update impacted objects using Synchronize workspace command

Run Synchronize Model with Catalog command (Mark out-of-date occurrences)

Yes

Is there an impact on Geometry or Topology of 3D modeled objects?

Use Filter mechanism to select impacted objects and Update

Run Bulkload Utility And Review the Log file

Review impact of proposed changes using Catalog Checker Utility

Run Bulkload Utility And Review the log file

Run Verify Consistency Command and/or Resolve any discrepancies


No


Run Synchronize Model with Catalog command (Mark/Update out-of-date occurrences) at satellites

Run Synchronize Model with Catalog command (Mark/Update out-of-date occurrences)

GWS Configuration

11

Note: For more information on unique ID definitions refer to the Reference Data User’s Guide under

Unique Key Information section. 4.2

Symbol Definition Changes A symbol definition change refers to RAD 2D symbol, .NET/Visual Basic symbol and Solid Edge file used to define the graphical representation of the part occurrences.

Is the change violated the symbol definition modification rule?

START

No

Changes to symbol definition: - Inputs - Outputs and representations - Construct Outputs subroutine

Increase the Major version and Build the dll

Copy the dll to the SharedContent\Custom Symbols

Yes – Not applicable Update impacted objects using Synchronize workspace command


Yes



Run Update Custom Symbol Configuration Command

No – Not applicable Verify Changes and/or Resolve any discrepancies

4.3

Catalog Schema Changes Catalog schema change refers to data used to define the classes, interfaces, and properties for part definition and part occurrences.

START

Is the change violated the schema modification rule? No

Changes to part class: - Add new attibutes to part - Add new occurrence attributes

Create a new interface using CustomInterface sheet

Add new attributes to part class sheets


Add "M" at the part class

Yes – Not applicable

Re-generate the report database

Run Synchronize Model with Catalog command to update views in the model

12

5

Examples of Piping Component Data Changes The following illustrates example workflows for editing all aspect of a piping component in the catalog. The objective is to ensure that you are aware of the necessary steps to perform the catalog changes, as well ensuring that you know the effect synchronization has on the model. You can therefore decide whether the catalog changes are safe. This section’s primary focus is on helping you to determine the change requires adding “M”, “D” or “A” at the beginning of the record in the Excel sheet in order to apply the catalog changes using the bulkload utility.

5.1

Change Contractor Commodity Code in the Piping Commodity Filter sheet Description: The contractor commodity code in the Piping Commodity Filter rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the new requirement dictates the 1C0031 specification needs a new default contractor commodity for a 0.75-to 1.5-inch size range. Change Procedure: Find Piping Commodity Filter sheet



Run Bulkload Utility and Review the log file





No



Yes

No – Not applicable

Caution: Make sure a corresponding piping part definition and the material control data for the new contractor commodity code exists in the catalog. 5.2

Add an Optional Short Code in the Piping Commodity Filter sheet Description: An optional piping commodity code can be added in the Piping Commodity Filter rule. For example, the new requirement dictates that the 1C0031 pipe specification needs an optional gate valve for 0.75- to 1.5-inch sizes.

13

Change Procedure: Find Piping Commodity Filter sheet

. Add "A" at the beginning of the new record



Caution: Make sure that a corresponding piping part definition and the material control data for the new optional contractor commodity code exists in the catalog. 5.3

Change Nominal Pipe Diameter Range in the Piping Commodity Filter sheet Description: The nominal pipe diameter range in the Piping Commodity Filter rule is a property used to create the unique ID definition of the record. You must therefore remove the existing record from the catalog by adding the “D” character at the beginning of the record. Add a new record with the changes. For example, the new requirement dictates that a 4-inch butterfly valve must be available for the 1C0031 pipe specification. Change Procedure:

Find Piping Commodity Filter sheet


Yes







No

Is there an impact on Geometry or Topology of 3D modeled objects? Yes – Not applicable

Caution:

14

Make sure a corresponding piping part definition and the material control data for the new optional contractor commodity code exists in the catalog. 5.4

Change Maximum Temperature in the Piping Commodity Filter sheet Description: The maximum temperature attribute in the Piping Commodity Filter rule is a property used to create the unique ID definition of the record. You must therefore remove the existing record from the catalog by adding the “D” character at the beginning of the record. Add a new record with the changes. For example, the new requirement dictates that you can place small ball valve sizes in the 1C0031 pipe specification if the pipe run maximum temperature is less than or equal to 400 degrees F. Change Procedure:

Find Piping Commodity Filter sheet


Yes








No


5.5

Change Dimensional Parameter in the User Defined Part Class sheet Description: Dimensional Parameters are not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the new requirement dictates the face-to-face dimension value is 8-inches for a 3-inch 150# gate valve with a contractor commodity code “VAAAHAAAWAIFABAZZZZUS”.

15

Change Procedure:

Find User Defined Part Class sheet

Is it an occurrence attribute? No Yes – Not applicable






No

Yes – Not applicable Run Synchronize Model with Catalog command (Mark out-of-date occurrences)

Yes




5.6

Add/Change Dry Weight in the User Defined Part Class sheet Description: Dry weight is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the correct dry weight is 65 pounds for a 3-inch 150# gate valve with a contractor commodity code “VAAAHAAAWAIFABAZZZZUS”. Change Procedure: Find User Defined Part Class sheet

Is it an occurrence attribute? No Yes – Not applicable Verify Changes and/or Resolve any discrepancies




No

Yes – Not applicable Run Synchronize Model with Catalog command (Mark/Update out-of-date occurrences)

No




5.7

Change End Standard in the User Defined Part Class sheet Description: End Standard is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the

16

beginning of the record. For example, the correct end standard value is 30 for 150# gate valve with a contractor commodity code “VAAAHAAAWAIFABAZZZZUS”. Change Procedure:

Find User Defined Part Class sheet


5.8

Is it an occurrence attribute? No





No


Yes



Change Short Description in the Piping Commodity Material Control Data sheet Description: The short description in the Piping Commodity Material Control data rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the correct short description is “Gate valve, CL150, FFFE, BB, OS&Y, ASTM-A395, brnz trim, Stockham D-623” for 150# gate valve with a contractor commodity code “VAAAHAAAWAIFABAZZZZUS”. Change Procedure:

Find Piping Commodity Material Control Data sheet

Is it an occurrence attribute? No Yes – Not applicable Verify Changes and/or Resolve any discrepancies




No


No




17

6

Examples of Pipe Branch Rule Changes The following examples illustrate workflows to edit all aspects of the pipe branch rule.

6.1

Change Branch Size in the Pipe Branch Rule sheet Description: The Branch size is a property used to create the unique ID definition. You must therefore delete the existing record and add a new record with the change. For example, the new requirement dictates a 3-inch size is available in the pipe specification, instead of a 2.5-inch size. Change Procedure:

Find Pipe Branch sheet


Yes









Yes


6.2

Change ShortCode in the Pipe Branch Rule sheet Description: Since the short code is not a property used to create the unique ID definition, add “M” at the beginning of the record, and apply the changes to the existing record. For example, the new requirement dictates that a reducing tee is placed for 4"x2” lines instead of a weldolet.

18

Change Procedure:

Find Pipe Brach sheet







No




Yes


7

Examples of Valve Operator Changes The following examples illustrate workflows to edit all aspects of the valve operator data.

7.1

Change Valve Operator Part Number in the Piping Commodity Material Control Data sheet Description: The valve operator part number in the Piping Commodity material Control Data rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. However, since valve operator is an output to the symbol definition of the valve, you must mark all affected valve part records as modified by adding the “M” character at the beginning of the record. Change Procedure: Find Piping Commodity Material Control Data sheet


No


Find Part Classes sheets of all valve parts affected by the changes

Add "M" at the beginning of all valve part records affected by the changes






Yes


19

20

Caution: Use the following SQL statement to find all affected valves.

Select x1.oid, x10.ItemName as PartOcc, x11.PartNumber, x15.PrimarySize, x15.PriSizeNPDUnits, x15.SecondarySize, x15.SecSizeNPDUnits, x14.Name as ClassName, x4.ValveOperatorCatalogPartNumber as 'Operator PartNumber' From JPartOcc x1 Join JNamedItem x10 on x10.Oid = x1.oid Join XmadeFrom x2 on x2.OidOrigin = x1.oid Join JDPart x11 on x11.Oid = x2.OidDestination Join JDPipeComponent x15 on x15.Oid = x11.oid Join XSymbolDefinitionforPartClass x13 on x13.OidDestination = x11.oid Join JDPartClass x14 on x14.Oid = x13.OidOrigin Join XPartOccToMaterialControlData x3 on x3.OidOrigin = x1.oid Join JValveOperatorInfo x4 on x4.Oid = x3.OidDestination Where x4.ValveOperatorCatalogPartNumber Not like '' Order by x11.PartNumber, x15.PrimarySize, x15.PriSizeNPDUnits, x15.SecondarySize, x15.SecSizeNPDUnits

21

7.2

Change Dimensional Parameter in the User Defined Part Class sheet Description: Dimensional parameters are not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. However, since the valve operator is an output to the symbol definition of the valve, you must mark all affected valve part records as modified by adding the “M” character at the beginning of the record. Change Procedure: Find Piping Commodity Material Control Data sheet


No


Find Part Classes sheets of all valve parts affected by the changes

Add "M" at the beginning of all valve part records affected by the changes







Yes


Caution: Use a SQL statement to find all affected valves. See section 7.1.

22

8

Examples of Generic Dimensional Data Changes The following examples illustrate workflows to edit all aspects of the generic dimensional data.

8.1

Change Flange Thickness in the Piping Generic Data Bolted sheet Description: The flange thickness in the Piping Generic Data Bolted rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the correct flange thickness for 1.25-inch size, 125# pressure rating, flat-face flanged end is 0.5 inches based on the ASME B16.5 standard. Change Procedure:

Find Piping Generic Data Bolted sheet







No




Yes


8.2

Add new size for schedule thickness S-5S in the Plain Piping Generic Data sheet Description: You can add new records can be added to the Plain Piping Generic Data rule. For example, the new requirement dictates that the project needs a 0.75-inch plain pipe with schedule S-5S. Change Procedure:

Find Plain Piping Generic Data sheet




23

9

Examples of Gasket Data Changes The following examples illustrate workflows for editing all aspects of the gasket data.

9.1

Change Gasket Commodity Code in the Gasket Selection Filter sheet Description: The contractor commodity code in the Gasket Selection Filter rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the new requirement dictates that the 1C0031 specification needs a new default contractor commodity for 0.75-inch to 24-inch size range. Change Procedure: Find Gasket Selection Filter sheet







No




Yes


Caution: Make sure a corresponding gasket part definition and the material control data for the new contractor commodity code exists in the catalog.

24

9.2

Change Nominal Pipe Diameter Range in the Gasket Selection Filter sheet Description: The nominal pipe diameter range in the Gasket Commodity Filter rule is a property used to create the unique ID definition of the record. You must therefore remove the existing record from the catalog by adding the “D” character at the beginning of the record. Add a new record with the changes. For example, the new requirement dictates that the 1C0031 specification needs a gasket up to 30 inches in size. Change Procedure: Is it used in unique id definition that uniquely identifies the record?

Find Gasket Selection Filter sheet

Yes







No


9.3

Add an Optional Gasket Commodity Code in the Gasket Selection Filter sheet Description: An optional gasket commodity code can be added in the Gasket Selection Filter rule. For example, the new requirement dictates that the 1C0031 specification needs an optional gasket for 2- to 24-inch sizes. Change Procedure: Find Gasket Selection Filter sheet




25

9.4

Change Gasket Thickness in the Gasket Part Data sheet Description: Gasket thickness is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the new requirement dictates that the gasket thickness value is 0.125 inches for commodity code “GMAHACABXBEPUS”. Change Procedure: Find Gasket PartData sheet







No

Yes – Not applicable Is there an impact on Geometry or Topology of 3D modeled objects?



Yes No – Not applicable

9.5

Change Short Description in the Piping Commodity Material Control Data sheet Description: The short description in the Piping Commodity Material Control data rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record by adding the “M” character at the beginning of the record. For example, the correct short description is “Gasket, CL150, 0.0625" thk comp sheet, org fiber/nitrile binder, ASME-B16.21” for commodity code “GAAHAAAALBFIUS”. Change Procedure: Find Piping Commodity Material Control Data sheet






No


No




26

9.6

Change Reporting Type in the Piping Commodity Material Control Data sheet Description: Occurrences attributes are those attributes that appear on the occurrence tab of the object property page. If the piping designer has specified the value for the Reporting Type in the 3D model, the property value in the model will not be updated with the corresponding value in the reference data during the synchronization process. Create a filter to select those objects that the system must update, and then use the property page to type or select the correct value. Change Procedure:


Is it an occurrence attribute?






10 Examples of Bolt Data Changes The following examples illustrate workflows for editing all aspects of the bolt data. 10.1 Change Bolt Commodity Code in the Bolt Selection Filter sheet Description: The contractor commodity code in the Bolt Selection Filter rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the new requirement dictates that the 1C0031 specification needs a new default gasket contractor commodity for 0.75- to 36-inch size range.

27

Change Procedure: Is it used in unique id definition that uniquely identifies the record?

Find Bolt Selection Filter sheet






No

Yes – Not applicable Verify Changes and/or Resolve any discrepancies

10.2 Change Nominal Pipe Diameter Range in the Bolt Selection Filter sheet Description: The nominal pipe diameter range in the Bolt Commodity Filter rule is a property used to create the unique ID definition of the record. You must therefore remove the existing record from the catalog by adding the “D” character at the beginning of the record. Add a new record with the changes. For example, the new requirement dictates that the 1C0031 specification requires the availability of bolts up to 42 inches in size. Change Procedure:

Find Bolt Selection Filter sheet


Yes







No


28

10.3 Add an Optional Bolt Commodity Code in the Bolt Selection Filter sheet Description: You can add an optional bolt commodity code in the Bolt Selection Filter rule. For example, the new requirement dictates that the 1C0031 specification needs an optional bolt for 0.75- to 36-inch sizes. Change Procedure: Find Bolt Selection Filter sheet




10.4 Change Short Description in the Piping Commodity Material Control Data sheet Description: The short description in the Piping Commodity Material Control data rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the correct short description for a bolt with contractor commodity code “BAZZZZZZAAYBFVZZUS” is “Studbolts w/hex nuts, ASTM-A193-B8C Cl.1, Electrofilm 2006 coated”.

29

Change Procedure:







No


No




10.5 Change Reporting Type in the Piping Commodity Material Control Data sheet Description: Occurrences attributes are those attributes that appear on the occurrence tab of the object property page. If the piping designer has specified the value for the Reporting Type in the 3D model, the property value in the model will not be updated with the corresponding value in the reference data during the synchronization process. Create a filter to select those objects that need updating, and then use the property page to type or select the correct value. Change Procedure:


Is it an occurrence attribute?






30

10.6 Change Bolt Extension for Studs/Machine Bolts in the Bolt Extension sheet Description: The bolt extension for studs/machine bolt in the Bolt Extension rule is not a property used to create the unique ID definition of the record. You can therefore mark the existing record as modified by adding the “M” character at the beginning of the record. For example, the correct studs/machine bolt extension for a 6-inch nominal pipe diameter connection is 5 mm. However, since the bolt extension rule is a plant rule, all affected bolted connection must be updated by the synchronization process. You can do this by adding the “M” character at the beginning of the record for all affected records in the “Piping Generic Data Bolted” sheet. Change Procedure:

Find Bolt Extension sheet



Find Piping Generic Data Bolted sheet

No

Add "M" at the beginning of all generic data bolted records affected by the changes



Yes





11 Examples of .NET Symbol Definition Changes Symbol definition is a persistent object in the model database that holds the definition of the inputs and outputs used to create the graphical representation of the object. This section lists some

31

recommendations for .NET symbol changes in such a way the persisted symbol definition and the related data is not get corrupted in the model database. 11.1 Changing the Inputs of a Symbol Definition The system currently requires a symbol to declare a set of inputs that creates a set of outputs. Declaring an input includes defining the enumerated index, name, description, and the optional property of that input. An example of the declaration of the inputs is shown below:

The following lists the types of input modifications that make the symbol definition invalid: –

Index and name cannot be modified

–

Input type cannot be changed

–

An input cannot be deleted

–

An optional input cannot be made a mandatory input

–

New input added in the middle of existing inputs is not allowed

11.2 Changing the Outputs of a Symbol Definition The system currently requires a symbol to declare each of the representations the software generates. Declaring a representation includes defining the name, description, aspect id, and the subroutine used to generate the outputs of that representation. For each representation, the symbol must declare each of the outputs. Declaring an output includes defining the name and description. An example of the declaration of the outputs follows below:

32

The following lists the types of output modifications that invalidate the symbol definition: –

Name of an aspect cannot be modified

–

Aspect id cannot be changed

–

Aspect cannot be deleted

–

Name of an output of a static symbol cannot be modified

–

Output of a static symbol cannot be deleted

11.3 Changing Code for Generating Outputs of a Symbol Definition The software requires a symbol to provide subroutines for generating the outputs for each representation. Each output is created, initialized with some data, and added to the output collection. When the code is changed in these subroutines, the name of the output must not change when added to the output collection. An example code to generate the outputs follows below:

Caution: 

The symbol fails to update if an output is declared, but no actual output object with a matching name is created.



The symbol fails to update if multiple output objects with the same name are found.

33

12 Appendix - Unique ID Definition The following table lists all objects in alphabetical order and the corresponding unique properties.

Object

Unique Properties

Allowable Piping Materials Class

SpecName, FluidCode

Auto Bolt Selection at Spec Brk Rule

PipingMaterialsClassEndA, PipingMaterialsClassEndB, EndPreparationEndA, PressureRatingEndA, EndStandardEndA, MaterialGradeEndA, EndPreparationEndB, PressureRatingEndB, EndStandardEndB, MaterialGradeEndB, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, MaximumTemperature, MaximumPressure

Auto Clamp Selection at Spec Brk Rule

PipingMaterialsClassEndA, RevisionNumberEndA, PipingMaterialsClassEndB, RevisionNumberEndB, EndPreparationEndA, EndStandardEndA, MaterialGradeEndA, EndPreparationEndB, EndStandardEndB, MaterialGradeEndB, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Auto Gasket Selection at Spec Brk Rule

PipingMaterialsClassEndA, RevisionNumberEndA, PipingMaterialsClassEndB, RevisionNumberEndB, EndPreparationEndA, PressureRatingEndA, EndStandardEndA, MaterialGradeEndA, EndPreparationEndB, PressureRatingEndB, EndStandardEndB, MaterialGradeEndB, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, FluidCode, MaximumTemperature, MaximumPressure

Bend Angles

SpecName, Npd, NpdUnitType, BendAngle

Bend Radius Multiplier Rule

NominalPipingDiameter, NominalPipingDiameterUnits, PipeBendRadiusMultiplier

Bolt Commodity Code Subst Rule

ContractorCommodityCode, BoltDiameter, BoltLength

34

Bolt Diameter Equivalence Rule

BoltDiameterInPrimaryUnits, PrimaryUnitsOfMeasure

Bolt Extension

NominalPipingDiameter, NominalPipingDiameterUnits, PressureRating, EndPreparation, EndStandard

Bolt Part Data

IndustryCommodityCode

Bolt Selection Filter

SpecName, NominalDiameterFrom, NominalDiameterTo, BoltOption, MaximumTemperature, EndPreparation, PressureRating, EndStandard, AlternateEndPreparation, AlternatePressureRating, AlternateEndStandard

Bolt Selection Filter For Nozzles

EquipmentTagNumber, NozzleTagnumber, ContractorCommodityCode, BoltingRequirements, QuantityOfCapScrews, CapScrewContractorCmdtyCode, CapScrewDiameter, TappedHoleDepth, BoltExtensionOption

Calculation ProgIDs

DesignStandard

Cap Screw LenCalTolerance

BoltType, BoltLengthFrom, BoltLengthTo, BoltDiameterFrom, BoltDiameterTo

Cap Screw LenCal Tolerance Per Spec

SpecName, BoltType, BoltLengthFrom, BoltLengthTo, BoltDiameterFrom, BoltDiameterTo

Clamp Selection Filter

SpecName, NominalDiameterFrom, NominalDiameterTo, ClampOption, EndPreparation, EndStandard, AlternateEndPreparation, AlternateEndStandard

Component Insulation Exclusion

PipingCommodityType, FirstSizeFrom, FirstSizeTo, SecondSizeFrom, SecondSizeTo, MultiSizeOption, HeatTracingMedium, InsulationTemperatureFrom, InsulationTemperatureTo

Commodity Specific Service Limits

IndustryCommodityCode, FirstSize, FirstSizeUnits, FirstSizeSchedule, SecondSize, SecondSizeUnits, SecondSizeSchedule, MultisizeOption, IndustryCommodityCodeGasket, MaximumTemperature, MaximumPressure

35

Corrosion Allowance

SpecName, MaterialsCategory, CorrosionAllowance

Default Change of Direction

BendAngleFrom, BendAngleTo

Default Change of Direction Per Spec

SpecName, BendAngleFrom, BendAngleTo

Default Commodity Selection Rule

FeatureType

DIN Wall Thickness Data

FirstSize, FirstSizeUnits, SecondSize, SecondSizeUnits, MultiSizeOption, GeometricIndustryStandard, FirstSizeSchedule, SecondSizeSchedule

End Prep Compatible Exceptions Rule

EndPreparationEndA, EndStandardEndA, MaterialsCategoryEndA, EndPreparationEndB, EndStandardEndB, MaterialsCategoryEndB

Field Fit Length

WeldType, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, ConstructionRequirementEnd1, ConstructionRequirementEnd2, FieldFitLength

Field Fit Length Per Spec

SpecName, WeldType, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, ConstructionRequirementEnd1, ConstructionRequirementEnd2, FieldFitLength

Field Lining Thickness

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Flared Pipe

NominalPipingDiameter, NominalPipingDiameterUnits, ScheduleThickness

Flared Pipe Per Spec

SpecName, NominalPipingDiameter, NominalPipingDiameterUnits, ScheduleThickness,

Flexible Hose Assembly Rule

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, TopologyType, AssemblyTag, AssemblyOption

Fluid Density Rule

FluidCode, TemperatureFrom, TemperatureTo, Density

Gasket Commodity Code Subst Rule

ContractorCommodityCode, GasketInsideDiameter, GasketOutsideDiameter,

36

GasketProcurementThickness, RingNumber Gasket Part Data

IndustryCommodityCode, RingNumber, NominalDiameterFrom, NominalDiameterTo, NominalDiameter, NpdUnitType, GasketIndustryStandard

Gasket Selection Filter

SpecName, NominalDiameterFrom, NominalDiameterTo, GasketOption, MaximumTemperature, EndPreparation, PressureRating, EndStandard, AlternateEndPreparation, AlternatePressureRating, AlternateEndStandard, FluidCode, ScheduleThickness, MinimumTemperature

Gasket Selection Filter For Nozzles

EquipmentTagNumber, NozzleTagNumber, ContractorCommodityCode, GasketRequirements, RingNumber

Inside Surface Treatment

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, FluidCode

Instrument Class Data

TagNumber, GenericTagNumber, FirstSizeFrom, FirstSizeTo, FirstSizeUnits, SecondSizeFrom, SecondSizeTo, SecondSizeUnits, MultiSizeOption

Insulation Thickness Table

SpecName, Npd_Lo, Npd_Hi, Temperature_Lo, Temperature_Hi

Jacket Closure

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, JacketClosureMethod

Joint Quality Factor

SpecName, NominalDiameterFrom, NominalDiameterTo, NpdUnitType, CommodityOption

Lined Connector Selection Filter

SpecName, NominalDiameterFrom, NominalDiameterTo, NpdUnitType, MaximumTemperature, EndPreparation, PressureRating, EndStandard, AlternateEndPreparation, AlternatePressureRating, AlternateEndStandard

Liner Thickness Data

NominalPipingDiameter, NominalDiameterUnits, LiningMaterial, GeometricIndustryStandard

37

Mach Bolt Len Cal Tolerance


Mach Bolt Len Cal Tolerance Per Spec


Materials Data

DesignStandard, MaterialsGrade, Temperature, WallThicknessFrom, WallThicknessTo, CoefficientY, AllowableStress, MillTolerance, MillTolerancePercentage

Mating Ports

EndPrep1, EndPrep2

Mech Joint Allow Pipe End Separation

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, GeometricIndustryStandard, GeometricIndustryPractice

Minimum Pipe Length Rule

NominalPipingDiameter, NominalPipingDiameterUnits

Minimum Pipe Length Rule Per Spec

SpecName, Npd, NpdUnitType

Min Pipe Length Purchase

NominalPipingDiameter, PurchaseLength

Min Pipe Length Purchase Per Spec

SpecName, NominalPipingDiameter, PurchaseLength

Multiport Valve Operator Data

ContractorCommodityCode, PortNumber

NPD Equivalence

NPDInPrimaryUnitsOfMeasure, PrimaryUnitsOfMeasure

Nut Commodity Code Subst Rule

ContractorCommodityCode, BoltDiameter

Nut Part Data


Nut Selection Filter

SpecName, NutOption, MaximumTemperature, BoltType, BoltDiameter, PressureRating

Outside Surface Treatment

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, EnvironmentalZone

Permissible Jacket And Jumper Sizes

SpecName, CoreNominalPipeDiameter, CoreNominalPipeDiameterUnits, JacketNominalPipeDiameter, JacketNominalPipeDiameterUnits, JumperNominalPipeDiameter, JumperNominalPipeDiameterUnits

38

Permissible Jacket Size Exceptions

SpecName, CoreNominalPipeDiameter, CoreNominalPipeDiameterUnits, JacketNominalPipeDiameter, JacketNominalPipeDiameterUnits, ShortCode

Permissible Pipe Bending Machine

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUOM

Permissible Taps

SpecName, PermissibleTapNumber

Pipe Bending Configuration Data

IsBendPlanar, NominalBendAngleFrom1, NominalBendAngleTo1, NonPlanarRotationAngleFrom2, NonPlanarRotationAngleTo2, NominalBendAngleFrom2, NominalBendAngleTo2, NonPlanarRotationAngleFrom3, NonPlanarRotationAngleTo3, NominalBendAngleFrom3, NominalBendAngleTo3, NonPlanarRotationAngleFrom4, NonPlanarRotationAngleTo4, NominalBendAngleFrom4, NominalBendAngleTo4, NonPlanarRotationAngleFrom5, NonPlanarRotationAngleTo5, NominalBendAngleFrom5, NominalBendAngleTo5, NonPlanarRotationAngleFrom6, NonPlanarRotationAngleTo6, NominalBendAngleFrom6, NominalBendAngleTo6, NonPlanarRotationAngleFrom7, NonPlanarRotationAngleTo7, NominalBendAngleFrom7, NominalBendAngleTo7, NonPlanarRotationAngleFrom8, NonPlanarRotationAngleTo8, NominalBendAngleFrom8, NominalBendAngleTo8

Pipe Bending Die Data

PipeBendingMachineName, NominalPipingDiameter, NominalPipingDiameterUOM, PipeBendRadiusMultiplier

Pipe Bending Elongation

NominalPipingDiameter,

39

NominalPipingDiameterUnits, PipeBendRadius, BendAngle Pipe Bending Elongation Per Spec

SpecName, NominalPipingDiameter, NominalPipingDiameterUnits, PipeBendRadius, BendAngle

Pipe Bending Machine Data

PipeBendingMachineName

Pipe Bending Min Tangent Len Data

PipeBendingMachineName, PipeBendType, MinBendToBendTanLenOption, NominalPipingDiameter, NominalPipingDiameterUOM, PipeBendRadiusMultiplier

Pipe Branch

SpecName, HeaderSize, HdrSizeNpdUnitType, BranchSize, BrSizeNpdUnitType, AngleLow, AngleHigh

Pipe Branch For Jackets

SpecName, HeaderSize, HdrSizeNpdUnitType, BranchSize, BrSizeNpdUnitType, AngleLow, AngleHigh

Pipe Mfg Map Symbol

PartClassName, SKEY, CodeList

Pipe Mfg Rules

IsoNames

Pipe Mfg Spool Rule

Name

Pipe Nominal Diameters


Pipe Part Spec

SpecName, FirstSizeFrom, FirstSizeTo, FirstSizeUnits, SecondSizeFrom, SecondSizeTo, SecondSizeUnits, ShortCode, OptionCode, MultisizeOption

Pipe Schedule Thickness

Npd, NpdUnitType, Schedule, Thickness

Pipe Spec

SpecName

Pipe Takedown Parts


Piping Commodity Filter

SpecName, FirstSizeFrom, FirstSizeTo, FirstSizeUnits, SecondSizeFrom, SecondSizeTo, SecondSizeUnits, ShortCode, OptionCode, MultisizeOption, MaximumTemperature, MinimumTemperature, SelectionBasis

Piping Commodity Matl Control Data

ContractorCommodityCode, FirstSizeFrom, FirstSizeTo, FirstSizeUnits, SecondSizeFrom, SecondSizeTo, SecondSizeUnits

Piping Commodity Procurement Data

CommodityCode, FirstSize, FirstSizeUnits, SecondSize, SecondSizeUnits, MultisizeOption, FirstSizeSchedule, SecondSizeSchedule

40

Piping Generic Data Bolted

NominalPipingDiameter, NominalDiameterUnits, EndPreparation, EndStandard, PressureRating

Piping Generic Data Female

NominalPipingDiameter, NominalDiameterUnits, EndPreparation, EndStandard, PressureRating, Schedule

Piping Generic Data Mechanical

NominalPipingDiameter, NominalDiameterUnits, EndPreparation, EndStandard, PressureRating

Piping Materials Class Data

SpecName

Piping Specialty Class Data

TagNumber, GenericTagNumber, FirstSizeFrom, FirstSizeTo, FirstSizeUnits, SecondSizeFrom, SecondSizeTo, SecondSizeUnits, MultiSizeOption

Plain Piping Generic Data

NominalPipingDiameter, NominalDiameterUnits, EndStandard, Schedule, PressureRating

Plate Flange Setback Distance

NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Port Alignment

NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, EndPreparation

Port Alignment Per Spec

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, EndPreparation

Preferred Cap Screw Length

BoltType, BoltDiameterFrom, BoltDiameterTo, BoltDiameterIncrement, MaterialsGrade, PreferredBoltLengthFrom, PreferredBoltLengthTo, PreferredBoltLengthIncrement

Preferred Cap Screw Length Per Spec

SpecName, BoltType, BoltDiameterFrom, BoltDiameterTo, BoltDiameterIncrement, MaterialsGrade, PreferredBoltLengthFrom, PreferredBoltLengthTo, PreferredBoltLengthIncrement

Preferred Mach Bolt Length


41

Preferred Mach Bolt Length Per Spec


Preferred Stud Bolt Length


Preferred Stud Bolt Length Per Spec


PreferredTapEndStudBoltLength


PrefTapEndStudBoltLengthPerSpec


Reference Standard

Name

Reinforcing Pad Data

SpecName, HeaderSize, HeaderSizeUnitsOfMeasure, BranchSize, BranchSizeUnitsOfMeasure, AcuteBranchAngleFrom, AcuteBranchAngleTo

Reinforcing Weld Data

SpecName, HeaderSize, HeaderSizeUnitsOfMeasure, BranchSize, BranchSizeUnitsOfMeasure, AcuteBranchAngleFrom, AcuteBranchAngleTo

Rootgap

NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Rootgap Per Spec

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Service Limits

SpecName, Temperature, Pressure, NominalPipingDiameterFrom,

42

NominalPipingDiameterTo, NominalPipingDiameterUnits Service Limits For Jackets

SpecName, Temperature, Pressure

Short Code Hierarchy Rule

ShortCodeHierarchyType, ShortCode

Size Reduction

SizeReductionType, FirstSize, FirstSizeUnits, SecondSize, SecondSizeUnits, SizeReductionPreference

Size Reduction Per Spec

SpecName, SizeReductionType, FirstSize, FirstSizeUnits, SecondSize, SecondSizeUnits, SizeReductionPreference

Slip On Flange Setback Distance

NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, CompanyPracticeGap, CompanyPracticeRoundOffFactor, EndStandard, MaximumWeldThickness

Socket Offset Rule

NominalPipingDiameter, NominalDiameterUnits, EndPreparation, EndStandard, PressureRating, Schedule

Standard Notes Data

Name, Purpose

Stud Bolt Len Cal Tolerance


Stud Bolt Len Cal Tolerance Per Spec


Swaged Jacket Pipe Rule

NominalPipingDiameter, NominalPipingDiameterUnits, Schedule

Swaged Jacket Pipe Rule Per Spec

SpecName, NominalPipingDiameter, NominalPipingDiameterUnits, Schedule

TapEndStudBoltLenCalTol


TapEndStudBoltLenCalTolPerSpec


Tap Properties

TapNumber

Thickness Data Rule

SpecName, NominalPipingDiameter, NominalPipingDiameterUnits, ScheduleThickness

Valve Operator Matl Control Data

OperatorPartNumber

43

Washer Commodity Code Subst Rule

ContractorCommodityCode, BoltDiameter

Washer Part Data


Washer Selection Filter

SpecName, WasherOption, MaximumTemperature, BoltDiameter, PressureRating

Weld Clearance Rule

SpecName, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, WeldClass

Weld Gap Rule

SpecName, WeldType, NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits

Weld Model Representation Rule

NominalPipingDiameterFrom, NominalPipingDiameterTo, NominalPipingDiameterUnits, WeldClass

Weld Type Rule

FabricationTypeOfEnd1, ConstructionRequirementOfEnd1, FabricationTypeOfEnd2, ConstructionRequirementOfEnd2

The rule to create the object unique ID definition for pipe parts and piping component parts is driven by the “PipingCmdtyCtlgPartNoBasisOpt” option in the default project option rule. If the PipingCmdtyCtlgPartNoBasisOpt option is set to 5, then the unique ID definition is a string composed by concatenating the industry commodity code, npd sizes and schedules. If the PipingCmdtyCtlgPartNoBasisOpt option is set to 10, then the unique ID definition is the contractor commodity code from the piping commodity filter rule. If the PipingCmdtyCtlgPartNoBasisOpt option is set to 15, then the unique ID definition is the client commodity code from the piping commodity procurement data rule.

44

Reference Data Best Practices Changes

Recommend Documents