Skip to main content
Skip table of contents

Workflow

Overview

QueryPie supports a Workflow feature that allows users to request and approve various tasks requiring authorization. This integrated environment lets you conveniently manage requests, approvals, and executions without leaving QueryPie.

Entry Points for the Workflow Menu

QueryPie offers two paths to access the Workflow menu:

스크린샷 2024-07-25 오후 2.54.23.png

Top Menu > General > Workflow

스크린샷 2024-07-25 오후 2.54.41.png

My Dashboard > Workflow Requests

Roles within the Workflow

Depending on the actions performed within the Workflow, users can assume the following roles:

  • Requester: Can send requests.

  • Approver: Can review, approve, or reject requests.

  • Executor: Can execute approved SQL Requests and Export Requests.

  • Reviewer: Can review or reference requests.

Approvers and Executors for requests are pre-set by the administrator through Approval Rules.

Submit Request

Click the Submit Request button in the Workflow menu and select the desired request type to move to the request creation page. Detailed instructions for each request type are available on the linked pages.

  • DB Access Request : Request access permissions for DB connections, granted immediately upon approval.

  • SQL Request : Request approval to execute SQL, executable once upon approval.

  • SQL Export Request : Request to export data, downloadable once upon approval.

  • Unmasking Request : Request unmasking to view original data, accessible for the approved duration upon approval.

  • Server Access Request : Request access permissions for server connections, granted immediately upon approval.

  • Access Role Request : Request access role permissions for servers or Kubernetes targets, granted immediately upon approval.

Sent Requests

Requests you submit as a Requester appear under the Sent Requests sub-menu.

  • In Progress : Requests that are still pending approval. Any request with either Approval Status or Execution Status marked as Pending or In Progress appears here.

  • Done : Requests that have been fully approved or executed, or those canceled by the requester.

Received Requests

Requests assigned to you as an Approver are listed under the Received Requests sub-menu. If designated as a delegated approver, requests not yet approved by the original approver are also displayed here. For more details on delegated approvals, refer to the Approval Add-ons documentation.

  1. Check the requests needing approval under Received Requests > To Do.

  2. Click on a request to view details, then click Approve or Reject in the upper right corner.

image-20240801-062129.png

Workflow > Received Requests > To Do > List Details

Q: Can I approve only some of the requested DB connections?

A: Yes, for DB Access Requests, partial approvals are possible. Uncheck the boxes for the connections you do not wish to approve, then click Approve. Unchecked connections will be automatically rejected.

  1. Enter the approval or rejection reason in the Comments popup and click OK to complete the process.

  2. You can review completed requests under Workflow > Received Requests > Done.

Executions

Requests assigned to you as an Executor are listed under the Executions sub-menu, categorized into To Do and Done. The request types requiring execution are SQL Requests and SQL Export Requests.

Executing an SQL Request

스크린샷 2024-07-25 오전 9.48.50.png

Workflow > Executions > To Do > List Details

  1. Navigate to the Workflow > Executions > To Do menu.

  2. Click on the pending SQL Request to view its details.

  3. Click Execute to run the query or Cancel to abort.

  4. When you click the Execute button, a query execution confirmation popup will appear.

  5. Review the notes, then click Execute to finalize the query execution.

  6. The results (success or failure) are shown under the Results tab in the details page.

  7. You can review your execution history under Workflow > Received Requests > Done.

Q: Does QueryPie maintain query execution in the background for large queries?

A: Yes, if a query executed via SQL Request is large, it will continue running in the QueryPie server background even if the web browser is closed. Reconnect to QueryPie to check the execution status on the SQL Request details page. This background execution feature is supported from QueryPie version 9.15.0 and above.

Executing an SQL Export Request

스크린샷 2024-07-25 오전 10.47.19.png

Workflow > Executions > To Do

  1. Navigate to the User > Workflow > Executions > To Do menu.

  2. Click on the pending Export Request to view its details.

  3. Review the details, then click Execute to run the export or Cancel to abort.

  4. In the Export Option popup, set the export options:

    • File Type: Select the file format from SQL (default), CSV, JSON, or EXCEL.

    • Export Option: Choose additional export options.

      • DROP TABLE syntax: Apply DROP TABLE syntax.

      • Contain Data: Include data in the export.

      • New INSERT Statement every N Rows: Specify the number of rows per INSERT statement.

  5. Once the options are set, click Export in the modal to finalize the export.

  6. After the export is complete, the results can be viewed under the Results tab in the details page.

  7. You can review the completed export request history under Workflow > Executions > Done.

Reviews

Requests assigned to you as a Reviewer, with completed approvals or executions, are listed under Reviews > All Reviews. The review status is displayed as Unread or Confirmed. For details on handling unread requests, refer to the Approval Add-ons documentation.

The Review menu appears only if enabled by the administrator.

Request Status List

The status of requests is categorized as follows:

Approval Status

Execution Status

Review Status

  • Pending: Waiting for approval

  • In Progress: Approval in process

  • Approved: Approved

  • Canceled: Canceled by requester

  • Rejected: Rejected by approver

  • Expired: Approval request expired

  • Pending: Waiting for execution

  • Executing: In progress

  • Success: Execution successful

  • Failure: Execution failed

  • Canceled: Canceled by requester

  • Expired: Execution period expired

  • Unread: Waiting for review

  • Confirmed: Review completed

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.