This documentation relates to an earlier version of JeraSoft VCS.
View User Guide 3.21 or visit our current documentation home page.
Skip to end of metadata
Go to start of metadata
In this article

Section overview

The Swap Deals section has been created since version 3.20 of the JeraSoft Billing. Its purpose is to comprise all the bilateral agreements for further monitoring and analysisThe section is presented as a table like the one below:

Screenshot: Swap Deals section

Column NameDescription
IDID of the Swap Deal
Alert

This column is showing whether the Swap Deal goes as planned. If the current traffic speed is insufficient to close the deal as planned, there will be a  icon to let you know. 

NameName of the Swap Deal
Status

The deal's status. It can one of the following:

  • pending - the Swap Deal's start day is in the future
  • in process - meaning the Swap Deal is in process of completing
  • archive - inactive Swap Deal
  • success - the result status after the success deal's completion
  • fail - the result status after the failed deal's completion
PeriodPeriod of the Swap Deal
Forecast DateThe forecasted date of the Swap Deal completion with the current speed
Live ProfitThe sum of inbound and outbound live revenue
ProgressThe progress bar for the Swap Deal, shows the percentage of completion
ClientThe Client's name and its Account, with whom the deal was agreed

Functional buttons and icons presented in the section are as follows:

Button/IconDescription

Allows adding a new Swap Deal to the system

Allows editing a Swap Deal
Allows deleting a Swap Deal from the system

Adding a New Swap Deal

To add a new swap deal, click the Add Swap Deal button and define the respective values in a pop-up window: 

Screenshot: Adding a New Swap Deal


FieldDescription
GeneralNameDefine the name for a Swap Deal
Status

Specify a Swap Deal status. There are two options:

  • active
  • archive
Currency

Specify a Swap Deal currency

Client

Select the Client for the current Swap Deal

Note that the Client and Account fields are mutually exclusive.

AccountSelect an Account for the current Swap Deal
Period SettingsPeriodIndicate a period in days or months for this Swap Deal
Start DateIndicate a start date for this Swap Deal

Items List tab

There are certain Items inside of the Swap Deal entity, which are the agreements on traffic volumes and pricing per destination. The Items are in the Items List tab of the current Swap Deal. This tab looks like this:

Screenshot: Items List tab

FieldDescription
General

Client

Displays the Client and its Account, with whom the deal was agreed upon
PeriodShows the period for the current Swap Deal
Update TimeLast time the system renewed information for this Swap Deal according to current statistics
StatusDisplays the current Swap Deal status
ProfitPlannedThe sum of inbound and outbound planned revenue
LiveThe sum of inbound and outbound live revenue
Sales

Shows profit according to current statistics and sales rates

Counted like

sales profit = inbound sales revenue + outbound sales revenue

where inbound sales revenue is a sum of all inbound items' sales revenue, and outbound sales revenue is a sum of outbound respectively

Margin

Indicates the Swap Deal efficiency

Counted like

margin = live profit - sales profit

Inbound

Planned

Planned inbound revenue based on Swap Deal volume and price
LiveCurrent inbound revenue according to the statistics within the Swap Deal
ForecastForecasted end date with current speed (concerning inbound traffic)
ProgressProgress bar based on current inbound traffic
OutboundPlannedPlanned outbound revenue based on Swap Deal volume and price
LiveCurrent outbound revenue according to the statistics within the Swap Deal
ForecastForecasted end date with current speed (concerning outbound traffic)
ProgressProgress bar based on current outbound traffic
ItemsIDID of the Item
Direction

Item's direction:

  •  for inbound traffic;
  •  for outbound traffic.
DestinationDst Code or Code Name
RateIndicates the Swap Deal rate (first) and average sales rate (second) for the destination
Volume, minShows how much traffic from the planned amount is currently within the Swap Deal (Live Volume | Planned Volume)
RevenueShows how much you earned on a specific destination within the Swap Deal from the planned amount (Live Revenue | Planned Revenue)
Sales Revenue

Shows how much you would have earned on a specific destination without a Swap Deal agreement

Counted like

sales revenue = live volume * sales rate

Alert

Shows whether the Item's progress goes as planned. If the current traffic speed is insufficient to close the deal as planned, there will be a  icon. 

Run Rate, minCurrent speed of filling out the Swap Deal as per this Item (the first is the actual Run Rate, the second is the Required Run Rate)
Progress, %Item's progress

Edit Swap Deal tab

To edit the Swap Deal details, there is an Edit Swap Deal tab available. It has the following outlook:

Screenshot: Edit Swap Deal tab

Adding a New Item

To add a new item to the swap deal, click the button in the Items List tab and define the respective values in a pop-up window: 

Screenshot: Adding a New Item

FieldDescription
GeneralDirection

Specify the traffic direction:

  • Inbound
  • Outbound
VolumeIndicate an expected volume for the swap deal item.
Code

Indicate a code of the item.

Note that the Code and Code Name fields are mutually exclusive.

Code NameIndicate a code name of the item.
RatingRateIndicate a rate that you agreed upon with your partner.
Sales RateSpecify an average rate that would be applied if not for the swap deal.
ServiceSelect a service for this swap deal (calls, SMS, data).

Swap Deals' in-system functioning

Swap Deals work within the billing system using the information on rates and current statistics. There is a separate service in System → Task Scheduler section - Swap Deals Manager. This service updates each Swap Deal's statistics maximum once per hour. It monitors the current statistics and updates the Swap Deal information putting a timestamp of the latest changes to the Update Time field in the General section of an Items List tab.

If the Swap Deals Manager detects during its analysis that any item in a swap deal is performing not as expected, it will generate an alert to System → Events Log. Such alerts are sent at a frequency of maximum once in 4 hours. Apart from that, you will see an alert  icon in the Swap Deals section of the web interface.

From Events Log, you can configure it so that Swap Deals alerts will be sent to your mailbox upon occurrence. Learn more about how to set this up here

  • No labels