SPMAT User Interface Basics

SmartPlant Materials
User Interface Basics
Version 2011 SP8 (7.0.8)
June 2010 / April 2013
DMAR1-PE-200030F-Updated
Copyright
Copyright © 2000-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
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this 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. 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.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes
the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, 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.
Contents
Preface .......................................................................................................................................................... 7
Documentation Comments ..................................................................................................................... 7
SmartPlant Materials Overview .................................................................................................................. 9
Log-on......................................................................................................................................................... 11
Menu ........................................................................................................................................................... 15
Main Menu ............................................................................................................................................ 16
File Menu ........................................................................................................................................ 16
Edit Menu ....................................................................................................................................... 17
Customer Menu .............................................................................................................................. 20
Window Menu ................................................................................................................................. 20
Help Menu ...................................................................................................................................... 21
Menu Tree ............................................................................................................................................. 22
Menu Tree Structure....................................................................................................................... 23
Tree View Toolbar .......................................................................................................................... 25
Search Functionality ....................................................................................................................... 26
My Menu ......................................................................................................................................... 26
Guided Tours .................................................................................................................................. 27
Screen Handling ........................................................................................................................................ 29

Screen Layout ....................................................................................................................................... 30
Screen Structure ................................................................................................................................... 31
Toolbar .................................................................................................................................................. 32
Print to File ............................................................................................................................................ 34
NLS Window ......................................................................................................................................... 37
Context Bar ........................................................................................................................................... 37
Status Bar ............................................................................................................................................. 38
Operation Modes................................................................................................................................... 38
Query Mode .................................................................................................................................... 38
Input Mode ...................................................................................................................................... 39
Editing Features Overview ............................................................................................................. 39
Editor Window ....................................................................................................................................... 40
List of Values......................................................................................................................................... 41
Query/Where Dialog Box ...................................................................................................................... 44
Case-Insensitive Query ......................................................................................................................... 47
Core Workflow Screens ............................................................................................................................ 49

Configurations ....................................................................................................................................... 49
Favorite Configuration ........................................................................................................................... 51
Pop-up Menu......................................................................................................................................... 52
Add field .......................................................................................................................................... 53
Set column spacing ........................................................................................................................ 55
Multi configuration .......................................................................................................................... 57
Order by this field … ....................................................................................................................... 58
SmartPlant Materials User Interface Basics 3

Contents
Remove field ................................................................................................................................... 58

Move to/Remove from scroll area .................................................................................................. 58
Populate … ..................................................................................................................................... 59
Global update ................................................................................................................................. 60
Drag and drop ....................................................................................................................................... 61
Order By ................................................................................................................................................ 62
Adding Basic Data ................................................................................................................................ 64
Valid Settings ............................................................................................................................................. 65

Project Defaults ..................................................................................................................................... 66
DBA Settings ......................................................................................................................................... 66
Privileges ............................................................................................................................................... 67
CIPs ...................................................................................................................................................... 67
VAs ........................................................................................................................................................ 68
Product Documentation ........................................................................................................................ 68
Reference Entries ................................................................................................................................. 69
SPRD Explorer ........................................................................................................................................... 71

Preselection .......................................................................................................................................... 73
Full Text Search .................................................................................................................................... 74
Fastcall .................................................................................................................................................. 76
Pop-up menus ....................................................................................................................................... 76
Ident Collection Cart ................................................................................................................................. 83

Define Ident Collection Carts ................................................................................................................ 85
Attached Attributes ................................................................................................................................... 89
Attachments ............................................................................................................................................... 91
Documents ............................................................................................................................................ 91
Text and Terms ..................................................................................................................................... 96
Vendor Data Requirements (VDRs)...................................................................................................... 99
Attributes ............................................................................................................................................. 103
Approval Sequences ............................................................................................................................... 109

Approval Sequence Screen ................................................................................................................ 109
Approvals, Privileges, and Settings .................................................................................................... 112
Online Help ............................................................................................................................................... 115

Navigation ........................................................................................................................................... 116
Search ................................................................................................................................................. 116
Printable Guides ...................................................................................................................................... 119
Reports ..................................................................................................................................................... 123

Generating a Report ........................................................................................................................... 123
Report Formatting ............................................................................................................................... 125
Report Document Library .................................................................................................................... 128
4 SmartPlant Materials User Interface Basics

Contents
Index ......................................................................................................................................................... 131

Contents

Preface
This document provides a working knowledge of the basic features and general screen handling
in SmartPlant Materials. It does not deliver insight into SmartPlant Materials or SmartPlant
Reference Data functionality or workflows.
The Core Workflow Screens (on page 49) section is intended for more experienced users.
To get more detailed information about a specific module or feature, read the online help or the
printable guides, both provided with the software.
Click the Help button on the toolbar of a screen for context-sensitive information about that
active SmartPlant Materials screen.
Click Help > Printable Guides on the main menu to display the list of guides. Each SmartPlant
Materials and SmartPlant Reference Data module has separate guides available.
Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
mailto:ppmdoc@intergraph.com?subject=documentation comments.

Preface

SECTION 1
SmartPlant Materials Overview

SmartPlant Materials is a materials management and administration software for process plants.
Its main applications are:
 Design, engineering, and construction of processing plants for the chemical,
pharmaceutical, and oil industries
 Industrial pipeline construction
 Power plant construction
 Ship design and assembly
SmartPlant Materials supports materials management for all disciplines, including piping (and
pipe supports), instrumentation, and structural steel equipment (such as vessels).
SmartPlant Materials provides continuous support for all processing stages of project
management. This support includes:
 Pre-project phase of parts and standards specification
 Design and financial planning
 Definition of material requirements
 Procurement and scheduling
 Pre-fabrication and installation
 Deadline and cost tracking
Database and Application

SmartPlant Materials consists of a database (tables) and an application (screens and lists).
Users interact with the database through the application screens (or forms). With the use of
these screens, the user can present and maintain the data stored in the database.
The database software organizes associated data in tables, consisting of rows and columns. A
row consists of several named columns (or fields), which together constitute a data record. A
record is a set of data stored in a database table. A column has a fixed data type and name. The
content or data of a column is displayed in a field on the screen.
SmartPlant Materials screens display database table contents structured according to the
function of the data. Each displayed data record shows a complete or partial row from the
associated table. Data from different tables are shown in separate blocks. Blocks are areas
within a screen, bordered by a frame. A block usually represents a database table. Changes
made in a block on a screen are saved in the corresponding database table.
SmartPlant Materials screens, menus, data fields, command line prompts, toolbars, and key
sequences make working in SmartPlant Materials easy for users.
The SQL database language can be used to access database tables from outside the
application for the purpose of obtaining information. It should never be used to modify data.
Definitions
Product Group - Corporate standards are defined on the product group level. Data defined in a
product group will be available in all projects created based on this product group. Product
group data is visible in projects, but the projects cannot change this data.

SmartPlant Materials Overview
Project - Project-specific material is defined at the project level. It is common for a project to
reference the product group as much as possible and only create project-specific material
definitions when the code cannot be included in the corporate standard. Data defined in a
project will not be available on the product group level or in any other project.
Discipline – Disciplines are used to separate materials into different project areas like Piping,
Electrical, and Structural.

SECTION 2
Log-on
1. Start Internet Explorer. If SmartPlant Materials is your default web page, the Logon screen
appears automatically. If it is not set up as your default, select it from your Favorites list, or
enter the web address into the entry field.
The Logon screen verifies user access privileges to SmartPlant Materials and to individual
SmartPlant Materials functions based on the user account and the role assigned to the user
account, set up by your System Administrator.
2. Enter your user name and password in the corresponding fields. Press ENTER or click OK.
The name of the database is displayed automatically in the Database field. Clicking the
Cancel button terminates the login and closes the Logon screen.
3. In SmartPlant Materials, you can work on the project or corporate (product group) level.
Select either Project or Product Group in the Working With field to get a list of available
project or product group log-ins assigned to your user account.
After you select Project in the Working With field, the lower block is shown on the Logon
screen. See the picture below. This block shows detailed information about the available login
credentials. You can see the project name and the description, the underlying product group, the
discipline, the login language, and the role assigned to your user account. The role controls the
access permissions for the modules, screens, and functions in SmartPlant Materials. The Last
Login field shows the date when you were last signed into the project.

Log-on
The right-hand fields on top show the details of the selected project/product group and the
version of your SmartPlant Materials application.
You can use the Help button to call the online help for the Logon screen.
The New User button will only be activated when DBA setting NEW_USER_BUTTON is set to
‘Y’, and when a valid user name and password are entered. Clicking the New User button
opens the A.60.01.01 Create User screen; here you can enter the details of a new user request.
When done, click the Submit button to send the request to the administrator.
To log in to the project (product group), either double-click the Project (Product Group) name or
any other field of the record, or select the Project (Product Group) you want to log in to and click
the OK button.

Log-on
If you select Product Group in the Working With box, the same fields are displayed except the
Project field is replaced by the Product Group field.
To re-logon from an active session, you can use the Set Project/Discipline button on the menu
toolbar when you want to log in to another project/discipline using the same role and user. For
more information, see Tree View Toolbar (on page 25). Or, click File > Change Login to open
the Logon screen again.
To end the SmartPlant Materials/Reference Data session, click the Log Off button on the menu
toolbar or click File > Exit, after closing all open screens.

Log-on

SECTION 3
Menu
The SmartPlant Materials main menu gives users access to the SmartPlant Materials features
and screens that they need to do their work. Main menu features include:
1. SmartPlant Materials menus, forms, and reports in a tree view
2. The tree menu toolbar
3. Guided tours list of user-defined tours, or workflows
4. My Menu for standard and user-defined forms, reports, and menus
5. Quick change of project and discipline with Set Project/Discipline
6. Installation Overview report
7. Session information identifying the user, role, Oracle database version, and the SmartPlant
Materials version
8. Search functionality
9. Context bar - For more information, see Screen Handling (on page 29).

Menu
Main Menu
At the top of the window, under the title bar, you’ll find the main menu with sub-menus File, Edit,
Customer Menu, Window, and Help.
File Menu
The File menu includes the following commands.
Command Shortcut Description

Close Closes the active screen.
Close all ALT+F4 Closes all open screens.

Save F10 Saves changes made in the active screen. Changes are stored
in the database.
Print Prints the active screen to the user’s default printer.
Refresh Re-displays the active screen.
Change Log In Displays the Logon screen for a user to log in with a different
user name to enable different access rights or to select a new
project/product group.
Exit ALT+F4 Logs the user out of SmartPlant Materials, and closes the
session.

Menu
Edit Menu
The Edit menu includes the following commands.

Cut CTRL+X Removes the selected data and places it in a paste buffer to
copy or paste.
Copy CTRL+C Copies the selected data from the input field of the screen to
the clipboard.
Paste CTRL+V Inserts data from clipboard to the input field of the screen at
the cursor position.
Clear Field Deletes the entry of the current field at the cursor position.
Duplicate Field F3 Copies the field entry of the record above the cursor into the
Above current field.
List of Values F9 Opens a new window, displaying the available values for
insert into the current field.
Edit Field CTRL+E Opens an editor window to allow editing of large amounts of
text.

Menu

NLS Description CTRL+SHIFT Opens the Translated Description window to allow
+PAGE multi-lingual capture of descriptions.
DOWN
Where Condition Displays the A.60.06 Query Condition screen, which allows
a user to change selection limitations. This screen displays
all available Where conditions defined for the calling screen.
This command is only active for screens/blocks having a
Where Condition field. Example: R.10.42 Req Split
Criteria
Ident Attributes Opens the A.60.14 Ident Attribute Values screen. The
command is only active in screens/blocks having the Ident
Code field, for example, R.30.01 Requisitions window 2.
New Record F6 Enters a new empty record underneath the current cursor
position.
Delete Record SHIFT+F6 Deletes the current record at the cursor position.
Clear Record SHIFT+F4 Hides the current record without deleting.
Duplicate F4 Only on new records, copies the record above the current
Record Above cursor position into the new record.
Clear Block SHIFT+F5 Clears all records of the current block, without deleting.
Clear All Clears all displayed data.
Query Opens a sub-menu with items.
Go To Opens a sub-menu with items.

Menu

Preferences Opens the User Preferences screen, which enables the
setup of menu call, buttons, and menu options.
 Enable buttons context sensitive: Toolbar buttons are

only active in context with the screen operation.
 Highlight queryable items: In query mode, the
queryable fields are displayed with a yellow background.
 Highlight required items: In input mode the mandatory
fields are displayed with a green background.
 Replace current window: The current window will be
closed when a new screen is opened.
 Tree menu orientated display: The screens are
positioned to the right of the menu tree.
You can also use the A.60.61 User Preferences screen to
set user preferences. For more information, see the User
Preferences chapter in the SmartPlant Materials
Administrator's Guide, available from the Printable Guides
page in the software.
Query sub-menu
Enter F7 Switches to enter query mode, allows entering a search
condition. You can use % and _ wildcards.
Run F8 Starts the query.
Cancel CTRL+Q Cancels the query.

Show Last F7 After switching to enter query mode using F7, the last
Criteria entered search criteria will be displayed using F7 again.
Count Matching SHIFT+F2 Counts the queried records and shows the result.
Records

Menu
Get More CTRL+SHIF Gets the next set of records.

Records T+PAGE
DOWN
Go To sub-menu
Next Field TAB Moves the cursor to the next field.
Previous Field SHIFT+TAB Moves the cursor to the previous field.
Next Record Arrow down Moves the cursor to the next record in the block.
Previous Record Arrow up Moves the cursor to the previous record in the block.
First Record Moves the cursor to the first queried record.
Last Record Moves the cursor to the last queried record.
Next Block CTRL+PAGE Moves the cursor to the next block.
DOWN
Previous Block CTRL+PAGE Moves the cursor to the previous block.
UP
Customer Menu
The Customer Menu may contain reports and screens defined and placed there by the
customer. SmartPlant Materials does not deliver any reports or screens on this menu.
Window Menu
The Window menu includes the following commands: Cascade, Tile Horizontally, Tile
Vertically, and a list of windows that are currently open. These commands operate the same as
standard Window commands to allow users to manipulate window placement.

Menu
Help Menu
The Help menu includes the following commands.

