SPI 2018 IDEAL Client Instalation Guide

18/7/22, 08:26 Hexagon PPM Documentation PDF Export
Intergraph Smart Instrumentation IDEAL

Client Installation Guide
Hexagon PPM Documentation Web Site
Generated 07/18/2022
https://docs.hexagonppm.com/internal/api/webapp/print/1e5c719a-90ec-4de8-8dd2-65576b197e82 1/12
Intergraph IDEAL Client Installation

The Interface to Distributed Environment Application Layer (IDEAL) is a set of components
that are used to generate reports containing Smart Instrumentation data. IDEAL enables you
to retrieve data and display it in a Web browser in a format appropriate for the report type,
such as .pdf or native formats.
This section covers and describes the system requirements and installation procedures for
IDEAL components.
The core of the IDEAL software is the Apitools.exe application, whose function is to pass
commands from the user application to Smart Instrumentation Server using IIS Server.
Customer Support
Hexagon PPM Policy Against Software Piracy
Copyright © 1995-2019 Hexagon AB <http://hexagonppm.com> and/or its subsidiaries and affiliates
Version 2018 (12.00)
Published 6/4/2019 at 02:42
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 7 or Windows 10.
You must have Microsoft .NET Framework 4.6 installed on the computer where you are
going to install IDEAL Client.
You must have Smart Instrumentation Server installed. For installation details, see
Install Smart Instrumentation Server in the Smart Instrumentation Server Installation
Guide. For further information about possible configurations, see IDEAL Configurations.
To view instrument specifications, process data sheets, and other non-wiring reports,
you must display them in .pdf format, which requires that you install a PDF reader on
your client machine. To display reports in other formats, you must install a suitable
viewer application.
IDEAL Configurations
The software is configured as follows:
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 7 or Windows 10 as the client operating system.
Registering Installed Files

File registration is necessary only if you perform a batch installation of
Intergraph IDEAL on multiple clients. If you intend to install IDEAL using the standard
installation setup, skip this section and follow the appropriate installation procedure for a local
installation. For details, see, Performing a Local IDEAL Installation
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.
Local Installation Files

The local installation includes a RAD Viewer installation as a component. This installation
includes the following self-registering files:
Objsafe.tlb
ESLViewer.ocx
RADView.ocx
These files are located in the program folder and you need to register them on the local
machine.
Performing a Local IDEAL Installation

The following is a complete step-by-step procedure that describes how to install a new
Intergraph IDEAL version on a client machine.
Perform a Local IDEAL Installation

1. Insert the product media into the CD-ROM or DVD drive. If the installation does not start
automatically, double-click the setup.exe file in the main folder.
2. Click Additional Software, and then click IDEAL Installation.
3. Click Start Setup.
4. On the Details and Features page, do the following:
a. Type a user name in the User Name field.
b. Type your companies name in the Company field.
c. Type the IDEAL serial number in the Serial Field.
d. Check the Install Path is correct.
Click to browse to a different location.
The amount of disk space required and available for the installation is displayed
below the installation path.
a. Click Next.
5. On the License Agreement page, do the following:
a. Select your country or region from the Country or Region select list.
b. Read the software license agreement.
c. Select the I agree check box
d. Click Install.
6. Click Finish.
Select the Readme check box, to view the readme file. The file opens after
clicking Finish.
Accessing IDEAL from a Client Machine without API or

Smart Instrumentation Installed
It is possible to communicate with and retrieve information from the IDEAL client, from a
machine that does not have an installation of Smart Instrumentation or IDEAL installed.
To do this you must have done the following:
1. Installed Smart Instrumentation Server and IDEAL Client on a server machine and
checked that the configuration is correct.
2. That the IDEAL folder and the TEMP folder are shared with the client machine.
3. In a system folder on the client machine, you have installed and registered Microsoft
Service Pack 6 for Visual Basic 6.0: Run-Time Redistribution Pack (vbrun60sp6.exe)
<http://www.microsoft.com/downloads/en/details.aspx?FamilyId=7B9BA261-7A9C-
43E7-9117-F673077FFB3C&displaylang=en> .
4. Microsoft's .Net Framework is also installed on the client machine.
5. That your user account has defined, access to %temp% folder.
Once you have checked that the above conditions have been met, you can connect to the
IDEAL client by doing the following:
From the Run menu, type the path to the APITools.exe, for example: \\Server
Name\IDEAL\APITools.exe.
Test IDEAL using the API Runner

