You are here:
Rebate Orchestration Flow
Run the Rebate Orchestration Flow to calculate rebate amounts and process payouts. It includes other predefined Rebate flows as subflows. The flow searches for data processing engine definitions with Process Type as Rebates and triggers the aggregation of data. Then, the flow runs the calculation process to generate member payout amounts.
Required Editions
| Available in: Enterprise, Unlimited, and Developer Editions that have Rebate Management enabled. |
The Rebate Orchestration Flow has these components:
| Template | Purpose | Additional Details |
|---|---|---|
| Run Rebate DPE Jobs | Runs all active data processing engine definitions to generate aggregate records. To be included in this flow, the Process Type of a data processing engine definition must be set to Rebates |
Use this flow to automatically run applicable data processing engine definitions at periodic intervals. |
| Run Rebate Payout Calculations | Calls the Calculate Rebate Payout batch management job to calculate the rebate payout amount from aggregated records, and update the rebate payout data in the Program Rebate Type Payout Source, Program Rebate Type Payout, and Rebate Program Member Payout objects. |
Use this flow to get visibility into the as on date or most current rebate amount, before the final payout calculation date for a period arrives. The calculation takes the most current values in the aggregate object to update the payout amounts in various objects, then finalizes the values when the payout calculation date arrives. |
| Calculate Rebate Amount | This flow is called by the Calculate Rebate Payout batch management job to process aggregate records and generate rebate payouts. The batch management job processes the records in manageable chunks. | — |
| Run Rebate Post Payout Actions | Runs a series of actions to ensure that member payout records are closed on the payout calculation date for each period. | When the payout calculation date for a period arrives, the payout status is set to Calculated and the payout period is set to Closed. |
Objects Updated by the Rebate Orchestration Flow
When the flow runs, it aggregates transaction data and updates payout-related records.
The flow updates these objects:
- Rebate Member Product Aggregate — Stores aggregated transaction data used for payout calculations.
- Rebate Member Aggregate Item — Stores transaction-level details contributing to aggregates.
- Rebate Program Member Payout — Stores calculated payout amounts for each member.
- Program Rebate Type Payout Source — Stores payout breakdown by rebate type.
- Program Rebate Type Payout — Stores payout values at the rebate type level.
- Rebate Program Payout Period — Updated when payout processing completes.
The Rebate Orchestration Flow can complete successfully and update the Rebate Program Payout Period status to Closed without generating payout records.
Rebate Program Member Payout records are generated only when:
- At least one Rebate Benefit is defined for the rebate type.
- Rebate Member Product Aggregate records are created by the DPE.
Payout records aren’t generated if aggregates aren't created because of a mismatch between the Program Rebate Type and the associated DPE definition.
