You are on page 1of 103

SmartPlant Materials

E&PI(BOM) User's Guide

Version 2011 R1 (7.1.0)

November 2013

DMAR1-PE-200145B
Copyright
Copyright © 2010-2013 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
300 Intergraph Way
Huntsville, AL 35813

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

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

Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

2 SmartPlant Materials E&PI(BOM) User's Guide


Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
e. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of
Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are
trademarks of their respective owners.

SmartPlant Materials E&PI(BOM) User's Guide 3


4 SmartPlant Materials E&PI(BOM) User's Guide
Contents
Preface .......................................................................................................................................................... 7
Documentation Comments ..................................................................................................................... 7

Setup ............................................................................................................................................................. 9
Project Defaults ....................................................................................................................................... 9
Copy BOM Setup .................................................................................................................................... 9
Verifications ........................................................................................................................................... 12
Fix Verification Routines ................................................................................................................. 13
List Status ............................................................................................................................................. 15
Issue Status .......................................................................................................................................... 16
Node Types and Settings ...................................................................................................................... 18
Node Type Hierarchy ............................................................................................................................ 23
Position Attributes ................................................................................................................................. 24
BOM Views ........................................................................................................................................... 25
Single Position View ....................................................................................................................... 26
Multi Position View ......................................................................................................................... 26
Discipline BOM Views .................................................................................................................... 27
BOM User Views ............................................................................................................................ 28
BOM Rules ............................................................................................................................................ 29
BOM Procedures/Macros/Buttons ........................................................................................................ 30
Flat Configurations ................................................................................................................................ 38

BOM Handling ............................................................................................................................................ 39


Edit BOM ............................................................................................................................................... 39
Edit BOM (Easy Entry) .......................................................................................................................... 40
Advanced BOM Maintenance ............................................................................................................... 40
WBS Tree View .............................................................................................................................. 41
WBS Flat View................................................................................................................................ 52
Node Properties and Attributes ...................................................................................................... 56
Search ............................................................................................................................................ 58
Buttons ........................................................................................................................................... 60
BOM Position Views ....................................................................................................................... 60

BOM Utilities .............................................................................................................................................. 89


BOM Import ........................................................................................................................................... 89
BOM Datasets ....................................................................................................................................... 90
BOM Work Packages ............................................................................................................................ 91
BOM Compare ...................................................................................................................................... 93
Manually Lock BOM .............................................................................................................................. 97

Reports ..................................................................................................................................................... 101

Index ......................................................................................................................................................... 103

SmartPlant Materials E&PI(BOM) User's Guide 5


Contents

6 SmartPlant Materials E&PI(BOM) User's Guide


Preface
This document is a user’s guide for the SmartPlant Materials E&PI(BOM) module.

Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
(mailto:ppmdoc@intergraph.com?subject=documentation comments).

SmartPlant Materials E&PI(BOM) User's Guide 7


Preface

8 SmartPlant Materials E&PI(BOM) User's Guide


SECTION 1

Setup
When starting a new project in SmartPlant Materials, you must define the E&PI(BOM)-related
project defaults and perform the setup of the BOM module as described in this section. The
setup of the work breakdown structure (WBS) should be done with consideration of how your
P&IDs and plant layout drawings are organized.

Project Defaults
You can find a detailed description of how to set project defaults and the purpose and usage of
each project default in the E&PI (BOM) Project Defaults (ZB) section of the SmartPlant Materials
Project Defaults document, available from the Printable Guides page in the software.

Copy BOM Setup


To copy the BOM setup data from an existing project (source/template) to the new project
(target), you can use the B.10.11 Copy BOM Setup screen when logged in to the target project.

Furthermore, you can use the A.60.02.07 Project Setup Copy screen, which allows copying
setup data from different SmartPlant Materials modules in one step. For more information about

SmartPlant Materials E&PI(BOM) User's Guide 9


Setup

copying project setup data, see Copy Project Setup Data in the SmartPlant Materials
Administrator’s Guide, available from the Printable Guides page in the software.
This copy BOM setup function should be used at the beginning of a project, before any data is
entered, because this function can only be used for tables that have not been filled with data
already. If any setup data has been entered before using this function, the copy BOM setup
function will not overwrite this data.
You must be logged in with the target project to which you would like to copy the BOM setup.
Only those projects with the same product group as the target project can be chosen as the
copy base (source).
Select the source project from the LOV in the Copy from Project field, and click the Run query
button. Then, select all setup data you want to copy by selecting the corresponding check
boxes. Finally, click the Start button to start the copy job.
After the copy process has terminated, the message below will appear.

Acknowledge this message with OK to open the A.60.72 Show Log File screen, which displays
the log file of this BOM setup copy job. Here you can see the name and the content of the BOM
setup copy process log file. This allows you to check the results of the copy process. For
example, it’s possible that no data was copied because data is already present in some of the
tables involved.

10 SmartPlant Materials E&PI(BOM) User's Guide


Setup

If you want to check this log file again after you have closed the A.60.72 screen, you can find
this file in the utl_file_dir of your database. The name of the log file starts with CBS_ followed by
a sequential number, with the extension .log.

This BOM setup data can be copied from project to project:


 Verifications defined on B.10.01
 List Status defined on B.10.02
 Node Types defined on B.10.03
 Position Attributes defined on B.10.04
 BOM rules defined on B.10.05
 BOM views defined on B.10.06
 Node-type hierarchies defined on B.10.07
 Issue status defined on B.10.08
 Discipline BOM views defined on B.10.09
All setup data for which the check box is checked will be copied from the selected source project
to the project you are currently logged in, the target project. In some cases, there are
dependencies among the data. This means for these cases a check box must be selected if
another one is checked. Read the check box descriptions in the B.10.11 online help to find the
dependencies.
The following points must be considered when starting the copy BOM setup job:
 Only setup data for which the check box has been checked will be taken into account during
the copy process.

SmartPlant Materials E&PI(BOM) User's Guide 11


Setup

 Depending on the setting of the radio group at the bottom, data of different disciplines will be
copied. If you select the Login Discipline option, only data of the discipline you are
currently logged in will be copied from the source project to the target project. If you select
the Discipline option, you must select disciplines from the LOVs in the From Discipline
and To Discipline fields. Data will be copied from the source discipline entered in From
Discipline to the target discipline entered in To Discipline. If you select the All Disciplines
option, data of all disciplines assigned to both, the source and the target project, will be
copied.
 Data will only be created if no records can be found for the target project in the
corresponding table. This will be checked table by table, which means: If verifications, for
example, have already been defined in the target project but no node types, and you
checked both check boxes, no verifications will be copied from the source project. But the
node types will be taken over.
For all data for which language dependent descriptions exist, these descriptions will be copied
as well.
Project defaults are not copied by the procedure. You should check whether the values are set
correctly. You can do this by calling the modules A.20.11, A.20.12, or A.20.13.
The Start button can be used multiple times. For example, you want to copy the verifications
from project A but the node types from project B. Then you use the Start button twice, once with
project A and the verifications indicator checked, and once with project B and the node types
selected.
If some setup data is not copied because the tables already contained data, you can delete this
existing data if it is no longer relevant and then start the copy procedure again.

Verifications
Verification routines are processing procedures to verify and maintain data in BOMs. There are
two types of verifications: fixed and variable.
Verifications of the fixed type are part of SmartPlant Materials and cannot be changed (except
for the description).
Verifications created by the user are of the ‘Variable’ type. These verifications can either be a
customer-installed procedure (CIP), or a variable list check that associates a Where Condition
(from A.60.06) with a check name.

12 SmartPlant Materials E&PI(BOM) User's Guide


Setup

Customer-installed procedures (CIPs) are PL/SQL procedures that must be incorporated into
the SmartPlant Materials custom package called M_PCK_VERIFY_CUSTOM. They allow you to
embed any kind of complex processing logic that may be developed and implemented by
customers, and seamlessly integrate this logic into SmartPlant Materials verification processing.
A Where condition must be allocated to each ‘Variable’ type verification routine. Without a
Where condition, the verification routine cannot be allocated to a verification job (on B.20.01.41
Start Verification Job, called from B.20.01 Edit BOM), or to a List Status (on B.10.02 List
Status). The attributes to be edited during verification processing are defined in this Where
condition. Attribute values and logic rules (AND, OR) can also be given in the Where condition.
For more information about Where conditions, see the Administrator’s Guide available from the
Printable Guides page in the software.

The verifications can be maintained on the B.10.01 Verifications screen.

Fix Verification Routines


The Verification routines of type ‘FIX’ are part of SmartPlant Materials delivery, and they cannot
be changed. The fix verifications are listed below.
BLD_IDENT (Build Idents): This program calls the procedure that builds idents.
BOM_COPY (Copy Assemblies to BOM): This program copies assemblies as defined on
S.70.03/S.70.04 to the Bill of Materials. It is driven by the BOM_COPY rule setup in the Project
Defaults.
BOM_POS (Find BOM terminal nodes without BOM positions): This program finds BOM
terminal nodes beneath the starting node specified for the verification job that do not have any
BOM positions. This data quality check detects potential incomplete BOM structures.
EST_SHORT (Calculate Estimation Shortage): This program can be used on the B.20.01 Edit
BOM screen. The purpose of this check routine is to automatically generate an isometric with
the missing material. This material will be the difference between the first estimation and the
material included in the isometrics loaded into SmartPlant Materials when a line is incomplete.
FND_IDENT (Find Idents): This program attempts to find idents for BOM positions, using this set
of rules:
 If a BOM position has a specification code assigned, the program tries to find an ident using
the specification, short code, option code, and sizes.
 If no specification is assigned, but the BOM position has a commodity code, the program
tries to find an ident for a special item, using the commodity code and sizes.
IDENT_INFO (Update Ident Information): This program updates BOM positions that already
have an ident with the information from the SmartPlant Reference Data module that is
associated with this ident; that is, it sets the commodity group, part, commodity code, and sizes
accordingly. So, this is a means of synchronization for the BOM positions data.
ISSUE_DEL (ISSUE_DEL): This procedure deletes positions of a specified issue status.
However, ISSUE_DEL does not process or delete positions with site quantities, which
ISSUE_REV does.

SmartPlant Materials E&PI(BOM) User's Guide 13


Setup

ISSUE_REV (ISSUE_REV): This program can be used on the B.20.01.41 Start Job screen.
The purpose of this check routine is to reverse an issue to site and thus to enable reloading of
an existing highest issue status of the BOM, although reservations and/or issues have already
been done. The check determines the highest issue status on a node, and it determines the next
lower issue status on a node. It transfers site quantities recorded against positions in the highest
issue status to matching positions in the next lower issue status. If for such a position no
matching position exists in the next lower issue status, a "dummy" position with quantity 0 is
created. So this is the same as the Transfer Site Quantities logic (ZI_OMI_TSQ) in the OMI
interface, with the difference that it works in the opposite direction here. References in the Site
module to these positions (issues, reservations, and so forth) are remapped to those matching
positions in the next lower issue status. Furthermore, after this transfer has been done, the BOM
positions in the highest issue status are deleted and already executed Design Change Issue
transfer logs are deleted also.
This check is therefore an extension of the logic of the already existing check ISSUE_DEL,
which also deletes positions of a specified issue status. However, ISSUE_DEL does not
process/delete positions with site quantities, which this ISSUE_REV check does.
Parameters to the ISSUE_REV check: Parameters specified on B.20.01.41 are ignored.
Regardless of what is specified as an Issue Status option, or as a List Status option, or
additional query conditions, this check always works the same way: it finds the highest and the
second highest issue status at a node, and transfers site quantities from the first to the latter,
and then deletes the highest issue status.
Error conditions: This transfer (and the subsequent deletion) cannot take place if:
 There are no positions at this node at all (an obvious case).
 The node is locked (released_ind = 'Y' on the BOM node).
 Positions at this node have a locked list status.
 There is only one issue status at this node (that is, there is no lower one to transfer to).
 Unprocessed Design Change Log entries for this node and the highest issue status exist in
the C.50.01 BOM Design Change Log; that is, entries exist where the destination
warehouse for a DCI has not been specified yet, and thus the DCI quantity could not be
transferred.
If any of these error conditions are met, processing is halted for this node, an error log entry is
made, and the processing continues with the next node.
PJSPEC (Check Specification): This program iteratively checks the BOM positions data against
the assigned specification.
SPEC_UPDT (Spec update): This program updates spec references on the BOM position to the
latest issued revision of the spec.
TSQ (Transfer Site Qty for IFC to highest Issue Status at Node): This program can be used on
the B.20.01.41 Start Job screen. The purpose of this check routine is to transfer Site Quantities
(Issued and/or Reserved Quantities) on BOM positions in an "IFC" issue status of a BOM node
to the highest existing "Engineering" issue status of that node. Optionally, when ZI_OMI_DCC is
set to Y, the OMI Design Change Control processing logic is also applied.
TSQ_CHK (Find Nodes higher IS but not with Issued/Reserved QTYs): This program can be
used on the B2001 Edit BOM screen. The purpose of this check routine is to find out all the
BOM nodes with the positions in an Issue Status differing from the highest Issue Status and
having the site records assigned (issued and/or reserved qty).

14 SmartPlant Materials E&PI(BOM) User's Guide


Setup

VER_IDENT (Verify Ident Prerequisites): This program checks the prerequisites for building
idents; that is, it determines whether all commodity rule details that are defined as mandatory
are present.

List Status
Use the B.10.02 List Status screen to define the needed BOM list statuses.

