User Tools

Site Tools


awe:notifications

E-Mail Notifications

AWE sends e-mail through Fylr's normal template mechanism. Two template types are contributed by the plugin and are created and edited in the E-Mail Templates admin module; a default template ships with the plugin for both:

Template Type Sent when
AWE - Workflow Assignment Notification A transition configured to notify assignees was applied, or an item was reassigned.
AWE - Workflow Due Date Reminder The Workflow Due Dates job found an item past the due date of the state it is in.

Placeholders

Placeholder Content Available in
${workflow} The workflow name. both
${state} The state the item is in. both
${transition} The applied transition; for a reassignment the localised word for it. assignment
${item-title} The item's display title. both
${item-id} The item's id. both
${item-link} A deep link to the item in Fylr. both
${applying-user} Who applied the transition or performed the reassignment. assignment
${comment} The comment that was entered, empty when none was. assignment
${due-date} The deadline that has passed, formatted for the recipient. due date

The built-in global placeholders such as ${fylr-url} are available as well.

Who is notified

Sending is switched on per sender, never globally — on the transition for the assignment mail, on the workflow for the reassignment mail and on the due-date entry for the reminder. All three are off by default.

  • A transition notifies the users the item is assigned to after it was applied: the fixed owner list for Assign to Fixed Users or Groups, the item's current assignees for Keep Current Assignments.
  • A reassignment notifies the new assignees.
  • A due-date reminder goes to the assignees of the overdue item.

The user who triggered the change is always excluded — nobody is notified about their own action.

Assigned groups are only expanded to their members when the Also Notify the Members of an Assigned Group option beside the respective switch is enabled, because a single group assignment can turn into any number of e-mails. Membership in Fylr's system groups cannot be resolved, so such a group expands to nobody.

Every message is written in the recipient's own Fylr frontend language. Recipients with different languages receive separate messages.

A failing e-mail never undoes the transition or the reassignment that triggered it — the step succeeds, only the message is lost. A transition that is configured to notify but whose assignment mode assigns nobody, or for which no template can be found, is reported by Validate Workflow….

awe/notifications.txt · Last modified: (external edit)

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki