Configuration

Checker

Checker : Configuration

Although the Checker utility is used to supply standard data checking facilities in AVEVA E3D™, its main purpose is to allow project specific 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 and user checking functions separate, they are configured in separate configuration files.

Use the Data checker Configuration window to add a new check function.

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 Data Checker Configuration window by selecting Control > Reload checks.

Use the Files functionality to choose existing pmldat files by selecting from the drop-down list. com-checks-pmlda, displayed as the default, is the file supplied by AVEVA containing common checks. The file is stored in aveva_design_dflts.

Additional checks for design should be created in des-checks.pmldat. Multiple des-checks.pmldat files can exist, their path will be shown next to the filename in square brackets.

All checks from com-checks.pmldat and one or more des-checks.pmldat that are available in the current module are combined and displayed in the Design Checker window.

Discipline

A Discipline (also referred to as a Class) may contain multiple Groups. To rename a Class, select it from the drop-down list, click in the field and edit the text. Click Apply to commit the changes.

To create a new Class, click Create a new class.


	Create a new class

Note:

A Class must contain at least one Group and at least one Check.

Enter a Name, Description and Function for the new class and click Apply.

Groups

A Group may contain multiple Checks. To rename a Group, select it from the drop-down list, click in the field and edit the text.

To create a new Group, click Create a new group.


	Create a new group

Note:

A group must contain at least one Check.

Enter a Name, Description and Function for the new group and click Apply.

Edit selected group

Types

Enter the type of elements to be checked, separated by spaces, for example, NOZZ ELBO.

Note:

The field can be left blank, but must be the same for all checks in the same group.

Rule

Expression to filter elements on, must be valid expression, for example, type of owner eq |PIPE|.

Note:

The field can left blank, but must be the same for all checks in the same group.

Module

Module(s) in which check can be run in, must be separated by spaces, for example, MODEL Spool Paragon. In com-checks.pmldat any valid module can be entered. In des-checks.pmldat the module must be MODEL.

Note:

Must be the same for all checks in the same group.

Checks

Checks displays a list of checks in currently selected group, selecting a check allows it to be edited.


	Create a New check	creates a new check in the selected Group.
	Copy selected check	creates a copy of the selected check in the same Group.
	Delete selected check	deletes the selected check.

Edit selected check


Name	Enter the name of the check which must be in upper case with no spaces (for example: CONNCHECK)
Description	Enter a description of the check. The description will be displayed in the Design Checker window.
Function	PML check function (for example:. !!connectioncheck) The function must be written as defined in the manual.

Edit Rule Data

Where Rule Data has been set up in an APPLDW for a specific check Edit Rule Data becomes active and displays the Edit Rule Data window.

Clicking Apply writes the changes made to file. Apply is only active when a change is made into one of the text gadgets, when creating a new check, or when renaming a class/group. Clicking Cancel closes the Data Checker Configuration window.

The standard AVEVA-supplied checks for AVEVA E3D™ 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 AVEVA E3D™ module; in this release, the utility is available from MODEL only.)

Note:

The standard AVEVA-supplied checks are available for download on the AVEVA Support website, also refer to Standard AVEVA Supplied Checks.

Configure Rules

If required the rule data for a check can be imported or exported to Excel and the list of rule data can be viewed. Rule data rows can be appended, inserted or removed. From the Edit Rule Data window, right click on the grid displayed in the Edit Rule window.


Append Row	Adds a row at the bottom of the grid.
Insert Row	Inserts a row above the currently selected row in the grid.
Remove Selected (Rows)	Removes row(s) by multi--selection from the grid.
Save to Excel	Save rule data from an Excel file.
Import from Excel	Import rule data to an Excel file.
Print Preview	Preview the list of rule data for print.

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

•

The AVEVA_DESIGN_DFLTS directory holds company-wide checks, which are available to all projects.

•

The ABCDFLTS directory (where ABC is the project name) holds checks specific to one project.

•

The AVEVA_DESIGN_USER directory holds checks specific to a single user.

Entries in all des-checks.pmldat files available will be combined together on the Checker window.

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. It does 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, FRMW and SBFR elements must start with the first two letters of a UDA :PRODNO, which is set at ZONE level.


-- Data file for Design Checker Utility
--	Comment lines begin --
--Checks for panel zero length edges, backtracks, and <3 vertices
!Check = object CHECK()	Declaration of new check entry
!Check.Name = 'LOOPCHECK'	Name of check function
!Check.Title = 'Check Panel Boundary'	Title appears in Check selection box
!Check.Class = 'Steelwork'	Add this check function to this class
!Check.Group = 'Panels'	Add this check function to this group
!Check.Types = 'PANE'	Type of element to be checked
!Check.Rule = ''	Rule for filtering selected element types (none)
!Check.Function = '!!EdgeCheck'	Name of Check Function
!Check.Module = 'Design'	AVEVA E3D™ module using this function
!Check.FileType = '$1'	Mandatory line for checker utility
!!AddCheckerCheck(!Check)	Adds this check to the list of checks
--
-- Check that primary steel element names begin with the first two letters of the Production Number in :PRODNO UDA on ZONE
!Check = object CHECK()	Declaration of new check entry
!Check.Name = 'STRUCTNAME'	Check name
!Check.Title = 'Check Steelwork Names’	Title appears in Check selection box
!Check.Class = 'Steelwork'	Class
!Check.Group = 'Administration'	Group
!Check.Types = 'PANE SCTN FRMW SBFR'	List of element types to check
!Check.Rule = 'FUNC OF ZONE eq \|PS\|'	Selection filter
!Check.Function = '!!PSNameCheck'	Name of Check Function
!Check.Module = 'Design'	Used in MODEL
!Check.FileType = '$1'	Mandatory Line
!!AddCheckerCheck(!Check)	Add to the list of Checks

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

!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.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 file psnamecheck.pml.

!Check.Module is set to the AVEVA E3D™ 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.