ReportAdapter for SmartPlant P&ID

ENGINEERED EFFICIENCY

Manual

Contact & informa on:

CAXperts GmbH
Carl-Zeiss-Ring 4
85737 Ismaning Germany
P.: +49 89 96 97 72 0
F.: +49 89 96 97 72 11
E.: info@caxperts.com

CAXperts ReportAdapter for SmartPlant P&ID Manual

Copyright
Copyright 2002 CAXperts GmbH. All Rights Reserved.
Including so6ware, le formats, and audiovisual displays; may be used pursuant to applicable so6ware licence agreement; contains conden;al and proprietary informa;on of CAXperts and/or third par;es which is protected by copyright law, trade secret law, and interna;onal treaty, and may not be provided or otherwise made available without
proper authoriza;on.

Restricted Rights Legend

Rights reserved under the copyright laws of the Federal Republic of Germany.

Warran es and Liabili es

All warran;es given by CAXperts about equipment or so6ware are set forth in your purchase contract, and nothing
stated in, or implied by, this document or its contents shall be considered or deemed a modica;on or amendment
of such warran;es. CAXperts believes the informa;on in this publica;on is accurate as of its publica;on date.
The informa;on and the so6ware discussed in this document are subject to change without no;ce and are subject to
applicable technical product descrip;ons. CAXperts is not responsible for any error that may appear in this document.
The so6ware discussed in this document is furnished under a licence and may be used or copied only in accordance
with the terms of this licence. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE
USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Trademarks
CAXperts is a registered trademark of CAXperts GmbH. Intergraph, the Intergraph logo, SmartSketch, FrameWorks,
SmartPlant, INtools, MARIAN, PDS, IGDS, RIS and IntelliShip are registered trademarks of Intergraph Corpora;on. IGDS
le formats 1987-1994 Intergraph Corpora;on. Microso6 and Windows are registered trademarks of Microso6
Corpora;on. Bentley, the Bentley logo B, and MicroSta;on are registered trademarks of Bentley Systems, Inc.
ISOGEN is a registered trademark of Alias Limited. Other brands and product names are trademarks of their respec;ve
owners.

Introduc on

Contents
1

Introduc on................................................................................................................. 4
1.1

Installa on................................................................................................................... 4

2.1

Uninstall ..................................................................................................................... 5
Setup command line (for administrators) ................................................................. 5
Licence ....................................................................................................................... 5
Site licence (local) ...................................................................................................... 5
Floa;ng (server) licence ............................................................................................ 6

Graphical User Interface (GUI) ...................................................................................... 8

3.1
3.2
3.3

3.4

3.5
3.6

3.7
4

General conven;ons .................................................................................................. 4

Typefaces ................................................................................................................... 4
Symbols ..................................................................................................................... 4

Invoking ReportAdapter for SmartPlant P&ID ......................................................... 8

Loading a plant .......................................................................................................... 8
Extrac;ng data ........................................................................................................... 9
General extrac;on seQngs........................................................................................ 9
SeQngs related to the from/to calcula;on .............................................................10
Keep original tables during extrac;on.....................................................................11
ARributes on drawing objects .................................................................................12
Addi;onal SQL statements ......................................................................................12
Create addi;onal SQL statements ...........................................................................12
Use query builder ....................................................................................................13
Create new SQL query template..............................................................................14
Add manual extract info ..........................................................................................14
Congure aRributes.................................................................................................15
General func;ons ....................................................................................................15
ParentPlantGroup and UnitCode .............................................................................16
PipingPoint aRributes including ConnectedPiperunID ............................................17
CaseProcess SI values (also other proper;es SI values) ..........................................17
Filename and quan;ty .............................................................................................18
Connec;vity aRributes for the rela;ons Equipment to PipeRun and Instruments
to PipeRuns or Equipments....................................................................................19
Disconnected piperuns having the same ItemTag ...................................................21
Iden;fy number of LineNumberLabels placed on a piperun ..................................22
Command line mode ...............................................................................................23

Technical support ....................................................................................................... 24

