Sie sind auf Seite 1von 130

SmartPlant P&ID

Installation and Upgrade Guide

Version 2009 (SP-P&ID 6.0 and SPEM 6.1)

January 2009

DPID2-PE-200014O

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

U.S. Government Restricted Rights Legend


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

Terms of Use
Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("EULA") delivered with this
software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a
valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of
this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee
permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the
software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.

Warranties and Liabilities


All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or its
contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in this
publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable technical
product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this
license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its
affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE
USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should
verify for themselves that the data is accurate and suitable for their project work.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN,
MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft
Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their
respective owners.

Contents
Welcome to SmartPlant ............................................................................................................................. 1
Installation Checklist.............................................................................................................................. 1
Introducing SmartPlant P&ID................................................................................................................ 1
SmartPlant P&ID Program Group ................................................................................................... 2
SmartPlant Engineering Manager .......................................................................................................... 3
SmartPlant Engineering Manager Program Group.......................................................................... 3
Internationalization .................................................................................................................................... 5
Hardware and Software Recommendations............................................................................................. 7
SmartPlant P&ID Database Server ........................................................................................................ 7
SmartPlant P&ID Workstation............................................................................................................... 8
Installing the Software ............................................................................................................................. 11
Setting up the Database............................................................................................................................ 11
Oracle Installation and Configuration.................................................................................................... 12
Configure Oracle Networking Components......................................................................................... 12
Oracle Installation Workflow............................................................................................................... 13
Installing Oracle Database Server ........................................................................................................ 13
Install Oracle 10.2.0.4 Database Server......................................................................................... 13
Create an Oracle Listener..................................................................................................................... 14
Creating an Oracle Instance ................................................................................................................. 14
Requirements for Oracle Instance Creation................................................................................... 15
Create a New Oracle 10.2.0.4 Instance.......................................................................................... 15
Installing Oracle Client ........................................................................................................................ 18
Installing Oracle 10.2.0.4 Client Prerequisites .............................................................................. 19
Install Oracle 10.2.0.4 Client......................................................................................................... 19
Register DLLs with RegSrv32 ............................................................................................................. 19
Oracle Tuning Recommendations........................................................................................................ 20
Microsoft SQL Server Installation and Configuration ......................................................................... 21
Modify Logon Information for SQL Server Services .......................................................................... 22
SQL Server 2005 Database Server Installation.................................................................................... 23
Configure SQL Server 2005 Database Server ............................................................................... 24
Set Database Maintenance Options for SQL Server 2005............................................................. 25
Run DBCC Utility Options for SQL Server 2005 ......................................................................... 26
Update Statistics for SQL Server 2005.......................................................................................... 26

SmartPlant P&ID Installation and Upgrade Guide

Contents
Installing SQL Server Client................................................................................................................ 26
Install SQL Server 2005 Client...................................................................................................... 27
Loading SmartPlant P&ID Prerequisite Software ................................................................................ 31
Install SmartPlant 3D Piping Specification Remote Access Client ..................................................... 31
Installing the SmartPlant P&ID Software.............................................................................................. 31
Grant Permissions to Write to a Registry Key ..................................................................................... 31
Install SmartPlant Engineering Manager ............................................................................................. 32
Install SmartPlant P&ID ...................................................................................................................... 33
Uninstall a Previous Version of SmartPlant Engineering Manager ..................................................... 34
Uninstall a Previous Version of SmartPlant P&ID .............................................................................. 35
Install SmartPlant Reference Data ....................................................................................................... 35
Configuring Reference Data for SmartPlant P&ID.............................................................................. 36
Installing SmartPlant P&ID in Silent Mode......................................................................................... 36
Install SmartPlant P&ID in Silent Mode.............................................................................................. 37
Working in Thin Client Mode ................................................................................................................. 41
Overview .............................................................................................................................................. 41
Comparison of Thin Client Mode and SmartPlant P&ID Workshare.................................................. 41
Tuning the Software for Use in Thin Client Mode .............................................................................. 42
Publish the SmartPlant Application ..................................................................................................... 42
Configure Citrix Presentation Server 4.5 ............................................................................................. 43
Terminal Server Logon Sequence ........................................................................................................ 43
Upgrading to SmartPlant P&ID 2009..................................................................................................... 45
Correcting Database Constraint Violations.......................................................................................... 45
Generate a Database Constraint Exceptions Report ...................................................................... 46
Using Constraint Utilities .............................................................................................................. 47
Before Running the Upgrade Utility .................................................................................................... 50
Back Up Your Data ....................................................................................................................... 50
Share Paths to Site .INI Files......................................................................................................... 50
Set Oracle Parameters.................................................................................................................... 50
Memory Management Considerations........................................................................................... 51
Using the SmartPlant Engineering Manager Upgrade Utility.............................................................. 53
Upgrading a Site ............................................................................................................................ 54
Upgrade a Plant ............................................................................................................................. 54
Upgrade SmartPlant P&ID ............................................................................................................ 56
Upgrade Utility Commands........................................................................................................... 59
After Running the Upgrade Utility....................................................................................................... 61
Backup Each Upgraded Plant ........................................................................................................ 61
Use Oracle Analyzer Scripts.......................................................................................................... 61
Preserve Software Customizations ................................................................................................ 61
Making Manual Changes............................................................................................................... 62
Upgrading Reference Data ................................................................................................................... 62
Upgrade Reference Data................................................................................................................ 63

ii

SmartPlant P&ID Installation and Upgrade Guide

Contents
Updating Drawings .............................................................................................................................. 64
Update Command (File > Out-of-Date Drawings Menu).............................................................. 64
Resolve Command (File > Out-of-Date Drawings > Update Drawings Menu) ............................ 66
Out-of-Date Drawing Criteria Command (Tools Menu)............................................................... 67
Configuring SmartPlant Engineering Manager .................................................................................... 69
Working with Database Schemas......................................................................................................... 69
Understanding Default Database User Names .............................................................................. 70
Working with Data Dictionaries.................................................................................................... 72
Using Default Settings................................................................................................................... 75
Creating Network Shares ..................................................................................................................... 81
Site Administrator User Group ............................................................................................................ 82
Create a User Group ...................................................................................................................... 82
Add Users to the Administrators Group ........................................................................................ 84
Grant Network Access Privileges.................................................................................................. 84
Novell Networking and User Groups ............................................................................................ 85
Change the Site Administrator User Group................................................................................... 86
New Site Administrator Group Dialog Box .................................................................................. 87
New Site Server Wizard....................................................................................................................... 88
New Plant Structure Wizard................................................................................................................. 89
Associate Applications Wizard ............................................................................................................ 89
Create a New Role ............................................................................................................................... 90
User Access ................................................................................................................................................ 91
Overview .............................................................................................................................................. 91
SmartPlant Engineering Manager Rights............................................................................................. 92
SmartPlant P&ID Access Rights.......................................................................................................... 94
SmartPlant P&ID Access Rights Examples .................................................................................. 98
Customizing Your Reference Data........................................................................................................ 103
Customizing Reference Data Options ................................................................................................ 103
Working with Filters .......................................................................................................................... 103
Working with Formats ....................................................................................................................... 103
Working with Symbols and Labels .................................................................................................... 104
Modifying Data Model Properties...................................................................................................... 104
Synchronizing Reference Data........................................................................................................... 104
Establishing Design Rules.................................................................................................................. 105
Configuring Border Templates .......................................................................................................... 105
SmartPlant P&ID Delivered Templates....................................................................................... 106
Edit Delivered Templates ............................................................................................................ 107
Create a Border Template............................................................................................................ 108
Using SmartPlant P&ID in Production ................................................................................................ 109
Start SmartPlant P&ID....................................................................................................................... 109
Tips for Creating a P&ID Drawing .................................................................................................... 109
Recreating Drawings.......................................................................................................................... 110
Filtered Printing ................................................................................................................................. 111
SmartPlant P&ID Installation and Upgrade Guide

iii

Contents
Working with SmartPlant Integration ................................................................................................. 113
Overview ............................................................................................................................................ 113
Registering Tools ............................................................................................................................... 114
Preparing the Integrated Environment ............................................................................................... 114
Tool Requirements for Integrating SmartPlant P&ID........................................................................ 115
General Integration Requirements............................................................................................... 115
Working with SmartPlant Instrumentation .................................................................................. 116
Working with SmartPlant 3D ...................................................................................................... 117
Working with Zyqad.................................................................................................................... 117
Using Workshare in an Integrated Environment ......................................................................... 117
Using the Catalog Index in SmartPlant P&ID and SmartPlant Integration ................................. 118
Mapping for SmartPlant Integration .................................................................................................. 119
Using Custom Hierarchies ................................................................................................................. 119
Register Command (SmartPlant Menu) ............................................................................................. 120
Index ........................................................................................................................................................ 121

iv

SmartPlant P&ID Installation and Upgrade Guide

SECTION 1

Welcome to SmartPlant
The Intergraph SmartPlant family of process industry solutions is an open line of
discipline-specific software tools that provide an integrated solution for the entire plant life
cycle. Knowledge-based, intuitive, easy-to-use, accessible, flexible, and data-driven, SmartPlant
supports global workflows. The software enables users to create logical and physical definitions
of the plant model and enables access to plant data from conceptual design to decommissioning.
SmartPlant is the fulfillment of the Intergraph vision to speed and improve the creation of
information and to provide this data to multiple users at any moment in the appropriate form.
Workflows are compressed, reducing production time, lowering costs, enhancing global
execution, and extending the life and usability of plant information.
The successor to the Intergraph Plant Design System (PDS), SmartPlant includes expanded
functionality for front-end engineering and design (FEED), construction, operation, and
maintenance phases.

Installation Checklist
For the recommended installation workflow, see the SmartPlant P&ID Installation Checklist:
(SPPIDInstall_Checklist.xls), delivered during product setup to the \Program
Files\SmartPlant\P&ID Workstation\Program\resdlls\0009\ folder.

Introducing SmartPlant P&ID


SmartPlant P&ID creates intelligent P&IDs by populating the database with relevant plant data.
This method provides valuable information throughout the plant life cycle. As a data-centric,
rule-based solution for the P&ID life cycle, SmartPlant P&ID helps users improve design
quality, data consistency, and standards compliance. With quick access to supporting
engineering data, SmartPlant P&ID significantly cuts design and modification time and increases
accuracy with its exclusive data-centric approach and use of design rules, automatic checks, and
drag-and-drop capabilities.
SmartPlant P&ID is vastly different from graphic-driven P&ID solutions of today. All data from
the P&ID is stored in the plant database and adheres to plant standards. The graphical
representation of the P&ID is a view or a report of the data. The strong data import and export
facilities of SmartPlant P&ID allow users to populate the system with relevant plant data, such
as process data from process simulation databases based on Aspen Zyqad from Aspen
Technologies, Inc. or equipment and line lists. You can then use this information in the
SmartPlant P&ID Stockpile to design the P&ID.

SmartPlant P&ID Installation and Upgrade Guide

Welcome to SmartPlant
The rule-based and automation capabilities of SmartPlant P&ID also differentiate it from other
P&ID systems. SmartPlant P&ID features a comprehensive, user-definable rule-based system
that assists the engineer during the design phase of the plant and subsequent life cycle phases.
Data is entered directly into the database; rules are executed; and feedback is immediate. The
design rule-base confirms data consistency and compliance with plant and engineering
standards, allowing faster, more efficient design with less iteration.
SmartPlant P&ID incorporates the latest Microsoft technologies, such as OLE automation, to
provide integration with existing data and other systems. Running on various Microsoft
Windows operating system platforms, SmartPlant P&ID does not require a traditional, expensive
CAD engine for P&ID creation. The open architecture of SmartPlant P&ID permits integration
with other systems, such as Intergraph PDS, SmartPlant Instrumentation, and Aspen Zyqad, all
of which allow users to share data with third-party software.

SmartPlant P&ID Program Group


SmartPlant P&ID provides multiple views of a central, unified data structure that represents the
plant model. A view is a visual presentation of the data in the plant model and can be a
schematic drawing or a table. The plant model is the computer representation of the conceptual
design, including all plant components and their relationships. By manipulating model views,
you can organize the information within the plant model to better understand and maintain the
data.
SmartPlant P&ID has several programs and utilities for running and managing your plant data.
SmartPlant P&ID provides the design environment for SmartPlant
P&ID drawings.
SmartPlant P&ID Drawing Manager allows you to create and
delete drawings, manage drawing versions, and print multiple
drawings. Drawing Manager also allows you to perform Workshare
and project-specific commands.
SmartPlant P&ID Insulation Specification Manager allows you to
create and modify lookup tables for insulation specifications and
thicknesses.
SmartPlant P&ID Options Manager defines plant-wide graphic
standards for symbology, gapping, heat tracing, and formats.
Options Manager also defines paths to SmartPlant P&ID files and
directories.
SmartPlant P&ID Rule Manager defines rules for placement and
property copying on placement.
SmartPlant Engineering Manager performs higher-level data management tasks, such as
specifying user permissions, designing plant hierarchies, and so forth. For more information
about SmartPlant Engineering Manager, see the SmartPlant Engineering Manager User's Guide
and the appropriate sections of this guide.

SmartPlant P&ID Installation and Upgrade Guide

SECTION 2

SmartPlant Engineering Manager


SmartPlant Engineering Manager provides all the tools you need to effectively set up and
manage your work with SmartPlant applications. SmartPlant Engineering Manager takes
advantage of a client/server design that greatly enhances performance and lowers the cost of
ownership. Because it is built on few Microsoft dependencies and is not web-based, SmartPlant
Engineering Manager requires no web server. The intuitive user interface design, with its
streamlined layout, allows you to easily manage user access and to share plant data.
Supporting SmartPlant P&ID, SmartPlant Instrumentation, and SmartPlant Electrical,
SmartPlant Engineering Manager manages the plant structures while the applications themselves
are responsible for manipulating the actual data (including creating, deleting, modifying,
launching, and so forth). SmartPlant Engineering Manager allows you to view not only the data
related to the whole site but also data related to individual plants and projects. You can create
and maintain SmartPlant Engineering sites, plant structures and projects, in addition to adding
plant group types, modifying plant attributes, creating and modifying hierarchies, and
associating SmartPlant applications.

SmartPlant Engineering Manager Program Group


The SmartPlant Engineering Manager program group provides several utilities for managing
your plant data.
SmartPlant Engineering Manager allows you to create the
SmartPlant site and plants. You can create plant structures, plant
groups, hierarchy templates, as well as define the access to plant
data on many levels.
Catalog Manager allows you to create and modify symbols and
labels.
Data Dictionary Manager allows you to add properties to
SmartPlant database tables, define external programs, view
relationships, and create and modify select lists.
Data Dictionary Template Comparison Utility allows you to
determine the differences between two data dictionary template files
or between one data dictionary template file and the corresponding
data dictionary/schema from a plant.
Filter Manager allows you to create and modify filters to
discriminate on database data. Filters are used for displaying data
in symbology, gapping, graphical views, reports, rules, and so forth.
Format Manager defines available formats for units of measure
properties.
Refresh Site Roles Utility allows you to automatically refresh the
roles in a site on a scheduled basis.
SmartPlant P&ID Installation and Upgrade Guide

Welcome to SmartPlant
Reference Data Synchronization Manager provides tools for
comparing, synchronizing, and managing reference data across
multiple plants. Used in conjunction with the Update Drawings
functionality in Drawing Manager, this application is especially
useful when you need to maintain a central set of reference data for
all plants across a site without having a network or database
connection between plants.
Upgrade Utility guides you through upgrading your SmartPlant
Engineering data.

SmartPlant P&ID Installation and Upgrade Guide

SECTION 3

Internationalization
Supporting internationalization in a homogeneous environment is one of the enhancements
available in SmartPlant Enterprise. A homogeneous environment uses elements from only a
single locale. For example, a German customer running on a German operating system using
only German characters and German cultural conventions is a fully supported homogeneous
environment configuration.

Homogeneous Environments
When starting a new project, use extra care during installation and configuration to ensure the
proper creation and maintenance of homogeneous environments:
All the computers (servers and clients) within an integrated SmartPlant Enterprise
implementation must have the same regional settings, and no one should change the regional
settings after the project has started.
Do not cross the decimal locale boundary. This is the most common cause of numeric data
corruption and calculation errors. Having users with different regional settings (like with a
period versus a comma for the decimal point) causes the software to interpret values
unpredictably. For example, a pipe run with a pressure of 35.3 psi can be read by the
software as 353 psi to the user with different regional settings. A cable length defined as 39
ft 11,21 inches has been interpreted as 121718910971323 meters when published to an XML
file. These incorrect interpretations may be used in internal software calculations and can be
impossible to backtrack or correct. Do not change the decimal point character to try to solve
an issue. Doing so will only corrupt values in the database or in text files.
Do not cross the character-set locale boundary. For example, the character set boundary
between Western (Latin-based) and Eastern Europe (Cyrillic-based), or between Eastern
Europe and Japan.
Create Oracle databases using AL32UTF8 for the database character set and AL16UTF16
for the NLS character set.
Never modify the NLS_LANG registry entry on an Oracle client. Doing so causes the
character data not to convert to Unicode.
Create Microsoft SQL Server databases with locale-specific collation settings and ensure
that all databases have the same setting.

Heterogeneous Environments
In contrast, a heterogeneous environment using elements from different, or even multiple
locales, is not supported. Many customers are currently operating in unsupported
heterogeneous environments and are often not aware of that fact. Examples of heterogeneous
environments:
Entering or viewing Japanese data on an US/English operating system
Using German Regional Settings (where the decimal point is a comma) on a US/English
operating system
SmartPlant P&ID Installation and Upgrade Guide

Internationalization
Using databases with different character encodings such as CL8MSWIN1251 or JA16SJIS
Using multiple languages in a project, especially when crossing language-group boundaries
Using an English server with different local language clients

International / Bi-lingual Projects


International bi-lingual projects are possible; however, great care must be used when configuring
these environments. Limitations exist and must be properly understood:
Oracle and MS SQL Server databases can reside on any language operating system, as long
as the databases have been created and configured with proper Unicode and collation
settings.
All Microsoft operating systems (Japanese, Russian, German, and so forth) can enter English
characters. The reverse, however, is not true in most cases.
Keyboard-locale can be changed as long as a character-set and code- page boundary is not
crossed. For example, English, German, French, and Spanish characters can all be used in
the same project because the same Windows code-page (1252) is used. However, Russian
characters (code-page 1251) cannot be used in a US/English environment.
You must decide which language operating system will be the master for bi-lingual projects.
The following is an example of a Russian-based project:
Companies in the United States and the United Kingdom are working a project with a Russian
company and the deliverables (drawings, reports, and so forth) must ultimately be provided in
Russian. The companies in the U.S. and the U.K. are working the project using the "master"
Russian operating systems (possibly using virtual Russian operating systems running on
VMware Workstation). The U.S. and U.K. companies can install and use English Microsoft
Office products on the Russian operating system because Office products are globally enabled. If
a Russian interface exists for the SmartPlant Enterprise application, then Russian users can use
the Russian interface while the English-speaking users would continue to use the US/English
interface. English-speaking engineers can enter English characters. Russian-speaking engineers
can enter Russian characters.
However, because the Russian locale uses different decimal and character-set locales, everyone
(English and Russian engineers) must use the Russian decimal symbol which is a comma. For
customization purposes, databases can be modified to accommodate new Russian-specific
requirements (fields, properties, and so forth.) Using filters, display sets, and other software
features, bi-lingual projects can be further customized. Graphic data, reports, and so forth can be
created in either or both languages.
Do not change regional settings to reflect a U.S. environment in order to resolve
problems in a non-US/English homogeneous configuration. Doing this creates a heterogeneous
configuration that will cause other possibly hidden problems that cannot be corrected. Everyone
working on a project must use the same regional settings and character set throughout the life of
the project.

Questions and Assistance


Please contact your support representative for assistance.

SmartPlant P&ID Installation and Upgrade Guide

SECTION 4

Hardware and Software


Recommendations
Before beginning an installation of the SmartPlant software, verify that your servers meet the
following requirements. These requirements assume that the SmartPlant software is not installed
on the database server. You can install the SmartPlant software on the database server if you
want to, but we do not recommend it.
SmartPlant Engineering Manager may be installed on its own workstation or it can run on the
same computer with other engineering applications, such as SmartPlant P&ID or SmartPlant
Electrical.

The SmartPlant database management server installation was certified on 64-bit hardware
with a 64-bit operating system (Windows Server 2003) and 64-bit database software. The client
machine installation was certified on 64-bit hardware with a 64-bit operating system and 32-bit
database software.

SmartPlant P&ID Database Server


Hardware Recommendations
2.4 GHz Pentium processor
2 GB RAM (or more for a large database)
For all installations, DVD drive access, either locally or through a network connection

Supported Operating Systems


Microsoft Windows Standard Server 2003 Service Pack 2 (32-bit and 64-bit)
Microsoft Windows Enterprise Server 2003 Service Pack 2 (32-bit and 64-bit)
SmartPlant P&ID Installation and Upgrade Guide

Hardware and Software Recommendations


Microsoft Windows Enterprise Server 2003 R2 Service Pack 2 (32-bit and 64-bit)
The operating system must be installed in the account where you have administrator
privileges.

Supported Database Servers


Microsoft SQL Server 2005 Service Pack 2 (32-bit and 64-bit)
Oracle Database 10g Release 2 (10.2.0.4 32-bit and 64-bit)

Recommended Disk Space


Oracle 10g Software

SQL Server 2005 Software

SmartPlant Engineering Manager


Software

Oracle
Server
installation

2 GB

SQL Server
2005
installation

1 GB

Initial SmartPlant
Engineering Manager
database

250 MB

Initial Oracle
instance

500 MB

SQL Server
Temporary
database

100 MB

Total:

2.5 GB

Total:

1.1 GB

Total:

0.25 GB

Software Prerequisites
Adobe Reader 8.0 (required to view the Software License Agreement and Printable
Guides).
Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (MDAC 2.8 is delivered as
part of Microsoft Windows XP Service Pack 3).
Microsoft .NET Framework 2.0

SmartPlant P&ID Workstation


Hardware Recommendations
2 GHz Pentium IV processor or higher
2 GB RAM
DVD drive access, either locally or through a network connection
Windows supported printer access, either locally or through a network connection

Supported Operating Systems


Microsoft Windows XP Professional Service Pack 3 (32-bit)
Microsoft Vista Business Client 1.0 Service Pack 1 (32-bit)

SmartPlant P&ID Installation and Upgrade Guide

Hardware and Software Recommendations

Supported Database Clients


Microsoft SQL Server 2005 Service Pack 2
Oracle 10g Client Release 2 (10.2.0.4)
Do not use Oracle 'light client' as it does not include some of the required .dll files.
The client database software must be of the same version as the server database software.

Recommended Disk Space


Oracle 10g Software

SQL Server 2005 Software

SmartPlant Software

Oracle Client
installation

SQL Server
2005 Client
installation

SmartPlant Engineering
Manager 2009 (full
installation)

250 MB

SmartPlant P&ID 2009 (full


installation)

250 MB

SmartPlant Schema
Component

25 MB

SmartPlant Client

30 MB

Total:

