PIPEPHASE Getting Started Guide[1]

PIPEPHASE 9.2Getting Started Guide

PIPEPHASE 9.2 Getting Started Guide The software described in this guide is furnished under a written agreement and may be used only in accordance with the terms and conditions of the license agreement under which you obtained it. The technical documentation is being delivered to you AS IS and Invensys Systems, Inc. makes no warranty as to its accuracy or use. Any use of the technical documentation or the information contained therein is at the risk of the user and their individual skill or ability. Invensys Systems, Inc. reserves the right to make documentation changes without prior notice or obligation to distribute.

Copyright Notice 2007 Invensys Systems, Inc. All rights reserved. No part of the material protected by this copyright may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying, recording, broadcasting, or by any information storage and retrieval system, without permission in writing from Invensys Systems, Inc.

Trademarks PIPEPHASE, NETOPT, and Invensys SIMSCI-ESSCOR are trade-marks of Invensys plc, its subsidiaries and affiliates.TACITE is a trademark of Institut Franais du Petrole (IFP).OLGAS 1.1, OLGAS TWO-PHASE, and OLGAS THREE-PHASE are trademarks of SCANDPOWER A/S.Windows 98, Windows ME, Windows NT, Windows 2000, Windows XP, Windows 2003, and MS-DOS are trademarks of Microsoft Corporation.Compaq Visual Fortran is a trademark of Compaq Computer Corporation.Adobe, Acrobat, Exchange and Reader are trademarks of Adobe Systems, Inc.All other products noted herein are owned by respective companies.

U.S. GOVERNMENT RESTRICTED RIGHTS LEGENDThe Software and accompanying written materials are provided with restricted rights. Use, duplication, or disclosure by the Gov-ernment is subject to restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data And Computer Software clause at DFARS 252.227-7013 or in subparagraphs (c) (1) and (2) of the Commercial Computer Software-Restricted Rights clause at 48 C.F.R. 52.227-19, as applicable. The Contractor/Manufacturer is: Invensys Systems, Inc. (Invensys SIMSCI-ESS-COR) 26561 Rancho Parkway South, Suite 100, Lake Forest, CA 92630, USA.

Printed in the United States of America, October 2007.

Contents

Introduction

About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vAbout PIPEPHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vAbout SIMSCI - ESSCOR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viWhere to find Additional Help . . . . . . . . . . . . . . . . . . . . . . . . . . . .vi

Online Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viOnline Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viOther Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii

Chapter 1Installation Requirements

Verifying the Package Contents . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1Media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1

Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3USB Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3FLEXlm7.2 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3FLEXlm9.5 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3TOKEN Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3Switching Security Types . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-4

Chapter 2Installing PIPEPHASE

PIPEPHASE Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1Installing a Standalone Version . . . . . . . . . . . . . . . . . . . . . . . . . . .2-2Directory Structures and Desktop Icons . . . . . . . . . . . . . . . . . . . .2-4

PIPEPHASE Installation Directory (Typical) . . . . . . . . . . . . .2-4Installing a Network Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-7

Option 1: Install all Files onto a Network File Server . . . . . .2-7PIPEPHASE 9.2 Getting Started Guide iii

Option 2: Install Executables on a Network File Server and then Install User Directories Locally . . . . . . . . . . . . . . . . . . . . . . . 2-7

Testing PIPEPHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Review the Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12

Uninstalling PIPEPHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13Accessing User-Added Subroutines (UAS). . . . . . . . . . . . . . . . . 2-14

Workspace for PIPEPHASE User-Added Routines . . . . . . . 2-14Build Sample One: Customize a Pressure Drop Model. . . . 2-15Build Sample Two: Customize a PRO/II Thermo routine . . 2-17

Chapter 3Installation Troubleshooting

Diagnosis of Issues with TOKEN and FLEXlm 7.2/9.5 Security .3-1Diagnosis of USB Security Problems . . . . . . . . . . . . . . . . . . . . . 3-11General License Security questions. . . . . . . . . . . . . . . . . . . . . . . 3-16

Chapter 4Getting Started

Starting PIPEPHASE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Exiting PIPEPHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Manipulating the PIPEPHASE Window . . . . . . . . . . . . . . . . . . . . 4-3

Changing Window Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Working with On-screen Color Coding Cues . . . . . . . . . . . . . . . . 4-3Using the Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Choosing a Menu Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5Using the Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Using the File Manipulation Buttons . . . . . . . . . . . . . . . . . . . 4-6Using the Structure and Unit Operation Buttons . . . . . . . . . . 4-6Using the Calculation Option, Optimization, and Property Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Using the Zoom and Redraw Buttons. . . . . . . . . . . . . . . . . . . 4-7

Using PIPEPHASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8Defining the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11Defining Fluid Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Defining Properties for Compositional Fluids . . . . . . . . . . . 4-14Defining Properties for Non-compositional Fluids . . . . . . . 4-20Defining Properties for Mixed Compositional/Non-Compositional Fluids . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23iv Contents

Generating and Using Tables of Properties. . . . . . . . . . . . . .4-24Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-24Structure of Network Systems. . . . . . . . . . . . . . . . . . . . . . . .4-25PIPEPHASE Flow Devices. . . . . . . . . . . . . . . . . . . . . . . . . .4-28Pressure Drop Calculations . . . . . . . . . . . . . . . . . . . . . . . . . .4-30Equipment Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-37Heat Transfer Calculations . . . . . . . . . . . . . . . . . . . . . . . . . .4-40Sphering or Pigging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-41Reservoirs and Inflow Performance Relationships . . . . . . . .4-41Production Planning and Time-stepping . . . . . . . . . . . . . . . .4-42Subsurface Networks and Multiple Completion Modeling .4-44Case Studies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-47Nodal Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-49

Starting the PIPEPHASE Results Access System (RAS) . . . . . .4-53Starting the PIPEPHASE Excel Report . . . . . . . . . . . . . . . . . . . .4-55

Chapter 5Tutorial

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1Problem Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1Building the Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3Entering Optimization Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-20Specifying Print Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-28Running the Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-29Viewing and Plotting Results. . . . . . . . . . . . . . . . . . . . . . . . . . . .5-30Using the RAS to Plot Results . . . . . . . . . . . . . . . . . . . . . . . . . . .5-31Generate and View Excel Report . . . . . . . . . . . . . . . . . . . . . . . . .5-33Including Operating Costs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-34

IndexPIPEPHASE 9.2 Getting Started Guide v

vi Contents

Introduction

About this ManualThe PIPEPHASE Getting Started Guide provides an introduction to PIPEPHASE. It describes how the interface modules work and includes a step-by-step tutorial to guide you through a PIPEPHASE example optimization problem. Also covered in this guide is PIPEPHASE Keywords. An outline of this guide is provided below.

This manual will guide you through the installation of PIPEPHASE. An outline of the manual is provided below.

About PIPEPHASEPIPEPHASE is a simulation program which predicts steady-state pressure, temperature, and liquid holdup profiles in wells, flow-

Introduction Introduces the manual, the program, and SIMSCI.

Chapter 2 Installation Requirements

Provides you with the installation and security requirements.

Chapter 3 Installing PIPEPHASE

Describes how to install PIPEPHASE.

Chapter 4 Installation Trou-bleshooting

Addresses some of the problems you may encounter while installing PIPEPHASE.

Chapter 5 Getting Started Explains how to use PIPEPHASE.

Chapter 6 Tutorial Provides a step-by-step tutorial for the optimiza-tion of an off-line pipeline design.PIPEPHASE 9.2 Getting Started Guide v

lines, gathering systems, and other linear or network configurations of pipes, wells, pumps, compressors, separators, and other facilities. The fluid types that PIPEPHASE can handle include liquid, gas, steam, and multiphase mixtures of gas and liquid.

Several special capabilities have also been designed into PIPEPHASE including well analysis with inflow performance; gas

lift analysis; pipeline sphering; and sensitivity (nodal) analysis. These additions extend the range of the PIPEPHASE application so that the full range of pipeline and piping network problems can be solved.

About SIMSCI - ESSCORSimSci-Esscor, a business unit of Invensys Systems, Inc., is a leader in the development and deployment of industrial process simulation software and systems for a variety of industries, including oil and gas production, petroleum refining, petrochemical and chemical manufacturing, electrical power generation, mining, pulp and paper, and engineering and construction. Supporting more than 750 client companies in over 70 countries, SimSci-Esscor solutions enable cli-ents to minimize capital requirements, optimize facility perfor-mance, and maximize return on investment.

For more information, visit SimSci-Esscor Web site at http://www.simsci-esscor.com.

Where to find Additional Help

