Admin Reference

8/3/2019 Admin Reference

1/247

PDMS1151/man17/doc1Issue 140403

PDMS ADMINCommand Reference Manual

Version 11.5


2/247

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

PLEASE NOTE:

AVEVA Solutions has a policy of continuing product development: therefore, the

information contained in this document may be subject to change without notice.

AVEVA SOLUTIONS 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

Solutions 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 to which you may not have

access or which may not be licensed to you. For further information on which Products

are licensed to you please refer to your licence conditions.

Copyright 1991 through 2003 AVEVA Solutions 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

Solutions.

The software programs described in this document are confidential information and

proprietary products of AVEVA Solutions or its licensors.

For details of AVEVA's worldwide sales and support offices, see our website at

http://www.aveva.com
http://www.aveva.com/http://www.aveva.com/


3/247

VANTAGE PDMS ADMINCommand Reference ManualVersion 11.5

Revision History

Date Version Notes

March 2003 11.5 Section 4 First note moved to Section 3.19.8 and updated

Figure 4-2 LCOML element title changed and LCOMD

element added

Section 4.2.1 LCTIML element updated

Section 5.5 Second para added

Section 7 ALLOCATE Updated for offline locations,OVERRIDE PROPG and related commands

Section 7 CHANGE Updated for offline locations and related

commands

Section 7 CREATE Updated description about extracts, note

about offline locations, and built-in recovery

Section 7 DELETED Note added about deleted files

Section 7 EXTRACT Updated to cover FLUSH RESET

Section 7 GENERATE Sentence about Hub added to second

para of descriptionSection 7 HUB LOCATION Description updated to cover

OVERRIDE PROPG

Section 7 NEW Additional example for Global

Section 7 PREVOWNER updated to cover built-in recovery

Section 7 QUERY Updated to include attributes for database

states

Section 7 RECOVER Minor change to note in description

Section 7 REMOTE Function updated for BACKTRACK,

CHANGES and MERGE

Section 7 RENEW updated to cover DELETE option

Section 7 TO Function updated to mention stopping daemon

Section 7 TRANSFER Description updated to cover offline

location

Index - All occurrences of offline location references included


4/247

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


5/247

VANTAGE PDMS ADMIN Contents-iCommand Reference ManualVersion 11.5

Contents

1 Introduction ................................................................................................... 1-1

1.1 Macros .........................................................................................................................1-1

1.2 How to Use This Manual............................................................................................1-2

2 Stand-Alone DICE..........................................................................................2-1

2.1 DICE Errors................................................................................................................2-1

2.2 DICE Commands........................................................................................................2-2

3 Reconfiguration.............................................................................................3-13.1 The Reconfiguration Process......................................................................................3-1

3.2 Starting up RECONFIGURER..................................................................................3-2

3.3 Administrative and Querying Commands ................................................................3-2

3.4 Basic Reconfiguration ................................................................................................3-3

3.4.1 Reconfiguring a Single Database .....................................................................3-3

3.4.2 Specifying the Source Database .......................................................................3-3

3.4.3 Specifying the Destination DB .........................................................................3-4

3.4.4 Specifying What Will be Copied .......................................................................3-4

3.4.5 Starting the Reconfiguration Process ..............................................................3-5

3.4.6 Example of a Simple Reconfiguration.............................................................. 3-5

3.5 Using the SAMEREF Option.....................................................................................3-63.6 Using the SESSIONS Option.....................................................................................3-6

3.7 Listing the Reference Number Index ........................................................................3-7

3.8 Global Projects............................................................................................................3-8

3.9 Controlling RECONFIGURER Output .....................................................................3-8

3.10 Copies and Reconfigured Copies of DBs....................................................................3-9

3.10.1Copies.. ...............................................................................................3-9

3.10.2Reconfigured Copies.........................................................................................3-9

3.11 Advanced Reconfiguration .......................................................................................3-10

3.11.1References Between Databases.....................................................................3-10

3.11.2Updating References into a Reconfigured Database....................................3-11

3.11.3Saving the Reference Number Index ............................................................3-123.11.4Copying Parts of Databases...........................................................................3-12

3.11.5Copying Groups..............................................................................................3-14

3.12 Transferring Data Between Projects.......................................................................3-14

3.13 Upgrading a Project..................................................................................................3-15

3.14 Reconfiguration Messages........................................................................................3-18

3.14.1Standard Information Messages ...................................................................3-19

3.14.2General Format of Pass 2 Error Messages ................................................... 3-19

3.14.3Codes Used to Identify Message Types.........................................................3-20

3.15 Database Transfers between Computers ................................................................3-20

3.16 Binary and Character Files .....................................................................................3-21

3.17 The Transfer Process................................................................................................3-21

3.18 Reconfiguring a Global Project ................................................................................3-22


6/247

Contents

Contents-ii VANTAGE PDMS ADMINltCommand Reference Manual

Version 11.5

3.19 Reconfiguring Extracts............................................................................................ 3-22

3.19.1Outputting Changes Only............................................................................. 3-22

3.19.2RECONFIG SAMEREF FULLThe SAMEREF Option ............................... 3-223.19.3The SESSIONS Option ................................................................................. 3-22

3.19.4Reconfiguring a Single Extract..................................................................... 3-23

3.19.5Reconfiguring a Family of Extracts.............................................................. 3-23

3.19.6The RCFUPDATE command ........................................................................ 3-24

3.19.7Example of Reconfiguring a Three Level Extract........................................ 3-24

3.19.8Reconfiguring the Transaction Database in a Global Project..................... 3-26

4 The System and Global Databases ............................................................. 4-1

4.1 Standard Projects: the System Database ................................................................. 4-1

4.2 Global Projects ......................................................................................................... 4-10

4.2.1 Structure of the Local System Database....................................................... 4-124.2.2 Structure of the Global Database .................................................................. 4-15

5 The Transaction Database ........................................................................... 5-1

5.1 Structure of the Transaction Database .................................................................... 5-1

5.2 TRMSGW element ..................................................................................................... 5-3

5.3 TRYEAR, TRMONT and TRDAY elements ............................................................. 5-3

5.4 TRUSER and TRLOC elements................................................................................ 5-3

5.5 TRINCO element (Input Command)......................................................................... 5-4

5.6 TROUCO element (Output Command)..................................................................... 5-7

5.7 TROPER element (Operation)................................................................................. 5-10

5.8 TRMLST, TRSLST, and TRFLST elements........................................................... 5-11

5.9 TRMESS, TRSUCC, and TRFAIL elements .......................................................... 5-12

6 Command Summary ..................................................................................... 6-1

6.1 Project Definition ....................................................................................................... 6-1

6.2 Project Administration .............................................................................................. 6-2

6.3 Global Project Administration .................................................................................. 6-2

6.4 Module Definition ...................................................................................................... 6-3

6.5 Font Definition........................................................................................................... 6-3

6.6 Querying..................................................................................................................... 6-3

6.7 General PDMS Commands........................................................................................ 6-4

6.8 Data Integrity Checking............................................................................................ 6-4

6.9 Reconfiguration.......................................................................................................... 6-4

7 Command Details.......................................................................................... 7-1

7.1 Conventions Used in the Syntax Graphs.................................................................. 7-1

7.2 Notes on Syntax Graphs............................................................................................ 7-3

7.3 Detailed Descriptions of Commands......................................................................... 7-4

ACCESS (Project definition)..................................................................................... 7-5

ACRADD (Project definition).................................................................................... 7-6

ACRREM (Project definition) ................................................................................... 7-7

ADD (Project definition) ........................................................................................... 7-8

ADMINISTER (Global Project Administration - Remote Administration) ............ 7-9

ALLOCATE (Global Project Administration - Hub only) ..................................... 7-12


7/247

Contents

VANTAGE PDMS ADMIN Contents -iiiCommand Reference ManualVersion 11.5

ALPHA (General PDMS Command) ......................................................................7-15

BACKTRACK (Project Administration) .................................................................7-16

BRIEF (Reconfiguration) ........................................................................................7-18CANCELCOMMAND (Global Project Administration) ........................................7-19

CDESC (Project definition) .....................................................................................7-20

