ApprovalWorkflowService provides operations for managing approval workflows.
Approval workflows allow your company to create workflows to ensure that the processing of ad placements and orders adhere to your company guidelines. For example, if a sales person wants to create an order with discounts and your company policy is not to allow discounts on orders, your company could create an approval workflow that defines the process for obtaining an approval for the order.
You can set up separate approval workflows for in-network and cross-network orders and placements. Or, set up an approval workflow for both in-network and cross-network orders and placements. The in-network approval workflow is only for objects (orders and placements) created by an account that is in the same network as the network to which the approval workflow applies. The cross-network approval workflow is for objects (orders and placements) created by an account that is not in the network.
You can have an in-network approval workflow and a cross-network approval workflow simultaneously active. You cannot, however, have an approval workflow for both in-network and cross-network and an approval workflow for either in-network or cross-network simultaneously active.
The approval workflow defines:
- The approval category.
- The trigger (such as a discount being applied to an order).
- The type (such as InNetwork, CrossNetwork, or Both).
- The approval workflow execution type:
- In a parallel approval workflow, all individuals are notified when a trigger initiates an approval workflow.
- In a sequential workflow, the first individual in the approvers list is notified; after the individual approves the placement or order, the next individual is notified, and so on.
- The list of approvers who must review and approve the proposed order or placement.
- The approval notification process—how the individuals in the approval list are notified that an approval workflow has begun and requires their attention.
Not all triggers are applicable for all types of workflows. The following table describes the triggers that are available and supported for each type.
Approval Workflow Triggers
ApprovalWorkflowService provides operations for creating, updating, retrieving, activating, deactivating, and deleting approval workflows.
Create, Update, Retrieve, and Delete Approval Workflows
To create an approval workflow, use the addApprovalWorkflow operation and to create a list of approval workflows, use the addApprovalWorkflows operation.
To update an approval workflow, use the updateApprovalWorkflow operation and to update a list of approval workflows, use the updateApprovalWorkflows operation.
To retrieve an approval workflow, use the getApprovalWorkflow operation and to retrieve multiple approval workflows, use the getApprovalWorkflows operation. To retrieve the approval workflows for an account, use the getApprovalWorkflowsByAccountID operation.
To delete an approval workflow, use the deleteApprovalWorkflow operation and to delete a list of approval workflows, use the deleteApprovalWorkflows operation.
Activate and Deactivate Approval Workflows
To activate an approval workflow, use the activateApprovalWorkflow operation and to activate a list of approval workflows, use the activateApprovalWorkflows operation.
Note: At any given time, a network can have only one approval workflow in an active state for a specific trigger.
To deactivate an approval workflow, use the deactivateApprovalWorkflow operation and to deactivate a list of approval workflows, use the deactivateApprovalWorkflows operation.
Note: If you deactivate an approval workflow while an approval is in process, the approval workflow continues until it is approved or denied.