smartplant materials commodity code...

SmartPlant Materials Commodity Code Generation

Version 2007.4 (6.2.5) November 2006 / April 2008 DMAR1-PE-200022E-Updated

Copyright Copyright © 2002-2008 Intergraph Corporation. All Rights Reserved.

Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization.

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 Huntsville, Alabama 35894-0001

Warranties and Liabilities All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in this publication is accurate as of its publication date.

The information and the software discussed in this document are subject to change without notice and are subject to applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.

The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license.

No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should verify for themselves that the data is accurate and suitable for their project work.

Trademarks Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, MARIAN, PDS, and IntelliShip are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of their respective owners.

Table of Contents

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

Commodity Code Generation ...........................................................................................5

A.50.01 Attributes ........................................................................................................5 A.50.02 Tables ..............................................................................................................6 S.20.01 Tablename with Groups ..................................................................................7 S.20.02 Tablenames with Details .................................................................................8 S.10.01 Commodity Rule .............................................................................................9 S.10.02 Commodity Group .........................................................................................12 S.10.02 Commodity Part .............................................................................................13 S.10.05 Object Parameter Detail ................................................................................14 S.10.05 Object Parameter Detail ................................................................................15

Definition for the input numbers of S.10.05 ..................................................................... 15 Definition for the output numbers of S.10.05 ................................................................... 15

S.10.06 Part Object Parameter ....................................................................................17 S.20.03 Parts with Tablegroups ..................................................................................18 S.20.04 Parts with Tabledetails ..................................................................................19 S.30.01 Commodity Code ...........................................................................................20 S.30.02 List all Commodity Codes .............................................................................22 S.30.03 Commodity Code Text ..................................................................................23

SmartPlant Materials Commodity Code Generation 3

Preface

Preface This document is the result of consulting sessions with our customers.

Their basic idea was to help individual customers to understand specific SmartPlant Materials functionality.

It is neither complete nor committal documentation.

General: By application of this complete procedure, an alphanumeric encoded numbering system will be generated for the selected and standardized item. The sequence of the code can be determined by menu S10.01.

4 SmartPlant Materials Commodity Code Generation

Commodity Code Generation

Commodity Code Generation A.50.01 Attributes

Detail: Attributes are necessary in order to define geometrical Objects, which are the links between Commodity Codes and Geometric Tables for the generation of Ident Numbers. Examples of Attributes are: NPS, OD, SCHEDULE, WT, ID, WEIGHT, SURFACE, etc.

1. Choose for field "Types" the character "GEOM" and perform a query.

Important • Only this "Attribute Type" is valid for the generation of attributes.

2. Define under "Attribute Names" all necessary kinds that are required to provide a complete description of the selected item, for example, a pipe would be described by the NPS and Schedule.

3. Define Data Type, Width, Precision, Form Width, and Units by the LOV button.



A.50.02 Tables Detail: The information that should become part of the Com. Code has to be defined in this menu. Examples for Table Names include Material, Standards, Endcondition, Rating, and Service, etc.

1. Choose for "Table Types" the type "COMMATTR" and perform query.

Important • Only this “Attribute Type” is valid for the generation of attributes.

2. Fill in under "Table Names" all necessary and general conditions that could be used for the generation of the commodity code.

3. Provide the requested descriptions.



S.20.01 Tablename with Groups For each of the general created "Table Name" items of A50.02, a group has to be assigned, for example, Table Name: Material; Table Group: Carbon Steel, etc.



S.20.02 Tablenames with Details For each of the created "Tablenames with Group" items of S20.01, a detail (more specific information ) has to be assigned (for example, Tablename with Group: Carbon Steel ; Tablename with Detail: Carbon Steel A106 Grade B, CS A106 B).

The "Table Detail", which has to be given by the operator, will become part of the Commodity Code Sequence later on. Don't assign to many digits for this detail. Two should be sufficient.