Online DocumentationPIPEPHASE online documentation is provided in the form of .PDF files that are most conveniently viewed using Adobe Acrobat Reader 7.0.5 or Acrobat Exchange 5.0. You can install Adobe Acro-bat Reader 7.0.5 from the product CD, which requires 5 MB of disk space beyond that required for PIPEPHASE. Online manuals are stored in the Manuals directory and they remain on the CD when you install the program. To access these files, open the PIPEPHASE ONLINE HELP.CHM file in the Bin directory and click the appro-priate link to navigate to the corresponding PDF.

Online HelpPIPEPHASE comes with online Help, a comprehensive online ref-erence tool that accesses information quickly. In Help, commands, features, and data fields are explained in easy steps. Answers are available instantly, online, while you work. You can access the elec-tronic contents for Help by selecting Help/Contents from the menu bar. Context-sensitive help is accessed using the F1 key or the Whats This? button by placing the cursor in the area in question. A Road Map to Online Help will be displayed where you can select the help document you wish to view. From the desired online help vi Introduction

document you can do a search for the desired topic. If you chose a .CHM file, you can search by selecting Help/Search from the menu bar. If you chose a .PDF formatted document, you can use all the davailable Acrobat Reader search features to find the topic of inter-est. Please refer to Acrobat Reader on-line help for information concerning Acrobat Reader features.

Other DocumentationThe table below outlines the other existing PIPEPHASE documen-tation available in a hardcopy form.

Where to Find Additional HelpIf you want to... See...

Quickly learn how to simulate a simple flowsheet using PIPEPHASE

This document

Obtain detailed information on the capabilities and use of PIPEPHASE

This document

Learn how to install PIPEPHASE This document

Obtain basic information on PIPEPHASE keywords

PIPEPHASE Keyword Manual

See simulation examples PIPEPHASE Application Briefs

To learn more on Well and Surface Models Well and Surface Examples

Obtain detailed information on using PIPEPHASE w/ NETOPT

NETOPT Users Guide

Obtain detailed information on using PIPEPHASE w/ TACITE

TACITE Users Guide

Obtain basic information on PIPEPHASE calculation methods

Online Help

Obtain detailed information of component and thermodynamic properties

SIMSCI Component and Thermodynamic Data Input ManualPIPEPHASE 9.2 Getting Started Guide vii

Technical SupportIf you have any questions regarding program use or the interpretation of program output, contact the nearest SimSci-Esscor Technical Support Center from the following address list, or contact your local SimSci-Esscor representative.

To expedite your request for assistance, please have the following information available when you call:

A description of the problem

The installation CD and printed documentation available

The type of computer you are using

The amount of free disk space available on the disk where PIPEPHASE is installed

The actions you were taking when the problem occurred

The error messages that appear on your screen and any other symptomsviii Introduction

Authorized SimSci- Esscor Technical Support CentersSupport Center Address Tel/Fax/Internet

USA and Canada Invensys Process Systems (SimSci-Esscor)10900 Equity DriveHouston, TX 77041

Tel: + 1 800 SIMSCI 1+ 1 713 329 1600

Fax: + 1 713 329 1905E-mail: [email protected]

USA East Coast Invensys Process Systems (SimSci-Esscor)Gateway Corporate Center, Suite 304, 223 Wilmington-West Chester Pike,Chaddsford, PA 19317

Tel: + 1 800 SIMSCI 1+ 1 610 364 1900

Fax: + 1 610 364 9600E-mail: [email protected]

USA West Coast Invensys Systems, Inc. (Invensys, SimSci-Esscor)26561 Rancho Parkway South, Suite 100,Lake Forest, CA 92630

Tel: + 1 800 SIMSCI 1E-mail: [email protected]

Mexico Invensys Systems Mexico S.AEjercito Nacional 1005, Col. Irrigacion Deleg.Miguel Hidalgo, Mexico city 11500

Tel: + 52 55 52 63 01 77Fax:+ 52 55 55 57 26 20E-mail:[email protected]

Argentina Invensys Systems Argentina Inc.Nunez 4334Buenos Aires (Argentina) C1430AND

Tel: + 54 11 6345 2100Fax: + 54 11 6345 2111E-mail:[email protected]

Italy Invensys Systems Italia S.p.AVia Carducci, 125Sesto San Giovanni (MI) 20099, Italia

Tel: + 39 02 262 97326Fax: + 39 02 262 97200E-mail:[email protected]

Venezuela Invensys Systems VenezuelaTorre Delta Piso 12, Av.Francisco de MirandaAltamira, Caracas 1060

Tel: + 58 212 267 5868 Fax: + 58 212 6270964E-mail:[email protected]

Brazil Invensys Systems Brasil Ltda.Av. Chibaras, 75 - MoemaSao Paulo, SP O 4076 - 000

Tel:+ 55 11 6844 0200Fax: + 55 11 6844 0341E-mail: [email protected]

Germany Invensys Systems GmbHWilly- Brandt- Platz, 6Mannheim, 68161

Tel: + (0800) 550 - 5510E-mail:[email protected]

Australia and New Zealand Invensys Performance SolutionsLevel 2-4, 810 Elizabeth StreetSydney 2017, Australia

Tel: + 61 2 8396 3626Fax:+ 61 2 8396 3604E-mail: [email protected]

Japan Invensys Systems JapanGotanda Chou Building2-3-5 Higashi Gotanda, Shinagawa-kuTokyo 141-0022, Japan

Tel: + 81 3 5793 4856Fax:+ 81 3 5793 4855E-mail: [email protected]

Middle East Invensys ME DubaiPO Box 61495Jebel Ali Free Zone, Dubai

Tel: + 971 4 88 11440Fax: + 971 4 88 11426E-mail: [email protected]

Asia - Pacific Invensys Software Systems (s) Pte. Ltd.15, Changi Business ParkCentral 1Singapore 486057

Tel: + 65 6829 8657Fax: + 65 6261 9492E-mail: [email protected]

United Kingdom Invensys Systems (UK) LimitedHigh Bank House, Exchange Street,Stockport, CheshireUnited Kingdom SK3 OET

Tel: + 44 161 429 6744Fax: + 44 161 480 9063E-mail: [email protected]

China Invensys Process Systems (China) Co., Ltd.809, Tower B, Eaglerun Plaza, No.26 Xiaoyun RoadChaoyang District, Beijing 100016

Tel: + 86 10 8458 5757 Fax: + 86 10 8458 4521E-mail: [email protected]

Colombia Invensys Systems LA ColombiaCalle 100 # 36-39 Int. 4-203, Bucaramanga, SDER

Tel: + 57 1 3136360E-mail: [email protected]

Korea Invensys Systems Korea551-3 Hyosung-dong, Gyeyang-guIncheon, 407-040

Tel: + 82-32-540-0665Fax: + 82-32-542-3778E-mail: [email protected] 9.2 Getting Started Guide ix

x Introduction

Chapter 1Installation Requirements

This chapter provides a list of the PIPEPHASE package contents, the installation requirements, and an outline of the hardware and software requirements for running PIPEPHASE.

Verifying the Package ContentsThis section describes the contents of your release package.

Media

PIPEPHASE is provided on a single CD. The TACITE Transient Module and the NETOPT Optimizer Module are also included on the PIPEPHASE product CD. SimSci-Esscor FLEXlm server appli-cation installation program is provided on a separate CD.

DocumentationA list of PIPEPHASE documents is provided below. If you need a manual that is not included in your installation package or add-on package, contact Technical Support to request it.

PIPEPHASE Getting Started Guide (This document)

PIPEPHASE Keyword Manual

Release NotesPIPEPHASE 9.2 Getting Started Guide 1-1

Other documentation as required:

NETOPT Users Guide

TACITE Users GuideA complete set of online documentation is provided for each product.

Software RequirementsThe minimum recommended software requirements for PIPEPHASE are listed below:

The minimum recommended software requirements for Sim4Me Portal are listed below:

Disk Space Requirements

OperatingSystem

Windows 2000, Windows 2003, Windows XP or, Windows Vista. Proper installation of PIPEPHASE under Windows 2000, Windows XP, Windows 2003 or Windows Vista, requires administrator rights.

Microsoft Office MS Office 2000, MS Office XP, Office 2003, Office 2007.

Compiler To build User-Added Subroutines applications, the following compiler is required:

Compaq Visual FORTRAN (version 6.1 through 6.6b)

Note: User-Added Subroutine Applications built under Windows 2000 will run under Windows 2000, Windows XP, Windows 2003 and Windows Vista.

OperatingSystem

Windows 2000, Windows 2003, or Windows XP. Proper installation of PIPEPHASE under Windows 2000, Windows XP and Windows Vista requires administrator rights.

Microsoft Office MS Office 2003 Professional SP2.

Default Installation (no user-added subroutines) 80 MB

Full Installation (with user-added subroutines) 160 MB

Graphics Only Installation (no user-added subrou-tines)

20 MB1-2 Installation Requirements

Security

