You are on page 1of 120

AVEVA Plant

(12.1)

TRAINING GUIDE
Design Utilities

TM-1003

www.aveva.com
AVEVA Plant (12.1)
Design Utilities TM-1003

www.aveva.com
© Copyright 1974 to current year. 2
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Revision Log
Date Revision Description of Revision Author Reviewed Approved
05/08/2011 0.1 Issued for Review PDMS 12.1 SW
18/10/2011 0.2 Reviewed SW KB
25/10/2011 1.0 Approved for Training PDMS 12.1 SW KB NG
02/12/2011 2.0 Issued with latest copyright footer CF CF
06/03/2011 2.1 Issued for Review PDMS 12.1 SP2 KB
08/03/2011 2.2 Reviewed KB SB
11/03/2012 3.0 Approved for Training PDMS 12.1.SP2 KB SB NG

Updates
In general, all headings containing updated or new material will be highlighted.

Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers, please report it to AVEVA
Training & Product Support (TPS) at tps@aveva.com

This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.

Visit our website at http://www.aveva.com

Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.

1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar
losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of
data or information; any special, indirect, consequential or pure economic loss, costs, damages,
charges or expenses which may be suffered by the user, including any loss suffered by the user
resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of
whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence)
or otherwise.

1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with
the performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year
in which the user's claim is brought.

1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall
take precedence.

