Class COOWF@1.1:EscalationDefinition

Objects of this class can be used to define escalation mechanisms, if deadlines in an activity instance are not met. This includes which deadlines are checked, when are they escalated, by which means is escalation done, and who is the recipient of escalation messages. An escalation definition can be associated to a process in general or only to particular activities within a process.
Requirement for the automatic escalation is an AT service. To activate the automatic escalation a background task must be created on an object of class BackgroundActivities that calls the action CheckExpiredActivities. This must be done once in the domain, where expired deadlines should be checked.

Class Hierarchy

Object > ComponentObject > ConfigurationObject > SimpleConfigurationObject > EscalationDefinition

Properties

Type	Property	Name
Object[]	escdefallowedcategories	Applicable for
Object[]	escdefallowedparents	Object Class/Category of the File
Object[]	escdefallowedteamrooms	Object Class/Category of the Teamroom
LanguageStringList[]	mlname	Multilingual Name

Actions

Return Type	Signature
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
boolean	IsTemplateReleased( out retval boolean isreleased, out optional object releasedtemplate)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)
void	RevokeReleasedTemplate( optional dictionary additionalsettings)

Properties

Applicable for (COOWF@1.1:escdefallowedcategories)

This property defines the categories for which the escalation definition is usable.

unique Object[] COOWF@1.1:escdefallowedcategories readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass
Object Classes Not Allowed: AppCategory

Object Class/Category of the File (COOWF@1.1:escdefallowedparents)

This property defines the categories for which the escalation definition is usable.

unique Object[] COOWF@1.1:escdefallowedparents readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass
Object Classes Not Allowed: AppCategory

Object Class/Category of the Teamroom (COOWF@1.1:escdefallowedteamrooms)

This property defines the Teamroom for which the escalation definition is usable.

unique Object[] COOWF@1.1:escdefallowedteamrooms readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass
Object Classes Not Allowed: AppCategory

Multilingual Name (COOSYSTEM@1.1:mlname)

Defines the multilingual name of the object. It stores one name for each supported language.

Explanation:
This field defines the multilingual name of the object.

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Actions

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

COOTC@1.1001:IsTemplateReleaseable

Checks if a template is releaseable, and if a released template is required in a particular context.

In the room environment, it is usually the case that a template, which can in principle be released, only needs to be released in certain cases. Templates in an app configuration or a template collection must always be released, while a template of the same object class in an app room does not require release.

boolean COOTC@1.1001:IsTemplateReleaseable(
out retval boolean isreleaseable,
out boolean requirereleasedversion)

Name	Description
isreleaseable	the result
requirereleasedversion	this parameter defines if release version of the template is required

COOTC@1.1001:IsTemplateReleased

Check if a template is already released.

boolean COOTC@1.1001:IsTemplateReleased(
out retval boolean isreleased,
out optional object releasedtemplate)

Name	Description
isreleased	the result
releasedtemplate	the released template

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates

COOTC@1.1001:RevokeReleasedTemplate

Marks an released template as no longer released, so the template can no longer be instantiated.

void COOTC@1.1001:RevokeReleasedTemplate(
optional dictionary additionalsettings)

Name	Description
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to withdraw release of sub templates