0% found this document useful (0 votes)
162 views

SPR Install

SPR 2015
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
162 views

SPR Install

SPR 2015
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 42

SmartPlant Review

Installation Guide

Version 2015 R1

March 2015

DVIS2-PE-200002N
Copyright
Copyright © 1999 - 2015 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
305 Intergraph Way
Madison, AL 35758

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 Intergraph Smart Support,
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 Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s 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.

SmartPlant Review Installation Guide 2


Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S 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 Corporation’s 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, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
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 Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Portions of the user interface copyright 2012-2014 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, SupportModeler, and Sapphire 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 Installation Guide 3


Contents
Preface .......................................................................................................................................................... 6

Welcome to SmartPlant Review ................................................................................................................. 7


What's New in SmartPlant Review? ....................................................................................................... 8
Internationalization .................................................................................................................................. 9
Using SmartPlant Review Modules....................................................................................................... 11
API Module ..................................................................................................................................... 12
Construction Module ....................................................................................................................... 12
On-Site Drawing Generation Module ............................................................................................. 13
Photo-Realism Module ................................................................................................................... 14
Point Cloud Integrator Module ........................................................................................................ 15
Simulation and Visual Effects Module ............................................................................................ 15
SmartPlant Review Utilities ................................................................................................................... 16

SmartPlant Review Hardware and Software Recommendations.......................................................... 17


SmartPlant Review Workstation ........................................................................................................... 17
Performance Tips .................................................................................................................................. 19

Installing SmartPlant Review ................................................................................................................... 24


Installation Checklist ............................................................................................................................. 24
Install SmartPlant Review ..................................................................................................................... 24
Add Individual Modules After Installing the Core Product .................................................................... 25
Install SmartPlant Review in Silent Mode ............................................................................................. 26

SmartPlant License Manager Environment Variables ........................................................................... 29

Using the Select Modules Utility .............................................................................................................. 30


Select Modules Utility Dialog Box ......................................................................................................... 30
Select Licenses for Modules ................................................................................................................. 31

Using the SmartPlant License Checkout Utility ..................................................................................... 33


Install SmartPlant License Checkout Utility .......................................................................................... 33
License Checkout Utility Dialog Box ..................................................................................................... 34
Check Out a License for SmartPlant Review ........................................................................................ 35

Configuring SmartPlant Review for Integration ..................................................................................... 37

SmartPlant Review and Citrix .................................................................................................................. 38


Optimize SmartPlant Review with Citrix................................................................................................ 39
Adding Application Path Statements to the System Path ..................................................................... 40

SmartPlant Review Installation Guide 4


Contents

Index ........................................................................................................................................................... 42

SmartPlant Review Installation Guide 5


Preface
This document describes the requirements and steps for installing SmartPlant® Review.
Intergraph® gives you permission to print as many copies of this document that you need for
non-commercial use at your company. You cannot print this document for resale or redistribution
outside your company
We welcome comments or suggestions about this documentation. You can send us an email at:
[email protected].
Documentation updates for supported software versions are available from
https://smartsupport.intergraph.com.

SmartPlant Review Installation Guide 6


SECTION 1

Welcome to SmartPlant Review


Intergraph® SmartPlant Review is the complete Microsoft® Windows® visualization
environment for interactively reviewing large, complex 3D models for in-depth analysis of
process/power plants and marine structures. Providing a robust set of review-oriented tools for
the clear and concise communication of spatial design well beyond low-end viewer capabilities,
SmartPlant Review provides tools for visual analysis and simulation (dynamic walk-through),
tagging, and model queries, as well as an API for complete customization. Advanced features
include construction simulation, stereo viewing, and sophisticated image generation using
textures, reflection maps, and lighting. The familiar, easy-to-use Microsoft Windows interface
allows you to navigate through the three dimensional models with a joystick, mouse, or
keyboard control.
SmartPlant Review displays and manipulates three dimensional models and is specifically
designed to meet the process and power industry's requirements to dynamically visualize
computer-generated three dimensional plant models. With SmartPlant Review walk-through and
interrogation features, process plant models can now remain live throughout the life cycle of the
facility from conceptual design studies to de-commissioning.

SmartPlant Review Installation Guide 7


What's New in SmartPlant Review?
Version 2015 R1
 SmartPlant Review is a 64-bit client application.
 SmartPlant Review (64-bit) supports only 64-bit application programs to control SmartPlant
Review functions and no longer supports 32-bit programs. For more information, see the
SmartPlant Review Programming Help file (Draprix_api.chm).
 The 32-bit MoveDset.exe API program is no longer delivered.
 The 32-bit Visual Basic® samples are no longer delivered.
 The functionality and capabilities available in the Photo-Realism module have been
upgraded to provide a faster way to create photo-quality images of a 3D model. The
following new features and interface components have been added:
 The View > Photo-Realism > Renderer command replaces the View > Photorealism
> Raytrace command and opens a dynamic rendering window that raytraces your
model. As you make changes to the model in the Main view, the Renderer window
updates to reflect your changes. The Raytrace command has been removed from the
menu and the Photo-Realism toolbar. For more information, see Raytrace and Render
Model Objects.
 You can move and zoom in to a specific location or section of the model, or you can
select one or more individual objects in the Main view to render. This functionality
replaces the Raytrace Range command. The Raytrace Range command has been
removed from the menu and the Photo-Realism toolbar.
 An Environment Sphere option has been added to the Environment tab of the
