Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The ActionHandler ICalHandler allows an appointment, which has been created in a smartformform, to be sent to all participants.

...

Code Block
com.dooris.bpm.actionhandler.ICalHandler

 

Parameter

Parameter

Default value

Description

Valid examples

eventName

Status
titleMANDATORY

 

This parameter is used to set the name of the meeting. Process variables can also be used.

${name}

description

 

This parameter is used to set the description of the meeting. Process variables can also be used.

${description}

location

Status
titleMANDATORY

 

This parameter is used to set the location of the meeting. Process variables can also be used.

${location}

start

Status
titleMANDATORY

 

This parameter is used to set the start date of the meeting. This parameter allows choosing a range through date picker from the

smartform

form.

Note

If you select a range, the parameter end will become invalid, since the start and the end dates are both entered via the start parameter.

Process variables can also be used in this parameter. Format should be as follows if it will be given manually:

e.g. in the format: dd.MM.yyyy HH:mm:ss ⇒ 13.02.2013 17:00:00 (see datePattern)

${start}

end

 

This parameter is used to set the end date of the meeting. Process variables can also be used.
e.g. in the format: dd.MM.yyyy HH:mm:ss ⇒ 13.02.2013 19:00:00 (see datePattern)

Info
  • if startis a date range (i.e. "2023-02-28T23:00:00Z","2023-03-01T23:00:00Z" then, endbecomes invalid.

${end}

organizer

Status
titleMANDATORY

 

This parameter is used to set the organizer of the meeting. It may be derived from process variables. A group, a swimlane or a user can be set.

If the organizer comes from a process variable: ${organizer}
Process variable: organizerEmail –> mail address

If the organizer is given directly to the handler:
Format: email?name

Info

Usage of selectUsersByGroupByClass is possible!

Note

Only one user must be part of the organizer. If you set a group as organizer, it must be only one user within a group.

${organizer}

attendant

Status
titleMANDATORY

 

This parameter is used to set the participants of the meeting. Can come from a process variable.

If the participant comes from a process variable: ${attendant}

Info

Or: ${attendant} -> mail addresses are separated by commas!

If the participant is given directly to the handler:
Format: mail addresses are separated by commas!

You can set a group, swimlane, user, combine them via comma: user(username),group(groupName),swimlane(swimlaneName)

Info

Usage of selectUsersByGroupByClass is possible!

 

fullTime

false

This parameter controls if the last day of the entry should be counted as an all-day event.

true

 

Example:

We have a simple process with only one task. We also have a Smartform Form with various process variables that we will use to configure this ActionHandler in our ICALTest4 task. The configuration details with the help of process variables coming from the Smartform Form are as follows:

...

The Smartform Form can be configured according to your needs. For example, the description of the meeting is set with the following limitations:

...

Now a new process instance can be started. The Smartform Form must be filled with all mandatory information (EventName, location, organizer, attendant, Start) and can be started via the ‘Start process instance’ button. You can add more users or groups to the attendant field, separated by commas.

...