CHANGE (Project definition)..................................................................................7-21

CHECK (Data Integrity Checking) .........................................................................7-25

CHECKOPTION (Data Integrity Checking) ..........................................................7-28

CNAME (Project definition) ....................................................................................7-32

COPY (Project definition)........................................................................................7-34

CREATE (Project definition)...................................................................................7-36

CURRENT (Project definition) ...............................................................................7-43

DADD (Project definition) .......................................................................................7-44

DEALLOCATE (Global Project Administration - Hub only) ................................7-45DEFER (Project definition) .....................................................................................7-47

DELETE (Project definition)...................................................................................7-48

DREMOVE (Project definition)...............................................................................7-51

DUMP (Reconfiguration) ........................................................................................7-52

DUPLICATENAMES (Global Project Administration).........................................7-53

EDIT (Module definition) ........................................................................................7-55

ERRORFILE (Data Integrity Checking).................................................................7-57

ERRORS (Reconfiguration).....................................................................................7-58

EXCHANGE (Project definition) ............................................................................7-59

EXCLUDE (Project definition)................................................................................7-60

EXPUNGE (Project administration) ......................................................................7-61

EXTERNAL (Data Integrity Checking) ..................................................................7-63

EXTRACT (Project administration) .......................................................................7-65

FINISH (General PDMS Command)......................................................................7-68

FONTDIRECTORY (Font definition) .....................................................................7-69

FONTFAMILY (Font definition) ............................................................................7-70

FROM (Reconfiguration).........................................................................................7-72

FULL (Reconfiguration) ..........................................................................................7-73

GENERATE (Global Project Administration - Hub only) .....................................7-74

GETWORK (General PDMS Command)................................................................7-76

HUBLOCATION (Global Project Administration - Hub only) ..............................7-77

INCLUDE (Project definition) ................................................................................7-79

INITIALISE (Global Project Administration)........................................................7-80

ISOLATION (Global Project Administration) .......................................................7-81

LIST (Querying).......................................................................................................7-82

LOAD (Reconfiguration) .........................................................................................7-85

LOCK (Project administration) ..............................................................................7-86

MAKE GLOBAL (Global Project Administration).................................................7-87

MAXERRORS (Data Integrity Checking)...............................................................7-88

MAXUSERS (Project Administration) ...................................................................7-89

MAXWARNINGS (Data Integrity Checking) .........................................................7-90

MERGE CHANGES (Project Administration) .......................................................7-91

MESSAGE (Project administration).......................................................................7-94

MODE (Data Integrity Checking) ...........................................................................7-95


8/247

Contents

Contents-iv VANTAGE PDMS ADMINltCommand Reference Manual

Version 11.5

MODULE (Module Definition) ............................................................................... 7-96

MOVE (Project administration) ............................................................................. 7-98

NEW (Project definition and Global Project Administration) .............................. 7-99NEW STAMP (Project administration) ............................................................... 7-101

PING (Global Project Administration) ................................................................ 7-103

PREVOWNER (Global Project Administration - Hub only) ............................... 7-104

PROJECT (Project definition) .............................................................................. 7-106

PURGE (Project Administration and Global Project Administration) .............. 7-108

QUERY (Querying) ............................................................................................... 7-109

RCFCOPY (Reconfiguration)................................................................................ 7-114

RCFUPDATE (Reconfiguration) .......................................................................... 7-116

RCFUPGRADE (Reconfiguration) ....................................................................... 7-117

RECONFIGURE (Reconfiguration) ..................................................................... 7-118

RECOVER (Global Project Administration)........................................................ 7-120REINIT (Reconfiguration) .................................................................................... 7-123

REMOTE (Global Project Administration).......................................................... 7-124

REMOTEMESSAGE (Global Project Administration) ....................................... 7-130

REMOVE (Project definition) ............................................................................... 7-131

RENEW (Global Project Administration)............................................................ 7-132

REORDER (Global Project Administration) ....................................................... 7-134

REPLICATE (Project definition) .......................................................................... 7-135

RESETXREFS (Reconfiguration)......................................................................... 7-138

REVERT (Project administration) ....................................................................... 7-139

SAVEWORK (General PDMS Command) ........................................................... 7-140

SET (Project definition and Global Project Administraion) ............................... 7-141

STATISTICS (Data Integrity Checking) .............................................................. 7-142

STATUSSESSION (Querying) ............................................................................. 7-143

STOP (Data Integrity Checking) .......................................................................... 7-144

SYNCHRONISE (Global Project Administration) .............................................. 7-145

SYSTAT (Querying) .............................................................................................. 7-147

SYSTEMLOCATION (Global Project Administration - Hub Only) ................... 7-150

TADD (Project definition) ..................................................................................... 7-152

TERM (General PDMS Command)...................................................................... 7-153

TO (Reconfiguration) ............................................................................................ 7-154

TRANSFER (Global Project Administration)...................................................... 7-156

TREMOVE (Project definition)............................................................................. 7-158

UNLOCK (Project administration) ...................................................................... 7-159

UPDATE (Global Project Administration) .......................................................... 7-160

UPGRADE (Reconfiguration)............................................................................... 7-162

VB (Reconfiguration) ............................................................................................ 7-163

XREF (Reconfiguration) ....................................................................................... 7-164

Index...........................................................................................................................1


9/247

VANTAGE PDMS ADMIN 1-1Command Reference ManualVersion 11.5

1 Introduction

This manual describes the PDMS ADMIN commands for Standard (non-global) and

Global projects. It is written for System Administrators who are already experienced

ADMIN users and who wish to write macros or use command input, rather than the

GUI.

The content of this manual is based on the assumption that you are already familiar

with the concepts that a PDMS System Administrator needs to understand. If you are

not familiar with these concepts, you should refer to the relevant user guide, as follows:

Using PDMS ADMIN for a standard (non-global) project is described in the

VANTAGEPDMS ADMIN User Guide, which tells you how to set up and

administer PDMS projects using the GUI. The User Guide also describes the

concepts that PDMS System Administrators need to understand.

Using Plant Design Global via the GUI is described in the VANTAGEPlant Design

Global User Guide, which also describes the concepts in Plant Design Global that

PDMS System Administrators need to understand.

Within the manual, commands that are only available in Plant Design Global are

labelled as Global Project Administration Commands. Some of these commands are

only available at the Hub of a Global Project, and this is also shown. Some options instandard commands are only available in Global Projects and these options are also

indicated by 'Global' in associated text.

This manual also describes how to use DICE, the PDMS Data Integrity Checker, outside

PDMS, as there is no GUI for the stand-alone module. It also describes database

reconfiguration, which is also a command line or macro operation.

1.1 Macros

Most people who read this manual will be writing macros, either to run into PDMSwhen required, for example, to create a new project, or as part of customising the

ADMIN interface.

There are some commands in ADMIN which automatically create simple PDMS macros.

These are command files which can be read back into PDMS. In particular, you can use

the REPLICATE command to create a macro which will replicate a project.

For information about writing more complicated macros using the PDMS Programmable

Macro Language, (PML), see the VANTAGEPlant Design Software Customisation

Guide and the VANTAGEPlant Design Software Customisation Reference Manual.


10/247

Introduction

1-2 VANTAGE PDMS ADMINCommand Reference Manual

Version 11.5

1.2 How to Use This Manual

Chapter 2,Stand-Alone DICE,applies to Standard and Global projects and describes

how to run the PDMS Data Integrity Checker, DICE, from outside PDMS. This chapter

is included in the Command Reference manual as there is no interface to stand-alone

DICE, and you will need to enter commands interactively or via a macro.

Chapter 3,Reconfiguration, applies to Standard and Global projects and describes

database reconfiguration.

Chapter 4, The System and Global Databases, applies to Standard and Global projects.

It contains maps of the System Database and Global Database Hierarchies, and a list of

the ADMIN elements and their attributes that can be set explicitly by the user.

Chapter 5,The Transaction Databaseapplies to Global projects only, and describes thetransaction database, the elements in it, and their attributes.

Chapter 6,Command Summaryapplies to Standard and Global projects. It lists the

ADMIN commands in functional groups.

