Download as pdf or txt
Download as pdf or txt
You are on page 1of 136

SmartPlant Materials

How to Define Piping Material

Version 2008.5 (6.3.6) October 2009 DMAR1-PE-200076B


Copyright
Copyright © 2004-2009 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, PDS, SmartPlant, SmartSketch, FrameWorks, INtools, MARIAN, ISOGEN, and
IntelliShip are registered trademarks and SupportModeler and SupportManager are 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
Overview .............................................................................................................................5
Create Idents .................................................................................................................8
Detailed Workflow for Creating Commodity Codes and Idents.................................10

SmartPlant Reference Data Using Existing Data..........................................................11


Product Group versus Project .....................................................................................11
How to Create a Commodity Code .............................................................................11
S.30.01 Commodity Code Creation .................................................................................. 11
Single Commodity Code Creation .................................................................................... 12
Multiple Commodity Code Creation ................................................................................ 14
Copy Commodity Code .................................................................................................... 15
Updating Commodity Codes and Descriptions ................................................................ 17
Deleting Commodity Codes .............................................................................................. 17

Ident Creation ..................................................................................................................18

Supporting Data for Commodity Codes and Idents .....................................................21


Material Grouping and Rules ......................................................................................22
S.10.02 Group Definition ................................................................................................. 22
S.10.03 Part Definition ..................................................................................................... 24
S.10.01 Commodity Rule .................................................................................................. 25
Commodity Code Format ................................................................................................. 27
Layout attribute length limitation ..................................................................................... 29

Units ..................................................................................................................................30
A.10.06 Unit System......................................................................................................... 30
A.10.07 Unit Sets .............................................................................................................. 32
S.10.04 Object Parameters ................................................................................................ 33
Ident Description .............................................................................................................. 36
S.10.07 Assign the Object Parameter to a Group and Part ............................................... 37
Base Data for Commodity Codes & Idents .................................................................38
A.50.01 Attributes ............................................................................................................ 38
A.50.02 Commodity Attribute Tables .............................................................................. 39
A.50.03 – Adding Attributes to Tables............................................................................. 41
S.20.01 Table Names with Groups ................................................................................... 41
S.20.01 Table Details........................................................................................................ 42
S30.01 SPECIAL FEATURES ...................................................................................43
Geometrics ..................................................................................................................45
Geometric Tables for Standardized Values ...................................................................... 45
Tables for Standardized Dimensions ................................................................................ 47
S.40.12 Commodity Geometrics (User-definable Application) ....................................... 49
Commodity Geometric Relation ....................................................................................... 50
Geometric Simulation ....................................................................................................... 56

SmartPlant Materials How to Define Piping Material 3


Table of Contents

Phase 2. Create Idents .................................................................................................77


Geometrics ........................................................................................................................ 85
Geometric Simulation ....................................................................................................... 89
Generated Idents and their “Values” ................................................................................ 98

SmartPlant Reference Data Explorer ..........................................................................100


General Features .......................................................................................................100
Details for Commodity Group Level .............................................................................. 101
Details for Commodity Part Level .................................................................................. 103
Details for Commodity Code Level ................................................................................ 104
Details for Ident Level .................................................................................................... 104
Search Features .........................................................................................................105

Work Process Examples ................................................................................................109


Create a New Specification from a Paper Specification and Export to Smart 3D....109
Enter a Specification Header .......................................................................................... 110
Enter Butt-Welded Fittings ............................................................................................. 111
Enter a Gate Valve .......................................................................................................... 113
SmartPlant Reference Data Plus ...............................................................................114
Create Commodity Codes in the Specification ............................................................... 114
Review the Specification Before Export ..................................................................123
Export Specification and Catalogs to Smart 3D .......................................................125
Bulk Load Code Lists into Smart 3D........................................................................130
Placing Components in Smart 3D.............................................................................131
Changing Specifications ...........................................................................................134
Generation of Piping Material Catalog / Piping Commodity Data for Plant Design System
(PDS®) .....................................................................................................................136

4 SmartPlant Materials How to Define Piping Material


Overview

Overview
Piping Material is typically segregated into bulk pipe and fittings, valves, supports,
and special items. The SmartPlant Reference Data module of SmartPlant Materials is
used to categorize standard material so the data can be specified and managed using a
consistent coding structure for each material type. This benefits not only the current
project through ease of data management but also allows future estimation based on a
consistent historical record of material.

NOTE: STANDARD MATERIAL FROM ANY DISCIPLINE CAN BE DEFINED


IN A SIMILAR WAY TO PIPING MATERIAL.

The document will illustrate how the coding structure may be defined for standard
bulk material; it does not incorporate the definition of special items or non-standard
pipe supports. The non-standard items may be managed as Tagged Material and
handled in a similar manner to equipment or other non-standard material.

The codes and their descriptions created in SmartPlant Reference Data are referenced
in all other modules of SmartPlant Materials; they are not duplicated. When material
codes are received from other systems, SmartPlant Materials validates each code
against SmartPlant Reference Data definition, thus minimizing the risk of data error.

The ideal procedure for creating codes is to generate the majority of requirements
before a project begins. In this way, valuable time is not lost at the front end of a
project. IT is also more efficient to generate en masse rather than piecemeal. There
will always be project-specific codes to be created (gradually diminishing over time)
and these can be created as needed on a project.

This document first details the creation of Codes using the existing dataset, and then
explains how to create additional supporting data and configuration to generate
entirely new codes to suit the customer’s requirements.

The definition of Material Coding is accomplished in two phases:

Create Commodity Codes (sometimes called part or stock codes).


Create Idents (equals commodity code + geometric detail).

SmartPlant Materials How to Define Piping Material 5


Overview

Example of a SmartPlant Materials commodity code with descriptions:

Commodity codes are created according to user-definable rules. They generate a short
description that is used in Piping Classes, Bills of Materials, and requisitions, and a
long description that is used for Purchasing.

The default delivered commodity code structure does not contain any geometric
(dimensional) data such as Nominal Pipe Size, Schedule, or Wall Thickness. It is
acceptable, however, to define these attributes as part of the commodity code if
company practices dictate the requirement.

The benefit of not including geometric detail is that fewer commodity codes need to
be created and maintained. Plus, SmartPlant Materials will generate unique idents for
each size and schedule combination that the commodity code has.

Except for three administrative screens, all screens required to create commodity
codes and idents are located on the SmartPlant Reference Data menu. The goal of this
menu is to define all standard components so that:

They are available at the start of a project.


New parts can be created as quickly and efficiently as possible.

6 SmartPlant Materials How to Define Piping Material


Overview

SmartPlant Materials Commodity Codes (Concept) Example:


Commodity Code Commodity Code Text

PPPAMB0C6B00 Pipe, B36.10 SMLS BE - CS, ASTM A106-B

Each digit of the commodity Each digit (or group of digits) of


code represents a specific the commodity code generates a
attribute (property) of the pipe. part of the description.

SmartPlant Materials How to Define Piping Material 7


Overview

Create Idents
In this phase, commodity codes are related (linked) to geometric tables that contain
the appropriate geometric values. For pipe, this should be at least the nominal size and
the schedule since these values are required for ordering.

Reducing components will require two sizes and two schedules. Additional values are
also possible for definition of attributes such as weight and surface area. Using these
additional attributes allows further calculations to be performed such as shipping
weight or painting requirements.

Example of ident showing Geometric and Commodity Code relation:

SmartPlant Materials automatically generates the ident in a fixed format. SmartPlant


Materials idents are generated on the basis of the geometric link (relation). Material
management functions cannot be performed in SmartPlant Materials unless there is an
ident for each material item and it is the ident that ensures uniqueness of
identification.

8 SmartPlant Materials How to Define Piping Material


Overview

SmartPlant Materials idents example:

This part of the description is based


on the commodity code.

The geometric details are generated


by the ident.

SmartPlant Materials How to Define Piping Material 9


Overview

Detailed Workflow for Creating Commodity Codes


and Idents
The diagram below shows all common screens that are required during Commodity
Code and Ident creation.

10 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Using Existing Data

SmartPlant Reference Data Using Existing


Data
Product Group versus Project
Corporate standards are defined in the product group, and project-specific material is defined at the
project level. It is usual for a project to reference the product group as much as possible and only create
project-specific material definitions when the code cannot be included in the corporate standard. For the
purposes of this document, we are considering the product group only.

How to Create a Commodity Code


The delivered dataset contains substantial data for the creation of commodity codes and already contains
many commodity codes and idents. So in order to make the base data more relevant, first the document
discusses how to use the existing data to create commodity codes, and then how to change the base data
and configuration to create new codes.

S.30.01 Commodity Code Creation


1. Select screen S.30.01.
2. Query and select the appropriate Group and Part.
3. In our example, Group is defined as ‘Pipe & Tube’ and Part is ‘Pipe’.

SmartPlant Materials How to Define Piping Material 11


SmartPlant Reference Data Using Existing Data

A commodity code initially is a random number, which is a temporary placeholder


that will be replaced when the new commodity code is created. There are four
different types of commodity codes:

Table Detail Based -- For standard bulk materials.


Attribute Based -- Bulk material based on attributes
TAG Attribute Based -- For equipment templates where a common
commodity code may be applied to different tags as a datasheet
Others – (Not used)
NOTE: IN THIS DOCUMENT WE CONSIDER TABLE DETAIL-BASED SINCE
THIS IS THE RECOMMENDED METHOD FOR MOST STANDARD BULK
MATERIAL.

Object -- Select Object Parameter using LOV.


This specifies the format of the geometric table related to the
commodity code. It enables SmartPlant Materials to read data from the
geometric table in the correct way. The Object Parameter is related in
S.10.06 and re-used here. Usually, there is only the choice of one
object.
Additional Fields -- If you scroll to the right, you will see Account
group and Shop/Field (S/F) indicators; these are extra attributes that
have been assigned in A.50.03. It is possible to add any attribute
required in this manner.
HINT: IT IS RECOMMENDED TO USE THE COPY COMMAND WHEN CREATING
NEW RECORDS SINCE COMMODITIES BELONGING TO THE SAME GROUP/PART
ARE SIMILAR AND ONLY NEED CHANGING IN A FEW AREAS. SEE COPYING
COMMODITY CODE IN THE NEXT SECTION.
4. Save the record and go to [Next Blck].

In this section, the detail codes for each attribute of the commodity code are selected.
There are two tabs: ‘Details’ and ‘Attributes’. For the ‘Table Detail Based’ type
selected, the ‘Details’ table is activated.

Single Commodity Code Creation


1. ‘Digit From/To’, Tablename, Group, Detail, Description. Ensure the cursor is
in the field and use the List of Values (LOV). After selecting the attribute,
SmartPlant Materials will automatically step to the next appropriate LOV.
2. Move to the next line using the down arrow or mouse pointer.

12 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Using Existing Data

5. Use LOV and select the next value. Repeat the procedure. Continue until all
attributes are defined.
HINT: IF YOU SAVE CHANGES BETWEEN EACH LINE, THE LOV WITH
ATTRIBUTES WILL ONLY SHOW THE ATTRIBUTES NOT YET
SELECTED.

6. Save the attribute entries once complete.


7. Build One Commodity -- Click this button to build a single commodity code
(SmartPlant Materials ignores the range and wild card entries). SmartPlant
Materials will use the specified attributes to generate a new commodity code and
generate the long and short descriptions.
8. Check Double -- When active (and if the code already exists), it will generate an
entry prefixed with ‘EXISTING’.

SmartPlant Materials How to Define Piping Material 13


SmartPlant Reference Data Using Existing Data

Complete example:

Multiple Commodity Code Creation


The procedure is the same as for a single commodity code, but also specifies a range
or wild card.

Range -- Optional. It is possible to specify a range of attribute values