Photo-Realism Settings dialog box. This sphere provides a distant 3D background to
the model. For more information, see Environment Tab.
 The Raytrace Image option has been added to the Snapshot dialog box to create an
image of the Renderer window. For more information, see Take a Snapshot of the
Renderer Window.
 The Renderer window can display Key Frame animations. You can record a Key Frame
animation displaying in the Renderer window and save it to an .avi file. You can also
step through a Key Frame animation and take a snapshot of each frame as it displays in
the Renderer window. For more information, see Record Settings and Raytrace and
Render Model Objects.
 The global solar lighting intensity range has been increased to produce a brighter
display in the Renderer window. The default setting is now .15. In previous versions of
SmartPlant Review, additional lights had to be placed to increase the brightness of the
model, which lowered display performance. With the increased lighting capability, you
do not have to use additional lights. When you open files saved in previous versions,
SmartPlant Review automatically adjusts the global lighting intensity setting so that your
objects display appropriately. For more information, see Solar Tab (Global Lighting
Dialog Box).
 Fog is not supported in this release.
 The SmartPlant Review sample files are delivered in the
[drive]:\ProgramData\Intergraph\SmartPlant\Review\Samples folder.

SmartPlant Review Installation Guide 8


Welcome to SmartPlant Review

 The Eye Point Motion and Display Set Motion classic commands are now available in the
Motion menu and the Animation toolbar. Use these commands to toggle between eye
point motion to change the view cone and enabling display set motion. By default, the Eye
Point Motion command is active. For more information, see Set Motion Control to Eye Point
and Set Motion Control for Display Sets.
 The SmartSketch package is no longer provided with the On-Site Drawing Generation
module.
 The Move Display Set (MOVEDSET.EXE) add-in has been removed from the Accessories
menu.
 Snaplock measurement performance and accuracy have been improved. You do not have