Printable Guides In-depth documentation for each module, including new features
for the release and workflow explanations.
Report Library of report descriptions and samples.
Document
Library
SmartPlant Opens the Intergraph SmartPlant Materials home page.
Homepage
Subscribe to Enables the user to sign up for the SmartPlant Materials
News newsletter.
Keyboard Help CTRL+F1 Opens a window with a list of keyboard function keys with its
assignment. The functions are listed in alphabetical order.
Record Info Displays detailed information about a selected record
Display Error SHIFT+F1 In case an error occurs, use this function to get more details
about the cause of the error.
Universal Dialog Use this dialog box to open screens instead of using the menu.
Enter the screen name like S1001 and press Enter.
About Opens the About window, displaying information about the
product such as version, license, and so forth.

Menu
Menu Tree
The menu tree view includes the SmartPlant Materials modules and other options listed in the
following section. The modules are listed in the order they appear in the menu. Use the tree
toolbar to expand and collapse items in the tree view. In the tree view, users can see and
access modules and options allowed by their login and role privileges.
SmartPlant Materials modules, screens, and reports have a consistent structure and numbering
scheme, which makes working easy and fast. Each screen and report has a unique number.
The majority of the screens and reports have three levels of numbering, followed by the screen
name. Several have a fourth level, when the topic range is sub-divided. The letter R between
level 2 and level 3 indicates a report.
The icons used in the tree menu are:

Submenu
Screen
Report

Menu
Menu Tree Structure

Administration Module for administration of the SmartPlant Materials database
application and maintenance of basic data.
The screen names start with the letter A.
SmartPlant Reference Data SmartPlant Reference Data provides materials libraries at the
corporate and project levels, and enables materials revision and
change management. The library enables corporate
(project-independent) material data standardization, especially of
bulk material. Data can be organized and reused according to
international (ANSI, ISO, DIN) or corporate standards.
The screen names start with the letter S, because of the former
module name Standardization.
At the bottom of the SmartPlant Reference Data menu branch, you
can find the submenus of the PDS, SmartPlant 3D, SmartPlant
Isometrics, SmartPlant P&ID, and PDMS interfaces.
E&PI (BOM) The Engineering & Procurement Integration (E&PI) module
E&PI (Req) presents the most recent status of any material item being used
within the project, allowing the elimination of surplus materials and
delays due to materials shortages. All engineering and design
quantities are stored, combined, and change-controlled in highly
flexible project structures and bills of material (history and
increments). Based on the client's knowledge and experience,
rule-driven processes automatically create material requisitions
according to the client's operating procedures, translating the
project engineering view into the project procurement view.
The names of the E&PI (BOM) screens start with the letter B, and
the E&PI (Req) screens start with the letter R.
MSCM The Material Supply Chain Management (MSCM) module
seamlessly integrates the interchange of data with commodity
suppliers, manufacturers, fabricators, and freight forwarders. It
synchronizes decentralized processes such as supplier
management, procurement, progress control, tracking and tracing,
and event management as well as supplier performance and
history management. All procurement and relevant supply chain
information is in the same database allowing paperless integration
of supplier performance and history measurement, supplier
management, inquiry cycle, bid tabulation, purchase order/award,
scheduling, progress/milestone control, and traffic/shipment.
The screen names start with the letter P, because of the former
module name Procurement. The Extended Traffic screen names
start with the letters PT.

Menu
Site The Site Management module is subdivided into Field Material

Control and Subcontract Management. Field Material Control
enables balancing of on-site personnel with material availability,
assigning material to site inventories. Material receiving,
forecasting, reservation, and allocation routines efficiently control
and manage materials in the various site warehouses. Availability
of all upstream and site inventory data enables sophisticated
planning and simulation.
The Field Material Control screen names start with the letter C,
because of the former module name Construction.
The Subcontract Management module enables managing
subcontracts on various levels. For example, an O/O company may
hire an EPC company. This company might then hire a
subcontractor for construction, and this subcontractor hires a
supplier company as a subcontractor. The Subcontract
Management screen names start with the letters SM.
Integrator SmartPlant Materials interfaces enable data to be fed into design
systems such as PDS or PDMS with relevant, standardized project
data, eliminating duplicated effort. SmartPlant Materials interfaces
with their leading applications include:
 Bulk Material Life Cycle Library with PDS, PDMS, SAP R/3
 Engineering & Procurement Integration with PDS and PDMS
You can find the SAP interface submenu under the Integrator
branch, and the others in the SmartPlant Reference Data submenu.
Others Utilities including Documentation, Graphics, Assessments,
Estimates, Accounting, Data Sheets, Work Progress, and Line List.
Guided Tours Displays a list of user-defined tours, or workflows. The form for
each tour, or workflow, shows a sequential list of screens and the
actions required for each one.
Discoverer This sub-menu includes a screen to handle the Discoverer.
Company Menu Can be used to create a company-specific menu tree containing all
company forms and reports. To use this company menu, you must
define an appropriate menu structure on A.30.01 Menus.
My Menu Displays a list of user-defined menus.

Menu
Tree View Toolbar

Use the Tree view toolbar to navigate and work with the modules and selections in the tree.
Button Meaning Description

Expand All Displays all levels of nodes in the tree underneath the
active/selected node.
Expand Displays one lower level of the active node.
Collapse Hides all levels of the active node.
Collapse Hides all levels of all nodes in the tree.

All
Edit Displays screen A.30.01 with the active menu item in it for
editing and updates.
Refresh Updates the tree display. Use it when changes are made on
screens A.30.01 or A.30.03.
Set Project Changes to a different project or discipline, using the current
/ Discipline role and user ID. A list will be displayed showing all available
projects/disciplines. Select a record from the list and click the
OK button (or double-click the record) to re-login to the
chosen project/discipline.
Log Off Ends the SmartPlant Materials session.
User Alerts Click this button to open the A.60.12 Early Warning Alerts
screen, which displays the alerts of the logged in user.
Installation Creates an overview report of your Oracle and SmartPlant
Overview Materials installation.

Menu
Online Help Opens the online help of the main menu.
Search Functionality
This block can be used to search for specific screens or reports in the menu tree.
Enter the screen name in the Search for field, without using any dots or blanks. For sample,
enter R3001 to search for R.30.01 Requisitions. Then click the Search button. The software
will find and highlight the occurrences of the text specified in the Search for field. Double-click
the menu item to open the screen.
To activate the advanced search criteria, select the More check box.
The selection of Options allows you to control the search direction, starting from the selected
node. The options Down, Up and All are available.
When Match Case is checked, the search will distinguish between uppercase and lowercase
characters.
When Whole Word is checked, only menu items that correspond exactly to the search string will
be found.
When Focus Tree is checked, the focus will move to the search result/menu item in the Menu
Tree. This allows you to open the screen by simply pressing Enter.
My Menu
Users can define their own menu under My Menu to collect the most used screens under one
node, with the benefit of quick access to these screens.
Click My Menu on the menu tree view. Right-click to open the menu and create your own user
menu.
Use the Add child menu, Add child form, and Add child report commands to create your
own user menu.

Menu
Example of a user-defined menu:
Right-clicking in any open screen shows a menu with the last five screens opened by the user in
the current session, and the top four items of My Menu and the Universal Dialog. All these
screens can be opened directly from that menu.
Guided Tours
The Guided Tours option displays a list of pre-defined workflows set up by your company for
users to follow. For example, the administrator might set up a guided tour named ‘New Project’,
which lists all affected screens in the order of the workflow, and the actions and to do list for
each one. The user could follow the workflow/guided tour to create a new project.

Menu
The graphic below shows an example of a Guided Tour named NEW_PROJ that shows how to
create a new project. Click Call to open a screen, and then complete the To do list for that
screen. Continue down the list calling each screen and completing its To do list until the guided
tour/workflow is completed.

SECTION 4
Screen Handling
To open a screen:
 Navigate through the menu tree and then double click-the menu item.
 Enter the screen code in the Search For field at the bottom of the menu tree. Then press
ENTER or click the Search button to navigate straight to the menu item. Now double-click
the menu item to open the screen.
 Select the Help > Universal Dialog command from the main menu to call the Universal
Dialog screen. Enter the screen code in the Module Name field and press ENTER.
To close a screen:
 Select File > Close or Close all from the main menu.
 Double-click the upper left corner or click the left corner and select Close from the menu.
 Click the X at the upper right corner.
 Use the function keys CTRL+F4.

Screen Handling
Screen Layout
The general layout of all Smart Plant Materials screens is consistent across the application. All
screens have a title bar, main menu, toolbar, and screen title at the top, and a context bar,
message bar, and status bar at the bottom.
Title bar Displays the project or product group and the name of the
database being used during the session, in addition to the version
of the SmartPlant Materials application.
Main menu Contains the menus File, Edit, Customer Menu, Window, and
Help.

Screen Handling
Toolbar Contains buttons to enter and modify data, navigate within the
screen, query data, and more.
Screen title Displays the screen number and name.
Context bar Displays the record owner, user name, project/product group,
discipline, and related information.
Message bar Displays processing messages, error messages, and instructions.
Status bar Displays the active mode (Enter Query or Input), the defined
values for the field, and information about the number of records in
a query.
Screen Structure
The screens are structured depending on the data model complexity of the underlying database
tables. Each block, which is an area within a screen and bordered by a frame, represents a
database table; each row in a block represents a record or set of data of the database table.
The fields on the screen show the particular values of a record.

Screen Handling
Toolbar
The main toolbar at the top of the screens provides buttons to navigate within the screen, and to
query, enter, modify, delete, print, and export data. Other buttons can be used to retrieve
information, like calling the online help, checking record info, and reviewing all relevant settings
of the active screen. Most of the commands of the toolbar are also available on the File and
Edit menus.
Button Function Function Key Description

Save F10 Saves record modifications.
Save and Saves record changes and moves to

Proceed the next record.
Print Screen Prints a snapshot of the active
SmartPlant Materials screen to the
default printer.
Print to File Prints the information in the displayed
SmartPlant Materials screen to a data
file in the default location.
Enter Query F7 Initiates Enter Query mode for a user to
set up a database query. Search
conditions entered in yellow fields
restrict the query result.
Run Query F8 Runs a database query after it is
defined with Enter Query and displays
the data in the SmartPlant Materials
screen
Cancel Query CTRL+Q Stops a query and changes from Enter
Query mode to Input mode. In Input
mode, users can insert records. Green
fields are mandatory and have to be
filled before you can save the record.
New Record F6 Adds (inserts) a new record underneath
the cursor position.
Delete Record SHIFT+F6 Deletes the selected record. If
dependent data exists, the user is
prompted to click the Delete Record
icon again to delete the data and all of
its dependent data.
Clear Record SHIFT+F4 Clears the current record at the cursor
position.
Go To Previous SHIFT+↑ Moves to the previous record of a block.
Record

Screen Handling

Go To Next SHIFT+ Moves to the next record of a block.
Record
Go To Previous CTRL+PAGE Moves to the previous block of the
Block UP screen.
Go To Next Block CTRL+PAGE Moves to the next block of the screen.
DOWN
List of Values F9 Displays the list of values (LOV)
(LOV) available for input into the current field.
Click a value to select it for the input
field. Click Cancel to dismiss the list
and not select a value.
Edit Field CTRL+E Opens a text editor window for
extensive text input into a field.
NLS Description SHIFT+CTRL+ Opens the Translated Descriptions
PAGE DOWN window for polyglot input. Click the
button a second time or close the
window to return to the previous block.
(NLS stands for National Language
Support.)
Record Displays detailed information about the
Information selected record.
Where Condition Displays the A.60.06 Query Condition
screen, which allows a user to change
selection limitations. It displays all
available Where conditions defined for
the calling screen. This command is
only active for screens having a Where
Condition field, for example, screen
R.10.42 Req Split Criteria.
Comments Allows you to add comments to the
current/active record. A green
background of the button indicates that
comments exist for the active record.
Valid Settings Opens the A.60.63 Valid Settings
screen, where you can display all
project settings relative to the active
SmartPlant Materials screen.
Reports Opens the A.30.06.01 Attached Menu
Reports screen with all reports
available for the active screen. All listed
reports can be started from this screen.
The button is only activated when
reports have been assigned to the
screen on A.30.06 Menu Settings on
the Menu Reports tab.

Screen Handling

Delete all records Deletes all displayed records in the
current block (that is, where the cursor
is placed).
Help Displays the SmartPlant Materials
online help for the current screen.
FASTCALL Displays a list of additional SmartPlant
Materials screens related to the active
task. Can be used to move to the
related screen without closing the active
screen.
Function keys that are not available on the toolbar:
 SHIFT+F1 show more detailed information in the case of an error.
 SHIFT+F2 counts the number of queried records of the active block at the cursor position.
 SHIFT+F3 shows the screen modifier information in the message line (timestamp, latest
change).
Print to File
As described in the Toolbar (on page 32) topic, the Print to File button allows you to store
data displayed on the screen in a file. When you click this button, a window opens where you
can specify how to store the data.
The Output File field displays the name of the output file with the entire path. The name is
automatically generated by the software and cannot be changed.
In the Export Format section, you specify how the text is formatted in the file. Select Excel if
you want to export the data into a semicolon separated Excel file. The other options will create
plain ASCII (txt) files, with a tabulator, a space, or any other specified character as a separator.
To align the columns, select the Column Align check box.

Screen Handling
Click the Select button in the Blocks to Write section to open the Select Blocks window.
Select the Select check boxes of all screen blocks to be exported to the file and click OK. You
can use the Select All button to mark all records in one step. Deselect All cancels the selection
and Cancel closes the screen without selecting any block.
You can specify the records to be stored in the file in the Records to Write section. Select
either All Records queried to export all queried records or All Records displayed to export
only the records currently displayed on the screen.
You can also specify the fields to be stored in the file in the Fields to Write section. With All
Items selected, the job will export all fields of the screen, whereas Displayed Items will export
the currently displayed fields only. With the Re-Importable indicator selected, the data will be
exported in a format that allows re-import into SmartPlant Materials.
Finally, click OK to start the export, or click Cancel to close the screen without exporting any
data.
On several screens, for example, S.20.02 Tablenames with Details or P.70.74 Packages,
it is also possible to import data using the Print to File button.

Select the Import tab and click the Browse button to upload the file to be imported.

Screen Handling
A browser window opens where you click the Browse button again.
Select a file and click Open. Next, click Submit Query to complete the upload operation.
The Upload Feedback message is shown.
Close the browser window to go back to the Print to File window.

In the Import Mode section, select the action to be allowed for the import. You can select
Insert, Update, and/or Delete with an optional Cascading option.
Further, you can select the type of error handling. Ignore Error will continue the import if an
error occurs, Stop on Error will stop the import in case of an error, but all data imported so far
will be stored in the database. Rollback on Error will cancel the entire import in case of an
error.
Finally, click OK to start the import, or click Cancel to close the screen without importing any
data.