so that more than one commodity is created at a time (for example, for
the rating attribute, select 150# with range 900# and all ratings
between will generate additional codes).
Wildcard -- Like range, this can be used to create many codes at one
time. Simply specify the wildcard required (for example, B36% will
generate all material codes with a design standard beginning with
B36).
Build all Commodities for -- When clicked, SmartPlant Materials will
use the range and/or wildcard specified to generate all the possible
codes. Progress will be indicated in the bottom window.

14 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Using Existing Data

HINT: IF SMARTPLANT MATERIALS PROMPTS, “DO YOU WISH TO


UPDATE COMMODITY CODE?” A RESPONSE OF “YES” WILL UPDATE THE
CODE AND DESCRIPTION; “NO” WILL SKIP THE ACTION AND CONTINUE
TO CREATE THE REMAINING CODES.

HINT: IT IS WISE TO ONLY USE ONE RANGE OR WILDCARD ENTRY AT A


TIME, SINCE THE COMBINATION OF RANGES CAN LEAD TO
SUPERFLUOUS CODES BEING CREATED.

Copy Commodity Code


After initial creation of the dataset, copy and modify is the normal method to create
codes:
1. Select screen S.30.01.
2. Query and select the appropriate groups and part and Commodity Code or use
LOV.
3. Click the New Record Icon (or function key F6).
4. A new entry exists with a random number.

SmartPlant Materials How to Define Piping Material 15


SmartPlant Reference Data Using Existing Data

5. Duplicate record (F4).


The following should appear (note the prefix “DUPL” in front of the copied
record):

9. Move the cursor to the section containing group and detail values.
10. Select the Group/Detail attribute to change.
11. Use LOV to select the new values(s).
12. Save the changes.
13. Click the “Build One Commodity” button.

SmartPlant Materials will update the commodity code and description to reflect the
changes made.

NOTE: RANGE AND WILDCARDS MAY ALSO BE USED IN CONJUNCTION


WITH THE COPY RECORD FUNCTION.

16 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Using Existing Data

Updating Commodity Codes and Descriptions


There are various ways a commodity code may be modified:

The table detail code entry changed in S.30.01. Here, either a new
detail code or a code from LOV can be selected. If a new code is
entered, the system inserts the code including the description into the
S20.03 tables. After you click the “Build One Commodity” button, the
commodity Code is updated.
Detail code changed in the supporting table (for example, from A to X
in screen S.20.02. If this is done, the commodity code will
automatically change to include X instead of A in the code when the
change is saved).
Detail code description change in the support table (for example,
B36.10 to B36.10M). In this case, the commodity code description will
be updated automatically when the changes are saved.
NOTE: CHANGES MADE IN BASE TABLES IN 2 AND 3 ABOVE WILL
PROPAGATE THROUGH ALL SMARTPLANT MATERIALS MODULES,
INCLUDING PURCHASE ORDERS AND SITE. CARE SHOULD BE TAKEN
SINCE THIS MAY LEAD TO ISSUED PURCHASE ORDERS READING
DIFFERENTLY FROM THAT WHICH IS SEEN IN SMARTPLANT MATERIALS.
THE IDENT WILL NOT CHANGE.

Deleting Commodity Codes


1. Enter S.30.01.
2. Query and select the code.
3. Select the delete record command (twice).
4. Save changes.
NOTE: THE CODE WILL ONLY BE DELETED IF IT IS NOT USED
ELSEWHERE IN SMARTPLANT MATERIALS.

SmartPlant Materials How to Define Piping Material 17


Ident Creation

Ident Creation
1. Go to S.80.01 Build New Idents.
14. Select the group and part. Go to [Next Blck].

15. Click the ‘Build Queried Idents’ or ‘Build all Idents’ button to start the Ident
generation process.

If you only want to build idents with specific


geometric values (for example, only S-80)
you can do the following:
Select the [enter query] mode.
Enter S-80 in the ‘Sch_1’ field.
Select the [Execute Query] mode.
Click ‘Build queried Idents’ (Not ‘Build all
Idents’).
Only idents with Schedule 80 will be
generated.

SmartPlant Materials will display the following message:

16. Click ‘OK’.

18 SmartPlant Materials How to Define Piping Material


Ident Creation

The next message will show how many idents have been created. In our case, (for
our commodity code ‘PPPAMB0C6B00’), it is 403 Idents.

All idents can be viewed on S.80.04 List All Idents.


SmartPlant Materials has
generated:
Idents
and
Ident codes.
They are initially identical
except that the ident code is
preceded with the letter ‘I’.
You can manually change
the ident code on this
screen if you wish to do so.
You cannot change the
ident.
It is the ident code that is
used in all material control
modules (for example,
BOMs, Requisitions, POs,
di t ti )
Ident text can be viewed on S.80.06 Ident Text.

SmartPlant Materials How to Define Piping Material 19


Ident Creation

Ident text (The result of the layout


defined in S.10.05).

HINT: IT IS ALSO POSSIBLE TO GENERATE ONLY THE IDENTS REQUIRED


FOR A GIVEN PIPE CLASS. IN THIS CASE, FEWER IDENTS WILL BE
CREATED TO MINIMIZE THE STORAGE REQUIREMENTS OF THE
DATABASE AND INCREASE THE SEARCH SPEED FOR SLOWER SERVERS.

20 SmartPlant Materials How to Define Piping Material


Supporting Data for Commodity Codes and Idents

Supporting Data for Commodity Codes and


Idents
The above examples used data that was already created. This section will detail how
to create the supporting data. The prerequisites may be categorized as follows:

Material Grouping and Rules


S.10.02 Commodity Groups
S.10.03 Commodity Part
S.10.01 Commodity Rule
S.10.04 Object Parameter
S.10.05 Object Parameter Detail
S.10.06 Part Object Parameter
Base Data
A.50.01 Attributes
A.50.02 Tables
S.20.01 Table names with groups
S.20.02 Table names with details
S.20.03 Parts with table groups (Optional, that is, recommended)
S.20.04 Parts with table details (Optional, that is, recommended)
Geometric Data
Geometric for Standardized Values
Geometric for Standardized Dimensions
Geometric for Commodity Dimensions
Commodity Geometric Relation
Geometric Simulation

SmartPlant Materials How to Define Piping Material 21


Supporting Data for Commodity Codes and Idents

Material Grouping and Rules


Material is categorized into Groups and Parts. Typically, a Group will be Pipe,
Flanges, and Elbows. Parts will be a type of component in the group (for example,
seamless pipe, raised face flanges, and so forth). These categories simply follow the
industry norm and are useful throughout SmartPlant Materials for managing material,
creating requisitions, and reporting data.

S.10.02 Group Definition


1. Select screen S.10.02.
2. Select the New Record icon.

The screen will appear as follows, and new data may be entered.

Our example follows the entry for Pipe, PP.

Note the following about the fields:

Group Type the name allocated to the new Material


Group. All or part of the text in the name can
be used later to form part of the commodity
code. This improves the readability of the code.

Rule Use LOV to select the Rule. It is the


commodity code format or structure definition.
This will be detailed later and may be changed
if required; for Pipe, it is P_PIPE.

22 SmartPlant Materials How to Define Piping Material


Supporting Data for Commodity Codes and Idents

Standard This is irrelevant as the Standard may be


defined again at a lower level and may
contradict whatever is specified here. The best
use for this is just descriptive.

Object The default Object Parameter for the group.


This is detailed later and refers to the geometry
format required to define the material.

Special Not applicable in this context.


Table

Short Desc Short Description for the group.

Description Full Description for the group.

Once defined, the group can be used in the part definition.

SmartPlant Materials How to Define Piping Material 23


Supporting Data for Commodity Codes and Idents

S.10.03 Part Definition


Parts are a subset of groups.
1. Select screen S.10.03.
2. Query and select the appropriate group (for example, PP for Pipe).
The screen will appear as follows, and new data may be entered:

Note the following about the fields:

Part Name Enter the new part name (type of


component). The part name may be
used in the commodity code in the
same way as the group name.

Rule The rule defines the format of the


commodity code. The defaults
specified for the group may be
changed if required.

Standard The defaults specified for the group


may be changed if required.

Attribute Set Intended for use by Equipment and


Instrumentation.

Short The descriptions.


Desc/Description

24 SmartPlant Materials How to Define Piping Material


Supporting Data for Commodity Codes and Idents

Additional Fields Scroll right. If MARIAN has been


configured to include the PDS
configuration, additional columns
that are relevant will appear on the
screen. In the delivered dataset,
there is the PDS Model code and a
Label code.
3. Save and exit.

Following the definition of Groups and Parts, the categorization of material is


complete at a high level.

S.10.01 Commodity Rule


The Commodity Rule is the format of the commodity code. A Rule defines the
attributes required for a code, the format in which the attributes are presented, and the
description for the material required attributes.
1. Select screen S.10.01.
2. Enter a new name and descriptions for the Rule.
3. Save and go to the next block.

SmartPlant Materials How to Define Piping Material 25


Supporting Data for Commodity Codes and Idents

4. Use LOV to select each attribute that is required to define the material.
Required Specifies if the field is mandatory or
not (it usually is).
Short/Long Specifies if the long and short
descriptions are to be used in the
commodity code definition (they
usually are).
Ctrl Indicates the revision status if active.

5. Save the changes and go to the next block.

26 SmartPlant Materials How to Define Piping Material


Supporting Data for Commodity Codes and Idents

Commodity Code Format


The Commodity Code Format is also known as the Commodity Key for the Rule.
This screen defines which attributes from the previous screen are used in the
commodity code number and the order in which they are arranged.

Digit The position in the commodity code where the


ID attribute appears (for example, digit ID 1 is the
first number in the commodity code).

Table Name of the base table that the attribute is in or


Name the group or part definition.

Ins Used if the attribute is blank. This may be used to


Char enter a hyphen between attributes. To do this,
create a ‘dummy’ table name on S.20.01 that
contains no entries, and specify a hyphen in this
screen. The dummy table on the previous screen
must be made NOT mandatory.

NOTE: THIS METHOD OF DEFINING COMMODITY CODES ALLOWS FOR A


FIXED FORMAT/LENGTH CODE. IF AN ATTRIBUTE IS TWO DIGITS
INSTEAD OF THREE, THERE WILL BE A BLANK SPACE IN THE CODE. THIS
CAN LEAD TO MISINTERPRETATION OF THE CODE AND SUBSEQUENT
ERROR. IT IS THEREFORE RECOMMENDED THAT WHEN USING FIXED
FORMAT/LENGTH CODING STRUCTURES, THE ATTRIBUTES ARE
ALWAYS THE SAME LENGTH. USE ZERO PADDING WHERE NECESSARY.

IT IS POSSIBLE TO DEFINE A COMMODITY CODE OF VARIABLE LENGTH


IF REQUIRED; AN EXAMPLE IS IN CODES FOR STRUCTURAL PROFILES
610UB125 AND 310UB46. IN BOTH CASES, THE CODE IS INDUSTRY-
ACCEPTED AND COMPRISES SIZE + PROFILE + WEIGHT/UNIT LENGTH.
6. Save changes and go to [NEXT BLCK].

SmartPlant Materials How to Define Piping Material 27


Supporting Data for Commodity Codes and Idents

Description Definition
NLS Defines the language that the description appears
in. It is possible to store multiple language
definitions for the same commodity code,
providing the base codes are also defined for the
languages used here.

Short Select the attributes that are used to make up the


Description description. The attributes appear between # marks.
After selecting from the LOV, you must add a
suffix to each attribute manually (that is,
#m_parts# must be changed to #m_parts_short# or
#m_parts_long# for the short and long descriptions,
respectively).

Layout Short Intended for use on drawings.

Layout Long Intended for purchasing. May have additional free


text added to format the description in a more
structured manner.

7. Save and exit.

The commodity code format is now complete and may be used in the Part Definition
on S.10.02/03. Refer to the section on Base Table Data if the required attributes and
tables do not exist.

28 SmartPlant Materials How to Define Piping Material


