Displaying Reports Using Command Line Parameters - Intergraph Smart Instrumentation - Help - Intergraph Process, Power & Marine Documentation

Intergraph Smart Instrumentation IDEAL Help (2019)

PPMProduct
Intergraph Smart Instrumentation
PPMCategory_custom
Help
Version_SPI_custom
2019 (13.0)

The software uses the following command syntax for displaying reports:

  • <Home folder>\apitools.exe <Report Key>,<User Name>, <User Password>, <Domain Name>, <Plant Name>, <Area Name>, <Unit Name>, {<Parameter>}{^|<Parameter>}, {<File Name>}, {<Project Name>}, {<Database Name>}

 The command syntax only works correctly if each combination of plant-area-unit hierarchy item names corresponding to the <Plant Name>, <Area Name>, and <Unit Name> parameters is unique throughout your domain or project.  For details of the meaning of these parameters, see the first of the following notes.

  • Optional parameters are shown enclosed by curly braces {}.  Where it is possible to specify more than one parameter, you use a combination of the caret and pipe characters '^|' (without any spaces) as the delimiter to separate the parameters (for details, see the example for a Panel- Strip report).

  • By default, the comma character ',' is used as a separator between the command parameters.  To specify an alternative separator string consisting of one or more characters, the 'Separator' parameter must appear in the Apiserv.ini file, under the [API] section, with the appropriate value.  For example, to use a semicolon ';' as the separator, you should type:
      Separator=;

  • The <User Name> and <User Password> parameters refer to the user name and password of the Smart Instrumentation user and not of the database user.

  • The <Plant Name> parameter refers to a plant or the equivalent plant hierarchy item at the highest level; the <Unit Name> parameter refers to a unit or the equivalent plant hierarchy item at the lowest level; the <Area Name> parameter refers to an area or the equivalent plant hierarchy item immediately above the lowest level.

  • The <Project Name> parameter is only required when you are working in an owner operator domain.  For As-Built, you must type the string 'As-Built' (with a space).  This parameter is not required for an engineering company domain, unless you are working in a multi-database environment and want to use the <Database Name> parameter, in which case this parameter must have the value 'As-Built'.

  • The <Database Name> parameter is required when you are working in a multi- database environment. The value for this parameter is a profile name that appears in the INtools.ini file under the [Profiles] section.  When specifying this parameter, you must also enter a value for the <Project Name> parameter.

  • The <File Name> parameter is required when you are performing batch generation of reports as PDF files.  If you do not specify a file name, the software uses a default name and this can result in the same file being overwritten each time the software generates a new report.

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

  • For reports that use date ranges, you must type the dates using the current Windows date format.