User Guide

The eZDesk Business Rules Descriptions tool makes documenting your business rules effortless. It automatically generates descriptions for all active Triggers, Automations, Macros, Views, SLA Policies, Workspaces, and Deletion Schedules.

Need to share a rule? Copy the description in Markdown for quick pasting into GitHub issues or in HTML for easy email sharing. Plus and Pro plan users can also download descriptions by rule type or for all rule types at once, making it simple to document an entire instance with just a few clicks.

Effortless documentation at your fingertips! 🚀

How to use:

  • Select a Rule
    Click any business rule listed on the left, and its detailed description will appear on the right.
  • Search for a Rule
    Use the search function to quickly filter and find a specific rule from a long list.
  • Copy a Description
    Click “Copy Markdown” or “Copy HTML” to instantly copy the formatted description to your clipboard.
  • Download Descriptions
    Click the download link above each rule type to download descriptions for that category. Or click “Download All Business Rule Descriptions” at the top of the page to get a zip file containing:
    • A directory for each rule type.
    • A file with links to each rule.
    • Each rule’s description in Markdown and HTML.
    • A JSON file with the rule’s raw data—perfect for those who want to dig into the details.