SmartPlant Reference Data Plus Installation Guidespmat.hec.co.kr/marian_webentry/Pdfs/SPRD_Installation_Guide.pdf · SmartPlant Reference Data Plus . Installation Guide . ... I-Convert,

SmartPlant Reference Data Plus Installation Guide

Version 2011 SP1 (7.0.1)

June 2010 / September 2010

DMAR1-PE-200121B-Updated

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

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

Terms of Use Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.

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

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

SmartPlant Reference Data Plus Installation Guide 5

Contents Preface .......................................................................................................................................................... 7

Overview ....................................................................................................................................................... 9

Web Service Architecture ..................................................................................................................... 11

SmartPlant Reference Data Plus Hardware and Software Requirements ........................................... 15

Installing the SmartPlant Reference Data Plus Server .......................................................................... 17

Install Oracle Client ............................................................................................................................... 18 Check IIS Settings for Windows Server 2008 ....................................................................................... 25 Execute InstallShield Server Installation ............................................................................................... 30 Check Security Rights to Directory ....................................................................................................... 38 Copy Oracle TNS Names ..................................................................................................................... 38 Modify the Web Configuration ............................................................................................................... 39

Installing the SmartPlant Reference Data Plus Client - CD Setup ........................................................ 41

Execute InstallShield Client Installation ................................................................................................ 41

Installing the SmartPlant Reference Data Plus Client - Click Once Setup .......................................... 45

Updating SmartPlant Reference Data Plus ............................................................................................. 49

Overview ............................................................................................................................................... 49 Update the SmartPlant Reference Data Plus Server ............................................................................ 49 Update the SmartPlant Reference Data Plus Client ............................................................................. 49

Troubleshooting ........................................................................................................................................ 51

User Comments Form ............................................................................................................................... 55

Index ........................................................................................................................................................... 57

Contents

6 SmartPlant Reference Data Plus Installation Guide

Preface This document is an installation guide for SmartPlant® Reference Data Plus. You can find installation and configuration instructions in this document.

For SmartPlant Materials user's guides, how-to documents, and more, open SmartPlant Materials, and click Help > Printable Guides. 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.

Documentation Comments We welcome comments or suggestions about this documentation. You can send us an email at: [email protected].


Preface


Overview This document describes how to install SmartPlant Reference Data Plus. You must do two steps for the installation. 1. You must install IIS, .NET Framework 4.0, and Oracle tools on the server machine. You must

also install and prepare the SmartPlant Reference Data Plus Server components on the server machine.

2. You must install the client on each client machine for each user. The first step has to be done once. Step two has to be done for each user on each client machine. If the first step is done, then you have one virtual directory on the application server. This directory hosts the web service executable itself. We call this the Service directory. The second step is the client installation, which is done by a typical InstallShield procedure. After the installation, you have installed SmartPlant Reference Data Plus on the client.


Overview


Here is an example showing how daily work on the client is executed.

Overview


Web Service Architecture SmartPlant Reference Data Plus uses a "web-service-architecture".

Architecture Description The client is a rich client Windows forms application with a wide range of powerful GUI interfaces. The client communicates to the Web Service on the application server. The communication is handled through SOAP Request and responses. The web service handles the client request, does the work, communicates with the database server, and sends the responses to the clients. The client receives the responses from the web service and displays the results. The client doesn't communicate with the database directly.

Web Service The Web Service works as an Application server and handles the requests of the client. This can be simple Insert/Update and Delete commands, but can also be complex, long running business logic processes. The Web Service communicates with an Oracle database.

Database Tier The database contains objects to store SmartPlant Reference Data Plus, the user and system data itself, as well as the second part of the SmartPlant Reference Data Plus business logic.

Overview


Overview


Overview


SmartPlant Reference Data Plus Hardware and Software Requirements

Before beginning an installation of SmartPlant Reference Data Plus, verify that your computers meet the following hardware and software requirements.

The SmartPlant Reference Data Plus Server requires a Windows-based operating system. It

must be Microsoft Windows Server 2003 R2 (64-bit) or Microsoft Windows Server 2008 R2 (64-bit).

The SmartPlant Reference Data Plus client requires a Windows-based operating system. It

must be Microsoft Windows XP (32-bit) or higher.

System Requirements In order to avoid port conflicts with the SmartPlant Reference Data Plus server, no other web servers (Apache or others) should run on a SmartPlant Reference Data Plus server. The configuration is tightly related to the number of concurrent users working on the system. Refer to Microsoft documentation for detailed information. Pentium 4 double processor XEON, 3 GHz or higher 4 GB RAM on the application server 80 GB hard disk for SmartPlant Reference Data Plus and Oracle (approximate) DVD-ROM drive access, either locally or through a network connection

