You can type various IDEAL commands at the command line to open the Document Viewer Interface. In the Document Viewer Interface, you can generate documents starting from:
-
a tag list for a specified loop.
-
a document list for a specified tag number.
-
a list of strips for a specified panel.
The software uses the following general command syntax:
<Home folder>\apitools.exe <Domain ID>, <Plant ID>, <Area ID>, <Unit ID>, l/c/p, <Loop ID>/<Component ID>/<Panel ID>, <Project ID>, <Database Name>
where the phrases in brackets represent the following parameters:
-
<Home folder> — The folder where the IDEAL components were installed.
-
<Domain ID> — The ID of the domain where the item is located.
-
<Plant ID> — The ID of the plant or equivalent highest level plant hierarchy item.
-
<Area ID> — The ID of the area or the equivalent plant hierarchy item immediately above the lowest level.
-
<Unit ID> — The ID of the unit or equivalent lowest level plant hierarchy item.
-
l/c/p — The flag for the item type for which you want to display data, where l = loop for displaying a list of tag numbers, c = component (tag number) for displaying a list of tag documents, and p = panel for displaying a list of strips. You must type one of these flags only.
-
<Loop ID> — The ID of the selected loop where the flag for the item type is l.
-
<Component ID> — The ID of the selected tag number where the flag for the item type is c.
-
<Panel ID> — The ID of the selected panel where the flag for the item type is p.
-
<Project ID> — The ID of the engineering project to which the item belongs, if applicable. This parameter is only required when you are working in an owner operator domain. For As-Built, the value of this parameter is 1. 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 a value of 1.
-
<Database Name> — The name of the database profile to which the item belongs, if 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 ID> parameter.