0.55 GB

Total:

1 GB

1 GB

Total:

100 MB

0.1 GB

Software Prerequisites
Adobe Reader 8.0 (required to view the Software License Agreement and Printable
Guides).
SmartPlant License Manager 2009 (10.00.05.00). The licensing is delivered on its own CD
that comes with your SmartPlant P&ID product CD.
Microsoft Internet Explorer 7.0 (required for viewing the online documentation delivered
with the software)
Microsoft XML Core Services (MSXML) 6.0 Service Pack 1
Microsoft .NET Framework 2.0
Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (MDAC 2.8 is delivered as
part of Microsoft Windows XP Service Pack 3).
Microsoft Office 2003 or 2007 (Microsoft Excel is required for working with report
templates and for viewing the Installation Checklist and various other files).
SmartPlant 3D Piping Specification Remote Access Client, Version 01.00. The Piping
Specification Client software is required for using SmartPlant 3D specifications in the
SmartPlant P&ID Piping Specification Utility and is available on the SmartPlant P&ID
product CD.

SmartPlant P&ID Installation and Upgrade Guide

Hardware and Software Recommendations

Optional Software
Apart from SmartSketch, the following software programs are not Intergraph
corporation software and are owned by third parties. It is the responsibility of the customer to
select in its sole discretion the applicable third party software customer desires to use to generate
reports and Intergraph makes no recommendation as to the choice of said third party software.
Customer is responsible for obtaining a valid license to use said third party software from the
owner of said third party software and to pay any license fees to the owner of said third party
software for the use of said third party software. INTERGRAPH DISCLAIMS AND MAKES
NO WARRANTY EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF
MERCHANTABILITY OR THE WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE IN REGARDS TO SAID THIRD PARTY SOFTWARE.
For working in a Citrix environment, Citrix Presentation Server 4.5
SmartSketch 2007 (5.0) or similar graphical editor (used for editing border template files)
SmartSketch 2009 is not compatible with SmartPlant P&ID 2009. If you have
installed SmartSketch 2009 on the same machine as the SmartPlant P&ID 2009 installation and
you open a SmartPlant P&ID 2009 drawing file using SmartSketch 2009 (note that this is not a
recommended workflow, as you should open the file using SmartPlant P&ID instead), you must
save the file as an earlier version of SmartSketch to be able to work with the file in SmartPlant
P&ID.
In addition, if you create a symbol using SmartSketch 2009 (instead of Catalog Manager 2009),
you must save the file as an earlier version of SmartSketch before importing the symbol file into
Catalog Manager.

10

SmartPlant P&ID Installation and Upgrade Guide

SECTION 5

Installing the Software


This section describes how to set up your database and install SmartPlant Engineering Manager,
SmartPlant P&ID and supporting software. Before you begin installing the software, verify that
the computers on which the software components will be installed meet the requirements
described in SmartPlant Engineering Manager Hardware and Software Recommendations (see
"Hardware and Software Recommendations" on page 7).
The Open Database functionality, incorporated into all parts of the SmartPlant software, allows
you to install pieces of the software on several different workstations. You do not have to
maintain a server for just SmartPlant Engineering Manager. For example, you can install
SmartPlant Engineering Manager and its related managers on one workstation, SmartPlant P&ID
and its related managers on another, and the reference data on yet another workstation or file
server. You could install all of the SmartPlant software on one workstation, or you could install
SmartPlant Engineering Manager on one workstation, SmartPlant Catalog Manager on another
workstation, and the remaining SmartPlant software on another workstation.

Setting up the Database


Installing any database involves significant decisions regarding the size of the database, the
maximum number of users, the frequency of automatic backups, and other important issues.
Therefore, the following sections provide only suggestions for tuning your database
configuration to work with SmartPlant software. The ultimate database creation and
configuration depends on the policies and standards at your company.
SmartPlant Engineering Manager includes a number of deferrable database constraints, which
are rules used to ensure database integrity by checking values at the time the information is
written to the database. If all of the information does not fall within these embedded constraints,
the information is not written to the database, and the software rolls back the transaction.
These deferrable database constraints are applied only when you use an Oracle database;
SQL Server does not support them.

SmartPlant P&ID Installation and Upgrade Guide

11

Oracle Installation and Configuration

Oracle Installation and Configuration


Because system configurations, database software, and individual company standards vary, use
this section as a checklist instead of step-by-step instructions. Please contact Intergraph
Customer Support (http://support.intergraph.com) for specific configuration questions.

Oracle Instances
If one server hosts the databases of several products, Intergraph recommends that each product's
database be a separate instance, each of which can host multiple plants.
The advantage of placing each product's database its own instance is that only the affected
application will be off-line during backup, performance tuning, and other database maintenance
activities. Additionally, global tuning parameters that apply to one instance can be tailored to the
specific product requirements.
According to Oracle documentation, the only limit to the number of instances you can have on
any machine is the availability of resources. However, the number of instances on one database
server should be minimized, because each additional instance puts additional load on the server.
Each instance adds redundant tablespaces, rollback segments, background processes, and
memory requirements for each SGA (System Global Area). For this reason, you should start by
putting the database of one product for several plants into a single instance. Then, when the
number of plants increases, or a plant becomes very large, consider separating the database into
new instances, adding server memory, or even adding database servers.
We recommend installing and configuring Oracle locally, not by remote desktop connection.
Oracle recommends that database activity on the database server consume no more than 50
percent of the available memory.

Configure Oracle Networking Components


Oracle Net combines configuration abilities with component control to provide an integrated
environment for configuring and managing client connections to services via a net service name.
SmartPlant Engineering Manager and P&ID use the Oracle Net service to establish and maintain
network sessions from client applications to the Oracle database server. After a network session
is established, this utility acts as a data courier for the client application and the database server.
See the Oracle Net Services Administrator's Guide and the Oracle Net Services Reference Guide
in your Oracle documentation for more information about using this utility and creating net
service name connections. If you follow the procedures provided to Install Oracle Server
Software (Basic Installation for Enterprise Edition) and Install Oracle Client Software, the
Oracle Networking Components should be configured correctly.

12

SmartPlant P&ID Installation and Upgrade Guide

Oracle Installation and Configuration

For SmartPlant P&ID to access the database, you must load and configure Oracle Net
Services on the database server and on each end-user SmartPlant workstation. If SmartPlant
Engineering Manager is installed on the database server, you must load and configure
Oracle Net Services on that server, in addition to the Oracle TCP/IP Protocol Adapter.
If SmartPlant Engineering Manager is installed on a workstation other than the database
server, you must load the Net Services and the Oracle TCP/IP Protocol Adapter on the
SmartPlant Engineering Manager computer. You must also load the Net Services and the
Oracle TCP/IP Protocol Adapter on the Oracle database server.
Net Manager is installed with the Net Services software and allows you to create a database
Net Service Name, which SmartPlant uses to communicate with the database.
The version of Net Services must be the same on all computers.

Oracle Installation Workflow


The following workflow is necessary for installing Oracle for use with SmartPlant P&ID.
Installing Oracle Database Server (on page 13)
Create an Oracle Listener (on page 14)
Creating an Oracle Instance (on page 14)
Installing Oracle Client (on page 18)

Installing Oracle Database Server


The following editions of Oracle Database Server are available:
Standard Edition (for minimum installation)
Enterprise Edition
You should refer to your Oracle Installation Guide for detailed instructions on installing Oracle.

Install Oracle 10.2.0.4 Database Server


1. Start Oracle 10.2.0.4 Setup.
2. On the Select Installation Method page, click Basic Installation, and from the Installation
Type list, select one of the following:
Standard Edition If the operating system is Windows 2003 Server.
Enterprise Edition If the operating system is Windows XP.
3. Clear the Create Starter Database check box and then click Next.
4. On the Product-Specific Prerequisite Checks page, ignore the Checking Network
Configuration requirements warning and click Next.
5. On the Warning dialog box, click Yes.

SmartPlant P&ID Installation and Upgrade Guide

13

Oracle Installation and Configuration


6. If the OUI-10030 warning message appears, if the disk of the target folder has enough
space, click Yes.
7. On the Summary page, click Install.
8. Complete the installation and then click Exit.
9. Restart the server machine.

Create an Oracle Listener


1. On the Start menu, click All Programs > Oracle OraDb10g_home1 > Configuration
and Migration Tools > Net Configuration Assistant.
2. In the Oracle New Configuration Assistant Wizard, click Next until you reach the page
Listener Configuration, Listener Name.
3. Define the listener name, for example, LISTENER and click Next.
4. On the Listener Configuration, Select Protocols page, select TCP and click Next.
5. On the remaining Wizard pages, click Next and then click Finish to complete the listener
creation.

Creating an Oracle Instance


The Oracle instance is a workspace on the Oracle database server where Oracle keeps a single
database. You can create as many instances as required and, this way, append as many databases
as you need on a single database server. However, note that appending instances on your Oracle
database server can slow down your work in the P&ID database located on that server.
You need to create a new instance in Oracle if you have an existing Oracle database server
whose parameters do not comply with the parameters required to use P&ID on Oracle. This way
you can append the P&ID database to existing Oracle databases on your Oracle database server
without losing your existing Oracle database information.
The instance creation process contains the following major steps:
1. Creating a new instance initialization file from an existing initialization file.
2. Modifying the database parameters in the new instance initialization file.
3. Modifying the Listener.ora file which Oracle will run when carrying out the instance
creation process.
4. Creating a new instance using the Database Configuration Assistant.
When creating an instance, Oracle takes-up some disk space. Therefore, you must have enough
free disk space on the hard disk where the Oracle database is located to be able to create the new
instance. The disk usage is as follows:
Oracle instance environment 50 MB recommended
Oracle instance after running Oracle DB Setup 80 MB recommended
Oracle instance after initializing a domain 150 MB recommended
See your Oracle User Guide for additional information about limitations on creation of instances.

14

SmartPlant P&ID Installation and Upgrade Guide

Oracle Installation and Configuration

Requirements for Oracle Instance Creation


Before creating an Oracle instance, make sure that you have Administrator's access rights in
both your Oracle server database and the operating system installed on the server machine.
If you still need to create an instance from the account in which you do not have
Administrator's rights, and if your company's policy allows you to change the Oracle
security, you can do the following: in the Sqlnet.ora file, add the # symbol before the
Sqlnet.Authentication_Services = (NTS) parameter to comment it out. The default
location of the Sqlnet.ora file will look similar to the following path:
\\<Oracle home folder>\Product\<Version*>\db_1\Network\Admin\
(* An example of the 7.x folder name is 10.2.0)
Before starting an Oracle database you need to ensure that the RAM that this database occupies
does not exceed the available RAM on your server. You can calculate the amount of RAM
needed for the database by using the following Oracle parameters:
SHARED_POOL_SIZE (at least 10 MB)
DB_BLOCK_SIZE
LOG_BUFFER
SORT_AREA_SIZE
JAVA_POOL_SIZE and LARGE_POOL_SIZE are additional parameters that affect the
RAM that the Oracle database occupies. These parameters appear if you select certain options
when running the Oracle Database Configuration Assistant using a custom installation type.
For the DB_BLOCK_SIZE parameter, make sure that the value is at least 8192.
As an alternative to the above calculation, you can use the following target parameters to
determine the maximum amount of RAM:
sga_target (at least 100 MB is recommended)
pga_aggregate_target (at least 20 MB is recommended)

Create a New Oracle 10.2.0.4 Instance


Make sure that all passwords, user names, folders, and files of the new instance are different
from those of any existing instance.
All user names and passwords must use ASCII / English characters. Oracle does not support
non-ASCII / English characters in user names or passwords and will not work. This
limitation is an Oracle limitation, not Intergraph's.
1. On the Start menu, click All Programs > Oracle OraDb10g_home1 > Configuration
and Migration Tools > Database Configuration Assistant.
2. On the Welcome page, click Next.
3. In the Database Configuration Assistant Wizard, click Next until you reach the page Step
2 of 12: Database Templates.

SmartPlant P&ID Installation and Upgrade Guide

15

Oracle Installation and Configuration


4. Select Custom Database and click Next.
5. On the page Step 3 of 12: Database Identification, do the following:
a. In the Global Database Name box, define the database name, for example, PID10gdb.
b. In the SID box, accept or modify the instance name that the software enters
automatically as you type the database name.
The database name and the instance name do not have to be the same.
c. On the page Step 4 of 12: Management Options, clear Configure the Database with
Enterprise Manager, and then, click Next.
6. On the page Step 5 of 12: Database Credentials, in the Password and Confirm Password
boxes, type the password, for example, Oracle.
The following terms are reserved and cannot be used as passwords: manager (reserved
for the SYSTEM user) and change_on_install (reserved for the SYS user).
7. Click Next until you reach the page Step 7 of 12: Database File Locations, and then do the
following:
a. Select Use Common Location for All Database Files.
b. Specify the path and folder, for example, D:\oracle\.
c. Click Next.
8. On the page Step 8 of 12: Recovery Configuration, clear Specify Flash Recovery Data
and click Next.
9. On the page Step 9 of 12: Database Content, do the following:
a. On the Database Components tab, clear all the check boxes.
b. Click Standard Database Components, and then, on the Standard Database
Components dialog box, clear all the check boxes and click OK.
c. If prompted you to disable local database management, click Yes.
d. On the Custom Scripts tab, click No scripts to run.
e. Click Next.
10. On the page Step 10 of 12: Initialization Parameters, on the Memory tab, do the
following:
a. Select Custom.
b. Beside Shared Memory Management, select Automatic.
c. In the SGA Size box, enter 160 M Bytes.
d. In the PGA Size box, enter 60 M Bytes.

16

SmartPlant P&ID Installation and Upgrade Guide

Oracle Installation and Configuration


The recommended total memory for one Oracle 10g instance is 260 M Bytes.

e. Click the Character Sets tab and do the following:


i.

Under Database Character Set, select Use Unicode (AL32UTF8).

ii. Under National Character Set, select AL16UTF16 (the default)


The same database character set and national character set values should also be
defined on your server.
The Default Language and Default Date Format values will reflect locale-specific
information.
f.

Accept the settings on the other tabs and click Next.

SmartPlant P&ID Installation and Upgrade Guide

17

Oracle Installation and Configuration

11. On the page Step 11 of 12: Database Storage, if you intend to create a SmartPlant
Electrical or SmartPlant P&ID database in the current Oracle database, change the data file
size of the TEMP and USERS tablespaces to 100 MB.
To change the size, double-click the field under Size.
12.
13.
14.
15.

Click Next.
On the page Step 12 of 12: Creation Options, click Finish.
On the Confirmation dialog box, click OK.
Restart the server machine.

Installing Oracle Client


The Oracle client provides P&ID with the means to interface with the Oracle database server.
You install the Oracle client after you have completed the Oracle database server installation.
You can install the Oracle client either on a file server or on the local station. If you install the
Oracle client on a station, make sure you have the appropriate access rights to the Oracle
database server.
After the Oracle client installation process is complete, you proceed by installing P&ID. Before
you start the installation process, make sure that the machine (file server or local station) has
access to a CD-ROM drive. If your machine does not have access to a CD-ROM drive, you
need to copy all the installation files from the installation CD to your local hard disk.

18

SmartPlant P&ID Installation and Upgrade Guide

Oracle Installation and Configuration

Installing Oracle 10.2.0.4 Client Prerequisites


Make sure that your Oracle server version is 10.2.0.4.
Uninstall previous versions of Oracle client from the client machine where you want to
install Oracle Client 10.2.0.4.
Set up your client Windows regional and language options as you require. You can only set
up these options before the client installation. If you want to change the regional and
language options after the installation, you will have to reinstall the Oracle client for the
changes to take effect
After the client installation, you must not change any of the default values of the
NLS_LANG parameter on the client.

Install Oracle 10.2.0.4 Client


1. Start the Oracle Universal Installer for Oracle client.
2. On the Select Installation Type page, from the list, select one of the following:
Administrator For users who need Administrator functions, such as the ability to
create tablespaces.
Runtime For all other users.
3. On the Specify Home Details page, enter the name of the folder that will appear in the Start
menu and the folder path for the installation.
The Start menu folder name is also the name given to the Oracle Home folder in the
Registry.
4.
5.
6.
7.
8.
9.
10.
11.
12.

Clear the Create Starter Database check box and then click Next.
On the Product-Specific Prerequisite Checks page, click Next.
On the Summary page, click Install.
On completion of the installation, when the Oracle Net Configuration Assistant opens, select
the Perform typical configuration check box.
On the Welcome page, click Next.
On the Oracle Net Configuration Assistant: Done page, click Finish.
Complete the installation and then click Exit.
Restart the client machine.
Create an alias to the Oracle database on the client machine using Oracle Net Manager.
The alias name can contain any alphanumeric characters without spaces.

Register DLLs with RegSrv32


If you install Oracle Client on your SmartPlant workstation after installing SmartPlant
Engineering Manager or P&ID software, the setup process will not register the
igrOraspconnect.dll file. To rectify this, after you install Oracle Client, do the following:
1. From the Windows Control Panel, select Add/Remove Programs.

SmartPlant P&ID Installation and Upgrade Guide

19

Oracle Installation and Configuration


2. From the list of programs on your computer, select Intergraph P&ID.
3. Click Change/Remove.
4. On the Setup Type page, select Add/Remove install components (in SmartPlant P&ID
only).
5. Select Repair.

Oracle Tuning Recommendations


We recommend using the following Oracle tools for optimizing your database performance with
the SmartPlant products.

OPTIMIZER_MODE Initialization Parameter


The OPTIMIZER_MODE initialization parameter establishes the default behavior for
choosing an optimization approach for the instance. This parameter can be set in the
initSIDname.ora or init.ora file to one of the following four values. For more information, see
the Oracle performance tuning documentation at
http://pbscrm.intergraph.com/pbs/sppid/Freeware/OracleAnalyzer.zip
(http://pbscrm.intergraph.com/pbs/sppid/Freeware/OracleAnalyzer.zip).
CHOOSE The optimizer chooses between a cost-based approach and a rule-based approach
based on whether statistics are available for the CBO. If the data dictionary contains statistics for
at least one of the accessed tables, then the optimizer uses a cost-based approach and optimizes
with a goal of best throughput. If the data dictionary contains no statistics for any of the accessed
tables, then the optimizer uses a rule-based approach. This is the default value for the parameter.
ALL_ROWS The optimizer uses a cost-based approach for all SQL statements in the session
regardless of the presence of statistics and optimizes with a goal of best throughput (minimum
resource use to complete the entire statement). If you are not gathering statistics on your
database, we do not recommend using this setting.
FIRST_ROWS The optimizer uses a cost-based approach for all SQL statements in the
session regardless of the presence of statistics and optimizes with a goal of best response time
(minimum resource use to return the first row of the result set). If you are not gathering statistics
on your database, we do not recommend using this setting.
RULE The optimizer chooses a rule-based approach for all SQL statements regardless of the
presence of statistics. If you are not gathering statistics on your database, we do not recommend
using this setting.

Oracle Cost Based Optimizer (CBO)


We recommend using the Oracle Cost Based Optimizer (CBO) on Online Transaction
Processing (OLTP) systems. Use the following settings to encourage the CBO to use indexes
instead of full table scans.
OPTIMIZER_INDEX_CACHING = 90
OPTIMIZER_INDEX_COST_ADJ = 35

20

SmartPlant P&ID Installation and Upgrade Guide

Microsoft SQL Server Installation and Configuration


Before you can use the CBO, you must set the OPTIMIZER_MODE initialization
parameter to CHOOSE.

ARCHIVELOG Mode
We also recommend running Oracle in ARCHIVELOG mode, which copies filled online redo
logs to disk. You must specify the mode at database creation or by using the ALTER
DATABASE statement. You can enable automatic archiving either dynamically using the
ALTER SYSTEM statement or by setting the initialization parameter LOG_ARCHIVE_START
to TRUE.
Running the database in ARCHIVELOG mode has several advantages over NOARCHIVELOG
mode. You can:
Back up the database while it is open and being accessed by users.
Recover the database to any desired point in time.
To protect the ARCHIVELOG mode database in case of failure, back up the archived logs.
For more information, please see the SQL*Plus Backup and Recovery Concepts document in
your Oracle documentation.

Other Recommendations
Some users have found using the following settings beneficial.
System Tablespace Max_Extents = UNLIMITED (If you choose to set this parameter to
505, the database monitoring system will warn you if the system tablespace is growing
heavily. This setting has no impact on performance.)
Tablespace System / initial und next set to 64KB (Setting the pctincrease parameter to 50
allows you to take advantage of the dynamic growth provided by Oracle, leading to larger
extents in a large database.)
RollBackSegment und Temp-Tablespace create rollback segment <name> tablespace
rbs storage (optimal 10MB)
begin dbms_stats.gather_database_stats (cascate => TRUE); end;/ (Gathers statistics on
the schemas. Use with the OPTIMIZER_MODE variable set to ALL_ROWS.)

Microsoft SQL Server Installation and


Configuration
The installation and configuration procedures described in this guide include only the steps
required to install and use SmartPlant software in the Microsoft SQL Server environment.
Therefore, it is recommended that you refer to your Microsoft SQL Server User's Guide for
additional information about Microsoft SQL Server.

SmartPlant P&ID Installation and Upgrade Guide

21

Microsoft SQL Server Installation and Configuration


If you intend to use the SmartPlant P&ID Connected Workshare functionality, you must
use an Oracle database rather than SQL Server. Connected Workshare does not support SQL
Server; however, Standalone Workshare does support SQL Server.
Because system configurations, database software, and individual company standards vary, use
this section as a checklist instead of step-by-step instructions. Please contact Intergraph
Customer Support (CustomerSupport.htm) for specific configuration questions.
1. Using the Typical installation, load the Microsoft SQL Server software on your database
server.
2. Configure SQL Server to create your custom database. You will need to provide the
database node name, Administrator user name, and Administrator password when
performing the configuration.
SQL Server Client is required on any SmartPlant computer on which you intend to create
sites, plants, or projects, or on any computer that performs backup or restore operations.
When creating and configuring your databases, keep in mind that plant structures must be
created in a SQL Server database separate from the site server database and that each plant
must be in its own database.
If the backup location for your SQL site is located on a separate computer from your
database, you must modify the logon information for the SQL Server services using the
procedure that follows.

Modify Logon Information for SQL Server Services


1. From the Windows Control Panel, select Administrative Tools > Services.
2. In the Services list, double-click SQLServer (MSSQLServer) to open the SQLServer
(MSSQLServer) Properties dialog box.
The default instance for SQL Server 2005 is SQLServer (MSSQLServer).
In place of the default instance, you can use a named instance, for example: SQLServer
(SPPID).
3. Click the Log On tab.
4. Select This account and type the user name and password for the domain user who will be
starting the MSSQLSERVER service.
5. Save your changes.
6. If the user defined in This account does not already have permissions to the share where
backups are stored, grant the user read/write permissions to that share.
For more information about MSSQLServer properties and granting permissions to domain users,
refer to your SQL Server and Windows documentation.

22

SmartPlant P&ID Installation and Upgrade Guide

Microsoft SQL Server Installation and Configuration

SQL Server 2005 Database Server Installation


Create Microsoft SQL Server databases with locale-specific collation settings and
ensure that all interacting databases have the same collation settings.
1. Start SQL Server 2005 Setup.
2. On the Microsoft SQL Server 2005 Setup wizard, click Next until you reach the
Components to Install page.
3. On the Components to Install page, do the following:
a. Select SQL Server Database Services.
b. Select Workstation components, Books Online and development tools and then click
Next.
4. On the Instance Name page, select Default instance and click Next.
5. On the Existing Components page (if displayed), click Next.
6. On the Service Account page, do the following:
a. Select Use the built-in System account and then select Local system.
b. Under Start services at the end of setup, select SQL Server and click Next.
On the Service Account page, you must only select the SQL Server service. The other
two services (SQL Server Agent and SQL Browser) are not needed for any SmartPlant
software product. After the database server setup, the SQL Server service is created with
the Automatic startup type, the SQL Server Agent service is created with the Manual
startup type, and the SQL Browser service is not created.
7. On the Authentication Mode page, do the following:
a. Select Mixed Mode.
b. Define the System Administrator password as you desire and click Next.
8. On the Collation Settings page, ensure that Collation designator and sort order is
selected, and from the list, select the appropriate designator corresponding to the national
environment defined for the operating system on the client machines. For example, if the
client environment is Russian, select Cyrillic_General as the collation designator.
If the national environment of the client machines is identical with the national
environment defined for the server, just accept the default values on this page.
Ensure that the Case sensitive check box is cleared.
9. Click Next and complete the remaining steps.
10. After clicking Finish, restart the server machine.

SmartPlant P&ID Installation and Upgrade Guide

23

Microsoft SQL Server Installation and Configuration

Configure SQL Server 2005 Database Server


This procedure explains how to configure the server to avoid running out of memory.
By default, the server is configured to use unlimited memory.
As a quick alternative to this procedure, you can stop and then restart the server.
To implement this procedure, you must have DBA permissions.
1. Click Start > Programs > Microsoft SQL Server 2005 Setup > SQL Server
Management Studio.
2. On the Connect to Server dialog box, enter the required information as shown.

3.
4.
5.
6.
7.

Beside Server type, select Database Engine.


Beside Server name, select the name of your server or instance.
Beside Authentication, select SQL Server Authentication.
Type a login name.
Type a strong password of a least 6 characters; this is a password that must include upperand lower-case characters, numeric and non-alphanumeric characters.
8. Click Connect.

24

SmartPlant P&ID Installation and Upgrade Guide

Microsoft SQL Server Installation and Configuration


9. In the Microsoft SQL Server Management Studio window, under the Object Explorer,
select the server (top-level node), right-click, and on the shortcut menu, click Properties.

10. Select the Memory page and do the following:


a. Select Use AWE to allocate memory.
b. Under Maximum server memory (in MB), set a suitable value.
If it is likely that a large number of users will connect to the database concurrently, set
the maximum memory to a higher value to avoid poor performance.
11. Select the Database Settings page and change the value of Default index fill factor to 80.

Set Database Maintenance Options for SQL Server 2005


You set the database maintenance options for SQL Server using the DBCC Utility. It is
recommended that you run the following options about once a week:
CHECKCATALOG
CHECKDB
You must use an SA connection for running these options.
You should also update the database statistics as needed.

SmartPlant P&ID Installation and Upgrade Guide

25

Microsoft SQL Server Installation and Configuration

Run DBCC Utility Options for SQL Server 2005


1. Open the SQL Server Management Studio.
2. In the Microsoft SQL Server Management Studio window, under the Object Explorer,
select the server (top-level node), right-click, and on the shortcut menu, click New Query.
3. Type the appropriate query using the syntax shown, for example:
DBCC CHECKCATALOG ('Site_Server1_DB')
You must enclose the name of your database within the quotes and parentheses as
shown.
Identical syntax applies for the CHECKDB command.
4. Click Query > Execute.
5. View the Messages window for the results of the query.
You can save the results to an external file. To do so, click Query > Results To >
Results to File.
The software automatically corrects basic problems. For more complex problems, you
must refer to the query results and correct these problems manually.

Update Statistics for SQL Server 2005


1. Open the SQL Server Management Studio.
2. In the Microsoft SQL Server Management Studio window, under the Object Explorer,
select the server (top-level node), right-click, and on the shortcut menu, click New Query.
3. Type the following SQL script with the name of your database, for example:
USE Site_Server1_DB
GO
EXEC SP_UPDATESTATS
This script updates the statistics for every table in the database.

Installing SQL Server Client


The SQL Server client provides with the means to interface with the SQL Server database
server. You can install the SQL Server client on each client machine after you have completed
the SQL Server database server installation.
Before you install the SQL Server client on a client machine, ensure that:
SQL Server database server is installed on a database server machine.
The SQL Server client version is compatible with your SQL Server database server version.
You have appropriate access rights to the SQL Server database server.

26

SmartPlant P&ID Installation and Upgrade Guide

Microsoft SQL Server Installation and Configuration


You do not need to install the SQL Server client on the computer where you installed the SQL
Server database server, as all the client utilities are automatically installed during the SQL Server
database server installation. See your SQL Server User Guide for additional information about
SQL Server components and utilities.

Install SQL Server 2005 Client


1. Start SQL Server 2005 client Setup to open the Microsoft SQL Server 2005 CTP Setup
wizard.
2. Accept the licensing agreement.
3. Click Next until you reach the Registration page.
4. On the Registration page, type in the user details.
5. Click Next until you reach the Features Selection page.
6. On the Features Selection page, select the required features.
The Features Selection page should look similar to the following image:

SmartPlant P&ID Installation and Upgrade Guide

27

Microsoft SQL Server Installation and Configuration


7. Click Next until you reach the Setup Progress page.
The Setup Progress page displays the progress and status of the components being installed.

28

SmartPlant P&ID Installation and Upgrade Guide

Microsoft SQL Server Installation and Configuration


8. Click Next, the Completion page opens.

9. Click Finish, and restart the client machine.

SmartPlant P&ID Installation and Upgrade Guide

29

Microsoft SQL Server Installation and Configuration

30

SmartPlant P&ID Installation and Upgrade Guide

SECTION 6

Loading SmartPlant P&ID Prerequisite


Software
Install any required prerequisite software which is not yet installed on your computer. Note that
requirements may vary depending on your particular configuration.
Adobe Reader 8.0 (required to view the Software License Agreement and Printable Guides).
SmartPlant License Manager 2009 (10.00.05.00). The licensing is delivered on its own CD
that comes with your SmartPlant P&ID product CD.
Microsoft Office 2003 or 2007 (Microsoft Excel is required for working with report
templates and for viewing the Installation Checklist and various other files).
SmartPlant 3D Piping Specification Remote Access Client, Version 01.00. The Piping
Specification Client software is required for using SmartPlant 3D specifications in the
SmartPlant P&ID Piping Specification Utility and is available on the SmartPlant P&ID
product CD.

Install SmartPlant 3D Piping Specification Remote


Access Client
In order to use the Piping Specification utility with SmartPlant 3D, you must install the
SmartPlant 3D Piping Specification Remote Access Client.
1.
2.
3.
4.
5.

Insert the SmartPlant P&ID CD into the CD-ROM drive.


On the SmartPlant P&ID Installation screen, click Prerequisite Software.
Click SmartPlant 3D Piping Specification Remote Access Client Installation.
Follow the instructions to install the client software.
When the setup is complete, click Close to return to the list of prerequisite software.

Installing the SmartPlant P&ID Software


After installing and configuring the database software and any of the prerequisite software, you
are ready to install SmartPlant Engineering Manager and SmartPlant P&ID.

Grant Permissions to Write to a Registry Key


If you are installing over an older version of the SmartPlant software, you may receive an error
during the installation process stating that setup does not have permission to modify one or more
registry keys. This procedure explains how to grant write permissions to the registry keys for
computers running Windows XP.
SmartPlant P&ID Installation and Upgrade Guide

31

Installing the SmartPlant P&ID Software


1. Click Start > Run.
2. Type regedit.exe, and click OK.
3. In the left window, select the HKEY_LOCAL_MACHINE > SOFTWARE > Intergraph
> Applications registry key.
4. Right-click and select Permissions.
5. On the Permissions for dialog box, click Advanced.
6. At the bottom of the Advanced Security Settings dialog box, clear the option: Inherit from
parent the permission entries that apply to child objects. Include these with entries
explicitly defined here.
7. A security dialog box appears to verify your change. Click Remove.
8. Reselect the Inherit from parent the permission entries that apply to child objects.
Include these with entries explicitly defined here check box.
9. Select the Replace permission entries on all child objects with entries shown here that
apply to child objects check box.

Install SmartPlant Engineering Manager


1. Insert the product CD into the CD-ROM drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. Click SmartPlant Engineering Manager Installation.
3. Click Next to start the installation wizard.
4. Type your User Name, Company Name, and Serial Number, then click Next.
5. Verify your Name, Company, and Serial Number, then click Yes.
6. Click Display to view and read the license agreement. You must have Adobe Reader to
view the license agreement.
7. Close the Adobe Reader window, then click Yes to accept the license agreement.
8. Specify the Destination Folder, then click Next.
If you are installing the software on a 64-bit operating system, either do not
install to the Program Files (x86) folder (the default location), or if you do so, make sure that
you copy the seed files to another location that does not contain parentheses in the path.
9. Verify that the appropriate components are selected, then click Next.
If you want to upgrade your SmartPlant Engineering Manager data, be sure that you
select Upgrade Utility to install the SmartPlant Engineering Upgrade Utility. For more
information, see Using the SmartPlant Engineering Upgrade Utility
(Upgrade_EngDataOvr.htm).
10. Accept the default Program Folders or select a new Program Folder name, then click
Next.
11. Review your Current Settings, then click Next to install SmartPlant Engineering Manager.

32

SmartPlant P&ID Installation and Upgrade Guide

Installing the SmartPlant P&ID Software


12. Click Finish to close the installation wizard.
If you are reinstalling SmartPlant Engineering Manager, you must first remove the previous
SmartPlant Engineering Manager installation using the Add/Remove Programs option in
the Windows Control Panel.
Be sure to apply all available SmartPlant Engineering Manager service packs for the version
you are installing. For more information, please contact Intergraph Customer Support.

Install SmartPlant P&ID


If you have not already installed and configured SmartPlant License Manager on your
workstation, we recommend doing so before installing SmartPlant P&ID.
SmartPlant P&ID requires the SmartPlant License Manager software for concurrent
licensing for both the core SmartPlant P&ID product and for each manager. This licensing
software is delivered on its own CD that comes with your SmartPlant P&ID product CD. For
more information about using and configuring concurrent licensing, see the SmartPlant License
Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf).
1. Insert the SmartPlant P&ID CD into the CD-ROM drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. Click SmartPlant P&ID Installation.
3. Click Next to start the installation wizard.
4. Type your User Name, Company Name, and Serial Number, then click Next.
5. Verify your Name, Company, and Serial Number, then click Yes.
6. Click Display to view and read the license agreement. You must have Adobe Reader to
view the license agreement.
7. Close the Adobe Reader window, then click Yes to accept the license agreement.
8. Specify the destination folder, then click Next.
9. Verify that the appropriate components are selected, then click Next.
10. Accept the default Program Folder or type a new Program Folder name, then click Next.
11. Review your Current Settings, then click Next to install SmartPlant P&ID.
12. Click Finish.
If you do not plan to immediately make use of the system editing functionality introduced in
SmartPlant P&ID Version 4.2, you must take steps to make the Version 2009 software
behave more like Version 4.1, such as running the validation programs that are delivered
with Version 4.1 instead of the new programs delivered with Version 2009. All validation
programs that were configured for the plant before upgrading remain configured after
upgrade. The Upgrade Utility does not change the ProgIDs of validation programs in the
data dictionary. However, the uninstall and reinstall of the software on a client machine
deletes the Version 4.1 validation programs if you do not take measures to avoid it.

SmartPlant P&ID Installation and Upgrade Guide

33

Installing the SmartPlant P&ID Software


Before installing SmartPlant P&ID 2009, the old validation programs delivered with Version
4.1 should be moved to a different folder so that when the Version 4.1 software is
uninstalled, the old validation programs will not be deleted. When you install the Version
2009 software, the new validation programs are installed in their normal locations. After
installing the Version 2009 software, you must re-register the old Version 4.1 validation
programs. For more information, see Running in Version 4.1 Compatibility Mode.
Be sure to apply all available SmartPlant P&ID service packs for the version you are
installing. For more information, please contact Intergraph Customer Support.
If you try to install SmartPlant P&ID software when you do not have write permissions to
the registry on the computer on which you are installing, the following warning message
appears. For more information, see Grant Permissions to Write to a Registry Key (on page
31).

If Oracle software is not detected on the computer during the installation of SmartPlant
P&ID, the following warning message appears:

If you plan to use Oracle, click No to stop the installation process and install the Oracle
software before you proceed further. If you are planning to use Microsoft SQL Server
software, click Yes to continue with the installation process.

Uninstall a Previous Version of SmartPlant


Engineering Manager
1. From the Windows Control Panel, select Add or Remove Programs.
2. Select Intergraph SmartPlant Engineering Manager and then click Remove.
To uninstall a previous Service Pack, select the appropriate row in the Currently
installed programs list.

34

SmartPlant P&ID Installation and Upgrade Guide

Installing the SmartPlant P&ID Software


3. In the Installation for SmartPlant Engineering Manager wizard, on the Welcome page,
select Remove and then click Next.
4. At the message prompt to confirm removal of the software, click Yes.
5. On the Maintenance Complete page, click Finish.

Uninstall a Previous Version of SmartPlant P&ID


1. From the Windows Control Panel, select Add or Remove Programs.
2. Select Intergraph SmartPlant P&ID and then click Change/Remove.
To uninstall a previous Service Pack, select the appropriate row in the Currently
installed programs list.
3. In the Installation for SmartPlant P&ID wizard, on the Welcome page, select Remove
and then click Next.
4. At the message prompt to confirm removal of the software, click Yes.
5. On the Maintenance Complete page, click Finish.

Install SmartPlant Reference Data


1. Insert the product CD into the CD-ROM drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. Click SmartPlant Reference Data for P&ID Installation.
3. Click Next to start the installation wizard.
4. Click Display to view and read the license agreement. You must have Adobe Reader to view
the license agreement.
5. Close the Adobe Reader window, then click Yes to accept the license agreement.
6. Type your User Name and Company Name, then click Next.
7. Specify the Destination Folder, then click Next.
8. Verify that the appropriate components are selected, then click Next.
For a configuration in an integrated environment, be sure to install the Integration
Resource Files during reference data installation.
After installation, be sure the Integration Resource Path setting in Options Manager
points to this folder.
9. Review your Current Settings, then click Next to install the reference data.
10. Click Finish to close the installation wizard.
11. After installation, share the folder that contains the reference data. All SmartPlant users
must be granted read permission to this share. Write permission to the share is required to
make changes to the symbols, rules, templates, and other reference data.
We recommend that you make a copy of the reference data and store it with your
plant files. This common practice will help you with future service pack installations, data
recovery, and so forth.

SmartPlant P&ID Installation and Upgrade Guide

35

Installing the SmartPlant P&ID Software

Configuring Reference Data for SmartPlant P&ID


SmartPlant Reference Data for P&ID contains the symbols, rules, labels, styles, templates,
insulation specification and other information that you use to create a P&ID. The default
location for the reference data is C:\Program Files\SmartPlant\P&ID Reference Data.
If the reference data is located elsewhere, use SmartPlant P&ID Options Manager to identify the
location of symbols, rules, labels, and other reference data for the application. You can also
define symbology for graphics, default formats for data, and key distances that affect the
behavior of the application. Usually, a project manager sets these options at the beginning of a
project. The project manager seldom modifies these options except on rare occasions when
project requirements dictate a change. For more information about using SmartPlant P&ID
Options Manager, see Customizing Your Reference Data (on page 103).
You no longer need to set the default data locations in Options Manager before creating a
P&ID in SmartPlant Drawing Manager. These locations are set at the time of plant structure
creation. The drawing template path should be set to the correct node name and share name
so that the software can locate the templates for P&ID creation. For the correct share name,
see Install SmartPlant Reference Data (on page 35).
For a configuration in an integrated environment, be sure the Integration Resource Path
setting in Options Manager points to the Integration Resource Files installed with the
SmartPlant P&ID Reference Data.

Installing SmartPlant P&ID in Silent Mode


Silent mode installation is a two-stage process. First, you perform a normal installation by
running the setup.exe file from the command line with special parameters that cause the software
to record the installation session and the options you choose to a file with an .iss extension.
Then, from any workstation, you can run setup in silent mode using the recorded .iss file to
provide the necessary setup information.
Because SmartPlant P&ID installation requires SmartPlant License Manager software for
concurrent licensing, you must install the SmartPlant License Manager software on your
workstation prior to creating a silent setup of SmartPlant P&ID and on each workstation
where you will be silently installing SmartPlant P&ID. For more information about
installing and configuring SmartPlant License Manager, see the SmartPlant License
Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf).
The environment of the machine on which you run the normal setup to create the .iss file and
the environment of the workstations on which you perform the silent mode installation must
be identical; that is, they must have the same database platforms, software versions, installed
files, drive partitions, and so forth. You must also ensure that there is sufficient disk space
on each workstation for the installation.

