Package net.pricefx.common.dto

package net.pricefx.common.dto

Defining approval workflows, and chaining background jobs.

A workflow logic adds approval steps and watcher steps to a document's approval workflow, with their approvers and reasons. An approval step can name a post-step logic, which runs after the step and can insert another step right after it. A calculation flow can start a job when another job finishes.

Entry point: the binding of the logic that runs. A workflow logic gets workflow. A post-step logic that an approval step names gets currentWorkflow. A chained job is created with new.

A post-step logic can also run on a document that has no workflow logic. The postStepLogicsWhenNoWorkflowDefined advanced configuration option names that logic for each document type.

 // workflow logic
 workflow.addApprovalStep("Margin Approval")
         .withApprovers("admin")
         .withReasons("Margin below target")
 

 // calculation flow logic: calculate a Calculated Field Set after the price list
 import net.pricefx.common.dto.ChainedJobInfo

 def nextJob = new ChainedJobInfo()
 nextJob.setTargetObject("38.CFS")
 actionBuilder.addPricelistAction("Price List 1")
         .setNextJobs([nextJob])
         .setCalculate(true)
 

Reference

• WorkflowDTO defines the steps of an approval workflow. A workflow logic gets it as the workflow binding.
• InsertWorkflowStepsDTO inserts an approval step or a watcher step after the running post-step logic. The logic gets it as the currentWorkflow binding.
• ChainedJobInfo names a job that runs after another job finishes.

See Also:

• Approval Workflow Logic (Knowledge Base)
• Advanced Configuration Options (Approval Workflow) (Knowledge Base)
• How to Schedule Jobs with Dependencies (Knowledge Base)

Related Packages

Package	Description
net.pricefx.common.dto.creationworkflow	Defining the creation workflow of a document.

Classes

Class	Description
ChainedJobInfo	This class is a DTO that holds information about jobs that should be executed next.
InsertWorkflowStepsDTO	Lets a Workflow Post Step logic add approval or watcher steps to the running Approval Workflow.
WorkflowDTO	This class is basically the type of object, which is exposed in the workflow logic by the binding variable workflow
WorkflowDTO.ApprovalStepDTO	An approval step of the workflow: the document must be approved (or denied) by the step's approvers before the workflow continues with the next step.
WorkflowDTO.StepDTO<T extends WorkflowDTO.StepDTO>	Common base of the approval and watcher steps of a workflow.
WorkflowDTO.WatcherStepDTO	A watcher step of the workflow: its recipients are notified by email when the step becomes active, but they cannot approve or deny.