CONFIG_VALIDATIONS

CONFIG_VALIDATIONS is a configuration package used to define and manage validation rules. It allows you to define commit message validations and enable or disable SQL mapping analysis features.

Commit message validation allows you to enforce formatting rules, such as requiring a ticket number or specific prefix, through regular expressions. Each rule includes a validation pattern, message, and mode of enforcement.

See also:

CONFIG_ISSUE_TRACK_SYSTEM - Configure linking to issue tracking system tickets.

Usage

To manage validation rules, open the CONFIG_VALIDATIONS package and navigate to the Validations tab. From there, you can add, modify, or remove validation rules as needed. Refer to the examples provided for guidance.

Alternatively, you can edit the package directly by using Show Editor, or by exporting the JSON file, editing it externally, and re-importing it into Designer. See the Contents section below for reference.

After saving changes, the CONFIG_VALIDATIONS package will contain uncommitted changes. To maintain change history, it is recommended to commit the package after editing.

Key	Value type	Example	Description
validationId	String	87259b16-28be-11eb-ad54-2bb3624824bb	The unique identifier of the validation. Can be generated with online tools, such as UUID Generator.
validationName	String	COMMIT_MESSAGE_EACH_LINE_STARTS_WITH	The unique name of the validation.
description	String	Commit message validation that checks if each new line of it starts with JIRA-.	Description of the validation. Provides additional context or details about the purpose and behavior of the validation rule.
validationRule	String	(?s)(JIRA-)(.)*	Validation rule – Defines the logic applied during the validation process to determine whether the object under validation meets the required criteria. For commit message validations, this rule is a regular expression.
validationMessage	String	Each line of commit message must start with JIRA	If the validation fails, the validation message is used to describe the reason for the failure, typically for end-user guidance. For example, the message can be displayed in the UI below a form field to explain why the input is invalid.
validationMode	String	ERROR	Specifies the validation mode. Supported values are: `ERROR` - Enforces a strict rule. If the validation fails, e.g. the commit is blocked until the message meets the requirement. `WARNING` - Displays a warning if the validation fails, but still allows the action to proceed. Useful for encouraging best practices without interrupting workflow. `INFO` - Can be used to provide guidance or suggestions without enforcing any restrictions. `NONE` - The validation rule is ignored during processing. This mode is useful for storing validation examples or temporarily disabling validations without removing them.
validationType	String	COMMIT_MESSAGE	Specifies the validation type. Supported types: `COMMIT_MESSAGE` – Applies the regular expression (defined in `validationRule`) to the entire commit message as a single string. `COMMIT_MESSAGE_LINE` – Applies the regular expression to each line (or paragraph) of the commit message individually. `SQL_MISSING_MAPPINGS_ANALYSIS` – Enables or disables validation that checks for missing entity mappings in SQL logic. This validation is applied globally and does not use a regular expression. `SQL_UNREFERRED_MAPPINGS_ANALYSIS` – Enables or disables validation that checks for unused entity mappings in TRANSFORM_PERSIST or TRANSFORM_SQL_VIEW load types. Like the above, this is a toggle without a regex pattern.

Example: Validation configuration

JSON

"validations": [
    ...
    {
      "validationId": "0bfc9682-28bf-11eb-ad6f-fb56de3fff2a",
      "validationName": "COMMIT_MESSAGE_STARTS_WITH_FULL_TICKET_NUMBER",
      "description": "Example of commit message validation that checks if it starts with JIRA- and a ticket number (sequence of digits)",
      "validationRule": "(?s)(JIRA-\\\\d{1,})(.)*",
      "validationMessage": "Commit message must start with JIRA- and a ticket number consisting of at least 1 digit",
      "validationMode": "ERROR",
      "validationType": "COMMIT_MESSAGE"
    },
    ...
]