Smartplant Review: Citrix Installation Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 43

SmartPlant Review

Citrix Installation Guide

Version 2014

August 2013
DVIS2-PE-200012C

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

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
300 Intergraph Way
Huntsville, AL 35813

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on eCustomer, SharePoint, or
box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for
using a software product.

Terms of Use
a.

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

b.

For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensees internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensees internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

SmartPlant Review Citrix Installation Guide

UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATIONS LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporations software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a.

To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.

b.

To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www,bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List,
www.treas.gov/offices/enforcement/ofac/http://www.pmddtc.state.gov/compliance/debar.html, and the U.S. Department of State
Debarred List.

c.

To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.

d.

To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.

Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporations Export
Compliance Department, Huntsville, Alabama 35894, USA.
Portions of the user interface copyright 2012-2013 Telerik AD.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, CADWorx, CAESAR II, 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 Review Citrix Installation Guide

SmartPlant Review Citrix Installation Guide

Contents
Preface Citrix Guide .................................................................................................................................... 7
What's New with SmartPlant Review Citrix Installation .......................................................................... 9
Internationalization .................................................................................................................................. 9
SmartPlant Review and Citrix .................................................................................................................. 13
Installation of SmartPlant License Manager ........................................................................................... 15
SmartPlant License Manager and Citrix ............................................................................................... 17
Microsoft Windows Firewall and SmartPlant License Manager ............................................................ 19
Installing SmartPlant Review ................................................................................................................... 21
SmartPlant Review Workstation ........................................................................................................... 21
Performance Tips .................................................................................................................................. 22
Install SmartPlant Review ..................................................................................................................... 26
Add Individual Modules After Installing the Core Product .................................................................... 27
Install SmartPlant Review in Silent Mode ............................................................................................. 28
Configuring SmartPlant Review for Integration ..................................................................................... 31
Configuring SmartPlant Review for Citrix............................................................................................... 33
Deploying SmartPlant Enterprise on Citrix ............................................................................................. 35
Set Up the Citrix XenApp 6.5 Server .................................................................................................... 35
Publish Applications on the Application Delivery Server ...................................................................... 35
Install the Application on the Application Delivery Server .............................................................. 36
Publish the Application on the Application Delivery Server............................................................ 36
Additional Citrix Implementation Topics ................................................................................................ 37
Adding Application Path Statements to the System Path ..................................................................... 37
Publishing Complex Links or Shortcuts ................................................................................................ 39
Configuring Dual Monitors .................................................................................................................... 39
Citrix Client Time Zones ........................................................................................................................ 40
Disable the Citrix Virtual Memory Optimizer ......................................................................................... 40
Index ........................................................................................................................................................... 43

SmartPlant Review Citrix Installation Guide

Contents

SmartPlant Review Citrix Installation Guide

Preface Citrix Guide


This document describes how to install, configure, and use SmartPlant Review on Citrix XenApp
6.5.

SmartPlant Review Citrix Installation Guide

Preface Citrix Guide

SmartPlant Review Citrix Installation Guide

What's New with SmartPlant Review


Citrix Installation
Version 2014

SmartPlant Review supports Citrix XenApp 6.5.

Version 2012

SmartPlant Review supports the MSI Installer.

Version 2010

This is a new document.

Internationalization
Supporting internationalization in a homogeneous environment is one of the enhancements
available in SmartPlant Enterprise. A homogeneous environment uses elements from only a
single locale. For example, a German customer running on a German operating system using
only German characters and German cultural conventions is a fully supported homogeneous
environment configuration.

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

SmartPlant Review Citrix Installation Guide

What's New with SmartPlant Review Citrix Installation


Heterogeneous Environments
In contrast, a heterogeneous environment using elements from different, or even multiple
locales, is not supported. Many customers are currently operating in unsupported
heterogeneous environments and are often not aware of that fact. Examples of heterogeneous
environments:
Entering or viewing Japanese data on an US/English operating system
Using German Regional Settings (where the decimal point is a comma) on a US/English
operating system
Using databases with different character encodings such as CL8MSWIN1251 or JA16SJIS
Using multiple languages in a project, especially when crossing language-group boundaries
Using an English server with different local language clients

International / Bi-lingual Projects


International bi-lingual projects are possible; however, great care must be used when
configuring these environments. Limitations exist and must be properly understood:
Oracle and MS SQL Server databases can reside on any language operating system, as
long as the databases have been created and configured with proper Unicode and collation
settings.
All SQL Server databases must have the same collation setting and reflect the master
language. Text is stored, sorted, indexed, and presented based on the collation setting. You
must determine which language will be used primarily to generate output (P&IDs, SLDs,
reports, approval documents, and so forth.) If Russian and English text is entered, and
Russian is the target locale, the chosen collation should be based on the Cyrillic character
set.
All Microsoft operating systems (Japanese, Russian, German, and so forth) can enter
English characters. The reverse, however, is not true in most cases.
Keyboard-locale can be changed as long as a character-set and code-page boundary is not
crossed. For example, English, German, French, and Spanish characters can all be used in

the same project because the same Windows code-page (1252) is used. However, Russian
characters (code-page 1251) cannot be used in a US/English environment.
You must decide which language operating system will be the master for bi- lingual projects.
The following is an example of a Russian-based project:
Companies in the United States and the United Kingdom are working a project with a Russian
company and the deliverables (drawings, reports, and so forth) must ultimately be provided in
Russian. The companies in the U.S. and the U.K. are working the project using the "master"
Russian operating systems (possibly using virtual Russian operating systems running on
VMware Workstation). The U.S. and U.K. companies can install and use English Microsoft
Office products on the Russian operating system because Office products are globally enabled.
If a Russian interface exists for the SmartPlant Enterprise application, then Russian users can
use the Russian interface while the English-speaking users would continue to use the
US/English interface. English-speaking engineers can enter English characters.
Russian-speaking engineers can enter Russian characters.
However, because the Russian locale uses different decimal and character-set locales,
everyone (English and Russian engineers) must use the Russian decimal symbol which is a
comma. For customization purposes, databases can be modified to accommodate new
Russian-specific requirements (fields, properties, and so forth.) Using filters, display sets, and
other software features, bi-lingual projects can be further customized. Graphic data, reports, and
so forth can be created in either or both languages.

10

SmartPlant Review Citrix Installation Guide

What's New with SmartPlant Review Citrix Installation


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

Citrix XenApp Solutions for International Projects


Using Citrix XenApp Solutions, you can define environments that isolate users from having to
interact with non-native language operating systems while improving data integrity and
minimizing opportunities for data corruption. However, users still have to enter data using
master locale conventions for the project (decimal separator and date conventions, for
example). You can create these environments using different combinations of languages, but
some limitations exist. For example, you cannot use Russian and Chinese text together in a
project. In addition, special language characters (the German and for example) cannot be
used if the master locale is outside the western Latin-based languages (the master locale is
Russian, Chinese, Japanese, or Korean for example).