All domain verified user names and passwords must use ASCII7/English characters. Oracle does not support non-ASCII / English characters in domain user names or passwords and will not work. This limitation is an Oracle limitation, not Intergraph's.


SmartPlant Reference Data Plus Hardware and Software Requirements


Installing the SmartPlant Reference Data Plus Server

To set up the SmartPlant Reference Data Plus software, complete the steps explained in this section.

The installation of SmartPlant Reference Data Plus on a Windows system must be performed as a local administrator or member of the local admin group. For installation of the SmartPlant Reference Data Plus Server, several tasks are necessary. Be sure the IIS is installed. Install the files (and configure the system) with the InstallShield setup.

For an overview of the server installation tasks, please see the following diagram.




Install Oracle Client Use the following media for the installation:

Media Packs Oracle Database 11g Release 2 (11.2.0.1.0) Media Pack for Microsoft Windows x64 (64-bit)

(11.2.0.1.0) Part Number B58804-01 Open the client folder, and double-click setup.exe.



Select Administrator, and click Next.



Select English, and click Next.



Keep the defaults, and click Next.



On the Summary screen, click Finish.



Installation starts and takes a while.



Click Close to end the installation.



Check IIS Settings for Windows Server 2008 Open the Server Manager. On the left side, click Roles. Then, on the right side, click Add Roles.

The Add Roles wizard appears. On the Select Server Roles screen, click Server Roles (on the left side). Select Web Server (IIS). Click Next.



You may see some confirmation messages in the wizard process. Click OK to proceed.

On the Select Role Services screen, select .NET Extensibility.

If this check box is already selected, you can cancel the wizard.



Click Next.



On the Confirm Installation Selections, click Install.

The installation runs. When the installation finishes, a results screen appears.



Click Close.



Execute InstallShield Server Installation Start the setup media (either the original installation media, or a shared location on the network), and click SmartPlant Reference Data Plus Installation.



On the next screen, click SmartPlant Reference Data Plus Server Installation.

Start the installation. The InstallShield Wizard appears and prepares for installation.



Microsoft .NET Framework will install.

Depending on the Framework installation status, a reboot may be required.

Start the server installation a second time.



Click Next.

Type a valid user name and organization.



Click Next.



Click Change to choose the C:\Program Files\SmartPlant\SmartPlant ReferenceData Plus 2011 location. Click Next.



Click Install to begin the installation.

The installation starts. It takes a while to make all the changes on your system. If everything is fine, you see the following screen.



Click Finish to finish the installation.



Check Security Rights to Directory Use Windows Explorer, and select the "C:\Program Files\Intergraph\SmartPlant Reference Data Plus 2011" directory. Right-click to select Properties. Select the Security tab, and make sure Full Control is set for the IIS_WPG user.

Copy Oracle TNS Names Copy the tnsmames.ora and sqlnet.ora from: %SPMAT_DB_InstallFolder%\samples\oradata\SPMAT\scripts\useful\specials\



to:

Or, use any other valid tnsnames.ora and sqlnet.ora for communication to the Oracle database.

Modify the Web Configuration The web.config file contains some application settings that administrators can set. This file is located in the server installation directory (C:\Program Files\SmartPlant\SmartPlantReferenceDataService). Here is some sample code from the web.config file: <appSettings> <add key="SecurityToken" value="ABC123"/> <add key="DatabaseDefault" value="md"/> <add key="ForceUseOfDatabaseDefault" value="N"/> <add key="CultureInfoIdentifier" value="en-US"/> </appSettings>

Database Default You must modify the DatabaseDefault key to use the tnsname of your database. Look for this line: <add key="DatabaseDefault" value="spmat7"/> If necessary, change "spmat7" to your tns alias name. <add key="DatabaseDefault" value="tnsaliasname"/>



The tnsname value affects the connection of the clients and is specified in both the web.config file and in the client software on the Logon Parameters dialog box (see graphic below). For more information, see the SmartPlant Reference Data Plus User's Guide.

Force Database Default In order to make sure your users are working in the proper database, you can set the ForceDatabaseDefault key. Look for this line: <add key="ForceUseOfDatabaseDefault" value="N"/> If you set this key to Y, the software ignores the logon parameters on each client, using the database default instead. If you set this key to N, the software uses the logon parameters on the client.

Installing the SmartPlant Reference Data Plus Client - CD Setup

Execute InstallShield Client Installation Start the setup media (either the original installation media, or a shared location on the network), and click SmartPlant Reference Data Plus Installation.




On the next screen, click SmartPlant Reference Data Plus Client Installation.



Follow the instructions to install the client. Each user on each client machine must do this installation task.

Click Install to start the installation. After installation, the software starts. Cancel the Logon screen, and go to Connection > Logon Parameters and set the correct parameters.

After installation, the software is located on the Start menu.



