Kolmisoft Wiki - User contributions [en]

MOR API

2014-10-29T12:27:37Z

Vaidask: /* Subscriptions */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.
* [[MOR API subscription create|subscription_create]] - Subscription create.
 

==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API subscription create

2014-10-29T12:26:29Z

Vaidask: Created page with '=Deescription=  MOR API Create subscription =Usage= * Call: /api/subscription_delete * Methods: POST, GET(if all…'

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

* Call: /api/subscription_delete
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* service_id - Service ID. '''Required'''.
* user_id - User ID . '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start. '''Optional'''.
* subscription_activation_end - timestamp of Subscription activation end. '''Optional'''.
* subscription_memo - memo of Subscription. '''Optional'''.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off). '''Optional'''.
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''. '''Optional'''.
 

===Request===

We have service_id = 10, user_id = 2, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_create?u=username&service_id=10&user_id=2&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully created</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - Person trying to create Subscription does not exist or his user type is User.
* <error>You are not authorised to use this functionality</error> - Person trying to create subscription does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
 
=See also=

* [[MOR API]]

MOR API

2014-10-29T10:30:52Z

Vaidask:

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
 
==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API subscription delete

2014-10-29T10:26:34Z

Vaidask: Created page with '=Deescription=  MOR API Delete subscription =Usage= * Call: /api/subscription_delete * Methods: POST, GET(if all…'

=Deescription=

[[MOR API]] Delete subscription
 
=Usage=

* Call: /api/subscription_delete
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* subscription_id - ID of Subscription you want to delete. '''Required'''.
* subscription_delete_action - number of action that you wish to choose. Numbers meaning: 1 - Delete without money return, 2 - Disable Subscriptions, 3 - Delete with whole money return. '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
 

===Request===

We have subscription_id = 123, API Secret Key = 456789 and we want to Subscription to be deleted with whole money return.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_delete?u=username&subscription_id=123&subscription_delete_action=3&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription deleted and money returned</success>
</status>
</page>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription disabled</success>
</status>
</page>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription deleted</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - Person trying to delete Subscription does not exist or his user type is User.

* <error>You are not authorised to use this functionality</error> - Person trying to delete subscription does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription disabled</error> - Subscription was successfully disabled.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Subscription delete action was not found</error> - Specified subscription_delete_action was not found should be in (1,2,3).
 
=See also=

* [[MOR API]]

M4 Rate Details

2014-10-08T08:15:43Z

File:Aggregate statistics.png

2014-09-08T11:34:44Z

Vaidask: uploaded a new version of "File:Aggregate statistics.png"

M4 Customer Invoices

2014-09-08T11:21:11Z

Vaidask: /* Description */

= Description =

M2 '''Customer Invoice''' is dedicated for final User of M2, who have to pay for made Calls. Admin can see and manage them in '''ACCOUNTING –> Customer Invoices''', User can reach list of his Invoices and check them from main menu. 
Despite your settings all values in Invoices are rounded into two digits after comma.
 
==Invoices List==

Invoices can be viewed, created (WIP) or exported to XLSX file in '''ACCOUNTING –> Customer Invoices'''. In the main window, you can see list of all the Invoices.

All Prices are displayed in particular Invoice Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for invoice A exchange rate will be from that day when invoice was generated (0.5). 

Same calculations with other currencies 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for invoice B exchange rate will be from that day when invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for invoice C exchange rate will be from that day when invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 
==Invoice Edit==

Invoice edit is accessed from invoices list.

Here you are able to see some information of the user and Invoice displayed and also some details of the Invoice can be edited.

'''Price''' and '''Price with TAX''' are displayed in a currency the invoice was generated with. It will not be changed according to system settings. 
The '''Exchange rate''' at the invoice generation moment is also saved in the database and displayed in Invoice Edit page. 
'''Period Start''' and '''Period End''' dates are not affected by time zones: only '''Issue Date''', '''Date Due''' and '''Status changed at''' changes according to the [[GUI_time_zone | time zone]] of the system. 
 
==Invoice Details==

You can find this page by clicking '''Invoice details''' link in the Invoice Edit page.

In the Invoice Lines page there is information about destinations, rates assigned to those destinations, calls made to the destinations, total time per destination and price for all the calls made to the specific destination.

This page can be accessed from Invoice edit page. 

In this page you can search by destination prefix. For example: enter ''35567'' and ''Albania mobile'' destination will be displayed.

Search can also be made with wildcard %. If you enter ''35%'', ''%67'', ''3%7'' or ''%56%'', ''Albania mobile'' will also be displayed.
 

=User Invoices=
Invoices can be viewed by Users and exported in XLSX format
 
[[Image:M2_user_invoices.png]]
 
By pressing on DETAILS User will be redirected to Invoice Details page
 
[[File:M2_invoice_details.png]]
 
= XLSX Invoices =

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.

Template have to be called default.xlsx and placed in /home/m2/public/invoice_templates folder. One template already exist, you need to change that one with yours. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, define information taken from Invoice main window and so on.

How and what information is displayed can be set in database by specific settings. For example:

UPDATE conflines SET value = 'G2' WHERE name = 'Cell_m2_invoice_number';
UPDATE conflines SET value = 'G3' WHERE name = 'Cell_m2_invoice_issue_date';
UPDATE conflines SET value = 'A7' WHERE name = 'Cell_m2_invoice_period_start';
UPDATE conflines SET value = 'D7' WHERE name = 'Cell_m2_invoice_period_end';
UPDATE conflines SET value = 'A2' WHERE name = 'Cell_m2_invoice_client_name';
UPDATE conflines SET value = 'G4' WHERE name = 'Cell_m2_invoice_due_date';
UPDATE conflines SET value = 'A3' WHERE name = 'Cell_m2_invoice_client_details1';
UPDATE conflines SET value = 'B3' WHERE name = 'Cell_m2_invoice_client_details2';
UPDATE conflines SET value = 'C3' WHERE name = 'Cell_m2_invoice_client_details3';
UPDATE conflines SET value = 'A4' WHERE name = 'Cell_m2_invoice_client_details4';
UPDATE conflines SET value = 'B4' WHERE name = 'Cell_m2_invoice_client_details5';
UPDATE conflines SET value = 'A5' WHERE name = 'Cell_m2_invoice_client_details6';
UPDATE conflines SET value = 'B13' WHERE name = 'Cell_m2_invoice_lines_destination';
UPDATE conflines SET value = 'F13' WHERE name = 'Cell_m2_invoice_lines_name';
UPDATE conflines SET value = 'G13' WHERE name = 'Cell_m2_invoice_lines_rate';
UPDATE conflines SET value = 'I13' WHERE name = 'Cell_m2_invoice_lines_calls';
UPDATE conflines SET value = 'H13' WHERE name = 'Cell_m2_invoice_lines_nice_total_time';
UPDATE conflines SET value = 'J13' WHERE name = 'Cell_m2_invoice_lines_nice_price';
UPDATE conflines SET value = 'A13' WHERE name = 'Cell_m2_invoice_lines_destination_number';
UPDATE conflines SET value = 'E25' WHERE name = 'Cell_m2_invoice_nice_total_amount';
UPDATE conflines SET value = 'E26' WHERE name = 'Cell_m2_invoice_nice_total_amount_with_tax';
UPDATE conflines SET value = 'G25' WHERE name = 'Cell_m2_invoice_exchange_rate';
UPDATE conflines SET value = 'D27' WHERE name = 'Cell_m2_invoice_comment';
UPDATE conflines SET value = 'G7' WHERE name = 'Cell_m2_invoice_timezone';

'''NOTE''' value is an address of cell and name defines what information to show.

'''NOTE''' GUI should be restarted after made changes!

Cell_m2_invoice_client_details1 - Address 
Cell_m2_invoice_client_details2 - City 
Cell_m2_invoice_client_details3 - Postcode/ZIP 
Cell_m2_invoice_client_details4 - State 
Cell_m2_invoice_client_details5 - Country 
Cell_m2_invoice_client_details6 - Phone 

All other are self explanatory.

M4 Customer Invoices

2014-09-08T11:17:55Z

Vaidask: /* Description */

= Description =

M2 '''Customer Invoice''' is dedicated for final User of M2, who have to pay for made Calls. Admin can see and manage them in '''ACCOUNTING –> Customer Invoices''', User can reach list of his Invoices and check them from main menu. 
All values in Invoices are rounded into two digits after comma despite your settings.
 
==Invoices List==

Invoices can be viewed, created (WIP) or exported to XLSX file in '''ACCOUNTING –> Customer Invoices'''. In the main window, you can see list of all the Invoices.

All Prices are displayed in particular Invoice Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for invoice A exchange rate will be from that day when invoice was generated (0.5). 

Same calculations with other currencies 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for invoice B exchange rate will be from that day when invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for invoice C exchange rate will be from that day when invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 
==Invoice Edit==

Invoice edit is accessed from invoices list.

Here you are able to see some information of the user and Invoice displayed and also some details of the Invoice can be edited.

'''Price''' and '''Price with TAX''' are displayed in a currency the invoice was generated with. It will not be changed according to system settings. 
The '''Exchange rate''' at the invoice generation moment is also saved in the database and displayed in Invoice Edit page. 
'''Period Start''' and '''Period End''' dates are not affected by time zones: only '''Issue Date''', '''Date Due''' and '''Status changed at''' changes according to the [[GUI_time_zone | time zone]] of the system. 
 
==Invoice Details==

You can find this page by clicking '''Invoice details''' link in the Invoice Edit page.

In the Invoice Lines page there is information about destinations, rates assigned to those destinations, calls made to the destinations, total time per destination and price for all the calls made to the specific destination.

This page can be accessed from Invoice edit page. 

In this page you can search by destination prefix. For example: enter ''35567'' and ''Albania mobile'' destination will be displayed.

Search can also be made with wildcard %. If you enter ''35%'', ''%67'', ''3%7'' or ''%56%'', ''Albania mobile'' will also be displayed.
 

=User Invoices=
Invoices can be viewed by Users and exported in XLSX format
 
[[Image:M2_user_invoices.png]]
 
By pressing on DETAILS User will be redirected to Invoice Details page
 
[[File:M2_invoice_details.png]]
 
= XLSX Invoices =

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.

Template have to be called default.xlsx and placed in /home/m2/public/invoice_templates folder. One template already exist, you need to change that one with yours. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, define information taken from Invoice main window and so on.

How and what information is displayed can be set in database by specific settings. For example:

UPDATE conflines SET value = 'G2' WHERE name = 'Cell_m2_invoice_number';
UPDATE conflines SET value = 'G3' WHERE name = 'Cell_m2_invoice_issue_date';
UPDATE conflines SET value = 'A7' WHERE name = 'Cell_m2_invoice_period_start';
UPDATE conflines SET value = 'D7' WHERE name = 'Cell_m2_invoice_period_end';
UPDATE conflines SET value = 'A2' WHERE name = 'Cell_m2_invoice_client_name';
UPDATE conflines SET value = 'G4' WHERE name = 'Cell_m2_invoice_due_date';
UPDATE conflines SET value = 'A3' WHERE name = 'Cell_m2_invoice_client_details1';
UPDATE conflines SET value = 'B3' WHERE name = 'Cell_m2_invoice_client_details2';
UPDATE conflines SET value = 'C3' WHERE name = 'Cell_m2_invoice_client_details3';
UPDATE conflines SET value = 'A4' WHERE name = 'Cell_m2_invoice_client_details4';
UPDATE conflines SET value = 'B4' WHERE name = 'Cell_m2_invoice_client_details5';
UPDATE conflines SET value = 'A5' WHERE name = 'Cell_m2_invoice_client_details6';
UPDATE conflines SET value = 'B13' WHERE name = 'Cell_m2_invoice_lines_destination';
UPDATE conflines SET value = 'F13' WHERE name = 'Cell_m2_invoice_lines_name';
UPDATE conflines SET value = 'G13' WHERE name = 'Cell_m2_invoice_lines_rate';
UPDATE conflines SET value = 'I13' WHERE name = 'Cell_m2_invoice_lines_calls';
UPDATE conflines SET value = 'H13' WHERE name = 'Cell_m2_invoice_lines_nice_total_time';
UPDATE conflines SET value = 'J13' WHERE name = 'Cell_m2_invoice_lines_nice_price';
UPDATE conflines SET value = 'A13' WHERE name = 'Cell_m2_invoice_lines_destination_number';
UPDATE conflines SET value = 'E25' WHERE name = 'Cell_m2_invoice_nice_total_amount';
UPDATE conflines SET value = 'E26' WHERE name = 'Cell_m2_invoice_nice_total_amount_with_tax';
UPDATE conflines SET value = 'G25' WHERE name = 'Cell_m2_invoice_exchange_rate';
UPDATE conflines SET value = 'D27' WHERE name = 'Cell_m2_invoice_comment';
UPDATE conflines SET value = 'G7' WHERE name = 'Cell_m2_invoice_timezone';

'''NOTE''' value is an address of cell and name defines what information to show.

'''NOTE''' GUI should be restarted after made changes!

Cell_m2_invoice_client_details1 - Address 
Cell_m2_invoice_client_details2 - City 
Cell_m2_invoice_client_details3 - Postcode/ZIP 
Cell_m2_invoice_client_details4 - State 
Cell_m2_invoice_client_details5 - Country 
Cell_m2_invoice_client_details6 - Phone 

All other are self explanatory.

301 Originator not found

2014-09-08T10:31:43Z

Vaidask:

Hangupcause Code - 301. Originator not found (IP/port/Tech.prefix)
 
Originator is searched by:

* IP
* Port
* Technical prefix

If ALL of these values are correct - then Originator will be found.

If AT LEAST ONE of these values are not correct - then Originator will NOT be found.

 
= See also =
* [[M2 Hangupcause Codes | Hangupcause Codes]]

M4 Hangupcause Codes

2014-09-08T10:28:30Z

Vaidask:

{| border="1" cellpadding="5" cellspacing="0"
| '''Code''' || '''Explanation'''
|-
| 300 || Not authenticated (accountcode = 0)
|-
| 301 || [[301 Originator not found | Originator not found]](IP/port/Tech.prefix)
|-
| 302 || Global Call Limit reached
|-
| 303 || Originator Capacity reached
|-
| 304 || CPS Limit reached
|-
| 305 || Source (CallerID) not accepted by regexp
|-
| 306 || Originator Balance Limit reached (Balance Min)
|-
| 307 || Originator Rate not found
|-
| 308 || Dial Peer not found
|-
| 309 || No Dial Peer is available by regexp
|-
| 310 || Suitable Terminator not found
|-
| 311 || User is blocked
|-
| 312 || Caller cancelled the call (Freeswitch HGC ORIGINATOR_CANCEL 487)
|-
| 313 || User call limit reached
|-
| 314 || M2 radius server did not receive accounting start packet (acct start timeout)
|-
| 315 || M2 radius server did not receive accounting stop packet (acct stop timeout)
|-
| 316 || Freeswitch did not find termination point details
|-
| 317 || Registration to termination point failed
|-
| 318 || --
|-
| 319 || --
|-
|}

All M2 HGC returns SIP 503 by default.

This can be changes in /etc/asterisk/m2.conf using

hgcX = code

Where X is M2 HGC, and code is [https://wiki.freeswitch.org/wiki/Hangup_Causes ITU-T Q.850 Code]

 
= See also =
* https://wiki.freeswitch.org/wiki/Hangup_Causes

Prefix finder

2014-09-08T07:03:51Z

Vaidask: /* About */

= About =
Navigate to:
 
For Admin             '''STATISTICS -> Various -> Prefix Finder''': 
For Admin User    '''PERSONAL MENU -> Various -> Search''': 
For Reseller           '''MAIN MENU -> Routing -> Search''': 
For Reseller User   '''PERSONAL MENU -> Details -> Search''': 
 
[[File:File-prefixfinder.png]]
 

Prefix finder is very useful tool when you want to get a country prefix in [[E.164]] format knowing only a country name. 

Prefix - refers to the first digits of a telephone number. 

These digits are a way to identify the area that the phone number is located in. 

 

== Functions ==
Prefix finder has two functions: 

1) You can enter prefix to get destination name. For example you can enter '''370''' and get destination name Lithuania, tariff and rates for this destination. 

2) You can enter Destination name and get prefix. For example you can enter '''Lithuania''' and get a prefix 370. 

3) You can enter Number to get Rate.

Device settings

2014-09-08T06:25:36Z

2014-09-08T05:29:35Z

Vaidask: /* Configuration */

=Description=
[[MOR API]] rate_get feature enables you to check rate over http.
 

Admin able to check Rates of his Users.
Accountant with Permissions able to check Rates of Admins Users.
Reseller able to check Rates of his Users.

=Configuration=

Go to '''SETTINGS –> Setup –> Settings'''
 
[[File:settings_path.png]]
 
In API tab ensure that MOR API is enabled and check '''Allow devices to check rate over HTTP''' option :
 
[[File:Settings_api.png]]
 

=Usage=

* From '''MOR X4''' call: '''/api/rate_get'''
* For Backwards-compatibility old name 'rate' is also usable. Call: '''/api/rate'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