CAXperts ReportAdapter for SmartPlant P&ID Manual

Introduc on
The intended purpose of ReportAdapter for SmartPlant P&ID is to perform an extrac;on of
data used by Intergraph SmartPlant P&ID (SPPID) into a local project database in Microso6 Access format.

1.1

General conven ons

This document contains many visual cues to help you understand the meaning of certain words
or phrases. The use of dierent fonts for dierent types of informa;on allows you to scan the
document for key concepts or commands. Symbols help abbreviate and iden;fy commonly used
words, phrases, or groups of related informa;on

Typefaces
Italic

Indicates a system response, which is an explana;on

of what the so6ware is doing. For example,
The text is placed in the viewing plane.

Bold

Indicates a command name, parameter name, or dialog box ;tle. Command paths are shown using an arrow between command names. For example,
Choose File Open to load a new le.

Normal
typewriter

Indicates an actual le or directory name. For example,

The ASCII report is stored in the layout.rpt le.

Bold typewriter

Indicates what you literally type in. For example,

Key in original.dat to load the ASCII le.

Symbols
This document uses the following symbols to iden;fy special informa;on:
Note important supplemental informa;on.
Map or path shows you how to get to a specic command or form.
More informa;on indicates there is addi;onal or related informa;on.

Installa on
Requirements:

Supported opera;ng systems:

Microso6 Windows XP

Installa on

Microso6 Windows Server 2003

Microso6 Windows Vista
Microso6 Windows 7
Intergraph SmartPlant P&ID 4.3 or later

Administrator rights are required on each computer to install CAXperts PID ReportAdapter. Run
as is not supported.

Uninstall
To uninstall the so6ware, select Control panel from the start menu. Then on in large or small
icon view, click Programs and features. If you're using category view, under Programs, click Uninstall a program.
Select the program you want to remove, and click Uninstall/Remove. Alterna;vely, right-click the
program and select Uninstall.

Setup command line (for administrators)

The following command line op;ons are supported by the installer:
/S:<<op onal ini le>>
Allow an install to be run in silent mode. As a result, no screens or dialogs will be shown.
This command line op;on also has an op;onal INI le that can be passed containing session
variable values. For example:
"C:\output\setup.exe" "/S:C:\setupvars.ini"

This will cause the session variables in the INI le to be used for the setup. The INI le should be
in the format:
[SetupValues]
%AppFolder%=C:\Program Files\MyProduct

/U:<<XML cong le>>

This command line op;on must be used when calling the uninstall program from the command
line. This command also has an op;onal XML le that can be passed containing session variable
values. For example:
"C:\Program Files\MyProduct\uninstall.exe" "/U:C:\Program Files\MyProduct\irunin.xml"

2.1

Licence
CAXperts so6ware supports two types of licences:

Site licence (local)

Domain based licences are restricted to machines within a 5 miles (8 kilometres) radius at a specic geographic loca;on (building) for which the licence key le was issued for. There is no limita;on regarding the number of users or machines.
CAXperts will need your Current domain name to issue a licence le (.lic).

CAXperts ReportAdapter for SmartPlant P&ID Manual

The licence le has to be stored on a local or network loca;on accessible by the machine running
the CAXperts product; a licence server is not required.
The loca;on of the licence le should be dened on every machine with the CAXperts product
installed, which can be done

Either by setting the environment variable

CAXPERTS_LICENSE_FILE=C:\Program Files (x86)\CAXperts\Licensing\

Or by setting the registry key

HKEY_CURRENT_USER\Software\FLEXlm License
Manager\CAXPERTS_LICENSE_FILE=C:\Program Files
(x86)\CAXperts\Licensing\

Mul;ple licence key le loca;ons should be separated by semicolons (;).

Note: If the licence key le loca;on is not dened, C:\Program Files (x86)\CAXperts\Licensing\ is used
Note: The licence key le may be renamed (including the extension). The CAXperts product will check the content of all les in the licence folder(s) for valid keys.
Note: Changes to the key path (in the environment variable or registry key) are read during the next start of the CAXperts product.