Screen Handling
NLS Window
As described in the Toolbar (on page 32) topic, the NLS Description button opens the
Translated Descriptions window.
Here you can enter multilingual translations of the short description and the description of the
record from which this window was called.
To enter a description for a new language, select the language from the LOV in the Nls field. All
languages defined on A.10.01 Languages are available. Next, enter the translated descriptions
in the Short Desc and Description fields and save the new record using the Save button (F10).
The translated descriptions will be displayed on the screens depending on the login language.
Context Bar
The context bar is displayed in the footer of the SmartPlant Materials screens. The logon
parameters determine which information is displayed.
The context bar provides the following context-sensitive information, from left to right:
 Record owner, either product group or project. Indicates where the record was created.
 Name of the user who is logged in.
 Name of the active project or product group.
 Name of the active product group. When logged in with the product group, this field and the
previous field show the same information.
 Active discipline.
 Active standard.
 Active language. Multilingual descriptions (National Language Supported data description)
will be displayed corresponding to the login language.
 General information, like Revision OFF, UOM ON.

Screen Handling
Status Bar
The status bar is the last line at the bottom of a SmartPlant Materials screen.
It displays context-sensitive information about the session. The status bar contains the following
information, from left to right:
Status Description
Record x/y x indicates the number of the current record.
y indicates the total number of queried records. When ? is displayed instead
of a number, the queryable records are not yet counted due to the large
number of records. When you scroll to the last record, ? will change to the
total number.
Enter Query Indicates that the user is in Enter Query mode. On some screens, the Enter
Query mode allows users to enter a specific query again.
< List of Previously-defined list of values for the field. If there is no list of values for
Values> the field, this part of the status line is empty. (F9 and the LOV icon display
the list of values.)
Operation Modes
SmartPlant Materials screens have two operation modes: Enter Query and Input.
SmartPlant Materials validates all modified and new records before saving them to the
database. If the validation fails, the user must correct all records with errors and then try to save
them again. Therefore, it’s recommended to save records periodically to minimize the time
required to find record errors.
Data entered and updated on the screen is not available to other users until you save the
changes. As long as the changes are not saved, other users can access the old data. To
prevent editing and saving the same record by multiple users, the software allows only the first
commit. To make the second set of changes, you must retrieve the record from the database,
make the changes again, and then save.
Query Mode
Query mode allows you to browse and to display existing data, either all data or restricted by
means of the entered query conditions. Most screens open in query mode by default, ready for
the user to display existing data from the database, and visible with the yellow field background
color. Query mode is also shown in the status bar of the screen footer. You can change from
Query Mode to Input Mode by selecting Cancel Query or Run Query from the toolbar or using
the corresponding shortcuts.
In query mode, you can enter values or ranges as search criteria in the yellow fields to reduce
the search result. You can use the wildcards _ (underscore) as a placeholder for one character
and % (percent) as a placeholder for multiple characters. Then use the Run Query button on
the toolbar to retrieve the selected data.

Screen Handling
The example in the picture below uses both wildcards: _ and %.
Result of the query:
You can enter search criteria in multiple fields; the search will only retrieve records that meet all
of these criteria.
To repeat a query using the same search criteria again, use Enter Query or the F7 shortcut
twice to retrieve the previous query condition.
Input Mode
Input mode allows data manipulation such as inserting new records, updating existing data, or
deleting existing records from the database. In Input mode, the data you enter into the screen
fields is not stored in the database unless you save the changes using the Save button on the
toolbar, or by clicking File > Save to explicitly save the temporary data to the database.
While you are working on data in a screen, your input is checked for syntax and validity in terms
of required fields, value ranges, and data types. The data content is validated again before it is
saved to the database. This second verification includes checks for uniqueness of the new
records with regard to the key fields and for references to records with nonexistent data, such as
standardization data.
Screens that require immediate input or contain very little information are in the Input mode by
default. When these screens are opened, the software has already completed the database
query.
Editing Features Overview

The following table is an overview of the editing features for data input and querying screens.
Operation Action
Move the cursor left or right Press ← or → (left or right) arrow key.
Move the cursor up or down a Press ↑ or ↓ (up or down) arrow key.
line
Move the cursor to the end of Press the END key.
the input field

Screen Handling
Operation Action
Move the cursor to the first Press the HOME key.
position of the input field
Select text with the mouse Click on an input to select the entire field.
Click and drag the mouse to select text in a field.
Select text using the keyboard Move the cursor to the start of the desired text. Press the
Shift key while moving the cursor to the end of the desired
text, using the arrow keys ←, →, ↑, or ↓.
Delete selected text, or delete Press the DELETE key.
text on the right side of the
cursor position
Delete text on the left side of Press the BACKSPACE key.
the cursor position
Cut selected text. Select Edit > Cut from toolbar or press CTRL+X.
Copy selected text to the Select Edit > Copy from toolbar or press CTRL+C.
clipboard
Insert text from the clipboard Select Edit > Paste from toolbar or press CTRL+P.
Editor Window
When you need to enter a lot of text into an input field, use the Editor window to view the text.
There are three ways to open the Editor window:
 Click the Edit Field icon on the toolbar.

 Select the Edit > Edit Field command from the main menu.
 Press CTRL+E on the keyboard.

Screen Handling
The Editor window of the SmartPlant Materials screen opens for the user to edit the text.
Click Search to use the search and replace functionality of the Editor window. In the
Search/Replace window, you can enter a search string in the Search for field and click the
Search button to find occurrences of the string in the text. If you want to replace terms in a text
with other terms, type the string to be searched for in the Search for field, and type the string
that should replace the text in the Replace with field. Click the Replace or Replace All button
to change the text. The Cancel button closes the Search/Replace window.
Click OK in the Editor window to move the edited text to the input field, or click Cancel to close
the Editor window.
List of Values
Use the List of Values (LOV) to display the database values that are available for a field. Click
a value in the list to select it for the field, or click Cancel to dismiss the list.
Use Find to reduce the amount of the displayed data. In date fields, the List of Values displays a
calendar. Click a date to copy it into the input field.
The LOV is available for the most important input fields in most SmartPlant Materials screens.
The List of Values message in the status line and the active LOV button in the toolbar indicate

Screen Handling
an existing list of values for the input field. With the cursor in an input field, there are three ways
to call an LOV:
 Click the List of Values button on the toolbar.

 Select the Edit > List of Values command from the main menu.
 Press the F9 function key.

Screen Handling
For example, entering the string %NPS% in the Find field yields the result below. Be aware that
both columns of the LOV will be searched.
LOV Command Action

Limits the displayed list of values to the value entered in the Find
field. Use the wildcard _ (underscore) for a single character and %
(percent sign) for a multiple character placeholder.
Click a value from the list to select it as the active value. Clicking the
OK button copies the selected value into the input field and closes the
LOV window.
Exits the LOV window without selecting anything.
Scroll bar Moves the displayed list up or down in the window.

Double-click a Copies the selected value into the input field and closes the LOV
value window.
↑ and ↓ arrow keys Scroll through the displayed values to select one for input.

Screen Handling
Query/Where Dialog Box

Oracle Forms provides a feature called “Query/Where” that allows you to modify existing SQL
statements on the SmartPlant Materials screens. This feature is quite useful for power-users but
also potentially dangerous because any Forms user can execute any SQL statement. In
addition, you are not limited to the fields that are shown on the form itself.
Because of the potential danger of SQL injection, Oracle has turned off this functionality by
default. To enable the Query/Where feature, you must set the
FORMS_RESTRICT_ENTER_QUERY=FALSE in the default.env file and restart forms.
The use of this feature requires a detailed knowledge of the underlying database
structure and of the SQL query language.
You can use this Query/Where feature on each screen. Open the screen, and switch to query
mode using the Enter Query button. Now place a colon (:) or ampersand (&) character into
one of the fields, and click the Run Query button to execute the query.
The Query/Where dialog box opens as shown in the screenshot below.
Enter a valid where clause, and click the OK button to perform the query. Click Cancel to close
the dialog box without performing the query. After entering a where clause, you can use the
Search button to search and/or replace strings in the clause.

Screen Handling
For example, if you enter the where clause displayed in the picture below on the A.20.06.02
User Securities for Projects screen, the query retrieves all records with RS in the User field
and with a role assigned in the Role field that includes the ADMIN module.
If you have entered the colon (:) in the field, you can use the colon as a variable instead of the
column name. The picture below shows an example with variables (:A and :B) used in the
Company and Country Code fields.
The query condition in the next picture uses both variables.
Additionally, an order by statement was added to change the sort order of the displayed records.
The result is displayed in the picture below.
As with the ‘normal’ search, you can search for:

 empty fields (… is NULL)
 fields that are not empty (… is NOT NULL)
You can use logical operators like:
 < (less than)
 > (greater than)
 = (equal)

Screen Handling
 <= (less or equal)

 >= (greater or equal)
In text fields, you can use:
 LIKE - in connection with wildcards; for example: like ‘%tech%’ finds all values with the
string ‘tech’ somewhere in it.
 SUBSTR - to find values having a particular string at a specific place in the value; for
example: substr(company_code,1,3)=’111’ finds all companies starting with 111.
 INSTR - to find values having a particular string anywhere in it; for example:
instr(company_code,’111’)>0 finds all companies starting with 111.
If your SQL statement is not correct like ‘proj_id=RS’, Oracle returns the error ‘FRM-40505:
Oracle error: unable to perform query.’ as shown in the screenshot below.
You can obtain a detailed error message by clicking Help > Display Error or by pressing
SHIFT+F1.

Screen Handling
Case-Insensitive Query
The case-insensitive query feature allows you to search for text strings in the database,
regardless of whether upper- or lowercase characters are used. Using this feature, you can find
records that were entered incorrectly, for example, with uppercase instead of lowercase, or vice
versa, or a combination of uppercase and lowercase.
The DBA setting CASE_INSENSITIVE_QUERY controls the case sensitivity of the query
operation. If this DBA setting is set to Y, the query operation is executed in case-insensitive
mode. If this setting is set to N (default), the query operation is strictly case-sensitive, which
means you must enter exactly the same upper- and lowercase letters for the query condition as
used in the text strings you are looking for.
For more information about DBA settings, see the SmartPlant Materials DBA Settings
guide, available from the Printable Guides command in the software.
Switch to enter query mode using the Enter query button, click in the field that is used for
the query, and enter the search string into this field. If the case-insensitive mode is activated, it
does not matter if you enter the string in uppercase, in lowercase, or in mixed case.
For example, to query all tables on the S.20.02 Tablenames with Details screen that have a
group description with the substring ‘material’, ‘Material’, ‘MATERIAL’, or any other spelling
anywhere in the text, do the following: Open the S.20.02 screen, switch to enter query mode,
and enter the string '%material%' in the Description field, as displayed in the picture below.
Click the Run query button to execute the query. Any occurrences of the entered
substring will be found, for example, in ‘steel materials’:
or in ‘Material for PAS pipes’:

Screen Handling
or in ‘JACK_BOLT_MATERIAL’:

SECTION 5
Core Workflow Screens

This section is intended for experienced users or administrators. You must have adequate
knowledge of the SmartPlant Materials screens before changing their configuration.
The core workflow screens in SmartPlant Materials are configurable with regard to fields
(display, size, sort order, and distance). They are characterized by a set of features that are
described in detail in this section.
You can identify the core workflow screens by means of the Drag and Drop check box, the
Order By … button, the Ordered by field, and a few more features.
For example, the SmartPlant Materials screens listed below are core workflow screens.
 B.20.03 Adv. Maintain BOM
 D.90.21 Attachments
 P.20.01 Suppliers/Subcontractors
 P.30.01 Requisition Workload
 P.30.11 Inquiries
 P.50.01 Agreements
 P.50.07 Maintain Agreements
 P.70.71 Expediter Workload
 P.70.72 Expediting Details
 R.30.01 Maintain Requisitions
 S.50.06 Specification Management
 SM.20.01 Subcontractor Workload
Configurations
The multi-record display is freely configurable to a high degree. This includes not only the
number and order sequence of the fields but also their display width and the distance between
fields.
Please note that these features are only fully available if the No Config Change indicator has
not been set for the active role on the A.30.03 Roles/Menus screen.
When entering a screen, if no favorite configuration can be found, all available fields except for
attributes and CIP fields are displayed. If the offered design does not suit you, you can modify it
and thus create your own favorite configuration. Alternatively, you can select an existing
configuration from the dropdown list on the right on the toolbar.

The dropdown list to the right of the toolbar shows the configuration that is currently used for
displaying data. If no value is displayed when opening the screen, you have not selected any
configuration so far and all available fields are displayed. When you open the dropdown list by
clicking the , it shows the available configurations for the active screen. Selecting any
configuration from the list will change the screen layout according to this configuration.
If this dropdown list is empty, no configurations have been created so far for this screen. If any
configuration for the active screen is assigned to the role that you have used for the login, the
dropdown list is restricted to these configurations.
When changing the layout within this screen, this will create a new configuration and
automatically add this configuration to this list and set it as your new favorite. A complete
description of how to create a new configuration within this screen can be found in the help on
the screen level.
When double-clicking on this dropdown list field, the A.30.13 Configurations screen will be
called for the current configuration.
The fields that are displayed when the screen is opened and the fields that are available for
adding to a configuration depend on the use of configurations in your company. Configurations
can be assigned to user roles, but this is just an option. If any configurations have been
assigned to a role, the availability of fields is limited to the fields that are covered by these
configurations. If no configuration is assigned to the user’s role, all the fields of the screen are
available for the user.
This concept has been implemented to prevent any user from having access to sensitive
or confidential data such as prices or ratings.
To check whether the use of configurations has been restricted, you can use A.30.03
Roles/Menus or A.30.13 Configurations screen, Show Assignments button.
Please note that each time that you modify the current configuration by adding or (re)moving
fields or setting the column spacing or width, a new configuration is created and saved as your
favorite one. The current old configuration will not be changed because there might be other
users working with this configuration who do not want the modifications you are applying.
Instead of making the changes on the core workflow screen, you can use the A.30.13
Configurations screen to create and maintain the configurations.

