m25 basic admin

Version 11.6

Module 25

Basic Administration

Training Manual

AVEVA Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK

PLEASE NOTE:

AVEVA has a policy of continuing product development: therefore, the information contained in this document may be subject to change without notice.

AVEVA MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENT, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

While every effort has been made to verify the accuracy of this document, AVEVA shall not be liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance or use of this material.

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

Copyright 2009 AVEVA Limited

All rights reserved. No part of this document may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of AVEVA.

The software programs described in this document are confidential information and proprietary products of AVEVA Ltd or its licensors.

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

Module 25 Basic Administration Contents-i

Contents

Session 1 ...................................................................... 1-1 Project Access .................................... .......................................................... 1-1

Objectives .................................................................................................. 1-1 Must Know Points ...................................................................................... 1-1 Project Access ........................................................................................... 1-2 Adding Project Environment Variables to the Batch File ............................ 1-5 Starting PDMS ........................................................................................... 1-6

Session 2 .................................................................... 2-1 Creating a new Project ............................ ..................................................... 2-1

Objectives .................................................................................................. 2-1 Must Know Points ...................................................................................... 2-1 Creating a New Project .............................................................................. 2-2 The Admin Module ..................................................................................... 2-3 Teams and Users ....................................................................................... 2-4 Creating Teams .......................................................................................... 2-5 Creating Users ........................................................................................... 2-6 Creating Databases ................................................................................... 2-8 Database Types ......................................................................................... 2-9 UPDATE or CONTROLLED databases ..................................................... 2-9 MULTIWRITE databases ........................................................................... 2-9 Creating Catalogue, Dictionary and Properties databases. ...................... 2-10 Copying Databases .................................................................................. 2-12 Including and Copying Foreign Databases .............................................. 2-12 Copy a Foreign database from the SAM project ...................................... 2-15 Modifying the Admin Elements Form ....................................................... 2-17 Multiple Databases (MDBs) ..................................................................... 2-19

Session 3 .................................................................... 3-1 Testing PDMS Access ............................... ................................................... 3-1

Objectives .................................................................................................. 3-1 Must Know Points ...................................................................................... 3-1 Testing PDMS Access ............................................................................... 3-2

Session 4 .................................................................... 4-1 References Between Databases ...................... ........................................... 4-1

Objectives .................................................................................................. 4-1 Must Know Points ...................................................................................... 4-1 References Between Databases. ............................................................... 4-2 Running Inter database macros. ................................................................ 4-3 Deleting Inter-database Macros ................................................................. 4-4

Contents

Contents- ii Module 25 Basic Administration

Session5 ..................................................................... 5-1 Sharing PDMS, PDMS Projects & Files ............... ........................................ 5-1

Objectives ................................................................................................... 5-1 Must Know Points ....................................................................................... 5-1 Introduction ................................................................................................. 5-2 Sharing PDMS / Files ................................................................................. 5-2 Creating Shortcuts ...................................................................................... 5-4 6.2 Shortcut Arguments .............................................................................. 5-5

Session 6 .................................................................... 6-1 MULTIWRITE Databases............................... ................................................ 6-1

Objectives ................................................................................................... 6-1 Must Know Points ....................................................................................... 6-1 MULTIWRITE Databases ........................................................................... 6-2 Guidelines for Using Multiwrite Databases ................................................. 6-2 Example of MULTIWRITE Databases ........................................................ 6-3 Example of Modifying Items in a Multiwrite database ................................. 6-5 Claim Lists .................................................................................................. 6-6

Session 7 .................................................................... 7-1 Project Administration............................. ..................................................... 7-1

Objectives ................................................................................................... 7-1 Must Know Points ....................................................................................... 7-2 Project Administration ................................................................................. 7-3 Locking the Project Database ..................................................................... 7-3 The Options under Admin on the Main Menu ............................................. 7-4 Abnormal Exits ........................................................................................... 7-5 Display ........................................................................................................ 7-5 The Query Options ..................................................................................... 7-6 The Settings Options .................................................................................. 7-6 The Utilities Options .................................................................................... 7-7 Integrity Checking (See Section 9) ............................................................. 7-7 Sending Messages to other Users .............................................................. 7-8 The Project Options .................................................................................... 7-9 Project Information ...................................................................................... 7-9 Font Families ............................................................................................ 7-11 Introduction to Font Families .................................................................... 7-11 Character Sets .......................................................................................... 7-11 Character Styles ....................................................................................... 7-12 User-defined Fonts ................................................................................... 7-13 Sloping Fonts ............................................................................................ 7-13 Setting Up Font Families .......................................................................... 7-13 Modules .................................................................................................... 7-14 How Modules are Defined ........................................................................ 7-14 The Module Definition Form ..................................................................... 7-14 Setting the DABACON Buffer Size ........................................................... 7-16

Contents

Module 25 Basic Administration Contents- iii

Replicating a Project ................................................................................ 7-17 Deleting Phantom Users/Claim Lists ........................................................ 7-20 The Data Options ..................................................................................... 7-21 Merging Sessions ..................................................................................... 7-21 Backtracking Session .............................................................................. 7-24 Inter-DB Macros ....................................................................................... 7-25

Session 8 .................................................................... 8-1 PDMS Environment Variables ........................ ............................................. 8-1

Objectives .................................................................................................. 8-1 Must Know Points ...................................................................................... 8-1 PDMS Environment Variables .................................................................... 8-2 Loading CATVIEW ..................................................................................... 8-3 Testing CATVIEW ...................................................................................... 8-5

Session 9 .................................................................... 9-1 Data Integrity Checking ........................... .................................................... 9-1

Objectives .................................................................................................. 9-1 Must Know Points ...................................................................................... 9-1 Data Integrity Checking .............................................................................. 9-2 Database Storage Statistics ....................................................................... 9-2 Using DICE ................................................................................................ 9-3 FULL and BRIEF Modes and Maximum Errors .......................................... 9-4 Producing Statistics .................................................................................... 9-4 Checking External References ................................................................... 9-4 Selecting the Output Destination ................................................................ 9-5 Macros ....................................................................................................... 9-5 DICE Output ............................................................................................... 9-6 The Error Report ........................................................................................ 9-8 The Report Summary ................................................................................. 9-8

Session 10................................................................. 10-1 Reconfigure ....................................... ......................................................... 10-1

Objectives ................................................................................................ 10-1 Must Know Points .................................................................................... 10-1 Reconfigure .............................................................................................. 10-2 Intermediate and Dump Files ................................................................... 10-2 Reconfigurer Commands: ........................................................................ 10-3 Example of a Simple Reconfigure ............................................................ 10-6 Example of a Partial Reconfigure ............................................................. 10-7 Example of a Reconfigure Using the SAMEREF Option .......................... 10-8 Converting a Database to be compatible with a New DDL ..................... 10-10

Session 11................................................................. 11-1 Backing up Data ................................... ...................................................... 11-1

Objectives ................................................................................................ 11-1 Must Know Points .................................................................................... 11-1

Contents

Contents- iv Module 25 Basic Administration

Daily Backups ........................................................................................... 11-2 Project Backups ........................................................................................ 11-3

Project Access

Module 25 Basic Administration 1-1

Session 1

Project Access

Vantage PDMS makes extensive use of Environment Variables they are used to define the location of the PDMS software and Projects. In this section we are going to investigate the setting and the location of PDMS Projects

Objectives

At the end of this session you will be able to:

• Add Project Environment Variables

• Start PDMS and access the AVEVA’s SAM Project

Must Know Points

It is important to understand the following points about Project Access

• How to create Project Varables

tringuyen

Typewriter

bao quát

tringuyen

Typewriter

bien

tringuyen

Typewriter

tringuyen

Typewriter

nghien cuu

tringuyen

Typewriter

tringuyen

Typewriter

Project Access

1-2 Module 25 Basic Administration

Project Access PDMS requires four “Project Environment Variables” pointing at four directories, these are set for each project.

Project names are made up using 3 Characters.

For example, for a Project ABC

ABC000 Project database directory.

ABCISO Project Isodraft Options directory.

