Explant-i User Guide

7/27/2019 Explant-i User Guide

1/28

ExPLANT-I

User Guide


2/28

Disclaimer

Information of a technical nature, and particulars of the product and its use, is given by AVEVASolutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim

any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.

Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person orentity for any actions, claims, loss or damage arising from the use or possession of any information,particulars, or errors in this publication, or any incorrect use of the product, whatsoever.

Copyright

Copyright and all other intellectual property rights in this manual and the associated software, and everypart of it (including source code, object code, any data contained in it, the manual and any otherdocumentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.

All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in

this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrievalsystem, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where suchpermission is granted, it expressly requires that this Disclaimer and Copyright notice is prominentlydisplayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any materialor electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also notreverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of theproduct described in this publication may be incorporated into any third-party software, product,machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted bylaw. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminalprosecution.

The AVEVA products described in this guide are to be installed and operated strictly in accordance withthe terms and conditions of the respective license agreements, and in accordance with the relevantUser Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.

First published September 2007

AVEVA Solutions Ltd, and its subsidiaries

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

Trademarks

AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised

use of the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or itssubsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trade mark rights, or other intellectual property rights in any other product, its name orlogo belongs to its respective owner.

AVEVA Solut ions Ltd


3/28

ExPLANT-I User Guide

Contents Page

12.0i


ExPLANT-I

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

How this Guide is Organised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Manual or Network Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Transfer from DESIGN to MicroStation . . . . . . . . . . . . . . . . . . . . . . . 2:1

Choose a Seed File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Create a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Prepare the Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Colours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Graphic Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Set the Uni ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Set the Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Running ExPLANT-I . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4

Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

ExPLANT-I Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Example Configuration File for HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Structure of the Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Select the Output Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3


4/28

12.0ii


Switch the Attribute File On or Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Switch the DGN File On or Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Define the Output Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4Link to the DGN File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Define the Head and Foot of the Attribute File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Define the Head and Tail of an Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Define the Format of an Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Variables Available. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Set the Output Uni ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6

Select At tributes for Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Choose Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Choose Multiple Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8Choose Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Change the Tag in the Attribute File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Reference Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9

Attributes of Other Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9

Using WRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10

Miscellaneous Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10

Control Cell Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10

ImPlant - I and Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10

Limitations, Warning and Error Messages . . . . . . . . . . . . . . . . . . . . 4:1

Geometry Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2


5/28


Introduction

12.01:1

1 Introduction

The AVEVA ExPLANT-I Export Driver allows the user to extract 3D geometric models fromthe DESIGN databases and output them in a binary file (called a dgn file) compatible withMicroStation according to the Intergraph Standard File Format Specification. The resultingfile can then be used to import 3D graphics models into MicroStation or into other systems

that can read dgn format files.

Version 1.4.x of AVEVA ExPLANT-I can be used to transfer information from AVEVA PDMSand also includes the capability to create a highly configurable text file, linked to the dgn file,containing the PDMS attribute values.

Note: AVEVA ExPLANT-I Version 1.4 will only convert models into dgn Version 7 format.This format can be read by more recent versions of MicroStation (which use adifferent native file format).

1.1 Before You Begin

It is assumed that you are familiar with the following:

PDMS - in particular the DESIGN module.

Operating system functions such as installing software from CD-ROM/DVD, creatingand editing files and directories/folders

For general information on using the Export facilities in PDMS, refer to DESIGN ReferenceManual: Utilities.

1.2 How this Guide is Organised

This guide is divided into chapters as follows:

1.3 Installation

ExPLANT-I is supplied as an installation option of the AVEVA PDMS DVD.

Transfer from DESIGN toMicroStation

explains transferring geometric information from DESIGN toMicroStation

ExPLANT-I Configuration

File

explains creating an ExPLANT-I configuration file

Limitations, Warning and

Error Messages

explains Limitations, Warning and Error Messages


6/28

12.01:2


Introduction

1.4 Manual or Network Instal lat ion

It is possible to copy ExPLANT-I from one machine to another, for example as part of an

automated deployment using SMS. In order to do this you must:

Copy explant.dll (installed into %PDMSEXE%, to the target %PDMSEXE% folder. You mustbe sure that the version of explant.dll is compatible with the version of PDMS.

Make sure that a suitable seedfile is available, either locally or across a network.


7/28


Transfer from DESIGN to MicroStation

12.02:1

2 Transfer from DESIGN to MicroStat ion

The AVEVA ExPLANT-I Export Driver can be used to transfer geometric information from aDESIGN database into a format suitable for input into MicroStation and to write attributedata into a linked text file.

2.1 Choose a Seed File

ExPLANT-I needs a seed file which is a .dgn used as a header for all the generated dgnfiles, and contains settings such as the units to be used in the dgn file.

You can supply ExPLANT-I with a seedfile in either of two ways:

If the environment variable SEED3D_DIR is set to a folder-path, then ExPLANT-I willlook in that folder for as file named seed3d.dgn., for example:

set SEED3D_DIR= %PDMSEXE%

This is particularly useful if you always use the same seed file. In that case you couldadd this set command to your PDMS batch files: set SEED3D_DIR=%PDMSEXE%\ExPLANT-I.

You can use the export opt ion 'seedfile' command in DESIGN to set thepath of the seed file (note that the path of the file is needed, not the path of the folder,as in the case of the environment variable). For example

export option 'seedfile' 'C:\seedfiles\seed1.dgn'

This is particularly useful if you use different seed files for different exports.

2.2 Create a Configurat ion Fi le

If you wish to export attribute data you must create a configuration file. This defines theformat of the attribute file and specifies which DESIGN elements and particular attributesare to be output.

The contents of the Configuration file are described in ExPLANT-I Configuration File.

2.3 Prepare the Transfer

To translate a model file into MicroStation format you must use the AVEVA ExPLANT-IExport Driver from within DESIGN module. However, before you start DESIGN you must toinitialise a number of environment variables to appropriate values. Although the commandscan be typed in, it is recommended that the commands be invoked automatically at the startof each session.

Note: To use a configuration file, either the environment variableEXPLANT_CONFIGURATION must be set to the path of the configuration file; or the


8/28

12.02:2



PDMS command export option 'configuration' '' must be called to setup a temporary path to the configuration file.

2.4 Colours

When selecting geometry for output from DESIGN, the user can choose a colour that isassociated with each element or group of elements. Provided that the DESIGN colournumber is in the range 1-63, then that number will be used as the level number in the dgnfile. If the PDMS colour is outside that range, then a default dgn level number of 1 will beused.

2.5 Graphic Group

When exporting equipment and structural elements, AVEVA ExPLANT-I will use a different

dgn graphic group number for each piece of equipment or structural element. It should benoted that because some hierarchy information is not available to AVEVA ExPLANT-I, thenthere are some circumstances where the graphic group is not always correctly set.

2.6 Set the Units

The exported data units are set from the working units in the seed file in use. The standardseed file supplied with AVEVA ExPLANT-I has mm as the working units but metres, feet andinches can also be recognised if a different seed file is used.

In a DGN file the working units are described in terms of:

1. Master units, these can be named

2. Sub-units, these can be named

3. Resolution units (these are not named)

4. Number of sub-units per master unit

5. Number of resolution units per sub-unit

Firstly, AVEVA ExPLANT-I checks the master units name for millimetres (MM or mm),metres (M or m), feet (FT, ft or ) or inches (IN, in or ) for a positive match and if it finds onewill set the scaling accordingly.

If there is no positive match, it then checks the sub-unit name against the same unit namesand if it finds a match sets the scaling from the sub-unit and the number of sub-units permaster unit.

If the units in the seed file are not recognised, the default is to assume MM.

2.7 Set the Representation

The Export command was designed as a what-you-see-is-what-you-get system, where thevisibility and representation settings in DESIGN control what is exported. This enables youto select certain elements of the database for export, and to choose an appropriate level ofdetail for your needs.

If you are operating in a graphical mode, and working with relatively small volume of datathis is ideal. When exporting large models the close integration with the graphical displaycan result in slow performance.


9/28

12.0



2:3

In this case you can speed up the export significantly by running DESIGN without graphics.It is then very important to ensure that the visual representation is set to what you require(note that DESIGNs default settings are different when you are running without graphics).

We suggest that you do the following:

1. Read 4.2 Element Representation of the DESIGN Reference Manual: GeneralCommands, which discusses the options available.

2. Using DESIGN with graphics enabled, set the representation to your requirements,using either the menus or commands.

3. Activate the PDMS Command Line window (Menu Display -> Command Line)

4. Type the command:

Q REPR

5. Note the results, for example:

Cent r el i ne Of f

Tube OnObst r uct Of fI nsul at i on Of fHol e Of fPpoi nt s Of fPpoi nt Length 50mmPpoi nt Numbers Of fRepr esent at i on l evel 6Repr esent at i on l evel PI PE 6Repr esent at i on l evel NOZZ 6Repr esent at i on l evel STRU 6Mass Pr oper t i es Det ai l l evel 6Pnode OnPnode si ze 100mmPnode col our 22Snode OnSnode si ze 50mmSnode col our 31Poi nt s Of fPl i ne Of fPl i ne l engt h 50mmPkey Of f

6. Leave DESIGN, and re-enter, but without graphics (by typing dev tty to Monitor)

7. Type Q REPR again, note the results, for example:

Cent r el i ne Of fTube OnObst r uct Of fI nsul at i on Of fHol e Of fPpoi nt s Of fPpoi nt Length 50mmPpoi nt Numbers Of fRepr esent at i on l evel 0Repr esent at i on l evel PI PE 0Repr esent at i on l evel NOZZ 0Repr esent at i on l evel STRU 0Mass Pr oper t i es Det ai l l evel 0Pnode On


10/28

12.02:4



Pnode si ze 10mmPnode col our Vi si bl eSnode On

Snode si ze 10mmSnode col our Vi si bl ePoi nt s Of fPl i ne Of fPl i ne l engt h 50mmPkey Of f

8. Look at the differences, in this case:

Repr esent at i on l evel 6Repr esent at i on l evel PI PE 6Repr esent at i on l evel NOZZ 6Repr esent at i on l evel STRU 6Mass Pr oper t i es Det ai l l evel 6

Pnode si ze 100mmPnode col our 22Snode si ze 50mmSnode col our 31

9. Either include all of these representation commands in your PDMS macro file (seebelow), or select those you do need using the DESIGN Reference Manual as a guide.

2.8 Running ExPLANT-I

To translate a model file into a MicroStation input file you must be in the DESIGN module.

If the model that you are going to export is large, then it will be a lot quicker to output the file

if you enter the device tty mode rather than the graphics mode of DESIGN and then switchtracing off (trace off). The DESIGN EXPORT commands can be stored in a PDMS macrofile.

For example:

pdms From the operating system start PDMS. The PDMSbanner will be displayed.

Enter project name

bas Enter valid project name

Enter username and password Enter your username and password

/SAMPLE Select the multiple database

dev tty Select tty mode

DESIGN Enter DESIGN module. The DESIGN banner will bedisplayed.

trace off Switch tracing off

repre level 6 Set drawing representation level

repre level pipe 6 Set drawing representation level for pipes

repre level nozz 6 Set drawing representation level for nozzles


11/28

12.0



2:5

Full details of more powerful colour selection and element selection techniques can be

found in the DESIGN Reference Manual.

2.9 Log File

Whenever AVEVA ExPLANT-I is run, it writes a log file. This has the same name as the dgnfile, but with a .log extension rather than .dgn. If a message or warning is printed byDESIGN, further details will usually be available in the log file.

If warnings or errors are written to the log file, this is usually mentioned after the banner tothe window from which PDMS was started.

The log file is plain text, and may be viewed with more in a command window, or any texteditor such as notepad.

repre level stru 6 Set drawing representation level for structures

export sys tem /explant Load the AVEVA ExPLANT-I export driver

Export option 'seedfile'

'c:\seedfiles\seed1.dgn'

Select a non-default seedfile to use

export fil e /equip over Specify name of the output file

export holes on Process holes in components

export /EQUIP colour 3

export /PIPES colour 4

Select names of PDMS elements that are to beexported.

export finish Create export data


12/28

12.02:6




13/28


ExPLANT-I Configuration File

12.03:1

3 ExPLANT-I Configuration File

In order to produce an attribute file from ExPLANT-I you must create an ExPLANT-Iconfiguration file, and inform the ExPLANT-I driver of its location in either of two ways:

Setting the environment variable EXPLANT_CONFIGURATION to the path of that filebefore starting DESIGN, for example

set EXPLANT_CONFIGURATION : %pdmsexe%\config.sample

This is particularly useful if you always use the same configuration file. In that case youcould add this set command to your PDMS batch files.

You can use the export option 'configuration' command in DESIGN toset the path of the configuration file. For example

export option 'configuration' 'C:\configs\config.txt'

This is particularly useful if you use different configuration files for different exports.

The ExPLANT-I log-file contains the path of the configuration file used for the run.

3.1 Example Configuration File for HTML

Here is a complete example configuration file. This file instructs ExPLANT-I to create a fileof commands to display some attributes of valves in the database.

The example output format used is HTML (Hyper Text Mark-up Language). The exampleshows how the ExPLANT-I commands can be used to tables that can be viewed using abrowser, such as Internet Explorer.

The configuration commands used are explained later in this section.

Some of the commands do not fit on a single line of this document and have been split.When you see a character, this means that the next line of the example is really part ofthe same original line.

$* Conf i gur at i on Fi l e header t o pr oduce ht ml f i l e

ATTRI BUTE_FI LE ht mDGN_FI LE yesATTRI BUTE_LI NKAGE 32768 0FI LE_HEADER | |FI LE_HEADER | Sampl e ExPLANT- I HTML out put|FI LE_HEADER | PDMS At t r i but es|FI LE_FOOTER | |ELEMENT_HEADER | Cel l %I D1% %I D2%|ELEMENT_FOOTER | |ATTRI BUTE_FORMAT | %TAG%

%VALUE%|


14/28

12.03:2



VALVNAME AS | Val ve|NAME OF BRANCH AS | Branch|

SPREF AS | Speci f i cat i on|POSEND_VALV

When ExPLANT-I is run using this configuration file it writes, in addition to the usual .dgnfile, a .htm file similar to this:

Sampl e ExPLANT- I HTML out put AVEVA At t r i but esCel l 1 0Val ve/ V102Branch/ 100- B- 1- B1Speci f i cat i on/ A3B/ VCW100POS12490 12280 1836. 5Cel l 2 0Val ve/ V103Branch/ 100- B- 1- B1Speci f i cat i on/ A3B/ VG100POS12490 12280 2063. 4. . . Mor e t abl es omi t t ed . . .

And when this file is viewed with a web-browser it appears similar to this:


15/28

12.0



3:3

3.2 Structure of the Configurat ion Fi le

The ExPLANT-I configuration file is a text file, which may be produced with any text editor

(such as notepad). Lines whose first non-blank characters are $* are treated as comments, and are not

processed.

Character strings may be quoted with | characters, and must be quoted if spaces areincluded in the string.

Blank lines are permitted (and ignored).

Spaces and tabs may be included before commands.

Words of commands are separated by one or more spaces or tabs (spaces and tabswithin |quotes do not separate words).

Commands may not be split over more than one line.

Commands are not case-sensitive.

This document describes the recommended forms of the commands. Some otherforms are also accepted.

3.3 Select the Output Files

3.3.1 Switch the Attribute File On or Off

Examples:

3.3.2 Switch the DGN Fi le On or Off

Keywords: ATTRIBUTE_FILE

Description:This command switches the Attribute file on or off, and sets its file-extension. The default is not to create an attribute file.

ATTRI BUTE_FI LE NO Do not create an attribute file

ATTRI BUTE_FI LE ht ml Create an attribute file with extension .html

ATTRI BUTE_FI LE EXTENSI ON| no|

Create an attribute file with extension .no

Keywords: DGN_FILE

Description: This command switches the DGN file on or off. The default is to createa DGN file.


16/28

12.03:4



Examples:

3.4 Define the Output Format

ExPLANT-I has a very flexible output format that enables you to export attribute data in theway that is most useful to you. This section describes the configuration commands availableto control the output format.

3.4.1 Link to the DGN File

Four numbers link the cells in the dgn file to the attributes in the attribute file. These arestored as anAt tr ibute Linkage. The first two of these are constant for all cells in the file andmay be set by theATTRIBUTE_LINKAGE command. For example, a web-browser will notread the dgn file itself and so has no particular requirements:

ATTRI BUTE_LI NKAGE 32768 0

ExPLANT-I generates the other two numbers, which change for each cell in the file.

3.4.2 Define the Head and Foot of the Attribute File

To define constant information to be placed at the start or end of the attribute file, use theFILE_HEADER and FILE_FOOTER commands. Each may be used more than once.

For example the HTML file needs three lines at the start:Sampl e ExPLANT- I HTML Out put AVEVA At t r i but es

and one line at the end:

and so the configuration file will have three FILE_HEADER commands and oneFILE_FOOTER command:

FI LE_HEADER | |FI LE_HEADER | Sampl e ExPLANT- I HTML Out put

|FI LE_HEADER | PDMS At t r i but es|FI LE_FOOTER | |

3.4.3 Define the Head and Tail of an Element

Similarly you can define the text to be written to the attribute file at the start and end of eachelement by means of the ELEMENT_HEADER and ELEMENT_FOOTER commands.

The HTML file needs to start the table and define a caption at the start of each element, forexample:

Cel l 1 0

and needs to close the table afterwards:

DGN_FI LE NO Do not create a DGN file

DGN_FI LE YES Create a DGN file


17/28

12.0



3:5

Some of the information in the element header changes from element to element, and sothe command uses two variablesin the quoted strings:

ELEMENT_HEADER | Cel l %I D1% %I D2%|ELEMENT_FOOTER | |

These variables (%ID1% and %ID2%) will be replaced whenever an element is processedby the current identification numbers (the third and fourth numbers in the dgn attributelinkage).

See Variables Available for a list of all available variables.

3.4.4 Define the Format of an Attribute

Each attribute is output using a single text format, with the variable %TAG% set to the tagdefined for the attribute, and %VALUE% set to the value of the attribute.

The HTML needed for one line of a table is:

Val ve/ V102

and so the command needed is:

ATTRI BUTE_FORMAT| %TAG%%VALUE%|

As another example, to create a file with attribute lines looking like:

Val ve = " / V102"

use the command:ATTRI BUTE_FORMAT | %TAG% = "%VALUE%"|

3.4.5 Var iab les Avai lable

Here are the variables you may put in the formats. These are replaced by the appropriatevalues when the format is used:

%LINKAGE1% is replaced by the first value from the ATTRIBUTE_LINKAGEcommand, (the first of the four linkage numbers in the dgn file) in the range from 0 to65535.

%LINKAGE2% is replaced by the second value from the ATTRIBUTE_LINKAGEcommand, (the second of the four linkage numbers in the dgn file) in the range from 0

to 65535. %ID1% is replaced by the first ExPLANT-I generated identification number, (the third of

the four linkage numbers in the dgn file) in the range from 0 to 65535.

%ID2% is replaced by the second ExPLANT-I generated identification number, (the lastof the four linkage numbers in the dgn file) in the range from 0 to 65535.

%#LINKAGE1%, %#LINKAGE1%, %#ID1% and %#ID2% are replaced by the samevalues, but in the range -32768 to32767.

%TAG% is replaced with the attribute tag.

%VALUE% is replaced with the attribute value.

%% is replaced by a single % character.

If a format ends in a single % then ExPLANT-I will not move to the next line of the

Attribute File before the next item.


18/28

12.03:6



3.5 Set the Output Units

Examples:

Here are some examples of sets ofOUTPUT_UNIT commands:

If you want bore and distance values to be reported in millimetres, using the nominal bore toone decimal place, all other dimensions to three decimal places you should include:

OUTPUT_UNI TS MM DECI MAL 3OUTPUT_UNI TS DI STANCE MMOUTPUT_UNI TS BORE NOMI NAL MM DECI MAL 1

If you want distances to be in feet, inches and eighths of an inch, actual bores in inches tothree decimal places, and any other inch dimensions to one decimal place you shouldinclude:

OUTPUT_UNI TS DI STANCE FI NCH FRACTI ON 8OUTPUT_UNI TS BORE ACTUAL I NCH DECI MAL 3OUTPUT_UNI TS I NCH DECI MAL 1

Keywords: OUTPUT_UNITS

Description: This command controls how ExPLANT-I writes units to the attribute file.It does not affect unit handling within the DGN file. The default is usePDMS internal units (typically millimetres).

OUTPUT_UNI TS RAW Use PDMS internal units. This should not becombined with any other OUTPUT_UNITScommand

OUTPUT_UNI TS MM DECI MAL 3 When writing a value in millimetres, use threedecimal places.

OUTPUT_UNI TS I NCH DECI MAL 2 When writing a value in inches, use two decimalplaces.

OUTPUT_UNI TS FI NCH FRACTI ON 32 When writing a value in feet and inches, usefractions as small as 1/32 of an inch.

OUTPUT_UNI TS BORE NOMI NAL MMDECI MAL 3

When writing a value which is in bore units,output the nominal bore in millimetres to threedecimal places.

OUTPUT_UNI TS BORE ACTUAL I NCH When writing a value which is in bore units,

output the actual bore in inches to the ordinaryinch precision.

OUTPUT_UNI TS DI STANCE FI NCHFRACTI ON 64

When writing a value in distance units, output infeet and inches to 1/64 of an inch.


19/28

12.0



3:7

3.6 Select At tr ibutes for Output

3.6.1 Choose ElementsFor each element type that you want to report on in the attribute file you must include ablock of commands in the configuration file. This block starts with the type of the element,and ends with the corresponding END_ command. Between these two you include theattributes that you require.

For example:

BRANCHALL_ATTRI BUTESALL_UDAS

END_BRANCH

VALVENAMESPREF

: MANUFACTUREREND_VALVE

Each element found when ExPLANT-I is scanning the DESIGN database according to theexport commands is checked so see if it is one of those listed in the configuration file. If itmatches, a MicroStation Cell is added to the dgn file. Since the DESIGN is hierarchical,with, for example ZONEs containing PIPEs containing BRANCHes containing VALVEs, thiswill, by default create Cells within Cells in the dgn file. This can lead to two problems:

There is a limit on the amount of data that can be put in a MicroStation Cell. A ZONEwill almost certainly exceed this limit.

Some applications that read dgn files may not interpret nested cells correctly.

To deal with these situations it is possible to tell ExPLANT-I to handle some elementsdifferently, and either to use an empty cell, or a cell containing geometry, but not nestedcells. If you use the EMPTY qualifier on an element line, for example

ZONE EMPTYNAMEEND_ZONE

ExPLANT-I will create an almost empty cell in the dgn file, and link the attributes to that. Asthe cell is almost empty it will not exceed the size limit. The cell will not be completely empty

as many dgn file readers reject completely empty cells. (If necessary, a line of zero length isput in the cell). It will often be better to use the facilities to report on the attributes of anotherelement (described inAttributes of Other Elements) to report attributes of these very high-level attributes.

If you use the NONEST qualifier on an element line then ExPLANT-I will write a cell to thedgn file which may contain geometry, but will not contain the cells of other elements from theconfiguration file (it may contain cells produced for geometry defined in PDMS as facets). Itis recommend that you only use this option if the system reading the dgn file cannot copewith the default NEST option.

An example of a possible use ofNONEST is when you want to have cells for valves, but togather all the geometry within a branch except for the valves into a branch-cell. You canexpress this as:


20/28


21/28

12.0



3:9

Note: When the new tag includes spaces you must quote it in ||. In the second example it isnot strictly necessary to use the quotes, as the new tag is a single word, but it isrecommended, for consistency, that you use them.

3.6.5 Reference Att ributes

By default, if you ask for a reference attribute, ExPLANT-I will report the name of theelement referred to. For example, if the element block were

VALVETYPENAMEREFNOSPREFEND_VALVE

the report might be

TYPE: VALVENAME: / V102REFNO: / V102SPREF: / A3B/ VCW100

Sometimes you may want the reference to be reported as the database reference number,rather than its name. In this case you must add the ASREF modifier to the attribute. Forexample:

VALVETYPENAME

REFNO ASREFSPREFEND_VALVE

might produce the report

TYPE: VALVENAME: / V102REFNO: =40/ 92005SPREF: / A3B/ VCW100

You may combine theAS and theASREF modifiers, for example:

REFNO ASREF AS | PDMS Ref er ence|

3.6.6 Attributes of Other Elements

You may wish to report on attributes of other elements referred to by the element you areworking on, for example some attributes of an element owning the current element, or of thespecification referred to by the element. You can do this by using OF modifiers, for example

VALVENAME OF PI PE AS | Pi pe- name|CATREF OF SPREFOWNER OF PTREF OF CATREF OF SPREF ASREF: LOCATI ON OF ZONE: VI SI BLE OF SPEC OF PSPEC OF BRANCH

END_VALVE


22/28


23/28


Limitations, Warning and Error Messages

12.04:1

4 Limitat ions, Warning and Error Messages

4.1 Geometry Mapping

The MicroStation dgn data file that is produced by the AVEVA ExPLANT-I Export Drivercontains a series of geometry definition records. The following table shows how DESIGN

primitives are mapped to dgn record types.

If the user requests that holes to be output, then AVEVA ExPLANT-I will generate a solidobject bounded by a number of facets. The facets with no holes are translated as Shapesand the facets with holes are translated as Cells containing no-hole Shapes and holeShapes.

4.2 Limitations

The following limitations affect the transfer of information from DESIGN to MicroStation.

DESIGN dgn File

Cylinder Truncated Cone

Snout Truncated Cone

Cone Truncated Cone

Slope bottomed cylinder Capped Surface

Sphere Capped Surface

Dish Capped Surface

Box Capped Surface

Circular Torus Capped Surface

Rectangular Torus Capped Surface

Pyramid Capped Surface

Polyhedron Cell containing a number of Shape elements

Structural Rectangle Capped Surface or a Cell containing a number of Shapeelements

Structural Annulus Capped Surface or a Cell containing a number of Shapeelements

Extrusion Capped Surface


24/28

12.04:2



1. The interface translates 3D geometric elements only. Attribute data may be written toan attribute file.

2. The BOUN and DRAW elements and 3D lines are not translated.

3. Element names are not translated but may be written to the attribute file.

4. Attributes are not translated but may be written to the attribute file.

5. The database hierarchy is not translated and any catalogue components are copied forevery instance. Some geometry elements may not have the correct graphic groupsetting.

6. Wide character sets (such as Kanji) are not supported.

7. Under some circumstances User Defined Attributes of type WORD may not be outputcorrectly.

4.3 Error Messages

This section provides details of the error messages that can be output when runningAVEVAExPLANT-I. When an error occurs the program will output a message to the standard errorstream (usually the screen) and the program will then stop.

A more detailed error message may often be found in the log file.

Less serious problems will cause a warning to be output to the log file, but the program willnot stop.

The following message is output by DESIGN if there is a problem with the software licensefor the AVEVA ExPLANT-I Export Driver. If this problem occurs you may need to contactAVEVA Customer Support for assistance.

***** FATAL SI TEFI LE ERROR *****

The following message is output by Design if there is a problem with locating or loading theAVEVA ExPLANT-I Export Driver.

Unabl e to open dynami c l i br ar y . . .

The following error messages may be output during translation from DESIGN toMicroStation.

l i br ar y does not accept t hi s har dwar e

i ogi ni has not been cal l ed

f i l e does not exi st

t her e i s no I SFF f i l e open

cannot cl ose t he f i l e

end of f i l e f ound

i nsuf f i ci ent space pr ovi ded

2D r equest on 3D f i l e

3D r equest on 2D f i l e

t ype does not exi st

t ype i s i nval i d f or quer y r out i ne

i nval i d l evel i n t ype 9


25/28

12.0



4:3

i nval i d di mensi on

er r or r eadi ng I DGS f i l e

i nval i d exponent i n doubl e

gr oup not appl i cabl e t o t ype

at t r i but es not appl i cabl e

SEED3D_DI R has not been decl ar ed

Can not open seed f i l e

Can not open I SFF f i l e

I nval i d expor t opt i on:


26/28

12.04:4




27/28

Index

12.0Index page 1


A

Attributedefine the Format . . . . . . . . . . . . . . . 3:5

Attribute Filechange the Tag . . . . . . . . . . . . . . . . 3:8define the Head and Foot . . . . . . . . . 3:4switch On or Off . . . . . . . . . . . . . . . . 3:3

Attributes

choose . . . . . . . . . . . . . . . . . . . . . . . 3:8other elements . . . . . . . . . . . . . . . . . 3:9reference . . . . . . . . . . . . . . . . . . . . . 3:8select for Output . . . . . . . . . . . . . . . . 3:7

C

Colours . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2Commands

miscellaneous. . . . . . . . . . . . . . . . . 3:10Configuration File

create . . . . . . . . . . . . . . . . . . . . . . . . 2:1ExPLANT-I . . . . . . . . . . . . . . . . . . . . 3:1structure . . . . . . . . . . . . . . . . . . . . . . 3:3

D

DGN Filelink . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4switch On or Off . . . . . . . . . . . . . . . . 3:3

E

Elementdefine the Head and Foot . . . . . . . . . 3:4

Elements

choose . . . . . . . . . . . . . . . . . . . . . . . 3:7choose multiple . . . . . . . . . . . . . . . . 3:8

ExPLANT-Irun . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4

F

Filelog . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

G

Geometry Mapping. . . . . . . . . . . . . . . . . 4:1Group

graphic . . . . . . . . . . . . . . . . . . . . . . . 2:2I

Installation . . . . . . . . . . . . . . . . . . . . . . . 1:1network . . . . . . . . . . . . . . . . . . . . . . 1:2

L

Limitations . . . . . . . . . . . . . . . . . . . . . . . 4:1O

OutputFiles select. . . . . . . . . . . . . . . . . . . . 3:3Format define. . . . . . . . . . . . . . . . . . 3:4Units set. . . . . . . . . . . . . . . . . . . . . . 3:6

R

Representation


28/28


setting . . . . . . . . . . . . . . . . . . . . . . . . 2:2S

Seed Filechoose . . . . . . . . . . . . . . . . . . . . . . . 2:1

T

TransferDESIGN to Microstation . . . . . . . . . . 2:1prepare . . . . . . . . . . . . . . . . . . . . . . . 2:1

U

Units

setting . . . . . . . . . . . . . . . . . . . . . . . . 2:2V

Variables . . . . . . . . . . . . . . . . . . . . . . . . . 3:5W

WRTuse . . . . . . . . . . . . . . . . . . . . . . . . . 3:10

Documents

Explant-i User Guide