You are on page 1of 40

VANTAGE Plant

Design (PDMS)
Version 11 .6

Module 11
Clash Detection
Training Manual

Introduction ............................................................................................................. ~ .......................... 4


1.1
Aim .................................................................................................................................................... 4
1.2
Obj.ctlves ...................................................... _......................................................................... ........ 4
1.3
Pr.requl.ite . .................................................................................................................................... 4
1.4
Cou .... Structure ............................................................................................................................. 4
1.5
us ing this guide ............................................................................................................................... 4
2 Clash Detection ....................................................................................................................................... 5
>1
Clashes which are NOT Reporteo ................................................................................................ ..
2.2
Invoking the 30-Clash Utility ......................................................................................................... .
Aut o Clash utility ........................... ,...... ...................... ................................................................ 5
2.2.1
Clash Oisplay ... ....... ........... ... ..................................... ............. ................................................. .. 5
2.2.2
Setting Cla.h Dafaults................................................................................................................... ..
2.'
2.4
Ob.tructlon L.v.ls .......................................................................................................................... 6
2.' Us ing the Obstruction Attribute in Your Dign ........................................................................ ..
2.6
Displaying Obstruction Levels In Design ...................................................................................... T
2.7 Changing ObstrucUon Levels In Design ....................... ................ ............................................... . 7
Extent of Clashing ..................................................... .................................................................... .. 8
2.'
2.' Spatial Map ...................................................................................................................................... . 8
Setting Ob.tructlons .............................................................................................................................. .
' .1 Setting the CI.sher Obstructlon List ............................................................................................ .
' .2 Setting the Clash.r Eltcluslon List .............................................................................................. ..
' .3 Clasher Obstruction Limit .......................................................................................................... 10
4
Clash Oata .............................................................................................................................................. 11
4.1
Dlspl.ylng of CI h o.t. .............................................................................................. ................. 11
4.2
Cla.h Check CE ..................................................................................... _..................................... . 11
4.3
Filtering and R.freshlng the Clash USt ..................................................................................... . 11
Navlg.ting to CIh It.ms ............................................................................................................ . 12
4.'
Cla.h Qu.ry .................................................................................................................................... 12
4.'
4.S.1
Query Clash Oelail ........................ _.......................................................................................... 12
4.5.2
Query Clash Summary............................................................................................................. 13
4.5.3
Query:oOefaulls ... ...... ,............................... _............ ,........ ,.................. _....... _............................. 13
4.5.4
Clash History .... _..................................................................................................................... . 13
Clash Dlspl.y ..............................................................................._............................................ _.. 13
4.6

EJlercls.1 ....................................................................................................................................................... 14

2....................................................................................................................................................... 1..
Oetclash ................................................................................................................................................. 16
' .1 Starting Descla.h .......................................................................................................................... 15
6.2
The Output Davice ......................................................................................................................... 15
The Obstruction Li.t...................................................................................................................... 15
' .3
.4
The Check Command .................................................................................................................... 16
' .6 The Checkadd Command ............................................................................................................. 15
Ex..mple Cla.h Macro............................................................................................................. ...... .
Clash Output Report ....................... .. ...................... ................................................................ ............. . 16
6
6.1
The Report Sections ................................................................................. ,................................... .
6.2 Customl.'ng CI h output ............................................................................................. ............. ..
Clash Repon Keyworos .................. .............. ... _.... ................................................................... 16
B.2.1
6.3
EJlample of uelng Report MacfO ................................................................................................ 16
Approving Clashas (for Adminlstr.tOfS only) .................................................................................... 18
7
e.ampl. of approving a Clash ..................................................................................................... 18
7.1

EIt~is.

.,

,.,."

Introduction

ThIl Tralnitlg Manual shows you how to check your desi9n continuously lor spatial dullea.lllat is, to Identity different
dKign items thai are oompe~ng for the tame apace.
To do this, we sl\3ll be usinq the 3D-CLASH Ut~ily witllin DESIGN. Thls ul W
ity is very IJ$CIlul whe n won..ing in eonMed
spaces....nere Ihflte is a chance \hal you may hive two or mOfe items oompeling for lhe"me space.
Workng WIlli On-l~ Clash Detection. unlrnl1ed brlnches....,O shoW any e1atne. "Ihey ocx:ur, fll\abling tile UStl' to
correet Ihe error before rnIMng on in the design . Although a pipe may be continuously checked for clashes M.till mUll
be Dala COMiItenc:y Checked and any erforl found, redifled belore you ~m a f~ clash c:tleek.

1.1 Aim
The following Train,,!! Manual desctibes!he use ofille Vantag e Plant Design (POMS) Cluh Oelect~ System

1.2 Objectives
AI Ule eoo of Ihis lI'3ining, you wi. have I .

Unde1513l1d the dilfefence betwHn auto-dash and on-dem3l'\d dash.

Be able \0 set clash def.ults.


Uncle~tand

!he exlent 01 clalh and 1110 the t~ of clash repoo Wd .


Understand hoW to query and update the tpatial map.
Understand the v;uious obstruction Vok.mes.

1.3 Prerequisites
The participants must ha~ compieteG the Management Overview COurM, or one of the basic VantagB Ptant oellgn
(POMS) Courses lor flltample ' Basi<: PipWl9 ee'i9n', "Snk: $leelWOl'k Design",

1.4 Course Structure


Traiftlng oMll consist 01oral and visual preMnliitions, demonstralionl and set exercises. Eaen rI<II'IIltallon wi! n.ave
traWling projecl, popub.ted with model objeds This w.t be used by the trainee, to practice their melhods, and complele
the lei exerecHS

1,5 Using th is guide


Certan tu l Myles are used to V'ICIieale specI.1 situ.bOns throughout dria document, here is a summary;
Manu pol downa and button p~ .ction . Are indicated by bold d.r1l blu. ,*xt.
lnfomlitioo the user 1181 10 Keyin W~t be red aod In lIl~rTod commal:
Annotation for tra inees benefit

<D

Addifloo81 infamia/iOn

G\:,/"

bl

Pay dose attention to

Reier 10 olher ~nlal/Oll

$ptem prompts should be bold and bi le in inverted ammas l., 'CIIoostl fIJnc/ion'

Eltample files or

~uts

wil be in the c:ourier new fonl, coIoufs and lIy1u used as before

,,
1

Clash Detection

2.1 Clashes wh ich are NOT Reported


Clashes are notmally reponed kif each pair of design primitives, piping components
interler., wrth the exception o!..,letferenoe', between the following patrs of ileons:

0(

ItHIwotII COI'l"l9Onenlllhal

PrWroitive, belonging to the Mme equipment


TWO structure 0( aubtWudure primitives having the "'Hne owner.
T wo piping cornponeI1\S lhatare conntc:tl!ld.

A piping componenl and tI'Ie nozzle 10 which it i$ connected.


Any component or prlm~Ne t/\al tI,. its obstruction value set to zero.

2.2 Invoking Ihe 3D-Clash Ulility


There are \WQ ways 01 using \he facility

2.2.1 Auto Clash utility


Tile 01'1-1.1118 d ..h utility c.n be used II tile same time as using one of lhe App~callon . 11 can be IwMChed 01\ b~
depl euing the AulD Clash bo.Inon on the
right of the Main Bar menu. This wil l ,how any clashes as they ooc:ur.

f.,

2.2.2 Clash Display


Alternatively. you may iu~ check.fler COI1~ tB Ung a section of Pillhi'Ol'1t (Make aure ia OWl QOI\~,tency;" dean). Using

Utlllt"', Clash.. ...

-....

"

.-

,: ..

.
.~,

'

-.

..

...... , ..-

.,"

....-;-

'.

..

--

The dnh ron is p !sformed u,1og Control" Chec k C E wfl.ich is QUD ibed laler

2.3 Setting Clash Delaulls


To MllhfI values 10 tw!I used for the clash ehec'" seled SetungpC luMr>Oe lau hs . This will bring up the form lor
IMIIlng your clash ernerill.
You /TIllY MlthalOlK:h \JlIP, O\Ier1ap and diIU!lf8f\Ot, and whethel or tIOI touches are to be shaM! III dashes or !goofed
You may also .petil,,, that dashes WIIhm a br8flCh are igr1(lfed at reponed as daWI

Anolher optIOn 11 10 1Connectionlto be included, ignored, at

wi1h &pee ignored

There Is toggle 10 set Clalh MicIpoWlt positic>n on or off thi$ can be u&ed and is used by aome applealions to make
IUfI lhe Clash Location is always repot1ed the ome. This fac:i~ty is used by applications like Clash Manl~.

30Cluher mikes use of aNoUfi to hlgh~ght item. that, !rom the sel limits, are deemed to be cluhlng. The obatrucliOn
may be shown In dilferent colour to thai of It1e dashing objectllhowing at once thlthere Is. cIIosh and the Ilems
involved.
The: setOOg for lI'Iese options can be pre-dellned in a lellt file . ..mic:h can be loaded via lI'Ie Rut' to Flit button on the
!onn Shoold you wtsh 10 return 10 trle default vatues the setectiOn of lhe Reu t 10 System button wlH relo.d U\e
.tanoard defaultl.
Once yoo a,. ..tislied with Ihl settings, you may USI either dicit IhI OK or Apply MONtO'c;:Qtpt the CllfTenl settings.
The OK option will ClUIl!t!he CUrl'ent lIale ot the fonn 10 be accepted and then dosed. whelen \he App ly option will
a~ the c;urrent stale of the form but wltlleave it displayed.

2.4 Obstruction Levels


AI Oe..:."n.nd CaLaIog~ database primitiVfl have ~II' a ttribute"..med OBSTRUCTION. The po5lible valul.101 Ih ...
ttribute , a"liIa betweefI 0 and 2 They Ire used as foIows

OSST.

No OOItructlon

0 6ST 1

A .011 obs\l\Ietion uM!! to provic!e SPace fOf wakways,

085T2

A l\ard obstrudiol'l

.eee" to hand <MIee'" and 10 on

used \0 indicate any ~tic! object.

For neoativa prim,bYfl these alfea3 all!

~1I.tty

leversed.!IlI !heywi. onl~ be trel'ted.s '00Ies' if 06ST " I

Of 2

(defaull).

2.5 Using the Obstruction Attribute in Your Design


'Nhen PMllljVel are aealed In Design, the 08ST attribute wal always be set to 2 (liard) by default. If you leqllire vatues
o f 001 1, then you must changl ll\e itllribull\O Ihe value you want it to be.

Careful conSlder.tion should bllillven 10 d31h geometry. becaus,the more objects ~ou alk to be ched<ed, the more
lime it wi. laki!! to prooess youl design. You can often represenltne obstruction of it deaign item by I/'dOSing il ln one or
two prWnitives. <MIich approximata to the volume lor dash cI1eckJI'Ig purposes . The visual model may bit vlry
compHcated, but by endOling lhe whole volume WI a simplified manner ~ou can COI'IlIderably rlduce the amount of wort:
that clash detlCfiolll'leeds to do.

As.n eXlmple. I pump is gene ... ny QOIlSlrUded from III number of ey1inderllhat m.kl up the body, sh.l'I, coupUng .M
motor. plus I boX lor the b.... The overa_ ob5Iruc6otl volume could 1>e rept'esented more aimply by a lingle box, wtjch
elldoses thl wIlole Ilea .

to selthe

No", pr....

_If_

O .. ",,1ICt1M> hlIlCI

leU.,. p/tM ""'~

. d .h

1011. Willi 01111 J

The dash" lire nrported in the following way;

HH
HS

HardlHard
Hard/Soft

HI

Hardllnsulation

S5

SoNSort
SoltJHard

SH
51
II

IH
IS

SofVInsulaUon
InllulatiOn/lnsulalion
InilutatiolllHard

InsuiationiSort

The distindion between nardlsort and soNhard dashes depends upo n whid'l primitive is regarded a, the original
()t)'I~ierol

the shared spaoe (the fixed obstruction) iIInd VIotlich is regan:!ed as the intruder into ttla! space.

2.6 Displaying Obstruction Levels in Design


You ean change the _y ~ems are d"Played in Design using Setting> Gnphlcs . and Mlecting !he R. pr.... ntatlon
Tab.

Obstruction can be let 10 various levels of translucency which he", with the datily or the display

2.7 Changing Obstruction Levels in Design


The obltruction level 01 Equipme nt PnmitJves is changed in design using Modify > Rllpnrs.ntaUon in the Equipment
Appllcatlon

2.8 Extent of Ctashing


There are tIYI' type. or d.lhes.
NOllTlal dash: whete the primitives overlap by more Ulan a apecif.ed amOVrl\
A. loud!; wnete the primitive. oYef'lap by len than III specified amount. Of where

lhe~

fire separated by less than III

specified distance.
A clearll'lOll; wIIere the primitives are separated by more tlm'llhe amount necessary 10 COfIllitlJte I tOOJeh, b tilies' ,nan
II $peCified de ....nce distance

,,

(h'crlap greater

than 5nlln

A Clash

Overlap kss
than Smm

Gap less

"

Touches

lhan 2mm

Separation morc than


2mm but less than 8mm

A Clearance:

2.9 Spatiat Map

,,,

The Clash detection first acc&$$U' simplified spatIal map 01the desigl'l. rather than the f!.AIr d,laWed data htlclln the
De sigf1 DB. Thi. J.pa~lll'Np contains the .I%e$ and position. of II aeries of rect.'..g,Jlar obtlrudlon ~mi l boxes. each of
wtlich completely enclose design elemenl
The

~rst

stage 01cliIsh deteetlOn i. to see II any of these obslrudion limit boxes Intersect. II no boll.ea Irltel1leet. no

claw. 111'8 reported.


If!'NO obstl\lClion lin'lil boxes in the splli.1 m3p intel1lect. Ihe detailed geometry 01the element! within !hose boxes is
examined to Me if any of their constituent primitives intersect.

The spatial map ihOYId be maintained throughout the pro.iect To be l ure if if I.IP to dale. before beginn ing cialh
detedlon, if WOuld be wiN to rebuild the map. Tt'k is achieved by Iyping the following command In the command liM.
(There is no UI fortin opIion).
M.AP B UILD MOS

Setting Obstructions

3.1 Setting the Clasher Obstruction List


To ereate an obsll'\lction list use the meOlJ selection!!.
Settings>Clu her>Obs lruttlon >Lls l

Thi ..wl bring up II form similar /0 that used for the Or .,..ti,t ., Ih.t you t.ighlighl lhe elemerol lha t you wish to add, then
UM the Add buUotI so l lIat it is now!hown in the otIsl ructioo list
When adding any 81em,nllo

t~

obstruction lislliUelements and primitives below the specified item are automatica lly

incorporated Into the list.

By default the obs.tru ction list contains a. design elemenls in the current MOB.
items may be removed from the list only if th ey are shown by name by use of Ihe Remove bulton. If for example II lIIIe
were added, none of ii's members would be shown in the list, although they are inCluded.

3.2 Setting the Clasher Exclusion List


If an element below Ihe slle was not to be pan of me obstl\lclion 611 lor example a zone, the n you must use II se-cond th.1
caled the ExctuOe List. Contro l > E.o:c l usion u s t on the AddlRemove Obstruction Items Form .

a""
This Iisl Is created in the same way 8S the obstruction Ii~ but contains elements ll'Iat are not to be conside'ed as
ob structIOns, To switch betwe en the obstruction lisland exclude bL use ttle oontrol pu~ down.

. """'" -.-

,,

3.3 Clasher Obstruction limits


Creating a Iisl Is nol lhe only way '0 sel the obs,ructions: you may wish 10 have an araa around items or a region that is
10 be used. This can be achieved by usll"lg limits to create an obstruCbon box. Any element !hat lies partly Of ....noll),
wittm I~ lirM. bo. win be ched<ed. A clash betwMln Items Ihat lie par1ially within the limit. box win alway. be I"fJpOIte.:l.
even il1M point at whiCh tt. cI..h OCCtJl$lies outside the box. To vse Ihis option yov mlllt Mteel: the following menvi

Settlngl>ClaSheP DbAtnlc tlon>l,ml t ..

,,
,

.''''

,
,i

Onoe thl, fofrn Is displayed you may set )"OUr limits by using one 01 Itla options .hown. either Cursor or Control.
Selection 01either onl ~I give you choices on how to set the limi t, i.e-. icI (selection 01M itam). CE, No Limits plvs
oilier option .

The vse of No Limit. will CllIIMI the values defining tile co rners ollhe bOll 10 be set to zero. A .eWng 01zero in alt (,eldl
wia. by defavlt. Inctooe In elements and primitNes in the currenl '"'08.

I
'0

Clash Data

4.1 Displaying of Clash Data


of Utill' les>Clnhes ... from Ute main bar menu will bring up the form shown below This form ~ used for
starting clash checks that lire not conllnuously cartled out This form Is split into two regions, these being 8 lelltual area
lI\at oulptin II list of Clashes and a graphical area similar to thai used for the normal deSign WOrk .
sel~llon

4.2 Clash Check CE


The Con \lol selection will give you the choice to either, close lhe form and return \0 the main clash form, or 10 Chec k

CE o

The cuflenUy tdghlighled Item in the Design E)(J)lorer will be Clash cheCked ..gainS! !he items defined In the ob!.truction
~st or limits as described eartiel'. Any dashes Ihal are detected w~1 be listed In t11e iRa of the form called Usl of

CllI$hes. This. list will be in the order thai tn.ese clashes are cleteeied and will stale tile type of dash that has occurred
and....nid'l ~ems are involved.

,.

" -10

i ..

..r . .
i......

..

Il

"

k)

."..'-.-

-~.,:

',-

"

4.3 Filtering and Refreshing the Clas h List


The Lis t Option has two

possibJ~ies:

Re fresh or Clash.

Refres h can be used 10 re freSh the Clash Display


1I I..Ist:'Clash is pid<ed then !he submenu is di5p1 ayed showing Ihe pOMibte options 01 what may be displayed.

"

."-.

N:tPlo" 1IrI

5J>ccf'y...

wi
.
cause the specify form to be
wnic.h .Iows)'oo 10 giw the extent
(phyalaol, loueh, or cie."nce ) of Ule dall1 you....ant displayed. and also the cIOIlJh level (hard-tlard. hard-.ott etc.)
displa~ed.

If )'Ou chao.. Llst>Cluh >Spec:l'y, thi,

CD

NOTE:

/f)'OO restrict Ihe

type o f ciasl!9s showl) fhe nCJm~ {n the (bsh liSI may f10I be C1J(1lifWQllS if oilier

/ypeS 01 c41JsII.re ptes.nt bul not (jjspJ8~.

4.4 Navigating to Clash Ite ms


S~l r;lion

of the Navlg.tion option allo\oos you to navigate through the d.laba... directly to either !he ~sh item Of Itle
obstruction !\em. depending on your c/'Iotc;e from the submc!(Iu.
N,II;gatlon )o Clash Item

N8Vigale:s to the dash demo

Navlgatlon)o Ob,tr uctlon 110m

Navigale3 to ob5lrvction item,

4 .5 Clash Query
The Query op6on ol!el'$!h. dIoioe of Clash or De/auts. 1f Clash is selected yoy will He the.wmenu thai otrlfS either
DeUiu

0(

Summary.

4.5.1 Query Clash Detail


Query>Cla.I\>DeI2II,

DisplaY" the following information about the current clash.

The reference number of the dash on the dull li$l


Ttl .xIeAI of the dash (ph~~ touch Of clearance).
The name 01 the dashr,g elemenls Ind!heir obstn.octlol1levels
T he co-oroinate, of tile dash

12

!
I

4.5.2 Query Clash Summary


Querf..Clnh>Summ.ry: Displays a form , which contains a report on the number of each type of duh IH'ld a total
numbet" of ellShe'S lor !hit cheek.
\"rllm~ ,

--'. .~ I

0..

j. .. .

4.5.3 Query>Defaults
Query>[)erlll ults: Ttli. displlyl
module .

a torm showtog what the current dash settings Ire. as coyereci at ttle sla" of ttlil

4.5.4 Clash HislOry


Selection of the History option writ d ispla y a sUbmenU -Mlh two ctloices; these ;we Redisplay 01' Empty
History>RedilpNi y: Rechecks al element. that hl'\le d ashed while Au!oet.sh"'''' been set or since Empty was lu'

,.....

Hlstory>Empty' Empties !he clu'" list 01 ilems thai have duhed

wI\~ 1I

Autocluh I"Ias been swiIched on

4.6 Clash Di splay


The right hand aide of the Clash Display lorm is a graphical window end wof1o:s In the lame Willy " Iny oll"ler graphical
window uti~sj ng the atme menu ct\OIoeI with one or two add itions.
_

t,..." ,

......,.

--.
- --

1 -

-~--

TypICally the . mits option has beln extended

13

Exercise 1
CMdo; your P;:! I (chedl) aglItllS! your Eq uipment (ob$trudion)

'Of ellIShe .

If I " dear of cla&hes, route, pipe through an equipment item On puroose to _the etfeet of A uto-Ctash.

You may have clasher rvnning w11~o you are 'ftOrking by depre"ing the Auto CI_ah button on the right of the mlin
menu. This wig ched( e....ry item in the obsttuetJOn list against the CEo

Exercise 2
Clun:k your Pipes againsl all \tie item, in 1M dlllabase.

Oesclash

.... s an III1et'native to lolling the UI, you /'1'181'1' manualy check your design using DESClASH. To U$8 this laolity, aM the
eorMVondi mull be typIlnto. command wli'Idow. It is n.onnally run by the AdmWlilllrlll lor vi a macro. It c:ontlios extq
commands INt are not Ivaillb le 10 the UI,

5.1 Starting Desclash


To stilirt up dntl detection, ill tile COfI'VTIands window type: -

Oe SCLASH
INhen you have completed the dlecklng you must exil the program by typing'
EXIT

5.2 The Output Device


As itl aR POM$ reponing modules, you "",,ve the option \0 $lind your output

to your terminal or to a file. Type either ol lhe

foIloMng :
TERM
fiLE /fi lename

5.3 The Obstruction list


To".\ the obslrlldOon list)'OO /Ust gilla a
0 8 ST ICIVILS /EOUIP

~st

of names to be added 10 the list' .

5.4 The Check Command


To start the ciaII'! detection type'
CHECK /PIPES
Of Whatever nem you wish to check ~ainsl the obstructiM list

5.5 The Checkadd Command


The CHECKAOO command dle<b en element against the existing obltlUdions .nd then acids it 10 !he obslrudiotllisl.
AlllUbseql.lel'l\elamentl.re therefore checked against all elements defined in the CHECKAOO oomrl'lind.

CH ECKAOD ISTR.US

5.6 Example Clash Macro


You may include positions 01clashes in YOOt report:
DESCL ASH
FILE ICLASH REP
REM OBS T A LL
OBST JCNlL /EQUIP
REPORT POS SITE
CHECK AOD/PIPES
EXIT

Clash Output Report

CLASHER generates a repolt, which is

spl~

VIto three parts, the Header, the Main part arKIlhe Summary.

6.1 The Report Sections


The Report HtI.der gives general information Uke the

ve~lon

in use, the cleartlnces defined.

The Ma in Body of the report details every clash found, including the type (tlard. soli, etc.) the clash extent (dash, touch,
and clear) and the identities of the elements involved .
TI'Ie Report Summary lists the total m.mber ol clashes found !or each type plus the total m.m ber of element. checked.
CLASH SUMMARY' "
6 hardJhard claJhes

2 llardJin.ulation dasll,s
57 hardhlard touches
50 si9nifiean\ alemanlS checked
9 signirlc8f1t elements interlerence free

6.2 Customising Clash output


You can customize the output from Clash: this output could be used to creal. a file incorporating dash aala In a format
$Uilable for Input 88 a macro to another POMS module, such as DRAFT.
The process operates by merging the clash data with information read from a pre..prepared template file and then
oulputtirlg the re&U11 01 Ihi& merger 10 lhe required maao file . The templale file must contain all necessary commands IIX
tl'M! module 10.....,k;t1 the dale Is 10 be translenad, with coded keyw'O(d~ mar1<ing the locations into which tile dash da ta ~
10 be loaded.
DESIGN \hen substitutes its clash repo rt data for these keywo rds.

6.2.1 Clash Report Keywofds


The keyword s to be used In the !&mplate file, ead"! ofv.tllch is identiflt'd by
$ ... S man.:e rs, afe 9$ follOw&.

$CLA1$

First clashing Ilem

$C LA2$

Second clashing l1em

SCLATYPE$

Clash type

SCLAPOSS

Oasll position in World coOl"dirlates

$CLATEXT$

Clash description as output In .. standard report: fOf example HH TOU sox 1 of NESSI with HEAD
TUBE 01 IBRA N1

$CLA NUM$

Clash number

$CLAOWN1$

SrgniflCant elemen t owning first clashing

$CLAOWN2$

SignifICant element owning second clu hing item

$S

Used to represent a single $ characler in the macro file

~em

6.3 Example of using a Report Macro


Creele a ~Ie in !he operating system called Repma c.txt
Add the follOWing to the file:
SCLANUMSS CLATEX TS
at SCLAPOSS

16

Nowtype the fotlowing on Ihe command Ine:


OESCLASH
REPORT MACRO IREPMAC.llIt
REMOBST ALL
0 8ST /CIVIL /EQUIP
CHECKADD IPIPES

EXIT
The oulpllt

~11

now be 01 the fonn.

1 HS
IelY't tube o f FLANGE 1 of 8RANCH 11oo8 .2.B1 with BOX 1F1.PLANT .FLRACCESSWA'f23
N1DSOO U21N

17

.t EI3A

Approving Clashes (for Administrators only)

The ildmlnistratc:n may specify OM Of more cla!lhes within the Design DB wen, although Ill al intcrfefence's, are to be

omitted from subsecau&nt CLASHER reports. These clashes are known as approved clashes.
The obsuvetion ~m ll s bo~H lor " Uapproved clashes are identified in a SI!IJ)<Irate list kn own IS the approval b l.
AdM lnistralof$ may rnanlpvlate the apo.-oval data in the following wa~$; Add new d ashes \Cl ll1e approvOiI ~sl
Remove dashes Irom the apPfoval lisi.

Re-approve clashes betwe&n ilems, either or b[)1h of which have boon moiled since approval was given.
OulPut the ament list 01approved clashes.
Save the approval list to a file so !hat il can be restored for use In a subseqLrenl d ash-checklng seSSion.

7. 1 Example of approving a Clash


The IoUowing 8;o:ample was used ir1 previous section and must have ttle Report Macro create<l .
OESCLASH

REPORT MACRO IREPMAC.llI l


REMOBST ALL

0 6ST /CIVIL IEQUIP


CHECKADD IPIPES
Make a /\Ote 01 now many dashM were created . We will flOW for lIli, e)(ample Approve lIle first clash.
APPR OVE 1
Runllle Clash again
CHECKAOO !PIPES
You will now have one less clash, (10$ the Approved Cl ash is 1"10\ reported .
You C3n save the Approved clllShe, 10 a

f~e

lor use in $ubsequ.enl runs

SAV APP I APPR OVAL- \

EXIT
Tile following elt3ffiPle was used in a previOU5 section and mu5\llave the Report Macro and lIle Approvat fije created .
DES CLASH
REPORT MACRO IREPMAC.lllt
RESTORE APP IAPPROVAL-'
R EM OBS T ALL
OaST /CIVIL IEQUIP
CHeCKAOO / PIPES
EXIT
A full e)(planation of the use of Clasher CIIn be fourod in The Design Reference M ~nuBI Part 4

"

VANTAGE

Plant Design
Management System
Version 11 .5

TR
TR

TRA

TRA

NG

ING
I NG
NG

VAN T AGE

Contents

....... ,""........................................................................................
Objectives ........... ' .......... ... ... .

<0

.,,.,

Must Know Points ............................... ...... ............. ................................................. 1-1


Generating Reports .. ..... ... .... .. ... ...... ... ............................ .. ......... ......... ............... ..... 1-2
Quick Reports ......................................... .. ...... ...... .. .... .... .. ...................... , ... ........ .. .. 1-2
Report ................ .............................................. ................................................. ..... 1-4
Starting to Use Reports ........................ ....... .. ............. ............................................ 1- 5
Running a Report from a Saved Template .............. ............................................... 1-5
Creating a New Template .............................. .... ... ......... ......................................... 1-9
Selection ........................................................... .................................................... 1- 10
New Columns ......... ....... .................. ..................................................... ......... .... . 1-111
Modify Columns ...... ......................................................................... .................... . 1-13
Moving Columns .. ................... ... ..................................... .. ......... ... .................. ..... .
Delete Columns ....... .............. . ............................................................................. 1-15
Systenl COtnnland ..................... ................................... ....................................... . 1-15
Hierarchy .............................................................................................................. . 1-15
New Reports TetTlplate ........................................................................................ 1-17
Exercise ............................................................. ................................................... 11 9

,.,4

Introduction
Objectives
At the end of Ihls sessIon you will be able to:

Generate Reports from VANTAGE POMS

Must Know Points


It is impon.nl to have 8 sound knowledge of VANTAGE POMS befOf8 undertaking Ihls
module.

Modul, U Repom

,.,

/ntlOdtK.fion

Generating Reports
The POMS database stotes a large amount of 30 engineering Information about your plant
design. You can extract this data both graphically, in the fonn of drawings, 0( in telrt form, by
producing reports. This session describes the pnncip/es and practice of prodUCing reports.
You can produce a report by running a report template (REPORTS) or one based on your
own selection criteria (QUICK REPORTS) from w ithin the Design module.

Quick Reports
The Create Quick Report form 15 displayed when you select Utilities " Quick Reports from
the main bar menu. This form aUows you to create reports YIith only basic formatting and this
lemp/ate cannot be saved.
You can enter a filename for the output report. If you just want to see the report
on the screen, leave the File te)(l box blank, or press Ihe Term button, In wh ich
case any filename given will be ignored. If Term is selected, a window will be displayed 10
show the results or th e report, unless there is a lready a form currently d isplayed 10 w hiCh Ihe
results may be written to.

Quic k Report fo nn

,.,

/ 138-TRA
/ 138-TRA
/ UB-TRA
/ F'lC-TRl
/ FlC- TRl
/ lU-TRJ..
/ lU - TRl
/ lU-TRl
/13B-TRA
/ /I, 38-TRl

100
100
100
100
100
100

lSO

00

BVO
OPEN

FSS
FSO
O.EN

BVO
FBI>
F8D

fl"

100
100
100
100

liD
100
100

l SO
>DO
>SO

COO
FBO
FBO

'"
.""
O.EII

roo
FBD
FDO
FBO
FBO

(0"'
.'13
10525 . 35
'''4.4''
35684 . 281
325?'7 . ?'U
2263' . 4,.6
1"80 . 611
'065 . U
2USl . l'
6462 . 257
56'1 . 302

Output from above eumple


The options periorme<l by the buttons on the quick Reports form an!! as folloWs:
Types :
PDMS element types can be specified.
For examples: Bran Mem valve gask nan

Wlth :
This option is a way of narrowing down the report Enter an PDMS expt'ession, For example:
abore 9t 300 ANO pspec of CPMler neq 'fA3B'
Columns :
Thele are the PDMS attributes to be output n the report The attributes you specify win be
used as headings to the column. You can enter expressions. enclosed in round bfakets. The
following ,. flllample outpu ts tile type. name, and the first ttlree characterl of the ownefs
name.
For example: type name (substr(name of owner. ,,3))
Other examples: name owner hpos tpos

Hierarchy:
Enter the element or etements at the top of the hierarChy that you want to report on.
Because you can give a ijst of elements, you must enter the slash character befOftl each
narne, except for IJIIORlD.
For example: I200-B-~ 1250-B5
Run th e Rep ort :
elicit this bulton when ready to generate the report .

~~~;-----------------------------w
.. ~'- 12 It8poibi

Inrroductfon

Report
The template speclfl9s What the report wi lt contain, whethe r it wilt be sent to the screen or a
file , and how it \Viti be laid out.
There is a directory of example reports supplied with the product. This can be found in the
directory $POMSUUREPORTS. Under tI'lis directory is a TEMPLATES d irectory. This
contains sample templates which can be used to generate standard reports. The templates
are POMS macros. The best way 10 see how Ihey are defined is to select Utilities> Reports
:> Modify from the main menu, and took at the settings for the fields on the form s displayed.
Templates have the file extension .tmp, and the corresponding reports have a file extension
.re p.
Most of the examples are based on the sample projed supplied with the product.
The sample temp/ales produce the following types of report
nozz_sched
This is a Nozzle schedule, Which lisls all Nozzles sorted by name, and shows the P1 bore,
connection type and direction. and the pO$lt ton of eaCh Nozzle.
lin I _list
This report wi llits! Branches, sorted by the name of the Pipe wn ich owns them. T he Pipe
Specification. the Head and Tail bores and the Head and Tail references are given.
plpe_mto
This report shows materi al information for all Branch members, sorted by type. Detail Text
and Material Text. The Tube length and quantity of each component are totalled. There is an
Imperial version of this report template.
tube_mto
This report tota ls alt Tubing. The Specification Reference, P1 Bore, Detail Text and MOlterts l
Text are shown.
steel_mto
This Is a material takeoff list for structural components.
valve_Ust
This report is an example of selective reporting.
centre_Url e
The centreline length of each Branch is Hsted . There is an Imperial version of this report
te mplate.
t ube_ gradient
This repon gives the gradient of each tubing component.
catalogue_param
This report lists Branch members, with their CA TREFs and the
cata togue_plgmret

pa rameter~

of the CATREFs.

Moduli! 12 Rep grl:!l

This report lists Branch members, with their CATREFs folloWed by the PTREFs and
GMREFs of the CATREFs.
tube_area_yol
This report uses derived properties to report on the a rea and volume of tubing.

Starting to Use Reports


You will usually have a library of report temptates set up fOf you , but you can prOduce and
ru n a report temptate by selecting Reports> Create. filling in the New Report Temptate
form to specify What you want 10 report on and th8fl pressing "'pply on the form , which will
run the report.

Running a Report from a Saved Template


You may already be famitiar with creating a report by JIXlnlng
try this introductory exercise. Select the following

a saved report tem plate. II not,

Utilities" Reports" Run


You wi ll see a File Browser, shoWing the contenls of the directory REPORTS .
Select the TEMPL...TES directory. Now choose the report template required ego
plpe_mto.lmp and press the OK button. The Report. Details form w~1 be displayed, On Il"is
form the user will need to complete all fields. The inform at/on req uested by this form is
dependent on the settings of 1M Runtime Prompts IQI"m, oofined during the templa te

creation.

....,,

T he information required by this form is totally dependent on what has been defined within
the Template. We wHilook at what other questions could be asked by th is form later under
Create. In the above case the following fields should be completed.

Modul. 12 Repa rts

Filename :
If you specify a filename, the repo l1 will be sent to the gi ....en file in the current directory. If you
lea.... e this field empty, the report will be sent to the screen

Hierarchy:
Here you should specify the elements where report should start its searches. The report wlU
be produced for all these elements and elements owned by them.

Types:
Here you shoukl state all element Types that are to be reported on. The report w ill be
produced for all the elements given.

With :
Oefines the criteria that must match the elements befote they w ill be reported on, This is
$OI1letimes refe rred to as a filter but works in the same way 815 the other occurrences in
POMS.

-.= ==---_._--._.Mod ulO 12 Rlporu

,.,

- - - - - - -----;-;

Volume:
Allows the setting of Limits. The report may be generated on elements that are Completely
0( Partially within the W
mits.

From :

Allows you to specify where the search will take place. The Default Is MOB

,.,

Creating a New Template


To create a new templa te we need to select the following options from the top bar menu.
This is true for all graphical modules and applications.
Utilities> Reports::. Create
This will cause the New Template form to be displayed. Ills from this form that all the deta!ls
associated with the ClsaUon 01 a standard report template wl ll be defined.
The New Repo rt Template form, shown below, cOllers several Important areas wtlich need
to be compleled ellen for a simple template. These are Dest lnetlon , SelM;l lon and
Columns .

Mod... 11 IQpoob

Introduction

Destination
DesUnatlon allows you to specify whether the report is output to Screen or to a File. This Is
achieved by the selection 01 the Screen button. On will..",.lte th e report to a ny commands
type window and Off will send the report to the filename specified by the Filename text
field .
To send the report to a file you m ust select one of the buttons located under Ihe File on the
form . All these buttons are mulually exclusive. As stated before , tI1e Screen option wi ll send
the report to a commands type window, lhe others will create a (de containing tha raport.
Selection of the New button will mean that a new file of the name defined in the Filename
text field wi. be created. This means that jf the fi le already exists then you wilt be given an
error message accord ingly. Overwrite will

create a new file il one doesn't exist or will

overwrite the contents of the fite if it does. Lastly is the Append bullon. This wi ll add your
re port to the end of the conten ts of the fi le defined by the Filename text field .

Selection
The Selection options al ow you to spe cify the type of item you want to report on, along with
the level in the database hierarchy below wh ich the selecllon will be made and any particular
selection criteria you may have ..

The text fiek! Type(s) allows you to define the element Gtypes that you wish to report

on.

With text field allows lor the defining 01 selection criteria, thus a more selective form of
reporting can be achieved. For example if we were reporting on branches we might choose
to only report 00 branch that had the ir Pspec set to {A3BTRA.
The Hierarchy field is simply usaa to define the start point l or the report search. This
eliminates check s to elements above the start poin t in the hierarchy so reducing the lime
take n.

,., 0

M!)dlll, 12 R,pOtU

[fI(,odt.lCtlon

New Columns
Every report consists 01 a number of columns. The next stage is to define your columns by
Iheir content. To create a new coIomn select the Hew button to the right of the Columns.
The selection of this will cause the Creating Column form to be displayed.

Creaung Column fonn

The Expression lext field defines the contents of the column. You can enter a PDMS
attributll Ot pseudo-attribute here.
The Sorting button wUl allow you to choose one of the methods for listing the COlumn
contents. In the above picture the sorting has been defined to ht alphabetically. The case 01
the letters is also laken Into account.
The setting of sorting criteria will cause the Precedence button to be set. Each time you
create 8 new column and MIt its sOr1ing criteria it will be given a Precedence number. This
determines tile Ofder in which the sorting is carried out.
By selection of the Un ite button you can select one of the units optIOn, when appropriate.
The Column l lyout button wi. cause the l ayout for Column xx form 10 be displayed.

1 11

Layo ut (or Col umn xx fo rm


SpiceS befo re cotumn is lhe number of spaces between the end of the previous column
and the start 01 the cunent cotumn. T he effect wi ll be affected by Ihe JusUflcatlon. The
Column width
is the number allowed for the column. If you do not give a vatue, the width of Ihe widest entry
will be used. The J ustification can be sel lo Lett, Centre or Right.
The Numeric Olsplay allows you 10 define if you wish to use Decima l or Fraction in your
column output. T hese two buttons are again mutually exclusive. Depending on the seleciion
you can enter the number of Decimal Places to be used or the Denominato r. NOle that the
Denominato r w ill be reduced if possible.
The Style button only affects how feet ana inches are displayed. Luding Zero es can be
On Of Off.
Using the Text Ofsplay options you can specify Ihe characters used to

~eclfy

Unset text.

In this flekl you can define the text string thai will be displayed II the item 10 reported on is
Unset.

\.1 2

Introdudion

The Head ings can be set as On , Off or Page. The On option (default) wi. display the
expression used aslhe column heading. Off will show no column headings and P,ge Is only
used fO( file reports where the spedal page details have been sel via the Plge opllon on top
of the New Report Template form.
Heading Texl can be set to:
Exprusion Tut : ThIs will use the expre$Slon enlered in the Expression teld field on the
Creating Column form.
Default: Will use the full PDMS attribute name il possible,
Custo m : You can en ter your own text for the column heading in the laid area. You can
insert several lines of text
Values can be selected from the form as On, Off, 1$t Of Sub. On win give the result of the
expression fOl every element that passes the selection criteria. Off no values will be shown.
This can be used fO( reports which give only subtotals or totals. 1st If this is sorted, Ihis
option can be used to display only the first occurrence of the resu lt of a particular
expression. Sub will only output when a sublotal appears In one of the other columns.
Subtot... can only be produced for columns containing numeric data.
Totalling can only be produced for columns oontaining nU"'1I1 Ie dala.
The last options 011 the Creating Co lumn form ate the t'Ml buttons below Co{umn layout.
SelectiOn 01 either the Previous Column or Next Column buttons wi. cause the COlumn
that you are currenUy defining to be added to the New Reports remp lale form in the area
under the columns buttons. The selection of Previo us Column or Next Column [s
dependent totally on if you wish lhe new column to be before or atter the currently
highlighted item. The form will also be reta ined ready for your next column definition. If you
select the OK button your column definition will be entered aft er Ihe current Item , and the
form will be closed.

Modify Columns
The Modify button will call the Modifying Column form 10I1he C\.ltrefllly highlighted , This
wWI be the same as thlliorm displayed by \he New button. The opera lion of the Previous
Column or Next Column will be as be fo re. The OK button will dose the form and update
tne New Report Template form .
Please note the column number being modified will be shown as part of Ihe form name.

- ---------------------c,-~13

Intnxluction

Mo difying Column

Moving Columns
If you have created your colum n in the wrong order or il you wish to change the order, this is
achieved by the selection 01 the Move button on the New Reports Template form . This will
display the Move Column form .

Move Column form

The number of th e currently highlighted column will be displayed next to the From. You can
now select any of the column position which are displayed by the To button. Once too new
column position is selected press lhe OK button . The order shown in the column area of Ihe
New Rep orts Template form will now be modified.

1-14

Modulo 12 Rope""

Delete Columns
To delete a column, select the column to be delele<::! on the New Reports Templat e form.
Once tlighl ighled selecl the Delete button. You will now be asked to confirm that you want to
delete this column.

Delete Connrmatlon Fo""

System Command
At the bottom 01 the New Reports Template form is the text field marked System
Command . This text field allOws you to give a system comman d thai wi ll be run When the
repor1 has been completed. FOf example you might wistl lo direct it to yoor printer via your
print command ego'Ipr (vtut(lfilenameJ)'

Hierarchy
ThIs button will display the Hierarchy 10ml. This form is used to specitr which par1 of the
hierarchy you want to report on. The information entered into this form will be used 10
populate the Hierlrthy field on the New reports Template form .

IntToducIiof1

Hierarchy Form
The Volume bUtton allows you to specify if only elements thai are Completely within or
Partially within the given volume are to be reported on. Selection of either of the above
options will cause the Report Volume form to be displayed. This form works in the same
way as the other volume area forms used within Design and Draft.

Report Volume Form

, 16

Modulo 12 Report.

Introduction

When you define the volume to use, the default win take the elements from the current MOB.
You may. by using th e From options, choose to obtain the elements fro m your current
Drawlls! or Obstru ction list instead.

New Reports Template


Retuming to the New Reports Template there are the bat menu options still to be
explained. These are

Bar Menu Option from the REPORTS Template form

File: Allows you to save your curr&nl definition 10 the filename which was selected from the
filo browser or to enter a new filename for it to be stored as. II is advised that temptates are
given the extensIOn .tmp. It IS also advised that you have a sample report to show users the
type of repor1 format they can eKpect from this template. Sample reporia are given an
eKtension of .rep .
Page Info: ThIs is used to set up page information such as Header, Footer, Introduction.
Summary or Page Len gth . Please note that any of these opti ons are only displayed on
reports that are sent to file and not If sent d irectly to the command line window ..
To create a header select the Header option from Page Info. This will display the Header
form .

Header Form

Module 12 Report.

1-1 7

InrroductJon

To define your Header enter the required text at PM L expressions inlO the text area of the

form and select OK.

A Footer can be created In exactly the same w ay as the Header.


The Introduction option will display a large lext window and is used as befOfe. Please note
that in this case the text entered wfll only be displayed at the start of the report.
The Summary option will display a large text window a nd is used as before. Please I1Qte
that in this case the text entered wiNonly be displayed at the end of the report.
The Page Length option allows the definition of the number of lines that wilt constitute the
page length. This number must be between 5 and 500.

Page Length Form

Options: This has two choices, RuntIme Prompts and Report Format.
The Runtime Prompts option will display the Runtime Prompts form . This form is used to
define what information the user will be asked before the report may be run .

1-18

ModU le 12 Repons

/ ntrotJuaion

The buttons selected on this fOlm will be added to a prompts displayed on the Reports
Details form which the user must com plete to be able to complete the report. These form w ill
conlaln any del"initions that have been given wittl ln the temp late Of left blank.
Selection 01 Report Format wi ll cause the Reports Fonnal form to be displayed.

Report Format Form

Format
This allows you to choose either the Normal
produce

or CSV option s. T he

No rmal option will

a report in the standard PDMS reports format

However, by setting lhe option to CSV (Comma Separated Variable) you will produce y our
report in a format thaI can be read into a spreadsheet package. You can specify the field
separator and text delimiter. Values shown in the rep ort are recognised as text onl y if the
Units option on the Creallng Column form is set to Off.

Exercise
1.

Run the report nou_sched and line_Us! to show the type of output created .

2.

Create a report to list allihe pipes with spec A1A. Create colum ns to display Name,

Pspec, Hbofe , and Tbore.

3.

Create a line list report as show n Overleaf, experi ment with the sorting facility and
notice the way it changes the output

Module 12 Reporta

119