2022 April Release

Struct COOWF@1.1:EscalationEntryList Permanent link for this heading

This struct is used to define when and who will get an escalation

Additional Information

Properties Permanent link for this heading

Type

Property

Name

Action

escdefaction

Action to Call

Importance

escdefmailimportance

Importance

integer

escdefovertime

Period of Time

WorkFlowPriority

escdefpriority

For Workflow Priority

EscalationRecipient[]

escdefrecipients

Recipients of Escalation Message

integer

escdefrepeat

Repeat Every

boolean

escdefsubjaddsuiteprefix

Add Product Suite as Prefix to Subject

string[]

escdefsubjexpr

Mail Subject Expression

LanguageStringList[]

escdeftext

Message Text

EscalationType

escdeftype

Escalation Type

XSLTransformation

esctextxslt

XSL-Transformation for Escalation Text

Properties Permanent link for this heading


Action to Call (COOWF@1.1:escdefaction) Permanent link for this heading

This property can be used to define an action that is called to handle an escalation. Activity instances are escalated, if start or end deadlines are not met and an escalation definition is used for these activities or for the processes, that contain these activities.
Escalation handling actions are called with the prototype EscalationActionPrototype. They can modify the recipients and the content of the escalation message or they can decide to handle the escalation completely by itself and disable the escalation routine built in.

Action COOWF@1.1:escdefaction

Additional Information


Importance (COOWF@1.1:escdefmailimportance) Permanent link for this heading

The importance of the sent mail can be defined. If no configuration is done mails are sent with importance SMTP_IMPORTANCE_NORMAL

Importance COOWF@1.1:escdefmailimportance

Additional Information


Period of Time (COOWF@1.1:escdefovertime) Permanent link for this heading

Defines the delay period for the escalation routine. If a value is specified for this property, the escalation routine is not started immediately, when the deadline of an activity instance is exceeded, but after the specified amount of time. The time is stored in number of seconds.

unsigned integer COOWF@1.1:escdefovertime

Additional Information


For Workflow Priority (COOWF@1.1:escdefpriority) Permanent link for this heading

Defines the priority of the escalation routine. This means that the escalation routine is used only for those activity instances that have the same priority. You can use this property to specify different escalation routines for activity instances with different priorities.

WorkFlowPriority COOWF@1.1:escdefpriority

Additional Information


Recipients of Escalation Message (COOWF@1.1:escdefrecipients) Permanent link for this heading

Defines the list of escalation recipient definitions, who receive the escalation message. Such an escalation recipient can be specified as e-mail address, as an abstract participant or a user, a position, a group or an organizational unit.

EscalationRecipient[] COOWF@1.1:escdefrecipients not null

Additional Information


Repeat Every (COOWF@1.1:escdefrepeat) Permanent link for this heading

Defines the time interval for repeating the escalation. For each execution of the escalation the date is stored in the activity instance object. Thus the last escalation for an activity instance is visible. With this property the escalation can be repeated multiple times. The next escalation is done after the specified time interval - unless the activity instance was started or completed in the meantime.

unsigned integer COOWF@1.1:escdefrepeat

Additional Information


Add Product Suite as Prefix to Subject (COOWF@1.1:escdefsubjaddsuiteprefix) Permanent link for this heading

If true and a custom subject is calculated using escdefsubjexpr the suit prefix (e.g. "Fabasoft Cloud Event:") will be added.

boolean COOWF@1.1:escdefsubjaddsuiteprefix

Additional Information


Mail Subject Expression (COOWF@1.1:escdefsubjexpr) Permanent link for this heading

This property defines an expression to calculate the subject of the notification mail.

The object of the process is passed into the Local Scope as variable object.

string[] COOWF@1.1:escdefsubjexpr (
  optional object object,
  optional ProcessInstance process,
  optional ActivityInstance activity,
  optional EscalationType escdeftype,
  optional ExpiryCheck escdefdeadlinetype,
  optional datetime escdefdate,
  optional string objectname)

Local Scope: dictionary
Returns: string

Name

Description

object

the object of the process

process

the process instance

activity

the current activity instance

escdeftype

the type of the escalation if the escalation should be done before or after the deadline

escdefdeadlinetype

the deadline type for example EXPCHK_SUBMITTED, EXPCHK_STARTED or EXPCHK_COMPLETED

escdefdate

the time stamp when the deadline expires

objectname

the name of the object of the process

Additional Information


Message Text (COOWF@1.1:escdeftext) Permanent link for this heading

Defines the message that is sent by the escalation routine. This property is a multilingual string.

unique LanguageStringList[] COOWF@1.1:escdeftext

Additional Information


Escalation Type (COOWF@1.1:escdeftype) Permanent link for this heading

This property defines if the escalation is triggered before or after the expiration of the deadline

EscalationType COOWF@1.1:escdeftype

Additional Information


XSL-Transformation for Escalation Text (COOWF@1.1:esctextxslt) Permanent link for this heading

This property defines an XSL-Transformation to format the body of the escalation mail. Note the XSL-Transformation is only exectuted for mail dispatch with a defined WorkFlowParticipant. The XSL-Transformation is ignored for escalations with deined mail addresses only

XSLTransformation COOWF@1.1:esctextxslt

Additional Information