36

SmartPlant P&ID Installation and Upgrade Guide

Installing the SmartPlant P&ID Software


Prior to creating a silent setup of SmartPlant P&ID over a network, ensure that the following
conditions exist:
For a new release, all previous existing versions of SmartPlant P&ID on the target
machine have been uninstalled prior to network installation.
The target machine does not have a directory by the same name to which SmartPlant
P&ID is to be installed.
The target machine meets the free disk space recommendations specified in SmartPlant
P&ID Workstation (SPELInstall_Workstation_Reqs_1a.htm).
All applications are closed.

Install SmartPlant P&ID in Silent Mode


1. Open a Command Prompt window from the Start menu.
2. At the command prompt, type:
"<setup source folder path>\setup.exe" -r -f1"<path>\<filename>.iss".
Be sure the <setup source folder path> specifies the path to the folder that
contains the setup.exe file that launches the SmartPlant P&ID InstallShield Wizard, not the
setup.exe file that launches the SmartPlant P&ID AutoPlay executable. For example, on the
SmartPlant P&ID CD, the setup.exe file in the P&ID folder is the file that launches the
InstallShield Wizard. Double quotes are required only if the path to the setup.exe file
contains spaces.
The -r parameter tells setup to automatically generate the silent setup file
(<filename>.iss), and to record all setup input.
The - f1"<path>\<filename>.iss" parameter specifies the path and filename for the
silent setup file. The double quotes are required around this path, with no space between
the -f1 and the opening double quotes. For example, if you type the following command
string, the software places the resulting .iss file in the c:\installfiles folder.
\\sourceserver\instrumentation\setup.exe -r - f1"c:\installfiles\silentsetup.iss"
3. Work through the standard software installation on your database platform. For details, refer
to the appropriate procedure in the SmartPlant P&ID Installation and Upgrade Guide.
When you click Display on the License Agreement dialog box while running setup
in record mode, the following message appears.

SmartPlant P&ID Installation and Upgrade Guide

37

Installing the SmartPlant P&ID Software


Click OK to acknowledge that you are accepting the license agreement for all users on
whose computers you will install the product. Setup then returns you to the normal
installation process by displaying the license agreement and enabling the Yes button on
the License Agreement dialog box.
4. At each workstation on which you want to install the software, open a Command Prompt
window and type:
"<setup source folder path>\setup.exe" -s -f1"<path>\<filename>.iss" f2"<path>\<filename>.log"
Be sure to use the same setup executable that you used in step 3 above.
The -s parameter tells setup to run in silent mode using the indicated .iss file.
The - f1"<path>\<filename>.iss" parameter specifies the path and the filename for the
silent setup (.iss) file you want to run. The double quotes are required, with no space
between the -f1 and the opening double quotes. For example, f1"c:\installfiles\silentsetup.iss".
(Optional) Use the - f2"<path>\<filename>.log" parameter to record a log file of the
setup process. The double quotes are required, with no space between the -f2 and the
opening double quotes. For example, - f2"c:\installfiles\silentsetup.log". If -f2 is not
defined, a log file is created in the same location as the .iss file.
5. Check the .log file to ensure that the installation proceeded without errors. A successful
silent installation produces a .log file looking something like this:
[InstallShield Silent]
Version=v7.00
File=Log File
[ResponseResult]
ResultCode=0
[Application]
Name=SmartPlant P&ID
Version=2009 (xx.xx.xx.xx)
Company=Intergraph
Lang=0009 In general, if an error occurred, the ResultCode will be a number less than
zero. Possible result codes include the following:
Any value greater than 0 = Success.

38

-1

General error

-2

Invalid mode

-3

Required data not found in the


Setup.iss file

-4

Not enough memory available

-5

File does not exist

-6

Cannot write to the response file

-7

Unable to write to the log file


SmartPlant P&ID Installation and Upgrade Guide

Installing the SmartPlant P&ID Software


-8

Invalid path to the InstallShield Silent


response file

-9

Not a valid list type (string or number)

-10

Data type is invalid

-11

Unknown error during setup

-12

Dialog boxes are out of order

-51

Cannot create the specified folder

-52

Cannot access the specified file or


folder

-53

Invalid option selected

This procedure also applies to the uninstall operation. The uninstall procedure should use
the same command and procedures as for the installation, both for the record mode and for each
workstation mode; however, you should specify a different name for the .iss file so as not to
overwrite the file used for the installation.

SmartPlant P&ID Installation and Upgrade Guide

39

Installing the SmartPlant P&ID Software

40

SmartPlant P&ID Installation and Upgrade Guide

SECTION 7

Working in Thin Client Mode


Overview
You can use SmartPlant P&ID in thin client mode, which supports Citrix Presentation Server or
Microsoft Terminal Server using Remote Desktop for Administration. For installation details of
Citrix Presentation Server client / server or Microsoft Terminal Server, refer to the appropriate
software vendor's documentation. When working in an integrated environment, thin client mode
operation is used as the means of providing Workshare.
When you access the SmartPlant P&ID application via Citrix, we strongly recommend that
you do not perform any administration activities that run automatically for a long time on a
client machine. When you execute administration activities via Citrix client, the software
actually performs these activities on the server side, while the client remains idle, and the
connection to Citrix is lost, possibly resulting in corruption of data. Examples of these type
of administration activities are: upgrading the database to a new version or importing a large
number of drawings.
As a workaround, we recommend that you perform these kind of activities either on your
database server machine or on a client machine using a configuration other than Citrix.
When using thin client mode, all users share a common database, resulting in intellectual
property being shared between all sites.

Comparison of Thin Client Mode and SmartPlant P&ID


Workshare
For data sharing between sites, you can use SmartPlant P&ID's Workshare functionality or you
can run SmartPlant P&ID in thin client mode using Citrix Presentation Server or Microsoft
Terminal Server.

Using SmartPlant P&ID Workshare


Users on the host and on each satellite work in separate databases. This means that it is possible
to segregate intellectual property between sites by transferring only the data that needs to be
shared. When using Workshare, it is necessary to update reference data at remote locations and
to move data between sites.

