TM 2120 AVEVA Marine 12 1 System Administration Basic Rev 3 0 PDF

AVEVA Marine
(12.1)
System Administration
(Basic)
TM-2120
www.aveva.com
AVEVA Marine (12.1)
System Administration (Basic) TM-2120
Revision Log
Date Revision Description of Revision Author Reviewed Approved
27/09/2011 0.1 Issued for Review SK / WR
09/10/2011 0.2 Reviewed SK / WR FP / MZ
25/10/2011 1.0 Issued for Training 12.1 SK / WR FP / MZ SH
02/12/2011 2.0 Issued with latest copyright footer CF CF
Cache Manager and Optional
30/10/2012 2.1 Upgrade added. Design Reuse SK / WR / MZ
exercise revised to use AMT
02/11/2012 3.0 Issued for Training 12.1.SP3 SK / WR / MZ SK/WR WR
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 tps@aveva.com
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Visit our website at http://www.aveva.com
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses;
loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or
information; any special, indirect, consequential or pure economic loss, costs, damages, charges or
expenses which may be suffered by the user, including any loss suffered by the user resulting from the
inaccuracy or invalidity of any data created by the AVEVA software, irrespective of whether such losses are
suffered directly or indirectly, or arise in contract, tort (including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall take
precedence. www.aveva.com
Copyright 1974 to current year. 2
AVEVA Solutions Limited and its subsidiaries.
AVEVA Marine (12.1)
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part
of it (including source code, object code, any data contained in it, the manual and any other documentation
supplied with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this
document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or
transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is
granted, it expressly requires that this copyright notice, and the above disclaimer, is prominently displayed at
the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in
this publication may be incorporated into any third-party software, product, machine, or system without the
prior written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised
action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the
terms and conditions of the respective software licences, and in accordance with the relevant User
Documentation. Unauthorised or unlicensed use of the software is strictly prohibited.
Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA
shall not be liable for any breach or infringement of a third party's intellectual property rights where such
breach results from a user's modification of the AVEVA software or associated documentation.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its
name or logo belongs to its respective owner.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Contents
1 Introduction .............................................................................................................................................. 9
1.1 Aim..................................................................................................................................................... 9
1.2 Objectives ......................................................................................................................................... 9
1.3 Prerequisites .................................................................................................................................... 9
1.4 Course Structure .............................................................................................................................. 9
1.5 Using this guide ............................................................................................................................... 9
2 Installation and Setup............................................................................................................................ 11
2.1 Installation of FlexMan 5.2 ............................................................................................................ 11
2.2 Installation of the AVEVA Marine (12.1) Application Product Software ................................... 16
2.2.1 Automatic Install of the Cache Service .................................................................................... 16
3 Project Access Verifying Installation................................................................................................ 21
3.1 Installation Projects ....................................................................................................................... 21
3.2 Adding Project Environment Variables to the Batch File .......................................................... 22
3.3 Starting the AVEVA Marine (12.1) Application ............................................................................ 23
3.4 Optional Upgrade ........................................................................................................................... 24
4 Creating a New Project .......................................................................................................................... 25
4.1 Project Creation Wizard ................................................................................................................ 25
4.1.1 Project Variables ...................................................................................................................... 25
4.1.2 Adding Project Details .............................................................................................................. 27
4.2 Existing Projects ............................................................................................................................ 27
Exercise 1 - Project Creation ........................................................................................................................ 28
5 Database Administration ...................................................................................................................... 29
5.1 Teams and Users ........................................................................................................................... 30
5.2 Creating Teams .............................................................................................................................. 31
5.3 Creating Users ................................................................................................................................ 32
5.3.1 Create User as a Copy of the Existing User ............................................................................ 34
5.3.2 Creating Users using the Access Control Assistant ................................................................. 34
Exercise 2 - Teams and Users ...................................................................................................................... 35
6 Creating Databases ............................................................................................................................... 37
6.1 Data Base Types ............................................................................................................................ 37
6.1.1 Administration Databases ........................................................................................................ 37
6.1.2 Model Databases ..................................................................................................................... 38
6.2 Creating a Design Database ......................................................................................................... 38
6.2.1 Create SITE .............................................................................................................................. 39
6.2.2 Database Access Mode ........................................................................................................... 40
6.2.3 Database Access Restrictions ................................................................................................. 41
6.2.4 Controlled Databases ............................................................................................................... 41
6.2.5 Protection ................................................................................................................................. 41
6.2.6 Reference Only Databases ...................................................................................................... 42
6.2.7 Area Number, DB Number and File Number ........................................................................... 42
6.3 Creating a Catalogue Database .................................................................................................... 43
6.3.1 Creating Namesequence Database ......................................................................................... 44
6.4 Copied Databases .......................................................................................................................... 44
Exercise 3 - Database Creation .................................................................................................................... 45
7 Foreign Databases ................................................................................................................................. 47
7.1 Including and Copying Foreign Databases ................................................................................. 47
7.1.1 Including Databases from the MAS Project ............................................................................. 47
7.2 Copying a Foreign Database from the MTP Project ................................................................... 48
7.3 Excluding Foreign Databases ....................................................................................................... 48
7.4 Deleting Databases ........................................................................................................................ 48
7.5 Modifying the setup of the Admin Elements Form ..................................................................... 49
Exercise 4 - Copying and Including Foreign Databases ........................................................................... 50
8 Multiple Databases (MDBs) ................................................................................................................... 51
8.1 Creating MDBs ............................................................................................................................... 52
8.2 Database Order in the MDB .......................................................................................................... 53
Exercise 5 - Creating MDBs .......................................................................................................................... 54
9 Project Setup Excel Import ................................................................................................................... 55
9.1 Admin Export to Excel ...................................................................................................................
www.aveva.com 55
9.2 Project Setup Excel Spreadsheet File ......................................................................................... 56
AVEVA Marine (12.1)
9.2.1 Project Setup Excel Spreadsheet - Teams .............................................................................. 56

9.2.2 Project Setup Excel Spreadsheet - Users ................................................................................ 57
9.2.3 Project Setup Excel Spreadsheet NT Authenticated Users .................................................. 57
9.2.4 Project Setup Excel Spreadsheet Databases ....................................................................... 58
9.2.5 Project Setup Excel Spreadsheet Included Foreign Databases ............................................ 58
9.2.6 Project Setup Excel Spreadsheet Multiple Databases........................................................... 59
9.3 Starting the Excel Import Form .................................................................................................... 59
9.4 Admin Database Rollback ............................................................................................................. 61
Exercise 6 Project Setup Excel Import ..................................................................................................... 62
10 Project Replication ............................................................................................................................ 63
10.1.1 Replicate Project Data ............................................................................................................. 63
10.1.2 Replicate Project Structure ...................................................................................................... 64
Exercise 7 Project Replication .................................................................................................................. 65
11 Hull Top Level Elements ................................................................................................................... 67
Exercise 8 - Creating Hull Top Level Elements .......................................................................................... 68
12 Testing the AVEVA Hull and Outfitting 12.1 Access ...................................................................... 69
12.1 Testing the Access ........................................................................................................................ 69
Exercise 9 - Testing AVEVA Marine (12.1) Access ..................................................................................... 73
13 References between Databases ....................................................................................................... 75
13.1 Checking Inter-DB Macros ............................................................................................................ 75
13.1.1 Finding the Names of the Inter-DB Macros .............................................................................. 76
13.1.2 Checking that the Nozzle CREF is not Set .............................................................................. 76
13.2 Running the Inter-DB Macros ....................................................................................................... 76
13.3 Deleting Inter-DB Macros .............................................................................................................. 77
Exercise 10 - Running Inter-DB Macros ...................................................................................................... 77
14 NT Authentication .............................................................................................................................. 79
14.1 Setting up NT Authentication ....................................................................................................... 79
14.2 Testing the NT Authentication ...................................................................................................... 80
Exercise 11 - NT Authentication ................................................................................................................... 80
15 Sharing AVEVA Hull and Outfitting 12.1.SPx Projects and Files .................................................. 81
15.1 Sharing Files ................................................................................................................................... 81
15.2 Cache Manager............................................................................................................................... 83
15.3 Creating Shortcuts ......................................................................................................................... 84
15.4 Change Start in Directory .............................................................................................................. 84
15.5 Shortcut Arguments ...................................................................................................................... 85
Exercise 12 - Creating Desktop Shortcut .................................................................................................... 85
16 Project Administration ...................................................................................................................... 87
16.1 Locking the Project Database ....................................................................................................... 87
16.2 Options under the Admin Menu ................................................................................................... 87
16.3 Abnormal Exits ............................................................................................................................... 88
16.4 Display Menu .................................................................................................................................. 88
16.5 The Query Options ......................................................................................................................... 88
16.5.1 User Status Form ..................................................................................................................... 88
16.5.2 User List Form .......................................................................................................................... 89
16.6 Team List Form .............................................................................................................................. 89
16.7 Database List Form ........................................................................................................................ 89
16.7.1 DB Session Form ..................................................................................................................... 90
16.7.2 MDB List Form ......................................................................................................................... 90
16.7.3 Stamp List Form ....................................................................................................................... 90
16.7.4 Data Access Control Audit Form .............................................................................................. 91
16.7.5 Database Sets Report Form .................................................................................................... 91
16.8 The Settings Options ..................................................................................................................... 92
16.9 The Utilities Options ...................................................................................................................... 92
16.9.1 Integrity Checker Option .......................................................................................................... 92
16.9.2 Sending Message..................................................................................................................... 93
16.10 The Project Options ................................................................................................................... 93
16.10.1 Project Information ............................................................................................................... 93
16.10.2 Font Families ........................................................................................................................ 94
16.10.3 True Type Fonts ................................................................................................................... 95
Exercise 13 - True Type Fonts ...................................................................................................................... 97
16.10.4 Module Definition .................................................................................................................. 97
16.10.5 www.aveva.com
Marine Environment Variables ............................................................................................. 99
AVEVA Marine (12.1)
16.11 Deleting Phantom Users / Claim Lists ..................................................................................... 99

16.12 The Data Options ..................................................................................................................... 100
16.12.1 Change Management ......................................................................................................... 100
16.12.2 Backtracking the Databases (Command Window) ............................................................ 103
16.12.3 Inter-DB Macros ................................................................................................................. 103
16.12.4 Inter-DB Macros ................................................................................................................. 104
Exercise 14 - Database Sessions ............................................................................................................... 104
17 AVEVA Hull and Outfitting 12.1.1 Environment Variables ........................................................... 105
17.1 Environment Variable PDMSWK................................................................................................. 105
17.2 Environment Variable PDMSUSER............................................................................................. 105
17.3 Serialisation Files......................................................................................................................... 105
17.4 Environment Variable PDMSUI ................................................................................................... 106
17.5 Environment Variable PMLLIB .................................................................................................... 106
18 Data Integrity Checker ..................................................................................................................... 107
18.1 Main Checks ................................................................................................................................. 107
18.2 Causes of database corruption .................................................................................................. 107
18.3 Database Storage Statistics ........................................................................................................ 107
18.4 Preparatory Steps before Checking Starts ............................................................................... 108
18.5 Using DICE .................................................................................................................................... 108
18.5.1 Check options ......................................................................................................................... 108
18.5.2 Settings options ...................................................................................................................... 109
18.6 Macros ........................................................................................................................................... 110
18.7 DICE Output .................................................................................................................................. 111
18.8 The Error Report .......................................................................................................................... 112
18.9 The Report Summary ................................................................................................................... 112
18.9.1 Fatal Errors ............................................................................................................................. 112
18.9.2 No Structural Errors................................................................................................................ 112
Exercise 15 - Dice ........................................................................................................................................ 112
19 Lexicon .............................................................................................................................................. 113
19.1 Lexicon GUI .................................................................................................................................. 113
19.2 Lexicon Hierarchy ........................................................................................................................ 114
19.2.1 Dictionary Database ............................................................................................................... 114
19.3 Lexicon Options ........................................................................................................................... 116
19.4 Display Options ............................................................................................................................ 116
19.5 Edit Options .................................................................................................................................. 116
19.6 Schematic Model Manager Options ........................................................................................... 117
19.7 Dictionary Explorer ...................................................................................................................... 117
19.8 Current Element Editor ................................................................................................................ 118
19.9 Creating a UDA (Worked Example) ............................................................................................ 118
19.9.1 ......................................................................... 119
19.10 Creating a USDA (Worked Example) ...................................................................................... 120
19.11 Creating UDET (Worked Example) ......................................................................................... 121
20 Assembly Planning Properties Creation ....................................................................................... 123
20.1 Creating an Assembly Working Location .................................................................................. 123
Exercise 16 - ................................................................................... 125
21 Status Management Configuration ................................................................................................ 127
21.1 Creating a Status World (Worked Example) .............................................................................. 128
21.2 Creating a New Status Definition ............................................................................................... 129
21.3 Creating a New Status Value ...................................................................................................... 130
21.4 Setting the Transitions ................................................................................................................ 131
21.5 Testing the Status Management Configuration. ....................................................................... 132
22 Appendix A - Backing up Data........................................................................................................ 133
22.1 Daily Backups ............................................................................................................................... 133
22.2 Typical Backup ............................................................................................................................. 133
22.3 Project Backups ........................................................................................................................... 133
23 Appendix B Design Resuse - Settings ........................................................................................ 135
23.1 Defaults ......................................................................................................................................... 135
23.2 Renaming options ........................................................................................................................ 135
24 Appendix B1 - Export from source project ................................................................................... 137
24.1 Source model check before export ............................................................................................ 137
24.2 Model Selection ............................................................................................................................ 138
24.2.1 www.aveva.com
Search utility ........................................................................................................................... 138
AVEVA Marine (12.1)
24.2.2 Drag and Drop from Explorers ............................................................................................... 139

24.3 Transfer set ................................................................................................................................... 140
Exercise 17 Design Reuse ....................................................................................................................... 140
25 Appendix B2 - Import into the target project ................................................................................ 141
25.1 Import and release surface file into target project ................................................................... 141
25.2 Hull block reference objects import ........................................................................................... 142
25.3 Hull reference objects ................................................................................................................. 142
25.4 Project catalogue and steel quality ............................................................................................ 142
25.5 Manufacturing packages ............................................................................................................. 142
25.6 Create a new RSO envelope ....................................................................................................... 142
25.7 Model import from transfer set ................................................................................................... 144
25.8 Nesting import .............................................................................................................................. 145
25.9 Outfitting model import ............................................................................................................... 146
25.10 Target model check after import ............................................................................................ 146
Exercise 18 Design Reuse ....................................................................................................................... 146
26 Appendix B3 Hull Model + Outfitting (Working Example)......................................................... 147
26.1 Export to transfer set ................................................................................................................... 147
26.2 Import from transfer set .............................................................................................................. 148
www.aveva.com
CHAPTER 1
1 Introduction
AVEVA Marine (12.1) System Administration (Basic) Training Course will enable the Trainee to create and
maintain AVEVA Marine (12.1) projects.
1.1 Aim
Over the duration of the course the Trainee will be given a basic understanding of how to administer an
AVEVA Marine (12.1) Project.
1.2 Objectives
Set up a new AVEVA Marine (12.1) project, controlling which users have access to which
databases.
Set Hull top level elements using DBPrompt utility.
General system configuration.
Administer projects, including change management and setting AVEVA Marine (12.1) fonts.
Control user access to AVEVA Marine (12.1) modules.
Check data integrity.
Create DB Listings and understand change highlighting.
Create UDAs (User Defined Attributes)
Create UDETs (User Defined Element Types)
1.3 Prerequisites
Trainees should be familiar with AVEVA Marine (12.1) and Microsoft Windows
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 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 bold courier new font.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
CHAPTER 2
2 Installation and Setup
This chapter covers the installation of license software and application software and the configuration of the
Flexman license utility.
2.1 Installation of FlexMan 5.2
Insert the AVEVA Marine (12.1) software products disk into the computer. The disk will autostart and display
a welcome page. Click the Click for contents link.
The screenshots displayed in this chapter of

the manual are indicative only and may vary
depending on the installation version being
installed.
The contents of the disk are listed, showing the

Application Products and the Utility Products. From
the Utility Products section select the current version
of AVEVA Flexman.
Then select the option to suit your operating system

platform.
The Release Documents screen appears. Firstly, read

the release notes. Once this has been read and
understood select the INSTALL link.
www.aveva.com
AVEVA Marine (12.1)
The Microsoft Internet Explorer form appears asking for confirmation for running active content from CD on
your computer. Click the OK (or YES) button. A File Download Security Warning form now appears, Click
the Run button
A further Internet Explorer Security Warning form appears as the publisher could not be verified, click the
Run button. The FlexMan Setup form appears, click the Next button.
The FlexMan Setup form now changes to allow Custom Setup. To modify selection of features to be
installed, click the right mouse button on the selected feature and select the desired installation option from
the menu available. By default all the required features are pre-selected to be installed. Click the Next
button. The form now changes to Ready to install FlexMan, click the Install button.
Browse may also be used to change the installation

path.
The installation starts and is shown in the Status

bar.
www.aveva.com
AVEVA Marine (12.1)
When the installation is complete, the FlexMan setup form asks the user to click the Finish button to exit
and setup.
Now using Windows Explorer, select your Flexman installation folder e.g. C:\AVEVA_X64\FlexMan5.2 or
C\:AVEVA\FlexMan5.2 and place your AVEVA Marine (12.1) license file supplied by AVEVA here.
There are some limits for the license file, the host name
can only have 64 characters and the licence file lines
\
continuation character.
Now from the Start menu select All Programs > AVEVA_X64
> FlexMan5.2 > lmtools.exe (LMTOOLS)
The LMTOOLS form appears. On the Service/License File tab, select Configure using Services.
Then, select the Config Services tab.
Key in the Service Name AVEVA Marine
Use the Browse button to

browse for the Path to the
lmgrd.exe file, the Path to the
license file and the Path to
the debug log file. These are
all located in the FlexMan5.2
folder.
Tick the two boxes Start

Server at Power Up and Use
Services
Then click the Save Service

button.
www.aveva.com
AVEVA Marine (12.1)
Before running any AVEVA product, the path to the AVEVA license server needs to be set. From the Start
menu select All Programs > AVEVA > FlexMan 5.2 > FlexMan Configuration Tool. In the Select
Application Vendor pull-down menu select AVEVA(CADCENTRE). In the System registry (32 bit) and or
(64 bit) field key in 744@<Computername> i.e. 744@ukcaml4039. Then click the Set button.
Click the Save and Exit button when finished to close the form.
Generally 744 tcp-port number is used in AVEVA Marine (12.1). This tcp-port number can be
changed by the system manager. See your license file.
Only in extreme circumstances edit the registry to clear out any duplicate license path entries. From
the Run command in the Open field key in regedit., click OK. Under the HKEY_LOCAL_MACHINE
> SOFTWARE > FLEXlm License Manager select the LM_LICENSE_FILE that is incorrect, then
click the right mouse button and select from Modify, Delete or Rename
www.aveva.com
AVEVA Marine (12.1)
The License Server has not yet been started. To start the license server the user can either, Stop and restart
your computer, which will start the AVEVA Marine license service or Start the license server manually by
opening the Start/Stop/Reread tab and click the Start Server button.
To check that your license server has started correctly the user can view the contents of the license server
debug log file by opening the Config Services tab and then select the View Log button.
For some common faults and workarounds see LicenseAdministration.pdf in the Flexman installation folder,
or visit:
http://support.aveva.com/services/products/flex/flexnews.htm
www.aveva.com
AVEVA Marine (12.1)
2.2 Installation of the AVEVA Marine (12.1) Application Product Software
If a previous version of the AVEVA Marine (12.1) software has been removed from the machine prior to
installing the new software version, the serialization files located in C:\Documents and Settings\<user
name>\Local Settings\Application Data\Aveva and the installation folder AVEVA\Marine are to be
deleted.
Remember to move any project you would like to keep which is located in the AVEVA\Marine folder
before removing the software.
2.2.1 Automatic Install of the Cache Service
The database caching service stores Dabacon database pages on the local disk to improve performance
where there is repeated reading of project data across a computer network. The cache must be active on
the machine running the application, but the cache is shared by all applications and users running on that
machine. If the cache service is not active then database access is via the network file system, as usual.
The cache service will be automatically installed if

Message Queuing (also known as MSMQ) is
activated on your machine. This is done using the
Start > Control Panel > Add or Remove
Programs facility.
Where MSMQ is not active the cache service will

not be installed.
The Cache Manager is covered later in this

course.
Now that the FlexMan has been set up and MSMQ enabled (if required), select from the Application
Products section AVEVA Hull & Outfitting
www.aveva.com
AVEVA Marine (12.1)
The Release Documents for the AVEVA Marine Hull & Outfitting form is displayed click the INSTALL button.
The Microsoft Internet Explorer form appears asking for confirmation for running active content from CD on
your computer. Click the OK or YES button. A File Download Security Warning form now appears, Click
the Run button.
A further Internet Explorer Security Warning form appears as the publisher could not be verified, click the
Run button.
Windows Installer initiates the AVEVA Marine (12.1) setup form. On the AVEVA Marine (12.1) Setup form
click the Next button.
www.aveva.com
AVEVA Marine (12.1)
The Custom Setup selection form is displayed for the user to select the features to be installed. By default
the AVEVA Marine Suite and Initial Design are pre-selected for installation. To install Hull and Outfitting
Marine Sample Projects, place mouse cursor on the icon next to Marine Sample Projects, from the
right mouse button context sensitive menu chose Entire feature will be installed on local hard drive from
the options. The AVEVA Marine (12.1) Setup form now allows the administrator to change the destination
folder by selecting the Browse button if required. When the destination folder has been set, click the Next
button.
For the purpose of the Training please make sure that the Area Based ADP, Multi Discipline
Supports and the Schematic 3D Integrator are installed
The Marine setup form now requests Advanced Configuration

settings for customers with existing projects and
infrastructure. By default .bat files will be installed with
StartMenu Shortcuts and Desktop Shortcuts, these can be
selected as required.
The Install Configuration form allows the configuration of folder paths for the pdmsuser, pdmswk and the
DFLTS. The form now informs the administrator that the software is ready for installation. If no modification
of destination folder is necessary, click the Install button. Otherwise, click Back button to go back through
the steps and change the necessary information. The form changes to show the Setup status.
www.aveva.com
AVEVA Marine (12.1)
Once the Installation is complete, the form will change to inform the administrator that the installation is
completed. Click the Finish button to exist form.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
CHAPTER 3
3 Project Access Verifying Installation
AVEVA Hull and Outfitting 12.1.SPx makes extensive use of Environment Variables; they are used to define
the location of the AVEVA Marine (12.1) software and Projects. In this chapter we are going to investigate
the setting and the location of AVEVA Marine (12.1) Projects with the use of the Project Environment
Variables for this we will be using the installed Marine sample project (MAR).
3.1 Installation Projects
AVEVA Marine (12.1) requires several a number of directories;

these are set for each project. Project names are made up using 3 Characters. i.e., for a Project e.g. MAR
MAR000 Project database directory.

MARDFLTS Project defaults directory.
MARDIA Project Visio diagram directory.
MARDRG Project Marine Drafting drawings directory.
MARDWG Project Final Designer drawings directory.
MARISO Project Isodraft Options directory.
MARMAC Project Inter-DB connection macro directory.
MARMAR Project Hull directory.
MARPIC Project Draft Picture File directory.
MARSTE Project Visio Stencil directory.
MARTPL Project Visio template directory.
MARINFO Project Information directory.
MARREPORTS Project reports directory
MARPSI Project Pipe Stress Interface directory.
AVEVA Hull and Outfitting 12.1.SPx installs several sample projects from the AVEVA Marine (12.1)
installation CD.
CPL MDS Catalogue Project

LIS MDS Catalogue Project
MAR Marine Sample Project (Metric)
MAS Marine Master Catalogue
MDS MDS Project
MDU MDS User Defined joints Project
PSL MDS Catalogue Project
We are going to test our AVEVA Hull and Outfitting 12.1 installation using the installation sample project
MAR. The environment variables for the MAR project have been set up in the project batch file called
evarsMarine.bat project directory MAR. The evars.bat file held in the
AVEVA\Marine\OH12.1.SPx directory calls for the project batch file, setting all the project variables. The
evars.bat file is called from the marine.bat file which is executed when AVEVA Hull and Outfitting 12.1.SPx
is started from the start menu All Programs > AVEVA Marine > Design > Marine 12.1.SPx > <Required
Application>
All Catalogue information for the MAR project is held in the MAS project so the environment variables for
MAS have also been set. The Administrator will check the settings of MAR000, MARPIC, MARISO,
MARMAC, MAS000 and MASPIC.
Normally the MASMAC and MASISO will never be required as no Design or Isometrics will be produced in
the master catalogue project.
www.aveva.com
AVEVA Marine (12.1)
By default the supplied AVEVA Marine (12.1) projects are held in a project directory under the AVEVA
Marine (12.1) executables directory.
Navigate using the Windows Explorer or My

Computer to the Project directory, in this
example C:\AVEVA\Marine\Projects12.1.SPx\
The user can now see the installed AVEVA

Marine (12.1) Projects
3.2 Adding Project Environment Variables to the Batch File
If desired to locate the project to another location on your network it will be necessary to change the project
environment variables.
Modifications or additions to the Project Environment Variables should be made in the project s batch file
e.g. evarsMarine.bat. This file is normally in the project folder.
Using the Windows Explorer navigate to the project batch file e.g. evarsMarine.bat file and open it for
editing. The following is an example of how these project variables might be set:
A project loaded onto a machines hard disk
A Project loaded onto a server machine
The IP address \\192.168.95.43\

points to the server. This could have
also been the server name or another
machine name that holds the project
i.e. \\ukcaml3459\
Always make modifications to environment variables in the batch file, do not include them as system
variables as this may create conflicts between different AVEVA Marine (12.1) versions.
If all projects are located on a server, it is appropriate to have the evars.bat on that server otherwise it would
be necessary to edit the evars.bat file at each workstation. To ensure that only one evars.bat file needs to be
updated (the one on the server) when a project is added, the marine.bat file should be set to point at the
server evars.bat file. www.aveva.com
AVEVA Marine (12.1)
3.3 Starting the AVEVA Marine (12.1) Application
To start AVEVA Marine (12.1), select the application to be started from

within the AVEVA Marine menu options: Click Start > All Programs >
AVEVA Marine > then follow the path to the program you wish to start or
alternatively use the shortcut icons on the desktop to take you to the folder
containing shortcuts to the Marine executables. Expanded Start menu
options for Design show opposite:
The AVEVA
MARINE
application login
box appears the
Project,
Username and
MDB are chosen
by using the
option arrows
adjacent to each
entry (except for
SYSTEM which
is a free user
and does not appear in the drop down list) whilst the Password must be entered using the keyboard.
The Options: Integrate Engineering and Schematics setting is relevant when Outfitting is being used
alongside Engineer and/or Diagrams, and it affects the visibility of Engineering and Schematic data in the 3D
Outfitting modules. Engineering and Schematic data will be visible, read-only, when this option is checked.
The options are determined by the project set- AVEVA Hull and Outfitting 12.1.SPx is
initialised.
Select the Project mar, key in Username SYSTEM, key in the Password XXXXXX, then select the MDB
ALL_NO_MDS, click Login.
The first time Hull Design

module is started a warning
be displayed.
Click OK.
When module has started, click the File menu and select the
application to be used.
A default screen layout will be displayed comprising the general menu bar for the application and a Design
Explorer window showing all the objects from the current design project database.
To exit the AVEVA Hull and

Outfitting 12.1 application
select Design > Exit from the
main pull www.aveva.com
down menu.

AVEVA Marine (12.1)
3.4 Optional Upgrade
The database upgrade framework is extended with a concept of optional upgrades. The software requires a
database to be upgraded to a certain level to be granted write access to the database. But beyond that
mandatory upgrade level it is now possible to apply further optional upgrade levels to acquire new
enhanced features.
The benefit of optional upgrades is that 12.1.SP3 software operates with databases even though this
upgrade has not been applied, i.e. the upgrade is optional. Through this you can deploy and install
12.1.SP3 and share project data with previous software versions.
The upgrade level denoted 12010301 is an optional upgrade provided by release of 12.1 SP3 and contains
the following upgrade items.
Storing of a space arrangement definition.
Storing of coordinate system entities under a GENPRI element.
Introduce marine drawing type as table attribute. Applicable for PADD databases.
Marine Drawing Object applied with new Layers and IDs for outfitting models. Applicable for PADD
databases.
New Marine Drawing Types. Applicable for PADD databases.
The DBUP command is extended with an additional qualifier OPTIONAL to apply an optional upgrade
version e.g. DBUP PROJECT TO LATEST OPTIONAL.
The upgrade number may also be given directly e.g. DBUP PRO TO 12010301
The Q UPGRADE LIST is extended to give a short notice for upgrade versions that are optional.
Db upgrade: 12010301, Upgrades the database to 12.1.SP3, version 1. Optional upgrade version.
As soon as a database is upgraded it is no longer compatible with 12.1.SP2 or earlier versions.
If backtracking sessions on an upgraded project, if the backtrack takes you to a session before the
upgrade was performed, then that database will need to be upgraded once again.
www.aveva.com
CHAPTER 4
4 Creating a New Project
4.1 Project Creation Wizard
A Project Creation Wizard enables the administrator to create the project structure and an environment
variable batch file without the need to use manual techniques.
Activate the Project Creation Wizard by selecting All Programs > AVEVA Marine
> Design > Marine12.1.SPx > Project Creation Wizard.
The AVEVA Marine (12.1) Project Creation Wizard form appears, key in the
Project ShipAMA, the CODE AMA and key in the Address
C:\AVEVA\Marine\OH12.1.SPx\project\ShipAMA where the project will reside.
The project Address may be changed by typing or browsing but by default

it will be automatically populated with the default project path. The
address folder has to be created or should already exist before selecting
the Project Variables, Create, buttons etc.
The Project Creation Wizard only allows changes before the Project is created. Once the Project is
created changes can be done manually using the available utilities.
4.1.1 Project Variables
The Project variables Button primarily is used to display the location where the project will be created, but
can be used to create extra project areas for splitting the project across disks.
From the Project Creation Wizard form click the Project Variables button, the Project Variable form
appears.
If variables DWG, INFO, REPORTS and PSI and appropriate folders assigned to each variable are
to be included in the new project, check appropriate checkboxes in the Project Variables form
shown above.
www.aveva.com
AVEVA Marine (12.1)
4.1.1.1 Extra Project Areas
Using the Extra Project Areas Button Project,

additional areas can be created, these were
used in the past when disk space was at a
premium and are used by some customers
to split projects so that they can provide
windows file protection.
To add Extra Project Areas use the scrollable menu to select the number of extra project areas to create.
The additional Areas and Values are automatically added to the Project Areas and are created when the OK
button is clicked.
For the training we will only use the main area so the Extra Project Areas should be set to 0
4.1.1.2 Marine Variables
The Marine environment setup form is displayed the administrator can make changes to the variables in the
project definition file.
From the Project Variables form click the Marine Variables button, The Template path form now appears,
change the path as required and then click the OK button.
The Marine environment setup form is displayed showing all the Variables and Values, then select File >
Save. The Project Variables form is displayed once again now select File > Close.
This file can be launched through the Admin module. Select

Project > Marine environment setup .
www.aveva.com
AVEVA Marine (12.1)
4.1.2 Adding Project Details
The Details button is used to set the project details; this is used to populate the information forms in
Outfitting Design and Admin modules.
In Marine projects, the Number value must be the same as the Project value.
From the Project Creation Wizard form click the Details button, the Project Details form appears. Key in
the Name System Administration Training Project, the Description System Administration Training
and, if required, a Message. Then click the OK button.
Once the details and project variables have been configured, click on the Create button to create the new
project.
4.2 Existing Projects
From the Project Creation Wizard form Click the Existing Projects button. The Existing Projects form is
displayed with the newly created project shown.
The Existing Projects form lists information about existing projects. This form is intended only for browsing
the list of existing projects, and cannot be used to change existing projects. It can however be filtered by
Project or Code in the drop down box, and then search the list for a string by entering a value in the textbox.
Click the Cancel button to close the form.
www.aveva.com
AVEVA Marine (12.1)
When the project has been created a ProjectInfo.xml file is written / updated in the PDMS folder, this file can
be opened by using the windows explorer and navigating to C:\AVEVA\Marine\OH12.1.SPx\PDMS\
If for any reason the project creation fails, the references to that project should be removed from this
file to allow the user to re-use the project name.
The evars.bat file is also updated to include the path to the new project.
Exercise 1 - Project Creation
1. Create a new project AMA using the Project Creation Wizard.
2. Check the evars.bat file for the project path and the ProjectInfo.xml file
www.aveva.com
Chapter 5
5 Database Administration
To start AVEVA Marine (12.1) Admin utility select All Programs > AVEVA
Marine > Design> Marine 12.1.SPx > Admin
After initialising the application the AVEVA Marine (12.1) Login box appears.
The Project, Username and MDB are chosen by using the option arrows
adjacent to each entry (except for SYSTEM which is a free user and does not
appear in the drop down list) whilst the Password must be entered using the
keyboard. The options are determined by the project set-
AVEVA Marine (12.1) is initialised.
Enter the Project ShipAMA, Username SYSTEM,

Password XXXXXX, and then click OK
No MDB needs to be set to go into Admin

module
The Admin default screen layout will be displayed comprising of the main pull down menus, the Admin
Explorer, the Admin elements form, and the Access Control Assistant form, also available from the
Display pull down are the Attributes form and the Search utility.
Most of the admin elements will be created using the Admin elements form. Currently the Access Control
Assistant form can only be used for creating users and for Data Access Control (DAC).
It would be normal practice for the system administrator at this point to change the system administrator
password (Username = SYSTEM and Password = XXXXXX) to a new one for security reasons. However for
the purposes of this System administrator training we will not change it.
www.aveva.com
AVEVA Marine (12.1)
5.1 Teams and Users
In AVEVA Marine (12.1) each database belongs to one Team only. Ownership of a database is established
by the naming convention and has the format i.e. TeamName / DatabaseName. Users are defined by name
and password, which they enter when starting the AVEVA Marine (12.1) application.
Users are normally members of Teams. Any user belonging to a Team will have write access to the
databases owned by the Team.
Example of Teams and Users:
Team Description User / Password Owning the database(s) Type
CATA Project Catalogue Team CATA / CATA CATA/PIPE CATA

CATA/STEEL CATA
PIPEF Forward Piping areas PIPEF / PIPEF PIPEF/DESIGN DESI
PIPEA Aft Piping areas PIPEA / PIPEA PIPEA/DESIGN DESI
HULLFWD Forward Hull Blocks HULLF / HULLF HULLFWD/FWDBLOCKS DESI
HULLAFT Aft Hull Blocks HULLA / HULLA HULLAFT/AFTBLOCKS DESI
DRAFT Draft Team DRAFT / DRAFT DRAFT/DRAFT PADD
ISO Isometric Team ISO / ISO
ADMIN Administration Team ADMIN / ADMIN ADMIN/DICT DICT
ADMIN/PROP PROP
SCHEMATICS Schematics Team SCHEM / SCHEM SCHEMATICS/DIAGRAMSS SCHE
In addition, the following Teams and Users will be needed for the administrative functions:
Team Description User / Password
PARAGONADMIN Paragon Administration Team PARADM / PARADM

DESIGNADMIN Design Administration Team DESADM / DESADM
DRAFTADMIN Draft Administration Team DRAADM / DRAADM
ISOADMIN Isometric Administration Team ISOADM / ISOADM
CATADMIN Catalogue Administration Team CATADM / CATADM
HADMIN Hull Administration Team HADMIN / HADMIN
www.aveva.com
AVEVA Marine (12.1)
5.2 Creating Teams
To create a team, select from the Elements section of the Admin elements form the pull down list, choose
Teams, now from the form click the Create button.
The Create Team form appears, key in the Name CATA, the Description Project Catalogue Team and click
the Apply button.
Type the Team Name CATA
This process is repeated until all the necessary

teams are created. If modifications are required,
select from the Admin elements form the team to
modify and click the Modify button. Once the
Modify Team form appears make the necessary
changes and then click the Apply button and
then click the Dismiss button to close the form.
The Attributes form may also be used to edit

fields which are not greyed out.
If the Lock box is ticked all attributes will be greyed

out (to refresh the view select a different node in
the Explorer then reselect the previous node).
The Team MASTER can be changed the same way.
www.aveva.com
AVEVA Marine (12.1)
The Teams are now all shown.
5.3 Creating Users
To create a user, select from the Elements section of the Admin elements form the pull down list, choose
Users, now from the form click the Create button.
The Create User form appears. Key in the Name

CATA and the Description Project Catalogue User.
On the form, from the Project Teams section select

Project Team CATA and use the arrow to add it to
the Team Membership section.
To set password, click on the Set

Password button. Change Password form will
appear.
Key in the password CATA into the New Password field and
confirm it by retyping it into the Confirm New Password field. Click OK www.aveva.com
AVEVA Marine (12.1)
Password length can b

The User Security has two levels:
Free May enter all modules and may update any databases.
General May not enter the restricted modules, which are usually the administration modules of ADMIN and
LEXICON.
Now click the Apply button.

This process is repeated until all the necessary users are created.
The Users are now all shown.
If modifications are required, select the user from the

Admin elements form and click the Modify button.
Once the Modify User form appears make the

necessary changes and then click the Apply button
and then click the Dismiss button to close the form.
Modify User
form, click the Reset Password button. The Change
Password form will appear.
Key in the new password into the New Password field
and confirm it by re-typing it into the Confirm New
Password field. Click the OK button
password and exit from the form.
It is possible for the user to change their password at any time, if the administrator does not prevent
password change, from the Monitor module check the Change Password box and complete as above.
www.aveva.com
AVEVA Marine (12.1)
5.3.1 Create User as a Copy of the Existing User
To create a new user by copying an existing user, click the Copy button and on the Copy User form key in
the name, password, security and description for the new user. Confirm copying and exit the form by clicking
OK button.
When creating a new user by Copy User functionality, the

new inherits the same team membership as the user being
copied.
It is not possible to execute the copy user function

without setting the password for the new user. Entry
and confirmation of a password for the new user are
compulsory.
5.3.2 Creating Users using the Access Control Assistant
It is possible to create users using the Access Control Assistant, from the Access Control Assistant form,
select the Users tree and click the right mouse button and from the pop up select New user. Key in the User
name ANOTHER (refresh the list if necessary). Using the TAB button on the keyboard, switch to the User
description field. Key in the description Windows User. To set the password, use option for modifying user
from the Users Admin element form.
The AVEVA Marine (12.1) User name should always be in upper case
New user, windows user, can now be dragged to the

required Team / Teams using the left hand mouse
button.
www.aveva.com
AVEVA Marine (12.1)
Exercise 2 - Teams and Users
1. Create the Following Teams and Users for the AMA project.
The users should be members of their respective teams.
2. The Associations team will have a number of members, ASSEMBLY, HULLF, HULLA, HULLDES,
PIPEA, and PIPEF. It will also be necessary to add other users to teams to give required access.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 6
6 Creating Databases
6.1 Data Base Types
An AVEVA Marine (12.1) project can contain different types of databases described as follows further.
6.1.1 Administration Databases
The SYSTEM database holds the access control data for the model data and modules.
There is only one, SYSTEM database in the Project Directory. It holds administrative information about the
composition and use of the project, including the following:
A list of all the databases which are available in the project.

A list of all Users who can access the databases, and the Teams to which they belong.
A list of modules available in the project.
The SYSTEM database is a multiwrite database, which means that there may be more than one
user in ADMIN at any time but these users cannot modify the same part of the database at the same
time.
In the COMMS database the information are stored about who is using which module and which model
databases are available.
Each user has a separate area of the COMMS database, which can be accessed in write mode, and so can
other users in the project.
The COMMS database is a single-access database. Users queue for the COMMS database on
entry into the module.
The MISC database stores inter-user messages, and inter-database macros.
This database can only be opened in write mode by one user at a time, but many users can read from it. All
users need to be able to write to this database, but only when they are sending messages or writing inter-
database macros, or deleting messages and macros. All users can read from the database at any time
The MISC database is a single-access queued database, that is if a user wants to write to the MISC
database must wait until any other users writing to it have finished
www.aveva.com
AVEVA Marine (12.1)
6.1.2 Model Databases
DESIGN (DESI) databases contain all the design information for the project.
DRAFT (PADD) databases contain data about drawings produced by

Outfitting Draft and Marine Drafting.
CATALOGUE (CATA) databases contain the project catalogue and

specifications.
PROPERTIES (PROP) databases can contain material properties, and be

referenced to by the catalogue.
DICTIONARY (DICT) databases contain the definitions of User-Defined Attributes (UDAs), User Default
Element Types (UDETs) and User System Defined Attributes (USDAs) as set up in LEXICON.
ISODRAFT (ISOD) databases contain spool drawings produced by Spooler.
SCHEMATIC (SCHE) databases contain P&ID (Schematic) information.
MANUFACTURING (MANU) databases contain detailed manufacturing data.
NAMESEQUENCE (NSEQ) databases store name sequences.
ENGINEERING (ENGI) databases for engineering tags.
Each project can have only one of each type of administration databases and one Namesequence
database (one per location if Global is used with predefined sequences), but it can have any number
of other types of model database.
6.2 Creating a Design Database
To create a new database, select Databases & Extracts from the Elements section of the Admin elements
form pull down list, then click the Create button.
www.aveva.com
AVEVA Marine (12.1)
The Database & Extracts form appears. Select the radio button for Master DB and click the OK button.
The Extract of a DB is covered in the System Administration

(Advanced) training manual.
From the Owning Team section select the PIPEF team, now key in
the database name DESIGN, the description Forward Area Pipes,
and the site name PIPEF, then from the pull down list for Database
Type select Design and set the Access Mode to Multiwrite,
Implicit Claim
This is repeated until the required number of databases are

created.
For databases created to be used by hull design

applications, specific rules are defined and site is not to be
set. Hull application functionalities require creating certain
database types and, instead of sites, hull top level
elements are defined at a later stage. Creating hull top
level elements is covered later in this manual, in the
chapter entitled Hull Top Level Elements .
For a full list of the hull modelling requirements see Users
Guides AVEVA Marine, Hull in Dabacon, Marine
Databases and World Elements.
6.2.1 Create SITE
It is very useful when creating AVEVA Hull and Outfitting 12.1.SPx projects databases to have at least one
top level element created. This gives the administrator the ability to navigate to the correct database when
creating items in the design session.
Typical top level element types are: Design, SITE

Draft, DEPT
Catalogue, CATA
etc.
For the creation of hull specific top level elements, in hull databases, DBPrompt utility is used. See
chapter entitled Hull Top Level Elements .
www.aveva.com
AVEVA Marine (12.1)
6.2.2 Database Access Mode
The access mode for databases can be:
Update Allow one writer and multiple readers.

Multiwrite Allow multiple writers and multiple readers. Elements in databases with multiwrite
access must be claimed when they are modified so that no other user can change
them at the same time.
Claim mode can be:
Explicit Users must explicitly claim any element they wish to change before the modification can
start.
Implicit An element will automatically be claimed when it is activated
DESIGN, DRAFT, CATALOGUE, ISODRAFT, SCHEMATIC, MANUFACTURING and ENGINEERING

databases can be multiwrite. The SYSTEM database is always multiwrite.
It is normal practice to use multiwrite databases with implicit claim mode. The following are guidelines for
multiwrite databases:
Keep interactive usage levels to 10 or fewer Designers per database.

In Outfitting Design, Outfitting Draft and Paragon, keep data collected on a discipline basis where
possible e.g. have a Pipe database, a Steel database, Nested Plate Database etc.
Maintain the concept of a graphical split where possible
Use one Team with Multiple Users
Do NOT enter AVEVA Marine (12.1) more that once with the same name from different workstations
For multiwrite databases, it may be more appropriate to add several databases to the same team, and allow
several users to belong to that team.
If a project becomes Global, the administration becomes much easier if there are more databases i.e. for
outfitting only project, if Area 22 Piping is being modelled at another location, then Area 22 Piping database
can be allocated to the satellite for updating.
Remember the first level of access control is Team membership e.g. piping designers would not
normally have write access to Steelwork databases.
Database access mode can be changed from update to multiwrite at any time. Database access
mode can be changed from update to multiwrite only if no database extracts have been created.
www.aveva.com
AVEVA Marine (12.1)
6.2.3 Database Access Restrictions
Access restrictions apply to certain modules and database types as listed below:
Only Schematics modules (Diagrams and Schematic Model Manager) will be able to modify
databases with type Schematics.
Only Engineering module will be able to modify databases with type Engineering.
Only Hull and Outfitting modules (all others except Admin, Monitor and Lexicon) will be able to
modify databases with types Design, Draft, Isodraft, Manufacturing, Catalogue and Properties.
One exception to this exists: Schematics and Engineering modules can write to Design databases
Database read restrictions have also been introduced based on the Integrate Engineering and
Schematics mode selected when entering certain modules. If this is not selected on entry to a Hull
and Outfitting module, any databases in an MDB that have Schematics or Engineering database
type will be omitted without any warning being shown.
6.2.4 Controlled Databases
By selecting the Controlled checkbox user can specify that the database will
be controlled, by an external system.
If a database is defined as a CONTROLLED database, then all updates are controlled externally to
Outfitting. Both UPDATE and MULTIWRITE databases can be CONTROLLED.
The external system is accessed via an EDMSlink program, which must be supplied by the user. Users must
claim elements in order to change them on CONTROLLED databases. The EDMSlink program is activated
by Outfitting when a CLAIM or release is made. It is totally up to the user as to what the EDMSlink does.
Normally it will link into a user's central control system.
Both UPDATE and MULTIWRITE DESIGN databases can also be CONTROLLED.
6.2.5 Protection
By selecting the Protected checkbox the databases are marked as uniquely

belonging to the project from which it was protected such that restricted users
cannot copy data from that database into another project, even through a
physical copy of the database file. The following functionality will be
unavailable when Protected is checked:
OUTPUT command
COPY command, when copying across databases
EXPORT command
Data Access Routines (DARs)
In addition, read access to certain attributes is restricted to obstruct an unauthorised user from writing their
own output using functionality in PML. When Protected has been checked it is possible to set an expiry date.
Enabling the Expires checkbox highlights the date pull downs based on date.
www.aveva.com
AVEVA Marine (12.1)
6.2.6 Reference Only Databases
Systems and Areas can only be created in DESI DBs. Thus if product checks are made before opening a
DESI DB it appears that a 3D-product license will be required to access them, preventing 2D only users from
using Systems and Areas.
The Reference Only check box is only
ability of non-3D applications to create and modify reference data in the Design database.
The toggle is inactive when the form is in Modify mode to prevent modification; even when inactive
the value of the toggle accurately reflects the setting that applied on database creation. The toggle
also informs the top-level element type that is available for immediate creation when the database is
.
rence
command clause is available that is only available when DESI is given
as the database type: CREATE DB <database name> DESI [ REF/ONLY ]
It will not be possible to create certain top-level element types in Design databases that have this
-level types that will be available are listed in the following
table:
6.2.7 Area Number, DB Number and File Number
The Area Number, DB Number and File

Number are normally set by the system, as
shown by the word System entered in the input
boxes. It may sometimes be necessary to set
them manually.
The Area Number is used if the user needs to store databases in a different directory. The user can reset
this attribute by clicking the System button to the right of the input box.
The DB number is used internally to identify the database. When a database is copied or an extract is
made, the copy or extract keeps the same DB number as its parent. There cannot be more than one
database with the same DB number in the same MDB (unless the database is a Working Extract). The DB
numbers for user defined databases must be in the range 1 255,000, numbers 7,001 to 8,000 and 250,000
to 255,000 are reserved for AVEVA Solutions use. The user can reset this attribute by clicking the System
button to the right of the input box.
The Unique button can be used to allow the system to automatically

use the next available number in a predefined range. This range is set
from the Admin menu Settings > DB Number Range the following
form is displayed:
Key in the unique number range to be allocated to your project and

click Apply.then Dismiss the form.
www.aveva.com
In this instance the first number that will be used when the Unique button is clicked will be 10000.

AVEVA Marine (12.1)
The File number is used in generating the filename of the database, i.e. a database in project ABC with file
number 12 will be stored in the file named abc012. The File Number input box will only accept values in the
range of 1-8188. This value entered must be unique within the project. If the value is set to System (using
the button System next to the input box) then the file number will be reset to 0 and the database file will be
created with the name abc<database number>_0001 allowing for the 8188 limit to be ignored. It is
recommended to reset the file number to 0, particularly if a user is going to use extracts, as it will ensure that
file names are consistent within an extract family. In modify mode, the input box is inactive.
Click the Apply button and the database will created.
6.3 Creating a Catalogue Database
If the database is to be shared across many projects as may be the case with the Piping Catalogue, it will be
necessary to specify the AVEVA Marine (12.1) DB Number. Database numbers must be unique within
AVEVA Marine (12.1). Remember the Catalogue supplied by AVEVA has the AVEVA Marine (12.1) DB
Number in the 7000 range.
From the Settings menu set the DB

Number Range to be from 10000 to
20000.
On the Admin elements section of the

form Select Databases & Extracts from
the Elements pull down list. Then click
the Create Button.
The Create Database form appears, key in the

Name PIPE, the description Project Pipe
Catalogue, DB Element Name CATA/PIPE, then
from the Database Type pull down lists select
Catalogue, and from the Access Mode pull down
select Multiwrite. Select Unique for the DB Number
field, this will be set the catalogue DB Number as
10000.
This would be repeated until all the DBs are

created.
If there is a conflict in DB numbers it would

need to be resolved using Reconfigure
The administrator can use the Modify

button to change the database names if this
should be required.
Database access is controlled by the Team, so by

changing the team the database belongs to will also
change user access rights to that database.
www.aveva.com
AVEVA Marine (12.1)
6.3.1 Creating Namesequence Database
The Namesequence database (NSEQ) is used by Curved Hull and Assembly Planning. Creating of this type
of database is similar to previously described procedures, for creating design and catalogue database. The
difference is in access mode settings. There is no possibility to set access mode for this database. Also,
Controlled and Protection cannot be set.
For information of name sequences for global set up see TM-2262 AVEVA Marine (12.1) Global
training guide
6.4 Copied Databases
Copied databases can be used for:
Copying a template project

Merging projects
Copying included databases before archiving
If several users are to work on copies of the same

data, it may be more appropriate to use Extracts
Databases can be copied by selecting Database from the

Elements option list on the Admin elements form, selecting
the element desired to copy from the scrolling list, and then
clicking the Copy button. The Copy Database form will be
displayed.
On the form, the administrator can specify the Owning Team by selecting one from the list of all the teams in
the project. The administrator can give the copy a Name, Description and Area Number.
The database number of the copied database cannot be changed. This will be same as the original.
Users cannot have more than one database with the same database number in the same MDB
To avoid the risk of database corruption, all copying of databases (i.e. the files inside the Project
directory) must be done from the ADMIN module and not by using operating system utilities or
commands.
Copied databases can be changed or deleted.
www.aveva.com
AVEVA Marine (12.1)
Exercise 3 - Database Creation
1. Create the databases as describe below.
level elements to be defined at a later stage. For a full list of the hull requirements see User Guide >
Hull in Dabacon > Marine Databases and World Elements
www.aveva.com
AVEVA Marine (12.1)
View showing databases defined in Admin module.
2. Install the Training project MTP, follow the installation wizard delivered by the trainer. This will be
referenced in future exercises throughout the training. Please start the MTP project in Hull or
Outfitting to verify that the installation has been successful
The training will provide the folder

containing the exe file for the
installation of the MTP
www.aveva.com
Chapter 7
7 Foreign Databases
The administrator can copy databases from other projects. Databases can also be shared between projects;
which saves disk space and eliminates errors that could be caused by copying. Catalogue databases are
often shared in this way.
Databases included from a second project are also known as foreign databases. The second project must
be available, that is, the administrator must be able to read from the second project directory, and have the
environment variables for the second project set.
When the administrator creates a project that is going to share databases from other projects
Teams must exist for all databases that are to be shared.

Databases in the source project that will be shared must NOT be given a database number that will
clash with a database number that already exists in the destination project.
The Foreign Databases are marked with * in the database list.
7.1 Including and Copying Foreign Databases
To complete the database additions to our AMA project, we are going to include all the databases for the
MAS project and also copy a database from the MAR project.
7.1.1 Including Databases from the MAS Project
To include databases from MAS project, select Databases &

Extract from the Admin elements form and then click the
button.
Include Foreign Database form appears; select the MAS Project

from the Foreign Projects section, Key in the Username SYSTEM
and the Password XXXXXX. Then select all the foreign databases
except the databases starting with U and then click the Apply
button.
All the databases starting with U are Imperial example

databases
www.aveva.com
AVEVA Marine (12.1)
7.2 Copying a Foreign Database from the MTP Project
From the Admin elements form, click the Copy Foreign button. Copy Foreign Database form appears.
From the Foreign Project section, select the MTP project and
key in the Username SYSTEM and the Password XXXXXX.
Then select from the Foreign Database section the database to
copy i.e. MPROJECT/PADD. Now from the Target Database
Name section select the Target Database i.e. ADMIN and
finally click the Apply button.
Copy all databases belonging to MPROJECT team into

the new project to enable project libraries to be
available when executing different functions i.e.
Automatic Drawing Production.
7.3 Excluding Foreign Databases
The administrator can exclude foreign Databases by clicking the Exclude button on the Admin Element
form. The Exclude Foreign Database form will be displayed. Select the foreign databases to be excluded
and click Exclude .
7.4 Deleting Databases
Databases can be deleted by selecting the element from the list on the Admin
elements form and then clicking the Delete button.
To avoid the risk of database corruption, all deletion of databases (i.e. the files inside the project
directory) must be done from ADMIN and not by using operating system utilities or commands
www.aveva.com
AVEVA Marine (12.1)
7.5 Modifying the setup of the Admin Elements Form
The display on the Admin elements form can be changed to display additional information i.e. the Database
Filename, Database Access mode, etc.
From the Settings pull down menu select Display

Mode > Setup Admin Elements form .
The Level of Detail on the Admin Elements

form appears, select the two boxes for
Filename and Access so they are ticked and
click the Apply and then the Dismiss
button.
The Admin elements form now displays the two extra columns Access and Filename
www.aveva.com
AVEVA Marine (12.1)
Exercise 4 - Copying and Including Foreign Databases
1. Include all the Foreign Databases from the MAS project that are not imperial and not MDS or MDU
team own into the AMA project. The list of Foreign databases should appear as below.
2. Copy the MPROJECT/PADD, MPROJECT/CATA from the MTP project into the ADMIN team.
3. Change the display of the Admin Elements Form for Databases to include Access and Filename to
be displayed.
www.aveva.com
Chapter 8
8 Multiple Databases (MDBs)
To control what data a user can see, databases are grouped into Multiple Databases (MDBs). A project will
contain at least one MDB. A database may be a member of any number of MDBs.
An MDB must contain all the databases that the user needs to access. i.e., for a Design user, the MDB must
contain the databases which the user is going to work on. In addition, the MDB should contain all other
Design databases with data in the same physical volume, which will ensure the accuracy of clash checking,
in all other Design
Many users can access the same MDB. There are different ways of allowing access to MDBs, some options
are described below:
One MDB per User. This method is now superseded. It was common practice before the advent
of Multi-write databases. The DB with write access must be the first DB of that type (DESIGN,
DRAFT, etc.) in the MDBs list of members. This option was suitable for large projects with many
Update DBs and Users.
One MDB per Department. This is a common method of working it allows the System
Administrator to Group appropriate top level elements towards the top of the Design Explorer. In this
case, the System Administrator must create the top level elements in the DB.
One MDB per Area. This is a common method of working on larger project with several areas.
Adjacent Area databases may be included in the MDB.
One MDB with many users (This may be just one MDB). In this case, the System Administrator
must create the top level elements in the DB. This option is often suitable for small to medium
projects with few DBs and Users.
MDBs for special purposes. i.e., an MDB containing Piping data only for specific work e.g.
Drawing Production.
An MDB may contain up to 1000 databases. All of these databases (known as the current databases) can
be accessed at any time.
Databases can be transferred between current and deferred status at any time, so that a user can replace a
current database by a non-current one to access a particular part of the design.
The Project Databases list shows all the databases in the project which are not in the MDB. The arrow
buttons are used to add and remove databases from the MDB, either as current or deferred, and to
change a database between the current and deferred lists.
An MDB can only contain one database with a given Database number. Two databases will have
the same Database number if one has been created as a copy
Large lists of databases may create performance issues. This can be improved using the Rebuild
Lists On / Off toggle. If this toggle is switched off then the lists are not rebuilt each time a database
is moved; only when using the Apply or the Now button. The default is On.
www.aveva.com
AVEVA Marine (12.1)
8.1 Creating MDBs
From the Admin elements form, select MDBs from the Elements pull down list, now click the Create button.
The Create Multiple Database form appears, Key in

the Name PIPEF and the Description Forward
Area Pipes MDB, select the PIPEF/DESIGN
database from the Project Database section. Select
the down arrow to move the project database into
the Current Databases section.
The listing displayed in the Project Databases

can be sorted by Name, Team, Type, Number,
Access or Description; Filters may also be
applied to limit the selection available.
Control and shift keys can be used to group

database selections before transferring to the
Current Databases list.
www.aveva.com
AVEVA Marine (12.1)
Holding the mouse over the Project Database section right click the mouse button and from the pop up
menu click the Select All DBs. Using the down arrow move the highlighted Project Databases down to the
Current Databases.
All of the Project Databases including foreign

are moved across to the Current Database
section, finally click the Apply button.
This process should be repeated until all the

MDB s for the Project, are created.
8.2 Database Order in the MDB
The order in which the databases are included is very important, the users write access database should be
the first in the list and the rest should follow in the order that they will be accessed. Frequently used
databases should be near the top of the list, also the display in the Design Explorer is controlled by the order
In the containing hull databases

ER1 and one in
the other db named ER2, the system will look for the top level element before storing the model objects).
Similarly for other hull objects e.g. SSOWLD, MOGWLD, etc. The system will look to store the objects below
these world objects regardless of the database order in the MDB.
If the top level elements have not been created, the system may automatically generate them in the
be available in
www.aveva.com
AVEVA Marine (12.1)
The Insert option button is used to position the databases in a specified order. This can be done when
transferring them from the Project Databases list to the Current Database or Deferred Database lists.
The same options can be used when transferring databases from the Current Database list to the Deferred
Database list and visa versa.
For this worked example create a new MDB named ALL with description All Databases copy all the
databases to the new MDB.
Select the ASSEMBLY databases to be re-ordered and defer them
Select Before below the Current Database list, select PIPEF/DESIGN in the Current Database list, the
deferred databases will move above the selected DB when transferred back into the Current Database list.
Exercise 5 - Creating MDBs
Create the following MDBs
Name ALL Description All Databases.

Name CHULL Description Curved Hull Modelling MDB.
Name DBPROMPT Description Hull Top Level Elements.
Name HULLAFT, Description Aft Hull Blocks MDB.
Name HULLFWD Description Fwd Hull Blocks MDB.
Name HULLDES, Description Hull Design MDB.
Name PIPEA, Description Aft Area Pipes MDB.
Name PIPEF, Description Forward Area Pipes MDB.
appear in the Design Explorer after the mdb has been selected when starting an application.
It is advised that only the databases required are added to the MDB, as if too many databases are
added then this could slow the response time.
www.aveva.com
Chapter 9
9 Project Setup Excel Import
Project Setup Excel Import is designed for making the process of setting-up the AVEVA Hull and Outfitting
12.1 projects easier. It allows importing the Admin data via spreadsheets which can be output from and read
into the projects.
For the purposes of this Basic Administration Training we will concentrate just on Project Teams, Users, NT
Authenticated Users, Databases, Included Foreign Databases and MDBs. Extract Databases and Data
Access control is covered on the Advanced System Administration training guide.
The easiest way to get the format on the Project Setup Excel Spreadsheet file is to export the Admin data
and investigate the results.
9.1 Admin Export to Excel
Select Utilities > Export from the Admin main window pull down menu. The AVEVA Hull and Outfitting
12.1.SPx Admin Export form appears, key in the path and Project Setup Excel file name to export data to.
(C:\Temp\Marine_Admin). The file extension will be added automatically.
Alternatively, click the browse button to navigate to the location where Project Setup Excel
Spreadsheet file is to be stored. The Windows Save in form appears, input the Project Setup Excel
Spreadsheet file name and then click the Save button.
Click OK in the Admin Export form to start the export.

www.aveva.com
AVEVA Marine (12.1)
Exporting to Excel window containing performing operations information appears.
Upon finishing exporting, click Dismiss

to exit this window.
9.2 Project Setup Excel Spreadsheet File
The Project Setup Excel Spreadsheet file has a specific format containing the keyword and appropriate
headings.
Navigate to the Project Setup Excel Spreadsheet just created with export utility in Admin module; open it by
double clicking on the file.
The spreadsheet is split down into various tabs for the purposes of this Basic Administration Training we will
concentrate just on Teams, Users, Authenticated Users, Databases, Foreign Includes and MDS. Extracts
and Data Access control is covered on the Advanced Administration Course.
9.2.1 Project Setup Excel Spreadsheet - Teams
Select the Teams Tab
#Keyword TEAM
Name Team Names
Description Team Description
The format of the Spread Sheet is self explanatory as shown on the screen shot.
www.aveva.com
AVEVA Marine (12.1)
9.2.2 Project Setup Excel Spreadsheet - Users
Select the Users Tab:
#Keyword USER
Name
Description
Security Can be a Free or a General user
Password User Password is not exported
Access Rights Access Control Rights are covered in the Advanced System Administration training
guide.
Teams All the Teams that the user is a member of separated by spaces.
If the user name and password are not supplied in excel input form, the system will prompt for them during
the Project Excel Spreadsheet import.
9.2.3 Project Setup Excel Spreadsheet NT Authenticated Users
Select the Authenticated Users Tab:
#Keyword AUTHUSER
Login Name Windows Login Name (must be lower case)
Default user AVEVA Marine Login Name
Other users Any Extra Users for example SYSTEM or DRAFT
As No Authenticated Users have been currently set up in the Project, then this tab will appear
empty.
www.aveva.com
AVEVA Marine (12.1)
9.2.4 Project Setup Excel Spreadsheet Databases
Select the Databases Tab
#Keyword DATABASE
Owning Team Team that owns the Database.
Name Database Name
Description Database Description
Type Database Type (DESI, CATA, PADD, DICT, PROP etc.)
Claim Mode IMPLICIT, EXPLICIT, UPDATE or OVERWRITE, depending on database type and
access mode set
Number Unique Database Number
9.2.5 Project Setup Excel Spreadsheet Included Foreign Databases
Select the Foreign Includes Tab
If the user name and

password are not supplied
in excel input form, the
system will prompt for
them during the Project
Excel Spreadsheet import.
#Keyword FOREIGN
Foreign Project Foreign Project Name for example MDS or MAS
Foreign Name Foreign Database name in the format TEAM/NAME e.g. MASTER/PIPECATA
Foreign User Free User Name in the Foreign Project is not extracted
Foreign Password Free User Password in the Foreign Project is not extracted
www.aveva.com
AVEVA Marine (12.1)
9.2.6 Project Setup Excel Spreadsheet Multiple Databases
Select the MDB Tab
#Keyword MDB
Name MBD Name
Description MDB Description
Databases List of Databases in order, separated by spaces.
9.3 Starting the Excel Import Form
The Project Setup Excel Import is available in AVEVA Hull and Outfitting 12.1.SPx from the Admin main pull
down menu, select Utilities > Import. The AVEVA Hull and Outfitting 12.1.SPx Admin Import form appears,
key in the path and the Project Setup Excel Spreadsheet file name to import. (C:\Temp\Marine_Admin.xls).
Alternatively, click the browse button to navigate to the Project Setup Excel Spreadsheet file to import
The Windows Open form appears, select the Project Setup Excel Spreadsheet file to import and then click
the Open button.
www.aveva.com
AVEVA Marine (12.1)
Click OK in the Admin Import form to start the import.
The AVEVA Marine 12.1.SPx Import from Excel form is now populated with the information from the Project
Setup Excel Spreadsheet.
Key in the User Name and password for any Foreign Projects as the form is displayed
User - SYSTEM
Password XXXXXX
An Opening MDB to use User defined Data form is displayed:
If user defined data is to be used from
selected.
Importing from Excel window containing performing operations information appears. Any Loading Errors or
Warnings will be displayed in this window.
Upon finishing importing, click Dismiss to exit this window.
If you have errors it is possible to execute rollback of the system database to the state before the
load.
www.aveva.com
AVEVA Marine (12.1)
9.4 Admin Database Rollback
The Admin Database can be rolled back following the import from Project Setup Excel Spreadsheet file
Excel Load should there have been errors. Select Utilities > Rollback from the Admin main pull down
menu.
A Rollback form is displayed showing the items that will be deleted.
Click Rollback button.
System will prompt the confirmation window

Perform rollback? for confirming executing
rollback function.
Click Yes.
The Rollback results are displayed in lower

part of Rollback form. Click OK to exit the
window.
www.aveva.com
AVEVA Marine (12.1)
Exercise 6 Project Setup Excel Import
1. Export your Admin elements from the AMA project to a Project Setup Excel Spreadsheet.
2. Modify the spreadsheet adding some new Teams, Users and Databases.
3. Create a new project, AMP using the Project Creation Wizard and import the modified spreadsheet into
the project.
4. Execute the database Rollback. (This illustrates how the project can be reset to immediately before the
file was imported).
5. Import modified spreadsheet into the AMP project.
6. Save Work.
www.aveva.com
Chapter 10
10 Project Replication
In AVEVA Marine (12.1) there are project replication options available to enable user to replicate the whole
project, including all the data, or just the structure of the project.
10.1.1 Replicate Project Data
The Project Data option copies the current project structure and data to a new project. Project directory and
the environment variables for the new project must be set before using the project replicate data option.
A project must not be replicated outside AVEVA Marine (12.1) by copying the whole of the Project
directory to another Project directory. This is because information about the project name is stored
inside the DBs themselves.
Using the Windows Explorer, navigate to the Project folder and, create an AVEVA Marine (12.1) project
folder called AMP. Remember to create the project evars file containing project variables AMP000, AMPPIC,
AMPMAC, AMPDFLTS, AMPDIA, AMPDRG, AMPDWG, AMPMAR, AMPSTE, AMPTPL, AMPINFO and
AMPISO, and to set a call for evarsamp.bat file from evars.bat file.
Delete all the folders form the AMP

Project folder except the
evarsAMP.bat file
Now select Project > Replicate > Project Data.
The Replicate Project form appears, select the AMP project and click the OK button. A confirm form appears
askin Project Training is unlocked. Do you wish to lock the project before
replication? Yes button.
Project locking is covered later in this

course.
www.aveva.com
AVEVA Marine (12.1)
10.1.2 Replicate Project Structure
Replicate Project Structure option creates a macro which can be run into AVEVA Marine 12.1 to replicate
the structure of the current project. No data is copied. When this option is selected, file browser is displayed
to enable modification of the macro file name and path.
Admin scans the System database and outputs to the file all the commands necessary to recreate the
project structure, in the following order: Create users, Create teams, Add users to teams, Create DBs, Make
Copy DBs, Create MDBs, Add DBs to MDBs and make them current if appropriate.
Select Project > Replicate > Project Structure, the Replicate Project Structure form appears click the
Save button.
This macro is often used as the basis for creating new projects. It can be customised by each
company to suit their requirements.
Below is an example of the Replicate Project Structure ma

passwords are not exported. From the Admin module drag and drop the file into the command window.
This file may be edited before

using in the new project, for
modification of User Names and
Passwords, DBs names etc. Any
and correctly configured.
www.aveva.com
AVEVA Marine (12.1)
Exercise 7 Project Replication
1. Create an AVEVA Marine (12.1) Project AMP as a copy of MTP project, using replicate project data
functionality (ensure the evars and projectevars.bat files are correctly configured).
Test that a user can enter the project and confirm that the design data created earlier exist in the
new project.
2. Login to the MTP Project as user SYSTEM and generate replicate project structure macro. Review
the project structure replication macro.
3. Create new project AMT using Project Creation Wizard. Create project AMT structure using the
project structure replication macro generated from MTP project.
The MTP MDU projects. When executing the replication

macro, errors will be displayed if these projects are not installed or are incorrectly referenced from
the evars.bat file and evars<project>.bat files respectively. Errors will also be displayed regarding db
num
4. Set password for the users and test if the users can log into the project AMT, Outfitting module.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 11
11 Hull Top Level Elements
necessary to run the DBP s. In the

example that follows the MDB named DBPROMPT has been created which includes all o
the hull top level elements will be stored.
Start the Log Viewer from All Programs > AVEVA Marine > Design > Marine 12.1.SPx > Hull Log
Viewer. From the menu Admin select DBPrompt.
The CredentialsForm will be displayed, input

the required login information. Select the
Project MTP, Key in the User SYSTEM,
Password XXXXXX and MDB: /HADMIN
The following form is displayed:
To add a the hull top level elements to a DB, select the

DB and right click to display the available options, these
will differ depending on the type of DB selected (DESI or
MANU).
DESI DB options:
MANU DB options:
Click on the element type you wish to create, the following input box is displayed:
Key in the name of the element i.e. A101A, then press Return/Enter
on the keyboard.
www.aveva.com
AVEVA Marine (12.1)
The hull top level elements will be added to the DB, the + sign indicates additional contents within the DB,
selecting the + sign will expand the tree. Selecting sign will close the node.
To delete an element, select the element to delete and click on the right
mouse button. From the menu available, select Delete.
To rename an element, select the element to rename and click on the right
mouse button. From the menu available, select Rename, then key in a new
name and press Return/Enter on the keyboard.
The delete option will be disabled if the element contains hull references e.g. if panels have been added to a
block.
When all top level elements have been created select File > Save.
The top level element structure can be exported ( ) to a csv file which
can be edited using Excel. The file can then be imported ( ) to update
the structure.
Extract of exported file shown below:
The following top level elements should be defined in DESI database

RSOWLD, COMWLD, SSOWLD, HCMWLD, MOGWLD, STDWLD,
BLOCK or HBLWLD, MWLWLD, GRDWLD, ASWL, LINKWL and
FEMWLD.
Only one NSEQ database containing SEQWOR should be available in

the project (per location for Global project).
The following top level elements should be defined in MANU databases,

MOGWLD and MRESTQ.
More detailed information on distribution of hull top level elements and their distribution in the project
are available in the User Guide > Hull in Dabacon > Marine Databases and World Elements.
Please refer to Project Administration (Hull) training manual for hull initialisation, handling surface files,
manufacturing setup and customisation of a project that should follow the creation of hull top level
elements.
Exercise 8 - Creating Hull Top Level Elements
1. Extract dbprompt csv file from MTP project.
2. Add the top level element T, created in Exercise 7,

imported csv file extracted from MTP project. Log into the project as user: SYSTEM in MDB:
/DBPROMPT.
www.aveva.com
Chapter 12
12 Testing the AVEVA Hull and Outfitting 12.1 Access
Log into AVEVA Marine (12.1), Outfitting Design as different users and check that objects can be created,
and objects created by other users in other databases can be seen. This will also test that the user is able to
create Equipment and Pipes in AVEVA Marine (12.1), using multiple users.
The databases created earlier were created with multiwrite access. Databases created with update
access will only allow one writer, so when the user tries to connect to a nozzle that is in a database
that it cannot write to, an Inter database Macro will be created.
12.1 Testing the Access
Testing the access assumes that the users have a knowledge AVEVA Marine (12.1), Equipment and Piping
modules, if this is not the case the trainer will help with the creation of the elements required.
Start AVEVA Marine (12.1) in the Outfitting application.
Now from the AVEVA Marine Login

form, select the Project ShipAMA,
Username PIPEF, the Password
PIPEF, set the MDB to PIPEF
From the Design pull down on the main

menu select Equipment, this changes
the module to the Equipment module.
Firstly create a SITE PIPEF/DESIGN, from the main Pull down menu
select Create > Site
Now using the Design Explorer navigate to the SITE

PIPEF/DESIGN, create a ZONE TEST_PIPEF. Add two pieces
of simple equipment EQUI1 and EQUI2 to the ZONE each
containing at least one Nozzle.
A macro file Test_Pipe.txt is available for those not familiar

with creating equipment. Navigate to the SITE
PIPEF/DESIGN and drag the datal into the command
Window.
Finally click Design >

Save Work and then
Design > Exit. www.aveva.com
AVEVA Marine (12.1)
Start a new session this time when the AVEVA

MARINE Login form appears, select the
Username PIPEA, the Password PIPEA, set
the MDB to PIPEA and the Module to
Outfitting
From the Design pull down on the main menu

select Pipework, this changes the module to
the Pipework module.
Create a new SITE PIPEA/DESIGN, from the main Pull down menu select
Create > Site
Now using the Design Explorer navigate to the SITE

PIPEA/DESIGN, create a ZONE TEST_PIPEA main Pull down
menu select Create > Zone
Create a single pipeline PIPE01 to the ZONE that connects the two Nozzles from EQUI1 and EQUI2 using
the specification SP/DR07C as shown below.
Using the Design Explorer bring in the two previously created equipment elements EQUI1 and EQUI2 into
the 3D graphical display, now navigate to the newly created Zone TEST_PIPEA. From the Pipework
Toolbar, select the Show pipe creation from icon.
The Create Pipe form is displayed, Key in the Pipe Name PIPE01, select the
required pipe specification SP/DR07C, select the Bore 150mm and then
click the Apply button. The newly created pipe now is displayed in the
Design Explorer, select the BRAN PIPE01/B1.
www.aveva.com
AVEVA Marine (12.1)
The Create Pipe form has now changed to Modify Pipe, from the Head
Connections section of the form click the Change button. The form changes
again, from the Connect Branch Head to: section click the Pick button.
The user is now prompted to identify element to connect to, select NOZZLE /N1 from EQUI1 in the graphical
display.
The connection is displayed in the graphical view, click the Connect button. Repeat this operation to
connect the tail to NOZZLE /N2 of EQUI2
This has connected now connected both the Head and Tail, the Connection code for each is currently FBN,
this needs to be changed to GBP so that the Flanges can be connected with the correct gasket.
From the Modify Pipe form, click the Change button from the Head Detail section of the form, the form
changes. Now from the Modify Branch Head section change the connection to GBP and then click the
Apply button. Repeat this operation to change the Tail connection type to GBN
www.aveva.com
AVEVA Marine (12.1)
Now from the Pipework Toolbar, select the Show pipe component creation form icon. The Component
Creation form is displayed, from the Component Types list select Flange.
The form changes to display all the flange options, select FLSO and then click the Connect button. The
flange is created, using the Design Explorer navigate back to the BRAN PIPE01/B1 element and create
another flange but this time check the Against Flow icon on the form.
The two flanges have now been created, now click the dotted line connecting the two flanges in the
graphical display, and then select the Model Editor icon.
www.aveva.com
AVEVA Marine (12.1)
The Model editor handles are shown, select the up handle and drag this 1000.00mm in the Z direction, then
select the X arrow and hold this over the End arrow on the EQUI2 element and press the right mouse button
and select Complete from the context sensitive menu.
Turn off the Model Editor and the pipe should look as below.
Select from the main pull down menu select Display > Command Window.
Select the Design > Save Work
An Inter database macro will have been created as the

Pipe is in a different database to the equipment
Exercise 9 - Testing AVEVA Marine (12.1) Access
1. Test that two Equipments and Pipes can be created in the Design modules for PIPEF and PIPEA
MDB similar to what has been shown above.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 13
13 References between Databases
Here we explain the relationship between databases and the use of Inter database connection macros.
HREF of Branch
points to CREF of Nozz
Design DB
PIPEF
Design DB
PIPEA CREF of Nozz
Points to HREF of
BRAN
When the user connects Branches the system sets the Head Reference (HREF) or the Tail Reference
(TREF) to the Item it is connected to, i.e. a Nozzle or a Tee Name.
It also sets the Connection Reference (CREF) of that item to point at the Branch that has been connected.
If the user has write access to the connected component it just connects and sets the relevant connection
references. If the user does not have write access an Inter-database connection macro is created.
13.1 Checking Inter-DB Macros
By default the user can only see Inter-DB Macros in the Monitor application.
Start a new session in Monitor this time when the

AVEVA MARINE Login form appears, select the
Username PIPEF, the Password PIPEF, set the MDB
to PIPEF
The Monitor form appears in the Monitor application. At the

bottom of the Monitor form the is a message informing the
user You have Inter-DB Macros to run
www.aveva.com
AVEVA Marine (12.1)
13.1.1 Finding the Names of the Inter-DB Macros
To find out the names of the Inter-DB Macros to run, select Project > Inter-DB Macros . The Inter DB
Macro form appears, displaying a list of the macros to run. The user needs to make a note of the macro
name and then needs to enter Outfitting.
As shown, the user has one Inter-DB Macro to run. The user should make a note of the name and then
enter the Design module. Select Monitor > Modules > Outfitting
13.1.2 Checking that the Nozzle CREF is not Set
Before the user runs the Inter-DB macro they should go to one of the Nozzles they created earlier and query
the CREF. The CREF should be Unset (=0/0).
Using the Design Explorer navigate to one the Nozzle, click the right mouse button and from the pop up
menu select Show Attributes. The Attribute form is displayed showing that the Cref attribute is unset.
13.2 Running the Inter-DB Macros
he Inter-DB Macros are run via the command line. Select Display > Command Line from the main pull
down menu. The Command Window is displayed, in the Command Window key in the Inter-DB Macro to run
i.e. $M/%AMAMAC%/ama001.mac
The Cref attribute of both Nozzles will now have been set.
The variable %AMAMAC% points to the Inter-DB Macros

directory that was set up earlier, when project was created.
www.aveva.com
AVEVA Marine (12.1)
13.3 Deleting Inter-DB Macros
Once the Inter-DB Macros have been run in the Outfitting application, they can be deleted. From the main
pull down menu select Design > Monitor. The monitor module is now active, select Project > Inter-DB
Macros . The Inter DB Macro form appears, displaying a list of the macros. Select the macro then click the
Delete Macro button.
A Confirm form kay to delete macro number 1 Yes button. The Inter-
DB Macros are removed from the list.
Exercise 10 - Running Inter-DB Macros
1. Run and Delete the Inter-DB Macro that was created in the previous Exercise.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 14
14 NT Authentication
NT Authentication is used by system administrators to allocate a Windows Login User to AVEVA Hull and
Outfitting 12.1.SPx
14.1 Setting up NT Authentication
It is advised to make a copy of the system database before setting up NT Authentication
From the Project drop down menu in the Admin Module, select Project > NT Authentication . A Confirm
form Are you sure you wish to switch NT Authentication ON project wide
click the Yes button.
Once the NT Authentication is activated, the NT Authenticated Users are available from the Admin
elements pull down. Click the Create button.
The windows login username can be

checked at any time using
<Ctrl><Alt><Del>
www.aveva.com
AVEVA Marine (12.1)
The NT Authentication User Creation form appears, key in the (Windows User) Name first.last, this will
always be in lowercase. From the Project Users section select the users to be added to the Authenticated
Users section, use the arrow to move the users across. Finally make sure that the default user is set to
HULLDES and then click the Apply button.
Because the system
Administrator normally
sets NT Authentication,
the SYSTEM user should
also be added to the
Authenticated Users.
Exit the application by selecting Admin > Exit.
14.2 Testing the NT Authentication
When the user next enters AVEVA Hull and Outfitting 12.1.SPx application they will see the default user will
be SYSTEM. Use the Username pull down menu to select HULLDES, the word Password will be greyed
out and the input box will be inactive. Select the Module Admin and Click the OK button.
If the Username pull down menu is

selected the user will only see the user
names allocated to the current Windows
Login.
Free Users like SYSTEM will

always require a Password to be
keyed in.
If the Administrator has incorrectly set up the NT Authentication, it is possible to get back into the
system from Monitor in the Command Window by keying in.
DEV TTY (DEV = Devise and must be TTY mode)
USER SYSTEM/XXXXXX (Free User / Password)
DEV GRA (GRA = Graphics)
ADMIN (Restarts the Admin Module)
Exercise 11 - NT Authentication
1. Switch on NT Authentication on AMA project and create NT Authenticated users as described above
but using your own windows user name. Test that AVEVA Hull and Outfitting 12.1.SPx can still be
accessed.
Remember to make a copy of the system database (amasys) before you start. www.aveva.com
Chapter 15
15 Sharing AVEVA Hull and Outfitting 12.1.SPx Projects and Files
This chapter explains how AVEVA Hull and Outfitting 12.1.SPx projects can be shared across a network for
multi-user access.
15.1 Sharing Files
Once a project has been configured on the Database Server a number of steps should be taken to allow
users access to the project.
On the Database Server we must share the project directory to allow network users to access the project.
Navigate to the project folder using Computer (this will vary depending on the operating system being used,
the example given is for Windows 7). Right click on the project folder and go to Properties.
On the Sharing tab click Advanced Sharing
Ensure the Share this folder tick box is checked.
Share name AVEVA and click the Permissions button.
www.aveva.com
AVEVA Marine (12.1)
The Permissions for AVEVA form appears.
Select Everyone from the Group and user names

section, and Allow Full Control
Click the Apply button, then click the OK button to close

the Permissions form.
Now click OK to close the Properties from.
The user will now be able to browse to the AVEVA directory via Computer.
UNC (Universal Naming Convention) paths are recommended for locating the project server.
In the example shown above the machine name has been used, instead the IP address could have been
given. i.e. \\193.168.10.125\AVEVA.
Any references to the project location in the project evars.bat file should be set using the UNC path.
The D065 file in the <project>mar folder should also be updated with the new paths.
www.aveva.com
AVEVA Marine (12.1)
15.2 Cache Manager
If MSMQ was enabled at installation the Caching Manager will be available from the Start > All Programs
> AVEVA > Aveva Database Cache Service > Cache Manager. This AVEVA Cache Service
Configuration form is displayed:
If the cache service is installed and running, the Marine applications Outfitting, Outfitting Draft, Hull Design,
Marine Drafting, and the Marine utilities programs, for example sf*.exe will connect to the cache service
and all database pages that are read across the network will be cached locally for the next access.
The purpose of this user interface is to check on the current status of the cache service, and to allow users
of a machine to manage the service with particular emphasis on the local disk storage used by the cache
service.
Cache Path: Allows the user to change the location of the cache folder. A new folder will be created and
the contents of the old folder will be left intact.
Stop caching threshold: Allows the user to set maximum disk usage percentage used by the cache
service. If the usage exceeds this then the cache service will not write any new cache data to the disk.
Current cache disk usage: Shows the percentage of the allocated cache currently being used.
Purge unused caches after: The number of days after which cached projects that have not been accessed
will be automatically deleted. A setting of 0 indicates purging of unused cache is inactive and will not be
purged.
If any of the settings have been changed the Reset and Save buttons will become active. Reset can only
be used if the changes have not been saved, Save will save the current settings.
Delete: Delete selected cached projects shown in the Cache Storage control window
from the cache folder on your local disk.
Cache Service Control allows the user to activate, de-activate or reset the service.
(This is not a full service restart).
www.aveva.com
AVEVA Marine (12.1)
15.3 Creating Shortcuts
Short cuts to all application groups will be installed to the desktop during installation if checked during setup.
If this option was not selected then navigate to C:\ProgramData\Microsoft\Windows\Start

Menu\Programs\AVEVA Marine\Design\Marine12.1.SPx
As an example select the Hull Design shortcut, click the right mouse button and select Copy, Navigate to
the Windows Desktop and click the right mouse button again, from the pop up menu select Paste. The icon
can be used to start the Hull Design application directly.
15.4 Change Start in Directory
Right click on the shortcut and select Properties,
Modify the Start in folder to C:\Temp. This is the folder that

AVEVA Hull and Outfitting 12.1.SPx will place some of the output
files. It should not be left as the AVEVA Marine (12.1) executables
folder.
www.aveva.com
AVEVA Marine (12.1)
15.5 Shortcut Arguments
Where a user will log into one area of a specific project, additional arguments may be set, allowing the user
to access the project without the need to enter the Login screen.
In the following example the marine application will be started in

the project AMA, user HULLDES, password HULLDES, mdb
HULLDES, module HullDesign
In the Target path key in

C:\AVEVA\Marine\OH12.1.SPx\marine.bat AMA
HULLDES/HULLDES /HULLDES
The correct installation folder address must given, replace

OH12.1.SPx with your version number.
If the user wants to use the Integrate Engineering and

Schematics option then the following could be used
C:\AVEVA\Marine\OH12.1.SP2\marine.bat MTP
SYSTEM/XXXXXX /EQUIPMENTFWD Outfitting -
Integratedmode True -noconsole
-noconsole, the console window will no longer be

displayed on startup
Exercise 12 - Creating Desktop Shortcut
1. Create a shortcut on the desktop to Marine.bat
2. Add arguments to access project AMA in the PIPEF MDB in Outfitting application with Integrate
Engineering and Schematics option on
3. Rename the shortcut to AMA-PIPEF
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 16
16 Project Administration
This chapter is an overview of the options on the Admin menu. Some of the simpler options are described in
full, and some of them have references to other chapters, where they are described in more detail.
16.1 Locking the Project Database
Project databases can be locked to prevent users from entering the project until the project is unlocked.
Locking has no effect on users already accessing a project.
To lock the project databases, from pull down menu select Project > Locking .
Locking the project may be necessary for various reasons, e.g. to allow a release
of newly approved data or to incorporate new versions of the AVEVA Hull and
Outfitting 12.1.SPx module.
The administrator should always Lock the project before carrying out database modifications
16.2 Options under the Admin Menu
The options under the Admin menu are similar to corresponding options in other AVEVA Hull and Outfitting
12.1.1 modules.
Selecting Admin > Save Work will save all changes to the System databases.
Selecting Admin > Get work Will refresh the view of the System databases.
Selecting Admin > Session Comment will display the

Session Comment form. The administrator can enter a text
string to identify the changes made in their current session. The
administrator can see details of previous sessions by using the -,
Current or + buttons on the form to move through the sessions.
Selecting Admin > Modules displays a submenu from which the administrator can select the module they
wish to switch to. Switching to another module is available only if a MDB has been set on the Login form
when entering the Admin module.
Selecting Admin > Exit will save changes to the System database and exit from AVEVA Marine (12.1)
Admin module.
The administrator cannot QUIT (exit without saving changes) from Admin. This is to ensure that
there are no inconsistencies between the actual database files and the record of the databases in
the Project stored in the System database
www.aveva.com
AVEVA Marine (12.1)
16.3 Abnormal Exits
If the user exits abnormally from Admin module, i.e. because of a power failure or system crash, then the
database files in the operating system should be listed to see the files with a deleted extension. When the
user does any task that involves deleting a database file in Admin, AVEVA Hull and Outfitting 12.1.SPx
copies the file to be deleted to a new file with the deleted extension.
When the user clicks Save Work or Exit, the deleted files are removed. If there is a problem which results
in database files being deleted, and an exit occurs before the System database can be updated with the
changes, AVEVA Hull and Outfitting 12.1.SPx will rename the deleted files by removing the file extension,
so that the files will still be available.
16.4 Display Menu
Admin Elements will display the Admin Elements form, if it has been closed.
Command Window will display the Command Window.
Admin Explorer will display the Admin Explorer tree.
Global Explorer will display the Global Explorer (only valid in Global projects).
My Data will display the My Data form.
Reference List will display the Reference List.
Attributes will display the Attributes Form.
Search will display the Search input form.
Search Results will display a form showing the results of the last search.
16.5 The Query Options
The options under Query > Project on the main

menu allow the administrator to query information
about the current user, and list information about any
Team, User, Database, MDB etc.
16.5.1 User Status Form
Select Query > Project > User Status displays

the User Status form.
This form displays the following information about

the user sessions currently in the project.
Real Name, User, Login ID, Mdb Selected,

Module, PDMS ID (the id of the process in which
AVEVA Hull and Outfitting 12.1.SPx is running),
Hostname, Date/Time in:
The scrolling DB Mode Status list has three

columns. It shows a list of the Databases in the
current MDB (if there is one). The Mode of the
Database shows the RW access rights of the
user and the Status of the Database shows the
way the User is actually accessing the Database.
www.aveva.com
AVEVA Marine (12.1)
16.5.2 User List Form
Select Query > Project > Users displays the User List form. This form displays a list of all the users who
have been created in the project.
For the user selected in the Users list, the form

displays:
Description
Privilege (General or Free)
Teams to which the user belongs.
16.6 Team List Form
Select Query > Project > Teams displays

the Team List form. This form displays a list of
all the teams in the project. For the team
selected in the list, the form displays a list of
users who are members of that team, and
which databases the team owns.
16.7 Database List Form
Select Query > Project > DBs displays

the Database List form. This form
displays a list of all the databases which
exist in a project at a selected location.
The Sort Databases options either sort

the databases into Alphabetic order or
By Hierarchy.
For each database selected, the form will

display:
Description
Team that owns the database
Type
Number
Size
Access
Source (local or foreign)
MDB List showing which MDBs the database is in.
www.aveva.com
AVEVA Marine (12.1)
16.7.1 DB Session Form
Select Query > Project> Database Sessions on the main Admin menu bar. Select the database to query
from the Database List. Select the session to
view from the Sessions list.
On entry to the form, the Sessions list displays

the 15 most recent sessions. To view details of
older sessions, select a date using the drop-
down Day/Month/Year lists, then click Search
Date. The 15 sessions previous to the selected
date are then displayed.
If the administrator wishes to view more than a

set of 15 sessions at a time, the Display
Previous Sessions list can be used to select
either 25 or 50 sessions instead.
A right-mouse button menu is available from the Search Date menu, from which the administrator can select
Today, which will set the search date to the today's date, and Session, which will set the search date to the
date of the session selected on the Sessions list.
If there are more sessions on the selected date than the Sessions list is set to display, the administrator will
be asked whether they wish to view the first set of these sessions, or all of them. If they choose to view them
all, it may take some time to display.
The up and down arrows next to the Display Previous Sessions list are used to browse to the next or
previous set of sessions.
16.7.2 MDB List Form
Select Query > Project > MDBs displays the

List MDBs form. This form displays a list of all
MDBs which have been created in the project.
For each MDB selected the form will display its
current and deferred database lists.
16.7.3 Stamp List Form
Select Query > Project > Stamps displays

the Stamp List form. This form displays a list of
all the Stamps in the project. For each Stamp
selected, the form will display the Date of the
Stamp and a Database List of all databases in
the Stamp, including their session numbers.
www.aveva.com
AVEVA Marine (12.1)
16.7.4 Data Access Control Audit Form
The Data Access Control Audit form is displayed when the administrator select Query > Project > Data
Access Control on the main Admin menu bar.
This form gives details of all the Data Access elements in the Project (all Roles, Scopes, ACRs and ACR
Groups).
The administrator can select the type of element they want to list from the DAC Element Type on the right
of the form. All the elements of that type will be shown in the DAC Element Type list. The administrator
selects the one they want, and AVEVA Hull and Outfitting 12.1.SPx will navigate to its details in the main
Audit window.
The report is regenerated each time the form is displayed. To regenerate the report without re-displaying the
form, click the Create Audit button.
16.7.5 Database Sets Report Form
The Database Sets Report form is

displayed when the administrator select
Query > Project > Database Sets on
the main Admin menu bar. This form
gives details of all the Database Sets in
the Project.
The Navigate to DB Set list on the right

of the form lists all the DB Sets in the
project. The administrator selects the one
they want, and AVEVA Hull and Outfitting
12.1.SPx will navigate to its details in the
window on the right of the form.
The report is regenerated each time the form is displayed. To regenerate the report without re-displaying the
form, click the Update Report button.
www.aveva.com
AVEVA Marine (12.1)
16.8 The Settings Options
The Settings > Display Mode options allow the administrator to modify, save and restore the display of the
Admin Elements form.
The Settings > Change Password option, allows the administrator to set whether or not users can
change their passwords. If the administrator selects Enabled, the users will see a Change Password option
on the menu of the main AVEVA MARINE Login form, which will allow them to change their passwords.
Otherwise, a password can only be changed within the Admin Module.
The DB Number Range option, allows the user to define a range of database numbers to be used in the
current project, the next available number will automatically be assigned during databases creation when the
Unique button is selected on the database form.
16.9 The Utilities Options
The Export, Import and Rollback were discussed earlier in Chapter 9.
16.9.1 Integrity Checker Option
This option displays the Data Integrity Check form. The AVEVA Hull and Outfitting 12.1.SPx Data Integrity
Checker (DICE) is discussed later in the course.
www.aveva.com
AVEVA Marine (12.1)
16.9.2 Sending Message
The administrator can send messages to other users by

selecting Utilities > Send Message . Send Message form
will be displayed.
The administrator can select to send a message either to
an individual user, all members of a specified team or all
active project users.
The message will be displayed only to users already in

AVEVA Hull and Outfitting 12.1.SPx when the command is
given, and then only when they change modules or leave
AVEVA Hull and Outfitting 12.1.SPx
The Administrator can list messages. Once it has been

displayed, the message is automatically deleted.
Messages are only displayed in System Command

Window and could easily be missed. This is an old
feature; better option may be to use e-mail.
16.10 The Project Options
16.10.1 Project Information
The administrator can add descriptive information about the Project by selecting Project > Information
from the Main Menu. The Project Information form will be displayed.
The administrator can set the Name, Description,

Message and Maximum Number of Users.
The maximum numbers of characters for Name,
Description and Message is 119. For Maximum
Number of Users, maximum numbers of characters is
16.
If set, these details can be displayed each time the

AVEVA Hull and Outfitting 12.1.SPx project is
accessed. They can be reset in Admin module at any
time.
The effects of setting the project information can be seen if you switch to the Monitor module. It can also be
viewed by querying the project information from the Command Window by keying in Q PROJ or Q PROJ
Num.
www.aveva.com
AVEVA Marine (12.1)
16.10.2 Font Families
The System database stores details of four font families, numbered 1-4. These families are defined using
Admin itself or the commands can be included in the makemac.mac macro which is called during the project
creation process by the Project Creation Wizard. All four families are used by Outfitting Draft, but only the
first is used by the other graphical modules.
All AVEVA Marine (12.1) font files have the suffix .gfb.
16.10.2.1 Introduction to Font Families
A font family combines a character set with a character style.
16.10.2.2 Character sets
A character set is specified by name or by an AVEVA Marine (12.1) code number derived from its
International Registration (ISO-IR) number or from its ISO 8859 part number. The available character sets
are:
Name Code Description

Latin 1 885901 ISO 8859-1 Latin alphabet No. 1
Latin 2 885902 ISO 8859-2 Latin alphabet No. 2
Latin Cyrillic 885905 ISO 8859-5 Latin/Cyrillic alphabet
UK 4 Standard UK ASCII (ISO 646 Reg 4)
US 6 Standard US ASCII (ISO 646 Reg 6)
Greek 18 ISO 2375 Registration 18
Cyrillic 37 ISO 2375 Registration 37
The ISO 8859 sets contain all the characters of the standard US ASCII set plus ranges of extra punctuation
marks, symbols, accents, accented characters, and combined characters.
Latin-1 provides additional characters for the following languages:

Danish, Dutch, Faroese, Finnish, French, Icelandic, Irish, Spanish, German, Norwegian, Portuguese,
Swedish, Italian
Latin-2 provides additional characters for the following languages:

Albanian, Czech, German, Hungarian, Polish, Rumanian, Serbian, Croatian, Slovak, Slovene
Latin/Cyrillic provides additional characters for the following languages:

Bulgarian, Byelorussian, Macedonian, Serbian, Ukrainian, Russian
16.10.2.3 Character Styles
The character styles are also specified by name or code number. The available styles are:
Name Code
Line 1
Block 2
Serif 3
Italic 4
Script 5
Typewriter 6
UWLine 7 (Uniform Width Line)
Styles 1 to 5 are proportionally spaced i.e. the spacing of the characters varies depending on the characters.
Styles 6 and 7 have fixed spacing and are better for the construction of lists or tables where items must line
up vertically.
Not all styles are available for every character set. An error will be output if a specified combination is not
available. www.aveva.com
AVEVA Marine (12.1)
16.10.2.4 User-Defined Fonts
A font family may also be defined by two user-supplied font files. One file is used to define the standard
character set and the second (optional) file to define a bold version of it. These user-supplied files must be in
AVEVA Hull and Outfitting 12.1.SPx font-file format and have the suffix .gfb. AutoCAD character shape files
(.shp format) can be converted to .gfb format using the Font Converter supplied as part of the AVEVA
Marine (12.1) Software Developer's Kit.
For details contact your local AVEVA Support office
16.10.2.5 Sloping Fonts
For each font family, the administrator can define an angle of slope between -85 and +85 degrees inclusive.
This will cause the text to be sloped forwards (positive angles) or backwards (negative angles).
16.10.2.6 Setting up Font Families
Select Project > Font Families from the main menu and the Font Family form will be displayed.
The Font Directory sets the directory where the font

files are stored.
The Current Font Settings show the four fonts that are
available. It shows whether they are System-defined or
User-defined, the character set (Type) and style.
The administrator can change the definition of the font

selected in the list by changing the settings on the rest
of the form.
16.10.3 True Type Fonts
True Type fonts are only available if they are present on each workstation running AVEVA Marine (12.1) and
are registered in the project's SYSTEM database. To add additional true type fonts select Project > True
Type fonts , the True Type fonts configuration file appears, click the Add button.
www.aveva.com
AVEVA Marine (12.1)
The windows Font form appears, select the Font, Font

style and Size then click the OK button.
The True Type font details form appears click the OK

button.
Font ID is automatically allocated by the

System
The True Type fonts configuration form appears

again continue to add additional fonts if required
and then click the Dismiss button.
If all installed fonts are not displayed for
selection in Windows 7 it will be necessary
tings
form.
The default font to be used by Marine Drafting and

set in the Marine Drafting default file should be
assigned in the True Type fonts configuration. The font number used should be assigned as the font type in
the Dept and Regi attributes. This will automatically cascade to any drawing created in these Dept and Regi
Outfitting Draft).
True Type Fonts added to the System Database can now be used in Outfitting Draft and Marine Drafting.
Once the user starts the Outfitting Draft module, they need to create a new Dept, Regi, Drwg and Sheet to
use the True Type Font, then select Draft > Administration, then Draft > Label Libraries. Navigate to a
TXTM element in the Draft Explorer then select Modify > Text Template > Attributes .
www.aveva.com
The Text Template Attributes form appears, from the Font pull down list choose * Select a True Type Font.
AVEVA Marine (12.1)
The True Type font selection form appears, select the True Type font to use and click the OK button.
True Type Fonts & AVEVA Marine (12.1) Fonts cannot be

mixed on the same sheet; this includes backing sheets &
symbols.
AVEVA Marine (12.1) plot file format has not been extended
to handle True Type Fonts, such character strings will be
omitted, but new output formats (incl. PDF) are being
provided.
Support for AVEVA Marine (12.1) fonts will be withdrawn at

some stage in the future. However, AVEVA will provide an
upgrade capability to allow it to happen.
There is now a Marine System font available that is delivered with the
installation; this can be added using the True Type fonts
configuration.
Exercise 13 - True Type Fonts
1. Allocate several different True Type Fonts in Admin, for usage on the project. Check that these fonts
are available for use in the drafting applications.
16.10.4 Module Definition
The modules are set up in the supplied product, and user will not normally need to create or edit module
definitions in order to run AVEVA Hull and Outfitting 12.1.SPx The only part of the definition the user may
wish to change is the initialisation macro (imacro), which runs on entry to the module. The initialisation
macro contains module-specific commands to set up the screen display, including loading application
macros.
16.10.4.1 How Modules are Defined
Each Module has an entry in the System database, which consists of the Module command followed by
commands to specify the following:
The security for the module;

The runfile i.e. the program that is executed.
The initialisation macro (imacro), which runs on entry to the module
The Read / Write access to database types. i.e. Design needs Write access to Design
database, but Read access to Catalogue databases
General modules can be accessed by General Users. This option is not normally used now.
Unrestricted modules should be set to Free. Restricted modules can only be accessed by Free
User. Free modules can be accessed by any User
www.aveva.com
AVEVA Marine (12.1)
16.10.4.2 The Module Definition Form
The Module Definition form is displayed when the administrator selects Project > Module Definitions
from the main Admin menu bar. This form is used to create and edit modules definitions for the current
Project.
The Modules section lists the AVEVA Hull and Outfitting 12.1.SPx Modules.
The Sort by pull down list controls the order of modules