The list status (or release status) is an indicator of the status (condition) of the BOM positions.
These indicators are defined and assigned by the user depending on what or how much he
wants to control. In a sense, this function can also be considered a quality control function
(Highest List status = Highest quality). List status has an ascending order of priority and can only
be assigned in ascending order during updates of the bill of material unless the issue status is
increased.
To understand the meaning of this function, the user must know that each BOM position can be
further identified with attributes, for example, design temperature, design pressure, SFI (Shop,
Field, or Installed), Checked, and so forth, and the list status can indicate which of these
attributes have values. List status functions are completely user-definable; that is, they are not
hard-coded in the software.
A few examples are described below.
List status 00-DEF = Default
This list status is the default that is automatically assigned to a new position. The default list
status is defined by the project default ZB_LST_ID.
List status 05-SFI = SFI
This list status is assigned to positions when the associated BOM position attribute SFI has a
value assigned; for example: S, F, or I.
List status 10-MTO = Issued for MTO
If this list status is assigned, it means that the BOM position entry is based on a spec that is OK;
that is, the spec is suitable for MTO.

SmartPlant Materials E&PI(BOM) User's Guide 15


Setup

List status 20-IFC = Issued for Construction


If the BOM position attribute named ‘CHECKED’ has a value, list status 20 is assigned to that
position, meaning the ident and quantity have been checked, and it’s issued for construction
(Site).
List status 50-LOCK
This list status has the Lock indicator marked. If this list status is assigned to a BOM position, it
means that the node (isometry) is locked; that is, the iso has been released (or issued) and
cannot be updated.

Defining a list status


To define a list status, enter a name in the List Status field and the descriptions in the Short
Desc and Description fields. A number of flags can be allocated to each list status.
 DELETE - If this indicator is selected (DEL=Y), BOM positions with this list status assigned
can be deleted.
 LOCK - If this check box is selected (LOCKED=Y), it means that positions with this list
status assigned are locked for update. Locking relates to the entire node; that is, either all
the positions of a node are locked, or none are. A locked node and its positions cannot be
changed, with the exception of attributes with the Allow Update indicator selected on
A.50.01. The values of these attributes can be updated even if the node is locked. If any of
the other fields or attributes must be updated, the lock of the node must be canceled. To do
this, select the node in the BOM tree of B.20.01, and click the B.20.01.06 Edit Node icon to
open the B.20.01.06 Edit Node screen. Here you can click the Unrelease button to cancel
the lock of the node and all its positions.
 OVERWRITE - This flag controls whether the list status is overwritten during batch
processing by the verification function.
In the second (List Status Checks) block on the B.10.04 screen, you can allocate list checks
defined on the B.10.01 Verifications screen to the selected list status. With the Mandatory
indicator, you define whether the list check must generally be implemented during a verification
run.

Issue Status
The issue status is used on the B.20.01 Edit BOM and B.20.03 Adv. Maintain BOM screens to
indicate the progress of material input in BOMs. The issue status can also be considered a
material history value. Here is an example of an issue status definition:

Issue Status Description

00 Estimation

10 Design 10% (state of


engineering)

15 Design 50%

20 Issued for construction

16 SmartPlant Materials E&PI(BOM) User's Guide


Setup

50 As built

The issue status can be defined on the B.10.08 Issue Status screen.

To create an issue status, enter a unique sequence number in the Seq field, the issue status
name in the Issue Status field, and descriptions in the Short Desc and Description fields. The
sequence number will be used for the "Best Quantity" functionality to indicate the highest
available issue status.
If the Use on Site indicator is checked, this issue status will be available for Fixed Issue Status
selection on the forecast/reservation run definition in the Site module. This means that BOM
positions with this issue status assigned can be selected during forecast or reservation runs.
With the Usage option, you define if the issue status will be considered for Best Quantity. The
available options are listed below.
 NULL (empty) - The issue status can be selected for BOM positions, and then it will be
included for Best Quantity calculation.
 Exclude Best QTY - The issue status can be selected for BOM positions, and it will be
excluded for Best Quantity calculation. This issue status is listed on Window 2 with the No
Display indicator not selected.
 Not Selectable & Exclude Best QTY - The issue status cannot be selected for BOM
positions, and it will be excluded for Best Quantity calculation. This issue status is listed on
Window 2 with the No Display indicator selected.
Click the Next Block button to open Window 2.

All statuses excluded from the Best Quantity are listed here. The No Display indicator is
checked when this issue status should not be selectable on BOM positions.

SmartPlant Materials E&PI(BOM) User's Guide 17


Setup

Node Types and Settings


The purpose of the B.10.03 Node Types and Settings screen is to define node types that are
used later in the Work Breakdown Structure (WBS) on the B.20.01 Edit BOM and the B.20.03
Adv. Maintain BOM screens. In addition, you can assign node attributes to the node types.
With node types and their attributes, you can establish the hierarchy of a project structure with
units, areas, line numbers, and isometrics, for example.

To define new node types in the first (Node Types) block, enter the node type name in the
Name field and the descriptions in the Short Desc and Description fields on the BOM Node
Settings tab. The description of a node in the WBS with a certain node type assigned can be
derived from a rule. Use the LOV in the Description Rule field to define the description rule for
the selected node type. The procedure creates the node description based on this description
rule if you create a new BOM node.
The description rule can be set up with these objects:
 individual node name ($CODE) and path ($NAME)
 node type ($TYPE)
 unit for the attribute ($ATTR_UNIT)
 any attribute defined in A.50.01
 fixed text
The attributes are enclosed by the special character #. Fixed text values should be entered
without using the # character. The user must be sure to use only attributes that are assigned to
the node type, or are available at the structural level in the BOM.

18 SmartPlant Materials E&PI(BOM) User's Guide


Setup

The picture below shows an example of how to use attributes with the description rule. The
attributes ‘DES_AREA’ and ‘P_ID’ have been assigned to a node type and added to the
description rule of that node type.

When you create a line number and enter values for the assigned node attributes, the generated
name of the node includes these values. See the picture below for an example.

Node types or attributes of a node type can only be deleted if the node type has not yet
been allocated to any node within the WBS.
In the lower section of the screen on the Assigned Attributes tab, you assign the needed node
attributes to the selected node type. Enter a unique sequence number in the Order Seq field
and select the attribute from the LOV in the Attribute field. All attributes defined on A.50.01 are
available for selection. Select the Mandatory indicator to make this node attribute mandatory.
This means the node attribute value is not optional and must be entered before saving the node.
With the Propagation Behavior option, you define whether and how the attribute is to be
propagated when creating nodes and positions in the BOM. The available options are listed
below.
 Propagate to Nodes and Pos (default) - This attribute will be propagated to all sub nodes
and positions.
 Propagate to Nodes only - This attribute will be propagated to the sub nodes, not to any
positions.
 Do not Propagate - This attribute will not be propagated, neither to sub nodes nor to any
position.

SmartPlant Materials E&PI(BOM) User's Guide 19


Setup

On the Assigned Valid Node Names tab, you can define a list of node names that are valid
and allowed for the selected node type.

Enter the allowed node names for the selected node type in the Name field and descriptions in
the Short Desc and Description fields.
When the project default ZB_VALNODE is set to Y, only the node names pre-defined on this tab
are allowed to be created on the B.20.03 Adv. Maintain BOM and the B.20.01 Edit BOM
screens. During creation of new nodes on B.20.03 or B.20.01, the node names will be validated
against the list defined here on B.10.03. If you try to create a node name that is not specified on
B.10.03, the message ‘MAR-20360: The node name is not valid.’ will appear and you cannot
save. If no node names are assigned to the node type on B.10.03, the message ‘MAR-20369:
Valid node names are not available for this node type.’ will appear and you cannot save. To
proceed, you must define the node name on B.10.03 before creating the new node.

To copy node types from another project, click the Copy Node Types button on the main
toolbar. A box opens, displayed below.

Select the Project or Product Group option from the Source radio group, and select the source
project/product group from the LOV in the Project/PG field. If you want to copy all node types,
select the All option from the Node Types radio group. To copy only one node type, select One
and select the node type from the LOV in the Old Name field. If you want to rename this node
type during the copy, enter the new node type name in the New Name field. Click OK to close
the box and to copy the node type(s). Click the Cancel button to close the box without copying
anything.

20 SmartPlant Materials E&PI(BOM) User's Guide


Setup

If you double-click the node type name in the Name field of B.10.03, the B.10.03.03 Node
Master Attributes screen will be opened.

This screen is used to store node master values for the assigned attributes of the selected node
types. Up to 20 attributes assigned to the node type on B.10.03 can be displayed here on
B.10.03.03. Select the node name from the LOV in the Node Name field and enter the so-called
master values for all displayed attributes. Leave the field empty or enter the # character if the
node attribute shall not be populated, because this attribute value is entered on node level on
B.20.03. After saving the records, you can click the Populate Node Values buttons to copy the
master value to the selected node, the sub-nodes of the selected node, and the positions of the
node and/or sub-nodes. The behavior of the attribute value population is determined by the
setting of the Propagation Behavior option on B.10.03.
The Project Settings tab allows you to define the project calendar and the project defaults that
are relevant to the BOM module. Furthermore, you can specify project discipline defaults on that
tab.

To specify the calendar for a new project, select the project start date from the LOV in the Start
Date field and the project end date from the LOV in the End Date field. Now click the Calculate
Calendar button to calculate and activate the project calendar. The project calendar can also be
maintained on the A.20.15 Project Calendar screen. For more information, see the Project
Calendar chapter of the SmartPlant Materials Administrator’s Guide, available from the
Printable Guides page in the software.

SmartPlant Materials E&PI(BOM) User's Guide 21


Setup

In the Project Defaults block, you can specify a user-definable selection of project defaults.
Right-click in the Parameter field, and click the Select Parameters command to open the
selection window.

This window shows all selectable project defaults of type General (ZX), BOM (ZB),
Standardization (ZS), or Integrator (ZI). Select the Display indicator of all project defaults to be
displayed on B.10.03. Clear the Display indicator of project defaults to be removed from the list.
Click OK to apply the changes and to close the window. Click Cancel to close the window
without applying any changes.
If any project default value has been specified on the discipline level, this project discipline
default value is displayed in the Value field of the Disciplines block. If child disciplines have
been defined for the selected discipline, these are shown in the Child Discipline fields
underneath.
A value assigned to a project default can be copied to the project discipline default. Select the
Select check box of the discipline or the child discipline(s), and click the Propagate button to
copy the value defined for the project default to all selected disciplines.
For more information, see the SmartPlant Materials Project Defaults document, available from
the Printable Guides page in the software.

22 SmartPlant Materials E&PI(BOM) User's Guide


Setup

Node Type Hierarchy


To enforce a fixed structure of the node types in the WBS, you must define the hierarchy on the
B.10.07 Node-Type Hierarchy screen.
In addition, the project default ZB_BOMHIER (Free BOM Structure?) must be set to N.
The purpose of this function is to fix the hierarchy in the WBS in order to prevent users from
changing it for ongoing projects and to prevent them from making mistakes.
As already explained earlier in this document, the WBS is defined in accordance with project
requirements and with reference to a plant layout drawing. A typical fixed hierarchy is shown in
the graphic below.

Each node type has an assigned parent node type, except the top node type DISC. This
assignment ensures that, for example, lines are only entered within units.

SmartPlant Materials E&PI(BOM) User's Guide 23


Setup

Position Attributes
On the B.10.04 Position Attributes screen, you can define variable BOM position attributes for
use on the B.20.01 Edit BOM and B.20.03 Adv. Maintain BOM screens. These attributes are
used to add additional information to BOM positions, that is, information not supplied by the
ident description.

The position attribute definition is stored by discipline.


All attributes defined on the A.50.01 Attributes screen can be assigned. An attribute can
only be assigned once to a discipline.
When you assign new attributes, select the appropriate discipline in the first (Discipline) block.
Then move to the second (Assigned Attributes) block and enter a sequence number for the
attribute in the Order Seq field. This number establishes the display sequence of variable
position attributes on the B.20.01 and B.20.03 screens.
In the Name field, you can use the LOV function to select the attribute, and the Description and
Unit Code fields are automatically filled from A.50.01.
With the Mandatory indicator, you can define an attribute as obligatory, meaning the attribute
values must be filled when entering BOM positions on B.20.01/B.20.03; otherwise, a warning
message appears, prompting the user to enter the value.
The warning message appears only when the mandatory attribute is visible in the current
view.

24 SmartPlant Materials E&PI(BOM) User's Guide


Setup

If you enter a value in the Target Node field, the attribute is only added to positions of that node.
When Include Sub Nodes is checked, the attribute is also added to the sub nodes of the
selected target node.
The third (Assign Attributes - Group Dependent) and fourth (Assign Attributes - Part
Dependent) blocks can be used to define group or part specific attributes. These position
attributes are only added for matching groups or parts. The handling in these blocks is the same
as in the second block.

 The attribute definitions should be set up here before Bills of Materials are created in the
project. But, you can also add attributes here when BOMs are already present. The new
attributes are then automatically copied to the relevant BOM tables for those positions
belonging to the selected discipline.
 For adding attributes when BOMs are present, the insertion may take some time to
complete. Furthermore, if you have large amounts of BOM data, this operation may also
require a large amount of rollback space because of the data size of this transaction.
Therefore, it is possible to set up the RBS_PROP parameter on the A.60.04 screen to
assign this kind of transaction to a specific rollback segment. This rollback segment must
exist in the database, and, of course, must also be placed online by the DBA; otherwise, an
Oracle server error message occurs.

BOM Views
There are two ways in SmartPlant Materials to view BOM data on the B.20.01 Edit BOM and
the B.20.03 Adv. Maintain BOM screens: the single position view and the multi position view.

SmartPlant Materials E&PI(BOM) User's Guide 25


Setup

Single Position View


In the single position view, only one position is displayed at a time, and the user must scroll to
see the next position. The screen for this view is hard-coded in SmartPlant Materials.

Multi Position View


In the multi position view, the user can display up to 20 positions on B.20.01 or up to 13
positions on B.20.03. This multi position view is customizable.