S.10.01 Commodity Rule A name for the "RULE" has to be given, which should indicate the items or components for which the rule should be applicable. For example, if this rule should be applied in general for all piping material, the rule could be named PIPE. The input for "TABLENAME" can be selected by means of the LOV-button. All Tablenames included in this field will become a part of the Commodity Code later on, if you mark the "REQUIRED" field. Switch over to Window 2 "COMMODITY KEY FOR RULE" and define the structure of your Commodity Code. By means of the LOV-button you can select all Tablenames, defined in page 1 of S10.01 and additional two default settings, called "M_COMMODITY_GROUPS" and "M_PARTS". With the frequency of the Tablenames and the ascending order of the assigned digits, the operator decides where and what kind of information will become part of the Commodity Code. So if you have foreseen "M_COMMODITY_GROUPS" on digits 1 to 3, then the first three digits of the Commodity Code will provide the first 3 digits of the content from the name "M_COMMODITY_GROUPS" . Ditto for the "M_PARTS". From the other selected Tablenames, the related Table Details will be used.

Switch over to Window 3 and define the output for your Commodity Code information in the fields of "LAYOUT SHORT and LONG": Layout Creation: N.B.: The text entered in the field "LAYOUT SHORT" will be shown in pipe classes and BOMs. The text entered in the field "LAYOUT LONG" will be shown in Requisitions and Purchase Orders. N.B.: For both layout fields, the following rule has to be applied: You have to add the text "_long" for the Layout Long field and "_short" for the Layout Short field, e.g. Layout Short: The original text produced by the LOV-button is: #m_parts#, i.e. the correct extended version will be: #m_parts_short#. Without this extension, no values will be shown behind the text.



1. Switch over to Window 3. 2. Create a table with describing text and add the available info of the LOV-button

behind.



S.10.02 Commodity Group The main intention of this step is to create a relation between the defined Commodity Rule of S10.01 and the existing geometric Object. The availability of an Object is not a necessity and can be done after the Object has been defined in S10.04.

Examples are: Valves, Pipes, Flanges, etc. First, you have to provide a name for the "GROUP" under which the relationship between "RULE" and "OBJECT" will be handled. It should be considered that parts of the group name might be used for the structure of the Commodity Code. "RULE" and "OBJECT" input can be done by the LOV-button. The operator has to decide about an appropriate Object for his Rule.

N.B. The field "Object" can be skipped until you have defined the suitable Object Parameter in S10.04. The O.P. is only necessary in S30.01 for the Com. Code generation and can be left out here, if it does not already exist.



S.10.02 Commodity Part Using this menu you can define a subdivision in relation to the items of S10.02 -Commodity Group. For example, if the Com. Group was only describing general pipes, you are now able to become more specific and to structure them into seamless pipes and welded pipes, etc. Take into consideration that sections of the Com. Part name can be used for the Commodity Code, if this has been specified in the "Commodity Key for Rule " of S10.01.



S.10.05 Object Parameter Detail An Object Parameter is the link between the Com. Code and the related Geometrics. The Object Parameter is required if you want to generate a Com. Code, and it is a necessity if you want to create Ident Numbers.

1. You have to define a name under which the single Objects will be summarized, the so-called Object Parameter. Use a description that explains the specific application of this Object Parameter.

2. Select the Quantity Unit by means of the LOV button. 3. Enter the required description.



S.10.05 Object Parameter Detail Here you will stipulate which Attributes will be assigned to the pre-defined Object Parameter name. By the end of this procedure, the Object is ready for further use in case you want to generate a Commodity Code or an Ident Number later.

1. Enter the Object Parameter name of S10.04 2. Define a "PARAMETER DETAIL NAME", and insert this name into the field

" NAME" 3. Select by means of the LOV-button the available Attribute Names. 4. For Layout definition, switch over to Window 2. 5. The syntax for the fields "LAYOUT LONG" and "LAYOUT SHORT" is identical

and as follows: You have to use the text from the field "NAME" of the first screen, this is the Object Parameter Detail, e.g. if the "NAME" is NPS, than the input in the layout fields has to be #nps#. You can write explanation text in front and ,a unit after the input, for example, NPS: #nps#in

