PDM Rule Library Registry

Custom validation and substitution rules can be defined for data flowing from the PDM to your Essential database. Rules are applied when specific conditions outlined by the rule are met during the PDM PI process of mapping tags to parameters. Once a rule is defined and compiled, typically by your system administration group, it is registered using the Rule Library form. Registered rules can be assigned on the Parameter Tag Mapping form. A rule name, assembly name, and class name are required for rule registration.

To allow rules to be applied differently for each tag that is mapped to a parameter, associate one or more properties with a registered rule on the Rule Property form. Access the Rule Property form via the Rule Properties section on the Rule Library form or the Rule Library Properties link in the Navigation Tree.

For each rule name and rule description, equivalent entries in different languages can be specified. When localization has been implemented, the Culture setting assigned to a user determines which values are displayed in field lists on Essential forms. Enter the corresponding names/descriptions and associate each one with the appropriate language in the Add Language Dependent Rule Name and Description section.

Language-dependent rule property names and descriptions can also be entered when accessing the Rule Property form via the Rule Library Properties link in the Navigation Tree.

System administrators should refer to the Process Data Manager Rule Development Guidelines document for additional information. See Default PDM Rules for a description of the rules shipped with Essential.

For instruction on registering rules, click the following links or use the scroll bar to scan the page.

To register rules

1. Click Data Entry > Rules Configuration > Rule Library in the Navigation Tree.
   
   The Rule Library list appears.

2. Click New.
   
   The Rule Library form is displayed.

3. Enter a Rule Name and Description to identify the rule for tag-to-parameter mapping.

4. Identify the rule as Active by clicking the check box.

5. Enter an Assembly Name and Class Name.
   
   The Assembly Name is the name of the DLL without the extension. The Class Name must include the namespace and class name.

6. Expand the Register Rule section, and specify the Assembly File location, and click Register Assembly when applicable. The Browse button is available to select the location.

7. Enter Rule Properties and/or language dependent values when applicable.

8. Click Save.

9. Repeat steps 2 through 8 to register additional rules.

To add rule properties

1. Use one of the following methods to access the Rule Property form for a specific rule:

1. • Open the Rule Library form for the rule and click the Add Property link in the Rule Properties section.

   • Click Data Entry > Rules Configuration > Rule Library Properties in the Navigation Tree, click the New button,and select a Rule from the list.

2. Enter a Property Name to identify the property.

3. Enter the Class Property Name. This is the actual name of the property of the rule class in the assembly.

4. Select the property Type that represents the data type when the rule is applied during the tag-to-parameter mapping process. Options are None (only tag data allowed), String, Integer, Float, and DateTime.

5. Select the Allow Parameter check box to permit the selection of a parameter as the property source.

6. Enter a Description of the property.

7. Click Save.
   
   The property information is displayed as a line item in the Rule Properties section on the Rule Library form and in the Rule Library Properties list. On the Rule Library form, edits can be made using the buttons adjacent to the line item.

8. Add language-dependent property names and descriptions when applicable.

To add language-dependent rule property names and descriptions

1. Click Data Entry > Rules Configuration > Rule Library Properties in the Navigation Tree.
   
   The Rule Library Properties list is displayed.

2. Locate the property and click one of the links to open the Rule Property form.

3. Click Add Language Value in the Language Values section.

4. Select a Language from the list.

5. Enter the Property Name and Description for the language selected.

6. Click Save.
   
   The translation information is displayed as a line item in the Language Values section. Edit existing translation information using the buttons adjacent to the line item.

7. Repeat steps 3 through 6 to add other language translations.

8. Click the Save button on the form.

To add language-dependent rule names and descriptions

1. Open the Rule Library form for the rule and click the Add Language Value link in the Add Language Dependent Rule Name and Description section.

2. Select a Language from the list.

3. Enter the Rule Name and Description for the language selected.

4. Click Save.
   
   The translation information is displayed as a line item in the Add Language Dependent Rule Name and Description section. Edit existing translation information using the buttons adjacent to the line item.

5. Click the Add Language Value link and repeat steps 2 through 4 to add other language translations.

6. Click the Save button on the form.