Chapter 7,Command Details, applies to Standard and Global projects. It occupies the

majority of the manual and describes every ADMIN command. The descriptions appear

in alphabetical order of command names.


11/247


2 Stand-Alone DICE

The PDMS Data Integrity Checker (DICE) can be run as a stand-alone program outside

PDMS. This may be necessary if the System database has been corrupted, and you

cannot enter PDMS.

Stand-alone DICE is started up using the script named dop, supplied in the PDMSEXE

directory. Give the following command, outside PDMS:

$PDMSEXE/dop

For a summary of the commands that you can use in DICE, see the Data Integrity

Checking commands in 6,Command Summary.

Commands to exit from DICE in stand-alone mode are:

STOPFINISH

You can send the reports generated by DICE to a named file in your working directory

using the ALPHA command.

2.1 DICE Errors

PDMS obtains the text of all its user messages from an external file. When DICE is used

from within a PDMS project, this file is automatically available, but this is not the case

in stand-alone mode. Hence the next command you must give in stand-alone mode is the

ERRORFILE command, followed by the name of the error message file. For example:

ERRORFILE /%PDMSEXE%/MESSAGE.DAT

Note: This file will contain error messages referring to the operation of DICE

itself, not any errors DICE has found during the checking process

The default name of the message file can be found from the entry for DICE in the

current version ofmakmac.mac, the project configuration macro.


12/247

Stand-Alone DICE


Version 11.5

2.2 DICE CommandsSet up the options you require using the following commands (see the appropriate

command pages for details):

ERRORFILEMODEMAXERRORSMAXWARNINGSSTATISTICS

You can send the reports generated by DICE to a named file using the ALPHA

command.

You can check one or more DB files by using the CHECK command. In this mode, you

can only refer to databases by their external filenames rather than by their internal

PDMS DB names. Up to ten files may be specified in a single command.

Note: The EXTERNALcommand cannot be used in stand-alone mode (or by REMOTE

CHECK), because only one DB file can be accessed at a time.


13/247


3 Reconfiguration

PDMS RECONFIGURER is run from within ADMIN, but only by using the command

line.

In order to understand why database reconfiguration may be necessary, and to

appreciate the steps involved, it is helpful to have some knowledge of PDMS database

structures and their management. For a summary of this information, including an

explanation ofDDLs (Database Description Languages) and DABACON (the

DAtaBAse CONtrol program), read the chapter The PDMSDatabase Management

System in the VANTAGEPDMS ADMIN User Guide.

3.1 The Reconfiguration Process

Reconfiguration is a two-pass operation, acting on either a complete database or on

specified parts of one.

In the first pass, RECONFIGURER scans a named source database and copies the

data for some or all existing elements and their attributes into intermediate files.

In the second pass, the contents of the intermediate files are transferred to a specifieddestination database.

This mode of operation has the following features:

Only existing elements are copied to the intermediate files; deleted items and

corrupt data are ignored. The destination database created from these files is

therefore both compact and uncorrupted.

The reference and non-reference attributes of the elements are held in different

intermediate files. The method of transfer of data to the destination database

ensures that all referencing is complete and consistent.

The source and destination databases may have different DDLs. This enables

existing data to be restructured to conform to a new database structure and so, for

example, to be used with a new version of PDMS.

Reconfiguration can used to transfer a project to different hardware. The

intermediate files produced by the first stage can be decoded into a portable format

(typically ASCII), and transferred, and then the second stage carried out.

A similar technique is used to convert whole projects to new versions of PDMS, though

in this case the intermediate files need not be decoded.


14/247

Reconfiguration


Version 11.5

3.2 Starting up RECONFIGURER

Enter PDMS in non-graphics (tty) mode by typing:

pdms tty

Then specify the Project and User ID/Password, and enter ADMIN. For example:

proj ABCuser SYSTEM/XXXXXXadmin

You can now start to set up the reconfiguration parameters using the commands

summarised in the Command Summary under Reconfiguration.

3.3 Administrative and Querying Commands

Some of the general PDMS and querying commands, which are particularly relevant to

reconfiguration, are summarised below.

SYSTAT Gives information about the current active status of theprojectwithin which you are working.

LIST Lists project information; there are a variety of options.

SET TEAM Sets the specified team as the current one.

LOCK, UNLOCK Locking the System Database prevents any new usersentering

the project.MESSAGE Sends messages to other users.

Q DB Gives the type, number and filename of the specified DB, and alist of the MDBs of which it is a member. For example:

Q DB CIVIL/JBX37CCIVIL/JBX37C DESI NUMBER 6 FILENAME /TVX000/TVX009MDBS: /LAYOUT /TANKS

Q COPIES Lists all DBs which are copies of the specified DB. For example:

Q COPIES CIVIL/JBX37CDB CIVIL/JBX37C HAS COPIES:CIVIL/JBX47C

Q MDB Lists the DBs in the specified MDB.Q TEAM Lists the users who are members of the specified team, plus a list

of the DBs owned by the team.

Q SET TEAM Gives the name of the currently set team, if any.

Q LOCK Shows whether the project is locked.


15/247

Reconfiguration


3.4 Basic Reconfiguration

3.4.1 Reconfiguring a Single Database

The simplest reconfiguration involves a single DB which has no references into it from

other DBs; for example, a Design DB which has no associated Drawing (PADD) DBs.

A simple reconfiguration requires a source and a destination DB. When the process

has been completed, the source DB will remain unchanged, and thedestination DB will

contain a compacted copy of the parts of the source which were specified in the copy

list.

The transfer of data takes place in two passes, the second of which is further divided

into two phases:

PASS 1 The data is read from the source DB and written to a pair of

intermediate files. The first file holds the element structures and

the non-reference attributes, the other holds the reference

attributes.

PASS 2 - Phase 1 The first file is read by RECONFIGURER and used to recreate

the original structures in the destination DB, including setting of

the non-reference attributes.

PASS 2 - Phase 2 The second intermediate file is read and its contents used to set

all reference attributes in the destination DB and to perform

insertion operations.

The reason for the two phases is that references in the source DB may refer to elements

lower down in the hierarchy. It is necessary, therefore, to create all elements in the

destination DB before trying to set references to any of them.

Since the two passes perform independent and consecutive operations, the process can

be interrupted after Pass 1 has been completed, with Pass 2 being run later.

Reconfiguration has four basic steps:

1. Specify where the data to be reconfigured is coming FROM.

2. Specify where the reconfigured data is going TO.

3. Specify which parts of the source data are to be copied to the destination.

4. Start the reconfiguration process.

3.4.2 Specifying the Source Database

The source of the data to be copied is specified using the FROM command. Some

examples of the use of FROM are:

FROM DB STEELS/STEELS

Source data is in database STEELS/STEELS in current project


16/247

Reconfiguration


Version 11.5

FROM PROJECT XXX STEELS/STEEL

Source data is in specified DB in project XXX

FROM DBFILE /abc016

Source data is in specified file (assumes project directory is current

directory)

3.4.3 Specifying the Destination DB

The destination of reconfigured data is specified using the TO command. Some examplesof the use ofTO are:

TO DB STEELS/STEELS

Reconfigured data to go to database STEELS/STEELS in current project

TO NEW HVAC/HVAC DBNO 777

Reconfigured data to go to new databaseUSERM/DESIGN, number 777, in

current project

TO DBFILE /des008

Reconfigured data to go to specified file (assumes project directory is

current directory)

TO DBand TO DBFILE specify that the data is to be reconfigured into an existing DB,

identified by its name or that of the file containing it. The destination DB must be of thesame type as the source DB, and will normally be empty, but need be. For an

explanation of what happens when the DB is not empty, see Section 3.11.4,Copying

Parts of Databases.

TO NEW specifies that a new DB is to be created to receive the reconfigured data. Thisis the most common option for the general compaction of DBs. It is explained further in

Section 3.10,Copies and Reconfigured Copies of DBs.

Note: The new database will need to be added to the appropriate MDBs.

3.4.4 Specifying What Will be CopiedThe RCFCOPY command specifies which parts of the source DB are to be copied to thedestination. Most commonly a whole DB is reconfigured, using the command option

RCFCOPY ALL