Using Thin Client Mode


All users share a common database, so that there is no need to update reference data at remote
locations or to move data between sites.

SmartPlant P&ID Installation and Upgrade Guide

41

Working in Thin Client Mode

Tuning the Software for Use in Thin Client Mode


The following procedures describe special instructions for the installation of SmartPlant P&ID
when working in thin client mode using Citrix Presentation Server 4.5 on Windows 2003
Server. Tuning SmartPlant P&ID involves performing the following operations:
Installing P&ID on a Citrix Presentation Server.
Publishing the P&ID program to view P&ID on a web page or in a published Citrix
application list.
Configuring Citrix Presentation Server for P&ID.

Publish the SmartPlant Application


You need to publish the application to allow you to view the data using a web page.
1. On the Start menu, click Programs > Citrix > Metaframe Presentation Server to start the
Citrix Management Console.
The names of dialog boxes may vary from the ones described in this document
according the version of Citrix Presentation Server that you are using.
2. Click Action > New > Published Application.
3. In the Published Application wizard, type a display name such as SmartPlant P&ID, and
an application description, and then click Next.
4. On the Specify What to Publish page, do the following:
a. Click the Application option button (the default).
b. Beside Command Line, click Browse to navigate to the SmartPlant P&ID executable
file location.
c. Click Next.
5. On the Program Neighborhood Settings page, if desired, define a program neighborhood
folder and add shortcuts for the clients, and then click Next.
6. On the Specify Application Appearance page, specify the window size, color, and start-up
settings according to your needs, and then click Next.
7. On the Specify ICA Client Requirement page, accept the default value, and then click
Next.
8. On the Specify Servers page, add the Citrix server and then click Next.
9. On the Specify Users page, add the user accounts that are to be granted access to the
published application and then click Finish.
10. After publishing the application, do the following to create the .ica and .html files:
a. On the Citrix Management Console, select the SmartPlant P&ID application, rightclick, then click Create ICA File and follow the wizard instructions.
b. On the Citrix Management Console, select the SmartPlant P&ID application, rightclick, then click Create HTML File and follow the wizard instructions.

42

SmartPlant P&ID Installation and Upgrade Guide

Working in Thin Client Mode

Configure Citrix Presentation Server 4.5


1. Configure Citrix Presentation Server to mount a user drive with a common drive letter (for
example, U:) and create a common folder path for the program in this drive, for example,
U:\Program Files\SmartPlant\P&ID Workstation.
To prevent performance problems that may be caused if the software maps drive U: to a
server that is very remote from the Citrix server, ensure that the U: drive is on or local to
the Citrix server and that the 'TS Roaming Profiles' option is enabled.
Make sure that the common folder path contains the SmartPlantV4.ini file. You can also
use this folder for temporary files.
Modify the system path statement on the server to include the common folder path in the
system path.

Terminal Server Logon Sequence


The following section describes the logon sequence of system procedures carried out
automatically.
Ensure that you have edited the Rootdrv2.cmd file to specify the home folder drive
letter. For this installation, you need to change the line Set RootDrive=DriveLetter to Set
RootDrive=U. The U: drive points to C:\Documents and Settings\<username>.
1. When a user logs on to Windows 2003 Server, a logon script Userlogon.cmd starts running.
Therefore, you can run any pre-logon command or script from this file.
2. The Userlogon.cmd file calls the Userlogn1.cmd file which contains the compatibility logon
scripts.
3. The Userlogon.cmd file checks whether you have set up the logon to the user's home folder.
The Userlogon.cmd file then calls the Rootdrv.cmd file located in the path
C:\Winnt\Application Compatibility Scripts.
4. The Rootdrv.cmd file calls the Rootdrv2.cmd file.

SmartPlant P&ID Installation and Upgrade Guide

43

Working in Thin Client Mode

44

SmartPlant P&ID Installation and Upgrade Guide

SECTION 8

Upgrading to SmartPlant P&ID 2009