Supporting Data for Commodity Codes and Idents

Layout attribute length limitation


To make the whole layout (layout short or layout long) not exceed a stated length, you
can limit the length of the substitution of variables. Directly after the variable, you
write the maximum length framed in '#' (like the variable itself). Between the last '#'
of the variable and the first '#' of the limitation, no blank is allowed.

For example: #m_parts_long##10#

When building the layout of a commodity code from the template, the variable
#m_parts_long# is substituted by the description of the part, the length of the
description is limited to 10 characters, and the limitation itself is removed.

SmartPlant Materials How to Define Piping Material 29


Units

Units
A.10.06 Unit System
The unit system determines the quantity unit during the ordering process. For
example, if you worked on an imperial project, you would want to order pipe in
‘FEET’, whereas on a metric project, the quantity unit would be ‘METERS’. To set
up SmartPlant Materials for both possibilities, we use an “object parameter” that
includes reference to the unit system.

The second task of the object parameter is to define which geometric attributes are
linked to the commodity code. This provides a unique identification for the
component (that is, pipe will need nominal bore and schedule, but not weight or
surface area).

The object parameter is the link between commodity codes and geometric tables. It is
used when commodity codes are created and when idents are generated based on the
commodity-geometric relation. This means that the object parameter has a dual
function:

It specifies the appropriate geometric attributes that are to be used to


create idents.
It determines the quantity unit that is to be used in the ordering
process.

30 SmartPlant Materials How to Define Piping Material


Units

How this is accomplished in SmartPlant Materials is explained in the next four steps.

Unit system example:

Select the unit type with LOV.


One of these unit systems must be entered as a project default on
A.20.12. The graphic below shows that for the ‘EPC1’ project, the
‘US’ unit system (for Imperial projects) has been selected.

SmartPlant Materials How to Define Piping Material 31


Units

A.10.07 Unit Sets


With a unit set, we determine which quantity unit is used to purchase items (for
example, pipe is bought by length – linear and fittings are bought with the quantity
unit ‘Ea’ - each).

Assign the unit system to a unit set in the lower block. It can be
selected with LOV.
This definition accomplishes
the following:
For parts such as Pipe,
Tubing, and Cable that
require a LINEAR unit, the
quantity unit would be ‘M’
(Meters) for projects that use
the ‘Metric’ unit system as a
default, and ‘FT’ (Feet) for
projects that use the ‘US’
(Imperial).
A similar logic applies to parts
that are ordered with a
‘Number’ quantity unit such
as fittings or valves, and so
forth.
For these, the unit code for
imperial projects would be
‘Ea.’ (each), and for metric
projects, it could be ‘Stck’ or
‘Pieces’.

32 SmartPlant Materials How to Define Piping Material


Units

S.10.04 Object Parameters


Simply put, SmartPlant Materials needs to know how to interpret a geometric table
that is linked to a commodity code. The Object Parameter tells SmartPlant Materials
how to interpret the table. Usually, this is the order of the size and wall thickness
attributes. SmartPlant Materials uses this information in the generation of Idents. The
parameter also defines the Unit System that is used.

There are three sections to managing the Object Parameter:

Define the Object Parameter Name,


Define the Object Parameter Detail,
Assign the Object Parameter to a Group and Part,
An example of a geometric is shown below:

The Object Parameter defines the Column usage.

The first column is always the “Unit System” to define imperial or


metric values.
Columns 2 through 6 are the five input fields.
Columns 7 and greater are output fields.
This column usage does not vary.

SmartPlant Materials How to Define Piping Material 33


Units

Define the Object Parameter Name


The Object Name should have some logical meaning so that it may be easily
interpreted. In this example, D1S1L indicates that the geometric will have one
diameter, one schedule, and is linear.

At this point, the object parameter is only a name; the appropriate attributes will be
added in the next step.

Define the Object Parameter Detail


In this step, we define the attributes used in the Object Parameter and hence the
columns that will appear in the geometric table.

Define the table as follows:


1. Select the name of the object parameter in the first block (Object parameter).
2. Go to [Next Block] Parameter Detail.
3. Enter a sequence number (1 – n). This sequence number relates to the column
ORDER assigned to the attributes in the associated geometric tables and not the
column number.
Input numbers
The sequence for these is 1 to 5; there should be no gaps in the sequence numbers.
The sequence number is either an input to, or an output from the geometric table.
The inputs are defined by a checkmark in the “Input?” field.

34 SmartPlant Materials How to Define Piping Material


Units

Output numbers
Gaps are accepted between the sequence numbers for output fields.
If there are only two input fields defined, the first output field can be 3.
Gaps are allowed in the Output sequence numbers.
8. Enter a name in the ‘NAME’ field. This can be a synonym of the actual attribute.
9. Check the ident check box for those attributes that are to be used to create idents.
For Pipe, we need at least an attribute for the nominal size and one for the
schedule. In the example above (graphic), additional attributes have been selected.
This is because on metric projects, the outside diameter and the wall thickness are
specified on purchase orders. With the above definition, the Ident description
includes both the imperial attributes as well as the metric ones. But again, for
imperial projects, only the nominal size and the schedule are required. The others
are optional and included for reference only.
10. In the ‘Kind of Attribute’ field, select the kind (or type) of attribute: NPS or
Schedule.
11. Add a description.

SmartPlant Materials How to Define Piping Material 35


Units

Ident Description
The description defined here is appended to the commodity code description for use
with idents.
1. With [Next Blck], go to Window 2 of this screen.
2. Define the geometric values that are used in the ident description. The syntax
for the "LAYOUT LONG" and "LAYOUT SHORT" fields is identical.
3. Use LOV to select ‘NAME’ (synonym of the attribute). It is between the ‘#’
control signs. You may add additional text before and after these control signs.
The following graphic shows the definitions that will be used for pipe and the
results that these definitions generate.

Result

36 SmartPlant Materials How to Define Piping Material


Units

S.10.07 Assign the Object Parameter to a Group and Part


This is the link between a Part (and therefore a commodity code) and the Geometric
table it will use. This step may be ignored if the Commodity Geometric Relation is
defined in S.40.22. This is required if there are multiple geometric tables assigned to a
single part.
1. Select the group with the LOV function and go to [Next Blck].
2. Select part codes for the ‘Pipe’ group and enter the object parameter for
‘Pipe’.

SmartPlant Materials How to Define Piping Material 37


Units

Base Data for Commodity Codes & Idents


A.50.01 Attributes
A.50.02 Tables
S.20.01 Table names with groups
S.20.02 Table names with details

A.50.01 Attributes
Attributes are stored in logical groups. There are some industry-accepted groups
delivered in the dataset. These can be modified and new groups created, provided that
the overall integrity of the configuration is maintained.
1. To create a new group, use the “New Record” command and enter the group
name and description.

This screen is used to define


all attributes in MARIAN.
For PIPE, we have to define the
geometric attributes that are
required for purchasing. There
must be at least one attribute
for the nominal pipe size and
one for the schedule.
For our example, we are going
to define:
NPS_1 for nominal pipe size.
and
SCH_1 for schedule of the
pipe.
The other attributes are
optional and are included for
reference only.

38 SmartPlant Materials How to Define Piping Material


Units

The following groups exist:

12. To add a new attribute, use the “New Record” command in the second block
(attributes). Normal database conventions apply to the specification of the
attribute. However, it is often wise to copy the entries for a similar attribute to
ensure similar functionality. Attribute definitions can be changed at a later time if
necessary.

A.50.02 Commodity Attribute Tables


The database tables used to store material information in SmartPlant Materials need
defining to meet your company’s requirements. Many already exist in the default
dataset. The tables are generic tables, and each contains the following columns:

Name Used for the code value in SmartPlant Materials.

Short Desc Explains the code in short format.

Description Describes the code in long format suitable for


Purchasing.

Additional attributes may be added to the table as required. For example, PDS
Material Grade Codes would be added to the Material Commodity tables. The tables
are grouped logically, and it is important to use the appropriate group to avoid
difficulties in other areas of SmartPlant Materials.

SmartPlant Materials How to Define Piping Material 39


Units

For example, the GEOM_S4010 Type is for values used on screen S.40.10. If the
values do not exist in the correct group, they will not be available for use.

COMMATTR These are used in S.20.01/S.20.02 to


Tables define material attributes such as ASME
B36.10, Seamless, Beveled End, and
ASTM A106 Grade.

GEOM_S40XX Used in Geometric screens as the name


implies.

INTERFACE Used for PDS interface.

PHYSCIAL Part of the SmartPlant Materials core and


must not be altered.

SPEC Used for Piping Material Class Tables.

40 SmartPlant Materials How to Define Piping Material


Units

A.50.03 – Adding Attributes to Tables


This is necessary to customize the generic tables to suit each situation with special
requirements. For example, the commodity code has been assigned a Shop/Field
indicator and Account Group attribute so that values can be assigned to each
commodity code.

To add an attribute:
1. Select screen A.50.03.
2. Select the Type table. In this case, Physical tables are selected. It is OK to add
attributes but not change existing table definitions in the database.
3. Select the Table (for example, M_COMMODITY_CODES).
4. Use LOV to enter the attribute to add (it must already exist).
5. Enter the Physical Attribute Type.
There are several Attribute Types. In this case, the valid attribute type begins with
ATTR_CHAR or ATTR_NUM. (See the online help for a full description of Attribute
Types.) The number suffix on the attribute type determines the order in which the
attributes are displayed in the table.

S.20.01 Table Names with Groups


Tables are used to store attribute values for such information as design standard or
material grade. Before creating the details, it is necessary to define the grouping for
the details. If there is no need to group the details, there must still exist a group to
which the details are assigned.

For the ‘P_MATL’ Table, the


‘PIPE_MTLC’ group (Metallic
Pipe Material) is defined here.

The specified standard is a default and may be overridden at the part level.

SmartPlant Materials How to Define Piping Material 41


Units

S.20.01 Table Details


Table details are the attribute values that will be assigned in a commodity code (for
example, A1P is ASTM A691 Grade 9 CR). These attributes (table details) are
assigned to each appropriate table group.

HINT: SOME OF THESE TABLES WILL CONTAIN INTERFACE DETAILS FOR


PDS DATA TRANSFER. (REFER TO OTHER SESSION DETAILS FOR MORE
INFORMATION.) IT IS FOR THIS REASON THAT PDS REQUIREMENTS
SHOULD BE CONSIDERED CAREFULLY AND IN PARALLEL WITH
ENGINEERING DEFINITIONS (FOR EXAMPLE, TABLE NAME IS DEFINED IN
STEP 2 - A.50.02).

Table Group defined in Step 3 (S.20.01):

Table details with descriptions are defined on this screen.

42 SmartPlant Materials How to Define Piping Material


Units

S30.01 SPECIAL FEATURES


The following data described in chapters 4.1-4.3 can also be created directly on screen
S30.01. This feature is especially useful if only a few new commodity codes with a
few new base data must be created.

S.10.02 Group Definition

S.10.03 Part Definition

S.20.01 Table Names with Groups

S.20.01 Table Details

To create these data entries, on screen S30.01 enter the needed values into the
appropriate fields. SmartPlant Materials will always ask whether a new entity should
be created.

Example for a new table detail:

After clicking Yes, please insert the new TD description

SmartPlant Materials How to Define Piping Material 43


Units

After you click Yes, the system saves the value into the appropriate base table; here, it
saves it into P_DSGN_STD detail BEV. To save the record against the actual
commodity code, press COMMIT (F10).

44 SmartPlant Materials How to Define Piping Material


Units

Geometrics
SmartPlant Materials geometric tables may be divided into three types:

Tables for standardized values.


Tables for standardized dimensions.
S.40.12 Commodity Geometrics.

Geometric Tables for Standardized Values


The structure is pre-defined for these tables. Examples are shown below:

Nominal sizes S.40.01

Outside diameter S.40.02