The RCFCOPY ALL command copies all elements in the list part of the World element ofthe source DB into the World element of the destination DB. World itself is not copied.

Parts of a database can be copied by using the RCFCOPY command followed by the

name of the element at the top of the hierarchy to be copied. Only elements that can be

owned by World, for example, Sites, can be specified. The list of elements specified by

the RCFCOPY command becomes the copy list.


17/247

Reconfiguration


Note that you must use RCFCOPY ALL if you intend to use the RECONFIGURESESSIONS command at the next step, as the SESSIONS option is not valid if you only

carry out partial reconfiguration.

3.4.5 Starting the Reconfiguration Process

The reconfiguration process is started by giving the command:

RECONFIGURE (minimum abbreviation RECON)

Messages are output to indicate the successful start and completion of each stage. When

the process is complete, all information concerning the source, destination, copy list and

the extent of information output is deleted, ready for another reconfiguration operation

if required.You must specify the source, destination and copy list for each reconfiguration.

The output by default is sent to the screen, but you can send it to a file by giving the

ALPHA FILE command, followed by a filename, before reconfiguration.

You can use the following options with RECONFIGURE:

Use the SAMEREF option to ensure that the same reference numbers are maintained

after reconfiguration. See Section 3.5,Using the SAMEREF Option, for details.

Use the SESSIONS option to ensure that the session information stays the same

after reconfiguration. See Section 3.6,Using the SESSIONS Option for details.

3.4.6 Example of a Simple Reconfiguration

The following command sequence might be used to reconfigure a DB which is not

referenced by any other DBs:

FROM DB MASTER/DESIGNTO DB MASTER/DESNEWRCFCOPY ALLRECONFIGURE

Note: In practice it would be advisable to use RCFUPDATE and DUMPin the

command sequence. See Sections 3.11.2 and 3.11.3.

The following messages are typical of the output during a completely successful

reconfiguration:


18/247

Reconfiguration


Version 11.5

*** Pass one initiated ****** Pass one completed ***

*** Pass two initiated ***

EC SITE #32/202 =42/205Phase one complete - starting phase two

*** Pass two completed ***

***Reconfiguration Completed0 Elements were not defined in DDL0 Elements have been lost0 Elements are no longer named0 Attributes were incorrectly defined

0 Elements were not inserted.

See Section 3.14,Reconfiguration Messages, for a complete list of output messages.

3.5 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 delete the source database, and create a new one with the

same number.

The following example illustrates the use of the SAMEREF option:

FROM DB MASTER/DESIGNTO FILE /F1 /F2RCFCOPY ALLRECONFIGURE

DELETE DB MASTER/DESIGNCREATE DB MASTER/DESIGN DESI DBNO nn

FROM FILE /F1/F2TO DB MASTER/DESIGNRECONFIG SAMEREF

3.6 Using the SESSIONS Option

When a DB is reconfigured, by default the session information from the source DB is not

preserved. To ensure that session information such as the original session comment,


19/247

Reconfiguration


session number, username and original date stays the same after reconfiguration, you

can use the command:

RECONFIGURE SESSIONS

The option is not valid for SYSTEM, GLOBAL or COMPARATOR DBs, and is not

available for a partial reconfiguration.

The following example illustrates the use of the SESSIONS option:

FROM DB CTBATEST/DESITO FILE /A /BRCFCOPY ALLRECONFIG SESSIONS

After reconfiguration, data can be read back in from the file using the existing

commands, replacing the original DB data. When reading in data, the DB number andextract number must be the same as the originating DB number and extract number.

For example:

FROM FILE /A /BTO DB CTBATEST/DESIRECONFIG

The SAMEREF option is assumed when reading the data. If errors occur, the data is not

saved. If you want the data saved even if errors occur, use the FORCE option. For

example:

FROM FILE /A /B

TO DB CTBATEST/DESIRECONFIG FORCE

3.7 Listing the Reference Number Index

When a DB is reconfigured without theSAMEREF option, the reference numbers of theelements in the destination DB will be different from the corresponding reference

numbers in the source DB.

An index of the reference numbers of elements in the new DB against those in the old

DB is automatically created as an essential part of the reconfiguration process. The new

reference corresponding to an old reference can be queried using the command:

Q NEWREF refno

where refno is the new reference number. The old reference number will be returned.

For example:

Q NEWREF #32/202 =42/205


20/247

Reconfiguration


Version 11.5

3.8 Global Projects

In a Global project, you can reconfigure the System and Global databases. Thecommands are:

FROM SYSTEMRECONFIGURE

(The above command also works in a non-Global project.)

FROM GLOBALRECONFIGURE

In both these cases, the existing System or Global databases will be overwritten, so you

do not give a TO command. The COPY ALL and SAMEREF options are also implied.

In a Global project, you can only give a RECONFIGURE command for a System or Global

database if you are at the primary location of the database:

For a Global database, the primary location is the Hub.

For a Satellite System database, the primary location may be at the Satellite itself,

or it may be at another Satellite, or at the Hub. The RECONFIGURE command

reconfigures the currently open System database. At a Satellite, the command can

therefore operate either on the local System database, or on another Satellites

System database which is primary at the local Satellite.

3.9 Controlling RECONFIGURER Output

You can control the format and extent of the output produced by RECONFIGURER

during Pass 2 processing. The commands are:

VB very brief output mode

BRIEF brief output mode

FULL full output mode

InVB (Very Brief) mode, a message is output as each element in the copy list is

successfully created. If the copy command was RCFCOPY ALL, then a message is output

for each element successfully copied into the World of the destination DB.

In BRIEF mode, all information output in VB mode is given, plus messages describing

any errors that have occurred due to DDL changes.

In FULL mode, all information output in BRIEF mode is given, plus a log of all

elements successfully created and named. Note that FULL mode is very verbose and its

use is not generally recommended.

The default is BRIEF mode.

An upper limit may be set on the number of errors that are acceptable during Pass 2 of a

reconfiguration using the ERRORS command. For example:

ERRORS 50


21/247

Reconfiguration


If the specified limit is reached, reconfiguration is abandoned and the DB is left

unaltered.

By default, RECONFIGURER allows an unlimited number of errors to occur. This

situation may be reset if necessary by using the ERRORS command followed by anegative value. For example:

ERRORS -1

3.10 Copies and Reconfigured Copies of DBs

There are two ways of copying a DB in PDMS, which create two different types of copy:

copies and reconfigured copies. This section explains the difference.

3.10.1 Copies..

A copy of a DB can be made by using the RCFCOPY command. For example thefollowing command: will create a copy of the existing DB PIPEA/PIPEA in the new DB

ADMIN/TEST.

RCFCOPY PIPEA/PIPEA ADMIN/TEST

The key features of copies are:

All copies of DBs have the same DB number. This may be seen by using the LIST

FILES command. For example:

MASTER/DES DESI NUMBER 14 FILENAME /%DRA000%/dra013 UPDATE

PIPEA/PIPEA DESI NUMBER 2 FILENAME /%DRA000%/dra001 UPDATE

ADMIN/TEST DESI NUMBER 2 FILENAME /%DRA000%/dra003 UPDATE

USER/DRAFT PADD NUMBER 5 FILENAME /%DRA000%/dra004 UPDATE

There is no implied direction of copying. Thus, in the previous example,

PIPEA/PIPEA and ADMIN/TEST are each a copy of the other.

The contents of all copies are identical with respect to both data and structure.

Any given element has the same reference number in each copy.

A DB may have any number of copies, but copies may not exist in the same MDB.

3.10.2 Reconfigured Copies

A reconfigured copy is one named by the TO DB or TO NEW commands. The keyfeatures of reconfigured copies are:


22/247

Reconfiguration


Version 11.5

A reconfigured copy has a different DB number from that of the source DB.

In the reconfiguration process, the destination DB becomes a reconfigured

copy of the source DB, but the reverse is not true. The relationship exists in

one direction only.

The contents of a reconfigured copy are an edited version of those of the

source DB.

Any given element will have a different reference number in the reconfigured

copy from its reference number in the original DB (unless you use the same

SAMEREF option).

3.11 Advanced Reconfiguration

