Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 65 Next »

 Table of Contents

You’re using Approval Workflow logic when you need to:

  • build approval or watcher steps for a document

    • pre-approve some steps, if they were already approved in the previous approval process

Logic API

  • Logic Type: Workflow

  • Logic Nature: default

  • Workflow Type: determines, for which object will this logic be used. The value is one of

    • claim

    • contract

    • dcr

    • dealplan

    • modelrecord

    • pricegriditem

    • pricelist

    • quote

    • rebateagreement

    • rebaterecord

  • Logic Name: in case logic for Quote you can change this 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 variables:

      • workflow : WorkflowDTO - on this object you will build the steps

      • submitter - 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 approver denies and then a user submits again.

      • approvable : Map - the content of the document to be approved. This is an alternative way to the next variable.

      • quote | pricegriditem | rebateagreement | contract | dcr | pricelist | rebaterecord : Map - the content of the document to be approved

  • Expected logic execution outcome

    • the elements results are not used by the system

    • the logic is supposed to build the Steps on the provided WorkflowDTO object. Each step should have:

      • type: Approver / Watcher

      • approvers : either one or more Users, or one or more User Groups (i.e. you cannot mix Users and User Groups)

      • number of approvers : how many must approved. By default one user is enough to approve the step.

      • reasons : reasons why the Users/Groups are requested to approved the document.

Mechanism of selection, which logic is used

When an approval workflow logic is about to be be calculated, the engine will select the logic based on certain criteria. Besides standard things, like if the logic is active, there are also following things deciding, which logic will be used:

  • type of document

    • Deal Plan - the approval workflow logic can be specified in the Plan Type (since version 8.0)

    • Quote - the approval workflow logic can be specified in the Quote Type

    • Rebate Agreement - approval workflow logic can be specified in the Rebate Agreement Type (since version 8.0)

    • Rebate Record - approval workflow logic can be specified in the Rebate Agreement Type (since version 8.0)

    • other - the logic is selected based on its Workflow Type.

  • validity - 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 first date of validity of the document (e.g. on quote it’s field targetDate)

Code sample

  • No labels

Found an issue in documentation? Write to us.