CygNet Measurement > FMS Explorer > Admin Menu > Managing Validation Engines > Configuring Validation Rules

Configuring Validation Rules

Validation rules are the elements that comprise validation engines. When creating a new validation engine or editing an existing validation engine, you have the opportunity to define the properties, details, and schedules pertaining to each of its component validation rules. Use the following procedure to add or edit rules for a validation engine.

Creating or Editing a Validation Rule

Within a selected validation engine, add or edit validation rules as follows.

To Create or Edit a Validation Rule

  1. Select a validation rule to configure. (Once the rule is created/selected, the procedure is similar.) Do one of the following to select a rule.
  1. Create a new rule in a new engine.
  1. On the list of Validation Engines, click Add to access the Create New Validation Engine dialog box.
  2. On the Create New Validation Engine dialog box, define the engine and assignment. Enter a Name for the new engine. Click to select/clear the Enabled check box. Select the Node to which the validation engine will be assigned.
  3. Click Add to create a new rule. The new rule will appear in the rule list, initially populated with default settings.
  1. Create a new rule in an existing (or copied) engine.
  1. On the list of Validation Engines, click to select an existing engine and then click Edit to access the Validation Engine Properties dialog box.
  2. Click Add to create a new rule. The new rule will appear in the rule list, initially populated with default settings.
  1. Edit an existing rule in an existing (or copied) engine.
  1. On the list of Validation Engines, click to select an existing engine and then click Edit to access the Validation Engine Properties dialog box. It will contain a list of validation rules belonging to the selected engine.
  2. Click to select an existing rule.
  1. Configure or edit the rule properties. Click the desired column within the rule row to select the property to edit. See Validation Rule Properties for more information.
  1. Type in or edit the Rule Name. Initially, each new Rule Name will automatically adjust to match the name of the rule type selection, but you can edit the rule name to best suit your purposes.
  2. Use the drop-down menus provided to select or edit the Rule Category, Rule Type, and Severity settings.
  3. Use the drop-down menu provided to select or edit the Schedule setting. See Validation Rule Schedules for more information.
  1. Configure or edit the rule details. In the Rule details section below the list box, configuration details appear for the rule you have selected. Verify your rule selection by reading the rule type and description listed (on the left), and then configure or edit the required details associated with the rule (on the right). See Validation Rule Details for more information.
  2. Repeat steps 1 - 3 for each desired rule belonging to the validation engine.
  3. Click Create to save a new validation engine, or OK to save changes to an existing validation engine.
  4. The Save FMS Record dialog box will appear. Configure the date and audit information requested to historize the changes in your system. See Save FMS Record for more information.

Validation Rule Properties

The properties for the Rule list section of the dialog box are described below.

Property Description
[Rule list]

Rule Name

Lists the rule name for each rule belonging to the currently selected validation engine. Names initially default to the name of the rule type selected, but can be edited to better suit your usage. Click the cell to type in a new name.

Valid characters for names are as follows.

A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

Rule Category

Lists the rule category for each rule belonging to the selected validation engine. Click to access the drop-down menu to select a category to apply to the rule.

Possible rule categories are as follows.

  • Device
  • Configuration Data
  • Gas Analysis Data
  • Gas Metering History
  • Gas Quality History
  • Historical Data
  • Station

Note: When you change the Rule Category, the corresponding Rule Name and Rule Type options will also change, to default values you can edit.

See FMS Validation Rules for a complete list of all the rule categories and types provided in the measurement system.

Rule Type

Lists the rule type for each rule belonging to the selected validation engine. Click to access the drop-down menu to select the rule type desired.

Rule type options displayed in the drop-down menu depend on the rule category selected. The rule type you select determines the configurable properties displayed in the Rule details section.

Note: When you change the Rule Type, the corresponding Rule Name will also change, to a default value you can edit.

See FMS Validation Rules for a complete list of all the rule categories and types provided in the measurement system.

Severity

Lists the severity level assigned to each rule. Click to access the drop-down menu to select a severity level to associate with the rule.