The previous sections in this chapter describe how a single DB can be reconfigured. In a

real PDMS project, with many DBs of different types and with reference attributes

pointing from one DB to several other DBs, reconfiguration is usually a more complex

process.

This section describes how one or more DBs can be reconfigured in such an

environment. It also describes how part of a DB can be reconfigured, rather than the

whole DB.

Note: If the SAMEREF option is used, the reconfiguration is much simpler

3.11.1 References Between Databases

A DB often contains elements which have reference or reference array attributes which

point into other DBs. For example, one Design DB could contain a Branch connected to a

Nozzle in another Design DB. The HREF (or TREF) attribute of the Branch would point

into the second DB and the CREF attribute of the Nozzle would point back into the first

DB. See example below:

DESIGN DB 1

DESIGN DB 2

Branch /150-B1

Nozz /E1-N2

CREF /150-B1

HREF /E1-N2


23/247

Reconfiguration


Similarly, references can exist from Design DBs into Catalogue DBs (the SPREF

attribute of a piping component pointing to an SPCOM, for example), but references

cannot exist from a Catalogue DB back into a Design DB.

When a DB is reconfigured without the SAMEREF option, most of the reference numbers

of its elements will change. To maintain the integrity of pointers into the DB from other

DBs, the contents of any DB which might point to elements in the reconfigured DB are

scanned and the reference or reference array attributes are changed to point to the

correct element once more.

For example, assume that the reference number of an SPCOM in a Catalogue DB

changes from =17/3108 in the original DB to =49/2014 in the reconfigured copy. All

piping components whose SPREF attribute was previously set to =17/3108 must have

SPREF reset to =49/2014. Such components might exist in several DBs.

Reference resetting is performed by the RCFUPDATE command described in the nextsection.

3.11.2 Updating References into a Reconfigured Database

While a DB is being reconfigured without the SAMEREF option, RECONFIGURER

builds up an index of the reference numbers of all elements in the source DB versus

their corresponding new reference numbers in the destination DB. The RCFUPDATEcommand uses this index to check reference pointers in other DBs and update them to

point to the correct elements in the reconfigured DB. Examples of the use of this

command are:RCFUPDATE DB MASTER/DESIGN

Updates references to the reconfigured DB from DB MASTER/DESIGN.

RCFUPDATE MDB /USERA

Updates all references to the reconfigured DB from DBs in MDB /USERA.

RCFUPDATE TEAM USER

Updates all references to the reconfigured DB from DBs owned by team USER.

Notes:

The RCFUPDATE command must be given immediately following a RECONFIGURE

operation.As the RCFUPDATE command may cause a DB to be written to, you must have Read-Write access to all relevant DBs. The DBs must not be in active use by any other user

of the project.

Care should be taken when reconfiguring to the same DB number. If you update a

DB twice, the resulting reference numbers could be wrong. For example:

Old reference New reference

/VESS1 =123/456 =123/457

/VESS2 =123/457 =123/458


24/247

Reconfiguration


Version 11.5

Thus, giving the RCFUPDATE command twice results in the reference =123/456being reset to =123/458.

RECONFIGURER knows which types of DB can be pointed to by reference attributes in

other types of DB, and so does not attempt to update DBs which could not possibly point

to the latest reconfigured copy. A report is output which lists which DBs were and which

were not updated.

The table of references is maintained across multiple reconfigurations, as long as you do

not exit from ADMIN.

3.11.3 Saving the Reference Number Index

The RCFUPDATE command is usually given immediately after databases have beenreconfigured. The index can be saved to a file when the reconfiguration has beencompleted; to be used at a later date.

The commands are DUMP to save to a file, and LOAD to load a file. For example:

LOAD /DUMP1FROM DB MASTER/DESIGNTO DB MASTER/DESNEWRCFCOPY ALLRECONFIGUREDUMP /DUMP2

These commands will read an existing reference number index from file /DUMP1, add

the reference number pairs from the specified reconfigurationto it, and then write the

index out again to the file /DUMP2.If a number of databases have been reconfigured, the dump file will record the cross-

reference index for all of them.

The LOAD command replaces the current index. The command LOAD APPEND appendsthe table to the current index.

3.11.4 Copying Parts of Databases

The RCFCOPY ALL command copies all the elements in the source DB World into thedestination DB World. If the World of the destination DB already contains members,

then the elements from the source DB are added to these.

The RCFCOPY command can be used to define the root elements to be copied. A rootelement is any element owned by the World, that is:

BLTA CASW CATA CCTA CMPW CONW DEPTGPWL LIBY MATW RUNW SITE SPWL UNIT UWRL

When a root element is copied, all elements owned by it are also copied. A maximum of

300 root elements may be specified in a single copy list.

The selective commands RCFCOPY CATALOGUE and RCFCOPY SPECIFICATIONScause the first root elements of type CATA and SPWL, respectively, to be copied from

the list part of the World in the source DB.


25/247

Reconfiguration


To copy only part of a DB, one or more root elements must be specified (by name or

reference number) in a RCFCOPY command. For example:

RCFCOPY /SITE-A SITE-7

Elements of any other types will be copied into the destination DB as NULL elements,

that is they will be created as floating elements, not owned by any higher-level element.

This does not mean that they are inaccessible. As long as such an element is named (or

you know its new reference number) it can be incorporated as a member of any suitable

parent element by using the INCLUDE command.

If you are not at a top level element, there must be an existing element in the

destination DB into whose list part you wish to incorporate the element being copied.

This is done using the INTO option of the RCFCOPY command. For example:

RCFCOPY /ZONE5A INTO /SITE-3

would copy the Zone /ZONE5A and make it the last member of the Site /SITE-3.

If the intended owning element does not already exist in the destination DB at the

beginning of Pass 2, the listed root element will not be copied. For example:

RCFCOPY /SITE-3 /ZONE5A INTO /SITE-3

is not allowed.

INTO cannot be used when the destination is FILES rather then a DB. The word ANDand the comma (,) may be used as separators to improve readability, thus:

RCFCOPY /SITE-5, /ZONE5A INTO /SITE-3, /SITE-6 AND /SITE-12

Several RCFCOPY commands can be given in sequence to add elements to the copy list.For example, the sequence

RCFCOPY /SITE-5RCFCOPY /ZONE5A INTO /SITE-3RCFCOPY /SITE-6, /SITE-12

is exactly equivalent to the RCFCOPY command in the previous example.

If an element is quoted in the copy list but does not exist in the source DB, an error

message is output and the element is not copied. Since RCFCOPY commands areadditive, a correcting command may be given on the next line. For example:

RCFCOPY /SITE1 /SITE2 /SITR3 /SITE4(24,16) /SITR3 not found (error message)

Since SITE1, SITE2 and SITE4 are already in the copy list, all that is needed to add

SITE3 is:

RCFCOPY /SITE3

Note: Partial reconfiguration of PADD DBs is only allowed for picture elements (i.e.

SHEE, BACK, OVER, SYLB, LALB) and above.


26/247

Reconfiguration


Version 11.5

3.11.5 Copying Groups

If a Group World is specified in a RCFCOPY command, only the Group World and itsowned Groups are copied. Errors will occur in Phase 2 if the Group members have not be

copied as well.

It is meaningless to try to reconfigure a group on its own.

3.12 Transferring Data Between Projects

RECONFIGURER provides a simple means of transferring data from one project to

another, on the same type of computer, provided both projects are running under the

same major version of PDMS and provided cross-referencing between DBs is consideredlogically.

The transfer operation in this case requires the use of the FROM FILES and TO FILESoptions of the FROM and TO commands. In the simplest case, namely the transfer of thecontents of a single DB, such as a Catalogue, the following sequence of commands could

be used:

In the source project:

FROM DB /CATOLD Specify source DB.

TO FILES /TEMP1 /TEMP2 Only pass 1 of reconfiguration to be

carried out; partially reconfigured

data to be stored in named files.RCFCOPY ALLRECONFIGURE

and in the destination project:

FROM FILES /TEMP1 /TEMP2 Partially reconfigured data to be

recovered from named file;

TO DB /CATNEW pass 2 of reconfiguration to be done.RCFCOPY ALLRECONFIGURE