ABCMAC Project Inter-DB connection macro directory.

ABCPIC Project Draft Picture File directory.

AVEVA supplies three projects on the PDMS CD.

SAM Sample Project (Metric)

IMP Sample Project (Imperial)

MAS Master Catalogue

We are going to test our PDMS installation using the SAM project. The environment variables for the SAM project have been set up in a batch file called “EVAR.BAT” which is held in the PDMS executables Directory.

All Catalogue information for the SAM project is held in the MAS project so the environment variables for MAS have also been set. We will check the settings of SAM000, SAMPIC, SAMISO, SAMMAC, MAS000 and MASPIC.

Normally the MASMAC and MASISO will never be required as no Design or Isometrics will be produced from this project

By default the supplied PDMS projects are held in a project directory under the PDMS executables directory.

Navigate using the File Manager or My Computer to the Project directory, in this example c:\AVEVA\pdms11.6\project

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

He Anh

tringuyen

Typewriter

tringuyen

Typewriter

co the thuc hien dc

tringuyen

Typewriter

tringuyen

Typewriter

dieu hanh

Project Access


You can now see the three AVEVA-supplied Projects

Project Access


Checking the Environment Variables

Navigate to the PDMS executables directory for example c:\AVEVA\pdms11.6

Edit evars.bat

The evars batch file checks to see if the variables are set and if they are not set they are set to the default location.

tringuyen

Typewriter

Project Access


Adding Project Environment Variables to the Batch File

If you wish to locate the project to another location on your network you will need to change the project environment variables.

Modifications or additions to the Project Environment Variables should be made in the PDMS.bat file. This file is normally in the PDMS executables directory.

One way to edit this file is to click on the Run PDMS shortcut with the RH mouse button end selecting EDIT

The following is an example of how these project variables might be set:

SET SAM000=P:\AVEVA\PDMS11.6\PROJECT\SAM000

SET SAMMAC=P:\AVEVA\PDMS11.6\PROJECT\SAMMAC

SET SAMISO=P:\AVEVA\PDMS11.6\PROJECT\SAMISO

SET SAMPIC=P:\AVEVA\PDMS11.6\PROJECT\SAMPIC

SET MAS000=C:\AVEVA\PDMS11.6\PROJECT\MAS000

SET MASPIC=C:\AVEVA\PDMS11.6\PROJECT\MASPIC

This should be placed in PDMS.bat after the after @echo off line

PDMS makes extensive use of environment variables and more of these are explained in Session 8.

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

Project Access


Always make modifications to environment variables in the batch file, do not include them as system variables as this may create conflicts between PDMS versions.

Starting PDMS

Double click on the Run PDMS Shortcut

Or Start > Programs > AVEVA > VANTAGE PDMS 11.6 > Run PDMS

Creating a new Project


Session 2


Objectives

At the end of this session, you will able to:

• Creating a new Project

• Creating Teams

• Creating Users

• Creating Databases

• Creating Catalogue, Dictionary and Properties databases.

• Copying Databases

• Including and Copying Foreign Databases.

• Multiple Databases (MDB’s)

Must Know Points

The following points need to be understood by the trainees.

• Project Environment Variables

• Creating a new Project

• Creating Teams & Users

• Creating Databases including, Catalogue, Dictionary and Properties databases.

• Copying Databases

• Including and Copying Foreign Databases.

• Multiple Databases (MDBs)

tringuyen

Typewriter



Creating a New Project

For this example we are going to create a new project called TAD

1. Create four project directories, TAD000, TADPIC, TADMAC and TADISO.

2. Add the Project variables to both PDMS.bat and Make.bat via the Shortcuts.

3. Run the Make a PDMS Project ‘Start > Programs > AVEVA > VANTAGE PDMS 11.6 > Make PDMS Project’

4. Enter the 3 letter Project name TAD you will see an asterisk * command prompt

5. Run the Utility makemac.mac by typing: $m/%pdmsexe%/makemac.mac

You will see messages similar to the ones shown below :

6. FINISH

The new PDMS database directory TAD000 will now contain three system databases, TADSYS, TADCOM, and TADMIS.

At versions of PDMS prior to PDMS 11.4.SP1 virgin databases would have been copied from the %pdmsexe% directory this practice has stopped and the virgin databases are used directly from the %pdmsexe% directory.

Note : The variable %pdmsexe% will have been set to point at c:\AVEVA when we installed PDMS.

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter

tringuyen

Typewriter



The Admin Module

You can now enter the new project.

Double click the Run PDMS Shortcut

Select Project TAD

Enter Username SYSTEM

Enter PDMS Default Password(XXXXXX)

Select ADMIN

Load from Macro Files (this will be the only option)

OK

Note: You do not need a MDB to be set to go into Admin.

Free Users, Like System are NOT shown on the Username pull down.

The Admin default screen will now be displayed.

It would be normal practice at this point to change the system password (SYSTEM/XXXXXX) to a new one for security reasons.

For the purposes of this Training Manual we will be changing it later during User Modification.



Teams and Users

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 PDMS.

Users are normally members of Teams. Any user belonging to a Team will have write access to the databases owned by the Team.

For the Training Example we will create the following Teams and Users:

Team User/Password Owning the database(s) Type

CATA CATA/CATA CATA/PIPE CATA CATA/STEEL

PIPEN PIPEN/PIPEN PIPEN/DESIGN DESI

PIPES PIPES/PIPES PIPES/DESIGN DESI

STEELN STEELN/STEELN STEELN/DESIGN DESI

STEELS STEELS/STEELS STEELS/ DESIGN DESI

DRAFT DRAFT/DRAFT DRAFT/DRAFT PADD

ISO ISO/ISO

ADMIN ADMIN/ADMIN ADMIN/DICT DICT

ADMIN/PROP PROP

In addition, the following Teams and Users will be needed for the administrative functions:

Team User/Password

PARAGONADMIN PARADM/PARADM

DESIGNADMIN DESADM/DESADM

DRAFTADMIN DRAADM/DRAADM

ISOADMIN ISOADM/ISOADM



Creating Teams

1. On the Admin Elements Form Select Elements Teams

2. Select the Create Button

3. Type the Team Name CATA

4. Description Team for Project Catalogue

5. Select Apply

6. Continue to create all the Teams as described above.

7. Modify the description of team MASTER by selecting Modify and then select Team master on the Admin Elements Form

8. Dismiss the Modify Team Form



You should now have the Teams as shown below:

Creating Users

1. On the Admin Elements Form Select Elements USER




3. Type the User Name CATA

4. Password CATA

5. Security Select GENERAL (see note below)

6. Description User for Project Catalogue

7. Select Project Team CATA and add to Membership Using the Arrow.

8. Select Apply

Note: The use and setting up of User Access Contro l Rights is covered

on the Advanced System Administrators Course and wi ll be left Blank.

9. Continue to create the Users ADMIN, DRAFT, PIPEN, PIPES, STEELN and STEELS as described above. Remember to select the appropriate Team

10. Modify the description and the password of the User SYSTEM by selecting Modify and then select <User> SYSTEM on the Admin Elements Form. Form this exercise change the SYSTEM password to TAD

11. Dismiss the Modify User Form

You should now have the Users as shown below:

Database access depends on attributes of the User and of the Database

Users can be:

FREE Users

May enter all modules. May update any databases.

GENERAL Users

May not enter the Restricted modules, which are usually the administration modules of ADMIN and LEXICON. May only modify databases for teams of which they are members.

Note: User privileges also control access to modules.



Creating Databases

1. On the Admin Elements Form Select Elements Databases & Extracts


Note: The use and creation of Extract Databases is covered on the Advanced System Administrators Course.

3. Select Master DB and OK

We will first create a Design Database for PIPEN.

4. Select Team PIPEN

5. Name DESIGN

6. Description North Area Pipes

7. Select Database Type Design

(The explination of Database Types is described Below)

8. Access Mode Update, Implicit Claim.

(The explanation of Access Modes is described Below)

9. Area Number, DB Number and File Number for this example should be left at System.



10. Select Apply