You can define on two levels which BOM position information appears in the multi position view,
either on the discipline level for all users logged in with this discipline, or on the user level, which
allows the user to define his own individual view.

26 SmartPlant Materials E&PI(BOM) User's Guide


Setup

Discipline BOM Views


The prerequisites for defining discipline BOM views are as follows:
 A list view must be defined on A.20.06.11.
 This list view must be assigned to the user security of the current login environment on
A.20.06.02.
Use the B.10.09 Discipline BOM Views screen to define BOM views on the discipline level.
These BOM views are available for all users logged in with this discipline.

Select the name of the discipline in the Discipline Code field in the first (Disciplines) block.
Then move to the second (Attributes for Discipline BOM Views) block. Here you can define a
set of BOM attributes that the discipline users can access in the multi position view of the BOM
module. To assign an attribute, enter a sequence number in the Order Seq field. This sequence
number controls the display order of the attribute fields on the B.20.01 screen.
Next, select an attribute from the list view assigned to the user security on A.20.06.02. For more
information about list views and attribute security, see Attribute Security in the SmartPlant
Materials Administrator's Guide, available from the Printable Guides page. There are two
different kinds of attributes: fixed hard-coded attributes and variable user-definable attributes.
The number of displayed variable attributes is restricted to a maximum of 20. For this reason,
use only sequence numbers from 1 to 20 for the variable attributes; otherwise, they won’t
appear.
To assign all attributes defined by the list view to the selected discipline in one step, use the
Copy All Attributes button at the bottom of the screen.

SmartPlant Materials E&PI(BOM) User's Guide 27


Setup

The picture below shows the multi position view as defined on B.10.09 shown in the picture
above. The hard-coded attributes always appear on the left side, whereas the variable attributes
appear on the right side of the screen.

The discipline BOM views are usually defined by BOM or discipline super
users/administrators.

BOM User Views


To allow each user to adjust the multi position view according to his requirements, the user can
define his individual BOM view on the B.10.06 BOM Views screen.

The BOM user views are categorized for use on the B.20.01 or B.20.03 screens. Select either
Screen B.20.01 or Screen B.20.03 from the list in the Used For field. The View Type can only
be set for the B.20.03 specific views. You can select one of the types listed below from the
drop-down list.
 Personal - This view can only be used by the user who creates it.
 Project Wide - All projects users in all disciplines can use this view.
 Discipline Specific - Similar to the discipline BOM views defined on B.10.09 for B.20.01,
this view can be used by all users logged in to the specified discipline.
The Copy View button can be used to copy view definitions from other projects. This button
opens a box where you can use the LOV to select an existing user view to be copied from.

28 SmartPlant Materials E&PI(BOM) User's Guide


Setup

After selecting the view in the Copy from User View field, click the Copy button to copy the
attributes.
You can click the Copy All Attributes button to open the selection box displayed below.

Choose Copy Attributes from A.20.06.11 to copy the attributes from all list views assigned to
the login user. Or, select the Copy Attributes from B.10.03 and B.10.04 option to copy all
attributes currently defined as node type or position attributes in the login project.
When both the discipline BOM view and BOM user view are present, the BOM user view
will be prioritized and applied when opening the multi position view.

BOM Rules
The purpose of the B.10.05 BOM Rules screen is to administer assembly explosion and site
activities. Here, only assembly explosion for BOMs and requisitions is described.
Assembly explosion for BOMs means that child idents of assemblies are physically copied to the
BOM. Assembly explosion for requisitions means that assemblies are exploded during the MTO
job, and the child idents are copied to their respective requisitions.
For requisitioning, it is not necessary to copy assembly child idents to BOMs.

To define a BOM rule for assembly explosion on BOM, first define a rule group in the first (Rule
Groups) block. Enter the group name in the Rule Group field and its description in the Short
Desc and Description fields. In the Category field, select the value BOM_Copy from the list.
Save and go to the next block.

SmartPlant Materials E&PI(BOM) User's Guide 29


Setup

In the second (Rule) block, enter a name in the Rule field and descriptions for the rule in the
Short Desc and Description fields. Next, a Where condition must be assigned to the rule. To
do this, use the LOV in the Where Condition field to select a predefined Where condition from
the list. Or, double-click in the Where Condition field to open the A.60.06 Where Conditions
screen. On that screen, you can verify the existing Where conditions for the B.10.05 module, or
you can create a new Where condition. When done, close the A.60.06 screen to go back to
B.10.05. For more information about Where conditions, see the SmartPlant Materials
Administrator’s Guide, available from the Printable Guides page in the software.

BOM Procedures/Macros/Buttons
BOM procedures can be used to verify and maintain BOM position data.
The BOM procedures are available for execution on the B.20.03 Adv. Maintain BOM screen to
those users with the EXEC_ALL_BOM_PROCEDURES privilege, as a user privilege on
A.20.06.04 or as a role privilege on A.30.03.

30 SmartPlant Materials E&PI(BOM) User's Guide


Setup

BOM procedures and macros can be defined on the B.10.21 BOM Procedures/Macros screen.

The Procedures tab in the upper section displays the available procedures, with the procedure
name in the Procedure field and a description in the Comment field. Select the Display
indicator for all procedures to be displayed on the pop-up menu on B.20.03. Up to ten
procedures can be displayed on the menu. An example of the menu is displayed in the picture
below.

The standard procedures delivered with the software have the Standard indicator selected and
cannot be changed. The available standard procedures are listed below.

Procedure Comment

EST_SHORTAGE Calculate Estimation Shortage

SmartPlant Materials E&PI(BOM) User's Guide 31


Setup

IDENT_INFO BOM VERIFICATION JOB - IDENT_INFO

VER_BLD_IDENT BOM VERIFICATION JOB - VER_BLD_IDENT

VER_BOM_COPY BOM VERIFICATION JOB - VER_BOM_COPY

VER_BOM_POS BOM VERIFICATION JOB - VER_BOM_POS

VER_FND_IDENT BOM VERIFICATION JOB - VER_FND_IDENT

VER_IDENT BOM VERIFICATION JOB - VER_IDENT

VER_ISSUE_DEL BOM VERIFICATION JOB - VER_ISSUE_DEL

VER_ISSUE_REV BOM VERIFICATION JOB - VER_ISSUE_REV

VER_PJSPEC BOM VERIFICATION JOB - VER_PJSPEC

VER_SPEC_UPDT BOM VERIFICATION JOB - VER_SPEC_UPDT

VER_TSQ BOM VERIFICATION JOB - VER_TSQ

VER_TSQ_CHK Find Nodes higher IS but not with Issued/Reserved


QTYs

The Exec for Nodes check box specifies whether the BOM procedure shall run against nodes.
In this case, LN_ID must be passed as one of the procedure parameters. If the check box is not
selected, the procedure will run against BOM positions. In this case, LP_ID must be passed as
one of the procedure parameters.
To define a procedure, enter the procedure name in the Procedure field and a description in the
Comment field. Select the Display indicator to make the procedure available on the B.20.03
menu. Select the Exec for Nodes check box if the procedure should run against nodes. Then
save this new record.
Click on the Procedure Parameters tab to display or define the parameters for the selected
procedure.

Select the parameter to be assigned to the procedure from the LOV in the Parameter field.
Parameters to be used as BOM procedure parameters must be defined on the A.30.05
Parameter screen. For more information about the parameter definition, read the SmartPlant
Materials Administrator’s Guide, available from the Printable Guides page in the software.
Only parameters with data type VARCHAR2, DATE, or NUMBER are allowed.

32 SmartPlant Materials E&PI(BOM) User's Guide


Setup

Enter a sequence number greater than 1 in the Seq field to define the order of the parameters in
the BOM procedure. The value 1 is reserved for LP_ID or LN_ID. Enter a parameter default
value in the Default Value field. Save the assigned parameters.
Go back to the Procedures tab and click the Edit Procedure button to open window 2, which
displays the BOM procedure definition of the selected procedure.

The selected procedure and its description are displayed on top in the Procedure and
Comment fields. A part of the declaration and execution section and all of the exception section
of the new BOM procedure are automatically generated and displayed, but you cannot modify
these parts of the procedure. You can only add missing declarations and the execution section
of the procedure in the central field with the light background color.
An API (M_PCK_BOM_PROC.LOG_DETAIL_INFO) is provided to record customized log
messages from within the BOM procedure. After execution of the procedure, the log messages
can be viewed on the B.20.03 Adv. Maintain BOM screen.
The API takes four parameters as described below.
M_PCK_BOM_PROC.LOG_DETAIL_INFO (<KIND_OF>, <TEXT>, <RET_VAL>, P_LP_ID)
The <KIND_OF> argument is a message type of indicator for classifying the log message. You
can use any three characters for the value of the <KIND_OF> argument. Do not use the
argument values ‘MAR’, ‘WRN,’ or ‘ERR’ because these values are reserved for system internal
logs (‘MAR’ - information log, ‘WRN’ - warning log, ‘ERR’ - error log).
For the <TEXT> argument, you can use any text value that you want to have as a log comment.
For the <RET_VAL> argument, you can use any text value that you want to have as a log
comment returning from the BOM procedure.

SmartPlant Materials E&PI(BOM) User's Guide 33


Setup

The P_LP_ID argument must always be kept as the last argument in the list. This variable is
passed as the first argument to the BOM procedure.
The first characters of the character string returned through the variable V_RET_VAL
from the BOM Procedure must not be Error.
After defining the procedure, save it. The Compilation Message field at the bottom will show
‘Not Compiled.’ Click the Compile button to compile the procedure. If the procedure compiles
successfully, the Compilation Message field shows ‘Function <PROC_NAME> compiled
successfully.’. If the compilation is not successful, the corresponding compilation error message
is shown in the Compilation Message field. Only successfully compiled procedures can be run
from B.20.03 Adv. Maintain BOM.
If it is required to execute a set of BOM procedures cumulatively, you can define a BOM macro
on the Macros tab in the lower section of the screen.

Enter the macro name in the Macro field and the description in the Comment field. Select the
Display indicator if the macro should be displayed on the pop-up menu on B.20.03. Up to ten
macros can be displayed on the menu. An example of the menu is displayed in the picture
below.

In the next (BOM Macro Details) block, you can assign pre-defined procedures to the selected
macro. Enter a unique sequence number in the Seq No. field; this number controls the
execution order of the BOM procedures within the macro. Then select the procedure from the
LOV in the Procedure field and save.

34 SmartPlant Materials E&PI(BOM) User's Guide


Setup

On the Buttons tab in the lower section of the screen, you can assign up to four of your favorite
BOM procedures or BOM macros to buttons displayed on B.20.03.

Select the procedure or macro from the LOV in the BOM Procedure/Macro field and enter a
label in the Button Label field. These buttons will be displayed on the B.20.03 Adv. Maintain
BOM screen and can be used for fast access and execution of the associated BOM procedure
or macro. The buttons defined on B.10.21 are displayed at the bottom of B.20.03 beside the
‘Search for’ section.

If you run a procedure from B.20.03 which is not compiled successfully, the message displayed
below will appear.

Clicking OK will automatically open the B.10.21 BOM Procedures/Macros screen where you
can revise and validate the procedure.

SmartPlant Materials E&PI(BOM) User's Guide 35


Setup

While executing a valid BOM procedure, the Selection Criteria box displayed below will pop up.

On the Node Selection Options tab. the selected node with its entire path is displayed in the
Path field. Select the Include Sub-Tree check box to include all sub-nodes of the selected WBS
node to be processed by the procedure.
To add additional nodes to be included in the processing, click the Select Multiple Nodes
check box, this will enhance the box as displayed below.

Click the Browse button to open the BOM multi selection LOV, select the Sel check box of all
nodes to be included, and click the Fill In button to close the LOV and copy the selected nodes
to the Selection Criteria box.
Select an option from the Issue Status Selection radio group. The available options are:
 Any - All positions with any issue status will be processed.
 Best Quantity - Only positions with the highest issue status of the node (according to best
quantity logic) will be processed.

36 SmartPlant Materials E&PI(BOM) User's Guide


Setup

 Specified - You must specify a particular issue status by selecting it from the LOV in
the Issue Status field. Only positions with this specified issue status will be processed.
Click on the Procedure Parameters tab to adjust the parameter values.

Click the Continue button to start the procedure execution. When done, the box below will
appear.

SmartPlant Materials E&PI(BOM) User's Guide 37


Setup

Click the Show Log button to open a new window, which displays the BOM Procedure/Macro
Logs screen.

Flat Configurations
To import BOM data to SmartPlant Materials with the Flat Loading Config data source option
on B.40.01, you must define a flat configuration on the B.10.41 Flat Configurations screen. For
more information, read the Flat Loading Config Import chapter in the SmartPlant Materials Open
MTO Interface (OMI) documentation, available from the Printable Guides page in the software.

38 SmartPlant Materials E&PI(BOM) User's Guide


SECTION 2

BOM Handling

Edit BOM
BOM handling on the B.20.01 Edit BOM screen is described in the SmartPlant Materials How to
Handle Bills of Materials (BOM) document, available from the Printable Guides page in the
software.

SmartPlant Materials E&PI(BOM) User's Guide 39


BOM Handling

Edit BOM (Easy Entry)


To enter new BOM data easily, you can use the B.20.02 Edit BOM (Easy Entry) screen.

Advanced BOM Maintenance


The work breakdown structure (WBS) with its properties and attributes is defined and
maintained on the B.20.03 Adv. Maintain BOM screen. The picture below shows the screen
with these major sections:
Tree View Section - Displays the WBS in a tree structure view. In the tree view, you can
perform actions such as adding, deleting, copying, and moving nodes.
Flat View Section - Displays the WBS in a flat structure view. In the flat view, you can perform
actions such as adding or deleting nodes, updating node names, and so forth. . The control
section helps to adjust the view according to the user’s preferences.
Node Properties and Attributes Section - Displays the properties and assigned attributes with
their values of a selected node.
Search Section – Allows you to search particular nodes in the WBS structure. This section is at
the bottom on the left.