Favorite Configuration
The software automatically stores the latest selected configuration for a screen as the favorite
configuration for the logged in user and the active project/discipline. Whenever the user opens a
screen, it opens with the user’s favorite configuration.
When a core workflow screen is opened, the software checks whether the current user has
already called this screen with the current role in the current project and discipline, and if he has
defined a favorite configuration. If so, this configuration will be used for displaying the fields.
If no favorite configuration can be found, the software checks whether it can find a favorite for
the current user, role and project, disregarding the discipline. If again no favorite can be found,
the software looks for a favorite in any project for the current user and role. If no favorite can be
found, all available fields apart from CIP fields will be displayed.
If the role prohibits the creation or change of configurations and exactly one configuration has
been assigned to the user's role, this configuration is automatically used and shown.
If a configuration has been marked as the default for this screen on A.30.03 Roles/Menus, this
one is used when no favorite configuration has been selected so far.
Example
The configuration DOE_001 assigned to the role on A.30.03 and marked as default is
automatically used on the P.20.01 screen. Furthermore, the list of available configurations is
restricted to the configurations assigned to the role.

Pop-up Menu
To change the screen layout, click in the field you want to modify and open the pop-up menu
with a right mouse-click.
This menu is available for each field. The displayed menu items depend on the kind of field the
cursor is positioned on. These items are available for all fields:
 Add field
 Set column spacing
 Multi configuration
 Order by this field ascending
 Order by this field descending
Any changes in the screen layout will automatically create a new configuration. The name of the
configuration is built with the user name followed by the _ character and a sequential number.

Add field
When you select Add field from the menu, a list of values appears that allows you to select one
of the fields that are available for this screen but are not displayed at the moment. After
selecting a field from the list, it is added to the screen and displayed next to the field where you
invoked the pop-up menu.

After selecting an attribute field from the list, window 5 will open to allow you to select an
attribute from the A.50.01 LOV to assign to the attribute field. To open the LOV, click the LOV
button on the toolbar or use the F9 function key.
After selecting the attribute from the LOV, click the Add Field button to add the attribute to the
configuration.
Double-clicking in the attribute field will open the A.50.21 Attached Attributes screen.

When you select a CIP field from the list, window 6 will open to allow you to select a function
from the M_PCK_CONFIG_CUSTOM package. To open the LOV, click the LOV button on the
toolbar or use the F9 function key.
After selecting the function from the LOV, click the Add Field button to add the CIP to the
configuration.
The field will display the result of the assigned function.
Set column spacing

The Set column spacing command controls the distance between individual fields. Setting the
column spacing to 0 (the default value) results in a look and feel like that from spreadsheets.

When you select Set column spacing from the menu list, window 7 will open to allow you to
enter a new value for the distance between the displayed screen fields. Click the Set Column
Spacing button to save the change and to show the screen with the new layout.
This is the result:

Multi configuration
The Multi configuration option allows you to compose a new configuration or update an
existing one by performing several steps at one time. You can add or remove fields from your
current configuration, change the display order, set the column spacing, and specify a name for
your new configuration. When you select the Multi configuration option, it will open the A.30.91
Multi Configuration screen.
You can compose your configuration for all configurable blocks of the calling screen, not only for
the block you were in when calling this screen.
Opening this screen may take some time depending on the number of blocks and fields
that are freely configurable. Also, selecting a field requires some time if the number of fields is
quite large. Please also keep in mind that due to an Oracle forms restriction the number of
records that can be displayed at a time is limited to 255. This means that in case of more than
255 configurable fields, you must set the focus on the last field displayed and it will automatically
fetch the next (up to) 255 fields. If you place the cursor on a field and more than 255 fields exist,
the field may be displayed as the first one although it is not really the first one; the others are
just not displayed.
For more details about Multi Configuration, refer to the online help of the A.30.91 Multi
Configurations screen.

Order by this field …

For the Order by this field ascending and Order by this field descending options, refer to
Order By (on page 62).
Remove field
Fields that are not mandatory for this screen can be removed from the configuration. The pop-up
menu of these fields contains the additional item Remove field.
Move to/Remove from scroll area

Fields that can be displayed either in the non-scrollable or in the scrollable area of a screen can
be moved from one area to the other by selecting Move to scroll area or Remove from scroll
area respectively from the pop-up menu.

Populate …
A few fields provide the Populate downwards command on the right-click menu to make
entering new data easier. This function will copy the value of the current field to all fields/records
underneath.
Screens with a matrix view like the Checklists tab on P.30.22 Commercial Evaluation
additionally provide the Populate sidewards and Populate downwards and sidewards
options. This allows you to copy the value of the current field to all appropriate fields to the side
and (when selecting downwards and sideways) to all records underneath.

This would be the result when selecting Populate downwards and sidewards in the example
above:
Global update
Another feature that helps with data input is Global update on the right-click menu. This
function will copy the value of the current field to all fields/records of the current block. Like
Populate downwards, this feature is only available for dedicated fields.

Drag and drop

To avoid a constant and unintended new design of the screen, the following two features are
only available if Drag and Drop has been marked.
To change the display width of a field, you set the focus on the field, press down the left mouse
button, keep it pressed, move the mouse to the right or the left depending on whether you want
to enlarge or to shorten the field, and let off the mouse button. To support this feature visually,
the cursor changes its display to a horizontal arrow with arrowheads on both sides if it is located
near the end of the field. This feature is available at any point within the field even if the cursor
layout is not changed.
To change the field display order, you can move fields. Set the focus on a field, press the left
mouse button, keep it pressed, move the mouse to the left beyond the limits of the current field,
and let off the mouse button. This shifts the current field behind the field where you have let off
the mouse button. Moving fields with drag and drop only works within the non-scrollable area or
within the scrollable area. To move an item from a non-scrollable to a scrollable area, or vice
versa, use the pop-up menu as described above. Moving fields with drag and drop does not
work with moving the mouse to the right. Thus, you can only enlarge the width of a field.

Order By
The core workflow screens allow you to adjust the order of the displayed records according to
the user’s preferences. Click the Order By … button to open a list of values window displaying
all the fields on the current screen. Select a field from the list to be the first sort key and click
OK. If you want to add more sort criteria, repeat these steps; otherwise, close the list by clicking
the Cancel button.

The new sort order will be displayed in the Ordered by field, and the data will be arranged
according to the defined sort order.
Another way to change the sort order of the displayed data is to right-click any field and then
select the Order by this field ascending or Order by this field descending options.

Adding Basic Data

Another feature of the core workflow screens is the direct input of basic data, which is usually
maintained on separate setup screens. On a core workflow screen, all fields with an available
LOV and where the values of the LOV have been defined on a setup screen provide this feature.
When entering new data in these fields, you can either use the LOV to select existing
pre-defined values from the list, or you can manually enter the value in the field. The software
checks whether the entered value was already defined on the setup screen or not. If it’s a new
value, a message appears: ‘You have entered an unknown value. Do you wish to continue?’.
When you click Yes and then save the record, the software will automatically add the new value
to the setup screen.
Your access rights given by the assigned role determine whether you are allowed to create new
values or just to select existing values from the LOV. If the role allows you to add new records
on the setup screen, you can also add the new values on the core workflow screen.

SECTION 6
Valid Settings
This section describes the valid settings in SmartPlant Materials, including project defaults, DBA
settings, privileges, and product documentation.
On each screen in SmartPlant Materials, you can check the valid settings that are relevant for
the particular screen. Use the Valid Settings button on the toolbar to call the Valid Settings
screen.
This screen shows all project defaults, DBA settings, privileges, CIPs, and visual attributes that
are assigned to the current form. In addition, all documentation associated with the form is listed
and can be directly accessed from this screen. Finally, the related reference entries (release
notes) are displayed to give you a quick overview of all changes relevant for this module.
All these settings are usually done by the administrator. The user will just have read-only access
to the valid settings screen.
The meaning of the project defaults, DBA settings, privileges, CIPs, and visual attributes is
described in detail in the corresponding documentation. For a basic understanding, find a brief
statement below.
Project Defaults - In many areas of SmartPlant Materials, the workflows and the software
behavior are controlled by parameter defaults for projects. These settings are project-specific
and do not impact other projects.
DBA Settings - These are global settings and preferences that control the general behavior and
processing of SmartPlant Materials, independent of the login project or product group.
Privileges - Certain actions in SmartPlant Materials require a granted privilege to allow users to
perform these actions. For example, approval of a requisition can only be done by users with the
privilege ER approval granted.
CIPs - Customer-installed procedures or functions provided with custom packages. CIPs can be
customized to integrate your own logic for specific procedures. This requires consolidated
knowledge of the corresponding SmartPlant Materials functionality and programming skills.
VAs - Visual attributes can be defined to visualize the change of values/conditions by
highlighting fields with a colored background.

Valid Settings
Project Defaults
The Project Defaults tab lists the project defaults that are relevant for the screen from which it
is called, with their description, settings, value description, and default value.
If you have the permission to enter or change project defaults on A.20.12/.13, you can update
these values here on A.60.63 as well.
When this screen is called, it shows the current settings of the project defaults. Double-clicking
the value or using the LOV icon or F9 opens the List of Values, wherever available. When a
value is changed and the A.60.63 screen is closed, you are prompted to specify if changes
should be made for the project or discipline. To be sure that the changes are in effect, the
screen from which A.60.63 was called must be closed and re-opened.
DBA Settings
The DBA Settings tab shows all DBA settings that are relevant for the screen from which it was
called, with their setting values.
Users who are authorized to change the DBA settings on A.60.04 can update these values here
on A.60.63 as well.

Valid Settings
Privileges
The Privileges tab shows all privileges used in the current form and whether they are assigned
to the logged in user.
Only users who are allowed to grant and revoke privileges can directly change the assignments
here on the Valid Settings screen as well.
CIPs
The CIPs tab shows all custom packages assigned to the module. The functions and
procedures can be used for customizations, which means that you can implement your own
logic. This is a read-only folder, the data cannot be changed.

Valid Settings
VAs
The VAs tab shows the visual attribute rules that are defined for the current form on A.30.14.
The displayed rules will only be active when project default ZX_VISUAL is set to Yes. This is a
read-only folder; the data cannot be changed.
Product Documentation
The Product Documentation tab provides a list of all documents that are related to the current
form. The listed documents are either part of the Printable Guides or were released with an
enhancement of the screen as part of a service pack.
The title of the document is displayed in the Comment field and the file name in the Document
Name field.
The Document Type field indicates if the document is from the Printable Guides page or if the
document was released with a service pack.
You can open a document listed on this screen by simply double-clicking the document name.

Valid Settings
Reference Entries
All release notes of the most recent and previous service packs, and relevant for the form, are
listed on the Reference Entries tab. The records are sorted by version, with the most recent on
top. The release note itself can be read in the Comments field. You can use the Type or
Version field to search for the release notes of a specific version or type, such as all change
requests.
If a document was provided with the release note, you can open it by double-clicking in the
Document Name field.

Valid Settings

SECTION 7
SPRD Explorer
You can use the SPRD Explorer screen to browse your reference data and to search for groups,
parts, commodity codes, and idents, using filter criteria for group, part, commodity code
properties (table name, group, details), and commodity codes. From the SPRD Explorer, you
can access the main functions for creating, updating, and deleting relevant data in this range of
topics.
For use in downstream modules, the SPRD Explorer provides the ident collection cart (ICC), a
simple and user-friendly method of collecting pre-defined material in a cart. This cart can then
be used in downstream modules to populate, for example, bill of materials, requisitions, and
agreements.
You can open the SPRD Explorer directly from the SmartPlant Reference Data > SPRD
Explorer menu branch. Or, you click the SPRD Explorer button on any of the screens listed
below.
 B.20.03 Advanced Maintain BOM in the E&PI (BOM) module
 R.30.01 Requisitions in the E&PI(Req) module
 P.50.07 Maintain Agreements in the MSCM module
 C.20.03 Prepare MRR by Direct Receive in the Site module
 AS.10.02 Price Data in the Assessments module
 E.10.02 Estimations in the Estimations module

SPRD Explorer
The hierarchical tree displays commodity groups, commodity parts, commodity codes, and
idents, as well as ident values and attribute groups in their hierarchical structure. The legend on
the right shows the symbols used in the tree.
The first level displays all existing commodity groups that are available for the current login,
including all assigned queryable disciplines. Expanding the nodes of the first level, you will find
all existing commodity parts for the selected group at the second level. The third level shows all
existing commodity codes for the selected part. Level four shows the available idents for a
selected commodity code.
If applicable, the attribute groups are displayed at level five and the attributes at level six. Both
levels five and six do not have any special functionality such as double-clicking or a right
mouse-click menu to open assigned screens.
The picture below shows an example of the tree structure with all levels expanded.
The sort order of the SPRD Explorer tree is controlled by the project default ZS_RD_SORT.
 If ZS_RD_SORT is set to B (default), the tree will be sorted by commodity group, commodity
part, commodity code, and ident code.

SPRD Explorer
 If ZS_RD_SORT is set to D, the tree will be sorted by discipline and within the discipline by
commodity group, commodity part, commodity code, and ident code. With ZS_RD_SORT
set to D, the discipline of a group is displayed in brackets behind the short description of the
commodity groups.
In the top right-hand corner of the screen you can find buttons to be used with the tree. Click the
Refresh Tree button after you have updated or deleted data. Using this button also
shows all available data again after you have performed a search that restricted the displayed
items.
Click the button to collapse the selected node and the button to expand the
selected node.
Preselection
The fields in the Preselection area on top can be used to restrict the displayed data in the tree.
Without defining any preselection criteria, the tree shows all available data.
All the fields in the Preselection block allow you to use the LOV to select a value, or insert
search criteria manually using the wildcards % (percent, placeholder for multiple characters) or _
(underscore, placeholder for one character) combined with strings.

SPRD Explorer
Example
‘Pip%’ will result in Pipe, Piping, Pipeline, etc. whereas ‘Pip_’ will fetch only Pipe. The table
below lists the available list of values in the preselection fields.
Field LOV source

CC Group S.10.02 Commodity Groups
Part S.10.03 Commodity Parts
Preselection of a commodity group will restrict the available
list of values.
Tablename A.50.02 Tables (all tables of type COMMATTR)
Preselection of a commodity group and/or part will restrict
the available list of values.
Group S.20.01 Table Groups
Preselection of a tablename will restrict the available list of
values.
Detail S.20.02 Table Details
Preselection of a tablename and/or table group will restrict
Commodity Code S.30.01 Commodity Codes
Preselection of a commodity group and/or part will restrict
If you enter a filter criterion in any of the fields, it will restrict the available values of the levels
underneath. For example, if you enter a tablename, only table groups and details of this table
are available for selection in the Group and Detail fields.
You can use the button to cancel your inputs and clear the fields. The
button cancels all current preselections and clears the fields. Click the
button apply the filter criteria you have defined. Only data in the tree that
matches the preselection restrictions will be displayed.
Full Text Search