USB SecuritySimSci-Esscor provides USB hardware security, in which you insert key specially coded to allow use of PIPEPHASE. During installation, the USB key should not be plugged in. But after installation, simply plug the hardware directly into the computers USB port to start running PIPEPHASE. USB ports are not supported in Windows NT, therefore USB security is not available for this operating system.

FLEXlm7.2 SecuritySimSci-Esscor provides a FLEXlm security option on the FLEXlm Server Application installation CD. The FLEXlm License Manager is a third-party concurrent-user software licensing tool from Macrovision Corporation. It is a client/server-based tool that has been customized by SimSci-Esscor.

FLEXlm Server can run under Windows 2000/XP. The server must have at least 5 MB of available disk space. To install, learn, and troubleshoot FLEXlm security, follow the instructions provided in the FLEXlm Security Guide included in the standard release package.

FLEXlm9.5 SecuritySimSci-Esscor provides a FLEXlm security option on the FLEXlm Server Application installation CD. The FLEXlm License Manager is a third-party concurrent-user software licensing tool from Macrovision Corporation. It is a client/server-based tool that has been customized by SimSci-Esscor.

FLEXlm Server can run under Windows 2000/XP/Vista. The server must have at least 5 MB of available disk space. To install, learn, and troubleshoot FLEXlm security, follow the instructions provided in the FLEXlm Security Guide included in the standard release package.

TOKEN SecuritySimSci-Esscor provides a TOKEN security option on the FLEXlm Server 9.5 Application installation CD. The FLEXlm License Manager is a third-party concurrent-user software licensing tool PIPEPHASE 9.2 Getting Started Guide 1-3

from Macrovision Corporation. It is a client/server-based tool that has been customized by SimSci-Esscor.

For detailed information please refer to the SIM4ME Token Check Out Security Guide available in the Pphase92\Manuals\PIPEPHASE Getting Started Guide folder.

Switching Security Types

To switch to USB security:

Open the pipephase.ini file found in the user directory.

Find the section entitled [wss_Security] and set Type=USB.

Save the file and exit.

To switch to FLEXlm7.2 security:


Find the section entitled [wss_Security] and set Type=FLXLM72.


If you are running under Windows 2000/XP/2003, add the IPASSI_LICENSE_FILE=@{FLEXlm server machine name} system environment variable to your control panel/system/advanced/environment variables.

Reboot your computer so the changes to your security environment will be correctly configured.

To switch to FLEXlm9.5 security:


Find the section entitled [wss_Security] and set Type=FLXLM95.


If you are running under Windows 2000/XP/2003/Vista, add the IPASSI_LICENSE_FILE=@{FLEXlm server machine name} system environment variable to your control panel/system/advanced/environment variables.1-4 Installation Requirements

Reboot your computer so the changes to your security environment will be correctly configured.

To switch to TOKEN security:


Find the section entitled [wss_Security] and set Type=TOKEN.


If you are running under Windows 2000/XP/2003/Vista, add the IPASSI_LICENSE_FILE=@{FLEXlm server machine name} system environment variable to your control panel/system/advanced/environment variables.

Reboot your computer, so the changes to your security environment will be correctly configured.PIPEPHASE 9.2 Getting Started Guide 1-5

1-6 Installation Requirements

Chapter 2Installing PIPEPHASE

This chapter explains how to install PIPEPHASE as a standalone version or from a network/newuser version.

PIPEPHASE InstallationThere are three installation options for the PIPEPHASE software:

Typical - This option installs both the GUI and the calculation portions of PIPEPHASE directly to your PC.

Custom - This option allows you to customize your installation by selecting the User Added files with PIPEPHASE.

Network - This option allows you to customize your installation by selecting the components you wish to install to the network. Individual users can run a simple setup program Graphics Only installation from their PC to access the PIPEPHASE program installed PIPEPHASE 9.2 Getting Started Guide 2-1

PIPEPHASE can be installed as a standalone version on a local machine or as a multiple-user version to a network machine.

on the network.

Note: PC user-added subroutines require a custom installation.

When installing PIPEPHASE, you also have the option to install the TACITE Transient module and/or the NETOPT Optimizer module and/or SIM4ME Portal 1.1. If you do not license and would like to add-on one or all of these modules, please contact your SimSci-Esscor representative for details.

Installing a Standalone VersionThese instructions assume that you are installing from a CD-ROM in drive E into the structure C:\SIMSCI.

Start your Windows session.

Insert the PIPEPHASE installation CD into drive E.

Browse to the root of the installation CD and read the Release Notes.

Open the PIPEPHASE92 folder and double-click on SETUP.EXE to start the PIPEPHASE Installation program.

Installing SIMSCI Common Framework 2.1dialog boxes appear.

Then Application Type screen will allow users to select to install either PIPEPHASE or Acrobat Reader.

Select PIPEPHASE and the Welcome to the InstallShield Wizard for PIPEPHASEdialog box appears.

Click Next >.to continue. The License Agreement dialog box appears. Click Yes to continue.

Choose Typical, Custom, or Network Installation.

Enter the location where you wish to install the PIPEPHASE program, if different from the default directory (C:\SIMSCI).To install to a different folder, click Browse... and select another folder.

Note: If you are maintaining an older version of PIPEPHASE in the SIMSCI directory, place PIPEPHASE 9.2 in another directory (e.g., \PP2v92) to avoid any conflicts.2-2 Installing PIPEPHASE

For Typical Installation:

Select the modules dialog box which displays the add-on module(s) you wish to install.

Click Next > to continue.

The Security Option dialog box appears. Select one of the four security options:

If you chose FLEXlm7.2, FLEXlm9.5, or Token, specify the prospective IPASSI FLEXlm server(s) (e.g., @server1; @server2) to guide PIPEPHASE to find the FLEXlm server. Click Next > to continue.

Then select the program folder you wish to designate as the PIPEPHASE icon location (SIMSCI is the default).You may

Note: If you are licensed to run TACITE, select install TACITE Transient module; or if you are licensed to run NETOPT, select install NETOPT Optimizer module. If you are licensed to run SIM4ME Portal, select install SIM4ME Portal 1.1 module. All modules can be selected if you are licensed.

FLEXlm9.5 Allows PIPEPHASE to go beyond the current machine to obtain licenses from another machine (FLEXlm9.5 security server machine) on the network.


USB Utilizes a USB hardware key attached to the USB port on the back of the current machine for licensing purposes. Using this type, PIPEPHASE will only search this hardware key for license(s).

Token Allows PIPEPHASE to go beyond the current machine to obtain licenses from a Token server on the network.PIPEPHASE 9.2 Getting Started Guide 2-3

type a new folder name, or select one from the existing folders list. Click Next > to continue.

The Start Copying Files dialog box appears which summarizes your install settings. If you want to review or change any settings, click < Back. If you are satisfied with the settings, click Next > to begin copying files.

Once the installation starts, you will see a box logging the progress of your installation. You can use the Cancel button at any time during disk installation to pause or exit the installation program. When your installation is complete, the Complete PIPEPHASE Installation dialog box appears.

Click Finish to complete the Local Typical installation.

You should now test your PIPEPHASE installation. Proceed to the Testing PIPEPHASE section for more information.

Directory Structures and Desktop Icons

PIPEPHASE Installation Directory (Typical)The Typical Installation will set up all PIPEPHASE files under the directories shown below:

C:\SIMSCI\PPHASE92\BIN [Program executable files]C:\SIMSCI\PPHASE92\LIB [Component library directory]C:\SIMSCI\PPHASE92\SYSTEM [PIPEPHASE system files]C:\Program Files\PFE32 [Text editor]C:\SIMSCI\PPHASE92\USER [PIPEPHASE user directory]C:\SIMSCI\PPHASE92\MANUALS [PIPEPHASE Manuals] C:\SIMSCI\PPHASE92\RESOURCE [GUI bitmaps and icon files]C:\SIMSCI\SIM4MEPortal11 [SIM4ME Portal files]C:\Program Files\SIMSCI\ [SIMSCI CommonSIMSCICFI21 Framework Files]

A typical installation creates the following four icons:

PIPEPHASE 9.2

PIPEPHASE 9.2 Online Help

Note: Setup determines if it is necessary to restart the computer. If so, it asks whether you want to restart the system now or later. 2-4 Installing PIPEPHASE

Programmer's File Editor

SIM4ME Portal

For Custom Installation:

Choose the components you wish to install.

If you plan to link your own user-added subroutines into PIPEPHASE, select the User-Added Files option. Refer to the User-Added Subroutine section for relink procedures.

Select the add-on module(s) you wish to install.







Token Allows PIPEPHASE to go beyond the current machine to obtain licenses from a Token server on the network.PIPEPHASE 9.2 Getting Started Guide 2-5


Then select the program folder you wish to designate as the PIPEPHASE icon location (SIMSCI is the default). You may type a new folder name, or select one from the existing folders list. Click Next > to continue.

The Start Copying Files dialog box appears which summarizes your install settings. If you want to review or change any settings click < Back. If you are satisfied with the settings, click Next > to begin copying files.


