Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt

Use this file to discover all available pages before exploring further.

After completing this topic, you can create a reusable review checklist that makes every new Run easier to review.
New to Detect and Review? Read the Overview to understand how Rules, Reports, Annotations, and Campaigns work together before proceeding.

​
When to use this workflow

Every time you generate a Report without a template, you manually select which Rules to evaluate. For a one-off review this process is fine, but for a recurring test scenario, hardware configuration, or standard review process, it becomes repetitive and error-prone. A Report Template solves this by saving a named group of Rules. When you generate a Report, you select the template instead of individual Rules and Sift evaluates all the Rules in the template automatically. Use this workflow when:
  • You review the same type of Run repeatedly and always apply the same set of Rules.
  • You want your team to apply a consistent set of checks without remembering which Rules to include.
  • You are building a standard review process across a program or hardware configuration.

​
Before you begin

​
Complete the workflow

​
Step 1: Create the template

  1. In Sift, click the Report Templates tab.
  2. Click New Report Template.
  3. In Untitled Report Template, enter a name that describes the review scenario; for example, Motor qualification checklist or Thermal system review.
  4. Optional: In the Report Template tags list, select tags to make the template easier to find.
  5. Optional: In Report Template description, describe what this template checks and when to use it.

​
Step 2: Add Rules to the template

  1. Click Add Rules.
  2. In the Rules table, select each Rule you want to include.
  3. Click Confirm selection.
  4. Click Save new Report Template.
The template is now available to anyone in your workspace when generating a Report.

​
Step 3: Apply the template when generating a Report

  1. In Sift, click the Runs tab.
  2. In the Runs table, click the Run you want to review.
  3. Click Create report.
  4. Click the Report Template tab.
  5. Click the template you want to apply.
  6. Click Evaluate.
Sift evaluates all Rules in the template against the Run and opens the Report.

​
When to create a new version of a template

Report Templates are not automatically versioned the way Rules are, so keep a consistent naming or tagging convention when your review requirements change. Create a new template (or update the existing one) when:
  • New Rules have been added to your workspace that belong in the standard checklist.
  • A hardware revision changes which channels or thresholds are relevant.
  • A Rule in the template has been archived or replaced with a newer version.
When you rerun an existing Report, Sift uses the same Rule versions that were originally evaluated; it does not pick up template changes automatically. To evaluate with updated Rules or a revised template, generate a new Report on the Run instead.

​
Verify the result

After creating the template:
  • It appears in the Report Templates tab.
  • When generating a Report, the template appears in the Report Template tab and applies all its Rules in one step.

​
Next steps

​
Reference