Docs for all releases
Page History
...
The tab is designed to provide a user with a possibility to import rates to VCS JeraSoft Billing by uploading a .csv or .xls file. The whole process can be divided into the following stepsseveral steps discussed below. You can access the rates import by clicking the Import button in the Rates section. The button will only be active when you filter the rates by the rate table:
Screenshot: Import tabbutton
Step 1. Selecting a File and Specifying Additional Parameters
First, The first thing you need to select a file for importdo in the import configurations view is to select a rate table (the import template will autocomplete if existent). Then, drag-and-drop or upload an import file. Additionally, you can specify the following parameters:
Screenshot: Step 1. File Settings
Field | Description | |
---|---|---|
Import Template | Select a target template for rates importing | |
Delimiter | Specify a delimiter symbol here. Possible options are:
By default, the autodetect option is selected. | |
Auto Confirm | Select whether the system must confirm imported rates automatically or not | |
Rate Table | This field will be autocompleted with the name of a rate table if the rates are filtered in the Rates section. If not applicable, select a target rate table | |
Import Template | Select a target template for rates importing if available |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Panel | ||||||||
| ||||||||
Warning
|
...
The system will recognize the file and display first and last 5 rows of the first sheet. To switch from one sheet with rates to another, click on a respective tab: You will need to select the start and end lines of an import table (marked green). The middle lines are skipped, you can unfold them both ways by five lines by clicking the respective buttons. To switch from one sheet with rates to another, click on a respective tab: i.e., Sheet 1, Sheet 2, etc.
Screenshot: Step 2. Import Settings
Starting fromStarting from VCS 3.17.0, the user has a possibility to specify a type for each sheet of an imported file. Each sheet type has its own list of columns.Currently, there are 3 sheet types:
- Rates type - an equivalent to an importing page from earlier versions. While importing, at least 1 sheet must be of Rates type. For this type, the following columns are mandatory:
- Dst Code/Code Name - indicate at least one of them
- Rate
- Effective Date - if you don't indicate this column, the Effective Date, specified in the Code Rules information block, will be applied to imported rates.
- Src Codes type - this type allows a user to perform the import to the code deck attached to the rate table. For this, indicate source codes/code names and has in the two columns: Src Code and Src Code Name. If selected, both columns must be specified.
- Dst Codes type - this type allows a user to perform the import to the code deck attached to the rate table. For this, indicate destination codes/code names and has two in the two columns:Dst Code Code andDst Code Code Name. If selected, both columns must be specified.
Starting from JeraSoft Billing v3.18.0, the user has an option to select the Skip this sheet option for the system to ignore respective sheet during import. More about sheet types configuration here.
Screenshot: Sheet types
On the second step, you can also save the importing rate table as a template for further usage during import. To do so, specify a template
...
title in the bottom left corner of the tab,
...
and click the Save Template button
...
(see screenshot above).
To open advanced configurations, click on a grey downwards arrow icon next to the to Step 2: Import Settings. Advanced settings contain the following fields:
Screenshot: Step 2. Import SettingsAdvanced settings
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
On Duplicates | Determines billing behavior if it finds a rate row duplicate. Duplicates are checked by Code + Effective Date pair of columns.
| ||||||||||||
On Errors | Determines billing behavior if an inconsistency or error was found in the importing file (data inconsistency, incorrect symbols, etc.)
| ||||||||||||
Date Datetime Format | Specify the date format of an imported file. Please note, the auto-detection of date and time can be performed with files that contain one of the date and time formats, listed below:
| ||||||||||||
Custom Format | If defined, this format will be used for date parsing instead of the Date Format field | Optimize Codes |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Tip Therefore, when you make an import with the Optimize codes option enabled and your importing file consists of code 440 and code range 4400-4409 at the same time, the import result will depend on the On duplicate rates settings. |
Billing Increment defines the way events are billed and combines two parameters: minimum volume and tariffication interval or three parameters: minimum volume,tariffication interval and grace volume. Indicate the order of parameters recognition in the Billing Increment column:
- Min Volume/Interval
- Interval/Min Volume
- Min Volume/Interval/Grace Volume
- Interval/Min Volume/Grace Volume
For example, if the Billing Increment column in your import file is 1, 5, and you selected Min Volume/Intervalvalue in this field, the system will recognize 1 as Minimum Volume and 5 as a Tariffication Interval for a target rate.
Select whether a dash in codes must be skipped or not:
- Enabled - codes, written as 1201-1205, will be imported as a single 12011205 code
- Disabled- 1201-1205 codes will be imported as separate 1201, 1202, 1203, 1204, 1205 codes
This option is used only in case source code names contain an underscore symbol. Choose one of the following:
- Disabled - if an Src Code Name is, for instance, USA_Columbia, it will be preserved as it is after import.
- By underscore - if selected, a USA_Columbia Code Name will be changed to Columbia after import.
Select the way you want both Src and Dst code decks to be updated with new/existing code names from current rates file:
- Disabled - leave selected code decks unchanged
- Import only not existing codes - code decks will be updated with codes and their names if they are missing
- Import all codes (update existing) - сode decks and codes will be updated with code names taken from a file, overwriting of existing ones
- Import all codes (purge code deck first) - code decks are fully cleared and then all codes and code names are imported from a file
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
If Src Code and/or Dst Code sheet type is selected, you need to enable this feature |
- Min Volume/Interval
- Interval/Min Volume
- Min Volume/Interval/Grace Volume
- Interval/Min Volume/Grace Volume
Select whether a dash in codes must be skipped or not:
This option is used only in case source code names contain an underscore symbol. Choose one of the following:
- Disabled - if an Src Code Name is, for instance, USA_Columbia, it will be preserved as it is after import.
- By underscore - if selected, a USA_Columbia Code Name will be changed to Columbia after import.
Select the way you want both Src and Dst code decks to be updated with new/existing code names from current rates file:
- Disabled - leave selected code decks unchanged
- Import only not existing codes - code decks will be updated with codes and their names if they are missing
- Import all codes (update existing) - сode decks and codes will be updated with code names taken from a file, overwriting of existing ones
- Import all codes (purge code deck first) - code decks are fully cleared and then all codes and code names are imported from a file
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Attention If Src Code and/or Dst Code sheet type are selected, you need to enable this feature |
A special mode that determines system behavior regarding active/future rates:
- Disabled- leave active/future rates unchanged. Selected by default.
- Simple mode - active rates from a current Rate Table will be closed on the specified AZ close date if they aren't present in this import.
- Extended mode - all existing future rates will be marked as stashed. Currently, active rates (not presented in this import) will be closed by the date specified below.
A special mode that determines system behavior regarding active/future rates:
Disabled- leave active/future rates unchanged. Selected by default.Available if A-Z AZ Mode is active. It consists of two fields, where time and date of rates closure are specified:
- Time - select from a drop-down list:
- Beginning of the day - active/future rates will be closed at 00:00 of the specified day
- Import time - active/future rates will be closed at the exact time of import on the specified day
Day - specify the interval of days after which rates will be closed
Specify the period for AZ mode to close rates. The selectable options are:
- days from last midnight - the rates will be closed after the specified amount of days from the midnight of the import day
- days from now - the rates will be closed after the specified amount of days from the import day
- hours from XX:00 - the rates will be closed after the specified amount of hours from the start of an hour of the import timestamp
- hours from now - the rates will be closed after the specified amount of hours from the import timestamp
Panelpanel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Tip For a detailed explanation, check out our Knowledge Base article |
Code Rules Information Block
For adding a new code rule, click on the plus icon next to the information block name.
When you add a rule and set the value in the fields, it will overwrite parameters specified in the respective columns of the file. If you leave fields empty, it will take the parameters from the file.
If you a add a rule with * code for a certain service, not specified columns of the imported rates will be filled in with the respective field values of this code rule. You can add rules with a * code for all services. The list of code rules fields is as follows:
Screenshot: Rates import - Code Rules settings
...
Additional parameters are stored under the downwards arrow icon.
...
Agreements Tolerance, (days) | Define a number of days that the system will take into account while analyzing the new import and the current agreement with the vendor. If the dates of an agreement and the import are closer then the specified amount, the system will generate an alert for the manager. | |
Changes Threshold, (rates) | Define a number of changed rates that will serve as a threshold for the selected rate table. If exceeded, the system will generate an alert for the manager. | |
Deviation Tolerance, (%) | Define the value of how much can an imported rate differ from an existing one in percent. If exceeded, the system will generate an alert for the manager. |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
If you have rates with missing Rate value in the importing file, the system will find the previous rate for the same destination and take this value from there. Also, when you have rates with missing Effective Date value, the system will take it from the End Date value. |
Code Rules Information Block
For adding a new code rule, click on the plus icon next to the information block name.
When you add a rule and set the value in the fields, it will overwrite parameters specified in the respective columns of the file. If you leave fields empty, it will take the parameters from the file.
If you add a rule with a * code for a certain service, not specified columns of the imported rates will be filled in with the respective field values of this code rule. You can add rules with a * code for all services. The list of code rules fields is as follows:
Screenshot: Rates import - Code Rules settings
Field | Description | |
---|---|---|
Code | Indicate a destination code. For all codes, use * (asterisk) | |
Status | Indicate a status for the rates. By default, it will be Active. Set the Stashed status if you want to double-check them later after import. | |
Effective Date | Specify a start date of a rate. There are various options to schedule this date:
| |
Time Profile | Indicate time profile that will be used for a current rate, for example, business time, non-business time, weekends, etc. | |
Min | Minimal time of the call that will be tariffed. For example, if the total call time was 20 seconds and Min is 30, the client will pay for 30 seconds of the call. | |
Int | Tariffication interval. This parameter is used, when Min Time time expires. | |
Extra | Additional parameters are stored under the downwards arrow icon.
|
After specifying all additional parameters, click the Import button.
Step 3. Import Errors
Provided a non-critical error(s) occurred, you will see a table, where exact sheet, line and error description are specified (see screenshot). In this case, you need to start the whole import procedure from the beginning.
Screenshot: Step 3. Import Errors
In case numerous errors occurred while importing rates, you will be displayed the respective notification:
Screenshot: Error notification
By clicking on Download file, a .csv file with the following columns will be downloaded:
Column | Description | |
---|---|---|
Sheet | Index number of the sheet, where an error occurred | |
Line | Line of the sheet, where an error occurred | |
Errors | Description of the error that occurred |
Screenshot: .csv file with detailed error data
Confirming Rates
When the procedure has been executed, you will be forwarded to the Rates section where all imported rates will be displayed. If the Auto-Confirm option was disabled during the import process, you need to Mass Edit the rates' status from stashed to active.
Screenshot: Confirming Rates
Import History Tab
The tab contains information about all executed imports to this rate table. You can access it in the Rate Tables → {Specific Rate Table} → Import History. It is presented in the form of a table with the following columns:
Screenshot: Import History output
Column | Description | |
---|---|---|
Date | Time and date of import execution | |
User Login | Login of a user who executed the import | |
File | Import file. By clicking on the icon, the file will be downloaded | |
Total | Total amount of imported rates | |
New | Total amount of rates with New type | |
Increased | Total amount of rates with Increased type | |
Decreased | Total amount of rates with Decreased type | |
Unchanged | Total amount of rates with Unchanged type | |
A-Z Closed | Number of rates, closed by A-Z import | |
A-Z Stashed | Number of rates, stashed by A-Z import | |
Status | Status of import procedure (success/failed) | |
Error File | File that contains a description of all errors occurred during import. By clicking on the icon, the file will be downloaded | |
icon | When clicked on, deletes respective import data from the system |
The imported rates are divided into the following types: Unchanged, Increased, Decreased, New. By clicking on the respective numbers of rates, you can see filtered rates by type (see screenshot above) in the Rates section.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Imported rates will be marked as Unchanged, Increased, or Decreased only if their Effective Date value (e.g., 04.25.2018) is higher than Effective Date of a current rate (e.g., 04.10.2018) and they don't have an End Date value. If the End Date value is present in a previous rate, the fresh one will be marked as New. |
...
After specifying all additional parameters, click the Import button.
Step 3. Import Errors
Provided a non-critical error(s) occurred, you will see a table, where exact sheet, line and error description are specified (see screenshot). In this case, you need to start the whole import procedure from the beginning.
Screenshot: Step 3. Import Errors
In case numerous errors occurred while importing rates, you will be displayed the respective notification:
Screenshot: Error notification
By clicking on Download file, a .csv file with the following columns will be downloaded:
...
...
...
...
Screenshot: .csv file with detailed error data
Confirming Rates
When the procedure has been executed, you will be forwarded to the Rates tab where all imported rates will be displayed. They are divided into the following types: Unchanged, Increased, Decreased, New. By clicking on the respective buttons in the top right corner of the tab, you can filter rates by type (see screenshot).
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Attention Imported rates will be marked as Unchanged, Increased, or Decreased only if their Effective Date value (e.g., 04.25.2018) is higher than Effective Date of a current rate (e.g., 04.10.2018) |
If Auto-Confirm option is disabled, you need to click the Confirm Filtered Rates button (see screenshot) to change rates status from stashed to active.
Screenshot: Confirming Rates
Import History Tab
The tab contains information about all executed imports to this rate table. It is presented in a form of table with the following columns:
Screenshot: Import History tab
...
...
...
...
Import file. By clicking on the icon, the file will be downloaded
...
File that contains description of all errors occurred during import. By clicking on the icon, the file will be downloaded
...
icon
...