Troubleshoot IDEAL Using the API Runner - Intergraph Smart Instrumentation - Help - Intergraph Process, Power & Marine Documentation

Intergraph Smart Instrumentation IDEAL Help

PPMProductFamily
Engineering and Schematics
PPMProduct
Intergraph Smart Instrumentation
PPMCategory
Help
Version_SPI
12.0(2018)
  1. Run the executable file Apitools. exe.

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

  3. In the Server box, type the name of the Smart Instrumentation server on which the data you want to retrieve is located; if the server location is the computer you are working from, type Localhost.

  4. Click Load PAU to connect to the server and retrieve the data for selecting the appropriate plant hierarchy items.

  5. From the Domain list, select the Smart Instrumentation domain that you want to use.

  6. For an owner operator domain only, select As-Built or specified project from the Project list.

  7. Select a plant, area, and unit from the Plant, Area, and Unit lists respectively.

     For this option to work correctly, each combination of plant-area-unit hierarchy item names must be unique throughout your domain or project.  Note that Plant refers to a plant or the equivalent plant hierarchy item at the highest level; Unit refers to a unit or the equivalent plant hierarchy item at the lowest level; Area refers to the area or equivalent plant hierarchy item immediately above the lowest level.

  8. Click the General tab.

  9. From the Item type list, select 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 item name that you type corresponds to the 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 you type are not case-sensitive.

  • Do not use spaces when typing delimiters.

  • For a complete list of reports, report keys, and parameters, see List of IDEAL Reports.

  • 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 sub-item, type the item name only in the Item box.