Upgrading from SmartPlant P&ID Version 4.3, 2007, or 2007.x to Version 2009 involves the
following steps:
1. Correcting Oracle database constraint violations using SmartPlant P&ID Version 4.3, 2007,
or 2007.x. If you are using SQL Server, you can skip this step.
2. Upgrading the plant, project, satellite, and application database tables of SmartPlant P&ID
Version 4.3, 2007, or 2007.x using Version 2009 of the SmartPlant Engineering Manager
Upgrade Utility.
3. Upgrading reference data using SmartPlant P&ID Options Manager 2009.
4. Updating drawings, when necessary, using SmartPlant P&ID Drawing Manager 2009.
If you are upgrading from an earlier version of SmartPlant P&ID to those mentioned above,
you must first upgrade that version to SmartPlant P&ID 4.3 (SmartPlant Engineering
Manager 4.4) using Version 4.4 of the Upgrade Utility, before upgrading to Version 2009.
For more information, visit the Intergraph support Web site: http://support.intergraph.com
(http://support.intergraph.com/).
SmartPlant Engineering Manager 2009 can display sites and plants created in SmartPlant
Engineering Manager Versions 4.4 (SmartPlant P&ID 4.3), 2007, or 2007.x. While the
plants that have not been upgraded will appear in the Tree view, none of the data below the
plant will be available. Attempting to work in a non-upgraded plant results in a message
stating that the plant must be upgraded first.
Before using the new version of the software, we strongly recommend that you completely
upgrade your plant and update all drawings to the current version. A plant with a mixture of
upgraded and non-upgraded data may result in some data being permanently inaccessible.
When upgrading from SmartPlant P&ID 4.1, it is recommended that you reference the new
Llama type library in your legacy projects and recompile. This helps to ensure that any
version compatibility issues can be detected right away. If any functionality of the previous
type library version has been changed or deleted, legacy code may not perform as expected.
To prevent errors when running the PrintFromToData Line List report, de- reference the
older version Llama type library and reference the new 6.0 version of Llama.

Correcting Database Constraint Violations


Before you can begin upgrading, you must make sure the SmartPlant P&ID data stored in your
Oracle database is compliant with the database constraints. To help you identify non-compliant
data, use the Database Constraint Report.exe reporting utility delivered with your current
version of SmartPlant P&ID before installing the latest version.

SmartPlant P&ID Installation and Upgrade Guide

45

Upgrading to SmartPlant P&ID 2009

Tasks for correcting constraint violations


1. Make a complete backup of the data you are upgrading.
2. Generate a Database Constraint Exceptions Report. For more information, see Generate a
Database Constraint Exceptions Report (on page 46).
3. Clean up the database by removing orphan model items. For more information, see Clean
Data Utility (DelOrpModItems.dll) in the SmartPlant P&ID Utilities Guide.
4. Resolve constraint violations. For more information, see Constraint Utilities (on page 47).
5. Generate a database constraint exceptions report again.
6. Run the appropriate constraint utilities again if any exceptions still exist.
7. Continue running the database constraint report and the constraint utilities until no
exceptions are reported.
8. Make a complete backup of the now compliant data.
If you are using Microsoft SQL Server, you can skip this database constraints process.
For additional information on resolving discrepancies listed in the database constraint report,
contact your custom service representative.

Generate a Database Constraint Exceptions Report


Use SmartPlant P&ID or one of its manager applications to connect to the plant on which you
want to run the Database Constraint Exception Report utility.
If you use SmartPlant P&ID to connect to the plant, be sure to close all drawings
before proceeding.
1. In the Program Files\SmartPlant\P&ID Workstation\Program folder, double-click the
Database Constraint Report.exe file.
2. On the Database Constraint Exception Report Utility dialog box, click Connect to
Active Plant.
The utility runs the report on the active plant that you are connected to at the
time. To run a report on another plant, connect to that plant using SmartPlant P&ID or one
of its manager applications.
3. After connecting to the database, click the Create Database Constraint Report button.
This process may take several minutes, depending on the amount of data you have in your
plant.
4. When complete, the utility automatically saves a copy of the report in the temp directory
under your user profile and displays the file name (plant name - ConstraintExceptions.xls)
in the list box on the right side of the Database Constraint Exception Report Utility
dialog box.
5. Exit the Database Constraint Exception Report utility.
6. Open the report using Microsoft Excel and save a copy of the report to another location other
than the temp directory.

46

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


7. Review the completed report for discrepancies that must be resolved before you can upgrade
to the new version of SmartPlant P&ID. We recommend running this utility again until no
discrepancies are reported.
Microsoft Excel must be installed on any workstation from which you run the Database
Constraint Exception Report utility.
Workshare must be disabled before cleaning up any constraint violations.

Database Constraint Report Results


The Database Constraint Report file is a Microsoft Excel file containing several worksheets.
The first sheet in the report is the Report Progress Messages, which contains a list of the
constraint checks made and the number of violations detected for each constraint check. Each
violation type appears on its own worksheet, with the name of the constraint violation displayed
on the worksheet tab.
Each worksheet also contains a list of drawings containing constraint exceptions, along with the
name of the recommended constraint utility (usually in cell B1) to use in resolving the violation.
All constraint utilities (see "Using Constraint Utilities" on page 47), including the Clean
Data utility (DelOrphModItem.dll), are run on an open drawing inside SmartPlant P&ID.
However, unlike all the other constraint utilities that run on a drawing-by-drawing basis, the
Clean Data utility runs on the entire plant data set. If Clean Data is used to resolve any particular
constraint violation, a particular drawing will not be specified in the report for this constraint
violation nor will a utility name be listed at the top of the worksheet.

Using Constraint Utilities


Before running any of the constraint utilities recommended by the database constraint report, run
the Clean Data utility inside a blank drawing, then run the Database Constraint Report.exe
again. Running Clean Data first decreases the number of exceptions listed in the report and
lessens the amount of further manual data cleanup required. For more information about running
the Clean Data utility, see Clean Data (Delete Orphan Model Items) in the SmartPlant P&ID
Utilities Guide.
The remaining constraint utilities must be run from within specific drawings. These utilities are
located in the C:\Program Files\SmartPlant\P&ID Workstation\Program folder, along with the
Clean Data (DelOrphModItems.dll) utility.
Each plant may require a different set of utilities. Open each drawing listed in the database
constraint report and run the recommended macros on the drawing. You need to run only the
macros listed in the report for that particular drawing.

Constraint Utilities
Delivered with SmartPlant P&ID, the following constraint utilities help you correct any database
constraint exceptions reported in the database constraint exception report.

SmartPlant P&ID Installation and Upgrade Guide

47

Upgrading to SmartPlant P&ID 2009


In general, each utility attempts to repair the constrain violation. However, in some cases the
violation could not be cleaned up by the utility and the item is band-aided in the drawing. This
situation is noted and logged in each utility's corresponding log file. For more information, see
Constraint Utilities Log Files (on page 49).
You must manually fix any band-aided items in a drawing by deleting the item and
replacing it. If you have difficulty finding the band-aided items, click Tools > Options in
SmartPlant P&ID, then select the Display as Printed option on the Options > General tab.
cmdnotconnectedcomps.dll Repairs items that have a relationship to a PipeRun or
SignalRun (sp_piperunid or sp_signalrunid are not null), but are not referenced by a
corresponding connector. If the relationship cannot be repaired, you must delete it and replace
it.
cmdLPCheck.dll Checks for LabelPersist records pointing to a representation that does not
exist. If the graphical label is watching a graphic, the database is updated to match, thus
repairing the LabelPersist. If the label cannot be repaired, the utility band-aids it. You should
delete and replace these band-aided items.
cmdRepOIDCheck.dll Checks for symbol records with a null graphic OID. If the graphical
symbol exists, the utility repairs the item by updating the database with its graphic OID value. If
the graphical symbol does not exist, the utility sets the InStockpile flag = True to repair the item.
ConnectorItem12.dll Checks for connector records pointing to a symbol that does not exist.
If the graphical connector is connected to a symbol, the utility repairs the connector by updating
the database to match. If the connector cannot be repaired, the utility band-aids it. You should
delete and replace these band-aided items.
OPCFK.dll Checks for OPC records with a partner that does not exist. If the graphical OPC
exists, fix it. You should delete these items.
PointIndexCheck.dll Checks for PipingPoint records and SignalPoint records with nonunique indices or point numbers, then repairs the item by deleting from the database whichever
one of the duplicate points is not loaded into the cache.
RelationshipOIDMacro.dll Checks for relationship records with a null graphic OID. If the
graphical relationship indicator exists, the utility repairs the item by updating the database with
its graphic OID value. If the graphical relationship indicator does not exist, the utility deletes the
relationship from the database.
RepairBadConnector.dll Checks for connectors with the same start and end objects and
connectors with the wrong number of vertices. The utility band-aids the graphical connector,
which you should delete.
RepairNullFileNameCmd.dll Checks for LabelPersist records with a null file name value.
If the number of LabelPersist records equals the number of SmartLabel objects locked to the
watched symbol, the utility repairs the LabelPersist record by updating the filename value
for the LabelPersist.
If the number of LabelPersist records does not equal the number of SmartLabel objects
locked to the watched symbol, then the utility band-aids the watched symbol. You should
delete band-aided items.

48

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


For the remaining LabelPersist records with a null filename, if the graphic exists, the utility
band-aids it. You should delete band-aided items. If the graphic does not exist, the utility
deletes the representation from the database.
RepairOrphanedNozzleCmd.dll - Checks for the following situations.
Nozzle records without a Parent If the Nozzle graphic is not in the drawing, the utility
repairs the nozzle by setting the Instockpile flag = True. If the Nozzle graphic is in the
drawing, the utility tries to set either the SP_EquipmentID or SP_PartOfID based on the
graphic relationship. The graphic parent must be an equipment or equipment component for
the relationship to be re-established. If the relationship cannot be re-established, the utility
band-aids it. You should delete band-aided items.
Nozzles associated via SP_EquipmentID to a Parent in the stockpile - If the Nozzle
graphic is not in the drawing, the utility repairs the Nozzle by setting the Instockpile flag =
True. If the Nozzle graphic is in the drawing, the utility band-aids it. You should delete
band-aided items.
Nozzles associated via SP_PartOfID to a Parent in the stockpile If the Nozzle graphic
is not in the drawing, the utility repairs the Nozzle by setting Instockpile flag = True. If the
Nozzle graphic is in the drawing, the utility band-aids it. You should delete band-aided
items.
Nozzles that are a Part of a Run The utility clears the SP_PartOfID attribute. If the
Nozzle graphic is not in the drawing, the utility repairs the Nozzle by setting the Instockpile
flag = True. If the Nozzle graphic is in the drawing, the utility band-aids it. You should
delete band-aided items.

Constraint Utilities Log Files


Each constraint utility generates a log file, which records each action taken to correct the
constraint violation.
Log files are located at the path specified in your TEMP environment variable.

Constraint Utility

Log File

cmdnotconnectedcomps.dll

RepairNotConnectedComps.log

cmdLPCheck.dll

RepairBadEmbLabelCmd.log

cmdRepOIDCheck.dll

RepresentationOIDChecks.log

ConnectorItem12.dll

ConnectorItem12_Check.log

DelOrpModItems.dll (CleanDB)

SPDelOrpModItems.log
DBCleanup.txt

OPCFK.dll

OPC_OPC_FK.log

PointIndexCheck.dll

PointIndexConstraint_check.log

RelationshipOIDMacro.dll

RelationshipOID_Checks.log

RepairBadConnector.dll

RepairBadConnector.log

SmartPlant P&ID Installation and Upgrade Guide

49

Upgrading to SmartPlant P&ID 2009

Constraint Utility

Log File

RepairOrphanedNozzleCmd.dll

RepairOrphanedNozzles_.pid.log

RepairNullFileNameCmd.dll

RepairNullFileNameCmd.log

Before Running the Upgrade Utility


The following tasks must be completed before you begin upgrading your plant using the
Upgrade Utility.
If you are using an Oracle database, the Upgrade Utility checks your Oracle data for compliance
with the SmartPlant P&ID database constraints. If you have not already generated a Database
Constraint Report on your data using your current version of SmartPlant P&ID and cleared up
any discrepancies, run the Database Constraint Report.exe before installing the new software
and proceeding with the upgrade. This utility is delivered to the C:\Program
Files\SmartPlant\P&ID Workstation\Program folder by default.

Back Up Your Data


Before you upgrade, back up your existing site and plant data using the Backup and Restore
functionality in SmartPlant Engineering Manager.

Share Paths to Site .INI Files


The Upgrade Utility must be able to read the site INI file for the site containing the plants being
upgraded. Create a UNC network share to the folder containing the site INI file and be prepared
to provide this path during the upgrade process.

Set Oracle Parameters


If you are using an Oracle database, you must modify the following parameters in the initsid
name.ora file using Oracle Enterprise Manager before you begin your upgrade. After
completing the upgrade process, reset these parameters to their original values.
OPEN_CURSORS Set to at least 500. You can use a higher number if necessary for other
applications. SmartPlant uses open cursors to improve performance and scalability for database
inserts, updates, and deletes.
Hash Parameters Provide extra memory for the Oracle hash procedure by setting the
following hash parameters to the values shown below. The upgrade process runs much faster if
the hash table fits in RAM, rather than being written to and read from the disk. Therefore, by
providing extra memory for this procedure during the upgrade process, you can significantly
reduce the time required.
hash_join_enabled=true

50

True is the default setting. However,


you should make sure the setting was
not previously changed to False.

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


hash_area_size=number

This setting determines how much


RAM is available for use by the hash
tables. The default value for
hash_area_size is 131072, and the
value you enter for number should be
a multiple of this default value. The
new value should be as large as
possible without interfering with the
needs of the operating system. A
value of 1310720 (default x 10)
would not be unreasonable for a
server with a gigabyte or more of
memory.

Memory Management Considerations


Upgrading database information requires significant changes and, therefore, a significant amount
of database server resources. For that reason, Intergraph makes the following recommendations.
Upgrade only one plant at a time on a database server.
As much as possible, limit other activity on the database server during the upgrade process.
You should limit the use of SmartPlant applications on the server, as well as access to the
database by other plants.
The more database server resources available for upgrade, the faster the upgrade process will
proceed. The more activity occurring on the database server during the upgrade process, the
longer that process will take.

SmartPlant P&ID Installation and Upgrade Guide

51

Upgrading to SmartPlant P&ID 2009

52

SmartPlant P&ID Installation and Upgrade Guide

SECTION 9

Using the SmartPlant Engineering Manager Upgrade


Utility
The SmartPlant Engineering Manager Upgrade Utility upgrades the plant and application
databases to the latest version of SmartPlant.
Version 2009 of the SmartPlant Engineering Manager Upgrade Utility allows you to upgrade
plants created in the following software:

SmartPlant Engineering
Manager

SmartPlant P&ID

SmartPlant
Electrical

Version 4.4

Version 4.3

Version 3.5

Version 2007

Version 2007

Version 2007

Version 2007.x

Version 2007.x

Version 2007.7

For SmartPlant Electrical, the software cannot perform an upgrade of an archive. However,
you can create an archive of an upgraded plant as soon as you complete the upgrade.
You are not required to upgrade all plants in a particular site at the same time. However,
plants that share reference data, such as styles, templates, and symbols, should be upgraded
at the same time.

Upgrading Plants Created with SmartPlant Engineering Manager Prior to Version 4.4
Plants created prior to version 4.4 must first be upgraded to version 4.4 or 2007 before they can
be upgraded to version 2009.
Version 4.1 must be first upgraded to version 4.4 using the Upgrade Utility version 4.4.
Versions 4.2 and 4.3 can be upgraded using any of the following versions of the Upgrade Utility:
4.4
2007
2007.x
After upgrading plants to version 4.4 or higher use version 2009 of the Upgrade Utility to
upgrade your plants to Version 2009.

Upgrading Plants Containing Projects


Running the Upgrade Utility on a plant containing projects upgrades both the plant and its
projects at the same time. Each of the upgrade tasks handles any necessary changes in both the
plant databases and the project databases.

SmartPlant P&ID Installation and Upgrade Guide

53

Upgrading to SmartPlant P&ID 2009

Upgrading Satellites in a Workshare Collaboration


You no longer have to collapse or shut down projects or satellites in Workshare collaborations
before upgrading. Upgrading a satellite is a separate process. The host for a connected satellite
must be upgraded before the satellite.

Upgrading a Site
When you open a site created in Version 4.4, 2007, or 2007.x using SmartPlant Engineering
Manager 2009, you are prompted to upgrade that site to Version 2009.
Use the Upgrade Site command to perform the upgrade. This command removes the restriction
in which projects with the same name cannot reside in the same plant and then updates the site
data dictionary version number to 2009.
Upgrading a P&ID site is only possible when the source and target have the same
character set.

Upgrade a Plant
After you select the site containing the plants you want to upgrade, the SmartPlant Engineering
Upgrade Utility displays a list of active plants that are available for upgrade.

1. Select the plant in the Tree view to see the available applications that can be upgraded for
that plant.

54

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


2. Right-click the active plant and select Upgrade Plant from the shortcut menu. The utility
moves the plant from the Active plants node to the Upgrades in progress node and
displays the list of upgrade tasks required to upgrade the selected plant.

3. Right-click in either view and select Finish Next Task to start the first upgrade task.

4. If there is more than one task in the Upgrade Tasks view, click Finish All Tasks to
complete the plant upgrade. After the plant is upgraded, the utility moves it back under the
Active plants node and updates the plant status in the Upgrade Tasks view to Up-to-date.

Oracle users, for the upgrade process to finish correctly after upgrading your plants and
associated applications, the Convert Oracle Data Type process must be carried out. Unless
you do so, you will not be able to work with a plant in SmartPlant Engineering Manager,
SmartPlant Electrical, or SmartPlant P&ID.
You must complete all upgrade tasks for a plant before you upgrade the reference data or
drawings in the plant.
The rules file for the upgraded plant are marked as out-of-date for the Update Drawings
commands in Drawing Manager. The formats and select lists will also be marked as out-ofdate.

SmartPlant P&ID Installation and Upgrade Guide

55

Upgrading to SmartPlant P&ID 2009

Upgrade SmartPlant P&ID


Upgrading a P&ID site is only possible when the source and target are using the
same character set.
1. Select the plant in the Active Plants node, right-click and select the Upgrade P&ID
command.

2. The utility moves the plant from the Active Plants node to the Upgrades in progress node
and displays the list of upgrade tasks required to upgrade the P&ID application.

3. Right-click in either view and select Finish Next Task to start the first upgrade task.

56

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


4. When the first task finishes, click Finish All Tasks to complete the application upgrade.

5. After the application is upgraded, the utility moves the plant back under the Active plants
node and updates the application status in the Upgrade Tasks view to Up-to-date.

Oracle users, for the upgrade process to finish correctly after upgrading your plants
and associated applications, the Convert Oracle Data Type process must be carried out. Unless
you do so, you will not be able to work with a plant in SmartPlant Engineering Manager,
SmartPlant Electrical, or SmartPlant P&ID.

See Also
Finish Next Task Command (see "Finish Next Task Command (File Menu)" on page 59)
Run to Selected Task Command (see "Run to Selected Task Command (File Menu)" on page 59)
Upgrade P&ID Command (see "Upgrade P&ID Command (Upgrade Menu)" on page 61)

SmartPlant P&ID Installation and Upgrade Guide

57

SECTION 10

Upgrade Utility Commands


The Upgrade Utility provides the following commands.

In This Section
Open Site Command (File Menu).................................................. 59
Finish Next Task Command (File Menu) ...................................... 59
Finish All Tasks Command (File Menu) ....................................... 59
Run to Selected Task Command (File Menu)................................ 59
Show Log Command (File Menu) ................................................. 60
Upgrade Site Command (Tools Menu).......................................... 60
Upgrade Plant Command (Upgrade Menu) ................................... 60
Upgrade P&ID Command (Upgrade Menu).................................. 61

Open Site Command (File Menu)


Allows you to select another site containing other plants you want to upgrade.

Finish Next Task Command (File Menu)


Runs the first incomplete task in the Upgrade Tasks view. The status of each task appears in the
Status column.
The Upgrade Utility records how far it progresses during an upgrade task so that it can
recover if system problems occur.

Finish All Tasks Command (File Menu)


Runs all incomplete tasks listed in the Upgrade Tasks view. The status of each task appears in
the Status column.
The Upgrade Utility records how far it progresses during an upgrade task so that it can
recover if system problems occur.

Run to Selected Task Command (File Menu)


Runs all incomplete tasks up to and including the selected task. The status of each task appears
in the Status column in the Upgrade Tasks view.
The Upgrade Utility records how far it progresses during an upgrade task so that it can
recover if system problems occur.

SmartPlant P&ID Installation and Upgrade Guide

59

Upgrading to SmartPlant P&ID 2009

Show Log Command (File Menu)


Displays the upgrade log file.
The upgrade log file contains a list of all changes made during the upgrade, including each
upgrade subtask.
The log file, named UpgradeV4_plantname.log, is saved in the folder where the drawings
for the plant are stored.

Upgrade Site Command (Tools Menu)


This command removes the restriction in which projects with the same name cannot reside in the
same plant and then updates the site data dictionary version number to 2009. For more
information, see Upgrading a Site (on page 54).

Upgrade Plant Command (Upgrade Menu)


Displays the upgrade tasks required for the plant upgrade process. On choosing this command,
the utility moves the plant from the Active plants node to the Upgrades in progress node and
displays the list of upgrade tasks required to upgrade the selected plant.

Click File > Finish Next Task or File > Finish All Tasks to actually start the upgrade process.
If you have not yet run a task, you can cancel the upgrade process by selecting the plant under
the Upgrades in Progress node and clicking File > Cancel to restore the pre-upgrade state.
Oracle users, for the upgrade process to finish correctly after upgrading your plants and
associated applications, the Convert Oracle Data Type process must be carried out. Unless
you do so, you will not be able to work with a plant in SmartPlant Engineering Manager,
SmartPlant Electrical, or SmartPlant P&ID.
You must complete all upgrade tasks for a plant before you upgrade the reference data or
drawings in the plant.
The rules file for the upgraded plant are marked as out-of-date for the Update Drawings
commands in Drawing Manager. The formats and select lists will be marked as up-to-date.

60

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


You cannot upgrade a backed-up plant without restoring it first.
For a list of all changes made during the plant upgrade, including each upgrade subtask, see
the plant upgrade log file. The log file, named UpgradeV600_plant name.log, is saved in
the folder where the plant structure resides.
To view the plant upgrade log file, select the plant in the Tree view, and then click File >
Show Log.

Upgrade P&ID Command (Upgrade Menu)


Displays the upgrade tasks required for the SmartPlant P&ID application upgrade process. Click
one of the File > Finish commands to actually start the upgrade process.

See Also
Upgrade SmartPlant P&ID (on page 56)

After Running the Upgrade Utility


After you complete all of the upgrade tasks for a plant, make a full backup of the upgraded
databases. You should also use the Oracle analyzer scripts to optimize your databases.

Backup Each Upgraded Plant


After you have completed the upgrade process for each plant, you should do the following:
1. Set the backup location for the plant in SmartPlant Engineering Manager and perform a full
backup. For more information about backing up a plant, see the Backup and Restore
section in the SmartPlant Engineering Manager Help.
2. Perform a complete database backup.
3. Perform a file system backup to archive the drawings, reference data, and other files.

Use Oracle Analyzer Scripts


The Oracle performance tuning documentation recommends analyzing the database objects after
a large number of records have been added. These analyzer scripts collect statistics and store
them internally in the database to determine potential execution paths so that the one with the
lowest cost can be selected for use. After the upgrade, you should add these scripts to your
nightly backup routine.

Preserve Software Customizations


The Upgrade Utility does not make changes that might overwrite user customization of display
names, property formats, calculation programs, validation programs, or layouts.

SmartPlant P&ID Installation and Upgrade Guide

61

Upgrading to SmartPlant P&ID 2009


A data dictionary change made during an upgrade can cause layouts that use
PipingPoint properties to have an incorrect caption or column heading. None of the default
layouts delivered during installation include PipingPoint properties. However, if you added
these properties to one of the default layouts or created a new layout with PipingPoint properties,
you can manually revise the captions for any layouts that use PipingPoint properties after you
upgrade by doing the following:
1. Open SmartPlant P&ID.
2. In the list on the Engineering Data Editor toolbar, select the saved view that contains
PipingPoint properties.
3.
4.
5.
6.

In the Engineering Data Editor, click the View


menu and select Edit View.
On the Table Properties dialog box, click Advanced.
Click the Layout tab.
In the Display Property list, select the PipingPoint property.
PipingPoint properties start with the word End, such as End, End 2, End 3, and End 4.

7. Confirm that the caption is appropriate for the property.


8. If you need to modify the caption, make changes in the Caption box at the bottom of the
Advanced Table Properties dialog box.

Making Manual Changes


After running the Upgrade Utility, you must still perform the following changes for SmartPlant
P&ID 2009 manually:
Opening and saving the rules file so that the new rule options are added to the Rules.rul file.
Possibly copying any new or modified symbols from ~\Program Files\SmartPlant\P&ID
Reference Data to the plant's reference data, making sure that you do not overwrite any
customizations.
If the plant has been upgraded from SmartPlant P&ID 4.3:
Adding all the new rules for jacketing.
Adding the new rule for Serial Lines (Instrument Signal Lines).
Creation of the graphics on the Jacket Layer of the symbols for jacketing.

Upgrading Reference Data


Reference data often changes between versions of the software. These changes can include
deletions and additions to reference data, as well as modifications to existing data formats and
locations. After you upgrade your plant data using the SmartPlant Engineering Upgrade Utility,
you can use the Upgrade Reference Data command in SmartPlant P&ID Options Manager to
upgrade styles, template files, symbols, and assemblies.

62

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009

User Access
Before you can upgrade the reference data and drawings for an upgraded plant, you must define
user access for the plant in SmartPlant Engineering Manager. For more information about
defining user access, see the SmartPlant Engineering Manager User's Guide.
After you upgrade reference data, you cannot view it in earlier versions of the software.
For information about changes made during the reference data upgrade, see the
V4RefDataUpgrade.log file. This log file is saved in the folder where the symbols are
stored. For more information about upgrading reference data, see SmartPlant P&ID Options
Manager Help.

Upgrade Reference Data


1. Click Start > Programs > SmartPlant P&ID > Options Manager.
2. Select the site and plant for which you want to upgrade reference data.
3. Click Tools > Upgrade Reference Data. A splash screen displays, then a message box
informs you when the upgrade operation successfully completes.

4. Click OK.
After you upgrade reference data, you should not view it in earlier versions of the software.
For information about changes made during the reference data upgrade, see the
V4RefDataUpgrade.log file. This log file is saved in the folder where the symbols are
stored.
For more information about upgrading reference data, see SmartPlant P&ID Options
Manager Help.

SmartPlant P&ID Installation and Upgrade Guide

63

Upgrading to SmartPlant P&ID 2009

Updating Drawings
Changes are often made to the SmartPlant P&ID reference data while work is being managed on
the P&IDs. When these changes are made, they apply to all drawings items after the time of
change, but do not apply to existing drawing items. The Update Drawings functionality
(provided by the set of Out-of-Date Drawings commands in Drawing Manager) allows you to
manage which drawings are updated with the latest reference data changes by defining values
that define out-of-date drawings criteria and by resolving any symbols that have been deleted,
moved, or renamed.
You can also schedule these update operations and create reports. For more information about
this functionality, see the Drawing Manager Help.
Using the Update Drawings functionality is not required as part of the upgrade
process, but it is strongly recommended.
When you submit a selection of P&IDs to the Out-of-Date Drawings > Update command,
Drawing Manager analyzes the drawing for changes to the following:
Data Dictionary (select lists)
Formats
Symbols (moved and missing symbols, and changes to the .sym file)
Rules Manager
Options Manager (heat tracing, gapping, and symbology)
Model Items (via Llama)
OPCs (moved)
Drawings in a recreate state
Drawing Properties
After this analysis process, a summary displays, listing the number of drawings selected, the
number of out-of-date drawings, and the number of drawings with missing symbols. You must
manually resolve the missing symbols using the Resolve Missing Symbols dialog box, which
lists the symbols in question and allows you to define the new location of each symbol.
In addition to the interactive approach of updating drawings, you can schedule the entire update
process, except for the resolution of missing symbols, which is a manual process as described
above.
Reporting capability provides a summary of the selected drawings and the out-of-date criteria
detected during the analyze step. This report format is non-configurable.

Update Command (File > Out-of-Date Drawings Menu)


Displays the Update Drawings dialog box. When you select this command, the selected
drawings are analyzed based on the out-of-date criteria and the results display on the Update
Drawings dialog box.

64

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009


Update does not update any symbol whose definition has been changed into a break component.
This situation occurs when you have a catalog item that has been placed in a drawing and then
you change its definition to be a break component. The SmartPlant P&ID Replace command
does not allow a non-breaking component to be replaced with a break component. The Update
command relies on the SmartPlant P&ID Replace command to replace symbols that are out-ofdate.
Intergraph recommends that you backup your work or create a version of your work prior
to using this command.

Total drawings selected Displays the number of drawings selected.


Report Generates a Microsoft Excel report describing the details of out-of-date drawing(s).
Out-of-date drawings Displays the number of drawings that are out-of-date based on the
criteria selected using the Out-of-Date Drawing Criteria dialog box.
Resolve Displays the Resolve Missing Symbols dialog box. Use this button to resolve any
missing symbols.
Drawings with missing symbols Displays the number of out-of-date drawings containing
symbols that do not exist in the catalog.
If the path to your Rules file is set incorrectly in SmartPlant P&ID Options Manager, then
the Update Drawings command will not work. For example, if the path is invalid, then all
drawings in the project are in an out-of-date state but the software cannot update them. This
error also occurs if the Catalog Explorer Root Path specified in SmartPlant P&ID Options
Manager is invalid. An error message displays and the report displays Drawings with a ? in the
criteria column have missing or incorrect reference data.

SmartPlant P&ID Installation and Upgrade Guide

65

Upgrading to SmartPlant P&ID 2009

Resolve Command (File > Out-of-Date Drawings > Update


Drawings Menu)
Displays the Resolve Missing Symbols dialog box which provides a way for you to define any
symbols that have been deleted, moved, or renamed.
In order to resolve any missing symbols, you must have an existing symbol in the catalog to
define as the replacement for the missing symbol.
You cannot resolve missing symbols for offline instruments of a different class using this
command.
Old Path - Displays the relative path of the missing symbol.
New Path - Displays possible options for defining correct locations for the missing symbol(s).
Drawings - Displays the list of drawings that contain the missing symbol(s).

See Also
Out-of-Date Drawing Criteria Command (see "Out-of-Date Drawing Criteria Command (Tools
Menu)" on page 67)
Update Command (see "Update Command (File > Out-of-Date Drawings Menu)" on page 64)

66

SmartPlant P&ID Installation and Upgrade Guide

Upgrading to SmartPlant P&ID 2009

Out-of-Date Drawing Criteria Command (Tools Menu)


Displays the Out-of-Date Drawing Criteria dialog box. Items selected in this list define what
criteria is used to search for out-of-date values when you use the commands on the File > Outof- Date Drawings menu.

Select out-of-date drawing criteria


Select List Changes
Data Dictionary Select List Data dictionary select list GUID on the drawing item is not
equivalent to select list GUID in Data Dictionary.
PID Select List PID select list GUID on the drawing item is not equivalent to the select
list GUID in PID schema.
Format Changes
Formats GUID on the drawing item is not equivalent to Formats GUID from the Database.
Default Formats GUID on the drawing item is not equivalent to Default Formats GUID in
Option Manager setting.
Out-of-Date Symbols File Last Modified Time Stamp on at least one representation in the
drawing is not equivalent to the File Last Modified Time Stamp on the corresponding symbol
definition file.
Missing Symbols Filename specified for at least one representation in the drawing does not
have the corresponding symbol definition file available in the current catalog.
Rule Changes Rules GUID on the drawing item is not equivalent to the GUID from the
Rules file.
Heat Trace Changes Heat Trace GUID on the drawing is not equivalent to the Heat Trace
GUID in Option Manager Setting.

SmartPlant P&ID Installation and Upgrade Guide

67

Upgrading to SmartPlant P&ID 2009


Gapping Changes Gapping GUID on the drawing item is not equivalent to the Gapping
GUID in Option Manager Setting.
Symbology Changes Symbology GUID on the drawing item is not equivalent to the
Symbology GUID in Option Manager Setting.
Out-of-Date Model Items SP_ModelItemTimeStamp for at least one representation in the
drawing is not equivalent to the TimeStamp on the History Item of its Model Item. This criteria
covers model items updated via Llama (Outside the drawing).
Moved OPCs MatingOPCPath (will have Drawing Id of its mate) on the OPC is not
equivalent to the SP_DrawingId of its mate OPC. The OPC label is in a to-be-updated state as
its mate has been moved.
Recreate State The drawing is in a Recreate state.
Drawing Property Changes Property Changes GUID on the drawing item is not equivalent
to Drawing Property Changes GUID on the drawing item. Drawing Property Changes GUID is
set when drawing properties are modified from Drawing Manager.

See Also
Resolve Command (see "Resolve Command (File > Out-of-Date Drawings > Update Drawings
Menu)" on page 66)
Out-of-Date Drawing Criteria Command (see "Out-of-Date Drawing Criteria Command (Tools
Menu)" on page 67)
Update Command (see "Update Command (File > Out-of-Date Drawings Menu)" on page 64)

68

SmartPlant P&ID Installation and Upgrade Guide

SECTION 11

Configuring SmartPlant Engineering


Manager
After installing the software and reference data, use SmartPlant Engineering Manager to create a
site server and plant structures within the site, associate applications to the plant structure, and
configure user access.

Working with Database Schemas


The SmartPlant schemas are configured to use separate data dictionaries for SmartPlant
Engineering Manager and each engineering application. While each application sees only the
reference data that applies to it, each application shares some common SmartPlant Engineering
Manager data. This configuration supports the requirement for distributed management of the
relational database, supports navigation across application tables for read-only access, and
supports integration of data across applications.
A valid site with one plant consists of six database schemas when you use SmartPlant P&ID as
your application, seven database schemas when you use SmartPlant Electrical, and nine database
schemas if you use both applications concurrently. The plant structure schemas are shared
between SmartPlant P&ID and SmartPlant Electrical.
For example, in the following figure, the site server contains two plants, one with both
SmartPlant P&ID and SmartPlant Electrical associated to it and the other with only the
SmartPlant P&ID application associated.

SmartPlant P&ID Installation and Upgrade Guide

69

Configuring SmartPlant Engineering Manager


The figure below shows the schemas that would exist in the database for this configuration
example, assuming that both applications are in the same database instance. On a given database
server, we recommend putting all plants in one database instance.

The majority of database activity occurs in the application schemas (SPPID Schema, SPPID
Data Dictionary Schema, SPEL Schema, SPEL Data Dictionary Schema, and SPEL Reference
Schema) since this is where the application data is stored. The plant schema contains the
smallest amount of data compared with the other schemas.

Understanding Default Database User Names


Oracle and SQL Server databases require user names and passwords for each of the schemas and
data dictionaries created by the New Site Server, New Plant Structure, Load Plant Structure,
New Project, and Associate Application wizards.
SmartPlant Engineering Manager uses the formulas in the following table to generate default
values for these user names.

70

Schema Type

Database User Name

Example

Site Schema

Name of the site

Site1

Site Data Dictionary

Site Schema user name + 'd'

Site1d

Plant Schema

Name of the plant

Plant1

Plant Data Dictionary


Schema

Name of the plant + 'd'

Plant1d

P&ID Schema

Plant schema user name + 'pid'

Plant1pid

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager

Schema Type

Database User Name

Example

P&ID Data Dictionary


Schema

Plant schema user name + 'pidd'

Plant1pidd

Electrical Schema

Plant schema user name + 'el'

Plant1el

Electrical Data Dictionary


Schema

Plant schema user name + 'eld'

Plant1eld

Electrical Reference
Schema

Electrical schema user name + 'ref'

Plant1elref

Satellite Plant Schema

Plant schema user name + 'sat' +


satellite count

Plant1sat1

Satellite P&ID Schema

Satellite plant schema user name +


'pid'

Plant1sat1pid

Satellite Replication
Schema

Satellite plant schema user name +


'rep'

Plant1sat1rep

Project Schema

Plant schema user name + 'p' +


project count

Plant1p1

Project P&ID Schema

P&ID schema user name + 'p' +


project count

Plant1pidp1

Project Electrical Schema

Electrical schema user name + 'p' +


project count

Plant1elp1

The software sets the related password defaults for each of the above user names
automatically (Oracle uses the default user name, while SQL Server 2005 appends '1' to the
default user name). In the case of SQL Server 2005 running on Windows Server 2003, if
you are using SQL Server authentication, you can specify that SQL Server 2005 is to use the
password validation rules that are used by Windows Server 2003.
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the plant name in
creating the default database user names using the formulas above.
The software removes all spaces or special characters in a plant name before using that name
to create a default database user name.
Database usernames cannot contain any of the following characters: . < , > ? \ / ' ; { } [ ] ~ ` !
%*()&$@#"

See Also
New Site Server Wizard (on page 88)
Associate Applications Wizard (on page 89)

SmartPlant P&ID Installation and Upgrade Guide

71

Configuring SmartPlant Engineering Manager

Working with Data Dictionaries


SmartPlant Engineering Manager allows you to add or edit attributes in plant and application
data dictionaries and then create data dictionary templates from the modified plant or application
data dictionaries. You can then move the template to a new site and use it to populate a new
plant or application schema. For example, you can make your plant customizations one time,
create a template of that data dictionary, and then use that template in other sites, much like
copying a plant from site to site, rather than having to perform the same modification steps at
each site.
Data dictionary templates are not database-specific. In other words, a given data dictionary
template can be used in both Oracle and SQL Server environments.
The data dictionary template file is a collection of all filters, plant group types, Options
Manager settings, and other database-related items (anything that's not stored in external
files, like Rules or Symbols). When using a data dictionary template to create a plant in
another site, you must have the proper rules file (which relies on filters) to go with that
template. Rules, insulation specification, symbols, and other file-based reference data are
not included in data dictionary templates.
In a Workshare collaboration, you cannot create a plant or application data dictionary
template at a satellite site. You must create the templates at the host site.
Data dictionary templates cannot be upgraded. However, you can use the Data Dictionary
Template Comparison Utility to compare your existing template with the default template
delivered with the latest version of SmartPlant Engineering Manager. For more information,
see the SmartPlant Data Dictionary Template Comparison Utility User's Guide.

See Also
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 74)
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 72)
New Data Dictionary Template Dialog Box (on page 74)

Data Dictionary Manager Command (Tools Menu)


Starts Data Dictionary Manager, allowing you to add and edit attributes in the plant data
dictionaries within the site.
To add properties to the active plant database, select the plant structure and click Tools > Data
Dictionary Manager.

72

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


To add, modify, or delete attributes for the plant group types, select the Plant Group Types
node and then click Tools > Data Dictionary Manager. Attributes added to a plant group type
using this method are not automatically included in the attributes for active plant group
structures that use that plant group type.
To access the site data dictionary, start Data Dictionary Manager outside SmartPlant
Engineering Manager. When started from within SmartPlant Engineering Manager, Data
Dictionary Manager can access only the plant data dictionaries. You cannot swap between
data dictionaries once Data Dictionary Manager is running.
After accessing Data Dictionary Manager from within SmartPlant Engineering Manager and
making changes, you must either exit and restart SmartPlant Engineering Manager or reopen
the site to see the changes from within SmartPlant Engineering Manager.
Do not use Oracle reserved words (for example, "address") as attribute names.

See Also
New Data Dictionary Template Dialog Box (on page 74)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 74)

Create a Data Dictionary Template


1. Select the plant or application from which you can to create the template and click Tools >
New Data Dictionary Template.
To create a plant data dictionary template, select the Plant node

in the Tree view.

To create an application data dictionary template, select the Applications node in the
Tree view and then select the application in the List view.
2. In the Template file box, browse to the path where you want the template file saved and
then type a file name for the template file.
3. If you are creating an application template, type the Source name for the application data
dictionary template. By default, this field displays the name of the source data dictionary
template used to create the existing application data dictionary.
Data dictionary templates cannot be upgraded. You cannot use a template created using an
older version of SmartPlant Engineering Manager to create a plant or application schema.
Data dictionary templates are not database-specific. In other words, a given data dictionary
template can be used in both Oracle and SQL Server environments.
When using a data dictionary template to create a plant in another site, you must have the
proper rules file (which relies on filters) to go with that template. Rules, insulation
specification, symbols, and other file-based reference data are not included in data dictionary
templates.

SmartPlant P&ID Installation and Upgrade Guide

73

Configuring SmartPlant Engineering Manager

See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 72)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 74)

New Data Dictionary Template Command (Tools Menu)


Generates a template .ddt file based on the selected plant or application schema. Use this
command to create a data dictionary template from a data dictionary that you have modified via
the Tools > Data Dictionary Manager command.
A plant data dictionary template file contains all the information in the plant schema. The
application data dictionary temple contains all filters, plant group types, Options Manager
settings and symbology, and other database-related items (anything that's not stored in external
files, like rules or symbols).
Data dictionary templates cannot be upgraded. You cannot use a template created using an
older version of SmartPlant Engineering Manager to create a plant or application schema.
Data dictionary templates are not database-specific. In other words, a given data dictionary
template can be used in both Oracle and SQL Server environments.
When using a data dictionary template to create a plant in another site, you must have the
proper rules file (which relies on filters) to go with that template. Rules, insulation
specification, symbols, and other file-based reference data are not included in data dictionary
templates.

See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 72)
New Data Dictionary Template Dialog Box (on page 74)

New Data Dictionary Template Dialog Box


Allows you to generate a template from an existing plant or application data dictionary.

Template file Allows you to specify the path and file name for the new template.

74

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


Source name Available only when creating an application template, this field displays the
internal name of the source data dictionary template used to create the existing application data
dictionary. You can type a new name to be used in place of Imperial or Metric in the Plant
Settings table in the plant schema.

See Also
Data Dictionary Manager Command (see "Data Dictionary Manager Command (Tools Menu)"
on page 72)
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 74)

Using Default Settings