Click Finish to complete the Local Custam installation.

When installation is done, you should see a SIMSCI group with a PIPEPHASE GUI icon and a desktop PIPEPHASE icon.

Restart Windows when prompted at the end of the installation procedure.

Continue the installation procedure by testing your PIPEPHASE installation.

Note: Setup determines if it is necessary to restart the computer. If so, it asks whether you want to restart the system now or later. 2-6 Installing PIPEPHASE

Installing a Network VersionA system administrator usually installs the network version. As the system administrator, you have two options:

Copy the entire CD-ROM contents onto the network.

Install executables onto a network machine and then install user directories locally.

Option 1: Install all Files onto a Network File ServerThis option is typically done in preparation for local installations. You simply copy all of the files and folders from the PIPEPHASE CD-ROM to the network server. This makes the install program accessible to users on the network who can then perform a local installation to their local hard drives.

Create a single PIPEPHASE directory on the appropriate network drive. Make sure the directory has enough disk space to accommodate the entire CD-ROM (140 MB) and is accessible to all potential users.

Use the DOS XCOPY command (with /V and /S switches) to copy the CD-ROM to the PIPEPHASE network directory.

Refer users to Installing a Standalone Version, earlier in this section.

Single-users perform the actual standalone installation from the Network File Server.

Option 2: Install Executables on a Network File Server and then Install User Directories LocallyThis option is a two-part installation:

1. An installation of executables and their related files on the network.

2. Installations of user directories on each users local disk drive using the PIPEPHASE New User install procedure.

Install Executable Files onto the Network File Server:

Begin the install process as previously stated on pages 2-1 and 2-2.PIPEPHASE 9.2 Getting Started Guide 2-7

Select the PIPEPHASE Network installation procedure. Select the modules dialog box which displays the add-on module(s) you wish to install.




Then select the program folder you wish to designate as the PIPEPHASE icon location (SIMSCI is the default).You may





Token Allows PIPEPHASE to go beyond the current machine to obtain licenses from a Token server on the network.2-8 Installing PIPEPHASE

type a new folder name, or select one from the existing folders list. Click Next > to continue.



Typical Directory Structure on a Network DriveF:\..\SIMSCI\PPHASE92\BIN [Program executable files]F:\..\SIMSCI\PPHASE92\LIB [Component library directory]F:\..\SIMSCI\PPHASE92\SYSTEM [PIPEPHASE system files]F:\..\Program Files\PFE32 [Text editor]F:\..\SIMSCI\PPHASE92\MANUALS [Online Documentation Files]F:\..\SIMSCI\PPHASE92\GUISETUP [GUI Setup files]F:\..\SIMSCI\PPHASE92\USERADD [User-added Subroutine files- optional]F:\..\SIMSCI\PPHASE92\RESOURCE [GUI Bitmaps and icon files]

where F:\..\ is the subdirectory on your network drive.

Install User Directories LocallyThe PIPEPHASE New User install program installs PIPEPHASE User directory and icons that are linked to the executable files on the network server. Each user must execute the PIPEPHASE GUISetup install program from their machines.

To install user directories locally:

Connect to the drive and directory to which you have installed the PIPEPHASE Network Version.

Locate the GUISetup directory and run SETUP.EXE in this directory.

Installing SIMSCI Common Framework 2.1dialog boxes appear.

Note: The User-Added Subroutine files will appear only if the user has selected them during the network installation.PIPEPHASE 9.2 Getting Started Guide 2-9

Then Application Type screen will allow you to install PIPEPHASE or Acrobat Reader.

Select PIPEPHASE and the Welcome to the InstallShield Wizard for PIPEPHASEdialog box appears.

Click Next > to continue. The License Agreement dialog box appears. Click Yes to continue.

The Choose Destination Location dialog box appears. This box shows the default destination directory (C:\SIMSCI) of the PIPEPHASE files. To install to this folder, click Next >. To install to a different folder, click Browse... and select another folder.

Select Features dialog box which displays the User Added Feature.The list box shows all possible components. Check the components you want to install and note the change in required disk space. Click Next >.

Select the modules dialog box which displays the add-on module(s) you wish to install. Check the components you want to install. Click Next >.




FLEXlm7.2 Allows PIPEPHASE to go beyond the current machine to obtain licenses from another machine (FLEXlm7.2 security server machine) on the network.2-10 Installing PIPEPHASE


Then select the program folder you wish to designate as the PIPEPHASE icon location (SIMSCI is the default).You may type a new folder name, or select one from the existing folders list. Click Next > to continue.



The system reboot occurs after the User directories are installed on each users local disk drive using the PIPEPHASE Workstation install program.

Setup installs the following directories on the local disk drive:

where X:\..\ is the selected installation drive and directory.

After you have installed user directories for a user, Setup returns you to the users Program Manager or the Desktop. When


Token Allows PIPEPHASE to go beyond the current machine to obtain licenses from a Token server on the network.

X:\..\PPHASE92\USER [PIPEPHASE users directory]X:\..\PPHASE92\USERADD [PIPEPHASE UserAdd directory-

optional]PIPEPHASE 9.2 Getting Started Guide 2-11

installation is done, you should see a SIMSCI group with a PIPEPHASE GUI icon and a desktop PIPEPHASE icon. A typical installation produces four icons:

PIPEPHASE 9.2

PIPEPHASE 9.2 Online Help

Programmer's File Editor

SIM4ME Portal

See the Testing PIPEPHASE section of this chapter to test your PIPEPHASE installation.

Testing PIPEPHASEAs a simple test of your PIPEPHASE system, open PIPEPHASE, import the input file EX1_LIQUID-PUMP.INP and run it. This will let you utilize PIPEPHASEs data reconciliation capability and give you a sense of how PIPEPHASE will run. Refer to the additional manuals shipped with PIPEPHASE for hands-on examples and information that will have you using the powerful capabilities of PIPEPHASE quickly.

Click Start and select Program Files/SIMSCI/PIPEPHASE 9.2/PIPEPHASE 9.2.

Select Import/Keyword File from the File menu.

Select EX1_LIQUID-PUMP.INP in the Import Keyword File dialog box and click Open. A window will appear showing the Save Imported File As... box.

Click on Save to replace the existing ppzip file.

Click the Run button on the toolbar to start running the simulation.

Review the ResultsWhen the simulation is complete, you will be able to view the output file. The results are shown in the Programmers File Editor window by selecting the View button in the run window.2-12 Installing PIPEPHASE

Uninstalling PIPEPHASEYou can uninstall PIPEPHASE by accessing Add/Remove Pro-grams in the Control Panel.

To uninstall PIPEPHASE:

Click Start. Select Settings and then select Control Panel.

Double-click Add/Remove Programs. The Add/Remove Programs Properties dialog box appears.

Select PIPEPHASE 9.2 (for Typical & Custom) and PIPEPHASE 9.2 Workstation for Graphics Only install (Network install).

Click Add/Remove.

Click Yes to confirm the deletion. A message may ask you whether to delete a shared file. If you know that the file is not used by another application, click Yes. Otherwise, click No.

Uninstall deletes the component and displays a screen verifying deletion.

Click OK again.

Note: The order of uninstalling components and/or creating files under the PIPEPHASE tree may cause certain single files to remain on the disk. After uninstalling a component, check the corresponding installation directory for remaining files and delete them manually.PIPEPHASE 9.2 Getting Started Guide 2-13

Accessing User-Added Subroutines (UAS)You can choose to install the directories for UAS during the standard installation procedures. See the instructions earlier in this chapter.

Building and Using PIPEPHASE UAS

User-Added Subroutines written in FORTRAN can be integrated into PIPEPHASE by creating a new D_MAINONE.DLL module. User- Added Subroutines for the PRO/II thermodynamics can be integrated into PIPEPHASE by creating a new FFPESMainDLL.DLL.

The User-Added Subroutines must be compiled and linked using Compaq Visual FORTRAN (or CVF) for Windows 98/ME or for Windows NT/2000/XP. Refer to the Hardware/Software Requirements section of "Chapter 1" for information concerning the version of CVF required for this release of PIPEPHASE.

The build procedures outlined in this chapter assumes that you are familiar with the currently supported versions of the Windows OS and CVF. If you already have CVF installed on your computer, you can find information on setting up your computer's environment in the batch file located at c:\program files\devstudio\df\bin\dfvars.

This manual does not contain instructions on writing the FORTRAN subroutines or using CVF. For information on using CVF, see the Compaq Visual FORTRAN Programmer's Guide.

Workspace for PIPEPHASE User-Added RoutinesThe workspace C:\SIMSCI\PPHASE92\USERADD\Makewsp\MAKEWSP.DSW contains several projects, listed below in the order most commonly used:

