You are on page 1of 107

SmartPlant Electrical

Installation and Upgrade Guide

Version 2015 (7.0)

January, 2015

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

U.S. Government Restricted Rights Legend


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

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

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

Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

2 SmartPlant Electrical Installation and Upgrade Guide


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

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

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

SmartPlant Electrical Installation and Upgrade Guide 3


4 SmartPlant Electrical Installation and Upgrade Guide
Contents
Welcome to SmartPlant .............................................................................................................................. 9
Installation Checklist ............................................................................................................................... 9
Introducing SmartPlant Electrical ............................................................................................................ 9
SmartPlant Electrical Program Group ............................................................................................ 10
SmartPlant Engineering Manager ......................................................................................................... 11
SmartPlant Engineering Manager Program Group ........................................................................ 11

Internationalization .................................................................................................................................... 13

Hardware and Software Recommendations ........................................................................................... 17


SmartPlant Electrical Database Server ................................................................................................ 17
SmartPlant Electrical Workstation......................................................................................................... 18

Before You Install ...................................................................................................................................... 21


Loading SmartPlant Electrical Prerequisite Software ........................................................................... 21
Using Environment Variables for Tracking Licensing ........................................................................... 22
Add an Environment Variable ......................................................................................................... 22

Oracle Installation and Configuration ..................................................................................................... 23


Configure Oracle Networking Components .......................................................................................... 24
Oracle Installation Work Process .......................................................................................................... 24
Installing Oracle Database Server ........................................................................................................ 25
Install Oracle Database Server ...................................................................................................... 25
Create an Oracle Listener ..................................................................................................................... 26
Creating an Oracle Instance ................................................................................................................. 26
Requirements for Oracle Instance Creation ................................................................................... 26
Create a New Oracle Instance ....................................................................................................... 27
Oracle System User Requirements ...................................................................................................... 32
Installing Oracle Client .......................................................................................................................... 32
Prerequisites ................................................................................................................................... 33
Install Oracle Client ........................................................................................................................ 33
Oracle Tuning Recommendations ........................................................................................................ 34

Microsoft SQL Server Installation and Configuration ........................................................................... 37


Modify Logon Information for SQL Server Services ............................................................................. 38
Install SQL Server 2005 ........................................................................................................................ 38
Install SQL Server Database Server ..................................................................................................... 39
Configure SQL Server Database Server .............................................................................................. 41
Set Database Maintenance Options for SQL Server ............................................................................ 43
Run DBCC Utility Options for SQL Server ..................................................................................... 43
Update Statistics for SQL Server ................................................................................................... 43

SmartPlant Electrical Installation and Upgrade Guide 5


Contents

Installing the Software .............................................................................................................................. 45


Setting up the Database ....................................................................................................................... 45
Installing .NET Framework in a 64-bit Environment ............................................................................. 45
Grant Permissions to Write to a Registry Key ...................................................................................... 46
Uninstall a Previous Version of SmartPlant Electrical .......................................................................... 46
Install SmartPlant Electrical .................................................................................................................. 47
Install Additional Software ..................................................................................................................... 48
Modify or Uninstall the Latest Version of SmartPlant Electrical ............................................................ 49
Installing SmartPlant Electrical in Silent Mode ..................................................................................... 50
Install SmartPlant Electrical in Silent Mode .................................................................................... 51
Silent Mode Example Scripts ......................................................................................................... 55

Configuring Reference Data for SmartPlant Electrical .......................................................................... 57


Install SmartPlant Electrical Reference Data ........................................................................................ 57

Working in Thin Client Mode .................................................................................................................... 59


Tuning the Software for Use in Thin Client Mode ................................................................................. 59
Create Global Objects ........................................................................................................................... 60
Publish the SmartPlant Application using Citrix Presentation Server ................................................... 60
Publish SmartPlant Applications Using XenDesktop 7.0 RDS ............................................................. 61

Upgrading to SmartPlant Electrical 2015 ................................................................................................ 67


Requirements Before Upgrading .......................................................................................................... 67
Back Up Your Data ......................................................................................................................... 67
Share Paths to Site .INI Files ......................................................................................................... 67
Set Oracle Parameters ................................................................................................................... 67
Memory Management Considerations ........................................................................................... 68
Upgrading Sites, Plants, and Applications ............................................................................................ 69
Upgrade a Site ................................................................................................................................ 70
Upgrade a Plant .............................................................................................................................. 70
Upgrade SmartPlant Electrical ....................................................................................................... 71
Upgrade Plants with the Batch Upgrade Command ...................................................................... 72
Upgrade Utility Commands ............................................................................................................ 73
Post-Upgrade Tasks ............................................................................................................................. 75
Backup Each Upgraded Plant ........................................................................................................ 75
Use Oracle Analyzer Scripts .......................................................................................................... 75
Preserve Software Customizations ................................................................................................ 75
Upgrade Site Command (Tools Menu)........................................................................................... 75

User Access ............................................................................................................................................... 77


SmartPlant Electrical User Rights ......................................................................................................... 78
SmartPlant Electrical User Rights Examples ................................................................................. 87
SmartPlant Electrical Plant Group Permissions ............................................................................. 89
View Access Rights by Plant Group ............................................................................................... 90
View Access Rights by Role ........................................................................................................... 90
Access Rights Command (Tools Menu) ......................................................................................... 90
Access Rights Dialog Box .............................................................................................................. 91

6 SmartPlant Electrical Installation and Upgrade Guide


Contents

Customizing Your Reference Data .......................................................................................................... 93


Customizing Reference Data Options .................................................................................................. 93
Working with Filters ............................................................................................................................... 93
Working with Formats ........................................................................................................................... 93
Working with Symbols and Labels ........................................................................................................ 94
Modifying Data Model Properties .......................................................................................................... 94
Establishing Design Rules .................................................................................................................... 94
Configuring Border Templates .............................................................................................................. 95
SmartPlant Electrical Delivered Templates .................................................................................... 95
Edit Delivered Templates ............................................................................................................... 96
Create a Border Template .............................................................................................................. 96

Working with SmartPlant Integration ...................................................................................................... 99


Preparing the Integrated Environment ................................................................................................ 100
Tool Requirements for Integrating SmartPlant Electrical .................................................................... 101
Integration with SmartPlant Instrumentation ................................................................................ 101
Integration with Smart 3D ............................................................................................................. 102
Integration with SmartPlant P&ID ................................................................................................. 103
Using Projects in an Integrated Environment ............................................................................... 103
Mapping for SmartPlant Integration .................................................................................................... 104
Using Custom Hierarchies in an Integrated Environment ................................................................... 104
Register Command (SmartPlant Menu) .............................................................................................. 105

Index ......................................................................................................................................................... 107

SmartPlant Electrical Installation and Upgrade Guide 7


Contents

8 SmartPlant Electrical 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 Electrical Installation Checklist:
SPELInstall_Checklist.xlsx. The checklist is located in the same folder as this installation guide.

Introducing SmartPlant Electrical


SmartPlant Electrical is a true engineering solution for planning and describing electrical
equipment in your plant. SmartPlant Electrical is designed to meet specific needs of electrical
engineers by automating work processes, complying with corporate or project standards and
manipulating electrical data throughout the plant and project lifecycle. You can create electrical
equipment and components and then dynamically associate among them.
You can generate single line diagrams and schematic drawings without an external CAD engine
and thus generate these deliverables automatically, creating graphical reports based on the
engineering work itself. Electrical engineering deliverables include electrical equipment list
reports, consumer list and load summaries, power distribution board design, single-line
diagrams and schematic drawings, as well as cable lists and wiring reports.
SmartPlant Electrical supports the major commercial databases and outputs drawings in
common CAD formats including SmartSketch, and generates reports in Microsoft Excel format.
SmartPlant Electrical 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 Electrical does not require a traditional,
expensive CAD engine for the creation of single line diagrams and schematics. The open
architecture of SmartPlant Electrical permits integration with other systems, such as Intergraph
SmartPlant Instrumentation and ETAP, all of which allow users to share data with third-party
software.

SmartPlant Electrical Installation and Upgrade Guide 9


Welcome to SmartPlant

SmartPlant Electrical Program Group


SmartPlant Electrical 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
single line diagram 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 Electrical has several programs and utilities for running and managing your plant
data.

SmartPlant Electrical allows you to design and maintain the electrical


equipment and documentation for process plants, refineries, and so
forth.

SmartPlant Electrical Import Manager allows you to import data to


SmartPlant Electrical from external data files and various database
platforms, such as Microsoft Access, Microsoft SQL Server, Oracle,
and so forth.

SmartPlant Electrical Options Manager allows you to define


plant-wide default preferences, customize formats, naming
conventions, item types, and set cable sizing parameters. Options
Manager also defines default paths to data files and directories.

SAP Wizard allows you to specify parameters needed to create a data


file that is used to export data from SmartPlant Electrical to SAP.

SmartPlant Electrical Document Server Utility allows users of


SmartPlant Electrical Document Viewer to define the location of the
documents that are retrieved for viewing.

SmartPlant Electrical Rule Manager allows you to define an


environment used for creating, manipulating and managing sets of
consistency rules that apply whenever a user associates two items or
modifies properties of a certain item tag in SmartPlant Electrical.

If you installed SmartPlant Electrical API Programming Help, it is available in the Help of
Visual Studio 2012 or Visual Studio 2013.
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.

10 SmartPlant Electrical Installation and Upgrade Guide


Welcome to SmartPlant

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 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 Electrical Installation and Upgrade Guide 11


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.

12 SmartPlant Electrical Installation and Upgrade Guide


SECTION 2

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 Electrical Installation and Upgrade Guide 13


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 SQL Server databases must have the same collation setting and reflect the “master”
language. Text is stored, sorted, indexed, and presented based on the collation setting. You
must determine which language will be used primarily to generate output (P&IDs, SLDs,
reports, approval documents, and so forth.) If Russian and English text is entered, and
Russian is the target locale, the chosen collation should be based on the Cyrillic character
set.
 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.

14 SmartPlant Electrical Installation and Upgrade Guide


Internationalization

Citrix XenApp Solutions for International Projects


Using Citrix XenApp Solutions, you can define environments that isolate users from having to
interact with non-native language operating systems while improving data integrity and
minimizing opportunities for data corruption. However, users still have to enter data using
master locale conventions for the project (decimal separator and date conventions, for
example). You can create these environments using different combinations of languages, but
some limitations exist. For example, you cannot use Russian and Chinese text together in a
project. In addition, special language characters (the German ä and ß for example) cannot be
used if the master locale is outside the western Latin-based languages (the master locale is
Russian, Chinese, Japanese, or Korean for example).

Questions and Assistance