SmartPlant Engineering Manager allows you to predefine values for creating sites, plant
structures, projects, and associating application. Using these default settings simplifies the
creation process and allows you to use the same settings across sites and plants.
The values specified on the Default Settings dialog box are used by default only if
you turn on the Tools > Use Default Settings command.

See Also
Default Settings Dialog Box (on page 76)
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page

Use Default Settings Command (Tools Menu)


Allows you to toggle on and off using the predefined settings for populating the corresponding
values in the New Site Server, New Plant Structure, and Associate Applications wizards.

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Default Settings Dialog Box (on page 76)
Using Default Settings (on page 75)

Default Settings Command (Tools Menu)


Displays the Default Settings dialog box, which allows you to predefine settings for populating
the corresponding values in the New Site Server, New Plant Structure, and Associate
Applications wizards. These wizards use the values specified on this dialog box only if you
turn on the Tools > Use Default Settings command.

See Also
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page
Default Settings Dialog Box (on page 76)
Using Default Settings (on page 75)

SmartPlant P&ID Installation and Upgrade Guide

75

Configuring SmartPlant Engineering Manager

Default Settings Dialog Box


Allows you to predefine values for populating the corresponding values in the New Site Server,
New Plant Structure, and Associate Applications wizards.
The default settings values are used by default only if you turn on the Tools > Use
Default Settings command.
Database Tab (see "Database Tab (Default Settings Dialog Box)" on page 76)
Paths Tab (see "Paths Tab (Default Settings Dialog Box)" on page 77)
Plant Tab (see "Plant Tab (Default Settings Dialog Box)" on page 79)
SmartPlant P&ID Tab (see "SmartPlant P&ID Tab (Default Settings Dialog Box)" on page 80)
SmartPlant Electrical Tab

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page

Database Tab (Default Settings Dialog Box)


Displays the database settings you can predefine for populating the corresponding values in the
New Site Server and New Plant Structure wizards. Initially, the values specified during site
creation populate this tab. You can modify these values for subsequent site or plant creations.

Oracle Select this option if you are using an Oracle database. This information is carried
forward from the site properties, but you can modify it for subsequent plant creations.
76

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


Oracle alias Type the name of the Oracle net service alias used by the site in which the plant
will be created.
Refresh Click this button to update the entries in the tablespace lists if you have changed the
system user name or password entries.
System user Type a database system user name. This name does not have to be the database
administrator user name, but this user must have system privileges.
System password Type the system password.
Oracle tablespace Select a default Oracle tablespace name for your plant database.
We recommend that you do not use SYSTEM for the default tablespace, because
Oracle uses this tablespace for its own use.
Oracle temp tablespace Select a default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator.
SQL Server Select this option if you are using a SQL Server database. This information is
carried forward from the site properties, but you can modify it for subsequent plant creations.
Server Type the node name of the server on which the SQL Server database resides.
Refresh Click this button to update the database information if you have changed the system
user name or password entries.
System user Type a database system user name. This name does not have to be the database
administrator user name, but this user must have system privileges.
System password Type the system password.
Database usernames and passwords cannot contain any of the following characters: . < , >
?\/';{}[]~`!%*()&$@#"

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page

Paths Tab (Default Settings Dialog Box)


Displays the path settings you can predefine for populating the corresponding values in the New
Site Server, New Plant Structure, and Associate Applications wizards.

SmartPlant P&ID Installation and Upgrade Guide

77

Configuring SmartPlant Engineering Manager


All paths, except Seed location, must be in UNC format.

Plant structure root directory Specify the path to the storage location for the plant data and
the drawing files. Folders for individual plant structures are automatically appended to this path
as they are created.
You must create the plant structure root directory and share it out before using these
default settings during plant creation.
Backup root directory Specify the path to the shared storage folder for backing up the plant
files. Folders for individual plant structures are automatically appended to this path as they are
created.
Seed location Specifies the folder where all the templates are stored. The site administrator
sets this path during installation.

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page
75)

78

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager

Plant Tab (Default Settings Dialog Box)


Displays the plant settings you can predefine for populating the New Plant Structure wizard.

Data Dictionary source Select the default source for the new plant data dictionary.
Use default template Select this option to create the plant data dictionary using the delivered
template.
Use custom template Select this option to create the plant data dictionary using a custom
template.
Template path Specify the path where the custom template file is located. This field is
enabled only if the Use custom template option is selected. This path is limited to 255
characters and must be in UNC format. The software verifies that the specified template is of the
proper template type.
Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
72).
Hierarchy Select the default hierarchy that you want to use for new plants. All currently
defined hierarchies display in this list.

SmartPlant P&ID Installation and Upgrade Guide

79

Configuring SmartPlant Engineering Manager


If you want to use a custom hierarchy, you must create it before using these default
settings to create a plant structure. Hierarchies cannot be modified during plant structure
creation.
Hierarchy definition Displays the plant breakdown structure items in the currently selected
hierarchy.
Show warning message when the hierarchy has less than 3 levels Displays a warning
when the plant hierarchy has less than three levels. Clear this checkbox, if you do not want this
message to be displayed.

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page

SmartPlant P&ID Tab (Default Settings Dialog Box)


Displays the SmartPlant P&ID settings you can predefine for populating the corresponding
values in the Associate Applications wizard.

Data Dictionary source Select the default source for the SmartPlant P&ID data dictionary.
Use default template Select this option to create the SmartPlant P&ID data dictionary using
the delivered template.
Use custom template Select this option to create the SmartPlant P&ID data dictionary using
a custom template.
Template path Specify the path where the custom template file is located. This field is
enabled only if the Use custom template option is selected. This path is limited to 255
characters and must be in UNC format. The software verifies that the specified template is of the
proper template type.

80

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
72).
SmartPlant P&ID reference data path Type or browse to the SmartPlant P&ID reference
data path. This path is limited to 255 characters and must be in UNC format.
System of units Select the system used for displaying units in SmartPlant P&ID.

