Administrator Command Reference Manual

Administrator Command Reference Manual

AVEVA Solutions Ltd

DisclaimerInformation of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law. Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or errors in this publication, or any incorrect use of the product, whatsoever.

CopyrightCopyright and all other intellectual property rights in this manual and the associated software, and every part of it (including source code, object code, any data contained in it, the manual and any other documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries. All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior written permission of AVEVA Solutions Ltd Where such permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made. The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in this publication may be incorporated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution. The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms and conditions of the respective licence agreements, and in accordance with the relevant User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited. First published September 2007 AVEVA Solutions Ltd, and its subsidiaries 2007 AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

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



Contents

Page

Administrator CommandIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1 How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Stand-Alone DICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1DICE Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 DICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Reconfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1Reconfiguration Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1 Starting up RECONFIGURER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1 Administrative and Querying Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2 Basic Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2Reconfiguring 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

2007 AVEVA Solutions Ltd

i

12.0


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

Advanced Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9References 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:17Standard 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:21Outputting 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:1Structure of the Local System Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2 Structure of the Global Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

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


ii

12.0


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:1Project 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:4 Data Integrity Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5 Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5

Command Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1Conventions Used in the Syntax Graphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1 Notes on Syntax Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2 Detailed Descriptions of Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3ACCESS (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


iii

12.0


CDESC (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHANGE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHECK (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CHECKOPTION (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CNAME (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . COPY (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) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7:14 7:15 7:18 7:20 7:23 7:24 7:26 7:32 7:33 7:34 7:35 7:36 7:38 7:39 7:40 7:41 7:43 7:43 7:44 7:44 7:45 7:47 7:48 7:50 7:51 7:51 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


iv

12.0


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:71 NEW (Project definition and Global Project Administration). . . . . . . . . . . . . . . . . . . . 7:72 NEW STAMP (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:74 PING (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:75 PREVOWNER (Global Project Administration - Hub only). . . . . . . . . . . . . . . . . . . . . . 7:76 PROJECT (Project definition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:77 PURGE (Project Administration and Global Project Administration) . . . . . . . . . . . . . 7:79 QUERY (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:80 RCFCOPY (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:85 RCFUPDATE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:87 RCFUPGRADE (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:87 RECONFIGURE (Reconfiguration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:88 RECOVER (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:89 REINIT (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:91 REMOTE (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:92 REMOTEMESSAGE (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . 7:96 REMOVE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:96 RENEW (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:97 REORDER (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:98 REPAIR (Global Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:98 REPLICATE (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:99 RESETXREFS (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:101 REVERT (Project Administration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:102 SAVEWORK (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:103 SET (Project definition and Global Project Administration) . . . . . . . . . . . . . . . . . . . 7:104 SORTALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:105 STATISTICS (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:105 STATUSSESSION (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:106 STOP (Data Integrity Checking) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:106 SYNCHRONISE (Global Project Administration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:107 SYSTAT (Querying) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:108 SYSTEMLOCATION (Global Project Administration - Hub Only) . . . . . . . . . . . . . . . 7:110 TADD (Project definition) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:111 TERM (General PDMS Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:112 TO (Reconfiguration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:112


v

12.0


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:113 7:115 7:115 7:116 7:117 7:119 7:119 7:120 7:120 7:121

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


vi

12.0

Administrator Command Reference ManualIntroduction

1

IntroductionThis manual describes the PDMS ADMIN commands for Standard (non-global) and Global projects. It is written for System Administrators who are already experienced ADMIN users and who wish to write macros or use command input, rather than the GUI. The content of this manual is based on the assumption that you are already familiar with the concepts that a PDMS System Administrator needs to understand. If you are not familiar with these concepts, you should refer to the relevant user guide, as follows: Using PDMS ADMIN for a standard (non-global) project is described in the AVEVA ADMIN User Guide, which tells you how to set up and administer PDMS projects using the GUI. The User Guide also describes the concepts that PDMS System Administrators need to understand. Using Plant Design Global via the GUI is described in the Global User Guide, which also describes the concepts in Plant Design Global that PDMS System Administrators need to understand.

Within the manual, commands that are only available in AVEVA Global are labelled as Global Project Administration Commands. Some of these commands are only available at the Hub of a Global Project, and this is also shown. Some options in standard commands are only available in Global Projects and these options are also indicated by 'Global' in associated text. This manual also describes how to use DICE, the PDMS Data Integrity Checker, outside PDMS, as there is no GUI for the stand-alone module. It also describes database reconfiguration, which is also a command line or macro operation.

1.1

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

1.2

How to Use This ManualStand-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


1:1

12.0

Administrator Command Reference ManualIntroduction

Command Reference manual as there is no interface to stand-alone DICE, and you will need to enter commands interactively or via a macro. Reconfiguration, applies to Standard and Global projects and describes database reconfiguration. System and Global Projects, applies to Standard and Global projects. It contains maps of the System Database and Global Database Hierarchies, and a list of the ADMIN elements and their attributes that can be set explicitly by the user. Transaction Database applies to Global projects only, and describes the transaction database, the elements in it, and their attributes. Command Summary applies to Standard and Global projects. It lists the ADMIN commands in functional groups. Command Details, applies to Standard and Global projects. It occupies the majority of the manual and describes every ADMIN command. The descriptions appear in alphabetical order of command names. Drawing File Name and Folders file name conventions used for Drawing and Picture files during propagation.


1:2

12.0

Administrator Command Reference ManualStand-Alone DICE

2

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

$PDMSEXE/dopFor 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 FINISHYou can send the reports generated by DICE to a named file in your working directory using the ALPHA command.

2.1

DICE ErrorsPDMS 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.DATNote: 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 CommandsSet up the options you require using the following commands (see the appropriate command pages for details): ERRORFILE MODE MAXERRORS MAXWARNINGS STATISTICS


2:1

12.0

Administrator Command Reference ManualStand-Alone DICE

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


2:2

12.0

Administrator Command Reference ManualReconfiguration

3

ReconfigurationPDMS RECONFIGURER is run from within ADMIN, but only by using the command line. In order to understand why database reconfiguration may be necessary, and to appreciate the steps involved, it is helpful to have some knowledge of PDMS database structures and their management. For a summary of this information, including an explanation of DDLs (Database Description Languages) and DABACON (the DAtaBAse CONtrol program), read the chapter The PDMS Database Management System in the ADMIN User Guide.

3.1

Reconfiguration ProcessReconfiguration 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 RECONFIGUREREnter PDMS in non-graphics (tty) mode by typing:

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


3:1

12.0


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

3.3

Administrative and Querying CommandsSome of the general PDMS and querying commands, which are particularly relevant to reconfiguration, are summarised below. SYSTAT LIST SET TEAM LOCK, UNLOCK MESSAGE Q DB Gives information about the current active status of the project within which you are working. Lists project information; there are a variety of options.. Sets the specified team as the current one. Locking the System Database prevents any new users entering the project. Sends messages to other users. Gives the type number and filename of the specified DB and a list of the MDBs of which it is a memer. For example:

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

FILENAME /

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

Q COPIES CIVIL/JBX37C DB CIVIL/JBX37C HAS COPIES: CIVILl/ JBX47CQ MDB Q TEAM Q SET TEAM Q LOCK Lists the DBs in the specified MDB. Lists the users who are members of the specified team plus a list of the DBs owned by the team. Gives the name of the currently set team if any. Shows whether the project is locked.

3.43.4.1

Basic ReconfigurationReconfiguring a Single DatabaseThe 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.


3:2

12.0


The transfer of data takes place in two passes, the second of which is further divided into two phases: PASS 1 The data is read from the source DB and written to a pair of intermediate files. The first file holds the element structures and the non-reference attributes, the other holds the reference attributes. The first file is read by RECONFIGURER and used to recreate the original structures in the destination DB, including setting of the non-reference attributes. The second intermediate file is read and its contents used to set all reference attributes in the destination DB and to perform insertion operations.

PASS 2 - Phase 1

PASS 2 - Phase 2

The reason for the two phases is that references in the source DB may refer to elements lower down in the hierarchy. It is necessary, therefore, to create all elements in the destination DB before trying to set references to any of them. Since the two passes perform independent and consecutive operations, the process can be interrupted after Pass 1 has been completed, with Pass 2 being run later. Reconfiguration has four basic steps: 1. 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 DatabaseThe 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/STEELSSource data is in database STEELS/STEELS in current project

FROM PROJECT XXX STEELS/STEELSource data is in specified DB in project XXX

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


3:3

12.0


3.4.3

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

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

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

TO DBFILE /des008Reconfigured 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 CopiedThe 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 ALLThe 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 ProcessThe 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


3:4

12.0


extent of information output is deleted, ready for another reconfiguration operation if required. You must specify the source, destination and copy list for each reconfiguration. The output by default is sent to the screen, but you can send it to a file by giving the ALPHA FILE command, followed by a filename, before reconfiguration. You can use the following options with RECONFIGURE: Use the SAMEREF option to ensure that the same reference numbers are maintained after reconfiguration. See 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.

3.4.6

Example of a Simple ReconfigurationThe 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 RECONFIGURENote: 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 OptionWhen 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


3:5

12.0


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

RECONFIGURE SAMEREFIn 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 OptionWhen 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 SESSIONSThe 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 SESSIONSAfter 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 RECONFIGThe SAMEREF option is assumed when reading the data. If errors occur, the data is not saved. If you want the data saved even if errors occur, use the FORCE option. For example:

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


3:6

12.0


3.7

Listing the Reference Number IndexWhen 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 refnowhere refno is the new reference number. The old reference number will be returned. For example:

Q NEWREF #32/202

=42/205

3.8

Global ProjectsIn 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 RECONFIGUREIn both these cases, the existing System or Global databases will be overwritten, so you do not give a TO command. The COPY ALL and SAMEREF options are also implied. In a Global project, you can only give a RECONFIGURE command for a System or Global database if you are at the primary location of the database: For a Global database, the primary location is the Hub. For a Satellite System database, the primary location may be at the Satellite itself, or it may be at another Satellite, or at the Hub. The RECONFIGURE command reconfigures the currently open System database. At a Satellite, the command can therefore operate either on the local System database, or on another Satellites System database which is primary at the local Satellite.

3.9

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

VB BRIEF FULL

Very brief output mode Brief output mode Full output mode

In VB (Very Brief) mode, a message is output as each element in the copy list is successfully created. If the copy command was RCFCOPY ALL, then a message is output for each element successfully copied into the World of the destination DB.


3:7

12.0


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 50If the specified limit is reached, reconfiguration is abandoned and the DB is left unaltered. By default, RECONFIGURER allows an unlimited number of errors to occur. This situation may be reset if necessary by using the ERRORS command followed by a negative value. For example:

ERRORS

-1

3.10

Copies and Reconfigured Copies of DBsThere 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

CopiesA 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/TESTThe key features of copies are: All copies of DBs have the same DB number. This may be seen by using the LIST FILES command. For example:MASTER/DES DESI NUMBER 14 NUMBER NUMBER NUMBER 2 2 5 FILENAME /%DRA000%/dra013 UPDATE FILENAME /%DRA000%/dra001 UPDATE FILENAME /%DRA000%/dra003 UPDATE FILENAME /%DRA000%/dra004 UPDATE

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

There is no implied direction of copying. Thus, in the previous example, PIPEA/PIPEA and ADMIN/TEST are each a copy of the other. The contents of all copies are identical with respect to both data and structure. Any given element has the same reference number in each copy. A DB may have any number of copies, but copies may not exist in the same MDB.

3.10.2

Reconfigured CopiesA 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.


3:8

12.0


In the reconfiguration process, the destination DB becomes a reconfigured copy of the source DB, but the reverse is not true. The relationship exists in one direction only. The contents of a reconfigured copy are an edited version of those of the source DB. Any given element will have a different reference number in the reconfigured copy from its reference number in the original DB (unless you use the same SAMEREF option).

3.11

Advanced ReconfigurationThe 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 DatabasesA DB often contains elements which have reference or reference array attributes which point into other DBs. For example, one Design DB could contain a Branch connected to a Nozzle in another Design DB. The HREF (or TREF) attribute of the Branch would point into the second DB and the CREF attribute of the Nozzle would point back into the first DB. See example below:

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

Branch /150-B1

Similarly, references can exist from Design DBs into Catalogue DBs (the SPREF attribute of a piping component pointing to an SPCOM, for example), but references cannot exist from a Catalogue DB back into a Design DB. When a DB is reconfigured without the SAMEREF option, most of the reference numbers of its elements will change. To maintain the integrity of pointers into the DB from other DBs, the contents of any DB which might point to elements in the reconfigured DB are scanned and the reference or reference array attributes are changed to point to the correct element once more. For example, assume that the reference number of an SPCOM in a Catalogue DB changes from =17/3108 in the original DB to =49/2014 in the reconfigured copy. All piping components whose SPREF attribute was previously set to =17/3108 must have SPREF reset to =49/2014. Such components might exist in several DBs. Reference resetting is performed by the RCFUPDATE command described in the next section.


3:9

12.0


3.11.2

Updating References into a Reconfigured DatabaseWhile 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/DESIGNUpdates references to the reconfigured DB from DB MASTER/DESIGN.

RCFUPDATE DB MASTER/DESIGN INTERNALUpdates 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 /USERAUpdates all references to the reconfigured DB from DBs in MDB /USERA.

RCFUPDATE TEAM USERUpdates 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 /VESS1 /VESS2 =123/456 =123/457 New reference =123/457 =123/458

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

RECONFIGURER knows which types of DB can be pointed to by reference attributes in other types of DB, and so does not attempt to update DBs which could not possibly point to the latest reconfigured copy. A report is output which lists which DBs were and which were not updated.The table of references is maintained across multiple reconfigurations, as long as you do not exit from ADMIN.


3:10

12.0


3.11.3

Saving the Reference Number IndexThe 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 /DUMP2These 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 DatabasesThe RCFCOPY ALL command copies all the elements in the source DB World into the destination DB World. If the World of the destination DB already contains members, then the elements from the source DB are added to these. The RCFCOPY command can be used to define the root elements to be copied. A root element is any element owned by the World, that is:

BLTA GPWL

CASW LIBY

CATA MATW

CCTA RUNW

CMPW SITE

CONW SPWL

DEPT 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-7Elements 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.


3:11

12.0


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-3would 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-3is 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-12is 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 /SITE3Note: Partial reconfiguration of PADD DBs is only allowed for picture elements (i.e. SHEE, BACK, OVER, SYLB, LALB) and above.

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

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


3:12

12.0


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 GroupsIf 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 ProjectsRECONFIGURER 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 /CATOLDSpecify source DB.

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

RCFCOPY ALL RECONFIGUREand in the destination project: Example:

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

TO DB /CATNEWpass 2 of reconfiguration to be done.

RCFCOPY ALL RECONFIGURE


3:13

12.0


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 CIVIL/STRUC4 ANSI/MASCAT SITE-A Elements Transferred Whole Design DB Whole Catalogue DB One Site Destination DB STEEL/MAIN CATAL/MAIN EQUIP/MAIN

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

FROM DB ANSI/MASCAT TO FILES /REC1A /REC1B RCFCOPY ALL RECONFIGURE FROM DB CIVIL/STRUC4 TO FILES /REC2A /REC2B RCFCOPY ALL RECONFIGURE FROM DB VESSEL/V25CT TO FILES /REC3A /REC3B RCFCOPY /SITE-A RECONFIGUREand in the destination project:

Copies the Catalogue DB first

Copies the Design DB

Copies the Site

FROM FILES /REC1A /REC1B TO DB CATAL/MAIN RECONFIGURE FROM FILES /REC2A /REC2B TO DB STEEL/MAIN RECONFIGURE FROM FILES /REC3A /REC3B TO DB EQUIP/MAIN RECONFIGURE RCFUPDATE DB STEEL/MAIN RCFUPDATE DB EQUIP/MAIN

Creates Catalogue DB

Creates Design DB

Creates equipment item

Gives correct cross-references

3.13

Upgrading a ProjectThe 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


3:14

12.0


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 Ltd, and it is for this reason that they are described here. XREF may be used to generate a list of the reference numbers of all elements which need updating for each DB. The list is created during the restructuring of the new DBs in Phase 2 of Pass 2. This list is then used to monitor a partial updating operation, which ensures that all references are reset into every element which has been affected by a DB reconfiguration. The partial update is controlled by the RESETXREFS command, which is related to the RCFUPDATE DB command. The RESETXREFS function applies only to elements whose reference numbers appear in the corresponding XREF file. For example:

RESETXREFS WITH /REFFILE RESOLVE DB MASTER/DESNEW RESET /REF2 RESOL /NEWDBHere /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.


3:15

12.0


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/A2A more general command sequence for a project upgrade is shown in the following input and output macros: Input macroWrite 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


3:16

12.0


Output macroWrite 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 MessagesDuring 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 MessagesThe progress-monitoring messages, which indicate the stages reached during the reconfiguration, are self-explanatory. They are:

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


3:17

12.0


The format of this report is: Integer Integer Interger Integer Interger Elements were not defined in the DDL Elements have been lost Elements are no longer named Attributes where incorrectly defined Elements were not inserted

where integer is the relevant number.

3.14.2

General Format of Pass 2 Error MessagesIn 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/23The individual parts of the message are: CODE: TYPE: OLDREF NEWREF: Identifies the nature of a message arising from the creation or naming of an element. The codes used are detailed in the next section. The type of element, e.g. SITE, BRAN, SHEE etc. The reference number of the element in the source DB (starting with #). The reference number of the corresponding element created in the destination DB (starting with =). This will be blank if the element could not be created. The name given to the element. This applies only if the message is coded EN to indicate that the element has been named (see next section).

NAME:

3.14.3

Codes Used to Identify Message TypesThe 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.


3:18

12.0


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

EC EN

Element Created Element Named

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

*ENID

Elements Not In DDL

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

*ENI

Element Not Inserted

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

*EL

Element Lost

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

#EAE

Element Attribute Error

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

3.15

Database Transfers between ComputersNote: 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 PDMS DESIGN Reference Manual Part 1 (OUTPUT command).


3:19

12.0


3.16

Binary and Character FilesData 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 ProcessThe 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 RECONFIGOn destination machine:

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

3.18

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


3:20

12.0


3.193.19.1

Reconfiguring ExtractsOutputting Changes OnlyThe 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 OptionThe 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 OptionThe SESSIONS option is always used for extracts. You need not enter the SESSIONS option; it is assumed.

3.19.4

Reconfiguring a Single ExtractThe procedure for reconfiguring a single leaf extract is as follows: 1. Reconfigure from the DB to a file. 2. REVERT the extract to Session 1. 3. MERGE CHANGES to remove the intermediate session. 4. Reconfigure from the file to a DB. An alternative strategy would be to replace Steps 2 and 3 by a DB deletion and a DB creation. The procedure is similar for single extracts that own other extracts. The only difference is: The MERGE CHANGES command will leave sessions referred to by child extracts. Thus, the resultant file will be larger than it would have been had there been no extract children. The alternative approach of deleting and recreating the extract is not possible unless all child extracts are also deleted and recreated. The Master DB should be reverted to Session 2 rather than Session 1.

3.19.5

Reconfiguring a Family of ExtractsWhen reconfiguring a whole extract family, the following considerations apply: The REVERT/MERGE operation must be done bottom-up, to minimise the number of sessions kept. Reconfiguring from databases to files must be done top-down. Reconfiguring back from files to databases must also be done top-down, and you must complete the reconfiguration for the whole extract. For example, if you reconfigure all three database levels of a three level extract to files but only reconfigure the top two file levels back to databases, the third database will be corrupted due to the reconfiguration of the other two. For further details, see section 3.19.7 below. Before reconfiguring out from a file, refresh the extract.


3:21

12.0


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 CommandWhen 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 ExtractConsider this three-level extract:

All databases must be reconfigured to files first and then reconfigured from the files to the databases, in the order; MASTER, EXT, EXTBOT. If this sequence of operations is not completed, then databases will be corrupted. For example, if EXTBOT is not reconfigured from file, then EXTBOT will be corrupted as a result of the reconfiguration of the other two databases. It is therefore suggested that you make backups of databases before reconfiguring them. The sequence of commands to reconfigure the above three level extract could therefore be: Note: The REFRESH, REVERT and MERGE CHANGES commands have not been shown below.

FROM DB CTBATEST/MASTER TO FILE /MASTERA /MASTERB RCFCOPY ALL RECONFIG SESSIONS FROM DB CTBATEST/EXT TO FILE /EXTA /EXTB


3:22

12.0


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 RECONFIGIt 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 SESSIONS2. At location B (primary location for EXT):

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

FROM DB CTBATEST/EXTBOT TO FILE /EXTBOTA /EXTBOTB RCFCOPY ALL RECONFIG SESSIONSSteps 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 RECONFIGThe user must now propagate the whole database to locations (B) and (C).


3:23

12.0


5. At location B (primary location for EXT)

FROM FILE /EXTA /EXTB TO DB CTBATEST/EXT RECONFIGThe 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 RECONFIGThe 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 ProjectThe 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, see Running Global Projects with PDMS. Note: The daemon for a location must be stopped before reconfiguring its transaction database.


3:24

12.0

Administrator Command Reference ManualSystem and Global Projects

4

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


4:1

12.0


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


4:2

12.0


STAT ElementThis 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 ElementThe 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 ElementThe 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 Lock Owner Logfn Logms Loglv /name false /*LC /filenam false 0 Diagnostic level Log file name

LCOML ElementThe LCOML element contains a list of LCOMD elements, each of which specifies details about the communications link between the current site and one other site, as described below. Attributes: Name Type Lock Owner /name LCOML false /*LC


4:3

12.0


LCOMD ElementThe LCOMD element contains specific details about the communications link between the current site and one other site, and controls scheduled updates. There will be one LCOMD element for each location, which has a communications link with the current location. Attributes: Name Lock Owner Description Locrf Timer Times Timee Timei Timeo Execb Execa LNoUpd 0 2400 30 10 unset unset false /name false /name unset /name 120 character text Name of Location which has comms link with current Location frequency of update events 120 character text: (See below) Time window start Time window end Interval in seconds between communication attempts Number of re-tries 120 character text: name of script to be run before updates are transferred (optional) 120 character text: name of script to be run after updates are transferred (optional) 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 Hours Days Months Days of the week For example: Timer '0,30 * * * *' Timer '12 10,12,14,16,18 * * 1,5 ' specifies every half hour, every day. specifies 12 minutes past the hours given, Monday to Friday. 0 - 59 0 - 23 1 - 31 1 - 12 0 (Sunday) - 6


4:4

12.0


The attributes TIMES and TIMEE are not implemented at this release. Files such as Isodraft external plot files files are not propagated automatically by the global daemon. However, there is a mechanism in the daemon to allow such files to be transferred to and from neighbouring locations, during scheduled updates (or the UPDATE ALL command). The directory to receive transferred files is defined by the environment variable %IMPORT%. Each location to which files are to be transferred requires its own transfer directory - %EXP_ABC% for location ABC. Transfer of other data is described more fully in the Global User Guide. Offline locations: Note that transfer of such files to or from offline locations must be done manually.

LCTIML ElementThe 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 Lmerti 5 Time interval for event loop (secs)

Frequency of Automerges. 120 character text:

(settings as for Timer above) Lmersu Lmerfa Lmerdl 3 3 false Time in days after which successful commands should be deleted. The value -1 means no deletion. Time in days after which failed commands should be deleted. The value -1 means no deletion. If true, transaction database is merged and purged at specified times.

At times specified by LMERTI, the transaction database will automatically be merged and commands deleted as specified by the LMERSU and LMERFA attributes. The LMERDL attribute must be set to true. For example, the automerge data could be set as follows: LMerti 59 23 * * 3,6 LMersu 10 Lmerfa -1 Lmerdl true

In this example, the daemon would delete all successful commands older than 10 days and merge the transaction database. Failed commands would not be deleted. Note: If both LMERSU and LMERFA are set to -1, then the transaction database will not be merged.


4:5

12.0


LCTIMD ElementThe LCTIMD element contains details about the event timings between the current site and one other site. There will be one LCTIMD element for each location that communicates with the current location. Attributes. Name Description Locrf Lendti Lmaxtr Ltimei /name unset /name 604800 100 120 120 character text Reference to Location communicating with current Location Command timeout period, in seconds (default is 7 days in seconds) Maximum number of retries to send command Time interval between retries, in seconds

4.2

Structure of the Global DatabaseThe 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.WORLD World

/*GS GSTAT Global Status World

/*GL GLOCWL Location World

/*GRO GROLW Global Role World

/*GT GTMWL Global Team World

/*GST GSTWLD Global Stamp World STAMP Stamps

ROLE Roles GRPLI Group List LOCLI Location List LNKLI Links List PEROP Perops LNK Links

TEAM Teams

DBLI DB List

STLST Stamp List

GRP Groups

LOC Locations

DB DBs

DBLOC

Figure 4:1.

Structure of the Global System Database

2007 AVEVA S

Documents

Administrator Command Reference Manual