For further restriction of the data displayed in the tree, you can use the fields in the Full Text
Search area.In connection with pre-defined filter criteria in the Preselection block, any string
entered in the Search Text field will further restrict the displayed data in the tree. Without a
preselection, the full text search will be performed on the basis of all available idents.
With the Include options, you can define on which level the search will be performed; multiple
selection is possible.

SPRD Explorer
The Display Option dropdown controls how the search result is displayed in the tree. The
selected option defines which level will be displayed as the top level; available options are
group, part, commodity code, and ident.
With the Search Options, you can specify how the text in the Search Text field is used. The
available options are:
 Start With - searches for items that begin with the exact phrase specified in the Search
Text field
 Containing - searches for items that contain all words in the exact order as specified in the
Search Text field
 Full Text - searches for items that exactly match the phrase specified in the Search Text
field
Type your search criterion into the Search Text field and click the button
to apply the filter. Window 2 opens, showing the search result.
You can further restrict the displayed items by using the Enter Query button (F7), entering a
query condition (wildcards are allowed), and clicking the Exe Query button (F8). Finally, click
the button to apply this search result to the tree view.

The Ident Collection Cart section is described in the Define Ident Collection Carts (on
page 85) topic.

SPRD Explorer
Fastcall
If the cursor is positioned on any node in the tree, you can use the Fastcall menu to open
associated screens. For example, if you have selected a commodity group, you can call the
S.10.02 Commodity Group and the S.10.03 Commodity Part screens.
The associated screens can only be opened when access is granted by the user role.
Pop-up menus
You can open a pop-up menu with a right mouse-click on a node in the tree. The available items
on the menu are context sensitive, depending on the node level.
Group level

SPRD Explorer
Double-click the group level node or select the first pop-up menu item to open window 5
displaying all commodity group relevant data.
From the right mouse-click menu on the group level, you can directly access the S.10.02
Commodity Groups screen, S.10.03 Commodity Parts screen, and SP3D.30.01 Commodity
Mappings screen.
Part level

SPRD Explorer
Double-click the part level node or select the first pop-up menu item to open window 6
displaying all commodity part relevant data.
From the right mouse-click menu on the part level, you can directly access the S.10.03
Commodity Parts screen, S.30.01 Commodity Codes screen, and SP3D.30.01 Commodity
Mappings screen.

SPRD Explorer
Commodity Code level
Double-click the commodity code level node or select the first pop-up menu item to open
window 7 displaying all commodity code relevant data.
From the right mouse-click menu on the commodity code level, you can directly access the
S.30.01 Commodity Codes screen, S.30.04 Delete Commodity Codes screen, S.80.01 Ident
Management screen, SP3D.30.01 Commodity Mappings screen, SP3D.30.03 Ident

SPRD Explorer
Mappings screen, S.30.21 Commodity Code Usage screen, and the SPRD Explorer window
12 Show Specifications.
Ident level
Double-click the ident level node or select the first pop-up menu item to open window 8
displaying all ident relevant data.

SPRD Explorer
From the right mouse-click menu on the ident level, you can directly access the S.80.01 Ident
Management screen, SP3D.30.01 Commodity Mappings screen, and the SPRD Explorer
window 12 Show Specifications.

SECTION 8
Ident Collection Cart

You can define an Ident Collection Cart (ICC) to collect a set of materials. This ICC can be used
to fill in the collected materials, for example, into a requisition, in one step.
This feature is used to collect a set of materials (idents), place them on a shopping list, and save
the set as a named Ident Collection Cart (ICC). This named ICC will then be available in the
SmartPlant Materials modules to be used to fill in the collected materials in one step. The
screens where you can find the Populate Cart Idents and SPRD Explorer buttons to create
and populate ICCs are listed below.
 B.20.03 Advanced Maintain BOM screen in the E&PI (BOM) module to populate materials
into a BOM to create BOM positions.
 R.30.01 Requisitions screen in the E&PI(Req) module to populate materials into a
requisition to create requisition line items.
 P.50.07 Maintain Agreements screen in the MSCM module to populate materials into an
agreement to create agreement line items.
 C.20.03 Prepare MRR by Direct Receive screen in the Site module to populate materials
into a material receiving report (MRR) to create inventory receipts.
 AS.10.02 Price Data screen in the Assessments module to populate materials into a price
type to create price data.
 E.10.02 Estimations screen in the Estimations module to populate materials into an
estimation base to create estimations.
To create an ICC, use the SPRD Explorer button from any of these screens or open the SPRD
Explorer screen, or open it directly from the SmartPlant Reference Data > SPRD Explorer
menu branch. The SPRD Explorer screen opens, allowing you to collect material and to create
an ICC. For more information about the Ident Collection Cart feature in the SPRD Explorer, see
Define Ident Collection Carts (on page 85).

Example
The screenshot below shows an example of an ICC with six collected idents.
After completing the ICC, close the SPRD Explorer to go back to the calling screen, for example,
R.30.01 as shown in the picture below. On this screen, a list of all available ICCs is displayed so
that you can select one of these carts. This LOV is also displayed when you click the Populate
Cart Idents button.

After selecting the ICC from the list, click OK. The LOV closes, and the software populates the
contents of the selected ICC to the document (BOM, requisition, agreement, and so forth) from
which you have called this function. The result is shown in the picture below.
Any pre-defined ICC can be populated immediately without calling the SPRD Explorer.
Click the Populate Cart Idents button to open the LOV and select one of the available ICCs
from the list. Then click OK to populate the selected ICC.
Define Ident Collection Carts

As mentioned in Ident Collection Cart (on page 83), you can define ICCs using the SPRD
Explorer, which can either be opened using the SPRD Explorer button on any of the screens
listed in Ident Collection Cart (on page 83) or from the SmartPlant Reference Data > SPRD
Explorer menu branch.
The picture below displays the SPRD Explorer screen with the highlighted Ident Collection
Cart section.
To delete the content of the temporary Ident Collection Cart, use the button.

To add an ident to the temporary Ident Collection Cart, either use the button, or open the
menu on the tree with a right mouse-click on an ident and select the option Put selected ident
into ICC.
To view the content of the temporary Ident Collection Cart, use the button to open
window 10, which displays the current ICC with all selected idents.

Maintaining Ident Collection Cart
Click the button to maintain the Ident Collection Cart. Window 11 opens, as
shown in the picture below.
Use the Named ICC field to enter the ICC name or select an existing ICC name from the LOV.
The Number of Idents field shows how many idents are currently in the selected ICC.
Select an existing named ICC in the Named ICC field, and then click the
button to delete the selected ICC.
Select an existing named ICC in the Named ICC field, then click the button to
view the contents of the selected ICC. Window 10 opens, and displays all idents in the ICC.
Enter the name for a new ICC in the Named ICC field and click the
button to create the ICC. When the ICC is created, a

message appears.
Select the name of an existing ICC from the LOV in the Named ICC field and click the
button to add the items of the temporary ICC to the selected

named ICC. When the items are added, a message appears.
button to replace the contents of the selected ICC with the

items of the temporary ICC. When the ICC is updated, a message appears.
button to copy the content of the named ICC to the

temporary cart. The temporary cart will be cleared before copying the idents.

button to copy the contents of the named ICC to the

temporary cart. The new idents will be added to the temporary cart without deleting its content.
To close the ICC Admin Menu (window 11), click the button.

SECTION 9
Attached Attributes
Attributes can be assigned on either the header or on the line item level to objects such as
requisitions, inquiries, agreements, and so forth. Attached attributes are maintained on the
A.50.21 Attached Attributes or D.90.21 Attachments screens. A.50.21 can only be opened
via fastcall or by using the Attributes button from any other screen.
The design and functionality of this screen is identical to the Attachments tab of the D.90.21
Attachments screen. For the field descriptions, see Attributes (on page 103).

Attached Attributes

SECTION 10
Attachments
The D.90.21 Attachments screen is used for attaching documents, text and terms, VDRs, and
attributes to objects such as requisitions, inquiries, agreements, insurance certificates, change
order requests, and so forth. You can open this screen by clicking the Attachments button on
screens dealing with objects for which documents, text and terms, VDRs, or attributes are
available. The tabs on the D.90.21 screen that are actually available depends on the object for
which this screen has been called. On D.90.21, you can only view and maintain the attachments
of the object that was selected when you opened this screen.
The D.90.21 screen is a core workflow screen. For more information, see Core Workflow
Screens (on page 49).
In the first block of the D.90.21 screen, some information is shown about the object for which
you have called this screen. The picture below shows an example of a requisition. D.90.21 was
opened from the R.30.01 Maintain Requisitions screen.
You can open any of the tabs below this first block to maintain the following:
 Attached documents
 Attached text and terms
 Attached vendor data requirements (VDRs)
 Attached attributes
Documents
On the Documents tab, you can see all documents that have been attached to the selected
object. A document can only be assigned once to an object. You cannot attach the same
document with different revisions.
Documents can only be attached to an object as long as this object is not approved. After
approval, no more changes can be applied. Therefore, the screen is opened in query-only mode
once the object has been approved.
If the project default ZR_UPD_DOC is set to Y, you can insert or delete attached documents on
requisitions or requisition line items that are already approved or released to procurement.
These modifications can only be done if no higher supplements exist for the requisition or the
requisition line item, and if the attached document does not have VDRs attached.
Changes to the attached documents of a requisition or requisition line item will increase the MR
revision of the requisition.

Attachments
You can use a document as a document package and attach vendor data requirements (VDRs)
to this package.
With the radio group on top of the tab, you can control whether data on the Documents tab is
displayed independently from the data on the VDRs tab.
If the Only Documents option (default) is selected, data is shown independently from each
other; that is, if you assign a document to an object and a VDR to this document, this VDR will
not be displayed on the VDRs tab. And vice versa, if you assign a VDR to an object and a
document to this VDR, this document will not be displayed here on the Documents tab.
If you select the Include VDR Documents option, VDRs attached to documents will be
displayed on both tabs, and vice versa, documents assigned to a VDR on the VDRs tab will also
be displayed on the Documents tab.
If the Document Code field is displayed with a cyan background color, VDRs are attached to
this document (package). If the Document Code field is displayed with a magenta background
color, the document is assigned to a VDR on the VDRs tab.
In Include VDR Documents mode, you cannot attach VDRs to documents on the
Documents tab.
The Ordered by field shows by which fields the displayed records are sorted. By default, the
records are ordered by sequence. To change the order criteria, you can click the Order By ...
button at the bottom of the screen. Or, you can open the pop-up menu with a right mouse-click
in any field and select the Order by this field ascending or Order by this field descending
menu items.

Attachments
To insert a document, enter a sequence number in the Seq field and the document name in the
Document Code field. When you enter a document name that is not yet defined on D.10.11, the
name will automatically be inserted on D.10.11.To select a pre-defined document from the list,
open the LOV in the Seq or Document Code fields. The LOV shows all documents defined on
the D.10.11 Documents screen and not yet attached on D.90.21.
Select the Sel check box of all documents to be attached. You can use the Select All button to
select all displayed documents. Deselect All cancels the current selection. Finally, click the Fill
In button to attach all selected documents and to close this LOV window.
Back on the main window of D.90.21, you can double-click in the Document Code field to open
the D.10.11 Documents screen where documents are defined.
The Highest Rev check box indicates if the highest revision of this document is attached. If this
check box is not marked, a higher revision of this document is available.
The document revision is displayed in the Rev field. When creating new documents, the default
revision value depends on the setting of project default ZX_DO_ORD. If the project default is set
to N (numbers), the default revision is 0 (zero). If the project default is set to L (letters), the
default revision is A.
Numerical revisions are regarded as being newer/higher than alphanumeric revisions.
For example, alphanumeric revisions (A, B, C, ...) are used in the design phase, and numeric
revisions (0, 1, 2, ...) are used in the construction phase.
The Doc Changed check box indicates if the document has changed compared to the previous
supplement. If a previous supplement (of the requisition, inquiry, agreement) exists, the check
box is marked if any change has been applied to the document. This means that either the
document revision has changed or that any change has been applied to the VDRs of a
document. The check box is also marked if the document was added on a supplement greater
than 0 (zero).
The SmartPlant check box indicates if this document was retrieved from SmartPlant Integration.

Attachments
The document version coming from SmartPlant is displayed in the Version field.
The SmartPlant Rev field shows the revision of this document in SmartPlant Foundation. This
revision can be different from the document revision in SmartPlant Materials because here the
document revision must be unique. When retrieving a document with the same SmartPlant
Foundation revision but a different version, the SmartPlant Materials revision is increased by
one.
The SmartPlant Version UID field shows the SmartPlant Foundation UID of the particular
version of this document.
The document descriptions are displayed in the Short Desc and Description fields.
The Category field shows the SmartPlant Integration document category. A category contains
document types. The type of the document is shown in the Type field. The Subtype field shows
the SmartPlant document subtype. A subtype belongs to a document type.
The Title field displays the document title, coming from SmartPlant Integration.
The UID field shows the unique identifier of this document in the SmartPlant environment. This
field is mandatory for documents coming from SmartPlant.
The original document name coming from SmartPlant is displayed in the Org. Document Code
field. This field will be filled with the document name only if a conflict of duplicate document
names occurs. To guarantee uniqueness within the software, this field will be filled with a
concatenation of the internal identifier of the document (ID) and a substring of the document
code.
The SmartPlant Plant field shows the name of the SmartPlant plant where the document has
been retrieved from.
The SmartPlant Project field shows the name of the SmartPlant project where the document
has been retrieved from.
The date the document was created is displayed in the Document Date field.
The date this document was last changed is displayed in the Changed Date field.
The path type can be selected from the dropdown list in the Path Type field. These are the
available path types:
 Physical - The file name of the document will be added to the value of project default
ZI_WEB_DOC when you open the document.
 Link - The browser will be opened using the values in the Source Path and File Name
fields when you click the Open button.
 DB Storage - The document is saved in the database and is retrieved correspondingly.
The Source Path field shows the path of the document file. This field is not available for the DB
Storage path type.
The File Name field shows the name of the document file.
The number of pages of the document can be entered in the No. Pages field.
The author of the document can be entered in the Author field.
The Directa Class field shows the document class in Directa, and the Directa Type field shows
the type of the Directa document. Both fields are not used or supported any longer.
The COR Number field is only of interest if you are looking at the documents that are assigned
to a change order (CO). This field contains the name/number of the COR (change order
request) to which the document was originally assigned and which was converted into the CO
that you are now viewing.
You can use the Order By ... button to change the order by criteria for the displayed records.
Click the Upload button to upload a file into the database or to any server or share within the
network. This button is only available for new documents.

