Interface ReviewUserGroupsParallelSubStep

All Superinterfaces:
IsSequentialSubStep

public interface ReviewUserGroupsParallelSubStep extends IsSequentialSubStep
A parallel group of review sub-steps in a ReviewStepDefinition of a Creation Workflow. All branches of the group are active at the same time, and the group as a whole occupies one position in a sequence of sub-steps.

You get an instance from api.newReviewParallelSubSteps(...). Its branches are objects that implement IsParallelSubStep: single review sub-steps created by api.newReviewSubStep(), or sequences created by api.newReviewSequentialSubSteps(...).

The group implements IsSequentialSubStep, so you place it in a sequence: in ReviewByUserGroups.withSequentialSubSteps(IsSequentialSubStep...) or in a sequence created by api.newReviewSequentialSubSteps(...). To run sub-steps in parallel directly at the top level, use ReviewByUserGroups.withParallelSubSteps(IsParallelSubStep...) instead.

The following rules are checked when the Creation Workflow runs:

  • Nested parallel sub-steps are not allowed: a sequence used as a parallel branch must not contain a parallel group.
  • Every single sub-step in the group must have a user group.
  • If the review step does not define line item filters and the group is the first position of a sequence, each branch must define its own line item filters. If the group is at a later position, its branches must not define any.

Example:


 // line item filters are defined on the review step
 api.newReviewByUserGroups()
     .withSequentialSubSteps(
         api.newReviewSubStep()
             .withUserGroup("SupplyCoordinator")
             .withLabel("Supply Coordinator"),
         api.newReviewParallelSubSteps(
             api.newReviewSubStep()
                 .withUserGroup("PricingAdvisor")
                 .withLabel("Pricing Advisor"),
             api.newReviewSubStep()
                 .withUserGroup("ChannelAnalyst")
                 .withLabel("Channel Analyst")
         )
     )
 
Since:
14.0 - Caribou Lou
See Also: