SPF Install
SPF Install
SPF Install
Version 2014
August 2013
DSPF1-PE-200001N
Copyright
Copyright 2002-2013 Intergraph Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
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 eCustomer, SharePoint, or
box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for
using a software product.
Terms of Use
a.
Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b.
For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensees internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensees internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
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 CORPORATIONS 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 Corporations software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a.
To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b.
To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www,bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List,
www.treas.gov/offices/enforcement/ofac/http://www.pmddtc.state.gov/compliance/debar.html, and the U.S. Department of State
Debarred List.
c.
To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d.
To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporations Export
Compliance Department, Huntsville, Alabama 35894, USA.
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.
Portions of the user interface copyright 2012 Telerik AD.
Contents
Preface .......................................................................................................................................................... 9
SmartPlant Foundation Product Documentation .................................................................................... 9
Documentation Comments ................................................................................................................... 13
Welcome to SmartPlant Foundation ..................................................................................................... 15
SmartPlant Foundation Internationalization .......................................................................................... 17
SmartPlant Foundation Hardware and Software Recommendations .................................................. 21
SmartPlant Foundation Recommendation Summary ........................................................................... 22
SmartPlant Foundation Database Server ............................................................................................. 23
SmartPlant Foundation Application Server ........................................................................................... 25
SmartPlant Foundation License Server ................................................................................................ 26
SmartPlant Foundation Alternate Server .............................................................................................. 27
SmartPlant Foundation File Server ....................................................................................................... 28
SmartPlant Foundation Workstation ..................................................................................................... 29
SmartPlant Foundation Web Portal Server ........................................................................................... 30
SmartPlant Foundation Web Portal Client ............................................................................................ 30
Setting Up Databases................................................................................................................................ 33
Setting Up the Database Server ........................................................................................................... 33
Install Database Software on the Database Server ....................................................................... 33
Create the SmartPlant Foundation Database Instance.................................................................. 34
Set Security on the Oracle Home Folder........................................................................................ 35
Maximum Positive and Negative Database Values ....................................................................... 35
Optimizing Oracle Databases ............................................................................................................... 36
Setting Up Database Access on the Application Server ....................................................................... 36
Install Database Software on the Application Server ..................................................................... 36
Set Up Database Access................................................................................................................ 37
Setting Up the Application Server ........................................................................................................... 39
Installing Prerequisite Software on the Application Server ................................................................... 39
Installing Software on the Application Server ....................................................................................... 40
Install Schema Component.NET .................................................................................................... 40
Install Schema Component ............................................................................................................ 41
Install SmartPlant Foundation ........................................................................................................ 42
Installing the Software in Silent Mode ............................................................................................ 44
Installing Hot Fix Packages ............................................................................................................ 47
Using Server Manager to Configure the Application Server ................................................................. 48
Configuring the Application Server ................................................................................................. 48
Defining the Application Server Default Folder Structure............................................................... 49
Granting Permissions ..................................................................................................................... 50
Setting Up Sites .............................................................................................................................. 53
Configuring Windows Server 2008 R2 .................................................................................................. 64
IIS Requirements for an Integrated Environment ........................................................................... 65
Configure Maximum Worker Processes ......................................................................................... 65
Minimum IIS Application Mappings ................................................................................................ 66
Contents
Define MIME Types ........................................................................................................................ 66
Suggested IIS Configuration Settings ............................................................................................ 69
Edit IIS Site Bindings ...................................................................................................................... 69
Configure Office Reference Files ................................................................................................... 71
Setting the Theme for Running the Desktop Client on the Server ................................................. 72
Configuring Security for the Application Server .................................................................................... 73
Changing Security Settings in Excel .............................................................................................. 73
IIS Security ..................................................................................................................................... 80
Set Up Integrated Windows Authentication .................................................................................... 80
Set Up HTTPS ................................................................................................................................ 83
Configuring FTR and Remote Services for HTTPS ....................................................................... 85
Permissions for SmartPlant Foundation Processes ....................................................................... 86
Security for IIS Sites ....................................................................................................................... 87
Port Assignments for SmartPlant Enterprise .................................................................................. 89
Upgrading SmartPlant Foundation .......................................................................................................... 93
Setting Up SmartPlant Foundation File Servers .................................................................................... 95
Remote File Service Overview.............................................................................................................. 96
Install the File Server Software ............................................................................................................. 97
Configuring Virtual Directories for a Remote File Server ...................................................................... 97
Configure a Remote File Service with Server Manager ................................................................. 98
Configure a Remote File Service Manually .................................................................................... 99
Configuring Vaults on the File Server ................................................................................................. 100
Setting up a Host for the File Server ............................................................................................ 101
Create a New Vault ...................................................................................................................... 103
Configure Document Management for a Vault ................................................................................... 104
Force a Class of Object to a Vault ................................................................................................ 105
Configuring Vault Replication.............................................................................................................. 105
Considerations for Setting Up Vault Replication .......................................................................... 108
Vault Replication Configuration Checklist .................................................................................... 108
Set Up Remote File Services for Vault Replication ...................................................................... 108
Relate Replicated Vaults to Source Vaults................................................................................... 109
Configuring SmartPlant Foundation ..................................................................................................... 111
Setting Up PDF Generation ................................................................................................................ 112
Configuring PDF Generation with SmartPlant Markup Plus ......................................................... 112
PDF Generation with Custom .INI Settings .................................................................................. 113
SmartPlant Foundation Settings for SmartPlant Markup Plus ..................................................... 114
Additional Settings and Tips Required for Generating a PDF/CSF ............................................. 115
Setting Up E-mail for SmartPlant Foundation ..................................................................................... 125
Change the E-mail Transport Method for SmartPlant Foundation ............................................... 125
Test Email Configuration Command ............................................................................................ 125
Setting Up an Alternate Scheduler Server .......................................................................................... 126
Setting Up Enhanced Mechanical Equipment Data Sheets ............................................................... 127
Install Enhanced Mechanical Equipment Data Sheets ................................................................ 127
Setting Up Enhanced Mechanical Equipment Data Sheets ......................................................... 128
Delivered Data Sheets.................................................................................................................. 130
Configuring the Security Model ........................................................................................................... 131
Security Model Configuration ....................................................................................................... 131
Enhancing Performance ..................................................................................................................... 131
Remove Audit Domain from an Upgraded Database ................................................................... 131
Contents
Setting Up a SmartPlant Foundation License Server .......................................................................... 133
Installing Prerequisite Software on the License Server ...................................................................... 134
Installing the SmartPlant License Manager Client on the License Server .......................................... 134
Configuring a License Server.............................................................................................................. 134
Defining the Application Server Default Folder Structure............................................................. 135
Grant permissions ........................................................................................................................ 135
Permissions Script Files ............................................................................................................... 137
Set Up a License Manager Site .......................................................................................................... 139
Start the license server wizard ..................................................................................................... 139
Configure the license server for performance .............................................................................. 142
Link the License Server to a SmartPlant Foundation Site .................................................................. 143
Configuring the SmartPlant License Manager Client .......................................................................... 143
Configuring Web Portals ........................................................................................................................ 145
Create a New Web Portal ................................................................................................................... 145
Delete a Web Portal ............................................................................................................................ 146
Add a Web Portal Server .................................................................................................................... 146
Modify Web Portal Server Settings ..................................................................................................... 146
Delete a Web Portal Server .......................................................................................................... 147
Configure the Web Portal Authentication Method............................................................................... 147
Configuring Integrated Windows Authentication (IWA) in a Double Hop Web
Portal Configuration ...................................................................................................................... 148
Move a Web Portal onto a New Server .............................................................................................. 150
Using the Web Portal with Microsoft Internet Explorer 8 or 9 ............................................................. 151
Add a Custom HTTP Header on the Web Portal Server .............................................................. 151
Add a Server to the Compatibility View Settings in Internet Explorer 8 or 9 ................................ 152
Setting Up Client Workstations .............................................................................................................. 153
Install Prerequisite Software on the Client Workstations .................................................................... 153
Permissions for Users on a Windows 7 Client with UAC Enabled ............................................... 154
Install Schema Component.NET......................................................................................................... 154
Install the Desktop Client .................................................................................................................... 155
Installing the Desktop Client in Silent Mode ................................................................................. 156
Disabling the Business Intelligence Module ....................................................................................... 156
Backing Up and Restoring Data ............................................................................................................. 157
Back Up the SmartPlant Foundation Server ....................................................................................... 157
Data Protection and Recovery for Installations Using Oracle ...................................................... 158
Data Protection and Recovery for Installations Using SQL Server .............................................. 159
Performing a Cold Database Backup on the SmartPlant Foundation Server .............................. 160
Restore SmartPlant Foundation Databases Using Oracle ................................................................. 160
Restore SmartPlant Foundation Databases Using SQL Server ......................................................... 161
Customer Support ................................................................................................................................... 163
Appendix A: Alternate Desktop Client Deployment ............................................................................. 165
Running Desktop Client from a UNC Share ....................................................................................... 165
Running Desktop Client from a URL ................................................................................................... 166
Increasing Trust for Deploying the Desktop Client ............................................................................. 167
Contents
Appendix B: Desktop Client and Web Portal Launch Parameters ..................................................... 169
Desktop Client Command Line Parameters ....................................................................................... 169
Parameter Formatting................................................................................................................... 169
Command Line Parameters ......................................................................................................... 170
API Parameters ............................................................................................................................ 171
Web Portal URL Parameters .............................................................................................................. 173
Appendix C: Configuring Citrix for SmartPlant Foundation ............................................................ 175
System Requirements for Citrix Servers ............................................................................................. 175
Install Citrix Software .......................................................................................................................... 175
Install and Configure the Software for Citrix ....................................................................................... 176
Appendix D: Configuring IIS Application Pools and User Accounts Manually ................................ 177
Create a New User Account for Application Isolation ......................................................................... 177
Creating and Configuring Application Pools in Windows Server 2008 ............................................... 178
Create a New Application Pool in Windows Server 2008 ............................................................ 179
Configure an Application Pool Identity Using a Configurable Account in Windows
Server 2008 .................................................................................................................................. 179
Assign the Software to an Application Pool in Windows 2008 ..................................................... 180
Configuring COM+ Applications in Windows Server 2008 ................................................................. 180
Configuring Folder Permissions in Windows Server 2008 ................................................................. 181
Appendix E: Setting Up a FLEXlm License Server .............................................................................. 183
Installing License Manager on a Remote Server ................................................................................ 183
Obtaining Your Host ID and Disk Serial Number ................................................................................ 184
Activating Licensing ............................................................................................................................ 184
Activate the Token License File ................................................................................................... 185
Glossary ................................................................................................................................................... 189
Index ......................................................................................................................................................... 209
Preface
This document contains information about the installation and configuration of SmartPlant
Foundation. This document is intended for system administrators and users who are installing
and setting up SmartPlant Foundation.
You can install SmartPlant Foundation as a stand-alone application or as part of SmartPlant
Enterprise. When you install SmartPlant Foundation as a stand-alone product, all the standard
SmartPlant Foundation data management functionality is available to you, but SmartPlant
Enterprise-specific authoring tool integration is not available. Typically, each customer uses
SmartPlant Foundation either as a stand-alone product or as part of SmartPlant Enterprise, but
not both.
If you want to install and configure SmartPlant Foundation and other products that
are part of SmartPlant Enterprise, see the Integration Setup Guide, delivered with SmartPlant
Foundation.
User's Guides
SmartPlant Foundation Desktop Client User's Guide - Provides instructions for creating,
viewing, updating, and managing objects and their relationships. Additionally, it provides
information about completing workflow steps and using SmartPlant Foundation in an
integrated environment.
SmartPlant Foundation Business Intelligence User's Guide - Provides information and
procedural instructions for using the SmartPlant Foundation Business Intelligence module.
SmartPlant Foundation Web Portal User's Guide - Provides instructions for using the
SmartPlant Foundation Web Portal.
Preface
Administrative Guides
Troubleshooting Guide
Reference Guide
10
How To Guide Master Table of Contents - Provides a copy of the table of contents of each
"How to" document in the SmartPlant Foundation documentation set. Use this document to
locate the guide that contains a particular topic without opening each "How to" guide to
search for the topic.
How to Configure the Authoring and Data Warehouse Models - Provides information for
system administrators on how to configure the authoring and data warehouse models in
SmartPlant Foundation and describes the underlying data model.
How to Configure Classified Objects - Provides information for system administrators on
how to configure classified objects in SmartPlant Foundation and describes the underlying
data model.
How To Configure the Consolidated Data Warehouse (CDW) - Provides information for
system administrators on how to configure the CDW in SmartPlant Foundation and
describes the underlying data model.
How to Configure Concurrent Engineering - Provides information for system administrators
on how to configure concurrent engineering in SmartPlant Foundation and describes the
underlying data model.
How to Configure the Data Sheet Model - Provides information for system administrators on
how to configure the data sheets model in SmartPlant Foundation and describes the
underlying data model.
How to Configure Document Management - Provides information for system administrators
on how to configure document management in SmartPlant Foundation and describes the
underlying data model.
How to Configure the GUI Model - Provides information for system administrators on how to
configure the graphical user interface (GUI) model in SmartPlant Foundation and describes
the underlying data model.
How to Configure the Infrastructure Model - Provides information for system administrators
on how to configure the infrastructure model in SmartPlant Foundation and describes the
underlying data model.
How to Configure the Line List Model - Provides information for system administrators on
how to configure the line list application in SmartPlant Foundation and describes the
underlying data model.
Preface
Integration Guides
11
Preface
load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation
database.
SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring
integrated SmartPlant Enterprise applications to run in a Citrix environment.
Programming Guides
To view customization and programming documentation for SmartPlant Foundation and
integration, browse to the ..\SmartPlant\Foundation\< version >ProgrammingHelp folder on a
computer where the SmartPlant Foundation server components are installed.
SmartPlant Foundation Server Customization Guide - Provides information for developers
on customizing the SmartPlant Foundation Server.
SmartPlant Foundation Client Customization Guide - Provides information for developers on
customizing the SmartPlant Foundation Client.
SmartPlant Foundation Web Portal Customization Guide
(SPFWebPortalCustomization.chm) - Provides information about customizing and
configuring the SmartPlant Foundation Web Portal.
SmartPlant Foundation Web Services Guide - Describes SmartPlant Foundation web
methods used for uploading data from and downloading data to the SmartPlant Foundation
Server.
SmartPlant Adapter Interfaces Reference Guide - Provides information for tool developers
about the interface classes used to communicate data between the authoring tool and the
common user interface and the common user interface and the tool adapter.
SmartPlant Common UI Interfaces Reference Guide - Provides information for tool
developers about the API exposed through the EFCommonUI.dll, which is used by authoring
tool developers to access integration functionality.
12
Preface
SmartPlant Metadata Adapter Reference Guide - Provides information for tool developers
about programming the metadata adapter. The tool metadata adapter allows communication
between the SmartPlant Schema Editor and the tool database to manage mapping between
the tool and the SmartPlant schema.
SmartPlant Schema Component API Reference Guide - Provides information for developers
about the Schema Component API.
SmartPlant Enterprise SmartPlant Adapter for SmartPlant Electrical - Describes the
SmartPlant Adapter details, functionality and configuration in SmartPlant Electrical.
SmartPlant Enterprise SmartPlant Adapter for SmartPlant Instrumentation - Describes the
SmartPlant Adapter details, functionality and configuration in SmartPlant Instrumentation.
SmartPlant Enterprise SmartPlant Adapter for SmartPlant P&ID - Describes the SmartPlant
Adapter details, functionality and configuration in SmartPlant P&ID.
SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D - Describes the SmartPlant
Adapter details, functionality and configuration in SmartPlant 3D.
SmartPlant Enterprise SmartPlant Adapter for PDS 3D - Describes the SmartPlant Adapter
details, functionality, and configuration in PDS 3D.
Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
(mailto:ppmdoc@intergraph.com?subject=documentation comments).
13
Preface
14
SECTION 1
15
SmartPlant Instrumentation, SmartPlant P&ID, and Aspen Basic Engineering . This integration
addresses the flow of data as it moves from one engineering application to another through its
lifecycle.
Integration provides the following features:
Transfer of engineering data from one tool to another, eliminating the need for manual
re-entry of data
Management of change resulting from ongoing engineering in upstream applications
Accessibility of engineering information to other collaborators without requiring the original
engineering tools
Recording of change in data as it moves through the plant lifecycle
Correlation of shared objects from multiple authoring tools. For example, the full definition of
a pump may come from multiple disciplines (electrical, mechanical, and so on), and the data
comes from different authoring tools.
Support for engineering workflows, especially versioning, approval/release, and
configuration control
At the center of integration is SmartPlant Foundation, which provides the repository for data
published by the authoring tools. Integration components make the exchange of data from the
authoring tools to SmartPlant Foundation and back possible.
For more information about installing SmartPlant Enterprise and the authoring tools, see the
Integration Setup Guide, delivered with SmartPlant Foundation.
16
Homogeneous Environments
When starting a new project, use extra care during installation and configuration to ensure the
proper creation and maintenance of homogeneous environments:
All the computers (servers and clients) within an integrated SmartPlant Enterprise
implementation must have the same regional settings, and no one should change the
regional settings after the project has started.
Do not cross the decimal locale boundary. This is the most common cause of numeric data
corruption and calculation errors. Having users with different regional settings (like with a
period versus a comma for the decimal point) causes the software to interpret values
unpredictably. For example, a pipe run with a pressure of 35.3 psi can be read by the
software as 353 psi to the user with different regional settings. A cable length defined as 39
ft 11,21 inches has been interpreted as 121718910971323 meters when published to an
XML file. These incorrect interpretations may be used in internal software calculations and
can be impossible to backtrack or correct. Do not change the decimal point character to try
to solve an issue. Doing so will only corrupt values in the database or in text files.
Do not cross the character-set locale boundary. For example, the character set boundary
between Western (Latin-based) and Eastern Europe (Cyrillic-based), or between Eastern
Europe and Japan.
Create Oracle databases using AL32UTF8 for the database character set and AL16UTF16
for the NLS character set.
Never modify the NLS_LANG registry entry on an Oracle client. Doing so causes the
character data not to convert to Unicode.
Create Microsoft SQL Server databases with locale-specific collation settings and ensure
that all databases have the same setting.
Heterogeneous Environments
In contrast, a heterogeneous environment using elements from different, or even multiple
locales, is not supported. Many customers are currently operating in unsupported
heterogeneous environments and are often not aware of that fact. Examples of heterogeneous
environments:
Entering or viewing Japanese data on an US/English operating system
Using German Regional Settings (where the decimal point is a comma) on a US/English
operating system
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
17
Oracle and MS SQL Server databases can reside on any language operating system, as
long as the databases have been created and configured with proper Unicode and collation
settings.
All SQL Server databases must have the same collation setting and reflect the master
language. Text is stored, sorted, indexed, and presented based on the collation setting. You
must determine which language will be used primarily to generate output (P&IDs, SLDs,
reports, approval documents, and so forth.) If Russian and English text is entered, and
Russian is the target locale, the chosen collation should be based on the Cyrillic character
set.
All Microsoft operating systems (Japanese, Russian, German, and so forth) can enter
English characters. The reverse, however, is not true in most cases.
Keyboard-locale can be changed as long as a character-set and code-page boundary is not
crossed. For example, English, German, French, and Spanish characters can all be used in
the same project because the same Windows code-page (1252) is used. However, Russian
characters (code-page 1251) cannot be used in a US/English environment.
You must decide which language operating system will be the master for bi- lingual projects.
The following is an example of a Russian-based project:
Companies in the United States and the United Kingdom are working a project with a Russian
company and the deliverables (drawings, reports, and so forth) must ultimately be provided in
Russian. The companies in the U.S. and the U.K. are working the project using the "master"
Russian operating systems (possibly using virtual Russian operating systems running on
VMware Workstation). The U.S. and U.K. companies can install and use English Microsoft
Office products on the Russian operating system because Office products are globally enabled.
If a Russian interface exists for the SmartPlant Enterprise application, then Russian users can
use the Russian interface while the English-speaking users would continue to use the
US/English interface. English-speaking engineers can enter English characters.
Russian-speaking engineers can enter Russian characters.
However, because the Russian locale uses different decimal and character-set locales,
everyone (English and Russian engineers) must use the Russian decimal symbol which is a
comma. For customization purposes, databases can be modified to accommodate new
Russian-specific requirements (fields, properties, and so forth.) Using filters, display sets, and
other software features, bi-lingual projects can be further customized. Graphic data, reports, and
so forth can be created in either or both languages.
Do not change regional settings to reflect a U.S. environment in order to resolve
problems in a non-US/English homogeneous configuration. Doing this creates a heterogeneous
configuration that will cause other possibly hidden problems that cannot be corrected. Everyone
working on a project must use the same regional settings and character set throughout the life of
the project.
18
19
20
SECTION 2
On the Windows Server 2008 platform, SmartPlant Foundation Core is a 64-bit application
with all other components (such as File Service and Remote Services) being 32-bit
applications. It was certified on 64-bit hardware with a 64-bit operating system (with IIS
configured to run SmartPlant Foundation Core as a 64-bit application and the other
components as 32-bit applications).
SmartPlant Foundation Desktop Client is a 32-bit application certified on 64-bit hardware
with a 64-bit operating system and 32-bit operating system.
For increased performance for the SmartPlant Foundation database server, Intergraph
recommends using a 64-bit database server.
Intergraph highly recommends installing database software on a database server separate
from the SmartPlant Foundation application server for improved performance.
SmartPlant Foundation supports the Enterprise Platform 2013, but is deferring support of
Microsoft SQL Server 2012 to a later release.
Intergraph recommends setting up Development and Test environments, in addition to the
Production environment, for preparing and testing updates, customizations, and other
configuration changes. For more information on how to set up these environments, contact
your Intergraph services team.
Full Text Retrieval is a 32-bit application and was certified on 64-bit hardware with a 64-bit
operating system.
21
22
Hardware Recommendations
These hardware recommendations are based on a 64-bit platform and should be used for
comparison with other hardware platforms.
8 core 3 GHz processor
32 GB RAM
Fast disk storage (for example, 1TB with I/O throughput better than 3GBps with 2 or more
data channels)
Data Backup/Recovery
1000 BaseT or higher network interface connection to the Application Server
Hardware sizing, especially for servers, depends on many factors such as the number
of concurrent users per site, the size of the project (which translates into the size of the
database), and other software that is running on the machine.
Multiple physical drives should be used on the database server to distribute file
read/write operations and improve performance. For example, the operating system
should be installed on its own drive, with separate drives containing the core database
files and user data files.
23
24
Hardware sizing, especially for servers, depends on many factors such as the number
of concurrent users per site, the size of the project (which translates into the size of the
database), and other software that is running on the machine.
These SmartPlant Foundation application server hardware recommendations also apply
to virtual servers hosted on Citrix XenServer. For virtual deployments, the same amount
of RAM, disk space, and CPU capacity that would be required for a similar physical
deployment should be available to the virtual machine.
Be sure to install the most recent Microsoft security patches, available from
http://www.microsoft.com/.
Windows Server 2008 R2 is supported with UAC enabled and set to Level 3 (Default).
For a server with more than four cores, the Enterprise edition of Windows Server 2008
R2 is required.
Both the Web Server (IIS) role and the Application Server role must be installed on the
server, with the ASP.NET, .NET Extensibility, Windows Process Activation Service
Support, TCP Activation, and Named Pipes Activation role services installed.
Software Prerequisites
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
Microsoft XML (MSXML) 6.0 (required for Schema Editor or data sheets only)
SmartPlant Schema Component.NET
25
SmartPlant Schema Component (required for integration with tools that do not support
Schema Component.NET)
Oracle 11g R2 64-bit client software (required if using Oracle database server)
Microsoft SQL Server 2008 Client Management Tools - Complete installation (required if
using SQL Server database server)
When you install Management Tools - Complete, the following additional required
tools are also installed: Client Tools Connectivity, Client Tools Backward Compatibility,
Client Tools SDK, and Management Tools.
Microsoft Office Excel 2007 or 2010 (with VBA installed)
SmartSketch 2011 R1, installed with the SmartSketch CAD Translators and Programming
Tools custom installation options (only required for automatic hotspotting with the
SmartConverter)
Some SmartSketch installations require SmartPlant License Manager. Ask your
system administrator or contact Intergraph Support Services if you have a question about
SmartSketch licensing requirements.
SmartPlant Markup Plus 2011 (available with Intergraph information management products
and required for viewing MicroStation V8, AutoCAD 2004 and later, Microsoft Office, PDF,
Solid Edge, or other third-party formats)
SmartPlant Markup Plus Server 2011 (required to perform View and Markup command with
Microsoft Office files)
SmartPlant Markup Plus Server must be installed on both the application server and
file server.
Hardware Recommendations
26
Be sure to install the most recent Microsoft security patches, available from
http://www.microsoft.com/.
Windows Server 2008 R2 is supported with UAC enabled and set to Level 3 (Default).
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
Microsoft XML (MSXML) 6.0
Oracle 11g R2 64-bit client software (required if using Oracle database server for
SmartPlant License Manager)
Microsoft SQL Server 2008 Client Management Tools - Complete installation (required if
using SQL Server database server for SmartPlant License Manager)
When you install Management Tools - Complete, the following additional required
tools are also installed: Client Tools Connectivity, Client Tools Backward Compatibility,
Client Tools SDK, and Management Tools.
SmartPlant License Manager 2012 client software (or greater)
Hardware Recommendations
Be sure to install the most recent Microsoft security patches, available from
http://www.microsoft.com/.
Windows Server 2008 R2 is supported with UAC enabled and set to Level 3 (Default).
Software Prerequisites
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
27
Hardware Recommendations
Be sure to install the most recent Microsoft security patches, available from
http://www.microsoft.com/.
Windows Server 2008 R2 is supported with UAC enabled and set to Level 3 (Default).
Software Prerequisites
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
SmartPlant Markup Plus 2011 (available with Intergraph information management products
and required for viewing MicroStation V8, AutoCAD 2004 and later, Microsoft Office, PDF,
Solid Edge, or other third-party formats)
SmartPlant Markup Plus Server 2011 (required to perform View and Markup command with
Microsoft Office files)
SmartPlant Markup Plus Server must be installed on both the application server and
file server.
28
Software Prerequisites
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
Microsoft XML (MSXML) 6.0 (required for Schema Editor or data sheets only)
Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (2.8.1) (required for Model
Loader)
SmartPlant Markup Plus 2011 (available with Intergraph information management products
and required for viewing MicroStation V8, AutoCAD 2004 and later, Microsoft Office, PDF,
Solid Edge, or other third-party formats)
Microsoft Office Excel 2007 or 2010 Service Pack 1
SmartPlant Client (required for integration)
SmartPlant Schema Component.NET
SmartPlant Schema Component (required for integration with tools that do not support
Schema Component.NET)
Active CGM 6.0 P7 (only required for existing .cgm files with SmartPlant Foundation 2D
Navigator, new conversions can use .igr files and SmartPlant Markup Plus)
29
Hardware Recommendations
Software Prerequisites
Microsoft Internet Explorer 9.0 (required for viewing the online documentation delivered with
the software)
Adobe Reader 9 or later compatible version, downloadable from the Adobe website
(required to view the Software License Agreement and Printable Guides)
Microsoft .NET Framework 4.5
30
The Web Portal supports Microsoft Internet Explorer 8 or 9 in IE-7 compatibility mode.
For more information on how to configure the Web Portal to work with Internet Explorer 8 or 9,
see Using the Web Portal with Microsoft Internet Explorer 8 or 9 (on page 151).
If a Web Portal client is expected to be used for viewing 3D models, the client configuration
should match the recommendations for SmartPlant Review Workstation. For more information,
refer to the SmartPlant Review Installation Guide.
31
32
SECTION 3
Setting Up Databases
This section describes how to set up your SmartPlant database server and database
connectivity on the SmartPlant Foundation server. Before you begin setting up your database
servers, verify that they meet the requirements described in SmartPlant Foundation Database
Server (on page 23).
Oracle Notes
For important internationalization information, see the Oracle encoding instructions in Create
the SmartPlant Foundation Database Instance (on page 34).
For Oracle databases, you must install Oracle Net Server and Client on the database
server.
On Oracle database servers, use Oracle Net Configuration Assistant to create a database
alias that SmartPlant Foundation can use to communicate with the database.
All domain verified user names and passwords must use ASCII7/English
characters. Oracle does not support non-ASCII / English characters in domain user names or
passwords and will not work. This limitation applies only to Oracle, not Intergraph.
33
Setting Up Databases
Microsoft SQL Server Notes
For SQL Server databases, there are internationalization considerations concerning the
collation settings you specify that relate to reference data, using SmartPlant Enterprise
integrated systems, Global Workshare Configuration, multiple locales, backup/restore,
reports, and upgrading to future releases.
Please contact Intergraph Customer Support for specific configuration questions about SQL
Server.
See Also
Optimizing Oracle Databases (on page 36)
Oracle
A single Oracle database instance must be created, which will contain one or more tablespaces
for SmartPlant Foundation data. No tablespaces need to be created at this time. They can be
created after the application software is installed.
SQL Server
Once the database server instance is running, no additional databases need to be created. The
databases can be created after the application software is installed.
Intergraph recommends that the name of the Oracle or SQL Server instance match the
name of the SmartPlant Foundation database.
All products in SmartPlant Enterprise that participate in integration should set their Oracle
11g encodings to the following:
a. Database Character Set option - Use Unicode (AL32UTF8)
See your Oracle documentation for information about changing the encodings on
your existing projects to match the AL32UTF8 setting.
b. National Character Set option - AL16UTF16 (the default)
The Default Language (American) and Default Date Format (America) options will, of
course, reflect locale-specific information.
The Oracle client installation does not involve any checking or modifying the Oracle client
character set. After the installation, you must not change any of the default values of the
NLS_LANG parameter on the client.
For more information about support and known issues for internationalization and
localization in SmartPlant Enterprise, request the SmartPlant Enterprise Internationalization
document from Intergraph Support.
See Also
Optimizing Oracle Databases (on page 36)
34
Setting Up Databases
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
For Oracle 11g, this is typically the Ora11g folder (for example,
D:\App\Administrator\product\11.2.0).
Right-click the ORACLE_HOME folder, and click Properties.
In the Properties dialog box, click the Security tab.
Click the Advanced button.
In the Permissions list verify that the Authenticated Users are listed with Read & Execute
in the Permission column and This folder, subfolders and files in the Apply to column.
If the permissions are not set correctly, select the appropriate row in the table, and click
Edit.
Make sure the Apply onto list contains This folder, subfolders and files and that the
appropriate permissions have been checked in the table. This should already be set
properly, but it is important that you verify this.
Click OK to close the Permission Entry for Checklists dialog box.
Select the Replace permission entries on all child objects with entries shown here that
apply to child objects check box.
Click OK until you close all the security properties dialog boxes. An hourglass cursor may
appear for a few seconds as the system applies the permissions you just changed to all
subfolders and files.
Restart the application.
Any application that is using Authenticated User privileges will not work. A notable
example is IIS, which might service some of the requests based on the Authenticated User
privileges.
See Also
Optimizing Oracle Databases (on page 36)
Oracle 11g R2
-7.92281625142643E+28
7.92281625142643E+28
-1.7976931348623E+308
1.7976931348623E+308
35
Setting Up Databases
After installing the Oracle client on the application server, the server should be
rebooted.
Oracle Net Server database software, to configure a local net service name pointing to the
database server.
For more information about installing Net Server, see the Oracle documentation.
For SQL Server database access, install the following:
Microsoft SQL Server Management Studio
Microsoft SQL Server client software
See Also
Configuring SmartPlant Foundation (on page 111)
Setting Up the Application Server (on page 39)
36
Setting Up Databases
If the Oracle database instance ever goes down, once it is restarted you must recycle
the IIS application pools on the SmartPlant Foundation application server in order to
restore their worker process connections to the database.
After installing the Oracle 64-bit client on the application server, the server should be
rebooted.
37
Setting Up Databases
38
SECTION 4
Roles
Role Services
ASP.NET
.NET Extensibility
Web Server (IIS) Support
Windows Process Activation Service Support
TCP Activation
Named Pipes Activation
You can install roles and role services on the application server using the Windows Server
2008 R2 Server Manager administrative tool.
39
Internet Explorer
Adobe Acrobat Reader (required to view the Software License Agreement and Printable
Guides)
MSXML (available during Setup from the Prerequisite Software link in the SmartPlant
Foundation Installation window)
.NET Framework (available during Setup from the Prerequisite Software link in the
SmartPlant Foundation Installation window)
The software checks for these prerequisites during installation.
For information on the required versions of the prerequisite software, see SmartPlant
Foundation Application Server (on page 25).
If you have previously installed Schema Component.NET, the software prompts you to
remove the older version of the Schema Component.NET before installing the new
version. After you uninstall the older version, click Schema Component.NET
Installation again in the SmartPlant Foundation Installation window.
The installation process checks whether Microsoft Excel is installed on the server. If
Excel is not installed, the Schema Component.NET installation will display a message
box stating that Excel is required. Click No to dismiss the message box and continue
the Schema Component.NET installation.
4. Click Next in the Welcome to SmartPlant Schema Component.NET Setup and Select
Optional Features dialog boxes.
40
If you have previously installed Schema Component, the software prompts you to
remove the older version of the Schema Component before installing the new version.
After you uninstall the older version, click Schema Component Installation again in
the SmartPlant Foundation Installation window.
The installation process checks whether Microsoft Excel is installed on the server. If
Excel is not installed, the Schema Component installation will display a message box
stating that Excel is required. Click No to dismiss the message box and continue the
Schema Component installation.
4. Click Next in the Welcome to SmartPlant Schema Component Setup and Select
Optional Features dialog boxes.
The Schema Editor, which allows you to view and edit the SmartPlant schema, tool
schemas, and authoring tool mapping, is installed with the Schema Component by default.
5. In the Select Program Folder dialog box, select an installation location and click Next.
6. Click Finish.
In order to uninstall Schema Component when it is installed on the same machine as
SmartPlant Foundation, you must always uninstall SmartPlant Foundation before uninstalling
Schema Component.
41
You can install the software in silent mode, which requires no user interaction as the
software installs. For more information, see Installing the Software in Silent Mode (on page
44).
For SmartPlant Basic Integrator, perform the installation below. Licensing determines the
features available to SmartPlant Basic Integrator.
1. Insert the SmartPlant Foundation CD into the CD-ROM drive. If the installation does not
start automatically, double-click setup.exe on the CD.
2. Click SmartPlant Foundation Installation in the SmartPlant Foundation Installation
window.
3. Click Next.
The SmartPlant Foundation installation stops IIS services when you click Next. The
software restarts these services after SmartPlant Foundation installation is complete. Be
sure that these services have started successfully before using the SmartPlant Foundation
software.
4. Enter your User Name, Company Name, and Serial Number, and then click Next.
5. Verify that the registration information is correct, and then click Yes.
6. Select your country from the list, and click Display to view the license agreement.
The license agreement is delivered as a PDF file; consequently, you must have
Acrobat Reader installed on your computer to view the license agreement.
7. Carefully read the licensing agreement. When you are finished, close the PDF file and click
Yes to accept the terms.
8. To accept the default installation location for SmartPlant Foundation, click Next.
If you want to change the installation location, click Browse and navigate to the new
folder. Then, click Next.
9. In the Setup Type dialog box, click Custom to select the SmartPlant Foundation software
that you want to install, and click Next. Selecting Custom allows you to install any
SmartPlant Foundation components, including server components.
10. In the Select Features dialog box, click Next to accept the default features.
To install individual components, click those components in the list. All items are selected by
default. Available components include the following.
SmartPlant Foundation Desktop Client - Installs the Desktop Client, which provides
the SmartPlant Foundation client functionality on the user's local computer. For the
Desktop Client to work properly, you must also install SmartPlant Foundation Server.
SmartPlant Foundation Server Components:
Server - Installs the SmartPlant Foundation Server.
License Manager - Installs the SmartPlant Foundation License Manager, which
controls licensing for SmartPlant Foundation. While this component does not have
to be installed on the SmartPlant Foundation server, there must be at least one
License Manager server in the SmartPlant Foundation architecture.
File Server - Installs a service that handles direct file transfer between vaults and
the SmartPlant Foundation client.
FTR Service - Installs the Full-Text Retrieval module, which allows you to store,
index, and search for text contained in or associated with objects managed by
SmartPlant Foundation.
42
Remote Services - Installs a set of web services that perform tasks such as printing
and titleblocking.
SmartPlant Foundation Web Portal - Installs the Web Portal, which provides a
web-based interface for accessing SmartPlant Foundation data.
You can clear the check boxes for any software that you do not want to install. However,
if this software installation is a modification to a previous installation, do not clear any
selected check boxes unless you want those components to be uninstalled.
You can install the File Server on the SmartPlant Foundation server, on both the
SmartPlant Foundation server and other computers, or on other computers besides the
SmartPlant Foundation server. For information on installing these components
elsewhere, see Configuring SmartPlant Foundation (on page 111).
11. Click Next.
At this point, the installation process checks whether the World Wide Web
Publishing service and IIS Admin service are installed. If these services are not installed,
warning dialog boxes will display to inform you that they are missing. Click OK to dismiss
each warning box. You can either click Cancel in the Installation for SmartPlant
Foundation dialog box to stop the SmartPlant Foundation installation, install the required
services while the SmartPlant Foundation installation dialog box is still displayed, or
continue with the SmartPlant Foundation installation and install the required services later.
12. To accept the default installation location for License Manager, click Next.
If you want to change the installation location, click Browse and navigate to the new
folder. Then, click Next.
13. Type the name of the SmartPlant Foundation Web server, and click Next.
If you make a typographical error in the host name you enter during the
software installation process, you may receive an error when you try to log on to any of the
SmartPlant Foundation software components. You can edit this value in
Desktop_Client.exe.config and SPFDataLoader.exe.config in the SmartPlant Desktop Client
program installation folder (for example, C:\Program
Files\SmartPlant\Foundation\2014\SPFDesktopClient\CurrentVersion).
14. Type the name of the virtual Web directory that maps to the physical folder that contains the
client .asp pages, and click Next.
After installation, you can edit this value in Desktop_Client.exe.config and
SPFDataLoader.exe.config in the SmartPlant Desktop Client program installation folder (for
example, C:\Program
Files\SmartPlant\Foundation\2014\SPFDesktopClient\CurrentVersion).
15. Select the program folder where you want SmartPlant Foundation to appear on your Start
menu, and click Next.
16. Verify the installation settings, and click Next to copy files to your computer.
If the settings are not correct, click Back to change the installation options.
17. Click Finish.
43
44
The /r parameter tells setup to automatically generate the silent setup file (setup.iss),
which is a record of the setup input.
The /f1"<path>\<filename>.iss" parameter specifies the path and filename for the
silent setup file. The double quotes are required around this path, with no space
between the /f1 and the opening double quotes. For example, if you type the following
command string, the software places the resulting silentsetup.iss file to the c:\installfiles
folder.
\\sourceserver\spf\setup.exe /r / f1"c:\installfiles\silentsetup.iss"
4. Work through the standard installation as documented in the component installation
procedure.
When you click Display on the License Agreement dialog box while running setup
in record mode, you are required to acknowledge that you are accepting the license
agreement for all users on whose computers you will install the product. Setup then returns
you to the normal installation process by displaying the license agreement and enabling the
Yes button on the License Agreement dialog box.
5. To silently install the software component using the newly created .iss file, open a
Command Prompt window on each computer on which you want to install the software and
type:
"<setup source folder path>\setup.exe" /s /f1"<path>\<filename>.iss"
/f2"<path>\<filename>.log"
Be sure to use the same setup executable that you used in step 3 of this
procedure.
The /s parameter tells setup to run in silent mode using the indicated .iss file.
The /f1"<path>\<filename>.iss" parameter specifies the path and filename for the
silent setup (.iss) file you want to run. The double quotes are required, with no space
between the /f1 and the opening double quotes. For example,
/f1"c:\installfiles\silentsetup.iss".
(Optional) Use the /f2"<path>\<filename>.log" parameter to record a log file of the
setup process. The double quotes are required, with no space between the /f2 and the
opening double quotes. For example, /f2"c:\installfiles\silentsetup.log". If /f2 is not
defined, a log file is created in the same location as the .iss file.
6. Check the .log file to ensure that the installation proceeded without errors. A successful
silent installation produces a .log file looking something like this:
[InstallShield Silent]
Version=v6.00.000
File=Log File
[ResponseResult]
ResultCode=0
[Application]
Name=SmartPlant Foundation
Version= 05.00.00.18
45
SERIALNUMBER=<serial number>
SLAACCEPT=Yes
46
To run the silent install, execute the msiexec.exe command defining parameters for the
software's MSI file.
The following example installs Schema Component.NET silently, accepting the SLA and
creating a log file:
msiexec.exe /qn /i INSTALLER PATH\Intergraph SmartPlant Schema
Component.NET 2014.msi" SLAAccept=Yes /l*v "E:\EFSchemLogNet.log"
47
48
49
Granting Permissions
Some basic folder permissions must be set in order for SmartPlant Foundation to run. The
following permissions are recommended in order for SmartPlant Foundation to run securely.
The server user needs access to the SmartPlant Foundation server directory.
The server user needs Read and Write access of the Temp folders (within the root path for
Server Manager).
The server user needs Read and List permissions for the Web_Sites folder (within the root
path for Server Manager).
Permissions can be set manually, or administrators can run scripts in Server Manager to grant
basic permissions.
50
Script
Purpose
SettingPermissions.bat
SettingPermissionsOracleClient.bat
SettingPermissionsLocalService.bat
Permissions
<drive>:\Program Files\SmartPlant
This folder, subfolder, and files
1.
2.
3.
4.
5.
6.
7.
For more information, see Permissions Script Files (on page 52).
Intergraph suggests you make a copy of the script file. Edit the copy, and then run the script
file from the copy.
Start SmartPlant Foundation Server Manager. The first time you start Server Manager, the
program prompts you to run batch scripts to set basic permissions.
Click No on the dialog box to set up permissions at a later time.
Browse to the script files. The scripts can be found in the UsersAndPermissionsScripts
folder (for example, browse to C:\Program
Files\SmartPlant\Foundation\2014\ServerManager\UsersAndPermissionsScripts).
Make a copy of the script file.
Using the copy of the script file, edit the keywords in the permissions script with the required
values.
Double-click the script name to run and set permissions.
Repeat steps 3-6 for each script file.
51
SettingPermissions.bat
For Windows Server 2008, this file gives the following permissions to the SPFUsers group in the
following folders.
Directory
Permissions
%SystemRoot%\Temp
This folder, subfolders, and files
%SystemRoot%\System\inetsrv\config
This folder, subfolder, and files
<drive>:\Program Files\SmartPlant\Foundation
This folder, subfolder, and files
Description
1%
2%
3%
4%
5%
SettingPermissionsOracleClient.bat
For Windows Server 2008, this file gives the following permissions to the SPFUsers group on
the Oracle client home directory.
52
Permissions
The following table lists the variables for the script file.
Variable
Description
1%
2%
SettingPermissionsLocalService.bat
For Windows Server 2008, this file sets permissions for Local Service if using a 64-bit operating
system and IIS 7.
Directory
Permissions
%SystemRoot%\Temp
This folder, subfolders, and files
The following table lists the variables for the script file.
Variable
Description
%1
%2
Setting Up Sites
A SmartPlant Foundation site contains the server configuration and connection settings for
accessing and managing your plant and project data in the database.
Each site is defined as either a primary or secondary site.
A primary site contains the SmartPlant Foundation application server, file service, cache,
and configuration services.
A secondary site contains the SmartPlant Foundation application and communicates with
the existing cache and configuration services on the primary site. Secondary sites are
optional and can be used to offload the scheduler service from the primary site's server.
Each primary site is associated with a virtual directory in IIS. When you create a new
primary site, this virtual directory is also created.
An optional secondary site can be set up only on a different server from the one where the
primary site is set up; this allows you to offload the scheduler from the primary SmartPlant
Foundation server to an alternate secondary server.
53
You can create and manage sites according to your data-modeling needs. For example, you
might have a single primary site containing one or more plants on a single server, or have a
single primary site with a secondary site on another server to offload the scheduler, or you
might have multiple sites on a single server, using a different site per plant. Maintaining
multiple sites on a single server requires multiple, customized versions of the SmartPlant
schema file. See the SmartPlant Schema Editor Users Guide for information about
customizing SmartPlant schema files.
The SmartPlant Foundation Sites node contains all sites created on the server on which
Server Manager is running.
Site nodes - Each represents a site. The Settings node under each site node contains
configuration information for that site, such as the database user IDs, data sources, and
passwords.
System Settings node - Used to configure registry settings that are available for the Server
component. The settings configured in this node apply to all the sites in the SmartPlant
Foundation Sites node.
You must have IIS installed on your computer before you can use this command.
Intergraph recommends that you add and delete sites only through the Server Manager
application. Do not use IIS to delete any virtual directories created using this command.
Creating a new site also creates a set of virtual directories in Internet Information Service
(IIS) on your computer.
You can allow the wizard to automatically create local users on the operating system, set
them to run as the identity of the related application pool, and set permissions for the users.
If you prefer to do this manually, refer to Appendix D: Configure the Software to Run
Independently of Other Applications (see "Appendix D: Configuring IIS Application Pools and
User Accounts Manually" on page 177).
The wizard logs information about site creation in a log file located in the
Temp\ServerManager directory of the default path (for example, C:\SmartPlant Foundation
2014 Server Files\Temp\ServerManager). The log file name is SiteCreation#date_time#.log,
where #date_time# represents the date and time of the database creation (for example,
SiteCreation6.20.2014_3.46.log).
The operation of the wizard differs depending on the type of site you are creating.
54
When creating a new site for a SQL Server database, please note the following:
When the application server is separate from the database server and you are using a
backup file to load the data schema to the database, you must share the folder in which
the file is located before you run the New Site Wizard. When specifying the path to the
backup file in the wizard, you must use UNC format. (For example,
\\SPFServer\SQLDataShare\SPF42ADW.BAK)
If you are using one of the delivered backup files, after you copy the file to the shared
folder, you must unzip the file before you run the wizard. By default, this zip file is
delivered in \Program Files (x86)\SmartPlant\Foundation\2014\Database\SQL Server.
See Completing the Configuration of a New Site (see "Complete the Configuration of a New
Site" on page 56) for information about ensuring optimum performance.
Server Manager uses template script files for importing dump files and for creating new sites
using new databases. See Database Creation Script Files (on page 59) for information about
modifying the template script files.
When a new site is created, the trace log file paths for the server, cache service, and
configuration service are automatically created. For more information, see the Setting Up
SmartPlant Foundation Logging section in the SmartPlant Foundation Troubleshooting
Guide.
If multiple sites share the same SmartPlant schema file, then any changes that you
make to the shared schema file will affect every site. Therefore, Intergraph strongly
recommends that you make a copy of the delivered SmartPlant schema folder for each
site. Store each customized folder within the site folder, for example,
<drive>:\SmartPlant Foundation 2014 Server
Files\Web_Sites\<site_name>\EFSchema.
The folders containing the customized schema files must be shared with Read-only
access. The path to these files can be either a path to a location on the local computer
or a UNC path to a location on a remote computer.
55
56
The case sensitivity of Quick Find operations will always respect the user preference
setting Case Sensitive quick find, regardless of the value of this property.
For newly created sites, the default setting of this property is True. For sites upgraded
from a previous version, if this property is not present in the site's list, the property is
added to the site and set to False.
UnderscoreIsWildcard - Indicates that the underscore character is used in object name
searches as a wildcard. If set to True, underscore is a wildcard in name searches that return any
single character. If set to False, underscore is not a wildcard in the search. Default is False.
Databasetype - Type of database software used on the database server (ORACLE for Oracle
or SQLSERVER for MS SQL Server).
DefaultConfigTreeLevels - Number of levels required in the plant breakdown structure (PBS).
ProgressLogDirectory - Physical location to which progress log files are stored.
FileServiceDirectory - Name of the virtual directory that this site will use for file service
operations.
FileServiceTimeout - Period of time, in milliseconds, before a file service operation on the
server will time out. Default timeout is set to 40000 milliseconds.
RemoteServiceTimeout - Period of time, in milliseconds, before a remote service operation on
the server will time out. Default timeout is set to 40000 milliseconds.
FTRServiceTimeout - Period of time, in milliseconds, before a FTR service operation on the
server will time out. Default timeout is set to 100000 milliseconds.
XMLCompression.Enabled - Indicates if XML compression is enabled for sending data from
this site to other SmartPlant Foundation components. This setting does not affect the
compression of files stored in vaults; these files are always compressed regardless of this
setting.
Email:DefaultFromAddress - Sets the return address for system-generated Emails sent by
SmartPlant Foundation.
Email:MailClient - Type of Email client software used by SmartPlant Foundation (CDO or
JMAIL) to send Emails.
Email:SMTPHost - Name of the Email server used by SmartPlant Foundation to send Email.
DisableAutoLogin - Indicates if pass-through login is allowed; if disabled, SmartPlant
Foundation will always prompt for credentials.
SiteSchemaLocation - Physical location of the EFSchema configuration file (EFSchema.cmf).
The default location for the delivered SmartPlant schema CMF file and folder
structure is <drive>:\Program Files\Common Files\Intergraph\EFSchema.
If multiple sites share the same SmartPlant schema file, then any changes that you
make to the shared schema file will affect every site. Therefore, Intergraph strongly
recommends that you make a copy of the delivered SmartPlant schema folder for each
site. Store each customized folder within the site folder, for example,
<drive>:\SmartPlant Foundation 2014 Server
Files\Web_Sites\<site_name>\EFSchema.
The folders containing the customized schema files must be shared with Read-only
access. The path to these files can be either a path to a location on the local computer
or a UNC path to a location on a remote computer.
For more information about configuration files, see the Schema Editor User's Guide.
The SmartPlant schema configuration file is delivered with the SmartPlant Server and Client
components. By default, it is installed in the following location: ..\Program Files\Common
Files\Intergraph\EFSchema.
DefaultPublishWorkflow - Specifies the workflow the published documents will be submitted to
automatically, if a workflow is not selected in the Publish UI.
57
58
59
Template_CreateTableSpaces.sql
This file is used for Oracle databases to create the Data permanent and temp databases.
If the tablespace selected by the user in the New Site Server Wizard already exists, the
creation of the tablespace will not be included in the file generated from the template file.
Variable
Description
#DATA_TS#
#DATA_TEMP_TS#
#DEFAULT_PATH#
Template_CreateUsers.sql
This file is used for Oracle databases to create the Data users.
Variable
Description
#DATA_USER#
#DATA_PWD#
#DATA_TS#
#DATA_TEMP_TS#
Template_NewSiteOracle.bat
This file is used to login into the Oracle database and execute the CreateTableSpace and
CreateUsers script files. It also launches the Oracle imp.exe command to import the Data
dump file.
Variable
Description
#SYS_USER#
#SYS_PWD#
#DATASOURCE#
#FROM_USER_DATA#
60
#DATA#
#DATA_DUMP#
#DATA_LOG#
Template_ImportOracle.bat
This batch file is used for importing an Oracle dump file into a database that already has the
tablespaces and the users already created. Some of the information populated in this script is
retrieved from the global.asa file for that site.
Variable
Description
#USER_ID#
#USER_PWD#
#DATASOURCE#
#FROM_USER#
#TO_USER#
#DUMP_FILE#
#DUMP_LOG#
Template_CreateDBSQL.sql
This template is used to create the database. This will create the MDF and the LDF files for the
SQL Server Data database.
Variable
Description
#DATA_DB#
61
Description
#DATA_USER#
#DATA_PWD#
#DATA_DB#
Template_ImportDumpSQL.sql
This template is used to import the dump files into the Data database.
Variable
Description
#DATA_DB#
#DATA_DUMP#
#FROM_USER#
#DATA_USER#
#DEFAULT_PATH#
Template_NewSiteSQL.bat
This batch file is used to login into SQL Server and to execute the following script files:
CreateDBSQL, CreateLoginSQL, and ImportDumpSQL.
62
Variable
Description
#SYS_USER#
#SYS_PASS#
#DATASOURCE#
Description
#USER_ID#
#DUMP_FILE#
#FROM_USER#
#MDF_PATH#
The fully qualified path to the MDF file that will have
the dump file imported into.
#LDF_PATH#
The fully qualified path to the LDF file that will have
the dump file imported into.
Template_ImportSQL.bat
This batch file is used to login into the SQL Server database and to execute the ImportSQL file
to import a dump file either into the Data database.
Variable
Description
#SYS_USER#
#SYS_PWD#
#DATASOURCE#
63
Configure IIS 7
In previous versions of IIS, the worker processes ran as the LocalSystem account. Because the
LocalSystem account has access to almost all of the resources that are on the operating
system, there are serious security implications. IIS 7 offers better security because the worker
process runs under the default application pool identity, Network Service.
In IIS 7, you can configure the application pool identity to choose the account under which the
worker processes will run. You have the option of using one of the three predefined accounts or
creating your own account.
The IIS_IUSRS group is a user group provided by IIS 7. IIS_IUSRS group membership provides
the minimum set of user rights and permissions required to run an application. It provides a
convenient way to use a specific user account, which would be a member of IIS_IUSRS, for the
application pool identity without having to manually assign the user rights and permissions to
that account. In a case where the user account is not in the IIS_IUSRS group and it does not
have the appropriate permissions, the worker process serving the application pool will fail to
start.
64
65
Extension
SPFServer
SPFCacheService
.asmx, .svc
SPFConfigService
.asmx, .svc
SPFViewDir
none
SPFFileService
SPFRemoteServices
When you create a site with SmartPlant Foundation Server Manager, the software sets
many of the necessary MIME types on the Web site for you. Before adding MIME types, be
sure that Server Manager has not already added the ones you need. By default, MIME types
are configured in the SPFViewDir site.
Set MIME types at the Web site level, not the server level.
1. On the application server, open the Control Panel.
2. Open Administrative Tools > Internet Information Services.
66
If the Features View window is not visible, right-click the site in the tree view and
select the Switch to Features View command.
67
For more information about choosing the correct MIME type for a file type, see the
Microsoft IIS Help.
If you do not know the correct MIME type for a file extension, you can use
application/octet-stream as the default.
6. Click OK to save the new MIME type.
68
Properties
Default Value
Updated Value
200000
1073741824
Queue Length
3000
6000
4194304
1073741824
25
100
These settings are suggestions only. You can fine tune the settings based on your
performance requirements. See the Microsoft Support Knowledge Base for more information
on IIS configuration.
Properties set at the server level will apply to all sites on that server.
The ASP role service must be installed in IIS in order to access these configuration
properties.
If you configure automatic recycling of your application pools while also running
scheduled tasks in SmartPlant Foundation, be sure to set the application pool's Shutdown Time
Limit for a duration that would allow all scheduled jobs in progress to complete should the
recycle be initiated while the job is still running. For example, if a scheduled task such as a load
operation could take twenty minutes to complete, make sure the Shutdown Time Limit (in
seconds) is set to a value greater than twenty minutes.
69
6. Type * in the Binding information field to show all bindings and click OK.
70
8. Type 808:* in the Binding information text box to show the bindings and click OK.
71
6. On the Select Users, Computers, Service Accounts, or Groups dialog box, click Object
Types... to open the Object Types dialog box.
7. Select the types of objects you want to find and click OK on the Object Types dialog box.
8. On the Select Users, Computers, Service Accounts, or Groups dialog box, select
Locations... to open the Locations dialog box.
9. Browse to and select a location and click OK on the Locations dialog box.
10. On the Enter the object name to select section of the Select Users, Computers, Service
Accounts, or Groups dialog box, type the name of the file service user. For example, type
SPFFileServer.
11. Click Check Names to verify the correct name.
12. Click OK on the Select Users, Computers, Service Accounts, or Groups dialog box to
add the user.
13. Click OK on the Administrators Properties dialog box to save the settings and close the
dialog box.
14. Close the Computer Management window.
72
73
74
75
10.
11.
12.
13.
Click OK.
Click OK in the Options dialog box to save your changes.
Close Excel.
Log out of the server computer.
The above procedure lowers the security for only the one logged-in user. If necessary, you
can set the default macro security settings for all users on the computer by editing the following
registry key to add the value shown.
Intergraph recommends only experienced users edit the registry settings.
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\12.0\Excel\Security]
"AccessVBOM"=dword:1
On a 64-bit system, the registry key is located at
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Office\12.0\Excel\Security
76
77
78
10.
11.
12.
13.
Click OK.
Click OK in the Options dialog box to save your changes.
Close Excel.
Log out of the server computer.
The above procedure lowers the security for only the one logged-in user. If necessary, you
can set the default macro security settings for all users on the computer by editing the following
registry key to add the value shown.
Intergraph recommends only experienced users edit the registry settings.
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\14.0\Excel\Security]
"AccessVBOM"=dword:1
On a 64-bit system, the registry key is located at
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Office\14.0\Excel\Security
79
IIS Security
There are two IIS security scenarios for which SmartPlant Foundation can be configured:
Anonymous Authentication
Integrated Windows Authentication
For information on IIS 7.0 security/permissions, please refer to the following article:
http://support.microsoft.com/kb/981949 http://support.microsoft.com/kb/981949.
Anonymous Authentication
Anonymous users are used for running all server-side processes; these are the only SmartPlant
Foundation/IIS users.
80
81
82
Set Up HTTPS
If the application server is to be set up for a secure HTTPS connection, perform the following
procedure.
1. Install an SSL Certificate.
2. Configure the Desktop Client for secure communications.
83
3. Modify the server name to reflect the fully qualified domain name, for example <add
key="server_name.domain_name.com"
value="server_name.domain_name.com:SPF42Server" />.
4. Add the three Boolean values True:True:True to the line as shown below.
The values correspond to the properties Secure:Internet:IWA. The third True value
enables Integrated Windows authentication (IWA). If you are using IWA, for more
information, see Set Up Integrated Windows Authentication (on page 80).
5. Save and close the config file.
Your changes are reflected in the Logon Information dialog box when you log in to the
Desktop Client. The Secure Channel (SSL) option is checked.
84
85
Oracle Client
Make sure the entire Oracle Client folder from the root drive has read/execute/list permissions
propagated for the IIS users.
Directory
Permissions
.NET Framework
Make sure all the .NET Framework directories from the root drive have read/execute/list
permissions propagated for the IIS users.
Directory
Permissions
%SystemRoot%
This folder and files
%SystemRoot%\System32
This folder and files
%SystemRoot%\System32\Inetsrv
This folder, subfolders, and files
%SystemRoot%\Microsoft.NET
This folder, subfolders, and files
%SystemRoot%\Globalization
This folder, subfolders, and files
86
File Access
Debug/Logs - Make sure all the debug log directories have read/execute/list/write
permissions for SmartPlant Foundation/IIS users if logging is being used.
SmartPlant Foundation Program Files - Make sure all the SmartPlant Foundation
program directories have read/execute/list permissions for the SmartPlant Foundation/IIS
users.
Directory
Permissions
<drive>:\Program Files\SmartPlant\Foundation
This folder, subfolder, and files
SmartPlant Foundation Vaults - Make sure all the vault directories have
read/execute/list/write permissions for the SmartPlant Foundation/IIS users.
System Temp Directory - Make sure the system temp directory has read/execute/list/write
permissions for the SmartPlant Foundation/IIS users.
Directory
Permissions
%SystemRoot%\Temp
This folder, subfolders, and files
RSA Container
Make sure the user account that runs your SmartPlant Foundation application pools in IIS has
read/execute/list permissions.
These permissions should be applied only to the user account that runs your SmartPlant
Foundation application pools:
Directory
Permissions
C:\Program Data\Microsoft\Crypto\RSA
This folder, subfolder, and files
COM+ Access
Directory
Permissions
READ, WRITE,
EXECUTE, LIST
%SystemRoot%\Temp
This folder, subfolders, and files
READ, WRITE,
EXECUTE, LIST
87
88
Comments
80
TCP
From workstation to
server
139, 445,
137, 138
TCP
From workstation to
server; from server to
workstation
3389
TCP
From workstation to
server
8575
TCP
From workstation to
server; from server to
workstation
89
90
Comments
80
TCP
From workstation to
server
1521, 1526
TCP
From workstation to
server; from server to
workstation
1158
TCP
From workstation to
server
5560, 5580
TCP
From workstation to
server
443
TCP
From workstation to
server
7809
TCP
7810-7820
TCP
Comments
1433
TCP
From workstation to
server; from server to
workstation
1434
UDP
From workstation to
server; from server to
workstation
91
92
SECTION 5
93
94
SECTION 6
95
1.
2.
3.
4.
5.
File upload
1.
2.
3.
4.
5.
6.
7.
96
9.
10.
11.
12.
If you want to change the installation location, click Browse and navigate to the new
folder. Then, click Next.
In the Setup Type dialog box, click Custom, and click Next.
In the Select Components dialog box, click File Server, and click Next.
Select the program folder where you want SmartPlant Foundation to appear on your Start
menu, and click Next.
Verify the installation settings, and click Next to copy files to your computer.
If the settings are not correct, click Back to change the installation options.
13. Click Finish.
97
The only virtual directories that are required for remote file services are the two file
service virtual directories (for example, SPFViewDir and SPFFileService).
98
99
Enter the name SPFViewDir for the Alias, set the Physical path to the directory you
created in the earlier step, and click OK.
4. Edit the web.config file in the File Service virtual directory, ensuring that the following path
points to the location of the SPFViewDir virtual directory on the remote file server:
<add key="SPFViewDir" value=" " />
5. Set permissions for file service access on the remote file server.
For details about the directories that require permissions to be set, see the File Server
Access section of Permissions for SmartPlant Foundation Processes (on page 86).
100
If a vault is related to an owning group, objects associated with that owning group are stored
in the vault.
If a vault is related to a configuration (such as a plant), objects associated with that
configuration item are stored in the vault.
For more information on relating owning groups and configurations to a vault, as well as
using object interface relationships to set conditions on the objects directed to a vault, refer to
How to Configure Document Management.
3. Click Finish to create the new host. The new host displays in the New Items window.
101
When you create an organization, you can associate it with one or more hosts. You define the
host of your external organization on the New External Company form. You define the host of
your new internal organization host on the New Department/Office form.
If you did not associate the organization with a host when it was created, you can create the
relationship by dragging the host on the company object.
For more information, see SmartPlant Foundation How to Configure the Infrastructure Model.
102
Do not use numbers for the leading characters of the vault name if you will be
performing batch print, PDF generation, titleblock, or archive and purge operations on
files in the vault. These operations fail if the name begins with numeric characters. For
example, "Vault1001" is acceptable, but "1001Vault" is not.
Do not use spaces in the vault name.
Do not start the name of the vault with the letter combination "xml".
Local path
Host
Name of the host for this vault. The host (web server) is
where the vault is located.
103
Plant Configuration
When relating a vault to a plant or other configuration level, document objects that are
associated with that configuration level are stored in the related vault. A vault that is related to
a particular configuration item, such as a plant, can contain objects associated with
sub-configurations below that level, such as projects related to a plant. Separate vaults can
also be created for each sub-configuration level.
For example, a vault related to the ConfigurationTop level can act as a default vault, since
objects related to all sub-configurations can be published to that vault. While an object
associated with a particular plant, such as PlantA, can be published to a vault related to
ConfigurationTop, the object cannot be published to a vault that is related to another
configuration at the same level, such as PlantB, or to a project within another plant hierarchy.
Owning Group
SmartPlant Foundation has two ownership relationships. You can configure an object to be
owned by a user or by an owning group, which is why groups are more commonly referred to as
owning groups. The link between users and owning groups is not a simple relationship; it is via
the user's role.
Owning groups are typically configured to set up ownership of data by department or discipline.
Owning groups can be used to control the users access to an object or parts of an object based
on its ownership. This control operates independently of domains and configurations, both within
and across multiple domains and configurations. Access control by object ownership can be
configured to control the following:
Shortcut menu command access (for example, check out of a document)
Menus and toolbar access (for example, for the process group)
Query access to objects (for example, documents)
In cases where an object might be placed in one vault because of its applicable
configuration and another vault because of its relation to an owning group, the owning group
relationship takes precedence over the configuration relationship. In this situation, the object
would be stored in the vault that is associated with the owning group.
104
105
106
When a user requests to download a file from a vault on file server 1, the server checks the file
server host for the user who is downloading the file and uses this to determine the server from
which to download the file. The server determines that users located at the remote site are
associated to file server 2 and therefore the server downloads the files from this server.
All users downloading files from vaults on file server 2 retrieve files directly from file server 2
regardless of their location, because the replication flag for the file server is set to false.
Server Identification
If a file is viewed, and replicated vaults are being used, it is necessary to know which file server
to view the file from. To achieve this:
Create a new relationship definition between Host and Organization
(SPFOrganizationFileServerHost).
Because a user probably belongs to an Organization, a collection of the file hosts that a user
wants to define as his local set can be configured by attaching the hosts to the organization
object and ensuring that the user is a member of the correct Organization.
When a file is viewed, its vault and therefore its host can be derived.
If a host is related to the users organization, it is considered as a local host to the user
(User-Organization-Host). If the host derived from the file is local to the current user, the file
is directly viewed.
If the host is not local to the current user, SmartPlant Foundation checks if this vault is
replicated to any of the local hosts for the current user. If so then the file is directly viewed
from the local host. If such a host is not found, the file is viewed remotely from the original
host.
107
108
109
110
SECTION 7
Setting up printing
For more information about these and other configuration tasks, see How To Setup and
Configure SmartPlant Foundation.
111
For a complete list of available .INI parameters, refer to the SmartPlant Markup Plus User's
Guide, Appendix A.
For SmartPlant file formats, a printer named SmartPlant PDF Converter 452 is installed on
the SmartPlant Foundation application server when SmartPlant Markup Plus is installed.
This printer is used for PDF generation and should not be removed or used for any other
purpose.
For SmartPlant file formats, the command line dmredl.exe -p obj.Name -pdf $OUTPUTDIR
is added as the Alternate Rendition application. For information on adding arguments to this
command line, refer to the SmartPlant Markup Plus User's Guide.
For non-SmartPlant file formats, either spm -pdf or dmredl.exe -p obj.Name -pdf
$OUTPUTDIR can be added as the Alternate Rendition application. For information on
adding arguments to this command line, refer to the SmartPlant Markup Plus User's Guide.
For non-SmartPlant file formats, if the dmredl.exe command is used as the Alternate
Rendition application, a separate scheduler task is created. If the spm -pdf command is
used as the Alternate Rendition application, no scheduler task is created (and the PDF
should generate faster).
SmartPlant Instrumentation file types (.brw, .ssf, .spd) cannot be viewed by SmartPlant
Markup Plus and cannot be generated into PDF format by SmartPlant Markup Plus. These
files can be generated into PDF format within SmartPlant Instrumentation before being
published to SmartPlant Foundation (which can then be viewed and printed using
SmartPlant Markup Plus).
112
Custom .INI file settings are supported for SmartPlant file formats only. For non-SmartPlant
file formats, custom .INI file settings are not supported. The following instructions can only
be used for SmartPlant file formats.
For a complete list of available .INI parameters, refer to the SmartPlant Markup Plus User's
Guide, Appendix A.
To generate a PDF with custom settings, you can specify the .INI file that contains the custom
settings using the -i switch in the command line of the Alternate rendition application text box.
For example, to print a watermark diagonally on each page of the PDF, you can add the
following to an .INI file (named CustomSettingsFile1.ini in this example):
[SPMParameters]
PrtWaterMarkText=TEST WATERMARK3
PrtWaterMarkPosition=2
PrtWaterMarkFontName=Arial
PrtWaterMarkFontSize=48
To include the custom settings for PDF generation, include the .INI file containing these settings
in the command line as shown:
dmredl p obj.Name $OUTPUTDIR i "C:\CustomSettingsFile1.ini"
More than one .INI file can be included in the Alternate rendition path. The following is an
example for specifying multiple .INI files:
dmredl p obj.Name $OUTPUTDIR i "C:\CustomSettingsFile1.INI" i
"D:\CustomSettingsFile2.INI" i "E:\CustomSettingsFile3.INI"
All the settings in the .INI files supplied in the Alternate rendition path are concatenated on
execution. If two or more .INI files contain the same settings, the settings in last .INI file listed in
the Alternate rendition path will be take the precedence.
For example, if the file CustomSettingsFile1.INI contains the setting PrintRange=0 (current
view), but in the file CustomSettingsFile3.INI the setting value is 2(All), the PDF will be
generated with PrintRange=2(All), which is taken from the CustomSettingsFile3.INI file.
113
Before completing the rest of the installation, you must install SmartPlant Foundation Server
and Desktop Client on your computer. Be sure to create a site using SmartPlant
Foundation Server Manager.
114
6.
7.
8.
9.
115
116
117
6. Click Cancel.
118
4. Close Notepad.
Login Tasks
1.
2.
3.
4.
5.
6.
7.
8.
9.
119
120
2.
3.
4.
5.
6.
7.
9. Click OK.
121
8. Click OK.
9. Restart your Job Processor service. With the previous Microsoft Office configuration
changes, Microsoft Excel files with macros will successfully convert to the PDF/CSF
formats.
122
123
124
Valid values are JMAIL for JMAIL and CDO for CDOSYS. CDO is the default
value.
Email::SMTPHost -- Enter the name of your SMTP mail server.
Email::DefaultFromAddress -- Enter the mail address to be used in the From field for
system E-mails.
See Also
Test Email Configuration Command (on page 125)
125
3.
4.
5.
6.
7.
Ensure the secondary scheduler server is set to use the same Config Service
Name as the primary server, for example SPFConfigService.
On the client computer, configure a server site (SPFSite object) that contains the URL to the
dedicated scheduler server secondary site and relate it to the scheduler object.
On a client computer connected to the primary server, create a site object with the File >
New > Administration > Server Site command. When you create the site object, select the
Is Active option.
Find the scheduler object you want to run on the secondary alternate server with the Find >
Administration > Schedulers command. You can also create new scheduler objects.
Drag and drop the site onto the scheduler to create the relationship. This relationship directs
the scheduler tasks to the alternate server.
If the scheduler is already started, stop and restart the scheduler to make the change.
126
1.
2.
3.
4.
5.
You must have the SmartPlant Foundation software, including the server components,
installed before installing the data sheets if you plan to use the Enhanced Mechanical Data
Sheets for SmartPlant Foundation. Installation of SmartPlant Foundation is not required to
use the Enhanced Mechanical Data Sheets for Excel.
You can install the software in silent mode, which requires no user interaction as the
software installs. For more information, see Installing the Software in Silent Mode (on page
44).
Double-click setup.exe to begin the installation.
Click Next in the Welcome window.
Enter your User Name, Company Name, and Serial Number in the Customer
Information window, and click Next.
Review the information in the Registration Confirmation window, and click Yes to
continue, or click No to go back and make changes.
In the Select Features dialog box, do one of the following:
Check the For Excel check box to install Enhanced Mechanical Data Sheets for Excel.
Check the For SmartPlant Foundation check box to install Enhanced Mechanical Data
Sheets for SmartPlant Foundation.
127
128
7. Optional. Example equipment data is delivered that can be used for demonstration
purposes. The example data is not required to configure equipment data sheets.
Select the file EFSchema_MechEQDAuth_Examples.xmlldr and repeat steps 5 and 6 to
load the example data.
129
130
Enhancing Performance
SmartPlant Foundation can be configured to enhance performance.
131
132
SECTION 8
For information on the recommended hardware and required software for a license server,
see SmartPlant Foundation License Server (on page 26).
If you are currently using FLEXlm as your license manager, you can continue to use it but
must perform the additional configuration procedures in this section to use it with this version
of SmartPlant Foundation.
For information on installing and setting up the SmartPlant License Manager server
software, refer to the SmartPlant License Manager Installation and User's Guide. For
information on installing and setting up a new FLEXlm license server, refer to Appendix E:
Setting Up a FLEXlm License Server (on page 183). FLEXlm is available only to existing
customers who are already using FLEXlm for SmartPlant Foundation licensing.
133
The license server requires access to the database server. The recommended client for
that database should be installed and tested before you begin to configure the license
server.
You should also make sure that the IIS service is installed on the server before installing the
licensing software.
134
Grant permissions
Some basic folder permissions must be set in order for SmartPlant Foundation to run. The
following permissions are recommended in order for SmartPlant Foundation to run securely.
The server user needs access to the SmartPlant Foundation server directory.
The server user needs Read and Write access of the Temp folders (within the root path for
Server Manager).
The server user needs Read and List permissions for the Web_Sites folder (within the root
path for Server Manager).
Permissions can be set manually, or administrators can run scripts in Server Manager to grant
basic permissions.
135
Purpose
SettingPermissions.bat
SettingPermissionsOracleClient.bat
SettingPermissionsLocalService.bat
All three batch files call XCACLS.vbs. All files are delivered in the UsersAndPermissionsScripts
folder (for example, browse to C:\Program
Files\SmartPlant\Foundation\2014\ServerManager\UsersAndPermissionsScripts). A log file for
the permissions scripts can be found at [drive]:\SmartPlant Foundation 2014 Server
Files\Temp\ServerManager\Permissions.log. For more information, see Permissions Script Files
(on page 52).
For more information, see Permissions Script Files (on page 52).
Intergraph suggests you make a copy of the script file. Edit the copy, and then run the script
file from the copy.
1. Start SmartPlant Foundation Server Manager. The first time you start Server Manager, the
program prompts you to run batch scripts to set basic permissions.
2. Click No on the dialog box to set up permissions at a later time.
136
SettingPermissions.bat
For Windows Server 2008, this file gives the following permissions to the SPFUsers group in the
following folders.
Directory
Permissions
%SystemRoot%\Temp
This folder, subfolders, and files
%SystemRoot%\System\inetsrv\config
This folder, subfolder, and files
<drive>:\Program Files\SmartPlant\Foundation
This folder, subfolder, and files
Description
1%
2%
3%
4%
137
Description
5%
SettingPermissionsOracleClient.bat
For Windows Server 2008, this file gives the following permissions to the SPFUsers group on
the Oracle client home directory.
Directory
Permissions
The following table lists the variables for the script file.
Variable
Description
1%
2%
SettingPermissionsLocalService.bat
For Windows Server 2008, this file sets permissions for Local Service if using a 64-bit operating
system and IIS 7.
Directory
Permissions
%SystemRoot%\Temp
This folder, subfolders, and files
The following table lists the variables for the script file.
138
Variable
Description
%1
%2
Intergraph recommends that you add and delete sites only through the Server Manager
application. Do not use IIS to delete any virtual directories created using this wizard.
Only one license server virtual directory is allowed to be configured per machine.
If you already use FLEXlm as your license server, you must configure a new license server
in order to continue using it with this version of SmartPlant Foundation.
FLEXlm is only supported on 32-bit operating systems. SmartPlant License Manager is
supported on both 32-bit and 64-bit operating systems.
Creating a license server site also creates a virtual directory in IIS that points to the
licensing data source.
The new license server wizard checks for the existence of a web.config file. If none is
present an error message is displayed. If one exists the process continues.
FLEXlm and SmartPlant License Manager both handle the general check in and check out
of licensing. You can track how many users concurrently access the software, helping you to
comply with the Software Licensing Agreement.
The wizard displays the Create local operating system users for site application
pools option. The option is selected by default, and it creates local users on the
operating system, sets them to run as the identity of the related application pool, sets
permissions for the users, and adds the local user to the SPFUsers group. If you prefer
to perform this process manually, do not select the option and refer to Appendix D:
Configuring IIS Application Pools and User Accounts Manually in the SmartPlant
Foundation Installation Guide.
Do not use special characters in the virtual directory name. Special characters cause
errors if used.
139
Server names should not exceed 20 characters. If you allow the wizard to create local
users for the license server application pools, your server name should not exceed 20
characters. The wizard uses the license server name for the user name and Windows
local user names cannot exceed 20 characters.
The wizard creates an application pool with the same name as the virtual directory
value.
The wizard updates the SPFAppServer.config files of the sites selected at the end of the
process. It will add a new entry to the SPFAppServer.config file, which allows the
administrator to direct each site to a license server. For example:
<add key="LicenseServerURL"
value=http://localhost/SPFLicenseServer />
If no site was selected or none exists, click Next and the license server site creation
continues. However, you have to manually go to the SmartPlant Foundation site's
settings in Server Manager and add the license server URL you want to use. See Link
the License Server to a SmartPlant Foundation Site (on page 143) for further
information.
2. Click Next.
140
An example of the default script to create tables for an Oracle site can be found at:
C:\Program
Files(x86)\SmartPlant\Foundation\2014\ServerManager\DatabaseScripts\Template_SP
LMDbaseTablesOracle.sql
If you are using an existing Oracle database, this option and the boxes for the Oracle
tablespace and temp tablespace are disabled.
1. If you want to save the script path for future operations, select the Save as default option.
2. Select the Oracle tablespace from the list of valid tablespaces, or type the name of the
tablespace.
By default, the name of the new tablespace created appears in the list as the name of
the site with a suffix of _Data.
The name of the temp tablespace created appears in the list as the name of the site
with a suffix of _DataTemp.
3. Select an Oracle temp tablespace, or type the name of the temp tablespace.
4.
5.
6.
7.
8.
9.
The name of the temp tablespace to be created appears in the list as the name of the
site with a suffix of _DataTemp.
In the Database username box, type the name of the Oracle user who owns the objects in
the Data database schema.
Type and then confirm the Database password for the Oracle database user.
Click Next to display the Ready to Create License Server page.
Review the new server parameters, and click Back to make any changes.
Click Next. The Server Creation Status displays as the site is created, and then the After
License Server Creation page displays.
Read the information about the additional steps required to fully configure the new server,
and then click Finish to create the server. The new server appears in the tree view.
For more information about fully configuring the server, see Configure the license server for
performance (on page 142).
At the end of the process the wizard adds a new entry to each selected site's
SPFAppServer.config file, which allows the user to direct each site to a license server. For
example:
<add key="LicenseServerURL" value=http://localhost/SPFLicenseServer />
141
2.
3.
4.
5.
6.
7.
8.
9.
An example of the default script to create tables for a SQL server site can be found at:
C:\Program Files
(x86)\SmartPlant\Foundation\2014\ServerManager\DatabaseScripts\Template_SPLMD
baseTablesSQL.sql
If you are using an existing SQL Server database, this option and the boxes for the
physical database file and log file location are disabled.
If you want to save the current path for future operations, select the Save as default option.
Accept the default Physical database file location.
Accept the default Log file location.
In the Database username box, type the name of the database user who owns the objects
in the data database schema.
Type and then confirm the Database password for the SQL Server database user.
Click Next. The Ready to Create License Server page displays. Review the new server
parameters, and click Back to make any changes.
Click Next. The Server Creation Status displays as the site is created, and then the After
License Server Creation page displays.
Read the information about the additional steps required to fully configure the new site, and
then click Finish to create the site. The new site displays in the tree view.
For more information about fully configuring the server, see Configure the license server for
performance (on page 142)..
At the end of the process the wizard adds a new entry to each selected site's
SPFAppServer.config file, which allows the user to direct each site to a license server. For
example:
<add key="LicenseServerURL" value=http://localhost/SPFLicenseServer />
142
For detailed information and procedures on configuring the license server, and IIS and
security settings in particular, refer to the Configuring Windows Server 2008 section of the
SmartPlant Foundation Installation and Setup Guide or the Integration Setup Guide.
143
144
SECTION 9
An application pool is created with the same name as the web site virtual directory
value.
The Create local operating system users for site application pools option is
selected by default, and it creates local users on the operating system, sets them to run
as the identity of the related application pool, and adds the local user to the SPFUsers
group. If you prefer to perform this process manually, uncheck this option and refer to
Appendix D: Configuring IIS Application Pools and User Accounts Manually (on page
177).
5. Click OK and the Web Portal is added as a sub-node under the root Web Portals node.
When installing a Web Portal on the same server as the SmartPlant Foundation server, any
sites that have already been created are added to the Web Portal automatically. If the Web
Portal is being added on a stand-alone server, or if a site has not been created before the
Web Portal is created, you must add the server manually. For more information, see Add a
Web Portal Server (on page 146).
After a Web Portal has been created, the Web Portal Path property is read-only and cannot
be modified. To change the location of the files, a new Web Portal must be created.
145
3.
4.
5.
6.
7.
You can also access the New command in Server Manager by selecting the Web
Portal in the tree view and then clicking Edit > New.
In the Name box, enter a name for the Web Portal server, which will appear in the
drop-down list of servers when a user logs into the Web Portal.
In the Web host box, enter the computer name of the SmartPlant Foundation server.
In the Web directory box, enter the SmartPlant Foundation site name.
Click Validate to ensure that Server Manager can locate the server and site.
Click OK at the prompt and the Web Portal server is added as a property of the Web Portal
node.
You can add more than one server to a Web Portal if you have multiple sites on your
SmartPlant Foundation server.
If your web server uses an alternate port number (other than port 80), add a colon and the
port number in the Web host property value, as in localhost:8080.
3.
4.
5.
6.
7.
146
You can also access the Properties command in Server Manager by selecting the
server in the tree view and then clicking Edit > Properties.
In the Name box, enter a name for the Web Portal server, which will appear in the
drop-down list of servers when a user logs into the Web Portal.
In the Web host box, enter the computer name of the SmartPlant Foundation server.
In the Web directory box, enter the SmartPlant Foundation site name.
Click Validate to ensure that Server Manager can locate the server and site.
Click OK at the prompt and the Web Portal server is updated.
Anonymous
Authentication
Integrated Windows
Authentication
Integrated
Windows
Authentication
Basic Authentication
Basic
Authentication
Comments
To edit the web.config file and set the Impersonate attribute to True
1. Open the web.config file for editing in Notepad (or another text editor).
The file is located at the root of the Web Portal web directory (for example,
C:\SmartPlant Foundation 2014 Server Files\WebPortals\SPFWebPortal).
2. Locate the <system.web> section of the file.
147
148
Search for the string "requireSSL =" and set the value to True. You must also
uncomment this line.
4. In IIS, open the Authentication feature for the web site.
5. Select Windows Authentication and click Providers.
6. Ensure that NTLM is set as the top provider in the list.
149
150
5. Type X-UA-Compatible in the Name box, and type IE=EmulateIE7 in the Value box.
6. Click OK.
7. Reset IIS.
You can also edit the Web Portal file directly (either default.aspx or defaultall.aspx) and add
the meta tag at the top of the <Head> section:
<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" />
151
2. Type the name of the server to add in the Add this website box.
3. Click Add to add the server to the Websites you've added to Compatibility View list.
All Web Portal sites on the server added to this list are displayed in compatibility
mode.
4. Click Close.
To ensure that Web Portal sites viewed directly on the Web Portal server display correctly,
add localhost to the compatibility view list for the instance of Internet Explorer 8 or 9 installed on
the Web Portal server.
152
SECTION 10
153
Microsoft XML (MSXML) (available during Setup from the Prerequisite Software link in the
SmartPlant Foundation Installation window)
If a workstation will be used only to connect to a SmartPlant Foundation Web Portal via a
Web browser, you do not need to perform any other installations on the client workstation.
The Web Portal is not compatible with Internet Explorer 8 or 9 Standards mode. To connect
to a Web Portal with Internet Explorer 8 or 9, you must use Internet Explorer 8 or 9's
Compatibility View functionality. See Add a Server to the Compatibility View Settings in
Internet Explorer 8 or 9 (on page 152) for more information.
To connect to a SmartPlant Foundation Web Portal, enter the server name and Web Portal
virtual directory name in the Address line of the Web Browser, using the form
http[s]://<spf_server_name>/<web_portal_name> (ex.: http://SPFServer/SPFWebPortal).
For more information on using a SmartPlant Foundation Web Portal, refer to the SmartPlant
Foundation Web Portal User's Guide.
See Also
Install the Desktop Client (on page 155)
Setting Up Client Workstations (on page 153)
Permissions
<drive>:\Program Files\SmartPlant
This folder, subfolder, and files
154
If you have previously installed Schema Component.NET, the software prompts you to
remove the older version of the Schema Component.NET before installing the new
version. After you uninstall the older version, click Schema Component.NET
Installation again in the SmartPlant Foundation Installation window.
The installation process checks whether Microsoft Excel is installed on the server. If
Excel is not installed, the Schema Component.NET installation will display a message
155
The environment of the computer on which you run the normal setup to create the .iss file
and of the workstations on which you perform the silent mode installation must be identical;
that is, they must have the same database platforms, software versions, installed files, and
so forth. For example, if you create the .iss file and install the software on D drive, you must
have a D drive on all the workstations.
156
SECTION 11
157
Templates
Make backups of any templates stored in the <drive>:\Program
Files\SmartPlant\Foundation\2014 folder (for example, Excel templates, report templates, or
data sheet templates).
IIS Configuration
Refer to your Windows documentation for details about backing up your IIS configuration.
158
159
160
161
162
SECTION 12
Customer 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
(mailto:PPOdoc@ingr.com?subject=Documentation Comments).
163
Customer Support
164
SECTION 13
165
The copied and shared directory structure should have no less than what is shown below:
The CurrentVersion folder contains the client assemblies, so the path to the executable
would be similar to this:
\\<SPFServer>\<SPFDesktopClientShare>\CurrentVersion\Desktop_Client.exe
where <SPFDesktopClientShare> is the name of the share.
For information about parameters for launching the Desktop Client, see Desktop Client
Command Line Parameters (on page 169) in the SmartPlant Foundation Installation and
Setup Guide.
Before you can run the software using a URL, you must:
Have a valid client installation, either local or UNC install.
Start the Desktop Client manually to create the settings.xml file in the C:\Documents
and Settings\[YourUserName]\Application Data\SmartPlant\Foundation\[version] folder.
Then, when you use the SPFLaunch.exe command, the settings.xml file is updated to
include an entry for the local computer.
Set the Execute Permissions for the virtual directory to Scripts only.
For information about parameters for running the Desktop Client from a URL, see
Desktop Client Command Line Parameters (on page 169).
166
167
168
SECTION 14
Parameter Formatting
When launching the Desktop Client from the command line, all parameters that 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 ( ), as shown in
the following example.
When launching the Desktop Client using a URL, the command line parameters must be
specified in a URL format. In this case, the first parameter must be separated from the
SPFLaunch.exe command with a question mark ( ? ), and subsequent parameters must be
separated by an ampersand ( & ). Spaces in the URL format are denoted by a tilde ( ~ ).
Forward slashes (/) must be replaced with %5C. You might use forward slashes in the path
to the log file, for example.
169
Description
User name
Password
PLANT
Plant name
PROJECT
Project name
Host
Web directory
CURRDIR
Current directory
SECURE
DEBUGLOG
Path and file name for a debug file. This parameter is only
valid for URLs.
The following details logon parameter behavior, depending on what you specify in the command
line or URL. The following are provided in command line format. They can also be used in the
URL format.
/U /P /PLANT /PROJECT /S
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
boxes disabled, and the Server list to select the correct server.
/U /P /PLANT /PROJECT /H /W
Same as the previous example, but 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 command logs you on to the Desktop Client. Otherwise, the
Logon dialog box appears with the Server list disabled, but displays the specified server.
If the server specified is not defined, a message box appears to inform the user, and the logon
process stops.
/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. Otherwise, the Logon dialog box appears with the Server list disabled, but displays
the specified server.
/PLANT /PROJECT
Displays the Logon dialog box, but once you select a server and log on, the specified Plant and
Project is honored.
170
If you do not specify any command line parameters, the Logon dialog box appears.
If you select an authenticated server from the list, the User name and Password boxes are
disabled. They are enabled if you select 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.
When using the /SECURE switch, you may need to adjust the timeout setting in your
web.config file to keep the login attempt from timing out while the secure login is processing.
If this occurs, add or edit the following key in the web.config file with the following value:
<add key="IsResponding.Timeout" value="600" />.
The logon parameters are case-sensitive.
Examples
Desktop_Client.exe /U abc /P /S SPF42
Desktop_Client.exe /U abc /P /PLANT Plant1 /PROJECT Project1 /S SPF42
http://server/SPFServer/DesktopClient/Apps/SPFLaunch.exe?U=superuser&P=&CONFIGUID=P
LANT_NAME&H=server&DEBUGLOG=C:%5Ctemp5Cspflaunch.log&W=SPFSite
API Parameters
At logon, it is possible to launch any of the APIs available. APIs are divided into those that
require an object and those that do not.
Parameter
Required object
Description
API
API name
SINSTANCE
True or False
ARG1
First argument
ARG2
ARG3
Third argument
ARG4
Fourth argument
ARG5
Fifth argument
ARG6
Sixth argument
ARG7
Seventh
argument
ARG8
Eighth argument
CRITERIA
Search criteria
To launch an API from the command line, you need the /API parameter. The arguments are
optional and depend on the API being used. To launch an API from a URL, use the API= syntax
followed by the name of the API and any parameters for that API. For example,
PI=QFindObject&ARG1=Change&ARG4=*.
To launch an API on an object, the following parameters are mandatory.
CLASS classname
NAME name of item
The CRITERIA argument is optional.
Examples
Desktop_Client.exe /PLANT Plant1 /PROJECT ProjectA /API Navigate /ARG1 FRAME /CLASS
DocRevision /Name DOC-ACCREP-003
171
172
Description
user or u
User name
password or p
User password
plant
Plant name
project
Project name
configuid
roles
Role name
server or s
host or h
Host name
webdir or w
Web directory
secure
task
DisableAutoLogin
Launching Web Portal using a URL uses parameters including a single character (u) or the full
name (user). The following are valid parameters: user or u, password or p, server or s, host or
h, and webdir or w. For example:
http://nodename/directory/Default.asp?user=jqpublic&password=MyPassword&class=userinbox
or
http://nodename/directory/Default.asp?u=jqpublic&p=MyPassword&class=userinbox
When both user and u are used in URL parameters, the full-named parameter will be used. For
example, if the following is provided by the user,
http://demo/SPFWebPortal/Default.aspx?u=JohnDoe&user=JDoe&p=pwjdoe&server=url-demo
the URL will become,
http://demo/SPFWebPortal/Default.aspx?user=JDoe&password=pwjdoe&server=url-demo.
To launch the API, you need the &api parameter. The arguments are optional and depend on
the API being used.
173
Description
api
class
Class name
name
uid
arg1 - arg14
criteria
In order to call an API, you must provide an API name and its required and proper arguments for
that API (in order to run API from URL). Each API has its own arguments, and you can find the
arguments for a client API by searching for that API.
The following is an example URL to call ViewAndNavigate which displays SmartPlant Markup
Plus in the Web Portal.
http://demo/SPFWebPortal/Default.aspx?u=jdoe&p=jdoepwd&s=url-demo&API=Navigate&Class
=SPFDesignDocVersion&Arg1=FRAME&Arg3=True&Name=3D-CivilPlans_003
This URL logs in to the SmartPlant Foundation Web Portal site url-demo with user name jdoe
and password jdoepwd. Once logged in, a design document of 3D-CivilPlans_003 is located
(including an attached file). Then, SmartPlant Markup Plus displays in the Web Portal as a
frame. If there are any redline objects in the file, they also display.
Example URLs
The following URL launches the Web Portal and uses the Navigate API to open a specific
version (revision 2A, version 2) of the specified document (SB101).
http://localhost/SPFWebPortal/Default.aspx?server=localhost&API=Navigate&Class=SPFDesign
DocVersion&Arg1=OPEN&Name=SB101&Arg8=2&Arg9=A&Arg10=2
The following example URL launches the Web Portal and displays the details dialog box for the
SPFPlant named PlantA.
http://SPFServer/SPFWebPortal/?&api=ShowObj&class=SPFPlant&name=PlantA
The example below opens the appropriate drawing using the value specified for ARG1, and
highlights in the drawing the object specified by the CLASS and NAME arguments.
http://spfdev1/SPFWebPortalDemo3/default.aspx?server=SPF42DemoServer&API=ViewInDraw
ing&ARG1=EDG_LatestVersionsContainingDrawingItem&CLASS=SPFTEFSharedEquipment&
NAME=T-181
As shown in the following example, you must include the SECURE parameter, and set the value
to true, if you are using a secure site (https).
https://spfsrv64a/spfwebportal/default.aspx?user=sbarakam&password=&secure=true&server=l
ocalhost_SPFSRV64aAUTH&api=QFindObject&arg1=ISPFDesignDocVersion&arg2=False&Crit
eria=*
174
SECTION 15
When you access applications 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 run 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
becomes inactive. This disconnects the current session and can even cause applications to
close on the server. A connection break off during such an activity can cause damage to
your database.
We suggest that you perform administrative activities either on your database server
computer or on a client computer using a configuration other than Citrix.
Citrix Prerequisites
See the Citrix documentation for system hardware and software requirements for the Citrix
software.
To install software on a Citrix server, you must log on to the computer as an
administrator.
175
176
SECTION 16
177
The IIS_WPG group has Read and Execute, List Folder Contents, and Read permissions on
every Web site directory by default. When this account is not in the IIS_WPG group and
does not have the appropriate permissions, the worker process will fail to start.
For more information about creating user accounts or adding users to groups, see the
Microsoft Windows documentation.
3. Repeat this procedure for each new user account you have created.
178
179
180
2.
3.
4.
5.
6.
7.
8.
9.
10.
For more information, see Permissions for SmartPlant Foundation Processes (on
page 86).
Right-click the folder and select Properties from the shortcut menu.
Select the Security tab on the Properties dialog box.
Click Edit to open the Permissions dialog box.
Remove LocalService, if desired.
Click Add to open the Select Users, Computers, Service Accounts, or Groups dialog
box.
Type the name of a user.
Click Check Names to verify the name of the user.
Select a user name and click OK.
Click OK.
For more information about creating user accounts or adding users to groups, see the
Microsoft Windows documentation.
181
182
SECTION 17
3.
4.
5.
6.
183
Activating Licensing
The SmartPlant Foundation License Manager node in SmartPlant Foundation Server
Manageris used to configure a SmartPlant Foundation license server to use either a FLEXlm
license or a SmartPlant Foundation License Manager license.
FLEXlm Properties
Site Path Physical path to the SmartPlant Foundation license server files (physical location of
the virtual directory).
Site Virtual Directory Name of the license server as defined in IIS
LicType Specifies that the license is a FLEXlm license type
File - Location of the notification file the software sends to the system administrator. The
notification file is a text file that you can customize with a message reminding your system
administrator to order more tokens.
License - Location of the token pool license file (tknpool.dat). If License Manager is installed on
another server, enter the port number on the License Manager server, followed by @, and the
name of the License Manager server computer (for example, 8575@SPFLicenseServer).
Log - Location of License Manager log file (SPFtkn.rpt), which is parsed by the token report and
the token recall utilities.
Output file - Location of the local License Manager token output file (token_output.txt).
System administrator e-mail - Address of the system administrator to whom e-mail
notifications should be sent.
184
Microsoft security patch #262701 prevents the SmartPlant Foundation e-mail notification
feature from working properly because the patch blocks e-mail generated by a command
line program. However, Microsoft Outlook Express settings can be edited to enable the
e-mail notification feature. In Microsoft Outlook Express,
Click Tools > Options > Security.
Clear the Warn me when other applications try to send e-mail as me security
feature.
For more information about licensing for SmartPlant Foundation, see SmartPlant Foundation
Licensing Guide available from the Help > Printable Guides command in SmartPlant
Foundation Server Manager.
185
3. Click Edit > Activate License Files to open the Activate License Files dialog box.
4. Type your SmartPlant Foundation serial number in the Serial number box.
The serial number is located on the SmartPlant Foundation CD.
186
12.
13.
14.
15.
If you did not purchase perpetual tokens for SmartPlant Foundation because you are
using daily tokens only, the DAEMON line should contain only the Token path.
Change host-name to the name of the computer on which you will be running the License
Manager.
Change port-number to the unique TCP port that you will be using.
Change token-daemon-path-including-name to point to:
\<license manager installation directory>\token.exe
If you have purchased perpetual tokens for SmartPlant Foundation, change
path-to-perpet.dat to point to:
\<license manager installation directory>\perpet.dat
If you are using daily tokens only, Intergraph recommends that you make the
following changes in order for licensing to work properly:
Make sure that the path to perpet.dat is removed (if present), for example:
DAEMON Token c:\flexlm\Token.exe
Remove or rename the sample perpet.dat file delivered with the software.
16. Restart the License Manager by running lmgrd.exe from the command line. See the
SmartPlant Foundation Licensing Guide for more information.
187
188
Glossary
A
active scope
A configuration in which you may view, create, modify, and delete information in the SmartPlant
Foundation client.
adapter
Authoring tool software that facilitates the sharing of data between the authoring tool and other
integrated tools. Tool adapters generate XML files for publish operations and consume XML
when tools retrieve documents. Adapters are also called SmartPlant adapters.
API
The Application Programming Interface.
as-built
The set of data that describes the existing conditions of a plant or site; the completed and
approved state of a project.
attribute
An object characteristic.
authoring tools
Applications where documents are created and then shared through integration. Integrated
authoring tools include Aspen Basic Engineering, SmartPlant P&ID, SmartPlant Electrical,
SmartPlant Instrumentation, SmartPlant 3D, SmartPlant Materials, and SmartPlant Foundation.
B
batch printing
Printing files at a specified date and time from the SmartPlant Foundation client.
189
Glossary
brownfield
An existing plant or site that is modified by one or more projects.
C
cache
Memory that stores recently-accessed data so that subsequent requests to access the same
data can be processed quickly.
cases
Configurations for instruments that may include specific parameters, settings, or even
components for use in a specific situation.
change notification
An e-mail message sent to a user when an action is performed on an object in SmartPlant
Foundation.
check out
Allows you to make changes to an existing document in SmartPlant Foundation. Only the user
who has checked out a document can save changes to it.
checklist
A series of items, tasks, or questions that the user finishes before a completing a step in a
workflow. Checklists can be optional or required.
claim
client API
A .dll (dynamic link library) that performs a particular function in SmartPlant Foundation. Client
APIs are processed by a specific section of code in a component.
190
Glossary
common UI
An ActiveX component (.dll) that provides a standard user interface for integration functionality,
such as publish, retrieve, and register. The authoring tools display the common UI when the
user clicks particular SmartPlant commands in the authoring tool.
compare
To view the differences between two revisions of the same document in SmartPlant Foundation.
component
A .dll (dynamic link library) that handles requests on the SmartPlant Foundation server.
Components are also called business service layers (BSLs).
component schema
A subdivision of the complete SmartPlant schema that contains the set of class definitions that
are used within a specific domain or application area.
condition
An object that can restrict access to a method, workflow, or relationship based on specified
criteria.
configuration tree
A representation in a tree list, which may include plant, areas, units, and projects that indicates
the structure in which the data is stored in SmartPlant Foundation.
container
An object used by the tool adapters and the SmartPlant software components to pass data back
and forth between a tool and SmartPlant Foundation. A container may hold data or metadata
related to the data model or actual instance data.
contract
A group of documents that are collected and issued for bid, construction, review, and so on.
correlation
The relationship between items that represent the same object in multiple authoring tools.
191
Glossary
create scope
A configuration for data creation, modification, and termination in SmartPlant Foundation.
current document
A document that has been signed off. Current documents can be revised in SmartPlant
Foundation, but not checked out or in.
cut-off date
Any date on which progress information is calculated. Official cut-off dates are scheduled in
advance and are typically part of a reporting schedule. Unofficial cut-off dates are random dates
when rollups are not scheduled but progress is calculated anyway.
D
data list
A list of plant items that can be modified outside SmartPlant Foundation. You can generate data
lists to view and edit SmartPlant Foundation data in Microsoft Excel, and then save the data
back into SmartPlant Foundation.
data sheet
A file that allows users to view, edit, and print object data in a customizable format.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.
design basis
An item in an authoring tool that represents an item from an upstream application (an application
used earlier in the lifecycle of the plant). Plant items placed with the authoring tool correspond to
a particular design basis item.
Design basis items provide a means of determining if the plant items within the authoring tool
are consistent with the items from the upstream application and help users maintain consistency
as changes are made in all authoring tools.
192
Glossary
design file
A file generated by a design tool, such as SmartPlant P&ID or Aspen Basic Engineering.
digest
See e-mail digest.
display item
Object used to present data or relationships on a form in SmartPlant Foundation.
distribution matrix
A list of people who will receive a transmittal created in SmartPlant Foundation and an indication
of what is expected from each recipient. Workflows can also be configured to use a distribution
matrix for sending To Do List or e-mail notifications to workflow step recipients.
document
An object used to track revisions to a design file in SmartPlant Foundation.
document master
An object used to group all the revisions of a document in SmartPlant Foundation.
document revision
An officially recognized change to a document.
domain
A set of data (for example: tool data, SmartPlant Foundation administration data, and schema
data) that is segregated and managed independently in SmartPlant Foundation. Data
segregation improves performance and maintains data integrity. The SmartPlant Enterprise
authoring tools create data in one SmartPlant Foundation domain and publish into another
domain.
downstream forecasting
A feature that uses timestring information and actual dates when steps were completed to
provide an estimated completion date for subsequent steps.
193
Glossary
dump file
A file that contains data exported from the SmartPlant Foundation data or system administration
database. You can import database dump files using SmartPlant Foundation Server Manager.
E
edge definition
Single or multiple relationship definitions with direction. In the SmartPlant schema, an edge
definition is used to traverse from a starting object to related objects.
effectivity date
The period of time for which historical data is displayed in SmartPlant Foundation.
e-mail digest
A collection of notification messages from SmartPlant Foundation that are sent together instead
of separately. You can set a user preference in the Desktop Client to receive digests instead of
individual e-mail messages.
enumerated entry
A member of an enumerated list that defines one possible value for a property in the SmartPlant
schema. Enumerated values are sometimes called enumerated entries.
enumerated list
A list of possible string property values defined for a property definition in the SmartPlant
schema. Enumerated sets are sometimes called enumerated lists, picklists, codelists, and
lookups.
exposes
The relationship between interface definitions and property definitions in the SmartPlant
schema. Interface definitions expose the property definitions for class definitions.
194
Glossary
file server
A service that handles direct file transfer between vaults and the SmartPlant Foundation client.
file type
A setting in SmartPlant Foundation that specifies the format of attached files based on file
extension. This setting determines how files are viewed, edited, and printed in SmartPlant
Foundation.
folder
A grouping object that can contain a number of items. A folder can contain other folders, to build
up a folder hierarchy. A folder can have an owner, which makes it visible only for that user, and
it can have an owning group, which allows access for members of the group. Some uses of a
folder include grouping objects, putting a folder's contents through a workflow, and generating a
data list from a folder's contents.
form
A part of the SmartPlant Foundation client user interface that allows users to specify values for
class definition properties.
FTR
Full-Text Retrieval; a separate module of SmartPlant Foundation that allows you to store, index,
and search for text contained in or associated with objects managed by SmartPlant Foundation.
Full-text retrieval creates an inverted index (a list of the individual words with locations in the
files) and uses this index at search time.
G
governing case
The specific case used for an instrument.
graph definition
A connected network of edge definitions with structure. Each graph definition in the SmartPlant
schema starts at an interface definition and traverses through one or more relationship
definitions to another interface definition at the other end. Graph definitions are sometimes
referred to as directed graph definitions.
195
Glossary
graphic report
A filtered view of a drawing or model, displayed graphically in SmartPlant Foundation.
greenfield
A new plant on a site with no existing infrastructure.
H
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, used for
grouping data.
host
A computer that stores files.
hotspot
Graphical notification that a user can click a drawing item in a drawing or viewable file to display
the properties for the item in SmartPlant Foundation.
I
implies
The relationship between two interface definitions in the SmartPlant schema. If an interface
definition implies another interface definition, then any class definition that realizes the first
interface definition can also realize the implied interface definition.
integration
Technology that standardizes and improves the communication among the various SmartPlant
Enterprise authoring tools used in the course of designing, constructing, and operating a plant.
Integration manages data exchange among these authoring tools, which enables sharing and
re- use of plant information throughout the plant lifecycle.
196
Glossary
interface definition
A named collection of property definitions that represents a role for a class definition in the
SmartPlant schema.
issue
To release a document as part of a transmittal. The document is not considered issued until the
status of the transmittal has been changed to issued.
issue request
A staging of documents and drawings to be issued with a transmittal. An issue request means
that the documents or drawings are ready to be issued with a transmittal, but does not actually
cause the transmittal to be issued.
M
master file
A document file that references other files.
meta schema
A set of schema objects that describe the objects in the SmartPlant schema. The meta schema
provides the building blocks upon which the SmartPlant schema is built.
method
A call to an API that allows users to perform actions on objects or interfaces in SmartPlant
Foundation.
O
owning group
The user group to which an object is assigned in SmartPlant Foundation.
197
Glossary
picklist
A list of applicable values for a given property in SmartPlant Foundation.
plant
An object that can represent the top level in the delivered SmartPlant Foundation data hierarchy.
If you use a custom hierarchy, the object at the top level of the hierarchy may have a different
name.
print server
A computer that processes print requests for a defined list of printers in SmartPlant Foundation.
process cases
Configurations for instruments that may include specific parameters, settings, or even
components for use in a specific situation.
profile
See user profile.
progress
Functionality that allows users to track the development of deliverables, such as documents or
items, against a project plan, indicating any deviations from the original plan.
project
A logical unit of data that is a subset of the items that make up a plant. A project is used for
making controlled, incremental changes to the data in a plant. There can be multiple projects for
a plant at any given time.
property
An object characteristic.
198
Glossary
property definition
A basic attribute shared by all members of a class. Property definitions are grouped using
interface definitions in the SmartPlant schema.
publish
To share a document and its data with other authoring tools by exporting an XML file containing
the document data and relationships. When a document is published, the software places the
XML file in the appropriate SmartPlant Foundation vault and loads the data from the XML file
into the SmartPlant Foundation database. After the document is published, users can retrieve
the data from the XML file located in the SmartPlant Foundation vault into other authoring tools.
punchlist
Provides a running to do list of outstanding scope for completions.
Q
query
A detailed search based on object properties.
query scope
A configuration for data queries and relationship expansions in SmartPlant Foundation.
R
realizes
The relationship between class definitions and interface definitions in the SmartPlant schema.
Class definitions realize interface definitions. The interface definitions that are realized by a
class definition expose the properties for that class definition.
199
Glossary
reference file
Files associated with a master file in SmartPlant Foundation.
register
To map an authoring tool and all its projects to a SmartPlant Foundation URL, which points to
one SmartPlant Foundation database. You must register your authoring tool plant before you
can publish and retrieve in an integrated environment.
relationship
An association between two objects.
relationship definition
Associations between interface definitions in the SmartPlant schema. Relationship definitions
identify two specific objects that fulfill the roles on each end of the relationship.
resurrected object
A deleted authoring tool object that is reintroduced to the SmartPlant Foundation database when
recovered tool data is republished. For example, a tool initially publishes a document containing
an object, but later deletes the object and republishes. SmartPlant Foundation then detects that
the object is deleted. However, if the tool restores data that was backed up before the object
was deleted, through a data restoration or other tool-specific mechanism, and republishes, then
SmartPlant Foundation recognizes that the object was previously deleted but has been
reintroduced (resurrected).
retrieve
To import document data from an .XML file that was published by another authoring tool for the
purpose of maintaining consistency of data across tools. When you retrieve a document, most
authoring tools analyze the impact of the newly retrieved data on the existing database and then
place tasks on the authoring tool's To Do List. The tasks on the To Do List allow you to create,
delete, or modify items at the appropriate time in the design process.
revision
An officially recognized change to a document. Each revision of a document may have multiple
versions.
200
Glossary
revision scheme
A numbering convention for document revisions.
role
A role determines a user's level of access to data and functionality in a specific plant/project
configuration. Users can belong to more than one role per configuration. Roles are defined by
system administrators and are based on related access groups, domains, and owning groups.
rollup
The process of calculating progress data. Progress is calculated for every deliverable at every
level of the hierarchy, and all of that information is available for viewing or reporting when you
run a rollup. Rollups can be scheduled with official cut-off dates or can be run manually at any
time.
S
schema
A model used to describe and validate the structure of XML files.
Schema Component
A suite of ActiveX components that provide functionality surrounding the creation, parsing,
validation, and comparison of the SmartPlant schema and data. The tool adapters interact with
the Schema Component to read the SmartPlant schema, to create data for publish, and to
retrieve data.
scoped by
The relationship between property definitions and property types in the SmartPlant schema. The
scoped by relationship specifies the property type that defines acceptable values, or scopes, a
particular property definition. Every property definition in the SmartPlant schema is scoped by
one and only one property type. All properties of that property definition must be of that property
type.
section
A collection of display items used on SmartPlant Foundation forms.
201
Glossary
server
A computer that stores or processes files.
sharing
The relationship between class definitions and shared object definitions in the SmartPlant
schema. This relationship indicates that a class definition can be shared.
SI
International System of Units, sometimes referred to as the metric system. When values for
units of measure are published, they are converted to SI units and stored, regardless of the units
of measure selected when the user defined the value in the authoring tool.
sign off
To approve a particular revision of a document in SmartPlant Foundation. Signing off a
document sets the document to be the current released revision, makes it official, and
supersedes any previous released revisions. Document revisions that have been signed off are
frozen and cannot be checked out.
site
Refers to the SmartPlant Foundation server settings that point to SmartPlant Foundation
Administration and Data databases and vaults. Each site allows you to run SmartPlant
Foundation operations on data associated with plants and projects configured in the database.
SmartPlant Enterprise
A suite of Intergraph engineering applications that are delivered together.
SmartPlant schema
An XML file that describes the structure of the XML files generated by integrated authoring tools
in much the same way as a data dictionary describes the structure of a database. As tools
publish documents in XML format, those documents must adhere to the format defined by the
schema to ensure that the XML data can be loaded into SmartPlant Foundation and retrieved
into the other authoring tools.
202
Glossary
status
The state of a change object at the completion of each step in a workflow.
step
A process that must be performed in order to complete a workflow.
subscribe
To register interest in an object so that you receive a notification when the object is modified.
You can manually subscribe to change notifications in the SmartPlant Foundation client.
superseded
Indicates that a newer, working version of the selected document exists.
symbology
Settings that determine how a drawing or model will appear when displayed as a graphical
report in SmartPlant Foundation.
T
TEF
The Engineering Framework; technology behind the integration of SmartPlant Enterprise
products.
terminate
To change the status of a SmartPlant Foundation object to terminated without removing it from
the SmartPlant Foundation database. Terminating objects, instead of deleting them, allows you
to continue to see the history of the object after termination.
timestring
A schedule that assigns a certain number of days for the completion for each step in the
lifecycle of a deliverable.
203
Glossary
title block
The portion of a drawing that contains information about the drawing, such as who created the
drawing, when it was created, who approved it, and so on. The type of information included in
the title block varies by drawing type, industry, and organization.
To Do List
A graphical list of tasks that require attention from the user. In SmartPlant Foundation, the To
Do List contains workflow steps assigned to the user. In the authoring tools, such as SmartPlant
P&ID and SmartPlant Instrumentation, the To Do List contains create, delete, and update tasks
generated when a user retrieves a document.
token
A license that provides timed access to users of SmartPlant Foundation. When a user opens the
software, a token is activated.
There are two types of tokens: daily and perpetual. Daily tokens are available to all users and
are valid for 12 consecutive hours after the user logs on to SmartPlant Foundation. When a daily
license token is checked out, a token is depleted from the daily token file. If there are no tokens
left in the daily token file, then other users cannot access the software. Perpetual tokens are
only available to a select group of system users and provide unlimited access to the software.
tombstone
Delete instructions for an object that has been removed in one of the authoring tools. Upon
retrieval of a tombstone, delete tasks are created in the authoring tool's To Do List to allow the
tool to delete the object from its database.
tool
See authoring tool.
tool adapter
See adapter.
tool schema
A set of schema objects that describe the data in the authoring tool databases before it is
transformed into the format prescribed by the SmartPlant schema. The tool schema also
specifies the mapping between objects in the tool database and the SmartPlant schema.
204
Glossary
tool signature
A unique identifier for the relationship between a plant in SmartPlant Foundation and a specific
plant in an authoring tool database. The relationship is created when an authoring tool registers
with SmartPlant Foundation.
transmittal
A controlled package of documents used to perform, track, and record the distribution of project
documentation among different design teams.
U
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the
plant. Most companies, but not all, use the concept of unit.
UoM
A unit of measurement.
user
An object that specifies data about a person who is authorized to use SmartPlant Foundation.
user profile
Information about windows, configuration, and interface settings, saved by the SmartPlant
Foundation client when you close the application and used to configure the application when
you reopen it.
V
vault
A folder where files are stored on a host computer.
205
Glossary
version
An intermediate update to an existing document that is tracked by the SmartPlant Foundation
software.
view definition
A named group of properties extracted from the possible properties that a graph definition
exposes. View definitions are used in an integrated environment to provide a different view of
data from that provided by the underlying schema.
virtual directory
A Web folder created in IIS that points to a physical folder on the Web server. Virtual directories
are used by SmartPlant Foundation to run applications and services from the SmartPlant
Foundation server and to transfer files between file servers and clients.
W
Web Portal
Provides the functionality of the SmartPlant Foundation client system through an easy-to-deploy
Internet Explorer web browser. Based on the software configuration and authorization of the
System Administrator, you can perform the following functions:
View information from the database about a specific object
Search for objects in the database
View drawings and 3D models
View a history for a particular object
View relationships between objects
weighting
The percentage of a project that is made up by a step, sub- step, or deliverable. When you
create a step or sub-step for a deliverable or assign a deliverable to workpack, you must
indicate what percentage of the work that item represents. For example, if a deliverable is 30
percent complete when a particular step is finished, the weighting for that step is 30.
wildcard
A character that helps you narrow your search for objects in the SmartPlant Foundation
database. You can use wildcards in any text box in the Find and Query dialog boxes.
Text wildcards in SmartPlant Foundation include the following:
? - Finds any single character
* - Finds any string of characters
% - Performs the same function as *
206
Glossary
Work Breakdown Structure (WBS)
The composition of the plant based on the construction work to be completed. The plant usually
occupies the top level of the hierarchy; it is typically followed by projects, contracts, and
documents.
workflow
A series of steps defining actions to be taken on an object in SmartPlant Foundation.
working document
A document that has not been signed off in SmartPlant Foundation.
X
XML
Extensible Markup Language; the format for all documents published or retrieved in an
integrated environment. These XML files must conform to the structure defined by the
SmartPlant schema.
207
Glossary
208
Index
A
cache 190
cases 190
change notification 190
Change Security Settings in Microsoft Excel
2007 73
Change Security Settings in Microsoft Excel
2010 77
Change the E-mail Transport Method for
SmartPlant Foundation 125
Changing Security Settings in Excel 73
check out 190
checklist 190
claim 190
client API 190
Command Line Parameters 170
common UI 191
compare 191
Complete the Configuration of a New Site
56
component 191
component schema 191
condition 191
configuration tree 191
Configure a File Type to Use SmartPlant
Markup Plus for PDF Generation 112
Configure a Remote File Service Manually
99
Configure a Remote File Service with
Server Manager 98
Configure an Application Pool Identity Using
a Configurable Account in Windows
Server 2008 179
Configure Document Management for a
Vault 104
Configure Maximum Worker Processes 65
Configure Office Reference Files 71
Configure the Desktop Client for Secure
Communications 84
Configure the license server for
performance 142
Configure the SmartPlant Desktop Client
Logon 81
Configure the Web Portal Authentication
Method 147
Configuring a License Server 134
Configuring COM+ Applications in Windows
Server 2008 180
B
Back Up the SmartPlant Foundation Server
157
Backing Up and Restoring Data 157
batch printing 189
brownfield 190
209
Index
Configuring Folder Permissions in Windows
Server 2008 181
Configuring FTR and Remote Services for
HTTPS 85
Configuring Integrated Windows
Authentication (IWA) in a Double Hop
Web Portal Configuration 148
Configuring Microsoft Office Files for
Generating a PDF/CSF 120
Configuring PDF Generation with
SmartPlant Markup Plus 112
Configuring Security for the Application
Server 73
Configuring SmartPlant Foundation 111
Configuring the Application Server 48
Configuring the Security Model 131
Configuring the SmartPlant License
Manager Client 143
Configuring Vault Replication 105
Configuring Vaults on the File Server 100
Configuring Virtual Directories for a Remote
File Server 97
Configuring Web Portals 145
Configuring Windows Server 2008 R2 64
Considerations for Setting Up Vault
Replication 108
container 191
contract 191
correlation 191
Create a Folder on the SmartPlant
Foundation Application Server 71
Create a New Application Pool in Windows
Server 2008 179
Create a New Host 101
Create a New Site 54
Create a New User Account for Application
Isolation 177
Create a New Vault 103
Create a New Web Portal 145
Create a Relationship Between a Host and
an Organization 103
Create a SQL Server database 142
Create an Oracle database 141
create scope 192
Create the SmartPlant Foundation
Database Instance 34
Creating and Configuring Application Pools
in Windows Server 2008 178
current document 192
Customer Support 163
cut-off date 192
210
D
data list 192
Data Protection and Recovery for
Installations Using Oracle 158
Data Protection and Recovery for
Installations Using SQL Server 159
data sheet 192
data sheet template 192
database 192
Database Creation Script Files 59
Define database system information 140
Define MIME Types 66
Define server information 139
Define the site schema location 55
Defining Application Pool Settings for
SPFRemoteServices 117
Defining the Application Server Default
Folder Structure 49, 135
Delete a Web Portal 146
Delete a Web Portal Server 147
Delivered Data Sheets 130
design basis 192
design file 193
Desktop Client Command Line Parameters
169
digest 193
Disabling the Business Intelligence Module
156
display item 193
distribution matrix 193
document 193
document master 193
document revision 193
domain 193
downstream forecasting 193
dump file 194
E
edge definition 194
Edit IIS Site Bindings 69
effectivity date 194
e-mail digest 194
Enable Integrated Windows Authentication
for IIS 7 80
Enabling HTTPS for the Business
Intelligence Service 84
Enabling Integrated Windows
Authentication for the Business
Intelligence Service 82
Enhancing Performance 131
enumerated entry 194
enumerated list 194
Index
exposes 194
hierarchy 196
host 196
hotspot 196
F
file server 195
file type 195
folder 195
Force a Class of Object to a Vault 105
form 195
FTR 195
I
IIS Requirements for an Integrated
Environment 65
IIS Security 80
implies 196
Incorporate the Enhanced Mechanical
Equipment Data Sheets into an Existing
Site 128
Increasing Trust for Deploying the Desktop
Client 167
Install an SSL Certificate 83
Install and Configure the Software for Citrix
176
Install Citrix Software 175
Install Database Software on the
Application Server 36
Install Database Software on the Database
Server 33
Install Enhanced Mechanical Equipment
Data Sheets 127
Install in Silent Mode 44
Install Prerequisite Software on the Client
Workstations 153
Install Schema Component 41
Install Schema Component.NET 40, 154
Install SmartPlant Foundation 42
Install the Desktop Client 155
M
Manually Edit and Run Server Manager
Permissions Scripts 51
master file 197
Maximum Positive and Negative Database
Values 35
Mechanical Equipment Data Sheet Options
and Functionality 130
meta schema 197
method 197
Minimum IIS Application Mappings 66
Modify the Default Folder Structure 49
Modify Web Portal Server Settings 146
Modifying File Service Settings 58
Modifying FTR Settings 59
Modifying Site Settings 56
Modifying Site System Settings 59
Move a Web Portal onto a New Server
150
O
Obtaining Your Host ID and Disk Serial
Number 184
Optimizing Oracle Databases 36
Oracle Database Port Assignments 89
211
Index
Oracle Template Files 60
owning group 197
P
Parameter Formatting 169
PDF Generation with Custom .INI Settings
113
Performing a Cold Database Backup on the
SmartPlant Foundation Server 160
Permissions for SmartPlant Foundation
Processes 86
Permissions for Users on a Windows 7
Client with UAC Enabled 154
Permissions Script Files 52, 137
picklist 198
plant 198
Plant Breakdown Structure (PBS) 198
Port Assignments for SmartPlant Enterprise
89
Preface 9
print server 198
process cases 198
profile 198
progress 198
project 198
property 198
property definition 199
publish 199
punchlist 199
Q
query 199
query scope 199
R
realizes 199
Reason For Issue (RFI) 199
Reason For Receipt (RFR) 199
reference file 200
register 200
Relate Replicated Vaults to Source Vaults
109
relationship 200
relationship definition 200
Relationships Between Hosts and
Organizations 102
Remote File Service Overview 96
Remove Audit Domain from an Upgraded
Database 131
Restore SmartPlant Foundation Databases
Using Oracle 160
212
S
schema 201
Schema Component 201
scoped by 201
section 201
Secure the Host for HTTPS 83
Security for IIS Sites 87
Security Model Configuration 131
server 202
Set a Default Mail Server for JMAIL 125
Set Permissions for Running SmartPlant
Foundation Loader 51
Set Security on the Oracle Home Folder
35
Set Up a License Manager Site 139
Set Up Basic Authentication for a Double
Hop Web Portal Configuration 148
Set Up Database Access 37
Set Up HTTPS 83
Set Up Integrated Windows Authentication
80
Set Up Kerberos Authentication for a
Double Hop Web Portal Configuration
149
Set Up Remote File Services for Vault
Replication 108
Setting HTTPS on the
DefaultSPFServerURL 83
Setting Launch and Active Permissions
116
Setting the Theme for Running the Desktop
Client on the Server 72
Setting up a Host for the File Server 101
Setting Up a SmartPlant Foundation
License Server 133
Setting Up an Alternate Scheduler Server
126
Setting Up Client Workstations 153
Index
Setting Up Database Access on the
Application Server 36
Setting Up Databases 33
Setting Up E-mail for SmartPlant
Foundation 125
Setting Up Enhanced Mechanical
Equipment Data Sheets 127, 128
Setting Up PDF Generation 112
Setting Up Sites 53
Setting Up SmartPlant Foundation File
Servers 95
Setting Up the Application Server 39
Setting Up the Database Server 33
shared object definition 202
sharing 202
SI 202
sign off 202
site 202
SmartPlant Enterprise 202
SmartPlant Foundation Alternate Server
27
SmartPlant Foundation Application Server
25
SmartPlant Foundation Database Server
23
SmartPlant Foundation File Server 28
SmartPlant Foundation Hardware and
Software Recommendations 21
SmartPlant Foundation Internationalization
17
SmartPlant Foundation License Server 26
SmartPlant Foundation Port Assignments
89
SmartPlant Foundation Recommendation
Summary 22
SmartPlant Foundation Settings for
SmartPlant Markup Plus 114
SmartPlant Foundation Web Portal Client
30
SmartPlant Foundation Web Portal Server
30
SmartPlant Foundation Workstation 29
SmartPlant schema 202
SQL Server Port Assignments 91
SQL Server Template Files 61
Start the license server wizard 139
status 203
step 203
subscribe 203
Suggested IIS Configuration Settings 69
superseded 203
symbology 203
T
TEF 203
terminate 203
Test Email Configuration Command 125
Test Email Configuration Dialog Box 125
timestring 203
title block 204
To Do List 204
token 204
tombstone 204
tool 204
tool adapter 204
tool schema 204
tool signature 205
transmittal 205
U
unit 205
unit of measure list 205
UoM 205
Update sites with new license server 140
Upgrading SmartPlant Foundation 93
user 205
user profile 205
Using Alternate Rendition Service Debug
122
Using Server Manager to Configure the
Application Server 47
Using the Web Portal with Microsoft Internet
Explorer 8 or 9 151
V
vault 205
Vault Replication Configuration Checklist
108
version 206
view definition 206
virtual directory 206
W
Web Portal 206
Web Portal URL Parameters 173
weighting 206
Welcome to SmartPlant Foundation 15
wildcard 206
Work Breakdown Structure (WBS) 207
workflow 207
working document 207
213
Index
X
XML 207
214