Class COOWF@1.1:WorkFlowDiagram

Representing BPMN workflows (process diagrams).

Explanation:
A BPMN Process Diagram is used for modeling a business process. The modeled business process can be released for execution and executed.

Class Hierarchy

Object > BasicObject > DiagramObject > BPMNDiagramObject > WorkFlowDiagram

Properties

Type	Property	Name
Object[]	wfdallowedcategories	Applicable for
Object[]	wfdallowedparents	Object Class/Category of the File
Object[]	wfdallowedteamrooms	Object Class/Category of the Teamroom
Object[]	wfduseddefinitions	Used Process Elements
ObjectClass[]	wfduseforclasses	Applicable for Object Classes
boolean	wfduseforsubprocessesonly	Only Usable as Subprocess
Object[]	wfprocessowner	Process Owner

Actions

Return Type	Signature
boolean	CanBeUsedForSubProcessesOnly( out retval boolean subprocessesonly)
boolean	CanReleaseTemplate( out retval boolean canrelease)
WorkFlowCompoundParticipant[]	GetDiagramProcessParticipants( optional boolean skipsubprocesses, out retval WorkFlowCompoundParticipant[] processparticipants, optional boolean forcereferenceddraftversion)
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
WorkFlowDiagram[]	GetReferencedDiagrams( boolean recursive, out retval WorkFlowDiagram[] refdiagrams)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
boolean	IsReferencedDiagram( boolean checkreleasedonly, out retval boolean isreferenced, out optional WorkFlowDiagram[] referencingdiagrams)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)
void	RevokeReleasedTemplate( optional dictionary additionalsettings)

Properties

Applicable for (COOWF@1.1:wfdallowedcategories)

This property defines the categories for which the diagram is usable.

Explanation:
The process can only be executed on objects that have one of the listed categories and one of the listed object classes and one of the listed object aspects assigned. If nothing is defined, the process is commonly usable.

unique Object[] COOWF@1.1:wfdallowedcategories readonly

Additional Information

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

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

This property defines the categories for which the diagram is usable.

Explanation:
The properties of the object classes and categories of this list can be used when defining the abstract participants "Property of the File of the Object" and "Role by Property of the File of the Object".

unique Object[] COOWF@1.1:wfdallowedparents readonly

Additional Information

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

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

This property defines the Teamroom for which the diagram is usable.

unique Object[] COOWF@1.1:wfdallowedteamrooms readonly

Additional Information

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

Used Process Elements (COOWF@1.1:wfduseddefinitions)

This property stores all definition elements contained in the process diagram

unique Object[] COOWF@1.1:wfduseddefinitions readonly invisible

Additional Information

Object Classes Allowed: ActivityDefinition, EscalationDefinition, ProcessDefinition, WorkFlowDiagram

Applicable for Object Classes (COOWF@1.1:wfduseforclasses)

This property defines the object classes on those instances the process defined in the WorkFlowDiagram can be started.

unique ObjectClass[] COOWF@1.1:wfduseforclasses readonly volatile invisible

Only Usable as Subprocess (COOWF@1.1:wfduseforsubprocessesonly)

This property defines if the process diagram is only useble as sub process for other diagrams

boolean COOWF@1.1:wfduseforsubprocessesonly

Process Owner (COOWF@1.1:wfprocessowner)

Stores the process owner of the process diagram. The process owner is treated as additional process administrator for processes started based on the process diagram.

Explanation:
The process owner is responsible for a process or subprocess.

Object[] COOWF@1.1:wfprocessowner readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User, Group, Person

Actions

COOWF@1.1:CanBeUsedForSubProcessesOnly

Checks if the current workflow diagram is only usable as sub process

boolean COOWF@1.1:CanBeUsedForSubProcessesOnly(
out retval boolean subprocessesonly)

Name	Description
subprocessesonly	the result

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release.

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

COOWF@1.1:GetDiagramProcessParticipants

Get the participants used in the executable processes of the process diagram

WorkFlowCompoundParticipant[] COOWF@1.1:GetDiagramProcessParticipants(
  optional boolean skipsubprocesses,
  out retval WorkFlowCompoundParticipant[] processparticipants,
  optional boolean forcereferenceddraftversion)

Name	Description
skipsubprocesses	If set to true the subprocesses contained in the process diagram will not be scanned for participants
processparticipants	the result
forcereferenceddraftversion	if to true the draft version of all referenced diagrams is used. If set to false the released version of the referenced processes is used. If the parameter is not defined the current referenced object is used

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

COOWF@1.1:GetReferencedDiagrams

Action to retrieve all diagrams used in subprocesses

WorkFlowDiagram[] COOWF@1.1:GetReferencedDiagrams(
boolean recursive,
out retval WorkFlowDiagram[] refdiagrams)

Name	Description
recursive	the nested diagrams are also included
refdiagrams	the result

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

COOWF@1.1:IsReferencedDiagram

Check if the current workflow diagram is used as referenced diagram in another diagram

boolean COOWF@1.1:IsReferencedDiagram(
  boolean checkreleasedonly,
  out retval boolean isreferenced,
  out optional WorkFlowDiagram[] referencingdiagrams)

Name	Description
checkreleasedonly	the diagram in only marked as used if the referencing diagram is released
isreferenced	the result
referencingdiagrams	the diagrams which reference the current diagram

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