Wall thickness (for DIN only) S.40.07

Nominal reducer (standard number of reductions) S.40.03

Branches S.40.05

Schedules (for ANSI only) S.40.06

S.40.01 Nominal Sizes

This table contains standard US pipe sizes as can be seen in the next block.

SmartPlant Materials How to Define Piping Material 45


Units

All standard pipe


sizes with the
dimensional unit
(In.) must be
defined here.

S.40.02 Outer Diameter

These tables contain standard outside diameters for pipe and fittings. They are
primarily used for metric projects. See values in the next block:

46 SmartPlant Materials How to Define Piping Material


Units

S.40.06 Schedule

Go to [Next Blck]:

Tables for Standardized Dimensions


The table structure for these table types is user-defined on A.50.02 and A.50.03,
respectively (that is, they are not provided by the system).

S.40.10 Standard Geometrics (User-definable application)


Example: A table may contain all standard dimensions for weld neck flanges by rating
(for example, NPS, length, flange diameter, bolt circle, number of bolts, and so forth).

S.40.11- Other Geometrics (User-definable application) – used for custom


requirements.

S.40.13 Filter Geometrics (User-definable application)


Example: S.40.13 Filter Geometric is used to filter schedules in Pipe classes.

SmartPlant Materials How to Define Piping Material 47


Units

48 SmartPlant Materials How to Define Piping Material


Units

S.40.12 Commodity Geometrics (User-definable


Application)
Only tables of this type will be used for ‘Commodity Geometric Relations’ and
subsequently for the generation of idents. They are so named for the Geometrics that
belong to commodities (for example, flange dimensions).

See [Next Blck] for details.

SmartPlant Materials How to Define Piping Material 49


Units

This table structure was created on A.50.03. Please note the alignment of the Input
and Output fields.

Commodity Geometric Relation


The purpose of this functionality is to create a relationship between Commodity
Codes and Commodity Geometrics so that idents may be automatically generated.

Step 1
First, the geometric must be created for the material. Enter a name and
description for the geometric table structure on A.50.02 Tables.

The type must be


‘GEOM_S4012’.

Enter a name and description of the table structure.

50 SmartPlant Materials How to Define Piping Material


Units

Step 2
Define (attribute) columns for the structure on A.50.03
Tables/Attributes.
2.1 With LOV, call up the
‘GEOM_S4012’ table type.

2.2 With LOV, call up the


table structure name defined
in the previous step.

2.4 With LOV, assign physical attributes.


2.3 With LOV, call up geometric They are provided by the system.
attributes defined on A.50.01, or Example: GD.IN1 stands for Geometric
copy the attributes that you have Detail, Input 1. This means that in our
assigned to the object parameter case, NPS_1 will appear in the first column
for PIPE (see S.10.05). of the geometric table.

SmartPlant Materials How to Define Piping Material 51


Units

In our example, the geometric table would look like the graphic below.

GD.IN1 GD.IN3 GD.IN5 GD.OUT1 GD.OUT3


GD.OUT5

GD.IN2 GD.IN4 GD.OUT2 GD.OUT4

Each geometric table consists of a maximum of five input fields


and 15 output fields. For more details, read the ‘Geometrics’
section at the end of this manual.

52 SmartPlant Materials How to Define Piping Material


Units

Step 3
Create the geometric table on S.40.12 Commodity Geometrics.

Enter a With LOV, assign Enter descriptions


name for the table structure for the geometric
the table. defined on A.50.03. table.

Go to [Next Blck].
Enter data. (For a more efficient way to fill geometric tables with data,
read the ‘Geometric simulation’ section at the end of this manual.)

SmartPlant Materials How to Define Piping Material 53


Units

Step 4
Create the Geometric Rule on S.40.21 Geometric Rule.
Enter a name for the rule. In line with our Best Practice philosophy, it
should be the same as the geometric table used for Commodity
geometric relations (S.40.12).
‘Formular’ is used for
Geometric simulation. This
function is explained at the
end of this manual.
Add a comment.

With LOV, select Group Code, Part Code, and the Geometric Table
from S.40.12.

In these fields you have the


option to filter according to
geometric values (for This definition will filter out those commodity
example, size or schedule). codes that have an end type = ‘B’ (Beveled
End) and the geometric standard = ‘A’,
which in our case means B.36.10. This
means that only commodity codes with
Starts the commodity- these table details will be included in the
geometric relation. commodity-geometric relation.

The block ‘Geometric Rule Definition’ constitutes the geometric relation. In our
example, all commodity codes belonging to the ‘PP’ Commodity Group and the ‘P’
Commodity Part will be related to the ‘UPP’ geometric table. If the ‘Part code’ field
is left blank, all the parts and all their commodity codes will be related to the
geometric.

The ‘Ident’ check box is checked by default. If you uncheck it, this relation will not
be included when you build idents.

The ‘Formular’ field is not used in Commodity Relations. It is on this screen because
the screen is common to the Geometric Simulation command.

54 SmartPlant Materials How to Define Piping Material


Units

Step 5
Create the Geometric Relation by clicking the ‘Commodity Relation’
button. The result can be viewed on screen S.40.22 Commodity
Geometric Relation.

Select the Group and


Part and go to [Next
Blck].

Here you can view and delete commodity-geometric relations. The purpose of this
screen is to provide you with the opportunity to check the relation you have just
created and make corrections, if necessary, before building idents.

Commodity

Geometric relation

The Geometric Relation is now created and the idents may be created.

SmartPlant Materials How to Define Piping Material 55


Units

Geometric Simulation
Geometric Simulation allows new geometrics to be created from existing geometric
tables. Any user-defined geometric table can be filled with data by means of the
‘Geometric simulation’ function.

Using this function, it is very easy to create geometrics that do not reflect
commercially available commodities – and are therefore erroneous information in the
database. This function is primarily used for tables that are required for commodity-
geometric relations (that is, tables of the ‘S.4012’ type). See the graphic below:

Since the data shown in this table exists somewhere in the standard tables (that is, on
S.40.01 through S.40.07), it would not make sense to enter this data again manually in
a user-defined table. Instead, it should be copied with the Geometric Simulation
function.

56 SmartPlant Materials How to Define Piping Material


Units

The following geometric values will be copied in this example:

NPS_1 Nominal size

SCH_1 Schedule

OD_1_IN Outside diameter in Inches

OD_1_MM Outside diameter in MM

THK_1_IN Wall thickness in Inches

THK_1_MM These geometric values don’t exist in


standard tables and are not included.

Step 1
S.40. Geometric Formulas

Geometric Formulas are copy instructions. Here you have to specify which geometric
values you want to copy from which table. It does not have to be a standard table
(S.40.01 through S.40.07); it can be any geometric table.

Enter a meaningful name for the Formula.


Go to [Next Blck] Tables to be used in Formula.
With LOV, select a table type you want to copy from. In our example,
it is the ‘SCHEDULE’ type.
In the ‘Table’ field, select a table of the ‘SCHEDULE’ type. In our
example, it is the ‘U_B36.10’ table. This table includes the values DN
(NPS), Schedule, and WT (wall thickness).

All three values will be copied.

SmartPlant Materials How to Define Piping Material 57


Units

Go to [Next Blck]. Columns to be used with Formula and table.


Select the attributes you want to copy in the ‘Column name’ field.

Assign a label in the ‘Label’ field. For the ‘DN’ (NPS) attribute, you
should specify the table name as a label.
Assign an order (sequence) number in the ‘Order’ field.

This order number determines where these attributes should appear in your user-
defined table. In our example, it is the ‘UPP’ geometric table of the type S.40.12.
See the graphic below.
NPS_1 (DN) = Order 1, SCH_1 = Order 2, WT (THK_1_IN) = Order 8

Next we need to copy the outside diameters. You must check your
standard tables to find out where these values have been defined.
In this database, there are two tables: one for outside diameters in inches and one
in millimeters. Both tables must be used in our Formula.

58 SmartPlant Materials How to Define Piping Material


Units

Select the ‘Outer diameter’ table type and the ‘U_OD_MM’ table for
the outside diameter in MM.

Select column names (attributes) and assign labels and an order


number. Notice that ‘DN’ has been selected again, although we already
copied it with our previous instruction. But this time the ‘Displ’
(Display) check box has been checked off because DN only needs to
be displayed once. The outside diameter (MM) will be copied to
column 7 in the user-defined table.
Select the ‘Outer Diameter’ table type and the ‘U_OD_US’ table for
the outside diameters in inches.

Select attributes and assign labels and order numbers:


DN = Order 1 Displ (has been checked off)
OD = Order 6

Go to [Next Blck].
In this last block, we have to specify the relations between the columns
used in the Formula. But we are only concerned with the nominal
sizes.

The above definitions have the following meaning: The nominal sizes from the
U_B3610 table of the ‘Schedule’ type have to be equal to the nominal sizes from the
U_OD_MM table (Outer diameter type) and also to the nominal sizes from the

SmartPlant Materials How to Define Piping Material 59


Units

U_OD_US table (Outer diameter type). This is why it is helpful to enter the name of
the table in the Label field. See below:

The name of the table where


the DN values come from is
repeated here.

SmartPlant Materials now appends DN with the name of the table when you define
the column relations.

Notice that the column clause has a different value for each attribute. These values
can also be used when you establish the relations, but the above method is simpler.

So far we have been concerned with source tables (that is, tables we copy from). In
the next step, we must specify the destination table (that is, the table we are trying to
fill with the data).

60 SmartPlant Materials How to Define Piping Material


Units

Step 2
Go to S.40.21 Geometric Rules.
We have seen this screen before when we created the commodity-geometric
relations for the purpose of creating idents. It has a dual function: It is used to
create the commodity-geometric relation, and it also includes the copy instruction
(Formula) that is used to complete the specified geometric.

The ‘UPP’ geometric table is filled with data using the


copy instructions of the ‘UPIPE’ Formula.

SmartPlant Materials How to Define Piping Material 61


Units

Step 3
Go to S.40.30 Geometric Simulation.
With LOV, select the name of the Formula and check the ‘Simulate’
check box.

Click ‘Validate’. SmartPlant Materials will check your definitions.

Click ‘Simulate’. This will start the copying process.

SmartPlant Materials will now display the geometric.

62 SmartPlant Materials How to Define Piping Material


Units

Go to [Next Blck].
The geometric values have been copied to a temporary table for you to review
them.

If the values are correct, check the ‘Transfer’ check box.


Activate the ‘Add only new rows’ or ‘Replace old by new rows’ button
if you want to perform an update. The geometric values will now be
transferred to your table (UPP).
Step 4
Go to S.40.12 Commodity Geometrics Window 2 to verify the
transfer.

SmartPlant Materials How to Define Piping Material 63


Units

Step 5

S.20.01 Table Name with Groups.


To each of the "Table Name" items created on A50.02, a table group
has to be assigned. You should have good reasons why grouping
should be used. Even if groups are not appropriate, there must be at
least one default group entry.
For the ‘P_MATL’ Table, the
‘PIPE_MTLC’ group (Metallic
Pipe Material) is defined here.

64 SmartPlant Materials How to Define Piping Material


Units

Step 6
Table details are the attribute values that will be assigned in a commodity code (for
example, A1P is ASTM A691 Grade 9 CR). These attributes (table details) are
assigned to each appropriate table group.

HINT: SOME OF THESE TABLES WILL CONTAIN INTERFACE DETAILS FOR


PDS DATA TRANSFER (for example, the TABLE NAME DEFINED IN STEP 2 -
A.50.02). REFER TO OTHER SESSION DETAILS FOR MORE INFORMATION.
THE TABLE GROUP IS DEFINED IN STEP 3 - S.20.01. TABLE DETAILS WITH
DESCRIPTIONS ARE DEFINED IN THIS SCREEN.

Step 7

The Commodity Code Rule defines the format of the commodity code. It does this by
specifying which attributes are required and in what order they will appear in the
code.