* u - username for authentication. '''From X5 - Required'''.
* username – username of user whose rates you want to see.
* prefix – prefix number of destination you want to see.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).
'''NOTE:''' Don't use full number in API request. Use correct prefix only, because this method don't do prefix search, its only shows actual price for the exact prefix.
 

===Request===

HTML POST: http://<SERVER_IP>/billing/api/rate_get?u=admin&username=USERNAME&prefix=PREFIX&hash=HASH

Example:

http://127.0.0.1/billing/api/rate?u=admin&username=admin&prefix=370&hash=47fc73b6d374bd0a85e3984c1e1623451681569c
 

===Returns===

'''Success'''

Result is returned in format: rate#destination#prefix

<?xml version="1.0" encoding="UTF-8"?>
<page>
<rate>0.987#Lithuania#370</rate>
</page>

'''NOTE.''' MOR API rate method shows rate, which is applied to User. If rate by prefix is not found in [[Custom Rates]], it will be taken from Tariff assigned to User.
 
----
'''Errors'''

* User do not have rates for selected destination:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<error>Rate was not found</error>
</page>

* User with selected username does not exist:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<error>User was not found</error>
</page>

* '''Allow devices to check rate over HTTP''' option in [[MOR_API_rate_get#Configuration | API Settings]] is not set:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<error>Feature disabled</error>
</page>

* API is not allowed:

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>API Requests are disabled</error>
</status>

* User does not belong to the user who is trying to check rate or it was not found in the system:

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>User was not found</error>
</status>

* Accountant must have See Financial Data read or write [[Accountant_permissions | permission]] and Manage Tariffs read or write permission enabled:

<?xml version="1.0" encoding="UTF-8"?>
<status>
<error>You are not authorized to view this page</error>
</status>

 

=See Also=

* [[MOR API]]

File:Settings api.png

2014-09-08T05:27:52Z

Vaidask: uploaded a new version of "File:Settings api.png"

MOR API user details update

2014-09-08T05:25:15Z

Vaidask: /* Usage */

=Description=

[[MOR API]] Update user from params.

'''Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.'''
 
=Usage=

* From '''MOR X4''' call: '''/api/user_details_update'''
* For Backwards-compatibility old name 'user_update_api' is also usable. Call: '''/api/user_update_api'''
* Methods: POST, GET(if allowed, not recomended)
 
Note if Admin checked Allow Resellers to use Admin Tariffs in [[API Configuration]] then using this API Reseller can set for his Users Wholesale or Retail Tariffs which belongs to Admin.
 
===Parametres===

Parameters which are '''included''' into hash (if it is used):

* user_id - Users ID in MOR database, whose details we want to change. '''REQUIRED'''.
* u - username of user which can modify details (admin, reseller or accountant). '''REQUIRED'''.
* u0 - vat number
* u1 - lcr id
* u2 - warning email hour
* u3 - hide destination end
* u4 - currency id
* u5 - tariff id
* u6 - warning email balance
* u7 - spy device id
* u8 - language
* u9 - username
* u10 - warning balance call
* u11 - acc group id
* u12 - generate invoice
* u13 - usertype
* u14 - taxation country
* u15 - blocked
* u16 - quickforwards rule id
* u17 - last name
* u18 - call limit
* u19 - clientid
* u20 - recording hdd quota
* u21 - cyberplat active
* u22 - recordings email
* u23 - first name
* u24 - warning balance sound file id
* u25 - postpaid
* u26 - accounting number
* u27 - agreement number
* u28 - hidden
* ay - agr_date year
* am - agr_date month
* ad - agr_date day
* by - block at date year2011
* bm - block at date month
* bd - block at date day
* pswd - password
* user_warning_email_hour
* pgui - privacy gui [0-off, 1-on]
* pcsv - privacy csv [0-off, 1-on]
* ppdf - privacy pdf [0-off, 1-on]
* recording_forced_enabled - [0-off, 1-on]
* i4 - invoice detailed csv [0-off, 16-on]
* tax4_enabled - [0-off, 1-on]
* tax2_enabled - [0-off, 1-on]
* accountant_type_invalid
* block_at_conditional - 15
* tax3_enabled - [0-off, 1-on]
* accountant_type
* tax1_value - float
* show_zero_calls - [0-off, 1-on]
* warning_email_active - [0-off, 1-on]
* compound_tax - [0-off, 1-on]
* tax4_name -
* allow_loss_calls - [0-off, 1-on]
* tax3_name -
* tax2_name -
* credit - float
* tax1_name -
* total_tax_name -
* tax2_value - float
* tax4_value - float
* ignore_global_monitorings - [0-off, 1-on]
* i1 - invoice pdf [0-off, 2-on]
* tax3_value - float
* cyberplat_active - [0-off, 1-on]
* i2 - invoice csv [0-off, 4-on]
* i3 - invoice detailed pdf [0-off, 8-on]
* recording_enabled - [0-off, 1-on]
* email_warning_sent_test - [0-off, 1-on]
* own_providers - [0-off, 1-on]
* a0 - address
* a1 - city
* a2 - postcode
* a3 - county
* a4 - mob_phone
* a5 - fax
* a6 - direction id
* a7 - phone
* a8 - email
* a9 - state

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''REQUIRED'''.
 

===Reguest===

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send:
HTML POST: http://<server_ip>/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

'''* Note that username and password are not included in hash'''

Other examples:

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin).

HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes user quickforwards rule to rule with ID 3 (u16=3) user with ID 789 (user_id=789). User belongs to admin (u=admin).
 
===Returns===

'''Success'''

<page>
<status>User was updated</status>
</page>
 
----
'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - Check params and permissions.
* <error>You have no editing permission</error> - Accountant dont have permission.
* <error>Tariff not found</error> - Tariff was not found using param u5.
* <error>User was not updated</error>
* <message>problem message</message>
 

=See also=

* [[MOR API]]

API Configuration

2014-09-08T05:17:07Z

Vaidask:

Go to '''SETTINGS –> Setup –> Settings –> API''' tab

[[File:Settings api.png]]

* '''Allow API globally''' – should we enable API globaly? When it is disabled, all settings below are also disabled and not editable.
* '''Allow GET API''' – should we allow GET method to be used for API? Good for testing - but do not use in production! It is unsafe.
* '''Allow Resellers to use Admin Tariffs''' – It is possible to let Resellers use Admins Tariffs. With [[MOR API user details update]] Resellers can set Admins Wholesale or Retail Tariffs for their users. With [[MOR API rate get]] they can get Admins Rates. Using [[MOR API tariff rates get]] Resellers can get Admins Tariffs.
* '''API Secret Key''' – key to [[MOR API hash construction | generate Hash]]
* '''XML API Extension''' – send XML output with <HTML> tag - this is used for broken .Net support, keep it unchecked if everything works for you
* '''Allow API Login Redirect''' – if login is successful the customer will be redirected to MOR billing Main site.
* '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off.
* '''Uniquehash''' – admin's unique hash. Reseller can see it by going to '''SETTINGS''' -> '''Registration'''.

'''NOTE''' that MOR does not allow you to enable '''Allow API''' if '''API Secret Key''' is not entered. In such case you will get a message '''Invalid API secret key'''. Enter '''API Secret Key''' in order to fix this.
 
=From Reseller/RSPRO =

Reseller can use API functionality if '''Allow API globally''' in Admins settings is checked.

Reseller has three options in his API Settings (Seetings –> API tab):
* '''Allow API''' – turns on API functionality.
* '''API Secret Key''' – key to [[MOR API hash construction | generate Hash]]
* '''Disable hash checking''' – When it is on API functions can be used without sending hash. Default value: off.

'''NOTE''' that Reseller also must enter '''API Secret Key''' if he want to use API functionality.
 
= See also =

* [[MOR API]]

File:Settings api.png

2014-09-08T04:59:33Z

Vaidask: uploaded a new version of "File:Settings api.png"

Alerts

2014-08-19T14:29:14Z

Vaidask: /* Usage */

=Description=

Alerts functionality is dedicated to taking actions about your system issues which may cause a problem. You may block User, disable Provider, change LCR for User or simply send a notification to specified [[Alert Groups|Group]] of [[Alert Contacts|Contacts]].

You are able to follow these parameters:

* [[ASR/ACD|ASR]] – Answer-Seizure Ratio (percent)
* [[ASR/ACD|ACD]] – Average Call Duration (in seconds)
* PDD – Average Post Dial Delay. The time between punching in the last digit of a telephone number and receiving a ring or busy signal (in seconds)
* TTC (Time to Connect)(DURATION-BILLSEC) – Average time between receiving a ring signal and answer to the call (in seconds)
* BILLSEC – Sum of calls bilsec (in seconds)
* TOTAL CALLS – Sum of all calls.
* ANSWERED CALLS – Sum of answered calls.
* NOT ANSWERED CALLS – Sum of not answered calls (FAILED, BUSY, NO ANSWER).
* SIMULTANEOUS CALLS – Number of simultaneous calls (only applies to users and providers).
* PRICE SUM – Sum of calls price (only applies to users and providers).

And it is possible to make actions for these types of MOR Objects or send notification about it:

* [[Users]]
** All
** Postpaid
** Prepaid
** One User
* [[Providers]]
* [[Devices]]
* [[Directions and Destinations | Destinations]]
** One Destination by prefix.
** Few Destinations by prefix and % sign. Eg. 93%, 3706% and so on.
* [[Destinations Groups]]
 

=Usage=

Go to '''ADDONS –> Monitorings –> Alerts'''
 
[[File:alerts_path.png]]
 
Here you can see list of all created Alerts and their main information like is Alert active? When it was Raised/Cleared last time? What value was at Alert/Clear...
 
[[File:alerts_list.png]]
 
Click on [[Image:icon_add.png]]'''Add new Alert''' link to create an Alert or click on [[image:icon_edit.png]] icon to change settings of existing Alert.
 
[[File:Alert_edit3.png|right]]
 
'''General'''

* '''Name''' – Alert name.
* '''Object Type''' – select which Object you want to follow.
* '''Object Name''' – pecify name/prefix of Object.
* '''Parameter''' – choose which parameter should be followed.
* '''Alert Type''' – ABS means that absolute data values will be taken from specified time period.
'''NOTE''': Object Type, Object Name, Parameter, Alert Type cannot be changed once Alert is created.
* '''Ignore if Calls''' <= – indicate calls sum when system should ignore Alert if calls sum is less than written.
* '''Ignore if Calls''' >= – indicate calls sum when system should ignore Alert if calls sum is more than written.
* '''Group to Notify''' – select [[Alert Groups|Group]] of [[Alert Contacts|Contacts]] who should be informed about Alert/clear.
* '''Notify to User''' – it is available only when Alert object type is User or Device. Check if you want to notify User on Alert. 
'''Alert'''

* '''Alert if <=''' – indicate Parameter value when system should raise Alert if value is less than written.
* '''Alert if >=''' – indicate Parameter value when system should raise Alert if value is more than written.
* '''Disable Object''' – check if you want to disable selected Object on Alert.
* '''Disable Provider in LCR''' – indicate LCR where Provider should be disabled.
* '''LCR on Alert''' – select LCR which one should be used after Alert
* '''Notify On Alert via Email''' – check if you want that specified [[Alert Groups|Group]] will receive an email notifications about Alerts.
 
'''Clear'''

* '''Disable Clear''' – when alert is raised, it will never be cleared.
* '''Clear on Condition'''
** '''Clear if <=''' – indicate Parameter value when system should Clear Alert if value is less than written.
** '''Clear if >=''' – indicate Parameter value when system should Clear Alert if value is more than written.
* '''Clear on time basis'''
** '''Clear after''' – indicate time value after which system should Clear Alert
** '''Clear on Date''' – indicate specific date and time when system should Clear Alert (After clear, selection will be reset)
* '''Enable Object''' – check if you want to enable selected(in Alert configuration) Object on Clear.
* '''Enable Provider in LCR''' – check if you want to enable selected(in Alert configuration) Provider on Clear.
* '''LCR on Clear''' – select LCR which one should be used after Clear.
* '''Notify On Clear via Email''' – check if you want that specified [[Alert Groups|Group]] will receive an email notifications about Clear.

'''NOTE''' one of '''Clear on Condition''' options and both '''Clear on time basis''' options can be selected at one time. System will clear alert if at least one of conditions will be true, it means that alert will be cleared on condition which first will appear.
 
'''Period'''

You can select different time periods for each alert. This period defines time period which activity have to be checked.

Note: period has no effect when parameter SIMULTANEOUS CALLS is chosen.
 
'''Comment''' – additional notes.
 

= Alert vs Clear =

Example with CPU Load just to demonstrate what is Alert and what is Clear and proper usage of them.

[[File:alert_graph.png]]

 

=Examples=

===Send notification and change LCR on Alert===

Parameter: TOTAL CALLS 
Object Type: User 
Object Name: Prepaid 
Alert if >=: 300 
Clear if <=: 200 
LCR on alert: secondary LCR 
LCR on clear: Restore Original 
Group to Notify: support group 
Notify on Alert via Email: checked 
Period: 1h 
 
This Alert monitors all Calls done by Prepaid Users. If a Prepaid User makes more than 300 Calls during one hour period, his LCR will be changed to secondary LCR and Email notification will be sent to every contact on support group.
 
If User's Call count drops below 200 calls during one hour period, his LCR will be restored to original LCR
 

===Block user when simultaneous calls are detected===

Parameter: SIMULTANEOUS CALLS 
Object Type: User 
Object Name: All 
Alert if >=: 2 
Group to Notify: administration 
Notify on Alert via Email: checked 
Disable Object: checked 
Disable Clear: checked 
 
This Alert monitors simultaneous calls done by all Users. If a User makes more than (or equal to) 2 simultaneous Calls to the same destination, his account will be suspended and Email notification will be sent to every contact on administration group.
 
This alert will no be cleared automatically and user will stay suspended even if no more simultaneous calls are present.
 

===Alerts triggered by other Alerts===

Since '''MOR X5''' administrators are able to create alerts that depend on other alerts. What that means is, that you are able to create an alert that is triggered by a set or a subset of other alerts.

'''Example:'''
* Alert 1 is triggered when a specific user's ACD drops below ten seconds.
* Alert 2 is triggered when a the same user's Device's ASR drops below 50%.
* Alert 3 is triggered when both Alert 1 and Alert 2 is triggered, so that the technicians are notified.

In order to set up such a chain of events, you should first create Alert 1 and Alert 2.

Then, you should set up Alert 3.
 
[[File:Alert_group_parameter.png‎]]
 
* Configure your alert as usual, but instead of a specific parameter choose GROUP.
* Then, add the alert dependencies using the shown interface.

 
[[File:Alert_group_alert.png‎]]
 
* Set a number of alerts, that, when reached will trigger the alert.

 
[[File:Alert_group_clear.png‎]]
 
* Finally set up a number of alerts that will clear your alert.

These alerts can also be nested, without worrying about circular-dependencies, '''MOR''' simply will not let you make them.

=See also=

* [[Alert Schedules]]
* [[Alert Groups]]
* [[Alert Contacts]]
* [[ASR/ACD]]
* [[How to resolve long PDD]]

File:Alert edit3.png

2014-08-19T14:23:46Z

Vaidask: uploaded a new version of "File:Alert edit3.png"

File:Alert edit3.png

2014-08-19T14:22:34Z

Vaidask: uploaded a new version of "File:Alert edit3.png"

Alerts

2014-08-19T14:20:57Z

Vaidask: /* Usage */

=Description=

Alerts functionality is dedicated to taking actions about your system issues which may cause a problem. You may block User, disable Provider, change LCR for User or simply send a notification to specified [[Alert Groups|Group]] of [[Alert Contacts|Contacts]].

You are able to follow these parameters:

* [[ASR/ACD|ASR]] – Answer-Seizure Ratio (percent)
* [[ASR/ACD|ACD]] – Average Call Duration (in seconds)
* PDD – Average Post Dial Delay. The time between punching in the last digit of a telephone number and receiving a ring or busy signal (in seconds)
* TTC (Time to Connect)(DURATION-BILLSEC) – Average time between receiving a ring signal and answer to the call (in seconds)
* BILLSEC – Sum of calls bilsec (in seconds)
* TOTAL CALLS – Sum of all calls.
* ANSWERED CALLS – Sum of answered calls.
* NOT ANSWERED CALLS – Sum of not answered calls (FAILED, BUSY, NO ANSWER).
* SIMULTANEOUS CALLS – Number of simultaneous calls (only applies to users and providers).
* PRICE SUM – Sum of calls price (only applies to users and providers).

And it is possible to make actions for these types of MOR Objects or send notification about it:

* [[Users]]
** All
** Postpaid
** Prepaid
** One User
* [[Providers]]
* [[Devices]]
* [[Directions and Destinations | Destinations]]
** One Destination by prefix.
** Few Destinations by prefix and % sign. Eg. 93%, 3706% and so on.
* [[Destinations Groups]]
 

=Usage=

Go to '''ADDONS –> Monitorings –> Alerts'''
 
[[File:alerts_path.png]]
 
Here you can see list of all created Alerts and their main information like is Alert active? When it was Raised/Cleared last time? What value was at Alert/Clear...
 
[[File:alerts_list.png]]
 
Click on [[Image:icon_add.png]]'''Add new Alert''' link to create an Alert or click on [[image:icon_edit.png]] icon to change settings of existing Alert.
 
[[File:alerts_edit3.png|right]]
 
'''General'''

* '''Object Type''' – select which Object you want to follow.
* '''Object Name''' – pecify name/prefix of Object.
* '''Parameter''' – choose which parameter should be followed.
* '''Alert Type''' – ABS means that absolute data values will be taken from specified time period.
'''NOTE''': Object Type, Object Name, Parameter, Alert Type cannot be changed once Alert is created.
* '''Ignore if Calls''' <= – indicate calls sum when system should ignore Alert if calls sum is less than written.
* '''Ignore if Calls''' >= – indicate calls sum when system should ignore Alert if calls sum is more than written.
* '''Group to Notify''' – select [[Alert Groups|Group]] of [[Alert Contacts|Contacts]] who should be informed about Alert/clear.
 
'''Alert'''

* '''Alert if <=''' – indicate Parameter value when system should raise Alert if value is less than written.
* '''Alert if >=''' – indicate Parameter value when system should raise Alert if value is more than written.
* '''Disable Object''' – check if you want to disable selected Object on Alert.
* '''Disable Provider in LCR''' – indicate LCR where Provider should be disabled.
* '''LCR on Alert''' – select LCR which one should be used after Alert
* '''Notify On Alert via Email''' – check if you want that specified [[Alert Groups|Group]] will receive an email notifications about Alerts.
 
'''Clear'''

* '''Disable Clear''' – when alert is raised, it will never be cleared.
* '''Clear on Condition'''
** '''Clear if <=''' – indicate Parameter value when system should Clear Alert if value is less than written.
** '''Clear if >=''' – indicate Parameter value when system should Clear Alert if value is more than written.
* '''Clear on time basis'''
** '''Clear after''' – indicate time value after which system should Clear Alert
** '''Clear on Date''' – indicate specific date and time when system should Clear Alert (After clear, selection will be reset)
* '''Enable Object''' – check if you want to enable selected(in Alert configuration) Object on Clear.
* '''Enable Provider in LCR''' – check if you want to enable selected(in Alert configuration) Provider on Clear.
* '''LCR on Clear''' – select LCR which one should be used after Clear.
* '''Notify On Clear via Email''' – check if you want that specified [[Alert Groups|Group]] will receive an email notifications about Clear.

'''NOTE''' one of '''Clear on Condition''' options and both '''Clear on time basis''' options can be selected at one time. System will clear alert if at least one of conditions will be true, it means that alert will be cleared on condition which first will appear.
 
'''Period'''

You can select different time periods for each alert. This period defines time period which activity have to be checked.

Note: period has no effect when parameter SIMULTANEOUS CALLS is chosen.
 
'''Comment''' – additional notes.
 

= Alert vs Clear =

Example with CPU Load just to demonstrate what is Alert and what is Clear and proper usage of them.

[[File:alert_graph.png]]

 

=Examples=

===Send notification and change LCR on Alert===

Parameter: TOTAL CALLS 
Object Type: User 
Object Name: Prepaid 
Alert if >=: 300 
Clear if <=: 200 
LCR on alert: secondary LCR 
LCR on clear: Restore Original 
Group to Notify: support group 
Notify on Alert via Email: checked 
Period: 1h 
 
This Alert monitors all Calls done by Prepaid Users. If a Prepaid User makes more than 300 Calls during one hour period, his LCR will be changed to secondary LCR and Email notification will be sent to every contact on support group.
 
If User's Call count drops below 200 calls during one hour period, his LCR will be restored to original LCR
 

===Block user when simultaneous calls are detected===

Parameter: SIMULTANEOUS CALLS 
Object Type: User 
Object Name: All 
Alert if >=: 2 
Group to Notify: administration 
Notify on Alert via Email: checked 
Disable Object: checked 
Disable Clear: checked 
 
This Alert monitors simultaneous calls done by all Users. If a User makes more than (or equal to) 2 simultaneous Calls to the same destination, his account will be suspended and Email notification will be sent to every contact on administration group.
 
This alert will no be cleared automatically and user will stay suspended even if no more simultaneous calls are present.
 

===Alerts triggered by other Alerts===

Since '''MOR X5''' administrators are able to create alerts that depend on other alerts. What that means is, that you are able to create an alert that is triggered by a set or a subset of other alerts.

'''Example:'''
* Alert 1 is triggered when a specific user's ACD drops below ten seconds.
* Alert 2 is triggered when a the same user's Device's ASR drops below 50%.
* Alert 3 is triggered when both Alert 1 and Alert 2 is triggered, so that the technicians are notified.

In order to set up such a chain of events, you should first create Alert 1 and Alert 2.

Then, you should set up Alert 3.
 
[[File:Alert_group_parameter.png‎]]
 
* Configure your alert as usual, but instead of a specific parameter choose GROUP.
* Then, add the alert dependencies using the shown interface.

 
[[File:Alert_group_alert.png‎]]
 
* Set a number of alerts, that, when reached will trigger the alert.

 
[[File:Alert_group_clear.png‎]]
 
* Finally set up a number of alerts that will clear your alert.

These alerts can also be nested, without worrying about circular-dependencies, '''MOR''' simply will not let you make them.

=See also=

* [[Alert Schedules]]
* [[Alert Groups]]
* [[Alert Contacts]]
* [[ASR/ACD]]
* [[How to resolve long PDD]]

File:Alert edit3.png

2014-08-19T14:20:36Z

Vaidask:

Advanced Rates for Users

2014-08-13T07:42:06Z

Vaidask:

It is possible to show Advanced Rates for Users.

Make sure they will understand them before showing these Rates to Users.

It is necessary to turn on the settings:

In '''SETTINGS –> Setup –> Settings –> Functionality''' check '''Show rates for users''' and '''Show Advanced Rates for users''' settings

Click '''Save changes'''

Then Users are able to see the rates in their portal:

[[File:X5_user_rates.png]]

and their details:

[[Image:ar_for_users3.png]]