Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This article describes how to setup UDR Rate Groups, UDR Rates and UDR Rate Plans. For an overview of UDR Rating and what these terms mean please review Usage Rating Overview.

UDR Rate Groups

The first step in the configuration of your rate structure is to define UDR Rate Groups.  Once complete individual rates can then be created and assigned to their respective Rate Group.

...

  1. In the AdminPortal click on Setup

  2. Click on UDR Rate Groups

  3. On the UDR Rate Groups page click the Add button on the right side of the window

  4. The Add window will load

    • Name - the name given to the rate group

    • Display Name - this is an optional field. The system will display the value entered here on customer invoices. Use this field if you would like to display a more end-user friendly version of the Rate Group name

    • Start - represents the date on which this rate group will become active

    • Use for Cost - indicates that the Rates in this group will be setup as 'cost' rates. Cost Rate Groups are referenced by Rates that are configured with a Rate Type of 'Markup'. For example if a Long Distance Rate with a 'Markup' Rate Type exists then when rating executes the charge for this Rate will be determined by first looking for a 'Use For Cost' Rate Group within the Rate Plan and then if the cost group exists, looking for a Long Distance UDR Class Rate in the Use For Cost Group. The 'Use For Cost' Long Distance Rate Amount that is found will be the cost value that is Marked up

      • Example Scenario:

        • A Rate is configured with a Class of 'Long Distance', Rate Type of 'Rated Markup' and amount of fifty cents a minute (0.50/m)

        • During rating a Markup Rate is found triggering a check for a 'Use For Cost' Rate Group in the Rate Plan

        • If the 'Use For Cost' Rate Group in the Rate Plan includes a Long Distance Class UDR Rate with an amount value of ten cents a minute (0.10/m), the Rated Markup would result in a charge of sixty cents a minute (ten cents cost + fifty cents rated markup)

        • If the Use For Cost Rate Group does not contain a Long Distance UDR Class Rate, or the Rate Plan is not setup with a Use For Cost Rate Group then a UDR Exception will occur

    • Time Period - driven from the Time Periods configuration (Setup > Time Periods), allows you to select a preconfigured time period (e.g. peak hours, evenings/weekends, etc.) to association with this rate group. Once set, rates in the rate group will only be used if the usage occurs in the specified time period. If a group is configured to a specific time period other rate groups will need to be setup in the same rate plan to provide the rates that are applicable outside of the time period (otherwise usage will fail to rate and UDR Exceptions will be generated)

    • Currency - the currency to be used with this rate group

    • Conditions - allows you to apply conditional elements which instruct the system to preform additional checks when using this rate group (more on this below)

  5. Fill in the fields as desired

  6. To quickly produce additional UDR Groups see the "Adding Rate Groups Using Cloning" section below.

...

  • Click on Setup

  • Under the heading Rating and Usage click on UDR Rate Plans

  • On the UDR Rate Plans page that loads click the Add button on the right hand side of the page

  • Enter a name for the rate plan (for instance "RetailRatePlan") 

    • Name - enter a value for the Rate Plan’s name

    • Display Name - value entered in this field will be displayed on the customer’s invoice and reports

    • Amount Precision - specifies the number of digits to round the amount to after the decimal place. The default is four decimal places but some organizations may choose to round up to two decimal places, in which case you would enter '2' in this field. This rounding occurs during rating. As of EngageIP 8.5.26.5 you can specify the maximum and default amount precision that rate plans will use by setting the UDRAmountPrecision value on the Configuration page. The Rounding behavior you observe will depend on your EngageIP version and setup, specifically:

      • If the Amount Precision field on the Rate Plan is left empty the result will be midpoint rounded. Meaning round up at a value of 5 or more and down at a value of 4 or less (an amount of 0.00015 becomes 0.0002 and an amount of 0.00014 becomes 0.0001). The Amount Precision field could be left empty in older versions of EngageIP, but after EngageIP 8.5.26.5 an amount precision value must be selected on rate plans

      • If the Amount Precision has a value specified the result will be 'roundup' rounding behavior (in a scenario with Amount Precision set to '2' on a rate plan and an amount of 0.051, the amount will roundup to 0.06)

      • If the EngageIP option 'UDRRatePlanPrecisionDoRoundTo' (introduced in EngageIP 8.5.26.5) is set to true then midpoint rounding will be enabled. If you need to enable this option please contact LogiSense support for assistance

  • Click the Save button when finished

...

Assumption: you have You have already created your package and it includes at least one service within EngageIP which UDR Rate Plans will be added to. If this has not been done please create your packages first (see: the Package and Service Setup article)

Now that you have your Packages and UDR Rate Plans setup and configured you can now link them together so that when a customer signs up for a package the appropriate UDR Rate Plan will be added to their account as well.

...