11. Continue to Create Databases for Teams PIPES, STEELN, STEELS.

12. Create a Draft database for Team DRAFT, remember to change the database type to DRAFT.

Database Types A PDMS project can contain the following types of database:

Administration databases

The SYSTEM database itself, which holds the access control data for the model data and modules.

The COMMS database, which stores information about who is using which module and which model databases are available.

The MISC database which stores inter-user messages, and inter-database macros.

Model Databases

DESIGN databases which contain all the design information for the project.

CATALOGUE databases which contain the project catalogue and specifications.

PADD databases which contain data about drawings produced by DRAFT.

ISOD databases which contain spool drawings produced by SPOOLER.

PROPERTIES databases which can contain material properties, and can be referenced by the catalogue.

DICTIONARY databases which contain the definitions of user-defined attributes (UDAs), as set up in LEXICON.

COMPARATOR databases which are used by Design Manager. (You may not be licensed to use this product, in which case this type of database will never be used.)

Databases can be:

UPDATE Allow one writer and n readers.

CONTROLLED Allow one writer and n readers, the same as UPDATE. Write access is controlled externally to PDMS.

MULTIWRITE Allow n writers and m readers.



UPDATE or CONTROLLED databases It is best to create a database for each user. Each user will then have write access to the owned database, and read access to any other databases required.

MULTIWRITE databases The use of Multiwrite databases is explained later in Session 6.



Creating Catalogue, Dictionary and Properties databases.

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 PDMS DB Number. Database numbers must be unique within PDMS.

The Catalogue supplied by AVEVA has the PDMS DB Number in the 7000 range.

Create the Catalogue, Dictionary and Properties databases in the 5050 range.

If there is a conflict in DB numbers it would need to be resolved using Reconfigure.

1. On the Admin Elements Form Select Elements Databases


3. Select Team CATA

4. Name PIPE

5. Description Project Pipe Catalogue

6. Database type Select Catalogue

7. Access Mode Update, Implicit Claim.

8. Area Number and File Number for this example should be left at System.

9. Set DB Number 5050

10. Select Apply

11. Create databases CATA/STEEL (5051) Catalogue, ADMIN/DICT (5052) Dictionary,

ADMIN/PROP (5053) Properties.



You should now have the following databases defined.

You can use the Modify button to change the database names should you require.

Database access is controlled by the Team so by changing the Team of a database user access can be changed.



Copying Databases

Copied databases can be used for:

• Copying a template project

• Merging projects

• Copying included databases before archiving Databases can be copied by selecting Database from the Element option button on the Admin Elements form, selecting the element you want to copy from the scrolling list, and then pressing the Copy button. The Copy Database form will be displayed.

Note that you cannot change the Database number of the copied database. This will be same as the original. You cannot have more than one database with the same database number in the same MDB.

Note : 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.

Including and Copying Foreign Databases

You can copy Databases from other projects. Databases can also be shared between projects, which saves disk space and eliminates errors which 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, you must be able to read from the second project directory, and have the environment variables for the second project set.

When you create a Project that is going to share databases from other Projects, there are two important considerations:

• 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.

Note that Foreign Databases are marked with * in the database list.

You can exclude foreign Databases by pressing the Exclude DB button on the Admin Element form. The ExcludeDb form will be displayed



You can also include databases from the sample project, Using the options under Install on the main menu These options are as follows:

Sample Project >

Foreign Master dbs sets pointers to all the MAS databases in the Sample project Local Master dbs copies all the MAS databases in the Sample project to the local directory

Foreign Master dbs

The options allow you to set pointers to individual databases in the MAS project.

Local Master dbs

The options allow you to copy individual databases in the MAS project to the local directory

Deleting Databases

Databases can be deleted by selecting the element from the scrolling list on the Admin Elements form and then pressing.

Note : 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.

Using Different Areas

The Area Number will accept values in the range 1 to 9. If the value is set to System (using the button next to the gadget) then the database area will be set to the system default (0).

Note : The environment variable for a database’s area must exist when the database is created or moved.

To complete the database additions on our example project we are going to include all the databases for the MAS project and copy a database from the SAM project.



To include all the databases from MAS Select

INSTALL > Foreign Master DBs > All

This command will have included most of the databases from MAS the rest will need to be included manually.

You can see on the form below that all foreign databases are indicated with an asterisk *

To include additional databases from MAS

1 On the Admin Elements Form Select Elements Databases

2 Select the Include Button



3. Select MAS project

4. Username SYSTEM

5. Password XXXXXX

6. Select the foreign Databases MASTER/COMP

7. Select Apply

8. Repeat the process for the rest of the foreign databases

Copy a Foreign database from the SAM project

1. On the Admin Elements Form Select Elements Databases

2. Select the Copy Foreign Button

3. Select the SAM Project

4. Username SYSTEM }

} Default

5. Password XXXXXX }

6. Foreign Databases ADMIN/PADD

7. Team ADMIN

8. Database Name PADD



9. Select Apply

10. You should now have the following databases defined: -



Modifying the Admin Elements Form

We are going to modify the Admin Elements Form to include the Database File Name and the Database access mode.

Select Settings > Display Mode > Setup Admin Elements Form

Tick Access and Filename

Select Apply and Dismiss

You may now wish to resize the Admin Elements From

Select Settings > Display Mode > Resize Admin Elements Form

Set the size to 70, Apply and Dismiss



The Admin Elements Form will now look like this. It may also require stretching by dragging the bottom right corner hand corner of the form.



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 data that the user needs to access. For example, for a DESIGN user, the MDB must contain a Catalogue database and the Design database 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, and all other DESIGN databases which will have connections to the user’s design area.

Many users can access the same MDB. There are different ways of allowing access to MDBs: some options are described below:

1. One MDB per User. The DB with write access must be the first DB of that type (DESIGN, DRAFT, etc.) in the MDBs list of members. This option may be suitable for large projects with many DBs and Users.

2. One MDB with many users. In this case, the System Administrator can create the first-level elements in the DB, for example, Sites or Departments, which avoids having to use the DEFER and CURRENT options to move the required database to the top of the list. This option is often suitable for small to medium projects with few DBs and Users.

3. MDBs for special purposes. For example, an MDB containing Piping data only for MTO production, etc

An MDB may contain up to 1000 databases. However, only 300 of these (known as the current databases) can be accessed at any one time. The other databases are deferred. 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 is important.

Note : An MDB can only contain one database with a given DBNO. Two databases will have the same DBNO if one has been created as a copy.



For the Training exercise we are going to create six MDBs, PIPEN, PIPES, STEELN, STEELS, DRAFT and CATA.

These MDB will be used by each of the associated users as described earlyier.

1. On the Admin Elements Form Select Elements MDBs


3. Enter the name of our first Pipe user PIPEN

4. Description North Pipes MDB

5. Sort By Number

6. Select Project Database PIPEN/DESIGN

7. Use the down arrow to move PIPEN/DESIGN to the Current Databases field.

8. Select Insert AFTER

9. Highlight PIPEN/DESIGN in the Current Databases



10. Select all the Project databases (RH mouse button in Project Database window )

11. Change Insert from Before to After and press the down arrow.

12. Select Apply

13. Continue to create MDBs for the other users. (remember you could use copy)

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.



You should now have the following Multiple Databases.

At this point we will go into PDMS Design as different users and check that we can create items and see items created in other databases.

Testing PDMS Access


Session 3

Testing PDMS Access

This session tests that you are able to create Equipment and Pipes in PDMS using multiple User Names.

Objectives


• Create Equipment as PDMS User PIPES and create Pipes as PDMS User PIPEN

Must Know Points


• How to enter PDMS as different Users.

Testing PDMS Access


Testing PDMS Access

1. Enter PDMS as User PIPES

2. Create a Site, Zone and 2 Pieces of Equipment containing at least 1 Nozzle each.

3. Enter PDMS as User PIPEN

4. Create a Site, Zone and a Pipe that connects the 2 Nozzles created earlier.

5. Savework

An Inter database macro will have been created as the Pipe is in a different database to the equipment.

References Between Databases


Session 4


