CheckListTask Step

Last published at: May 14th, 2024


Route "checkListTask" to users. Task will contain a list of check list items that are user defined.


  • description – Checklist task description
  • routeTo – Select the list of users to route the task
  • routeToRoles – Select the list of roles to route the task
  • checklistitem--Configure checklist items
  • taskDesc – Description for the task
  • routedItem – Item that is routed
  • showURL – URL to render within the task
  • emailAddressses- Email addresses to route task to
  • priority – Priority of the task
  • daysToComplete - # of days, minutes, hours, months to complete the task by
  • expireType – Task expire type (days, months, hours, minutes)
  • includeWeekends - Include weekends (toggle ON/OFF)
  • taskRoutingRules – Task routing rule types (default, task locking, least # of tasks in total, least # of tasks in definition)
  • taskReminder- Set Task reminder to send reminder mails
  • waitForAll – Yes = all users must act on the task, No = requires only 1 user to act on the task (toggle ON/OFF)
  • storeRouteToUsers – Variable to store what users the task was routed to
  • sendEmailNotifications – Yes = email notification will be sent to each user for the task (toggle ON/OFF)
  • fromEmail – Set From email address
  • emailSubject – Subject of the email message
  • emailBody – Body of the email message
  • emailFiles – Set the server path for file attachments
  • sendExpireEmail - Send expired email notification (toggle ON/OFF)
  • sendAckLink - Send acknowledgement link (toggle ON/OFF)
  • approveButtonLabel-- Set text for Approve button label (e.g. Ok)
  • rejectButtonLabel-- Set text for Reject button label (e.g. Not Ok)
  • sendExpireEmail - Yes = email notification will be sent to each user on task expiry (toggle ON/OFF)
  • hideRejectButton--Hide reject button (toggle ON/OFF)
  • userCanReAssign – Yes = user can re-assign task to another active users (toggle ON/OFF)


  • completed – task was approved and completed
  • rejected – task was rejected
  • timeout – task timed out

Step Returns Collection

  • stepReturn.routeTo - list of users (GUID), the task is routed to
  • stepReturn.completedByUsers – user (GUID), the task completed by
  • stepReturn.rejectedUserList – list of users (GUID), the task is rejected by



Let’s build and execute the checklisttaskDef example.

  • Create a new definition called “checklisttaskDef”
  • Select the definition and click the “design” button
  • Drag a "checkListTask" step to the canvas
  • Connect the dots between the start and checklisttask step
  • Click on the “checklisttask” step to configure its properties
  • Configure the following values for the properties as shown on the below graphic
  • Click on Select the users to route to and select users or enter variable of userid 

  • Click on select roles to route to and select application role 

  • Click on Task reminder to set task reminder intervals. Enable "Send Email Notification" to ON.Task reminders configured with a positive value is calculated from the task created date. Task reminders configured with a negative value is calculated by reducing that duration from the task due date. The task reminder message body supports line breaks.

  • Use Variable(s) references for more meaningful reminder message.
  • Click on Email body and use the existing template (you can edit existing template as well) as email body or create custom template as email body. 

  • Click on Replace Link(s) or Variable(s) or Global(s) and select any reference to add more meaningful email message.
  • Click on return values to configure return values to the task. 

  • If the checklist item "Is Required" checked, then while rendering the task, the user has to check it in order to complete the task.
  • If "Let user can add custom items" is enabled, then while rendering, user can add custom checklist items to task
  • Save the process definition, create a process instance and execute. Check the step properties by rendering the process instance. Step should route checklist task to users.
  • Navigate to Logging settings. The "Send Test Mail" feature is provided to send a test email with the contents configured in the email body, to the current (logged in) user.