SPI 2018 Internal Setup

18/7/22, 08:28 Hexagon PPM Documentation PDF Export
Intergraph Smart Instrumentation Internal

Setup
Hexagon PPM Documentation Web Site
Generated 07/18/2022
https://docs.hexagonppm.com/internal/api/webapp/print/9eeea5b7-4aa2-4d9b-9b8c-5bfcce734c65 1/37
Internal Setup Utility

The Internal Setup Utility is for the use of System Administrators to troubleshoot and fix
database problems in Intergraph Smart® Instrumentation without the need to log on to Smart
Instrumentation. The Internal Setup Utility is installed when you perform your network
installation.
With the Internal Setup Utility, you can execute SQL commands for updating the database or
for ODBC configuration. You can also compare and match a version of Smart Instrumentation
with the number available in the version information file.
Incorrect use of this utility can damage the Smart Instrumentation database. If
you are unsure of any of the procedures, back-up your database and contact Customer
Support before starting to work with the Internal Setup Utility.
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.00)
Published 6/2/2019 at 07:31
Internal Setup Commands

File
Open — Allows you to open an external SQL file in the Query pane of the Database Type
Test and Query window. The encoding of the source SQL file must be Unicode LE. You
can then execute the retrieved SQL statements as needed.
Available when the Database Type Test and Query window is open and you are
connected to the database.
Close — Closes the Database Type Test and Query window.
Available when the Database Type Test and Query window is open.
Save As — Saves the results of an SQL Select command in a specified format.
Active only after you connect to a database.
Print — Prints the results of an SQL Select command.
Active only after you connect to a database.
Database Type Test and Query — Opens the Database Type Test and Query window to
test your database connection and version compatibility. You can also query your database
from this window by means of SQL commands.
Printer Diagnostics — Opens the Printer Diagnostics dialog box, which displays details of
your current default printer settings and allows you to specify the printing orientation. From
this dialog box, you can also launch the Properties dialog box if you need to change the
printer settings.
Versions — Opens the Versions dialog box, where you compare Smart Instrumentation and
template database versions with the version information file.
Action
The Action menu is available only when the Database Type Test and Query window is
open. Note that you can access most of these commands by clicking the icons that become
active when you open this window.
(Database connection actions)
Use INI file — Copies the database settings from the Intools.ini file to the fields under the
Connection setting group box.
Connect — Connects to the database indicated by the parameters.
(Database query actions) — Active only after you connect to a database.
Execute — Executes any SQL commands that you typed in the Query pane.
Settings
Available only from the Internal Setup window.
Create ODBC Profile — Creates an ODBC profile to configure Smart Instrumentation

database files.
Rebuild Procedures and Triggers — Identifies abnormal database behavior and corrects it
by rebuilding the stored procedures and triggers in the database.
Smart Instrumentation Database Structure and Schemas
The Smart Instrumentation database consists of a hierarchy, where each level of the
hierarchy contains tables that are specific to that level. The highest level of the hierarchy is
the Admin schema. On the next level of the hierarchy, there is a Domain schema for each
domain you initialize in the database. For an engineering company domain, the hierarchy can
be represented as follows:
Within each domain, there are plant hierarchy levels. By default, each domain has three
levels as follows: <plant>, <area>, and <unit>. When you perform an upgrade, the Admin
schema is updated first, then the software prompts you to upgrade domains (one domain at a
time).
The following table shows most common types of data you can define at each level of the
hierarchy:
Level Table Data Included Note
Admin schema Users, user groups, naming conventions, access rights
Domain schema instrument types and other supporting tables, spec forms,
reference wiring data
<Plant> Wiring data, custom fields
<Area> None Used as a

container only
<Unit> Loops, instruments The software

checks
uniqueness at
the <unit> level
There is a connection between the data settings at each level of the plant hierarchy, for
example, an instrument tag includes data from various tables at the following levels:
COMPONENT table (contains instruments) at the <unit> level
Supporting tables at the domain level
PD_GENERAL table (contains process functions, such as pressure, flow, temperature,

and so forth) at the <unit> level
SPEC_SHEET_DATA table (contains specification data) at the <unit> level
Referential Integrity Constraints

There are foreign keys between the parent and child tables. In some cases, the referential
constraints cannot be kept via foreign keys due to technical limitations, so the stored
procedures and triggers perform the constraints.
Due to a mutating problem, some referential integrity in Oracle and SQL Server is kept only in
stored procedures and triggers or in the application (referred to in the table as o(p)).
Some parent tables in Smart Instrumentation, mostly supporting tables (also known as
validation tables) have initial rows for cases where the child table is not required to have a
defined value for the parent table. The ID number of these rows is usually 0. This emulation
is done by the application or the database code and a restricted foreign key exists.
Database Relationship Example

The following example shows how data in the LOOP and COMPONENT tables is related.
The LOOP table includes the following columns:
Column Example Value Column Status
LOOP_ID 1000 Primary key
LOOP_NAME F-100
LOOP_SERV Feed to B-101 Pass A
The COMPONENT table includes the following columns:
Column Example Value Column Status
CMPNT_ID 999 Primary key
CMPNT_NAME FT-100
LOOP_ID 1000 Foreign key
CMPNT_SERV Heat exchanger inlet
A primary key is the column or a combination of columns where the values determine the
uniqueness of each record. Note that both tables include the column LOOP_ID. This column
is the primary key in the LOOP table. In the COMPONENT table, the LOOP_ID column uses
the value of LOOP_ID in the LOOP table to associate the tag to the loop, and is therefore the
foreign key in the COMPONENT table.
In the LOOP table, there is a zero row, which is used as a reference row if you create a tag
that is not associated with any loop.
The following SQL Select command retrieves loop numbers and instrument tag numbers with
the associations between them:
Select component.cmpnt_name, loop.loop_name from component, loop where

component.loop_id = loop.loop_id;
Smart Instrumentation Database Schemas

Smart Instrumentation database schemas are internal objects that hold Smart Instrumentation
data and enable the software to connect to the database. Each database schema has a
logon name and password, which the software uses to connect to the database.
The following schemas exist in Smart Instrumentation:
Admin Schema
Domain Schema
INTOOLS_LOGIN Schema
SPI_login Schema
SPIsuper Schema
View-Only Domain Schema
Owner Operator Domain Schemas
Admin Schema
The Admin schema holds Smart Instrumentation administration data managed by the System
Administrator. The logo name and password of the Admin schema depend on your database
platform.
Admin Schema in a SQL Server Database
The software creates the Admin schema in your SQL Server instance on the database server
when you run the DB Setup Utility. The default Admin schema logon name is SPI_DBAMN.
The default Admin schema logon password is SPI_DBA. Smart Instrumentation System
Administrator can redefine the default name and password when running the DB Setup Utility,
provided that the schema password is different from the schema name.
Admin Schema in an Oracle Database
The software creates the Admin schema in your Oracle instance on the database server
when you run the DB Setup Utility. The default Admin schema logon name and password is
IN_DBAMN. Smart Instrumentation System Administrator can redefine the default name and
password when running the DB Setup Utility.
The software adds the Oracle role DBA with maximum privileges to the Admin schema. The
software uses the DBA role when running the DB Setup Utility, initializing a new domain, or
upgrading the software. Furthermore, the following Administration module activities cannot
be performed without the DBA role:
Assigning Administrator rights
Deleting a domain
Deleting an invalid domain
Accessing the database
Encrypting passwords of Smart Instrumentation users
Managing security
Resizing tablespaces
Working with the tablespace list
Rebuilding catalog tables
Rebuilding stored procedures and triggers
Rebuilding domain views
Clearing locking
By default, regardless of the database platform, the Admin schema logon

password is not encrypted. On Oracle or SQL Server, if needed, the System Administrator
can encrypt the Admin schema logon password. For more information, see Encrypt the
Admin Schema Logon Password in the Administration Module help. When encrypting the
password, the software removes the Admin schema logon name and password from the
Intools.ini file and stores this data in the INTOOLS_LOGIN table of the INTOOLS_LOGIN
schema.
Domain Schema
The Domain schema holds Smart Instrumentation domain data, managed by the Domain
Administrator and engineers. The software creates the Domain schema when the System
Administrator initializes a domain. The System Administrator is prompted to define the
Domain schema name and password and the defined Domain schema name becomes the
domain logon name in the database. In Oracle or SQL Server, the System Administrator can
encrypt all the Domain schema logon passwords in the database if needed. When performing
a database connection, the software retrieves the logon name and password from the
PROJECT table of the Admin schema.
INTOOLS_LOGIN Schema
INTOOLS_LOGIN is a Smart Instrumentation database schema created only in Oracle during
the database setup. This schema stores the encrypted Admin schema password in the
database. The schema logon name and password are both intools_login. The logon name
is set permanently in the software. The System Administrator can change and encrypt the
intools_login password if needed.
SPI_login Schema
SPI_login is a Smart Instrumentation database schema (database user) created only in SQL
Server during the database setup. Each SPI_login schema stores the encrypted Admin
schema password in the database. This schema login is shared for all databases you create
in a SQL Server instance. For example, if you create SPI1 and SPI2 databases in the same
instance, each database contains the SPI_login schema but, at the instance level, both
schemas share the same login, whose name is SPI_login and password is spi_login_pwd
(lower case). The login name is set permanently in the software. The System Administrator
can change and encrypt the spi_login_pwd password if needed.
SPIsuper Schema
SPIsuper is a Smart Instrumentation database user created only in SQL Server during the
database setup. This schema is used when you initialize and define a domain, and when you
back up, upgrade, or delete a domain. Furthermore, this schema is used when you run any
DBA menu option in the System Administration window.
The schema login is shared for all databases you create in a SQL Server instance. For
example, if you create SPI1 and SPI2 databases in the same instance, each database
contains the SPIsuper schema but, at the instance level, both schemas share the same login.
The login name is SPIsuper and the password is spisuper_pwd (lower case). Both the login
name and password are set permanently in the software.
View-Only Domain Schema

The View-Only Domain schema holds database views of all tables in a domain. The software
creates this schema when the System Administrator initializes a domain. This schema
enables viewing data for users of report generators, such as Microsoft Access and
InfoMaker. The View-Only Domain schema logon name and password that the software
creates is <DOMAIN NAME>_VIEW, where the DOMAIN NAME segment corresponds to the
Domain schema logon name in the database. The logon name is set permanently in the
software. The default logon password is <DOMAIN NAME>_VIEW. In the database, the
password is not encrypted. The System Administrator can change the password only once,
when initializing a new domain. On the Initialize dialog box, the default password and the
characters that you type when changing the password appear masked.
Owner Operator Domain Schemas

An owner operator domain is a domain that supports an As- Built functionality with multiple
projects. There are three owner operator domain schemas.
As-Built Schema — Holds As-Built database views. The software creates the logon name
and password automatically using the following naming convention: <domain name>_a_1.
The <domain name> segment corresponds to the Domain schema logon name in the
database. The As- Built schema logon name and password are identical to each other.
When performing a database connection, the software retrieves the logon name and
password from the ENGINEERING_PROJECT table of the Domain schema. The password
<domain name>_a_1 is not encrypted. The logon name and password are set permanently
in the software.
Project Schema — Holds project database views. The software creates the logon name and
password automatically using the following naming convention:
<domain name>_e_<project id number>. The <domain name> segment corresponds to

the Domain schema logon name in the database. The Project schema logon name and
password are identical to each other. When performing a database connection, the software
retrieves the logon name and password from the ENGINEERING_PROJECT table of the
Domain schema. The password <domain name>_e_<project id number> is not encrypted.
The logon name and password are set permanently in the software.
Combined Project Schema — Holds database views of a project used in a combination with
As-Built. In Smart Instrumentation, such a combination enables the user to open a project
with As-Built items displayed. The software creates the logon name and password
automatically using the following naming convention:
<domain name>_c_<project id number>. The <domain name> segment corresponds to

the Domain schema logon name in the database. The Combined Project schema logon
name and password are identical to each other. When performing a database connection, the
software retrieves the logon name and password from the ENGINEERING_PROJECT table
of the Domain schema. The password <domain name>_c_<project id number> is not
encrypted. The logon name and password are set permanently in the software.
Connecting to the Smart Instrumentation Database

The Internal Setup Utility allows you to connect to the Admin schema or Domain schema and
then run various SQL commands to view or modify data in the tables. On Oracle or SQL
Server, if the Admin schema is not encrypted, any user can connect to the Admin schema,
view user logon information, or update data in the Admin schema tables, or retrieve Domain
schema logon information and then connect to the appropriate Domain schema. If the
System Administrator encrypted the Admin schema, you can connect to the Admin schema
only if you know the Admin schema logon password. For details about the Admin schema
encryption, see Encrypt the Admin Schema Logon Password in the Administration Module
help.
When you connect to the Admin schema, depending on whether the Admin schema password
is encrypted or not, the software retrieves the Admin schema logon name and password in
one of the following ways:
If the Admin schema is not encrypted, the software connects to the Admin schema
using the Admin schema logon name and password from the Intools.ini file. On an
Oracle platform, the default logon name and password are IN_DBAMN. On a SQL
Server platform, the default logon name is SPI_DBAMN and the password is
SPI_DBA. It is possible to specify different settings during Smart Instrumentation
database setup. In SQL Server, the name must be different from the password.
If the Admin schema is encrypted, the software connects to the INTOOLS_LOGIN

schema and then retrieves the Admin schema logon name and password from the
INTOOLS_LOGIN table.
When you connect to a Domain schema, the software performs the following actions:
a. Connects to the Admin schema.
b. After retrieving the Admin schema logon name and password, the software connects to
the Domain schema and retrieves the Domain schema logon name and password from
the PROJECT table of the Admin schema.
The following connection actions only apply when the domain type is Owner
operator:
After connecting to the Domain schema, the software connects to a project schema (As-
Built or project) and retrieves the logon name and password from the
ENGINEERING_PROJECT table of the Domain schema.
When a Smart Instrumentation user opens a project with As-Built items displayed, the
software connects to the Combined Project schema and retrieves the logon name and
password from the ENGINEERING_PROJECT table of the Domain schema.
Testing the Database Connection Common Tasks

These tasks deal with testing the connection to the Admin schema or Domain schema of the
Smart Instrumentation database.
Connect to the Admin Schema
Use this procedure to test the connection to the Admin schema in your database. You can
either connect to the database whose connection settings are specified in the Intools.ini file or
connect to a different database. For details, see Connect to the Admin Schema.
Connect to the Domain Schema on Oracle
Use this procedure to test the connection to a specific Domain schema residing in Oracle.
You can either connect to the database whose connection settings are specified in the
Intools.ini file or connect to a different database, if you know the Oracle instance alias for the
target Oracle database. For details, see Connect to the Domain Schema on Oracle.
Connect to the Domain Schema on SQL Server
Use this procedure to test the connection to a specific Domain schema residing in SQL
Server. You can either connect to the database whose connection settings are specified in
the Intools.ini file or connect to a different SQL Server database, if you previously created the
appropriate ODBC profile. For details, see Connect to the Domain Schema on SQL Server.
Connect to the As-Built Schema
Use this procedure to connect to the As-Built schema in an owner operator domain. For
details, see Connect to the As-Built Schema.
Connect to a Project Schema
Use this procedure to connect to a specific Project schema in an owner operator domain. For
details, see Connect to a Project Schema.
Connect to a Combined Project Schema
Use this procedure to connect to a specific Combined Project schema in an owner operator
domain. For details, see Connect to a Combined Project Schema.

1. On the menu bar, click File > Database Type Test and Query.
2. Do one of the following:
Click Actions > Use INI File.
On the toolbar, click to retrieve the parameters from the Intools.ini file for the
current Admin schema.
3. Under, Database type group box, select the type of database that you are working in,
and then, under Connection settings, type the appropriate database parameters in the
boxes to retrieve the parameters from a different Admin schema.
On Oracle or SQL Server, the System Administrator can prevent unauthorized

connections to the Admin schema by encrypting the Admin schema password using the
Administration module option. When encrypting the password, the software removes
the Admin schema logon name and password from the Intools.ini file and stores this
data in the database. Therefore, if the password is encrypted, you cannot retrieve it
automatically from the Intools.ini file but must enter it manually. For more information,
see Encrypt the Admin Schema Logon Password in the Administration Module help.
On the menu bar, click Actions > Connect.
On the toolbar, click .
The Results pane displays the result of the connection. A zero (0) indicates a
successful operation. Codes that indicate a connection failure include a message explaining
the reason for the failure.

2. Under Database type, do the following:
Select Oracle.
In the ODBC driver box, enter the DBMS parameter of your Oracle version.
3. Under Connection settings, do the following:
In the Schema logon name box, enter the target Domain schema logon name
specified by the System Administrator when initializing the domain.
In the Schema logon password box, enter the target Domain schema logon
password specified by the System Administrator when initializing the domain.
4. In the Server name and Database name boxes, enter the Oracle instance alias name,
which is the same for the Oracle server name and Oracle database name.
Click Actions > Connect.
Click .

To connect to the Admin schema whose parameters are defined in the Intools.ini
file on the current client machine, click Actions > Use INI File.
The software automatically retrieves the connection parameters from the

Intools.ini file for the Admin schema.
To connect directly to the target Domain schema without specifying the Admin
schema parameters first, under Database type, select SQL Server.
When connecting to a Domain schema in a database that is located on another

machine, make sure that the appropriate ODBC profile exists on the current
machine.
The ODBC driver box must display MSS. This value is retrieved from the
Intools.ini file, where it appears in the [Database] section as the DBMS parameter
value. Make sure that in the MSS value of the DBMS parameter appears in upper
case. Otherwise, it is not possible to work with specifications in Smart
Instrumentation.
3. Under Connection settings, do the following:
4. In the Schema logon name box, type the target Domain schema logon name specified
by the System Administrator when initializing the domain.
5. In the Schema logon password box, type the target Domain schema logon password
specified by the System Administrator when initializing the domain.
6. Enter or modify the DBParm string using the following values:
DBParm=ConnectString='DSN=<ODBC profile name>;UID=<Domain schema logon

name>;PWD=<Domain schema logon password>',DisableBind=1
If you connected to the Admin schema using the Intools.ini file

parameters, the DBParm string is retrieved automatically from the Intools.ini file. When
you change the logon name and password, the software does not update the DBParm
string. You must manually change the UID and PWD values to match the Domain
schema logon name and password respectively.
For SQL Server 2014, the default ODBC profile name for SQL Server is
MSS2014.
If the Server name and Database name boxes do not display any settings, you
can leave them blank.
Click .
The Results pane displays the result of the connection. A zero (0)
indicates a successful operation. Codes that indicate a connection failure include
a message explaining the reason for the failure.

2. Connect to the Domain schema.
3. In the Query pane, type the following command:
select * from ENGINEERING_PROJECT;
4. Click Execute.
5. On the SQL Result window, scroll right to display the Eng Log Name and Eng Log
Pass columns.
The Eng Log Name and Eng Log Pass columns contain As-Built and Project
schema logon information.
In the ENGINEERING_PROJECT table, the As-Built row is the one whose Eng
Proj ID column value is 1.
6. Type the As-Built schema logon name, which appears in the Eng Log Name column, in
the Schema logon name box in the Database Type Test and Query window.
7. Type the As-Built schema logon password, which appears in the Eng Log Pass column,
in the Schema logon password box in the Database Type Test and Query window.
Click .

3. In the Query pane, type following command:
4. Click Execute.
Pass columns.
The Eng Log Name and Eng Log Pass columns contain Project and As- Built
schema logon information. The Engineer Name column displays names of existing
projects.
6. Type the target Project schema logon name, which appears in the Eng Log Name
column, in the Schema logon name box in the Database Type Test and Query
window.
7. Type the target Project schema logon password, which appears in the Eng Log Pass
column, in the Schema logon password box in the Database Type Test and Query
window.
Click .

