Promote

Package Group Approval Process

 

Watch the video.

Promote contains a code approval process for package groups that can be turned on and off, depending on whether or not an approval is required as part of the project’s business requirement. This process restricts a user from transporting data unless it is approved by a designated approver. Some projects may want an approval step for defects. By default, the approval process is disabled.

To set up and run the approval process:

  1. Enable Approval Mode

  2. Add Approvers

  3. Users: Submit a Package Group for Approval

    Or

    Approvers: Approve or Reject a Package Group

  4. Archive a Request

  5. View Approval History

Enable Approval Mode

The transport approval process can be turned on and off.

To enable approval mode:

  1. Select Configuration > Parameters in the Navigation pane.

  2. Click the Approval Mode check box to enable it.

Add Approvers

All approvers are notified with in-app messaging and by an email that a package has been submitted for approval. These users use Promote to review the comparison results and the changes in the queue to determine if the package is ready to be transported.

The list of approvers is controlled by security in System Administration. To add an approver, add a user to the Promote Approver security role. Refer to Set Up Security for Promote for more information.

To view the list of approvers in Promote, select Configuration > Approvers in the Navigation pane.

Submit a Package Group for Approval

If approval mode is enabled, a package group cannot be transported unless it is approved.

To submit a package group for approval:

  1. Compare Code Across Environments

  2. Select Packages in the Navigation pane.

  3. Click the Request Approval icon for a package group; approvers are notified with an in-app message and an email that there is a request to be approved.

Users are not notified if their request was approved or rejected. They must work with the approver or check the Approval Status in the Package Groups - Approval page for an update.

If the package group was approved, transport the packages.

If it was rejected, work with the Approver, fix the package group and re-submit for approval.

Approve or Reject a Package Group Request

When a package group is sent for approval, all Approvers are notified with an in-app message and an email that a package is ready for approval.

When reviewing a package group:

  • Gather change / defect management number

  • View queued data

  • Test the package in a development environment

  • Gather any approval documentation such as test results or supporting emails

To approve a package group request:

  1. Click the in-app message.

    Or

    Click the link in the approval email.

    Or

    Select Approval in the Navigation pane; all packages sent for approval display.

  1. Click the View Package icon to review the content.

  2. Return to the Package Groups - Approval page.

  3. Click Edit for the package.

    View the page description for the Package Groups - Approval page

  1. Enter the corresponding tracking number in the NOTES text box.

  2. Click the TESTING COMPLETED IN DEV check box to enable it, confirming the package group has been successfully tested in a development environment.

  3. Click Save.

NOTE: Optionally, click the Approval Documentation icon to add any supporting documents, such as an email from the client or test results.

  1. Click the Approve Request icon; notify the user who initiated the request that the request has been approved.

NOTE: The request may take several iterations of changes and approvals before all the content is ready to be transported.

To reject a package group:

  1. Select Approval in the Navigation pane; all packages sent for approval display.

  2. Click the View Package icon to review the content.

  3. Click Edit for the package.

    View the page description for the Package Groups - Approval page

  4. Enter a reason for why the package is being rejected in the REJECT NOTES text box.

  5. Click Save.

  1. Click the Reject Request icon; notify the user who initiated the request that the request has been rejected.

NOTE: By rejecting the request, users have the opportunity to fix errors and resubmit for approval. Do not mark the package group request as completed until the package group has been approved.

Archive a Request

Once the request is complete, it can be archived, which moves the approval request to the Package Groups - Approval (History) page for the package.

To archive a request:

  1. Select Approval in the Navigation pane.

  2. Click the Mark Completed icon for an approval request.

View Approval History

Once an approver marks an approval request as Completed, it displays on the Package Groups - Approval (History) page to be referenced later, if need be.

To view the approval history for a package group:

  1. Select Packages on the Navigation pane.

  2. Click the Approval History icon; all completed request approvals for the package group display.

  3. Click the Data or the Objects icon to view exactly what data and SQL objects were approved for transport.