Spel Install Guide

SmartPlant Electrical Installation and Upgrade Guide

Versi on 2007.5 (SPEL 4.2 and SPEM 5.0)

May 2008

DELE2-PE-200003N

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

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

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

Trademarks Intergraph, the Intergraph logo, PDS, SmartPlant, SmartSketch, FrameWorks, INtools, MARIAN, and IntelliShip are registered trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of th eir respective owners.

Table of Contents

Table of Content Con tentss Preface................................................................................................................................. Preface.................................................................................................................................7 Welcome to SmartPlant..................................................................................................... SmartPlant.. ...................................................................................................8

Installati Installation on Checklist Checklist .................................................................................................... ....................................................................................................9 9 Introducing SmartPlant Electrical............................................................................... Electrical...............................................................................10 10 SmartPlant Electrical Program Group............................................................................... Group... ............................................................................ 10

Introducing SmartPlant SmartPlant Engineering Manager ........................................................... ...........................................................12 12 SmartPlant Engineering Manager Program Group ........................................................... ... ........................................................ 13

Internationaliza Internationalization tion ......................................................................................................... ... ......................................................................................................14 14 SmartPlant SmartPlant Engineering Manager Hardware Hardware and Software Software Recommendations Recommendations ... ...17 ...17

SmartPlant Engineering Manager Database Server.................................................... Server....................................................18 18 SmartPlant Electrical Workstation ............................................................................. .............................................................................20 20 Installing the Software..................................................................................................... Software... ..................................................................................................23 23

Setting Setting up the Database Database .............................................................................................. ..............................................................................................23 23 Installing and and Configuring Configuring Oracle ................................................................................. ... ..............................................................................25 25

Configuring Oracle Networking Components............................................................ Components............................................................26 26 Installing Installing Oracle Oracle Common Tasks ............................................................................... ...............................................................................27 27 Installing Oracle Database Server: An Overview....................................................... Overview.......................................................28 28 Install Oracle 9i Database Server...................................................................................... Server... ................................................................................... 28 Install Oracle 10g Database Server................................................................................... Server... ................................................................................ 34 Create an Oracle Listener.................................................................................................. Listener... ............................................................................................... 34

Creating an Oracle Instance: An Overview................................................................ Overview................................................................35 35 Requirements for Oracle Instance Creation...................................................................... Creation... ................................................................... 35 Create a New Oracle 9i Instance....................................................................................... Instance... .................................................................................... 36 Create a New Oracle 10g Instance.................................................................................... Instance... ................................................................................. 37

Installing Oracle Client: An Overview... Overview ....................................................................... ....................................................................41 41 Installing Oracle Oracle 9i Client Client Prerequisites ........................................................................... ... ........................................................................ 41 Install Oracle 9i Client...................................................................................................... Client... ................................................................................................... 41 Installing Oracle Oracle 10g Client Client Prerequisites ........................................................................ ... ..................................................................... 42 Install Oracle 10g Client ................................................................................................... ... ................................................................................................ 43 Register DLLs with RegSrv32.......................................................................................... RegSrv32... ....................................................................................... 43

Installing and Configuring Configuring Microsoft SQL Server... Server ... .................................................... ....................................................47 47 Modify Logon Information for SQL Server Services....................................................... Services... .................................................... 48

Installing SQL Server Common Tasks....................................................................... Tasks.......................................................................48 48 Installing SQL Server 2000 Database Server ............................................................. .............................................................49 49 Install SQL Server 2000 Database Server......................................................................... Server... ...................................................................... 49 Create a Named Instance on SQL Server 2000................................................................. 2000... .............................................................. 50

SmartPlant Electrical Installation and Upgrade Guide 3

Table of Contents

Setting Database Maintenance Options for SQL Server 2000 ...................................51 Run DBCC Utility Options............................................................................................... 51 Update Statistics ............................................................................................................... 53

Installing SQL Server 2005 Database Server .............................................................53 Install SQL Server 2005 Database Server......................................................................... 53 Configure SQL Server 2005 Database Server .................................................................. 54

Setting Database Maintenance Options for SQL Server 2005 ...................................56 Run DBCC Utility Options............................................................................................... 56 Update Statistics ............................................................................................................... 57

Installing SQL Server Client: An Overview...............................................................57 Install SQL Server 2000 Client......................................................................................... 57 Install SQL Server 2005 Client......................................................................................... 58

Installing SmartPlant Software ......................................................................................59 Grant Permissions to Write to a Registry Key.................................................................. 59 Install SmartPlant Engineering Manager.......................................................................... 60 Install SmartPlant Electrical ............................................................................................. 61 Install SmartPlant Electrical Over a Previous Installation... ............................................. 61 Install SmartPlant Reference Data .................................................................................... 62 Configuring Reference Data for SmartPlant Electrical..................................................... 63

Installing SmartPlant Electrical in Silent Mode .........................................................64 Install SmartPlant Electrical in Silent Mode... .................................................................. 64

Working in Thin Client Mode ........................................................................................68

Overview.....................................................................................................................68 Tuning the Software for Use in Thin Client Mode.....................................................68 Publish the SmartPlant Application.................................................................................. 69 Configure Citrix Presentation Server 4.0.......................................................................... 70

Terminal Server Logon Sequence ..............................................................................70 Upgrading SmartPlant Electrical to Version 2007 ... ....................................................71

Before Running the Upgrade Utility...........................................................................72 Back Up Your Data........................................................................................................... 72 Share Paths to Site .INI Files............................................................................................ 72 Set Oracle Parameters....................................................................................................... 72 Plants with Multiple Naming Convention Definitions for Cables ... ................................. 73 Memory Management Considerations.............................................................................. 74

Using the SmartPlant Engineering Upgrade Utility ...................................................75 Upgrade a Plant................................................................................................................. 76 Upgrade SmartPlant Electrical.......................................................................................... 77 Upgrade Utility Commands .............................................................................................. 79

After Running the Upgrade Utility.............................................................................82 Upgrade Site Command.................................................................................................... 82 Backing Up Each Upgraded Plant .................................................................................... 82 Using Oracle Analyzer Scripts.......................................................................................... 82 Preserving Software Customizations ................................................................................ 83 Making Manual Changes.................................................................................................. 84

4 SmartPlant Electrical Installation and Upgrade Guide

Table of Contents Configuring SmartPlant Engineering Manager ... ........................................................85

Working with Database Schemas: An Overview .......................................................85 Understanding Default Database User Names ...........................................................87 Working with Data Dictionaries: An Overview .........................................................89 Data Dictionary Manager Command................................................................................ 89 New Data Dictionary Template Command....................................................................... 90

Using Default Settings: An Overview ........................................................................93 Default Settings Command............................................................................................... 93 Use Default Settings Command........................................................................................ 99

Creating Network Shares............................................................................................99 Site Administrator User Group.................................................................................100 Create a User Group........................................................................................................ 101 Add Users to the Administrators Group ......................................................................... 102 Grant Network Access Privileges ................................................................................... 103 Novell Networking and User Groups.............................................................................. 104 Change the Site Administrator User Group .................................................................... 105

New Site Server Wizard ...........................................................................................108 New Plant Structure Wizard .....................................................................................109 Associate Applications Wizard.................................................................................110 Creating Roles ..........................................................................................................111 Create a New Role .......................................................................................................... 111

User Access .....................................................................................................................113

Overview...................................................................................................................113 SmartPlant Engineering Manager Rights........................................................................ 114 SmartPlant Electrical User Access Rights ...................................................................... 116

Customizing Your Reference Data.... ...........................................................................128

Customizing Reference Data Options ......................................................................128 Working with Filters.................................................................................................128 Working with Formats..............................................................................................129 Working with Symbols and Labels...........................................................................129 Modifying Data Model Properties............................................................................129 Establishing Design Rules ........................................................................................130 Configuring Border Templates.................................................................................130 SmartPlant Electrical Delivered Templates .................................................................... 130 Edit Delivered Templates ............................................................................................... 131 Create a Border Template ............................................................................................... 132

Working with SmartPlant Integration.........................................................................133

Overview...................................................................................................................133 Preparing the Integrated Environment......................................................................134 Tool Requirements for Integrating SmartPlant Electrical ........................................136 Working with SmartPlant Instrumentation ..................................................................... 136 Working with SmartPlant 3D.......................................................................................... 137 Working with SmartPlant P&ID..................................................................................... 138 Using Projects in an Integrated Environment ................................................................. 139


Table of Contents

Mapping for SmartPlant Integration.........................................................................139 Using Custom Hierarchies........................................................................................140 Register Command ...................................................................................................140 Index................................................................................................................................142


Preface

Preface This document is the installation and upgrade guide for SmartPlant® Electrical. Intergraph® gives you permission to print as many copies of this document as you need for non-commercial use at your company. You cannot print this document for resale or redistribution outside your company. Send documentation comments or suggestions to [email protected]. 1


Welcome to SmartPlant

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



Installation Checklist For the recommended installation workflow, please see the installation checklist (SPELInstall_Checklist.pdf), available in the Help folder on the product CD. This checklist, also available in Microsoft Excel format (SPELInstall_Checklist.xls), is delivered during product setup to the \Program Files\SmartPlant\Electrical\ Program\ folder.



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

SmartPlant Electrical Program Group SmartPlant Electrical provides multiple views of a central, unified data structure that represents the plant model. A view is a visual presentation of the data in the plant model and can be a single line diagram or a table. The plant model is the computer representation of the conceptual design, including all plant components and their relationships. By manipulating model views, you can organize the information within the plant model to better understand and maintain the data.



SmartPlant Electrical has several programs and utilities for running and managing your plant data. SmartPlant Electrical allows you to design and maintain the electrical equipment and documentation for process plants, refineries, and so forth. SmartPlant Electrical Import Manager allows you to import data to SmartPlant Electrical from external data files and various database platforms, such as MS Access, MS SQL Server, Oracle, and so forth. SmartPlant Electrical Options Manager allows you to define plant-wide default preferences, customize formats, naming conventions, item types, and set cable sizing parameters. Options Manager also defines default paths to data files and directories. SAP Wizard allows you to specify parameters needed to create a data file that is used to export data from SmartPlant Electrical into S AP. SmartPlant Electrical Web Utility allows users of IDEAL who do not use the SmartPlant Electrical application to connect to the SmartPlant Electrical database via the IIS (Internet Information Server) and then display retrieved data in formats supported by SmartPlant Electrical. SmartPlant Electrical Rule Manager allows you to define an environment used for creating, manipulating and managing sets of consistency rules that apply whenever a user associates two items or modifies properties of a certain item tag in SmartPlant Electrical.

SmartPlant Engineering Manager performs higher-level data management tasks, such as specifying user permissions, designing plant hierarchies, and so forth. For more information about SmartPlant Engineering Manager, see the SmartPlant Engineering Manager User's Guide and the appropriate sections of this guide. Related Topics Introducing SmartPlant Electrical , page 10 •



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



SmartPlant Engineering Manager Program Group The SmartPlant Engineering Manager program group provides several utilities for managing your plant data. SmartPlant Engineering Manager allows you to create the SmartPlant site and plants. You can create plant structures, plant groups, hierarchy templates, as well as define the access to plant data on many levels. Catalog Manager allows you to create and modify symbols and labels. Data Dictionary Manager allows you to add properties to SmartPlant database tables, define external programs, view relationships, and create and modify select lists. Filter Manager allows you to create and modify filters to discriminate on database data. Filters are used for displaying data in symbology, gapping, graphical views, reports, rules, and so forth. Format Manager defines available formats for units of measure properties. Reference Data Synchronization Manager provides tools for comparing, synchronizing, and managing reference data across multiple plants. Used in conjunction with the Update Drawings functionality in Drawing Manager, this application is especially useful when you need to maintain a central set of reference data for all plants across a site without having a network or database connection between plants. Upgrade Utility guides you through upgrading your SmartPlant Engineering data.


Internationalization

Internationalization Supporting internationalization in a homogeneous environment is one of the enhancements available in SmartPlant Enterprise. A homogeneous environment uses elements from only a single locale. For example, a German customer running on a German operating system using only German characters and German cultural conventions is a fully supported homogeneous environment configuration. Homogeneous Environments When starting a new project, use extra care during installation and configuration to ensure the proper creation and maintenance of homogeneous environments: •

•

•

•

•

•

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



Heterogeneous Environments In contrast, a heterogeneous environment using elements from different, or even multiple locales, is not supported. Many customers are currently operating in unsupported heterogeneous environments and are often not aware of that fact. Examples of heterogeneous environments: •

•

•

•

•

Entering or viewing Japanese data on an US/English operating system Using German Regional Settings (where the decimal point is a comma) on a US/English operating system Using databases with different character encodings such as CL8MSWIN1251 or JA16SJIS Using multiple languages in a project, especially when crossing languagegroup boundaries Using an English server with different local language clients

International / Bi-lingual Projects International bi-lingual projects are possible; however, great care must be used when configuring these environments. Limitations exist and must be properly understood: •

•

•

•

Oracle and MS SQL Server databases can reside on any language operating system, as long as the databases have been created and configured with proper Unicode and collation settings. All Microsoft operating systems (Japanese, Russian, German, and so forth) can enter English characters. The reverse, however, is not true in most cases. Keyboard-locale can be changed as long as a character-set and code-page boundary is not crossed. For example, English, German, French, and Spanish characters can all be used in the same project because the same Windows code-page (1252) is used. However, Russian characters (code page 1251) cannot be used in a US/English environment. You must decide which language operating system will be the master for bi-lingual projects.



The following is an example of a Russian-based project: Companies in the United States and the United Kingdom are working a project with a Russian company and the deliverables (drawings, reports, and so forth) must ultimately be provided in Russian. The companies in the U.S. and the U.K. are working the project using the "master" Russian operating systems (possibly using virtual Russian operating systems running on VMware Workstation). The U.S. a nd 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. Warning •

Do not change regional settings to reflect a U.S. environment in order to resolve problems in a non-US/English homogeneous configuration. Doing this creates a heterogeneous configuration that will cause other possibly hidden problems that cannot be corrected. Everyone working on a project must use the same regional settings and character set throughout the life of the project.

Questions and Assistance Please contact your support representative for assistance.


SmartPlant Engineering Manager Hardware and Software Recommendations

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

Note •

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



SmartPlant Engineering Manager Database Server Hardware Recommendations •

•

•

•

•

2.4 GHz Pentium machine (for Oracle), 1 GHz or higher Xeon machine (for SQL Server 2000), 2 GHz or higher Xeon machine (for SQL Server 2005) 1 GB RAM (2 GB RAM recommended for SQL Server 2005) Digital tape or DVD backup system for server For SmartPlant Enterprise installation, DVD drive access, either locally or through a network connection For SmartPlant Engineering Manager installation, CD-ROM drive access, either locally or through a network connection

Supported Operating Systems •

•

•

•

Microsoft Windows 2000 Server and Advanced Server Service Pack 4 Microsoft Windows Standard Server 2003 Service Pack 1 Microsoft Windows Enterprise Server 2003 Service Pack 1 Microsoft Windows Enterprise Server 2003 R2 Service Pack 1 Note

•

The operating system must be installed in the account where you have administrator privileges.

Supported Database Servers •

Microsoft SQL Server 2000 Service Pack 4

•


•

Oracle Database 9i Release 2

•

Oracle Database 10g Release 2 (10.2.0.1) Important

•

When using SmartPlant Engineering Manager in stand-alone mode with an Oracle database, you can use only Oracle 9i Client (and not Oracle 10g Client).



Recommended Disk Space Oracle 9i or 10g Software

SQL Server 2000 Software


SmartPlant Engineering Manager Software

Oracle Server installation

2 GB

SQL Server 2000 installation

250 MB

SQL Server 2005 installation

1 GB

Initial SmartPlant Engineering Manager database

250 MB

Initial Oracle instance

500 MB

SQL Server Temporary database

100 MB

SQL Server Temporary database

100 MB

Total :

2.5 GB

Total:

0.35 GB

Total:

1.1 GB

Total:

0.25 GB

Software Prerequisites •

•

•

Adobe® Reader 7.0 (required to view the Software License Agreement and Printable Guides. Version 7.0 is available on the product CD.) Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (required by SmartPlant Engineering Manager for SQL Server databases. Included with Microsoft SQL Server 2000.) Microsoft .NET Framework 2.0



SmartPlant Electrical Workstation Hardware Recommendations •

•

•

•

•

1 GHz Pentium III processor or higher 512 MB RAM For SmartPlant Enterprise installation, DVD drive access, either locally or through a network connection For separate SmartPlant Electrical installation, CD-ROM drive access, either locally or through a network connection Windows supported printer access, either locally or through a network connection

Supported Operating Systems •

Microsoft Windows 2000 Server and Advanced Server Service Pack 4

•