This module explains the relationship between databases and the use of Inter database connection macros.

Objectives


• Understand the use of Connection References

• Running Inter database macros

Must Know Points

The following points need to be understood by the trainees. • Run and Delete Inter database macros



References Between Databases.

When you connect Branches PDMS sets the Head Reference (HREF) or the Tail Reference (TREF) to the Item it is connected to, for example 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 you have write access to the connected component it just connects and sets the relevant connection references. If you don’t have write access an Inter-database connection macro is created.



Running Inter database macros.

1. Enter PDMS Monitor as User PIPES

If you have any Inter-database macros to run there will be a message in Monitor highlighted in red:

You have Inter-DB Macros to run

To find out there names Select Project > Inter-DB Macros

As you can see we have one macro to run, make a note of the name and enter Design.



Before we run the Inter-DB macro go to one of the Nozzles we build earlier and query the CREF, it should be Nulref (=0/0).

The Inter-database macros are run via the command line.

Display the Command Line Display > Command Line

The variable %tadmac% points to the Inter-database macro directory that we set up earlier.

The CREF attribute of both Nozzles will now have been set.

Deleting Inter-database Macros

The Inter-database macro can now be deleted in Monitor

1. Design > Modules > Monitor

2. Project > Inter-DB Macros

3. Select the Macro

4. Select Delete Macro


Session5

Sharing PDMS, PDMS Projects & Files

This session explains how PDMS and the PDMS databases can be shared between more that one Designer. The installation of PDMS and the use of Shortcuts to gain access to PDMS are also discussed.

Objectives

At the end of this session, you will become familiar with:

• Sharing PDMS / Files

• Creating Shortcuts

• Shortcut Arguments

Must Know Points


• How to share files between computers.

• Creation and use of Shortcuts



Introduction

If you have more than one user who wishes to access PDMS it will be necessary to share PDMS and the databases across a Network of computers.

The Installation of PDMS can be performed in two ways:

1. A full version of PDMS on each PC

2. A client version of PDMS on each PC

For the purposes of this training we are going to assume that the required version has been installed on the PCs.

Sharing PDMS / Files

For this exercise we are going to share c:\AVEVA this will give us network access to PDMS and the TAD project.

1. Navigate to the c:\ drive using the file manager or My Computer

2. Select the AVEVA Directory using the RH Mouse Button.

3. Select Sharing

1. Select Shares As

2. Share Name AVEVA

3. Select OK



You will now be able to see the AVEVA directory via Network Neighbourhood. (Network Neighbourhood on NT or by using My Network Places on W2000)

In the following example the PC name is PC517.

Navigate to Network Neighbourhood using the File Manager or Network Neighbourhood.

The network name of this directory will be \\pc517\AVEVA.

We will now need to modify the PDMS batch file and replace any references to the

c: drive with pc517.

Remember to change the pdms_installed_dir variable



Creating Shortcuts

For the purposes of this Training move to another PC, Login and navigate to the PDMS executable directory using Network Neighbourhood or the File Manager.

Select PDMS.bat with the RH Mouse Button and Select Create Shortcut.

Drag this Shortcut to the Desktop.

The Start in: directory should be changed to point to a User Directory as this is the place that PDMS will place output files. I should not be left as the PDMS executables directory.

Modify the Properties of the Shortcut by selecting Properties via the RH Mouse Button

To change the icon to the PDMS Logo

1. Modify the Properties of the Shortcut by selecting Properties via the RH Mouse Button

2. Select Change Icon



Browse the network and Select des.exe from the PDMS executable directory

3. OK all the forms and you will now have the new Icon.

4. Modify the Start up directory to point to a local drive for example c:\userdata or c:\temp

5. Rename the shortcut via the RH Mouse Button to say PDMS 11.6

You can now test this shortcut.

6.2 Shortcut Arguments

PDMS allows the use or arguments on the command line to, for example enter Design on project TAD

Modify the Shortcut and add PROJECT USER/PASSWORD MDB Module.

The module name could be replaced by a macro $m/start.mac etc.

You may wish to rename the Shortcut to reflect the Project and user.


Session 6

MULTIWRITE Databases

This module explains the use and creation of Multiwrite databases.

Objectives


• Understand the use of MULTIWRITE Databases

• Create Multiwrite databases

• Modifying Items in a Multiwrite database

• Claim Lists

Must Know Points

• The following points need to be understood by the trainees.

• How to Create Multiwrite databases.




DESIGN, CATALOGUE, DRAFT (PADD) and ISODRAFT databases can be multiwrite. The SYSTEM database is always multiwrite.

For multiwrite databases, it is better to split the database content according to the different team responsibility. This will normally be determined by:

• The physical layout of the plant.

• The different engineering disciplines involved.

Databases may be switched between UPDATE and MULTIWRITE at any time.

One recommended way of working is to start with an UPDATE database for each user. This keeps a tight control on the write access. Then if a particular database requires intensive work at some stage in the project, the database can be switched to multiwrite to allow several users to make the required changes simultaneously.

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.

Guidelines for Using Multiwrite Databases

• Use Conservatively

• Keep interactive usage levels to 10 or fewer per database.

• Use implicit claim mode.

• In Design, Draft and Paragon, keep data collected on a discipline basis, have a Pipe database, a Steel database etc.

• Maintain the concept of a graphical split.

• Apply the same guidelines in Draft and Design.

• Use one Team with Multiple Users

• Do NOT enter PDMS more that once with the same name from different workstations.



Example of MULTIWRITE Databases

For this example we are going to modify one of our existing Design databases to be MULTIWRITE.

1. Enter PDMS Admin

2. On the Admin Elements Form Select Databases

3. Select PIPEN/DESIGN

4. Select Modify

5. Change Access Mode to Multiwrite, Implicit Claim

6. Select Apply

7. Select Dismiss

When you use Implicit Claim if you modify an item you claim the Item for modification.

This mode must be used as some applications may not be set up to claim items before modification.



Remember write access to a database is controlled b y being a member of the Team.

Modify User PIPES and give them membership of Team PIPEN.



Example of Modifying Items in a Multiwrite database

1. Enter Design as User PIPES

2. Modify the Pipe created in the earlier session by User PIPEN.

Remember in update mode you would not be able to modify this pipe as it would be in a read only database.

As the database containing the pipe is in a Multiwrite database we are able to modify it.



Claim Lists

Select Utilities > Claim Lists

When working in Implicit Claim mode, each time you modify an item in Design the significant Item, Bran, Equip etc is added to the Claim List.

For standard Multiwrite databases Claims can be release manually using Unclaim and are released automatically when the Designer leaves PDMS. If the designer leaves PDMS abnormally the items will remain claimed.


Session 7

Project Administration

This module is an overview of the options on the main ADMIN menu. They are described in the order in which they appear on the menu, reading from left to right. Some of the simpler options are described in full, and some of them have references to other modules, where they are described in more detail.

Objectives

At the end of this session, you will be familiar with:

• Locking/Unlocking the Project Database

• Admin Options

• Display Options

• Query Options

• Settings Options

• Utilities Options

• Project Information

• Understand the use of Fonts in PDMS

• Set Up Font Families

• How Modules are Defined

• The Module Definition Form

• Setting the DABACON Buffer Size

• Replicating a Project

• Deleting Phantom Users / Claim Lists

• Merging Sessions

• Backtracking Sessions

• Inter-DB Macros



Must Know Points


• Locking/ Unlocking the Project Database

• How to set the Imacro

• Deleting Phantom Users / Claim Lists

• Merging Sessions

• Backtracking Sessions




This Chapter is an overview of the options on the main ADMIN menu. They are described in the order in which they appear on the menu, reading from left to right. 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.

Locking the Project Database

The Project Database can be locked using the Lock button at the right of the Main ADMIN menu. Locking has no effect on users already accessing a project; but it will prevent other people from entering the project until the project is unlocked.

Locking the project may be necessary, for example, to allow a release of newly approved data or to incorporate new versions of the PDMS modules.

You should always Lock the project before carrying out database modifications.



The Options under Admin on the Main Menu