Installing the SmartPlant Reference Data Plus Client - Click Once Setup

As part of a release (a hot fix or a major release), the following files are delivered:

This set of files must be copied to a web folder whose path will be provided at the time of installation.

The next time updates are released, the files must be overwritten in the same location on the local server. On each and every client system, you must open the Deploy.html page. For example: http://dor-mds-netas02/currentclient/deploy.html




Click Install. Follow the instructions to install the client. Each user on each client machine must do this installation task.

After installation, the software starts. Cancel the Logon screen, and go to Connection > Logon Parameters to set the correct parameters.

After installation, the software is located on the Start menu and also on the Desktop.

When the client is launched, the software first checks to see if there are any updates from the same location where the setup files are present (on the local web server).



If it finds any, it prompts you to update the client.



Updating SmartPlant Reference Data Plus

This section describes how to update the software for a service pack.

Overview Periodically, the SmartPlant Materials Product Center releases service packs that update crucial new areas of development and any customer-requested service or trouble requests. It is important for each customer to stay current by evaluating and installing each new service pack and major release. This section describes the process for installing a new SmartPlant Reference Data Plus service pack with minimal customization. The audience includes SmartPlant Materials administrators and Oracle developers or database administrators (DBAs). Assumptions are as follows: The administrators and developers have access to the appropriate sample database(s)

through the software required. The actual service pack sample files are available. This section does not describe any customer-specific examples of any custom configuration.

All examples are for demonstration purposes only.

Update the SmartPlant Reference Data Plus Server To update the server, go to \SmartPlant Materials\SPMaterialsServicePack\ and run SmartPlantReferenceDataPlus2011_Net_7.0.x.x_Server_Update.exe, following the instructions. If it is installed, un-install the previous version using the Control Panel. The process removes the client from the computer.

Update the SmartPlant Reference Data Plus Client To install the new client, go to \SmartPlant Materials\SPMaterialsServicePack\ and run SmartPlantReferenceDataPlus2011_Net_7.0.x.x_Client_Update.exe, following the instructions.


Updating SmartPlant Reference Data Plus


Troubleshooting The following information can help when troubleshooting the server installation.

Connection to Web Server Check the server pages on the server machine: first, the HTML page, and then the Service page. These are the addresses if the standard installation has been done. http://localhost/SmartPlantReferenceDataService/TestHTMLAccess.htm

You should get some simple text. http://localhost/SmartPlantReferenceDataService/service.asmx

You should get a list of functions.

Database Connection If there is an error with database access, then it might help to reboot the server machine after the tnsnames.ora and sqlnet.ora files have been copied to the server directory.

Application Startup If there is an error at application startup and all logon parameter tests are successful, check the security access settings of the server installation directory. The web service writes log files to the directory, and the rights must be set correctly. See the Check Security Rights to Directory (on page 38) section in this document.


Troubleshooting


Sometimes the IIS_WPG user is not in the list. In this case, click Add.

Then, type IIS_WPG, and click OK.

Troubleshooting


Select the Full Control option, and click Apply and then OK.

Troubleshooting


User Comments Form Intergraph welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision. Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? What features did you like most about this document?

_____________________________________________________________________________ _____________________________________________________________________________ _____________________________________________________________________________ _____________________________________________________________________________ _____________________________________________________________________________ Send your comments to: [email protected]

or Intergraph (Deutschland) GmbH

SmartPlant Materials Service Center Martin-Schmeißer-Weg 18 D-44227 Dortmund Germany Phone ++49-231/72596-4211 Fax ++49-231/72596-4210

Thank you for your help!


User Comments Form


Index

C Check IIS Settings for Windows Server 2008 •

25 Check Security Rights to Directory • 38 Copy Oracle TNS Names • 38

E Execute InstallShield Client Installation • 41 Execute InstallShield Server Installation • 30

I Install Oracle Client • 18 Installing the SmartPlant Reference Data

Plus Client - CD Setup • 41 Installing the SmartPlant Reference Data

Plus Client - Click Once Setup • 45 Installing the SmartPlant Reference Data

Plus Server • 17

M Modify the Web Configuration • 39

O Overview • 9, 49

P Preface • 7

S SmartPlant Reference Data Plus Hardware

and Software Requirements • 15

T Troubleshooting • 51

U Update the SmartPlant Reference Data Plus

Client • 49 Update the SmartPlant Reference Data Plus

Server • 49 Updating SmartPlant Reference Data Plus •

49 User Comments Form • 55

W Web Service Architecture • 11


Documents

SmartPlant Reference Data Plus Installation Guidespmat.hec.co.kr/marian_webentry/Pdfs/SPRD_Installation_Guide.pdf · SmartPlant Reference Data Plus . Installation Guide . ... I-Convert,