Requiring review
Review is set up per dashboard, by a user with Full access to its workbook. It can be set up before the dashboard is first published, too.- Open the dashboard in the dashboard builder.
- Click the arrow (▾) next to Publish and choose Review settings….
- Turn on Require review before publishing.
- Optionally, add default reviewers: search for users by name or email and pick them. Remove one with its ×.
- Click Save.
A dashboard that requires review is published only from its review. Publishing
it through the REST API, the Workbook
Agent or a workbook promotion is refused
with the message “This dashboard requires review before publishing”. The API
answers
400.Requesting a review
You need Can edit or Full access on the workbook to request a review.- Make your changes in the dashboard builder.
- Click Request review.
- Pick reviewers, or check the default reviewers the dialog lists. You can’t pick yourself, and Send request stays disabled until the request has at least one reviewer.
- Optionally, describe what changed under Message (optional).
- Click Send request.
Reviewers without access
A reviewer has to be able to view the dashboard. When you pick someone who can’t:- With Full access, the person’s row is marked Will get view access. When you send the request, or save the review settings, they get Can view on the workbook, through the same sharing you’d use in the Share dialog. If you cancel, nothing is shared. A reviewer who already has access keeps the level they have.
- With Can edit, the person’s row is greyed out and marked No access, with the hint Ask someone with full access to share this dashboard first.
The review page
Reviewers and anyone who can edit the workbook can open a review. While a review is open, they see a Review button in the header of the published dashboard that opens it. Other people who can only view the dashboard don’t see the button and can’t open the review. A review of a dashboard that was never published opens from the builder’s Review button or from its notification. Anyone who can edit the dashboard also sees an Edit button in the review page’s header. It opens the dashboard in the dashboard builder. The review page shows the revision’s frozen widgets the way the published dashboard would show them, with the review’s status:
The review panel is hidden when the page opens. Click Review in the page
header to show or hide it. It opens on the first of its two tabs:
- Activity lists the request, every new revision, comment, approval, change request and cancellation, in the order they happened. It covers this review and every earlier review of the dashboard since its last publish, such as a review that was cancelled. Entries look like those in the dashboard’s Comments panel: the author’s avatar, name and time on one line, then the entry’s tags, then its message. A tag names the entry’s revision: Revision 2 for this review, Earlier review · revision 1 for an earlier one. An approval or change request also carries an Approved or Changes requested tag.
- Changes lists the widgets the revision adds, updates and removes, and whether the layout moved, compared with the version that is published now. A chart whose report was edited counts as updated. On a dashboard that was never published, every widget is listed as added.
Commenting, approving and requesting changes
While a review is open, anyone who can open it can leave a comment in the review panel: type in the box that reads Leave a comment… and click its send button, or press Enter. Press Shift+Enter to add a new line. Reviewers also have Approve and Request changes under the box. Each posts the verdict with what you typed in the box, which is optional. The person who requested the review can’t approve or request changes on it. What you post appears at the end of the Activity tab: the panel switches to it, from Changes too, and scrolls to show your post. A reviewer can change their verdict: only each reviewer’s latest verdict counts. A reviewer who requested changes and later approves lifts their block. Review comments stay in reviews. They don’t appear in the dashboard’s Comments panel or its counts, and they work whether or not dashboard comments are turned on.Updating a review
When you edit the draft after requesting a review, the builder shows Draft and Request review again. Request review again to add the current draft to the same review as the next revision. It goes to the review’s reviewers, and the Activity tab shows Updated to revision 2. A dashboard has at most one open review. If nothing changed since the latest revision, Cube refuses a new request.Publishing
When the review is Approved, anyone who can edit the workbook can click Publish on the review page. While the draft matches the latest revision, the builder’s Publish button does the same. Publish stays greyed out until the review is approved. Publishing makes the approved revision the live version, exactly as reviewers saw it: the same widgets, layout and chart reports. Edits you made to the draft after the request stay in the draft. The dashboard keeps the workbook’s current title and description, so renaming the workbook during a review is not undone. The review becomes Published.Cancelling a review
The person who requested a review, or anyone with Full access to the workbook, can cancel it: choose Cancel review from the arrow (▾) next to the builder’s main button, or click Cancel review on the review page.Notifications
Everyone taking part in a review gets a notification when something happens on it: the requester, the reviewers and anyone who commented. The person who acted doesn’t get one. Notifications are sent when:- a review or a new revision is requested;
- someone comments;
- a reviewer approves;
- a reviewer requests changes;
- the review is published.