The options under Admin on the main menu are similar to corresponding options in other PDMS modules.

Selecting Admin > Savework will save all changes to the System database.

Selecting Admin > Getwork Refresh view of System database.

Selecting Admin > Session Comment will display the Session Comment form. You can enter text to identify the changes made in your current session. You can see details of previous sessions by using the gadgets on the form to move through the sessions. See the online help if you need more information.

Selecting Admin > Modules displays a submenu from which you can select the module you want. For the GUI modules, you can choose to load from binary files or macro files. See the online help if you need more information.

Selecting Admin > Exit will save changes to the System database and exit from PDMS.

Note: You cannot QUIT (that is, exit without savin g changes) from ADMIN. This is to ensure that there are no inconsistencies betw een the actual database files and the record of the databases in t he Project stored in the System database.



Abnormal Exits

If you exit abnormally from ADMIN, for example because of a power failure or system crash, and you list the database files in the operating system, you may see files with a .deleted extension. This is because when you do any task that involves deleting a database file in ADMIN, PDMS copies the file to be deleted to a new file with the .deleted extension.

When you SAVEWORK, or exit normally which automatically does a SAVEWORK, the .deleted files are removed. However, 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, PDMS will rename the .deleted files, removing the extension, so that the files will still be available.

Display

Selecting Display > Admin Elements will display the Admin Elements form, if it has been closed.

Selecting Display > Command Line will display the Command Input and Output window.



The Query Options

The options under Query on the main menu allow you to query information about the current user, and list information about any Team, User, Database or MDB.

See the online help if you need further information about these forms.

The Settings Options

The Settings > Display Mode options allow you to modify, save and restore the display of the Admin Elements forms.



The Settings > Change Password option allow you to set whether or not users can change their passwords. If you select Enabled , users will see a Change Password option on the menu on the main Session Manager window, which will allow them to change their passwords. Otherwise, a password can only be changed within ADMIN.

The Utilities Options

Integrity Checking (See Session 9)

This option displays the Data Integrity Check form. The PDMS Data Integrity Checker (DICE) is described in Session 9 of Administration Module 25.



Sending Messages to other Users

You can send messages to other users by selecting Utilities > Send Message . Send Message form will be displayed.

You can send a message to one of the following:

• An individual user

• All members of a specified team

• All active project users

The message will be displayed only to users already in PDMS when the command is given, and then only when they change modules or leave PDMS.

You can list messages. A message is automatically deleted once it has been displayed.

(Messages are only displayed in a System Command Window and could be missed, this is an old feature, it may be better to use e-mail)



The Project Options

The options under Project on the main menu are as follows:

• Information allows you to add descriptive information about the project.

• Font Families allows you to set the fonts used in DESIGN and DRAFT.

• Module Definitions allows you to change the PDMS module definitions.

• Replicate allows you to replicate the project structure. See later in this Module.

• Expunge allows you to remove phantom users from the Project after an abnormal exit.

• Data Access Control allows you to turn on Data Access Control this is covered on Advanced System Administrators Course. Turning on DAC by default will remove all access to PDMS

Project Information

You can add descriptive information about the Project by selecting Project > Information from the Main Menu. The PROJECT Information form will be displayed.

You can set the Name, Description , Message and Number . The maximum numbers of characters are 119 for Name, Description , and Message , and 16 for Number .

If set, these details are displayed each time the PDMS project is entered. They can be reset in ADMIN at any time.



Change the Project information as Indicated above, and go into Monitor to see the effects.

You could also query the Project information

Q PROJ

Q PROJ Num



Font Families

The System database stores details of four font families , numbered 1-4. These families may be defined using ADMIN itself, or the commands can be included in the makemac.mac macro used to create the project. All four families are used by DRAFT, but only the first is used by the other graphical modules.

Note that all PDMS font files have the suffix .gfb .

Introduction to Font Families

A font family combines a character set with a character style .

Character Sets

A character set is specified by name or by a CADC code number derived from its International Registration (ISO-IR) number or from its ISO 8859 part number. The available character sets are:

Name Code Description

Latin 1 885901 ISO 8859-1 Latin alphabet No. 1

Latin 2 885902 ISO 8859-2 Latin alphabet No. 2

Latin Cyrillic 885905 ISO 8859-5 Latin/Cyrillic alphabet

UK 4 Standard UK ASCII (ISO 646 Reg 4)

US 6 Standard US ASCII (ISO 646 Reg 6)

Greek 18 ISO 2375 Registration 18

Cyrillic 37 ISO 2375 Registration 37

The ISO 8859 sets contain all the characters of the standard US ASCII set plus ranges of extra punctuation marks, symbols, accents, accented characters, and combined characters.

Latin-1 provides additional characters for the following languages:

Danish Dutch Faroese Finnish French Icelandic Irish Spanish German Norwegian Portuguese Swedish. Italian

Latin-2 provides additional characters for the following languages:

Albanian Czech German Hungarian Polish Rumanian Serbo-Croat Slovak Slovene



Latin/Cyrillic provides additional characters for the following languages:

Bulgarian Byelorussian Macedonian Serbo-Croatian Ukrainian Russian

Character Styles

The character styles are also specified by name or code number. The available styles are:

Name Code

Line 1

Block 2

Serif 3

Italic 4

Script 5

Typewriter 6

UWLine 7 (Uniform Width Line)

Styles 1 to 5 are proportionally spaced, that is the spacing of the characters varies depending on the characters.

Styles 6 and 7 have fixed spacing and so 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.



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 PDMS 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 PDMS Software Developer's Kit. For details contact your local AVEVA Support office, listed on the copyright page of this manual.

Sloping Fonts

For each font family, you 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).

Setting Up Font Families

Select Project > Font Families from the main menu and the Font Family form will be displayed.



The Font Directory sets the directory where the font files are stored.

The Current Font Settings show the four fonts that are available. It shows whether they are System-defined or User-defined, the character set (Type) and style.

You can change the definition of the font selected in the list by changing the settings on the rest of the form.

Modules

The modules are set up in the supplied product, and you will not normally need to create or edit module definitions in order to run PDMS. The only part of the definition that you may wish to change is the initialisation macro (imacro ), which is run on entry to the module. The initialisation macro typically contains module-specific commands to set up the screen display, including loading application macros.

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 security for the module:

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 Users Free modules can be accessed by any User.

The runfile .

The initialisation macro (imacro ), which is run on entry to the module

The Read/Write access to database types. For example, DESIGN needs Write access to DESIGN database, but Read access to Catalogue databases.

The buffer size

The Module Definition Form

The Module Definition form is displayed when you select Project > Module Definitions from the main ADMIN menu bar. This form allows you to create and edit modules definitions for the current Project.

The Modules window lists the PDMS Modules.

The Sort by gadget controls the order of modules displayed in the list.

The Copy button displays the Copy Module form. This form allows you to create new Modules by copying existing Module definitions. This form allows you to specify the Number and Name of the new Module.

Delete deletes a Module definition from the Project. You will no longer be able to use the Module in the current Project, unless you re-define it.



The Settings window displays the settings for the Module selected in the modules List. You can change all of these except the Number and Name.

Security can be set to Restricted , General or Free.

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.

A typical value as used in the Design Module would be %PDMSUI%/des/ADMIN/START.

The Advanced button displays the Advanced Module Settings form. This form allows you to set the buffer size (see next section), the default database type and access for the Module.

Note : Changing the options on this form may cause serious problems when using PDMS. The form is for expert use only.



Setting the DABACON Buffer Size Each module definition in the System DB may include a BUFFER command. This command specifies how much space is to be reserved for the DABACON Buffer in each module, and allows the database constructor to trade off CPU usage against disc I/O to some extent and thereby optimise computer efficiency in some of the more heavily used modules. The limitations on buffer size are 1280K words (maximum).

Experiments at a customer site suggest that the maximum of 12 800 000 words is the most appropriate settings for most situations.

We will change the setting for Draft and Design

Select the DRAFT Module and Advanced Settings

Change the Buffer Size to 12800000 and Apply

Repeat the process for Design



