Administration
Workflow rules
A workflow rule watches tickets and acts on them automatically. Each rule has three parts: a trigger (the event that starts it), conditions (which tickets it applies to) and actions (what it does). You manage rules in Admin → Workflow rules, which requires the Administrator security level.
Limit: Rules run for tickets only. The Applies to list also shows Project task, Opportunity and Contract, marked "(coming)"; they cannot be selected.
Triggers
Choose one trigger per rule in When it.
| Trigger | Fires when |
|---|---|
| is created | A ticket is created, including tickets generated by recurring tickets and tickets created through the API |
| is updated | Any field on a ticket changes |
| changes status | The ticket's status changes |
| gets a note | A note is added to the ticket |
A status change counts as both an update and a status change, so rules on either trigger are checked.
Conditions
Conditions sit in the IF block. All of them must be true for the rule to run; there is no "or" between conditions. To match several values of one field, use is one of. A rule with no conditions runs for every ticket on its trigger.
| Field | Operators |
|---|---|
| Status, Type, Company | is, is not, is one of |
| Priority | is, is not, is one of, more urgent than, less urgent than |
| Queue, Contact, Contract, Issue type, Sub-issue type, Source, Assigned resource | is, is not, is one of, is empty, is set |
| Title | is, is not, contains, is empty, is set |
| Tier | is, is not, is one of, is above, is below, is empty, is set |
Tier runs T1, T2, T3, ENG from lowest to highest. contains ignores upper and lower case.
The Event group in the field list holds fields that describe what just happened:
| Field | Values | Has a value for |
|---|---|---|
| Status bucket | open, waiting, done | Every trigger |
| Previous status | Any ticket status | changes status and is updated |
| Note direction | in, out, internal | gets a note |
| Note visibility | internal, public | gets a note |
| Note type | note, resolution, escalation, email_in, email_out, tool, system | gets a note |
An event field with no value for the chosen trigger is marked "(not for this event)". The rule still saves, but that condition never matches a value.
Actions
Actions sit in the THEN block and run in the order shown. A rule needs at least one.
| Action | What it does |
|---|---|
| Set field | Sets Status, Priority, Queue, Type, Issue type, Sub-issue type, Source, Assigned resource or Tier. For Queue and Assigned resource, leaving the value empty clears the field |
| Assign to | Assigns the ticket to a resource you choose |
| Move to queue | Moves the ticket to a queue you choose |
| Add note | Adds an Internal or Public note with your text. The note's author shows as "Workflow:" followed by the rule name |
| Notify | Sends an in-app notification, with your title, to the Assignee, the Queue members or a named resource |
| Create to-do | Creates a to-do on the ticket's company for the Assignee or a named resource, due in the number of hours you enter |
Things to know:
- Notify creates in-app notifications only, the ones staff see under the bell. It does not send email and does not add anything to the Notifications outbox. If you choose Assignee and the ticket has none, nobody is notified.
- If Set field moves a ticket to a status in the done bucket and the ticket has no resolution, the resolution is filled in as "Closed by workflow rule" with the rule name.
- Notification titles and to-do subjects are prefixed with the ticket number.
Create a rule
- Go to Admin → Workflow rules and click New rule.
- Enter a Rule name.
- Leave Applies to as Ticket and choose a trigger in When it.
- Under IF, click Condition for each test you need. Pick the field, the operator and the value.
- Under THEN, choose the first action and fill it in. Click Action to add more, and use the arrows to reorder them.
- Read the READS AS box. It restates the rule in plain language, for example "When a ticket is created and priority is Critical: set status to Escalated, then notify the assignee." If the rule is unfinished it shows "incomplete" with the first problem.
- Leave Active ticked to switch the rule on as soon as it is saved, then click Save rule.
A rule can have up to 20 conditions and 20 actions.
Order, switch off and delete
Rules are evaluated in the order of the list on the left, top first. Every matching rule runs, not only the first one, so a later rule sees the changes made by an earlier one. Use the arrows beside a rule to move it, or edit its Order number.
- To pause a rule, open it and click Turn off now, or clear Active and save. Rules that are off show an "off" tag.
- To remove a rule, click Delete. It stops running immediately, and the audit log keeps a copy.
Changes that a rule makes do not trigger other rules or the same rule again, so rules cannot loop. If a rule fails on a ticket, it is skipped and the remaining rules still run; the change the user made is never blocked.
See whether a rule is running
There is no test or dry-run mode. To check a rule:
- The number beside each rule in the list is how many times it has fired.
- Opening a rule shows when it last fired and how many times.
- Each firing is recorded in Admin → Audit log with the rule name and ticket number. Filter the log by the action "fire" to see them. See Administration.
Examples
Send critical tickets to an escalation queue
- When it: is created
- IF: Priority is Critical
- THEN: Move to queue (your escalation queue), then Notify Queue members with the title "Critical ticket"
Flag a customer reply
- When it: gets a note
- IF: Note direction is in, AND Status bucket is waiting
- THEN: Set field Status to your "customer responded" status, then Notify Assignee with the title "Customer replied"
Follow up after closing
- When it: changes status
- IF: Status bucket is done, AND Type is Incident
- THEN: Add note (Internal) "Confirm with the customer that the issue has not returned"
The status, priority, type and queue names in these examples are placeholders. Use the values from your own picklists and queues, which you manage in Admin → Picklists and Admin → Queues.