Page Comparison

{noprint}{float:right|width=300px|background=lightgrey|border=solid blue 2px|margin=10px|padding=8px}
*Contents*
{toc:all=true|depth=4|excerpt=true|indent=14px}
{float}{noprint}


|| Code \\
\\
_Code of the Bundle as seen in the GUI._ | AMOUNT-CAP \\ ||
|| Description \\  \\
_Short description of the Bundle, e.g. what does it aim at._ | 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. \\
The bundle also includes a few different ways to discount as well.  \\ ||
|| Business scenario | See examples ||
|| Applies to \\  \\
_Types of   traffic (plan elements) that the bundle should be associated with._ | No limitations ||
|| Core info \\  \\
_Is this bundle available in Core? If yes, specify which version._ | Available only infrom version 1.3 of the Rator-bundles project (from version 1.3). ||

h2. 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 ||

h2. 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.

{info:title=Please note}
Give the bundle a high priority (low number) as other bundles should likely be used before this one
{info}

h3. 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 \\ |
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 || Code || Default || Description ||
| Discounting \\ | Zero rate discount line | DECREASE_AMOUNT \\ | 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 | CREATE_NEGATED_LINE \\ | | Discounts by creating a detail line with an opposite sign and adding it to the rating result. |


h2. Parameters

The parameters available for the Amount Cap Bundle are described in the Strategies section.



h2. Examples

h4. 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.