291
MOR 8 MANUAL Release: 2009.10.01
MOR 8 MANUAL Release: 2009.10.01
MOR 8 Manual
Kolmisoft 2006-2009
2
It is IMPORTANT to note that this manual is compilation of
articles from our main data source: http://wiki.kolmisoft.com and
current info in this manual can be outdated.
In order to get newest info please use online wiki.
http://wiki.kolmisoft.com/
MOR 8 Manual
Kolmisoft 2006-2009
3
Introduction ..................................................................................................................................... 7 Who is this product designed for ...................................................................................................... 7 Supported Business Models ............................................................................................................. 7
How to make first call........................................................................................................................ 8 Concepts/Definitions ....................................................................................................................... 10
Billing Concepts ........................................................................................................................... 10 Billing Logic ................................................................................................................................. 11 Call explained .............................................................................................................................. 11 E.164 ......................................................................................................................................... 13 Rounding .................................................................................................................................... 13 Multi-Tax system ......................................................................................................................... 13 What is increment ........................................................................................................................ 15 What is PIN ................................................................................................................................. 15 ASR/ACD .................................................................................................................................... 16 Margin and Markup ...................................................................................................................... 16 What are callgroups and pickupgroups ............................................................................................ 17 Balance and Credit ....................................................................................................................... 17 Local Calls ................................................................................................................................... 18
Configuration ................................................................................................................................. 19 Mor.conf ..................................................................................................................................... 19 Configuration from GUI ................................................................................................................. 20 Global ........................................................................................................................................ 20 Registration ................................................................................................................................ 20 Invoices ...................................................................................................................................... 20 WEB Callback .............................................................................................................................. 21 Emails ........................................................................................................................................ 21 Various ....................................................................................................................................... 21 Tax ............................................................................................................................................ 22 Fax ............................................................................................................................................ 22 Google Maps ............................................................................................................................... 22 Backups ...................................................................................................................................... 22 API............................................................................................................................................. 22 Functionality ............................................................................................................................... 22 ReCAPTCHA................................................................................................................................. 23 Payments configuration ................................................................................................................ 28 Device configuration ..................................................................................................................... 28 Default device settings ................................................................................................................. 29 Accountant permissions ................................................................................................................ 31 Logo change ................................................................................................................................ 31 Currencies .................................................................................................................................. 31 Translations ................................................................................................................................ 33 Voicemail .................................................................................................................................... 34 Multi Server support ..................................................................................................................... 36 Emails ........................................................................................................................................ 37 Email variables ............................................................................................................................ 38
Number Manipulation ...................................................................................................................... 39 Definitions .................................................................................................................................. 39 How Number Manipulation works ................................................................................................... 39 Localization ................................................................................................................................. 43 Provider Rules ............................................................................................................................. 47 DID handling by Localization ......................................................................................................... 50 Number Manipulation Examples ..................................................................................................... 51
MOR 8 Manual
Kolmisoft 2006-2009
4
Block wrong short numbers with Localization ................................................................................... 53 LCR/Tariff change based on call prefix ............................................................................................ 54
Users ............................................................................................................................................ 56 Description .................................................................................................................................. 56 User types .................................................................................................................................. 56 User list ...................................................................................................................................... 56 User Details ................................................................................................................................ 58 User Blocking .............................................................................................................................. 60 Hide Users .................................................................................................................................. 61 User grouping .............................................................................................................................. 62 Why MOR does not allow to delete users ......................................................................................... 65
Tariffs ........................................................................................................................................... 66 Description .................................................................................................................................. 66 Directions and Destinations ........................................................................................................... 67 Destinations Groups ..................................................................................................................... 67 Block some Destination to User ..................................................................................................... 68 Day setup ................................................................................................................................... 68 Bulk change Tariffs for Users ......................................................................................................... 68 Entering Rates for Wholesale Tariff ................................................................................................. 69 Rate import from CSV................................................................................................................... 74 Advanced Rates ........................................................................................................................... 80 Entering Rates for Retail Tariff ....................................................................................................... 83 Custom Rates .............................................................................................................................. 84 Tariff Transformation .................................................................................................................... 84 Make Retail Tariff from Wholesale Tariff explained ............................................................................ 85 Why User can't check his Rates ..................................................................................................... 85
Providers/Devices ........................................................................................................................... 86 Devices....................................................................................................................................... 86 Device settings ............................................................................................................................ 88 Trunks ........................................................................................................................................ 93 CLIs ........................................................................................................................................... 94 ANI/CLI ban system ..................................................................................................................... 95 Duplicate call prevention ............................................................................................................... 95 Allow loss calls ............................................................................................................................ 96 Device groups ............................................................................................................................. 97 Call Flow ..................................................................................................................................... 98 Which codecs should I choose for devices ...................................................................................... 102 Providers ................................................................................................................................... 104 Terminators ............................................................................................................................... 106 Provider with ANI ........................................................................................................................ 107 Configure Provider which can make calls ........................................................................................ 108 Configure Provider with dynamic IP ............................................................................................... 108 Simultaneous call limitation .......................................................................................................... 109 PBX connection to MOR ................................................................................................................ 110
Payment gateways ......................................................................................................................... 112 PayPal ....................................................................................................................................... 112 Webmoney ................................................................................................................................. 115
Call Routing .................................................................................................................................. 118 LCR ........................................................................................................................................... 118 LCR Logic ................................................................................................................................... 119 Example .................................................................................................................................... 119 How to add Provider to LCR .......................................................................................................... 121 Call Routing by priority (Manual LCR) ............................................................................................ 121
MOR 8 Manual
Kolmisoft 2006-2009
5
Call routing per destination basis .................................................................................................. 122 How to route call to specific Destination through specific Provider ..................................................... 126 Block some Destination to User .................................................................................................... 126 LCR/Tariff change based on call prefix ........................................................................................... 126 Routing by Percent ...................................................................................................................... 128 Why call was not routed through other provider/trunk? ................................................................... 130
DIDs ............................................................................................................................................ 131 DID Management ........................................................................................................................ 131 Work flow for DID ....................................................................................................................... 135 DID Billing ................................................................................................................................. 136 DID Billing Time explained ........................................................................................................... 137 DIDs Usage ................................................................................................................................ 138 Example - Configuring DID to ring some Device .............................................................................. 138 Forward DID to External Number .................................................................................................. 142 How to charge DID on a monthly basis .......................................................................................... 143 DID handling by Localization ........................................................................................................ 143 DID Blocking .............................................................................................................................. 144 Dial Plans ................................................................................................................................... 145 Authorization by PIN ................................................................................................................... 145 Authorization by ANI ................................................................................................................... 148 Calling Card Dial Plan .................................................................................................................. 150
Additional functionality ................................................................................................................... 153 IVR system ................................................................................................................................ 153 IVR for Calling Cards ................................................................................................................... 157 Callback ..................................................................................................................................... 158 WEB Callback ............................................................................................................................. 163 Callback over Email ..................................................................................................................... 164 Click2Call ................................................................................................................................... 165 Callback setup example ............................................................................................................... 166 PBX Functions ............................................................................................................................ 170 Dial Local ................................................................................................................................... 171 Call Shop functionality ................................................................................................................. 172 Fax2Email .................................................................................................................................. 177 Recordings ................................................................................................................................. 181 PhoneBook ................................................................................................................................. 183 Speed Dials ................................................................................................................................ 185 Backup system ........................................................................................................................... 186 Data import ................................................................................................................................ 187 CDR Import ................................................................................................................................ 188 CDR Rerating ............................................................................................................................. 191 Online registration ...................................................................................................................... 193 Quick Forwards ........................................................................................................................... 195 Transfers with MOR ..................................................................................................................... 196 MOR API .................................................................................................................................... 197 API Configuration ........................................................................................................................ 198
Accounting .................................................................................................................................... 199 Accounting ................................................................................................................................. 199 Invoices ..................................................................................................................................... 201 Invoice configuration ................................................................................................................... 203 Pay Invoice with balance deduction ............................................................................................... 204 Invoice by CallerID...................................................................................................................... 205 Payments ................................................................................................................................... 206 Vouchers ................................................................................................................................... 209
MOR 8 Manual
Kolmisoft 2006-2009
6
Flat-Rates .................................................................................................................................. 212 Reporting...................................................................................................................................... 213
Active Calls ................................................................................................................................ 213 Users Calls ................................................................................................................................. 214 Users Finances ........................................................................................................................... 215 Loss Making Calls ........................................................................................................................ 215 Providers Statistics ...................................................................................................................... 216 Providers Calls ............................................................................................................................ 216 Quick Stats ................................................................................................................................ 217 Simultaneous Calls stats .............................................................................................................. 219 Calls by Source ........................................................................................................................... 219 Login Stats ................................................................................................................................. 221 Profit Stats ................................................................................................................................. 222 Country Stats ............................................................................................................................. 223 Realtime Stats ............................................................................................................................ 224 Google Maps integration .............................................................................................................. 226 Get Google Maps key ................................................................................................................... 227 Balance in phone ........................................................................................................................ 228
Troubleshooting ............................................................................................................................. 230 Action log .................................................................................................................................. 230 Call Tracing ................................................................................................................................ 231 Integrity Check ........................................................................................................................... 239 Hangupcause Codes .................................................................................................................... 240 Hangupcause Sounds .................................................................................................................. 241 Different code send to User compared to received from Provider ....................................................... 241 SIP debug info ............................................................................................................................ 242
Addons ......................................................................................................................................... 243 Calling Cards Addon .................................................................................................................... 243 Calling Card Groups .................................................................................................................... 246 Calling Card management ............................................................................................................ 248 Calling Card Dial Plan .................................................................................................................. 250 Online Calling Card Shop ............................................................................................................. 253 Calling Card setup example .......................................................................................................... 255 Sound files ................................................................................................................................. 263 Speed Dials for Calling Cards ........................................................................................................ 266 Callback and Calling Cards ........................................................................................................... 266 Card import from CSV file ............................................................................................................ 267 IVR for Calling Cards ................................................................................................................... 268 How to sell Calling Cards in e-commerce site .................................................................................. 269 Questions about Calling Cards ...................................................................................................... 269 Auto-Dialer Addon ....................................................................................................................... 270 Reseller Addon ........................................................................................................................... 275 Manual for Resellers .................................................................................................................... 276 SMS Addon ................................................................................................................................ 286 Recordings Addon ....................................................................................................................... 287 Mobile Number Portability Addon .................................................................................................. 290
MOR 8 Manual
Kolmisoft 2006-2009
7
Introduction Kolmisoft VoIP Softswitch with Billing and Routing MOR is an advanced system that enables alternative telecoms to provide flexible voice services, effectively manage service offerings and grow their voice businesses due to the systems stability and high traffic scalability. Kolmisoft System MOR integrates the core AAA functions Authentication, Authorization, and Accounting with vital functions that facilitate the effective management of all billing/routing-related processes:
Customers
Services
Finance
Services distribution
Reporting
Traffic partners
User rights On the business side, Kolmisoft System MOR makes possible the deployment of services with high-quality and flexibility within any VoIP business model; on the technical side the system maintains seamless performance at high and rapidly increasing traffic volume. The optimal combination of functions, the adaptability to every VoIP business model and rate-plan settings, as well as its stability, make Kolmisoft System MOR the absolute billing/routing and customer care solution for Voice Over Broadband/ IP
businesses worldwide.
Who is this product designed for
Kolmisoft System MOR is designed for premium performance and scalability; therefore, it is suitable for VoIP or Broadband service providers who:
plan for a full-scope VoIP business deployment
need to maintain medium, high or very high voice traffic volumes
differentiate on a first-class customer service
demand high reliability from their billing system
enjoy rapid business development and have outgrown their legacy billing systems
Supported Business Models
Kolmisoft System MOR is adaptable to telephony service providers' business models and custom
requirements for service configuration. Voice-over-IP and Voice-over-Broadband providers can configure different service types within all of the following basic business models:
Wholesale traffic origination/termination
Retail
Prepaid
Postpaid
Calling Cards
Corporate Clients
Residential Clients
Internet services
MOR 8 Manual
Kolmisoft 2006-2009
8
How to make first call
This small guide will show how to make first call after system installation.
Login
After you installed MOR from InstallCD open your web browser and enter in address field
http:///billing
Where is your servers' IP address. (How to find out servers IP address)
Press ENTER and MOR Login screen will open.
Login with:
Username: admin
Password: admin
If you see main MOR screen it means that system is ready to work.
Provider
In order to send calls you need to have Providers which would deliver your calls to telephone network
(PSTN).
To make life easier we preconfigured Kolmisoft as default Provider so you could start making calls at once.
In order to proceed you need to have some credit to make test call. To get such credit for testing, please contact us and send us your .
We will open you account and you will be able to start making calls at once!
NOTE: MOR is not limited to only one Provider. You can add your own Providers at will. But for the sake of simplicity we recommend to try Kolmisoft as provider for quick test calls.
http://wiki.kolmisoft.com/index.php/How_to_make_first_callhttp://wiki.kolmisoft.com/index.php/MOR_install_from_InstallCDhttp://wiki.kolmisoft.com/index.php/How_to_find_out_servers_IP_addresshttp://wiki.kolmisoft.com/index.php/Providershttp://www.kolmisoft.com/contacts/http://wiki.kolmisoft.com/index.php/Providers
MOR 8 Manual
Kolmisoft 2006-2009
9
Softphone
To make a real call you will need a softphone for quick test.
You can use your own which supports SIP or IAX2 protocol.
For the sake of simplicity we will show how to configure Idefisk 1.37 which is very small and easy-configurable.
First download from our server and install it. (It is for Windows OS.)
For Linux it can be downloaded here for MacOS here.
Use this manual to configure Idefisk with your and username/password as 101/101.
Dialing
After that enter some phone number into softphone and try to dial.
NOTE: enter number in international (E164 format). E.g. do not use any international prefixes, use country code + area code + number.
As example Lithuanian number is: 37063042439, where 370 - country code, 6 - area code (MOB network), all the rest - number.
NOTE: USA/Canada numbers should start with 1 (it is USA/Canada country code).
If you hear nothing - that means your softphone is not registered to the server.
If you hear message from Kolmisoft - that means you do not have account on our server (contact us to get it).
If you hear ringing - that means everything is ok.
Call Logs
After the call you can check your call in the system.
Go to: STATISTICS - Calls - Last Calls and you will see your call.
It will be already billed.
http://wiki.kolmisoft.com/index.php/Softphoneshttp://193.138.191.205/packets/idefisk137_installer.exehttp://www.zoiper.com/zclinux.phphttp://www.zoiper.com/downloads/free/mac/communicator/ZoiperCommunicatorFree-1.04_installer.dmghttp://wiki.kolmisoft.com/index.php/Idefisk_configurationhttp://www.kolmisoft.com/contacts/
MOR 8 Manual
Kolmisoft 2006-2009
10
Concepts/Definitions
Billing Concepts
This section is dedicated entirely for billing system. Here is configured the actual call-flow from user to provider(s).
Billing system is quite complex and there are a lot of concepts to grasp.
There are main parts from which billing in MOR consists. The most important are:
Providers
LCR
Directions
Destinations
Rates
Tariffs
Users
Devices
Providers - In old PSTN world they are called Trunks. These are your routes to outside world (out of your
VoIP network). Providers can be several types: Zap, SIP, IAX2, and H323. Type determines which technology is used to connect to Provider.
LCR - Least Cost Route. It's an entity which describes how calls should go through several Providers and in which order. Order can be determined by calls route's price, quality or manual priority.
Directions - In other words - Countries. Could also be satellite networks. They just describe direction to which the call is routed.
Destinations - these are more concrete concepts of the calls course. Let's say we are dialing number 37068547771. From this number MOR knows, that Direction is Lithuania, but Destination is Mobile network Bite. Destinations are determined by Prefix. Each destination has unique Prefix. The Prefix from the example is 370685.
Rates - these are the prices for Destinations. They have many properties from which the way they are calculated depends.
Tariffs - they are groups of Rates. Sometimes they are called Price Lists.
Users - User is the actual user of the system the client which dials out or receives calls. User can represent one person or whole company. User is main unit in the system. Most of the settings are associated with user.
Devices - Each user can have many devices. Device represents end-point where voice traffic should be sent. As example device can represent:
VoIP phone
VoIP softphone
PSTN phone (connected through FXS port)
http://wiki.kolmisoft.com/index.php/MOR_Manual#Concepts.2FDefinitionshttp://wiki.kolmisoft.com/index.php/Billing_Concepts
MOR 8 Manual
Kolmisoft 2006-2009
11
Billing Logic
In order to successfully use MOR for dialing out and billing some rules must be met.
Best way to show this is by example.
User A dials number trying to reach User B.
System takes User's A Tariff and LCR.
Then takes all Providers which belong to that LCR.
For every Provider system takes their Tariff.
From every Tariff based on Prefix - Rate is taken.
If LCR type is 'Price' then all Providers are sorted that first Provider would have lowest Rate to that Destination.
Then system tries to dial number using first Provider.
If call successful - system does billing and finishes session.
If call unsuccessful - system tries to dial next Provider in a row.
It repeats until call is successful or no Providers left.
When call ends - system bills it.
The whole process in MOR is much more complex. This example covers bare minimum to take grasp of how the billing system works.
Call explained
Duration - time from caller enters number till call end
Billsec - time from when callee answers the call till call end
See also:
Detailed MOR Call Flow
http://wiki.kolmisoft.com/index.php/Billing_Logichttp://wiki.kolmisoft.com/index.php/Call_explainedhttp://wiki.kolmisoft.com/index.php/Detailed_MOR_Call_Flow
MOR 8 Manual
Kolmisoft 2006-2009
12
MOR 8 Manual
Kolmisoft 2006-2009
13
E.164
What is E.164 format number? In short it's the number without international prefix which starts with country code, for more details check Wikipedia.
Every destination inside MOR should be in this format. That's one of the most important rules of the MOR. If destination is not in E.164 format it can't be billed correctly.
All DIDs in MOR should be in this format also. Do not include international prefixes for DIDs. Enter them in E.164 format.
Example: For instance, the local number 08 6311 3000 in Australia would be converted to E164 as 61863113000.
More info how MOR works with E.164 can be found here Number manipulation.
Rounding
Rounding in MOR GUI is done only when showing final result. All values are not rounded in database.
Why? Example: 0.027 + 0.027 = 0.054 rounded is 0.05, if you are rounding each step, then you get: 0.03 + 0.03 = 0.06 which is not so right as 0.05.
Multi-Tax system
All prices and rates in MOR are without TAXES. That's a rule. Each user has TAX percent. By this TAX percent he gets charged when he makes payments or views his rates.
Multi-Tax system allows to have several taxes in final reports for users.
As example we can take Canada which has GST and PST taxes which should be shown on Invoices/Reports/etc.
http://wiki.kolmisoft.com/index.php/E.164http://en.wikipedia.org/wiki/E.164http://wiki.kolmisoft.com/index.php/Number_Manipulationhttp://wiki.kolmisoft.com/index.php/Roundinghttp://wiki.kolmisoft.com/index.php/Multi-Tax_system
MOR 8 Manual
Kolmisoft 2006-2009
14
Taxes are applied to all newly created Users:
and Calling Cards:
Then in invoice it is possible to see configured taxes:
MOR 8 Manual
Kolmisoft 2006-2009
15
If you changed taxes you can assign this to all Users/Calling Cards by pressing buttons bellow:
Apply to all Users
Apply to all Calling Cards
What is increment
Increment is amount of time in which the call will be billed. It is counted in seconds.
Example:
Imagine call length is 15s
Rate for 1 min is 1 EUR/min (for simplicity reasons)
Then:
If increment is 1, then call length will be counted as 15s and call price will be 0.25 EUR (1/60*15) - increment is 1, so call can be 1, 2, 3... in length. 15s is exact length of call.
If increment is 10, then call length will be counted as 20s and call price will be 0.333.. EUR (1/60*20) - increment is 10, so call can be 10, 20, 30... in length. 20s is nearest to 15.
If increment is 20, then call length will be counted as 20s and call price will be 0.333.. EUR (1/60*20) - increment is 20, so call can be 20, 40, 60... in length. 20s is nearest to 15.
What is PIN
Description
PIN is Personal Identification Number used to Authenticate Devices OR Calling Cards in MOR.
Normal scenario where PIN is used is following:
User dials some Access Number (DID)
System asks to enter PIN
Users enters PIN
System checks for PIN in database
If found - system asks for Destination
User enters Destination
System calls to Destination
Connects Call
http://wiki.kolmisoft.com/index.php/What_is_incrementhttp://wiki.kolmisoft.com/index.php/What_is_PIN
MOR 8 Manual
Kolmisoft 2006-2009
16
How to get PIN
For Devices you can manage it in Devices' window.
Calling Cards
Example how PIN is used in Calling Cards can be found here: Calling Card logic
ASR/ACD
ASR - Answer Seizure Ratio
Its calculated by taking the number of successfully answered calls and dividing by the total number of calls
attempted (seizures). Since busy signals and other rejections by the called number count as call failures, the calculated ASR value can vary depending on user behavior. (http://www.voip-info.org/wiki/view/ASR)
60-70% is considered very good ASR in VoIP world.
ACD Average Call Duration
It is calculated by taking sum of billsec (billable seconds) of answered calls and dividing by amount of these answered calls.
Margin and Markup
If we have BUY and SELL prices, then:
PROFIT = SELL - BUY
Margin = PROFIT / SELL x 100
Markup = SELL / BUY x 100 - 100
In other words:
Margin = PROFIT part in SELL price
Markup = increase from BUY to SELL price
http://wiki.kolmisoft.com/index.php/Calling_Card_logichttp://wiki.kolmisoft.com/index.php/ASR/ACDhttp://www.voip-info.org/wiki/view/ASRhttp://wiki.kolmisoft.com/index.php/Margin_and_Markup
MOR 8 Manual
Kolmisoft 2006-2009
17
What are callgroups and pickupgroups
Letting someone else answer a call
In the mgcp, SIP, IAX, Asterisk Skinny Channels and the zapata channels you can define call and pickup groups for phones. Note that call pickup typically only works WITHIN a technology, e.g. from a SIP phone to a SIP phone and not ACROSS technologies, e.g. not from a SIP phone to a IAX phone.
The basic functionality is this:
* A call is placed in one or several call groups * If a phone belongs in a pickup group that matches one of the call's call groups, that phone may pickup the incoming call by calling *8# on his phone
* In v1-0, the feature code seems to be *8# on zap channels, and *8 on SIP channels: *8# does not seem to work from a SIP phone (unless your phone is configured to interpret # as ENTER key)
Groups are in interval 0-63.
You define call and pickupgroup per device, like:
callgroup=1 pickupgroup=1-9,13
Common misconception
Callgroups are not intended to call a group of phones; all a callgroup entry does is to help define who is permitted to perform a pick-up for which calls!
Info taken from: http://www.voip-info.org/wiki-Asterisk+callgroups+and+pickupgroups
Balance and Credit
Description
There are two fields which describes money situation for user: balance and credit.
Balance is the amount of money you owe user.
Credit how much money you allow user to be in debt before you.
These fields act and have slightly different meaning for different types of users: postpaid and prepaid:
http://wiki.kolmisoft.com/index.php/What_are_callgroups_and_pickupgroupshttp://www.voip-info.org/wiki-Asterisk+callgroups+and+pickupgroupshttp://wiki.kolmisoft.com/index.php/Balance_and_Credit
MOR 8 Manual
Kolmisoft 2006-2009
18
Postpaid users
Balance can be any value:
< 0 means user owns you money for your services, he will get invoice at the end of the month and when he pays for that invoice and his balance will increase
> 0 user has overpaid you (you owe to user)
== 0 nobody owes nothing to anybody (this is usual when user is new or just paid his invoice and did not made a call or used other services)
Credit for postpaid user can be:
> 0 that means user can make calls and use other services until he reaches credit. E.g. if his credit = 10 USD, he can make calls (and use other services) for total amount of 10 USD. At that time his balance will start at 0 and go down to -10 USD. When balance reaches -10 USD user will not be able to make any more calls.
== - user can make unlimited calls and use any services without any restrictions. All amounts will be included into invoice.
Prepaid users
Balance for prepaid users ALWAYS should be more then zero. Otherwise prepaid user will be unable to dial-out.
Credit for prepaid users is ALWAYS zero.
Note: balance and credit are set for users not devices. E.g. if user has several devices and his balance/credit does not allow to make any more calls that means he will be unable to use any of his devices.
Local Calls
MOR does not serve local calls when users are using extensions. So no reports are available to see such calls.
If one user dialed another user using DID - then it is possible to see report about such calls.
Same applies to billing local calls. If one extension dial another using DID - then it is possible to bill such call.
http://wiki.kolmisoft.com/index.php/Local_Calls
MOR 8 Manual
Kolmisoft 2006-2009
19
Configuration
Mor.conf
This file is in /etc/asterisk/ and describes some values for app_mor.so application which is the main MOR core working in Asterisk environment.
hostname, dbname, user, password, port, sock all these values describes connection to database;
min_frozen Minimum credit left to allow simultaneous calls. If users balance is lower he will not be able to make simultaneous calls (default 10); Not used starting from MOR 0.7.
frozen_time How much balance to freeze in minutes if user is prepaid (default 30). If user makes several simultaneous calls and he is prepaid we need to freeze some amount to be safe;
show_notice, show_warning, show_error sets debug level for app_mor.so application in Asterisk CLI;
zap_change change ZAP into something else in Asterisk to let use some custom made channels based on Zaptel;
server_id unique number for server identification;
active_calls tells app_mor.so to update info to DB related to calls currently on the system;
dial_out_settings global settings for Dial() command in Asterisk (rTt or similar);
serial serial key for activating app_mor.so
use_lcr_partials - Should MOR be able to use LCR by destinations? Default 1
global_call_timeout - Global timeout for calls in seconds, default 7200 seconds (2h)
check_banned_clis - Should MOR check for banned CLIs? Default 1, Enables/Disables ANI/CLI ban system
play_hgc_audio - Should we play audio with error message when call fails? (default 0 if not set)
use_flat_rates - Should MOR use Flat Rates, default 1
use_speed_dials - Should Speed Dials be enabled
In order to activate changes made to this file you need to restart Asterisk or reload app_mor.so
How to restart Asterisk server
Reload app_mor.so
1. Login to Asterisk CLI
2. Make sure there are no active calls using command: show channels, wait till they end or kill them using soft hangup command
3. Issue: module unload app_mor.so 4. Then: module load app_mor.so
http://wiki.kolmisoft.com/index.php/MOR_Manual#Configurationhttp://wiki.kolmisoft.com/index.php/Mor.confhttp://wiki.kolmisoft.com/index.php/ANI/CLI_ban_systemhttp://wiki.kolmisoft.com/index.php/ANI/CLI_ban_systemhttp://wiki.kolmisoft.com/index.php/Speed_Dialshttp://wiki.kolmisoft.com/index.php/How_to_restart_Asterisk_server
MOR 8 Manual
Kolmisoft 2006-2009
20
Configuration from GUI
SETTINGS - Setup - Settings
Global
Company Name of the company
Company email email of the company
Version version number shown on the bottom left corner of GUI
Copyright Title shown on the bottom left corner of GUI after Version
Browser Title browser title for MOR GUI
FrontPage Text some text to place on front page
Registration
Enabled? do we want to let users to register online automatically?
Tariff for new users select tariff for just registered users
LCR select LCR for new users
Default TAX percent what TAX percent should be for just registered users
Default country
Asterisk server IP what IP user should connect his softphone/server
Default CallerID name the CID name to send for new users
Default CallerID number the CID number to send for new users
Send email to user after registration just yes or no
Send email to admin after registration just yes or no
Allow user to enter TAX some system owners want to let users do this
ReCAPTCHA configuration
Invoices
Invoice configuration is divided into Prepaid and Postpaid.
Settings
Number start how invoice number should start
Number length the length in digits AFTER Number start e.g. Number start is not counted into this length. This value is active only for first number type
Number type select more appropriate number format
Invoice period start when invoices are issued, default is first day of the month
Show calls in detailed invoice yes or no
Show balance line - should we show balance line in invoice or not
Round finals to 2 decimals - round or not total in Invoices to 2 decimals
Invoice/Detailed/CallerID/By Destinations - default settings which decides what type of invoices should be sent to user
Details
Address format changes field positioning in the invoice for the address
Address line 1-4 Address info
Bank details line 1-5 Bank details info
http://wiki.kolmisoft.com/index.php/Configuration_from_GUIhttp://wiki.kolmisoft.com/index.php/ReCAPTCHA
MOR 8 Manual
Kolmisoft 2006-2009
21
Invoice balance line - Line for balance (e.g. "Your current balance is")
End title some title for your invoice's end
WEB Callback
Active? enabled or disabled
MaxRetries how many time try to redial if call fails
RetryTime in what intervals (in seconds) try to redial
WaitTime timeout value for the call how long to wait till the call is answered
WEB Callback CID - what CID to show on outgoing call
Web Callback Server - which server from servers list to use for webcallback
Emails
Sending enabled if checked you will be able to use Mass Mailing and system will send emails upon user registration
SMTP server hostname of the server
Domain you can leave it localhost.localdomain
Port - port of SMTP server
Login username to your SMTP server
Password password to your SMTP server
Batch size value for Mass Mailing how many emails to send at once
From - email address to put into From: field in email
Test email sending - save settings and press this to test email sending - do not to save settings first!
See also:
Email variables
Various
Days for DID to close - How long keep DID Closed before making it Free
Agreement number length - number length in digits
Number digits - how many decimal digits will see system users (admin/resellers/users)
Items per page - how many items to show per page
Device PIN length - length for automatically generated PIN codes for devices
Change Zap - Sometimes it is wanted to change "Zap" to something else in GUI. E.g. to "PSTN", mainly because not everybody knows what Zap stands for. PSTN is more common.
Change Zap to - to what value change "Zap" in GUI
Device range MIN - from which extension automatic extension assigning starts
Device range MAX - till which extension automatic extension assigning goes o E.g.: from this interval: [Device range MIN, Device range MAX] MOR will select extensions
for newly created Devices.
CSV Column Separator - how columns are separated in imported/exported CSV files
CSV Decimal Separator - how decimal parts in numbers are separated in imported/exported CSV files
Maximum Active Calls - how many calls (maximum) to show on Active Calls page
Active Calls refresh interval - how often to refresh Active Calls window (in seconds)
Show Full Source (CallerID Name and Number) - show CallerID Name and Number or only Number
http://wiki.kolmisoft.com/index.php/Email_variables
MOR 8 Manual
Kolmisoft 2006-2009
22
Show rates without Tax - show rates without for user. It is disabled by default to not confuse users and shows rates only with Tax.
Banned CLIs default IVR - default IVR to route banned numbers
Show logo on first page - enabled by default. Disable if you want that your and yours resellers' users to do not see your logo.
Hide Quick Stats - hide Quick Stats on front page. Use when server has many calls and GUI is working slow. Default OFF.
Show rates for users - disabled by default. Enable to show Rate menu option for resellers/users. Same applies to resellers.
Tax
Settings are explained here: Multi-Tax system
Fax
Fax device enabled - enable/disable Fax device in MOR
Email2Fax From Sender - what to put in From: field in email which sends fax
Google Maps
Fullscreen - should we show Google Maps in full-screen? E.g. remove menu from template
Reload Time - how often refresh
Width - width for GMaps window
Height - height for GMaps window
Key - GMaps key o Instructions how to get it here o More about Google Maps integration
Backups
Configuration is explained here: Backup system
API
Allow API - enable/disable API
Allow GET API - enable/disable GET in API - use only for testing!
API Secret Key - secret key for API
XML API Extension - .NET does not follow standards (surprise), enable this setting if you are using it to get XML starting with HTTP tags
Functionality
Click2Call active - Activates Click2Call icon near phone numbers in User portal (this setting is not related to Click2Call Addon)
User wholesale tariff enabled - enables/disables Wholesale tariff type for Users
Allow devices to check balance over HTTP - enables/disables Balance in phone
Play IVR for unauthenticated call - Which IVR to play when system does not know from where call came
See also:
MOR API
http://wiki.kolmisoft.com/index.php/How_to_show_rates_for_resellers_usershttp://wiki.kolmisoft.com/index.php/Multi-Tax_systemhttp://wiki.kolmisoft.com/index.php/Get_Google_Maps_keyhttp://wiki.kolmisoft.com/index.php/Google_Maps_integrationhttp://wiki.kolmisoft.com/index.php/Backup_systemhttp://wiki.kolmisoft.com/index.php/Balance_in_phonehttp://wiki.kolmisoft.com/index.php/MOR_API
MOR 8 Manual
Kolmisoft 2006-2009
23
ReCAPTCHA
Description
A CAPTCHA is a program that can tell whether its user is a human or a computer. You've probably seen
them colorful images with distorted text at the bottom of Web registration forms. CAPTCHAs are used by many websites to prevent abuse from "bots," or automated programs usually written to generate spam. No computer program can read distorted text as well as humans can, so bots cannot navigate sites protected by CAPTCHAs.
More info
Implementation in MOR
reCAPTCHA is disabled by default in MOR.
To enable it go to SETTINGS - Registration:
Here mark reCAPTCHA enable and press on Get reCAPTCHA keys
http://wiki.kolmisoft.com/index.php/ReCAPTCHAhttp://recaptcha.net/captcha.htmlhttp://recaptcha.net/captcha.htmlhttps://admin.recaptcha.net/accounts/signup/?next=
MOR 8 Manual
Kolmisoft 2006-2009
24
and follow pictures how to register and get keys:
MOR 8 Manual
Kolmisoft 2006-2009
25
Here enter your domain name or IP if you do not have domain, example: http://22.33.44.55 (put your IP here! do not leave support.kolmisoft.com or 22.33.44.55
MOR 8 Manual
Kolmisoft 2006-2009
26
Now on registration page user should enter valid words to complete registration:
And in registration page user will see captcha:
MOR 8 Manual
Kolmisoft 2006-2009
27
See also:
Registration configuration
http://wiki.kolmisoft.com/index.php/Configuration_from_GUI#Registration
MOR 8 Manual
Kolmisoft 2006-2009
28
Payments configuration
Vouchers
Vouchers enabled yes or no
Number length how long vouchers number should be make it at least 10 digits long
Disable time (minutes) if user several times fails to enter correct voucher number for how long should we disable possibility for him to try again
Attempts to enter how many time user can try to enter voucher number
PayPal
PayPal Enabled yes or no
PayPal Email account in PayPal where you want to get payments
Default currency select currency which matches you account's supported currency if they do not match you will get errors
User pays transfer fee - check if User should pay transfer fee, otherwise you as system owner will pay it (default)
Default amount amount to show for customer when he tries to enter payment. User can change this amount
Minimal amount minimal amount user can send you
Test if checked all amounts will be equal to 0.01 good for testing with real account
See also:
PayPal
Device configuration
PIN
PIN is unique number sequence which is used to authenticate device.
It is used in:
Authenticate device in ANI/PIN Dial Plan
Authenticate device when Tell Balance extension is dialed
System asks to enter PIN over phone, when PIN is entered, system check for PIN in DB and if founds - device is authenticated.
http://wiki.kolmisoft.com/index.php/Payments_configurationhttp://wiki.kolmisoft.com/index.php/PayPalhttp://wiki.kolmisoft.com/index.php/Device_configuration
MOR 8 Manual
Kolmisoft 2006-2009
29
Works not logged
Default: YES
This setting has nothing to do with DEVICE registering to SERVER.
It is for USER registering into GUI.
This setting lets device dial out when device owner (user) is not logged into GUI interface.
If this setting is unchecked, and User is not logged into GUI, Device will not be able to dial:
Asterisk CLI will show something like this:
-- Executing [37068111855@please_login:1] Wait("SIP/101-082b73c8", "1") in new stack -- Executing [37068111855@please_login:2] Playback("SIP/101-082b73c8", "mor_login_fail|noanswer") in new stack -- Playing 'mor_login_fail' (language 'en') -- Executing [37068111855@please_login:3] PlayTones("SIP/101-082b73c8", "congestion") in new stack
-- Executing [37068111855@please_login:4] Congestion("SIP/101-082b73c8", "") in new stack
Caller will hear: LOGIN FAILED
Just check this setting (activate it) in device settings to allow it to dial all the time.
This setting is mostly used in Call Center environment when caller must be logged into GUI to dial out.
Default device settings
SETTINGS - Setup - Settings - Default device
These settings will be applied to manually created devices.
That means if you enter some special settings here and later you will go to create new device for some user - device will have these settings preset.
http://wiki.kolmisoft.com/index.php/Default_device_settings
MOR 8 Manual
Kolmisoft 2006-2009
30
Default values of Default Device
MOR 8 Manual
Kolmisoft 2006-2009
31
Accountant permissions
By default Accountants have only read-only rights.
It is possible to allow them to make some changes to the system by changing their permissions.
Permissions are global - e.g. for all accountants.
Logo change
You can change logo very easily over GUI. Go to SETTINGS - Setup - Logo and browse for your new logo.
Relogin to see your new logo.
Currencies
SETTINGS - Setup - Settings - Currencies
Here is whole list of supported currencies.
MOR operates in one and only one currency.
http://wiki.kolmisoft.com/index.php/Accountant_permissionshttp://wiki.kolmisoft.com/index.php/Logo_changehttp://wiki.kolmisoft.com/index.php/Currencies
MOR 8 Manual
Kolmisoft 2006-2009
32
Default Currency
It is necessary to decide in which currency software will operate and set such currency as default before starting to work with software.
That means that all operations inside MOR will be done in this default currency.
This video demonstrates how to change default currency:
http://wiki.kolmisoft.com/index.php/Currencies#Default_Currency
Currencies window
In Currencies window we see list of currencies.
First one is default and most important currency.
Exchange rate is equal to Default Currency DIVIDED BY Some other currency. E.g. EUR Exchange rate when Default currency is USD is equal (in 2009-03-24) 0.7351, e.g. USD/EUR
Last Update is for informational purposes
Active? - shows if this Currency is used in GUI
Update? - if checked - this currency (its Exchange rate) will be updated from finances.yahoo.com at midnight
Yahoo - updade this currency (its Exchange rate) from finances.yahoo.com right now
Edit - this option is accessible when Update? is OFF and then you can enter Exchange Rate manually for this currency
Update currencies from web - updates all currencies (which are marked as to update from web)
Add/Remove Currency
There are main set of Currencies which cannot be removed from MOR.
You can add own Currency - just make sure it is not in the list already.
To add Currency fill data at the bottom of Currencies table and press Add icon.
For newly added Currency you will need to set Exchange Rate manually. Update from Yahoo is not possible.
Manually added Currency can be deleted. E.g. removed from MOR.
http://wiki.kolmisoft.com/index.php/Currencies#Default_Currency
MOR 8 Manual
Kolmisoft 2006-2009
33
Translations
If you want to change translation of MOR GUI you can press on the selected flag in the upper right corner of the window.
In order to manage Translations of the MOR you should go to SETTINGS Setup Settings - Translations.
Here you will see window with all available translations.
In the first column you can Drag & Drop translation to its new place. This column is dedicated to manage the order of translations.
Second column is for Activating/deactivating translation. Simply click on desired translation to activate/deactivate it.
When it's disabled it is in grey color.
If you want to see changes instantly press icon at the bottom. Page will be reloaded and you will not need to logout/login to see changed translation order at the upper right corner of your window where translations are represented as flags.
The first translation is DEFAULT translation. If you want to change default translation Drag&Drop other translation to the very top of translations list.
Default translation is translation which is active when user comes to page first time.
Short demo video which shows how many translations are disabled and Spanish translation is set as default (old default was English): http://wiki.kolmisoft.com/index.php/Translations
See also:
MOR GUI Translation
Change flag for translation
http://wiki.kolmisoft.com/index.php/Translationshttp://wiki.kolmisoft.com/index.php/Translationshttp://wiki.kolmisoft.com/index.php/MOR_GUI_Translationhttp://wiki.kolmisoft.com/index.php/Change_flag_for_translation
MOR 8 Manual
Kolmisoft 2006-2009
34
Voicemail
Description
Voicemail (or voice mail, voice-mail, vmail or VMS, sometimes called messagebank) is a centralized system
of managing telephone messages for a large group of people. The term is also used more broadly, to denote any system of conveying voice message, including the answering machine. (http://en.wikipedia.org/wiki/Voicemail)
Voicemail is automatically sent to users email if email address is specified in the device details.
Audio recording in WAV format is attached to the email.
1 minute audio takes approx. 100 Kb.
Configuration
This section can be found in SETTINGS - Billing - DIDs - PBX Functions - VoiceMail
VoiceMail Extension (local) - describes by which local extensions local user can dial to retrieve his voicemail (system will ask him to enter his voicemail password which can be set in device's details)
If you want to setup VoiceMail (VM) on different server, then following settings are important:
VoiceMail Server active - turns VM server on/off, when on - all VM request will go to distabd VM server, when off - VM will be handled locally on Asterisk
VoiceMail Server connection/device - describes connection to VM server
VoiceMail Retrieve Extension (local) - which extension to dial on distant VM server to retrieve voicemail for some extension
Example:
Let's say we have our server on IP 23.45.67.89 connected with SIP to our Asterisk.
We create separe user/device (vm_device) to describe this connection. Device's type is SIP, IP = 23.45.67.89, set other settings also (codecs/etc)
VoiceMail Retrieve Extension (local) = 999
First action is when VM is recorded
So now when VM server is ON and user with device 201 get's a VM, call is redirected like this:
Dial(SIP/vm_device/201)
That means server on 23.45.67.89 will receive call to extension 201. Server SHOULD BE configured that way, that it will process VM correctly when it receives such call.
http://wiki.kolmisoft.com/index.php/Voicemailhttp://en.wikipedia.org/wiki/Voicemail
MOR 8 Manual
Kolmisoft 2006-2009
35
Second action - retrieving VM
When user want to retrieve his VM on distant machine he dials VoiceMail Extension (local).
He is redirected like this:
Dial(SIP/vm_device/999#201)
Again - distant server should know how to process such a request.
Let's say we have distant VM server based on Asterisk.
So in our example it's configuration in /etc/asterisk/extensions.conf should look like this:
[incoming] # to retrieve VM exten => _999#.,1,VoiceMailMain(${EXTEN:4}) exten => _999#.,2,Hangup
# to record VM exten => _X.,1,VoiceMail(${EXTEN}) exten => _X.,2,Hangup
Retrieve VoiceMail from outside over DID
In PBX functions create new function with type: check_voicemail
Assign this PBX Function to some DID
FROM field in email
To change Voicemail email sending FROM field edit /etc/asterisk/voicemail.conf file, line:
;fromstring=The Asterisk PBX
to
fromstring=SOME OTHER LINE
And reload Asterisk.
MOR 8 Manual
Kolmisoft 2006-2009
36
Multi Server support
SETTINGS - Billing - Servers
With this system it is possible to manage several Asterisk servers from GUI.
These servers are Asterisk servers which work with calls and BILLS them.
NOTE! If you want to connect other Asterisk server which will not bill call - then configure as Device/Trunk.
Database and GUI servers are not described here.
Gateway - determines if server acts as Gateway for SIP Proxy. This option is available only when Carrier Class addon is enabled. It means that SIP Proxy will use this server to send calls through.
Active - determines if server is active - e.g. if MOR should 'talk' to this server in order to update provider/device information. Disabling server does not disables it's use, only the updating of changes from GUI.
ID - unique identifier of server which should be same as server_id in mor.conf
Test - press to test connection to the server over AMI
Hostname most times is equal to Server IP
URL - special URL for some third-party software, sometimes for server stats
Type and Comment - just for informational purposes
Max Call Limit - not used for now
AMI Username/AMI Secret - settings to connect to that server over AMI - most important settings in this window! Should match values in servers' /etc/asterisk/manager.conf
SIP Port - on which port Asterisk listens to SIP, used in MOR Carrier Class
SSH Username/Password/Port - not used now
Providers
This window shows which Providers are accessible from this Server.
Every Provider can belong to every Server.
It is important to map correct Providers to correct servers.
http://wiki.kolmisoft.com/index.php/Multi_Server_supporthttp://wiki.kolmisoft.com/index.php/Carrier_Class_addonhttp://wiki.kolmisoft.com/index.php/MOR_Carrier_Class
MOR 8 Manual
Kolmisoft 2006-2009
37
Emails
This function is used to send bunch of emails to your clients. It can be used to send some commercials, notes about service unavailability or anything else maybe greetings for Christmas.
This function can be found in SETTINGS Setup Emails:
Here you see emails which are templates for email for various system messages. The 'test' email is created for demo purposes for mass-mailing.
We will press on to edit created email. Creating and editing are very similar. We will show how to edit:
http://wiki.kolmisoft.com/index.php/Emails
MOR 8 Manual
Kolmisoft 2006-2009
38
Name and Subject fields are simple. The most important field is Message text. Here you enter message for the user. Also you can use such variables here:
- Server IP where your users should register their SIP/IAX2 devices - Used on user registration - shows device's type user had selected - Used on user registration - shows device's username - Used on user registration - shows device's password - GUI login url - User's username to login to GUI
- User's password to login to GUI - same as login_username - First name of the user - Last name of the user - First name and last name of the user
After all press Change to save it.
In main window you can press on icon to select to which recipients to send this email:
Email variables
These variables can be used in emails:
- Server IP where your users should register their SIP/IAX2 devices
- Used on user registration - shows device's type user had selected
- Used on user registration - shows device's username
- Used on user registration - shows device's password
- GUI login url
- User's username to login to GUI
- User's password to login to GUI
- same as login_username
- First name of the user
- Last name of the user
- First name and last name of the user
See also:
Email Configuration
http://wiki.kolmisoft.com/index.php/Email_variableshttp://wiki.kolmisoft.com/index.php/Configuration_from_GUI#Emails
MOR 8 Manual
Kolmisoft 2006-2009
39
Number Manipulation
Number Manipulation is used to change Number formats.
Main RULES
MOR manipulates with numbers which are in E.164 format.
Explanation in other words: numbers coming to MOR SHOULD BE in E.164 format. Number leaving MOR ARE in E.164 format.
From this we come to necessary actions:
1. Incoming destination number should be made E.164 compatible (done by Localization) 2. Outgoing number may be made out of E.164 number (done by Provider Rules)
Definitions
E.164 format - In short it's the number without international prefix which starts with country code, for more details - check Wikipedia.
Localization o Main idea of Localization: No matter how user dials number (destination) when
localized it should be in E.164 format. o Localization has nothing in common with numbers you send to providers. It operates with
numbers received from caller.
Provider Rules o MOR operates with numbers in E.164 format, but Provider often asks different format
number - so Provider Rules formats E.164 number to Provider acceptable format.
How Number Manipulation works
The first part which makes any incoming number E.164 compatible is done by Localization. The second one which changes E.164 number is Provider Rules. The basic schema for all this process can be simplified as:
MOR works only with E.164 numbers. That means, MOR accepts only standard numbers, if number is not in E164 - it must be changed to E164 compatible number.
For this task MOR has a feature Localization (found in Billing -> Functions -> Localization) which could be used for "standardizing non E.164 numbers to correct E.164 numbers".
If requested by outgoing calls provider, MOR can cut/add special prefix to number to send it to Provider in its requested format. This can be done using Provider Rules.
Localization and Provider Rules follows same logic.
http://wiki.kolmisoft.com/index.php/Number_Manipulationhttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/E.164http://en.wikipedia.org/wiki/E.164http://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Rules
MOR 8 Manual
Kolmisoft 2006-2009
40
Example how Localization works:
Number from Caller -> Localization -> Number from Caller in E164 format -> MOR -> Provider Rules -> Number for Calee
International prefixes, local number formats are handled by Localization.
Provider technical prefixes and special number formats for providers are handled by Provider Rules.
That means:
o if MOR receives number with international prefix you need to strip it and make number E.164 compatible.
o if MOR received number in some local number format with some special digit(s) in front of it you need to strip it, add country code -> make it E.164 compatible using Localization
o if your Provider requests some fancy technical prefix you need to add this prefix using Provider Rules. Add prefix to E.164 number. It can occur that you need to cut some digits (let's say country code) before adding technical prefix do it with Provider Rules.
Let's repeat again, because it is extremely important:
When MOR receives number make sure it is E.164 compatible or make it E.164 compatible with
Localization When you are sending number to provider use Provider Rules to change E.164 number to provider expected format
Work flow to setup Localization and Provider Rules
To setup correct Localization and Provider Rules you need to do following things:
1. To know what number format user will be dialing 2. Create appropriate Location and assign user to that Location 3. Create rules for specific Location to handle user entered numbers 4. To know what number provider expects 5. Create rule for provider which handles number transformation to providers expected number
For the training let's cover full example using the scheme we had before:
1. User dials some number: 863042438 2. Number is made E.164 compatible by Localization: we cut 86, add 3706 and we have: 37063042438 3. Billing: MOR uses 37063042438 to find correct destination and rates 4. E.164 number is transformed to provider format by Provider Rules: number 37063042438 is
transformed to number format which provider expects by adding 89765#, so we have:
89765#37063042438 5. Call is sent to provider: 89765#37063042438
HINT: We should remind you to use Call Tracing to debug all this.
http://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Call_Tracing
MOR 8 Manual
Kolmisoft 2006-2009
41
HINT: World Telephone Numbering Guide can help you a lot handling different number formats.
Rule Ordering
Rules for Localization and for Provider Rules are ordered in following order:
Device/Provider Location
Global Location
That means that Global location rules are applied to every device. But they have lower priority over some specific Location. That means - if device belongs to some Location X, then rules in Location X are reviewed first. If none of the rules can be applied from Location X, then rules in Location Global are checked.
When one rule is applied - no more rules will be applied after that.
How exact rule for dialed number is selected from many rules
How MOR select rule which should be applied to the number?
There are 3 steps done for all rules (for Localization & Provider Rules)
1. MOR checks for number length and reject these rules if dialed Numbers length does not fall into MIN and MAX described interval. E.g. if Numbers length is less then MIN or greater then MAX.
2. Then these rules are rejected if beginning of number does not match Cut value of these rules.
3. At the last step MOR selects the rule which has longest Cut length.
E.g. Rule selected at step 3 will be used to transform dialed number.
Example
Lets say 012337068111543 coming from caller to MOR system.
And we have such rules:
# CUT ADD MIN MAX
1 01 11 11 14 2 012 22 12 15 3 123 33 15 16 4 0123 44 11 20
1. MOR is checking number length by available min/max settings. So if incoming number's length (number
length = 15 in our example) is more or equal then MIN and less or equal then MAX - this rule will not be rejected. E.g. rule will be rejected if number length will be less then MIN or greater then MAX.
Then we are rejecting rule #1 because 15 is > MAX(14), after first step we have:
http://www.wtng.info/http://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Rules
MOR 8 Manual
Kolmisoft 2006-2009
42
# CUT ADD MIN MAX
2 012 22 12 15 3 123 33 15 16 4 0123 44 11 20
2. MOR proceeds to looks for CUT value which match beginning of dialed number. MOR rejects all rules which do not match dialed number beginning.
In this step we are rejecting rule #2, because its CUT value (123) is NOT beginning of dialed number: 012337068111543.
After second step we have:
# CUT ADD MIN MAX
2 012 22 12 15 4 0123 44 11 20
3. MOR checks for all remaining rules which haven't been rejected by first and second rule and select rule which has longest CUT.
This step selects rule with longest CUT, so our result is:
# CUT ADD MIN MAX
4 0123 44 11 20
This rule is applied to dialed number. E.g. if dialed number is 012337068111543, then first we cut CUT value
(0123) out from it (then we have 37068111543) and then we add ADD value (44), so final result is 4437068111543.
See also:
Localization
Provider Rules
DID handling by Localization
Number Manipulation Examples
http://wiki.kolmisoft.com/index.php/Localizationhttp://wiki.kolmisoft.com/index.php/Provider_Ruleshttp://wiki.kolmisoft.com/index.php/DID_handling_by_Localizationhttp://wiki.kolmisoft.com/index.php/Number_Manipulation_Examples
MOR 8 Manual
Kolmisoft 2006-2009
43
Localization
Description
Localization transforms received number to E.164 format number.
Main idea of Localization: No matter how user dials number (destination) when localized it should be in e.164 format.
Localization has nothing in common with numbers you send to providers. It operates with numbers received from caller.
Often it is important to let users to dial different format numbers to reach same destination. It depends on the location where user (or his device) is located.
For that purpose each device has field Location. It describes the physical location of device and rules how this device can dial destination. In other words each device IS (belongs) in some Location where some specific dialing rules apply.
Location describes where caller IS - not where he is calling!
By default device has location 'Global'. Global rules apply to ALL devices. If user belongs to some other
location and his dialed destination has some rule for his destination then global rules are not activated they have lower priority upon location rules.
You can access Localization settings in SETTINGS Billing Functions Localization.
In the main window you can see available Locations:
At first there is only Global location. You can't delete this location. It's default for all devices.
You can add new Location by entering this Location's name in field at the bottom of table:
http://wiki.kolmisoft.com/index.php/Localization
MOR 8 Manual
Kolmisoft 2006-2009
44
and pressing :
In the column Rules press icon on to access Location's rules:
Following settings should be explained for rule:
Name just for informational purposes
Cut what prefix from the number should be cat
Add what prefix to the number should be added
Min Len what's the minimum length of number we are trying to apply this rule
Max Len what's the maximum length of number we are trying to apply this rule
Tariff - which Tariff to apply when this Rule is applied. It is used in special cases, example here. Leave this empty in most cases
LCR - which LCR to apply when this Rule is applied. It is used in special cases, example here. Leave this empty in most cases
http://wiki.kolmisoft.com/index.php/LCR/Tariff_change_based_on_call_prefixhttp://wiki.kolmisoft.com/index.php/LCR/Tariff_change_based_on_call_prefix
MOR 8 Manual
Kolmisoft 2006-2009
45
When you enter all values (Cut or Add can be left empty) press .
Example:
Normal Lithuania MOB prefix is: 3706
User's device is located in Lithuania Vilnius
By current Lithuanian regulations local customer can dial 9 digit numbers starting with 86 to reach Mobile subscribers
To describe this situation we will create following rule:
Rules can be enabled or disabled pressing icon or accordingly in the Enabled? column.
- This icon let's you edit rule's details.
- This icon let's you delete rule
Now in the main Localization window:
Press on in Devices column to access Devices in Global Location:
Here all Devices with selected location are listed. Choose other location for selected Device and press on icon to activate this change. Device will be assigned to the selected Location.
http://wiki.kolmisoft.com/index.php/Image:Edit.pnghttp://wiki.kolmisoft.com/index.php/Image:Edit.pnghttp://wiki.kolmisoft.com/index.php/Image:Cross.pnghttp://wiki.kolmisoft.com/index.php/Image:Cross.png
MOR 8 Manual
Kolmisoft 2006-2009
46
NOTE: It's possible to change Device's Location in Device's settings (SETTINGS Users Devices).
Now our device belongs to Location Lithuania Vilnius. And if we dial mobile number in Lithuanian format for example:
863042438, MOR cuts 86 (remaining part 3042438) and adds 3706. Result is: 37063042438 which is E.164 compatible and MOR can bill it correctly.
NOTE: make sure that after localization your number always is E.164 compatible. Call Tracing can help you do this.
See also:
Number Manipulation o Provider Rules o DID handling by Localization o Number Manipulation Examples
http://wiki.kolmisoft.com/index.php/Call_Tracinghttp://wiki.kolmisoft.com/index.php/Number_Manipulationhttp://wiki.kolmisoft.com/index.php/Provi