Floa ng (server) licence

Floa;ng licences require a FlexNET server (lmadmin or lmgrd) accessible by the machine running
the CAXperts product. The licence key le is typically located on the FlexNET server machine. The
licence key le denes the maximum number of seats which can be used at the same ;me.
Note: Every running instance of the CAXperts so6ware product will require one seat, no
maRer if the applica;on is running mul;ple ;mes on the same or dierent machine(s).
New instances can only be started as long as seats are available and the FlexNET server is accessible.
The loca;on of the licence server must be dened on every machine with the CAXperts product
installed, which can be done

Either by setting the environment variable

CAXPERTS_LICENSE_FILE=@YourServerName

Or by setting the registry key

HKEY_CURRENT_USER\Software\FLEXlm License Manager\CAXPERTS_LICENSE_FILE=@YourServerName

Every computer name must be preceded by the @ symbol. Mul;ple licence server loca;ons
should be separated by semicolons (;).
YourServerName is the Windows computer name of the machine running lmadmin (FlexNET

server). If lmadmin is running on a non-default port, the port number should be dened like this:
port@ YourServerName.
Note: Changes to the server path (in the environment variable or registry key) are read
during the next start of the CAXperts product.

Installa on

Borrowed licences
Licence seats can be borrowed for a period of ;me from the server and saved to the local machine. Once the seat has been borrowed the CAXperts applica;on can be used without any connec;on to the FlexNET server.

To borrow a licence seat press the Borrow seat buRon, dene the loan period (up to 7 days) and
press OK. When the borrowed seat expires it gets automa;cally returned back to the FlexNET
server.

The seat can be returned earlier by pressing the Return borrowed seat buRon.

Note: Without a valid licence le the so6ware will run in demo mode.

CAXperts ReportAdapter for SmartPlant P&ID Manual

Graphical User Interface (GUI)

3.1

Invoking ReportAdapter for SmartPlant P&ID

The u;lity can be invoked by clicking the ReportAdapter for SmartPlant P&ID from the programs menu as shown below

The following screen will appear:

3.2

Loading a plant
The so6ware automa;cally connects to the ac;ve plant. It is displayed in the eld Plant and can
be changed using the Change ac ve plant... buRon.
From the Open plant structure dialog, another plant of the ac;ve site can be selected. Plants of
others sites can be accessed by using the Site server... buRon.

Graphical User Interface (GUI)

Before loading the plant data, the Output Access le needs to be specied using the Browse...
buRon.

3.3

Extrac ng data
Using the Extract buRon starts the extrac;on from the selected plant. Dierent extrac;on op;ons are available: All, Selected drawings, Associated data, Extract drawing les.

General extrac on se>ngs

All
The op;on All extracts all data of the plant without needing further congura;on.
Selected drawings
The op;on Selected drawings starts the extrac;on with a dialog where the desired drawings can
be selected.
A list with available drawings from the ac;ve project will appear. Check the designated drawings
from the dialog and press OK to start the extrac;on.

In Connected Workshare projects drawings which belong to the satellite are displayed in red so
that the user is informed about the status of the drawings.
Associated data
The op;on Associated data starts the extrac;on with a dialog where the desired data can be
dened using SQL statements.

CAXperts ReportAdapter for SmartPlant P&ID Manual

The above statement for instance will extract only pipe runs whose tags begin with 05.
In a similar way it is possible to only extract pipe runs with FluidSystem Water or Nominal
Diameter 100 mm.
The same interface can also be used to search data for instance if a certain Sequence Number
has been used in the plant (the yellow bar can be used to key in a search string) without performing the extrac;on:

Extract drawing les

The op;on Extract drawing les copies the drawing les to a folder called igr located at the
same level as the mdb le and renames the drawings to .igr.
Note: The version of SmartSketch must be compa;ble to the version of SmartPlant P&ID
otherwise the highlight func;on in UniversalReporter will not work.

Se>ngs related to the from/to calcula on

The following op;ons can be used when extrac;ng the from/to informa;on:

