| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
You’re using You will use an Approval Workflow logic when you need to:
build Build approval or watcher steps for a document.
prePre-approve some steps, if they were have already been approved in the previous approval process.
Logic API
Logic Type: Workflow
Logic Nature: defaultDefault
Workflow Type: determinesDetermines, for which object will this logic will be used. The value is one of WorkflowTypes.
Logic Name: in case If the logic is intended for Quote Quotes you can change this its name. For all other workflow types, the logic name must be the same as the workflow type.
Execution Types:
Standard - to calculate and build the approval or watcher steps for the approval workflow.
Information provided to the logic
binding Binding variables:
workflow: WorkflowDTO - on this object you will build the steps.
submitter - username : Username of the user, who submitted the document.
currentWorkflow: InsertWorkflowStepsDTO
workflowHistory: WorflowInfo as Map - previously processed workflow, before it was denied. This is available only when an approver denies and then a user submits again.
claim | compensation | compensationrecord | contract | customform | dcr | dealplan | model | modelrecord | pricegriditem | pricelist | quote | rebateagreement | rebaterecord: Map - the content of the document to be approved.
approvable: Map - the content of the document to be approved. This is an alternative to the previous variable.
Expected logic execution outcome
the The elements results are not used by the system.
the The logic is supposed to build the Steps on the provided WorkflowDTO object. Each step should have:
typeType: Approver / Watcher
approvers Approvers: either Either one or more Users, or one or more User Groups (i.e., you cannot mix Users and User Groups).
number Number of approvers: how How many must approved. By default, one user is enough to approve the step.
reasons Reasons: reasons Reasons why the Users/Groups are requested to approved the document.
Mechanism of
selection, which logic is usedSelection, Which Logic Is Used
When an approval workflow logic is about to be executed, the engine will select the logic based on certain criteria. Besides standard things, like if the logic is active, there are also the following things decidingaspects that decide, which logic will be used:
type Type of document - some Some types of documents can have the workflow logic set up in their Type object:
Compensation Plan - approval Approval workflow logic can be specified in the Compensation Header Type (since version 8.0).
Compensation Record - approval Approval workflow logic can be specified in the Compensation Header Type (since version 8.0).
Custom Form - approval Approval workflow logic can be specified in the Custom Form Type (since version 9.0).
Deal Plan - the approval Approval workflow logic can be specified in the Plan Type (since version 8.0).
Quote - the approval Approval workflow logic can be specified in the Quote Type.
Rebate Agreement - approval Approval workflow logic can be specified in the Rebate Agreement Type (since version 8.0).
Rebate Record - approval Approval workflow logic can be specified in the Rebate Agreement Type (since version 8.0).
Logic’s Workflow Type - when When the Workflow logic is not set in the Type object, then the workflow logic is selected based on its Workflow Type.
validity Validity - the The logic’s Valid After will be compared to:
either to today,
or, if the advanced configuration property clicWorkflowByTargetDate is set, the system will use the first date of validity of the document (e.g. on quote it’s , in a Quote it’s the field targetDate).