Object Class Ad Hoc Process Template (COOWF@1.1:PrescriptionTemplate)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:BasicObject > COOWF@1.1:PrescriptionTemplate

Check properties of activity instance before they are saved.

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Default Context Menu (Container Independent): COODESK@1.1:MenuRootOLEContext
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Programmatic Use: true
Symbol: COODESK@1.1:SymbolProcessTemplate
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOSYSTEM@1.1:BasicObject
Action for Linking Objects: COODESK@1.1:DragIntoLink
Display Mode: DISP_LINES
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
COOWF@1.1:actinstprescrbackActivity Back
COOWF@1.1:actinstprescrblocksAdditional Prescriptions
COOWF@1.1:actinstprescriptionPrescriptions
COOWF@1.1:actinstprescrmetawhatWhat
COOWF@1.1:actinstprescrmetawhenDeadlines
COOWF@1.1:actinstprescrmetawhenworkdaysDeadlines
COOWF@1.1:actinstprescrmetawhoWho
COOWF@1.1:actinstprescrparallelParallel

Actions

ReferenceName
COOATTREDIT@1.1:CheckAppLicense
COOWF@1.1:AddPrescription
COOWF@1.1:AttrActInstSet
COOWF@1.1:AttrPrescriptionBlockConstructor
COOWF@1.1:AttrPrescriptionLineConstructor
COOWF@1.1:CheckInsertTemplate
COOWF@1.1:CheckPrescriptionsForm
COOWF@1.1:CheckSimplePrescriptionsForm
COOWF@1.1:ConvertPrescription
COOWF@1.1:ExtractSubPrescription
COOWF@1.1:GetPrescribeTemplate
COOWF@1.1:GetPrescriptionHeadLine
COOWF@1.1:MovePrescription
COOWF@1.1:NormalizeNestedPrescriptions
COOWF@1.1:RemovePrescription
COOWF@1.1:ResolveDistributionList

Properties

COOWF@1.1:actinstprescrback (Activity Back)

This property is used to let the user define the activity definition for the activity back to the current user when doing prescriptions on an activity instance. If it is used when doing prescriptions, an activity instance is created and appended to the prescribed activities, that uses this definition and that concerns the current user In the case of a parallel prescription, this would be a join to this activity. This property is only used in the user interface, it never stores a value. When the user intends to do prescriptions, it is initialized with the value returned by the action COOWF@1.1:GetPrescribeDefault. Before the property is stored, it is set to empty.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrActInstSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOWF@1.1:ActivityDefinition
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstprescrblocks (Additional Prescriptions)

This property is used to let the user edit additional blocks of prescriptions when doing prescriptions on an activity instance. A block of prescriptions consists of a list of prescription definitions and a flag, if this list is to be used sequentially or in parallel. This property is only used in the user interface, it never stores a value. When the user intends to do prescriptions, it is initialized with the value returned by the action COOWF@1.1:GetPrescribeDefault. Before the property is stored, it is set to empty.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrActInstSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOWF@1.1:WorkFlowPrescriptionBlockList
Line Constructor Action for Lists: COOWF@1.1:AttrPrescriptionBlockConstructor
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstprescription (Prescriptions)

This property is used to let the user edit the list of prescriptions when doing prescriptions on an activity instance. This property is only used in the user interface, it never stores a value. When the user intends to do prescriptions, it is initialized with the values returned by the action COOWF@1.1:GetPrescribeDefault. Before the property is stored, it is set to empty.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrActInstSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOWF@1.1:WorkFlowPrescriptionList
Line Constructor Action for Lists: COOWF@1.1:AttrPrescriptionLineConstructor
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:actinstprescrmetawhat (What)

Additional Information

Type: COOWF@1.1:PrescriptionMetaDataWhat
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:actinstprescrmetawhen (Deadlines)

Additional Information

Type: COOWF@1.1:PrescriptionMetaDataWhen
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:actinstprescrmetawhenworkdays (Deadlines)

Additional Information