Only equipment tag: will report only equipment tags (no nozzle tags)

10

Graphical User Interface (GUI)

No branches: will not report branch connec;ons

Use component descrip on if no tag: will report the Piping Component Descrip;on aRribute if
the component tag is empty and if the component is an EndComponent
In addi;on to these seQngs the following changes were implemented:
Tema heat exchangers
If the front and rear sec;ons do not have an own item tag dened then the shell item tag will
also be extracted as From/To informa;on for pipe runs connected to the front or the rear sec;on.
In the example above all runs connected to the parts of the heat exchanger will have

W-170 as from or to informa;on.

Equipment with no tag
For equipment with no tag it is possible to use a variable which will tell the so6ware which attribute to use as from/to informa;on (Name or Descrip;on etc.).
This is done using the PID ReportAdapter ini le:
\Program Files(x86)\CAXperts\PID ReportAdapter\PID ReportAdapter.ini
[FROM_TO]
Equipment_NoTag=Name

Keep original tables during extrac on

For customers who want to keep the original tables which are created during the extrac;on there
is a seQng in the PID ReportAdapter ini le which can be used to prevent dele;on of the original
tables:
[Settings]
Pid_Delete_TempTables=0

11

CAXperts ReportAdapter for SmartPlant P&ID Manual

If this parameter is added and set to the value 0 then the tables will not be deleted and in tables
like t_equipment, t_piperun etc. will be available in the mdb le.
If the value is set to 1 then the tables will be deleted (this is the default behaviour if the parameter is not included in the ini le).

ABributes on drawing objects

A seQng was implemented which is ac;va;ng a check box for drawing extrac;on:

[Settings]
DrawingAttributes=1

If this parameter is added and set to the value 1 then the check box Add aRributes is available
in the PID ReportAdapter interface.
If the user selects it before the extrac;on then PID proper;es will be copied to the elements of
the SmartSketch le (visible in the SmartSketch proper;es window).

Note: this opera;on needs a few minutes for each drawing, if performed on large datasets
we recommend to run it in batch mode.

3.4

Addi onal SQL statements

Create addi onal SQL statements

SQL statements to extend standard output tables with user dened aRributes or to perform
some other tasks (like crea;ng addi;onal tables, queries) can be dened using Tools Addional SQL statements. They will be executed automa;cally a6er the extrac;on process has been
completed.

12

Graphical User Interface (GUI)

The addi;onal SQL statements can be typed in the Addi onal SQL statements to be processed
aEer extrac on eld. They have to look like the following examples
SQL1=ALTER TABLE Equipment ADD COLUMN [MyAttribute] VARCHAR(255)
SQL2=UPDATE [Equipment] SET [MyAttribute] = 'Test'

Tables that can be used in the queries are those that will be created during extrac;on. Addi;onal
tables (if needed) have to be copied before extrac;on to the template.mdb database which can
be found in the applica;on folder.

Use query builder

The included query builder can assist to create the SQL statements. Create a new statement with
the Add buRon and add one of the Available SQL query templates to it. Add query or doubleclick on a list item will add the query at the cursor posi;on or replace the selected text.
The Available SQL query templates look like:
UPDATE [%TABLE1%] SET [%TABLE1%].[%COLUMN1%]=

When the template is used, the %TABLE1% and %COLUMN1% elds will be lled with the table name
and column name selected in the %TABLE1% and %COLUMN1% elds.
13

CAXperts ReportAdapter for SmartPlant P&ID Manual

Note: The %TABLE1% and %COLUMN1% elds are lled from the Access database dened for
extrac;on output, which also includes the tables from Template.mdb. This means, the elds
are only lled a6er the extrac;on was performed once.
With the Show hidden tables eld checked, all tables of the database can be selected to build
the query. If it is not checked, only tables that will be displayed in UniversalReporter are available
and tables created for internal use are hidden.

Create new SQL query template

User dened SQL query templates can be created. To add a new template, click the Add buRon
and enter the template name.

