C H A P T E R
14
Creating a Plant
Breakdown Structure
14-2
Creating a Plant Breakdown Structure
Creating a Plant Breakdown Structure
14-3
14. Creating a Plant Breakdown Structure (PBS) in
SmartPlant Foundation
The composition of the plant is based on the grouping of physical objects by their function
in the plant. The plant usually occupies the top level of the hierarchy and is typically
followed by subsections, such as areas, units, sites, or systems. This is commonly referred
to as the Plant Br eakdown Str uctur e or PBS.
In this chapter, creating a PBS in SPF will be discussed. Once the PBS exists in SPF, it
must be published in order to be retrieved by the authoring tools. This is necessary in
order to synchronize the different authoring tools and SmartPlant Foundation as part using
the SmartPlant environment.
In this class, we will be using SmartPlant P&ID and SmartPlant Instrumentation for our
example. Once you have an understanding of how to publish and retrieve a PBS from SPF
to these two tools, the same concepts and procedure will apply to Aspen Basic
Engineering, SmartPlant 3D, SmartPlant Electrical, and SmartPlant Materials.
Prior to Version 4.2, you were required to use the Plant/Area/Unit hierarchy. This
restriction is no longer in place, however, the following restrictions still apply:
You must apply the structure you create in SmartPlant Foundation across all
authoring tools. For example, if you choose to use the Plant/Area/System
hierarchy, you must use that structure in every tool that will be using SmartPlant.
You cannot select different hierarchies for different authoring tools.
Your structure must consist of at least three levels. You cannot create a structure
that consists of just Plants and Areas.
In this chapter, we will use the Plant/Area/Unit structure for our examples.
Creating a Plant Breakdown Structure
14-4
14.1 Creating a Plant Breakdown Structure in SPF
Start the SmartPlant Foundation Desktop Client.
Defining the SPF Plant Breakdown Structure
Enter the SPF User name and Password to log in to the Desktop
Client.
Creating a Plant Breakdown Structure
14.1.1 Creating a New Plant
The first step is to create a new plant in SmartPlant Foundation.
Defining the SPF Plant Breakdown Structure
From the menu, click File > New > Organization / Support
Items > Plant.
Define properties for the new plant, and then click OK to create it.
Defining the SPF Plant Breakdown Structure
Enter the necessary values for the new plant, and click
Finish.
14-5
Creating a Plant Breakdown Structure
14-6
The new plant appears in the New Items window.
Defining the SPF Plant Breakdown Structure
The new plant is displayed in the New Items window.
Creating a Plant Breakdown Structure
14-7
14.1.2 Setting the Active Scope
Once the plant is created, set the Active Query Scope to the new plant. The active query
scope determines the plant in which your searches take place.
Defining the SPF Plant Breakdown Structure
Set the Create scope to the
new plant, select a role and
query scope. Use the Status
filter to determine what
configurations are available in
the Query scope list.
If you select multiple
configurations from the Query
scope list, you can search for
data in all selected
configurations.
14-8
Creating a Plant Breakdown Structure
The plant you selected appears beside Quer y Scope and Cr eate/Update Scope in the
status bar.
Defining the SPF Plant Breakdown Structure
The new scope of work will be displayed in the Status Bar at
the bottom of the Desktop Client window.
If you have selected more than one role or configuration for
one of the settings on the Set Active Scope dialog box, the
status bar will indicate only that multiple choices were
selected, not a list of all selected roles and configurations.
Creating a Plant Breakdown Structure
14.1.3 Creating a New Area
The first step, once the scope has been set, is to create a new functional area.
Defining the SPF Plant Breakdown Structure
From the menu, click File > New > Organization / Support
Items > Area.
Define properties for the new area, and then click OK to create it.
Defining the SPF Plant Breakdown Structure
Enter the necessary values for the new area, and click
Finish.
14-9
Creating a Plant Breakdown Structure
14-10
The new area appears in the New Items window.
Defining the SPF Plant Breakdown Structure
The new area is displayed in the
New Items window.
Creating a Plant Breakdown Structure
14-11
14.1.4 Creating a New Unit
In the New Items window of the Desktop Client, right-click the area you just created. On
the shortcut menu that appears, click New Unit.
Defining the SPF Plant Breakdown Structure
From the menu, click File > New > Organization / Support
Items > Unit.
Creating a Plant Breakdown Structure
14-12
Define properties for the new unit. Be sure that you define a value for the Unit code
property if you intend to use this PBS in SmartPlant Instrumentation.
Defining the SPF Plant Breakdown Structure
Enter the necessary values for the new unit, and click
Finish.
The new unit appears in the New Items window.
Defining the SPF Plant Breakdown Structure
The new unit is displayed in the
New Items window.
Creating a Plant Breakdown Structure
14-13
14.1.5 Relate the Plant to a Vault
In order to successfully publish the PBS in a later step, the new Plant must be related to a
vault. For the purpose of this chapter, the new Plant is related to the existing
SPFTRN_vault. To find the SPFTRN_vault, use F ind > Administration > Vault. Drag and
drop the vault to the new Madison Plant.
Relate the Plant to a Vault
Drag and drop a vault object to a plant object then, create
the relationship.
Creating a Plant Breakdown Structure
14-14
14.1.6 Register the Plant Breakdown Structure (PBS)
Document
Once the new area and unit have been created for the new plant, you are ready to register
the new PBS with SPF. Being fully integrated, SPF treats itself like any other authoring
tool so you must register the new PBS before attempting to publish process.
As part of the synchronization between SmartPlant Foundation and each of the
engineering or authoring tools, each tool must be registered with SPF. This process
associates a plant in each tool with a plant in SmartPlant Foundation.
Registering Authoring Tools
Being fully integrated, SPF treats itself like any other authoring
tool (such as SmartPlant P&ID or Smart Plant Instrumentation).
You must register the new PBS before attempting the publish
process.
SPF
Authoring
SmartPlant
SPF
Creating a Plant Breakdown Structure
14-15
Defining the SPF Plant Breakdown Structure
Register the PBS in the SPF Desktop Client. From the
menu, click SmartPlant > PBS > Register.
The SmartPlant Registration Wizard appears.
Registering a New Plant in SPF
Enter the SmartPlant Foundation URL, and click Next.
In the SmartPlant Foundation URL field, type the node name and virtual directory of the
SmartPlant Foundation database with which you want to register your plant. Use the
following format: http://<SPFServer>/<VirtualDirectory>. For example,
http://SPFTRAIN/SPFTRN.
14-16
Creating a Plant Breakdown Structure
For the next step, specify the Madison plant that was created earlier.
Registering a New Plant in SPF
Select the plant to register and click Finish.
If the registration is completed successfully, the registration objects appear in the New
Items window, as illustrated below.
Registering a New Plant in SPF
Verify that the plant registration was successful. The new
registration objects appear in the new items window.
Creating a Plant Breakdown Structure
14-17
14.1.7 Publish the Plant Breakdown Structure (PBS)
Document
Once the new area and unit have been created for the new plant, you are ready to publish
the new PBS to make the structure available to the engineering tools.
Defining the SPF Plant Breakdown Structure
Expand the new plant relationships to verify the new area
and unit for this plant.
14-18
Creating a Plant Breakdown Structure
In the SmartPlant Foundation Desktop Client, right-click the plant in the tree view.
Defining the SPF Plant Breakdown Structure
Right-click the plant, and select Publish PBS from the popup menu.
The Publish dialog box appears. Select the revision information for the document to be
published, and then click OK. Make sure the publish process is successful.
Defining the SPF Plant Breakdown Structure
Select the revision information to continue with the
publish operation.
Click OK to run the publish process.
Creating a Plant Breakdown Structure
14-19
14.2 Registering Authoring Tools
As part of the synchronization between SmartPlant Foundation and each of the
engineering or authoring tools, each tool must be registered with SPF. This process
associates a plant in each tool with a plant in SmartPlant Foundation.
Registering Authoring Tools
Before you can publish and retrieve documents from any of
the authoring tools (such as SmartPlant P&ID or SmartPlant
Instrumentation), you must register each plant in the authoring
tool with a SmartPlant Foundation plant database.
Authoring
Tool
SmartPlant
SPF
14-20
Creating a Plant Breakdown Structure
14.2.1 Creating a New SmartPlant P&ID Plant
Several administrative tasks in SmartPlant P&ID are actually conducted in the SmartPlant
Engineering Manager application, including creating new plants and registering them with
SmartPlant Foundation. As a result, in order to create a P&ID plant, register it with SPF,
and retrieve the information from the PBS to correlate the P&ID plant with the SPF Plant.
We will perform all these task using SmartPlant Engineering Manager.
Before you can register a plant in SmartPlant Engineering Manager, you must create the
site and plant, associate applications, and define roles for the plant.
Begin by starting the SmartPlant Engineering Manager application.
Creating a New Plant in SP Eng Mgr
Click Start > All Programs > Intergraph SmartPlant
Engineering Manager > SmartPlant Engineering Manager.
The following steps must be completed before you can register a new plant in SmartPlant
Engineering Manager to be used by the SmartPlant P&ID authoring tool.
Creating a Plant Breakdown Structure
14-21
First, create a new plant structure in SmartPlant Engineering Manager to be associated
with the PBS published from SPF.
Creating a New Plant in SP Eng Mgr
Right-click the Plant Structure node in the tree, and select
New Plant Structure from the pop-up menu.
The New Plant Structure form will appear.
Creating a New Plant in SP Eng Mgr
Select the Use default template radio button, and accept
the Seed location and click Next.
14-22
Creating a Plant Breakdown Structure
Select Hierarchy 7 to create a three-level plant structure. The plant group types in this
hierarchy are defined as Plant, Area, and Unit.
Creating a New Plant in SP Eng Mgr
Select Hierarchy 7 and click Next to create a three-level
hierarchy structure Plant/Area/Unit.
Define the information for the new plant. This information should match what you have
created in SPF.
Creating a New Plant in SP Eng Mgr
Enter the new plant structure root properties, and click
Next.
Creating a Plant Breakdown Structure
14-23
Next define the paths used by this plant. These paths should use the <host>\site UNC
path.
Creating a New Plant in SP Eng Mgr
Specify the appropriate
paths for the plant
structure storage and
backup file locations,
and click Next.
If the specified storage
directory does not exist,
click Yes to create it.
In order to create the necessary Oracle tables, enter the necessary Oracle login
information.
Creating a New Plant in SP Eng Mgr
Enter the Oracle System user name (system) and
password (system).
14-24
Creating a Plant Breakdown Structure
The Oracle username and password information will be filled in for you. Set the
tablespace where you want to add the plant structure.
Creating a New Plant in SP Eng Mgr
Under Oracle tablespace, choose the Users, under Oracle
temp tablespace, choose Temp, and then click Next to
create the new plant schema.
Again, the Oracle username and password information will be filled in for you. Set the
tablespace where you want to add the plant data dictionary.
Creating a New Plant in SP Eng Mgr
Click Next to create the new plant data dictionary.
Creating a Plant Breakdown Structure
14-25
In the New Plant Structure dialog box, note the tasks that will be performed by the setup.
Creating a New Plant in SP Eng Mgr
Choose Finish to complete the setup of the new plant
structure.
Creating a New Plant in SP Eng Mgr
The new Madison plant has been created in SmartPlant
Engineering Manager.
Creating a Plant Breakdown Structure
14-26
Expand the new Madison plant structure.
Creating a New Plant in SP Eng Mgr
Right-click Applications, and select Associate
Applications from the pop-up menu.
Next, associate the new plant with the SmartPlant P&ID application.
Creating a New Plant in SP Eng Mgr
Enable the SmartPlant P&ID toggle, set a reference data
path if necessary, and then click Next.
Creating a Plant Breakdown Structure
14-27
Creating a New Plant in SP Eng Mgr
Accept the default settings, and click Next.
Once again, the Oracle username and password information will be filled in for you. Set
the tablespace where you want to add the SP P&ID schema.
Creating a New Plant in SP Eng Mgr
Confirm the correct information for the SP P&ID schema,
and click Next.
Creating a Plant Breakdown Structure
14-28
Repeat this for the SmartPlant P&ID data dictionary.
Creating a New Plant in SP Eng Mgr
Confirm the correct information for the SP P&ID data
dictionary, and click Next.
In the Associate Applications dialog box, note the tasks that will be performed by the
setup.
Creating a New Plant in SP Eng Mgr
Choose Finish to complete the setup of the new
application settings.
Creating a Plant Breakdown Structure
The new plant is now associated with the SmartPlant P&ID application.
Creating a New Plant in SP Eng Mgr
The SmartPlant P&ID application has been associated with the
new Madison plant.
14-29
14-30
Creating a Plant Breakdown Structure
14.2.2 Registering SmartPlant P&ID with SmartPlant
Foundation
From the Plant Structures node in the tree view, select the plant that you would like to
register. On the SmartPlant menu, click the Register command, which should be
available to you. If it is not available, make sure that you have selected the plant in the
tree view.
Registering a New Plant in SP Eng Mgr
Select the SmartPlant > Register command from the menu.
Creating a Plant Breakdown Structure
14-31
The Specify Map File dialog box will appear.
Registering a New Plant in SP Eng Mgr
Use the browse button to select a map file (if not already
specified), and then click OK.
After you click the Register command, the software displays a dialog box asking you to
specify a map file for SmartPlant Engineering Manager. SmartPlant Engineering Manager
uses this map file to map plant properties from SmartPlant Foundation PBS document to
the plant properties in SmartPlant Engineering Manager.
By default, SmartPlant Engineering Manager places a copy of this schema map file under
your plant structure. To minimize confusion and to avoid having multiple copies of this
file, you can move a copy of the schema map file to a central EFResour ces folder during
SmartPlant P&ID reference data configuration. The following is an example of the
location of the EFResour ces folder: \\efspid1\Sites\RefData\EFResources.
When you select a location for the map file, you can accept the default location without
any problems later with publish and retrieve.
14-32
Creating a Plant Breakdown Structure
After you specify the schema map file for SmartPlant Engineering Manager, the
SmartPlant Registration Wizard appears. The SmartPlant Registration Wizard user
interface is part of the Common UI and is incorporated by all authoring tools from
Intergraph.
Registering a New Plant in SP Eng Mgr
Enter the SmartPlant Foundation URL, and click Next.
In the SmartPlant Foundation URL field, type the node name and virtual directory of the
SmartPlant Foundation database with which you want to register your plant. Use the
following format: http://<SPFServer>/<VirtualDirectory>. For example,
http://SPFTRAIN/SPFTRN.
You may be required to enter your SmartPlant Foundation user name and password before
you can register a plant. You are not required to enter this information if your computer
user name matches a user name in SmartPlant Foundation.
Creating a Plant Breakdown Structure
14-33
For the next step, you will need to know the SmartPlant Foundation plant to which you
are registering. In this example, we will register to the Madison plant that was created
earlier.
In the Plant name list, select the Madison plant.
Registering a New Plant in SP Eng Mgr
Select the plant to register and click Finish.
14-34
Creating a Plant Breakdown Structure
If the registration is completed successfully, the Register With SmartPlant Software
message box appears, as illustrated below.
Registering a New Plant in SP Eng Mgr
Verify that the plant registration was successful.
Creating a Plant Breakdown Structure
14-35
14.2.3 Retrieve the PBS Document from SmartPlant
Foundation
After you register your plant, you can retrieve the PBS document from SmartPlant
Foundation. The PBS document can be used to update the plant and create the appropriate
area and unit.
Retrieving the PBS from SPF
Select the SmartPlant > Retrieve command from the menu.
You may be required to enter your SmartPlant Foundation user name and password before
you can retrieve from SmartPlant Foundation. You are not required to enter this
information if your computer user name matches a user name in SmartPlant Foundation.
Creating a Plant Breakdown Structure
14-36
Select the document associated with the PBS information you defined in SmartPlant
foundation.
Retrieving the PBS from SPF
Select the PBS document to be retrieved, and click OK.
The software displays the retrieve status in the Retrieving message box. When the
document has been retrieved, the software displays a message box to let you know that the
retrieve was successful.
Retrieving the PBS from SPF
The Retrieving dialog box displays the status of the retrieve
operation.
Creating a Plant Breakdown Structure
14-37
14.2.4 Reviewing the Results of the Retrieve
When you retrieve the PBS into SmartPlant Engineering Manager, the Run Tasks dialog
box appears.
Running the Retrieval Tasks
Click OK to run the retrieval tasks.
When you click OK, the software automatically runs all the tasks that are generated by
the retrieve process.
Creating a Plant Breakdown Structure
14-38
In SmartPlant Engineering Manager, you can now see the area and unit that were created
in SmartPlant Foundation and that were added to the new P&ID plant as a result of
retrieving the PBS.
Retrieval Task Results
Expand the tree to display the Madison plant breakdown
structure.
Creating a Plant Breakdown Structure
14-39
Now that the plant has been registered and the PBS retrieved and updated in SmartPlant
Engineering Manager, you can exit the application.
Retrieval Task Results
Select the File > Exit command from the menu to exit
SmartPlant Engineering Manager.
Creating a Plant Breakdown Structure
14-40
14.2.5 Creating a New SmartPlant Instrumentation
Plant
Again, before you can register a plant in SmartPlant Instrumentation, you must create the
plant. For the purposes of this example, these tasks are shown being completed in
SmartPlant Instrumentation.
Begin by starting the SmartPlant Instrumentation Administration module.
Creating a New Plant in SP Instrumentation
Click Start > All Programs
> Intergraph SmartPlant
Instrumentation >
Administration.
Creating a Plant Breakdown Structure
14-41
Log on to SmartPlant Instrumentation using the default user name and password. The
default user name and password are DBA/DBA, and they are not case sensitive.
Creating a New Plant in SP Instrumentation
Enter a valid User name and Password to log in to
SmartPlant Instrumentation Administration.
The Open Administration Module dialog box appears.
Creating a New Plant in SP Instrumentation
Choose the Domain Administrator option, and select the
domain name.
Creating a Plant Breakdown Structure
14-42
Next, open the Plant Hierarchy Explorer window.
Creating a New Plant in SP Instrumentation
In the Domain Administration window, select the Explorer
icon.
The Plant Hierarchy Explorer dialog box appears.
Creating a New Plant in SP Instrumentation
Right-click Plant Hierarchy Explorer, and select New >
Plant from the pop-up menu.
Creating a Plant Breakdown Structure
The Plant Properties (New) dialog box appears.
Creating a New Plant in SP Instrumentation
Enter the necessary new plant values, and click OK.
Next, create a new area for the newly defined Madison plant.
Creating a New Plant in SP Instrumentation
Right-click the Madison plant, and select New > Area from
the pop-up menu.
14-43
Creating a Plant Breakdown Structure
14-44
The Area Properties (New) dialog box appears.
Creating a New Plant in SP Instrumentation
Enter the necessary values for the new area, and click OK.
Finally, create a new unit for the new Area1.
Creating a New Plant in SP Instrumentation
Right-click the area, and select New > Unit from the pop-up
menu.
Creating a Plant Breakdown Structure
The Unit Properties (New) dialog box appears.
Creating a New Plant in SP Instrumentation
Enter the necessary values for the new unit, and click OK.
Review the new plant, area, and unit (PAU) structure that you have just defined in
SmartPlant Instrumentation.
Creating a New Plant in SP Instrumentation
Expand the new plant relationships to verify the new area
and unit for this plant.
14-45
14-46
Creating a Plant Breakdown Structure
Register items by running the command DBA > Data Maintenance > Register Items.
This step is required to keep SmartPlant Instrumentation data up-to-date for integration.
Items are registered in a special table designed to hold references to SmartPlant
Instrumentation items and records with information about user operations, such as
deleting, inserting, and updating.
Creating a New Plant in SP Instrumentation
Select DBA > Data Maintenance > Register Items.
Creating a New Plant in SP Instrumentation
Confirm that you want to register items by clicking Yes.
When the registration is complete, a message indicates
whether the process was completed successfully.
Creating a Plant Breakdown Structure
14-47
14.2.6 Registering SmartPlant Instrumentation with
SmartPlant Foundation
To register the new plant, select SmartPlant > Register from the menu, then, select the
plant.
Registering a New Plant in SPI
Select the SmartPlant > Register command.
Select the plant to be registered, and click OK.
14-48
Creating a Plant Breakdown Structure
The SmartPlant Registration Wizard appears. The SmartPlant Registration Wizard user
interface is the same for other authoring tools.
Registering a New Plant in SPI
Enter the SmartPlant Foundation URL, and click Next.
In the SmartPlant Foundation URL field, type the node name and virtual directory of the
SmartPlant Foundation database with which you want to register your plant. Use the
following format: http://<SPFServer>/<VirtualDirectory>. For example,
http://SPFTRAIN/SPFTRN.
Creating a Plant Breakdown Structure
14-49
For the next step, you need to know the SmartPlant Foundation plant to which you will
register. In this case, register to the Madison plant that was created earlier.
In the Plant name list, select the Madison plant.
Registering a New Plant in SPI
Select the plant to register and click Finish.
14-50
Creating a Plant Breakdown Structure
If the registration is completed successfully, the following message box appears.
Registering a New Plant in SPI
Verify that the plant registration was successful.
Creating a Plant Breakdown Structure
14-51
14.2.7 Retrieve the PBS Document into SmartPlant
Instrumentation
After you register your plant, you can retrieve the PBS document from SmartPlant
Foundation. In this instance, the PBS document will correlate to the plant, area and unit
structure that was defined in SmartPlant Instrumentation.
Retrieving the PBS from SPF
Select the SmartPlant > Retrieve command.
Creating a Plant Breakdown Structure
14-52
The Select Plant dialog box appears.
Retrieving the PBS from SPF
Select the plant to be correlated with the Plant Breakdown
Structure in SPF.
The Correlate plant option will correlate the plant structure in SmartPlant Instrumentation
with the PBS that will be retrieved from SPF. The plant names and structure must match
in order to use the correlate option.
Creating a Plant Breakdown Structure
14-53
The Retrieve dialog box appears, listing the PBS document that was published from SPF.
Retrieving the PBS from SPF
Select the PBS document to be retrieved, and click OK.
The software displays the retrieve status on the Retrieving dialog box. When the
document has been retrieved, the software displays a message box to let you know that the
retrieve was successful.
Retrieving the PBS from SPF
Monitor the retrieve process on the Retrieving dialog box.
Click Close when the notified that the retrieve operation
was successful.
Creating a Plant Breakdown Structure
14-54
Retrieving the PBS from SPF
Click Cancel to close the Select Plant dialog box.
Creating a Plant Breakdown Structure
14-55
14.2.8 Run Tasks in the SmartPlant Instrumentation
To Do List
To see the PBS information and tasks that need to be performed, display the To Do List
window.
Viewing the To Do List
Select the SmartPlant > To Do List command.
Creating a Plant Breakdown Structure
14-56
The To Do List window will be displayed showing all tasks, including those that have
already been run. The tasks without an icon to the left are the new ones resulting from the
latest retrieve and are ready to be executed.
Viewing the To Do List
Highlight the tasks to be executed in the To Do List for the
correlated plant and click Run.
A check mark appears in the left most column of the To Do List when the tasks have
been completed.
Retrieval Task Results
Review the results of the task execution, and click Close.
Creating a Plant Breakdown Structure
14.2.9 Set the Naming Conventions for the New
Plant
On the Domain Administration window toolbar, click the Naming Conventions icon.
Set Naming Conventions for New Plant
Click the Naming Conventions icon.
14-57
Creating a Plant Breakdown Structure
14-58
The Naming Conventions dialog box appears. Select Copy all conventions from the
current < unit> to copy the naming conventions from the current plant to the new plant.
Set Naming Conventions for New Plant
Specify a plant that has naming conventions, select Copy
all conventions from the current <unit> and click Copy To.
Select the new plant configuration and click Copy.
Set Naming Conventions for New Plant
Click to select our newly created plant configuration and
click Copy.
Creating a Plant Breakdown Structure
14-59
14.3 Activity Creating a Plant Breakdown Structure
Complete the Chapter 14 Activity in the SmartPlant Foundation Introduction and
Administration I activity workbook.
14-60
Creating a Plant Breakdown Structure
