AVEVA Marine

(12.1)

TRAINING GUIDE
Equipment Seat Application

TM-2242

www.aveva.com
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

www.aveva.com
2
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Revision Log
Date Page(s) Revision Description of Revision Author Reviewed Approved
Nick R,
23/05/2012 All 0.1 Issued for review Bright K, Wayne R
Ginny S
Nick R,
12/06/2012 All 0.2 Feedback updated Wayne R
Ginny S
Nick R,
20/06/2012 All 1.0 Approved to issue Wayne R Wayne R
Ginny S
Nick R,
03/01/2013 All 2.0 Updated to 12.1.SP3 Wayne R
Elva L
Updated to 12.1.SP4 Nick R,
15/05/2013 All 3.0 Wayne R
Approved for Training Elva L

Updates
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 the AVEVA
EDS - Training & Product Support at [email protected]

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.

© Copyright 1974 to current year. 3

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

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.

© 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

2 Equipment Seat Application Features ................................................................................................... 9

2.1 Introduction to Equipment Seat Application ................................................................................ 9
2.2 How to Store Equipment Seat Modelling Data ........................................................................... 10
2.3 Installing Application and Configuring Environment ................................................................ 11
2.4 Starting Application ....................................................................................................................... 13

3 Contexts, Design Groups and Materials ............................................................................................. 15

3.1 Contexts ......................................................................................................................................... 15
3.2 Design Groups ............................................................................................................................... 16
Exercise 1 – Creating Context and Design Group ..................................................................................... 19
3.3 Materials ......................................................................................................................................... 20
3.3.1 Profile & Pad Tab ......................................................................................................................... 20
3.3.2 Plate Tab...................................................................................................................................... 21
3.3.3 Earth Bolts Tab ............................................................................................................................ 22
Exercise 2 – Setting Material for Context ................................................................................................... 23

4 Defaults................................................................................................................................................... 25

5 Bolt Information of Equipment ............................................................................................................. 29

5.1 Using Design Point ........................................................................................................................ 29
5.2 Using Negative Cylinder ............................................................................................................... 30
Exercise 3 – Creating Design Point for EQUI ............................................................................................. 32
Exercise 4 – Creating Negative Cylinder for EQUI ..................................................................................... 33

6 Equipment Seat Modelling.................................................................................................................... 35

6.1 Seat Designer ................................................................................................................................. 35
6.1.1 Toolbar Icons ............................................................................................................................... 35
6.2 Creating Seat Model ...................................................................................................................... 39
Exercise 5 – Creating SEAT for EQUI .......................................................................................................... 42
6.3 Modifying Seat Model .................................................................................................................... 44
6.3.1 By Picking Seat Only ................................................................................................................... 45
6.3.2 By Picking Seat and EQUI ........................................................................................................... 46
6.3.3 By Picking Seat and Facet ........................................................................................................... 46

7 Material Modification ............................................................................................................................. 49

8 Report and Sketch Production ............................................................................................................. 51

8.1 Report ............................................................................................................................................. 51
8.2 Sketch ............................................................................................................................................. 53
8.2.1 Adding New Menu to Marine Drafting .......................................................................................... 53
8.2.2 Generating Equipment Seat Sketch ............................................................................................ 55
Exercise 6 – Generating Sketch ................................................................................................................... 60
Exercise 7 – Generating Revision Sketch ................................................................................................... 60

Administrator Only ........................................................................................................................................ 63

9 Sheet Template Modification ................................................................................................................ 63

Exercise 8 – Modifying Template/ Backing Sheet ...................................................................................... 70

10 New Seat Type Addition ........................................................................................................................ 75

© Copyright 1974 to current year. 5
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1 Creating Seat Template ................................................................................................................. 75

10.1.1 Starting Design Template ........................................................................................................ 75
10.1.2 Creating Design Template Hierarchy....................................................................................... 76
10.1.3 Defining Template Property ..................................................................................................... 78
10.1.4 Defining Template Rule ........................................................................................................... 80
10.1.5 Displaying Dimensions............................................................................................................. 84
10.1.6 Setting Purpose and Function ................................................................................................. 90
10.2 Creating Icon File ........................................................................................................................... 91
10.3 Creating PML Handler Object ....................................................................................................... 91

© Copyright 1974 to current year. 6

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 1

1 Introduction

This course is aimed at Equipment Designers/ Engineers with AVEVA Marine Equipment Design skills; this
application shows how to create, modify and delete various types of equipment seats – including any
additional equipment components – which are required during the design stages of a project. Equipment
Seat Application is based on an engineering standard that is configured to the project requirements.

1.1 Aim

Over one and a half days the participants will learn to use AVEVA Equipment Seat Application and obtain a
good understanding of how the application can help with Design.

1.2 Objectives

 Understand the basic concept of the application

 Learn how to create and modify an equipment seat
 Know how to produce outputs for an equipment seat such as report, sketch, etc.

1.3 Prerequisites

 AVEVA Outfitting, AVEVA Marine Drafting and the application software have been installed with
valid licences and the basic configurations have been setup correctly.
 The user knows how to launch the Outfitting module.
 The user is familiar with Windows Operating System installed on the computer.
 The user is familiar with the basic Graphical User Interface (GUI) features, as described in the
AVEVA document Getting Started with Marine.

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 click actions are indicated by bold dark turquoise text
Information the user has to key-in will be in bold red text

Annotation for trainees benefit:

 Additional information

System prompts should be bold and italic in inverted commas i.e. 'Choose function'
Example files or inputs will be in the Courier New font, colours and styles used as before.

© Copyright 1974 to current year. 7

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 2

2 Equipment Seat Application Features

2.1 Introduction to Equipment Seat Application

The Equipment Seat Application (ESA) is a fully interactive, graphics oriented application that functions
within Equipment and Structures of AVEVA Hull & Outfitting modules.

The application uses a topological design approach in order to provide a simple, fast and error-free design
environment. Thus the individual equipment seat is modeled according to predefined rules using information
of the general layout of equipment and of the supported hull structure arrangements, typically consisting of
plate and stiffener profiles.

It also provides a configurable and flexible environment, so the user can easily add their own seat templates
and make configuration contexts as many as needed.

Below is the overall structure of the application:

© Copyright 1974 to current year. 9

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

2.2 How to Store Equipment Seat Modelling Data

