Professional Documents
Culture Documents
AVEVA Administration - Administrator Command Reference Manual
AVEVA Administration - Administrator Command Reference Manual
Reference Manual
AVEVA Solutions Ltd
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every
part of it (including source code, object code, any data contained in it, the manual and any other
documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in
this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval
system, or transmitted without the prior written permission of AVEVA Solutions Ltd Where such
permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently
displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material
or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not
reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the
product described in this publication may be incorporated into any third-party software, product,
machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by
law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with
the terms and conditions of the respective licence agreements, and in accordance with the relevant
User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
Administrator Command Reference Manual
Contents Page
Administrator Command
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Reconfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Reconfiguration Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Starting up RECONFIGURER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Administrative and Querying Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Basic Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Reconfiguring a Single Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Specifying the Source Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Specifying the Destination DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Specifying What Will be Copied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Starting the Reconfiguration Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Example of a Simple Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Using the SAMEREF Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Using the SESSIONS Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Listing the Reference Number Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7
1 Introduction
This manual describes the PDMS ADMIN commands for Standard (non-global) and Global
projects. It is written for System Administrators who are already experienced ADMIN users
and who wish to write macros or use command input, rather than the GUI.
The content of this manual is based on the assumption that you are already familiar with the
concepts that a PDMS System Administrator needs to understand. If you are not familiar
with these concepts, you should refer to the relevant user guide, as follows:
• Using PDMS ADMIN for a standard (non-global) project is described in the AVEVA
ADMIN User Guide, which tells you how to set up and administer PDMS projects using
the GUI. The User Guide also describes the concepts that PDMS System
Administrators need to understand.
• Using Plant Design Global via the GUI is described in the Global User Guide, which
also describes the concepts in Plant Design Global that PDMS System Administrators
need to understand.
Within the manual, commands that are only available in AVEVA 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 Software Customisation Guide and the Software
Customisation Reference Manual.
Command Reference manual as there is no interface to stand-alone DICE, and you will
need to enter commands interactively or via a macro.
Reconfiguration, applies to Standard and Global projects and describes database
reconfiguration.
System and Global Projects, 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.
Transaction Database applies to Global projects only, and describes the transaction
database, the elements in it, and their attributes.
Command Summary applies to Standard and Global projects. It lists the ADMIN commands
in functional groups.
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.
Drawing File Name and Folders file name conventions used for Drawing and Picture files
during propagation.
2 Stand-Alone DICE
The PDMS Data Integrity Checker (DICE)PDMS 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 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.
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.
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.
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 ADMIN User Guide.
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.
The transfer of data takes place in two passes, the second of which is further divided into
two phases:
PASS 1 The data is read from the source DB and written to a pair of
intermediate files. The first file holds the element structures
and the non-reference attributes, the other holds the
reference attributes.
PASS 2 - Phase 1 The first file is read by RECONFIGURER and used to
recreate the original structures in the destination DB,
including setting of the non-reference attributes.
PASS 2 - Phase 2 The second intermediate file is read and its contents used to
set all reference attributes in the destination DB and to
perform insertion operations.
The reason for the two phases is that references in the source DB may refer to elements
lower down in the hierarchy. It is necessary, therefore, to create all elements in the
destination DB before trying to set references to any of them.
Since the two passes perform independent and consecutive operations, the process can be
interrupted after Pass 1 has been completed, with Pass 2 being run later.
Reconfiguration has four basic steps:
1. Specify where the data to be reconfigured is coming FROM
2. Specify where the reconfigured data is going TO.
3. Specify which parts of the source data are to be copied to the destination.
4. Start the reconfiguration process.
Examples:
FROM DB STEELS/STEELS
Source data is in database STEELS/STEELS in current project
Examples:
TO DB STEELS/STEELS
Reconfigured data to go to database STEELS/STEELS 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 are 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 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 Copies
and Reconfigured Copies of DBs.
Note: The new database will need to be added to the appropriate MDBs.
The following messages are typical of the output during a completely successful
reconfiguration:
*** Pass one initiated ***
*** Pass one completed ***
*** Pass two initiated ***
***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 Reconfiguration Messages, for a complete list of output messages.
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
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
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.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:
DESIGN DB 1
CREF /150-B1
Nozz /E1-N2
DESIGN DB 2
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.
Examples:
RCFUPDATE DB MASTER/DESIGN
Updates references to the reconfigured DB from DB MASTER/DESIGN.
As the RCFUPDATE command may cause a DB to be written to, you must have Read-Write
access to all relevant DBs. The DBs must not be in active use by any other user of the
project.
Care should be taken when reconfiguring to the same DB number. If you update a DB twice,
the resulting reference numbers could be wrong. For example:
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.
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
Note: Partial reconfiguration of PADD DBs is only allowed for picture elements (i.e. SHEE,
BACK, OVER, SYLB, LALB) and above.
To update the references of the original database to point to the new copied elements use
the RCFUPDATE INTERNAL command described in Updating References into a
Reconfigured Database.
Example:
FROM DB /CATOLD
Specify source DB.
RCFCOPY ALL
RECONFIGURE
Example:
TO DB /CATNEW
pass 2 of reconfiguration to be done.
RCFCOPY ALL
RECONFIGURE
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:
FROM DB ANSI/MASCAT
TO FILES /REC1A /REC1B
RCFCOPY ALL Copies the Catalogue DB first
RECONFIGURE
FROM DB CIVIL/STRUC4
TO FILES /REC2A /REC2B
RCFCOPY ALL Copies the Design DB
RECONFIGURE
FROM DB VESSEL/V25CT
TO FILES /REC3A /REC3B
RCFCOPY /SITE-A Copies the Site
RECONFIGURE
RCFUPDATE DB STEEL/MAIN
RCFUPDATE DB EQUIP/MAIN
Gives correct cross-references
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.
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.
Example:
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
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
CODE: Identifies the nature of a message arising from the creation or naming of
an element. The codes used are detailed in the next section.
TYPE: The type of element, e.g. SITE, BRAN, SHEE etc.
OLDREF The reference number of the element in the source DB (starting with ‘#’).
NEWREF: The reference number of the corresponding element created in the
destination DB (starting with ‘=’). This will be blank if the element could
not be created.
NAME: The name given to the element. This applies only if the message is
coded ‘EN’ to indicate that the element has been named (see next
section).
EC Element Created
EN Element Named
These are output as the reconfiguration proceeds and each message ends with the name of
the copied element.
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.
An attempt was made to insert the element into a list where it is no longer permitted.
Elements in the list part of ones that cannot be created are lost, since they cannot be
created either.
followed by one or more other messages giving more information about the error.
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.
The transfer operation is essentially an extension of the procedure for copying data between
projects, described in Transferring Data Between Projects. 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 PDMS DESIGN Reference Manual Part 1 (OUTPUT command).
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
• 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:
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.
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: The REFRESH, REVERT and MERGE CHANGES commands have not been shown
below.
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
FROM DB CTBATEST/EXT
TO FILE /EXTA /EXTB
RCFCOPY ALL
RECONFIG SESSIONS
FROM DB CTBATEST/EXTBOT
TO FILE /EXTBOTA /EXTBOTB
RCFCOPY ALL
RECONFIG SESSIONS
The user must now propagate the whole database to locations (B) and (C).
The user must now propagate the whole database to locations (C) and (A).
6. At location C (primary location for EXTBOT)
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.
Note: The daemon for a location must be stopped before reconfiguring its transaction
database.
This chapter describes how ADMIN elements and their attributes, in a System database
differ when a Global project is used.
You can navigate to the elements in the System and Global databases, and query their
members and attributes in the normal way.
A full list of Elements and their Attributes is included in the Data Model Reference Manual.
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.
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.
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.
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:
Note: 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.
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.
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
Logms false
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 /name
Lock false
Owner /name
Locrf /name Name of Location which has comms link with current
Location
Hours 0 - 23
Days 1 - 31
Months 1 - 12
For example:
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 User Guide.
Offline locations: Note that transfer of such files to or from offline locations must be done
manually.
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.
Attributes:
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 /name
WORLD
World
DBLOC
Attributes
Name /*GS
Lock false
Owner /*
Maxusers 999999
Charset -370086
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:
• It does not own a user list element USLI.
• The DB element does not own an MDB list element MDBL.
• The DB element owns a single DBLOC element DBLOC.
Attributes
Name /*GT
Lock false
Owner /*
TEAM Element
Attributes
Name /name
Lock false
Owner /*GT
Description unset
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). 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 Global daemon.
Attributes
Name /name
Type DB
Lock false
Owner /name
Stype DESI
Daccess Update
Description unset
Proj unset (except for Foreign DBs, where it is set to the project
code)
Fcpyref Nulref
Bcpyref Nulref
Extractno n
Variant false
Controlled false
DBLOC Element
Attributes
Name /name
Type DBLOC
Lock false
Attributes
Name /*GRO
Lock false
Owner /*
Attributes
Name /name
Lock false
Owner /*T
Attributes
Name /name
Lock false
Owner /name
Opcreate ignore
Opmodify ignore
Opdelete Ignore
Opclaim ignore
Opissue ignore
Opdrop ignore
Opoutput ignore
Opexport ignore
Opcopyfrom ignore
Condition unset
Acrmessage unset
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 /*
Newuid text gets new UUID value to use when setting ADUUID.
To be used when a Global project is copied directly
without the REPLICATE command (see
REPLICATE (Project definition)) 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.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
Attributes
Name /name
Lock false
Owner /name
DEALAL false Indicates that ALL DBs are currently being de-
allocated from this location.
LCpOvWrite default false If true, database files which are locked by dead
users may be overwritten if an update requires an
entire file copy.
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.
Note: Do not allow locked files in the current project to be overwritten during copying by
Global updates if other projects are using the current project as a foreign one. This is
because database readers in the other projects are valid users even though they are
not recorded as users in the current project.
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
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.
5 Transaction Database
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.)
%TRMSG
%TRYEAR
%TRMONT
%TRDAY
%TRUSER
%TRLOC
%TRINCO
%TROPER %TROUCO
%TRSUCC %TRFAIL
restarted, and is sufficient to generate the operations and output commands necessary to
execute the command.
Note: Local commands added from PDMS, that is those with TRLOCL True, do not contain
successes, failures or messages.
Attributes
COMUID ref 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.
TRMODU int Module number through with the USER has issued this
command, or GLOBALDAEMON module
COMSTR text Command string USER entered that generate this command,
else null
DATERD date Date command made ready (after EXTIME has been reached)
MSTEXT text text info set on completion (normally only if failed to generate
operations)
TRPASS log True if command succeeded, false if failed. The command fails
if any of its operations fail, or if it fails to generate operations
INARCO int argument count for intargs (args of the command) (defaulted to
zero.)
STALLED The command has failed to create its operations and state
will later return to ACKNOWLEDGED ready for retry, or to
TIMEDOUT.
REPLIED The daemon has sent the results back to the originating
location. DATERP is set and NREPLY incremented.
TIMEDOUT The command has timed out before creating its operations
and finished with TRPASS false. DATEND is set.
Attributes
COMREF ref Ref of the TRINCO of this command stored in the receiving
location transaction database. This is NULL until an
acknowledgement is received.
NXTARL[3]- text Next Target location - this is needed to determine which port
to assign the output command to, and which location to send
the command.
ENDTIM date Date when command will fail if sending remains stalled.
DATERP date Date reply with results received from destination location.
MSTEXT text Text info set on completion (normally only if failed to generate
operations).
POPCOD int Code for post operation creation function to be run. If none
then zero.
DATEND date Date all processing of command finished all post operations
generated, or command cancelled, or command timed out.
INARCO int Argument count for intargs (args of the command, defaulted to
zero).
STALLED The command could not be sent. State will later return to
ACKNOWLEDGED ready for retry, or to TIMEDOUT.
REPLIED A reply with results has been received from the destination
location. DATERP is set, NREPLY is incremented.
STALLED_POSTOP Post operations could not be created. State will later return
to COMPLETE ready for retry, or to TIMEDOUT.
Attributes
ENDTIM date Date when operation will fail if execution remains stalled.
STALLED The operation could not be executed. State will later return
to READY (ready for retry), or to TIMEDOUT. DATESL is
set.
STALLED_POSTOP Post operations could not be created. State will later return
to COMPLETE ready for retry, or to TIMEDOUT.
6 Command Summary
This chapter lists the ADMIN commands in functional groups. Details of the commands are
given in Command Details in alphabetical order of command name.
CHANGE Changes database access type, and the claim mode for
multiwrite databases. (In a Global project, also changes
primary location)
USERREM/OVE FROM Removes the specified PDMS user from the authenticated
user.
PURGE Removes old Database files and Picture files from an offline
Location.
6.6 Querying
Stand-alone:
ERRORFILE Specifies the name of the file containing the error and
warning messages when DICE is used in stand-alone
mode.
6.9 Reconfiguration
LOAD Loads the reference number index from the given file.
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.
CReate
CR
CRE
CREA
CREAT
CREATE
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:
• 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:
• 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.
• 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>
<date>
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.
month can be entered as a word, or as a number separated by a slash. If not given the
current month is assumed. If used, the slash must be surrounded by spaces.
year will default to the current year. It may be entered as two or four figures.
Examples:
Function:
Changes the access rights of the specified user to PDMS modules.
Example:
Command Syntax:
.-------------<-------------.
/ |
>--- ACcess --*-- userid ---*--- FRee ------|
| |
‘--- GEneral ---+--->
Related Commands:
CREATE
Function:
Adds an ACR to an ACR Group.
Description:
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:
Command Syntax:
.----<-------.
/ |
>-- ACRADD --*--- acrname ---'
|
‘--------------------->
Function:
Removes an ACR from an ACR Group.
Description:
The ACR Group must be the current element. You can then give a list of ACR names to be
removed from the Group.
Examples:
Command Syntax:
.----<-------.
/ |
>-- ACRREM --*--- acrname ---'
|
‘--------------------->
Function:
Places a named DB at a specified position in the current MDB list.
Description:
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).
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, EXCHANGEREMOVE, DEFER, CURRENT, EXCHANGE
Function:
Creates or opens a system database to allow you to administer a remote location.
Description:
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:
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.
Examples:
Command Syntax:
Querying:
Function:
Allocates databases and copies them to a Location.
Description:
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 Location’s 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.
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:
Command Syntax:
Related Commands:
DEALLOCATE, CHANGE dbname PRIMARY, HUBLOC, TRANSFER
Querying:
>--- Q DBLC ---> At a DB, shows the list of locations that have the DBs allocated
Function:
Sends the information output in the Command Input and Output window to a file.
Examples:
Command Syntax:
Related Commands:
TERM
7.3.8 AUTHENTICATION
Function:
Switches Windows NT authentication ON or OFF.
Examples:
AUTHENTICATION ON
AUTHENTICATION OFF
Command Syntax:
Related Commands:
LIST AUTHUSER, USERADD TO, USERREM/OVE FROM, AUTHUSERREMOVE,
CREATE AUTHUSER
7.3.9 AUTHUSERREM/OVE
Function:
Removes Window NT authenticated user.
Examples
AUTHUSERREM/OVE ‘fred.bloggs1’
Command Syntax:
Related Commands:
LIST AUTHUSER, USERADD TO, USERREM/OVE FROM, CREATE AUTHUSER,
AUTHENTICATION
Function:
Allows you to backtrack a database to a previous session.
Description:
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.
Examples:
Command Syntax:
Querying:
Q SESSION
Related Commands:
REVERT, MERGE CHANGES, REMOTE BACKTRACK, REMOTE REVERT - Global only
Function:
Gives brief output from pass 2 reconfiguration. This is the default.
Examples:
A short example of brief output is shown below. Compare with very brief output from the VB
command.
***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:
Related Commands:
FULL, VB, ERRORS
Function:
Allows a daemon command being executed at the current location to be cancelled.
Description:
The command to be cancelled must be in the ACKNOWLEDGED, READY, RECEIVED or
STALLED state. See TRINCO element (Input Command) for information about the different
states. A READY command cannot be cancelled if it has running operations.
Examples:
Command Syntax:
Related Commands:
REMOTE CANCEL
Function:
Changes the description of the specified User, Team, Database or MDB.
Description:
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:
Command Syntax:
Related Commands:
CNAME, 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.
• Optionally set PROTECTION to limit copying and extraction of data between users and
projects.
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.
Note: 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.
Setting the PROTECTION parameter will disallow copying extraction of data between
projects or users which are not members of the protected database. An optional expiry date
may be specified.
CHANGE dbname PROTection [ ON | OFF ] [EXPires future-date ]
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:
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.
Command Syntax:
Querying:
Related Commands:
PREVOWNER, TRANSFER (Global only)
Function:
Starts the integrity checking of the databases specified.
Description:
• 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 Stand-Alone DICE.
When a DICE report indicates that buckets have been lost, normally this would require the
master database to be patched. However in a global project, this error is non-fatal if there
are working extracts. These databases are non-propagating and only exist at the primary
location of their extract owner. This results in the error report, since the buckets for working
extracts are not accessible at the primary location of the master db.
Examples:
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:
.------<----.
/ |
>- CHEck -+- DBs --*-- dbname ---+----------------------------------.
| |
|- SYStemdb ----------------------------------------------|
| |
|- GLOBaldb ----------------------------------------------|
| |
|- COMMdb ------------------------------------------------|
| |
|- MISCdb ------------------------------------------------|
| |
‘- PROject -----------------------------------------------+->
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
Function:
Sets the options for database integrity checking.
Description:
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.
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
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:
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:
For case 704, the patch attempts to release the element from the parent extract. If
successful, the following message will be written:
CHECKOPTION (continued)
704: PATCH: Element ref/ref cleared from parent extract claim list
Command Syntax:
Related Commands:
CHECK
Function:
Changes the name of the Element.
Description:
This command is the only way in which the System Administrator can change a user’s
password without deleting and recreating the user. Note that users can change their own
passwords using the PASSWORD command in MONITOR. Passwords are alpha numeric
character strings up to 50 characters long. The following characters should be avoided:-
|’@$/*
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:
Command Syntax:
Related Commands:
CHANGE, EXCLUDE, INCLUDE, MOVE, CDESC
Function:
Creates a copy of a DB, MDB, Team, User, Module or Stamp.
Description:
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.
In a Global Project, you can only copy Teams and Databases at the Hub.
If the PROTection parameter was set during the creation of a database then a copy
command will not be permitted.
Examples:
Command Syntax:
>- COpy -+- DB dbname -+- FROM PROject projid USer id pass -.
| |
‘------------------------------------+-> continued
>- 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
Function:
Creates USERs, Windows NT authenticated users, TEAMs, Databases (including Extracts)
and MDBs.
Description:
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 AVEVA PDMS ADMIN User Guide; for information about using extracts in
Global projects, see Running Global Projects with 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.
In a Global Project, you can only create Teams and Master Databases at the Hub. Extracts
can be created at any authorised 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.
Authorised locations:
A location is authorised to create extracts (for itself or an administered location) if its
NOEXTC attribute is false. The Project hub is always authorised to create extracts.
Examples:
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
Command Syntax:
Databases
userid and teamid are alpha numeric character strings up to 50 characters long.
The following characters should be avoided:-|’@$/*.
passwd is an alphabetic character string up to six characters long.
name is a normal PDMS name consisting of a slash (/) followed by up to
31 alphanumeric characters.
dbname is a 32-character name
Extracts
>- CReate WORKing EXTRact FROM team/db FOR user ----------> cont
Standard projects:
cont >--------+- EXTNO n -.
| |
‘-----------+- DESC text -.
| |
‘-------------+-->
Global projects:
cont >-+- EXTNO n -.
| |
‘-----------+- REFBLOCKS n -.
| |
‘---------------+- AT <loc> -.
| |
‘------------+- DESC text -.
| |
‘-------------+->
The REFBLOCKS option is used to allocate a block of reference numbers. See Running
Global Projects for more details.
The AT <loc> option allows the Hub or an administering location to create an extract
database whose primary location is at the specified satellite.
Authenticated User
Querying:
Related Commands:
SET, MODULE, CHANGE, NEW, LIST AUTHUSER, USERADD TO, USERREM/OVE
FROM, AUTHUSERREMOVE, AUTHENTICATION
Function:
Moves a DB to a given position in the current MDB list.
Description:
The specified list position must be in the range 1-300.
Examples:
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
Function:
Adds a DB or another DB Set to a DB Set.
Description:
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.
Command Syntax:
.----------------<------------.--<---.
/ | |
/ .----<-------. | |
/ / | | |
>-- DADD --*--- DB -------*--- dbname ---+---' |
| |
| .-------------------<------------. |
| / | |
| / .-------<-------. | |
|/ / | | |
*--- DBSET ----*--- dbsetname ---+---+---+--->
Querying:
Q SET DBSET
Related Commands:
DREMOVE, DELETE, SET, NEW
Function:
Removes databases from the list of databases allocated to a Location.
Description:
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 de-allocation 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.
Occasionally it is necessary to perform routine housekeeping and other maintenance on
satellite databases and then it is advantageous to be able to deallocate them temporarily.
To do this we can use the KEEPMDBS option. When the database is reallocated, it
becomes available once more after the MDB is reselected.
Note: When a user at a satellite accesses an MDB which contains a de-allocated database
it will be treated as a deferred database. This may lead to unexpected errors since
attributes in other databases may still contain references to this database.
See the guide Running Global Projects with PDMS for more information about de-allocating
databases that have extracts.
Examples:
Command Syntax:
The KEEPMDBS option means that the database will not be removed from MDBs at the
satellite although its database file will be deleted and the database removed from the
location's allocation list. This option is useful when a database is being de-allocated
temporarily for housekeeping procedures. A replacement database with the same details
will be available for use immediately it is re-allocated without any need to modify MDBs.
SORTAL/LOCATE --- loc --->
This command sorts extract databases in a location's list of allocated databases into master-
child-grandchild order, so that extract owners precede extract children. Note that this
command will have no effect until the relevant databases have been allocated.
Related Commands:
ALLOCATE, CHANGE
Querying:
Function:
Makes a specified DB non-current.
Description:
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
Function:
Deletes elements from the project.
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.
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 PDMS for further information about deleting databases
and extracts from a Global project.
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
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.
Command Syntax:
Function:
Removes a DB or DB Set from the current DB Set.
Description:
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.
Command Syntax:
.----------------<------------+--<---.
/ | |
/ .----<-------. | |
/ / | | |
>-- DREMove --*--- DB -------*--- dbname ---+---' |
| |
| .-------------------<------------. |
| / | |
| / .-------<-------. | |
|/ / | | |
*--- DBSET ----*--- dbsetname ---+---+---+--->
Querying:
Q SET DBSET
Related Commands:
DADD, DELETE, SET
Function:
Writes a reference number index to the given file.
Description:
If required, the reference index should be written for each database.
Examples:
DUMP /DUMP1
Write reference number index to named file.
Command Syntax:
Related Commands:
LOAD, XREF
Function:
Checks for elements with duplicate names in the Project.
Description:
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.
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:
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:
Function:
Enables project module entries to be edited.
Description:
Enters edit mode (which continues as long as only command lines beginning with EDIT or
MODULE are used) within which a project module entry’s NAME, NUMBER, SECURITY,
MODE, data file, RESUME file and IMACRO and BUFFER options can be edited.
Examples:
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
Function:
Specifies the name of the file containing the error and warning messages when DICE is
used in stand-alone mode.
Description:
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:
Related Commands:
MODULE, LIST MODULES
Function:
Sets an upper limit on the number of errors that are acceptable during Pass 2 of a
reconfiguration.
Description:
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:
Related Commands:
BRIEF, FULL, VB
Function:
Replaces the current DB by a non-current DB.
Description:
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:
Command Syntax:
.--------<----------.
/ |
>-- EXchange ---*--- dbname dbname ---’
|
|-----------------------.
| |
‘--- integer integer ---+--->
Related Commands:
ADD, REMOVE, CURRENT, DEFER
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:
Related Commands:
INCLUDE
Function:
Removes users who are accessing the Project, and releases claimed elements in Multiwrite
databases.
Description:
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.
Note: EXPUNGING users re moves them from the COMMS database but does not end
their PDMS session or remove the file-locks on the database. To remove these locks
you can use the Microsoft NETFILE API or proprietary tools like pstools from
Sysinternals.
In a Global project, you can use this command on Constructor 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 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.
Alternatively you can set the LCPOVW attribute to TRUE, which allows the damon to
overwrite locked files provided there are no database READERS (as recorded in the
Session data in the COMMS database).
Note: Do not use this facility if the project has users from other projects. Such users are
valid database READERS but are not recorded in the Session data for the current
project
Examples:
EXPUNGE
Expunge all users. (This should be used with care.)
EXPUNGE ’29f’
Expunge user identified by given process number.
EXPUNGE USER ’USERA’
Expunge user given by name.
EXPUNGE USER nnnn
Expunges the specified user slot number.
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.
EXPUNGE DB dbname
Releases elements which have been claimed in a multiwritedatabase. 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.
Command Syntax:
.-----<--------------------------------.
/ |
>-- EXPUNGE --*-- process_id --------------------------|
| |
|-- user ---------+-- username ----------|
| | |
| ‘-- slot nnnn ---------|
| |
|-- 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.
Querying:
Q ACTIVE
Related Commands:
SYSTAT,
Function:
Checks that all external references point to DBs of appropriate types.
Description:
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.
Examples:
EXTERNAL CHECK
EXTERNAL NOCHECK
EXTERNAL REJECT
8 GLB/DESI 41
31 TECHP/TPDESI 4
Command Syntax:
Function:
Control of database extracts
Description:
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.
Ordinary Flush should be used in preference.
REFRESH Refreshes any extract in the database hierarchy with changes that
have been made to its parent extract.
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 Writes the changes back to the parent extract, and releases the
extract claim.
RELEASE Releases the extract claim: this command can only be used to
release changes that have already been flushed.
DROP Drops changes that have not been flushed or issued. The user claim
must have been unclaimed before this command can be given.
Note: That unlike the constructor modules, you can only perform these operations on a
complete database in ADMIN, and so extract claiming has no meaning in ADMIN.
For general information about using extracts in projects, see the AVEVA PDMS
ADMIN User Guide. For information about using extracts in Global projects, see
Running Global Projects with PDMS.
In a Global project, Flush, release and issue may be executed remotely if the parent extract
is not primary at the current location. In this case, FlushW is used and the database must be
explicitly refreshed after completion of the flush.
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:
Command Syntax:
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.
Function:
The FINISH command saves work and leaves PDMS.
Examples:
FINISH
Command Syntax:
Related Commands:
SAVEWORK
Function:
Sets the font directory name.
Description:
The font directory stores the native (WIGMAN) 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 user’s current directory.
Examples:
FONTD /%PDMSEXE%
Command Syntax:
Querying:
Related Commands:
FONTFAMILY, Q FONTS
Function:
Defines a native (WIGMAN) font family.
Description:
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 1 UK STYLE 1
FONTF 2 UK STYLE 2
FONTF 3 UK STYLE 3
FONTF 4 UK STYLE 4
FONTD /%PDMSEXE%
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).
Note: True-Type fonts are not defined in this way, these use the TTFONT element.
Examples:
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 --|
| |
‘------------+-->
Note: 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, Q FONTS, NEW TTFONT, TTFONT
Querying:
Function:
Specifies the source database for reconfiguration.
Examples:
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:
Related Commands:
RECONFIG, RCFCOPY, TO
Function:
Gives full output from pass 2 reconfiguration.
Description:
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.
Command Syntax:
Related Commands:
BRIEF, VB, ERRORS
Function:
Generates the files required for a new location.
Description:
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
project_locid where project is the 3-character project code and locid is the 3-character
identifier of the new location.
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 on-line Location.
If the ALLOCATE option is specified, all the Databases allocated to the Location’s 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.
Examples:
Note: If the location identifier contains numeric characters, it must be enclosed in quotes.
Command Syntax:
Related Commands:
INITIALISE
Querying:
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 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 PDMS.
Command Syntax:
Related Commands:
SAVEWORK
Function:
Relocate Project Hub.
Description:
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-to-date. 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.
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.
Command Syntax:
Related Commands:
PREVOWNER HUB, ALLOCATE ALL
Querying:
Function:
Includes databases from another project in the current MDB. Note that the external
databases can only be accessed in Read-only 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:
Command Syntax:
Related Commands:
CNAME, MOVE, CHANGE, EXCLUDE, COPY
Function:
Initialise communications link at an on-line Location.
Description:
This command checks for the existence of the Admin daemon at the given location and
informs the Hub that the location is on-line. 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:
Related Commands:
GENERATE LOCATION
Querying:
Q LINIT
Function:
Isolates a Location so that no updates take place.
Description:
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:
Querying:
Function:
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 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 filena mes 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 MESSAGES
Lists inter-user messages.
LIST PASSWORDS
Lists users’ ids and passwords.
LIST TYPES
Lists the types of DB currently permissible.
LIST SIZES
Gives the sizes of all the DBs in a project.
LIST EXTERNAL
Lists DBs which are being shared from another project.
LIST MACROS
Lists inter-db connection macros.
LIST AREA 51
Lists DBs in Project Area 51.
LIST AUTHUSER
Lists Windows NT authenticated users.
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 ----------------------------------|
| |
|--- AUTHUSERS ---------------------------------|
| |
‘--- WORKing EXTracts --+----------.- FOR user -+--->
| |
‘- dbname -’
Related Commands:
QUERY
Function:
Loads the reference number index from the given file.
Examples:
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:
Related Commands:
DUMP, REINIT, XREF
Function:
Locks the Project Database and prevents any other user from entering the database until
the project is unlocked.
In a Global Project, a Project Database can be locked remotely from the Hub.
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
ocks 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:
Related Commands:
UNLOCK
Querying:
Function:
Make a standard Project into a Global Project.
Description:
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.
Note: 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.
For details of Global Project Administration, see the AVEVA PLANT DESIGN Global User
Guide.
Examples:
MAKE GLOBAL
Command Syntax:
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:
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:
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.
Example:
MAXWARNINGS 100
Related Commands:
MODE, MAXERRORS
Command Syntax:
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 a Global project, a merge on an extract database also requires its child extracts to be
primary at the same location.
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.
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:
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 Notes on Syntax
Graphs, 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.
Related Commands:
BACKTRACK, REVERT, REMOTE
Querying:
Q SESSION
Function:
Sends messages to other users.
Description:
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:
Querying:
LIST MESSAGE
Related Commands:
DELETE MESSAGE,
REMOTE MESSAGE (Global Projects only)
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:
MAXERRORS
Command Syntax:
Function:
Creates an entry for a module in the System DB.
Description:
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.
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.
Examples:
Module 78 DESIGN
Security Free
Mode DESI Default
Mode PROP R
Mode CATA R
Mode DESI RW
Resume /%PDMSEXE%/des
Command Syntax:
.--------------------------.
/ |
>--- Open ---*--- ATTLIB filename --------|
| |
|--- SYMBOLFILE filename ----|
| |
‘--- MESSagefile filename ---+-->
Related Commands:
LIST MODULES, DELETE MODULES, EDIT
Querying:
.----------------.
/ |
>--- Query MOdule ---*--- integer ------|
| |
‘--- module_name --+---
Function:
Moves a DB to a different directory.
Description:
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:
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:
Command Syntax:
Related Commands:
CNAME, CHANGE, INCLUDE, EXCLUDE
Function:
Create an ADMIN element.
Description:
This command is used:
• In any Project, to create Roles, Scopes, Teams, DB Sets and MDBs and other
elements. In a Global Project, Roles and STAMPS can only be created at the Hub.
Roles, PEROPs , STAMPS and Teams must be created in the global database.
• At the Hub of a Global project, to create the Global elements of Locations, Location
Groups and Communication Events (LCOMDs).
Note: After creating the above elements, you will need to set their attributes.
Related Commands:
CREATE
Function:
Creates a new stamp element.
Description:
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:
Command Syntax:
.--------<---------.
/ |
>-- NEW --+-- STLST --*-- STLSF /*dbname --'--+-- STSESS dbname ---.
| | |
| ‘ |
| |
‘-- STAMP /stampname ------------------------------------+--->
Related Commands:
BACKTRACK, MERGE CHANGES, REVERT
Querying:
Function:
Checks that the communications link to named Location exists.
Description:
A round-trip time will be displayed.
Example:
PING LON
Checks that communications link to Location LON exists.
Command Syntax:
Note: This command is now also available in other modules, such as DESIGN andDRAFT.
Related Commands:
Q COMMS
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 location’s 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.
Examples:
PREVOWNER HUB
PREVOWNER dbname
PREVOWNER SYSTEM AT <loc>
Command Syntax:
Related Commands:
HUBLOCATION, SYSTEMLOCATION, CHANGE PRIMARY
Querying:
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.
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.
Function:
Adds descriptive information to project definitions, sets project sub type i.e. Plant/Marine.
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:
NUMBER 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.
In Marine projects, the Project numbers should match the 8-character project identifier a
defined by %ABC000ID%.
Examples:
The type parameter can be used to change the project sub type from between Pant and
Marine. Since the transition is one-way, another command must be invoked first in order to
activate the project type changing capability. An advisory message is displayed after the
activation command.
PROJECT TYPE ALLOWCHANGE
(1,340) It is now possible to convert the current project to
Marine. Note: there is no way to reverse this action
PROJECT TYPE MARINE
The rationale for the distinction between Plant and Marine, as based on the constituent
database sub types, is to restrict access to data from inappropriate modules. To enforce
these restrictions checks are made at the database access layer to restrict access to data
according to the subtype of the database and the family of the currently working modules.
No indication is given that a read-only restiction applies when accessing a Plant database
from a Marine module. Any attempt to modify data will return an appropriate “read only”
error notification
The following error text is displayed when an attempt is made to access a Plant database
from a Marine module. This typically appears when loading an MDB that contains a Plant
database; in this case the MDB open will also fail, returning the user to the Montor, or
preventing the user from leaving “MDB mode”
(43,67) Unable to access Plant database MAS/CATA from a Marine
module
Command Syntax:
Querying:
Function:
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.
Description:
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.
Examples:
Command Syntax:
Related Commands:
TRANSFER
Function:
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
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 HCCNT
At a DB element, gives the extract list changes count. This value increases when
extracts are inserted or removed.
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 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.
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 project lock at location LON.
Q PROJ LOCK AT LON
Returns the project lock at location LON
Q REMOTE LON SAMPLE/DESI FILEDETAILS
Returns details of the latest session number, compaction number and other file
details for the database at the specified location. These details are used by the
Global daemon when sending a database update, and can be useful when
analysing the progress of scheduled updates.
Q REMOTE LON SAMPLE/DESI LASTSESSION
Returns Session information for the last session of the specified database at the
specified location. The output is equivalent to that from Q SESSION SAMPLE/
DESI at the current location. Note that it is not possible to query sessions other
than the latest at a remote location.
Note: Q COMMS, Q ISOLAT and Q PROJ LOCK are now available in other modules
such as DESIGN
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.
Command Syntax:
Related Commands:
LIST, Q REMOTE
Function:
Defines the part of the database to be copied from the source DB to the destination DB
before reconfiguration.
Description:
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.
Command Syntax:
.-------------<----------------.
/ |
>- RCFCopy --*- ALL ------------. |
| | |
|- CATalogue ------| |
| | |
|- SPECifications -| |
| | |
|- name -----------| |
| | |
‘- refno ----------+-- AND ------|
| |
|-- comma ---’
|
‘- INto -+- name --+-ALLCONnections-.
| | |
‘- refno -+----------------+->
Querying:
Q COPIES
Related Commands:
FROM, TO, RECONFIG
Function:
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
pdates 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:
Related Commands:
RECONFIGURE
Function:
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:
Function:
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.
Description:
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.
• 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.
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 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 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:
Related Commands:
FROM, TO, RCFCOPY,
RENEW (Global project only)
Function:
Recovers data when a database has been corrupted.
Description:
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.
Examples:
The examples are based on the following configuration:
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
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.
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.
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.
Command Syntax:
Function:
Re-initialises the reference number index.
Description:
Re-initialises the reference number index in database reconfiguration.
Command Syntax:
Related Commands:
DUMP, LOAD
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.
• 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 non-propagating, later
sessions will be merged). REMOTEºMERGE 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
REMOTEºMERGE 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.
• However, extract databases cannot usefully be checked in isolation (using CHECK
FILE), since access to the extract owner is required. This means that REMOTE
CHECK cannot be used on Extract databases other than the extract master.
• You can also query information about the project status at a Satellite. See Querying
below.
• REMOTEºEXPUNGE 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.
• REMOTEºMERGE and REMOTEºBACKTRACK are not valid for extracts which own
other extracts. However, REMOTEºREVERT and REMOTEºEXPUNGE can be used. A
database that owns extracts can be merged in PDMS using the MERGE command.
Examples:
For details of time and date syntax, see Notes on Syntax Graphs.
BACKTRACK
REVERT
MERGE CHANGES
EXPUNGE
DICE Checking
Cancelling commands
Command Syntax:
For details of <loc> and <when> syntax, see Notes on Syntax Graphs.
Related Commands:
CANCELCOMMAND, REMOTEMESSAGE, MERGE, REVERT, BACKTRACK, EXPUNGE,
CHECK
Querying:
Remote database session information can be queried using the Q REMOTE command:
The success of database updates may be monitored using these queries. These allow
comparison of the state of the database at different locations.
Where <dbname> can be one of:
• GLOBAL
• SYSTEM
• SYSTEM FOR LOCAL
• SYSTEM FOR <loc>
Information about remote users of PDMS may be queried using remote session objects. For
example:
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 REMOTE…EXPUNGE.
For more information about PML Objects see the Plant Design Software Customisation
Reference Manual. Only these three session methods are available for remote sessions.
Function:
Sends messages to users at other Locations.
Examples:
Command Syntax:
Related Commands:
MESSAGE, LIST MESSAGE
Function:
Removes the specified DB from the MDB.
Examples:
REMOVE SERV/AREA-D
Command Syntax:
.------------.
/ |
>-- REMove dbname ---*--- dbname ---’
|
‘-------------------->
Related Commands:
ADD, REMOVE, CURRENT, DEFER
Function:
Deletes a transaction database and creates a fresh version.
Description:
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 PDMS.
The RENEW command is not recorded in the transaction database.
Examples:
Command Syntax:
Related Commands:
RECONFIGURE, RECOVER
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:
Function:
Repairs the System database, to remove deleted global elements including deleted
databases.
Note: you will not be prompted to carry out a Repair as a result of the system finding de-
allocated databases. This results from using DEALLOCATE with the KEEPMDBS
option.
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 REPAIR - required - Returns an integer indicating the number of illegal entries in the
System database.
Examples:
Q REPAIRREQUIRED
REPAIR
REPAIR CHECKONLY
REPAIR NOCHECK
Command Syntax:
Related Commands:
DEALLOCATE
Function:
Saves the project in a file so it can be replicated.
Description:
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.
Before you run the macro to recreate the project structure, you must ensure that suitable
project variable have been defined. 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).
REPLICATE F123
In this case the long project identifier (%ABC000ID%) has been specified. This will
replicate to the underlying project path of which this variable is associated, i.e the
path that %ABC000% maps to.
Note: 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.
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 pseudo-attribute provided for the purpose of generating a new uid
value for ADUUID.
/*GL
!N=NEWUID
ADUUID=$!N
Function:
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:
Command Syntax:
Related Commands:
XREF, LOAD, RCFUPDATE DB
Function:
Allows you to restore a database to a previous session.
Description:
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:
Command Syntax:
Related Commands:
BACKTRACK, MERGE CHANGES,
REMOTE REVERT (Global project only)
Function:
Updates the System database.
Description:
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:
Related Commands:
GETWORK, FINISH
Function:
Sets the current administrative element.
Description:
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:
Command Syntax:
Querying:
Related Commands:
CREATE, ADD, DADD
7.3.83 SORTALLOCATE
Function:
Re-orders database extracts in a database allocation list
Description:
Re-orders database extracts in a location’s allocation list into the correct extract order, so
that extract children follow the parent extract. This affects the order in which database
updates are sent.
Note: This command does not sort the order of unrelated databases. It is up to the system
administrator to ensure a sensible order.
Examples:
Related Commands:
ALLOCATE, DEALLOCATE, Q DBALL
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 specifies that no statistics are to be gathered during the checking. This is
the default.
Function:
Gives information about your current status and the database to which you have access.
Examples:
An example of output is shown below.
Project:
User: HVAC (75dws52)
Teams: HVAC
MDB: /HVAC
Command Syntax:
Related Commands:
SYSTAT
Function:
Exits from DICE when it is running in stand-alone mode.
Examples:
STOP
Related Commands:
FINISH has the same effect
Command Syntax:
Function:
Updates databases with the changes from another location.
Description:
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.
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.
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.
Command Syntax:
Related Commands:
UPDATE, RECOVER
Function:
Gives information about users accessing the project.
Description:
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.
Examples:
The following is an example of output:
PROJECT SAM
=============
User HVAC (75d-sg52)
Name au (A.User)
Host sg52
Entered 14:37 10 Sep
Module DESIGN
MDB /HVAC
DB MODE
HVAC/DESI RW
HVAC/PADD R
HVAC/CATA R
MASTER/IPECATA R
ASTER/STLCATA R
MASTER/HVACCATA R
MASTER/SUPPCATA R
MASTER/PADD R
MASTER/DICT R
MASTER/PROP R
User HANGER (3c41-sg107)
Name an (A.N. Other)
Host sg107
Entered 14:39 10 Sep
Module DRAFT
MDB /HANGERS
DB MODE
HANGERS/DESI R
HANGERS/PADD RW
HANGERS/CATA R
ASTER/PIPECATA R
MASTER/STLCATA R
MASTER/HVACCATA R
MASTER/SUPPCATA R
MASTER/PADD R
MASTER/DICT R
MASTER/PROP R
2 user(s) listed
You can restrict the output to information about the user, host, module or MDB as shown in
the following examples:
Command Syntax:
Function:
Changes the Administering Location of a Satellite.
Description:
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:
Command Syntax:
Related Commands:
ADMINISTER, PREVOWNER SYSTEM
Querying:
At a Location, shows the previous primary location until the SYSTEMLOC command has
completed. This attribute is normally unset.
Function:
Adds users to the Set (i.e. Current) team.
Examples:
TADD SJC
Add user SJC to the current Team.
Command Syntax:
.------<-----.
/ |
>--- TADD userid ---*--- userid ---’
|
‘----------------->
Related Commands:
TREMOVE, SET
Function:
Terminates Alpha file.
Examples:
TERM
Terminates alpha file and outputs reports to screen. Thissyntax is equivalent to
ALPHA FILE END
Command Syntax:
Related Commands:
ALPHA
7.3.92 TO (Reconfiguration)
Function:
Specifies the destination database for reconfiguration.
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 location’s 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.
Command Syntax:
Related Commands:
FROM, RCFCOPY
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.
Description:
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 project_loc where project is
the 3-character project code and loc is the 3-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: ABC_SYD
At SYD: ABC_CAM
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.
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:
Function:
Removes users from the Set (i.e. Current) team.
Examples:
TREM SJC
Removes user SJC from the current Team.
Command Syntax:
.-----<------.
/ |
>--- TREmove userid ---*--- userid ---|
|
‘--------------+--->
Related Commands:
TADD, SET
Function:
Reconfigures the TrueType font definition.
Description:
Used to change the attributes of the TrueType font element (TTFONT), that has previously
been created using the NEW TTFONT command.
For a description of these attributes, refer to Administator User Guide.
Examples:
Command Syntax:
.-----------<----------.
/ |
>--- TTDONT integer ---*-- DESCRiption text ----|
| |
|-- FACE text -----------|
| |
‘-- RENUMBER integer ----+-->
Querying:
Q FONTS
Displays information about all fonts configured in the system.
Q FONTS WIGWAM
Displays information about the native (WIGWAM) fonts only.
Q FONTS TRUETYPE
Displays information about TrueType fonts only.
Related Commands:
Function:
Unlocks all locked databases.
Note: Locking and Unlocking commands are not recorded in the transaction database.
Examples:
UNLOCK
Unlocks all locked databases
UNLOCK AT LON
Unlocks all locked databases at Location LON.
Command Syntax:
Related Commands:
LOCK
Querying a Standard (non-global) Project:
Function:
Updates the current location and an immediate neighbour.
Description:
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-to-date 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 Structure of the Global Database.
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.
Updates of individual databases obey network routing. The database will be synchronised
with the database at locations on the route to the primary location; and updated with the
database on the route from the primary location to the destination.
Both Locations (and any intermediate locations) must be on-line.
Note: This command should be used with caution, since it may result in Reverse
propagation errors at intermediate locations,
Command Syntax:
Related Commands:
SYNCHRONISE
Function:
Produces macros to upgrade a project to a new version of PDMS.
Examples:
Command Syntax:
.---<------.
/ |
>--- UPGrade macro1 macro2 ---+-- FOReign --*-- dbname --’
| |
‘-------------+--- ALL -----.
| |
‘-------------+--->
7.3.99 USERADD TO
Function:
Add PDMS users to the Window NT authenticated user. Also allows the specified PDMS
user to be the default PDMS username for the Windows NT authenticated user.
Examples:
Command Syntax:
Related Commands:
LIST AUTHUSER, USERREM/OVE FROM, AUTHUSERREMOVE, CREATE AUTHUSER,
AUTHENTICATION
Function:
Removes the specified PDMS users from the Windows NT authenticated user.
Example:
Command Syntax:
.------------.
/ |
>- USERREM/OVE -- FROM --- authuser --+-- username --.
|
‘--->
Related Commands:
LIST AUTHUSER, USERREM/OVE FROM, AUTHUSERREMOVE, CREATE AUTHUSER,
AUTHENTICATION
7.3.101 VB (Reconfiguration)
Function:
Gives very brief output for pass 2 reconfiguration.
Examples:
A short example of very brief output is shown below. Compare with the brief output shown in
the BRIEF command.
***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
Function:
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:
Related Commands:
RESETXREFS, DUMP, UPDATE DB
Certain ADMIN functions such as Copy, Reconfigure, Delete may act on the drawing files
associated with DRAFT or SCHEMATIC databases. The administrator may need to know
details of these if there is a problem.
Drawing files are stored using a strict naming convention. The elements used to build the
file are illustrated below:
Prefix
The prefix is dependant on the file type, the following options are available.
Ref No
The Ref No is dependant on the file type, the following options are available:
Extract file
The extract file number from which the Drawing was saved.
Version
The version number when the Drawing was saved.
Page Prefix
The Page number prefix part of the file name is only used when dealing with SVG files.
Page No.
Number of pages per Schematic Diagram. Only used when dealing with SVG files.
File Suffix
The file name suffix is dependant on the file type, the following options are available.
Drawing files are stored in a folder defined by an environment variable. In the case of Draft
drawing files see table below the file is stored in a numbered sub-folder is determined by the
database reference (Module 32 of the second component of the reference).
Q DRFILE Default drawing file name for element (for SVG files, for
highest number file)
Splitting of Folders
When the number of files in a folder becomes huge, the performance of the Microsoft
Windows file system can suffer. Some folders in the AVEVA PDMS project folder structure
are especially susceptible to this negative effect:
These folders have been split by creating 32 subfolders numbered '00', '01', …, '31', and the
files, that were previously stored in the main folder, now are spread among the subfolders
using an algorithm, that guarantees the most even distribution of files. As a result, the
number of files in a single subfolder will be significantly lower, improving the file system
performance. The formula for determining the subfolder is:
subfolder number = DBREF[2] modulo 32
where DBREF[2] is the second element of the DB reference of the picture element.
For example: A sheet in the BAS project having the DB reference =15773/4101, extract file
number (EXFI) 16, and picture version number (PVNO) 25.
The associated picture file path would be:
/%BASPIC%/05/M15773-4101-16-25
where the file name itself is built from the DB reference, the EXFI and PVNO attribute
values, as in previous versions, but the subfolder number (05) has been derived by the
formula:
4101 modulo 32 = 5
Assuming, that the DB references are allocated sequentially, we can then expect an even
selection of the subfolder for the picture files. Some features of the implemented algorithm:
• If the DB reference does not change, the subfolder number also stays the same.
• Creation of the new version of the picture, or modification of this picture from an extract
will change the EXFI or PVNO attribute values, but the reference would stay the same,
thus preserving the selected subfolder number.
• If the picture element is removed, and then later recreated (e.g. from a DATAL
transfer), it may get assigned a different DB reference, than originally, thus getting
possibly a different subfolder for its picture file.
All existing Admin functions, including purging picture files, copying or deleting DBs,
creating or replicating projects, etc., are aware of the new folder structure. In order to
facilitate the handling of the subfolders and the files therein, the following pseudo-attributes
have been implemented.
PICF/ilename returns the path to the AVEVA PDMS Draft picture file for
the current picture element
PDWGF/ilname returns the path to the AVEVA Final Designer file for the
current picture element
DWGF/ilename returns the path to the temporary AVEVA Final Designer file
for the current picture element
As compared to the folder structure valid for previous versions, the new layout looks as
follows:
Index
A D
Attributes Data Integrity Checker (DICE) . . . . . . . . 2:1
non-reference DAtaBAse CONtrol program (DABACON) 3:1
handling of during reconfiguration 3:1, Database Description Languages (DDLs) 3:1
3:3 Database Structure
reference Elements and their Attributes . . . 4:1, 5:1
handling of during reconfiguration 3:1, Global Database . . . . . . . . . . . . . . . 4:6
3:3 Transaction Database . . . . . . . . . . . 5:1
Destination database
B for reconfigure operations . . . . . 3:1, 3:2
DICE
Binary-format files . . . . . . . . . . . . . . . . . 3:20 Exiting . . . . . . . . . . . . . . . . . . . . . . . 2:1
BRIEF command . . . . . . . . . . . . . . . . . . . 3:7 Reports . . . . . . . . . . . . . . . . . . . . . . 2:2
Brief output mode . . . . . . . . . . . . . . . . . . 3:7 Setup Options . . . . . . . . . . . . . . . . . 2:1
Starting up . . . . . . . . . . . . . . . . . . . . 2:1
C User Message File . . . . . . . . . . . . . . 2:1
DUMP command . . . . . . . . . . . . . . . . . 3:11
Character-format files . . . . . . . . . . . . . . 3:20
Commands
E
Detailed Descriptions . . . . . . . . . . . . 7:3
Reconfiguration . . . . . . . . . . . . . . . . 3:2 Elements
Summary in Functional Groups . . . . 6:1 DB (Database) . . . . . . . . . . . . . . . . . 4:8
Syntax Graphs . . . . . . . . . . . . . 7:1, 7:2 DBALL (Location DB List) . . . . . . . 4:13
Communications elements DBLI (Database List) . . . . . . . . . . . . 4:8
LCOMC (Admin Daemon Config) . . . 4:3 DBLOC (DB Location) . . . . . . . . . . . 4:9
LCOMD (Comms Link Details) . . . . . 4:4 GRP (Group) . . . . . . . . . . . . . . . . . 4:11
LCOML (LCOMD Elements List) . . . 4:3 GRPLI (Group List) . . . . . . . . . . . . 4:11
LCTIMD (Event Timings) . . . . . . . . . 4:6 LNK (Links) . . . . . . . . . . . . . . . . . . 4:14
LCTIML (Event Timer) . . . . . . . . . . . 4:5 LNKLI (Link List) . . . . . . . . . . . . . . 4:13
LEVENL (Time Interval) . . . . . . . . . . 4:5 LOC (Location) . . . . . . . . . . . . . . . 4:11
Copies of databases . . . . . . . . . . . . . . . . 3:8 LOCLI (Location List) . . . . . . . . . . . 4:11
Copy list (for reconfiguration) . 3:2, 3:4, 3:11 PEROP (Perops) . . . . . . . . . . . . . . 4:10
ROLE (Role) . . . . . . . . . . . . . . . . . . 4:9
TEAM (Team) . . . . . . . . . . . . . . . . . 4:7
Errors R
reconfiguration
controlling limit of for output . . . . 3:8 RCFCOPY command . . . . . . . . . . . . . . . 3:4
ERRORS command . . . . . . . . . . . . . . . . 3:8 RCFUPDATE command . . . . . . . 3:10, 3:11
Reconfiguration . . . . . . . . . . . . . . . . . . . 3:5
Extracts . . . . . . . . . . . . . . . . . . . . . 3:21
F Projects . . . . . . . . . . . . . . . . . . . . . 3:20
FROM command . . . . . . . . . . 3:3, 3:13, 3:20 same references . . . . . . . . . . . . . . . 3:5
FULL command . . . . . . . . . . . . . . . . . . . 3:7 Transaction Database . . . . . . . . . . 3:24
Full output mode . . . . . . . . . . . . . . . . . . . 3:7 RECONFIGURE command . . . . . . . . . . 3:4
RECONFIGURER . . . . . . . . . . . . . . . . . 3:1
Reference attributes . . . . . . . . . . . . 3:9, 3:10
G
Reference number index . . . . . . . . . . . 3:10
Global Commands . . . . . . . . . . . . . . . . . 1:1 listing . . . . . . . . . . . . . . . . . . . . . 3:5, 3:7
Groups loading from file . . . . . . . . . . . . . . . 3:11
reconfiguring . . . . . . . . . . . . . . . . . . 3:13 saving to file . . . . . . . . . . . . . . . . . . 3:11
References
I between databases . . . . . . . . . . . . . 3:9
Relevant User Guides . . . . . . . . . . . . . . 1:1
INCLUDE command . . . . . . . . . . . . . . . 3:11 REPLICATE command . . . . . . . . . . . . . 1:1
Index RESETXREFS command . . . . . . . . . . 3:14
of reference numbers . . . . . . . . . . . 3:10 Root element . . . . . . . . . . . . . . . . . . . . 3:11
Intermediate files . . . . . . . . . . . . . . . 3:1, 3:3
Isodraft files . . . . . . . . . . . . . . . . . 4:5, 7:117 S
M T
Manual Content . . . . . . . . . . . . . . . . . . . . 1:1 TO command . . . . . . . . . . . . 3:4, 3:13, 3:20
Messages . . . . . . . . . . . . . . . . . . . . . . . 3:17 Transaction elements
TRDAY (Command Date Day) . . . . . 5:3
O TRFAIL (Transaction Failure) . . . . 5:11
TRFLST (Transaction Failure List) 5:11
Offline location 4:5, 4:11, 6:3, 7:8, 7:16, 7:17, TRINCO (Transaction Incoming Command)
7:27, 7:37, 7:49, 7:55, 7:56, 7:58, 7:76, 5:3
7:79, 7:107, 7:111, 7:114 TRLOC (Transaction Location) . . . . 5:3
Output TRMESS (Transaction Message) . 5:11
controlling . . . . . . . . . . . . . . . . . . . . . 3:7 TRMLST (Transaction Messages List) 5:11
TRMONT (Command Date Month) . 5:3
P TROPER (Transaction Operation) . . 5:9
TROUCO (Transaction Output Command)
PADD databases 5:6
treatment of when reconfiguring . . . 3:12 TRSLST (Transaction Success List) 5:11
Picture files TRSUCC (Transaction Success) . . 5:11
treatment of when reconfiguring . . . 3:12 TRUSER (Transaction User) . . . . . . 5:3
Plot files . . . . . . . . . . . . . . . . . . . 4:5, 7:117 TRYEAR (Command Date Year) . . . 5:3
Programmable Macro Language (PML) . 1:1
Projects
U
transferring data between . . . . . . . . 3:13
upgrading . . . . . . . . . . . . . . . . . . . . 3:14 Upgrade macros . . . . . . . . . . . . . . . . . . 3:15
V
VB Command . . . . . . . . . . . . . . . . . . . . . 3:7
Very Brief output mode . . . . . . . . . . . . . . 3:7
W
World elements
GLOCWL (Global Location) . . . . . . 4:10
GROWL (Global Role) . . . . . . . . . . . 4:9
GSTAT (Global Status) . . . . . . . . . . 4:7
GSTWLD (Global Stamp) . . . . . . . . 4:14
GTMWL (Global Team) . . . . . . . . . . 4:7
LCOMW (Communications) . . . . . . . 4:3
STAT (Project Status) . . . . . . . . . . . 4:3
TRMSGW (Transaction Message) . . 5:2
X
XREF command . . . . . . . . . . . . . . . . . . 3:14