displayed in the list.
The Copy button displays the Copy Module form. This

form is used to create new Modules by copying existing
module definitions. It allows the administrator to specify
the Number and Name of the new Module.
The Delete button deletes a Module definition from the

Project. The administrator will no longer be able to use
the Module in the current Project, unless they re-define
it.
The Settings section displays the settings for the

Module selected from the modules List. All of the
settings can be changed except the Number and Name.
Security:General: Modules can be accessed by

General users.Restricted: Modules can only be
accessed by Free users.Free: Modules can be accessed
by any user.
Runfile sets the file used to start up the Module. The defaults are supplied in the %PDMSEXE% directory.
Imacro sets the file used to start up the GUI for the Module. Typical value as used in the Design Module
would be %PDMSUI%/DES/ADMIN/START. The Advanced Settings button displays the Advanced Module
Settings form. This form is used to set the buffer size, the default database type and access for the Module.
Changing options on this form may cause serious problems in usage of AVEVA Hull and Outfitting
12.1.SPx Only system administration experts are supposed to use this form.
16.10.4.3 Setting the Dabacon Buffer Size
Each module definition in the System DB may include a Buffer size definition
that specifies how much space is to be reserved for the DABACON Buffer in
each module.
It also allows the database administrator to optimise computer efficiency in

