SmartPlant Enterprise Control

Panel
Installation and Setup Guide

Version 2013

October 2012

DSCP-100002A
Copyright
Copyright © 2012 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade
secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from
Intergraph Corporation.
U.S. Government Restricted Rights Legend
Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes
the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Contents
Preface .......................................................................................................................................................... 5
SmartPlant Enterprise Control Panel Documentation............................................................................. 5

Welcome to SmartPlant® Enterprise Control Panel ................................................................................ 7

Enterprise Dataflow module .................................................................................................................... 7
Internationalization .................................................................................................................................. 8

SmartPlant Enterprise Control Panel Hardware and Software Recommendations ........................... 11

SmartPlant Enterprise Control Panel Server ........................................................................................ 11
SmartPlant Enterprise Control Panel Client .......................................................................................... 11

Installing SmartPlant Enterprise Control Panel on the Application Server ........................................ 13

Install SmartPlant Enterprise Control Panel ......................................................................................... 13
Install SmartPlant Enterprise Control Panel in Silent Mode (Server Only) ........................................... 17
Create a Silent Install Setup File .................................................................................................... 18
Install Silently Using the Setup File ................................................................................................ 18

Installing SmartPlant Enterprise Control Panel on a Client Workstation ............................................ 21

Install Prerequisite Software ................................................................................................................. 21
Install onto a Client Workstation ........................................................................................................... 21

Configuring SmartPlant Enterprise Control Panel Security ................................................................. 23

SmartPlant Foundation Security Model ................................................................................................ 23
Create and Manage Role Assignments ................................................................................................ 24
Create SmartPlant Enterprise Control Panel Users .............................................................................. 24
Configure Access Groups ..................................................................................................................... 25

Configuring SmartPlant Enterprise Control Panel in Server Manager ................................................ 27

Create a New SmartPlant Enterprise Control Panel Site in Server Manager ....................................... 27

Setting Up and Configuring SmartPlant Enterprise Control Panel Services ...................................... 29

Set Your Active Scope in SmartPlant Foundation to Scope Not Set .................................................... 29
Import SmartPlant Enterprise Control Panel Load Files ....................................................................... 29
Mapping Tool Templates ................................................................................................................ 30
Log on to SmartPlant Enterprise Control Panel after Server Installation .............................................. 31

SmartPlant Enterprise Control Panel Launch Parameters.................................................................... 33

Command Line Parameters .................................................................................................................. 33

Index ........................................................................................................................................................... 35

SmartPlant Enterprise Control Panel Installation and Setup Guide 3

Contents

4 SmartPlant Enterprise Control Panel Installation and Setup Guide

Preface
This SmartPlant Enterprise® Control Panel installation Guide provides details on the installation
and configuration of SmartPlant Enterprise Control Panel. This document is intended for
software developers and administrators who are skilled with SmartPlant Enterprise Control
Panel and SmartPlant Foundation.

SmartPlant Enterprise Control Panel Documentation

SmartPlant Enterprise Control Panel documentation is available as Help and as Adobe® PDF
files. To view printable guides for SmartPlant Enterprise Control Panel in the software, see the
Printable Guides topic in the SmartPlant Enterprise Control Panel Help.
Intergraph gives its customers permission to print as many copies of the delivered PDF files as
they need for their non-commercial use. Do not print the PDF files for resale or redistribution.

Installation and Setup Guide

SmartPlant Enterprise Control Panel Installation and Setup Guide - Provides installation and
setup instructions for SmartPlant Enterprise Control Panel administrators and users.

Administration and Configuration Guide

SmartPlant Enterprise Control Panel Administration and Configuration Guide - Provides
information to help administrators manage and configure the SmartPlant Enterprise Control
Panel application.

User's Guide
SmartPlant Enterprise Control Panel User's Guide - Provides information and instructions to
help new users manage information in SmartPlant Enterprise Control Panel.

Support
For the latest support information for this product, use a World Wide Web browser to connect to
http://support.intergraph.com (http://support.intergraph.com).
Send documentation comments or suggestions to PPMdoc@intergraph.com.

SmartPlant Enterprise Control Panel Installation and Setup Guide 5

Preface

6 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 1

Welcome to SmartPlant® Enterprise

Control Panel
SmartPlant® Enterprise Control Panel is a framework for managing modules that participate in
the administration of a SmartPlant Enterprise system. This framework is based on SmartPlant
Foundation technology, which provides a comprehensive electronic data storage, exchange,
management, and integration system for SmartPlant Enterprise.

Enterprise Dataflow module