Questions and Assistance


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

SmartPlant Review Citrix Installation Guide

11

What's New with SmartPlant Review Citrix Installation

12

SmartPlant Review Citrix Installation Guide

SECTION 1

SmartPlant Review and Citrix


Performance Issues
A Citrix Presentation Server implements a virtualization environment that uses an emulated
graphics card instead of a native hardware 3D CAD Workstation graphics card. This means that
all clients running SmartPlant Review in Citrix will notice a severe degradation in performance
because SmartPlant Review cannot take advantage of full hardware acceleration on this
emulated graphics card.

Prerequisites
Citrix Prerequisites:
Before you install any SmartPlant Enterprise software on a Citrix server, you must install and
configure Citrix software and the corresponding prerequisites on the server. See the Citrix
documentation for more information.
SmartPlant Enterprise Prerequisites:
To run SmartPlant Review on a Citrix server, you must install the same prerequisite software
that is required for the product to run on a desktop client system. Make sure that any
prerequisite software installations are matched to the operating system. All patches or products
should be in accordance with administrative guidance. For more information about software
prerequisites for SmartPlant Review, see SmartPlant Review Workstation (on page 21).
To install software on a Citrix server, you must log on with an account that has
administrator level access and use the Change User Mode option to set the Terminal Server in
the Installation mode.
Special Hardware Requirements:
See the Citrix documentation for system hardware for the Citrix server. SmartPlant Review
(SPR) requires at least 500MB of RAM for each concurrent user. This is in addition to the RAM
required for Windows and Citrix. A server running SmartPlant Review with fewer than six
concurrent users will require at least 4 GB of RAM. If 6 to 10 users will be accessing the system,
6 GB of RAM will be required. These are minimum requirements. Large work environments will
require additional RAM.

SmartPlant Review Citrix Installation Guide

13

SmartPlant Review and Citrix

14

SmartPlant Review Citrix Installation Guide

SECTION 2

Installation of SmartPlant License