Note: FREE (i.e. Read/Write) access is required to both projects.

If the contents of more than one DB are to be transferred, provided no reference

attributes point outside the set of DBs being transferred, an extension of the same

procedure could be used. Consider the transfer of the whole of one Design DB, the whole

of a Catalogue DB and one item of equipment from a second Design DB, thus:

Source DB Elements Transferred Destination DB

CIVIL/STRUC4 Whole Design DB STEEL/MAIN

ANSI/MASCAT Whole Catalogue DB CATAL/MAIN

SITE-A One Site EQUIP/MAIN

The reconfiguration commands should be given in the following order:

In the source project:


27/247

Reconfiguration


FROM DB ANSI/MASCATTO FILES /REC1A /REC1B

RCFCOPY ALLRECONFIGURE Copies the Catalogue DB first

FROM DB CIVIL/STRUC4TO FILES /REC2A /REC2BRCFCOPY ALL

RECONFIGURE Copies the Design DB

FROM DB VESSEL/V25CTTO FILES /REC3A /REC3BRCFCOPY /SITE-A

RECONFIGURE Copies the Site

and in the destination project:FROM FILES /REC1A /REC1BTO DB CATAL/MAIN

RECONFIGURE Creates Catalogue DB

FROM FILES /REC2A /REC2BTO DB STEEL/MAIN

RECONFIGURE Creates Design DB

FROM FILES /REC3A /REC3BTO DB EQUIP/MAIN

RECONFIGURE Creates equipment item

RCFUPDATE DB STEEL/MAINRCFUPDATE DB EQUIP/MAIN Gives correct cross-references

3.13 Upgrading a Project

The XREF and RESETXREFS commands described in this section are intended for useduring the upgrading of a project from one version of PDMS to the next. They operate on

the data during its transfer from the source DB to the destination DB such that the data

can be modified to conform to the requirements of a new DDL.

The commands are used to ensure that all cross-references are correctly set after amulti-DB reconfiguration. They are particularly useful in the case where two databases

of the same type are referencing each other.They are also useful when copying between

projects, as an alternative to the UPDATE command. When copying between DBs withthe same DB number, it is best to use XREF and RESETXREFS.

These commands are normally handled automatically by the upgrade macros supplied

with a new version of PDMS. They may be used independently of the upgrade macros by

the experienced user, preferably after consultation with AVEVA Solutions Ltd, and it is

for this reason that they are described here.


28/247

Reconfiguration


Version 11.5

XREF may be used to generate a list of the reference numbers of all elements whichneed updating for each DB. The list is created during the restructuring of the new DBs

in Phase 2 of Pass 2.

This list is then used to monitor a partial updating operation, which ensures that all

references are reset into every element which has been affected by a DB reconfiguration.

The partial update is controlled by the RESETXREFS command, which is related to theRCFUPDATE DB command. The RESETXREFS function applies only to elements whosereference numbers appear in the corresponding XREF file.

For example:

RESETXREFS WITH /REFFILE RESOLVE DB MASTER/DESNEWRESET /REF2 RESOL /NEWDB

Here /REFFILE is the name of the file generated by the XREF command andMASTER/DESNEW is the corresponding DB to be updated.

In effect the RESETXREFS command opens the specified XREF file and the RESOLVEcommand part initiates the appropriate update. The macro files generated by the

UPGRADE command in ADMIN ensure that the RESET filenames are correctlymatched to the corresponding RESOLVE dbnames.

Note: The XREF file only indicates those elements which need to be updated. The

DUMP files are still required in order to match the old and new reference

numbers correctly.

When reconfiguring a whole project, it is impossible to order databases of the same type

so that all references are resolved as the reconfiguration proceeds. The XREF andRESETXREFS commands are needed to tidy up the references.

Note: The UPGRADE command is used when a project is being upgraded from anearlier version of PDMS.

The following is an example of a sequence of commands:

TO DB XX/A2FROM DB XX/A1XREF /XX1RCFCOPY ALLRECONFIG

::

TO DB XX/B2FROM DB XX/B2RCFCOPY ALLRECONFIGRESET WITH /XX1 RESOLVE DB XX/A2

A more general command sequence for a project upgrade is shown in the following input

and output macros:

Input macro

Write Upgrading project CJB

Write From PDMS10 to PDMS11


29/247

Reconfiguration


Write Input phase $R6

Checkddl is 11To db STANA/SAPROPFrom files /REC1A /REC1BXref /REC1XReconfigureTo db DEREKF/DFPROPFrom files /REC2A /REC2BXref /REC2XReconfigureTo db ALANC/ACPROPFrom files /REC3A /REC3BXref /REC3X

ReconfigureTo db TAMH/THPROPFrom files /REC4A /REC4BXref /REC4XReconfigureTo db TAMH/PROP_ATESTFrom files /REC5A /REC5BXref /REC5XReconfigureReset with /REC1XResolve db STANA/SAPROPReset with /REC2X

Resolve db DEREKF/DFPROPReset with /REC3XResolve db ALANC/ACPROPReset with /REC4XResolve db TAMH/THPROPReset with /REC5XResolve db TAMH/PROP_ATESTFinish

Output macro

Write Upgrading project CJB Write From PDMS10 to PDMS11

Write Output phase $R6UPGRADE ONFrom db STANA/SAPROPTo files /REC1A /REC1BCopy allReconfigureFrom db DEREKF/DFPROPTo files /REC2A /REC2BCopy allReconfigureFrom db ALANC/ACPROP

To files /REC3A /REC3B


30/247

Reconfiguration


Version 11.5

Copy allReconfigure

From db TAMH/THPROPTo files /REC4A /REC4BCopy allReconfigureFrom db TAMH/PROP_ATESTTo files /REC5A /REC5BCopy allReconfigure

3.14 Reconfiguration Messages

During the various stages of the reconfiguration process, messages will be output. This

is particularly so during Pass 2, in which the data from the intermediate files is used to

reconstruct the element hierarchy in the destination DB.

In the simplest case these messages will just indicate the start and finish of each phase,

and confirm that all elements and their attributes were correctly placed. In a more

complex case it is probable that a number of error messages will also be output,

indicating potential problems in building up an unambiguous structure in the new DB.


31/247

Reconfiguration


3.14.1 Standard Information MessagesThe progress-monitoring messages, which indicate the stages reached during the

reconfiguration, are self-explanatory. They are:

*** Pass one initiated ****** Pass one completed ****** Pass two initiated ***:*** Pass two completed ******Reconfiguration Completed

After the reconfiguration has been completed, a summary of any problems found during

Pass 2. This will contain zero values where no problems were found.The format of this report is:

integer Elements were not defined in the DDL

integer Elements have been lost

integer Elements are no longer named

integer Attributes were incorrectly defined

integer Elements were not inserted

whereinteger is the relevant number.

3.14.2 General Format of Pass 2 Error Messages

In addition to the standard information messages described above, a range of error

messages may be generated during Pass 2. These messages have the general format:

CODE TYPE OLDREF NEWREF NAME

although some parts of this may be omitted.

For example:

EN EQUIP #10/21 =12/12 /NEWNAME

#EAE SHEE #88/842 =16/2417 /DR1/S5

*ENID SITE #15/23

The individual parts of the message are:

CODE: Identifies the nature of a message arising from the creation or naming of

an element. The codes used are detailed in the next section.

TYPE: The type of element, e.g. SITE, BRAN, SHEE etc.

