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

Quick Start Guide Page 1

Quick Start Guide Top Previous Next

PlantManager Quick Start Guide


PlantManager is the software platform that delivers an integrated solution for the following set of
licensable products.
SagePlus - Engineering Analytical Capabilities
API RBI - Risk Based Inspections

The technical guide delivers the general PlantManager Help in a sequence that guides new users
to a basic level of understanding. Navigating the Quick Start Guide is simple.
· Use links take you to the concepts within the PlantManager Help that are applicable to
the topic
· Use the back arrow to navigate back to the Quick Start Guide section
· Watch short videos for each Quick Start Guide

Quick Start Guide Sections:


Connecting to a Database
Navigation Tree
Keywords
Calculating

Connecting to a Database Top Previous Next

The initial launch of the PlantManager application page is empty (see Figure 1) until you describe
a database location. This is done in 2 steps:
1) Establishing a Server Connection
2) Connecting to a Database

Figure 1 - Initial PlantManager Application Page

Please review the following Key Concepts

Key Concept > Establishing a Server and Database Connection

Get Started by Accessing the Example Databases Delivered with your PlantManager Installation

file:///C:/Users/Lenovo/App... 11/15/2021 1:39:41 PM


Quick Start Guide Page 2

There are Example Problem Databases delivered with your PlantManager install. These databases
are located in the directory EEG\PlantManager\examples. The EEG directory is usually found in
C:\Program Files or C:\Program Files (x86), depending on the directory that was chosen during the
install.

The following Example Problem Databases delivered with your install:


· API RBI - API 581 Example Problems
· Design Codes - ASME Section VIII - Division 1, PTB-4 Example Problems
· Fitness-For-Service - API 579-2ASME FFS-2 Example Problems

It is recommended that you copy the Example Problem Databases to a local working directory.
After copying the databases, set up a server connection to the example database applicable to
your use of PlantManager. This will be helpful while completing the Quick Start Guide.

Navigation Tree Top Previous Next

PlantManager uses the Navigation Tree to organize your data relating to Equipment, Components,
and Analysis Capabilities. You can think of the Navigation Tree as a directory structure allowing
you quick access and the primary interface to your information. Your productivity will increase as
you become more familiar with the Navigation Tree, the meaning behind each icon, etc (see
Fiugre 1).

Figure 1 - Example Navigation Tree

Please review the following Key Concepts

Key Concept > PlantManager Interface Overview


Key Concept > PlantManager Tool Bar Icons
Key Concept > The Navigation Tree
Key Concept > The Right Click Menu

file:///C:/Users/Lenovo/App... 11/15/2021 1:39:41 PM


Quick Start Guide Page 3

Key Concept > Nodes (Entries within the Navigation Tree)


Key Concept > Drag and Drop (Re-sequencing Nodes within the Navigation Tree)
Key Concept > Filtering the Navigation Tree

Keywords Top Previous Next

Within PlantManager, the term Keyword is used to represent input and output fields within forms
(see Figure 1). Becoming more familiar with keyword formats and actions will allow users to be
more productive. This Quick Start Guide Section will guide you through an overview of Keywords.

Figure 1 - Example PlantManager Form

Please review the following Key Concepts

Key Concept >Right Click Menu


Key Concept > Keyword States
Key Concept >Keyword Default Values
Key Concept >Keyword Comments
Key Concept >Keyword Flags
Key Concept >Hover Over Help

Calculating Top Previous Next

Calculating is the process of applying proven engineering algorithms to convert known input into
actionable information necessary to support engineering decisions. This may include an API RBI
analysis across a specific unit, a design assessment on an equipment, an end of life assessment,
etc.

Please review the following Key Concepts

There are three main processes when performing a calculation:


Key Concept > Initiating a Calculation
Key Concept > Viewing Calculation Progress
Key Concept > Viewing Calculated Results

file:///C:/Users/Lenovo/App... 11/15/2021 1:39:41 PM


Software Navigation Page 1

Software Navigation Top Previous Next

Owner-users of pressurized fixed equipment, including pressure vessels, piping and tanks, are becoming increasingly interested in whole-life management of
equipment to enhance reliability and availability. The following are the fundamental requirements of a life cycle management process for fixed pressurized
equipment:

· Understanding potential damage mechanisms in the design process


· Selecting appropriate construction codes to ensure reliable designs
· Establishing in-service inspection programs to monitor anticipated damage and to determine the presence of unanticipated damage mechanisms
· Applying Fitness-For-Service (FFS) technology if unanticipated damage is discovered
· Implementing effective repair procedures, as required, to ensure mechanical integrity of in-service equipment

PlantManager is a fully integrated software tool for the life cycle management of fixed equipment that takes advantage of the integration of design and in-service
codes and standards that are now becoming a focal point in the industry. By combining key equipment and data management software in one application and
database, PlantManager offers the fixed equipment reliability tools that are needed for maximum plant safety and efficiency.

PlantManager Interface Overview Top Previous Next

