Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Introduction

The Inbound Emails and the Temporary Task Users TBD LINK allow designers to open up their workflows to external contractors while increasing the number of possible new use cases.

The Temporary Task Users TBD LINK are an essential part of defining a workflow that is accessible for users outside of the TIM BPM Suite environment. Click here to learn more!

Start your workflow by sending an email!

It is now possible to start an instance of your workflow by simply sending an email to the designated email address linked to it. This feature can be customised so that it fits your specific use case. Click here to learn more.

Complete a task by answering an email!

Configuring tasks to be completed by email reply is now simpler. This feature was previously available via the SignalByMailReply Timer which is now obsolete. This improved feature is now better customisable and enables the implementation of more complex use cases. Click here to learn more.


Prerequisites

Some initial prerequisites are necessary to implement the feature into your workflow. To activate this feature your process model must have at least one of the following:

  1. image-20240507-122051.png Email Start Event:
    A transition needs to be drawn from the additional start event to an activity or gateway.

The process model must still contain the normal start event for the manual start of the workflow.

  1. image-20240507-121107.png Task Boundary Event:
    A transition needs to be drawn from the boundary event to the target activity or gateway.
    Additionally, it is required to draw another transition from the activity where the boundary event is attached to another or the same target activity or gateway. See example below:

image-20240507-123054.png

As seen in the thumbnails above 2 variants of the start and boundary events are supported (Signal and Message according to the BPMN Standard).

Configuration

To configure the Inbound Email feature, some initial configuration and a per workflow configuration are required.

Set up IMAP Host

For the TIM BPM Suite to receive inbound emails an IMAP Host needs to be configured. This is done outside the TIM BPMN Suite environment (e.g. Microsoft, Google, etc.).

POP3 is not supported.

Mailbox Connector

After completing the setup of the IMAP Host, you need to connect it to your TIM BPM environment. This is done via a new connector type the Mailbox Connector.

Like other Connectors it can be found in the Design section of the TIM BPM Suite, therefore it is required that the user that sets up the Mailbox Connector has the workflow-designer static role.

From there select the Connectors sub-section.

Screenshot 2024-05-07 at 10.31.22.png

In the bottom-left corner the Plus-Button1 ((plus)) is shown clicking it will show a sub-button-menu, there click the Mailbox-Button2 to create a new Mailbox Connector.

Screenshot 2024-05-07 at 10.51.20.png

Reference

Attribute

Description

1

Mailbox configuration

These are the required fields to create a connection between the IMAP mail server and the TIM BPM Suite:

  1. Email address: Here the receiving email address needs to be specified

This address is freely selectable.

  1. IMAP Host: Here the host URL of the IMAP mail server needs to be specified.

  2. IMAP Port: Here the corresponding port of the IMAP mail server needs to be specified.

The typical IMAP port number is 143, for IMAP over SSL/TLS (IMAPS) the port number 993 is assigned.

2

Authentication

There are 2 authentication Methods available:

  1. Basic Authentication

  2. OAuth (Open Authorization)

Depending on the selection new required fields need to be filled. Optionally No Authentication can be selected.

Workflow Design

The configuration regarding the Inbound Emails is done on the workflow level.

Connecting the workflow to a mailbox

If the prerequisites regarding the process model are met a new tab is shown in the workflow properties.

Screenshot 2024-05-07 at 17.24.42.png

Reference

Attribute

Description

1

Mailbox Connector

Here the Mailbox Connector that is linked to the workflow must be selected.

Only one Mailbox Connector can be linked to a workflow at a time.

2

Other Configuration

These additional options allow the workflow designer to decide what should happen with the initialising email and its attachments.

  1. Add attachments of incoming mail to instance:
    Adds all attachments that were sent together with the initialising email to the started or running instance.

  2. Attach incoming mail to instance as note?:
    Adds the text of the initialising email in the form of a note to the started or running instance.

  3. Attach incoming mail to instance as EML?:
    Adds the initialising email in the form of an EML to the documents of the started or running instance.

Configuration of email start

Configuration of task completion by mail reply

Administration

Click here TBD LINK to see what's new in the administration regarding the inbound emails.

  • No labels