3. In the Query pane, type following command:
4. Click Execute.
Pass columns.
The As-Built Log Name and As-Built Log Pass columns contain Combined
Project schema logon information. The Engineer Name column displays names of
existing projects.
6. Type the target Combined Project schema logon name, which appears in the As-Built
Log Name column, in the Schema logon name box in the Database Type Test and
Query window.
7. Type the target Combined Project schema logon password, which appears in the As-
Built Log Pass column, in the Schema logon password box in the Database Type
Test and Query window.
Click .
Checking Database Version Compatibility

When you run Smart Instrumentation after installation or update, if a message appears that
there is an inconsistency between the database and the application, this procedure can help
you to start troubleshooting the source of the problem. You can then notify Customer
Support.
Check the Database and Application Versions

1. On the menu bar, click File > Versions.
2. Click Read.
By default, the Internal Setup Utility reads data from the Smart Instrumentation
database and the version information file.
3. Beside Domain, select the domain in which you want to check the version numbers.
If the version information file number is higher than the corresponding domain
database number, the most likely reason for the incompatibility is that the
database needs updating. In this case, you should open the Administration
module and run the upgrade option on the domain.
If the version information file number is lower than the corresponding domain
database number, the most likely reason is that an older Smart Instrumentation
version was installed over an existing database. In this case, you should contact
Customer Support for further assistance.
The template database does not have a version number.
Commands and Controls
Database Type Test and Query Window

You use this window to connect to a database and to run SQL commands.
On the menu bar, click File > Database Type Test and Query to open this window.
Database type
In this group box, you select the platform on which your database runs. The following options
are available:
Oracle
SQL Server
If you click Actions > Use INI File, the software selects the database type
automatically.
ODBC driver — Accept the default value for the database platform, or type a different value.
If your database is Oracle, you must enter the DBMS parameter of your Oracle version. For
example, for Oracle 11g, enter ORA. If you click Actions > Use INI File, the software
retrieves the DBMS parameter value from the [Database] section of Intools.ini file and
displays this value in the ODBC driver box automatically.
When the database platform is SQL Server, make sure that the ODBC driver
box displays MSS in upper case. In the Intools.ini file, the string DBMS=MSS must display
MSS in upper case; otherwise, it is not possible to work with specifications in Smart
Instrumentation.
Connection settings
Displays the connection settings retrieved from the Intools.ini file or allows you to enter the
connection settings manually if you need to connect to another database.
Schema logon name — Allows you to type the logon name of the Admin or Domain schema.
Schema logon password — Allows you to type the logon password of the Admin or Domain
schema. The password characters appear masked.
Server name — Allows you to type the Oracle instance alias for the server to which you want
to connect.
Only required when the database type is Oracle.
Database name — Allows you to type the Oracle instance alias for the database to which you
want to connect. The alias name is the same for both boxes.
Only required when the database type is Oracle.
DBParm — Displays the connection string as defined for the DBParm parameter under the
[Database] section of the Intools.ini file.
Only required when the database type is SQL Server.
On SQL Server, if you first connected to the Admin schema by using the
Intools.ini file parameters, when connecting to a Domain schema on SQL Server, you must
manually change the UID and PWD values to match the displayed target Domain schema
logon name and password respectively.
Auto commit — Allows you to execute a batch of SQL commands. If you clear the check
box, when executing SQL commands, the software prompts you to execute each SQL
command manually.
Query — Allow you to enter the SQL command that you want to execute for the database to
which you are connected.
Results — Displays the result of making a database connection or executing SQL

commands. On connecting to the database, a zero (0) parameter indicates a successful
connection.
Database Type Test and Query Toolbar
Use .INI — Allows you to copy the database settings from the Intools.ini file to the boxes in
the Connection setting dialog box.
Connect — Connects to the database specified in the Database type and Connection
setting parameters.
The following icons are active only after you connect to a database.
Execute — Executes the SQL commands that you typed in the Query pane.
Open — Opens an .sql file.
Save as — Save the results of an SQL Select command in a specified format.
Print — Print the results of an SQL Select command.
Versions
Use this dialog box together with Customer Support to compare Smart Instrumentation and
template database versions with the version information file, c_ver.pbd.
Read from
From this group box, select one or more of the following:
User database — Select to read version data from the database used for creating and
managing Smart Instrumentation data.
Template database — Select to read version data from the Smart Instrumentation template
database file, IN_TEMPL.DDTI. This file is used for database upgrade.
Version file — Select to read version data from the version information file, c_ver.pbd.
Domain — After clicking Read to display the data, select the domain to which you want to
compare the version information.
Admin — Displays the Admin schema version ID in each category.
Domain — Displays the Domain schema version ID in each category.
SQL Queries
This section contains topics about using SQL Queries in the Internal Setup Utility.
Executing SQL Commands