Microsoft Windows Standard Server 2003 Service Pack 1

•

Microsoft Windows Enterprise Server 2003 Service Pack 1

•

Microsoft Windows Enterprise Server 2003 R2 Service Pack 1

•

Microsoft Windows 2000 Professional Service Pack 4

•

•

Microsoft Windows XP Professional Service Pack 2 Microsoft 32-bit Vista Business Client

Supported Database Clients •


•


•

Oracle 9i Client Release 2

•

Oracle 10g Client Release 2 (10.2.0.1) Important

•

•

When using SmartPlant P&ID and SmartPlant Electrical in stand-alone mode with an Oracle database, you can use only Oracle 9i Client (and not Oracle 10g Client). The client database software must be of the same version as the server database software.



Recommended Disk Space Oracle 9i or 10g Software



SmartPlant Software

Oracle Client installation

SQL Server 2000 Client installation

SQL Server 2005 Client installation

SmartPlant Engineering Manager 2007 (full installation)

250 MB

SmartPlant Electrical 2007 (full installation)

200 MB

SmartPlant Schema Component

25 MB

SmartPlant Client

30 MB

Total:

0.5 GB

Total :

1 GB

1 GB

Total:

120 MB

0.12 GB

Total:

100 MB

0.1 GB

Software Prerequisites •

•

•

•

•

•

•

•

Adobe Reader 7.0 (required to view the Software License Agreement and Printable Guides. Version 7.0 is available on the product CD.) SmartPlant License Manager 9.0 Microsoft Internet Explorer 6.0 Service Pack 1 or Microsoft Internet Explorer 7.0 (required for viewing the online documentation delivered with the software) Microsoft XML Core Services (MSXML) 4.0 Service Pack 2 Microsoft .NET Framework 2.0 Microsoft Data Access Components (MDAC) 2.8 Service Pack 1 (MDAC 2.8 is delivered as part of Microsoft Windows XP Service Pack 2 or with Microsoft SQL Server 2000). Microsoft Office 2000, XP Service Pack 3, 2003, or 2007. (Microsoft Excel is required for working with report templates and for viewing the Installation Checklist and various other files.) Windows Scripting, wshom.ocx, version 5.6 (required by SmartPlant Engineering Manager. Available on the product CD.)



Optional Software Caution •

•

•

Apart from SmartSketch, the following software programs are not Intergraph corporation software and are owned by third parties. It is the responsibility of the customer to select in its sole discretion the applicable third party software customer desires to use to generate reports and Intergraph makes no recommendation as to the choice of said third party software. Customer is responsible for obtaining a valid license to use said third party software from the owner of said third party software and to pay any license fees to the owner of said third party software for the use of said third party software. INTERGRAPH DISCLAIMS AND MAKES NO WARRANTY EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY OR THE WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE IN REGARDS TO SAID THIRD PARTY SOFTWARE. SmartSketch 2007 (5.2) or similar graphical editor (required for editing border template files) For working in a Citrix environment, Citrix Presentation Server 3 or 4


Installing the Software

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

Setting up the Database SmartPlant currently supports Oracle 9.0.1, 9.2.0, and 10g (on Windows XP only), and Microsoft SQL Server 2000 and 2005. Installing any database involves significant decisions regarding the size of the database, the maximum number of users, the frequency of automatic backups, and other important issues. Therefore, the following sections provide only suggestions for tuning your database configuration to work with SmartPlant software. The ultimate database creation and configuration depends on the policies and standards at your company. SmartPlant Engineering Manager includes a number of deferrable database constraints, which are rules used to ensure database integrity by checking values at the time the information is written to the database. If all of the information does not fall within these embedded constraints, the information is not written to the database, and the software rolls back the transaction.


Installing the Software

However, SQL Server does not support these deferrable database constraints. They are applied only when you use an Oracle database. The following table shows the supported Oracle versions for each product: Product

Supported Oracle Version s

SmartPlant Electrical

9.0.1, 9.2.0, 10g (10.2.0.1)

SmartPlant Instrumentation

9.2.0, 10g (10.2.0.1)

SmartPlant P&ID

9.0.1, 9.2.0, 10g (10.2.0.1)

SmartPlant Foundation

10g (10.2.0.1)


Installing and Configuring Oracle

Installing and Configuring Oracle Because system configurations, database software, and individual company standards vary, use this section as a checklist instead of step-by-step instructions. Please contact Intergraph Customer Support for specific configuration questions. Oracle Instances If one server hosts the databases of several products, Intergraph recommends that each product's database be a separate instance, each of which can host multiple plants. The advantage of placing each product's database its own instance is that only the affected application will be off-line during backup, performance tuning, and other database maintenance activities. Additionally, global tuning parameters that apply to one instance can be tailored to the specific product requirements. According to Oracle documentation, the only limit to the number of instances you can have on any machine is the availability of resources. However, the number of instances on one database server should be minimized, because each additional instance puts additional load on the server. Each instance adds redundant tablespaces, rollback segments, background processes, and memory requirements for each SGA (System Global Area). For this reason, you should start by putting the database of one product for several plants into a single instance. Then, when the number of plants increases, or a plant becomes very large, consider separating the database into new instances, adding server memory, or even adding database servers. Important •

•

We recommend installing and configuring Oracle locally, not by remote desktop connection. Oracle recommends that database activity on the database server consume no more than 50 percent of the available memory.



Configuring Oracle Networking Components Oracle Net Services combines configuration abilities with component control to provide an environment for configuring and managing client connections to services via a net service name. SmartPlant Engineering Manager and SmartPlant Electrical use Oracle Net to establish and maintain network sessions from client applications to the Oracle database server. After a network session is established, this utility acts as a data courier for the client application and the database server. See the Oracle Net Services Administrator's Guide (a96580) and the Oracle Net Services Reference Guide (a96581) in your Oracle documentation for more information about using this utility and creating net service name connections. Important •

For SmartPlant to access the database, you must load and configure Oracle Net Services on the database server and on each end-user SmartPlant workstation. If SmartPlant Engineering Manager is installed on the database server, you must load and configure Oracle Net Services on that server, in addition to the Oracle TCP/IP Protocol Adapter .

If SmartPlant Engineering Manager is installed on a workstation other than the database server, you must load the Net Services and the Oracle TCP/IP Protocol Adapter on the SmartPlant Engineering Manager computer. You must also load the Net Services and the Oracle TCP/IP Protocol Adapter on the Oracle database server. Oracle Manager is installed with the Net Services software and allows you to create a database Net Service Name, which SmartPlant uses to communicate with the database. Important •

The version of Net Services must be the same on all computers.



Installing Oracle Common Tasks The following tasks must be performed when installing Oracle Versions 9i or 10g Server and Client installations for use with SmartPlant Electrical. Oracle Server Setup •

Install Oracle 9i Database Server , page 28

•

Install Oracle 10g Database Server , page 34

•

Create an Oracle Listener , page 34 (Oracle 10g only)

Oracle Instance Creation You need to create a new instance in Oracle if you have an existing Oracle database server whose parameters do not comply with the parameters required to use SmartPlant Electrical on Oracle. This way you can append the SmartPlant Electrical database to existing Oracle databases on your Oracle database server without losing your existing Oracle database information. For details, see Creating an Oracle Instance: An Overview, page 35. For additional information, see: •

•

•

Requirements for Oracle Instance Creation, page 35 Create a New Oracle 9i Instance, page 36 Create a New Oracle 10g Instance, page 37

Oracle Client Setup •

Installing Oracle Client: An Overview, page 41

•

Install Oracle 9i Client , page 41

•

Install Oracle 10g Client , page 43

Related Topics Installing Oracle Database Server: An Overview, page 28 •



Installing Oracle Database Server: An Overview The procedures described in this Installation Guide include only the steps required to install and use your SmartPlant software. Therefore, you should refer to the Oracle Installation Guide for detailed instructions about Oracle installation. The following editions of Oracle Server Versions 9i and 10g are available: •

•

Standard Edition (for minimum installation) Personal Edition

This Installation Guide describes the installation of specific editions of each Oracle Server version. If you use an edition of Oracle not shown in the table, your Oracle Server installation procedure is likely to be slightly different from the one described. Therefore, we recommend that you use one of the versions and editions shown in the table for Oracle Server installation. Operating System

Edition Used in Described Installation

Windows 2000 Server or Windows 2003 Server

Standard Edition

Windows XP

Personal Edition

Install Oracle 9i Database Server 1. Launch the Autorun.exe file and on the Oracle9i Server - Autorun page, click Install/Deinstall Products to start the Oracle Universal Installer 2.2. 2. On the Welcome page of the Oracle Universal Installer, click Next. 3. On the File Locations page, enter the source file path and the destination file name and path as desired, and then click Next. 4. On the Available Products page, click Oracle9i Database 9.2.0.1.0 , and then click Next. 5. On the Installation Types page, click Personal Edition (2.80GB) , and then click Next. 6. On the Database Configuration page, click Customized , and then click Next. 7. On the Oracle Services for Microsoft Transaction Server page, click Next. 8. On the Summary page, click Install . 9. After the software completes the installation and opens the Oracle Net Configuration Assistant, on the Welcome page of the Oracle Net Configuration Assistant, select Perform typical configuration and then click Next to create a listener.


Installing and Configuring Oracle Tip •

After creating a listener, the software opens the Configuration Tools page, where you can review the database creation progress, and also opens the Database Configuration Assistant, where you need to configure the Oracle server database for SmartPlant Electrical.

10. In the Database Configuration Assistant, on the Welcome page, click Next. 11. On the page Step 1 of 8: Operations , click Create a database , and then click Next. 12. On the page Step 2 of 8: Database Templates , make sure that the New Database option is selected, and then click Next.

13. On the page Step 3 of 8: Database Identification , do the following: a. In the Global Database Name box, enter the name of the Oracle database, for example, SPEL. b. In the SID box, it is recommended that you accept the default instance name SPEL. c. Click Next. 14. On the page Step 4 of 8: Database Features , do the following: a. Clear all the check boxes appearing on the Database Features tab. b. Click Standard database features and then, on the dialog box that opens, clear all the check boxes. Tip

During these steps, if you are prompted to delete any tablespaces, click Yes. c. Click Next. •

15. On the page Step 5 of 8: Database Connection Options , click Dedicated Server Mode, and then click Next. Tip •

If you are setting up a database for more than about 8 users, click Shared Server Mode .



16. On the page Step 6 of 8: Initialization Parameters , do the following: a. On the Memory tab, make sure that the Custom option is selected, and then, in the Shared Pool box, if you want to save physical memory on the server machine, reduce the value to 10 MB (recommended).

b. On the Character Sets tab, in the Database Character Set group box, select Use Unicode (AL32UTF8) . c. From the National Character Set list, select AL16UTF16.

d. On the DB Sizing tab, for the Block Size parameter, accept the default value 8 . e. Click the All Initialization Parameters button and set the following values: DB_BLOCK_SIZE = 8192 DISTRIBUTED_TRANSACTIONS = 500 (Only if using Oracle 8) LOG_CHECKPOINT_INTERVAL = 10000 LOG_CHECKPOINT_TIMEOUT = 1800 NLS_LANGUAGE = AMERICAN 30 SmartPlant Electrical Installation and Upgrade Guide

Installing and Configuring Oracle NLS_TERRITORY = AMERICA OPEN_CURSORS = 500 TRANSACTIONS = 500

17. Click Next. 18. On the page Step 7 of 8: Database Storage , Set the User Tablespace size = 600 as follows: a. On the tree view, click Tablespaces > USERS. b. In the Datafiles grid, click in the row containing the file and then click (Edit Datafile).

c. On the Edit Datafile dialog box, change value of File Size to 600.

19. Set the Temp Tablespace size = 200.



20. Choose the Automatic Extend feature for tablespaces. By allowing tablespaces to be extended automatically, you can prevent certain errors later resulting from data files limited to too little space.



Tip •

You can create additional tablespaces later using the Oracle Enterprise Manager Console.

21. Click Next. 22. On the page Step 8 of 8: Creation Options , select Create Database , and then click Finish. 23. After the database creation process completes, assign new SYS and SYSTEM passwords.



24. Complete the Oracle database creation as described in your Oracle Installation Guide. 25. Restart your computer.

Install Oracle 10g Database Server 1. Start Oracle 10g Setup. 2. On the Select Installation Method page, click Basic Installation , and from the Installation Type list, select one of the following: •

•

Standard Edition — If the operating system is Windows 2000 Server or Windows 2003 Server. Personal Edition — If the operating system is Windows XP.

3. Clear the Create Starter Database check box and then click Next. 4. On the Product-Specific Prerequisite Checks page, ignore the Checking Network Configuration requirements warning and click Next. 5. On the Warning dialog box, click Yes. 6. If the OUI-10030 warning message appears, if the disk of the target folder has enough space, click Yes. 7. On the Summary page, click Install . 8. Complete the installation and then click Exit. 9. Restart the server machine.

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



Creating an Oracle Instance: An Overview The Oracle instance is a workspace on the Oracle database server where Oracle keeps a single database. You can create as many instances as required and, this way, append as many databases as you need on a single database server. However, note that appending instances on your Oracle database server can slow down your work in the SmartPlant Electrical database located on that server. The instance creation process contains the following major steps: 1. Creating a new instance initialization file from an existing initialization file. 2. Modifying the database parameters in the new instance initialization file. 3. Modifying the Listener.ora file which Oracle will run when carrying out the instance creation process. 4. Creating a new instance by using the Oracle Enterprise Manager When creating an instance, Oracle takes-up some disk space. Therefore, you must have enough free disk space on the hard disk where the Oracle database is located to be able to create the new instance. The disk usage is as follows: •

Oracle instance environment — 50 MB recommended

•

Oracle instance after running Oracle DB Setup — 80 MB recommended

•

Oracle instance after initializing a domain — 150 MB recommended

See your Oracle User Guide for additional information about limitation on instances creation.

Requirements for Oracle Instance Creation Important •

Before creating an Oracle instance, make sure that you have Administrator's access rights in both your Oracle server database and the operating system installed on the server machine. If you still need to create an instance from the account in which you do not have Administrator's rights, and if your company's policy allows you to change the Oracle security, you can do the following: in the Sqlnet.ora file, add the # symbol before the Sqlnet.Authentication_Services = (NTS) parameter to comment it out. The Sqlnet.ora file default location depends on your Oracle version: •

For Oracle 9i, the path is: \\\Oracle92\Network\Admin\



•

For Oracle 10g, the path is: \\\Product\\Client_1\Network\Admin\ (* An example of the folder name is 10.2.0)

Before starting an Oracle database you need to ensure that the RAM that this database occupies does not exceed the available RAM on your server. You can calculate the amount of RAM needed for the database by using the following Oracle parameters: •

SHARED_POOL_SIZE (at least 10 MB)

•

DB_BLOCK_SIZE

•

•

LOG_BUFFER SORT_AREA_SIZE Note

•

JAVA_POOL_SIZE and LARGE_POOL_SIZE are additional parameters that affect the RAM that the Oracle database occupies. These parameters appear if you select certain options when running the Oracle Database Configuration Assistant using a custom installation type. Caution

•

For the DB_BLOCK_SIZE parameter, make sure that the value is at least 8192.

As an alternative to the above calculation, you can use the following target parameters to determine the maximum amount of RAM: •

•

sga_target (at least 100 MB is recommended) pga_aggregate_target (at least 20 MB is recommended)

Create a New Oracle 9i Instance Important

Make sure that all passwords, user names, folders, and files of the new instance are different from those of any existing instance. 1. Run the Database Configuration Assistant. •

2. On the Welcome page, click Next. 3. On the page Step 1 of 8: Operations , click Create a database , and then click Next. 4. On the page Step 2 of 8: Database Templates , make sure that the New Database option is selected, and then click Next.



5. On the page Step 3 of 8: Database Identification , do the following: a. In the Global Database Name box, enter the name of Oracle database name, for example, SPEL. b. In the SID box, enter the default instance name SPEL. It is recommended that you use the same database and instance name. c. Click Next. 6. On the page Step 4 of 8: Database Features , do the following: a. Clear all the check boxes appearing on the Database Features tab. b. Click Standard database features and then, on the dialog box that opens, clear all the check boxes. c. Click Next. 7. On the page Step 5 of 8: Database Connection Options , click Dedicated Server Mode, and then click Next. 8. On the page Step 6 of 8: Initialization Parameters , do the following: a. On the Memory tab, make sure that the Custom option is selected, and then, in the Shared Pool box, if you want to save physical memory on the server machine, reduce the value to 10 MB (recommended). b. On the DB Sizing tab, accept the default value 8 or change the value to 16 or 32 if you intend to use multiple specifications in the SmartPlant Electrical database. c. On the Character Set tab, click Choose from the list of character sets , and then select AL32UTF8 . d. From the National Character Set list, select AL16UTF16. 9. Click Next. 10. On the page Step 7 of 8: Database Storage , click Next. 11. On the page Step 8 of 8: Creation Options , select Create Database , and then click Finish. 12. Complete the Oracle database creation as described in your Oracle Installation Guide. 13. Restart your computer.