On this screen, a name for the "RULE" has to be entered. The name
should indicate the items or components to which the rule will be
applied (for example, if this rule will be applied to PIPE, the rule could
simply be named ‘PIPE’). In our example (see the graphic below) it
was named ‘P_PIPE’.

SmartPlant Materials How to Define Piping Material 65


Units

HINT: THE PREFIX P INDICATES THE PIPING DISCIPLINE SO THAT ALL


PIPING RULES ARE EASILY IDENTIFIED. THE INPUT FOR "TABLENAME"
CAN BE SELECTED BY THE LOV FUNCTION. THESE ARE THE TABLES WE
HAVE DEFINED ON A.50.02. THEY CONTAIN THE PROPERTIES
(ATTRIBUTES) FOR PIPE. IF THE “REQUIRED” COLUMN IS CHECKED FOR
A TABLE NAME, THEN IT MUST BE USED TO CREATE THE COMMODITY
CODE LATER. IF THE ‘REQUIRED’ FIELD IS NOT CHECKED FOR A TABLE,
ITS USE IS OPTIONAL WHEN YOU CREATE COMMODITY CODES.

Go to [Next Block] Window 2 of this screen: "COMMODITY KEY


FOR RULE" and define the structure of your commodity code.
By means of the LOV button, select all table names from page 1 of this
screen, as well as two additional default settings:
‘M_COMMODITY_GROUPS’ and "M_PARTS". They are provided
by the system and their meaning will be explained in the next two
steps. The number of times a table is selected here determines how
many digits are used to represent a particular property of the
commodity code.

66 SmartPlant Materials How to Define Piping Material


Units

Example: The ‘P_MATL’ table (Material) has been


selected three times in this case. This means that
material will be represented with three digits in the
commodity code (digits 8, 9, and 10).

HINT: IF A HYPHEN IS REQUIRED IN THE COMMODITY CODE, THEN A


“DUMMY” OR “CHARACTER” TABLE MUST BE DEFINED IN THE SAME
MANNER AS OTHER TABLES. THIS TABLE CAN CONTAIN A HYPHEN “-”
CHARACTER OR YOU CAN DEFINE A DEFAULT “-” IN THE COLUMN “INS
CHAR”.

HINT: IF A TABLE DETAILS ATTRIBUTE HAS A VARIABLE LENGTH (FOR


EXAMPLE, SOMETIMES TWO-DIGIT AND SOMETIMES THREE), THEN THE
GREATEST NUMBER OF DIGITS SHOULD BE SPECIFIED AND A DEFAULT
CHARACTER SPECIFIED IN THE “INS CHAR” COLUMN. ALTERNATELY, IF
THE COMMODITY CODE IS REQUIRED TO BE VARIABLE IN LENGTH,
THEN A DIFFERENT CONFIGURATION IS REQUIRED (FOR EXAMPLE,
TABLE LINKING OF TABLE ATTRIBUTES AS SEEN IN THE STRUCTURAL
DISCIPLINES 1200WB137 AND 900WB123).

HINT: EVEN IF AN ATTRIBUTE IS FOUR CHARACTERS LONG, IT IS


POSSIBLE TO ONLY USE THE FIRST TWO IN THE COMMODITY CODE
FORMAT IF THIS IS REQUIRED.

Now use [Next Block] to go to Window 2.1 - Rule Layout.


Rule Layout is the commodity code description format definition. The
definitions in the "LAYOUT SHORT" field will be applied with the
generation of the short descriptions that are used in Pipe Classes, on
BOMs, and in Requisitions. The definitions in the "LAYOUT LONG"
field will be applied with the generation of the long (ordering)
descriptions that are used in Purchase Orders.

SmartPlant Materials How to Define Piping Material 67


Units

Start by selecting the language in which your description should be


generated. You can create a different layout for each language.

Next, using LOV, select the tables from page 2 of this screen (List of
Values) in the sequence in which the values should appear. Append the
values with ‘_short’ for the short description and with ‘_long’ for the
ordering description. The table names have to be between the ‘#’
control signs. Additional text that is not generated by attributes (not
between these control signs) will appear as it is entered here for every
commodity code that is created with this rule.
HINT: IT IS POSSIBLE TO COPY ANOTHER LAYOUT RULE BY SELECTING
“NEXT BLOCK”, SEARCHING FOR THE CODE REQUIRED, COPYING, AND
PASTING IT BACK INTO THE LAYOUT RULE BEING CREATED.

68 SmartPlant Materials How to Define Piping Material


Units

Example:

The result of the above definitions looks like this:

SmartPlant Materials How to Define Piping Material 69


Units

Step 8
The unit system determines the quantity unit during the engineering and ordering
process. For example, if you worked on an imperial project, you would want to order
Pipe in ‘FEET’. However on a metric project, the quantity unit would be ‘METERS’.

To set up SmartPlant Materials for both possibilities, we use an “object


parameter” that includes reference to the unit system.
The second task of the object parameter is to define which geometric
attributes are linked to the commodity code to provide a unique
identification for the component (that is, pipe will need nominal bore
and schedule but not weight or surface area). The object parameter is
the link between commodity codes and geometric tables. It is used
when commodity codes are created and when idents are generated
based on the commodity-geometric relation. This means that the object
parameter has a dual function:
- It specifies the appropriate geometric attributes that are to be used to create
idents.
- It determines the quantity unit that is to be used in the ordering process.

How this is accomplished in SmartPlant Materials is explained in the next four steps.

Step 1

Select the unit type with LOV. One of these unit systems must be
entered as a project default on A.20.12. The graphic below shows that
for the ‘EPC1’ project, the ‘US’ unit system (Imperial projects) has
been selected.

70 SmartPlant Materials How to Define Piping Material


Units

Step 2
With a unit set, we determine which quantity unit is used to purchase
items (for example, pipe is bought by length (linear) and fittings are
bought with the quantity unit ‘Ea.’ (each)). The unit system is then
assigned to a unit set in the lower block. It can be selected with LOV.
This definition accomplishes the
following: For parts such as Pipe,
Tubing, and Cable that require a
LINEAR unit, the quantity unit
would be ‘M’ (Meters) for projects
that use the unit system ‘Metric’ as
a default, and ‘FT’ (Feet) for
projects that use the ‘US’ (Imperial)
unit system as a default.
A similar logic applies to parts that
are ordered with a ‘Number’
quantity unit such as fittings or
valves. For these, the unit code for
imperial projects would be ‘Ea.’
(each), and for metric projects, it
could be ‘Stck’ or ‘Pieces’.

Step 3
The object parameter determines which attributes link the commodity code to the
geometric tables. The parameter also defines the Unit System that is used.

Please note that at this point the object parameter is only a name. The appropriate
attributes will be added in the next step.

Step 4

SmartPlant Materials How to Define Piping Material 71


Units

In the previous step, we defined a name for an object parameter. In this step, we
define the attributes used in the object parameter and their associated details. Proceed
as follows:

In the first block (object parameter), select the name of the object
parameter as defined in the previous step using LOV. In our example,
we select ‘D1S1L’.
Go to [Next Block] (parameter detail).
Enter a sequence number (1 – n).
Logic for input numbers:

Input numbers represent a set of geometrical values that define a unique article
(ident). In CAD systems, the input values are set manually by the designer or are
taken over by the component the system is actually connected to. A pipe normally is
identified by two input values -- NPS1 and Schedule1. A reducer normally has four
input values -- NPS1, NPS2, Schedule1, and Schedule2.

This sequence number relates to the position of the attributes in the associated
geometric tables. The input figures for the "No" field must start with number 1 and
must be in an ascending order. This ascending order must be without any gap. The
input figures for the "No" field must be in line with the position of the input values
used on A.50.03 when the structures for the ‘S.40.12’ table types are created.

Logic for the output numbers:

Output numbers are additional information that depends on the input values and that
does not create a uniqueness of an ident. For example, outer diameter for a pipe
depends on the NPS1 of this pipe.