Replicating a Project The Project > Replicate options enable you to replicate the whole project, including all the data, or just the structure of the project. The Project Data option copies the current Project to a new Project. Before you use this option, you must create the project directories and set the environment variables for the copied project. Then enter the new project code on the Replicate Project form. Note : A project must not be replicated outside PDMS 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. Before you can use this option it will be necessary to create the four environment variables and the project directories a s described earlier. For the exercise, create a PDMS Project called TCP. Remember to create the project variables and associated directories for TC P000, TCPPIC, TCPMAC and TCPISO adding them to the PDMS batch file. 1. Select Project > Replicate > Project Data

2. Enter the Project Code TCP 3. Select OK



The Project Structure option creates a macro which can be run into PDMS to replicates the structure of the current project. No data is copied. When you select this option, a file browser is displayed so that you can give the pathname for the macro. 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 In this example we are going to create a macro to replicate the project structure. 1. Select Project > Replicate > Project Structure

2. Select the Required file name ReplicateProj.mac 3. Select OK

This macro is often used as the basis for creating all new projects and is customised by each company to suit their requirements.



The following is an example of the Replicate Project Structure macro.

It may be necessary to edit this file to modify User Name and Passwords.



Deleting Phantom Users/Claim Lists From time to time a user may exit from PDMS abnormally, for example if there is machine failure or if a system fault occurs. An abnormal exit may leave phantom users in PDMS.

The Project > Expunge > All Users option will remove all phantom users from the system. You will be prompted to confirm that this is what you want to do.

The Project > Expunge > User Processes option will display the Expunge form. The current process is shown by an asterisk. ADMIN will not let the Current User be expunged.



The Project > Expunge > Claimlist option will display the Expunge Database Claim List form.

The Data Options

The Data options on the main menu are as follows: The Data >Change Management options allow you merge and backtrack PDMS sessions. The Data >Inter Db Macros option allows you to manage the macros generated by PDMS when a User needs to write to a database to which the User does not have access. The Data > Extract Databases Control this is covered on Advanced System Administrators Course. Merging Sessions PDMS sessions enable a history of changes to the database to be recorded. When a new session is made, the changed data is appended to the end of the database file. Appending updated data to files will increase the disk space required. If the history information is not required, and to save disk space, you can compact a database by merging sessions. You can specify that the changes before or after a given date or session number will be merged.



For example, there may be a session, which corresponds to a project milestone, which you need to keep, in which case you can merge the sessions around this. In other cases you may wish to merge all sessions before a given date or within a given week. 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.

You can merge the changes to All Project Databases , the System databases , or the Single Project database selected in the list. If you choose All Project databases , you can merge all changes, or changes before or after a given time, date or session number. If you choose System Database , you can merge changes before or after a given time, date or session number.



If you choose Single Project database , choose a database from the list. Note that the More button is now available. This will display the Database Sessions form, which lists information about the existing sessions for the database.

The following example all the changes have been merged.

As you can see all the sessions have been merged and the database size will have been reduced. This would normally only be done after getting a project archive. The Rebuild list button is used to update the list of databases. For example, 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 pressed.



Backtracking Sessions You can return a database to the state it was in at a previous session, you can backtrack using the Data > Change Management > Backtrack Changes option on the main ADMIN menu. The Backtrack Changes form will be displayed. Select the database required from the list. You can backtrack changes by specifying a time, date or session number. Note : Subsequent sessions will be lost, and so you may wish to copy a 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. For example, 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 pressed.



Inter-DB Macros Any Inter-DB macros can be displayed by selecting Data > Inter-db Macros from the Main ADMIN menu. The Inter-db Macro form will be displayed. A macro can be deleted by selecting it in the scrolling list and pressing Delete . This allows the Administrator to delete any macros, not just the macros for the current Team. Remember Inter-DB macros are created in the following situations: A user in DESIGN attempts to make a connection to an element which is in a Design database to which the user does not have write access, A user in DESIGN attempts to make a connection to an element which is 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. The Administrator would normally check the project users before deleting Inter-DB macros.


Session 8

PDMS Environment Variables

We have seen the use of “Project Environment Variables” ABC000, ABCPIC, ABCISO and ABCMAC that are used to point at out projects. PDMS make extensive use of these variables.

The PDMS installation guide has a full list of these variable and there uses.

The following section describes the use and modification of some of these variables

Objectives


• Modify PDMS Environment Variables

• Load CATVIEW

• Test CATVIEW

Must Know Points


• Understanding of the basic use of Environment Variables.



PDMS Environment Variables We have seen the use of “Project Environment Variables” ABC000, ABCPIC, ABCISO and ABCMAC that are used to point at out projects. PDMS make extensive use of these variables.

The PDMS installation guide has a full list of these variable and there use.

The following section describes the use and modification of some of these variables.

Environment Variable “PDMSWK”

When you are working in PDMS you are effectively working on a copy of the data. The data is only written back when the user does a Savework or Exit.

PDMS uses a work area directory that is normally local on the PC this directory is described by the Environment Variable PDMSWK, for example

Set PDMSWK=C:\TEMP

This variable should be set in the PDMS.BAT file, note there should be no spaces at the equal sign.

Environment Variable “PDMSUSER”

PDMS makes use of the Environment Variable PDMSUSER to place its reports etc.

It is often nice to have this variable set to the same as the Shortcut “Start in” directory and should be local on the PC.

You will need to create a directory C:\PDMSUSER

Set PDMSUSER=C:\PDMSUSER

This variable should be set in the PDMS.BAT file, note there should be no spaces at the equal sign.

Change the PDMS Shortcut “Start in” to be C:\PDMSUSER

Environment Variable “PDMSUI”

The Environment Variable PDMSUI points at the PDMS User 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. PDMS will find the files in the search path, in the search order.

This facility can be used to customise PDMS, modified Forms, Menus or Macros can be placed in a parallel directory structure and PDMS will find these modified files first.

The default setting for PDMSUI is

SET PDMSUI=%PDMSEXE%\PDMSUI



In our example this would be c:\AVEVA\pdms11.6\pdmsui

If you have a look in this directory you will see a structure where Des holds the Design Interface, Dra holds the Draft Interface, Iso holds the Isometric interface etc.

For the purposes of this training we are going to load CATVIEW 11.3 (This is the current version).

CATVIEW is used by the “Cats and Specs people” to help them create Piping Specifications.

Loading CATVIEW

1. Locate CATVIEW on the PDMS CD.

2. Install CATVIEW to the AVEVA directory.

e.g. c:\AVEVA (or \\pc517\AVEVA for server installation)

A batch file is provided to point PDMS at this extra User Interface, this batch file will require modification to suit your system.

3. Navigate to the CATVIEW directory you have just installed.

4. Edit the file evars.bat

Make sure that the catview variable points to the correct location of Catview.

For example -

set catview=c:\AVEVA\catview11.6



Modify the PDMS.BAT file and include the line

call c:\AVEVA\catview11.6\evars.bat

after the line -

call %pdms_installed_dir%\evars %pdms_installed_dir%

The modified section of the file would now look like this.



Testing CATVIEW

Enter PDMS Module PARAGON and enter the Pipework application

Select Utilities > Catview

Select Catview > Browse

Display one of the Components.

Cats and Specs are the subject of a separate course.


Session 9

Data Integrity Checking

This chapter describes the PDMS Data Integrity checker known as DICE. DICE checks the internal structure of a database.

Objectives


• Use DICE

• Use FULL and BRIEF Modes and Maximum Errors

• Producing Statistics

• Checking External References

• Format DICE Output

Must Know Points


• Interrogate Dice Report for Errors




This chapter describes the PDMS Data Integrity checker known as DICE. DICE checks the internal structure of a database. The main checks are:

• Is the complete data hierarchy intact? For example, 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 a deleted database.

• If the answer to any of these questions is no, a message will be output, either to your screen or to a named ASCII file in your working directory.

• DICE also tells you how many elements are stored.

The most probable causes of database corruption are:

• An error in the network, resulting in loss or non–arrival of data.

• An error on copying databases. In particular, this can lead to truncated databases.

