Data CheckeData Checker Utility User Guider Utility User Guide

7/27/2019 Data CheckeData Checker Utility User Guider Utility User Guide

http://slidepdf.com/reader/full/data-checkedata-checker-utility-user-guider-utility-user-guide 1/26

Data Checker UtilityUser Guide



Disclaimer

Information of a technical nature, and particulars of the product and its use, is given by AVEVA

Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim

any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.

Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or

entity for any actions, claims, loss or damage arising from the use or possession of any information,

particulars, or errors in this publication, or any incorrect use of the product, whatsoever.

Copyright

Copyright and all other intellectual property rights in this manual and the associated software, and every

part of it (including source code, object code, any data contained in it, the manual and any other

documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.

All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in

this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrievalsystem, 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 withthe terms and conditions of the respective license 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

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

Trademarks

AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised

use of the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its

subsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trade mark rights, or other intellectual property rights in any other product, its name or

logo belongs to its respective owner.

AVEVA Solut ions Ltd



Data Checker Uti li ty User Guide

Contents Page

12.0i

Data Checker Utility User Guide

Data Checker Util ity

Introducing the Data Checker Utili ty . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Scope of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

How the Guide is Organised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Running the Data Checker Util ity . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Specifying the Elements to be Checked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Selecting the Check Funct ions to be Carried Out . . . . . . . . . . . . . . . . . . . . . . . 2:2

Highlight ing Elements in the Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3

Running the Checks and Viewing the Results . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3

Navigating to a Checked Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4

Saving Check Results to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4

Updating the Available Check Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

Adding a New Check Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Checker Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Rules for Organising Checks into Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Check Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Checker Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Example 1: Panel Boundary Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Example 2: Structural Element Name Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6

Modifying and Deleting Check Functions . . . . . . . . . . . . . . . . . . . . . 4:1



12.0ii


Checker Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1




Introducing the Data Checker Utility

12.01:1

1 Introducing the Data Checker Utility

1.1 Scope of this Guide

This guide describes the Data Checker utility, which allows data consistency checks written

in PML to be added to DESIGN quickly and easily.

The Checker utility provides:

• A standard user interface for data consistency checks written in PML.

• Standard reporting, to screen and file, of the results of a data consistency check.

• The ability to add new checking functions tailored to company or project workingpractices.

• Navigation in the database to elements that have failed the checks, by simply pickingon part of the on-screen report.

You can add your own customised check functions to any standard data consistency checks

provided by AVEVA. A check function is a PML function which tests selected elements in the

database, and reports back to the Checker utility whether the element has passed or failed

the tests.

This guide does not describe how to program in PML. Before reading the customisation

chapters of this manual you should be familiar with PML facilities, which are described in full

in the Software Customisation Guide.

1.2 How the Guide is Organised• Running the Data Checker Utility describes how to use the Checker utility to run

predefined data checks.

• Adding a New Check Function explains, with some examples, how to add new Checkfunctions. It shows the conventions used when programming Check functions in PML.

• Modifying and Deleting Check Functions shows how to modify or delete existing Checkfunctions.

• Checker Objects defines the principal PML objects used by the Checker utility.

Note: If you simply want to run predefined checks on your design data, you need only refer

to Running the Data Checker Utility.

If you want to customise the Checker utility by editing the files defining available Check

functions, you will need to read the whole of the guide.



12.01:2


Introducing the Data Checker Utility




Running the Data Checker Utility

12.02:1

2 Running the Data Checker Utility

To access the Data Checker utility from within any DESIGN application, selectUtilities>Data Checker from the application's main menu bar.

All checking operations are controlled from the resulting form:

Note: When this form is first displayed, the Check Items list will be empty.

The upper part of the form lets you specify which design elements you want to check; the

lower part lets you select one or more check functions to be applied to those elements.

To run a data check, carry out the operations described in the following sections.



12.02:2



2.1 Specifying the Elements to be Checked

Use the Checker form's Add and Remove menu options to edit the Check Items list until it

shows those elements that you want to check.

The Add menu options work as follows:

• CE

Adds the current element (as shown in the Explorer or Members List).

• CE Members

Adds all members of the current element, but not the current element itself.

• Pick

Lets you add elements by picking them in a graphical view, using any of the standardevent-driven graphics options.

• Failed Lis t (valid only after a previous data check)

Adds all elements which have failed an earlier check, as listed on a Checker Resultsform (see Running the Checks and Viewing the Results). This option is useful for rechecking items after you have corrected the reasons for their earlier failure.

• List list_name

Adds all elements in the named list (as created using the application's Utilities > Listsmenu option). This provides a convenient way of adding elements which conform to aselection rule (for example, 'all pipes with pspec eq /A1A'), or which are within a givenvolume.

The Remove menu options work as follows:

• All

Empties the Check Items list.

• Selected

Removes all items currently selected in the Check Items list.(Pick an element in the list to select it; pick it again to deselect it.)

• CE

Removes the current element (as shown in the Explorer or Members List).

• CE Members

Removes all members of the current element, but not the current element itself.

• Pick

Lets you remove elements by picking them in a graphical view, using any of thestandard event-driven graphics options.

• List list_name

Removes all elements in the named list (as created using the application's Utilities >Lists menu option). This provides a convenient way of removing elements whichconform to a selection rule (for example, 'all pipes with pspec eq /A1A'), or which arewithin a given volume.

2.2 Selecting the Check Functions to be Carried Out

The available check functions are organised into class and group categories, simplifying

the selection of those most relevant to your current design activities. Each class of checks

represents, typically, a main design discipline; for example, Steelwork, Piping, HVAC, Cable

Trays, etc. Each class may have one or more groups associated with it, representing more

specific features of the design discipline; for example, HVAC Branches, HVAC Offsets, etc.





12.02:3

First select the required class of checks from the Classes options. This will automatically

update the Groups options.

Now select the required group of checks from the Groups options. This will automatically

update the Checks list to show all individual checks applicable to the chosen class and

group.

From the Checks list, select one or more checks that are to be made on the elements in theCheck Items list. (Pick an element in the list to select it; pick it again to deselect it.)

2.3 Highlighting Elements in the Graphical View

To make it easier to interpret the check results, you can highlight particular elements in the

graphical view. The Highlight menu options work as follows:

• Elements

Highlights all elements that are in the Check Items list. When you select this option,you will see a form that lets you choose the highlight colour. Note that only elementsalready in the Drawlist will be highlighted; elements are not added to the viewautomatically.

• Passed

This is an On/Off toggle option. When on (shown by a tick on the menu), all elementswhich pass subsequent checks will be highlighted. Set the required highlight colour using the Colours > Passed menu option.

• Failed

This is an On/Off toggle option. When on (shown by a tick on the menu), all elementswhich fail subsequent checks will be highlighted. Set the required highlight colour usingthe Colours > Failed menu option.

• Clear Clears either just the current element (CE), or everything in the graphical view ( Al l).

2.4 Running the Checks and Viewing the Results

When you have set up the check requirements as described in Specifying the Elements to

be Checked to Highlighting Elements in the Graphical View, click the Check button to carry

out the checking operations. The results will be displayed in a Checker Results window, as

shown.



12.02:4



:

The Passed list shows all elements that have passed all specified checks. The Failed list

shows all elements that have failed one or more checks, with a brief description of the

reason for the failure.

2.5 Navigating to a Checked Element

To navigate easily to any element shown in the Passed or Failed list, click on that item in

the list.

This facility is particularly useful if you want to navigate to a failed element to correct the

reason for the failure before repeating the checks.

2.6 Saving Check Results to a Fi le

To save the results of a data check to a file, select one of the following:

• Control > Save > ResultsThis saves both the Passed and Failed results. Use the displayed File Browser tospecify the required file name and its location.

• Control > Save > Failed Reference

This saves the database references of elements that have failed, together with thechecks performed. Use the displayed File Browser to specify the required file nameand its location. This facility makes it easy to recheck the failed elements later.

To reload a list of failed element references (saved as in the preceding paragraph), typically

following corrections to their data settings, select Control > Load > Failed References and

use the displayed File Browser to specify the required file.





12.02:5

2.7 Updating the Available Check Functions

If the list of available checks has been modified during your current PDMS session (say by

editing existing checks or adding new ones), you can update the Checker form to show thenew options immediately. To do so, select Control > Reload Checks.

The checks will be reloaded from the relevant default and user directories and the Classes,

Groups and Checks options will be updated as appropriate.



12.02:6






Adding a New Check Function

12.03:1

3 Adding a New Check Function

3.1 Checker Configurat ion Fi les

Although the Checker utility is used by AVEVA to supply standard data checking facilities in

PDMS, its main purpose is to allow users to add their own checking tools.

The utility is controlled by creating configuration files. These configuration files will tell the

system what checks are available, and which elements to select for checking. In order to

keep standard (AVEVA) and user checking functions separate, they are configured in

separate configuration files.

The standard AVEVA-supplied checks for PDMS data are configured in a file called com-checks.pmldat, in the product directories. This file must not be modified. (The com prefix

shows that this file can, in principle, apply to any PDMS module; in this release, the utility is

available from DESIGN only.)

User-supplied checking tools for Design data must be configured in files named des-checks.pmldat in the following directories:

• The PDMSDFLTS directory holds company-wide checks, which are available to allprojects.

• The ABCDFLTS directory (where ABC is the project name) holds checks specific toone project.

• The PDMSUSERdirectory holds checks specific to a single user.

Entries in all des-checks.pmldat files available to a user will be combined together on the

Checker form.

The format of des-checks.pmldat files is described by example below. The commands in the

file must be valid PML syntax, and all information must be provided for each checking

function.

The Checker file in the following example contains two checks:

• The first check identifies any panels that have incorrectly defined boundary curves. Itdoes so by checking for panels having fewer than three vertices, or zero-length edges.

• The second check looks for structural elements that do not obey a naming convention.

The naming convention for this example is that the names of all SCTN, PANEL, FRMWand SBFRelements must start with the first two letters of a UDA :PRODNO, which is set

at ZONE level.

- - Dat a f i l e f or Desi gn Checker Ut i l i t y

- - Comment lines begin --

- - Checks f or panel zero l engt h edges, backt r acks, and <3 vert i ces



12.03:2



!Check.Title identifies the check in the Checks selection window and in the Failed resultslist.

!Check.Class and !Check.Group determine the Classes and Groups descriptions for the

check function.

!Check.Types is a list of element types that will be selected for this test. This list will be

filtered by the rule in !Check.Rule. Only elements from the !Check.Types list which obey

any conditions specified in !Check.Rule will be presented to the check function by the

Checker utility. The database reference (DBREF object) of a selected database element is

passed to the check function. The check function must be written to handle any elements

that might be selected and passed to it. If the check function itself fails, this will be reported

in the Failed results list.

! Check = obj ect CHECK( ) Declaration of new check entry

! Check. Name = ' LOOPCHECK' Name of check function

! Check. Ti t l e = ' Check Panel Boundary' Title appears in Check selection box

! Check. Cl ass = ' St eel work' Add this check function to this class

! Check. Gr oup = ' Panel s' Add this check function to this group

! Check. Types = ' PANE' Type of element to be checked

! Check. Rul e = ' ' Rule for filtering selected element types

(none)

! Check. Funct i on = ' ! ! EdgeCheck' Name of Check Function

! Check. Modul e = ' Desi gn' PDMS module using this function

! Check. Fi l eType = ' $1' Mandatory line for checker utility

! ! AddChecker Check( ! Check) Adds this check to the list of checks

- -

- - Check t hat pr i mary st eel el ement names begi n wi t h t he f i r st t wol et t er s of t he Pr oduct i on Number i n : PRODNO UDA on ZONE

! Check = obj ect CHECK( ) Declaration of new check entry

! Check. Name = ' STRUCTNAME' Check name

! Check. Ti t l e = ' Check Steel work Names’ Title appears in Check selection box

! Check. Cl ass = ' St eel work'Class

! Check. Gr oup = ' Admi ni st r at i on' Group

! Check. Types = ' PANE SCTN FRMW SBFR' List of element types to check

! Check. Rul e = ' FUNC OF ZONE eq | PS| ' Selection filter

! Check. Funct i on = ' ! ! PSNameCheck' Name of Check Function

! Check. Modul e = ' Desi gn' Used in DESIGN

! Check. Fi l eType = ' $1' Mandatory Line

! ! AddChecker Check( ! Check) Add to the list of Checks





12.03:3

!Check.Function is set to the name of the check function, which must include the !! at the

beginning of the name. This function must exist in the PMLLIB search path. The filename of

the function will be the same as the function name, but all in lower case with a .pml filename

extension; for example, the !!PSNameCheck function will be defined in filepsnamecheck.pml.

!Check.Module is set to the PDMS module in which this check will run.

The !Check.FileType = '$1' line is mandatory.

The !!AddCheckerCheck(!Check) line adds the details of this check to the list of available

checks.

3.2 Rules for Organising Checks into Groups

Any number of Check Classes and Check Groups can be defined, but you must adhere to

the following rule:• All checks in the same class and group must have exactly the same selection criteria.

!Check.Types must contain the same element list, !Check.Rule must contain the sameselection filter, and !Check.Module must identify the same module.

If this rule is broken, then the results from the checker can be unreliable, particularly when

multiple checks are run at the same time.

3.3 Check Functions

Check functions are PML functions which are called by the Checker utility. The name of the

function is provided to the Checker utility from the !Check.Function line in a des-

checks.pmldat file.

A Check function contains PML code, which must follow these rules:

• The function definition must have the following format:

def i ne f unct i on ! ! Funct i onName ( ! I t emRef i s DBREF, ! Check i sCHECKDEFI NI TI ON ) i s CHKRETURN

!!FunctionName is the name of the function in the !Check.Function line in a des-checks.pmldat file. The PML file for a check function will be in a file namedfunctionname.pml.

!ItemRef is the name of the variable containing the database reference of the item to bechecked.

!Check is passed as an argument to the function, although it is not often used. !Checkcontains all of the information provided in the des-checks.pmldat file for this check

function.

These arguments are strictly read only. You should not reset the values of thesearguments in the function itself.

• The return information from a Check function must be put into a ChkReturn object.The detailed definition of this object is described later in this guide.

A ChkReturn object must be built by the Check function to tell the Checker utilitywhether the check has passed or failed. It is advisable to initialise the return value atthe start of the Check function:

! Resul t = obj ect CHKRETURN( ) Declare the Return object



12.03:4



• The remainder of the function performs the required check on the object passed in thefirst argument of the Check function. If any test in the function fails, the result must beset to indicate a failure. This is done by using the following method:

The function may stop and return a result after the first error is found, or it could go on and

find other errors and add them to the message list.

The result is returned to the Checker utility using the command:

r et ur n ! Resul t

3.4 Checker Examples

3.4.1 Example 1: Panel Boundary Check

This example checks a panel boundary for zero length edges and missing vertices. The

comments in the PML code describe the operations being performed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - Descr i pt i on:- - Checks f or bad def i ni t i on of panel boundary vert i ces:- - Zer o l engt h edge; Less t han t hr ee ver t i ces; Panel l oop not f ound- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

def i ne f unct i on ! ! EdgeCheck( ! Panel Ref i s DBREF, ! Check i s CHKDEFI NI TI ON ) i sCHKRETURN

- - I ni t i al i se Var i abl es! Resul t = obj ect CHKRETURN( )! Resul t . Passed = t r ue! Resul t . Messages. cl ear ( )

- - Get panel l oop el ement - er r or i f i t does not exi st

! Pl oopRef = ( PLOOP 1 OF $! Panel Ref )Handl e any! Resul t . Passed = f al se! Resul t . Messages. append( ' No Panel Loop Found' )r et ur n ! Resul t

endhandl e

- - get arr ay of ver t i ces bel ongi ng t o the panel boundaryVAR ! Ver t i ces COLLECT ALL PAVE FOR $!Pl oopRef ! Number Of Ver t s = ! Ver t i ces. si ze( )

- - Check that t her e ar e at l east t hr ee ver t i cesi f ( ! Vert i ces .s i ze( ) l t 3) t hen

! Resul t . Passed = f al se! Resul t . Messages. append( ' Onl y ' & ! Ver t i ces. si ze( ) & ' Ver t i ces' )

r et ur n ! Resul t

! Resul t . Passed = t r ue Initialise to test passed

! Resul t . Messages. cl ear ( ) Initialise the message list

! Resul t . Passed = f al se Indicates a test failure

! Resul t . Messages. append( ‘ Text of err or message’ )

Add a message to the list of

fail messages





12.03:5

endi f

- - Add f i r st ver t ex to t he end t o cl ose t he l oop! Ver t i ces. append( ! Ver t i ces[ 1] )

- - Loop thr ough ver t i ces and check f or zero l engt h edgedo ! I ndexVert s t o !Number Of Vert s

- - get addr ess and posi t i on of t hi s ver t ex and next vert ex! Vert ex = ! Ver t i ces[! I ndexVer t s]. dbref ( )! Next Ver t ex = ! Ver t i ces[! I ndexVer t s + 1] . dbref ( )! Ver t exPos = ! Ver t ex. Pos! Next Vert exPos = ! Next Vert ex. Pos

- - cal cul ate di st ance between ver t i ces & t est f or l ess t han 0. 01mm t ol eranceVAR ! Di st CONSTRUCT DI ST $! Ver t exPos TO $!Next Ver t exPosi f ( ! Di st. real ( ) l t 0. 01mm) t hen

! Resul t . Passed = f al se! Resul t . Messages. append( ' Zer o l engt h edge: Ver t ex ' & ! I ndexVer t s. st r i ng( ) )

ski pendi f

enddo

- - Ret ur n Datar et ur n ! Resul t

endf unct i on

The following is a sample report generated by running the preceding panel boundary check:

Check Report Fi l e

Cr eat ed By : M. Barl ow

Dat e : 10 Oct 97

Checks Perf ormed

Cl ass : St eel wor k

Gr oup : Panel s

[ 1] Check Panel Boundary

Summar y of Checks

El ement s passed al l t est s : 8

El ement s f ai l ed on or more t ests : 4

Tot al : 12

El ement s t hat have passed al l checks : 8

DEVTEST- C22001- P00001

DEVTEST- C22001- P00002

DEVTEST- C22001- P00003

DEVTEST- C22001- P00004

DEVTEST- C22001- P00005

DEVTEST- C22001- P00006

DEVTEST- C22001- P00007

DEVTEST- C22001- P00008

El ement s t hat have f ai l ed one or more checks: 4



12.03:6



El ement : PANEL 1 of FRMWORK / DEVTEST- C22001

Check Panel Boundary - No Panel Loop Found


Check Panel Boundary - Onl y 1 Ver t i ces


Check Panel Boundary - Zero l ength edge: Ver t ex 2


Check Panel Boundary - No Panel Loop Found

End of Check Report Fi l e

3.4.2 Example 2: Structural Element Name CheckThis example checks the names of PANE, SCTN, FRMW and SBFR elements for primary

steel ZONES (with FUNC ‘PS’). This example checks a panel boundary for zero length

edges and missing vertices. The comments in the PML code describe the operations being

performed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- - Descr i pt i on:- - Checks t hat t he f i r st t wo l et t er s of pr i mary st eel el ement names ar e- - t he same as t he f i r st t wo l et t er s of t he Pr oduct i on Number of t hat- - ZONE. The Product i on Number i s s t or ed i n UDA : PRODNO. A Zone cont ai ni ng- - pr i mary steel has i t s FUNC at t r i but e set t o ' PS' . Er r or s t est ed:- - Pr oduct i on Number UDA not set- - Product i on Number UDA i ncorr ect ( l ess than t wo l ett ers)

- - Steel wor k el ement not named- - Name of <i t emf ul l name> does not begi n wi t h <f i r st 2 l ett ers of : PRODNO>- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

def i ne f unct i on ! ! PSNameCheck ( ! I t emRef i s DBREF, ! Check i s CHKDEFI NI TI ON ) i sCHKRETURN

- - I ni t i al i se Var i abl es! Resul t = obj ect CHKRETURN( )! Resul t . Passed = t r ue! Resul t . Messages. cl ear ( )

- - Get Product i on Number and check t hat i t i s set! ZoneRef = ( ZONE OF $! I t emRef )! Product i onNumber = ! ZoneRef . at t r i bute( ' : PRODNO' )

i f ( ! Product i onNumber . empt y() ) t hen! Resul t . Passed = f al se! Resul t . Messages. append( ' Product i on Number not set f or ' & ! ZoneRef . f l nn)r et ur n ! Resul t

endi f

- - Check that pr oduct i on number has at l east t wo charact ersi f ( ! Pr oducti onNumber . l engt h( ) l t 2 ) t hen

! Resul t . Passed = f al se! Resul t . Messages. append( ' Product i on Number i ncorr ect f or ' & ! ZoneRef . f l nn)r et ur n ! Resul t

endi f

- - Get f i r st t wo character s of t he pr oduct i on number

! ProdCode = ! Product i onNumber . subst r i ng(1, 2)





12.03:7

- - Get name of st eel el ement! Name = ! I t emRef . Name

- - Test f or unset name - Fi r st char act er wi l l be ' ='

i f ( ! Name. subst r i ng( 1, 1) eq ' =' ) t hen! Resul t . Passed = f al se! Resul t . Messages. append( ! I t emRef . Type & ' not named ' )r et ur n ! Resul t

endi f

- - Test f or f i r st t wo l et t er s of Pr oducti on number = f i r st t wo l et t er s of namei f ( ! Name. subst r i ng( 2, 2) neq ! ProdCode ) t hen

! Resul t . Passed = f al se! Resul t . Messages. append( ! I t emRef . Type & ' name does not begi n wi t h ' & ! ProdCode

)endi f

- - Ret ur n Datar et ur n ! Resul t

endf unct i on

The following is a sample report generated by running the preceding panel name check:

Check Report Fi l e

Cr eat ed By : M. Barl ow

Dat e : 9 Oct 97

Checks Perf ormed

Cl ass : St eel wor k

Gr oup : Admi ni st r ati on

[ 1] Check Pr i mary St eel work Names

Summar y of Checks

El ement s passed al l t ests : 13

El ement s f ai l ed one or more t ests : 5

Tot al : 18

El ement s t hat have passed al l checks : 13

PA- C22001- P00002

PA- C22001- S00001

PA- C22001- P00003

PA- C22001- S00003

PA- C22001- S00004

PA- C22001- S00005

PA- C22001- S00006

PA- C22001- S00007

PA- C22001- S00008

PA- C22001- S00009

PA- C22001- P00005

PA- C22001- P00006

PA- C22001- P00007

El ement s t hat have f ai l ed one or more checks: 5



12.03:8



El ement : DEVTEST- C22001

Check Pr i mar y Steel work Names - FRMW name does not begi n wi t h PA

El ement : DEVTEST- C22001- P00001Check Pr i mar y Steel work Names - PANE name does not begi n wi t h PA

El ement : DEVTEST- C22001- S00002

Check Pr i mar y Steel work Names - SCTN name does not begi n wi t h PA

El ement : DEVTEST- C22001- P00004

Check Pr i mar y Steel work Names - PANE name does not begi n wi t h PA


Check Pr i mar y Steel wor k Names - PANE not named

End of Check Report Fi l e




Modifying and Deleting Check Functions

12.04:1

4 Modifying and Deleting Check Functions

If any of the information in the des-checks.pmldat configuration file is changed, or if a check

is deleted by removing its entry from the file, it will be necessary for the checks to be

reloaded on each active or saved user Checker utility form by using the Control > ReloadChecks option.

The Check functions themselves can be modified by simply editing the Check function PML

file. If the Check function is moved to another location, it will not be found until users restart

PDMS, or the PML REHASH command is used to tell PDMS to rebuild its table of currently

available PML functions.



12.04:2


Modifying and Deleting Check Functions




Checker Objects

12.05:1

5 Checker Objects

A ChkReturn object is returned from a Check function to the Checker utility to tell the utility

whether the element has passed or failed the test.

If the check has passed, the .Passed member will be set to TRUE and the array of text

string messages is initialised as empty.

If the check has failed, the .Passed member will be set to FALSE and the array of text string

messages should contain at least one entry.

- - Def i ne obj ectdef i ne obj ect CHKRETURN

- - Message Ar r aymember . Messages i s ARRAY- - Passed=TRUE Fai l ed=Fal semember . Passed i s BOOLEAN

endobj ect- - End of obj ect def i ni t i on

The Check object is the object created in the des-checks.pmldat file to configure the

Checker utility. It is also passed to the Check function as its second argument.

- - Def i ne obj ectdef i ne obj ect CHECK

- - Check Name ( uni que)member . Name i s STRI NG- - Check Cl assmember . Cl ass i s STRI NG- - Cl ass Check Typemember . Gr oup i s STRI NG- - Check Descr i pt i onmember . Ti t l e i s STRI NG- - Check Funct i on Namemember . Funct i on i s STRI NG- - Per mi ssi bl e El ement t ypesmember . Types i s STRI NG- - Sel ect i on rul emember . Rul e i s STRI NG

- - Successf ul acti on



12.05:2


Checker Objects

member . Passed i s STRI NG- - Fai l ed act i on ( i f none r et ur ned f r om check)member . Fai l ed i s STRI NG

- - Modul e check i s avai l abl e f or mmember . Modul e i s STRI NG- - Fi l e t ype ( who/ wher e check i s l oaded f r om)member . Fi l eType i s STRI NG

endobj ect- - End



Index

12.0Index page i


A

Add menu . . . . . . . . . . . . . . . . . . . . . . . . 2:2

C

Check files

Directories . . . . . . . . . . . . . . . . . . . . 3:1

Check functions

Reloading . . . . . . . . . . . . . . . . . . . . . 2:5Check Items list

Adding/removing entries . . . . . . . . . . 2:2

Check object . . . . . . . . . . . . . . . . . . 3:2, 5:1

Check.Class object member . . . . . . . . . . 3:2

Check.Function object member . . . . . . . 3:3

Check.Group object member . . . . . . . . . 3:2

Check.Module object member . . . . . . . . 3:3

Check.Rule object member . . . . . . . . . . . 3:2

Check.Title object member . . . . . . . . . . . 3:2

Check.Types object member . . . . . . . . . 3:2

Checker form . . . . . . . . . . . . . . . . . . . . . 2:1

Checker Results form

. . . . . . . . . . . . . . . 2:3Failed list . . . . . . . . . . . . . . . . . . . . . 2:4

Passed list . . . . . . . . . . . . . . . . . . . . 2:4

Checks

Selecting . . . . . . . . . . . . . . . . . . . . . . 2:3

ChkReturn object . . . . . . . . . . . . . . 3:3, 5:1

Class

Selecting . . . . . . . . . . . . . . . . . . . . . . 2:3

com-checks.pmldat files . . . . . . . . . . . . . 3:1

Configuration files . . . . . . . . . . . . . . 3:1, 4:1

D

des-checks.pmldat files . . . . . . . . . . 3:1, 4:1

F

Failed list . . . . . . . . . . . . . . . . . . . . . . . . 2:4

G

Group

Selecting . . . . . . . . . . . . . . . . . . . . . 2:3

H

Highlight menu . . . . . . . . . . . . . . . . . . . . 2:3

P

Passed list . . . . . . . . . . . . . . . . . . . . . . . 2:4

PDMSDFLTS directory . . . . . . . . . . . . . . 3:1

PDMSUSER directory . . . . . . . . . . . . . . 3:1

Project defaults directory . . . . . . . . . . . . 3:1

R

Remove menu . . . . . . . . . . . . . . . . . . . . 2:2

Results

Reloading . . . . . . . . . . . . . . . . . . . . . 2:4

Saving . . . . . . . . . . . . . . . . . . . . . . . 2:4

Viewing . . . . . . . . . . . . . . . . . . . . . . 2:4




Data CheckeData Checker Utility User Guider Utility User Guide

Documents