manual_reportadapter for smartplant 3d [en]

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.: [email protected]

EN

GIN

EE

RE

D E

FF

ICIE

NC

Y

ReportAdapter for SmartPlant® 3D Manual

CAXperts ReportAdapter for SmartPlant® 3D – Manual

2

Copyright

Copyright © 2002 CAXperts GmbH. All Rights Reserved.

Including so6ware, file formats, and audiovisual displays; may be used pursuant to applicable so6ware licence agree-

ment; contains confiden;al and proprietary informa;on of CAXperts and/or third par;es which is protected by copy-

right 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 modifica;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

file 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

3

Contents

1 Introduc on ................................................................................................................. 4

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

Typefaces ................................................................................................................... 4

Symbols ..................................................................................................................... 4

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

Uninstall ..................................................................................................................... 5

Setup command line (for administrators) ................................................................. 5

2.1 Licence ....................................................................................................................... 5

Site licence (local) ...................................................................................................... 5

Floa;ng (server) licence ............................................................................................ 6

3 ReportAdapter for SmartPlant® 3D ............................................................................... 8

3.1 SeOng up ReportAdapter for SmartPlant® 3D .......................................................... 8

Select plant ................................................................................................................ 8

Select filter ................................................................................................................. 8

Select output ............................................................................................................. 9

3.2 Configure aQributes ................................................................................................... 9

Add new table.......................................................................................................... 10

AQribute set ............................................................................................................. 11

Add new aQribute set .............................................................................................. 11

Add new aQribute.................................................................................................... 11

Edit aQribute set proper;es .................................................................................... 11

Extended aQribute seOngs ..................................................................................... 12

Find .......................................................................................................................... 13

3.3 Extrac;on Geometry ............................................................................................... 14

Prerequisites ............................................................................................................ 14

3.4 Generate VUE file .................................................................................................... 15

3.5 Extrac;on ................................................................................................................. 15

3.6 Addi;onal SQL statements ...................................................................................... 15

Create addi;onal SQL statements ........................................................................... 15

Use query builder .................................................................................................... 16

Create new SQL query template .............................................................................. 17

3.7 SeOngs .................................................................................................................... 17

General .................................................................................................................... 18

Surface style rules .................................................................................................... 19

Drawings .................................................................................................................. 19

Load seOngs from file ............................................................................................. 20

Save seOngs to file .................................................................................................. 20

3.8 Command line mode ............................................................................................... 21

4 Technical support ....................................................................................................... 21


4

1 Introduc on

ReportAdapter for SmartPlant® 3D is designed to export a SmartPlant 3D aQributes and grafic

into a SQL Lite database, containing one table per task. The resul;ng records are compressed

and internally resolved by code lists.

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 different fonts for different 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 dia-

log box ;tle. Command paths are shown using an ar-

row between command names. For example,

Choose File → Open to load a new file.

Normal

typewriter

Indicates an actual file or directory name. For exam-

ple,

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

Bold type-

writer

Indicates what you literally type in. For example,

Key in original.dat to load the ASCII file.

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 specific command or form.

More informa;on – indicates there is addi;onal or related informa;on.

2 Installa on

Requirements:

▪ Supported opera;ng systems:

▪ Microso6 Windows Server 2008, 2012

Installa�on

5

▪ Microso6 Windows 7, 8

▪ Intergraph SmartPlant 3D 2009 SP5 or later

Administrator rights are required on each computer to install CAXperts ReportAdapter for

SmartPlant® 3D. “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 Un-

install 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 file>>

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

/U:<<XML config file>>

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 file that can be passed containing session variable

values. For example:

"C:\Program Files\MyProduct\uninstall.exe" "/U:C:\Program Files\MyProd-

uct\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 spe-

cific geographic loca;on (building) for which the licence key file was issued for. There is no limi-

ta;on regarding the number of users or machines.

CAXperts will need your Current domain name to issue a licence file (.lic).


6

The licence file 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 file should be defined 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 file loca;ons should be separated by semicolons (“;”).

Note: If the licence key file loca;on is not defined, “C:\Program Files (x86)\CAXperts\Li-

censing\” is used

Note: The licence key file may be renamed (including the extension). The CAXperts prod-

uct 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 dur-

ing 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 file is typically located on the FlexNET server machine. The

licence key file defines 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

maQer if the applica;on is running mul;ple ;mes 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

• Either by setting the environment variable CAXPERTS_LICENSE_FILE=@YourServerName

• Or by setting the registry key HKEY_CURRENT_USER\Software\FLEXlm License Manager\CAXPERTS_LI-

CENSE_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 defined 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

7

Borrowed licences

Licence seats can be borrowed for a period of ;me from the server and saved to the local ma-