Create a New Oracle 10g Instance Important

Make sure that all passwords, user names, folders, and files of the new instance are different from those of any existing instance. 1. On the Start menu, click All Programs > Oracle – OraDb10g_home1 > Configuration and Migration Tools > Database Configuration Assistant . •



2. On the Welcome page, click Next. 3. In the Database Configuration Assistant Wizard, click Next until you reach the page Step 2 of 12: Database Templates . 4. Select Custom Database and click Next. 5. On the page Step 3 of 12: Database Identification , do the following: a. In the Global Database Name box, define the database name, for example, SPEL10gdb . b. In the SID box, accept or modify the instance name that the software enters automatically as you type the database name. Tip

The database name and the instance name do not have to be the same. 6. On the page Step 4 of 12: Management Options , clear Configure the Database with Enterprise Manager , and then, click Next. •

7. On the page Step 5 of 12: Database Credentials , in the Password and Confirm Password boxes, type the password, for example, Oracle . Tip

The following terms are reserved and cannot be used as passwords: manager (reserved for the SYSTEM user) and change_on_install (reserved for the SYS user). 8. Click Next until you reach the page Step 7 of 12: Database File Locations , and then do the following: •

a. Select Use Common Location for All Database Files . b. Specify the path and folder, for example, D:\oracle\ . c. Click Next. 9. On the page Step 8 of 12: Recovery Configuration , clear Specify Flash Recovery Data and click Next. 10. On the page Step 9 of 12: Database Content , do the following: a. On the Database Components tab, clear all the check boxes. b. Click Standard Database Components , and then, on the Standard Database Components dialog box, clear all the check boxes and click OK . c. If prompted you to disable local database management, click Yes. d. On the Custom Scripts tab, click No scripts to run . e. Click Next. 11. On the page Step 10 of 12: Initialization Parameters , on the Memory tab, do the following: a. Select Custom. b. In the SGA Size box, enter 160 M Bytes.



c. In the PGA Size box, enter 60 M Bytes. Tip •

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

12. Click the Character Sets tab and do the following: a. Select Use Unicode (AL32UTF8) . b. From the National Character Set list, select AL16UTF16. c. Select the default language and data format as needed. d. Accept the settings on the other tabs and click Next.



13. On the page Step 11 of 12: Database Storage , if you intend to create a SmartPlant Electrical or SmartPlant P&ID database in the current Oracle database, change the data file size of the TEMP and USERS tablespaces to 100 MB. Tip

To change the size, double-click the field under Size. 14. Click Next. •

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



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

Installing Oracle 9i Client Prerequisites Make sure that the Oracle client version ve rsion is compatible with your Oracle server version. Caution •

From Version 2007 of SmartPlant Electrical, Oracle client installation does not involve any checking or modifying the Oracle client character set. After the installation, you must must not change any of the default values of the NLS_LANG parameter on the client.

Install Oracle 9i Cli Client ent 1. Launch the Autorun.exe file and on the Oracle9i Server - Autorun page, click Install/Deinstall Products to start the Oracle Universal Installer. 2. On the Welcome page of the Oracle Universal Installer, click Next. 3. On the File Locations page, enter the source file path and the destination file name and path as desired, and then click Next. 4. On the Available Products page, click Oracle9i Client 9.2.0.1.0 , and then click Next. 5. On the Installation Types page, click Runtime (161MB) , and then click Next. 6. On the Summary page, click Install . The software completes the installation and displays the Configuration Tools page, from which it opens the Oracle Net Configuration Assistant. 7. On the Welcome page of the Oracle Net Configuration Assistant, click the option: No, I will create net service names myself , and then click Next.



8. On the Net Service Name Configuration, Database Version page, click Oracle8i or later database or service , and then click Next. 9. On the Service Name page, type the name of the SmartPlant Electrical database created on the Oracle database server machine, and then click Next. 10. On the Select Protocols page, select the Internet protocol TCP, and then click Next 11. On the TCP/IP Protocol page, do the following: a. In the Host name box, type the name of the server computer on which the SmartPlant Electrical database is located. b. Click Use the standard port number of 1521 . c. Click Next. 12. On the Text page, click Yes, perform a test , and then click Next. 13. On the Connecting page, on completing the text, click Next. 14. On the Net Service Name page, type an alias to establish a connection between the SmartPlant Electrical client application and database. Tip

The alias name can contain any alphanumeric characters without spaces. After installing the Oracle client, the alias value appears in the Intools.ini file as a value of the ServerName parameter in the [Database] section. 15. Complete the Oracle client installation creation as prompted in the succeeding Wizard pages. •

16. On the End of Installation page, click Exit. 17. Restart the client computer.

Installing Oracle 10g Client Prerequisites •

•

•

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


Installing and Configuring Oracle Caution •

From Version 2007 of SmartPlant Electrical, Oracle client installation does not involve any checking or modifying the Oracle client character set. After the installation, you must must not change any of the default values of the NLS_LANG parameter on the client.

Install Oracle 10g 10g Client 1. Start the Oracle Universal Installer for Oracle 10g client. 2. On the Installation Method page, from the Installation Type list, select one of the following: •

•

Standard Edition — If you want to install an Oracle client on a server machine where the operating system is Windows 2000 Server or Windows 2003 Server. Personal Edition — If the operating system is Windows XP.

3. Clear the Create Starter Database check box and then click Next. 4. On the Product-Specific Prerequisite Check page, ignore the Checking Network Configuration requirements warning and click Next. 5. On the Warning dialog box, click Yes. 6. If the OUI-10030 warning message appears, if the disk of the target folder has enough space, click Yes. 7. On the Summary page, click Install . 8. Complete the installation and then click Exit. 9. Restart the client machine. 10. Create an alias to the Oracle database on the client machine using Oracle Net Manager. Tip •

The alias name can contain any alphanumeric characters without spaces.

Regis Register ter DLLs with w ith RegSrv32 RegSrv32 If you install Oracle Client on your SmartPlant workstation after installing SmartPlant Engineering Manager or SmartPlant Electrical software, the setup process will not register the igrOraspconnect.dll file. To rectify this, this, after you install Oracle Client, do the following: 1. From the Windows Control Panel , select Add/Remove Programs .



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

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



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

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

ARCHIVELOG Mode We also recommend running Oracle in ARCHIVELOG mode, which copies filled online redo logs to disk. You must specify the mode at database creation or by using the ALTER DATABASE statement. You can enable automatic archiving either dynamically using the ALTER SYSTEM statement or by setting the initialization parameter LOG_ARCHIVE_START to TRUE. Running the database in ARCHIVELOG mode has several advantages over NOARCHIVELOG mode. You can: •

•

•

Back up the database while it is open and being accessed by users. Recover the database to any desired point in time. To protect the ARCHIVELOG mode database in case of failure, back up the archived logs.

For more information, please see the SQL*Plus Backup and Recovery Concepts document in your Oracle documentation. Other Recommendations Some users have found using the following settings beneficial. •

•

•

System Tablespace Max_Extents = UNLIMITED (If you choose to set this parameter to 505, the database monitoring system will warn you if the system tablespace is growing heavily. This setting has no impact on performance.) Tablespace System / initial und next set to 64KB (Setting the pctincrease parameter to 50 allows you to take advantage of the dynamic growth provided by Oracle, leading to larger extents in a large database.) R ollBackSegment und Temp-Tablespace create rollback segment tablespace rbs storage (optimal 10MB)



•

begin dbms_stats.gather_database_stats (cascate => TRUE); end;/ (Gathers statistics on the schemas. Use with the OPTIMIZER_MODE variable set to ALL_ROWS.)


Installing and Configuring Microsoft SQL Server

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

During the database server installation process you need to select a collation (combination of the SQL Server character set and sort order). If you use East Asian Windows language in your SQL Server client machines, you must select the Alternate dictionary order, caseinsensitive, uppercase preference, for use with the 850 (Multilingual) character set collation. In any other language environment, you can either accept the default selection or select the ...850 (Multilingual)... setting because it is suitable for any language environment. You must make sure that the default collation is case-insensitive.

Because system configurations, database software, and individual company standards vary, use this section as a checklist instead of step-by-step instructions. Please contact Intergraph Customer Support for specific configuration questions. 1. Using the Typical installation, load the Microsoft SQL Server software on your database server. 2. Configure SQL Server to create your custom database. You will need to provide the database node name, Administrator user name, and Administrator password when performing the configuration. 3. SQL Server Client is required on any SmartPlant computer on which you intend to create sites, plants, or projects, or on any computer that performs backup or restore operations. Important •

•

•

Microsoft Data Access Components (MDAC) 2.8.1 is required if you are using a SQL Server database. When creating and configuring your databases, keep in mind that plant structures must be created in a SQL Server database separate from the site server database and that each plant must be in its own database. If the backup location for your SQL site is located on a separate computer from your database, you must modify the logon information for the SQL Server services using the procedure that follows.



Modify Logon Information for SQL Server Services 1. From the Windows Control Panel , select Administrative Tools > Services . 2. In the Services list, double-click SQLServer (MSSQLServer) to open the SQLServer (MSSQLServer) Properties dialog box. Tips •

•

SQLServer (MSSQLServer) is the default instance for SQL Server 2005. For SQL Server 2000, the default instance is MSSQLSERVER. In place of the default instance, you can use a named instance, for example: SQLServer (SPEL).

3. Click the Log On tab. 4. Select This account and type the user name and password for the domain user who will be starting the MSSQLSERVER service. 5. Save your changes. 6. If the user defined in This account does not already have permissions to the share where backups are stored, grant the user read/write permissions to that share. For more information about MSSQLServer properties and granting permissions to domain users, refer to your SQL Server and Windows documentation.

Installing SQL Server Common Tasks The following tasks must be performed when installing SQL Server Versions 2000 or 2005 Server and Client installations for use with SmartPlant Electrical. SQL Server Database Server Setup •

Install SQL Server 2000 Database Server , page 49

•

Install SQL Server 2005 Database Server , page 53

Named Instance Creation On installing SQL Server 2000, the software automatically creates a default instance. You need to create a named instance in SQL Server 2000 if you have an existing SQL Server database server whose parameters do not comply with the parameters required to use SmartPlant Electrical on SQL Server. This way you can append the SmartPlant Electrical database to existing SQL Server databases on your SQL Server database server without losing your existing SQL Server database information. For details, see Create a Named Instance on SQL Server 2000, page 50. SQL Server Client Setup •

Install SQL Server 2000 Client , page 57



•

Install SQL Server 2005 Client , page 58

Installing SQL Server 2000 Database Server Install SQL Server 2000 Database Server 1. Run the SQL Server 2000 installation as described in the Microsoft SQL Server User's Guide till you open the Setup Type dialog box. 2. Select Custom as the setup type (required). 3. Click the upper Browse button to select the program files destination folder if you do not want to accept the displayed default. 4. Click the lower Browse button to select the data files destination folder if you do not want to accept the displayed default. 5. Click Next to continue. 6. On the Service Accounts dialog box, do the following: a. Make sure that the Use the same account for each service. Auto start SQL Server Service option button is selected. b. Select the Local System account option button. 7. Click Next to continue. 8. On the Authentication Mode dialog box, select Mixed mode (Windows Authentication and SQL Server Authentication) (required). 9. On the Collation Settings dialog box, do the following: a. Select SQL Collations (Used for compatibility with previous versions of SQL Server). b. From the collation list, select Alternate dictionary order, case-insensitive, uppercase preference, for use with the 850 (Multilingual) character set . Tip •

You must select the ...850 (Multilingual)... setting if your use East Asian Windows language in your SQL Server client machines. In any other language environment, you can either accept the default selection or select the ...850 (Multilingual)... setting because this setting is suitable for any language environment.

10. Click Next to continue. 11. On the Network Libraries dialog box, make sure that the following check boxes are selected: a. Named Pipes b. TCP/IP Sockets SmartPlant Electrical Installation and Upgrade Guide 49


12. On the Start Copying Files page, click Next. 13. On the Choose Licensing Mode dialog box, specify whether you purchased SQL Server licenses per seat or per processor. Tip

When specifying SQL Server licenses per seat, such a configuration only applies to the number of client machines, and is not related to the number of SmartPlant Electrical sessions that your users can have open concurrently. 14. Complete the database server installation as described in the Microsoft SQL Server User's Guide and restart your server machine when prompted. •

Note •

The software creates a SQL Server default instance automatically with the SQL Server 2000 installation. All other instances you create on this server after the server has been installed are considered named instances.

Create a Named Instance on SQL Server 2000 A named instance is a new instance you create on an installed SQL Server 2000. 1. Follow the instance creation procedures described in your Microsoft SQL Server User's Guide until you open the Installation Selection dialog box. 2. On the Installation Selection dialog box, select Create a new instance of SQL Server, or install Client Tools . 3. Click Next to continue. 4. On the Instance Name dialog box, type your instance name in the field provided. 5. Click Next to continue. 6. On the Setup Type dialog box, do the following: a. Click Custom. b. Click the upper Browse button to select the program files destination folder if you do not want to accept the displayed default. c. Click the lower Browse button to select the data files destination folder if you do not want to accept the displayed default. Caution

It is recommended that you install data files on separate physical disks each time you create a new instance. 7. Click Next to continue and follow the procedures described in your Microsoft SQL User's Guide to finish a new named instance creation. •



Setting Database Maintenance Options for SQL Server 2000 You set the database maintenance options for SQL Server using the DBCC Utility. It is recommended that you run the following options about once a week: •

CHECKCATALOG

•

CHECKDB Note

•

You must use an SA connection for running these options.

You should also update the database statistics as needed.

Run DBCC Utility Options 1. Click Start > Programs > Microsoft SQL Server > Query Analyzer . 2. On the Connect to Server dialog box, enter the required information as shown.

a. Beside SQL Server , select the name of your server or instance. b. Connect using SQL Server authentication . c. Type a login name. d. Type a strong password of a least 6 characters; this is a password that must include upper- and lower-case characters, numeric and non-alphanumeric characters. 3. Click OK . 4. In the SQL Query Analyzer window, if desired, select a different database from the one you logged on to.



5. On the toolbar, from the Execute Mode icon

, select Results in Text.

6. Type the appropriate query using the syntax shown, for example: DBCC CHECKCATALOG ('Site_Server1_DB')

Important •

•

You must enclose the name of your database within the quotes and parentheses as shown. Identical syntax applies for the CHECKDB command.

7. On the toolbar, click

(Execute Query).

8. View the lower window for the results of the query. Tip •

You can save the results to an external file. To do so, select Results to File and run the query again.

Note •

The software automatically corrects basic problems. For more complex problems, you must refer to the query results and correct these problems manually.



Update Statistics 1. Open the SQL Server Query Analyzer. 2. In the SQL Query Analyzer window, type the following SQL script with the name of your database, for example: USE Site_Server1_DB GO EXEC SP_UPDATESTATS

Note •

This script updates the statistics for every table in the databa se.

Installing SQL Server 2005 Database Server Install SQL Server 2005 Database Server 1. Start SQL Server 2005 Setup. 2. On the Microsoft SQL Server 2005 Setup wizard, click Next till you reach the page Components to Install . 3. On the Components to Install page, do the following: a. Select SQL Server Database Services . b. Select Workstation components, Books Online and development tools and then click Next. 4. On the Instance Name page, select Default instance and click Next. 5. On the Existing Components page (if displayed), click Next. 6. On the Service Account page, do the following: a. Select Use the built-in System account and then select Local system. b. Under Start services at the end of setup , select SQL Server and click Next. Tip

On the Service Account page, you must only select the SQL Server service. The other two services (SQL Server Agent and SQL Browser ) are not needed for any SmartPlant software product. After the database server setup, the SQL Server service is created with the Automatic startup type, the SQL Server Agent service is created with the Manual startup type, and the SQL Browser service is not created. 7. On the Authentication Mode page, do the following: •

a. Select Mixed Mode. b. Define the System Administrator password as you desire and click Next.



8. On the Collation Settings page, do the following: a. Select SQL collations . b. From the collation list, select Alternate dictionary order, case-insensitive, uppercase preference, for use with the 850 (Multilingual) character set . Tip

You must select the ...850 (Multilingual)... setting if your use East Asian Windows language in your SQL Server client machines. In any other language environment, you can either accept the default selection or select the ...850 (Multilingual)... setting because this setting is suitable for any language environment. 9. Click Next and complete the remaining steps. •

10. After clicking Finish, restart the server machine.