Note: These instructions assume that you have installed the PIPEPHASE UAS files in the default directory structure, C:\SIMSCI\PPHASE92\USERADD. Modify the paths indicated in the procedure below if you have installed the routine in a directory structure other than the default structure.2-14 Installing PIPEPHASE

** Refer to the PIPEPHASE documentation for information regarding PIPEPHASE User-Added capabilities.

Build Sample One: Customize a Pressure Drop Model In this sample build procedure, we will integrate the sample UAS routine HUSER1.FOR into D_MAINONE.DLL.

First you must open the development project:

Start CVF by selecting it from the Start menu.

Select the Open Workspace option from the menu.

Select project \SIMSCI\PPHASE92\USERADD\MAKEWSP\MAKESP.DSW

Set the active project to D_MAINONE by selecting Set Active Project from the Project menu.

Next you must add the file HUSER1.FOR into project:

Select the folder "CLIENT USER FILES" and use the right mouse button to select the "Add Files to Folder" option.

Add the file \SIMSCI\PPHASE92\USERADD\USERSRC\HUSER1.FOR. (If this file is already in the project, a message will be displayed.)

Click OK to close the window and update the project file.

Table 2-1: Work Space for PIPEPHASE User Added RoutinesProject Description Build Products

D_MAINONE Project used to update PIPEPHASE user-added routines (i.e. HUSER1.FOR)

D_MAINONE.DLL

MAINONE_CPP Main program entry point provided for debugging purposes

MAINONE.EXE

FFPESMAINDLL Project used to update PRO/II thermo user-added routines **(i.e. HUSER1.FOR)

FFPESMainDLL.DLL

MAINTI Main program for thermo preprocessor provided for debugging purposes

MAINTI.EXE

Note: Build products must be copied into the C:\SIMSCI\PPHASE92\BIN directory. You should save the original products into another directory in case you want to go back to the standard release version.PIPEPHASE 9.2 Getting Started Guide 2-15

Next you can update the code and build D_MAINONE.DLL:

Modify the user added routine. For example increase the frictional pressure drop by 10% (PGF = PGF*1.1).

Select the "Win 32 Release" version.

Select the Rebuild All option from the Build menu. This builds D_MAINONE.DLL in directory \SIMSCI\PPHASE92\USERADD\MAKEWSP. Copy this file to the \SIMSCI\PPHASE92\BIN directory.

Now you can verify the UAS in the build:

Run file \SIMSCI\PPHASE92\USERADD\USERINP\HUSER.INP and compare the results to file HUSER.CHK. View the Node Summary and verify that the pressure drop has changed as expected.

You may also use the MAINONE_CPP project for debugging.

Repeat the build procedures for D_MAINONE.DLL but select the "Win 32 Debug" option. D_MAINONE.DLL will still be built directory \SIMSCI\PPHASE92\USERADD\MAKEWSP. Copy this file to the \SIMSCI\PPHASE92\BIN directory.

Now set the active project to MAINONE_CPP by selecting Set Active Project from the Project menu.

Select the "Win 32 Debug" version.

Select the Rebuild All option from the Build menu. CVF will build the MAINONE.EXE in the directory \SIMSCI\PPHASE92\USERADD\MAKEWSP. Copy this file to the \SIMSCI\PPHASE92\BIN directory.

Set the debug options as follows:

Set a breakpoint in MAINONE_CPP at command to "Run Preprocessor" and run to this breakpoint.

Executable for \SIMSCI\PPHASE92\BIN\MAINONEWorking Dir \SIMSCI\PPHASE92\BINProgram Arg. /F=filename /

D=\SIMSCI\PPHASE92\USER\ / I=\SIMSCI\PPHASE92\USER\ PIPEPHASE.INI2-16 Installing PIPEPHASE

Now you can set breakpoints in the user added routines and debug as normal.

Build Sample Two: Customize a PRO/II Thermo routine In this sample build procedure, we will integrate the sample UAS routine UKHS1.FOR into FFPESMainDLL.DLL.

First you must open the development project:

Start CVF by selecting it from the Start menu.

Select the Open Workspace option from the menu.

Select file C:\SIMSCI\PPHASE92\USERADD\MAKEWSP\MAKEWSP.DSW and click OK.

Set the active project to FFPESMainDLL by selecting Set Active Project from the Project menu.

Next, you must add the file UKHS1.FOR into the project:

Select the folder "CLIENT USER FILES" and use the right mouse button to select the "Add Files to Folder" option.

Add the file \SIMSCI\PPHASE92\USERADD\USERSRC\UKHS1.FOR. (If this file is already in the project, a message will be displayed.)

Click OK to close the window and update the project file.

Next you can update the code and build FFPESMainDLL.DLL:

Select the "Win 32 Release" version.

Modify the user added routine. For example, increase the liquid density by 10% (DENSE = DENSE*1.1).

Select the Rebuild All option from the Build menu. CVF will build the FFPESMainDLL.DLL module in the directory \SIMSCI\PPHASE92\USERADD\MAKEWSP. Copy this file to the \SIMSCI\PPHASE92\BIN directory.

Note: To update the version identification to include the "UAS", you must rebuild D_MAINONE.DLL as described in the previous example.PIPEPHASE 9.2 Getting Started Guide 2-17

Now you can verify the UAS build:

Run file \SIMSCI\PPHASE92\USERADD\USERINP\ETH_UAS.INP and compare the results to file ETH_UAS.CHK.

Note: You may debug your routines by building this dll in debug mode as described in the previous example.2-18 Installing PIPEPHASE

Chapter 3Installation Troubleshooting

This chapter addresses some of the more common support questions and problems related to TOKEN and FLEXlm 7.2/9.5, USB, and General License security.

If you are having problems installing this product, review this section. If you are unable to correct the problem, contact Technical Support located at your local SIMSCI Technical Support Center, as listed in Introduction.

Diagnosis of Issues with TOKEN and FLEXlm 7.2/9.5 SecurityStep 1 - Ensure that the FLEXlm server is working correctlyWhen encountering a licensing problem with TOKEN or FLEXlm 7.2/9.5 security, first ensure that the FLEXlm server is running without any errors. The TOKEN license server is actually a FLEXlm 9.x server, and the only difference between these two types of license servers lies in the license files, one being token-based (each product requires a specified number of tokens when used) and the other product-specific. Incidentally, only a 9.x FLEXlm server can manage a SimSci-Esscor TOKEN license file. There are two ways to verify that the FLEXlm server is running correctly.

The first way is to examine the FLEXlm server debug log file PIPEPHASE 9.2 Installation Guide 3-1

ipassi.log. This log file is by default located in the FLEXlm directory (C:\Program Files\IPASSI\Security\FLEXlm for FLEXlm 7.2 and C:\Program Files\IPASSI\Security\FLEXlm95 for FLEXlm 9.5) The actual location for this log file can be found from the FLEXlm lmtool.exe utility in the "Path to the debug log file" field

on the "Config Services" tab (see figure below). Carefully go through the log file to see if there are any errors recorded in this log file.

Figure 3-1: LMTOOLS Config Services tab

Alternatively, after attempting to start the FLEXlm server, start the lmtools.exe utility, click on the "Server Status" button on the "Sever Status" tab, and then click the "Perform Status Enquiry" button (as shown in the Figure on the next page). Again, carefully go through the output text to find any error messages. Note that if you need to perform the server status enquiry multiple times, you can use "Edit->Clear Window" from the menu bar as this will clear the output text box for easy reading.

3-2 Installation Troubleshooting

Figure 3-2: Server Status tab

If there are any error messages in the FLEXlm server log file or in the lmtool.exe "Server Status" output text window, try and take appropriate action to resolve the problem yourself.

Examples:

If you try to start the FLEXlm server on a license file not intended for the license server, you will get an authentication error. In this case, you will either need to install the license (and FLEXlm server) on the machine for which the license was generated, or contact [email protected] to issue you a license file for the machine on which the FLEXlm server is installed.

Another issue could be that the licenses themselves have expired. The expiry date can either be obtained by looking at the license file, ipassi.lic, or by clicking on the "Perform Diagnostics" button on the "Server Diags" tab. If the licenses have expired, then contact [email protected] to renew your licenses.

A further common error is that the FLEXlm server machine name, the second item on the SERVER line in the FLEXlm license file, is not stated correctly. An example of the server line, from a permanent license, is as follows:

SERVER miawa2ca 000874fe5ea8

Or for a temporary license:PIPEPHASE 9.2 Installation Guide 3-3

SERVER ukfcra-g6fyq0j ANY

Note, for a temporary license the ANY, the third item on the SERVER line, must be retained.

If the machine name is correct in the SERVER line but the FLEXlm server is still not starting correctly, then use the IP address of the server machine instead of the machine name.

For errors that you cannot resolve yourself, contact your SimSci-Esscor technical support for assistance. When doing so, have the server log file available to send as this will aid in the troubleshooting.

