Package net.pricefx.common.dto.creationworkflow

package net.pricefx.common.dto.creationworkflow

Defining the creation workflow of a document.

A creation workflow is the list of steps a document passes through while it is created. Quotes, Agreements & Promotions, Rebate Agreements and Compensation Plans support it. Each step has a label, assignees and watchers. A review step sends line items to user groups for review.

Entry point: PublicGroovyAPI.newCreationWorkflow(), built from steps that api.newCreationWorkflowStep() and api.newReviewStep() create. The creation workflow logic returns the finished workflow.

 def draft = api.newCreationWorkflowStep()
         .withLabel("Draft")
         .withUserAssignees("john.price")
 def check = api.newCreationWorkflowStep()
         .withLabel("Price Check")
         .withUserAssignees("admin")
         .withUserWatchers("john.doe")
 return api.newCreationWorkflow()
         .withSteps(draft, check)
 

Review sub-steps nest. api.newReviewSubStep() sends line items to one user group. api.newReviewSequentialSubSteps() runs sub-steps one by one, and api.newReviewParallelSubSteps() runs them at the same time. Each kind of group can sit inside the other.

Reference

• CreationWorkflowDefinition holds the steps of a creation workflow.
• CreationWorkflowStepDefinition is one step, with its label, assignees and watchers.
• ReviewStepDefinition is a step that sends line items to user groups for review.
• ReviewByUserGroups holds the review sub-steps of a review step.
• ReviewUserGroupSubStep sends line items to one user group for review.
• ReviewUserGroupsSequentialSubSteps runs review sub-steps one by one.
• ReviewUserGroupsParallelSubStep runs review sub-steps at the same time.
• IsSequentialSubStep marks a sub-step that can run in a sequence.
• IsParallelSubStep marks a sub-step that can run in parallel.

See Also:

• Creation Workflow Logic (Knowledge Base)

Related Packages

Package	Description
net.pricefx.common.dto	Defining approval workflows, and chaining background jobs.

Class	Description
CreationWorkflowDefinition	Defines a document Creation Workflow: the ordered list of steps in which users cooperate on creating a Quote, Agreement/Promotion, Rebate Agreement, or Compensation Plan before it is submitted for approval.
CreationWorkflowStepDefinition	Defines one step of a document Creation Workflow: its label, the users and user groups assigned to work on the document in this step, the watchers, and whether email notifications are sent.
IsParallelSubStep	Marker interface for review sub-steps that can run as one branch of a parallel group in a ReviewStepDefinition of a Creation Workflow.
IsSequentialSubStep	Marker interface for review sub-steps that can be placed in a sequence in a ReviewStepDefinition of a Creation Workflow.
ReviewByUserGroups	Defines which user groups review the line items in a review step of a Creation Workflow, and in which order.
ReviewStepDefinition	A step in the Creation Workflow where line items are sent for review.
ReviewUserGroupsParallelSubStep	A parallel group of review sub-steps in a ReviewStepDefinition of a Creation Workflow.
ReviewUserGroupsSequentialSubSteps	A sequence of review sub-steps in a ReviewStepDefinition of a Creation Workflow.
ReviewUserGroupSubStep	A sub step in the Creation Workflow where line items are sent for review by a particular user group.