Configure SQL Server 2005 Database Server This procedure explains how to configure the server to avoid running out of memory. Notes •

•

By default, the server is configured to use unlimited memory. As a quick alternative to this procedure, you can stop and then restart the server.

To implement this procedure, you must have DBA permissions. 1. Click Start > Programs > Microsoft SQL Server 2005 Setup > SQL Server Management Studio . •

2. On the Connect to Server dialog box, enter the required information as shown.

a. Beside Server type, select Database Engine . 54 SmartPlant Electrical Installation and Upgrade Guide


b. Beside Server name, select the name of your server or instance. c. Beside Authentication , select SQL Server Authentication . d. Type a login name. e. Type a strong password of a least 6 characters; this is a password that must include upper- and lower-case characters, numeric and non-alphanumeric characters. 3. Click Connect. 4. In the Microsoft SQL Server Management Studio window, under the Object Explorer , select the server (top-level node), right-click, and on the shortcut menu, click Properties .

5. Select the Memory page and do the following: a. Select Use AWE to allocate memory . b. Under Maximum server memory (in MB) , set a suitable value. Tip

If it is likely that a large number of users will connect to the database concurrently, set the maximum memory to a higher value to avoid poor performance. 6. Select the Database Settings page and change the value of Default index fill factor to 80. •



Setting Database Maintenance Options for SQL Server 2005 You set the database maintenance options for SQL Server using the DBCC Utility. It is recommended that you run the following options about once a week: •

CHECKCATALOG

•

CHECKDB Note

•

You must use an SA connection for running these options.

You should also update the database statistics as needed.

Run DBCC Utility Options 1. Open the SQL Server Management Studio. 2. In the Microsoft SQL Server Management Studio window, under the Object Explorer , select the server (top-level node), right-click, and on the shortcut menu, click New Query. 3. Type the appropriate query using the syntax shown, for example: DBCC CHECKCATALOG ('Site_Server1_DB')

Important •

•

You must enclose the name of your database within the quotes and parentheses as shown. Identical syntax applies for the CHECKDB command.

4. Click Query > Execute . 5. View the Messages window for the results of the query. Tip •

You can save the results to an external file. To do so, click Query > Results To > Results to File .

Note •

The software automatically corrects basic problems. For more complex problems, you must refer to the query results and correct these problems manually.



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

Note •

This script updates the statistics for every table in the databa se.

Installing SQL Server Client: An Overview The SQL Server client provides with the means to interface with the SQL Server database server. You can install the SQL Server client on each client machine after you have completed the SQL Server database server installation. Before you install the SQL Server client on a client machine, ensure that: •

•

•

SQL Server database server is installed on a database server machine. The SQL Server client version is compatible with your SQL Server database server version. You have appropriate access rights to the SQL Server database server.

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

Install SQL Server 2000 Client 1. Start SQL Server 2000 Setup. 2. In the wizard, click Next till you reach the Select Components page. 3. If you want to install a minimal version of SQL Server client, make sure that on the Select Components page of the installation wizard, you select check boxes for the following components and sub-components: •

•

Client Connectivity Management Tools



•

•

Enterprise Manager — a sub-component of Management Tools Conflict Viewer — a sub-component of Management Tools Caution

If you do not select the Management Tools component with subcomponents Enterprise Manager and Conflict Viewer , you cannot use audit trail options in SmartPlant Instrumentation because the software does not create audit triggers. For more information on the audit trail options, see the Administration User's Guide, Domain and Project Administration > Managing Audit Trail Data. 4. After clicking Finish, restart the client machine. •

Install SQL Server 2005 Client 1. Start SQL Server 2005 client Setup to open the Microsoft SQL Server 2005 CTP Setup wizard. 2. In the wizard, click Next till you reach the Components to Install page. 3. On the Components to Install page, select Workstation components, Books Online and development tools and then click Next and complete the remaining steps. 4. After clicking Finish, restart the client machine.


Installing SmartPlant Software

Installing SmartPlant Software After installing and configuring the database software and any of the prerequisite software, you are ready to install the SmartPlant software.

Grant Permissions to Write to a Registry Key If you are installing over an older version of the SmartPlant software, you may receive an error during the installation process stating that setup does not have permission to modify one or more registry keys. This procedure explains how to grant write permissions to the registry keys. For computers running Windows XP 1. Click Start > Run. 2. Type regedit.exe , and click OK . 3. In the left window, select the HKEY_LOCAL_MACHINE > SOFTWARE > Intergraph > Applications registry key. 4. Right-click and select Permissions . 5. On the Permissions for dialog box, click Advanced. 6. At the bottom of the Advanced Security Settings dialog box, clear the option: Inherit from parent the permission entries that apply to child objects. Include these with entries explicitly defined here . 7. A security dialog box appears to verify your change. Click Remove. 8. Reselect the Inherit from parent the permission entries that apply to child objects. Include these with entries explicitly defined here check box. 9. Select the Replace permission entries on all child objects with entries shown here that apply to child objects check box. For computers running Windows 2000 1. Click Start > Run. 2. Type regedt32.exe , and click OK . 3. Select the HKEY_LOCAL_MACHINE > SOFTWARE > Intergraph > Applications registry key. 4. Click Security > Permissions . 5. Click Advanced. 6. Click on Allow inheritable permissions from parent to propagate to this object to deactivate the check box. 7. A security dialog box appears to verify your change. Click Remove.



8. Reselect the Allow inheritable permissions from parent to propagate to this object check box. 9. Select the Reset permissions on all child objects and enable propagation of inheritable permissions check box.

Install SmartPlant Engineering Manager 1. Insert the product CD into the CD-ROM drive. If the installation does not start automatically, double-click setup.exe in the main folder. 2. Click SmartPlant Engineering Manager Installation . 3. Click Next to start the installation wizard. 4. Type your User Name, Company Name , and Serial Number, then click Next. 5. Verify your Name, Company, and Serial Number, then click Yes. 6. Click Display to view and read the license agreement. You must have Adobe Reader to view the license agreement. Adobe Reader is available on the product CD. 7. Close the Adobe Reader window, then click Yes to accept the license agreement. 8. Specify the Destination Folder , then click Next. 9. Verify that the appropriate components are selected, then click Next. Tip

If you want to upgrade your SmartPlant Engineering Manager data, be sure that you select Upgrade Utility to install the SmartPlant Engineering Upgrade Utility. For more information, see Using the SmartPlant Engineering Upgrade Utility, page 75. 10. Accept the default Program Folders or select a new Program Folder name, then click Next. •

11. Review your Current Settings , then click Next to install SmartPlant Engineering Manager. 12. Click Finish to close the installation wizard. Notes •

•

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



Install SmartPlant Electrical 1. If you have not already installed and configured SmartPlant License Manager on your workstation, we recommend doing so before installing SmartPlant Electrical. Important

SmartPlant Electrical requires the SmartPlant License Manager software for concurrent licensing for both the core SmartPlant Electrical product and for each manager. This licensing software is delivered on its own CD that comes with your SmartPlant Electrical product CD. For more information about using and configuring concurrent licensing, see the SmartPlant License Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf). 2. Insert the SmartPlant Electrical CD into the CD-ROM drive. If the installation does not start automatically, double-click setup.exe in the main folder. •

3. Click SmartPlant Electrical Installation . 4. Type your User Name, Company Name , and Serial Number, then click Next. 5. Verify your Name, Company, and Serial Number, then click Yes. 6. Click Display to view and read the license agreement. You must have Adobe Reader to view the license agreement. Adobe Reader is available on the product CD. 7. Close the Adobe Reader window, then click Yes to accept the license agreement. 8. Specify the destination folder, then click Next. 9. Verify that the appropriate components are selected, then click Next. Tip

For a configuration in an integrated environment, be sure to install the Integration Resource Files during reference data installation. Be sure the Integration Resource Path setting in Options Manager points to this folder. For more information, see Install SmartPlant Reference Data, page 62. 10. Accept the default Program Folder or type a new Program Folder name, then click Next. •

11. Review your Current Settings , then click Next to install SmartPlant Electrical. 12. Click Finish.

Install SmartPlant Electrical Over a Previous Installation You can install SmartPlant Electrical over a previous installation if you need to modify the installed components or repair those components that stopped working.



1. Insert the SmartPlant Electrical CD into the CD-ROM drive. If the installation does not start automatically, double-click setup.exe in the main folder. 2. Click SmartPlant Electrical Installation . 3. On the Installation for SmartPlant Electrical Setup Type dialog box, do one of the following: •

•

Click Add or remove installed components to run Setup again, which allows you to remove installed components, repair the current installation, or to install new components. Click Expand evaluation license to update your evaluation license or to upgrade from an evaluation license to an full license.

Install SmartPlant Reference Data 1. Insert the product CD into the CD-ROM drive. If the installation does not start automatically, double-click setup.exe in the main folder. 2. Click Reference Data for SmartPlant Electrical Installation . 3. Click Next to start the installation wizard. 4. Click Display to view and read the license agreement. You must have Adobe Reader to view the license agreement. Adobe Reader is available on the product CD. 5. Close the Adobe Reader window, then click Yes to accept the license agreement. 6. Type your User Name and Company Name , then click Next. 7. Specify the Destination Folder , then click Next. 8. Verify that the appropriate components are selected, then click Next. Tips •

For a configuration in an integrated environment, be sure to install the Integration Resource Files during reference data installation.

After installation, be sure the Integration Resource Path setting in Options Manager points to this folder. 9. Review your Current Settings , then click Next to install the reference data. •

10. Click Finish to close the installation wizard. 11. After installation, share the folder that contains the reference data. All SmartPlant users must be granted read permission to this share. Write permission to the share is required to make changes to the symbols, rules, templates, and other reference data.


Installing SmartPlant Software Important •

We recommend that you make a copy of the reference data and store it with your plant files. This common practice will help you with future service pack installations, data recovery, and so forth.

Configuring Reference Data for SmartPlant Electrical SmartPlant Reference Data for SmartPlant Electrical contains the symbols, data dictionary, filters, and other information that you use to create and manage electrical engineering data. The default location for the reference data is C:\Program Files\SmartPlant\Electrical Reference Data. With SmartPlant Electrical Options Manager, you can identify the location of symbols, drawing and report templates, as well as other reference data. You can also define naming conventions, default preferences, formats for data, item type parameters, and various general settings (for example settings used for cable sizing calculations). Usually, a project manager sets these options at the beginning of a project. The project manager seldom modifies these options except on rare occasions when project requirements dictate a change. For more information, see the SmartPlant Electrical Options Manager documentation. Important •

For a configuration in an integrated environment, be sure the Integration Resource Path setting in Options Manager points to the Integration Resource Files installed with the SmartPlant Electrical Reference Data.



Installing SmartPlant Electrical in Silent Mode Silent mode installation is a two-stage process. First, you perform a normal installation by running the setup.exe file from the command line with special parameters that cause the software to record the installation session and the options you choose to a file with an .iss extension. Then, from any workstation, you can run setup in silent mode using the recorded .iss file to provide the necessary setup information. Important •

•

•

Because SmartPlant Electrical installation requires SmartPlant License Manager software for concurrent licensing, you must install the SmartPlant License Manager software on your workstation prior to creating a silent setup of SmartPlant Electrical and on each workstation where you will be silently installing SmartPlant Electrical. For more information about installing and configuring SmartPlant License Manager, see the SmartPlant License Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf). The environment of the machine on which you run the normal setup to create the .iss file and the environment of the workstations on which you perform the silent mode installation must be identical; that is, they must have the same database platforms, software versions, installed files, drive partitions, and so forth. You must also ensure that there is sufficient disk space on each workstation for the installation. Prior to creating a silent setup of SmartPlant Electrical over a network, ensure that the following conditions exist: •

•

•

•

For a new release, all previous existing versions of SmartPlant Electrical on the target machine have been uninstalled prior to network installation. The target machine does not have a directory by the same name to which SmartPlant Electrical is to be installed. The target machine meets the free disk space recommendations specified in SmartPlant Electrical Workstation, page 20. All applications are closed.

Install SmartPlant Electrical in Silent Mode 1. Open a Command Prompt window from the Start menu. 2. At the command prompt, type: "\setup.exe" -r -f1"\.iss" .


Installing SmartPlant Software Caution •

Be sure the specifies the path to the folder that contains the setup.exe file that launches the SmartPlant Electrical InstallShield Wizard, not the setup.exe file that launche s the SmartPlant Electrical AutoPlay executable. For example, on the SmartPlant Electrical CD, the setup.exe file in the Electrical folder is the file that launches the InstallShield Wizard. Double quotes are required only if the path to the setup.exe file contains spaces. Tips

•

•

The -r parameter tells setup to automatically generate the silent setup file (.iss), and to record all setup input. The -f1"\.iss" parameter specifies the path and filename for the silent setup file. The double quotes are required around this path, with no space between the -f1 and the opening double quotes. For example, if you type the following command string, the software places the resulting .iss file in the c:\installfiles folder. \\sourceserver\instrumentation\setup.exe -r -f1"c:\installfiles\ silentsetup.iss"

3. Work through the standard software installation on your database platform. For details, refer to the appropriate procedure in the SmartPlant Electrical Installation and Upgrade Guide. Note •

When you click Display on the License Agreement dialog box while running setup in record mode, the following message appears.

Click OK to acknowledge that you are accepting the license agreement for all users on whose computers you will install the product. Setup then returns you to the normal installation process by displaying the license agreement and enabling the Yes button on the License Agreement dialog box. 4. At each workstation on which you want to install the software, open a Command Prompt window and type: •

"\setup.exe" -s -f1"\.iss" f2"\.log"


Installing SmartPlant Software Caution •

Be sure to use the same setup executable that you used in step 3, above. Tips

•

•

The -s parameter tells setup to run in silent mode using the indicated .iss file. The -f1"\.iss" parameter specifies the path and the filename for the silent setup (.iss) file you want to run. The double quotes are required, with no space between the -f1 and the opening double quotes. For example, -f1"c:\installfiles\silentsetup.iss" .

(Optional) Use the -f2"\.log" parameter to record a log file of the setup process. The double quotes are required, with no space between the -f2 and the opening double quotes. For example, f2"c:\installfiles\silentsetup. log" . If -f2 is not defined, a log file is created in the same location as the .iss file. 5. Check the .log file to ensure that the installation proceeded without errors. A successful silent installation produces a .log file looking something like this: •

[InstallShield Silent] Version=v7.00 File=Log File [ResponseResult] ResultCode=0 [Application] Name=SmartPlant Electrical Version=2007 (04.00.00.20) Company=Intergraph Lang=0009

In general, if an error occurred, the ResultCode will be a number less than zero. Possible result codes include the following: Any value greater than 0 = Success. -1 General error. -2 Invalid mode. -3 Required data not found in the Setup.iss file. -4 Not enough memory available. -5 File does not exist. -6 Cannot write to the response file. -7 Unable to write to the log file. -8 Invalid path to the InstallShield Silent response file. -9 Not a valid list type (string or number). -10 Data type is invalid. -11 Unknown error during setup. -12 Dialog boxes are out of order. -51 Cannot create the specified folder. -52 Cannot access the specified file or folder. -53 Invalid option selected.


Installing SmartPlant Software Note •

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


Working in Thin Client Mode

Working in Thin Client Mode Overview You can use SmartPlant Electrical in thin client mode, which supports Citrix Presentation Server or Microsoft Terminal Server using Remote Desktop for Administration. For installation details of Citrix Presentation Server client / server or Microsoft Terminal Server, refer to the appropriate software vendor's documentation Caution •

When you access the SmartPlant Electrical application via Citrix, we strongly recommend that you do not perform any administration activities that run automatically for a long time on a client machine. When you execute administration activities via Citrix client, the software actually performs these activities on the server side, while the client remains idle, and the connection to Citrix is lost, possibly resulting in corruption of data. Examples of these type of administration activities are: upgrading the database to a new version, importing data using Import Manager, or importing reference data using Options Manager. As a workaround, we recommend that you perform these kind of activities either on your database server machine or on a client machine using a configuration other than Citrix.

Tuning the Software for Use in Thin Client Mode The following procedures describe special instructions for the installation of SmartPlant Electrical when working in thin client mode using Citrix Presentation Server XP Release 2 on Windows 2000 Server or Windows 2003 Server. Tuning SmartPlant Electrical involves performing the following operations: •

•

•

Installing SmartPlant Electrical on a Citrix Presentation Server. Publishing the SmartPlant Electrical program to view SmartPlant Electrical on a web page or in a published Citrix application list. Configuring Citrix Presentation Server for SmartPlant Electrical.



Publish the SmartPlant Application You need to publish the application to allow you to view the data using a web page. 1. On the Start menu, click Programs > Citrix > Metaframe Presentation Server to start the Citrix Management Console. Tip

The names of dialog boxes may vary from the ones described in this document according the version of Citrix Presentation Server that you are using. 2. Click Action > New > Published Application . •

3. In the Published Application wizard, type a display name such as SmartPlant Electrical , and an application description, and then click Next. 4. On the Specify What to Publish page, do the following: a. Click the Application option button (the default). b. Beside Command Line , click Browse to navigate to the SmartPlant Electrical executable file location. c. Click Next. 5. On the Program Neighborhood Settings page, if desired, define a program neighborhood folder and add shortcuts for the clients, and then click Next. 6. On the Specify Application Appearance page, specify the window size, color, and start-up settings according to your needs, and then click Next. 7. On the Specify ICA Client Requirement page, accept the default value, and then click Next. 8. On the Specify Servers page, add the Citrix server and then click Next. 9. On the Specify Users page, add the user accounts that are to be granted access to the published application and then click Finish. 10. After publishing the application, do the following to create the .ica and .html files: a. On the Citrix Management Console , select the SmartPlant Electrical application, right-click, then click Create ICA File and follow the wizard instructions. b. On the Citrix Management Console , select the SmartPlant Electrical application, right-click, then click Create HTML File and follow the wizard instructions.



Configure Citrix Presentation Server 4.0 1. Configure Citrix Presentation Server to mount a user drive with a common drive letter (for example, U:) and create a common folder path for the program in this drive, for example, U:\Program Files\SmartPlant\Electrical . Tip

Make sure that the common folder path contains the SmartPlantV4.ini file. You can also use this folder for temporary files. 2. Modify the system path statement on the server to include the common folder path in the system path. •

3. In the path C:\Winnt\Application Compatibility Scripts , open the file Rootdrv2.cmd and set the following parameter: Set RootDrive=U.

Terminal Server Logon Sequence The following section describes the logon sequence of system procedures carried out automatically. Important

Ensure that you have edited the Rootdrv2.cmd file to specify the home folder drive letter. For this installation, you need to change the line Set RootDrive=DriveLetter to Set RootDrive=U . The U: drive points to C:\Documents and Settings\ . 1. When a user logs on to Windows 2000 Server or Windows 2003 Server, a logon script Userlogon.cmd starts running. Therefore, you can run any prelogon command or script from this file. •

2. The Userlogon.cmd file calls the Userlogn1.cmd file which contains the compatibility logon scripts. 3. The Userlogon.cmd file checks whether you have set up the logon to the user's home folder. The Userlogon.cmd file then calls the Rootdrv.cmd file located in the path C:\Winnt\Application Compatibility Scripts . 4. The Rootdrv.cmd file calls the Rootdrv2.cmd file.


Upgrading SmartPlant Electrical to Version 2007

Upgrading SmartPlant Electrical to Version 2007 When upgrading to version 2007 of SmartPlant Electrical, you use Version 5.0 of the SmartPlant Engineering Upgrade Utility to upgrade the plant, project, and application database. Note •

Upgrade is available from Versions 2.0 (service pack 2), 3.0, and 3.5. Important

•

Before upgrading SPEL to version 2007 you must upgrade from Oracle version 8.0 to 9.0. The SmartPlant Engineering Upgrade Utility 5.0 upgrades SmartPlant Electrical versions 2.0 Service Pack 2, 3.0, and 3.5 to version 2007. If you are upgrading from an earlier version of SmartPlant Electrical, you must first upgrade to SmartPlant Electrical 2.0 Service Pack 2 before moving to 2007. For more information, visit the following Web site: http://ppm.intergraph.com/services/support.asp.

•

•

Version 5.0 of SmartPlant Engineering Manager can display sites and plants created in version 4.4 (SmartPlant Electrical 4.0), 4.3 (SmartPlant Electrical 3.0), and version 4.2 (SmartPlant Electrical 2.0). While the plants that have not been upgraded will appear in the Tree view, none of the data below the plant will be available. Attempting to work in a non-upgraded plant results in a message stating that the plant must be upgraded first. Before using the new version of the software, we strongly recommend that you completely upgrade your plant to the current version. A plant with a mixture of upgraded and non-upgraded data may result in some data being permanently inaccessible.



Before Running the Upgrade Utility The following tasks must be completed before you begin upgrading your plant using the Upgrade Utility.

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

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

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



hash_join_enabled=true

True is the default setting. However, you should make sure the setting was not previously changed to False.

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

Plants with Multiple Naming Convention Definitions for Cables When upgrading from SmartPlant Electrical 2.0 or SmartPlant Electrical 2.0 Service Pack 1 to SmartPlant Electrical 2.0 Service Pack 2 for a plant that has multiple naming convention definitions for cables, make sure that each naming convention has a name. Perform the following procedure before running the upgrade to SP2: 1. In Options Manager, open the Naming Convention window. 2. Select the hierarchy level where the cable item type was defined. 3. Select item type Cable. 4. Write down the naming convention definitions and then delete this convention. 5. Redefine the cable naming convention. You must give a name to the convention and it must get a priority number. 6. Save the changes you made to the naming conventions. 7. Close Options Manager. 8. Continue with the upgrade procedure according to the instructions in the documentation.



Memory Management Considerations Upgrading database information requires significant changes and, therefore, a significant amount of database server resources. For that reason, Intergraph makes the following recommendations. •

•

•

Upgrade only one plant at a time on a database server. As much as possible, limit other activity on the database server during the upgrade process. You should limit the use of SmartPlant applications on the server, as well as access to the database by other plants. The more database server resources available for upgrade, the faster the upgrade process will proceed. The more activity occurring on the database server during the upgrade process, the longer that process will take.



Using the SmartPlant Engineering Upgrade Utility The SmartPlant Engineering Upgrade Utility upgrades the site, plant, and application databases to the latest version of SmartPlant. Use Version 2007.5 of the SmartPlant Engineering Upgrade Utility to upgrade the following product versions. Product

From

To

SmartPlant Engineering Manager

4.3

2007 (5.0)

4.4 SmartPlant P&ID

4.2

2007 (5.0)

4.3 SmartPlant Electrical

2.0 SP2

2007 (4.0)

3.0 3.5 Upgrading Plants Created with SmartPlant Engineering Prior to Version 4.3 You must first upgrade any plants, created with SmartPlant Engineering Manger before version 4.3, using the Upgrade Utility version 4.4, and then use the 2007.5 version of the Upgrade Utility to upgrade your plants to 2007.5. Upgrading P&IDs Created with SmartPlant P&ID Prior to Version 4.2 You must first upgrade any P&IDs, created with SmartPlant P&ID before version 4.2, using the Upgrade Utility version 4.4, and then use the 2007.5 version of the Upgrade Utility to upgrade your P&IDs to 2007.5. Upgrading Plants Containing Projects Running the Upgrade Utility on a plant containing projects upgrades both the plant and its projects at the same time. Each of the upgrade tasks handle any necessary changes in both the plant databases and the project databases. Upgrading Satellites in a Workshare Collaboration You no longer have to collapse or shut down projects or satellites in Workshare collaborations before upgrading. Upgrading a satellite is a separate process. The host for a connected satellite must be upgraded before the satellite.


Upgrading SmartPlant Electrical to Version 2007 Important •

•

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

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

2. Select the plant in the Tree view to see the upgradeable applications available for that plant.

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



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

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

Important •

•

You must complete all upgrade tasks for a plant before you upgrade the reference data or drawings in the plant. The rules file for the upgraded plant are marked as out-of-date for the Update Drawings commands in Drawing Manager. The formats and select lists will be marked as up-to-date.

Related Topics Finish All Tasks Command , page 79 Finish Next Task Command , page 79 Run to Selected Task Command , page 80 Upgrade Plant Command , page 81 •

•

•

•

Upgrade SmartPlant Electrical Important •

Before upgrading a SmartPlant Electrical plant connected to a SQL Server database, make sure the database instance is not set to 'case sensitive'.



1. Select the plant in the Active Plants node, right-click and select the Upgrade Electrical command.

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

3. Right-click in either view and select Finish All Tasks to start the upgrade process.

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



Note •

After the Upgrade Utility has finished, you must check in SmartPlant Electrical Options Manager in the Locations window that the reference data paths are correct. In some instances you may find that some sections of the reference data paths have been changed to , this should be replaced with the correct reference data path..

Related Topics Finish Next Task Command , page 79 Run to Selected Task Command , page 80 Upgrade Electrical Command , page 80 •

•

•

Upgrade Utility Commands The Upgrade Utility provides the following commands.

Finish All Tasks Command Runs all uncompleted tasks listed in the Upgrade Tasks view. The status of each task appears in the Status column. Note •

The Upgrade Utility records how far it progresses during an upgrade task so that it can recover if system problems occur.

Finish Next Task Command File > Finish Next Task

Runs the first uncompleted task in the Upgrade Tasks view. The status of each task appears in the Status column.


Upgrading SmartPlant Electrical to Version 2007 Note •


Open Site Command File > Open Site

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

Run to Selected Task Command File > Run to Selected Task

Runs all uncompleted tasks up to and including the selected task. The status of each task appears in the Status column in the Upgrade Tasks view. Note •


Show Log Command File > View Log

Displays the upgrade log file. Notes •

•

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

Upgrade Electrical Command Upgrade > Upgrade Electrical

Displays the upgrade tasks required for the SmartPlant Electrical application upgrade process. Click one of the File > Finish commands to actually start the upgrade process. Related Topics Finish Next Task Command , page 79 •



Upgrade Plant Command Upgrade > Upgrade Plant

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

Click File > Finish Next Task or File > Finish All Tasks to actually start the upgrade process. If you have not yet run a task, you can cancel the upgrade process by selecting the plant under the Upgrades in Progress node and clicking File > Cancel to restore the pre-upgrade state. Important •

•

•

You must complete all upgrade tasks for a plant before you upgrade the reference data or drawings in the plant. The rules file for the upgraded plant are marked as out-of-date for the Update Drawings commands in Drawing Manager. The formats and select lists will be marked as up-to-date. You cannot upgrade a backed up plant without restoring it first.

Related Topics Upgrade a Plant , page 76 •



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

Upgrade Site Command Tools > Upgrade Site

When you open a Version 4.x site using SmartPlant Engineering Manager 2007, you are prompted to upgrade the site to Version 2007. Use the Upgrade Site command to perform the upgrade. This process removes the restriction in which projects with the same name canno t reside in the same plant and then updates the site data dictionary version number to 2007.

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

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



Preserving Software Customizations The Upgrade Utility does not make changes that might overwrite user customization of display names, property formats, calculation programs, validation programs, or layouts. To avoid overwriting your software customization, the following changes are not reflected in upgrades: •

•

Many of the display names that appear in the Properties window were corrected or modified to make the names clearer or more consistent. The default layouts for the Engineering Data Editor were rebuilt. Important

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

menu and select Edit

4. In the Table Properties dialog box, click Advanced . 5. Click the Layout tab. 6. Select the PipingPoint property in the Display Property list. Tip

PipingPoint properties start with the word end , such as End, End 2, End 3, and End 4. 7. Confirm that the caption is appropriate for the property. •

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

•

For a list of all changes made during the plant upgrade, including each upgrade subtask, see the plant upgrade log file. The log file, named UpgradeV4_ p lant name .log, is saved in the folder where the drawings for the plant are stored. To view the plant upgrade log file, select the plant in the Tree view, and then click File > Show Log .



Making Manual Changes After running the Upgrade Utility, the following changes for Version 2007 must still be performed manually: •

•

•

•

•

Opening and saving the rules file so that the new rule options are added to the Rules.rul file. Adding all the new rules for jacketing. Adding the new rule for Serial Lines (Instrument Signal Lines). Creation of the graphics on the Jacket Layer of the symbols for jacketing. Possibly copying any new or modified symbols from ~\Program Files\SmartPlant\P&ID Reference Data to the plant's reference data, making sure that you do not overwrite any customizations.


Configuring SmartPlant Engineering Manager

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

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

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



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



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

Database User Name

Example

Site Schema

Name of the site

Site1

Site Data Dictionary

Site Schema user name + 'd'

Site1d

Plant Schema

Name of the plant

Plant1

Plant Data Dictionary Schema

Name of the plant + 'd'

Plant1d

P&ID Schema

Plant schema user name + 'pid'

Plant1pid

P&ID Data Dictionary Schema

Plant schema user name + 'pidd'

Plant1pidd

Electrical Schema

Plant schema user name + 'el'

Plant1el

Electrical Data Dictionary Schema

Plant schema user name + 'eld'

Plant1eld

Electrical Reference Schema

Electrical schema user name + 'ref'

Plant1elref

Satellite Plant Schema

Plant schema user name + 'sat' + satellite count

Plant1sat1

Satellite P&ID Schema

Satellite plant schema user name + 'pid'

Plant1sat1pid

Satellite Replication Schema

Satellite plant schema user name + 'rep'

Plant1sat1rep

Project Schema

Plant schema user name + 'p' + project count

Plant1p1

Project P&ID Schema

P&ID schema user name + 'p' + project count

Plant1pidp1

Project Electrical Schema

Electrical schema user name + 'p' + project count

Plant1elp1


Configuring SmartPlant Engineering Manager Notes •

•

•

•

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

Related Topics Associate Applications Wizard , page 110 New Site Server Wizard , page 108 •

•



Working with Data Dictionaries: An Overview SmartPlant Engineering Manager allows you to add or edit attributes in plant and application data dictionaries and then create data dictionary templates from the modified plant or application data dictionaries. You can then move the template to a new site and use it to populate a new plant or application schema. For example, you can make your plant customizations one time, create a template of that data dictionary, and then use that template in other sites, much like copying a plant from site to site, rather than having to perform the same modification steps at each site. Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. Caution •

•

•

