TM-2120 AVEVA Marine (12 Series) System Administration Basic Rev 5.0

System Administration
(Basic)
TM-2120
TRAINING GUIDE
AVEVA Marine
(12 Series)
www.aveva.com
AVEVA Marine (12 Series)

System Administration (Basic) TM-2120
Revision Log
Date
Revision
Description of Revision
Author
SB/WR/SK
SB/WR/
MG
SB/WR/
MG
02/02/2009
2.0
Approved for Training 12.0.SP3
09/09/2009
2.1
Issued for Review SP4
11/09/2009
3.0
Approved for Training 12.0 SP4
Reviewed
Approved
SK/WR
RP
SH
SH
07/12/2009
3.1
21/12/2009
3.2
Issued for Review SP5

Password security handling
change reflected in small
changes in the majority of
training manual chapters
Reviewed
21/12/2009
4.0
Approved for Training 12.0.SP5
SB
JD/JF/SK
SH
21/05/2010
18/06/2010
16/07/2010
4.1
4.2
5.0
Issued for review 12.0 SP6

Reviewed
Approved for Training 12.0 SP6
SK
SK
SK
WR/OZK
WR/OZK
SH
SB
SB
JD/JF/SK
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
Group Solutions Centre at gsc@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
Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd
and its subsidiaries without warranty. AVEVA Solutions Ltd. and its subsidiaries disclaim any and all
warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd or any of its subsidiaries shall be liable to any person or entity
for any actions, claims, loss or damage arising from the use or possession of any information, particulars or
errors in this publication, or any incorrect use of the product, whatsoever.
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use
of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries,
registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights or other intellectual property rights in any other product, its name or logo
belongs to its respective owner.
www.aveva.com
2

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 AVEVA Solutions Ltd. or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in this
document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or
transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is
granted, it expressly requires that this Disclaimer and Copyright notice 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 Ltd. The user may also not reverse
engineer, decompile, copy or adapt the associated software. Neither the whole nor part of the product
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 or save as permitted by law. Any such
unauthorised action is strictly prohibited and may give rise to civil liabilities and criminal prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with the
terms and conditions of the respective licence agreements, and in accordance with the relevant User
Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
Printed by AVEVA Solutions on 03 August 2010

AVEVA Solutions and its subsidiaries 2001 2010
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
www.aveva.com
3

www.aveva.com
4
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 FlexMan5.2 ............................................................................................................. 11
2.2
Installation of the AVEVA Marine (12 Series) Application Product Software .......................... 16
3 Project Access ....................................................................................................................................... 19
3.1
Installation Projects ....................................................................................................................... 19
3.2
Adding Project Environment Variables to the Batch File .......................................................... 20
3.3
Starting the AVEVA Marine (12 Series) Application ................................................................... 21
4 Creating a New Project .......................................................................................................................... 23
4.1
Project Creation Wizard ................................................................................................................ 23
4.1.1
Project Variables ...................................................................................................................... 23
4.1.2
Adding Project Details .............................................................................................................. 25
4.2
Existing Projects ............................................................................................................................ 25
Exercise 1 (Project Creation)........................................................................................................................ 26
5 Database Administration ...................................................................................................................... 27
5.1
Teams and Users ........................................................................................................................... 28
5.2
Creating Teams .............................................................................................................................. 29
5.3
Creating Users................................................................................................................................ 30
5.3.1
Create User as a Copy of the Existing User ............................................................................ 32
5.3.2
Creating Users using the Access Control Assistant................................................................. 32
Exercise 2 (Teams and Users)...................................................................................................................... 33
6 Creating Databases ............................................................................................................................... 35
6.1
Data Base Types ............................................................................................................................ 35
6.1.1
Administration Databases ........................................................................................................ 35
6.1.2
Model Databases ..................................................................................................................... 35
6.2
Creating a Design Database ......................................................................................................... 36
6.2.1
Create SITE.............................................................................................................................. 37
6.2.2
Database Access Mode ........................................................................................................... 37
6.2.3
Controlled Databases ............................................................................................................... 38
6.2.4
Protection ................................................................................................................................. 38
6.2.5
Area Number, DB Number and File Number ........................................................................... 38
6.3
Creating a Catalogue Database .................................................................................................... 39
6.3.1
Creating Namesequence Database ......................................................................................... 39
6.4
Copied Databases .......................................................................................................................... 40
Exercise 3 (Database Creation) .................................................................................................................... 41
7 Foreign Databases ................................................................................................................................. 43
7.1
Including and Copying Foreign Databases ................................................................................. 43
7.1.1
Including Databases from the MAS Project ............................................................................. 43
7.2
Copying a Foreign Database from the MAR Project .................................................................. 44
7.3
Excluding Foreign Databases....................................................................................................... 44
7.4
Deleting Databases ........................................................................................................................ 44
7.5
Modifying the setup of the Admin Elements Form ..................................................................... 44
Exercise 4 (Copying and Including Foreign Databases) ........................................................................... 46
8 Multiple Databases (MDBs) ................................................................................................................... 47
8.1
Creating MDBs ............................................................................................................................... 48
8.2
Database Order in the MDB .......................................................................................................... 49
Exercise 5 (Creating MDBs) .......................................................................................................................... 50
9 Project Setup Excel Import ................................................................................................................... 51
9.1
Admin Export to Excel ................................................................................................................... 51
9.2
Project Setup Excel Spreadsheet File.......................................................................................... 52
9.2.1
Project Setup Excel Spreadsheet - Teams .............................................................................. 52
9.2.2
Project Setup Excel Spreadsheet - Users ................................................................................ 53
9.2.3
Project Setup Excel Spreadsheet NT Authenticated Users ..................................................
53
www.aveva.com
9.2.4
Project Setup Excel Spreadsheet Databases ........................................................................ 54
5

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