The PlantManager Graphical User Interface (GUI) organizes stored data using the Navigation Tree. Each Node on the Navigation Tree represents a collection of
information referenced as Keywords and is organized in logical Keyword Group Tabs. The GUI enables quick access to common functions through a Tool Bar. Access
to all functions is through the Navigation Tree Right-Click Menu (visible when right-clicking on a node) and the Keyword Right-Click Menu (visible when right-clicking
on a keyword). Finally, the GUI provides a Status Bar that shows a quick view of PlantManager operating status and messages (see Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 2

Figure 1 - PlantManager GUI

Server & Database Connections Top Previous Next

A server connection defines a link to a unique database, which may be stored locally or remotely. By configuring a server connection, you are telling PlantManager
where to find your data. Local connections access a database that is stored on the user's computer. These databases may only be accessed by one person at a time.
Remote connections access a database that is stored on a server. Several users may be active in the database at any given time. Remote connections also require a
username and password. Depending on the user's licensing and setup, one or more server connections may be created.

In the Navigation Tree, server connections are marked with the symbol . A server connection appearing in this list is referred to as a Connection node.

Configuring a Server Connection

The Server Connection only needs to be configured once for each Database you access. PlantManager will save the configuration details.

Configuring a Local Server Connection

Steps to Establish a Local Server Connection (see Figure 1):


1. Select the PlantManager menu option File > New Server Connection... to display the Connection Configuration dialog box.
2. Configure the Connection:
a. Enter the Connection Name - This name will appear in the Navigation Tree and should be descriptive enough to easily find, as you will likely have
multiple Server Connections in your Navigation Tree over time.
b. Select Server Type - Local.
c. Name the database file by entering the path and database name or selecting the ellipsis ( ) on the Database File field to select the directory using
the Windows Explorer.
An existing local database can be selected, or you can choose a new file name to create a blank database.
3. After a Server Connection is established, you will be able to remove, edit, or connect to the database when it is disconnected.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 3

Figure 1 - Establishing a Local Server Connection

Configuring a Remote Server Connection

Steps to Establish a Remote Server Connection (see Figure 2):


1. Select the PlantManager menu option File > New Server Connection... to display the Connection Configuration dialog box

The Remote Server Address, Port, User Name, and Password are created and maintained by your local PlantManager Administrator. Your local
PlantManager Administrator will need to provide this information prior to configuring a Remote Connection.

2. Configure the Connection:


a. Enter the Connection Name - This name will appear in the Navigation Tree and should be descriptive enough to easily find, as you will likely have
multiple Server Connections in your Navigation Tree over
time.
b. Select Server Type - Remote.
c. Enter the server name or the server IP address in the Server Address Field.
d. Enter the Port (The port represents the database on your remote server and must be provided by your local PlantManager administrator).
e. Enter the user name and password that give you access to the Server.
3. After a server connection has been established, you will be able to remove, edit, or connect to the database when it is disconnected.

Figure 2 - Establish a Remote Server Connection

Connecting to and Disconnecting from a Database


- A database connection will need to be established each time PlantManager is launched in order to access (view or update) the database contents.
- Connecting to a database opens the database for access (viewing or updating), while disconnecting from a database closes the database.
- You can connect to multiple databases at one time.
Connecting to a local database puts a lock on the data that is removed when you disconnect. You MUST disconnect prior to sharing your Local Database
with another user.

Connect to and Disconnect From a Database


1. Select the Connection node level in the Navigation Tree (see Figure 3).
a.To connect, select the Connect ( ) button. You will notice the Connection node will show you are connected to the database.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 4

b. To disconnect, select the Disconnect ( ) button. You will notice the Connection node will show you are disconnected from the database.

Figure 3 - Connecting/Disconnecting to a Database

Toolbar Icons Top Previous Next

The Toolbar is located directly under the menu bar. Toolbar icons provide an easy way to perform a function within PlantManager. The icons are context and license
sensitive (see Figure 1).

Figure 1 - Toolbar Icons

Description Icons:

Icon Shortcut Meaning


Toggles the selected data between input and output key
CTRL + I words.

ALT + B Calculate the currently selected item.

Finds any item in the tree containing the text string you
CTRL + F enter.
Bulk Edit Inspection History - Icon is available when a Unit
CTRL + H is selected.
Module Level Help - Quick way to get help for the selected
CTRL + F1 Node. Example - Clicking when performing an analysis
returns the Technical Guide for that specific analysis.
Text Editor Toggle - Toggles between Forms and Text
CTRL + T Editor Views.

CTRL + S Saves the current form of Equipment branch..

Expand All Nodes in the Navigation Tree.

Collapse All Nodes in the Navigation Tree.

Google Analytics Top Previous Next

Like all companies, Equity has limited resources. We use the data collected from the field to help guide our development efforts.

· Speed - data captured about speed to be used to make decisions on targeted performance improvements. Even though our software products undergo
extensive testing prior to release, there is nothing better than actual real-world usage to demonstrate performance issues.
· OS & Resolution - we are always striving for improvement and knowing what our clients are using most often helps us to decide if these development efforts
are going to be helpful of troublesome for the end users.
· Physical module creation - this information is used to determine which modules to focus our development and testing resources.
· Exception - this information will be used to know when something has gone wrong. This allows us to begin researching and potentially even fix issues before
the user even logs it with our help desk.

What is Captured :
· User ID - This is a unique anonymous ID created for each installation of the PlantManager server. It is automatically generated by the software at run-time.
· Per Server Installation Data:
o Server Operating System version
o Server PlantManager version
· Per Client Connection Data:
o Time to download tree data from the server to the client
o Time to populate the GUI with the tree data downloaded from the client
o Screen resolution of the client PC
o Nodes created in PlantManager (i.e. Plant, Tank, Course). We do not capture specifics about these nodes, only that they were created

Settings:
The root user can configure the Analytic's collection in one of three ways (see Figure 1):

1. The user can choose to not capture any data by un-checking the Capture Analytic's Data option. This will cause the server to not collect any analytic information.

2. The user can choose to capture data but not upload it by checking the Capture Analytic's Data option and un-checking the Upload Analytics Data option. This will

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 5

cause all of the analytic information to be collected in a file on the server computer. At a later time, this data can be retrieved from the server manually or by
selecting the Retrieve Analytic's Data option, which can be found in the PlantManager client’s help menu. Retrieving the data in this manner will allow the user to
save the data locally and will clear the server file. The other option is to enable the Upload Analytic Data option, which initiate the currently recorded analytic data
to be batch uploaded at that time.

3. The user can choose to capture and upload the data by checking both the Capture Analytics Data and Upload Analytics Data options. This initiate all analytics data
to be uploaded immediately. If there is an issue with internet connectivity from the server, the data will be accumulated in a file on the server until connectivity is
restored, at which time the stored data will be uploaded.

Figure 1 - Analytics Options Dialog

The Navigation Tree Top Previous Next

Most of the operations in PlantManager are executed using the Navigation Tree. The tree is a visualization of the physical links between data, which are stored and
manipulated in modules. When a module appears in the Navigation Tree, it is referred to as a node. The Navigation Tree makes it easy to view and edit data stored in
the nodes.

Node Relationships
Two nodes that share data are said to have a parent-child relationship when one node is subordinate to another in the Navigation Tree hierarchy. Child nodes may
have only one parent node, but a parent node can share data with multiple child nodes. Nodes sharing the same parent are referred to as sibling nodes.
It is possible for a node to be both a parent and a child. An easy way to discern parent-child relationships is to look for the expand ( ) button next to the node's
name in the Navigation Tree. Any node with this button can be considered a parent node. Clicking on the expand button will show all of the node's children.

Figure 1 - The Navigation Tree

Nodes Top Previous Next

The Navigation Tree is a visualization of the physical links between data, which are stored and manipulated in modules. When a module appears in the Navigation
Tree, it is referred to as a node. The Navigation Tree makes it easy to view and edit data stored in the nodes.

There are four primary categories of nodes represented in the Navigation Tree:
1. Server Connections
2. Folders
3. Analysis Modules
4. Physical Modules

Each Node Type is represented in the tree with a unique Node Icon to make navigation easier. In addition, Node Flag icons provide an easy way to see the status
information.

The combination of Node Icons and Node Flags provides a simple visual representation of your data and status directly from the Navigation Tree.

Node Icon List


The following shows the list of all Node Icons for each Connection Node:
- Server Connection
- Folder
- Analysis Module

Physical Modules:
- Corporation
Plant
Unit
Equipment
Component
Inspectable Component
Bundle
PRD
Inspectable Equipment

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 6

Node Flag Icon List

While data is being entered or post-calculation, related tree nodes may appear with flags. The flags will highlight the overall status of the node.

The columns are as follows (from left to right):


1. Node Name
2. Case Slider
3. Case - node has two or more cases or a Parametric Study is present
4. Calculation status:
a. Success - calculation succeeded
b. Warnings - calculation succeeded with warnings
c. Failed - calculation failed
d. Obsolete - data changed since last calculation
5. Errors - missing/incorrect form data is present
6. Flag - a data flag has been set on the form
7. Modified - unsaved form data is present
8. Lock - the node is being edited or viewed

Combining Node Icons and Node Flag Icons

Figure 1 is an example of what may be seen in the columns based on the data present in the forms.

Figure 1 - Node Flag Example

Folders Top Previous Next

Folders may be used to store text files, documents, spreadsheets, etc. They may also be used to contain Analysis Modules. Files can be dragged-and-dropped into a
folder or imported by right-clicking on the folder and selecting Import Input Files from the menu. When appearing in the Navigation Tree, folders are denoted with
the icon. A folder appearing in the tree is referred to as a Folder node (see Figure 1).

If a file with the extension *.inp is dragged and dropped into a folder, PlantManager will parse the file to detect if it is a valid analysis input file. If successful, the
appropriate hierarchy of Analysis Modules will be created within the Folder.

Note: No Physical Modules may be constructed inside a folder, but folders may be placed inside any Physical Module.

Figure 1 - Typical Folder Node Containing SagePlus Analysis modules and File Attachments

File Attachment Top Previous Next

File attachments may be added to any folder and may include pictures, text files, documents, spreadsheets, etc. Files can be dragged-and-dropped into a folder or
imported by right-clicking the folder and selecting Import Input Files from the menu. When appearing in the Navigation Tree, file attachments are denoted with the
icon of the file format (see Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 7

Figure 1 - File attachment Within a Folder With .xls Extension

Analysis Modules Top Previous Next

Analysis Modules are used to perform various engineering studies. They can be attached to Equipment, Component, or Folder nodes. In the Navigation Tree, Analysis
Modules are marked with the icon . If pertinent information is missing, the Analysis Module will have an icon in the Error column. Please see the Node Flag Icon
List section for details.

Analysis Modules can be created from the parent node's right-click menu or by importing or dragging and dropping an *.inp file into a valid location.

Right Click Menu Top Previous Next

Maintaining Nodes in the Navigation Tree is accomplished using the right-click menu (see Figure 1). The right-click menu has built-in intelligence that dynamically
adjusts based on actions allowed for the specific node that was selected.

Example: Only Corporation and Folder nodes can be added to a Server Connection node

Right-clicking on an existing node that you wish to act upon will initiate the right-click menu. The following Maintenance Actions are available:
· Adding new nodes (Physical Modules, Folders, and Analysis Modules)
· Adding an attachments to a folder
· Cutting/copying/pasting from one part of the Navigation Tree to another
· Renaming a node
· Deleting a node

Figure 1 - Right-Click Menu

Drag and Drop Top Previous Next

Moving Nodes
To drag a node to a new location, left-click and hold on the node and move the mouse pointer to the desired location in the tree. Releasing the click drops the node
into the new location. While using drag-and-drop, the pointer will indicate if the action is permitted. Additionally, one of the following icons will indicate if the node
will be placed above, below, or inside the selected node.
The item will be dropped below this node.
The item will be dropped inside this node.
The item will be dropped above this node.
Nodes within the Navigation Tree can be reordered by dragging the node icon to the desired location and dropping it into place. Some nodes can also be relocated to
a new parent; (e.g. an Equipment node can be moved to a different Unit, or a Unit can be moved to a different Plant).

Examples of drag-and-drop

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 8

Figure 1 - SHELL3 Analysis Module Moved From Folder 1 to Folder 2 Figure 2 - Unit 2 Moved Above Unit 1

Copying Nodes
To make a copy of a node a during drag-and-drop, press and hold Ctrl on the keyboard while moving the icon. A new copy of the node and all of its children will be
created where the node was dropped.

Copying Between Servers


In most cases, when moving a node, the node will be moved and will no longer be present in the original location. However, if a node is moved to another server
connection, copies will be placed in both the original location and in the outside server. Copying nodes can cause large amounts of data to move across the network
and may be slow.

Filtering Top Previous Next

The filtering feature of PlantManager enables users to control what nodes are visible in the Navigation Tree. The filtering dialog box is accessed by selecting View > Filter
menu bar. To add or edit a filter, select the Add or Edit option. The dialog box has options for specifying how the keywords are applied in the filter. Possible filtering options include
the following:
· By a word or phrase
· By an equality or inequality (greater than, less than, equal to, etc.)
· By conditional operators (and, or, etc.)

For example, the statement:


COMPONENT.COMP_TYPE equals "DRUM" Or COMPONENT.COMP_TYPE equals "KODRUM"
will make only components that are drums or knockout drums visible in the Navigation Tree.

Import Default Filters


PlantManager is delivered with a set of default filters. These Filters must be imported to your filter list before they can be used.

Importing Default Filters


1. Select View > Filter from the menu bar.
2. Select the Import button.
3. Select the defaultfilters file in the File List dialog box, then select the Open button. This will add a comprehensive list of predefined filters to your filter drop down list.
4. Select the specific filters you wish to import, then select the Import button.
5. After the import completes, select the desired filter from the filter drop down list and select Apply.

Adding / Editing / Removing a Filter

Adding a Filter
1. Select View > Filter from the menu bar.
2. Select Add from the Filter Select dialog box.
3. At the Create Filter dialog box, enter a name for the new filter in the Filter Name field.
4. Select a Module from the drop down list.
5. Select the keyword items that you wish to filter within the Filter Keywords section and click the ">" button.
6. Click the Criteria button.
7. Click the + icon located next to the And text to add the first criterion.
8. Click on the <enter a value> message and type or select the value you want to filter on.
9. Click the OK button.
10. Select the Show Children option if applicable.
11. Click the Save button.
12. The filter will be saved and can be used by clicking the Apply button.

Editing a Filter
1. Select View > Filter from the menu bar.
2. Select the filter you which to edit.
3. Click the Edit button from the Filter Select dialog box.
4. Follow Steps 4 through 12 from the Add A Filter section above.

Removing a Filter
To remove the filter so that all nodes are displayed again, select View > Remove Filter from the menu bar.

Filtering for Flagged Fields


Individual fields cannot be chosen to filter for flags, but nodes can be filtered if any field in the node has a flag.

Filter Based on Flags


1. Select View > Filter from the menu bar.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 9

2. Click the Add button the Filter Select dialog box.


3. At the Create Filter dialog box, enter a name for the new filter in the Filter Name field, to create a name for the new filter.
4. Select GLOBAL ITEMS from the Module drop drown select list.
5. Select the GLOBAL ITEMS.Form Flag item in the Filter Keywords list, and press the > button.
6. Click the Criteria button.
7. Click + icon located next to the And text.
8. Click the <enter a value> message and select the type of flag to filter on.
9. Click the OK button.
10. Select the Show Children option if applicable.
11. Click the Save button.
12. The filter will be saved and can be used by clicking the Apply button.

Figure 1 - Using Filter Select and Filter Dialog

Cases Top Previous Next

Cases can be added to Equipment and Components by right-clicking on the node and selecting Add Case. Adding cases is useful for things such as Parametric Studies.
A user can create multiple Cases of the same component where each case varies one or more input keyword values.

In the Navigation Tree, the Case Slider allows users to view each case for a piece of equipment. The slider is enabled or disabled by right-clicking the word Node,
which appears at the top of the Navigation Tree, and selecting Show Case Slider or Hide Case Slider.

There are three parts to the Case Slider.


· The slider triangle ( ) enables users to choose which case to view.
· The plus sign ( ) adds a case.
· The minus sign ( ) removes the current case. Note that the first case cannot be removed.

Figure 1 - Appearance of Cases in Navigation Tree; Hiding the Case Slider

Keywords Top Previous Next

Within PlantManager the term Keyword is used to represent input and output fields within forms. Becoming more familiar with Keyword formats and actions will

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 10

allow users to be more productive.

Figure 1 - Example PlantManager Form

Right Click Menu Top Previous Next

Maintaining Keywords within input and output data forms is accomplished using the Keyword right-click menu option. The Keyword right-click menu has built-in
intelligence that will dynamically adjust based upon actions allowed for the specific Keyword that was selected.

Right-clicking a Keyword that you wish to act upon will initiate the right-click menu (see Figure 1). The following actions are available;
i. Copy/Paste - Copy the value from one keyword to another
ii. Reset to Default - Reset the Keyword value to the default (the value will turn to Italicized Text to indicate a default value)
iii. Keyword Comments - Add a comment specific to that Keyword
iv. Flag - Flag a Keyword for future reference
v. Help - Keyword Definition

See Figure 1 - Right-click menu for the highlights of each applicable menu option.

Figure 1 - Keyword Right-Click Menu

Setting Keywords Top Previous Next

The method of entering or selecting a value for a Keyword depends on the Keyword Setting Type.

Text Field
A text field allows a user to type a value for a Keyword. If an invalid value is entered, a red warning indicator will appear to the left of the text field.

Drop-Down Menu
Keywords that only accept a discrete number of values are set by drop down menus (see Figure 1). For example, a keyword representing a design code will only
contain values such as API 650, API 620, etc, (see Figure 1).

Figure 1 - Setting a Keyword Using a Drop-Down Menu

Check Box
Keywords that take on true/false or yes/no values use a check box or a drop down menu (see Figure 2). If it is a check box, leaving the box unchecked sets the
keyword to NO or FALSE, while checking the box sets the keyword to YES or TRUE. If it is a menu, select the appropriate response from the choices.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 11

Figure 2 - Check-boxes

Tables
In PlantManager, tables function like spreadsheets (see Figure 3). The column headings are where the variable or keyword name appears. Rows and columns can
be added when necessary.

Figure 3 - Data Table and Row Editor

Material Selector
Material Attributes appear on the input forms as read-only (pink background). The Material Selector must be initiated to edit any of the material attributes.

Selecting the Select button within the Material Specification Keyword group will initiate the Material Selector pop-up window (see Figure 4).

Figure 4 - Material Selector

Date Chooser
Date Chooser is used to ensure a valid date is used when entering Date Keywords (see Figure 5).

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 12

Figure 5 - Date Chooser

Keyword States Top Previous Next

PlantManager uses different formats to highlight the specific state of a Keyword. This formatting makes it easy to view an input/output form and know the Keywords
that are required, optional, calculated, read-only, and set with a default value.

Required Keywords - Yellow Background


Required Keyword values must be defined by the user in order to perform a calculation. Required Keywords have a yellow background and are marked with the
icon if no data is entered. If a node contains required Keywords that have not been set:

· The tab in the Data Panel that contains the Keyword will be marked with the icon
· The node will be marked with a red circle (see Physical Modules) so that the user can easily find missing Keywords and correct errors.

Required input field Required input field as a drop-down menu

Optional Keywords - White Background


Optional Keywords will be set to a default value if not otherwise defined by the user.
Optional Keywords will have a white input field. Default values are italicized.

Weld Joint Efficiency and Cladding are optional keywords with default values of 1.0 and NO, respectively

Read-Only Keywords - Pink Background


Read-only Keywords cannot be edited by the user. They take on a value based upon another keyword. Often, read-only Keywords are used to reference a value
on another data tab. Read-only Keyword fields have a pink background (see Figure 1).

Figure 1 - Grade and Year are Read Only Keywords

Calculated Keywords - Purple Background


Some Keywords cannot be set by the user directly and only take on a value after the user has performed a calculation. These keyword fields have a purple
background (see Figure 1).

Figure 1 - A Keyword Set By a Calculation

Default Values - Italicized Text


Some Keywords are initialized with default values. It is often important to know if a default value of an entered value is used for the calculation

The data value for a Keyword will be Italicized Text when it contains a default value

Calculation Flag set as Default Value (Italicized) -- vs -- Calculation Flag set as User Entered Value (Not Italicized)

Keywords with Comments - Green Keyword Label Text


Keywords with user set comments are identifiable by Green Value

Top Previous Next

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 13

Keyword Default Values


To reduce the required the amount of data entry, many keywords are set to a default value when creating a specific node. Default values are delivered with
PlantManager, and they represent the most commonly used value for the specific Keyword.

Default values are easily identifiable because they are shown in italicized text. See Keyword States for examples.

Hover Over Help will show the keyword default value.

Resetting the Keyword Default Value


There are times when a default value has been changed and needs to be restored.

Using the Keyword right-click menu, select Reset to Default.

Figure 1 - Reset Keywords to Default

Keyword Comments Top Previous Next

It can be very useful to add a specific comment to a Keyword. Comments may describe assumptions, reminders, justification etc.

Keywords with comments are identifiable because the value is shown in Green Text. See Keyword States to see examples.

Adding, Editing, Viewing, and Removing Keyword Comments


Accessing Keyword comments is the same for Adding, Editing, Viewing and Removing comments

Initiate the Keyword right-click menu option on the Keywords with a comment (see Figure 1).

Figure 1 - Setting Keyword Comments

View - Initiate the Keyword Comments right-click option of a Keyword with comments set.
Edit - Initiate the Keyword Comments right-click option of a Keyword with comments set. Change the comments, and select OK
Remove - Initiate the Keyword Comments right-click option of a Keyword with comments set. Delete the comment text, and select OK (the label text will return
to black).

Keyword Flags Top Previous Next

Users can place indicator flags on Keywords. Flags can be set by right-clicking on the Keyword entry field and selecting one of the following options from the Flag
menu:

Flag Type Flag Marker


Assumption
Default
Needs Review
Suspect
Check Units
Ignore When Calculating

Previously entered flagged Keyword will have a icon on the Data Panel (see Figure 1). Additionally, its node will be marked in the Navigation Tree with a
yellow dot (see Physical Modules).

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 14

Figure 1 - Recognizing Keyword Flags

Turning Keyword Flag on and off


Keyword flags are turned on and off by using the Keyword right-click menu (see Figure 2).

Figure 2 - Setting a Keyword Flag

Only one Keyword flag can be set for a specific keyword.


To change a Keyword flag, select the new value.
To remove a Keyword flag, select None.

Filtering for Nodes with a Keyword Flag Set


Filtering on Keyword flags is the best way to quickly find all flagged keywords. You can use one of the delivered default filters or create a custom filter for flagged
fields. Filtering HELP provides detailed steps.

Using a delivered Default Filter - PlantManager is delivered with predefined filters for each of the Keyword flag settings. Default filters must be imported to your
filter drop-down to make them available. Follow the steps to Import Default Filters within the Filtering HELP

Available Default Filters

Creating a Custom Filter - Steps to create a custom filter to show all Flagged Keywords - See Filtering for Flagged Field within the Filtering HELP

Hover Over Help Top Previous Next

Descriptive help is available for each keyword. This help is initiated by hovering over the Keyword's text field with the mouse.

Hover Over Help provides the Keyword Name in [ ], Keyword Description, and the Keyword Default Value in ( ) (see Figure 1).

Figure 1 - Viewing the hover over help for Liquid Discharge Coefficient. The tool tip shows the keyword name, a description, and the default value

Calculation Top Previous Next

Calculating is the process of applying proven engineering algorithms to convert known input into actionable information necessary to support engineering decisions.
This may include an API RBI analysis across a specific unit, a design assessment on equipment, an end of life assessment, etc.

There are three main processes to perform a calculation (see Figure 1):

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 15

Initiating a Calculation
Viewing Calculation Progress
Viewing Calculated Results

Figure 1 - Calculation Process

Initiating a Calculation Top Previous Next

Calculating can be initiated at any level in the Navigation Tree except at the database connection. For example, you can calculate an entire Unit, a specific
Equipment/Component, an entire Folder, a specific SagePlus Analysis Module, etc.

Calculation Respects Filters - only Nodes within the set filter will be calculated. Filtering prior to calculation is a way to reduce the overall calculation time.

Productivity Benefit - all nodes are viewable and nodes not within the scope of the calculation are editable while the calculation runs in the background.
(Example: If you are calculating a Unit, you can edit nodes in other units within the same database.)

Calculating automatically saves any unsaved data.

Initiate a Calculation
1. Select the scope of the calculation within the Navigation Tree (see Figure 1).
2. Initiate the Calculation using the Toolbar Icon or the Navigation Tree Right-Click Menu option

Figure 1 - Initiating a Calculation

Cancel a Calculation

Calculations are stopped through the Server Message Viewer. To learn more about the Server Message Viewer, see Viewing Calculation Progress

Viewing Calculation Progress Top Previous Next

Calculations run in the background, and the progress and status are viewable through the Server Message Viewer. The Server Message Viewer shows vital
information about the calculation as it is happening.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 16

Figure 1 - Server Message Viewer

Viewing Past Calculation Results Detail


The Server Message Viewer holds the result of each calculation during your current PlantManager session (see Figure 2). Each calculation holds an entry in the
upper half of the Server Message Viewer dialog box.

Select the plus sign ( ) to expand the calculation event.

Figure 2 - Server Message Viewer

Cancel a Calculation
Calculations are stopped through the Server Message Viewer.

To cancel a calculation select the Cancel Job( ) button in the Server Message Viewer (see Figure 3).

Figure 3 - Canceling a Calculation

Viewing Calculated Results Top Previous Next

Within PlantManager, data forms are either input oriented or output oriented. Once a node has been calculated, the results are viewable on the output form.
PlantManager provides the capability of toggling back and forth between Input and Output forms (see Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 17

Figure 1 - Input/Calculated Output Toggle

Changing an input value on a successfully calculated node will cause the status icon (Green C) in the Status column to change to an out of sync (Grey C) status.
This is an indicator that the output results are suspect and the node needs to be re-calculated.

Copying/pasting nodes will clear the output and require it to be re-calculated, while moving (dragging and dropping) will preserve the calculated results.

Recognizing Calculation Status within the Navigation Tree


The Navigation Tree highlights the calculation status using color coded flags located in the Status column.

Calculation Symbols:

For details relating to Node Icons, Flags, and how they work together, see Nodes Help

Viewing Calculated Output


Calculating any portion of the Navigation Tree results in the generation of calculated results. The Input values and calculated output values are viewable by
toggling between input and output forms (see Figure 2).

Figure 2 - Toggling Between Input and Output Forms

Viewing Warning or Error Messages


Error and Warning Messages are available when a node is flagged with a Calculation Failed (Red C) or Calculation Successful with Warnings (Yellow C), which will
help to address the errors and/or warnings.

The Navigation Tree Right Click Menu will provide the options to review both Error (see Figure 1) and Warning (see Figure 2) Messages for a specific node in the
Navigation Tree.

1. Select the node with the Error or Warning with a right mouse click to initiate the menu.
2. Select the option Error Messages or Warning Messages.

Example - View Error Messages

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 18

Figure 3 -View Error Messages

Example - View Warning Messages

Figure 4 - View Warning Messages

Working with Graphs Top Previous Next

Enabling Graphs
Several of the PlantManager modules offer graphical output. Typically, graphs can be found by toggling to the output form (see Viewing Calculated Results) in the
Graphs tab.

These User Customizable Features Are Available Within Graphs

> Saving and Exporting Graphs

To save a graph, open the Graph Viewer by clicking on the graph, then select File > Save from the Graph Viewer menu bar. Currently, PlantManager supports *.jpg,
*.gif, *.png, *.tiff, and *.bmp file extensions.

Graphs can be copied to the clipboard by opening the graph and selecting Edit > Copy from the Graph Viewer menu bar. The image can then be pasted into a
document or spreadsheet.

> Changing the Graph Display

The title, axes, legend, and display color of the graphs can be modified to meet the user's needs. Open the Graph Viewer and select Tools > Modify Graph from the
menu bar (see Figure 1 and Figure 2).

Figure 1 - Modifying Chart Properties

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 19

Figure 2 - Modifying Chart Colors and Display

> Viewing Data Points

The data points that appear form the basis of the graphs can be viewed by selecting Tools > View Series Data from the Graph Viewer menu bar. Depending on the
Analysis Module, the parameters of the curve (if applicable) are viewable this way.

General Import/Export Top Previous Next

Importing Files - Files like images, spreadsheets, *.txt's, *.pdf's - can be imported into a Folder for reference. To import a file:

1. Right-click on the Folder

2. Select Import Input Files

3. Select All Files (*.*) as the file type

4. Choose the file(s) to import from the hard drive

5. Click the Open button

Importing Input (*.inp) Files - Analysis Modules that have been saved as Input (*.inp) files can be imported into a Folder module or to an appropriate Parent module.

1. Right-click on the Folder or Parent module

2. Select Import Input Files

3. Choose the file(s) from the hard drive

Exporting Spreadsheets - Data stored in modules can be exported to a *.xls file. To export data:
Right-click on the Connection node
Select Export Spreadsheet. The following summaries are available to export:
· Basic
· Bundle
· Circuit (excluding thickness measurements)
· PRD
· Supplemental
· Tank
· Tank Details
· Tank Inventory
· Tank Supplement
Importing Spreadsheets - Data exported in *.xls format can be imported into PlantManager. To import a spreadsheet
Right-click on the Connection node
Select Import Spreadsheet.
Fixed Equipment, PRDs, Bundles, and Circuits can all be imported. Data pertaining to already existing nodes will be overwritten. Nodes that already exist will be
ignored. Any node not in the active connection will be created.
Note that when importing a spreadsheet that references two nodes with the same name, the data will be imported as one node.

BatchEditPlus Top Previous Next

BatchEditPlus is a feature that allows users to view and modify the same piece of data, such as Base Material, Operating Pressure, etc., across multiple nodes in the
tree at once. The content is presented as a table with columns representing keywords, such as operating pressure, and rows representing nodes, such as
components. The logic in the forms is still enforced; for example, if a user changes one component’s corrosion basis from estimated to measured, the measured rate
becomes required, and the estimated rate is no longer required.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 20

Working With BatchEditPlus Top Previous Next

The tool can be launched either from the right-click menu or from the main work toolbar (see Figure 1). Once the tool is launched, multiple pieces of data can be
selected on a node (e.g., a component) from the Select Module and Keywords screen (see Figure 2). This screen enables the selection of a module that is a
descendant of the node where BatchEditPlus was launched. For example, launching BatchEditPlus from the unit will allow the user to edit equipment and component
data.

Figure 1 - Accessing BatchEditPlus

Figure 2 - Select Module and Keywords Screen

Rows can be filtered in the BatchEditPlus table (e.g., only seeing components with the Level 2 Consequence Modeler). There are check-boxes that can be utilized to
show only columns with form error flags, data flags, and/or changed data (see Figure 3).
The BatchEditPlus provides the ability to edit text fields, date fields, check-boxes,drop-down boxes, and materials. Materials can be copied and pasted using the Copy
Material and Paste Material functions, located on the right-click menu on the material (see Figure 3).

Figure 3 - BatchEditPlus Table

Material Selector Top Previous Next

The material selector is used to distinguish between materials in the code where the spec, grade, UNS CCT, and size are the same but are differentiated by notes,
product form, or MTS.

Working With the Material Selector Top Previous Next

The material selection dialog makes material selection easier by presenting a series of filtered drop-down boxes. The options in each drop-down are filtered to list
the options valid for the selections that have already been made in the other drop-downs; this means that users can start by entering the information in whatever
order suits the user best. If the UNS is entered first, the user will only see the specs valid for that UNS in the spec drop-down.

If a selection results in only one option being available in another drop-down box, that option will be automatically selected.

Major categories of product form are grouped together (see Figure 1). For example, selecting the “Plate and Sheet” filter will let users see all specifications with a
product form of “Plate”, “Sheet”, “Plate, Sheet”, “Plate, bar” etc.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 21

Figure 1 - Filtered Specs Based on a Selected UNS

Materials in 2010 and 2015 have added information about the source of the material, including the table, page, and line number from the code. For some recent
materials, additional notes from the code have been added in the selection dialog area (see Figure 2).

Figure 2 - Selected Material Showing Notes

Data Grids Top Previous Next

PlantManager and associated products make heavy use of data grids. Data grids are easy ways to organize data for both input and output.
All data grids provide a common set of powerful functions that allow each PlantManager user to customize how they view, update, and analyze results.

Figure 1 - Data Grid Example

Data grids allow you to customize your view by adding\removing columns, reordering columns, sorting, and filtering.

The Working With Data Grids Help Topic will provide detail instructions.

Working With Data Grids Top Previous Next

Introduction
The data grid used in PlantManager is a flexible, configurable way to organize the data in an optimal way for each user.
These User Customizable Features Are Available Within Data Grids
> Adding and Removing Columns
A select group of columns are available to be viable within a data grid. Each user can customize the viable data.

To add or remove columns right click on any column heading

o To add, click on the Column Chooser menu option then double click the columns to add from the available list.
o To remove, select the Remove This Column menu option

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 22

Figure 1 - Adding/Hiding Columns

> Change column order


Changing the order of columns allows you to easily see the most important data side by side.

To change the column order:


· Place your mouse over the column heading, click and hold the mouse button and drag the column left or right to your desired order.

> Group by Column


Data grids with a large number of rows may be difficult to work with. One way of making it easier is by grouping rows based upon common value within a
specific column. Data grids within PlantManager allow for simple and nested grouping to further organize data grid rows.

Use Group By Box to manage data grid data grouping:

· Right-click on any column heading and select Show Group by Box pop up menu option
· The Group By Box will appear above the data grid (blue box above the column headings, see Figure 2)
· To add or nest group, drag column heading to the Group By Box. Drag additional levels to group your results (see Figure 2)
· To remove nested groups, drag the grouping keyword from the Group By Box to the column heading in the data grid.
· Once complete, right click in the Group by Box and select Hide Group by Box (see Figure 2)
You can adjust grouping previously saved by repeating the Group by Column instructions

Figure 2 - Working with the Data Grid - Group By

> Basic Column Sorting Within The Data Grid


All Columns within a data grid are sortable.
o Left-click on the column heading to sort assenting and left-click again to sort descending.
o To remove all sorting right-click on the column heading and select Clear Sorting

Figure 3 - Basic Sorting

> Basic Filtering Within The Data Grid

All columns within a data grid are filterable.


· Hover over the column you want to filter and left-click on the small filter icon that appears in the top right corner of the column header. Select the
desired filter values.
· To remove the filter, repeat the above step and select All Values.
Basic filters can be applied to multiple columns to further refine the rows with the data grid

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 23

Figure 4 - Working with the Data Grid - Basic Filtering

> Advanced Filtering Within A Data Grid


Advanced filtering is available to handle the complexity of your data (For example I want to see all the components that begin with 'Pipe'
· Right-click on any column heading
· Choose the pop-up menu option for Filter Editor and the Filter Editor dialog box will appear.
· Select the Keyword by left-clicking on the first argument and selecting the appropriate Keyword from the pop-up box. (See Figure 5)
· Select the operand by left-clicking on the middle argument and selecting the appropriate operand from the pop-up box. (See Figure 6)
· Select the filter value by left-clicking on the last argument and keying in the appropriate filter value.
· Multiple conditions can be selected to filter. To add a condition click on the + (plus sign) next to the And (See Figure 5). Repeat the above steps.

Figure 5 - Working with the Data Grid - Filter Editor - Keyword Select Figure 6 - Working with the Data Grid - Filter Editor - Operand Select

The filter that is set will appear at the bottom of the data grid.

o To turn filters on and off, check and un-check the filter check box (see the lower left corner of Figure 7.
o To further edit the filter shown, select the Edit Filter link, in the lower right corner, and the Filter Editor dialog box will appear.

Figure 7 - Managing Filters

Data Structures Top Previous Next

Data Structure Overview


PlantManager data has unique data structures for input and output keywords.
ManagerNodeData stores each item found in the Navigation Tree (e.g., Equipment and Component items). ManagerNodeData.Text is the name of the item as
displayed in the tree. PlantManager defines each row in the ManagerNodeData table as an instance of a "module." Module examples include "EQUIPMENT" and
"COMPONENT." ManagerNodeData is associated with ManagerNodeCase in a one-to-many relationship where the primary key is ManagerNodeData.OID and the
foreign key is ManagerNodeCase.ManagerNodeData.

Each data point associated with a module instance is defined by a keyword and one or more values. Keywords can be defined as single value, columnar, or tabular. All
input data is stored in the DataItem table. DataItems are joined to ManagerNodeData through the intermediate DataItemWrapper table.

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


Software Navigation Page 24

PlantManager stores output data defined as single value or columnar with fixed column count in separate tables using a naming convention in which the table name
is constructed by prefixing an X to the module name and appending an O. For example, for the COMPONENT module, the output table is XCOMPONENTO. Most data
related to RBI calculations is associated with the COMPONENT module. Data that is columnar with variable column count or tabular is stored in the DataItem's table.

Input Keyword Data Relationship Description

Figure 1 - Input Keyword Table Relationship Diagram

(See Figure 1) There are exactly two rows in the DataItemWrapper table for each row in the ManagerNodeData table; joined on InputDataItemWrapperOid
and OutputDataItemWrapperOid. By changing the reference in the sample query below, the query will return various input or output data.
Sample Query – SQLite (local database) syntax
SELECT mnd.Text,di.Key,di.ShortValue
FROM ManagerNodeData mnd
INNER JOIN DataItemWrapper diw ON mnd.InputDataItemWrapperOid = diw.DataItemWrapperOid
LEFT JOIN DataItem di ON diw.DataItemWrapperOid=di.DataItemWrapper

Output Keyword Data Relationship Description

Figure 2 Output Keyword Table Relationship Diagram

(See Figure 2) All output is associated with a unique row in the ManagerNodeCase table. Each output table contains a ModuleID column that is linked to
ManagerNodeCase.XMODO_ID in a one-to-one relationship. Each column name in the output table is constructed by prefixing an underscore to the
keyword and appending a column index separated by an underscore. The column index is 1 for all single value output keywords (e.g., Tmin Date is a single
value stored in the keyword TMIN_DATE: therefore, the table column is _TMIN_DATE_1).
Sample Query – SQLite (local database) syntax
SELECT managernodecase.XMODO_ID as Component_Name,
xcomponento._TMSF_TAR_TOT_NI_1 as Total_DF_at_Target_Date,
xcomponento._INSDATE_PLAN_THIN_1 as INSDate_Plant_Thin,
xcomponento._TAR_TOT_NI_OUT_1 as Total_Risk_at_Target_Date,
xcomponento._TMIN_DATE_1 as Tmin_Target_Date
FROM managernodecase
JOIN xcomponento ON managernodecase.XMODO_ID = xcomponento.ModuleId

file:///C:/Users/Lenovo/App... 11/15/2021 1:40:33 PM


API RBI Page 1

API RBI Top Previous Next

Purpose

API RBI is the industry standard for performing RBI. Developed by an API-sponsored Joint Industry Project, the technology is fully documented in API 581 Risk-Based
Inspection Technology. The software includes equipment-specific risk-based procedures for pressure vessels and piping, atmospheric storage tanks, heat exchanger
bundles (shell and tube) and pressure relief devices. It includes advanced probability of failure modeling, a state-of-the-art consequence modeler, and a fluid
property modeler with the ability to model almost unlimited user-defined mixtures for modeling process streams created from a fluid property database of over 500
fluids compiled from such sources as the industry-standard DIPPR database. API RBI software can perform inspection planning based on risk derived from the
probability of failure and consequence models, using both safety and financial considerations.

Capabilities

Equipment specific risk-based procedures based on equipment type

· Pressure vessels and piping, addressing various component types, such as heads, elbows, conical sections and spheres
· Atmospheric Storage Tanks (AST), considering risk scenarios for tank shell and floor components
· Heat exchanger bundles (shell and tube), including experience database capabilities to forecast future performance based on the user's experience in
operation conditions for selected services
· Pressure Relief Devices (PRDs), defined at the equipment level with risk computed for various overpressure scenarios

Advanced Probability Of Failure modeling

· A wide range of damage mechanisms covering refining and petrochemical applications


· ASME Code minimum thickness calculations for vessel components and piping, structural tmin specification, and/or input of user-defined minimum thickness
· ASME Code material specification database covering allowable stresses and engineering properties of base and overlay/clad materials

State-of-the art consequence modeler with direct event tree solution using an embedded cloud dispersion modeler

· Fluid property modeler completely rewritten to use improved algorithms that are more robust and accurate to calculate the properties of two-phase fluid
mixtures (recipes) over a wider range of operating conditions
· Ability to develop almost unlimited user-defined mixtures for modeling process streams created from a fluid property database of over 500 fluids compiled
from such sources as the industry-standard DIPPR database, which is regularly tested and updated for accuracy

Inspection planning based on risk derived from the Probability Of Failure and consequence models

· Risk analysis includes both safety and financial considerations


· Inspection plan provides date and equipment specific inspection requirements

API RBI Overview Top Previous Next

Module Overview
The API RBI module is used to establish a risk-based inspection program for:

· Pressurized fixed equipment and piping


· Atmospheric storage tanks
· Pressure relief devices
· Heat exchanger tube bundles

API RBI employs a quantitative methodology, described in API RBI 581 Risk-Based Inspection Technology, to generate a risk-ranking and corresponding inspection
plan for each equipment item. By following the recommended inspection plan, users can better understand and manage their plant's overall risk level.

General

In order to perform an analysis with API RBI, users are required to interact with Corporation, Plant, Unit, Equipment, Component, and PRD nodes within the Plan
Manager tree. On each of these nodes, all tabs with the API RBI logo contain keywords that are relevant to an API RBI analysis.

After all of the required keywords on the Corporation, Plant, Equipment, and Component nodes have been set, the missing data flag should become invisible on all
nodes.

API RBI Modules Top Previous Next

Physical Modules allow users to enter data into PlantManager that correspond to real entities (e.g., a refinery's units and equipment). These entities are organized
into a hierarchy:

Corporation
Plant
Unit
Equipment
Component

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 2

Inspectable Component
Bundle
PRD
Inspectable Equipment

Each Physical Module is represented by a different icon in the Navigation Tree. These icons will also indicate the status of the module.

Physical Module Normal Incomplete Information Has Cases Has Flagged Keyword
Corporation n/a n/a
Plant n/a n/a
Unit n/a n/a
PRD n/a
Equipment
Component
Bundle n/a
Inspectable Equipment n/a
Inspectable Component n/a

Figure 1 - Physical Module Icons

Corporation Top Previous Next

Corporation nodes are the foundation of the Physical Modules hierarchy. Equipment and Component analysis cannot be done without first creating at least one
Corporation. Multiple corporations can be created on one server connection. In the Navigation Tree, Corporations are marked with the icon.

When a Corporation node is selected, the following tabs are shown in the Data Panel:
· Fluid Designer: Custom fluids that will be processed by the Equipment and Components in the Corporation
· Inspection Category Editor: Data regarding the various Inspection types
· Component Risk Settings: RBI parameters (e.g., GFF and Failure Cost)
Corporations can only be added at the Connection Node

Figure 1 - Corporation Tab

Plant Top Previous Next

Plant nodes are directly under Corporation nodes in the Physical Modules hierarchy. Equipment and Component analysis cannot be performed without attaching at
least one Plant to a Corporation. Multiple Plants can be attached to one Corporation. In the Navigation Tree, Plant nodes are marked with the icon.

When a Plant node is selected, the following tab is shown in the Data Panel:
· Inspection Interval: Inspection intervals for various Equipment types

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 3

Figure 1 - Plant Tab

Unit Top Previous Next

Unit nodes are directly under Plant nodes in the Physical Modules hierarchy. Equipment and Component analysis' cannot be done without attaching at least one Unit to a
Plant. Multiple Units can be attached to one Plant. In the Navigation Tree, Unit nodes are marked with the icon.

When a Unit node is selected, the following tabs are shown in the Data Panel:
Input Screen (Figure 1)
· Inventory Group: Define how much fluid is available for release which will affect the consequences
· Risk Settings: Risk parameter definition
· Fixed Equipment: RBI and Inspection Planning parameters
· PRD Planning: PRD parameter definition

Figure 1 - Unit Input Tabs

Output Screen (Figure 2)


· Risk Matrices: Two views available; Risk and Iso-Risk
· Inspection Plan: Summary of Equipment Inspection Plans within the Unit

Figure 2 - Unit Output Tabs

Top Previous Next

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 4

Equipment
Equipment nodes are directly under Unit nodes in the hierarchy. Multiple Equipment nodes can be attached to one Unit. In the Navigation Tree, Equipment nodes are marked with the
icon.

When an Equipment node is selected, the following tabs are shown in the Data Panel:
Input Screen (Figure 1)
· Equipment Information: Equipment Identification Analysis options, Design Conditions, and Equipment Geometry
· Operating Conditions: Equipment operating parameters and COF model identification
· Component Tables: Design view of all Components within the Equipment
· Failure Consequence: RBI parameters for assessing COF

Figure 1 - Equipment Within a Unit Input Screen

Output Screen (Figure 2)


· Inspection Planning: Inspection Plan Summary for all Components within the Equipment
· Inspection Recommendation: Specifies Inspection Type and Coverage required to satisfy the Inspection Plan
· RBI Date Risk Details: RBI output calculation of Risk
· Inspection Plan Details: RBI output calculation of Inspection Planning
· Analysis Messages: E2G Method messages for the analysis
· Graphs: RBI Graphs showing Corrosion, Damage, and Risk over time

Component Top Previous Next

Component nodes are directly under Equipment nodes in the API RBI Modules hierarchy. In the Navigation Tree, Component nodes are marked with the icon.

When a Component node is selected, the following tabs are shown in the Data Panel:

Input Screen (Figure 1)


· Design Information: Component Analysis Options, Design Conditions, and Equipment Geometry
· Operating Conditions: Component Operating parameters and COF Model Identification
· Inspection Planning: RBI target parameters
· Consequence of Failure: RBI parameters for assessing COF
· Damage Mechanisms: Assesses component Damage and POF
· Inspection History: Allows for adding of Inspection History
· PRD Settings: RBI parameters used only for the RBI PRD

Figure 1 - Components Within Equipment

Output Screen (Figure 2)


· Inspection Plan: Summary of recommended inspection activities
· Inspection Recommendations: Specifies inspection type and coverage required to satisfy inspection plan
· RBI Date Risk Details: RBI output calculation of Risk
· Inspection Plan Details: RBI output calculation of Inspection Planning
· Graphs: RBI Graphs showing corrosion, damage, and risk over time

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 5

Valid Equipment and Component Combinations


To create a new Equipment type, right-click on the Unit and select a piece of Equipment from the New menu. The user will be prompted with the Equipment Designer, which allows
select the number and type of Components to attach to the piece of Equipment. Components can also be added later by right-clicking on the Equipment node and selecting the
Component from the New menu.

The possible combinations of Equipment and Components are as foolows:

· Horizontal Vessel (Drum)


· Head (max 2)
· Shell Section (max 50)
· Nozzle (max 10)

· Vertical Vessel (Tower)


· Top Head (yes/no)
· Shell Section (max 50)
· Bottom Head (yes/no)
· Nozzle (max 10)

· Heat Exchanger (Shell and Tube Bundle)


· Front End (yes/no)
· Shell Section (max 50)
· Tube Bundle (max 25)
· Rear End (yes/no)
· Nozzle (max 10)

· Air Cooler
· Tube Section (max 10)
· Head Box (max 50)
· Nozzle (max 10)

· Boiler
· Tube Section (max 1)
· Head (max 2)
· Shell Section (max 10)
· Nozzle (max 10)

· Fired Heater
· Heater Box (yes/no)
· Tube Section (max 10)

· Piping System
· Pipe (max 50)

· Storage Tank
· Tank Roof (yes/no)
· Tank Course (max 20)
· Tank Bottom (yes/no)

· Process or Storage Sphere


· Shell Section (max 50)

· Rotating Equipment
· Shell Section (max 50)

· PRD Equipment
· Shell Section (yes/no)
· Pipe (yes/no)

Inspectable Equipment Top Previous Next

Inspectable Equipment nodes are directly under Unit nodes in the Physical Modules hierarchy. Multiple Inspectable Equipment nodes can be attached to one Unit. In
the Navigation Tree, Inspectable Equipment nodes are marked with the icon.

Inspectable Equipment nodes are Physical Modules that fall outside one of the core API RBI Equipment types. They will generate Interval Based Inspections
recommendations.

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 6

Figure 1 - Inspectable Equipment

Inspectable Component Top Previous Next

Inspectable Component nodes are directly under Equipment nodes in the Physical Modules hierarchy. In the Navigation Tree, Inspectable Component nodes are
marked with the icon.

Inspectable Components are Physical Modules that fall outside one of the core API RBI Component types. They will generate Interval Based Inspections
recommendations.

Figure 1 - Inspectable Component

Bundle Top Previous Next

Bundle nodes are directly under Equipment nodes in the APIRBI Modules hierarchy. Bundles can only be added to heat exchangers and are marked with the icon.
When a Component node is selected, the following tabs are shown in the Data Panel:
Input Screen (Figure 1)
· Bundle Details: Basic Bundle RBI details
· Bundle Reliability Database: Bundle matching parameters for Weibull curve fitting
· Risk Analysis: RBI Risk parameters
· Inspection History: Input for adding inspection history

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 7

Figure 1 - Bundle Input Tab

Output Screen (Figure 2)


· Inspection Planning: Dashboard for Inspection Planning Summary of the bundle
· TAR Cost Benefit: Results of RBI Cost Benefit calculation
· Optimal Replacement: Results of RBI calculation for Optimal Replacement
· Bundle RBI Details: RBI Calculation output details
· Weibull Plot: Shows the base fit Weibull curve along with uncertainty fit curve
· Graphs: RBI Graphs showing corrosion, POF, and Risk over time

Figure 2 - Bundle Output Tab

Heater Box Top Previous Next

Heater Box nodes are directly under Equipment nodes in the APIRBI Modules hierarchy. Heater Boxes can only be added to Fired Heaters and are marked with the icon

When a Heater Box node is selected, the following tabs are shown in the Data Panel:
Input Screen (Figure 1)
· Design Information: Component Identification Analysis options, Design Conditions, and Equipment Geometry
· Operating Conditions: Component Operating parameters and COF Model Identification.
· Consequence of Failure: RBI parameters for assessing COF
· Heater Management: Management System Factor and RBI target parameters

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 8

Figure 1 - Fired Heater Box Component - Input

Output Screen (Figure 2)


· Inspection Plan: Summary of the Recommended Management Improvements
· Fluid Properties: Results from Fluid Modeler
· Consequence of Failure Results: Results from RBI COF Calculation
· Risk Results: Results of RBI Risk Calculation
· Management Recommendation: Detailed recommendations

Figure 2 - Fired Heater Box Component - Output

PRD Top Previous Next

Pressure Relief Device (PRD) nodes are directly under Unit nodes in the Plant Module hierarchy. In the Navigation Tree, PRD nodes are marked with the icon.

When a PRD node is selected, the following tabs are shown in the Data Pane:
Input Screen (Figure 1)
· PRD Design: PRD Identification Analysis options, Design Conditions, and Equipment Geometry
· Protect Components: Assign/remove Protected Components
· Demand Cases: Active and assign Demand Cases
· Inspection History: Input for adding Inspection History's
· Risk Analysis: RBI Target and Leakage Cost parameters
· PRD Identification: PRD information that is not used in PRD calculation

Figure 1 - PRD Component

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 9

Output Screen
· PRD Results Plant: Summary of Inspection Plan highlighting the Recommended Inspection Interval
· PRD Results: RBI output calculation of FTO and Leak Risk

API RBI Tools Top Previous Next

A set of features within the API RBI module of PlantManager that will simplify the workflow, as well as standardize the routine. These include:

· Batch Apply Unit Defaults

· Bulk Edit Inspection History

· Bundle Filtering

· Custom Materials and Relationships

· Fluid Designer

· Inventory Groups

· Inspection Category Editor

· Risk Matrix Editor

Batch Apply Unit Defaults Top Previous Next

Batch Apply Unit Defaults allows the user to set the RBI parameters for all Component nodes attached to the selected Unit node. The right-click menu for a Unit
node includes the Batch Apply Component Unit Defaults option. This feature enables changes to large sets of data at one time. It is available for Equipment,
Components, Bundles, and PRDs.

Some Components will still require additional information after using Batch Apply Unit Defaults.

Figure 1 - Accessing the Batch Apply Component Settings Option

Figure 2 - Batch Apply Component Settings Dialog Box

Bulk Edit Inspection History Top Previous Next

Bulk Edit Inspection History allows the user to input and grade many inspection histories easily. This feature was created to enable the input of many inspections
reports as once. Some of the features include the ability to quickly add new inspection dates and “quick” comments all in a convenient form. The Bulk Edit
Inspection History functionality can be used for all types of assets within the APIRBI module, including pressure vessels, Tanks, PRVs, and bundles.

Opening Bulk Edit Inspection

Bulk Edit Inspection History can be only be accessed at the Unit level on the navigation tree. After a unit node has been selected, the Bulk Edit Inspection icon in the
toolbar becomes available . This feature can also be accessed using the right-click option on the Unit node (Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 10

Figure 1 - Bulk Edit Inspection Dialog Box

Adding/Editing?Removing Bulk Edit Inspections

To begin editing or adding to the list of inspection histories, first select the desired component in the Components screen in the left pane of the window. This list can
be filtered down further by hovering over either the Equipment or Component column headers and selecting the small filter icon (Figure 1).

Figure 1 - Bulk Edit Inspection Editing

To Add an Inspection History to a component, select the Add New Date button at the bottom of the list of Inspection Histories (Figure 2). This will pop up a box in
which the date of the inspection should be entered (Figure 3). The Keep this date in the list option can be selected if additional new histories for other components
using the same Inspection Date and that inspection date will appear unchecked on the inspection list for all components ready to be added.

Figure 2 - Add New Date Figure 3 - New Inspection Date

To Remove an Inspection History from a component, select the desired inspection history date, and click the Remove Date button. To Edit an Inspection History for a
component, select the desired inspection date from the list and edit the date, inspection effectiveness’s, or inspection comments (Figure 4).

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 11

Figure 4 - Editing/Removing An Inspection

To the right of the Comments box for any individual inspection history, there is a button called Quick; clicking this button reveals a pop-up window that enable a
comment to be created that can be inserted into the Inspection History Comments box for a particular Inspection History. Once the quick comment is formed, check
the box to the left of the comment description and click Pick to add the quick comment to the Inspection History Comments box (Figure 5).

Figure 5 - Quick Comments Box

Saving Bulk Edit Inspections

Once the Inspection Histories have been added or edited for a particular component, click the Save button to save the data and remain on the current component or
the Save and Next to save the current components inspection history data and move to the next component in the list. The Undo button will undo any changes made
to the Inspection Histories for the current component.
After making the needed changes to the Bulk Edit Inspection History form, the window can be closed. All affected components need to be recalculated to update the
RBI Analysis.

Bundle Filtering Top Previous Next

Bundle Filtering is the most important tool for the HX Tube Bundle RBI Module. Filtering is required to create a Weibull plot of similar HX Tube Bundles. Once the
plot is created, the POF of the bundle can be calculated, which is used to determine Risk. The filtered data of exchangers can be sources from the Current exchanger,
all the bundles in PlantManager, from a generic database or from all sources (Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 12

Figure 1 - Bundle Filter Tab

The Bundle Matches Tab shows the user the matched HX Tube Bundles. These bundles will be used to determine the characteristic life of the bundle, which is used to
calculate Risk. The user can remove a particular Bundle in the list if that particular bundle is a poor fit (Figure 2).

Figure 2 - Bundle Matches Tab

Custom Materials and Relationships Top Previous Next

Material properties based on the Code, Specification, and Design Temperature are displayed on the Design Information tab and has a customization feature (Figure
1). Enabling the Custom Material feature
provides the ability to modify the physical properties of the material. This includes:

· Material Type
· Allowable Stress
· Yield Stress
· Tensile Stress
· Modulus of Elasticity
· External Pressure Chart
· Impact Test Exemption Curve
· Impact Test Temperature

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 13

Figure 1 - Custom Materials

Material type relationships:


· Equipment or Component type, Cladding, and Damage Mechanism
· Thinning Supplements

Material Relationships
Damage Mechanisms By Material

Damage Mechanism Equipment Materials Cladding

Internal thinning All All Yes


Equipment lining Non-Rotating All Yes
Mechanical fatigue Pipe All Yes
Brittle fracture All CS,LC,CI,NF Yes
Temper embrittlement Non-Tank LC Yes
885 embrittlement Non-Tank HC Yes
Sigma embrittlement Non-Tank HA,DP Yes
External atmospheric thinning All CS,LC Yes
External other thinning All All Yes
External cracking All HA,HC,NI,DP,AL Yes
HTHA Non-Tank CS,LC Yes
Amine cracking Non-Boiler CS,LC No
Carbonate cracking Non-Boiler CS,LC No
Caustic cracking All CS,LC,NI,HA,DP Yes
Chloride cracking All HA,HC,NI,DP,AL,NF Yes
H2S HIC Non-Boiler CS,LC No
HF HIC Non-Boiler CS,LC,NI No
Hydrogen stress cracking Non-Boiler CS,LC No
PTA cracking Non-Tank HA,DP,NF Yes
Sulfide stress cracking Non-Boiler CS,LC No
Other cracking All All Yes

Thinning Supplements By Material

Thinning Supplement Materials

Hydrofluoric acid CS,NI,LC


Sulfuric acid CS,LC,HA,NI
Acid sour water All
Amine CS,LC,HA,NI,HC,DP
Sour water All
H2\H2S CS,LC,HC,HA

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 14

Naphthenic acid CS,LC,HC,HA


Hydrochloric acid All
Cooling water All
CO2 CS,LC,HC
Soil All
Oxidation All

Material Nomenclature

Material Nomenclature

CS Carbon steel
LC Low chrome
NI Nickel alloy
NF Non-ferrous
HA High alloy
HC High chrome
DP Duplex stainless steel
AL Aluminum alloy
TI Titanium alloy
CU Copper alloy
ZR Zirconium alloy
CI Cast iron

Fluid Designer Top Previous Next

The Fluid Designer is located at the Corporation level. Custom fluids can be created which then can be used in an API RBI analysis that utilizes the New(Level2)
Consequence model (Figure 1).

Figure 1 - Fluid Designer Dialog Box

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 15

Designing a Fluid

To create a new fluid, click the Add button and the Fluid Designer Details dialog box will open (Figure 1).

The makeup of the fluid is modified under the Fluid Component section. The chemical can be selected from the Fluid Component drop-down menu. Enter the percent
composition and select the Add Component button. Components need to be added until the percent composition sums to 100.

To edit a component after it has been added, click on the edit icon . To delete a component after it has been added, click on the delete icon . The Fluid Cost
(in dollars per pound) and Basis (in Moles or Mass) are optional fields. The Fluid Designer checks that the percent composition equal to 100% and if not it will present
a prompt.

Figure 1 - Adding/Editing/Deleting Fluids

If a custom fluid resembles a pre-existing fluid, it can be copied by selecting the fluid from the list and clicking the Copy button. A Copy dialog box will appear where
the new Fluid Name can be inserted (Figure 2).

Figure 2 - Coping a Fluid

Fluid Import/Export

The Importing/Exporting of fluids will allow the editing and validation of fluids using an excel spreadsheet. The can only be used with custom fluids (Figure 1).

Figure 1 - Fluid Export

Inventory Groups Top Previous Next

Inventory Groups define how much fluid is available for release and this affects the consequences. Logical breaks between process vessels should be made. Inventory
is calculated or estimated based on input data available for inventory group, length (height), and diameter (Figure 1).

Figure 1 - Inventory Groups

Configuring Inventory Groups

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 16

Inventory Groups are defined at the unit level (Figure 2). Components can only belong to one inventory group. In order to create an Inventory Group:

1. Either select the Add Inventory Group button or right-click in the white area and select Add Inventory Group (Figure 3).
2. Enter a name and define the Isolation
3. Define equipment in the group by adding Available Components.
4. Click Save.

Figure 2 - Inventory Group Parts

Figure 3 - Adding An Inventory Groups

Inventory Group Drawing Example

Inventory groups should be assigned based on logical breaks between process vessels. Most comment breaks include physical barriers commonly seen between
exchanger SS/TS or isolatable barriers such as isolation valves, block valves, compressors and/or turbines. It is recommended to determine these barriers by
reviewing the Process Flow Diagram (Figure 1).

Figure 1 - Process Flow Diagram Example

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 17

Inspection Category Editor Top Previous Next

The Inspection Category Editor allows for the customization of the Inspection Effectiveness Criteria. Updating this information ensures the correct recommendation
will be populated on the Inspection Planning screen for a component (Figure 1).

Updating the Non-Intrusive Inspection section ensures the appropriate inspection requirements (inspection technique, coverage, etc.) will be recommended on the
component output (Figure 2).

Figure 1 - Inspection Category Editor

Figure 2 - Inspection Category Editor Output Screen

Risk Matrix Editor Top Previous Next

The Risk Matrix Editor is located on the output at the Unit level and displays a graphical representation of the RBI date and Plan date with and without
inspection. These matrices contain all of the components within a specific Unit. The are two styles of plots, either Risk Matrix or ISO-Risk Plot. The
design of the plots and break-points can be customized to almost any parameter from the risk dimensions, to the risk category and color convention.

To change the existing layout either select the Risk/Iso-risk Plot Editor button located on the Risk Matrices tab located in the Output on the Unit or by
selecting one of the editors from the Tools menu (Figure 1).

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


API RBI Page 18

Figure 1 - Risk Matricies

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:10 PM


SagePlus Page 1

SagePlus Top Previous Next

SagePlus offers a large collection of analysis modules which run within the PlantManager platform and incorporates the following standards:

· API 520, 530, 579, 620, 650, 653


· ASME Section VIII Div 1, Section VIII Div 2, B16.5, B16.47, B31.1, B31.3, B31.4, B31.8, B36.10, B36.19
· WRC 107, 537, 541
· ASCE7, ASI210, TEMA, AISC, EN13445, IIW, Zicks 1972
The Software integrates materials from the Codes and ASME Section II, D.
The SagePlus Analysis modules address the following Engineering Disciplines:
Construction Code Equipment Specialty In-Service Evaluation
· Pressure Vessels · Specialty Bolted Connections
· Shell and Tube Heat Exchangers · Hot Taps
· Air Cooler Heat Exchangers
· Storage Tanks Stress Analysis
· Piping · Design by Analysis
· Fired Heaters · FAST Stress Analysis
· Power Boilers
Process Safety
Fitness-for-Service · Consequence Analysis
· Advanced Fracture Mechanics · Overpressure Protection
· API 579 \ ASMI FFS-1 Level 1 or 2
· Specialty High Temperature Creep Material Properties
· High Temperature Hydrogen Attack
Fluids and Heat Transfer

Additional Topics
Parametric Studies
Module Creating Instructions - SagePlus - Creating a Module
Calculation Instructions - Initiate a Calculation, View Progress and View Calculated Results

SagePlus - Creating a Module Top Previous Next

A Sage Analysis Module can be created any of the following ways:

Creating a Module using the Right Click Menu


Creating a Module within a Folder (See Figure 1)
1. Right-click on the folder within the Navigation Tree to initiate the right-click menu.
2. Select New and follow the menu options to create the analysis module.

Figure 1 - Creating a Module within a Folder


Creating a Child Module Under a Parent Module (See Figure 2)
Some module types can be connected to a module in a Parent \ Child type relationship. In these cases, the Child module inheres common keyword values
from the parent eliminating the need for duplicate data entry.
1. Right-click on the Parent Module within the Navigation Tree to initiate the right-click menu.
2. Select New and select the specific child module (Note - The right-click menu will only display children that can be connected to the selected parent)

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 2

Figure 2 - Creating a Child Module Under a Parent Module

Creating a Module by Dragging and Dropping an Input File


You can drag and drop a saved module input file into a folder (See Figure 3). Once the input file is dropped into the folder the Analysis Module will be
automatically created within the folder

Figure 3 - Using Drag and Drop to Create a Module.

Parametric Study Overview Top Previous Next

Parametric Study Overview


Parametric Studycapability is available for all SagePlus analysis modules. It provides the ability to easily perform sensitivity studies for all available engineering
calculations. Activating this feature for an analysis module enables a user to select one or more input keywords that can be varied for each analysis case. Output
results can also be individually selected. The Parametric study is presented as an easily exported table of the selected inputs and outputs for each analysis case.

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 3

Figure 1 - Parametric Study Process

Parametric Study Process


Using Parametric Studies as part of your analysis is a five step process. (See Figure 1)

Enable a Parametric Study


A Parametric Study is enabled at the Sage Analysis Module level in the Navigation Tree and honor the parent/child relationship.
To enable Parametric Studies for a specific module, right-click on the module in the Navigation Tree and select the right-click menu option: Enable Parametric
Studies.
The Parametric Study Flag ( ) will appear in the Navigation Tree, and a Data and Parametric Study tab will be added to the form (See Figure 2).

Figure 2 - Enabling a Parametric Study

Select Input Keyword to the Parametric Study


Select the specific input keywords that you wish to add as part of the Parametric Study. These are the keywords that will be different in each Parametric Study
row valculation.
To select an input keyword to be part of the Parametric Study, select the Data tab and locate the input keyword you wish to add to the study. Right-click on
the keyword data value and select Add to Parametric Study
The Parametric Study flag ( ) will appear next to the keyword and on the Input Data tab, which will make it easy to identify the locations of the input
keywords included in the study, and the keyword is added to the Parametric Study (See Figure 3).

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 4

Figure 3 - Adding a Keyword to a Parametric Study


Set Varying Input Values
Each row in the Parametric Study table drives a unique Sage calculation. By varying the selected input values with each execution (all other values under the
Data tab will remain unchanged with each execution), you are easily able to see how the output values change.

Toggle to the Parametric Study Tab


The row with italicized values in the input table is the main row for the Parametric Study. These values cannot be changed using the Parametric Study
tab. To change the main row, you must toggle to the Data tab.

Input values can be entered by one of the following methods:


1. Entering the varying values directly into the Parametric Study table (See Figure 4)
· Select the Add Row button (lower right corner of the form).
· Update the values in the newly added row.

Figure 4 - Enter Values Directly into the Parametric Study Table

2. Copying from Excel and Pasting into the Parametric Study Table (See Figure 5).
· Add a row to the Parametric Study table (this is necessary because you cannot paste into the main record).
· Copy values from Excel.
· Right-click on the row selector of the newly added row and select Paste.
You cannot paste into the main row since these values cannot change within the Parametric Study table.

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 5

Figure 5 - Copy from Excel and Paste into the Parametric Study Tab

Calculate the Parametric Study


The main row (row in italics), which ties to the data on the Data tab, must calculate prior to calculating other Parametric Study cases.

A Parametric Study is calculated using the same steps as any Sage module.
See the following Help Topic Links:
Initiating a Calculation
Viewing Calculation Progress
Once calculated, the Status column will indicate if it completed successfully (See Figure 6).

Figure 6 - Calculated Parametric Study

Select Output Keywords and View Results.


Adding targeted output keywords to the Parametric Table makes it to view calculations that result from each varied input value.
Complete the following steps to add output Keywords (See Figure 7)
1. Toggle to the Parametric Study tab
2. Click Select Output to initiate the output Keyword list
3. Select the specific output keywords to be included from the output keyword list. The folders in the Keyword picker are organized by the output tabs
that are viewable on the Output Form.

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 6

Figure 7 - Adding Output Keywords

The data within the Parametric Study table can be Copied and Pasted into Excel, Word, etc to aid in report generation.

You can view the detailed output for any line in the Parametric Study by selecting the button at the far right of each Parametric Study line.

You can view error and warning messages by clicking the Status Link. The link will show calculation errors or warnings.

Construction Code Equipment Top Previous Next

The SagePlus Construction Code Equipment Analysis Modules address the following
Pressure Vessels
The analysis modules available in the Pressure Vessels package enable users to perform both design and in-service evaluations of pressure vessels.
Full pressure vessel equipment analysis
· ASME Section VIII horizontal vessels (drums) HVESS
· ASME Section VIII vertical vessels (towers) TOWER
Individual pressure vessel component analysis
· ASME Section VIII shell sections and formed heads SHELL
· ASME Section VIII conical shell transitions STRAN
· Custom ASME Section VIII girth flanges FLANGE
· ASME Section VIII nozzle and standard B16.5 flange connections NOZZLE, FLANGE
· Internal/External Bolted Heads BHEAD
· ASME Section VIII integral flat heads with large openings OFLATHD
· WRC 537 nozzle stress analysis BIJLAARD
· WRC 537 lug attachments BIJLAARD
· Refractory and insulation evaluation TANAL
Shell and Tube Heat Exchangers
The analysis modules available in the Shell and Tube Heat Exchangers package enable users to perform both design and in-service calculations for heat exchanger
components.
· Tubesheet TUBESHEET
· Internal/External Bolted Heads BHEAD
· ASME Section VIII shell, channel, or tube sections SHELL
· ASME Section VIII conical shell transitions STRAN
· Custom shell and channel ASME Section VIII girth flanges FLANGE
· ASME Section VIII nozzle and standard B16.5 flange connections NOZZLE, FLANGE
· Bellow and flanged and flued type expansion joints BELLOW
· Tube vibration evaluation HETVIB
· Analysis of Shell and Tube Heat Exchangers per ASME Section VIII or TEMA EXCHANGER
Air Cooler Heat Exchangers
The analysis modules available in the Air Cooler Heat Exchangers package enable users to perform design and in-service evaluations of air coolers.
· ASME Section VIII header boxes NCPV
Storage Tanks
The analysis modules available in the Storage Tanks package enable users to perform design and in-service evaluations of storage tanks.
· API 650 and API 620 tank design or in-service evaluation TANK
· API 653 in-service tank evaluation and settlement TANK, TANKSETT
· Tank settlement top ovalization evaluation TANKSETT

Piping
The analysis modules available in the Piping package enable users to perform both design and in-service evaluations of piping components.
· B31 Pipe section evaluation APIPE
· Pipe elbow flexibility and stress analysis ELBOW
· B31 branch or extruded header evaluation APIPE
· B16 flange ratings FLANGE
· B16 flange stress analysis FLANGE

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 7

· Pipe span evaluation APIPE, PIPERETIRE


· WRC pipe lug evaluation WRCLUGS
· Standard piping class definition PCLASS
· Bellows type expansion joints BELLOW
· Refractory and insulation evaluation TANAL
· Steam tracing evaluation TRACING
Fired Heaters
The analysis modules available in the Fired Heaters package enable users to perform both design and in-service evaluations of fire heaters.
· API RP530 heater tube design and remaining life RP530
Power Boilers
The analysis modules available in the Power Boilers package enable users to perform both design and in-service evaluations of boilers
· ASME Section I boiler and tube design SHELL, APIPE

Pressure Vessels Top Previous Next

The analysis modules available in the Pressure Vessels package enable users to perform both design and in-service evaluations of pressure vessels.

Pressure Vessels
Full pressure vessel equipment analysis
ASME Section VIII horizontal vessels (drums) HVESS
ASME Section VIII vertical vessels (towers) TOWER
Individual pressure vessel component analysis
ASME Section VIII shell sections and formed heads SHELL
ASME Section VIII conical shell transitions STRAN
Custom ASME Section VIII girth flanges FLANGE
ASME Section VIII nozzle and standard B16.5 flange connections NOZZLE, FLANGE
Internal/External Bolted Heads BHEAD
ASME Section VIII integral flat heads with large openings OFLATHD
WRC 537 nozzle stress analysis BIJLAARD
WRC 537 lug attachments BIJLAARD
Refractory and insulation evaluation TANAL

Shell and Tube Heat Exchangers Top Previous Next

The analysis modules available in the Shell and Tube Heat Exchangers package enable users to perform both design and in-service calculations for heat exchanger
components.

Shell and Tube Heat Exchangers


Individual shellside or tubeside exchanger component analysis

Tubesheet TUBESHEET
Internal/External Bolted Heads BHEAD
ASME Section VIII shell, channel, or tube sections SHELL
ASME Section VIII conical shell transitions STRAN
Custom shell and channel ASME Section VIII girth flanges FLANGE
ASME Section VIII nozzle and standard B16.5 flange connections NOZZLE, FLANGE
Bellow and flanged and flued type expansion joints BELLOW
Tube vibration evaluation HETVIB
Analysis of Shell and Tube Heat Exchangers per ASME Section VIII or EXCHANGER
TEMA

The analysis modules available in the Air Cooler Heat Exchangers package enable users to perform design and in-service evaluations of air coolers.

Air Cooler Heat Exchangers


ASME Section VIII header boxes NCPV

Storage Tanks Top Previous Next

The analysis modules available in the Storage Tanks package enable users to perform design and in-service evaluations of storage tanks.

Storage Tanks
API 650 and API 620 tank design or in-service evaluation TANK
API 653 in-service tank evaluation and settlement TANK, TANKSETT
Tank settlement top ovalization evaluation TANKSETT

Piping Top Previous Next

The analysis modules available in the Piping package enable users to perform both design and in-service evaluations of piping components.

Piping
B31 Pipe section evaluation APIPE
Pipe elbow flexibility and stress analysis ELBOW
B31 branch or extruded header evaluation APIPE
B16 flange ratings FLANGE
B16 flange stress analysis FLANGE
Pipe span evaluation APIPE, PIPERETIRE

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 8

WRC pipe lug evaluation WRCLUGS


Standard piping class definition PCLASS
Bellows type expansion joints BELLOW
Refractory and insulation evaluation TANAL
Steam tracing evaluation TRACING

Fired Heaters Top Previous Next

The analysis modules available in the Fired Heaters package enable users to perform both design and in-service evaluations of fire heaters.

Fired Heaters
API RP530 heater tube design and remaining life RP530

Power Boilers Top Previous Next

The analysis modules available in the Power Boilers package enable users to perform both design and in-service evaluations of boilers.

Power Boilers
ASME Section I boiler and tube design SHELL, APIPE

Material Properties Top Previous Next

The SagePlus Material Property Analysis Modules address the following


Material Properties
The analysis modules available in the Material Properties Package enable users to look up material information for a large variety of ASTM specifications based on
a design or post-construction Code. Typical material information includes allowable stress, physical properties, material dependent damage models, and much
more.
· Material properties database MATDAT
· Charpy v-notch post processing CHARPYH

Material Properties Top Previous Next

The analysis modules available in the Material Properties Package enable users to look up material information for a large variety of ASTM specifications based on
a design or post-construction Code. Typical material information includes allowable stress, physical properties, material dependent damage models, and much
more.

Materials Properties
Material properties database MATDAT
Charpy v-notch post processing CHARPYH

Fitness-for-Service Top Previous Next

The SagePlus Fitness-for-Service Analysis Modules address the following


Advanced Fracture Mechanics
The analysis modules available in the Advanced Fracture Mechanics Package enable users to determine the fitness-for-service of components containing crack-like
flaws using the assessment procedures in API 579, Section 9. The Failure Assessment Diagram (FAD) is used in API 579 for the evaluation of crack-like flaws in
components.
· Level 3 brittle fracture screening CLFLAW
· Crack like flaw evaluation for arbitrary loading CLFLAW
· API 579-1/ASME FFS-1 static crack-like flaws CLFLAWCG
· Crack Ductile Tearing Analysis CLFLAWTA
· API 579 Part 9 Crack Like Flaw Level 1 screening curves CLFLAWL1

API 579-1/ASME FFS-1, Level 1 or 2


The analysis modules available in the API 579/ASME FFS-1 Level 1 or 2 package enable users to perform fitness-for-service analyzes on pressure vessels, piping,
and storage tanks per API 579/ASME FFS-1.
Note that the APIFFS module cannot be attached to a Folder. It must be attached to an SHELL, APIPE, or TANK.
· Level 1 SHELL, APIPE, TANK, APIFFS, APIFFSB
· Level 2 APIFFS, APIFFSB
Specialty High Temperature Creep
The Specialty High Temperature Package is used to perform creep damage and remaining life estimation on high temperature components, based on the Larson
Miller and MPC Omega methods using analytical formulations (LIFER and CREEPALLOW), finite element analysis (TUBELIFE), or probabilistic analysis (PROBANAL).
· Creep fatigue evaluation CFDAMAGE
· ASME Section III, Subsection NH evaluation LIFER
· Creep temperature-stress limits CREEPALLOW

High Temperature Hydrogen Attack


The analysis modules available in the High Temperature Hydrogen Attack package can be used to analyze the effects of hydrogen diffusion in pressurized
equipment.
· Hydrogen diffusion TSDANAL

Advanced Fracture Mechanics Top Previous Next

The analysis modules available in the Advanced Fracture Mechanics Package enable users to determine the fitness-for-service of components
containing crack-like flaws using the assessment procedures in API 579, Section 9. The Failure Assessment Diagram (FAD) is used in API 579
for the evaluation of crack-like flaws in components.

Advanced Fracture Mechanics

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 9

Level 3 brittle fracture screening CLFLAW


Crack like flaw evaluation for arbitrary loading CLFLAW
API 579-1/ASME FFS-1 static crack-like flaws CLFLAWCG
Crack Ductile Tearing Analysis CLFLAWTA
API 579 Part 9 Crack Like Flaw Level 1 screening CLFLAWL1
curves

API 579/ASME FFS-1 Level 1 or 2 Top Previous Next

The analysis modules available in the API 579/ASME FFS-1 Level 1 or 2 package enable users to perform fitness-for-service analyzes on pressure vessels, piping,
and storage tanks per API 579/ASME FFS-1.

Note that the APIFFS module cannot be attached to a Folder. It must be attached to an SHELL, APIPE, or TANK.

API 579-1/ASME FFS-1, Level 1 or 2


Level 1 SHELL, APIPE, TANK, APIFFS
Level 2 APIFFS
API 579 Fitness-for Service for Nozzles and APIFFSB
Flanges

Specialty High Temperature Creep Top Previous Next

The Specialty High Temperature Package is used to perform creep damage and remaining life estimation on high temperature components, based on the Larson
Miller and MPC Omega methods using analytical formulations (LIFER and CREEPALLOW), finite element analysis (TUBELIFE), or probabilistic analysis (PROBANAL).

Specialty High Temperature Creep


Creep fatigue evaluation CFDAMAGE
ASME Section III, Subsection NH evaluation LIFER
Creep temperature-stress limits CREEPALLOW

High Temperature Hydrogen Attack Top Previous Next

The analysis modules available in the High Temperature Hydrogen Attack package can be used to analyze the effects of hydrogen diffusion in pressurized
equipment.

High Temperature Hydrogen Attack


Hydrogen diffusion TSDANAL

Specialty In-Service Evaluation Top Previous Next

The SagePlus Specialty In-Service Evaluation Analysis Modules address the following
Specialty Bolted Connections
The Specialty Bolted Connections Package can be used to analyze the stresses in clamp-type flange connections used in piping or pressure vessels in accordance
with the ASME Pressure Vessel Code, Section VIII.
· Clamped connections CLAMP
· Flange Mating Rotational Analysis OFLANGE
Hot Taps
The Hot Tap Package can be used to optimize process conditions and welding procedures to minimize the probability of failures that are associated with hot
tapping a live pipe, vessel, or tank.
· Hot tap structural evaluation APIPE
· E2G Welding Simulation HOTTAP
· Batelle Welding Simulation HOTTAPTA

Specialty Bolted Connections Top Previous Next

The Specialty Bolted Connections Package can be used to analyze the stresses in clamp-type flange connections used in piping or pressure vessels in accordance
with the ASME Pressure Vessel Code, Section VIII.

Specialty Bolted Connections


Clamped connections CLAMP
Flange Mating Rotational Analysis OFLANGE

Hot Taps Top Previous Next

The Hot Tap Package can be used to optimize process conditions and welding procedures to minimize the probability of failures that are associated with hot
tapping a live pipe, vessel, or tank.

Table: Description of Modules Included in Hot Taps Package

Hot Taps
Hot tap structural evaluation APIPE
E2G Welding Simulation HOTTAP
Batelle Welding Simulation HOTTAPTA

Both HOTTAP and HOTTAPTA are used for predicting pipe wall temperature histories during the welding process in hot-tap procedure to avoid two potential
problems: pipe wall burn-through and heat-affected zone cracking. The key feature comparison between HOTTAP and HOTTAPTA are provided in Table below.

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 10

Table: Key Feature Comparison between HOTTAP and HOTTAPTA

HOTTAP HOTTAPTA
Numerical method finite element finite difference
Model node number varied with geometry fixed
Heat source model surface double-ellipsoidal empirical formula based on testing
Required input welding current, voltage, arc efficiency current, voltage, arc efficiency, electrode
parameters diameter and electrode type
Number of fluid selection 1,800 16
Maximum number of fluid 20 1
mixture
Model geometry types Sleeve-to-pipe, branch-to-sphere, weldolet-to- Sleeve-to-pipe, branch-to-sphere
handled sphere, bead-on-plate with bead, bead-on-plate
without bead

Stress Analysis Top Previous Next

The SagePlus Stress Analysis Analysis Modules address the following


Design by Analysis
The analysis modules available in Design By Analysis Package provide users with an analysis toolbox for new design including techniques from ASME Section VIII,
Division 2, Part 5 and also for in-service equipment including techniques from API 579-1/ASME FFS-1, Annex B.
· Stress classification ASMEHP
· Fatigue evaluation FATLIFE
FAST Stress analysis
The FAST Stress Analysis Package can be used for the stress analysis of cylindrical and spherical vessel-to-nozzle intersections.
· Axisymmetric shell evaluation FAST1
· Axisymmetric shell evaluation with asymmetric loading FAST4
· Nozzle stress analysis FAST2

Design by Analysis Top Previous Next

The analysis modules available in Design By Analysis Package provide users with an analysis toolbox for new design including techniques from ASME Section VIII,
Division 2, Part 5 and also for in-service equipment including techniques from API 579-1/ASME FFS-1, Annex B.

Design by Analysis
Stress classification ASMEHP
Fatigue evaluation FATLIFE

FAST Stress Analysis Top Previous Next

The FAST Stress Analysis Package can be used for the stress analysis of cylindrical and spherical vessel-to-nozzle intersections.

FAST Stress analysis


Axisymmetric shell evaluation FAST1
Axisymmetric shell evaluation with asymmetric loading FAST4
Nozzle stress analysis FAST2

Fluids and Heat Transfer Top Previous Next

The SagePlus Fluids and Heat Transfer Analysis Modules address the following
Fluids and Heat Transfer
The analysis modules available in the Fluids and Heat Transfer Package enable users to evaluate steady state or transient heat transfer in pressure containing
components such as cylindrical shells. It also contains a suite of tools that can be used to model fluid or mixture physical properties and behavior.
· Fluid property modeler MIXER
· Steady state heat transfer TANAL
· Vessel refractory and insulation design TANAL
· Transient Heat Transfer TSDANAL
· Hydrogen diffusion TSDANAL
· ASCE 7 wind pressure calculator PWIND
· Steam tracing evaluation TRACING

Fluids and Heat Transfer Top Previous Next

The analysis modules available in the Fluids and Heat Transfer Package enable users to evaluate steady state or transient heat transfer in pressure containing
components such as cylindrical shells. It also contains a suite of tools that can be used to model fluid or mixture physical properties and behavior.

Fluids and Heat Transfer


Fluid property modeler MIXER
Steady state heat transfer TANAL
Vessel refractory and insulation design TANAL
Transient Heat Transfer TSDANAL
Hydrogen diffusion TSDANAL
ASCE 7 wind pressure calculator PWIND
Steam tracing evaluation TRACING

Process Safety Top Previous Next

The SagePlus Process Safety Transfer Analysis Modules address the following
Consequence Evaluation

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM


SagePlus Page 11

The analysis modules available in the Consequence Analysis package enable users to evaluate the consequence of a failure occurring.
· Stored energy of a pressurized system PNENERGY
Overpressure Protection
The analysis modules available in the Consequence Analysis package enable users to evaluate the consequence of a failure occurring.
· Burst pressure evaluation BURSTP
· Tube rupture shock evaluation TBREAK

Consequence Analysis Top Previous Next

The analysis modules available in the Consequence Analysis package enable users to evaluate the consequence of a failure occurring.

Consequence Evaluation
Stored energy of a pressurized system PNENERGY

Overpressure Protection Top Previous

The Overpressure Protection Package is used to estimate the magnitude of the burst pressure for cylindrical and spherical shells, or the effects of the sudden
shock pressure on the shell of a heat exchanger as a result of a sudden tube rupture.

Overpressure Protection
Burst pressure evaluation BURSTP
Tube rupture shock evaluation TBREAK

file:///C:/Users/Lenovo/App... 11/15/2021 1:41:46 PM

You might also like