40 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Button Section – Allows you to place user-defined buttons. This section is at the bottom on the
right.

The sections are described in detail in the following chapters.

WBS Tree View


In this section, the work breakdown structure (WBS) is displayed in a tree structure. It behaves
similar to Windows Explorer in the Windows environment and supports operations like add
node, delete node, cut/copy and paste, refresh tree, expand all nodes, and others through a
pop-up menu.
The WBS tree displays all nodes created in the login project and discipline. If queryable
disciplines are defined for the login user, the nodes of these disciplines are also displayed. Data
manipulation like add, delete, or update is only allowed for nodes of the login discipline. The
node icons indicate if the node is assigned to the login discipline or another discipline and if the
node is unlocked or locked. The icons and their purpose are listed below.

Icon Meaning

Node is assigned to the login discipline and is not locked.

Node is assigned to the login discipline and is locked (released).

Node is not assigned to the login discipline and is not locked.

Node is not assigned to the login discipline and is locked

SmartPlant Materials E&PI(BOM) User's Guide 41


BOM Handling

(released).

Node is manually locked from the B.40.31 Manually Lock


BOM screen.

With a right mouse-click on a node, you can open the pop-up menu displayed in the picture
below.

The commands on this pop-up menu are described below.

42 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Add Root Node


This option is enabled only if more than one root node (master node) is allowed in the login
project/discipline; that is, the project default ZB_1MSTR is set to N (default). If you select this
command from the menu, the Add Node box will be displayed.

Select the node type from the LOV in the Node Type field; enter the node name in the Name
field and descriptions in the Short Desc and Description fields.
If the project default ZB_NODE_UK is set to Y, the node names for a node type must be
unique within the project. When trying to create a node name that already exists for the node
type in the project, the message ‘MAR-20391: A node with the name already exists for the node
type in the project’, and you cannot save the node.
You can select an issue status from the LOV in the Preassigned Status field, which will be set
as the default when creating BOM positions for this node. The quantity factor is set to 1 in
the QTY Factor field, but it can be changed before saving the node. When all fields are filled on
this Property page, select the Attribute page, which displays the attributes assigned to the
selected node type on the B.10.03 Node Types and Settings screen.

SmartPlant Materials E&PI(BOM) User's Guide 43


BOM Handling

Enter the attribute values, and use the LOV whenever available. Then click OK to complete
node creation, or click the Cancel button to cancel this action. On successful completion, the
new node is added at the root level of the existing WBS.

Add Child Node


If you select this command from the menu, the Add Node box will be displayed also, but now
with the entire path of the selected node shown in the Path field.

Fill out the fields as described above, and then click OK. On successful completion, the new
node is added beneath the selected node.

44 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Delete Node
This command allows you to delete the currently selected node with all sub-nodes and positions
from the WBS tree. When you select this option from the menu, you will be prompted to confirm
the delete operation as shown below.

Click Continue to go ahead or Cancel to abort.


A node cannot be deleted if it is assigned to another (non-login) discipline, or if the node
has been released, that is the Released indicator is set on the Property page.

Cut / Copy - Paste


If you want to copy or move a WBS node, select this command from the menu. The B.20.03.08
Cut/Copy Nodes screen appears.

