Administrator Command Reference Manual

Administrator Command Reference Manual

AVEVA Solutions Limited

Disclaimer 1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from viruses. 1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence) or otherwise. 1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's claim is brought. 1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law. 1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under which the AVEVA software was purchased, the clauses in the software licence shall take precedence.

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, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries. All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires that this copyright notice, and the above disclaimer, 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 Limited. The user may not reverse engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this publication may be incorporated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution. The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms and conditions of the respective software licences, and in accordance with the relevant User Documentation. Unauthorised or unlicensed use of the software is strictly prohibited. © Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall not be liable for any breach or infringement of a third party's intellectual property rights where such breach results from a user's modification of the AVEVA software or associated documentation. AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

Trademark AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden. AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiaries, registered in the UK, Europe and other countries (worldwide). The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or logo belongs to its respective owner.

Administrator Command Reference Manual

Revision Sheet

Date

Version

September 2011 12.1.1

Comments / Remarks Linewidths example added under Query section. Dabacon Buffer Size section incorporated.

January 2012

Copyright added to all pages.

January 2013

Intellectual Property incorporated.

January 2013

12.1.SP4

Rights

(IPR)

Protection

Additions to chapter 7.3.54 Merge Changes.

changes

Administrator Command Reference Manual

Administrator Command Reference Manual

Administrator Command Reference Manual Contents

Page

Reference Manual Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1 Macros

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Stand-Alone DICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 DICE Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 DICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2: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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Source Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Destination DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying What Will be Copied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the Reconfiguration Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of a Simple Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3:2 3:3 3:4 3:4 3:4 3:5

Using the SAMEREF Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5 Using the SESSIONS Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6 Listing the Reference Number Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

i

12 Series

Administrator Command Reference Manual

Global Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7 Controlling RECONFIGURER Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7 Copies and Reconfigured Copies of DBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8 Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8 Reconfigured Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Advanced Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9 References Between Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9 Updating References into a Reconfigured Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10 Saving the Reference Number Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11 Copying Parts of Databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11 Copying Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13

Transferring Data Between Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13 Upgrading a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:14 Reconfiguration Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17 Standard Information Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17 General Format of Pass 2 Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:18 Codes Used to Identify Message Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:18

Database Transfers between Computers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:19 Binary and Character Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20 Transfer Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20 Reconfiguring a Global Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20 Reconfiguring Extracts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:21 Outputting Changes Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The SAMEREF Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The SESSIONS Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reconfiguring a Single Extract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reconfiguring a Family of Extracts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The RCFUPDATE Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of Reconfiguring a Three Level Extract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reconfiguring the Transaction Database in a Global Project. . . . . . . . . . . . . . . . . . . . . . .

3:21 3:21 3:21 3:21 3:21 3:22 3:22 3:24

System and Global Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1 Structure of the Local System Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2 Structure of the Global Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

Transaction Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Structure of the Transaction Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

ii

12 Series

Administrator Command Reference Manual