Type: COOWF@1.1:PrescriptionMetaDataWhenWorkDays
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:actinstprescrmetawho (Who)

Additional Information

Type: COOWF@1.1:PrescriptionMetaDataWho
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOWF@1.1:actinstprescrparallel (Parallel)

This property is used to let the user define whether the defined prescriptions should be done in parallel or in sequence when doing prescriptions on an activity instance. This property is only used in the user interface, it never stores a value. When the user intends to do prescriptions, it is initialized with the value returned by the action COOWF@1.1:GetPrescribeDefault. Before the property is stored, it is set to empty.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOWF@1.1:AttrActInstSet
Changeable in Installed Component: true


[top]

Actions

COOATTREDIT@1.1:CheckAppLicense

Checks the license of an app. If there is one or more apps defined in the property COOATTREDIT@1.1:classapps of the object class of the object, check if any of these apps is licensed currently.
Thrown errors include
COOATTREDIT@1.1:object_app_license_expired
COOATTREDIT@1.1:object_not_licensed.
ParameterTypeIn/OutOptionalDescription
objdirectCOOSYSTEM@1.1:BOOLEANintrue
instanceCOOSYSTEM@1.1:STRINGintrue Instance to be checked.
disableerrorappsCOOSYSTEM@1.1:BOOLEANintrue Just raise an error, do not set error application.
contextCOOSYSTEM@1.1:OBJECTintrue the current context for the license evaluation. E.g an object of the teamroom to evaluate the correct organization
silentmodeCOOSYSTEM@1.1:BOOLEANintrue if set no errors will be raised
haslicenseCOOSYSTEM@1.1:BOOLEANoutfalse additional to possible errors the result of the license check will be returned in this parameter

Additional Information

Must Be Executed: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AddPrescription

Adds a prescription
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListin/outfalse the prescription
actionCOOWF@1.1:SavePresciptionActionTypeinfalse the action
pblockidxCOOSYSTEM@1.1:INTEGERin/outtrue the pblockidx
pidxCOOSYSTEM@1.1:INTEGERin/outtrue the pidx
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue = the prescriptionblocks

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrActInstSet

This action is used for must properties of COOWF@1.1:ActivityInstance and COOWF@1.1:WaitActionInstance. It is called by the kernel before these properties are saved. Most properties of activity instances, that are already executed, must not be changed any more, and during the execution of a process only certain changes of values are valid. This action is used to check these conditions.

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrPrescriptionBlockConstructor

Create a new block in the prescription
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse
valueoutfalse
oldvaluesinfalse

Additional Information

Prototype: COOSYSTEM@1.1:AttrLineConstructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrPrescriptionLineConstructor

Create a new line in the prescription
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse
valueoutfalse
oldvaluesinfalse

Additional Information

Prototype: COOSYSTEM@1.1:AttrLineConstructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckInsertTemplate

Check a prescription template can be inserted at the current position
ParameterTypeIn/OutOptionalDescription
pblockidxCOOSYSTEM@1.1:INTEGERinfalse the index of the precription block
pidxCOOSYSTEM@1.1:INTEGERinfalse the index of the prescription in the prescription block
allowedCOOSYSTEM@1.1:BOOLEANoutfalse the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckPrescriptionsForm

This action is used to check the user input when doing prescriptions to other users, if it is valid and complete. It is called by the property editor, after the input is saved and before the form is closed and the input is committed, to verify the user input. It is expected to return an appropriate error, if problems are found.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTinfalse
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowParticipantoutfalse
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
prescriptionsCOOWF@1.1:WorkFlowPrescriptionListintrue
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue

Additional Information

Prototype: COOATTREDIT@1.1:AttrCheckPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckSimplePrescriptionsForm

Check the entered values in the simple prescription editor
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTinfalse
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowParticipantoutfalse
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue
prescriptionCOOWF@1.1:WorkFlowPrescriptionListintrue
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListintrue

Additional Information

