...
Overview
Concepts: ReviewsApprovals, Roles and Permissions
If you've completed Lesson 3 - Transitions, you're probably stuck in the Review state of our workflow with no way out.
That's because as soon as you specify a different type of transition, the default transitions are removed. But
but why did the
submittransition in the Editing state work, yet theapprovedandrejectedtransitions in the Review state failed?
It's because the submit transition is very basic, and it automatically adds an option to transition to the target state.
Review transitions, however, are a bit more advanced – in addition to specifying the target states with the approved and rejected parameters, we also need to define the review (the approval) itself, and, optionally, who can take part in it.
...
Now would be a good time to try that. You can find out how in the Administrator administrator state override example.Note:
If you don't have administrator privileges in the space where you're testing the workflow, you can make yourself an administrator of the workflow by adding the adminusers parameter to the
...
...
...
Document activity report
If you use the admin state override, it will be logged in the Activity ReportDocument activity report. Most interactions with the workflow, or the content it applies to (including commenting), will be tracked in the Activity Report.
If you haven't already done so, take a look now. Open the Page Tools menu and choose Document Activity Report.
...
Once you're done, choose View Page at the top of the screen to return to your page.
| Info |
|---|
Some spaces may use Page Activity rather than Document Activity and will display the Page Activity Report. These spaces can be upgraded to use Document Activity. |
Adding a review
Now, let's fix our Review state. To do that we're going to need to add an {approval} macro inside the Review state:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{workflow:name=Simple Content Production Process}
{state:Editing|taskable=true|submit=Review}
{state}
{state:Review|taskable=true|approved=Published|rejected=Editing}
{approval:Technical Review}
{state}
{state:Published|final=true|taskable=true|updated=Editing}
{state}
{workflow} |
As you can see, we've added the
...
approval
...
macro, and given it a name, using its First Unnamed Parameter,
...
of Review.
More importantly, we've added Approve and Reject buttons, and it should be obvious what they will do.Note that, unlike
| Info |
|---|
Unlike the other macros we've seen so far, the |
...
|
...
macro can't contain other macros, because it has no Macro body. That's why it doesn't need a closing tag. |
Workflow builder can be used to add an approval to the Review state.
...
Once the approval is added, the Approved and Rejected transitions can be added to the state using the workflow builder Transitions editor for the Review state.
...
| Info |
|---|
The Approved and Rejected transitions are only available after an approval has been added to the state. |
Test it
Try testing your workflow again via the Workflow Popup.workflow popup.
The Editing state is configured with a submit transition. The only destination state available is the Review state.
...
You should now see Approve and Reject buttons in the Review state, and clicking them should work as expected.
...
Also, did you notice that the heading text in the workflow popup changed toTechnical Review? This is the name of our approval.
And what about the Published state?
...
Did you test that editing the page content will automatically take you back to the Editing state?
| Info |
|---|
The Published state in the example workflow is the workflow final state. When a workflow has a final state, all other states are considered as draft states in the workflow. This affects visibility of content in the a draft state for users with only Confluence view permission. These users are only able to view the page version at the time of the last transition into the final state, not the draft page content. If there has not yet been a transition to the final state, no page content is displayed. |