TRMSGW Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2 TRYEAR, TRMONT and TRDAY Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3 TRUSER and TRLOC Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3 TRINCO Element (Input Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3 TROUCO Element (Output Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:6 TROPER Element (Operation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9 TRMLST, TRSLST, and TRFLST Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:11 TRMESS, TRSUCC, and TRFAIL Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:11

Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1 Project Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1 Project Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2 Global Project Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3 Module Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 Font Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 Querying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 General PDMS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5 Data Integrity Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5 Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6

Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1 Conventions Used in the Syntax Graphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1 Notes on Syntax Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 Detailed Descriptions of Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 ACCESS (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4 ACRADD (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4 ACRREM (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5 ADD (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5 ADMINISTER (Global Project Administration - Remote Administration) . . . . . . . . . . . 7:6 ALLOCATE (Global Project Administration - Hub only) . . . . . . . . . . . . . . . . . . . . . . . . . 7:8 ALPHA (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10 AUTHENTICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10 AUTHUSERREM/OVE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:11 BACKTRACK (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:11 BRIEF (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13 CANCELCOMMAND (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

iii

12 Series

Administrator Command Reference Manual

CDESC (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHANGE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHECK (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHECKOPTION (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CNAME (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . COP (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CREATE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CURRENT (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DADD (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DEALLOCATE (Global Project Administration - Hub only) . . . . . . . . . . . . . . . . . . . . . DEFER (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DELETE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DREMOVE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DUMP (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DUPLICATENAMES (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . EDIT (Module definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ERRORFILE (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ERRORS (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EXCHANGE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EXCLUDE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EXPUNGE (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EXTERNAL (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EXTRACT (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FINISH (General PDMS Command). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FONTDIRECTORY (Font definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FONTFAMILY (Font definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FROM (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FULL (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GENERATE (Global Project Administration - Hub only). . . . . . . . . . . . . . . . . . . . . . . . GETWORK (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HUBLOCATION (Global Project Administration - Hub only) . . . . . . . . . . . . . . . . . . . . INCLUDE (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INITIALISE (Global Project Administration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ISOLATION (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LIST (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LOAD (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LOCK (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MAKE GLOBAL (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MAXERRORS (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MAXUSERS (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

iv

7:14 7:15 7:19 7:21 7:24 7:25 7:27 7:33 7:34 7:35 7:37 7:37 7:40 7:40 7:41 7:42 7:44 7:44 7:44 7:45 7:46 7:47 7:49 7:51 7:51 7:52 7:54 7:55 7:55 7:56 7:57 7:58 7:58 7:59 7:60 7:62 7:63 7:64 7:64 7:65

12 Series

Administrator Command Reference Manual

MAXWARNINGS (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:65 MERGE CHANGES (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:66 MESSAGE (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:68 MODE (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:69 MODULE (Module Definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:70 MOVE (Project Administration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:72 NEW (Project definition and Global Project Administration) . . . . . . . . . . . . . . . . . . . . 7:72 NEW STAMP (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:74 PASSWORDLOCK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:75 PING (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:76 PREVOWNER (Global Project Administration - Hub only) . . . . . . . . . . . . . . . . . . . . . . 7:76 PROJECT (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:78 PURGE (Project Administration and Global Project Administration) . . . . . . . . . . . . . 7:80 QUERY (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:80 RCFCOPY (Reconfiguration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:85 RCFUPDATE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:87 RCFUPGRADE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:88 RECONFIGURE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:88 RECOVER (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:89 REINIT (Reconfiguration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:92 REMOTE (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:92 REMOTEMESSAGE (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . 7:98 REMOVE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:99 RENEW (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:100 REORDER (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:101 REPAIR (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:101 REPLICATE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:102 RESETXREFS (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:104 REVERT (Project Administration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:105 SAVEWORK (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:106 SET (Project definition and Global Project Administration) . . . . . . . . . . . . . . . . . . . 7:106 SORTALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:107 STATISTICS (Data Integrity Checking). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:108 STATUSSESSION (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:108 STOP (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:109 SYNCHRONISE (Global Project Administration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:109 SYSTAT (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:113 SYSTEMLOCATION (Global Project Administration - Hub Only) . . . . . . . . . . . . . . . 7:115 TADD (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:116 TERM (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:117

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

v

12 Series

Administrator Command Reference Manual

TO (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TRANSFER (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TREMOVE (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TTFONT (TrueType font definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNLOCK (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UPDATE (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UPGRADE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . USERADD TO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . USERREM/OVE FROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VB (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XREF (Reconfiguration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7:117 7:118 7:120 7:120 7:121 7:122 7:125 7:125 7:126 7:126 7:127

Dabacon Buffer Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 Specifying the Dabacon Buffer Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 Per Module Per Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 Per User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Querying the Amount of Unused Dabacon Buffer . . . . . . . . . . . . . . . . . . . . . . . 8:1 Affect of Setting the Dabacon Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:2

Drawing File Name and Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

vi

12 Series

Administrator Command Reference Manual Introduction

1

Introduction This manual describes the PDMS Administration commands for Standard (non-global) and Global projects. It is written for System Administrators who are already experienced administration 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 Administration for a standard (non-global) project is described in the Administrator 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

1:1

12 Series

Administrator Command Reference Manual Introduction

1.2

How to Use This Manual Stand-Alone DICE

applies to Standard and Global projects and describes how to run the PDMS Data Integrity Checker, DICE, from outside PDMS. This chapter is included in the Command Reference manual as there is no interface to stand-alone DICE, and you will need to enter commands interactively or via a macro.

Reconfiguration,

applies to Standard and Global projects and describes database reconfiguration.

System and Projects

Global

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.

Dabacon Buffer Size

specifies buffer requirements for running a project.

Drawing File and Folders

file name conventions used for Drawing and Picture files during propagation.

Name

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

1:2

12 Series

Administrator Command Reference Manual Stand-Alone DICE

2

Stand-Alone DICE The Data Integrity Checker (DICE) can be run as a stand-alone program outside PDMS. This may be necessary if the System database has been corrupted, and you cannot enter PDMS. Stand-alone DICE is started up using the script named dop, supplied in the PDMSEXE directory. Give the following command, outside PDMS:

$PDMSEXE/dop For a summary of the commands that you can use in DICE, see the Data Integrity Checking commands in Command Summary. Commands to exit from DICE in stand-alone mode are:

STOP FINISH You can send the reports generated by DICE to a named file in your working directory using the ALPHA command.

2.1

DICE Errors PDMS obtains the text of all its user messages from an external file. When DICE is used from within a PDMS project, this file is automatically available, but this is not the case in stand-alone mode. Hence the next command you must give in stand-alone mode is the ERRORFILE command, followed by the name of the error message file. For example:

ERRORFILE /%PDMSEXE%/MESSAGE.DAT Note: This file will contain error messages referring to the operation of DICE itself, not any errors DICE has found during the checking process The default name of the message file can be found from the entry for DICE in the current version of makmac.mac, the project configuration macro.

2.2

DICE Commands Set up the options you require using the following commands (see the appropriate command pages for details): •

ERRORFILE

•

MODE

•

MAXERRORS

•

MAXWARNINGS

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

2:1

12 Series

Administrator Command Reference Manual Stand-Alone DICE

•

STATISTICS

You can send the reports generated by DICE to a named file using the ALPHA command. You can check one or more DB files by using the CHECK command. In this mode, you can only refer to databases by their external filenames rather than by their internal PDMS DB names. Up to ten files may be specified in a single command. Note: The EXTERNAL command cannot be used in stand-alone mode (or by REMOTE CHECK), because only one DB file can be accessed at a time.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

2:2

12 Series

Administrator Command Reference Manual Reconfiguration

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 Database Management System in the Administrator User Guide.

3.1

Reconfiguration Process Reconfiguration is a two-pass operation, acting on either a complete database or on specified parts of one. In the first pass, RECONFIGURER scans a named source database and copies the data for some or all existing elements and their attributes into intermediate files. In the second pass, the contents of the intermediate files are transferred to a specified destination database. This mode of operation has the following features: •

Only existing elements are copied to the intermediate files; deleted items and corrupt data are ignored. The destination database created from these files is therefore both compact and uncorrupted.

•

The reference and non-reference attributes of the elements are held in different intermediate files. The method of transfer of data to the destination database ensures that all referencing is complete and consistent.

•

The source and destination databases may have different DDLs. This enables existing data to be restructured to conform to a new database structure and so, for example, to be used with a new version of PDMS.

•

Reconfiguration can used to transfer a project to different hardware. The intermediate files produced by the first stage can be decoded into a portable format (typically ASCII), and transferred, and then the second stage carried out.

A similar technique is used to convert whole projects to new versions of PDMS, though in this case the intermediate files need not be decoded.

3.2

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

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:1

12 Series

Administrator Command Reference Manual Reconfiguration

proj ABC user SYSTEM/XXXXXX admin You can now start to set up the reconfiguration parameters using the commands summarised in the Command Summary under Reconfiguration.

3.3

Administrative and Querying Commands Some of the general PDMS and querying commands, which are particularly relevant to reconfiguration, are summarised below. SYSTAT

Gives information about the current active status of the project within which you are working.

LIST

Lists project information; there are a variety of options.

SET TEAM

Sets the specified team as the current one.

LOCK, UNLOCK

Locking the System Database prevents any new users entering the project.

MESSAGE

Sends messages to other users.

Q DB

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

Q DB CIVIL/JBX37C CIVIL/ JBX37C DESI NUMBER 6 TVX000/TVX009 MDBS: /LAYOUT /TANKS Q COPIES

FILENAME /

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

Q COPIES CIVIL/JBX37C DB CIVIL/JBX37C HAS COPIES: CIVILl/JBX47C Q MDB

Lists the DBs in the specified MDB.

Q TEAM

Lists the users who are members of the specified team plus a list of the DBs owned by the team.

Q SET TEAM

Gives the name of the currently set team if any.

Q LOCK

Shows whether the project is locked.

3.4

Basic Reconfiguration

3.4.1

Reconfiguring a Single Database The simplest reconfiguration involves a single DB which has no references into it from other DBs; for example, a Design DB which has no associated Drawing (PADD) DBs. A simple reconfiguration requires a source and a destination DB. When the process has been completed, the source DB will remain unchanged, and the destination DB will contain a compacted copy of the parts of the source which were specified in the copy list.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:2

12 Series

Administrator Command Reference Manual 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.

3.4.2

Specifying the Source Database The source of the data to be copied is specified using the FROM command. Some examples of the use of FROM are: Examples:

FROM DB STEELS/STEELS Source data is in database STEELS/STEELS in current project

FROM PROJECT XXX STEELS/STEEL Source data is in specified DB in project XXX

FROM DBFILE /abc016 Source data is in specified file (assumes project directory is current directory)

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:3

12 Series

Administrator Command Reference Manual Reconfiguration

3.4.3

Specifying the Destination DB The destination of reconfigured data is specified using the TO command. Some examples of the use of TO are: Examples:

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

TO NEW HVAC/HVAC DBNO 777 Reconfigured data to go to new database USERM/DESIGN, number 777, in current project

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

3.4.4

Specifying What Will be Copied The RCFCOPY command specifies which parts of the source DB are to be copied to the destination. Most commonly a whole DB is reconfigured, using the command option:

RCFCOPY ALL The RCFCOPY ALL command copies all elements in the list part of the World element of the source DB into the World element of the destination DB. World itself is not copied. Parts of a database can be copied by using the RCFCOPY command followed by the name of the element at the top of the hierarchy to be copied. Only elements that can be owned by World, for example, Sites, can be specified. The list of elements specified by the RCFCOPY command becomes the copy list. Note that you must use RCFCOPY ALL if you intend to use the RECONFIGURE SESSIONS command at the next step, as the SESSIONS option is not valid if you only carry out partial reconfiguration.

3.4.5

Starting the Reconfiguration Process The reconfiguration process is started by giving the command:

RECONFIGURE (minimum abbreviation RECON) Messages are output to indicate the successful start and completion of each stage. When the process is complete, all information concerning the source, destination, copy list and the

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:4

12 Series

Administrator Command Reference Manual Reconfiguration

extent of information output is deleted, ready for another reconfiguration operation if required. You must specify the source, destination and copy list for each reconfiguration. The output by default is sent to the screen, but you can send it to a file by giving the ALPHA FILE command, followed by a filename, before reconfiguration. You can use the following options with RECONFIGURE:

3.4.6

•

Use the SAMEREF option to ensure that the same reference numbers are maintained after reconfiguration. See Using the SAMEREF Option, for details.

•

Use the SESSIONS option to ensure that the session information stays the same after reconfiguration. See Using the SESSIONS Option for details.

Example of a Simple Reconfiguration The following command sequence might be used to reconfigure a DB which is not referenced by any other DBs:

FROM DB MASTER/DESIGN TO DB MASTER/DESNEW RCFCOPY ALL RECONFIGURE Note: In practice it would be advisable to use RCFUPDATE and DUMP in the command sequence. See Updating References into a Reconfigured Database and Saving the Reference Number Index. The following messages are typical of the output during a completely successful reconfiguration:

*** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC SITE #32/202 =42/205 Phase one complete - starting phase two *** Pass two completed *** ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 0 Attributes were incorrectly defined 0 Elements were not inserted. See Reconfiguration Messages, for a complete list of output messages.

3.5

Using the SAMEREF Option When a DB is reconfigured, the reference numbers of the elements in the destination DB will be different from the corresponding reference numbers in the source DB. To ensure that

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:5

12 Series

Administrator Command Reference Manual Reconfiguration

the same reference numbers are maintained after reconfiguration, you can use the command:

RECONFIGURE SAMEREF In this case the destination DB number must be the same as the original one. This means that you will have to delete the source database, and create a new one with the same number. The following example illustrates the use of the SAMEREF option:

FROM DB MASTER/DESIGN TO FILE /F1 /F2 RCFCOPY ALL RECONFIGURE DELETE DB MASTER/DESIGN CREATE DB MASTER/DESIGN DESI DBNO nn FROM FILE /F1/F2 TO DB MASTER/DESIGN RECONFIG SAMEREF

3.6

Using the SESSIONS Option When a DB is reconfigured, by default the session information from the source DB is not preserved. To ensure that session information such as the original session comment, session number, username and original date stays the same after reconfiguration, you can use the command:

RECONFIGURE SESSIONS The option is not valid for SYSTEM, or GLOBAL DBs, and is not available for a partial reconfiguration. The following example illustrates the use of the SESSIONS option:

FROM DB CTBATEST/DESI TO FILE /A /B RCFCOPY ALL RECONFIG SESSIONS After reconfiguration, data can be read back in from the file using the existing commands, replacing the original DB data. When reading in data, the DB number and extract number must be the same as the originating DB number and extract number. For example:

FROM FILE /A /B TO DB CTBATEST/DESI RECONFIG The SAMEREF option is assumed when reading the data. If errors occur, the data is not saved. If you want the data saved even if errors occur, use the FORCE option. For example:

FROM FILE /A /B TO DB CTBATEST/DESI RECONFIG FORCE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:6

12 Series

Administrator Command Reference Manual Reconfiguration

3.7

Listing the Reference Number Index When a DB is reconfigured without the SAMEREF option, the reference numbers of the elements in the destination DB will be different from the corresponding reference numbers in the source DB. An index of the reference numbers of elements in the new DB against those in the old DB is automatically created as an essential part of the reconfiguration process. The new reference corresponding to an old reference can be queried using the command:

Q NEWREF refno where refno is the new reference number. The old reference number will be returned. For example:

Q NEWREF #32/202

3.8

=42/205

Global Projects In a Global project, you can reconfigure the System and Global databases. The commands are:

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

FROM GLOBAL RECONFIGURE In both these cases, the existing System or Global databases will be overwritten, so you do not give a TO command. The COPY ALL and SAMEREF options are also implied. In a Global project, you can only give a RECONFIGURE command for a System or Global database if you are at the primary location of the database:

3.9

•

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

•

For a Satellite System database, the primary location may be at the Satellite itself, or it may be at another Satellite, or at the Hub. The RECONFIGURE command reconfigures the currently open System database. At a Satellite, the command can therefore operate either on the local System database, or on another Satellite’s System database which is primary at the local Satellite.

Controlling RECONFIGURER Output You can control the format and extent of the output produced by RECONFIGURER during Pass 2 processing. The commands are:

VB

Very brief output mode

BRIEF

Brief output mode

FULL

Full output mode

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:7

12 Series

Administrator Command Reference Manual Reconfiguration

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

3.10

-1

Copies and Reconfigured Copies of DBs There are two ways of copying a DB in PDMS, which create two different types of copy: copies and reconfigured copies. This section explains the difference.

3.10.1

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

RCFCOPY PIPEA/PIPEA ADMIN/TEST The key features of copies are: •

All copies of DBs have the same DB number. This may be seen by using the LIST FILES command. For example: MASTER/DES

3.10.2

DESI

NUMBER 14

FILENAME /%DRA000%/dra013 UPDATE

PIPEA/PIPEA DESI

NUMBER

2

FILENAME /%DRA000%/dra001 UPDATE

ADMIN/TEST

DESI

NUMBER

2

FILENAME /%DRA000%/dra003 UPDATE

USER/DRAFT

PADD

NUMBER

5

FILENAME /%DRA000%/dra004 UPDATE

•

There is no implied direction of copying. Thus, in the previous example, PIPEA/PIPEA and ADMIN/TEST are each a copy of the other.

•

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

•

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

•

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

Reconfigured Copies A reconfigured copy is one named by the TO DB or TO NEW commands. The key features of reconfigured copies are: •

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:8

12 Series

Administrator Command Reference Manual Reconfiguration

3.11

•

In the reconfiguration process, the destination DB becomes a reconfigured copy of the source DB, but the reverse is not true. The relationship exists in one direction only.

•

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

•

Any given element will have a different reference number in the reconfigured copy from its reference number in the original DB (unless you use the same SAMEREF option).

Advanced Reconfiguration The previous sections in this chapter describe how a single DB can be reconfigured. In a real PDMS project, with many DBs of different types and with reference attributes pointing from one DB to several other DBs, reconfiguration is usually a more complex process. This section describes how one or more DBs can be reconfigured in such an environment. It also describes how part of a DB can be reconfigured, rather than the whole DB. Note: If the SAMEREF option is used, the reconfiguration is much simpler

3.11.1

References Between Databases A DB often contains elements which have reference or reference array attributes which point into other DBs. For example, one Design DB could contain a Branch connected to a Nozzle in another Design DB. The HREF (or TREF) attribute of the Branch would point into the second DB and the CREF attribute of the Nozzle would point back into the first DB. See example below:

HREF /E1-N2

Branch /150-B1

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:9

12 Series

Administrator Command Reference Manual Reconfiguration

3.11.2

Updating References into a Reconfigured Database While a DB is being reconfigured without the SAMEREF option, RECONFIGURER builds up an index of the reference numbers of all elements in the source DB versus their corresponding new reference numbers in the destination DB. The RCFUPDATE command uses this index to check reference pointers in other DBs and update them to point to the correct elements in the reconfigured DB. Examples of the use of this command are: Examples:

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

RCFUPDATE DB MASTER/DESIGN INTERNAL Updates references in DB MASTER/DESIGN for any elements that have been copied with RCFCOPY ALL CONNECTIONS. Use this option with care because it is possible to update a reference that has already been changed by the RECONFIGURE command.

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

RCFUPDATE TEAM USER Updates all references to the reconfigured DB from DBs owned by team USER. Note: The RCFUPDATE command must be given immediately following a RECONFIGURE operation. As the RCFUPDATE command may cause a DB to be written to, you must have Read-Write access to all relevant DBs. The DBs must not be in active use by any other user of the project. Care should be taken when reconfiguring to the same DB number. If you update a DB twice, the resulting reference numbers could be wrong. For example: Old reference

New reference

/VESS1

=123/456

=123/457

/VESS2

=123/457

=123/458

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:10

12 Series

Administrator Command Reference Manual Reconfiguration

3.11.3

Saving the Reference Number Index The RCFUPDATE command is usually given immediately after databases have been reconfigured. The index can be saved to a file when the reconfiguration has been completed; to be used at a later date. The commands are DUMP to save to a file, and LOAD to load a file. For example:

LOAD /DUMP1 FROM DB MASTER/DESIGN TO DB MASTER/DESNEW RCFCOPY ALL RECONFIGURE DUMP /DUMP2 These commands will read an existing reference number index from file /DUMP1, add the reference number pairs from the specified reconfiguration to it, and then write the index out again to the file /DUMP2. If a number of databases have been reconfigured, the dump file will record the crossreference index for all of them. The LOAD command replaces the current index. The command LOAD APPEND appends the table to the current index.

3.11.4

Copying Parts of Databases The RCFCOPY ALL command copies all the elements in the source DB World into the destination DB World. If the World of the destination DB already contains members, then the elements from the source DB are added to these. The RCFCOPY command can be used to define the root elements to be copied. A root element is any element owned by the World, that is:

BLTA

CASW

CATA

CCTA

CMPW

CONW

DEPT

GPWL

LIBY

MATW

RUNW

SITE

SPWL

UNIT

UWRL

When a root element is copied, all elements owned by it are also copied. A maximum of 300 root elements may be specified in a single copy list. The selective commands RCFCOPY CATALOGUE and RCFCOPY 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:11

12 Series

Administrator Command Reference Manual Reconfiguration

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. Setting External References In cases where you have made a partial copy of a database, sometimes it is necessary for you to ensure the external references are correct in the copied elements. For example, if you moved a piping zone to a different database while maintaining the references to an equipment zone which was to remain it the original database, the copied piping zone could have unset external references and the equipment zone would remain connected to the original piping zone. In these cases you can use the ALLCONnections option to set the external references for the reconfigured elements:

RCFCOPY /SITE1 INTO /SITE2 ALLCONNECTIONS This will set all references including those within the original database not in the list of copied elements.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:12

12 Series

Administrator Command Reference Manual Reconfiguration

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.

3.11.5

Copying Groups If a Group World is specified in a RCFCOPY command, only the Group World and its owned Groups are copied. Errors will occur in Phase 2 if the Group members have not be copied as well. It is meaningless to try to reconfigure a group on its own.

3.12

Transferring Data Between Projects RECONFIGURER provides a simple means of transferring data from one project to another, on the same type of computer, provided both projects are running under the same major version of PDMS and provided cross-referencing between DBs is considered logically. The transfer operation in this case requires the use of the FROM FILES and TO FILES options of the FROM and TO commands. In the simplest case, namely the transfer of the contents of a single DB, such as a Catalogue, the following sequence of commands could be used: In the source project: Example:

FROM DB /CATOLD Specify source DB.

TO FILES /TEMP1 /TEMP2 Only pass 1 of reconfiguration to be carried out; partially reconfigured data to be stored in named files.

RCFCOPY ALL RECONFIGURE and in the destination project: Example:

FROM FILES /TEMP1 /TEMP2 Partially reconfigured data to be recovered from named file;

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

RCFCOPY ALL RECONFIGURE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:13

12 Series

Administrator Command Reference Manual Reconfiguration

Note: FREE (i.e. Read/Write) access is required to both projects. If the contents of more than one DB are to be transferred, provided no reference attributes point outside the set of DBs being transferred, an extension of the same procedure could be used. Consider the transfer of the whole of one Design DB, the whole of a Catalogue DB and one item of equipment from a second Design DB, thus: Source DB

Elements Transferred

Destination DB

CIVIL/STRUC4

Whole Design DB

STEEL/MAIN

ANSI/MASCAT

Whole Catalogue DB

CATAL/MAIN

SITE-A

One Site

EQUIP/MAIN

The reconfiguration commands should be given in the following order: In the source project:

FROM DB ANSI/MASCAT TO FILES /REC1A /REC1B RCFCOPY ALL RECONFIGURE

Copies the Catalogue DB first

FROM DB CIVIL/STRUC4 TO FILES /REC2A /REC2B RCFCOPY ALL RECONFIGURE

Copies the Design DB

FROM DB VESSEL/V25CT TO FILES /REC3A /REC3B RCFCOPY /SITE-A RECONFIGURE

Copies the Site

and in the destination project:

FROM FILES /REC1A /REC1B TO DB CATAL/MAIN RECONFIGURE

Creates Catalogue DB

FROM FILES /REC2A /REC2B TO DB STEEL/MAIN RECONFIGURE

Creates Design DB

FROM FILES /REC3A /REC3B TO DB EQUIP/MAIN RECONFIGURE

Creates equipment item

RCFUPDATE DB STEEL/MAIN RCFUPDATE DB EQUIP/MAIN

3.13

Gives correct cross-references

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:14

12 Series

Administrator Command Reference Manual Reconfiguration

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 multiDB 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 Limited, 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:15

12 Series

Administrator Command Reference Manual Reconfiguration

The following is an example of a sequence of commands: 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:16

12 Series

Administrator Command Reference Manual Reconfiguration

Output macro Write ’Upgrading project CJB ’ Write ’From PDMS10 to PDMS11 ’ Write ’Output phase ’ $R6 UPGRADE ON From db STANA/SAPROP To files /REC1A /REC1B Copy all Reconfigure From db DEREKF/DFPROP To files /REC2A /REC2B Copy all Reconfigure From db ALANC/ACPROP To files /REC3A /REC3B Copy all Reconfigure From db TAMH/THPROP To files /REC4A /REC4B Copy all Reconfigure From db TAMH/PROP_ATEST To files /REC5A /REC5B Copy all Reconfigure

3.14

Reconfiguration Messages During the various stages of the reconfiguration process, messages will be output. This is particularly so during Pass 2, in which the data from the intermediate files is used to reconstruct the element hierarchy in the destination DB. In the simplest case these messages will just indicate the start and finish of each phase, and confirm that all elements and their attributes were correctly placed. In a more complex case it is probable that a number of error messages will also be output, indicating potential problems in building up an unambiguous structure in the new DB.

3.14.1

Standard Information Messages The progress-monitoring messages, which indicate the stages reached during the reconfiguration, are self-explanatory. They are:

*** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** : *** Pass two completed *** ***Reconfiguration Completed After the reconfiguration has been completed, a summary of any problems found during Pass 2. This will contain zero values where no problems were found.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:17

12 Series

Administrator Command Reference Manual Reconfiguration

The format of this report is: Integer

Elements were not defined in the DDL

Integer

Elements have been lost

Integer

Elements are no longer named

Integer

Attributes where incorrectly defined

Integer

Elements were not inserted

where integer is the relevant number.

3.14.2

General Format of Pass 2 Error Messages In addition to the standard information messages described above, a range of error messages may be generated during Pass 2. These messages have the general format: CODE TYPE OLDREF NEWREF NAME although some parts of this may be omitted. For example:

EN EQUIP #10/21 =12/12 /NEWNAME #EAE SHEE #88/842 =16/2417 /DR1/S5 *ENID SITE #15/23 The individual parts of the message are:

3.14.3

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

Codes Used to Identify Message Types The coded prefix to each message comprises two parts. The first character is one of the following: •

A space indicates information rather than an error

•

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

•

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

The remaining characters, which give more explicit meaning to the message, are explained in the following subsections.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:18

12 Series

Administrator Command Reference Manual Reconfiguration

Information-only Messages (prefix: space) There are two possible codes:

EC

Element Created

EN

Element Named

These are output as the reconfiguration proceeds and each message ends with the name of the copied element. Error Messages Relating to Elements (prefix: asterisk)

*ENID

Elements Not In DDL

The element could not, therefore, be created. This can occur when the element type is not permitted in the list part of the element above it in the DB hierarchy, for example, if an attempt is made to reconfigure FROM FILES into a DB of the wrong type.

*ENI

Element Not Inserted

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

*EL

Element Lost

Elements in the list part of ones that cannot be created are lost, since they cannot be created either. Error Messages Relating to Attributes (prefix: hash sign) These all begin with

#EAE

Element Attribute Error

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

3.15

Database Transfers between Computers Note: The hardware platforms currently supported allow binary compatibility of databases, and so the information in this section will not usually be needed. RECONFIGURER can be used for the transfer of PDMS DBs between different computers, which may be of different types. Because reconfiguration is a two-pass operation, the data can be copied from one computer and read back into a different one. 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 DESIGN Reference Manual Part 1 (OUTPUT command).

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:19

12 Series

Administrator Command Reference Manual Reconfiguration

3.16

Binary and Character Files Data can be stored in two formats: •

Binary files are in a compact machine-readable form, but are generally specific to a particular type of computer.

•

Character files (which are usually in ASCII code) generally have to be much larger to hold the same amount of information, but are human-readable. Character files can be transferred relatively easily between different types of computers.

PDMS DBs are stored as binary files so that large amounts of data can be held efficiently. RECONFIGURER provides a means to convert PDMS DBs from binary files into character files and vice versa.

3.17

Transfer Process The files used by the transfer process are not the PDMS DBs themselves but the (binary) intermediate files created by Pass 1 of a reconfiguration. These are converted into larger, but easily transportable, character files by the TO FORMATTEDFILES command. The files can then be transferred to the target machine via a communications network or magnetic tape and converted back into Pass 1 temporary file format by the FROM FORMATTEDFILES command. For example: On source machine:

FROM DB MASTER/DESI TO FORM /F1 /F2 RCFCOPY ALL RECONFIG On destination machine:

FROM FORM /F1 /F2 TO DB MASTER/DESI RECONFIG

3.18

Reconfiguring a Global Project We recommend that you use the SAMEREF option when reconfiguring a Global project. We also recommend that there are no users in the database at the primary location when reconfiguring back to the SAMEREF database. Databases can only be reconfigured at their primary locations. Note that when a project database is reconfigured, the database sessions will effectively be lost. Thus the ability for Global to send only session changes is lost as well. When the next update occurs between locations, the entire database will be sent via the Global daemon. This can take some time if the database is large.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:20

12 Series

Administrator Command Reference Manual Reconfiguration

3.19

Reconfiguring Extracts

3.19.1

Outputting Changes Only The default for reconfiguration is that, when reconfiguring an extract, only changes made in the extract are output. To output all elements, as in normal reconfiguration, the keyword FULL must be added to the RECONFIGURE command line. For example:

RECONFIG FULL

3.19.2

The SAMEREF Option The SAMEREF option is always used for extracts. You need not to enter the SAMEREF option; it is assumed. This means that you can not reconfigure to DBs of a different DB number.

3.19.3

The SESSIONS Option The SESSIONS option is always used for extracts. You need not enter the SESSIONS option; it is assumed.

3.19.4

Reconfiguring a Single Extract The procedure for reconfiguring a single leaf extract is as follows: 1. Reconfigure from the DB to a file. 2. REVERT the extract to Session 1. 3. MERGE CHANGES to remove the intermediate session. 4. Reconfigure from the file to a DB. An alternative strategy would be to replace Steps 2 and 3 by a DB deletion and a DB creation. The procedure is similar for single extracts that own other extracts. The only difference is:

3.19.5

•

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

•

The alternative approach of deleting and recreating the extract is not possible unless all child extracts are also deleted and recreated.

•

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

Reconfiguring a Family of Extracts When reconfiguring a whole extract family, the following considerations apply: •

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

•

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

•

Reconfiguring back from files to databases must also be done top-down, and you must complete the reconfiguration for the whole extract. For example, if you reconfigure all three database levels of a three level extract to files but only reconfigure the top two file levels back to databases, the third database will be corrupted due to the reconfiguration of the other two. Refer to Example of Reconfiguring a Three Level Extract for more information.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:21

12 Series

Administrator Command Reference Manual Reconfiguration

•

Before reconfiguring out from a file, refresh the extract.

•

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

For example, given a simple two-level extract containing TEAMA/MASTER, TEAMA/ EXTRACT, the sequence would be: 1. Refresh TEAMA/EXTRACT. 2. Reconfigure TEAMA/MASTER to file /A, /B. 3. Reconfigure TEAMA/EXTRACT to file /C, /D. 4. REVERT TEAMA/EXTRACT to Session 1. 5. MERGE CHANGES on TEAMA/EXTRACT. 6. REVERT TEAMA/MASTER to Session 2. 7. MERGE CHANGES on TEAMA/MASTER. 8. Reconfigure from file /A, /B to TEAMA/MASTER. 9. Refresh TEAMA/EXTRACT (to pick up changes made in Step 8). 10. Reconfigure from file /C, /D to TEAMA/EXTRACT.

3.19.6

The RCFUPDATE Command When the RCFUPDATE command is used on an extract, all affected attributes will be updated regardless of whether or not the element has been claimed to the extract. This means that, if many extracts of the same extract family are updated, the same changes will be made to each of the extracts.

3.19.7

Example of Reconfiguring a Three Level Extract Consider this three-level extract:

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:22

12 Series

Administrator Command Reference Manual Reconfiguration

FROM DB CTBATEST/EXT TO FILE /EXTA /EXTB RCFCOPY ALL RECONFIG SESSIONS FROM DB CTBATEST/EXTBOT TO FILE /EXTBOTA /EXTBOTB RCFCOPY ALL RECONFIG SESSIONS FROM FILE MASTERA /MASTERB TO DB CTBATEST/MASTER RECONFIG FROM FILE EXTA /EXTB TO DB CTBATEST/EXT RECONFIG FROM FILE EXTBOTA /EXTBOTB TO DB CTBATEST/EXTBOT RECONFIG It is not necessary for the reconfiguration back from file to be done within the same session of RECONFIGURER. For example, in a global project where MASTER, EXT and EXTBOT are primary at different locations, then the following sequence could be followed: 1. At location A (primary location for MASTER):

FROM DB CTBATEST/MASTER TO FILE /MASTERA /MASTERB RCFCOPY ALL RECONFIG SESSIONS 2. At location B (primary location for EXT):

FROM DB CTBATEST/EXT TO FILE /EXTA /EXTB RCFCOPY ALL RECONFIG SESSIONS 3. At location C (primary location for EXTBOT):

FROM DB CTBATEST/EXTBOT TO FILE /EXTBOTA /EXTBOTB RCFCOPY ALL RECONFIG SESSIONS Steps 1 to 3, reconfiguring from databases to files, can be done in parallel. 4. At location A (primary location for MASTER):

FROM FILE /MASTERA /MASTERB TO DB CTBATEST/MASTER RECONFIG

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:23

12 Series

Administrator Command Reference Manual Reconfiguration

The user must now propagate the whole database to locations (B) and (C). 5. At location B (primary location for EXT)

FROM FILE /EXTA /EXTB TO DB CTBATEST/EXT RECONFIG The user must now propagate the whole database to locations (C) and (A). 6. At location C (primary location for EXTBOT)

FROM FILE /EXTBOTA /EXTBOTB TO DB CTBATEST/EXTBOT RECONFIG The whole database will be propagated to locations (A) and (B) automatically. Steps 4 to 6, reconfiguring from files to databases, should be done consecutively.

3.19.8

Reconfiguring the Transaction Database in a Global Project The Global Daemon stores most of the commands that it is asked to perform at a location in a transaction database. Each location has its own transaction database. For details, see Transaction Database. If a transaction database becomes corrupt, it may be necessary to reconfigure it. For information about this, refer to Running Global Projects. Note: The daemon for a location must be stopped before reconfiguring its transaction database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

3:24

12 Series

Administrator Command Reference Manual System and Global Projects

4

System and Global Projects 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:1

12 Series

Administrator Command Reference Manual System and Global Projects

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.

4.1

Structure of the Local System Database

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:2

12 Series

Administrator Command Reference Manual System and Global Projects

Note: This means that a report of all Users at every Location in the Project can only be obtained by combining reports from each Location. The TMLI list in the USER element in the Local System database will continue to provide a list of teams to which a user at a particular location belongs. In the same way that a TEAM element no longer maintains a list of users in that team, a DB element in a team does not maintain a list of MDBs to which the DB belongs. The MDB element, in the Local System database keeps a list of DBs belonging to it. The detailed changes to the elements and attributes are described below.

STAT Element This element already exists in the Local System database, but certain attributes have been relocated to the Global System database. The attributes are the same as in a Standard Project with the addition of: Locrf

text(120)

120 character text: current Location Reference

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

Logfn

/filenam

Logms

false

Loglv

0

Log file name

Diagnostic level

LCOML Element The LCOML element contains a list of LCOMD elements, each of which specifies details about the communications link between the current site and one other site, as described below.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:3

12 Series

Administrator Command Reference Manual System and Global Projects

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

Description

unset

120 character text

Locrf

/name

Name of Location which has comms link with current Location

Timer

frequency of update events 120 character text: (See below)

Times

0

Time window start

Timee

2400

Time window end

Timei

30

Interval in seconds between communication attempts

Timeo

10

Number of re-tries

Execb

unset

120 character text: name of script to be run before updates are transferred (optional)

Execa

unset

120 character text: name of script to be run after updates are transferred (optional)

LNoUpd

false

If set TRUE, the scheduled update is disabled. This is useful during certain house-keeping operations such as merging.

The Timer values are: Minutes past the hour

0 - 59

Hours

0 - 23

Days

1 - 31

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:4

12 Series

Administrator Command Reference Manual System and Global Projects

Months

1 - 12

Days of the week

0 (Sunday) - 6

For example: Timer '0,30 * * * *'

specifies every half hour, every day.

Timer '12 10,12,14,16,18 * * 1,5 '

specifies 12 minutes past the hours given, Monday to Friday.

The attributes TIMES and TIMEE are not implemented at this release. Files such as Isodraft external plot files 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: Levenl

5

Time interval for event loop (secs)

Lmerti

Frequency of Automerges. 120 character text:

(settings as for Timer above) Lmersu

3

Time in days after which successful commands should be deleted. The value -1 means no deletion.

Lmerfa

3

Time in days after which failed commands should be deleted. The value -1 means no deletion.

Lmerdl

false

If true, transaction database is merged and purged at specified times.

At times specified by LMERTI, the transaction database will automatically be merged and commands deleted as specified by the LMERSU and LMERFA attributes. The LMERDL attribute must be set to true. For example, the automerge data could be set as follows:

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:5

12 Series

Administrator Command Reference Manual System and Global Projects

•

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

4.2

Name

/name

Description

unset

120 character text

Locrf

/name

Reference to Location communicating with current Location

Lendti

604800

Command timeout period, in seconds (default is 7 days in seconds)

Lmaxtr

100

Maximum number of retries to send command

Ltimei

120

Time interval between retries, in seconds

Structure of the Global Database The Global System database contains Teams, Databases, Roles, Locations and Stamps. Figure 4:1.: Structure of the Global System Database shows the structure of the Global System database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:6

12 Series

Administrator Command Reference Manual System and Global Projects

WORLD World

/*GS GSTAT Global Status World

GRPLI Group List

GRP Groups

/*GL GLOCWL Location World

LOCLI Location List

/*GT GTMWL Global Team World

/*GST GSTWLD Global Stamp World

ROLE Roles

TEAM Teams

STAMP Stamps

PEROP Perops

DBLI DB List

STLST Stamp List

/*GRO GROLW Global Role World

LNKLI Links List

LOC Locations

LNK Links

DB DBs

DBLOC

Figure 4:1.

Structure of the Global System Database

GSTAT Element (GSTAT) Only one /*GS element can exist in the database and it is inherited from the STAT element in the Standard System Database. Attributes Name

/*GS

Lock

false

Owner

/*

Prjnumber

unset

Maxusers

999999

Prjdesc

unset

Charset

-370086

Hccnt

Extract list changes count

Naccnt

Non additive changes count

Clccnt

Change list changes count

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

Project number:

17 character text

Project description 120 character text

4:7

Integer =< 999999

12 Series

Administrator Command Reference Manual System and Global Projects

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

Database List Element (DBLI) Attributes Name

/name

Type

DBLI

Lock

false

Owner

/name

DB Element The DB element owns the list element DBLOC which holds four additional attributes (see DBLOC Element). 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:8

12 Series

Administrator Command Reference Manual System and Global Projects

Lock

false

Owner

/name

Stype

DESI

Fino

n

File number

Area

0

Area number

Daccess

Update

Claimdb

Explicit or Implicit if Daccess is Multiwrite

Description

unset

Proj

unset

Fcpyref

Nulref

Bcpyref

Nulref

Extractno

n

Variant

false

Controlled

false

DBLC

List of locations to which DB is allocated

PRMLOC

Primary Location

ISDRDB

Does DB have drawing files

DBLNKP

The DBLNKP pseudo attribute will return TRUE is both Project and Database have propagation of linked documents enabled.

(except for Foreign DBs, where it is set to the project code)

DBLOC Element Attributes Name

/name

Type

DBLOC

Lock

false

Owner

/name

DB element

Locrf

/name

Name of Primary Location

Prvrf

Name of previous Primary Location (normally unset)

Propg

true

Propagation flag

Picfd

false

Picture file propagation flag

DEALDB

Ref Array Indicates locations where db is being de-allocated

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:9

12 Series

Administrator Command Reference Manual System and Global Projects

Hccnt

Extract list changes count = <999999

Naccnt

Non additive changes count

Clccnt

Changes list changes count

NOLNKP

false

If true propagation of linked documents is disabled for the database.

Global Role World (GROLW) The Global Role World Element stores the ROLE elements in a Global project. Attributes Name

/*GRO

Lock

false

Owner

/*

LACR

false

Sets Data Access Control on or off

Role Element (ROLE) Attributes Name

/name

Lock

false

Owner

/*T

Description

unset

120 character text

Perop Element (PEROP) Attributes Name

/name

Lock

false

Owner

/name

Opcreate

ignore

Opmodify

ignore

Opdelete

Ignore

Opclaim

ignore

Opissue

ignore

Opdrop

ignore

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:10

12 Series

Administrator Command Reference Manual System and Global Projects

Opoutput

ignore

Opexport

ignore

Opcopyfrom

ignore

Eclass

unset

Element Class

Aclass

unset

Attribute Class

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

/*

Aduuid

text

Daemon version string (Project UUID)

Hubrf

/name

Hub Location Reference

Prvrf

Nulref

Previous Hub Reference (normally unset)

NxtHb

Nulref

Next Hub location (normally unset)

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.

GLINKP

false

To enable Link Propagation, the GLINKP attribute must be set to TRUE.

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 Global-tree structure of Locations. Attributes Name

/name

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:11

12 Series

Administrator Command Reference Manual System and Global Projects

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 Databases allocated to the Location. It is implemented as a Dabacon secondary list of DB reference numbers which refer to DB elements under the DBLI list element of TEAM elements. Locations which belong to a Group have an attribute GRPRF holding the reference number of the Group. If this attribute is null then the Location does not belong to a group. LOC elements also possess a LOCRF attribute which points to the parent of the Location. This attribute is used to determine paths between Locations in the proposed tree structure for connecting Locations. In a future implementation, based on a more general graph structure, the LOCRF attribute might either be dropped or used for another purpose. A Location is only recognised as fully initialised when the logical attribute LINIT is true. Other attributes of a Location are described in the following table. The LOC element has the following attributes:

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:12

12 Series

Administrator Command Reference Manual System and Global Projects

Attributes Name

/name

Lock

false

Owner

/name

Description

unset

120 character text

Locid

XXX

3-letter identifier

Rhost

rhost name

host name

Iconn

1

Connection type: 1 = on-line 0 = off-line

Linit

false

Initialisation flag

Grprf

Nulref

Group reference set if Location is added to a Group

Locrf

/name

Parent Location

PRMRF

Primary location of system Database. If unset, (and PRVRF is unset) the Satellite will be administered locally .

PRVRF

Nulref

Old primary location (normally unset)

DEALAL

false

Indicates that ALL DBs are currently being deallocated from this location.

CURLOC

True current Location (available everywhere)

ADMLOC

Currently administered location (available everywhere).

PRMLOC

Primary location of its system db

DBPRIMARY

(ref array) - List of Databases primary at the current location.

LOCPRIMARY

(ref array) - List of Locations primary at the current location.

DBALL

List of Databases allocated to this location.

NoExtCreation

default false

If true, disables the creation of extracts by this location. Extract creation must be done by the Hub (or an authorised administering 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:13

12 Series

Administrator Command Reference Manual System and Global Projects

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

Description

unset

120 character text

LNKRX LINKRY LINKWV

GSTWLD Element Any existing stamps in the standard System database are copied to the Global Stamp World element and deleted from the System database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

4:14

12 Series

Administrator Command Reference Manual Transaction Database

5

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

5.1

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:1

12 Series

Administrator Command Reference Manual Transaction Database

%TRMSG

%TRYEAR

%TRMONT

%TRDAY

%TRUSER

%TRLOC

%TRINCO

%TROPER

%TROUCO

%TRSLST

%TRFLST

%TRSUCC

%TRFAIL

%TRMLST

%TRSUCC

Figure 5:1.

5.2

%TRMESS

%TRFAIL

Structure of the Transaction Database

TRMSGW Element The Transaction Message World element is called /*MS. There is only one such element and it contains elements that store the communication between the daemon, PDMS and other daemons. It owns any number of TRYEAR elements. Attributes NAME

Text

TRSETL

Logical Controls whether Local claim commands are stored

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

/*MS

5:2

12 Series

Administrator Command Reference Manual Transaction Database

5.3

TRYEAR, TRMONT and TRDAY Elements These are organisation elements to allow the commands stored in the transaction database to be grouped by the date on which they were received. Each of these elements only has a single attribute NAME that is of the form: •

Name of %TRYEAR - year number. For example, /2001

•

Name of %TRMONT - as for year, then slash and month. For example, /2001/MAY

•

Name of %TRDAY - as for TRMONT, followed by slash then date. For example, /2001/ MAY/21

TRYEARs own TRMONTs, TRMONTs own TRDAYs and TRDAYs own TRUSERs.

5.4

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

5.5

TRINCO Element (Input Command) The TRINCO element stores the information about an input command issued to the daemon from a user, or another location’s daemon. The information includes the state of processing of the command and is sufficient for the command to be restarted when a daemon is

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:3

12 Series

Administrator Command Reference Manual Transaction Database

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 NAME

text

Not automatically generated

TRCNUM

int

Command number

INCSTA

int

The state of processing of the TRINCO

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

TRLOCL

log

True if command stored directly by PDMS independent of the Daemon

COMSTR

text

Command string USER entered that generate this command, else null

ORILOC[3]

text

Original Location where user issued the command

DESLOC3]

text

Ultimate target - destination location where command will be executed. For some commands this is the destination of subsidiary commands to be sent, not this command itself.

PRVLOC[3]

text

Previous Location which passed the command on to this location (normally the same as the TRLOC element)

AUXLOC[3]

text

Auxiliary location. Often used as a location to send auxiliary commands

SYSLOC[3]

text

Location of administrator when being remotely administered, else NULL

DEPCOU

int

number of other TRINCOs on which this is dependent (always zero)

DEPEND[*]

ref

References of TRINCOs on which it is dependent, (always none)

DEPTYP[*]

log

Type of dependencies - on success or failure

DATECR

date

Date command received and recreated

DATEAK

date

Date sent acknowledgement for command

NACKN

int

Number of times acknowledgement sent

EXTIME[4]

text

Time to execute command (hence allows a delay) -

DATERD

date

Date command made ready (after EXTIME has been reached)

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:4

12 Series

Administrator Command Reference Manual Transaction Database

DATECM

date

Date command completed

DATERP

date

Date reply sent with results of command

NREPLY

int

Number of times reply sent

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

DATEND

date

Date all processing of command finished - acknowledgement of command received, or command cancelled.

NREPAK

int

Number of times reply acknowledgement received

USERST

text

user cancelling the command

TRDBRF

ref

of Database DB element

TRFINO

int

file number of DB element

TREXTN

int

extract number of DB element

TRAREA

int

area number of DB element

TRSTYP

int

filetype of DB element

TRDBNO

int

dbnumber of DB element

TRDACC

int

access type of DB element

INARCO

int

argument count for intargs (args of the command) (defaulted to zero.)

INTARG[*]

int

Command arguments (passed around as a Conformant array)

TRCARG[*]

text

Command argument ‘NAME=X/Y’

TRVISI

log

Visible or not

DESC[256]

text

User description

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:5

qualifiers

space

separated.

e.g.

12 Series

Administrator Command Reference Manual Transaction Database

Values of INCSTA State Attribute and Order of Change

5.6

RECEIVED

The command has been received ready for processing. DATECR is set.

ACKNOWLEDGED

An acknowledgement has been sent off by this daemon. DATEAK is set and NACKN incremented.

STALLED

The command has failed to create its operations and state will later return to ACKNOWLEDGED ready for retry, or to TIMEDOUT.

READY

The command has reached its execute time and is independent. DATERD is set.

COMPLETE

The command has been processed, and results obtained. DATECM is set.

REPLIED

The daemon has sent the results back to the originating location. DATERP is set and NREPLY incremented.

PROCESSED

An acknowledgement for the result received from originating location. DATEND is set and NREPAK incremented.

REDUNDANT

The command will not be executed now due to dependency rules. DATEND is set.

CANCELLED

The command has been cancelled and finished with TRPASS false. DATEND is set.

TIMEDOUT

The command has timed out before creating its operations and finished with TRPASS false. DATEND is set.

TROUCO Element (Output Command) The TROUCO element contains information about an output command to be issued by the daemon to itself, or to the daemon at another location. The information includes the state of processing of the command and is sufficient for the command to be resent when a daemon is restarted. Output commands are generated by an input command when operations are created. They may be destined to be executed at this, or another site.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:6

12 Series

Administrator Command Reference Manual Transaction Database

Attributes NAME

text

Not automatically generated.

TRCNUM

int

Command number of command being sent.

OUTSTA

int

State of processing of the TROUCO.

COMREF

ref

Ref of the TRINCO of this command stored in the receiving location transaction database. This is NULL until an acknowledgement is received.

ORILOC[3]

text

Original Location where user issued the command.

DESLOC3]

text

Ultimate target - destination location where command will be executed. For some commands this is the destination of subsidiary commands to be sent, not this command itself.

PRVLOC[3]

text

Previous Location which passed the command on to this location (normally the same as the TRLOC element).

AUXLOC[3]

text

Auxiliary location. Often used as a location to send auxiliary commands.

SYSLOC[3]

text

Location of administrator when being remotely administered, else NULL.

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.

DEPCOU

int

Number of other TROPERs and TROUCOs on which this is dependent.

DEPEND[*]

ref

References of TROPERs and TROUCOs on which it is dependent.

DEPTYP[*]

log

Type of dependencies - on success or failure.

PREOP

ref

Reference of previous operation which generated this output command as one of its post operations. If no previous operation this is NULL.

DATECR

date

Date command created by owning input command.

DATERD

date

Date command is ready to send after dependencies satisfied.

DATESN

date

Date command sent to destination location.

NRETRY

int

Number of attempts when command was sent.

MAXTRY

int

Number of attempts sending command before command fails.

WAITIM

int

Number of seconds delay between attempts at sending.

ENDTIM

date

Date when command will fail if sending remains stalled.

DATEAK

date

Date acknowledgement received from destination location

NACKN

int

Number of times acknowledgement received.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:7

12 Series

Administrator Command Reference Manual Transaction Database

DATERP

date

Date reply with results received from destination location.

DATERK

date

Date reply acknowledgement sent to destination location

NREPLY

int

Number of times reply received.

MSTEXT

text

Text info set on completion (normally only if failed to generate operations).

TRPASS

log

True if command succeeded, false if failed. This is determined from the result received.

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.

NREPAK

int

Number of times reply acknowledgement received.

USERST

text

User cancelling the command.

TRDBRF

ref

Reference for Database DB element.

TRFINO

int

File number of DB element.

TREXTN

int

Extract number of DB element.

TRAREA

int

Area number of DB element.

TRSTYP

int

Filetype of DB element.

TRDBNO

int

Dbnumber of DB element.

TRDACC

int

Access type of DB element

INARCO

int

Argument count for intargs (args of the command, defaulted to zero).

INTARG[*]

int

Command arguments (passed around as a Conformant array)

TRCARG[*]

text

Command argument ‘NAME=X/Y’

TRVISI

log

Visible or not

DESC[256]

text

User description

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:8

qualifiers

space

separated.

E.g.

12 Series

Administrator Command Reference Manual Transaction Database

Values of OUTSTA State Attribute and Order of Change

5.7

WAIT

The command is waiting until it is independent of any other operation/command. DATECR is set.

READY

The command is independent and ready to be sent. DATERD is set.

STALLED

The command could not be sent. State will later return to ACKNOWLEDGED ready for retry, or to TIMEDOUT.

SENT

The command has been sent acknowledgement. DATESN is incremented.

ACKNOWLEDGED

An acknowledgement has been received from the destination location. DATEAK is set, NACKN is incremented, CMREF is set.

REPLIED

A reply with results has been received from the destination location. DATERP is set, NREPLY is incremented.

COMPLETE

A reply acknowledgement has been returned to the executing location. DATERK, TRPASS, MSTEXT are set. NREPAK is incremented.

STALLED_POSTOP

Post operations could not be created. State will later return to COMPLETE ready for retry, or to TIMEDOUT.

PROCESSED

Any required post operations have been generated using the result of this command. DATEND is set.

REDUNDANT

The command will not be executed now due to dependency rules. DATEND is set.

CANCELLED

The command has been cancelled by owning TRINCO by a user. DATEND is set.

TIMEDOUT

The command has had the number of sends exhausted, or maximum time exceeded. DATEND is set.

and waits for set, NRETRY

an is

TROPER Element (Operation) The TROPER element stores the information about an operation to be executed by the daemon. The information includes the state of processing of the operation and is sufficient for the operation to execute when a daemon is restarted. Operations are generated by an input command when operations and output commands are created.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:9

12 Series

Administrator Command Reference Manual Transaction Database

Attributes NAME

text

Not automatically generated.

TRONUM

int

Operation number of operation to execute. Note this is not a command number.

OPSTAT

int

State of processing of the TROPER:

DEPCOU

int

Number of other TROPERs and TROUCOs on which this is dependent.

DEPEND[*]

ref

References of TROPERs and TROUCOs on which it is dependent.

DEPTYP[*]

log

Type of dependencies - on success or failure.

PREOP

ref

Reference of previous operation which generated this output command as one of its post operations. In none then NULL.

DATECR

date

Date operation created by owning input command.

DATERD

date

Date operation is ready to execute after dependencies satisfied.

DATERN

date

Date operation was started running (executing).

NRETRY

int

Number of attempts to start operation running

MAXTRY

int

Maximum number of retries allowed before failure.

WAITIM

int

Number of seconds delay between attempts at executing.

ENDTIM

date

Date when operation will fail if execution remains stalled.

DATESL

date

Date operation stalled during execution.

DATECM

date

Date execution completed.

MSTEXT

text

Text info set on completion.

TRPASS

log

True if operation succeeded, false if failed.

POPCOD

int

Code for post operation creation function to be run. If none then zero.

DATEND

date

Date all processing of operation finished, all post operations generated, or command cancelled, or command timed out.

USERST

text

User cancelling implemented.

TRVISI

log

Visible or not.

DESC[256]

text

User description.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:10

the

TROUCO

-

may

not

be

12 Series

Administrator Command Reference Manual Transaction Database

Values of OPSTAT State Attribute and Order of Change

5.8

WAIT

The operation is waiting until it is independent of any other operation/command. DATECR is set.

READY

The operation is independent and ready to execute. DATERD is set.

STALLED

The operation could not be executed. State will later return to READY (ready for retry), or to TIMEDOUT. DATESL is set.

RUNNING

The command has started running. DATERN is set, NRETRY is incremented.

COMPLETE

A reply acknowledgement has been returned to the executing location. DATECM, TRPASS, MSTEXT are set.

STALLED_POSTOP

Post operations could not be created. State will later return to COMPLETE ready for retry, or to TIMEDOUT.

PROCESSED

Any required post operations have been generated using the result of this command. DATEND is set.

REDUNDANT

The command will not be executed now due to dependency rules. DATEND is set.

CANCELLED

The command has been cancelled by owning TRINCO by a user. DATEND is set.

TIMEDOUT

The command has had the number of sends exhausted, or maximum time exceeded. DATEND is set.

TRMLST, TRSLST, and TRFLST Elements The TRMLST, TRSLST, and TRFLST elements are organisational elements (Message Lists, Success Lists and Failure Lists respectively): •

Messages (TRMESS) are grouped under Message Lists (TRMLST).

•

Successes (TRSUCC) are grouped under Success Lists (TRSLST) and TRMLST.

•

Failures (TRFAIL) are grouped under Failure Lists (TRFLST) and TRMLST.

Failures and Successes are propagated back to the originating location as messages as soon as they are generated and before the full result is handed back. These are finally stored under TRMLST as TRSUCC and TRFAIL elements. All the list elements have no user attributes.

5.9

TRMESS, TRSUCC, and TRFAIL Elements The TRMESS, TRSUCC, and TRFAIL elements are for Messages, Successes and Failures respectively. Operations and Output Commands are able to have any number of messages attached to them. They will be generated by Local operation during their execution and be stored. Remote operations will receive messages from their output commands that will:

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:11

12 Series

Administrator Command Reference Manual Transaction Database

•

generate messages relating to transaction events (sends, acknowledgements etc.)

•

receive messages from the execution of commands at other site

•

receive transaction event messages forwarded through other site remote operations.

Operations and output commands have a TRSUCC attribute stating a success or (relative) failure. Each point of failure will generate a single TRFAIL element (e.g. failure to claim an element). Each point of success will generate a single TRSUCC element (E.g. an element claimed). The attributes of TRSUCC and TRFAIL elements are equivalent. They include: •

A Reference to an element involved in the operation (e.g. the ref of a claimed element)

•

A double integer code relating to a PDMS message or error (0,0 if not known or relevant)

•

A text string which is a representation of the said message or error.

•

An integer qualifier to be used for such things as session numbers etc.

The result of a command (TROUCO) is the sum of all TRSUCC and TRFAIL elements owned by its operations and output commands. All of these are communicated back to either the user (if it is a local command) or propagated to the originating site (if it is a foreign command). In the latter case the compounded errors will appear under the relevant originating TROUCO operation and hence onwards and upwards Whether a TROPER itself is classed as a success is determined by its execute method. Input Commands are successes if all its operations AND output commands are successes. An output Command is a success if the input command it spawned returns a success. Results are only passed on to the generating TROUCO when the input command is totally finished. Messages are sent immediately they are generated before waiting for operation or command conclusion. They go the same route as the result, being compounded by a TROUCO and transmitted to other site TROPER elements. They are only stored under the final TRINCO generated from a USER command. Attributes for Elements %TRSUCC and %TRFAIL DATEMS

date

Date success/failure raised.

MESNUM[2]

int[2]

Message/error number relating to MSTEXT or 0,0 if none available. This can be used as an indication of the severity of a failure.

MSTEXT

text

Any result text (not passed on).

MSTYPE

int

Data type indicates significance of MESQUA, MSREF, MSDTXT.

MESQUA

int

Data qualifier.

MESREF

ref

Data refno corresponding to the error.

MSDTXT

text

Data text of the result/error.

MSLOC

text

Name of location that generated the success/failure

TRCNUM

int

Source command type number (if generated by a TRINCO).

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:12

12 Series

Administrator Command Reference Manual Transaction Database

TRONUM

int

Source operation type number (if generated by a TROPER).

TRTYPE

text

Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes. Allows you to query the member operations of a command independently of whether the operations are TROUCO or TROPER. It combines the TRCNUM and TRONUM queries (these are attributes of TROUCO and TROPER respectively).

Attributes for Element %TRMESS DATEMS

Date

Date success/failure raised.

MESNUM[2]

int[2]

Message/error number relating to MSTEXT or 0,0 if none available.

MSTEXT

Text

Message text.

MSLOC

text

Name of location that generated the success/failure.

MSSENT

log

Unused.

TRCNUM

int

Source command type number (if generated by a TRINCO).

TRONUM

int

Source operation type number (if generated by a TROPER).

TRTYPE

text

Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:13

12 Series

Administrator Command Reference Manual Transaction Database

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

5:14

12 Series

Administrator Command Reference Manual Command Summary

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.

6.1

Project Definition ACCESS

Changes the access rights of the specified user to PDMS modules.

ACRADD

Adds a named ACR to the current ACR Group.

ACRREM

Removes a named ACR from the current ACR Group.

ADD

Places a named DB at a specified position in the current MDB list.

AUTHENTICATION

Switches authentication user on/off.

AUTHUSERREM/OVE

Removes authenticated user.

CHANGE

Changes database access type, and the claim mode for multiwrite databases. (In a Global project, also changes primary location)

CDESC

Changes the description of the specified user, team, database or MDB.

CNAME

Changes the name of the specified user, team, DB or MDB.

COPY

Copies a DB, MDB, Team, User, Module or Stamp.

CREATE

Creates a DB (including Extract DBs), MDB, Team, User, Windows NT Authenticated user or Module.

CURRENT

Moves a DB to a specified position in the current MDB list.

DADD

Adds a Database or DB Set to the current DB Set.

DEFER

Makes a DB non-current.

DELETE

Removes the specified element from the project.

DREMOVE

Removes a DB or DB Set from the current DB Set

EXCHANGE

Replaces the current DB by a non-current DB.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:1

12 Series

Administrator Command Reference Manual Command Summary

6.2

EXCLUDE

Removes a database which has been included from an external project.

INCLUDE

Includes databases from another project in the current MDB.

LIST AUTHUSERS

Lists authenticated users.

NEW

Creates a DB Set, Role, Scope, Access Control Right (ACR) or ACR group. Also used to create a new TrueType font element (TTFONT).

PASSWORDLOCK

Grant or prevent the ability for users to reset their own password in Monitor.

PROJECT

Adds descriptive information to project definitions.

REPLICATE

Saves the structure or contents of a project in a named file.

REMOVE

Removes a DB from an MDB.

SET

Sets the current MDB, Team or DB Set.

TADD

Adds Users to the current Team.

TREMOVE

Removes Users from the current Team.

USERADD TO

Adds specified PDMS users to authenticated user. DEFAULT. Sets the specified PDMS user as the default PDMS username for the authenticated user.

USERREM/OVE FROM

Removes the specified PDMS user from the authenticated user.

Q AUTHUSER

Queries the authenticated user.

Q AUTHENTICATION

Queries the authentication status.

Project Administration BACKTRACK

Backtrack a database to a previous session.

EXPUNGE

Removes users from the Project and releases claimed elements in databases.

EXTRACT

Control of database extracts

LOCK

Locks the Project Database so that Users cannot enter.

MAXUSERS

Maximum number of users for a project.

MERGE CHANGES

Merges the changes made to a database over several sessions.

MESSAGE

Sends messages to other users.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:2

12 Series

Administrator Command Reference Manual Command Summary

6.3

BACKTRACK

Backtrack a database to a previous session.

MOVE

Moves a DB to a different area.

NEW STAMP

Creates a new stamp.

REVERT

Backtrack a database to a previous session.

UNLOCK

Unlocks a locked database.

Global Project Administration ADMINISTER

Creates or opens a system database to allow you to administer a remote location.

ALLOCATE

Allocates databases to a Location.

DEALLOCATE

Removes databases from a Location.

DUPLICATENAMES

Checks for elements with duplicate names in the Project.

GENERATE

Generates the files required for a new Location.

HUBLOCATION

Relocates Project Hub.

INITIALISE

Initialises communications link at a Location.

ISOLATION

Isolates a Location so that no updates take place.

MAKE GLOBAL

Makes a Standard Project into a Global Project.

NEW

Creates a DB Set, Role, Scope, Access Control Right (ACR) or ACR group. Also used to create a new TrueType font element (TTFONT).

PING

Checks that communications link to named location exists.

PREVOWNER

Restores the Hub to its previous Location. Restores a database to its previous Primary Location.

PURGE

Removes old Database files and Picture files from an offline Location.

RECOVER

Recovers data when a databases has been corrupted.

REMOTE

Allows the Hub or the Administering Location of a Satellite to carry out certain tasks.

REMOTEMESSAGE

Sends messages to users at other Locations.

RENEW

Deletes a transaction database and creates a fresh version.

REORDER

Reorders a members list.

SET

Sets the current MDB, Team, or DB Set.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:3

12 Series

Administrator Command Reference Manual Command Summary

6.4

6.5

6.6

SORTALLOCATE

Sorts an allocation list so that Database extracts are in the correct hierarchical order

SYNCHRONISE

Updates a database with changes from another Location.

SYSTEMLOCATION

Changes the Administering Location of a Satellite.

TRANSFER

Generates a directory containing copies of all database files, ready for transfer to a Location.

UPDATE

Updates current Location and an immediate neighbour.

QREMOTE

Remote database query.

Module Definition EDIT

Enables project module entries to be edited.

MODULE

Creates an entry for a module in the System DB.

Font Definition FONTDIRECTORY

Sets the font directory name.

FONTFAMILY

Defines a font family.

TTFONT

Changes the definition of a TrueType font, that has previously been created with the NEW TTFONT command.

Querying LIST

Lists Project Information

QUERY

Queries information about ADMIN elements.

STATUSSESSION

Gives information about the current state of the Project.

SYSTAT

Gives information about users accessing the project.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:4

12 Series

Administrator Command Reference Manual Command Summary

6.7

6.8

General PDMS Commands ALPHA

Sends command input and output to a file.

FINISH

Leaves PDMS, saving work.

GETWORK

Refresh view of System database.

SAVEWORK

Updates the Project Database.

TERM

Equivalent to ALPHA FILE END.

Data Integrity Checking Within : CHECK

Starts the integrity checking.

CHECKOPTION

Control what is to be checked, and the amount of information output.

Stand-alone: CHECK

Starts the integrity checking.

ERRORFILE

Specifies the name of the file containing the error and warning messages when DICE is used in stand-alone mode.

EXTERNAL

Checks that all external references point to DBs of appropriate types.

MAXERRORS

Maximum number of errors found before data integrity checking is abandoned.

MAXWARNINGS

Maximum number of warnings found before data integrity checking is abandoned

MODE

Specifies what happens when DICE finds an error.

STATISTICS

Produces a summary of information about the database being checked.

STOP

Exits from DICE in stand-alone mode. (Equivalent to FINISH)

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:5

12 Series

Administrator Command Reference Manual Command Summary

6.9

Reconfiguration BRIEF

Brief output to pass 2 reconfiguration.

DUMP

Writes a reference number index to the given file.

ERRORS

Sets an upper limit on the number of errors that are acceptable during Pass 2 of a reconfiguration.

FILE

Sets the output destination for reconfiguration messages (see Chapter 3).

FROM

Specifies the source database for reconfiguration.

FULL

Gives full output from pass 2 reconfiguration.

LOAD

Loads the reference number index from the given file.

RCFCOPY

Defines the part of the database to be copied from the source DB to the destination DB.

RCFUPDATE

Updates reference pointers into reconfigured database.

RCFUPGRADE

Consult AVEVA Solutions Support.

RECONFIGURE

Starts reconfiguration.

REINIT

Re-initialises the reference number index.

RESETXREFS

Consult AVEVA Solutions Support.

TO

Specifies the destination database for a reconfiguration.

UPGRADE

Produces macros to upgrade a project to a new version of PDMS.

VB

Gives very brief output for pass 2 reconfiguration.

XREF

Consult AVEVA Solutions Support.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

6:6

12 Series

Administrator Command Reference Manual Command Details

7

Command Details The commands are described in this chapter in alphabetical order of command names. The descriptions are usually under subheadings of Function, Description, Examples, Command Syntax, and Related Commands. The syntax of commands is shown by syntax graphs. These are discussed in the first two sections. The third section contains the command descriptions.

7.1

Conventions Used in the Syntax Graphs The syntax graph conventions are as follows: •

Commands are shown in a combination of uppercase and lowercase letters, where the capital letters indicate the minimum abbreviation.

Note: This convention does not mean that the second part of the command must be typed in lowercase letters; commands may be entered in any combination of uppercase and lowercase letters. •

For example, the command

CReate •

can be input in any of the following forms:

CR CRE CREA CREAT CREATE •

Commands shown in all uppercase letters cannot be abbreviated.

•

Command arguments are shown in lowercase letters. These are just descriptions of what you need to enter. For example:

FONTDirectory name •

means that to set the name of the Font Directory to newfonts, you enter:

FONTD newfonts •

Syntax graphs are read from top left to bottom right. The start point is shown by >, and you can follow any path through the graph until the exit point, shown by >, is reached.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:1

12 Series

Administrator Command Reference Manual Command Details

•

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: >----+--- ABC ------. | | |--- PQR ------| | | ‘--------------+--->

•

means you can type in ABC or PQR or just press Enter to get the default option.

•

Text in angle brackets <. . . > is the name of another syntax graph. This convention is used for syntax which occurs in many places. The graphs referred to are described at the end of this section. For example: >----+--- ABC ------. | | |--- PQR ------| | | |--- ----| | | ‘--------------+--->

•

means you can type in ABC or PQR or any command allowed by the syntax given in diagram 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:2

12 Series

Administrator Command Reference Manual Command Details

7.2

Notes on Syntax Graphs When a Location needs to be specified, it is shown as in the syntax graphs. It can be: •

A three-letter Word. For example: CAM, the LOCID of a LOC element, where the LOCID is 3 capital letters.

•

A text string of three alphanumeric characters, beginning with a letter. For example: 'CAM’, ‘A99' or ‘abc’, the LOCID of a LOC element.

•

A PDMS general identifier which points to a LOC element. For example: / LOCATION_AAA.

<when> >--+-- BEFORE --. | | ‘-- AFTER ---+------ --------. | | |------ SESS n --------| | | ‘-- STAMP stampname ---+--->



>--- time --- day --- month --- year time is in the format hh:mm where hhx is the hour and mm the minutes. If not given then the default of 23:59 is taken. There must not be any spaces around the colon. day will be an integer. If not specified, the current day is taken. The day must be given if no time was specified. 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:

12:00 21 January 2002 9:30 11 / 1 / 02 10:30 21 / 1 / 2002 21 January

7.3

Detailed Descriptions of Commands The detailed descriptions appear on the following pages in alphabetical order of command name. Each description starts on a new page. The command name and relevant functional group are at the top of the first page of the description, and the command name is repeated on each continuation page.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:3

12 Series

Administrator Command Reference Manual Command Details

When a command is associated with the Global Project Administration functional group, the command is specific to Global projects. Commands associated with other functional groups may be used for Standard and Global projects, and any particular aspect of a command that concerns Global projects is highlighted by the appearance of 'Global' in larger typeface.

7.3.1

ACCESS (Project definition) Function: Changes the access rights of the specified user to PDMS modules. Example:

ACCESS ADMINUSER FREE DRAFTUSER GEN Give user ADMINUSER FREE access, user DRAFTUSER GENERAL access. Command Syntax: .-------------<-------------. / | >--- ACcess --*-- userid ---*--- FRee ------| | | ‘--- GEneral ---+--->

Related Commands:

CREATE

7.3.2

ACRADD (Project definition) 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:

ACRADD /ACR1 /ACR22 /ACR24 Adds the ACRs /ACR1, /ACR22 and /ACR24 to the current ACR Group.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:4

12 Series

Administrator Command Reference Manual Command Details

Command Syntax:

.----<-------. / | >-- ACRADD --*--- acrname ---' | ‘--------------------->

7.3.3

ACRREM (Project definition) 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:

ACRREM /ACR1 /ACR22 /ACR24 Removes the ACRs /ACR1, /ACR22 and /ACR24 from the current ACR Group Command Syntax:

.----<-------. / | >-- ACRREM --*--- acrname ---' | ‘--------------------->

7.3.4

ADD (Project definition) 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 1000. 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:5

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: .-------------<--------------. / | >-- ADD ---*--- dbname ---+--- integer ---| | | ‘---------------+--->

Related Commands: REMOVE, DEFER, CURRENT, EXCHANGEREMOVE, DEFER, CURRENT, EXCHANGE

7.3.5

ADMINISTER (Global Project Administration - Remote Administration) 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:

SYSTEMLOC /AAA PRIMARY AT /BBB where /AAA is the identifier of the new Location, and /BBB is the identifier of the Administering Location, that is, the location where the System database for the Location will be Primary. The NEWSYSTEM option is only available at the Hub. It creates a system database for a new location in the transfer area. (This is similar to the GENERATE LOCATION command.) The system database created is a copy of the Hub system database without MDBs and with only a SYSTEM user. The Administrator at the Hub can then create Users and MDBs (as well as Teams and Databases) for the Location before it is set up. The SYSTEM option is available at the Administering Location, that is, the location where the System database for the Location is Primary. This may be the Hub or another Satellite. This command will close the local system database and open the appropriate satellite system database. The database will be opened with Write access unless the READONLY keyword is used. After the SYSTEM or NEWSYSTEM commands have been given, you will be able to carry out administration tasks for the remote location. To return to administering your own (current) Location, give the command ADMINISTER LOCAL. To return to administering the last system database which was open, give the command ADMINISTER SAME. Any location may issue an ADMINISTER command for another other location’s system database. If the system database is not Primary, then the system database will be opened READONLY.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:6

12 Series

Administrator Command Reference Manual Command Details

Once you have selected a remote system database, you can give most ADMIN commands, which will operate on the remote Location. In particular, the following commands can be used for housekeeping tasks on the remote System Database:

EXPUNGE SYSTEM MERGE CHANGES SYSTEM CHECK SYSTEM RECONFIGURE SYSTEM The Hub will not be allowed to REPLICATE the project when it is administering a remote location, since the wrong system database will be replicated. However REPLICATE SYSTEM commands (which generate macros to replicate the project structure) will still be valid. The administered location will still be able to lock or isolate the project locally. It will also be able to administer its primary constructor databases by using the REMOTE command, where 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:

ADMINISTER NEWSYSTEM /Cambridge ADMINISTER NEWSYSTEM 'CAM' Allows the Hub Administrator to create data (Users, MDBs etc) for a Location in the transfer directory.

ADMINISTER SYSTEM /Cambridge ADMINISTER SYSTEM 'CAM' Allows any System Administrator to read the System Database for Cambridge. Only the Administrator at the Location where the Cambridge System Database is Primary will have write access to it.

ADMINISTER SYSTEM SAME Allows a System Administrator who is administering other Locations to open the last System database opened.

ADMINISTER SYSTEM LOCAL Allows a System Administrator who is administering other Locations to open the local System database.

ADMINISTER SYSTEM AT /Cambridge ADMINISTER SYSTEM LOCAL READONLY This is equivalent to entering the ADMIN module as ADMIN READONLY.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:7

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >-- ADMINISTER --+--- NEWSYSTEM -----------------------------. | | ‘--- SYSTEM ------+-- AT ---. | | | | |--- SAME -------| | | | | ‘--- LOCAL ------+--- READONLY --| | | ‘---------------+--->

Querying:

7.3.6

>--- Q CURLOC --->

Returns the true current location

>--- Q ADMLOC --->

Returns the currently administered location

ALLOCATE (Global Project Administration - Hub only) 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. Using Macros to Allocate Databases You will probably use a macro for long lists of databases allocations, for example, when a project is first set up.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:8

12 Series

Administrator Command Reference Manual Command Details

The allocation process may take some time if there is a slow link between Hub and Satellite and/or if databases sizes are large. Note that if a de-allocation is in progress, then the allocation will stall until the de-allocation is complete before commencing. Make sure that you do not try to allocate a database to the same location twice. If the allocation appears to have failed, check the transaction databases at both the Hub and the Satellite before attempting to repeat the command. To check that the allocation has been successful, GETWORK and then navigate to the LOC element. Navigate to its DBALL (allocation list) member, and query its members. Wait until the DBALL element at both the Hub and the Satellite lists all the allocated databases before continuing. Note: If the transaction database for a location is being allocated, this command is not recorded in the transaction database. It is not normally necessary to allocate it or change its primary location explicitly. Note: The OVERRIDE PROPG option cannot be used with a deferred time. Examples:

ALLOCATE PIPE/PIPE PRIMARY AT CAM Copies database PIPE/PIPE from the current Location to Location CAM, making it Primary.

ALLOCATE ALL AT LON AT 23:30 Copies all databases which exist at the current Location but do not exist at Location LON, from the current Location to Location LON, at 2330 hrs. The Primary/Secondary status will not be changed.

ALLOCATE ALL AT OXF OVERRIDE PROPG Copies all databases, including non-propagating databases, which exist at the current Location but do not exist at Location OXF, from the current Location to Location OXF. The Primary/Secondary status will not be changed. Transaction databases will not actually be copied, but empty database files will be created at secondary locations. This command is useful when changing the Hub location, since it ensures that the DB allocation lists of the old and new Hub locations match. Command Syntax: >-ALLOCate -+- teamid -. | | |----------+- dbname -+-------------. | | | | |- PRIMary ---| | | | | ‘- SECOndary -+-AT loc-+-AT ----. | | | | ‘--------------+-> | ‘- ALL ---------------------------AT loc-+-AT -------. | | ‘-OVERride PROPG -+->

Related Commands: DEALLOCATE, CHANGE dbname PRIMARY, HUBLOC, TRANSFER

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:9

12 Series

Administrator Command Reference Manual Command Details

Querying:

7.3.7

--- Q DBALL --->

At a location, shows the list of allocated DBs

>--- Q DBLC --->

At a DB, shows the list of locations that have the DBs allocated

ALPHA (General PDMS Command) Function: Sends the information output in the Command Input and Output window to a file. Examples:

ALPHA LOG /LOG OVERWRITE Sends all information displayed in the Command Input and Output window to a file named log.

ALPHA FILE /LOG Sends reports to a file named log, for example, a DICE report.

ALPHA LOG END Ends recording. Command Syntax: >-- ALPha ---*--- LOG ---+--- filename ---+--- OVERwrite -------------------| | | | | | | |--- APPend ----------------------| | | | | | | ‘-----------------+-- COMMands ---| | | | | | | |-- REQuests ---| | | | | | | ‘---------------| | | | | ‘--- END ------------------------------------------| | | ‘--- FILE ---+--- filename ---+--- OVERwrite ------------------| | | | | |--- APPend ---------------------| | | | | ‘--------------------------------| | | ‘--- END -----------------------------------------+-->

Related Commands: TERM

7.3.8

AUTHENTICATION Function: Switches Windows NT authentication ON or OFF.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:10

12 Series

Administrator Command Reference Manual Command Details

Examples:

AUTHENTICATION ON AUTHENTICATION OFF Command Syntax: >- AUTHENTICATION -+- ON ---> | ‘- OFF ---> 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: >- AUTHUSERREMOVE --- authuser ---> Related Commands: LIST AUTHUSER, USERADD TO, USERREM/OVE FROM, CREATE AUTHUSER, AUTHENTICATION

7.3.10

BACKTRACK (Project Administration) 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 BACKTRACK command to backtrack a constructor database that is Primary at a remote Location, where is the Location identifier. See the REMOTE command for examples.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:11

12 Series

Administrator Command Reference Manual Command Details

If you try to backtrack over any stamped sessions to a previous session, you will receive an error message. Backtracking over stamped sessions is not allowed. You must remove the stamp from the intervening sessions before you backtrack. BACKTRACK removes the sessions permanently. The related command REVERT adds a session containing the data for the specified old session. The backtracked database is written to a new file. This is done to avoid the situation where secondary database files in a Global project could still contain removed sessions. This situation would cause propagation failures if further sessions were added to the backtracked file. Note: For extracts, the REVERT command is used instead of BACKTRACK. Examples:

BACKTRACK HANGERS/PADD TO SESSION 4 Backtracks the HANGERS/PADD database to Session 4. The team id (HANGERS) and TO can be omitted.

BACKTRACK HANGERS/PADD TO STAMP /stamp_007 Backtracks the HANGERS/PADD database to the session that has the stamp stamp_007. The team id (HANGERS) and TO can be omitted.

BACKTRACK /HVAC 10:30 31 / 8 / 96 BACKTRACK /HVAC 10:30 31 AUGUST 1999 Backtracks the HVAC database to 10.30 am on the 31 August 1999. If the time is omitted, 11.59 p.m. is assumed. If the month is not given, the current month is assumed. If the year is not given, the current year is assumed. This example assumes that the team name has been specified using the SET command.BACKTRACK (continued)

BACKTRACK PIPE/PIPE-A AT OXF TO SESSION 4 In a Global project, backtracks the PIPE/PIPE-A database at Location OXF to Session 4. The team id (PIPE) and TO can be omitted. (The database PIPE/PIPEA must be Primary at the Location OXF,) and the System Database for OXF must be Primary at the current Location. See the ADMINISTER SYSTEM command. Command Syntax:

>- BACKTrack -+- teamid -. | | ‘----------+- dbname TO <when> --->

Querying: Q SESSION Related Commands: REVERT, MERGE CHANGES, REMOTE BACKTRACK, REMOTE REVERT - Global only

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:12

12 Series

Administrator Command Reference Manual Command Details

7.3.11

BRIEF (Reconfiguration) 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.

*** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC

LIBY

#92/842

=16/2404

(24,90) Warning! library number 242 already exists in the project. Duplicate libraries should not be used in the same MDB EC DEPT #16/805 =16/2408 Phase one complete - starting phase two #EAE SHEE #88/842 =16/2417 /DR1/S5 IDLN: The head of the current element does not contain the attribute given #EAE SHEE #69/808 =18/2408 /DR1/S4 IDLN: The head of the current element does not contain the attribute given #EAE SHEE #53/819 =22/2402 /DR1/S3 IDLN: The head of the current element does not contain the attribute given ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 3 Attributes were incorrectly defined 0 Elements were not inserted. Command Syntax:

>--- Brief ---> Related Commands: FULL, VB, ERRORS

7.3.12

CANCELCOMMAND (Global Project Administration) Function: Allows a daemon command being executed at the current location to be cancelled.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:13

12 Series

Administrator Command Reference Manual Command Details

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:

CANCELCommand TRINCO1 OF /2002/APR/23/USERA/LON Command Syntax:

>--- CANCELCommand ---> where is a TRINCO in the transaction database for the Location. Related Commands: REMOTE CANCEL

7.3.13

CDESC (Project definition) 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: CDESC CDESC CDESC CDESC

USER TEST/TEST ’This is a test user’ TEAM TEST ’This is the test team’ DB TEST/DESI ’The test design database’ MDB TEST ’This is the test MDB’

Command Syntax: >--- CDesc ---+--| |--| |--| ‘---

USer username/password ’text’ ---. | TEam name ’text’ ----------------| | MDB name ’text’ -----------------| | DB dbname ’text’ ----------------+-->

Related Commands: CNAME, CHANGE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:14

12 Series

Administrator Command Reference Manual Command Details

7.3.14

CHANGE (Project definition) 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. It is possible to set or reset a password associated with the database. 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. If a password is already associated with the database then that password must be specified in the same command using the VERIFY <password> clause, otherwise an error will occur and no change will be made. CHANGE dbname PROTection [ ON | OFF ] [EXPires future-date ] Setting the PASSWORD parameter sets or resets the password associated with the database. If encrypted appware or command scripts have the same password embedded then they are able to access attribute values that would otherwise be unavailable in a protected database. If a password is already associated with the database then the existing password must be specified in the same command using the VERIFY <password> clause otherwise an error will occur and no change will be made. CHANGE dbname VERIFY old-password PASSWORD new-password 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:15

12 Series

Administrator Command Reference Manual Command Details

users in PDMS with write access to the database. The command will eventually complete once all such users have left PDMS. You may need to use EXPUNGE to remove phantom users. After the CHANGE PRIMARY command has been issued, users in PDMS with write access to the database can continue to modify the database, even if GETWORK is used. Once they have made a module switch, the database will become read-only. If a CHANGE PRIMARY command fails, the previous primary location will normally be recovered automatically. If the recovery fails (for example, the daemon is not running), you can recover the previous Primary location using the command: PREVOWN dbname Use of the PREVOWN command should be avoided if possible. Offline Locations Before issuing a CHANGE PRIMARY command to or from an offline location, all users should have left PDMS at the old primary location. The TRANSFER command should first be used to bring the database at the new primary location up-to-date. Any modifications to the database at the old primary location subsequent to this TRANSFER will be lost. Only after this TRANSFER is it safe to issue the CHANGE PRIMARY command. Examples:

CHANGE TEST/TESTDESI ACCESS MULTIWRITE Change access rights to named database to multiwrite.

CHANGE TEST/TESTDESI CLAIM IMPLICIT Change claim mode for named DB to IMPLICIT. This option can only be used for a MULTIWRITE database.

CHANGE TEST/TESTDESI ACCESS UPDATE Change access rights to named DB to single write.

CHANGE TEST/TESTDESI CLAIM OFF Change claim mode for named DB to OFF. This option can only be used for a CONTROLLED database.

CHANGE TEST/TESTDESI CONTROL OFF Change control setting for named DB to OFF. This option can only be used for a CONTROLLED database.

CHANGE TEST/TESTDESI FINO 500 Change the Filenumber (FINO attribute) of the given database to the given number. By default, the Filenumber will be set to 0, and the filename of the database file will be derived from the database number. Using the default is recommended, particularly if you are using extracts. If you set the filenumber explicitly, the extract filename will still be derived from the Database number (NUMDB attribute), and so the consistency of filenames within an Extract family will be lost.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:16

12 Series

Administrator Command Reference Manual Command Details

CHANGE TEST/TESTDESI FINO 0 Change the Filenumber (FINO attribute) of the given database to 0. This command can be used to update database files to the new file numbering convention, which will keep Extract filenames consistent within an Extract family.

CHANGE TEST/TESTDESI VERIFY 'XXXXXX' PASSWORD 'SecretPassw0rd' Changes the password associated with the given database from 'XXXXXX' to 'SecretPassw0rd'. If the given database does not have a password associated with it, the VERIFY part can be omitted.

CHANGE TEST/TESTDESI PROTECTION OFF Changes the protection status of the given database so that it is no longer restricted under IPR protection. In this case no password has been associated with the database.

CHANGE FOREIGN PIPE/PIPECATA RESET If PIPE/PIPECATA is a local database in project AAA, and a foreign database in project BBB, and the access is changed (in AAA), you should give this command in project BBB to update the project. Note: On the following Change...Primary Commands The new Primary Location will receive all outstanding updates of the database from the current Primary Location. Note: Offline Locations: The Primary Location of a Database cannot be changed directly between an off-line satellite and an on-line satellite. The Primary Location of the database must first be changed to the Hub. The option is not allowed for off-line Locations.

The following command can only be used at the Hub of a Global project:

CHANGE TEST/TESTDESI PRIMARY AT CAM Change the primary location of the named DB to be CAM. The database will automatically become secondary at the current Primary location. The following option is only available at the Hub of a Global Project:

CHANGE HVAC/HVAC PRIMARY AT CAM AT 2330 Change the Primary Location of the named DB to the Location CAM at the specified time.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:17

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: .-------<---------. / | >- CHange -+- dbname -+--- VERify text ---’ | | | |- ACCess -----+--- MULTIWrite ----------------. | | | | | | |--- CONTRolled ----------------| | | | | | | ‘--- UPDAte --------------------| | | | | |- CLAIM ------+--- IMPLicit ------------------| | | | | | | |--- EXPLicit ------------------| | | | | | | ‘--- OFF -----------------------| | | | | |- FINO -------+--- n -------------------------| | | | | | | ‘--- 0 -------------------------| | | | | |- PROTected --+--- ON -+----------------------| | | | | | | | | ‘-EXPires future date -| | | | | | | ‘--- 0FF------------------------| | | | | |- PASSword ---+--- text ----------------------| | | | | | | ‘--- DELete --------------------| | | | | ‘- CONTROL ----+--- ON ------------------------| | | | | ‘--- OFF -----------------------| | | ‘- FOREIGN dbname RESET ----------------------------------+->

Note: The CLAIM OFF option is only applicable to Controlled databases. The CLAIM IMPLICIT and CLAIM EXPLICIT options are only applicable to Multiwrite and Controlled databases. The following option is only available at the Hub of a Global Project: >--- CHange dbname --- PRIMary AT

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:18

---+-- AT --. | | ‘---------------+--->

12 Series

Administrator Command Reference Manual Command Details

Querying: >--- Query DB dbname ---> >--- Q PRMLOC --->

At a DB, shows the primary location.

Related Commands: PREVOWNER, TRANSFER (Global only)

7.3.15

CHECK (Data Integrity Checking) 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. Stand Alone DICE In a Global Project, both Primary and Secondary databases can be DICE checked. This enables you to check a number of locations to find, for example, a valid version of a database which has been corrupted at its primary location. To check a database at a remote location, prefix the CHECK command with REMOTE command, where is the Location identifier. See the REMOTE command for examples. Note: Remote checking uses 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:

CHECK DBS MASTER/DESI MASTER/CATA Checks the integrity of a single named DB or a series of DBs within the project. Up to ten DBs may be specified in each command.

CHECK SYSTEMDB Checks the integrity of the project’s System DB. In a Global Project, the current administered System DB is checked.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:19

12 Series

Administrator Command Reference Manual Command Details

CHECK COMMDB Checks the integrity of the project’s Comms DB.

CHECK MISCDB Checks the integrity of the project’s Misc DB.

CHECK GLOBALDB Checks the integrity of the project’s Global DB.

CHECK PROJECT Checks the integrity of all DBs in a project, including the System DB, Comms DB and Misc DB (but not the virgin DBs). The DBs are checked automatically by DICE in the following order: The System DB The Comms DB The Misc DB The user-accessible DBs, which are checked team by team

CHECK FILES /TRA000/TRA003 /TRA000/TRA001 Checks the integrity of one or more DBs by specifying the names of the files in which the DBs are held. Up to ten files may be specified in each command. This version of the command is usually used in stand-alone mode. (A list of DBs in a project, together with the names of the corresponding files in which they are stored, can be produced by using the LIST FILES command.) Note: If DICE is being used within PDMS and the CHECK FILES option is used, then no external reference checking can be done for that file and EXTERNAL NOCHECK will be assumed. Command Syntax: From a PDMS module:

>- 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 , where is the Location identifier. See the REMOTE command for examples.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:20

12 Series

Administrator Command Reference Manual Command Details

In stand-alone mode: .-------<------. / | >--- CHEck --- FIles --*--- filename ---+--->

Related Commands: CHECKOPTION

7.3.16

CHECKOPTION (Data Integrity Checking) 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.

Controlling the Amount of Information Output There are two types of DB fault detected by DICE: •

An error is identified if the DB is corrupted internally.

•

A warning is identified if DICE encounters, for example, a fault with a reference to an external DB.

In BRIEF mode, checking is stopped when the first error is encountered; that is, DICE simply determines whether or not the DB is corrupt. This is the default mode. In FULL mode, DICE continues checking the whole DB or file, listing all errors and warnings, until a prescribed maximum error or warning count is exceeded, when checking of that DB is abandoned. Occasionally DICE will stop before processing the whole DB. This will happen when the error is so severe that it is not worth continuing; for example, if a database has been truncated. The default setting for the maximum error count and maximum warning count is 50, but you can specify different numbers by using the MAXERRORS and MAXWARNINGS options. STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc. STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default setting.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:21

12 Series

Administrator Command Reference Manual Command Details

An example of the output from DICE when statistics are requested is as follows:

OVERALL STATISTICS ================== Total no. of entries in Name Table = 111 Total no. of elements checked = 782 Total no. of ref attributes found = 726 Total no. of external references = 0 Checking External References The elements in some types of DB have reference or reference array attributes which can point to elements in other DBs. If you use the EXTERNAL option, DICE will check that all external references point to DBs of appropriate types. For example, a reference attribute in a Design DB which points to a Draft (PADD) DB must be illegal, but a reference attribute pointing to a Catalogue DB will be accepted. This command cannot be used in stand-alone mode because only one DB file can be accessed at a time. EXTERNAL NOCHECK is the default. In this mode DICE does not cross-check any references to other DBs. If EXTERNAL CHECK is specified, the following tests are applied to each external DB to which reference is made: •

Does the referenced DB exist?

•

Is the referenced DB of a valid type?

•

Is the position pointed to within the limits of the referenced DB? Note that in the case of a DB which has copies, DICE only checks that the position pointed to is within the limits of the largest copy.

A non-fatal error message is produced for each invalid external reference found. If you specify the EXTERNAL CHECK option, you can specify a preference MDB. In this case, DICE will check external references to databases which are current within the given MDB, before checking other databases in the project. This option is mainly relevant when extracts are used, which means that there may be many databases with the same database number in the project, and so it is less relevant to Global projects. 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:22

12 Series

Administrator Command Reference Manual Command Details

Extract Claimlists The CLAIM ON option (the default) will check that the claim list in an extract corresponds with the claim list in its master database. The following error messages may be produced: 700:

Element ref/ref is not in parent extract claim list

702:

Element ref/ref is claimed to another user/extract

703:

Element ref/ref needs claiming to child extract in parent extract

704:

Element ref/ref needs clearing in parent extract claim list

If PATCH ON has been selected, then an attempt is made to patch errors of type 701, 703 and 704, and these cases will be treated as warnings rather than errors (and will therefore not terminate the check even if MODE FULL has not been selected). For cases 701 and 703, the patch attempts to claim the element from the parent extract (and continues up the extract hierarchy if necessary). If successful, the following message will be written: 701:

PATCH: Element ref/ref claimed in parent extract

For case 704, the patch attempts to release the element from the parent extract. If successful, the following message will be written: CHECKOPTION (continued) 704:

PATCH: Element ref/ref cleared from parent extract claim list

If the attempted patch is unsuccessful, the following error will be raised: 537:

Attempt to patch failed

There is no patch for errors of type 702. (Patches may also be attempted for some other extract problems.)

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:23

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >-- CHECKOption ----+| | | | | | | | | || | | || | | | | || || || | | ‘-

EXTernal --+- CHECK -+-----------------------. | | | | ‘- PREFerence -+- NONE -| | | | | ‘- mdb --| | | |-- NOCHeck ----------------------| | | ‘-- REject -----------------------| | MOde -------+-- FUll ------------------------| | | ‘-- BRief -----------------------| | STATistics -+-- FULL ------------------------| | | |-- ON --------------------------| | | ‘-- OFF -------------------------| | MAXErrors n ---------------------------------| | MAXWarnings n -------------------------------| | CLAIM ------+-- ON --------------------------| | | ‘-- OFF -------------------------| | PATCh ------+-- ON --------------------------| | | ‘-- OFF -------------------------+->

Related Commands: CHECK

7.3.17

CNAME (Project definition) 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 15 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:24

12 Series

Administrator Command Reference Manual Command Details

Examples:

CNAME USER JF RAB/ROB Change username JF to username RAB, password ROB

CN DB TEAMNAME/GBPADD TEAMNAME/GBDRAFT Change DB GBPADD to GBDRAFT if GBDRAFT does not exist.

CN DB TEAMNAME/GBPADD TEAMNAME/GBDRAFT OVER Change DB GBPADD to GBDRAFT even if GBDRAFT exists. In a Global project, if /GBDRAFT already exists, then it must not be allocated to locations other than the Hub, since the CNAME will delete this database.

CN MDB /DES1 /DESIGN Change MDB name /DES1 to MDB name /DESIGN

CN TE GEORGEB GEORGEC Change team name GEORGEB to GEORGEC. Command Syntax: >-- CName --+-- USer --- username username ---+--- /password---. | | | | ‘----------------| | | |--- DB --- dbname dbname ---+--- OVER ------------| | | | | ‘---------------------| | | |--- MDB --- mdbname mdbname ----------------------| | | ‘--- TEam -- teamname teamname --------------------+->

Related Commands: CHANGE, EXCLUDE, INCLUDE, MOVE, CDESC

7.3.18

COP (Project definition) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:25

12 Series

Administrator Command Reference Manual Command Details

If the PROTection parameter was set during the creation of a database then a copy command will not be permitted. Examples:

COPY DB ADMIN/CA1A TO ADMIN/CA1C TO AREA 051 Copies DB ADMIN/CA1A to area 051, renaming it ADMIN/CA1C

COPY TEAM TESTTEAM TO SUPPORT Team SUPPORT will be the same as team TESTTEAM when queried.

COPY TEAM TESTTEAM TO SUPPORT EXCL USERS Team SUPPORT will be the same as team TESTTEAM when queried, but the team’s users will not be copied.

CO MDB /ADMIN TO /ADMINCOPY MDB/ADMINCOPY will contain the same structure as /ADMIN.

CO USER ADMINA TO TESTA/GEN A new user TESTA, password GEN will be created, belonging to the same teams, and having the same access rights as, user ADMINA

COPY DB Z/Z FROM PROJ ABC US SYSTEM/XXXXXX TO A/A DB Z/Z will be copied from project ABC, so that it can be accessed by user SYSTEM, password XXXXXX, into the current project. It will be given the name A/A.

COPY DB Z/Z TO A/A TO AREA 99 TO FINO 50 DB Z/Z will be copied to A/A, in area number 99 with filenumber 50. The environment variable pointing to area 50 will need to be set.

COPY STAMP /stamp_005 TO /stamp_012 The stamp stamp_012 will be a copy of the stamp stamp_005. The list of databases referenced will be identical.

COPY DB Z/Z FROM PROJ ABC123 USER FRED.BLOGGS1/B TO A/A Copies from a project with a long project identifier, accessed via user ‘Fred Bloggs’ password B into the current project.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:26

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >- COpy -+- DB dbname -+- FROM PROject projid USer id pass -. | | ‘------------------------------------+-> continued continued --- TO dbname -+-- TO AREA n --. | | ‘---------------+-- TO FINO filenumber --. | | ‘------------------------+-> >- COpy -+| | | || || | | | | || ‘-

TEam teamid TO teamid -+- EXCLuding USERs -------------------------. | | ‘-------------------------------------------| | MDB mdbname TO mdbname --------------------------------------------| | USer word TO word name -+--- FRee ---------------------------------| | | |--- GEneral-------------------------------| | | ‘------------------------------------------| | STAMP stampname1 TO stampname2 ------------------------------------| | MODule -+- integer ---. | | | | ‘- moduleid --+- TO integer moduleid ----------------------+->

Related Commands: CREATE, INCLUDE

7.3.19

CREATE (Project definition) 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 Administrator User Guide; for information about using extracts in Global projects, refer to Running Global Projects.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:27

12 Series

Administrator Command Reference Manual Command Details

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: Creating Teams, Users and MDBs

CR TEAM PIPING Create Team PIPING

CREATE USER RAB/ROB Create User RAB with password ROB, default access rights

CRE US HHJ/MICK FREE Create User HHJ with password MICK, free access rights

CR MDB /STEEL Create MDB /STEEL

CR USER ‘FRED.BLOGGS1’/ABC Creates user ‘Fred.Bloggs1’ (Non alphabetic user names are valid)

CR AUTHUSER NAME Creates a NT authenticated user which should be the name of a valid windows user. Creating Master Databases Note: If the SET TEAM command has not been used to set the current teamid, then the dbname must be prefixed by the name of the team which owns it.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:28

12 Series

Administrator Command Reference Manual Command Details

CREATE DB PIPING/PIPEDB DESI Create Design database PIPING/PIPEDB

CREATE DB STEEL/STEELDB DESI ACC MULTIW CLAIM EXPL Create multiwrite Design DB STEEL/STEELDB, with explicit claim mode.

CREATE DB STEEL/STEELDB DESI ACCESS MULTIWRITE DBNO 901 Create multi-write Design DB STEEL/STEELDB, database number (NUMBDB attribute) 901.

CREATE DB STEEL/STEELDB DESI DBNO UNIQUE Create Design DB STEEL/STEELDB using the next available number within the project database range.

CREATE DB TEST/TESTDESI FINO 500 Create the database TEST/TESTDESI with the given Filenumber (FINO attribute). By default, the Filenumber will be set to 0, and the filename of the database file will be derived from the database number. Using the default is recommended, particularly if you are using extracts. If you set the filenumber explicitly, the extract filename will still be derived from the Database number (NUMDB attribute), and so the consistency of filenames within an Extract family will be lost.

CREATE DB TEST/TESTDESI FINO 0 Create the database TEST/TESTDESI with the Filenumber (FINO attribute) of the given database set to 0. This command can be used to update database files to the new convention, which will keep Extract filenames consistent within an Extract family.

CREATE DB PIPE/PIPEEB DESI IN AREA 501 Create Design DB PIPE/PIPEEB in area 501 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. Setting the PASSWORD parameter sets or resets the password associated with the database. If encrypted appware or command scripts have the same password embedded then they are able to access attribute values that would otherwise be unavailable in a protected database. CREATE dbname PROTection [ ON | OFF ] [EXPires future-date ] [ PASSWORD password ] Creating Standard Extracts

CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB Create an extract PIPING/PIPE-X1 from database PIPING/PIPEDB

CREATE EXTRACT ADMIN/PIPE-X1 FROM PIPE/PIPEDB Create an extract ADMIN/PIPE-X1 from database PIPING/PIPEDB. Note the extract can be owned by a different Team from its owner.

CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB EXTNO 100 Create an extract PIPING/PIPE-X1 with extract number 100 from database PIPING/PIPEDB.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:29

12 Series

Administrator Command Reference Manual Command Details

Creating a Master Database above an existing Master Database

CREATE MASTER PIPING/PIPE-X1 ABOVE PIPE/PIPEDB Create a new master database PIPING/PIPE-X1 above existing master database PIPING/PIPEDB. This means that PIPE/PIPEDB is now a child extract of the new master PIPING/PIPE-X1 Creating Working Extracts Working extracts can only be created from a database that is primary at the current location.

CREATE WORKING EXTRACT FROM DB PIPING/PIPEDB FOR USERA Create a working extract from PIPING/PIPEDB for USERA

CR WORK EXTR FROM DB PIPING/PIPEDB FOR USERB EXTNO 21 Create a working extract from PIPING/PIPEDB for USERB with extract number 21. Creating Variant Extracts

CREATE VARIANT TEST/PIPE-V1 FROM PIPING/PIPEDB Create Design database PIPING/PIPEDB Creating Extracts for a Satellite

CREATE EXTRACT PIPING/PIPE-X1 FROM PIPE/PIPEDB AT LON Create an extract PIPING/PIPE-X1 from database PIPING/PIPEDB at satellite with LOCID ‘LON’ Creating Transaction Databases (Global projects only)

CREATE DB TRANSACTION/LON Create transaction db for location with LOCID ‘LON’. database type. Transaction databases have a special associates them automatically with the location. This created with the correct primary location. These are databases.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:30

Note the omission of the naming convention which database is automatically created as OVERWRITE

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: Databases >- CReate DB

teamid/dbname -+| || || || || ‘-

CATA -. | DESI -| | ISOD -| | PROP -| | PADD -| | DICT -+- IN AREA n -. | | ‘-------------+-->

cont

cont >---+- PASSword text -. | | ‘-----------------+--> cont cont >-- ACCess -+- UPDATE -----. | | +- CONTRolled -. | | ‘- MULTIWrite -+- CLAIM -+- EXPLicit -| | | ‘- IMPLicit -+--------+-> cont

cont >

- PROTected -+--- ON -+----------------------| | | | | ‘-EXPires future date -| | | ‘--- 0FF------------------------+--------+-> cont

cont >---+-- EXTNO n -. | | ‘------------+- DBNO n -. | | ‘----------+-- FINO n --. | | ‘------------+-- DESC text --. | | ‘---------------+--->

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:31

12 Series

Administrator Command Reference Manual Command Details

Extracts >- CReate MASTER team/db ABOVE team/db ---->

cont

>- CReate ---+--- EXTRact ---. | | ‘--- VARiant ---+--- team/db FROM team/db ---->

cont

>- CReate EXTRact team/db FROM team/db -+-------------------. | | ‘- AS AT SESSION n -+--> cont

>- CReate VARiant team/db FROM team/db -------------------->

cont

>- CReate WORKing EXTRact FROM team/db FOR user

cont

---------->

cont >---+- IN AREA n -. | | ‘-------------+- CONTROL -. | | ‘-----------+- CLAIM -+- IMPLicit -. | | | | ‘- EXPLicit -| | | ‘----------------------+--> cont

Standard projects: cont >--------+- EXTNO n -. | | ‘-----------+- DESC text -. | | ‘-------------+-->

Global projects: cont >-+- EXTNO n -. | | ‘-----------+- AT -. | | ‘-----------+- REFBLOCKS n -. | | ‘----------------+- DESC text -. | | ‘-------------+->

The REFBLOCKS option is used to allocate a block of reference numbers. By default, one REFBLOCK will be assigned to the extract. More reference blocks may be required if many users are creating elements. Refer to ‘Using Extracts with Global Projects' in Running Global Projects for further information. The AT option allows the Hub or an administering location to create an extract database whose primary location is at the specified satellite.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:32

12 Series

Administrator Command Reference Manual Command Details

Transaction Databases (Global projects only) >- CReate DB TRANSACTION/name ------------cont > cont >--+-- EXTNO n -. | | ‘------------+- DBNO n -. | | ‘----------+-- FINO n --. | | ‘-------------+-- DESC text --. | | ‘---------------+--->

The ‘name’ must be the LOCID of a valid Location. Users, Teams and MDBs >- CReate -+- USer userid passwd -+--- FRee ------. | | | | ‘--- GEneral ---| | | |- TEam teamid ------------------------+-- DESC text ---. | | | | ‘----------------| | | ‘- MDB name --------------------------------------------+->

Authenticated User >- CR/EATE --- AUTHUSER --- authuser --->

Querying: >--- Query --+-| |-| |-| |-| ‘--

USer userid ---. | DB dbname -----| | MDB name ------| | Authuser ------| | TEam teamid ---+-->

Related Commands: SET, MODULE, CHANGE, NEW, LIST AUTHUSER, USERADD TO, USERREM/OVE FROM, AUTHUSERREMOVE, AUTHENTICATION

7.3.20

CURRENT (Project definition) Function: Moves a DB to a given position in the current MDB list.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:33

12 Series

Administrator Command Reference Manual Command Details

Description: The specified list position must be in the range 1-1000. 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

7.3.21

DADD (Project definition) 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.

DADD DB /STEELN /STEELS DBSET /ASET DB /PIPEN Adds the databases /STEELN, /STEELS and /PIPEN, and all the Databases in the DB Set /ASET, to the current DB Set.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:34

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: .----------------<------------.--<---. | | / .----<-------. | | / / | | | >-- DADD --*--- DB -------*--- dbname ---+---' | | | | .-------------------<------------. | | / | | | / .-------<-------. | | |/ / | | | *--- DBSET ----*--- dbsetname ---+---+---+---> /

Querying: Q SET DBSET Related Commands: DREMOVE, DELETE, SET, NEW

7.3.22

DEALLOCATE (Global Project Administration - Hub only) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:35

12 Series

Administrator Command Reference Manual Command Details

See the guide Running Global Projects for more information about de-allocating databases that have extracts. Examples:

DEALLOCATE PIPE/PIPE AT CAM Removes the database PIPE/PIPE from Location CAM. The database must not exist at any Locations which are descendants of CAM.

DEALLOCATE HVAC/HVAC AT OXF INCLUDING DESCENDANTS Removes the database HVAC/HVAC from Location OXF and all descendants of OXF.

DEALLOCATE ALL AT LON Removes all databases which exist at Location LON. Note that you cannot use the INCLUDING DESCENDANTS option with ALL.

DEALLOCATE PIPE/PIPE KEEPMDBS AT CAM Temporarily deallocates and makes unavailable for use database PIPE/PIPE, which exists at Location CAM. Command Syntax: >- DEALLOC/ATE --- ALL ---+--- KEEPMDB/S --. | | ‘----------------+--- AT --- loc ---> >- DEALLOC/ATE - teamid - dbname -+- KEEPMDB/S -. | | ‘------------+-AT-loc-+-INC/LUDING-DESCEND/ANTS-> | ‘------

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 masterchild-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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:36

12 Series

Administrator Command Reference Manual Command Details

Querying:

7.3.23

At a location:

>--- Q DBALL

At a Database:

>--- Q DBLC --->

DEFER (Project definition) 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

7.3.24

DELETE (Project definition) Function: Deletes elements from the project. Notes on Deleted Files When a database is deleted, its file is renamed by addition of the suffix .deleted. The renamed file is actually deleted on the next SAVEWORK or module switch, once the change has been saved in the system or global database. This arrangement allows database files to be recovered after a crash, by the PDMS exit handler. However, if the exit handler cannot be invoked (for example, due to a loss of power) then the files with the .deleted suffix can be restored manually, to make the project directory consistent with the system or global database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:37

12 Series

Administrator Command Reference Manual Command Details

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. Notes on Global Projects: You can only delete Teams, Databases, Locations and Groups at the Hub. Offline locations: When a location is deleted, the system administrator must ensure that the system database for that location is deleted from all other locations. See Running Global Projects with PDMS for further information about deleting databases and extracts from a Global project. Examples:

DELETE DELETE DELETE DELETE

USER TEAM MDB 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. Global Projects only:

DELETE LOCATION Deletes the current Location. This will remove the system database file for that location from all other locations. The location may be deleted provided all databases (other than its transaction database) have been deleted.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:38

12 Series

Administrator Command Reference Manual Command Details

DELETE LOCATION LON Deletes Location LON.

DELETE GRP Deletes the current Location Group.

DELETE LCOMD Deletes the current communication event.

DELETE WORKING EXTRACT FROM CTATEST/DES1 FOR USERA Deletes the working extract for USERA from the database CTATEST/DES1. Working extracts cannot be deleted unless the owning extract is primary at the currently administered location. Command Syntax: >--- DELETE ---+--- USer ------+--- user--------------------------. | | | | ‘----------------------------------| | | |--- TEam ------+--- team_name --------------------| | | | | ‘----------------------------------| | | |--- DB --------+--- db_name ----------------------| | | | | ‘----------------------------------| | | |-- WORKing -+- EXTract --. | | | | | | ‘- VARiant --+- FROM dbname FOR user -| | | |--- MDB -------+--- mdb_name ---------------------| | | | | ‘----------------------------------| | | |--- LOCation --+--- code -------------------------| | | | | |--- location_name ----------------| | | | | ‘----------------------------------| | | |--- GRP ------------------------------------------| | | |--- LCOMD ----------------------------------------| | | |--- MESSage n ------------------------------------| | | |--- MACro n --------------------------------------| | | |--- RUNFile --------------------------------------| | | |--- STAMP ----------------------------------------| | | | .--------<-------. | | / | | ‘--- MOdule ----*--- integer ------| | | | | ‘--- module_name --+---------------+-->

Note: Locations, GRPs and LCOMDs exist in Global Projects only.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:39

12 Series

Administrator Command Reference Manual Command Details

7.3.25

DREMOVE (Project definition) 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.

DREM DB /STEELN /STEELS DBSET /ASET DB /PIPEN Removes the databases /STEELN, /STEELS and /PIPEN, and all the Databases in the DB Set /ASET, from the current DB Set. Command Syntax: .----------------<------------+--<---. | | / .----<-------. | | / / | | | >-- DREMove --*--- DB -------*--- dbname ---+---' | | | | .-------------------<------------. | | / | | | / .-------<-------. | | |/ / | | | *--- DBSET ----*--- dbsetname ---+---+---+---> /

Querying: Q SET DBSET Related Commands: DADD, DELETE, SET

7.3.26

DUMP (Reconfiguration) Function: Writes a reference number index to the given file. Description: If required, the reference index should be written for each database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:40

12 Series

Administrator Command Reference Manual Command Details

Examples:

DUMP /DUMP1 Write reference number index to named file. Command Syntax:

>--- DUmp filename ---> Related Commands: LOAD, XREF

7.3.27

DUPLICATENAMES (Global Project Administration) 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. Example of Command Sequence:

DUPLIC START Initialise memory allocation etc.

DUPLIC FILE /filename Specify file for report. If this command is not given, the report will be sent to the screen.

DUPLIC INCLUDE ALL Include all the Databases in the project in the check.

DUPLIC EXCLUDE DB dbname dbname ... Exclude the named Databases from the check.

DUPLIC CHECK Perform duplicate name check on the Databases specified in the INCLUDE and EXCLUDE options, and exit. The list of Databases to be checked will be emptied. If you want to do another check, you must give the DUPLIC START command again, redefine the list of Databases you wish to check, and give the DUPLIC CHECK command again.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:41

12 Series

Administrator Command Reference Manual Command Details

Other Examples: Other options which you can use to set up the list of Databases are as follows:

DUPLIC INCLUDE DB dbname dbname ... Include the named Databases in the check.

DUPLIC INCLUDE CLEAR Remove all entries in INCLUDE list

DUPLIC INCLUDE LIST List all entries in INCLUDE list

DUPLIC EXCLUDE CLEAR Remove all entries in EXCLUDE list

DUPLIC EXCLUDE LIST List all entries in EXCLUDE list The output reports the element name and the DB reference number and DB number for each of the duplicates, for example:

/00NEB0SED =15196/3964, 7004, =15192/24230, 7000 /00NEB0SFD =15196/3965, 7004, =15192/24231, 7000 /00NEB0SFE =15196/3966, 7004, =15192/24232, 7000 If both MASTER and COPY DBs occur in the list then the DB refs and nos will be identical. If necessary, use the LIST DBS command to associate a DB name with a DB number. Command Syntax: >--- DUPLICatenames START ---> >--- DUPLICatenames FIle filename ---> >--- DUPLICatenames INclude ---+--- ALL ---------------------. | | | .----<-------. | | / | | |--- DB ---*--- dbname ---+---| | | |--- LIST --------------------| | | ‘--- CLEAR -------------------+---> .----<-----------. / | >--- DUPLICatenames EXclude ---+--- DB ---*--- dbname -------+ | | |--- LIST --------------------| | | ‘--- CLEAR -------------------+---> >--- DUPLICatenames CHECK --->

7.3.28

EDIT (Module definition) Function: Enables project module entries to be edited.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:42

12 Series

Administrator Command Reference Manual Command Details

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:

EDIT MODU ADMIN IMACRO /START Enter EDIT mode and edits module ADMIN to add the macro /START as an initialisation macro.

EDIT MODU 77 SECU FR Enter EDIT mode and edits module 77 to make it a FREE module

MODU 77 MODE CATA RW In Edit mode, change module 77 to CATA db with read/write mode.

EDIT MODU DESIGN RES /%PDMSEXE%/DES Change resume file name for DESIGN module entry

EDIT MODU ADMIN IMACRO DELETE Edits the ADMIN module definition and deletes the Imacro entry. 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:43

12 Series

Administrator Command Reference Manual Command Details

7.3.29

ERRORFILE (Data Integrity Checking) 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:

>--- ERRORfile filename ---> Related Commands: MODULE, LIST MODULES

7.3.30

ERRORS (Reconfiguration) 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:

>--- ERRors number ---> Related Commands: BRIEF, FULL, VB

7.3.31

EXCHANGE (Project definition) Function: Replaces the current DB by a non-current DB.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:44

12 Series

Administrator Command Reference Manual Command Details

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:

EXCHANGE PIPING/AREA-A SERV/AREA-D SERV/AREA-E PIPING/AREA-B PIPING/AREA-A and PIPING/AREA-B are the current DBs. They will be replaced by the DBs SERV/AREA-D and SERV/AREA-E respectively, even though they are listed out of sequence. Command Syntax: .--------<----------. / | >-- EXchange ---*--- dbname dbname ---’ | |-----------------------. | | ‘--- integer integer ---+--->

Related Commands: ADD, REMOVE, CURRENT, DEFER

7.3.32

EXCLUDE (Project definition) Function: Removes a database which has been included from an external project. In a Global Project, you can only exclude Databases at the Hub. The database must not be allocated to any satellites. Examples:

EXCLUDE DB MASTER/STEELCATA Remove named DB from current project. Command Syntax:

>--- EXCLude DB dbname ---> Related Commands: INCLUDE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:45

12 Series

Administrator Command Reference Manual Command Details

7.3.33

EXPUNGE (Project Administration) 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 command, where 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 daemon 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 multiwrite database. These elements may be inaccessible after a user has exited abnormally. This is not allowed if there are current users accessing the DB.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:46

12 Series

Administrator Command Reference Manual Command Details

EXPUNGE DB SYSTEM Releases elements which have been claimed in a SYSTEM database. These elements may be inaccessible after a user has exited abnormally.

EXPUNGE DAEMON Expunge the Global daemon user (Global projects only). Note the EXPUNGE DAEMON command does not stop the Global daemon process. The Global daemon user is not expunged by default - however certain commands (such as MERGE CHANGES on a Transaction db) will fail if there is still a session for the Daemon user. Command Syntax: .-----<--------------------------------. / | >-- EXPUNGE --*-- process_id --------------------------| | | |-- user ---------+-- username ----------| | | | | ‘-- slot nnnn ---------| | | |-- DB dbname ----+-- USER usernumber ---| | | | | ‘----------------------' | |-- DB SYSTEM ----. | | |-- DB GLOBAL/DB -| | | |-- DAEMON -------| | | ‘-----------------+----------------->

Note: All the EXPUNGE syntax can be applied to a remote Location in a Global Project by prefixing the command by REMOTE , where is the Location identifier. See the REMOTE command for examples. Querying: Q ACTIVE Related Commands: SYSTAT, For Global projects - REMOTE, REMOTE EXPUNGE

7.3.34

EXTERNAL (Data Integrity Checking) 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:47

12 Series

Administrator Command Reference Manual Command Details

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 An example of the output when EXTERNAL CHECK is specified: External databases referenced _____________________________ Number ______

Name ____

8 31

No of references ________________

GLB/DESI TECHP/TPDESI

41 4

Command Syntax: >--- EXTernal ---+--- NOCHeck* ---. | | |--- CHECK ------+-- PREFERENCE | | ‘--- REject -----+--->

The default is NOCHECK.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:48

12 Series

Administrator Command Reference Manual Command Details

7.3.35

EXTRACT (Project Administration) 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

A flush reset command will completely clear the flush stack for the extract. In most cases the system will resolve any dependencies between issued flush commands, including any resets required after failed flush commands. Only as a last resort should the user consider issuing a Flush Reset command.

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 Administrator User Guide. For information about using extracts in Global projects, see Running Global Projects. 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:49

12 Series

Administrator Command Reference Manual Command Details

commands can only be issued locally. There is no mechanism at an offline location to claim (etc.) from an online location. Examples:

EXTRACT FULLREFRESH DB PIPE/PIPE-X1 Refreshes all parent extracts in the database hierarchy above PIPE/PIPE-X1, ending by refreshing PIPE/PIPE-X1 itself with changes to its parent extract.

EXTRACT REFRESH DB PIPE/PIPE-X1 Refreshes database PIPE/PIPE-X1 with changes to its parent extract.

EXTRACT RELEASE DB PIPE/PIPE-X1 Releases all extract claims in database PIPE/PIPE-X1.

EXTRACT ISSUE DB PIPE/PIPE-X1 Issues all changes to database PIPE/PIPE-X1 and releases the extract claim.

EXTRACT FLUSH DB PIPE/PIPE-X1 Writes the changes to database PIPE/PIPE-X1 back to its parent extract, but keeps the elements claimed to the extract. Also, PIPE/PIPE-X1 is refreshed with changes to its owning database.

EXTRACT FLUSHW DB PIPE/PIPE-X1 Writes the changes to database PIPE/PIPE-X1 back to its parent extract, but keeps the elements claimed to the extract. PIPE/PIPE-X1 is not refreshed.

EXTRACT DROP DB PIPE/PIPE-X1 Drops all changes to database PIPE/PIPE-X1.

EXTRACT FLUSH RESET DB PIPE/PIPE-X1 Undo any failed or incomplete flushes on this database. Command Syntax: >-- EXTRACT -+| | || || || || || ‘-

FLUSH --+------------. | | ‘--- RESET --| FLUSHWithoutrefresh -| | RELEASE -------------| | ISSUE ---------------| | DROP ----------------| | FULLREFRESH ---------| | REFRESH -------------+- DB - dbname -->

Note: In ADMIN, you cannot carry out partial operations as you can in the constructor modules. The commands can only be applied to entire DBs.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:50

12 Series

Administrator Command Reference Manual Command Details

7.3.36

FINISH (General PDMS Command) Function: The FINISH command saves work and leaves PDMS. Examples:

FINISH Command Syntax:

>--- FINISH ---> Related Commands: SAVEWORK

7.3.37

FONTDIRECTORY (Font definition) Function: Sets the font directory name. Description: The font directory stores the AVEVA 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:

>--- FONTDirectory name ---> Querying:

>--- Q FONTDirectory ---> Related Commands: FONTFAMILY, Q FONTS

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:51

12 Series

Administrator Command Reference Manual Command Details

7.3.38

FONTFAMILY (Font definition) Function: Defines a AVEVA 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:

FONTFAMILY font_no IR ir_no STYLE style_no ANGLE angle FONTFAMILY font_no FILE /abc BOLD /def ANGLE angle PROJECT MBCHARSET JAPAN ANGLE angle FONTFAMILY 1 IR 4 STYLE 1 FONTF 2 UK ITALIC FONTF 3 UK BLOCK FONTF 4 GREEK STYLE 1

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:52

12 Series

Administrator Command Reference Manual Command Details

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:

>--- Q FONTFamily integer --->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:53

12 Series

Administrator Command Reference Manual Command Details

7.3.39

FROM (Reconfiguration) 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: >--- From ---+--| |--| |--| |--| |--| |--| |--| ‘---

DBFile filename ----------------------------. | DB dbname ----------------------------------| | PROJect code dbname ------------------------| | SYSTEM -------------------------------------| | GLOBAL -------------------------------------| | FIles --------------------. | | | BINaryfiles --------------| | | | FORMattedfiles -----------+--- name name ---+-->

Related Commands: RECONFIG, RCFCOPY, TO

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:54

12 Series

Administrator Command Reference Manual Command Details

7.3.40

FULL (Reconfiguration) 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:

>--- FUll ---> Related Commands: BRIEF, VB, ERRORS

7.3.41

GENERATE (Global Project Administration - Hub only) 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. When a location is generated, it will allocate the system database for that location to other locations as part of the generation process.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:55

12 Series

Administrator Command Reference Manual Command Details

Examples:

GENERATE LOCATION LON Generates a location with identifier LON. By default, all Databases at the Hub will be allocated to LON.

GENERATE LOCATION /LONDON Generates a location /LONDON, allocating all databases.

GENERATE LOCATION LON NOALLOCate Generates a location with identifier LON. No Databases will be allocated. Note: If the location identifier contains numeric characters, it must be enclosed in quotes. Command Syntax: >-- GENerate LOCation --+--- ALLOCate -----. | | ‘--- NOALLOCate ---+-->

Related Commands: INITIALISE For Offline locations: TRANSFER Querying:

>--- Q LINIT ---> >--- Q DBALL ---> >--- Q DBPRIM --->

7.3.42

GETWORK (General PDMS Command) 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. Command Syntax:

>--- GETWORK ---> Related Commands: SAVEWORK

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:56

12 Series

Administrator Command Reference Manual Command Details

7.3.43

HUBLOCATION (Global Project Administration - Hub only) 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 Global User Guide for more information on Hub administration. If a HUBLOCATION command fails, the previous Hub will normally be recovered automatically. If the recovery fails (for example, the daemon is not running), you can recover the previous Primary location using the command: PREVOWN HUB Use of the PREVOWN command should be avoided if possible. Examples:

HUBLOCATION LON Relocates the Hub to location with identifier LON.

HUBLOCATION LON AT 20:00 Relocates the Hub to location with identifier LON at 2000 hrs. Command Syntax: >--- HUBLOCation ---+-----------------. | | ‘--- AT ---+---> Related Commands: PREVOWNER HUB, ALLOCATE ALL Querying:

>--- Q HUBRF --->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:57

12 Series

Administrator Command Reference Manual Command Details

7.3.44

INCLUDE (Project definition) 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:

INCLUDE DB MASTER/PIPECATA FROM PROJ MAS USER USERA/A The database MASTER/PIPECATA from project MAS will be included in the current project. The user/password (USERA/A in this example) must be a FREE user in the source project.

INCLUDE DB MASTER/PIPECATA FROM PROJ MASTER USER FRED. BLOGGS1/B Similar using long project identifier and non-alphabetic username. Command Syntax: >---INCLude DB dbname FROM PROject projectid USer username/password--->

Related Commands: CNAME, MOVE, CHANGE, EXCLUDE, COPY

7.3.45

INITIALISE (Global Project Administration) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:58

12 Series

Administrator Command Reference Manual Command Details

When you first use a Global project, it is necessary to initialise the Hub. The Hub transaction database must be created before initialising. Examples:

INITIALISE Command Syntax: >--- INITIALise ---> Related Commands: GENERATE LOCATION Querying: Q LINIT

7.3.46

ISOLATION (Global Project Administration) 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).

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:59

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >--- ISOLATion ---+--- TRUE ----. | | ‘--- FALSE ---+--- AT ---. | | ‘----------------+--->

Querying: >--- Query ISOLATion ---+--- AT ---. | | ‘----------------+--->

7.3.47

LIST (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 DBS OF TYPE DESI Lists all the Databases of type DESI in a project.

LIST TEAMS Lists the Teams in a project.

LIST COPIES Lists the DBs in a project which have been copied and the filenames of the copies.

LIST ALL Lists the Users, Teams, Databases and MDBs in a project.

LIST FILES Lists the DBs in a project and their corresponding filenames in the Project directory.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:60

12 Series

Administrator Command Reference Manual Command Details

LIST MESSAGES Lists inter-user messages.

LIST MODULES Produces information on all the PDMS modules used by the project.

LIST MODULES 5 Produces information on module 5.

LIST MODULES DESIGN Produces information on module DESIGN.

LIST MESSAGES Lists inter-user messages.

LIST PASSWORDS Lists users’ ids s.

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 WORKing EXTracts Lists the working extracts.

LIST WORKing EXTracts FOR user Lists the working extracts for the specified user.

LIST WORKing EXTracts dbname Lists the working extracts for the specified DB.

LIST AUTHUSER Lists Windows NT authenticated users.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:61

12 Series

Administrator Command Reference Manual Command Details

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

7.3.48

LOAD (Reconfiguration) Function: Loads the reference number index from the given file.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:62

12 Series

Administrator Command Reference Manual Command Details

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: >--- LOad ---+--- APPEND ---. | | ‘--------------+--- filename --->

Related Commands: DUMP, REINIT, XREF

7.3.49

LOCK (Project Administration) 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 Locks the Project database at the remote Location LON. Only available at the Hub of a Global Project or at the administering location for the location (in this example, the administering location for LON). Command Syntax: >--- LOCK ------>

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:63

12 Series

Administrator Command Reference Manual Command Details

Related Commands: UNLOCK Querying:

>--- Query LOCK ---> Only available at Hub of a Global Project or at the administering location: >--- Query LOCK ---+--- AT ---. | | ‘-----------------+--->

7.3.50

MAKE GLOBAL (Global Project Administration) 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 Global User Guide. Examples:

MAKE GLOBAL Command Syntax:

>--- MAKE GLOBAL --->

7.3.51

MAXERRORS (Data Integrity Checking) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:64

12 Series

Administrator Command Reference Manual Command Details

Description: In FULL mode, DICE checks the DB or files specified, listing all errors and warnings, until a prescribed maximum number of errors or warnings is exceeded. Checking of that DB is then abandoned. The default setting for the maximum error count is 50, but you can specify a different number by using the MAXERRORS command. Examples:

MAXERRORS 100 Related Commands: MODE, MAXWARNINGS Command Syntax: >--- MAXErrors

7.3.52

integer --->

MAXUSERS (Project Administration) 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 license restrictions. Examples:

MAXUSERS 10 Command Syntax: >--- MAXUSers integer --->

7.3.53

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:65

12 Series

Administrator Command Reference Manual Command Details

Example:

MAXWARNINGS 100 Related Commands: MODE, MAXERRORS Command Syntax: >--- MAXWarnings

7.3.54

integer --->

MERGE CHANGES (Project Administration) 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, you can issue REMOTE MERGE commands if you are at the Hub or are administering the Primary location of a database, even if that is not your current location. See the REMOTE command for more examples. After you merge changes, some session data is deleted. The sessions remaining are those that you have either kept deliberately, or stamped sessions, as these cannot be merged. With the FILEPURGE option all .SDB and .PIC files that become obsolete as of a session merge operation will be deleted as part of the operation. This is relevant only for PADD databases. As alternative method to delete obsolete .SDB files see User Guide Marine Drafting / Appendices / Remove Obsolete .SDB Files. 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:66

12 Series

Administrator Command Reference Manual Command Details

Examples:

MERGE CHANGES HVAC/PADD AFTER SESSION 4 BEFORE SESSION 10 Merges all the changes to the HVAC/PADD database after session 4 and before session 10, that is all changes made in sessions 5 to 9 will be combined. If there are any stamped sessions in sessions 5 to 9, they will be kept. The team id (HVAC) can be omitted if a current team is set.

MERGE CHANGES HVAC/PADD AFTER STAMP/ stamp_012 BEFORE STAMP /stamp_016 Merges all the changes to the HVAC/PADD database for sessions that are after the session stamped with stamp_012 and before the session stamped with stamp_016. All changes made in stamped sessions that are between the sessions stamped with stamp_012 and stamp_016 will be combined. If there are any other stamped sessions, they will be kept. The team id (HVAC) can be omitted if a current team is set.

MERGE CHANGES /HVAC BEFORE 10:30 31 / 8 / 01 MERGE CHANGES /HVAC BEFORE 10:30 31 AUGUST 2001 Merges all the changes to the HVAC database before 10.30 am on the 31 August 2001. If the time is omitted, 11.59 is assumed. If the month is not given, the current month is assumed. If the year is not given, the current year is assumed. If there are any stamped sessions, they will be kept.

MERGE CHANGES PROJECT Merges all the changes to all databases in the project, except stamped sessions. A range of dates may be specified, but not a session number.

MERGE CHANGES SYSTEM Merges all the changes to the System database. A date, session number or stamp cannot be specified. In a Global project, you must be administering the System database and be at its primary location.

MERGE CHANGES GLOBAL This command is only available in a Global project, at the Hub. Merges all the changes to the Global database. A date, session number or stamp cannot be specified. Command Syntax for Standard (Non-Global) project

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:67

12 Series

Administrator Command Reference Manual Command Details

Note: do not apply to the SYSTEM or Global db. Command Syntax for Global project:

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 , where is the Location identifier. MERGE CHANGES SYSTEM applies to the currently administered system database. See the REMOTE command for examples. Related Commands: BACKTRACK, REVERT, REMOTE Querying: Q SESSION

7.3.55

MESSAGE (Project Administration) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:68

12 Series

Administrator Command Reference Manual Command Details

Examples:

mess team piping ’the latest pipe routing has been approved’ Command Syntax: >--- MEssage ----+--- ID text ------| |--- USer userid --| |--- TEam teamid --| |--- HOST ---------| |--- LOGIN --------| ‘-------------------

text ----------. | text ----------| | text ----------| | text ----------| | text ----------| | text ----------+-->

Querying: LIST MESSAGE Related Commands: DELETE MESSAGE, REMOTE MESSAGE (Global Projects only)

7.3.56

MODE (Data Integrity Checking) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:69

12 Series

Administrator Command Reference Manual Command Details

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: >--- MOde ---+--- BRief ---. | | ‘--- FUll ----+--->

The default is BRIEF.

7.3.57

MODULE (Module Definition) 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: Examples: OPEN

specifies a data file which the module is expecting to have opened for it.

MODE

specifies the modes (Read, Read/Write etc.) in which the various types of DB comprising the current MDB are to be opened.

RESUME

specifies the name of the runfile of the module to be used for this project.

SECURITY

specifies the security rating of the module.

BUFFER

specifies how much space is to be reserved for the DABACON buffer. The default value is 2560000 but the Administrator may specify a larger or smaller value than this. Note that the buffer size should be at least this value in projects where distributed Extracts are being used.

IMACRO

specifies the name of an initialisation macro.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:70

12 Series

Administrator Command Reference Manual Command Details

Module 78

DESIGN Security Free Mode DESI Default Mode PROP R Mode CATA R Mode DESI RW Resume /%PDMSEXE%/des

Command Syntax: >- MODule -+--- integer module_name -. | | ‘--- module_name integer -+- newline -->

where the keywords are defined as follows: .--------------------------. / | >--- Open ---*--- ATTLIB filename --------| | | |--- SYMBOLFILE filename ----| | | ‘--- MESSagefile filename ---+--> >--- Mode dbname ---+--| |--| |--| ‘---

RW --------. | Read ------| | None ------| | DEFault ---+--->

>--- Resume filename ---> >--- Security ---+--- FRee ---------. | | ‘--- GEneral ------+---> >--- Buffer ---+--- integer -----. | | ‘--- DEFault -----+---> >--- IMACRO name ---> Related Commands: LIST MODULES, DELETE MODULES, EDIT

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:71

12 Series

Administrator Command Reference Manual Command Details

Querying: .----------------. / | >--- Query MOdule ---*--- integer ------| | | ‘--- module_name --+---

7.3.58

MOVE (Project Administration) 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: xxxnnn

set to

pathname

where xxx is the Project Code, for example, abc, and nnn is a number, for example, 001. When the database is created, the area number of the database must then be set to the corresponding value, in this example, 1. In a Global Project, this command can only be carried out at the Hub. The area directories must exist at all Locations to which the Database is allocated. Example:

MOVE DB HVAC/HVAC TO AREA 051 Command Syntax: >--- MOve DB dbname TO AREA integer ---> Related Commands: CNAME, CHANGE, INCLUDE, EXCLUDE

7.3.59

NEW (Project definition and Global Project Administration) Function: Create an ADMIN element. Description: This command is used:

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:72

12 Series

Administrator Command Reference Manual Command Details

•

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

Examples (any Project):

NEW ROLE /SnrPiper Creates a new Role named SnrPiper.

NEW PEROP /MaxBore Creates a new Permissible Operation named MaxBore. The current element must be a Role.

NEW SCOPE /AREA-A Creates a new Scope named Area-A.

NEW DBSET /ASET-A Creates a new DB Set named ASET-A

NEW ACR /ACR-A Creates a new ACR named ACR-A

NEW ACRST /ACRSET Creates a new DB Set named ACRSET Note: After creating the above elements, you will need to set their attributes.

NEW TTFONT TTFIND5 TTFACE ‘ARIAL’ TTFDES ‘ARIAL’ Creates a new TTFONT element for the font ‘Arial’ at index 5

NEW TTFONT TTFIND6 TTFACE ‘TIMES NEW ROMAN’ TTFDES ‘TIMES’ Creates a new TTFONT element, with description abbreviated to ‘TIMES’, at index 6. Command Syntax (any Project): >-- NEW ---+--| |--| |--| |--| |--| |--| |--| |--| ‘---

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

ROLE /name -------------------------------. | PEROP /name -------------------------------| | SCOPE /name -------------------------------| | TEAM /name --------------------------------| | ACR /name ---------------------------------| | ACRST /name -------------------------------| | MDB /name ---------------------------------| | DBSET /name -------------------------------| | TTFONT integer --TTFACE text --TTDES text -+-->

7:73

12 Series

Administrator Command Reference Manual Command Details

Examples (at the Hub of a Global project):

NEW LOCATION /CAMBRIDGE Creates a new location named CAMBRIDGE.

NEW GRP /AUSTRALIA Creates a Location Group named AUSTRALIA.

NEW LCOMD /NORMAL Creates a Communications Event named NORMAL.

NEW LCTIMD /EVENTS/NORMAL Creates an Events timing element named EVENTS/NORMAL. Command Syntax (at the Hub of a Global project): >--- NEW ---+--| |--| |--| ‘---

LOC /name -----| | GRP /name -----| | LCOMD /name ---| | LCTIMD /name --+--->

Related Commands: CREATE

7.3.60

NEW STAMP (Project Administration) 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:74

12 Series

Administrator Command Reference Manual Command Details

Example:

NEW STAMP /Stamp_007 Creates a new stamp named Stamp_007.

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

Related Commands: BACKTRACK, MERGE CHANGES, REVERT Querying: where the current element is a stamp.

>--- Query attribute --->

7.3.61

PASSWORDLOCK Function: Grant or prevent the ability for users to reset their own password in Monitor. Examples: PASSWORDLOCK ON PASSWORDLOCK OFF Command Syntax: >- PASSWORDLOCK -+- ON ---> | '- OFF ---> Querying: >--- Q PASSWORDLOCK -->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:75

12 Series

Administrator Command Reference Manual Command Details

7.3.62

PING (Global Project Administration) 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:

>- PING ---> Note: This command is now also available in other modules, such as DESIGN and DRAFT. Related Commands: Q COMMS

7.3.63

PREVOWNER (Global Project Administration - Hub only) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:76

12 Series

Administrator Command Reference Manual Command Details

Note: PREVOWNER is not usually needed after a failure of this command since it contains an in-built recovery operation. However, the automatic recovery operation does not cover the CREATE command Allocate operation and PREVOWNER may be needed in the unlikely event of this failing. In all other circumstances it is better to await the completion of the in-built recovery operation, since this prevents incompatible changes being made by two competing users at different locations. Note: This command cannot be used to reverse a successful CHANGE PRIMARY, HUBLOCATION or SYSTEMLOCATION command. Examples:

PREVOWNER HUB PREVOWNER dbname PREVOWNER SYSTEM

Command Syntax: >--- PREVOwner ---+--- HUB ---------------. | | |--- SYSTEM ------| | | ‘--- dbname ------------+--->

Related Commands: HUBLOCATION, SYSTEMLOCATION, CHANGE PRIMARY Querying:

>--- Query PRVRF ---> This query must be used at the appropriate element. For CHANGE PRIMARY, this is DBLOC 1 of ; for SYSTEMLOCATION, this is ; for HUBLOCATION, this is /*GL.

>--- Query NXTHB ---> If a problem occurs with the HUBLOCATION command, you can use this query at /*GL to query NXTHB. NXTHB is used to record the future new Hub until the HUBLOCATION command has completed.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:77

12 Series

Administrator Command Reference Manual Command Details

7.3.64

PROJECT (Project definition) Function: Adds descriptive information to project definitions, sets project sub type i.e. Plant. Also used to set Multibyte characters sets for fonts such as Kanji. You can, optionally, specify a second (bold) user-defined font file for multibyte fonts. In a Global Project, the Name, Description, Number and MBCHARSET can only be set at the Hub. The Message can be set at all Locations. Description: The descriptive information will be displayed each time the project is entered. The attributes which can be set, with their maximum number of characters, are: NAME

119 characters

DESCRIPTION

119 characters

MESSAGE

119 characters

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 as defined by %ABC000ID%. Examples:

PROJ NAME ’STABILIZER’ PROJ DESCRIPTION ’CADC TRAINING PROJECT’ PROJ MBCHAR JAPANESE PROJ MBCHAR 87

(where 87 is the ISO Standard Font number).

PROJ MBCHAR LATIN FILE /lat_std BOLD /lat_bld PROJ CHARSET LATIN 2 The type parameter can be used to change the project sub type between Plant and Marine. The PROJECT TYPE ALLOWCHANGE command must be invoked first in order to activate the project type changing capability.

PROJECT TYPE ALLOWCHANGE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:78

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >- PROJect -+-- NUMber text ------------------------------------------------. | | |-- NAMe text --------------------------------------------------| | | |-- DEScription text -------------------------------------------| | | |-- MESsage text -----------------------------------------------| | | |- MBCHARset -+- integer --. | | | | | | |- JAPanese -| | | | | | | |- CHInese --| | | | | | | |- LATIN ----+- FILE -+- name -+- BOLD name -. | | | | | | | | | | | | ‘-------------| | | | | ‘- DEFAULT ------------| | | | ‘-------------------------------| | | | | | | | .-------<------' | | | | | | ‘-+- KORean ---. | | | | | | | | ‘- TCHINese -+--FILE name --+- ANGLE integer ---| | | | | ‘-------------------+-> |- CHARset -+- IR integer ---------. | | | | ‘- LATIN -+- integer --| | | | | |- CYRIllic -| | | | | ‘------------+-> | | `- TYPe -+- ALLOWchange -. | | |- MARine ------| | | `- PLAnt -------+->

Querying: >--- Q PROject --+-| |-| |-| |-| |-| |-| |-| `--

NUMber -------. | NAMe ---------| | DEScription --| | MESsage ------| | CODe ---------| | MBCHARset ----| | CHARset ------| | TYpe ---------+->

Q PROJ ID returns the external project identifier 8 character alphanumeric ID defined by %ABC000ID%. An administrator can also query the project type through the following syntax:

Q PROJ TYPE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:79

12 Series

Administrator Command Reference Manual Command Details

7.3.65

PURGE (Project Administration and Global Project Administration) 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:

PURGE OLD FILES Deletes all files in the Project with the suffix .admold.

PURGE OLD FILES DB Deletes all database files in the Project with the suffix .admold.

PURGE OLD FILES PICTURE Deletes all picture files in the Project with the suffix .admold. Command Syntax: >--- PURGE ---+--- OLDfiles ---+----------------. | | | | |--- DB ---------| | | | | ‘--- PICture ----| | | ‘--- DB dbname -------------------+--->

Related Commands: TRANSFER

7.3.66

QUERY (Querying) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:80

12 Series

Administrator Command Reference Manual Command Details

Examples:

Q COPIES PIPING/AREA-A List the copies of DB PIPING/AREA-A

Q LINEWIDTHS List the system defined line widths used in DRAFT

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:81

12 Series

Administrator Command Reference Manual Command Details

Note: The superseded ELCCNT pseudo-attribute is retained as a synonym for HCCNT. HCCNT is available at /*S and /*GS elements as well as at DB elements.

Q CLCCNT At a DB element, gives the claim list changes count. This value increases when elements are claimed or dropped without other changes to the database. Note: In a Global project, the above three attributes together with session information can be used to compare the state of the database at different locations. For information about this, see Running Global Projects with 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:82

12 Series

Administrator Command Reference Manual Command Details

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 attributes are also useful:At a LOC element,

Q DBALL lists the allocated dbs;

Q DBPRIM lists the primary dbs; At a DB element,

Q DBLC lists the locations where it is allocated; At either DB or LOC,

Q PRMLOC indicates its Primary location 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:83

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >- Q --+- Authuser -------. | | |- Authentication -| | | |--- USer ---------| | | |--- TEam ---------+--- word ------------------. | | |--- DB -------. | | | | |--- COpies ---+--- dbname --------------------| | | |--- DBNO dbno --------------------------------| | | |--- MDB name ---------------------------------| | | | .-------<-----. | | / | | |--- MOdule ---*--- integer ---| | | | | | | ‘--- word ------+---------------| | | |--- LOck -------------------------------------| | | |--- DDL --------------------------------------| | | |--- SET ---+--- TEam -------------------------| | | | | |--- DBSet ------------------------| | | | | ‘--- MDB --------------------------| | | |--- PROject ----------------------------------| | | |--- SESSIONS --+-- SINCE --. | | | | | | |-- LAST ---+- n --+-----------| | | | | | ‘—- ON -----+-dbname ---| | | |--- CLAIM dbname -----------------------------| | | |--- PASSWORDLOCK -----------------------------| | | |--- NEWREF oldref ----------------------------| | | |--- MAXUSers ---------------------------------| | | |--- ACTIVE -----------------------------------| | | |--- MACRO n ----------------------------------| | | ‘--- INFOrmation --+--- dbname ----------------| | | ‘--- SYSTEM ----------------+--->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:84

12 Series

Administrator Command Reference Manual Command Details

The following options are only available in a Global Project. >--- Q COMMS ---+--- TO ---. | | ‘----------+--- ---+--- INPUTPackets ----. | | |--- OUTPUTPackets ---| | | |--- INPUTRequests ---| | | |--- OUTPUTRequest ---| | | |--- PATH ------------| | | ‘---------------------+--> >-->-->-->-->-->---

Q Q Q Q Q Q

ADMLOC ---> CURLOC ---> ISOLAT AT ---> LOCK AT ---> --+-- READERS --. COMMS ---+--- TO ---. | | ‘----------+--- ---+--- INPUTPackets ----. | | |--- OUTPUTPackets ---| | | |--- INPUTRequests ---| | | |--- OUTPUTRequest ---| | | |--- PATH ------------| | | ‘---------------------+-->

>-->-->-->-->---

Q Q Q Q Q

ADMLOC ---> CURLOC ---> ISOLAT AT ---> LOCK AT ---> --+-- READERS --. | | ‘-- WRITERS --+- --. | | ‘-------------+--- AT --. | | ‘---------------+-- COUNT --. | | ‘-----------+-->

For details of Q REMOTE, see under REMOTE Related Commands: LIST, Q REMOTE

7.3.67

RCFCOPY (Reconfiguration) Function: Defines the part of the database to be copied from the source DB to the destination DB before reconfiguration.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:85

12 Series

Administrator Command Reference Manual Command Details

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:86

12 Series

Administrator Command Reference Manual Command Details

7.3.68

RCFUPDATE (Reconfiguration) 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 Updates references in DB MASTER/DESIGN for any elements that have been copied with RCFCOPY. Use this option with care because it is possible to update a reference that has already been changed by the RECONFIGURE command.

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

RCFUPDATE TEAM STEEL Updates references to the reconfigured DB from all appropriate DBs owned by team STEEL.

RCFUPDATE ALL Updates references to the reconfigured DB from all databases in current project. Command Syntax: >--- RCFUPdate ---+--- DB dbname -+--------------. | ‘-- INTERNAL --| | | |--- MDB mdbname --------------| | | |--- TEam teamname ------------| | | |--- ALL ----------------------| | | ‘------------------------------+-->

Related Commands: RECONFIGURE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:87

12 Series

Administrator Command Reference Manual Command Details

7.3.69

RCFUPGRADE (Reconfiguration) 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: >-- RCFUPGRADE --+-- ON ----. | | ‘-- OFF ---+-->

7.3.70

RECONFIGURE (Reconfiguration) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:88

12 Series

Administrator Command Reference Manual Command Details

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, refer to Running Global Projects.

•

If the TO database is allocated to other locations, the Recover command should be used to copy the database to all secondary locations.

Examples:

RECONFIGURE Command Syntax: >--- RECONfigure ---+---- FORCE ----. | | |--- SESSIONS --| | | ‘--- SAMEREF ---+--->

Related Commands: FROM, TO, RCFCOPY, RENEW (Global project only)

7.3.71

RECOVER (Global Project Administration) 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. Note: The Global database can sometimes be recovered using the daemon. If the Global database for a location is corrupt or the network of locations has changed, it cannot be recovered using the daemon, since the daemon needs to use the Global database to understand the network. The System Administrator must copy this database to the required locations outside PDMS. Refer to Running Global Projects guide for detailed description of this process.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:89

12 Series

Administrator Command Reference Manual Command Details

When Reconfiguring or Renewing a database, you should then recover the database at all its secondary locations in order to prevent reverse propagation. This also applies if a database is replaced by one from another project. The RECOVER TO ALL command can be used to recover a database from its primary location to all secondary locations. Examples: The examples are based on the following configuration:

Secondary constructor DBs

RECOVER PIPEN/PIPEN Recovers from BBB or DDD, whichever is the most recent.

RECOVER STEELN/STEELN Recovers from BBB, that is the next DB on the route to the Primary Location

RECOVER STEELN/STEELN FROM DDD Recovers from DDD. Remote recovery of secondary constructor DBs (available from the Hub or the administering location of the satellite)

RECOVER STEELN/STEELN AT DDD Recovers from CCC, the only neighbouring Location in this case. If there was a child of DDD, the recovery would be from the most recent copy.

RECOVER STEELN/STEELN AT DDD FROM BBB Recovers DB at DDD from BBB 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:90

12 Series

Administrator Command Reference Manual Command Details

Remote recovery of System DBs (available at the Hub or the administering location of the satellite)

RECOVER SYSTEM FOR EEE AT AAA FROM BBB Recovers AAA's copy of the System database for EEE from the copy at BBB. System DBs

RECOVER SYSTEM FOR EEE FROM BBB Recovers System database for EEE from the copy at BBB.

RECOVER SYSTEM FROM BBB Recovers System database for the true current location from BBB. Remote recovery of System DBs (available at the Hub or the administering location of the satellite)

RECOVER SYSTEM FOR EEE AT AAA FROM BBB Recovers AAA's copy of the System database for EEE from the copy at BBB. System DBs

RECOVER SYSTEM FOR EEE FROM BBB Recovers System database for EEE from the copy at BBB.

RECOVER SYSTEM FROM BBB Recovers System database for the true current location from BBB. Remote recovery of System DBs (available at the Hub or the administering location of the satellite)

RECOVER SYSTEM FOR EEE AT AAA FROM BBB Recovers AAA's copy of the System database for EEE from the copy at BBB. Recover to All Locations

RECOVER PIPEN/PIPE TO ALL Recover a database to all allocated locations. The command can only be issued from the HUB, the Primary location of a database or the administering location of its Primary location.

RECOVER PIPEN/PIPE AT CCC TO ALL Note that this will recover the database from its primary location to online secondary locations, even if the destination is not explicitly stated. The syntax RECOVER AT FROM should be used to recover a database from a secondary location.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:91

12 Series

Administrator Command Reference Manual Command Details

Recover a Global database

RECOVER GLOBAL TO ALL The user can recover a Global db from the HUB to a satellite or satellites. The command is only available from the HUB.

RECOVER GLOBAL AT If the AT locations are omitted, then the database will be recovered at the Current location from the next location on the route to the project HUB. It is recommended that changes to the network are not distributed this way, since results might be unpredictable. The user should refer to Running Global Projects guide for the recommended recovery procedure. Command Syntax: >- RECOVer -+- SYSTEM -+-- FOR -. | | | | ‘--------------| | | ‘- dbname ----------------+- AT ------. | | |-----------------+-- FROM --. |-To ALLlocations-+ | | | | ‘-----------------+---------------+-->

7.3.72

REINIT (Reconfiguration) Function: Re-initialises the reference number index. Description: Re-initialises the reference number index in database reconfiguration. Command Syntax: >--- REinit ---> Related Commands: DUMP, LOAD

7.3.73

REMOTE (Global Project Administration) Function: Allows the Hub or the Administering Location of a Satellite to carry out the following tasks for constructor or system databases at a Satellite: •

BACKTRACK

•

REVERT

•

MERGE CHANGES

•

EXPUNGE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:92

12 Series

Administrator Command Reference Manual Command Details

•

CHECK

Other than when the REMOTE . . . CHECK command is used, the databases must be primary at the destination Satellite. Note: REMOTE MERGE should be considered as a Global Merge, since it affects all available locations to which the database is allocated, including its secondary locations. At Global 12 you can perform Queries on the REMOTE function to allow reporting on session details and other file details for remote satellites. The REMOTE . . . BACKTRACK, REVERT, MERGE CHANGES and EXPUNGE commands can be given at the Hub, the Satellite itself or the administering location. The Satellite itself may need to use the REMOTE version of the command, because it may not have write access to the system database. The administering Location may need to use the REMOTE version of the command, because it may not have write access to the constructor database. The REMOTE . . . CHECK command can be given at any location. Certain REMOTE commands cannot be used for Extract databases - see below. 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.

•

Global Merging (syntax 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 Global MERGE command (syntax REMOTE MERGE) has completed for the database. 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 parameter syntax REMOTE MERGE CHANGES GLOBALDB where is the project hub can be used to merge a Global Database. The Remote Merge command can be scheduled by using the AT parameter show in the following examples.

•

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-

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:93

12 Series

Administrator Command Reference Manual Command Details

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 must be merged in PDMS using the MERGE command.

Examples: For details of time and date syntax, see Notes on Syntax Graphs. BACKTRACK

REMOTE BACKTRACK dbname TO 14:30 REMOTE BACKTRACK dbname TO SESS 17 Backtracks changes to the given database, which must be Primary at the named location. A database cannot be backtracked through a stamp. REVERT

REMOTE REVERT dbname TO 14:30 REMOTE REVERT dbname TO SESS 17 Adds a session reverting to the data at the specified session or date. The database must be Primary at the named location. MERGE CHANGES REMOTE MERGE CHANGES dbname BEFORE 31 MARCH REMOTE MERGE CHANGES dbname BEFORE SESSION 9 AFTER SESSION 4

Merges changes to the given database, which must be Primary at the named location. Stamped sessions will not be removed by the merge.

REMOTE MERGE CHANGES SYSTEM Merges changes to the system database for the location .

REMOTE MERGE CHANGES SYSTEM FOR Merges changes to the system database for , which must be administered by .

REMOTE MERGE CHANGES AT 23:00 <mergeoptions> Merge changes at a specified time, in this case at 23:00 hours. Where <merge-options> are the normal Before/After session information described above.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:94

12 Series

Administrator Command Reference Manual Command Details

REMOTE MERGE GLOBALDB Merges the Global database at location . EXPUNGE

REMOTE EXPUNGE REMOTE EXPUNGE username Expunges all users or the given user from the communications database at the given Location. username is the PDMS username.

REMOTE REMOTE REMOTE REMOTE



EXPUNGE EXPUNGE EXPUNGE EXPUNGE

DB DB DB DB

dbname dbname USER username SYSTEM SYSTEM FOR

Expunges all users or the given user from the given database at the given Location. The database must be primary at the given Location. Username can be the PDMS username or a session number. DICE Checking

REMOTE REMOTE REMOTE REMOTE REMOTE



CHECK CHECK CHECK CHECK CHECK

SYSTEM DB dbname MISCDB dbname COMMDB SYSTEMDB FOR

Performs a standalone DICE check on the given database at the given Location. The database does not need to be primary at the given Location. The check uses the current MODE, STATISTICS, MAXERRORS and MAXWARNINGS settings. Cancelling commands

REMOTE CANCEL Allows an Admin user to cancel a command at another Location , where is a TRINCO in the transaction database for the given Location (this is not the current Location, unless is the current Location). This command requires an up-to-date version of the transaction database for Location to be available at the current Location. (The transaction database is not normally propagated. It is best to RECOVER this database from the primary location rather than to SYNCHRONISE it.) Note: Only commands which have not started can be cancelled.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:95

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: For details of and <when> syntax, see Notes on Syntax Graphs. >- REMOTE BACKTRACK dbname TO <when> --> >- REMOTE REVERT dbname TO <when> --> >- REMOTE MERGE CHANGES +--- dbname ----------------. +--- GLOBAL ----------------| .---------. +--- SYSTEM -+- FOR --| / | `--------------+--+--+ `---> where is:--+--BEFORE <when>---. +--AFTER <when>----| +--AT -------| `------------------+---> REMOTE (continued) >- REMOTE EXPUNGE -+- USER username ----------------------. | | |--------------------------------------| | | ‘- DB --+- dbname -+-- USER username --| | | | | ‘-------------------| | | ‘- SYSTEM -+-- FOR -----| | | ‘-------------------+--> >- REMOTE CHECK --+-| |-| |-| |-| | | ‘--

DB dbname ------------------------. | MISCDB --------------------------| | COMMDB --------------------------| | SYSTEMDB dbname -+- FOR ---. | | ‘----------------| | GLOBALDB -------------------------+-->

Related Commands: CANCELCOMMAND, REMOTEMESSAGE, MERGE, REVERT, BACKTRACK, EXPUNGE, CHECK

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:96

12 Series

Administrator Command Reference Manual Command Details

Querying: Remote database session information can be queried using the Q REMOTE command:

Q REMOTE FILEDETAILS Would return: Compaction number 104 Last session 142 Header changes count 0 Claim list changes count 0 Last page 139

Q REMOTE LASTSESSION Would return: Session 142: Date: 14:52 04 Feb 2009 User: fred.bloggs Description: Default session comment Note: When used in syntax for variables, the data from the query is returned in CSV format, suitable for export to a spreadsheet (this applies to both FILEDETAILS and LASTSESSION). The success of database updates may be monitored using these queries. These allow comparison of the state of the database at different locations. Where can be one of: •

GLOBAL

•

SYSTEM

•

SYSTEM FOR LOCAL

•

SYSTEM FOR

The Global banner at a remote location can be queried using:

Q REMOTE BANNER An example output would be: AVEVA Global Mk12.0.0.1 (WINDOWS-NT 5.1) (Mar 6 2009) Information about remote users of PDMS may be queried using remote session objects. For example: !p = current project

Returns a PROJECT object

!l = !p.locations()

Returns an array of LOCATION objects

!r = !l[2].sessions()

Returns an array of SESSION objects for the specified LOCATION

Only the following SESSION object methods are valid for a session at a remote location (where !l[2] is not the current location)

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:97

12 Series

Administrator Command Reference Manual Command Details

q var !r[1]

The below example output is the Daemon itself <SESSION> 149c-PC526 ENTERED <STRING> '10:09:26 Tue, 3

Mar 2009'

HOST <STRING> 'PC526' ISCURRENT FALSE ISREMOTE TRUE LOCATIONNAME <STRING> '/LONDON' LOGIN <STRING> 'SYSTEM' NAME <STRING> 'globaldaemon - Global Daemon' UNIQUEID <STRING> '149c-PC526'

q var !r[1].module()

example of user() query (from the above session): <STRING> 'GLOBALDAEMON';

q var !r[1].user()

e.g. (from the above session): SYSTEM ACCESS <STRING> 'Free' DESCRIPTION <STRING> '' NAME <STRING> 'SYSTEM' REFNO <STRING> '=24575/668'

q var !r[1].mdb().

e.g. (from the above session) <MDB> Unset - Unset DESCRIPTION <STRING> Unset NAME <STRING> Unset REFNO <STRING> Unset

We can thus query which MDBs which users are using in which modules at location 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 Software Customisation Reference Manual. Only these three session methods are available for remote sessions.

7.3.74

REMOTEMESSAGE (Global Project Administration) Function: Sends messages to users at other Locations.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:98

12 Series

Administrator Command Reference Manual Command Details

Examples:

REMOTEMessage ALL text Send message to all users at named location

REMOTEMessage TEAM teamid text Send message to all members of a team at named location

REMOTEMessage FREEUSER text Send message to administrator at a named location Command Syntax: >--- REMOTEMessage ---+--- ALL -------------. | | |--- FREEuser --------| | | ‘--- TEam teamid -----+--- text --->

Related Commands: MESSAGE, LIST MESSAGE Querying: >--- Query DBALL ---> at a LOC queries the databases allocated to a location; >--- Query DBPRIM ---> at a LOC queries the databases primary at a location; >--- Query DBLC ---> at a DB element queries the locations to which the database is allocated; >--- Query PRMLOC ---> at a DB or LOC element queries its Primary location

7.3.75

REMOVE (Project definition) Function: Removes the specified DB from the MDB. Examples:

REMOVE SERV/AREA-D Command Syntax: .------------. / | >-- REMove dbname ---*--- dbname ---’ | ‘-------------------->

Related Commands: ADD, REMOVE, CURRENT, DEFER

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:99

12 Series

Administrator Command Reference Manual Command Details

7.3.76

RENEW (Global Project Administration) 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 recreate 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 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 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 AT 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 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:

RENEW DELETE Renews the transaction DB at the current location

RENEW TRANSACTION/LON AT LON Renews the transaction DB for London at location London Command Syntax: >--- RENEW ---+-- DELETE ----- dbname -----. | | ‘-- dbname --- AT -----+--->

Related Commands: RECONFIGURE, RECOVER

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:100

12 Series

Administrator Command Reference Manual Command Details

7.3.77

REORDER (Global Project Administration) Function: Reorders the members list of an element. In a Global Project, this command is particularly useful for Databases, as the list order at a location determines the order in which Databases are propagated. For example, a Catalogue database should be propagated before any Design Databases which reference it. Examples:

REORDER 2 BEFORE 1 Command Syntax: >-- REORDer element_id --+--- BEFore ---. | | ‘--- AFTer ----+-- list_position -->

7.3.78

REPAIR (Global Project Administration) 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 deallocated 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.

•

REPAIR - outputs a report and Repairs the database.

•

REPAIR NOCHECK - Repairs the database without a report.

•

REPAIR CHECKONLY - Outputs a report without Repairing the database.

The latter is useful when using ADMIN in READONLY mode, as at a satellite with a secondary system database. Examples:

Q REPAIRREQUIRED REPAIR REPAIR CHECKONLY REPAIR NOCHECK

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:101

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >-- REPAIR ---+-----------------. | | +--- NOcheck -----+ | | ‘----CHECKonly----+----->

Related Commands: DEALLOCATE

7.3.79

REPLICATE (Project definition) 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 variables 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:102

12 Series

Administrator Command Reference Manual Command Details

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. The ADUUID attribute is essential to distinguish between Global projects. Each project should have a unique value of ADUUID. This value is what the Global daemon uses to select the correct project. For example if the user copies a project using the file system, rather than by using the REPLICATE command, then the ADUUID attribute in both projects will be the same, and this may cause commands from one Global project to be received by the wrong Global project. It is therefore essential that the PDMS Administrator resets the ADUUID attribute of the project. The NEWUID attribute provides a way to get a new value, since it makes a 'uuidgen' query. The Administrator can then use the result of the NEWUID attribute query to set the ADUUID attribute. Note that NEWUID is not an attribute of the database. It is a pseudo-attribute provided for the purpose of generating a new uid value for ADUUID. /*GL !N=NEWUID ADUUID=$!N

REPLICATE SYSTEM filename Generate macro to replicate the project structure. If the current project is Global, the macro will include Location and Communication details.

REPLICATE SYSTEM /filename FILENUMBERS Generate macro in a file /filename to replicate the complete data in the current project, maintaining the same file numbers.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:103

12 Series

Administrator Command Reference Manual Command Details

REPLICATE SYSTEM /filename OVERWRITE Generate macro to replicate the complete data in the current project. The data will be saved in the named file. If the file exists, it will be overwritten.

REPLICATE SYSTEM STANDalone filename Generate macro to replicate the project setup for a stand-alone (non-Global) project. This omits all references to Locations and Communication elements.

REPLICATE SYSTEM SATELLite filename Generate macro to replicate the project setup for a satellite of a Global project. Outputs the commands for building the System database only, not the Global database, that is, Teams, DBs and Locations are omitted. Command Syntax for a Standard (non-global) project: >-- REPLICATE -+- code ----------------------------. | | ‘- SYSTEM filename -+- FILENumbers -| | | ‘---------------+- OVERwrite -. | | ‘-------------+-->

Command Syntax for a Global project: >- REPLICATE -+-code-----------------------------------------. | | ‘-SYSTEM-+-STANDalone-. | | | | |-SATELLite--+------------------------ | | | | ‘------------+-filename-+-FILENumbers-| | | ‘-------------+-OVERwrite--. | | ‘------------+-->

The FILENumbers option maintains the same file numbers. The OVERWRITE option overwrites an existing file of the same name.

7.3.80

RESETXREFS (Reconfiguration) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:104

12 Series

Administrator Command Reference Manual Command Details

Examples:

RESETXREFS WITH /REFFILE RESOLVE DB MASTER/DESNEW where /REFFILE is the name of the file generated by the XREF command and MASTER/DESNEW is the corresponding DB to be updated. Command Syntax: >-- RESETxrefs --+-- WIth --. | | ‘----------+-- name --*-- RESOLve --+-- DB --. | | | | ‘--------+-- dbname --. | | ‘-- END ----------------------------+-->

Related Commands: XREF, LOAD, RCFUPDATE DB

7.3.81

REVERT (Project Administration) 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:

REVERT PIPE/PIPE to 10:30 Reverts database to the session current at 10:30.

REVERT PIPE/PIPE to 31 MAY Reverts database to the session current on 31st May.

REVERT PIPE/PIPE to SESS 10 Reverts database to the session 10.

REVERT PIPE/PIPE to STAMP /stamp_012 Reverts database PIPE/PIPE to the session that has the stamp /stamp_012.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:105

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >-- REVERT dbname to <when> ---> Related Commands: BACKTRACK, MERGE CHANGES, REMOTE REVERT (Global project only)

7.3.82

SAVEWORK (General PDMS Command) 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: >--- SAVEWORK ---> Related Commands: GETWORK, FINISH

7.3.83

SET (Project definition and Global Project Administration) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:106

12 Series

Administrator Command Reference Manual Command Details

•

Once a team has been set, DBs owned by that team can be referred to by using the database part of the name only.

•

ADD, DEFER, REMOVE, CURRENT and EXCHANGE require an MDB to be set.

•

Databases can only be added to a DB set once the DB Set has been specified.

Examples:

SET MDB /RAB Sets current MDB as RAB.

SET DBSET /ASET Sets current DB Set as ASET.

SET TEAM PIPING Sets current team as PIPING. Abbreviated references to the DBs /AREA-A, /AREAB etc. will automatically be taken as references to the actual DBs PIPING/AREA-A, PIPING/AREA-B etc. Command Syntax: >--- SET ----+--- MDB name ------. | | |--- DBSET name ----| | | ‘--- TEAm name -----+---> Querying: >--- Query SET --+--- MDB ----. | | |--- DBSET --| | | ‘--- TEAM ---+---> Related Commands: CREATE, ADD, DADD

7.3.84

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:107

12 Series

Administrator Command Reference Manual Command Details

Examples: Command Syntax:

SORTALLOCATE loc

Querying:

Q DBALL to query an allocation list.

Related Commands: ALLOCATE, DEALLOCATE, Q DBALL

7.3.85

STATISTICS (Data Integrity Checking) Function: Produces a summary of information about the database being checked. Note: This command should only be used when running DICE in stand-alone mode (or REMOTE CHECK). For DICE checking within a PDMS project, use the CHECKOPTION command. Description: STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc. STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default setting. Examples: An example of the output from DICE when statistics are requested is as follows: OVERALL STATISTICS ================== Total no. of entries in Name Table = 111 Total no. of elements checked = 782 Total no. of ref attributes found = 726 Total no. of external references = 0 Command Syntax: >--- STATistics ---+--- OFF ----. | | ‘--- ON -----+--->

STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default.

7.3.86

STATUSSESSION (Querying) Function: Gives information about your current status and the database to which you have access.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:108

12 Series

Administrator Command Reference Manual Command Details

Examples: An example of output is shown below.

Project: User: HVAC (75dws52) Teams: HVAC MDB: /HVAC Command Syntax: >--- STATUSSession --> Related Commands: SYSTAT

7.3.87

STOP (Data Integrity Checking) Function: Exits from DICE when it is running in stand-alone mode. Examples:

STOP Related Commands: FINISH has the same effect Command Syntax: >--- STOP --->

7.3.88

SYNCHRONISE (Global Project Administration) Function: Updates databases with the changes from another location. Description: This command updates one, all or a set of databases at an on-line Location with the changes in the corresponding databases at another location. The set of databases may be specified by DBSET or MDB elements as well as by an explicit list. 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:109

12 Series

Administrator Command Reference Manual Command Details

Note that if the more up-to-date database has been compacted, that is, sessions have been merged, or if it has been backtracked, the entire database will be transferred. Updates for offline Locations can only come from the Hub. Examples of synchronisation of constructor databases:

SYNCHRONISE STEELN/STEELN Synchronise given database at current location with its Primary location.

SYNCHRONISE ALL Synchronise all databases at current location with their Primary locations.

SYNCHRONISE STEELN/STEELN AT LON Synchronise given database at location LON with its Primary location.

SYNCHRONISE ALL AT LON Synchronise all databases at location LON with their Primary locations.

SYNCHRONISE STEELN/STEELN WITH LON Synchronise given database at current location with location LON.

SYNCHRONISE STEELN/DRAWINGS DRAWINGS/ONLY (FORCE/PICFD) Synchronise drawing-files for a Drawings database (PADD or SCHE). This command allows the drawing-files to be transferred without a database update. This can be useful if a database update has been succeeded without updating its drawings. If the FORCE/PICFD option is specified, then the PICFD attribute of the database is ignored and all drawings will be synchronised. This command can only be used on individual databases, and not with the DBLIST option.

SYNCHRONISE ALL WITH LON Synchronise all databases at current location with location LON.

SYNCHRONISE STEELN/STEELN AT LON WITH CAM Synchronise single database at location LON with location CAM. Examples of synchronisation of system databases:

SYNCHRONISE SYSTEM WITH CAM Synchronise the System Database for the current Location with location CAM

SYNCHRONISE SYSTEM AT LON WITH CAM Synchronise the System Database for the current location at location LON with location CAM

SYNCHRONISE SYSTEM FOR OXF AT LON WITH CAM Synchronise the System Database for OXF at location LON with location CAM

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:110

12 Series

Administrator Command Reference Manual Command Details

Examples of synchronisation of the global database:

SYNCHRONISE GLOBAL WITH CAM Synchronise the Global Database at the current Location with location CAM

SYNCHRONISE GLOBAL AT LON WITH CAM Synchronise the Global Database at location LON with location CAM

SYNCHRONISE GLOBAL AT OXF Synchronise the Global Database at OXF with the current location. Examples of synchronisation of the global database using DBLIST:

SYNCHRONISE DBLIST <synchronise-options> To SYNCHRONISE a set of databases use a lists of DBs, MDBs, or DBSETs. These are passed to the daemon as a list of DB element names: •

Where may contain one or more of the following –

•

DB

•

GLOBAL/DB

•

SYSTEM/DB FOR

•

<element-id>

Valid elements include MDB, DBSET, DB or LOC elements;

SYNCHRONISE DBLIST MDB/ATEST AT OXF; Synchronise all the databases in MDB/ATEST that are allocated but not primary at OXF

SYNCHRONISE DBLIST DBSET /FRED WITH CAM; Synchronise all the databases in DBSET/ FRED that are allocated but not primary at CAM

SYNCHRONISE DBLIST GLOBAL SYSTEM FOR LON AT CAM; Synchronise the Global database and the LON System database at CAM

SYNCHRONISE DBLIST STEELN/STEEL PIPEN/PIPE AT OXF Synchronise the STEELN/STEEL and PIPEN/PIPE databases at OXF. The Primary location must not be OXF Examples of synchronisation of the global database using linked document

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:111

12 Series

Administrator Command Reference Manual Command Details

propagation: For a DESIgn database:

SYNCHRONISE DBNAME LINKDOCUMENTS {FORCE|NOFORCE} (AT ) For DRAFT or SCHE databases

SYNCHRONISE DBNAME DRAWINGS/ONLY {FORCE|NOFORCE} (AT ) (WITH ) For example:

SYNCHR CTBATEST/DESI LINKDOC AT CAM SYNCHR CTBATEST/PADD DRAWINGS FORCE The keyword FORCE has a slightly different meaning for the two cases: For drawing databases, force will copy non-propagating drawings such as picture files even if their propagation has been disabled. For Linked Documents, the files will be transferred to the secondary location even if they already exist, thus updating them. Command Syntax: >- SYNCHronise -+- dbname --------------------. | | | .------<-------. | | / | | |-- DBLIST ---+- -| | | |--- SYSTEM -+- FOR -+-- LOCAL -| | | | | | | ‘-- -| | | | | ‘------------------| | | |--- GLOBAL --------------------| | | ‘- ALL -------------------------+- AT --. | | ‘-------------+- WITH -. | | ‘--------------+--->

The can be as follows:>-SYNCHRONISE-+-dbname-+-LINKDOC/UMENTS---. | | +- DRAWINGS/ONLY --+-+-FORCE-. ‘------------------|---------| ‘---------+-AT -. | | ‘----------+-WITH -. | | ‘-------------+-->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:112

12 Series

Administrator Command Reference Manual Command Details

The can be as follows:--+--GLOBALdb --------------------. | | |--SYSTEM-- --|-- FOR -----| | `-----------------| |-- DB -----------------| | | `-- <element-id>----------------+--->

The <element-id> may be an MDB, DBSET, DB or LOC. Related Commands: UPDATE, RECOVER

7.3.89

SYSTAT (Querying) 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-computer1) Name au (A.User) Host computer1 Entered 14:37 10 Sep Module DESIGN MDB /HVAC DB HVAC/DESI HVAC/PADD HVAC/CATA MASTER/IPECATA ASTER/STLCATA MASTER/HVACCATA MASTER/SUPPCATA MASTER/PADD MASTER/DICT MASTER/PROP

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

MODE RW R R R R R R R R R

7:113

12 Series

Administrator Command Reference Manual Command Details

User HANGER (3c41-computer2) Name an (A.N. Other) Host computer2 Entered 14:39 10 Sep Module DRAFT MDB /HANGERS DB HANGERS/DESI HANGERS/PADD HANGERS/CATA ASTER/PIPECATA MASTER/STLCATA MASTER/HVACCATA MASTER/SUPPCATA MASTER/PADD MASTER/DICT MASTER/PROP

MODE R RW R R R R R R R R

2 user(s) listed This shows that two users are using Project SAM: •

User HANGER who is using DRAFT, and has Read/Write access to the Draft database HANGERS/PADD.

•

User HVAC who is using DESIGN, and has Read/Write access to the Design database HVAC/DESI.

In a Global project, there may also be a SYSTEM user running the Globaldaemon module. This shows that the daemon is running. You can restrict the output to information about the user, host, module or MDB as shown in the following examples:

SYS USER HVAC Lists the information for the user HVAC

SYS NAME an Lists the information for the user id an

SYS HOST ’computer1’ Lists the information for the host computer

SYS MODULE DRAFT Lists the information for any users of DRAFT

SYS MDB HVAC Lists the information for any users of the MDB HVAC

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:114

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >--- SYStat ---+----------------------. | | |--- USER username ----| | | |--- NAME ’loginid’ ---| | | |--- HOST ’hostid’ ----| | | |--- MODUle module ----| | | ‘--- MDB name ---------+--->

Related Commands: STATUSSession, EXPUNGE

7.3.90

SYSTEMLOCATION (Global Project Administration - Hub Only) 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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:115

12 Series

Administrator Command Reference Manual Command Details

Examples:

SYSTEMLOCation LON PRIMARY AT OXF Changes the Primary Location of the Location LON to be the Location OXF, so that LON can be administered from OXF.

SYSTEMLOCation OXF LOCAL Changes the Primary Location of the Location LON to be at LON, so that LON can be administered locally.

SYSTEMLOCation OXF HUB Changes the Primary Location of the Location OXF to be the Hub. Command Syntax: >-- SYSTEMLOCation --+-- PRIMARY AT --. | | |-- LOCAL -------------| | | ‘-- HUB ---------------+-->

Related Commands: ADMINISTER, PREVOWNER SYSTEM Querying:

>--- Q PRMLOC ---> At a Location, shows the Primary Location for the Location. >--- Q PRVRF ---> At a Location, shows the previous primary location until the SYSTEMLOC command has completed. This attribute is normally unset.

7.3.91

TADD (Project definition) Function: Adds users to the Set (i.e. Current) team.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:116

12 Series

Administrator Command Reference Manual Command Details

Examples:

TADD SJC Add user SJC to the current Team. Command Syntax: .------<-----. / | >--- TADD userid ---*--- userid ---’ | ‘----------------->

Related Commands: TREMOVE, SET

7.3.92

TERM (General PDMS Command) Function: Terminates Alpha file. Examples:

TERM Terminates alpha file and outputs reports to screen. This syntax is equivalent to ALPHA FILE END Command Syntax:

>--- TERM -----> Related Commands: ALPHA

7.3.93

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.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:117

12 Series

Administrator Command Reference Manual Command Details

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: >- To -+| || || || || ‘-

DBFile filename ---------------------------------------------------. | DB dbname ---------------------------------------------------------| | FIles ----------. | | | BINaryfiles ----| | | | FORMattedfiles -+- name name --------------------------------------| | NEW dbname -----+- IN AREA n -. | | | | ‘-------------+- ACCess -+- UPDAte -----. | | | | | | |- CONTROL ----| | | | | | | ‘- MULTIWRITE -| | | | | ‘-------------------------+- DBNO n -| | | ‘----------+->

Related Commands: FROM, RCFCOPY

7.3.94

TRANSFER (Global Project Administration) 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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:118

12 Series

Administrator Command Reference Manual Command Details

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. Note: There is an additional option TRANSFER - FORCEPROPG which transfers all allocated DBs regardless of the Propagation flag. Refer to Running Global Projects guide for a detailed explanation of this option. Related Commands: GENERATE LOCATION Command Syntax: >--- TRANSFer ---+--- TO pathname ---. | | ‘--- FROM pathname -------+--->

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:119

12 Series

Administrator Command Reference Manual Command Details

7.3.95

TREMOVE (Project definition) 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

7.3.96

TTFONT (TrueType font definition) 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 Administrator User Guide. Examples:

TTFONT 6 DESCRIPTION ‘My Times’ Changes the description of font no. 6, which is Times New Roman.

TTFONT 6 FACE ‘COURIER NEW’ DESCRIPTION ‘Courier’ Replace font 6 with Courier New, providing the appropriate description. Font 6 is no longer Times New Roman.

TTFONT 6 RENUMBER 19 The font ID of font 6 is changed to 19. Font ID 6 becomes free to be re-used.

TTFONT 6 RENUMBER 19 FACE ‘Courier New’ DESCR ‘Courier’ Font no. 6 becomes free, but font no. 19 becomes ‘Courier New’ with an appropriate description.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:120

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: .-----------<----------. / | >--- TTDONT integer ---*-- DESCRiption text ----| | | |-- FACE text -----------| | | ‘-- RENUMBER integer ----+-->

Querying: Q FONTS Displays information about all fonts configured in the system. Q FONTS AVEVA Displays information about the AVEVA fonts only. Q FONTS TRUETYPE Displays information about TrueType fonts only. Related Commands:

7.3.97

UNLOCK (Project Administration) Function: Unlocks all locked databases. Note: Locking and Unlocking commands are not recorded in the transaction database. Examples:

UNLOCK Unlocks all locked databases In a Global Project, the System Administrator at the Hub or at a Satellite’s administering location can unlock a Project at the Satellite:

UNLOCK AT LON Unlocks all locked databases at Location LON.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:121

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >--- UNLOck ---+---------------. | | ‘--- AT --+-->

Related Commands: LOCK Querying a Standard (non-global) Project: >--- Query LOCK -----> Querying a Global Project: >--- Query LOCK ---+--------------. | | ‘--- AT -+-->

7.3.98

UPDATE (Global Project Administration) 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, backing-sheets 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 can also be made with locations which are not immediate neighbours. In this case, the update obeys 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 is called ‘Update Routed’ in the transaction database.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:122

12 Series

Administrator Command Reference Manual Command Details

Examples of updating constructor databases:

UPDATE ALL WITH LON All databases at the current location and all databases at Location LON will be compared, and updated so that all have the most recent data. If LON is not an immediate neighbour, then updates will also be run at intermediate locations. For example if CAM is between the current location ABC and LON, 3 updates will be run - between ABC and CAM, between CAM and LON, and finally again between CAM and ABC.

UPDATE PIPES/PIPES WITH CAM The PIPES/PIPES database at the current location will be compared with the PIPES/PIPES database at Location CAM. Updates will be transferred from the most up-to-date database to the other.

UPDATE DIRECT CTBATEST/DESI WITH CAM The ‘Update Direct’ command is deprecated and should be used with caution. This updates directly with the specified location ignoring the network routing. This may cause ‘Reverse propagation’ warnings, since intermediate locations will not be updated. This functionality is provided for upwards compatibility with older versions of Global. Both Locations (and any intermediate locations) must be on-line. •

Scheduled updates run updates concurrently for several databases. The update is scheduled as follows:

•

First the Global database will be updated;

•

Then 5concurrent DBLIST updates will be scheduled. The databases are distributed across these 5 update commands.

•

Where possible, extracts will be included in the same update as their parent database;

•

The system databases are updated in a separate DBLIST update.

•

Scheduled updates will not start if the previous update for the same Update event (LCOMD) is still running. If duplicate scheduled updates are required, then additional Update events are required. However since the standard update runs 5 updates concurrently, this should not be necessary. The results of Inter-db macro transfer and failures from Other-data transfer are recorded in the Transaction database.

UPDATE DBLIST Where may contain one or more of the following – •

DB

•

GLOBAL/DB

•

SYSTEM/DB FOR

•

<element-id>

•

Valid elements include MDB, DBSET, DB or LOC elements.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:123

12 Series

Administrator Command Reference Manual Command Details

Examples of updating system databases:

UPDATE SYSTEM WITH CAM The System database for the current location, at the current location, will be compared with the System database for the current Location at Location CAM. Updates will be transferred from the most up-to-date database to the other.

UPDATE SYSTEM FOR OXF WITH CAM The System database for location OXF at the current Location will be compared with the System database for location OXF at Location CAM. Updates will be transferred from the most up-to-date database to the other. Examples of updating the global database:

UPDATE GLOBAL WITH CAM The Global database at the current location will be compared with the Global database at Location CAM. Updates will be transferred from the most up-to-date database to the other. Command Syntax: >- UPDATE ------+- DIRECT --------------------. |-----------------------------| |-- dbname -------------------| | | | .------<------. | | / | | |-- DBLIST ---+--| | | |-- SYSTEM -+- FOR ----- | | | | | `-----------------| |-- GLOBAL -------------------| | | `-- ALL ----------------------+- WITH ------->

The can be as follows:--+--GLOBALdb --------------------. | | |--SYSTEM-- --|-- FOR -----| | `-----------------| |-- DB -----------------| | | `-- <element-id>----------------+--->

The <element-id> may be an MDB, DBSET, DB or LOC.

Related Commands: SYNCHRONISE

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:124

12 Series

Administrator Command Reference Manual Command Details

7.3.99

UPGRADE (Reconfiguration) Function: Produces macros to upgrade a project to a new version of PDMS. Examples:

UPGRADE /OUTMACRO /INMACRO This will produce two macro files, OUTMACRO and INMACRO. OUTMACRO will be used in the old PDMS version to dump the contents of all DBs in the project to intermediate files. INMACRO will be used in the new PDMS version to load the intermediate files and recreate the complete project.

UPGRADE /OUTMACRO /INMACRO FOREIGN db1 db2 ... All databases, including the list of foreign databases specified by the FOREIGN option will be upgraded.

UPGRADE /OUTMACRO /INMACRO FOREIGN ALL All databases, including all foreign databases will upgraded. Command Syntax: .---<------. / | >--- UPGrade macro1 macro2 ---+-- FOReign --*-- dbname --’ | | ‘-------------+--- ALL -----. | | ‘-------------+--->

7.3.100 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:

USERADD TO ‘fred_bloggs1’ USERA, USERB, USERC... Adds PDMS users A, B and C to Window NT user ‘fred_bloggs1’

USERADD TO ‘fred_bloggs1’ DEFAULT USERC Sets user C as the default PDMS user for Windows NT authenticated user ‘fred_bloggs1’.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:125

12 Series

Administrator Command Reference Manual Command Details

Command Syntax: >- USERADD -- TO --- authuser --+-- DEFAULT --username--> | | | .------------. | / | ‘- username --+-- username --. | ‘--->

Related Commands: LIST AUTHUSER, USERREM/OVE FROM, AUTHUSERREMOVE, CREATE AUTHUSER, AUTHENTICATION

7.3.101 USERREM/OVE FROM Function: Removes the specified PDMS users from the Windows NT authenticated user. Example:

USERREM/OVE FROM ‘fred_bloggs1’ USERA, USERB, USERC... Removes PDMS users A, B and C from Window NT user ‘fred_bloggs1’ Command Syntax: .------------. / | >- USERREM/OVE -- FROM --- authuser --+-- username --. | ‘--->

Related Commands: LIST AUTHUSER, USERREM/OVE FROM, AUTHUSERREMOVE, CREATE AUTHUSER, AUTHENTICATION

7.3.102 VB (Reconfiguration) Function: Gives very brief output for pass 2 reconfiguration.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:126

12 Series

Administrator Command Reference Manual Command Details

Examples: A short example of very brief output is shown below. Compare with the brief output shown in the BRIEF command. *** Pass one initiated *** *** Pass one completed *** *** Pass two initiated *** EC

LIBY

#92/842

=16/2404

(24,90) Warning! library number 242 already exists in the project. Duplicate libraries should not be used in the same MDB EC DEPT #16/805 =16/2408 Phase one complete - starting phase two *** Pass two completed *** ***Reconfiguration Completed 0 Elements were not defined in DDL 0 Elements have been lost 0 Elements are no longer named 3 Attributes were incorrectly defined 0 Elements were not inserted.

Command Syntax:

>--- VB ---> Related Commands: BRIEF, FULL, ERRORS

7.3.103 XREF (Reconfiguration) 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:

>--- XRef filename ---> Related Commands: RESETXREFS, DUMP, UPDATE DB

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:127

12 Series

Administrator Command Reference Manual Command Details

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

7:128

12 Series

Administrator Command Reference Manual Dabacon Buffer Size

8

Dabacon Buffer Size The Dabacon buffer may be between 20 Mbytes and 1 Gbyte. The default for modules in a new project is as follows:

8.1

20 MBytes

Monitor

200 Mbytes

Admin, Specon, Propcon, Isodraft, Lexicon, Dars, Toolbox

500 Mbytes

Design, Draft, Paragon, Spooler, HullDesign, HullDrafting, Outfitting, OutfittingDraft, Diagrams, Schematic Modeller, Tags

Specifying the Dabacon Buffer Size The Dabacon buffer may be set in one of two ways:

8.1.1

•

Per module per project

•

For a specific window for all users

Per Module Per Project The 'Ed Mod' command can be used to change the Dabacon Buffer size per module per project. The value may be specified in Mbytes or integers. 256000 integers is the same as 1 MByte. For example: ED MOD DESIGN 12800000 Is the same as ED MOD DESIGN 50 MBytes

8.1.2

Per User The Dabacon value may be fixed for a particular user by setting the environment variable 'PDMSBUF'. The value of this is always in megabytes This environment variable should be set before running PDMS. This will set the buffer size for use by all PDMS modules. If a value greater than 1000 is given then the value will be rejected.

8.2

Querying the Amount of Unused Dabacon Buffer This may be queried using the command 'Q Dabacon avail'.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

8:1

12 Series

Administrator Command Reference Manual Dabacon Buffer Size

8.3

Affect of Setting the Dabacon Buffer Increasing the Dabacon buffer size is likely to reduce the amount of network I/O. Thus in generally a larger Dabacon buffer will increase performance. However if the Dabacon buffer is greater than the memory, then it is likely that the machine will do more paging, thus offsetting some of the advantages of less network traffic.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

8:2

12 Series

Administrator Command Reference Manual Drawing File Name and Folders

A

Drawing File Name and Folders 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. File Type

Prefix

Picture file

M

Marine Hull Drawing

D

Diagram

V

Stencil

V

Template

V

Neutral Format (SVG)

V

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

A:1

12 Series

Administrator Command Reference Manual Drawing File Name and Folders

Ref No The Ref No is dependant on the file type, the following options are available: File type

Element Type

Database

Picture file

SHEE,OVER

PADD

Marine Hull Drawing

SHEE,OVER

PADD

Diagram (Visio)

SCDIAG

SCHE

Stencil (Visio)

SCSTEN

SCHE

Template (Visio)

SCTEMP

SCHE

Neutral Format (SVG)

SCDIAG

SCHE

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 Neutral format (SVG) files. Non-Visio diagrams only have one page. File Suffix The file name suffix is dependant on the file type, the following options are available. Note: Visio files may be stored in either Binary or XML format; The types and numbers of files are defined by attributes.

File type

Suffix

Picture file

-

Marine Hull Drawing

sdb

Diagram (Visio)

Vdx or vsd

Stencil (Visio)

Vsx or vss

Template (Visio)

Vtx or vst

SVG

Svg

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

A:2

12 Series

Administrator Command Reference Manual Drawing File Name and Folders

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

Suffix

Picture file

{project}PIC

Marine Hull Drawing

{project}DRG

Diagram

{project}DIA

Stencil

{project}STE

Template

{project}TPL

SVG

{project}DIA

The following attributes may be useful at the above elements Q DRFTYP

List of drawing file types for elements

Q DRFILE

Default drawing file name for element (for SVG files, for highest number file)

Q DRFILE (number)

Drawing file of specification type of element

There are also attributes specific to each element type PICF, DOFIL

for SHEE (PICF, also applies to OVER)

VISF, NVIEWF

for SCDIAG (VISF also applies to SCSTEN, SCTEMP)

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: <project>PIC

containing AVEVA PDMS Draft picture files

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

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

A:3

12 Series

Administrator Command Reference Manual Drawing File Name and Folders

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

As compared to the folder structure valid for previous versions, the new layout looks as follows:

Figure A:1.

Layout of the <project>PIC Folders

Figure A:2.

Layout of the <project>DWG Folder

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

A:4

12 Series

Administrator Command Reference Manual

Index

A

D

Attributes non-reference handling of during reconfiguration 3:1, 3:3 reference handling of during reconfiguration 3:1, 3:3

Data Integrity Checker (DICE) . . . . . . . . 2:1 DAtaBAse CONtrol program (DABACON) 3:1 Database Description Languages (DDLs) 3:1 Database Structure Elements and their Attributes . . . 4:1, 5:1 Global Database . . . . . . . . . . . . . . . 4:6 Transaction Database . . . . . . . . . . . 5:1 Destination database for reconfigure operations . . . . . 3:1, 3:2 DICE Exiting . . . . . . . . . . . . . . . . . . . . . . . 2:1 Reports . . . . . . . . . . . . . . . . . . . . . . 2:2 Setup Options . . . . . . . . . . . . . . . . . 2:1 Starting up . . . . . . . . . . . . . . . . . . . . 2:1 User Message File . . . . . . . . . . . . . . 2:1 DUMP command . . . . . . . . . . . . . . . . . 3:11

B Binary-format files . . . . . . . . . . . . . . . . . 3:20 BRIEF command . . . . . . . . . . . . . . . . . . . 3:7 Brief output mode . . . . . . . . . . . . . . . . . . 3:7

C Character-format files . . . . . . . . . . . . . . 3:20 Commands Detailed Descriptions . . . . . . . . . . . . 7:3 Reconfiguration . . . . . . . . . . . . . . . . 3:2 Summary in Functional Groups . . . . 6:1 Syntax Graphs . . . . . . . . . . . . . 7:1, 7:3 Communications elements LCOMC (Admin Daemon Config) . . . 4:3 LCOMD (Comms Link Details) . . . . . 4:4 LCOML (LCOMD Elements List) . . . 4:3 LCTIMD (Event Timings) . . . . . . . . . 4:6 LCTIML (Event Timer) . . . . . . . . . . . 4:5 LEVENL (Time Interval) . . . . . . . . . . 4:5 Copies of databases . . . . . . . . . . . . . . . . 3:8 Copy list (for reconfiguration) . 3:2, 3:4, 3:11

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

E Elements DB (Database) . . . . . . . . . . . . . . . . . 4:8 DBALL (Location DB List) . . . . . . . 4:14 DBLI (Database List) . . . . . . . . . . . . 4:8 DBLOC (DB Location) . . . . . . . . . . . 4:9 GRP (Group) . . . . . . . . . . . . . . . . . 4:12 GRPLI (Group List) . . . . . . . . . . . . 4:11 LNK (Links) . . . . . . . . . . . . . . . . . . 4:14 LNKLI (Link List) . . . . . . . . . . . . . . 4:14 LOC (Location) . . . . . . . . . . . . . . . 4:12 LOCLI (Location List) . . . . . . . . . . . 4:12 PEROP (Perops) . . . . . . . . . . . . . . 4:10 ROLE (Role) . . . . . . . . . . . . . . . . . 4:10 TEAM (Team) . . . . . . . . . . . . . . . . . 4:8

Index page 1

12 Series

Administrator Command Reference Manual

Errors reconfiguration controlling limit of for output . . . . 3:8 ERRORS command . . . . . . . . . . . . . . . . 3:8

F FROM command . . . . . . . . . . 3:3, 3:13, 3:20 FULL command . . . . . . . . . . . . . . . . . . . 3:7 Full output mode . . . . . . . . . . . . . . . . . . . 3:7

G Global . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20 Global Commands . . . . . . . . . . . . . . . . . 1:1 Groups reconfiguring . . . . . . . . . . . . . . . . . . 3:13

I INCLUDE command . . . . . . . . . . . . . . . 3:11 Index of reference numbers . . . . . . . . . . . 3:10 Intermediate files . . . . . . . . . . . . . . . 3:1, 3:3 Isodraft files . . . . . . . . . . . . . . . . . 4:5, 7:122

R RCFCOPY command . . . . . . . . . . . . . . . 3:4 RCFUPDATE command . . . . . . . 3:10, 3:11 Reconfiguration . . . . . . . . . . . . . . . . . . . 3:5 Extracts . . . . . . . . . . . . . . . . . . . . . 3:21 Projects . . . . . . . . . . . . . . . . . . . . . 3:20 same references . . . . . . . . . . . . . . . 3:5 Transaction Database . . . . . . . . . . 3:24 RECONFIGURE command . . . . . . . . . . 3:4 RECONFIGURER . . . . . . . . . . . . . . . . . 3:1 Reference attributes . . . . . . . . . . . . 3:9, 3:10 Reference number index . . . . . . . . . . . 3:10 listing . . . . . . . . . . . . . . . . . . . . . 3:5, 3:7 loading from file . . . . . . . . . . . . . . . 3:11 saving to file . . . . . . . . . . . . . . . . . . 3:11 References between databases . . . . . . . . . . . . . 3:9 Relevant User Guides . . . . . . . . . . . . . . 1:1 REPLICATE command . . . . . . . . . . . . . 1:1 RESETXREFS command . . . . . . . . . . 3:14 Root element . . . . . . . . . . . . . . . . . . . . 3:11

S SAMEREF option . . . . . . . . . . . . . . . . . . 3:5 Source database for reconfigure operation . . . . . . 3:1, 3:2

L LOAD command . . . . . . . . . . . . . . . . . . 3:11

T M Manual Content . . . . . . . . . . . . . . . . . . . . 1:1 Messages . . . . . . . . . . . . . . . . . . . . . . . 3:17

O Offline location 4:5, 4:12, 6:3, 7:8, 7:16, 7:17, 7:28, 7:38, 7:49, 7:55, 7:56, 7:58, 7:76, 7:80, 7:110, 7:115, 7:119 Output controlling . . . . . . . . . . . . . . . . . . . . . 3:7

P PADD databases treatment of when reconfiguring . . . 3:12 Picture files treatment of when reconfiguring . . . 3:12 Plot files . . . . . . . . . . . . . . . . . . . 4:5, 7:122 Programmable Macro Language (PML) . 1:1 Projects transferring data between . . . . . . . . 3:13 upgrading . . . . . . . . . . . . . . . . . . . . 3:14

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

TO command . . . . . . . . . . . . 3:4, 3:13, 3:20 Transaction elements TRDAY (Command Date Day) . . . . . 5:3 TRFAIL (Transaction Failure) . . . . 5:11 TRFLST (Transaction Failure List) 5:11 TRINCO (Transaction Incoming Command) 5:3 TRLOC (Transaction Location) . . . . 5:3 TRMESS (Transaction Message) . 5:11 TRMLST (Transaction Messages List) 5:11 TRMONT (Command Date Month) . 5:3 TROPER (Transaction Operation) . . 5:9 TROUCO (Transaction Output Command) 5:6 TRSLST (Transaction Success List) 5:11 TRSUCC (Transaction Success) . . 5:11 TRUSER (Transaction User) . . . . . . 5:3 TRYEAR (Command Date Year) . . . 5:3

U Upgrade macros . . . . . . . . . . . . . . . . . . 3:15

Index page 2

12 Series

Administrator Command Reference Manual

V VB Command . . . . . . . . . . . . . . . . . . . . . 3:7 Very Brief output mode . . . . . . . . . . . . . . 3:7

W World elements GLOCWL (Global Location) . . . . . . 4:11 GROWL (Global Role) . . . . . . . . . . 4:10 GSTAT (Global Status) . . . . . . . . . . 4:7 GSTWLD (Global Stamp) . . . . . . . . 4:14 GTMWL (Global Team) . . . . . . . . . . 4:8 LCOMW (Communications) . . . . . . . 4:3 STAT (Project Status) . . . . . . . . . . . 4:3 TRMSGW (Transaction Message) . . 5:2

X XREF command . . . . . . . . . . . . . . . . . . 3:14

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

Index page 3

12 Series