Rules Templates

Prev Next

Rules Templates enable you to manage a single Rule across multiple queues efficiently. Instead of creating and maintaining the same rule in each queue separately, you can define it once as a template and distribute it wherever needed.

Overview

A Rules Template contains all the components of a standard Rule (condition and actions), plus additional features for multi-queue management:

  • Queue context selection: Choose a queue for testing and validation

  • Distribution management: Control which queues receive the template and track their synchronization status

Templates are stored centrally, outside of individual queues, making it easy to maintain consistency across your document processing workflows.

Key benefits

  • Centralized management: Update rules across all queues from a single location

  • Consistency: Ensure identical rule behavior across multiple queues

  • Flexibility: Choose which queues to update while maintaining visibility of local modifications

  • Time savings: Deploy rules to new queues instantly without recreation

How to create a Rules Template

Step 1: Create a new template

  1. Navigate to Settings > Rules Templates in your workspace

  2. Click Add rule template

  3. Optional: Use the AI assistant by describing your rule in natural language (this will also pre-select a queue for testing context)

  4. Or skip the dialog to configure manually

Step 2: Select queue for testing

Since templates exist outside of queues, you must select a queue to provide context for:

  • Field validation (ensuring referenced fields exist)

  • AI copilot functionality

  • Testing your template configuration

This selection appears at the top of the template configuration page.

Step 3: Configure the template

Templates include the same configuration options as regular Rules:

Identification

  • Label: Short, descriptive name

  • Description: Detailed explanation of the template's purpose

When (Condition)

  • Define conditions using TxScript

  • Use the AI Edit condition feature with natural language

  • The selected test queue provides context for field references

Then (Actions)

  • Add one or more actions to execute

  • Configure action-specific settings

  • Enable/disable actions as needed

Step 4: Test your template

Use the Test rule section to validate your template against real documents from the selected test queue.

Managing template distribution

The Template distribution section at the bottom of the page provides comprehensive control over your distributed rules.

Distribution features

Queue list

View all queues where the template is distributed, with Differences status indicators:

  • To be published: Template assigned but not yet published to this queue

  • Up to date: Queue's rule matches the template exactly

  • [Specific differences]: Lists which components differ (e.g., "Label" if only the label was modified locally)

Distribution controls

  • Distribution toggle: Select which queues to update when publishing

  • Delete: Remove the rule from specific queues using the trash icon

  • Publish: Deploy the current template version to all selected queues

  • Add queue: Select additional queues for template distribution

Publishing workflow

  1. Make your changes to the template

  2. Review the distribution list and toggle switches

  3. Click Publish

  4. If asked by “Unsaved changes” dialog, save the template first to ensure the latest version is distributed

  5. Click Publish again after saving

Managing local modifications

Templates maintain connections to distributed rules even when local changes exist:

  • Toggle off distribution to preserve local modifications

  • View exactly which components differ

  • Decide whether to overwrite or maintain queue-specific customizations

When you navigate to a specific queue's Rules list, you'll see all rules including those distributed via templates. You can edit template-distributed rules directly from the queue - the template connection remains intact. Any local modifications will be reflected in the Template Distribution section, showing exactly which components differ between the template and the queue's rule.

Best practices

  • Test thoroughly: Always validate templates in your test queue before publishing

  • Review before publishing: Check the distribution list to avoid unintended updates

  • Preserve customizations: Use distribution toggles to maintain queue-specific requirements

Common use cases

  • Standardized validation: Deploy consistent data validation rules across all queues

  • Company-wide policies: Implement universal business rules (e.g., approval thresholds)

  • Multi-region operations: Maintain identical processing rules across geographic queues

  • Phased rollouts: Test rules in specific queues before company-wide deployment

Requirements

  • Access to Rules Templates in Settings section (typically administrators and managers)

  • At least one queue selected for testing context

  • Valid rule configuration before publishing