• Insufficient disk space or storage quota, so that the project area fills up while a database is being updated.

• Deletion of a DB which is referenced from another DB.

• Reconfiguration of a DB without a corresponding update of all DBs which have references pointing into it.

• An undetected fault in the PDMS 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 fast 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, for example, before a daily backup is taken. DICE should be run at least once a week.

Database Storage Statistics

During the checking process, DICE can output statistics the contents of the database, with very little extra resource usage.

The following statistics can be produced:

• The total number of elements in the DB

• The number of referenced names in the DB



Preparatory Steps before Checking Starts

A summary of most of the project information stored in the System DB can be obtained by using the Query options. This may be helpful when deciding which DBs need a detailed check.

Although DICE can never alter the contents of a DB which it is checking, it always accesses the DB in Read/Write mode, to prevent anyone using the database while it is being checked. You cannot, therefore, check any DB which is in use elsewhere.

You can use the Query options to see which other users are currently accessing the project, which DBs they are using, and what their access mode is to each.

You may wish to lock the project by pressing the Lock button on the main menu. Locking prevents any more users from entering the project, although current users will be able to continue working.

Using DICE

Select Utilities > Integrity Checking from the main menu and the Data Integrity Check form will be displayed.



The Check options at the top of the form allow you to choose which databases you want to check. If the option button is set to Selection, you can pick the databases you want from the list. All selects all the databases in the list, and Clear clears the selection.

The other options under Selection allow you to check the Project database or the System database.

The Settings options control the types of check carried out, and they are described in the following sections.

FULL and BRIEF Modes and Maximum Errors

There are two type of errors detected by DICE:

A fatal error is identified if the DB is corrupted.

A non-fatal error is identified if DICE encounters a fault with references to external DBs, or if the name tables require realigning. See the REALIGN command in RECONFIGURER.

In BRIEF mode, checking stops when the first fatal error is encountered; that is, DICE simply determines whether or not the DB is corrupt.

In FULL mode, DICE continues checking the whole DB or file, listing all non-fatal and fatal errors until the Maximum fatal errors count is exceeded, when the checking of that DB is abandoned. Occasionally DICE will stop before processing the whole DB. This will happen when the error is so severe that it is not worth continuing, for example, if the DB has been truncated.

Producing Statistics

STATISTICS OFF specifies that no statistics will be generated.

STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc.

See Section for an example of the type of output produced.

Checking External References

The elements in some types of DB have reference or reference array attributes which can point to elements in other DBs.

If the NOCHECK option is set, DICE does not cross-check any references to other DBs.

If CHECK is set, each referenced element is checked to see if it is a valid type. A non-fatal error message is produced for each invalid external reference found. The following tests are applied to each external DB to which reference is made:

Does the referenced DB still exist?



Is the referenced DB a valid type? For example, a reference attribute in a Design DB which points to a DRAFT DB 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.

The REJECT option should normally only be used 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.

Selecting the Output Destination

You can send the reports generated by DICE to your screen or to a named file.

When the form is complete, press Apply , and the selected Databases will be checked.

Macros

Normally the System Administrator will set up standard macros for the regular use of DICE.

DICE has two modes of operation:

From within PDMS. This is the normal way of using DICE. You can use it to check a single DB, several DBs or a whole PDMS project. You can use the Database Integrity Check form for a quick interactive check, or you can write a macro.

As a stand-alone program. This is useful, for example, when the System DB has been corrupted. DICE can be used to check the System DB from outside the PDMS 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 PDMS ADMIN Reference Manual. Some of the commands in DICE can only be used from within PDMS, 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.



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 DB 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. This will contain just one error and any number of warnings in BRIEF mode, but up to the number of errors and warnings specified by if FULL has been specified.

A report summary , which tells you whether the DB is free from structural faults, suspect or definitely corrupt.

Other output sections, which will be appended to the basic report if they have been requested, are:

• DB storage statistics

• An external reference list

• The Report Header

All the information which DICE can determine about a DB before starting its detailed checks is presented in the report header.

If any particular item of information cannot be determined (for example, the project name when running in stand–alone mode), it is presented in the header as

*UNKNOWN*

The format of the header is as follows:

***************************** * DATABASE INTEGRITY REPORT * ***************************** Date TAD Oct 96 Time 16.02

Project TAD Database SYSTEM Filename /%TAD000%/tad000 DB number 1 DB type SYSTEM DB size 133 Pages (0.272 Million bytes) Maximum size 2000 Pages DB is 0.% full Page size 2048 bytes



Options requested STATISTICS OFF CHECK EXTERNAL REFERENCES LIST REFERENCED DATABASES FULL CHECK

DDL version 10.0

8/10/92

Database has no structural errors

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 PDMS project code.

Database . The name by which the DB is known within the PDMS 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, in pages and megabytes, currently used by the DB in its file. Also shown are the maximum size (in pages) and the percentage of space filled. Note that if the database is more than 90% full, the space filled is output as a warning.

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.



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 a PDMS module. Errors in running DICE are listed in Appendix B.

When BRIEF mode has been specified, DICE will diagnose any number of warnings up to the first error found and will then abandon any further checking.

When FULL mode has been selected, DICE will output a list of all errors found, unless the number of errors exceeds the setting of MAXERRORS or the number of warnings exceeds the setting of MAXWARNINGS.

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:

*DATABASE CONTAINS FATAL ERRORS**

The DB must NOT be used further in the context of a PDMS project and a backup copy must be retrieved to replace it.

Any occurrence of DB corruption should always be re ported immediately to AVEVA Ltd and documented in the usual way on a faul t report.

Sometimes a corrupted database can be recovered by reconfiguration, but this is not guaranteed.

Database has no structural errors

The DB can continue to be used.

WARNING! Database contains some reference attribute warnings

For example, 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.


Session 10

Reconfigure

The Reconfigure Module has been withdrawn at PDMS 11.2 the functionality has been included in Admin. Reconfigure is not used as much as it was at earlier releases, this is because it is now not used to compress databases. Database compression is not done by Merging Sessions as described earlier.

You can use Reconfigure to Upgrade Projects, Move data between databases or projects.

Objectives


• Understand Basic Reconfigure Command

• Understand the use of Intermediate / Dump Files

• Perform a Simple Reconfigure

• Perform a Partial Reconfigure

• Perform a Reconfigure using the SAMEREF option

Must Know Points


• Basic understanding of Reconfigure Command

Reconfigure


Reconfigure

The Reconfigure Module has been withdrawn at PDMS 11.2 the functionality has been included in Admin. Reconfigure is not used as much as it was at earlier releases, this is because it is now not used to compress databases. Database compression is not done by Merging Sessions as described earlier.

You can use Reconfigure to Upgrade Projects, Move data between databases or projects.

The process of Reconfiguring can be roughly split into five commands :

FROM - The Database of file where the information is coming from.

TO - The Database or file where the information is going to.

RCFCOPY - The data you wish to copy.

RECON - The reconfigure command.

RCFUPDATE - When you create a new database the reference numbers used by PDMS will change. It would be correct to deduce that databases using this information must be changed to point at the new references. We will need to update all databases which point to it to the new database.

Intermediate and Dump Files

Both RECONFIGURE and RCFUPDATE make use of a ‘DUMP’ file. This contains a complete list of old and new reference numbers. Each old reference has an equivalent new number in the new database. If you wish to break the process between RECONFIGURE and UPDATE, you must save the dump table.

It is always good practice to save the dump file as the RECONFIGURE and UPDATE process can take a long time and may be subject to machine failure.

Reconfigure


Reconfigurer Commands:

The FROM Command

Although, the syntax graph for FROM offers several options, the one normally used is:

FROM DB dbname

FROM PROJECT projectid dbname - should be used with great care. A DB can be transferred from another project, but it must be completely independent of other DB’s, i.e. it must be ‘self-sufficient’ with no pointers to other DBs.

>------FROM----+----FIles-----file 1-----file 2---- . | | |----SYStem------------------------- | | | |----DBFile--------name------------- | | | |----PROJect---projectid----dbname-- | | | ‘----DB------------dbname----------- +---->