OLDREF The reference number of the element in the source DB (starting with #).

NEWREF: The reference number of the corresponding element created in the

destination DB (starting with =). This will be blank if the element could

not be created.

NAME: The name given to the element. This applies only if the message is coded

EN to indicate that the element has been named (see next section).


32/247

Reconfiguration


Version 11.5

3.14.3 Codes Used to Identify Message Types

The coded prefix to each message comprises two parts. The first character is one of thefollowing:

A space indicates information rather than an error

An asterisk (*) indicates an error concerning the creation or naming of an element

A hash (#) indicates an error concerned with an attribute

The remaining characters, which give more explicit meaning to the message, are

explained in the following subsections.

Information-only Messages (prefix: space)

There are two possible codes:EC Element Created

EN Element Named

These are output as the reconfiguration proceeds and each message ends with the name

of the copied element.

Error Messages Relating to Elements (prefix: asterisk)

*ENID ElementsNot In DDL

The element could not, therefore, be created. This can occur when the element type is

not permitted in the list part of the element above it in the DB hierarchy, for example, if

an attempt is made to reconfigure FROM FILES into a DB of the wrong type.

*ENI ElementNot Inserted

An attempt was made to insert the element into a list where it is no longer permitted.

*EL Element Lost

Elements in the list part of ones that cannot be created are lost, since they cannot be

created either.

Error Messages Relating to Attributes (prefix: hash sign)

These all begin with

#EAE ElementAttribute Error

followed by one or more other messages giving more information about the error.

3.15 Database Transfers between Computers

Note: The hardware platforms currently supported allow binary compatibility of

databases, and so the information in this section will not usually be needed.

RECONFIGURER can be used for the transfer of PDMS DBs between different

computers, which may be of different types. Because reconfiguration is a two-pass

operation, the data can be copied from one computer and read back into a different one.


33/247

Reconfiguration


The transfer operation is essentially an extension of the procedure for copying data

between projects, described in Section 3.12. RECONFIGURER makes provision for

translating the coding of the intermediate files to ensure compatibility between thelanguage requirements of different computers.

An alternative method of transferring data between different computers is to use the

OUTPUT command in Design, Draft, Paragon or Lexicon. For details of other data

transfer methods, see the VANTAGE PDMS DESIGN Reference Manual Part 1

(OUTPUT command).

3.16 Binary and Character Files

Data can be stored in two formats: Binary files are in a compact machine-readable form, but are generally specific to

a particular type of computer.

Character files (which are usually in ASCII code) generally have to be much

larger to hold the same amount of information, but are human-readable. Character

files can be transferred relatively easily between different types of computers.

PDMS DBs are stored as binary files so that large amounts of data can be held

efficiently. RECONFIGURER provides a means to convert PDMS DBs from binary files

into character files and vice versa.

3.17 The Transfer Process

The files used by the transfer process are not the PDMS DBs themselves but the

(binary) intermediate files created by Pass 1 of a reconfiguration. These are converted

into larger, but easily transportable, character files by the TO FORMATTEDFILEScommand. The files can then be transferred to the target machine via a communications

network or magnetic tape and converted back into Pass 1 temporary file format by the

FROM FORMATTEDFILES command. For example:

On source machine:

FROM DB MASTER/DESITO FORM /F1 /F2RCFCOPY ALLRECONFIG

On destination machine:

FROM FORM /F1 /F2TO DB MASTER/DESIRECONFIG


34/247

Reconfiguration


Version 11.5

3.18 Reconfiguring a Global Project

We recommend that you use the SAMEREFoption when reconfiguring a Global project.We also recommend that there are no users in the database at the primary location

when reconfiguring back to the SAMEREF database.

Databases can only be reconfigured at their primary locations.

Note that when a project database is reconfigured, the database sessions will effectively

be lost. Thus the ability for Global to send only session changes is lost as well. When the

next update occurs between locations, the entire database will be sent via the Global

daemon. This can take some time if the database is large.

3.19 Reconfiguring Extracts

3.19.1 Outputting Changes Only

The default for reconfiguration is that, when reconfiguring an extract, only changes

made in the extract are output. To output all elements, as in normal reconfiguration, the

keyword FULL must be added to the RECONFIGURE command line. For example:

RECONFIG FULL

3.19.2 RECONFIG SAMEREF FULLThe SAMEREF Option

The SAMEREF option is always used for extracts. You need not to enter the SAMEREFoption; it is assumed.

This means that you can not reconfigure to DBs of a different DB number.

3.19.3 The SESSIONS Option

The SESSIONS option is always used for extracts. You need not enter the SESSIONS

option; it is assumed.


35/247

Reconfiguration


3.19.4 Reconfiguring a Single ExtractThe procedure for reconfiguring a single leaf extract is as follows:

1. Reconfigure from the DB to a file.

2. REVERT the extract to Session 1.

3. MERGE CHANGES to remove the intermediate session.

4.Reconfigure from the file to a DB.

An alternative strategy would be to replace Steps 2 and 3 by a DB deletion and a DB

creation.

The procedure is similar for single extracts that own other extracts. The only differenceis:

The MERGE CHANGES command will leave sessions referred to by child extracts.Thus, the resultant file will be larger than it would have been had there been no

extract children.

The alternative approach of deleting and recreating the extract is not possible

unless all child extracts are also deleted and recreated.

The Master DB should be reverted to Session 2 rather than Session 1.

3.19.5 Reconfiguring a Family of Extracts

When reconfiguring a whole extract family, the following considerations apply:

The REVERT/MERGE operation must be done bottom-up, to minimise the numberof sessions kept.

Reconfiguring from databases to files must be done top-down.

Reconfiguring back from files to databases mustalso be done top-down, and you

must complete the reconfiguration for the whole extract. For example, if you

reconfigure all three database levels of a three level extract to files but only

reconfigure the top two file levels back to databases, the third database will be

corrupted due to the reconfiguration of the other two. For further details, see

section 3.19.7 below.

Before reconfiguring out from a file, refresh the extract.

Before reconfiguring in from a file, the extract must be refreshed from its parent.

For example, given a simple two-level extract containing TEAMA/MASTER,

TEAMA/EXTRACT, the sequence would be:


36/247

Reconfiguration


Version 11.5

1. Refresh TEAMA/EXTRACT.

2. Reconfigure TEAMA/MASTER to file /A, /B.

3. Reconfigure TEAMA/EXTRACT to file /C, /D.

4. REVERT TEAMA/EXTRACT to Session 1.

5. MERGE CHANGES on TEAMA/EXTRACT.

6. REVERT TEAMA/MASTER to Session 2.

7. MERGE CHANGES on TEAMA/MASTER.

8. Reconfigure from file /A, /B to TEAMA/MASTER.

9. Refresh TEAMA/EXTRACT (to pick up changes made in Step 8).

10.Reconfigure from file /C, /D to TEAMA/EXTRACT.

3.19.6 The RCFUPDATE command

When the RCFUPDATE command is used on an extract, all affected attributes will beupdated regardless of whether or not the element has been claimed to the extract. This

means that, if many extracts of the same extract family are updated, the same changes

will be made to each of the extracts.

3.19.7 Example of Reconfiguring a Three Level ExtractConsider this three-level extract:

All databases must be reconfigured to files first and then reconfigured from the files to

the databases, in the order; MASTER, EXT, EXTBOT. If this sequence of operations is

not completed, then databases will be corrupted. For example, if EXTBOT is not

reconfigured from file, then EXTBOT will be corrupted as a result of the reconfiguration

of the other two databases. It is therefore suggested that you make backups of databases

before reconfiguring them.

The sequence of commands to reconfigure the above three level extract could therefore

be:

(Note that the REFRESH, REVERT and MERGE CHANGES commands have not beenshown below.)

MASTER

EXT

EXTBOT


37/247

Reconfiguration


FROM DB CTBATEST/MASTERTO FILE /MASTERA /MASTERB

RCFCOPY ALLRECONFIG SESSIONS

FROM DB CTBATEST/EXTTO FILE /EXTA /EXTBRCFCOPY ALLRECONFIG SESSIONS

FROM DB CTBATEST/EXTBOTTO FILE /EXTBOTA /EXTBOTBRCFCOPY ALLRECONFIG SESSIONS

FROM FILE MASTERA /MASTERBTO DB CTBATEST/MASTERRECONFIG

FROM FILE EXTA /EXTBTO DB CTBATEST/EXTRECONFIG

FROM FILE EXTBOTA /EXTBOTBTO DB CTBATEST/EXTBOTRECONFIG

It is not necessary for the reconfiguration back from file to be done within the same

session of RECONFIGURER. For example, in aglobal project where MASTER, EXTand EXTBOT are primary at different locations, then the following sequence could befollowed:

1. At location A (primary location for MASTER):

FROM DB CTBATEST/MASTERTO FILE /MASTERA /MASTERBRCFCOPY ALLRECONFIG SESSIONS

2. At location B (primary location for EXT):

FROM DB CTBATEST/EXT

TO FILE /EXTA /EXTBRCFCOPY ALLRECONFIG SESSIONS

3. At location C (primary location for EXTBOT):

FROM DB CTBATEST/EXTBOTTO FILE /EXTBOTA /EXTBOTBRCFCOPY ALLRECONFIG SESSIONS

Steps 1 to 3, reconfiguring from databases to files, can be done in parallel.


38/247

Reconfiguration


Version 11.5

4. At location A (primary location for MASTER):

FROM FILE /MASTERA /MASTERBTO DB CTBATEST/MASTERRECONFIG

The user must now propagate the whole database to locations (B) and (C).

5. At location B (primary location for EXT)

FROM FILE /EXTA /EXTBTO DB CTBATEST/EXTRECONFIG

The user must now propagate the whole database to locations (C) and (A).

6. At location C (primary location for EXTBOT)

FROM FILE /EXTBOTA /EXTBOTBTO DB CTBATEST/EXTBOTRECONFIG

The whole database will be propagated to locations (A) and (B) automatically.

Steps 4 to 6, reconfiguring from files to databases, should be done consecutively.

3.19.8 Reconfiguring the Transaction Database in a Global Project

The Global Daemon stores most of the commands that it is asked to perform at a

location in a transaction database. Each location has its own transaction database.For details, see Chapter 5,The Transaction Database.

If a transaction database becomes corrupt, it may be necessary to reconfigure it. For

information about this, see Running Global Projects with VANTAGE PDMS.

Note: The daemon for a location must be stopped before reconfiguring its transaction

database.


39/247


4 The System and Global Databases

This chapter describes the ADMIN elements and their attributes, which are stored in

the System database (and, for a Global project, the Global database).

You can navigate to the elements in the System and Global databases, and query their

members and attributes in the normal way.

4.1 Standard Projects: the System Database

Figure 4-1 shows the structure of the System database in a standard (that is, non-

global) project.

A list of the elements and their attributes follows. For the attributes, the default value

(which is some cases, for example, the Owner of the Team World, is the only allowable

value) is shown, and there may also be a short explanation or additional information.

Some elements can exist in more than one place in the database hierarchy, for example,

DB Lists are owned by Teams and DB Sets. In this case the element is only described

once.

Session information is stored separately in the COMMs database; and the MISC

database stores inter-db macros and messages. The communications world element in

the COMMs database contains the project lock. This may be set or cleared using LOCK

and UNLOCK syntax.


40/247

The

Systema

ndGlobalDatabases

VAN

TAGEPDMSADMIN

4-2

Com

mandReferenceManual

Vers

ion11.5

Figure4-1

TheSystemDatabase

Thenamesofthetop-leveleleme

nts(forexample,/*S,)areshown,followedbytheelement

typeandashortexplanation.

RUNF

Modules

Runfileinformation:youcan

onlymodifytheseelements

usingtheMOD

ULEandEDIT

commands

/*

WORLD

World

FTWL

Font

World

FNTF

Font

Files

/*

M

MD

BW

MDB

World

M

DB

MDBs

D

B

D

Bs

DBL

DBList

/*DS

DBSTWL

DBSet

World

DBSET

DBSets

/*RO

ROWL

R

ole

W

orld

R

OLE

Roles

PEROP

Perops

/*SC

SCOW

Scope

World

SCOPE

Scopes

/*ACR

ACRW

ACR

World

ACR

ACRs

ACRST

ACR

Groups

ACRL

ACRLists

/*ST

STWLD

Stamp

World

STAMP

Stamps

STLST

StampList

/*T

TMWL

TeamWorld

TEAM

Teams

DBLI

DB

Lists

USLI

U

ser

Lists

DB

DBs

USER

Users

/*U

USWL

UserWorld

TMLI

Team

Lists

EXTLI

Extract

Lists

DB

DBs

DBSTL

RFWL

Module

World

/*S

STAT

StatusWorld


41/247

The System and Global Databases

VANTAGE PDMS ADMIN 4-3Command Reference ManuaVersion 11.5

The Project Status World (STAT)

Attributes

Name /*S

Lock false

Owner /*

Prjnumber unset Project number 16 character text

Maxusers 999999 Integer =< 999999

Prjlck false Not used, see Comms DB

Prjdesc unset Project description 120 character text

Infa unset Project name 120 character text

Infb unset Project message 120 character text

Charset 0 Multibyte character set

Locrf nulref in a non-global project

The Runfile or Module World (RFWL)

Attributes

Name /name

Lock false

Owner /*S

The Runfile or Module Element (RUNF)

RUNF elements own runfile information: you can only modify these

elements using the MODULE and EDIT commandsAttributes

Name /name

Lock false

Owner /*RFWL

Smno Module number, for example: 1 for ADMIN

Security For example: Free for DESIGN

The Font World (FTWL)

Attributes

Name /name

Lock false

Owner /*S

Fontdirectory /%PDMSEXE%/

The Font File Element (FNTF)

Attributes

Name /name

Lock false

Owner /name


42/247



Version 11.5

Irno US

Stno LINE

Fnma unsetFnmb unset

Faangle 17

The Team World (TMWL) (not used in Global projects)

Attributes

Name /*T

Lock false

Owner /*

The Team Element (TEAM)

Attributes

Name /name

Lock false

Owner /*T

Description unset 120 character text

The Database List Element (DBLI)

Attributes

Name /name

Lock falseOwner /name

The Database Element (DB)

Attributes

Name /name

Lock false

Owner /name

Dbno n

Stype DESI Database type

Fino n File number

Area 0 Area number

Daccess Update Access type

Claimdb Implicit or Explicit for Multiwrite DBs, or unset


Projid unset 3 character text

Fcpyref Nulref

Bcpyref Nulref

Extractno n

Extract owner/name

Variant false

Controlled false


43/247



The User List Element (USLI)

Attributes

Name /name

Lock false

Owner /name

The User World (USWL)

Attributes

Name /*U

Lock false

Owner /*

The User Element (USER)Attributes

Name /name

Lock false

Owner /*U

Password /name

Security General


Acrli unset List of ACRs and ACRGRPs

The Team List Element (TMLI)

Attributes

Name /name

Lock false

Owner /name

The Extract List Element (EXTLI)

Attributes

Name /name

Lock false

Owner /name

The MDB World (MDBW)

Attributes

Name /*M

Lock false

Owner /*


44/247



Version 11.5

The MDB Element (MDB)

Attributes

Name /name

Lock false

Owner /*M

CurdbsList of current DBs


The DB Set World (DBSTWL)

Attributes

Name /*DSLock false

Owner /*

The DB Set Element (DBSET)

Attributes

Name /name

Lock false

Owner /*DS


The Database Set List Element (DBSTL)

Attributes

Name /name

Lock false

Owner /name

DBSTF Reference to a DBSET

The Database List Element (DBL)

Attributes

Name /name

Lock false

Owner /name

The Role World (ROWL) (Not used in Global projects)

Attributes

Name /*RO

Lock false

Owner /*

LACR false Sets Data Access Control on or off (Standard projects only)


45/247



The Role Element (ROLE)

Attributes

Name /name

Lock false

Owner /*T


The Perop Element (PEROP)

Attributes

Name /name

Lock false

Owner /name

Affirm trueOpcreate ignore

Opmodify ignore

Opdelete ignore

Opclaim ignore

Opissue ignore

Opdrop ignore

Eclass unset Element Class

Aclass unset Attribute Class

Condition unset

Acrmessage unset

Note on setting the ECLASS attribute:

The syntax is:

.-----------

For example:

ECLASS BRANCH HIERARCHY EQUI HIERARCHY STRU

will include Branch and Equi members, but only STRUs themselves.

The Scope World (SCOW)

Attributes

Name /*SC

Lock false

Owner /*


46/247



Version 11.5

The Scope Element (SCOPE)

Attributes

Name /name

Lock false

Owner /*SC


Scosel unset Scope selection PML expression

The Stamp World (ST

Documents

Admin Reference