Configure Analysis Validation

About the Analysis Validation

When you calculate an RBI Criticality Analysis, it validates the fields in the analysis and verifies if all the fields required for calculation contain valid values. If any of the fields required for calculation are blank or contain invalid values, the calculation fails, and appropriate error messages appear in the Analysis Calculation window. You can now configure these validations based on your requirements. If you use the flexible validations, it overrides the baseline validations. The following image illustrates the flexible analysis validation framework:



Workflow

This topic describes the sequence of the tasks that you must perform to configure the flexible analysis validation. Based on the complexity of the configuration, you may need to perform certain tasks outside of the Risk Based Inspection module. When performing such tasks, we recommend that you follow the documentation of the respective modules.

The following image illustrates the workflow to configure the flexible analysis validation:



Note: If you want to use additional fields for validations which are not part of baseline, you can add the additional fields to the RBI Criticality Analysis family. You must configure the family before creating the analysis validation policy. For more information on creating family fields, refer to the Family Management documentation.

Create an Analysis Validation Policy

About This Task

As part of the flexible validation configuration, to configure new validations, you must create a policy to define the validation rules. After you create the analysis validation policy, you must configure the policy in the Flexible Calculation Validation section in RBI 580 Flexible Calculation Preferences. If you use the analysis validation policy, all the baseline analysis validations are overridden.

This topic describes the basic steps on creating an analysis validation policy. For more information on creating, managing, and activating policies, refer to the Policy Designer documentation.

Procedure

  1. Create a policy.
  2. Access the Design workspace of the policy.
  3. Add an Entity node that represents the RBI Criticality Analysis family. For information on Entity nodes, refer to the Entity Nodes in Policy Designer topic.
  4. As needed, add other nodes required for validation. For information on the different types of nodes, refer to the Condition, Logic, and Calculation Nodes in Policies section in the Policy Designer documentation.
  5. For each validation, add a Return Value node that has the error message that you want to display to the user when validating the policy. For information on Return Value node, refer to the Return Value Nodes in Policy Designer topic.
    Note: Each Return Value node must have a unique name and the error messages must not contain more than 255 characters.
  6. Save the policy.
    The analysis validation policy is created.

Create Flexible Analysis Validation Configuration

If you want to override the baseline analysis validation logic, you must create a flexible analysis validation record in the RBI 580 Flexible Calculation Preferences section. For more information on creating a flexible analysis validation record, refer to the Create a Flexible Calculation Configuration topic.

Before You Begin

Before creating a flexible analysis validation configuration, make sure that a policy is created for the flexible validations.

Procedure

Create a flexible validation record with the following configuration:
Master section:
  • Analysis Family: RBI Criticality Analysis
  • Action: Analysis Validation
  • Action Family: Select the family that you want to use for the flexible analysis validation.
  • Policy Name: Select the policy that must be used for the validation.
  • Sequence: 1
Detail section:
  • Input Entity Family: Select the family defined in Input Entity of the analysis validation policy.
  • Policy Node Name: Enter the name of the input Entity node defined in the analysis validation policy.
The flexible analysis validation configuration record is created.

Configure Analysis Validation - Example

About This Task

Suppose you want to create a new analysis validation to validate the following fields:
  • Design Pressure: This is a required field and the value must not be less than 0.
  • Design Temperature: This is a required field and the value must not be less than 0.

Procedure

  1. Create a validation policy to perform the validations on fields. For detailed steps on creating the validation policy, refer to the Create Sample Validation Policy topic.
  2. Create an analysis validation record in the RBI Application Settings with the following settings:
    • Analysis Family: RBI Criticality Analysis
    • Action: Analysis Validation
    • Action Family: RBI Criticality Analysis
    • Policy Name: Select the validation policy created in step 1.

    For more information on validation configuration, refer to the Create Flexible Analysis Validation Configuration topic.

    The flexible analysis validation record is now configured. Now, when you calculate an RBI Criticality Analysis, the following events will occur:
    • The baseline analysis validations will be overridden.
    • The validation policy will be triggered. If the input fields contain null values or invalid values, the calculation will fail, displaying an appropriate validation error message.
    • If there is no validation error, the calculation will be executed.

Create a Sample Analysis Validation Policy

About This Task

This task explains the basic steps that you need to perform to configure validations as part of the example. For detailed information on creating and configuring a policy, refer to the Policy Designer documentation.

Procedure

  1. Create a Policy with the name Configured Analysis Validation Policy.
  2. Configure an Entity node to represent the RBI Criticality Analysis family.
  3. Configure an Is Null node and map the value in the Design Pressure field of the RBI Criticality Analysis family.
  4. Set the output value of the Is Null node to -1.


  5. Map the output of the Is Null node to the input of the Equal node.
  6. Configure the Equal node such that:
    • If the value in the Design Pressure field is null, a Return Value node is triggered to display an error message indicating that Design Pressure is a required field.


    • If the value in the Design Pressure field is not null, the output is mapped to the Less Than node.


  7. Configure the Less Than node such that if the value in the Design Pressure field is less than zero, a Return Value node displays an error message indicating that the value must not be less than zero.


  8. Repeat steps 3 through 7 for the Design Temperature field.
  9. Save the policy.
    The validation policy is created.