Administrator Command Reference Manual
Command Details : Detailed Descriptions of Commands : REMOTE (Global Project Administration)
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
•
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 AVEVA E3D™. 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 <loc> MERGE CHANGES GLOBALDB where <loc> 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-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 AVEVA E3D™ using the MERGE command.
Examples:
For details of time and date syntax, see Notes on Syntax Graphs.
BACKTRACK
 
REMOTE <loc> BACKTRACK dbname TO 14:30
REMOTE <loc> BACKTRACK dbname TO  SESS 17
Backtracks changes to the given database, which must be Primary at the named location. A database cannot be backtracked through a stamp.
REVERT
 
REMOTE <loc> REVERT dbname TO 14:30
REMOTE <loc> REVERT dbname TO  SESS 17
Adds a session reverting to the data at the specified session or date. The database must be Primary at the named location.
MERGE CHANGES
 
REMOTE <loc> MERGE CHANGES dbname BEFORE 31 MARCH 
REMOTE <loc> MERGE CHANGES dbname BEFORE SESSION 9 AFTER SESSION 4
Merges changes to the given database, which must be Primary at the named location. Stamped sessions will not be removed by the merge.
REMOTE <loc> MERGE CHANGES SYSTEM 
Merges changes to the system database for the location <loc>.
 
REMOTE <loc> MERGE CHANGES SYSTEM FOR <loc2> 
Merges changes to the system database for <loc2>, which must be administered by <loc>.
REMOTE <loc> MERGE CHANGES <dbname> AT 23:00 <merge-options>
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.
 
REMOTE <loc> MERGE GLOBALDB
Merges the Global database at location <loc>.
EXPUNGE
 
REMOTE <loc> EXPUNGE
REMOTE <loc> EXPUNGE username
Expunges all users or the given user from the communications database at the given Location. username is the AVEVA E3D™ username.
 
REMOTE <loc> EXPUNGE DB dbname
REMOTE <loc> EXPUNGE DB dbname USER username
REMOTE <loc> EXPUNGE DB SYSTEM
REMOTE <loc> EXPUNGE DB SYSTEM FOR <loc2> 
Expunges all users or the given user from the given database at the given Location. The database must be primary at the given Location. Username can be the AVEVA E3D™ username or a session number.
 
REMOTE <loc> EXPUNGE DB dbname AT 22:55
Expunges the specified database at a specified time, to allow housekeeping operations.
DICE Checking
 
REMOTE <loc> CHECK SYSTEM
REMOTE <loc> CHECK DB dbname
REMOTE <loc> CHECK MISCDB dbname 
REMOTE <loc> CHECK COMMDB
REMOTE <loc> CHECK SYSTEMDB FOR <loc2>
Performs a standalone DICE check on the given database at the given Location. The database does not need to be primary at the given Location. The check uses the current MODE, STATISTICS, MAXERRORS and MAXWARNINGS settings.
Cancelling commands
 
REMOTE <loc> CANCEL <gid>
Allows an Admin user to cancel a command at another Location <loc>, where <gid> is a TRINCO in the transaction database for the given Location (this is not the current Location, unless <loc> is the current Location). This command requires an up-to-date version of the transaction database for Location <loc> to be available at the current Location. (The transaction database is not normally propagated. It is best to RECOVER this database from the primary location rather than to SYNCHRONISE it.)
Note:
Only commands which have not started can be cancelled.
Command Syntax:
For details of <loc> and <when> syntax, see Notes on Syntax Graphs.
>- REMOTE <loc> BACKTRACK dbname TO <when> -->
>- REMOTE <loc> REVERT dbname TO <when> -->
>- REMOTE <loc> MERGE CHANGES +--- dbname ----------------.
                              +--- GLOBAL ----------------|   .---------.
                              +--- SYSTEM -+- FOR <loc> --|  /          |
                                           `--------------+--+-<options>-+
                                                       `--->
where <options> is:-
--+--BEFORE <when>---.
  +--AFTER <when>----|
  +--AT <date>-------|
  `------------------+--->
REMOTE (continued)
>- REMOTE <loc> EXPUNGE -+- USER username ----------------------.
                         |                                      |
                         |--------------------------------------|
                         |                                      |
                         ‘- DB --+- dbname -+-- USER username --|
                                 |          |                   |
                                 |          ‘-------------------|
                                 |                              |
                                 ‘- SYSTEM -+-- FOR <loc2> -----|
                                            |                   |
                                            ‘-------------------+-->
>- REMOTE <loc> CHECK --+-- DB dbname ------------------------.
                        |                                     |
                        |-- MISCDB  --------------------------|
                        |                                     |
                        |-- COMMDB  --------------------------|
                        |                                     |
                        |-- SYSTEMDB dbname -+- FOR <loc2> ---.
                        |                    |                |
                        |                    ‘----------------|
                        |                                     |
                        ‘-- GLOBALDB -------------------------+-->
Related Commands:
CANCELCOMMAND, REMOTEMESSAGE, MERGE, REVERT, BACKTRACK, EXPUNGE, CHECK
Querying:
Remote database session information can be queried using the Q REMOTE command:
Q REMOTE <loc> <dbname> FILEDETAILS
Would return:
Compaction number 104
Last session 142
Header changes count 0
Claim list changes count 0
Last page 139
Q REMOTE <loc> <dbname> 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 <dbname> can be one of:
•
GLOBAL
•
SYSTEM
•
SYSTEM FOR LOCAL
•
SYSTEM FOR <loc>
The Global banner at a remote location can be queried using:
Q REMOTE <loc> BANNER
An example output would be:
AVEVA Global Mk12.0.0.1 (WINDOWS-NT 5.1) (Mar 6 2009)
Information about remote users of AVEVA E3D™ 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)
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 <BOOLEAN> FALSE
ISREMOTE <BOOLEAN> 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):-
<USER> 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 <loc>
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.
1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Logo