chine. Once the seat has been borrowed the CAXperts applica;on can be used without any con-

nec;on to the FlexNET server.

To borrow a licence seat press the Borrow seat buQon, define 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 buQon.

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


8

3 ReportAdapter for SmartPlant® 3D The ReportAdapter for SmartPlant® 3D is used to extract SmartPlant 3D data out of an exis;ng

project like Material-Take-Off (MTO) of all SmartPlant 3D. The extrac;on of all data can be done

without any knowledge of SP3D specific Report Crea;on. The philosophy is to use the

SmartPlant 3D Workspace Filters for crea;on of discipline specific reports.

Note: ReportAdapter for SmartPlant® 3D requires SmartPlant 3D and a SmartPlant 3D

(S3D) licence seat on a SmartPlant Licence Server.

3.1 Se;ng up ReportAdapter for SmartPlant® 3D

Select plant

Start ReportAdapter for SmartPlant® 3D and select your Model Plant from the Plant Combo Box:

Note: Only plants of the current site are displayed.

Select filter

To select a filter, click on the Filter Combo Box and select More filters….

ReportAdapter for SmartPlant® 3D

9

A window will open where all filters are listed, please select filter and click OK.

Select output

Browse with the Browse… buQon to select a loca;on to create a Microso6 Access Database file

in which the results will be shown.

All the seOngs are stored automa;cally in the configura;on file which is found under Tools →

Se;ngs.

3.2 Configure a>ributes

ReportAdapter for SmartPlant® 3D contains a predefined set of aQributes which are reported

by default. Addi;onally customer can define and configure own aQributes. No database specific

or programming knowledge is required for customiza;on of reportable Smart Plant 3D aQrib-

utes. A table is a combina;on of aQribute sets, columns with iden;cal names will be ver;cally

aligned.


10

Add new table

To add a new table, right click in right panel and click New table

From here user can ac-

cess all aQributes from

Smart Plant 3D

Right side contains the al-

ready predefined aQributes

per discipline


11

A>ribute set

Each table consists of one or more aQribute sets. Each aQribute set holds the data for a specific

top node. The result of one or more aQribute sets is grouped together in the table they belong

to in the output database.

Add new a>ribute set

To add a new table, right click on a table and click New a>ribute set

Add new a>ribute

Drag and drop an aQribute to the table on the right side. The aQribute will then appear under

the AQribute set.

Edit a>ribute set proper es

To set the proper;es of a table, right click on the aQribute set and select Proper es.


12

The type selected here defines the main item used for repor;ng, e.g. pipe component → run:

pipe component selected → only runs that belong to the component are listed; run selected →

also empty runs get listed.

Press OK to finish the configura;on.

Note: The changes will be applied on the next extrac;on

Note: SmartPlant 3D labels can be used similar to the direct object aQributes.

Extended a>ribute se;ngs

Click with the right mouse buQon on a code listed aQribute to open extended aQribute configu-

ra;on form:

Code listed aQributes can be extracted as:

▪ Numeric values


13

▪ Values decoded by short descrip;on

▪ Values decoded by long descrip;on (default)

For Values with Units, the Units can be chosen:

Note: The changes will be applied on the next extrac;on.

Find

Select Find… from the Edit menu to search for the available aQributes:

Enter the search text in Find what and define the task name in Look in to search for the aQribute

in the given task:


14

3.3 Extrac on Geometry

ReportAdapter for SmartPlant® 3D allows extrac;on of geometry from Smart 3D, which is used

by CAXperts Universal Plant Viewer and CAXperts S3D2PDS so6ware.

Tick on Extract Geometry op;on and select exis;ng 3D DGN drawing.

Prerequisites

1. Bentley MicroSta;on J (V7) has to be installed on the Worksta;on.

2. Empty 3D DGN-drawing has to be created through the Smart 3D Drawing Console, e.g.

like this:

This 3D DGN Drawing is by ReportAdapter for SmartPlant® 3D for the geometry ex-

trac;on. The user needs the permission to update this drawing.

3. Permission to create new filter in the folder (“Plant filters\3D ReportAdapter” by default).


15

4. Write permissions on Shared Content (Drawings\Catalog\Rules) to able create new

View/Style rules.

Technical Hint regarding MicroSta;on limita;on:

The extrac;on of geometry using ReportAdapter for SmartPlant® 3D is based on Intergraph

Smart 3D export to 3D DGN file and has the same limita;ons: only graphical model data in a

range of -26843 m to 26843 m in XYZ direc;on (for M/MM dgn-seed-file) and from -88069 '

to 88069 ' in XYZ direc;on (for '/" dgn-seed.file) are exported into MicroSta;on-files. Model

