Proportional Distribution
Proportional Distribution
The ProportionalDistribution
operation performs distribution of call processing
down one or more exit paths according to a configured ratio/proportion for
each exit path.
The ProportionalDistribution
operation must have at least one exit. The
ProportionalDistribution
operation is only useful when it has more than one exit,
although this is not enforced by the operation definition.
Config Parameters
The ProportionalDistribution
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
rules
|
Array of Object |
[Required] The rules Array must contain one or more Objects.
|
Config Rules
A ProportionalDistribution
operation rules
Object is as follows.
Parameter | Type | Description |
---|---|---|
proportion
|
Integer | The relative proportion of calls that should be routed down the associated index. |
exit_idx
|
Integer | The zero-based index number down which to route this proportion of calls. |
Note that the sum of proportion
values does not need to add up to 100.
Example Operation
Here is an example ProportionalDistribution
operation in JSON representation.
{
"id": 5,
"type": "ProportionalDistribution",
"base_node": 1,
"config": {
"rules": [
{ "proportion": 50, "exit_idx": 0 },
{ "proportion": 50, "exit_idx": 1 }
]
},
"exits": [ 4, 17 ]
}
In this example, 50% of calls will proceed down exit index 0
to operation ID 4
, while
the other 50% of calls will proceed down exit index 1
to operation ID 17
.
Exits
In general, the user interface should ensure that the entries in exits
match 1:1 with the configured rules
, although this is not enforced by
the operation definition.
Exit Index | Name | Description |
---|---|---|
0
|
Proportion #1 |
[Required]
All ProportionalDistribution operations must have at least one exit.
|
1
|
Proportion #2 + | Additional exits may be present |