1. Run the executable file Apitools.exe.
2. In the IDEAL API Runner window, click the Settings tab.
3. In the Server box, type the name of the server on which the Smart Instrumentation data
that you want to retrieve is located; if the server location is the computer you are
working from, type localhost.
If you use localhost as the computer I/P address, make sure that in your Internet
Explorer settings, you select the check box Bypass proxy server for local addresses
(to access the check box, click Tools > Options, and then on the Connections tab,
click LAN Settings).
4. Click Load PAU to connect to the server and retrieve the data for selecting the plant,
area, and unit.
5. From the Domain list, select the Smart Instrumentation domain that you want to use.
6. For an Owner operator domain only, select a project (As-Built or specified engineering
project) from the Project list.
7. Select a plant, area, and unit from the Plant, Area, and Unit lists respectively.
8. Click the General tab.
9. Under Item type, click one of the following options:
Report — Allows you to select a report type and specify the appropriate
parameters for that report type.
Loop — Allows you to specify a loop and display a list of all the tags associated
with that loop in the Document Viewer Interface.
Component — Allows you to specify a tag number and select documents

associated with that tag number in the Document Viewer Interface.
Panel — Allows you to specify a panel and display a list of all the strips associated
with that panel in the Document Viewer Interface.
10. Do one of the following:
If under Item type, you selected Loop, in the Item box, type a loop name and
click Display to display a list of all the tags associated with the specified loop.
If under Item type, you selected Component, in the Item box, type a tag number
and click Display to display a list of all the documents associated with the
specified tag number.
If under Item type, you selected Panel, in the Item box, type a panel name and
click Display to display a list of all the strips associated with the specified panel.
If under Item type, you selected Report, from the Report list, select the report
that you require. Next, in the Item box, type the appropriate report parameters,
and then click Display to display the report.
Make sure that the name of the item that you type corresponds to an existing item name
in Smart 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.
Support, Copyright, and Legal Information

Customer Support and Technical User Forum
For the latest support information for this product, connect to http://hexagonppm.com/ppm-
support <http://hexagonppm.com/ppm-support> .
Join our Technical User Forum on Linkedin. Visit

http://www.intergraph.com/ppm/customers/tuf/instrumentation.aspx
<http://www.intergraph.com/ppm/customers/tuf/instrumentation.aspx> .
Hexagon PPM Policy Against Software Piracy

When you purchase or lease Hexagon PPM software, Hexagon PPM, Intergraph, or its
affiliates, parents, subsidiaries retains ownership of the product. You become the licensee of
the product and obtain the right to use the product solely in accordance with the terms of the
Intergraph Corporation, doing business as Hexagon PPM, Software License Agreement and
applicable United States and/or international copyright laws.
You must have a valid license for each working copy of the product. You may also make one
archival copy of the software to protect from inadvertent destruction of the original software,
but you are not permitted to use the archival copy for any other purpose. An upgrade replaces
the original license. Any use of working copies of the product for which there is no valid
Intergraph Corporation, doing business as Hexagon PPM, Software License Agreement
constitutes Software Piracy for which there are very severe penalties. All Hexagon PPM
software products are protected by copyright laws and international treaty.
If you have questions regarding software piracy or the legal use of Hexagon PPM software
products, please call the Legal Department at 256-730-2362 in the U.S.
Updated June 2017
Document No. DDGL562C0
Copyright Notice
Copyright
Copyright © 1995-2019 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
This computer program, including software, icons, graphic symbols, documentation, file
formats, and audio-visual displays; may be used only as pursuant to applicable software
license agreement; contains confidential and proprietary information of Hexagon AB and/or
third parties which is protected by patent, trademark, copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper
authorization from Hexagon AB and/or its subsidiaries and affiliates.
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.
Hexagon PPM
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, box.net, or the Hexagon PPM
documentation web site, 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 Software License