to set the stroking tolerance setting to 100 to achieve maximum accuracy.

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 (such as 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.

SmartPlant Review Installation Guide 9


Welcome to SmartPlant Review

 Create Oracle databases using AL32UTF8 for the database character set and AL16UTF16
for the NLS character set.
 Never modify the NLS_LANG registry entry on an Oracle client. Doing so causes the
character data not to convert to Unicode.
 Create Microsoft SQL Server databases with locale-specific collation settings and ensure
that all databases have the same setting.

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

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, choose the collation 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 is 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.

SmartPlant Review Installation Guide 10


Welcome to SmartPlant Review

If a Russian interface exists for the SmartPlant Enterprise application, then Russian users can
use the Russian interface while the English-speaking users continue to use the US/English
interface. English-speaking engineers can enter English characters. Russian-speaking
engineers can enter Russian characters.
However, because the Russian locale uses different decimal and character-set locales,
everyone (English and Russian engineers) must use the Russian decimal symbol which is a
comma. For customization purposes, databases can be modified to accommodate new
Russian-specific requirements (fields, properties, and so forth.) Using filters, display sets, and
other software features, bi-lingual projects can be further customized. Graphic data, reports, and
so forth can be created in either or both languages.
Do not change regional settings to reflect a U.S. environment in order to resolve
problems in a non-US/English homogeneous configuration. Doing this creates a heterogeneous
configuration that will cause other possibly hidden problems that cannot be corrected. Everyone
working on a project must use the same regional settings and character set throughout the life of
the project.

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 must 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 (http://support.intergraph.com/).

Using SmartPlant Review Modules


The following add-in modules further enhance the functionality found in SmartPlant Review.
API Module (on page 12)
Construction Module (on page 12)
On-Site Drawing Generation Module (on page 13)
Photo-Realism Module (on page 14)
Point Cloud Integrator Module (on page 15)
Simulation and Visual Effects Module
To see which modules are currently licensed on your computer, click the Modules list on
the Help > About SmartPlant Review dialog box.

SmartPlant Review Installation Guide 11


Welcome to SmartPlant Review

API Module
The Application Programming Interface (API) module includes programming libraries that allow
developers to create custom programs that run with SmartPlant Review. The API module is not
a requirement to run the custom programs, only to create custom programs for SmartPlant
Review.

Key Features:
 API Library - Provides two libraries, the original DRAPI C library function interface and a
newer ActiveX control interface, DRAPIX, that can be linked into your application programs
to control SmartPlant Review functions. These functions give your applications direct control
over the working of SmartPlant Review instead of just sending commands that you enter.
This gives your application more control and flexibility. Your Visual C® or Visual C++®
programs can use either interface. Your Visual Basic® programs can also be linked in a
similar fashion using the ActiveX control interface.
 Save VUE file - Creates a VUE file inside SmartPlant Review. This does not include the
ability to create VUE files in a batch mode.
 Snapshot - Creates an image file of the Main view, application window, or entire screen.
Snapshot can be used to create a high quality anti-aliased image of any resolution. This
module includes support for standard output types like BMP and JPG.
 Main View to VUE File - Exports all the graphics currently shown in the Main view to a new
VUE file. SmartPlant Review creates separate MDB and MDB2 files for the generated VUE
file. These databases contain only the information about the graphics present in the
exported VUE file. This enables you to quickly create a VUE file of a model showing specific
graphics. This command is not active if you have a ZVF or SVF project file open.

Construction Module
The Construction module extends the capabilities of SmartPlant Review with integrated project
scheduling and collision detection functionality. For project scheduling, ScheduleReview turns
data from your project planning software into a visual display of the construction or demolition
progress. Use ScheduleReview together with the collision detection functionality to plan safe
and timely equipment installation. Review collisions as equipment moves dynamically through
the plant. Hear sounds and see objects highlight as collisions occur.

Key features:
 ScheduleReview - Helps analyze and visualize the process by showing objects in the
context of the overall project schedule. You can display the project as it appears on a
specified day, or fly through the model and show the construction sequence. This
component also allows you to visualize the construction or demolition cycle in a single step -
by day, week, or month - or continuously. ScheduleReview supports the following popular
planning software: Microsoft® Project, Microsoft Project Professional, Primavera Project
Planner®, and Primavera Engineering & Construction. For more information, see
ScheduleReview Animations .
Before using SmartPlant Review ScheduleReview, you must first install the
Primavera SDK on your client computermachine and configure an SQL Server Connection
to the ODBC Name PrimaveraSDK or Primavera SDK. For more information, see the

SmartPlant Review Installation Guide 12


Welcome to SmartPlant Review

Primavera Administrator's Guide for your version. Only a single user at a time can access
this Primavera SDK database. To access the SDK, you must be added as a user with
Administrator access rights, or be assigned the global privilege, View All Global/Project
Data via SDK.
 Collision Detection - Includes static and dynamic collision detection. Colliding objects can
be highlighted in a customizable color. Users can play a sound file each time objects collide.
Collisions can be recorded as an object (or group) is driven through the model with precision
controls or moved freely with a mouse or joystick. Collision information is written to a log file
for review. Collision detection does not take into account non-model tolerances, such as
construction tolerances, or soft boundaries, such as pipe insulation. Collision detection runs
only in an interactive mode. Batch processes are not available. For these reasons, collision
detection does not replace the PDS clash reporting detection capabilities. See Using
Collision Detection.
 Snapshot - Creates an image file of the Main view, application window, or entire screen.
Snapshot can be used to create a high quality anti-aliased image of any resolution.
Snapshot includes support for standard output types like .BMP and .JPG. See Take a
Snapshot.
 Snapshot Animation - Creates high quality animation sequences. Snapshot can be used to
create high quality anti-aliased images of any resolution. The module includes support for
standard output types like BMP and JPG.
 Volume Annotations - Provides a very powerful planning and tracking tool. You can use
volume annotations to represent many types of objects and areas in the model, including
scaffolds, field welds, work areas, security areas, construction parking lots, and lay down
yards. Volume annotations allow you to place three basic types of geometry that SmartPlant
Review saves only in the project database. You can place boxes, cylinders, and spheres.
SmartPlant Review also provides several specialty types of volume annotations, including
scaffolds (boxes), welds (cylinders), and clipping volumes (boxes). See Placing Volume
Annotations.

On-Site Drawing Generation Module


The SmartPlant Review On-Site Drawing Generation module is a powerful, versatile product that
allows you to bring design and drawing capabilities from the office to your project site. This
module features fast, intelligent outline display capability - your drawing maintains intelligence
even when displayed in hidden-line mode. The module also improves communication, because
you control the way the drawing will appear to others. Additionally, by reducing the time required
to process and display outline removal from hours to a fraction of a second, the On-Site Drawing
Generation module saves time and money.
You can combine the On-Site Drawing Generation module with the Simulation and Visual
Effects module to create outline animations to improve the quality of your presentations.

Key features:
 Outline Mode - Provides capabilities of a display model to navigate the model by using the
joystick, mouse, or keypad.
 Labels - Assigns identifying phrases to objects in the outline view with tags, text annotation,
and measurements.

SmartPlant Review Installation Guide 13


Welcome to SmartPlant Review

 Snapshot - Creates an image file of the Main view, application window, or entire screen.
Snapshot can be used to create a high quality anti-aliased image of any resolution.
Snapshot includes support for standard output types like .BMP and .JPG.

Benefits of the On-Site Drawing Generation module:


 Saves time by eliminating the wait for the outline display to finish
 Improves communication by presenting your designs in a clear and understandable way as
you control the display of the objects in the view and their display method on the drawing
 Easy to use because casual users can navigate the three-dimensional model and quickly
produce an outline drawing that is ready for printing.

Photo-Realism Module
The SmartPlant Review Photo-Realism module provides features for creating realistic,
photo-quality images from a 3D model. A realistic image, rendered using textures, patterns,
bump maps, background images, environment boxes, and raytraced lighting, helps you to
visualize designs during each stage of the development process and to create powerful
presentations that communicate and sell your ideas to clients and managers.

Key features:
 Display Textures - Creates a more realistic display by assigning textures to materials and
then applying them to objects.
 Material Editor - Provides complete material editor functionality for creating new material
definitions and palettes.
 Lighting - Supports global (ambient, flashbulb, and solar), spot, distance, and point lights.
 Renderer window - Creates more realistic 3D effects by adding reflections and shadows to
images.
 High resolution - Captures the image at high resolution to produce near photo-quality plots
of the model.
 Snapshot - Creates an image file of the Main view, application window, or entire screen.
Snapshot can be used to create a high quality anti-aliased image of any resolution.
Snapshot includes support for standard output types like BMP and JPG.
 Stereo Viewing - Adds dramatic depth perception to models.
 Patterns Plus CD - Includes several pre-defined material definitions.
See Also
Performance Tips (on page 19)

SmartPlant Review Installation Guide 14


Welcome to SmartPlant Review

Point Cloud Integrator Module


The SmartPlant Review Point Cloud Integrator module offers vendor-neutral point cloud data
integration with the modeling software environment. This module provides an interface to
products like those offered by Leica Geosystems HDS and BitWyse Solutions, allowing you to
manage existing-condition data by enabling the display of lasergrammetry point cloud data
within SmartPlant Review.

Key features:
 Displays point cloud data when external software product is installed in conjunction with the
Point Cloud Integrator module.
 Supports normal SmartPlant Review navigation features, including walk-through.
 Provides surface measurement between the point cloud vector points and any graphic
object.
 Detects collisions between point cloud elements and a graphic element.
 Point clouds rendered in true color or laser intensity return color mapping.

Benefits:
 Integration of point cloud data within SmartPlant Review helps lower the time, effort, and
cost of process retrofit engineering and construction projects.
 Extends the use of 3D CAD to more projects.
 Helps in the planning of existing site remodeling by coupling existing configuration data
provided by point cloud scans with 3D model displays.

Simulation and Visual Effects Module


SmartPlant Review's Simulation and Visual Effects module brings life to your three dimensional
model by simulating the placement or removal of equipment, reviewing physical clearances,
performing motion studies, and developing complex motion scenarios. This module works with
the Construction module to visually simulate the construction process where you can review the
simulation on-screen or create animations for output to video.

Key features:
 Animation - Create animation paths - one or many - through your models by defining key
frames. Start with an aerial view of your facility, for example, and then dive into it, moving
along the animation path for an impressive flythrough. Save your animation at the resolution
and size that you need, and apply anti-aliasing to produce sharp, clear images. Import
animation frames into the non-linear digital video editor product VizFx Web Pro, provided
with this module.
 VizFx Web Pro - Create dynamic and original graphics, animation, and video with a
non-linear digital video editing product that includes a collection of high-end special effects.
Output file types include .AVI, .BMP, .GIF, .JPG, .PICT, .TGA, and .TIFF.

SmartPlant Review Installation Guide 15


Welcome to SmartPlant Review

 Snapshot - Used for creating an image file of the Main view, application window, or entire
screen. Can be used to create a high quality anti-aliased image of any resolution. Includes
support for standard output types like .BMP and .JPG.
 Snapshot Animation - Used to create high quality animation sequences. Snapshot is
compatible with the Construction module for SmartPlant Review to record the simulation of
the construction process. Snapshot can be used to create high quality anti-aliased images of
any resolution. The module includes support for standard output types like .BMP and .JPG.
You can use ViZfx Web Pro to apply sophisticated special effects to your animations,
special web projects, or video. You can download ViZfx Web Pro with your SmartPlant Review
serial number from http://www.intergraph.com/visualization/vizfx.asp.
See Also
Construction Module (on page 12)

SmartPlant Review Utilities


SmartPlant Review delivers the following utilities to help you manage your data. Each utility is
delivered separate folders under the \SmartPlant\Review\Utilities folder.
DBCompact (DBCompact.exe) - Compacts and defragments your Microsoft Jet 4.0 databases.
For more information, see the ReadMe.txt file in the \SmartPlant\Review\Utilities\DBCompact
folder.
ImageView (ImgView.exe) - Provides image viewing and printing support for Intergraph RGB file
formats and other image file formats. Slide show capability is provided for viewing multiple
images.
Tag Merge (TagMerge.exe) - Allows you to merge multiple tag files into a single tag file, which
enables you to identify duplicate tags and handle the resolution of these duplicates in a variety
of ways. For more information, see the ReadMe.txt file in the
\SmartPlant\Review\Utilities\TagMerge folder.
SP3DLabelSelector (SP3dLabelSelector.exe) - Generates a new SPRSP3DLabels.bin
template file to match the SmartPlant schema with the labels to be generated into the .MDB2
label file from published SmartPlant 3D XML label data. For more information, see Use the
SmartPlant 3D Label Selector Utility.
UoM Converter - Reads and displays information from the P3DComponent.xml.file so that you
can edit the units of measurement. Once you set the new units of measurement, the UoM
Converter utility generates the UoMConversions.xml file, which is read by SmartPlant Review
the next time the project file is opened and a new label database (MDB2) file is generated. Your
changes are reflected in the SmartPlant Review Text window or the Properties dialog box when
you select graphic elements using the updated units of measure. For more information, see
Using the UoM Converter to Change the Units of Measure for Labels
Select Modules (SelectModules.exe) - Allows you to select which modules you want to pull
licenses for when starting a SmartPlant Review session. For more information, see Using the
Select Modules Utility (on page 30).
SmartPlant License Checkout (License Checkout Utility.exe) - Allows you to obtain licenses
for SmartPlant products and its modules for use on a non-networked computer (laptop). Using
this utility allows you to run SmartPlant products without a network connection to the license
server. For more information, see Using the SmartPlant License Checkout Utility (on page 33).

SmartPlant Review Installation Guide 16


SECTION 2

SmartPlant Review Hardware and


Software Recommendations
SmartPlant Review is a state-of-the-art graphics application, capable of displaying and
manipulating very complex 3D models. As such, this technology requires comparable
state-of-the-art hardware to ensure a successful, productive, and efficient experience.
Before beginning the installation, verify that your end-user workstation computers meet the
following hardware recommendations and software requirements.

SmartPlant Review Workstation


Hardware Recommendations
 Intel Core i7 Processor or equivalent
 8 GB RAM
 DVD drive access, either locally or through a network connection
 Monitor capable of a minimum of 1024 x 768 Resolution
 A workstation class graphics card designed for 3D intensive, OpenGL-based, 3D-CAD
applications
 (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/Datacenter Server 2012 (R2) (64-bit)
 Microsoft Windows 7 Professional and Enterprise Client (64-bit)
 Microsoft Windows 8.1 Professional and Enterprise Client (64-bit)

Software Prerequisites
 Microsoft Access Database Engine (64-bit)
OR Microsoft Office 2010 (64-bit)
 Microsoft Visual C++ 2010 SP1 Redistributable Package with MFC Security Update
 Microsoft Internet Explorer 10.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)

SmartPlant Review Installation Guide 17


SmartPlant Review Hardware and Software Recommendations

 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 9.0 (required for using a joystick with SmartPlant Review)
 Microsoft .NET Framework 4.5.1 (installed automatically during SmartPlant Review setup)
 SmartPlant License Manager 2010 (v11)
 SmartPlant License Checkout Utility (required to run in remote license mode.)

Software Compatibility
 SmartPlant Checkout Utility 11.x
Although you can also have an older version of the Checkout Utility installed on
your system, you must use the latest version with SmartPlant Review. If you attempt to use
an older Checkout Utility version with the current version of SmartPlant Review, the utility
does not detect SmartPlant Review and does not provide options for license checkout.
 Citrix XenApp 6.5 and Citrix XenDesktop 7.0
 SmartPlant Foundation 2009 or later
 SmartPlant 3D or SmartMarine 3D 2009 or later and Intergraph Smart™ 3D 2014
 Microsoft Project (64-bit)
 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.

SmartPlant Review Installation Guide 18


SmartPlant Review Hardware and Software Recommendations

Performance Tips

Video Cards
The results of a survey of graphics cards used with SmartPlant Review are available on the
Intergraph Smart Support site. To view these results:
1. Go to https://smartsupport.intergraph.com.
2. Type your Intergraph Smart Support user name and password.
3. Click View Downloads > SmartPlant Review > Technical Notes & Whitepapers >
SmartPlant Review > Graphics Cards used with SmartPlant Review.
When considering a video card, select a video card designed for OpenGL-based, 3D-intensive
scientific or engineering applications. Many 3D-intensive game cards are not suitable for
engineering purposes.
In addition to the video card, the device driver is also crucial to performance. We advise trying
various card and driver combinations prior to committing to a particular card vender.
After configuring your computer, be very careful about installing operating system updates or
gaming software, because doing so can dramatically affect performance. Also, make sure you
can return your machine configuration to a previous state.
For laptop computers with built-in graphics, sometimes the graphics chip manufacturer has a
better driver available than the one installed by the laptop manufacturer. However, because the
use of a non-laptop manufacturer driver might void your warranty, be sure to check with both the
graphics chip supplier and the laptop manufacturer before using a non- laptop manufacturer
driver.
You can also try turning off Vertex Buffer Objects (VBOs) for the first time you open the VUE file.
The VBOs are created when SmartPlant Review loads the file. However, VBOs should be
turned back on after the initial opening.
SmartPlant Review defaults to software rendering if your system does not support
OpenGL acceleration.

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.

SmartPlant Review Installation Guide 19


SmartPlant Review Hardware and Software Recommendations

 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.
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.

SmartPlant Review Installation Guide 20


SmartPlant Review Hardware and Software Recommendations

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.

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. For example,
you can change the Maximum moves per second rate from 30 to 100 in
the Motion > Settings > Rates dialog box.
Display - Turn off the Allow all texturing, Update view cone, and Update
position status options, to improve performance.

SmartPlant Review Installation Guide 21


SmartPlant Review Hardware and Software Recommendations

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.

Data Fragmentation
 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
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

SmartPlant Review Installation Guide 22


SmartPlant Review Hardware and Software Recommendations

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 (64-bit) databases to store and manage your
project data.

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. 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.

SmartPlant Review Installation Guide 23


SECTION 3

Installing SmartPlant Review


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

Installation Checklist
For the recommended installation workflow, please see the installation checklist
(SPRInstall_Checklist.pdf), available in the Help folder on the Product CD.
This checklist, also available in Microsoft Excel format (SPRInstall_Checklist.xls), is delivered
during product set up to the \Program Files\SmartPlant\Review\resdlls\0009 folder for future
reference.

Install SmartPlant Review


The following steps apply to every release type of SmartPlant Review: full product, hot fix, and
service pack installations.
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
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. Uninstall any previous version of SmartPlant Review.
3. 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.
4. Click Prerequisite Software and install the following:
 Microsoft Data Access Components (MDAC)
 .NET 4.5.1 Framework software.
 MS VC++ 2010 SP1 Redistributable Package with MFC Security Update. This package
is required for the installation process to continue.
If you are installing on a laptop computer and plan to run SmartPlant Review in remote
mode, be sure to also install the SmartPlant License Checkout Utility. For more information,
see Install SmartPlant License Checkout Utility (on page 33).
5. Click Installation for SmartPlant Review.
If the MS VC++ 2010 SP1 Redistributable Package with MFC Security Update is not found

SmartPlant Review Installation Guide 24


Installing SmartPlant Review

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.
6. Click Next.
7. 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.
8. Verify your name, company name, and serial number, then click Next.
9. Click Display to read and accept the license agreement, then click Yes. You must have a
PDF reader to view the license agreement.
10. 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.
11. 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.
12. Click Install.
SmartPlant Review displays the Completed the Intergraph SmartPlant Review Setup
Wizard page upon successful installation.
13. Click Finish.
14. 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.
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.

SmartPlant Review Installation Guide 25


Installing SmartPlant Review

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 24).

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 17). 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:

/i <Path>\<msi file Set up for installation.


name>

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 Specifies your company name.


name>

SERIALNUMBER=<assigned Specifies the serial number provided by


_serial_number> Intergraph for SmartPlant Review only.
Modules are specified in optional

SmartPlant Review Installation Guide 26


Installing SmartPlant Review

arguments described below.

Optional Arguments:

/qn Runs the Windows Installer setup SPR.msi


in silent mode.

MODSERNUM=<serial_numb Comma delimited list of module serial


er> 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 Creates a Windows Installer installation log


<path>\Logfilename 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

SmartPlant Review Installation Guide 27


Installing SmartPlant Review

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 Installation Guide 28


SECTION 4

SmartPlant License Manager


Environment Variables
If you are using SmartPlant License Manager 2010, SmartPlant License Manager 2012, or a
later version, an administrator can create environment variables to customize license tracking.
These variables match the columns in the SmartPlant License Manager logging file (or journal
report). The variable name must exactly match the column name.
The environment variables can be added and changed using automated scripts, custom product
launching utilities, or manually (as shown in the below example). The environment variables can
be defined at the system level or user level. If the environment variable(s) is added at both the
system and user levels, the user level will take precedence over variable(s) added at the System
level.
Any of the following variables can be defined as needed.
ProjectName - Defines the project name. There is a maximum of 50 characters.
NodeName - Defines the node name. There is a maximum of 30 characters.
UserNameEx - Defines the user name. There is a maximum of 50 characters.
Please contact your support representative if you need assistance.
The following steps are an example of how to manually add new environment variables.
1. Open Control Panel.
2. Click System
3. Click Advanced system settings.
4. Click Environment Variables....
5. Click New... under User Variables.
6. Define the new variable name and value.