Manager
Before beginning the product installation, refer to the delivered SmartPlant License Manager
readme file for the latest product installation updates. The readme file is delivered in the top
level product folder of the product media. Be sure you have the latest version of the SmartPlant
License Manager software before beginning the installation. If you do not have the latest version
of the software, you can install it using http://ppmapps.intergraph.com/elicense
(http://ppmapps.intergraph.com/elicense).
SmartPlant License Manager 2010 (v11) can be upgraded to SmartPlant License
Manager 2012 (v12). Any existing license key will be invalidated after the upgrade to SmartPlant
License Manager 2012 (v12). You will also need to generate a new computer ID and request a
new key. If you upgrade the SmartPlant License Manager 2010 (v11) license computer to a
SmartPlant License Manager 2012 (v12) client by mistake, you will have to un-install the
SmartPlant License Manager client and reinstall SmartPlant License Manager 2012 (v12)
license computer.

Hardware Configurations
The SmartPlant License Manager licensing computer software should be installed on a stable,
single node, hardware configuration (such as a simple PC), with a static IP address, because
license key installation and license seat usage authentication depends on the information
gathered from the physical hardware. Any automated changes that cause the hardware
information not to match with the information used to generate the license key will result in a
failure of the authentication process.
Virtual (including VMware), shadowed, mirrored, dynamic, or distributed hardware
configurations cannot be used as a SmartPlant License Manager licensing computer. This
includes terminal (application) servers, networked and distributed storage management
systems, and so forth. When these specialized systems occur in the user's network, the
SmartPlant License Manager Server licensing computer should be installed on a separate
dedicated hardware configuration system. The SmartPlant License Manager licensing computer
should be situated on the user's network where it can be accessed by all systems that are
running application software that relies on the SmartPlant License Manager licensing computer
for license management.
Multiple SmartPlant License Manager licensing computers can be used in the user's network as
long as each system is a unique hardware system/installation. If SmartPlant License Manager
licensing computers are cloned after the license key has been installed, then the license
management will fail on the cloned system. Each SmartPlant License Manager licensing
computer requires its own unique license key.

RAID (redundant array of independent disks) and SAN (storage area networks) are not
supported on a SmartPlant License Manager license computer.
The license computer must have the same version (or later) of SmartPlant License Manager
installed as any client computers. In other words, you cannot use a newer version on a client
computer to retrieve a license from an older version of SmartPlant License Manager on the

SmartPlant Review Citrix Installation Guide

15

Installation of SmartPlant License Manager


licensing computer. The license computer must have the same version (or a newer version)
installed than the clients.
You must log in as Administrator to install this software.
1. Insert the Intergraph SmartPlant License Manager media. If the media does not start
automatically, double-click Setup.exe in the root folder of the media.

2.
3.
4.
5.

During SmartPlant License Manager installation automatically turns on a product


usage log file in C:\Win32App\Ingr\SPLM\bin\loggingfileV12.txt. You can
change this location and name of this file as it can grow to be a large file. If you stop and
restart logging, you need to define the output location.
This file can grow very large and users can redefine the location and name of this file.
Select SmartPlant License Manager Installation.
Click Next on the Welcome to the InstallShield Wizard for SmartPlant License Manager
page.
Enter your name and company name in the User Name and Company Name fields on the
Customer Information page. Click Next.
On the Software License Agreement page, select your country from the list and click
Display to view the license agreement.

The license agreement is delivered as a PDF file.


6. Carefully read the license agreement. Close the PDF document, and click Yes on the
License Agreement page to accept the terms.
7. Select either License Client or License Machine.
8. On the Choose Destination Location page, click Next to install SmartPlant License
Manager in the default location. If you want to install the software in another location, click
Change and select the new location.
It is recommended that you install SmartPlant License Manager using a path that
contains no spaces, such as c:\win32app\Ingr (the default path).
9. Click Install on the Ready to Install the Program page. A status bar displays the progress
of the installation on the Status Setup page.
10. Click Finish on the InstallShield Wizard Complete page to complete installation of
SmartPlant License Manager.
Do not delete any files that are created during installation or as a result of using
SmartPlant License Manager. Removal of any files causes the license system to fail and
can require install, repair, or possibly removal and re-install of SmartPlant License Manager.
11. Add pdlice.exe to both the license computer and the client computer after installing of
SPLM. You may need to remove pdlice.exe and re-add it if you uninstall and reinstall
SPLM to upgrade SPLM from previous version to a current version. Otherwise, you may
receive a Connection timed out error message when you start your application. You may
also see the same error in your scavenging log file.

16

SmartPlant Review Citrix Installation Guide

Installation of SmartPlant License Manager

SmartPlant License Manager and Citrix


Before you install any SmartPlant Enterprise software on a Citrix server, you must install and
configure the Citrix software and the corresponding prerequisites on the server. Please refer to
your Citrix documentation for more information about any prerequisites.
To run SmartPlant Review software on a Citrix server, you must install the same prerequisite
software that is required for the product to run on a desktop client system. Make sure that any
patches or prerequisite software installations are matched to the operating system. For example,
a 64-bit operating system may require that some patches or products are also 64-bit. All patches
or products should be in accordance with administrative guidance. For more information about
software prerequisites for SmartPlant Enterprise products, see the documentation delivered with
the product.

Only SmartPlant License Manager client is supported on a Citrix machine.


The SmartPlant License Manager license machine does not support a NAT configuration on
a Citrix machine.
Running batch jobs on the Citrix XenApp 6.5 server is not supported.
If you are using Citrix, and crossing multiple time zones, the error message SPLM
Failed: Server/Client Timers Mismatch by 6+ Hours - <license server> can display. To
correct the error, adjust the Citrix server's Time Zone Redirection configuration to prevent it
from using the client's local time zone for the Citrix session. For more information, refer to
the Citrix's Knowledge Base article Troubleshooting Client Time Zone Issues
(http://support.citrix.com/article/CTX303498).
If you have the license machine defined under HK_Current_User for SmartPlant License
Manager, you cannot use Test Seat Reservation and Test Seat Release (commands in the
SmartPlant License Manager product) to test the licensing machines. Those test options are
used to test for the licensing machine configured in the SmartPlant License Manager's
registry key (value from HK_Local_Machine in Registry).

SmartPlant Review Citrix Installation Guide

17

Installation of SmartPlant License Manager

A license machine that is defined in the HK_Current_User does not roll over to a license
machine defined using the SmartPlant License Manager interface (saved in
HKLM_Current_User).

Additional information about certified Citrix versions is available on the SmartPlant Enterprise
Product Compatibility Matrix on the Intergraph Process, Power & Marine eCustomer Web site.
To view this matrix, browse to the following Web address, and type your eCustomer user name
and password: https://crmweb.intergraph.com. Click Download Software Updates >
Products, and then click the PPM Compatibility Matrices link in the middle of the page.
To install software on a Citrix server, you must log on with an account that has
administrator access. Use the Change User Mode Option to set the Terminal Server in the
"Installation" mode.

Hardware Requirements
Refer to your Citrix documentation for system hardware requirements for the Citrix server.
SmartPlant License Manager has no special hardware requirements beyond those
recommended for Windows.

Configure the SmartPlant License Manager Client on Citrix Server


SmartPlant License Manager listens for license requests on TCP port 807 (the port must be
open), and returns seat information over a randomly selected port. For more information, refer to
Appendix E: Microsoft Windows Firewall and SmartPlant License Manager.

18

SmartPlant Review Citrix Installation Guide

Installation of SmartPlant License Manager


Installing and Configuring the Product
Refer to Installation of SmartPlant License Manager (on page 15) for information about installing
and configuring SmartPlant License Manager. There are no special requirements for installing
SmartPlant License Manager for use with Citrix. Configuring and installing SmartPlant License
Manager as a license machine on Citrix is not supported.

Publishing SmartPlant Review Applications


SmartPlant License Manager does not require any components to be published for user access.
Administrative access to the SmartPlant License software can be accomplished by publishing
the SmartPlant License Manager application in accordance with standard Citrix practices. Use
the provided Start > Intergraph SmartPlant License Manager menu for SmartPlant License
Manager as a guide for publishing the individual SmartPlant License Manager applications.

Known Issues
Configuring SmartPlant License Manager as a license machine on Citrix is not supported.

Microsoft Windows Firewall and SmartPlant License


Manager
SmartPlant License Manager utilizes Transmission Control Protocol (TCP) ports to pass license
seats from the SmartPlant License Manager license machine(s) to the workstation(s). TCP port
807 is required to be open and is utilized by the SmartPlant License Manager license machine
to listen for requests from the workstation(s) for a license seat. If a request is made, a random
TCP port is utilized to pass the seat from license machine to client.
Since a firewall is used to prevent unauthorized port access, SmartPlant License Manager has
problems working properly with a firewall. Most firewall programs allow an Administrator to open
ports to prevent the firewall from interfering with a programs execution. Because SmartPlant
License Manager utilizes random ports, there is not a good way to do this unless the firewall
program also allows programs to be added to a program list to open ports required by the
program.
If the user exits the application properly, the license used by the workstation is released back to
the pool of licenses available. Sometimes, when an application process is exited abnormally, the
license seat is not returned to the license manager. This is where the SmartPlant License
Manager license machine can help. A scavenge routine can be setup to run that will scavenge
the network for seats that are reserved. If one is found, the seat can be returned to the pool if it
is no longer in use. The firewall prevents the license machine from retrieving the seat and
returns a timed out error message.
In order to run commands using the Command Prompt window, pdlice.exe needs to be
added to the Exception List for the Windows Firewall on both the license machine and the client
machine (if it is turned on). This includes all Windows operating system (for example, Microsoft
Windows 7, Windows Server 2008 R2, Windows Server 2003, Windows XP, and so forth). The
following steps provide an example of how to add the appropriate SmartPlant License Manager
program to the Exception List for Microsoft Windows 7 (allowing for proper scavenging and
access to the license machine).
1. Select Start > Control Panel > Windows Firewall to display the Windows Firewall options.
2. Click to select Allow a program or feature through Windows Firewall.
3. Click Change settings.
4. Click Allow another program.

SmartPlant Review Citrix Installation Guide

19

Installation of SmartPlant License Manager


5.
6.
7.
8.

Click Browse on the Add a Program dialog box.


Browse for the pdlice.exe program (by default it is installed in c:\win32app\ingr\splm\bin).
Click to select pdlice.exe and click Open.
Click Add on the Add a Program dialog box. SmartPlant License Manager now displays in
the Allowed programs and features list.
9. Click OK to dismiss the Windows Firewall options.
[Connecting Socket] Connection Time Out is the error message you receive if
pdlice.exe is not defined in the Windows Firewall exception list.

20

SmartPlant Review Citrix Installation Guide

SECTION 3

Installing SmartPlant Review


Your SmartPlant Review CD contains the SmartPlant Review product, SmartPlant Review
modules, and sample project files.

SmartPlant Review Workstation


Hardware Recommendations

3.0 GHz Intel Pentium 4 processor or Core 2 Duo processor.


4 GB RAM
CD-ROM drive access, either locally or through a network connection
Color display
(Optional) SmartPlant Review supports 3D Stereo. Consult the documentation that came
with your hardware to make sure it supports 3D stereo.
(Optional) Digital Joystick

Supported Operating Systems

Microsoft Windows Standard/Enterprise Server 2008 (R2) (64-bit)


Microsoft Windows 7 Professional and Enterprise Client (64-bit)

Software Prerequisites

Microsoft Visual C++ 2010 SP1 Redistributable Package with MFC Security Update
Microsoft Internet Explorer 8.0 or later (required for viewing the online documentation
delivered with the software)
A PDF reader (required during installation to view the License Agreement and Printable
Guides)
Microsoft Data Access Components (MDAC) 2.8.1 (MDAC 2.8.1 is available on the product
DVD)
If you are running SmartPlant Review on a non-English operating system and
locale, you must download the appropriate locale-specific version of the Microsoft Data
Access Components (MDAC) from Microsoft. SmartPlant Review might not work correctly
with multi-byte characters when using the English version of MDAC.
Microsoft DirectX 8.1 for Windows XP systems. 64-bit systems require version 9.0 (required
for using a joystick with SmartPlant Review).
Microsoft .NET Framework 4.0 (installed automatically during SmartPlant Review setup)
SmartPlant License Manager 2010 (v11)
SmartPlant License Checkout Utility (required to run in remote license mode.)

Software Compatibility

Citrix XENApp 6.5


Microsoft Access 2000 or later (for more information, see Understanding SmartPlant Review
Projects.)

SmartPlant Review Citrix Installation Guide

21

Installing SmartPlant Review

SmartSketch 2009 or later


SmartPlant Foundation 2009 or later
SmartPlant 3D or SmartMarine 3D 2009 or later and Intergraph Smart 3D 2014
Microsoft Project 2010 Professional
Primavera Project Planner version 2.0B (with RA installed), Primavera Project Planner 3.0,
and Primavera Engineering & Construction P6 Release 4.1, 5.0, 6.0, and 8.1.
To access the SDK, you must be added as a user with Administrator/SuperUser
access rights, OR be assigned the global privilege, View All Global/Project Data via SDK.
MicroStation SE 05.07.01.14, MicroStation/J 07.01.04.16 (SmartPlant Review supports PDS
models used in conjunction with MicroStation SE and MicroStation J. However, element
types new in MicroStation J are not supported by PDS and SmartPlant Review.
SmartPlant Review displays MicroStation/J SmartSolids in shaded mode if you
change the display setting to Surfaces using the MicroStation/J Change SmartSolid Display
tool on the 3D Utilities tool bar prior to opening the project in SmartPlant Review.
MicroStation V8 XM 08.09 - SmartPlant Review reads .VUE files and label databases
created by SmartPlant Interop Publisher from Microstation V8 data files.
SmartPlant Review does not directly read in the Microstation V8 data file
format.

Performance Tips
Memory Usage (Estimating Required RAM)
Use the following procedure to estimate the amount of RAM (or system memory) your
SmartPlant Review project needs. Actual memory usage varies based on the project data and
features being used. Runtime memory usage can increase significantly when using various
SmartPlant Review features, such as Animation, Display Sets, Collision Detection, Materials,
Raytracing, and so forth.
1. Estimate the total SmartPlant Review data size by summing the size of all files required by
your project that SmartPlant Review reads into memory.
For DRI projects, add the size of the DRI file and all listed model files (DGN, PRP, and
so forth). If the project database must be created (or recreated), add the size of any
legacy project text files that will be imported into the project database (MDB), such as
DST, SET, TAG, and so forth.
For single file projects (DGN, PRP, VUE), add the size of the single file. If the
MicroStation file references other MicroStation files, then the sizes of the referenced
MicroStation files should also be added.
For .SVF (multiple VUE file) projects, add the size of the SVF file and all listed VUE
files.
Be sure to add the size of any material files used by the project (MAT, PAL). Remember
that all texture files will consume system memory when raytracing or if graphics card
memory is not available.
The label database (MDB2) is not read into memory. However, if the label database
must be created (or recreated), then add the size of the single largest DRV and/or .XML file
being used to create the label database to approximate the extra memory needed to
process each DRV and/or .XML file data when creating the label database.

22

SmartPlant Review Citrix Installation Guide

Installing SmartPlant Review


2. Multiply this approximation by 1.2 for a rough estimate on the overhead of the SmartPlant
Review executable code in memory and the extra memory needed to process and manage
the data in the other files during load and during the SmartPlant Review session.

Virtual Memory (Swap Space)


Because the operating system and other applications take a portion of available memory,
leaving less memory available for SmartPlant Review, make sure you have enough virtual
memory.
Calculate the minimum required virtual memory by taking the larger of these two calculations:
(1.5 * RAM) * the number of processors on the machine
(1.5 * the largest dataset used in the application) * the number of
processors
Set the minimum and maximum virtual memory settings to the same value for best performance.
If the page file has to grow, it can become very fragmented. Although the operating system can
address only 2 GB of virtual memory at one time for each application, the swap space can be
larger because multiple applications can be in virtual memory at the same time.
For FAT and FAT32 file systems, virtual memory is limited to approximately 4 GB.
For NTFS file systems, virtual memory is limited to one approximately 4GB page file per
partition. NTFS file systems can have more than one page file by using a page file on more
than one partition.
For large VUE files, set the virtual memory to a value much larger than the VUE file size. For
extremely large VUE files, set the virtual memory to the maximum allowed for your file
system, defragment the drive, and close any non- essential programs to provide the VUE file
with the maximum amount of space possible. To handle extremely large VUE files, in excess
of 1 or 2 GB, you may need at least two 4GB defragmented page files.

Display Performance
Error Message: Memory limits prevent showing highlight/selection of display set
This message displays in the status bar when there is not enough memory available to show a
highlighted or selected display set in the main view. The display set contains too many objects
to show highlighted or selected at this time.
Many SmartPlant Review settings affect display time. While there is no single combination of
options that works best for all data sets or user workflows, the following features can improve
display time, especially when working with large data sets. Use the View > Settings >
Advanced > Time Display option to evaluate the effects of using these options.
View Settings

Update Interrupt - The Esc key cancels the current screen update. Only
elements rendered so far will be displayed. This can be very useful if the full
update of the model is not needed for the current task.
Range Rejection - Increase the settings as needed and activate to
significantly improve display time for wireframe and/or shaded rendering by
eliminating elements that are too small to be of current interest.
Dot Box - Draws distant elements less precisely for improved update speed.
At a distance, these items will be represented by a small box of pixels
instead of a full rendering.
Two-sided lighting - Turn off this option to improve display time for all
models.
Stroking Tolerance - Reduce this setting to the lowest acceptable level
(minimally 4) to improve display time for models with objects having round
surfaces such as pipes, reducers, valves, and so on.
Perspective - Turn off this mode to improve display time for all models.

SmartPlant Review Citrix Installation Guide

23

Installing SmartPlant Review


Views

Plan and Elevation Views - Turn off these views whenever possible to
improve performance.
Overlapping Windows - Prevent the Main view from being overlapped by
any other window (including toolbars and the plan or elevation views) to
improve responsiveness.
Partial Recall - When recalling a saved view, either singularly or during Key
Frame animation, use the partial recall feature with the Level settings option
turned off. This significantly improves performance for datasets with large
numbers of files.

Motion Settings

Rates - Increase to improve motion speed through the model.


Display - Turn off the Allow all texturing, Update view cone, and Update
position status options, to improve performance.

Data Reduction

Ideally, each SmartPlant Review project should contain only the data of
interest for the review session. The less data to review, the faster
performance will be. The following features can improve display performance
for any project by hiding any graphic elements not currently of interest for the
task at hand:
Motion Clipping Plane - Motion display times can be improved by setting
and activating the motion far clipping plane to the required extent. Elements
are only clipped during motion through the model.
Clipping Planes - Display times can be improved by setting and activating
the near and far clipping view cone plane settings to the required extent.
Clipping Volumes - Display times can be improved by creating a clipping
volume to clip all data outside a particular volume.
Level Settings - Display times can be improved by turning off the levels of
objects not currently of interest.
Display Sets - Display times can be improved by creating display sets of
elements not currently of interest, and turning them off. Display sets can be
created in a wide variety of ways, using element file, level, color, volume,
and attribute data information.
Non-Model Data - Turn off the display and/or use of all annotations,
materials, measurements, lights, tags and/or textures whenever possible to
improve display times.

File System
Make sure the system is using the fastest file system. For Windows 2000 and Windows XP,
studies have shown that the NTFS file system with a 4K cluster size provides better
performance than a FAT or FAT32 file system.

Data Fragmentation

24

Hard Drives - Defragment your hard drives regularly. File fragmentation on the hard drive
slows down the system and SmartPlant Review.
System Page Files - Keep the system page files defragmented as well as the disk drives.
The page file is a system file and cannot be defragmented while the system is running. A
fragmented page file may be scattered all over a disk drive and will not perform efficiently. If
a page file becomes too fragmented, the system may not be able to open an extremely large
.VUE file.
Defragmenting the page file is typically a boot time operation separate from the real- time
disk drive defragmentation operation. Tools are available, such as Diskeeper, that will
defragment the page files.
Project and Label Databases - Use the DBCompact utility to compact and defragment your
Microsoft Jet databases. If the label or project files are updated for an existing project, the
software attempts to replace the label database records on a file by file basis. Deleting and
replacing large numbers of records in the label database might lead to significant database

SmartPlant Review Citrix Installation Guide

Installing SmartPlant Review

fragmentation, which can lead to poor performance. Compressing the database on exit will
remove this fragmentation. For more information, see SmartPlant Review Utilities.
However, if several design or label files have been changed because the current label
database was created, we recommend simply deleting the existing label database (MDB2)
and allowing the software to rebuild it from the current project data. If display sets exist in the
main project database (MDB), then rebuilding the label database also kicks off display set
resolution, which rebuilds the display sets based on the current label and project file
contents. Only the label database (MDB2 file) needs to be deleted. For example, one label
database took 7 hours to update by replacing records. This same data set was up in minutes
when the old database was deleted and SmartPlant Review was allowed to re-build a clean
database.

Database Format
SmartPlant Review creates Microsoft Access databases to store and manage your project data.
Because Access 2000 databases are much faster than Access 97 databases, use the Access
2000 format instead of the Access 97 format when creating your project databases. However,
Access 2000 is in Unicode, which makes the database file size larger than Access 97 because
the Unicode format doubles the size of text fields. The actual Access 2000 database size will
depend on the amount of text data in the database. Therefore, if you have the space and need
the speed, use the Access 2000 format. For more information about Microsoft Access and
project databases, see Understanding SmartPlant Review Projects.
Do not use Access 97 format if you are using multi-byte character data on a nonEnglish operating system and locale.

Page Timeout Registry Settings


Check the Microsoft Jet database Page Timeout registry settings, which can affect database
performance over the network. The Page Timeout value for the Microsoft Jet database 3.5 and
4.0 versions is set to 5000 milliseconds by default. Set this value to 5 milliseconds for best
performance, especially over a Novell network. Make sure that you find and set all values of the
Page Timeout setting in each Jet version registry entry.
Any changes to the registry are at your own risk.
\HKEY_LOCAL_MACHINE\Software\Microsoft\Jet\Engine\Jet\3.5\Engines\Jet
2.x\Page Timeout
\HKEY_LOCAL_MACHINE\Software\Microsoft\Jet\Engine\Jet\3.5\Engines\Jet
3.5\Page Timeout
\HKEY_LOCAL_MACHINE\Software\Microsoft\Jet\Engine\Jet\4.0\Engines\Jet
2.x\Page Timeout
\HKEY_LOCAL_MACHINE\Software\Microsoft\Jet\Engine\Jet\4.0\Engines\Jet
3.x\Page Timeout
\HKEY_LOCAL_MACHINE\Software\Microsoft\Jet\Engine\Jet\4.0\Engines\Jet
4.0\Page Timeout
The Jet Page Timeouts when running Windows 7 (64-bit) are at the following locations:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Jet\3.5\Engines\Jet
2.x
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Jet\3.5\Engines\Jet
3.5
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Jet\4.0\Engines\Jet
2.x
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Jet\4.0\Engines\Jet
3.x

SmartPlant Review Citrix Installation Guide

25

Installing SmartPlant Review


HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Jet\4.0\Engines\Jet
4.0

Photo-Realism Module
To get the most out of the Photo- Realism module, we recommend the following system
resources:
System memory - Additional memory is recommended to improve the performance of the
raytracer. Additional memory is particularly important on multi-processor systems and/or with
relatively large models. Some models are too large to raytrace in their entirety due to the
memory limitations of 32-bit operating systems (Windows 2000 and XP limit applications to 2GB
of addressable memory; Windows 2003 Server allows access to 3GB of memory). Creating
smaller subsets of the larger model should allow portions of the larger model to be raytraced.
Processors - The raytracer has an efficient multi-threaded implementation that can improve
raytrace performance when using multiple processors. When using multiple processors, the
amount of system memory should be considered on a per processor basis. The amount of
system memory, virtual memory and number of processors are likely the most influential factor
in raytrace performance.
Virtual memory - Additional virtual memory might be needed to supplement the system
memory for large models.
Lights - The typical number of lights supported by an OpenGL graphics card can vary from 8 to
24 or more and are dependent on the driver used. This will affect the display of lights using
OpenGL type rendering. Raytracing does not rely on the graphics card for lighting calculation
and will not be affected by the number of lights supported by it.
Textures - The amount of texture memory on the graphics card can affect OpenGL display
performance. A greater amount of texture memory can improve performance. The amount of
texture memory on the graphics card does not affect the performance of the raytracer.

The operating system shares resources (CPU, memory, disk, and so forth) equally among
all processes running on the system. For maximum performance, reduce the number of
processes and services while using SmartPlant Review. Processes and services that are
notorious for consuming vast amounts of resources are (but not limited to) virus scanners,
media players, disk organizers, and mail programs. You might consider dedicating a
machine for exclusive SmartPlant Review use with minimal auxiliary programs.
SmartPlant Review defaults to software rendering if your system does not support OpenGL
acceleration.

Set Number of Processors


Use the View > Advanced > Processors command to set the number of processors used for
normal rendering. Setting this value to a lower number (i.e. "1") limits the number of software
threads that will be created for normal rendering. Setting the number of processors to 1 before
or after opening a project can improve software stability on some systems, but can reduce
rendering performance.

Install SmartPlant Review


1. If you have not already installed and configured SmartPlant License Manager on your
workstation, we recommend doing so before installing SmartPlant Review.
SmartPlant Review requires the SmartPlant License Manager software for
concurrent licensing for both the core SmartPlant Review product and for each module. This

26

SmartPlant Review Citrix Installation Guide

Installing SmartPlant Review


licensing software is delivered on its own CD that comes with your SmartPlant Review
product. For more information about using and configuring concurrent licensing, see the
SmartPlant License Manager Installation and User's Guide (SPLMInstall_UserGuide.pdf).
2. Insert the SmartPlant Review product CD into the CD-ROM drive. If the installation does not
start automatically, double-click setup.exe in the main folder.
If you are using SmartPlant Enterprise, insert Disc 2 of your SmartPlant Enterprise
disk set.
3. Click Prerequisite Software and install the following:
Microsoft Data Access Components (MDAC)
.NET 4.0 Framework software.
MS VC++ 2010 SP1 Redistributable Package with MFC Security Update. This package is
required for the installation process to continue.
4. Click Installation for SmartPlant Review.
If the MS VC++ 2010 SP1 Redistributable Package with MFC Security Update is not
found on your system, you are prompted about the requirement. Click Yes to install this MS
package and continue, or click No to return to the start page.
5. Click Next.
6. Type your name, company name, and the base SmartPlant Review serial number.
The serial number is used for initial installation purposes only. A license key is
required to run SmartPlant Review.
7. Verify your name, company name, and serial number, then click Next.
8. Click Display to read and accept the license agreement, then click Yes.
You must have a PDF reader to view the license agreement.
9. Specify the destination folder, and then click Next.
If you install SmartPlant Review on two different partitions on a dual-boot computer,
you must install each copy of SmartPlant Review in a different folder for uninstall to work
properly.
10. From the Add-In Module Configuration page, enter the serial number for the SmartPlant
Review module to install, and then click Add. Repeat until you have added all of the
modules you purchased, and then click Next.
You cannot add or remove modules while running SmartPlant Review in
remote license mode.
11. Click Install.
SmartPlant Review displays the Completed the Intergraph SmartPlant Review Setup
Wizard page upon successful installation.
12. Click Finish.
13. Close the SmartPlant Review page.

Add Individual Modules After Installing the Core


Product
1. Double-click setup.exe on the product CD to restart the installation process.
2. Click SmartPlant Review Installation, and then click Next.

SmartPlant Review Citrix Installation Guide

27

Installing SmartPlant Review


3. Select Change.
4. On the Add-In Module Configuration dialog box, enter the serial number for the
SmartPlant Review module to install, and click Add. Repeat until you have added all of the
modules you purchased.
5. Review your settings, and click Next to install the modules.
6. Click Finish.

Install SmartPlant Review in Silent Mode


Silent mode installations can be performed using command-line arguments executed from a
command prompt, a batch file, or a third-party software deployment tool. Silent installations are
performed with no user interaction or with pre-filled values requiring minimal interaction. This
section provides the setup command and describes the available command-line arguments that
can be used to perform silent installations for SmartPlant Review using the provided setup
executable.
It is helpful if you are also familiar with the normal installation process. For more
information, see Install SmartPlant Review (on page 26).

Before you begin


Prior to creating a silent setup of SmartPlant Review, make sure that the following conditions
exist:
All prerequisites are loaded. For more information, see SmartPlant Review Workstation (on
page 21). The silent installations do not automatically check for prerequisites.
All previous versions of SmartPlant Review on the target machine have been uninstalled
prior to installation.
The target machine meets the free disk space recommendations.

Command-line install with all arguments


msiexec.exe /i "<path>\<msifilename>.msi" <SLAACCEPT=yes> USERNAME=<name>
COMPANYNAME=<company_name> SERIALNUMBER=<assigned_serial_number>
[MODSERNUM=<serialnumber(s)] [INSTALLDIR=<path>]
[/Lv*x<path_to_log_file>] /qn
If any names or paths contain one or more spaces, enclose the name in quotation marks.
For example:
USERNAME= "Pat Smith"
Required Arguments:

28

/i <Path>\<msi file
name>

Set up for installation.

SLAACCEPT=yes

Accepts the Software License Agreement


for all users on whose computers you are
installing the product.

USERNAME=<name>

Specifies the user name.

COMPANYNAME=<company
name>

Specifies your company name.

SERIALNUMBER=<assigned
_serial_number>

Specifies the serial number provided by


Intergraph for SmartPlant Review only.

SmartPlant Review Citrix Installation Guide

Installing SmartPlant Review


Modules are specified in optional
arguments described below.
Optional Arguments:
/qn

Runs the Windows Installer setup SPR.msi


in silent mode.

MODSERNUM=<serial_numb
er>

Comma delimited list of module serial


numbers. Do not put spaces between the
serial numbers.

INSTALLDIR=<path>

Specifies that the application installs to


another location other than the default
Windows application folder, To change the
location, enter a different path such as:
INSTALLDIR=D:\Review

/Lv*x
<path>\Logfilename

Creates a Windows Installer installation log


file. Enter an existing path for the log file
such as:
/Lv*x "C:\Installer Log
Files\InstallLog.log"
There are other configurable logging
options that can be entered. See the
Windows Installer help documentation for
more details.

Examples Using the Windows Installer


This section shows how to enter them calling the MSI from the Windows Installer.
You must use the /i argument when using the Windows Installer (msiexec.exe).
Example 1: Installation with Pre-Filled Values
msiexec.exe /i E:\SPR\SPR.msi SLAACCEPT=yes USERNAME="Pat Smith"
COMPANYNAME=Intergraph SERIALNUMBER=0123456789
This command-line example installs SmartPlant Review from E:\SPR, agrees to the license
agreement, and registers the software to Pat Smith at Intergraph with a serial number of
0123456789.
Example 2: Silent installation
msiexec.exe /i E:\SPR\SPR.msi SLAACCEPT=yes USERNAME="Pat Smith"
COMPANYNAME=Intergraph SERIALNUMBER=0123456789
MODSERNUM=1234567890,2345678901 /qn
This command-line uses the same parameters as described in Example 1, but also loads two
modules, and then installs without displaying any prompts or messages.
Example 3: Custom Folder and Log File Creation
msiexec.exe /i E:\SPR\SPR.msi SLAACCEPT=yes USERNAME="Pat Smith"
COMPANYNAME=Intergraph SERIALNUMBER=0123456789 INSTALLDIR="D:\Program
Files\SPR" /Lv*x C:\sprlog.txt /qn
This command-line uses the same parameters as in Example 2. It also performs a silent install
to the custom folder D:\Program Files\SPR, and creates the C:\sprlog.txt log file.

SmartPlant Review Citrix Installation Guide

29

SECTION 4

Configuring SmartPlant Review for Integration


To configure SmartPlant Review to work in an integrated environment, you must install the
Schema Component and the SmartPlant Client, which are delivered with SmartPlant
Foundation, on your SmartPlant Review workstation. For more information, see the Integration
Setup Guide. For more information about using SmartPlant Review in an integrated
environment, refer to the SmartPlant Review User's Guide.

SmartPlant Review Citrix Installation Guide

31

Installing SmartPlant Review

32

SmartPlant Review Citrix Installation Guide

SECTION 5

Configuring SmartPlant Review for Citrix


When SmartPlant Review is installed, you must perform the following operations to configure
SmartPlant Review for use with a Terminal Server or Citrix.
If you are not familiar with making modifications to the registry, or do not have
experience in working with registry settings, please contact your Intergraph customer support
representative before attempting to perform registry operations described in this section.

File Permission Adjustments for Label Selector


SmartPlant Review users will require file permission adjustments to use the Label Selector:
Select the file "SPRSP3DLabels.bin", and grant minimum permissions of Read and
Execute, and Write and Modify, to the AD Group that will need to change SP3D labels
using SmartPlant Review.

Citrix Presentation Server Feature Pack 1


Citrix Presentation Server Feature Pack 1 requires a registry entry. If SmartPlant Review is
launched without this entry, it will fail with the following message:
"The application failed to initialize properly (0xc0000005). Click on OK to terminate the
application"
To address this, make the following entry:
Windows, 32Bit Servers
[HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\CtxHook\AppInit_Dlls\Multiple
Monitor Hook]
"Flag"=dword:00000004
Windows, 64Bit Servers
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Citrix\CtxHook\AppInit_DLLs\Mu
ltiple Monitor Hook]
"Flag"=dword:00000004

This setting can be applied granularly by using and "exclude" entry for SmartPlant Review. See
Citrix KB# 110301.

Use Citrix in Seamless Mode


SmartPlant Review users working in Citrix may experience low responsiveness for some actions
when using Citrix in "Seamless" mode. There are registry keys that can be created to improve
seamless responsiveness for SmartPlant Review. Contact your support representative for more
information.

SmartPlant Review Citrix Installation Guide

33

Configuring SmartPlant Review for Citrix

34

SmartPlant Review Citrix Installation Guide

SECTION 6

Deploying SmartPlant Enterprise on


Citrix
To deploy SmartPlant Enterprise software on Citrix, the following high-level procedure must be
performed:
1. Set Up the Citrix License Server
2. Set Up the Citrix XenApp 6.5 Server (on page 35)
3. Publish Applications on the Application Delivery Server (on page 35)

Set Up the Citrix XenApp 6.5 Server


The Citrix XenApp server must be installed and configured after the License Server has been
set up.
Perform the following procedure on the XenApp server.
1. Install prerequisite software on the XenApp host computer.
Required software includes Application Server, Internet Information Server (IIS),
ASP.NET, and Terminal Services. Refer to the Citrix product documentation for detailed
requirements, including required versions of each component.
2. Run the installation wizard for Citrix XenApp and its components.
In addition to installing the main Citrix XenApp component, the installation wizard also
installs the set of additional components selected at the beginning of the wizard, to include .NET
3.5 Service Pack 1.

Publish Applications on the Application Delivery


Server
When installing applications on the application delivery server, you must perform the following
high-level procedure in order to ensure a successful implementation:
1. Run the installation for the application(s).
2. Publish the application using the Citrix AppCenter.

SmartPlant Review Citrix Installation Guide

35

Deploying SmartPlant Enterprise on Citrix

Install the Application on the Application Delivery Server

In a Citrix or Terminal Server environment the operating system has two user modes. The
normal execute mode and the installation mode. When installing applications in the
Installation mode changes that would be made in the Registry to HKEY_Current_User on a
single-user system are instead made to a shadow key for each user and files that would be
installed to a users home directory on a single-user system are saved to the
%SystemRoot% folder instead. The Installation mode of the Terminal Server operating
system allows you to install an application as if you were installing it on a single-user
operating system.
To toggle these commands on the server use the following syntax: change user /install
(places the server in multi-user mode before loading applications). Change user /execute
(places the server back into normal execute mode). To see what mode the server is
currently in use: change user /query command.
If you are going to install SmartPlant Review silently with a script under a Terminal Services
Server in Application Server mode, we recommend that you update the script to include a
Change User mode command to set the user mode to Install mode first, and then back to
Execute mode after the SmartPlant Review installation command. This ensures that
changes written to registry key HKEY_CURRENT_USER are properly redirected to their
corresponding HKEY_LOCAL_MACHINE registry after each user logs in into the
system. These steps are also recommended when applying hot fixes and service packs in a
silent install.
Most application installation programs are detected by the Terminal Server and the change
to installation mode is done automatically. If this occurs, an After Installation window is
displayed, with the instruction to click Next after the installation. When Next is clicked, the
mode is set back to Execute mode, so it should not be done until the installation has
finished.
1. In a command prompt window, type change user /install and press Enter.
You can confirm the current setting of the user mode by using the /query switch
(change user /query).
2. Install any prerequisite software required by the application.
3. Run the installation for the application to be installed.
4. When the installation is complete, in the command prompt window, type change user
/execute and press Enter.

Publish the Application on the Application Delivery Server


1. Launch the Citrix AppCenter.
If this is the first time Citrix AppCenter has been launched on this server, a wizard will
be launched to discover the server and load its properties into the console.
2. In the tree view, select Citrix Resources > XenApp > YourFarmName > Servers >
YourServerName.
3. Click the right mouse button on the server name and from the pop-up menu, select Other
Tasks > Publish application on the server.
4. Follow the prompts of the Publish Application wizard.

36

SmartPlant Review Citrix Installation Guide

SECTION 7

Additional Citrix Implementation Topics


The following topics contain additional configuration information related to publishing
applications on Citrix.

Adding Application Path Statements to the System


Path
Windows stores system path statements for individual executable files under the following
registry path (depending on the platform):
32-bit O/S: HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe
64-bit O/S: HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe
When a program registers an application path this way, Windows adds the path statement to the
search path whenever the application is run. This path information becomes part of the System
Search Path search order.
When applications are launched through Terminal Services (or Citrix), these path statements
are not automatically added. If an application requires this path, then the path information from
the appropriate AppPath registry key must be added to the path variable of the System
Environment.
Ensure that you back up the current value of the system path to a file for later
reference if there is an issue. Making a mistake during the modification of the system path
variable can render the computer unusable. It is essential to know the path contents prior to the
modification to bring the computer back with any real confidence if there is a problem.
1. In the Registry, copy the data of the Path value for the application executable:
32-bit O/S: HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe

SmartPlant Review Citrix Installation Guide

37

Additional Citrix Implementation Topics

2.
3.
4.
5.
6.

64-bit O/S: HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\App


Paths\App_name.exe

Display the System Properties window via the Control Panel.


Click the Advanced tab.
Click Environment Variables.
In the System variables list, select Path and click Edit.
Paste the value data from the Registry to the end of the Path string.

7. Click OK to dismiss all windows.

38

SmartPlant Review Citrix Installation Guide

Additional Citrix Implementation Topics

Publishing Complex Links or Shortcuts


Most Citrix applications can be published by inserting the contents of a desktop or start-menu
shortcut as the command line of the published applications Location properties. However
some applications use complex switches or command-line arguments that lose their meaning
when copied into the Location window of the Citrix Access Management Console. For this
situation, it is necessary to create a command line script (.CMD) that will supply the required
arguments and parameters to the application being launched.
This .CMD is the object that gets published. This does not compromise the functionality of the
application.
1. Copy the command-line string from the Target property of the shortcut.
2. Open Notepad (or any text editor) and paste the string into an empty file.
3. Edit the arguments and switches to replace any relative path notations (such as ..\ and .\)
with fully qualified paths.
If an argument with a path name includes a directory or file name with spaces,
enclose the argument in double quotes (for example, "C:\Program
Files\MyApp\Myapp.exe").
4. Save the file with a .cmd extension.
5. Publish the .CMD file as the application in Citrix. The file acts like a load script that will
launch the application with the required arguments as originally intended.

Configuring Dual Monitors


After logging into the Citrix portal via the Citrix Web Client, perform the following procedure.
1. Select the Preferences menu on the title bar.

SmartPlant Review Citrix Installation Guide

39

Additional Citrix Implementation Topics


2. In the Display area of Session Settings, select the screen resolution to use.

Citrix Client Time Zones


Please see the article How to Configure Time Zone Redirection in XenApp 6.x Using the
Windows Group Policy Management Editor (http://support.citrix.com/article/CTX126099). Citrix
relies on Microsoft APIs to establish time zone during an ICA session. Data is no longer written
to the user registry hive.

Disable the Citrix Virtual Memory Optimizer


A service named Virtual Memory Optimization (VMO) can inadvertently corrupt the .NET images
on the computer. When the application that relies on the image attempts to start, it cannot. It
terminates quickly with .NET errors reported to the event logs. The problem is transient because
the when the .NET optimizer service runs and the native images are processed and the
application works again. The application will work until the VMO kicks in again causing image
corruption.
To solve this problem, the Citrix Virtual Memory Optimizer (VMO) service needs to be set to
disabled. This is done as a FARM-WIDE policy in the Citrix AppCenter the .Net optimizer
should be set to Manual (which it is by default).
1. Stop the Citrix Virtual Memory Optimization service and set it to disabled.

40

SmartPlant Review Citrix Installation Guide

Additional Citrix Implementation Topics


Computer Management >Services and Applications > Services > Citrix Virtual
Memory Optimization > Disabled.

2. Disable the VMO service as a FARM-WIDE policy.


To repair the corrupt .NET images in place without removing and reinstalling software:
1. Complete the "Proactive" steps in the previous section: 1.) Stop the VMO service. And, 2.)
Disable the service as a FARM-WIDE Policy.
2. Open a command prompt to C:\windows\Microsoft.Net\framework64\ and run "ngen.exe
update" (Ignore any embedded errors many are expected. The process will take a few
minutes).
3. Open a command prompt to C:\windows\Microsoft.Net\framework\ and run "ngen.exe
update" (same-to-same)

SmartPlant Review Citrix Installation Guide

41

Additional Citrix Implementation Topics


This will fix .NET 3.5 and 3.0 and 1.1 images in addition to the 2.0 because the .NET
2.0 NGEN is the unified definition for all of these versions of .NET there is currently no
need to run NGEN for 3.0/3.5/1.1 just for 2.0. If 2.0 does not exist on the computer, then
the 3.0/3.5 NGEN(s) would work.

42

SmartPlant Review Citrix Installation Guide

Index
A

Add Individual Modules After Installing the


Core Product 27
Adding Application Path Statements to the
System Path 37
Additional Citrix Implementation Topics 37

Set Up the Citrix XenApp 6.5 Server 35


SmartPlant License Manager and Citrix 17
SmartPlant Review and Citrix 13
SmartPlant Review Workstation 21

C
Citrix Client Time Zones 40
Configuring Dual Monitors 39
Configuring SmartPlant Review for Citrix
33
Configuring SmartPlant Review for
Integration 31

W
What's New with SmartPlant Review Citrix
Installation 9

D
Deploying SmartPlant Enterprise on Citrix
35
Disable the Citrix Virtual Memory Optimizer
40

I
Install SmartPlant Review 26
Install SmartPlant Review in Silent Mode
28
Install the Application on the Application
Delivery Server 36
Installation of SmartPlant License Manager
15
Installing SmartPlant Review 21
Internationalization 9

M
Microsoft Windows Firewall and SmartPlant
License Manager 19

P
Performance Tips 22
Preface Citrix Guide 7
Publish Applications on the Application
Delivery Server 35
Publish the Application on the Application
Delivery Server 36
Publishing Complex Links or Shortcuts 39

SmartPlant Review Citrix Installation Guide

43

You might also like