Using the Enterprise Dataflow module of the SmartPlant Enterprise Control Panel, you can
control how mapping information flows between participating authoring tools in a SmartPlant
Enterprise system. The mapped information is shared between the different authoring tools
using a publish and retrieve mechanism. This dataflow between the tools consists of the
mapping of classes and properties using map files, which specify how the mapped data from
one authoring tool relates to the mapped data of another authoring tool in the system.
The SmartPlant Enterprise integration approach is based on both SmartPlant Foundation
authoring applications and SmartPlant external authoring tools publishing their tool schema data
to a SmartPlant Foundation system. Each authoring tool can also retrieve the mapped data
published by the other authoring tools from the SmartPlant Foundation database.
An administrator can edit the mapping dataflow of published and retrieved classes and
properties. The next time the authoring tool publishes or retrieves mapped data, the change to
the mapping dataflow is passed to other authoring tools. In this way an administrator can control
the dataflow of mapped data between different authoring tools. Administrators can also manage
and report on the dataflow for your business needs.
Information that is available from the tools includes:
 Type of tool (SmartPlant Foundation authoring application or SmartPlant Enterprise external
authoring tool)
 Number of mapped published properties from each tool
 Number of mapped retrieved properties (from SmartPlant Foundation and each installed
tool)
 Number of unmapped properties from each tool
Information that you can view includes:
 Tool-to-SmartPlant Foundation dataflow for properties
 Tool-to-SmartPlant Foundation dataflow for enumerated lists
 Tool-to-tool dataflow comparison report for properties

Through the interoperability of SmartPlant Enterprise Control Panel and SmartPlant Foundation,
SmartPlant Enterprise Control Panel users are able to find the registered authoring tools for a
project server, and alter their mapping by switching on or off the property mapping dataflow
between the authoring tool and SmartPlant Foundation.

SmartPlant Enterprise Control Panel Installation and Setup Guide 7

Welcome to SmartPlant® Enterprise Control Panel

As seen in the following diagram, SmartPlant Enterprise Control Panel is installed with
SmartPlant Foundation.

 SmartPlant Enterprise Control Panel uses SmartPlant Foundation to store the administration
items that it controls. SmartPlant Foundation provides a comprehensive electronic data
storage, exchange, management, and integration system for SmartPlant Enterprise Control
Panel.
 Administrators can use the SmartPlant Enterprise Control Panel to view, edit, and configure
existing mapping dataflows in their project configuration system.

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

8 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Welcome to SmartPlant® Enterprise Control Panel

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
 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"

SmartPlant Enterprise Control Panel Installation and Setup Guide 9

Welcome to SmartPlant® Enterprise Control Panel

Russian operating systems (possibly using virtual Russian operating systems running on
VMware Workstation). The U.S. and U.K. companies can install and use English Microsoft
Office products on the Russian operating system because Office products are globally enabled.
If a Russian interface exists for the SmartPlant Enterprise application, then Russian users can
use the Russian interface while the English-speaking users would continue to use the
US/English interface. English-speaking engineers can enter English characters.
Russian-speaking engineers can enter Russian characters.
However, because the Russian locale uses different decimal and character-set locales,
everyone (English and Russian engineers) must use the Russian decimal symbol which is a
comma. For customization purposes, databases can be modified to accommodate new
Russian-specific requirements (fields, properties, and so forth.) Using filters, display sets, and
other software features, bi-lingual projects can be further customized. Graphic data, reports, and
so forth can be created in either or both languages.
Do not change regional settings to reflect a U.S. environment in order to resolve
problems in a non-US/English homogeneous configuration. Doing this creates a heterogeneous
configuration that will cause other possibly hidden problems that cannot be corrected. Everyone
working on a project must use the same regional settings and character set throughout the life of
the project.

Questions and Assistance

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

10 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 2

SmartPlant Enterprise Control Panel

Hardware and Software
Recommendations
Before beginning an installation of SmartPlant Enterprise Control Panel, verify that your servers
and client workstation computers meet the following hardware and software recommendations.

SmartPlant Enterprise Control Panel Server

SmartPlant Enterprise Control Panel server must be installed on a SmartPlant Foundation
application server, configured with its prerequisite software. The SmartPlant Enterprise Control
Panel server is a 64-bit application, and requires all of the same hardware and software
recommendations as the SmartPlant Foundation application server, except for the following
additional software prerequisite:
 SmartPlant Foundation 2009 R4
For more information on SmartPlant Foundation hardware and software recommendations, see
the SmartPlant Foundation Installation and Setup Guide delivered with SmartPlant Foundation.

SmartPlant Enterprise Control Panel Client

The SmartPlant Enterprise Control Panel client can be installed in a 32-bit or a 64-bit
environment.

