Skip to main content

Review a Procedure

Overview of a procedure draft Review process before Release.

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

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.

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!

Procedure review comments now provide a clearer way to track what happened to each piece of feedback throughout a review. Comments can be Accepted, Rejected, or Deferred until the next review cycle, and comments created during multi-stage reviews are automatically tagged with the review stage in which they were added.

The Comments side panel also includes search, filtering, grouping, and sorting tools so reviewers and procedure authors can quickly find and acknowledge feedback without losing review context.

Accept, Reject, or Defer Review Comments

Each review comment includes a disposition control that lets the review team record how the feedback should be handled.

A review comment beneath a procedure step with Reply, Accept, and a dropdown containing Reject and Defer options.

Use the comment actions to record one of three outcomes:

  • Accept marks the comment as Accepted for the current review.

  • Reject records that the comment was reviewed but not incorporated.

  • Defer postpones the comment until the next revision or review cycle.

The same disposition controls are available from the Comments side panel, allowing comments to be reviewed and acknowledged from a consolidated list instead of navigating back to each individual step.

Comments side panel showing the Accept dropdown with Reject and Defer options.

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.

Review Comments Sidebar

Open the Comments panel from the comment icon in the procedure header to review comments across the procedure in one place.

The panel displays the commenter, timestamp, comment text, available replies and actions, and any status or context associated with the comment.

Comments side panel with search, status, grouping, sorting, resolved comments, and an open review comment with an Accept action.

Search comments

Use the Search comments field at the top of the panel to locate comments by text without manually scanning the full review history. Search can be used together with the available filters and grouping options to narrow a large set of review feedback.

Filter comments by status

Select Status to filter the panel by review comment disposition. The filter lists the available statuses and shows the number of comments currently in each category: Open, Accepted, Rejected, and Deferred. Select one or more statuses to focus the panel on the comments that still need action or on comments with a particular review outcome.

Status filter in the Comments side panel with Open, Accepted, Rejected, and Deferred options and comment counts.

Group comments

Select Group to organize comments into meaningful sections. Comments can be left ungrouped or grouped by Review stage, Status, or User. Grouping is especially useful for multi-stage reviews or when several reviewers are working through a large number of comments.

Group menu in the Comments side panel with None, Review stage, Status, and User options.

Disposition status is shown on the comment along with the time stamp and user. Click undo to modify the disposition action.

Use the sort control to review comments in chronological order. Select Oldest First when you want to work through feedback in the order it was created.

@mentions are still supported in the side bar.

Review-Stage and Comment Context Tags

In a multi-stage review, each new review comment is automatically tagged with the review stage in which it was created. Stage tags such as Stage 1 and Stage 2 keep feedback tied to its original review context, making it easier to distinguish comments from different approval phases and to group comments by review stage in the side panel.

Two procedure review comments automatically labeled Stage 1 and Stage 2.

Comments can also display context badges such as Author or Reviewer next to the commenter and timestamp. These badges make the commenter’s relationship to the review immediately visible when multiple people are collaborating on the same procedure.

Configure Review Notifications


Review notifications are configured from Settings > Notifications. Expand Runs/Procedures to find the review-specific notification events.

Notifications settings under Runs/Procedures showing Procedure Review Comment and Procedure Review Complete events with In-App, Email, Realtime Client, and Slack delivery options.

Two events are available for the procedure review workflow:

  • Procedure Review Comment notifies users when a new review comment is added.

  • Procedure Review Complete notifies users when the procedure review is complete.

For each event, enable the delivery methods that should be used. Review notifications can be delivered through In-App notifications, Email, Realtime Client, or Slack. For Slack, notifications can be sent by DM or to a selected Channel; enable Channel and choose the desired destination when channel delivery is needed.

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 can navigate large, complex procedures more easily with the Flowchart view. The flowchart draws cleaner, more vertical and horizontal lines instead of crowded curves, making it easier to read. Clicking a step or section jumps straight to it, and clicking a line highlights it so it's easy to follow through the diagram.

A search bar jumps to a specific step or section without needing to scroll to find it. By default, the flowchart collapses to show only the steps and sections involved in dependencies and conditionals, keeping the view focused. It can be expanded to show everything, or collapsed down to just sections and opened individually.

The flowchart can also be exported as a PNG, generated at a large, detailed size suitable for printing.

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.

Queue Multiple Drafts for Review/Editing

Users can use the “Queue for Review” action in the procedures list to create a queue of procedure drafts. The queue will automatically navigate the user to the next procedure draft in the queue after the current procedure draft has been released or deleted.

From the Procedure Library, select one or more procedures that have a draft version created. Once selected, the Queue for Review button will appear.

If any of the selections do not have a draft version created, the Queue for Review button will be greyed out.

Did this answer your question?