www.aveva.com
© Copyright 1974 to current year. 3
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part
of it (including source code, object code, any data contained in it, the manual and any other documentation
supplied with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this
document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or
transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is
granted, it expressly requires that this copyright notice, and the above disclaimer, is prominently displayed at
the beginning of every copy that is made.

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

The AVEVA software described in this guide is to be installed and operated strictly in accordance with the
terms and conditions of the respective software licences, and in accordance with the relevant User
Documentation.

Unauthorised or unlicensed use of the software is strictly prohibited.

Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA
shall not be liable for any breach or infringement of a third party's intellectual property rights where such
breach results from a user's modification of the AVEVA software or associated documentation.

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

Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trademark rights, or other intellectual property rights in any other product or software, its
name or logo belongs to its respective owner.

www.aveva.com
© Copyright 1974 to current year. 4
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Contents

1 Introduction .............................................................................................................................................. 7
1.1 Aim..................................................................................................................................................... 7
1.2 Objectives ......................................................................................................................................... 7
1.3 Prerequisites .................................................................................................................................... 7
1.4 Course Structure .............................................................................................................................. 7
1.5 Using this guide ............................................................................................................................... 7
1.6 Setting up the Training Course ...................................................................................................... 8
2 Clash Detection ........................................................................................................................................ 9
2.1 Overview of PDMS Clash Detection ............................................................................................... 9
2.2 Obstruction Values .......................................................................................................................... 9
2.3 Classes of Clash ............................................................................................................................ 10
2.4 How PDMS Reports Clashes ......................................................................................................... 10
2.5 Setting Clash Options.................................................................................................................... 11
2.6 Specifying What to Clash Check Against .................................................................................... 13
2.6.1 Obstruction List ........................................................................................................................ 13
2.6.2 Clash Limits .............................................................................................................................. 15
2.7 Auto Clash ...................................................................................................................................... 16
2.8 Clasher ............................................................................................................................................ 17
2.8.1 The Clashes Form .................................................................................................................... 17
Exercise 1 Clash Detection ...................................................................................................................... 22
3 Groups .................................................................................................................................................... 27
3.1 Creating Group Worlds ................................................................................................................. 28
3.2 Creating Group Sets ...................................................................................................................... 28
3.3 Managing Groups........................................................................................................................... 28
3.4 Dynamic Groups ............................................................................................................................ 29
Exercise 2 Groups ..................................................................................................................................... 31
4 Search Utility .......................................................................................................................................... 33
4.1 Specifying the Items to Search for ............................................................................................... 33
4.2 Search Filters ................................................................................................................................. 33
4.2.1 Hierarchical Search Below a Ceiling ........................................................................................ 34
4.2.2 Volumetric Search .................................................................................................................... 34
4.3 Attribute Filters .............................................................................................................................. 35
4.3.1 Attribute .................................................................................................................................... 35
4.3.2 Operator ................................................................................................................................... 35
4.3.3 Value ........................................................................................................................................ 35
4.4 Saved Searches.............................................................................................................................. 36
4.4.1 Executing Saved Searches ...................................................................................................... 36
4.4.2 Deleting Saved Searches ......................................................................................................... 36
4.4.3 Executing the Search from the Search form ............................................................................ 37
4.5 Search Results ............................................................................................................................... 37
4.5.1 Displaying Multiple Search Results .......................................................................................... 37
4.5.2 Results Grid Pop-up Menu ....................................................................................................... 38
4.5.3 Results Grid Options and Attribute Editing .............................................................................. 39
Exercise 3 Search Utility .......................................................................................................................... 43
5 User Grid Systems ................................................................................................................................. 45
5.1 Creating 3D Rectangular Grids ..................................................................................................... 45
5.2 Creating 3D Radial Grids ............................................................................................................... 48
5.3 Grid Display Options ..................................................................................................................... 50
5.4 Modifying User Grid Systems ....................................................................................................... 52
5.4.1 Deleting User Grid Systems ..................................................................................................... 52
5.5 Displaying Picked Positions in Grid Coordinates ...................................................................... 53
Exercise 4 User Grid Systems ................................................................................................................. 54
6 Surface Treatment ................................................................................................................................. 55
6.1 Definition of Surface Treatments ................................................................................................. 55
6.2 Assigning a Surface Treatment .................................................................................................... 56
6.2.1 Selecting Elements................................................................................................................... 56
6.2.2 Selecting the Surface Treatment.............................................................................................. 57
6.2.3 Applying the Surface Treatment...............................................................................................
www.aveva.com 59
6.3 Surface Treatment Calculation and Report ................................................................................. 61
© Copyright 1974 to current year. 5
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

6.4 Surface Treatment – A Worked Example ..................................................................................... 62


Exercise 5 Surface Treatments ................................................................................................................ 67
7 Mass Properties ..................................................................................................................................... 69
7.1 Mass Properties Overview ............................................................................................................ 69
7.1.1 Weight Data.............................................................................................................................. 69
7.1.2 Centre of Gravity Data ............................................................................................................. 69
7.1.3 Accuracy of Mass Properties ................................................................................................... 70
7.2 Weight and Centre of Gravity ....................................................................................................... 71
7.3 Surface Area ................................................................................................................................... 73
7.4 Volume ............................................................................................................................................ 74
7.5 Using the Mass Properties Utility – A Worked Example ............................................................ 74
7.5.1 Calculating Weight and Centre of Gravity ................................................................................ 75
7.5.2 Calculating Surface Area ......................................................................................................... 76
7.5.3 Calculating Volume .................................................................................................................. 78
Exercise 6 Calculating Mass Properties ................................................................................................. 80
8 Linking Documents to Design Elements ............................................................................................. 81
8.1 Linking Documents Overview ....................................................................................................... 81
8.1.1 Link World (LINKWL) Elements ............................................................................................... 81
8.1.2 Link Folder (LNFOLD) Elements .............................................................................................. 81
8.1.3 Link Class (LNCLAS) Elements ............................................................................................... 81
8.1.4 Link Descriptor (LNDESC) Elements ....................................................................................... 81
8.2 Adding Links .................................................................................................................................. 82
8.3 Displaying Links............................................................................................................................. 84
8.4 Adding Document Links – A Worked Example ........................................................................... 86
Exercise 7 Adding Linked Documents .................................................................................................... 89
9 Status Control ........................................................................................................................................ 91
9.1 Overview ......................................................................................................................................... 91
9.2 The Status Control Data Model ..................................................................................................... 91
9.3 The Status Controller Form .......................................................................................................... 92
9.3.1 The Status Controller Form – Option Lists ............................................................................... 92
9.3.2 The Status Controller Form – Toolbar...................................................................................... 93
9.3.3 The Status Controller Form – Context Menus ......................................................................... 95
9.3.4 Reporting Features................................................................................................................... 96
9.4 Using the Status Controller Form – A Worked Example............................................................ 99
9.4.1 Creating and Configuring the Status Layout ............................................................................ 99
9.4.2 Controlling Model Objects and Status Values ........................................................................ 101
Exercise 8 Status Control....................................................................................................................... 104
10 Representation Rules in Design ..................................................................................................... 105
10.1 Overview ....................................................................................................................................... 105
10.2 Creating Design Representation Rules ..................................................................................... 106
10.3 Modifying Design Representation Rules ................................................................................... 106
10.4 Saving, Loading and Applying the Rules .................................................................................. 107
10.5 Design Representation Rules – A Worked Example ................................................................ 108
11 Standard Model Library ................................................................................................................... 113
11.1 Overview ....................................................................................................................................... 113
11.2 Creating from the Standard Model Library ................................................................................ 114
11.3 Using Standard Model Library Elements - A Worked Example ............................................... 115
Exercise 9 Using the Standard Model Library...................................................................................... 120

www.aveva.com
© Copyright 1974 to current year. 6
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 1

1 Introduction

The AVEVA PDMS Foundations training module introduced Designers to the basic concepts of PDMS. This
training module introduces further Design Utilities that assist productivity and produce data from the model
to show the power of data centric design.

1.1 Aim

The aim of this training module is to introduce Design Utilities that complement and build open those
covered in the AVEVA PDMS Foundations training module.

1.2 Objectives

 To introduce the concept of clash detection and how it may be used interactively by Designers.
 To enable a user to create quick reports and produce report templates.
 To explain the basic principles of surface treatment and its application to Design elements.

1.3 Prerequisites

It is expected that trainees will have completed the TM – 1001 AVEVA Plant (12.1) PDMS Foundations
training course. Trainees who can demonstrate a suitable understanding of other PDMS applications and
techniques may also be permitted to undertake the training.

1.4 Course Structure

Training will consist of oral and visual presentations, demonstrations and set exercises. Each workstation
will have a training project, populated with model objects. This will be used by the trainees to practice their
methods, and complete the set exercises.

1.5 Using this guide

Certain text styles are used to indicate special situations throughout this document, here is a summary;

Menu pull downs and button press actions are indicated by bold dark turquoise text.

Information the user has to key-in will be in bold red text.

Where additional information is presented, or reference is made to other documentation the following
annotation will be used:

 Additional information
 Refer to other documentation
System prompts will be bold, italicised, and presented in inverted commas i.e. 'Choose function'.

Example files or inputs will be in the courier new font. www.aveva.com


© Copyright 1974 to current year. 7
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

1.6 Setting up the Training Course

Login to PDMS using the details provided by the Trainer. They will typically be as shown below:

Project: Training (TRA)

Username: A.PIPER

Password: A

MDB: A-PIPING

Module: Design

Select Utilities > Training Setup… from the main menu to display the Training Setup form. Navigate to the
Utilities tab.

Select the Setup Training Course checkbox, click the Apply button and close the form. Select Design >
Pipework… from the main menu to enter the Pipework application.

www.aveva.com
© Copyright 1974 to current year. 8
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 2

2 Clash Detection

One of the principal reasons for building a 3D model of a plant in PDMS is the ability to detect clashes and
thus produce a plant design that is as ‘clash free’ as possible.

Whilst a completely clash free design is almost impossible to achieve, it is many times more expensive to
resolve clashes during the fabrication, assembly or erection phase than it is in a 3D model in the Design
office.

2.1 Overview of PDMS Clash Detection

Project wide ‘clash runs’ are normally made at frequent intervals during the design process. They are
generally timed events, set-up by the System or Project Administrator, and run during non-working hours.
This type of clash detection enables clash reports to be produced and certain clashes to be ‘approved’ so
that they are not reported again unless specifically requested. This type of clash detection is outside the
scope of this training guide.

PDMS also provides the user with interactive clash facilities so that clashes may be detected during creation
or modification of design elements, or retrospectively, following completion of a particular part of the design
(prior to it being checked or approved). These types of clashes cannot be approved.

There is no ‘magic button’ that resolves clashes. Clash detection is passive. Clashes will be reported when
asked, but actions that may cause a clash are not prevented. Therefore, if clashes are found in the design
steps must be taken to resolve them.

2.2 Obstruction Values

All design primitives and all catalogue primitives have an Obstruction attribute (Obst) that define the
physical type of obstruction the primitive represents. For catalogue items the Obstruction attribute value is
determined during the creation of the catalogue item. For design primitives (e.g. a primitive used in
equipment building and structural panels) the value is set by the user.

The Obstruction attribute may have one of three integer values: 2, 1 or 0.


 Obstruction = 2 – a hard obstruction. This value represents a solid element and is generally used for
‘real’ objects such as a piece of equipment, a steel beam, a pipe component, etc.
 Obstruction = 1 – a soft obstruction. This value represents a volume that is not solid but should be kept
clear for access purpose. This value is generally used for access/escape routes, valve wheel access,
stair headroom, tube bundle withdrawal volumes, etc.
 Obstruction = 0 – no obstruction. This value represents a freely accessible volume. It is generally used
for simplified structural profile definitions, etc.
In addition to the obstruction types defined by the Obstruction attribute, Insulation is treated as a special
obstruction type in its own right.

www.aveva.com
© Copyright 1974 to current year. 9
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

2.3 Classes of Clash

As well as the three types of clashing item, i.e. hard, soft and insulation, PDMS uses three classes of clash
depending on three values that may be set by the user, i.e. Overlap, Gap and Clearance.

The three classes of clash are:


 Physical Clash – the primitive volumes overlap by more than the Overlap value.
 Touch – the primitives either overlap by less than the Overlap value or are separated at their closest
point by less than the Gap value.
 Clearance – the primitives are separated at their closest point by more than the Gap value but less than
the Clearance value.
In the following scenarios the values are set to: Overlap = 5mm, Gap = 2mm and Clearance = 8mm.
 Care should be taken when setting the values for overlap, gap and clearance as, both individually and
in combination, they can make an enormous difference to the number of clashes detected.

 Scenario 1 - primitives overlap by more than 5mm, a clash is reported.


 Scenario 2 - primitives overlap, but by less than 5mm, a touch is reported.
 Scenario 3 - primitives do not overlap but are separated by less than 2mm, a touch is reported.
 Scenario 4 - primitives are separated by more than 2mm but by less than 8mm, a clearance is reported.
If the primitives are separated by more than 8mm then no interference is found.
 The Clearance value, if set, must be greater than the touch Gap value. Setting the Clearance value to
0 switches off the clearance checking function.

2.4 How PDMS Reports Clashes

Physical clashes, touches and clearances occur between two elements. The element that is being checked
is known as the Clash Item and the element that interferes with it is known as the Obstruction Item.

When clashes, touches and clearances are reported the class of clash is prefixed by the type of obstruction
of the Clash Item and the Obstruction Item. The Clash Item is always specified first, for example:
 HH Hard/Hard – the Obst value of both the Clash Item and Obstruction Item is 2.
 HS Hard/Soft – the Obst value of the Clash Item is 2 and Obst value of the Obstruction Item is 1.
 HI Hard/Insulation - the Obst value of the Clash Item is 2 and the Obstruction Item is insulation.
 SS Soft/Soft – the Obst value of both the Clash Item and Obstruction Item is 1.
 SH Soft/Hard - the Obst value of the Clash Item is 1 and Obst value of the Obstruction Item is 2.
 SI Soft/Insulation - the Obst value of the Clash Item is 1 and the Obstruction Item iswww.aveva.com
insulation.

© Copyright 1974 to current year. 10


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 II Insulation/Insulation – both the Clash Item and the Obstruction Item are insulation.
 IH Insulation/Hard – the Clash Item is insulation and the Obst value of the Obstruction Item is 2.
 IS Insulation/Soft – the Clash Item is insulation and the Obst value of the Obstruction Item is 1.
Therefore, interferences may be reported as HH Clash, HH Touch, HH Clearance, HS Clash, HS, Touch, HS
Clearance, etc.

Clashes between the following pairs of items are not reported:


 Primitives belonging to the same equipment.
 Two structure or substructure primitives having the same owner.
 Two piping components that are connected.
 A piping component and the nozzle to which it is connected.
 Any component or primitive that has its obstruction value set to 0.

2.5 Setting Clash Options

The number of clashes reported during a clash check depends greatly on the options chosen and the values
of the parameters discussed previously. Selecting Utilities > Clashes… from the main menu displays the
Clashes form. The Clashing options are located on the Options tab.

Tolerances provide settings for Touch Gap, Overlap and Clearance are set by entering the required
values in the appropriate textboxes.

Clash options determine the behaviour of the clash checking operation, with the following settings.

Touches are option list enables the user to specify whether touches (and clearances) are to be Included or
Ignored.

www.aveva.com
© Copyright 1974 to current year. 11
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Clashes within Branch options list enables the user to specify how Branches are checked and has the
following options:
 are Included – this option runs the ACHECK function which performs a primitive-by-primitive check of
every component in each branch.
 are Ignored – this option ignores clashes within individual Branches but reports clashes between items
in different Branches.
 Ignore Adjacent – this option runs the BCHECK function which is a simplified check that ignores the
possibility of clashes between certain pairs of components within the Branches.

 The ACHECK and BCHECK functions are part of the DESCLASH command set. See the Design
Reference Manual supplied with AVEVA PDMS for details of these commands.
The Connections options list enables the user to control clash checking at steelwork junctions. Clashes
between sections and attached joints are ignored automatically. However, if end preparations at steelwork
joints have been left until late in the design process, clash reporting at connections may be inhibited using
the following options:
 are Included – (default) includes all steelwork connections.
 are Ignored – ignores all steelwork connections.
 With Spec. are Ignored – ignores only those connections that have specifications, i.e. the SJOIs Spref
attribute is set.
The Clash Midpoint Position checkbox enables the position of the clash to be more accurately determined.
By default, the reported position of a clash depends on which part of the overlapping region is first detected.
In most cases this identifies with sufficient accuracy the clash. Checking the Clash Midpoint Position
checkbox makes the reported clash position the centre of a box surrounding the overlapping region. Using
this option will give more reproducible results but may be slower.

The Clash Colours determine the colour of the Clash Item, Obstruction Item and background Colour when
the clashes are displayed in the 3D view. Clicking the Major Clash Items button displays the Major Clash
Items Colour form, clicking the Obstruction Items button displays the Minor Clash Items Colour form and
clicking the View Background button displays the View Background Colour form. The required colour
may be selected from the palette and clicking Dismiss on any of the forms sets the colour selection.

Presentation defines how the clash information is displayed.


Group Clash / Obstruction – if checked groups the clashes grid on the Clashes tab by clash and
obstruction item.
Clash Item Aid – if checked displays aid label within the 3D view detailing the name of the clash item.
Clash Obstruction Aid – if checked displays an aid label within the 3D detailing the name of the obstruction
item.
Clash Position Aid – if checked displays an aid label within the 3D detailing the position of the clash using
the current session coordinates.
Clashes Ignored Within enables clashes within certain elements to be ignored, but still report clashes
between different elements. Each applicable element type is shown with an adjacent checkbox. Checking a
box next to an element type will cause clashes within that element to be ignored. If the box is left
unchecked then clashes are included.
www.aveva.com
© Copyright 1974 to current year. 12
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Clashes can be ignored within the following elements:

SITE Site STRU Structure


ZONE Zone SUBS Sub-Structure
PIPE Pipework FRMW Framework
BRAN Branch SBFR Sub-Framework
HANG Hanger SCTN Section
REST Restraint GENSEC Generic Section
EQUI Equipment PCOJ Primary Collinear Joint
TMPL Template PLTFRM Platform
CWBRAN Cableway Branch CPANEL Curved Panel
HPANEL Hull Panel

Save/Restore allows the saving of current or retrieval of previous clash checking options.
The Reset System Defaults button resets the form settings to the system defaults which are read from a
system file when PDMS is opened.
The Save button saves the current option settings to a user options file.
The Restore button reads the saved user options file and sets the options accordingly.

2.6 Specifying What to Clash Check Against

Having set the clash options the items to clash check against must be specified. The items to check against
may be specified by an Obstruction list of explicit elements or by setting clash limits where all elements
within those limits are used.

2.6.1 Obstruction List

Selecting the Obstructions / Exclusions tab on the clashes form displays the Obstructions and Exclusions
Lists.

www.aveva.com
© Copyright 1974 to current year. 13
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

This tab defines which elements will be used to clash against. This can be performed in two ways. By
explicitly selecting all the obstructions to clash against, or by excluding the specific elements that will not be
clashed against.

The top half of the tab is the Obstructions list, where the obstructions the checked item(s) will be clashed
against are specified. The default content of the list is All, meaning that all Design items in the MDB will be
used to check against.

There are several ways in which items may be added or removed from the list. However, with All set, no
other elements can be added to the Obstructions list. All must be removed before other elements can be
added.

The Add button works in conjunction with the adjacent options list which has the following options:
 Current Element – with this option, clicking the Add button adds the CE to the Obstructions list.
 Pick Element – with this option, clicking the Add button displays the prompt ‘Pick element to Add’. The
required elements are graphically picked from the 3D view and are highlighted. Pressing the Esc key will
add the picked items to the Obstructions list.
 Current Selection – with this option, clicking the Add button adds all elements selected in the 3D view
to the Obstructions List. Multiple items can be selected by holding down the Ctrl key when picking from
the 3D View.
 Current List – with this option set, clicking the Add button adds the contents of the current list to the
Obstructions list.
 All – with this option set, clicking the Add button removes any elements currently in the Obstructions list
and replaced it with the key word All, meaning all elements within the MDB will be checked against.
The Remove button removes the current selection from the Obstructions list. The button is only available
when a selection is made from the list.

The Clear button removes all items from the Obstructions list. A
confirmation box appears before the List is cleared.

Clicking Yes on the message clears the list. Clicking No will cancel the
operation and retain the List.

 When an element is added to the Obstruction List, all elements and primitives below the specified
item (i.e. its members) are automatically incorporated in the list. If a Branch (or higher) element is
added to the Obstruction list, implied tube within the Branch is treated as part of the obstruction. If
individual piping components are added to the list, implied tubing connecting those components is not
automatically included and must be added explicitly if required.
The bottom half of the tab shows the Exclusions list, where the items selected are excluded from the clash
checking operation.

This list may be used to exclude specific elements from the clash check. For example, if the element’s
Owner has been included in the Obstruction list. Any elements in the Exclusion list will not be considered
during clash checking. The default Exclusion list is empty.

The Exclusions list options work the same as those for the Obstruction List; with the exception of the Add All
option as adding all items to the obstruction list would void the clash checking operation.

www.aveva.com
© Copyright 1974 to current year. 14
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

2.6.2 Clash Limits

By default, all parts of the Design model relevant to the current Obstruction List will be checked during a
clash check run. However, if the entire design is not required to be checked a restricted region of interest
may be specified using a Clash Limits box.

The Clash Limits box is defined from the Limits tab on the clashes form.

The Limits tab enables two opposing corners of a box to be specified, defining the clash limits. The co-
ordinates of the box corners may be specified by entering values in the From and To textboxes.

Each co-ordinate direction can be swapped by selecting the drop down list adjacent to the relevant textbox.
A direction can be locked to preserve its value by checking the checkbox next to the relevant textbox.

The Clash Limits box may also be defined by using the Volume drop down list.
Current Element - this sets the Clash Limits box to the limits of the current element. The co-ordinates are
displayed in the relevant From and To textboxes.
Picked Elements – this displays the prompt ‘Pick element to add to list for enclosing box’. The required
elements are graphically picked from the 3D view and are highlighted. Pressing the Esc key will set the
Clash Limits box to the limits of the picked items. The co-ordinates are displayed in the relevant From and
To textboxes.
Defined by 2 picks - This displays the prompt ‘Pick First Clash Limit’ and activates the Positioning
Control Toolbar. This then allows the use of any of the positioning toolbar functions to select the first, To,
corner of the limits box. Once the first point is picked the prompt is changed to ‘Pick Second Clash Limit’.
Once the second From point is selected the co-ordinates are displayed in the To and From textbox.
Current Selection – This sets the clash limits to all elements selected in the 3D view. Multiple items can be
selected by holding down the Ctrl Key when picking from the 3D View. The co-ordinates are displayed in the
relevant From and To textboxes.
Current List - This sets the clash limits to all elements contained within the current list. The co-ordinates are
displayed in the relevant From and To textboxes.
 For a clash to be reported, both items involved in the clash must lie wholly or partially within the Clash
Limits box. A clash between items that lie partially within the Clash Limits box will always be reported,
even if the point at which they clash occurs outside the box.

www.aveva.com
© Copyright 1974 to current year. 15
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Clear button can be used at any time to reset all values from the To and From textboxes to 0.

The Display checkbox is used to toggle on and off an aid representation of the limits box. The aid shows the
clash limits as a green wireframe box and marks the To and From corners of the limits box with aid labels.

2.7 Auto Clash

Auto Clash may be turned on by clicking the Auto Clash button on the Utilities toolbar. When Auto
Clash is switched On, a clash check is carried out at the end of every command in which an
element has been modified in some way that could cause a clash to occur, for example:
 When a new element has been created.
 When an element's position and/or orientation has been changed.
 When an element's geometry has been changed.
Each clash check is carried out using the current clash options and Obstructions/Exclusions Lists. If the
Obstruction List is extensive, Auto Clash may have a small overhead in performance so it is good practice to
consider the contents of the Obstruction List or restrict the volume being considered using a Clash Limits
box. Auto Clash is very useful where a few new items are to be added to an existing design which has
already been checked for clashes.

Auto Clash starts checking when it is switched On. Any clashes that have occurred before that time are not
considered. Similarly, Auto Clash stops checking as soon as it is switched Off. Any clashes that occur after
that time are not considered.

When a clash is detected the Clash Item and Obstruction Item are highlighted in the colours specified in the
Clash Options. If a clashing element is already in the Drawlist it will be highlighted in the appropriate colour.
If the element is not currently displayed, it will be added to the Drawlist automatically, in the default visible
colour, and will then be highlighted in the appropriate colour. The element stays highlighted until another
clash is found, until all graphical highlighting is specifically removed, or the clash is resolved.

The results of each clash check replace those of any previous checks, so any reported clashes must result
from the actions of the last command. The user’s attention will normally focus on the current element, so
graphical highlighting is used to show the clash, rather than outputing the clash data to file.

www.aveva.com
© Copyright 1974 to current year. 16
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 In order to avoid spurious clash reports when a new Branch is created, the last section of implied tube
in a Branch is checked only if the Branch LTAI attribute is set to True. (The LTAI attribute is set
automatically when the Branch Tail is positioned).
The clash-checking rules are as follows:
 If the current element is a Piping Component and is the last component in the Branch, then its leave
tube is checked only if the Branch LTAI attribute is set to True.
 If the current element is a Branch which has no members, then the tube which constitutes the Branch
is checked only if the Branch LTAI attribute is set to True.

2.8 Clasher

In addition to Auto Clash, PDMS provides the user with interactive clash detection utility which may be used
at any time. If Auto Clash is not used, it is good practice to use this utility whenever a significant part of the
model has been completed so that any errors in the design can be resolved before having an impact on later
design elements.

Selecting Utilities > Clashes… from the main window displays the Clashes form. Clash information is
found on the Clashes tab.

The form contains a 3D view, with full view control functionality, to graphically display the clashes and a
Clash List of all the clashes found during the clash check.

Clash checking and viewing of the results is controlled by the form tabs and the 3D view pop-up menu, as
described in the following sections.

 For use of the 3D View controls and functionality please refer to the TM – 1001 AVEVA Plant (12.1)
PDMS Foundations.

2.8.1 The Clashes Form

The Clashes form menus have options to initiate a clash check and modify the 3D view to show the clash. It
has the following options.

 Check CE – this option initiates a clash check of the CE against the Obstruction List.www.aveva.com

© Copyright 1974 to current year. 17


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 It is good practice to initiate clash checks on small items, e.g. a Pipe or Branch, a FRMW or SBFR,
etc., so that the displayed results are manageable.
 Check– this option initiates a clash check of the Element defined in the adjacent text box against the
Obstruction List. An element Name can be directly entered into the textbox for checking.

The Clip Box check box toggles a clip volume within the 3D view. If checked the 3D view is clipped around
the position of the clash.

The size of the clip box is defined by the text box adjacent to the checkbox. The default value is 2000mm.
This can be changed by entering a value or by using the slider. As the slider is moved to the right the value
in the box is increased and the 3D view is updated. Likewise moving the slider to the left decreases the
value within the textbox.

If the Clip Box checkbox is unchecked then the entire of the current drawlist will be displayed in the 3D
view.
 Any elements which are checked are automatically added to the current drawlist. Likewise any
obstructions found to be clashing with a checked item are also added to the current drawlist.
The Clashes form also displays the details of the current clash selected in the Clashes Grid. This is shown
as a label at the top of the form. The details shown update as the user navigates between clashes.

2.8.1.1 Clash Grid

The Clashes tab displays the resulting information following a clash check and allows the viewing and
organising of the results and navigation to the Clash and Obstruction Items.

The clash information is displayed within the Clashes Grid. The information within the grid is displayed with
the following headings.
 Clash number.
 Clash – Checked / Obstruction Item, i.e. HH or HS.
 Clash Type.
 Clash Item (Checked Item).
 Obstructer.
 Clashed low level elements.
 Clash Easting.
 Clash Northing.
 Clash Elevation.
 Clash Owning Element.
 Obstruction Owning Element.
The clash results can be sorted and grouped by one or more column headings. To group by a heading click
and hold the left mouse button on the heading and drag the heading into the grey area above the grid.

Any of the columns can be filtered using the standard grid gadget filtering, utilising the options available in
the cell below the heading title.

Selecting a clash from the grid automatically updates the 3D view to display the current clash. The
information for the selected clash is also displayed at the top of the clashes form.

www.aveva.com
© Copyright 1974 to current year. 18
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Navigate check box defines the relationship between the clashes grid and the design explorer..
Unchecked the explorer will remain unchanged as clashes are selected from the grid. If checked it activates
the adjacent drop down menu. This has two options:
 Clash Item – selecting this option will navigate to the Clash Item in Design Explorer for the clash
highlighted in the clash gird and make it the CE.
 Obstruction Item – selecting this option will navigate to the Obstruction Item in Design Explorer for the
clash highlighted in the clash grid and make it the CE.
Right clicking anywhere in the clash grid shows a pop-up menu with two methods for the export of the clash
grid information.

Print Preview – Opens the standard Print preview form allowing the page setup to be defined and the grid
printed.

Save to Excel – Prompts the user to browse to a file location and save the grid as a Microsoft Excel, .xls,
file. This then saves the file to the selected location.

 Any grouping or filtering applied to the grid is maintained within the export. However the print preview
only displays the group titles and not the lower information. Excel export provides all the grid
information in the same format as the grid gadget.

2.8.1.2 Clash Reporting

The clasher utility has the ability to generate a text report of the clash checking results. The reporting
functionality is located on the Report tab of the Clashes form.

The default setting when running a clash check is not to create a report. When this is the case the report
options are inactive. By checking the Report to file when checking for clashes checkbox the clash
checker will automatically create a report of its results and the options for this report are then activated.

The Position frame sets the presentation of the clash position.


World – Reports the position with respect to the world origin.
Site – Reports the position with respect to the owning site of the clash item.
Off – Position of clash is not reported.
www.aveva.com
© Copyright 1974 to current year. 19
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Duplicate frame sets the option for reporting clashes which appear multiple times within a clash check.
When clash checking it is possible for an obstruction in one clash to be the clash item in another. As such it
is possible for an item to be a both a clash item and an obstruction item and thus the same clash is reported
twice. These options allow the report to take this into account.
First – Reports only the first element within the clash and ignores the second.
Second – Reports only the second occurrence of the clash and ignores the first.
Both - Reports the first and second clash occurrences.

The Levels frame sets the types of clashes that will be reported.
Clashes – Will report any physical clashes found.
Clearances – Will report any clearance clashes found.
Touches – Will report any touch clashes found.

The Report Format frame allows the report layout to be customised.

Header – Adds header information to the top of the report such as Date and Time of clash check; the types
of clash reported; any non-default checking options and limits; the touch and clearance limits; any special
reporting options in use. An example is shown below.

Date 6 Jun 2011 Time 11:33


Report on All CLASHES TOUCHES CLEARANCES in:-
ZONE /EQUIP

Touches defined as 2mm overlap to 0mm gap


No clearance defined
Branch check option ACHECK selected
Clashes included between connected SECTIONs
Clashes ignored within GENSEC, BRAN, TMPL, CWBRAN, PLTFRM, SCTN, PCOJ, PIPE,
CSURPX, CPANEL, HPANEL
Clash reported for both items in DB hierarchy

Main Body – Details of the clashes found, including the clash type and extent and the identifiers of the two
design items involved. The clashes are grouped into sections, one for each significant element that
contains interference. An example is shown below.

ZONE /EQUIP
EQUIPMENT /E1301
HH BOX 1 with BOX 1 of SUBSTRUCTURE /E1301-BASE
AT SITE COORDINATES E2621 N7221 U841
HH BOX 2 with BOX 2 of SUBSTRUCTURE /E1301-BASE
AT SITE COORDINATES E2621 N10881 U841

Numbering – Adds the relevant clash number from the clash grid to the clash main body within the report.

Primary - Reports only the first or highest priority clash found between two significant elements (i.e.
suppresses multiple clashes, including those between different primitives of the same pairs of significant
elements).

Obstruction – Adds the obstruction list to the header information.

Reference – Adds database reference numbers to the clash and obstruction items in the main body.

www.aveva.com
© Copyright 1974 to current year. 20
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Clash Summary – Lists the total number of clashes of each type found; the total number of elements
checked and the number of elements found to be interference free. If the Primary option was selected the
summary will be divided into the Primary clash summary and the Actual Clash summary. An example of this
is shown below.

***PRIMARY CLASH SUMMARY***


4 hard/hard clashes
5 hard/soft clashes
29 hard/hard touches
249 significant elements checked
234 significant elements interference free

***ACTUAL CLASH SUMMARY***


19 hard/hard clashes
6 hard/soft clashes
35 hard/hard touches
4 hard/soft touches

The Listing frame allows a list of the selected element types that are checked to be incorporated into the
report. Checking the List Elements checkbox activates the list. The default value for all element types is
On. Clicking on a row in the list toggles the Check column On or Off.

The destination and name of the report file can be set via the Report to file frame. The default destination
and file name is, %PDMSUSER%/MyReport.txt. This can be changed by typing in the required filename and
path or by navigating to the required location using the Browse button. This opens a standard windows
dialogue box, where the required location and filename can be entered.
 The PDMSUSER folder can be thought of as a storage area for settings, files and defaults created or
setup by the user. The information held in the folder may interact with many aspects of PDMS but is
essentially independent of the programmes function.
 At the 12.1 SP2 release of PDMS the PDMSUSER folder has a default location within a Data12.1.SP2
folder. The folder path is typically C:\AVEVA\Plant\Data12.1.SP2\pdmsuser.
The Reset System Defaults button resets the form settings to the system defaults which are read from a
system file when PDMS is opened.

The Save button saves the current user options.

The Restore button reads the saved user options file and sets the options accordingly.

www.aveva.com
© Copyright 1974 to current year. 21
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 1 Clash Detection

Add the ZONE named /ZONE-PIPING-AREA01 below the SITE /SITE-PIPING-AREA01 to the 3D view.
Click the Walk to Draw List button and set the view direction to Iso 3.
Select Utilities > Clashes… from the main menu to display the Clashes form. Navigate to the Options tab.
Check the Clash Midpoint Position checkbox. Set the Major Clash Items colour to Green and the
Obstruction Items colour to Cyan. Click the Save button.
Select Obstructions / Exclusions tab to display the Obstructions and Exclusions list. Click the Clear
button on the Obstruction List, then the Yes button on the confirmation message box. The Obstruction List
should now be empty.
Navigate to the ZONE named /ZONE-STRUCTURAL-AREA01. Ensure Current Element is selected from
the add obstructions drop down box and click the Add button. Note that the ZONE has been added to the
Obstructions List. Repeat the operation to add the ZONE named /ZONE-EQUIPMENT-AREA01 to the
Obstructions List.
Select the Clashes tab on the Clashes form to display the Clash List.
Navigate to PIPE 150-A-57 in Design Explorer to make it the CE. Click the Check CE link label from the
main form. There should be two clashes displayed in the Clash List and the 3D View should have updated
to show a clipped view around the clash area.

Note that in the main 3D view a structural section, coloured Cyan has been added, indicating that it is the
Obstruction Item. Also note that the two tubes on the selected Pipe are coloured Green, indicating they are
the Clash Items.

www.aveva.com
© Copyright 1974 to current year. 22
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Check the Navigate checkbox. Then select Obstruction from the dropdown list. Select the second clash
and note that the Obstruction Item (i.e. the section) is now the CE in Design Explorer.
Using the Clipping Box slider above the 3D view, increase the size of the clipping box. Note how more of
the elements around the clash become visible as the clipping box increases.
To resolve this clash it may be necessary to raise the pipe to clear the beam or, lower the beam to clear the
pipe. The resolution would need to be agreed between the disciplines.
Remove the ZONE named /ZONE-PIPING-AREA01 and the ZONE named /ZONE-STRUCTURAL-AREA01
from the 3D view.
Navigate to PIPE 100-B-1 in Design Explorer and again click the Check CE link label from the Clashes
form. There should be five HH Touches in the Clash List.

Select the first clash in the Clash List, i.e. HH TOUCH ELBOW 1 OF BRANCH /100-B-1/B1 (tube). The
detail of the clash can be found by sliding the grid gadget across to reveal all the columns in the grid. An
overview of the selected clash can be seen at the top of the clashes form.

This clash is a ‘touch’ between the leave tube of ELBOW 1 of the branch and a beam on ROW_J.

Right click in the 3D view and select Look > North then zoom in so that the touch between the tube and the
structural section is clearly shown:

www.aveva.com
© Copyright 1974 to current year. 23
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

This clash is classed as a touch because the default settings of Overlap 2, Gap 0 and Clearance 0 are
being used. The tube is not overlapping the section but resting on it, therefore, it is not a Clash but a touch.
Select the Options tab to display the Clash Options. Modify the Touch Gap setting to 1 and the Clearance
setting to 5 and click the Save button.
Select the Clashes tab. Navigate to PIPE 100-B-1 in Design Explorer again and select Check CE to re-run
the clash check with the new settings. Note that one more touch and two clearances have been added to the
Clash List, demonstrating the importance of getting the clash settings right.

 Select the Report tab. To create a clash report during clash checking check the Report to file when
checking for clashes checkbox. Uncheck the Primary and Reference checkboxes as all clashes will
be reported on, but the database reference for each clash item is not required. Click the Save button.

 Select the Clashes tab and navigate to the ZONE /ZONE-PIPING-AREA01 in Design Explorer to make
it the CE. Select Check CE from the Clashes form. The form should now display a considerable number
of clashes (more than 60). A text report detailing the clash check findings can be found in the
PDMSUSER directory with the default name MyReport.txt.

www.aveva.com
© Copyright 1974 to current year. 24
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The clash summary at the bottom of the report should be as below.

***ACTUAL CLASH SUMMARY***


12 hard/hard clashes
1 hard/soft clashes
26 hard/hard touches
26 hard/hard clearances
29 significant elements checked
8 significant elements interference free

Note the total number of clashes and close the report.

Change the default Touch Gap and Clearance settings on the Options tab back to 0 and save them. With
the ZONE /ZONE-PIPING-AREA01 as the CE, again select Check CE from the Clashes form. As the name
for the clash report was not changed the old text file is overwritten. The summary from the clash report
should now be as below, again note that the number of clashes has been reduced.

***ACTUAL CLASH SUMMARY***


12 hard/hard clashes
1 hard/soft clashes
23 hard/hard touches
29 significant elements checked
17 significant elements interference free

Check PIPE 100-B-8 and decide how the clashes might be resolved.

www.aveva.com
© Copyright 1974 to current year. 25
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

www.aveva.com
© Copyright 1974 to current year. 26
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 3

3 Groups

A group element can hold in its members list a number of design elements from any combination of
hierarchic levels and may also span across multiple databases. Appropriate design operations can act upon
the individual elements in the group simply by carrying out the operation on the group.

Groups are particularly useful when there is a need to create a secondary hierarchy of elements. For
example, a set of elements for a project may span more that one site, if this is the case it is difficult to
identify where in the hierarchy these elements occur. With a group its members can be queried and the
hierarchy of elements contained within it easily seen.

A group is a Design database element in its own right and is, therefore, stored in the hierarchy for use in
later sessions or by other modules that have access to Design elements.

The elements that make up a group are:

A Group World (GPWL) is the top level administrative element and may own many
group sets.

A Group Set (GPSET) contains groups of items.

A Group Item (GPITEM) is the element from another part of the hierarchy. A GPSET
may own many GPITEMs.

Group sets may be nested within other group sets. To achieve this structure a GPSET can own another
GPSET or a GPITEM can point back to a GPSET.

Selecting Create > Group… from


the main menu displays the
Groups form.

The form contains its own


Explorer to browse the hierarchy,
a grid to display the Group Sets in
the Group World and a Group
Members grid to display the Group
Item data.

The form is automatically


populated with all the GPWL and
GPSET elements in the current
MDB if they have been previously
defined. The data in the Group
Members grid data is defaulted to
the first GPSET in the first GPWL.

The form may be dismissed by


selecting the cross in the top right
hand corner.

www.aveva.com
© Copyright 1974 to current year. 27
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 GPITEM elements do not appear in the Design Explorer or the form Explorer. The actual names of
the members of the group set are displayed instead. With a GPSET as the CE, entering Q MEM in
the Command Window displays a list of the GPITEM elements. Querying the attributes of any
GPITEM will show an attribute called SItem that holds the actual element name.

3.1 Creating Group Worlds

Group worlds are created by right clicking in the form Explorer and selecting Create Group World… from
the pop-up menu. This displays the Create Group World Form.

A Name for the Group World, and other attributes, may be entered into the relevant textboxes on the form.

Clicking the OK button on the Create Group World form creates the new Group World (GPWL) in the
hierarchy below the highest level significant element of the CE.

3.2 Creating Group Sets

Group Sets are created by right clicking on a current Goup World in the form Explorer and selecting Create
Group Sets… from the pop-up menu. This displays the Create Group Form.

A Name for the Group Set, and other attributes, may be entered into the relevant textboxes on the form.

Clicking the OK button on the Create Group form creates the new Group Set (GPSET) owned by the select
GPWL.

3.3 Managing Groups

All Group Sets available in the current MDB are displayed in the Available group sets list on the Groups
form. Selecting a Group Set from this list displays the members of the Group Set in the grid below the list.
This grid has the same options as other grids within PDMS allowing sorting and filtering of the contents.

Populating a Group Set with elements and modifying the contents of a Group Set is achieved using pop-up
menus from the form Explorer and the Group Members grid. www.aveva.com
© Copyright 1974 to current year. 28
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Right clicking on an element in the form Explorer displays a pop-up


menu that has the following options:

 For the following menu options that use the term Current
Element, it is the CE highlighted in the form Explorer, and not that
of the Design Explorer, that is being referred to.

 Add Current Element – this option adds the CE to the current group set.
 Add Current Element Members – this option adds the CE members to the current group set.
 Remove Current Element – this option removes the CE from the current group set.
 Remove Current Element Members – this option removes the members of the CE from the current
group set.
 Add From Current List – this option adds the members of the current list to the current group set.
 Remove from Current List – this option removes members of the current list from the current group set.
 3D View – this option has a sub-menu that has options to add and remove the CE from the 3D View.
Right clicking anywhere in the Group Items grid displays a pop-up
menu that has the following options:
 Remove All From Group – this option removes all elements from
the current group set and clears the Group Members grid.
 Remove Selected From Group – this option removes the selected
elements in the Group Members grid from the current group set.
 3D View – this option displays a sub-menu with the following options:

 Add All – this option adds all of the items in the current group set to
the 3D View.
 Add Selected – this option adds the items selected in the Group
Members grid to the 3D View.
 Remove All – this option removes all items in the current group set
from the 3D View.
Remove Selected - this option removes the items selected in the
Group Members grid from the 3D View.
 Navigate – this option navigates in the Design Explorer to the item selected in the Group Members grid.
If there is a multiple selection in the Group Members grid this option will navigate to the first selected item
in the grid.
 Export to Excel – Allows the export of the grid contents to a Microsoft Excel .xls form.
 Print Preview - Produces a standard print preview of the grid and its contents.

3.4 Dynamic Groups

Groups can be dynamic, so that the elements contained within them are automatically updated.

If a top level element, for example a Site or Zone, is added to the group, then elements owned by this are
automatically added/removed as they are created or deleted. However it is also possible to create a dynamic
group that does not rely on the addition of top level elements.
www.aveva.com
© Copyright 1974 to current year. 29
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

This is achieved using a Group Set. The Group Set has the attribute SCOSEL. This attribute can contain a
PML 1 expression which is then used to populate the group.

For example if the SCOSEL was set as ALL PIPE, the group would automatically populate with all of the
PIPE elements contained within the MDB.

This could then be expanded to PIPES of a certain specification e.g. ALL PIPE WITH PSPEC EQ /A3B.
Which would add all pipes in the MDB of the spec A3B.

Several criteria can be combined in the expression, for example ALL PIPE WITH PSPEC EQ /A3B OR
BORE GT 80 would now only add pipes with spec A3B and a bore greater than 80mm.

These expressions, once entered are automatically evaluated, providing automatically updating dynamic
groups.
 Note that the SCOSEL attribute must be set via the attribute form or the Command Window.

 For further information about PML Expressions please refer to the Design Reference Manual
supplied with PDMS.
Any elements added via the SCOSEL attribute are not shown in the Group set form, allowing the user to
make the distinction between items explicitly added to the group and items automatically added to the group.

www.aveva.com
© Copyright 1974 to current year. 30
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 2 Groups
 Navigate to the World in Design Explorer. Select Create > Group… from the main menu to display the
Groups form. Right click in the form Explorer and select Create Group world… from the pop-up menu
to display the Create Group World form. Enter TRAINING_GROUP_WORLD in the Name textbox and
press the Return key. Leave the three other attribute textboxes at unset. Click the OK button to create
the GPWL element.
 Right click on the GPWL in the form Explorer and select Create Group Sets… from the pop-up menu to
display the Create Group form. Enter ALL_EQUI in the Name textbox and press the Return key. Leave
the other two attribute textboxes at unset. Click the OK button to create the GPSET element.
 In the form Explorer, expand SITE-EQUIPMENT-AREA01, right click on the ZONE-EQUIPMENT-
AREA01 and select Add Current Element Members from the pop-up menu. Note that the equipment
elements are added to the grid gadget.
 Expand the GPWL and GPSET elements and note the contents of the Group Set.
 In the Design Explorer select the GPSET element. Right Click and from the pop-up menu pick
Attributes… In the SCOSEL attribute field enter ALL EQUI and press the Return key. Collapse and re-
expand the group set and observe the contents has updated.
 Note that the Groups form still only contains the manually added elements.
 Right click on the ALL_EQUI GPSET in the form Explorer and select 3D View > Add CE from the pop-
up menu. The equipment elements should now be displayed in the 3D View again.
 Dismiss the Groups form and save work.

www.aveva.com
© Copyright 1974 to current year. 31
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

www.aveva.com
© Copyright 1974 to current year. 32
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 4

4 Search Utility

The Search utility enables the databases to be searched for specific items. The scope of the search may be
defined and the items may be identified by different criteria including name, type, attributes or any
combination of these.

The search results are output to a grid gadget and may be grouped, sorted and filtered. The results may be
added to the 3D View, added to My Data, printed, and exported to Excel.

Selecting Display > Search… from the main


menu displays the Search form.

The form is re-sizeable and dockable and


contains an area to specify the item to be
searched for; a fold-up panel to specify
Search Filters, a fold-up panel to apply
Attribute Filters to the search and a fold-up
panel for Saved Searches.

The functionality available on the main form and the fold-up panels is described in the following section.

4.1 Specifying the Items to Search for

The items to be searched for may be specified by names that contain a specific string, one or more element
types or a combination of both.

A character string may be entered in the Name Contains textbox. The string may be of any length and
contain any permissible name character. The search is case sensitive.

Any strings that have been previously specified in the session are retained in the options list for the duration
of the session and are available for further use. The options list also contains a Clear History option that will
remove any previously entered strings from the list.

One or more item types may be entered in the Element Types textbox. If more than one item type is
entered they must be separated by a space, comma or semi-colon, i.e. EQUI PIPE, NOZZ; TEE. The entries
may be any valid item types and are not case sensitive. The options list contains an ALL option (the default)
which, if selected, will find all item types in the current search scope.

Any item type(s) that have been previously specified in the session are retained in the options list for the
duration of the session. The options list also contains a Clear History option that will remove all any
previously entered item types from the list.

4.2 Search Filters

The Search Filters fold-up panel contains two methods to specify the Scope of Search, a hierarchical
search below a ‘ceiling’ or a volumetric search within a specified volume. Each of these methods may be
used separately or they may be combined.

www.aveva.com
© Copyright 1974 to current year. 33
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

4.2.1 Hierarchical Search Below a Ceiling

Checking the Beneath Element checkbox


activates the search below a ‘ceiling’ option.

When the Search utility is first opened during a session, the default scope will be set to the World element
(/*) as the ‘ceiling’ of the search within the current database, e.g. Design, if within the Design application.
The ‘ceiling’ may be changed by entering a valid item name in the textbox or clicking the CE button to set
the current element as the ‘ceiling’ for the search.

The database items entered in the Beneath Element options list will be retained throughout the current
session; however, this history can be cleared by selecting Clear History from the options list.

The database types listed in the In Database options list are those that are
available to the user in the current MDB.

The options list will automatically update if the item exists in any of the databases types. Similarly, if the
database type is changed in the options list then the database item currently displayed will be checked. If it
is not found in that database type, the ceiling of the search scope will be reset to world.

As well as searching specific database types, it is possible to narrow the scope of the search further by
checking the Element List checkbox. This activates a number of options available via the adjacent drop
down list.

 Draw List - will only search elements currently in the draw list.
 Graphical Selection – only elements within the current graphical selection
will be searched.
 My Data – Only the contents of the My Data storage location will be searched.
 My Data Selection – Only the data stored within the current My Data selection will be searched.

4.2.2 Volumetric Search

Checking the In Volume checkbox activates the Of


Element and Explicit Volume radio buttons.

Selecting the Of Element radio button enables an


element to be selected in the design explorer and then
the CE button clicked to set the search volume to the
bounds of this element.

The elements entered in the Of Element options list will


be retained throughout the current session; however, this
history can be cleared by selecting Clear History from
the options list.

Checking the Explicit Volume checkbox activates the


textboxes in the Lower Limit and Upper Limit areas of the
fold-up panel, enabling the opposing corners of a box to
be specified by entering the X, Y and Z co-ordinates to
define the volume explicitly.

The Wholly Within and Wholly & Partially within radio buttons, which are applicable to both methods of
volumetric search, specify whether the found items exist completely or partially within the specified volume.
www.aveva.com
© Copyright 1974 to current year. 34
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

4.3 Attribute Filters

The Attribute Filters fold-up panel enables one or


more attribute filters to be set for the search.

The specified attributes will apply to each item type


listed.

If there is more than one attribute filter specified


then the found items will satisfy all of the attribute
filters.

The Add Filter and Delete Filter link labels at the bottom of the fold-up panel enable an attribute filter to be
added and deleted as required.

4.3.1 Attribute

Having added an attribute filter, moving the cursor over the Attribute column
highlights a pull-down that contains the attributes of the specified item type. The
required attribute may be selected from the list.

Entering the first one or two letters will find the required attribute in the list, if present.

If no item type has been specified, i.e. only a partial Name string has been specified,
only the Name attribute is available.

If multiple item types have been specified, attributes for all item types are available.

4.3.2 Operator

Moving the cursor over the Operator column highlights a pull-down that contains a list
of valid operators. The contents of the pull-down depend on the attribute selected as
not all operators are valid for all attributes. A suitable operator may be selected from
the list.

Most of the operators are self-explanatory, however, the following operators work as
described:

The In the List operator enables a list of values (separated by spaces) to be specified for the attribute value.
The values may be numeric or non-numeric, depending on the attribute type. For example, for the AREA
attribute using an In the List operator with a value of 0 1 3 would find items which have AREA attribute equal
to either 0, 1 or 3.

The In the Range Operator enables a range of two numeric values to be specified, i.e. an upper and a lower
limit, inclusive. For example, for the AREA attribute using an In the Range operator with a value of 1 10
would find items which have AREA attribute equal to any numeric value between and including 1 and 10.

4.3.3 Value

The Value column will either display a textbox, to allow a numeric or alpha-numeric
entry to be made, or an options list with relevant options that may be selected from the
list, for example True or False for a Boolean attribute.

www.aveva.com
© Copyright 1974 to current year. 35
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

4.4 Saved Searches

The Saved Searches fold-up panel enables


regularly used or complex searches to be
saved for later use.

Clicking the Create “Saved Search” Based on Current Search


Criteria link label displays the Create Saved Search form.

Entering a suitable name in the Name textbox activates the OK


button.

Clicking the OK button saves the search criteria to a file located in the Local Settings directory of the user’s
computer, e.g.

C:\DocumentsandSettings\<username>\LocalSettings\ApplicationData\Aveva\PDMS\Searches.Local
Settings, where <username> is the user’s Windows login name.

The entered name is displayed in the saved


searches options list and is available in future
sessions of PDMS.

Saved searches are also displayed in the options list on the


Search toolbar.

4.4.1 Executing Saved Searches

Saved searches may be executed from the Saved Searches fold-up panel of the Search form or from the
Search toolbar.

On the Search form, after selecting the required saved search to execute from the options list, clicking the
Search button adjacent to the options list executes the selected search.

On the Search toolbar, after selecting the required saved search to execute from the options list,
clicking the Run Search button executes the selected search.

4.4.2 Deleting Saved Searches

Saved searches may be deleted from the Saved Searches fold-up panel of the Search form, or from the
Search toolbar.

On the Search form, after selecting the required saved search to delete from the options list, clicking the
Delete Selected Saved Search link label deletes the selected search.

On the Search toolbar, after selecting the required saved search to delete from the options list, clicking
the Delete Search button deletes the selected search.

Using either method to delete a selected search displays a Delete


Search confirmation message.

Clicking the Yes button deletes the search and clicking the No
button does not delete the search.
www.aveva.com
© Copyright 1974 to current year. 36
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

4.4.3 Executing the Search from the Search form

Having specified the search criteria, clicking the Search button on the Search form executes the search with
the specified criteria. The search may display results quickly or it may take some time, depending on the
scope and complexity of the search and Attribute Filters.

As soon as the search is started, the Search button changes to a Stop button. Clicking the Stop button
stops the search and displays the results found so far, if any. The number of items found and the time taken
to find them is displayed adjacent to the Display Search Results link label at the top of the form.

4.5 Search Results

On completion of the search the utility automatically opens the Search Results form, if not already open,
and populates the grid with the items found for the given criteria.
 The Search Results form may be opened at any time by selecting Display > Search Results from the
main menu.

The Search Results form displays the results in a grid gadget.

Each column of the grid represents an attribute of an item in the


database(s). The columns to be displayed can be specified and the
results can be grouped, sorted and filtered.

Selected results may be dragged and dropped into a 3D View or


added to My Data and the complete grid may be printed or
exported to Excel.

Some attributes in the results grid may be edited individually or by


bulk editing.

4.5.1 Displaying Multiple Search Results

By default the search results are displayed in a tab on the Search Results form named Search Results 1.

Multiple search results may be


displayed by checking the Display
Search Results in Separate Tab
checkbox in the top area of the Search
form.

If unchecked (the default) all search


results will be displayed in the tab
named Search Results 1, i.e. the
previous search results will be
overwritten.

www.aveva.com
© Copyright 1974 to current year. 37
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

If checked, the search results will be displayed in a


new tab named Search Results n, where n is the
next sequential number of the displayed tabs.

For Saved Searches the tab name is the same as


the Saved Search name, providing the Search
button in the Saved Searches fold-up panel is used.

If the Saved Search is saved anywhere other than Local Settings the tab name will be in the form
<Location/Name> where Location is the pathname to the location of the Saved Search.

If a Saved Search tab is already open, running the Saved Search again will re-use the tab.

Clicking the down arrow button at the bottom right


corner of the form displays a pop-up menu
containing all of the tab names.

Selecting a tab from the menu name makes the tab


current.

Right clicking on any of the tabs displays a pop-up


menu with the following option:

 Synchronise Search with Tab – this option sets the parameters on the Search form to those used to
create the Search Results displayed in the selected tab, including any Attribute Filters.

A tab can be closed by clicking the cross in the bottom left of the form with the tab required selected.

If multiple search results are open and the Display Search Results in Separate Tab checkbox is
unchecked, all subsequent searches will be displayed in the default tab named Search Results 1.

4.5.2 Results Grid Pop-up Menu

Right clicking on any row in the grid displays a pop-up menu with the following
options:

 Remove Selected Rows – this option removes the selected rows from the results grid.
 Multiple rows may be selected using standard Window selection methods.
 Navigate To – this option navigates to the element in Design Explorer. If multiple rows are selected this
option is disabled.
 3D View – this option has a sub-menu that enables the elements in the selected rows to be added to,
removed from or highlighted/un-highlighted in, the 3D view.
 Add to My Data – this option adds the elements in the selected rows to My Data.
 The My Data form does not have to be open.

www.aveva.com
© Copyright 1974 to current year. 38
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

4.5.3 Results Grid Options and Attribute Editing

Right clicking in any column header displays a pop-up menu.

Some options can be enabled and disabled, i.e. clicking on these options
toggles them on and off. If any of these options are enabled a check icon is
displayed to the left of the option in the pop-up menu.

The menu has the following options:

 Column Setup… - this option displays the Table Column Setup form:

The Table Column Setup form enables columns to be added to or deleted from
the results grid and the columns to be re-ordered.

Clicking the Add Column link label displays a new line in the column grid. Any
valid attribute may be entered into the Attribute column and column heading text
entered into the column heading.

The Add Standard Attribute link label will add all the
standard attributes available.

Clicking the Delete Selected Columns link label will


delete single or multiple column selections.

The columns may be re-ordered by dragging a column


header into a new position.

Clicking the OK button will make the changes to the


columns.

 Clear Results – this option clears the results grid.

 Enable Group Sorting – this option toggles group sorting. If enabled, the Grid sort area is displayed
above the column headers. One or more column headers may be dragged into this area to group the grid
data by.

 Enable Filtering – this option toggles column filtering. If enabled, the grid data may be filtered on one or
more columns.

 Enable Column Summaries – this option toggles column summaries. If enabled, columns that contain
numeric data may be summarised and a summary symbol Σ is displayed in the column header.

Clicking the Σ symbol displays the Select Summaries form.

Various summaries may be selected using the appropriate


www.aveva.com
© Copyright 1974 to current year. 39
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

checkboxes. The summaries are displayed at the bottom of the grid


when a new search is initiated.

 Enable Column Sort – this option toggles column sorting. If enabled, columns may be sorted alpha-
numerically, either ascending or descending, by clicking on the column header. An arrow is displayed in
the column header to show that is sorted and the direction of the sort. Only one column may be sorted at
a time.
 Suppress “unset” values – this option toggles the suppression of unset attribute values. If this option
enabled attribute values that are set to unset are not displayed.

 Suppress “Nulref” values – this option toggles the suppression of attributes with a null reference. If this
option is enabled attribute values that have a null reference (Nulref) are not displayed.
 If columns are added that are based on attributes that have no meaning to some of the items found by
the search, e.g. a POS attribute has no meaning to a PIPE, the results grid shows the symbol
.
 Interaction Mode – this option enables element attributes to be edited, either singularly or in bulk, and
has a sub-menu.
Clicking on these options toggles them on and off. If an option is enabled a
check icon is displayed to the left of the option in the pop-up menu.

All options are mutually exclusive, i.e. only one may be enabled at any one
time.
 The Read only option does not allow any editing of the data in the results grid.
 The Single Cell Edit option enables attributes of elements displayed in the grid to be edited one cell
at a time. The cell contents are update and highlighted when the cursor is clicked in another cell.
Some attributes may not be edited, e.g. Type or Owner, cannot be edited as they are set by the
system. Text or numeric attributes are edited by entering appropriate values in the cells. For
Boolean attributes, e.g. Lock, an options list is displayed in the cell from which the appropriate
value, i.e. true or false, may be selected.

www.aveva.com
© Copyright 1974 to current year. 40
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Right clicking in an editable cell displays a pop-up menu with various


options that may be used on single cells only.

 The Bulk Cell Edit option enables multiple cells to be edited by using Cut, Paste, Fill Down or Fill
Up options available from a pop-up menu.

Right clicking in a single editable cell displays the pop-up menu with the
Copy option enabled.

Copying the data in the cell and right clicking in a single cell or right clicking
a multiple cell selection in the same column enables the Paste option by
which the data may be entered into the selected cell(s).
 Data cannot be copy and pasted into another column using this option.
Selecting multiple cells and right clicking displays the pop-up menu with the
Fill Down and Fill Up options enabled. Choosing these options will fill the
selected cells with the data from the top or bottom cell(s) in the selected
cell group respectively, depending on the option chosen.

 Feedback Colours – this option enables feedback colours to be set for cell display and editing and has a
sub-menu.

The sub-menu has the following options:

 Read Only Cell Colour… - this option displays the Read Only Cell Colour form:

The form displays the basic 16 PDMS colours. Selecting a


colour highlights the cells containing non-editable attributes
(Read Only attributes). This does affect editable attribute cells
if the Read Only Interaction Mode is set.

The Reset button resets the colour to the previously set


colour.

The More… button displays a larger form with 256 colours.

The default colour is white.

www.aveva.com
© Copyright 1974 to current year. 41
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 Edit Success Colour… - this option displays the Feedback Success Colour form:

Selecting a colour sets the edit success feedback colour, i.e.


when a cell is successfully edited it is highlighted in the
selected colour.

The Reset button resets the colour to the previously set


colour.

The More… button displays a larger form with 256 colours.

The default colour is cyan.

 Edit Fail Colour… - this option displays the Feedback Fail Colour form:

Selecting a colour sets the edit fail feedback colour, i.e. when
a cell edit fails it is highlighted in the selected colour.

The Reset button resets the colour to the previously set


colour.

The More… button displays a larger form with 256 colours.

The default colour is salmon.

 Reset Default Feedback Colours – this option resets the feedback colours to their defaults.
 When a cell has been edited and is highlighted in the success or fail colour, positioning the cursor
over the cell displays a tooltip with feedback on the edit. This is particularly useful if the edit has
failed.

 Reset Cell Feedback – this option un-highlights any cells that have been highlighted by cell editing. It
does not affect the Read Only feedback cell colour.
 Refresh – this option refreshes the data in the Search Results grid from the source data.
 Quick Report - this option sends the information contained within the search grid to the report utility
within PDMS for formatting.

 For information on Reporting please refer to the TM – 1004 AVEVA Plant (12.1) Reporting training
guide.
 Export to Excel – this option displays a standard Windows Save As dialogue where a location and
filename may be specified for the excel file. If grouping and filtering have been applied, the Excel file will
contain the groups and/or filters.
 Print Preview – this option displays the results grid in a standard Windows Print Preview dialogue where
it may be printed.

www.aveva.com
© Copyright 1974 to current year. 42
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 3 Search Utility

 Select Display > Search from the main menu to display the Search form. Enter EQUI in the Element
Types textbox. Note that the Beneath Element check box is checked and the default value of /*, i.e. the
World, is set in the adjacent textbox. Click the Search button to initiate the search.
 The search results are displayed in the Search Results form displayed automatically when the search is
complete.
 The default grid on the Search Results form has only two columns, NAME and TYPE. Right click in the
grid header row and select Column Setup… from the pop-up menu to display the Column Setup form.
Click the Add Column link label to add a new entry to the column list and in the Expression column
enter ZONE. Left click in the Heading column and note that ZONE is automatically entered. This can be
edited, if desired. Click the OK button on the Column Setup form. Note that the Search Results form
has been updated to include the new column.
 Enter PIPE in the Element Type textbox on the Search form in addition to the EQUI entry, i.e. EQUI
PIPE. Separate the entries with a space or a comma. Check the In Volume checkbox and click the Of
Element radio button. Navigate to Zone /ZONE-PIPING-AREA01 in Design Explorer and click the CE
button. Click the Wholly Within radio button at the bottom of the Search Filters fold-up panel.
 Click the Search button again to re-run the search. Note that the search has found all the EQUI and
PIPE elements wholly within the volume of the Area01 Piping Zone.
 Right click in the grid header row and select Enable Group Sorting from the pop-up menu. Note that
the group sorting area is now displayed above the results grid. Click and hold down the left mouse
button on the Zone column header and drag it to the left until it is the first column, the red arrow aids
help to determine the new position for the column. When in position, release the left mouse button.
 Left click on the Zone column header to sort the results by this column. Left click the Zone column
header again to reverse the sort. Drag the Zone column header into the Group area at the top of the
grid to group the results by the owning Zone. Note that there are two groups in the grid. Expand each
one and note the content of each. Drag the Zone column header back to the other column headers.
 Add one more column for the attribute Function to the Search Results form. Note that the Function
attribute is unset for all the PIPE and EQUI elements. Right click on the column header row in the
Search Results form and select Feedback Colours > Read Only Cell Colour… from the pop-up menu
to display the Read Only Cell Colour form. Click the Green button and then click the Dismiss button.
Note that the Zone and Type columns are now highlighted in green on the Search Results form.
 Right click on the column header row in the Search Results form and select Feedback Colours > Edit
Success Colour… from the pop-up menu to display the Edit Success Cell Colour form. Click the
Magenta button and then click the Dismiss button.
 Left click on the Type column header to sort the results in ascending order by Type. Right click on the
column header row in the Search Results form and select Interaction Mode > Single Cell Edit… from
the pop-up menu.
 Left click in the Function cell for the top row of the grid, i.e. an EQUI element, to highlight the unset
entry and enter Equipment in the cell. Left click in any other cell and note that the Function cell has
been highlighted in Magenta.
 Right click on the column header row in the Search Results form and select Interaction Mode > Bulk
Cell Edit… from the pop-up menu.
 Select the Function cells for all of the EQUI elements in the results grid, i.e. a multiple cell selection.
Right click in any of the Function cells and select Fill Down from the pop-up menu. Note that all the
EQUI elements now have their Function attribute set to Equipment and are highlighted in Magenta.
 Repeat this process for all the PIPE elements in the results grid by editing the Function attribute of the
bottom grid entry to Pipe and use the Fill Up option to modify the other cells.
 Right click on the column header row in the Search Results form and select Reset Cell Feedback from
the pop-up menu to un-highlight the edited cells. Right click on the column header row again and select
Refresh from the pop-up to show that the Function attributes have been changed at the data source.
www.aveva.com
© Copyright 1974 to current year. 43
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 Right click on the column header row in the Search Results form and select Export to Excel… from
the pop-up menu to display the Save As form. Choose a suitable storage location and enter Equipment
in the File name textbox. Click the Save button to save the Equipment.xls file.
 Locate the Equipment.xls file and double click it to open the file. Close the Search Results form.
 On the Search form enter BRAN in the Search for Element Types textbox, make the Zone /ZONE-
PIPING-AREA01, in the Site /SITE-PIPING-AREA01, the CE and click the CE button to the right of the
Beneath Element textbox on the Search form. Open the Attribute Filter fold-up panel if not already
open. Click the Add Filter link label to create a new filter. Select HBOR from the Attribute options list,
select Greater than from the Operator options list and enter 100 in the Value textbox.
 Click the Search button to obtain the search results. Right click in the grid header row and select
Column Setup… from the pop-up menu. Highlight the ZONE row and click the Delete Selected
Columns link label to delete the two columns. Create two new columns on the Column Setup grid,
HBOR (Head Bore) and TBOR (Tail Bore). Export the results to an Excel file named Pipe
Branches.xls. Close the Search and Search Results form.

www.aveva.com
© Copyright 1974 to current year. 44
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 5

5 User Grid Systems

The User Grid Systems utility creates 3D rectangular and radial grids in
Design. Grids may be project wide or local to a specific Plant area or a room
in a module or building.

Selecting Utilities > User Grid Systems… from the main menu displays the
User Grid Systems form.

The form is re-sizable and contains a pane to display available grid systems
and a number of options for formatting the displayed grid. The form menu
enables grids to be created and modified and the co-ordinates of a picked
point to be displayed in both World and Grid co-ordinate systems.

Grids are stored in a Design database and have their own hierarchy structure
as shown:

 Although user grid systems are stored in a Design database they do not appear in the Drawlist.

5.1 Creating 3D Rectangular Grids

Selecting Create > 3D Rectangular Grid… from the


User Grids Systems form menu displays the
Reference 3D Rectangular Grid form.

The form has two tabs, the Options tab where the
grid axis offsets, line IDs and labels are specified and
Position & Orientation tab where the location and
orientation of the grid are specified.

On the Options tab the Display area of the form


contains radio button options that control how the grid
is labelled in the 3D View.

The X Axis, Y Axis and Z Axis areas of the form


enable grid labels, line IDs and offsets to be specified
for each axis individually.

www.aveva.com
© Copyright 1974 to current year. 45
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

A label for the respective axis may be entered in the appropriate Label text box. The label should be
meaningful and will suffix the Grid Axis (GRIDAX) and Gridline (GRIDLN) element names in the Design
Explorer. The labels X, Y and EL (elevation) are commonly used for the X, Y and Z axes respectively.

The line IDs are used to identify individual gridlines and suffix the label in the Design Explorer. The ID format
may be alphabetic or numeric and may be incremented by any step.

The Offsets are relative values from the previous gridline. Negative or positive values may be entered which
will determine how the grid is distributed around the grid origin.

Clicking the Autofill… button on the Reference 3D


Rectangular Grid form displays the Autofill
Rectangular Grid System form.

This form enables the labels, range and interval of


offsets and the ID formats to be specified. When first
opened the form is populated with default values
which can be adjusted accordingly.

Having specified the required data clicking the OK


button will dismiss the form and autofill the Reference
3D Rectangular Grid form.

The auto filled Reference 3D Rectangular Grid form


may be edited manually to make the final adjustments
to the grid.

It is often easier to use the autofill function and edit


than enter all the data from scratch.

The Preview button will display the grid in the current


3D View so that it may be visually inspected before
creation.

The Set View Limits to Grid button zooms the view


such that the specified grid fills the 3D View.

www.aveva.com
© Copyright 1974 to current year. 46
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Position & Orientation tab enables the grid


origin to be positioned and the grid to be orientated.

The Position area of the form enables the grid origin


to be placed explicitly by entering East/West,
North/South and Up/Down, i.e. X, Y and Z, co-
ordinates in the relevant text boxes.

The direction may be changed by using the three pull-


downs. Checking one of the Lock checkboxes
disables the editing of that co-ordinate.

The position may also be specified by using the


Positioning Control Toolbar and graphically
selecting a position in the 3D View.

The With Respect To (WRT) textbox allows the


selection of co-ordinates with respect to any design
element. The default is World.

 See TM-1001 AVEVA Plant (12.1) Foundations for information on the Positioning Control Toolbar.

The Orientation area of the form enables the grid to be orientated in three ways:

1. Clicking the Through three point’s button prompts for the graphical selection of three points to
define the plane of the grid. When the orientation points have been picked, the Y is and Z is text boxes
are updated with new directions defined by the grid plane.

2. Clicking the Through origin and two points button prompts for the graphical selection of two
points which, together with the origin point, define the plane of the grid. When the orientation points have
been picked, the Y is and Z is text boxes are updated with new directions defined by the grid plane.
3. The orientation can also be set by entering a direction in the Y is and Z is text boxes. The X direction is
automatically derived, and is displayed beneath the two text boxes. Only one direction may be altered at
a time so it may require two or more entries to re-orientate the grid to the required orientation.
A grid name may be entered in the Name text box at the bottom of the Reference 3D Rectangular Grid
form. This name will be displayed on the User Grid Systems form so that it may be selected for future use
or modification.

Clicking the Save button creates the grid elements and displays the grid in the 3D View. If no Grid World
elements are in a writeable Design database, one is created automatically. If more than one writeable Grid
World exists, the new grid will be placed in the first available one in the hierarchy.

The Close button closes the Reference 3D Rectangular Grid form.

www.aveva.com
© Copyright 1974 to current year. 47
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

5.2 Creating 3D Radial Grids

Selecting Create > 3D Radial Grid… from the User


Grids Systems form menu displays the Reference
3D Radial Grid form.

The form has two tabs, the Options tab where the
angles, radii, offsets, line IDs and labels are specified
and Position & Orientation tab where the location
and orientation of the grid are specified.

On the Options tab the Display area of the form


contains radio button options that control how the
grid is labelled in the 3D View.

The Angles, Radii and Z Axis areas of the form


enable grid labels, line IDs, radial line angles,
concentric circular line radii and Z axis offsets to be
specified.

A label for the angles, radii and Z axis may be entered in the appropriate Label text box. The label should be
meaningful and will suffix the Grid Axis (GRIDAX) and Gridline (GRIDLN) element names in the Design
Explorer. The labels A, R and EL (elevation) are commonly used for the angles, radii and Z axis
respectively.

The line IDs are used to identify individual gridlines and suffix the label in the Design Explorer. The ID format
may be alphabetic or numeric and may be incremented by any step.

The Angles are in degrees, counter clockwise from East (X). The Radii are absolute values from the grid
origin and the Offsets are relative values from the previous gridline.

Clicking the Autofill… button on the Reference 3D


Radial Grid form displays the Autofill Radial Grid
System form.

This form enables the labels, range and interval of


offsets and the ID formats to be specified. When first
opened the form is populated with default values
which can be adjusted accordingly.

Having specified the required data clicking the OK


button will dismiss the form and autofill the Reference
3D Radial Grid form as shown below.

The auto filled Reference 3D Radial Grid form may


be edited manually to make the final adjustments to
the grid.

www.aveva.com
© Copyright 1974 to current year. 48
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

It is often easier to use the autofill function and edit


than enter all the data from scratch.

The Preview button will display the grid in the current


3D View to so that it may be visually inspected before
creation.

The Set View Limits to Grid button zooms the view


such that the specified grid fills the 3D View.

The Position & Orientation tab enables the grid


origin to be positioned and the grid to be orientated.

This tab functions as previously described for


Rectangular Grids.

www.aveva.com
© Copyright 1974 to current year. 49
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

5.3 Grid Display Options

When one or more grid systems have been created the Displaying grid
system area of the User Grid Systems form is activated.

Selecting a grid system from the Grid System pane and clicking the Display
button displays the selected grid in the 3D View and activates the Set View
Limits to Grid button which may be used to set the display limits to the whole
grid.

The Hide button removes the selected grid system from the view and re-
activates the Display button.

The radio buttons in the Display area of the form control the labelling of the
grid. The options produce the following results:

 Axes only displays the gridlines only with a label at the grid origin.

 Gridline IDs displays the gridline IDs prefixed with the specified label.

 Spacings displays the spacing between grid lines for rectangular grids and the spacings between
concentric circles and the angles between radial lines for radial grids.

www.aveva.com
© Copyright 1974 to current year. 50
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 Coordinates displays the co-ordinates of the grid lines, prefixed by the specified label, for a rectangular
grid and the distance from the origin of the concentric circles and the cumulative angle of the radial lines
for a radial grid.

These display settings are also available in the Display


area of the Reference 3D Rectangular Grid and
Reference 3D Radial Grid forms.

Clicking the Select display axes… button displays the Plant Grid Axes form, if the currently selected grid
is rectangular, or the Radial Grid Axes form if the currently selected grid is radial.

The Plant Grid Axes form enables the display plane for each
axis to be toggled On or Off and the location of the plane to be
selected, i.e. on a gridline.

The display of an axis plane is toggled using the checkbox


adjacent to the appropriate plane. The plane is located using the
pull-down for the appropriate plane. The list contains all of the
gridlines for that axis.

For example, displaying all three axes for the grid, i.e. checking
all three checkboxes and selecting X3 for the X Axis plane and
YB for the Y Axis plane gives the following result.

 When the Plant Grid Axes or Radial Grid Axes forms are opened, the grid is removed from the 3D
display and the Display button activated. Clicking the display button after the OK (or Cancel) buttons
have been clicked on the Grid Axes forms, re-displays the grid with any changes.

www.aveva.com
© Copyright 1974 to current year. 51
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Radial Grid Axes form enables the elevation, i.e. the Z
Axis location, to be specified at which the grid is displayed. The
pull-down shows all of the Z Axis locations specified when the
form was created or modified.

Selecting a location displays the whole grid at the selected


elevation.

 The 0 label indicates the grid origin.

5.4 Modifying User Grid Systems

Highlighting the grid to be modified in the Grid Systems area of the


User Grid Systems form and selecting Modify > Selected Grid
System… from the form menu displays the Modify Grid (nnnn),
where nnnn is the name of the selected grid.

The displayed form depends on the type of grid selected. Both forms are identical to the forms used for
creating the two grid types except that they are populated with the current settings of the selected grid and
the Name text box is greyed out

Having made the required changes to the grid, clicking the Save
button on the Modify Grid form displays a confirmation message to
replace the existing grid.

5.4.1 Deleting User Grid Systems

Highlighting the grid to be modified in the Grid Systems area of


the User Grid Systems form and selecting Delete > Selected
Grid System… from the form menu deletes the grid from the form
and from the 3D View if displayed.

Having selected Delete > Selected Grid System… a


confirmation message to delete the selected grid Is shown.
Clicking Yes will delete the grid. Clicking No will cancel the
process and maintain the grid.

www.aveva.com
© Copyright 1974 to current year. 52
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

5.5 Displaying Picked Positions in Grid Coordinates

A position may be picked from a 3D View and displayed in terms of Grid co-ordinates.

Selecting Display > Picked position in grid cords… from the


User Grid Systems form menu prompts for a position to be
picked and activates the Positioning Control Toolbar.

Having picked the position the Display Grid Coords form is


displayed, showing the position in both World and grid co-
ordinates.

The grid used for the co-ordinates is the current grid selected from
the User Grid Systems form. The grid name is displayed on the
Display Grid Coords form.

 The referenced grid does not have to be displayed to obtain the position in grid co-ordinates.

www.aveva.com
© Copyright 1974 to current year. 53
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 4 User Grid Systems


 Empty the Drawlist and make the World the CE. Select Utilities > User Grid Systems… from the main
menu to display the User Grid Systems form. Select Create > 3D Rectangular Grid… from the form
menu to display the Reference 3D Rectangular Grid form. Click the Autofill… button to display the
Autofill Rectangular Grid System form. Click the OK button on the form, accepting the default Autofill
values. Note that the Reference 3D Rectangular Grid has now been populated with values.
 Click the Preview button and the Set View Limits to Grid button, displaying the grid in the 3D View.
Enter Rectangular_Grid in the Name textbox and click the Save button. Using the Design Explorer
navigate to GRIDWL TRAINING-GRIDS. Note that a GRIDSY element named Rectangular_Grid has
been created. Click the Close button on the Reference 3D Rectangular Grid form.
 On the User Grid Systems form click the Gridline IDs radio button and then click the Display button to
display the grid with the selected annotation option. Note that the Gridline IDs are now displayed on the
grid. Try the other Display options.
 Click the Select display axes… button to display the Plant Grid Axes form. Check the Display plane
through X axis offset at and the Display plane through Y axis offset checkboxes. Leave the option
lists at their default values of X0, YA and EL0 and click the OK button. Note that the grid has been
removed from the 3D View. Click the Gridline IDs radio button on the User Grid Systems form and
then click the Display button. Note the changes to the displayed grid.
 Display the Plant Grid Axes form again and try different combinations of the different planes from the
option gadgets and note the different combination of grid planes.
 Create a 3D Radial Grid named Radial_Grid using the Autofill option on the Reference 3D Radial
Grid form. Enter A in the Label textbox for the Angles on the Autofill Radial Grid System form.
Display the radial grid and try the different labelling and axis options.
 Create a 3D Rectangular Grid named Area01_Grid with the following data:

www.aveva.com
© Copyright 1974 to current year. 54
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 6

6 Surface Treatment

The Surface Treatment utility enables specific paint types and coatings to be applied to individual Design
items such as piping, HVAC, structural elements, etc.

6.1 Definition of Surface Treatments

Surface treatments consist of surface preparation, primer, paint description, manufacturer and a coating
thickness. Surface treatments are defined in Paragon and stored in a Catalogue database.

 The definition of Surface Treatments is outside the scope of this training guide. Refer to TM-1303
AVEVA Plant (12.1) Project Design General Administration for information on how to define and modify
surface treatments in Paragon.
The database MASTER/PIPECATA, in the AVEVA sample data project MAS, contains a number of pre-
defined surface treatments, for example:

Surface treatments are referenced by Design elements via the attributes Inprtref and Ouprtref representing
the inside surface treatment and the outside surface treatment respectively. Only elements with these
attributes may have a surface treatment assigned to them.

www.aveva.com
© Copyright 1974 to current year. 55
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

6.2 Assigning a Surface Treatment

Selecting Utilities > Surface Treatment > Assign… from the main menu displays the Surface Treatment –
Assignment form.

6.2.1 Selecting Elements

The Scope definition area of the form assists in selecting database elements to assign surface treatment to
and displays them in the Selected elements area of the form in a grid.

The Scope definition options list may be used to filter by a particular element type. For example, if PIPE is
selected and a ZONE containing only EQUI elements is selected, the Selected elements grid does not
display any results. Similarly, if EQUI is selected and a ZONE containing only EQUI elements is selected,
only the EQUI elements are displayed in the grid. However, if ALL is selected the Zone containing only
EQUI elements will display the NOZZ elements as well.

The radio buttons in the Scope definition area have the following functionality:
 CE mem - includes members of the current element, i.e. elements owned by the CE.
www.aveva.com
© Copyright 1974 to current year. 56
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 ID – enables item(s) to be graphically picked from the 3D view.


 CE - includes the current element only.
 LIST– this radio button, and its associated options list, is only enabled if one or more lists are defined.
The options list adjacent contains all the currently defined lists. This option allows the selection of items
from predefined lists.
Clicking either the Select or Add Item buttons populates the Selected elements grid with the elements
based on the chosen method and criteria.

The Select button clears the grid of any existing elements and adds the selected items.

The Add Item button appends the selected items to the items already displayed in the grid.
 Only items which have Inprtref and Ouprtref attributes are added to the grid. Items without these
attributes are ignored.
Once the Selected elements grid is populated, elements from the grid must be selected to apply the
surface treatment to. Selections can be made from the grid using standard Windows selection methods.

6.2.2 Selecting the Surface Treatment

Once the elements required have been selected, the surface treatment to be applied and where it is to be
applied, can be selected from the bottom part of the Surface Treatment – Assignment form.

The database MASTER/PIPECATA contains four pre-defined Table groups (Selection Tables) which may
be selected using the Table group options list.

www.aveva.com
© Copyright 1974 to current year. 57
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

These options are:


 IPSP – Inside Paint Specification, rule based.
 OPSP – Outside Paint Specification, rule based.
 FACE – Face Code of Zone.
 GENE – General, non-rule based.
Each Table Group option has a number of specification based table items which are selected from the
Table item options list:

When a Table item has been selected the Specification, if applicable, Symbol code and Punch code
textboxes are automatically filled with the relevant information.

www.aveva.com
© Copyright 1974 to current year. 58
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

6.2.3 Applying the Surface Treatment

Having selected the elements to apply the surface treatment to and the required surface treatment, clicking
either the Inside, Outside or Both buttons will update the Selected elements grid with the appropriate
settings.

Clicking the Apply button on the form displays a warning message.

Clicking the OK button on the message assigns the


surface treatment to the specified items and removes
them from the Selected elements grid.

By Viewing the attributes of the processed elements it


can be seen that the Inprtref attribute has been
displayed accordingly.

6.2.3.1 Selected Elements Grid Pop-up Menu

Having selected items from the Selected elements grid, right clicking in
the grid item displays a pop-up menu which has the following options:
 Add to 3D view – this option adds the selected elements to the 3D
view.
 Change Inside codes from Spec – this option populates the inside
codes, i.e. INPRTR, STINRF, STINCD and PUINCD columns in the
grid, for the selected items using the current Table item data.
 Change Outside codes from Spec - this option populates the
outside codes, i.e. OUPRTR, STOURF, STOUCD and PUOUCD
columns in the grid, for the selected items using the current Table
item data.

www.aveva.com
© Copyright 1974 to current year. 59
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 Change IN/OUT codes from Spec - this option populates both the inside codes and outside codes for
the selected items using the current Table item data.
 The Apply button on the Surface Treatment – Assignment form will still need to be clicked to
update the attributes on the selected items after the grid is updated.
 Change codes from Table List – this option opens the Surface Treatment – Section form which is
described in detail in the next section.
 Remove selected list in Grid – this option removes the selected items from the grid.
 Remove all list in Grid – this option clears the grid.
 Print Grid – Opens the standard Print preview box allowing the page setup to be defined and the grid
printed.
 Grid to Excel file – Prompts the user to browse to a file location and save the grid as a Microsoft Excel,
.xls, file. This then saves the file to the selected location.

6.2.3.2 The Surface Treatment – Selection form

Having selected items from the Selected elements


grid, clicking the SRFList button at the bottom of the
Surface Treatment – Assignment form displays
the Surface Treatment – Selection form.

The form contains Table group and Table item


options list, whose functionality is the same as
previously described for the corresponding gadgets
on the Surface Treatment – Assignment form.
However, selecting a Table group and Table item
displays details and coatings of the surface
treatment.

Clicking the Inside, Outside or Both buttons


updates the selected items in the grid with the
details from the selected surface treatment.

The Clear button clears the details on the form.

 The Apply button on the Surface Treatment – Assignment form will still need to be clicked to
update the attributes on the selected items after the grid is updated.

www.aveva.com
© Copyright 1974 to current year. 60
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

6.3 Surface Treatment Calculation and Report

Once the surface treatments have been assigned to the required Design elements, the inside and outside
surface area for each component may be calculated and reported on.

With the required element as the CE, selecting Utilities > Surface Treatment > Report… from the main
menu displays the Surface Treatment – Report form.

The CE when the form is loaded is set automatically. Navigating to another element within the design
explorer and clicking the CE button will set that as the current CE for the form.

Clicking the Calculate button calculates the inside and outside surface area for each component owned by
the CE and displays the results in the Selected elements grid. Units for the calculated area derive from the
current session units for distance.
 The Units for Area displayed derive from the current session units for Distance, as defined in the units
setting form.

www.aveva.com
© Copyright 1974 to current year. 61
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Having selected items from the Selected elements grid, right clicking in the grid displays a pop-up menu
which has the following options:

 Add to 3D view – this option adds the selected elements to the


3D view.
 Remove selected list in Grid – this option removes the selected
items from the grid.
 Remove all list in Grid – this option clears the grid.
 Export to Excel… – Prompts the user to browse to a file location
and save the grid as a Microsoft Excel, .xls, file. This then saves
the file to the selected location.
 Print Preview… - Opens the standard Print preview box allowing
the page setup to be defined and the grid printed.

6.4 Surface Treatment – A Worked Example

Clear the Drawlist.

Select Utilities > Surface Treatment > Assign… from the main menu to display the Surface Treatment –
Assignment form.

Navigate to PIPE 100-B-1 in ZONE /ZONE-PIPING-AREA01 to make it the CE.

In the Scope definition area of the form select BRAN from the options list, make sure that the CE mem
radio button is selected, and click the Select button to populate the Selected elements grid with three
branches.

www.aveva.com
© Copyright 1974 to current year. 62
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Select all three branches in the grid to highlight them. Select IPSP from the Table group options list and, as
the pipe spec for the branches is A3B, select /MAS-IPSP-PSPE-A3B from the Table item options list.

Click the Inside button to populate the inside codes for the branches in the grid.

Select OPSP from the Table group options list and /MAS-OPSP-PSPE-A3B from the Table item options
list.

With the three branches still highlighted in the grid, right click to display the selected elements pop-up menu.
Select the Add to 3D view option to add the three branches to the 3D view.

Right click in the grid again and select the Change Outside codes from Spec option to populate the
outside codes for the branches in the grid.

www.aveva.com
© Copyright 1974 to current year. 63
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the Apply button on the bottom of the Surface Treatment – Assignment form and click the OK button
on the subsequent warning message.

Navigate to BRAN 100-B-1/B1 in the Design Explorer.


Right Click and select Attributes… to display the
Attributes form.

Scroll down to find the Inprtref and Ouprtref attributes


to verify that the change has been made.

Note that the three branches have been removed from


the Selected elements grid on the Surface Treatment
– Assignment form.

Dismiss the Attributes form.

Navigate to PIPE 150-A-3 in the Design Explorer and click the Select button on the Surface Treatment –
Assignment form to add two branches to the Selected items grid.

Navigate PIPE 80-A-11 in Design Explorer and click the Add Item button on the Surface Treatment –
Assignment form to add two branches to the Selected items grid. Repeat the process for PIPE 150-A-57.
There are now six branches in the grid.

Highlight all six branches in the grid and click the SRFList button on the Surface Treatment – Assignment
form to display the Surface Treatment – Selection form.

Select IPSP form the Table group options list and


/MAS-IPSP-PSPE-A1A from the Table item options
list to populate the Coating Lists grid.

Click the Inside button to populate the inside codes


on the Selected elements grid on the Surface
Treatment – Assignment form.

Select OPSP form the Table group options list and


/MAS-OPSP-PSPE-A1A from the Table item
options list to populate the Coating Lists grid.

Click the Outside to populate the outside codes on


the Selected elements grid on the Surface
Treatment – Assignment form.

Click the Dismiss button on the Surface Treatment


– Selection form.

www.aveva.com
© Copyright 1974 to current year. 64
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the Apply button on the bottom of the Surface Treatment – Assignment form and click the OK button
on the subsequent warning message to apply the selected surface treatments to the branches.

Click the Dismiss button on the Surface Treatment – Assignment form.

Navigate to PIPE 100-B-1 in Design Explorer and select Utilities > Surface Treatment > Report… from the
main menu to display the Surface Treatment – Report form.

Click the Calculate button to populate the Selected elements grid with the details of the pipe components,
assigned surface treatments and surface area for inside and outside.

Note that the gaskets have been assigned a surface treatment. To filter the gaskets from the report, on the
TYPE column, select the drop down list in the cell below the column header and unstick the GASK option
from the filter pop-up menu. www.aveva.com
© Copyright 1974 to current year. 65
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Note that the gaskets have now been filtered out of the report.

Right Click in the Selected Elements grid and select Export to Excel… to display the Save Surface
Treatment Data As form. Click the Save button on the form. Click the OK button on the subsequent
message form.

Now open the saved Excel file and validate the contents against the Selected Elements grid.

www.aveva.com
© Copyright 1974 to current year. 66
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 5 Surface Treatments

Assign appropriate surface treatments to the remaining pipes in the ZONE ZONE-PIPING-AREA01 and
create reports for them.

www.aveva.com
© Copyright 1974 to current year. 67
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

www.aveva.com
© Copyright 1974 to current year. 68
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 7

7 Mass Properties

7.1 Mass Properties Overview

The Mass Properties utilities are common across all applications in the Design module of PDMS. They
enable the user to obtain the Weight, Centre of Gravity (C of G), Surface Area and Volume for individual
items, parts of the model or the whole model.

Whilst the Surface Area and Volume utilities work in the same way for all disciplines, the weight data and
Centre of Gravity data for the Weight and Centre of Gravity utility is obtained from different sources
depending on the discipline.

7.1.1 Weight Data

For Piping, Cable Tray, HVAC and Cable, the weight data is stored against individual component weights
in the Properties database.

For Piping, the ‘wet’ weight, i.e. the pipe full of fluid, can only be calculated if the Fluref attribute is set on
the PIPE or BRAN elements.

For Equipment (EQUI), Volume Model (VOLM) and Sub Volume Model (SVOLM) elements, the weight
data is stored in the following attributes:
 Usrweight – the ‘dry’ weight of the element. A fixed value or an expression may be used.
 Usrwweight – the ‘wet’ weight of the element, i.e. the element ‘dry’ weight plus any fluids. A fixed
value or an expression may be used.
 Usrcogravity – the co-ordinates of the ‘dry’ centre of gravity from the elements origin, expressed in
the frame of reference of the element.
 Usrwcogravity – the co-ordinates of the ‘wet’ centre of gravity from the elements origin, expressed
in the frame of reference of the element.
A value or expression must be entered for each attribute on each element after it has been created.

For Structural elements and their soft types, the weight data is obtained by multiplying the volume (net or
gross) by the density of the assigned material stored in the Properties database.

7.1.2 Centre of Gravity Data

For Piping, Cable Tray and HVAC, the C of G position is taken from a Ppoint on the catalogue item whose
Purpose attribute is set to COFG. If the Ppoint does not exist then P0 is considered to be the items C of G
position.

For Equipment (EQUI), Volume Model (VOLM) and Sub Volume Model (SVOLM) elements, the C of G
position is stored in the following attributes:
 Usrcogravity – the co-ordinates of the ‘dry’ centre of gravity from the elements origin, expressed in
the frame of reference of the element.
 Usrwcogravity – the co-ordinates of the ‘wet’ centre of gravity from the elements origin, expressed
in the frame of reference of the element.
A value or expression must be entered for each attribute on each element after it has been created.

www.aveva.com
© Copyright 1974 to current year. 69
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

7.1.3 Accuracy of Mass Properties

The mass properties for Structural elements are calculated by the PDMS graphical engine and its
interpretation of the geometry. The accuracy of this calculation is defined by the graphics settings.

Selecting Settings > Graphics loads the graphics settings form. Selecting the Representation tab shows
the representation settings.

The accuracy of the mass properties calculation is defined using the Arc Tolerance setting. Arcs within
PDMS are approximated as a series of faceted edges. Reducing the arc tolerance increases the accuracy of
the result.

The default setting for arc tolerance is 10mm, representing an upper arc tolerance limit. The minimum Arc
tolerance that may be defined is 0.1mm. In this regard, the User must make a judgement between
calculation speed/system performance (improved with maximum Arc Tolerance) and accuracy (Improved
with minimum Arc Tolerance).

AVEVA recommends that the Arc Tolerance is set to 0.1mm when performing any mass property
calculations.

www.aveva.com
© Copyright 1974 to current year. 70
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

7.2 Weight and Centre of Gravity

Selecting Utilities > Mass Properties > Weight and Centre of Gravity… from the main menu displays the
Weight and Centre of Gravity form.

The upper section of the form allows the user to select the
elements to be considered in the calculations.

The Add buttons allow the user to populate the grid in the
Selected Elements area of the form.

The top Add button allows the user to add elements using the
method selected in the adjacent textbox.

The Add Elements options list


provides the following element
selection methods:

 Current Element – this option adds the Current Element to


the list.
 Element Members – this option adds all members of the
Current Element.
 Members with TUBI – this option adds all members of the
Current Element that contain elements of the type TUBI –
(implied tube).
 Current List – this option adds the current active list (if one
exists).
 Graphical Pick – this option allows the user to select
elements from the graphical display.
 Graphical Selection – this option uses the current graphical
selection.
 Within Area – this option allows the user to select an Area
from the 3D view.
 Within Volume of CE – this option adds all elements that fall
within the bounding box of the current element.
The lower Add button on the form allows the user to add elements using the Named Element textbox
adjacent. CE may be entered here as a valid name.
 The Within Area option has been designed to use AREADE elements. These elements are currently
only used for the Room Design application in AVEVA Marine and in AVEVA Plant Nuclear
Applications. The use of the ‘Use the Within Area Options’ section of the form will not be described in
detail in this training guide.

www.aveva.com
© Copyright 1974 to current year. 71
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Once the Selected Elements grid has been populated, right


clicking in any part of the grid displays a pop-up menu which
has the following options:
 Remove Selected Elements(s) – this option removes all
selected elements from the list.
 Remove all Elements – this option removes all elements
from the list.
 Enhance in 3D View – this option highlights all the
elements in the list in the 3D view.
 Unenhance in 3D View – this option will un-highlight all
elements in the list in the 3D view.

 Navigate To – this option is a toggle. When on, indicated by a tick to the left of the option, clicking on
any element in the list will navigate to it in the Design Explorer.
 Export to Excel – this option enables the Selection grid to be saved to Excel. The user is presented
with a standard windows dialogue box to choose the filename and location for the Excel file.
 Print Preview – this option produces a print preview of the Selection grid.
Initially the Selection grid has two columns, i.e. Type and Name. When the calculations are complete the
grid displays additional columns for Weight and C of G. The Grid can be filtered and sorted in the same
manner as any PDMS grid gadget.

The Settings area of the form enables adjustments to be made to


the Weight and Centre of Gravity calculations via a series of
options list and textboxes.

The Wet/Dry option list enables the selection of the Wet Weight
or Dry Weight to be used in the calculations.

The Negatives options list enables the user to select whether or not negative geometry (e.g. end
preparations, holes, etc) will be considered in the calculations. The options are:
 Consider (net) – this option allows for negative geometry and produces the most accurate result. The
data returned is appropriate for determining as-built weights for loading calculations, transport planning,
etc.
 Ignore (gross) – this option ignores the effect of negative geometry. The data returned is appropriate
for material cost estimating, etc.
 Ignore (rough) – this option is similar to the Ignore (gross) option, however, this calculation makes a
number of simplifications (basic arc tolerances, less iterations of surface smoothing of complex primitive
configurations, etc). It is quicker calculation and is a useful option for models with large amounts of data
or very complex geometry.
The Weight Of option list allows the user to specify whether the calculations will apply to the Element Only
or All Members associated with the element. For example, consider a section that owns several fittings.
Selecting All Members would include the geometry of the section and the fittings in the calculations.
Selecting Element Only would consider the section only and ignore the fittings.

When calculating mass properties the system uses the Representation Mass value which can be set in the
Representation Level textbox on the Weight and Centre of Gravity form or by using the Representation
tab on the Graphics Settings form.

The Refresh button adjacent to the Representation Level textbox will refresh the level setting if it is
changed on the Graphics Settings form.
www.aveva.com
© Copyright 1974 to current year. 72
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Representation Mass is similar to other representation settings for different drawing levels of detail. For
example, a very simple shape may be represented at Level 1, whereas more complicated geometry may be
represented at Level 6. A more simplistic shape representation will return a mass property more quickly,
though it will be less accurate than the result obtained when a detailed representation is considered.

The CofG wrt textbox is used to calculate the centre of gravity of an element with respect to another, the
default is /* (World) coordinates.

The user can input, for example, an element Name and the calculations will use this for the list of individual
Centres of Gravities. If the user changes the CofG wrt value on pressing the Return key the total Centre of
Gravity will be refreshed. To refresh the individual Centre of Gravities displayed in the Selected Elements
grid the calculation must be performed again.

Once the appropriate settings have been chosen the calculations are made by selecting the Apply button. If
all elements are valid, the total Weight and Centre of Gravity coordinates are displayed in the appropriate
textboxes. The individual element data is displayed in the Selection grid.
 The Weight and Centre of Gravity use the current session units for Mass and Distance respectively,
as defined in the units setting form.

If a weight or C of G cannot be determined for a selected element,


i.e. a component weight cannot be found (Piping, Cable, HVAC), the
Matref attribute is not set (Structural) or the user data has not be
entered (Equipment), an error message is returned for that element.

7.3 Surface Area

Selecting Utilities > Mass Properties > Surface Area… from the main menu displays the Surface form.

The top part of the form, including the Selected Elements grid,
looks and functions in a similar way as the Weight and Centre of
Gravity form described earlier, with the following differences.
 The Add Elements options list does not contain the Within
Area option.
 The Selection grid, when populated and the calculation run,
displays a column for the Surface, rather than Weight and
CofG.

The Settings area options functions in the similar way to those


described previously for the Weight and Centre of Gravity form.
Except instead of the CofG wrt text box the user is presented with
a Units option list.

Here the units displayed for surface area can be changed between
square mm, cm, m, inches and feet. This works independently of
the current session distance units.

Clicking the Apply button calculates the Total Surface area,


displaying the result in the Total Surface textbox and populating
the Surface column in the Selection grid for each element.

www.aveva.com
© Copyright 1974 to current year. 73
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

7.4 Volume

Selecting Utilities > Mass Properties > Volume… from the main menu in the Beams & Columns or
Panels & Plates application displays the Volume form.

The top part of the form, including the Selection grid, looks and
functions in a similar way as the Weight and Centre of Gravity
form described earlier, with the following differences.
 The Add Elements options list does not contain the Within
Area option.
 The Selection grid, when populated and the calculation run,
displays a column for the Volume rather than Weight and
CofG.

The Settings area options functions in the similar way to those


described previously for the Weight and Centre of Gravity form.
Except, instead of the CofG wrt text box the user is presented with
a Units dropdown list.

Here the units displayed for surface area can be changed between
cubic mm, cm, m, inches and feet. This works independently of
the current session distance units.

Clicking the Apply button calculates the Total Volume, displaying


the result in the Total Volume textbox and populating the Volume
column in the Selection grid for each element.

7.5 Using the Mass Properties Utility – A Worked Example

Exit PDMS.

Login to PDMS as a Structural Designer using the details provided by the Trainer, for example:

Project: Training (TRA)

Username: A.STEELMAN

Password: A

MDB: A-STRUCTURAL

Module: Design

Select Design > Structures > Beams & Columns… from the main menu to enter the Beams & Columns
application

This worked example utilises the STRU PIPERACK to demonstrate the functions of the Mass Properties
utility.

Add the STRU PIPERACK, in ZONE ZONE-STRUCTURAL-AREA01, to the 3D view. Click the Walk to
Drawlist button and set the view direction to Iso 3. www.aveva.com
© Copyright 1974 to current year. 74
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Select Modify > Materials… from the main menu to display the Set Material form. With the STRU
PIPERACK as the CE, select S355J0 Steel from the Materials list. Ensure the Cascade Material to all
offspring checkbox is selected and click the Apply button.

Click the Yes button on the confirmation form to set the Matref attribute of all PIPERACK elements to
S355J0 Steel. Dismiss the Set Material form.

7.5.1 Calculating Weight and Centre of Gravity

Select Utilities > MassProperties > Weight and Centre of Gravity… from the main menu to display the
Weight and Centre of Gravity form.

With the STRU PIPERACK as the CE, select Element Members from
the Add Elements options list and click the Add button.

Each FRMW within the STRU is listed in the Selected Elements grid.
Note that the elements are highlighted in the 3D view.

Leave the Settings area of the form at the default values then click the
Apply button.

The Selected Elements grid now contains two


further columns listing the Weight and CofG
coordinates for each FRMW.

Note the Total Weight and Centre of Gravity


at the bottom of the form for all FRMWs and
the axes aid graphically showing the Centre of
Gravity in the 3D view.

In the Settings area of the form enter J1 in the CofG wrt


textbox and press the Return key.

Note that the overall Centre of Gravity coordinates have


changed but the individual Centres of Gravity are the same.

Clicking the Apply button updates the individual Centres of


Gravity
Right Click within the grid, from the pop-up menu select
Remove All Elements to remove all elements from the
Selected Elements grid.

In the Named Element text box enter /ROW_J-BRACING


and press the Return key.

In the Settings area of the form enter WORLD in the CofG


wrt textbox and press the Return key.

Leave the other settings at the default values and click the
Apply button. Note the calculated Total Weight.
www.aveva.com
© Copyright 1974 to current year. 75
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

In the Settings area of the form, enter 2 in the Representation Level textbox and click the Refresh button.

Click the Apply button again and note the calculated Total
Weight. The total weight should have increased from the
previous calculation.

Close the Weight and Centre of Gravity form.

The difference in weights is due to the use of different Mass


Representation levels. In this example Mass Representation
Level 2 has utilised simplified geometry (e.g. no radius at
corners of the RHS) when considering the section profile.

By contrast, Mass Representation Level 6 utilised more


detailed geometry representation (e.g. radii at corners) when
considering the section profile.
 The geometry at different representation levels is set in
the structural profile catalogue.
In a similar manner to changing the way negative geometry is considered, the mass representation level
provides another tool allowing designers to choose between accuracy of result and speed of calculation.
 Care should be taken with the mass representation level and negative geometry. The designer must
consider how the returned information is to be used.

7.5.2 Calculating Surface Area

Change the viewing direction to a Plan North view.

Click the Walk to Drawlist button.

Using a Wholly Within selection rectangle, select the


eastern most bay of the STRU PIPERACK.

Select Utilities > Mass Properties > Surface Area… from the main menu to display the Surface form.

Select Graphical Selection from the Add Elements option list and click the Add button to display the
sections from the graphical selection in the Selection grid.

Change the viewing direction to Iso 3 and note the elements are highlighted in the 3D view.

www.aveva.com
© Copyright 1974 to current year. 76
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Enter 6 in the Representation Level textbox, press the Return


key and click the Update button.

Leave the other settings in the Settings area at the default


values.

Click the Apply button.

The Selection grid displays the Surface area for each individual
element and the surface area of all elements is displayed in the
Total Surface textbox at the bottom of the form.

Right Click in the Selected Elements grid and select Remove All Elements to remove all members from
the Selected Elements grid.

In the Design Explorer navigate to SCTN 2 of FRMW ROW_J of the PIPERACK. Select Current Element
from the Add Elements options list and click Add to add the section to the Selection grid.

This SCTN owns a number of web stiffener fittings where the bracing members are connected to it.

www.aveva.com
© Copyright 1974 to current year. 77
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

In the Settings area of the Surface form select


Element only from the Surface Of options list.

Click the Apply button and note the calculated Total


Surface area.

Change the Surface of setting to All Members and


click the Apply button again. Note the change in the
Total Surface value.

The Total Surface area calculated using the All Members option includes the area of the web stiffeners,
whereas, the Element only option ignored the stiffeners and considered the surface area of the section
only. Close the Surface form.

7.5.3 Calculating Volume

In the Design Explorer navigate to FRMW ROW_7 of the PIPERACK.

Select Utilities > Mass Properties > Volume… from the main menu to display the Volume form.

Select Element Members from the Add Elements option list and click the Add button to display the
members of ROW_7 in the Selection grid. Again Note the selected items are highlighted in the 3D View.

Leave the settings in the Settings area at the default values.

www.aveva.com
© Copyright 1974 to current year. 78
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the Apply button to calculate the volume.

The Selection grid displays the Volume for each individual


element and the surface area of all elements is displayed in the
Total Volume textbox at the bottom of the form.

Close the Volume form.

www.aveva.com
© Copyright 1974 to current year. 79
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 6 Calculating Mass Properties

This exercise adds weight and C of G data to the equipment in the Stabilizer Area 01 and then uses the
Mass Properties utilities to determine weight, centre of gravities, surface areas and volumes.

Navigate to ZONE ZONE-EQUIPMENT-AREA01 and, using the Attributes form, add the following data to
the relevant equipment attributes.

Equipment Name Usrweight Usrwweight Usrcogravity Usrwcogravity


C1101 15000 16000 E 0 N 0 U 10350 E 0 N 0 U 9900
D1201 3000 3200 E 0 S 2400 D 50 E 0 S 2400 D 50
E1301 2250 3000 E 0 N 3250 D 5 E 0 N 3250 D 5
E1302A 1200 1500 E 0 S 2750 U 55 E 0 S 2750 U 55
E1302B 1250 1550 E 0 S 2750 D 10 E 0 S 2750 D 10
P1501A & B 250 300 E 10 S 605 D 180 E 10 S 500 D 150
P1502A & B 400 475 E 0 S 600 D 275 E 0 S 550 D 250

 The syntax for entering the C of G values is (EA NB UC) where A, B, C are the ENU coordinate
values respectively.

Calculate the dry and wet weights and C of G for :PUMP P1501A and note that the obtained values
correspond to the input values.

Calculate the weight and C of G of different combinations of equipment, with respect to the World and to
other elements.

Calculate the surface area and volumes of individual pieces of equipment and combinations of equipment.

www.aveva.com
© Copyright 1974 to current year. 80
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 8

8 Linking Documents to Design Elements

8.1 Linking Documents Overview

Design elements may be linked to documents or external sources, e.g. web pages or email addresses.

8.1.1 Link World (LINKWL) Elements

All elements related to links are stored under a Link World (LINKWL) element which can store Link Folders
(LNFOLD), Link Classes (LNCLAS) and Link Descriptors (LNDESC).

It is possible to assign LNDESC to elements in other databases. It is, therefore, recommended that LINKWL
elements are created in their own DESIGN database to which all relevant teams have read and write
access. Usually the System Administrator will provide a database with the LINKWL element in it.

8.1.2 Link Folder (LNFOLD) Elements

Under a LINKWL it is possible to organise all elements into a tree structure using LNFOLD elements which
can own further LNFOLD elements, LNCLAS elements and LNDESC elements. This way it is possible to
freely configure the hierarchy.

8.1.3 Link Class (LNCLAS) Elements

Classification of documents is possible through the use of LNCLAS elements. Each LNDESC may be
classified by multiple classes. In the diagram below each LNDESC is associated with more than one
LNCLAS. A single LNCLAS may classify multiple LNDESC elements. In the diagram LNCLAS1 is
associated with all three LNDESC elements.

8.1.4 Link Descriptor (LNDESC) Elements

A LNDESC element holds a link to documents and external resources. Both external documents and draft
drawing elements can be referenced using the Urlfile attribute, a string storing the raw Uniform Resource
Locator (URL) of the linked document can be:
 a file – stored in the form "file:///Docsys/ProjectX/MyDocument.doc".
 a web page – stored in the form "http://www.aveva.com"
 an e-mail address - stored in the form “mailto:support@aveva.com"
 an internal database reference - (e.g. to a drawing) stored in a form "dabref://=12345/6789"
 any other external resource. www.aveva.com
© Copyright 1974 to current year. 81
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

8.2 Adding Links

With a LINKWL as the CE, selecting Display > Link


Documents > Add Link… from the main menu
displays the Add link to nnnn form, where nnnn is
the name of the CE.
 A LINKWL must exist in a writeable database
before links may be added to Design elements.
LNFOLD elements are optional.
The Choose link category area of the form enables
a link category, i.e. Existing file, Web page or E-mail
address to be selected.

Selecting any of these options changes the display in


the Link options area of the form.

Clicking the Existing file icon displays Name and


Description textboxes where appropriate name and
description entries may be made.

A pathname and file name may be entered in the Path


to file textbox.

Clicking the Choose file… button will display a


Choose file to link to browser where the file may be
located and, upon clicking the Open button, on the
browser, dismisses the browser and populates the
Path to file textbox.

Clicking the Web Page icon displays Name and


Description textboxes where appropriate name and
description entries may be made.

A web address may be entered in the Address textbox.

Clicking the Browse… button will display a Web


browser where the web address may be located and,
upon closing the web browser, the Address textbox is
populated with the web address.

www.aveva.com
© Copyright 1974 to current year. 82
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Clicking the E-mail address icon displays Name and


Description textboxes where appropriate name and
description entries may be made.

An email address may be entered in the E-mail


Address textbox and a subject heading for the email
entered in the Subject textbox.

Once the link options have been completed, clicking the


OK button on the Add link to nnnn form displays the
Select destination container form.

The form contains the LINKWL and any LNFOLD


elements that exist below the LINKWL.

Selecting the required container and clicking the OK


button creates a LNDESC element below the selected
LINKWL or LNFOLD.

At this stage, although the link has been created, no Design elements have been associated with it. To Link
the document to a design element, first select the required element within the Design Explorer then select
Display > Link Documents > Add Link… from the main menu to display the Add link to nnnn form again.

www.aveva.com
© Copyright 1974 to current year. 83
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Selecting the previously created link and clicking the OK


button associates the Design element with the document.
The Design element name has now been placed under the
LNDESC element in Design Explorer.

This method of creating links, i.e. creating the link first and then assigning Design elements to it, is useful if
the user is unsure about which elements are to be linked to the document. Alternatively, making a Design
element the CE prior to selecting Display > Link Documents > Add Link… the first time will automatically
associate the CE with the selected document or source and place it below the created LNDESC element.

Whichever method is used to create the LNDESC element,


other Design elements can be added to it by following the
procedure described above.

8.3 Displaying Links

Once links have been added, the links in which Design items are involved in may be displayed. Navigating
to an element in Design Explorer and selecting Display > Link Documents > Links from the main menu
displays the Linked Documents form. The form has two tabs, Links and Folders/Classes.

The Links tab displays document links with the CE, with the name of the CE displayed in the list header.

Right clicking on a link document in the list displays a pop-up menu with the following
options:

 Open – this option opens the linked document. If the link is an email address, the email application is
opened and a new email created with the address and subject populated with the details supplied in the
link.
 An application that enables the document or web page to be opened must be available to the
user. A link may also be opened by double clicking on it in the list.
 Rename – this option enables the Name of the link to be modified.
 Remove – this option deletes the link.
 Add link – this option displays the Add link to nnnn form, enabling a new link to be added.
Right clicking in the blank area of the list displays a pop-up menu with a single Add link option which
displays the Add link to nnnn form.
The Track CE checkbox, if checked, will display any links if a new CE is selected in Design Explorer.
www.aveva.com
© Copyright 1974 to current year. 84
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Assigned Classes section of the list displays any LNCLAS elements to which the link has been
assigned.

The Folders/Links tab displays any LNFOLD elements and the linked documents in the folder as well as
assigned LNCLAS elements.

Right clicking on a link document in the list displays a pop-up menu with the same options as described
previously for the Links tab.

Similarly, right clicking in the blank space of the list displays a pop-up menu with a single Add link option, as
described previously.

Right clicking on displayed element in the hierarchy area of the form (on the left side)
displays a pop-up menu with the following options:
 Cut – Removes the element from the Hierarchy and places it in memory to be
placed in another area via the paste command.
 Copy - Copies the element from the Hierarchy and places it in memory to be
placed in another area via the paste command.
 Rename - this option enables the Name of the LNFOLD or LINKWL to be
modified.
 Delete – this option deletes the selected LNFOLD, LNCLAS or LINKWL and displays a confirmation
message.

Clicking the Yes button deletes the selected element.


 New folder – this option creates a new LNFOLD element below the selected element.
 New class - this option creates a new LNCLAS element below the selected element.
 Collapse all – this option collapses the hierarchy tree.

Right clicking on blank area of the hierarchy area displays a pop-up menu with the
following options:

 New world – this option creates a new LINKWL element.


 Collapse all - this option collapses the hierarchy tree.
www.aveva.com
© Copyright 1974 to current year. 85
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

If a document to which links have been added is deleted or its location


moved, selecting the Open option or double clicking on the link displays an
error message.

8.4 Adding Document Links – A Worked Example

Navigate to the LINKWL named Document_Links in Design Explorer. Select Display > Link Documents >
Links from the main menu to display the Linked Documents form.

Select the Folders/Classes tab and right click on the


Document_Links entry in the hierarchy area of the form to display
the pop-up menu.

Select the New folder option from the pop-up menu and enter the
name Equipment-Drawings when the New Link Folder is created.

Close the Linked Documents form. Make the new LNFOLD the CE and select Display > Link Documents
> Add Link… to display the Add link to Equipment-Drawings form.

Click the Existing file icon in the Choose link category


area of the form to display file options in the Link options
area of the form.

Enter Equipment-Location-Area01 in the Name textbox


and Equipment Location Drawing Area 01 in the
Description textbox.

Click the Choose file… button to display the Choose file to


link to browser.

Browse to the folder as directed by the Trainer, typically


C:\AVEVA\Plant\Training12.1\Training\pdmsuser\Equip
ment Drawings, and select the file EQUIPMENT
LOCATION.jpg.

Click the Open button on the browser to dismiss the


browser and populate the Path to file textbox.

www.aveva.com
© Copyright 1974 to current year. 86
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the OK button on the Add link to /Equipment-


Drawings form to display the Select destination
container form.

Expand the Document_Links entry and select the


Equipment-Drawings entry.

Click the OK button on the Select destination container


form to create the LNDESC element.

Note that the LNDESC element has been created below the LNFOLD element in Design Explorer.

Navigate to the EQUI element C1101 in the ZONE /ZONE-EQUIPMENT-AREA01 to make it the CE.

Select Display > Link Documents > Add Link… from the main menu to display the Add link to /C1101
form.

The Existing link icon is highlighted as the default and


the Document_Links LINKWL is displayed in the Link
options area of the form.

Expand the Document_Links entry and the Equipment-


Drawings entry to display the linked document.

Select the linked document and click the OK button to


add the link to the equipment.

Note that C1101 has been added to the LNDESC


element in Design Explorer.

Repeat the process to link the equipment D1201 and E1301 in ZONE-EQUIPMENT-AREA01 to the
Equipment Location drawing.

Make :HEATEX E1302A the CE and select Display > Link Documents > Links from the main menu to
display the Linked Documents form. Check the Track CE checkbox.

Right click in the empty list to display the single entry pop-up menu and select the Add link option to display
the Add link to /E1302A form. The Existing link icon is highlighted as the default.

Expand the Document_Links entry and the Equipment-Drawings entry to display the linked document.

Select the linked document and click the OK button to add the link to the equipment.

Make :HEATEX E1302B the CE.

www.aveva.com
© Copyright 1974 to current year. 87
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Right click in the empty list to display the single entry pop-up menu and select the Add link option to display
the Add link to /E1302B form. The Existing link icon is highlighted as the default.

Expand the Document_Links entry and the Equipment-Drawings entry to display the linked document.

Select the linked document and click the OK button to add the link to the equipment.

Repeat the process to add the four :PUMP elements to the LNFOLD element. All equipment elements in
ZONE-EQUIPMENT-AREA01 are now linked to the Equipment Location drawing.

Do not close the Linked Documents form.

Navigate to EQUI element E1301 so that its linked document id displayed in the Linked Documents form.

Right click in the empty list to display the single entry pop-up menu and select the Add link option to display
the Add link to /E1301 form.

Click the Existing file icon in the Choose link category area of
the form to display file options in the Link options area of the
form.

Enter E1301-GA in the Name textbox and General Arrangement


of E1301 in the Description textbox.

Click the Choose file… button to display the Choose file to link
to browser.

Browse to the folder as directed by the Trainer, typically


C:\AVEVA\Plant\Training12.1.1\Training\pdmsuser\Equipment
Drawings, and select the file E1301 GA.jpg.

Click the Open button on the browser to dismiss the browser and
populate the Path to file textbox.

Click the OK button on the Add link to /Equipment-


Drawings form to display the Select destination
container form.

Expand the Document_Links entry and select the


Equipment-Drawings entry to highlight it.

Click the OK button on the Select destination container


form to create a new LNDESC element.

The Linked Documents form now displays two linked


documents for E1302A.

www.aveva.com
© Copyright 1974 to current year. 88
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Note that a new LNDESC element for E1301-GA has been created below the LNFOLD Equipment-
Drawings in Design Explorer.

Right click on one of the entries in the Linked Documents form to display the pop-up menu and select the
Open option. The linked document will open, providing a suitable application is available to the user.

Close the document and double click on the other linked document in the Linked Documents form to open
it. Close the document.

Exercise 7 Adding Linked Documents

Add links to the following equipment General Arrangement drawings:

Equipment Type Name GA Filename


:HEATEX E1302A E1302A&B GA.jpg
:HEATEX E1302B E1302A&B GA.jpg
:PUMP P1501A P1501A&B GA.jpg
:PUMP P1501B P1501A&B GA.jpg
:PUMP P1502A P1502A&B GA.jpg
:PUMP P1502B P1502A&B GA.jpg

Open each of the documents to test the links.

Dismiss the Linked Document forms.

Save Work.

www.aveva.com
© Copyright 1974 to current year. 89
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

www.aveva.com
© Copyright 1974 to current year. 90
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 9

9 Status Control

From initial planning to completed construction, a typical AVEVA Plant project contains a number of design
disciplines and processes. In order to maximise productivity and minimise costs it is essential to control and
communicate the progress of design activities. The Status Control utility has been developed to assist
designers with this process.

9.1 Overview

The Status Control utility is a highly configurable tool that allows users to control and report on the
progress of model objects. It works by defining a number of Status Values, that describe the current state
of a model object, and applies them to appropriate elements in the constructor modules (i.e. Design, Draft,
Paragon, etc.).
Status Values can perform two functions. They inform the user of an objects current status and they can be
used to influence subsequent design activities.
The terms used to describe Status Values are defined by an Administrator. They may represent project
milestones, WBS elements, percentage completion rates, or they may be simple descriptive terms.
The Administrator will also define the object types that the Status Values can be applied to. The object
type will vary by constructor module e.g. in Draft the object type may be DRWG but in Design the object type
could be PIPE, EQUI, etc.
Data Access Control (DAC) is often applied in conjunction with status control to impose restrictions on
model objects that have reached a particular status. For example, certain activities, such as modifying an
objects position, may be prohibited once a certain status is reached.
Any model object that has one or more status values assigned to it is considered to be a Controlled
Object. It may not be necessary to control all instances of a model object type. As such the Status Control
utility allows the user to select which instances will be controlled.

9.2 The Status Control Data Model

The diagram below illustrates the relationships that are utilised in AVEVA Plant by the Status Control utility:

www.aveva.com
© Copyright 1974 to current year. 91
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Status Values are created and stored in the dictionary database hierarchy. Within the Constructor Modules
a Status Link hierarchy is referenced by model objects. The Status Link also references the Status
Value held in the dictionary database. The status link hierarchy is hidden from designers, but it makes
extensive use of pseudo attributes which can be queried by the user if necessary.

9.3 The Status Controller Form

The Status Controller form is the primary tool used by designers to set, change, and report on the status
of model objects. Selecting Display > Status Controller from the main menu will open the Status
Controller form.
 When the form is first displayed the title of the form is displayed as Status Controller. Once status
layouts have been created the title of the form will update to reflect the status layout being considered.

The status controller form will display status data in columns. The rows are populated with those objects
that are, or could be, controlled by the selected status definitions. The features of the status controller
form will now be considered in further detail.

9.3.1 The Status Controller Form – Option Lists

Two option lists are presented to the user in the Status Controller form; the Status Layout option list and
the Focus Status option list.

The Status Layout options list presents all available


saved status layouts and holds the option that allows
the user to create a new layout. When the status
controller form is first accessed the options list will be
blank and the user will only be able to select the New
Layout option.

www.aveva.com
© Copyright 1974 to current year. 92
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Selecting the New Layout option displays the Select


Status Columns form from which the user can select
the definitions required for the layout by checking the
appropriate checkbox. That definition that will then be
displayed in the Focus Status options list

The user can also choose which of the default


columns they wish to display by checking the
appropriate checkboxes beneath the status definition
selected.

Clicking the OK button will confirm the action and


close the form.

The Status Controller form grid will then be updated to


show the selected columns and the elements which
can be controlled by the selected definition. The Focus
Status options list will be populated with the names of
each Status Definition that has been selected in the
layout setup. The Focus Status selected determines
the status values that are available for selection.

The status layout can the be saved by selecting the Save Status Layout button.

This opens the Save Layout As form. This shows the


current saved layouts which the user can select to
overwrite, or allows the entry of a new name in the
bottom text box. Clicking the OK button closes the form
and saves the Status Layout.

The title of the Status Controller form changes to that


of the current Status Layout.

9.3.2 The Status Controller Form – Toolbar

The Status Controller form contains several toolbars which allow the user to carry out a number of tasks
relevant to setting and changing status values, reporting, and saving layouts.

By default all toolbars are displayed on the Status Controller form.


The Status Commands toolbar consists of the following buttons:

Promote Promotes a controlled model object to a new status value.


Demote Demotes a controlled model object to a new status value.

Allows the user to set a model objects status, in order to control it. It also allows
Edit Status the user to select a status value from the valid transition values associated with
a status value. Clicking the Edit Status button opens the Status form.

www.aveva.com
© Copyright 1974 to current year. 93
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

This form shows the element to which the status is


applied, when the status was last updated and who last
updated the status.

The current status is shown in the drop down Status list.


Expanding this list shows the available status values. At
first the elements loaded will read not controlled. Only
once the initial status has been set is the element
controlled.

The status values from this point on will be those set by


the project administrator. However, once the element is
controlled the options to Promote and Demote the
element to different status levels become available
(assuming the user has access rights to do so).

Remove Removes the status from a controlled model object i.e. the model object is no longer
Status controlled by the status definition selected.

Allows the user to view the status history of a controlled object (or a selection of
Status
controlled objects). Changes of status and any associated comments will be
History
displayed.

Produces a graphical representation of the status values assigned to a group of


Statistical
model objects. Non-controlled model objects can be included and will appear as a
Reports
group.

The Element Interaction toolbar allows the user to select elements in the Status
Control Grid from the design explorer or graphical view. The toolbar consists of the
following buttons

Select CE
When clicked the Current Element in the Design Explorer will be selected within the
in Grid
Status Control grid.

Select CE
When clicked the members of the Current Element in the Design Explorer will be
Members
selected within the Status Control grid.
in Grid
.
Select
Graphical When clicked any element(s) selected in the 3D View will be selected within the
Selection Status Control grid.
in Grid

The Select CE in Grid button only becomes active when a valid element is selected in the design explorer.
That is elements covered by the current Status Layout. The Select CE Members in Grid is always active
and the Select Graphical Selection in Grd button becomes active when any element within the 3D View is
selected. If either of these two buttons are pressed and the selected element has no corresponding items in
the Status Control Grid one following error messages will be displayed.

www.aveva.com
© Copyright 1974 to current year. 94
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

9.3.3 The Status Controller Form – Context Menus

The Status Controller form contains context menus that allow the user to customise and save the status
layouts and change and report on status values.

Clicking the right mouse button when the pointer is positioned in the blank
row below the Column Headings will display a context menu. This menu allows
users to manipulate how the status layout is displayed.

Status Layout… This option will display the Select Status Columns form.
Here users can adjust the default columns displayed in the status layout by
making an appropriate selection in each checkbox. A similar process can be
undertaken for status definitions. Selecting the OK button once the selections
are made will apply the changes and close the form.

Column Setup… allows the user to change the column setup by opening the
Column Setup form.

On opening, the Column Setup form will display the


position, expression, heading and Visibility of each
column currently displayed in the status layout.

The order in which existing columns appear in the status


layout grid can be adjusted using this form. Select the row,
corresponding to the column to be shifted, using the cells
located at the left side of the form. The up and down arrows
in the top right corner of the form can then be used to
manipulate the position of the column.
 Although multiple rows can be selected, only one column
can be re-positioned at a time.

Two link labels in the lower section of the form allow the user to add or remove columns. Selecting the
Add Column link label will create a new row at the bottom of the list. The user must enter a suitable
attribute in the Expression column then enter a name in the Heading column.

If the user wishes to remove a column then the Delete Selected Columns link label should be selected. A
number of columns can be deleted at once. The appropriate row (or rows) must be selected using the
cells located on the left side of the form before the delete link label is selected.

The Add Standard Attributes link label adds columns for all the standard attributes for the controlled
design elements.

Settings options, including the resetting and refreshing of cells, behave in a similar manner to other grid
commands in AVEVA Plant applications. Editing functions with suppression of null values and interactive
feedback is supported.

Other commands available from this context menu allow the user to Save the layout, export the data to
Excel and print.

www.aveva.com
© Copyright 1974 to current year. 95
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Clicking the right mouse button when the pointer is positioned in the main grid
area of the status layout form will display another context menu. This menu allows
users to set and change status values, report on status values, and save layouts.

It allows the same functionality as the Status Commands Toolbar. Users can set
and edit the status value of any model object(s) selected in the grid. Both the Status
History and Statistical reporting functions can be accessed.
The menu also has a Navigate To option. Selecting this option will navigate to the selected model object
in the Design Explorer.

This function will only work if a single model object is selected in the layout grid.

9.3.4 Reporting Features

At any point a statistical report can be generated for the required elements. Selecting the required elements
in the grid and clicking the Statistical Report button on the Status Controller toolbar displays the default
graphical statistical report.

Each status value is reported on with a legend showing the colours used in the report. By moving the mouse
pointer over each category of the chart the segement is highlighted and the status value, number of
objects and percentage of controlled objects is displayed in a separate box.

Right clicking with the pointer in the chart legend displays a context menu. T he Chart Type entry enables a
variety of 2D and 3D report formats to be selected.

www.aveva.com
© Copyright 1974 to current year. 96
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Chart Legend entry has a sub-menu that enables the position of the
legend around the Statistical Report frame or turn it off completely.

The default position of the chart legend is Right.

Selecting another option places a check mark on the sub-menu to denote the
current selection.

The right click pop-up menu also allows the chart to be Printed or Saved. Statistical reports are saved as an
XML file. Any reports that are saved can also be Loaded to view again using the Right click pop-up menu.

Right clicking on the statistical graphic provides another pop-up menu.

List Elements - will list all the elements which fall within the statistical group
currently selected.

Add to My Data - adds the elements within the statistical group to the My Data
utility.

Add To 3D View - adds the elements within the statistical group to the 3D view.

Edit Status - opens the Status form and allows the user to change the status for
the elements within the selected statistical group.

Status History - opens the Status History form for the elements within the
selected statistical group.

www.aveva.com
© Copyright 1974 to current year. 97
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

9.3.4.1 Status History

The Status History of model objects may also be checked. Selecting an object from the Status
Controller form grid then right clicking and selecting Status History… from the context menu, or
clicking the Status History button on the Status Commands Toolbar displays the Status History
form:

All transition events associated with the object are listed. The comment field will display the last comment
associated with each status.

www.aveva.com
© Copyright 1974 to current year. 98
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

9.4 Using the Status Controller Form – A Worked Example

This example utilises the pipes created in the stabilizer project and a number of Status Definitions and
Values stored in a provided dictionary database.

Exit PDMS.

Login to PDMS as a Piping Designer using the details provided by the Trainer, for example:

Project: Training (TRA)

Username: A.PIPER

Password: A

MDB: A-PIPING

Module: Design

Select Design > Pipework… from the main menu to enter the Piping application

9.4.1 Creating and Configuring the Status Layout

Select Display > Status Controller from the main menu to display the Status Controller form.

Before setting the specifc objects to be contolled (in this case pipes). It is necessary to configure the Status
Controller form. This can be done by creating a new layout based around a Status Definition that has
already been created.

Select New Layout from the Status Layout options list to


display the Select Status Columns form.

All valid Status Definitions will be displayed in the form.


Expand the Status Definition DEFINITION FOR CRITICAL
PIPE WORKFLOW then check the checkbox adjacent to it.
Click the OK button.

The Status Controller form is updated to reflect the new status


definition being used.

The default columns are now displayed in the status controller


form along with all instances of the controllable model object
type (in this case PIPE) present in the model.

www.aveva.com
© Copyright 1974 to current year. 99
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the Save Status Layout button on the status commands


toolbar to display the Save Layout As form.

Enter Critical Pipes in the textbox at the bottom of the form


and then click the OK button.

It is unlikely that a user will want to controll all PIPE model object types, as this Type can also be used in
other design disciplines such as HVAC and Cable Tray. As such, the data displayed needs to be filtered to
show only the pipes required.

This example will focus on those Pipes with a specification of A3B. To assist the user in identifying the
correct pipes, a further column will be added to the status controller form.

With the mouse pointer centred on the Name column heading, click the right mouse button to display the
context menu. From the menu, select the Column Setup option.

From the lower section of the Column Setup form select the
Add Column link label. A new row will be added to the form.

Enter PSPEC in the Expression and Heading fields then click


the OK button. The Column Setup form will close and the
Status Controller form updates to show the new PSPEC
column at the far right of the form.

Click on the PSPEC heading and drag it to a position adjacent


to the Owner column.

Using the drop down list under the PSPEC heading select A3B from the filter options.

www.aveva.com
© Copyright 1974 to current year. 100
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Status Controller form should now look similar to this:

 Model objects that are not already shown in the 3D display can be selected in the Status Controller
form and dragged into the display.

9.4.2 Controlling Model Objects and Status Values

Althought the Status Controller form has been configured and the data displayed has been filtered, no
model objects have a status value assigned to them. By default model objects will not be controlled. The
user must select the specific model objects they wish to control and set a status value for them.

Select all the A3B pipes displayed in the Status Controller form (standard
Windows Shift and Ctrl selection rules can be used).

Using the Edit Status button from the Status toolbar, or the right click
context menu of the main grid, select the Edit Status option. The Status
form will be displayed.

The Status form allows the user to set the status of the model
objects selected and make a comment that will be associated
with the Status Transition.

Selecting either the Apply button or the OK button will action


the status change.

Using this method the user can set the objects status to any of
the valid transiton values.

Select the AWAITING RESOURCES option and add a suitable


comment before selecting the OK button.

The pipes with specification set to A3B are now controlled


objects. Buttons and menu options associated with adjusting the
objects status are now active.

Select pipe 200-B-4 from the status controller form then select the Promote button from the Status
Commands Toolbar.

www.aveva.com
© Copyright 1974 to current year. 101
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The Status form is again displayed, however this time the new
Status has been selected automatically as the Promote setting
was defined in Lexicon.

Enter a suitable comment then select the OK button.

The Status Controller grid will update to reflect the new status.

Continue to Promote /200-B-4 until it reaches status CONFIRM STRESS OK.

The status CONFIRM STRESS OK has two valid transitions.


Select the Demote option from the Status Command toolbar to
display the Status form.

The form is automatically populated with the Demote Status


Value set in Lexicon.

Enter a suitable comment then click the OK button.

It may become neccesary to remove Status Control from certain model objects. This may be due to an
initial selection error, or perhaps a more appropriate status definition has been created to suit the project
workflow. In either case, the designer can remove Status Control from model objects at any time.

The required objects must first be selected in the Status Controller form.

Once this is done, the user can select either the Remove Status button from the
Status Command toolbar, or select the Remove Status option from the context
menu.

www.aveva.com
© Copyright 1974 to current year. 102
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

A confirmation message is displayed for each item


selected in the Status Controller grid.

The user can accept or reject each error message


using the Yes or No buttons. If the user is certain that
all items should be changed they can select the Yes to
All Button.
 If Status Control is removed from a model object it will be recorded in the objects status history.
However, there is no comment facility associated with this status change.

www.aveva.com
© Copyright 1974 to current year. 103
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 8 Status Control

Using the Edit Status option, promote the following pipes to the corresponding status values:

PIPES STATUS
100-B-1, 100-B-2, 250-B-5, 80-B-7 PROVISIONAL LAYOUT
150-B-6, 100-B-8, 40-B-10 CONFIRM STRESS OK
50-B-9 ISSUED TO DRAFT TEAM
80-B-14 Not Controlled

Prepare a series of statistical reports to show the status of the controlled objects and view the history of
several objects and verify this against the status changes made.

www.aveva.com
© Copyright 1974 to current year. 104
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 10

10 Representation Rules in Design

10.1 Overview

The representation of items in a 3D view can be controlled according to project or user defined rules to
provide easy visualisation by discipline, status or any other available attribute.

For example, in the image below, larger bore pipes are shown in green tube with semi-translucent insulation,
smaller bore pipes are shown in blue centreline and instruments are shown in tan or sandybrown according
to their dry weights.

Selecting Settings > Graphics… from the main menu displays the Graphics Settings form. On the
Representation tab, clicking the Advanced… button displays the Representation Rules form where
representation rules can be created, modified, saved and applied.

www.aveva.com
© Copyright 1974 to current year. 105
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

10.2 Creating Design Representation Rules

The Representation Settings area of the form enables the rules to be defined.

An element type must be selected using the Gtype options list, which currently contains the following
element types:

PIPE NOZZ STRU GWALL


BRAN HVAC FRMW CFLOOR
CWBRAN INST SBFR FLOOR
EQUI VALV CWALL DETGRP
SUBE CWAY STWALL

The other buttons, checkboxes, options list and textboxes enable the graphic settings to be set in the same
way as used on the Graphics Settings form. Once the appropriate values have been set, clicking the Add
to End of List button appends the rule to the list in the Representation List, where all the rule settings are
displayed.

10.3 Modifying Design Representation Rules

Rules may be edited by clicking on a rule in the Representation List which copies the settings to the
Representation Settings area.

After making the required modifications, clicking the Replace Selection button will update the rule settings
in the Representation List.

The Move Up , Move to Top , Move Down and Move to bottom buttons on the right side of
the Representation List may be used to move the selected rule accordingly in the list. Only one rule may
be moved at once.

www.aveva.com
© Copyright 1974 to current year. 106
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

 The order of the rules is important to give the desired results. Rules for Branch Members, e.g. INST,
must be below rules for PIPE or HVAC. A warning message is displayed when rules are applied
where this is not the case.
A rule may be deleted by selecting it in the Representation List and clicking the Delete button on the
right hand side of the list.

10.4 Saving, Loading and Applying the Rules

Once representation rules have been


defined they may be saved by selecting
File > Save from the form menu to display
the Representation Rule Sets browser.

The browser defaults to the project


defaults folder, however, the user may
browse to any folder; enter a suitable
filename and click the Save button on the
browser.

The file is saved as a .pmldat file.

A file may be loaded by selecting


File > Load from the Representation
Rules form menu to display the
Representation Rules Sets browser, the
file located and the Open button clicked to
load the file.

Once a file has been saved or loaded, its pathname and file name are displayed in the Current File area of
the Representation Rules form.

The last file used in a session is remembered for the next session.

The OK and Apply buttons on the Representation Rules form apply the rules to the current Drawlist. For
each item in the Drawlist, the first rule that satisfies the Gtype and Rule Expression applies its settings to
that item.

As the rules are applied to items already in the Drawlist, if items are added to
the Drawlist which the rules will affect, the rules must be re-applied.

The rules can be applied by clicking the Apply Representation Rule Set button
on the left side of the 3D view.

Clicking the Reset Display button on the Representation Rules form returns
the 3D view to its default representation settings.
www.aveva.com
© Copyright 1974 to current year. 107
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

10.5 Design Representation Rules – A Worked Example

This worked example creates some simple representation rules for various discipline and element types.

Clear the Drawlist and add back ZONE ZONE-PIPING-AREA01.

Set the view direction to Iso 3.

Select Settings > Graphics… from the main menu to display the Graphics Settings form. Make the
Representation tab current and click the Advanced… button to display the Representation Rules form.

In the Representation Settings area of the form, leave the Gtype setting to the default of PIPE and enter
BORE GT 100mm in the Rule Expression textbox.

Click the colour button to display the Colour form and select Green. Click the Dismiss button on the
Colour form.

Make sure the Tube checkbox is checked (the default) and select 50% from the Obstruction options list.

Enter 6 in the Level textbox and 1 in the Arc Tolerance textbox.

Click the Add to End of List button to add the rule to the Representation List.

Click the Apply button on the Representation Rules form and note that some of the pipes are displayed in
green with semi-translucent obstruction volumes around the valves in the 3D view.

Enter BORE GT 50mm in the Rule Expression textbox, select Royalblue via the colour button, uncheck
the Tube checkbox and check the Centreline checkbox. Select Off from the Obstruction options list and
leave the Level and Arc Tolerance settings as previously specified.
www.aveva.com
© Copyright 1974 to current year. 108
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Click the Add to End of List button to add the rule to the Representation List.

Enter BORE LE 50mm in the Rule Expression textbox, select Brightred via the colour button and leave
the other settings as previously specified.

Click the Add to End of List button to add the rule to the Representation List.

Select the BORE GT 50mm rule and click the button to move this rule to the top of the list. Now when
the rules are used all pipes with a bore greater than 50mm will be coloured blue, however if they are then
over 100mm they are coloured green. This is important as the rules are evaluated in order.

Click the Apply button on the Representation Rules form and note the difference in representation of the
pipes according to their bore size in the 3D view.

www.aveva.com
© Copyright 1974 to current year. 109
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Select INST from the Gtype options list. Enter BORE OF PIPE LE 50mm in the Rule Expression textbox,
select Magenta via the colour button, uncheck the Centreline checkbox and check the Tube checkbox.

Select 50% from the Obstruction options list and leave the Level and Arc Tolerance settings as previously
specified.

Click the Add to End of List button to add the rule to the Representation List.

Enter BORE OF PIPE GT 50mm in the Rule Expression textbox, select Turquoise via the colour button
and leave the other settings as previously specified.

Click the Add to End of List button to add the rule to the Representation List.

Left click on the last rule in the list to highlight it in blue and click the Move to Top button on the right side of
the Representation List to move the INST rule to the top of the list.

Click the Apply button on the Representation Rules form.

An error message is displayed saying that the INST rule


must be below the rules for Gtype PIPE in the list.

Click the OK button on the error message to dismiss it.

Move the INST rule at the top of the list to the bottom of the list using the Move to Bottom button on the
right side of the Representation List.

Add ZONE ZONE-EQUIPMENT-AREA01 to the Drawlist and click the Walk to Draw List button on the 3D
view.

On the Representation Rules form select EQUI form the Gtype options list and enter ACTTYPE EQ
‘:PUMP’ in the Rule Expression textbox.

Select Chocolate via the colour button and select Off from the Obstruction options list. Leave the other
settings as previously specified.

Click the Add to End of List button to add the rule to the Representation List.

Leave the Gtype options list as EQUI, clear the Rule Expression textbox so there is no expression, select
Khaki via the colour form and leave the settings as previously specified.

Click the Add to End of List button to add the rule to the Representation List.

Add ZONE ZONE-STRUCTURAL-AREA01 to the Drawlist and click the Walk to Draw List button on the
3D view.

Select STRU form the Gtype options list and enter NAME EQ ‘/EQUIP_SUPPORT’ in the Rule Expression
textbox. www.aveva.com
© Copyright 1974 to current year. 110
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Select Springreen via the colour button and select Off from the Obstruction options list and leave the
other settings as previously specified.

Click the Add to End of List button to add the rule to the Representation List.

Modify the Rule Expression to NAME EQ ‘/PIPERACK’, select Mauve via the colour form and click the
Add to End of List button to add the rule to the Representation List.

Click the Apply button on the Representation Rules form to apply the rules to the Drawlist.

Select File > Save from the Representation Rules form menu to display the Representation Rule Sets
browser.

Leave the Save in textbox at the default folder, enter Training Rep Rules in the File textbox and click the
Save button on the browser. This saves the file and dismisses the form with the file extension of .pmldat.

The file pathname and filename are now displayed in the Current File area of the form.

Click the Reset Display button on the Representation Rules form and note that the display resets to the
default display colours, i.e. those set by the Auto Colour Rules.

Click the OK button on the Representation Rules form to dismiss it.

Click the Apply Representation Rule Set button on the left side of the 3D view and note that the rules from
the current file have been re-applied.

www.aveva.com
© Copyright 1974 to current year. 111
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Remove the ZONE ZONE-PIPING-AREA01 from the Drawlist and add it immediately back in. Note that the
piping has returned to its default representation.

Click the Apply Representation Rule Set button again and note that the piping now conforms to the
specified representation rules.

Save Work.

www.aveva.com
© Copyright 1974 to current year. 112
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 11

11 Standard Model Library

11.1 Overview

The Standard Model Library provides a library of pre-defined hierarchies containing modelled, single or
multi-discipline elements that can be used in the model as many times as required throughout the project. It
is available through the Equipment Application.

Standard Model Library captures design elements and stores them within an Application Data World
(APPLDW) referred to as a Library.

This in turn owns Application Data Area (APPLDAR) elements referred to as a Library Area.

The PURPose attribute of each of these elements is set to STDM to distinguish them from other Application
Data Worlds used with other utilities and allows them to store Application Data elements (APPLDA)
referred to as Library Items.

Underneath the Library Item sits a Zone which holds the captured design elements.

Library Models may contain elements from several design disciplines. In some cases the designer using the
Model Library may not have right access to all of the design elements. For example an equipment designer
may not be able to modify structural sections. In this instance the equipment designer can utilise the
standard library to create and initially position a library item within the model, but would then be unable to
modify the position of the structural segments after.

It should be noted that design items created from a Library Item are Design Elements and do not contain
any reference to the Library Item from which they were created. If the Library Item is modified this change
would not be reflected in the design elements created.
 Library Items are usually added by an Administrator once the status of the Library Item is verified for
release. As such the creation of the Library, Library Area and Library Items is not covered in this
training guide.

 For information on the creation of Standard Model Library items please refer to the TM-1303 AVEVA
Plant (12.1) Project Design General Administration training guide.

www.aveva.com
© Copyright 1974 to current year. 113
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

11.2 Creating from the Standard Model Library

Items stored in the Standard Model Library can be placed an unlimited number of times within the design.
To create an instance of the Library Item select Create > From Standard Model Library… The Create
Standard Model Library Item form is displayed.

To create a Library Item the user must set a storage zone,


under which the design elements will be created.

If a zone was the CE when the form was launched it will


appear in the text box at the top of the form. If a zone was not
selected the text box turns red and asks the user to navigate
to a zone.

A zone can be selected, or re-selected by selecting a zone


from the design explorer and pressing the Zone button. The
selected zone will then appear in the adjacent textbox.

The Selection frame allows the selection of the library and


library areas to be used. These are chosen from the two drop
down lists which display the available selections.

The Toggle Name / Description checkbox toggles between


displaying the name and the description of Library Items.

Once a Library Area Is selected the Library Items stored


within that area become available within the Standard Model
Library Items list. Selecting an item from this list makes it
the current Model Item and it is displayed in the forms 3D
view.

The New Instance frame shows several attributes which can


be set when the new item is placed into the design.

Name – Allows the user to select a name for the Library


Item. The user can select the Use Autoname checkbox to
utilise autonaming rules, if suitable rules are available.

Orientate Y is, and Z is - allow the orientation, with respect


to the world co-ordinates to be defined, prior to creation. The
default values are the same as for the Orientation commands
within PDMS, Y is N and Z is U.

Although the default values are wrt the world, another element, e.g. the owning site could be used by
entering WRT then the element name into the text box.

An occurance of the Library Item can be created and positioned within the design by selecting the Create
and Position link label. The prompt bar on the form and the main 3D view cahnges to ‘Pick New Item
position’ and the positioning control toolbar is activated.

Any item can be selected from the main 3D view to act as the origin of the new item. The Model Item data is
then created and positioned at the selected position.

www.aveva.com
© Copyright 1974 to current year. 114
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Once positioned the item creates the required design elements, which behave as any design element of the
same type does.

11.3 Using Standard Model Library Elements - A Worked Example

Enter the Equipment Application by selecting Design > Equipment.

Load the sample Standard Model Library data from the Training Setup form Utilities > Training Setup…
Select the General tab, check the Add Standard Model Library Data checkbox and click the Apply button.

Dismiss the form.

Several Standard Model Library Items are now available for use within the model.

Add /ZONE-ELECTRICAL-AREA03, /ZONE-STRUCTURAL-AREA03 and /ZONE-CIVIL-AREA03 to the


main 3D View.

Open the Create Standard Model Library Item form by selecting Create > From Standard Model
Library…

In the Design Explorer select /ZONE_ELECTRICAL_AREA03 and click the ZONE button to set the Item
storage area.

From the Library options list. Sample Standard Model Data and from the Library Area options list select
the Standard Model Data Area Library Area. From the Standard Model Library Items list box select the
Standard Model Library Light. The 3D view on the form should then update with the Light Standard Item.

The Standard Library Item has its origin positioned in the centre between the two hangers allowing simple
positioning. Lights are going to be added to the lower beams between columns D10 and D11, G10 and
G11, J10 and J11.

The first Light will be positioned between D10 and D11. In the Name text box enter LT-103-B2.

In the Orientate Y text box enter N WRT /*.

Now click the Create and Position Link label. The Position Control Toolbar is activated allowing the full
range of graphical picking options. In this case the light will be positioned at the mid point of the beam. As
such select Pline, Midpoint from the Position Control Toolbar.

Now select the top of the BOS pline on the Bottom face of the beam between columns D10 and D11.

www.aveva.com
© Copyright 1974 to current year. 115
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The new Light will then be positioned in the centre of the beam. Repeat this process on the beams between
columns G10 and G11, J10 and J11 naming them LT-103-B3 and LT-107-B4 respectivley.

Note that all of the lights are created in the existing zone because the Library Item contains a single design
element. Next a Library Item containing multiple design elements from multiple disciplines will be used.

Select the Library Sample Standard Model Data from the Library drop down list. Then select Standard
Model Data Area from the Library Area drop down list. The Standard Model Library Items list now shows
the Library Item PUMP KIOSK FOR STANDARD MODEL LIBRARY. Selecting this from the list shows the
Library Item in the 3D View.

In this case the Library Item is a captured zone containing design elements from the Structural, Equipment
and Piping disciplines.

In the Name text box enter PUMP_KIOSK_01.

The kiosk will be positioned with the doors facing South. To allow this the orientate Y is set to W WRT /*

Select the Create and Position link label to create and position the Library Item.

The kiosk will be positioned on the main foundation slab in the south west corner. On the Position Control
Toolbar select position explicitly option and set the co-ordinates as W 319200 N 332500 www.aveva.com
U 100000.

© Copyright 1974 to current year. 116


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The new pump kiosk is created in the design. Note that due to the multiple discipline elements a new zone
has been created.

It is possible to include model Items with multiple design items using a User Defined Element Type
(UDET), which has a base type of Zone, but which can be stored under a zone.

 The creation of User Defined Element Types is not covered in this training guide and is usually
performed by a system administrator. For information on the creation and management of User Defined
Element Types please see the TM–1308 AVEVA Plant (12.1) Lexicon training guide.

In this case an UDET named: skid will be used. The: SKID is a zone element, able to be stored beneath
another zone.

Add /ZONE-PIPING-AREA03 to the 3D View.

 A colon infront of an element type indicates it is an User Defined Element Type.

Select the Library Sample Standard Model Data from the Library drop down list. Then select Standard
Model Data Area from the Library Area drop down list. The Standard Model Library Items list now shows
the Library Item Skid Mounted Pump Arrangement. Selecting this from the list shows the Library Item in
the 3D View.

www.aveva.com
© Copyright 1974 to current year. 117
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The SKID origin is located in the Centre of Upper Nozzle. This allows simple positioning of the SKID to the
Pipework. Two skids will be added connecting to pipes 0350-B-23, 03100-B-24, 0350-B-24, and 03100-B-
25.

In the Design Explorer select /ZONE_EQUIPMENT_AREA03 and click the ZONE button to set the Item
storage area.

Enter the name 03SKID1 and ensure the Orientate Y is set to S WRT /*.

Select the Create and Position Link Label to activate the Position Control Toolbar. On this toolbar select
Element and Snap.

Now Select the Head Flange on Pipe 0350-B-23.

Repeat the process for Pipe 0350-B-24, naming it 03SKID2.

www.aveva.com
© Copyright 1974 to current year. 118
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

The skids should now be positioned as follows.

In the Heirarchy note that the element :SKID is positioned underneath the Equipment Zone and that the
element name is :SKID but it has the same symbol as a normal Zone.

www.aveva.com
© Copyright 1974 to current year. 119
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Plant (12.1)
Design Utilities TM-1003

Exercise 9 Using the Standard Model Library

Using the Standard Model library add lights to all of the beams of the PIPERACK in Area 01

www.aveva.com
© Copyright 1974 to current year. 120
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like