Skip to content

/AWS1/CL_DBRRULE

Represents a single data quality requirement that should be validated in the scope of this dataset.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/DBRRULENAME /AWS1/DBRRULENAME

The name of the rule.

iv_checkexpression TYPE /AWS1/DBREXPRESSION /AWS1/DBREXPRESSION

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

Optional arguments:

iv_disabled TYPE /AWS1/DBRDISABLED /AWS1/DBRDISABLED

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

it_substitutionmap TYPE /AWS1/CL_DBRVALUESMAP_W=>TT_VALUESMAP TT_VALUESMAP

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".

io_threshold TYPE REF TO /AWS1/CL_DBRTHRESHOLD /AWS1/CL_DBRTHRESHOLD

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

it_columnselectors TYPE /AWS1/CL_DBRCOLUMNSELECTOR=>TT_COLUMNSELECTORLIST TT_COLUMNSELECTORLIST

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.


Queryable Attributes

Name

The name of the rule.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Disabled

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

Accessible with the following methods

Method Description
GET_DISABLED() Getter for DISABLED

CheckExpression

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

Accessible with the following methods

Method Description
GET_CHECKEXPRESSION() Getter for CHECKEXPRESSION, with configurable default
ASK_CHECKEXPRESSION() Getter for CHECKEXPRESSION w/ exceptions if field has no val
HAS_CHECKEXPRESSION() Determine if CHECKEXPRESSION has a value

SubstitutionMap

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".

Accessible with the following methods

Method Description
GET_SUBSTITUTIONMAP() Getter for SUBSTITUTIONMAP, with configurable default
ASK_SUBSTITUTIONMAP() Getter for SUBSTITUTIONMAP w/ exceptions if field has no val
HAS_SUBSTITUTIONMAP() Determine if SUBSTITUTIONMAP has a value

Threshold

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

Accessible with the following methods

Method Description
GET_THRESHOLD() Getter for THRESHOLD

ColumnSelectors

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

Accessible with the following methods

Method Description
GET_COLUMNSELECTORS() Getter for COLUMNSELECTORS, with configurable default
ASK_COLUMNSELECTORS() Getter for COLUMNSELECTORS w/ exceptions if field has no val
HAS_COLUMNSELECTORS() Determine if COLUMNSELECTORS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_RULELIST

TYPES TT_RULELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_DBRRULE WITH DEFAULT KEY
.