Review Settings / Types
NOTE: Any user with an email account (no matter their access level) can perform a review and sign off a procedure. This means "Viewers," "Operators," "Editors," and "Admins" can review, leave comments, and even sign off their approval.
When putting a procedure into Review, select one of the configured Review Types.
Admins are able to add or edit the Review Types in Settings. Check out this article for more information: Setting Review Types / Multi-Stage Review
Use the + signs to add additional reviewers before selecting Move to Review.
In the case of Multi-Stage Review, each review stage will be listed on separate lines.
Reviewers can be added using standard "AND" and "OR" logic.
Click to see more
Click to see more
Each new block represents a signature. Signatures for review can be gathered by Operator role (anyone with that operator role can signoff) or User (a user's email will be used and that specific user must signoff).
Operator roles and user emails are both represented in the same drop down menu.
In the example below, the procedure will need to be signed off by someone with the AVI role AND someone with either the OP1 role OR the ACS role.
Click the x next to the role or user to remove them as a reviewer.
Hover over the signoff block and click the x that appears to remove that signoff block.
Click Move to Review to lock in reviewer selections.
Each new block represents a signature. Signatures for review can be gathered by Operator role (anyone with that operator role can signoff) or User (a user's email will be used and that specific user must signoff).
Operator roles and user emails are both represented in the same drop down menu.
In the example below, the procedure will need to be signed off by someone with the AVI role AND someone with either the OP1 role OR the ACS role.
Click the x next to the role or user to remove them as a reviewer.
Hover over the signoff block and click the x that appears to remove that signoff block.
Click Move to Review to lock in reviewer selections.
Click Move to Review to save the selected reviewers and enter Review Mode.
Multi-Stage Review
Procedure Review can be configured to allow for a Multi-Stage flow.
Only Admins are able to add or edit Review Types and Stages.
See Setting Review Types / Multi-Stage Review for more information.
When all review blocks in one stage have been approved, that stage will be locked and the review will move on to the next review stage.
When the stage is locked, reviewers can not be added or removed, except in the last stage before the procedure is Released.
To add or edit reviewers, click Edit to re-enter Edit mode and then select Review again. You will only be able to edit on the active review stage or later. Previous review stages are locked.
If Edits are made to the draft version of the procedure mid-review, approvals will only clear on the active review stage and only if the box is check to "Clear approvals if additional changes are made" in the Review Types section in Settings:
Approvals made in previous/locked stages will not be cleared even if the box is checked in Settings. For more information, see Setting Review Types / Multi-Stage Review.
Revoke / Remove Review Approval
Approvals that have been made in review can be revoked if they are in the active stage, and the user has the permissions / roles required to sign off on the block.
To revoke approval, click on the 3 dot menu in the approval block and select revoke approval, which becomes visible after the approval is made.
In the example above, the approval can be revoke by any user with either the AVI role or the ACO role. Once the Review moves to the to next "QA" stage then the approvals in the Eng stage are not able to be revoked.
If an approval was made that you do not permissions to revoke, the 3 dot menu will not be visible in the sign off block.
Sign off permissions are only restricted by username and/or Operator Roles. Admins are NOT able to revoke and/or approve blocks unless they have the username or Operator Role Required.
Release Notes
Release notes are typically used by the procedure owner, however some users have made use of this field for collecting their thoughts on the procedure update as a whole.
Review Comments
TIP
During a review, there are multiple fields where the operator can input comments for the procedure owner.
Click COMMENT on any Header or Step that needs work before it will be ready for approval.
You must post you comment in order for it to be saved.
Review comments are viewable in the Edit page so the owner is able to view and incorporate suggestions directly without flipping back and forth from Review to Edit.
Click Reply on a posted comment to start a comment thread.
Replies are now available in Edit and Review mode and during a run!
Resolve/Unresolve functionality will work based on the main or parent comment and all child comments in the same thread will Resolve/Unresolve with the parent.
Once the comment has been reviewed, the procedure owner can Resolve the comment and the action will be timestamped.
Mentions in Comments
Type @ to trigger a dropdown list of teammates in a comment.
Select the user you would like to notify. When the comment is posted, the mentioned user will receive an email to review the comment.
Mentions can be used in threads or in separate comments.
Version Diff View
Any changes that need to be reviewed will be outline in red. For more information, check out our article Procedure Review Diffs!
Review comments can be viewed, created, resolved and unresolved in this view, Run-Preview view, or in Edit Mode.
Run-Preview View
Reviewers are able to simulate a run of the procedure in Review Mode without persisting any data.
Review comments can be viewed, created, resolved and unresolved in this view, Version Diff view, or in Edit Mode.
Flowchart View
Reviewers are able to see the big picture of the procedure with diagrams of how sections and steps are both organized and connected.
Different line types indicate Conditional Flow, Default Flow, and Dependency.
You can prevent the Release of procedures with unresolved actions
You can prevent the Release of procedures with unresolved actions
Click the Settings icon in the left navigation pane.
In the General section, enable the toggle that says "Release will be disabled if there are any unresolved actions."
This will also require the Suggested Edits to be resolved before release, which is done in EDIT mode of the procedure. See the Suggested Edits article for more details.