Summary
A ZAB Revenue Configuration may include multiple ZAB Revenue Configuration Fields Maps.
- Each Revenue Configuration Field Maps has a Summary Type associated with it.
- A Summary Type of 'Group' determines how ZAB Charges are grouped together to create ZAB Revenue Detail records.
- ZAB Revenue Configuration Maps with a Summary Type of “Group” can be referred to as 'Rev Config Groupings'.
Adding a new Rev Config Grouping to an existing Revenue Configuration is never recommended due to possible, unintentional, revenue-impacting consequences.
Impact of Adding a Rev Config Grouping
The Rev Config Groupings are used to generate a 'Unique Key' for each ZAB Revenue Detail record.
- When a Rev Config Grouping is changed or added, the 'Unique Key' is subsequently altered.
- Each ZAB Charge that is processed through the Update Revenue Details process will either be assigned to a current ZAB Revenue Detail record or create a new ZAB Revenue Details based on the Unique Key.
- Adding a Rev Config Grouping to an in-flight Revenue Configuration will not automatically trigger that Subscription to be processed via Update Revenue Details.
- A given ZAB Subscription will only be processed through Update Revenue Details if a related ZAB Charge or ZAB Subscription Item has been modified since the last time that the Revenue Order was successfully updated (Date Last Detail Sync field on the ZAB Revenue Order).
Note: in the example below, the Unique Keys are made up in order to help follow the example. In actuality, these keys are disguised as alpha-numeric keys that are not discernible through the UI.
Note: When a Rev Config Grouping is added to a Revenue Configuration, a given Subscription will not run through the Update Revenue Details process based on that addition alone.
Example
- A Revenue Configuration is created with two Revenue Configuration Groupings:
- Charge Item
- A custom field on the Subscription Item called 'Color'
- A Subscription is created using that Revenue Configuration, with two Subscription Items:
- Subscription Item 1
- 12 Charges
- Charge Item = ItemABC
- “Color” = Blue
- Subscription Item 2
- 12 Charges
- Charge Item = ItemABC
- “Color” = Red
- Subscription Item 1
- When Update Revenue Details is run, two Revenue Details are generated:
- Revenue Detail 1
- Unique Key representing 'ItemABC_Blue'
- Revenue Detail 2
- Unique Key representing 'ItemABC_Red'
- Revenue Detail 1
Updating a Source Field Value:
Using the above example:
- Subscription Item 2 is updated, and the 'Color' is changed to 'Blue'
- When Update Revenue Details is run,
- The original Revenue Detail for Subscription Item 2 is deleted.
- The Revenue Detail for Subscription Item 1 is updated, and all Charges from Subscription Item 2 are associated with this Revenue Detail.
Adding a Rev Config Grouping:
Expanding on the example above, a new Revenue Configuration Field Map for 'Subscription Item' (Summary Type = 'Group') is added as to the selected Revenue Configuration.
- The new grouping added will cause the Revenue Detail Unique Keys to generate as:
- Subscription Item 1: “ItemABC_Blue_SubItem1”
- Subscription Item 2: “ItemABC_Blue_SubItem2”
- Because no ZAB Revenue Detail records exist with these Unique Keys,
- Two new Revenue Details are created.
- The existing Revenue Detail will no longer have charges associated with it and will become inactive (and be deleted).