Kolmisoft Wiki - User contributions [en]

Configuration from GUI

2026-02-04T18:43:53Z

Ervinas: /* Last Calls */

=Where I can find this settings menu?=

You can find this menu in '''SETTINGS –> Setup –> Settings'''

[[File:Settings_path.png]]
 
== Global ==

'''SETTINGS –> Setup –> Settings –> [[Global_Settings | Global]]'''

* '''Company''' – name of the company.
* '''Company email''' – email address of the company.
* '''Version''' – version number.
* '''Copyright Title''' – copyright title supports html text format.
* '''Browser Title''' – browser title for MOR GUI.
* '''Front Page Text''' – some text to place on front page.
* '''Login Page Text''' – some text to place on login page
* '''Show logo on first page''' - untick to hide logo on the start page
 

== Users ==

* '''Show Calls statistics to User for last''' – number of Calls statistics to show in days. For example, if you enter 5 days, users will only see 5 days old calls, they will not be able to check older calls.
* '''Show user_billsec for Users instead of billsec''' – shows user_billsec instead of billsec in Users invoices and last calls. Notice that Billsec shows real Call duration, user_billsec shows Call duration after minimal time or increment applied. For example, if user tariff has 60 sec minimal time and user made a Call for 20 sec, then billsec will show 20 sec and user_billsec will show 60 sec (minimal time is applied).
* '''Hide device passwords for users''' – do not display device passwords for users.
* ''' Hide Device username for Users''' – do not display device username for users.
* '''Hide payment options for postpaid users''' - will hide the payment option for all postpaid users (including Resellers if they are postpaid).
* '''Hide non-completed payments for user''' – hides non-completed payments (the ones which are started in MOR, but are not completed in a payment gateway website).
* '''Hide Recordings for all users''' – hides recordings for all system users from menu and device settings.
* '''Allow User to assign DID to Device''' – lets User to assign DID to Device.
* '''Allow User to assign DID to Trunk''' – lets User to Assign DID to Trunk.
* '''Do not allow users to change their email addresses'''
* '''Do not allow users to change their Personal Details'''
* '''Change ANSWER to FAILED if HGC not equal to 16 for Users''' – changes the Hangupcause for users in call reports from Answered to Failed if Hangupcause is not 16.
* '''Do not allow PREPAID User balance drop below zero (block them instead)'''
* '''Do not block POSTPAID User when balance goes bellow zero on subscription count'''
* '''Allow identical email addresses to different Users''' – allows creating Users or registering users with identical email addresses. After checking this setting you will be not able to check.

 

== Devices ==