Hardware Recommendations
 2.8 GHz Pentium 4 processor or higher
 4 GB RAM
 80 MB of free disk space
 DVD drive access, either locally or through a network connection for installation
 100 BaseT network interface

Supported Operating Systems

 Windows Server 2008 R2 SP1 (64-bit)
 Windows 7 Professional or Enterprise Service Pack 1 (32-bit or 64-bit)

Software Prerequisites
 Microsoft Internet Explorer 7.0 or 8.0 (required for viewing the online documentation
delivered with the software). The latest version can be downloaded from the Microsoft Web
site
 Adobe Reader 8.0 or greater (required for viewing the Software License Agreement,
Printable Guides, and reports). The latest version can be downloaded from the Adobe Web
site

SmartPlant Enterprise Control Panel Installation and Setup Guide 11

SmartPlant Enterprise Control Panel Hardware and Software Recommendations

 Microsoft .NET Framework 4.0. The latest version can be downloaded from the Microsoft
Web site

Software Recommendations
 SmartPlant Foundation 2009 R4 Desktop Client (to display SmartPlant Foundation
functionality in SmartPlant Enterprise Control Panel)
 Microsoft Office Excel 2007 or later (32-bit) (for exporting reports)
 Microsoft Office Word 2007 or later (32-bit) (for exporting reports)
 Microsoft Visual Studio 2010 (for SmartPlant Enterprise Control Panel customization)

12 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 3

Installing SmartPlant Enterprise Control

Panel on the Application Server
SmartPlant Enterprise Control Panel must be installed on the SmartPlant Foundation application
server. Before you start the installation, however, you must verify that all the prerequisite
software is installed on the SmartPlant Foundation application server, and decide the location
where the software will be installed.

 By default, the software is installed in the following location: C:\Program Files

(x86)\SmartPlant\Enterprise Control Panel\2013. Check with your IT department for specific
guidelines about where to install the software.
For more information on software and hardware requirements, see SmartPlant Enterprise
Control Panel Hardware and Software Recommendations (on page 11) and SmartPlant
Foundation Installation and Setup Guide delivered with SmartPlant Foundation.

Install SmartPlant Enterprise Control Panel

You can also install the application using silent mode. See Install SmartPlant
Enterprise Control Panel in Silent Mode (Server Only) (on page 17).
1. Insert the SmartPlant Enterprise Control Panel DVD into the DVD drive. If the installation
does not start automatically, double-click SPECPAutoPlay.exe (found on the DVD).
2. Click SmartPlant Enterprise Control Panel Installation to start the Install Shield Wizard.
The Welcome to Intergraph SmartPlant Enterprise Control Panel Setup dialog box
displays.
3. Click Next to start the installation.

SmartPlant Enterprise Control Panel Installation and Setup Guide 13

Installing SmartPlant Enterprise Control Panel on the Application Server

4. Enter your User Name, Company Name and the Serial Number and click Next

5. Verify the registration information entered is correct and click Yes.

14 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Installing SmartPlant Enterprise Control Panel on the Application Server

6. Select your country from the list and click Display to view the license agreement.

Because the license agreement is delivered as a PDF file, you must have
Acrobat Reader installed to view the license agreement.
7. Carefully read the license agreement. Close the PDF file when finished and click Yes to
accept the terms.
8. To accept the default installation folder for SmartPlant Foundation, click Next.

If you want to choose a different installation destination location, select Browse and
navigate to the new folder. Then click Next.

SmartPlant Enterprise Control Panel Installation and Setup Guide 15

Installing SmartPlant Enterprise Control Panel on the Application Server

9. In the Setup Type dialog box, select the setup type that you want to install, and click Next.

 Client-Only - Installs SmartPlant Enterprise Control Panel client software only.

 Server and Deployable Client - Installs SmartPlant Enterprise Control Panel server,
client, and deployable client. Users can run the client interactively from the server
computer. Users can launch the deployable client from another computer using a URL.

10. Select the program folder where you want SmartPlant Enterprise Control Panel to appear on
your start menu, and click Next.

16 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Installing SmartPlant Enterprise Control Panel on the Application Server

11. Verify that the installation settings are correct and click Next to start copying the files.

12. Once installation is complete, click Finish to close the Install Shield Wizard.

Install SmartPlant Enterprise Control Panel in Silent

Mode (Server Only)
You can also install the software onto a server using silent mode. Silent mode installation is a
two-stage process and is used to replicate the server installation on another server.
The process for installing in silent mode is as follows:
 Perform a normal installation by running the setup.exe file from the command line, using