7. Click OK to add the variable.

SmartPlant Review Installation Guide 29


SECTION 5

Using the Select Modules Utility


The SmartPlant Review Select Modules utility (SelectModules.exe) allows you to select which
modules you want to pull licenses for when starting a SmartPlant Review session. Installed by
default to C:\Program Files\SmartPlant\Review\Utilities\SelectModules, this utility is available on
the Start menu under Programs > Intergraph SmartPlant Review > Select Modules.
By default, SmartPlant Review attempts to obtain licenses for each module installed when you
start the product. However, if there are not enough module licenses available to cover the
number of modules installed, the SmartPlant Review session closes. In this case, we
recommend that you use the Select Modules utility to unselect the modules for which you cannot
obtain licenses. Doing so allows you to run SmartPlant Review with only those modules for
which you can obtain licenses. You can also ask a co-worker to exit SmartPlant Review, which
returns in-use licenses to the server, or you can purchase more licenses.

Example
If your site has four licenses of SmartPlant Review but only three module licenses for the
Construction module and three of the SmartPlant Review sessions are currently using all three
Construction module licenses, the fourth SmartPlant Review session will not run unless you use
the Select Modules utility to de-select the Construction module before starting SmartPlant
Review.

Select Modules Utility Dialog Box


Specifies which modules you want to pull licenses for when starting a SmartPlant Review
session.

Modules - Displays the modules available with SmartPlant Review. A grayed-out entry means
that module is not installed on your workstation. Check the box beside the module you want

SmartPlant Review Installation Guide 30


Using the Select Modules Utility

SmartPlant Review to pull a license for during startup. Licenses are not pulled for modules that
are not checked. By default, all installed modules are checked.

 If you are running SmartPlant Review in remote license mode (that is, you used the
SmartPlant License Checkout utility to obtain licenses) and open the Select Modules utility,
all modules appear inactive, with checks beside the modules with currently checked out
licenses. These selections cannot be changed until the checkout duration expires, nor can
licenses be obtained interactively while licenses are checked out. Checked out licenses
cannot be checked in.
 If SmartPlant Review cannot obtain enough licenses at start up, a "not enough licenses
available" message is displayed and SmartPlant Review shuts down. Before SmartPlant
Review will run, you must free enough currently in-use licenses to cover the modules you
want to run or you must use the Select Modules utility to unselect the modules for which you
cannot currently obtain a license.
 After SmartPlant Review obtains the necessary licenses and is ready for use, the Help >
About SmartPlant Review dialog box displays the modules for which licenses were
obtained.

Select Licenses for Modules


1. Click Start > Programs > Intergraph SmartPlant Review > Select Modules.
2. Check the modules for which you want to pull licenses.
3. Click OK.
4. Click Start > Programs > Intergraph SmartPlant Review > SmartPlant Review.
5. Click Help > About SmartPlant Review to view a list of the modules for which SmartPlant
Review was able to obtain licenses.

 By default, the first time you start SmartPlant Review, it attempts to pull licenses for itself
