StartProcessInstanceRepetitive

Description

Processes can be started periodically, on certain days. Intuitive time specifications (e.g. the 3rd day of each month) can be easily displayed. It is also possible to check whether an instance of the process has already been started and, depending on this, to decide whether a new one should be started.

 

Class

com.dooris.bpm.actionhandler.StartProcessInstanceRepetitive

 

Parameter

Parameter

Default Value

Description

Valid Examples

Parameter

Default Value

Description

Valid Examples

processDefinition

 

This parameter is used to set the name of the process instance to be started.

 

variableNameForTopic

 

This parameter is used to set the name of a process variable that contains the topic of the instance.

 

contentForTopicVariable

 

This parameter is used to set the content of the variableNameForTopic variable.

 

referenceTimePeriodString

 

This parameter is used to specify the time period.

YEAR, MONTH, WEEK

relativeStartPoint

 

Contains all days on which a new instance is to be started, separating the individual entries. All days must be seperateed by an &. Valid values are integers from -365 to 365 or MAX.

 

Examples:

  1. Start on the first day of each year:
    referenceTimePeriodString=YEAR
    relativeStartPoint=1

  2. Start on the last day of each month:
    referenceTimePeriodString=MONTH
    relativeStartPoint=MAX

  3. Start every Wednesday:
    referenceTimePeriodString=WEEK
    relativeStartPoint=3

  4. Start three days before the end of each month:
    referenceTimePeriodString=MONTH
    relativeStartPoint=-3

useBusinessCalendar

 

This parameter is used to decide if the business calendar will be used. If it is set to true, only business days will be taken into account when calculating the start time.

 

timeForStartCheck

00:00

This parameter is used to set a time in HH:MM format. New instances will be started as soon as this time is exceeded.

 

criteriaForDuplicateCheck

 

Valid values are DEFINITION or TOPIC. If DEFINITION is set, no instance will be started if another instance of the same process was started in a certain period of time (periodeInDaysForExistenceCheckOfStartedInstanceInPast). If TOPIC is set, no new instance will be started if another one was started with the same content in the topic variable.

 

periodeInDaysForExistenceCheckOfStartedInstanceInPast

 

A number from 0 to 365 can be specified here. This determines (in days) the period in which the same instances are checked (criteriaForDuplicateCheck).