some of the more heavily used modules by trading off Central Processing Unit
(CPU) usage against disc Input / Output (I/O).
Information on buffer size is available in AVEVA User Guides,

Administration > User Guide > Modules > Setting the DABACON
Buffer Size
It is useful if some system users are able to change items in the catalogue
database whist remaining in Design. Changing the access to the catalogue
from Read Only to Read/Write enables the system user to do so.
www.aveva.com
AVEVA Marine (12.1)
To change the access settings for the Catalogue, Select the Outfitting Module and click the Advanced
Settings button. The Advanced Module Setting form appears, using the catalogue pull down list select
Read/Write and then click the Apply button. Click the Dismiss button to close the form.
Remember that the user must be a member of the TEAM that owns the database to have read/write
access.
16.10.5 Marine Environment Variables
Select Project > Marine environment setup , the Marine environment setup form appears. The Marine
environment variables are automatically generated by the Project Creation Wizard, from the nominated
template project. They can be changed by the
administrator to suit the individual shipyards
requirements.
16.11 Deleting Phantom Users / Claim Lists
From time to time a user may exit from AVEVA Hull and Outfitting 12.1.SPx abnormally e.g. if there is
machine failure or if a system fault occurs. An abnormal exit may leave phantom users in AVEVA Hull and
Outfitting 12.1.SPx
The Project > Expunge > All Users option will remove all phantom
users from the system. The administrator will be prompted to confirm
that this is what they want to do.
The Project Expunge > User Processes option will display the Expunge User Process form. The current
process is shown by an asterisk.
Select the user process to be expunged, click the

