ADMIN Command Reference Manual

PDMS ADMIN
Command Reference Manual

Version 11.6SP1
PDMS1161/ADMIN Command Reference Manual Issue 260605
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 2005 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
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK
Revision History
Date March 2003 Sept 2004 June 2005 Version 11.5 11.60 11.6.SP1 Notes Miscellaneous updates for this release. Miscellaneous updates for this release. Updates and minor corrections.
VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1
Revision History-i
Revision History
Revision History-ii
Contents
1
1.1 1.2
Introduction ................................................................................................... 1-1

Macros .........................................................................................................................1-1 How to Use This Manual..............................................................................................1-2
2
2.1 2.2
Stand-Alone DICE.......................................................................................... 2-1

DICE Errors..................................................................................................................2-1 DICE Commands .........................................................................................................2-2
3
3.1 3.2 3.3 3.4
Reconfiguration............................................................................................. 3-1
The Reconfiguration Process.......................................................................................3-1 Starting up RECONFIGURER .....................................................................................3-2 Administrative and Querying Commands ....................................................................3-2 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 Using the SAMEREF Option........................................................................................3-6 Using the SESSIONS Option.......................................................................................3-6 Listing the Reference Number Index ...........................................................................3-7 Global Projects.............................................................................................................3-8 Controlling RECONFIGURER Output ..........................................................................3-8 Copies and Reconfigured Copies of DBs ....................................................................3-9 3.10.1 Copies.. .........................................................................................3-9 3.10.2 Reconfigured Copies ...................................................................................3-9 Advanced Reconfiguration.........................................................................................3-10 3.11.1 References Between Databases ...............................................................3-10 3.11.2 Updating References into a Reconfigured Database ................................3-11 3.11.3 Saving the Reference Number Index.........................................................3-12 3.11.4 Copying Parts of Databases ......................................................................3-12 3.11.5 Copying Groups.........................................................................................3-14 Transferring Data Between Projects ..........................................................................3-14 Upgrading a Project ...................................................................................................3-16 Reconfiguration Messages ........................................................................................3-18 3.14.1 Standard Information Messages................................................................3-20 3.14.2 General Format of Pass 2 Error Messages ...............................................3-20 3.14.3 Codes Used to Identify Message Types ....................................................3-21 Database Transfers between Computers ..................................................................3-21 Binary and Character Files ........................................................................................3-22 The Transfer Process ................................................................................................3-22
3.5 3.6 3.7 3.8 3.9 3.10
3.11
3.12 3.13 3.14
3.15 3.16 3.17
Contents-i
Contents
3.18 Reconfiguring a Global Project.................................................................................. 3-23 3.19 Reconfiguring Extracts .............................................................................................. 3-23 3.19.1 Outputting Changes Only.......................................................................... 3-23 3.19.2 RECONFIG SAMEREF FULL The SAMEREF Option .............................. 3-23 3.19.3 The SESSIONS Option ............................................................................. 3-23 3.19.4 Reconfiguring a Single Extract .................................................................. 3-24 3.19.5 Reconfiguring a Family of Extracts ........................................................... 3-24 3.19.6 The RCFUPDATE command .................................................................... 3-25 3.19.7 Example of Reconfiguring a Three Level Extract...................................... 3-25 3.19.8 Reconfiguring the Transaction Database in a Global Project ................... 3-27
4
4.1 4.2
The System and Global Databases ............................................................. 4-1

Standard Projects: the System Database ................................................................... 4-1 Global Projects .......................................................................................................... 4-10 4.2.1 Structure of the Local System Database................................................... 4-12 4.2.2 Structure of the Global Database.............................................................. 4-15
5
5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9
The Transaction Database ........................................................................... 5-1

Structure of the Transaction Database........................................................................ 5-1 TRMSGW element ...................................................................................................... 5-3 TRYEAR, TRMONT and TRDAY elements................................................................. 5-3 TRUSER and TRLOC elements .................................................................................. 5-3 TRINCO element (Input Command) ............................................................................ 5-4 TROUCO element (Output Command) ....................................................................... 5-7 TROPER element (Operation) .................................................................................. 5-10 TRMLST, TRSLST, and TRFLST elements .............................................................. 5-11 TRMESS, TRSUCC, and TRFAIL elements ............................................................. 5-12
6
6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9
Command Summary ..................................................................................... 6-1

Project Definition ......................................................................................................... 6-1 Project Administration ................................................................................................. 6-2 Global Project Administration ...................................................................................... 6-2 Module Definition......................................................................................................... 6-3 Font Definition ............................................................................................................. 6-3 Querying...................................................................................................................... 6-3 General PDMS Commands......................................................................................... 6-4 Data Integrity Checking ............................................................................................... 6-4 Reconfiguration ........................................................................................................... 6-4
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 ALPHA (General PDMS Command) ................................................................................ 7-15
Contents-ii VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1
Contents
BACKTRACK (Project Administration) ............................................................................7-16 BRIEF (Reconfiguration) ...................................................................................................7-19 CANCELCOMMAND (Global Project Administration) ....................................................7-20 CDESC (Project definition) ...............................................................................................7-21 CHANGE (Project definition) ............................................................................................7-22 CHECK (Data Integrity Checking) ...................................................................................7-26 CHECKOPTION (Data Integrity Checking) .....................................................................7-29 CNAME (Project definition) ..............................................................................................7-33 COPY (Project definition) .................................................................................................7-35 CREATE (Project definition).............................................................................................7-37 CURRENT (Project definition)..........................................................................................7-44 DADD (Project definition) .................................................................................................7-45 DEALLOCATE (Global Project Administration - Hub only) ............................................7-46 DEFER (Project definition) ...............................................................................................7-48 DELETE (Project definition) .............................................................................................7-49 DREMOVE (Project definition) .........................................................................................7-52 DUMP (Reconfiguration) ...................................................................................................7-53 DUPLICATENAMES (Global Project Administration) .....................................................7-54 EDIT (Module definition) ..................................................................................................7-56 ERRORFILE (Data Integrity Checking) ...........................................................................7-58 ERRORS (Reconfiguration) ..............................................................................................7-59 EXCHANGE (Project definition) .......................................................................................7-60 EXCLUDE (Project definition) ..........................................................................................7-61 EXPUNGE (Project administration) .................................................................................7-62 EXTERNAL (Data Integrity Checking) ............................................................................7-64 EXTRACT (Project administration)..................................................................................7-66 FINISH (General PDMS Command) .................................................................................7-69 FONTDIRECTORY (Font definition) ................................................................................7-70 FONTFAMILY (Font definition) ........................................................................................7-71 FROM (Reconfiguration) ...................................................................................................7-73 FULL (Reconfiguration).....................................................................................................7-74 GENERATE (Global Project Administration - Hub only) ................................................7-75 GETWORK (General PDMS Command) ..........................................................................7-77 HUBLOCATION (Global Project Administration - Hub only) .........................................7-78 INCLUDE (Project definition) ...........................................................................................7-80 INITIALISE (Global Project Administration) ....................................................................7-81 ISOLATION (Global Project Administration) ...................................................................7-82 LIST (Querying) .................................................................................................................7-83 LOAD (Reconfiguration)....................................................................................................7-86 LOCK (Project administration).........................................................................................7-87 MAKE GLOBAL (Global Project Administration) ............................................................7-88 MAXERRORS (Data Integrity Checking) ........................................................................7-89 MAXUSERS (Project Administration)..............................................................................7-90 MAXWARNINGS (Data Integrity Checking) ....................................................................7-91 MERGE CHANGES (Project Administration) ..................................................................7-92 MESSAGE (Project administration).................................................................................7-95 MODE (Data Integrity Checking).....................................................................................7-96 MODULE (Module Definition) ..........................................................................................7-97
VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1 Contents -iii
Contents
MOVE (Project administration) ....................................................................................... 7-99 NEW (Project definition and Global Project Administration) ...................................... 7-100 NEW STAMP (Project administration) .......................................................................... 7-102 PING (Global Project Administration)........................................................................... 7-104 PREVOWNER (Global Project Administration - Hub only) ......................................... 7-105 PROJECT (Project definition) ........................................................................................ 7-107 PURGE (Project Administration and Global Project Administration) ........................ 7-109 QUERY (Querying) ......................................................................................................... 7-110 RCFCOPY (Reconfiguration) ......................................................................................... 7-115 RCFUPDATE (Reconfiguration) ..................................................................................... 7-117 RCFUPGRADE (Reconfiguration).................................................................................. 7-118 RECONFIGURE (Reconfiguration) ................................................................................ 7-119 RECOVER (Global Project Administration).................................................................. 7-121 REINIT (Reconfiguration) ............................................................................................... 7-124 REMOTE (Global Project Administration) .................................................................... 7-125 REMOTEMESSAGE (Global Project Administration) .................................................. 7-131 REMOVE (Project definition) ......................................................................................... 7-132 RENEW (Global Project Administration) ...................................................................... 7-133 REORDER (Global Project Administration) ................................................................. 7-135 REPAIR (Global Project Administration) ...................................................................... 7-136 REPLICATE (Project definition)..................................................................................... 7-137 RESETXREFS (Reconfiguration) ................................................................................... 7-140 REVERT (Project administration) ................................................................................. 7-141 SAVEWORK (General PDMS Command) ..................................................................... 7-142 SET (Project definition and Global Project Administration) ....................................... 7-143 STATISTICS (Data Integrity Checking) ........................................................................ 7-144 STATUSSESSION (Querying)........................................................................................ 7-145 STOP (Data Integrity Checking) ................................................................................... 7-146 SYNCHRONISE (Global Project Administration) ......................................................... 7-147 SYSTAT (Querying) ........................................................................................................ 7-149 SYSTEMLOCATION (Global Project Administration - Hub Only)............................... 7-152 TADD (Project definition) ............................................................................................... 7-154 TERM (General PDMS Command) ................................................................................ 7-155 TO (Reconfiguration) ...................................................................................................... 7-156 TRANSFER (Global Project Administration) ................................................................ 7-158 TREMOVE (Project definition) ....................................................................................... 7-160 UNLOCK (Project administration) ................................................................................. 7-161 UPDATE (Global Project Administration) ..................................................................... 7-162 UPGRADE (Reconfiguration) ......................................................................................... 7-164 VB (Reconfiguration) ...................................................................................................... 7-165 XREF (Reconfiguration) ................................................................................................. 7-166
Index ...........................................................................................................................1
Contents-iv
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:
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 VANTAGE Plant Design Global User Guide, which also describes the concepts in Plant Design
VANTAGE PDMS ADMIN User Guide, which tells you how to set up and
Using PDMS ADMIN for a standard (non-global) project is described in the
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 in standard 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 PDMS when 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 VANTAGE Plant Design Software Customisation Guide and the VANTAGE Plant Design Software Customisation Reference Manual.
1-1
Introduction
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 Database applies to Global projects only, and describes the transaction database, the elements in it, and their attributes. Chapter 6, Command Summary applies 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.
1-2
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: STOP FINISH 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 of makmac.mac, the project configuration macro.
2-1
Stand-Alone DICE
2.2 DICE Commands

Set up the options you require using the following commands (see the appropriate command pages for details):
ERRORFILE MODE MAXERRORS MAXWARNINGS STATISTICS

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 EXTERNAL command cannot be used in stand-alone mode (or by REMOTE CHECK), because only one DB file can be accessed at a time.
2-2
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 of DDLs (Database Description Languages) and DABACON (the DAtaBAse CONtrol program), read the chapter The PDMS Database Management System in the VANTAGE PDMS 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 specified destination 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.
3-1
Reconfiguration
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 ABC user SYSTEM/XXXXXX admin 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. Gives information about the current active status of the project within 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 users entering the project. MESSAGE Sends messages to other users. Q DB Gives the type, number and filename of the specified DB, and a list of the MDBs of which it is a member. For example: Q DB CIVIL/JBX37C CIVIL/JBX37C DESI NUMBER 6 FILENAME /TVX000/TVX009 MDBS: /LAYOUT /TANKS Q COPIES Lists all DBs which are copies of the specified DB. For example: Q COPIES CIVIL/JBX37C DB 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. SYSTAT
3-2
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 the destination 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. 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. The second intermediate file is read and its contents used to set all reference attributes in the destination DB and to perform insertion operations.
PASS 2 - Phase 1
PASS 2 - Phase 2
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. 2. 3. Specify where the data to be reconfigured is coming FROM. Specify where the reconfigured data is going TO. Specify which parts of the source data are to be copied to the destination. Start the reconfiguration process.
4.
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
3-3
Reconfiguration
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 examples of the use of TO 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 database USERM/DESIGN, number 777, in current project

TO DBFILE /des008
Reconfigured data to go to specified file (assumes project directory is current directory) TO DB and 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 the same 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. This is 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 Copied

The RCFCOPY command specifies which parts of the source DB are to be copied to the destination. 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 of the 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.
3-4
Reconfiguration
Note that you must use RCFCOPY ALL if you intend to use the RECONFIGURE SESSIONS 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/DESIGN TO DB MASTER/DESNEW RCFCOPY ALL RECONFIGURE Note: In practice it would be advisable to use RCFUPDATE and DUMP in 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:
3-5
Reconfiguration
*** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC SITE #32/202 =42/205 Phase one complete - starting phase two *** Pass two completed *** ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 0 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/DESIGN TO FILE /F1 /F2 RCFCOPY ALL RECONFIGURE DELETE DB MASTER/DESIGN CREATE DB MASTER/DESIGN DESI DBNO nn FROM FILE /F1/F2 TO DB MASTER/DESIGN RECONFIG 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,
3-6
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, or GLOBAL DBs, and is not available for a partial reconfiguration. The following example illustrates the use of the SESSIONS option: FROM DB CTBATEST/DESI TO FILE /A /B RCFCOPY ALL RECONFIG 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 and extract number must be the same as the originating DB number and extract number. For example: FROM FILE /A /B TO DB CTBATEST/DESI RECONFIG 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/DESI RECONFIG FORCE
3.7 Listing the Reference Number Index

When a DB is reconfigured without the SAMEREF option, the reference numbers of the elements 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
3-7
Reconfiguration
3.8 Global Projects

