The Prorata Operator calculates the product Y = X * R, in which: The Prorata Operator calculates the product Y = X * R, in which:
Y is the numerical result
X is a numerical value
R is a ratio ranging from 0 to 1 (R is a decimal number; for example, 0.45)
As shown in the next illustration, the Prorata Operator calculates R = (tr - ti) / (tf - ti) as the ratio of two time periods:
tf - ti: Time period that is delimited by the initial time ti and the final time tf. The condition ti < tf is always true.
tr - ti: Part of the time period tf - ti that is delimited by the initial time ti and the reference time tr. The condition ti <= tr <= tf is always true.
|
Important: Keep in mind that tf - ti is a cycle defined by one of the following frequencies:
|
|
Note: Instead of calculating R = (tr - ti) / (tf - ti), the Prorata Operator can calculate the ratio R = (tf - tr) / (tf - ti) as shown in the next illustration. |
If you propose some services that include a monthly calling plan, you may want to adjust a new client’s plan for the first month according to the subscription date of the contract. Likewise, you may want to adjust the plan for the last month when the plan is based on the cancellation date of the contract. In both cases, you use the Prorata component to calculate the calling plan.
A customer signs a contract on the 10th of the month for a service that includes two free hours per month. Because the customer signed on the 10th of the month, you want to prorate two free hours from the 10th to the end of the month. The following table presents the information that you need to set up the Prorata component:
|
Data |
Name of Properties/Settings |
Comment |
|
Property to prorate |
Number of free hours |
In the product Y = X * R, the numerical value X is Number of free hours (two hours). |
|
Generated Property |
Number of free hours during the first month |
The generated property contains the resulting amount Y = X * R. |
|
Prorata Date |
Charge effective date |
In the product Y = X * (tf - tr) / (tf - ti), the reference time tr is the Charge effective date (the 10th of the month). |
|
Time period |
Every month |
In the product Y = X * (tf - tr) / (tf - ti), the initial time ti is the first of the month at 12:00 AM and the final time tf is the last day of the month. |
|
Type of ratio |
Calculation according to the Fraction from prorata date option |
The Fraction from prorata date option calculates R = (tf - tr) / (tf - ti). |
Name: Type the name of the component (mandatory).
Description: Allows you to type the description of the component (optional).
Property to prorate: Provides the list of numerical properties. Select the property that represents the numerical value X of the product Y = X * R.
Generated Property Name: Allows you to type the name of the new property that retrieves the numerical result of Y = X * R.
Reference period: Allows you to set up the time period tf - ti and the initial time ti. To set up the time period tf - ti, this area provides you with a list of frequencies (Every, Every other, Every 3nd, and other items) associated with the following list: day, week, month, and year. For example, you can choose a time period of two months by selecting Every other month, or you can choose a time period of one day by selecting Every day.
|
Note: The Reference Date is used ONLY if you select either or both of the options The same day as the reference date and The same time as the reference date. Instead of the Reference Date, you can use the other options. |
Once you have selected a frequency or time period, you can select the initial time ti:
Reference Date: Provides the list of date properties. Select the property that represents the initial time ti.
The same day as the reference date: If you click this option, the initial time ti is the date selected in the Reference Date field. Example: you have selected the Charge Effective Date. If you select Every month, the time period tf - ti is one month and the initial time ti starts at the Charge Effective Date.
the: If you have selected the frequency Every (3rd, 4th, and so on) month or year, this option allows you to select the initial time ti as a day of the month. This option is combined with a list of numbers (from 1 to 31), a list of items such as Last day, First, Second, Third and Fourth and the list of weekdays and months. Example: selecting Every 5th month The 11 of the month at 04:00 PM means that the time period tf - ti is five months and that the initial time ti starts the 11 of the month at 04:00 PM.
on: If you have selected the frequency Every (3rd, 4th, and so on) week or year, this option allows you to select the initial time ti as a day of the week or the month. This option is combined with a list of numbers (from 1 to 31) and months and a list of weekdays. Example: selecting Every 4th week on Wednesday at 02:00 AM means that the time period tf - ti is four weeks and that the initial time ti starts on Wednesday at 02:00 PM.
at: Allows you to select the starting hour of the initial time ti if you have selected any of the previous options. This option includes hours and minutes combined with AM (ante meridiem) or PM (post meridiem). Example: selecting Every day at 07:25 PM means that the time period tf - ti is one day and that the initial time ti starts at 07:25 PM. You can select The same time as the reference date that is the date selected in the Reference Date field. Example: if you select the Charge Effective Date, the initial time of the time period tf - ti is that of the Charge Effective Date.
Fraction of the reference period to prorate: Allows you to select the reference time tr and the type of ratio to calculate: R = (tr - ti) / (tf - ti) or R = (tf - tr) / (tf - ti).
Prorata date: Provides the list of numerical properties. Select the reference time tr.
Fraction up to prorata date: Calculates the ratio R = (tr - ti) / (tf - ti)
Fraction from prorata date: Calculates the ratio R = (tf - tr) / (tf - ti)
You set up the parameters for making the calculation.
Time Unit: Provides the list of time units to calculate the total part of the ratio R. The default option is seconds. Select one of the following units:
seconds
minutes
hours
days
Rounding Mode: Provides the list of modes for rounding the decimal portion of the ratio R. The default option is To the next greater value. Select one of the following rounding modes:
To the next greater value
To the previous value
To the nearest value
Rounding Step: Allows you to type a step rule for rounding the ratio R, or allows you to select a numerical property that represents this step rule. The default option is 1. Example: If the rounding step value is 5 seconds and the rounding mode is To the next greater value, a period of tima of 47 seconds is rounded to 50 seconds. In this example, the rounding step consists of 5-second intervals.
Use typical period of: If selected, this option allows you to turn a variable period into a constant period. Once you have selected the Use typical period of option, you can either select the value of a property or select Numerical Value, and then type a number. For example, to turn each month into a constant period of 30 days, click Use typical period of, select Numerical Value in the list, and then type 30. If you clear Use typical period of, the reference period is 28 days in February, 31 days in January, and so on.