Attachments
If the path type is set to DB Storage, the file is uploaded into the database. If you have logged
into the software using the E-Supplier functionality, only this path type is available for selection,
which means that from E-Supplier you can upload and store files only into the database.
If the path type is set to Link or Physical, the file is uploaded to the selected server or share
and the path type is automatically set to Link. Regardless of the path type, you first select the
file that you want to upload from a file selection dialog box.
If the file is to be uploaded to a server or share, you must select the destination. These
destinations are defined on the A.10.38 File Destinations screen.
If the selection of subdirectories is allowed for a destination, that is, the Sub Dir check box is set
on A.10.38, a directory selection dialog box appears afterwards. You can only select any
subdirectory. If you move upwards in the directory hierarchy or select a completely different
drive or directory, an error message appears.
You must know the following rules when working with subdirectories.
If subdirectories are available but you do not want to select any subdirectory, you just have to
click the Cancel button. The file will be uploaded to the directory that was originally selected.
If you want to select a subdirectory, just click once on the name of that subdirectory. The
subdirectory name will be taken over into the File Name field. Then click OK to continue.
If you want to select a sub-subdirectory, you must double-click in the (first) subdirectory to see
the list of all subdirectories below that directory. Then click once on the subdirectory and click
OK.
To be able to upload the file to its final destination, the DBA setting DOC_UPLOAD_DEST must
be set. For more information, see the SmartPlant Materials DBA Settings document, available
from the Printable Guides page in the software.
The Source Path and File Name fields are automatically filled with the appropriate values so
that you can open the file by clicking the Open button.
If you want to use your own procedure for uploading a file, you must set the project default
ZX_DOC_CIP to Y and modify the library mar_custom. For more information, see the
SmartPlant Materials Project Defaults document, available from the Printable Guides page in
the software.
When you click the Link button, you can select a file to be linked with the current document. The
button is only available for new documents and only if you did not log on via E-Supplier. First,
you must select one of the server paths or shares, which were defined on the A.10.38 screen,
from the LOV. Then a file selection dialog box is displayed where you can pick the file. After
selecting a file, the Source Path and File Name fields are automatically filled with the
appropriate values.
When you click the Open button, the selected file is opened. If the document has been retrieved
from SmartPlant, the document will be opened within SmartPlant WebClient and SmartPlant
Markup. Of course, it is necessary to have the software installed to make use of this
functionality.
If the document was not retrieved from SmartPlant and the path type is set to Physical, the
project default ZI_WEB_DOC must be set to be able to open files. For more information, see the
the software.
If you want to use your own procedure for opening a file, you must set the project default
ZX_DOC_CIP to Y and modify the library mar_custom. For more information, see the
the software.

Attachments
Click the Revision button to create a new revision of the current document. Another window is
opened where you can enter the new revision number. This button is not available for
documents that have been retrieved from SmartPlant Integration.
In the Document Set field, you can select the name of a document set from the LOV. All
document sets defined on the D.10.12 Document Sets screen are available for selection. Then
click the Copy button to attach the documents of this selected set. The document set will be
copied as follows:
 Any document of the set not yet assigned will be attached.
 If the document is already attached with the same revision, nothing will be changed.
 If the document is already attached with a higher revision, nothing will be changed.
 If the document is already attached with a lower revision, the old one will be replaced with
the document from the document set.
Only the highest revision of a document set is available for this copy process. If you have
opened the D.90.21 screen from a discipline dependent screen like R.30.01 Maintain
Requisitions, you can only copy a document set if you are logged in with the discipline of the
selected object (for example, the requisition).
You can double-click in the Document Set field to open the D.10.12 Document Sets screen.
The Rev field shows the revision of the selected document set.
In the VDRs for Document block, you can attach VDRs to the document selected in the upper
block. For more information, see Vendor Data Requirements (VDRs) (on page 99).
Text and Terms

On the Text and Terms tab, you can maintain text and terms that have been attached to a
requisition template, a requisition, an inquiry, or an agreement. Text can be changed by filling
out blanks, for example; or you can insert additional text.You can also delete text. Modifications
made to the text here do not change the original text defined on the D.20.11 Text and Terms
screen.

Attachments
If you modify the texts of a requisition, these changes will not be reflected on further
supplements of this requisition.
Select Header or Footer from the dropdown list in the Placement field. This placement defines
where the text should appear after it has been attached to a requisition or an inquiry, for
example.
Enter a sequence number in the Seq field. This sequence controls the order in which the
attached text and terms appear in the header or the footer section of the document.
Select the name of the text and term from the LOV in the Term Code field. You can double-click
in this field to open the D.20.11 Text and Terms screen where text and terms are defined.
The revision is automatically assigned to a text and term starting with 0 (zero); the revision is
displayed in the Rev field. When you duplicate a record, the revision is increased by one.
The Highest Rev check box indicates if the highest revision of the text and term is attached
(check box is marked), or if a higher revision exists (check box is not marked).
The Term changed check box indicates whether a text and term is changed compared with the
previous supplement. This indicator is only set for requisitions and requisition line items.
The text and term descriptions are displayed in the Short Desc and Description fields.
If a file is attached to the selected text and term, the file name is shown in the File Name field.
You can click the Open button to open this file. The project default ZI_WEB_DOC must be set to
be able to open files. For more information, see the SmartPlant Materials Project Defaults
document, available from the Printable Guides page in the software.
If you click the Show Short Desc button, a window opens where the short descriptions of all
attached text and terms are displayed, concatenated and ordered by their sequence.
If you click the Show Description button, a window opens where the descriptions of all attached
text and terms are displayed, concatenated and ordered by their sequence.
Instead of adding single text and terms, you can attach a pre-defined term set. To insert a set,
select the name of the term set from the LOV in the Term Set field and click the Copy button.
The LOV in the Term Set field shows only term sets defined for the referenced object. For
example, if you want to attach text and terms to a requisition, only sets defined for the

Attachments
‘Engineering Requisition’ term type are available for selection. When you click the Open button,
all text and terms of the selected set will be attached. The text and terms of the selected set will
be copied as follows:
 Any text and term of the set not yet assigned will be attached. If the sequence of the TT set
detail is already used, the next available sequence will be selected. If necessary, you can
re-sequence the text and terms afterwards.
 If the text and term is already attached with the same revision, nothing will be changed.
 If the text and term is already attached with a higher revision, nothing will be changed; the
text and term will not be added.
 If the text and term is already attached with a lower revision, the old one will be replaced
with the text and term from the set.
Only the highest revision of a text and term set is available for this copy process.
If you have opened the D.90.21 screen from a discipline dependent screen like R.30.01
Maintain Requisitions, you can only copy a text and term set if you are logged in with the
discipline of the selected object (for example, the requisition).
You can double-click in the Term Set field to open the D.20.12 Text and Term Sets screen.
The Rev field shows the revision of the selected text and term set.

Attachments
Vendor Data Requirements (VDRs)

A vendor data requirement (VDR) can only be assigned once to an object. You cannot attach
the same VDR with different revisions.
For attached VDRs, you can store additional information that is not available for VDRs or VDR
set details. For example, you can enter the number of weeks the vendor promises for delivery or
the delivery date itself.
Except for agreements, their line items and item shipments, VDRs can only be attached to an
object as long as it has not been approved. After approval, no more changes can be applied.
Therefore, the module is running in query-only mode once the object has been approved.
On the VDRs tab, you can attach vendor data requirements (VDRs) to objects such as
engineering requisitions, inquiries, and agreements.
Only the highest revision of each VDR is available.
With the radio group on top of the tab, you can control whether data on the VDRs tab is
displayed independently from the data on the Documents tab.
If the Only VDRs option (default) is selected, data is shown independently from each other; that
is, if you assign a VDR to an object and a document to this VDR, this document will not be
displayed on the Documents tab. And vice versa, if you assign a document to an object and a
VDR to this document, this VDR will not be displayed here on the VDRs tab.
If you select the Include Document VDRs option, documents attached to VDRs will be
displayed on both tabs, and vice versa, VDRs assigned to a document on the Documents tab
will also be displayed on the VDRs tab.
If the VDR field is displayed with a cyan background color, documents are attached to this VDR.
If the VDR field is displayed with a magenta background color, the VDR is assigned to a
document on the Documents tab.
In Include Document VDRs mode, you cannot attach documents to VDRs on the VDRs
tab.

Attachments
The Ordered by field shows by which fields the displayed records are sorted. By default, the
records are ordered by sequence and VDR. To change the order criteria, you can click the
Order By ... button at the bottom of the screen. Or, you can open the pop-up menu with a right
mouse-click in any field and select the Order by this field ascending or Order by this field
descending menu item.
To insert a VDR, enter a sequence number in the Seq field and the vendor data requirement
name in the VDR field. When you enter a VDR name that is not yet defined on D.40.11, the
name will automatically be inserted on D.40.11.To select a pre-defined VDR from the list, open
the LOV in the VDR field. The LOV shows all VDRs defined on the D.40.11 Vendor Data
Requirements screen and not yet attached on D.90.21.
Select the Sel check box of all VDRs to be attached. You can use the Select All button to select
all displayed VDRs. Deselect All cancels the current selection. Finally, click the Fill In button to
attach all selected VDRs and to close this LOV window.
Back on the main window of D.90.21, you can double-click in the VDR field to open the D.40.11
Vendor Data Requirements screen.
The Highest Rev check box indicates if the highest revision of the VDR is attached (check box
is marked) or if a higher revision exists (check box is not marked).
The VDR Changed check box indicates that a VDR has changed compared with the previous
supplement.
The VDR Changed check box indicates if the VDR has changed compared to the previous
supplement. If a previous supplement (of the requisition, inquiry, agreement) exists, the check
box is marked if any change has been applied to the VDR. This means that either the VDR
revision has changed or that any other field, for example, the distribution category or the revised
delivery date, has been modified. The check box is also marked if a VDR has been added for
the first time on a supplement > 0 (zero).

Attachments
The revision is automatically assigned to a VDR starting with 0 (zero) and displayed in the Rev
field. When you duplicate a record, the revision is increased by one.
The Distribution Category field shows the name of the distribution category.
The VDR descriptions are displayed in the Short Desc and Description fields.
The Required indicator shows whether the VDR is required for document management.
The date the VDR is required is shown in the Date Required field.
The first issue copies are stored in the First Issue Copies field, that is, how many copies should
be delivered from the supplier (number of copies wanted).
In the Scheduled field, enter the number of days, weeks, or months in which the documents
should be delivered by the supplier. Select the period for the value in the Scheduled field from
the dropdown list in the Period field. The available values are DAYS, WEEKS, and MONTHS.
The Event field shows the event when the documents should be delivered.
The purpose of the VDR can be selected from the dropdown list in the Purpose field.
The final issue copies are stored in the Final Issue Copies field, that is, how many copies will
be delivered from the supplier.
Enter the number of weeks after which the delivery of this VDR is promised by the supplier in
the PW field.
The Prom Delv field contains the date on which the supplier has promised to deliver the VDR.
This field is populated automatically when assigning VDRs to an agreement coming from a
requisition or an inquiry/bid evaluation. It is filled with the current date or agreement creation
date plus the number of weeks stored in the PW field. The value of this field cannot be changed.
If the supplier revises the delivery date, select the new date from the LOV in the Rev Delv field.
In the Actual Delv field, select the actual delivery date of this VDR from the LOV.
In the Received By field, enter the name of the person who received the VDR.
In the Priority field, enter the priority for this VDR.
The following fields can be used to enter the appropriate information:
 With Tender Period
 With Tender Event
 For Approval Period
 For Approval Event
 For Approval Schedule
 Final Period
 Final Event
 Final Schedule
 As Built Period
 As Built Event
 As Built Schedule
In the Deliverable Status field, you can select the name of the deliverable status from the LOV.
You can double-click in this field to open the P.10.79 Deliverable Status screen.
In the VDR Comment field, you can enter the default required quantity (pieces and types) or
any other comment.
The Complete indicator shows whether this VDR is complete.
You can add up to 20 attribute fields to the screen configuration; see Add field (on page 53) in
the Core Workflow Screens (on page 49) section of this document. As long as the attribute fields
are empty, the attribute is not assigned to the VDR. When you enter a value in any attribute
field, this attribute will be added to the VDR.

Attachments
Depending on the object (requisition, quote, order, (any) line item, item shipment) for which you
have opened the D.90.21 screen, you can update VDRs at any time or only up until its approval.
For objects without approval functionality (for example, item shipments) there is no restriction on
updates.
If the object is already approved, it is possible to make updates to given attributes and/or to
insert new attributes when some conditions are fulfilled (only possible for attached attributes of
type 'Other').
 If the project default ZX_MODATTR is set to Y, new attached attributes can be inserted for
already approved objects. These new attributes can be updated or deleted afterwards.
 If the Allow Update check box is selected on the A.50.01 screen and the Locked check box
is not selected on the A.50.21 screen, it is possible to update the value for this attribute after
the approval of the object; it is not possible to delete the attribute. If any of these conditions
is not fulfilled, you cannot update the attributes.
If the project default ZX_HL_RQAT is set to Y, and the attribute has been marked on the
A.50.01 Attributes screen as being required (Reqd indicator marked) the background color
used for required fields is also used for highlighting this attribute.
Label and hint text for the attribute fields is retrieved from A.50.01.
You can double-click in the attribute field or click the Attributes button to open the A.50.21
Attached Attributes screen.
You can add up to 10 CIP fields to the screen configuration; see Add field (on page 53) in the
Core Workflow Screens (on page 49) section of this document.
You can click the VDRs button to open the multi-selection LOV for VDRs, same as using the
LOV button in the VDR field.
Instead of adding single VDRs, you can attach a pre-defined VDR set. To insert a set, select the
name of the VDR set from the LOV in the VDR Set field. All VDR sets defined on the D.40.12
VDR Sets screen are available for selection. Then click the Copy button to attach the VDRs of
this selected set. The VDRs of the selected set will be copied as follows:
 Any VDR of the set not yet assigned will be attached.
 If the VDR is already attached with the same revision, nothing will be changed.
 If the VDR is already attached with a higher revision, nothing will be changed; the VDR will
not be added.
 If the VDR is already attached with a lower revision, the old one will be replaced with the
VDR from the set.
Only the highest revision of a VDR set is available for this copy process.
Maintain Requisitions, you can only copy a VDR set if you are logged in with the discipline of
the selected object (for example, the requisition).
You can double-click in the Term Set field to open the D.40.12 VDR Sets screen.
The Rev field shows the revision of the selected VDR set.
In the Documents for VDR block, you can attach documents to the VDR selected in the upper
block. For the field descriptions, see Documents (on page 91).