parameters that are recorded in the installation session, and save the selected options into
an .iss file.
 Run setup in silent mode on another server, using the recorded installation to provide the
necessary setup process.
The server environment on which you run the normal setup, (to save the selected
options to an .iss file) and the server environment you perform the silent mode installation onto,
must be identical. They must have the same drive name, database platform, software version,
installed files, and so on.

SmartPlant Enterprise Control Panel Installation and Setup Guide 17

Installing SmartPlant Enterprise Control Panel on the Application Server

Create a Silent Install Setup File

Ensure that the following conditions exist prior to running a silent install setup for SmartPlant
Enterprise Control Panel components over a network:
 All existing versions of the software have been uninstalled prior to network installation.
 The target computer meets the free disk space recommendations specified.
 All applications are closed.
To create the Silent Install Setup File from a command line:
1. Open a Command Prompt window from the Start menu.
2. Type the following: "<setup source folder path>\setup.exe"/r
/f1"C:\Temp\SPECP_Custom_All.iss"
3. Press Enter.

 The /r parameter records the setup input and automatically generates the Silent Install
Setup File (silentsetup.iss).
 The /f1"<path>\<filename>.iss" parameter specifies the path and filename for the
silent install setup file.
 The double quotes are required around this path, with no space between the /f1 and the