You can execute SQL commands to retrieve data from the database, or to update values in
the database. After retrieving data, you can save it in several formats such as Excel
spreadsheets, PowerSoft reports, SQL, and so forth. You execute SQL commands in the
Database Type Test and Query window, in which you can either type an SQL command in
the Query pane or load SQL commands from an external SQL file, provided that the file
encoding is Unicode LE.
In the Internal Setup Utility, it is possible to run certain SQL commands generated by
the DBChecker Utility. However, when using the Internal Setup Utility on the SQL Server
platform, commands that contain 'go' do not run. To be able to run these commands in the
Internal Setup Utility, change all the occurrences of 'go' with ';'.
Execute a SQL Command

Define connection parameters for the Admin schema by clicking Actions > Use
INI File on the menu bar or by clicking on the toolbar.
Define connection parameters for the appropriate Domain schema. For details,
see Testing the Database Connection Common Tasks.
On the menu bar, click Actions > Connect.
On the toolbar, click .
Under Query, type the SQL command that you want to execute. End each
command with a semicolon (;) and do not type more than one SQL Select
command.
On the menu bar, click File > Open, and then, select an external SQL file with the
.sql extension.
The encoding of the source SQL file must be Unicode LE. Any other SQL
file encoding is not supported.
On the menu bar, click Actions > Execute.
Examples of SQL Commands
The following SQL Select command retrieves the current software version and domain name
from the Admin schema tables:
Select rev_software, proj_name from project;
The following SQL Select command retrieves loop numbers and their associated instrument
tag numbers from the Domain schema tables:
Select component.cmpnt_name, loop.loop_name from component, loop

where component.loop_id = loop.loop_id;
or:
Select c.cmpnt_name, l.loop_name from component c, loop l where

c.loop_id = l.loop_id;
End each command with a semicolon (;).
In this example, the where argument ensures that the tag numbers appear with the
correct relationship to the loops to which they belong.
Save SQL Results in a Specified File Format

1. Execute an SQL Select command.
2. With the SQL Result dialog box open, click File > Save As.
3. On the Save As dialog box, select one of the following data formats:
Original: Saves the data in all the fields, including the ones that are not visible in
the preview, for example, internal database ID numbers. This option is
recommended if you want to save the file in .psr or .sql format, or if you want to re-
import the data into Smart Instrumentation at a later stage.
Data Only: Saves only the data that is visible in the preview. This option is
recommended for easier viewing of the data, and enables you to manipulate the
headers and select the columns you want to display.
4. Click OK and navigate to the location where you want to save the file.
5. Select the required file format and type the name of the file, then click Save.
You can save a result in the original format as an SQL file under the name of the table
that you specified in the Select command. When you run the SQL file, it creates the
table. You can delete all the data except for the set of values under the first insert into
section and run the file as a script to insert the zero (default) line if it is missing.
If you save SQL results in SQL format and you intend to open the SQL file in the
Internal Setup Utility later, make sure you select the correct encoding, which is Unicode
LE.
Save As Dialog Box

This dialog box enables you to save your query results as an external file. Among the formats
supported are Microsoft Excel, PowerSoft, and SQL.
Original
Saves the data in all the fields, including internal database ID numbers and so forth. This
option is recommended if you want to save the file in . psr, .xls, or .sql format, or if you want to
re-import the data into Smart Instrumentation at a later stage.
Data only
Saves only the report data that is visible in the preview. This option is recommended for
easier viewing of the data, and enables you to manipulate the headers and select the
columns you want to display.
Include headers — Allows you to include the column headers in the new file you are saving.
This option is available only if you selected Data only.
Edit headers — Opens the Edit Column Headers dialog box where you can edit the column
headers Smart Instrumentation saves in the new external file. This option is available only if
you selected Data only and Include headers.
ODBC Profiles
Smart Instrumentation uses an ODBC profile when connecting to a Smart Instrumentation

database on SQL Server. When you install Smart Instrumentation on SQL Server, the
software automatically creates an ODBC profile on your client machine. The created profile
type is System DSN, which allows every user working on this machine to connect to the
database using this profile. You do not need to configure this profile to connect to Smart
Instrumentation.
SQL Server ODBC Profiles
When you install Smart Instrumentation on SQL Server, the software creates an ODBC profile
on the Windows registry level and adds database profile connection parameters in the
[Database] section of the Intools.ini file. For SQL Server 2014 database server, on every
client machine where you install Smart Instrumentation, the software creates the MSS2014
profile. It is not possible to create SQL Server ODBC profiles using the Internal Setup Utility.
However, you can use the Internal Setup Utility to test the connection to your database using
any other ODBC profile for SQL Server that exists in your Windows registry.
To ensure that you do not receive errors when opening a domain from your database, in
the [Database] section of the Intools.ini file, the ServerName parameter must have the
same value as <ODBC profile name> in the ODBC connection string.
You must use your tools to create an ODBC profile if you want to connect from your
client machine to another Smart Instrumentation database residing on a different
machine.
When installing Smart Instrumentation, the software creates an ODBC profile for every
shipped .ddti file on the Windows registry level and adds database profile connection
parameters in the [Database] section of the Intools.ini file. For example, if you chose to
create an empty database rather than a demo database, in the Intools.ini file, the software
automatically sets the connection parameters to enable the use of the ODBC profile created
for the Intools.ddti database. Connection parameters for other ODBC profiles are commented
out.
You must create an additional ODBC profile in the following case:
You need to connect from your client machine to another Smart Instrumentation
database residing on a different machine.
The Internal Setup Utility provides a convenient method of creating ODBC profiles, although,
you can define ODBC profiles using the Windows Control Panel, Data Sources option, on
the System DSN tab or User DSN tab. When creating an ODBC profile using the Internal
Setup Utility, you have an option to define the profile creation method. The following methods
are available:
System DSN — Allows you to create a database profile on the registry entry level of the
local machine so that every user working on this machine can connect to the database
using this profile. The profile appears in the Windows registry in the following path:
HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI.
User DSN — Allows you to create a database profile on the registry entry level of the
current user so that only the current user working on this machine can connect to the
database using this profile. The profile appears in the Windows registry in the following
path: HKEY_CURRENT_USER\SOFTWARE\ODBC\ODBC.INI.
User DSN and System DSN — Allows you to create a profile on both registry entry
levels.
Service Operations
This section contains topics about various service operations performed in the Internal Setup
Utility.
Rebuilding Stored Procedures and Triggers

