Administrator Command Reference Manual
Command Details : Detailed Descriptions of Commands : CHECKOPTION (Data Integrity Checking)
CHECKOPTION (Data Integrity Checking)
Function:
Sets the options for database integrity checking.
Description:
The CHECKOPTION command is used to control the level of detail output by a CHECK command. You can specify whether or not you want to check references to other (external) databases. You can also check consistency of claimlists, and, if there are errors, instruct AVEVA E3D™ to correct them where possible.
Use the CHECKOPTION command to set up the output you require, and then use the CHECK command to perform the check.
Note:
This command is only available within an AVEVA E3D™ project. The corresponding top-level commands MODE, STATISTICS, MAXERRORS and MAXWARNINGS are available when running stand-alone DICE or REMOTE CHECK.
Controlling the Amount of Information Output
There are two types of DB fault detected by DICE:
•
An error is identified if the DB is corrupted internally.
•
A warning is identified if DICE encounters, for example, a fault with a reference to an external DB.
In BRIEF mode, checking is stopped when the first error is encountered; that is, DICE simply determines whether or not the DB is corrupt. This is the default mode.
In FULL mode, DICE continues checking the whole DB or file, listing all errors and warnings, until a prescribed maximum error or warning count is exceeded, when checking of that DB is abandoned. Occasionally DICE will stop before processing the whole DB. This will happen when the error is so severe that it is not worth continuing; for example, if a database has been truncated.
The default setting for the maximum error count and maximum warning count is 50, but you can specify different numbers by using the MAXERRORS and MAXWARNINGS options.
STATISTICS ON causes DICE to produce a statistical summary of the DB, including its size, the number of elements contained within it, etc.
STATISTICS OFF specifies that no statistics are to be gathered during the checking. This is the default setting.
An example of the output from DICE when statistics are requested is as follows:
OVERALL STATISTICS
==================
Total no. of entries in Name Table = 111
Total no. of elements checked = 782
Total no. of ref attributes found = 726
Total no. of external references = 0
Checking External References
The elements in some types of DB have reference or reference array attributes which can point to elements in other DBs. If you use the EXTERNAL option, DICE will check that all external references point to DBs of appropriate types. For example, a reference attribute in a MODEL DB which points to a Draft (PADD) DB must be illegal, but a reference attribute pointing to a Catalogue DB will be accepted.
This command cannot be used in stand-alone mode because only one DB file can be accessed at a time.
EXTERNAL NOCHECK is the default. In this mode DICE does not cross-check any references to other DBs. It is recommended that this setting is always used for Transaction databases.
If EXTERNAL CHECK is specified, the following tests are applied to each external DB to which reference is made:
•
Does the referenced DB exist?
•
Is the referenced DB of a valid type?
•
Is the position pointed to within the limits of the referenced DB? Note that in the case of a DB which has copies, DICE only checks that the position pointed to is within the limits of the largest copy.
A non-fatal error message is produced for each invalid external reference found.
Note:
Not recommended for Transaction databases due to the large number of errors that will be reported.
If you specify the EXTERNAL CHECK option, you can specify a preference MDB. In this case, DICE will check external references to databases which are current within the given MDB, before checking other databases in the project. This option is mainly relevant when extracts are used, which means that there may be many databases with the same database number in the project, and so it is less relevant to Global projects.
Once set, the preference MDB remains current until another EXTERNAL CHECK PREFERENCE command is entered to set a new MDB, or to specify that none is to be used, (though the setting will become irrelevant if EXTERNAL NOCHECK or EXTERNAL REJECT is entered). Using just EXTERNAL CHECK to switch external setting back on will not affect the current preference MDB.
The EXTERNAL REJECT option should normally be chosen only when you are certain that the DB which is being checked should not contain any external references. If this setting is used, any external reference found in the DB will be reported as a fatal error and further checking will be abandoned.
Note:
Not recommended for Transaction databases due to the large number of errors that will be reported.
Note:
When the CHECK FILES option is used, no external reference checking can be done for that file and EXTERNAL NOCHECK will be assumed.
The CLAIM options are only relevant to extracts.
Extract Claimlists
The CLAIM ON option (the default) will check that the claim list in an extract corresponds with the claim list in its master database. The following error messages may be produced:
700:
Element ref/ref is not in parent extract claim list
702:
Element ref/ref is claimed to another user/extract
703:
Element ref/ref needs claiming to child extract in parent extract
704:
Element ref/ref needs clearing in parent extract claim list
If PATCH ON has been selected, then an attempt is made to patch errors of type 701, 703 and 704, and these cases will be treated as warnings rather than errors (and will therefore not terminate the check even if MODE FULL has not been selected).
For cases 701 and 703, the patch attempts to claim the element from the parent extract (and continues up the extract hierarchy if necessary). If successful, the following message will be written:
701:
PATCH: Element ref/ref claimed in parent extract
For case 704, the patch attempts to release the element from the parent extract. If successful, the following message will be written:
CHECKOPTION (continued)
704:
PATCH: Element ref/ref cleared from parent extract claim list
If the attempted patch is unsuccessful, the following error will be raised:
537:
Attempt to patch failed
There is no patch for errors of type 702.
(Patches may also be attempted for some other extract problems.)
Command Syntax:
>-- CHECKOption ----+- EXTernal --+- CHECK -+-----------------------.
                    |             |         |                       |
                    |             |         ‘- PREFerence -+- NONE -|
                    |             |                        |        |
                    |             |                        ‘- mdb --|
                    |             |                                 |
                    |             |-- NOCHeck ----------------------|
                    |             |                                 |
                    |             ‘-- REject -----------------------|
                    |                                               |
                    |- MOde -------+-- FUll ------------------------|
                    |              |                                |
                    |              ‘-- BRief -----------------------|
                    |                                               |
                    |- STATistics -+-- FULL ------------------------|
                    |              |                                |
                    |              |-- ON --------------------------|
                    |              |                                |
                    |              ‘-- OFF -------------------------|
                    |                                               |
                    |- MAXErrors n ---------------------------------|
                    |                                               |
                    |- MAXWarnings n -------------------------------|
                    |                                               |
                    |- CLAIM ------+-- ON --------------------------|
                    |              |                                |
                    |              ‘-- OFF -------------------------|
                    |                                               |
                    ‘- PATCh ------+-- ON --------------------------|
                                   |                                |
                                   ‘-- OFF -------------------------+->
Related Commands:
CHECK
1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Logo