All Outfitting data is stored in the form of a hierarchy. An Outfitting Design database has:

 a top level, World (this can be represented by the symbolic name /* ) and
 two principal administrative sub levels, Site and Zone.

The names used to identify database levels below Zone depend on the specific engineering discipline for
which the data is used. For seal modelling data, the lower administrative levels (and their Outfitting
abbreviations) are:

 Structure (STRU)
 Substructure (SUBS)
 Template (TMPL)

Each template can contain DPSE, DDSE, SCTN and PANE.

 Design pointset (DPSE) contains information of seat dimensions to preview in the 3D View.
 Design dataset (DDSE) contains information of template properties which are required to create a
seat model, such as dimensions, specifications, earth bolt position, etc.
 Profile section (SCTN) and panel (PANE) can be different according to a seat type

© Copyright 1974 to current year. 10

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

2.3 Installing Application and Configuring Environment

To start the application, the user must install the application and configure the environment properly.

Run the Equipment Seat Application setup file EquipmentSeat12.1.SP4.MSI.

Check if the files have been installed as shown in the picture.

Edit the evar.bat file to include paths of PMLLIB and PDMSUI.

Add the following lines at the end of evar.bat:

set esadir=C:\AVEVA\Marine\Design\EquipmentSeat12.1.SP4\
for %%x in ("%esadir%") do set esadir=%%~dpx
if not exist "%esadir%" goto esapass
echo esadir set to %esadir%
for %%x in ("%pmllib%") do set pmllib=%%~dpx;
set pmllib=;%pmllib%%esadir%pmllib\;
echo pmllib set to %pmllib%
for %%x in ("%pdmsui%") do set pdmsui=%%~dpx;
set pdmsui=;%pdmsui%%esadir%pdmsui\;
echo pdmsui set to %pdmsui%
:esapass

The application is delivered with datal files for design template, steel catalogues, user defined attributes and
sample configurations in the ProjectData directory which is below the installation directory. The files should
be executed in the World element and writable database:

 Run ESA_LEXICON_DATAL.txt in the Lexicon module to create user defined attributes.

© Copyright 1974 to current year. 11

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Run ESA_CATALOGUE_DATAL.txt in the Paragon module to create a catalogue element (CATA)

and a specification world (SPWL) element.

 Run ESA_TEMPLATES_DATAL.txt in the Outfitting module to create seat design templates.

 Run ESA_APPLDW_DATAL.txt in the Outfitting module to create sample configurations.

 Run ESA_SKETCH_LIB_DATAL.txt in the Outfitting Draft module to create drawing template

libraries.

© Copyright 1974 to current year. 12

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

2.4 Starting Application

To start AVEVA Marine application, select Start > All Programs > AVEVA Marine> Design > Marine
12.1.SP4> Outfitting.

The AVEVA Marine – Outfitting Login box appears, enter the following data:

Project Training
Username OUTSTL
Password OUTSTL
MDB OUTSTEELFWD

Click Login.

Setting the project to Training on the AVEVA Marine – Outfitting Login form will result in the use of the
Marine Training Project; this will be referred to as MTP for the remainder of this guide.

To run AVEVA Equipment Seat Application, select one of below:

 Design > Equipment
 Design > Structures > Beams & Columns… or
 Design > Structures > Panels & Plates…

© Copyright 1974 to current year. 13

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Then select Utilities > Equipment Seat Designer... in the pull-down

menu.

© Copyright 1974 to current year. 14

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 3

3 Contexts, Design Groups and Materials

3.1 Contexts

The administrator can define contexts for equipment seat modelling according to the company’s standards.
A context contains Design Groups and Material specification components.

In the ESA - Designer form, click the Show

defaults form button; or right click Show defaults
form and select Contexts...

Then the ESA - Contexts form is open.

Refresh – Refresh the list of contexts

New – Add a new row to add a new context

Copy – Copy a selected context and create a

new one

Delete – Delete a selected context

Navigate on Selection – Check if the user

wants to navigate to the APPLDA element of
a selected context

Edit Design Groups... – Populate the ESA -

Context - Design Groups form

Edit Materials... – Populate the ESA - Context - Materials form

In the ESA - Contexts form, the user can find Department1 registered as default. If the user creates a new
context using the Copy button, Design Groups and Design Group Members that belong to Department1 are
also copied.

 Click a row in the list to activate Edit Design Groups… and Edit Materials…
link labels.

In the following example, the user will create a context to be used throughout this training course.

Create a new context using the Copy

button.

Key in the Name, Train_Seat and

the Description, Context for Training.

© Copyright 1974 to current year. 15

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

3.2 Design Groups

A design group is a set of seat template. Click the Edit Design Groups… link label in the ESA - Contexts
form and open the ESA - Context - Design Groups form. It consists of four parts; Design Groups, Design
Group Members, Seat Templates and Preview.

Design Groups – The user can manage a design group(s):

 New – Create a new design group
 Copy – Copy a selected design group to create a new one
 Remove – Remove a selected design group from the list
 Up/Down arrow – Move up/down a selected design group

Design Group Members – The user can manage members for each design group:
 Select – Bring the name and the seat type of a selected seat from the Seat Templates list
 Include – Include a new member to the design group with a specific name and a seat type

 Unless the user clicks on list, the Include button may not be activated.

© Copyright 1974 to current year. 16

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Replace – Replace a selected member with a new name and a new seat type
 Remove – Remove a selected member from the design group
 Left/Right arrow – Move a selected member to the left/right

Seat Templates – The user can inquire all the seat templates belong to a selected context

Preview – Display a selected seat template

Refresh – Discard any changes and refresh the entire form

Apply – Save the design groups and their members into the database. Until the user clicks the button,
changes will not be saved.

Dismiss – Dismiss the form

In the following example, the user will include, modify and remove members of the context Train_Seat.

Select the Context Train_Seat in the ESA - Contexts form.

Click the New button to create a new

design group.

Key in the Name G1 and the

Description Seat Group1.

Select the Design Group, G1 and

click the Edit Design Groups… link
label to open the ESA - Context -
Design Groups form.

Choose a seat template,

/ESASEATBAA to include from the
Seat Templates list.

Click Select in Design Group Members

to fill in the Name and the Template
automatically from a selected seat
template above.

Also, the user can key in the Name and

the Template manually. Change the
Name to E-01.

Click Include.

Then click Apply to save.

Now the seat template E-01 became a member of the current design group.

© Copyright 1974 to current year. 17

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

In the following example, the user will modify a member created above.

Select the Context Train_Seat in the ESA - Contexts form.

Then select the Design Group, G1 and click the Edit Design Groups… link label to open the ESA -
Context - Design Groups form.

Click the existing member E-01 to modify.

Change the Name to E-001.

Click Replace and then Apply to save

before closing the form.

Now the seat template … is modified

from E-01 to E-001.

In the following example, the user will remove an existing member from the current design group.

Select the Context Train_Seat in the ESA - Contexts form.

Then select the Design Group, G1 and click the Edit Design Groups… link label to open the ESA -
Context - Design Groups form.

Click the existing member E-001 to

remove.

Click Remove, and the selected

member will be removed from the
current design group.

Click Apply to save before closing the

form.

© Copyright 1974 to current year. 18

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 1 – Creating Context and Design Group

In this exercise, the user will learn how to organise design group members for design groups of the context
Train_Seat.

Referring to the below picture, create new design groups G1, G2 and G3 using the New button

Then organise members for G1, G2 and G3 as follows:

© Copyright 1974 to current year. 19

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

3.3 Materials

There are several types of material used in the application; for example, profile, pad, plate and earth bolt.
The administrator should define such materials in advance before modelling.

Click Edit Materials... in the ESA - Contexts form to open the ESA - Context - Materials form.
It consists of three tabs:
 Profile & Pad
 Plate
 Earth Bolt

 Note: The user should click Apply to save any change.

3.3.1 Profile & Pad Tab

The user can match a profile pad with a profile; and the set pad will be selected automatically when it is
required for a profile.

Add – Choose a profile specification and click

Add to add the selected one into the Selected
Profiles list

Remove – Choose a profile specification and

click Remove to remove the selected one from
the Selected Profiles list

Up/Down arrow – Move up/down a selected

profile in the list

Pad items in the

Selected Profiles list
are from specification
elements whose
attribute :ESAPad is set
to true.

© Copyright 1974 to current year. 20

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

If the user wants to select a

profile pad which is not in the list,
choose Select from catalogue...
in the Pad combo box.

Then the ESA - Select Profile Pad form will be

open. The user is able to select a pad from the
Catalogue database.

3.3.2 Plate Tab

The user can manage plate

specification components for seat
models.

Add – Choose a plate specification

and click Add to add the selected
one into the Selected Plates list

Remove – Choose a plate

specification and click Remove to
remove the selected one from the
Selected Plates list

Up/Down arrow – Move up/down a

selected plate in the list

© Copyright 1974 to current year. 21

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

3.3.3 Earth Bolts Tab

The user can manage earth bolt specification components for seat models.

Add – Choose an earth bolt specification

and click Add to add the selected one
into the Selected Earth Bolts list

Remove – Choose an earth bolt

specification and click Remove to
remove the selected one from the
Selected Earth Bolts list

Up/Down arrow – Move up/down a

selected earth bolt

To make a fitting specification element for earth bolts visible in Specification Data, the attribute:
ESAEarthBolt must be set to true.

© Copyright 1974 to current year. 22

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 2 – Setting Material for Context

In this exercise, the user will compose materials for a context. The settings will be used throughout this
training course.

Set the following materials for a context, Train_Seat.

Add several profiles and pads with below specification data:

 Specification British Standard

 Generic Type Equal Angle

Add several plates with below specification data:

 Specification Standard Plate Spec

Add several earth bolts with below specification data:

 Specification ESA Earth Bolts

 Section Type Any
 Sub-Type Any

© Copyright 1974 to current year. 23

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 4

4 Defaults

The user can predefine default values which are often used for seat equipment modeling according to the
company’s standards. Default values are stored by the user.

In the ESA - Designer form, click the Show defaults form button; or right click Show defaults form and
select Defaults...

Then the ESA - Defaults form is open.

Context – Select one to be used as an active

context during modelling. According to a selected
context, the form name and tabs of the ESA -
Designer form will be different as follows:

Zone – Select one to be used as a default storage

zone for a newly creating seat model

Install Stage – Key in a default value of install

stage

Paint Code – Key in a default value of paint code

Profiles – Select a default profile component

against a Gtype

Plate – Select a default plate component

Earth Bolt – Select a default earth bolt

component

 Selectable items in the combo boxes

Profiles, Plate and Earth Bolt can be
managed in the ESA - Context - Materials
form. Refer to section 3.3.

© Copyright 1974 to current year. 25

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Earth Bolt Pos. – Select a default position of an earth bolt:

Left Centre Right

Bolt Hole Margin – Key in a default margin of a bolt hole. The bolt hole diameter of a seat model is
determined by the bolt hole diameter of target equipment as well as this value;
i.e. Bolt hole diameter of a seat model = Bolt hole diameter of equipment + Bolt hole margin * 2

Check options – Check whether to insert a below material type(s) or not:

 Pad: If it is checked, a profile pad is inserted between a wall and profile members (legs) of the
framework to avoid adverse local welding as well as stress concentration effects.

 Fit Legs to Plane: If it is checked, all leg ends of a seat model are trimmed by the plane where the
legs are welded.

© Copyright 1974 to current year. 26

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Weld Mark: If it is checked, weld marks are created while modelling. A weld mark is a SNOD
element whose purpose is WELD.

 Suppress Message Box: If it is checked, an error or warning message is not populated while
modelling.

 Hide Local Axes: If it is checked, local axes aid elements are hidden.

In the following example, the user will generate a site and set default values to be used throughout this
training course.

Select Design > Structures > Panels & Plates… from the main pull-down menu.

Create a site, /ESA_Training at the world level.

Navigate to ESA_Training in the Design Explorer and create a

new ZONE TRAIN_311_SEAT.

Open the ESA - Defaults form and set the values as follows:
 Context Train_Seat
 Zone /TRAIN_311_SEAT
 Install Stage BLOCK
 Paint Code E1
 Profiles ANG / BS-SPEC/45x45x4.0
 Plate /Plate/5mm
 Earth Bolt /ESA-EBLT-SW-11
 Earth Bolt Pos. Right
 Bolt Hole Margin 0.00mm
 Fit Legs to Plane On

© Copyright 1974 to current year. 27

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 5

5 Bolt Information of Equipment

The bolt information is used to determine the location, the orientation and dimensions of an equipment seat
intelligently. If it is not prepared against target equipment in advance, the user has to input all information
one by one manually when creating a seat and it takes time and effort. For speedier and more convenient
equipment seat installation, it is recommended for the administrator to define this bolt information before
starting seat modelling. There are two methods to add the information:

 using Design Points

 using Negative Cylinders

5.1 Using Design Point

The administrator can add bolt information using a design point, such as direction, diameter, position, etc., at
any position of existing equipment. There are three types of design point:

 Cartesian (DPCA)
 Cylindrical (DPCY)
 Spherical (DPSP)

But the administrator must use a Cartesian design point for bolt information.

© Copyright 1974 to current year. 29

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

To mark bolt information using design points, there are some attributes to be set:

Select Create/Modify > Cartesian Point.

Cartesian Point

 Function indicates the diameter of a bolt

 Purpose must be BOLT
 Direction of Design Point indicates a bolt direction
 Positioning indicates bolt positions

 The Modify pull-down menu will show differently according to a selected point type.

5.2 Using Negative Cylinder

Traditionally a bolt hole is represented with a negative cylinder in equipment.

© Copyright 1974 to current year. 30

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

To reuse the bolt hole information for equipment seat installation, the following attributes should be set:

 Purpose must be BOLT

 Orientation indicates the Z direction of a negative cylinder
 Diameter indicates the bolt diameter

A bolt position is calculated automatically according to the owner of a negative cylinder:

 Box
 Cylinder, Cone, Circular Torus, Extrusion, Snout, Pyramid or Rectangular Torus
 Dish
 Others

© Copyright 1974 to current year. 31

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 3 – Creating Design Point for EQUI

In this exercise, the user will create design points for an equipment seat.

Navigate to the ESA_EQUI_014-1 in the Design Explorer and create a design point as follows:

 Description Bolt1
 Function 14mm
 Purpose BOLT
 Direction of Design Point(z) Y
 Normal Direction(Y) Z

Set the Positioning for this cylindrical design point.

Create three more cylindrical design points.

© Copyright 1974 to current year. 32

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 4 – Creating Negative Cylinder for EQUI

In this exercise, the user will create negative cylinders for an equipment seat.

Navigate to the ESA_EQUI_005 in the Design Explorer and create four negative cylinders:

Select Create > Primitives…

Key in the following values:

 Height 7mm
 Diameter 10mm

For NCYL 1, key in:

 Purpose BOLT
 Position X 0mm Y 100mm Z 0mm
 Orientation Y is Y and Z is X

For NCYL 2, key in:

 Purpose BOLT
 Position X 0mm Y -100mm Z 0mm
 Orientation Y is Y and Z is X

© Copyright 1974 to current year. 33

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 6

6 Equipment Seat Modelling

6.1 Seat Designer

The ESA - Designer form is the main of the application, and it mainly consists of two areas; toolbar buttons
and design group tabs.

6.1.1 Toolbar Icons

Below toolbar icons are available in the application main form.

1. Create new seat model
2. Modify seat model
1 2 3 4 5 6 7 8 9 10 11 12 13 3. Mark as non-standard type
4. Fit leg
5. Add/Delete profile pad
6. Add/Delete snip
7. Delete endcut
8. Add/Delete weld mark
9. Add/Delete note
10. Working plane
11. Clipping
12. Show report form
13. Show template view form

© Copyright 1974 to current year. 35

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Create new seat model – The user can create a new seat model using with function. Refer to section 6.2
for more details.

Modify seat model – The user can modify a seat model with this function. Refer to section 6.3 for more
details.

Mark as non-standard type – The user can make a seat model(s) as the non-standard type.
 Click Mark as non-standard type and pick a seat model(s).
 Press the Escape key to finish picking and to change the picked ones as the non-standard type.

Fit leg – The user can fit a leg(s) to a target plant.

 Click Fit leg and pick a profile end(s). The user can pick many profiles at once.
 Press the Escape key to finish picking.
 Pick a target plane and press the Escape key. Then all picked profiles are trimmed against the
target plane.
Pick profile ends Pick a target plane Profile ends are trimmed

Add/Delete profile pad – The user can add or delete a pad to/from a profile.
 Click Add/Delete profile pad, and the ESA - Profile Pad form is open.
 Check Use Predefined Pad to use predefined values in the Profile & Pad tab, the ESA - Context -
Materials form (refer to section 3.3.1); or uncheck Use Predefined Pad and select a specific pad
component manually.

Use Predefined Pad is checked A specific pad is selected

 Lastly pick a profile end. If the profile end has no pad, a new pad will be created; but if it already has
a pad, the pad will be deleted.
 Press the Escape key or close the ESA - Profile Pad form to finish adding/deleting a profile pad(s).

© Copyright 1974 to current year. 36

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Add/Delete snip – The user can add or delete a snip to/from an angle.
 Click Add/Delete snip, and the ESA - Snip form is open.
 Key in the Length and the Height of a snip.
 Lastly pick a profile end. If the profile end has no snip, a new snip will be created; but if it already
has a snip, the snip will be deleted.
 Press the Escape key or close the ESA - Snip form to finish adding/deleting a snip(s).

Delete endcut – The user can flatten a selected profile end(s).

 Click Delete endcut and pick a profile end(s). Then endcut of the picked profile end(s) will be
removed.
 Press the Escape key to finish deleting an endcut(s).

Add/Delete weld mark – The user can add or delete a weld mark(s) to/from a profile end.
 Click Add/Delete weld mark and pick a profile end. If the profile end does not have a weld mark, a
new weld mark will be created; but if it already has a weld mark, the weld mark will be removed.
 Press the Escape key to finish adding/deleting a weld mark(s).

Add/Delete note – The user can add/delete a note(s) to/from a profile end.
 Click Add/Delete note and pick a profile end. Then the Input form is open.
 Key in the note content.
If there is an existing note, the content is displayed; change the content and click OK to modify.
If the user does not input anything, the existing note will be deleted.
 Press the Escape key to finish adding/deleting a note(s).

 A note is a SNOD element whose

purpose is NOTE.

© Copyright 1974 to current year. 37

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Working plane – The user can make a plane as the current working plane when modelling several seats on
a single plane.
 Click Working plane and select a plane in the 3D View.
 Press the Escape key.
 As the plane is selected, the Working plane toggle button is on (in its pressed state). Then while
the user is modelling seats, the selected plane is picked automatically.
 To make the toggle button off, click the button again.

Clipping – The user can clip a specific space.

 CE: Select an element in the Design Explorer and click CE to make a target to be clipped. The
name of the selected one is displayed in the text box. The initial clipping box limits are determined
according to the element volume. The size of clipping box is adjustable by controlling slide bars.
 Pick: Pick an element in the 3D View and click Pick to make a target to be clipped. The name of the
selected one is displayed in the text box. The initial clipping box limits are determined according to
the element volume. The size of clipping box is adjustable by controlling slide bars.
 Step: Key in a step value for slide bars of the Clipping Box area.
 Show Boundary: Check to display a boundary box in the 3D View.
 Enable Clipping: Check whether to display a clipped model or a whole model.

Show report form – The user can manage a report including production data for seal models. Refer to
section 8.1 for more details.

Show template view form – The user can check a selected seat template in a separated volume view.
 Click Template view, and the ESA - Template View form is open.
 The user can view a selected seat template with predefined dimensions. The small sphere in the
centre of the view is the origin point of the seat template.

© Copyright 1974 to current year. 38

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

6.2 Creating Seat Model

The user can create a seat model following the below processes:

1. Choose a template:
In the ESA - Designer form, choose a template from design group tabs or select the All tab.

2. Click Create new seat model in the ESA - Designer form.

The EDG picking mechanism will be initiated to create a seat model. Pay attention to the message
displayed on the top of the 3D View.

3. Pick participants:
The user can identify one or multiple participants, such as equipment, hull plate(s) and stiffener(s),
which are to be supported as well as a facet(s) where a seat is welded. The indicated equipment or
hull structure will be highlighted with the system highlight colour. If the user clicks the highlighted
once again, the element will be deselected.
Target equipment is picked A landing plane is picked

A seat structure is to be welded on a vessel’s hull structure. Typically a seat model is attached on a
hull structure (plate), for example deck plate, inner bottom plate, bulkhead plate, sloped plated,
vertical plate, etc.
Press the Escape key to finish picking, and the ESA - Designer - Create form is open.

© Copyright 1974 to current year. 39

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

4. Edit properties:
The user can modify properties for a creating seat, such as materials, dimensions, orientation,
positions, etc.

Basic Data
 Zone – Input the name of a zone element
where a creating seat is to be stored. To
select the current zone, click CE.
 Name – Input the name for a creating seat
 Auto Naming – Click to apply the auto
naming rule. To define the naming rule, select
Settings > Naming… and click Define
Naming Rules, and the Naming Rules form
is open. The administrator can a defining rule
by clicking the Element Rules… button in the
form.

 In the Naming Rule form, set the Format,

!!ce.owner.namn & ‘-’ & !index.

 To create or modify the auto naming information,

the administrator status is required.

 Install Stage – Key in the Install Stage

 Paint Code – Key in the Paint Code
 Description – Key in the Description. If the
description of picked equipment exists, it is
displayed. Unless, it shows empty.
 Non-Standard Type – Check to mark a
newly creating seat as the non-standard type
Material – The user can select materials to be used for seat structure creation, for example profile,
plate and earth bolt.

 Default values are displayed in the form, but the user can still modify them.

Dimensions – The associated handler object (refer to section 10.3) calculates all dimension values
automatically by selected equipment and landing planes (from the above process, ‘Pick
participants’):

 : Increase/Decrease a dimension by 1mm or 1 degree

© Copyright 1974 to current year. 40

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 : Display the aid dimension of a selected parameter in the 3D View

 : Measure a distance in the 3D View to input a value

 Fit Legs to Plane: Check to trim all leg ends of a seat model against the plane where the
legs are welded. (Refer to Check options, chapter 4 for more details.)
 Display All Dimensions: Display all predefined dimensions in the volume view. This
options are activated once a model is created.

Orientation & Position

 Rotate: Rotate the seat orientation. The Model Editor also can be used as an alternative.

 Pick Position: Click Pick Position and pick the seat in the 3D View to identify its position.

Refit – Reselect target equipment and a landing plane(s) and modify the current seat model when
the user wants to change target equipment

ReCalc. – Recalculate all dimension values including orientation and position

Apply – Apply modified parameter values. If there is no seat model created yet, a new one will be
created.

5. Click Apply and complete creating a new seat model.

© Copyright 1974 to current year. 41

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 5 – Creating SEAT for EQUI

Navigate to SITE /ESA_Training in the Design Explorer and add the datal file, ESA_Equip_DATAL.txt
beneath the SITE to create sample equipment. Then a new zone, TRAIN_311_EQUI will be created.

Add the following equipment and hull panels to the 3D View to be referred in seat modelling.
 Hull Block F204
 ZONE TRAIN_311_EQUI

Using the type ESASEATBAC, create a seat /TRAIN_311-SEAT-001 as the wall type for EQUI
/ESA_EQUI_013.
Key in a 80mm.

© Copyright 1974 to current year. 42

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Using the type ESASEATFAG, create a seat /TRAIN_311-SEAT-002 as the deck type for EQUI
/ESA_EQUI_013.
Key in a 70mm and b 40mm.

Using the type ESASEATFAT, create a seat /TRAIN_311-SEAT-003 as the deck type for EQUI
ESA_EQUI_009.
Then modify the seat leg with the Fit leg function (refer to section 6.1.1) as shown in the picture.

© Copyright 1974 to current year. 43

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

6.3 Modifying Seat Model

The procedure of modifying a seat model is very similar to seat model creation, except for picking
participants; i.e. when picking them, the user should identify an existing seat model to modify.

1. Click Modify seat model in the toolbar of the ESA - Designer form to initiate the modification mode.
Pay attention to the message displayed on the top of the 3D View.

2. Pick an existing seat model, EQUI, a facet to modify in the 3D View. Refer to section 6.3 for more
details.

3. Then the ESA Designer - Modify form is open. Modify values needed.

4. Click Apply to save changes.

© Copyright 1974 to current year. 44

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

6.3.1 By Picking Seat Only

In the above process 2, ‘Pick existing seat models to modify’; the user can pick a seat only.

The Fit Legs to Plane option will be deactivated.

If the user change an H value, the leg end will be modified accordingly.

Click Rotate, and the modelling is modified as shown below:

© Copyright 1974 to current year. 45

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

6.3.2 By Picking Seat and EQUI

In the above process 2, ‘Pick existing seat models to modify’; the user can pick not only a seat, but also
EQUI.

Click Rotate, and the modelling is modified as shown below:

6.3.3 By Picking Seat and Facet

In the above process 2, ‘Pick existing seat models to modify’; the user can pick not only a seat, but also a
facet.

The Fit Legs to Plane option will be activated.

If the user change an H value, the fitting part with EQUI will be modified accordingly with fixing the leg ends
on the plane.

© Copyright 1974 to current year. 46

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

In the following example, the user will pick a seat and a facet and modify an H value.

Pick the seat TRAIN_311_SEAT-001 and the facet where the seat is attached on.

Change H to 200mm.

© Copyright 1974 to current year. 47

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 7

7 Material Modification

All elements of a seat model must have valid material references. If not, the weight of the seat model cannot
be correctly calculated. In this chapter, the user can change the material of a seat model irrespective of the
default specification material.

Select Modify > Material... in the pull-down menu, and the Set Material form will be open.

Select the element to be modified. It can be the CE, selected from a list or picked with the
cursor in the 3D View.

Select the material from the scrollable list and click Apply to change the material.

Click Dismiss to discard any information and close the Set Material form.
If Cascade Material to all offspring. is chedked, any associated items, for example fitting, have their
material changed as well.

© Copyright 1974 to current year. 49

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 9

8 Report and Sketch Production

In this chapter, the user will learn how to produce outputs, such as report and sketch, from design data;
navigate to a level in the Design Explorer and produce a list of equipment seat.

8.1 Report

The user can manage a report from production data for seat models.

Click the Show report form button in the ESA - Designer toolbar, and the ESA - Report form will be
displayed.

Search – Search all seat models that meet the Filter conditions.

Non-Standard – Mark a selected seat model(s) as the non-standard type

Navigate to Model – Check if the user wants to navigate a selected seat model (from the list) in the Design
Explorer

Focus on Model – Check if the user wants to highlight a selected seat model (from the list) in the 3D View.

Pop-up menu (1) – Select a row and right click to see more options for report management:

 Mark as Non-Standard Type: Mark selected a selected

seat model(s) as the non-standard type
 Select All: Select all seat models in the list
 Add to 3D View: Add a seat model (selected from the list)
onto the 3D View
 Remove from 3D View: Remove a seat model (selected
from the 3D View) in the list
 Navigate to Model: Navigate a selected seat model in the
Design Explorer
 Focus on Model: Highlight a select seat model in the 3D
View
 Print Preview: Preview or print out the list
 Save to Excel: Save the list to Excel

© Copyright 1974 to current year. 51

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Pop-up menu (2) – Select a cell and right click to see more options for report generation, for example
Revision, Stage, Description and Paint Code:

 Copy: Copy the text of a selected cell

 Paste: Pasted the copied text. It is not activated in other columns. Multi
selection is available.
 Fill Down: For multi selection, paste down from the uppermost cell.

 Fill Up: For multi selection, paste up from the undermost cell.

© Copyright 1974 to current year. 52

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

8.2 Sketch

After creating or modifying equipment seats, the user can produce a sketch.

8.2.1 Adding New Menu to Marine Drafting

To enter the Marine Drafting module, select Start > All Programs > Marine Drafting…

The administrator can insert a new menu item for Equipment Seat Application.
Right click the toolbar and select Customize...

Select the Active Customization File, Marine Drafting from the

pull-down list.

Click New Button and create a new button item.

© Copyright 1974 to current year. 53

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Edit properties of the new command as follows:

 Caption Equipment Seat Sketches...

 Command Macro: show !!esaSketchForm
 Name AVEVA.Marine.UI.Button.EquipmentSeatSketch
 Tooltip Create Equipment Seat Sketches

Drag the new button command and drop at the last position under A&utoDP.

Click Apply to save and then close the customised menu bar.
Double check whether the menu is inserted successfully.

© Copyright 1974 to current year. 54

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

8.2.2 Generating Equipment Seat Sketch

The user can search a seat model(s) in the Design Explorer and generate a sketch using a drawing template.
A produced sketch will be stored in the Draft database. This sketch includes dimensions and scale drawings
of a seat along with the table of relevant manufacturing information.

Select Design > Module > Marine Drafting… and enter the Marine Drafting module.

Then select AutoDP > Equipment Seat Sketches…

In the Design Explorer (Display > Explorers > Design

Explorer), select /TRAIN_311_SEAT.

Click the Search button in the Equipment Seat

Sketches form to display seats for the current element.
The filtering option, Name is also provided.

The user should choose a template and a registry to store sketches before generating a sketch.

© Copyright 1974 to current year. 55

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Select /ESA-Sketch-Templates/A4-A from the

Template scrollable lists

Select REGI Structure_Drawings_FWD.

In the Draft Explorer, highlight the Registry

for equipment seat sketches and click the
CE.

Highlight the seats to generate sketches.

Click Create Sketches.

If there is any problem, the Message form will

be populated with the reason as shown below:

If there is a problem in a seat modeling, the Status will display ‘Failed’ and the sketch will not be generated.

© Copyright 1974 to current year. 56

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Below is a generated sketch.

© Copyright 1974 to current year. 57

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

When selecting /ESA-Sketch-Templates/A4-

GROUP from the Template scrollable list, a sketch
is created by grouping the seats of the same type
among selected seats as follows.

© Copyright 1974 to current year. 58

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

All materials of the grouped seats are listed.

Material No. corresponding to Position No. is searched

from the Material list and is displayed.

When selecting /ESA-Sketch-Templates/A4-

REPORT from the Template scrollable list, a sketch
for report is created as follows.

© Copyright 1974 to current year. 59

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

When seat is nonstandard type, a sketch is created by applying template /ESA-Sketch-Templates/A4-A.

Materials registered in the

Context which is selected in
the ESA – Defaults Form
are displayed.

Pop-up menu – Right click the Equipment Seat Sketches list to see more options to manage sketches:

 Open Sketch: Open a generated sketch.

 Create Sketches: Create sketches of a selected seat model(s)
 Delete Sketches: Delete sketches of a selected seat model(s)
 Navigate to Model: Navigate a selected seat model in the Design Explorer.
 Navigate to Sketch: Navigate a sketch of a selected seat model in the Draft Explore

Exercise 6 – Generating Sketch

Create sketches for seats /TRAIN_311-SEAT-001, /TRAIN_311-SEAT-002 and /TRAIN_311-SEAT-003

created in Exercise 5.

Exercise 7 – Generating Revision Sketch

Change the attribute :REVNO of the seat model TRAIN_311_SEAT-001.

Then create revision sketches for the seats created in Exercise 5.

© Copyright 1974 to current year. 60

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

© Copyright 1974 to current year. 61

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 9

Administrator Only

9 Sheet Template Modification

This section will demonstrate how to modify a sheet template for sketch generation.

Select Start > All Programs > AVEVA Marine> Design > Marine 12.1.SP4 > Outfitting Draft.

The AVEVA Marine – Outfitting Draft Login

box appears, enter the following data:

 Project Training
 Username OUTSTL
 Password OUTSTL
 MDB OUTSTEELFWD

Click Login.

The General User application is selected as default.

Select Draft > Administration… and enter the Administration application.

Then select Draft > Sheet Libraries… to enter the Sheet Libraries.

© Copyright 1974 to current year. 63

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

The following example will describe a relationship between a backing sheet and a template.

A backing sheet is referenced by the SHTMPL element via the BSRF attribute. It contains several elements
organised within a series of the NOTE elements.

Select SHTMPL ESA-Sketch-Templates/A4-A/S1.

The attribute BSRF of SHTMPL ESA-Sketch-

Templates/A4-A/S1 is ESA-Sketch-
Backsheets/A4-A.

Select BACK ESA-Sketch-BackSheets/A4-A and then right click to display the context sensitive menu.
Select Open Sheet.

© Copyright 1974 to current year. 64

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Select and open ESA-Sketch-Templates/A4-A/S1. Then, elements created by ESA-Sketch-

Templates/A4-A/S1/MtoEntries are displayed on the top of the sheet template.

Page_no on the top as well as elements at the bottom are created by ESA-Sketch-Templates/A4-
A/S1/TitleEntries.

Select SHIP NO on the sheet template view and change the attribute Btext to VESSEL NO.

© Copyright 1974 to current year. 65

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Instead of selecting SHIP NO on the sheet template view, the user can select TEXP 5 below.NOTE
ESA-Sketch-BackSheets/A4-A/Frame.

Now the following example, the user will learn how to modify a backing sheet.

In the Draft Explorer, select and open ESA-Sketch-BackSheets/A4-A.

From the main pull-down menu, select Edit > Move Primitives By > X, Y…

Select primitives, i.e. the lines and text that are required to be repositioned and then press the Escape key.

The Explicit By form is displayed.

Key in Y -10 and click Apply.

© Copyright 1974 to current year. 66

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

The selected primitives are repositioned as shown below:

The following example will describe how to modify a sheet template.

Select and open ESA-Sketch-Templates/A4-A/S1.

To apply the changes previously made from the backing sheet to the sheet template, select Graphics >
Update > All.

The sheet template is modified as follows:

Select ESA-Sketch-Templates/A4-A/S1/MtoEntries and key in Xyposition X 0mm Y -20mm in the

Command Window.

Then, the sheet template is modified as follows:

© Copyright 1974 to current year. 67

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Key in the Lframe attribute of VIEW to true.

The outline of the view is displayed as follows:

Select ESA-Sketch-Templates/A4-A/S1/V3.
Key in Size 75mm 75mm and Xyposition X 54mm Y 105mm in
the Command Window.

© Copyright 1974 to current year. 68

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Modify the Direction attribute of ESA-Sketch-Templates/A4-A/S1/V3 from Y to –X.

Change the TPValue attribute of TKPARA1 to False.

The view direction against the seat model will be modified as follows:

Direction: Y Direction: -X

-X

 Above example is based on the seat /TRAIN_311-SEAT-003.

Change the Rcode attribute of ESA-Sketch-Templates/A4-A/S1/V1 from Up to Right.

Change the TPValue attribute of TKPARA1 to False.

The direction of region vertical on the sheet will be modified in the 90° clockwise rotation as follows:

Rcode: Up Rcode: Right

 Above example is based on the seat /TRAIN_311-SEAT-003.

© Copyright 1974 to current year. 69

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Exercise 8 – Modifying Template/ Backing Sheet

Key in the following attribute values for each sheet template:

ESA-Sketch-Templates/A4-A/S1/V1
 Size 75mm 75mm
 Xyposition X 54mm Y 250mm
 Rcode Right

ESA-Sketch-Templates/A4-A/S1/V2
 Size 75mm 75mm
 Xyposition X 151mm Y 250mm

ESA-Sketch-Templates/A4-A/S1/V3
 Size 75mm 75mm
 Xyposition X 54mm Y 160mm
 Direction –X

ESA-Sketch-Templates/A4-A/S1/V4
 Size 75mm 75mm
 Xyposition X 151mm Y 160mm
 Direction –Y

ESA-Sketch-Templates/A4-A/S1/MtoEntries
 Xyposition X 0mm Y -180mm

ESA-Sketch-BackSheets/A4-A/MtoTable
 Xyposition X 0mm Y -160mm

© Copyright 1974 to current year. 70

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Then the sheet is modified as follows:

© Copyright 1974 to current year. 71

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Set the Lframe attribute of VIEW back to False to remove four views.

© Copyright 1974 to current year. 72

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Create a seat sketch for EQUI ESA_EQUI_009 created in Exercise 5 using the updated template and
backing sheet.

© Copyright 1974 to current year. 73

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 10

10 New Seat Type Addition

In this chapter, the user will define and add a new seat type.

There are only two steps to add a new seat type:

 Create a seat template including an icon file
 Create a PML handler object for the new seat template

10.1 Creating Seat Template

10.1.1 Starting Design Template

Select Design > Design Templates…

© Copyright 1974 to current year. 75

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1.2 Creating Design Template Hierarchy

Select Create > Template World and create a new Template World element:

 Name /MYSEATTMPL.TPWL
 Purpose ESA
 Description Template world for seat templates

Select Create > Template Area and create a new Template Area element:

 Name /MYSEATTMPL.TMAR
 Purpose ESA
 Description Template area for seat templates

Select the newly create Template Area element in Template Browser.

In the following example, the user will create a template (TMPL) from an existing structure element.

Run the MYSEAT.DATAL file.

Navigate to the Framework (FRMW) element of the structure, /MYSEAT in the Design Explorer.

© Copyright 1974 to current year. 76

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Select Create > Template, and the Create Template form will
be open.

Set the template information as follows:

 Name /MYSEATAAA
 Description My Seat Type AAA

Check Add Properties and Add Points.

(Do not click OK yet.)

The current position of the design template origin is the centre

of the limits box. We will redefine the origin as being at the
centre of the two bolt holes.

Set the Origin positions, X 0, Y 0 and Z 0.

Click OK.

Then the Template Browser will show the following elements.

The 3D View will now show both the original structure and the template derived from it (They are overlapped
each other). From the Template Browser, click Display to display the current template only in the 3D View.

Select the new template element TMPL MYSEATAAA in the Design Explorer and select Display >
Attributes from the main pull-down menu. The Attributes form will be displayed.

Key in the Purpose attribute, SEAT.

© Copyright 1974 to current year. 77

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1.3 Defining Template Property

Check a selected element in the Template Browser is the working TMPL element, and select Modify >
Property Definitions. The Define Template Properties form will be open:

Define the following property:

 Description W1
 Key WIDA
 Definition Design Parameters
 No 1
 Data Type Distance
 Default 150mm
 Range unset

Click Include to create the currently defined

properties into the list.

Repeat the above process to add the following property definitions into the list:

Description Key Definition No. Data Type Default

L LEGL Design Parameter 2 Distance 150mm
d BDIA Design Parameter 3 Distance 15mm
a DISA Design Parameter 4 Distance 15mm
b DISB Design Parameter 5 Distance 30mm

© Copyright 1974 to current year. 78

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Define the next property to be used to determine a position of earth bolt:

 Description Earth Bolt Position

 Key EBPS
 Definition Design Parameter
 No. 6
 Data Type Integer
 Default 2
 Range From 1 To 3

 The Key of this property must be EBPS and its value must be 1 (left), 2 (centre) or 3 (right).

Define the next property, i.e. the overall width of the angle which has bolt holes. It will be decided from the
summation of the WIDA, DISA and DISB properties.

 Description W
 Key WID
 Definition Expression
 Data Type Distance
 Default 150mm
 expr CDPR DISA + CDPR WIDA + CDPR DISB
 Range unset

Define the next property to be used for a specification component of angle:

 Description Angle
 Key EASP
 Definition Specification Ref
 Data Type Spec Ref
 Default ID /BS-SPEC/50x50x5.0

Define the next property to be used to determine a specification component of earth bolt:

 Description Earth Bolt

 Key EBSP
 Definition Specification Ref
 Data Type Spec Ref
 Default ID /ESA-EBLT-DUMMY

 The Key of the property for a specification component of earth bolt must be EBSP.

The result of Currently Defined Properties should be as follows:

© Copyright 1974 to current year. 79

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1.4 Defining Template Rule

Using the template property values defined from the previous section, the user can parameterise members
of a template instance.

Check the new seat template element (TMPL), My Seat Type AAA is still selected in the Template
Browser form.

Select Modify > Parameterisation and open the

Template Member Parameters form. The user can
check members that make up the current template.

In the Template Members list, select the Element

SCTN 1 which has two bolt holes.

In the Rules list, select the Attribute Spref.

Then the Attribute Rule form will be open. The user can define rules for the selected attribute Spref.

© Copyright 1974 to current year. 80

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Key in the Expression, CFDP EASP.

Then it will set the Spref to a property value of the current template whose key is EASP.

By clicking Test Expression, the user is able to check the result how the rule is to be applied. If no real
design data has been created, the result will be set by the rule with a default value of the property, EASP
(specified as /BS-SPEC/50x50x5.0).

Click OK to accept the rule. Check the changed result in the Rules list of the Template Member
Parameters form.

(SCTN 1 is still selected as a template member.) Select Posstart and Posend in the Rules list and define
the attribute rules as follows:

 Posstart X ( - CDPR WIDA / 2 - CDPR DISA ) Y ( 0 ) Z ( PARA[1 ] OF CFDP EASP * 0.5 mm )

 Posend X ( CDPR WIDA / 2 + CDPR DISB ) Y ( 0 ) Z ( PARA[1 ] OF CFDP EASP * 0.5 mm )

In the Template Members list of the Template Members Parameters form, select the Element FITT 1
which is a bolt hole on the right side of the angle, and define the attribute rules as follows:

 Zdistance LDPR DISA OF TMPLATE + LDPR WIDA OF TMPLATE

 Delposition X ( - PARA[1 ] OF OWNER * 0.5 mm ) Z ( PARA[3 ] OF OWNER * 0.5 mm )

The diameter and height of the hole (whose Spref is /ESA-PROF-HOLE-TYPE-O) are controlled by the
design parameters of the fitting element:

 Diameter design parameter 1

 Height design parameter 2

To define the rule for the first design parameter, select the Attribute Desparam in the Rules list and key in
the Expression LDPR BDIA OF TMPLATE.

© Copyright 1974 to current year. 81

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Click OK then the Rules list should now be displayed as follows:

Select the Attribute Desparam[2] and key in the Expression PARA[3 ] OF OWNER * 1 mm.

 The expression * 1mm will change an undimensioned value to dimensioned one.

In the Template Members list of the Template Members Parameters form, select the Element FITT 2
which is a bolt hole on the left side (on the start side) of the angle, and define the attribute rules as follows:

 Zdistance LDPR DISA OF TMPLATE.

 Delposition X ( - PARA[1 ] OF OWNER * 0.5 mm ) Z ( PARA[3 ] OF OWNER * 0.5 mm ).
 Desparam[1] LDPR BDIA OF TMPLATE.
 Desparam[2] PARA[3 ] OF OWNER * 1 mm.

Select the Element FITT 3 which is an earth bolt, and define the attribute rules as follows:

EBPS = 1 (Left) EBPS = 2 (Centre) EBPS = 3 (Right)

 Spref LFDP EBSP OF TMPLATE.

 Zdistance IFTRUE(LDPR EBPS OF TMPLATE EQ 1, LDPR DISA OF TMPLATE + 20mm,
IFTRUE( LDPR EBPS OF TMPLATE EQ 3, LDPR DISA OF TMPLATE + LDPR WIDA OF
TMPLATE - 20mm, LDPR DISA OF TMPLATE + LDPR WIDA OF TMPLATE / 2 ) ).

© Copyright 1974 to current year. 82

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

In the Template Members list, select the Element, SCTN 2 which is a fitting for a pad, and define the
attribute rules as follows:

 Spref CFDP EASP

 Posstart X ( CDPR WIDA / 2 + CDPR DISB ) Y ( 0 ) Z ( PARA[1 ] OF CFDP EASP * 0.5 mm )
 Posend X ( CDPR WIDA / 2 + CDPR DISB ) Y ( CDPR LEGL ) Z ( PARA[1 ] OF CFDP EASP
* 0.5 mm )

Select the Element FITT 1 for pad under SCTN 2 and define the attribute rule as follows:

 Zdistance ABS ( POSS[3 ] OF SCTN WRT SCTN - POSE[3 ] OF SCTN WRT SCTN )

It makes the position of the pad always be at the end position of the angle whenever the rule is executed.

© Copyright 1974 to current year. 83

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1.5 Displaying Dimensions

Make /MYSEATAAA the current element.

Select Create > Dimension Points in the main pull-down menu, and the Dimension Point Definition form
will be open. In this form, the user is able to specify position (Dimension Position), extension line length
(Dimension Extension) and extension line direction (Dimension Direction) with dimension points in pairs.

Select Control > AutoBuild in the

Dimension Point Definition form. Then
two dimension points for each design
parameters in the Dimension Points list.

When firstly created, all dimension points

are positioned at the template origin
(shown as a sphere in the 3D View).
Then the user has to reposition each
point and specify its projection line length
and direction.

Select the Dimension Point 101.

Key in the Design Point Description, W1 which is a distance between bolt holes.

Click (next to Dimension Position), and the Position Rule Definition form is displayed.

Key in the Expression, X ( CDPR WIDA / 2 ) Y ( - 100mm ) Z ( 0 ) and click OK.

© Copyright 1974 to current year. 84

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

To position 101 at the centre of the bolt hole on the right side, key in the Dimension Extension, 100mm and
the Dimension Direction, Y. Then the projection line from this point is directed towards Y and just reaches
the centre of the right bolt hole.

Click Replace to overwrite the data with the new values.

Select the Dimension Point 102. Comparing to the point 101, only its X coordinate is different.
Click Copy Partner to copy all positions and projection line values from the other point in the same pair.

To position 102 at the centre of the bolt hole on the left side, edit the Expression (by changing the sign from
- to +), X ( - CDPR WIDA / 2 ) Y ( - 100mm ) Z ( 0 ).

Click Replace.

In the following example, the user will set dimension points for a which is a distance between the start of the
parent profile and the centre of the bolt hole on the left side.

Select the first Dimension Point 201.

To position 201 at the start of the parent profile, set the values as below:

 Design Point Description a

 Dimension Position X ( - CDPR WIDA / 2 - CDPR DISA ) Y ( -100 mm ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction Y

Select the second Dimension Point 202.

To position at the centre of the bolt hole on the left side, set the values as below:

 Design Point Description a

 Dimension Position X ( - CDPR WIDA / 2 ) Y ( -100 mm ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction Y

© Copyright 1974 to current year. 85

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

The result should be as shown in the picture:

In the following example, the user will set dimension points for b which is a distance between the end of the
parent profile and the centre of the bolt hole on the right side.

Select the first Dimension Point 301.

To position at the centre of the bolt hole on the right side, set the values as below:

 Design Point Description b

 Dimension Position X ( CDPR WIDA / 2 ) Y ( -100 mm ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction Y

Select the second Dimension Point 302.

To position at the end to the parent profile, set the values as below:

 Design Point Description a

 Dimension Position X ( CDPR WIDA / 2 + CDPR DISB ) Y ( -100 mm ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction Y

The result should be as shown in the picture:

© Copyright 1974 to current year. 86

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

In the following example, the user will set dimension points for L.

Select the first Dimension Point 401.

To position at the start of the profile, set the values as below:

 Design Point Description L

 Dimension Position X ( CDPR WIDA / 2 + CDPR DISB + 100mm ) Y ( 0 ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction -X (If an error occurs, key in W.)

Select the second Dimension Point 402.

To position at the end of the profile, set the values as below:

 Design Point Description L

 Dimension Position X ( CDPR WIDA / 2 + CDPR DISB + 100mm ) Y ( CDPR LEGL ) Z ( 0 )
 Dimension Extension 100mm
 Dimension Direction -X (In case of error, key in W)

The result should be as shown in the picture:

In the following example, the user will set dimension points for d which is the bolt diameter.

Set the first Dimension Point 501 and the second Dimension Point 502 as below:

 Design Point Description 2xd (2x means that there are two bolt holes.)
 Dimension Position X (CDPR WIDA / 2 + 100mm / SQRT ( 2 ) ) Y ( - 150mm / SQRT
(2)) Z(0)
 Dimension Extension 150mm
 Dimension Direction Y 45 -X

The result should be as shown in the picture:

© Copyright 1974 to current year. 87

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Key in the following attribute values:

 Bore 100mm (The Design Point is used to display the circumference dimension, not the
linear dimension)
 Orientation Y IS Z AND Z IS –Y (It is the orientation of AID circle for the bolt hole dimension)

Then the Template View form will display the dimensions as below:

© Copyright 1974 to current year. 88

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Lastly the user will set dimension points for W which is the overall width W = a + W1 + b.

Select the last first dimension point from the list and edit the values as below:
To position at the start of the Template Element SCTN 1, set the values as below:

 Design Point Description W

 Design Parameter Number 11 (Any index not in use for a design parameter)
 Dpoint No 11 (Any index not duplicated)
 Dimension Position X ( -CDPR DISA - CDPR WIDA / 2) Y ( -200 mm ) Z ( 0 )
 Dimension Extension 200mm
 Dimension Direction Y

Click Include.

Select the second dimension point for W.

To position at the end of SCTN 1, edit the values as below:

 Design Point Description W

 Design Parameter Number 11 (Should be the same as the first dimension point’s)
 Dpoint No 12 (Must be the next number of the first dimension point’s, but not
duplicated)
 Dimension Position X ( CDPR WIDA / 2 + CDPR DISB ) Y ( -200 mm ) Z ( 0 )
 Dimension Extension 200mm
 Dimension Direction Y

These dimension points are also displayed incorrectly in the 3D View, but correctly in the Template View
form.

© Copyright 1974 to current year. 89

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.1.6 Setting Purpose and Function

Navigate to the Template Element SCTN 2 in the Design Explorer.

Set the Purpose to LEG and the Function to E. This means that the end side of this angle is welded to a
facet of hull structure, hull panel, stiffener, etc.

All legs of a seat template must have its Purpose and Function attributes as below:

 Purpose starts with LEG (All legs with the same landing plane must have the same purpose.)
 Function E (the end side is welded), S (the start side is welded), ES or SE (both sides are
welded)

 Purp LEG
 Func E

 Purp LEGA
 Func E

 Purp LEGB
 Func E

Navigate to fittings for bolt holes under SCTN 1.

Set the Purpose to HOLE and the Function to BOLT. This means that these fittings are used to represent
bolt holes.

Navigate to FITT 1 under SCTN 1.

Set the Purpose to PAD and the Function to E. This means that this fitting is used to represent a pad and its
position is at the end side of the owner profile.

Navigate to /MYSEATAAA.
Set the Purpose to SEAT and the Function to /MYSEATAAA;MYSEATAAA;2;1;1. This means:

 Template name /MYSEATAAA

 PML handler object name MYSEATAAA
 Bolt hole count 2
 Equipment count that this seat can support 1
 Landing plane count needed 1

© Copyright 1974 to current year. 90

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

10.2 Creating Icon File

Create an icon file for /MYSEATAAA.

myseataaa.png, 85x85 pixels, PNG format

Put it in the icons directory, for example

C:\AVEVA\Marine\Design\EquipmentSeat12.1.SPx\PMLLIB\mcoe\icons. Typically this directory is located
under the installation directory.

10.3 Creating PML Handler Object

Open a text editor and create a text file as below:

 The easiest way to create a skeleton handler object for a seat template is to copy an existing one and
delete its contents except for definitions for the object and methods).

Name the file as mySeatAAA.pmlobj and put it in the PMLLIB\mcoe\design\handlers directory.

Try to key in as below:

define object MYSEATAAA

endobject

define method .mySeatAAA()

endmethod

define method .validateParameters(!designer is ESADESIGNER) is BOOLEAN

return true
endmethod

define method .displayPreview(!designer is ESADESIGNER)

endmethod

define method .getProductionData(!designer is ESADESIGNER, !data is

ESAPRODUCTIONDATA)
endmethod

define method .getPseudoDimensionValue(!designer is ESADESIGNER, !name is

STRING) is REAL
return object REAL()
endmethod

define method .preCreate(!designer is ESADESIGNER)is BOOLEAN

return false
endmethod

define method .postCreate(!designer is ESADESIGNER)

endmethod

define method .preModify(!designer is ESADESIGNER) is BOOLEAN

return false
endmethod

© Copyright 1974 to current year. 91

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

define method .postModify(!designer is ESADESIGNER)

endmethod

define method .rotate(!designer is ESADESIGNER) is ORIENTATION

return object ORIENTATION()
endmethod

define method .getLandingPlane(!legKey is STRING, !start is BOOLEAN) is PLANE

return object PLANE()
endmethod

define method .process(!designer is ESADESIGNER) is BOOLEAN

return true
endmethod

.validateParameters(!designer is ESADESIGNER) is BOOLEAN

: This method will validate input parameter values.
For this new template, make sure that the input values are greater than or equal to 0.

define method .validateParameters(!designer is ESADESIGNER) is BOOLEAN

do !i indices !designer.designParams
!title = !designer.designParams[!i].title
!value = !designer.designParams[!i].value[1]

if !value.lt(0) then
!!alert.error(|Please input valid value for '| + !title + |'!|)
return false
endif
enddo

return true
endmethod

.displayPreview(!designer is ESADESIGNER)
: This method will draw a preview of a seat instance using Graphic AID elements.
For this new template, a preview of boundary box of a seat instance is already provided as below:

© Copyright 1974 to current year. 92

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

define method .displayPreview(!designer is ESADESIGNER)

-- read property values
!w1 = !designer.getTemplatePropertyValue('WIDA')
!l = !designer.getTemplatePropertyValue('LEGL')
!d = !designer.getTemplatePropertyValue('BDIA')
!a = !designer.getTemplatePropertyValue('DISA')
!b = !designer.getTemplatePropertyValue('DISB')

!xdir = !designer.orientation.xdir()
!ydir = !designer.orientation.ydir()
!zdir = !designer.orientation.zdir()

!angleSpco = !designer.getTemplatePropertyValue('EASP')
!angleWidth = !!comConvertUnknownValue(!angleSpco.param[1], 'MM')
!angleThickness = !!comConvertUnknownValue(!angleSpco.param[3], 'MM')

-- draw boundary box

!box = object GMFBOX()
!box.xLength = !a + !w1 + !b
!box.yLength = !l
!box.zLength = ! angleWidth
!box.position = !designer.position.offset(!xdir, (!b - !a) / 2 ).offset(!ydir,
!box.yLength / 2)
!box.orientation = !designer.orientation

!gphBox = object GPHBOX(!box)

!gphBox.draw(!designer.aidNoForPreview)

-- draw bolt holes

!boltPositions = ARRAY()
!boltPositions.append(!designer.position.offset(!xdir, !w1 / 2))
!boltPositions.append(!designer.position.offset(!xdir, -!w1 / 2))
!boltOrientation = object ORIENTATION('X IS ' + !xdir.string() + ' AND Z IS '
+ !ydir.opposite().string())
!boltDiameter = !d
!boltHoleHeight = !angleThickness
do !boltPosition values !boltPositions
!designer.drawBoltHolePreview(!boltPosition, !boltOrientation,
!boltDiameter, !boltHoleHeight)
enddoendmethod

.getPseudoDimensionValue(!designer is ESADESIGNER, !name is STRING) is REAL

: This method will provide a value of a pseudo dimension property.
For this new template, this method will not be used.

define method .getPseudoDimensionValue(!designer is ESADESIGNER, !name is

STRING) is REAL
-- just return an empty real value
return object REAL()
endmethod

.getProductionData(!designer is ESADESIGNER, !data is ESAPRODUCTIONDATA)

: This method will provide detailed production data for a seat type.
For this new template in this training course, the following built-in function provided in the application will be
used instead of this method. Define Template Property as below:

 Description Production data

 Key PROD (The key must be PROD.)
 Definition Expression
© Copyright 1974 to current year. 93
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Data Type String

 Default ‘’
 expr ‘WIDA;LEGL;BDIA;DISA;DISB;WID;EASP;’

define method .getProductionData(!designer is ESADESIGNER, !data is

ESAPRODUCTIONDATA)
-- empty
endmethod

.preCreate(!designer is ESADESIGNER) is BOOLEAN

: This method will be called to handle pre-processing jobs before running the standard creation procedure. In
other words, the standard creation procedure is executed after running this method. To skip the standard
creation procedure, return false.
For this new template, do not use this method but leave it empty:

define method .preCreate(!designer is ESADESIGNER) is BOOLEAN

-- The Equipment Seat Application will handle the creation for us
return false
endmethod

.postCreate(!designer is ESADESIGNER)
: This method will be called to handle post-processing jobs after running the standard creation procedure.
For this new template, do not use this method but leave it empty:

define method .postCreate(!designer is ESADESIGNER)

-- empty
endmethod

.preModify(!designer is ESADESIGNER) is BOOLEAN

: This method will be called to handle pre-processing jobs before running the standard modification
procedure. In other words, the standard modification procedure is executed after running this method. To
skip the standard modification procedure, return true.
For this new template, do not use this method but leave it empty:

define method .preModify(!designer is ESADESIGNER) is BOOLEAN

-- The Equipment Seat Application will handle the modification
return true
endmethod

.postModify(!designer is ESADESIGNER)
: This method will be called to handle post-processing jobs after running the standard modification procedure.
For this new template, do not use this method but leave it empty.

define method .postModify(!designer is ESADESIGNER)

-- empty
endmethod

.rotate(!designer is ESADESIGNER) is ORIENTATION

: This method will calculate a new orientation of seat when the user clicks Rotate on the edit form.
For this new template, rotation by 180 degree is allowed only:

© Copyright 1974 to current year. 94

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

define method .rotate(!designer is ESADESIGNER) is ORIENTATION

!xdir = !designer.orientation.xdir()
!ydir = !designer.orientation.ydir()
-- just reverse the x-axis against the y-axis
return object ORIENTATION(‘X is ‘ + !xdir.opposite().string() + ‘ AND Y is ‘ +
!ydir.string())
endmethod

.process(!designer is ESADESIGNER) is BOOLEAN

: This method is the main method of a handler object and will calculate items needed for a seat, for example
position, orientation, landing planes, dimensions, etc., with given parameter values.
Before implementing this method, declare a member variable to store a landing plane value as below:

define object .MYSEATAAA

member .landingPlane is PLANE
endobject

define method .process(!designer is ESADESIGNER) is BOOLEAN

-- unset the landing plane value

!this.landingPlane = object PLANE()

-- retrieve all template property values given by user

!w1 = !designer.getTemplateProperty('WIDA')
!l = !designer.getTemplateProperty('LEGL')
!d = !designer.getTemplateProperty('BDIA')
!a = !designer.getTemplateProperty('DISA')
!b = !designer.getTemplateProperty('DISB')

!seatPosition = !designer.position
!seatOrientation = !designer.orientation
!targetPlane = !designer.getTargetPlane()

if !designer.targetEquipments.empty() then
-- no equipment selected, stand-alone
if !targetPlane.set() then
-- no landing plane selected
if !seatOrientation.unset() then
!planeXDir = !targetPlane.orientation.xdir()
!planeYDir = !targetPlane.orientation.ydir()
!planeZDir = !targetPlane.orientation.zdir()

© Copyright 1974 to current year. 95

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

!ydir = !planeZDir.opposite()

!zaxis = object DIRECTION('Z')

if !planeXDir.dot(!zaxis).abs().gt(!planeYDir.dot(!zaxis).abs()) then
!zdir = !planeXDir
if !planeXDir.dot(!zaxis).lt(0) then
!zdir = !zdir.opposite()
endif
else
!zdir = !planeYDir
if !planeYDir.dot(!zaxis).lt(0) then
!zdir = !zdir.opposite()
endif
endif

!seatOrientation = object ORIENTATION('Y IS ' + !ydir.string() + ' AND Z

IS ' + !zdir.string())
endif

!ydir = !seatOrientation.ydir()
!seatPosition = !targetPlane.intersection(object
POINTVECTOR(!seatPosition, !ydir)).offset(!ydir, -!l)
handle (2, 875)
!designer.warning('Plane and leg are parallel!')
elsehandle NONE
!this.landingPlane = !targetPlane
endhandle
endif
else

-- retrieve bolt data of the target equipment

!boltData = !designer.getEquipBoltData()
!boltCount = !boltData.size()
if !boltCount.neq(2) then
!designer.warning(|Insufficient bolt information - | + !boltCount.string()
+ |/2 found!|)
return false
endif

!boltDirection = !boltData[1].direction.opposite()
!boltPositions = !boltData.evaluate(object
BLOCK('!boltData[!evalIndex].position'))

-- calculate position
!seatPosition = !boltPositions[1].midpoint(!boltPositions[2])

-- calculate orientation
if !seatOrientation.unset() then

!xdir = !boltPositions[1].direction(!boltPositions[2])
!ydir = !boltDirection.opposite()
!zdir = !xdir.cross(!ydir)
-- make sure that !zdir is always toward upper direction
!zaxis = object DIRECTION('Z')
if !zdir.dot(!zaxis).lt(0) then
!zdir = !zdir.opposite()
endif
!seatOrientation = object ORIENTATION('Y IS ' + !ydir.string() + ' AND Z
IS ' + !zdir.string())

endif

© Copyright 1974 to current year. 96

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

-- calculate w1, distance between bolt holes

!w1 = !boltPositions[1].distance(!boltPositions[2])

-- bolt diameter
do !boltDatum values !boltData
if !boltDatum.diameter.set() AND !boltDatum.diameter.gt(0) then
!d = !boltDatum.diameter
break
endif
enddo

-- calculate the length of leg

if !targetPlane.set() then
if !targetPlane.orientation.zdir().dot(!seatOrientation.ydir()).gt(0) then
!designer.warning(|Plane and leg have the same direction!|)
else
!xpt = !targetPlane.intersection(object POINTVECTOR(!seatPosition,
!seatOrientation.ydir()))
handle (2, 875)
!designer.warning(|Plane and leg are parallel!|)
elsehandle NONE
!this.landingPlane = !targetPlane
!l = !seatPosition.distance(!xpt)
endhandle
endif
endif
endif

-- set the new property values, position and orientation

!designer.setTemplateProperty('BDIA', !d)
!designer.setTemplateProperty('WIDA', !w1)
!designer.setTemplateProperty('LEGL', !l)
!designer.setTemplateProperty('DISA', !a)
!designer.setTemplateProperty('DISB', !b)

!designer.position = !seatPosition
!designer.orientation = !seatOrientation

-- return false to notify that there is no error

return false
endmethod

.getLandingPlane(!legKey is STRING, !start is BOOLEAN) is PLANE

: This method will return the PLANE object where a specified leg is attached (or welded).

Landing Plane A
 Purp LEGA
 Func E

 Purp LEGB
 Func E
Landing Plane B

© Copyright 1974 to current year. 97

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

 Landing Plane means a plane where one or more legs of a seat are welded.

In the above picture:

 getLandingPlane (‘LEGA’, false) returns Landing Plane A
 getLandingPlane (‘LEGB’, false) returns Landing Plane B

For this new template, return a value of member variable landingPlane which is set by the .process
method.

Landing Plane

 Purp LEG
 Func E

method . getLandingPlane(!legKey is STRING, !start is BOOLEAN) is PLANE

-- return the landing Plane only if the legKey is ‘LEG’ and !start is FALSE
if !legKey.eq(‘LEG’) AND !start.not() then
return !this.landingPlane
endif
return object PLANE()
endmethod

Key in PML REHASH ALL in the Command Window so that the AVEVA Marine can find the newly created
files (i.e. mySeatAAA.pmlobj and myseataaa.png).

Reload the Outfitting module and select Design > Equipment.

Select Utilities > Equipment Seat Designer to open the ESA - Designer form.
Check if the new template /MYSEATAAA is in the template list in the All tab.

© Copyright 1974 to current year. 98

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Marine (12.1)
Equipment Seat Application TM-2242

Test the newly created template in design.

© Copyright 1974 to current year. 99

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.