This procedure allows you to identify abnormal database behavior and correct it by rebuilding
the stored procedures and triggers in the database. Stored procedures and triggers are
portions of code that run automatically when you perform certain actions that affect the
database. For example, when you delete a loop, there is a stored procedure that runs to
delete an associated loop drawing. You can re-create stored procedures either for the Admin
schema or for the Domain schema.
The System Administrator should perform this procedure if inappropriate SQL error messages
are displayed in Smart Instrumentation.
Normally, you should run this option from the Administration module; however, you
can run it from the Internal Setup Utility if for some reason you cannot log on to the
Administration module.
Rebuild Stored Procedures and Triggers
This procedure should only be carried out when you are specifically instructed to do so
by Customer Support.
Make sure that all users have logged out of the Smart Instrumentation database before
starting this procedure. When you start rebuilding stored procedures and triggers, no
users should attempt to log on to Smart Instrumentation.
Create a Batch Rebuild File
As in batch upgrade, you can create a .bat file that rebuilds stored procedures and triggers for
multiple domains simultaneously. The following procedure describes how to create a batch
rebuild file.
1. In Notepad, create a batch file (for example, BatchRebuild.bat).
2. Enter a line for each domain you are asked to rebuild stored procedures and triggers for,
as shown in the example below:
Upgrade -9999 //rebuild stored procedures and triggers for admin schema
Upgrade -<proj_id> //rebuild stored procedures and triggers for a specific

domain
3. Double-click the batch file to run it and rebuild stored procedures and triggers for the
defined domains.
You can schedule the batch file to run at a convenient time using Windows
scheduler (for example, during the night or over the weekend).
Rebuild Stores Procedures and Triggers Manually
1. With the System Administration window open, click DBA >Rebuild Stored
Procedures and Triggers.
Click Admin schema to rebuild stored procedures and triggers of the Admin
schema.
Click Domain schema and then, under Domain, select a domain for which you
can rebuild stored procedures and triggers.
3. Click OK.
When rebuilding stored procedures and triggers of the Admin schema, the
Domain list is redundant.
If the process stops for any reason, you can restart the process and the process
continues from where it stopped. If you get an error that cannot be corrected,
contact Intergraph Support with the error description. It is recommended that you
have your log file available when contacting Intergraph Support.
4. On the Rebuild Stored Procedures dialog box you can click Browse to specify the log
file path and filename, if you do not want to use the default Log.txt file. This file
contains information of the current session and any errors that may have occurred in
previous sessions. The log file is concatenated, if you use the same log file name.
5. Click OK to start rebuilding the stored procedures and triggers of the selected schema.
At the end of the process, an appropriate message is displayed and an additional log file
Logerror.txt is generated in the Smart Instrumentation home folder. The data in the
Logerror.txt file is incremented between sessions. Send the Logerror.txt file to Intergraph
Support after you complete the process.
Testing the Printer

This option allows you to troubleshoot printing problems by testing the default printer and
displaying current settings.
Test the Printer

1. Click File > Printer Diagnostics.
2. Click Test to display the parameters for the default printer.
If necessary, click Setup to change settings for the default printer.
3. Under Printing orientation, select Portrait or Landscape.
4. Click Close to return to the main the Internal Setup Utility window.
Printer Diagnostics Dialog Box

You use this dialog box to display the settings of the current default printer. The dialog box
also allows you to access a dialog box to change the printer settings.
To access this dialog box, click File > Printer Diagnostics.
Printer settings
Displays the current printer settings after you click Test.
Printer name — Displays the name and model of the printer.
Horizontal resolution — Displays the horizontal resolution of your printer in dpi (dots per
inch).
Vertical resolution — Displays the vertical resolution of your printer in dpi.
Port — Displays the port connecting your computer to the printer.
Paper width — Displays the width of the paper you selected in setup.
Paper height — Displays the height of the paper you selected in setup.
Paper size — Displays the name of the paper-size you selected, for example: A4, Letter, with
the appropriate dimensions.
Print driver — Displays the name of the driver file you set for this printer on your computer.
Printing orientation — Displays Portrait or Landscape selected, according to the print