and for each module you have installed, unless you first use the Select Modules utility to
select the modules for which you want to pull licenses.
 If you are running SmartPlant Review in remote license mode (that is, you used the
SmartPlant License Checkout utility to obtain licenses) and open the Select Modules utility,
all modules appear disabled, with checks beside the modules with currently checked out
licenses. These selections cannot be changed until the checkout duration expires, nor can
licenses be obtained interactively while licenses are checked out. Checked out licenses
cannot be checked in.
 Pulled licenses are returned to the license server when you close SmartPlant Review.
SmartPlant Review displays a message if it cannot return a license for any reason (for
example, the network connection to the license server is down). Licenses that cannot be
returned must be scavenged on the SmartPlant License Manager server. For more
information about scavenging licenses, see the SmartPlant License Manager Installation
and User's Guide (SPLMInstall_UserGuide.pdf).
 If SmartPlant Review cannot obtain enough licenses at start up, the software displays a "not
enough licenses available" message and SmartPlant Review shuts down. Before
SmartPlant Review will run, you must either free enough currently in-use licenses to cover

SmartPlant Review Installation Guide 31


Using the Select Modules Utility

the modules you want to run, or use the Select Modules utility to unselect the modules for
which you cannot currently obtain a license. To see who is currently using licenses, use
SmartPlant License Manager on the license server.

SmartPlant Review Installation Guide 32


SECTION 6

Using the SmartPlant License Checkout


Utility
The SmartPlant License Checkout utility (License Checkout Utility.exe) allows you to obtain
licenses for SmartPlant products for use on a non-networked computer (for example, a remote
laptop). Using this utility allows you to run SmartPlant products without a network connection to
the license machine. Each user on a server can check out a license on that machine. When you
check out a license, the license and expiration information are stored for use by the application.
Your Intergraph application determines the license information location and whether the
checkout operation applies to all users or a single user on the same system.
Each time you start the product during the checkout period, a message displays the expiration
date for the checked out license. When the checkout period for the license expires, the
application attempts to request a license using SmartPlant License Manager the next time you
start the product. For example, after the license expires at 11:59 PM on the expiration date, the
next time you start the product, it attempts to access the SmartPlant License Manager license
machine for base and module licenses prior to running.

 For information on products supported by the SmartPlant License Checkout Utility, see the
Intergraph PPM Compatibility Matrix - Product Report at Intergraph Smart Support:
https://smartsupport.intergraph.com (https://smartsupport.intergraph.com).
 You must install and configure SmartPlant License Manager before checking out a license.
 You must have administrator privileges to setup and install the utility.

Install SmartPlant License Checkout Utility


Do not uninstall the version of the SmartPlant License Checkout Utility that is
currently on your system if you (a) are installing a new product that includes the latest version of
the SmartPlant License Checkout Utility, or (b) have other Intergraph applications loaded on
your machine. You can have both versions of the Checkout Utility installed on your system. The
older version of the SmartPlant License Checkout Utility is required to work with your
currently-loaded applications. Refer to the compatibility matrix chart on ecustomer for
information on application versions and their required version of the SmartPlant License
Checkout Utility.
The SmartPlant License Checkout Utility version that is supported by your purchased Intergraph
product is included in the product delivery.

SmartPlant Review Installation Guide 33


Using the SmartPlant License Checkout Utility

Install the Utility


1. Insert the product CD or DVD. If the installation does not start automatically, double-click
setup.exe in the main folder.

 The required version of the SmartPlant License Checkout Utility is included with each
supported product installation and setup.
 For ICAS products, locate the SmartPlant License Checkout Utility installation program
in the Other Installs folder of the product DVD.
2. Click SmartPlant License Checkout Utility Installation, and from the Welcome screen
click Next.
3. Type your name and the organization or company name, and then click Next.
4. Click Display to read and accept the license agreement, and then click Yes.
You must have a PDF reader to view the license agreement.
5. Specify the destination folder, and then click Next.
6. Click Install to start the installation process.
7. Click Finish.

 You can uninstall the License Checkout utility at any time, even if you are currently running
a product in remote license mode.
 If you installed the latest version of the SmartPlant License Checkout Utility, it is installed
along with the older version. Both versions display from the Start menu as shown in the
following example:

License Checkout Utility Dialog Box


Specifies the product for which you want to check out a license.
Application Group - Displays the installed products available for license checkout. Select the
product for which you want to check out licenses.
If the Application Group list is empty, your application requires an older version of the
checkout utility. Please check your original product installation media for the compatible version
of the utility.
Available Modules - Displays any modules or add-ins available with your product. If no
modules appear in the list, either your product contains no supported modules, or no modules
have been installed. Check the box beside the module for which you want to check out a
license, and then click Check Out. If you want to check out only the base product, do not check
any of the modules.
License Expiration - Specifies the date that you want the checkout to expire. When the
checkout period for the license expires, the product returns to normal and connected license
operation using the SmartPlant License Manager the next time you start the product.

SmartPlant Review Installation Guide 34


Using the SmartPlant License Checkout Utility

Check Out a License for SmartPlant Review


1. Make sure SmartPlant License Manager (SPLM) is set up on your computer.
2. Click Start > Programs > Intergraph SmartPlant License Checkout Utility > License
Checkout Utility.
License Checkout Utility Dialog Box (on page 34)
3. In the Application Group list, select your product.
4. In the Available Modules list, select the module to use.
5. If required, select an expiration from the License Expiration list, and then click Check Out.
The minimum length of time you can have a license checked out is for approximately 24 hours.
You can cut this time down to approximately 12 hours if you check out the license just before
mid-day. For product-specific check out information, refer to the installation guide provided with
your product. To check out only the base SmartPlant Review product, do not check any of the
modules.

 This version of SmartPlant Review requires the most current version of the SmartPlant
License Checkout Utility. Although you can have an older version of the Checkout Utility
installed on your system, you must load and run the latest version with SmartPlant Review.
If you attempt to use an older Checkout Utility version with the current version of SmartPlant
Review, the utility does not detect SmartPlant Review and does not provide options for
license checkout.
 Checked out licenses cannot be checked in. If you check out three modules (four total
licenses: one base and three modules), then attempt to run the License Checkout utility
again and select two other modules, the software displays a dialog box telling you that a
license is already checked out for SmartPlant Review and displaying the expiration date for
that license.
When running in remote license mode, you cannot use setup to modify the product
installation until the following conditions are met:
 The checkout duration expires.
 The system is working with SmartPlant License Manager in connected license mode
once again.
In other words, you cannot install or remove modules while running in remote license mode.
 If SmartPlant Review is running in remote license mode but is unable to confirm for any
reason that it is running in that mode, SmartPlant Review automatically returns to connected
license mode and attempts to obtain the licenses from SmartPlant License Manager.
SmartPlant Review notifies you if it is unable to obtain licenses from SmartPlant License
Manager.

SmartPlant Review Installation Guide 35


Using the SmartPlant License Checkout Utility

Each time you start SmartPlant Review while using remote license mode, the software displays
a message informing you when the checked out licenses expire. The first time that you run
SmartPlant Review after the checked out licenses expire, the software displays a message
informing you that the checked out licenses have expired and that the software is reverting to
the standard connected license mode and attempting to get licenses from SmartPlant License
Manager.

SmartPlant Review Installation Guide 36


SECTION 7

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 Installation Guide 37


APPENDIX A

SmartPlant Review and Citrix

Performance Issues
A Citrix 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 17).
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 or use the Control Panel.
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 Installation Guide 38


SmartPlant Review and Citrix

Optimize SmartPlant Review with Citrix


After installing SmartPlant Review on a XenDesktop server, you must edit the
SPRDisplaySettings.ini file delivered with SmartPlant Review based on your video hardware.
You can use any standard text editor.

NVidia K2 Grid Card


Follow the steps below to edit the contents of the [ViewSettings] section if you are using an
NVidia K2 Grid card for graphics acceleration.
Before you begin, we recommend that you make a backup copy of the
SPRDisplaySettings.ini delivered with SmartPlant Review.
1. Locate and open SPRDisplaySettings.ini.
2. Under [ViewSettings], replace:
VBOMemoryPercent=100
with
VBOMemoryPercent=10000
3. Add the line:
MaxTessellatorCount=1
4. Save the file.

Server CPU
Perform the following steps if you are using the Citrix CPU server for video rendering.
1. Locate and open SPRDisplaySettings.ini.
2. Under [ViewSettings], add the line:
MaxTessellatorCount=2
3. Save the file.

SmartPlant Review Installation Guide 39


SmartPlant Review and 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
 64-bit O/S: HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\App
Paths\App_name.exe

2. Display the System Properties window via the Control Panel.


3. Click the Advanced tab.
4. Click Environment Variables.

SmartPlant Review Installation Guide 40


SmartPlant Review and Citrix

5. In the System variables list, select Path and click Edit.


6. Paste the value data from the Registry to the end of the Path string.

7. Click OK to dismiss all windows.

SmartPlant Review Installation Guide 41


Index
SmartPlant Review and Citrix • 38
A SmartPlant Review Hardware and Software
Recommendations • 17
Add Individual Modules After Installing the SmartPlant Review Utilities • 16
Core Product • 25 SmartPlant Review Workstation • 17
Adding Application Path Statements to the
System Path • 40
API Module • 12 U
Using SmartPlant Review Modules • 11
C Using the Select Modules Utility • 30
Using the SmartPlant License Checkout
Check Out a License for SmartPlant Review Utility • 33
• 35
Configuring SmartPlant Review for
Integration • 37 W
Construction Module • 12 Welcome to SmartPlant Review • 7
What's New in SmartPlant Review? • 8
I
Install SmartPlant License Checkout Utility •
33
Install SmartPlant Review • 24
Install SmartPlant Review in Silent Mode •
26
Installation Checklist • 24
Installing SmartPlant Review • 24
Internationalization • 9

L
License Checkout Utility Dialog Box • 34

O
On-Site Drawing Generation Module • 13
Optimize SmartPlant Review with Citrix • 39

P
Performance Tips • 19
Photo-Realism Module • 14
Point Cloud Integrator Module • 15
Preface • 6

S
Select Licenses for Modules • 31
Select Modules Utility Dialog Box • 30
Simulation and Visual Effects Module • 15
SmartPlant License Manager Environment
Variables • 29

SmartPlant Review Installation Guide 42

You might also like