Skip to content

Safely Updating Inspections

When modifying an existing Inspection, it is important to ensure that updates do not unintentionally disrupt production use. Use Inspection Revisions to test and iterate safely before releasing changes to users.

This article builds on concepts introduced in the guide on Using Developer Mode for Safe Changes.

Understanding Inspection Revisions

Each Revision represents a complete snapshot of an Inspection’s configuration, including its Tests and Scripts. The Revisions section of each Inspection's edit page displays all saved Revisions, along with buttons to Edit or Run the specific Revision.

The Published Revision is the active version presented to operators when they run the Inspection from their list. Any changes made to other Revisions will not affect users until that Revision is published.

An image showing the revisions of an Inspection

Creating a New Revision

To modify an existing Inspection safely, first create a new Revision:

  1. Edit an existing Revision.
  2. Click Actions, then select the Save New Revision action. An image showing the Inspection Designer with the save new revision action highlighted
  3. Enter a Revision Name and a Note describing the purpose of the changes. Notes are used to keep track of why changes were made. Make sure to enter a descriptive note of the changes being made.
  4. Click Confirm. This creates the new Revision and opens it for editing. An image showing the note overlay of the inspection designer
  5. Make any desired changes, using the Save action as normal.

Tip

The name of the Revision currently being edited is displayed under the Inspection's name in the designer.

Publishing the Revision

After completing and testing updates in the new Revision:

  1. Return to the edit page of the Inspection.
  2. Set the Published Revision to the name of the new Revision.
  3. Click Save.

Once published, the selected Revision becomes the active version and will be used by all data entry operators.

An image showing the Published Revision of an Inspection

See Also