Step 2 - Ensure that the application is using FLEXlm/TOKEN securityIf the FLEXlm server is up and running with the correct license, but there is still a problem launching the application due to a FLEXlm/TOKEN security error, then the focus should switch to the SimSci-Esscor application side. The second step in troubleshooting FLEXlm/TOKEN security is to verify if FLEXlm/TOKEN is indeed the active license security type. This selection of license security type is made in the main initialization file (*.ini) of the application. These files are usually named after the applications they control, such as PROII.ini, PIPEPHASE.ini, DATACON.ini, etc. The easiest way to locate these ini files is to search the application directory for the *.ini file that contains the string [wss_Security]. Once you identify the ini file, you need to open the file (Notepad will work fine for this) to see what the active security type is. Search for the Type statement in the [wss_Security] section. The active security Type statement is the one that does not have a semi-colon (;) in front of it. If FLEXlm/TOKEN is not the current active security type, you will need to comment out the current active type by placing a semi-colon at the beginning of that line, and uncomment the ;Type=FLEXlm or the ;Type=TOKEN line. For example:

[wss_Security] (if you are using FLEXlm 9.5 for security)

Type=FLXLM95

;Type=USB

;Type=FLXLM72

;Type=TOKEN3-4 Installation Troubleshooting

Or

[wss_Security] (if you are using TOKEN for security)

Type= TOKEN

;Type=USB

;Type=FLXLM72

;Type= FLXLM95

If FLEXlm/TOKEN security was previously not the active security type and has now been made the active security type, the user should test the application to verify that the change has corrected the problem. If the FLEXlm/TOKEN security still does not work, proceed to Step 3 for further diagnosis.

Step 3 - Ensure that the application is using the correct set of security filesThis step involves checking the security files at two levels. At the first level, the user needs to make sure that the application is actually using its own set of security files (scintf.dll, token.dll, flxlm72.dll, and flxlm95.dll). Sometimes multiple copies of the security files exist on the machine and the application may be using the file(s) somewhere on the paths specified in the PATH environment variable, not the ones under its own directory. Since this will create significant confusion during security troubleshooting, it is highly recommended that all security files that are not part of any SimSci-Esscor application file systems be deleted, especially the ones on the PATH environment variable. When this is done, the user can be sure exactly which security files the application is using.

The second level is only applicable to the FLEXlm security. The SimSci-Esscor FLEXlm security comes in two versions, 7.2 and 9.5. Because these two versions are not completely compatible with each other, it is critical that the FLEXlm client (the flxlm.dll on the application side), the license file, and the FLEXlm server be of the same FLEXlm version. The symptom of this incompatibility is that the application fails and in the server debug file you see the license is checked out and back in almost at the same time. The FLEXlm server version can be found in the server log file (ipassi.log) and the license file version can be found in the license file itself. If the version cannot be found in the license file, then the license file should be FLEXlm version 7.2. The version of the flxlm.dll can be PIPEPHASE 9.2 Installation Guide 3-5

found by right-clicking the file, selecting Properties, and then selecting the Version tab. From 2006, we are moving towards using the FLEXlm version in FLEXlm dll file names. For instance, flxlm72.dll means the file is version 7.2 and flxlm95.dll means version 9.5. Moreover, the value of the Type statement in the application ini file also uses flxlm95 and flxlm72 to reflect the FLEXlm version it is using.

Step 4 - Ensure that the FLEXlm communications are functioning properlyIf the FLEXlm server is running correctly and the applications' licensing configuration is appropriate, but there is still a FLEXlm/TOKEN licensing problem, turn the focus to the communications between the application machine and the FLEXlm server machine.

To do this, first ping the FLEXlm server machine from the application machine to see if the communications between them are enabled. If not, the user should contact their IT personnel to resolve this issue first. After the fundamental communications problem is resolved, examine the value of the environment variable IPASSI_LICENSE_FILE on the application machine to see if the value points to the intended FLEXlm server machine. If this value has been set multiple times, examining and editing the value in the registry may be necessary because the old value may be cached in the registry location. The figure below shows the registry entry for server @cms4m0ca:

Figure 3-3: Registry Editor entry for FLEXlm

The user can directly delete/edit the value of the IPASSI_LICENSE_FILE from here or run lmpath.exe to accomplish the same result.

Another issue with this environment variable is that sometimes the application machine system has a problem resolving the FLEXlm server machine name into the IP address. In this case, instead of 3-6 Installation Troubleshooting

using the FLEXlm server machine name for value of IPASSI_LICENSE_FILE, use the FLEXlm server machine's IP address, such as @123.12.10.100.

If the environment variable is managed correctly and the problem still persists, the user may resolve the problem based on any error messages rendered on the application side. The user should exam-ine the contents of the FLEXlm server log file ipassi.log to see if there are any records about the license request. If there are no records at all in the server log file about this license request, then the communication between the FLEXlm client and FLEXlm server have not been established. In this case, the user needs to examine the firewall on the FLEXlm server machine to ensure that the port numbers used by the FLEXlm server (lmgrd.exe) are enabled for the communication. The port numbers used by the FLEXlm server can be found in the FLEXlm server log file ipassi.log.

Example:

10:21:59 (lmgrd) lmgrd tcp-port 27000

10:22:10 (lmgrd) IPASSI using TCP-port 2601

Another possible FLEXlm communication issue may be encountered accessing FLEXlm licenses over the internet, as it may take longer for the application to connect to the FLEXlm server machine. If this takes too long, the application may prematurely timeout the connection attempt and return an error. To overcome this problem, set the environment variable FLEXLM_TIMEOUT on the application machine. The usage of this variable is as follows:

Set the timeout value of a FLEXlm-licensed application when attempting to connect to a license server port in the range 27000-27009. Values are in microseconds, within the range 0 through 2147483647. The default setting is 100000 microseconds.

The other thing the user can do to reduce the connection time is to explicitly set the FLEXlm server ports such that the application knows exactly what ports to talk to. Please refer to Table 3-1: FLEXlm License Security-related Problems and Solutions for details on setting up explicit FLEXlm server ports.PIPEPHASE 9.2 Installation Guide 3-7

Table 3-1: FLEXlm License Security-related Problems and Solutions

Problem Can I have multiple FLEXlm servers installed and run on the same machine?Fix Yes, it is allowed to install and simultaneously run multiple FLEXlm servers from

different vendors on the same machine. When doing so, it is highly recommended that you install the servers to different locations so that they do not interfere with one another. However, multiple FLEXlm servers from the same vendor cannot run simultaneously. Only one version can be active at a time. For example, the IPASSI FLEXlm 7.2 and 9.5 can be installed in different locations on the same machine, but only one of them can be running at a time.

Problem I have multiple IPASSI license files on my FLEXlm server machine. Can I combine them into one?

Fix If those license files have an identical SERVER line, then they can be combined. Otherwise, the answer is no. After the merge, there should be only one SERVER line and one VENDOR line in the resultant license file.

Problem How do I instruct my IPASSI FLEXlm server to use multiple license files?Fix Use lmtools.exe to configure the FLEXlm service so that the field "Path to the license

file" points to the directory where the license files are located (as shown below). In addition, all the license files in the directory must have the .lic file extension name.

Figure 3-4: Verify Path to the license file 3-8 Installation Troubleshooting

Problem How can I make FLEXlm security work with firewall on the FLEXlm server machine?Fix To make FLEXlm security work with firewalls, the following three components must be

configured correctly.

1. Use a port number on the SERVER line in the license file as follows: SERVER host hostid [port]

Example: SERVER ips-sol07 0002b303df80 27000

2. Use another port number on the VENDOR line in the license file: VENDOR vendor [port=]port

Example: VENDOR IPASSI port=27001

3. On the application machine, set the value of the environment variable IPASSI_LICENSE_FILE to be 27000@ips-sol07. The port number here is the port number from the SERVER line.

4. Make sure both the ports are enabled on the FLEXlm server machine.5. Ensure that the port numbers for the SERVER line and for the VENDOR line are

not used by other applications on the FLEXlm server machine, and are different from each other.

Problem How do I automatically launch my FLEXlm server when I reboot my FLEXlm server machines?

Fix For FLEXlm servers on Windows NT/2000/XP/2003 machines, this is possible through the "Config Services" tab. On this tab, check the "Use Services" and the "Start Server at Power Up" check boxes and save the server configuration.

Problem How do I prevent my FLEXlm server from being manipulated by users on other machines?

Fix Beginning with FLEXlm 9.x, when you are starting the FLEXlm server, you can specify that users on other machines cannot shut down the FLEXlm server. To do this, go to the Start/Stop/Reread tab, select the service you are about to start, click the "Advanced settings," and check "lmdown will only work from node where lmgrd is running." Then, click "Start Server."Figure 3-5: Configuring through Start/Stop/Reread tabPIPEPHASE 9.2 Installation Guide 3-9

