Test IDEAL using the API Runner - Intergraph Smart Instrumentation - Installation & Upgrade - Intergraph Process, Power & Marine Documentation

Intergraph Smart Instrumentation IDEAL Client Installation Help

PPMProduct
Intergraph Smart Instrumentation
PPMCategory_custom
Installation & Upgrade
Version_SPI_custom
13.1
  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.