In a Global project, you can reconfigure the System and Global databases. The commands are: FROM SYSTEM RECONFIGURE (The above command also works in a non-Global project.) FROM GLOBAL RECONFIGURE 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 BRIEF FULL
very brief output mode brief output mode full output mode
In VB (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
3-8 VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1
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 a negative 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 the following 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 NUMBER NUMBER NUMBER 2 2 5 FILENAME /%DRA000%/dra013 UPDATE FILENAME /%DRA000%/dra001 UPDATE FILENAME /%DRA000%/dra003 UPDATE FILENAME /%DRA000%/dra004 UPDATE
PIPEA/PIPEA DESI ADMIN/TEST USER/DRAFT DESI PADD
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 key features of reconfigured copies are:
3-9
Reconfiguration
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:
HREF /E1-N2 DESIGN DB 1 CREF /150-B1 Nozz /E1-N2 DESIGN DB 2
Branch /150-B1
3-10
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 next section.
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 RCFUPDATE command 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 DB MASTER/DESIGN INTERNAL Updates references in DB MASTER/DESIGN for any elements that have been copied with RCFCOPY ALLCONNECTIONS. Use this option with care because it is possible to update a reference that has already been changed by the RECONFIGURE command. 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 ReadWrite 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:
VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1 3-11
Reconfiguration
Old reference /VESS1 /VESS2 =123/456 =123/457
New reference =123/457 =123/458
Thus, giving the RCFUPDATE command twice results in the reference =123/456 being 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 been reconfigured. The index can be saved to a file when the reconfiguration has been completed; 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 /DUMP1 FROM DB MASTER/DESIGN TO DB MASTER/DESNEW RCFCOPY ALL RECONFIGURE DUMP /DUMP2
These commands will read an existing reference number index from file /DUMP1, add the reference number pairs from the specified reconfiguration to 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 crossreference index for all of them. The LOAD command replaces the current index. The command LOAD APPEND appends the 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 the destination 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 root element is any element owned by the World, that is: BLTA GPWL CASW CATA CCTA CMPW CONW DEPT LIBY MATW RUNW SITE SPWL UNIT UWRL
3-12
Reconfiguration
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 SPECIFICATIONS cause the first root elements of type CATA and SPWL, respectively, to be copied from the list part of the World in the source DB. 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 AND and 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-5 RCFCOPY /ZONE5A INTO /SITE-3 RCFCOPY /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 are additive, 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
3-13
Reconfiguration
Note:
Partial reconfiguration of PADD DBs is only allowed for picture elements (i.e. SHEE, BACK, OVER, SYLB, LALB) and above. Setting External References
3.11.4.1
In cases where you have made a partial copy of a database, sometimes it is necessary for you to ensure the external references are correct in the copied elements. For example, if you moved a piping zone to a different database while maintaining the references to an equipment zone which was to remain it the original database, the copied piping zone could have unset external references and the equipment zone would remain connected to the original piping zone. In these cases you can use the ALLCONnections option to set the external references for the reconfigurered elements: RCFCOPY /SITE1 INTO /SITE2 ALLCONNECTIONS This will set all references including those within the original database not in the list of copied elements. To update the references of the original database to point to the new copied elements use the RCFUPDATE INTERNAL command described in Section 3.11.2.
3.11.5
Copying Groups
If a Group World is specified in a RCFCOPY command, only the Group World and its owned 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 considered logically. The transfer operation in this case requires the use of the FROM FILES and TO FILES options of the FROM and TO commands. In the simplest case, namely the transfer of the contents of a single DB, such as a Catalogue, the following sequence of commands could be used:
3-14
Reconfiguration
In the source project: FROM DB /CATOLD TO FILES /TEMP1 /TEMP2
Specify source DB. Only pass 1 of reconfiguration to be carried out; partially reconfigured data to be stored in named files.
RCFCOPY ALL RECONFIGURE and in the destination project: FROM FILES /TEMP1 /TEMP2 TO DB /CATNEW RCFCOPY ALL RECONFIGURE Note:
Partially reconfigured data to be recovered from named file; pass 2 of reconfiguration to be done.
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 CIVIL/STRUC4 ANSI/MASCAT SITE-A In the source project: FROM DB ANSI/MASCAT TO FILES /REC1A /REC1B RCFCOPY ALL RECONFIGURE FROM DB CIVIL/STRUC4 TO FILES /REC2A /REC2B RCFCOPY ALL RECONFIGURE FROM DB VESSEL/V25CT TO FILES /REC3A /REC3B RCFCOPY /SITE-A RECONFIGURE and in the destination project: FROM FILES /REC1A /REC1B TO DB CATAL/MAIN RECONFIGURE Elements Transferred Whole Design DB Whole Catalogue DB One Site Destination DB STEEL/MAIN CATAL/MAIN EQUIP/MAIN
The reconfiguration commands should be given in the following order:
Copies the Catalogue DB first
Copies the Design DB
Copies the Site
Creates Catalogue DB
3-15
Reconfiguration
FROM FILES /REC2A /REC2B TO DB STEEL/MAIN RECONFIGURE FROM FILES /REC3A /REC3B TO DB EQUIP/MAIN RECONFIGURE RCFUPDATE DB STEEL/MAIN RCFUPDATE DB EQUIP/MAIN
Creates Design DB
Creates equipment item Gives correct cross-references
3.13 Upgrading a Project

The XREF and RESETXREFS commands described in this section are intended for use during 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 a multi-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 with the 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. XREF may be used to generate a list of the reference numbers of all elements which need 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 the RCFUPDATE DB command. The RESETXREFS function applies only to elements whose reference numbers appear in the corresponding XREF file. For example: RESETXREFS WITH /REFFILE RESOLVE DB MASTER/DESNEW RESET /REF2 RESOL /NEWDB Here /REFFILE is the name of the file generated by the XREF command and MASTER/DESNEW is the corresponding DB to be updated. In effect the RESETXREFS command opens the specified XREF file and the RESOLVE command part initiates the appropriate update. The macro files generated by the UPGRADE command in ADMIN ensure that the RESET filenames are correctly matched to the corresponding RESOLVE dbnames.
3-16
Reconfiguration
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 and RESETXREFS commands are needed to tidy up the references. Note: The UPGRADE command is used when a project is being upgraded from an earlier version of PDMS.
The following is an example of a sequence of commands: TO DB XX/A2 FROM DB XX/A1 XREF /XX1 RCFCOPY ALL RECONFIG : : TO DB XX/B2 FROM DB XX/B2 RCFCOPY ALL RECONFIG RESET 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 Write Input phase $R6 Checkddl is 11 To db STANA/SAPROP From files /REC1A /REC1B Xref /REC1X Reconfigure To db DEREKF/DFPROP From files /REC2A /REC2B Xref /REC2X Reconfigure To db ALANC/ACPROP From files /REC3A /REC3B Xref /REC3X Reconfigure To db TAMH/THPROP From files /REC4A /REC4B Xref /REC4X Reconfigure To db TAMH/PROP_ATEST From files /REC5A /REC5B
Reconfiguration
Xref /REC5X Reconfigure Reset with /REC1X Resolve db STANA/SAPROP Reset with /REC2X Resolve db DEREKF/DFPROP Reset with /REC3X Resolve db ALANC/ACPROP Reset with /REC4X Resolve db TAMH/THPROP Reset with /REC5X Resolve db TAMH/PROP_ATEST Finish Output macro Write Upgrading project CJB Write From PDMS10 to PDMS11 Write Output phase $R6 UPGRADE ON From db STANA/SAPROP To files /REC1A /REC1B Copy all Reconfigure From db DEREKF/DFPROP To files /REC2A /REC2B Copy all Reconfigure From db ALANC/ACPROP To files /REC3A /REC3B Copy all Reconfigure From db TAMH/THPROP To files /REC4A /REC4B Copy all Reconfigure From db TAMH/PROP_ATEST To files /REC5A /REC5B Copy all Reconfigure
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
3-18 VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1
Reconfiguration
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.
3-19
Reconfiguration
3.14.1
Standard Information Messages
The 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 integer integer integer integer
Elements were not defined in the DDL Elements have been lost Elements are no longer named Attributes were incorrectly defined Elements were not inserted
where integer 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: TYPE: OLDREF NEWREF:
Identifies the nature of a message arising from the creation or naming of an element. The codes used are detailed in the next section. The type of element, e.g. SITE, BRAN, SHEE etc. The reference number of the element in the source DB (starting with #). 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. 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).
NAME:
3-20
Reconfiguration
3.14.3
Codes Used to Identify Message Types
The coded prefix to each message comprises two parts. The first character is one of the following: 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 EN Element Created 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 Elements Not 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 Element Not 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 Element Attribute 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.
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 the language 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 FORMATTEDFILES command. 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/DESI TO FORM /F1 /F2 RCFCOPY ALL RECONFIG
On destination machine:
FROM FORM /F1 /F2 TO DB MASTER/DESI RECONFIG
3-22
Reconfiguration
3.18 Reconfiguring a Global Project

We recommend that you use the SAMEREF option 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 FULL
The SAMEREF Option
The SAMEREF option is always used for extracts. You need not to enter the SAMEREF option; 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.
3-23
Reconfiguration
3.19.4
Reconfiguring a Single Extract

1. Reconfigure from the DB to a file. 2. REVERT the extract to Session 1. 3. MERGE CHANGES to remove the intermediate session.
The procedure for reconfiguring a single leaf extract is as follows:
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 difference is: 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 number of sessions kept. Reconfiguring from databases to files must be done top-down. Reconfiguring back from files to databases must also 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:
3-24
Reconfiguration
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 be updated 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 Extract
Consider this three-level extract: MASTER EXT EXTBOT 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 been shown below.)
3-25
Reconfiguration
FROM DB CTBATEST/MASTER TO FILE /MASTERA /MASTERB RCFCOPY ALL RECONFIG SESSIONS FROM DB CTBATEST/EXT TO FILE /EXTA /EXTB RCFCOPY ALL RECONFIG SESSIONS FROM DB CTBATEST/EXTBOT TO FILE /EXTBOTA /EXTBOTB RCFCOPY ALL RECONFIG SESSIONS FROM FILE MASTERA /MASTERB TO DB CTBATEST/MASTER RECONFIG FROM FILE EXTA /EXTB TO DB CTBATEST/EXT RECONFIG FROM FILE EXTBOTA /EXTBOTB TO DB CTBATEST/EXTBOT RECONFIG It is not necessary for the reconfiguration back from file to be done within the same session of RECONFIGURER. For example, in a global project where MASTER, EXT and EXTBOT are primary at different locations, then the following sequence could be followed: 1. At location A (primary location for MASTER): FROM DB CTBATEST/MASTER TO FILE /MASTERA /MASTERB RCFCOPY ALL RECONFIG SESSIONS 2. At location B (primary location for EXT): FROM DB CTBATEST/EXT TO FILE /EXTA /EXTB RCFCOPY ALL RECONFIG SESSIONS 3. At location C (primary location for EXTBOT): FROM DB CTBATEST/EXTBOT TO FILE /EXTBOTA /EXTBOTB RCFCOPY ALL RECONFIG SESSIONS Steps 1 to 3, reconfiguring from databases to files, can be done in parallel.
3-26
Reconfiguration
4. At location A (primary location for MASTER): FROM FILE /MASTERA /MASTERB TO DB CTBATEST/MASTER RECONFIG The user must now propagate the whole database to locations (B) and (C). 5. At location B (primary location for EXT) FROM FILE /EXTA /EXTB TO DB CTBATEST/EXT RECONFIG The user must now propagate the whole database to locations (C) and (A). 6. At location C (primary location for EXTBOT) FROM FILE /EXTBOTA /EXTBOTB TO DB CTBATEST/EXTBOT RECONFIG 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.
3-27
Reconfiguration
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.
3-28
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, nonglobal) 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.
4-1
The System and Global Databases
/* WORLD
World
Status World
/*S STAT
Team World
/*T TMWL
User World
/*U USWL
MDB World
/*M MDBW
/*DS DBSTWL
DB Set World
/*RO ROWL
/*SC SCOW
Role World
Scope World
/*ST STWLD
Stamp World
/*ACR ACRW
ACR World
Module World
RFWL
FTWL
Font World
Teams
TEAM
USER
Users
MDBs
MDB
DB Sets
DBSET
ROLE
SCOPE
Roles
Scopes
STAMP
Stamps
ACRs
ACR
ACRST
ACR Groups
Modules
RUNF
FNTF
Font Files
DBLI
DB Lists
DB
USLI
User Lists
TMLI
Team Lists
Extract Lists
EXTLI
DBs
DB
DBSTL
DB List
DBL
PEROP
Perops
STLST Stamp List
ACR Lists
ACRL
Runfile information: you can only modify these elements using the MODULE and EDIT commands
DBs
DBs
Figure 4-1 The System Database
DB
The names of the top-level elements (for example, /*S,) are shown, followed by the element type and a short explanation.
4-2
The Project Status World (STAT)

Attributes Name /*S Lock false Owner /* Prjnumber Maxusers
Prjlck false
unset Project number 999999
Prjdesc unset Project description Infa unset Project name Infb unset Project message Charset 0 Locrf nulref in a non-global project Hccnt Extract list changes count
Not used, see Comms DB
16 character text Integer =< 999999 120 character text 120 character text 120 character text Multibyte character set Integer =< 999999
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 commands Attributes 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%/
4-3
The Font File Element (FNTF)

Attributes Name /name Lock false Owner /name Irno US Stno LINE Fnma unset Fnmb 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 false Owner /name
4-4
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 Description unset 120 character text Projid unset 3 character text Fcpyref Nulref Bcpyref Nulref n Extractno Extract owner /name Variant false Controlled false Hccnt Extract list changes count Integer =< 999999
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 Lock Owner Password Security Description Acrli /name false /*U /name General unset unset
120 character text List of ACRs and ACRGRPs
4-5
The Team List Element (TMLI)

Attributes Name /name Lock false /name Owner
The Extract List Element (EXTLI)

The MDB World (MDBW)

Attributes Name /*M Lock false Owner /*
The MDB Element (MDB)

Attributes Name /name Lock false Owner /*M CurdbsList of current DBs Description unset 120 character text
The DB Set World (DBSTWL)

Attributes Name /*DS Lock false Owner /*
The DB Set Element (DBSET)

Attributes Name /name Lock false Owner /*DS Description unset
120 character text
4-6
The Database Set List Element (DBSTL)

Attributes Name /name Lock false /name Owner DBSTF Reference to a DBSET
The Database List Element (DBL)

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

Attributes Name /*RO Lock false Owner LACR false Attributes Name /name Lock false Owner /*T Description unset
/* Sets Data Access Control on or off (Standard projects only)
The Role Element (ROLE)
120 character text
The Perop Element (PEROP)

Attributes Name /name Lock false Owner Affirm true Opcreate Opmodify Opdelete Opclaim Opissue Opdrop Eclass unset Aclass unset Condition Acrmessage
/name
ignore ignore ignore ignore ignore ignore Element Class Attribute Class unset unset
4-7
Note on setting the ECLASS attribute: The syntax is:

.-----------<-------------. / | *-----<----. | / | | >--- ECLASS ---*--- noun ---+--- HIERarchy --+ | | | `------------+----------------+--->
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 /*
The Scope Element (SCOPE)

Attributes Name /name Lock false Owner /*SC Description unset 120 character text Scosel unset Scope selection PML expression
The Stamp World (STWLD) (Not used in Global projects)

Attributes Name /*ST Lock false Owner /*
The Stamp Element (STAMP)

Attributes Name /name Lock false Owner /*ST Desc unset Func unset Purp unset Setdat unset
4-8
The Stamp List Element (STLST)

Attributes Name /name Lock false Owner /name Stlsf Nulref DB reference Stsess 0 Session number for DB
The ACR World (ACRW)

Attributes Name /*ACR Lock false Owner /*
The ACR Element (ACR)

Attributes Name /name Lock false Owner /*ACR Description unset 120 character text Roleref Nulref Role name Scoperef Nulref Scope name
The ACR Group Element (ACRST)

Attributes Name /name Lock false Owner /*ACR Description unset
120 character text
The ACR List Element (ACRL)

Attributes Name /name Lock false Owner /name Acrf list of references of ACRs in the ACR Group
4-9
4.2 Global Projects

When you use the MAKE GLOBAL command to make a standard project into a global project, the Standard System database is split into two new database files; the Global database and the (local) System database. A modified sysvir.dat virgin database is used to upgrade the System database file xxxsys, where xxx is the 3-character project code. The communications world element LCOMW is added. The glbvir.dat database template file is used to create the Global database file xxxglb. The existence of the xxxglb database file shows that the project is global. The following elements are added: The communications world element LCOMW The Global Locations world element GLOCW, which will own GRPLI elements which in turn own GRP elements The Global Team World element GTMWL The Global Stamp World element GSTWLD. If stamps exist in the System database, they are all copied to the Global Stamp World element and deleted from the System database.
The attributes of these elements and their members, and the changes to other ADMIN database elements which occur when a Project is made Global, are described in the following pages. The Global database contains information that is common to all Locations running a Global project. The Global database is readable at all locations but is it can only be written to at the Hub. Changes to the Global database are propagated to all the other Locations. This means that the Global database is the same at every Location, except during the short time changes are being propagated. Each local System Database contains project information that is specific to the Location. The local administrator can write to the local system Database. A local System database is similar to the System database in a non-global Project. The main difference is that some of the standard ADMIN elements will be redundant. The differences are described below. Session information is stored separately in the COMMs database; and the MISC database stores inter-db macros and messages. The Comms and Misc databases are local to each Location.
4-10
/* WORLD
World
Status World
/*S STAT
User World
/*U USWL
MDB World
/*M MDBW
/*DS DBSTWL
DB Set World
Role World (empty)
/*RO ROWL
/*SC SCOW
Scope World
/*ACR ACRW
ACR World
Team World (empty)
/*T TMWL
/*LC LCOMW
Comms World
Modules World
RUNF
RFWL
FTWL
Fonts World
USER
Users
MDBs
MDB
DB Sets
DBSET
SCOPE
Scopes
ACRs
ACR
ACR Sets
ACRST
LCTIML
Event Timer
LCOMC
Daemon config
LCOML
Modules
Font Families
FNTF
TMLI
Team Lists
Extract Lists
DB
EXTLI
DBs
DB
DBSTL
DB List
DBL
ACR Lists LCTIMD Timings
ACRL
Comms Links Li
Runfile information: you can only modify these elements using the MODULE and EDIT commands
Scheduled Updates
LCOMD
DBs
Figure 4-2
The Local System Database in a Global Project
The names of the top-level elements (for example, /*S,) are shown, followed by the element type (for example, STAT) and a short description, (for example, Status World)
The communications world element in the COMMs database contains the project lock and isolation flags. The project lock may be set or cleared using LOCK and UNLOCK; and the Isolation flag may be set true or false using ISOLATION syntax. Both lock and isolation may be set or queried remotely by the Hub or an administering location.
4.2.1 Structure of the Local System Database

Figure 4-2 shows the structure of the local System Database in a Global project. The Local System database contains the data for local Fonts, Modules, Users, MDBs, DB Sets, Scopes and ACRs: these elements correspond to those that existed in the System database of a Standard project. The communications data is held in a new LCOMW Location Communications world element. The Team World and Role Worlds still exist in the local System database, but they are empty. The Team data is stored in the Global Team World element GTMWL in the Global database, and the Role data is stored in the Global Role World. The TEAM and USER elements in the Standard System database cross-reference each other, that is each team element holds a list USLI of users belonging to the team and each user element holds a list TMLI of teams to which the user belongs. In the Global database, a Team does not maintain a USLI list of users belonging to it. Note: This means that a report of all Users at every Location in the Project can only be obtained by combining reports from each Location.
The TMLI list in the USER element in the Local System database will continue to provide a list of teams to which a user at a particular location belongs. In the same way that a TEAM element no longer maintains a list of users in that team, a DB element in a team does not maintain a list of MDBs to which the DB belongs. The MDB element, in the Local System database keeps a list of DBs belonging to it. The detailed changes to the elements and attributes are described below.
STAT Element
This element already exists in the Local System database, but certain attributes have been relocated to the Global System database. The attributes are the same as in a Standard Project with the addition of: Locrf text(120) Note: 120 character text: current Location Reference
When a location is created, the LOCRF attribute in its local system DB will be set to the reference of its LOC location element in the global system database.
The LCOMW Element

The Location Communications World element LCOMW is called /*LC. It contains elements that describe the communications between one Location and all the other Locations with which it can communicate. The LCOMW element owns a LCOMC element, LCOML elements and LCTIML elements.
4-12
The LCOMC Element

The LCOMC element contains general details about the configuration of the Admin daemon at the current location. There should be only one LCOMC element in the database. Attributes: Name /name Lock false Owner /*LC Logfn /filenam Log file name Logms false Loglv 0 Diagnostic level
LCOML Element
The LCOML element contains a list of LCOMD elements, each of which specifies details about the communications link between the current site and one other site, as described below. Attributes: Name /name Type LCOML Lock false Owner /*LC
LCOMD Element
The LCOMD element contains specific details about the communications link between the current site and one other site, and controls scheduled updates. There will be one LCOMD element for each location, which has a communications link with the current location. Attributes: Name Lock Owner Description Locrf Timer Times Timee Timei Timeo Execb /name false /name unset /name
120 character text Name of Location which has comms link with current Location frequency of update events 120 character text: (See below) 0 Time window start 2400 Time window end 30 Interval in seconds between communication attempts 10 Number of re-tries unset 120 character text: name of script to be run before updates are transferred (optional)
4-13
Execa unset 120 character text: name of script to be run after updates are transferred (optional) The Timer values are: Minutes past the hour Hours Days Months Days of the week For example: Timer '0,30 * * * *' specifies every half hour, every day. Timer '12 10,12,14,16,18 * * 1,5 ' specifies 12 minutes past the hours given, Monday to Friday. The attributes TIMES and TIMEE are not implemented at this release. Files such as Isodraft external plot files files are not propagated automatically by the global daemon. However, there is a mechanism in the daemon to allow such files to be transferred to and from neighbouring locations, during scheduled updates (or the UPDATE ALL command). The directory to receive transferred files is defined by the environment variable %IMPORT%. Each location to which files are to be transferred requires its own transfer directory - %EXP_ABC% for location ABC. Transfer of other data is described more fully in the Global Management User Guide. Offline locations: Note that transfer of such files to or from offline locations must be done manually. 0 - 59 0 - 23 1 - 31 1 - 12 0 (Sunday) - 6
LCTIML Element
The LCTIML element is present in a Global project only and has the following functions: It overrides the default transaction event timings. It contains a LEVENL attribute, which sets the time interval for the event loop for all locations, in seconds. It contains attributes that control the frequency of automatic merges on the transaction database. It contains a list of LCTIMD elements, each of which specifies details about the event timings between the current site and one other site, as described below. Levenl Lmerti Lmersu 3 Time interval for event loop (secs) 5 Frequency of Automerges. 120 character text: Time in days after which successful commands should be deleted. The value 1 means no deletion.
Attributes:
(settings as for Timer above)
4-14
Lmerfa 3 Lmerdl false
Time in days after which failed commands should be deleted. The value 1 means no deletion. If true, transaction database is merged and purged at specified times
At times specified by LMERTI, the transaction database will automatically be merged and commands deleted as specified by the LMERSU and LMERFA attributes. The LMERDL attribute must be set to true. For example, the automerge data could be set as follows: LMerti 59 23 * * 3,6 LMersu 10 Lmerfa 1 Lmerdl true In this example, the daemon would delete all successful commands older than 10 days and merge the transaction database. Failed commands would not be deleted. Note: If both LMERSU and LMERFA are set to 1, then the transaction database will not be merged.
LCTIMD Element
The LCTIMD element contains details about the event timings between the current site and one other site. There will be one LCTIMD element for each location that communicates with the current location. Attributes: Name Description Locrf Lendti Lmaxtr Ltimei 120 character text Reference to Location communicating with current Location 604800 Command timeout period, in seconds (default is 7 days in seconds) 100 Maximum number of retries to send command 120 Time interval between retries, in seconds unset /name
/name
4.2.2 Structure of the Global Database

The Global System database contains Teams, Databases, Roles, Locations and Stamps. Figure 4-3 shows the structure of the Global System database.
4-15
WORLD World
/*GS GSTAT Global Status World
/*GL GLOCWL Location World
/*GRO GROLW Global Role World
/*GT GTMWL Global Team World
/*GST GSTWLD Global Stamp World STAMP Stamps
ROLE Roles GRPLI Group List LOCLI Location List LNKLI Links List PEROP Perops LNK Links
TEAM Teams
DBLI DB List
STLST Stamp List
GRP Groups
LOC Locations
DB DBs
DBLOC
Figure 4-3
Structure of the Global System Database.
GSTAT Element (GSTAT)

Only one /*GS element can exist in the database and it is inherited from the STAT element in the Standard System Database. Attributes Name Lock false Owner Prjnumber Maxusers Prjdesc Charset Hccnt /*GS /* unset Project number: 999999 unset Project description -370086 Extract list changes count 17 character text 120 character text Integer =< 999999
GTMWL Element
The Global Team World element GTMWL is named /*GT. Only one /*GT element can exist in the database. It is the same as the TMWL element, except that:
4-16
It does not own a user list element USLI. The DB element does not own an MDB list element MDBL.
Attributes
The DB element owns a single DBLOC element DBLOC. Name /*GT Lock false Owner /*
TEAM Element
Attributes Name /name Lock false Owner /*GT Description unset
The Database List Element (DBLI)

Attributes Name /name Type DBLI Lock false Owner /name
DB Element
The DB element owns the list element DBLOC which holds four additional attributes (see DBLOC element, page 4-18). These attributes are attached to the DBLOC element to facilitate separate claiming of both this element and the owning DB element. This scheme reduces the contention between the PDMS ADMIN module and the Plant Design Global daemon. Attributes Name /name Type DB Lock false Owner /name Stype DESI File number Fino n Area 0 Area number Daccess Update Claimdb Explicit or Implicit if Daccess is Multiwrite Description unset Proj unset (except for Foreign DBs, where it is set to the project code) Fcpyref Nulref Bcpyref Nulref n Extractno Variant false Controlled false
4-17
DBLOC Element
Attributes Name /name
Lock false /name DB element Owner Locrf /name Name of Primary Location Prvrf Name of previous Primary Location (normally unset) Propg true Propagation flag Picfd false Picture file propagation flag DEALDB Ref Array Indicates locations where db is being de-allocated
Type DBLOC
The Global Role World (GROLW)

The Global Role World Element stores the ROLE elements in a Global project. Attributes Name /*GRO Lock false Owner /* LACR false Sets Data Access Control on or off
The Role Element (ROLE)

Attributes Name /name Lock false Owner /*T Description unset 120 character text
The Perop Element (PEROP)

Attributes Name /name Lock false Owner Opcreate Opmodify Opdelete Opclaim Opissue Opdrop Eclass unset Aclass unset Condition Acrmessage
/name
ignore ignore ignore ignore ignore ignore Element Class Attribute Class unset unset
4-18
GLOCWL Element
The Global Location World element GLOCWL specifies information about Locations, Groups and Communications (Links). It is named /*GL and only one /*GL element can exist in the database. The GLOCWL element consists of the three list elements GRPLI for groups, LOCLI for locations and LNKLI for links. It has the following attributes: Attributes Name /*GL Lock false Owner /* text Aduuid Hubrf /name Prvrf Nulref NxtHb Nulref text Newuid
Daemon version string (Project UUID) Hub Location Reference Previous Hub Reference (normally unset) Next Hub location (normally unset) gets new UUID value to use when setting ADUUID. To be used when a Global project is copied directly without the REPLICATE command (see page 7-137) having been used.
GRPLI Element
The GRPLI element contains a list of Group elements GRP. A Group is a fully connected local network of Locations which conceptually form a single node in the Plant Design Globaltree structure of Locations. Attributes Name /name Lock false Owner /*GL
GRP Element
The characteristics of each group are defined by a GRP element which has the following attributes: Attributes Name /name Lock false Owner /name Description unset Membership of a group is indicated by the attribute GRPRF in each location element LOC, as described below. The location elements LOC are themselves listed in the LOCLI element.
4-19
LOCLI Element
The LOCLI element contains a list of all Location elements LOC, including offline Locations and those which belong to Groups. Attributes Name /name Lock false Owner /*GL
LOC Element
The characteristics of each Location are defined by a LOC element which has a set of attributes and a secondary list element DBALL. The DBALL element is a complete list of all Databases allocated to the Location. It is implemented as a Dabacon secondary list of DB reference numbers which refer to DB elements under the DBLI list element of TEAM elements. Locations which belong to a Group have an attribute GRPRF holding the reference number of the Group. If this attribute is null then the Location does not belong to a group. LOC elements also possess a LOCRF attribute which points to the parent of the Location. This attribute is used to determine paths between Locations in the proposed tree structure for connecting Locations. In a future implementation, based on a more general graph structure, the LOCRF attribute might either be dropped or used for another purpose. A Location is only recognised as fully initialised when the logical attribute LINIT is true. Other attributes of a Location are described in the following table. The LOC element has the following attributes: Attributes Name /name Lock false Owner /name Description unset 120 character text Locid XXX 3-letter identifier Rhost rhost name host name Iconn 1 Connection type: 1 = on-line 0 = off-line Linit false Initialisation flag Grprf Nulref Group reference set if Location is added to a Group Locrf /name Parent Location PRMRF Primary location of system Database. If unset, (and PRVRF is unset) the Satellite will be administered locally PRVRF Nulref Old primary location (normally unset) DEALAL false Indicates that ALL DBs are currently being de-allocated from this location
4-20
CURLOC ADMLOC DBPRIMARY
True current Location (available everywhere) Currently administered location (available everywhere) (ref array) - List of Databases primary at the current location (ref array) - List of Locations primary at the current location
LOCPRIMARY Note:
When a Global Project is created an initial Location element is created with a NAME of /PROJECTHUB and a LOCID of HUB. Its LINIT flag is set to TRUE.
DBALL Element
Attributes Lock false Owner /name
LNKLI Element
The LNKLI element contains a list of link elements LNK which specify the connections between pairs of Locations. Not used at this release. Attributes Name /name Type LNKLI Lock false Owner /*GL
LNK Element
Not used at this release.
Attributes Name /name Descriptions unset 120 character text LNKRX LINKRY LINKWV
GSTWLD Element
Any existing stamps in the standard System database are copied to the Global Stamp World element and deleted from the System database. Attributes Name /*GST Lock false Owner /*
4-21
STAMP Element
Attributes Name /name Lock false Owner /*ST Desc unset Func unset Purp unset Setdat unset
STLST Element
Attributes Name /name Lock false Owner /name Stlsf Nulref DB reference Stsess 0 Session number for DB
4-22
5 The Transaction Database

This chapter is applicable to Global Projects only. The Global Daemon stores most of the commands that it is asked to perform in a transaction database. The System Administrator can use this database to get information about the progress of commands, and investigate why commands have failed. (Use GETWORK to see the latest changes to the transaction database) This chapter describes the structure of the transaction database, and explains the function of the elements within it, and their attributes. Note: To avoid data consistency errors, PDMS changes to the transaction database should not be made whilst the daemon is running. This includes deleting commands (TRINCOs) and merging the database. (Using REMOTE MERGE is OK.)
5.1 Structure of the Transaction Database

The hierarchical structure of the transaction database is shown in Figure 5-1. All the owner/child relations are one to many with the exception of TRMLST, TRFLST, and TRSLST. There is only one of each below an operation (TROPER) or output command (TROUCO) or an input command (TRINCO). There is no distinction between commands received from other locations (foreign) or from the local location as there are no fundamental differences between them. Whether they are local or foreign is determined by their position in the hierarchy and their owners names. The structure is a hierarchy leading to input commands received by the daemon, and the operations these have evaluated to.
5-1
The Transaction Database
%TRMSG
%TRYEAR
%TRMONT
%TRDAY
%TRUSER
%TRLOC
%TRINCO
%TROPER
%TROUCO
%TRSLST
%TRFLST
%TRMLST
%TRSUCC
%TRFAIL
%TRSUCC
%TRMESS
%TRFAIL
Figure 5-1
Structure of the Transaction Database.
5-2
5.2 TRMSGW element

The Transaction Message World element is called /*MS. There is only one such element and it contains elements that store the communication between the daemon, PDMS and other daemons. It owns any number of TRYEAR elements. Attributes NAME Text TRSETL /*MS Logical Controls whether Local claim commands are stored
5.3 TRYEAR, TRMONT and TRDAY elements

These are organisational elements to allow the commands stored in the transaction database to be grouped by the date on which they were received. Each of these elements only has a single attribute NAME that is of the form: Name of %TRYEAR year number. For example, /2001 Name of %TRMONT as for year, then slash and month. For example, /2001/MAY Name of %TRDAY as for TRMONT, followed by slash then date. For example, /2001/MAY/21
TRYEARs own TRMONTs, TRMONTs own TRDAYs and TRDAYs own TRUSERs.
5.4 TRUSER and TRLOC elements

These are further organisational elements under which commands are stored as issued by a specific user (TRUSER) and from a particular location (TRLOC). They each only have NAME attributes. A given transaction database will have a structure containing the TRDAY element for any date on which input commands were received. This will own a TRUSER element for each of the PDMS users that have issued daemon commands on that day. These will own a single TRLOC element with the name of the local location (e.g. CAM). There is only one TRLOC because the PDMS user only sends commands to the local daemon. The TRDAY may also own a TRUSER for the local and remote daemons (LOCALDAEMON and REMOTEDAEMON). These will own TROUCO commands received using RPC from other locations. These will own TRLOC elements for each location from which an input command has been received. LOCALDAEMON will own a TRLOC for the local location (e.g. CAM) since operations can send commands to the local site.
5-3
The final system TRUSER element is named /TIMEDUPDATES with a single TRLOC of the local site. This contains commands issued to process the regular timed updates. TRDAY TRUSER TRLOC TRINCO CLAIMetc CLAIMetc CLAIMetc CLAIMetc UPDATE ALLetc CLAIMetc CLAIMetc CLAIMetc etc /2002/MAR/25 /2002/MAR/25/LOCALDAEMON ../CAM /2002/MAR/25/REMOTEDAEMON ../OXF ../LON ../HOU /2002/MAR/25/TIMEDUPDATES ../CAM /2002/MAR/25/SYSTEM ../CAM /2002/MAR/25/FRED ../CAM /2002/MAR/25/ROSE ../CAM etc etc
5.5 TRINCO element (Input Command)

The TRINCO element stores the information about an input command issued to the daemon from a user, or another locations daemon. The information includes the state of processing of the command and is sufficient for the command to be restarted when a daemon is restarted, and is sufficient to generate the operations and output commands necessary to execute the command. Note that local commands added from PDMS, that is those with TRLOCL True, do not contain successes, failures or messages. Attributes NAME TRCNUM INCSTA COMUID text int int ref Not automatically generated Command number The state of processing of the TRINCO This is the reference of the command that sent this command to the daemon. For commands sent by this or other daemons it is the ref of the TROUCO element at the relevant location. For commands originating from PDMS it will be set to null. Module number through with the USER has issued this command, or GLOBALDAEMON module True if command stored directly by PDMS independent of the Daemon Command string USER entered that generate this command, else null Original Location where user issued the command
TRMODU TRLOCL COMSTR ORILOC[3]
int log text text
5-4
DESLOC3]
text
Ultimate target destination location where command will be executed. For some commands this is the destination of subsidiary commands to be sent, not this command itself. Previous Location which passed the command on to this location (normally the same as the TRLOC element) Auxiliary location. Often used as a location to send auxiliary commands Location of administrator when being remotely administered, else NULL number of other TRINCOs on which this is dependent (always zero) References of TRINCOs on which it is dependent, (always none) Type of dependencies - on success or failure Date command received and recreated Date sent acknowledgement for command Number of times acknowledgement sent Time to execute command (hence allows a delay) Date command made ready (after EXTIME has been reached) Date command completed Date reply sent with results of command Number of times reply sent text info set on completion (normally only if failed to generate operations) True if command succeeded, false if failed. The command fails if any of its operations fail, or if it fails to generate operations Date all processing of command finished acknowledgement of command received, or command cancelled. Number of times reply acknowledgement received user cancelling the command of Database DB element file number of DB element
PRVLOC[3]
text
AUXLOC[3] SYSLOC[3] DEPCOU DEPEND[*] DEPTYP[*] DATECR DATEAK NACKN EXTIME[4] DATERD DATECM DATERP NREPLY MSTEXT TRPASS
text text int ref log date date int text date date date int text log
DATEND
date
NREPAK USERST TRDBRF TRFINO
int text ref int
5-5
TREXTN TRAREA TRSTYP TRDBNO TRDACC INARCO INTARG[*] TRCARG[*] TRVISI DESC[256]
int int int int int int int text log text
extract number of DB element area number of DB element filetype of DB element dbnumber of DB element access type of DB element argument count for intargs (args of the command) (defaulted to zero.) Command arguments (passed around as a Conformant array) Command argument qualifiers space separated. E.g. NAME=X/Y Visible or not User description
Values of INCSTA state attribute and order of change RECEIVED ACKNOWLEDGED STALLED The command has been received ready for processing. DATECR is set. An acknowledgement has been sent off by this daemon. DATEAK is set and NACKN incremented. The command has failed to create its operations and state will later return to ACKNOWLEDGED ready for retry, or to TIMEDOUT. The command has reached its execute time and is independent. DATERD is set. The command has been processed, and results obtained. DATECM is set. The daemon has sent the results back to the originating location. DATERP is set and NREPLY incremented. An acknowledgement for the result received from originating location. DATEND is set and NREPAK incremented. The command will not be executed now due to dependency rules. DATEND is set. The command has been cancelled and finished with TRPASS false. DATEND is set. The command has timed out before creating its operations and finished with TRPASS false. DATEND is set.
READY COMPLETE REPLIED PROCESSED
REDUNDANT CANCELLED TIMEDOUT
5-6
5.6 TROUCO element (Output Command)

The TROUCO element contains information about an output command to be issued by the daemon to itself, or to the daemon at another location. The information includes the state of processing of the command and is sufficient for the command to be resent when a daemon is restarted. Output commands are generated by an input command when operations are created. They may be destined to be executed at this, or another site. Attributes NAME TRCNUM OUTSTA COMREF text int int ref Not automatically generated. Command number of command being sent. State of processing of the TROUCO. Ref of the TRINCO of this command stored in the receiving location transaction database. This is NULL until an acknowledgement is received. Original Location where user issued the command. Ultimate target destination location where command will be executed. For some commands this is the destination of subsidiary commands to be sent, not this command itself. Previous Location which passed the command on to this location (normally the same as the TRLOC element). Auxiliary location. Often used as a location to send auxiliary commands. Location of administrator when being remotely administered, else NULL. Next Target location this is needed to determine which port to assign the output command to, and which location to send the command. Number of other TROPERs and TROUCOs on which this is dependent. References of TROPERs and TROUCOs on which it is dependent. Type of dependencies - on success or failure. Reference of previous operation which generated this output command as one of its post operations. If no previous operation this is NULL. Date command created by owning input command.
ORILOC[3] DESLOC3]
text text
PRVLOC[3]
text
AUXLOC[3] SYSLOC[3] NXTARL[3]-
text text text
DEPCOU DEPEND[*] DEPTYP[*] PREOP
int ref log ref
DATECR
date
5-7
DATERD DATESN NRETRY MAXTRY WAITIM ENDTIM DATEAK NACKN DATERP DATERK NREPLY MSTEXT TRPASS POPCOD DATEND
date date int int int date date int date date int text log int date
Date command is ready to send after dependencies satisfied. Date command sent to destination location. Number of attempts when command was sent. Number of attempts sending command before command fails. Number of seconds delay between attempts at sending. Date when command will fail if sending remains stalled. Date acknowledgement received from destination location Number of times acknowledgement received. Date reply with results received from destination location. Date reply acknowledgement sent to destination location Number of times reply received. Text info set on completion (normally only if failed to generate operations). True if command succeeded, false if failed. This is determined from the result received. Code for post operation creation function to be run. If none then zero. Date all processing of command finished all post operations generated, or command cancelled, or command timed out. Number of times reply acknowledgement received. User cancelling the command. Reference for Database DB element. File number of DB element. Extract number of DB element. Area number of DB element. Filetype of DB element. Dbnumber of DB element. Access type of DB element Argument count for intargs (args of the command, defaulted to zero).
NREPAK USERST TRDBRF TRFINO TREXTN TRAREA TRSTYP TRDBNO TRDACC INARCO
int text ref int int int int int int int
5-8
INTARG[*] TRCARG[*] TRVISI DESC[256]
int text log text
Command arguments (passed around as a Conformant array) Command argument qualifiers space separated. E.g. NAME=X/Y Visible or not User description
Values of OUTSTA state attribute and order of change WAIT READY STALLED SENT The command is waiting until it is independent of any other operation/command. DATECR is set. The command is independent and ready to be sent. DATERD is set. The command could not be sent. State will later return to ACKNOWLEDGED ready for retry, or to TIMEDOUT. The command has been sent and waits for an acknowledgement. DATESN is set, NRETRY is incremented. An acknowledgement has been received from the destination location. DATEAK is set, NACKN is incremented, CMREF is set. A reply with results has been received from the destination location. DATERP is set, NREPLY is incremented. A reply acknowledgement has been returned to the executing location. DATERK, TRPASS, MSTEXT are set. NREPAK is incremented.
ACKNOWLEDGED
REPLIED COMPLETE
STALLED_POSTOP Post operations could not be created. State will later return to COMPLETE ready for retry, or to TIMEDOUT. PROCESSED REDUNDANT CANCELLED TIMEDOUT Any required post operations have been generated using the result of this command. DATEND is set. The command will not be executed now due to dependency rules. DATEND is set. The command has been cancelled by owning TRINCO by a user. DATEND is set. The command has had the number of sends exhausted, or maximum time exceeded. DATEND is set.
5-9
5.7 TROPER element (Operation)

The TROPER element stores the information about an operation to be executed by the daemon. The information includes the state of processing of the operation and is sufficient for the operation to execute when a daemon is restarted. Operations are generated by an input command when operations and output commands are created. Attributes NAME TRONUM OPSTAT DEPCOU DEPEND[*] DEPTYP[*] PREOP text int int int ref log ref Not automatically generated. Operation number of operation to execute. Note this is not a command number. State of processing of the TROPER: Number of other TROPERs and TROUCOs on which this is dependent. References of TROPERs and TROUCOs on which it is dependent. Type of dependencies - on success or failure. Reference of previous operation which generated this output command as one of its post operations. In none then NULL. Date operation created by owning input command. Date operation is ready to execute after dependencies satisfied. Date operation was started running (executing). Number of attempts to start operation running Maximum number of retries allowed before failure. Number of seconds delay between attempts at executing. Date when operation will fail if execution remains stalled. Date operation stalled during execution. Date execution completed. Text info set on completion. True if operation succeeded, false if failed. Code for post operation creation function to be run. If none then zero.
DATECR DATERD DATERN NRETRY MAXTRY WAITIM ENDTIM DATESL DATECM MSTEXT TRPASS POPCOD
date date date int int int date date date text log int
5-10
DATEND
date
Date all processing of operation finished, all post operations generated, or command cancelled, or command timed out. User cancelling the TROUCO may not be implemented. Visible or not. User description. The operation is waiting until it is independent of any other operation/command. DATECR is set. The operation is independent and ready to execute. DATERD is set. The operation could not be executed. State will later return to READY (ready for retry), or to TIMEDOUT. DATESL is set. The command has started running. DATERN is set, NRETRY is incremented. A reply acknowledgement has been returned to the executing location. DATECM, TRPASS, MSTEXT are set.
USERST TRVISI DESC[256] WAIT READY STALLED
text log text
Values of OPSTAT state attribute and order of change
RUNNING COMPLETE
STALLED_POSTOP Post operations could not be created. State will later return to COMPLETE ready for retry, or to TIMEDOUT. PROCESSED REDUNDANT CANCELLED TIMEDOUT Any required post operations have been generated using the result of this command. DATEND is set. The command will not be executed now due to dependency rules. DATEND is set. The command has been cancelled by owning TRINCO by a user. DATEND is set. The command has had the number of sends exhausted, or maximum time exceeded. DATEND is set.
5.8 TRMLST, TRSLST, and TRFLST elements

The TRMLST, TRSLST, and TRFLST elements are organisational elements (Message Lists, Success Lists and Failure Lists respectively): Messages (TRMESS) are grouped under Message Lists (TRMLST). Successes (TRSUCC) are grouped under Success Lists (TRSLST) and TRMLST. Failures (TRFAIL) are grouped under Failure Lists (TRFLST) and TRMLST.
5-11
Failures and Successes are propagated back to the originating location as messages as soon as they are generated and before the full result is handed back. These are finally stored under TRMLST as TRSUCC and TRFAIL elements. All the list elements have no user attributes.
5.9 TRMESS, TRSUCC, and TRFAIL elements

The TRMESS, TRSUCC, and TRFAIL elements are for Messages, Successes and Failures respectively. Operations and Output Commands are able to have any number of messages attached to them. They will be generated by Local operation during their execution and be stored. Remote operations will receive messages from their output commands that will: generate messages relating to transaction events (sends, acknowledgements etc.) receive messages from the execution of commands at other site, receive transaction event messages forwarded through other site remote operations.
Operations and output commands have a TRSUCC attribute stating a success or (relative) failure. Each point of failure will generate a single TRFAIL element (e.g. failure to claim an element). Each point of success will generate a single TRSUCC element (E.g. an element claimed). The attributes of TRSUCC and TRFAIL elements are equivalent. They include: A Reference to an element involved in the operation (e.g. the ref of a claimed element) A double integer code relating to a PDMS message or error (0,0 if not known or relevant) A text string which is a representation of the said message or error. An integer qualifier to be used for such things as session numbers etc.
The result of a command (TROUCO) is the sum of all TRSUCC and TRFAIL elements owned by its operations and output commands. All of these are communicated back to either the user (if it is a local command) or propagated to the originating site (if it is a foreign command). In the latter case the compounded errors will appear under the relevant originating TROUCO operation and hence onwards and upwards. Whether a TROPER itself is classed as a success is determined by its execute method. Input Commands are successes if all its operations AND output commands are successes. An output Command is a success if the input command it spawned returns a success. Results are only passed on to the generating TROUCO when the input command is totally finished. Messages are sent immediately they are generated before waiting for operation or command conclusion. They go the same route as the result, being compounded by a
5-12
TROUCO and transmitted to other site TROPER elements. They are only stored under the final TRINCO generated from a USER command. Attributes for elements %TRSUCC and %TRFAIL DATEMS MESNUM[2] date int[2] Date success/failure raised. Message/error number relating to MSTEXT or 0,0 if none available. This can be used as an indication of the severity of a failure. Any result text (not passed on). Data type indicates significance of MESQUA, MSREF, MSDTXT. Data qualifier. Data refno corresponding to the error. Data text of the result/error. Name of location that generated the success/failure Source command type number (if generated by a TRINCO). Source operation type number (if generated by a TROPER). Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes. Allows you to query the member operations of a command independently of whether the operations are TROUCO or TROPER. It combines the TRCNUM and TRONUM queries (these are attributes of TROUCO and TROPER respectively).
MSTEXT MSTYPE MESQUA MESREF MSDTXT MSLOC TRCNUM TRONUM TRTYPE
text int int ref text text int int text
5-13
Attributes for element %TRMESS DATEMS MESNUM[2] MSTEXT MSLOC MSSENT TRCNUM TRONUM TRTYPE Date int[2] Text text log int int text Date success/failure raised. Message/error number relating to MSTEXT or 0,0 if none available. Message text. Name of location that generated the success/failure. Unused. Source command type number (if generated by a TRINCO). Source operation type number (if generated by a TROPER). Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes.
5-14
6 Command Summary
This chapter lists the ADMIN commands in functional groups. Details of the commands are given in Chapter 7 in alphabetical order of command name.
6.1 Project Definition

ACCESS ACRADD ACRREM ADD CHANGE Changes the access rights of the specified user to PDMS modules. Adds a named ACR to the current ACR Group. Removes a named ACR from the current ACR Group. Places a named DB at a specified position in the current MDB list. Changes database access type, and the claim mode for multiwrite databases. (In a Global project, also changes primary location) Changes the description of the specified user, team, database or MDB. Changes the name of the specified user, team, DB or MDB. Copies a DB, MDB, Team, User, Module or Stamp. Creates a DB (including Extract DBs), MDB, Team, User or Module. Moves a DB to a specified position in the current MDB list. Adds a Database or DB Set to the current DB Set. Makes a DB non-current. Removes the specified element from the project. Removes a DB or DB Set from the current DB Set Replaces the current DB by a non-current DB. Removes a database which has been included from an external project. Includes databases from another project in the current MDB. Creates a DB Set, Role, Scope, Access Control Right (ACR) or ACR group. Adds descriptive information to project definitions.
CDESC CNAME COPY CREATE CURRENT DADD DEFER DELETE DREMOVE EXCHANGE EXCLUDE INCLUDE NEW PROJECT
6-1
Command Summary
REPLICATE REMOVE SET TADD TREMOVE
Saves the structure or contents of a project in a named file. Removes a DB from an MDB. Sets the current MDB, Team or DB Set. Adds Users to the current Team. Removes Users from the current Team.
6.2 Project Administration

BACKTRACK EXPUNGE EXTRACT LOCK MAXUSERS MERGE CHANGES MESSAGE MOVE NEW STAMP REVERT UNLOCK Backtrack a database to a previous session. Removes users from the Project and releases claimed elements in databases. Control of database extracts Locks the Project Database so that Users cannot enter. Maximum number of users for a project. Merges the changes made to a database over several sessions. Sends messages to other users. Moves a DB to a different area. Creates a new stamp. Backtrack a database to a previous session. Unlocks a locked database.
6.3 Global Project Administration

ADMINISTER ALLOCATE DEALLOCATE DUPLICATENAMES GENERATE HUBLOCATION INITIALISE ISOLATION MAKE GLOBAL NEW Creates or opens a system database to allow you to administer a remote location. Allocates databases to a Location. Removes databases from a Location. Checks for elements with duplicate names in the Project. Generates the files required for a new Location. Relocates Project Hub. Initialises communications link at a Location Isolates a Location so that no updates take place. Makes a Standard Project into a Global Project. Creates a DB Set, Role, Scope, Access Control Right (ACR) or ACR group.
6-2
Command Summary
PING PREVOWNER PURGE RECOVER REMOTE REMOTEMESSAGE RENEW REORDER SET SYNCHRONISE SYSTEMLOCATION TRANSFER UPDATE
Checks that communications link to named location exists. Restores the Hub to its previous Location. Restores a database to its previous Primary Location. Removes old Database files and Picture files from an offline Location. Recovers data when a databases has been corrupted. Allows the Hub or the Administering Location of a Satellite to carry out certain tasks. Sends messages to users at other Locations. Deletes a transaction database and creates a fresh version. Reorders a members list. Sets the current MDB, Team, or DB Set. Updates a database with changes from another Location. Changes the Administering Location of a Satellite. Generates a directory containing copies of all database files, ready for transfer to a Location. Updates current Location and an immediate neighbour.
6.4 Module Definition

EDIT MODULE Enables project module entries to be edited. Creates an entry for a module in the System DB.
6.5 Font Definition

FONTDIRECTORY FONTFAMILY Sets the font directory name. Defines a font family.
6.6 Querying
LIST QUERY STATUSSESSION SYSTAT Lists Project Information Queries information about ADMIN elements. Gives information about the current state of the Project. Gives information about users accessing the project.
6-3
Command Summary
6.7 General PDMS Commands

ALPHA FINISH GETWORK SAVEWORK TERM Sends command input and output to a file. Leaves PDMS, saving work. Refresh view of System database. Updates the Project Database. Equivalent to ALPHA FILE END.
6.8 Data Integrity Checking

Within PDMS: CHECK CHECKOPTION Stand-alone: CHECK ERRORFILE EXTERNAL MAXERRORS MAXWARNINGS MODE STATISTICS STOP Starts the integrity checking. Specifies the name of the file containing the error and warning messages when DICE is used in stand-alone mode. Checks that all external references point to DBs of appropriate types. Maximum number of errors found before data integrity checking is abandoned. Maximum number of warnings found before data integrity checking is abandoned Specifies what happens when DICE finds an error. Produces a summary of information about the database being checked. Exits from DICE in stand-alone mode. (Equivalent to FINISH) Starts the integrity checking. Control what is to be checked, and the amount of information output.
6.9 Reconfiguration
BRIEF DUMP ERRORS FILE Brief output to pass 2 reconfiguration. Writes a reference number index to the given file. Sets an upper limit on the number of errors that are acceptable during Pass 2 of a reconfiguration. Sets the output destination for reconfiguration messages (see Chapter 3).
6-4
Command Summary
FROM FULL LOAD RCFCOPY RCFUPDATE RCFUPGRADE RECONFIGURE REINIT RESETXREFS TO UPGRADE VB XREF
Specifies the source database for reconfiguration. Gives full output from pass 2 reconfiguration. Loads the reference number index from the given file. Defines the part of the database to be copied from the source DB to the destination DB. Updates reference pointers into reconfigured database. Consult AVEVA Solutions Support. Starts reconfiguration. Re-initialises the reference number index. Consult AVEVA Solutions Support. Specifies the destination database for a reconfiguration. Produces macros to upgrade a project to a new version of PDMS. Gives very brief output for pass 2 reconfiguration. Consult AVEVA Solutions Support.
6-5
Command Summary
6-6
7 Command Details
The commands are described in this chapter in alphabetical order of command names. The descriptions are usually under subheadings of Function, Description, Examples, Command Syntax, and Related Commands. The syntax of commands is shown by syntax graphs. These are discussed in the first two sections. The third section contains the command descriptions.
7.1 Conventions Used in the Syntax Graphs

The syntax graph conventions are as follows: Commands are shown in a combination of uppercase and lowercase letters, where the capital letters indicate the minimum abbreviation. (Note: This convention does not mean that the second part of the command must be typed in lowercase letters; commands may be entered in any combination of uppercase and lowercase letters.) For example, the command CReate can be input in any of the following forms: CR CRE CREA CREAT CREATE Commands shown in all uppercase letters cannot be abbreviated. Command arguments are shown in lowercase letters. These are just descriptions of what you need to enter. For example: FONTDirectory name means that to set the name of the Font Directory to newfonts, you enter: FONTD newfonts Syntax graphs are read from top left to bottom right. The start point is shown by >, and you can follow any path through the graph until the exit point, shown by >, is reached. Points marked with a plus sign (+) are option junctions which allow you to input any one of the commands to the right of the junction. For example:
7-1
Command Details
>----+--- ABC -----. | | |--- PQR -----| | | -------------+--->
means you can type in ABC or PQR or just press Enter to get the default option. Text in angle brackets <. . . > is the name of another syntax graph. This convention is used for syntax which occurs in many places. The graphs referred to are described at the end of this section. For example:
>----+--- ABC -----. | | |--- PQR -----| | | |--- <dia> ---| | | -------------+--->
means you can type in ABC or PQR or any command allowed by the syntax given in diagram <dia> or just press Enter to get the default option. Points marked with an asterisk (*) are loop back junctions. Command options following these may be repeated as required. For example:
.-----<-------. / | >---*--- option1 ---| | | |--- option2 ---| | | --- option3 ---+--->
means that you can enter any combination of option1 and/or option2 and/or option3, where the options can be commands, other syntax diagrams, or command arguments. The simplified format:
.----<------. / | >---*--- name ----+--->
means that you may type in a list of PDMS names, separated by at least one space.
7-2
Command Details
7.2 Notes on Syntax Graphs

<loc>
When a Location needs to be specified, it is shown as <loc> in the syntax graphs. It can be: A three-letter Word. For example: CAM, the LOCID of a LOC element, where the LOCID is 3 capital letters. A text string of three alphanumeric characters, beginning with a letter. For example: 'CAM, A99' or abc, the LOCID of a LOC element. A PDMS general identifier <gid> which points to a LOC element. For example: /LOCATION_AAA
<when>
>--+-- BEFORE --. | | `-- AFTER ---+------ <date> --------. | | |------ SESS n --------| | | -- STAMP stampname ---+--->
<date>
>--- time --- day --- month --- year
time is in the format hh:mm where hhx is the hour and mm the minutes. If not given then the default of 23:59 is taken. There must not be any spaces around the colon. day will be an integer. If not specified, the current day is taken. The day must be given if no time was specified.
current month is assumed. If used, the slash must be surrounded by spaces. Examples: 12:00 21 January 2002 9:30 11 / 1 / 02 10:30 21 / 1 / 2002 21 January
month can be entered as a word, or as a number separated by a slash. If not given the year will default to the current year. It may be entered as two or four figures.
7-3
Command Details
7.3 Detailed Descriptions of Commands

The detailed descriptions appear on the following pages in alphabetical order of command name. Each description starts on a new page. The command name and relevant functional group are at the top of the first page of the description, and the command name is repeated on each continuation page. When a command is associated with the Global Project Administration functional group, the command is specific to Global projects. Commands associated with other functional groups may be used for Standard and Global projects, and any particular aspect of a command that concerns Global projects is highlighted by the appearance of 'Global' in
larger typeface.
7-4
Command Details
ACCESS
Function: Examples:
(Project definition)
Changes the access rights of the specified user to PDMS modules.
ACCESS ADMINUSER FREE DRAFTUSER GEN Give user ADMINUSER FREE access, user DRAFTUSER GENERAL access Command Syntax:
.-------------<-------------. / | >--- ACcess --*-- userid ---*--- FRee ------| | | `--- GEneral ---+--->
Related Commands: CREATE
7-5
Command Details
ACRADD
Function: Description:
Adds an ACR to an ACR Group. The ACR and the ACR Group must already exist, and the ACR Group must be the current element. You can then give a list of ACR names to be added to the Group. Note that ACR Groups cannot contain other ACR Groups.
Examples: ACRADD /ACR1 /ACR22 /ACR24 Adds the ACRs /ACR1, /ACR22 and /ACR24 to the current ACR Group. Command Syntax:
.----<-------. / | >-- ACRADD --*--- acrname ---' | `--------------------->
7-6
Command Details
ACRREM
Function: Description: Examples:
Removes an ACR from an ACR Group. The ACR Group must be the current element. You can then give a list of ACR names to be removed from the Group.
ACRREM /ACR1 /ACR22 /ACR24 Removes the ACRs /ACR1, /ACR22 and /ACR24 from the current ACR Group. Command Syntax:
.----<-------. / | >-- ACRREM --*--- acrname ---' | `--------------------->
7-7
Command Details
ADD
Function:
Places a named DB at a specified position in the current MDB list. The list position must be in the range 1 through 300. If no list position is specified, the specified DB is added as a deferred database (equivalent to DEFER).
Description:
Examples: ADD STEELN/STEELN 1 Place DB STEELN/STEELN at the head of the current MDB list Command Syntax:
.-------------<--------------. / | >-- ADD ---*--- dbname ---+--- integer ---| | | ---------------+--->
Related Commands: REMOVE, DEFER, CURRENT, EXCHANGE
7-8
Command Details
ADMINISTER
(Global Project Administration - Remote Administration)

Creates or opens a system database to allow you to administer a remote location. Before you can use this command: The Location must have been created using the NEW LOC command, and its Location identifier must have been set. For example: Locid 'AAA' The system database of the new Location must be made Primary at the administering Location using the SYSTEMLOCATION command. For example: SYSTEMLOC /AAA PRIMARY AT /BBB where /AAA is the identifier of the new Location, and /BBB is the identifier of the Administering Location, that is, the location where the System database for the Location will be Primary. The NEWSYSTEM option is only available at the Hub. It creates a system database for a new location in the transfer area. (This is similar to the GENERATE LOCATION command.) The system database created is a copy of the Hub system database without MDBs and with only a SYSTEM user. The Administrator at the Hub can then create Users and MDBs (as well as Teams and Databases) for the Location before it is set up. The SYSTEM option is available at the Administering Location, that is, the location where the System database for the Location is Primary. This may be the Hub or another Satellite. This command will close the local system database and open the appropriate satellite system database. The database will be opened with Write access unless the READONLY keyword is used.
7-9
Command Details
ADMINISTER (continued)
After the SYSTEM or NEWSYSTEM commands have been given, you will be able to carry out administration tasks for the remote location. To return to administering your own (current) Location, give the command ADMINISTER LOCAL. To return to administering the last system database which was open, give the command ADMINISTER SAME. Any location may issue an ADMINISTER command for another other locations system database. If the system database is not Primary, then the system database will be opened READONLY. Once you have selected a remote system database, you can give most ADMIN commands, which will operate on the remote Location. In particular, the following commands can be used for housekeeping tasks on the remote System Database: EXPUNGE SYSTEM MERGE CHANGES SYSTEM CHECK SYSTEM RECONFIGURE SYSTEM The Hub will not be allowed to REPLICATE the project when it is administering a remote location, since the wrong system database will be replicated. However REPLICATE SYSTEM commands (which generate macros to replicate the project structure) will still be valid. The administered location will still be able to lock or isolate the project locally. It will also be able to administer its primary constructor databases by using the REMOTE <loc> command, where <loc> is its own location identifier, followed by one of the normal commands: EXPUNGE BACKTRACK MERGE CHANGES REVERT CHECK Reconfiguration will also be possible provided that suitable databases are primary at the location.
7-10
Command Details
ADMINISTER (continued)
Examples: ADMINISTER NEWSYSTEM /Cambridge ADMINISTER NEWSYSTEM 'CAM' Allows the Hub Administrator to create data (Users, MDBs etc) for a Location in the transfer directory. ADMINISTER SYSTEM /Cambridge ADMINISTER SYSTEM 'CAM' Allows any System Administrator to read the System Database for Cambridge. Only the Administrator at the Location where the Cambridge System Database is Primary will have write access to it. ADMINISTER SYSTEM SAME Allows a System Administrator who is administering other Locations to open the last System database opened. ADMINISTER SYSTEM LOCAL Allows a System Administrator who is administering other Locations to open the local System database. ADMINISTER SYSTEM AT /Cambridge ADMINISTER SYSTEM LOCAL READONLY This is equivalent to entering the ADMIN module as ADMIN READONLY.
Command Syntax:
>-- ADMINISTER --+--- NEWSYSTEM <loc> -----------------------------. | | `--- SYSTEM ------+-- AT <loc> ---. | | | | |--- SAME -------| | | | | `--- LOCAL ------+--- READONLY --| | | `---------------+--->
Querying:
>--- Q CURLOC ---> >--- Q ADMLOC --->
Returns the true current location Returns the currently administered location
7-11
Command Details
ALLOCATE
(Global Project Administration - Hub only)

Allocates databases and copies them to a Location. Each Location has a list of databases that are allocated to it. The ALLOCATE command adds a database to this list. A named database or all databases can be specified. The allocation can be deferred until a given time. The databases must already exist at the Hub. The Hub sends its own copy of the database, or that of the Locations parent, to the Location. This is not necessarily the most up-to-date copy. Note that the Database will also be allocated to all ancestors of the Location, if it is not already allocated to them. When a DRAFT Database is allocated, the picture files are not automatically copied with it. They will arrive with the next update. By default, the allocated databases will be Secondary, but you can specify that they will be Primary. If a database already exists at a location, you can change its Primary/Secondary status using the CHANGE command. Several Databases can be allocated in the same operation using the ALLOCATE command. In order for an extract database to be used at a satellite, all owning extracts must also have been allocated there. Offline Locations The ALLOCATE PRIMARY option cannot be used. Use ALLOCATE followed by CHANGE PRIMARY. The date option is not allowed. Note that ALLOCATE should be followed by a TRANSFER command to copy the database to the location. The CHANGE PRIMARY command should not be issued until this has been done. Using macros to Allocate Databases You will probably use a macro for long lists of databases allocations, for example, when a project is first set up. The allocation process may take some time if there is a slow link between Hub and Satellite and/or if databases sizes are large. Note that if a de-allocation is in progress, then the allocation will stall until the de-allocation is complete before commencing.
7-12
Command Details
ALLOCATE (continued)
Make sure that you do not try to allocate a database to the same location twice. If the allocation appears to have failed, check the transaction databases at both the Hub and the Satellite before attempting to repeat the command. To check that the allocation has been successful, GETWORK and then navigate to the LOC element. Navigate to its DBALL (allocation list) member, and query its members. Wait until the DBALL element at both the Hub and the Satellite lists all the allocated databases before continuing. Note: If the transaction database for a location is being allocated, this command is not recorded in the transaction database. It is not normally necessary to allocate it or change its primary location explicitly. Note: The OVERRIDE PROPG option cannot be used with a deferred time. Examples: ALLOCATE PIPE/PIPE PRIMARY AT CAM Copies database PIPE/PIPE from the current Location to Location CAM, making it Primary ALLOCATE ALL AT LON AT 23:30 Copies all databases which exist at the current Location but do not exist at Location LON, from the current Location to Location LON, at 2330 hrs. The Primary/Secondary status will not be changed. ALLOCATE ALL AT OXF OVERRIDE PROPG Copies all databases, including non-propagating databases, which exist at the current Location but do not exist at Location OXF, from the current Location to Location OXF. The Primary/Secondary status will not be changed. Transaction databases will not actually be copied, but empty database files will be created at secondary locations. This command is useful when changing the Hub location, since it ensures that the DB allocation lists of the old and new Hub locations match.
7-13
Command Details
ALLOCATE (continued)
Command Syntax:
>-ALLOCate -+- teamid -. | | |----------+- dbname -+-------------. | | | | |- PRIMary ---| | | | | `- SECOndary -+-AT loc-+-AT <time>----. | | | | `--------------+-> | `- ALL ----------------------------AT loc-+-AT <time>-------. | | `-OVERride PROPG -+->
Related Commands: Querying:
DEALLOCATE, CHANGE dbname PRIMARY, HUBLOC, TRANSFER >--- Q DBALL ---> At a location, shows the list of allocated DBs >--- Q DBLC ---> At a DB, shows the list of locations that have the DBs allocated
7-14
Command Details
ALPHA
Function: Examples:
(General PDMS Command)

Sends the information output in the Command Input and Output window to a file.
ALPHA LOG /LOG OVERWRITE Sends all information displayed in the Command Input and Output window to a file named log. ALPHA FILE /LOG Sends reports to a file named log, for example, a DICE report. ALPHA LOG END Ends recording. Command Syntax:
>-- ALPha ---*--- LOG ---+--- filename ---+--- OVERwrite -------------------| | | | | | | |--- APPend ----------------------| | | | | | | `-----------------+-- COMMands ---| | | | | | | |-- REQuests ---| | | | | | | `---------------| | | | | `--- END ------------------------------------------| | | `--- FILE ---+--- filename ---+--- OVERwrite ------------------| | | | | |--- APPend ---------------------| | | | | `--------------------------------| | | `--- END -----------------------------------------+-->
Related Commands: TERM
7-15
Command Details
BACKTRACK
(Project Administration)
Allows you to backtrack a database to a previous session. Sessions are defined as the work done between SAVEWORK commands. You can backtrack to the date or session number required, or, if the required session has been stamped, you can backtrack to the stamp. The current state of the database will be lost.
In a Global Project, this command can only be used when the

databases are Primary at your administering Location.
In a Global project, use the REMOTE <loc> BACKTRACK
command to backtrack a constructor database that is Primary at a remote Location, where <loc> is the Location identifier. See the REMOTE command for examples.
If you try to backtrack over any stamped sessions to a previous session, you will receive an error message. Backtracking over stamped sessions is not allowed. You must remove the stamp from the intervening sessions before you backtrack. BACKTRACK removes the sessions permanently. The related command REVERT adds a session containing the data for the specified old session. The backtracked database is written to a new file. This is done to avoid the situation where secondary database files in a Global project could still contain removed sessions. This situation would cause propagation failures if further sessions were added to the backtracked file. Note: Examples: BACKTRACK HANGERS/PADD TO SESSION 4 Backtracks the HANGERS/PADD database to Session 4. The team id (HANGERS) and TO can be omitted. BACKTRACK HANGERS/PADD TO STAMP /stamp_007 Backtracks the HANGERS/PADD database to the session that has the stamp stamp_007. The team id (HANGERS) and TO can be omitted. BACKTRACK /HVAC 10:30 31 / 8 / 96 BACKTRACK /HVAC 10:30 31 AUGUST 1999 Backtracks the HVAC database to10.30 am on the 31 August 1999. If the time is omitted, 11.59 p.m. is assumed. If the month is not given, For extracts, the REVERT command is used instead of BACKTRACK.
7-16
Command Details
the current month is assumed. If the year is not given, the current year is assumed. This example assumes that the team name has been specified using the SET command.
7-17
Command Details
BACKTRACK (continued)
BACKTRACK PIPE/PIPE-A AT OXF TO SESSION 4 In a Global project, backtracks the PIPE/PIPE-A database at Location OXF to Session 4. The team id (PIPE) and TO can be omitted. (The database PIPE/PIPE-A must be Primary at the Location OXF,) and the System Database for OXF must be Primary at the current Location. See the ADMINISTER SYSTEM command. Command Syntax: >- BACKTrack -+- teamid -. | | ----------+- dbname TO <when> --->
Querying:
Q SESSION
Related Commands: REVERT, MERGE CHANGES, REMOTE BACKTRACK, REMOTE REVERT - Global only
7-18
Command Details
BRIEF
Function: Examples:
(Reconfiguration)
Gives brief output from pass 2 reconfiguration. This is the default. A short example of brief output is shown below. Compare with very brief output from the VB command. *** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC LIBY #92/842 =16/2404
(24,90) Warning! library number 242 already exists in the project. Duplicate libraries should not be used in the same MDB EC DEPT #16/805 =16/2408 Phase one complete - starting phase two #EAE SHEE #88/842 =16/2417 /DR1/S5 IDLN: The head of the current element does not contain the attribute given #EAE SHEE #69/808 =18/2408 /DR1/S4 IDLN: The head of the current element does not contain the attribute given #EAE SHEE #53/819 =22/2402 /DR1/S3 IDLN: The head of the current element does not contain the attribute given ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 3 Attributes were incorrectly defined 0 Elements were not inserted. Command Syntax:
>--- Brief --->
Related Commands: FULL, VB, ERRORS
7-19
Command Details
CANCELCOMMAND
(Global Project Administration)
Allows a daemon command being executed at the current location to be cancelled. The command to be cancelled must be in the ACKNOWLEDGED, READY, RECEIVED or STALLED state. See Section 5.5, TRINCO element (Input Command) for information about the different states. A READY command cannot be cancelled if it has running operations.
Examples: CANCELCommand TRINCO1 OF /2002/APR/23/USERA/LON Command Syntax:

>--- CANCELCommand <gid> --->
where <gid> is a TRINCO in the transaction database for the Location. Related Commands: REMOTE CANCEL
7-20
Command Details
CDESC
Changes the description of the specified User, Team, Database or MDB. The CDESC command is used to set a description for elements created without one, or to overwrite an existing description. Note: This command can only be used with Users, Teams, Databases and MDBs. For all Admin elements, the description can be set or changed by navigating to the element and setting the Description attribute directly.
Examples: CDESC USER TEST/TEST This is a test user CDESC TEAM TEST This is the test team CDESC DB TEST/DESI The test design database CDESC MDB TEST This is the test MDB Command Syntax:
>--- CDesc ---+--| |--| |--| --USer username/password text ---. | TEam name text ----------------| | MDB name text -----------------| | DB dbname text ----------------+-->
Related Commands: CNAME, CHANGE
7-21
Command Details
CHANGE
Function:
Changes database access type (UPDATE or MULTIWRITE), and the claim mode for multiwrite databases. It also changes the file number and control mode, and brings foreign DBs up to date.
In a Global Project, this command can only be given at the Hub.

It can also be used to change the Primary Location of a database. Description: By default, databases are created with UPDATE access type, which means that they can be opened with one writer and n readers. DESIGN, DRAFT (PADD), CATALOGUE and ISODRAFT databases can be multiwrite databases, which allows more than one user to write to the same database. Multiwrite databases can have their claim mode set to IMPLICIT, in which case any element which is modified will be claimed automatically. Alternatively, the claim mode can be set to EXPLICIT, in which case users must claim elements before they can modify them, using the CLAIM command in the constructor modules. For more information, see the Reference Manual for the module. The CHANGE command can be used to change the access mode from UPDATE to MULTIWRITE, and from MULTIWRITE, to UPDATE. It can also be used to change the claim mode of Multiwrite databases from IMPLICIT to EXPLICIT, and from EXPLICIT to IMPLICIT. Notes: You cannot set the controlled attribute, which means that access is controlled by an external system, using this command. If the database has an extract database created from it, the access mode must stay as Multiwrite. If the access mode of a database used as a foreign database is changed, you should use the CHANGE FOREIGN command in the project which has included the foreign database to update the project. Both UPDATE and MULTIWRITE databases can also have their CONTROLLED attribute set.
7-22
Command Details
CHANGE (continued)
In a Global Project, the CHANGE command can be used at the
Hub to change the primary location of a database. The CHANGE PRIMARY command cannot complete while there are users in PDMS with write access to the database. The command will eventually complete once all such users have left PDMS. You may need to use EXPUNGE to remove phantom users. After the CHANGE PRIMARY command has been issued, users in PDMS with write access to the database can continue to modify the database, even if GETWORK is used. Once they have made a module switch, the database will become read-only. If a CHANGE PRIMARY command fails, the previous primary location will normally be recovered automatically. If the recovery fails (for example, the daemon is not running), you can recover the previous Primary location using the command: PREVOWN dbname Use of the PREVOWN command should be avoided if possible. Offline locations Before issuing a CHANGE PRIMARY command to or from an offline location, all users should have left PDMS at the old primary location. The TRANSFER command should first be used to bring the database at the new primary location up-to-date. Any modifications to the database at the old primary location subsequent to this TRANSFER will be lost. Only after this TRANSFER is it safe to issue the CHANGE PRIMARY command. Examples: CHANGE TEST/TESTDESI ACCESS MULTIWRITE Change access rights to named database to multiwrite. CHANGE TEST/TESTDESI CLAIM IMPLICIT Change claim mode for named DB to IMPLICIT. This option can only be used for a MULTIWRITE database. CHANGE TEST/TESTDESI ACCESS UPDATE Change access rights to named DB to single write. CHANGE TEST/TESTDESI CLAIM OFF Change claim mode for named DB to OFF. This option can only be used for a CONTROLLED database. CHANGE TEST/TESTDESI CONTROL OFF Change control setting for named DB to OFF. This option can only be used for a CONTROLLED database.
Command Details
CHANGE (continued)
CHANGE TEST/TESTDESI FINO 500 Change the Filenumber (FINO attribute) of the given database to the given number. By default, the Filenumber will be set to 0, and the filename of the database file will be derived from the database number. Using the default is recommended, particularly if you are using extracts. If you set the filenumber explicitly, the extract filename will still be derived from the Database number (NUMDB attribute), and so the consistency of filenames within an Extract family will be lost. CHANGE TEST/TESTDESI FINO 0 Change the Filenumber (FINO attribute) of the given database to 0. This command can be used to update database files to the new file numbering convention introduced at PDMS 11.3, which will keep Extract filenames consistent within an Extract family. CHANGE FOREIGN PIPE/PIPECATA RESET If PIPE/PIPECATA is a local database in project AAA, and a foreign database in project BBB, and the access is changed (in AAA), you should give this command in project BBB to update the project. Notes on the following Change...Primary Commands The new Primary Location will receive all outstanding updates of the database from the current Primary Location. Offline Locations: Note that the Primary Location of a Database cannot be changed directly between an off-line satellite and an online satellite. The Primary Location of the database must first be changed to the Hub. The <date> option is not allowed for off-line Locations.
The following command can only be used at the Hub of a Global project:
CHANGE TEST/TESTDESI PRIMARY AT CAM Change the primary location of the named DB to be CAM. The database will automatically become secondary at the current Primary location.
The following option is only available at the Hub of a Global Project:

CHANGE HVAC/HVAC PRIMARY AT CAM AT 2330 Change the Primary Location of the named DB to the Location CAM at the specified time.
7-24
Command Details
CHANGE (continued)
Command Syntax: >- CHange -+- dbname -+--- ACCess ---+--- MULTIWrite ----. | | | | | | |--- CONTRolled ----| | | | | | | --- UPDAte --------| | | | | |--- CLAIM ----+--- IMPLicit ------| | | | | | | |--- EXPLicit ------| | | | | | | --- OFF -----------| | | | | |--- FINO -----+--- n -------------| | | | | | | --- 0 -------------| | | | | --- CONTROL --+--- ON ------------| | | | | --- OFF -----------| | | `- FOREIGN dbname RESET ----------------------+--->
Note:
The CLAIM OFF option is only applicable to Controlled databases. The CLAIM IMPLICIT and CLAIM EXPLICIT options are only applicable to Multiwrite and Controlled databases.
The following option is only available at the Hub of a Global Project:

>--- CHange dbname --- PRIMary AT <loc> ---+-- AT <date> --. | | `---------------+--->
Querying:
>--- Query DB dbname ---> >--- Q PRMLOC ---> At a DB, shows the primary location.
Related Commands: PREVOWNER, TRANSFER (Global only)
7-25
Command Details
CHECK
(Data Integrity Checking)

Starts the integrity checking of the databases specified. Using the CHECK command from within a PDMS project, you can check: The System, Miscellaneous and Comms databases One or more named databases All the databases in a project
For information about using DICE (the PDMS Data Integrity Checker) as a stand-alone program, see Chapter 2, Stand-Alone DICE. be DICE checked. This enables you to check a number of locations to find, for example, a valid version of a database which has been corrupted at its primary location. To check a database at a remote location, prefix the CHECK command with REMOTE <loc> command, where <loc> is the Location identifier. See the REMOTE command for examples. Note: Remote checking uses stand-alone DICE. Examples: CHECK DBS MASTER/DESI MASTER/CATA Checks the integrity of a single named DB or a series of DBs within the project. Up to ten DBs may be specified in each command. CHECK SYSTEMDB Checks the integrity of the projects System DB. In a Global Project, the current administered System DB is checked. CHECK COMMDB Checks the integrity of the projects Comms DB. CHECK MISCDB Checks the integrity of the projects Misc DB. CHECK GLOBALDB Checks the integrity of the projects Global DB.
In a Global Project, both Primary and Secondary databases can
7-26
Command Details
CHECK (continued)
CHECK PROJECT Checks the integrity of all DBs in a project, including the System DB, Comms DB and Misc DB (but not the virgin DBs). The DBs are checked automatically by DICE in the following order: The System DB The Comms DB The Misc DB The user-accessible DBs, which are checked team by team
CHECK FILES /TRA000/TRA003 /TRA000/TRA001 Checks the integrity of one or more DBs by specifying the names of the files in which the DBs are held. Up to ten files may be specified in each command. This version of the command is usually used in stand-alone mode. (A list of DBs in a project, together with the names of the corresponding files in which they are stored, can be produced by using the LIST FILES command.) Note: If DICE is being used within PDMS and the CHECK FILES option is used, then no external reference checking can be done for that file and EXTERNAL NOCHECK will be assumed.
Command Syntax: From a PDMS module:

.------<----. / | DBs --*-- dbname ---+-----------------------------------. | SYStemdb -----------------------------------------------| | GLOBaldb -----------------------------------------------| | COMMdb -------------------------------------------------| | MISCdb -------------------------------------------------| | PROject ------------------------------------------------+-->
>- CHEck -+| || || || || `-
7-27
Command Details
CHECK (continued)
Note: All the CHECK syntax except CHECK GLOBALDB can be applied to a remote Location in a Global Project by prefixing the command by REMOTE <loc>, where <loc> is the Location identifier. See the REMOTE command for examples.
In stand-alone mode:
.-------<------. / | >--- CHEck --- FIles --*--- filename ---+--->
Related Commands:
CHECKOPTION
7-28
Command Details
CHECKOPTION
Sets the options for database integrity checking. The CHECKOPTION command is used to control the level of detail output by a CHECK command. You can specify whether or not you want to check references to other (external) databases. You can also check consistency of claimlists, and, if there are errors, instruct PDMS to correct them where possible. Use the CHECKOPTION command to set up the output you require, and then use the CHECK command to perform the check. Note: This command is only available within a PDMS project. The corresponding top-level commands MODE, STATISTICS, MAXERRORS and MAXWARNINGS are available when running stand-alone DICE or REMOTE CHECK.
Controlling the Amount of Information Output There are two types of DB fault detected by DICE: An error is identified if the DB is corrupted internally. A warning is identified if DICE encounters, for example, a fault with a reference to an external DB.
In BRIEF mode, checking is stopped when the first error is encountered; that is, DICE simply determines whether or not the DB is corrupt. This is the default mode. In FULL mode, DICE continues checking the whole DB or file, listing all errors and warnings, until a prescribed maximum error or warning count is exceeded, when 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 a database has been truncated. The default setting for the maximum error count and maximum warning count is 50, but you can specify different numbers by using the MAXERRORS and MAXWARNINGS options. STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc. STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default setting.
7-29
Command Details
CHECKOPTION (continued)
An example of the output from DICE when statistics are requested is as follows:
OVERALL STATISTICS ================== Total no. of entries in Name Table = 111 Total no. of elements checked = 782 Total no. of ref attributes found = 726 Total no. of external references = 0
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 you use the EXTERNAL option, DICE will check that all external references point to DBs of appropriate types. For example, a reference attribute in a Design DB which points to a Draft (PADD) DB must be illegal, but a reference attribute pointing to a Catalogue DB will be accepted. This command cannot be used in stand-alone mode because only one DB file can be accessed at a time. EXTERNAL NOCHECK is the default. In this mode DICE does not cross-check any references to other DBs. If EXTERNAL CHECK is specified, the following tests are applied to each external DB to which reference is made: Does the referenced DB exist? Is the referenced DB of a valid type? Is the position pointed to within the limits of the referenced DB? Note that in the case of a DB which has copies, DICE only checks that the position pointed to is within the limits of the largest copy.
A non-fatal error message is produced for each invalid external reference found. If you specify the EXTERNAL CHECK option, you can specify a preference MDB. In this case, DICE will check external references to databases which are current within the given MDB, before checking other databases in the project. This option is mainly relevant when extracts are used, which means that there may be many databases with the same database number in the project, and so it is less relevant to Global projects.
7-30
Command Details
Once set, the preference MDB remains current until another EXTERNAL CHECK PREFERENCE command is entered to set a new MDB, or to specify that none is to be used, (though the setting will become irrelevant if EXTERNAL NOCHECK or EXTERNAL REJECT is entered). Using just EXTERNAL CHECK to switch external setting back on will not affect the current preference MDB. The EXTERNAL REJECT option should normally be chosen only when you are certain that the DB which is being checked should not contain any external references. If this setting is used, any external reference found in the DB will be reported as a fatal error and further checking will be abandoned. Note that when the CHECK FILES option is used, no external reference checking can be done for that file and EXTERNAL NOCHECK will be assumed. The CLAIM options are only relevant to extracts. Extract Claimlists The CLAIM ON option (the default) will check that the claim list in an extract corresponds with the claim list in its master database. The following error messages may be produced: 700: 702: 703: 704: Element ref/ref is not in parent extract claim list Element ref/ref is claimed to another user/extract Element ref/ref needs claiming to child extract in parent extract Element ref/ref needs clearing in parent extract claim list
If PATCH ON has been selected, then an attempt is made to patch errors of type 701, 703 and 704, and these cases will be treated as warnings rather than errors (and will therefore not terminate the check even if MODE FULL has not been selected). For cases 701 and 703, the patch attempts to claim the element from the parent extract (and continues up the extract hierarchy if necessary). If successful, the following message will be written: 701: PATCH: Element ref/ref claimed in parent extract
For case 704, the patch attempts to release the element from the parent extract. If successful, the following message will be written:
7-31
Command Details
704: PATCH: Element ref/ref cleared from parent extract claim list
If the attempted patch is unsuccessful, the following error will be raised: 537: Attempt to patch failed There is no patch for errors of type 702. (Patches may also be attempted for some other extract problems.) Command Syntax:
>--- CHECKOption ----+| | | | | | | | | || | | || | | | | || || || | | `EXTernal --+- CHECK -+-----------------------. | | | | `- PREFerence -+- NONE -| | | | | `- mdb --| | | |-- NOCHeck ----------------------| | | `-- REject -----------------------| | MOde -------+-- FUll ------------------------| | | `-- BRief -----------------------| | STATistics -+-- FULL ------------------------| | | |-- ON --------------------------| | | `-- OFF -------------------------| | MAXErrors n ---------------------------------| | MAXWarnings n -------------------------------| | CLAIM ------+-- ON --------------------------| | | `-- OFF -------------------------| | PATCh ------+-- ON --------------------------| | | `-- OFF -------------------------+-->
Related Commands: CHECK
7-32
Command Details
CNAME
Changes the name of the Element. This command is the only way in which the System Administrator can change a users password without deleting and recreating the user. Note that users can change their own passwords using the PASSWORD command in MONITOR. The CNAME DB command must be used with great care. If both quoted DBs already exist, and if the OVER option is used, ADMIN will copy the second DB into the first DB, and will then delete the second DB. If, in the same circumstances, the OVER option is not used, ADMIN will generate an error message.
In a Global Project, you can only change the Name of a Team or a Database at the Hub.
Examples: CNAME USER JF RAB/ROB Change username JF to username RAB, password ROB CN DB TEAMNAME/GBPADD TEAMNAME/GBDRAFT Change DB GBPADD to GBDRAFT if GBDRAFT does not exist. CN DB TEAMNAME/GBPADD TEAMNAME/GBDRAFT OVER Change DB GBPADD to GBDRAFT even if GBDRAFT exists. In a Global project, if /GBDRAFT already exists, then it must not be allocated to locations other than the Hub, since the CNAME will delete this database. CN MDB /DES1 /DESIGN Change MDB name /DES1 to MDB name /DESIGN CN TE GEORGEB GEORGEC Change team name GEORGEB to GEORGEC.
7-33
Command Details
CNAME (continued)
Command Syntax: >-- CName --+-- USer --- username username ---+--- /password---. | | | | ----------------| | | |--- DB --- dbname dbname ---+--- OVER ------------| | | | | ---------------------| | | |--- MDB --- mdbname mdbname ----------------------| | | --- TEam -- teamname teamname --------------------+-> Related Commands: CHANGE, EXCLUDE, INCLUDE, MOVE, CDESC
7-34
Command Details
COPY
Function:
Creates a copy of a DB, MDB, Team, User, Module or Stamp. Any number of copies may be made. Copies of databases have the same database number as the original. An MDB cannot contain more than one database with the same database number. To avoid the risk of database corruption, databases must always be copied using this command in ADMIN and not by using operating system utilities or commands. Note that extract databases and databases which own extracts cannot be copied. This also applies when copying from foreign projects.
Description:
In a Global Project, you can only copy Teams and Databases at the Hub.
Examples: COPY DB ADMIN/CA1A TO ADMIN/CA1C TO AREA 051 Copies DB ADMIN/CA1A to area 051, renaming it ADMIN/CA1C COPY TEAM TESTTEAM TO SUPPORT Team SUPPORT will be the same as team TESTTEAM when queried. COPY TEAM TESTTEAM TO SUPPORT EXCL USERS Team SUPPORT will be the same as team TESTTEAM when queried, but the teams users will not be copied. CO MDB /ADMIN TO /ADMINCOPY MDB /ADMINCOPY will contain the same structure as /ADMIN. CO USER ADMINA TO TESTA/GEN A new user TESTA, password GEN will be created, belonging to the same teams, and having the same access rights as, user ADMINA COPY DB Z/Z FROM PROJ ABC US SYSTEM/XXXXXX TO A/A DB Z/Z will be copied from project ABC, so that it can be accessed by user SYSTEM, password XXXXXX, into the current project. It will be given the name A/A. COPY DB Z/Z TO A/A TO AREA 99 TO FINO 50 DB Z/Z will be copied to A/A, in area number 99 with filenumber 50. The environment variable pointing to area 50 will need to be set. COPY STAMP /stamp_005 TO /stamp_012 The stamp stamp_012 will be a copy of the stamp stamp_005. The list of databases referenced will be identical.
7-35
Command Details
COPY (continued)
Command Syntax:
>- COpy -+- DB dbname -+- FROM PROject projid USer id pass -. | | ------------------------------------+---> continued
continued --- TO dbname -+-- TO AREA n --. | | ---------------+-- TO FINO filenumber --. | | `------------------------+--->
>- COpy -+| | | || || | | | | || -
TEam teamid TO teamid -+- EXCLuding USERs ----------------------------------. | | ----------------------------------------------------| | MDB mdbname TO mdbname -----------------------------------------------------| | USer word TO word name -+--- FRee ------------------------------------------| | | |--- GEneral----------------------------------------| | | ---------------------------------------------------| | STAMP stampname1 TO stampname2 ---------------------------------------------| | MODule -+- integer ---. | | | | - moduleid --+- TO integer moduleid -------------------------------+->
Related Commands: CREATE, INCLUDE
7-36
Command Details
CREATE
Creates USERs, TEAMs, Databases (including Extracts) and MDBs. Update databases can be accessed by one writer and many readers. All PDMS databases can be update. Multiwrite databases can be accessed by many writers and many readers. DESIGN, CATALOGUE, DRAFT and ISODRAFT databases can be multiwrite. Multiwrite databases can have their claim mode set to IMPLICIT, in which case any element that is modified will be claimed automatically. Alternatively, the claim mode can be set to EXPLICIT, in which case users must claim elements before they can modify them, using the CLAIM command in the constructor module. In addition, both types of Database can be controlled, which means that access will be controlled by an external system. You can create Extract databases from standard (Master) multiwrite databases. Extract databases can be standard extracts or working extracts, and in addition, both standard and working extracts can be variant extracts. Examples of creating the different types of extracts, and the full syntax, are given here. For general information about using extracts in projects, see the VANTAGE PDMS ADMIN User Guide; for information about using extracts in Global projects, see Running Global Projects with VANTAGE PDMS. Before a newly created extract can be used at a satellite, all its owning extracts must have been allocated there. If the immediate parent extract is secondary at the satellite and there are no scheduled updates, it should have been synchronised since the new extract was created. Note: When the daemon is used to create an extract in a Global project, the CREATE EXTRACT command includes a recovery operation to restore the primary location of the database in the event of failure of the command, prior to its Allocate operation. Therefore, the PREVOWNER command is not usually needed after a failure of CREATE EXTRACT. However, the CREATE Allocate operation does not have an automatic recovery operation and, in the unlikely event of this failing, PREVOWNER may be needed.
7-37
Command Details
CREATE (continued)
In a Global Project, you can only create Teams and Master Databases at the Hub. Extracts can be created at any location. Working Extracts can only be created at locations where the owning extract database is Primary. Offline Locations: Working extracts cannot be created at an offline location that is administered by the Hub. The offline location must be locally administered. Examples:
Creating Teams, Users and MDBs

CR TEAM PIPING Create Team PIPING CREATE USER RAB/ROB Create User RAB with password ROB, default access rights CRE US HHJ/MICK FREE Create User HHJ with password MICK, free access rights CR MDB /STEEL Create MDB /STEEL
Creating Master Databases

Note: If the SET TEAM command has not been used to set the current teamid, then the dbname must be prefixed by the name of the team which owns it.
CREATE DB PIPING/PIPEDB DESI Create Design database PIPING/PIPEDB CREATE DB STEEL/STEELDB DESI ACC MULTIW CLAIM EXPL Create multiwrite Design DB STEEL/STEELDB, with explicit claim mode. CREATE DB STEEL/STEELDB DESI ACCESS MULTIWRITE DBNO 901 Create multi-write Design DB STEEL/DESI, database number (NUMBDB attribute) 901. CREATE DB TEST/TESTDESI FINO 500 Create the database TEST/TESTDESI with the given Filenumber (FINO attribute). By default, the Filenumber will be set to 0, and the filename of the database file will be derived from the database number.
7-38
Command Details
CREATE (continued)
Using the default is recommended, particularly if you are using extracts. If you set the filenumber explicitly, the extract filename will still be derived from the Database number (NUMDB attribute), and so the consistency of filenames within an Extract family will be lost. CREATE DB TEST/TESTDESI FINO 0 Create the database TEST/TESTDESI with the Filenumber (FINO attribute) of the given database set to 0. This command can be used to update database files to the new convention introduced at PDMS 11.3, which will keep Extract filenames consistent within an Extract family. CREATE DB PIPE/PIPEEB DESI IN AREA 501 Create Design DB PIPE/PIPEDB in area 501
Creating Standard Extracts

CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB Create an extract PIPING/PIPE-X1 from database PIPING/PIPEDB CREATE EXTRACT ADMIN/PIPE-X1 FROM PIPE/PIPEDB Create an extract ADMIN/PIPE-X1 from database PIPING/PIPEDB. Note the extract can be owned by a different Team from its owner. CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB EXTNO 100 Create an extract PIPING/PIPE-X1 with extract number 100 from database PIPING/PIPEDB.
Creating a Master database above an existing Master database

CREATE MASTER PIPING/PIPE-X1 ABOVE PIPE/PIPEDB Create a new master database PIPING/PIPE-X1 above existing master database PIPING/PIPEDB. This means that PIPE/PIPEDB is now a child extract of the new master PIPING/PIPE-X1
Creating Working Extracts

Working extracts can only be created from a database that is primary at the current location. CREATE WORKING EXTRACT FROM DB PIPING/PIPEDB FOR USERA Create a working extract from PIPING/PIPEDB for USERA CR WORK EXTR FROM DB PIPING/PIPEDB FOR USERB EXTNO 21 Create a working extract from PIPING/PIPEDB for USERB with extract number 21.
Creating Variant Extracts

CREATE VARIANT TEST/PIPE-V1 FROM PIPING/PIPEDB Create Design database PIPING/PIPEDB
Command Details
CREATE (continued)
Creating Extracts for a satellite
CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB AT LON Create an extract PIPING/PIPE-X1 from database PIPING/PIPEDB at satellite with LOCID LON
Creating Transaction databases (Global projects only)

CREATE DB TRANSACTION/LON Create transaction db for location with LOCID LON. Note the omission of the database type. Transaction databases have a special naming convention which associates them automatically with the location. This database is automatically created with the correct primary location. These are created as OVERWRITE databases. Command Syntax:
Databases
>- CReate DB teamid/dbname -+| || || || || CATA -. | DESI -| | ISOD -| | PROP -| | PADD -| | DICT -+- IN AREA n -. | | -------------+--->
cont
cont >--- ACCess -+- UPDATE -----. | | +- CONTRolled -. | | `- MULTIWrite -+- CLAIM -+- EXPLicit -| | | `- IMPLicit -+-----------+--> cont
7-40
Command Details
CREATE (continued)
cont >---+-- EXTNO n -. | | `-----------+- DBNO n -. | | `----------+-- FINO n --. | | `-------------+-- DESC text --. | | `---------------+--->
userid and teamid
are alphabetic character strings up to 32 characters long and passwd is an alphabetic character string up to six characters long. is a normal PDMS name consisting of a slash (/) followed by up to 31 alphanumeric characters. is a 32-character name
name dbname Extracts
>-- CReate MASTER team/db ABOVE team/db ---->
cont
>- CReate ---+--- EXTRact ---. | | `--- VARiant ---+--- team/db FROM team/db ---->
cont
>- CReate EXTRact team/db FROM team/db -+-------------------. | | `- AS AT SESSION n -+--> cont >- CReate VARiant team/db FROM team/db --------------------> >- CReate WORKing EXTRact FROM team/db FOR user ----------> cont cont
cont >---+- IN AREA n -. | | -------------+- CONTROL -. | | `-----------+- CLAIM -+- IMPLicit -. | | | | `- EXPLicit -| | | `----------------------+--> cont
7-41
Command Details
CREATE (continued)
Standard projects:
cont >--------+- EXTNO n -. | | `-----------+- DESC text -. | | `-------------+-->
Global projects:
cont >-+- EXTNO n -. | | `-----------+- REFBLOCKS n -. | | ---------------+- AT <loc> -. | | `------------+- DESC text -. | | `-------------+-->
Global Projects with VANTAGE PDMS for more details.
The REFBLOCKS option is used to allocate a block of reference numbers. See Running The AT <loc> option allows the Hub or an administering location to create an extract database whose primary location is at the specified satellite.
Transaction Databases (Global projects only)

>- CReate DB TRANSACTION/name ------------cont >
cont >--+-- EXTNO n -. | | `-----------+- DBNO n -. | | `----------+-- FINO n --. | | `-------------+-- DESC text --. | | `---------------+--->
The name must be the LOCID of a valid Location.
7-42
Command Details
CREATE (continued)
Users, Teams and MDBs
>- CReate -+- USer userid passwd -+--- FRee ------. | | | | `--- GEneral ---| | | |- TEam teamid ------------------------+-- DESC text ---. | | | | ----------------| | | - MDB name---------------------------------------------+-->
Querying:
>--- Query --+-| |-| |-| -USer userid ---. | DB dbname -----| | MDB name ------| | TEam teamid ---+-->
Related Commands: SET, MODULE, CHANGE, NEW
7-43
Command Details
CURRENT
Moves a DB to a given position in the current MDB list. The specified list position must be in the range 1-300.
CURRENT MASTER/AREA-D 2 Move DB MASTER/AREA-D to be at position 2 in the current MDB list Command Syntax: .------------<----------. / | >-- CUrrent ---+--- dbname ---*--- integer -- dbname --- | | --- integer --+-- integer -------------------->
Related Commands: ADD, REMOVE, DEFER, EXCHANGE
7-44
Command Details
DADD
Adds a DB or another DB Set to a DB Set. The DB Set must first be specified using the SET DBSET command. You can then give the keyword DB, followed by a list of DB names to be added to the Set, and the keyword DBSET, followed by a list of DB Set names to be added to the Set. The names have to be elements of the type specified by the last keyword, but you can use both keywords more than once in the same command line.
Examples:
The following example assumes that both the Team and the DB Set have been set using the SET command. DADD DB /STEELN /STEELS DBSET /ASET DB /PIPEN Adds the databases /STEELN, /STEELS and /PIPEN, and all the Databases in the DB Set /ASET, to the current DB Set.
Command Syntax:
.----------------<------------.--<---. | | / .----<-------. | | / / | | | >-- DADD --*--- DB -------*--- dbname ---+---' | | | | .-------------------<------------. | | / | | | / .-------<-------. | | |/ / | | | *--- DBSET ----*--- dbsetname ---+---+---+---> /
Querying:
Q SET DBSET
Related Commands: DREMOVE, DELETE, SET, NEW
7-45
Command Details
DEALLOCATE
Removes databases from the list of databases allocated to a Location. A named database or all databases can be specified. The databases must be Secondary at the Location. If you try to de-allocate a database from a Location which has a Descendant Location, and the database is also allocated to the Descendant, you will be warned of the existence of the Descendent allocation, and no action will be taken. You must use the INCLUDING DESCENDANTS option to de-allocate the database from all Descendant Locations as well. When a de-allocation command is in progress, the location is locked against Allocate commands. This lock is set when the Deallocate command is issued, and released by the daemon once the database(s) have been deleted at the location. The Allocate command can still be executed, but will stall until the full deallocation is complete. Locking only applies to the locations where dBs are being deallocated, and other locations should not be affected. The transaction database for the location is not de-allocated when de-allocating all databases. See the guide Running Global Projects with VANTAGE PDMS for more information about de-allocating databases that have extracts.
Examples: DEALLOCATE PIPE/PIPE AT CAM Removes the database PIPE/PIPE from Location CAM. The database must not exist at any Locations which are descendants of CAM. DEALLOCATE HVAC/HVAC AT OXF INCLUDING DESCENDANTS Removes the database HVAC/HVAC from Location OXF and all descendants of OXF. DEALLOCATE ALL AT LON Removes all databases which exist at Location LON. Note that you cannot use the INCLUDING DESCENDANTS option with ALL.
7-46
Command Details
DEALLOCATE (continued)
Command Syntax:
>- DEALLOCate -+- teamid -. | | |----------+- dbname -+- INCluding DESCENDants -. | | | | `-------------------------| | | `- ALL -----------------------------------------+-- AT <loc> -->
Related Commands: ALLOCATE, CHANGE Querying: At a location: >--- Q DBALL At a Database: >--- Q DBLC --->
7-47
Command Details
DEFER
Makes a specified DB non-current. Moves a DB from the current list of an MDB into the deferred list of an MDB. You can specify the position in the list by giving an integer.
Examples: DEFER MASTER/AREA-D Make DB MASTER/AREA-D non-current. Command Syntax:

.------<------. / | >-- DEfer ---+--- dbname ---*--- dbname --- | | --- integer --+----------------->
Related Commands: ADD, REMOVE, CURRENT, EXCHANGE
7-48
Command Details
DELETE
Function:
Deletes elements from the project. Note on Deleted Files When a database is deleted, its file is renamed by addition of the suffix .deleted. The renamed file is actually deleted on the next SAVEWORK or module switch, once the change has been saved in the system or global database. This arrangement allows database files to be recovered after a crash, by the PDMS exit handler. However, if the exit handler cannot be invoked (for example, due to a loss of power) then the files with the .deleted suffix can be restored manually, to make the project directory consistent with the system or global database.
Description:
The DELETE command can be used to delete Admin elements. The DELETE command cannot be abbreviated. This helps protect against accidental deletion. To avoid the risk of database corruption, all deletion of DBs (i.e. the files inside the Project Directory) must be done from the ADMIN module and not by using operating system utilities or commands. You can only delete Teams, Databases, Locations and Groups at the Hub. Offline locations: When a location is deleted, the system administrator must ensure that the system database for that location is deleted from all other locations. See Running Global Projects with VANTAGE PDMS for further information about deleting databases and extracts from a Global project.
Notes on Global Projects:
Examples: DELETE USER DELETE TEAM DELETE MDB DELETE DB Deletes the current element of the appropriate type. DELETE DB PIPEN/DESI Deletes Database PIPEN/DESI DELETE USER HVAC Deletes User HVAC
7-49
Command Details
DELETE (continued)
DELETE TEAM PIPEN Deletes Team PIPEN DELETE MACRO 7 Deletes inter-db connection macro 7 in current project DELETE MESSAGE 3 Deletes message 3 in current project DELETE RUNFILE Deletes runfile entry for current module. DELETE STAMP Deletes the stamp that is the current element.
Global Projects only:

DELETE LOCATION Deletes the current Location. This will remove the system database file for that location from all other locations. The location may be deleted provided all databases (other than its transaction database) have been deleted. DELETE LOCATION LON Deletes Location LON. DELETE GRP Deletes the current Location Group. DELETE LCOMD Deletes the current communication event. DELETE WORKING EXTRACT FROM CTATEST/DES1 FOR USERA Deletes the working extract for USERA from the database CTATEST/DES1. Working extracts cannot be deleted unless the owning extract is primary at the currently administered location.
7-50
Command Details
DELETE (continued)
Command Syntax:
>--- DELETE ---+--- USer ------+--- user--------------------------. | | | | `----------------------------------| | | |--- TEam ------+--- team_name --------------------| | | | | `----------------------------------| | | |--- DB --------+--- db_name ----------------------| | | | | `----------------------------------| | | |-- WORKing -+- EXTract --. | | | | | | `- VARiant --+- FROM dbname FOR user -| | | |--- MDB -------+--- mdb_name ---------------------| | | | | `----------------------------------| | | |--- LOCation --+--- code -------------------------| | | | | |--- location_name ----------------| | | | | `----------------------------------| | | |--- GRP ------------------------------------------| | | |--- LCOMD ----------------------------------------| | | |--- MESSage n ------------------------------------| | | |--- MACro n --------------------------------------| | | |--- RUNFile --------------------------------------| | | |--- STAMP ----------------------------------------| | | | .--------<-------. | | / | | --- MOdule ----*--- integer ------| | | | | --- module_name --+---------------+-->
Locations, GRPs and LCOMDs exist in Global Projects only.
7-51
Command Details
DREMOVE
Removes a DB or DB Set from the current DB Set. The DB Set must first be specified using the SET DBSET command. You can then give the keyword DB, followed by a list of DB names to be removed from the Set, and the keyword DBSET, followed by a list of DB Set names to be removed from the Set. The names have to be elements of the type specified by the last keyword, but you can use both keywords more than once in the same command line. Note that DB Sets are deleted using the DELETE command.
Examples:
The following example assumes that both the Team and the DB Set have been set using the SET command. DREM DB /STEELN /STEELS DBSET /ASET DB /PIPEN Removes the databases /STEELN, /STEELS and /PIPEN, and all the Databases in the DB Set /ASET, from the current DB Set.
Command Syntax:
.----------------<------------+--<---. | | / .----<-------. | | / / | | | >-- DREMove --*--- DB -------*--- dbname ---+---' | | | | .-------------------<------------. | | / | | | / .-------<-------. | | |/ / | | | *--- DBSET ----*--- dbsetname ---+---+---+---> /
Querying:
Q SET DBSET
Related Commands: DADD, DELETE, SET
7-52
Command Details
DUMP
(Reconfiguration)
Writes a reference number index to the given file. If required, the reference index should be written for each database.
DUMP /DUMP1 Write reference number index to named file. Command Syntax:
>--- DUmp filename --->
Related Commands: LOAD, XREF
7-53
Command Details
DUPLICATENAMES
Checks for elements with duplicate names in the Project. You can specify all Databases in the Project or a list. The process takes place in several stages, using different variations of the command. A typical sequence is shown in the Examples.
Example of Command Sequence: DUPLIC START Initialise memory allocation etc. DUPLIC FILE /filename Specify file for report. If this command is not given, the report will be sent to the screen. DUPLIC INCLUDE ALL Include all the Databases in the project in the check. DUPLIC EXCLUDE DB dbname dbname ... Exclude the named Databases from the check. DUPLIC CHECK Perform duplicate name check on the Databases specified in the INCLUDE and EXCLUDE options, and exit. The list of Databases to be checked will be emptied. If you want to do another check, you must give the DUPLIC START command again, re-define the list of Databases you wish to check, and give the DUPLIC CHECK command again. Other Examples: Other options which you can use to set up the list of Databases are as follows: DUPLIC INCLUDE DB dbname dbname ... Include the named Databases in the check. DUPLIC INCLUDE CLEAR Remove all entries in INCLUDE list DUPLIC INCLUDE LIST List all entries in INCLUDE list DUPLIC EXCLUDE CLEAR Remove all entries in EXCLUDE list DUPLIC EXCLUDE LIST List all entries in EXCLUDE list
7-54
Command Details
DUPLICATENAMES (continued)
The output reports the element name and the DB reference number and DB number for each of the duplicates, for example: /00NEB0SED =15196/3964, 7004, =15192/24230, 7000 /00NEB0SFD =15196/3965, 7004, =15192/24231, 7000 /00NEB0SFE =15196/3966, 7004, =15192/24232, 7000 If both MASTER and COPY DBs occur in the list then the DB refs and nos will be identical. If necessary, use the LIST DBS command to associate a DB name with a DB number. Command Syntax:
>--- DUPLICatenames START ---> >--- DUPLICatenames FIle filename ---> >--- DUPLICatenames INclude ---+--| | | |--| |--| `--ALL ---------------------. | .----<-------. | / | | DB ---*--- dbname ---+---| | LIST --------------------| | CLEAR -------------------+--->
.----<-----------. / | >--- DUPLICatenames EXclude ---+--- DB ---*--- dbname -------+ | | |--- LIST --------------------| | | `--- CLEAR -------------------+---> >--- DUPLICatenames CHECK --->
7-55
Command Details
EDIT
Function:
(Module definition)
Enables project module entries to be edited. Enters edit mode (which continues as long as only command lines beginning with EDIT or MODULE are used) within which a project module entrys NAME, NUMBER, SECURITY, MODE, data file, RESUME file and IMACRO and BUFFER options can be edited.
Description:
Examples: EDIT MODU ADMIN IMACRO /START Enter EDIT mode and edits module ADMIN to add the macro /START as an initialisation macro. EDIT MODU 77 SECU FR Enter EDIT mode and edits module 77 to make it a FREE module MODU 77 MODE CATA RW In Edit mode, change module 77 to CATA db with read/write mode. EDIT MODU DESIGN RES /%PDMSEXE%/DES Change resume file name for DESIGN module entry EDIT MODU ADMIN IMACRO DELETE Edits the ADMIN module definition and deletes the Imacro entry.
7-56
Command Details
EDIT (continued)
Command Syntax:
.----------------------------------------------------------------------------. / | >- EDit -*- MODule -+- number --. | | | | | | - modname -+- NUmber number ---------------------------------------| | | | | |- NAme name -------------------------------------------| | | | | |- Security -+- FRee ------------------------. | | | | | | | | `- GENeral ---------------------| | | | | | | |- Mode file -+- RW -------------------------| | | | | | | | | |- Read -----------------------| | | | | | | | | |- None -----------------------| | | | | | | | | - DEFault --------------------| | | | | | | |- Open -+- SYMBOLFILE --. | | | | | | | | | | |- ATTlibfile --| | | | | | | | | | | - MESSagefile -+- name -. | | | | | | | | | | --------+- DELETE -| | | | | | | | | ----------| | | | | | | |- Resume file ------------------------------| | | | | | | |- Buffer -+- integer -----------------------| | | | | | | | | - DEFault -----------------------| | | | | | | |- Imacro -+- name ---. | | | | | | | | | | - DELETE -+----------------------+- newline- | | ----------------------+--------------------------------------------------------->
Related Commands: MODULE, LIST MODULES, DELETE MODULES
7-57
Command Details
ERRORFILE

Specifies the name of the file containing the error and warning messages when DICE is used in stand-alone mode. 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 available automatically, but this is not the case in stand-alone mode. Hence the first command you must give in stand-alone mode is the ERRORFILE command, followed by the name of the error message file. The name of the message file can be found from the entry for DICE in the current version of makemac.mac, the project configuration macro.
Examples: ERRORFILE /%PDMSEXE%/MESSAGE.DAT Command Syntax: >--- ERRORfile filename ---> Related Commands: MODULE, LIST MODULES
7-58
Command Details
ERRORS
(Reconfiguration)
Sets an upper limit on the number of errors that are acceptable during Pass 2 of a reconfiguration. If the specified limit is reached, reconfiguration is abandoned and the DB is left unaltered. By default, an unlimited number of errors can occur.
Command Syntax:
>--- ERRors number --->
Related Commands: BRIEF, FULL, VB
7-59
Command Details
EXCHANGE
Replaces the current DB by a non-current DB. The DB names to be exchanged do not need to be listed in a particular order, since the MDB knows which are current and which are non-current, but they must be paired correctly if more than two names are listed.
Examples: EXCHANGE PIPING/AREA-A SERV/AREA-D SERV/AREA-E PIPING/AREA-B PIPING/AREA-A and PIPING/AREA-B are the current DBs. They will be replaced by the DBs SERV/AREA-D and SERV/AREA-E respectively, even though they are listed out of sequence. Command Syntax: .--------<----------. / | >-- EXchange ---*--- dbname dbname --- | |-----------------------. | | --- integer integer ---+---> Related Commands: ADD, REMOVE, CURRENT, DEFER
7-60
Command Details
EXCLUDE
Function:
Removes a database which has been included from an external project.
In a Global Project, you can only exclude Databases at the Hub. The database must not be allocated to any satellites.
Examples: EXCLUDE DB MASTER/STEELCATA Remove named DB from current project Command Syntax:
>--- EXCLude DB dbname --->
Related Commands: INCLUDE
7-61
Command Details
EXPUNGE
(Project administration)
Removes users who are accessing the Project, and releases claimed elements in Multiwrite databases. This command can be used to remove phantom users after abnormal exits. Users who are actually accessing the Project will be removed as soon as they change module. databases at Locations which you administering remotely by prefixing it with the REMOTE <loc> command, where <loc> is the Location identifier. See the REMOTE command for examples.
In a Global project, you can use this command on Constructor
In a Global project, you can use the EXPUNGE DB SYSTEM command to expunge the current administered System database. You will have to give the ADMINISTER SYSTEM command first if you are administering a Location remotely.
Examples: EXPUNGE 29f Expunge user identified by given process number. EXPUNGE Expunge all users. (This should be used with care.) EXPUNGE DB dbname Releases elements which have been claimed in a multiwrite database. These elements may be inaccessible after a user has exited abnormally. This is not allowed if there are current users accessing the DB. EXPUNGE DB SYSTEM Releases elements which have been claimed in a SYSTEM database.. These elements may be inaccessible after a user has exited abnormally. EXPUNGE DB dbname USER usernumber Expunges given user from given DB. This is allowed even if there are users accessing the DB. It is the preferred way of freeing unreleased claims.
7-62
Command Details
EXPUNGE (continued)
Command Syntax:
.-----<--------------------------------. / | >-- EXPUNGE --*-- process_id --------------------------| | | |-- DB dbname ----+-- USER usernumber ---| | | | | `----------------------' | |--- DB SYSTEM ---. | | -----------------+------------------>
Note:
All the EXPUNGE syntax can be applied to a remote Location in a Global Project by prefixing the command by REMOTE <loc>, where <loc> is the Location identifier. See the REMOTE command for examples. Q ACTIVE SYSTAT, For Global projects - REMOTE, REMOTE EXPUNGE
Querying: Related Commands:
7-63
Command Details
EXTERNAL

Checks that all external references point to DBs of appropriate types. The elements in some types of DB have reference or reference array attributes which can point to elements in other DBs. If you use the EXTERNAL command, DICE will check that all external references point to DBs of appropriate types. For example, a reference attribute in a Design DB which points to a Draft (PADD) DB must be illegal, but a reference attribute pointing to a Catalogue DB will be accepted. This command cannot be used in stand-alone mode because only one DB file can be accessed at a time. EXTERNAL NOCHECK is the default. In this mode DICE does not cross-check any references to other DBs. This setting is used by standalone DICE (and REMOTE CHECK). If EXTERNAL CHECK is specified, the following tests are applied to each external DB to which reference is made: Does the referenced DB exist? Is the referenced DB of a valid type? Is the position pointed to within the limits of the referenced DB? Note that in the case of a DB which has copies, DICE only checks that the position pointed to is within the limits of the largest copy.
A non-fatal error message is produced for each invalid external reference found. The EXTERNAL REJECT option should normally be chosen only when you are certain that the DB which is being checked should not contain any external references. If this setting is used, any external reference found in the DB will be reported as a fatal error and further checking will be abandoned. If the DICE option CHECK FILES is used, no external reference checking can be done for that file and EXTERNAL NOCHECK will be assumed.
7-64
Command Details
EXTERNAL (continued)
Examples: EXTERNAL CHECK EXTERNAL NOCHECK EXTERNAL REJECT An example of the output when EXTERNAL CHECK is specified: External databases referenced _____________________________ Number ______ 8 31 Command Syntax: >--- EXTernal ---+--- NOCHeck* ---. | | |--- CHECK ------+-- PREFERENCE | | --- REject -----+---> The default is NOCHECK. Name ____ GLB/DESI TECHP/TPDESI No of references ________________ 41 4
7-65
Command Details
EXTRACT
Control of database extracts This command allows you to release, issue, drop and refresh extract databases. FLUSH Writes the changes back to the parent extract. The Extract claim is maintained. The extract is refreshed with changes that have been made to its owning database.
FLUSH RESET Resets the database after a failed EXTRACT FLUSH command. If more than one user is issuing the same database extract, then flush and release commands can be processed in the wrong order, causing a flush to fail and preventing subsequent refreshes of the extract. This command can be used to undo the failed flush. FLUSHW (Flush without refresh) Writes the changes back to the parent extract. The Extract claim is maintained. The extract is not refreshed. Refreshes any extract in the database hierarchy with changes that have been made to its parent extract.
REFRESH
FULLREFRESH Refreshes an extract and all its parent extracts its ancestors. A full refresh takes place from the top of the database hierarchy downwards, ending with a refresh of the extract itself. Each extract is refreshed with changes that have been made to its parent extract. ISSUE RELEASE Writes the changes back to the parent extract, and releases the extract claim. Releases the extract claim: this command can only be used to release changes that have already been flushed. Drops changes that have not been flushed or issued. The user claim must have been unclaimed before this command can be given.
DROP
7-66
Command Details
EXTRACT (continued)
Note that unlike the constructor modules, you can only perform these operations on a complete database in ADMIN, and so claiming has no meaning in ADMIN. For general information about using extracts in projects, see the VANTAGE PDMS ADMIN User Guide. For information about using extracts in Global projects, see Running Global Projects with VANTAGE PDMS.
In a Global project, Flush, release and issue may be executed remotely if the parent extract is not primary at the current location.
Offline locations: Extracts cannot be used which are primary at an offline location unless the entire extract hierarchy is primary at the offline location. This is because claim, flush and release commands can only be issued locally. There is no mechanism at an offline location to claim (etc.) from an online location. Examples: EXTRACT FULLREFRESH DB PIPE/PIPE-X1 Refreshes all parent extracts in the database hierarchy above PIPE/PIPE-X1, ending by refreshing PIPE/PIPE-X1 itself with changes to its parent extract. EXTRACT REFRESH DB PIPE/PIPE-X1 Refreshes database PIPE/PIPE-X1 with changes to its parent extract. EXTRACT RELEASE DB PIPE/PIPE-X1 Releases all extract claims in database PIPE/PIPE-X1. EXTRACT ISSUE DB PIPE/PIPE-X1 Issues all changes to database PIPE/PIPE-X1 and releases the extract claim. EXTRACT FLUSH DB PIPE/PIPE-X1 Writes the changes to database PIPE/PIPE-X1 back to its parent extract, but keeps the elements claimed to the extract. Also, PIPE/PIPE-X1 is refreshed with changes to its owning database. EXTRACT FLUSHW DB PIPE/PIPE-X1 Writes the changes to database PIPE/PIPE-X1 back to its parent extract, but keeps the elements claimed to the extract. PIPE/PIPE-X1 is not refreshed. EXTRACT DROP DB PIPE/PIPE-X1 Drops all changes to database PIPE/PIPE-X1.
7-67
Command Details
EXTRACT (continued)
EXTRACT FLUSH RESET DB PIPE/PIPE-X1 Undoes a failed flush on this database. Command Syntax:
>-- EXTRACT -+| | || || || || || `FLUSH --+------------. | | `--- RESET --| FLUSHWithoutrefresh -| | RELEASE -------------| | ISSUE ---------------| | DROP ----------------| | FULLREFRESH ---------| | REFRESH -------------+- DB - dbname -->
Note:
In ADMIN, you cannot carry out partial operations as you can in the constructor modules. The commands can only be applied to entire DBs.
7-68
Command Details
FINISH
Function: Examples:

The FINISH command saves work and leaves PDMS.
FINISH Command Syntax: >--- FINISH ---> Related Commands: SAVEWORK
7-69
Command Details
FONTDIRECTORY
(Font definition)
Sets the font directory name. The font directory stores the font families for use in DESIGN and DRAFT. Font families are defined by the FONTFAMILY command. The FONTDIRECTORY command can be given in ADMIN or used in the make macro. In the make.mac macro supplied the font directory is defined as %PDMSEXE%. If the font directory is unset, PDMS will search for the fonts in the users current directory.
Examples: FONTD /%PDMSEXE% Command Syntax:

>--- FONTDirectory name --->
Querying:
>--- Q FONTDirectory --->
Related Commands: FONTFAMILY, Q FONTS
7-70
Command Details
FONTFAMILY
(Font definition)
Defines a font family. Defines a font family in terms of a character set and a style, or in terms of a file. If a file is specified, a bold version of the same font family can also be specified. Sloping text can be produced. The directory where the font files are to be found must be specified using the FONTDIRECTORY command. The macro makemac.mac supplied with PDMS includes the following commands: FONTF FONTF FONTF FONTF FONTD 1 UK STYLE 2 UK STYLE 3 UK STYLE 4 UK STYLE /%PDMSEXE% 1 2 3 4
For each font family, you can define an angle of slope between -85 and +85 degrees inclusive. The text can be sloped forwards (positive angles) and backwards (negative angles). Examples: FONTFAMILY font_no IR ir_no STYLE style_no ANGLE angle FONTFAMILY font_no FILE /abc BOLD /def ANGLE angle PROJECT MBCHARSET JAPAN ANGLE angle FONTFAMILY 1 IR 4 STYLE 1 FONTF 2 UK ITALIC FONTF 3 UK BLOCK FONTF 4 GREEK STYLE 1
7-71
Command Details
FONTFAMILY (continued)
Command Syntax:
.-------------------------<------------------------------. / | >-- FONTFamily ---*--- n ---*- IR number --. | | | | |- UK ---------| | | | | |- US ---------| | | | | |- GREEk ------| | | | | |- CYRIllic ---| | | | | |- LATIn 1 ----| | | | | |- LATIn 2 ----+-- STYle n ---------. | | | | | | |-- LIne ------------| | | | | | | |-- BLock -----------| | | | | | | |-- SErif -----------| | | | | | | |-- ITalic ----------| | | | | | | |-- SCript ----------| | | | | | | |-- TYpewriter ------| | | | | | | -- UWLIne ----------| | | | | - FILE filename -- BOLD filename --+- ANGLE n --| | | `------------+-->
Notes: The IR number is the International Registration Number of the font. See ISO 8859. The font family number must be in the range 1-4 The style n must be in the range 1-7. The angle n must be in the range -85 to + 85 degrees. Negative angles slope the text backwards. Related Commands: FONTDIRECTORY Querying: >--- Q FONTFamily integer --->
7-72
Command Details
FROM
Function: Examples:
(Reconfiguration)
Specifies the source database for reconfiguration.
FROM DB MASTER/DESIGN Source data is in database MASTER/DESIGN in current project FROM DBFILE /des016 Source data is in specified file (assumes project directory is current directory) FROM PROJECT des MASTER/DESIGN Source data is in specified DB within project des FROM FORMATTEDFILES /F1 /F2 Source data is in named character-format intermediate files (used when transferring data between computers). FROM SYSTEM This command is used to reconfigure the System database. It is followed by the command RECONFIGURE. For more information, see Section 3. In a Global Project, this command is only available at the primary location of the System DB (the administering location). FROM GLOBAL
This command is only available in a Global Project, at the Hub. The command is used to reconfigure the Global database. It is followed by the command RECONFIGURE. For more information, see Section 3.
Command Syntax:
>--- From ---+--| |--| |--| |--| |--| |--| |--| --DBFile filename ----------------------------. | DB dbname ----------------------------------| | PROJect code dbname ------------------------| | SYSTEM -------------------------------------| | GLOBAL -------------------------------------| | FIles --------------------. | | | BINaryfiles --------------| | | | FORMattedfiles -----------+--- name name ---+-->
Related Commands: RECONFIG, RCFCOPY, TO
7-73
Command Details
FULL
Function:
(Reconfiguration)
Gives full output from pass 2 reconfiguration. All information output in BRIEF mode is given, plus a log of all elements successfully created and named. FULL mode is very verbose and its use is not generally recommended.
Description:
Command Syntax:
>--- FUll --->
Related Commands: BRIEF, VB, ERRORS
7-74
Command Details
GENERATE

Generates the files required for a new location. All the Project files are copied to a transfer directory at the Hub, ready for transmission to the new satellite. The transfer directory is specified by the environment variable character identifier of the new location.
project_locid where project is the 3-character project code and locid is the 3-
Before the command is given, the environment variable must be set, the transfer directory must exist and contain the normal project sub-directories, and the transaction database for the location must already have been created. The project Hub should have already been initialised (or its LINIT attribute set True). All the files in the Project will be copied to the transfer area. They must then be transferred to the Location before the Location is initialised. After a LOC element has been created for a new Location, the LOCID and LOCREF must be set. The LOCID assigns a unique three-character code to the new Location. The LOCREF defines the position of the new Location within the network by specifying its unique parent Location. This command sets the LINIT flag for an offline Location. The LINIT flag must be set by the INITIALISE command for an online Location. If the ALLOCATE option is specified, all the Databases allocated to the Locations Parent will be allocated to the new Location as well. The NOALLOCATE option means that no databases (other than its transaction database) will be allocated to the new Location: no database files will be copied to the transfer area. Note that a transaction database must have been created for the location (and for the Hub), and the Hub must have been initialised.
7-75
Command Details
GENERATE (continued)
Examples: GENERATE LOCATION LON Generates a location with identifier LON. By default, all Databases at the Hub will be allocated to LON. GENERATE LOCATION /LONDON Generates a location /LONDON, allocating all databases. GENERATE LOCATION LON NOALLOCate Generates a location with identifier LON. No Databases will be allocated. Note: Command Syntax:
>-- GENerate LOCation <loc> --+--- ALLOCate -----. | | `--- NOALLOCate ---+-->
If the location identifier contains numeric characters, it must be enclosed in quotes.
Related Commands: INITIALISE For Offline locations: TRANSFER Querying: >--- Q LINIT ---> >--- Q DBALL --->
7-76
Command Details
GETWORK
Function:

Refresh view of System database, if there is more than one ADMIN user.
In Global projects, this command must be given before you can
VANTAGE PDMS.
Command Syntax:
>--- GETWORK --->
see changes made to the Global and Transaction databases by the Global daemon. For detailed information about when GETWORK commands are necessary, see Running Global Projects with
Related Commands: SAVEWORK
7-77
Command Details
HUBLOCATION
Relocate Project Hub. The specified Location becomes the new Hub. The Location which will become the new Hub must have all DBs allocated to it using the ALLOCATE ALL OVERRIDE PROPG command before the HUBLOCATION command is given. (The OVERRIDE PROPG option ensures that non-propagating databases, including transaction databases are allocated to the new hub) You may also wish to give a SYNCHRONISE command at the Location which will become the Hub to bring the databases up-todate. You are advised to backup the Global database at the Hub before issuing this command. The relocation can be deferred until a given time (for online Locations only). Note: Before you give this command, the new Hub Location must have a locally administered System database, and all constructor databases must be allocated to it (see above). You must wait for the operation to complete: see the VANTAGE Plant Design Global User Guide for more information on Hub administration.
If a HUBLOCATION command fails, the previous Hub will normally be recovered automatically. If the recovery fails (for example, the daemon is not running), you can recover the previous Primary location using the command: PREVOWN HUB Use of the PREVOWN command should be avoided if possible.
Examples: HUBLOCATION LON Relocates the Hub to location with identifier LON. HUBLOCATION LON AT 20:00 Relocates the Hub to location with identifier LON at 2000 hrs.
7-78
Command Details
HUB LOCATION (continued)

Command Syntax:
>--- HUBLOCation <loc> ---+-----------------. | | `--- AT <time> ---+--->
Related Commands: PREVOWNER HUB, ALLOCATE ALL Querying: >--- Q HUBRF --->
7-79
Command Details
INCLUDE
Function:
Includes databases from another project in the current MDB. Note that the external databases can only be accessed in Readonly mode.
In a Global Project, you can only include Databases at the Hub.

Description: Included databases are also known as foreign databases. They are often used for sharing Catalogues. When creating a new Project that is required to share DBs from other Projects, there are two important considerations: Teams must exist for all DBs that are to be shared. DBs in the source project that are to be shared should not be given a DB number that will clash with a DB number that already exists in the destination project.
Examples: INCLUDE DB MASTER/PIPECATA FROM PROJ MAS USER USERA/A The database MASTER/PIPECATA from project MAS will be included in the current project. The user/password (USERA/A in this example) must be a FREE user in the source project. Command Syntax:
>--- INCLude DB dbname FROM PROject projectid USer username/password --->
Related Commands: CNAME, MOVE, CHANGE, EXCLUDE, COPY
7-80
Command Details
INITIALISE

Initialise communications link at an on-line Location. This command checks for the existence of the Admin daemon at the given location and informs the Hub that the location is online. The command must be given at the Location after the files generated by the GENERATE LOCATION command have been transferred to the Location, and the Admin daemon has been started at the Location. Locations must be initialised before any Global activities can take place. Note that this command is only needed for online Locations: the LINIT attribute of an offline Location is set to TRUE by the GENERATE LOCATION command. When you first use a Global project, it is necessary to initialise the Hub. The Hub transaction database must be created before initialising.
Examples:
INITIALISE
Command Syntax:
>--- INITIALise --->
Related Commands: GENERATE LOCATION Querying: Q LINIT
7-81
Command Details
ISOLATION

Isolates a Location so that no updates take place. An isolated Location will not accept database updates from other Locations, or transfer updates to other Locations. Note that User messages and queries are accepted, and some commands can be passed through an isolated Location. A Location may need to be isolated if data corruption is suspected. Isolation commands are not recorded in the transaction database.
Examples: ISOLATION TRUE Isolates the current Location. ISOLATION FALSE Connects the current Location. ISOLATION TRUE AT LON Isolates the remote Location LON. This command is only available at
the Hub or at the administering location (in this example, that for LON).
ISOLATION FALSE AT LON Connects the remote Location LON. This command is only available at
the Hub or at the administering location (in this example, that for LON).
Command Syntax:
>--- ISOLATion ---+--- TRUE ----. | | `--- FALSE ---+--- AT <loc> ---. | | `----------------+--->
Querying:
>--- Query ISOLATion ---+--- AT <loc> ---. | | `----------------+--->
7-82
Command Details
LIST
Function:
(Querying)
Lists Project Information
Examples: LIST Outputs date and time. LIST USERS Lists the Users in a project. LIST MDBS Lists the Multiple Databases in a project. LIST DBS Lists the Databases in a project. LIST DBS OF TYPE DESI Lists all the Databases of type DESI in a project. LIST TEAMS Lists the Teams in a project. LIST COPIES Lists the DBs in a project which have been copied and the filenames of the copies. LIST ALL Lists the Users, Teams, Databases and MDBs in a project. LIST FILES Lists the DBs in a project and their corresponding filenames in the Project directory. LIST MESSAGES Lists inter-user messages. LIST MODULES Produces information on all the PDMS modules used by the project. LIST MODULES 5 Produces information on module 5. LIST MODULES DESIGN Produces information on module DESIGN. LIST MESSAGES Lists inter-user messages. LIST PASSWORDS Lists users ids and passwords. LIST TYPES Lists the types of DB currently permissible.
7-83
Command Details
LIST (continued)
LIST SIZES Gives the sizes of all the DBs in a project. LIST EXTERNAL Lists DBs which are being shared with another project. LIST MACROS Lists inter-db connection macros. LIST AREA 51 Lists DBs in Project Area 51. LIST WORKing EXTracts Lists the working extracts. LIST WORKing EXTracts FOR user Lists the working extracts for the specified user. LIST WORKing EXTracts dbname Lists the working extracts for the specified DB.
7-84
Command Details
LIST (continued)
Command Syntax:
.----------------------<----------- ----------. / | >--- LIst ---*-----------------------------------------------| | | |--- USers -------------------------------------| | | |--- MDBs --------------------------------------| | | |--- DBs ---+--- OF TYPE type ------------------| | | | | -----------------------------------| | | |--- TEams -------------------------------------| | | |--- FIles -------------------------------------| | | |--- COpies ------------------------------------| | | | .-------<---------. | | / | | |--- MOdules ---*--- integer -------| | | | | | | |--- module_name --- | | | | | -------------------------------| | | |--- MESSages ----------------------------------| | | |--- ALL ---------------------------------------| | | |--- PASSwords ---------------------------------| | | |--- TYpes -------------------------------------| | | |--- SIZes -------------------------------------| | | |--- MACRos ------------------------------------| | | |--- AREA --- integer --------------------------| | | |--- EXTernal ----------------------------------| | | --- WORKing EXTracts -+----------.- FOR user -+---> | | - dbname
Related Commands: QUERY
7-85
Command Details
LOAD
Function: Examples:
(Reconfiguration)
Loads the reference number index from the given file.
LOAD /DUMP1 Read reference number index from named file and replace current index. LOAD /DUMP1 APPEND Read reference number index from named file and append to current index. Command Syntax: >--- LOad ---+--- APPEND ---. | | --------------+--- filename ---> Related Commands: DUMP, REINIT, XREF
7-86
Command Details
LOCK
Function:
Locks the Project Database and prevents any other user from entering the database until the project is unlocked. from the Hub.
In a Global Project, a Project Database can be locked remotely
Description:
LOCK has no effect on users already accessing a project; it simply prevents people from entering that project. If the System Administrator is planning to execute a major change, particularly if he is to incorporate new versions of modules, he should first LOCK the project, then send a message to all users asking them to leave PDMS, make the required changes when there are no users left actively in the project, and finally UNLOCK it. Locking and Unlocking commands are not recorded in the transaction database.
Examples: LOCK Locks the Project database. LOCK AT LON Locks the Project database at the remote Location LON. Only available
at the Hub of a Global Project or at the administering location for the location (in this example, the administering location for LON).
Command Syntax:
>--- LOCK ------>
Related Commands: UNLOCK Querying: >--- Query LOCK --->
Only available at Hub of a Global Project or at the administering location:

>--- Query LOCK ---+--- AT <loc> ---. | | `-----------------+--->
7-87
Command Details
MAKE GLOBAL
Make a standard Project into a Global Project. This command splits the System database, creating a local System database and a Global database. This format is suitable for distribution to several geographical places. The Project becomes a Global Project with one Location, the Hub. The Project should be locked before the MAKE GLOBAL command is issued, and unlocked afterwards. Warning: This command should be used with care, as it alters the structure of the System database. This process cannot be reversed using PDMS. You are advised to take a full backup of your Project before proceeding.
PLANT DESIGN Global User Guide.

Examples: MAKE GLOBAL Command Syntax:
>--- MAKE GLOBAL --->
For details of Global Project Administration, see the VANTAGE
7-88
Command Details
MAXERRORS
Function:
Specifies the maximum number of errors found before data integrity checking is abandoned. Note: This command should only be used when running DICE in stand-alone mode (or REMOTE CHECK). For DICE checking within a PDMS project, use the CHECKOPTION command.
Description:
In FULL mode, DICE checks the DB or files specified, listing all errors and warnings, until a prescribed maximum number of errors or warnings is exceeded. Checking of that DB is then abandoned. The default setting for the maximum error count is 50, but you can specify a different number by using the MAXERRORS command.
Examples: MAXERRORS 100 Related Commands: MODE, MAXWARNINGS Command Syntax:

>--- MAXErrors integer --->
7-89
Command Details
MAXUSERS
Function:
Sets the maximum number of users for a project. Note that there is no theoretical limit to the number of simultaneous users, but a limit may be set by the current licence restrictions.
Examples: MAXUSERS 10 Command Syntax:

>--- MAXUSers integer --->
7-90
Command Details
MAXWARNINGS
Function:
Specifies the maximum number of warnings found before data integrity checking is abandoned. Note: This command should only be used when running DICE in stand-alone mode (or REMOTE CHECK). For DICE checking within a PDMS project, use the CHECKOPTION command.
Description:
In FULL mode, DICE checks the DB or files specified, listing all errors and warnings, until a prescribed maximum number of errors or warnings is exceeded. Checking of that DB is then abandoned. The default is 50.
Example: MAXWARNINGS 100 Related Commands: MODE, MAXERRORS Command Syntax:

>--- MAXWarnings integer --->
7-91
Command Details
MERGE CHANGES
Function:
Merges the changes made to a database over several sessions.
In a Global Project, this command can only be carried out when you are administering the Primary Location of a Database.
Description: Sessions are defined as the work done between SAVEWORK commands. They allow you to track the changes made to a database. If you are not interested in the history, or you want to save disk space, you can merge the changes made in several sessions. in databases which are Primary at a remote Location by prefixing it with the REMOTE <loc> command, where <loc> is the Location identifier. See the REMOTE command for examples. After you merge changes, some session data is deleted. The sessions remaining are those that you have either kept deliberately, or stamped sessions, as these cannot be merged. Note: If a database owns an extract database, you cannot merge the linked session, that is the session which was current when the extract was created.
In a Global project, you can use this command to merge changes
Note:
In a Global project, spurious lost bucket errors may be reported on the master database if there are working extracts at other locations.
Examples: MERGE CHANGES HVAC/PADD AFTER SESSION 4 BEFORE SESSION 10 Merges all the changes to the HVAC/PADD database after session 4 and before session 10, that is all changes made in sessions 5 to 9 will be combined. If there are any stamped sessions in sessions 5 to 9, they will be kept. The team id (HVAC) can be omitted if a current team is set. MERGE CHANGES HVAC/PADD AFTER STAMP / stamp_012 BEFORE STAMP /stamp_016 Merges all the changes to the HVAC/PADD database for sessions that are after the session stamped with stamp_012 and before the session stamped with stamp_016. All changes made in stamped sessions that are between the sessions stamped with stamp_012 and stamp_016 will be combined. If there are any other stamped sessions, they will be kept. The team id (HVAC) can be omitted if a current team is set.
7-92
Command Details
MERGE CHANGES (continued)

MERGE CHANGES /HVAC BEFORE 10:30 31 / 8 / 01 MERGE CHANGES /HVAC BEFORE 10:30 31 AUGUST 2001 Merges all the changes to the HVAC database before 10.30 am on the 31 August 2001. If the time is omitted, 11.59 is assumed. If the month is not given, the current month is assumed. If the year is not given, the current year is assumed. If there are any stamped sessions, they will be kept. MERGE CHANGES PROJECT Merges all the changes to all databases in the project, except stamped sessions. A range of dates may be specified, but not a session number. MERGE CHANGES SYSTEM Merges all the changes to the System database. A date, session number or stamp cannot be specified. In a Global project, you must be administering the System database and be at its primary location. MERGE CHANGES GLOBAL
This command is only available in a Global project, at the Hub. Merges all the changes to the Global database. A date, session number or stamp cannot be specified.
Command Syntax for Standard (Non-Global) project:
>- MERGE CHANGES -+- team -. | | |--------+- db -. | | |- PROJECT -----AFTER ----. | | | | `---------+- <when> -. | | | | -----------+- BEFORE -. | | | | ----------+- <when> -> | |--- SYSTEM ------------------------------------------->|
Note:
<BEFORE/AFTER>
do not apply to the <SYSTEM db>
7-93
Command Details
MERGE CHANGES (continued)

Command Syntax for Global project:
>- MERGE CHANGES -+- team --. | | |---------+- db -. | | |--- PROJECT ----+- AFTER -. | | | | `---------+-- when -. | | | | ---------+- BEFORE -. | | | | ----------+- when -. | | |--- SYSTEM ---------------------------------------------| | | --- GLOBAL ---------------------------------------------+-->
where when can be given in the form of a date or a session number, or, if the required sessions have been stamped, a stamp, as shown in the examples. See Section 7.2, for the full syntax of <when>. Note: All the MERGE CHANGES syntax except MERGE CHANGES GLOBAL can be applied to a remote Location in a Global Project by prefixing the command by REMOTE <loc>, where <loc> is the Location identifier. MERGE CHANGES SYSTEM applies to the currently administered system database. See the REMOTE command for examples. Related Commands: BACKTRACK, REVERT, REMOTE Querying: Q SESSION
7-94
Command Details
MESSAGE
Sends messages to other users. Can be used to send a message, of up to 80 characters, to one of the following: An individual user, specified by name, number or login name Users on a specified workstation 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 next change modules or leave PDMS. Examples: mess team piping the latest pipe routing has been approved Command Syntax: >--- MEssage ----+--- ID text ------| |--- USer userid --| |--- TEam teamid --| |--- HOST ---------| |--- LOGIN --------| ------------------Querying: LIST MESSAGE text ----------. | text ----------| | text ----------| | text ----------| | text ----------| | text ----------+-->
Related Commands: DELETE MESSAGE, REMOTEMESSAGE (Global Projects only)
7-95
Command Details
MODE
Function:

Specifies what happens when DICE finds an error. Note: This command should only be used when running DICE in stand-alone mode (or REMOTE CHECK). For DICE checking within a PDMS project, use the CHECKOPTION command.
Description:
There are two types of DB fault detected by DICE: An error is identified if the DB is corrupted internally. A warning is identified if DICE encounters, for example, a fault with a reference to an external DB.
In BRIEF mode, checking is stopped when the first error is encountered; that is, DICE simply determines whether or not the DB is corrupt. This is the default mode. In FULL mode, DICE continues checking the whole DB or file, listing all errors and warnings, until a prescribed maximum error or warning count is exceeded, when 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 a database has been truncated. The default setting for the maximum error count and maximum warning count is 50, but you can specify different numbers by using the MAXERRORS and MAXWARNINGS commands, respectively. Examples: MODE BRIEF MODE FULL Related Commands: Command Syntax:
>--- MOde ---+--- BRief ---. | | --- FUll ----+--->
MAXERRORS
The default is BRIEF.
7-96
Command Details
MODULE
(Module Definition)
Creates an entry for a module in the System DB. Command includes a variety of options, enabling the parameters of the runfile (the file containing the binary version of the module software) to be specified. The options are specified by the following keywords: OPEN specifies a data file which the module is expecting to have opened for it. MODE specifies the modes (Read, Read/Write etc.) in which the various types of DB comprising the current MDB are to be opened. RESUME specifies the name of the runfile of the module to be used for this project. SECURITY specifies the security rating of the module. BUFFER specifies how much space is to be reserved for the DABACON buffer. The default value is 2560000 but the Administrator may specify a larger or smaller value than this. Note that the buffer size should be at least this value in projects where distributed Extracts are being used. IMACRO specifies the name of an initialisation macro. The above options may be entered in any order, and may be repeated any number of times.
Examples: Module 78 DESIGN Security Free Mode DESI Default Mode PROP R Mode CATA R Mode DESI RW Resume /%PDMSEXE%/des
Command Syntax: >- MODule -+--- integer module_name -. | | --- module_name integer -+- newline <runf> -->
Command Details
where the <runf> keywords are defined as follows:

.--------------------------. / | >--- Open ---*--- ATTLIB filename --------| | | |--- SYMBOLFILE filename ----| | | --- MESSagefile filename ---+---> >--- Mode dbname ---+--| |--| |--| -->--- Resume filename ---> >--- Security ---+--- FRee ---------. | | --- GEneral ------+---> >--- Buffer ---+--- integer -----. | | --- DEFault -----+---> >--- IMACRO name ---> Related Commands: LIST MODULES, DELETE MODULES, EDIT Querying:
.----------------. / | >--- Query MOdule ---*--- integer ------| | | --- module_name --+--->
RW --------. | Read ------| | None ------| | DEFault ---+--->
7-98
Command Details
MOVE
Moves a DB to a different directory. This command may be needed if disk space is a problem. Databases can be stored in a different area, that is, a different directory from the Project directory. The directory must be created before the database is created, and an environment variable set to the pathname of the directory. For example:
xxxnnn
set to
pathname
where xxx is the Project Code, for example, abc, and nnn is a number, for example, 001. When the database is created, the area number of the database must then be set to the corresponding value, in this example, 1.
In a Global Project, this command can only be carried out at the Hub. The area directories must exist at all Locations to which the Database is allocated.
Example: MOVE DB HVAC/HVAC TO AREA 051 Command Syntax:

>--- MOve DB dbname TO AREA integer --->
Related Commands: CNAME, CHANGE, INCLUDE, EXCLUDE
7-99
Command Details
NEW
Function:
(Project definition and Global Project Administration)

Create an ADMIN element. This command is used: In any Project, to create Roles, Scopes, Teams, DB Sets and MDBs. In a Global Project, Roles can only be created at the Hub. Roles, PEROPs and Teams must be created in the
Description:
global database.
At the Hub of a Global project, to create the Global
elements of Locations, Location Groups and Communication Events (LCOMDs).
Examples (any Project): NEW ROLE /SnrPiper Creates a new Role named SnrPiper. NEW PEROP /MaxBore Creates a new Permissible Operation named MaxBore. The current element must be a Role. NEW SCOPE /AREA-A Creates a new Scope named Area-A. NEW DBSET /ASET-A Creates a new DB Set named ASET-A NEW ACR /ACR-A Creates a new ACR named ACR-A NEW ACRST /ACRSET Creates a new DB Set named ACRSET Note: After creating these elements, you will need to set their attributes. See Chapter 4.
7-100
Command Details
NEW (continued)
Command Syntax (any Project):
>--- NEW ---+--| |--| |--| |--| |--| |--| |--| `--ROLE /name ----. | PEROP /name ---| | SCOPE /name ---| | TEAM /name ----| | ACR /name -----| | ACRST /name ---| | MDB /name -----| | DBSET /name ---+--->
Examples (at the Hub of a Global project): NEW LOCATION /CAMBRIDGE Creates a new location named CAMBRIDGE. NEW GRP /AUSTRALIA Creates a Location Group named AUSTRALIA. NEW LCOMD /NORMAL Creates a Communications Event named NORMAL. NEW LCTIMD /EVENTS/NORMAL Creates an Events timing element named EVENTS/NORMAL. Command Syntax (at the Hub of a Global project):
>--- NEW ---+--| |--| |--| `--LOC /name -----| | GRP /name -----| | LCOMD /name ---| | LCTIMD /name --+--->
Related Commands: CREATE
7-101
Command Details
NEW STAMP
Creates a new stamp element. This command allows you to create a stamp to be used to mark database sessions. You can stamp sessions, either by a specific time and date, or by session number. Once you have stamped database sessions, you can use the stamp name in commands where a date or session number can be used, such as BACKTRACK or REVERT. Stamping database sessions makes it easier for you to: make comparisons and identify changes made from session to session for example, you can issue drawings on which all revisions that have been made since an earlier stamped session are highlighted merge database sessions backtrack a standard database to a previous session revert an extract database to a previous session
In a Global project, stamps must be created at the Hub

Example: NEW STAMP /Stamp_007 Creates a new stamp named Stamp_007. NEW STLST STLSF /*PIPEDB STSESS 7 Creates a new Stamp List for each DB in the stamp (here, PIPEDB), for session number 7. The Stamp List holds a reference to the DB and the session number. Any number of STLST elements can be created (or deleted). The default value of STSESS is the current session for the DB. Command Syntax:
.--------<---------. / | >-- NEW --+-- STLST --*-- STLSF /*dbname -'--+-- STSESS dbname ---. | | | | | | | -- STAMP /stampname ------------------------------------+--->
7-102
Command Details
NEW STAMP (continued)

Related Commands: BACKTRACK, MERGE CHANGES, REVERT Querying:
>--- Query attribute --->
where the current element is a stamp.
7-103
Command Details
PING
Function:

Checks that the communications link to named Location exists. A round-trip time will be displayed.
Description: Example:
PING LON Checks that communications link to Location LON exists. Command Syntax:
>- PING <loc> --->
Related Commands: Q COMMS
7-104
Command Details
PREVOWNER
Function:
Restores the Hub to its previous Location, or restores the previous Primary Location of a database, if the commands to change these attributes have failed. CAUTION: This command should not be used, except under special circumstances (see below).
Description:
If a CHANGE PRIMARY command on a Database fails, the Database will be left with no Primary Location. However, the original Primary Location will be recorded, and this command is used to restore the original Primary Location. Similarly, if a HUBLOCATION command fails, and the Project is left with no Hub, this command will restore the previous Hub Location. If a SYSTEMLOCATION command fails, the PREVOWNER SYSTEM command will restore the previous System database Location. These three commands have built-in recovery operations to restore the previous primary location if they fail. The PREVOWNER command is provided to enable the previous location to be recovered in the following circumstances: If the daemon is down For offline locations To recover a failed change primary on the locations own transaction database If the CREATE EXTRACT command fails before it has reached its Allocate Primary command. Note: PREVOWNER is not usually needed after a failure of this command since it contains an in-built recovery operation. However, the automatic recovery operation does not cover the CREATE command Allocate operation and PREVOWNER may be needed in the unlikely event of this failing.
In all other circumstances it is better to await the completion of the in-built recovery operation, since this prevents incompatible changes being made by two competing users at different locations. Note: This command cannot be used to reverse a successful CHANGE PRIMARY, HUBLOCATION or SYSTEMLOCATION command.
7-105
Command Details
PREVOWNER (continued)
Examples: PREVOWNER HUB PREVOWNER dbname PREVOWNER SYSTEM AT <loc> Command Syntax:
>--- PREVOwner ---+--- HUB ---------------. | | |--- SYSTEM AT <loc> ---| | | `--- dbname ------------+--->
Related Commands: Querying:
HUBLOCATION, SYSTEMLOCATION, CHANGE PRIMARY >--- Query PRVRF ---> This query must be used at the appropriate element. For CHANGE PRIMARY, this is DBLOC 1 of <dbname>; for SYSTEMLOCATION, this is <loc>; for HUBLOCATION, this is /*GL. >--- Query NXTHB ---> If a problem occurs with the HUBLOCATION command, you can use this query at /*GL to query NXTHB. NXTHB is used to record the future new Hub until the HUBLOCATION command has completed.
7-106
Command Details
PROJECT
Function:
Adds descriptive information to project definitions. Also used to set Multibyte characters sets for fonts such as Kanji. You can, optionally, specify a second (bold) user-defined font file for multibyte fonts.
In a Global Project, the Name, Description, Number and MBCHARSET can only be set at the Hub. The Message can be set at all Locations.
Description: The descriptive information will be displayed each time the project is entered. The attributes which can be set, with their maximum number of characters, are: NAME DESCRIPTION MESSAGE NUMBER 119 characters 119 characters 119 characters 16 characters
If you require information about multibyte character sets, please contact your local AVEVA Solutions Support Office, as listed on the copyright page of this manual. Examples: PROJ NAME STABILIZER PROJ DESCRIPTION CADC TRAINING PROJECT PROJ MBCHAR JAPANESE PROJ MBCHAR 87
(where 87 is the ISO Standard Font number).
PROJ MBCHAR LATIN FILE /lat_std BOLD /lat_bld PROJ CHARSET LATIN 2
7-107
Command Details
PROJECT (continued)
Command Syntax:
>- PROJect -+-- NUMber text ------------------------------------------------. | | |-- NAMe text --------------------------------------------------| | | |-- DEScription text -------------------------------------------| | | |-- MESsage text -----------------------------------------------| | | |- MBCHARset -+- integer --. | | | | | | |- JAPanese -| | | | | | | |- CHInese --| | | | | | | |- LATIN ----+- FILE -+- name -+- BOLD name -. | | | | | | | | | | | | -------------| | | | | - DEFAULT ------------| | | | -------------------------------| | | | | | | | .-------<------' | | | | | | -+- KORean ---. | | | | | | | | - TCHINese -+--FILE name --+- ANGLE integer ---| | | | | -------------------+-> - CHARset -+- IR integer ---------. | | - LATIN -+- integer --| | | |- CYRIllic -| | | ------------+->
Querying:
>--- Q PROject --+-| |-| |-| |-| |-| |-| -NUMber -------. | NAMe ---------| | DEScription --| | MESsage ------| | CODe ---------| | MBCHARset ----| | CHARset ------+-->
7-108
Command Details
PURGE
Function:
(Project Administration and Global Project Administration)

In a Global Project, removes old database files and picture files after propagation or transfer to an offline Location. Also removes old picture files from any Project.
When updated database files and picture files are propagate or transferred, the existing versions will be retained if Users are accessing them. The files will have the suffix .admold. The main use of this command is to remove the old versions of these files. The PURGE DB option removes old versions of picture files from a given Database in any Project.
Description:
Examples: PURGE OLD FILES Deletes all files in the Project with the suffix .admold. PURGE OLD FILES DB Deletes all database files in the Project with the suffix .admold. PURGE OLD FILES PICTURE Deletes all picture files in the Project with the suffix .admold. Command Syntax:
>--- PURGE ---+--- OLDfiles ---+----------------. | | | | |--- DB ---------| | | | | `--- PICture ----| | | `--- DB dbname -------------------+--->
Related Commands: TRANSFER
7-109
Command Details
QUERY
Function:
(Querying)
Used to output a wide variety of information. In general, querying options are documented with the commands which they relate to. Some options which do not fit into this category are listed here. Note that general PDMS commands for querying elements and attributes are also available.
Examples: Q COPIES PIPING/AREA-A List the copies of DB PIPING/AREA-A Q SET MDB Q SET TEAM Q SET DBSET Query the set (i.e. current) Team, MDB or DB Set Q MOD DESIGN DRAFT 33 Query module entries for DESIGN, DRAFT and module 33 Q DDL Gives version number of System DDL (Design Data Language) Q CLAIM SAMPLE/DESI Outputs information about claimed databases Q NEWREF old-ref Gives the new reference corresponding to the given old reference Q SESSION LAST Outputs the date, user, and any comments saved with the given session Q SESSIONS ON date dbname Q SESSIONS SINCE n dbname Q SESSIONS LAST n dbname Query session information on a specified database Q SESSIONS SINCE n Q SESSIONS LAST n Q SESSIONS ON date Query session information on the current database (i.e. System or Global database) Q ACTIVE Gives the active session number
7-110
Command Details
QUERY (continued)
Q NACCNT At a DB element, gives the non-additive changes count. This value increases when a database is merged, backtracked or reconfigured. This attribute will return the value for the system database if used at STAT /*S, or in a Global project, for the global database if used at GSTAT /*GS. Q HCCNTAt a DB element, gives the extract list changes count. This value increases when extracts are inserted or removed. Note: The superseded ELCCNT pseudo-attribute is retained as a synonym for HCCNT. HCCNT is available at /*S and /*GS elements as well as at DB elements. Q CLCCNT At a DB element, gives the claim list changes count. This value increases when elements are claimed or dropped without other changes to the database.
Note: In a Global project, the above three attributes together with session information can be used to compare the state of the database at different locations. For information about this, see Running Global Projects with VANTAGE PDMS.
Querying extracts
Q DBNAME Gives the name of the database you are actually writing to. Q CLAIMLIST Gives a list of user claims in your current database. Q CLAIMLIST EXTRACT Tells you what you can flush. Q CLAIMLIST OTHERS Tells you what you can't claim, including user claims and extract claims.
The following options are only available in a Global Project:

Q ADMLOC Returns the currently administered location, which may be different from the true current location. Q COMMS TO LON Query state of comms link to location LON. (Equivalent to PING) Q COMMS LON INPUTPACKETS Q COMMS LON OUTPUTPACKETS Query data from comms link to location LON: Input or Output Packets.
Command Details
QUERY (continued)
Q COMMS LON INPUTRequests Q COMMS LON OUTPUTRequests Query data from comms link to named location: Input or Output Requests. Q COMMS TO LON PATH Query Comms routing to location LON. Q CURLOC Returns the true current location. This command is useful when you are remotely administering another location: it returns the name of the actual location where you are working. Q ISOLAT AT LON Returns TRUE if the location LON is isolated. Q LOCK AT LON Returns the lock at location LON. The following options are only available in a Global Project at the Hub. The daemons must be running. Q READERS HVAC/HVAC AT CAM Outputs a list of readers of database HVAC/HVAC at Location CAM. Q READERS HVAC/HVAC AT CAM COUNT Outputs a count of readers of database HVAC/HVAC at Location CAM. Q WRITERS HVAC/HVAC AT CAM Outputs a list of writers to database HVAC/HVAC at Location CAM. Q WRITERS HVAC/HVAC AT CAM COUNT Outputs a count of writers to database HVAC/HVAC at Location CAM.
7-112
Command Details
QUERY (continued)
Command Syntax:
>- Q --+--| |--| |--| |--| |--| |--| | | |--| | | |--| |--| |--| | | | | |--| |--| | | | | |--| |--| |--| |--| |--| --USer ----. | TEam ----+--- word -----------------------. | DB -------. | | | COpies ---+--- dbname --------------------| | DBNO dbno --------------------------------| | MDB name ---------------------------------| | .-------<-----. | / | | MOdule ---*--- integer ---| | | | | --- word ------+---------------| | LOck -------------------------------------| | DDL --------------------------------------| | SET ---+--- TEam -------------------------| | | |--- DBSet ------------------------| | | --- MDB --------------------------| | PROject ----------------------------------| | SESSIONS --+-- SINCE --. | | | | |-- LAST ---+- n --+-----------| | | | - ON <date> -----+-dbname ---| | CLAIM dbname -----------------------------| | NEWREF oldref ----------------------------| | MAXUSers ---------------------------------| | ACTIVE -----------------------------------| | MACRO n ----------------------------------| | INFOrmation --+--- dbname ----------------| | | --- SYSTEM ----------------+--->
7-113
Command Details
QUERY (continued)
The following options are only available in a Global Project.
>--- Q COMMS ---+--- TO ---. | | `----------+--- <loc> ---+--- INPUTPackets ----. | | |--- OUTPUTPackets ---| | | |--- INPUTRequests ---| | | |--- OUTPUTRequest ---| | | |--- PATH ------------| | | `---------------------+--> >--- Q ADMLOC ---> >--- Q CURLOC ---> >--- Q ISOLAT AT <loc> ---> >--- Q LOCK AT <loc> ---> >--- Q --+-- READERS --. | | `-- WRITERS --+- <dbname> --. | | `-------------+--- AT <loc> --. | | `---------------+-- COUNT --. | | `-----------+-->
Related Commands: LIST
7-114
Command Details
RCFCOPY
(Reconfiguration)
Defines the part of the database to be copied from the source DB to the destination DB before reconfiguration. Must be given just before a RECONFIGURE command. Only elements that can exist at the level immediately below World can be specified. You must use RCFCOPY ALL if you intend to use the RECONFIGURE SESSIONS command afterwards, as the SESSIONS option is not valid if you carry out partial reconfiguration.
Examples: RCFCOPY ALL Copies all of the elements in the list part of WORLD in the source DB into the list part of WORLD in the destination DB RCFCOPY CATA Copies the first root elements of type CATA to be copied from the list part of the WORLD in the source DB. RCFCOPY SPEC Copies the first root elements of type SPWL to be copied from the list part of the WORLD in the source DB. RCFCOPY /SITE5A /SITE7 Copies just the named elements. RCFCOPY <SITEA> INTO <SITEB> ALLCONNECTIONS Sets all references, including those in the original database that are not in the list of copied elements.
7-115
Command Details
Command Syntax:
/ >- RCFCopy ---*| || || || `.-------------<-----------------. | ALL ------------. | | | CATalogue ------| | | | SPECifications -| | | | name -----------| | | | refno ----------+--- AND ------| | | |--- comma --- | `--- INto -+- name --+-ALLCONnections -. | | | - refno -+-----------------+->
Querying:
Q COPIES
Related Commands: FROM, TO, RECONFIG
7-116
Command Details
RCFUPDATE
Function:
(Reconfiguration)
Updates reference pointers into reconfigured databases.
In a Global Project, this command can only be given at the Hub.

Description: Uses index of element reference numbers in source database against reference numbers in destination database. The RCFUPDATE command must be given immediately following a RECONFIGURE operation, or after a LOAD command.
Examples: RCFUPDATE DB MASTER/DESIGN Updates references to the reconfigured DB from DB MASTER/DESIGN. RCFUPDATE DB MASTER/DESIGN INTERNAL Updates references in DB MASTER/DESIGN for any elements that have been copied with RCFCOPY. Use this option with care because it is possible to update a reference that has already been changed by the RECONFIGURE command. RCFUPDATE MDB /USERA Updates references to the reconfigured DB from all appropriate DBs in MDB /USERA RCFUPDATE TEAM STEEL Updates references to the reconfigured DB from all appropriate DBs owned by team STEEL. RCFUPDATE ALL Updates references to the reconfigured DB from all databases in current project. Command Syntax:
>--- RCFUPdate ---+--- DB dbname -+--------------. | `-- INTERNAL --| | | |--- MDB mdbname --------------| | ---------| |--- TEam teamname ------------| | | |--- ALL ----------------------| | | ------------------------------+-->
Related Commands: RECONFIGURE
7-117
Command Details
RCFUPGRADE
Function:
(Reconfiguration)
This command is used when an upgrade to a new version of PDMS is required. Note: This command is normally handled automatically by the upgrade macros supplied with a new version of PDMS. You are advised to consult your AVEVA Solutions Support Office before using it.
Command Syntax:
>-- RCFUPGRADE --+-- ON ----. | | -- OFF ---+-->
7-118
Command Details
RECONFIGURE
Function:
(Reconfiguration)
Starts a reconfiguration operation. You can specify that the reference numbers stay the same in the reconfigured database. You can specify that session information such as the original session comment, session number, username and original date stays the same in the reconfigured database. You can specify that the reference numbers stay the same in the reconfigured database. The SAMEREF option will fail if: The database specified in the TO DB command has a different DB number from the database given in the FROM DB command. An element already exists with the same reference number.
Description:
You can specify that session information stays the same in the reconfigured database by using the SESSIONS option: The option is not valid for SYSTEM, or GLOBAL DBs. The option is not available if you are doing a partial reconfiguration. You must use the RCFCOPY ALL command with RECONFIG SESSIONS. For extracts, RECONFIG SESSIONS will be assumed, even if the option is not given. For Draft DBs, the picture files will be ignored. The reconfigured data must go TO a file. After reconfiguration, data can be read back in from the file, replacing the original DB data. The SAMEREF option is assumed when reading the data. When reading in data created by RECONFIG SESSIONS, the DB number and extract number must be the same as the originating DB number and extract number. If errors occur when reading in data created by RECONFIG SESSIONS, the data is not saved unless you use the RECONFIG FORCE option.
The normal procedure for reconfiguring a database and maintaining the reference numbers is as follows: 1. Reconfigure from the target database to a file. 2. Delete the target database, and create a new one with the same DB number.
7-119
Command Details
RECONFIGURE (continued)
3. Reconfigure from the file to the new database. For Global projects, note the following: To reconfigure the Global Database in a Global Project, give the command FROM GLOBAL followed by RECONFIGURE. For more information, see Chapter 3, Reconfiguration. In a Global Project, the TO NEW option is only valid at the Hub (see the TO command). To reconfigure a satellite transaction database, reconfigure the DB to file, renew the file to empty it (see the RENEW command), stop the daemon at the satellite, and then reconfigure the transaction database from file. For information about reconfiguring a transaction database, see Running Global Projects with VANTAGE PDMS. If the TO database is allocated to other locations, the Recover command should be used to copy the database to all secondary locations.
Examples: RECONFIGURE Command Syntax:

>--- RECONfigure ---+---- FORCE ----. | | |--- SESSIONS --| | | `--- SAMEREF ---+--->
Related Commands:
FROM, TO, RCFCOPY, RENEW (Global project only)
7-120
Command Details
RECOVER

Recovers data when a database has been corrupted. This command can be used on both Primary and Secondary databases, but for Primary databases it may be better to restore the database from the latest backup copy, because the copies at other Locations may not be up-to-date. For a Primary database, by default recovery will be made from the most recent session at a neighbouring (parent/child) Database. For a Secondary database, by default recovery will be made from the neighbouring database which is first on the route to the Primary database. Both Locations must be on-line. Notes: The Global database cannot be recovered using the daemon. If the System database for a location is corrupt, it cannot be recovered using the daemon, since the daemon needs to use the system database to understand the network. The System Administrator must copy this database to the required locations outside PDMS. When Reconfiguring or Renewing a database, you should then recover the database at all its secondary locations in order to prevent reverse propagation.
7-121
Command Details
RECOVER (continued)
Examples: The examples are based on the following configuration: This is the Hub
AAA
BBB EEE
You are here STEELN/STEEL
CCC
You are administering DDD from CCC
N is Primary at EEE
PIPEN/PIPEN is Primary at CCC
DDD
Secondary constructor DBs RECOVER PIPEN/PIPEN Recovers from BBB or DDD, whichever is the most recent. RECOVER STEELN/STEELN Recovers from BBB, that is the next DB on the route to the Primary Location RECOVER STEELN/STEELN FROM DDD Recovers from DDD. Remote recovery of secondary constructor DBs (available from the Hub or the administering location of the satellite) RECOVER STEELN/STEELN AT DDD Recovers from CCC, the only neighbouring Location in this case. If there was a child of DDD, the recovery would be from the most recent copy. RECOVER STEELN/STEELN AT DDD FROM BBB Recovers DB at DDD from BBB
7-122
Command Details
RECOVER (continued)
System DBs RECOVER SYSTEM FOR EEE FROM BBB Recovers System database for EEE from the copy at BBB. RECOVER SYSTEM FROM BBB Recovers System database for the true current location from BBB. Remote recovery of System DBs (available at the Hub or the administering location of the satellite) RECOVER SYSTEM FOR EEE AT AAA FROM BBB Recovers AAA's copy of the System database for EEE from the copy at BBB. Command Syntax:
>--- RECOVer -+-- SYSTEM --+-- FOR <loc> --. | | | | `---------------| | | `-- dbname ------------------+-- AT <loc> --. | | `--------------+-- FROM <loc> --. | | `----------------+--->
7-123
Command Details
REINIT
(Reconfiguration)
Re-initialises the reference number index. Re-initialises the reference number index in database reconfiguration.
Command Syntax:
>--- REinit --->
Related Commands: DUMP, LOAD
7-124
Command Details
REMOTE
Function:

Allows the Hub or the Administering Location of a Satellite to carry out the following tasks for constructor or system databases at a Satellite: BACKTRACK REVERT MERGE CHANGES EXPUNGE CHECK Other than when the REMOTE . . . CHECK command is used, the databases must be primary at the destination Satellite. The REMOTE . . . BACKTRACK, REVERT, MERGE CHANGES and EXPUNGE commands can be given at the Hub, the Satellite itself or the administering location. The Satellite itself may need to use the REMOTE version of the command, because it may not have write access to the system database. The administering Location may need to use the REMOTE version of the command, because it may not have write access to the constructor database. The REMOTE . . . CHECK command can be given at any location. Note: The difference between the REMOTE options, and centralised administration of a satellite, are that REMOTE commands are executed by the Global Daemon, rather than by PDMS. All daemon commands take time to complete, and generally you will need to wait for this to happen.
The REMOTE commands (other than CHECK) can only be applied to databases which do not own extracts and to leaf extracts. REMOTE . . . BACKTRACK, MERGE CHANGES and EXPUNGE commands will not take effect while there are users (or potential users, for example, in MONITOR) in the project. REMOTE . . . BACKTRACK will do nothing if the primary location of the database contains later sessions than the secondary database at the issuing location. It will not backtrack through stamped sessions. The database must be allocated at the issuing location in order to determine the latest session there.
7-125
Command Details
REMOTE (continued)
If the primary database at the satellite contains later sessions than the secondary database at the Location issuing the command, the REMOTE . . . MERGE CHANGES command will not merge the later sessions. (If the database is nonpropagating, later sessions will be merged). REMOTEMERGE will not remove Stamped sessions. Unless the database is non-propagating, it must be allocated at the issuing location in order to determine the latest session there. REMOTE MERGE also merges the database at secondary locations after it has been merged at the primary location in order to prevent unnecessary copying of the entire database when it is next updated. This means that the command may take some time to complete. You are advised to stop scheduled updates and avoid adhoc updates until the entire REMOTEMERGE command has completed. If scheduled updates are left in place, then unnecessary copying of entire databases will be undertaken, and changes made by users at the primary location may be lost. The REMOTE . . . CHECK command can be given at any location on any database. Both Primary and Secondary databases can be checked. This command runs stand-alone DICE on the specified database from the daemon at the specified location and reports back to the location that issued the command. You can also query information about the project status at a Satellite. See Querying below. REMOTEEXPUNGE cannot distinguish between genuine and dead users of a database at a location. The system administrator should use remote session information (see Querying below) to check which users are actually writing to the database. REMOTEMERGE and REMOTEBACKTRACK are not valid for extracts which own other extracts. However, REMOTEREVERT and REMOTEEXPUNGE can be used. A database that owns extracts can be merged in PDMS using the MERGE command.
7-126
Command Details
REMOTE (continued)
Examples: For details of time and date syntax, see Section 7.2. BACKTRACK REMOTE <loc> BACKTRACK dbname TO 14:30 REMOTE <loc> BACKTRACK dbname TO SESS 17 Backtracks changes to the given database, which must be Primary at the named location. A database cannot be backtracked through a stamp. REVERT REMOTE <loc> REVERT dbname TO 14:30 REMOTE <loc> REVERT dbname TO SESS 17 Adds a session reverting to the data at the specified session or date. The database must be Primary at the named location. MERGE CHANGES REMOTE <loc> MERGE CHANGES dbname BEFORE 31 MARCH REMOTE <loc> MERGE CHANGES dbname BEFORE SESSION 9 AFTER SESSION 4 Merges changes to the given database, which must be Primary at the named location. Stamped sessions will not be removed by the merge. REMOTE <loc> MERGE CHANGES SYSTEM Merges changes to the system database for the location <loc>. REMOTE <loc> MERGE CHANGES SYSTEM FOR <loc2> Merges changes to the system database for <loc2>, which must be administered by <loc>. EXPUNGE REMOTE <loc> EXPUNGE REMOTE <loc> EXPUNGE username Expunges all users or the given user from the communications database at the given Location. username is the PDMS username. REMOTE <loc> EXPUNGE DB dbname REMOTE <loc> EXPUNGE DB dbname USER username REMOTE <loc> EXPUNGE DB SYSTEM REMOTE <loc> EXPUNGE DB SYSTEM FOR <loc2> Expunges all users or the given user from the given database at the given Location. The database must be primary at the given Location. Username can be the PDMS username or a session number.
7-127
Command Details
REMOTE (continued)
DICE Checking REMOTE <loc> CHECK SYSTEM REMOTE <loc> CHECK DB dbname REMOTE <loc> CHECK MISCDB dbname REMOTE <loc> CHECK COMMDB REMOTE <loc> CHECK SYSTEMDB FOR <loc2> Performs a standalone DICE check on the given database at the given Location. The database does not need to be primary at the given Location. The check uses the current MODE, STATISTICS, MAXERRORS and MAXWARNINGS settings. Cancelling commands REMOTE <loc> CANCEL <gid> Allows an Admin user to cancel a command at another Location <loc>, where <gid> is a TRINCO in the transaction database for the given Location (this is not the current Location, unless <loc> is the current Location). This command requires an up-to-date version of the transaction database for Location <loc> to be available at the current Location. (The transaction database is not normally propagated. It is best to RECOVER this database from the primary location rather than to SYNCHRONISE it.) Command Syntax: For details of <loc> and <when> syntax, see Section 7.2.
>- REMOTE <loc> BACKTRACK dbname TO <when> -->
>- REMOTE <loc> REVERT dbname TO <when> -->
>- REMOTE <loc> MERGE CHANGES -+- dbname ----------------+-<when>--> | `- SYSTEM -+- FOR <loc2> -+--> | | `--------------+-->
7-128
Command Details
REMOTE (continued)
>- REMOTE <loc> EXPUNGE -+- USER username ----------------------. | | |--------------------------------------| | | `- DB --+- dbname -+-- USER username --| | | | | `-------------------| | | `- SYSTEM -+-- FOR <loc2> -----| | | `-------------------+-->
>- REMOTE <loc> CHECK --+-| |-| |-| |-| | | `--
DB dbname ------------------------. | MISCDB --------------------------| | COMMDB --------------------------| | SYSTEMDB dbname -+- FOR <loc2> ---. | | `----------------| | GLOBALDB -------------------------+-->
Related Commands:
CANCELCOMMAND, REMOTEMESSAGE, MERGE, REVERT, BACKTRACK, EXPUNGE, CHECK
7-129
Command Details
REMOTE (continued)
Querying: Remote database session information can only be queried by looking at the secondary database at the current location, which may not be up-to-date. Information about remote users of PDMS may be queried using remote session objects. For example !p = current project !l = !p.locations() !r = !l[2].sessions()
Returns a PROJECT object Returns an array of LOCATION objects Where !l[2] is not the current location, returns an array of SESSION objects Returns data about a given session
q var !r[1] q var !r[1].module() q var !r[1].user() q var !r[1].mdb().
This may be combined with information about the satellite MDBs to identify users of a database when using REMOTEEXPUNGE. For more information about PML Objects see the Plant Design Software Customisation Reference Manual. Only these three session methods are available for remote sessions.
7-130
Command Details
REMOTEMESSAGE
Function: Examples:
Sends messages to users at other Locations.
REMOTEMessage <loc> ALL text Send message to all users at named location REMOTEMessage <loc> TEAM teamid text Send message to all members of a team at named location REMOTEMessage <loc> FREEUSER text Send message to administrator at a named location Command Syntax:
>--- REMOTEMessage <loc> ---+--- ALL -----------. | | |--- FREEuser --------| | | `--- TEam teamid -----+--- text --->
Related Commands: MESSAGE, LIST MESSAGE Querying: >--- Query DBALL --->
7-131
Command Details
REMOVE
Function: Examples:
Removes the specified DB from the MDB.
REMOVE SERV/AREA-D Command Syntax:

.------------. / | >-- REMove dbname ---*--- dbname --- | -------------------->
Related Commands: ADD, REMOVE, CURRENT, DEFER
7-132
Command Details
RENEW

Deletes a transaction database and creates a fresh version. If a transaction database becomes corrupt, it may be necessary to delete it and then re-create it. Existing commands in the database may be retained by Reconfiguring to file before the Renew and from file after the Renew. This daemon command is available with two options, namely DELETE and AT. It deletes an existing transaction database file at a Location and creates a fresh version. The RENEW DELETE <DB> command is the preferred method of re-creating the transaction database file, as it works even when the database is too corrupt for the daemon to run. Note that <DB> must be the transaction database for the current location, as the command cannot be executed remotely. When this command is used, ADMIN checks that all users have left PDMS and that the daemon has been shut down. Note that the check on the daemon takes up to 3 minutes. ADMIN then deletes the file for the transaction database (not its DB entry) and prompts the user to leave PDMS and restart the daemon. When the daemon is restarted, it will automatically recreate the transaction database file. The RENEW <DB> AT <loc> command may be used to renew a transaction database remotely. Note that this command may fail, if the database corruption is severe and the daemon at <loc> cannot be started. All users must be out of PDMS for the command to run. Alternatively, you may renew the transaction database by stopping the daemon and deleting its file outside PDMS (not its DB definition). The daemon will automatically create a new transaction database file when it is restarted. It is recommended that, after renewing, the System Administrator should recover the transaction database at all secondary locations. This will prevent reverse propagation. For further information about reconfiguring or renewing a transaction database, see Running Global Projects with VANTAGE PDMS. The RENEW command is not recorded in the transaction database.
7-133
Command Details
RENEW (continued)
Examples: RENEW DELETE <db> Renews the transaction DB at the current location RENEW TRANSACTION/LON AT LON Renews the transaction DB for London at location London Command Syntax:
>--- RENEW ---+-- DELETE ----- dbname -----. | | `-- dbname --- AT <loc> -----+--- >
Related Commands: RECONFIGURE, RECOVER
7-134
Command Details
REORDER
Function:

Reorders the members list of an element.
In a Global Project, this command is particularly useful for Databases, as the list order at a location determines the order in which Databases are propagated. For example, a Catalogue database should be propagated before any Design Databases which reference it.
Examples: REORDER 2 BEFORE 1 Command Syntax:
>-- REORDer element_id ---+--- BEFore ---. | | --- AFTer ----+--- list_position --->
7-135
Command Details
REPAIR
Function:

Repairs the System database, to remove deleted global elements and de-allocated databases. In a Global Project, this command may be used to Repair or Check Repair needed to the System database. There are four main commands:Q REPAIRrequired Returns an integer indicating the number of illegal entries in the System database. REPAIR outputs a report and Repairs the database. REPAIR NOCHECK Repairs the database without a report. REPAIR CHECKONLY Outputs a report without Repairing the database. The latter is useful when using ADMIN in READONLY mode, as at a satellite with a secondary system database.
Examples: Q REPAIRREQUIRED REPAIR REPAIR CHECKONLY REPAIR NOCHECK
Command Syntax:
>-- REPAIR ---+-----------------. | | +--- NOcheck -----+ | | ----CHECKonly----+----->
7-136
Command Details
REPLICATE
Saves the project in a file so it can be replicated. This command can be used: To replicate the complete Project, including all data (except the ISO subdirectories), to a new project. You use the REPLICATE command to do this. To replicate the structure of a standard (non-global) project to file. You use the REPLICATE SYSTEM command to do this. To replicate the structure of a global project to file: Use REPLICATE SYSTEM to replicate the structure of the project at the current location. Use REPLICATE SYSTEM STANDALONE to replicate the project as a standard project, omitting references to Locations and communications. Use REPLICATE SYSTEM SATELLITE at a Satellite in a global project to replicate the project as represented in the local System database. That is, the local information about Users, MDBs and Communication Events will be stored, but not the elements which can only be created and deleted at the Hub.
The file created by REPLICATE SYSTEM can be run as a macro in ADMIN. The REPLICATE SYSTEM command causes ADMIN to scan the System database (and Global database) and output to the named file all the commands necessary to recreate the project structure.
In a Global project, the file created contains macros that should be run in two stages:
The first stage creates the basic project structure and generates the satellite locations. The macro then terminates. You should then edit the remainder of the file into a new file to be run as a separate macro, which should not be run until satellites have been created and initialised. The second stage allocates databases to satellites and makes the relevant databases primary at satellites.
7-137
Command Details
REPLICATE (continued)
Before you run the macro to recreate the project structure, you must create the new project-related directories. In a Global project, this must include transfer directories for each satellite (for more details, see the TRANSFER command). Note: It is strongly recommended that this is only done in a newly created project, otherwise results could be unpredictable.
Examples: REPLICATE XYZ Copies all data from the current project directories into directories for a project named XYZ. In a Global project, a new UUID value for the Project is set (stored in ADUUID of /*GL; this is because each project requires a unique value of this attribute. This is used by Global daemons to distinguish between projects at the same location). Notes: A new UUID value may be queried at /*GL using Q NEWUID. The administrator may use this value to set ADUUID manually if a Global project has been copied externally to PDMS. If ADUUID is left unchanged, there may be data corruption since daemons may send data to the wrong project. The ADUUID attribute is essential to distinguish between Global projects. Each project should have a unique value of ADUUID. This value is what the Global daemon uses to select the correct project. For example if the user copies a project using the file system, rather than by using the REPLICATE command, then the ADUUID attribute in both projects will be the same, and this may cause commands from one Global project to be received by the wrong Global project. It is therefore essential that the PDMS Administrator resets the ADUUID attribute of the project. The NEWUID attribute provides a way to get a new value, since it makes a 'uuidgen' query. The Administrator can then use the result of the NEWUID attribute query to set the ADUUID attribute. Note that NEWUID is not an attribute of the database. It is a pseudoattribute provided for the purpose of generating a new uid value for ADUUID.
7-138
Command Details
REPLICATE SYSTEM filename Generate macro to replicate the project structure. If the current project is Global, the macro will include Location and Communication details. REPLICATE SYSTEM /filename FILENUMBERS Generate macro in a file /filename to replicate the complete data in the current project, maintaining the same file numbers. REPLICATE SYSTEM /filename OVERWRITE Generate macro to replicate the complete data in the current project. The data will be saved in the named file. If the file exists, it will be overwritten. REPLICATE SYSTEM STANDalone filename Generate macro to replicate the project setup for a stand-alone (nonGlobal) project. This omits all references to Locations and Communication elements. REPLICATE SYSTEM SATELLite filename Generate macro to replicate the project setup for a satellite of a Global project. Outputs the commands for building the System database only, not the Global database, that is, Teams, DBs and Locations are omitted. Command Syntax for a Standard (non-global) project:
>-- REPLICATE -+- code ----------------------------. | | `- SYSTEM filename -+- FILENumbers -| | | `---------------+- OVERwrite -. | | -------------+-->
Command Syntax for a Global project:

>- REPLICATE -+- code -----------------------------------------------. | | `- SYSTEM -+- STANDalone -. | | | | |- SATELLite --+----------------------------| | | | `--------------+- filename -+- FILENumbers -| | | `---------------+- OVERwrite --. | | --------------+-->
The FILENumbers option maintains the same file numbers. The OVERWRITE option overwrites an existing file of the same name.
7-139
Command Details
RESETXREFS
Function:
(Reconfiguration)
Controls a partial update of references following a multi-database reconfiguration. Note: This command is normally handled automatically by the upgrade macros supplied with a new version of PDMS. You are advised to consult your AVEVA Solutions Support Engineer before using it.
Description:
Updates the cross-references listed in a file created by the XREF command. Can be used when upgrading a project from one version of PDMS to the next.
Examples: RESETXREFS WITH /REFFILE RESOLVE DB MASTER/DESNEW where /REFFILE is the name of the file generated by the XREF command and MASTER/DESNEW is the corresponding DB to be updated. Command Syntax:
>-- RESETxrefs --+-- WIth --. | | ----------+-- name --*-- RESOLve --+-- DB --. | | | | --------+-- dbname --. | | -- END ----------------------------+-->
Related Commands: XREF, LOAD, RCFUPDATE DB
7-140
Command Details
REVERT
Allows you to restore a database to a previous session. This command is similar to the BACKTRACK command. Sessions are defined as the work done between SAVEWORK commands. You can revert to the date or session number required, or, if the required session has been stamped, you can revert to the stamp. The current state of the database will be lost. Any elements which are claimed out to users or extracts must exist in the backtracked session. This command has a different effect from BACKTRACK. Instead of truncating the database, a new session is added that is a copy of the required session. This means that unlike BACKTRACK, REVERT can always be reversed.
Examples: REVERT PIPE/PIPE to 10:30 Reverts database to the session current at 10:30. REVERT PIPE/PIPE to 31 MAY Reverts database to the session current on 31st May. REVERT PIPE/PIPE to SESS 10 Reverts database to the session 10. REVERT PIPE/PIPE to STAMP /stamp_012 Reverts database PIPE/PIPE to the session that has the stamp /stamp_012. Command Syntax:
>-- REVERT dbname to <when> --->
Related Commands:
BACKTRACK, MERGE CHANGES, REMOTE REVERT (Global project only)
7-141
Command Details
SAVEWORK

Updates the System database. Some commands automatically do a SAVEWORK command. These are: REPLICATE project MERGE CHANGES SYSTEM On Global projects: ALLOCATE DEALLOCATE HUBLOCATION CHANGE PRIMARY PREVOWNER HUB SYSTEMLOC GENERATE LOCATION ADMINISTER CREATE EXTRACT CREATE WORKING EXTRACT MERGE CHANGES GLOBAL
Command Syntax:
>--- SAVEWORK --->
Related Commands: GETWORK, FINISH
7-142
Command Details
SET
(Project definition and Global Project Administration)

Sets the current administrative element. Set the specified MDB, DB Set or Team as the current one for the addition or removal of DBs or users, respectively. Once a team has been set, DBs owned by that team can be referred to by using the database part of the name only. ADD, DEFER, REMOVE, CURRENT and EXCHANGE require an MDB to be set. Databases can only be added to a DB set once the DB Set has been specified.
Examples: SET MDB /RAB Sets current MDB as RAB. SET DBSET /ASET Sets current DB Set as ASET. SET TEAM PIPING Sets current team as PIPING. Abbreviated references to the DBs /AREA-A, /AREA-B etc. will automatically be taken as references to the actual DBs PIPING/AREA-A, PIPING/AREA-B etc. Command Syntax:
>--- SET ----+--- MDB name ------. | | |--- DBSET name ----| | | `--- TEAm name -----+--->
Querying:
>--- Query SET --+--- MDB ----. | | |--- DBSET --| | | `--- TEAM ---+--->
Related Commands: CREATE, ADD, DADD
7-143
Command Details
STATISTICS
Function:

Produces a summary of information about the database being checked. Note: This command should only be used when running DICE in stand-alone mode (or REMOTE CHECK). For DICE checking within a PDMS project, use the CHECKOPTION command.
Description:
STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc. STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default setting.
Examples: An example of the output from DICE when statistics are requested is as follows:
OVERALL STATISTICS ================== Total no. of entries in Name Table = 111 Total no. of elements checked = 782 Total no. of ref attributes found = 726 Total no. of external references = 0
Command Syntax:
>--- STATistics ---+--- OFF ----. | | --- ON -----+--->
STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default.
7-144
Command Details
STATUSSESSION
Function: Examples:
(Querying)
Gives information about your current status and the database to which you have access.
An example of output is shown below. Project: User: HVAC (75dws52) Teams: HVAC MDB: /HVAC Command Syntax:
>--- STATUSSession -->
Related Commands: SYSTAT
7-145
Command Details
STOP
Function: Examples:

Exits from DICE when it is running in stand-alone mode.
STOP Related Commands: FINISH has the same effect Command Syntax: >--- STOP --->
7-146
Command Details
SYNCHRONISE
Updates databases with the changes from another location. This command updates one or all databases at an on-line Location with the changes in the corresponding databases at another location. By default, the updates will be taken from the Primary Location, but the Hub Administrator can specify that they will be taken from another Location which is an immediate neighbour of the Location requiring the updates. Unlike UPDATE, the transfer is one-way only: the synchronising Location only receives updates, it does not send them. All Locations in the communications network between the two Locations being synchronised will also be updated. Note that if the more up-to-date database has been compacted, that is, sessions have been merged, or if it has been backtracked, the entire database will be transferred. Updates for offline Locations can only come from the Hub.
Examples of synchronisation of constructor databases: SYNCHRONISE STEELN/STEELN Synchronise given database at current location with its Primary location. SYNCHRONISE ALL Synchronise all databases at current location with their Primary locations. SYNCHRONISE STEELN/STEELN AT LON Synchronise given database at location LON with its Primary location. SYNCHRONISE ALL AT LON Synchronise all databases at location LON with their Primary locations. SYNCHRONISE STEELN/STEELN WITH LON Synchronise given database at current location with location LON.
7-147
Command Details
SYNCHRONISE (continued)
SYNCHRONISE ALL WITH LON Synchronise all databases at current location with location LON. SYNCHRONISE STEELN/STEELN AT LON WITH CAM Synchronise single database at location LON with location CAM. Examples of synchronisation of system databases: SYNCHRONISE SYSTEM WITH CAM Synchronise the System Database for the current Location with location CAM SYNCHRONISE SYSTEM AT LON WITH CAM Synchronise the System Database for the current location at location LON with location CAM SYNCHRONISE SYSTEM FOR OXF AT LON WITH CAM Synchronise the System Database for OXF at location LON with location CAM Examples of synchronisation of the global database: SYNCHRONISE GLOBAL WITH CAM Synchronise the Global Database at the current Location with location CAM SYNCHRONISE GLOBAL AT LON WITH CAM Synchronise the Global Database at location LON with location CAM SYNCHRONISE GLOBAL AT OXF Synchronise the Global Database at OXF with the current location Command Syntax:
>- SYNCHronise -+| || | | | | || `dbname --------------------. | SYSTEM -+- FOR -+-- LOCAL -| | | | | `-- <loc> -| | | `------------------| | GLOBAL --------------------| | ALL -----------------------+- AT <loc> --. | | `-------------+- WITH <loc> -. | | `--------------+--->
Related Commands: UPDATE, RECOVER
7-148
Command Details
SYSTAT
(Querying)
Gives information about users accessing the project. Lists all users who are accessing the project, the modules and databases which they are using, and whether they have Read-only or Read/Write access to the database. It also gives the login id and workstation identifier. You can select what information you want output: see the following examples. The following is an example of output:
Examples:
PROJECT SAM ============= User HVAC (75d-sg52) Name au (A.User) Host sg52 Entered 14:37 10 Sep Module DESIGN MDB /HVAC DB HVAC/DESI HVAC/PADD HVAC/CATA MASTER/PIPECATA MASTER/STLCATA MASTER/HVACCATA MASTER/SUPPCATA MASTER/PADD MASTER/DICT MASTER/PROP User HANGER (3c41-sg107) Name an (A.N. Other) Host sg107 Entered 14:39 10 Sep Module DRAFT MDB /HANGERS MODE RW R R R R R R R R R
7-149
Command Details
SYSTAT (continued)
DB HANGERS/DESI HANGERS/PADD HANGERS/CATA MASTER/PIPECATA MASTER/STLCATA MASTER/HVACCATA MASTER/SUPPCATA MASTER/PADD MASTER/DICT MASTER/PROP 2 user(s) listed This shows that two users are using Project SAM: User HANGER who is using DRAFT, and has Read/Write access to the Draft database HANGERS/PADD. User HVAC who is using DESIGN, and has Read/Write access to the Design database HVAC/DESI. In a Global project, there may also be a SYSTEM user running the Globaldaemon module. This shows that the daemon is running. You can restrict the output to information about the user, host, module or MDB as shown in the following examples: SYS USER HVAC Lists the information for the user HVAC SYS NAME an Lists the information for the user id an SYS HOST sg107 Lists the information for the workstation sg107 SYS MODULE DRAFT Lists the information for any users of DRAFT SYS MDB HVAC Lists the information for any users of the MDB HVAC MODE R RW R R R R R R R R
7-150
Command Details
SYSTAT (continued)
Command Syntax:
>--- SYStat ---+----------------------. | | |--- USER username ----| | | |--- NAME loginid ---| | | |--- HOST hostid ----| | | |--- MODUle module ----| | | --- MDB name ---------+--->
7-151
Command Details
SYSTEMLOCATION
(Global Project Administration - Hub Only)
Changes the Administering Location of a Satellite. The SYSTEMLOC command changes the primary location of the System database for the specified location. The primary location of the Hub system database cannot be changed: the Hub cannot be administered remotely. The SYSTEMLOC command cannot complete while there are users in PDMS with write access to the system database. The command will eventually complete once all such users have left PDMS. You may need to use EXPUNGE to remove phantom users. If a SYSTEMLOC command fails, the previous primary location will normally be recovered automatically. If the recovery fails (for example, the daemon is not running), you can recover the previous Primary location using the command:
PREVOWN SYSTEM AT locname
Use of the PREVOWN command should be avoided if possible. Offline locations: An offline Location can only be administered by the Hub or the Location itself. Once an offline Location has been initialised, you can only change the administering Location from the Hub to the Location, not from the Location to the Hub. Examples: SYSTEMLOCation LON PRIMARY AT OXF Changes the Primary Location of the Location LON to be the Location OXF, so that LON can be administered from OXF. SYSTEMLOCation OXF LOCAL Changes the Primary Location of the Location LON to be at LON, so that LON can be administered locally. SYSTEMLOCation OXF HUB Changes the Primary Location of the Location OXF to be the Hub.
7-152
Command Details
SYSTEMLOCATION (continued)
Command Syntax:
>-- SYSTEMLOCation <loc> --+-- PRIMARY AT <loc> --. | | |-- LOCAL -------------| | | `-- HUB ---------------+-->
Related Commands: ADMINISTER, PREVOWNER SYSTEM Querying: >--- Q PRMLOC ---> At a Location, shows the Primary Location for the Location. >--- Q PRVRF ---> At a Location, shows the previous primary location until the SYSTEMLOC command has completed. This attribute is normally unset.
7-153
Command Details
TADD
Function: Examples:
Adds users to the Set (i.e. Current) team.
TADD SJC Add user SJC to the current Team. Command Syntax:
.------<-----. / | >--- TADD userid ---*--- userid --- | ----------------->
Related Commands: TREMOVE, SET
7-154
Command Details
TERM
Function: Examples:

Terminates Alpha file.
TERM Terminates alpha file and outputs reports to screen. This syntax is equivalent to ALPHA FILE END Command Syntax:
>--- TERM ----->
Related Commands: ALPHA
7-155
Command Details
TO
(Reconfiguration)
Specifies the destination database for reconfiguration.
Function:
In a Global Project, the TO NEW option can only be used at the Hub. The TO DB option can only be used at the Primary Location of a database. When reconfiguring the locations own transaction database (using TO DB), the daemon must first be stopped.
Examples: TO DB USERA/DESIGN Reconfigured data to go to database USERA/DESIGN in current project. TO NEW USERM/DESIGN DBNO 777 Reconfigured data to go to new database USERM/DESIGN, number 777, in current project. TO NEW USERM/DRAFT ACCESS UPDATE Reconfigured data to go to new database USERM/DRAFT, N readers, 1 writer access rights, in current project. TO DBFILE des008 Reconfigured data to go to specified file (assumes project directory is current directory). TO FILES /TEMP1 /TEMP2 Only pass 1 of reconfiguration to be carried out; partially reconfigured data to be stored in named files.
7-156
Command Details
TO (continued)
Command Syntax:
>- To -+| || || || || DBFile filename ---------------------------------------------------. | DB dbname ---------------------------------------------------------| | FIles ----------. | | | BINaryfiles ----| | | | FORMattedfiles -+- name name --------------------------------------| | NEW dbname -----+- IN AREA n -. | | | | -------------+- ACCess -+- UPDAte -----. | | | | | | |- CONTROL ----| | | | | | | - MULTIWRITE -| | | | | -------------------------+- DBNO n -| | | ----------+->
Related Commands: FROM, RCFCOPY
7-157
Command Details
TRANSFER
Function:

Generate a directory containing copies of all database files at the current location, including inter-db macro files, for transfer between the Hub and an offline Location. This command is used at the Hub and at an offline location. All the databases at the current location will be transferred. Before the command is given, the environment variable pointing at the transfer directory must be set, and the transfer directory must exist and contain the normal project sub-directories. The current location must be either the Hub or an offline location. The location to which the files are transferred must be either the Hub or an offline location. The transfer directory is specified by the environment variable character identifier of the remote location. For example, in a Project ABC where the Hub is CAM and the offline Satellite is SYD, the following environment variables must be set: At CAM: At SYD ABC_SYD ABC_CAM
Description:
project_loc where project is the 3-character project code and loc is the 3-
TRANSFER TO copies all the Project files to the transfer directory specified by the project_loc variable. The files are then physically transferred by some means (tape, FTP etc.), and read on to the transfer directory specified by the project_loc variable. The System Administrator at the receiving end then uses the TRANSFER FROM command, which updates the Location with the transferred files. Offline Location: Special care should be taken when using CHANGE PRIMARY for an offline location. Before changing the primary location, it is important to ensure that the database at the new primary location is up-to-date. This may be done by using the TRANSFER TO command at the old primary location followed by the TRANSFER FROM command at the new primary location. All users should have left PDMS before this transfer is made. Any subsequent work on the database will be lost, due to the change in primary location.
7-158
Command Details
TRANSFER (continued)
Examples: TRANSFER TO loc Copies all database files at the current location, together with appropriate inter-db macro files etc. to the transfer directory specified by the project_loc variable. TRANSFER FROM loc Updates the current location with the files transferred from Location loc. Only databases that are allocated at the current location will be read in. Related Commands: GENERATE LOCATION Command Syntax:
>--- TRANSFer ---+--- TO pathname <loc> ---. | | `--- FROM pathname -------+--->
7-159
Command Details
TREMOVE
Function: Examples:
Removes users from the Set (i.e. Current) team.
TREM SJC Removes user SJC from the current Team. Command Syntax:
.-----<------. / | ---*--- userid --- | -------------------->
>--- TREmove userid
Related Commands: TADD, SET
7-160
Command Details
UNLOCK
Function:
Unlocks all locked databases.
Note: Examples:
Locking and Unlocking commands are not recorded in the transaction database.
UNLOCK Unlocks all locked databases
In a Global Project, the System Administrator at the Hub or at a Satellites administering location can unlock a Project at the Satellite:
UNLOCK AT LON Unlocks all locked databases at Location LON. Command Syntax:
>--- UNLOck ---+---------------. | | --- AT <loc> --+-->
Related Commands: LOCK Querying a Standard (non-global) Project:

>--- Query LOCK ----->
Querying a Global Project:

>--- Query LOCK ---+--------------. | | --- AT <loc> -+-->
7-161
Command Details
UPDATE

Updates the current location and an immediate neighbour. This is a two-way process, unlike SYNCHRONISE. Databases at the current location and databases at a neighbouring Location will be updated, according to which Location has the most up-todate version. Inter-db connection macros will also be transferred, and any update script will be run. Update scripts are linked with Update events by setting the EXECA and EXECA attributes of the LCOMD element. See Section 4.2.2, Structure of the Global Files such as Isodraft files and external plot files are not propagated automatically by the global daemon. However, there is a mechanism in the daemon to allow such files to be transferred to and from neighbouring locations, during scheduled updates or the UPDATE ALL command. The directory to receive transferred files is defined by the environment variable %IMPORT%. Each location to which files are to be transferred requires its own transfer directory - %EXP_ABC% for location ABC. Transfer of other data is described more fully in the Global Management User Guide. Both Locations must be on-line.
Database.
Examples of updating constructor databases: UPDATE ALL WITH LON All databases at the current location and all databases at Location LON will be compared, and updated so that all have the most recent data. UPDATE PIPES/PIPES WITH CAM The PIPES/PIPES database at the current location will be compared with the PIPES/PIPES database at Location CAM. Updates will be transferred from the most up-to-date database to the other.
7-162
Command Details
UPDATE (continued)
Examples of updating system databases: UPDATE SYSTEM WITH CAM The System database for the current location, at the current location, will be compared with the System database for the current Location at Location CAM. Updates will be transferred from the most up-to-date database to the other. UPDATE SYSTEM FOR OXF WITH CAM The System database for location OXF at the current Location will be compared with the System database for location OXF at Location CAM. Updates will be transferred from the most up-to-date database to the other. Examples of updating the global database: UPDATE GLOBAL WITH CAM The Global database at the current location will be compared with the Global database at Location CAM. Updates will be transferred from the most up-to-date database to the other. Command Syntax:
>--- UPDATE ---+--| |--| |--| `--dbname ---. | SYSTEM ---| | ALL ------| | GLOBAL ---+--- WITH <loc> --->
Related Commands: SYNCHRONISE
7-163
Command Details
UPGRADE
Function: Examples:
(Reconfiguration)
Produces macros to upgrade a project to a new version of PDMS.
UPGRADE /OUTMACRO /INMACRO This will produce two macro files, OUTMACRO and INMACRO. OUTMACRO will be used in the old PDMS version to dump the contents of all DBs in the project to intermediate files. INMACRO will be used in the new PDMS version to load the intermediate files and recreate the complete project. UPGRADE /OUTMACRO /INMACRO FOREIGN db1 db2 ... All databases, including the list of foreign databases specified by the FOREIGN option will be upgraded. UPGRADE /OUTMACRO /INMACRO FOREIGN ALL All databases, including all foreign databases will upgraded. Command Syntax: .---<------. / | >--- UPGrade macro1 macro2 ---+-- FOReign --*-- dbname -- | | -------------+--- ALL -----. | | `-------------+--->
7-164
Command Details
VB
(Reconfiguration)
Gives very brief output for pass 2 reconfiguration. A short example of very brief output is shown below. Compare with the brief output shown in the BRIEF command.
*** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC LIBY #92/842 =16/2404
Function: Examples:
(24,90) Warning! library number 242 already exists in the project. Duplicate libraries should not be used in the same MDB EC DEPT #16/805 =16/2408 Phase one complete - starting phase two *** Pass two completed *** ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 3 Attributes were incorrectly defined 0 Elements were not inserted.
Command Syntax:
>--- VB --->
Related Commands: BRIEF, FULL, ERRORS
7-165
Command Details
XREF
Function:
(Reconfiguration)
Generates a list of the reference numbers of all elements which need updating for each database prior to a multi-database reconfiguration. Can be used when upgrading a project from one version of PDMS to the next. Note: This command is normally handled automatically by the upgrade macros supplied with a new version of PDMS. You are advised to consult your AVEVA Solutions Support Office before using it.
Examples: XREF /REFFILE Reference number list to be written to file /REFFILE. Command Syntax:
>--- XRef filename --->
Related Commands: RESETXREFS, DUMP, UPDATE DB
7-166
Index
Attributes non-reference handling of during reconfiguration, 3-1, 3-3 reference handling of during reconfiguration, 3-1, 3-3 Binary-format files, 3-22 BRIEF command, 3-8 Brief output mode, 3-8 Character-format files, 3-22 Commands Detailed Descriptions, 7-4 Reconfiguration, 3-2 Summary in Functional Groups, 6-1 Syntax Graphs, 7-1, 7-3 Communications elements LCOMC (Admin Daemon Config), 4-13 LCOMD (Comms Link Details), 4-13 LCOML (LCOMD Elements List), 4-13 LCTIMD (Event Timings), 4-15 LCTIML (Event Timer), 4-14 LEVENL (Time Interval), 4-14 Copies of databases, 3-9 Copy list (for reconfiguration), 3-3, 3-5, 3-13 DAtaBAse CONtrol program (DABACON), 3-1 Database Description Languages (DDLs), 3-1 Database Structure Elements and their Attributes, 4-1, 5-1 Global Database, 4-10, 4-15 Local System Database, 4-12 System Database (standalone projects), 4-1 Transaction Database, 5-1 Destination database for reconfigure operations, 3-1, 3-3 DICE Exiting, 2-1 Reports, 2-2 Setup Options, 2-2 Starting up, 2-1 User Message File, 2-1 DUMP command, 3-12 Elements ACR (Access Control Rights), 4-9 ACRL (ACR List), 4-9 ACRST (ACR Group), 4-9 DB (Database), 4-5, 4-17 DBALL (Location DB List), 4-21 DBL (Database List), 4-7 DBLI (Database List), 4-4, 4-17 DBLOC (DB Location), 4-18 DBSET (DB Set), 4-6 DBSTL (Database Set List), 4-7 EXTLI (Extract List), 4-6 FNTF (Font), 4-4 GRP (Group), 4-19 GRPLI (Group List), 4-19 LNK (Links), 4-21 LNKLI (Link List), 4-21 LOC (Location), 4-20
index-i
Index
LOCLI (Location List), 4-20 MDB (MDB), 4-6 PEROP (Perops), 4-7, 4-18 ROLE (Role), 4-7, 4-18 RUNF (Runfile or Module), 4-3 SCOPE (Scope), 4-8 STAMP (Stamp), 4-8, 4-22 STLST (Stamp List), 4-9, 4-22 TEAM (Team), 4-4, 4-17 TMLI (Team List), 4-6 USER (User), 4-5 USLI (User List), 4-5 Errors reconfiguration controlling limit of for output, 3-9 ERRORS command, 3-9 FROM command, 3-3, 3-15, 3-22 FULL command, 3-8 Full output mode, 3-8 Global Commands, 1-1 Groups reconfiguring, 3-14 INCLUDE command, 3-13 Index of reference numbers, 3-11 Intermediate files, 3-1, 3-3 Isodraft files, 4-14, 7-165 LOAD command, 3-12 Manual Content, 1-1, 1-2 Messages, 3-19 New version of PDMS transferring data to, 3-1, 3-2 Offline location, 4-14, 4-20, 6-3, 7-12, 7-23, 725, 7-39, 7-50, 7-68, 7-76, 7-77, 7-82, 7107, 7-111, 7-150, 7-155, 7-161
index-ii
Output controlling, 3-8 PADD databases treatment of when reconfiguring, 3-14 PDMS Data Integrity Checker (DICE), 2-1 Picture files treatment of when reconfiguring, 3-14 Plot files, 4-14, 7-165 Programmable Macro Language (PML), 1-1 Projects transferring data between, 3-15 upgrading, 3-16 RCFCOPY command, 3-4 RCFUPDATE command, 3-11, 3-12 Reconfiguration, 3-5 Extracts, 3-23 Global Projects, 3-23 same references, 3-6 Transaction Database, 3-27 RECONFIGURE command, 3-5 RECONFIGURER, 3-1 Reference attributes, 3-10, 3-12 Reference number index, 3-11 loading from file, 3-12 saving to file, 3-12 Reference Number Index listing, 3-6, 3-7 References between databases, 3-10 Relevant User Guides, 1-1 REPLICATE command, 1-1 RESETXREFS command, 3-16 Root element, 3-13 SAMEREF option, 3-6
Index
Source database for reconfigure operation, 3-1, 3-3 TO command, 3-4, 3-15, 3-22 Transaction elements TRDAY (Command Date Day), 5-3 TRFAIL (Transaction Failure), 5-12 TRFLST (Transaction Failure List), 5-11 TRINCO (Transaction Incoming Command), 5-4 TRLOC (Transaction Location), 5-3 TRMESS (Transaction Message), 5-12 TRMLST (Transaction Messages List), 5-11 TRMONT (Command Date Month), 5-3 TROPER (Transaction Operation), 5-10 TROUCO (Transaction Output Command), 5-7 TRSLST (Transaction Success List), 5-11 TRSUCC (Transaction Success), 5-12 TRUSER (Transaction User), 5-3 TRYEAR (Command Date Year), 5-3 Transferring data to a new version of PDMS, 3-1, 3-2 Upgrade macros, 3-16
VB Command, 3-8 Very Brief output mode, 3-8 World, 4-8 World elements ACRW (Access Control Rights), 4-9 DBSTWL (DB Set), 4-6 FTWL (Font), 4-3 GLOCWL (Global Location), 4-19 GROWL (Global Role), 4-18 GSTAT (Global Status), 4-16 GSTWLD (Global Stamp), 4-21 GTMWL (Global Team), 4-16 LCOMW (Communications), 4-12 MDBW (MDB), 4-6 RFWL (Runfile or Module), 4-3 ROWL (Role), 4-7 STAT (Project Status), 4-3, 4-12 STWLD (Stamp), 4-8 TMWL (Team), 4-4 TRMSGW (Transaction Message), 5-3 USWL (User), 4-5 XREF command, 3-16
index-iii

ADMIN Command Reference Manual

Încărcat de

Informații document

Descriere originală:

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

ADMIN Command Reference Manual

Încărcat de

Drepturi de autor:

Formate disponibile

PDMS ADMIN

Command Reference Manual

PDMS1161/ADMIN Command Reference Manual Issue 260605

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

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

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

3.5 3.6 3.7 3.8 3.9 3.10

3.12 3.13 3.14

3.15 3.16 3.17

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

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

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

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

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

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

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

Global that PDMS System Administrators need to understand.

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

1.2 How to Use This Manual

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

2.1 DICE Errors

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

2.2 DICE Commands

ERRORFILE MODE MAXERRORS MAXWARNINGS STATISTICS

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.1 The Reconfiguration Process

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.2 Starting up RECONFIGURER

3.3 Administrative and Querying Commands

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.4 Basic Reconfiguration

3.4.2 Specifying the Source Database

Source data is in database STEELS/STEELS in current project

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

FROM PROJECT XXX STEELS/STEEL

Source data is in specified DB in project XXX

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

3.4.3 Specifying the Destination DB

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

Reconfigured data to go to new database USERM/DESIGN, number 777, in current project

3.4.4 Specifying What Will be Copied

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.4.5 Starting the Reconfiguration Process

3.4.6 Example of a Simple Reconfiguration

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.5 Using the SAMEREF Option

3.6 Using the SESSIONS Option

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.7 Listing the Reference Number Index

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.8 Global Projects

3.9 Controlling RECONFIGURER Output

3.10 Copies and Reconfigured Copies of DBs

PIPEA/PIPEA DESI ADMIN/TEST USER/DRAFT DESI PADD

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

3.11 Advanced Reconfiguration

References Between Databases

HREF /E1-N2 DESIGN DB 1 CREF /150-B1 Nozz /E1-N2 DESIGN DB 2

VANTAGE PDMS ADMIN Command Reference Manual Version 11.6SP1

Updating References into a Reconfigured Database

Old reference /VESS1 /VESS2 =123/456 =123/457

New reference =123/457 =123/458