Problem If I get the message below when launching a SimSci-Esscor application, what could be going wrong?Figure 3-6: Invalid (inconsistent) license key (-8,544)

Fix A common cause of this error is that the FLEXlm dll on the application is of version 7.2, but the FLEXlm server is 9.5. In this case, run the FLEXlm 9.5 Client Retrofit program to update the application and this should resolve the problem.

Problem How do I obtain the system information about the machine, including the host ID?Fix The FLEXlm utility, lmtools.exe System Settings tab, is always the most accurate for

checking the host ID. Note that when issuing a FLEXlm/TOKEN license, SimSci-Esscor uses Ethernet Address or Disk Volume Serial Number to bind the license. If your FLEXlm cannot start correctly, you may want to verify that the Ethernet Address or Disk Volume Serial number in the license file is consistent with that on the machine. In addition, you may check the Computer/Hostname to verify that this value is the same as the second item on the SERVER line in your license file. An example of lmtools System Settings tab display:

Figure 3-7: Getting the machine information from System Settings tab

Problem How do I configure the usage of my license(s)?Fix Use a FLEXlm options file to specify how the license(s) should be used. For detailed

information, please refer to the Options File documentation.Problem How do I include a FLEXlm options file and how would I know if the FLEXlm server is

using the options file?3-10 Installation Troubleshooting

Diagnosis of USB Security ProblemsWhen encountering licensing problem with the USB security, you can diagnose the problem following the steps described below:

Step 1 - Verify the active type of license security

This step is to ensure that USB is indeed the active license security type. This selection of security type is made in the main initialization file (*.ini) of the application. These files are usually named after the programs they control (Proii.ini, PipePhase.ini, Datacon.ini, etc.) The easiest way to locate these files is to search the application directory for the *.ini that contains the word [wss_Security]. When the ini file is identified, you need to open the file (Notepad will work fine for this) and find the value of the Type statement in the [wss_Security] section. The active security type

Fix If you use "ipassi.opt" for the name of the options file, then simply put this options file in the FLEXlm server folder (where the lmgrd.exe and IPASSI.EXE are). When the next time the IPASSI FLEXlm server starts, it will automatically read and apply the rules in this file. If the options file does not have the default file name or is not located in the FLEXlm server folder, then you'll need to explicitly specify the options file on the VENDOR line in the license file as follows:VENDOR IPASSI options="C:\Program Files\IPASSI\Security\FLEXlm95\ipassi.opt"Note that if there are any spaces in the path or the file name, put double quotes around the fully qualified path as above. When an options file is in use, you should see an entry similar to that shown below in the FLEXlm server log file, ipassi.log:

16:12:11 (IPASSI) Using options file: "C:\Program Files\IPASSI\Security\FLEXlm95\ipassi.opt"

Problem Can I use a regular FLEXlm license file and a TOKEN license file under the same IPASSI FLEXlm server?

Fix Technically, this configuration should work. However, this is not recommended as the logging and reporting functionalities work differently for FLEXlm and for TOKEN security. For clarity, it is highly recommended that FLEXlm and TOKEN be installed on different license server machines.

Problem We're using FLEXlm over a wide-area network. What can we do to improve the FLEXlm licensing performance?

Fix To shorten the initial connection time between the FLEXlm Client and the FLEXlm Server over a wide-area network, you can specify the FLEXlm server port numbers in the FLEXlm license file. In this case, the Client will know exactly what ports on the Server machine to use when trying to connect to the Server.

Problem We're using FLEXlm over a slow wide-area network. What can we do to allow longer FLEXlm Client/Server initial connection time?

Fix You can set the environment variable FLEXLM_TIMEOUT to a larger value on the Client machine. This value sets the timeout period of a FLEXlm-licensed application when attempting to connect to a license server port in the range 27000-27009. Values are in microseconds, within the range 0 through 2147483647. The default setting is 100000 microseconds.PIPEPHASE 9.2 Installation Guide 3-11

will not have a semi-colon (;) in front of the Type statement. If USB is not the current active security type, you will need to comment out the current active type by placing a semi-colon at the beginning of the line, and uncomment the ;Type=USB line as follows:

[wss_Security]

Type=USB

;Type=FLXLM72

;Type=FLXLM95

;Type=TOKEN

If USB was not previously the active security type and has now been made the active security type, the user should test the application to verify that the change has corrected the problem. If the USB security still does not work, proceed to Step 2 for further diagnosis.

Step 2 - Examine the USB environment on the machine

For the USB security to work, the machine itself must be able to correctly detect the USB key. This step is to determine if this is the case. With the USB key plugged in, go to the Device Manager and open the Universal Serial Bus Controllers to see whether the entry for the USB key is listed correctly as illustrated below:

Figure 3-8: Verify the USB key

If there is a conflict or problem, the USB SuperPro controller (shown as Rainbow USB SuperPro) will show up with a yellow exclamation mark or a red X (or may not show up at all). The figure on the next page shows an example of a USB driver issue, i.e. a yellow exclamation mark displayed by the USB SuperPro entry:3-12 Installation Troubleshooting

Figure 3-9: A typical sign of USB issue

When the machine is not detecting the USB entry correctly, please unplug the USB key from the machine and uninstall the existing USB driver from the Add/Remove Programs window as below:

Figure 3-10: Uninstall USB driver through Add/Remove Programs

After un-installing the existing USB driver, install the USB 7.0 driver. The install program for USB 7.0 driver is available from the SimSci-Esscor application install CD or from the SimSci-Esscor ESD web site. After installing the driver successfully, the Sentinel Protection Installer 7.0.0 entry should appear in the Add/Remove Programs window as follows:

Figure 3-11: Verify the upgraded USB driverPIPEPHASE 9.2 Installation Guide 3-13

Now, plug the USB key back into the machine and go to the Device Manager again to verify that the system is correctly detecting the USB key. If the problem persists, then either the key is damaged or the computer, including the USB port, may be malfunctioning. In this case, the user will either have to try the key on another machine that has a working USB environment to determine if the key is good; or alternatively, the user can try another USB key that is known to be working on another machine to try on the "problem" machine and verify if its USB environment is functioning correctly. If the result indicates that the USB key is not functioning properly, please return the key to SimSci-Esscor technical support for further diagnosis. If the USB environment on the machine is not working correctly, the user will have to resolve the machine problem first.

Another method for examining the USB environment is to use the SuperproMedic utility program (SproMedic.exe) from Rainbow Technology. The install program (SuperproMedic.exe) for this utility is available in the Utility folder in the USB 5.0 Retrofit program, which can be found in the SimSci-Esscor ESD web site. The default install location for this program is C:\Program Files\Rainbow Technologies\SuperPro\Medic. This program displays the version of the current Sentinel System Driver on the machine. Note that not all versions of Sentinel System Driver work with the SimSci-Esscor USB key. If the existing USB driver is not a good one, the SuperproMedic utility program will indicate the problem as shown in the figure below:

Figure 3-12: Version 5.39.2 - Unknown S

In this case, the user will have to unplug the USB key from the machine, un-install the current USB driver, and then re-install the USB 7.0 driver.

When the utility program shows no error in the Sentinel System Driver, the user can click on the Find SuperPro button to see if it can detect the USB key. If it finds the key, the output should look similar to that shown below:3-14 Installation Troubleshooting

Figure 3-13: 1 Hard limit of first key found

If no keys are detected, the output is as follows (0 Hard limit of first key found):

Figure 3-14: No SuperPro keys detected

Step 3 - Examine the SimSci-Esscor USB key and the USB.DLLIf the SproMedic.exe utility can correctly detect the USB key, the next thing to look at is the USB.DLL and the USB key. A potential problem with the USB.DLL is that it may not be recent enough to recognize the applications turned on in the USB key. To eliminate this problem, the user simply downloads the USB 5.0 Retrofit program from the Update area in the SimSci-Esscor ESD web site, and then retrofits the application accordingly to update the USB.DLL. After the retrofitting, the user can run the USBKeyCheck.exe utility program first to see if the USB key is good. If the USBKeycheck.exe program indicates that the USB key has already expired or does not contain the license to run the application, please contact the SimSci-Esscor sales representative to resolve this issue. PIPEPHASE 9.2 Installation Guide 3-15

Step 4 - Examine the copies of USB.DLL on the machineSometimes there are multiple copies of USB.DLL existing on the machine. In this case, the application may or may not be using the newly updated USB.DLL obtained from the previous step. The SimSci-Esscor security files, including USB.DLL, should only exist inside the application folder and the application should only use its own set of security files. Should there be any SimSci-Esscor security files existing outside of all SimSci-Esscor application folders, it is highly recommended that they be deleted to eliminate the confusion, especially those that exist on the paths specified in the PATH environment variable.

General License Security questionsTable 3-2: General License Security-related Problems and Solutions

Problem Can I use mixed security types in one application session?Fix No. With the current license security implementation, only one licensing type can be