Expunge button to expunge the selected user process.
Exit the form by clicking the Dismiss button.
Admin will not allow the Current User to be

expunged.
www.aveva.com
AVEVA Marine (12.1)
The Project > Expunge > Claimlist option will display the Expunge Database Claimlists form.
Select the database(s) to unclaim

elements, click the Expunge button
to unclaim elements in the selected
database(s).
Exit the form by clicking the

Dismiss button.
16.12 The Data Options
The Data options on the main menu are Change Management, Inter DB Macros and Extract Database
Control.
16.12.1 Change Management
The Data > Change Management option is used to

Merge Changes and Backtrack Changes in the AVEVA
Hull and Outfitting sessions.
16.12.1.1 Merging Sessions
AVEVA Hull and Outfitting 12.1.SPx sessions enable

recording a history of changes to the database. When a
new session is made, changed data is appended at the
end of the database file. Appending updated data to
database files increases the disk space requirements. If
the history information is not required, in order to save
disk space, database(s) can be compacted by merging
sessions. It can be specified that the changes before or
after a given date or session number will be merged.
i.e. If there is a session, which corresponds to a project

milestone that needs to be kept, the administrator can
merge the sessions around this. In other cases, it may
be that all sessions before a given date or within a
given week need to be merged. Merging the database
sessions has no effect on any database references into
that database from other databases.
To merge sessions select Data > Change

Management > Merge Changes from the main
Admin menu. The Merge Changes form will be
displayed. It is possible to merge the changes to All
Project databases, the System databases, or the Single
database selected in the list.
Comments can be added to sessions from the modelling applications using the command window
www.aveva.com
AVEVA Marine (12.1)
If All Project databases option is selected, changes can be merged for the
period before or after a given time, date or session number.
If System Database option is selected, changes before or after a given time,

date or session number can be merged.
If Single database option is selected, a database from the list is to be selected.
Log into the ADMIN as system user

in the MTP project.
Select Single Database

HULLDRAFTFWD/HULLFWDPADD1
from the list.
The Database Sessions button is

now available. Click the Database
Sessions button. The Database
Sessions form appears displaying all
sessions which have not been
merged.
Click the Dismiss button to leave the

form.
From the Merge changes form click the Apply button, and then click the Database Sessions button again.
As shown, all the sessions have been merged and the database size will have been reduced.
Normal procedure is to do database merge after creating a project archive.
The Command window can be opened during the merging of

sessions to give additional information regarding the results of
merging.
The Rebuild list button is used to update the list of databases. I.e. if a new database has been
created while the form is displayed, the list will not be updated until the form is closed and re-
displayed, or the Rebuild list button is clicked.
www.aveva.com
AVEVA Marine (12.1)
16.12.1.2 Backtrack Sessions.
A database can be returned to the state it was in at a previous session using the Data > Change
Management > Backtrack Changes option on the main Admin menu. The Backtrack Changes form will
be displayed.
Select the database from the list. Backtrack changes can be executed by specifying a time, date or session
number.
Subsequent sessions will be lost, and so you may wish to

copy the database before backtracking. You can backtrack to
the date or session number required.
Note that if a database has been upgraded after the
nominated session it will be necessary to upgrade the
database again.
The Rebuild list button is used to update the list of databases. I.e. if a
new database has been created while the form is displayed, the list
will not be updated until the form is closed and re-displayed, or the
Rebuild list button is clicked.
From the Backtrack Changes form select the Database

DRAFT/MIDPADD. An example can be seen in the screen shot
showing the database is up to Session Number 23. Changes can be
backtracked to any session above Session Number 2 because
Session Number 2 is required as this is the Database Creation
Session. Click More button to see the session details.
The DB Session number may differ from those shown in the

screen shots due to previous merging of sessions.
The Session Number field is used to set the session to backtrack to, 18. Click the Apply button. As shown
on the Database Session Form, a new Session, session 24 has been created which is a copy of session 18.
Backtrack can only be performed on the command line as described later on. www.aveva.com
AVEVA Marine (12.1)
The GUI does not actually do a physical backtrack. It performs revert i.e. the latest session is a copy of a
previous session.
To illustrate this we will now enter

AVEVA Hull and Outfitting 12.1.SPx in
the Training project as user DHULL in
the STRUCDESIGN mdb, using the
HullDesign application. Display the
Draft Explorer (View > Explorers >
Draft Explorer). Create a new drawing
named BACKTRACK. Save the
drawing then Save and Unclaim and
exit. Log into Admin, backtrack the
database
HULLDRAFTFWD/HULLFWDDPADD1 to the previous session. Then log in to the project again and view
the drawing list. The drawings can be retrieved by Backtracking the database back to the previous session.
Backtrack changes can be done by specifying a time, date or session number
16.12.2 Backtracking the Databases (Command Window)
As previously stated, the AVEVA Hull and Outfitting 12.1.SPx GUI performs revert and not a physical
backtrack. The only way of performing physical backtrack is to use the command Window.
The administrator should not use the Backtrack Command as data will be deleted; this command
will be used during the Reconfigure Same ref process which is discussed later
Example backtracks on the Command Window.
BACKTRACK PIPEF/DESIGN SESS 2
16.12.3 Inter-DB Macros
Inter-DB macros can be displayed by selecting Data > Inter-db Macros from the main Admin menu. The
Inter-Database Macros form will be displayed.
To delete a macro, select the macro in the scrolling list and click Delete button. This allows deleting any
macros, not just the macros for the current team.
Inter-DB macros are created in the following situations:
A user in design application attempts to make a connection to an element in a design database

to which the user does not have write access to;
A user in design application attempts to make a connection to an element in a multiwrite design
database to which the user has write access, but the element is claimed by another user;
A user in isodraft updates revision and detail attributes which need to be stored in the design
database, to which the user has no access to;
The administrator would normally check with the project users before deleting Inter-DB macros.
Normal procedure is that the designers run and delete their own macros so the last situation stated
above is not the usual way of handling inter - DB macros.
www.aveva.com
AVEVA Marine (12.1)
16.12.4 Inter-DB Macros
Data > Extract Database Control option displays the Extract Database Control form, which allows user
to see the extract hierarchy in the project, and to refresh, release, issue and drop changes to extract
databases.
Database Extracts are covered in System Admin (Advanced) training course.
Exercise 14 - Database Sessions
1. Merge the sessions on database PIPEF/DESIGN; Backtrack database PIPEA/DESIGN first to

session 2 and then back to previous session.
2. Check the File size of databases AMA001_0001 before and after the merge.
3. Check if the equipment created in Exercise 9 was deleted and recreated during the backtrack
process.
www.aveva.com
Chapter 17
17 AVEVA Hull and Outfitting 12.1.1 Environment Variables
Usage of Project Environment Variables i.e. AMA000, AMAPIC, AMAISO AMAMAC etc. to point at our
project has been shown. AVEVA Hull and Outfitting 12.1.SPx makes extensive use of these variables.
The AVEVA Marine (12.1) installation guide has a full list of these variables and their use. The following
section describes the use and modification of some of the variables.
17.1 Environment Variable PDMSWK
When working in AVEVA Hull and Outfitting 12.1.SPx user is effectively working on a copy of the data. The
data is only written back in the database when the user does a Save work or Exit.
AVEVA Hull and Outfitting 12.1.SPx uses a work area directory that is a local PC directory. The directory is
described by the Environment Variable pdmswk. This variable should be set in the evars.bat file i.e.
There should be no spaces at the equal (=) sign.
17.2 Environment Variable PDMSUSER
AVEVA Hull and Outfitting 12.1.SPx makes use of the Environment Variable PDMSUSER to place its
reports etc.
It is convenient should be
located locally on the PC.
Create the directory C:\PDMSUSER via Windows explorer and then set this variable in the evars.bat file i.e.
key in the variable Set PDMSUSER= C:\PDMSUSER.
There should be no spaces at the equal (=) sign.
17.3 Serialisation Files
When Designers exit AVEVA Hull and Outfitting 12.1.SPx application the screen layout is saved in a number
of files known as Serialisation files. Serialisation files are located in a directory C:\Users\<User
Name>\AppData\Local\Aveva
www.aveva.com
AVEVA Marine (12.1)
17.4 Environment Variable PDMSUI
The Environment Variable PDMSUI points at the AVEVA Hull and Outfitting 12.1.SPx User PML 1 Interface
(Forms and Menus) directory structure. This variable can be used to point at a search path. The PDMSUI
variable can be set to more than one directory path. AVEVA Hull and Outfitting 12.1.SPx will find the files in
the search path, in the search order.
It can be used to customise AVEVA Hull and Outfitting 12.1.SPx Modified forms, menus or macros can be
placed in a parallel directory structure and AVEVA Hull and Outfitting 12.1.SPx will find these modified files
first.
The default setting for PDMSUI is set

pdmsui=%pdmsexe%pdmsui\
In our installation the path would be

C:\AVEVA\Marine\OH12.1.SPx\PDMSUI
There are number of folders in this directory containing different interfaces i.e. des holds the Design
Interface, dra holds the Draft Interface, Iso holds the Isometric interface etc.
17.5 Environment Variable PMLLIB
The PMLLIB variable has similar role as PDMSUI variable with the exception that an index called pml.index
is used to describe the location of PML 2 Forms, Objects and Functions.
It can be used to customise AVEVA Hull and Outfitting 12.1.SPx forms, menus, object and functions. The
directory structure is not important as AVEVA Hull and Outfitting 12.1.SPx will find the modified files first via
the index.
The default setting for PMLLIB is set

pmllib=%pdmsexe%pmllib\
In our installation this would be

C:\AVEVA\Marine\OH12.1.SPx\PMLLIB
This directory structure holds a number of folders that containing forms, objects and functions.
www.aveva.com
Chapter 18
18 Data Integrity Checker
This chapter describes the AVEVA Hull and Outfitting 12.1.SPx Data Integrity checker known as DICE.
DICE checks the internal structure of a database.
18.1 Main Checks
The main checks are:
Is the complete data hierarchy intact? E.g. do all lists contain all of the members that they
should contain?
Are all element names correctly stored and accessible?
Are references to other databases valid? If not, a warning will be output. The most likely cause
is deleted database.
If the answer to any of above questions is no, a message will be output, either to your screen or
to a named ASCII file in the administrators working directory.
DICE also tells the administrator how many elements are stored.
18.2 Causes of database corruption
The most probable causes of database corruption are:
An error in the network, resulting in loss or non arrival of data.

An error on copying databases. In particular, this can lead to truncated databases.
Insufficient disk space or storage quota, so that the project area fills up while a database is
being updated.
Deletion of a DB which is referenced from another DB.
Reconfiguration of a DB without a corresponding update of all DBs which have references
pointing into it.
An undetected fault in the AVEVA Hull and Outfitting 12.1.SPx Database Management software
It is important that any corruption which does occur is detected as quickly as possible, so that the System
Administrator can replace the faulty database by a backup copy. For this reason, DICE is designed to
operate as efficiently as possible, using relatively little computer resource, so that it is economic and
practical to check the whole of the project database on a regular basis, and not just when an immediate
need arises, such as after a computer failure. It is recommended that DICE checks should be run frequently,
i.e., before a daily backup is taken. DICE should be run at least once a week.
18.3 Database Storage Statistics
During the checking process, DICE can output statistics relating to the contents of the database, with very
little extra resource usage.
The following statistics can be produced:
The total number of elements in the database

The number of referenced names in the database
www.aveva.com
AVEVA Marine (12.1)
18.4 Preparatory Steps before Checking Starts
A summary of most of the project information stored in the System database can be obtained by using the
Query options. This may be helpful when deciding which databases need a detailed check.
DICE always accesses the database in Read/Write mode, to prevent anyone using the database while it is
being checked. Therefore the administrator cannot check any database which is in use elsewhere.
However the administrator can use the Query options to see which other users are currently accessing the
project, which databases they are using, and what their access mode is to each.
The administrator may wish to lock the project as described in Chapter 16.1.
18.5 Using DICE
Using the Previously created AMA Project, the user can select Utilities > Integrity Check from the
main pull down menu, the Data Integrity Check form will be displayed.
18.5.1 Check options
The Check pull-down menu, at the top of the form, allows you to choose which database(s) you want to
check.
If the Selection option is selected, you can pick the databases you want from the list. Clicking the Select All
button selects all the databases in the list, and clicking the Clear Selection button clears the selection.
The other options under Selection allow the administrator to check the Project database or the System
database.
www.aveva.com
AVEVA Marine (12.1)
18.5.2 Settings options
The Settings options control the types of check carried out. They are described in the following sections.
18.5.2.1 Producing Statistics
Statistics produced in DICE report are controlled by the options available in Statistics pull-down menu, as
follows:
Off no statistics will be produced
On DICE report produces statistical summary of the DB, including its size, the number of elements
contained within it, etc.
Extra this option gives extra statistical information that may be required by your AVEVA Support engineer.
An example of the type of output produced is described later
18.5.2.2 Checking External References
The elements in some types of databases have reference or reference array attributes which can point to
elements in other databases.
Checking of these external references is controlled by the following three options available in External Refs.
pull-down menu:
No Checking DICE will not cross-check references to other databases.
Check each referenced element is checked for a valid type. A non-fatal error message is produced for
each invalid external reference found. The following tests are applied on each external database to
which reference is made:
Does the referenced database still exist?

Is the referenced database of a valid type? For example, a reference attribute in a Design
database which points to a DRAFT database must be illegal.
Is the position pointed to within the limits of the referenced DB? Note that for a copied DB, DICE
only checks that the reference is within the limits of the largest copy.
A non-fatal error message is produced for each invalid external reference found.
Reject this option should be used only when you are certain that the database which is being checked
should not contain any external references, for example, to a Dictionary database. If this command
is used any external reference found in the database will be reported as a fatal error and further
checking will be abandoned.
If databases have been copied, the references will be checked against the first copy found.
www.aveva.com
AVEVA Marine (12.1)
18.5.2.3 Patching the Database
By default, DICE checks the integrity of the selected database(s), without correcting any inconsistencies that
it may find. To make a slight difference in DICE execution regarding correcting inconsistencies we use
option available in the Attempt to patch database problems pull-down menu i.e. On or Off.
If option On is selected, certain inconsistencies are corrected automatically, for example, for extracts:
When a child extract recorded in the system database is not listed in the database header, the
extract is added to the database header.
When a child extract is listed in the database header but not recorded in the system database,
the extract is removed from the database header.
element is claimed from the parent extract.

When an element that is not claimed is recorded as cl
element is released in the parent extract.
When an element is recorded as being claimed to an extract that is not a child extract, the
element is released.
In these cases, the error message is written as a warning. If the patch is successful, it is followed by a
message indicating that the corrective action has been taken. If the attempt to patch fails for any reason (i.e.
if it is not possible to obtain write access to the database) then an error message indicating this is written
instead.
18.5.2.4 Maximum Errors
There are two types of errors detected by DICE:
A fatal error is identified if the DB is corrupted.

A non-fatal error (a warning) is identified if DICE encounters a fault with references to external
DBs.
If Maximum number of errors is set to 1, checking stops when the first fatal error is encountered; that is,
DICE simply determines whether or not the DB is corrupt. Otherwise DICE continues checking the whole DB
or file, listing all non-fatal and fatal errors until the maximum number of errors count or maximum number of
warnings count is exceeded, when the checking of that DB is abandoned. Occasionally DICE will stop
before processing the whole DB.
18.5.2.5 Selecting the Output Destination
The reports generated by DICE can be sent to the screen or to a named file by clicking the Screen or File
radio buttons.
If File is selected, the Filename textbox and button are activated so that a location and filename
may be specified.
When the form is complete, click the Apply button and the selected database(s) will be checked.
18.6 Macros
Normally the System Administrator will set up standard macros for the regular use of DICE.
DICE has two modes of operation:
From within AVEVA Hull and Outfitting 12.1.SPx This is the normal way of using DICE. The
administrator can use it to check a single DB, several DBs or a whole AVEVA Hull and Outfitting
12.1.SPx project. They can use the Database Integrity Check form for a quick interactive check,
or they can write a macro.
www.aveva.com
AVEVA Marine (12.1)
As a stand-alone program. This is useful, i.e. when the System DB has been corrupted. DICE
can be used to check the System DB from outside the AVEVA Hull and Outfitting 12.1.SPx
project. In stand-alone mode, DICE can only check database files one at a time.
The commands needed to write DICE macros, or to run DICE as a stand-alone program, are described in
the AVEVA Marine (12.1) Admin Reference Manual. Some of the commands in DICE can only be used from
within AVEVA Hull and Outfitting 12.1.SPx some can only be used in stand-alone mode and the rest is
available in either mode. DICE detects which mode it is operating in and rejects any inappropriate
commands.
18.7 DICE Output
As each DB or file is checked, a report is sent to the screen or a file. The basic report, produced in response
to any check command, consists of three sections:
A report header, which includes information about the date and time of the check, the general
details of the database which is to be checked (DB name, DB number, filename, size, etc), and
the options selected.
An error report, which lists details of any errors encountered during the checking process.
A report summary, which tells you whether the database is free from structural faults, suspect or
definitely corrupt.
Other output sections, which will be appended to the basic report if they have been requested, are:
DB storage statistics
An external reference list
The Report Header
All the information which DICE can determine about a DB before starting its detailed checks is presented in
the report header.
If any particular item of information

cannot be determined (for example,
the project name when running in
stand alone mode), it is presented
in the header as
*UNKNOWN*
DICE Banner. This is repeated at

the beginning of each report, in
addition to its display when first
entering the module. It confirms the
particular version of DICE which
produced the report.
Date and Time The date and time

at which the check was started for
that particular DB or file.
Project. The three-character AVEVA Hull and Outfitting 12.1.SPx project code.
Database. The name by which the DB is known within the AVEVA Hull and Outfitting 12.1.SPx project.
Filename. The name of the external file containing the DB.
DB number. The DB identification number, as it appears in the output from the LIST FILES command.
DB type. Design, Catalogue, Drawing etc.
DB size. The amount of space currently used by the DB in its file, in pages and megabytes. The
maximum size (in pages) and the percentage of space filled are also shown. Note that if the
database is more than 90% full, a warning is added in the output.
Page size. The number of bytes per file page.
www.aveva.com
AVEVA Marine (12.1)
Options requested. Confirms the settings of the checking options:
STATISTICS OFF or BRIEF STATISTICS or STATISTICS ON