Attachments
Attributes
On the Attributes tab, you can attach attributes and values for these attributes to objects such
as requisitions, inquiries, or agreements.
The entered attribute value will either be shown if the attribute does not depend on the login
language; that is, the NLS-Val check box is not marked for this attribute on A.50.01. Or, the
attribute value will only be shown in the login language when assigning the attribute and/or
setting the value.
Attributes can be assigned on either the header or line item level. Inserting and deleting
attributes or updating values of attributes on the header level has no consequences on the
attributes and their values on the line item level.
If you insert an attribute on the agreement line item level, this attribute will automatically be
inserted in all corresponding item shipments; also, an update or a delete is executed on the item
shipment level. Working with attributes on the agreement line item level is only possible as long
as the agreement is not approved.
If you have already changed the attached attribute on the item shipment level and
afterwards you make an update to the same attribute on the order line item level, you also
update the attribute on the item shipment level. If you have deleted an attribute on the item
shipment level and make an update on the order line item level, this attribute is again inserted
for the item shipment.
If attributes or values are to be populated to line items, you can use the Insert on Line Items
and Update Line Items buttons. If an attribute is to be deleted on all line items, you can use the
Delete on Line Items button. The buttons are described below.
Attributes for fabrication items can only be updated. You cannot insert or delete attributes
for fabrication items.
If the project default ZX_MODATTR is set to Y, new attached attributes can be inserted for
already approved records. These new attributes can be updated or deleted afterwards. If the
project default is set to N, attached attributes cannot be inserted for already approved records.

Attachments
If the Allow Update check box is selected on the A.50.01 screen and the Locked check box is
not selected on the A.50.21 screen, it is possible to update the value for this attribute after the
approval of the object; it is not possible to delete the attribute. If any of these conditions is not
fulfilled, you cannot update the attributes.
You can attach attributes of a pre-defined attribute set. Select the set from the LOV in the
Attribute Set field, and all sets defined on A.50.04 are available for selection. Then click the
Copy button to attach all attributes of the selected set.
Maintain Requisitions, you can only copy an attribute set if you are logged in with the discipline
of the selected object (for example, the requisition).
You can double-click in the Attribute Set field to open the A.50.04 Attribute Sets screen.
The level that has been assigned to an attribute within a set is ignored when using this feature.
Regardless of the level, an attribute is attached if not already existing.
If a default value has been provided for an attribute, it is taken over.
Only attributes that have been marked as being active are taken into account.
To attach a single attribute, select the name of the attribute group from the LOV in the Group
field. This will restrict the selectable attributes in the Name field to attributes defined for that
group. Without selecting a group, all attributes defined on A.50.01 are available for selection.
In the Value field, you can enter a value for the attribute.
You can click on any of the buttons above the Group, Name, and Value fields to change the
sort order of the displayed attributes. If you click a button, the records are sorted by the values in
the related field. The sort order is indicated on the small button, it is either D (descending) or A
(ascending).
The picture above is an example of when the attributes are sorted by the attribute name in
ascending order.
The After Appr indicator shows whether the attribute was inserted after the approval of the
corresponding object.

Attachments
An attribute can be used as a summary attribute, as a group by attribute, or as a normal attribute

just assigned to a requisition, inquiry, purchase order, and so forth. Select the kind of attribute
from the dropdown list in the Kind Of Attribute field. The available values are:
 Summary Attribute - The attribute is used as a summary attribute in the MTO.
 Group by Attribute - The attribute is used as a group by attribute in the MTO.
 Ident Values - The attribute is used as an ident value
 Other - (default) The attribute is a simple attribute, not used as a summary nor a group by
attribute.
The Change field indicates whether the attribute or the attribute value has changed compared
with the previous object supplement. The available values with their definitions are listed below.
 New - The attribute is attached for the first time.
 Unchanged - The attribute was already attached to the previous supplement of the object,
but the value of the attribute has not changed compared with the previous supplement.
 Changed - The attribute or the attribute value has changed compared with the previous
supplement.
If the value of an attribute has changed in the course of the supplements, the Suppl of last
change field shows the number of the highest supplement having a value different from the
current value. This value is displayed in the Value of last change field.
The unit of the attribute is shown in the Unit field..
The label text specified for the attribute is displayed in the Label Text field. The hint text
specified for the attribute is displayed in the Hint Text field.
The Locked indicator shows whether the attribute can be deleted and whether the attribute
value is locked for update. This indicator will be set for all attributes that are used as summary
and group by attributes in the MTO.
Insert on Line Items

The Insert on Line Items button is only enabled if you have opened the D.90.21 screen from
the (requisition or agreement) header level, and not from the line item level. When you click this
button, the following changes are applied on the line item level:
The selected attribute will be assigned with its value to each line item of the object. Line items to
which this attribute is already attached remain unchanged, even if the value on the line item
level differs from the value on the header level.
If you have opened D.90.21 from an agreement, you are asked whether you want the attribute to
be inserted on the item shipment level as well, if applicable. If you click No, the attribute is not
inserted on the item shipment level. If you click Yes, the attribute will also be attached to all item
shipments of all agreement line items.
Delete on Line Items

The Delete on Line Items button is only enabled if you have opened the D.90.21 screen from
the (requisition or agreement) header level. If you click this button, the selected attribute will be
deleted on all line items to which it has been assigned.
be deleted on the item shipment level as well, if applicable. If you click No, the attribute is not
deleted on the item shipment level. If you click Yes, the attribute will also be deleted for all item

Attachments
Update Line Items

The Update Line Items button is only enabled if you have opened D.90.21 from the header
level, not from the line item level. If you click this button, the attribute values on all line items to
which the attribute has been assigned will be updated.
be updated on the item shipment level as well, if applicable. If you click No, the attribute is not
updated on the item shipment level. If you click Yes, the attribute will also be updated on all item
Insert/Delete/Update for Detail Tags

The Insert for Detail Tags button is only enabled if you have opened D.90.21 for a master tag.
Master tags can be created on the quote detail, agreement line item, and item shipment levels.
For more information about master and detail tags, read the "Split Tag" chapter in the
SmartPlant Materials MSCM User’s Guide, available from the Printable Guides page in the
software. When you click this button, the following changes are applied:
The selected attribute will be assigned with its value to each detail tag of the selected master
tag. Detail tags to which the attribute is already attached remain unchanged, even if the value
for the detail tag differs from the value of the master tag.
The Delete for Detail Tags button is only enabled if you have opened D.90.21 for a master tag.
If you click this button, the attribute will be deleted for all detail tags to which it has been
assigned.
The Update Detail Tags button is only enabled if you have opened D.90.21 for a master tag. If
you click this button, the attribute values will be updated for all detail tags to which the attribute
is attached.
The Deleted Attributes (compared to last supplement) block displays attributes of the previous
supplement that are deleted in the actual supplement.

Attachments

SECTION 11
Approval Sequences
Multi-step approval can be set up in SmartPlant Materials with approval sequences for objects
such as engineering requisitions, inquiries, quote summaries, agreements, login requests,
company profiles, qualifications, and so forth. Approval templates serve as pre-defined lists of
approvers that are copied to the appropriate approval sequence. For more information, see
Approval Sequence Templates in the SmartPlant Materials Administrator's Guide, available from
the Printable Guides page in the software.
Approval Sequence Screen

On a screen where you want to approve, you can click the Approval Sequence button to open
the A.20.49 Approval Sequence screen.
In the first block, the object that must be approved to make it available in the downstream
process is displayed.
In the Approval Sequence block, the assigned approvers are displayed. If an approval template
was used, the users assigned to the template are copied to this approval sequence. Here you
can change, add, or remove approvers.
The project default ZP_RFA_CHG (default value = Y) controls whether an approval list
can be changed even when the RfA check box of the corresponding object is set. If
ZP_RFA_CHG is set to N and the RfA check box is set, the approval list is locked and cannot

Approval Sequences
be changed (of course, this does not apply to the Approved and Rejected check boxes and the
Comment field).
To add a new approver, enter a sequence number in the Seq field, and select a user name from
the LOV in the User field. This sequence is only used for the display of approvers; it does not
represent the sequence in which users have to perform the approval. This sequence is only
managed by the Prerequisites option.
Only users with the necessary approval privilege are available for selection. For more
information, see Approvals, Privileges, and Settings (on page 112).
The First Name and Last Name fields are populated from the selected user. Select a title from
the LOV in the Title field. You can double-click in this field to open the A.20.04 User Titles
screen where the titles are defined.
The Prerequisites indicator is set if any other users are assigned to the user as a prerequisite
for his approval. If prerequisites are defined for a user, he can only approve after all the other
users assigned as prerequisites have approved. To define prerequisites, you can double-click in
the User field to open a window where you can maintain the prerequisites of the selected user.
Prerequisites can only be defined or changed as long as the user has not selected the
Approved or Rejected check box.
To confirm or reject an approval, you must select the Approved or the Rejected check box in
the line with your user name.
You can only select the Approved or Rejected check box for the user name you have
used to log in.
Whenever a user listed in the approval sequence approves or rejects, the next user (according
to the sequence number) is invited via e-mail to approve or reject the object. The e-mail is only
sent if the e-mail address is defined for the user on A.20.05.
An approval cannot be withdrawn once another user for whom the current user is a prerequisite
has approved.
During requisition approval on R.30.01, the CIP function approve_req_by from the
M_PCK_REQ_CUSTOM package is called when the Approved indicator is set. This CIP
function can be used to implement your own logic to validate the requisition approval. An error
dialog box appears if the validation fails.
The date when the user has approved or rejected appears in the Approved/Reject Date field. In
the Comment field, you can enter any comments about the approval or the rejection.
The Allowed Amount field shows the maximum amount this user is allowed to approve, with
the currency in the Currency field. The allowed amount is checked at the approval of
requisitions on R.30.01, quote summaries on P.30.22, agreements on P.50.07, progress on
SM.20.11, invoices on SM.20.11, and change order requests on SM.40.02. The approval is only
possible if the value that has to be approved does not exceed the allowed amount. The allowed
amount with its currency is copied from the approval template (A.20.45) or the user definition
(A.20.05), but you can change or enter the value and currency here if you have the UPDATE
ALLOWED AMOUNT privilege granted.
If no allowed amount is entered, the user has the permission to approve unlimited
amounts.
The Approved/Rejected By field displays the name of the user who approved or rejected if this
action has been done by someone else instead of the user to whom this task was originally
assigned.
The Distribution Category field shows the distribution category assigned to this approver. The
distribution category defines who is to be notified when the user approves. You can double-click
in this field to open the A.10.52 Distribution Categories screen.

Approval Sequences
Copying Approval Templates

To copy a pre-defined approval template, select the template from the LOV in the Approval
Template field at the bottom of the screen, and click the Copy button. The users assigned to
the selected template are copied to the approval sequence. Any users that have been added
previously are removed from the sequence. You can double-click in the Approval Template
field to open the A.20.45 Approval Templates screen.
This field is no longer available once the approval procedure has started.
Approval Documents
You can assign a document to the approval sequence. For example, assign a report with the
details to the approval sequence of a requisition. Click the Upload button to open the File
Upload window, select a file, and click Open. The file is uploaded to the database and the
filename is displayed in the Approval Document field. Click the View button to open and view
the attached document. Click Remove to remove the document from the approval sequence.
Once the approval process has started, you cannot upload or remove documents.
Enforce and Reverse Approval

You can use the Enforce Approval button to enforce an approval even though not all users on
the approval sequence have approved. To use this button, you need the normal approval
privilege (depending on the approval object) and additionally the ENFORCE APPROVAL
privilege. For information about privileges, see Approvals, Privileges, and Settings (on page
112).
Use the Reverse Approval button to reverse an approval. To use this button, you need the
normal approval privilege (depending on the approval object) and additionally the REVERSE
APPROVAL privilege. For information about privileges, see Approvals, Privileges, and Settings
(on page 112). To reverse an approval, you must enter the reason for the reversal in the
Reason field. This reason is sent in an e-mail to all people on the approval sequence and to the
contact person for the object the approval of which has been reversed. The Reverse Approval
button is available after the first user has approved.
If the RfA check box was selected before you opened the approval sequence screen and
the project default ZP_RFA_CHG is set to N, the approval list cannot be changed. The only
fields you can update are the Approved and the Rejected check boxes and the Comment field.
Revert Approval
When an approval sequence is processed, the logged-in approval user can revert the approval
sequence chain. The approval sequence can be reverted to a particular user in the approval
chain, or the approval sequence can be reverted to the very beginning of the sequence. To
revert the approval sequence, select the Revert check box. If this check box is selected, an alert
appears with the options of reverting the approval sequence to a particular user or reverting the
entire approval sequence.
If you select reverting approval to a particular user, a new window opens to select the user in the
approval chain, and the software reverts the approval sequence to this user. An email is sent to
this user notifying him to start the approval sequence once again. The subsequent approvers
are reverted as well and must re-approve.
If the complete approval sequence is reverted, the originator and the first approver will receive
an email.

Approval Sequences
Approvals, Privileges, and Settings

Depending on the type of approval template, users assigned to the approval template must have
a particular privilege granted. The table below shows the available approval sequences,
associated settings, and the relationship between objects and privileges.
The Screen column shows the screen(s) where the approval template is used. The Filled
from… column indicates what setting, if any, is used to automatically fill the approval sequence
from a pre-defined approval template. The Started by… column indicates the event on the
associated screen that triggers the beginning of the approval sequence.
Screen Approval template type Privilege Filled from... Started by...
C.20.21 MIR by Reservation Material Issue Report MIR Approval Project default: RfA check box
C.20.21.11 MIR for Plates ZC_MIRAPPR
C.20.22.01 MIR by BOM
Commodity
Commodity (Group by)
Ident
C.20.23.01 MIR by Direct
Issue
C.20.23.02 MIR by Direct
Issue (Group by)
P.20.01 Qualification ALLOW P.10.25 Question Submit
Suppliers/Subcontractors, SUPPLIER List: assigned
Qualifications tab APPROVAL approval sequence
P.20.02 Login Requests Login Request ALLOW DBA setting: Submit
SUPPLIER LOGIN_REQUEST
APPROVAL _APT
P.20.04 Company Profile Company Profile ALLOW P.10.25 Question Submit
SUPPLIER List: assigned
APPROVAL approval sequence
P.30.21 Prepare RFQ, Bidder ALLOW No Request Bidder
Bidders tab SUPPLIER Approval check box
APPROVAL
P.30.21 Prepare RFQ, Addendum ALLOW Project default: Addendum Ready
Addenda tab INQUIRY ZP_APRADD for Approval
APPROVAL check box
P.30.21 Prepare RFQ, Inquiry ALLOW No Inquiry RfA check
Inquiry tab INQUIRY box
APPROVAL
P.30.22 Commercial Quote Summary QUOTE No Quote RfA check
Evaluation, Quote APPROVAL box
Summaries tab
P.50.07 Maintain Blanket Order BO APPROVAL Project default: Ready for Approval
Agreements ZP_APRBO check box
P.50.07 Maintain Notice of Commitment NOC Project default: Ready for Approval
Agreements APPROVAL ZP_APRNC check box
P.50.07 Maintain Purchase Order PO APPROVAL Project default: Ready for Approval
Agreements ZP_APRPO check box