opening double quotes. For example, the following command string,
\\sourceserver\specp\setup.exe /r /
f1"c:\installfiles\silentsetup.iss", places the resulting silentsetup.iss file
into the c:\installfiles folder.
Be sure the <setup source folder path> specifies the path to the folder that
contains the setup.exe file that launches the software component Install Shield Wizard, and
not the setup.exe file that launches the SmartPlant Enterprise Control Panel AutoPlay
executable.
4. Work through the standard installation for SmartPlant Enterprise Control Panel as
documented in Installation for SmartPlant Enterprise Control Panel (see "Install SmartPlant
Enterprise Control Panel" on page 13).
You now have the completed the recording of the component installation which has created
a new Silent Install Setup File (.iss file). See Silent Install Using Setup File (see "Install
Silently Using the Setup File" on page 18) for further information.

Install Silently Using the Setup File

You can silently install the software component using the new Silent Install Setup File (.iss
file).
1. Open a Command Prompt window on each computer onto which you want to install the
software and type: "<setup source folder path>\setup.exe" /s
/f1"C:\Temp\SPECP_Custom_All.iss"
/f2"C:\Temp\SPECP_Custom_All.iss.log"
Make sure that you use exactly the same silent install setup .iss file that was
previously created.

 The /s parameter tells setup to run in silent mode using the indicated Silent Install Setup
File (.iss file).

18 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Installing SmartPlant Enterprise Control Panel on the Application Server

 The /f1"<path>\<filename>.iss" parameter specifies the path and filename for the
Silent Install Setup File (.iss file) you want to run. The double quotes are required, with
no space between the /f1 and the opening double quotes. For example,
/f1"c:\installfiles\silentsetup.iss".
 You can optionally use the /f2"<path>\<filename>.log" parameter to record a log file of
the setup process. The double quotes are required, with no space between the /f2 and
the opening double quotes. For example, /f2"c:\installfiles\silentsetup.log". If /f2 is
not defined, a log file is created in the same location as the .iss file.
2. The Silent Install Setup File (.ss file) runs and installs SmartPlant Enterprise Control Panel
to the folder location and local directory destination previously recorded.
3. Verify that the software was installed correctly on the local directory. Successful silent
installation produces a log file. Check the .log file to ensure that the installation proceeded
without errors.

 Here is an example .log file to ensure that the installation proceeded without errors:
[InstallShield Silent]
Version=v1.00.000
File=Log File
[ResponseResult]
ResultCode=0
[Application]
Name=SmartPlant Enterprise Control Panel
Version= 01.00.00.00
Company=Intergraph
Lang=0009
 If an error occurrs, a ResultCode is displayed. Examples of result codes include the
following:
Any value greater than 0 = Success.
-1 General error.
-2 Invalid mode.
-3 Required data not found in the Setup.iss file.
-4 Not enough memory available.
-5 File does not exist.
-6 Cannot write to the response file.
-7 Unable to write to the log file.
-8 Invalid path to the InstallShield Silent response file.
-9 Not a valid list type (string or number).
-10 Data type is invalid.
-11 Unknown error during setup.
-12 Dialog boxes are out of order.
-51 Cannot create the specified folder.
-52 Cannot access the specified file or folder.
-53 Invalid option selected.

SmartPlant Enterprise Control Panel Installation and Setup Guide 19

Installing SmartPlant Enterprise Control Panel on the Application Server

20 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 4

Installing SmartPlant Enterprise Control

Panel on a Client Workstation
Installation of SmartPlant Enterprise Control Panel onto a client workstation allows you to
download and install the software application in a simple, automated deployment process, direct
from a web server or network server.

Install Prerequisite Software

Before you install SmartPlant Enterprise Control Panel on a client workstation, verify that the
recommended software has been installed. For more information see SmartPlant Enterprise
Control Panel Hardware and Software Recommendations (on page 11).

Install onto a Client Workstation

The installation of SmartPlant Enterprise Control Panel onto a workstation can be performed by
the user of the workstation. An administrator sends out a URL hyperlink in an email to each
client user that provides access to the installation location.
1. Click the URL hyperlink in the email received. For example, http:/<name of
host>/SPE.Client/deploy.htm.

SmartPlant Enterprise Control Panel Installation and Setup Guide 21

Installing SmartPlant Enterprise Control Panel on a Client Workstation

2. Click Install.

3. Click Install at the Application Install - a security warning message displays if the details are
correct.

 The deployment process starts and verifies that all application requirements are
present.
 A progress bar indicates the installation progress.
4. After the installation finishes, SmartPlant Enterprise Control Panel automatically starts up.

 If a new version of the software is available then an Update Available message is displayed
prompting you to download the latest version; you can either install the new version or Skip
the install if required.
 After installation you also have the option to run the SmartPlant Enterprise Control Panel
application from a shortcut icon on the desktop or from the Start menu. For example Start >
All Programs > Intergraph > SmartPlant Enterprise > Intergraph SmartPlant Enterprise
Control Panel Client.
 You will only see the tools and projects you have access to, depending on your security and
access permissions.
For further information on using the software see the SmartPlant Enterprise Control Panel
User's Guide.

22 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 5

Configuring SmartPlant Enterprise

Control Panel Security
SmartPlant Enterprise Control Panel security uses the SmartPlant Foundation security model to
control the access, operation, and display of project data in SmartPlant Enterprise Control
Panel.
SmartPlant Enterprise Control Panel administrators must configure and manage security
through user roles and access groups in SmartPlant Foundation Desktop Client.

SmartPlant Foundation Security Model

The SmartPlant Foundation security model is a flexible mechanism to control role-based user
access to data and the operations that can be performed on that data. The security model is
comprised of:
 Users
 Roles, domains, and access groups
 Configurations
 Role assignments
A user is assigned a role in a configuration. Roles are related to access groups, which control
access to the different components of the system. The security model also controls user access
to:
 Menus and toolbars
 Shortcut menu commands
 Relationship manipulation and navigation
The SmartPlant Foundation Desktop Client is used to configure the security model by creating
and relating security objects. No additional schema modeling of classes, interfaces, or
relationship definitions is required.
Once the security access model is designed, the various levels of access are modeled by
creating access groups and relating them to roles. The access groups are related to the relevant
methods, interfaces, and view definitions, to which they have to grant access.
SmartPlant Enterprise Control Panel is delivered with several default roles, access groups, and
configurable GUI items that are loaded with the default SmartPlant Enterprise Control Panel
administrative files.
For more information on configurable GUI items, see Update and Configure Items on the
SmartPlant Enterprise Control Panel Interface in the SmartPlant Enterprise Control Panel
Administration and Configuration Guide.
To configure SmartPlant Enterprise Control Panel security, you must create users, configure the
users' roles, then assign or relate each new user to access groups using the SmartPlant
Foundation Desktop Client.
The SmartPlant Foundation How to Configure the Security Model guide describes the
configuration and components of the SmartPlant Foundation security model. You can access
the guide by clicking Help > Printable Guides.

SmartPlant Enterprise Control Panel Installation and Setup Guide 23

Configuring SmartPlant Enterprise Control Panel Security

Create and Manage Role Assignments

SmartPlant Enterprise Control Panel is delivered with five default roles:

Role Description
SPE_Viewer View-only access to SmartPlant Enterprise Control Panel data.
SPE_Administrator Permissions to view, modify, update data, and perform
administrative tasks in SmartPlant Enterprise Control Panel.
SPE_2DEditor Permissions to edit 2D map files, such as SmartPlant P&ID. 3D
tool data can be seen but is not editable.
SPE_3DEditor Permissions to edit 3D map files, such as for SmartPlant 3D. 2D
tool data can be seen but is not editable.
SPE_SPFEditor Permissions to edit SmartPlant Foundation map files, such as
for Plant Breakdown Structure (PBS). All other tool data can be
seen but is not editable.
The role assignment links a user to a role in a given configuration.
By default, all SmartPlant Enterprise Control Panel roles are managed by the
SmartPlant Enterprise Control Panel Administrator role.
For more information about creating roles, assignments and configuration, see the SmartPlant
Foundation How to Configure the Security Model guide.

Create SmartPlant Enterprise Control Panel Users

SmartPlant Enterprise Control Panel is delivered with five example users:

User Role
SPEViewer SmartPlant Enterprise Control Panel
Viewer.
SPEAdmin SmartPlant Enterprise Control Panel
Administrator.
SPE2DEditor Editor of 2D Map Files.
SPE3DEditor Editor of 3D Map Files.
SPESPFEditor Editor of SmartPlant Foundation Map
Files.
The role assignment links a user to a role in a given configuration.
For more information about role creation, assignments, and configuration, see SmartPlant
Foundation User Creation and User and Role Assignment Configuration in the SmartPlant
Foundation How to Configure the Security Model guide.

24 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Configuring SmartPlant Enterprise Control Panel Security

Configure Access Groups

Access groups govern user access to SmartPlant Enterprise Control Panel commands and
navigation, and are modeled to represent different levels of functional access. The SmartPlant
Foundation administrator assigns users to an access user group set up for SmartPlant
Enterprise Control Panel. The access user group to which a user is assigned dictates how that
user views and manages tool mapping data.
To grant a user permission to access a specific command or function, you must associate that
user's roles to the appropriate access group. The following access groups are delivered in
SmartPlant Enterprise Control Panel.

Access Group
Access Group Role SPE_Administrator Role SPE_Viewer
Description
SPEAdmin YES
SPEViewer YES YES

Access Group Access Group SPEM SPEL P&ID SPI 3D LLA PBS
Description
SPE2DEditor YES YES YES YES
SPE3DEditor YES
SPESPFEditor YES YES
To configure access groups, you need to log on to the SmartPlant Foundation Desktop Client as
an administrator.
These are the default access groups delivered with the Sample Data SPE Map Tool
Templates. If you do not load the sample data, then the access groups in this chart do not exist.
For more information, see Roles and Access Groups in the SmartPlant Foundation How to
Configure the Security Model guide.

SmartPlant Enterprise Control Panel Installation and Setup Guide 25

Configuring SmartPlant Enterprise Control Panel Security

26 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 6

Configuring SmartPlant Enterprise

Control Panel in Server Manager
Once SmartPlant Enterprise Control Panel has been installed, use SmartPlant Foundation
Server Manager to configure the following server settings for your SmartPlant Enterprise Control
Panel site:
 Install DLLs
 Update configuration XML files on a SmartPlant Foundation site
 Update database tables specific to SmartPlant Enterprise Control Panel
For more information about SmartPlant Foundation Server Manager, see the SmartPlant
Foundation Server Manager User's Guide.

Create a New SmartPlant Enterprise Control Panel

Site in Server Manager
1. Open SmartPlant Foundation Server Manager.
After installing SmartPlant Enterprise Control Panel on the SmartPlant Foundation
application server, the SmartPlant Enterprise Control Panel Sites node appears in the
tree view.

2. Select the SmartPlant Enterprise Control Panel Sites node.

3. Click New on the Server Manager toolbar.
You can also select the New SmartPlant Enterprise Control Panel Sites node, and
click Edit > New, or right-click the node and click New on the shortcut menu.

SmartPlant Enterprise Control Panel Installation and Setup Guide 27

Configuring SmartPlant Enterprise Control Panel in Server Manager

4. In the New SmartPlant Enterprise Control Panel Site dialog box, select a site to update
from the list, or type a new site name, and click Create.

The site node is added under the SmartPlant Enterprise Control Panel Sites. All
server DLLs are installed on the site and configuration XML files are updated.

 After creating the new SmartPlant Enterprise Control Panel site, close SmartPlant
Foundation Server Manager and recycle the Internet Information Services (IIS) application
pools for your project's site.
a. At the command prompt, type
%WINDIR%\Microsoft.NET\Framework64\v4.0.30319 to go to the .NET
Framework 4 64bit folder.
b. Type the commands:
aspnet_regiis-iru
iisreset
 You must reset IIS when installing a new site to avoid errors.
 After installing the server DLLs and updating the configuration XML files, perform a backup
of your SmartPlant Foundation database. For more information on backing up your
database, see the SmartPlant Enterprise Backup and Restore Guide delivered with
SmartPlant Foundation.

28 SmartPlant Enterprise Control Panel Installation and Setup Guide

SECTION 7

Setting Up and Configuring SmartPlant

Enterprise Control Panel Services
SmartPlant Foundation Desktop Client is used to set up and configure SmartPlant Enterprise
Control Panel services. To carry out configuration, the administrator of SmartPlant Enterprise
Control Panel must be an administrator of SmartPlant Foundation Desktop Client.
Administrators should perform the following tasks to set up and configure the SmartPlant
Enterprise Control Panel services:
 Import and load schema, domains, and administrative files on the SmartPlant Enterprise
Control Panel server.
 Configure security on the SmartPlant Enterprise Control Panel server.
 Import SmartPlant Enterprise Control Panel load data on to the SmartPlant Foundation
server.

Set Your Active Scope in SmartPlant Foundation to

Scope Not Set
Before setting up and configuring SmartPlant Enterprise Control Panel services, you must set
your SmartPlant Foundation Desktop Client active scope to your project.
1. Log on to SmartPlant Foundation Desktop Client as an administrator.
2. Click File > Set Active Scope.
3. Select Scope Not Set in the Create Scope list.
4. Click OK.

Import SmartPlant Enterprise Control Panel Load

Files
To import the SmartPlant Enterprise Control Panel load files use the SmartPlant Foundation
Loader:
1. Log on to SmartPlant Foundation Desktop Client as an Administrator.
2. Click File > Loader.
3. On the Loader dialog box, Browse to the location of the SPELoadFiles directory folder in
the Directory text box.

SmartPlant Enterprise Control Panel Installation and Setup Guide 29

Setting Up and Configuring SmartPlant Enterprise Control Panel Services

For example, <Drive>:\Program Files (x86)\SmartPlant\Enterprise

Control Panel\2013\SPELoadFiles.

4. In the Selected load file list box, select SPECP_1_LoadFiles.xmlldr.

5. Click Process.
6. Click Load Results to view the load process details.
7. Click Close.
8. Log out of SmartPlant Foundation Desktop Client.
9. Log in to SmartPlant Foundation Desktop Client again as an Administrator.
10. Ensure that the menu item SPECP Administration has been added to the menu bar in
SmartPlant Foundation Desktop Client containing the items Quick Find, Query and Create.

Mapping Tool Templates

During the load operation, a set of mapping tool templates is loaded into the database. These
mapping tool templates are used to convert signature data into tool items and help make the
conversion easier. These can be edited as required.
1. Click SPECP Administration > Quick Find > Mapping Tool Templates.
2. Click OK to display all items.

30 SmartPlant Enterprise Control Panel Installation and Setup Guide

 Setting Up and Configuring SmartPlant Enterprise Control Panel Services

If a tool is not being used by SmartPlant Enterprise Control Panel it can be deleted
from the list by right-clicking the item and selecting Delete or Terminate from the shortcut
menu.
The directory name associated with the tool is a location where the tool map file is
normally located. The location can be edited or the field left blank to be completed later as
required.
3. Select the tools that have a Map Directory.
4. Right-click the selected items and click List Edit.

5. Type the correct mapped directory path or leave the field blank and click OK.
After registering the tools to be used within the project, the conversion of signature
data to tool data needs to take place. This is normally done after the project is set up, but it can
be run after new tools are registered to a particular plant and you are ready to convert these
data. Where the tools are already registered, this function is a quick way of making the existing
project work with SmartPlant Enterprise Control Panel.
The user has the option to create the tool without converting the signature object.
For more information on signature data conversion, see the Registered Tool Conversion
Function in the SmartPlant Foundation Administration and Configuration Guide.

Log on to SmartPlant Enterprise Control Panel after

Server Installation
After installation of the SmartPlant Enterprise Control Panel setup files, the administrator has the
option to start the application from a shortcut icon on the desktop or by selection of an option on
the Start menu.
1. Click Start > All Programs > Intergraph SmartPlant Enterprise Control
Panel.>.SmartPlant Enterprise Control Panel.
2. The SmartPlant Enterprise Control Panel application starts up and displays the logon home
page screen. Enter your Username and Password to log on.
When a user logs on, SmartPlant Enterprise Control Panel logs that user into the last
project that was accessed. This data is stored in the settings.xml file. For example, this file is
located by default at:
C:\Users\username\AppData\Roaming\SmartPlant\Foundation\04.04.00
For more information on how to use the application, see the SmartPlant Enterprise Control
Panel User's Guide.

SmartPlant Enterprise Control Panel Installation and Setup Guide 31

Setting Up and Configuring SmartPlant Enterprise Control Panel Services

32 SmartPlant Enterprise Control Panel Installation and Setup Guide

APPENDIX A

SmartPlant Enterprise Control Panel

Launch Parameters
SmartPlant Enterprise Control Panel supports a set of parameters that can be used when
launching the application from the command line. The following section explains the parameters
that can be used when launching these applications.

Command Line Parameters

Command line parameters are typically used when launching SmartPlant Enterprise Control
Panel from another application. They allow you to control who the user logs in as, and what
plant/project access they have. The command line parameters can also be used to log on to the
SmartPlant Enterprise Control Panel client.
When launching SmartPlant Enterprise Control Panel from the command line, all parameters
begin with a slash ( / ), are uppercase, and require a space between the parameter and the
value. If the value contains spaces, it must be enclosed inside double quotation marks (" ").

Logon Parameters
Parameter Description
/U User
/P Password
/S server
/H Host
/W Web Directory
/PLANT Plant (Not implemented yet)
/PROJECT Project (Not implemented yet)
/ROLES Roles (Not implemented yet)
/Configuid Configuration UID (Not implemented yet)
/Secure True/False: If logging onto a server using SSL
Detailed below is the behavior, depending on the command line:
/U /P
This autopopulates the user name and password in the client.
/U /P /PLANT /PROJECT /S
This logs you in as the user specified with the plant/project specified on the given server if the
server is not authenticated. The user and password are ignored if the server is authenticated. If
the server is authenticated, the logon dialog box appears with the User name and Password
disabled, and the Server list is set to the correct server.

SmartPlant Enterprise Control Panel Installation and Setup Guide 33

SmartPlant Enterprise Control Panel Launch Parameters

/U /P /PLANT /PROJECT /H /W
This is the same as the previous example, but it uses the host and web directory instead of the
server.
/U /P /PLANT /PROJECT
A logon dialog box appears with the User name and Password boxes populated.
/S /PLANT /PROJECT
If the server is authenticated, this logs you on to SmartPlant Enterprise Control Panel. If the
server is not authenticated, the logon dialog box appears with the Server list disabled showing
the specified server.
/H /W /PLANT /PROJECT
Same as the previous example except that if the specified Web host and Web directory have not
been defined, a new server is created from these. If the new server is authenticated, this logs
you on. If the new server is not authenticated, the logon dialog box appears with the Server list
disabled showing the specified server.
/PLANT /PROJECT
This displays the logon dialog box, but once you have selected a server and logged on, the
specified Plant and Project are honored.

 If you do not specify any command line parameters, the logon dialog box appears.
 If you pick an authenticated server from the list, the User name and Password are disabled.
They are enabled if you pick a server that is not authenticated.
 If a server is not responding, a message box appears to tell the user, and the OK button is
disabled. The OK button is enabled if you select another server that is responding.
Examples
SECP_Client.exe /U SECP_username /P /S SECP1
SECP_Client.exe /U SECP_username /P /PLANT Plant1 /PROJECT Project1 /S SECP1

34 SmartPlant Enterprise Control Panel Installation and Setup Guide

Index

C S
Command Line Parameters • 33 Set Your Active Scope in SmartPlant
Configure Access Groups • 25 Foundation to Scope Not Set • 29
Configuring SmartPlant Enterprise Control Setting Up and Configuring SmartPlant
Panel in Server Manager • 27 Enterprise Control Panel Services • 29
Configuring SmartPlant Enterprise Control SmartPlant Enterprise Control Panel Client
Panel Security • 23 • 11
Create a New SmartPlant Enterprise SmartPlant Enterprise Control Panel
Control Panel Site in Server Manager • Hardware and Software
27 Recommendations • 11
Create a Silent Install Setup File • 18 SmartPlant Enterprise Control Panel
Create and Manage Role Assignments • 24 Launch Parameters • 33
Create SmartPlant Enterprise Control Panel SmartPlant Enterprise Control Panel Server
Users • 24 • 11
SmartPlant Foundation Security Model • 23
E
Enterprise Dataflow module • 7 W
Welcome to SmartPlant® Enterprise
I Control Panel • 7
Import SmartPlant Enterprise Control Panel
Load Files • 29
Install onto a Client Workstation • 21
Install Prerequisite Software • 21
Install Silently Using the Setup File • 18
Install SmartPlant Enterprise Control Panel
• 13
Install SmartPlant Enterprise Control Panel
in Silent Mode (Server Only) • 17
Installing SmartPlant Enterprise Control
Panel on a Client Workstation • 21
Installing SmartPlant Enterprise Control
Panel on the Application Server • 13
Internationalization • 8

L
Log on to SmartPlant Enterprise Control
Panel after Server Installation • 31

M
Mapping Tool Templates • 30

P
Preface • 5

SmartPlant Enterprise Control Panel Installation and Setup Guide 35