...
Code | AMOUNT-CAP |
|---|---|
Description | This bundle has the capacity of discounting invoice detail lines or subscription fee lines (that apply to the bundle). The discounting does not happen until the limit defined in VALUE1 is reached. |
Business scenario | See examples |
Applies to | No limitations |
Core info | Available from version 1.3 of the Rator-bundles project. |
Values
The meaning and use of the values of this bundle are as follows:
Value1 | The maximum limit of usage inside the bundle. A Value1 of zero means unlimited |
|---|---|
Value2 | The current usage spent |
Value3 | Not used |
Value4 | Not used |
Logic
The bundle starts by forwarding the rating in order to get invoice detail lines or subscription fee lines (mentioned as "detail lines" from here on) returned. Afterwards, it processes the result of the actual rating. Value2 is incremented, until it reaches Value1. The value processed is the total monetary amount of the detail lines returned by the rating, with respect to the configured detail line value strategy.
| Info | ||
|---|---|---|
| ||
Give the bundle a high priority (low number) as other bundles should likely be used before this one |
Strategies
The Amount Split Bundle implements different strategies for its three main functionalities:
Main strategy | Key | Description |
|---|---|---|
Discounting | DISCOUNT_STRATEGY | Defines how a discount should be processed |
| Value of detail lines | CALCULATE_IDL_VALUE_STRATEGY | Defines how the value of detail lines is calculated |
All strategy types are defined using the bundle parameters as used by many other bundle types (i.e. DISCOUNT_STRATEGY=CREATE_NEGATED_LINE).
...
The current
...
implementations
...
of
...
the
...
main
...
strategies
...
are:
...
Main |
|---|
...
strategy |
|---|
...
Strategy |
|---|
...
name | Name | Default | Description | |
|---|---|---|---|---|
Discounting | Zero rate discount line | DecreaseDiscountLineValueStrategy | Yes | Discounts the detail line by decreasing the total value of the detail line. If the entire detail line is outside the bundle the detail line will be zero rated. |
Discounting | Create negated discount lines | CreateNegatedDiscountLineStrategy |
| Discounts by creating a copy of the discounted detail line with an opposite sign and adding it to the rating result. Two optional arguments are provided: serviceCode and priceCode. |
| Discounting | Create customized negated discount line | WorkflowEnabledNegateDiscountLineStrategy | Discounts by creating a customized detail line, where amount to be discounted is set. The customized detail line is returned from workflow invoked by the hookpoint having static key "BUNDLE.STRATEGY.DISCOUNT.NEGATE". | |
| Value of detail lines | Total for billing group | CalculateDetailLinesValueForBillingGroup | Yes | The value of detail lines are calculated as a sum of total excl VAT and total VAT for the billing group in billing context (might be different for "normal" billing group if detail lines have been created for other billing group). |
| Value of detail lines | Total as percentage | CalculateDetailLinesValueByPercentage | The value of detail lines are calculated as a sum of total excl VAT and total VAT, regardless of billing group. The returned value is the configured percentage of the value of detail lines. |
Parameters
The parameters available for the Amount Cap Bundle are described in the Strategies section.
Examples
Cap Bundle
Scenario: A bundle is required that discounts all detail lines outside the bundle, after DKK 100 is reached. It discounts by zero-rating the usage outside the bundle and decreases the total value of the splitting detail line.
Create an Amount Split Bundle and configure it to react on the desired plan elements. Set Value1 to 100. No bundle parameters are necessary as the desired strategies are already selected by default.