See Also
Default Settings Command (see "Default Settings Command (Tools Menu)" on page 75)
Use Default Settings Command (see "Use Default Settings Command (Tools Menu)" on page

Creating Network Shares


Before using SmartPlant Engineering Manager, you must create the following network shares.
The paths to these shares are needed while running the various wizards in SmartPlant
Engineering Manager.

Site Server Share


Create a share on the SmartPlant Engineering Manager (server) workstation to hold the site's
SmartPlantV4.ini file. This share can be on the same computer as SmartPlant Engineering
Manager or on a different machine. Because you can have several sites (different
SmartPlantV4.ini files) on one computer, you must create separate shares for each site.
All SmartPlant users must be granted read permissions on a site share (the site administrator
group needs to be granted read and write permissions). You will need this share name to create
the site later.

Role Template Share


Create a share on a server to hold the role templates you create for use with SmartPlant
Engineering Manager. These templates are standard sets of rights and privileges that you can
grant to user groups, without having to define the rights each time. This share can be on the
same server as SmartPlant Engineering Manager or on a different server.
Only administrators responsible for the creation of sites, plants, user groups, and assigning user
access require read and write permissions to this share. You must specify this location during
site creation, or your role templates will not be available for selection.

Backup Location Shares


Create shares to hold the backup data for the site and for each plant structure. These shares can
be on the same server as SmartPlant Engineering Manager or on a different server. We
recommend using a separate server for backups. SmartPlant users who will be doing backups
must be granted read and write permissions on these shares. You will need these share names to
create the site and plants later.
You must create backup shares for each plant structure you create.

SmartPlant P&ID Installation and Upgrade Guide

81

Configuring SmartPlant Engineering Manager

Site Administrator User Group


During site creation, you are asked to specify the user group that you want to have site
administrator privileges. The group you specify will then possess a set of unique rights that
cannot be granted to any other role. These rights include creating plant structures, creating and
modifying hierarchies, creating and modifying plant group types, enabling and creating projects,
and so forth. Site administrators can see all plant structures in the site and have full access to
them. Site administrator privileges do not extend to the individual engineering products.
The following tasks must be completed before a user group can be used as the site administrator
group:
1. Create the user group using the administrative tools on your computer.
2. Verify that the users you added to the group created above are also members of the local
Administrators group on the computer where SmartPlant Engineering Manager is loaded.
3. Grant network access privileges to the user group you just created using administrative tools
on your computer.
For more information about how SmartPlant Engineering Manager applies user access and
site administration privileges, see User Access (see "Change the Site Administrator User
Group" on page 86).
For information about Novell networking and user groups, see Novell Networking and User
Groups (on page 85).
All users in Groups other than the Administrators group must have write access to the
C:\Program Files\SmartPlant folder (or the folder where SmartPlant Engineering Manager is
installed) in order to use the software.
You can change the user group assigned as the site administrator group after site creation.
For more information, see Change the Site Administrator User Group (on page 86).

Create a User Group


Before creating a site server, you must create, on the computer that will house the site
smartplantv4.ini file, a local users group containing the users you want to have site
administration privileges. For example, to create a group named SiteAdmins on a Windows
2003 server, use the following steps.
1. From the Windows Control Panel, select Administrative Tools > Computer
Management.
2. Select System Tools > Local Users and Groups.
3. Select Groups in the Tree view, right-click and on the shortcut menu, select the New
Group command.

82

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


4. On the New Group dialog box, type the name and description for the new group.

5. Click Add and, from the Select Users, Computers or Groups dialog box, select users to
add to the new group. Each user added to this group must be a Windows domain user.

SmartPlant P&ID Installation and Upgrade Guide

83

Configuring SmartPlant Engineering Manager


6. Click Create to create the new group. The new SiteAdmins group should appear in the list
of groups.

Add Users to the Administrators Group


1. On the Local Users and Groups dialog box, double-click the Administrators group.
2. On the Administrators Properties dialog box, click Add.

3. Add the same users to this group that you added to the SiteAdmins group in the section
above.
All users in Groups other than the Administrators group must have write access to the
C:\Program Files\SmartPlant folder (or the folder where SmartPlant Engineering Manager is
installed) in order to use the software.

Grant Network Access Privileges


Complete the following steps to grant the Right to access this computer from the network
local policy to the SiteAdmins group you just created.
1. From the Windows Control Panel, select Administrative Tools > Local Security Policy.
84

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


2. On the Local Security Settings dialog box, select the User Rights Assignment local policy,
and double-click the Access this computer from the network policy.

3. On the Local Security Setting dialog box, click Add User or Group and browse to the
group you created above (for example, SiteAdmins).

Novell Networking and User Groups


Novell trees are the structures used for users and groups, much like domains on Windows
systems.

For example, if the logged in user is NDS:\\PBS\US\SP2D\AL\HSV\USERS\SPMGR and


NovellLevels is set to 3, SmartPlant Engineering Manager would look for groups under
NDS:\\PBS\US\SP2D and any sub-nodes of the tree from that path down.
You can modify the NovellLevels registry key to find the right scope to your groups. The lower
the value, the wider the scope. The default value is 3.

SmartPlant P&ID Installation and Upgrade Guide

85

Configuring SmartPlant Engineering Manager


Under the SmartPlant Manager node, you must also define a registry key named ForceNovell
and set its value to 1 to use Novell groups rather than Windows groups.

Change the Site Administrator User Group


1. Select the site node in the Tree view.
2. Right-click and select Properties.
3. On the General tab on the Site Properties dialog box, click the Browse button next to the
Site administrator user group box.
4. On the New Site Administrator dialog box, define the following properties:
Use local machine and domain groups Select this option to choose an existing user
group or domain that is accessible from your machine.
Use site server and domain groups Select this option to choose a user group or
domain that is accessible from the site server machine.
Role name Click the Browse button
, and select the user group to which you
want to assign site administrator privileges.
Role description (Optional) Type a descriptive note about the user group you
selected, such as noting that this group is assigned site administrator privileges. If a
description was defined when the group was created, it appears by default.
5. Click OK on the New Site Administrator Group dialog box.
6. Click OK on the Site Properties dialog box to complete the change.
You must have Site Administrator privileges to change the Site Administrator User Group.
You (or the person who changes the Site Administrator User Group) retain Site
Administrator privileges until you either select a new site or you restart the software.
However, if you are also a member of the user group now assigned Site Administrator
privileges, you will retain your Site Administrator privileges.

86

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager


When the Site Properties dialog box is dismissed, the software checks to see if the Site
Administrator User Group has changed and, if so, replaces the group in the T_Roles table
and the users in the T_RoleUsers group. If any error occurs or the same group is selected, no
changes occur.

See Also
New Site Administrator Group Dialog Box (on page 87)

New Site Administrator Group Dialog Box


Displays when you click the Browse button beside the Site administrator user group box on
the Site Properties > General tab, allowing you to change the user group assigned administrator
privileges for the site.

Use local machine and domain groups Use this option when you want to choose an existing
user group or domain that is accessible from your machine.
Use site server and domain groups Use this option when you want to choose a user group
or domain that is accessible from the site server machine.
Role name Type the name of or select the Windows or Novell user group you want to assign
to this new role. The name of the SmartPlant role will be the same as the name of the selected
user group. To quickly find the user group in your domain, you can type a partial name into this
field and click Check Name.
Check Name Displays the Microsoft Select dialog box, which allows you to select the
Windows or Novell user group you want to assign to this new role. The name of the SmartPlant
role will be the same as the name of the selected user group.
Role description Type a descriptive note about the role that you are creating. You can make
notes that indicate the privileges assigned to the group. If a description was defined when the
group was created, it appears by default.

See Also
SmartPlant Engineering Manager Rights (on page 92)
Change the Site Administrator User Group (on page 86)

SmartPlant P&ID Installation and Upgrade Guide

87

Configuring SmartPlant Engineering Manager

New Site Server Wizard


The New Site Server wizard steps you through creating a site schema and site data dictionary to
hold the database connection information for your site.
To start the New Site Server wizard, select Create a new site from the Site Server Options
dialog box that appears when you run SmartPlant Engineering Manager for the first time. You
must provide the following information as you step through the wizard.
Data Dictionary Source Specifies whether the data dictionary for the new site will be built
from the default template or a custom template. You must specify the path to the location of the
seed files. Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
72).
Paths Consists of naming the new site and specifying Universal Naming Convention (UNC)
paths to the site server, backup shares, and template locations.
Database Connection Information Allows you to specify the alias or database node and
system password for the database containing the site data.
Site Administrator Privileges Specify the local user group that can be assigned site
administrator privileges. Use the user access controls provided with your operating system to
create a group or to verify a group exists that can be used for these purposes. After you have
created the site, you can change the user group that is assigned site administrator privileges using
the Site Server Properties dialog box. You can also add or remove users from that user group
using the user access controls provided with your operating system.
Site Schema and Site Data Dictionary Schema Information Allows you to specify user
names and passwords for both schemas. All data needed to maintain the site is written into the
site's schema.
You cannot create a new site unless you log on using a domain account that has
administrator privileges on the computer where you are running SmartPlant Engineering
Manager.
Before you can create a site using an Oracle database, you must create a database instance in
Oracle and the database must be started. In the Windows Control Panel, select Services to
verify that the database is running.
The Site Server Options dialog box appears during future sessions only if SmartPlant
Engineering Manager cannot find the site SmartPlantV4.ini file.

See Also
New Data Dictionary Template Command (see "New Data Dictionary Template Command
(Tools Menu)" on page 74)

88

SmartPlant P&ID Installation and Upgrade Guide

Configuring SmartPlant Engineering Manager

New Plant Structure Wizard


The New Plant Structure wizard steps you through creating a plant structure. To start this
wizard, select the Plant Structures root in the Tree view and then click File > New. You must
provide the following information as you step through the wizard.
Data Dictionary Source Specifies whether the data dictionary for the new plant will be built
from a default template or a custom template. You must specify the path to the location of the
seed files. Data dictionary templates are not database-specific. In other words, a given data
dictionary template can be used in both Oracle and SQL Server environments. For more
information about using data dictionary templates, see Working with Data Dictionaries (on page
72).
Hierarchy Indicates the template for the plant breakdown structure of the plant. You can
define your own hierarchy that you can then use in creating plant structures or you can use one
of the several delivered hierarchies.
Root Item Attributes Specifies the plant structure root item and the name that will appear in
the Plant Structures node in the software.
Paths Consists of UNC paths for the plant structure storage location and a backup storage
location.
Database Connection Information Allows you to specify the alias and system password for
the database instance that contains the plant data.
Plant Schema and Data Dictionary Schema Information Allows you to specify user
names and passwords for both schemas. All data needed to maintain the plant structure is written
into the plant schema.
You can use the Default Settings commands on the Tools menu to specify default values to
simplify the plant creation process. For more information, see Using Default Settings: An
Overview (see "Using Default Settings" on page 75).
After creating your new plant structure, be sure to associate applications (see "Associate
Applications Wizard" on page 89) with your plant and to assign user access (see "Create a
New Role" on page 90) for the new plant structure.
Creating, restoring, or copying different plants on the same site, from two terminals, at the
same time, is not possible, a Run-time error 91:Object variable or With block variable
not set message is displayed on both terminals.

See Also
Associate Applications Wizard (on page 89)
User Access (on page 91)

Associate Applications Wizard


Engineering applications (such as SmartPlant Instrumentation, SmartPlant P&ID, or SmartPlant
Electrical) are used to access data within your plant structure. Before you can use an application
with your data, you must associate that application with the plant structure.
SmartPlant P&ID Installation and Upgrade Guide

89

Configuring SmartPlant Engineering Manager


To associate an application with your plant structure, use the Tools > Associate Applications
command to open the Associate Applications wizard that helps you step through creating the
application schema and data dictionary.
The association procedure of SmartPlant Instrumentation is different from association of
SmartPlant P&ID or SmartPlant Electrical and involves database configuration as the association
prerequisite. For details, see Associating SmartPlant Instrumentation with the Plant Structure
When associating an application, you must provide the following information as you step
through the wizard.
Data Dictionary Source Specifies whether the data dictionary for the associated application
will be built from a default template or a custom template. You must specify the path to the
location of the seed files. Data dictionary templates are not database-specific. In other words, a
given data dictionary template can be used in both Oracle and SQL Server environments. For
more information about using data dictionary templates, see Working with Data Dictionaries (on
page 72).
Application Schema and Application Data Dictionary Schema Information Allows you
to specify user names and passwords for both schemas. All data needed to maintain the
application association is written into the application schema.
When associating SmartPlant P&ID or SmartPlant Electrical, you can use the Default
Settings commands on the Tools menu to specify default values to simplify the application
association process. For more information, see Using Default Settings: An Overview (see
"Using Default Settings" on page 75).
In an integrated environment, if only one application is associated with the plant at the time
it is registered, only that application is registered. If another application is later associated
with the plant, the Register command is enabled so that you can register the new application
with the plant. For more information, see Register Command.

Create a New Role


1. Select the Roles node under the plant structure or project to which you want to add the new
role.
2. Right-click and select New Role.
3. On the General tab, define the following properties:
Use local machine and domain groups Use this option when you want to choose an
existing user group or domain that is accessible from your machine.
Use site server and domain groups Use this option when you want to choose a user
group or domain that is accessible from the site server machine.
Role name Select the Browse button to display the Select Groups dialog box, which
allows you to select the Windows or Novell user group you want to assign to this new
role. The name of the SmartPlant role will be the same as the name of the selected user
group.

90

SmartPlant P&ID Installation and Upgrade Guide

User Access
Role description Type a descriptive note about the role that you are creating. You
can make notes that indicate the privileges assigned to the group. If a description was
defined when the group was created, it appears by default.
Template Select a pre-defined role template. If you do not want to use a template,
select None.
4. On the Rights tab, specify the access privileges for this group of users. This step is optional
if you selected a template on the General tab. You can still modify individual access rights
after applying a role template.
If users experience access problems after you create a role for the group to which the user is
assigned, check with your Information Technology group to see if that user was created on a
Windows NT domain that has been upgraded to Windows XP. Microsoft provides a method
for adding users to the built-in Pre-Windows 2000 Compatible Access Group to handle
this backward-compatibility issue. For more information, see the Microsoft Knowledge
Base article number 303973 at http://support.microsoft.com.
The new role will not be created if you do not select any rights.
When setting the rights for the new role, be sure to not only set the rights for the
applications, but also set the access permissions available under the SmartPlant Engineering
Manager rights.
You can automatically include the site administrators group in each plant you create by
selecting the Add the site administrator group to each plant created option on the Site
Properties > General tab. Doing this saves you the step of creating a new role to grant these
users access to the new plant.

See Also
SmartPlant Engineering Manager Rights (on page 92)
SmartPlant P&ID User Access Rights (see "SmartPlant P&ID Access Rights" on page 94)

User Access
Overview
User access identifies the users allowed to work at specified access levels within the site and
related plant structures. With user access, administrators can control access to data and thereby
ensure the security of their project data.

SmartPlant P&ID Installation and Upgrade Guide

91

User Access
SmartPlant Engineering Manager incorporates user access as an integral product feature by using
roles to define and maintain user privileges and rights at the plant structure level, where each
application has its own set of rights. Roles are the primary focus, with each role associated to a
single Windows or Novell user group. Each role is then assigned specific rights for each
engineering application and for SmartPlant Engineering Manager.
To see the roles currently defined for a plant, click the Roles node under the plant node in
the Tree view.
To view the rights settings for a particular role, right-click the role in the List view and click
Properties.

Mutually-Exclusive Rights
Users can have access privileges that vary from one plant to another in the same site. These
rights are defined by categories. Categories with radio button options indicate that the rights
contained within are mutually exclusive, meaning you can choose only one right in that category
to apply to the role. In other categories, you can choose multiple rights, as denoted by check
boxes.
None The user is not allowed to execute the application or utility for this plant structure.
Read-Only The user can execute the application or utility for this plant structure to view
the data held within it.
Modify Settings The user can execute the application or utility for this plant structure to
view the data held within it and to modify any custom settings.
Full Control The user can execute the application or utility for this plant structure and
perform all commands and modifications. This right is not available to a satellite site when
operating in the Workshare mode because the reference data must be controlled by the host
site.
SmartPlant Engineering Manager provides roles templates to help you easily create new roles.
Because the most labor-intensive part of a role creation is setting the values for the rights, you
can create templates for specific roles and then use those templates multiple times. This feature
is useful for defining a role template in one site and then reusing that same role template
throughout all of your sites.

See Also
SmartPlant Engineering Manager Rights (on page 92)
Create a New Role (on page 90)
SmartPlant P&ID Access Rights (on page 94)

SmartPlant Engineering Manager Rights


SmartPlant Engineering Manager contains two sets of rights: site administrator rights and plant
structure rights.

92

SmartPlant P&ID Installation and Upgrade Guide

User Access

Site Administrator Rights


Site administrators, while not appearing in the Roles node in a plant structure, have a set of
unique rights that cannot be granted to any other role. This group of users has privileges to create
and modify plant structures, roles, hierarchies, and plant group types, to enable projects, and so
forth.
Only members of the user group specified as the Site Administrator User Group during site
creation can see the Hierarchy Templates and Plant Group Types roots in the Tree view. Site
administrators can see all plant structures and have full access to them.
Site administrator privileges do not extend by default to full privileges in the engineering
applications.
Additional site administrators can be added to the Site Administrator User Group by using
the administrative tools provided by Windows or Novell. Be sure that these users are granted
network access rights to the computer where SmartPlant Engineering Manager is installed.
You can change the user group assigned as the site administrator group after site creation.
For more information, see Change the Site Administrator User Group (on page 86).
You can automatically include the site administrators group in each plant you create by
selecting the Add the site administrator group to each plant created option on the Site
Properties > General tab. Doing this saves you the step of creating a new role to grant these
users access to the new plant. For more information, see General Tab (Site Server Properties
Dialog Box).

Plant Structure Rights


These rights are valid only within the plant structure with which the right is associated. To
access the plant structure through SmartPlant Engineering Manager, the user must belong to a
role that has at least read-only access to the plant structure.

The following rights are available to the Plant Structure Access category and are mutually
exclusive.

SmartPlant P&ID Installation and Upgrade Guide

93

User Access

Category

Right

Plant Structure Access

None The user is not allowed to see any part of the


plant structure, including the plant structure node.
Read-Only The plant structure is visible, but the user
cannot create, modify, or delete any data within the
plant structure.
Full Control The user can create plant groups, add
applications and roles, and create projects and satellites,
but cannot see the hierarchies or the plant group types.
This right is valid only within the SmartPlant
Engineering Manager software.

Formats

None The user is not allowed to launch Format


Manager.
Read-Only The user can launch Format Manager and
view the format settings but cannot create, modify, or
delete formats.
Full Control The user can launch Format Manager
and can create, modify, or delete formats.

See Also
Change the Site Administrator User Group (on page 86)

SmartPlant P&ID Access Rights


Category

Right

Notes

Catalog

None

None prevents users from accessing Catalog


Manager.

Read-Only

Read-Only allows users to view symbols in


Catalog Manager, but not make changes.

Full Control

Full Control allows users to create new


symbols and edit existing symbols. Full
Control is disabled for Workshare satellites
and projects.

None

None prevents users from accessing Filter


Manager.

Read-Only

Read-Only allows users to view existing


filter definitions, but not make changes.

Full Control

Full Control allows users to create new


filters and edit existing filters. Full Control
is disabled for Workshare satellites and
projects.

Plant Filters

94

SmartPlant P&ID Installation and Upgrade Guide

User Access

Category

Right

Notes

Display Sets

None

Controls the ability to view, edit, and define


display sets. Full Control is disabled for
Workshare satellites.

Read-Only
Full Control
Default Views

None
Read-Only
Full Control

Plant Reports

Rules

Data Dictionary

Controls the ability to specify default filters


and layouts for item types. Also controls
setting the Brief/Bulk Lists associated with
item types.
Full Control is disabled for Workshare
satellites and projects.

None

None prevents users from accessing the


plant reports.

Read-Only

Read-Only allows users to view existing


report definitions, but not make changes.

Full Control

Full Control allows users to create new plant


reports and edit existing reports. Full
Control is disabled for Workshare satellites
and projects.

None

None prevents users from accessing Rule


Manager.

Read-Only

Read-Only allows users to view existing rule


definitions, but not make changes.

Full Control

Full Control allows users to create new rules


and edit existing rule definitions. Full
Control is disabled for Workshare satellites
and projects.

None

None prevents users from accessing Data


Dictionary Manager. Modify Select Entry
and Full Control are disabled for Workshare
satellites and for projects.

Read-Only

Read-Only allows users to view settings in


the data dictionary, but not make any
changes.

Modify Select
Entry

Modify Select Entry allows users to edit


select lists.

Full Control

Full Control allows users to add items and


edit existing items in the data dictionary.
Modify Select Entry and Full Control are
disabled for Workshare satellites and for
projects.

SmartPlant P&ID Installation and Upgrade Guide

95

User Access

Category

Right

Notes

Options

None

None prevents users from accessing Options


Manager.

Read-Only

Read-Only allows users to view option


settings, but not make any changes.

Modify Settings

Modify Settings allows users to change


reference data pointers.

Full Control

Full Control allows users to add options and


edit existing options. Full Control is
disabled for Workshare satellites and for
projects, but users must have at least Modify
Settings level privileges to use Workshare.

None

None prevents users from accessing


Insulation Manager.

Read-Only

Read-Only allows users to view insulation


settings, but not make any changes.

Full Control

Full Control, disabled for Workshare


satellites and projects, allows users to add
settings and edit existing insulation settings.

Create P&ID

Create P&ID allows users to execute the


New Drawing command in Drawing
Manager.

Delete P&ID

Delete P&ID allows users to execute the


Delete command in Drawing Manager.

Refresh P&ID

Refresh P&ID allows users to execute the


Compare and Refresh and Validate
commands in SmartPlant P&ID. Users must
also have Full Control permission for P&ID
Objects before they can refresh a drawing.

Create Version

Create Version allows users to execute the


Create Version command in Drawing
Manager.

Delete Version

Delete Version allows users to execute the


Delete Version command in Drawing
Manager.

Fetch Version

Fetch Version allows users to execute the


Fetch Version command in Drawing
Manager.

Insulation
Specifications

Drawing
Management

96

SmartPlant P&ID Installation and Upgrade Guide

User Access

Category

P&ID Objects

Workshare

Right

Notes

Edit Import Map

Edit Import Map allows users to execute the


Edit Import Map command in Drawing
Manager.

Update P&ID

Update P&ID allows users to execute the


Update P&ID command in Drawing
Manager to update existing drawings.

Create Revision

Create Revision allows the user to create


revision properties, modify revision
properties, and associate revision properties
with the revised drawing.

Delete Revision

Delete Revision allows the user to delete a


revision and its associated version.

None

None prevents users from accessing objects


in the SmartPlant P&ID Modeler
environment.

Read-Only

Read-Only allows users to view objects in


the SmartPlant P&ID Modeler environment,
but not make any changes.

Modify Properties

To import, user needs at least the Modify


Properties right.

Full Control

To refresh drawings in SmartPlant P&ID,


users must have Full Control permission on
P&ID Objects.

Publish

Publish allows users to publish drawings to


other satellites or back to the host.

Get Latest
Version

Get Latest Version allows users to obtain the


latest published drawing from the host or
satellite site.

Assign Drawing
Ownership

Assign Drawing Ownership allows users to


specify which Workshare sites have
read/write permission for published
drawings.

Synchronize
Reference Data

Synchronize Reference Data allows users to


update their reference data with the
reference data at the host.

Synchronize
Shared Items

Synchronize Shared Items allows users to


update their shared items with the shared
items at the host.

SmartPlant P&ID Installation and Upgrade Guide

97

User Access

Category

Right

Notes

Projects

Check Out

Check Out allows users to execute the


Check Out and Undo Check Out
commands in Drawing Manager.

Check In

Check In allows users to execute the Check


In command in Drawing Manager.

Fetch

Fetch allows users to execute the Fetch


command in Drawing Manager.

Change Status

Change Status allows users to interact with


the Project Status dialog box in Drawing
Manager. If you are not granted this right,
you can only view the project status, but
cannot modify it.

Claim

Claim allows users to execute the Claim and


Release Claim commands in SmartPlant
P&ID.

Publish

Enables or disables the ability to publish to


or retrieve documents. Select the check box
to enable an option; clear to disable.

SmartPlant

Retrieve

SmartPlant P&ID Access Rights Examples


The following examples are suggestions for granting rights to common groups of users. These
example are a great starting place for defining custom SmartPlant P&ID role templates.

Plant Administrators
This user group has full control over all aspects of the plant structure for drawings,
administrative tasks, and reference data. The users should have the capability to create plant
groups, add applications and roles, create projects, enable Workshare, and create satellites, but
should not see the hierarchy templates or plant group types.

98

Category

Right

SPEM Plant Structure Access

Full-Control

Catalog

Full-Control

Plant Filters

Full-Control

Display Sets

Full-Control

Default Views

Full-Control

Formats

Full-Control

SmartPlant P&ID Installation and Upgrade Guide

User Access

Category

Right

Plant Reports

Full-Control

Rules

Full-Control

Data Dictionary

Full-Control

Options

Full-Control

Insulation Specifications

Full-Control

Drawing Management

Create P&ID, Delete P&ID, Archive,


Retrieve

P&ID Objects

Full Control

Workshare

Publish, Get Latest Version, Assign Drawing


Ownership,
Synchronize Reference Data, Synchronize
Shared Items

SmartPlant

Publish, Retrieve

Plant Users
This group has full control on all drawings, can set personal filters, set up personal display sets,
set up My Reports, create drawings, and archive drawings (needed for personal use in case there
are big changes to the drawing design).

Category

Right

SPEM Plant Structure


Access

Read-Only

Catalog

None

Plant Filters

Read-Only

Display Sets

Full-Control

Default Views

Read-Only

Formats

None

Plant Reports

Read-Only

Rules

None

Data Dictionary

None

Options

None

Insulation Specifications

None

Drawing Management

Create P&ID
Archive

SmartPlant P&ID Installation and Upgrade Guide

99

User Access

Category

Right

P&ID Objects

Full Control

Workshare

Undefined (do not choose


anything)

SmartPlant

Undefined (do not choose


anything)

Engineers
This group has access to drawings to view and modify data reports but not graphics. They can
set up personal filters, set up personal display sets, and create My Reports. They should not be
able to modify any project reference data or perform any administrative tasks with respect to
drawing management, projects, or Workshare activities.

100

Category

Right

SPEM Plant Structure


Access

Read-Only

Catalog

None

Plant Filters

Read-Only

Display Sets

Full-Control

Default Views

Read-Only

Formats

None

Plant Reports

Read-Only

Rules

None

Data Dictionary

None

Options

None

Insulation Specifications

None

Drawing Management

Undefined (do not choose


anything)

P&ID Objects

Modify Properties

Workshare

Undefined (do not choose


anything)

SmartPlant

Undefined (do not choose


anything)

SmartPlant P&ID Installation and Upgrade Guide

User Access

Managers
This group needs only view data access. They can set up personal filters, set up personal display
sets, and create My Reports. They should not be able to modify any project reference data or
perform any administrative tasks with respect to drawing management or Workshare activities.

Category

Right

SPEM Plant Structure


Access

Read-Only

Catalog

None

Plant Filters

Read-Only

Display Sets

Full-Control

Default Views

None

Formats

None

Plant Reports

None

Rules

None

Data Dictionary

None

Options

None

Insulation Specifications

None

Drawing Management

Undefined (do not choose


anything)

P&ID Objects

Read-Only

Workshare

Undefined (do not choose


anything)

SmartPlant

Undefined (do not choose


anything)

SmartPlant P&ID Installation and Upgrade Guide

101

User Access

102

SmartPlant P&ID Installation and Upgrade Guide

SECTION 12

Customizing Your Reference Data


Several tools are delivered during installation that allow you to customize your reference data.

Customizing Reference Data Options


Reference data options control the look and feel of the product and controls much of the data
used throughout the life of a project.
Use SmartPlant P&ID Options Manager to define how you want particular P&ID items to appear
in drawings by selecting colors, line styles, gapping styles, and heat tracing styles for the project.
1.
2.
3.
4.

Click Start > Programs > SmartPlant P&ID > Options Manager.
Define the symbology, gapping, heat tracing, formatting, and distances as needed.
Click Settings.
Verify that all \\node\share entries are set to the shares defined during reference data
installation.
5. Click File > Save.
For more information about working with reference data options, click Help > Printable Guides
in SmartPlant P&ID and select the Options Manager User's Guide.

Working with Filters


SmartPlant Filter Manager, delivered with SmartPlant Engineering Manager, allows you to
select the items to display in the engineering application. You can use this feature to clear the
view of other items to display one class of items.
For more information about working with filters, click Help > Printable Guides in SmartPlant
Engineering Manager and select the SmartPlant Filter Manager User's Guide.

Working with Formats


SmartPlant Format Manager, delivered with SmartPlant Engineering Manager, allows you to
define the characteristics and formats for labels, report data and formatted properties. You can
also create and edit formats.
For more information about working with formats, click Help > Printable Guides in SmartPlant
Engineering Manager and select the SmartPlant Format Manager User's Guide.

SmartPlant P&ID Installation and Upgrade Guide

103

Customizing Your Reference Data

Working with Symbols and Labels


Symbols include a graphic representation of the item as well as the properties associated with
that item. SmartPlant Catalog Manager, delivered with SmartPlant Engineering Manager, allows
you to create and edit these symbols.
Some of the characteristics of a SmartPlant symbol include the graphic representation of the
item, labels, heat tracing, the icon that represents the item in the Catalog Explorer, and the
properties associated with the item.
Two types of labels display important information about drawing items:
Driving Sets the property in the model, for example, a dimension that changes the size of
the object.
Driven Reports the property in the model, for example, a pressure label that takes its
pressure value from the associated pump.
For more information about working with symbols and labels, click Help > Printable
Guides in SmartPlant Engineering Manager and select SmartPlant Catalog Manager
User's Guide.

Modifying Data Model Properties


SmartPlant Data Dictionary Manager, delivered with SmartPlant Engineering Manager, allows
you to modify the data model properties, including the database entries, select lists, and item
types that form the underlying data structure.
With Data Dictionary Manager, you can perform the following tasks:
Add and change properties for specific database tables
Create select lists and add entries to them
Associate validation programs with various item types
Because your changes can affect the database for the entire project, only system administrators
and project managers typically customize the database with Data Dictionary Manager.
For more information about using Data Dictionary Manager, click Help > Printable Guides in
SmartPlant Engineering Manager and select SmartPlant Data Dictionary Manager User's
Guide.

Synchronizing Reference Data


SmartPlant Reference Data Synchronization (RDS) Manager provides tools for comparing,
synchronizing, and managing reference data across multiple plants. This application is
especially useful when you need to maintain a central set of reference data for all of the plants
across a site without having a network or database connection between plants.

104

SmartPlant P&ID Installation and Upgrade Guide

Customizing Your Reference Data


The reference data synchronization process involves three steps:
1. Creating an RDS package that contains the reference data from the source plant.
2. Comparing the RDS package to the target plant reference data.
3. Synchronizing (merging) the RDS package into the plant and application reference data at
the target.
For more information, see the SmartPlant Reference Data Synchronization User's Guide.
After synchronizing the reference data across the plants, you must use the Update
Drawings functionality in SmartPlant P&ID to synchronize the drawings in each plant with the
updated reference data. For more information about updating drawings, see the SmartPlant
P&ID Drawing Manager Users Guide.

Recommended Configuration
Select the plant whose reference data you want to use as the source reference data.
Create a data RDS package from the source plant.
Back up the target plant.
Lock down (set to read-only) the user access to the reference data at the source plants. Allow
full-control user access to the reference data only at the target plant.
Synchronize the target plants with the source plant RDS package.
Do not use the RDS Manager to synchronize reference data between a host and
satellites in a Workshare collaboration. Use the Workshare Synchronize Reference Data
command instead.

Establishing Design Rules


By defining typical or standard design rules, you can quickly and easily place required
equipment, interconnecting piping, instrumentation, and other accessories on a drawing. These
rules define the placement characteristics of items and how items interact with each other. Using
rules, you also confirm that you meet proper design criteria.
SmartPlant P&ID Rule Manager provides the tools for creating and editing rules. For more
information, click Help > Printable Guides in SmartPlant P&ID and click the Rule Manager
User's Guide link.

Configuring Border Templates


The delivered borders are embedded in the delivered template files. Before you can see
modifications made to the drawing border during the course of a project, you must edit (see
"Edit Delivered Templates" on page 107) the delivered templates. If you do not modify the
delivered template files, the borders of the drawings created with these templates will not be
modifiable on a global level. In other words, changes to border files do not show up in drawings
that are using the embedded border template files, which means that you can change the border
of drawings only on a drawing-by-drawing basis.

SmartPlant P&ID Installation and Upgrade Guide

105

Customizing Your Reference Data

SmartPlant P&ID Delivered Templates


SmartPlant P&ID delivers the following border templates.

Metric Templates

106

Template File

Border File

Page Size

A0-Size.pid

A0border.igr

A0 Wide
(1189mm x
841mm)

A1-Size.pid

A1border.igr

A1 Wide
(841mm x
594mm)

A1-Wide(Metric).pid

A1-Wide(Metric).igr

A1 Wide
(841mm x
594mm)

A1-Wide Note
Area.pid

A1-Wide Note Area.igr

A1 Wide
(841mm x
594mm)

A2-Size.pid

A2border.igr

A2 Wide
(594mm x
420mm)

A2-Wide(Metric).pid

A2-Wide(Metric).igr

A2 Wide
(594mm x
420mm)

A2-Wide Note
Area.pid

A2-Wide Note Area.igr

A2 Wide
(594mm x
420mm)

A3-Size.pid

A3border.igr

A3 Wide
(420mm x
297mm)

A3-Wide (Metric).pid

A3-Wide (Metric).igr

A3 Wide
(420mm x
297mm)

A4-Size.pid

A4border.igr

A4 Wide
(297mm x
210mm)

A4-Wide (Metric).pid

A4-Wide (Metric).igr

A4 Wide
(297mm x
210mm)

SmartPlant P&ID Installation and Upgrade Guide

Customizing Your Reference Data

Template File

Border File

Page Size

A5-Size.pid

A5border.igr

A5 Wide
(210mm x
148mm)

Template File

Border File

Page Size

A-Size.pid

A-Wide.igr

A Wide
(11in x 8.5in)

A-Wide (Imperial).pid

A-Wide (Imperial).igr

A Wide
(11in x 8.5in)

B-Size.pid

B-Wide.igr

B Wide (17in
x 11in)

B-Wide (Imperial).pid

B-Wide (Imperial).igr

B Wide (17in
x 11in)

C-Size.pid

C-Wide.igr

C Wide (22in
x 17in)

C-Wide (Imperial).pid

C-Wide (Imperial).igr

C Wide (22in
x 17in)

C-Wide Note Area


(Imperial).pid

C-Wide Note Area


(Imperial).igr

C Wide (22in
x 17in)

D-Size.pid

D-Wide.igr

D Wide
(34in x 22in)

D-Wide (Imperial).pid

D-Wide (Imperial).igr

D Wide
(34in x 22in)

D-Wide Note Area


(Imperial).pid

D-Wide Note Area


(Imperial).igr

D Wide
(34in x 22in)

E-Size.pid

E-Wide.igr

E Wide (44in
x 34in)

English Templates

Edit Delivered Templates


Before editing the delivered templates, verify that the correct plant structure has been selected
and that no drawings are open.
1. In Windows Explorer, browse to the default templates location defined in Options Manager
or the location of the reference data of your plant.

SmartPlant P&ID Installation and Upgrade Guide

107

Customizing Your Reference Data


2. Select the template that matches the system of units and page size requirements for the
drawing and double-click the template file to open it in SmartPlant P&ID. Refer to the
previous chart to determine the appropriate template and border files.
You also can drag the template file into the application window to open the template
file.
3.
4.
5.
6.
7.
8.
9.
10.
11.

Select the existing border file, and press Delete.


Click Edit > Insert > Object.
Clear the Link check box to be sure the item will be embedded.
Click Browse.
Click the border file to use. You can use the delivered border or choose another border.
Click Open.
Click OK on the Insert Object dialog box.
Position the border file in the template.
Click File > Exit.

Create a Border Template


1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.

108

Start SmartPlant P&ID.


Verify that the correct plant structure has been selected.
Click File > New Template.
Click File > Page Setup.
Select the sheet size in the Standard option and then click OK.
Click File > Properties.
On the Units tab select a unit in the Length, Angle, and/or Area Readout boxes to specify
the default units of measure, and then click OK.
Click Edit > Insert > Object.
Verify that Link is on if you want the border file linked, or clear the Link check box if you
want to link the file.
Select the border to use and click Open, and then click OK.
Click File > Save.
Type the name for the template in the File Name box.
Save the template border in the default templates location defined in Options Manager.
Click Save.
Click File > Exit.

SmartPlant P&ID Installation and Upgrade Guide

SECTION 13

Using SmartPlant P&ID in Production


SmartPlant Drawing Manager handles all of the drawing file maintenance tasks by allowing you
to create, open, update, and delete drawings, and to modify drawing properties and print multiple
drawings. See both the SmartPlant P&ID Drawing Manager and the SmartPlant P&ID Help
files for more information about handling drawings.
Before using the new version of the software, we strongly recommend that you
completely upgrade your plant and all drawings to the current version. A plant with a mixture of
upgraded and non-upgraded drawings may result in some data being permanently inaccessible.

Start SmartPlant P&ID


1. Click Start > Programs > SmartPlant P&ID > Drawing Manager.
2. Click File > Open Database. If the plant that you want appears in the Available plant
structures list, select the plant and go to step 6.
3. On the Open Plant Structure dialog box, click Site Server.
4. On the Open Site Server dialog box, select the correct SmartPlantv4.ini file and click
Open.
5. Select the plant in the Available plant structures list.
6. Click Open. The Open command checks to make sure you have the correct access
privileges for the selected plant structure and passes your access information back to the
software.
7. In the Tree view, click through the plant hierarchy nodes until you find the drawing you
want to work with.
8. Double-click the drawing in the list of drawings to open it in SmartPlant P&ID.
You can also open drawings directly from within SmartPlant P&ID. To do this, follow the
steps 1-6 above to connect to the plant database, then close Drawing Manager, open SmartPlant
P&ID, then click File > Open to navigate to the drawing. For more information, see the
SmartPlant P&ID User's Guide.

Tips for Creating a P&ID Drawing


With SmartPlant P&ID, you can easily perform the tasks required to create a detailed plant
model. You can place components such as equipment, piping, and instrumentation from Catalog
Explorer or the stockpile into graphical representations of your plant model in the drawing.
SmartPlant P&ID provides multiple views of a central, unified data structure that represents the
plant model. The plant model is the computer representation of the conceptual design in its
entirety, including all plant components and their relationships. By manipulating model views,
you can organize the information within the plant model to better understand and maintain the
data. A view is a visual presentation of the data that composes the plant model. A view can be a
schematic drawing, a table, or a report.
SmartPlant P&ID Installation and Upgrade Guide

109

Using SmartPlant P&ID in Production


Assemblies One key feature of SmartPlant P&ID is using catalogs to create instances of
components within the plant model. The standard modeling environment lets you place items
from the catalog into the appropriate model views. If you repeatedly place particular groups of
items, you can save the group of items as an assembly. Assemblies appear as symbols in the
Catalog Explorer list view so that you can place them exactly as you place other symbols in
your drawing.
Properties Window Allows you to add values for various properties of each item after you
place it in your drawing. Also, you can annotate your drawing with labels as you design the
drawing.
Consistency Checking - As you work on your drawing, you can monitor any inconsistencies in
your design by reviewing the inconsistency indicators. These indicators appear in your drawing
as soon as an inconsistency occurs in the design. You can resolve inconsistencies using solutions
from the Consistency Check dialog box.
Reporting Reports help you keep track of information in the drawing. For example, after you
finish the drawing, you can generate order lists for the components in the drawing.
Display Sets Replacing the former display tab functionality, displays sets allow you to
control the display of the model in the Drawing view. Display sets use filters you define to
control which symbols you want to display. You can also define colors and widths for display
items, then save these filters and share them with other users working in the same plant, and use
these filters to print a subset of the entire drawing.
Use the UpgradeTabsCMD.dll to convert display tabs created in previous SmartPlant
P&ID versions to display sets. The new display set displays in My Display Sets folder. For
more information, see Display Tabs Conversion Utility in the SmartPlant P&ID Utilities Guide.

Recreating Drawings
SmartPlant P&ID continually updates the database as you edit a drawing; however, the drawing
file is not updated until the file is saved (that is, when you click File > Save or when you exit
SmartPlant P&ID). Occasionally, the software may terminate abnormally due to power outages,
and so forth. As a result, the database is up-to-date with changes posted to the drawing, but the
drawing file reflects the status when it was last saved. When a drawing is re-opened, the
software recognizes that the drawing file is different from the database.
When the software notifies you that a re-create is necessary, click OK to re-create the drawing
from the database. Do not interfere with the re-create process once it is started or else the
drawing can become unusable.
For best system performance, close all other applications except for SmartPlant P&ID when
running the re-create process.
During the re-create process the status bar at the bottom of the P&ID window displays
updates about the particular elements currently being reconciled with the database. You can
check the log file, Recreate[Drawing#].log, in the Temp directory for any problems that may
have occurred during the re- create process.

110

SmartPlant P&ID Installation and Upgrade Guide

Using SmartPlant P&ID in Production


If your reference data has changed, use the Update Drawings functionality to incorporate
those changes into your existing drawings. For more information, see the SmartPlant P&ID
Drawing Manager User's Guide.
After the re-create process finishes, SmartPlant P&ID reinitializes the drawing. Review the recreated drawing and resolve any errors that occurred.

Resolving Error Conditions


If a section of the drawing could not re-create successfully, an error condition appears on the
drawing as a highlighted line (orange by default). Error conditions are almost always associated
with a pipe or signal run and must be resolved manually.
1. Delete the heavy orange line segment and components directly connected to it.
2. Re-route the line runs and replace all connections and components as required.

Filtered Printing
The Display Set functionality allows you to print a drawing using multiple filters. Using the
Print filter options on the Print dialog box in Drawing Manager, you can select the display set
that specifies which symbols in the drawing to print. If no display set is applied, the entire
drawing prints.

SmartPlant P&ID Installation and Upgrade Guide

111

Using SmartPlant P&ID in Production

112

SmartPlant P&ID Installation and Upgrade Guide

SECTION 14

Working with SmartPlant Integration


Overview
SmartPlant integration standardizes and improves the communication among the various
authoring tools you use in the course of designing, constructing, and operating a plant.
SmartPlant integration manages data exchange among these authoring tools, which enables
sharing and re-use of plant information throughout the plant lifecycle. SmartPlant Foundation
acts as a repository for data and a medium through which information is shared among other
tools, such as SmartPlant Electrical, SmartPlant Instrumentation, SmartPlant P&ID, SmartPlant
3D, and Zyqad.
Most of the commands that provide access to SmartPlant integration functionality exist in the
common user interface available on the SmartPlant menu in Engineering Manager, SmartPlant
Instrumentation, SmartPlant Electrical, SmartPlant P&ID, and Drawing Manager.
The following graphic displays what SmartPlant P&ID publishes and retrieves and shows the
flow of data and the different types of data.

SmartPlant P&ID Installation and Upgrade Guide

113

Working with SmartPlant Integration


SmartPlant P&ID interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents from SmartPlant
Foundation. Also, SmartPlant P&ID creates a set of tasks in the To Do List that you can run to
update the plant database. In SmartPlant P&ID, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation
Web Client in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For more
information, see SmartPlant Engineering Manager Help.

Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant Electrical or SmartPlant Instrumentation, you must register each plant in SmartPlant
P&ID with a SmartPlant Foundation database. The connection allows SmartPlant P&ID to use
the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator
typically registers a plant.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.

Preparing the Integrated Environment


To enable SmartPlant P&ID to work in an integrated environment, you must do the following:
1. Install the Schema Component and the SmartPlant Client, delivered with SmartPlant
Foundation, on each SmartPlant Engineering Manager and P&ID workstation. For more
information about installing these components, see the SmartPlant Enterprise Installation
and Setup Guide.
Before you install the Schema Component and the SmartPlant Client, be sure to install
the software prerequisites described in the SmartPlant Client Workstations section of the
SmartPlant Enterprise Installation and Setup Guide.
2. Use a hierarchy that contains a minimum of three levels when you create your plant in
SmartPlant Engineering Manager.
In addition to requiring a minimum of three-levels in hierarchies, SmartPlant
configurations also require that the names of hierarchy items cannot be changed after they
are created and that the hierarchy structure cannot be modified after you create the project.
For more information, see the SmartPlant Enterprise Installation and Setup Guide or the
Using Custom Hierarchies in SmartPlant topic in the SmartPlant Engineering Manager
User's Guide.
3. Associate applications with and assign user access rights to your plant.
114

SmartPlant P&ID Installation and Upgrade Guide

Working with SmartPlant Integration


When SmartPlant P&ID and SmartPlant Electrical are both enabled for a plant, they
are both enabled for all projects in that plant. If a project requires only one of these
applications, create separate plants in the project, then enable SmartPlant P&ID for one plant
and SmartPlant Electrical for the other.
4. Edit the SmartPlant resource path setting in Options Manager to point to the folder where
you installed the Integration Resource Files.
The path specified in Options Manager must contain the tool schema (for
example, SPIDDataMap.xml) for publish and retrieve operations between the tool and
SmartPlant to work properly. For more information, see the SmartPlant P&ID User's Guide.
5. Register your SmartPlant plant with SmartPlant Foundation, as described in the SmartPlant
Engineering Manager Help.
When you register your plant, you must specify the location of the SmartPlant
Engineering Manager schema map file (SPEMDataMap.xml). For more information,
see the Specify Map File Dialog Box topic in the SmartPlant Engineering Manager
User's Guide.
If only one application is associated with the plant at the time it is registered, only that
application is registered. If another application is later associated with the plant, the
Register command is enabled so that you can register the new application with the plant.

Tool Requirements for Integrating SmartPlant P&ID


The following lists include rules that must be followed when using SmartPlant P&ID when
working in an integrated environment. Following these rules allows SmartPlant P&ID data to be
shared correctly with SmartPlant 3D, SmartPlant Instrumentation, and the other tools that are
part of the integrated environment. Other tools that are not listed here have no known
SmartPlant P&ID/SmartPlant integration issues.

General Integration Requirements


The following is a list of best practice scenarios for using SmartPlant P&ID so data will migrate
correctly to the other SmartPlant tools.
When working with Projects and As-built, all instruments in the Instrument Index must be
placed on a P&ID drawing. This is because the Stockpile is not communicated back and
forth between Projects and As-Built.
SmartPlant P&ID retrieves equipment components and nozzles and generates corresponding
create tasks in the To Do List for them. The system allows you to automatically place the
items in a drawing when the To Do List task is executed. The items are placed attached to
their parent equipment item, based on a spacing algorithm. You can adjust the location and
post-placement as necessary.

SmartPlant P&ID Installation and Upgrade Guide

115

Working with SmartPlant Integration

Working with SmartPlant Instrumentation


Connect to Process Lines
Connect to Process lines are required for connecting instruments to equipment nozzles and
pipe runs in SmartPlant P&ID.
All non-piped offline equipment instruments must be connected to vessels through nonelectric signal lines and nozzles in SmartPlant P&ID. This enables SmartPlant
Instrumentation to recognize that instruments are connected to vessels.
If SmartPlant P&ID assigns an object to an intermediate level in the hierarchy and publishes,
SmartPlant Instrumentation will assign the object to the level in the hierarchy in SmartPlant
Instrumentation determined by their logic. Because instruments belong to units in
SmartPlant Instrumentation, an instrument assigned to the intermediate level in SmartPlant
P&ID will be assigned to the unit in SmartPlant Instrumentation. Panels will be assigned to
the plant. SmartPlant P&ID may get an update on retrieve to move the object to another
level in their hierarchy than where it was published based on the move done automatically
by SmartPlant Instrumentation. Instruments will move to the top level; panels will move to
the bottom.

Deleting and Adding Items


When you are working in a Projects environment, and items are correlated using the
SmartPlant integration tools, you should minimize deleting and re-adding any items.
SmartPlant P&ID will reuse tag numbers in the numbering scheme when you delete and readd items. SmartPlant Instrumentation tracks tag numbers claimed in a project, and this
tracking will not work if tag numbers are reused after correlation. If you must delete an item
in this situation, you can delete the item to the SmartPlant P&ID Stockpile.

Ports
SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
SmartPlant Instrumentation publishes the physical ports with the Dimensional Data Sheets
and not the Instrument Index. SmartPlant P&ID retrieves the Instrument Index and does not
retrieve the Dimensional Data Sheets.
When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, followed by
SmartPlant Instrumentation publishing the Dimensional Datasheet, a Same As relationship is
created between the ports in the SmartPlant Foundation database. That Same As relationship
is required by SmartPlant 3D to correctly match the design basis ports to the 3D
representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in the SmartPlant Foundation database. Without the
Same As relationship created in the SmartPlant Foundation database, the result may be
additional ports in SmartPlant 3D. To obtain the Same As relationship on the ports requires
that SmartPlant P&ID publish the P&ID with the instrument, this P&ID be retrieved by
SmartPlant Instrumentation and then having SmartPlant Instrumentation publish the
Dimensional Datasheet.

116

SmartPlant P&ID Installation and Upgrade Guide

Working with SmartPlant Integration

Working with SmartPlant 3D


Piping
Deleting pipe runs should be avoided in SmartPlant P&ID. You should either use the
SmartPlant P&ID Undo command or try to reconnect the pipe run correctly. Deleting pipe
runs in SmartPlant P&ID causes delete instructions to be passed to SmartPlant 3D which
requires a SmartPlant 3D user to remodel the pipe runs.

Working with Zyqad


Retrieving Documents
Zyqad datasheets can contain multiple objects and may be formatted in a traditional
datasheet view or list view (for example, as an equipment list). Datasheets retrieved from
Zyqad may include stream data, specialty piping data, or relief valve data as required by
business practices.

Using Nozzles, Projects and Claiming in the SmartPlant Environment


When using Projects in an integrated environment and SmartPlant P&ID claims a pump but
not the motor and then publishes, when Zyqad retrieves, they will respond to the claim on
the pump and then claim the motor. When Zyqad publishes, both the pump and motor are
published. When P&ID retrieves they get the update on the pump and get a create task for
the motor, even though they can clearly see the motor on the P&ID. Without it being
claimed to the P&ID project it is not acknowledged as belonging to the project.
The same holds true for the equipment and nozzle issue. SmartPlant P&ID permits an
equipment object to be claimed to the project without requiring the nozzles to be claimed,
even if the nozzles are seen on the P&ID. Zyqad's claim method does not support this. When
Zyqad retrieves the equipment claim it claims the nozzles along with the equipment. When
P&ID retrieves from Zyqad the nozzles are Create tasks since P&ID is not looking to
retrieve Claim status from other tools.
In these cases, either the P&ID user will have to delete the create tasks or agree to add the
objects to the project scope. If they agree to add them to the project scope they should delete
the create tasks first, then claim the objects and then re-retrieve the Zyqad document. This
would generate update tasks. Optionally, since Zyqad requires all related nozzles to be
claimed when claiming equipment, when claiming equipment in SmartPlant P&ID, all
nozzles could be claimed. This causes the scopes of the claims between Zyqad and
SmartPlant P&ID to match.

Using Workshare in an Integrated Environment


The following rules apply to using the Workshare functionality within an integrated SmartPlant
environment.
You can enable and disable Workshare before or after registering a Greenfield plant.
You can create satellites and connect to them after registering.

SmartPlant P&ID Installation and Upgrade Guide

117

Working with SmartPlant Integration


You cannot register a satellite.
You cannot retrieve a WBS document when Workshare is enabled.

Using the Integration Commands Within a Workshare Collaboration


The Workshare host can perform the following actions from within SmartPlant P&ID when
registered. For more information about these commands, see the SmartPlant P&ID User's
Guide.
Publish - Any drawing can be published.
Retrieve - Any SmartPlant document can be retrieved.
Correlate - Reviewing correlation is available if the drawing is in a read-only state. It is not
possible to assign correlation in a read- only drawing.
To Do List - Only available at the Workshare Host. To Do List tasks may be reviewed on
drawings for which the host does not have ownership, but these tasks may not be executed
unless ownership is assigned to the Host. The To Do List is not available at the Satellite.

Using the Catalog Index in SmartPlant P&ID and SmartPlant


Integration
When you select the Retrieve command, the software accesses the CatalogIndex.mdb and the
system performs the following options:
1. Using the retrieved document, the object type and classification of the retrieved item is
determined.
2. Using the SmartPlant P&ID Map file, the ItemTypeName (Equipment, PipeRun,
PipingComp, and so forth), and codelist indices for Class, Sub-Class, and Type is
determined.

Catalog Index Lookup


The Catalog Index file is used to find a symbol in the catalog with type properties that match the
given values. The lookup is performed using the most specific information first. If a match is
found, that symbol is used. However, if there is no match, the more generic type information is
used for additional searches. In this way, a generic symbol will be returned if no specific symbol
is available in the catalog.
Search Based on Type Value - Searches the catalog index for all rows with matching
ItemTypeName and Type values and IsDefaultForType = True. If one or more rows are found,
then use the CatalogItemName from the first one. If no match is found, then perform the search
based on Subclass.
Search Based on Subclass Value - Searches the catalog index for all rows with matching
ItemTypeName and SubClass values and IsDefaultForSubclass = true. If one or more rows are
found, then use the CatalogItemName from the first one. If no match is found, then perform the
search based on Class.

118

SmartPlant P&ID Installation and Upgrade Guide

Working with SmartPlant Integration


Search Based on Class Value - Searches the catalog index for all rows with matching
ItemTypeName and Class values and IsDefaultForClass = True. If one or more rows are found,
then use the CatalogItemName from the first one. If no match is found, then return an empty
string.

Mapping for SmartPlant Integration


If you customize the plant database items or attributes in your SmartPlant Engineering Manager
plant, you must define the mapping between these customized plant attributes and the properties
in the SmartPlant schema.
1. Open the plant data dictionary by right-clicking the plant in the Tree view in SmartPlant
Engineering Manager and selecting the Data Dictionary Manager command. For more
information, see Data Dictionary Manager Command (SPEMToolsDataDictMgrCMD.htm).
2. Add or modify the attributes in Data Dictionary Manager for each level in your hierarchy.
For more information, see the Add a Property to Database Tables topic in the Data
Dictionary Manager User's Guide.
3. Open the plant SPEMDataMap.xml schema map file in the Schema Editor and map the plant
database items between the tool schema (SPEMDataMap.xml) and the SmartPlant schema.
For more information, see the Schema Editor User's Guide.
If you add an enumerated list attribute to the plant data dictionary, see the Hierarchical
Enumerated Lists topic in the SmartPlant P&ID User's Guide for information about
mapping these complex data types.
The default SPEMdatamap.xml file contains the EF_SPAPlant attributes (CompanyName,
SiteName, SiteLocation, DivisionName, DivisionLocation). To use these default attributes,
use the EF_SPAPLANT.ddt when creating your plant in SmartPlant Engineering Manager.
The default SPEMdatamap.xml and the EF_SPAPLANT.ddt files are delivered to the
C:\Program Files\SmartPlant\Engineering Manager\EFResources folder.

Using Custom Hierarchies


SmartPlant integration supports custom hierarchies, as long as they contain a minimum of three
levels. By default, the delivered SPEMdatamap.xml file is compatible with the standard
SmartPlant Plant > Area > Unit hierarchy.
After registering, SmartPlant Engineering Manager cannot retrieve the PBS document if the
plant and SmartPlant hierarchies are not compatible. To be compatible with the SmartPlant
hierarchy, your plant hierarchy can contain less than or equal, but not more than the number
of levels in the SmartPlant hierarchy.

SmartPlant P&ID Installation and Upgrade Guide

119

Working with SmartPlant Integration


SmartPlant Engineering Manager retrieves from the SmartPlant hierarchy only the hierarchy
levels it needs. For example, if your plant hierarchy contains 4 levels and the SmartPlant
hierarchy contains 8 levels, only the top 4 levels of the SmartPlant hierarchy are retrieved.
Hierarchy item names at the same level do not have to match. Hierarchies are mapped by
depth (level), not by name.
In addition to requiring a minimum of three-levels in hierarchies, SmartPlant integration also
requires that the names of hierarchy items cannot be changed after they are created and that
the hierarchy structure cannot be modified after you create the project. For more
information, see the SmartPlant Enterprise Installation and Setup Guide.

Register Command (SmartPlant Menu)


Allows you to register a plant database, along with its associated applications, with an instance
of SmartPlant Foundation. Each database must be registered before you can connect to
SmartPlant Foundation to perform any specific tasks, such as publishing or retrieving files. You
can register each plant database only once.
During registration, the software maps the plant database, all of its projects, and all of its the
associated applications to a single SmartPlant Foundation URL, which points to one SmartPlant
Foundation plant database, and returns a unique signature for the tool/plant combination being
registered.
You must install the Schema Component and the SmartPlant Client, delivered with
SmartPlant Foundation, on your SmartPlant Engineering Manager workstation before you
can register. For more information, see the topic Configure SmartPlant P&ID for an
Integrated Environment in the appropriate Installation and Upgrade Guide.
If only one application is associated with the plant at the time it is registered, only that
application is registered. If another application is later associated with the plant, you must
also register the new application with the plant.
We recommend that you re-register each tool with SmartPlant Foundation after upgrading
that tool to the current software version.
After the plant is registered, the SmartPlant tab is added to the Plant Structure Properties
dialog box. The SmartPlant tab displays the SmartPlant Foundation URL, the SmartPlant
Foundation plant database, and the unique application identifiers returned by the registration
process.

120

SmartPlant P&ID Installation and Upgrade Guide

Index
Options Manager 103
reference data 103
rules 105
symbols 104

A
adding users 84
user groups 84

B
backing up 61
upgraded plants 61
backup locations 81
sharing 81
border templates 105, 106, 107, 108
configuring 105
creating 108
delivered 106, 107
break componenet 64, 66, 68
update drawings 64, 66, 68
break labels 62
upgrading 62

C
catalog index 115
CatalogIndex.mdb 115
out-of-date 115
retrieving symbols 115
updating 115
configuring 12, 36, 69, 81, 105
border templates 105
Integration Resource Path 36
network shares 81
Oracle networking 12
reference data 36
SmartPlant Engineering Manager 69
correcting 110
error conditions 110
creating 82, 108, 109
border templates 108
P&IDs 109
user groups 82
customizing 103, 104, 105, 106, 107
border templates 105, 106, 107
data model 104
filters 103
formats 103
labels 104
SmartPlant P&ID Installation and Upgrade Guide

D
Data Dictionary Manager 104
data model 104
customizing 104
database 11, 12, 20
database constraints 45, 46, 47, 49
utilities 47
database servers 7
configuration 11, 12
networking components 12
Oracle ARCHIVELOG mode 20
Oracle Cost Based Optimizer 20
system requirements 7
tuning 20
display sets 111
printing 111
Drawing Manager 2, 109
overview 2
starting SmartPlant P&ID 109
drawings 64, 66, 67, 68, 110, 111
out-of-date criteria 66, 67, 68
printing 111
re-creating 110
re-creating errors 110
updating 64

E
error conditions 110

F
Filter Manager 103
filtered printing 111
filters 103
customizing 103
Format Manager 103
formats 62, 103
upgrading 62

121

Index

H
hardware 7, 8
hardware requirements 7
database servers 7
requirements 7
workstation 8

I
installation 36
Installation Guide 2
overview 2
silent mode 36
installing 11, 31, 32, 33, 35
database 11
reference data 35
SmartPlant 31
SmartPlant 3D client 31
SmartPlant Engineering Manager 32
SmartPlant P&ID 31, 33
Insulation Manager 2
integration 11, 114
preparing the environment 114
supported Oracle versions 11

L
labels 104
customizing 104
logs 61

N
network access privileges 84
granting to user groups 84
network shares 81
backups 81
plant structure 81
role template 81
site server 81
Novell networking 85
user groups 85

O
Options Manager 2, 103
customizing 103
overview 2
Oracle 20, 61
Oracle analyzer scripts 61
analyzer scripts 61
122

ARCHIVELOG mode 20
Cost Based Optimizer 20
statistics 61
tuning 61
out-of-date 64, 66, 68
resolve drawings 66, 68
update drawings 64, 66, 68
overviews 1
SmartPlant P&ID 1

P
permissions 31
piping specification 31
PipingPoint 61
placing 109
items 109
plant structures 81
sharing 81
printing 111
filtered 111
P&IDs 111

R
recommendations 7
database servers 7
re-creating drawings 110
reference data 35, 36, 62, 63, 103
configuring 36
customizing 103
installing 35
Integration Resource Files 36
Integration Resource Path 36
Options Manager 103
upgrading 62, 63
registering 113
with SmartPlant Foundation 113
registry 31
requirements 7, 8
database servers 7
hardware 7
software 7
workstation 8
role templates 81
sharing 81
Rule Manager 2, 105
overview 2
rules 105

SmartPlant P&ID Installation and Upgrade Guide

Index
database servers 7

rules for integrating authoring and viewing


tools
customizing 105

tasks 61, 62
understanding 61, 62

servers 7
database 7
silent mode installation 36
site administrators 84, 85
network access privileges 84
Novell networking 85
user group 84
site servers 81
sharing 81
SmartPlant 31
SmartPlant 3D 31
installing remote access client 31
SmartPlant Engineering Manager 32, 69,
113
configuring 69
installing 32
SmartPlant Foundation 113
SmartPlant integration 11, 114
preparing the environment 114
supported Oracle versions 11
SmartPlant P&ID 1, 2, 31, 109
Drawing Manager 2, 109
installing 31
Insulation Manager 2
Options Manager 2
overviews 1
Rule Manager 2
starting 109
using 109
SmartPlant SmartPlant P&ID 33
installation 31
installing 33
software 8
requirements 7
workstation 8
starting 109
P&IDs 109
SmartPlant P&ID 109
subtasks 61, 62
symbols 104, 115
customizing 104
retrieving 115
system requirements 7

SmartPlant P&ID Installation and Upgrade Guide

U
updating 64
P&IDs 64
upgrade 61, 62
upgrade tasks 61, 62
logs 61
manual changes 62
tasks 61
understanding 61, 62
upgrading 47, 49, 50, 51, 61, 62, 63, 64, 66,
68
after 61
backing up after 61
backing up old data 50
break labels 62
cleanup macros 49
constraint utilities 47
formats 62
memory management 51
Oracle 61
plants 61
reference data 62, 63
setting Open_Cursors parameter 50
sharing paths 50
update drawings 64, 66, 68
user customizations 61
user groups 82, 84, 85
adding users 84
creating 82
network access privileges 84
Novell networking 85
customization 61
utilities 47
Clean Data 47
DelOrphModItem.dll 47

W
Workshare 115

Z
Zyqad 115
123

Index
retrieving documents 115

124

SmartPlant P&ID Installation and Upgrade Guide