Prototype: COOATTREDIT@1.1:AttrCheckPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ConvertPrescription

ParameterTypeIn/OutOptionalDescription
needsingleCOOSYSTEM@1.1:BOOLEANinfalse
prescrlistCOOWF@1.1:WorkFlowPrescriptionListin/outtrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

COOWF@1.1:ExtractSubPrescription

Converts a subprescription to a prescription
ParameterTypeIn/OutOptionalDescription
sourceCOOWF@1.1:WorkFlowSubPrescriptionListinfalse
extractedprescriptionCOOWF@1.1:WorkFlowPrescriptionListoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescribeTemplate

Gets the parsed and resolved prescription template
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListoutfalse the prescription
prescrparallelCOOSYSTEM@1.1:BOOLEANoutfalse the prescrparallel
prescrbackCOOSYSTEM@1.1:OBJECTin/outfalse the prescrback
prescrblocksCOOWF@1.1:WorkFlowPrescriptionBlockListouttrue the prescrblocks
prescrblocksonlyCOOSYSTEM@1.1:BOOLEANintrue the prescrblocksonly
selobjectsCOOSYSTEM@1.1:OBJECTLISTintrue the selobjects
edittemplateCOOSYSTEM@1.1:BOOLEANintrue the edittemplate

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescriptionHeadLine

Get title for prescription editor
ParameterTypeIn/OutOptionalDescription
headlineCOOSYSTEM@1.1:STRINGoutfalse the headline
labelCOOSYSTEM@1.1:STRINGoutfalse
prescrlabelCOOSYSTEM@1.1:STRINGoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:MovePrescription

Moves a prescription entry from the source index position to the destination index position. It is possible to convert a subprescription to a normal prescription ande vice versa. If no source index is supplied a new prescription will be created at the destiantion. If no destination index is supplied the prescription at source index will be removed. If no source and no target index is supplied a new prescription will be created at the end.
ParameterTypeIn/OutOptionalDescription
srcindicesCOOSYSTEM@1.1:INTEGERLISTin/outfalse the source index consists of blockid, prescriptionid, subblockid and subprescriptionid the subblock indices can be skipped
dstindicesCOOSYSTEM@1.1:INTEGERLISTin/outfalse the destination index consists of blockid, prescriptionid, subblockid and subprescriptionid the subblock indices can be skipped
modeCOOWF@1.1:SavePresciptionActionTypeinfalse defines if the prescription will be enclosed into a block or be inserted parallel.
afterCOOSYSTEM@1.1:BOOLEANinfalse defines if the operation will be performed before or after the destination index.
updatedprescriptionCOOWF@1.1:WorkFlowPrescriptionListintrue the source index will be updated with this value if the mode is set to update

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:NormalizeNestedPrescriptions

Normalize nested prescription of an activity instance. Try to transform nested prescriptions to own prescription blocks to increase readability of complex prescriptions
ParameterTypeIn/OutOptionalDescription
blocksCOOWF@1.1:WorkFlowPrescriptionBlockListin/outfalse the prescription blocks which should be normalized. If no blocks are supplied the blocks are read from the object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RemovePrescription

Removes a prescription
ParameterTypeIn/OutOptionalDescription
prescriptionCOOWF@1.1:WorkFlowPrescriptionListin/outfalse the prescription
pblockidxCOOSYSTEM@1.1:INTEGERin/outtrue the pblockidx
pidxCOOSYSTEM@1.1:INTEGERin/outtrue the pidx

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true


[top]

COOWF@1.1:ResolveDistributionList

Resolve distribution list to single prescription blocks
ParameterTypeIn/OutOptionalDescription
prescriptionblocksCOOWF@1.1:WorkFlowPrescriptionBlockListin/outfalse the prescription blocks which include distribution lists to resolve
persistCOOSYSTEM@1.1:BOOLEANintrue the resolved prescriptionblocks are stored on the object. In case of no supplied prescriptionblocks the prescriptionblocks are read from the object.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]