Approval Sequences
Screen Approval template type Privilege Filled from... Started by...
P.50.07 Maintain Subcontract SM APPROVAL Project default: Ready for Approval

Agreements ZP_APRSM check box
R.30.01 Maintain Engineering Requisition ER APPROVAL No RfA check box
Requisitions
SM.20.11 Subcontract Work Progress PROGRESS Project default: Submit
Administration, Item APPROVAL ZP_APRWKP
Progress tab
SM.20.11 Subcontract Schedule of Values SOV Project default: Submit
Administration, Schedule of APPROVAL ZP_APRSOV
Values tab
SM.20.11 Subcontract Schedule of Value PROGRESS Project default: Submit
Administration, SOV Progress APPROVAL ZP_APRSVP
Progress tab
SM.20.11 Subcontract Milestone Progress PROGRESS Project default: Submit
Administration, Milestone APPROVAL ZP_APRMSP
Summary tab
SM.20.11 Subcontract Invoice INV APPROVAL Project default: Invoice Ready for
Administration, Invoices tab ZP_APRINV Approval check box
SM.20.11 Subcontract Closeout Checklist Item CLOI Project default: Closeout Item
Administration, Closeout APPROVAL ZP_APRCLOI Ready for Approval
Checklist tab check box
SM.30.07 Non Conformance Non Conformance Reports NCR No Ready for Approval
Reports APPROVAL check box
SM.40.02 Change Order Change Order Request COR Project default: Ready for Approval
Requests APPROVAL ZP_APRCOR check box
SM.40.05 Back Charges Back Charge BC APPROVAL No Manually

Approval Sequences

SECTION 12
Online Help
This section describes the SmartPlant Materials Online Help. It describes the structure and the
context sensitivity of the online help, how to access the help, how to navigate within the help,
and how to search. The online help is context-sensitive to user actions and is available at all
times and for all screens.
The SmartPlant Materials online help is organized by screen, window, block, and fields.
This organization allows the help text to be context-sensitive. The help is provided in HTML
format and is stored in the web_help folder.
To call the online help for the active screen, use the question mark button on the right of the
toolbar.
The online help opens to the text describing the field from which the help was called. In the
example displayed above, the cursor was positioned in the Originator field of R.30.01 when the
online help was called. The picture below shows the result. This demonstrates the
context-sensitivity of the online help.
The online help of all forms is structured in the same way. It is organized by screen, window,
block, and field.
At the top of each page, you’ll find a general introduction about the intended purpose of the
screen. This introduction describes the functions and prerequisites like privileges, settings, or
configurations, if required for the screen.

Online Help
All the fields on the screen are listed in sequential order, with the field names in bold and
detailed description of the functions and properties of the field.
Navigation
In the upper right corner of each help page, you’ll find the forward and backward buttons. With
the use of these buttons, you can navigate through all the pages of the online help for the
current screen.
Using the scrollbar on the right side, you can scroll up or down the current page. Or, use the
arrow up/down keys, PAGE UP or PAGE DOWN, HOME, or END to navigate on the page.
Search
To search for a term within the active window, use the CTRL+F keys to open the search
window, enter the search criteria, and click Next to jump to the first occurrence of the search
term. Clicking Next again searches for further occurrences within the displayed text.

Online Help
Using the Back button, you can move to the start page of the current screen help. When
scrolling down this page, you will find a list of associated forms below the general introduction
section. All the screens related to the current screen are listed with a link that can be used to
directly call the help of those screens without leaving the current help or screen.

Online Help
Scrolling down further, you will find a list of all windows and tabs for the current form. They also
come with links to directly open the corresponding help. This allows you to easily navigate within
the help pages of a form.
To go back to the calling page, use the browser’s Back button. To navigate within a topic, use
the buttons at the top of the help page.

SECTION 13
Printable Guides
The Printable Guides is a library of documents that describe the functionality of SmartPlant
Materials and Reference Data. To access this library, click Help > Printable Guides.
The DBA setting ONLINE_REFERENCE_LIBRARY_URL is used to set the URL for the
Help > Printable Guides command to call the Printable Guides start page. The default value is
<your application server>/marian_webentry/docs.htm. The URL points to the <SmartPlant
Materials Home>/web_entry directory on the application server.
Another way to open the Printable Guides documents is described in Product Documentation
(on page 68) in the Valid Settings section of this document. In this way you can open documents
related to a specific screen or module directly from that screen.
The Printable Guides are organized in categories:
New Features - Release Bulletin and Release Notes, describing the new features.
Installation - Guidelines for the installation, migration and service pack upgrades.
General - General introduction and manuals explaining how to set up SmartPlant Materials.
Integration - All integration-related documentation.
SmartPlant Materials - This section is arranged in sub-categories reflecting the SmartPlant
Materials modules.
SmartPlant Reference Data - This category contains documents for the classic SmartPlant
Reference Data application and for the SmartPlant Reference Data Plus application.
Discoverer - Documents describing the Discoverer.
Tutorials - Training manuals demonstrating the functionality in SmartPlant Materials and
SmartPlant Reference Data.

Printable Guides
All the documents are clearly arranged and listed by title.
If you are not yet familiar with the documents, you might want to see some more information
about their content. For this purpose, use the Display Document Descriptions option on the
upper part of the page.

Printable Guides
When you click this option, the page shows brief descriptions for each document to help you
navigate through the library. This additional information makes the search for a particular
document easier.
To open a user's guide, move the cursor to the document title. The cursor style will change to a
pointer. Click the title to open the document.
To search through all the documents in the library, click the SPMATDOC.pdf link in the second
paragraph. The SPMATDOC.pdf contains all of the Printable Guides documents delivered with
SmartPlant Materials.
After opening this file, click Edit > Find, and enter the term you want to search for. Here we are
searching for "design change warehouse."

Printable Guides
You can also use Edit > Advanced Search for more options.
Adobe Reader finds all occurrences of that phrase in the document. You can step through the
results.

SECTION 14
Reports
Reports can be used to format and print out database information for a project or product group.
Reports have a header and footer that contain project data, dates, page numbers, and
pre-defined text. Users can output reports on the screen, to a printer, or to a file.
The letter R in the third position of a menu item identifies a report.
Generating a Report
1. Start a report from the menu tree view.
2. Enter the report parameters on the A.60.71 Start Reports screen. Set the Run Options
and Run Parameter options for the report. See below for descriptions of the options.
 You must define the standard parameters in the first report parameter block.

Reports
 The parameters below the standard parameters are report-specific.
 You can use the _ (underscore) and % (percent sign) as wildcards.

 You cannot use wildcards for number values.
3. Click Save Settings to save the settings (optional).
4. Click Start Report to generate the report.
Processing a large amount of data may take a few minutes.
The completed report is output to the printer, screen, or file, depending on your run
parameter setting.
Optional: Click Parameter Info to display the report parameter details in a second window.
To modify the report parameters, use the A.30.05 Parameter screen.
Run Options
Execution Online – Direct processing and output. The application waits for the
Modes report to finish.
Batch – The report is transmitted to the report server and queued. The
output will be displayed as soon as the report is finished.
Parameter Suppress Cover – If checked, the report will not have a cover page.
Table of Contents – If checked, the report has a Table of Contents.
Comment Entered comment text prints on the report cover page.

Reports
Process Status Displays the current state of the report processing.
Run Parameter Options

Destype Destination Type: Report output destination, for example, printer, file, or
cache. Selecting Cache will open the report in a new browser window,
after the report is generated.
Name of the Only taken into account if you have selected DESTYPE=File. The output
report will be stored as a file with the given file name. The entered value for this
parameter should be either a file name or a combination of path and file
name. Please refer to your application server administrator, as the
generated report will be stored on the application server, and every path
needs to match with the existing physical structure on the application
server.
Desformat Description Format: Report file format, for example, RTF, HTML, or PDF.
Discipline Specifies the engineering discipline (for example, piping).
Language National language for the report output.
Rule Code, Report-specific parameters.
Rules Order and
other
parameters
Report Formatting
Reports have a cover page with the name of the report and the parameters used to prepare it,
as well as a header and footer on every page. Reports are printed in the selected language,
which refers only to the database contents to be prepared for the report pages. The layout of the
report is independent of the selected language. The report header and footer can be defined on
the A.20.09 Project Report Layout screen.
The following graphic shows the report elements.

Reports
Report Cover Page

Reports
Report Body Pages

Reports
Report Document Library

The Report Document Library provides you with a set of sample reports as well as
documentation describing each report. Similar to the Printable Guides, you can access the
Report Document Library by clicking Help > Report Document Library.
This will open the start page of the Report Document Library.
On the right, you can select the module that you would like report information about.

Reports
For example, select Procurement to open the next page as displayed in the picture below. For
each report, a brief description is provided. You can open the report sample file by clicking the
name of the report. To get more details about the report, click the More Details... link. The
documentation provides information about the report, including its purpose, data, and
parameters.

Reports

Index
A I
Add field • 53 Ident Collection Cart • 81
Adding Basic Data • 64 Input Mode • 39
Approval Sequence Screen • 107
Approval Sequences • 107 L
Approvals, Privileges, and Settings • 110
Attached Attributes • 87 List of Values • 41
Attachments • 89 Log-on • 11
Attributes • 101
M
C Main Menu • 16
Case-Insensitive Query • 47 Menu • 15
CIPs • 67 Menu Tree • 22
Configurations • 49 Menu Tree Structure • 23
Context Bar • 37 Move to/Remove from scroll area • 58
Core Workflow Screens • 49 Multi configuration • 57
Customer Menu • 20 My Menu • 26
D N
DBA Settings • 66 Navigation • 114
Define Ident Collection Carts • 83 NLS Window • 37
Documents • 89
Drag and drop • 61 O
Online Help • 113
E Operation Modes • 38
Edit Menu • 17 Order By • 62
Editing Features Overview • 39 Order by this field … • 58
Editor Window • 40
P
F Populate … • 59
Fastcall • 76 Pop-up Menu • 52
Favorite Configuration • 51 Pop-up menus • 76
File Menu • 16 Preface • 7
Full Text Search • 74 Preselection • 73
Print to File • 34
Printable Guides • 117
G Privileges • 67
Generating a Report • 121 Product Documentation • 68
Global update • 60 Project Defaults • 66
Guided Tours • 27
Q
H Query Mode • 38
Help Menu • 21 Query/Where Dialog Box • 44

Index
R
Reference Entries • 69
Remove field • 58
Report Document Library • 126
Report Formatting • 123
Reports • 121
S
Screen Handling • 29
Screen Layout • 30
Screen Structure • 31
Search • 114
Search Functionality • 26
Set column spacing • 55
SmartPlant Materials Overview • 9
SPRD Explorer • 71
Status Bar • 38
T
Text and Terms • 94
Toolbar • 32
Tree View Toolbar • 25
V
Valid Settings • 65
VAs • 68
Vendor Data Requirements (VDRs) • 97
W
Window Menu • 20

SPMAT User Interface Basics

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SPMAT User Interface Basics

Uploaded by

Copyright:

Available Formats

SmartPlant Materials

User Interface Basics

Version 2011 SP8 (7.0.8)

June 2010 / April 2013

SmartPlant Materials Overview .................................................................................................................. 9

Screen Handling ........................................................................................................................................ 29

Core Workflow Screens ............................................................................................................................ 49

SmartPlant Materials User Interface Basics 3

Remove field ................................................................................................................................... 58

Valid Settings ............................................................................................................................................. 65

SPRD Explorer ........................................................................................................................................... 71

Ident Collection Cart ................................................................................................................................. 83

Attached Attributes ................................................................................................................................... 89

Approval Sequences ............................................................................................................................... 109

Online Help ............................................................................................................................................... 115

Printable Guides ...................................................................................................................................... 119

Reports ..................................................................................................................................................... 123

4 SmartPlant Materials User Interface Basics

Index ......................................................................................................................................................... 131

SmartPlant Materials User Interface Basics 5

6 SmartPlant Materials User Interface Basics

SmartPlant Materials User Interface Basics 7

8 SmartPlant Materials User Interface Basics

SmartPlant Materials Overview

Database and Application

SmartPlant Materials User Interface Basics 9

10 SmartPlant Materials User Interface Basics

SmartPlant Materials User Interface Basics 11

12 SmartPlant Materials User Interface Basics

SmartPlant Materials User Interface Basics 13

14 SmartPlant Materials User Interface Basics

SmartPlant Materials User Interface Basics 15

Command Shortcut Description

Close all ALT+F4 Closes all open screens.

16 SmartPlant Materials User Interface Basics

Command Shortcut Description

SmartPlant Materials User Interface Basics 17

Command Shortcut Description

Go To Opens a sub-menu with items.

18 SmartPlant Materials User Interface Basics

Command Shortcut Description

 Enable buttons context sensitive: Toolbar buttons are

Cancel CTRL+Q Cancels the query.

SmartPlant Materials User Interface Basics 19

Get More CTRL+SHIF Gets the next set of records.

Previous Field SHIFT+TAB Moves the cursor to the previous field.

20 SmartPlant Materials User Interface Basics

Command Shortcut Description

SmartPlant Materials User Interface Basics 21

The icons used in the tree menu are:

22 SmartPlant Materials User Interface Basics

Menu Tree Structure

SmartPlant Materials User Interface Basics 23

Site The Site Management module is subdivided into Field Material

My Menu Displays a list of user-defined menus.

24 SmartPlant Materials User Interface Basics

Tree View Toolbar

Button Meaning Description

Expand Displays one lower level of the active node.

Collapse Hides all levels of the active node.

Collapse Hides all levels of all nodes in the tree.

Log Off Ends the SmartPlant Materials session.

SmartPlant Materials User Interface Basics 25

Online Help Opens the online help of the main menu.