Fill in the text of SQL statement and the placeholders for Tables and columns to be used by
query textboxes by using the %TABLE1% and %COLUMN1% buRons.
User dened templates can be deleted or modied using the Remove or Edit buRons.
Note: The SQL text boxes support syntax highligh;ng.

3.5

Add manual extract info

Under Tools Se>ngs the user can congure whether he wants to enter addi;onal informa;on
that will be stored together with the extracted data. Only if Add manual extract info is checked,
addi;onal informa;on can be added before extrac;on.
If Keep last values is checked, the Informa on window will be lled with the values last used for
the selected plant.

14

Graphical User Interface (GUI)

If the op;on Add manual extract info is set another window will come up before extrac;on,
where informa;on like revision number or a descrip;on can be added. This informa;on is stored
in the output database and can be recalled in UniversalReporter (or Applica onReporter).
The eld Days valid can be used to dene a period during which the extracted data are valid.
A6er this period UniversalReporter (or Applica onReporter) will display a warning whenever
the database is opened.
Note: Days valid has to be a posi;ve number (or empty); all other elds are text elds
with up to 255 characters.

3.6

Congure aBributes

General func ons

Select Tools -> ABribute congura on... to open the ABribute congura on dialog.

The following window appears.

15

CAXperts ReportAdapter for SmartPlant P&ID Manual

In this dialog it is possible to dene aRributes to be extracted.

At present the aRributes can be added for six objects, namely Inlinecomp_prun, Eqp_Nozzle,
Plan;tems, Instruments, ItemNotes, OPCs and Drawings.
Expand the tables and select the required aRributes which can be transferred or removed from
the ARributes to be used pane using > or < buRons.
The aRribute congura;on will be saved in the folder %APPDATA%\CAXperts\PID ReportAdapter\ with the name PlantName.ini. The aRribute congura;on can also be saved for
backup or for batch mode extrac;on using:

ARribute congura;on special;es:

ParentPlantGroup and UnitCode

For SPEM Hierarchies like Plant\Area\Unit it is possible to extract the Parent PlantGroup informa;on and also the UnitCode informa;on:

16

Graphical User Interface (GUI)

This allows easy ltering for instance on the Area. The selec;on is available on all objects with
the excep;on of ItemNotes and OPCs.

PipingPoint aBributes including ConnectedPiperunID

For the piping connect points 1 to 4 it is possible to extract aRributes like nominal diameter,
descrip;on etc. but also the SP_ID of the connected pipe run. This informa;on can be used to
create a report which displays the pipe run connected to the second side of a pressure reducing
valve.

The result in UniversalReporter will look like this:

CaseProcess SI values (also other proper es SI values)

The SI values can also be selected for extrac;on.

17

CAXperts ReportAdapter for SmartPlant P&ID Manual

Filename and quan ty

If Filename is selected (on the PlantItem object level) then the symbol name will also be
extracted and it is possible to see how o6en a symbol is placed on a drawing.
If Quan;ty is selected (available on all object levels) then each extracted object will receive the
quan;ty of 1 and in UniversalReporter it is possible to create Sum_of_quan;ty to iden;fy
the total amount of valves for instance.

18

Graphical User Interface (GUI)

Connec vity aBributes for the rela ons Equipment to PipeRun and Instruments to PipeRuns or
Equipments
Even though not visible in the aRribute congura;on interface the following two aRributes are
extracted:

Nozzle_ConnectedPipeRunID for the Eqp_Nozzle table

Instrument_ConnectedItemID for the Instruments table

These aRributes can be used to create reports where the piperuns connected to an equipment
are listed (star;ng at the equipment object level) or where the instrument connec;ons can be
iden;ed (connec;ons can be to piperuns or equipment nozzles).

Example for the Equipment_PipeRun Rela on:

Example for the Instrument Connec on Report:

There are mul;ple ways to connect instruments to nozzles or piperuns.
The following connec;ons (related to piping components placed between the connected piperun or the connected equipment nozzle and the instrument) have been modied in PID ReportAdapter:
A: Instrument is connected to a valve which is placed in a branch of the main piperun; the branch
will return as connected object
B: Instrument is connected to a valve which is connected to a nozzle (the piperuntype is Conn to
process/Supply); here the nozzle will return as connected object
C: Instrument is connected to t valve which is connected via ZeroLength piperun to a nozzle;
here the nozzle will return as connected object