16.12.4
Inter-DB Macros ................................................................................................................... 95
Exercise 14 (Database Sessions)................................................................................................................. 95
17
AVEVA Hull and Outfitting 12.0SPx Environment Variables ......................................................... 97
17.1 Environment Variable PDMSWK................................................................................................... 97
17.2 Environment Variable PDMSUSER............................................................................................... 97
17.3 Serialisation Files........................................................................................................................... 97
17.4 Environment Variable PDMSUI ..................................................................................................... 98
17.5 Environment Variable PMLLIB...................................................................................................... 98
18
Data Integrity Checker ....................................................................................................................... 99
18.1 Main Checks ................................................................................................................................... 99
18.2 Causes of database corruption .................................................................................................... 99
18.3 Database Storage Statistics.......................................................................................................... 99
18.4 Preparatory Steps before Checking Starts ............................................................................... 100
18.5 Using DICE.................................................................................................................................... 100
18.5.1 Check options......................................................................................................................... 100
18.5.2 Settings options ...................................................................................................................... 101
18.6 Macros........................................................................................................................................... 103
18.7 DICE Output .................................................................................................................................. 103
18.8 The Error Report .......................................................................................................................... 104
18.9 The Report Summary ................................................................................................................... 105
18.9.1 Fatal Errors............................................................................................................................. 105
18.9.2 No Structural Errors ............................................................................................................... 105
Exercise 15 (Dice) ........................................................................................................................................ 105
19
Lexicon.............................................................................................................................................. 107
19.1 Lexicon GUI .................................................................................................................................. 107
19.2 Lexicon Hierarchy ........................................................................................................................ 108
19.2.1 Dictionary Database ............................................................................................................... 108
19.3 Lexicon Options ........................................................................................................................... 110
19.4 Display Options ............................................................................................................................ 110
19.5 Edit Options .................................................................................................................................. 110
19.6 Schematic Model Manager Options ........................................................................................... 111
19.7 Dictionary Explorer ...................................................................................................................... 111
19.8 Current Element Editor ................................................................................................................ 111
19.9 Creating a UDA (Worked Example) ............................................................................................ 112
19.9.1 Adding UDAs Using the Command Window ......................................................................... 113
19.10
Creating a USDA (Worked Example) ...................................................................................... 114
19.11
Creating UDET (Worked Example) ......................................................................................... 115
20
Assembly Planning Properties Creation ....................................................................................... 117
20.1 Creating an Assembly Working Location .................................................................................. 117
Exercise 16 (Creating / using UDAs and UDETs) ................................................................................... 120
21
Status Management Configuration ................................................................................................ 121
21.1 Creating a Status World (Worked Example) .............................................................................. 122
21.2 Creating a New Status Definition ............................................................................................... 123
21.3 Creating a New Status Value ...................................................................................................... 124
21.4 Setting the Transitions ................................................................................................................ 125
21.5 Testing the Status Management Configuration. ....................................................................... 126
22
Appendix A - Backing up Data ....................................................................................................... 127
22.1 Daily Backups............................................................................................................................... 127
22.2 Typical Backup ............................................................................................................................. 127
22.3 Project Backups ........................................................................................................................... 127
www.aveva.com
7

www.aveva.com
8
CHAPTER 1
Introduction
AVEVA Marine (12 Series) System Administration (Basic) Training Course will enable the Trainee to create
and maintain AVEVA Marine (12 Series) 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 Series) Project.
1.2
Objectives
1.3
Set up a new AVEVA Marine (12 Series) 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 Series)
fonts.
Control user access to AVEVA Marine (12 Series) modules.
Check data integrity.
Create DB Listings and understand change highlighting.
Create UDAs (User Defined Attributes)
Create UDETs (User Defined Element Types)
Prerequisites
Trainees should be familiar with AVEVA Marine (12 Series) 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 courier new font, colours and styles used as before.
www.aveva.com
9

www.aveva.com
10
CHAPTER 2
2
2.1
Installation and Setup

Installation of FlexMan5.2
Insert the AVEVA Marine (12 Series) 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
11

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. By default all the features are pre-selected to
be installed. Click the Next button. The form now changes to a Ready to Install FlexMan section, click the
Install button.
To modify selection of features to be installed, prior to clicking the Next button select feature, click the right
mouse button on the selected feature and select the desired installation option from the menu available.
Browse may also be used to change the installation

path.
The installation starts and is shown in the Status
bar.
www.aveva.com
12

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:\Flexman5.2 and place your
AVEVA Marine (12 Series) 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 can only have 200
characters or 2048 with \ as a continuation character.
Now from the Start menu select All Programs > AVEVA > FlexMan 5.2 > License Service Control
(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 12
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.1 folder.
Tick the two boxes Start Server
at Power Up and Use Services
Then click the Save Service
button.
www.aveva.com
13

Before running any AVEVA product, the path to the AVEVA license server needs to be set. From the Start
menu select All Programs > AVEVA > FlexMan4 > FlexMan Configuration Tool. In the Select
Application Vendor pool down menu select AVEVA(CADCENTRE). In the System registry
(recommended) field key in 744@Computername i.e. 744@ukcaml3259. Then click the Set button.
Save the input done and exit FlexMan configuration tool by clicking Save and Exit button.
Generally 744 tcp-port number is used in AVEVA Marine (12 Series). 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. 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
14

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 12 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 work around see:

http://support.aveva.com/services/products/flex/flexnews.htm
www.aveva.com
15

2.2
Installation of the AVEVA Marine (12 Series) Application Product Software
If a previous version of the AVEVA Marine (12 Series) 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 located under AVEVA\Marine folder desired to keep before removing
the software
Now that the FlexMan has been set up, select from the Application Products section AVEVA Marine (12
Series) & Hull Outfitting 12.0.SPx
The Release Documents for the AVEVA Marine Hull & Outfitting 12.0 SPx form is displayed click the
INSTALL button.
www.aveva.com
16

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.0.SPx Setup form. On the AVEVA Marine 12.0.SPx Setup
form click the Next button.
The AVEVA Marine 12.0.SPx Setup form opens Custom Setup selection for user to select 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
, click left right mouse button and chose Entire feature will be installed on local hard drive
from offered selection. The Marine 12.0.SPx 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.
www.aveva.com
17

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.
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
18
CHAPTER 3
Project Access
AVEVA Hull and Outfitting 12.0.SPx makes extensive use of Environment Variables; they are used to define
the location of the AVEVA Marine (12 Series) software and Projects. In this chapter we are going to
investigate the setting and the location of AVEVA Marine (12 Series) Projects with the use of the Project
Environment Variables.
3.1
Installation Projects
AVEVA Marine (12 Series) requires several Project Environment Variables pointing at 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.
MARISO
Project Isodraft Options directory.
MARMAC
Project Inter-DB connection macro directory.
MARPIC
Project Draft Picture File directory.
MARTPL
Project Visio template directory.
MARSTE
Project Visio Stencil directory.
MARMAR
Project Hull directory.
MARINFO
Project Information directory.
MARDWG
Project drawings directory.
MARDRG
Project drawings directory.
MARDIA
Project Visio diagram directory.
MARDFLTS
Project defaults directory.
MARREPORTS
Project reports directory
AVEVA Hull and Outfitting 12.0.SPx installs two projects from the AVEVA Marine (12 Series) installation CD.
MAR
MAS
Marine Sample Project (Metric)

Marine Master Catalogue
We are going to test our AVEVA Hull and Outfitting 12.0.SPx installation using the MAR project. The
environment variables for the MAR project have been set up in the project batch file called evarsMarine.bat
which is held in the project directory MAR. The evars.bat file held in the AVEVA\Marine\OH12.0 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.0.SPx is started from the start menu
All Programs > AVEVA > Marine 12.0 SPx > Run Marine
All Catalogue information for the MAR project is held in the MAS project so the environment variables for
MAS have also been set. We 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.
By default the supplied AVEVA Marine (12 Series) projects are held in a project directory under the AVEVA
Marine (12 Series) executables directory.
Navigate using the Windows Explorer or My

Computer to the Project directory, in this
example
C:\AVEVA\Marine\OH12.0.SPx\project
The user can now see the two AVEVA Marine
(12 Series) supplied Projects Mar and Mas.
www.aveva.com
19

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 projects 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 Hull and Outfitting 12.0.SPx 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
20

3.3
Starting the AVEVA Marine (12 Series) Application
To start AVEVA Hull and Outfitting 12.0.SPx, Select All Programs>AVEVA>Marine 12.0.SPx>Run Marine
The AVEVA MARINE 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-up
triggered when AVEVA Hull and Outfitting 12.0.SPx is initialised.
Enter the Project MAR, Username SYSTEM, Password XXXXXX,
MDB ALL_NO_MDS, Module Outfitting, and then click OK.
The first time Hull Design module is started a
warning Please choose application will 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.0.SPx application select Design > Exit from the main pull down
menu.
www.aveva.com
21

www.aveva.com
22
CHAPTER 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 12.0.SPx > Project
Creation Wizard.
The AVEVA Marine Hull and Outfitting12.0 SPx Project Creation Wizard form appears, key in the Project
Training, the CODE AMA and key in the Address C:\AVEVA\marine\OH12.0.SPx\project\Training 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, Cerate, buttons etc.
The Project 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 and REPORTS and appropriate folders assigned to each variable are to be
included in the new project, check appropriate checkboxes in Project Variables form shown above.
If the environment variables AVEVA_MARINE and MARINE are set to "YES" in the marine.bat file, then
the Project Creation Wizard will display a marine checkbox which will be checked by default. If the
environment variables AVEVA_MARINE and MARINE are not available or set to any other value
(including "Y") then the Project Creation Wizard will not display a marine checkbox.
www.aveva.com
23

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 Apply 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 click the Apply button.
This file can be launched through the

Admin module. Select Project > Marine
environment setup.
www.aveva.com
24

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 the
display 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
25

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.0.SPx\PDMS\
If for any reason the project creation fails, the references to that project should be removed from this file
to allow 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)