Please contact your support representative for assistance and answers to your questions: see
Intergraph Customer Support (http://support.intergraph.com/).

SmartPlant Electrical Installation and Upgrade Guide 15


Internationalization

16 SmartPlant Electrical Installation and Upgrade Guide


SECTION 3

Hardware and Software


Recommendations
Before beginning an installation of the SmartPlant software, verify that your servers meet the
requirements in this section.
We recommend that you do not install the SmartPlant software on the database server.

SmartPlant Electrical Database Server


Hardware Recommendations
SmartPlant Electrical testing is done on computers having a 2.4 GHz processor and 4 GB of
RAM. For additional details regarding platform support, please review the latest compatibility
matrix available on Intergraph SmartSupport (http://smartsupport.intergraph.com). If you cannot
access the compatibility matrix, contact Intergraph Support (http://support.intergraph.com/).

Supported Operating Systems


 Microsoft Windows Standard Server 2008 R2 Service Pack 1, 64-bit
 Microsoft Windows Enterprise Server 2008 R2 Service Pack 1, 64-bit

Supported Database Servers


 Microsoft SQL Server 2012, 64 bit
 Oracle Database 11g Release 2 (11.2.0.4), 64-bit (Standard or Enterprise)

Recommended Disk Space


Oracle Software SQL Server Software SmartPlant Electrical Software

Oracle Server 2.0 GB SQL Server 1.0 GB Initial SmartPlant Electrical 0.25 GB
installation Server database
installation

Initial Oracle 0.5 GB SQL Server 0.1 GB


instance Temporary
database

Total: 2.5 GB Total: 1.1 GB Total: 0.25 GB

SmartPlant Electrical Installation and Upgrade Guide 17


Hardware and Software Recommendations

SmartPlant Electrical Workstation


Hardware Recommendations
SmartPlant Electrical testing is done on computers having a 2.4 GHz processor and 4 GB of
RAM. For additional details regarding platform support, please review the latest compatibility
matrix available on Intergraph SmartSupport (http://smartsupport.intergraph.com). If you cannot
access the compatibility matrix, contact Intergraph Support (http://support.intergraph.com/).

Supported Operating Systems


 Microsoft Windows 7 Professional and Enterprise Service Pack 1, 32-bit and 64-bit
SmartPlant Electrical is certified on Windows 7 with UAC ‘On’ at Level 3 (Default)

Supported Database Clients


 Oracle 11g Client Release 2 (11.2.0.2), 32-bit

 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.
For SQL Server, no client installation is required.

Recommended Disk Space

Software Prerequisites
 PDF reader (required for viewing the printable guides)
 SmartPlant License Manager 2012. The licensing is delivered on its own CD that comes
with your SmartPlant Electrical product CD
 .NET Framework 4.5
 Microsoft Internet Explorer 64-bit 9 or 10 (required for viewing the Online documentation
delivered with the software)
 Microsoft Excel (32-bit only) from Office 2010 Service Pack 1 or Office 2013 Service Pack 1
(Microsoft Excel is required for working with report templates and for viewing the Installation
Checklist and various other files)
 Microsoft XML Core Services (MSXML) 6.0 Service Pack 1

18 SmartPlant Electrical Installation and Upgrade Guide


Hardware and Software Recommendations

Optional Software
Apart from SmartSketch and SmartPlant Engineering Manager, 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
the customer desires to use to generate reports and Intergraph makes no recommendation as to
the choice of said third party software. The 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 administrative functions, SmartPlant Engineering Manager 2014 R1
 For working in a Citrix environment, Citrix XenDesktop 7.0 RDS on Windows Server 2008
R2 Service Pack 1, 64-bit
 ETAP electrical power systems design and analysis software - version 12.6 and 14
 One of the following drawing software programs:
 SmartSketch 2014
 Autodesk AutoCAD 2014
 Bentley MicroStation J (not certified on Vista, Windows 7, or on a 64-bit machine)

SmartPlant Electrical Installation and Upgrade Guide 19


Hardware and Software Recommendations

20 SmartPlant Electrical Installation and Upgrade Guide


SECTION 4

Before You Install


Before you begin installing the software, verify that the computers on which the software
components will be installed meet the requirements described in the Hardware and Software
Recommendations (on page 17).

Loading SmartPlant Electrical Prerequisite Software


Install any required prerequisite software which is not yet installed on your computer. The
following software is required:
 SmartPlant License Manager.
 Microsoft .Net Framework 4.5. If working on an Oracle platform, you must install .Net
Framework 4.0 before installing Oracle client. For details, see Installing Oracle Client >
Prerequisites.
 Microsoft Office. (Microsoft Excel is required for working with report templates, importing
and generating reports, importing from SmartSketch, and for viewing the Installation
Checklist and various other files.)

 Requirements may vary depending on your particular configuration.


 If .Net Framework is not installed or if .Net 4.0 client profile is installed, the software prompts
you to install Microsoft .Net Framework 4.5; after installation, the Welcome page of the
setup appears. If .Net 4.0 Extended (FULL) is installed, the SmartPlant Electrical installation
installs Microsoft .Net Framework 4.5 as part of the software setup.
 For details of the specific software versions that are compatible with your product and
working environment, see SmartPlant Electrical Workstation.

SmartPlant Electrical Installation and Upgrade Guide 21


Before You Install

Using Environment Variables for Tracking Licensing


If you are using SmartPlant License Manager 2010, SmartPlant License Manager 2012, or a
later version, an administrator can create environment variables to customize license tracking.
These variables match the columns in the SmartPlant License Manager logging file (or journal
report). The variable name must exactly match the column name.
The environment variables can be added and changed using automated scripts, custom product
launching utilities, or manually (as shown in the below example). The environment variables can
be defined at the system level or user level. If the environment variable(s) is added at both the
system and user levels, the user level will take precedence over variable(s) added at the System
level.
Any of the following variables can be defined as needed.
ProjectName - Defines the project name. There is a maximum of 50 characters.
NodeName - Defines the node name. There is a maximum of 30 characters.
UserNameEx - Defines the user name. There is a maximum of 50 characters.
Please contact your support representative if you need assistance.

Add an Environment Variable


The following steps are an example of how to manually add new environment variables.
1. Open Control Panel.
2. Click System Properties and select the Advanced tab.
3. Click Environment Variables....
4. Click New User Variable. Define the new variable name and value.

5. Click OK to add the variable.

22 SmartPlant Electrical Installation and Upgrade Guide


SECTION 5

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. Consult your Oracle software
documentation for information as to which versions of Oracle database can be used with which
versions of the Windows operating system.
For specific questions about Oracle configurations, please contact Intergraph Smart Support
(http://smartsupport.intergraph.com).

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 in 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 places 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.
 Path names for tablespaces in Oracle 11g must be no greater than 60 characters.
 Oracle recommends that database activity on the database server should consume no more
than 50 percent of the available memory.

SmartPlant Electrical Installation and Upgrade Guide 23


Oracle Installation and Configuration

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 SmartPlant Electrical 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 Install Oracle Database Server (on
page 25) and Install Oracle Client (on page 33), the Oracle Networking Components should be
configured correctly.

 For SmartPlant Electrical 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 Work Process


The following work process is necessary for installing Oracle for use with SmartPlant Electrical.
 Installing Oracle Database Server (on page 25)
 Create an Oracle Listener (on page 26)
 Creating an Oracle Instance (on page 26)
 Installing Oracle Client (on page 32)
Depending on which version of Oracle you are using and on the operating system installed on
your machine there may be differences in the required work process. Consult your Oracle
software documentation for information as to which versions of Oracle database can be used
with which versions of the Windows operating system.
For specific questions about Oracle configurations, please contact Intergraph Smart Support
(http://smartsupport.intergraph.com).

24 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

Installing Oracle Database Server


You must log in to your machine locally using Administrator rights.
The following editions of Oracle Database Server are available:
 Standard Edition — For department or workgroup level applications, or for
small-to-medium sized enterprises (SMEs). It is engineered to provide core relational
database management services and options. If you select this installation type, you must
purchase additional licenses if you want to install extra Enterprise Edition options.
 Enterprise Edition — For enterprise-level applications. It is engineered for mission-critical,
high-security online transaction processing (OLTP) and data warehousing environments. If
you select this installation type, all separately licensable Enterprise Edition options are
installed.
You should refer to your Oracle Installation Guide for detailed instructions on installing Oracle.

Install Oracle Database Server


1. Double-click the Oracle setup icon.
2. On the Configure Security Updates page, enter the desired values and click Next.
3. On the Download Software Updates page, enter the desired values and click Next.
4. On the Select Installation Option page, select Install database software only and click
Next.
5. On the Grid Installation Options page, select Single instance database installation and
click Next.
6. On the Select Product Languages page, select the desired languages in which your
product will run and click Next.
7. On the Select Database Edition page, select Enterprise Edition or Standard Edition and
click Next.
Do not select Personal Edition or Standard Edition One. SmartPlant Electrical
does not support these installation types.
8. On the Specify Installation Location page, specify the locations for the Oracle Base and
for the software location and click Next.
9. On the Summary page, click Install.
10. On completion of the installation, click Close.
11. Restart the server machine.
12. Install the latest Oracle patch, if appropriate.

SmartPlant Electrical Installation and Upgrade Guide 25


Oracle Installation and Configuration

Create an Oracle Listener


It is recommended to create the Oracle listener using Port 1522.
1. On the Start menu, click All Programs, locate the Oracle folder and start the Net
Configuration Assistant.
2. In the Oracle New Configuration Assistant Wizard, select Listener configuration and
click Next.
3. Select Add and then click Next.
4. Define the listener name, for example, LISTENER and click Next.
5. On the Listener Configuration, Select Protocols page, select TCP and click Next.
6. 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 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 SmartPlant
Electrical on Oracle. This way you can append the SmartPlant Electrical database to existing
Oracle databases on your Oracle database server without losing your existing Oracle database
information.
You can create as many instances as required and, in 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 SmartPlant Electrical database
located on that server.
For additional information about limitations on creation of instances, see your Oracle User
Guide.

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 'Version' folder name is 10.2.0)
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

26 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

 Oracle instance after initializing a domain — 150 MB recommended


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 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, locate the Oracle folder and under Configuration
and Migration Tools, start the Database Configuration Assistant.
2. On the Welcome page, click Next.
3. On the Step 1 of 12: Operations page, select Create a Database.
4. On the Step 2 of 12: Database Templates page, select Custom Database and click Next.
5. On the Step 3 of 12: Database Identification page, do the following:
a. In the Global Database Name box, define the database name, for example,
SPEL11gdb.
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.
6. Click Next.
7. On the Step 4 of 12: Management Options page, clear the Configure Enterprise
Manager check box and click Next.

SmartPlant Electrical Installation and Upgrade Guide 27


Oracle Installation and Configuration

8. On the Step 5 of 12: Database Credentials page, in the Password and Confirm
Password boxes, type the password, for example, Oracle11 and then click Next.
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).
9. On the Step 6 of 12: Database File Locations page, 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.
10. On the Step 7 of 12: Recovery Configuration page, clear the Specify Fast Recovery
Data check box and click Next.
11. On the Step 8 of 12: Database Content page, 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, select No scripts to run.
e. Click Next.
12. On the Step 9 of 11: Initialization Parameters page, select the Memory tab and select
Typical.
Ensure that the memory size does not exceed 40% of total server memory.

28 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

13. Select the Character Sets tab and do the following:


a. Under Database Character Set, select Use Unicode (AL32UTF8).
b. 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.

SmartPlant Electrical Installation and Upgrade Guide 29


Oracle Installation and Configuration

a. Click All Initialization Parameters.

b. Click Show Advanced Parameters.


c. On the All Initialization Parameters dialog box, in the Name column, locate
sec_case_sensitive_logon.
d. For the Value of the sec_case_sensitive_logon, type FALSE over the existing value
TRUE and check the Override Default column.

30 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

This creates an instance that is not case sensitive as SmartPlant Electrical


cannot connect to instances that are case sensitive. Checking Override Default allows
you to skip this procedure when creating more instances.

e. Click Close.
14. Click Next to go to the Step 10 of 11: Database Storage page, and click Next again.
15. On the Step 11 of 11: Creation Options page, click Finish.
16. Restart the server machine.

SmartPlant Electrical Installation and Upgrade Guide 31


Oracle Installation and Configuration

Oracle System User Requirements


In order to work successfully with SmartPlant Engineering Manager and SmartPlant Electrical,
the following minimum Oracle system user privileges need to be defined.

Default System User Privileges


GRANT ALTER SESSION TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE CLUSTER TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE DATABASE LINK TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE SEQUENCE TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE SESSION TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE TABLE TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE VIEW TO SYS ADMIN USER WITH ADMIN OPTION;
GRANT CREATE SYNONYM TO SYS ADMIN USER WITH ADMIN OPTION;

Installing Oracle Client


The Oracle client provides SmartPlant Electrical with the means to interface with the Oracle
database server. 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 SmartPlant
Electrical. Before you start the installation process, make sure that the machine (file server or
local station) has access to a CD-ROM or DVD drive. If your machine does not have access to
a suitable drive, you need to copy all the installation files from the installation media to your local
hard disk.

32 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

Prerequisites
 Make sure that a compatible Oracle server version is installed.
 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 Client


1. Start the Oracle Universal Installer.
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. Click Next.
4. On the Download Software Updates page, select Skip software updates and click Next.
5. On the Select Product Languages page, select English and click Next.
6. On the Specify Installation Location page, click the Browse button next to the Oracle
Base field and locate where you want to install the software.
The Software Location field is updated according to the information in the Oracle
Base field. if you want to change this location use the Browse button to navigate to the
required location.
7. Click Next.
8. On the Perform Prerequisite Checks page, click Next.
9. On the Summary page, click Install.
10. On the Finish page, on completion of the installation, click Close.
11. Restart the client machine.
12. 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.
13. If required, install the appropriate Oracle client patch.

SmartPlant Electrical Installation and Upgrade Guide 33


Oracle Installation and Configuration

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.

34 SmartPlant Electrical Installation and Upgrade Guide


Oracle Installation and Configuration

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
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.)

SmartPlant Electrical Installation and Upgrade Guide 35


Oracle Installation and Configuration

36 SmartPlant Electrical Installation and Upgrade Guide


SECTION 6

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.
Because system configurations, database software, and individual company standards vary, use
this section as a checklist instead of step-by-step instructions. For specific configuration
questions, contact Intergraph Customer Support (http://support.intergraph.com/).
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.

 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. Database node names may not include periods (.) or
spaces.
 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.
 When creating a database for SmartPlant Engineering Manager, the database name may
not include periods (.) or spaces.
 Create Microsoft SQL Server databases with locale-specific collation settings and ensure
that all interacting databases have the same collation settings.

SmartPlant Electrical Installation and Upgrade Guide 37


Microsoft SQL Server Installation and Configuration

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.

 SQLServer (MSSQLServer) is the default instance for SQL Server.


 In place of the default instance, you can use a named instance, for example:
SQLServer (Schematics).
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.

Install SQL Server 2005


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.

38 SmartPlant Electrical Installation and Upgrade Guide


Microsoft SQL Server Installation and Configuration

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.

Install SQL Server Database Server


Prior to installing SQL Server, you must previously have installed:
 Microsoft .Net Framework.
 Windows Installer.

1. Start SQL Server Setup.


2. On the SQL Server Installation Center wizard:
a. In the left pane, click Installation.
b. In the right pane, click New SQL Server stand-alone installation or add features to
an existing installation (for 2008 setup) / New installation or add features to an
existing installation (for 2012 setup).
3. On the Setup Support Rules page, when the rule checking completes, click OK.
In SQL Server 2012 setup, if prompted for product updates, click Next to continue.
4. On the Product Key page, select Enter the product key and type the product key, then
click Next.
5. On the License Terms page, select the I accept the license terms check box and click
Next.
6. On the Setup Role page, select SQL Server Feature Installation (2012 setup).
7. On the Setup Support Files page, click Install.
8. On the Setup Support Rules page, when the rule checking completes, click Next.
9. On the Setup Role page, select SQL Server Feature Installation (2008 setup).

SmartPlant Electrical Installation and Upgrade Guide 39


Microsoft SQL Server Installation and Configuration

10. On the Feature Selection page, do the following;


a. Select specific features as desired or click Select All.
b. Accept the default path for Shared feature directory or define another path.
c. Click Next.
11. On the Installation Rules page, when the rule checking completes, click Next.
12. On the Instance Configuration page, select Default instance and click Next.
13. On the Disk Space Requirements page, click Next.
If available disk space for the selected Instance root directory path is insufficient,
you will only be able to click Back and choose a different disk.
14. On the Server Configuration page, click the Service Accounts tab and do one of the
following:
 For 2012 setup, accept the default values.
 For 2008 setup, set the values for the services shown according to the values in the
table (the default values can be left for any other services).

Service Account Name Startup Type

SQL Server Agent NT AUTHORITY\SYSTEM Manual

SQL Server NT AUTHORITY\SYSTEM Automatic


Database Engine

SQL Server Browser NT AUTHORITY\LOCAL SYSTEM Automatic (for connection


ACCOUNT to remote), else Disabled

15. Click the Collation tab. If the national environment of the client machines is identical with
the national environment defined for the server, just accept the default values, otherwise,
define the settings for both Database Engine and Analysis Services as follows:
a. Click Customize.
b. Ensure that Windows collation designator and sort order is selected.
c. From the list, select the appropriate Collation 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.
d. Ensure that the Case-sensitive check box is cleared.
e. Click OK.
16. Click Next.

40 SmartPlant Electrical Installation and Upgrade Guide


Microsoft SQL Server Installation and Configuration

17. On the Database Engine Configuration page, select the first tab (named Account
Provisioning in 2008 setup or Server Configuration in 2012 setup) and under
Authentication Mode, do the following:
a. Select Mixed Mode.
b. Define the SQL Server system administrator account password as desired in the Enter
password box.
c. Re-enter the same password in the Confirm password box.
d. Under Specify SQL Server administrators define at least one network user as system
administrator by clicking either Add Current User or Add and selecting an existing
network user.
e. Click Next.
18. On subsequent pages, add a network user where required and click Next, or just click Next.
19. When you reach the Ready to Install page, review the list of components to be installed
and click Install.
20. On the Installation Progress page, once setup process is complete, click Next.
21. After clicking Close, restart the server machine.

Configure SQL Server 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 2008 / 2012 > SQL Server Management
Studio.
2. On the Connect to Server dialog box, enter the required information as follows:
a. Beside Server type, select Database Engine.
b. Beside Server name, select the name of your server or instance.
c. Beside Authentication, select SQL Server Authentication.
d. Type a login name.
e. Type a strong password of a least 6 characters; this is a password that must include
upper- and lower-case characters, numeric and non-alphanumeric characters.
Passwords are case-sensitive.
3. Click Connect.

SmartPlant Electrical Installation and Upgrade Guide 41


Microsoft SQL Server Installation and Configuration

4. 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.

5. For SQL Server 2008 only, 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.
 For SQL Server 2012, memory allocation is set automatically.
6. Select the Database Settings page and change the value of Default index fill factor to 80.

42 SmartPlant Electrical Installation and Upgrade Guide


Microsoft SQL Server Installation and Configuration

Set Database Maintenance Options for SQL Server


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.

Run DBCC Utility Options for SQL Server


1. Click Start > Programs > Microsoft SQL Server 2008 / 2012 > SQL Server Management
Studio.
2. Connect to the server.
3. 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.
4. Type the appropriate query using the syntax shown, for example:
DBCC CHECKCATALOG ('Site_Server1_DB')

 You must enclose the name of your database within quotes and parentheses as shown.
 Identical syntax applies for the CHECKDB command.
5. Click Query > Execute.
6. 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


1. Click Start > Programs > Microsoft SQL Server 2008 / 2012 > SQL Server Management
Studio.
2. Connect to the server.
3. 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.
4. 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.

SmartPlant Electrical Installation and Upgrade Guide 43


Microsoft SQL Server Installation and Configuration

44 SmartPlant Electrical Installation and Upgrade Guide


SECTION 7

Installing the Software


This section describes how to install SmartPlant Electrical 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 the Hardware and Software Recommendations (on
page 17).
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
Electrical and its related managers on a different workstation, and the reference data on yet
another workstation or file server.

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.

Installing .NET Framework in a 64-bit Environment


It is strongly recommended that you install the Microsoft application .NET 3.5 SP1 Accumulative
Framework version (KB951847 SP).
You should remove all previous versions of the .NET Framework using the Add/Remove
programs function and then install the new version using Microsoft’s upgrade feature.

SmartPlant Electrical Installation and Upgrade Guide 45


Installing the Software

Grant Permissions to Write to a Registry Key


During the installation process, you may receive an error 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.
1. Click Start > Run.
2. Type regedit.exe, and click OK.
3. In the left window, do one of the following:
 For a 32-bit machine, select the
HKEY_LOCAL_MACHINE\Software\Intergraph\Applications registry key.
 For a 64-bit machine, select the
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Intergraph\Applications
registry key.
4. Right-click and on the shortcut menu, click Permissions.
5. On the Permissions for Applications dialog box, click Advanced.
6. At the bottom of the Advanced Security Settings for Applications dialog box, clear the
option: Include inheritable permissions from this object's parent.
7. On the security dialog box that appears to verify your change, click Remove.
8. Reselect the Include inheritable permissions from this object's parent check box.
9. Select the Replace all child object permissions with inheritable permissions from this
object check box.

Uninstall a Previous Version of SmartPlant Electrical


1. In the Windows Control Panel, navigate to the Programs and Features window.
2. From the list of installed programs, select Intergraph SmartPlant Electrical (with the
appropriate version number) and then click Change.
3. On the Modify page of SmartPlant Electrical setup, click Modify.
4. On the Modify/Uninstall page, select Uninstall and click Next.
5. On completion of the uninstall process, click Finish.

46 SmartPlant Electrical Installation and Upgrade Guide


Installing the Software

Install SmartPlant Electrical


SmartPlant License Manager software is required for concurrent licensing for both
the core SmartPlant Electrical product and for each feature, therefore you must install and
configure SmartPlant License Manager on your workstation before installing SmartPlant
Electrical. This licensing software is delivered on its own media. For more information about
using and configuring concurrent licensing, refer to the SmartPlant License Manager Online
Help.
1. Insert the SmartPlant Electrical DVD into the drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. On the Welcome page, click Start Setup.
3. On the Details and Features page, enter your user name and company details if required.
By default, the user name and company name are obtained from the registry. You
can change the values, but you cannot leave these fields blank.
4. Under Select Features to Install, select the check boxes beside the products you want to
install:
 SmartPlant Electrical (mandatory)
 Import Manager
 SAP Wizard
5. Ensure that the SmartPlant Electrical section is expanded and do the following:
a. In the Install Path field, accept the default installation path or if desired, specify a
different path.
b. In the Serial Number field, type your product serial number.
c. Under Optional Features, select the check boxes beside the additional features that
you want to install.
The SmartPlant Electrical program is always installed, regardless of any other
features you select.
6. If selected, expand the Import Manager and SAP Wizard sections and type the product
serial number for each item that you require.
7. Click Next.
8. On the License Agreement page, select your country or region from the list to view the
license agreement in your language and then select the I agree to the license agreement
and conditions check box.
9. Click Install.
10. On completion of the installation, if you want to open the Readme file, select View Readme.

SmartPlant Electrical Installation and Upgrade Guide 47


Installing the Software

11. Click Finish to close the installation wizard.

 If you try to install SmartPlant Electrical software when you do not have write permissions to
the registry on the computer on which you are installing, a warning message appears. For
details of what to do if you see this message, see Grant Permissions to Write to a Registry
Key (on page 46).
 The driver used for printing the PDF files, SmartPlant PDF Converter (Amyuni 4.5), is
included in the SmartPlant Electrical installation. This printer is used for PDF generation and
should not be removed or used for any other purpose. If you are unable to generate PDF
files because this driver is missing, restore the driver by running the executable file
InstallPDFConverter.exe, which is installed by default in the software installation folder path
..\SmartPlant\Electrical\Program\.
 If you installed SmartPlant Electrical API Programming Help, it is available in the Help of
Visual Studio 2012 or Visual Studio 2013.

Install Additional Software


You can install additional software if needed.
1. Insert the SmartPlant Electrical DVD into the drive. If the installation does not start
automatically, double-click setup.exe in the main folder.
2. On the Welcome page, click Additional Software.
if you have already installed Smartplant Electrical, start the process from the
Programs and Features on the Control Panel of your Windows. Select Intergraph
SmartPlant Electrical and click Change. Then click Additional Software on the Modify
page of the setup.
3. On the Additional Software page, click one of the available options. The following
additional software is available:
 SmartPlant Electrical Reference Data (for more information, see Install SmartPlant
Electrical Reference Data (on page 57).
 SmartPlant Electrical Document Viewer
 SmartPlant Engineering Manager
 SmartPlant Schema Component
 SmartPlant Client
4. Click Finish when done.

48 SmartPlant Electrical Installation and Upgrade Guide


Installing the Software

Modify or Uninstall the Latest Version of SmartPlant


Electrical
1. In the Windows Control Panel, navigate to the Programs and Features window.
2. From the list of installed programs, select Intergraph SmartPlant Electrical 2015 and then
click Change.
3. On the page that appears, click Modify.
4. On the Modify / Uninstall page, select one of the following options:
 Add or Remove Features
 Repair
 Uninstall
5. Click Next.
If you selected Repair or Uninstall, a wizard page opens with progress bars for the
overall process and individual details.
6. If you selected Add or Remove Features, under Select Features to Add or Remove, do
the following:
a. Select the check boxes beside those features that you want to add.
b. Clear the check boxes beside those features that you want to remove.
c. Click Update.
The Add or Remove Features option only adds or removes the additional features;
it does not remove SmartPlant Electrical.
7. On completion of the process, click Finish.

SmartPlant Electrical Installation and Upgrade Guide 49


Installing the Software

Installing SmartPlant Electrical in Silent Mode


Silent mode installation involves running a command at the command prompt with arguments
specifying the license activation, product serial number, and installation path. In addition, you
can specify which individual software features to install and the path of the log file.

 Because SmartPlant Electrical installation requires SmartPlant License Manager for


concurrent licensing, you must first install the SmartPlant License Manager software on your
workstation and on every other workstation where you are going to install SmartPlant
Electrical in silent mode. For more information about installing and configuring SmartPlant
License Manager, see the SmartPlant License Manager Online Help.
 You must ensure that there is sufficient disk space on each workstation for the installation.
 Prior to creating a silent setup of SmartPlant Electrical over a network, ensure that the
following conditions exist:
 For a new release, all previous existing versions of SmartPlant Electrical 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
Electrical is to be installed.
 The target machine meets the free disk space recommendations specified in SmartPlant
Electrical Workstation.
 All applications are closed.

50 SmartPlant Electrical Installation and Upgrade Guide


Installing the Software

Install SmartPlant Electrical in Silent Mode


 At each workstation on which you want to install the software, open a Command Prompt
window and type the silent installation command according to the following syntax:
"<setup source folder path>\setup.exe" /install /silent
InstallFolder="<path>" /log "<log file path and name>.log"
SLAACCEPT="YES" SERIALNUM="<product serial number>" ADDLOCAL="ALL"

Ensure that the command line includes spaces where shown before and after
arguments.

 Double quotes are required only if the path to the setup.exe file contains spaces.
 Argument values are case sensitive.
Mandatory arguments are validated by the setup procedure. If an argument or option is
missing, the setup stops and a log is produced with the name of the missing argument.

Example command line for SmartPlant Electrical installation:


"\\SPELInstall\Setup Files\Setup.exe" /install /silent
InstallFolder="C:\Program Files (x86)\SmartPlant" /log" C:\Setup.log"
SLAACCEPT="YES" SERIALNUM="012345678" ADDLOCAL="ALL"
Pause

Command Line Arguments


Argument Description Mandatory Notes

<setup source The path to the file that Yes


folder path> launches the setup

setup.exe The name of the file that Yes


launches the setup

-install Install product No

-uninstall Uninstall product No

-repair Repair product No

-modify Modify product features No

SmartPlant Electrical Installation and Upgrade Guide 51


Installing the Software

Argument Description Mandatory Notes

-s, -silent Silent mode Yes This argument is required for


silent mode installation, together
with the mandatory custom
command line arguments;
otherwise, the installation user
interface is displayed.

-l, -log Specifies a log file No If the log argument is used, a


valid file path and name must be
specified.

InstallFolder Specifies the installation No The default installation folder


folder should be set in bundle.wxs. If no
value is specified, the default
installation folder path is:
"C:\Program Files
(x86)\SmartPlant\".

SLAACCEPT Approve license Yes Accepted value: YES


agreement

SERIALNUM Sets the serial number to Yes A valid serial number


be used for installation

USERNAME Sets the user name See 'Notes' This argument is mandatory for
an Evaluation Mode installation

COMPANYNAME Sets the company name See 'Notes' This argument is mandatory for
an Evaluation Mode installation

ADDLOCAL The value of the No For use with the /install and
ADDLOCAL argument is a /modify arguments.
list of features that are to
Accepted values:
be installed locally. If the
ADDLOCAL argument is  ALL — installs all available
not present in the features
command line, the
software installs features  Specified list of features
delimited by commas. The
according to the default
features must be present in
settings (for details, see
the Feature column of the
the Notes below).
Feature table. The features
available for this product are
listed in the Notes below.

52 SmartPlant Electrical Installation and Upgrade Guide


Installing the Software

Argument Description Mandatory Notes

REMOVE The value of the REMOVE No For use with the /modify
argument is a list of argument.
features that are to be
Accepted values:
removed or excluded when
modifying an installation.  ALL — removes or excludes
from the installation all
features, including the main
application
 Specified list of features
delimited by commas. The
features must be present in
the Feature column of the
Feature table. The features
available for this product are
listed in the Notes below.

 Command line arguments and their values are case-sensitive; therefore you must ensure
that they are typed exactly as shown in the above table.
 Each command line argument must be preceded by a '-' or '/' delimiter, for example:
-install - silent or /install / silent
 If none of the arguments: install, uninstall, repair, or update is specified, install is
assumed as the default.
 SmartPlant Electrical is always installed. You can use the following ADDLOCAL / REMOVE
arguments (case-sensitive) for installing or removing specific features:

Feature Argument Value Notes

SmartPlant Electrical SPEL These features are always installed


regardless of whether this argument is
specified for ADDLOCAL. To install
these features alone, use the syntax
ADDLOCAL = "SPEL".
When using the syntax REMOVE =
"SPEL", all software features are
uninstalled.

Options Manager OPTIONSMGR This feature is not installed by default if


ADDLOCAL is not present in the
command line

SmartPlant Electrical Installation and Upgrade Guide 53


Installing the Software

Feature Argument Value Notes

Import Manager IMPORTMGR This feature is not installed by default if


ADDLOCAL is not present in the
command line

Rule Manager RULEMGR This feature is not installed by default if


ADDLOCAL is not present in the
command line

SmartPlant Electrical SPELDOCSERVICE This feature is not installed by default if


Document Service ADDLOCAL is not present in the
command line

To install specific features, use the syntax: ADDLOCAL="FEATURE1,FEATURE2", for


example: ADDLOCAL="OPTIONSMGR,RULEMGR". To skip or remove specific features, use
the syntax: REMOVE="FEATURE1,FEATURE2", for example: REMOVE="IMPORTMGR".
 When including the /modify argument, if a feature is not included in the ADDLOCAL or
REMOVE arguments, that feature remains unmodified; if it was not initially installed, it will
not be subsequently added, and if it was initially installed, it will not be removed.
 After a successful installation, you may be required to restart the computer.
 If a mandatory parameter or value is missing or the value is incorrect, the installation will
stop and an error will be recorded in the log file. It is recommended that after installation, you
check the .log file to ensure that the installation proceeded without errors. If the silent
installation was successful, at the end of the .log file, the following string appears:
Exit code: 0x0

54 SmartPlant Electrical Installation and Upgrade Guide


Installing the Software

Silent Mode Example Scripts

 These examples show the use of either '/' or '-' as argument delimiters.
 The 'Pause' command is optional and is used to display completion of the process in the
Command Prompt window.
 A value of '%tmp%' for the log file path can be used to write the log file to the active user's
local 'Temp' folder.

Install All Features


"\\SmartPlant Electrical\Setup Files\Setup.exe" /install /silent
InstallFolder="C:\Program Files (x86)\SmartPlant" /log "C:\Install.log"
SLAACCEPT="YES" SERIALNUM="012345678" ADDLOCAL="ALL"
Pause

Install Specific Features


"\\SmartPlant Electrical\Setup Files\Setup.exe" -install -silent
InstallFolder="C:\Program Files (x86)\SmartPlant" -log "%tmp%\Install
Part.log" SLAACCEPT="YES" SERIALNUM="012345678"
ADDLOCAL="OPTIONSMGR,RULEMGR"
Pause

Uninstall the Product


"\\SmartPlant Electrical\Setup Files\Setup.exe" -uninstall -silent -log
"C:\Uninstall.log"
Pause

Repair the Product


"\\SmartPlant Electrical\Setup Files\Setup.exe" -repair -silent -log
"C:\Repair.log"
Pause

Modify Product Features


"\\SmartPlant Electrical\Setup Files\Setup.exe" /modify /silent /log
"C:\Update Features.log" ADDLOCAL="OPTIONSMGR" REMOVE="RULEMGR"
Pause

SmartPlant Electrical Installation and Upgrade Guide 55


SECTION 1

Configuring Reference Data for


SmartPlant Electrical
SmartPlant Reference Data for SmartPlant Electrical contains the symbols, data dictionary, filters, and
other information that you use to create and manage electrical engineering data. The default location for
the reference data is ..\SmartPlant\Electrical Reference Data.
With SmartPlant Electrical Options Manager, you can identify the location of symbols, drawing and report
templates, as well as other reference data. You can also define naming conventions, default preferences,
formats for data, item type parameters, and various general settings (for example settings used for cable
sizing calculations). 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, see the SmartPlant Electrical Options Manager documentation.
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
Electrical Reference Data.

Install SmartPlant Electrical Reference Data


1. Insert the SmartPlant Electrical DVD into the drive. If the installation does not start automatically,
double-click setup.exe in the main folder.
2. On the Welcome page, click the Additional Software link.
3. On the Additional Software page, click Reference Data for SmartPlant Electrical Installation.
4. On the SmartPlant Electrical Reference Data Setup Wizard Welcome page, click Start Setup to start
the reference data setup wizard.
5. On the Details and Features page, under Select Features to Install, make sure that the SmartPlant
Electrical Reference Data check box is selected.
6. In the Install Path field, accept the default installation path or if desired, specify a different path, and
then click Next.
7. On the License Agreement page, select your country or region from the list to view the license
agreement in your language and then select the I agree to the license agreement and conditions
check box.
8. Click Install.
Configuring Reference Data for SmartPlant Electrical

9. On completion of the installation, if you want to open the Readme file, select View Readme.
10. Click Finish to close the installation wizard.
11. After installation, do the following:
a. 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.
b. Ensure that the SmartPlant Resource Path setting in Options Manager points to this
folder.
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.

58 SmartPlant Electrical Installation and Upgrade Guide


SECTION 9

Working in Thin Client Mode


You can use SmartPlant Electrical in thin client mode, which supports Citrix.

 When you access the SmartPlant Electrical 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 types
of administration activities are: upgrading the database to a new version, importing data
using Import Manager, or importing reference data using Options Manager.
As a workaround, we recommend that you perform these kinds 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.
In a Citrix environment, links within a .chm file to open a web browser will not work. To
view the linked web page, copy and paste the web address into the web browser on your local
machine.

Tuning the Software for Use in Thin Client Mode


The following procedures describe special instructions for the installation of SmartPlant
Electrical when working in thin client mode on a Citrix machine. Tuning SmartPlant Electrical
involves performing the following operations:
 Installing SmartPlant Electrical on Citrix.
 Creating Global Objects.
 Publishing the SmartPlant Electrical program to enable it to be viewed on a web page or in a
published Citrix application list.

SmartPlant Electrical Installation and Upgrade Guide 59


Working in Thin Client Mode

Create Global Objects


In order to run SmartPlant Electrical via Citrix using Oracle, users or groups that will be using
SmartPlant Electrical are required to be included in the "Create Global Objects" policy security
setting.
1. In Windows, open Control Panel.
2. Click Administrative Tools.
3. Double-click the Local Security Policy icon.
4. In the left pane of the window that opens, expand the hierarchy Local Policies > User
Rights Assignment.
5. In the right pane, double-click Create global objects.
6. On the Create global objects Properties dialog box, click Add User or Group.
7. On the dialog box that opens, add the users or groups that will be using SmartPlant
Electrical.

Publish the SmartPlant Application using Citrix


Presentation Server
You need to publish the application to allow you to view the data using a web page.
You must perform this procedure for each executable file for which you want to
view data; for example, the SmartPlant Electrical program.
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 Electrical,
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 Electrical
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.

60 SmartPlant Electrical Installation and Upgrade Guide


Working in Thin Client Mode

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 Electrical application,
right-click, then click Create ICA File and follow the wizard instructions.
b. On the Citrix Management Console, select the SmartPlant Electrical application,
right-click, then click Create HTML File and follow the wizard instructions.

Publish SmartPlant Applications Using XenDesktop


7.0 RDS
You need to publish the application to allow you to view the data using a web page.
You must perform this procedure for each executable file for which you want to
view data; for example, the SmartPlant Electrical program.
1. Click Start > All Programs > Citrix > Citrix Studio.
2. In the left pane, click Delivery Groups and do one of the following:
 In the main window, click the Delivery Groups tab, select the groups, and in the
Actions pane at the right, click Create Application.
 In the main window, click the Applications tab and in the Actions pane at the right,
click Add Applications.

SmartPlant Electrical Installation and Upgrade Guide 61


Working in Thin Client Mode

3. On the Introduction wizard page, click Next.

62 SmartPlant Electrical Installation and Upgrade Guide


Working in Thin Client Mode

4. On the Applications page, select the check boxes beside the applications you want to add
and click Next.

SmartPlant Electrical Installation and Upgrade Guide 63


Working in Thin Client Mode

If you want to add an application from a location other than the local machine, click
Add applications manually and in the dialog box that opens, enter the required
information.

64 SmartPlant Electrical Installation and Upgrade Guide


Working in Thin Client Mode

5. On the Summary page, click Finish.

If successful, the application will appear under Applications.


6. Repeat the above steps for each application you want to publish.

SmartPlant Electrical Installation and Upgrade Guide 65


Working in Thin Client Mode

66 SmartPlant Electrical Installation and Upgrade Guide


SECTION 10

Upgrading to SmartPlant Electrical 2015


SmartPlant Engineering Upgrade Utility Version 2014 R1 upgrades the SmartPlant Electrical
database from Versions 2009 and 2009 SPx to Version 2015.

 For an Oracle platform, the version must be at least Oracle 11g; therefore, if you have an
older version of Oracle, you must upgrade it before upgrading SmartPlant Electrical to
Version 2015.
 If you are upgrading from a database version of SmartPlant Electrical earlier than 2009, you
must first upgrade that database version to SmartPlant Electrical 2009 using Version 2009 of
the Upgrade Utility (included with SmartPlant Engineering Manager 2009) before upgrading
to SmartPlant Electrical 2015. For more information, visit the Intergraph support Web site
(http://support.intergraph.com).
 SmartPlant Electrical database version 2015 is suitable only for SmartPlant Electrical
software version 2015.

Requirements Before Upgrading


 The tasks in this section must be performed before you begin upgrading your database.

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.

SmartPlant Electrical Installation and Upgrade Guide 67


Upgrading to SmartPlant Electrical 2015

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 True is the default setting. However, you should make sure
the setting was not previously changed to False.

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.

68 SmartPlant Electrical Installation and Upgrade Guide


Upgrading to SmartPlant Electrical 2015

Upgrading Sites, Plants, and Applications


You update your site if needed using SmartPlant Engineering Manager.
Before using the new version of the software, we strongly recommend that you
completely upgrade your plant and applications as described in this section. A plant with a
mixture of upgraded and non-upgraded data may result in some data being permanently
inaccessible.
You use the SmartPlant Engineering Manager Upgrade Utility to upgrade the plant and
application databases to the latest version of the SmartPlant software.
The following table is a compatibility matrix of the most recent software versions.

SmartPlant Engineering Manager SmartPlant P&ID SmartPlant Electrical

Version 2009 Version 2009 Version 2009

Version 2009 SP1 Version 2009 Version 2009 SP1

Version 2009 SP2 Version 2009 SP1 Version 2009 SP2

Version 2009 SP3 Version 2009 SP2 Version 2009 SP2 HF4

Version 2009 SP4 Version 2009 SP3 Version 2009 SP3

Version 2009 SP5 Version 2009 SP4 Version 2009 SP3, SP4

Version 2009 SP6 Version 2009 SP4, SP5 Version 2009 SP5

Version 2014 Version 2014 Version 2009 SP5

Version 2014 R1 Version 2014 R1 Version 2015

SmartPlant Electrical Installation and Upgrade Guide 69


Upgrading to SmartPlant Electrical 2015

Upgrade Requirements at Different Levels


The following table will help you to determine what to upgrade when working with SmartPlant
Engineering Manager 2014 R1.

Level Versions Requiring Upgrade

Site SmartPlant Engineering Manager versions earlier than 2009 SP3

Plant SmartPlant Engineering Manager versions earlier than 2009

Application  SmartPlant P&ID versions earlier than 2014


 SmartPlant Electrical versions earlier than 2015

 Before upgrading your plants, ensure that your site is up-to-date.


 You are not required to upgrade all plants in a particular site at the same time.
 If you are upgrading from a database version of SmartPlant P&ID or SmartPlant Electrical
earlier than 2009, you must first upgrade that database version to SmartPlant P&ID or
SmartPlant Electrical 2009 using Version 2009 of the Upgrade Utility before upgrading to the
current version of the application.

Upgrading Plants and Applications Containing Projects


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

Upgrade a Site
It is not necessary to upgrade your site if the site was created by SmartPlant
Engineering Manager 2009 SP3 or later.
 To upgrade a site, in SmartPlant Engineering Manager, click Tools > Upgrade Site.

Upgrade a Plant
It is not necessary to upgrade your plant if the plant was created by SmartPlant
Engineering Manager 2009 or later. If you have such a plant, the Upgrade Utility shows that your
plant is up-to-date and you can skip this procedure. For a plant created by a version of
SmartPlant Engineering Manager earlier than 2009, use SmartPlant Engineering Upgrade Utility
2009 to upgrade your plant to Version 2009 first (for details, refer to the 2009 version of the
SmartPlant P&ID Installation and Upgrade Guide or the 2009 version of the SmartPlant
Electrical Installation and Upgrade Guide).

70 SmartPlant Electrical Installation and Upgrade Guide


Upgrading to SmartPlant Electrical 2015

Upgrade SmartPlant Electrical


1. Select the plant in the Active Plants node, right-click and on the shortcut menu, click
Upgrade Electrical.

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 SmartPlant Electrical
application.

2. Right-click in either pane and on the shortcut menu, click Finish All Tasks to start the
upgrade process for the application.

SmartPlant Electrical Installation and Upgrade Guide 71


Upgrading to SmartPlant Electrical 2015

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 pane to Up-to-date.

Upgrade Plants with the Batch Upgrade Command


This procedure explains how to upgrade two or more plants and their associated applications at
the same time.
1. In the Plant to Upgrade pane select two or more plants that need to be upgraded.
2. Do one of the following:
 From the menu commands, click Upgrade > Batch Upgrade.
 Right-click and on the shortcut menu, click Batch Upgrade.
For a list of all changes made during the batch upgrade, including each upgrade sub-task
for each plant, see the batch upgrade log files. The log files are saved in the folder where the .ini
file resides.

72 SmartPlant Electrical Installation and Upgrade Guide


Upgrading to SmartPlant Electrical 2015

Upgrade Utility Commands


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 pane. 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 pane. 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 pane.
The Upgrade Utility records how far it progresses during an upgrade task so that it can
recover if system problems occur.

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 UpgradeV600_plant name.log, is saved in the folder where the plant
structure resides.

SmartPlant Electrical Installation and Upgrade Guide 73


Upgrading to SmartPlant Electrical 2015

Batch Upgrade Command


Allows you to upgrade two or more plants and their associated applications at the same time.
For a list of all changes made during the batch upgrade, see the batch upgrade log files.
The log files, named BatchUpgradeV600_site name.log and BatchUpgradeV600_Details_site
name.log, are saved in the folder where the .ini file resides.

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 All Tasks to 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.

 You must complete all upgrade tasks for a plant before you upgrade the reference data or
drawings in the plant.
 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 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.
See Also
Upgrade a Plant (on page 70)

Upgrade Electrical Command (Upgrade Menu)


Displays the upgrade tasks required for the SmartPlant Electrical application upgrade process.
Click File > Finish All Tasks to 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 application to the pre-upgrade state.
See Also
Upgrade SmartPlant Electrical (on page 71)

74 SmartPlant Electrical Installation and Upgrade Guide


Upgrading to SmartPlant Electrical 2015

Post-Upgrade Tasks
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.
Some or all of the following post-upgrade tasks may also be required:
 Backup Each Upgraded Plant (on page 75)
 Use Oracle Analyzer Scripts (on page 75)

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
of 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.

Upgrade Site Command (Tools Menu)


This command updates the site data dictionary version number to the latest version of the
software.

SmartPlant Electrical Installation and Upgrade Guide 75


SECTION 11

User Access
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.

 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
User rights can 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.

SmartPlant Electrical Installation and Upgrade Guide 77


User Access

SmartPlant Electrical User Rights


Category Options Description

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.

Plant Filters 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.

Plant Reports None None prevents users from viewing or 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.

Rules 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.

Data Dictionary None None prevents users from accessing the Tools >
(These settings affect Update Select List command.
the Update Select List
command.) Read-Only Read-Only prevents users from accessing the Tools
> Update Select List command.

Modify Select Modify Select Entry allows users to add and edit
Entry select lists on the Update Select List dialog box.

Full Control Full Control allows users to add and edit select lists
on the Update Select List dialog box.

78 SmartPlant Electrical Installation and Upgrade Guide


User Access

Category Options Description

Options None None prevents users from accessing Options


Manager.

Read-Only Read-Only allows users to view Options settings,


but not make any changes.

Modify Settings Modify Settings allows users to view Options


settings and make changes.

Full Control Full Control allows users to add options and edit
existing options.

Electrical Items Data None None prevents users from viewing or accessing
electrical equipment items in the Electrical Index.

Read-Only Read-Only allows users to view electrical equipment


items in the Electrical Index. Users are not allowed
to make any changes or create new electrical
equipment items in the Electrical Index.

Modify Settings Modify Settings allows users to create and edit


electrical equipment items in the Electrical Index.
Users are not allowed to delete electrical equipment
items in the Electrical Index.

Full Control Full Control allows users to create, modify, and


delete electrical equipment items in the Electrical
Index.

Power Distribution None None prevents users from viewing or accessing PDB
Boards and Internals items and their internals in the Electrical Index.
(Index)

Read-Only Read-Only allows users to view PDB items and their


internals in the Electrical Index. Users are not
allowed to make any changes or create new PDB
items or their internals in the Electrical Index.

Modify Settings Modify Settings allows users to create and edit


PDB items and their internals in the Electrical
Index. Users are not allowed to delete PDB items
and their internals in the Electrical Index.

Full Control Full Control allows users to create, modify, and


delete PDB items and their internals in the Electrical
Index.

SmartPlant Electrical Installation and Upgrade Guide 79


User Access

Category Options Description

Wiring Equipment None None prevents users from viewing or accessing


wiring equipment items in the Electrical Index.

Read-Only Read-Only allows users to view wiring equipment


items in the Electrical Index. Users are not allowed
to make any changes or create new wiring
equipment items in the Electrical Index.

Modify Settings Modify Settings allows users to create and edit


wiring equipment items in the Electrical Index.
Users are not allowed to delete wiring equipment
items in the Electrical Index.

Full Control Full Control allows users to create, modify, and


delete wiring equipment items in the Electrical
Index.

Cable Sizing None None prevents users from viewing sizing data and
performing cable sizing for single cables or multiple
cables in batch mode.

Read-Only Read-Only allows users to view cable sizing data on


the Sizing Data tab of the Cable Common
Properties dialog box and on the Batch Size
Cables dialog box.

Full Control Full Control allows users to perform cable sizing for
single cables on the Sizing Data tab of the Cable
Common Properties dialog box and on the Batch
Size Cables dialog box for multiple cables.

Cable Replace None None prevents users from replacing multiple cables
in batch mode.

Full Control Full Control allows users to replace multiple cables


in batch mode.

Single Line Diagram None None prevents users from viewing or generating
Drawings (Index) PDB-based single line diagrams.

Read-Only Read-Only allows users to open and view


PDB-based single line diagrams in the Electrical
Index. Users are not allowed to edit or generate new
PDB-based single line diagrams in the Electrical
Index.

80 SmartPlant Electrical Installation and Upgrade Guide


User Access

Category Options Description

Modify Settings Modify Settings allows users to generate, edit, and


save PDB-based single line diagrams in the
Electrical Index. Users are not allowed to delete
PDB-based single line diagrams in the Electrical
Index.

Full Control Full Control allows users to generate, modify, and


delete PDB-based single line diagrams in the
Electrical Index.

Single Line Diagram None None prevents users from viewing or generating
Generation single line diagrams from the Electrical Engineer.

Read-Only Read-Only allows users to open and view single line


diagrams from the Electrical Engineer. Users are
not allowed to edit or generate new single line
diagrams from the Electrical Engineer.

Modify Settings Modify Settings allows users to generate, edit, and


save single line diagrams from the Electrical
Engineer. Users are not allowed to delete single line
diagrams that were generated from the Electrical
Engineer.

Full Control Full Control allows users to generate, modify, and


delete single line diagrams that were generated from
the Electrical Engineer.

Redlining None None prevents users from turning on the redlining


feature.

Full Control Full Control allows users to turn on or off the


redlining feature.

Schematic Drawings None None prevents users from opening, viewing, or


(Index) generating any drawings from Documents folder in
the Electrical Index.

Read-Only Read-Only allows users to open and view the


drawings in the Documents folder of the Electrical
Index. Users are not allowed to edit or generate new
drawings from the Electrical Index.

Modify Settings Modify Settings allows users to open, edit, and


save the drawings in the Documents folder of the
Electrical Index. Users are not allowed to delete
any drawings from the Documents folder of the
Electrical Index.

SmartPlant Electrical Installation and Upgrade Guide 81


User Access

Category Options Description

Full Control Full Control allows users to generate, modify, and


delete the drawings from the Documents folder of
the Electrical Index.

Schematic Drawing None None prevents users from viewing or generating


Generation schematic drawings in the Electrical Index.

Read-Only Read-Only allows users to open and view schematic


drawings in the Electrical Index. Users are not
allowed to edit or generate new schematic drawings
in the Electrical Index.

Modify Settings Modify Settings allows users to generate, edit, and


save schematic drawings in the Electrical Index.
Users are not allowed to delete schematic drawings
in the Electrical Index.

Full Control Full Control allows users to generate, modify, and


delete schematic drawings in the Electrical Index.

Apply Options Profile Enables or disables the available Apply Options


features. Select the check box to enable an option;
Circuit
clear to disable.
Control Station
Lookup
Schematic
I/O Set

Association Among Items Select the check box to enable an option; clear to
disable. Enables or disables users to:
 Perform Batch Load Association.
 Use Parallel Equipment Assistant.
 Drag items in and to the Electrical Index and
Electrical Engineer.

External Enables or disables users to associate or dissociate


Documents external documents. Select the check box to enable
an option; clear to disable.

Reference Documents None None prevents users from defining a reference to a


document. Also, when associating a document,
users cannot .associate a document with a plant
item.

82 SmartPlant Electrical Installation and Upgrade Guide


User Access

Category Options Description

Read-Only Read-Only allows users to see the list of the


associated documents on the Define Document
Reference dialog box. Users are not allowed to
create a new reference or dissociate a document.

Modify Settings Modify Settings allows users to add new references


on the Define Document Reference dialog box but
not dissociate any documents from plant items.

Full Control Full Control allows users to add or remove a


reference to a document in the Define Document
Reference dialog box.

Templates None None prevents users from viewing SmartPlant


Electrical templates.

Read-Only Read-Only allows users to view template definitions,


but not make any changes.

Modify Settings Modify Settings allows users to edit existing


templates.

Full Control Full Control allows users to create new and edit
existing templates.

Reference Data None None prevents users from seeing any reference
Explorer - Cables cable items in the Reference Data Explorer.

Read-Only Read-Only allows users to see reference cable


items in the Reference Data Explorer and view
reference cable properties, but not make any
changes.

Modify Settings Modify Settings allows users to edit the properties


of existing reference cables. Users are not allowed
to create or delete reference cables.

Full Control Full Control allows users to create, edit, and delete
reference cables.

Reference Data None None prevents users from seeing any lookup table
Explorer - Lookup items in the Reference Data Explorer.
Tables
Read-Only Read-Only allows users to see lookup table items in
the Reference Data Explorer and view lookup table
properties, but not make any changes.

SmartPlant Electrical Installation and Upgrade Guide 83


User Access

Category Options Description

Modify Settings Modify Settings allows users to edit the properties


of existing reference lookup tables. Users are not
allowed to create or delete reference lookup tables.

Full Control Full Control allows users to create, edit, and delete
reference lookup tables.

Reference Data None None prevents users from seeing any equipment
Explorer - Other items in appropriate Reference Data Explorer
Categories folders.

Read-Only Read-Only allows users to see all reference


equipment items in appropriate Reference Data
Explorer folders and view the equipment items
properties, but not make any changes.

Modify Settings Modify Settings allows users to edit the properties


of existing reference equipment items. Users are not
allowed to create or delete reference equipment
items.

Full Control Full Control allows users to create, edit, and delete
reference equipment items.

Tabular Editor Layouts None Enables or disables the creation and management of
Tabular Editor layouts. Select the check box to
Full Control
enable an option; clear to disable.

Electrical Engineer None Controls access to the Electrical Engineer. For


example, Full Control access is required to copy
Full Control
items from Electrical Engineer from another plant.

Import Manager None Controls access to Import Manager. None prevents


users from opening Import Manager. Full Control
Full Control
allows users to open and work within Import
Manager.

SmartPlant Publish Enables or disables the ability to publish or retrieve


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

Registered Reports None None prevents users from registering internal


documents.

Read-Only Read-Only allows users only to open and view the


registered reports.

84 SmartPlant Electrical Installation and Upgrade Guide


User Access

Category Options Description

Modify Settings Modify Settings allows users to create and edit


registered reports using the Common Properties
dialog box, set revisions.

Full Control Full Control allows users to modify and delete


registered reports.

Project Management None Enables or disables the Project Management table in


(As-Built) As-Built.
Full Control

Project Management None Enables or disables the Project Management table in


(Projects) projects.
Full Control

Apply Naming Enable Enables or disables the ability to apply a naming


Convention convention to SmartPlant Electrical item tags. The
setting has no effect on the ability to define naming
conventions in Options Manager.

Wiring Diagrams None None prevents users from viewing wiring diagrams.

Read-Only Read-Only allows users to view wiring diagrams, but


not make any editing changes or revisions.

Modify Settings Modify Settings allows users to edit (place


equipment and terminal strips, cables and wires and
perform terminations), revise, and save existing
wiring diagrams.

Full Control Full Control allows users to create new wiring


diagrams and to edit, revise, save, and delete
existing wiring diagrams.

Cable Block Diagrams None None prevents users from viewing cable block
diagrams.

Read-Only Read-Only allows users to view cable block


diagrams, but not make any editing changes or
revisions.

Modify Settings Modify Settings allows users to edit (place


reference and project equipment and cables,
perform connections, and so forth), revise, and save
existing cable block diagrams, and set filters for
common properties.

SmartPlant Electrical Installation and Upgrade Guide 85


User Access

Category Options Description

Full Control Full Control allows users to create new cable block
diagrams and to edit, revise, save, and delete
existing cable block diagrams.

PDB Layouts None None prevents users from viewing PDB layouts.

Read-Only Read-Only allows users to view PDB layouts, but


not make any editing changes or revisions.

Modify Settings Modify Settings allows users to edit, revise, and


save existing PDB layouts.

Full Control Full Control allows users to create new PDB layouts
and to edit, revise, save, and delete existing PDB
layouts.

Miscellaneous None None prevents users from viewing miscellaneous


Drawings drawings.

Read-Only Read-Only allows users to view miscellaneous


drawings, but not make any editing changes or
revisions.

Modify Settings Modify Settings allows users to edit, revise, and


save existing miscellaneous drawings.

Full Control Full Control allows users to create, edit, revise,


save, and delete existing miscellaneous drawings.

Bus Load Summary None Controls the ability to modify the preferences for load
Calculation Method summary calculations.
Full Control

Switch Active Operating None Controls the ability to select a specific operating
Case case and make it the active operating case for the
Full Control
plant.

86 SmartPlant Electrical Installation and Upgrade Guide


User Access

SmartPlant Electrical User Rights Examples


The following examples are suggestions for granting rights to common groups of users. These
examples are a great starting place for defining rights for users of SmartPlant Electrical.

Project Administrators
This group is defined as those who have full control over all aspects of the administrative tasks
and reference data. These users should have the ability to create plant groups, add
applications, and roles. These users should only be able to view and not modify detailed project
engineering data.

Project Engineers
This group is defined as those users who are responsible for the electrical distribution network,
association of items, sizing cables, and specifying equipment. Although these users do not
generate schematic drawings and do not deal with detailed engineering, they should have full
permissions for most SmartPlant Electrical functions.

Project Designers
This group is defined as those users who are responsible for the actual detailed engineering
design, cable termination, cable routing, and generation of drawings. As a rule, project
designers should have read-only user rights to the project documentation and item
properties. Project designers can set up personal filters, tabular views, and create My
Reports. However, they should not be able to modify project defaults.

Category Administrators Engineers Designers

SmartPlant Engineering Manager Full Control None None

Catalog Full Control Read-Only None

Project Filters Read-Only Full Control Read-Only

Project Reports Read-Only Full Control Read-Only

Data Dictionary Full Control Read-Only Read-Only

Options Full Control Read-Only Read-Only

Electrical Items Data Read-Only Full Control Read-Only

Power Distribution Boards and Read-Only Full Control Read-Only


Internals (Index)

Wiring Equipment Read-Only Full Control Modify Properties

Cable Sizing Read-Only Full Control None

SmartPlant Electrical Installation and Upgrade Guide 87


User Access

Category Administrators Engineers Designers

Cable Replace None Full Control Read-Only

Single Line Diagram Drawings Read-Only Full Control Read-Only


(Index)

Single Line Diagram Generation Read-Only Full Control Read-Only

Redlining Read-Only Full Control Read-Only

Schematic Drawings (Index) Read-Only Full Control Full Control

Schematic Drawing Generation Read-Only Full Control Full Control

Apply Options Disabled Enabled Disabled

Associations Disabled Enabled Disabled

Reference Documents Full Control Modify Properties Read-Only

Templates Full Control Read-Only Read-Only

Reference Data Explorer - Cables Full Control Modify Properties Read-Only

Reference Data Explorer - Lookup Full Control Modify Properties Read-Only


Tables

Reference Data Explorer - Other Full Control Modify Properties Read-Only


Categories

Tabular Editor Layouts Full Control Full Control Full Control

Electrical Engineer Full Control Full Control Full Control

Import Manager Full Control None None

SmartPlant None None Full Control

Registered Reports Full Control Full Control Modify Settings

Project Management (As-Built) Full Control Full Control Full Control

Project Management (Projects) Full Control Full Control Full Control

Apply Naming Convention None Full Control Full Control

Wiring Diagrams None Read-Only Full Control

88 SmartPlant Electrical Installation and Upgrade Guide


User Access

Category Administrators Engineers Designers

Cable Block Diagrams None Read-Only Full Control

PDB Layouts None Read-Only Full Control

Miscellaneous Drawings None Read-Only Full Control

Bus Load Summary Calculation None Full Control None


Method

Switch Active Operating Case None Full Control None

SmartPlant Electrical Plant Group Permissions


After defining the roles for your project, you can set appropriate permissions for your groups of
users on a particular plant hierarchy level. This way you can determine which users can access
certain sections of your project. For example, if your hierarchy is defined as Plant/Area/Unit, you
can select a group of users and grant them different permissions for various plants, areas, and
units in your project.

 Plant group permissions apply only to those item types in your project for which you have
defined a plant group type in Options Manager. Item types that have not been associated
with a plant group will have unrestricted access even if a particular user has been granted
No Access to that plant group.
 Permissions for particular hierarchy levels apply only to the activities performed in the
Electrical Index, Electrical Engineer, and the Tabular Editor.
The following plant group permissions are available:

No Access Restricted Access Unrestricted Access

Electrical Index Users cannot view or Allows users to view Grants users full control
access any items in the items, but not edit or of the items in the
selected plant groups. associate items in the selected plant groups.
selected plant groups.

Electrical Engineer Users can view items Users can view items Grants users full control
(but not properties) in (including properties) in of the items in the
the selected plant the selected plant selected plant groups.
groups but cannot groups but cannot
change associations change associations
among the items. among the items.

Tabular Editor Users cannot view or Users cannot edit the Grants users full control
access any items in the items in the selected of the items in the
selected plant groups. plant groups. selected plant groups.

SmartPlant Electrical Installation and Upgrade Guide 89


User Access

 Hierarchy permissions do not affect the items that you select for a report. Use the standard
filtering feature to include the items that you require.
 Hierarchy level permissions do not affect opening or modifying documents. Hierarchy level
access rights do not govern document revisions either.

View Access Rights by Plant Group


This procedure only applies to SmartPlant Electrical.
1. Open SmartPlant Engineering Manager.
2. Select the plant group in the Tree view.
3. Right-click and select Access Rights.
4. Modify the access rights as desired.

View Access Rights by Role


This procedure only applies to SmartPlant Electrical.
1. Open SmartPlant Engineering Manager.
2. Select the Roles node in the Tree view.
3. Select a role in the List view.
4. Right-click and select Access Rights.
5. Modify the access rights as desired.

Access Rights Command (Tools Menu)


Provides SmartPlant Electrical users the ability to view role-level access by plant group or
plant-level access by role.
You can set access rights to one of three states:
No Access — Allows the role no access, not even read-only access, to the plant group, no
matter what user rights are assigned to the role.
Restricted Access — Reduces the user rights for the role to read-only in the selected plant
group. For example, if the role has been assigned full-control in all user access rights, selecting
this option limits the role to read-only access in the plant group .
Unrestricted Access — Does not limit the user rights for the role in the plant group.
See Also
View Access Rights by Plant Group (on page 90)
View Access Rights by Role (on page 90)
Access Rights Dialog Box (on page 91)

90 SmartPlant Electrical Installation and Upgrade Guide


User Access

Access Rights Dialog Box


Displays role-level access rights by plant group or plant-level access rights by role.
The options on this dialog box only apply to SmartPlant Electrical.
When you select a plant group in the Tree view and then click Tools > Access Rights, the
Access Rights dialog box displays the role access assigned to that plant group.

Plant group — Displays the plant group level you selected in the Tree view.
Application — Displays the applications associated with the selected plant group.
Access rights — Displays the roles defined for the plant group and their assigned plant group
access rights.
Expand All — Opens the entire Access rights list, allowing you to quickly view all of the rights
options.
Collapse All — Closes the entire Access rights list.

SmartPlant Electrical Installation and Upgrade Guide 91


User Access

When you select the Roles node in the Tree view, then select a role in the List view and click
Tools > Access Rights, the Access Rights dialog box displays the plant group access
assigned to that role.

Role name — Displays the role you selected in the List view.
Application — Displays the applications associated with the selected role.
Access rights — Displays the plant group levels in the plant in which the role resides.
Expand All — Opens the entire Access rights list, allowing you to quickly view all of the rights
options.
Collapse All — Closes the entire Access rights list.

92 SmartPlant Electrical 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 Electrical Options Manager to define data dictionary templates and symbols for
SLD drawings.
1. Click Start > Programs > SmartPlant Electrical > Options Manager.
2. Make the definitions that you require.
3. Click Settings.
4. 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 Electrical 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, see 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, see the SmartPlant Format Manager User's
Guide.

SmartPlant Electrical Installation and Upgrade Guide 93


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, the icon that represents the item, and the properties associated with the item.

 For more information about working with symbols and labels, see the SmartPlant Catalog
Manager User's Guide.
 For guidelines about how to create symbols for single-line diagrams in Catalog Manager,
see Guidelines for Creating SLD Symbols in Catalog Manager in the SmartPlant Electrical
documentation.

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, see the SmartPlant Data Dictionary
Manager User's Guide.

Establishing Design Rules


By defining typical or standard design rules, you can quickly and easily place required cables,
motors, and other electrical equipment 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.
The Rule Manager provides the tools for creating and editing rules. For more information, see
the SmartPlant Electrical Rule Manager User's Guide.

94 SmartPlant Electrical Installation and Upgrade Guide


Customizing Your Reference Data

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 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 Electrical Delivered Templates


SmartPlant Electrical delivers the following border templates.

Metric Templates
Template File Border File Page Size

A4 Tall.spe A4 Tall.sym A4 Tall (210mm x 297mm)

A4 Wide.spe A4 Wide.spe A4 Wide (297mm x


210mm)

A3 Tall.spe A3 Tall.spe A3 Tall (297mm x 420mm)

A3 Wide.spe A3 Wide.spe A3 Wide (420mm x


297mm)

A0_Template.spe A0_Template.spe A0 Wide (1189mm x


841mm)

English Templates
Template File Border File Page Size

A Tall.spe A Tall.spe A Tall (8.5in x 11in)

A Wide.spe A Wide.spe A Wide (11in x 8.5in)

C Tall.spe C Tall.spe C Tall (17in x 22in)

C Wide.spe C Wide.spe C Wide (22in x 17in)

SmartPlant Electrical Installation and Upgrade Guide 95


Customizing Your Reference Data

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.
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 Electrical. 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. Select the existing border file, and press Delete.
4. Click Edit > Insert > Object.
5. Clear the Link check box to be sure the item will be embedded.
6. Click Browse.
7. Click the border file to use. You can use the delivered border or choose another border.
8. Click Open.
9. Click OK on the Insert Object dialog box.
10. Position the border file in the template.
11. Click File > Exit.

Create a Border Template


1. Start SmartPlant Electrical.
2. Verify that the correct plant structure has been selected.
3. Click File > New Template.
4. Click File > Page Setup.
5. Select the sheet size in the Standard option and then click OK.
6. Click File > Properties.
7. 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.
8. Click Edit > Insert > Object.
9. Verify that Link is selected if you want the border file linked, or clear the Link check box if
you want to embed the file.
10. Select the border to use and click Open, and then click OK.
11. Click File > Save.
12. Type the name for the template in the File Name box.
13. Save the template border in the default templates location defined in Options Manager.

96 SmartPlant Electrical Installation and Upgrade Guide


Customizing Your Reference Data

14. Click Save.


15. Click File > Exit.

SmartPlant Electrical Installation and Upgrade Guide 97


Customizing Your Reference Data

98 SmartPlant Electrical Installation and Upgrade Guide


SECTION 13

Working with SmartPlant Integration


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 life-cycle. SmartPlant
Foundation acts as a repository for data and a medium through which information is shared
among other tools, such as SmartPlant Instrumentation, SmartPlant P&ID, and Smart 3D.
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 Electrical publishes and retrieves and shows the
flow of data and the different types of data.

SmartPlant Electrical interacts with SmartPlant Foundation by correlating items between the
plant database and the SmartPlant Foundation database, retrieving documents such as
Electrical Power Elements, Electrical Signal List, Cable Schedule reports, and P&IDs, from
SmartPlant Foundation. Also, SmartPlant Electrical creates a set of tasks in the To Do List that
you can run to update the plant database. In SmartPlant Electrical, you can also use the
commands on the SmartPlant menu to publish documents and retrieve data, access the
SmartPlant Foundation Web Portal in order to browse in SmartPlant Foundation, and subscribe
to change notifications and compare documents.

SmartPlant Electrical Installation and Upgrade Guide 99


Working with SmartPlant Integration

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 P&ID or SmartPlant Instrumentation, you must register each plant in SmartPlant
Electrical with a SmartPlant Foundation database. The connection allows SmartPlant Electrical
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 Electrical 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 SmartPlant Electrical
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 an Integrated Environment (on page 104) topic in
SmartPlant Engineering Manager Help.
3. Associate applications with and assign user access rights to your plant.
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 for each application, then enable SmartPlant P&ID for
one plant and SmartPlant Electrical for the other.

100 SmartPlant Electrical Installation and Upgrade Guide


Working with SmartPlant Integration

4. 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 SmartPlant Engineering Manager Help.
 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


Electrical
This topic describes rules and settings that allow SmartPlant Electrical data to be shared
correctly with Smart 3D, SmartPlant Instrumentation and SmartPlant P&ID, and the other tools
that are part of an integrated environment. Other tools that are not listed here have no known
SmartPlant Electrical / SmartPlant integration issues.

Integration with SmartPlant Instrumentation


In order to have a successful data exchange between SmartPlant Electrical and SmartPlant
Instrumentation, make sure that:
 Both SmartPlant Electrical and SmartPlant Instrumentation have the same plant hierarchy
structure
 In SmartPlant Instrumentation, instruments and I/O signals are defined on the lowest plant
hierarchy level
 In SmartPlant Instrumentation, cabinets are defined on the highest plant hierarchy level
 In SmartPlant Electrical, you defined a registered report for both the I/O lists and for
Instruments requiring power supply.
You must also ensure that the following SmartPlant Electrical select lists and SmartPlant
Instrumentation supporting tables contain identical values:
 System I/0 type
 Rated Voltage
 Power Supply AC/DC Flag
 Number of Phases
 Operating Mode
 Process Function
 Frequency
Furthermore, in SmartPlant Electrical Options Manager, in the General Settings window, you
need to make the following changes:

SmartPlant Electrical Installation and Upgrade Guide 101


Working with SmartPlant Integration

 For the SmartPlant Instrumentation Default Domain setting, specify the name of a
SmartPlant Instrumentation domain which you want to set as a source domain for retrieving
detailed wiring data to be included in schematics.
 If you want to retrieve enhanced reports to be included in schematics, select Yes for the
setting Include Enhanced Reports in Schematics.
In the two tools, the units of measure of certain properties might be defined using a different
precision accuracy. For example, 1.2 kW (one-digit accuracy of precision) in SmartPlant
Electrical corresponds to 1.23 kW (two-digit accuracy of precision) in SmartPlant
Instrumentation. This may result in inconsistencies and could be interpreted as an update when
retrieving data.
These properties are:
 Rated Active Power
 Rated Reactive Power
 Rated Apparent Power
 Full Load Current
 Operating Mode Coincidence Factors (X, Y, Z, ZZ)
 Starting Current

Integration with Smart 3D


In order to have a successful data exchange between SmartPlant Electrical and Smart 3D,
make sure that SmartPlant Electrical reference cables used in the project match the cables
Smart 3D has in its Catalog. Smart 3D identifies the type of the retrieved cable by looking at the
reference cable name in the Catalog; if this cable in the Catalog does not exist, the retrieved
cable is identified as an unknown cable for cable routing purposes.

 SmartPlant Electrical ships a sample report named Reference Data Cables Interface to
Smart 3D, which you can use as a source to be transferred to Smart 3D, so that Smart 3D
users can create their Catalog using the report data.
 If cables that originated in SmartPlant Electrical were subsequently deleted in Smart 3D and
then published back from Smart 3D, SmartPlant Electrical does not generate Delete tasks
for those cables.
Make sure that the following select lists in SmartPlant Electrical must match the content of the
related select lists in Smart 3D:
 Routing status
 Segregation level
SmartPlant Electrical also publishes to Smart 3D the relations to the cable side 1 and side 2. If
Smart 3D does not contain the relations, Smart 3D cannot perform cable routing.
This means that:
 In SmartPlant Electrical, the cables must have their side 1 and side 2 associated before
publishing.
 In Smart 3D, users must make sure that each object referenced in the cable sides has a
corresponding object in the Smart 3D data model.

102 SmartPlant Electrical Installation and Upgrade Guide


Working with SmartPlant Integration

Integration with SmartPlant P&ID


SmartPlant Electrical can retrieve items of electrical equipment that were published from
SmartPlant P&ID. Electrical equipment in SmartPlant P&ID constitutes electrical motors and
heaters only.
SmartPlant Electrical retrieves any items of process equipment that are associated with the
electrical equipment: for example, if a motor is associated with a pump in SmartPlant P&ID, the
pump is retrieved along with the motor in SmartPlant Electrical. Likewise, if the software
retrieves a heater that is associated with a vessel, then that vessel is also retrieved. The
software also supports retrieval of multiple electrical equipment associations to a single item of
process equipment, for example, where several heaters are used to heat up one vessel. Note
that SmartPlant Electrical does not retrieve items of process equipment that are not associated
with electrical items.
When SmartPlant P&ID and SmartPlant Electrical are both enabled for a plant, they
are both enabled for all projects of that plant. If a project requires only one of these
applications, create separate plants for each application, and then enable SmartPlant P&ID for
one plant and SmartPlant Electrical for the other.
When retrieving an item of mechanical equipment associated with a motor from
SmartPlant P&ID, the numerical value and units of measure of the Power Driver Rated property
as set in SmartPlant P&ID must exactly match an existing value of the Motor Rated Power
property in SmartPlant Electrical for the task to run successfully. In addition, if you run the
SmartPlant Electrical command to copy the value of the process equipment Absorbed Power
property to the motor Brake Power property, the software only validates values of the brake
power that do not exceed the motor rated power, as determined by the standard SmartPlant
Electrical rule.

Using Projects in an Integrated Environment


When working in an integrated environment with a plant that has projects, you need to make the
following changes in SmartPlant Electrical Options Manager, in the General Settings window:
 For the Allow Full Access to As-Built setting, select No. To use such a plant in an
integrated environment, you must ensure that it is not possible to change As-Built data in
As-Built itself. After you select No for this setting, the software can only update As-Built
when you merge project data with As-Built.
 For the As-Built Claim Mode setting, select Exclusive. SmartPlant integration does not
support having the same item claimed for different projects.

SmartPlant Electrical Installation and Upgrade Guide 103


Working with SmartPlant Integration

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 (Tools Menu).
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 Electrical 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, and DivisionLocation). This file is delivered to the
..\Engineering Manager\SmartPlant Resources folder.

Using Custom Hierarchies in an Integrated


Environment
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 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.
 All SmartPlant Engineering Manager hierarchy item names (plant group names) below the
plant (top level) must match the names in the SmartPlant Foundation plant hierarchy that are
at the same level. The names are case-sensitive and therefore the cases must also
match. The plant names do not have to match.
 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.

104 SmartPlant Electrical Installation and Upgrade Guide


Working with SmartPlant Integration

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
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 your plant.
 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.
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.

SmartPlant Electrical Installation and Upgrade Guide 105


Working with SmartPlant Integration

106 SmartPlant Electrical Installation and Upgrade Guide


Index
SmartPlant Foundation • 95
A SmartPlant integration • 47
Integration Resource Path • 47
As-Built • 97
requirements for integration • 97

B
border templates • 91
delivered • 91

C
configuring • 55
reference data • 55
customizing • 89, 91
border templates • 91
Options Manager • 89

I
installing • 9, 47
SmartPlant Electrical • 47
integration • 97
Integration Resource Path • 47
requirements • 97

O
Options Manager • 89
customizing • 89

P
projects • 97
requirements for integration • 97

R
reference data • 55, 89
configuring • 55
Options Manager • 89
registering • 95
with SmartPlant Foundation • 95

S
SmartPlant Electrical • 9, 10, 47
installing • 47
overview • 9
program group • 10
SmartPlant Engineering Manager • 95

SmartPlant Electrical Installation and Upgrade Guide 107

You might also like