Académique Documents
Professionnel Documents
Culture Documents
Manual
ENGINEERED EFFICIENCY
Copyright
Copyright © 2002 CAXperts GmbH. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software li-
cence agree-ment; contains confidential and proprietary information of CAXperts and/or third parties which
is protected by copy-right law, trade secret law, and international treaty, and may not be provided or other-
wise made available without proper authorization.
The information and the software discussed in this document are subject to change without notice and are
subject to applicable technical product descriptions. CAXperts is not responsible for any error that may ap-
pear in this document.
The software 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, Frame-
Works, SmartPlant, INtools, MARIAN, PDS, IGDS, RIS and IntelliShip are registered trademarks of Intergraph
Corporation. IGDS file formats ©1987-1994 Intergraph Corporation. Microsoft and Windows are registered
trademarks of Microsoft Corporation. Bentley, the Bentley logo “B,” and MicroStation are registered trade-
marks of Bentley Systems, Inc. ISOGEN is a registered trademark of Alias Limited. Other brands and product
names are trademarks of their respective owners.
2
Introduction
Contents
1 Introduction ....................................................................................................... 4
1.1 General conventions .......................................................................................... 4
Typefaces ........................................................................................................... 4
Symbols .............................................................................................................. 4
2 Installation ......................................................................................................... 4
Uninstall .............................................................................................................. 5
Setup command line (for administrators) ....................................................... 5
2.1 Licence ............................................................................................................... 5
Site licence (local) ............................................................................................. 6
Floating (server) licence .................................................................................... 6
3
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
1 Introduction
The intended purpose of ReportAdapter for SmartPlant® P&ID is to perform an extrac-
tion of data used by Intergraph SmartPlant® P&ID (SPPID) into a local project database
in Microsoft Access format.
Typefaces
Italic Indicates a system response, which is an expla-
nation of what the software is doing. For example,
Bold type- Indicates what you literally type in. For example,
writer
Key in original.dat to load the ASCII file.
Symbols
This document uses the following symbols to identify special information:
2 Installation
Requirements:
4
Installation
▪ Microsoft Windows XP
▪ Microsoft Windows Server 2003
▪ Microsoft Windows Vista
▪ Microsoft Windows 7
▪ Microsoft Windows 8
▪ Microsoft Windows 10
▪ Intergraph SmartPlant P&ID 4.3 or later
Administrator rights are required on each computer to install CAXperts PID ReportA-
dapter. “Run as” is not supported.
Uninstall
To uninstall the software, 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 Pro-
grams, click Uninstall a program.
Select the program you want to remove, and click Uninstall/Remove. Alternatively, right-
click the program and select Uninstall.
This command line option also has an optional INI file 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 file to be used for the setup. The INI file
should be in the format:
[SetupValues]
%AppFolder%=C:\Program Files\MyProduct
2.1 Licence
CAXperts software supports two types of licences.
Note: The licence location (folder or server name) can be specified during the
setup process (if known already, otherwise the user may select “Continue in Demo
Mode”).
5
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
CAXperts will need your Current domain name to issue a licence file (.lic).
The licence file has to be stored on a local or network location accessible by the machine
running the CAXperts product; a licence server is not required.
The loca on of the licence file should be defined on every machine with the CAXperts product
installed, which can be done
Note: If the licence key file location is not defined, “C:\Program Files (x86)\CAX-
perts\Licensing\” is used
Note: The licence key file may be renamed (including the extension). The CAXperts
product will check the content of all files 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.
Note: Every running instance of the CAXperts software product will require one
seat, no matter if the application is running multiple times on the same or different
machine(s).
New instances can only be started as long as seats are available and the FlexNET server is acces-
sible.
The loca on of the licence server must be defined on every machine with the CAXperts product
installed, which can be done
6
Installation
Every computer name must be preceded by the @ symbol. Multiple licence server loca-
tions should be separated by semicolons (“;”).
Note: Changes to the server path (in the environment variable or registry key) are
read during the next start of the CAXperts product.
Borrowed licences
Licence seats can be borrowed for a period of time from the server and saved to the
local machine. Once the seat has been borrowed the CAXperts application can be used
without any connection to the FlexNET server.
To borrow a licence seat press the Borrow seat button, define the loan period (up to 7
days) and press OK. When the borrowed seat expires it gets automatically returned back
to the FlexNET server.
The seat can be returned earlier by pressing the Return borrowed seat button.
7
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
Note: Without a valid licence file the software will run in demo mode.
8
Graphical User Interface (GUI)
9
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
Before loading the plant data, the Output Access file needs to be specified using the
Browse... button.
All
The option All extracts all data of the plant without needing further configuration.
Selected drawings
The option Selected drawings starts the extraction with a dialog where the desired draw-
ings can be selected.
A list with available drawings from the active project will appear. Check the designated
drawings from the dialog and press OK to start the extraction.
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 option Associated data starts the extraction with a dialog where the desired data
can be defined using SQL statements.
The above statement for instance will extract only pipe runs whose tags begin with “05”.
10
Graphical User Interface (GUI)
In a similar way it is possible to only extract pipe runs with FluidSystem “Water” or Nom-
inal 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 extraction:
Revision
The option Revision allows the extraction of frozen data (only for revisions which do
have an associated version). The dialogue will allow the selection of the “Last Revision”
data or data for a specific revision:
11
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
Only equipment tag: will report only equipment tags (no nozzle tags)
No branches: will not report branch connections
Use component description if no tag: will report the Piping Component Description at-
tribute if the component tag is empty and if the component is an “EndComponent”
In addition to these settings the following changes were implemented:
In the example above all runs connected to the parts of the heat exchanger will have
“W-170” as from or to information.
12
Graphical User Interface (GUI)
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 file.
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 file).
[Settings]
DrawingAttributes=1
If this parameter is added and set to the value 1 then the check box “Add attributes” is
available in the PID ReportAdapter interface.
If the user selects it before the extraction then PID properties will be copied to the ele-
ments of the SmartSketch file (visible in the SmartSketch properties window).
Note: this operation needs a few minutes for each drawing, if performed on large
datasets we recommend to run it in batch mode.
13
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
Tables that can be used in the queries are those that will be created during extraction.
Additional tables (if needed) have to be copied before extraction to the template.mdb
database which can be found in the application folder.
14
Graphical User Interface (GUI)
When the template is used, the %TABLE1% and %COLUMN1% fields will be filled with the table
name and column name selected in the %TABLE1% and %COLUMN1% fields.
Note: The %TABLE1% and %COLUMN1% fields are filled from the Access database de-
fined for extraction output, which also includes the tables from Template.mdb. This
means, the fields are only filled after the extraction was performed once.
With the Show hidden tables field 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.
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% buttons.
User defined templates can be deleted or modified using the Remove or Edit buttons.
15
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
If the option Add manual extract info is set another window will come up before extrac-
tion, where information like revision number or a description can be added. This infor-
mation is stored in the output database and can be recalled in UniversalReporter (or
ApplicationReporter).
The field Days valid can be used to define a period during which the extracted data are
valid. After this period UniversalReporter (or ApplicationReporter) will display a warning
whenever the database is opened.
Note: Days valid has to be a positive number (or empty); all other fields are text
fields with up to 255 characters.
16
Graphical User Interface (GUI)
17
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
This allows easy filtering for instance on the Area. The selection is available on all ob-
jects with the exception of ItemNotes and OPCs.
18
Graphical User Interface (GUI)
19
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
These attributes can be used to create reports where the piperuns connected to an
equipment are listed (starting at the equipment object level) or where the instrument
connections can be identified (connections can be to piperuns or equipment nozzles).
20
Graphical User Interface (GUI)
Result:
21
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
Within a drawing the function will check if the runs are graphically connected, across
drawings the function will check if pipe runs are connected via OPCs. All results > 0 are
pointing at duplicate pipe run tags which are not graphically connected.
Warning whenever the database is opened.
Note: The extraction of the notconnected runs takes some time for larger da-
tasets.
To define more than one label for checking a semicolon must be placed between the
labels as in the example below:
Piping=\Piping\Labels - Piping Segments\Line Number.sym;\Piping\Labels - Piping Seg-
ments\Line Number_old.sym
All results different 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)
23
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
24
Graphical User Interface (GUI)
[General]
AllLoops=1
It gets calculated at extraction time and shows the value “True” for MultiRepresenta-
tion equipment and “False” for other equipment.
As-Built information
A new plant attribute called “Asbuilt-name” has been added to the _Info table so that it
is available in UniversalReporter as a parameter for the report template creation.
It gets calculated at extraction time and shows the name of the As-Built plant when data
is extracted for projects.
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 /parent-
plant PlantA /config "d:\PlantA.ini"
25
CAXperts ReportAdapter for SmartPlant® P&ID – Manual
The parameters /pbs and /unitcode must be used separately (either /pbs or /unitcode).
The attribute configuration ini file, used in the command line with the parameter /config,
can be created using the menu File - Save settings to file.
The options of "Extract Drawing Files" and "Extract From-To relations for In-
lineComp_Prun" from the interactive mode are saved in the file
%APPDATA%\CAXperts\PID ReportAdapter\config.ini
4 Technical support
Need more help? Contact CAXperts support by email, online, or phone:
mailto:support@caxperts.com
http://www.caxperts.com/contact/
26