DataRuleEvaluationManager

Versions

1.0.0

v1.0.0

Basic Information

Class Name: DataRuleEvaluationManager

Title: Data Rule Evaluation Manager

Version: 1.0.0

Author: Drew Shea

Organization: OneStream

Creation Date: 2025-02-27

Default Routine Memory Capacity: 2.0 GB

Description

Short Description

The Data Rule Evaluation Manager.

Long Description

The Data Rule Evaluation Manager is used to evaluate any data rules against a data monitor scan. The Data Rule Evaluation Manager can evaluate a single data rule, a group of data rules, or multiple data rules at once.

Use Cases

1. Evaluate Data Rules.

The Data Rule Evaluation Manager can evaluate a single data rule, a group of data rules, or multiple data rules at once. Data rules can be part of a group in which a user can simply evaluate all data rules in that given group at once. When data rules are evaluated, they are ran against a data monitor scan and the results returned encompass all the instances in which the data rule was violated. The evaluation of data rules can be used to identify inconsistencies/trends in the data monitor scans. This can be especially useful for identifying data quality issues.

Routine Methods

1. Aggregate Datarule Evaluations (Method)

Method: aggregate_datarule_evaluations
- Type: Method
- Memory Capacity: 2.0 GB
- Allow In-Memory Execution: No
- Read Only: No
- Method Limits: N/A
- Outputs Dynamic Artifacts: No
- Short Description:
  - Aggregates data rule evaluations into a single table in a bunch of different ways.
- Detailed Description:
  - Aggregates data rule evaluations into a single table based on prior IDs, data rules and/or data rule groups.
- Inputs:
  - No input parameters
- Artifacts: No artifacts are returned by this method

2. Run Datarule Evaluation (Method)

Method: run_datarule_evaluation
- Type: Method
- Memory Capacity: 2.0 GB
- Allow In-Memory Execution: Yes
- Read Only: Yes
- Method Limits: N/A
- Outputs Dynamic Artifacts: No
- Short Description:
  - Evaluates a data rule.
- Detailed Description:
  - Evaluates a single data rule and returns the evaluation result in a tabular format. This method will run the data rule against a data monitor scan.
- Inputs:
  - Required Input
    - Data Rule Group: Select the data rule group to index into.
      - Name: datarule_group
      - Tooltip:
        
        Validation Constraints:
        
        This input may be subject to other validation constraints at runtime.
      - Type: str
    - Data Rule: Specify the data rule to run the evaluation on.
      - Name: datarule_id
      - Tooltip:
        
        Validation Constraints:
        
        This input may be subject to other validation constraints at runtime.
      - Type: str
- Artifacts:
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: evaluation_tables
    - Aggregate Artifact: True
    - In-Memory Json Accessible: False
    - File Annotations:
      - artifacts_/@evaluation_tables/data_
        
        Folder containing inner artifacts
    - Nested Artifacts: This collection includes Index-based collection of Artifacts
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: N/A

3. Run Datarule Group Evaluation (Method)

Method: run_datarule_group_evaluation
- Type: Method
- Memory Capacity: 2.0 GB
- Allow In-Memory Execution: Yes
- Read Only: Yes
- Method Limits: N/A
- Outputs Dynamic Artifacts: No
- Short Description:
  - Evaluates a group of data rules.
- Detailed Description:
  - Evaluates data rules collected as a group and returns the evaluation result in a tabular format. This method will run each data rule in the group against a data monitor scan.
- Inputs:
  - Required Input
    - Data Rule Group: Select the data rule group to index into.
      - Name: datarule_group
      - Tooltip:
        
        Validation Constraints:
        
        This input may be subject to other validation constraints at runtime.
      - Type: str
- Artifacts:
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: evaluation_tables
    - Aggregate Artifact: True
    - In-Memory Json Accessible: False
    - File Annotations:
      - artifacts_/@evaluation_tables/data_
        
        Folder containing inner artifacts
    - Nested Artifacts: This collection includes Index-based collection of Artifacts
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: N/A

4. Run Datarules Evaluation (Method)

Method: run_datarules_evaluation
- Type: Method
- Memory Capacity: 2.0 GB
- Allow In-Memory Execution: Yes
- Read Only: Yes
- Method Limits: N/A
- Outputs Dynamic Artifacts: No
- Short Description:
  - Evaluates data rules.
- Detailed Description:
  - Evaluates multiple data rules and returns the evaluation result in a tabular format. This method will run each data rule against a data monitor scan.
- Inputs:
  - Required Input
    - Data Rule Group: Select the data rule group to index into.
      - Name: datarule_group
      - Tooltip:
        
        Validation Constraints:
        
        This input may be subject to other validation constraints at runtime.
      - Type: str
    - Data Rule: Specify the data rules to run the evaluation on.
      - Name: datarule_ids
      - Tooltip:
        
        Validation Constraints:
        
        This input may be subject to other validation constraints at runtime.
      - Type: list[str]
- Artifacts:
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: evaluation_tables
    - Aggregate Artifact: True
    - In-Memory Json Accessible: False
    - File Annotations:
      - artifacts_/@evaluation_tables/data_
        
        Folder containing inner artifacts
    - Nested Artifacts: This collection includes Index-based collection of Artifacts
  - Evaluation Table Result: The table result that is outputted from an evaluation.
    - Qualified Key Annotation: N/A

Interface Definitions

No interface definitions found for this routine

Developer Docs

Routine Typename: DataRuleEvaluationManager

Method Name	Artifact Keys
`aggregate_datarule_evaluations`	N/A
`run_datarule_evaluation`	evaluation_tables
`run_datarule_group_evaluation`	evaluation_tables
`run_datarules_evaluation`	evaluation_tables

Versions​

v1.0.0​

Basic Information​

Tags​

Description​

Short Description​

Long Description​

Use Cases​

1. Evaluate Data Rules.​

Routine Methods​

1. Aggregate Datarule Evaluations (Method)​

2. Run Datarule Evaluation (Method)​

3. Run Datarule Group Evaluation (Method)​

4. Run Datarules Evaluation (Method)​

Interface Definitions​

Developer Docs​