The data dictionary template file is a collection of all filters, plant group types, Options Manager settings, and other database-related items (anything that's not stored in external files, like Rules or Symbols). When using a data dictionary template to create a plant in another site, you must have the proper rules file (which relies on filters) to go with that template. Rules, insulation specification, symbols, and other file-based reference data are not included in data dictionary templates. In a Workshare collaboration, you cannot create a plant or application data dictionary template at a satellite site. You must create the templates at the host site. Data dictionary templates are not upgradeable. However, you can use the Data Dictionary Template Comparison Utility to compare your existing template with the default template delivered with the latest version of SmartPlant Engineering Manager.

Related Topics Data Dictionary Manager Command , page 89 New Data Dictionary Template Command , page 90 New Data Dictionary Template Dialog Box, page 91 •

•

•

Data Dictionary Manager Command Tools > Data Dictionary Manager

Starts Data Dictionary Manager, allowing you to add and edit attributes in the plant data dictionaries within the site.



To add attributes to a plant group type in an active plant structure, select the plant structure and click Tools > Data Dictionary Manager . To add, modify, or delete attributes for the plant group type attributes, select the Plant Group Types node and then click Tools > Data Dictionary Manager . Attributes added to a plant group type using this method are not automatically included in the attributes for active plant group structures that use that plant group type. Important •

•

•

To access the site data dictionary, start Data Dictionary Manager outside SmartPlant Engineering Manager. When started from within SmartPlant Engineering Manager, Data Dictionary Manager can access only the plant data dictionaries. You cannot swap between data dictionaries once Data Dictionary Manager is running. After accessing Data Dictionary Manager from within SmartPlant Engineering Manager and making changes, you must either exit and restart SmartPlant Engineering Manager or reopen the site to see the changes from within SmartPlant Engineering Manager. Do not use Oracle reserved words (for example, "address") as attribute names.

Related Topics New Data Dictionary Template Command , page 90 New Data Dictionary Template Dialog Box, page 91 •

•

New Data Dictionary Template Command Tools > New Data Dictionary Template

Generates a template .ddt file based on the selected plant or application schema. Use this command to create a data dictionary template from a data dictionary that you have modified via the Tools > Data Dictionary Manager command. A plant data dictionary template file contains all the information in the plant schema. The application data dictionary temple contains all filters, plant group types, Options Manager settings and symbology, and other database-related items (anything that's not stored in external files, like rules or symbols). Caution •

Data dictionary templates are not upgradeable. You cannot use a template created using an older version of SmartPlant Engineering Manager to create a plant or application schema.



•

•

Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. When using a data dictionary template to create a plant in another site, you must have the proper rules file (which relies on filters) to go with that template. Rules, insulation specification, symbols, and other file based reference data are not included in data dictionary templates.

Related Topics Data Dictionary Manager Command , page 89 New Data Dictionary Template Dialog Box, page 91 •

•

New Data Dictionary Template Dialog Box Allows you to generate a template from an existing plant or application data dictionary.

Template file - Allows you to specify the path and file name for the new template. Source name - Available only when creating an application template, this field displays the internal name of the source data dictionary template used to create the existing application data dictionary. You can type a new name to be used in place of Imperial or Metric in the Plant Settings table in the plant schema. Related Topics Data Dictionary Manager Command , page 89 New Data Dictionary Template Command , page 90 •

•



Create a Data Dictionary Template 1. Select the plant or application from which you can to create the template and click Tools > New Data Dictionary Template . Tips •

To create a plant data dictionary template, select the in the Tree view.

Plant node

To create an application data dictionary template, select the Applications node in the Tree view and then select the application in the List view. 2. In the Template file box, browse to the path where you want the template file saved and then type a file name for the template file. •

3. If you are creating an application template, type the Source name for the application data dictionary template. By default, this field displays the name of the source data dictionary template used to create the existing application data dictionary. Caution •

•

•

Data dictionary templates are not upgradeable. You cannot use a template created using an older version of SmartPlant Engineering Manager to create a plant or application schema. Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. When using a data dictionary template to create a plant in another site, you must have the proper rules file (which relies on filters) to go with that template. Rules, insulation specification, symbols, and other file based reference data are not included in data dictionary templates.

Related Topics Data Dictionary Manager Command , page 89 New Data Dictionary Template Command , page 90 •

•



Using Default Settings: An Overview SmartPlant Engineering Manager allows you to predefine values for creating sites, plant structures, projects, and associating application. Using these default settings simplifies the creation process and allows you to use the same settings across sites and plants. Important •

The values specified on the Default Settings dialog box are used by default only if you turn on the Tools > Use Default Settings command.

Related Topics Default Settings Command , page 93 Default Settings Dialog Box, page 93 Use Default Settings Command , page 99 •

•

•

Default Settings Command Tools > Default Settings

Displays the Default Settings dialog box, which allows you to predefine settings for populating the corresponding values in the New Site Server, New Plant Structure , and Associate Applications wizards. These wizards use the values specified on this dialog box only if you turn on the Tools > Use Default Settings command. Related Topics Default Settings Dialog Box, page 93 Use Default Settings Command , page 99 Using Default Settings: An Overview, page 93 •

•

•

Default Settings Dialog Box Allows you to predefine values for populating the corresponding values in the New Site Server , New Plant Structure , and Associate Applications wizards. Important •

The default settings values are used by default only if you turn on the Tools > Use Default Settings command.

Related Topics Default Settings Command , page 93 Use Default Settings Command , page 99 •

•



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

Oracle - Select this option if you are using an Oracle database. This information is carried forward from the site properties, but you can modify it for subsequent plant creations. Oracle alias - Type the name of the Oracle net service alias used by the site in which the plant will be created. Refresh - Click this button to update the entries in the tablespace lists if you have changed the system user name or password entries. System user - Type a database system user name. This name does not have to be the database administrator user name, but this user must have system privileges. System password - Type the system password. Oracle tablespace - Select a default Oracle tablespace name for your plant database.


Configuring SmartPlant Engineering Manager Important •

We recommend that you do not use SYSTEM for the default tablespace, because Oracle uses this tablespace for its own use.

Oracle temp tablespace - Select a default Oracle temporary tablespace name for your plant database. If this list is empty, contact your database administrator. SQL Server - Select this option if you are using a SQL Server database. This information is carried forward from the site properties, but you can modify it for subsequent plant creations. Server - Type the node name of the server on which the SQL Server database resides. Refresh - Click this button to update the database information if you have changed the system user name or password entries. System user - Type a database system user name. This name does not have to be the database administrator user name, but this user must have system privileges. System password - Type the system password. Note •

Database usernames and passwords cannot contain any of the following characters: . < , > ? \ / ' ; { } [ ] ~ ` ! % * ( ) & $ @ # "

Related Topics Default Settings Command , page 93 Use Default Settings Command , page 99 •

•

Paths Tab (Default Settings Dialog Box) Displays the path settings you can predefine for populating the corresponding values in the New Site Server , New Plant Structure , and Associate Applications wizards. Important •

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



Plant structure root directory - Specify the path to the storage location for the plant data and the drawing files. Folders for individual plant structures are automatically appended to this path as they are created. Important •

You must create the plant structure root directory and share it out before using these default settings during plant creation.

Backup root directory - Specify the path to the shared storage folder for backing up the plant files. Folders for individual plant structures are automatically appended to this path as they are created. Seed location - Specifies the folder where all the templates are stored. The site administrator sets this path during installation. Related Topics Default Settings Command , page 93 Use Default Settings Command , page 99 •

•

Plant Tab (Default Settings Dialog Box) Displays the plant settings you can predefine for populating the New Plant Structure wizard.



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

Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. For more information about using data dictionary templates, see Working with Data Dictionaries: An Overview, page 89.

Hierarchy - Select the default hierarchy that you want to use for new plants. All currently defined hierarchies display in this list. Important •

If you want to use a custom hierarchy, you must create it before using these default settings to create a plant structure. Hierarchies cannot be modified during plant structure creation.

Hierarchy definition - Displays the plant breakdown structure items in the currently selected hierarchy.



SmartPlant Electrical Tab (Default Settings Dialog Box) Displays the SmartPlant Electrical settings you can predefine for pop ulating the corresponding values in the Associate Applications wizard.

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

Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. For more information about using data dictionary templates, see Working with Data Dictionaries: An Overview, page 89.

SmartPlant Electrical reference data path - Type or browse to the SmartPlant Electrical reference data path. This path is limited to 255 characters and must be in UNC format.


Configuring SmartPlant Engineering Manager System of units - Select the system used for displaying units in SmartPlant Electrical. Related Topics Default Settings Command , page 93 Use Default Settings Command , page 99 •

•

Use Default Settings Command Tools > Use Default Settings

Allows you to toggle on and off using the predefined settings for populating the corresponding values in the New Site Server , New Plant Structure , and Associate Applications wizards. Related Topics Default Settings Command , page 93 Default Settings Dialog Box, page 93 Using Default Settings: An Overview, page 93 •

•

•

Creating Network Shares Before using SmartPlant Engineering Manager, you must create the following network shares. The paths to these shares are needed while running the various wizards in SmartPlant Engineering Manager. Site Server Share Create a share on the SmartPlant Engineering Manager (server) workstation to hold the site's SmartPlantV4.ini file. This share can be on the same computer as SmartPlant Engineering Manager or on a different machine. Because you can have several sites (different SmartPlantV4.ini files) on one computer, you must create separate shares for each site. All SmartPlant users must be granted read permissions on a site share (the site administrator group needs to be granted read and write permissions). You will need this share name to create the site later. Role Template Share Create a share on a server to hold the role templates you create for use with SmartPlant Engineering Manager. These templates are standard sets of rights and privileges that you can grant to user groups, without having to define the rights each time. This share can be on the same server as SmartPlant Engineering Manager or on a different server.



Only administrators responsible for the creation of sites, plants, user groups, and assigning user access require read and write permissions to this share. You must specify this location during site creation, or your role templates will not be available for selection. Backup Location Shares Create shares to hold the backup data for the site and for each plant structure. These shares can be on the same server as SmartPlant Engineering Manager or on a different server. We recommend using a separate server for backups. SmartPlant users who will be doing backups must be granted read and write permissions on these shares. You will need these share names to create the site and plants later. You must create backup shares for each plant structure you create.

Site Administrator User Group During site creation, you are asked to specify the user group that you want to have site administrator privileges. The group you specify will then possess a set of unique rights that cannot be granted to any other role. These rights include creating plant structures, creating and modifying hierarchies, creating and modifying plant group types, enabling and creating projects, and so forth. Site administrators can see all plant structures in the site and hav e full access to them. Site administrator privileges do not extend to the individual engineering products. The following tasks must be completed before a user group can be used as the site administrator group. 1. Create the user group using the administrative tools on your computer. 2. Verify that the users you added to the group created above are also members of the local Administrators group on the computer where SmartPlant Engineering Manager is loaded. 3. Grant network access privileges to the user group you just created using administrative tools on your computer. Notes •

•

•

For more information about how SmartPlant Engineering Manager applies user access and site administration privileges, see User Access, page 113. For information about Novell networking and user groups, see Novell Networking and User Groups, page 104. All users in Groups other than the Administrators group must have write access to the C:\Program Files\SmartPlant folder in order to use the software.



•

You can change the user group assigned as the site administrator group after site creation. For more information, see Change the Site Administrator User Group, page 105.

Create a User Group Before creating a site server, you must create, on the computer that will house the site smartplantv4.ini file, a local users group containing the u sers you want to have site administration privileges. For example, to create a group named SiteAdmins on a Windows 2000 machine, use the following steps. 1. From the Windows Control Panel, select Users and Passwords . 2. On the Advanced tab, click the Advanced button. 3. On the Local Users and Groups dialog box, select Groups in the Tree view, right-click and select the New Group command. 4. On the New Group dialog box, type the name and description for the new group.

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



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

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



3. Add the same users to this group that you added to the SiteAdmins group in the section above. Note •

All users in Groups other than the Administrators group must have write access to the C:\Program Files\SmartPlant folder in order to use the software.

Grant Network Access Privileges Complete the following steps to grant the Right to access this computer from the network local policy to the SiteAdmins group you just created. 1. Click Start > Programs > Administrative Tools > Local Security Policy . 2. On the Local Security Settings dialog box, select the User Rights Assignment local policy, and double-click the Access this computer from the network policy.

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



Novell Networking and User Groups Novell trees are the structures used for users and groups, much like domains on Windows systems. SmartPlant Engineering Manager uses the NovellLevels registry key and the path to the logged in user to determine how far down the tree to go before starting to look for user groups.

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



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

Change the Site Administrator User Group 1. Select the site node in the Tree view. 2. Right-click and select Properties . 3. On the General tab on the Site Properties dialog box, click the Browse button next to the Site administrator user group box. 4. On the New Site Administrator dialog box, define the following properties: •

•

•

•

Use local machine and domain groups - Select this option to choose an existing user group or domain that is accessible from your machine. Use site server and domain groups - Select this option to choose a user group or domain that is accessible from the site server machine.

, and select the user Role name - Click the Browse button group to which you want to assign site administrator privileges. Role description - (Optional) Type a descriptive note about the user group you selected, such as noting that this group is assigned site administrator privileges. If a description was defined when the group was created, it appears by default.

5. Click OK on the New Site Administrator Group dialog box. 6. Click OK on the Site Properties dialog box to complete the change.


Configuring SmartPlant Engineering Manager Notes •

•

You must have Site Administrator privileges to change the Site Administrator User Group. You (or the person who changes the Site Administrator User Group) retain Site Administrator privileges u ntil you either select a new site or you restart the software. However, if you are also a member of the user group now assigned Site Administrator privileges, you will retain your Site Administrator privileges. When the Site Properties dialog box is dismissed, the software checks to see if the Site Administrator User Group has changed and, if so, replaces the group in the T_Roles table and the users in the T_RoleUsers group. If any error occurs or the same group is selected, no changes occur.

Related Topics New Site Administrator Group Dialog Box, page 106 •

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

Use local machine and domain groups - Use this option when you want to choose an existing user group or domain that is accessible from your machine. Use site server and domain groups - Use this option when you want to choose a user group or domain that is accessible from the site server machine.


Configuring SmartPlant Engineering Manager Role name - Type the name of or select the Windows or Novell user group you want to assign to this new role. The name of the SmartPlant role will be the same as the name of the selected user group. To quickly find the user group in your domain, you can type a partial name into this field and click Check Name. Check Name - Displays the Microsoft Select dialog box, which allows you to select the Windows or Novell user group you want to assign to this new role. The name of the SmartPlant role will be the same as the name of the selected user group. Role description - Type a descriptive note about the role that you are creating. You can make notes that indicate the privileges assigned to the group. If a description was defined when the group was created, it appears by default. Related Topics Change the Site Administrator User Group, page 105 SmartPlant Engineering Manager Rights, page 114 •

•



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

•

You cannot create a new site unless you log on using a domain account that has administrator privileges on the computer where you are running SmartPlant Engineering Manager. Before you can create a site using an Oracle database, you must create a database instance in Oracle and the database must be started. In the Windows Control Panel , select Services to verify that the database is running.



•

The Site Server Options dialog box appears during future sessions only if SmartPlant Engineering Manager cannot find the site SmartPlantV4.ini file.

Related Topics New Data Dictionary Template Command , page 90 •

New Plant Structure Wizard The New Plant Structure wizard steps you through creating a plant structure. To start this wizard, select the Plant Structures root in the Tree view and then click File > New. You must provide the following information as you step through the wizard. Data Dictionary Source - Specifies whether the data dictionary for the new plant will be built from a default template or a custom template. You must specify the path to the location of the seed files. Data dictionary templates are not databasespecific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. For more information about using data dictionary templates, see Working with Data Dictionaries: An Overview, page 89. Hierarchy - Indicates the template for the plant breakdown structure of the plant. You can define your own hierarchy that you can then use in creating plant structures or you can use one of the several delivered hierarchies. Root Item Attributes - Specifies the plant structure root item and the name that will appear in the Plant Structures node in the software. Paths - Consists of UNC paths for the plant structure storage location and a backup storage location. Database Connection Information - Allows you to specify the alias and system password for the database instance that contains the plant data. Plant Schema and Data Dictionary Schema Information - Allows you to specify user names and passwords for both schemas. All data needed to maintain the plant structure is written into the plant schema. Notes •

•

You can use the Default Settings commands on the Tools menu to specify default values to simplify the plant creation process. For more information, see Using Default Settings: An Overview, page 93. After creating your new plant structure, be sure to associate applications with your plant and to assign user access for the new plant structure.



Ass s o c i ate A at e A p p l i c ati at i o n s Wizar Wi zardd Engineering applications (such as SmartPlant P&ID or SmartPlant Electrical) are used to access data within your plant structure. Before you can use an application with your data, you must associate that application with the plant structure. To associate an application with your plant structure, use the Tools > Associate Applications command to open the Associate Applications wizard that helps you step through creating the application schema and data dictionary. When associating an application, you must provide the following information as you step through the wizard. Data Dictionary Source - Specifies whether the data dictionary for the associated application will be built from a default template or a custom template. You must specify the path to the location of the seed files. Data dictionary templates are not database-specific. In other words, a given data dictionary template can be used in both Oracle and SQL Server environments. For more information about using data dictionary templates, see Working with Data Dictionaries: An Overview, page 89. 89. Application Schema and Application Data Dictionary Schema Information Allows you to specify user names and passwords for both schemas. All data needed to maintain the application association is written into the application schema. Notes •

•

When associating SmartPlant P&ID or SmartPlant Electrical, you can use the Default Settings commands on the Tools menu to specify default values to simplify the application association process. For more information, see Using Default Settings: An Overview, page 93. 93. In an integrated environment, if only one application is associated with the plant at the time it is registered, only that application is registered. If another application is later associated with the plant, the Register command is enabled so that you can register the new application with the plant. For more more information, see Register Command , page 140 140..



Creating Roles Create a New Role 1. Select the Roles node under the plant structure or project to which you want to add the new role. 2. Right-click and select New Role. 3. On the General tab, define the following properties: •

•

•

•

•

Use local machine and domain groups - Use this option when you want to choose an existing user group or domain that is accessible from your machine. Use site server and domain groups - Use this option when you want to choose a user group or domain that is accessible from the site server machine. Role name - Select the Browse button to display the Select a llows you to select the Windows or Groups dialog box, which allows Novell user group you want to assign to this new role. The name of the SmartPlant role will be the same as the name of the selected user group. Role description - Type a descriptive note about the role that you are creating. You can make notes that indicate the privileges assigned to the group. If a description was defined when the group was created, it appears by default. Template - Select a pre-defined role template. If you do not want to use a template, select None.

4. On the Rights tab, specify the access privileges for this group of users. This step is optional if you selected a template on the General tab. You can still modify individual access rights after applying a role template. Important •

•

If users experience access problems after you create c reate a role for the group to which the user is assigned, check with your Information Technology group to see if that user was created on a Windows NT domain that has been upgraded to Windows 2000 or Windows XP. Microsoft provides a method for adding users to the built-in PreWindows 2000 Compatible Access Group to handle this backwardcompatibility issue. For more information, see the Microsoft Knowledge Base article number 303973 at http://support.microsoft.com. The new role will not be created if you do not select any rights.



•

•

When setting the rights for the new role, be b e sure to not only set the rights for the applications, but also set the access permissions available under the SmartPlant Engineering Manager rights. You can automatically include the site administrators group in each plant you create by selecting the Add the site administrator group to each plant created option on the Site Properties > General tab. Doing this saves you the step of creating a new role to grant these users access to the new plant.

Related Topics SmartPlant Electrical User Access Rights, page 116 SmartPlant Engineering Manager Rights, page 114 •

•


User Access

User Access Overview User access identifies the users allowed to work at specified access levels within the site and related plant structures. With user access, administrators can control access to data and thereby ensure the security of their project data. SmartPlant Engineering Manager incorporates user access as an integral product feature by using roles to define and maintain user privileges and rights at the plant structure level, where each application has its own set of rights. Roles are the primary focus, with each role associated to a single Windows or Novell user group. Each role is then assigned specific rights for each engineering application and for SmartPlant Engineering Manager. Tips •

•

To see the roles currently defined for a plant, click the Roles node under the plant node in the Tree view. To view the rights settings for a particular role, right-click the role in the List view and click Properties .

Mutually-Exclusive Rights Users can have access privileges that vary from one plant to another in the same site. These rights are defined by categories. Categories with radio-button options indicate that the rights contained within are mutually exclusive, meaning you can choose only one right in that category to apply to the role. In other categories, you can choose multiple rights, as denoted by check boxes. •

•

•

•

None - The user is not allowed to execute the application or utility for this plant structure. Read-Only - The user can execute the application or utility for this plant structure to view the data held within it. Modify Settings - The user can execute the application or utility for this plant structure to view the data held within it and to modify any custom settings. Full Control - The user can execute the application or utility for this plant structure and perform all commands and modifications.


User Access

SmartPlant Engineering Manager provides roles templates to help you easily create new roles. Because the most labor-intensive part of a role creation is setting the values for the rights, you can create templates for specific roles and then use those templates multiple times. This feature is useful for defining a role template in one site and then reusing that same role template throughout all of your sites. Related Topics Create a New Role, page 111 SmartPlant Electrical User Access Rights, page 116 SmartPlant Engineering Manager Rights, page 114 •

•

•

SmartPlant Engineering Manager Rights SmartPlant Engineering Manager contains two sets of rights: site administrator rights and plant structure rights. Site Administrator Rights Site administrators, while not appearing in the Roles node in a plant structure, have a set of unique rights that cannot be granted to any other role. This group of users has privileges to create and modify plant structures, roles, hierarchies, and plant group types, to enable projects, and so forth. Only members of the user group specified as the Site Administrator User Group during site creation can see the Hierarchy Templates and Plant Group Types roots in the Tree view. Site administrators can see all plant structures and have full access to them. Important •

•

•

•

Site administrator privileges do not extend by default to full privileges in the engineering applications. Additional site administrators can be added to the Site Administrator User Group by using the administrative tools provided by Windows or Novell. Be sure that these users are granted network access rights to the computer where SmartPlant Engineering Manager is installed. You can change the user group assigned as the site administrator group after site creation. For more information, see Change the Site Administrator User Group, page 105. You can automatically include the site administrators group in each plant you create by selecting the Add the site administrator group to each plant created option on the Site Properties > General tab. Doing this saves you the step of creating a new role to grant these users access to the new plant.


User Access

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

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

Right

Plant Structure Access

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

Formats

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


User Access

SmartPlant Electrical User Access Rights Category

Right

Catalog

None

Plant Filters

None

Plant Reports

None

Rules

None

Notes

Controls the use of Catalog Manager. None prevents users from accessing Catalog Manager. Read-Only Read-Only allows users to view symbols in Catalog Manager, but not make changes. Full Full Control Control allows users to create new symbols and edit existing symbols. Controls the use of Filter Manager. None prevents users from accessing Filter Manager. Read-Only Read-Only allows users to view existing filter definitions, but not make changes. Full Control Full Control allows users to create new filters and edit existing filters. Controls access to plant reports definitions. None prevents users from accessing the plant reports. Read-Only Read-Only allows users to view existing report definitions, but not make changes. Full Control Full Control allows users to create new plant reports and edit existing reports.

Read-Only Full Control Data Dictionary

None

Options

None

Controls access to SmartPlant Electrical Rule Manager. None prevents users from accessing Rule Manager. Read-Only allows users to view existing rule definitions, but not make changes. Full Control allows users to create new rules and edit existing rule definitions.

Controls access to Data Dictionary Manager. None prevents users from accessing Data Read-Only Dictionary Manager. Read-Only allows users to view settings in the data dictionary, but not make Modify any changes. Modify Select Entry allows users to Select Entry edit select lists. Full Control allows users to add items and edit existing items in the data Full Control dictionary.

Read-Only Modify Settings Full Control

Controls access to SmartPlant Electrical Options Manager. None prevents users from accessing Options Manager. Read-Only allows users to view option settings, but not make any changes. Modify Settings allows users to change reference data pointers. Full Control allows users to add options and edit existing options.


User Access

Category

Right

Notes

Electrical Items Data

None

Controls the ability to create and manage the items that appear in the Electrical Index.

Read-Only Modify Settings Full Control Power Distribution Boards and Internals (Index)

None Read-Only

Controls the ability to generate and open PDBs and to disconnect electrical equipment items in the Electrical Index.

Modify Settings Full Control

Wiring Equipment

Controls the ability to work with cables and panels in the Electrical Index.

None Read-Only Modify Settings Full Control

Cable Sizing

Controls the ability to perform cable sizing.

None Read-Only Full Control

Cable Replace

Controls the ability to replace multiple cables in batch mode.

None Full Control

Single Line None Diagram Drawings (Index) Read-Only

Controls the ability to generate and manage power distribution board-based SLD drawings generated from the Electrical Index.

Modify Settings Full Control


User Access

Category

Right

Notes

Single Line Diagram Generation

None

Controls the ability to generate and manage SLD drawings generated from the Electrical Engineer.


Redlining

Read-Only Full Control

Schematic None Drawings (Index) Read-Only

Enables and disables redlining options in SLD drawings and schematics. Controls the ability to open and manage the items that appear in the Drawings folder of the Electrical Index.

Modify Settings Full Control Schematic Drawing Generation

None

Controls the ability to generate and open schematic drawings.


Apply Options

Profile Circuit

Enables or disables the available Apply Options features. Select the check box to enable an option; clear to disable.

Control Station Lookup Schematic I/O Set Association

Among Items

Enables or disables the Association features. Select the check box to enable an option; clear to disable.

External Documents


User Access

Category

Right

Notes

Reference Documents

None

Controls the management of external documents from within SmartPlant Electrical.

Read-Only Modify Settings Full Control Templates


Reference Data None Explorer - Cables Read-Only

Controls the ability to create and open SmartPlant Electrical templates. None prevents users from viewing the templates. Read-Only allows users to view template definitions, but not make any changes. Modify Settings allows users to edit existing templates. Full Control allows users to create new and edit existing templates. Controls the creation and management of RDE cables.

Modify Settings Full Control Reference Data Explorer Lookup Tables

Controls the creation and management of RDE lookup tables.


Reference Data Explorer - Other Categories

None Read-Only

Controls the creation and management of RDE items that belong to the categories other than lookup tables and cables.

Modify Settings Full Control Tabular Editor Layouts

None Full Control

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


User Access

Category

Right

Electrical Engineer

None

Import Manager

None

SmartPlant

Publish

Controls access to Electrical Engineer. For example, Full Control access is required to copy Full Control items from Electrical Engineer from another plant. Controls access to Import Manager. None prevents users from opening Import Manager. Full Control Full Control allows users to open and work within Import Manager.

Retrieve Register Reports

Notes

None Full Control

Project Management (As-Built)

None

Project Management (Projects)

None

Enables or disables the ability to publish to or retrieve documents. Select the check box to enable an option; clear to disable. Enables or disables registering internal documents. None prevents users from registering internal documents. Full Control allows users to register internal documents. Enables or disables the Project Management table in As-Built.

Full Control Enables or disables the Project Management table in As-Built.

Full Control

SmartPlant Electrical Access Rights Examples The following examples are suggestions for granting rights to common groups of users. These examples are a great starting place for defining rights for users of SmartPlant Electrical. Project Administrators This group is defined as those who have full control over all aspects of the administrative tasks and reference data. These users should have the ability to create plant groups, add applications, and roles. These users should only be able to view and not modify detailed project engineering data. Category

Right


Full Control

Catalog

Full Control

Project Filters

Read-only

Project Reports

Read-only

Data Dictionary

Full Control


User Access

Category

Right

Options

Full Control


Read-only

Power Distribution Boards and Internals (Index)

Read-only

Wiring Equipment

Read-only

Cable Sizing

Read-only

Cable Replace

None

Single Line Diagram Drawings (Index)

Read-only


Read-only

Redlining

Read-only

Schematic Drawings (Index)

Read-only

Schematic Drawing Generation

Read-only

Apply Options

Disabled

Associations

Disabled

Reference Documents

Full Control

Templates

Full Control

Reference Data Explorer - Cables

Full Control

Reference Data Explorer - Lookup Tables

Full Control


Full Control

Tabular Editor Layouts

Full Control

Electrical Engineer

Full Control

Import Manager

Full Control

SmartPlant

None

Register Reports

Full Control


Full Control


Full Control

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


User Access

Category

Right


None

Catalog

Read-only

Project Filters

Full Control

Project Reports

Full Control

Data Dictionary

Read-only

Options

Read-only


Full Control


Full Control

Wiring Equipment

Full Control

Cable Sizing

Full Control

Cable Replace

Full Control


Full Control


Full Control

Redlining

Full Control


Full Control


Full Control

Apply Options

Enabled

Associations

Enabled

Reference Documents

Modify Properties

Templates

Read-only


Modify Properties


Modify Properties


Modify Properties


Full Control

Electrical Engineer

Full Control

Import Manager

None

SmartPlant

None

Register Reports

Full Control


Full Control


Full Control

Project Designers This group is defined as those users who are responsible for the actual detailed engineering design, cable termination, cable routing, and generation of drawings.


User Access

As a rule, project designers should have read-only access rights to the project documentation and item properties. Project designers can set up personal filters, tabular views, and create My Reports. However, they should not be able to modify project defaults. Category

Right


None

Catalog

None

Project Filters

Read-only

Project Reports

Read-only

Data Dictionary

Read-only

Options

Read-only


Read-only


Read-only

Wiring Equipment

Modify Properties

Cable Sizing

None

Cable Replace

Read-only


Read-only


Read-only

Redlining

Read-only


Full Control


Full Control

Apply Options

Disabled

Associations

Disabled

Reference Documents

Read-only

Templates

Read-only


Read-only


Read-only


Read-only


Full Control

Electrical Engineer

Full Control

Import Manager

None

SmartPlant

Full Control

Register Reports

None


Full Control


Full Control


User Access

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

•

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

The following plant group access rights are available: No Access

Restricted Access

Unrestricted Access

Electrical Index

Users cannot view or Allows users to view access any items in the items, but not edit or associate items in the selected plant groups. selected plant groups.

Grants users full control of the items in the selected plant groups.

Electrical Engineer

Users can view items (but not properties) in the selected plant groups but cannot change associations among the items.


Tabular Editor

Users cannot view or Users cannot edit the access any items in the items in the selected selected plant groups. plant groups.

Users can view items (including properties) in the selected plant groups but cannot change associations among the items.


Notes •

•

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


User Access

Access Rig hts Command Tools > Access Rights

Provides SmartPlant Electrical users the ability to view role-level acce ss by plant group or plant-level access by role. You can set access rights to one of three states: No Access - Allows the role no access, not even read-only access, to the plant group, no matter what user rights are assigned to the role. Restricted Access - Reduces the user rights for the role to read-only in the selected plant group. For example, if the role has been assigned full-control in all user access rights, selecting this option limits the role to read-only access in the plant group . Unrestricted Access - Does not limit the user rights for the role in the plant group. Related Topics Access Rights Dialog Box, page 125 SmartPlant Electrical User Access Rights, page 116 View Access Rights by Plant Group, page 127 View Access Rights by Role, page 128 •

•

•

•

Access Rights Dial og Box Displays role-level access rights by plant group or plant-level access rights by role. When you select a plant group in the Tree view and then click Tools > Access Rights , the Access Rights dialog box displays the role access assigned to that plant group.


User Access

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

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


User Access

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

View View Access Acc ess Rights by Plant Group 1. Select the plant group in the Tree view. 2. Right-click and select Access Rights . 3. Modify the access rights as desired.


Customizing Your Reference Data

View View Acc ess Rights by Role 1. Select the Roles node in the Tree view. 2. Select a role in the List view. 3. Right-click and select Access Rights . 4. Modify the access rights as desired.

Custom Cust omizin izingg You Yourr Referenc Referencee Data Data Several tools are delivered during installation that allow you to customize your reference data.

Customizing Reference Data Options Reference data options control the look and feel of the product and controls much of the data used throughout the life of a project. Use SmartPlant Electrical Options Manager to define data dictionary templates and symbols for SLD drawings. 1. Click Start > Programs > SmartPlant Electrical > Options Manager . 2. Make the definitions that you require. 3. Click Settings . 4. Verify that all \\ node\ share share entries are set to the shares defined during reference data installation. 5. Click File > Save. For more information about working with reference data da ta options, click Help > Printable Guides in SmartPlant Electrical and select the Options Manager User's Guide.

Working orki ng with wit h Filters Filters SmartPlant Filter Manager, delivered with SmartPlant Engineering Manager, allows you to select the items to display in the engineering application. You can use this feature to clear the view of other items to display one class of items.



For more information about working with filters, click Help > Printable Guides in SmartPlant Engineering Manager and select the SmartPlant Filter Manager User's Guide .

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

Working orki ng with wi th Symbols and Labels Labels Symbols include a graphic representation of the item as well as the properties associated with that item. SmartPlant Catalog Manager, delivered with SmartPlant Engineering Manager, allows you to create and edit these symbols. Some of the characteristics of a SmartPlant symbol include the graphic representation of the item, labels, the icon that represents the item, and the properties associated with the item. Notes •

•

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

Modifying Modify ing Data Model Propertie Properti es SmartPlant Data Dictionary Manager, delivered with SmartPlant Engineering Manager, allows you to modify the data model properties, including the database entries, select lists, and item types that form the underlying data structure. With Data Dictionary Manager, you can perform the following tasks:



•

Add and change properties for specific database tables

•

Create select lists and add entries to them

•

Associate validation programs with various item types

Because your changes can affect the database for the entire project, only system administrators and project managers typically customize the database with Data Dictionary Manager. For more information about using Data Dictionary Manager, click Help > Printable Guides in SmartPlant Engineering Manager and select the SmartPlant Data Dictionary Manager User's Guide .

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

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

SmartPlant Electrical Delivered Templates SmartPlant Electrical delivers the following border templates.



Metric Templates Template File

Border File

Page Size

A4 Tall.spe

A4 Tall.sym

A4 Tall (210mm x 297mm)

A4 Wide.spe

A4 Wide.spe

A4 Wide (297mm x 210mm)

A3 Tall.spe

A3 Tall.spe

A3 Tall (297mm x 420mm)

A3 Wide.spe

A3 Wide.spe


A0_Template.spe

A0_Template.spe


Template File

Border File

Page Size

A Tall.spe

A Tall.spe

A Tall (8.5in x 11in)

A Wide.spe

A Wide.spe

A Wide (11in x 8.5in)

C Tall.spe

C Tall.spe

C Tall (17in x 22in)

C Wide.spe

C Wide.spe

C Wide (22in x 17in)

English Templates

Edit Delivered Templates Before editing the delivered templates, verify that the correct plant structure has been selected and that no drawings are open. 1. In Windows Explorer, browse to the default templates location defined in Options Manager or the location of the reference data of your plant. 2. Select the template that matches the system of units and page size requirements for the drawing and double-click the template file to open it. Refer to the previous chart to determine the appropriate template and border files. Tip

You also can drag the template file into the application window to open the template file. 3. Select the existing border file, and press Delete . •

4. Click Edit > Insert > Object . 5. Clear the Link check box to be sure the item will be embedded. 6. Click Browse. 7. Click the border file to use. You can use the delivered border or choose another border. 8. Click Open. 9. Click OK on the Insert Object dialog box.



10. Position the border file in the template. 11. Click File > Exit.

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


Working with SmartPlant Integration

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



SmartPlant Electrical interacts with SmartPlant Foundation by correlating items between the plant database and the SmartPlant Foundation database, retrieving documents such as Electrical Power Elements, Electrical Signal List, Cable Schedule reports, and P&IDs, from SmartPlant Foundation. Also, SmartPlant Electrical creates a set of tasks in the To Do List that you can run to update the plant database. In SmartPlant Electrical, you can also use the commands on the SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation Web Client in order to browse in SmartPlant Foundation, and subscribe to change notifications and compare documents. You can only use the SmartPlant menu commands after your plant is registered. For more information, see SmartPlant Engineering Manager Help and Related Topics. Registering Tools Before you can publish and retrieve documents from any of the other authoring tools, such as SmartPlant P&ID or SmartPlant Instrumentation, you must register each plant in SmartPlant Electrical with a SmartPlant Foundation database. The connection allows SmartPlant Electrical to use the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator typically registers a plant. The software maps a plant and all its projects to a single SmartPlant Foundation URL, which points to one, and only one, SmartPlant Foundation plant database and its projects. When you use the Register command in any of the authoring tools, you are registering an authoring tool plant with a SmartPlant Foundation URL and plant that you specify. The system administrator must register each plant in the authoring tool once; this action takes place in SmartPlant Engineering Manager. After the plant is registered, you can publish and retrieve documents.

Preparing the Integrated Environment To enable SmartPlant Electrical to work in an integrated environment, you must do the following: 1. Install the Schema Component and the SmartPlant Client, delivered with SmartPlant Foundation, on each SmartPlant Electrical workstation. For more information about installing these components, see The SmartPlant Enterprise Installation and Setup Guide.


Working with SmartPlant Integration Note

Before you install the Schema Component and the SmartPlant Client, be sure to install the software prerequisites described in the SmartPlant Client Workstations section of the SmartPlant Enterprise Installation and Setup Guide. 2. Use a hierarchy that contains a minimum of three levels when you create your plant in SmartPlant Engineering Manager. •

Note

In addition to requiring a minimum of three-levels in hierarchies, SmartPlant configurations also require that the names of hierarchy items cannot be changed after they are created and that the hierarchy structure cannot be modified after you create the project. For more information, see the SmartPlant Enterprise Installation and Setup Guide or the Using Custom Hierarchies in SmartPlant topic in the SmartPlant Engineering Manager User's Guide. 3. Associate applications with and assign user access rights to your plant. •

Note

When SmartPlant P&ID and SmartPlant Electrical are both enabled for a plant, they are both enabled for all projects in that plant. If a project requires only one of these applications, create separate plants in the project, then enable SmartPlant P&ID for one plant and SmartPlant Electrical for the other. 4. Register your SmartPlant plant with SmartPlant Foundation, as d escribed in the SmartPlant Engineering Manager Help. •

Notes •

•

When you register your plant, you must specify the location of the SmartPlant Engineering Manager schema map file (SPEMDataMap.xml). For more information, see the Specify Map File Dialog Box topic in the SmartPlant Engineering Manager User's Guide. If only one application is associated with the plant at the time it is registered, only that application is registered. If another application is later associated with the plant, the Register command is enabled so that you can register the new application with the plant.



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

Working with SmartPlant Instrumentation In order to have a successful data exchange between SmartPlant Electrical and SmartPlant Instrumentation, make sure that: •

•

•

•

Both SmartPlant Electrical and SmartPlant Instrumentation have the same plant hierarchy structure In SmartPlant Instrumentation, instruments and I/O signals are defined on the lowest plant hierarchy level In SmartPlant Instrumentation, cabinets are defined on the highest plant hierarchy level In SmartPlant Electrical, you defined a registered report for both the I/O lists and for Instruments requiring power supply.

You must also ensure that the following SmartPlant Electrical select lists and SmartPlant Instrumentation supporting tables contain identical values: •

System I/0 type

•

Rated Voltage

•

Power Supply AC/DC Flag

•

Number of Phases

•

Operating Mode

•

Process Function

•

Frequency

Furthermore, in SmartPlant Electrical Options Manager, in the General Settings window, you need to make the following changes: •

For the SmartPlant Instrumentation Default Domain setting, specify the name of a SmartPlant Instrumentation domain which you want to set as a source domain for retrieving detailed wiring data to be included in schematics.



•

If you want to retrieve enhanced reports to be included in schematics, select Yes for the setting Include Enhanced Reports in Schematics .

In the two tools, the units of measure of certain properties might be defined using a different precision accuracy. For example, 1.2 kW (one-digit accuracy of precision) in SmartPlant Electrical corresponds to 1.23 kW (two-digit accuracy of precision) in SmartPlant Instrumentation. This may result in inconsistencies and could be interpreted as an update when retrieving data. These properties are: •

•

Rated Active Power Rated Reactive Power

•

Rated Apparent Power

•

Full Load Current

•

Operating Mode Coincidence Factors (X, Y, Z, ZZ)

•

Starting Current

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

•

SmartPlant Electrical ships a sample report named Reference Data Cables Interface to SmartPlant 3D, that you can use as a source to be transferred to SmartPlant 3D, so that SmartPlant 3D users can create their Catalog using the report data. If cables that originated in SmartPlant Electrical were subsequently deleted in SmartPlant 3D and then published back from SmartPlant 3D, SmartPlant Electrical does not generate Delete tasks for those cables.

Make sure that the following select lists in SmartPlant Electrical must match the content of the related select lists in SmartPlant 3D: •

•

Routing status Segregation level



SmartPlant Electrical also publishes to SmartPlant 3D the relations to the cable side 1 and side 2. If SmartPlant 3D does not contain the relations, SmartPlant 3D cannot perform cable routing. This means that: •

•

In SmartPlant Electrical, the cables must have their side 1 and side 2 associated before publishing. In SmartPlant 3D, users must make sure that each object referenced in the cable sides has a corresponding object in the SmartPlant 3D data model.

Working with SmartPlant P&ID SmartPlant Electrical can retrieve items of electrical equipment that were published from SmartPlant P&ID. Electrical equipment in SmartPlant P&ID constitutes electrical motors and heaters only. SmartPlant Electrical retrieves any items of process equipment that are associated with the electrical equipment: for example, if a motor is associated with a pump in SmartPlant P&ID, the pump is retrieved along with the motor in SmartPlant Electrical. Likewise, if the software retrieves a heater that is associated with a vessel, then that vessel is also retrieved. The software also supports retrieval of multiple electrical equipment associations to a single item of process equipment, for example, where several heaters are used to heat up one vessel. Note that SmartPlant Electrical does not retrieve items of process equipment that are not associated with electrical items. Important •

When SmartPlant P&ID and SmartPlant Electrical are both enabled for a plant, they are both enabled for all projects of that plant. If a project requires only one of these applications, create separate plants for each application, and then enable SmartPlant P&ID for one plant and SmartPlant Electrical for the other. Note

•

When retrieving an item of mechanical equipment associated with a motor from SmartPlant P&ID, the numerical value and units of measure of the Power Driver Rated property as set in SmartPlant P&ID must exactly match an existing value of the Motor Rated Power property in SmartPlant Electrical for the task to run successfully. In addition, if you run the SmartPlant Electrical command to copy the value of the process equipment Absorbed Power property to the motor Brake Power property, the software only validates values of the brake power that do not exceed the motor rated power, as determined by the standard SmartPlant Electrical rule.



Using Projects in an Integrated Environment When working in an integrated environment with a plant that has projects, you need to make the following changes in SmartPlant Electrical Options Manager, in the General Settings window: •

•

For the Allow Full Access to As-Built setting, select No. To use such a plant in an integrated environment, you must ensure that it is not possible to change As-Built data in As-Built itself. After you select No for this setting, the software can only update As-Built when you merge project data with As-Built. For the As-Built Claim Mode setting, select Exclusive . SmartPlant integration does not support having the same item claimed for different projects.

Mapping for SmartPlant Integration If you customize the plant database items or attributes in your SmartPlant Engineering Manager plant, you must define the mapping between these customized plant attributes and the properties in the SmartPlant schema. 1. Open the plant data dictionary by right-clicking the plant in the Tree view in SmartPlant Engineering Manager and selecting the Data Dictionary Manager command. 2. Add or modify the attributes in Data Dictionary Manager for each level in your hierarchy. For more information, see the Add a Property to Database Tables topic in the Data Dictionary Manager User's Guide. 3. Open the plant SPEMDataMap.xml schema map file in the Schema Editor and map the plant database items between the tool schema (SPEMDataMap.xml) and the SmartPlant schema. For more information, see the Schema Editor User's Guide. Important •

•

If you add an enumerated list attribute to the plant data dictionary, see the Hierarchical Enumerated Lists topic in the SmartPlant P&ID User's Guide for information about mapping these complex data types. SmartPlant Electrical users should refer to the SmartPlant Electrical User's Guide. The default SPEMdatamap.xml file contains the EF_SPAPlant attributes (CompanyName, SiteName, SiteLocation, DivisionName, DivisionLocation). To use these default attributes, use the EF_SPAPLANT.ddt when creating your plant in SmartPlant Engineering Manager.



•

The default SPEMdatamap.xml and the EF_SPAPLANT.ddt files are delivered to the C:\Program Files\SmartPlant\Engineering Manager\EFResources folder.

Using Custom Hierarchies SmartPlant integration supports custom hierarchies, as long as they co ntain a minimum of three levels. By default, the delivered SPEMdatamap.xml file is compatible with the standard SmartPlant Plant > Area > Unit hierarchy. Important

After registering, SmartPlant Engineering Manager cannot retrieve the PBS document if the plant and SmartPlant hierarchies are not compatible. To be compatible with the SmartPlant hierarchy, your plant hierarchy can contain less than or equal, but not more than the number of levels in the SmartPlant hierarchy. •

•

SmartPlant Engineering Manager retrieves from the SmartPlant hierarchy only the hierarchy levels it needs. For example, if your plant hierarchy contains 4 levels and the SmartPlant hierarchy contains 8 levels, only the top 4 levels of the SmartPlant hierarchy are retrieved. Hierarchy item names at the same level do not have to match. Hierarchies are mapped by depth (level), not by name.

Register Command SmartPlant > Register

Allows you to register a plant database, along with its associated applications, with an instance of SmartPlant Foundation. Each database must be registered before you can connect to SmartPlant Foundation to perform any specific tasks, such as publishing or retrieving files. You can register each plant database only once. Important •

You must install the Schema Component and the SmartPlant Client, delivered with SmartPlant Foundation, on your SmartPlant Engineering Manager workstation before you can register. For more information, see the Configure for an Integrated Environment topic in the SmartPlant P&ID Installation and Upgrade Guide or the SmartPlant Electrical Installation and Upgrade Guide.



During registration, the software maps the plant database, all of its projects, and all of its the associated applications to a single SmartPlant Foundation URL, which points to one SmartPlant Foundation plant database, and returns a unique signature for the tool/plant combination being registered. Important •

If only one application is associated with the plant at the time it is registered, only that application is registered. If another application is later associated with the plant, the Register command is enabled so that you can register the new application with the plant.

The Register command is disabled if: •

•

•

•

All associated applications are registered. No applications are associated with the plant. The plant structure does not contain at least three levels. For more information about mapping hierarchies between the plant and SmartPlant, see Using Custom Hierarchies, page 140. The plant already contains projects. (You can still add projects to the plant after registering it.)

After the plant is registered, the SmartPlant tab is added to the Plant Structure Properties dialog box. The SmartPlant tab displays the SmartPlant Foundation URL, the SmartPlant Foundation plant database, and the unique application identifiers returned by the registration process.


Index

Index access rights viewing by role, 129, 130 adding users user groups, 104 AL16UTF16, 14 AL32UTF8, 14 applications associating, 111 default settings, 99 upgrading, 78, 81 archiving, 76 As-Built requirements for integration, 139 associating applications, 111 backing up upgraded plants, 83 backup locations sharing, 101 bi-lingual projects, 14 border templates configuring, 134 creating, 135 delivered, 134 Catalog Manager, 13 changing site administrator group, 106 character set Oracle 10g database server, 37 Oracle 9i database server, 36 SQL Server 2000 database server, 49 SQL Server 2005 database server, 53 character sets, 14 commands Access Rights, 126 Data Dictionary Manager, 90 Default Settings, 94 New Data Dictionary Template, 91 Register, 143 Upgrade Site, 83 Use Default Settings, 100 comments on documentation, 7 completing upgrade tasks, 80 configuring border templates, 134 network shares, 101 Oracle networking, 25, 26 reference data, 63 site administrator, 102 SmartPlant Engineering Manager, 86 user groups, 102 consulting services, 7

creating border templates, 135 plant structures, 110 role, 112 site schemas, 109 sites, 109 user groups, 102 cultural conventions, 14 customer support, 7 customization,users, 76, 84 customizing border templates, 134 data model, 132 filters, 131 formats, 131 labels, 132 Options Manager, 131 reference data, 131 symbols, 132 data dictionaries templates, 90 Data Dictionary Manager command, 90 data model customizing, 132 database character sets, 14 configuration, 23, 25, 26, 48 configuring SQL Server, 47 default settings, 95 default user names, 88 networking components, 25, 26 Oracle ARCHIVELOG mode, 44 Oracle Cost Based Optimizer, 44 SQL Server, 47 tuning, 44 database maintenance SQL Server 2000, 51 SQL Server 2005, 56 database servers system requirements, 18 databases, 76 date format, 14 DBCC Utility options, 51, 56 decimal point, 14 default settings application, 99 database, 95 paths, 96 plant, 97 user names, 88


Index Default Settings command, 94 displaying logs, 81 documentation comments, 7 Filter Manager, 13 filters customizing, 131 Finish All Tasks command, 80 Finish Next Task command, 80 finishing all tasks, 80 next task, 80 Format Manager, 13 formats customizing, 131 granting user access, 114, 115 groups site administrator, 115 user access, 114, 115 hardware requirements, 17 workstation, 20 hardware requirements database servers, 18 heterogeneous environment, 14 hierarchies flexible, 142, 143 mapping, 142 registering, 142, 143 homogeneous environment, 14 installation silent mode, 64 installing database, 23 reference data, 62 SmartPlant, 59 SmartPlant Electrical, 61 SmartPlant Engineering Manager, 60 SmartPlant P&ID, 59 SQL Server, 47 integration preparing the environment, 137 requirements, 139 supported Oracle versions, 23 internationalization, 14 keyboard locale, 14 labels customizing, 132 licenses evaluation, 61 locale boundary, 14 logs, 81, 84 managers Catalog, 13 Data Dictionary, 13

Filter, 13 Format, 13 mapping flexible hierarchies, 142 network access privileges granting to user groups, 104 network shares backups, 101 plant structure, 101 role template, 101 site server, 101 New Data Dictionary Template command, 91, 92, 93 next task,finishing, 80 NLS_LANG, 14 Novell networking user groups, 105 Open Site command, 81 opening sites, 81 Options Manager customizing, 131 Oracle, 76 analyzer scripts, 83 ARCHIVELOG mode, 44 Cost Based Optimizer, 44 statistics, 83 tuning, 83 Oracle 10g character set, 37 client installation, 43 client prerequisites, 42 database server installation, 34 instance creation, 37 recommended memory for Oracle instance, 37 Oracle 9i character set, 36 client installation, 41 client prerequisites, 41 database server installation, 28 instance creation, 36 Oracle analyzer scripts, 84 Oracle installation client installation overview, 41 common tasks, 27 database server installation overview, 28 listener creation, 34 Oracle instance Oracle 10g, 37 Oracle 9i, 36 overview, 35 requirements, 35 Oracle security, 35 paths default settings, 96 permissions, 59 PipingPoint, 84


Index plant structures access rights, 125, 126, 127, 129 copying, 90, 91, 92, 93 creating, 110 default settings, 97 registering, 143 sharing, 101 plants upgrading, 77, 82 projects requirements for integration, 139 properties sites, 107 queries CHECKCATALOG, 51, 56 CHECKDB, 51, 56 recommendations database servers, 18 reference data configuring, 63 customizing, 131 installing, 62 Options Manager, 131 reference numbers, 76 regional settings, 14 registering databases, 143 flexible hierarchies, 142, 143 plants, 142, 143 with SmartPlant Foundation, 136 registry, 59 requirements database servers, 18 hardware, 17 software, 17 workstation, 20 rights examples, 122 site administrator, 115 user access, 114, 115, 125, 126, 127 role templates sharing, 101 roles access rights, 125, 126, 127, 130 new, 112 site administrator, 115 user access, 114, 115 Run to Selected Task command, 81 running to task, 81 schema changes, 76 users, 76 schemas application, 86 application data dictionary, 86 plant, 86

plant data dictionary, 86 site, 86 site data dictionary, 86 selecting sites for upgrade, 81 servers database, 18 settings default, 94 default user names, 88 Show Log, 81 silent mode installation, 64 site administrator changing, 106 site administrator user group new, 107 rights, 115 specifying, 115 site administrators configuring, 102 network access privileges, 104 Novell networking, 105 user group, 104 site schemas creating, 109 site servers sharing, 101 sites creating, 109 new administrator user group, 107 opening, 81 SmartPlant installation, 59 SmartPlant Electrical evaluation license, 61 installing, 61 overview, 10 program group, 10 removing, 61 repairing current installation, 61 SmartPlant Engineering Manager, 136 configuring, 86 installing, 60 SmartPlant Foundation, 136 SmartPlant integration Integration Resource Path, 61 preparing the environment, 137 supported Oracle versions, 23 SmartPlant P&ID installing, 59 software requirements, 17 workstation, 20 SQL, 76 SQL server logon information, 48 SQL Server


Spel Install Guide

Recommend Documents