setting.
Rebuild Procedures and Triggers Dialog Box

This option allows you to identify abnormal database behavior and correct it by rebuilding the
stored procedures and triggers in the database. Normally, the System Administrator
accesses this feature from the Administration module; however, you can run it from the
Internal Setup Utility if for some reason you cannot log on to the Administration module.
To open this dialog box from the Internal Setup Utility, click Settings > Rebuild Procedures
and Triggers.
Select a schema you want to rebuild:
Admin schema — Allows you to rebuild the Admin schema.
Domain schema — Allows you to rebuild the schema of the domain you select from the
Domain list.
Domain — Allows you to select the target domain if you choose to rebuild a Domain schema.
OK — Opens the Rebuilding Stored Procedures and Triggers dialog box where you can
accept or specify a log file path and start the process.
Make sure that all users have logged out of the database before rebuilding
stored procedures and triggers. When you start rebuilding stored procedures and triggers, no
users should attempt to log on to Smart Instrumentation.
Testing the Database Connection Common Tasks

These tasks deal with testing the connection to the Admin schema or Domain schema of the
Smart Instrumentation database.
Use this procedure to test the connection to the Admin schema in your database. You can
either connect to the database whose connection settings are specified in the Intools.ini file or
connect to a different database. For details, see Connect to the Admin Schema.
Use this procedure to test the connection to a specific Domain schema residing in Oracle.
You can either connect to the database whose connection settings are specified in the
Intools.ini file or connect to a different database, if you know the Oracle instance alias for the
target Oracle database. For details, see Connect to the Domain Schema on Oracle.
Use this procedure to test the connection to a specific Domain schema residing in SQL
Server. You can either connect to the database whose connection settings are specified in
the Intools.ini file or connect to a different SQL Server database, if you previously created the
appropriate ODBC profile. For details, see Connect to the Domain Schema on SQL Server.
Use this procedure to connect to the As-Built schema in an owner operator domain. For
details, see Connect to the As-Built Schema.
Use this procedure to connect to a specific Project schema in an owner operator domain. For
details, see Connect to a Project Schema.
Use this procedure to connect to a specific Combined Project schema in an owner operator
domain. For details, see Connect to a Combined Project Schema.
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 Internal Setup

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 Internal Setup

Uploaded by

Copyright:

Available Formats

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

Intergraph Smart Instrumentation Internal

Internal Setup Utility

Internal Setup Commands

Close — Closes the Database Type Test and Query window.

Save As — Saves the results of an SQL Select command in a specified format.

Active only after you connect to a database.

Print — Prints the results of an SQL Select command.

Active only after you connect to a database.

(Database connection actions)

Connect — Connects to the database indicated by the parameters.

(Database query actions) — Active only after you connect to a database.

Available only from the Internal Setup window.

Create ODBC Profile — Creates an ODBC profile to configure Smart Instrumentation

Smart Instrumentation Database Structure and Schemas

Level Table Data Included Note

Admin schema Users, user groups, naming conventions, access rights

<Plant> Wiring data, custom fields

<Area> None Used as a

<Unit> Loops, instruments The software

COMPONENT table (contains instruments) at the <unit> level

Supporting tables at the domain level

PD_GENERAL table (contains process functions, such as pressure, flow, temperature,

SPEC_SHEET_DATA table (contains specification data) at the <unit> level

Referential Integrity Constraints

Database Relationship Example

The LOOP table includes the following columns:

Column Example Value Column Status

LOOP_ID 1000 Primary key

LOOP_SERV Feed to B-101 Pass A

The COMPONENT table includes the following columns:

Column Example Value Column Status

CMPNT_ID 999 Primary key

LOOP_ID 1000 Foreign key

CMPNT_SERV Heat exchanger inlet

Select component.cmpnt_name, loop.loop_name from component, loop where

Smart Instrumentation Database Schemas

The following schemas exist in Smart Instrumentation:

View-Only Domain Schema

Owner Operator Domain Schemas

Admin Schema in a SQL Server Database

Admin Schema in an Oracle Database

Assigning Administrator rights

Deleting an invalid domain

Accessing the database

Encrypting passwords of Smart Instrumentation users

Working with the tablespace list

Rebuilding catalog tables

Rebuilding stored procedures and triggers

Rebuilding domain views

By default, regardless of the database platform, the Admin schema logon

View-Only Domain Schema

Owner Operator Domain Schemas

<domain name>_e_<project id number>. The <domain name> segment corresponds to

<domain name>_c_<project id number>. The <domain name> segment corresponds to

Connecting to the Smart Instrumentation Database

If the Admin schema is encrypted, the software connects to the INTOOLS_LOGIN

a. Connects to the Admin schema.

Testing the Database Connection Common Tasks

Connect to the Admin Schema

Connect to the Domain Schema on Oracle

Connect to the Domain Schema on SQL Server

Connect to the As-Built Schema

Connect to a Project Schema