In the Cut/Copy section, select Cut if you want to cut (move) the selected node or Copy if you
want to copy the selected node. Next, select what should be moved or copied: only Structure
(only the node structure), only Positions (only the BOM positions of the selected node, or with
Structure and Positions (both node structure and BOM positions).
If the project default ZB_NODE_UK is set to Y, the node names for a node type must be
unique within the project.

SmartPlant Materials E&PI(BOM) User's Guide 45


BOM Handling

In the From Project/Product Group section, select same Project/Product Group to


copy/move the node/positions within the current project/product group. If you select other
Project or other Product Group, you must select the destination project/product group from the
LOV in the Project/Product Group field.
In the Map Nodes section, you select the node to be copied/moved from the LOV in the Source
Node Path field. Or, you can click the Browse button to open the BOM multi selection LOV.

Select the Sel check box of all nodes to be copied/moved, and then click the Fill In button to
close the LOV and to insert the selected nodes in the Source Node Path field. You can use
the Select All button to mark all displayed nodes. To cancel the selection, you can use
the Unselect All button.
Next, click in the Destination Node Path field and open the LOV using the LOV button or
the Browse button. Select the destination node(s) as described above.
In the Source and Destination sections, you can define copy settings. With from Position
and to Position, you can limit the positions of the selected node to be copied; by default it is set
to 0 and 9999999999. These options as well as List Status from and List Status to are only
available when you have selected only Positions in the Cut/Copy section. The list status can
be selected from the LOV in the List Status from and List Status to fields to copy/move
positions to another list status. Select the Best Qty check box or an issue status from the LOV
in the Issue Status from field. Select Only Position Attributes from the Attribute Option
radio group to copy/move the position attributes only. Or, select All Attributes to also

46 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

copy/move the node attributes. Select the keep Item Number check box to copy the positions
with its original position number. If the check box is cleared, new position numbers will be
created. If you select the with Assemblies check box, assembly structures will also be copied
with the positions.
In the Destination section, if you select Manual in the Type field, you must select an issue
status for the destination from the LOV in the Issue Status to field. This issue status will be set
for all copied positions at the destination node.
If you select Automatic from the dropdown list in the Type field, the positions will be copied
from the source node to the destination node, and for each destination node the issue status will
be set for all copied positions as follows.
 Existing positions at the destination node: Based on the highest issue status of the existing
positions, the issue status of the copied positions will be set to the next available issue
status.
If the maximum available issue status is already assigned to existing positions, the
procedure automatically creates a new issue status and assigns the copied positions to this
new issue status. The name for the new issue status is "AUTO" concatenated with the next
available sequence number, for example, AUTO51.
 No positions exist at the destination node: The issue status of the copied positions will be
set to the lowest available issue status.
Save and click the OK button to start the copy/move procedure. You can click the Cancel button
to close the screen without copying/moving anything.
When the copy/move procedure succeeds, this message will appear.

If the project default ZB_BOMHIER is set to N, only a fixed node type hierarchy is
allowed in the project. For more information, see Node Type Hierarchy (on page 23). In case of
a fixed node type hierarchy, nodes can only be copied/moved to a new parent node with the
same node type as the original parent node.

SmartPlant Materials E&PI(BOM) User's Guide 47


BOM Handling

Populate from PLL


If you select this command, window 17 will open where you can select multiple PLL units to be
populated to the BOM. The displayed PLL units have been created on the L.20.01 Process
Line Lists screen.

Tick the Select check box for all nodes to be created in the WBS, or click the Select All button
to mark all displayed units. To cancel a selection, use the Deselect All button. Finally, click
the Use in BOM button. All selected PLL Units will be created as child nodes underneath the
selected BOM node. These child nodes will get the same name as the corresponding PLL units
and the node type assigned to the ZB_LS_UNIT project default. Any existing process lines of
the selected PLL units will be created as child nodes of the unit BOM nodes. These child nodes
will get the same name as the corresponding process lines and the node type assigned to the
ZB_LS_LINE project default.
It is mandatory that the ZB_LS_LINE and ZB_LS_UNIT project defaults are correctly
defined. It is mandatory that the node type hierarchy is defined on B.10.07 Node Type
Hierarchy with the node type assigned to the ZB_LS_UNIT project default set as the Parent
Node Type of the node type assigned to the ZB_LS_LINE project default. For an example, see
the picture below, where node type UNIT is assigned to ZB_LS_UNIT and node type LINE to
ZB_LS_LINE.

48 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Refresh
To refresh the WBS tree view, select this command from the menu.

Expand All
Click this command to expand the entire WBS tree (open all nodes and sub-nodes).

BOM Procedures/Macro
Users with the EXEC_ALL_BOM_PROCEDURES privilege can use this command to start
predefined BOM procedures and macros. For more information about BOM procedures and
macros, see BOM Procedures/Macros (see "BOM Procedures/Macros/Buttons" on page 30).
After running a procedure, select the Show BOM Procedure/Macro Log sub menu item to
open a new window displaying the procedure/macro log.

SmartPlant Materials E&PI(BOM) User's Guide 49


BOM Handling

List Download
Select this command to export the selected node with its sub-nodes and positions, either to an
ASCII file in OMI format or to an Excel file. If you select this command, the B.20.01.44 List
Download screen will be opened, with the selected node shown in the BOM Path field on top.

In the into Export File section, select the OMI Export or Excel Export option. The download
path assigned to the DBA setting BOM_DOWNLOAD_DEST is displayed in the Physical Path
field. Enter the name of the file to be created in the Physical Filename field.
In the BOM Data Options section, select the with Structure check box to export the BOM
structure also. Select the with Position check box to export the BOM positions assigned to the
selected nodes.
Use the Assemblies radio group to determine the complexity of the download. Select one of
these options:
 without Assemblies - The assembly structures present in the BOM positions will not be
downloaded.
 with BOM-Assemblies - Assemblies will be exploded and downloaded according to the
BOM Copy rule assigned to the ZB_COCP project default.
 with Assemblies by Requisition Rule - Assemblies will be exploded and downloaded
according to the BOM Copy rule assigned to the ZR_COREQ project default.
 with Assemblies by Construction Rule - Assemblies will be exploded and downloaded
according to the BOM Copy rule assigned to the ZB_COCON project default.
Select an option from the Issue Status radio group. The available options are listed below.

50 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

 Selected - You must select a particular issue status from the LOV in the Issue Status field.
Only this selected issue status of the positions will be exported.
 Highest - Only the highest issue status of the positions will be exported.
 Lowest - Only the lowest issue status of the positions will be exported.
 All - The positions will be exported with all issue statuses, and re-import of the exported
data will not be possible.
In the BOM Attribute Options section on the right, you define which attributes are to be
exported. The available options are:
 With Attributes for Re-Import - With this option, attributes directly assigned to each
position are exported. To prevent import processing performance being negatively affected,
no attributes are downloaded in duplicate within the path.
 With directly assigned Attributes in User BOM View - Only node and position attributes
that were directly allocated through the node type or the discipline allocation are exported.
 With all Attributes in User BOM View - The node and position attributes that are defined in
the current BOM view, used by the user who called this function are exported.
 With all Attributes - With this option, all variable attributes for each selected node and each
position will be exported.
To start the list download, click the Online button.
The DBA settings BOM_DOWNLOAD_DEST and BOM_DOWNLOAD_URL must be set
properly before starting a list download. For more information about DBA settings read
the SmartPlant Materials DBA Settings document, available from the Printable Guides page in
the software.

SmartPlant Materials E&PI(BOM) User's Guide 51


BOM Handling

Attach Documents
This command can be used to attach or link documents to the nodes and positions in the BOM.
When you select this command, the D.10.21 Attached Documents screen opens.

Here you can attach documents (pre-defined on D.10.11) to the selected WBS. To attach a new
document, select the document name from the LOV in the Name field. All other fields are
optional. Instead of attaching single documents, you can select a document set from the LOV in
the Document Set field at the bottom and click the Copy button. All documents assigned to the
selected set on D.10.12 will be copied and attached to the selected WBS node. Click OK to
complete the document attachment and to close the screen, or click Cancel to close the screen
without attaching any document.

WBS Flat View


The WBS Flat View section in the middle of the screen provides a set of functionalities to work
on the WBS/BOM in an easy manner. The main purpose of this section is to provide a
spreadsheet type of utility where you can work on a bigger part of the tree. Unlike the tree view
section where the add/edit/delete operations can only be done for one node at a time, this
section allows the user to create several nodes or tree branches, modify the names of several
nodes, and delete several nodes in one operation. You can type in the name of a parent node
and then sub-nodes of this parent node in multiple levels in one row, to create a branch in the
tree.
To display WBS nodes in the flat view, select the Flat View check box on top.

52 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Select the Selected Node view option from the radio group to display only the selected WBS
node with its sub-nodes, or select Full Tree to display all nodes of the tree.
For more information about the Drag and Drop check box and the other core workflow screen
features, read the Core Workflow Screens chapter in the SmartPlant Materials User Interface
Basics document, available from the Printable Guides page in the software.
The TSQ Required indicator is set by the software. It indicates if for the selected node a TSQ
(transfer site quantities) job must be performed, because the node has positions with site
quantities (issue/reserved) in a lower issue status than the highest issue status at this node. You
can also find this indicator on window 2 on the multi and single position view tabs.
The flat view is sorted in ascending order, using all the WBS structure levels according to the
hierarchy, starting with level 1, level 2, and so forth. The order sequence is displayed in
the Ordered by field.

To enlarge the flat view section, you can use the Show/Hide BOM Tree button to hide the

tree view section, and the Show/Hide Property Window button to hide the node
properties section. If you use both buttons, the screen looks like that shown in the picture below.

Use the buttons again to unhide the tree view and node properties sections.
If the ZB_BOMHIER project default is set to N, which means the project uses a fixed node type
hierarchy defined on B.10.07, the node types are displayed as column labels as shown in the
picture above. If ZB_BOMHIER is set to Y, the columns will be labeled with ‘Level 1’, ‘Level 2’,
and so forth, reflecting the node level in the hierarchy.
The flat view is limited to a node type hierarchy of ten levels maximum.
You can include the following additional fields in the flat view:
Discipline - Discipline of the last displayed node in the row.
Object Code - Object Code of the last displayed node in the row.
Released - Released indicator that shows if the last displayed node in the row is
locked/released.
Issue Status - Issue status of the last displayed node in the row. If the Issue Status field is
displayed and the associated positions have different issue statuses, the node will be displayed
multiple times, once for each assigned issue status.
List Status - List status of the last displayed node in the row. If the List Status field is displayed
and the associated positions have different list statuses, the node will be displayed multiple
times, once for each assigned list status.

SmartPlant Materials E&PI(BOM) User's Guide 53


BOM Handling

The selected node is displayed with a light blue background color.

Selected nodes from queryable disciplines are displayed in red. These nodes cannot be
changed or deleted.

Add Node
New nodes can be added to the WBS tree from the flat view. This operation is supported only
when the ZB_BOMHIER project default is set to N and a strict node type hierarchy is maintained
by the WBS tree. You can type in the name of the new node in a blank field and save by clicking
the Save button. This will create a new node under the node shown in the field on the left. The
picture below shows how to create the new sheet 102 under the line LAB01.

While creating the node, the values for the other node properties are assigned automatically as
follows:
Node Type - This is the type of the column as represented by the caption of the column.
Short Description and Description - This is set as the node name.
QTY Factor - Set to 1.
The first column in the flat view represents the nodes at the root level of the tree. If you enter a
new name in the first column, this will create a new root node. If the ZB_1MSTR project default
is set to Y, the existing root node name will be copied to a new record.

Edit Node Name


The flat BOM view only allows editing the name of the node. In the case of a locked/released
node, this node name cannot be changed.

54 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Delete Node
This operation enables the user to delete a particular node from the BOM tree. It should be
noted that when you delete a node, all the nodes under the node that you chose to delete will
also be deleted. In order to delete a node from the flat BOM view, just delete the entry from that
field. For example, to delete the node 206 displayed in the picture below, delete the entry from
the SHEET field and save.

Add/edit/delete node is not possible in the flat view if the Issue Status or List Status
field is included in the flat view configuration. Nodes from queryable disciplines cannot be
updated or deleted. To add new rows or nodes in the flat view, all hierarchy levels must be
present in the flat view. If not all levels are displayed, you cannot add new nodes.

Pop-up Menu
With a right mouse-click in any field of the flat view section, you open the pop-up menu
displayed below.

Add Field, Remove Field, Set Column Spacing, and Order by this field ASC/DESC are
standard core workflow commands. For more information, read the Core Workflow Screens
chapter in the SmartPlant Materials User Interface Basics document, available from
the Printable Guides page in the software.
BOM Procedures/Macros, List Download, and Attach Documents are described in WBS
Tree View (on page 41).

SmartPlant Materials E&PI(BOM) User's Guide 55


BOM Handling

With Add This Field in Order By ASC/DESC, you can add the selected field to the order by list
to include it in the sorting criteria, displayed in the Ordered by field.

Node Properties and Attributes


This section on the right shows the property values and the attribute values of a WBS node
selected in the tree view or in the flat view section. The node properties and attribute values can
only be updated for unlocked nodes of the login discipline. On the first (Property) tab, the
properties of the selected node are displayed.

The node name in the Name field and the descriptions in the Short Desc and Description
fields can be modified. The name is displayed in red if the node is locked or if the node is not
assigned to the login discipline. The Path field shows the entire path of the selected node, and
the Node Type field shows the type of the selected node. In the Generated Name field, the
name of the selected node, generated by the user defined description rule assigned to the node
type, is displayed. The path, node type, and the generated name cannot be changed.
In the Preassigned Status field, you can assign the issue status at the node level to make sure
that all sub-nodes and positions will get the same issue status. Once an issue status is assigned
at node level, the following will happen:
 All the sub-nodes of the selected node will get the same issue status assigned.

56 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

 The existing manual positions for the node and its sub-nodes will get copied with the
assigned issue status at the node level.
It will not be possible to assign the issue status at the node level if:
 The existing manual positions of the node and its sub-nodes have a higher issue status than
the one assigned to the node.
 One or more of the existing manual positions of the node and its sub-nodes have a reserved
quantity or issued quantity greater than 0 (zero) or are assigned to un-posted MIRs.
Select an issue status from the LOV, save the change, and the associated sequence will be
shown in the Order Seq field. The message below will appear.

Click Continue to populate all sub-nodes and positions with the selected issue status.
If you add a new sub-node, the pre-assigned status from the parent node is automatically
assigned to the sub-node. When creating a new BOM position at a node with a pre-assigned
issue status, this status will automatically be copied to the position and cannot be changed
there.
You can use the Next Issue Status button to assign the issue status with the next order seq to
the selected node. Click Yes to continue.

When there is no higher issue status defined, a message appears, asking you if the new status
should be created.

The software will create a new issue status starting with AUTO and followed by the Order Seq.
The new Order Seq is calculated as the old highest order seq + 1. An example is displayed
below.

SmartPlant Materials E&PI(BOM) User's Guide 57


BOM Handling

The structure quantity of the node is shown in the QTY Factor field; by default, it is set to 1. The
revision values are displayed in the Rev1 and Rev2 fields and cannot be changed.
If the selected node was locked, the Released indicator is checked and the Unrelease button
enabled. You can use this button to remove the lock.

Click the Attribute tab to display the node attributes.

The node attributes assigned to the node type on B.10.03 and the node attributes propagated
from parent nodes are displayed. If the attribute was defined with a list of values on A.50.01, you
can use the LOV in the Value field to enter or update the value.

Search
The Search section at the bottom of the screen provides a way to search for a node in the WBS
tree.

For the simple search, enter the node name you are searching for or a part of it in the Search
for field and click the Search button. The Search Result window opens, displaying the nodes
found for the entered search criterion.

The nodes are shown with their node type and path. To navigate to a node in the Tree View,
double-click on this node in the Name field.

58 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

For a more advanced search, click the Advanced Search button to open the Advance Search
window, which allows you to enter more complex search criteria and to search in other fields
besides the node name.

Enter the search string in the Search for field. The search string can have multiple words. Next,
select one of the given search options:
 With all words - All words of the entered search string must match (default).
 With exact phrase - The search must match exactly the string entered in the Search for
field.
 With at least one of the words - At least one of the words of the entered search string
must match.
Specify the scope of the search by selecting the appropriate option. The available scope options
are listed below. At least one of the scope options must be selected.
 Node Name - WBS node name.
 Node Description - Short description or description of the WBS nodes.
 Node Type - Types of the WBS nodes.
 Node Attribute Value - Values of the node attributes.

SmartPlant Materials E&PI(BOM) User's Guide 59


BOM Handling

 Positions - BOM position.


 Positions Values - Values of the BOM position attributes.
 Commodity Code - Commodity codes assigned to BOM positions.
 Ident - Idents assigned to BOM positions.
 Ident Description - Short description or description of idents assigned to BOM positions.
 Ident Value - Ident values of idents assigned to BOM positions.
 Ident Value History - Ident value history of idents assigned to BOM positions.
Click the Include All button to select all the scope options for the search. To cancel the
selection, click the Include None button. To start the search process, click the Search button.
The search will include all specified criteria. The results are displayed in the search result
window as described above.
You can use the Search Result button to recall the result of the last search you have performed
in your current session.

Buttons
The Button section on the right of the Search section at the bottom of the screen provides up to
four user definable buttons. These buttons can be used to run procedures or macros.

For more information about user definable buttons, see BOM Procedures/Macros/Buttons (on
page 30).

BOM Position Views


A double-click on a node in the tree view section or in the flat view section opens window 2 with
the BOM position views. This window consists of the tabs listed below.
 Multi Position View
 Single Bulk Material View
 Single Tag Material View
 Multi Status View
These tabs are described in detail in the following chapters.

60 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Select the Include Sub Tree Nodes of <path> check box to query the positions of the selected
node and all its sub-nodes. In this case, the node path is also displayed in the Path field to show
to which node the position is assigned. This feature can be used in the multi position view and in
the single position view.

The Path field in the single position view is displayed in the picture below.

By default, the check box is not checked and only the positions of the selected node are
displayed.

Use Incompl. Specs


You may want to enter manual BOM positions by providing diameter, component type (short
code), option code, specification name (spec code), even though the specification is not
complete.
If you select the Use incompl. Specs check box, then
 specs that do not contain any spec items can be used in creating a BOM position
 all short codes and option codes defined on S.10.08 Short Codes can be used in creating a
BOM position independent of the selected spec
 all sizes of the nominal size table defined on S.40.01 Nominal Sizes, which are assigned to
the spec header geometrics of the selected spec, can be used in creating a BOM position
 once a short code is entered, you will be forced to enter the corresponding sizes
Once a short code is entered, the Unit field will be updated with the corresponding quantity unit.
If the ZB_IN_SPEC project default is set to Y, the Use Incompl. Specs check box is checked
when you open window 2 of B.20.03.

Issue Status dropdown list


The value displayed in the Issue Status field indicates the display and sort order of the
positions with regard to the assigned issue status. The available values are listed below.
 Highest - Positions with the highest available issue status of the selected node are
displayed.
 Lowest - Positions with the lowest available issue status of the selected node are displayed.
 All desc - All positions are displayed in descending order of the assigned issue status.

SmartPlant Materials E&PI(BOM) User's Guide 61


BOM Handling

 All asc - All positions are displayed in ascending order of the assigned issue status.
 Selected - Positions with the selected issue status are displayed. When selecting this
option, a further dropdown list appears where you must select a particular issue status. This
list shows all issue statuses pre-defined on B.10.08.

 Best Quantity - All positions are displayed with the highest issue status assigned.
With the setting of the ZB_ISSUE project default, you can define which issue status option is
used on B.20.03. The available values are:
 ALL_ASC
 ALL_DESC
 HIGHEST
 LOWEST
 BEST_QUANTITY
 SELECTED
If ZB_ISSUE is not set, HIGHEST will be used as the default. You can manually change the
displayed issue status by selecting a value from the dropdown list in the Issue Status field.

Cascading LOV Option


The cascading LOV feature automatically calls the LOV of a field when you navigate to this field
and the field is empty. To activate this feature, set the ZB_AUTOLOV project default to Y. This
feature is available on all position view tabs. The cascading LOV feature is available for the
following fields:
 Spec Code
 Short Code
 Option Code
 Group
 Part
 Commodity Code
 Ident Code
For example, you create a new BOM position and click into the Spec Code field, and the LOV is
automatically opened. Select a spec from the list and click OK to enter the spec in the field. This
will move the cursor to the Short Code field and automatically open the LOV, displaying the
short codes available for the selected spec. And so forth. If you click Cancel in the LOV box, the
cascading LOV functionality is interrupted.
The cascading LOVs can be used independent of the setting of the ZB_AUTOLOV project
default, automatically as described above or manually if ZB_AUTOLOV is set to N. In this case,
using the same example, after selecting the spec code from the LOV, the LOV in the Short
Code field will be limited to the short codes assigned to the selected spec.

62 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Multi Position View


When opening Window 2, the Multi Position View tab is displayed. Click on the other tabs to
change to the Single Bulk Material View, the Single Tag Material View, or the Multi Status
View.
This multi position view is customizable. For more information, see BOM Views (on page 25) in
the Setup section above. The view in use is displayed in the View Name field at the top of the
screen. To change the view, select another view from the drop-down list in the View Name field.

If no item is listed in the View Name field, no view was defined on B.10.06. Without a
pre-defined view, the following fields are displayed on the Multi Position View tab:
 Pos
 Quantity
 Unit
 Item Type
 Size1 to Size 5
 Commodity Code
 Ident Code
 Tag Number
For a description of the fields on the Multi Position View tab, see Single Bulk Material View (on
page 73).

SmartPlant Materials E&PI(BOM) User's Guide 63


BOM Handling

The Order by button can be used to change the default sort order of the displayed positions. By
default, the positions are sorted by issue status. Click the button to open the Order by … LOV.
Select the first field to be ordered by and click OK (or double-click the item).

The LOV will appear again to allow you to select the next field to be included in the sort order
definition. Click Cancel if you don’t want to add more fields. The positions will be sorted
according to your sort order definition. The current sort order is shown in the Ordered By field
on top of the tab.
The Populate Cart Idents button can be used to select a cart and to populate its data to create
new BOM positions. The carts are defined and maintained in the SPRD Explorer; click
the SPRD Explorer button to open the SPRD Explorer.

64 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

With a right mouse-click in any field of the multi position view, you can open the pop-up menu
displayed below.

The commands are described in the following chapters.

SmartPlant Materials E&PI(BOM) User's Guide 65


BOM Handling

Customize View
Select the Customize View command to customize the currently used view. A box will open
showing the available attributes on the left and the attributes used in the view on the right.

To add attributes to the view, select them on the left and click the button. To remove

attributes from the view, select them on the right and click the button. You can use the

button to add all available attributes, or the button to remove all assigned attributes from
the view. The attributes are displayed on the right in the order of their use in the view. To
change the order, use the or button. Finally, click the Select button to complete the
view customization. The message displayed below will appear.

If you click No, the selected fields will be added to the existing BOM view and will be displayed.
If you click Yes, a new BOM view will be created with the selected items, and this new view will
be set in the View Name field and displayed. The name of this new view will be created with the
username and a sequence number, for example ‘USER23’.
In order for a user to allocate attributes to a view, the attributes must be assigned to a
pre-defined list view on A.20.06.11 Attribute Security, and this list view is assigned to the user
on A.20.06.02 User Securities for Projects or to the user role on A.30.03 Roles/Menus.

66 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

You cannot customize a view of type Discipline Specific or of type Project Wide. If you try to
change such a view, the message below will occur.

Click OK to create a new view as described above. The view can be further maintained on
B.10.06; for more information, see BOM User Views (on page 28).

Remove Field : <Field Name>


All displayed fields can be removed from the multi position view, except for
the Pos, Quantity, Unit and Item Type fields. Removing the Spec Code field will automatically
remove the Rev. No, Short Code and Option Code fields as well. If you remove both the Spec
Code and Ident Code fields, the Size 1 - Size 5 fields will be removed as well.

Set Column Spacing


With this setting, you can change the distance between fields.

Order By Asc/Desc : <Field Name>


Will sort the data in ascending/descending order of the selected field.

Tile with BOM Tree view


When selecting this item, window 1 will resize and window 2 will move to the right so that both
the tree view and the BOM position views are visible. This tiling allows you to display positions
of other nodes by double-clicking the node, without closing window 2 in between.

Selecting the item again will resize window 1 to normal size and move window 2 back to its
original position.

Auto Filter
The Auto Filter command provides a quick and easy way to filter and work with a subset of
data.
When you select this option, dropdown list fields are shown on top of the columns where
applicable. These lists contain the fixed values (ALL) and (CUSTOM), and the distinct values

SmartPlant Materials E&PI(BOM) User's Guide 67


BOM Handling

displayed in the column. The values (NULL) and (NOT NULL) are shown in case at least one
position has a NULL (empty) value.

Selecting a value from the list will filter the displayed positions accordingly.

Selecting (CUSTOM) from the dropdown list opens the Auto Filter[Custom] box where you can
enter search criteria to cover a range of values.

Select an operator from the LOV in the first field. These operators are available:
 Equal
 Not Equal
 Like
 Not Like
 Greater Than
 Greater Than or Equal
 Less Than
 Less Than or Equal
Enter a search criterion in the next field. This can be combined with a second AND/OR criterion
entered in the second row. Click OK to apply the filter.

68 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Selecting the Auto Filter item again will hide the dropdown list fields.

Populate Downwards
Select Populate Downwards from the menu to copy the value of the selected field to the
fields/records below. The Populate Downwards functionality is available for the fields listed
below.
 Quantity
 Quantity Unit
 Spec Code
 Short Code
 Option Code
 Size1 - 5
 Ident Code
 Object Code
 Status
 List Status
 Req
 Reload
 all position attributes
Populate Downwards is not applicable when:
 the position does not belong to the login discipline
 the corresponding node is locked/released
 the tag number is filled and the item type is TWM, TOM, TFM, or TAB with the exception of
 the position attributes
 the Status, List Status, Req, Quantity, and Quantity Unit fields if the ZB_TAG_UPD
project default is set to Y.

SmartPlant Materials E&PI(BOM) User's Guide 69


BOM Handling

When calling Populate Downwards from the Spec Code, Short Code, or Option Code fields,
this box is shown:

The first option is displayed as ‘Copy Short Code only’ or ‘Copy Option Code only’
correspondingly.
 If the spec code, short code, option code, or sizes are changed, all the ident-related data
like group, part, commodity code, and ident code are cleared unless the ident consistency
check is done, resulting in the ident being consistent.
 If the spec revision number to be populated is less than the maximum spec revision number,
the alert message ‘Do you want to update Spec Revision Number with Highest Value?’ pops
up. Click Yes to copy the highest revision or highest issued revision, respectively, depending
on the setting of the ZX_ALLSPEC project default. Click No to stop the process.
When calling Populate Downwards from Size 1 - 5, the size field is updated and all
ident-related data like group, part, commodity code, and ident code. The fields are updated
based on the selected spec code, short code, option code, and sizes. If no ident is found for the
size, the ident-related data fields as mentioned above are cleared.

Add/Edit Sub Pos Nodes


Select this command to list or create sub position(s). The sub position records are displayed in
the main block. In the Parent Position Tree field at the bottom, a node is added, displaying the
information about level (like Level1, Level2, and so forth), positions path (like /20/30), and
position values (like Pos: (20), spec code: (AC0014), and so forth).

Back to Parent
Select this command to reach the preceding level. The navigation works level by level. Back to
Parent is only available on sub positions. This button is disabled on the first level.

70 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

List Download
This command is described in List Download (on page 50) in the WBS Tree View section.

Attach Documents
This command is described in Attach Documents (on page 52) in the WBS Tree View section.

Auto Column Width


This command automatically calculates the display length/width of each column depending on
the data so that the user can automatically optimize the amount of visual data.
Auto Column Width functionality does nothing when invoked from a column of type Checkbox or
List. Also, if the column from which this functionality is invoked has all NULL values, then this
functionality does nothing.

Retrieve from PLL


This command allows the retrieval of Spec Code and Size 1 from the PLL (Process Line List)
defined on L.20.01 to the BOM. Choosing this command opens an LOV, displaying Spec Code
and Nominal Diameter values from the line lists.
Prerequisites
 It is mandatory that the ZB_LS_LINE and ZB_LS_UNIT project defaults are correctly
defined. If the project defaults are not set properly, the following message will appear:
‘MAR-20367: Cannot retrieve data from the line lists.’
 The selected node, where the positions are to be created using the data from the line list,
must have exactly one parent node with these properties:
 Same list structure as the one assigned to ZB_LS_UNIT
 The node must be defined on L.20.01 Process Line Lists with the same name in
the PLL Units block.
 If no such match is found, the following message will appear: ‘MAR-20364: Cannot retrieve
data from the line lists.’. If more than one match is found, the following message will appear:
‘MAR-20363: Cannot retrieve data from the line lists.’
 The selected node, where the positions are to be created using the data from the line list,
must have exactly one parent node with these properties:
 Same list structure as the one assigned to ZB_LS_LINE
 The node must be defined on L.20.01 Process Line Lists with the same name in
the Process Lines block.
Instead of the parent node, the selected node itself can have these properties.
If no such match is found, the following message will appear: ‘MAR-20366: Cannot
retrieve data from the line lists.’. If more than one match is found, the following message
will appear: ‘MAR-20365: Cannot retrieve data from the line lists.’

SmartPlant Materials E&PI(BOM) User's Guide 71


BOM Handling

When selecting the Retrieve from PLL command on a new position, the LOV displayed in the
picture below will appear, with the spec codes and sizes listed that were defined for the selected
line on L.20.01.

Select a spec code with size and click OK to close the LOV and fill in the selected values in
the Spec Code and Size 1 fields of the new position.
If no spec codes and/or nominal diameters are assigned to the selected line, the following
message will appear: ‘MAR-20368: Line <line name> under unit <unit name> does not have any
spec or diameter associated.’
The Retrieve from PLL command will not be available if the node is locked/released or is not
assigned to the login discipline.

72 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Single Bulk Material View


The Single Bulk Material View tab fields are described below, ordered by their occurrence on
the screen.

Pos - Unique position number within the selected node. When you create a new BOM position,
the position number is set automatically, based on the ZB_LPSTART (first position number of a
node) and ZB_LP_INC (position number increment) project defaults.
Quantity - Ident quantity of the current position. If the ZB_QTY_NEG project default is set to Y,
negative quantities can be entered. If you create a position with a Tag number (item type TWM
or TOM) and the ZB_TAGQTY project default is set to Y, the quantity must be set to 1.
Unit - Quantity unit to be selected from the LOV. If a unit is assigned to the ZB_UNIT_ID project
default, this unit will be set by default when creating a new position.
TSQ Required - This indicator is set by the software. It indicates whether for the selected
position a TSQ (transfer site quantities) job must be performed, because the position has site
quantities (issue/reserved) in a lower issue status than the highest issue status of the position.
Resv%Sub Qty - Quantity reserved for this position by a forecast/reservation run. This quantity
is displayed for information only; it cannot be changed here.
Issued%Sub Qty - Quantity issued for this position with a MIR on site. This quantity is displayed
for information only; it cannot be changed here.

SmartPlant Materials E&PI(BOM) User's Guide 73


BOM Handling

MLD Issue Qty - Quantity issued for this position with a MIR on site, with issue type 'Miss, Lost
or Damage'. When the quantity is shown in red, the material was issued for this position with a
different quantity unit. This quantity is displayed for information only; it cannot be changed here.
For more information about reserved quantity, issued quantity, and MLD issue quantity,
read the SmartPlant Materials Site User’s Guide, available on the Printable Guides page in the
software.
Status - Issue status of this position, to be selected from the LOV. All issue statuses defined on
B.10.08, which are not excluded on window 2 of B.10.08 with the No Display indicator selected,
are available for selection.
List Status - The release status to be edited must be given, or in the case of creation, entered.
If a list status is assigned to the ZB_LST_ID project default, this list status will be set
automatically when creating a new BOM position.
Lst Date - Date when the list status was set for this position.
Lst User - User who set the list status for this position.
Spec Code - Specification. The LOV in this field shows all specifications pre-defined on S.50.06
with a spec rule that has the BOM indicator set on S.50.01. If the Use Incompl. Specs check
box is not selected, only specs that are not empty will be displayed. If the ZX_ALLSPEC project
default is set to N or not set at all, the LOV will only display issued specs. If the ZX_DP_SPEC
project default is set to Y, only specs created in the same discipline as the login discipline are
displayed in the LOV.
Next to the spec code the spec revision number is displayed.
Short Code - Short Code. The LOV in this field shows all short codes used in the selected spec.
Double-click in the field to open the S.10.08 Short Codes screen.
Option Code - Option Code. The LOV in this field displays the option codes used in the spec.
Item Type - The LOV in this field shows the item types defined on A.10.15 Item Types.
If the ZB_PCKMAIN project default is set to Y and you select an item type with item rule
TWM, TOM, TFM, or REF (tagged item), you can create sub-positions with the same item type.
Group - Commodity Group. You can use the LOV to select a pre-defined commodity group.
Double-click in the field to open the S.10.02 Commodity Group screen.
Part - Commodity Part. You can use the LOV to select a pre-defined commodity part.
Double-click in the field to open the S.10.03 Commodity Part screen.
Commodity Code - Commodity Code. Double-click in the field to open the S.30.01 Commodity
Codes screen.
Ident Code - Ident Code. Double-click in the field to open the S.80.01 Ident Management
screen.
Tag Number - Identifier of a special part. Double-click in the field to open the S.80.25 Tag
Description and History screen, where you can update the tag/commodity code description.
Plate Number - Identifier for a steel plate.
Size 1 - Size 5 - Size 1 to size 5 of the ident.
Object Code - This field can be used to hold the relation to a CAD system.
Link BOM - This field specifies the Link Structure Element Name (node name) from the BOM.
Use the B.20.01.17 Link BOM screen from B.20.01 Edit BOM to allocate a bill of materials

74 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

(BOM) to the selected position. For example, a spare parts list can be linked to a position. With
this link, only the reference to this BOM is assigned to the position; the items in the spare parts
list are not copied.
If the position has a reference to a BOM assigned, you can use the B.20.01.18 Show
BOM-Link screen from B.20.01 Edit BOM to display the allocated BOM.
Created By - This field shows how this position was created. For example, B2003 means the
position was manually created on B.20.03, LOAD means the position was imported by B.40.01.
Ctrl - Control status.
Rev1/ Rev2 - Revision begin/revision end.
Req - Indicator to define if this position will be included in MTOs.
Reload - Indicator to define if this position can be updated by an OMI load via B.40.01.
Ident Nls/Commodity Code Layout Short - This field shows the description of the selected
ident, built by the m_pck_std_custom.ident_desc CIP.
Path - This field shows the entire path of the position’s WBS node.
At the bottom of the Single Bulk Material View tab, the Parent Position Tree appears on the
left. The sub positions of the selected position are listed in the Sub Positions block on the right.
To go back from a sub position to the parent position, right-click in the Pos field, and
select Back to Parent from the shortcut menu.

Position Values
The position attributes defined on B.10.04 or populated from the node attributes are displayed
on the Position Values tab on the right.

SmartPlant Materials E&PI(BOM) User's Guide 75


BOM Handling

The Attribute field shows the attribute with its attribute group in the Group field, a hint in
the Hint Text field and the unit in the Unit field, as it was defined on the A.50.01 Attributes
screen. The Manual check box specifies if this attribute value can be updated manually. If this
check box is checked, the attribute value will not be updated by attribute propagation, unless
the Allow Update indicator for this attribute is checked on A.50.01. The attribute value must be
entered in the Value field. If the attribute was defined with the Mandatory check box selected
on B.10.03 or on B.10.04, respectively, the field will be displayed with a green background color.
This color indicates that the attribute value must be entered. If the value is not entered before
leaving the field or saving the position, the message ‘MAG-00078: Value must be entered’
appears.
By default, the data in this block is sorted in ascending order by attribute group and attribute.
You can use the Order By… button to change the sort order. Select the field to be used for
sorting from the LOV and click OK. Repeat this if you want to use multiple fields for sorting;
otherwise, click Cancel. The sort order is displayed in the Ordered By field on top.
If the ZB_SPAS project default is set to N (default), all position attributes are displayed. If it is
set to Y, only attributes to which the user has access (controlled by the list view assigned to the
user securities or role) are shown.

Commodity Details
The commodity code properties are displayed on the Commodity Details tab for all item types
except TAB.

The Attribute field shows the commodity attribute table name, the Value field shows the table
detail (commodity code property), and the Description field shows the table detail description.

76 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

By default, the data in this block is sorted in ascending order by attribute. To change the sort
order, you can use the Order By… button. Select the field to be used for sorting from the LOV
and click OK. Repeat this if you want to use multiple fields for sorting; otherwise, click Cancel.
The sort order is displayed in the Ordered By field on top.

Ident Values
Instead of the Commodity Details tab, the Ident Values tab is displayed if the item type of the
position is TAB. All attributes assigned to the ident are displayed; the values can be entered or
updated.

The Attribute field shows the attribute with its attribute group in the Group field and the unit in
the Unit field, as it was defined on the A.50.01 Attributes screen. The attribute value must be
entered in the Value field.
By default, the data in this block is sorted in ascending order by attribute group and attribute. To
change the sort order, you can use the Order By… button. Select the field to be used for sorting
from the LOV and click OK. Repeat this if you want to use multiple fields for sorting; otherwise,
click Cancel. The sort order is displayed in the Ordered By field on top.
Double-click in the Value field to open the B.20.03.01 Ident History screen. For more
information, see Ident History (on page 85).

SmartPlant Materials E&PI(BOM) User's Guide 77


BOM Handling

Ident Property Values


The Ident Property Values tab displays the property values for the CMS idents being used in
BOM positions.

Sub Positions
A sub-position can include an assembly defined in the parts master. A hierarchical structure is
possible, and a depth of 14 levels of hierarchy sub-positions is allowed.
If the position has sub-positions, a plus-sign (+) is displayed next to the Pos field. The
sub-positions of a position are displayed in the Sub Positions block at the bottom, and they
cannot be updated. The parent position information is shown in the Parent Position Tree field.

Shortcut Menu
With a right mouse-click in the Pos, Spec Code, or Size 1 field of the single position view, you
can open the following shortcut menu.

The commands are described in Multi Position View (on page 63).

78 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Single Tag Material View


The Single Tag Material View tab fields are described below, ordered by their occurrence on
the screen.

Pos - Unique position number within the selected node. When you create a new BOM position,
the position number is set automatically, based on the ZB_LPSTART (first position number of a
node) and ZB_LP_INC (position number increment) project defaults. To add or edit sub
positions, right-click in the Pos field and select Add/Edit Sub Pos Nodes, or double-click in
the Pos field.
Tag Number - Identifier of a special part. Double-click in the field to open the S.80.25 Tag
Description and History screen, where you can update the tag/commodity code description.
Plate Number - Identifier for a steel plate.
Quantity - Ident quantity of the current position. If the ZB_QTY_NEG project default is set to Y,
negative quantities can be entered. If you create a position with a tag number (item type TWM or
TOM) and the ZB_TAGQTY project default is set to Y, the quantity must be set to 1.
Unit - Quantity unit, to be selected from the LOV. If a unit is assigned to the ZB_UNIT_ID project
default, this unit will be set by default when creating a new position.
Item Type - The LOV in this field shows the item types defined on A.10.15 Item Types.
If the ZB_PCKMAIN project default is set to Y and you select an item type with item rule
TWM, TOM, TFM, or REF (tagged item), you can create sub-positions with the same item type.

SmartPlant Materials E&PI(BOM) User's Guide 79


BOM Handling

Status - Issue status of this position, to be selected from the LOV. All issue statuses defined on
B.10.08, which are not excluded on Window 2 of B.10.08 with the No Display indicator selected,
are available for selection.
List Status - The release status to be edited must be given, or in the case of creation, entered.
If a list status is assigned to the ZB_LST_ID project default, this list status will be set
automatically when creating a new BOM position.
Created By - This field shows how this position was created. For example, B2003 means the
position was manually created on B.20.03, and LOAD means the position was imported by
B.40.01.
Group - Commodity group. You can use the LOV to select a pre-defined commodity group.
Double-click in the field to open the S.10.02 Commodity Group screen.
Part - Commodity part. You can use the LOV to select a pre-defined commodity part.
Double-click in the field to open the S.10.03 Commodity Part screen.
Commodity Code - Commodity code. Double-click in the field to open the S.30.01 Commodity
Codes screen.
Ident Code - Ident code. Double-click in the field to open the S.80.01 Ident Management
screen.
TSQ Required - This indicator is set by the software. It indicates if for the selected position a
TSQ (transfer site quantities) job must be performed, because the position has site quantities
(issue/reserved) in a lower issue status than the highest issue status of the position.
Resv%Sub Qty - Quantity reserved for this position by a forecast/reservation run. This quantity
is displayed for information only; it cannot be changed here.
Issued%Sub Qty - Quantity issued for this position with a MIR on site. This quantity is displayed
for information only; it cannot be changed here.
MLD Issue Qty - Quantity issued for this position with a MIR on site, with issue type 'Miss, Lost
or Damage'. When the quantity is shown in red, the material was issued for this position with a
different quantity unit. This quantity is displayed for information only; it cannot be changed here.
For more information about reserved quantity, issued quantity, and MLD issue quantity,
read the SmartPlant Materials Site User’s Guide, available on the Printable Guides page in the
software.
Path - This field shows the entire path of the position’s WBS node.
Parent Position Path - This field shows the parent position path information like /20, which
means that the selected position is a child of position 20 (one level up in the hierarchy). This is
the only indication of sub-positions in the Single Tag Material View.
Ident Nls/Commodity Code Layout Short - This field shows the description of the selected
ident, built by the m_pck_std_custom.ident_desc CIP.
At the bottom of the Single Tag Material View tab, the Parent Position Tree appears on the
left. The sub positions of the selected position are listed in the Sub Positions block on the right.
To go back from a sub position to the parent position, right-click in the Pos field, and
select Back to Parent from the shortcut menu.

80 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Ident Values
The Ident Values tab on the right displays all attributes assigned to the ident. The attribute
values can be entered or updated.

On the left, the ident values are represented in the form of a tree view. The attribute groups are
displayed as root nodes in this tree, with the attributes combined with their values (<Attribute> :
<Value>) as child nodes.
The Attribute field shows the attribute with its attribute group in the Group field and the unit in
the Unit field, as it was defined on the A.50.01 Attributes screen. The attribute value must be
entered in the Value field.
By default, the data in this block is sorted in ascending order by attribute group and attribute. To
change the sort order, you can use the Order By… button. Select the field to be used for sorting
from the LOV and click OK. Repeat this if you want to use multiple fields for sorting; otherwise,
click Cancel. The sort order is displayed in the Ordered By field on top.
Double-click in the Value field to open the B.20.03.01 Ident History screen. For more
information, see Ident History.

SmartPlant Materials E&PI(BOM) User's Guide 81


BOM Handling

Position Values
The position attributes defined on B.10.04 or populated from the node attributes are displayed
on the Position Values tab.

The Attribute field shows the attribute with its attribute group in the Group field, a hint in
the Hint Text field, and the unit in the Unit field, as it was defined on the A.50.01 Attributes
screen. The Manual check box specifies if this attribute value can be updated manually. If this
check box is checked, the attribute value will not be updated by attribute propagation, unless
the Allow Update indicator for this attribute is checked on A.50.01. The attribute value must be
entered in the Value field. If the attribute was defined with the Mandatory check box selected
on B.10.03 or on B.10.04, respectively, the field will be displayed with a green background color.
This color indicates that the attribute value must be entered. If the value is not entered when
leaving the field or saving the position, the message ‘MAG-00078: Value must be entered’
appears.
By default, the data in this block is sorted in ascending order by attribute group and attribute. To
change the sort order, you can use the Order By… button. Select the field to be used for sorting
from the LOV and click OK. Repeat this if you want to use multiple fields for sorting; otherwise,
click Cancel. The sort order is displayed in the Ordered By field on top.
If the project default ZB_SPAS is set to N (default), all position attributes are displayed. If it is set
to Y, only attributes to which the user has access authorization (controlled by the list view
assigned to the user securities or the role) are shown.

82 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Ident Property Values


The Ident Property Values tab displays the property values for the CMS idents being used in
BOM positions.

SmartPlant Materials E&PI(BOM) User's Guide 83


BOM Handling

Multi Status View


The Multi Status View tab can be used to display the positions grouped by issue status. The
tab is divided into three blocks. Each block will display positions with a particular issue status.
With the ZB_MSV_IS1, ZB_MSV_IS2, and ZB_MSV_IS3 project defaults, you define which
issue status is assigned to which block. If no value is assigned to any of the project defaults, the
corresponding block will not display any records.

In all blocks you can add, modify, and delete positions. The configuration set for the MPV (multi
position view) tab will also be used on this tab. All three blocks will have the same configuration.
The user can also set the configuration on any block and the configuration will be propagated to
the other two blocks and the MPV automatically. Similarly, other functions available on the MPV
tab like sorting, column width and spacing, document attachment, and so forth are also available
here.
For more information about the fields and various supported features, see Multi Position View
(on page 63).

84 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Ident History
To access the B.20.03.01 Ident History screen, double-click in the Value field on the Ident
Values tab on the Single Tag Materials tab. The Ident Values tab is displayed only for tagged
attribute based BOM positions. On the top of the screen, the selected ident with its ident code is
displayed.

Compare Idents
On the Compare Idents tab, you can compare the attribute values of the ident within a specified
period. Enter the start date and time of the period in the From Date and Time fields and the end
date and time in the To Date and Time fields. You can use the LOV in the From Date and To
Date fields. Then click the Compare button to display the ident attributes with their values at the
start date and their values at the end date. You can select the display option Show All
Attributes to view all assigned attributes, or select Show Changed Attributes to view only
attributes that have been changed within the preset period

The attributes are displayed with the group in the Attribute Group field and the attribute name
in the Attribute field. The attribute values at the beginning and at the end of the reference
period are shown in the Value as on … fields. If the attribute was not assigned to the ident at
the start or end date, ‘Attribute not found’ will be shown in the Value field. If the attribute value
was empty, ‘No Value Specified’ will be shown in the Value field.
Any comments assigned to the ident values can be displayed by double-clicking in the Value as
on … fields. This action opens a box showing the comment. Or when moving the cursor over
the Value field, a tool tip appears displaying the comment.

SmartPlant Materials E&PI(BOM) User's Guide 85


BOM Handling

Flashback Idents
On the Flashback Idents tab, you can view the attributes and values of an ident at a specific
date and time, as it was at that time. The flashback values are displayed together with the
current values, with the option to set the flashback values as the current values for the ident.

Enter the flashback date and time in the Date and Time fields. You can use the LOV in the Date
field. Then click the Flashback button to display the ident attributes with their values as they
were at the specified date and time.
The attributes are displayed with the group in the Attribute Group field and the attribute name
in the Attribute field. The attribute values at the specified date and time are shown in the Value
as on … field. The current attribute values are shown in the Current Value field. If the attribute
was not assigned to the ident, ‘Attribute not found’ will be shown in the Value field. If the
attribute value was empty, ‘No Value Specified’ will be shown in the Value field.
You can click the Set Current button to reset the attribute values to the flashback values,
displayed in the Value as on … field. Before changing the attribute values, a message appears
asking the user to confirm the action.
Any comments assigned to the ident values can be displayed by double-clicking in the Value as
on … fields. This action opens a box showing the comment. Or when moving the cursor over
the Value field, a tool tip appears displaying the comment.

86 SmartPlant Materials E&PI(BOM) User's Guide


BOM Handling

Ident History
The Ident History tab provides the utility of viewing all historical changes made to the ident
attribute values within a specified period. Enter the start date and time of the period in the From
Date and Time fields and the end date and time in the To Date and Time fields. You can use
the LOV in the From Date and To Date fields. Then click the Show History button to display
the ident attributes that have been changed during the specified period. The original value is
shown in the Attr Value field, the change date in the Mod. Date field, and the user who did the
change in the Modified By field.

Any comments assigned to the ident values can be displayed by double-clicking in the Value as
on … fields. This action opens a box showing the comment. Or when moving the cursor over
the Value field, a tool tip appears displaying the comment.

SmartPlant Materials E&PI(BOM) User's Guide 87


SECTION 3

BOM Utilities

BOM Import
You can import WBS and BOM data into SmartPlant Materials using the B.40.01 BOM Import
screen.

For more information about defining and running BOM import jobs, see the SmartPlant Materials
Open MTO Interface (OMI) documentation, available from the Printable Guides page in the
software.

SmartPlant Materials E&PI(BOM) User's Guide 89


BOM Utilities

BOM Datasets
The software will keep all historical data of each issue status of the BOM; however, it will not
keep the historical data of each list status. Therefore, BOM datasets can be used to store the
current BOM data, for example, to keep the BOM data for any of the list statuses with the same
issue status. Create a BOM dataset on the B.40.11 BOM Datasets screen.

To define a dataset job, enter the job name in the Job Code field and descriptions in the Short
Desc and Description fields. Select a pre-defined work package from the LOV in the Work
Package field. Select either the Best Quantity indicator or an issue status from the LOV in
the Status field. Then select a list status from the LOV in the List Status field. You can
select Issued By and Issued Date values from the LOV in the corresponding fields. Finally,
save the record.
To start the job, click the Create Dataset Online button. When the job is finished, the BOM data
is stored, the FINISHED status is displayed in the Status field and the fields in the Job
Execution Statistics section show the job information. Furthermore, the Create Dataset
buttons are disabled and the Drop Dataset buttons are enabled.

90 SmartPlant Materials E&PI(BOM) User's Guide


BOM Utilities

If you want to indicate that the BOM data is voided, you must select the user and date from the
LOV in the Voided By and Voided Date fields. This means that the BOM data will still be stored
but indicated with Voided By and Voided Date values.
If you want to delete the BOM data, you must select the user and date from the LOV in
the Removed By and Removed Date fields and save the record. Then click the Drop Dataset
Online button to delete the BOM data from the database.
There is no feature for viewing the stored BOM data. Therefore, the customer must develop a
report if he wants to view and print out the stored BOM data.

BOM Work Packages


A work package is a user-defined selection of BOM nodes and materials in which you can define
specific Where conditions for the ident and list position selection (scope of material). You can
define BOM work packages on the B.40.12 BOM Work Packages screen.

To create a new work package, enter the work package name in the Work Package field and
the descriptions in the Short Desc and Description fields.
The next fields can be used to assign Where conditions to the selected work package. For more
information about Where conditions, refer to the Where Conditions chapter in the SmartPlant
Materials Administrator‘s Guide, available from the Printable Guides page in the software.
In the Where Condition for Ident field, you can select a pre-defined Where condition from the
LOV. The LOV shows all Where conditions defined on A.60.06 for the ‘B4012_1’ module.
Double-click in the field to open the A.60.06 screen. With this Where condition, you can limit the
idents (material) to be selected from the BOM.
In the Where Condition for List Pos field, you can select a pre-defined Where condition from
the LOV. The LOV shows all Where conditions defined on A.60.06 for the ‘B4012_2’ module.
Double-click in the field to open the A.60.06 screen. With this Where condition, you can limit the
WBS nodes and BOM list positions to be selected from the BOM.

SmartPlant Materials E&PI(BOM) User's Guide 91


BOM Utilities

Select an attribute from the LOV in the Attribute field. All attributes defined on A.50.01 are
available for selection.
Next, select a value from the dropdown list in the Priority Type field. The available values are:
 ATTRIBUTE
 WORK PACKAGE
With the selection of the Locked indicator, you can lock a work package, which means that the
assigned Where conditions, BOM paths, and so forth cannot be changed.
Only users with the UNLOCK WORK PACKAGES privilege granted are allowed to reset
the Locked indicator of a work package.
Enter the user who is responsible for this work package in the Name field. By default, the logged
in user is entered when creating a new work package.
In the second (Work Package Details) block, you assign BOM list nodes to the selected work
package. To select the nodes in the WBS (Work Breakdown Structure), click the Nodes button
on the right at the top of the second block. This will open the BOM multi selection LOV displayed
below.

Select the Sel check boxes of the nodes to be added to the work package, and then click
the Fill In button to close the LOV and to add the selected nodes to the work package. You can
use the Select All button to select all displayed nodes in one step. To cancel a selection, click
the Unselect All button.
The sequence number in the Seq field will be filled automatically. This sequence number
defines the order in which the list positions will be processed. If necessary, adjust these
sequence numbers manually. The sequence numbers must be unique within a work package.

92 SmartPlant Materials E&PI(BOM) User's Guide


BOM Utilities

BOM Compare
The BOM Compare feature allows you to compare two BOM structures with the same or
different issue statuses (like Estimate and 1.MTO), or to compare two different issue statuses of
the same BOM structure.
As described in the section above, you must first define a work package, which specifies the
start node of the WBS, for the BOM positions to become part of the comparison. Then define the
compare structure on the B.40.21 BOM Compare Structures screen.

Enter the structure name in the Structure field and descriptions in the Short Desc
and Description fields. You can assign an ident subset Where condition as a sub condition for
all detail rows, by selecting a Where condition from the LOV in the Where Condition field. For
more information about Where conditions, refer to the Where Conditions chapter in
the SmartPlant Materials Administrator‘s Guide, available from the Printable Guides page in
the software.
Furthermore, you can assign a customizable function from the m_pck_bc_custom CIP package
by selecting it from the LOV in the CIP Name field. The LOV will only show functions if the spec
and body of the CIP package is valid and the functions are entered on A.60.37. To check the
available functions and their purpose, use the A.60.37 Customer CIPs/Forms/Reports screen.
Read more about CIPs in the SmartPlant Materials Customer-Installed Procedures (CIP)
document, available from the Printable Guides page in the software.
The assignment of a Where condition and CIP is optional.
In the second (BOM Compare Structure Details) block, you can define the criteria for the BOM
compare job. Enter a number in the Qty No field. This number is used in the Formula field to
refer to this record. For example, you have defined two work packages to compare two BOM
structures, the first with Qty No = 10 and the second with Qty No = 11. To get the quantity
differences, you must define the formula ‘#11 - #10’.
Next, select the column type from the dropdown list in the Column Type field. The available
values are:

Type Code Priority

Work Package W 1

Formula F 4

SmartPlant Materials E&PI(BOM) User's Guide 93


BOM Utilities

CIP Function C 2

Dispo D 3

Define the prompt for the BOM compare result quantity in the Prompt field. The prompt is
free-format and a maximum of 15 characters long.
The Best Qty indicator is only used for the types Work Package and CIP Function. Select this
indicator to compare the best quantity of the selected BOM structures. If the Best Qty check box
is not selected and the type is Work Package or CIP Function, select the issue status from the
LOV in the Issue Status field. Then select the list status from the LOV in the List Status field.
For the Work Package type, select a pre-defined work package from the LOV in the Work
Package field. For the CIP Function type, select a function from the LOV in the CIP Name field.
If the selected type is Formula, you must enter a formula in the Formula field. Valid parameters
are the Qty Nos defined for the selected structure, less than the Qty No of this formula row (the
Qty No used as a parameter must be less than the Qty No used for the formula). Use the Qty No
with a # in front. For example, the formula could be defined as ‘#11 - #10’. When you save your
formula, it will be checked. If the syntax is wrong, you see an error message. Select the Update
Formula Results indicator if you want to update the result quantities by changing the ident
substitution quantity on the B.40.23 BOM Compare Results screen.
If you have selected the Dispo type, you must select a disposition rule from the LOV in
the Dispo Rule field. Disposition rules are pre-defined on the R.10.22 Disposition Rules
screen.
The BOM compare jobs can be defined and run on the B.40.22 BOM Compare Jobs screen.

Enter the job name in the Job Code field and descriptions in the Short Desc and Description
fields. Select the pre-defined structure from the LOV in the Structure field. If the selected
structure contains at least one record of type Dispo, you must select a disposition rule set from
the LOV in the Dispo Rule Set field. Disposition rule sets are defined on the R.10.23
Disposition Rule Sets screen. Save the new job.

94 SmartPlant Materials E&PI(BOM) User's Guide


BOM Utilities

Click the Start Online button to launch the BOM compare job.

When the job is completed, you can click the View Online Log button to open A.60.72
displaying the log file of the job.
The results of a BOM compare job are displayed on the B.40.23 BOM Compare Results
screen.
The second (BOM Compare Results) block shows the results of the compare job selected in
the first block and the sum of substitution quantity for the combination of ident and unit. The
block is ordered by commodity code and the sizes. You can re-order the block by ident code if
you select the Sort by Ident Code check box.

The Select indicator is set by the m_pck_bc_custom.set_select CIP function. This CIP function
is called for each ident, so the Select indicator can be used to show if the CIP function has
processed/changed this record or not.

SmartPlant Materials E&PI(BOM) User's Guide 95


BOM Utilities

Click on the Quantities tab to display the quantities calculated by the compare job.

With a double-click in any field of the second (BOM Compare Results) block, you open
the B.40.24 BOM Compare Ident Trace screen.
In the first (BOM Compare Results) block, the information for the selected idents is displayed.
You can click on the Quantities tab to show the quantities calculated by the job.

In the second (BOM Compare Traces) block, the BOM positions are listed with the entire node
path in the BOM Path field, the position number in the List Pos field, and the quantity in
the Quantity field. The Source Type field shows which work package or CIP has found this
position.

96 SmartPlant Materials E&PI(BOM) User's Guide


BOM Utilities

In the third (Ident Substitution) block, you can further substitute quantities to another ident.
Select the ident to be substituted and enter the quantity you want to substitute in the Subst QTY
field.

Select the substitution ident from the LOV, either in the From Ident field or in the To Ident field.
Then click the Substitute button to create the substitution and to save it to the substitution table.
The result is displayed in the picture above.
If the ident was entered in the From Ident field, the entered substitution quantity will be added to
the (source) ident selected in the second block and subtracted from the substitution ident. These
quantities are stored in the substitution table for both idents.

Manually Lock BOM


A user can lock WBS nodes manually so that no other users can update the locked nodes and
the assigned BOM positions.
When you lock a node, it means the node and all the positions of the node can no longer be
modified by other users. In detail, they cannot:
 modify or delete the node
 add child nodes to the locked node
 modify the node properties
 modify the node attribute values
 add, modify, or delete BOM positions of the node
 modify the position values of the nodes’ BOM positions

SmartPlant Materials E&PI(BOM) User's Guide 97


BOM Utilities

WBS nodes and BOM positions can manually be locked on the B.40.31 Manually Lock BOM
screen.

The BOM Tree field on the left side of the screen shows the work breakdown structure (WBS) of
the login project and discipline. To display the next node level, click the + sign in front of the
node.
To lock a node from the WBS, select the node and open the right mouse-click menu.

98 SmartPlant Materials E&PI(BOM) User's Guide


BOM Utilities

Select Lock Selected Node from the menu to lock only the selected node. Or select Lock Sub
Tree to lock the selected node and all its sub-nodes. Window 2 will open to allow you to enter a
lock reason, define permissions, and select an issue status.

Enter the locking reason in the Reason field; this is a mandatory field. In the Permissions
section, you can define which particular actions will be allowed to modify BOM data although the
node is locked. The available options are listed below.
Select the Allow MTO indicator to allow MTO processes to modify the BOM data. Select
the Allow Forecast Run indicator to allow forecast runs to modify the BOM data. Select
the Allow Reservation Run indicator to allow reservation runs to modify the BOM data. Select
the Allow Other Site Activity indicator to allow other site activities to modify the BOM data. For
example, issuing material can update the BOM issue quantity. Select the Allow Split Tag
indicator to allow splitting tags to modify the BOM data.
In the Issue Status section, you define for which issue status(es) the node will be locked.
Select All to lock all issue statuses. Choose Selected and Lower and select an issue status
from the LOV in the adjacent field to lock the selected and all lower issue statuses.
Choose Selected and select an issue status from the LOV in the adjacent field to lock only the
selected issue status.
Finally, click the Continue button to perform the lock and to close window 2. The locked nodes
will be displayed in the BOM Lock Details section.

SmartPlant Materials E&PI(BOM) User's Guide 99


BOM Utilities

The BOM Lock Details section on the right displays all locked WBS nodes.

The Locked Node field shows the entire path of the locked node. The Sub-Tree field indicates if
just the selected node is locked (N) or if the selected node was locked with all sub-nodes. If the
node is locked with a particular issue status, this status is displayed in the Issue Status field. An
empty Issue Status field indicates that the selected node is locked for all issue statuses. The
user who locked the node is shown in the Lock User field. The date and time when the node
was locked is shown in the Lock Date field. The Reason field displays the remark entered by
the user when locking the node.
If the Allow MTO indicator is checked, any MTO can modify the locked BOM data. If the Allow
Forecast Run indicator is checked, any forecast run can modify the locked BOM data. If
the Allow Reservation Run indicator is checked, any reservation run can modify the locked
BOM data. If the Allow Other Site Activity indicator is checked, any other site activity can
modify the locked BOM data. Other site actions are, for example, the reservation or issue of
material. If the Allow Split Tag indicator is checked, it’s allowed to modify the locked BOM data
by splitting tags.
To remove a lock from a BOM node, select the locked node in the BOM Lock Details section
and click the Release button at the bottom of the screen. Locks can only be released by the
user who created the lock. This means the Release button is only enabled if the login user is
shown in the Lock User field. When a locked node is released, it will no longer be displayed in
the BOM Lock Details section. If a node was locked with its sub-nodes, releasing the node will
also release all of its sub-nodes.
Locked nodes are displayed on the B.20.03 Adv. Maintain BOM screen using a different folder
icon.

100 SmartPlant Materials E&PI(BOM) User's Guide


SECTION 4

Reports
A series of standard reports is available for the E&PI (BOM) module. For a detailed description
and purpose of each report, call the Report Document Library from the Help menu in
SmartPlant Materials. Below you can find a list of all BOM reports delivered with the software.
 B.30.R.01.01 Structure Summary
 B.30.R.01.02 Structure Evaluation
 B.30.R.02.01 Positions Summary
 B.30.R.02.02 Positions Evaluation
 B.30.R.02.04 BOM MTO/Line
 B.30.R.03 Piping
 B.30.R.04 Proof of Components
 B.30.R.04.01 Material Trace Version 1
 B.30.R.04.02 Material Trace Version 2
 B.30.R.06 Assemblies
 B.30.R.06.01 Assemblies Summary
 B.30.R.06.02 Assemblies Evaluation
 B.30.R.07 Status
 B.30.R.07.01 Revision Summary
 B.30.R.07.02 Material by Issue Status
 B.30.R.50 Standard
 B.30.R.50.29 Search Result
 B.30.R.50.35 List Status Job Result
 B.30.R.50.41 Verification Results
 B.40.R.01 BOM Import Protocol
For more information about how to run a report, read the Reports chapter in the SmartPlant
Materials User Interface Basics documentation, available from the Printable Guides page in the
software.

SmartPlant Materials E&PI(BOM) User's Guide 101


Reports

102 SmartPlant Materials E&PI(BOM) User's Guide


Index

A L
Add Child Node • 44 List Download • 50
Add Root Node • 43 List Status • 15
Advanced BOM Maintenance • 40
Attach Documents • 52 M
Manually Lock BOM • 97
B Multi Position View • 26, 63
BOM Compare • 93 Multi Status View • 84
BOM Datasets • 90
BOM Handling • 39 N
BOM Import • 89
BOM Position Views • 60 Node Properties and Attributes • 56
BOM Procedures/Macro • 49 Node Type Hierarchy • 23
BOM Procedures/Macros/Buttons • 30 Node Types and Settings • 18
BOM Rules • 29
BOM User Views • 28 P
BOM Utilities • 89 Populate from PLL • 48
BOM Views • 25 Position Attributes • 24
BOM Work Packages • 91 Preface • 7
Buttons • 60 Project Defaults • 9

C R
Copy BOM Setup • 9 Refresh • 49
Cut / Copy - Paste • 45 Reports • 101

D S
Delete Node • 45 Search • 58
Discipline BOM Views • 27 Setup • 9
Single Bulk Material View • 73
E Single Position View • 26
Edit BOM • 39 Single Tag Material View • 79
Edit BOM (Easy Entry) • 40
Expand All • 49 V
Verifications • 12
F
Fix Verification Routines • 13 W
Flat Configurations • 38 WBS Flat View • 52
WBS Tree View • 41
I
Ident History • 85
Issue Status • 16

SmartPlant Materials E&PI(BOM) User's Guide 103