19

CAXperts ReportAdapter for SmartPlant P&ID Manual

D: Instrument is connected to a valve which is placed in a piperun which is connected to a nozzle;

the piperun has a special linetype; here the nozzle will return as connected object (in the example below the linetype is Components only)
The deni;on of the piperun type can be done in ..\PID ReportAdapter.ini with the following
seQng:
[Instr_Conn]
Nozzle_Pruntype = Components only

Details for C and D:

Result:

20

Graphical User Interface (GUI)

Disconnected piperuns having the same ItemTag

If NotConnectedRuns is selected (on the InlineComp_Prun object level below Others) then
the number of disconnected piperuns having the same Tag will be calculated for the extracted
dataset.

Within a drawing the func;on will check if the runs are graphically connected, across drawings
the func;on will check if pipe runs are connected via OPCs. All results > 0 are poin;ng at duplicate pipe run tags which are not graphically connected.
Warning whenever the database is opened.
Note: The extrac;on of the notconnected runs takes some ;me for larger datasets.

21

CAXperts ReportAdapter for SmartPlant P&ID Manual

Iden fy number of LineNumberLabels placed on a piperun

For all piperuns except InstrumentRuns and ZeroLength piperuns if the aRribute NumberofLabels is selected and the Label Name is dened in the Plant Specic ini le then the number of
labels placed on each pipe run will be calculated during extrac;on.

In the ini le (.UserProle\Appdata\Roaming\CAXperts\PID ReportAdapter\

<PlantName>.ini the rela;ve path for the line label to be checked must be added:

All results dierent than 1 are the ones to be checked (0 means no label is placed, >1 means
more than 1 label is placed on the same run.

22

Graphical User Interface (GUI)

3.7

Command line mode

PID ReportAdapter can also be used in command line mode, to extract all data from a plant to
an mdb le automa;cally from a batch script. Use the following command to show the command
line arguments:

Command line arguments:

Example:
"C:\Program Files\CAXperts\PID ReportAdapter\PID ReportAdapter.exe" /output
"c:\temp\PlantA.mdb"
"C:\Program Files\CAXperts\PID ReportAdapter\PID ReportAdapter.exe" /output
"c:\temp\PlantA.mdb" /site "d:\Site1\smartplantv4.ini" /plant PlantA /parentplant PlantA /config "d:\PlantA.ini"
"C:\Program Files\CAXperts\PID ReportAdapter PID ReportAdapter.exe" /output
d:\temp\1.mdb /pbs Refining Area\Recovery Unit;\Refining Area\Distillation
Unit\a_*
will save all drawings having names star;ng with a_ and located in the Rening
Area\Recovery Unit or Rening Area\Dis;lla;on Unit

"C:\Program Files\CAXperts\PID ReportAdapter PID ReportAdapter.exe" /output

d:\temp\1.mdb /unitcode 03
will save all drawings located beneath the unit with unit code 03

The parameters /pbs and /unitcode must be used separately (either /pbs or /unitcode).

The aRribute congura;on ini le, used in the command line with the parameter /config, can
be created using the menu File Save se>ngs to le.
The op;ons of "Extract Drawing Files" and "Extract From-To rela;ons for InlineComp_Prun" from
the interac;ve mode are saved in the le
%APPDATA%\CAXperts\PID ReportAdapter\config.ini

23

CAXperts ReportAdapter for SmartPlant P&ID Manual

(e.g.

C:\Documents and Settings\UserName\Application Data\CAXperts\PID Re-

portAdapter\config.ini). For the command line mode, the two op;ons will be read from the

cong.ini and will be used for the extrac;on.

Technical support
Need more help? Contact CAXperts support by email, online, or phone:
mailto:support@caxperts.com
hRp://www.caxperts.com/contact/

24