Notification Procedures

You are looking at an older version of the documentation. The latest version is found here.

The Data Virtuality Server can send you notifications by email or via Slack. In this page, we describe the procedures and the syntax; for more general information on how the notifications work, please refer to the dedicated page.

SYSADMIN.enableJobEmailNotification

This procedure enables email notifications for the given job(s).

SQL

SYSADMIN.enableJobEmailNotification(IN jobIds string NOT NULL, IN jobStatuses string NOT NULL, IN recipients string NOT NULL, IN subjectTemplate string, IN messageTemplate string, OUT id biginteger NOT NULL RESULT)

It takes the following parameters:

Parameter	Description
`jobIds`	IDs of the jobs for which the notification is being enabled
`jobStatuses`	Statuses of the jobs for which the notification is being enabled
`recipients`	Email addresses to which the notification will be sent
`subjectTemplate`	Custom template to apply to the notification. If set to null, default setting will be used
`messageTemplate`	Custom template to apply to the message. If set to null, default setting will be used

Example

SQL

SELECT * FROM (CALL SYSADMIN.enableJobEmailNotification(jobIds => '*', jobStatuses => 'FAILED, success', recipients => 'myemail@datavirtuality.de', subjectTemplate => 'DV Report - local subject', messageTemplate => 'DV Report - Local message - description: %description%')) a;;

SYSADMIN.disableJobEmailNotification

This procedure, correspondingly, disables email notifications for the given job(s).

SQL

SYSADMIN.disableJobEmailNotification(IN jobIds string NOT NULL, OUT id biginteger NOT NULL RESULT)

SYSADMIN.enableJobSlackNotification

This procedure enables Slack notifications for the given job(s).

SQL

SYSADMIN.enableJobSlackNotification(IN jobIds string NOT NULL, IN jobStatuses string NOT NULL, IN webHookURL string, IN message string, IN excludedJobs string, IN isFormattedSlackMessage boolean, OUT id biginteger NOT NULL RESULT)

SYSADMIN.deleteSlackNotification

This procedure deletes Slack notifications for the given job(s).

SQL

SYSADMIN.deleteSlackNotification(IN jobIds string NOT NULL, OUT id biginteger NOT NULL RESULT)

SYSADMIN.disableJobSlackNotification

This procedure disables Slack notifications for the given job(s).

SQL

SYSADMIN.disableJobSlackNotification(IN jobIds string NOT NULL, OUT id biginteger NOT NULL RESULT)

SYSADMIN.sendSlackNotification

This procedure sends a Slack notification for the given job(s).

SQL

SYSADMIN.sendSlackNotification(IN message string NOT NULL, IN webHookURL string, IN isFormattedSlackMessage boolean)