SPELInstallGuide
SPELInstallGuide
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 Software License Agreement ("SLA") 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 SLA 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 use. 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 SLA 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.
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 commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors 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 Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.
Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or registered trademarks of Intergraph Corporation
or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
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.
Internationalization .................................................................................................................................... 11
If you installed Smart Electrical API Programming Help, it is available in the Help of
Visual Studio 2012 or Visual Studio 2013.
Smart Engineering Manager performs higher-level data management tasks, such as specifying
user permissions, designing plant hierarchies, and so forth. For more information about Smart
Engineering Manager, see the Smart Engineering Manager User's Guide and the appropriate
sections of this guide.
Installation Checklist
For the recommended installation workflow, see the Smart Electrical Installation Checklist:
SPELInstall_Checklist.xlsx. The checklist is located in the same folder as this installation guide.
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 (such as 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 a US/English operating system
▪ Using German Regional Settings (where the decimal point is a comma) on a US/English
operating system
Oracle Server 2.0 GB SQL Server 1.0 GB Initial Smart Electrical 0.25 GB
installation Server database
installation
▪ The client database software must be of the same version as the server database software.
▪ Do not use Oracle 'light client' as it does not include some of the required .dll files.
▪ Beginning with Windows 10 and Oracle 12.1.0.2, Microsoft and Oracle will enforce the
Internet Host Table Specification RFC 952 which mandates that component hostname
labels can contain only alphanumeric characters. Host names using underscores (‘_’) are
not allowed. Refer to Oracle Support Articles 1603775.1 and 1957895.1 and Microsoft KB
101785.
For SQL Server, no client installation is required.
SmartPlant Schema 25 MB
Component (for an
integrated environment)
Software Prerequisites
▪ PDF reader (required for reading and saving various documents)
▪ SmartPlant License Manager 12.00.83.00 or higher. The licensing is delivered on its own
CD that comes with your Smart Electrical product.
▪ Microsoft .NET Framework 4.6.2 or later
▪ Microsoft Edge Browser (required for viewing the Online documentation delivered with the
software)
▪ Microsoft Excel from Office 2013 Service Pack 1, 32-bit or Microsoft Office 2016(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
Optional Software
Apart from SmartSketch and Smart 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 REGARD TO SAID THIRD-PARTY
SOFTWARE.
▪ For administrative functions, Smart Engineering Manager 2018
▪ For working in a thin client environment, Citrix XenApp 7.6 (Windows Server 2012 R2
(Datacenter)
▪ ETAP electrical power systems design and analysis software - version 16, 16.1 and 16.1.1
▪ One of the following drawing software programs:
▪ SmartSketch 2016
▪ Autodesk AutoCAD 2014
▪ Bentley MicroStation 08
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 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.
▪ For Smart Engineering Manager to access the database, you must load and configure
Oracle Net Services on the database server and on each end-user workstation. If Smart
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 Smart 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 Smart
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 Hexagon PPM software uses to communicate with the
database.
▪ The version of Net Services must be the same on all computers.
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.
▪ 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 Database Operation page, select Create a Database and click Next.
3. On the Creation Mode page, select Advanced Mode.
4. On the Database Template page, select Custom Database and click Next.
5. On the Database Identification page, do the following:
a. In the Global Database Name box, define the database name, for example,
SPEL12cdb.
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 Management Options page, select an option and enter the required values.
8. Click Next.
9. On the Database Credentials page, select an option and then in the Password and
Confirm Password boxes, type the password, for example, Oracle12 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).
▪ 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.
15. On the Creation Options page, select the Create Database check box and then click Next.
After clicking Next the software performs a check of the parameters selected. If
any problems are detected the Prerequisite Checks page opens. You must fix any
problems before continuing. If no problems are found the software skips this page and goes
straight to the Summary page.
16. On the Summary page, check that the parameters are correct and then click Finish. The
Progress Page is displayed.
17. On the Finish page click Close.
18. Restart the server machine.
Prerequisites
▪ You must log in to your machine locally using Administrator rights.
▪ 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.
10. On the Specify Installation Location page, check that the path in the Oracle Base field is
pointing to the where you want to install the software. Click Browse to change the location.
▪ The Oracle base by default points to the same Oracle base created when you installed
the Oracle server.
▪ The Software Location fields are 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.
11. Click Next.
12. On the Summary page, click Install.
13. On the Finish page, on completion of the installation, click Exit.
14. At the prompt click Yes.
15. Restart the client machine.
16. 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.
17. If required, install the appropriate Oracle client patch.
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.
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 required 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.)
▪ 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 Smart 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.
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.
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:
1. Click Customize.
2. Ensure that Windows collation designator and sort order is selected.
3. 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.
4. Ensure that the Case-sensitive check box is cleared.
5. Click OK.
12. Click Next.
13. On the Database Engine Configuration page, select the Server Configuration tab and
under Authentication Mode, do the following:
a. Select Mixed Mode (SQL Server authentication and Windows authentication).
b. In the Enter password box, type the required SQL Server system administrator account
password.
c. In the Confirm password box, re-type the same password.
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.
14. On subsequent pages, add a network user where required and click Next, or just click Next.
15. When you reach the Ready to Install page, review the list of components to be installed
and click Install.
16. On the Installation Progress page, once the setup process is complete, click Next.
17. After clicking Close, restart the server machine.
If it is likely that a large number of users will connect to the database concurrently,
select the Memory page and under Maximum server memory (in MB), set a higher value
to avoid poor performance.
4. Select the Database Settings page and change the value of Default index fill factor to 80.
▪ 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.
▪ On completion of the installation, if prompted, you should reboot your machine before
starting Smart Electrical
▪ If you try to install Smart 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 36).
▪ The driver used for printing the PDF files, Smart PDF Converter (Amyuni 5.0.1), is included
in the Smart 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 Smart Electrical API Programming Help, it is available in the Help of Visual
Studio 2012 or Visual Studio 2013.
▪ Because Smart Electrical installation requires Smart License Manager for concurrent
licensing, you must first install the Smart License Manager software on your workstation and
on every other workstation where you are going to install Smart Electrical in silent
mode. For more information about installing and configuring Smart License Manager, see
the Smart 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 Smart Electrical over a network, ensure that the
following conditions exist:
▪ For a new release, all previous existing versions of Smart 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 Smart
Electrical is to be installed.
▪ The target machine meets the free disk space recommendations specified in Smart
Electrical Workstation.
▪ All applications are closed.
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 Smart 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
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
be installed locally. If the
▪ Accepted values:
ADDLOCAL argument is ▪ ALL — installs all
not present in the available features
command line, the
software installs features ▪ Specified list of features
according to the default delimited by commas.
settings (for details, see The features must be
the Notes below). present in the Feature
column of the Feature
table. The features
available for this product
are listed in the Notes
below.
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: Specified list of
removed or excluded when
features delimited by commas.
modifying an installation.
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 modify is specified, install is
assumed as the default.
▪ The ADDLOCAL = "ALL" argument installs all the basic and optional features listed in the
tables below.
Basic Features
The basic features are the same as those selected by default in the regular interface.
Optional Features
Feature Argument Value Notes
▪ 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.
a. Share the folder that contains the reference data. All Smart Electrical 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 practice will help you with future service pack installations, data recovery,
and so forth.
▪ When you access the Smart 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.
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 Smart Electrical.
▪ For an Oracle platform, the version must be Oracle 12c; therefore, if you have an older
version of Oracle, you must upgrade it before upgrading Smart Electrical to Version 2018.
▪ If you are upgrading from a database version of Smart Electrical earlier than 2009, you must
first upgrade that database version to Smart Electrical 2009 using Version 2009 of the
Upgrade Utility (included with Smart Engineering Manager 2009) before upgrading to Smart
Electrical 2018. For more information, visit the Intergraph support Web site
(http://support.intergraph.com).
▪ Smart Electrical database version 2018 is suitable only for Smart Electrical software version
2018.
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.
The following table is a compatibility matrix of the most recent software versions.
Version 2009 SP3 Version 2009 SP2 Version 2009 SP2 HF4 —
Version 2009 SP5 Version 2009 SP4 Version 2009 SP3, SP4 —
Version 2009 SP6 Version 2009 SP4, SP5 Version 2009 SP5 —
▪ 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 before upgrading to the current version of the application.
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 Smart 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 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).
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 Smart Electrical application.
2. In the Upgrades in progress node, right-click the plant and on the shortcut menu, click
Finish All Tasks to start the upgrade process for the application.
3. Click Yes to proceed with the next stage of the upgrade procedure.
As each task is completed, its status changes from No to Yes and a progress bar at the
bottom of the dialog box indicates the upgrade activity for the current task:
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.
▪ 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.
▪ 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.
Post-Upgrade Tasks
After you complete all the upgrade tasks for a plant, make a full backup of the upgraded
databases.
Some or all of the following post-upgrade tasks may also be required:
▪ Back Up Each Upgraded Plant
▪ Preserve Software Customizations
▪ Update Symbology Definitions
▪ Make Additional Changes for Smart P&ID
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.
▪ 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.
Data Dictionary None None prevents users from accessing the Tools >
(These settings affect Update Select List command.
Read-Only
the Update Select List
Read-Only prevents users from accessing the
command.) Modify Select
Tools > Update Select List command.
Entry
Modify Select Entry allows users to add and edit
Full Control
select lists on the Update Select List dialog box.
Full Control allows users to add and edit select
lists on the Update Select List dialog box.
Electrical Items Data None None prevents users from viewing or accessing
electrical equipment items in the Electrical Index.
Read-Only allows users to view electrical
Read-Only
equipment items in the Electrical Index. Users
are not allowed to make any changes or create
new electrical equipment items in the Electrical
Modify Settings
Index.
Modify Settings allows users to create and edit
Full Control electrical equipment items in the Electrical Index.
Users are not allowed to delete electrical
equipment items in the Electrical Index.
Full Control allows users to create, modify, and
delete electrical 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
Full Control Cables dialog box.
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.
Single Line Diagram None None prevents users from viewing or generating
Drawings (Index) PDB-based single line diagrams.
Read-Only allows users to open and view
Read-Only
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
Modify Settings Electrical Index.
Modify Settings allows users to generate, edit,
Full Control 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 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 allows users to open and view single
Read-Only
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
Full Control Engineer. Users are not allowed to delete single
line diagrams that were generated from the
Electrical Engineer.
Full Control allows users to generate, modify,
and delete single line diagrams that were
generated from the Electrical Engineer.
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
Documents
dissociate external documents. Select the check
box to enable an option; clear to disable.
Reference Data None None prevents users from seeing any reference
Explorer - Cables cable items in the Reference Data Explorer.
Read-Only allows users to see reference cable
Read-Only
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
Full Control not allowed to create or delete reference cables.
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 allows users to see lookup table items
Read-Only
in the Reference Data Explorer and view lookup
table properties, but not make any changes.
Modify Settings Modify Settings allows users to edit the
properties of existing reference lookup tables.
Users are not allowed to create or delete
Full Control reference lookup tables.
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
Modify Settings
properties, but not make any changes.
Modify Settings allows users to edit the
Full Control properties of existing reference equipment items.
Users are not allowed to create or delete
reference equipment items.
Full Control allows users to create, edit, and
delete reference equipment items.
Engineering Data Editor None Enables or disables the creation and management
Layouts of EDE layouts. Select the check box to enable an
Full Control
option; clear to disable.
Cable Block Diagrams None None prevents users from viewing cable block
diagrams.
Read-Only allows users to view cable block
Read-Only
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
Full Control save existing cable block diagrams, and set filters
for common properties.
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
Full Control
save existing PDB layouts.
Full Control allows users to create new PDB
layouts and to edit, revise, save, and delete
existing PDB layouts.
Bus Load Summary None Controls the ability to modify the preferences for
Calculation Method load 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.
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 Smart 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.
Engineering Data Editor Layouts Full Control Full Control Full Control
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 EDE.
The following plant group permissions are available:
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.
Engineering Data Users cannot view or Users cannot edit the Grants users full control
Editor access any items in the items in the selected of the items in the
selected plant groups. plant groups. selected plant groups.
▪ 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.
See Also
View Access Rights by Role (on page 74)
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 the rights
options.
Collapse All — Closes the entire Access rights list.
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 the rights
options.
Collapse All — Closes the entire Access rights list.
▪ For more information about working with symbols and labels, see the 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 Smart Electrical User's
Guide.
Metric Templates
Template File Border File Page Size
English Templates
Template File Border File Page Size
Smart 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, Smart Electrical creates a set of tasks in the To Do List that you can run to
update the plant database. In Smart Electrical, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access SmartPlant Foundation to
browse data, and subscribe to change notifications and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For
more information, see Smart Engineering Manager Help.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
Smart P&ID or Smart Instrumentation, you must register each plant in Smart Electrical with a
SmartPlant Foundation database. The connection allows Smart Electrical to use the commands
on the SmartPlant menu. A Smart 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 Smart Engineering Manager. After the plant is registered, you can publish and retrieve
documents.
5. Register your SmartPlant plant with SmartPlant Foundation, as described in the Smart
Engineering Manager Help.
▪ When you register your plant, you must specify the location of the Smart Engineering
Manager schema map file (SPEMDataMap.xml). For more information, see the Specify
Map File Dialog Box topic in the Smart 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.
▪ 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 Smart Electrical
corresponds to 1.23 kW (two-digit accuracy of precision) in Smart 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
▪ Smart 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 Smart Electrical were subsequently deleted in Smart 3D and then
published back from Smart 3D, Smart Electrical does not generate Delete tasks for those
cables.
Make sure that the following select lists in Smart Electrical match the content of the related
select lists in Smart 3D:
▪ Routing status
▪ Segregation level
Smart 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 Smart 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.
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 Smart 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.
▪ After registering, Smart 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.
▪ Smart 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 Smart 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.
▪ You must install the Schema Component and the SmartPlant Client, delivered with
SmartPlant Foundation, on your Smart 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.