Slack DM Notifications

Overview

This document outlines how to configure and manage step-by-step notifications sent via Slack Direct Messages (DM) to Workflow requesters, approvers, and executors in QueryPie, as well as the types of notifications available.

Prerequisites

Before configuring these settings in QueryPie, ensure the following prerequisites are met:

• Slack App Creation: A Slack App must be prepared. To create an app, please contact QueryPie Customer Portal or reach out through an official partner.

• Email Address Matching: The email address registered in QueryPie must match the email address registered in Slack.

  • Notifications will not be received correctly if the email addresses do not match.

• Network Configuration: Ensure that network settings allow Slack to receive notifications sent from QueryPie. Adjust network settings if necessary.

Note

If QueryPie is installed in an internal network where ACL settings are challenging, you may need to set up a Proxy server. If you're using Okta, refer to the document titled [Internal Network] Forward Slack DM Workflow Results for detailed setup instructions.

Setting Up Slack DM

To use Slack Direct Message (DM) notifications, you need to enable the relevant settings in the Workflow Configuration.

Enabling Slack DM Notifications

Toggle Workflow Notifications via Slack Direct Message option to activate Slack DM notifications for Workflow.

• Decide whether to send Slack DM notifications to users designated as approvers.

• When you enable the toggle, the Bot User OAuth Token field will appear. Enter the Bot User OAuth Token from the Slack App you want to integrate, then save the settings.

• If you disable the toggle, the field will be hidden. (If you re-enable it before saving, the previously entered token will be retained.)

The Slack App's Bot User OAuth Token can be found under the ‘OAuth & Permissions’ section in the app management menu.

Enabling Request Approval/Rejection on Slack

Toggle Allow users to Approve or Reject on Slack option to allow users to approve or reject requests directly within Slack.

• When enabled, the Slack DMs will include Approve and Reject buttons.

  • Users can easily process requests by clicking the buttons and providing a reason if required.

Types of Slack DM Notifications

For a standard workflow with a pre-approval status, four types of notifications are dispatched according to progress:

1. Approval request notifications

2. Decline notifications

3. Approval completion notifications to the requester

4. Execution available notifications

In the scenario of post-approval (Urgent Mode), the following four types of notifications are sent:

1. Approval request notifications

2. Execution available notifications

3. Approval completion notifications to the requester

4. Urgent Mode unauthorized notifications

Approval Request Notifications

QueryPie supports all five types of workflows (SQL Request, SQL Export Request, DB Access Request, Server Access Request, Access Role Request).

Approval request notifications are triggered immediately that the first-level approver receives a notification upon the creation of a draft. Upon completion of the first level approval, the second level approver is notified, followed by the third-level approver upon completion of the second-level approval.

In cases where multiple approvers exist at each level, notifications are dispatched to all of them. Additionally, if any of the approvers have approval delegation set up, proxy approvers will also receive notifications. For detailed instructions on setting up approval delegation, refer to Using Delegated Approval section on Approval Add-ons.

Depending on your QueryPie admin's configurations, approvers receiving the notification may also approve or reject directly within Slack. Please refer to the section Setting Up Slack DM above for the required settings. Even in the absence of an action button, a Details button is consistently provided. Clicking on it launches a web browser, prompting the QueryPie login window to appear. Upon successful login, users are directed to the Workflow details page.

For post-approval (Urgent Mode) drafts, a corresponding message is displayed. In such instances, only the Approve button is visible, even if the Action button is utilized.

Decline Notifications

Decline notifications are applicable to all five types of workflows: SQL Request, SQL Export Request, DB Access Request, Server Access Request, and Access Role Request. In the event of a draft being rejected by any approver, a notification is promptly dispatched to the requester. The notification includes a comment detailing the reason for the rejection.

While no separate action button is provided, a Details button is available. Clicking on it launches a web browser, presenting the QueryPie login window. Upon successful login, users are directed to the Workflow details page.

For post-approval (Urgent Mode) drafts, rejection cases are not applicable, thus no rejection message is sent.

Approval Completion Notifications to the Requester

This notification feature is applicable to all five types of workflows: SQL Request, SQL Export Request, DB Access Request, Server Access Request, and Access Role Request. A notification is dispatched to the requester upon the finalization of approval.

While no separate action button is provided, a Details button is available. Clicking on it launches a web browser, presenting the QueryPie login window. Upon successful login, users are directed to the Workflow details page.

Even in cases where the draft is in Urgent Mode, the requester will receive a notification once all post-approvals have been completed.

Execution Available Notifications

This notification feature applies to workflows that support two types: SQL Request and SQL Export Request, both of which include an 'Execute' action.

Upon finalizing authorization, a notification is dispatched to the designated executor.

While it does not contain a separate action button, a Details button is provided. Clicking on it launches a web browser, presenting the QueryPie login window. After successful login, users are directed to the Workflow details page, from which SQL Requests and SQL Export Requests can be executed.

In cases where the draft is in Urgent Mode, the executor receives a notification immediately upon submission of the draft.

Urgent Mode Unauthorized Notifications

This notification feature applies to two types of workflows: SQL Request and SQL Export Request.

It serves to alert users when a draft that has been escalated to Urgent Mode remains unapproved for more than one day. Sent out once every morning, it targets approvers at that stage for all drafts older than a day.

If there are multiple approvers at each level, the message is distributed to all of them. Additionally, if any of the approvers have set up proxy approvals, the notification extends to their proxy approvers as well. For guidance on configuring proxy approvals, refer to Using Delegated Approval section on Approval Add-ons.

A separate message is dispatched for each unapproved draft. Therefore, if there are multiple unapproved drafts, multiple notifications will be generated. These messages are sent out at 10 am every morning, without distinction between business days and holidays.