The only safe use of this command would be to transfer the catalogue database of an old project into a new project. The old database would be left untouched in the old project as UPDATE will not scan outside the current project. The new reconfigured database in the current (new) project would be the same as if the old project catalogue had been DATAL’ed across to the new one.

‘FROM SYSTEM’ applies to the reconfiguration of the system database. Tthis action will normally be necessary when a project is being converted to a new version of PDMS. In this case a ‘TO’ destination is not stated as the database is reconfigured into itself.

The TO Command

This has a similar form to the FROM command, except that we have the option of sending the reconfigured information to an existing database or a new one.

TO DB dbname refers to an existing database.

TO NEW dbname will create a new DB of the correct type provided that an existing TEAM name has been used

.NOTE: If any other command than ‘TO NEW dbname or TO DB dbname’ is used, then the RCFUPDATE command will have no effect.

Reconfigure


>-----TO-----+------FIles-----file 1-----file 2---- -. | | |------DBFile-------------name-------- --| | | |------DB----------. | | | | ‘------NEW---------+---dbname--------- --’-->

The RCFCOPY Command

This specified exactly what we wish to copy. Normally ’COPY ALL’ is used, as the whole database is being transferred. The option to copy parts of DB‘s into other parts of existing DB‘s can become a hazardous operation if the whole process is not thought out carefully by the System Administrator.

.---------------------------------- -------. / | >-----RCFCopy---+------------CATa------------------ ------. | | | | |------------SPEC------------------- -----| | | | | |------------ALL-------------------- -----| | | | | |------------name--+---------------- -----| | | | | | | | +--name- -+ | | | ‘--INTO--| |--| | | ‘--refno --’ | | ‘------------------+---------------- -----|--| | +--name- -+ | | ‘--INTO--| | | | ‘--refno -’---+--+-->

The COPY command does not actually perform the copying function, it merely defines the information to be transferred.

Reconfigure


The RECONFIGURE Command

This is the final simple command that sets everything in motion. During the time that the RECONFIGURE is running, information on PASS1 and PASS2 will be output on the screen. This serves as some indication of the rate of progress, in that the completion of PASS1 can broadly be taken as the halfway mark.

At the end of the RECONFIGURE, a summary of errors similar in appearance to that seen in CLASHER is given. It is essential that if any errors have occurred that the RECONFIGURER process is considered as having failed.

The RECONFIGURER is a very general application and as such will try to complete any task given to it. If errors have occurred it is almost certain that the ‘TO’ DB contains only some of the information which was supposed to be transferred. The safest course is to delete this DB before any attempt is made to repeat the RECONFIGURE. If all the rules are obeyed then the message that the System Administrator will expect to see every time will be:

***PASS 2 COMPLETED RECONFIGURATION COMPLETE 0 ELEMENTS WERE NOT DEFINED IN DDL 0 ELEMENTS HAVE BEEN LOST 0 ELEMENTS ARE NO LONGER NAMED 0 ATTRIBUTES WERE WRONGLY DEFINED

The RCFUPDATE Command

The UPDATE process scans the DB’s specified for any pointers which refer to the old DB and changes them to references to the new reconfigured one. For this task, it of course requires the dumptable.

If the user had left the module since the RECONFIGURE was performed, he should have saved the dumptable;

DUMP /filename

Having returned to RECONFIGURER, he must now reactivate this table:

LOAD /filename

If the UPDATE follows on immediately after the RECONFIGURE then this is not necessary.

>-RCFUPdate----+----DB----dbname----. | | |----MDB---mdbname---| | | ‘----TEam--teamid----’---->

The UPDATE command may be given as many times as necessary to define all the MDB’s Teams or individual DB’s that are used to point to the old DB.

Reconfigure


There is not an ‘UPDATE PROJECT’ command as this would demand that the system scans every single DB in the project. This would be wasteful, as it is unlikely that all the databases in a project have pointers to one particular DB, except perhaps the catalogue.

Example of a Simple Reconfigure

Reconfigure


Example of a Partial Reconfigure

In the following example we are going to move one piece of equipment from database PIPES/DESIGN to PIPEN/DESIGN

As we are moving just one piece of equipment we need to move it to an existing zone in the other database.

The only difference from before is the line

RCFCOPY /VESS-1 into /ZONE-PIPEN-PIPE

The equipment /VESS-1 will exist twice with the same name, but only the one in database PIPEN/DESIGN is correct. The Equipment should be deleted from PIPES/DESIGN.

Reconfigure


Example of a Reconfigure Using the SAMEREF Option

When a DB is reconfigured, the reference numbers of the elements in the destination DB will be different from the corresponding reference numbers in the source DB. To ensure that the same reference numbers are maintained after reconfiguration, you can use the command:

RECONFIGURE SAMEREF

In this case the destination DB number must be the same as the original one. This means that you will have to Backtrack the changes to session 2 or delete the source database, and create a new one with the same number.

In the unlikely event of the Database becoming corrupt the SAMEREF option is a very good way of correcting the problem. The main advantage of using the SAMEREF option is that you do not need to update all the other databases.

RECONFIGURE SAMEREF (Using the Backtrack Changes Database Option)

Reconfigure the Database to File (using the command line)

Backtrack the Database to session number 2

Reconfigure SAMEREF from files to the Data base you have just Backtracked.

Reconfigure


RECONFIGURE SAMEREF (Using the Delete Database Opti on) Should the above method not be successful you may need to delete the Database and create a new one. As during this process the original database is deleted so you must make a note of the MDB’s where is has been used.

Before you start make a note of all the MDB’s where the Database has been used.

Query > Project > DB’s (you will need this information later)

Reconfigure the Database to File (using the command line)

Reconfigure


Make a note of the DB number using Modify Database.

Delete the db and create one using the same name, DB and File Number.

Reconfigure SAMEREF from files to the new Data base you have just created.

You will now need to add this new database to every MDB as required.

Reconfigure


Converting a Database to be compatible with a New DDL

A new DDL or DATA DESCRIPTION LANGUAGE is only encountered on major revisions of PDMS when the PDMS number changes. So when users change from PDMS 10 to PDMS 11 any current projects will have to be reconfigured to accept the new DDL. (Old projects which are no longer live, need not go through this process The version of PDMS which they were built should be stored on tape with the project).

A DDL change occurs when the structure of a database changes such that existing elements for example have new attributes.

The process of reconfiguring between major versions can vary slightly, but is always clearly documented on the release of the new version.

Normally when moving between minor releases (e.g. 11.3 to 11.4) of PDMS, no RECONFIGURATION is necessary, unless recommended by AVEVA. The process simply involves making sure the environment variable, PDMSEXE, points to the right area. A perl script is supplied by AVEVA Ltd. to semi automate the upgrade process.

When changing from 11.4 to 11.5 or 11.6 no upgrade is required.


Session 11

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 PDMS data so it is very important that data is not lost due to hardware failure, fire or user error.

Objectives


• Daily Backups.

• Project Backups

Must Know Points


• Understanding of the need for good Backups.

Backing up Data


Daily Backups

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 PDMS data so it is very important that data is not lost due to hardware failure, fire or user error.

Backups are normally produced each night when there is no one using the system and are normally automated.

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 PDMS Project (TAD000)

PDMS Options (TADISO)

PDMS Macro (TADMAC)

The PDMS picture files (TADPIC) need not be saved as they can be regenerated by using the Draft Update commands.

You must make sure that anything that has been modified has been backed up. I you have done any customisation then these files should be backed up.

Backing up Data


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).

Week No Monday Tuesday Wednesday Thursday Friday

1 MON TUE WEEK 1 THU FRI



4 MON TUE MONTH 1 THU FRI




8 MON TUE MONTH 2 THU FRI


Using the backup system shown in the worst case you could loose a days work, but by taking out a Weekly / Monthly tape you would be able to get items back up to 4 months ago that may have been deleted in error.

Backing up Data

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 PDMS 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.

m25 basic admin

Documents

project access

proprietary products

new project

project environment

basic administration

confidential information

admin module

contents session