CHECK EXTERNAL REFERENCES
LIST REFERENCED DATABASES
BRIEF CHECK or FULL CHECK
Finally the report summary and the error report will be given, as described in the following sections.
18.8 The Error Report
During the checking of the structure of each DB, DICE will output a diagnosis of each error as it is found.
These messages, which are output as part of the normal operation, are quite distinct from any general error
messages which may result from the incorrect running of DICE as an AVEVA Hull and Outfitting 12.1.SPx
module.
Depending on the settings options, DICE will diagnose any number of warnings up to the first error found
and will then abandon any further checking or DICE will output a list of all errors found, unless the number of
errors exceeds the setting of Maximum number of errors or exceeds the setting of the Maximum number
of warnings.
18.9 The Report Summary
This overall assessment of the DB integrity is often the most useful part of the report to the user. The
following messages can be output:
18.9.1 Fatal Errors
*DATABASE CONTAINS FATAL ERRORS**
The DB must NOT be used further in the context of an AVEVA Hull and Outfitting 12.1.SPx project and a
backup copy must be retrieved to replace it.
Any occurrence of DB corruption should always be reported immediately to AVEVA Solutions

Limited and documented in the usual way on a fault report
Sometimes a corrupted database can be recovered by reconfiguration, but this is not guaranteed.
18.9.2 No Structural Errors
Database has no structural errors
The DB can continue to be used.
WARNING! Database contains some reference attribute warnings i.e. a reference pointing to an element
which has been deleted has been found. The database can continue to be used, but the inconsistencies
may need further investigation.
Exercise 15 - Dice
1. Use the Integrity Checker to check several of the AMA project databases; no errors should be
found.
www.aveva.com
Chapter 19
19 Lexicon
The Lexicon module will allow creation and modification of User Definable Attributes (UDAs), User System
Definable Attribute (USDA), User Definable Element Types (UDETs) and Status Values (STAVAL) that can
be assigned to AVEVA Marine (12.1) elements so that additional information may be stored in the databases
and extracted into drawings and reports. This course covers the creation of UDAs and UDETs.
For TAGS refer to the Schematics Training Guide

TM-3550 - AVEVA Plant (12.1) AVEVA Tags Training Guide (Basic),
TM-3551 - AVEVA Plant (12.1) AVEVA Tags Training Guide (Advance),
TM-3552 - AVEVA Plant (12.1) AVEVA Tags Training Guide (Administration)
For Database Views refer to the TM-2204 AVEVA Marine (12 1) Reporting Training Guide
The administrator creates the following administrative elements which enable the users to group similar UDA
and UDET elements.
UWRL (UDA World)

UGRO (UDA Group)
UDETWL (UDET World)
UDETGR (UDET Group)
19.1 Lexicon GUI
From the Start menu select All Programs > Aveva Marine > Design > Marine 12.1 > Lexicon the AVEVA
MARINE Login window will be displayed. It is an administration module so can only be accessed by a free
user.
Enter Project Training, Username SYSTEM, Password

XXXXXX, in MDB PROJADMIN.
The Dictionary Explorer and

Current Element Editor are
opened.
www.aveva.com
AVEVA Marine (12.1)
19.2 Lexicon Hierarchy
19.2.1 Dictionary Database
A dictionary database holds the definitions of user defined attributes (UDA) and user defined element types
(UDET). User defined elements types allow objects in a database to be given a user defined name to
replace the generic name, i.e. an EQUI element can be called :PUMP or :VESSEL. Additional information
can be stored in user defined attributes assigned to database elements and extracted into drawings and
reports.
User Defined Element Types are used for Outfitting only.
19.2.1.1 User Defined Attributes
User Defined Attributes (UDA s) enable the system administrator to add new attributes to any element in the
databases of a project. These UDA s are created as elements in the Lexicon database inside the project.
Because Lexicon databases are project-specific, it is possible to define attributes to suit individual project
requirements or company standards.
Users can extend the allowed attributes for any element type, including a UDET, by defining UDAs (user
defined attributes).i.e. a user could define a UDA called: SUPPLIER of type string on all piping components.
The newly defined UDA will then exist on all applicable elements, existing and new. If the definition of a UDA
is changed then this will also apply to all existing instances.
Having defined a UDA, it is accessed in the same way as any other attribute
The elements which make up a UDA within the Dictionary Database are given below.
UWRL (UDA World) is the top-level administrative element. As well as

the standard attributes, this has a description
(DESC) attribute which can contain up to 120
characters of text.
UGRO (UDA Group) is a member element of the UWRL and has the
same attributes as a UWRL.
UDA (User-Defined Attribute) is user defined attribute which can only be owned
by a UGRO and has no members.
USDA (User System Defined Attribute) allows the administrator to place a behaviour on a
standard Outfitting element. I.e. limits may be
applied to attributes of top level elements within
Outfitting.
A UDA contains the following attributes.
Name Name of the element

Description Description
User-defined attribute name User name of the attribute
Reporter text A text attribute used to define the default column heading to be
used in reports. Reporter text (RPTX) may be up to 20 characters
long.
Type Type of attribute values
Length Length of data or text which is the maximum number of
occurrences of the given UTYPE that may be stored in the UDA.
i.e., a REAL UDA might be given a Length (ULEN) of 3, making it
suitable for storing, say, a 3D coordinate array. For TEXT and
WORD UTYPEs, ULEN is the maximum number of characters. The
default setting of ULEN is 1, the maximum is 500 (Strings longer
than 500 characters will be truncated)
Category Category of the attribute
Element types Types of elements to which this attribute applies. Up to 100
element types may be set
www.aveva.com
AVEVA Marine (12.1)
Referred Types Types of elements that can be pointed to by a reference attribute

Valid Values List of valid values and ranges for the attribute. Can be entered valid
numeric values, value ranges and/or strings. For numeric ranges it should
be separated minimum from maximum value with a single dash (-). Multi-
word strings must be enclosed in either single quotes (') or apostrophes (`)
or vertical bars (|). Single-word strings do not have to be enclosed. All items
must be separated by commas or white space
Protected Can be set to true to disallow viewing the attribute in a protected database.
Default value is False
Hidden Can be set True to hide attribute. Setting this to true will indicate that the
UDA will be hidden from the 'Q ATT' command and from the attribute form
within Outfitting. Querying of the individual UDA will not be effected by this
setting. Default value is False
Hyperlink Can be set True to treat attribute as a link to an external resource. Default
value is False
Connection Holds a logical value, setting the value to have will signal that the UDA is a
connection in the reference list.
Pseudo Attribute Setting this logical attribute to True will indicate the UDA is pseudo attribute.
Pseudo attribute allow for dynamic values to be returned as needed rather
than having static values stored in the database. Default value is False
A UDA Type (UTYPE) could be set to the following.
Integer Any whole number, i.e. 200

Real Any numeric value, i.e. 23.5
Text Any characters in closing single quotes. i.e. 'BOT_STEEL2'
Logical True or False
Reference An element identifier, i.e. /VESS1, =12/99
Word Any sequence of letters, i.e. ABCD
Position A position, i.e. X10 Y50 Z100
Orientation An orientation, i.e. Z is X and Y is Z
Direction A direction, i.e. X 45 Y
A USDA allows the administrator to add the following behaviours to system attributes.
Set valid values

Define limits
Hide attributes on forms
Category
The valid values and limits may be varied with element type
These values are defined by creating a USDA element in the dictionary database. A USDA contains the
following attributes.

System attribute Name of the system attribute to which the USDA is to be applied.
Category Category of the attribute
Valid Values List of valid values and ranges for the attribute. Can be entered valid
numeric values, value ranges and/or strings. For numeric ranges it should
be separated minimum from maximum value with a single dash (-). Multi-
word strings must be enclosed in either single quotes (') or apostrophes (`)
or vertical bars (|). Single-word strings do not have to be enclosed. All items
must be separated by commas or white space
Element types Types of elements to which valid values and ranges apply
Hidden Can be set True to hide attribute. Setting this to true will indicate that the
UDA will be hidden from the 'Q ATT' command and from the attribute form
within Outfitting. Querying of the individual UDA will not be effected by this
setting. Default value is False
www.aveva.com
Both UWRL and UGRO elements may themselves be given user-defined attributes

AVEVA Marine (12.1)
19.2.1.2 User-Defined Element Types
Within Outfitting, the standard set of elements is often used for a variety of purposes. A UDET allows an
element to be created with a more meaningful name, i.e. an administrator could create clearly defined sub
types such as Pipe Lagging, Pipe Painted and Pipe Heated.
The elements which make up a UDET within the Dictionary Database are given below.
UDETWL (UDET World) is a top-level administrative element. As well as the

standard Outfitting attributes, this has a description (DESC)
attribute which can contain up to 120 characters of text.
UDETGR (UDET Group) is a member element of a UDETWL and has the same
attributes as a UDETWL.
UDET (User-Defined Element Type) is user defined element type which can only be owned by a
UDETGR and has no members.
A UDET contains the following attributes.

User-defined type name User name of the type
Base Name Base type for the user-defined element type
Owner Types List of allowed owner types
Member Types List of allowed member types
Hidden Attributes Attributes hidden on elements of this user-defined element type
19.3 Lexicon Options
Following options are available under Lexicon pull down menu for Save Work to save the
DB changes; Get Work to get DB changes, Module to switch to other modules, and Exit
to leave the application.
19.4 Display Options
It is possible to display or hide the Dictionary Explorer, Current Element

Editor, Database Views Editor, Graphical Window, Search Window, Search
Results Window and Command Window via the Display menu.
19.5 Edit Options
From the Edit menu it is possible to use the Undo and Redo options as
well as Cut, Copy, Paste, Delete and Validate.
www.aveva.com
AVEVA Marine (12.1)
19.6 Schematic Model Manager Options
It is possible to configure UDA properties, map

UDA and other database attributes to attributes
from the diagram data source files and specify
which User Defined Attributes (UDAs) are
available in each schematic database with which
Schematic Model Manager operates,
These options are covered in more details in the TM-3451 Schematic Model Manager training guide
19.7 Dictionary Explorer
Using the Dictionary Explorer the user can right

click on the Dictionary World element and
create a Database view world (DBVWWLD), a
Bound Attribute definition world (DSXWLD), a
Status Configuration world (STAWLD), a User
defined element world (UDETWL), or a User
defined attribute world (UWRLD) or from the
Create menu on the main toolbar.
Once the world is created the Name can be given by keying in the name
in the Current Element Editor.
Once a World exists, it can be populated with Group elements (UGRO / UDETGR) depending on the owning
element.
Once a Group element exists, it can be populated with UDA or UDET elements depending on the owning
element.
To delete an element administrator should select Delete from the context menu by right clicking on
the appropriate element in Dictionary Explorer
www.aveva.com
AVEVA Marine (12.1)
19.8 Current Element Editor
Any element can be selected from the Dictionary Explorer and can be
modified via Current Element Editor using the attributes covered
previously.
19.9 Creating a UDA (Worked Example)
Before any UDA s can be created a Dictionary database must exist i.e. ADMIN/DICT created when the
databases were setup earlier.
From the Lexicon Dictionary database select the Dictionary WORL*, right click and select Create > UWRLD:
User defined attribute world.
Once the World is created with no name having

selected your newly created UDA World, it is
possible to give a name via Current Element
Editor. In the Current Element Editor key
Training_UDA_World in the Name field and key
Administration Dictionary in the Description
field.
Once the World has been created, right click on it

and select Create > UGROUP: User defined
attribute group. Using the Current Element
Editor as stated above name the newly created
Group as ADMINUDAGROUP and key in the
Description Administration UDA Group.
Now to create the UDA element navigate to your newly created

UDA Group and right click, then select Create > UDA: User
defined attribute.
Key in the Name ABS_CAPACITY, the Description Absolute

Capacity of Equipment, User-defined attribute name CAPACITY-
ABS using the Current Element Editor. Key in the Reporter text
Capacity, Select the UDA Type real, key in the UDA Length 15,
Element types EQUIPMENT.
The Current Element Editor for the newly added UDA should now
be as shown opposite:
If this same UDA was required on other design elements it

is possible to add the name(s) of the design element(s) in
Element types field. I.e. EQUIPMENT, PIPE, HVAC, etc.
www.aveva.com
AVEVA Marine (12.1)
The new UDA can now be seen against the equipment attribute in Outfitting.
19.9.1 Adding UDA s Using the Command Window
In the Lexicon Command Window key in /* to navigate to the top level i.e. the Dictionary World, then key in
Q MEM and press the return key on the keyboard, the Members are listed.
In the Command Window double click on 1 UWRL 1

/Training_UDA_World and press the return key and then key in Q MEM
once again.
Now in the Command Window key in 1 or double click on 1 UGRO 1 /ADMINUDAGROUP and then key in
NEW UDA /COLOUR UTYP TEXT, -
are allowed), ULEN 20, . Now, key in ELEL ADD EQUI.
After defining the administrator should execute the command

COMPILE and then make a SAVEWORK or just exit Lexicon by
keying in QUIT
UDNA or UTYP.
The new UDA can now be seen against the equipment attribute in Outfitting.
www.aveva.com
AVEVA Marine (12.1)
19.10 Creating a USDA (Worked Example)
To create the USDA element navigate to your newly created UDA Group and right click, then select Create
> USDA: User system defined attribute, Key in the Name FUNCTION, the Description Function
Restriction for Equipments, the System attribute FUNC.
Now to give the conditions for Function system attribute key in the Valid values PUMP, ' TANK ', FAN, '
HEATER ', BOILER, ' COOLER ' using the field or the button to view the Edit valid values form.
Key in the Element types EQUIPMENT. The newly

created USDA element now should consist of
UVALID elements and your Dictionary Explorer
should look like this:
The new USDA can now be seen against the

equipment attributes in Outfitting. Navigate to an
equipment and display the attributes. Select the pull-
down menu at the Function attribute, the available
values will be displayed as shown opposite:
www.aveva.com
AVEVA Marine (12.1)
19.11 Creating UDET (Worked Example)
Before any UDETs can be created a Dictionary database must exist i.e. ADMIN/DICT created when the
databases were setup earlier.
Select Dictionary WORL*, click the right mouse

button and select Create > UDETWL: User
defined element world. Once the World is
created, give a name via the Current Element
Editor. Training_UDET_World in the Name field
and key UDET Administration Dictionary in the
Description field.
Once the World has been created, right click

on it and select Create > UDETGR: User
defined element group. Using the Current
Element Editor as stated above, name the
newly created Group as ADMINUDETGROUP
and key in the Description Administration
UDET Group.
Now to create the UDET element navigate to your

newly created UDET Group and right click, then
select Create > UDET: user defined element.
Key in the Name TANK, Description UDET for
Tank, User-defined element type TANK, Base
type EQUIPMENT.
The Owner types and Member Types fields will be populated automatically with respect to the given base
type element.
The Dictionary Explorer and Current Element Editor should now appear as below;
www.aveva.com
AVEVA Marine (12.1)
Now the newly added UDET can be applied in the Design application against EQUI elements. Using the
Design Explorer, navigate to the equipment element you wish to modify, then key in the Command Window
CHANGETYPE TO :TANK
The Design Explorer now shows the UDET and in the Attributes form there is now an pseudo attribute
ActType for the UDET i.e. :TANK
www.aveva.com
Chapter 20
20 Assembly Planning Properties Creation
The Lexicon GUI has a mechanism available to

define a set of attribute values valid for a certain
system attribute or user defined attributes, related to
an element or a set of elements. i.e. a set of a set of
acceptable values for the Assembly Working Location
attribute (ASWLOC) can be added to the User
System Defined Attribute (USDA) type of element
defined by the Lexicon module. Here the user can
also define for what type of element this restriction of
the attribute should be valid, for the ASMBLY type of
element or any subtypes of the ASMBLY type, i.e.
User Def
same mechanism is available but the

restrictions are made directly in the UDA not
via a USDA
The current dialogue and will allow values for the system attributes Assembly Working Location (ASWLOC),
Assembly Destination (ASDEST), Assembly Build Strategy (ASBUIL), and Description (DESC) in a drop
the same way in the

dialogue i.e. will allow values presented in a dropdown list, and are presented below all system
get a dropdown list. Instead if a wrong value is given, the user will be informed in a message
window of the acceptable range.
20.1 Creating an Assembly Working Location
From the Dictionary Explorer, navigate to the Dictionary WORL*, click the right mouse button and from the
context sensitive menu that is displayed select Create > UWRLD: User defined attribute world.
The Current Element Editor is displayed, key in the Name

ASSY_WORK_LOC and the Description Assembly Working
Locations.
www.aveva.com
AVEVA Marine (12.1)
Now with the newly created UWRL element highlighted in the Dictionary Explorer, click the right mouse
button and from the context sensitive menu select Create > UGROUP: User defined attribute group. In
the Current Element Editor key in the Name ASSYWL_GRP and the Description Assembly Working
Locations Group
Now with the newly created UGRO element highlighted in the Dictionary Explorer, click the right mouse
button and from the context sensitive menu select New USDA. In the Current Element Editor key in the
Name ASSY_USDA and the Description Assembly User System Defined Attribute. When the System
attribute text field is selected a browse button is activated, click the browse button.
The Select system attribute form is displayed, in the Filter field key in AS, then from the list select ASWLOC.
When the Valid values text field is selected a browse button is activated, click the browse button.
The Edit valid values form is displayed, key in the required values
and and then click the OK button. Now select the Element types text field is selected a
browse button is activated, click the browse button.
www.aveva.com
AVEVA Marine (12.1)
The Select element types form is displayed, in the Filter text box key in ASM, select ASMBLY from the list
and click the Add to list button. The select element type is added to the Chosen element types list, once all
the required element types have been added, click the OK button.
The element type is now added to the form, select Lexicon > Save Work.
This can now be tested in Outfitting using the

Assembly Planning utility form the Properties for an
assembly form.
The Assembly Destination (ASDEST),

Assembly Build Strategy (ASBUIL), and
Description (DESC) are all created in the
same way just using different System
attributes.
Exercise 16 - Creating / using UDA s
1. Using the MTP Training Project, create the UDA s Designed, Checked and Approved UDAs and
2. Create the UDET s for a PUMP, and TANK element based on Equipment in Design
3. Check that information can be added to the UDA s in Design and the UDET can be used.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Chapter 21
21 Status Management Configuration
The Configuration of Status sequences and their status values is an administrative task done for each
project. The configuration data is defined in the Lexicon module and is stored in the Dictionary database.
Normal Lexicon commands for creating and deleting elements and setting the attributes values, are
available to allow the systems administrator to build the status sequence and status value data structure.
Status Management is the ability to control and report on the status of individual model objects as they
progress through their lifecycles. It can be applied to any model objects, i.e. tagged items, catalogue
components, drawings etc. the example below is a typical workflow
It is possible to view a Graphical representation of the

status work flow using Display > Graphical View.
Typical example shown opposite:
www.aveva.com
AVEVA Marine (12.1)
The status Management data model defines a workflow as a status definition owning a set of Status Values.
Individual model objects reference the status value via a status link object as shown below. Status data is
stored on the status link objects the user does not need write access to the model object in order to set its
status. The status link objects are distributed globally with the model objects they refer to. They are not
visible to the end user, but the status data is available as pseudo attributes.
Outfitting or other constructor module database Dictionary database (Lexicon)
Globally distributed with

model objects
Status Link World
Status Definition
Status Link
Element Ref
Status Value Ref
Equipment /LOS1006 Comment: Text
Pseudo Attribute
Design Status Value: Rework
Design Status Number: 25%
Status Value
21.1 Creating a Status World (Worked Example)
From the Dictionary Explorer, click the right mouse button and from the context sensitive menu select New
Status World, the Current Element Editor is now active for the new element key in the Name
Equipment_Status and the Description Equipment Status.
www.aveva.com
AVEVA Marine (12.1)
21.2 Creating a New Status Definition
Using the Dictionary Explorer navigate to the newly created Equipment_Status world, click the right mouse
button and from the context sensitive menu select New Status Definition, the Current Element Editor can
now be updated key in the Name Equipment_Creation and the Description Equipment Creation. Now on
the Current Element Editor form, click in the Controllable element types field and a browse icon is activated.
The Status Group which appears on the context sensitive menu is to allow the administrator to sub-
divide the hierarchy under the Status world.
Click the activated browse icon, the Select element type form is displayed, in the Filter field key in EQUI,
select EQUIPMENT from the list and then click the Add to List button, this adds the selected element to the
Chosen element types list. Additional elements could be added if required, if no more elements are required
click the OK button.
www.aveva.com
AVEVA Marine (12.1)
21.3 Creating a New Status Value
Using the Dictionary Explorer navigate to the newly created Equipment_Creation definition, click the right
mouse button and from the context sensitive menu select New Status Value, the Current Element Editor
can now be updated key in the Name Work_Pending, the Description Work Pending and Numerical value
0. Repeat this process creating the additional Status Values.
Additional Status Values
Name Description Numerical Value

Work_Started Work Started 20
Work_Suspended Work Suspended 15
Work_Complete Work Complete 50
Rework Rework 25
Preliminary Preliminary 55
For_Check For Check 60
Checked Checked 80
Approved Approved 90
Released Released 100
www.aveva.com
AVEVA Marine (12.1)
21.4 Setting the Transitions
Once all the Status Values have been created the Transitions need to be set up against each status value.
Using the Dictionary Explorer navigate to the first Status Value Work_Started, in the Current Element Editor,
select the Valid transitions field, a browse button appears. Click the browse button and the Select Valid
status transitions for is displayed. Click the Valid transitions i.e. Work_Complete, Work_Suspended and
click the OK button.
The Promote and Demote transitions can now be populated from the pull down list. i.e. Promote to
Work_Complete. Repeat this process adding the Valid Promote and Demote transitions for each status
value.
When there is more than one Promote valid transition the one
selected becomes the default and if the other valid transition
is required this can be selected from the Status Controller in
Outfitting using the Edit Status option.
The Valid transitions
Status Value Valid Transactions Promote Demote

Work_Started Work_Suspended Work_Complete Work_Suspended
Work_Complete
Work_Suspended Work_Started Work Started
Work_Complete Preliminary Preliminary
For_Check For_Check
Preliminary For_Check For_Check Rework
Rework
Rework Work_Complete Work_Complete
For_Check Checked Checked Rework
Rework
Checked Released Released
Released
Once all the Valid Transitions have be setup, the administrator needs to click
Lexicon > Save Work, a confirm form Savework Are you
sure? Yes button to confirm.
www.aveva.com
AVEVA Marine (12.1)
21.5 Testing the Status Management Configuration.
Log in to Outfitting and then select Display > Status Controller, this opens the Status Controller form, from
the Status Layout pull down select New Layout.
This displays the Select Status Columns form, select the newly created
Equipment Creation and the columns which are required to be displayed
and click the OK button
The Focus Status now displays the Equipment Design Status and the list is populated with the controlled
element types which were set in the Status Definition i.e. EQUIPMENT (EQUI). Highlight one of the
Elements from the list and then click the right mouse button and from the context sensitive menu select Edit
Status. The Status Equipment Design Status for is displayed from the Pull down the first status value i.e.
Work Pending [0] (Assigned) should be visible, select this and click the OK button.
This can be repeated to test all the status values can be promote and demoted with their expected results.
www.aveva.com
Appendix A
22 Appendix A - Backing up Data
It is essential that good backups are produced of your data. Companies will have invested a lot of money
and man hours into producing the AVEVA Hull and Outfitting 12.1.SPx data so it is very important that data
is not lost due to hardware failure, fire or user error.
22.1 Daily Backups
Backups are normally automated and produced each night when no one using the system.
Now that magnetic tapes can store vast amounts of data and operate very quickly it is normal practice to
backup all files on the Server each night. The local PC files are not normally backed up.
If your tape deck does not have the capacity to save all the data then you can just save the project data.
For example AVEVA Hull and Outfitting 12.1.SPxProject (AMA000)
AVEVA Hull and Outfitting 12.1.SPx Options (AMAISO)
AVEVA Hull and Outfitting 12.1.SPx Macro (AMAMAC)
AVEVA Hull and Outfitting 12.1.SPx Drawings (AMADWG)
The AVEVA Hull and Outfitting 12.1.SPx picture files (AMAPIC) need not be saved as they can be
regenerated by using the Draft Update commands (valid for outfitting only).
Administrator must make sure that anything that has been modified has been backed up. If any
customisation has been done, these files should be backed up.
22.2 Typical Backup
A typical tape backup sequence for the server could be as follows you will require Three Monthly Tapes
(MONTH 1, 2 and 3), Three Weekly Tapes (Week 1, 2 and 3) and Four Daily Tapes (MON, TUES, THU and
FRI).
Weekly/Monthly tape enables to get items back up to 4 months ago; the ones that may have been deleted
by error.
22.3 Project Backups
Once a project is completed it would be normal practice to save the project including all reports etc. and a
copy of the AVEVA Hull and Outfitting 12.1.SPx version. It is always best to create two copies of the data so
if the cd or tape gets lost or damaged there is still another copy.
www.aveva.com
AVEVA Marine (12.1)
www.aveva.com
Appendix B
23 Appendix B Design Resuse - Settings
23.1 Defaults
Transfer set directory path, changing names option and on transfer error program action settings are stored
in the C:\AVEVA\Marine\Data12.1.SPx\pdmsui\DFLTS\designreuse\GeneralSettings.xml file.
Tab Settings shown general settings (defined in the file described above) and control Local Settings
changed by user:
The Design Reuse form can be activated by selecting Display

> Design Reuse, from the main pull down menu.
GeneralTransferSetNamePrefix prefix of default transfer set

name
GeneralHelpVisible set True
LocalHelpVisible set True
Reload general settings from file
Display the content of the item settings file
Undo local settings changes
23.2 Renaming options
Handled elements and names of mapping functions scripts are defined in the
AVEVA\Marine\Data12.1.SPx\pdmsui\DFLTS\designreuse\ItemSettings.xml file.
Example of setting control block name change:
www.aveva.com
AVEVA Marine (12.1)
Model and references renaming functionality is controlled via PML scripts stored in the
\OH12.1.SPx\PMLLIB\DesignReuse\functions directory.
Below example of the buildBLOCKName.pmlfnc macro, which control hull block name change:
Rename functions can be edited by system administrator or user and adapted to current requirements.
www.aveva.com
Appendix B1
24 Appendix B1 - Export from source project
Start Hull Design (Structural Design application) and

use the following log in details:
Project: Training username: HADMIN (Hull
Administrator) Password: HADMIN MDB:
STRUCDESIGN (For Structural Design Users)
Currently supported are the following model items:

Hull
Plane panels,
Curved panels,
Shell stiffeners and plates,
Longitudinals/Transversals,
Frames/Waterlines/Buttocks and hull curves,
Bracket panels, knuckle panels,
Plate and Profiles nesting,
Assembly,
Marine Drawings + Assembly drawings,
Outfitting
Equipment,
Pipe,
HVAC,
Structure,
Cableway + Cable,
Room
Additional supported item types

Links
Distributed attributes
24.1 Source model check before export
references, system warnings and errors messages must be corrected.
1. Create xml file for exported elements and run in the batch on source project, check log file.
2. Remove all exported panel scheme files and generate new.
3. Run in batch scheme files, check result and correct all warnings and errors.
4. Use topology function and check exported panel references. Replace by X, Y, Z or planes missing
on target project (boundary definition).
5. Compare source and target block limits, panels have to be fully inside block box.
6. Compare source and target default settings (connection codes, endcuts, clips/cutout macros, bevel
codes, material quality etc)
www.aveva.com
AVEVA Marine (12.1)
24.2 Model Selection
24.2.1 Search utility
Start View > Addins > Search Utility from the Hull modules or
from the outfitting modules, to display the
Search form. Using the Search form key in the required Name
Contains: MTPS*, and the Element Type: CSEAM, then click the
Search button.
The Search Results form is displayed; highlight the elements that are to be added to the Design Reuse
export list, with the list select in the Search Results frame drag and drop the selected list of elements in to
Design Reuse Export list.
In the example shown below all the seams created on the main hull surface (seam name MTPS* without any
suffix) have been selected and then added to the Export list.
www.aveva.com
AVEVA Marine (12.1)
24.2.2 Drag and Drop from Explorers
It is possible to drag and drop elements for export from Design

Explorer and Draft Explorer or select the required element to move
from the Design Explorer, then click the right mouse button and select
function Add To Design Reuse Export List
From the Design Reuse Export list, select one or more elements in
the list (standard Windows SHIFT + CTRL combination), click right
mouse button, the following context sensitive menu will be presented:
Remove delete element from list

display topology elements for selection
Add external selection add elements selected in the 3D Viewer
display export information
Set to current element navigate in the Design Explorer to element
Select all select all elements in the export list
If a shell plate i.e. F206-SHELLPLATE-806 is added to the Export list, then the user from the right click
context sensitive menu selects Get referred items the following list (depend from selection) will be
displayed:
Include all referred items
Exclude all referred items
If no referred items are found then a message form will inform the user
Add the referred elements to export list and then click the Export button, The Give Transfer Set Name form
is displayed, select the directory and key in transfer set name, the click the OK button. The Export list
changes to show the exported element.
In one transfer set can be exported different

model objects (shell elements, plane panels,
outfitting model, drawings etc).
www.aveva.com
AVEVA Marine (12.1)
24.3 Transfer set
Model objects are stored in the transfer set directory as xml file, scheme file, datal file etc. The program
creates separate files for each model object.
All references (surface name, block name, object name etc) are replaced by PML functions according to
rules defined in the settings (See Appendix B):
Before import the system will substitute PML functions with correct names.
Exercise 17 Design Reuse
Using the Design Reuse Export, create a transfer for the following:
1. All seams generated on main hull surface (seam name without any suffix)
2. All shell profiles from MTP project
3. Shell plates and curved panels use name filter F206* for panel selection; as first select curved
panels, us
4. Plane panels for block F206 and drawing F206-12345-003
5. Assembly starting from root 206
6. Bow thruster equipment (THS3001, THS3002, THS3003, THS3004)
www.aveva.com
Appendix B2
25 Appendix B2 - Import into the target project
For the purpose of the training the users will use a previously created project AMT. Frame spacing 735 mm,
longitudinal spacing 700 mm. Deck 2 9300 mm above base, ship width 23200 mm.
Before model import can start, the target project should be fully setup up. The surface must be released, hull
reference objects and hull defaults must be created, nesting raw material and steel quality created in
Paragon, manufacturing packages must be defined, if production information will be reused. Both projects
should use same project catalogues. Hull setup detailed information is presented in TM-2122 AVEVA Marine
(12.1) Project Administration (Hull) training guide.
For Design Reuse training purposes the following process will be used:
- surface released via Surface Manager,
- hull blocks creation from csv file
- are used for MTP panels position)
Trainee will be asked to replace AMT project database files with files provided by trainer, run pml script to
create manufacturing packages and replace project catalogue and properties with MTP project data.
Applications called in the next chapter will use the following

log in details:
Project: AMT
Username: SYSTEM
Password: XXXXXX
MDB: HADMIN (for Hull Administration)
25.1 Import and release surface file into target project
Copy surface file AMT.dm from \Training\Additional_Data\Basic_Admin

directory into project \ShipAMT\atamar\navarch, start Project Tool and
release surface, see chapter 4 TM-2122 AVEVA Marine (12.1) Project
Administration (Hull) for details.
If surface file is delivered in the sat, iges, dml or napa format, Surface
Manager should be used to release the surface into dabacon. Below sat file
import and release example.
Start Surface Manager application, select Hull Surfaces node in the tree and from right mouse button
context sensitive menu select Import from File and choose
surface file. Press OK button.
To import a hull-form to a project select the hull-form in the tree

and from the right mouse button context sensitive menu select
Release Surface, if the user has not previously logged onto
the project then they will be presented with the dialogs to
enable them to do so.
Close application.
www.aveva.com
AVEVA Marine (12.1)
25.2 Hull block reference objects import
Start Hull Log Viewer, select from menu Hull > Init Hull, key in login details, select node Initiate Hull
Model > Blocks, create. Press button Browse and navigate to \Training\Additional_Data\Basic_Admin
directory, select file AMT_Blocks_1.csv and press button Create Object
25.3 Hull reference objects
Replace database files amt6007_0001 and amt6069_0001 stored in project amt000 directory with files
stored in the \Training\Additional_Data\Basic_Admin.
25.4 Project catalogue and steel quality
Start Admin application, delete database MPROJECT/CATA and PROJECT/PROP (see chapter 7.4) and
copy databases from MTP project. Copy Foreign option -> see chapter 7.2, then add databases
(STRUCDESIGN, HADMIN and other).
See chapter 8.15 and 8.17.2 TM-2122 AVEVA Marine (12.1) Project Administration (Hull) for material quality
and nesting raw material setup details instead of database file copy.
25.5 Manufacturing packages
Start Hull Design (any application) and open Manu Config addin (View > Addins > Manu Config). Drag
and drop from \Training\Additional_Data\Basic_Admin directory file AMT_ManuPkg.mac. Manufacturing
packages will be created, review result, Save and Unclaim.
See chapter 9 TM-2122 AVEVA Marine (12.1) Project Administration (Hull) for details.
25.6 Create a new RSO envelope
Start Hull Design (Structural Design) and select menu In the Envelopes frame select
from right mouse button context menu New, key in envelope name HULL and check Generate from Box.
Key-in limits and press Save Envelope
button.
www.aveva.com
AVEVA Marine (12.1)
Target project AMT is ready for model import. Real projects should be created and setup according to the
company standards.
MTP project
AMT project
Import is restricted to the applicable object types hull objects can be imported in Hull Design,
drawings in Marine Drafting, outfitting model in Outfitting Design.
Module switch is necessary to import mixed object types.
www.aveva.com
AVEVA Marine (12.1)
25.7 Model import from transfer set
Start Hull Design (Structural Design application)

Start View > Addins > Design Reuse, choose tab Import and click the Open button. Change directory, if
necessary and select transfer set for import:
If the rename PML script is correct, the system will replace names according to new on AMT project naming
convention:
Open transfer set
Transfer set properties, if selected the following

window will be opened:
If any of the imported objects already exist, the system will display the following information message:
the following message will be displayed:
www.aveva.com
AVEVA Marine (12.1)
Click the button to start the model import from the selected transfer set.
If any of the names are not correctly mapped or rules are missing, system will prompt:
After import the system will display following message:
Click the button to check detailed log file:
In this example 21 seams are not imported. The log file for each object can be found in the project lst
directory.
For example, seam AMTS605 is created as intersection between surface and Z plane at 18610. Project
AMT surface is a smaller surface than MTP from which the XML file has been extracted and the
be generated in the new project within the defined limit box (Z=17132 in AMT project). Check the XML file
for all seams that fail to import, correct any incorrect coordinates then run the XML file again in batch mode.
If a model object is only partly imported, the following warning is presented:
25.8 Nesting import
Production parts (plate and profile parts) are not supported in Design Reuse application. After successfully
importing the model and checking (rework, if necessary) Plane Parts Generation and Curved Parts
Generation programs have to be executed. After parts generation, nesting import can be done.
www.aveva.com
AVEVA Marine (12.1)
25.9 Outfitting model import
Outfitting model can be imported only in Outfitting application (module switch is necessary if the user is
currently using the Hull Design module). The outfit models are transferred via datal files, i.e.
NEW REPLACE EQUIPMENT /$[buildEQUIName('THS3001')]

DESC 'Bow Thruster'
POS X 156000mm Y 2700mm Z 2100mm
Position is not defined as references to frame or longitudinal position, but as absolute X, Y or Z value.
Picture above show bow thrusters imported in to smaller ship from bigger project. When reused, outfit items
will remain placed at their original geographical location. In many cases these will need to be repositioned
and in some cases replaced with a different specification item suit the new ship design. This may be better
handled by managing the amount of data brought into the new design into more workable packages.
25.10 Target model check after import
to check the model after import. Pay special attention to all elements reported as
not imported.
Example transfer is made between same ship types, but different size.
Exercise 18 Design Reuse
1. Import all objects exported to the transfer sets in the previous exercise. Use _ENV_HULL envelope.
2. Check import, log files, verify imported model.
www.aveva.com
Appendix B3
26 Appendix B3 Hull Model + Outfitting (Working Example)
26.1 Export to transfer set
Start Hull Design (Structural Design application) and

use the following log in details:
Project: Training
Username: HADMIN (Hull Administrator)
Password: HADMIN
MDB: STRUCDESIGN (For Structural Design User)
From the main pull down menu, select View > Addins > Design Reuse and start Design Reuse addin. Drag
and drop from Design Explorer hull block F401 in to Design Reuse frame (remove from selection curved
panels). Select all panels and click left mouse button, from the context sensitive menu select Get referred
items add to the selection bracket panels (HBRAPN object type) and RSO.
Select in the Design Explorer the following outfitting model elements:

SITE ELECT_4DK_FWD ZONE 403-CABLE-001
SITE EQUIP_4DK_FWD ZONE 403-EQUIP
SITE HVAC_4DK_FWD ZONE 403-HVAC
SITE OUTSTEEL_4DK_FWD ZONE 403-STRCT
SITE PIPE_4DK_FWD ZONE 403-PIPE
Drag & Drop elements into Design Reuse frame. Selection should be similar to elements displayed below:
With all the elements highlighted, click the Export button, key in transfer set name MTP-403 and click the
OK button. Review transfer files for each model type and then close Hull Design application.
www.aveva.com
AVEVA Marine (12.1)
26.2 Import from transfer set
Start Hull Design (Structural Design application) and use the following log in details:
Project: AMT
Username: SYSTEM
Password: XXXXXX
MDB: STRUCDESIGN (For Structural Design User)
Create a new block F501, use same block limits as

F401 (Proje
Select View > Addins > Design Reuse and start Design Reuse addin. Select the Import tab and then the
Open button. Choose transfer set created in chapter 26.1.
Change F401 block name and key in F501.
Rename bracket panels according to naming

convention (BlockName-bracketName-number)
Click the Import button. Check imported model. Save and unclaim panels. Change module (File >
Modules) and start Outfitting.
Edit buildequiname.pmlfnc PML script stored in AVEVA\Marine\OH12.1.SPx\PMLLIB\designreuse\functions
!newName = '403_' + !nameCE
Select Display > Design Reuse click tab Import and Open button. Select same transfer. Only outfitting
model elements are available for import. Check new equipment names.
Review import results. Check names, position, connections.
www.aveva.com
AVEVA Marine (12.1)
Result of the import between different projects should be similar to:
As described in chapter 25.9 outfitting model reused on different size ship should be repositioned, replaced
with new specification items etc.
www.aveva.com

TM 2120 AVEVA Marine 12 1 System Administration Basic Rev 3 0 PDF

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

TM 2120 AVEVA Marine 12 1 System Administration Basic Rev 3 0 PDF

Diunggah oleh

Hak Cipta:

Format Tersedia

AVEVA Marine

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

9.2.1 Project Setup Excel Spreadsheet - Teams .............................................................................. 56

16.11 Deleting Phantom Users / Claim Lists ..................................................................................... 99

24.2.2 Drag and Drop from Explorers ............................................................................................... 139

1.4 Course Structure

1.5 Using this guide

Example files or inputs will be in the bold courier new font.

2 Installation and Setup

2.1 Installation of FlexMan 5.2

The screenshots displayed in this chapter of

The contents of the disk are listed, showing the

Then select the option to suit your operating system

The Release Documents screen appears. Firstly, read

Browse may also be used to change the installation

The installation starts and is shown in the Status

Then, select the Config Services tab.

Key in the Service Name AVEVA Marine

Use the Browse button to

Tick the two boxes Start

Then click the Save Service

2.2 Installation of the AVEVA Marine (12.1) Application Product Software

2.2.1 Automatic Install of the Cache Service

The cache service will be automatically installed if

Where MSMQ is not active the cache service will

The Cache Manager is covered later in this

The Marine setup form now requests Advanced Configuration

3 Project Access Verifying Installation

3.1 Installation Projects

AVEVA Marine (12.1) requires several a number of directories;

MAR000 Project database directory.

CPL MDS Catalogue Project

Navigate using the Windows Explorer or My

The user can now see the installed AVEVA

3.2 Adding Project Environment Variables to the Batch File

A project loaded onto a machines hard disk

A Project loaded onto a server machine

The IP address \\192.168.95.43\

3.3 Starting the AVEVA Marine (12.1) Application

To start AVEVA Marine (12.1), select the application to be started from

The first time Hull Design

To exit the AVEVA Hull and

Copyright 1974 to current year. 23

3.4 Optional Upgrade

Storing of a space arrangement definition.

Storing of coordinate system entities under a GENPRI element.

New Marine Drawing Types. Applicable for PADD databases.

As soon as a database is upgraded it is no longer compatible with 12.1.SP2 or earlier versions.

4 Creating a New Project

4.1 Project Creation Wizard

The project Address may be changed by typing or browsing but by default

4.1.1 Project Variables

4.1.1.1 Extra Project Areas

Using the Extra Project Areas Button Project,

4.1.1.2 Marine Variables

This file can be launched through the Admin module. Select

4.1.2 Adding Project Details

4.2 Existing Projects

Exercise 1 - Project Creation

1. Create a new project AMA using the Project Creation Wizard.

Enter the Project ShipAMA, Username SYSTEM,

No MDB needs to be set to go into Admin

5.1 Teams and Users