Professional Documents
Culture Documents
Schem SPI IDEAL Client Installation Guide
Schem SPI IDEAL Client Installation Guide
IDEAL Client
Installation and Configuration Guide
Version 2013
March 2013
DSPI2-PE-200025B
Copyright
Copyright © 1995-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
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes
the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Contents
Intergraph IDEAL Client Installation .......................................................................................................... 5
Software Requirements .......................................................................................................................... 5
IDEAL Configurations ............................................................................................................................. 6
Registering Installed Files ....................................................................................................................... 7
Common Files .................................................................................................................................. 7
Local Installation Files ...................................................................................................................... 7
Network Client Installation Files ....................................................................................................... 7
Performing a Local IDEAL Installation .................................................................................................... 8
Perform a Local IDEAL Installation .................................................................................................. 8
Performing a Network Client IDEAL Installation ..................................................................................... 9
Perform a Network Client IDEAL Installation.................................................................................... 9
Accessing IDEAL from a Client Machine without API or SmartPlant
Instrumentation Installed .................................................................................................................. 9
Test IDEAL using the API Runner ........................................................................................................ 10
Software Requirements
The following requirements are specified for the correct running of IDEAL:
The Operating System on the computer where you are going to install IDEAL Client must be
Windows XP or later.
You must have Microsoft .NET Framework 4 installed on the computer where you are going
to install IDEAL Client.
You must have SmartPlant Instrumentation Server installed. For installation details, see
Install SmartPlant Instrumentation Server. For further information about possible
configurations, see IDEAL Configurations (on page 6).
To view instrument specifications, process data sheets, and other non-wiring reports, you
must display them in .pdf format, which requires that you install Adobe Reader on your client
machine. For details of the appropriate Adobe Reader version, see the SmartPlant
Instrumentation Installation and Upgrade Guide, Hardware and Software Recommendations
> SmartPlant Instrumentation Workstation, under 'Software Prerequisites'. To display
reports in other formats, you must install a suitable viewer application.
IDEAL Configurations
You can configure the software in one of the following modes:
Network installation — In this type of installation, the full set of IDEAL Client components is
installed on an application server. Each client machine can communicate with the application
server either by mapping its drive letter or by registering the IDEAL components on the client
machine.
Local IDEAL installation — Each client machine has a separate installation of the full set of
IDEAL Client components. The IDEAL client communicates with the server using a TCP
protocol. For a local IDEAL installation, you must have Windows XP or later as the client
operating system.
Common Files
Both local and network client installations include a mini Explorer installation as a component.
This installation includes the file Shdocvw.dll. This file needs to be on the client machine even
for a thin client installation, and should be located in a System folder, for example, System32.
The file Shdocvw.dll is a self-registering file that you need to register.
An additional installed file, Apitools.exe, can reside anywhere and does not require registration.
In a network client installation, this file resides on the application server.
Make sure that the name of the item that you type corresponds to an existing item name in
SmartPlant Instrumentation. If the value includes spaces, make sure you type the correct
number of spaces in the string. The characters that you type are not case-sensitive.
Do not use spaces when typing delimiters.
To retrieve a specific page of an Instrument Specification report, use the structure <tag
number>|<total number of sheets>|<specific sheet number>. If you do not know what the
total number of sheets is, you can type '0' (zero), and then type the required sheet number,
for example, 101-FT -100|0|3. If you want to retrieve a report for the first specification
sheet only, type the tag number without any other parameters in the Item box.
If you want to retrieve report for an item without specifying a child item, type the item name
only in the Item box.