Reminder

Description

Set, update or run a reminder.

The reminder step manages the schedule of sending reminders to other parties. It could potentially be used for managing other scheduled activities, but the semantics assume a reminder. Use the Schedule service for simpler scheduled activities.

The reminder also requires a step that will actually execute the reminder - typically a call to the other party. This will be called with a data parameter containing an object with title and text, for example:

{
"title":"Reminder title",
"text":"Reminder text that might be quite long with <em>markup</em>."
}

The reminder step can be run in one of two modes, identified by the show config property:

  • false - set reminder parameters. This is the default.
  • true - show the user the form to manage the reminder.

When show is false, the state will be set to "success" when modifying the reminder schedule, and the state will be set to "run" when the schedule has run. Processes should not execute more steps when the state is "run". The runAction controls the run action, and in any case a typical process would have multiple reminder steps (to turn reminders on and off), and any of those could be called back to run the schedule.

When show is true, the state is set to "submit" or "cancel".

Setting the reminder with show: false

The set reminderAction takes in data or config the options in the Reminder Script, plus:

dataReference Reference of the data area to hold the reminder data. Defaults to 'reminder'.
permit Standard usage.
remote Standard usage.

In typical usage:

  • The reminder would is called with a reminderAction of set during process initialisation, and some properties set. The following provides some typical values:
    {
    "dataReference": "reminder",
    "runAction": "sendReminder", "duePeriod": 7, "reminderPeriod": 1.6, "interval": 2, "reminderTitle": "Response required", "reminderText": "<p>Your response is due by [due date]. Please respond soon.</p><p>Thank you</p>", "overdueTitle": "Overdue", "overdueText": "<p>Your response was due by [due date] and is now overview. Please respond as soon as possible.</p><p>Thank you</p>", "overduePeriod": 7, "open": true,
    "on": true }
  • When the partner is sent work, the reminder is called with a reminderAction of "set" and config of
    {
    "dataReference": "reminder",
    "active": true
    }
  • When the partner returns work, the reminder is called with a reminderAction of "set" and config of
    {
    "dataReference": "reminder",
    "active": false
    }
  • When the process has completed, and reminders will not longer be required, the reminder is called with a reminderAction of "set" and config of
    {
    "dataReference": "reminder",
    "open": false
    }

Editing the reminder with show: true

Running with show of true will allow the reminder to be edited.

As a minimum, it requires config with a data reference and show of true.

{
"dataReference": "reminder",
"show": true
}

The full set of config parameter are:

dataReference Reference of the data area to hold the reminder data. Defaults to 'reminder'.
show Set to true to show the form
title Title for the form. Defaults to "name - reminder", where name is the name of the worker. If a form is given (see below), that form's title will be used in place of the default, if available.
form An alternative form definition. This should be based on the standard reminder form at library.worker.ReminderForm, but can omit fields that you do not want the user to update and can add more content.

Member Type List

Tab/SequenceWeightMember Type
Basic/
0
Basic/
0
Basic/description
0
Basic/tagList
0
Config/
0
Flow rules/flowRules
0

Set Tags

Tag List