The first output number following an input number is determined from the maximum
input value number, plus the position of the output column of A.50.03 and S.40.12,
respectively. SmartPlant Materials will accept an ascending order for the output
values with gaps (for example, if the last input value is No. 5, the first output value
could be 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 S.40.12.

Check the input field for those attributes that are entered in the first
five columns of the geometric table. (User-defined geometric tables
have five input fields and 15 output fields.)
Enter a name in the ‘NAME’ field. This can be a synonym of the
actual attribute.
Check the ident check box for those attributes that are to be used to
create idents.

72 SmartPlant Materials How to Define Piping Material


Units

For pipe, we need at least one attribute for the nominal size and one for the schedule.
In the example above (graphic), additional attributes have been selected. This is
because on metric projects, the outside diameter and the wall thickness are specified
on purchase orders. With the above definition, the ident description includes both the
imperial attributes as well as the metric ones. But again, for imperial projects, only the
nominal size and the schedule are required. The others are optional and included for
reference only.

In the ‘Kind of Attribute’ field, select the kind (or type) of attribute:
NPS or Schedule.
Add a description.
With [Next Block], go to Window 2 of this screen.
Define the geometric values that are used in the ident description. The
syntax for the "LAYOUT LONG" and "LAYOUT SHORT" fields is
identical.
Use LOV to select the ‘NAME’ (that is, the synonym of the attribute).
It is between the ‘#’ control signs. You may add additional text before
and after these control signs.

SmartPlant Materials How to Define Piping Material 73


Units

The following graphic shows the definitions that will be used for pipe and the results
that these definitions generate:

The results of the definitions can be seen on S.80.06 Ident Text:

Result

Step 9
‘Commodity Group’ can be defined as the first classification level for bulk material.
Examples are: Pipe, BW Fittings, Forged Fittings, Flanges, Valves, Bolts, Gaskets,
and so forth.

In our example, ‘PP’ has been used to define the name for the Pipe group. In the
‘Rule’ field, we select the rule for Pipe, which was defined in the previous step by
using the LOV function. The ‘ASME’ value in the ‘Standard’ field was defined in
Administration as the default and will be displayed automatically. The value of this
field has no impact on SmartPlant Materials functionality and is included to maintain
compatibility with the previous version of SmartPlant Materials. It is possible to have
different standards listed underneath this initial default.

Next, we select the object parameter for pipe in the ‘Object’ field and add a
description for the pipe group. In our case, the group is for Pipe and Tubing.

74 SmartPlant Materials How to Define Piping Material


Units

In our example, the ‘PP’ will occupy the first two digits of the commodity code since
we have entered ‘M_COMMODITY_GROUPS’ against the first two digits in our
commodity rule on S.10.01 Commodity Key for rule.

Step 10
‘Commodity Part’ can be defined as the second classification level of bulk material.
In other words, it is a subdivision of the commodity group. Here, you can enter more
specifically the types of pipe you want to define. Notice that the parts will
automatically inherit the rule assigned to the group.

In our example, the ‘P’ will occupy the third digit of the commodity code since we
have entered ‘M_PARTS’ against the third digit in our commodity rule on S.10.01
Commodity Key for Rule. The remaining digits will come from attribute tables. Table
details are defined on S.20.02.

Step 11
In the last step before we can create commodity codes, we assign object parameters to
parts.

Select the group with the LOV function and go to the next block.

SmartPlant Materials How to Define Piping Material 75


Units

Now select the part codes of the ‘Pipe’ group and enter the object
parameter for ‘Pipe’.

76 SmartPlant Materials How to Define Piping Material


Units

Phase 2. Create Idents


As we said earlier, commodity codes must be linked to a geometric table. On the basis
of this link (relation), SmartPlant Materials idents are generated.

Example: The commodity code


PPPAMB0C6B00 is related to the ‘UPP’
geometric table.

Based on this relation (link), one ident is


created for each of the records shown in this
table.

So the combination of

Commodity code + Geometric values

=
Ident

As shown in the above graphic, we need commodity codes and geometric tables to
generate idents in SmartPlant Materials. The geometric table shown in this graphic is
a user-defined table (that is, it is not provided by the system). For a more
comprehensive explanation on the logic of Geometrics in SmartPlant Materials, read
the ‘GEOMETRICS’ section at the end of this manual.

SmartPlant Materials How to Define Piping Material 77


Units

How to generate idents step-by-step:

Step 1
First, the geometric must be created for the material. Enter a name and
description for the geometric table structure on A.50.02 Tables. Enter a
name and description of the table structure.

The type must be


‘GEOM_S4012’.

Step 2
Define (attribute) columns for the structure on A.50.03
Tables/Attributes. 2.1 With LOV, call up the
‘GEOM_S4012’ table type.

2.2 With LOV, call up the


table structure name defined
in the previous step.

2.4 With LOV, assign physical


2.3 With LOV, call up attributes. They are provided by
geometric attributes (defined on the system. Example: GD.IN1
A.50.01), or copy the attributes stands for Geometric Detail, Input
that you have assigned to the 1. This means that in our case,
object parameter for PIPE. NPS_1 will appear in the first
(See S.10.05.) column of the geometric table.

78 SmartPlant Materials How to Define Piping Material


Units

In our example, the geometric table would look like the graphic below.

GD.IN1 GD.IN3 GD.IN5 GD.OUT1 GD.OUT3 GD.OUT5

GD.IN2 GD.IN4 GD.OUT2 GD.OUT4

Each geometric table consists of a maximum of five input fields and 15


output fields. For more details, read the ‘Geometrics’ section at the end
of this manual.

SmartPlant Materials How to Define Piping Material 79


Units

Step 3
Create the geometric table on S.40.12 Commodity Geometrics.

Go to [Next Blck].
Enter data. (For a more efficient way to fill geometric tables with data,
read the ‘Geometric Simulation’ section at the end of this manual.)

80 SmartPlant Materials How to Define Piping Material


Units

Step 4
To create the Geometric Rule on S.40.21 Geometric Rule, enter a
name for the rule. In line with our Best Practice philosophy, it should
be the same as the geometric table used for commodity geometric
relations‘Formula’
(S.40.12).is used for Geometric
simulation. This function is
explained at the end of this
Add comments.
l

With LOV, select Group Code, Part code, and the Geometric table from S.40.12.

In these fields, you have the possibility


to filter according to geometric values
(for example, size or schedule).
This definition will filter out those commodity
codes that have an end type = ‘B’ (Beveled
Starts the commodity- End) and the geometric standard = ‘A’,
geometric relation. which in our case means B.36.10. Only
commodity codes with these table details will
be included in the commodity-geometric
relation.

The ‘Geometric Rule Definition’ block constitutes the geometric


relation. In our example, all commodity codes belonging to the ‘PP’
commodity group and the ‘P’ commodity part will be related to the
‘UPP’ geometric table. If the ‘Part Code’ field is left blank, all the
parts and all their commodity codes will be related to the geometric.
The ‘Ident’ check box is checked by default. If you uncheck it, this
relation will not be included when you build idents.
The ‘Formula’ field is not used in commodity relations; it is on this
screen because the screen is common to the Geometric Simulation
command.
After all definitions have been made, click the ‘Commodity Relation’
button.

SmartPlant Materials How to Define Piping Material 81


Units

The result can be viewed on screen S.40.22 Commodity Geometric


Relation.

Select Group and Part and


go to [Next Blck].

Here you can view and delete commodity-geometric relations. The


purpose of this screen is to provide you with the opportunity to check
the relation you have just created and make corrections if necessary
before you build idents.

Commodity-
Geometric relation

Step 5
Go to S.80.01 Build New Idents.

82 SmartPlant Materials How to Define Piping Material


Units

Select group and part and go to [Next Blck].


Click ‘Build Queried Idents’ or ‘Build All Idents’ to start the ident
generation process.

If you only want to build idents with specific


geometric values, for example, only S-80, you
can do the following.
Select the [enter query] mode.
Enter S-80 in the ‘Sch_1’ field.
Select the [Execute Query] mode.
Click ‘Build Queried Idents’ (Not ‘Build All
Idents’).
Only idents with Schedule 80 will be generated.

SmartPlant Materials will display the following message:

Click ‘OK’.
The next message will show how many idents have been created. In our case (for
our commodity code ‘PPPAMB0C6B00’), it is 403 Idents.

All idents can be viewed on S.80.04 List All Idents.

SmartPlant Materials How to Define Piping Material 83


Units

MARIAN has generated


Idents
and
Ident codes.
They are initially identical
except that the ident code is
preceded with the letter ‘I’.
You can manually change
the ident code in this
screen. You cannot change
the ident.
It is the ident code that is
used in all material control
modules (for example,
BOMs, Requisitions, Pos,
and in construction).

Ident text can be viewed on S.80.06 Ident Text.

Ident text (The result of the


layout defined on S.10.05).

This concludes the subject on SmartPlant Materials idents. The following subjects
provide more detailed information on the structure and usage of geometric tables as
well as on the ‘Geometric Simulation’ function.

84 SmartPlant Materials How to Define Piping Material


Units

Geometrics
With respect to their usage, SmartPlant Materials geometric tables may be divided
into three types:

Type 1: Tables for standardized values

Type 2: Tables for standardized dimensions

Type 3: S.40.12 Commodity Geometrics

Type 1: Tables for standardized values


In these tables, the structure is pre-defined. Three examples are shown below.

Nominal Sizes S.40.01

Outside diameter S.40.02

Wall thickness (for DIN only) S.40.07

Nominal reducer (standard number of reductions) S.40.03

Branches S.40.05

Schedules (for ANSI only) S.40.06

S.40.01 Nominal sizes

This table contains standard US pipe sizes as can be seen in the next block.

SmartPlant Materials How to Define Piping Material 85


Units

All standard pipe sizes


with the dimensional
unit “ (In.) must be
defined here.

S.40.02 Outer Diameter

These tables contain standard outside diameters for pipe and fittings. They are
primarily used for metric projects. See values in the next block:

86 SmartPlant Materials How to Define Piping Material


Units

S.40.06 Schedule

Go to [Next Blck].

Type 2: Tables for standardized dimensions.


These table types are user-defined (that is, they are not provided by the system and
they have to be defined on A.50.02 and A.50.03, respectively.)

S.40.10 Standard Geometrics (User-definable application)


Example: A table may contain all standard dimensions for weld neck flanges by rating
(for example, NPS, length, flange dia., bolt circle, number of bolts, and so forth).

SmartPlant Materials How to Define Piping Material 87


Units

S.40.11 Other Geometrics (User-definable application)

S.40.13 Filter Geometrics (User-definable application)


Example: S.40.13 Filter Geometric -- Used to filter schedules in Pipe classes
.

Type 3 S.40.12 Commodity Geometrics (User-definable application)


Only tables of this type will be used for ‘Commodity Geometric Relations’ and
subsequently for the generation of idents.

Table name Name of table structure Description


Defined here. assigned to Geometric.
Defined on A.50.02/03

88 SmartPlant Materials How to Define Piping Material


Units

This table structure was created on A.50.03. Check the Input and Output fields.

Geometric Simulation
Geometric Simulation allows new geometrics to be created from existing geometric
tables. Any user-defined geometric table can be filled with data by means of the
‘Geometric Simulation’ function. This function is primarily used for tables that are
required for commodity geometric relations (that is, tables of the ‘S.40.12’ type). See
the graphic below.

Since the data shown in this table exists somewhere in standard tables (that is, in
S.40.01 through S.40.07), it would not make sense to enter this data again manually in
a user-defined table. Instead, it should be copied with the Geometric Simulation
function. The following geometric values will be copied in this example.

SmartPlant Materials How to Define Piping Material 89


Units

NPS_1 (Nominal size)

SCH_1 (Schedule)

OD_1_IN (Outside diameter in Inches)

OD_1_MM (Outside diameter in MM)

THK_1_IN (Wall Thickness in Inches)

THK_1_MM These geom. values don’t exist in standard tables and are not
included.

90 SmartPlant Materials How to Define Piping Material


Units

Step 1
S.40 Geometric Formulas are copy instructions. Here you have to specify which
geometric values you want to copy from which table. It does not have to be a standard
table (S.40.01 through S.40.07); it can be any geometric table.

Enter a meaningful name for the Formula.


Go to [Next Blck] Tables to be used in Formula.
With LOV, select a table type you want to copy from. In our example,
it is the ‘SCHEDULE’ type.
In the ‘Table’ field, select a table of the ‘SCHEDULE’ type. In our
example, it is the ‘U_B36.10’ table.
This table includes the values DN (NPS), Schedule, and WT (wall thickness).

All three values will be copied.

Go to [Next Blck] Columns to be used with Formula and table.


Select the attributes you want to copy in the ‘Column Name’ field.

Assign a label in the ‘Label’ field. For the attribute ‘DN’ (NPS), you
should specify the table name as a label. The reason for this will
become apparent in the ‘Next Block’.

SmartPlant Materials How to Define Piping Material 91


Units

Assign an order (sequence) number in the ‘Order’ field.

This order number determines where these attributes should appear in


your user-defined table. In our example, it is the ‘UPP’ Geometric
table of the type S.40.12. See the graphic below.
NPS_1 (DN) = Order 1, SCH_1 = Order 2, WT (THK_1_IN) = Order 8

Next, we need to copy the outside diameters. You must check your
standard tables to find out where these values have been defined. In
this database, there are two tables: one for outside diameters in inches
and one in millimeters. Both tables must be used in our Formula:

Select the ‘Outer diameter’ table type and the ‘U_OD_MM’ table for
the outside diameter in MM.

Select column names (attributes) and assign labels and an order


number. Notice that ‘DN’ has been selected again, although we already
copied it with our previous instruction. But this time the ‘Displ’
(Display) check box has been checked off because DN only needs to
be displayed once.
The Outside diameter (MM) will be copied to column 7 in the user-
defined table.

92 SmartPlant Materials How to Define Piping Material


Units

Select the ‘Outer diameter’ table type and the ‘U_OD_US’ table for
the outside diameters in Inches.

Select attributes and assign labels and order numbers


DN = Order 1 Displ. Has been checked off.
OD = Order 6

Go to [Next Blck].
In this last block we must specify the relations between the columns used in the
Formula. But we are only concerned with the nominal sizes.

^
The above definitions have the following meaning:
The nominal sizes from the U_B3610 table of the ‘Schedule’ type must be equal
to the nominal sizes from the U_OD_MM table (Outer diameter type) and also to
the nominal sizes from the U_OD_US table (Outer diameter type). This is why it
is helpful to enter the name of the table in the Label field. See below:

The name of the table


where the DN values
come from is
repeated here.

SmartPlant Materials How to Define Piping Material 93


Units

SmartPlant Materials now appends DN with the name of the table when you define
the column relations.

Notice that the column clause has a different value for each attribute. These values
can also be used when you establish the relations, but the above method is simpler.

So far we have been concerned with source tables, that is, tables we copy from. In the
next step, we must specify the destination table, that is, the table we are trying to fill
with the data.

94 SmartPlant Materials How to Define Piping Material


Units

Step 2
We have seen this screen (S.40.21 Geometric Rules) before when we created the
commodity-geometric relations for the purpose of creating idents. It has a dual
function:
1. It is used to create the commodity-geometric relation.
2. It includes the copy instruction (Formular) that is used to complete the
specified Geometric.

The ‘UPP’ geometric table is filled with data


with the copy instructions of the ‘UPIPE’
Formula.

Step 3
With LOV, select the name of the Formula and check the ‘Simulate’
check box to go to S.40.30 Geometric Simulation.

SmartPlant Materials How to Define Piping Material 95


Units

Click ‘Validate’. SmartPlant Materials will check your definitions.

Click ‘Simulate’. This will start the copying process.

96 SmartPlant Materials How to Define Piping Material


Units

SmartPlant Materials will now display the geometric. The geometric


values have been copied to a temporary table for you to review them.

If the values are correct, check the ‘Transfer’ check box.


Activate the ‘Add only new rows’ or ‘Replace old by new rows’ button
if you want to perform an update. The geometric values will now be
transferred to your table (UPP).
Step 4
Go to S.40.12 Commodity Geometrics Window 2 to verify the
transfer.

SmartPlant Materials How to Define Piping Material 97


Units

NOTE: THIS PROCEDURE CAN BE VERY DESTRUCTIVE TO EXISTING


DATA IN THE DATABASE AND GREAT CARE SHOULD BE EXERCISED
WHEN USING IT.

Generated Idents and their “Values”


After they are created, SmartPlant Materials idents can receive additional attributes
for different approaches. For example, the weight could be stored on the Ident level.

98 SmartPlant Materials How to Define Piping Material


Units

These so-called ‘ident values’ have their own revision and history of change
management. After the value was changed to 150, we check the ident history on
S.80.22.

Window 2 shows each modification with value, user, and date.

SmartPlant Materials How to Define Piping Material 99


SmartPlant Reference Data Explorer

SmartPlant Reference Data Explorer


General Features
The new S.80.41 SmartPlant Reference Data Explorer screen allows us to
comfortably browse, search, review, and edit SmartPlant Reference Data.

The screen shows the list of available commodity groups. The ‘+’ shows that under
this group additional data is available. In general, the functionality is comparable to
the Windows Explorer behavior.

The hierarchical tree displays commodity groups, parts, commodity codes, and idents
in their dependencies.

The base or first level displays all existing commodity group data of the login
environment (including all assigned A.20.06.03 Queryable Disciplines). When you
expanding the nodes of the first level, all existing commodity part data for that
specific expanded node are listed. The next level shows all existing commodity codes.
Level 4 shows all existing data for idents. Level 5 (attribute groups) and level 6
(attributes) present their data without special functions.

100 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Explorer

The functionalities of the hierarchical tree can be performed with the keyboard or
mouse; some can also be performed using the SmartPlant Reference Data Tree
buttons.

Possible activities:

Key up
Key down
Enter (double-click)
Button collapse (mouse click node state)
Button expand (mouse click node state)
Button refresh
Button refresh node
Select node and right mouse click
Double-clicking one of the first four levels will display a window that contains
detailed information like short and long descriptions, rules, objects, special tables, and
so forth.

Details for Commodity Group Level

SmartPlant Materials How to Define Piping Material 101


SmartPlant Reference Data Explorer

In all detail screens, several fields are available for double-click functions. The
double-click opens the relevant SmartPlant Materials base screen. These screens
always open in the correct data context, which simplifies work. Here you can then use
the same functions as described in chapter 4.

Fields that you can double-click:

FIELD CALLED SCREEN


Group S.10.02
Rule S.10.01
Tablename A.50.02
Object S.10.04
Unit Set A.10.07
No. S.10.05
Name S.10.05
Attr Name (Block: Parameter A.50.01
Detail)
Unit A.10.12
Physical Attribute A.50.03
Tablename (Block: Attributes) A.50.02
All of these fields are equipped with a mouse over ToolTip that provides a hint to the
called screen.

102 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Explorer

Details for Commodity Part Level

SmartPlant Materials How to Define Piping Material 103


SmartPlant Reference Data Explorer

Details for Commodity Code Level

Details for Ident Level

104 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Explorer

Search Features
SmartPlant Reference Data Explorer allows you to search for material in multiple
ways. As a general feature, a full text search is available, which allows you to find
materials based on any fragment of description on different levels of interest.

Important fields for


SmartPlant Reference
Data explorer search

The important fields for a search are:

Input search text: The search criteria to search for. Normal ORACLE query
wildcards like ‘%’ or ‘_’ can be used.

Display option: The selected level will be exploded in the tree based on the search
result.

Include Commodity Group, Part, Code, or Ident: The selected level descriptions
will be included in the search.

SmartPlant Materials How to Define Piping Material 105


SmartPlant Reference Data Explorer

The following pictures show some examples for the search of ‘EFW’, which in this
case is a value for Commodity Codes coming from a table detail. A search on the
group and part level does not show results.

106 SmartPlant Materials How to Define Piping Material


SmartPlant Reference Data Explorer

Now the same search on Commodity Code level:

The search opens a new window, which has a display function for the found hints.
From here, during the further manual search, the display of the explorer window can
be controlled. Selecting a row in window 3 will activate the same row on the explorer
screen.

SmartPlant Materials How to Define Piping Material 107


SmartPlant Reference Data Explorer

108 SmartPlant Materials How to Define Piping Material


Work Process Examples

Work Process Examples


Create a New Specification from a Paper
Specification and Export to Smart 3D
SmartPlant Reference Data allows you to enter data from a paper specification to
create a new specification. Once the new specification is created, it can be exported to
Smart 3D using the SmartPlant Standard Database.

The following example details procedures for creating a new specification from a
piping specification that is in paper format, then exporting it to Smart 3D.

SmartPlant Materials How to Define Piping Material 109


Work Process Examples

Enter a Specification Header


1. Click LOV to select the specification type in the S.50.06 Specification
Management screen.
2. Type the spec code from the paper specification in the Spec Code box. In this
example, we will use 1CS150.
3. Click Save.
4. Click the Spec Header Description tab.
5. Type a Short Description and a Description.
6. Click Save.
7. In the lower block, click the Specification Details tab.
8. Enter the service, rating class, temperature limit, and corrosion allowance
information from the paper specification. The following table is an example of
specification details from paper spec 1CS150.
Seq Tablename Group Detail Short Desc
1 P_Service All AA Process
2 P_Rating_Class All AA 150, ASME B16.5a - 1998
3 P_Temp_Limit All AA -20 to 800F
4 P_Corr_Allowance All AA 0.063 in (0.05 in MIN)

110 SmartPlant Materials How to Define Piping Material


Work Process Examples

9. Click the Specification Limits tab.


10. Enter the Pressure – Temperature Ratings based on the follow table.
Pressure Unit (Press) Temp Unit (Temps) Comments
80 psi 427 C
110 psi 371 C
140 psi 316 C
170 psi 260 C
200 psi 204 C
11. Click Save.

Enter Butt-Welded Fittings


In this example, enter data for a 90 degree elbow and a concentric reducer.

1. Double-click the Spec Code in the S.50.06 Specification Management screen.


S.50.06 Specification Management Window 2 appears.
2. Type E90 in the Short Code box to begin entering data for the 90 degree elbow.

3. In the Group box, click List of Values (LOV) , and select B from the S 10.02
Commodity Code list.

4. In the Part box, click LOV , and select E9L from the S 10.03 Commodity
Part list.

5. In the Commodity Code box, click LOV . Set your query criteria to limit the
number of Commodity Codes displayed.
For example, in the P_Material tablename, set the group as WRGT_US and the
table detail as CK, then click Find to filter the Commodity Codes displayed.
6. In the Commodity Codes block, select the BE9LABMBEACKZZZ commodity
code with the description 90 Degree Elbow Long Radius (R=1.5D), ASME
B16.9, Bevelled End, A 234 Grade WPB.

7. Click OK.

8. Click the Geometric tab to give the system a size range.

9. In the From 1 box, type 2.

SmartPlant Materials How to Define Piping Material 111


Work Process Examples

10. In the To 1 box, type 48.

11. In the Unit box, type in for inches.

12. Click Save.

13. Click the next row to begin entering data for the concentric reducer.

14. Type REDC in the Short Code box.

15. In the Group box, click LOV , and select B from the S 10.02 Commodity
Code list.

16. In the Part box, click LOV , and select REC from the S 10.03 Commodity
Part list.

17. In the Commodity Code box, click LOV . Set your query criteria to limit the
number of Commodity Codes displayed.
For example, to filter for the reducer, set the following values:

Tablename Group Table Detail


P_DIM_STD FIT_US BM
P_END_PREP WELD BE
P_MATERIAL WRGT_US CK
P_MAT_SYSTEM US A
P_SYSTEM US A
Click Find to filter the Commodity Codes displayed.
18. In the Commodity Codes block, select the BRECABMBEACKABA commodity
code with the description Concentric Reducer, ASME B16.9, Bevelled End, A
234 Grade WPB, Seamless.

19. Click OK.

20. Click the Geometric tab to give the system a size range.

21. In the From 1 box, type 3.

22. In the To 1 box, type 48.

23. In the Unit box, type in for inches.

24. Click Save.

112 SmartPlant Materials How to Define Piping Material


Work Process Examples

Enter a Gate Valve


1. On S.50.06 Specification Management Window 2, click the next row to begin
entering data for the gate valve.

2. In the Short Code box, click LOV .


3. Type vg% in the Find box on the S.10.08 Short Codes screen, then select VGAT
from the Short Code list.
The Group box is automatically set with the VG commodity code value.

4. In the Part box, click LOV , and select R from the S 10.03 Commodity Part
list.

5. In the Commodity Code box, click LOV . Set your query criteria to limit the
number of Commodity Codes displayed.
For example, to filter for the gate valves you want, set the following values

Tablename Group Table Detail


P_ALIAS_TRIM VG_US AAE
P_DIM_STD VG_US AA
P_END_PREP VALVE RF
P_MATERIAL CAST_US CD
P_MAT_SYSTEM US A
P_RATING RAT_US D
P_SYSTEM US A
Click Find to filter the Commodity Codes displayed.

6. In the Commodity Codes block, select the VGRAAADRFAFACDAAEA1A


commodity code with the description Gate Valve, ASME B16.10, Class 150,
Raised Face, Bolted Bonnet, Handwheel Operator, A 216 Grade WCB, 1
According to API 594

7. Click the Geometric tab to give the system a size range.

8. In the From 1 box, type .5.

9. In the To 1 box, type 2.

10. In the Unit box, type in for inches.

11. Click Save.

SmartPlant Materials How to Define Piping Material 113


Work Process Examples

SmartPlant Reference Data Plus


SmartPlant Reference Data Plus provides an easy-to-use user interface for creating
and viewing reference information, including commodity codes, idents, and parts, as
well as for writing and managing piping specifications.
The SmartPlant Reference Data Plus software is similar to the Reference Data
functionality in SmartPlant Materials (Forms application).

Create Commodity Codes in the Specification


SmartPlant Reference Data Plus allows you to browse existing specifications based
on the content.

114 SmartPlant Materials How to Define Piping Material


Work Process Examples

Opening a specification from the tree brings up the Spec Editor. The Spec Editor is
used to view and edit the materials specifications.

You can add information to use as default information within the specification, for
example, default piping material or thicknesses.

SmartPlant Materials How to Define Piping Material 115


Work Process Examples

The Open for Edit mode allows you to add information to these default areas.
List of Value (LOV) options let you select the information to add such as a
specific wall thickness.

Generate Commodity Codes


The Component Area page allows you to specify detailed information for the groups
and parts in the specification. You can also generate commodity codes and idents.
Within the Component Area page, the spec is now organized by component groups,
similar to the organization of the paper spec.

You can modify a component group simply by expanding the component group and
using the LOV to select the values to change. The Material Code and other
properties are predefined on the specification header.
Generate automatically creates commodity codes. The component groups already
contain information about the short code, groups, parts, and material codes, making it
easier for SmartPlant Reference Data to automatically find the corresponding
commodity codes. If the software does not find commodity codes or finds more than
one commodity code, it highlights that information. The possibilities for each short

116 SmartPlant Materials How to Define Piping Material


Work Process Examples

code/group/part are: a) The software found one commodity code, b) The software
found multiple codes, or c) The software did not find any commodity codes.
For one commodity code found, the Commodity Code field displays a
code. No user action is required.
For multiple codes found, the Commodity Code field displays text such
as "Find 2 Codes," and the background of the cell is blue. Click Browse
to choose one or more codes. These codes are from the S.30.01
Commodity Codes screen in the Forms application.
For no codes found, the Commodity Code field is empty and in a magenta
color:

SmartPlant Materials How to Define Piping Material 117


Work Process Examples

Create Missing Commodity Codes in Component Manager


You can open a Component Manager window and override information, such as the
material, save the data, and come back to the Spec Editor to generate commodity
codes again.
The Component Manager provides a tabular view of the data, much like Microsoft®
Excel®. You can add, modify, and delete data in the grid.

You can view different types of hierarchies in the Data view of the Component
Manager. The default view is Commodity Group/Part/Commodity Code/Ident.

118 SmartPlant Materials How to Define Piping Material


Work Process Examples

SmartPlant Reference Data and SmartPlant Materials use the same database. If you
query for the specification in SmartPlant Materials, the same data created in
SmartPlant Reference Data appears in SmartPlant Materials.

SmartPlant Materials How to Define Piping Material 119


Work Process Examples

Branch Table
Using the Branch Editor, you can add, modify, or delete branches.

You can access the Branch Editor in the following ways:


Through the Component Manager. Select Branches in the Data Explorer
dropdown list, and all branch tables appear.
Through the Spec Editor. Select a specification, and go to the Component Area
page. If there is a branch assigned to the spec, the branch content appears
automatically. If there is more than one branch, you can choose a distinct branch
from the combo box at the top of the Branch Editor.

At the top of the Branch Editor, the toolbar contains icons for creating a new branch,
editing a branch, and deleting a branch.

