Skip to main content

Managing Prompt Rules

note

This page is only relevant to users with the Super Administrator role. See Roles & Permissions.

Prompt Rules are the building blocks behind Field Rules - the reusable, named instructions that Document Type editors can attach to a field (or to a document identifier) to steer how the platform extracts it. Defining rules here is what makes them available for selection elsewhere in the platform.

Viewing prompt rules

The Prompt Rules list, under Administration, shows every rule's label, type, description, and last-modified date.

Creating or editing a rule

Go to Prompt Rules → New Prompt Rule (or open an existing one) and set:

  • Rule Label - the short name shown when someone picks this rule from a Field Rules dropdown.
  • Description - a longer explanation of what the rule does, shown alongside the label where relevant.
  • Type - determines what kind of value a Document Type editor supplies when they attach this rule to a field:
    • Text Input (String) - a free-text value.
    • Number Input - a numeric value.
    • Toggle Switch (Boolean) - an on/off switch.
    • Dropdown Selection (Array) - a value chosen from a predefined list of options.
  • Organisation Restriction - optionally limit this rule so it's only available to Document Type editors within one specific organisation. Leave unset to make the rule available platform-wide.

Click Save Changes.

note

If you're editing an existing rule, a Delete button is also available. Deleting a rule that's currently attached to fields on live Document Types may affect how those fields are extracted going forward - check where a rule is used before removing it.