* '''Device PIN length''' – length for automatically generated PIN codes for devices.
* '''Device range MIN''' – from which extension automatic extension assigning starts.
* '''Device range MAX''' – till which extension automatic extension assigning goes.
** For example, from this interval: [Device range MIN, Device range MAX] MOR will select extensions for newly created Devices.
* '''Random Device Extension''' – when creating device, random number from '''Device Range''' will be taken.
* '''Enable "Allowed addresses" option for Devices:''' – allows [[Device_settings#Allowed_Addresses | Allowed Addresses]] functionality in Devices settings.
* '''Do not allow duplicate device user names'''
* '''Inform when Devices are created or updated''' – check to get an email about every newly created or updated Device.
* '''Allow same IP and Port combinations in multiple Devices''' – allows creating Devices with the same IP and Port combination.
* '''Show Hostname/IP in Device list'''
* '''Change dahdi''' – Sometimes this is used 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.

 

== Registration ==

'''SETTINGS –> Setup –> Settings –> Registration'''

* '''Enabled?''' – do we want to let users [[Online registration | register online]] automatically?
* '''Hide registration link in Login page?''' – tick this option if you do not want users to be able to register online.
* '''Default country'''
* '''Asterisk server IP''' – what IP should user connect his softphone/server to?
* '''Send Email to User after registration''' – just yes or no.
* '''Send Email to Admin after registration''' – just yes or no.
* '''Send Email To User after User was created''' – just yes or no.
* '''Send Email To Admin after User was created''' – just yes or no.
* '''[[ReCAPTCHA]] configuration'''
* '''[[User_Agreement|Terms and conditions]]'''
* '''Allow to create user and device with matching username and password''' – just yes or no. If this setting is not enabled - username and password from MOR GUI will have to be different than device's username and password.
* '''Enable VAT checking for EU companies''' – you can choose whether to check '''TAX Registration Number:''' during the [[Online registration]] or not. Done over [http://ec.europa.eu/taxation_customs/vies/?locale=lt EU page].
* '''Allow blank VAT for EU companies''' – allows to leave blank '''TAX Registration Number:''' field during the [[Online registration]]
 
===See also===

* [[Default user]]
 

== Invoices ==

'''SETTINGS –> Setup –> Settings –> Invoices'''

Invoice configuration is divided into '''Prepaid''' and '''Postpaid'''.
 
=== Settings ===

* '''Number start''' – how the 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.
* '''[[Outstanding balance(Debt) | Show balance line]]''' – shows balance line in Invoice PDF files when Invoice is generated from first day of month till last one.
* '''Round finals to 2 decimals''' – round or not total in Invoices to 2 decimals.
* '''Use short file name'''
* '''Group Subscriptions''' - User's subscriptions will be grouped by service (only applies to PDF and XLSX invoice).
* '''Show Quantity''' - Show quantity of each service (only applies to PDF invoice).
* '''Invoice Page Limit:''' – invoice will be generated till this page limit. Additional page is added with an explanation that page limit was reached.
* ''' Rename 'DID owner cost' label in detailed PDF invoice:''' – text which will be used instead of '''DID owner cost''' in detailed PDF invoice.
* ''' Hide 'DID owner cost' line in detailed PDF invoice:''' – checkbox, which control whether or not DID owner cost should be shown in detailed PDF invoice.
* ''' Show Destination with Prefix in Detailed Invoice:''' - checkbox, if enabled, destination will be shown as '''Destination Name (prefix)'''.
* ''' Rename red 'INVOICE' label in Simplified PDF Invoice:'''
* ''' Rename red 'INVOICE' label in Detailed PDF Invoice:'''
* ''' Rename red 'INVOICE' label in PDF Invoice by CallerID:'''
* ''' Use rounded Invoice Details Prices to calculate Totals''' - use rounded sub-totals to calculate Invoice Total price.
 

=== Details ===

* '''Address format''' – changes field positioning in the invoice for the address. You must select it in order to show address in the invoice.
* '''Address line 1-4''' – address info.
* '''Bank details line 1-5''' – bank details info.
* '''Invoice balance line''' – line for balance (e.g. "Your current balance is")
* '''Invoice to pay Line'''
* '''End title''' – a title for the end of your invoice.

* '''Add Average rate in detailed invoice''' – adds average rate in detailed invoice.
* '''Show Time in Minute''' – shows time in mm:ss instead of hh:mm:ss, for example, not 02:13:42 but 133:42.
 

=== Additional ===

* '''Show additional details on separate page''' – enables additional custom page at the end of the invoice.
* '''Additional details''' – the information to be displayed in a custom page at the end of the invoice.
 
=== Functionality ===

* '''Invoice allow recalculate after send''' – allows recalculating invoices after being sent. This setting also allows to delete sent invoices.
* '''Do not generate Invoices for blocked Users''' - if enabled Invoices will not be generated for blocked Users.
* '''Rename "Calls" label''' - changes 'Calls' name for Simplified Invoices and new Invoice XLSX. If you want to apply new 'Calls' name for old XLSX, you should go to Settings > Invoices > XLSX and mark 'New XLSX template apply for old Invoices'
* '''Start value for Invoice numbers''' - defines number from which Invoices numeration should start.
* '''Duration Format:''' - time format in invoice. This setting applies for XLSX type invoices (and PDF invoices generated from XLSX invoice) and Invoice Details page. Available options - 'H:M:S', 'H:M', 'M'. When option 'M' is used, sub option Decimal places appear, where you can select precision.
* '''Invoice Group By: Prefix / Destination'''
* '''Show Rates:No / Yes'''
* '''Show Calls in CID Invoice (CSV)''' - if enabled, then CSV Invoice by CallerID will show a list of calls.
* '''Show Subscriptions total Selfcost in Invoices List CSV''' - enables additional columns at the Invoice List, when using Export to CSV: Agreement Number, Issue date, Subscriptions total Selfcost. Columns are enabled for Admin and Resellers.

 

=== XLSX ===
* '''XLSX Template''' - choose XLSX Template for Invoices.
* '''Send XLSX Invoices converted to PDF''' – If enabled XLSX invoices will be converted to PDF before sending over [[Invoices#Send_invoices_by_email_.28manual.29|Email]] or [[Cron_actions#Generate_Invoices_and_send_by_Email|using cron action]]
* '''Group regular Calls by Destination''' - Groups regular Calls be destination
 

===See also===

* [[Invoices]]
* [[Invoice configuration]]
 

== Emails ==

'''SETTINGS –> Setup –> Settings –> Emails'''

* ''' Sending globally enabled''' – if this is checked, you will be able to use Mass Mailing and the system will send emails upon user registration.
* ''' Add recipient first name and last name''' – if this is checked, it will show the user's first name and last name if they are entered in the User Settings.
* '''SMTP server''' – hostname of the server.
* '''Port''' – port of SMTP server.
* '''Login''' – username to your SMTP server.
* '''Password''' – password to your SMTP server.
* '''Batch size''' – value for Mass Mailing, or how many emails to send at once.
* '''From''' – email address to put into From: field in email. Acceptable formats are: '''example@email.com''' or '''John Smith <example@email.com>'''.
* '''Test email sending''' – save settings and press this to test email sending. Do not forget to save settings first!
* '''TLS''' – '''Auto''', '''Yes''' or '''No'''. Default '''Auto'''.

'''P.S. Remember to set admin's e-mail in admin's personal settings. Without this test email sending will not work!'''

 
===See also===

* [[Emails|Mass Emails]]
* [[Email variables]]
 

== Various ==

'''SETTINGS –> Setup –> Settings –> Various'''

* '''Allow login by email''' - allow users to log in by email instead of a username.
* '''Logout link''' – a user will be redirected to this link after pressing "Logout"
* '''Agreement number length''' – number length in digits.
* '''Google Maps API key''' - the setting is necessary for using the Google Maps functionality. For more on how to configure this key please check [[Get Google Maps key]].
* '''Chanspy is disabled globally'''
*'''Send Recordings space warning Email''' - sends Email to Admin once a day if recordings exceed space limit.
*'''Delete Tariff Jobs older than''' - deletes tariff jobs older than set days.
*'''Delete Automatic Tariff Import Inbox Messages older than''' - deletes automatic tariff import inbox messages older than set days.
* '''Server free space limit''' – indicator when system should inform admin about low [[Multi_Server_support|Server]] space. By default 20%. Notice will appear in [[Integrity Check]] and every hour will send an email "Low Disk Space Alert". Which template can be found and edited on [[Emails]] page. Information about the Server and the remaining free space will be provided.
* '''Days for DID to close''' – how long to keep DID closed before making it free.
* '''DID for Unassigned DID''' - this feature is used for calls coming from providers to system DIDs. Allows redirecting call to specific DID if client dials nonexistent DID. If empty, then this feature is disabled and a call will be terminated with [http://wiki.kolmisoft.com/index.php/207_Not_clear_who_should_receive_call 207 Not clear who should receive call] hangup code.
* '''Play IVR for unauthenticated call'''
* '''Banned CLIs default IVR''' – default IVR to route banned numbers.
* '''Default Music On Hold''' - allows to select Default Music On Hold.
* '''Use Extension in CallerID for Local Calls''' - overwrites original CallerID with Device Extension when making local calls. Outside calls are not affected by this setting.
* '''Call Forwarding CallerID (via call)''' - allows to manage CallerID when [http://wiki.kolmisoft.com/index.php/Call_Flow#Change_Forward_action_by_Call forwarding is set by call].
* '''Force Users to use forwarding CallerID (via GUI)''' – possible options: '''Empty''' (the user will have all options available), '''From Device, Same as comes, Sames as comes - with Diversion'''.
** Default value for ''Same as comes - with Diversion'' is '''${MOR_SIP_TO};reason=unconditional''' that the admin can change.
* '''Enable "Allowed addresses" option for Providers:''' – allows Allowed Addresses functionality in Providers settings.
*'''Allow forward from Resellers''' - enables advanced device option: Allow forward from Resellers. More information about option in [https://wiki.kolmisoft.com/index.php/Device_settings#Advanced device settings].

== Tax ==

'''SETTINGS –> Setup –> Settings –> Tax'''

Settings are explained here: [[Multi-Tax system]]
 
== Backups ==

'''SETTINGS –> Setup –> Settings –> Backups'''

Configuration is explained here: [[Backup system]]
 
== API ==

'''SETTINGS –> Setup –> Settings –> 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. This will be used as a password for signing queries to MOR API, check [[MOR_API | MOR API documentation]] for more information
* '''XML API Extension''' – .NET does not follow standards (surprise!); enable this setting if you are using it to get XML starting with HTTP tags.
* '''Allow API Login Redirect''' – enable/disable
* '''API allow registration''' – enable/disable registration through API
* '''API allow Payments''' – enable/disable payments through API
* '''API Payment confirmation''' – enable/disable payments confirmation through API
* '''[[Balance_in_phone|Allow devices to check balance over HTTP]]''' – enable/disable device balance checking
* '''[[MOR_API_rate_get|Allow devices to check rate over HTTP]]''' – enable/disable device rate checking
* '''Disable hash checking''' – lets you skip hash parameter using API
* '''Uniquehash''' – shows your uniquehash
* '''Send Email To Admin after API/Manual Payment''' - sends Email to Admin after API/Manual payment. Email Template name: manual_payment_email
* '''Send Email to User after API/Manual Payment''' - sends Email to User after API/Manual payment. Email Template name: manual_payment_email_for_user
* '''Send Email To Admin after API/Balance Update''' - sends Email to Admin after API/Balance Update. Email Template name: balance_update_email
 
===See also===

[[MOR API]]
 

== Functionality ==

'''SETTINGS –> Setup –> Settings –> Functionality'''
 
===FAX===

* '''Fax device enabled''' – enable/disable Fax device in MOR. When admin enables FAX, Functionality tab appears in Reseller's GUI configuration. He can then enable or disabled fax for his own users himself.
* '''Fax2Email From Sender''' – there is a field "From:" in an email form. When MOR sends Fax to Email, "Fax2Email From Sender" value is displayed in "From:" field.
* '''Allow Users to change FAX email''' - allow simple Users to add/remove/edit FAX emails in FAX Devices.
* '''Fax2Email Email Template''' - [[Emails|email template]] to be used for Fax2Email emails. "None" means the default Asterisk template.
 

===CSV===

* '''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.
* ''' Archive CSV file when size reaches''' – if CSV file reaches a certain size, the system will archive it to save time to download it (0 means to archive always)
 
===Active Calls===

* '''How many maximum [[Active_Calls|Active Calls]] to show in GUI''' – how many [[Active_Calls| Active Calls]] to show in GUI
* '''[[Active_Calls| Active Calls]] refresh interval''' – [[Active_Calls|Active Calls]] refresh interval in seconds
* '''Show [[Active_Calls|Active Calls]] for Users''' – tick if you want to allow users to see [[Active_Calls|Active Calls]]
* '''Show Servers in [[Active_Calls|Active Calls]]'''
* '''Show DIDs in [[Active_Calls|Active Calls]]'''
* '''Show localized Source in [[Active_Calls|Active Calls]]''' - if set, [[Active_Calls|Active Calls]] will show callerid number after localisations (if any) have been applied.
* '''Show Originators' Device IP in [[Active_Calls|Active Calls]]'''
 

===Last Calls===

* '''Limit PDF size in Last Calls to''' - limits how many pages can be exported from Last Calls to PDF. It takes a lot of system resources to generate PDF files therefore this limit should be low enough to prevent high load on system.
* '''Show Device and its CallerID in Last Calls''' – shows additional column in [[Last Calls]] page with Device and its CallerID information. Click to reach that Device settings page.
* '''Show DID User instead of DID Device User in Last Calls''' - if enabled, shows DID User in Last Calls User/Name column instead of DID Device User. This option is relevant when incoming Provider calls DID that belongs to User A and is assigned to User's B Trunk. If option is enabled, User A will be shown. If option is disabled, User B will be shown.
* '''Show Terminated by in Last Calls''' - show Terminated By column in [[Last Calls]], calls CSV/PDF export, and adds the possibility to select this column in [[CDR Export Templates]].
* '''Show Usernames on PDF/CSV Export Files in Last Calls''' – if checked, when a particular User in the Last Calls page search is selected, the Last Calls PDF/CSV file name will be composed also of the Name of selected User. If you are looking for All Users, no User Name will be used. (Name of the User will be shown in Name of the CSV/PDF file).
 

===Tariffs/Rates===

* '''Show rates for users''' – allows users to see rates
* '''Show rates without Tax''' – shows rates without TAX
* '''Show [[Advanced_Rates|Advanced Rates]] for users''' – allows users to see [[Advanced_Rates|Advanced Rates]]
* '''Show zero rates in LCR tariff export:''' – shows zero rates in LCR tariff exported file.
* '''Delete outdated Rates after''' - Delete outdated Rates after some dates.
* '''Show Ghost percent column in Tariffs:''' – if enabled, the Ghost percent column will be shown in the tariff. Default disabled.
NOTE: if [[Custom Rates]] and/or Tariff Rates are set for the user, only the custom rates will be shown in the details of destination rates.
 

===Statement of Account===
* ''' PDF Settings ''' - allows to put Address lines of PDF file for Statement of Account.
*Address line 1: Street Address
*Address line 2: City, Country
*Address line 3: Phone, fax
*Address line 4: Web, email
*Bank details line 1
*Bank details line 2
*Bank details line 3
*Bank details line 4
*Bank details line 5
*Bank details line 6
*Bank details line 7
*Bank details line 8
 

==Privacy==

'''SETTINGS –> Setup –> Settings –> Privacy'''

* '''[[Privacy_to_hide_Destination_ends|Privacy to hide Destination ends]]'''
* '''[[GDPR]] Activated''' – hides User data with notification "Data hidden due GDPR. Press to show data (action will be logged)". Valid for Admin, Accountant, Reseller and Partner.

== Visual ==

'''SETTINGS –> Setup –> Settings –> Visual'''

* '''Items per page (Setting high value can cause performance issues)''' – the number of items to display per one page
* '''[[Global_date_format| Default date format]]''' – System default date format
* '''Default Time Format''' – System default time format
* '''Default Hour Format''' - System default hour format
* '''Default Number Decimal''' – with this option you can set default number decimal for all GUI
* '''Number digits''' – how many digits to display after a comma
* '''Hide Quick Stats in Start page''' – hide Quick stats from start page
* '''Hide "Information about this page" link''' – hide HELP banner in GUI
* '''Hide "I want to" help links'''
* '''[[Remove_Manual_link_from_admin_GUI|Hide "Manual" link]]''' – hides "Manual" link
*'''Hide Provider Payments from User Payment List''' - default off.
* '''Show Full Source (CallerID Name and Number)'''
* '''Use <> brackets in CDR export''' - changes brackets in CDR export
* '''Show only main page''' – this is a very advanced feature for those who want to hide default MOR menu tree on the left so that they could build their own menu using advanced techniques without modifying MOR GUI sources.
* '''Show forgot password''', because this functionality requires a unique email in the system. The setting can be unchecked if all emails are unique in the system.
** '''From Device''' - puts CallerID for the Device that is forwarding the call. If Device CallerID is empty, then the originator's CallerID will be used.
** '''Same as comes - unchanged''' - leaves the CallerID as it comes from the originator.
** '''Same as comes - with Diversion''' - leaves the CallerID as it comes from the original caller and additionally adds SIP header Diversion with CallerID from the Device that is forwarding the call (header will not be added if Device does not have CallerID set).
* '''Show forgot password''' – turns on '''[[MOR_forgot_user_password | Forgot password]]''' functionality.
* '''Show detailed Quick Stats''' - shows modified quick stats of first page.
* '''Show Replication Broken warning only for Admin''' - if enabled, shows Replication Broken warning message only for Admin account.
* '''Change LCR priority by using drag and drop'''
* '''New Menu Active''' - if enabled, changes main menu to the new structure.
* '''Dropdown field in User's subscriptions''' - enables old style Service selection in Subscription form.
* '''Show entered Destination only for Users''' - show the Destination numbers for Users that were entered by them and not Destination numbers after Localization.
* '''Show Company Name column in Users page''' - show "Company Name" column in Users list page.
 

== Server load ==

'''SETTINGS –> Setup –> Settings –> Server load'''
 
Settings for GUI Server and Database Server

* '''HDD utilisation higher than''' – Percentage of CPU time during which I/O requests were issued to the device (bandwidth utilization for the device).
* '''CPU General Load higher than''' – CPU General load higher than – Percentage of the CPU for user processes.
* '''CPU Load Stats 1 higher than''' – average load per one minute on the system
* '''CPU MySQL process higher than''' – Percentage of the CPU for MySQL process
* '''CPU Ruby process higher than''' – Percentage of the CPU for Ruby process
* '''CPU Asterisk process (if present) higher than''' – Percentage of the CPU for Asterisk process
* '''Delete Server Load Stats older than''' – deletes internal servers load statistics older than defined number of days.
 

== Calls ==

'''SETTINGS –> Setup –> Settings –> Calls'''
* '''Retrieve PCAP files from the Proxy Server''' – default off. Works only when CCL module is activated.

* '''SQL Max Execution Time''' - max execution time in seconds for SQL query. The default time is 300 seconds (5 minutes). Used in Statistics pages (Calls List export and similar).
 
[[Archived calls]]
 

== FTP ==
Please fill up FTP server details if you want to store Archived calls or/and Backups to FTP server.

* '''IP''' - Enter FTP server IP.
* '''Port''' - Enter FTP server Port.
* '''Username''' - Enter FTP server Username.
* '''Password''' - Enter FTP server Password.
* '''Path for Archived Calls''' - Enter Path for Archived Calls.
* '''Path for Backups''' - Enter path for Backups.
* '''Path for CDR Export''' - Enter path where to export CDRs.
 

== SFTP ==
Please fill up SFTP server details if you want to use SFTP for [[Automatic CDR Export]].

* '''IP''' - IP of the SFTP server.
* '''Port''' - Port of the SFTP server.
* '''Username''' - Username to connect to SFTP server.
* '''Password''' - Password to connect to SFTP server.
* '''Use SSH key''' - Use SSH key configured as described [[Configure SSH connection between servers|here]].
* '''Path for CDR Export''' - Path in SFTP server where to export CDRs.
* '''Skip CA verification''' - skips SFPT servers CA verification. Try to enable it if the test passes, but if the upload fails. Adds the --insecure option as described here https://curl.se/docs/sslcerts.html
* '''Path to CA Certificate''' - optional. Allows specifying a custom CA store. Adds the --cacert [file] option as described here https://curl.se/docs/sslcerts.html
 

== Security ==
* '''Allow short passwords in devices'''
* '''Use strong passwords for users'''
* '''Admin login with approved IP only''' - security measure which allows to approve IP's that try to [[MOR_Login_with_approved_IP%27s|login with Admin Account]].
* '''Enable IP report warning on login failure''' - show [[MOR_Login_Failure_Report|warning]] on unsuccessful login attempts.
* '''Logout after password change''' - terminates all sessions of the User whose password is changed.
* '''Logout after closing browser window''' - terminates all sessions of the User after closing browser window.
* '''Do not logout on session IP change''' - do not logout from MOR GUI if IP is changed.
* '''2FA Enabled''' - Enables two factors authentication. Two factors authentication requires to enter emailed code during login to user account. '''2FA Enabled must be also enable on individual [[User_Details|User settings]] to make it work for that User.'''
** '''Email Template''' - [[Emails|email template]] used to send the code.
** '''Code length (digits)''' - code length.
** '''Code Enter Attempts Allowed''' - number of attempts to enter the code correctly. Code expires after this number of failed attempts.
** '''Code Enter Time Allowed''' - code is valid for this amount of time.
** '''Send Notification Email to Admin on Login''' - allows admin to get email notification on login.
*** '''Email Template''' - [[Emails|email template]] used to notify admin.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
** '''Send Notification Email on Login''' - allows this mailbox to get email notification on login.
*** '''Email Template''' - [[Emails|email template]] used to notify.
*** '''On Admin Login''' - get notification on login to Admin's account.
*** '''On User Login''' - get notification on login to User's accounts.
 

=See also=

* [[Server is overloaded]]

Cron actions

2024-07-02T15:20:13Z

Ervinas:

=Descriptions=
Cron actions is MOR functionality which allows you to do some tasks at a specified time. Currently supported actions are these:

* Change tariff (for Users and/or LCRs)

* Change LCR (for Users)

* Change provider tariff (for Providers)

*  Generate Invoice (for Users)

* Send SOA (Statement of Account)
 
'''NOTE''' that currently only System Admin is allowed yo use this functionality.
 

=Important notes on billing=

MOR takes the call price before the call and uses it to calculate the final price after the call is finished.

Example: User starts a call at 9:58 PM and is talking for 5 minutes, you have an action which changes tariff at 10:00 PM. When call will be finished MOR will bill user using older tariff. If user starts a call after tariff change - he will be charged using the new tariff assigned for him.
 
=Usage=

Go to '''SETTINGS –> Setup –> Settings –> Cron actions''':
 
[[File:Cron_actions_path.png]]
 
Here you will find list of all Cron Actions
 
[[File:Cron_settings_list.png]]
 
Click [[Image:icon_add.png]]'''Add new Cron Action''' to create new Cron Action.
 
==Example: Change tariff==

''Here is an example with an action '''Change tariff''' (applied for Users)''
 
[[File:Cron_actions_settings.png]]
 
'''Name''' – enter here something that will help you to remember what this settings is about

'''Action''' – what to do. To change Tariff for User, choose '''Change tariff'''

'''For User''' – for which User/Users action has to be applied

'''Where current Tariff is''' – for All Users and Location Rules where selected Tariff/Tariffs assigned.

'''Change to Tariff''' – which tariff to set

'''Periodic type''' – how often to perform the task

'''Repeat forever''' – makes action never stop. '''NOTE:''' this setting does not work when the Periodic type is set to '''One Time'''.

'''From''' – when to start doing the action

'''Till''' – when to stop doing the action

'''Description''' – you can use this field for your notes
 

==Example: Generate Invoices and send by Email ==


''Here is an example with an action '''Generate Invoice''' (applied for Users)''
 
[[File:Cron_actions_settings2.png]]
 

'''General'''

* '''Name''' – enter here something that will help you to remember what this settings is about

* '''Action''' – what to do. To generate Invoice for User, choose '''Generate Invoice'''

'''Details''' – Invoice Details

* '''User''' – for which User/Users action has to be applied

* '''Currency''' – currency which will be used for Invoice generation

* '''From''' – day of the month which should be used as '''start of Invoice period'''

* '''Till''' – day of the month which should be '''end of Invoice period'''

* '''Send after Invoice is generated?''' – if email sending is enabled, you can choose to send Invoices after it is generated.

'''Repeat''' – Cron Action repetition

* '''Periodic type''' – how often to perform the task: One Time, Monthly (Invoices are generated based on the specified '''From''' and '''Till''' dates, with a minimum start time of 6:00 AM if the '''Repeat From''' date is the day after the '''Till''' date), Bimonthly (every 2 months), Quarterly (every 3 months), Half-yearly (every 6 months), Dynamic.

* '''Repeat forever''' – makes action never stop. '''NOTE:''' this setting does not work when the Periodic type is set to '''One Time'''.

* '''From''' – when to start doing the action

* '''Till''' – when to stop doing the action

'''Description''' – you can use this field for your notes
 

==Every X days in Dynamic Periodic type==
[[File:Everyxdays.png]]
 
For example, we choose parameter '''From date''' 2018-09-06 and parameter '''every 4 days'''.

System will start to generate the invoice at 2018-09-11 and invoice will be generated for period 2018-09-06 and 2018-09-09.

Next invoice generation will begin at 2018-09-15 and period for this invoice will be 2018-09-10 and 2018-09-13.

 
[[Background Tasks|Background task]] for [[Invoices#Invoice_generation|Invoice generation]] will be created based on the specified '''From''' and '''Till''' dates, with a minimum start time of 6:00 AM if the '''Repeat From''' date is the day after the '''Till''' date. The repetition period determines when tasks have to be created. This is done to account for possible time zone differences and to ensure that the billing period is over for a user. This applies to the Invoices action only.

For example, we want to generate Invoices every month for full month from 2015 October 1 until 2016 January 1.

* In '''Details''' section we select '''From''' - 1 and '''Till''' - 31
* In '''Reapeat''' section we select '''Periodic type''' - monthly, '''From''' 2015 October 1 00 '''Till''' 2016 January 1 00
* When '''Create''' button is pressed at 2015 October 1 06 we will find Invoices of September

'''NOTE''' If Repetition start date and time is over 48 hours after nearest end of selected Invoice period, first group of Incvoices will be generated more than after one month.

 

=See also=

* [[Users]]
* [[LCR]]
* [[Providers]]
* [[Tariffs]]
* [[Invoices]]

M4 Rate Notifications

2022-10-11T12:23:44Z

Ervinas: /* Creating Rate Notification */

= Introduction =

Whenever there are Rate updates or changes in the Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing users to quickly and automatically create Jobs that inform Users about upcoming (depending on effective from the value in the future) Rate prices and also await their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications Templates =

[[File:RateNotificationTemplate1.png]]
 
The data is generated into an XLSX file. The system contains a '''Default''' template, which is assigned for all users.
 
[[File:RateNotificationTemplate2.png]]
 
It is possible to create a custom template file and use it for customers by clicking '''ADD NEW TEMPLATE''' and filling cells by your needs or uploading an XLSX Template file.
*Note: If a row has a value, the column near it cannot be blank.
 
[[File:RateNotificationTemplate3.png]]
 
It is also possible to assign Rate Notification Template for a User in his settings.
 
[[File:RateNotificationTemplate4.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when the following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. 
All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for these specific Notifications. 
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Template - Rate Notification Template.
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs.
** Additional possible variables:
*** rate_notification_tariff_name - Rate Notification's Tariff name
*** rate_notification_url_agree - Rate Notification's Agreement link
*** rate_notification_url_disagree - Rate Notifications' Disagreement link
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. A Timeout adds specified days value to Notification created time.
* Filename - Name of the notification file.
* Send Email:
** Every day: send an email every day until either Agreement link is pressed or Agreement Timeout is reached
** Once: send email only one time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
Rates will be converted using the default currency. To prevent conversion, setting - "Use Tariff currency in the CSV export" must be enabled. 
This setting can be found in Maintenance -> Settings -> Various -> Use Tariff currency in CSV export. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
'''Email will not be sent if there were no changes in rates!'''
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed, or ignored. The list will display specific responses and time it was responded on. Also an additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, the user gets an email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, the User disagrees and presses the second link. He can see the notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

When the User disagrees with the provided rates or ignores them, the system creates a Custom Tariff from the tariff assigned to Origination Point.

Custom Tariff includes increased rates, but these rates are blocked and calls will not pass over these destinations.

This Custom Tariff is assigned to Origination Point.

'''Note''':

1. If Origination Point already has Custom Tariff assigned, Custom Tariff from Rate Notification will be applied.

2. If Origination Point has assigned Conditional Tariff and User disagrees with the provided rates or ignores them, Custom Tariff is created, but is not assigned to Origination Point.

M4 Rate Notifications

2022-10-11T12:22:22Z

Ervinas: /* Creating Rate Notification */

= Introduction =

Whenever there are Rate updates or changes in the Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing users to quickly and automatically create Jobs that inform Users about upcoming (depending on effective from the value in the future) Rate prices and also await their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications Templates =

[[File:RateNotificationTemplate1.png]]
 
The data is generated into an XLSX file. The system contains a '''Default''' template, which is assigned for all users.
 
[[File:RateNotificationTemplate2.png]]
 
It is possible to create a custom template file and use it for customers by clicking '''ADD NEW TEMPLATE''' and filling cells by your needs or uploading an XLSX Template file.
*Note: If a row has a value, the column near it cannot be blank.
 
[[File:RateNotificationTemplate3.png]]
 
It is also possible to assign Rate Notification Template for a User in his settings.
 
[[File:RateNotificationTemplate4.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when the following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. 
All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for these specific Notifications. 
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Template - Rate Notification Template.
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs.
** Additional possible variables:
*** rate_notification_tariff_name - Rate Notification's Tariff name
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. A Timeout adds specified days value to Notification created time.
* Filename - Name of the notification file.
* Send Email:
** Every day: send an email every day until either Agreement link is pressed or Agreement Timeout is reached
** Once: send email only one time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
Rates will be converted using the default currency. To prevent conversion, setting - "Use Tariff currency in the CSV export" must be enabled. 
This setting can be found in Maintenance -> Settings -> Various -> Use Tariff currency in CSV export. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
'''Email will not be sent if there were no changes in rates!'''
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed, or ignored. The list will display specific responses and time it was responded on. Also an additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, the user gets an email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, the User disagrees and presses the second link. He can see the notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

When the User disagrees with the provided rates or ignores them, the system creates a Custom Tariff from the tariff assigned to Origination Point.

Custom Tariff includes increased rates, but these rates are blocked and calls will not pass over these destinations.

This Custom Tariff is assigned to Origination Point.

'''Note''':

1. If Origination Point already has Custom Tariff assigned, Custom Tariff from Rate Notification will be applied.

2. If Origination Point has assigned Conditional Tariff and User disagrees with the provided rates or ignores them, Custom Tariff is created, but is not assigned to Origination Point.

Implement login form into your website

2020-10-28T02:38:24Z

Ervinas:

Use such form (press [http://wiki.kolmisoft.com/index.php?title=Implement_login_form_into_your_website&action=edit here] to see HTML code):

<html>
<head>
<title>Your MOR login</title>
</head>
<body>
<form action="http://your_mor_gui_host/billing/callc/try_to_login" method="get">
<input class="input" id="login_username" name="login[username]" size="11" type="text" />
 
<input class="input" id="login_psw" name="login[psw]" size="11" type="password" />
 
 
<input name="commit" type="submit" value="Login" />
</form>
</body>
</html>

Automatic Tariff Import

2020-10-21T12:15:24Z

Ervinas: /* Analysis */

<big><big>NOTICE: this is an add-on. Its functionality is identical in M2/MOR softswitches. M2 screenshots are used in this guide. It looks similar in MOR.</big></big>

= Introduction =

An important task is the timely management of Provider Tariff Plans. While business practices differ somewhat, usually, each Provider will deliver an initial spreadsheet file detailing their prices to the range of Destination Codes that they are providing. This initial spreadsheet will be followed by update notification spreadsheets. These will be received at regular agreed-upon intervals, identifying amendments to the previous prices. The format and content of these notifications are not standardized and consequently differ from one Provider to another. This information is vital, from a commercial and financial management point of view. It is therefore important that the rating information received from a Provider is uploaded regularly, in order that the System can correctly calculate Provider rating costs for calls. It is also important to analyze Tariff/Rating Plan updates received from partners, in order to ensure that any errors are noticed early and resolved before causing Billing disputes.

Doing all this by hand is a long and tedious process. It is possible to automate it with a human-in-between approach that requires confirming the final import step, to avoid potential misconfiguration problems.

To solve this necessity Tariff Import system should be used. Let's start by defining the major terms used in this process.

 
= Workflow schema =

The workflow can be visualized using the following schema:

 
[[File:M2TIImage15.png]]
 

As can be seen, there are two components to this process:

# The configuration component, which is done once for each tariff file received from the provider
# The actual working component, where an automated process takes care of the tariff import, based on the settings configured in the first component

 

=Initial (Manual) Setup for Automation=

This sequence of steps is necessary to configure automatic import of the concrete tariff format received from any provider. Once configured, it can be used many times thereafter, until the provider decides to change the format.

==Rate file received from Provider examined and analyzed==

As every Provider sends different format files, their structure should be analyzed and necessary fields marked for Template creation.

XLSX file can be compressed to RAR or ZIP archive.

==XLSX Transformation Template created==

The Provider Import Template is the primary object that requires configuring before the Provider Rating Import can occur. The Provider Import Template contains the settings that the System uses to convert information from the Spreadsheet into the System.

==Rate Import Rules created==

The Rate Import Rules feature enhances the analysis of the Providers‘ rates by identifying rates that do not meet a specific criterion (for example, a rate increase with fewer than seven days notice) and then either alerting the Administrator or rejecting the rate.

==Tariff Import Rules created==

Tariff Import Rules assign each received Email/Attachment to the correct Provider/Tariff with appropriate Rate Import Rules, Notifications, and Template to properly convert received Tariffs and upload rates to the System.

==Email Notifications configured==

Notifications will generate an email to the desired recipient when configured for various events, such as:

* Tariff is received
* The tariff is analyzed and waiting for confirmation before import
* The tariff is imported or rejected
* Others

 
=Normal (Automatic) Workflow=

Based on preconfigured settings in the first step, the Automatic Tariff Import could be carried out by using all the defined settings.

==Rate file received from Provider via email==

One mailbox, usually named by rates@companyname.com, is monitored by the system and all received emails are analyzed.

==Email/Attachments analyzed by Tariff Import Rules==

When an email with a tariff attachment comes in, it is checked for address, email subject, attachment name, and other parameters to properly map the received Tariff file with the following procedures.

==Rate Plan converted and analyzed==

Based on the Tariff Import Rules, the Tariff file is converted to a standardized format (a process called Normalization) and then analyzed. During analysis, the Rate Import Rules are applied and necessary actions are taken based on the Rules.

==Notification for Review sent==

If there are no major problems, the responsible person receives an email saying that the Tariff is converted with such and such notices or warnings, and waits for approval. It is possible to skip this step with 100% automation, but it is usually not recommended, due to possible errors that human intervention could help to avoid..

==Import Denied==

The responsible person can deny the tariff import, based on the information received. The analysis could identify errors that can't be ignored or some other issues.

==Import Accepted==

If there are no major issues, the responsible person accepts the tariff import and the system is notified to continue the import.

==Tariff Imported==

The actual tariff import takes place, and old rates are replaced by the new ones. All of the preparation work culminates in this step.

 
= How it is implemented in the system =

 
[[File:M2TIImage56.png]]
 
[[File:M2TIImage20.png]]
 

Tariff Jobs table columns:
* Id: Tariff job identification number.
* Created at: Date when the job was created.
* Status: The state of the import process. Can be:
** Assigned - import process was started.
** Converting - rates are being converted.
** Failed Conversion - there was an error in rate conversion.
** Converted - rates were successfully converted.
** Importing into Temporary Table - rates are being uploaded from attachment to the system.
** Failed to Import into Temporary Table - there was an error in rates uploading process.
** Imported into Temporary Table - rates have been loaded to the system.
** Analyzing - rates are being analyzed.
** Failed Analysis - there was an error in the analysis. By lowering over Failed Analysis you can get more details.
***rate_with_multiple_ratedetails_found refers to Rate Details (where you can set rate for peak/off peak hours) being used on one or more rates on target tariff. Such rates are not supported by tariff import.
** Analyzed - analysis process has been completed.
** Rejected - rates did not match requirements and were rejected.
** Waiting for confirmation - import is stopped until it will be confirmed by admin.
** Cancelled - import was canceled by admin.
** Imported - rates were successfully imported.
* Import Rules - the name of the Tariff Import Rule used in import and the link to its edit view.
* Rate Import Rules - the name of the Rate Import Rules used in import and the link to its edit view.
* Tariff - Tariff name which is being changed in import and the link to its edit view.
* Attachment - the name of the attachment that was used in import.
* Import Type - the type of import. Can be:
** Update - rates will be added or updated.
** Full - rates will be replaced.
* Auto:
** ‘Yes’ means that tariff import will be done without any request for confirmation.
** ‘-’ means that confirmation will be needed after the analysis.
* Email:
** ‘Yes’ email about Tariff Job creation has been sent successfully.
** ‘-’ email has not been sent.
* Rate Changes - number of how many rates were changed during analysis.
* Rejected Rates - number of how many rates were rejected during analysis.
* Analysis (only in analyzed jobs) - link to analysis details.
* Delete - button to delete one job.

Note: yellow-colored Tariff Jobs rows show that they are waiting for confirmation.

Automatic Deletion

Old Tariff Jobs are periodically deleted by the system. The period of deletion can be found and changed in Settings -> Various -> Delete Tariff Jobs older than. The default value is 30 days. It means that Tariff Jobs which were created before 30 days or more will be deleted.

 
[[File:M2TIImage9.png]]
 

= Analysis =

Detailed Analysis can be reached from the Tariff Jobs table by pressing on the ANALYSIS link.

On the top right corner there are buttons:

 
[[File:M2TIImage101.png]]
 

* Confirm: results of the analysis are confirmed and tariff import will continue to proceed.

 
[[File:M2TIImage78.png]]
 

* Canceled: tariff import will be canceled.

 
[[File:M2TIImage69.png]]
 

* Schedule: Schedule Import from. Rates will be imported by the selected time if there are no Jobs waiting for the same tariff.

 
[[File:M2TIschedule.png]]
 

* Refine Results: allows filtering table by selected parameters.

Parameters:
: Rate Increase, Oldest Effective date, Max Decrease, Duplicate Rate, Date Decrease, Maximum Effective Date, Max Rate, Min Times, New Rate, Max Increase, Zero Rate, Increments - can be filtered by values: All (default), None, Alert, Rejected.

: Non Importable Reasons - can be filtered by values All (default), None, Any, Could not determine direction code, Rate price invalid, Effective from invalid.

 
[[File:M2TIImage94.png]]
 

Tariff Job Analysis table:

 
[[File:M2TIImage31.png]]
 

Table columns:
* Prefix: prefix on which the rate will be applied.
* Destination: destination name.
* Rate: rate value.
* Connection fee: [[How the Connection fee works]]
* Increment: [[What is increment]]
* Minimal time: [[What is increment]]
* Effective from: [[Rate Effective From]]

Tooltip:
If the mouse is on the table, additional import rule information will be presented.

 
[[File:M2TIImage32.png]]
 

Row colors:
* If the row is red-colored, the rate is not importable. Non-Importable Reason can be found by moving mouse over the rate.
* If the row is yellow-colored, the rate analysis was successful but there were some warnings. In the tooltip, the word ‘alert’ will be next to the parameter which caused the alert.
* If the row is white-colored, the rate analysis was successful.

Analysis execution order:
If the analysis is being executed on several jobs which includes the same tariff, these jobs will be resolved consistently and the oldest job will have the highest priority. The next analysis of the job will be started only after the previous one is completed.

= Understanding and Working with Provider Import Templates =

A Template is created when a Tariff/Rating Plan first needs importing, and can then be reused every time an update is required.
Templates can also be amended at a later point if the format of the original file is altered. Import Templates are highly flexible and support many Rating Plan formats; they, therefore, include many options that may not need configuring for the more common simpler Tariffs/Rating Plans.

The Templates work by mapping the contents of an Excel sheet, and its format, to the information required in the Database.
By configuring this information the data is then uploaded into the System and converted into the correct format.

This is illustrated in the diagram below:

 
[[File:M2TIImage64.png]]
 

Tip Before You Begin:
Import Templates are specific to individual Tariffs/Rating Plans, so when creating a new Import Template for the first time it is important to have easy access to the Tariff/Rating Plan involved.
A good tip for working with this - if you happen to have two monitors on your computer - is to display the Tariff/Rating Plan for which the Template is being constructed on one monitor, and System GUI on the other. Alternatively, if only one monitor is available, open the Tariff/Rating Plan in Excel and use Alt+Tab to switch directly between the applications.

The next section is going to describe each of the settings available for configuring an Import Template.

The screenshot below shows the Template Settings in the default basic view:

 
[[File:M2TIImage113.png]]
 

In this view, we can see the basic summary of the Template highlighting each of the sections that may be required to import the Tariff/Rating Plan.

Tip:
Remember that if the Tariff/Rating Plan being imported does not include information relating to a particular section of the Template, then that section can simply be left blank. Many Import Templates will be very simple configuring only four or five settings from the available options.

Name
: Name of the Template can be set to any, but for better management suggested to be the name of Provider.

Rate Sheet
: The Rate Sheet field requires to be set to the corresponding Worksheet in Excel that the Rating Plan information is held on.
: This means that Rating Plans that contain multiple sheets can still be imported.

: Example:
: In provided Tariff/Rating Plan below - Destinations, Prefixes, and Rates are stored in the second (“Numberplan”) Worksheet.
: [[File:M2TIImage73.png]]
: Accordingly, Template’s Rate Sheet value must be set to 2.
: [[File:M2TIImage97.png]]
 

Header Rows
: Header Rows setting requires to be set to inform the System of the rows at the top of the Tariff/Rating Plan that are to be ignored when importing meaningful data.
: If Header Rows are set incorrectly, there is a possibility that the Tariff/Rating Plan will not be imported at all or with errors because of wrongly processed data.

: Example 1:
: Provided Tariff/Rating Plan below meaningful data starts from Row 1.
: [[File:M2TIImage44.png]]
: This means there are no rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 0.
: [[File:M2TIImage124.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below meaningful data starts from Row 23.
: [[File:M2TIImage40.png]]
: This means there are 22 rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 22.
: [[File:M2TIImage114.png]]
 

Prefix/Code
: Prefix/Code requires to be set to match the Tariff/Rating Plan Prefix column.
: On some occasions, there may be two columns (like Country Code, City Code) which the System is also able to handle if Template settings are correct.
: Sometimes provided multiple Prefixes are displayed in singular cell format like “71-76”, “55,551,552,55257” or “370, 371, 372-376, 3772”, such formats are parsed automatically and does not require additional configuration.

: Example 1:
: Provided Tariff/Rating Plan below has only one Prefix column which is B.
: [[File:M2TIImage68.png]]
: Accordingly, Template’s Prefix/Code value must be set to B.
: [[File:M2TIImage42.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Prefix columns which are C and D.
: [[File:M2TIImage67.png]]
: Accordingly, Template’s Prefix/Code values must be set to C and D in exact order.
: [[File:M2TIImage28.png]]
 

Destination/Zone
: The Zone drop-down list box identifies the Column in the Excel sheet that contains the Zone name.
: If there is only one Column containing this information then only one of the dropdown boxes needs to be completed. However, if the Zone is in two Columns then both of the drop-down boxes can be completed to identify this. In this scenario, the blank fields either side of the second box can be used to format the Zone name.
: Example: A Rate Plan includes the following information:
: [[File:M2TIImage59.png]]
: The Zone import is configured with the Columns A and B and the separator fields with space “Column B”, as shown:
: [[File:M2TIImage5.png]]
 
: This means that the Zone name will be displayed as Brazil Mobile

: Example 1:
: Provided Tariff/Rating Plan below has only one Destination/Zone column which is A.
: [[File:M2TIImage7.png]]
: Accordingly, Template’s Destination/Zone value must be set to A.
: [[File:M2TIImage21.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Destination/Zone columns which are A and B.
: [[File:M2TIImage34.png]]
: Accordingly, Template’s Destination/Zone values must be set to A and B in exact order.
: [[File:M2TIImage5.png]]
 

Connection Fee
: While uncommon in wholesale, some Rating Plans being imported may still include a fixed Connection Charge - a one-off charge applied when the call is connected.
: If required, the Connection Charge drop-down list box can be used to identify the Column containing such a charge in the Rate Plan being imported.

Effective Date
: The Effective Date options determine in which Column(s) the Date and Time information for the imported rates can be found.
: Multiple options are provided to support different Spreadsheet formats.
: Some Tariff/Rating Plan Providers split Effective Date data between two Worksheets, whereas in the first Worksheet there are Destinations with Effective Date and in the second Worksheet - Destination, Prefix, Rate data. Configuration of such cases is provided in Example 3.

: Example 1:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date value can be set to F.
: [[File:M2TIImage10.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Effective Date column which is F and Effective Time which is G.
: [[File:M2TIImage17.png]]
: Accordingly, Template’s Effective Date values can be set to F and G.
: [[File:M2TIImage43.png]]
 

: Example 3:
: Provided Tariff/Rating Plan below in the first Worksheet shows Destination (Column A) and Effective Date (Column D).
: In the second Worksheet, there are Destination (Column A), Prefix (Column B), and Rate/Price (Column C).
: [[File:M2TIImage112.png]]
: The first dropdown configures from which Worksheet takes Effective Date data (which in this example’s case is Worksheet 1 (Rates)).
: The second dropdown configures the Effective Date column from the secondary Worksheet.
: The third dropdown configures by which secondary Worksheet column do the mapping with primary Worksheet (which in this example’s case is Destination from Worksheet 1 (Rates) Column A).
: The fourth dropdown configures by which the primary Worksheet column does the mapping with secondary Worksheet (which in this example’s case is Destination from Worksheet 2 (Numberplan) Column A).
: Accordingly, Template’s Effective Date values can be set to 1, D, A = A.
: [[File:M2TIImage100.png]]
 

Effective Date Format
: After selecting the Column, the Format field is used to specify the format the information is held in the Rate Plan.
: Some suggested formats already exist in the dropdown, which can be selected or used as an example to create a custom one if it is not present in the dropdown.

: Example:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date Format value can be selected from the dropdown with suggested formats.
: [[File:M2TIImage50.png]]
 

Rate
: Rate requires to be set to match the Tariff/Rating Plan Rate/Price column.

: Example:
: Provided Tariff/Rating Plan below has a Price column which is E.
: [[File:M2TIImage60.png]]
: Accordingly, Template’s Rate value must be set to E.
: [[File:M2TIImage51.png]]
 

Minimal Time
: Minimal Time can be set to match the Tariff/Rating Plan Minimal Time column.

: Example 1:
: Provided Tariff/Rating Plan below has a Minimal Time column which is E.
: [[File:M2TIImage46.png]]
: Accordingly, Template’s Minimal Time value can be set to E.
: [[File:M2TIImage52.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has a Minimal Time column which is D and in the first place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Minimal Time value can be set to D and field 1.
: [[File:M2TIImage26.png]]
 

Increment
: Increment can be set to match the Tariff/Rating Plan Increment column.

: Example 1:
: Provided Tariff/Rating Plan below has an Increment column which is F.
: [[File:M2TIImage63.png]]
: Accordingly, Template’s Increment value can be set to F.
: [[File:M2TIImage11.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Increment column which is D and in the second place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Increment value can be set to D and field 2.
: [[File:M2TIImage103.png]]
 

===Exceptions===

: Exceptions allow additional data manipulation when specific rules are defined separately in the provided Tariff/Rating Plan. Exceptions are set in Templates (BILLING > Tariff Import > Import Rules > Templates > EDIT). Mask field allows to define which Destinations/Zones should have exceptional values set. % can be used as a wild card to match part of a text in Destination/Zone. See examples below:

: Example 1:
: [[File:M2TIImage41.png]]
: [[File:M2TIImage6.png]]
 

: Example 2:
: [[File:M2TIImage16.png]]
: [[File:M2TIImage19.png]]
 

= Creating and Configuring Rate Import Rules =

Rate Import Rules are relevant to the importing of Provider Rates and specify actions to be taken if the rule is broken.

The actions available are:
* None (ignore this rule)
* Alert (notify the Administrator)
* Reject Rate (automatically reject the rate which breaches this rule)

Example:
The first Rate Import Rule is the rate increase rule. The variable for this rule is a number of days, 7 days by default.
What this means is that when a Provider Tariff/Rating Plan is uploaded and a rate increase is detected with an Effective Date less than 7 days into the future the action that has been configured will be triggered. The rate could be automatically rejected, or an alert about this rating entry was raised.

 
[[File:M2TIImage70.png]]
 

Available Rate Import Rules with explanation to each one of them:

 
[[File:M2TIImage93.png]]
 

Rate Increase
: If updating existing Rate, whose Rate (Price) increases and takes into effect earlier (by days compared to importing effective from) than set in Rule, then set action will be taken.
: Value can be set to any integer between 0 and 30 which represents the day(s).

Rate Decrease
: If updating existing Rate, whose Rate (Price) decreased and takes into effect earlier (by days compared to importing effective from) than set in Rule, then set will be taken.
: Value can be set to any integer between 0 and 30 which represents the day(s).

New Rate
: If creating a new non-existing Rate, which takes into effect earlier (by days compared to importing effective from) than set in Rule, then set action will be taken.
: Value can be set to any integer between 0 and 30 which represents the day(s).

Oldest Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is earlier (by days) than set in Rule, then set action will be taken.
: Value can be set to any integer between 0 and 365 which represents the day(s).

Maximum Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is later (by days) then set in Rule, then set action will be taken.
: Value can be set to any integer between 0 and 365 which represents the day(s).

Max Increase
: If updating existing Rate, whose Rate (Price) increased more by percentages than set in Rule, then set action will be taken.
: Value can be set to any decimal between 0 and 500 which represents Rate’s (Price’s) percentages.

Max Decrease
: If updating existing Rate, whose Rate (Price) decreased more by percentages than set in Rule, then set action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) percentages.

Max Rate
: If updating existing or creating a new Rate, whose Rate (Price) is higher than set in Rule, then set action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) value.

Zero Rate
: If updating existing or creating a new Rate, whose Rate (Price) is zero, then set action will be taken.

Min Times Not Equal
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then set action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z, and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

Increment Not Equal
: If updating existing or creating a new Rate, whose new Increment value does not match any from set Rule, then set action will be taken.
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then set action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z, and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

= Tariff Import Rules =

 
[[File:M2TIImage118.png]]
 

The main Tariff Import Rules page shows all the Tariff Import specific rules in the system. Here you can add new rules by clicking the button at the upper-right corner. Also, you can Edit/Delete selected Rules with the relevant buttons. The first column '''ACTIVE?''' allows to activate or deactivate a specific Rule by clicking the YES/NO buttons. If you would like to change the order of the Rules, Drag&Drop functionality is available.

Follow the steps below to create Tariff Import Rules:

By clicking the '''ADD NEW TARIFF IMPORT RULES''' button, you are presented with the following settings screen:

 
[[File:M2TIImage65.png]]
 

* '''Name''' - Name of the Rules
* '''Rate Import Rules''' - Select the Rate Import Rules you would like to use
* '''Target Tariff''' - The Tariff for which the changes will be applied
* '''Import Type''' - you can choose between 2 options: Add/Update and Replace All Rates
** '''Add/Update''' - new rates will be added from file and existing ones will be updated
** '''Replace All Rates''' - existing rates will be deleted and new ones imported from file
* '''Import Template''' - Template to be used
* '''Effective Date''' - Effective Date value to be used with Rates
** '''Template''' - Inline - Use Effective Date from File set by Template setting (see: Template)
** '''Subject''' - Use Effective Date from Email Subject
** '''File Name''' - Use Effective Date from File (Attachment) Name
* '''Manual Review''' - Import automatically or wait for manual confirmation
* '''Reject Import if errors found''' - Tariff Import will be rejected if at least one error will be found * '''after analyzing
* '''Stop processing more Rules''' - Matching with Email Details and Active Tariff Import Rules will be in specific order (from Tariff Import Rules List, from top to bottom). Email assigning will be stopped on this Rule if this option is enabled
* '''Default Effective From''' - Effective From value in Rates, when invalid value supplied from file
* '''Default Connection Fee''' - Set Connection Fee for Rates if it is not present or invalid in Import File
* '''Default Increment''' - Set Increment for Rates if it is not present or invalid in Import File
* '''Default Minimal Time''' - Set Minimal Time for Rates if it is not present or invalid in Import File

To edit the above parameters on Import Rules, which were previously used, you have to delete Processes related to those rules.

== Email/Attachment Validation ==

Email/Attachment Validation section is used for specifying which emails where will be used by Tariff Import Rules. There are five fields. The first four are for email and the fifth is for attachment.

 
[[File:M2TIImage104.png]]
 

* '''Mail From''' - Email Address(es). Multiple emails can be separated by ;.
* '''Sender Name''' - Senders name.
* '''Mail subject''' - Emails subject.
* '''Mail text''' - Emails text.
* '''File Name''' - Attachments file name.

Wildcard % is allowed, which substitutes any character with any length. Example is shown in the image below
 
[[File:M2TIImage110.png]]
 

# Mail From has two values %@gmail.com and john@%.%.
## %@gmail.com specifies it is any Gmail email address.
## john@%.% specifies it is john from any email client.
# Sender Name J% any value That starts with uppercase J
# Mail Subject %Rates Subject ends with word Rates
# Mail Text Hello Mail Text Starts with word Hello
# File Name %.csv filename ends with .csv

== Notifications ==

Email Notifications are used to generate email notifications to an internal or external list of recipients.

 
[[File:M2TIImage106.png]]
 

Follow the steps below to create and configure a notification Template.
# Create Email Template. Manual how to create Email Templates can be found here: [[M2 Emails]]. Additional Email variables: tariff_job_id, tariff_job_analysis_url.
# Select created Email Template from Email Template dropdown. Subject field will fill in automatically. [[File:M2TIImage112.png]]
# Enter Email Address(es) in the Recipients field. Multiple Email Addresses must be separated by ;. [[File:M2TIImage116.png]]
# Repeat the same process for desired Import Triggers. [[File:M2TIImage36.png]]

= Inbox =

The Inbox is a type of email inbox available within the System that allows the Rating.
Administrator to view and manage Provider Tariffs/Rate Notifications that have been sent to the System's Email Address.

Caution:
The Inbox functions in a similar way to the email inbox of your desktop or web-based email client, with emails sent to the platform’s email address being displayed and stored in the inbox. The inbox also includes additional functionality to support Providers Rate Import procedures and processes.
However, it is important to understand that the Rate Inbox is designed to manage received emails and not to be a “full email client”. This means that it is not possible to Reply To or Forward emails that are received into the Rate Inbox.

Inbox Interface:

 
[[File:M2TIImage82.png]]
 

The Inbox consists of 3 views: Inbox, Completed, and Junk.

'''Inbox''' - is the primary working inbox. It is this view that will show emails that have been received that have an associated task that requires carrying out.
That task might be to review and commit an update, assign Tariff Import settings, or a number of other actions.
Emails will remain visible in the Action Required view until the associated rate update is committed, or they are manually completed or deleted.

'''Completed''' - Fully processed emails are shown in the completed tab. Fully processed means that all of the email attachments had been assigned to at least one of Tariff Import Rules and Tariff Job which is completed.

'''Junk''' - Emails that are deleted from Junk will be removed permanently, not displayed in the deleted view.

Tariff Inbox basics

 
[[File:M2TIImage55.png]]
 

# Email column - Sender name, email address and subject
# Email details button - toggles email details
# Attachments list
# Attachments file type list
# Import jobs associated with attachments
# Import jobs button - toggles import jobs(if there are more than one tariff import job)
# Attachment mapping status
# Processing note
# Inbox view tab
# Completed view tab
# Junk view tab
# Select all emails checkbox
# Select single email checkbox
# Delete Selected emails
# Refine Results - shows fields to filter emails

== Email Details ==

Email details are toggled by pressing the arrow button in the Email column. There are four sections: Email Details, Message, Attachments, and function buttons.
* Email Details section shows detailed email information such as ID, Received, From, Sender, Subject, To, Reply to, and CC.
* Message section contains emails message.
* Attachments section shows attachments associated with email.
* the Last Section represents three function buttons.

 
[[File:M2TIImage47.png]]
 

== Filter Emails ==

Email filtering is done by pressing the Refine Results button in the top right corner of the Tariff Inbox.

 
[[File:M2TIImage37.png]]
 

There are four fields:
* Period - the period between emails were received.
* From - email or sender name.
* Subject - email subject.
* Message - email message.

 
[[File:M2TIImage71.png]]
 

Press Refine button to see results.

 
[[File:M2TIImage120.png]]
 

Press clear to clear fields.

 
[[File:M2TIImage107.png]]
 

== Delete Emails ==

To delete emails, select emails by clicking their checkboxes.

 
[[File:M2TIImage38.png]]
 

Then press Delete Selected button on top right side of Tariff Inbox

 
[[File:M2TIImage96.png]]
 

After that, selected emails will be in a Junk view. To delete permanently, repeat the process in Junk view.

To select all emails, click on the top checkbox near the Email column heading.

 
[[File:M2TIImage88.png]]
 

Also, email can be deleted by toggling Email Details and pressing Delete button

 
[[File:M2TIImage72.png]]
 

== Manually assign Tariff Import Settings ==

It is possible to manually Assign Tariff Import Settings.
# Toggle Email Details
# Select Tariff Import Rules for specific attachment
# Press Assign Import settings

 
[[File:M2TIImage57.png]]
 

== Retry Rules mapping ==

If an email with multiple attachments has attachments with no import rules it is possible to retry rules mapping. It's simple, press Retry Rules mapping.

 
[[File:M2TIImage33.png]]
 

Note: It’s not possible to Retry Rules mapping if all email attachments will have at least one import rule assigned to it.

== Attachment mapping status ==

Attachment mapping status(Status column in Emails list) indicates if Tariff Import Rules mapping was successful or not.

 
[[File:M2TIImage90.png]]
 

'''Import Rules Found''' - attachment was mapped successfully with at least one of the Tariff Import Rules.
'''Import Rules Not Found''' - attachment was not mapped to any of the Tariff Import Rules or there were no Tariff Import Rules to map.
'''Invalid Effective Date/Format for Tariff Import Rules''' - Invalid attachment date or it’s format compared to Tariff Import Rules settings. Numbers after status text represent Tariff Import Rules IDs.

== Email Example ==

Email can have one or multiple attachments. Every attachment will be processed individually. Attachment can have one or multiple Import Jobs which are dependent on the number of mapped Tariff Import Rules.

 
[[File:M2TIImage61.png]]
 

If there are multiple Tariff Jobs they will be shown as a toggle list. To toggle the list, simply press the arrow button next to Jobs list caption.

 
[[File:M2TIImage87.png]]
 

To see Job details click on any Import Job. The page will be redirected to the Tariff Jobs list.

 
[[File:M2TIImage62.png]]
 

= Examples =

== Rate upload from TATA ==

1. Analyze the tariff:
 
[[File:M2TIImage105.png]]
 

2. Create template for a tariff in BILLING → Tariff import → Import Rules → Templates
 
[[File:M2TIImage81.png]]
 

3. Select appropriate fields according to the tariff cells:
 
[[File:M2TIImage22.png]]
 

4. Create Rate Import Rules in BILLING → Tariff import → Import Rules → Rate Import Rules
 
[[File:M2TIImage54.png]]
 

5. Fill cells according your needs:
 
[[File:M2TIImage80.png]]
 

6. Create Tariff Import Rules in BILLING → Tariff import → Import Rules
 
[[File:M2TIImage14.png]]
 

7. Fill required cells:
 
[[File:M2TIImage111.png]]
 

8. Check the Inbox for a new email at Billing → Tariff Import → Inbox

9. Enter the mail, select Tariff Import Rules and press Assign Import Settings to continue the import:
 
[[File:M2TIImage18.png]]
 

10. Tariff job is created now, you can see it in BILLING → Tariff Import → Jobs
 
[[File:M2TIImage102.png]]
 

11. Job is now waiting for confirmation. You can view analysis before confirming:
 
[[File:M2TIImage45.png]]
 

12. Point to the line you want to analyze to see more information:
 
[[File:M2TIImage35.png]]
 

13. If you are satisfied, press confirm to finish the import procedure, otherwise cancel it.
 
[[File:M2TIImage1.png]]
 

14. If you pressed confirm, you will see that job was successfully confirmed:
 
[[File:M2TIImage77.png]]
 

15. Go back to Jobs page in BILLING → Tariff Import → Jobs to see the status of the Job:
 
[[File:M2TIImage79.png]]
 

16. Tariff import is finished. As a targeted tariff in this example was “SUPPLIER PREMIUM”, you can verify rates checking page BILLING → Tariffs.
 
[[File:M2TIImage12.png]]
 

== Speedflow Tariff Import configuration ==

 
[[File:M2TIImage117.png]]
 

1. Create an import template.
Go to BILLING > Tariff Import > Import Rules > Templates.
Click "ADD NEW TEMPLATE" at the top-right corner of the page.

Set "Name" to "speedflow". It can be any name, but "speedflow" will represent for which Provider tariffs this template is used.
Set "Rate Sheet" to "1", as this tariff files contains only one worksheet.
Set "Header Rows" to "22", as this tariff has 4 rows before actual rates data begins.
Set "Refix/Code" to column "A";
Set "Destination/Zone" to column "B";
Set "Effective Date" to column "E";
Set "Effective Date Format" to "%d.%m.%y";
Set "Rate" to column "C";
Set "Minimal Time" to column "E" and value "1";
Set "Increment" to column "E" and value "2";

 
[[File:M2TIImage76.png]]
 

Click "Create" to save changes.

2. Create Rate Import Rules
Go to BILLING > Tariff Import > Import Rules > Rate Import Rules
Click "ADD NEW RATE IMPORT RULES" at the top-right corner of the page.

This example shows how to create Rate Import Rule which will inform the admin about new rates above 1.0 in price and will reject rates where the price is equal to 0.

Set "Name" to "speedflow";
Set "Max Rate" to value "1.0" and action "Alert";
Set "Zero Rate" to action "Reject Rate".

 
[[File:M2TIImage23.png]]
 

Click "Create" to save changes.

3. Create Tariff Import Rules
Go to BILLING > Tariff Import > Import Rules
Click "ADD NEW TARIFF IMPORT RULES" at the top-right corner of the page.

Set fields like this:
"Name":"speedflow";
"Rate Import Rules":"speedflow";
"Target Tariff":"speedflow (EUR)". This is tariff assigned to speedflow Termination Point;
"Import Type":"Add/Update";
"Import Template":"speedflow";
"Effective Date":"Template - Inline"
"Mail From":"rates@speedflow.com". This is not actual email from which speedflow sends rates. Set correct email address from which you get tariffs.
"File Name":"%.xls"

 
[[File:M2TIImage58.png]]
 

Click "Create" to save changes

At this point, the system is ready to receive email from speedflow.

5. Once email from speedflow is received you will see a new Tariff Job waiting for confirmation in Billing > Tariff Import > Jobs.

 
[[File:M2TIImage108.png]]
 

Click "ANALYSIS" to see rates to be imported. By default, the ANALYSIS page does not show new rates. Click "REFINE RESULTS", uncheck "Show Only Rejected" and click REFINE to see all received rates.

Click "CONFIRM" at the top-right corner of the page to proceed with the import of rates.

 
[[File:M2TIImage89.png]]
 

In BILLING > Tariffs List, Tariff Import is completed and new Rates are now visible.

 
[[File:M2TIImage121.png]]
 

== Step by step example for VoiceTrading Tariff ==

1. Review VoiceTrading XLSX tariff structure

 
[[File:M2TIImage95.png]]
 

 
[[File:M2TIImage83.png]]
 

We can see that the XLSX document consists of two Worksheets: Worksheet 1 (Rates) and Worksheet 2 (Numberplan).
2. Go to BILLING > Tariff Import > Import Rules > Templates to create a new Template

 
[[File:M2TIImage85.png]]
 

3. Configure Template for VoiceTrading XLSX structure

 
[[File:M2TIImage92.png]]
 

As you can see, there are two tabs on this page: Primary Data and Secondary Data. Do not confuse them with Worksheets, they are not related. Some Providers do not want to exceed a certain limit of rows in the XLSX file, so data is placed in two regions on the same row(s). Let’s review the screenshot below:

 
[[File:M2TIImage66.png]]
 

Green square corresponds to '''Primary Data''', while Blue square corresponds to '''Secondary Data'''. They both contain the same information: Destination name, Prefix, and Rate.

Lets go step by step and configure a Template for '''Primary Data''':

 
[[File:M2TIImage4.png]]
 

'''Rate Sheet - 2'''. VoiceTrading XLSX file has two sheets, so set to 2
'''Header Rows - 0'''. VoiceTrading XLSX file has no header rows (data starts at 1st row)

 
[[File:M2TIImage3.png]]
 

'''Prefix/Code - B'''. Prefix is in Cell B for Primary Data.
'''Destination/Zone - A'''. Destination is in Cell A for Primary Data.
'''Connection Fee - Empty'''. There is no Connection Fee cell in VoiceTrading XLSX.

 
[[File:M2TIImage115.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage48.png]]
 

 
[[File:M2TIImage8.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage86.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates), and also A on Worksheet 2 (Numberplan). So we select '''A''' on 3rd and 4th Dropdown accordingly.

 
[[File:M2TIImage39.png]]
 

Effective Date Format for VoiceTrading is in YYY.MM.DD, so we select accordingly.

 
[[File:M2TIImage125.png]]
 

'''Rate - C'''. Prefix is in Cell C for Primary Data.
There are no '''Minimal Time''' and '''Increment''' cells in VoiceTrading XLSX.

Let’s configure '''Secondary Data''' now:

 
[[File:M2TIImage24.png]]
 

'''Rate Sheet''', '''Header Rows''' and '''Effective date''' will be the same as on Primary data.

 
[[File:M2TIImage25.png]]
 

'''Prefix/Code - F'''. Prefix is in Cell F for Secondary Data.
'''Destination/Zone - E'''. Destination is in Cell E for Secondary Data.
'''Connection Fee - Empty'''. There is no Connection Fee Cell in VoiceTrading XLSX.

 
[[File:M2TIImage30.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage53.png]]
 

 
[[File:M2TIImage119.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage98.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates) and E on Worksheet 2 (Numberplan). So we select '''A''' on 3rd dropdown and '''E''' on 4th dropdown accordingly.

 
[[File:M2TIImage109.png]]
 

Once the configuration is complete, press the CREATE button to create a new Template.

4. Go to BILLING > Tariff Import > Import Rules > Rate Import Rules to create Rate Import Rules

 
[[File:M2TIImage91.png]]
 

5. Configure Rate Import Rules according to your specifications

 
[[File:M2TIImage2.png]]
 

In this example we changed these values:
'''Max Increase''': 50%. If the rate increase is higher than 50%, such a rate will be automatically rejected.
'''Max Decrease''': 50%. If the rate increase is higher than 50%, such a rate will be automatically rejected.
'''Max Rate''': 1.99. If the rate is higher than 1.99, such a rate will be automatically rejected.

6. Go to BILLING > Tariff Import > Import Rules to create Tariff Import Rules

 
[[File:M2TIImage84.png]]
 

7. Configure Tariff Import Rules according to your specifications

 
[[File:M2TIImage99.png]]
 

The minimum what you should change from default:
'''Rate Import Rules''': set to Import Rules created in step 5.
'''Target Tariff''': set to Tariff you want to import rates to.
'''Import Template''': set to Template created and configured in step 3.
'''Email/Attachment Validation''': set to valid date for your Provider. Data in the screenshot is only an example and does not represent real values for VoiceTrading Provider.

8. Once email(s) will be received, you will see them in BILLING > Tariff Import > Inbox
If Tariff Import Rules have been correctly entered in the previous step, Import Job will be created automatically.

 
[[File:M2TIImage13.png]]
 

9. Click on the Import Job link. This will redirect you to the Tariff Jobs page.

 
[[File:M2TIImage123.png]]
 

Here we can see that Tariff Job is waiting for confirmation and that there are 1178 rates to be updated and 0 rejected rates.

10. Click on ANALYSIS link to view detailed analysis

 
[[File:M2TIImage74.png]]
 

By default, the Tariff Job Analysis page shows only rejected Rates. There are no rejected rates, in this case, so we can press the CONFIRM button.

11. Go to BILLING > Tariff Import > Jobs to check Tariff Jobs status again. We can see that status is '''Imported'''.

12. The process is completed. Let’s go to Billing > Tariffs to confirm this

 
[[File:M2TIImage75.png]]
 

We can see that 1178 rates have been imported to Tariff '''Supplier VoiceTrading'''.

 
= See also =
* [[Automatic Tariff Import - Email is not taken from the mailbox]]

File:M2 Aggregate template create.png

2020-10-06T17:08:18Z

Ervinas: uploaded a new version of "File:M2 Aggregate template create.png"

File:Aggregatesm2.png

2020-10-06T17:08:00Z

Ervinas: uploaded a new version of "File:Aggregatesm2.png"

M4 Routing Groups

2020-10-06T16:52:16Z

Ervinas:

Routing Group is logical routing entity (group of [[M2 Dial Peers | Dial Peers]]) which is assigned to [[M2 Origination Points | Origination Point]] and determines the route of the call from this [[M2 Origination Points | Origination Point]].
Routing group is able to have up to two Failover Routing Groups.

= Usage =
Go to '''Routing -> Routing Groups'''
 
[[File:M2 Routing groups menu.png]]
 
You can Refine the search results by providing a Routing Group Name.
 
[[File:M2 Routing groups.png]]
 

= Failover Routing Group =

Routing group is able to have up to two Failover Routing Groups. 
Assume there are three Routing Groups: Group1, Group2 and Group3. Group1 has Group2 as Failover Group, Group2 has Group3 as Failover Group. When Routing Group - Group4 is created, it cannot have a Failover Group Group1 and neither can it be a Failover Group for Group3, because it exceeds maximum sequence length (3).

= Assigning Dial Peers =
Routing > Routing Groups > press on button in Dial Peers column
 
[[File:M2_assigned_dial_peers.png]]
 
Dial Peers can be assigned to Routing Groups, by pressing ASSIGN DIAL PEER button (1) then selecting Dial Peer from Dial Peers drop down list (2), setting Priority (3) and pressin ASSIGN button (7) 
Active in routing group column (4) shows if Dial Peer is active. Active column (5) shows if Dial Peer is active. It can be edited in Dial Peers edit page. 
Pressing on Dial Peers name (6) redirects to Dial Peers edit page. 
Pressing on Priority (7) allows to update Priority. In order to save it just pres somewhere else in the page. 
Pressing on REMOVE button (9) removes Dial Peer.
 
You can Refine the search results by providing a Dial Peer Name.
 
[[File:M2_RG_dial_peers.png]]
 

= Dial Peers Management =
Routing > Routing Groups > press on "Management" button in Dial Peers column
 
[[File:m2_routing_group_dial_peers_management.png]]

File:M2 routing group dial peers management.png

2020-10-06T16:49:32Z

Ervinas:

MOR API subscription create bulk

2020-09-22T14:00:20Z

Ervinas: /* Returns */

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

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

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

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

'''NOTE''' Several subscriptions at once can be assigned choosing their IDs in the service_id parameter.

For example, if it is needed to assign subscriptions 1, 1, 1, 2, 3, parameter will look this way: service_id=1,1,1,2,3

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 (admin, reseller, accountant). '''Required'''.
* subscription_activation_start - Unix timestamp of Subscription activation start.
* subscription_activation_end - Unix timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* 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''' and '''Dynamic Flat-Rate'''.
* ignore_balance - for Prepaid user subscription will be applied even if Prepaid User does not have sufficient balance (0 - off, 1 - on, default - off).
* subscription_discount_percent - Subscription Discount Percent. Possible values are from 0 to 100.

 
'''NOTE'''. When Flat-Rate Service is subscribed Subscription will be created for full month.
 

===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_bulk?u=admin&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>Subscriptions were successfully created</success>
<ids>231</ids>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant 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>One or more Service was not found</error> - Service with specified service_id was not found.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription update]]

MOR API subscription create bulk

2020-09-22T13:55:11Z

Ervinas: /* Usage */

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

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

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

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

'''NOTE''' Several subscriptions at once can be assigned choosing their IDs in the service_id parameter.

For example, if it is needed to assign subscriptions 1, 1, 1, 2, 3, parameter will look this way: service_id=1,1,1,2,3

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 (admin, reseller, accountant). '''Required'''.
* subscription_activation_start - Unix timestamp of Subscription activation start.
* subscription_activation_end - Unix timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* 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''' and '''Dynamic Flat-Rate'''.
* ignore_balance - for Prepaid user subscription will be applied even if Prepaid User does not have sufficient balance (0 - off, 1 - on, default - off).
* subscription_discount_percent - Subscription Discount Percent. Possible values are from 0 to 100.

 
'''NOTE'''. When Flat-Rate Service is subscribed Subscription will be created for full month.
 

===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_bulk?u=admin&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>
<id>231</id>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant 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>Service was not found</error> - Service with specified service_id was not found.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription update]]

M4 Rate Notifications

2020-07-30T12:14:03Z

Ervinas: /* Rate Notification Jobs */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. 
All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications. 
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T12:13:42Z

Ervinas: /* Creating Rate Notification */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. 
All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications. 
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T12:13:29Z

Ervinas: /* Creating Rate Notification */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. 
All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T12:13:16Z

Ervinas: /* Rate Notifications */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent. 
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T12:12:38Z

Ervinas: /* Rate Notification Jobs */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states: 
'''Assigned''' 
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated''' 
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email. 
 
[[File:RateNotification7.png]]
 

'''Email Sent''' 
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout. 
 
[[File:RateNotification8.png]]
 

'''Completed''' 
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status. 
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T09:55:12Z

Ervinas: /* Type: Delta Only, Rate Notification Disagreed */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states:
'''Assigned'''
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated'''
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email.
 
[[File:RateNotification7.png]]
 

'''Email Sent'''
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout.
 
[[File:RateNotification8.png]]
 

'''Completed'''
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status.
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner, 
Please review attached Tariff‘s Rate changes. 
To confirm upcoming rate changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd 
If You do not agree with the changes, please click the link below: 
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8 
Thank you for cooperation. 
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T09:54:33Z

Ervinas: /* Type: Delta-only, Rate Notification Disagreed */

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states:
'''Assigned'''
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated'''
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email.
 
[[File:RateNotification7.png]]
 

'''Email Sent'''
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout.
 
[[File:RateNotification8.png]]
 

'''Completed'''
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status.
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta Only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner,
Please review attached Tariff‘s Rate changes.
To confirm upcoming rate changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd
If You do not agree with the changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8
Thank you for cooperation.
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

M4 Rate Notifications

2020-07-30T09:53:23Z

Ervinas:

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states:
'''Assigned'''
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated'''
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email.
 
[[File:RateNotification7.png]]
 

'''Email Sent'''
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout.
 
[[File:RateNotification8.png]]
 

'''Completed'''
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status.
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed ==

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta-only, Rate Notification Disagreed ==

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner,
Please review attached Tariff‘s Rate changes.
To confirm upcoming rate changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd
If You do not agree with the changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8
Thank you for cooperation.
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

File:RateNotification25.png

2020-07-30T09:52:57Z

Ervinas:

File:RateNotification24.png

2020-07-30T09:52:53Z

Ervinas:

File:RateNotification23.png

2020-07-30T09:52:48Z

Ervinas:

File:RateNotification22.png

2020-07-30T09:52:42Z

Ervinas:

File:RateNotification21.png

2020-07-30T09:52:35Z

Ervinas:

File:RateNotification20.png

2020-07-30T09:52:27Z

Ervinas:

File:RateNotification19.png

2020-07-30T09:52:22Z

Ervinas:

File:RateNotification18.png

2020-07-30T09:52:16Z

Ervinas:

File:RateNotification17.png

2020-07-30T09:52:10Z

Ervinas:

File:RateNotification16.png

2020-07-30T09:52:06Z

Ervinas:

File:RateNotification15.png

2020-07-30T09:52:02Z

Ervinas:

File:RateNotification14.png

2020-07-30T09:51:56Z

Ervinas:

File:RateNotification13.png

2020-07-30T09:51:51Z

Ervinas:

File:RateNotification12.png

2020-07-30T09:51:46Z

Ervinas:

File:RateNotification11.png

2020-07-30T09:51:41Z

Ervinas:

File:RateNotification10.png

2020-07-30T09:51:36Z

Ervinas:

File:RateNotification9.png

2020-07-30T09:51:32Z

Ervinas:

File:RateNotification8.png

2020-07-30T09:51:27Z

Ervinas:

File:RateNotification6.png

2020-07-30T09:51:21Z

Ervinas:

File:RateNotification7.png

2020-07-30T09:51:16Z

Ervinas:

File:RateNotification5.png

2020-07-30T09:51:06Z

Ervinas:

File:RateNotification4.png

2020-07-30T09:50:59Z

Ervinas:

File:RateNotification3.png

2020-07-30T09:50:53Z

Ervinas:

File:RateNotification2.png

2020-07-30T09:50:47Z

Ervinas:

File:RateNotification1.png

2020-07-30T09:50:39Z

Ervinas:

M4 Rate Notifications

2020-07-30T09:50:10Z

Ervinas: Created page with '= Introduction = Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functiona…'

= Introduction =

Whenever there are Rate updates or changes in Tariff some sort of communication must be made with Users that are using those Rates. Rate Notifications functionality eases manual tasks by allowing to quickly and automatically create Jobs that informs Users about upcoming (depending on effective from value in the future) Rate prices and also awaits their confirmation whether they agree or disagree with them.

= Workflow schema =

The workflow can be visualized using the following schema:
 
[[File:RateNotification1.png]]
 

= Rate Notifications =

Rate Notifications is the primary page of the functionality, it displays unique Tariff - User associations to whom Notification can be sent.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications
 
[[File:RateNotification2.png]]
 

Associated Tariff - User objects are shown only when following conditions are met:
* Tariff is Sell type;
* User's Connection Point is assigned Sell Tariff in Origination Point settings;
* Tariff was modified and does not have any Rate Notification Job created for specific Tariff - User;
* Tariff was modified and specific Tariff - User Rate Notification was created prior to Tariff modifications.

= Creating Rate Notification =

In order to create new Rate Notification Jobs, check wanted Tariff - User associations and press Set. All required Notifications can be selected by clicking header checkbox.
 
[[File:RateNotification3.png]]
 
After selection, another page will be loaded with options for this specific Notifications.
"Selected Tariffs - Users" displays marked associations to whom Notifications will be sent.
"Options" has several settings:
* Email Template: which Template will be used for email. Default "tariff_rate_notification" template is already present in the system and can be modified to fit specific needs. Also new templates can be created, but these templates must have "agree" and "disagree" tags in order to be shown in this dropdown.
* Rate Notification Type:
** Delta Only: future Rates only.
** Full: all future and currently active Rates.
* Agreement Timeout in days: timeout after which Notification will be automatically marked as disagreed (ignored) if the User did not respond. Timeout adds specified days value to Notification created time.
 
[[File:RateNotification4.png]]
 
After pressing the Create button, Jobs will be created and the Rate Notification Jobs page will be loaded.
 
[[File:RateNotification5.png]]
 

= Rate Notification Jobs =

Rate Notification Jobs is the page where the system will automatically gather required Rates data, send emails and awaits for Users' response.
This page can be found in Menu -> BILLING -> Tariffs -> Rate Notifications -> Jobs

Jobs have the following states:
'''Assigned'''
After Rate Notification is created a new Job appears as assigned.
 
[[File:RateNotification6.png]]
 

'''Date Generated'''
System checks for all newly assigned Jobs and generates required data in XLSX format, which can be downloaded from the list. The same exact file will be attached to the email.
 
[[File:RateNotification7.png]]
 

'''Email Sent'''
All Jobs that have successfully generated data will send emails to Users with unique agree and disagree links which can be clicked on only once and within specified timeout.
 
[[File:RateNotification8.png]]
 

'''Completed'''
Depending on User actions, Job can be either agreed, disagreed or ignored. List will display specific responses and time it was responded on. Also additional email will be sent to Admin informing Rate Notification Job response status.
 
[[File:RateNotification9.png]]
 

= Examples =

== Type: Full, Rate Notification Agreed

User have tariff with some rates:
 
[[File:RateNotification10.png]]
 
Admin uploads new rates with some changes on prices and Effective from date in future:
 
[[File:RateNotification11.png]]
 
In Billing > Tariffs > Rate Notifications, Admin now can see new entry. Admin selects new entry and clicks “SET”:
 
[[File:RateNotification12.png]]
 
Then Admin selects “Full” to display old rates and new rates and click “Create”:
 
[[File:RateNotification13.png]]
 
New Rate Notification is created:
 
[[File:RateNotification14.png]]
 
User gets email with two links:
 
[[File:RateNotification15.png]]
 
and file with rates comparison:
 
[[File:RateNotification16.png]]
 
After checking new rates, User clicks on first link in email to agree with new rates:
 
[[File:RateNotification17.png]]
 
Now, Admin gets email about new rates being confirmed:
 
[[File:RateNotification18.png]]
 
And also sees update status in Rate Notifications Jobs list:
 
[[File:RateNotification19.png]]
 

== Type: Delta-only, Rate Notification Disagreed

User has tariff with some rates
 
[[File:RateNotification20.png]]
 
In Billing > Tariffs > Rate Notifications, Admin can see a rate notification list of his users. Admin selects needed user and clicks “SET”:
 
[[File:RateNotification21.png]]
 
Then Admin selects “Delta” to display only new rates and press “Create”:
 
[[File:RateNotification22.png]]
 
Tariff Rate Notification Job(s) successfully created.
 
[[File:RateNotification23.png]]
 
Then Admin uploads new rates with some changes on prices and Effective from date in future.

After this, user gets email with two links with rates to comparison:

Dear Partner,
Please review attached Tariff‘s Rate changes.
To confirm upcoming rate changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/agree?id=1128bccbac519a04a4866c785f84f873eec6d5fd
If You do not agree with the changes, please click the link below:
http://123.123.123.123/billing/tariff_rate_notification_jobs/disagree?id=bcc02d82cf9d919af38bb4e4677685eeb0b382a8
Thank you for cooperation.
 
[[File:RateNotification24.png]]
 
For example, User disagrees and presses the second link. He can see notification that Tariff Rate changes successfully disagreed.

After that Admin will receive an email that the client disagreed and will see the same status in Tariff Job.

Tariff Rate Notification ID: 2 was disagreed by the client.
 
[[File:RateNotification25.png]]

DID Management

2020-06-02T15:32:06Z

Ervinas: /* Allowing Users to route their DIDs */

= Description =

DID is an external number to have incoming calls to your VoIP network reach a particular device. (This is a very simplified explanation that will serve for the moment. For a more extensive explanation, please check [http://www.voip-info.org/wiki/view/DID here]).

'''VERY IMPORTANT RULE: DIDs in MOR MUST be in E.164 format.'''

You can reach window, with list of all DIDs, in '''SETTINGS –> Billing –> DIDs''':
 
[[File:Dids updated.png]]
 
User/Dial Plan and Device show who will answer when dialing this DID.

Clicking on User or Device brings you to their settings. If you click on the [[Image:callflow.png]] icon, you will go to the device's [[Call Flow]] window.

In this page you can
*[[DID_Management#Add_new_DID(s) | Add new DID(s)]]
*Reach [[DID_Management#DID_bulk_management | Bulk management]]
*Export DIDs to CSV
*Reach page to change DID [[DID Billing | Rates]]
*Update DID [[DID_Management#Settings | settings]]
*Search only by DID Owner, when using search field called ''Owner'', or search by either DID Owner or DID Reseller at once, when using search field called ''User''.

*Hide Terminated DIDs. When option "Hide Terminated DIDs" is checked, terminated dids will be hidden until option is unchecked. Clear search button or relogin will not clear the checked option.
* Search by User type.
* Search by inclusive Balance range (only for Owners).
* Search by User status (only for Owners).

 

= Status =
[[Image:dids2.png|right]]
Status is very important. For every just-created DID, the status is Free.

A DID can have several statuses:

* '''Free''' – this status means that the DID is free to be reserved for any user/device. You can also Terminate it.
* '''Reserved''' – the DID is reserved but NOT actually used for a user. "Reserved" is useful at the negotiation stage before signing a contract. When a user decides to sign up, we Activate the DID. We can also make the DID Free.
* '''Active''' – the DID is assigned to a Device and is functional. We can Close it.
* '''Closed''' – the DID is no longer functional, so that all calls going to this DID will get Hangup. One important feature of this state: when a DID is Closed, it will be closed for a set time (the default is 90 days) in case the user changes his mind and decides to use this DID again. This is useful when a user is not paying for services, as we can suspend the DID by using Closed. MOR will make it Free after the Closed period runs out. You can manually make it Free or Terminate this DID.
* '''Terminated''' – the DID is no longer used in MOR. It remains only for historical purposes. You can make it Free if you want.

 

= Add new DID(s) =

In the main DIDs window, if you want to add new DID(s), click on [[Image:add.png]] '''New DID''':

[[Image:dids5.png]]

In this window you can:

# Select DID(s) [[DID_Management#Details | details]]
# Add one DID or series of DIDs
# [[ DID_Import_from_CSV | Import DID(s) from CSV file]]
 
'''NOTE:''' You should select the Provider which sold you this DID. DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

 
== VIDEO: How to create a DID ==

<html>
<iframe width="640" height="360" src="http://www.youtube.com/embed/SVJS_stEgBQ" frameborder="0"></iframe>
</html>

 

==Details==

*'''Provider''' – DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

*'''Language''' – option to set language for voice prompts in the Asterisk Dial Plan

*'''Call limit''' – describes how many simultaneous calls DID can '''receive'''. 0 (zero) means that calls are unlimited.

*'''Max Call Duration (Timeout)''' – a number of seconds before a Call via DID is terminated ('''NOTE:''' due to a global safeguard Calls are terminated ~3 sec. earlier than this setting).

*'''Comment''' – option to save some notes about DID.

*'''[[Sound files | Sound file]]''' – here you can add [[IVR Greeting for DID]]. There are two options:
# Answer and play.
# Early media.
*'''PIN''' – a numeric PIN code to secure a DID.

*'''PIN retries''' – a number of allowed attempts to enter a PIN code.

*'''[[Sound files | Sound file]] to reenter PIN''' – a Sound File that is played before the next attempt to enter a PIN Code.

*'''MOH instead of Ringing''' – if [[Music on Hold|MOH]] is selected, Music on Hold will be played instead of ringing when DID number is dialled.

*'''[[IVR_system | IVR]] if PIN fails''' – an IVR the Call is transferred to when all attempts to enter a PIN Code fail. '''NOTE:''' when all PIN attempts fail and '''IVR if PIN fails''' is None, a Call is terminated with a [[Hangupcause_Codes|Hangupcause Code]] '''275'''.


*'''Grace Time''' – if call duration is less than Grace Time, it will not be accounted, for example: '''Grace Time''' = 3s, call duration <= 3s, then price for the call = 0


*'''Timeout Digit''' – the maximum amount of time permitted between digits when the user is typing in a number. When this timeout expires after the user has started to type in a number, the number will be considered complete, and will be interpreted (sent to the system). Works both with entering destination and ANI/PIN.


*'''Timeout Response''' – the maximum amount of time permitted for user to START entering a number. If the user does not begin typing a number in this amount of time, system will notify that nothing was entered. Once the user begins to type a number, system will wait for Digit Timeout to be reached, and Response Timeout has no effect no more.


*'''CallerID Name Prefix''' – option to add a CallerID Name prefix to the incoming CallerID.


*'''Tone zone''' – option to set tone zones. Tone zone is a different ring tone depending on destination (country).


*'''Tariff for Calling Card''' – option to set a tariff for DID which will be applied for a calling card. It will not be important what tariff is assigned for that card's group.


*'''Active from''' – DID will become active from this date. If DID is not active yet, call is routed like there is no matching DID number.

*'''Active till''' – DID will be active till this date. Expiration does not change DID status, call is routed like there is no matching DID number.

* '''Blacklist Source Number Pool''' - this will set [[Number Pool]] for Blacklist Source. When calling this DID, if Source Number match number in this pool, call will be rejected with '''HGC 283 - Source number is in DID blacklist'''.

* '''Send call anonymously''' - default no. Ability to show Anonymous on incoming call.

* '''Send CallerID in UUI header''' - default no. The ability to show the caller ID on all calls in Sip UUI messaging.
Header example:
User-to-User: hexCallerid;pd=XX;encoding=hex;purpose=isdn-uui;content=isdn-uui

 

= Settings =

If you want to edit a DID's settings, click on the [[Image:edit.png]] icon.
 
[[Image:dids4.png]]
 
The above window is for Free DID. You can:

# Change [[DID_Management#Details | details]]
# [[DID_Management#Reserve_DID_for_User | Reserve DID for User]].
# [[DID_Management#Assign_to_Dial_Plan | Assign to Dial Plan]].
# Terminate a DID.

 

==Reserve DID for User==

When a DID is assigned to a Device (Reserve for User first), you have a few different choices:

[[File:DidAssign5.png]]

Here you can:

# Change [[DID_Management#Details | details]].
# Assign DID to device. Here you can select different Devices for the same user. For select Trunk Device is next section.
# Assign DID to Trunk. Here you can select different Trunk Devices for the same user.
# Stop a DID subscription and reserve the DID for 90 days (by default) to this user in case he changes his mind and wants to get the DID back.

 

==Assign to Dial Plan==

When DID is assigned to [[Dial_Plans | Dial Plan]], in DID settings you can:
# Change [[DID_Management#Details | details]].
# Make DID free.

When you have [[Quickforwards_rules | Quickforward Rule]] for this DID, in DID edit you will see additional notice:

[[Image:DID_edit_collisions_with_qf_rule.png‎]]

 
= Delete DID =

At first, mark it as "not used" (Free). Then terminate it. When you do, you will see [[Image:delete.png]] next to the DID in the main DID window. By clicking on it, you can delete the DID.

 
= DID bulk management =
In the main DIDs window, click [[Image:edit.png]] Bulk Management and you will be able to perform various actions either on:
*'''DIDs interval''' - this will apply action on selected DID interval,
*'''DIDs pattern''' - this will apply action on selected pattern. Supported wildcard symbols in pattern:
** '''%''' matches any symbols, for example '''370%''' will match any number starting with '''370'''
** '''_''' matches one symbol, for example '''370_1334455''' will match numbers in format '''370x1334455''', where '''x''' is any number.
 
[[Image:dids6.png]]
 
Here you can choose which DIDs to update and what to do:
*'''Update''' - option to change some of DID details, Reserve DID for User (only free DIDs can be reserved) or Make DID free.
*'''Delete''' - option to delete DIDs by Provider or make DIDs Free/Terminated/Closed.
*'''Manage rates''' - option to change Rates for [[DID Billing]].
*'''[[Assign DID to Trunk]]'''.

*'''Reserve for User''' - option to reserve DID for User (only free DIDs can be reserved).
*'''Assign Dial Plan''' - option for Assign DID to [[Dial_Plans | Dial Plan]]
 

= Allowing Users to route their DIDs =
Since '''MOR X5''' users are able to route their DID to a Device or an External Server .
This functionality can be enabled in '''SETTINGS -> Setup -> Visual''' by checking the 'Allow User to assign DID to Device:' setting.

Once the functionality is enabled, the user will be able to see an Edit icon, in his DIDs list.
 
[[File:Dids_list_with_did_routing.png‎]]
 

By pressing the icon, the user will be redirected to a page where he will be able to route his DID either to one of his MOR Devices, or to a Device on an external server (eg. SIP/370xxxxxx@123.123.123.123).
 
[[File:Did_routing_panel.png‎]]
 

'''NOTE:''' Reseller's DID list permissions are independent from Resellers' User, this means that Resellers' User can view DID list (if permissions are enabled for them) even when Resellers cannot.

=See Also=

*[[DID Billing]]
*[[DIDs Usage]]
*[[MOR_API_did_create | Create DID through API]]
*[[MOR_API_did_device_assign | Assign Device to DID through API]]
*[[MOR_API_did_device_unassign | Unassign Device from DID through API]]
*[[Providers#Provider_Grace_Time|Provider Grace Time]]
*[[Grace_time|Device Grace Time]]
*[[Example - Configuring DID to ring some Device]]
*[[DID is not working]]
*[[ DID_Import_from_CSV | Import DID(s) from CSV file]]
*[[Number Pool]]

DID Management

2020-06-02T15:31:31Z

Ervinas: /* Allowing Users to route their DIDs */

= Description =

DID is an external number to have incoming calls to your VoIP network reach a particular device. (This is a very simplified explanation that will serve for the moment. For a more extensive explanation, please check [http://www.voip-info.org/wiki/view/DID here]).

'''VERY IMPORTANT RULE: DIDs in MOR MUST be in E.164 format.'''

You can reach window, with list of all DIDs, in '''SETTINGS –> Billing –> DIDs''':
 
[[File:Dids updated.png]]
 
User/Dial Plan and Device show who will answer when dialing this DID.

Clicking on User or Device brings you to their settings. If you click on the [[Image:callflow.png]] icon, you will go to the device's [[Call Flow]] window.

In this page you can
*[[DID_Management#Add_new_DID(s) | Add new DID(s)]]
*Reach [[DID_Management#DID_bulk_management | Bulk management]]
*Export DIDs to CSV
*Reach page to change DID [[DID Billing | Rates]]
*Update DID [[DID_Management#Settings | settings]]
*Search only by DID Owner, when using search field called ''Owner'', or search by either DID Owner or DID Reseller at once, when using search field called ''User''.

*Hide Terminated DIDs. When option "Hide Terminated DIDs" is checked, terminated dids will be hidden until option is unchecked. Clear search button or relogin will not clear the checked option.
* Search by User type.
* Search by inclusive Balance range (only for Owners).
* Search by User status (only for Owners).

 

= Status =
[[Image:dids2.png|right]]
Status is very important. For every just-created DID, the status is Free.

A DID can have several statuses:

* '''Free''' – this status means that the DID is free to be reserved for any user/device. You can also Terminate it.
* '''Reserved''' – the DID is reserved but NOT actually used for a user. "Reserved" is useful at the negotiation stage before signing a contract. When a user decides to sign up, we Activate the DID. We can also make the DID Free.
* '''Active''' – the DID is assigned to a Device and is functional. We can Close it.
* '''Closed''' – the DID is no longer functional, so that all calls going to this DID will get Hangup. One important feature of this state: when a DID is Closed, it will be closed for a set time (the default is 90 days) in case the user changes his mind and decides to use this DID again. This is useful when a user is not paying for services, as we can suspend the DID by using Closed. MOR will make it Free after the Closed period runs out. You can manually make it Free or Terminate this DID.
* '''Terminated''' – the DID is no longer used in MOR. It remains only for historical purposes. You can make it Free if you want.

 

= Add new DID(s) =

In the main DIDs window, if you want to add new DID(s), click on [[Image:add.png]] '''New DID''':

[[Image:dids5.png]]

In this window you can:

# Select DID(s) [[DID_Management#Details | details]]
# Add one DID or series of DIDs
# [[ DID_Import_from_CSV | Import DID(s) from CSV file]]
 
'''NOTE:''' You should select the Provider which sold you this DID. DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

 
== VIDEO: How to create a DID ==

<html>
<iframe width="640" height="360" src="http://www.youtube.com/embed/SVJS_stEgBQ" frameborder="0"></iframe>
</html>

 

==Details==

*'''Provider''' – DID Provider is ONLY for informational purposes. If you do not know which Provider to assign - create dummy Provider to represent company from which you buy DID. If this is fake DID - assign any Provider you want. If your DID Provider has several IP addresses (as DIDWW) and you configured several Providers in MOR - assign ANY configured Provider.

*'''Language''' – option to set language for voice prompts in the Asterisk Dial Plan

*'''Call limit''' – describes how many simultaneous calls DID can '''receive'''. 0 (zero) means that calls are unlimited.

*'''Max Call Duration (Timeout)''' – a number of seconds before a Call via DID is terminated ('''NOTE:''' due to a global safeguard Calls are terminated ~3 sec. earlier than this setting).

*'''Comment''' – option to save some notes about DID.

*'''[[Sound files | Sound file]]''' – here you can add [[IVR Greeting for DID]]. There are two options:
# Answer and play.
# Early media.
*'''PIN''' – a numeric PIN code to secure a DID.

*'''PIN retries''' – a number of allowed attempts to enter a PIN code.

*'''[[Sound files | Sound file]] to reenter PIN''' – a Sound File that is played before the next attempt to enter a PIN Code.

*'''MOH instead of Ringing''' – if [[Music on Hold|MOH]] is selected, Music on Hold will be played instead of ringing when DID number is dialled.

*'''[[IVR_system | IVR]] if PIN fails''' – an IVR the Call is transferred to when all attempts to enter a PIN Code fail. '''NOTE:''' when all PIN attempts fail and '''IVR if PIN fails''' is None, a Call is terminated with a [[Hangupcause_Codes|Hangupcause Code]] '''275'''.


*'''Grace Time''' – if call duration is less than Grace Time, it will not be accounted, for example: '''Grace Time''' = 3s, call duration <= 3s, then price for the call = 0


*'''Timeout Digit''' – the maximum amount of time permitted between digits when the user is typing in a number. When this timeout expires after the user has started to type in a number, the number will be considered complete, and will be interpreted (sent to the system). Works both with entering destination and ANI/PIN.


*'''Timeout Response''' – the maximum amount of time permitted for user to START entering a number. If the user does not begin typing a number in this amount of time, system will notify that nothing was entered. Once the user begins to type a number, system will wait for Digit Timeout to be reached, and Response Timeout has no effect no more.


*'''CallerID Name Prefix''' – option to add a CallerID Name prefix to the incoming CallerID.


*'''Tone zone''' – option to set tone zones. Tone zone is a different ring tone depending on destination (country).


*'''Tariff for Calling Card''' – option to set a tariff for DID which will be applied for a calling card. It will not be important what tariff is assigned for that card's group.


*'''Active from''' – DID will become active from this date. If DID is not active yet, call is routed like there is no matching DID number.

*'''Active till''' – DID will be active till this date. Expiration does not change DID status, call is routed like there is no matching DID number.

* '''Blacklist Source Number Pool''' - this will set [[Number Pool]] for Blacklist Source. When calling this DID, if Source Number match number in this pool, call will be rejected with '''HGC 283 - Source number is in DID blacklist'''.

* '''Send call anonymously''' - default no. Ability to show Anonymous on incoming call.

* '''Send CallerID in UUI header''' - default no. The ability to show the caller ID on all calls in Sip UUI messaging.
Header example:
User-to-User: hexCallerid;pd=XX;encoding=hex;purpose=isdn-uui;content=isdn-uui

 

= Settings =

If you want to edit a DID's settings, click on the [[Image:edit.png]] icon.
 
[[Image:dids4.png]]
 
The above window is for Free DID. You can:

# Change [[DID_Management#Details | details]]
# [[DID_Management#Reserve_DID_for_User | Reserve DID for User]].
# [[DID_Management#Assign_to_Dial_Plan | Assign to Dial Plan]].
# Terminate a DID.

 

==Reserve DID for User==

When a DID is assigned to a Device (Reserve for User first), you have a few different choices:

[[File:DidAssign5.png]]

Here you can:

# Change [[DID_Management#Details | details]].
# Assign DID to device. Here you can select different Devices for the same user. For select Trunk Device is next section.
# Assign DID to Trunk. Here you can select different Trunk Devices for the same user.
# Stop a DID subscription and reserve the DID for 90 days (by default) to this user in case he changes his mind and wants to get the DID back.

 

==Assign to Dial Plan==

When DID is assigned to [[Dial_Plans | Dial Plan]], in DID settings you can:
# Change [[DID_Management#Details | details]].
# Make DID free.

When you have [[Quickforwards_rules | Quickforward Rule]] for this DID, in DID edit you will see additional notice:

[[Image:DID_edit_collisions_with_qf_rule.png‎]]

 
= Delete DID =

At first, mark it as "not used" (Free). Then terminate it. When you do, you will see [[Image:delete.png]] next to the DID in the main DID window. By clicking on it, you can delete the DID.

 
= DID bulk management =
In the main DIDs window, click [[Image:edit.png]] Bulk Management and you will be able to perform various actions either on:
*'''DIDs interval''' - this will apply action on selected DID interval,
*'''DIDs pattern''' - this will apply action on selected pattern. Supported wildcard symbols in pattern:
** '''%''' matches any symbols, for example '''370%''' will match any number starting with '''370'''
** '''_''' matches one symbol, for example '''370_1334455''' will match numbers in format '''370x1334455''', where '''x''' is any number.
 
[[Image:dids6.png]]
 
Here you can choose which DIDs to update and what to do:
*'''Update''' - option to change some of DID details, Reserve DID for User (only free DIDs can be reserved) or Make DID free.
*'''Delete''' - option to delete DIDs by Provider or make DIDs Free/Terminated/Closed.
*'''Manage rates''' - option to change Rates for [[DID Billing]].
*'''[[Assign DID to Trunk]]'''.

*'''Reserve for User''' - option to reserve DID for User (only free DIDs can be reserved).
*'''Assign Dial Plan''' - option for Assign DID to [[Dial_Plans | Dial Plan]]
 

= Allowing Users to route their DIDs =
Since '''MOR X5''' users are able to route their DID to a Device or an External Server .
This functionality can be enabled in '''SETTINGS -> Setup -> Visual''' by checking the 'Allow User to assign DID to Device:' setting.

Once the functionality is enabled, the user will be able to see an Edit icon, in his DIDs list.
 
[[File:Dids_list_with_did_routing.png‎]]
 

By pressing the icon, the user will be redirected to a page where he will be able to route his DID either to one of his MOR Devices, or to a Device on an external server (eg. SIP/370xxxxxx@123.123.123.123).
 
[[File:Did_routing_panel.png‎]]
 

'''NOTE:''' Reseller's DID list permissions are independent from Resellers' User, this means that Resellers' User can view DID list (if permissions are enabled for them) even when Resellers cannot.

 

=See Also=

*[[DID Billing]]
*[[DIDs Usage]]
*[[MOR_API_did_create | Create DID through API]]
*[[MOR_API_did_device_assign | Assign Device to DID through API]]
*[[MOR_API_did_device_unassign | Unassign Device from DID through API]]
*[[Providers#Provider_Grace_Time|Provider Grace Time]]
*[[Grace_time|Device Grace Time]]
*[[Example - Configuring DID to ring some Device]]
*[[DID is not working]]
*[[ DID_Import_from_CSV | Import DID(s) from CSV file]]
*[[Number Pool]]

Automatic Tariff Import

2020-03-30T13:13:13Z

Ervinas:

= Introduction =

An important task is the timely management of Provider Tariff Plans. While business practices differ, commonly, each Provider will deliver an initial Spreadsheet file detailing their prices to the range of Destination Codes that they are providing. This initial Spreadsheet will then be followed by update notification spreadsheets. These will be received at regular agreed-upon intervals identifying amendments to the previous prices. The format and content of these notifications is not standardised and differs from one Provider to another. This information is vital from a commercial and financial management point of view. It is important therefore that the rating information received from a Provider is uploaded regularly in order that the System can correctly calculate Provider rating costs for calls. It is also important to analyse Tariff/Rating Plan updates received from partners in order to ensure that any errors in the information are noticed early and resolved before causing Billing disputes.

To solve this necessity Tariff Import system should be used. Let's start from defining major terms used in this process.

= Template =

The Provider Import Template is the primary object that requires configuring so that the Provider Rating Import can occur. The Provider Import Template contains the settings that the System uses to convert the information from the Spreadsheet into the System.

= Rate Import Rules =

The Rate Import Rules feature enhances the analysis of the Providers rates by identifying rates that do not meet a specific criterion (for example a rate increase with less than 7 days’ notice) and then potentially either alerting the Administrator or rejecting the rate. One (or more) sets of Rate Import Rules can be defined on the System and assigned to many Tariff Import Rules.

= Tariff Import Rules =

Tariff Import Rules assign Rate Import Rules, Notifications and Template to the received Email/Attachment in order to properly convert received Tariff and upload rates to the System.

= Notifications =

Notifications will generate an email to the desired recipient when configured for various events. Such as:
* Tariff is received
* Tariff is analysed and waiting for confirmation before Import
* Tariff is imported or rejected
* and others

= Import Job =

The Import Job is an auditing object that is created by the import and provides information about what occurred during execution. The Import Job means that, when necessary, it is possible to go back and see what happened on previous imports. For that reason there is a Tariff Jobs table in the Tariff Jobs List window which can be reached by going to Menu -> Billing -> Tariff Import -> Jobs.

 
[[File:M2TIImage56.png]]
 
[[File:M2TIImage20.png]]
 

Tariff Jobs table columns:
* Id: Tariff job identification number.
* Created at: Date when job was created.
* Status: The state of import process. Can be:
** Assigned - import process was started.
** Converting - rates are being converted.
** Failed Conversion - there was an error in rates conversion.
** Converted - rates were successfully converted.
** Importing into Temporary Table - rates are being uploaded from attachment to the system.
** Failed to Import into Temporary Table - there was an error in rates uploading process.
** Imported into Temporary Table - rates have been loaded to the system.
** Analyzing - rates are being analysed.
** Failed Analysis - there was an error in analysis.
** Analyzed - analysis process has been completed.
** Rejected - rates did not match requirements and were rejected.
** Waiting for confirmation - import is stopped until it will be confirmed by admin.
** Cancelled - import was cancelled by admin.
** Imported - rates were successfully imported.
* Import Rules - name of the Tariff Import Rule used in import and the link to its edit view.
* Rate Import Rules - name of the Rate Import Rules used in import and the link to its edit view.
* Tariff - Tariff name which is being changed in import and the link to its edit view.
* Attachment - name of the attachment that was used in import.
* Import Type - type of import. Can be:
** Update - rates will be added or updated.
** Full - rates will be replaced.
* Auto:
** ‘Yes’ means that tariff import will be done without any request for confirmation.
** ‘-’ means that confirmation will be needed after the analysis.
* Email:
** ‘Yes’ email about Tariff Job creation has been sent successfully.
** ‘-’ email has not been sent.
* Rate Changes - number of how many rates were changed during analysis.
* Rejected Rates - number of how many rates were rejected during analysis.
* Analysis (only in analysed jobs) - link to analysis details.
* Delete - button to delete one job.

Note: yellow colored Tariff Jobs rows show that they are waiting for confirmation.

Automatic Deletion

Old Tariff Jobs are periodically deleted by the system. The period of deletion can be found and changed in Settings -> Various -> Delete Tariff Jobs older than. Default value is 30 days. It means that Tariff Jobs which were created before 30 days or more will be deleted.

 
[[File:M2TIImage9.png]]
 

= Analysis =

Detailed Analysis can be reached from the Tariff Jobs table by pressing on ANALYSIS link.

On the top right corner there are buttons:

 
[[File:M2TIImage101.png]]
 

* Confirm: results of analysis are confirmed and tariff import will continue to proceed.

 
[[File:M2TIImage78.png]]
 

* Canceled: tariff import will be canceled.

 
[[File:M2TIImage69.png]]
 

* Refine Results: allows to filter table by selected parameters.

Parameters:
: Rate Increase, Oldest Effective date, Max Decrease, Duplicate Rate, Date Decrease, Maximum Effective Date, Max Rate, Min Times, New Rate, Max Increase, Zero Rate, Increments - can be filtered by values: All (default), None, Alert, Rejected.

: Non Importable Reasons - can be filtered by values All (default), None, Any, Could not determine direction code, Rate price invalid, Effective from invalid.

 
[[File:M2TIImage94.png]]
 

Tariff Job Analysis table:

 
[[File:M2TIImage31.png]]
 

Table columns:
* Prefix: prefix on which the rate will be applied.
* Destination: destination name.
* Rate: rate value.
* Connection fee: [[How the Connection fee works]]
* Increment: [[What is increment]]
* Minimal time: [[What is increment]]
* Effective from: [[Rate Effective From]]

Tooltip:
If the mouse is on the table, additional import rule information will be presented.

 
[[File:M2TIImage32.png]]
 

Row colors:
* If the row is red colored, the rate is not importable. Non Importable Reason can be found by moving mouse over the rate.
* If the row is yellow colored, the rate analysis was successful but there were some warnings. In the tooltip the word ‘alert’ will be next to the parameter which caused the alert.
* If the row is white colored, the rate analysis was successful.

Analysis execution order:
If analysis is being executed on several jobs which includes the same tariff, these jobs will be resolved consistently and the oldest job will have the highest priority. The next analysis of the job will be started only after the previous one is completed.

= Workflow schema =

The workflow can be visualized using the following schema:

 
[[File:M2TIImage15.png]]
 

= Understanding and Working with Provider Import Templates =

A Template is created when a Tariff/Rating Plan first needs importing, and can then be reused every time an update is required.
Templates can also be amended at a later point if the format of the original file is altered. Import Templates are highly flexible and support many Rating Plan formats; they therefore include many options that may not need configuring for the more common simpler Tariffs/Rating Plans.

The Templates work by mapping the contents of an Excel sheet, and its format, to the information required in the Database.
By configuring this information the data is then uploaded into the System and converted into the correct format.

This is illustrated in the diagram below:

 
[[File:M2TIImage64.png]]
 

Tip Before You Begin:
Import Templates are specific to individual Tariffs/Rating Plans, so when creating a new Import Template for the first time it is important to have easy access to the Tariff/Rating Plan involved.
A good tip for working with this - if you happen to have two monitors on your computer - is to display the Tariff/Rating Plan for which the Template is being constructed on one monitor, and System GUI on the other. Alternatively, if only one monitor is available, open the Tariff/Rating Plan in Excel and use Alt+Tab to switch directly between the applications.

The next Section is going to describe each of the settings available for configuring an Import Template.

The screenshot below shows the Template Settings in the default basic view:

 
[[File:M2TIImage113.png]]
 

In this view we can see the basic summary of the Template highlighting each of the sections that may be required to import the Tariff/Rating Plan.

Tip:
Remember that if the Tariff/Rating Plan being imported does not include information relating to a particular section of the Template, then that section can simply be left blank. Many Import Templates will be very simple configuring only four or five settings from the available options.

Name
: Name of the Template can be set to any, but for better management suggested to be the name of Provider.

Rate Sheet
: The Rate Sheet field requires to be set to the corresponding Worksheet in Excel that the Rating Plan information is held on.
: This means that Rating Plans that contain multiple sheets can still be imported.

: Example:
: In provided Tariff/Rating Plan below - Destinations, Prefixes and Rates are stored in the second (“Numberplan”) Worksheet.
: [[File:M2TIImage73.png]]
: Accordingly, Template’s Rate Sheet value must be set to 2.
: [[File:M2TIImage97.png]]
 

Header Rows
: Header Rows setting requires to be set to inform the System of the rows at the top of the Tariff/Rating Plan that are to be ignored when importing meaningful data.
: If Header Rows are set incorrectly, there is a possibility that Tariff/Rating Plan will not be imported at all or with errors because of wrongly processed data.

: Example 1:
: Provided Tariff/Rating Plan below meaningful data starts from Row 1.
: [[File:M2TIImage44.png]]
: This means there are no rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 0.
: [[File:M2TIImage124.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below meaningful data starts from Row 23.
: [[File:M2TIImage40.png]]
: This means there are 22 rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 22.
: [[File:M2TIImage114.png]]
 

Prefix/Code
: Prefix/Code requires to be set to match the Tariff/Rating Plan Prefix column.
: On some occasions there may be two columns (like Country Code, City Code) which the System is also able to handle if Template settings are correct.
: Sometimes provided multiple Prefixes are displayed in singular cell format like “71-76”, “55,551,552,55257” or “370, 371, 372-376, 3772”, such formats are parsed automatically and does not require additional configuration.

: Example 1:
: Provided Tariff/Rating Plan below has only one Prefix column which is B.
: [[File:M2TIImage68.png]]
: Accordingly, Template’s Prefix/Code value must be set to B.
: [[File:M2TIImage42.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Prefix columns which are C and D.
: [[File:M2TIImage67.png]]
: Accordingly, Template’s Prefix/Code values must be set to C and D in exact order.
: [[File:M2TIImage28.png]]
 

Destination/Zone
: The Zone drop-down list box identifies the Column in the Excel sheet that contains the Zone name.
: If there is only one Column containing this information then only one of the dropdown boxes need to be completed. However if the Zone is in two Columns then both of the drop-down boxes can be completed to identify this. In this scenario the blank fields either side of the second box can be used to format the Zone name.
: Example: A Rate Plan includes the following information:
: [[File:M2TIImage59.png]]
: The Zone import is configured with the Columns A and B and the separator fields with a space “Column B”, as shown:
: [[File:M2TIImage5.png]]
 
: This means that the Zone name will be displayed as: Brazil Mobile

: Example 1:
: Provided Tariff/Rating Plan below has only one Destination/Zone column which is A.
: [[File:M2TIImage7.png]]
: Accordingly, Template’s Destination/Zone value must be set to A.
: [[File:M2TIImage21.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Destination/Zone columns which are A and B.
: [[File:M2TIImage34.png]]
: Accordingly, Template’s Destination/Zone values must be set to A and B in exact order.
: [[File:M2TIImage5.png]]
 

Connection Fee
: While uncommon in wholesale, some Rating Plans being imported may still include a fixed Connection Charge - a one off charge applied when the call is connected.
: If required, the Connection Charge drop-down list box can be used to identify the Column containing such a charge in the Rate Plan being imported.

Effective Date
: The Effective Date options determine in which Column(s) the Date and Time information for the imported rates can be found.
: Multiple options are provided to support different Spreadsheet formats.
: Some Tariff/Rating Plan Providers split Effective Date data between two Worksheets, whereas in first Worksheet there are Destinations with Effective Date and in second Worksheet - Destination, Prefix, Rate data. Configuration of such cases is provided in Example 3.

: Example 1:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date value can be set to F.
: [[File:M2TIImage10.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Effective Date column which is F and Effective Time which is G.
: [[File:M2TIImage17.png]]
: Accordingly, Template’s Effective Date values can be set to F and G.
: [[File:M2TIImage43.png]]
 

: Example 3:
: Provided Tariff/Rating Plan below in the first Worksheet shows Destination (Column A) and Effective Date (Column D).
: In the second Worksheet, there are Destination (Column A), Prefix (Column B) and Rate/Price (Column C).
: [[File:M2TIImage112.png]]
: First dropdown configures from which Worksheet takes Effective Date data (which in this example’s case is Worksheet 1 (Rates)).
: Second dropdown configures Effective Date column from secondary Worksheet.
: Third dropdown configures by which secondary Worksheet column do the mapping with primary Worksheet (which in this example’s case is Destination from Worksheet 1 (Rates) Column A).
: Fourth dropdown configures by which primary Worksheet column do the mapping with secondary Worksheet (which in this example’s case is Destination from Worksheet 2 (Numberplan) Column A).
: Accordingly, Template’s Effective Date values can be set to 1, D, A = A.
: [[File:M2TIImage100.png]]
 

Effective Date Format
: After selecting the Column, the Format field is used to specify the format the information is held in the Rate Plan.
: Some suggested formats already exist in dropdown, which can be selected or used as an example to create a custom one if it is not present in dropdown.

: Example:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date Format value can be selected from dropdown with suggested formats.
: [[File:M2TIImage50.png]]
 

Rate
: Rate requires to be set to match the Tariff/Rating Plan Rate/Price column.

: Example:
: Provided Tariff/Rating Plan below has a Price column which is E.
: [[File:M2TIImage60.png]]
: Accordingly, Template’s Rate value must be set to E.
: [[File:M2TIImage51.png]]
 

Minimal Time
: Minimal Time can be set to match Tariff/Rating Plan Minimal Time column.

: Example 1:
: Provided Tariff/Rating Plan below has a Minimal Time column which is E.
: [[File:M2TIImage46.png]]
: Accordingly, Template’s Minimal Time value can be set to E.
: [[File:M2TIImage52.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has a Minimal Time column which is D and in the first place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Minimal Time value can be set to D and field 1.
: [[File:M2TIImage26.png]]
 

Increment
: Increment can be set to match Tariff/Rating Plan Increment column.

: Example 1:
: Provided Tariff/Rating Plan below has an Increment column which is F.
: [[File:M2TIImage63.png]]
: Accordingly, Template’s Increment value can be set to F.
: [[File:M2TIImage11.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Increment column which is D and in the second place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Increment value can be set to D and field 2.
: [[File:M2TIImage103.png]]
 

Exceptions
: Exceptions allow additional data manipulation, when specific rules are defined separately in the provided Tariff/Rating Plan.

: Example 1:
: [[File:M2TIImage41.png]]
: [[File:M2TIImage6.png]]
 

: Example 2:
: [[File:M2TIImage16.png]]
: [[File:M2TIImage19.png]]
 

= Creating and Configuring Rate Import Rules =

Rate Import Rules are relevant to the importing of Provider Rates, and specify actions to be taken if the rule is broken.

The actions available are:
* None (ignore this rule)
* Alert (notify the Administrator)
* Reject Rate (automatically reject the rate which breaches this rule)

Example:
The first Rate Import Rule is the rate increase rule. The variable for this rule is a number of days, 7 days by default.
What this means is that when a Provider Tariff/Rating Plan is uploaded and a rate increase is detected with an Effective Date less than 7 days into the future the action that has been configured will be triggered. The rate could be automatically rejected, or an alert about this rating entry was raised.

 
[[File:M2TIImage70.png]]
 

Available Rate Import Rules with explanation to each one of them:

 
[[File:M2TIImage93.png]]
 

Rate Increase
: If updating existing Rate, whose Rate (Price) increases and takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

Rate Decrease
: If updating existing Rate, whose Rate (Price) decreased and takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

New Rate
: If creating a new non-existing Rate, which takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

Oldest Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is earlier (by days) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 365 which represents day(s).

Maximum Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is later (by days) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 365 which represents day(s).

Max Increase
: If updating existing Rate, whose Rate (Price) increased more by percentages than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 500 which represents Rate’s (Price’s) percentages.

Max Decrease
: If updating existing Rate, whose Rate (Price) decreased more by percentages than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) percentages.

Max Rate
: If updating existing or creating a new Rate, whose Rate (Price) is higher than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) value.

Zero Rate
: If updating existing or creating a new Rate, whose Rate (Price) is zero, then according action will be taken.

Min Times Not Equal
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then according action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

Increment Not Equal
: If updating existing or creating a new Rate, whose new Increment value does not match any from set Rule, then according action will be taken.
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then according action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

= Tariff Import Rules =

 
[[File:M2TIImage118.png]]
 

The main Tariff Import Rules page shows all the Tariff Import specific rules in the system. Here you can add new rules by clicking the button at the upper-right corner. Also, you can Edit/Delete selected Rules with the relevant buttons. The first column '''ACTIVE?''' allows to activate or deactivate a specific Rule by clicking the YES/NO buttons. If you would like to change the order of the Rules, Drag&Drop functionality is available.

Follow the steps below to create Tariff Import Rules:

By clicking the '''ADD NEW TARIFF IMPORT RULES''' button, you are presented with the following settings screen:

 
[[File:M2TIImage65.png]]
 

* '''Name''' - Name of the Rules
* '''Rate Import Rules''' - Select the Rate Import Rules you would like to use
* '''Target Tariff''' - The Tariff for which the changes will be applied
* '''Import Type''' - you can choose between 2 options: Add/Update and Replace All Rates
** '''Add/Update''' - new rates will be added from file and existing ones will be updated
** '''Replace All Rates''' - existing rates will be deleted and new ones imported from file
* '''Import Template''' - Template to be used
* '''Effective Date''' - Effective Date value to be used with Rates
** '''Template''' - Inline - Use Effective Date from File set by Template setting (see: Template)
** '''Subject''' - Use Effective Date from Email Subject
** '''File Name''' - Use Effective Date from File (Attachment) Name
* '''Manual Review''' - Import automatically or wait for manual confirmation
* '''Reject Import if errors found''' - Tariff Import will be rejected if at least one error will be found * '''after analyzing
* '''Stop processing more Rules''' - Matching with Email Details and Active Tariff Import Rules will be in specific order (from Tariff Import Rules List, from top to bottom). Email assigning will be stopped on this Rule if this option is enabled
* '''Default Effective From''' - Effective From value in Rates, when invalid value supplied from file
* '''Default Connection Fee''' - Set Connection Fee for Rates if it is not present or invalid in Import File
* '''Default Increment''' - Set Increment for Rates if it is not present or invalid in Import File
* '''Default Minimal Time''' - Set Minimal Time for Rates if it is not present or invalid in Import File

== Email/Attachment Validation ==

Email/Attachment Validation section is used for specifying which emails where will be used by Tariff Import Rules. There are five fields. First four are for email and fifth is for attachment.

 
[[File:M2TIImage104.png]]
 

* '''Mail From''' - Email Address(es). Multiple emails can be separated by ;.
* '''Sender Name''' - Senders name.
* '''Mail subject''' - Emails subject.
* '''Mail text''' - Emails text.
* '''File Name''' - Attachments file name.

Wildcard % is allowed, which substitutes any character with any length. Example is shown in the image below
 
[[File:M2TIImage110.png]]
 

# Mail From has two values %@gmail.com and john@%.%.
## %@gmail.com specifies it is any gmail email address.
## john@%.% specifies it is john from any email client.
# Sender Name J% any value That starts with uppercase J
# Mail Subject %Rates Subject ends with word Rates
# Mail Text Hello Mail Text Starts with word Hello
# File Name %.csv filename ends with .csv

== Notifications ==

Email Notifications are used to generate email notifications to an internal or external list of recipients.

 
[[File:M2TIImage106.png]]
 

Follow the steps below to create and configure a notification Template.
# Create Email Template. Manual how to create Email Templates can be found here: [[M2 Emails]]. Additional Email variables: tariff_job_id, tariff_job_analysis_url.
# Select created Email Template from Email Template dropdown. Subject field will fill in automatically. [[File:M2TIImage112.png]]
# Enter Email Address(es) in the Recipients field. Multiple Email Addresses must be separated by ;. [[File:M2TIImage116.png]]
# Repeat the same process for desired Import Triggers. [[File:M2TIImage36.png]]

= Inbox =

The Inbox is a type of email inbox available within the System that allows the Rating.
Administrator to view and manage Provider Tariffs/Rate Notifications that have been sent to the System's Email Address.

Caution:
The Inbox functions in a similar way to the email inbox of your desktop or web based email client, with emails sent to the platform’s email address being displayed and stored in the inbox. The inbox also includes additional functionality to support Providers Rate Import procedures and processes.
However, it is important to understand that the Rate Inbox is designed to manage received emails and not to be a “full email client”. This means that it is not possible to Reply To or Forward emails that are received into the Rate Inbox.

Inbox Interface:

 
[[File:M2TIImage82.png]]
 

The Inbox consists of 3 views: Inbox, Completed and Junk.

'''Inbox''' - is the primary working inbox. It is this view that will show emails that have been received that have an associated task that requires carrying out.
That task might be to review and commit an update, assign Tariff Import settings, or a number of other actions.
Emails will remain visible in the Action Required view until the associated rate update is committed, or they are manually completed or deleted.

'''Completed''' - Fully processed emails are shown in the completed tab. Fully processed means that all of the emails attachments had been assigned to at least one of Tariff Import Rules and Tariff Job which is completed.

'''Junk''' - Emails that are deleted from Junk will be removed permanently, not displayed in the deleted view.

Tariff Inbox basics

 
[[File:M2TIImage55.png]]
 

# Email column - Sender name, email address and subject
# Email details button - toggles email details
# Attachments list
# Attachments file type list
# Import jobs associated with attachments
# Import jobs button - toggles import jobs(if there are more than one tariff import job)
# Attachment mapping status
# Processing note
# Inbox view tab
# Completed view tab
# Junk view tab
# Select all emails check box
# Select single email check box
# Delete Selected emails
# Refine Results - shows fields to filter emails

== Email Details ==

Email details are toggled by pressing the arrow button in the Email column. There are four sections: Email Details, Message, Attachments and function buttons.
* Email Details section shows detailed email information such as ID, Received, From, Sender, Subject, To, Reply to and CC.
* Message section contains emails message.
* Attachments section shows attachments associated with email.
* Last Section represents three function buttons.

 
[[File:M2TIImage47.png]]
 

== Filter Emails ==

Email filtering is done by pressing the Refine Results button in the top right corner of Tariff Inbox.

 
[[File:M2TIImage37.png]]
 

There are four fields:
* Period - period between emails were received.
* From - email or sender name.
* Subject - emails subject.
* Message - emails message.

 
[[File:M2TIImage71.png]]
 

Press refine button to see results.

 
[[File:M2TIImage120.png]]
 

Press clear to clear fields.

 
[[File:M2TIImage107.png]]
 

== Delete Emails ==

To delete emails, select emails by clicking their checkboxes.

 
[[File:M2TIImage38.png]]
 

Then press Delete Selected button on top right side of Tariff Inbox

 
[[File:M2TIImage96.png]]
 

After that, selected emails will be in junk view. To delete permanently, repeat the process in Junk view.

To select all emails, click on the top checkbox near the Email column heading.

 
[[File:M2TIImage88.png]]
 

Also, email can be deleted by toggling Email Details and pressing Delete button

 
[[File:M2TIImage72.png]]
 

== Manually assign Tariff Import Settings ==

It is possible to manually Assign Tariff Import Settings.
# Toggle Email Details
# Select Tariff Import Rules for specific attachment
# Press Assign Import settings

 
[[File:M2TIImage57.png]]
 

== Retry Rules mapping ==

If email with multiple attachments has attachments with no import rules it is possible to retry rules mapping. It's simple, press Retry Rules mapping.

 
[[File:M2TIImage33.png]]
 

Note: It’s not possible to Retry Rules mapping if all email attachments will have at least one import rule assigned to it.

== Attachment mapping status ==

Attachment mapping status(Status column in Emails list) indicates if Tariff Import Rules mapping was successful or not.

 
[[File:M2TIImage90.png]]
 

'''Import Rules Found''' - attachment was mapped successfully with at least one of the Tariff Import Rules.
'''Import Rules Not Found''' - attachment was not mapped to any of the Tariff Import Rules or there were no Tariff Import Rules to map.
'''Invalid Effective Date/Format for Tariff Import Rules''' - Invalid attachment date or it’s format compared to Tariff Import Rules settings. Numbers after status text represent Tariff Import Rules IDs.

== Email Example ==

Email can have one or multiple attachments. Every attachment will be processed individually. Attachment can have one or multiple Import Jobs which are dependent on the number of mapped Tariff Import Rules.

 
[[File:M2TIImage61.png]]
 

If there are multiple Tariff Jobs they will be shown as a toggle list. To toggle the list, simply press the arrow button next to Jobs list caption.

 
[[File:M2TIImage87.png]]
 

To see Job details click on any Import Job. Page will be redirected to the Tariff Jobs list.

 
[[File:M2TIImage62.png]]
 

= Examples =

== Rate upload from TATA ==

1. Analyze the tariff:
 
[[File:M2TIImage105.png]]
 

2. Create template for a tariff in BILLING → Tariff import → Import Rules → Templates
 
[[File:M2TIImage81.png]]
 

3. Select appropriate fields according to the tariff cells:
 
[[File:M2TIImage22.png]]
 

4. Create Rate Import Rules in BILLING → Tariff import → Import Rules → Rate Import Rules
 
[[File:M2TIImage54.png]]
 

5. Fill cells according your needs:
 
[[File:M2TIImage80.png]]
 

6. Create Tariff Import Rules in BILLING → Tariff import → Import Rules
 
[[File:M2TIImage14.png]]
 

7. Fill required cells:
 
[[File:M2TIImage111.png]]
 

8. Check the Inbox for a new email at Billing → Tariff Import → Inbox

9. Enter the mail, select Tariff Import Rules and press Assign Import Settings to continue the import:
 
[[File:M2TIImage18.png]]
 

10. Tariff job is created now, you can see it in BILLING → Tariff Import → Jobs
 
[[File:M2TIImage102.png]]
 

11. Job is now waiting for confirmation. You can view analysis before confirming:
 
[[File:M2TIImage45.png]]
 

12. Point to the line you want to analyze to see more information:
 
[[File:M2TIImage35.png]]
 

13. If you are satisfied, press confirm to finish the import procedure, otherwise cancel it.
 
[[File:M2TIImage1.png]]
 

14. If you pressed confirm, you will see that job was successfully confirmed:
 
[[File:M2TIImage77.png]]
 

15. Go back to Jobs page in BILLING → Tariff Import → Jobs to see status of the Job:
 
[[File:M2TIImage79.png]]
 

16. Tariff import is finished. As a target tariff in this example was “SUPPLIER PREMIUM”, you can verify rates checking page BILLING → Tariffs.
 
[[File:M2TIImage12.png]]
 

== Speedflow Tariff Import configuration ==

 
[[File:M2TIImage117.png]]
 

1. Create import template.
Go to BILLING > Tariff Import > Import Rules > Templates.
Click "ADD NEW TEMPLATE" at the top-right corner of the page.

Set "Name" to "speedflow". It can be any name, but "speedflow" will represent for which Provider tariffs this template is used.
Set "Rate Sheet" to "1", as this tariff files contains only one worksheet.
Set "Header Rows" to "22", as this tariff have 4 rows before actual rates data begins.
Set "Refix/Code" to column "A";
Set "Destination/Zone" to column "B";
Set "Effective Date" to column "E";
Set "Effective Date Format" to "%d.%m.%y";
Set "Rate" to column "C";
Set "Minimal Time" to column "E" and value "1";
Set "Increment" to column "E" and value "2";

 
[[File:M2TIImage76.png]]
 

Click "Create" to save changes.

2. Create Rate Import Rules
Go to BILLING > Tariff Import > Import Rules > Rate Import Rules
Click "ADD NEW RATE IMPORT RULES" at the top-right corner of the page.

This example shows how to create Rate Import Rule which will inform admin about new rates above 1.0 in price and will reject rates where price is equal to 0.

Set "Name" to "speedflow";
Set "Max Rate" to value "1.0" and action "Alert";
Set "Zero Rate" to action "Reject Rate".

 
[[File:M2TIImage23.png]]
 

Click "Create" to save changes.

3. Create Tariff Import Rules
Go to BILLING > Tariff Import > Import Rules
Click "ADD NEW TARIFF IMPORT RULES" at the top-right corner of the page.

Set fields like this:
"Name":"speedflow";
"Rate Import Rules":"speedflow";
"Target Tariff":"speedflow (EUR)". This is tariff assigned to speedflow Termination Point;
"Import Type":"Add/Update";
"Import Template":"speedflow";
"Effective Date":"Template - Inline"
"Mail From":"rates@speedflow.com". This is not actual email from which speedflow sends rates. Set correct email address from which you get tariffs.
"File Name":"%.xls"

 
[[File:M2TIImage58.png]]
 

Click "Create" to save changes

At this point the system is ready to receive email from speedflow.

5. Once email from speedflow is received you will see a new Tariff Job waiting for confirmation in Billing > Tariff Import > Jobs.

 
[[File:M2TIImage108.png]]
 

Click "ANALYSIS" to see rates to be imported. By default, the ANALYSIS page does not show new rates. Click "REFINE RESULTS", uncheck "Show Only Rejected" and click REFINE to see all received rates.

Click "CONFIRM" at the top-right corner of the page to proceed with import of rates.

 
[[File:M2TIImage89.png]]
 

In BILLING > Tariffs List, Tariff Import is completed and new Rates are now visible.

 
[[File:M2TIImage121.png]]
 

== Step by step example for VoiceTrading Tariff ==

1. Review VoiceTrading XLSX tariff structure

 
[[File:M2TIImage95.png]]
 

 
[[File:M2TIImage83.png]]
 

We can see that XLSX document consists of two Worksheets: Worksheet 1 (Rates) and Worksheet 2 (Numberplan).
2. Go to BILLING > Tariff Import > Import Rules > Templates to create a new Template

 
[[File:M2TIImage85.png]]
 

3. Configure Template for VoiceTrading XLSX structure

 
[[File:M2TIImage92.png]]
 

As you can see, there are two tabs in this page: Primary Data and Secondary Data. Do not confuse them with Worksheets, they are not related. Some Providers do not want to exceed a certain limit of rows in XLSX file, so data is placed in two regions on the same row(s). Let’s review screenshot below:

 
[[File:M2TIImage66.png]]
 

Green square corresponds to '''Primary Data''', while Blue square corresponds to '''Secondary Data'''. They both contain the same information: Destination name, Prefix and Rate.

Lets go step by step and configure a Template for '''Primary Data''':

 
[[File:M2TIImage4.png]]
 

'''Rate Sheet - 2'''. VoiceTrading XLSX file has two sheets, so set to 2
'''Header Rows - 0'''. VoiceTrading XLSX file has no header rows (data starts at 1st row)

 
[[File:M2TIImage3.png]]
 

'''Prefix/Code - B'''. Prefix is in Cell B for Primary Data.
'''Destination/Zone - A'''. Destination is in Cell A for Primary Data.
'''Connection Fee - Empty'''. There is no Connection Fee cell in VoiceTrading XLSX.

 
[[File:M2TIImage115.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage48.png]]
 

 
[[File:M2TIImage8.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage86.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates) and also A on Worksheet 2 (Numberplan). So we select '''A''' on 3rd and 4th Dropdown accordingly.

 
[[File:M2TIImage39.png]]
 

Effective Date Format for VoiceTrading is in YYY.MM.DD, so we select accordingly.

 
[[File:M2TIImage125.png]]
 

'''Rate - C'''. Prefix is in Cell C for Primary Data.
There are no '''Minimal Time''' and '''Increment''' cells in VoiceTrading XLSX.

Let’s configure '''Secondary Data''' now:

 
[[File:M2TIImage24.png]]
 

'''Rate Sheet''', '''Header Rows''' and '''Effective date''' will be the same as on Primary data.

 
[[File:M2TIImage25.png]]
 

'''Prefix/Code - F'''. Prefix is in Cell F for Secondary Data.
'''Destination/Zone - E'''. Destination is in Cell E for Secondary Data.
'''Connection Fee - Empty'''. There is no Connection Fee Cell in VoiceTrading XLSX.

 
[[File:M2TIImage30.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage53.png]]
 

 
[[File:M2TIImage119.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage98.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates) and E on Worksheet 2 (Numberplan). So we select '''A''' on 3rd dropdown and '''E''' on 4th dropdown accordingly.

 
[[File:M2TIImage109.png]]
 

Once configuration is complete, press CREATE button to create a new Template.

4. Go to BILLING > Tariff Import > Import Rules > Rate Import Rules to create Rate Import Rules

 
[[File:M2TIImage91.png]]
 

5. Configure Rate Import Rules according to your specifications

 
[[File:M2TIImage2.png]]
 

In this example we changed these values:
'''Max Increase''': 50%. If rate increase is higher than 50%, such rate will be automatically rejected.
'''Max Decrease''': 50%. If rate increase is higher than 50%, such rate will be automatically rejected.
'''Max Rate''': 1.99. If rate is higher than 1.99, such rate will be automatically rejected.

6. Go to BILLING > Tariff Import > Import Rules to create Tariff Import Rules

 
[[File:M2TIImage84.png]]
 

7. Configure Tariff Import Rules according to your specifications

 
[[File:M2TIImage99.png]]
 

The minimum what you should change from default:
'''Rate Import Rules''': set to Import Rules created in step 5.
'''Target Tariff''': set to Tariff you want to import rates to.
'''Import Template''': set to Template created and configured in step 3.
'''Email/Attachment Validation''': set to valid date for your Provider. Data in the screenshot is only an example and does not represent real values for VoiceTrading Provider.

8. Once email(s) will be received, you will see them in BILLING > Tariff Import > Inbox
If Tariff Import Rules have been correctly entered in the previous step, Import Job will be created automatically.

 
[[File:M2TIImage13.png]]
 

9. Click on the Import Job link. This will redirect you to the Tariff Jobs page.

 
[[File:M2TIImage123.png]]
 

Here we can see that Tariff Job is waiting for confirmation and that there are 1178 rates to be updated and 0 rejected rates.

10. Click on ANALYSIS link to view detailed analysis

 
[[File:M2TIImage74.png]]
 

By default, Tariff Job Analysis page shows only rejected Rates. There are no rejected rates in this case, so we can press CONFIRM button.

11. Go to BILLING > Tariff Import > Jobs to check Tariff Jobs status again. We can see that status is '''Imported'''.

12. Process is completed. Let’s go to Billing > Tariffs to confirm this

 
[[File:M2TIImage75.png]]
 

We can see that 1178 rates have been imported to Tariff '''Supplier VoiceTrading'''.

Automatic Tariff Import

2020-03-30T13:12:56Z

Ervinas:

__INDEX__ Tariff Import

= Introduction =

An important task is the timely management of Provider Tariff Plans. While business practices differ, commonly, each Provider will deliver an initial Spreadsheet file detailing their prices to the range of Destination Codes that they are providing. This initial Spreadsheet will then be followed by update notification spreadsheets. These will be received at regular agreed-upon intervals identifying amendments to the previous prices. The format and content of these notifications is not standardised and differs from one Provider to another. This information is vital from a commercial and financial management point of view. It is important therefore that the rating information received from a Provider is uploaded regularly in order that the System can correctly calculate Provider rating costs for calls. It is also important to analyse Tariff/Rating Plan updates received from partners in order to ensure that any errors in the information are noticed early and resolved before causing Billing disputes.

To solve this necessity Tariff Import system should be used. Let's start from defining major terms used in this process.

= Template =

The Provider Import Template is the primary object that requires configuring so that the Provider Rating Import can occur. The Provider Import Template contains the settings that the System uses to convert the information from the Spreadsheet into the System.

= Rate Import Rules =

The Rate Import Rules feature enhances the analysis of the Providers rates by identifying rates that do not meet a specific criterion (for example a rate increase with less than 7 days’ notice) and then potentially either alerting the Administrator or rejecting the rate. One (or more) sets of Rate Import Rules can be defined on the System and assigned to many Tariff Import Rules.

= Tariff Import Rules =

Tariff Import Rules assign Rate Import Rules, Notifications and Template to the received Email/Attachment in order to properly convert received Tariff and upload rates to the System.

= Notifications =

Notifications will generate an email to the desired recipient when configured for various events. Such as:
* Tariff is received
* Tariff is analysed and waiting for confirmation before Import
* Tariff is imported or rejected
* and others

= Import Job =

The Import Job is an auditing object that is created by the import and provides information about what occurred during execution. The Import Job means that, when necessary, it is possible to go back and see what happened on previous imports. For that reason there is a Tariff Jobs table in the Tariff Jobs List window which can be reached by going to Menu -> Billing -> Tariff Import -> Jobs.

 
[[File:M2TIImage56.png]]
 
[[File:M2TIImage20.png]]
 

Tariff Jobs table columns:
* Id: Tariff job identification number.
* Created at: Date when job was created.
* Status: The state of import process. Can be:
** Assigned - import process was started.
** Converting - rates are being converted.
** Failed Conversion - there was an error in rates conversion.
** Converted - rates were successfully converted.
** Importing into Temporary Table - rates are being uploaded from attachment to the system.
** Failed to Import into Temporary Table - there was an error in rates uploading process.
** Imported into Temporary Table - rates have been loaded to the system.
** Analyzing - rates are being analysed.
** Failed Analysis - there was an error in analysis.
** Analyzed - analysis process has been completed.
** Rejected - rates did not match requirements and were rejected.
** Waiting for confirmation - import is stopped until it will be confirmed by admin.
** Cancelled - import was cancelled by admin.
** Imported - rates were successfully imported.
* Import Rules - name of the Tariff Import Rule used in import and the link to its edit view.
* Rate Import Rules - name of the Rate Import Rules used in import and the link to its edit view.
* Tariff - Tariff name which is being changed in import and the link to its edit view.
* Attachment - name of the attachment that was used in import.
* Import Type - type of import. Can be:
** Update - rates will be added or updated.
** Full - rates will be replaced.
* Auto:
** ‘Yes’ means that tariff import will be done without any request for confirmation.
** ‘-’ means that confirmation will be needed after the analysis.
* Email:
** ‘Yes’ email about Tariff Job creation has been sent successfully.
** ‘-’ email has not been sent.
* Rate Changes - number of how many rates were changed during analysis.
* Rejected Rates - number of how many rates were rejected during analysis.
* Analysis (only in analysed jobs) - link to analysis details.
* Delete - button to delete one job.

Note: yellow colored Tariff Jobs rows show that they are waiting for confirmation.

Automatic Deletion

Old Tariff Jobs are periodically deleted by the system. The period of deletion can be found and changed in Settings -> Various -> Delete Tariff Jobs older than. Default value is 30 days. It means that Tariff Jobs which were created before 30 days or more will be deleted.

 
[[File:M2TIImage9.png]]
 

= Analysis =

Detailed Analysis can be reached from the Tariff Jobs table by pressing on ANALYSIS link.

On the top right corner there are buttons:

 
[[File:M2TIImage101.png]]
 

* Confirm: results of analysis are confirmed and tariff import will continue to proceed.

 
[[File:M2TIImage78.png]]
 

* Canceled: tariff import will be canceled.

 
[[File:M2TIImage69.png]]
 

* Refine Results: allows to filter table by selected parameters.

Parameters:
: Rate Increase, Oldest Effective date, Max Decrease, Duplicate Rate, Date Decrease, Maximum Effective Date, Max Rate, Min Times, New Rate, Max Increase, Zero Rate, Increments - can be filtered by values: All (default), None, Alert, Rejected.

: Non Importable Reasons - can be filtered by values All (default), None, Any, Could not determine direction code, Rate price invalid, Effective from invalid.

 
[[File:M2TIImage94.png]]
 

Tariff Job Analysis table:

 
[[File:M2TIImage31.png]]
 

Table columns:
* Prefix: prefix on which the rate will be applied.
* Destination: destination name.
* Rate: rate value.
* Connection fee: [[How the Connection fee works]]
* Increment: [[What is increment]]
* Minimal time: [[What is increment]]
* Effective from: [[Rate Effective From]]

Tooltip:
If the mouse is on the table, additional import rule information will be presented.

 
[[File:M2TIImage32.png]]
 

Row colors:
* If the row is red colored, the rate is not importable. Non Importable Reason can be found by moving mouse over the rate.
* If the row is yellow colored, the rate analysis was successful but there were some warnings. In the tooltip the word ‘alert’ will be next to the parameter which caused the alert.
* If the row is white colored, the rate analysis was successful.

Analysis execution order:
If analysis is being executed on several jobs which includes the same tariff, these jobs will be resolved consistently and the oldest job will have the highest priority. The next analysis of the job will be started only after the previous one is completed.

= Workflow schema =

The workflow can be visualized using the following schema:

 
[[File:M2TIImage15.png]]
 

= Understanding and Working with Provider Import Templates =

A Template is created when a Tariff/Rating Plan first needs importing, and can then be reused every time an update is required.
Templates can also be amended at a later point if the format of the original file is altered. Import Templates are highly flexible and support many Rating Plan formats; they therefore include many options that may not need configuring for the more common simpler Tariffs/Rating Plans.

The Templates work by mapping the contents of an Excel sheet, and its format, to the information required in the Database.
By configuring this information the data is then uploaded into the System and converted into the correct format.

This is illustrated in the diagram below:

 
[[File:M2TIImage64.png]]
 

Tip Before You Begin:
Import Templates are specific to individual Tariffs/Rating Plans, so when creating a new Import Template for the first time it is important to have easy access to the Tariff/Rating Plan involved.
A good tip for working with this - if you happen to have two monitors on your computer - is to display the Tariff/Rating Plan for which the Template is being constructed on one monitor, and System GUI on the other. Alternatively, if only one monitor is available, open the Tariff/Rating Plan in Excel and use Alt+Tab to switch directly between the applications.

The next Section is going to describe each of the settings available for configuring an Import Template.

The screenshot below shows the Template Settings in the default basic view:

 
[[File:M2TIImage113.png]]
 

In this view we can see the basic summary of the Template highlighting each of the sections that may be required to import the Tariff/Rating Plan.

Tip:
Remember that if the Tariff/Rating Plan being imported does not include information relating to a particular section of the Template, then that section can simply be left blank. Many Import Templates will be very simple configuring only four or five settings from the available options.

Name
: Name of the Template can be set to any, but for better management suggested to be the name of Provider.

Rate Sheet
: The Rate Sheet field requires to be set to the corresponding Worksheet in Excel that the Rating Plan information is held on.
: This means that Rating Plans that contain multiple sheets can still be imported.

: Example:
: In provided Tariff/Rating Plan below - Destinations, Prefixes and Rates are stored in the second (“Numberplan”) Worksheet.
: [[File:M2TIImage73.png]]
: Accordingly, Template’s Rate Sheet value must be set to 2.
: [[File:M2TIImage97.png]]
 

Header Rows
: Header Rows setting requires to be set to inform the System of the rows at the top of the Tariff/Rating Plan that are to be ignored when importing meaningful data.
: If Header Rows are set incorrectly, there is a possibility that Tariff/Rating Plan will not be imported at all or with errors because of wrongly processed data.

: Example 1:
: Provided Tariff/Rating Plan below meaningful data starts from Row 1.
: [[File:M2TIImage44.png]]
: This means there are no rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 0.
: [[File:M2TIImage124.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below meaningful data starts from Row 23.
: [[File:M2TIImage40.png]]
: This means there are 22 rows to skip/ignore for the Header Rows setting.
: Accordingly, Template’s Header Rows value must be set to 22.
: [[File:M2TIImage114.png]]
 

Prefix/Code
: Prefix/Code requires to be set to match the Tariff/Rating Plan Prefix column.
: On some occasions there may be two columns (like Country Code, City Code) which the System is also able to handle if Template settings are correct.
: Sometimes provided multiple Prefixes are displayed in singular cell format like “71-76”, “55,551,552,55257” or “370, 371, 372-376, 3772”, such formats are parsed automatically and does not require additional configuration.

: Example 1:
: Provided Tariff/Rating Plan below has only one Prefix column which is B.
: [[File:M2TIImage68.png]]
: Accordingly, Template’s Prefix/Code value must be set to B.
: [[File:M2TIImage42.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Prefix columns which are C and D.
: [[File:M2TIImage67.png]]
: Accordingly, Template’s Prefix/Code values must be set to C and D in exact order.
: [[File:M2TIImage28.png]]
 

Destination/Zone
: The Zone drop-down list box identifies the Column in the Excel sheet that contains the Zone name.
: If there is only one Column containing this information then only one of the dropdown boxes need to be completed. However if the Zone is in two Columns then both of the drop-down boxes can be completed to identify this. In this scenario the blank fields either side of the second box can be used to format the Zone name.
: Example: A Rate Plan includes the following information:
: [[File:M2TIImage59.png]]
: The Zone import is configured with the Columns A and B and the separator fields with a space “Column B”, as shown:
: [[File:M2TIImage5.png]]
 
: This means that the Zone name will be displayed as: Brazil Mobile

: Example 1:
: Provided Tariff/Rating Plan below has only one Destination/Zone column which is A.
: [[File:M2TIImage7.png]]
: Accordingly, Template’s Destination/Zone value must be set to A.
: [[File:M2TIImage21.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has two Destination/Zone columns which are A and B.
: [[File:M2TIImage34.png]]
: Accordingly, Template’s Destination/Zone values must be set to A and B in exact order.
: [[File:M2TIImage5.png]]
 

Connection Fee
: While uncommon in wholesale, some Rating Plans being imported may still include a fixed Connection Charge - a one off charge applied when the call is connected.
: If required, the Connection Charge drop-down list box can be used to identify the Column containing such a charge in the Rate Plan being imported.

Effective Date
: The Effective Date options determine in which Column(s) the Date and Time information for the imported rates can be found.
: Multiple options are provided to support different Spreadsheet formats.
: Some Tariff/Rating Plan Providers split Effective Date data between two Worksheets, whereas in first Worksheet there are Destinations with Effective Date and in second Worksheet - Destination, Prefix, Rate data. Configuration of such cases is provided in Example 3.

: Example 1:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date value can be set to F.
: [[File:M2TIImage10.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Effective Date column which is F and Effective Time which is G.
: [[File:M2TIImage17.png]]
: Accordingly, Template’s Effective Date values can be set to F and G.
: [[File:M2TIImage43.png]]
 

: Example 3:
: Provided Tariff/Rating Plan below in the first Worksheet shows Destination (Column A) and Effective Date (Column D).
: In the second Worksheet, there are Destination (Column A), Prefix (Column B) and Rate/Price (Column C).
: [[File:M2TIImage112.png]]
: First dropdown configures from which Worksheet takes Effective Date data (which in this example’s case is Worksheet 1 (Rates)).
: Second dropdown configures Effective Date column from secondary Worksheet.
: Third dropdown configures by which secondary Worksheet column do the mapping with primary Worksheet (which in this example’s case is Destination from Worksheet 1 (Rates) Column A).
: Fourth dropdown configures by which primary Worksheet column do the mapping with secondary Worksheet (which in this example’s case is Destination from Worksheet 2 (Numberplan) Column A).
: Accordingly, Template’s Effective Date values can be set to 1, D, A = A.
: [[File:M2TIImage100.png]]
 

Effective Date Format
: After selecting the Column, the Format field is used to specify the format the information is held in the Rate Plan.
: Some suggested formats already exist in dropdown, which can be selected or used as an example to create a custom one if it is not present in dropdown.

: Example:
: Provided Tariff/Rating Plan below has an Effective Date column which is F.
: [[File:M2TIImage29.png]]
: Accordingly, Template’s Effective Date Format value can be selected from dropdown with suggested formats.
: [[File:M2TIImage50.png]]
 

Rate
: Rate requires to be set to match the Tariff/Rating Plan Rate/Price column.

: Example:
: Provided Tariff/Rating Plan below has a Price column which is E.
: [[File:M2TIImage60.png]]
: Accordingly, Template’s Rate value must be set to E.
: [[File:M2TIImage51.png]]
 

Minimal Time
: Minimal Time can be set to match Tariff/Rating Plan Minimal Time column.

: Example 1:
: Provided Tariff/Rating Plan below has a Minimal Time column which is E.
: [[File:M2TIImage46.png]]
: Accordingly, Template’s Minimal Time value can be set to E.
: [[File:M2TIImage52.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has a Minimal Time column which is D and in the first place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Minimal Time value can be set to D and field 1.
: [[File:M2TIImage26.png]]
 

Increment
: Increment can be set to match Tariff/Rating Plan Increment column.

: Example 1:
: Provided Tariff/Rating Plan below has an Increment column which is F.
: [[File:M2TIImage63.png]]
: Accordingly, Template’s Increment value can be set to F.
: [[File:M2TIImage11.png]]
 

: Example 2:
: Provided Tariff/Rating Plan below has an Increment column which is D and in the second place of “x/y/z/” fields.
: [[File:M2TIImage49.png]]
: Accordingly, Template’s Increment value can be set to D and field 2.
: [[File:M2TIImage103.png]]
 

Exceptions
: Exceptions allow additional data manipulation, when specific rules are defined separately in the provided Tariff/Rating Plan.

: Example 1:
: [[File:M2TIImage41.png]]
: [[File:M2TIImage6.png]]
 

: Example 2:
: [[File:M2TIImage16.png]]
: [[File:M2TIImage19.png]]
 

= Creating and Configuring Rate Import Rules =

Rate Import Rules are relevant to the importing of Provider Rates, and specify actions to be taken if the rule is broken.

The actions available are:
* None (ignore this rule)
* Alert (notify the Administrator)
* Reject Rate (automatically reject the rate which breaches this rule)

Example:
The first Rate Import Rule is the rate increase rule. The variable for this rule is a number of days, 7 days by default.
What this means is that when a Provider Tariff/Rating Plan is uploaded and a rate increase is detected with an Effective Date less than 7 days into the future the action that has been configured will be triggered. The rate could be automatically rejected, or an alert about this rating entry was raised.

 
[[File:M2TIImage70.png]]
 

Available Rate Import Rules with explanation to each one of them:

 
[[File:M2TIImage93.png]]
 

Rate Increase
: If updating existing Rate, whose Rate (Price) increases and takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

Rate Decrease
: If updating existing Rate, whose Rate (Price) decreased and takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

New Rate
: If creating a new non-existing Rate, which takes into effect earlier (by days compared to importing effective from) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 30 which represents day(s).

Oldest Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is earlier (by days) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 365 which represents day(s).

Maximum Effective Date
: If updating existing or creating a new Rate, whose new Effective Date is later (by days) than set in Rule, then according action will be taken.
: Value can be set to any integer between 0 and 365 which represents day(s).

Max Increase
: If updating existing Rate, whose Rate (Price) increased more by percentages than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 500 which represents Rate’s (Price’s) percentages.

Max Decrease
: If updating existing Rate, whose Rate (Price) decreased more by percentages than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) percentages.

Max Rate
: If updating existing or creating a new Rate, whose Rate (Price) is higher than set in Rule, then according action will be taken.
: Value can be set to any decimal between 0 and 100 which represents Rate’s (Price’s) value.

Zero Rate
: If updating existing or creating a new Rate, whose Rate (Price) is zero, then according action will be taken.

Min Times Not Equal
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then according action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

Increment Not Equal
: If updating existing or creating a new Rate, whose new Increment value does not match any from set Rule, then according action will be taken.
: If updating existing or creating a new Rate, whose new Min Time value does not match any from set Rule, then according action will be taken.
: Acceptable value format is: “x,y,z,w”
:: Where x, y, z and w must be integer values between 0 and 7200.
:: Must be separated by comma (,).
:: Must not have any spaces.
:: Must not have leading zeros, unless it is only a zero.
: Examples:
:: 0,100,60,7200
:: 0,1,60
:: 1,60
:: 1

= Tariff Import Rules =

 
[[File:M2TIImage118.png]]
 

The main Tariff Import Rules page shows all the Tariff Import specific rules in the system. Here you can add new rules by clicking the button at the upper-right corner. Also, you can Edit/Delete selected Rules with the relevant buttons. The first column '''ACTIVE?''' allows to activate or deactivate a specific Rule by clicking the YES/NO buttons. If you would like to change the order of the Rules, Drag&Drop functionality is available.

Follow the steps below to create Tariff Import Rules:

By clicking the '''ADD NEW TARIFF IMPORT RULES''' button, you are presented with the following settings screen:

 
[[File:M2TIImage65.png]]
 

* '''Name''' - Name of the Rules
* '''Rate Import Rules''' - Select the Rate Import Rules you would like to use
* '''Target Tariff''' - The Tariff for which the changes will be applied
* '''Import Type''' - you can choose between 2 options: Add/Update and Replace All Rates
** '''Add/Update''' - new rates will be added from file and existing ones will be updated
** '''Replace All Rates''' - existing rates will be deleted and new ones imported from file
* '''Import Template''' - Template to be used
* '''Effective Date''' - Effective Date value to be used with Rates
** '''Template''' - Inline - Use Effective Date from File set by Template setting (see: Template)
** '''Subject''' - Use Effective Date from Email Subject
** '''File Name''' - Use Effective Date from File (Attachment) Name
* '''Manual Review''' - Import automatically or wait for manual confirmation
* '''Reject Import if errors found''' - Tariff Import will be rejected if at least one error will be found * '''after analyzing
* '''Stop processing more Rules''' - Matching with Email Details and Active Tariff Import Rules will be in specific order (from Tariff Import Rules List, from top to bottom). Email assigning will be stopped on this Rule if this option is enabled
* '''Default Effective From''' - Effective From value in Rates, when invalid value supplied from file
* '''Default Connection Fee''' - Set Connection Fee for Rates if it is not present or invalid in Import File
* '''Default Increment''' - Set Increment for Rates if it is not present or invalid in Import File
* '''Default Minimal Time''' - Set Minimal Time for Rates if it is not present or invalid in Import File

== Email/Attachment Validation ==

Email/Attachment Validation section is used for specifying which emails where will be used by Tariff Import Rules. There are five fields. First four are for email and fifth is for attachment.

 
[[File:M2TIImage104.png]]
 

* '''Mail From''' - Email Address(es). Multiple emails can be separated by ;.
* '''Sender Name''' - Senders name.
* '''Mail subject''' - Emails subject.
* '''Mail text''' - Emails text.
* '''File Name''' - Attachments file name.

Wildcard % is allowed, which substitutes any character with any length. Example is shown in the image below
 
[[File:M2TIImage110.png]]
 

# Mail From has two values %@gmail.com and john@%.%.
## %@gmail.com specifies it is any gmail email address.
## john@%.% specifies it is john from any email client.
# Sender Name J% any value That starts with uppercase J
# Mail Subject %Rates Subject ends with word Rates
# Mail Text Hello Mail Text Starts with word Hello
# File Name %.csv filename ends with .csv

== Notifications ==

Email Notifications are used to generate email notifications to an internal or external list of recipients.

 
[[File:M2TIImage106.png]]
 

Follow the steps below to create and configure a notification Template.
# Create Email Template. Manual how to create Email Templates can be found here: [[M2 Emails]]. Additional Email variables: tariff_job_id, tariff_job_analysis_url.
# Select created Email Template from Email Template dropdown. Subject field will fill in automatically. [[File:M2TIImage112.png]]
# Enter Email Address(es) in the Recipients field. Multiple Email Addresses must be separated by ;. [[File:M2TIImage116.png]]
# Repeat the same process for desired Import Triggers. [[File:M2TIImage36.png]]

= Inbox =

The Inbox is a type of email inbox available within the System that allows the Rating.
Administrator to view and manage Provider Tariffs/Rate Notifications that have been sent to the System's Email Address.

Caution:
The Inbox functions in a similar way to the email inbox of your desktop or web based email client, with emails sent to the platform’s email address being displayed and stored in the inbox. The inbox also includes additional functionality to support Providers Rate Import procedures and processes.
However, it is important to understand that the Rate Inbox is designed to manage received emails and not to be a “full email client”. This means that it is not possible to Reply To or Forward emails that are received into the Rate Inbox.

Inbox Interface:

 
[[File:M2TIImage82.png]]
 

The Inbox consists of 3 views: Inbox, Completed and Junk.

'''Inbox''' - is the primary working inbox. It is this view that will show emails that have been received that have an associated task that requires carrying out.
That task might be to review and commit an update, assign Tariff Import settings, or a number of other actions.
Emails will remain visible in the Action Required view until the associated rate update is committed, or they are manually completed or deleted.

'''Completed''' - Fully processed emails are shown in the completed tab. Fully processed means that all of the emails attachments had been assigned to at least one of Tariff Import Rules and Tariff Job which is completed.

'''Junk''' - Emails that are deleted from Junk will be removed permanently, not displayed in the deleted view.

Tariff Inbox basics

 
[[File:M2TIImage55.png]]
 

# Email column - Sender name, email address and subject
# Email details button - toggles email details
# Attachments list
# Attachments file type list
# Import jobs associated with attachments
# Import jobs button - toggles import jobs(if there are more than one tariff import job)
# Attachment mapping status
# Processing note
# Inbox view tab
# Completed view tab
# Junk view tab
# Select all emails check box
# Select single email check box
# Delete Selected emails
# Refine Results - shows fields to filter emails

== Email Details ==

Email details are toggled by pressing the arrow button in the Email column. There are four sections: Email Details, Message, Attachments and function buttons.
* Email Details section shows detailed email information such as ID, Received, From, Sender, Subject, To, Reply to and CC.
* Message section contains emails message.
* Attachments section shows attachments associated with email.
* Last Section represents three function buttons.

 
[[File:M2TIImage47.png]]
 

== Filter Emails ==

Email filtering is done by pressing the Refine Results button in the top right corner of Tariff Inbox.

 
[[File:M2TIImage37.png]]
 

There are four fields:
* Period - period between emails were received.
* From - email or sender name.
* Subject - emails subject.
* Message - emails message.

 
[[File:M2TIImage71.png]]
 

Press refine button to see results.

 
[[File:M2TIImage120.png]]
 

Press clear to clear fields.

 
[[File:M2TIImage107.png]]
 

== Delete Emails ==

To delete emails, select emails by clicking their checkboxes.

 
[[File:M2TIImage38.png]]
 

Then press Delete Selected button on top right side of Tariff Inbox

 
[[File:M2TIImage96.png]]
 

After that, selected emails will be in junk view. To delete permanently, repeat the process in Junk view.

To select all emails, click on the top checkbox near the Email column heading.

 
[[File:M2TIImage88.png]]
 

Also, email can be deleted by toggling Email Details and pressing Delete button

 
[[File:M2TIImage72.png]]
 

== Manually assign Tariff Import Settings ==

It is possible to manually Assign Tariff Import Settings.
# Toggle Email Details
# Select Tariff Import Rules for specific attachment
# Press Assign Import settings

 
[[File:M2TIImage57.png]]
 

== Retry Rules mapping ==

If email with multiple attachments has attachments with no import rules it is possible to retry rules mapping. It's simple, press Retry Rules mapping.

 
[[File:M2TIImage33.png]]
 

Note: It’s not possible to Retry Rules mapping if all email attachments will have at least one import rule assigned to it.

== Attachment mapping status ==

Attachment mapping status(Status column in Emails list) indicates if Tariff Import Rules mapping was successful or not.

 
[[File:M2TIImage90.png]]
 

'''Import Rules Found''' - attachment was mapped successfully with at least one of the Tariff Import Rules.
'''Import Rules Not Found''' - attachment was not mapped to any of the Tariff Import Rules or there were no Tariff Import Rules to map.
'''Invalid Effective Date/Format for Tariff Import Rules''' - Invalid attachment date or it’s format compared to Tariff Import Rules settings. Numbers after status text represent Tariff Import Rules IDs.

== Email Example ==

Email can have one or multiple attachments. Every attachment will be processed individually. Attachment can have one or multiple Import Jobs which are dependent on the number of mapped Tariff Import Rules.

 
[[File:M2TIImage61.png]]
 

If there are multiple Tariff Jobs they will be shown as a toggle list. To toggle the list, simply press the arrow button next to Jobs list caption.

 
[[File:M2TIImage87.png]]
 

To see Job details click on any Import Job. Page will be redirected to the Tariff Jobs list.

 
[[File:M2TIImage62.png]]
 

= Examples =

== Rate upload from TATA ==

1. Analyze the tariff:
 
[[File:M2TIImage105.png]]
 

2. Create template for a tariff in BILLING → Tariff import → Import Rules → Templates
 
[[File:M2TIImage81.png]]
 

3. Select appropriate fields according to the tariff cells:
 
[[File:M2TIImage22.png]]
 

4. Create Rate Import Rules in BILLING → Tariff import → Import Rules → Rate Import Rules
 
[[File:M2TIImage54.png]]
 

5. Fill cells according your needs:
 
[[File:M2TIImage80.png]]
 

6. Create Tariff Import Rules in BILLING → Tariff import → Import Rules
 
[[File:M2TIImage14.png]]
 

7. Fill required cells:
 
[[File:M2TIImage111.png]]
 

8. Check the Inbox for a new email at Billing → Tariff Import → Inbox

9. Enter the mail, select Tariff Import Rules and press Assign Import Settings to continue the import:
 
[[File:M2TIImage18.png]]
 

10. Tariff job is created now, you can see it in BILLING → Tariff Import → Jobs
 
[[File:M2TIImage102.png]]
 

11. Job is now waiting for confirmation. You can view analysis before confirming:
 
[[File:M2TIImage45.png]]
 

12. Point to the line you want to analyze to see more information:
 
[[File:M2TIImage35.png]]
 

13. If you are satisfied, press confirm to finish the import procedure, otherwise cancel it.
 
[[File:M2TIImage1.png]]
 

14. If you pressed confirm, you will see that job was successfully confirmed:
 
[[File:M2TIImage77.png]]
 

15. Go back to Jobs page in BILLING → Tariff Import → Jobs to see status of the Job:
 
[[File:M2TIImage79.png]]
 

16. Tariff import is finished. As a target tariff in this example was “SUPPLIER PREMIUM”, you can verify rates checking page BILLING → Tariffs.
 
[[File:M2TIImage12.png]]
 

== Speedflow Tariff Import configuration ==

 
[[File:M2TIImage117.png]]
 

1. Create import template.
Go to BILLING > Tariff Import > Import Rules > Templates.
Click "ADD NEW TEMPLATE" at the top-right corner of the page.

Set "Name" to "speedflow". It can be any name, but "speedflow" will represent for which Provider tariffs this template is used.
Set "Rate Sheet" to "1", as this tariff files contains only one worksheet.
Set "Header Rows" to "22", as this tariff have 4 rows before actual rates data begins.
Set "Refix/Code" to column "A";
Set "Destination/Zone" to column "B";
Set "Effective Date" to column "E";
Set "Effective Date Format" to "%d.%m.%y";
Set "Rate" to column "C";
Set "Minimal Time" to column "E" and value "1";
Set "Increment" to column "E" and value "2";

 
[[File:M2TIImage76.png]]
 

Click "Create" to save changes.

2. Create Rate Import Rules
Go to BILLING > Tariff Import > Import Rules > Rate Import Rules
Click "ADD NEW RATE IMPORT RULES" at the top-right corner of the page.

This example shows how to create Rate Import Rule which will inform admin about new rates above 1.0 in price and will reject rates where price is equal to 0.

Set "Name" to "speedflow";
Set "Max Rate" to value "1.0" and action "Alert";
Set "Zero Rate" to action "Reject Rate".

 
[[File:M2TIImage23.png]]
 

Click "Create" to save changes.

3. Create Tariff Import Rules
Go to BILLING > Tariff Import > Import Rules
Click "ADD NEW TARIFF IMPORT RULES" at the top-right corner of the page.

Set fields like this:
"Name":"speedflow";
"Rate Import Rules":"speedflow";
"Target Tariff":"speedflow (EUR)". This is tariff assigned to speedflow Termination Point;
"Import Type":"Add/Update";
"Import Template":"speedflow";
"Effective Date":"Template - Inline"
"Mail From":"rates@speedflow.com". This is not actual email from which speedflow sends rates. Set correct email address from which you get tariffs.
"File Name":"%.xls"

 
[[File:M2TIImage58.png]]
 

Click "Create" to save changes

At this point the system is ready to receive email from speedflow.

5. Once email from speedflow is received you will see a new Tariff Job waiting for confirmation in Billing > Tariff Import > Jobs.

 
[[File:M2TIImage108.png]]
 

Click "ANALYSIS" to see rates to be imported. By default, the ANALYSIS page does not show new rates. Click "REFINE RESULTS", uncheck "Show Only Rejected" and click REFINE to see all received rates.

Click "CONFIRM" at the top-right corner of the page to proceed with import of rates.

 
[[File:M2TIImage89.png]]
 

In BILLING > Tariffs List, Tariff Import is completed and new Rates are now visible.

 
[[File:M2TIImage121.png]]
 

== Step by step example for VoiceTrading Tariff ==

1. Review VoiceTrading XLSX tariff structure

 
[[File:M2TIImage95.png]]
 

 
[[File:M2TIImage83.png]]
 

We can see that XLSX document consists of two Worksheets: Worksheet 1 (Rates) and Worksheet 2 (Numberplan).
2. Go to BILLING > Tariff Import > Import Rules > Templates to create a new Template

 
[[File:M2TIImage85.png]]
 

3. Configure Template for VoiceTrading XLSX structure

 
[[File:M2TIImage92.png]]
 

As you can see, there are two tabs in this page: Primary Data and Secondary Data. Do not confuse them with Worksheets, they are not related. Some Providers do not want to exceed a certain limit of rows in XLSX file, so data is placed in two regions on the same row(s). Let’s review screenshot below:

 
[[File:M2TIImage66.png]]
 

Green square corresponds to '''Primary Data''', while Blue square corresponds to '''Secondary Data'''. They both contain the same information: Destination name, Prefix and Rate.

Lets go step by step and configure a Template for '''Primary Data''':

 
[[File:M2TIImage4.png]]
 

'''Rate Sheet - 2'''. VoiceTrading XLSX file has two sheets, so set to 2
'''Header Rows - 0'''. VoiceTrading XLSX file has no header rows (data starts at 1st row)

 
[[File:M2TIImage3.png]]
 

'''Prefix/Code - B'''. Prefix is in Cell B for Primary Data.
'''Destination/Zone - A'''. Destination is in Cell A for Primary Data.
'''Connection Fee - Empty'''. There is no Connection Fee cell in VoiceTrading XLSX.

 
[[File:M2TIImage115.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage48.png]]
 

 
[[File:M2TIImage8.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage86.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates) and also A on Worksheet 2 (Numberplan). So we select '''A''' on 3rd and 4th Dropdown accordingly.

 
[[File:M2TIImage39.png]]
 

Effective Date Format for VoiceTrading is in YYY.MM.DD, so we select accordingly.

 
[[File:M2TIImage125.png]]
 

'''Rate - C'''. Prefix is in Cell C for Primary Data.
There are no '''Minimal Time''' and '''Increment''' cells in VoiceTrading XLSX.

Let’s configure '''Secondary Data''' now:

 
[[File:M2TIImage24.png]]
 

'''Rate Sheet''', '''Header Rows''' and '''Effective date''' will be the same as on Primary data.

 
[[File:M2TIImage25.png]]
 

'''Prefix/Code - F'''. Prefix is in Cell F for Secondary Data.
'''Destination/Zone - E'''. Destination is in Cell E for Secondary Data.
'''Connection Fee - Empty'''. There is no Connection Fee Cell in VoiceTrading XLSX.

 
[[File:M2TIImage30.png]]
 

To better understand Effective Date mapping, let’s review both Worksheets again:

 
[[File:M2TIImage27.png]]
 

 
[[File:M2TIImage53.png]]
 

 
[[File:M2TIImage119.png]]
 

Effective Date is on Worksheet 1 (Rates) and on Column D. So we select '''1''' and '''D''' on the first and second dropdown accordingly.

 
[[File:M2TIImage98.png]]
 

Now we need to map Worksheet 1 (Rates) where Effective Date is defined with Worksheet 2 (Numberplan), where Rates and Prefixes are defined. We can do this by Destination Column, which is A in Worksheet 1 (Rates) and E on Worksheet 2 (Numberplan). So we select '''A''' on 3rd dropdown and '''E''' on 4th dropdown accordingly.

 
[[File:M2TIImage109.png]]
 

Once configuration is complete, press CREATE button to create a new Template.

4. Go to BILLING > Tariff Import > Import Rules > Rate Import Rules to create Rate Import Rules

 
[[File:M2TIImage91.png]]
 

5. Configure Rate Import Rules according to your specifications

 
[[File:M2TIImage2.png]]
 

In this example we changed these values:
'''Max Increase''': 50%. If rate increase is higher than 50%, such rate will be automatically rejected.
'''Max Decrease''': 50%. If rate increase is higher than 50%, such rate will be automatically rejected.
'''Max Rate''': 1.99. If rate is higher than 1.99, such rate will be automatically rejected.

6. Go to BILLING > Tariff Import > Import Rules to create Tariff Import Rules

 
[[File:M2TIImage84.png]]
 

7. Configure Tariff Import Rules according to your specifications

 
[[File:M2TIImage99.png]]
 

The minimum what you should change from default:
'''Rate Import Rules''': set to Import Rules created in step 5.
'''Target Tariff''': set to Tariff you want to import rates to.
'''Import Template''': set to Template created and configured in step 3.
'''Email/Attachment Validation''': set to valid date for your Provider. Data in the screenshot is only an example and does not represent real values for VoiceTrading Provider.

8. Once email(s) will be received, you will see them in BILLING > Tariff Import > Inbox
If Tariff Import Rules have been correctly entered in the previous step, Import Job will be created automatically.

 
[[File:M2TIImage13.png]]
 

9. Click on the Import Job link. This will redirect you to the Tariff Jobs page.

 
[[File:M2TIImage123.png]]
 

Here we can see that Tariff Job is waiting for confirmation and that there are 1178 rates to be updated and 0 rejected rates.

10. Click on ANALYSIS link to view detailed analysis

 
[[File:M2TIImage74.png]]
 

By default, Tariff Job Analysis page shows only rejected Rates. There are no rejected rates in this case, so we can press CONFIRM button.

11. Go to BILLING > Tariff Import > Jobs to check Tariff Jobs status again. We can see that status is '''Imported'''.

12. Process is completed. Let’s go to Billing > Tariffs to confirm this

 
[[File:M2TIImage75.png]]
 

We can see that 1178 rates have been imported to Tariff '''Supplier VoiceTrading'''.