Below the toolbar is data about the branch, such as its name, short description,
description, header units, branch units, standard, and control code.

120 SmartPlant Materials How to Define Piping Material


Work Process Examples

Next, you can see controls to add axis values to the branch table and a way to save
preferences for the branch table.

The grid shows the details of the branch table. Each cell shows the group/part for that
branch and header size. If a cell has more than one preference, all group/part
combinations appear in the cell.

SmartPlant Materials How to Define Piping Material 121


Work Process Examples

On the right side of the grid, you can see the legend.

The bottom of the Branch Editor displays other information for the branch, such as
the short description, break type, and control code.

For more information about SmartPlant Reference Data Plus, see the SmartPlant
Reference Data Plus User’s Guide.

122 SmartPlant Materials How to Define Piping Material


Work Process Examples

Review the Specification Before Export


When the specification is generated, use S.50.02 Specification Management to review
the complete specification, including your spec header information, filtering tables,
specification details, and more.

Reports generated on S.50.R Reports screens allow you to review the details of the
specification. For example, a piping class report provides component details,
commodity codes and corresponding information.

SmartPlant Materials How to Define Piping Material 123


Work Process Examples

If you compare the report generated from SmartPlant Reference Data with the original
paper specification, the same information is displayed.

124 SmartPlant Materials How to Define Piping Material


Work Process Examples

Export Specification and Catalogs to Smart 3D


The new specification from SmartPlant Reference Data needs to be exported into a
format that can be imported by Smart 3D.
1. Type a job name in the Job box in the SP3D 20.02 Export Jobs screen.
2. Click the Destination box

3. Click LOV .
4. On the dialog box, select a destination.
The destination allows you to compare changes to the specification without
exporting the entire specification.
5. Click the Transfer Type box.

6. Click LOV .
7. Select a Transfer Type that exports all of the specification sheets, for example,
PIPING_SPEC_WBK.
Transfer Type allows you to control the number of sheets exported.
8. Select ADD_MODIFY_DELETE from the Bulkload Mode list.
Bulkload Mode allows you to control what kind of changes to export.
9. Click the Item Mapping box.

10. Click LOV .


11. Select SDB_ITEM_MAPPING from the list.
This option is preconfigured and automatically fills in the Template and Sheet
Config options.
12. Select COMPLETE_JOB from the Job Goal list.
13. Click the Config box.

14. Click LOV .


15. Select SDB_CONFIG from the list.
16. Click Save.
17. Click Yes in the Replace Sheets message box.
The sheets that are part of the transfer type and that are about to be created appear
under the Selected Sheets tab. The list of sheets does not include the part class
sheets. These will be automatically added based on the Spec Code you specify.
18. Click the Selected Spec Items tab.
19. Click the Spec Code Box

SmartPlant Materials How to Define Piping Material 125


Work Process Examples

20. Click LOV .


21. Select the SDB_1CS150 spec code that was created earlier in this example.
22. Click Start Online to start the export job in online mode.
23. Click OK.
24. A Job terminated with status Job_Finished message appears when the export is
complete. Click OK.
25. Click the Select Sheets tab. The parts class sheets now appear in the list.

Review the Export Results


Open the Excel sheets that were exported and review sheets exported by selecting the
tabs. For example, all components that are part of the specification are displayed in
the PipingCommodityFilter tab.

You can also review the data in SP3D 20.02 Destination Data screen. The same
information in the Excel spreadsheets is represented on this screen.
1. Expand the Piping Specification > Piping Materials Class > Piping
Commodity Filter.
2. Double-click Piping Commodity Filter. A tabular view of the same data that was
exported to the Excel spreadsheets appears.
The information stored in the database provides a delta of the piping specification
data. If changes are made to the specification, this view of the data allows you to
understand the changes and generate deltas of the piping specification for Smart
3D.

Review SmartPlant Reference Data Configurations


The SP3D 10.02 Sheets screen displays the sheets that are predefined in SmartPlant
Reference Data. The software has 776 predefined sheets and these sheets are the same
as the Excel sheets used by Smart 3D. These sheets are required when exporting to
Smart 3D.

In SP3D 10.03 Attributes screen shows all of the delivered attributes that can be used
for creating the sheets. The software had 1845 predefined attributes.

126 SmartPlant Materials How to Define Piping Material


Work Process Examples

The sheets and attributes delivered are used to help you create sheet configurations in
SP3D 10.07 Sheet Configs. These configurations help you determine how the sheets
appear in Smart 3D. In the example below, you can see the attributes for the
PipingCommodityFilter sheet. These attributes represent the column headings in the
Excel sheet used by Smart 3D.

Review of Item Mappings


SP3D 10.04 Item Mappings allows you to assign values to the attributes. Item
mappings can be sheet dependent or sheet independent.

Query for the PipingCommodityFilter sheet on the Sheet Dependent tab

SmartPlant Materials How to Define Piping Material 127


Work Process Examples

The highlighted section means that for the FirstSizeSchedule, B, CAP, the Value /
Source must MATCH.

The following example shows that for the SelectionBasis, B, E45, the Value /
Source is Elbow, fixed angle.

The standard database allows you to map attributes at the Group Part level, which is
the highest level. For more specific mapping, use the Commodity Code or Idents
levels.

If you click the Independent tab, only attributes appear in the table. There are no
sheets. In addition allowing you to map at the Group Part, Commodity Code, and
Idents levels, you can map attributes at the Table Details level. Any commodity
codes that use a table detail automatically maps the attributes, for example,
EndPreparation(1) with a Cdlst Number 301, in the Table Details. You do not
have to map these attributes repeatedly to the corresponding Group or Part.

128 SmartPlant Materials How to Define Piping Material


Work Process Examples

Review Templates
Sheets that are predefined appear in SP3D 10.08 Templates screen. You can query by
Category to review specific sheets, for example, the BoltExtensionOption sheet
shown below.

SmartPlant Materials How to Define Piping Material 129


Work Process Examples

Bulk Load Code Lists into Smart 3D


The following procedures explain how to bulk load the code lists into Smart 3D.
1. In Smart 3D, run the Bulkload Reference Data application. You must first load
the code list.
2. Click Add next to the Excel codelist files group, and select the code list
spreadsheet to load into the Smart 3D Catalog Schema database.

3. Click Browse next to the Log file box to define the log file location.
4. Click Load.

A message appears in the status bar when the bulkload is successful.


5. Click Add next Excel files, and select the reference data spreadsheet that you
want to load into the Smart 3D catalog database.
6. Click Load.

A message appears in the status bar when the bulkload is successful.

130 SmartPlant Materials How to Define Piping Material


Work Process Examples

Placing Components in Smart 3D


The following example shows you how to place components in Smart 3D using the
imported specification.
1. Click Route Pipe in Smart 3D.
In the New Pipe Run dialog box, the specification 1CS150 created earlier in
SmartPlant Materials appears.

2. Type a Name for the pipe.

SmartPlant Materials How to Define Piping Material 131


Work Process Examples

3. Select Temperature and Pressure from the Category list, and type your
temperature and pressure values

4. Select points to define the route of your pipe run.


5. Select the ending point of the pipe run. Right-click to end a pipe run that does not
terminate in a nozzle or branch.
6. Click Insert Component on the vertical toolbar.
7. Select the header run in which to insert the tee or other branch component.
8. Select the component type and the option in the Type and Option boxes.
9. Position the component on the header pipe run.
10. Click Finish.
11. Using the Route Pipe command, route the branch pipe run into the branch
component that you just placed on the header pipe run.

132 SmartPlant Materials How to Define Piping Material


Work Process Examples

12. Repeat Steps 6-11 to insert a check valve.

13. Right-click a pipe segment and select Properties on the shortcut menu. The new
pipe run is based on the imported specification.

SmartPlant Materials How to Define Piping Material 133


Work Process Examples

Changing Specifications
1. Create a revision of spec SDB_1CS150 in screen S.50.06 Specification
Management screen in SmartPlant Materials.
2. Double-click SDB_1CS150 in the spec code box.
3. In this example, select a pipe component with Commodity Code
PPABQBEAEEAAH, and click LOV .
4. Click Find.
5. In the Commodity Code box, paste PPABQBEAEEAAH.
6. Select the EE Table Detail next to P_MATERIAL.

7. Click LOV and select DL from the S.20.02 Tablenames with Details list.
8. Click Find, then click OK.

The new commodity code is inserted into the Specification Items list.
9. Click the Geometric tab.
10. Delete the existing Geometric 1 value.
11. Change the From 1 and To 1 values.
12. Click Save.
13. Check the Enable Spec Compare check box.
14. Click the Modifications tab.

You can compare all items in the specification or compare individual items.
15. Select the pipe component that was modified, and click Compare.

The modifications to the item are described in the Changes box.


16. Query for the previous export job in SP3D 20.02 Export Jobs. See Export
Specification and Catalogs to Smart 3D on page 123.
17. Click New Run to generate the revised specification.
18. In the Selected Spec Item tab, click Delete Record to remove the existing Spec
Code and Rev number.

19. Click LOV , and select SDB_1CS150 Rev 1 from the S.50.03 Spec Headers
list.
20. Click OK, and then click Save.
21. Click Start Online to export the revised specification.

134 SmartPlant Materials How to Define Piping Material


Work Process Examples

22. Click the Workbook tab, and then double-click the exported Excel spreadsheet to
open it.
23. Click the PipingCommodityFilter tab in the Excel spreadsheet. The item deleted
and the item added are displayed.

SmartPlant Materials How to Define Piping Material 135


Work Process Examples

Generation of Piping Material Catalog / Piping


Commodity Data for Plant Design System (PDS®)
1. Check the Sel box next to the SDB_1CS150 Spec Code in the PDS 10.12
Generate and View PMC/PCD screen.
2. Click Create PMC/PCD, and then click Yes in the message box.

When the specification is complete, the software returns to the PDS 10.12
Generate and View PMC/PCD screen.

3. Click to view to the PDS 10.12 Generate and View PMC/PCD Window 2
screen and review the data to be exported to PDS.

4. Click to return to the PDS 10.12 Generate and View PMC/PCD screen.
5. Click ASCII to generate the ASCII file of the specification.
6. Click Yes to confirm the generation, and then click Yes to download the files.

A WinZip archive is created. You can open the archive to see the .pcd file
generated.

136 SmartPlant Materials How to Define Piping Material

You might also like