Create a new project AMA using the Project Creation Wizard.
www.aveva.com
26
Chapter 5
Database Administration
To start AVEVA Marine (12 Series), Select All Programs>AVEVA>Marine 12.0.SPx>Run Marine
The AVEVA MARINE 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-up
triggered when AVEVA Marine (12 Series) is initialised.
Enter the Project Training, Username SYSTEM, Password
XXXXXX, Module Admin, 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
elements form and the Access Control Assistant form.
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 the 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
27

5.1
Teams and Users
In AVEVA Marine (12 Series) 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 the start the AVEVA Marine (12 Series) 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
CATA
Project Catalogue TeamCATA / CATA
PIPEF
PIPEA
HULLFWD
HULLAFT
DRAFT
ISO
ADMIN
Forward Piping areas

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

Design Administration Team
Draft Administration Team
Isometric Administration Team
Catalogue Administration Team
Hull Administration Team
PARADM / PARADM
DESADM / DESADM
DRAADM / DRAADM
ISOADM / ISOADM
CATADM / CATADM
HADMIN / HADMIN
www.aveva.com
28

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 Team MASTER can be changed the

same way.
www.aveva.com
29

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 the users 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. Press OK to set the
users password.
Password length can be 15 characters. Password can

contain any of the characters except |@$/*.
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.
www.aveva.com
30

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.
To change the users password, on the 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. Press OK to set the users 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 Monitor module.
To enable the change of password, the user must first confirm
current password by typing it into the current Password field.
Then key in the new password into the New Password field
and confirm it by re-typing it into the Confirm New Password
field. Press OK to set the users password and exit the form.
www.aveva.com
31

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.
5.3.2
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.
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. 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 Series) 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
32

Exercise 2 (Teams and Users)

Create the Following Teams and Users for the AMA project.
The users should be members of their respective teams.
The Associations team will have a number of members, HULLFWD, HULLAFT, HULLDES, PIPEA, and
PIPEF. It will also be necessary to add other users to teams to give required access.
www.aveva.com
33

www.aveva.com
34
Chapter 6
Creating Databases
6.1
Data Base Types
An AVEVA Marine (12 Series) 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
record module changes etc. Each user has read access to the other users areas, and so can find out about
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 interdatabase 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
6.1.2
Model Databases
DESIGN (DESI) databases contain all the design information for the project.
CATALOGUE (CATA) databases contain the project catalogue and specifications.
DRAFT (PADD) databases contain data about drawings produced by Outfitting
Draft and Hull Drafting.
ISODRAFT (ISOD) databases contain spool drawings produced by Spooler.
PROPERTIES (PROP) databases can contain material properties, and be
referenced to by the catalogue.
www.aveva.com
35

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.
SCHEMATIC (SCHE) databases contain P&ID (Schematic) information.
MANUFACTURING (MANU) databases contain detailed manufacturing data.
NAMESEQUENCE (NSEQ) databases store name sequences.
L
6.2
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.
Creating a Design Database
To create a new database, select Databases & Extracts from the Elements section of the Admin elements
form the pull down list, then click the Create button.
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/DESIGN, 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.
www.aveva.com
36

6.2.1
Create SITE
It is very useful when creating AVEVA Hull and Outfitting 12.0SPx 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.
Paragon, CATA.
Draft, DEPT etc.
For the creation of hull specific top level elements, in hull databases, DBPrompt utility is used. See
chapter entitled Hull Top Level Elements.
6.2.2
Database Access Mode
The access mode for databases can be:

Update
Multiwrite
Allow one writer and multiple readers.

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
Implicit
Users must explicitly claim any element they wish to change before the modification can
start.
An element will automatically be claimed when it is activated
DESIGN, DRAFT, CATALOGUE, ISODRAFT, SCHEMATIC and MANUFACTURING 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 Hull and Outfitting 12.0SPx 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
www.aveva.com
can be changed from update to multiwrite only if no database extracts have been created.
37

6.2.3
Controlled Databases
By selecting the Controlled checkbox user can specify that the database
will be controlled, by an external system.
Both UPDATE and MULTIWRITE DESIGN databases can also be CONTROLLED.
6.2.4
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 todays date.
6.2.5
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 - 6999: the higher numbers 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 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-8192. 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. 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:
Clicking the Apply button will be create the database.
www.aveva.com
38

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 Series) DB Number. Database numbers must be unique within
AVEVA Marine (12 Series). Remember the Catalogue supplied by AVEVA has the AVEVA Marine (12
Series) DB Number in the 7000 range.
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. In the DB Number field key in 5050, this will be the
catalogue DB number.
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 should this 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.
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.
www.aveva.com
39

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
pressing 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
40

Exercise 3 (Database Creation)

Create the databases as describe below.
Specific rules are defined for a number of hull dbs. Certain database types must exist for hull top 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
41

View showing databases defined in Admin module.
www.aveva.com
42
Chapter 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
Include 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
43

7.2
Copying a Foreign Database from the MAR Project
From the Admin elements form, click the Copy Foreign button. Copy foreign Database form appears.
From the Foreign Project section, select the MAR 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.
7.3
Copy all databases belonging to MPROJECT team into

the new project to enable project libraries to be available
when executing different functions eg. Automatic Drawing
Production.
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 scrolling list on the Admin elements form and
then clicking the Delete button.
L
7.5
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
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.
www.aveva.com
44

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
45

Exercise 4 (Copying and Including Foreign Databases)

1. Include all the Foreign Databases from the MAS project that are not imperial into the AMA project.
The list of Foreign databases should appear as below.
2. Copy the MPROJECT/PADD from the MAR 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
46
Chapter 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 databases which will have connections to the users design area.
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 Explore. 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.
Drawing Production.
i.e., an MDB containing Piping data only for specific work eg.
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. The Insert option button is used to position the
databases in a specified order in the list of current databases. The order the databases appear in the MDB
is important. The system will write to the first writeable database of a particular type listed in the MDB
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
47

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 [Marine] PIPEF/DESIGN database from the Project Database section. Select the
down arrow to move the project database into the Current Databases section.
www.aveva.com
48

From the Current Databases section select the PIPEF/DESIGN database and from the Insert pull down
select After. Now from the Project Databases section, select Number from the Sort by pull down list.
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 across 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 MDBs

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.
In the mdbs containing hull databases, top level elements in the dbs also control which db will be written to
(e.g. if two DESI type dbs exist in one mdb, one containing a block top level element named ER1 and one in
the other db named ER2, the system will look for the top level element before storing the model objects).
If the top level elements have not been created, the system may automatically generate them in the first
db of the required type. All top level elements are to be created beforehand and the dbs are to be
www.aveva.com
available in the mdbs to avoid this happening.
49

Exercise 5 (Creating MDBs)

Create the following MDBs
Name PIPEF, Description Forward Area Pipes MDB.
Name PIPEA, Description Aft Area Pipes MDB.
NameHULLAFT, Description Aft Hull Blocks MDB.
Name HULLFWD Description Fwd Hull Blocks MDB.
Name ALL Description All Databases.
Name DBPROMPT Description Hull Top Level Elements.
Name CHULL Description Curved Hull Modelling MDB.
Ensure that the order of the dbs within the mdb reflects its use and also how you wish them to appear
in the Design Explorer after the mdb has been selected when starting an application.
www.aveva.com
50
Chapter 9
Project Setup Excel Import
Project Setup Excel Import is designed for making the process of setting-up the AVEVA Hull and Outfitting
12.0SPx 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. The AVEVA Hull and Outfitting 12.0SPx
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
51

Exporting to Excel window containing

performing operations information appears.
Upon finishing exporting, click OK 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
52

9.2.2
Project Setup Excel Spreadsheet - Users
Select the Users Tab
#Keyword
USER
Name
Users Name
Description
Users Full Name
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
9.2.3
All the Teams that the user is a member of separated by spaces.
Project Setup Excel Spreadsheet NT Authenticated Users
Select the Authenticated Users Tab
#Keyword
Login Name
Default user
Other Users
AUTHUSER
Windows Login Name (must be lower case)
AVEVA Marine Login Name
Any Extra Users for example SYSTEM or DRAFT
www.aveva.com
53

9.2.4
Project Setup Excel Spreadsheet Databases
Select the Databases Tab
#Keyword
Owning Team
Name
Description
Type
Claim Mode
Number
9.2.5
DATABASE
Team that owns the Database.
Database Name
Database Description
Database Type (DESI, CATA, PADD, DICT, PROP etc.)
IMPLICIT, EXPLICIT, UPDATE or OVERWRITE, depending on database type and
access mode set
Unique Database Number
Project Setup Excel Spreadsheet Included Foreign Databases
Select the Foreign Includes Tab
#Keyword
Foreign Project
Foreign Name
Foreign User
Foreign Password
FOREIGN
Foreign Project Name for example MDS or MAS
Foreign Database name in the format TEAM/NAME e.g. MASTER/PIPECATA
Free User Name in the Foreign Project is not extracted
Free User Password in the Foreign Project is not extracted
If the user name and password are not supplied in excel input form, system will prompt for them during
the Project Excel Spreadsheet import.
www.aveva.com
54

9.2.6
Project Setup Excel Spreadsheet Multiple Databases
Select the MDB Tab
#Keyword
Name
Description
Databases
9.3
MDB
MBD Name
MDB Description
List of Databases in order, separated by spaces.
Starting the Excel Import Form
The Project Setup Excel Import is available in AVEVA Hull and Outfitting 12.0SPx from the Admin main pull
down menu, select Utilities > Import. The AVEVA Hull and Outfitting 12.0SPx 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
55

Click OK in the Admin Import form to start the export.

The AVEVA Hull and Outfitting 12.0SPx Import from Excel form is now populated with the information from
Project Setup Excel Spreadsheet file.
Key in the User Name and password for any Foreign Projects as the form is displayed
User Password
SYSTEM
XXXXXX
Importing from Excel window containing performing operations information appears. Any Loading Errors or
Warnings will be displayed in this window.
Upon finishing importing, click OK 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
56

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
57

Exercise 6 Project Setup Excel Import

1. Export your Admin elements from MAR project to Project Setup Excel Spreadsheet.
2. Modify generated spreadsheet adding some new Teams, Users and Databases.
3. Create new project, AMS using Project Creation Wizard and import modified spreadsheet into the
project.
4. Execute the database Rollback.
5. Import modified spreadsheet into the AMS project.
6. Save Work.
www.aveva.com
58
Chapter 10
10 Project Replication
In AVEVA Marine Hull and Outfitting 12.0SPx, 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 Hull and Outfitting 12.0SPx 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 Hull and Outfitting
12.0SPx 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.
Now select Project > Replicate > Project Data.
The Replicate Project form appears, select the AMP project and click the OK button. A confirm form appears
asking the administrator Project Training is unlocked. Do you wish to lock the project before replication?
Click the Yes button.
Project locking is covered later in the course.
www.aveva.com
59

10.1.2 Replicate Project Structure

Replicate Project Structure option creates a macro which can be run into AVEVA Hull and Outfitting 12.0SPx
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 macro. Due to password security reasons, users
passwords are not exported.
This file may be edited

before using in the
new project, for
modification of User
Names and
Passwords, DBs
names etc.Any foreign
dbs must be available
and correctly
configured.
www.aveva.com
60

Exercise 7 Project Replication

1. Create an AVEVA Marine (12 Series) Project AME as a copy of MAR project, using replicate project
data functionality.
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 MAR 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 MAR project.
The MAR project refers to foreign dbs from MDS and 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
numbers in the 7000 range stating they are reserved, these dbs will still be created.
4. Set password for the users and test if the users can log into the project AMT, Outfitting module.
www.aveva.com
61

www.aveva.com
62
Chapter 11
11 Hull Top Level Elements

After creating the project structure DBs, MDBs, Teams, Users etc., and editing the d065 file, it is now
necessary to run the DBPrompt utility to create the hull top level elements within the appropriate DBs. In the
example that follows the MDB named DBPROMPT has been created which includes all of the DBs where
the hull top level elements will be stored.
Start the Log Viewer from Start > All Programs > AVEVA > Marine 12.0SPx > Hull Log Viewer. From the
menu Admin select DBPrompt.
The CredentialsForm will be displayed, input the required login information.
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, then press Return/Enter on the
keyboard
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.
www.aveva.com
63

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 (Export csv) to a
csv file which can be edited using
Excel.
The file can then be imported
(Import csv) to update the
structure.
Extract of exported file shown below:
www.aveva.com
64

The following top level elements should be defined in DESI database RSOWLD, COMWLD, SSOWLD,
HCMWLD, MOGWLD, STDWLD, BLOCK or HBLWLD, MWLWLD, GRDWLD, ASWL, and LINKWL.
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. MBLOCK, MNSTQU, MRAWQU,
MRESTQ and MPRNST.
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
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 MAR project.
2. Add the top level elements to the projects hull databases of project AMS, created in Exercise 6,
imported csv file extracted from MAR project. Log into the project as user: SYSTEM in MDB:
/DBPROMPT.
www.aveva.com
65

www.aveva.com
66
Chapter 12
12 Testing the AVEVA Hull and Outfitting 12.0.SPx Access

Log into the AVEVA Hull and Outfitting 12.0.SPx, 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 Hull and Outfitting 12.0.SPx, Outfitting Design
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 of AVEVA Hull and Outfitting 12.0.SPx
Equipment and Piping modules, if this is not the case the trainer will help with the creation of the elements
required.
From the AVEVA MARINE Login form, select the Username PIPEF,
the Password PIPEF, set the MDB to PIPEF and the Module to
Outfitting
Form the Design pull down on the main
menu select Equipment, this changes the
module to the Equipment module.
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.
Finally click Design > Save Work and then Design > Exit.
www.aveva.com
67

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
Form the Design pull down on the main
menu select Pipework, this changes the
module to the Pipework module.
Using the Design Explorer navigate to the SITE PIPEA/DESIGN, create a ZONE TEST_PIPEA. Add a
single pipeline PIPE01 to the ZONE that connects the two Nozzles from EQUI1 and EQUI2 using the
specification SP/DR07C.
Select from the View pull down menu select Command Line.
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 Series) Access)

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
68
Chapter 13
13 References between Databases

Here we explain the relationship between databases and the use of Inter database connection macros.
Design DB
PIPEF
HREF of Branch
points to CREF of Nozz
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 this time when the AVEVA MARINE Login form
appears, select the Username PIPEF, the Password PIPEF, set the
MDB to PIPEF and the Module to Monitor
The Monitor form appears in the Monitor application. At the bottom of

the Monitor form the is a message informing the user You have InterDB Macros to run
www.aveva.com
69

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 > Macro Files
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

The 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
70

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 appears asking the user Okay to delete macro number 1? click the Yes button. The InterDB Macros are removed from the list.
Exercise 10 (Running Inter-DB Macros)

Run and Delete the Inter-DB Macro that was created in the previous Exercise.
www.aveva.com
71

www.aveva.com
72
Chapter 14
14 NT Authentication
NT Authentication is used by system administrators to allocate a Windows Login User to AVEVA Hull and
Outfitting 12.0.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 appears asking the user 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
73

The NT Authentication User Creation form appears, key in the Name stan.kernen, 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.0.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)

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.0.SPx can still be accessed.
Remember to make a copy of the system database (amasys) before you start.
www.aveva.com
74
Chapter 15
15 Sharing AVEVA Hull and Outfitting 12.0.SPx Projects and Files

This chapter explains how AVEVA Hull and Outfitting 12.0.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 C:\ using Windows Explorer or My Computer.
Select the AVEVA directory.
Right click and select Sharing and
Security
Check the Share this folder radio button. Key in the Share name
AVEVA and click the Permissions button. 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 see the AVEVA directory via My Network Places.
UNC (Universal Naming
Convention) paths are
recommended for locating the
project server.
In the example shown opposite, the
IP address has been given. The
machine name could have been
used instead i.e. \\server1\AVEVA.
www.aveva.com
75

Any references to the project location in

the project evars file should be set using
the UNC path.
15.2 Creating Shortcuts

Navigate to C:\Documents and Settings\All Users\Start Menu\Programs\AVEVA\Marine 12.0SPx.
Select the Run Marine 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.
15.3 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.0.SPx will place some
of the output files. It should not be left as the AVEVA
Marine12.0SPx executables folder.
www.aveva.com
76

15.4 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 Login screen.
In the following example the marine application will be
started in the project AMA, user PIPEF, password PIPEF,
mdb PIPEF, module Outfitting
In the Target path key in
C:\AVEVA\Marine\OH12.0.SPx\marine.bat AMA
PIPEF/PIPEF /PIPEF Outfitting
The correct installation folder address must given,

replace OH12.0.SPx with your SP number.
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.
3. Rename the shortcut to AMA-PIPEF
www.aveva.com
77

www.aveva.com
78
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 Project, select
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.0.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.0 SPx 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 Series)
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
79

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.0.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.0.SPx will rename the .deleted files by removing the file extension,
so that the files will still be available.
16.4 Display
Selecting Display > Admin Elements will display the Admin Elements form, if it
has been closed.
Selecting Display > Command Line will display the Command Window.
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.0SPx 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
80

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
81

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
82

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.0.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.0.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
83

16.8 The Settings Options

The Settings > Display Mode options allow the administrator to modify, save and restore the display of the
Admin Elements forms.
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.
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.0.SPx Data Integrity
Checker (DICE) is discussed later in the course.
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.0.SPx when the command is given, and then only
when they change modules or leave AVEVA Hull and Outfitting
12.0.SPx.
The Administrator can list messages. Once it has been displayed,
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.
www.aveva.com
84

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.0SPx 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.
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 Series) 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 Series) code number derived from its
International Registration (ISO-IR) number or from its ISO 8859 part number. The available character sets
are:
Name
Latin 1
Latin 2
Latin Cyrillic
UK
US
Greek
Cyrillic
Code
885901
885902
885905
4
6
18
37
Description
ISO 8859-1 Latin alphabet No. 1
ISO 8859-2 Latin alphabet No. 2
ISO 8859-5 Latin/Cyrillic alphabet
Standard UK ASCII (ISO 646 Reg 4)
Standard US ASCII (ISO 646 Reg 6)
ISO 2375 Registration 18
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.
www.aveva.com
85

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
Line
Block
Serif
Italic
Script
Typewriter
UWLine
Code
1
2
3
4
5
6
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.
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.0SPx 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 Hull and Outfitting 12.0 SPx 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.
www.aveva.com
86

The Current Font Settings show the four fonts that are
available. It shows whether they are System-defined or Userdefined, 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
Series) 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.
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
www.aveva.com
87

The True Type fonts configuration form appears

again continue to add additional fonts if required
and then click the Dismiss button.
The default font to be used by hull drafting and set
in the hull 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 elements. (Creation of Dept and Regis should
be done in Outfitting Draft).
True Type Fonts added to the System Database can now be used in Outfitting Draft and Hull Drafting.
Once the user starts the Outfitting Draft module, they need to create a new Dept, Regi, Drwg and Sheet to
use True Type Fonts. Select Modify > Text Template > Attributes. The Text Template Attributes form
appears, from the Font pull down list choose * Select a True Type Font.
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 Series) Fonts cannot be
mixed on the same sheet; this includes backing sheets &
symbols.
AVEVA Marine (12 Series) 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 Series) fonts will be withdrawn at
some stage in the future. However, AVEVA will provide an
upgrade capability to allow it to happen.
Exercise 13 (True Type Fonts)

Allocate several different True Type Fonts in Admin, for usage on the project. Check that these fonts are
available for usage in the drafting applications.
www.aveva.com
88

16.10.4
Modules
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.0SPx. 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
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.0SPx 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.
www.aveva.com
89

Changing options on this form may cause serious problems in usage of AVEVA Hull and Outfitting
12.0SPx. 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 are available in AVEVA Users Guide, Data

Management and Data Base > Admin > Administrator > 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.
To change the access settings for the Catalogue, Select the Outfitting Module and click the Advanced
Settings button. The Advanced Module Settings 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.
www.aveva.com
90

16.11 Deleting Phantom Users / Claim Lists

From time to time a user may exit from AVEVA Hull and Outfitting 12.0SPx 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.0.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 Expunge
button to expunge the selected user process.
Exit the form by pressing button Dismiss.
Admin will not allow the Current User to be expunged.
The Project>Expunge>Claimlist option will display the Expunge Database Claimlists form.
Select the database(s) to unclaim elements, click Expunge button to unclaim elements in selected
database(s).
Exit the form by pressing button Dismiss.
www.aveva.com
91

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.0SPx 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.
E.g. 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.
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, database

from the list is to be selected.
www.aveva.com
92

Log into the installed MAR project as ADMIN. Select Single Project Database HULLDRAFT/PADD from the
list. The Database Sessions button is now available. Click the Database Sessions button. This will display
the Database Sessions form which lists information about the existing sessions for the selected database.
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 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.
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.
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
93

From the Backtrack Changes form selects the Database AFTDRAFT/AFTPADD. As can be seen the
database is up to Session Number 238. 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 Session Number field is used to set the session to backtrack to, 235. Click the Apply button. As shown
on the Database Session Form, a new Session, session 239 has been created which is a copy of session
235.
Backtrack can only be performed on

the command line as described later
on.
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.0SPx in the MAR
project as user PIPE in the AFTPIPE mdb,
create a drawing from a template as shown
opposite. Save work and exit. Backtrack
the database 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
www.aveva.com
94

16.12.2
Backtracking the Databases (Command Window)
As previously stated, the AVEVA Hull and Outfitting 12.0SPx 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.
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 8 was deleted and recreated during the backtrack
process.
www.aveva.com
95

www.aveva.com
96
Chapter 17
17 AVEVA Hull and Outfitting 12.0SPx 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.0SPx makes extensive use of these variables.
The AVEVA Marine (12 Series) 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.0SPx 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.0SPx uses a work area directory that is local PC directory. The directory is
described by the Environment Variable pdmswk. This variable should be set in the evars.bat file i.e.
set TEMP=%~df1\pdmswk
This could also be set as
Set AVEVA PDMSWK=C:\TEMP
The use of %~df1 rather than %1 to get drive letter and fully qualified pathname of the 1st argument this allows it to work when the caller passes in a directory name including spaces and / or semicolons
There should be no spaces at the equal (=) sign.
17.2 Environment Variable PDMSUSER

AVEVA Hull and Outfitting 12.0SPx makes use of the Environment Variable PDMSUSER to place its reports
etc.
It is convenient to have this variable set to the same as the Shortcut Start in directory and 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.0SPx application the screen layout is saved in a number
of files known as Serialisation files. Serialisation files are located in a directory C:\Documents and
Settings\<User Name>\Local Settings\Application Data\AVEVA
www.aveva.com
97

17.4 Environment Variable PDMSUI

The Environment Variable PDMSUI points at the AVEVA Hull and Outfitting 12.0SPx 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 that one directory path. AVEVA Hull and Outfitting 12.0SPx will find the files in
the search path, in the search order.
It can be used to customise AVEVA Hull and Outfitting 12.0SPx. Modified forms, menus or macros can be
placed in a parallel directory structure and AVEVA Hull and Outfitting 12.0SPx will find these modified files
first.
The default setting for PDMSUI is SET
PDMSUI=%PDMSEXE%\PDMSUI
In our installation this would be

C:\AVEVA\marine\OH12.0.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.0SPx forms, menus, object and functions. The
directory structure is not important as AVEVA Hull and Outfitting 12.0SPx 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.0.SPx\pmllib
This directory structure holds a number of folders that containing
forms, objects and functions.
www.aveva.com
98
Chapter 18
18 Data Integrity Checker

This chapter describes the AVEVA Hull and Outfitting 12.0SPx 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 nonarrival 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.0SPx 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
99

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 paragraph 16.1.
18.5 Using DICE

Select Utilities > Integrity Checking 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
100

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
101

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.
When a claimed element is not recorded as claimed in the parent extracts claim list, the
element is claimed from the parent extract.
When an element that is not claimed is recorded as claimed in the parent extracts claim list, the
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 Browse 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.
www.aveva.com
102

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.0SPx. 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.0SPx project. They can use the Database Integrity Check form for a quick interactive check,
or they can write a macro.
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.0SPx
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 Series) Admin Reference Manual. Some of the commands in DICE can only be used
from within AVEVA Hull and Outfitting 12.0SPx, 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.
www.aveva.com
103

If any particular item of information cannot be determined (for example, the project name when running in
standalone 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.0SPx project code.
Database.
The name by which the DB is known within the AVEVA Hull and Outfitting 12.0SPx 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.
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.0SPx
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.
www.aveva.com
104

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.0SPx project and a
backup copy must be retrieved to replace it.
Any occurrence of DB corruption should always be reported immediately to AVEVA Solutions Ltd 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)
Use the Integrity Checker to check one of the AMA project databases; no errors should be found.
www.aveva.com
105

www.aveva.com
106
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 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.
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

Lexicon module interface is invoked from the AVEVA Marine Login window. It is an administrator module so
can only be accessed by the free user.
Enter Project mar, Username SYSTEM, Password XXXXXX, MDB

PROJADMIN, Module Lexicon, and then click OK
The Dictionary Explorer and Current Element Editor are opened.
www.aveva.com
107

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 (UDAs) enable the system administrator to add new attributes to any element in the
databases of a project. These UDAs 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)
UGRO (UDA Group)

UDA (User-Defined Attribute)
USDA (User System Defined Attribute)
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.
is a member element of the UWRL and has the
same attributes as a UWRL.
is user defined attribute which can only be owned
by a UGRO and has no members.
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
Description
User-defined attribute name
Reporter text
Type
Length
Category
Element types
Name of the element

Description
User name of the attribute
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 of attribute values
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 120 (Strings longer
than 120 characters will be truncated)
Category of the attribute
Types of elements to which this attribute applies. Up to 100
www.aveva.com
element types may be set
108

Referred Types
Valid Values
Protected
Hidden
Hyperlink
Connection
Pseudo Attribute
Types of elements that can be pointed to by a reference attribute

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 (-). Multiword 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
Can be set to true to disallow viewing the attribute in a protected database.
Default value is False
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
Can be set True to treat attribute as a link to an external resource. Default
value is False
Holds a logical value, setting the value to have will signal that the UDA is a
connection in the reference list.
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
Real
Text
Logical
Reference
Word
Position
Orientation
Direction
Any whole number, i.e. 200

Any numeric value, i.e. 23.5
Any characters in closing single quotes. i.e. 'BOT_STEEL2'
True or False
An element identifier, i.e. /VESS1, =12/99
Any sequence of letters, i.e. ABCD
A position, i.e. X10 Y50 Z100
An orientation, i.e. Z is X and Y is Z
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.
Name
Description
System attribute
Category
Valid Values
Element types
Hidden
Name of the element

Description
Name of the system attribute to which the USDA is to be applied.
Category of the attribute
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 (-). Multiword 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
Types of elements to which valid values and ranges apply
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
Both UWRL and UGRO elements may themselves be given user-defined attributes www.aveva.com
109

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)
UDETGR (UDET Group)

UDET (User-Defined Element Type)
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.
is a member element of a UDETWL and has the same
attributes as a UDETWL.
is user defined element type which can only be owned by a
UDETGR and has no members.
A UDET contains the following attributes.

Name
Description
User-defined type name
Base Name
Owner Types
Member Types
Hidden Attributes
Name of the element

Description
User name of the type
Base type for the user-defined element type
List of allowed owner types
List of allowed member types
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 and Command Line via Display menu.
19.5 Edit Options

It is possible to Validate and also use the Undo and Redo functionality.
www.aveva.com
110

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 user can create a UDA World (UWRL) or
UDET World (UDETWL) by selecting New UDA World or New UDET
World. Once the world is created the Name can be changed by keying in
the new name in the Current Element Editor.
Once a World exists, it can be populated with Group elements (UGRO / UDETGR).
Once a Group element exists, it can be populated with UDA or UDET elements.
To delete an element administrator should select Delete from the context menu by right clicking on the
appropriate element in Dictionary Explorer
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.
www.aveva.com
111

19.9 Creating a UDA (Worked Example)

Before any UDAs can be created a Dictionary database has to 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 New UDA World to create a UDA 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 New UDA
Group. The UDA Group will be created with no name. 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 New UDA, 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 Length 15, Element types EQUIPMENT. The Current Element
Editor for the newly added UDA should now be seen as below.
If this same UDA was required on other design elements it is possible to add the name(s) of the design
www.aveva.com
element(s) in Element types field. I.e. EQUIPMENT, PIPE, HVAC, etc.
112

The new UDA can now be seen against the equipment attribute in Outfitting.
19.9.1 Adding UDAs Using the Command Window

In the Lexicon Command Window key in /* to navigate to the top level i.e. the Dictionary World an then key
in Q MEM and press the return key on the keyboard, the Members are listed.
In the Command Window double click on 3 UWRL 2

/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, UDNA COLOUR, this is the name visible for user (Characters like ?_-
are allowed), ULEN 20, RPTX Colour. 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. After successful compile it shouldnt be changed
UDNA or UTYP.
The new UDA can now be seen against the equipment attribute in Outfitting.
www.aveva.com
113

19.10 Creating a USDA (Worked Example)

To create the USDA element navigate to your newly created UDA Group and right click, then select New
USDA, 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 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 attribute modifications in Outfitting. Navigate to an
equipment and select Modify > Attributes. Then click on Function attribute and key in Silencer, click OK
button. An error message will be popped when Apply button clicked since the Function value is not in newly
created USDAs range.
www.aveva.com
114

19.11 Creating UDET (Worked Example)

Before any UDETs can be created a Dictionary database has to exist i.e. ADMIN/DICT created when the
databases were setup earlier.
When the Lexicon Dictionary database was created, click right mouse button
and select New UDET World to create a UDET World. Once the World is
created with no name having selected your newly created UDET World, it is
possible to give a name via Current Element Editor. In the Current Element
Editor key 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 New UDET
Group. The UDET Group will be created with no name. 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 New UDET, Key in the Name TANK, the
Description UDET for Tank, the 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.
www.aveva.com
115

The Dictionary Explorer and Current Element Editor now should look like these;
Now the newly added UDET can be applied in the Design application against EQUI elements. Using the
Design Explorer, navigate to the equipment element to change the element type for and then key in the
Command Window CHANGETYPE TO :TANK
www.aveva.com
116
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 Defined Element Types (UDETs)
For User Defined Attributes (UDAs) the 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
down list providing that the definitions have been setup through USDAs.
User Defined Attributes (UDAs) of type text and word are handled in the sameway in the dialogue
i.e. will allow values presented in a dropdown list, and are presented below all system attributes. User
Defined Attributes (UDAs) of type real and int or arrays of real and int will not 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 New UDA World.
The Current Element Editor is displayed, key in the Name ASSY_WORK_LOC and the Description
Assembly Working Locations.
www.aveva.com
117

Now with the newly created UWRL element highlighted in the Dictionary Explorer, click the right mouse
button and from the context sensitive menu select New UDA 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.
www.aveva.com
118

The Edit valid values form is displayed, key in the required values Shop 1 Shop 2 Shop 3 Shop 4
Dock 1 and Dock 2 and then click the OK button. Now select the Element types text field is selected a
browse button is activated, click the browse button.
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.
www.aveva.com
119

Exercise 16 (Creating / using UDAs and UDETs)

1. Create the UDAs Designed, Checked and Approved UDAs and assign them to PIPE, and
EQUIP.
2.
Create the UDETs for a PUMP, and TANK element based on Equipment in Design
3.
Check that information can be added to the UDAs in Design and the UDETs can be used.
www.aveva.com
120
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
www.aveva.com
121

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
Comment: Text
Equipment /XX9006
Pseudo Attribute
Design Status Value: Checked
Design Status Number: 80%
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
122

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 New 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
123

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
Work_Started
Work_Suspended
Work_Complete
Rework
Preliminary
For_Check
Checked
Approved
Released
Description
Work Started
Work Suspended
Work Complete
Rework
Preliminary
For Check
Checked
Approved
Released
Numerical Value
20
15
50
25
55
60
80
90
100
www.aveva.com
124

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 transactions 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_Started and click the OK button
Now The Promote and Demote transactions can now be populated from the pull down list. i.e. Promote to
Work_Started. Repeat this process adding the Valid transactions, the Promote and Demote for each status
value.
When there is more than one Promote valid transaction the

one selected becomes the default and if the other valid
transaction is required this can be selected from the Status
Controller in Outfitting using the Edit Status option.
The Valid Transactions

Status Value
Work_Started
Work_Suspended
Work_Complete
Preliminary
Rework
For_Check
Checked
Released
Valid Transactions
Work_Suspended
Work_Complete
Work_Started
Preliminary
For_Check
For_Check
Rework
Work_Complete
Checked
Rework
Released
Promote
Work_Complete
Demote
Work_Suspended
Work Started
Preliminary
For_Check
For_Check
Rework
Work_Complete
Checked
Rework
Released
Once all the Valid Transactions have be setup, the administrator needs to click
Lexicon > Save Work, a confirm form appears asking Savework Are you
sure? click the Yes button to confirm.
www.aveva.com
125

21.5 Testing the Status Management Configuration.

Log in to Outfitting and then select Display > Status Controller, this opens the Status Controller from, 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
126
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.0SPx 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.0SPx Project
(AMA000)
AVEVA Hull and Outfitting 12.0SPx Options
(AMAISO)
AVEVA Hull and Outfitting 12.0SPx Macro
(AMAMAC)
AVEVA Hull and Outfitting 12.0SPx Drawings
(AMADWG)
The AVEVA Hull and Outfitting 12.0SPx 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).
Using the backup system as shown, in the worst case a days work could be lost, but by taking out a
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.0SPx 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
127

TM-2120 AVEVA Marine (12 Series) System Administration Basic Rev 5.0

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

TM-2120 AVEVA Marine (12 Series) System Administration Basic Rev 5.0

Caricato da

Copyright:

Formati disponibili

System Administration

AVEVA Marine (12 Series)

Approved for Training 12.0.SP3

Issued for Review SP4

Approved for Training 12.0 SP4

Issued for Review SP5

Approved for Training 12.0.SP5

Issued for review 12.0 SP6

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

AVEVA Marine (12 Series)

Printed by AVEVA Solutions on 03 August 2010

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

Using this guide

AVEVA Marine (12 Series)

Installation and Setup

The screenshots displayed in this chapter of the

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

AVEVA Marine (12 Series)

Browse may also be used to change the installation

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

For some common faults and work around see:

AVEVA Marine (12 Series)

Installation of the AVEVA Marine (12 Series) Application Product Software

AVEVA Marine (12 Series)

AVEVA Marine (12 Series)

Marine Sample Project (Metric)

Navigate using the Windows Explorer or My

AVEVA Marine (12 Series)

Adding Project Environment Variables to the Batch File

A Project loaded onto a server machine

AVEVA Marine (12 Series)

Starting the AVEVA Marine (12 Series) Application

AVEVA Marine (12 Series)

Creating a New Project

Project Creation Wizard

The project Address may be changed

AVEVA Marine (12 Series)

4.1.1.1 Extra Project Areas

4.1.1.2 Marine Variables

This file can be launched through the

AVEVA Marine (12 Series)

Adding Project Details

AVEVA Marine (12 Series)

Exercise 1 (Project Creation)

No MDB needs to be set to go into

AVEVA Marine (12 Series)

Teams and Users

Project Catalogue TeamCATA / CATA

Forward Piping areas

SCHEMATICS Schematics Team

Owning the database(s)

Paragon Administration Team

AVEVA Marine (12 Series)

Type the Team Name CATA

The Team MASTER can be changed the

AVEVA Marine (12 Series)

The Teams are now all shown.