Getting Started

To allow promotion to work you need to have 2 Secure Reporter systems.

Once you have both setup then configure them so that they know of each others presence.

Configuration

Test host.

A Secure Reporter where reports are tested and reviewed. Ordinary users will not have access to this host.

Production host

A Secure Reporter that is used by ordinary users to access production data.

Share cluster names

Setup connections on each host so that cluster names are shared. Use test or development databases on your Test Host and production databases on your production server.

The databases do not have to be of the same type. For instance they can be Postgres or SQLite in test and MySQL in production.

All that matters is the cluster names.

In production configure multiple databases in a cluster to allow connection balancing. Whereas in test you can use just the one database.

Create production access token

Use the admin / access tokens page in your production system to create a token for use by the test system. Give the token the admin or, better still, the editor group.

Environment Variables

Configuration is by environment variables that override the defaults. Use these values in the test host to setup your target promotion host.

Name Description Example / default
PROMOTION_TOKEN_NAME Name of the token on the promotion host promotion-key
PROMOTION_TOKEN_KEY Value of the token on the promotion host 45439809383490348
PROMOTION_HOST Server address of the promotion host https://secure-reporter-production.company.com
PROMOTION_APPROVERS CSV list of reviewers emails rob@bob.com,sue@bob.com

Promotion Approvers

Any user in the admin group can approve reviews. Add additional reviewers by putting them in the PROMOTION_APPROVERS list. Each reviewer must be in the editor or admin group.

Review process

Open the report you want to request promotion for. Click on the Request review button. Fill in the message box with appropriate notes to the reviewer. Click on Submit Request Review to submit the review to the reviewers. Reviewers will receive an email requesting for them to review. A reviewer can login to Secure Reporter and try out the report. Any active review will be available in the Admin / Reports page. When the report is ready the reviewer then clicks on Approve Review