Definition for the input numbers of S.10.05 • The input figures for the "No." field have to start with number 1.

• The input figures for the "No." field have to be in an ascending order. This continuous ascending order has to be without any gap. The only exception for this rule is the so-called "Assembly Number" ASS_NO. This ASS_NO, which is an input value, has to always be on position number 5. This is a severe requirement from SmartPlant Materials, because there are hardcoded functions behind it.

• The input figures for the "No." field have to be in-line with the position of the input values of A.50.03 and S40.12, respectively

Definition for the output numbers of S.10.05 • The first output number, following an input number, is determined after

the maximum input value number plus the position of the output column of A50.03 and S40.12, respectively.

• SmartPlant Materials will accept an ascending order for the output values with gaps. For example, if the last input value will be No. 5, the first output value can become No. 6, followed by No. 8 and No. 10. The output values are equivalent to GD.OUT 1; GD.OUT 3 and GD.OUT 5 of A.50.03 and S40.12



Summarizing the aforementioned: The input values No 1 NPS_1 and No 2 SCH_1 must be followed by the first output value DN_1, which must get No 3, because it has been assigned to output column number 1 on A50.03 and S40.12, respectively, because 2+1 = 3. According to this rule, OD_1 will become output No. 4 (2+2 = 4) on S10.05, and WT_1 will become output No. 5 (2+3 = 5) on S10.05.



S.10.06 Part Object Parameter For the existing Commodity Group and the subdivided Commodity Part Codes, an appropriate Object will be assigned to the Part Codes.

Note

• The Object is a necessary element in order to create a relation between the Commodity code and the Geometrics. Without this relation, it is impossible to generate Ident-numbers.



S.20.03 Parts with Tablegroups This menu and S20.04 are optional menus that enable you to enter filter conditions in order to generate more specific Com. Codes and to prevent operating mistakes. The result of this is that when forming a commodity code, only the details that match the part are displayed for selection and therefore for the generation of Commodity Codes. For example, when forming a commodity code for Pipe, materials for seals and screws, etc. are not displayed and only meaningful commodity codes can be formed. In order to do so, you have to define Parts with Tablegroups.

1. Select a Commodity Group and assign a Com. Part by selection. 2. Assign a Tablename to the Com. Part. 3. Assign a Tablegroup to the Tablename.



S.20.04 Parts with Tabledetails This optional menu enables you to enter filter conditions in order to generate more specific Com. Codes and to prevent operating mistakes.

1. Select a Commodity Group and assign a Com. Part by selection. 2. Assign a Tablename to the Com. Part. 3. Assign a Tablegroup to the Tablename. 4. Assign a Tabledetail to the Tablegroup.



S.30.01 Commodity Code Under assignment of the Commodity Group for the selected Commodity Part with the related Object, a new Commodity Code will be generated in accordance with the rule definitions of S10.01.

1. Enter the Group for which you intend to create a Com. Code. 2. Mark the Part for which you intend to create a Com. Code.

3. Enter a temporary placeholder in the "Com. Code" field. 4. Select the Object by the LOV button. 5. Save all entries and go to the lower block. 6. Enter all Com. Attributes by the LOV button and save the entries.



7. Activate the Build One Com. Code button.



S.30.02 List all Commodity Codes In order to get an overview about all existing Com. Codes of one Com. Group with their related Com. Parts, you can choose this menu.




S.30.03 Commodity Code Text Using this menu, you will be able to get the layout results of the Commodity Code that have been defined previously in the Commodity Rule (S10.01).

1. Enter the name of the required Com. Group by means of the LOV-button and perform a query.

2. Select the required Com. Part, which will already be shown after the query of step 1.

3. Switch over to window 2. 4. Under indication of the selected Com. Part, the related Com. Code, Com. Rule,

and the Com. code Layout, including Layout Short & Long, will be shown.

smartplant materials commodity code...

Documents