data out of this range are not exported.

3.4 Generate VUE file

If enabled, ReportAdapter for SmartPlant® 3D generates VUE file with aQributes as defined in

aQributes configurator.

Note: Intergraph Schema Component is required to generate VUE fie.

3.5 Extrac on

To start extrac;on of aQributes and geometry if enabled click on Extract.

3.6 Addi onal SQL statements

Create addi onal SQL statements

SQL statements to extend standard output tables with user defined aQributes or to perform

some other tasks (like crea;ng addi;onal tables, queries) can be defined using Tools → Addi-

onal SQL statements. They will be executed automa;cally a6er the extrac;on process has been

completed.

The addi;onal SQL statements can be typed in the Addi onal SQL statements to be processed

aGer extrac on field. They have to look like the following examples

SQL1=ALTER TABLE Equipment ADD COLUMN [MyAttribute] VARCHAR(255)

SQL2=UPDATE [Equipment] SET [MyAttribute] = 'Test'


16

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 buQon and add one of the Available SQL query templates to it. Add query or double-

click 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% 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 defined for

extrac;on output, which also includes the tables from Template.mdb. This means, the fields

are only filled a6er the extrac;on was performed once.


17

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.

Create new SQL query template

User defined SQL query templates can be created. To add a new template, click the Add buQon

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 %TABLE"1% and %COLUMN1% buQons.

User defined templates can be deleted or modified using the Remove or Edit buQons.

Note: The SQL text boxes support syntax highligh;ng.

3.7 Se;ngs

All program seOngs (selected tasks and filters, aQributes, units of measure …) are stored auto-

ma;cally for each plant in the configura;on file located by default in the user profile folder. The

loca;on of the configura;on file can be changed by using menu Tools>Se;ngs.


18

General

Add manual extract info: if enabled shows following dialog before extrac;on where the user can

provide addi;onal informa;on evaluated by CAXperts UniversalReporter.


19

Clean-up style rules and filter before extrac on (don’t use parallel extrac ons): if geometry

extrac;on is enabled this op;on removes all temporary style-rules and filters might le6 from last

run of the so6ware. In normal case You must not use this op;on when you run more the one

extrac;on of ReportAdapter for SmartPlant® 3D on your project at the same ;me.

Surface style rules

The colour is set in a standard S3D Surface Rule Style that is preconfigured from S3D Surface Rule

Style seOngs. You can define here for the different aspects of the par;cular object type the Mi-

croSta;on levels.

Select the rules to apply from the list of available Surface Rule Style on le6 hand side and press

Add buQon.

The rules are executed top->boQom. If no Style rules defined standard colours and MicroSta-

;on levels are used.

Drawings

Defines Isometric and Composed drawings to extract.


20

Load se;ngs from file

To import the seOngs into the plant configura;on file use menu File → Load se;ngs from file.

Note: The loca;on of the plant configura;on file is not affected, only the content of the

file will be overwriQen

Save se;ngs to file

To export the seOngs from the plant configura;on file use menu File → Save se;ngs to file.

Note: The loca;on of the plant configura;on file is not affected

Technical support

21

3.8 Command line mode

The ReportAdapter for SmartPlant® 3D can be used from the command line to automate the

exporta;on of a SmartPlant 3D data.

To then open the ReportAdapter batch mode help type in the installa;on path of ReportAdapter

followed by “\3D ReportAdapter.exe” /?

C:\ ”C:\Program Files\CAXperts\3D ReportAdapter\3D ReportAdapter.exe” /?

"3D ReportAdapter.exe" [-plant:ExamplePlant] [-config:c:\config_file.ini]

[-filter:My Filters\Filter1] [-output:output_file.mdb] [-cleanrules]

[-drawing:Plant\New 3D DGN Drawings\Drawing-0001] [-extractgeometry]

-plant plant_name SmartPlant 3D plant to process

-config config_file.ini Config file which contains the seOngs for the extrac-

;on. If a configura;on file is not defined, the last con-

figura;on will be used

-filter filter_name Filter name from S3D Plant. Can be a Plant Filter or

from My Filters. If a filter is not defined, the last config-

ura;on will be used

-output output_file.mdb Output database. If Output database is not defined,

the last configura;on will be used

-cleanrules Clean le6over temporary S3D3PDS-specific rules. This

is an op;onal seOng.

-drawing Path to the 3D DGN-Drawing from S3D Drawing con-

sole

-extractgeometry If this switch is set, S3D2PDS generates a PD_XPDA

Backup file.

4 Technical support

Need more help? Contact CAXperts support by email, online, or phone:

mailto:[email protected]

hQp://www.caxperts.com/contact/

manual_reportadapter for smartplant 3d [en]

Documents