used in one application session.Problem Where do I download SimSci-Esscor license security software?Fix As long as you have a valid SimSci-Esscor ESD user account, you are eligible to

download the license security programs/utilities from the ESD web site. The steps for the download are:1. Open the web page http://www.simsci-esscor.com

2. Select Support->Software Updates & Knowledge

3. Click the "Enter the SIM4ME Software Updates & Knowledge Base Website" link

4. Click the "License Security" link

5. Enter your user name and password and click the Login button

6. Click the "Updates/Documentations/Examples/Utilities/Simulation Tips" link

7. Click the item that you'd like to downloadProblem You have problems reading the disks: General failure reading drive, repeats the request

for the next disk (wrong disk). Errors during the installation or unloading of the archived files.

Fix 1 1. Verify that you have inserted the correct disk.2. Insert the disk again and retry.

Fix 2 1. Verify the disk with CHKDSK.2. If the disk cannot be read, or if CHKDSK shows errors, contact Technical Support for fast replacement.

Problem Invalid path of access failures: You receive messages that files could not be copied and that the installation failed.

Fix 1 If you are installing to a network, ensure that you have adequate read/write access privileges.

Fix 2 Ensure that you have enough disk space in the specified directory.Problem Security chip missing errors.3-16 Installation Troubleshooting

Fix 1 The security device must be the first item in parallel port.Fix 2 Make sure that the security installation has been completed correctly and that you have

the security device listed in the installation instructions. Make sure that the security device is firmly inserted into the parallel port.

Fix 3 Check the 25 connector pins on the security device for damage.Fix 4 If a printer is attached, make sure it is turned on.Fix 5 Some laptop computers do not put out enough voltage to the parallel port to return an

answer to the program. You can test this by attaching a printer, turning it on, and executing the program. If it works with a printer attached, then you can use that as a solution, move the program to another computer, or contact Technical Support for a special battery adapter to increase voltage directly to the security device number. Something to try: Some laptop problems have been resolved by attaching a cable at least two feet long to the printer side of the security device (no printer).

Fix 6 Make sure only similar security devices are piggybacked.Problem INPLANT is installed on a system running Windows NT. When you run INPLANT, it

produces errors relating to security.Fix Ensure that whoever installed INPLANT had system administration rights/privileges.PIPEPHASE 9.2 Installation Guide 3-17

3-18 Installation Troubleshooting

Chapter 4Getting Started

Starting PIPEPHASEIf you do not see a PIPEPHASE 9.2 icon in a SIMSCI group window or in your Program Manager window, see the troubleshooting section in the PIPEPHASE Installation Guide.

To start PIPEPHASE:

Double-click on the PIPEPHASE 9.2 icon.

The main PIPEPHASE window appears.

Figure 4-1: The PIPEPHASE Main WindowPIPEPHASE 9.2 Getting Started Guide 4-1

You can now open a new simulation file (select File/New), open an existing file (select File/Open), or import a keyword file (select File/Import Keyword File). The elements of the PIPEPHASE main window are described in Table 4-1.

To learn how to build a network, enter data, and run and optimize a simulation, see Chapter 6, Tutorial.

Exiting PIPEPHASETo exit PIPEPHASE, do one of the following:

Choose Exit on the File menu .

Double-click on the Control-menu box in the upper left hand corner of the PIPEPHASE main window .

Table 4-1: PIPEPHASE Main Window Components

Component Description

Control-menu Box Displays a menu with commands for sizing, moving and closing the active window.

Title Bar Identifies the application and the name of the open file; can be used to move the entire window.

Minimize Button Enables you to reduce the application to an icon.

Maximize/Restore Button (Not shown)

Enables you to enlarge a window to full-screen or restore a window to its default size.

Menu Bar Identifies the menus available in PIPEPHASE: File, Edit, View, General, Special Features, and Help.

Toolbar Provides push button access to various File, Edit, View, General, Special Features, and Help menu options.

Main Window Provides the repository for placing sources, sinks, or junction, adding links, and calculator or hydrates units, i.e., for drawing the network diagram.

Horizontal Scroll Bar Provides a sliding scale for moving the flowsheet right or left in the PIPEPHASE main window.

Vertical Scroll Bar Provides a sliding scale for moving the flowsheet up or down in the PIPEPHASE main window.

Status Bar Provides guidance, focus and error messages for the active feature or object.

Border Handles Enables you to quickly change window height, width, or size by grabbing the corresponding border handle and dragging it to a new position.4-2 Getting Started

Manipulating the PIPEPHASE Window The PIPEPHASE window offers a variety of features that enable you to customize how PIPEPHASE appears relative to the full screen and relative to other applications.

Changing Window Size The Windows interface provides tools for resizing each window. Some tools automatically change a window to a particular size and orientation, others enable you to control the magnification.

To display the control-menu box:

Click on the control-menu box in the top left hand corner of the PIPEPHASE main window or use .

Select the Move option from the menu.

Working with On-screen Color Coding Cues PIPEPHASE provides the standard visual cue (grayed out text and icons) for unavailable menu items and toolbar buttons. In addition, on the network, PIPEPHASE uses colored borders liberally to indicate the current status of the simulation.

Note: PIPEPHASE does not support multiple sessions for two different files located in the same directory.

Tools Description/Action

Minimize/Maximize Buttons

By clicking on the minimize and maximize buttons, you can automatically adjust the size of a window.

Border Handles You can use the window border to manually change the size of the main window. The border works like a handle that you can grab with the cursor and drag to a new position.

Control Menu You can also use the Control menu to Restore, Move, Size, Minimize, or Maximize a window.

Window Position You can change the position of the main window (or any pop-up window) by clicking on the title bar and dragging the window to a new position.

Control-menu Box You can also use the control-menu box to move a window.

Table 4-2: Flowsheet Color Codes

Color Significance

Red Required data. Actions or data required of the user. On the main PIPEPHASE windows and Link PFD only.

Blue Data you have supplied. PIPEPHASE 9.2 Getting Started Guide 4-3

Using the Menus The names of the PIPEPHASE main menus appear on the menu bar. From these menus, you can access most PIPEPHASE operations.

To display a menu:

Click on the menu name or press where n is the underlined letter in the menu name.

For example, to display the File menu, either click on File, or press .

Burgundy Calculated data.

Gray Data field not available to you.

Table 4-2: Flowsheet Color Codes

Color Significance

Figure 4-2: File Menu Figure 4-3: Edit Menu

Figure 4-4: View Output Menu Figure 4-5: General Menu 4-4 Getting Started

Choosing a Menu Item To choose a menu item, do one of the following:

Click on the desired item.

Use the arrow keys to highlight the item, then press .

Use the accelerator keys.

Using the Toolbar Buttons

Figure 4-8: Toolbar Buttons

The toolbar contains four groups of buttons:

File Manipulation Buttons

Structure and Unit Operation Buttons

Calculation Options, Optimization, and Property Buttons

Zoom and Redraw Buttons

Figure 4-6: Special Features Menu Figure 4-7: Help Menu

Note: Grayed out icons indicate that the functions are currently in passive mode and will become active when necessary.PIPEPHASE 9.2 Getting Started Guide 4-5

Using the File Manipulation Buttons These buttons enable you to open a new or existing simulation, import a keyword file, save a simulation, run a simulation, or view or print an output. These buttons duplicate menu options available on the File menu.

Using the Structure and Unit Operation Buttons These buttons enable you to add sources, sinks, junction, calculator units, or hydrate units to the flowsheet.

Button Menu Item Description

New Enables you to create a new simulation.

Open Enables you to open an existing simulation.

Import Keyword File Enables you to import an existing input file.

Save Enables you to save an open simulation.

Run Enables you to run the simulation.

Excel Reports Enables you to create Excel Reports.

Sim4Me Enables you to open Sim4Me Portal.

Note: PIPEPHASE permits the users to save, import and open files from locations with file path length of up to 120 characters and file name length of up to 64 characters.


Enables you to add a source to the flowsheet.

Enables you to add a sink to the flowsheet.

Enables you to add a junction to the flowsheet.

Enables you to add a Manifold unit to the flowsheet.

Enables you to add a calculator unit to the flowsheet.

Enables you to add a hydrate unit to the flowsheet.4-6 Getting Started

Using the Calculation Option, Optimization, and Property Buttons These buttons enable you to customize your calculation options, input dimensions, and global defaults, add optimization, and add component and thermodynamic or PVT data. These buttons duplicate menu options available on the General menu.

Using the Zoom and Redraw Buttons These buttons allow you to refresh, zoom in and out, search an object/Device on the flowsheet.


Input Units of Measurement

Enables you to specify your input units of measurements.

Component Library Enables you to specify your compo

PIPEPHASE Getting Started Guide[1]

Documents

Transcript of PIPEPHASE Getting Started Guide[1]