Guideline on Quick start of Yeti¶
Yeti is user-friendly application and it very easy for configuration. You can see this by looking at the diagram of dependencies between objects :)
This Guideline contains step-by-step description of Yeti’s configuration that will help to start it quickly just after finishing of the installation process. For configuration purposes Yeti Web interface could be used.
Chapter 1. Basic configuration¶
In this Chapter we’ll configure Yeti for receiving calls on IP address 127.0.0.1 (any port, UDP) and switching them (in case if B-number starts from 380) to the Gateway with IP address 128.0.0.1.
Step 1. Creation of Contractors
At the first step it is necessary to configure two Contractor’s records: one with type Customer and second with type Vendor. Both records should be Enabled.
| Field name | Customer | Vendor |
|---|---|---|
| Name | Contractor A | Contractor B |
| Enabled | True | True |
| Vendor | False | True |
| Customer | True | False |
Step 2. Creation of Accounts
At the second step it is necessary to configure two Account’s records: one will be linked to Contractor A (Customer) and second will be linked to Contractor B (Vendor). You should also set Max balance parameter for the Vendor to the some value that allow to make a call (current balance will be less than Max balance value). In our example we’ll set 100 monetary units.
| Field name | Customer | Vendor |
|---|---|---|
| Name | Account A | Account B |
| Contractor | Contractor A | Contractor B |
| Max balance | 0 | 100 |
Step 3. Creation of Gateways
At the third step it is necessary to configure two Gateway’s records: one will be linked to Contractor A (Customer) and second will be linked to Contractor B (Vendor). Both records should be Enabled. It is also important to allow origination at the Gateway A and termination to the Gateway B.
| Field name | Customer | Vendor |
|---|---|---|
| General | Tab | |
| Name | Gateway A | Gateway B |
| Enabled | True | True |
| Contractor | Contractor A | Contractor B |
| Allow origination | True | False |
| Allow termination False | True | |
| Signaling | Tab | |
| Host | 128.0.0.1 | |
Step 4. Creation of Routing plan, Routing group and Dialpeer
At the fourth step it is necessary to configure:
at least one Routing Group’s record;
Example of records filling¶ Field name Value Name My RoutingGroup at least one Routing Plan’s record that is associated with Routing Group above;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Name My RoutingPlan Routing groups My RoutingGroup at least one Dialpeer’s record that should be associated with Routing Group, Vendor, Vendor’s Account and Vendor’s Gateway that were configured above. In our example we use 380 (international code of Ukraine) as Prefix and we’ll pay one monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 2 monetary units during initial interval. This Dialpeer will be used as a route for all traffic to ukrainian numbers;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Prefix 380 Enabled True Routing group My RoutingGroup Vendor Contractor B Account Account B Initial Rate 2 Next Rate 1 Gateway Gateway B
Step 5. Creation of Rateplan and Destination
At the fifth step it is necessary to configure:
at least one Rateplan’s record;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Name My RatePlan at least one Destination’s record that should be associated with with Rateplan above. In our example we also use 380 (international code of Ukraine) as Prefix and we’ll receive 1.5 monetary units per minute from Customer after the initial interval and 3 monetary units during initial interval. So, in case of call with ten minutes length the profit will be (3-2)+(10-1)*(1.5-1) = 5.5 monetary units (16.5 will be received from the Customer and 11 will be paid to the Vendor);
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value New Destination Section Prefix 380 Enabled True Rateplan My RatePlan Fixed rating Section Initial rate 3 Next rate 1.5
Step 6. Creation of Customer Auth
At the sixth step it is necessary to configure at least one Customers Auth’s record that should be associated with Customer, Customer’s Account and Customer’s Gateway, Rateplan and Routing Group that were configured above.
| Field name | Value |
|---|---|
| General | Tab |
| Name | My CustomerAuth |
| Customer | Contractor A |
| Account | Account A |
| Gateway | Gateway A |
| Rateplan | My RatePlan |
| Routing plan | My RoutingPlan |
Step 7. Test the call
At the last step it is necessary to create some Payment’s record for topping up the balance of Account A and test the call (Customer’s balance should be greater than Min balance value).
| Field name | Value |
|---|---|
| Account | Account A |
| Amount | 50 |
Fot the call testing it is necessary to fill Routing Simulation form and to press Simulate routing button.
| Field name | Value |
|---|---|
| Remote ip | 127.0.0.1 |
| Remote port | 10000 |
| Src number | 001234567890 |
| Dst number | 380662296132 |
As a result two records will be shown, where the first record is an actual record of Call Profile that will be send to the Yeti/SEMS node for making call. Full log of call processing also will be shown under the resulting records.
Note
If you don’t see necessary results, please, make sure that you enter everything correctly.
Chapter 2. Additional Dialpeer¶
In this Chapter we’ll improve basic configuration that is described in Chapter 1 above by adding new Dialpeers that will help to spend less money for calling to the alternative routes.
In our new example the same Vendor (Contractor B from basic configuration) proposed us special price for all calls that will be made to the numbers that start from 38048 (regional code of Odessa city in Ukraine).
Step 1. Creation of additional Dialpeer
At the first step we’ll configure one additional Dialpeer’s record that should be associated with Routing Group, Vendor, Vendor’s Account and Vendor’s Gateway that were configured in Chapter 1 above. In our example we use 38048 as Prefix and we’ll pay 0.5 monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 1 monetary units during initial interval;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Prefix 38048 Enabled True Routing group My RoutingGroup Vendor Contractor B Account Account B Initial Rate 1 Next Rate 0.5 Gateway Gateway B
Step 2. Test the call
Fot the call testing it is necessary to fill Routing Simulation form and to press Simulate routing button.
| Field name | Value |
|---|---|
| Remote ip | 127.0.0.1 |
| Remote port | 10000 |
| Src number | 001234567890 |
| Dst number | 380487050321 |
As a result two records will be shown, where the first record is an actual record of Call Profile that will be send to the Yeti/SEMS node for making call. This Call Profile has Initial and Next Rates of Dealpeer that was newly created. Full log of call processing also will be shown under the resulting records. In our example we’ll still receive 1.5 monetary units per minute from Customer after the initial interval and 3 monetary units during initial interval, but will pay less to the Vendor. So, in case of call with ten minutes length the profit will be (3-1)+(10-1)*(1.5-0.5) = 11 monetary units (16.5 will be received from the Customer and 5.5 will be paid to the Vendor).
Note
If you don’t see necessary results, please, make sure that you enter everything correctly.
Chapter 3. Alternative Gateway for calls to the specific numbers¶
In this Chapter we’ll improve configuration that is described in Chapter 1 above by adding new Vendor’s Gateway that will be used for terminating calls that are sent to the specific numbers (to the numbers that start from 38048705).
Step 1. Creation of new termination Gateway
At the first step we’ll configure one additional termination Gateway’s record that will be linked to Contractor B (Vendor).
| Field name | Value |
|---|---|
| General Tab | |
| Name | Gateway C |
| Enabled | True |
| Contractor | Contractor B |
| Allow origination False | |
| Signaling Tab | |
| Host | 129.0.0.1 |
Step 2. Creation of additional Dialpeer
At the second step we’ll configure one additional Dialpeer’s record that should be associated with Routing Group, Vendor, Vendor’s Account that were configured in Chapter 1 above and also with Vendor’s Gateway C that was configured at Step 1 above. In our example we use 38048705 as Prefix and we’ll pay 0.5 monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 1 monetary units during initial interval;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Prefix 38048705 Enabled True Routing group My RoutingGroup Vendor Contractor B Account Account B Initial Rate 1 Next Rate 0.5 Gateway Gateway C
Step 3. Test the call
Fot the call testing it is necessary to fill Routing Simulation form and to press Simulate routing button.
| Field name | Value |
|---|---|
| Remote ip | 127.0.0.1 |
| Remote port | 10000 |
| Src number | 001234567890 |
| Dst number | 380487050321 |
As a result two records will be shown, where the first record is an actual record of Call Profile that will be send to the Yeti/SEMS node for making call. This Call Profile uses Gateway C for termination the call. Full log of call processing also will be shown under the resulting records.
Note
If you don’t see necessary results, please, make sure that you enter everything correctly.
Chapter 4. Origin based billing¶
In this Chapter we’ll improve configuration that is described in Chapter 1 above by adding origin based billing. In our example we’ll configure lower price (0.25 monetary unit per minute after the initial interval and 0.5 monetary units during initial interval) for calling to Ukraine (to the numbers that start from 380) from France (from the numbers that start from 33).
Step 1. Adding Areas and Area Prfixes
At the first step it is necessary to configure:
two Area’s records (one for France and one for Ukraine);
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Value Name France Ukraine two Area prefix’s records that should be associated with Areas above.
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Value Prefix 33 380 Area France Ukraine
Step 2. Adding Routing Tag and Routing Tag Detection Rule
At the second step it is necessary to configure:
- two Routing Tag’s records - one for describing all calls to Ukraine and one for describing calls from France to Ukraine only;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Value Name From_FR_to_UA to_UA
- two Routing Tag detection Rule’s records;
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Value Src area France
Dst area Ukraine Ukraine Tag action Append selected tags Append selected tags Tag action value From_FR_to_UA to_UA
Step 3. Creation of new Destination and editing of existing
At the third step we’ll configure Destination’s record that should be associated with Rateplan that was configured in Chapter 1 above. In our example we will use 380 as Prefix and we’ll receive 0.25 monetary units per minute from Customer after the initial interval and 0.5 monetary units during initial interval. So, in case of call with ten minutes length the lesion will be (0.5-1)+(10-1)*(0.25-0.5) = -2.75 monetary units (2.75 will be received from the Customer and 5.5 will be paid to the Vendor).
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value New Destination Section Prefix 380 Enabled True Rateplan My RatePlan Routing tag ids From_FR_to_UA Fixed rating Section Initial rate 0.5 Next rate 0.25
Also at this step it is necessary to edit Destination’s record that was configured in Chapter 1 above by adding to_UA Routing Tag’s to the Routing tag ids field.
Step 4. Changing the Dialpeer
At the fourth step we’ll edit Dialpeer’s record that was configured in Chapter 1 above. It is necessary to change Routing tag ids to the value any tag.
Step 5. Test the call
Fot the call testing it is necessary to fill Routing Simulation form and to press Simulate routing button.
| Field name | Value |
|---|---|
| Remote ip | 127.0.0.1 |
| Remote port | 10000 |
| Src number | 331234567890 |
| Dst number | 380487050321 |
As a result two records will be shown, where the first record is an actual record of Call Profile that will be send to the Yeti/SEMS node for making call. This Call Profile uses newly created Destination as a basis for Customer’s billing. Full log of call processing also will be shown under the resulting records.
Note
If you don’t see necessary results, please, make sure that you enter everything correctly.
Chapter 5. Emergency calls¶
In this Chapter we’ll change configuration that is described in Chapter 1 above by adding possibility to make free call to the emergency number (112) even in case of zero balance of Customer’s account.
Step 1. Editing of the Customer Auth record
At the first step it is necessary to edit Customers Auth’s record that was configured in Chapter 1 above by disabling Check account balance flag.
Step 2. Adding new Destination for emergency calls
At the second step we’ll configure Destination’s record that should be associated with Rateplan that was configured in Chapter 1 above. In our example we will use 112 as Prefix and we’ll receive 0 monetary units per minute from Customer after the initial interval and 0 monetary units during initial interval. It is also important to set value of the Profit control mode field into the no control value.
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value New Destination Section Prefix 112 Dst number min length 3 Dst number max length 3 Enabled True Rateplan My RatePlan Fixed rating Section Initial rate 0 Next rate 0 Profit control mode no control
Step 3. Creation new Dialpeer for emergency calls
At the third step we’ll configure one additional Dialpeer’s record that should be associated with Routing Group, Vendor, Vendor’s Account, Vendor’s Gateway B that were configured in Chapter 1. In our example we use 112 as Prefix and we’ll pay 0 monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 0 monetary units during initial interval.
Example of records filling (only fields that should be changed from default values are shown)¶ Field name Value Prefix 112 Dst number min length 3 Dst number max length 3 Enabled True Routing group My RoutingGroup Vendor Contractor B Account Account B Initial Rate 0 Next Rate 0 Gateway Gateway B
Step 4. Test the call
Fot the call testing it is necessary to fill Routing Simulation form and to press Simulate routing button.
| Field name | Value |
|---|---|
| Remote ip | 127.0.0.1 |
| Remote port | 10000 |
| Src number | 331234567890 |
| Dst number | 112 |
As a result two records will be shown, where the first record is an actual record of Call Profile that will be send to the Yeti/SEMS node for making call. This Call Profile uses newly created Destination’s and Dialpeer’s records as a basis for Customer’s and Vendor’s billing and will work also in case zero balance of Customer’s Account. Full log of call processing also will be shown under the resulting records.
Note
If you don’t see necessary results, please, make sure that you enter everything correctly.