Agreement ("SLA") 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
SLA 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 use. 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 SLA or separate license or
separate terms and conditions, Intergraph Corporation disclaims any and all express or
implied warranties including, but not limited to the implied warranties of merchantability and
fitness for a particular purpose and nothing stated in, or implied by, this document or its
contents shall be considered or deemed a modification or amendment of such disclaimer.
Intergraph believes the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without
notice and are subject to applicable technical product descriptions. Intergraph Corporation is
not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are
furnished under a license and may be used or copied only in accordance with the terms of
this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN
ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to,
catalog, reference and symbol data. Users should verify for themselves that the data is
accurate and suitable for their project work.
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT,

INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES,
INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF
INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
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 commercial-off-the-shelf software products, customized software

and/or third-party software, including any technical data related thereto (“Technical Data”),
obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to the export
control laws and regulations of the United States of America. Diversion contrary to U.S. law is
prohibited. To the extent prohibited by United States or other applicable laws, Intergraph
Corporation software products, customized software, Technical Data, and/or third-party
software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or
distributors must not be exported or re-exported, directly or indirectly (including via remote
access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of
these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but
not limited to, the United States Department of Commerce Denied Persons, Entities,
and Unverified Lists, the United States Department of Treasury Specially Designated
Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software
product, customized software, Technical Data and/or third-party software obtained from
Intergraph Corporation, its subsidiaries or distributors 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 Customer knows, or has reason to know, that an illegal reshipment
will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product,

customized software, Technical Data and/or third-party software obtained from Intergraph
Corporation, its subsidiaries or distributors, should be addressed to PPM’s Export Compliance
Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at
exportcompliance@intergraph.com. Customer shall hold harmless and indemnify PPM and
Hexagon Group Company for any causes of action, claims, costs, expenses and/or damages
resulting to PPM or Hexagon Group Company from a breach by Customer.
Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine,

SmartSketch®, SmartPlant Cloud®, PDS®, FrameWorks®, I-Route, I-Export, ISOGEN®,
SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, CAESAR II® , and HxGN SDx® are
trademarks or registered trademarks of Intergraph Corporation or its affiliates, parents,
subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its
subsidiaries. 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.
Copyright
Copyright© Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.

SPI 2018 IDEAL Client Instalation Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SPI 2018 IDEAL Client Instalation Guide

Uploaded by

Copyright:

Available Formats

18/7/22, 08:26 Hexagon PPM Documentation PDF Export

Intergraph Smart Instrumentation IDEAL

Intergraph IDEAL Client Installation

Registering Installed Files

Local Installation Files

Performing a Local IDEAL Installation

Perform a Local IDEAL Installation

2. Click Additional Software, and then click IDEAL Installation.

3. Click Start Setup.

4. On the Details and Features page, do the following:

a. Type a user name in the User Name field.

b. Type your companies name in the Company field.

c. Type the IDEAL serial number in the Serial Field.

d. Check the Install Path is correct.

Click to browse to a different location.

5. On the License Agreement page, do the following:

b. Read the software license agreement.

c. Select the I agree check box

Accessing IDEAL from a Client Machine without API or

To do this you must have done the following:

4. Microsoft's .Net Framework is also installed on the client machine.

5. That your user account has defined, access to %temp% folder.

Test IDEAL using the API Runner

2. In the IDEAL API Runner window, click the Settings tab.

8. Click the General tab.

9. Under Item type, click one of the following options:

Component — Allows you to specify a tag number and select documents

10. Do one of the following:

specified tag number.

Do not use spaces when typing delimiters.

Support, Copyright, and Legal Information

Join our Technical User Forum on Linkedin. Visit

Hexagon PPM Policy Against Software Piracy

Updated June 2017

Document No. DDGL562C0

U.S. Government Restricted Rights Legend

305 Intergraph Way

a. Use of a software product and Documentation is subject to the Software License

IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT,

UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY

Intergraph Corporation’s commercial-off-the-shelf software products, customized software

Any questions regarding export/re-export of relevant Intergraph Corporation software product,

Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine,

You might also like