The severity level selected will be assigned to the exception generated when the validation rule fails. Options include Low, Medium and High. Severity is displayed on the Exceptions Control and is provided as a mechanism to help you organize exceptions hierarchically.

Schedule

Lists the schedule applied to each rule. Click to access the drop-down menu to select a schedule to apply to the rule.

Additional schedules can be configured via the Schedules button. See Validation Rule Schedules for more information.

Add

Click to add a new rule to the validation engine. A new rule will appear in the list, populated with default values. Configure the rule properties and details as desired.

Delete

Click to delete a selected rule from the validation engine.

Details

Click to access the Record Details dialog box to view details about changes made to the selected rule.

Note: Only applies to rules that have already been saved.

See Viewing Record Details for more information.

Schedules

Click to access the Manage Schedules dialog box to configure schedule details for activation of the selected rule.

See Validation Rule Schedules for more information.

Validation Rule Details

The properties for the Rule Details section of the dialog box are described below.

Property Description

Type

Displays the rule type of the currently selected validation rule (read-only).

See FMS Validation Rules for a complete list of all the types of validation rules provided in the measurement system.

Description

Displays the description of the currently selected validation rule (read-only).

See FMS Validation Rules for a complete list of all the validation rules, and their descriptions, provided in the measurement system.

Data quality

This parameter will appear on the right side of the Rule details section below the rule list. For the currently selected validation rule (except Configuration Data rules), select a data quality level from the drop-down menu.

The data quality selected will be assigned to a record if it fails the validation rule. If a record fails multiple validation rules, it will be assigned the data quality with the lowest configured influence (of the rules it failed).

The options in the Data quality drop-down menu are listed in order of influence, from highest to lowest. Options are populated by the settings saved in your system. These data quality settings are configured by users with proper security access, via the Options button on the Admin menu. See Configuring Data Quality Settings for more information.

Note: Since a failed configuration record does not affect data quality, the data quality parameter is not available for validation rules belonging to the Configuration Data category.

[additional configuration parameters]

These parameters will appear on the right side of the Rule details section below the rule list. Depending on the type of rule selected, different configuration parameters are required. Configure the required parameters for the currently selected validation rule.

For most rules that require configuration you must specify the Units, and an upper and lower bound such as a high/low value, a +/- value for the tolerance, or a limit value. See FMS Validation Rules for a complete list of all validation rules provided in the measurement system, and their configuration options.

Back to top

Validation Rule Schedules

Use the Schedules button to access the Manage Schedules dialog box to configure schedule details to assign to validation rules.

Manage Schedules

The Always Active schedule exists by default, and is automatically assigned to any rule, unless changed. It cannot be deleted from the schedule list. Additional schedules can be created and/or deleted (until used) as needed. Once saved, new schedules will appear on the drop-down menu of Schedule options available when configuring the validation engine rules.

The properties for the Manage Schedules dialog box are described below.

Property Description
[Schedule list]

Name

Lists the names of the schedules saved in your system. Saved schedule names appear in the Schedule drop-down menu as options for assignment to validation rules when creating/editing validation engines.

Valid characters for names are as follows.

A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

Add

Click Add to create a new schedule on the list. The default name will be <New Schedule> until the new name is entered.

Delete

Click Delete to remove a schedule from the list.

Note:

Only schedules that are not in use by any validation rules can be deleted.

If you try to delete a schedule that is already saved and assigned, you will be informed with a message that it can't be deleted.

If you try to delete a schedule that is saved but not yet assigned, you will be prompted to confirm the deletion.

Details

Click Details to access the Record Details dialog box to view details about changes made to the selected schedule.

Note: This option only applies after the associated validation engine has been saved.

Schedule details

Days

Click to select/clear the check box(es) next to the day(s) of the week this rule will be active.

Date range

Use the drop-down menus to indicate the month/day time window during which this rule will be active.

Begin

Select a begin month and date for the active range.

End

Select an end month and date for the active range.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.