What's New in Rating Engine

CBRE-517 When shifting a plan to Rating Engine, the system attempted to shift terminated subscriptions instead of marking them as completed.
CBRE-529 When processing a partial upgrade order, Rating Engine could recalculate charges for previous billing periods of the subscriptions in that order.

Requirements

BSS 21.8 or later.

Rating Engine 1.31.3944 (October 31, 2024)

This is a patch release that contains internal improvements only.

Requirements

BSS 21.8 or later.

Rating Engine 1.31.3834 (October 18, 2024)

Fixes

CBRE-607 It could take significant time to load the Shift to Rating Engine screen on the installations with a large number of plans.

Requirements

BSS 21.8 or later.

Rating Engine 1.31.3833 (October 16, 2024)

Fixes

CBRE-535 When placing a product to cart in UX1, the request to estimate the product price could take significant time to complete or even fail.

Requirements

BSS 21.8 or later.

Rating Engine 1.31.3831 (August 30, 2024)

Fixes

CBRE-343 Rating an order could fail with error: Can't sort offer chain - some offers are out of chain.
CBRE-342 Billing orders could get stuck in the Cost Rating status.

Requirements

BSS 21.8 or later.

Rating Engine 1.30.3743 (May 30, 2024)

This is a patch release that contains internal component improvements only.

Requirements

BSS 21.8 or later.

Rating Engine 1.30.3730 (May 16, 2024)

Features

CBPFR-109 To increase stability of shifting subscriptions to Rating Engine, multiple improvements were made in Rating Engine:

When a migration order is generated, all the necessary information is taken from the subscription, not its history.
Co-termed subscriptions can now be shifted to Rating Engine.
The plan pre-check is now also run for subscriptions in REVENUE_ONLY mode.
Additional checks were added to the pre-check for shifting to Rating Engine procedure:
- The subscription period must include an integer number of billing periods.
- The subscription's expiration date must not be manually changed.

Fixes

CBRE-228 A change order for a migrated subscription could fail if placed on the migration day.
CBRE-15 Purchasing a subscription with only a one-time fee could fail on the installations with Price Manager.

Requirements

BSS 21.8 or later.

Rating Engine 1.29.3686 (March 18, 2024)

Features

PFR-6756 Migration orders can now be used to migrate subscriptions whose start and expiration date are not aligned: subscriptions that are co-termed and those whose plan changed. To migrate such subscriptions to CloudBlue, use the specialCase attribute when placing a migration order. This parameter can have the following values:
- NOT_SPECIFIED. Use this value, or omit the parameter for subscriptions that have start and expiration date aligned.
- COTERMING. Use this parameter for co-termed subscriptions.
- PLAN_CHANGE. Use this parameter for subscriptions that have their plan changed in the current subscription period.
When migrating a subscription that is co-termed, or has plan changed in the current subscription period, you also need to specify the start date of the current subscription period using the periodStartDate attribute.

Fixes

RE-3787 Sometimes, when shifting subscriptions with billing model Use External Rating to Rating Engine, dry run fails with the error: Undefined order type 'MIGRATION'.
RE-2709 If a resource was added to a subscription after its renewal, Rating Engine did not create charges for that resource's recurring fee.
RE-4043 Billing and renewal orders could fail for subscriptions with billing model Use External Rating.
RE-3214 After transferring a customer to another reseller, the next billing order for the customer's subscription could fail if it included a minimum-commitment resource with a non-zero recurring fee.
RE-3630 Upsizing of a subscription created during partial upgrade could not be completed.
RE-3642 Shift to rating engine failed for subscriptions with the expiration date set manually.
RE-4173 No correction order was issued if a special price was applied to a subscription on the billing order creation date.
RE-4284 Price effective date was not taken into account if a subscription was renewed after expiration.

Requirements

BSS 21.8 or later.

Other microservices required for specific scenarios

To be able to migrate subscriptions with non-aligned start and expiration dates, the following component is required:

BSS 21.15.189 or later.

Rating Engine 1.28.3653 (February 13, 2024)

This is a patch release.

Fixes

RE-4226 Incorrect prices could be displayed when placing a change order for Adobe 3-year commit consumable subscriptions.

Rating Engine 1.28.3652 (February 13, 2024)

This is a patch release.

Fixes

RE-4082 Change orders could have incorrect order details and the detail start date.
RE-4211 The subscription recurring fee could be not charged if a subscription renewal order was placed before a change order for the subscription upsize.

Rating Engine 1.28.3651 (February 13, 2024)

This is a patch release that contains internal component improvements only.

Rating Engine 1.28.3650 (February 9, 2024)

Features

PFR-6463, PFR-6391 Support for Adobe 3-year commit discount was added.

Requirements

BSS 21.8 or later.

Other microservices required for specific scenarios

To enable Adobe 3-year commitment support, the following is required:

Components
- BSS 21.15.246 or later.
- Product Lifecycle Management 2.1.1164 or later.
- UX1 Marketplace 8.0.2189 or later.
- Rating Engine 1.28.3650 or later.
- UX1 Subscription Management 5.7.1735 or later.
- UI and Branding 21.15.112 or later.
Product

Adobe VIP Marketplace Connect Product version 60 or higher.
Product Connector

Adobe VIP Marketplace Connector version 5.2.12 or higher.

Rating Engine 1.27.3605 (January 11, 2024)

This is a patch release.

Fixes

RE-4072 The ActualEndDate parameter was always set in the UTC timezone.
RE-4062 Orders for subscriptions based on plans with the Use external rating billing model failed with the error "ERC_021 :: Charges are not expected for Externally Rated billing model".
RE-4063 Usage files failed to process with the "Report Rating Failed..." error in the UI for Rating Engine version 1.27.3599 installed with Usage Collector version 1.10.1310.

Rating Engine 1.27.3603 (December 15, 2023)

This is a patch release that contains internal component improvements only.

Rating Engine 1.27.3601 (December 6, 2023)

This is a patch release.

Fixes

RE-3901 Rating Engine could incorrectly handle setup and plan fees during partial upgrade.

Rating Engine 1.27.3600 (November 28, 2023)

This is a patch release.

Fixes

RE-3847 Dry run of a shift to Rating Engine procedure could fail with error: Expiration date for subscription was changed manually.

Requirements

BSS 21.8 or later.

Rating Engine 1.27.3599 (November 20, 2023)

Features

PFR-6823 Rating Engine functionality has been redesigned for the subscriptions based on plans that have setup fees configured.

The setup fee is now charged when the resource quantity is increased, that is, when a subscription is upsized, switched to a new plan with a resource upsize, or switched to another subscription period with a resource upsize.

The setup fee is not refunded during a resource standalone downsize or downsize with a plan switch, except for the cases:
- This is a cancellation (CL order) of the initially purchased subscription plan (the subscription was not switched to a new plan or transferred). In this case, the cancellation policy will be applied (setup fees will be refunded within the full refund period).
- This is a standalone downsize of the resource quantity to zero - the resource will be considered as canceled and the cancellation policy will be applied (setup fees will be refunded within the full refund period).

Fixes

RE-2459 Vendor contract IDs could be missing for cancellation orders.
RE-2586 Subscriptions could not be upsized after they were switched to another plan with a resource downsize.
RE-2957 An account transfer failed with the error "BPR_006 :: No Fees found in BSS DB" if an account subscription failed to switch to another plan.
RE-3067 A Rating Engine request could hang when switching a plan on the last day of the month for subscriptions based on the plans aligned to the expiration date with no custom expiration date being passed.
RE-3568 Subscriptions which did not have any additional resources could not be migrated to the Revenue only mode.
RE-3788 Subscriptions could fail to shift to Rating Engine with the "No code :: Undefined order type 'MIGRATION'" error occurring on the dry run.
RE-3808 Renewal orders failed for the subscriptions that included only usage resources.

Rating Engine 1.25.3525 (October 20, 2023)

Fixes

RE-3502 Shifting a subscription with a changed expiration date failed.
RE-3105 Unexpected recalculations and refunds could occur for a monthly subscription with the BSP billing model.
RE-2924 If a subscription was renewed but not billed several times, recurring details for 1 month could be missing from the first billing order.
RE-3196 Processing of a scheduled change order could result in a missing plan or resource recurring fee.
RE-3158 If a billing period was changed for a subscription within a scheduled change order, the next billing period could include compensating charges for the charges in the scheduled change order.
RE-3431 Subscription renewal could fail after its subscription was changed from 1 year to 1 month.
RE-3516 An incorrect plan ID could be used when a subscription with multiple period changes was shifted to Rating Engine.

Requirements

BSS 21.8 or later.

Rating Engine 1.24.3458 (September 25, 2023)

This is a patch release that contains the following fixes:

Fixes

RE-3483 Shifting subscriptions usage of which is processed by Vendor-rated Data Manager to Rating Engine could fail.

Requirements

BSS 21.8 or later.

Rating Engine 1.24.3456 (September 5, 2023)

This is a patch release that contains the following fixes:

Fixes

RE-2475 It was impossible to cancel a subscription that had been previously switched to a service plan with different resources.

Requirements

BSS 21.8 or later.

Rating Engine 1.24.3455 (August 17, 2023)

Fixes

RE-3277 Rating Engine could display a blank error message when it failed to process a usage record.

Requirements

BSS 21.8 or later.

Rating Engine 1.24.3452 (July 28, 2023)

This release brings support for the features released with the other components:

The ability to adjust prices for products with the multi-resource volume pricing model during purchase, when changing a subscription or viewing its details.

Requirements

BSS 21.8 or later.

Other microservices required for specific scenarios

Price adjustment for products with multi-resource volume pricing model requires the following components:

BSS 21.11.126 or higher.
Order Management 1.13.620 or higher.
UX1 Marketplace 7.2 or higher.
UX1 Subscription Management 5.5 or higher.

Rating Engine 1.23.3444 (July 21, 2023)

Fixes

RE-2783 Shifting to Rating Engine a subscription for which Rating Engine was previously disabled could duplicate resources in the SHM database.
RE-2728 Sometimes Rating Engine ignored spot pricing in refunds to a reseller after a subscription change.
RE-2572 Rating Engine prohibited downsizing for plans with a cancellation policy and no downsize policies configured.
RE-2794 Transferring an account could fail if the account owned a subscription that was previously downsized with a refund.
RE-3154 If there were multiple upsizing or downsizing orders placed for a subscription in the same day, one of them could get stuck in the EC status.
RE-3186 It was possible to shift subscriptions with unaligned start and expiration dates to Rating Engine, which could cause incorrect calculations for such subscriptions.

Rating Engine 1.22.3425 (June 14, 2023)

Fixes

RE-2920 A zero value Billing Order with reseller transactions could be created for a period that had already been rated before.

Rating Engine 1.21.3411 (June 1, 2023)

Fixes

RE-2209 Discount was not applied if the charge start date was before the discount creation date.
RE-2225 Minimum commitment was not calculated after switching from a minimum commitment plan and then switching back to it.
RE-2729 Downsize and cancellation could fail with the error: Unable to find suitable notch.
RE-2893 Shifting subscriptions to Rating Engine could fail with an error.
RE-2945 Renewal of a 1-month subscription with BBP billing model could fail.

Rating Engine 1.20.3374 (April 24, 2023)

This release contains internal improvements only.

Rating Engine 1.20.3373 (April 21, 2023)

Fixes

RE-2878 Minimum commitment charges were not calculated after a subscription was switched to another plan and back.
RE-2877 Rating Engine could re-calculate previous charges after upsize.

Rating Engine 1.20.3368 (April 12, 2023)

Fixes

RE-2769 When shifting a subscription to Rating Engine, the system did not check if Rating Engine was already processing that subscription.
RE-2741 The expiration date pre-check could produce a misleading error message.
RE-2272 Service plan synchronization could fail due to TCV recalculation error.
RE-2076 A change order could fail if subscription period had been changed previously multiple times.

Rating Engine 1.19.3343 (March 15, 2023)

Fixes

RE-2206 Upgrading an NCE subscription by switching to another plan could result in incorrect price calculation.
RE-2279 Renewal of monthly billed subscriptions with BSP billing model could eventually fail.
RE-2510 An invoice could include redundant lines for renewed subscriptions.
RE-2740 A billing order could get stuck in the Revenue and Cost Rating status.
RE-2753 Rating Engine could not process certain change orders that switched subscriptions to another plan.

Rating Engine 1.18.3332 (February 8, 2023)

In this release, the following issues were fixed:

RE-2614 A subscription dry run could fail with the Internal Server error due to the incorrect Rating Engine mode.
RE-2627 The "MC_003 :: Can't apply merge due different values" error occurred when trying to switch an After billing period plan with the Start Date of Current Subscription Period option.
RE-2413 A discount was not applied to billing orders of subscriptions based on a Charge After Billing Period plan when the billing order Detail Start Date was earlier than the discount creation date.
RE-2597 Subscriptions in the Not provisioned status with a canceled sales order failed to shift to Rating Engine.

Rating Engine 1.17.3324 (February 1, 2023)

This is a patch release.

Fixes

RE-2646 Dry run could get stuck if performed for a subscription with a canceled sales order.

Rating Engine 1.17.3323 (January 30, 2023)

This is a patch release.

Fixes

RE-2622 Partial upgrade to a plan with calendar billing configured could lead to an unnecessary charge.
RE-2633 Dry run could fail for a subscription if its dry run status was previously reset manually.

Rating Engine 1.17.3309 (January 13, 2023)

Fixes

RE-2431 Sometimes prices did not appear in the end-customer marketplace for service plans processed by Rating Engine.

Features

This release adds support for co-terming and calendar billing features.

Rating Engine 1.16.3271 (December 27, 2022)

In this release, the following issues were fixed:

PFR-6353 Changing a plan's pricing model to Multi-resource volume pricing at order and subscription levels' caused renewal orders for subscriptions to that plan to fail.
RE-1952 Customers that switched to another plan could be charged twice for the same billing period for both old and new plans.
RE-2314 When shifting plans to Rating Engine, the Execute operation '/asyncMigratePlans' task could fail.
RE-2439 Dry run failed if the rating mode remained selected.
RE-2458 Rating Engine pods could be evicted because of excessive logging.
RE-2474 A call for order estimation failed if there were changes scheduled for subscription renewal and the renewal was configured for the last subscription day.
RE-2384 A discount could be calculated incorrectly if the plan name and the name of one of its resources were the same.
RE-2462 Processing of a renewal order could get stuck.

Dependencies

This version requires components of the following versions:

BSS 21.8 or higher.

Rating Engine 1.15-3243 (December 15, 2022)

In this release, the following issues were fixed:

RE-1836 Billing Orders for usage-based services could be missing in an external system even though usage files were processed by CloudBlue Commerce.
RE-2435 Billing and renewal orders could get stuck when switching a subscription to another plan.
RE-2377 Billing orders could get stuck when being rated by Rating Engine.
RE-2391 Sales order processing could fail because of insufficient memory.
RE-2271 Order detail descriptions contained incorrect end dates.
RE-2286 Cancellation orders could get stuck because correction charges with different product names could not be merged.
RE-2280 Sometimes reseller charges were not generated after the subscription was renewed in advance.
RE-1159 Account transfer could fail if its subscription was not shifted to Rating Engine while the respective service plan was shifted.
RE-2304 Billing order calculation could fail after changing the priority of a related discount.
RE-2389 Renewal of the migrated subscription could fail if the subscription was renewed multiple times manually before its migration.
RE-2156 Localization could not be applied to units of measure.
RE-2128 Upsize charges were missing sometimes if billing terms were configured to charge for an old amount in case of downsize.
RE-2481 Upsizing a subscription after partial upgrade could fail.

Rating Engine 1.14-3206 (September 30, 2022)

In this version, the following improvement was added:

An additional price model was introduced: Multi-resource volume pricing at order and subscription levels. Within this pricing model, the aggregated volume of all resources with the same units of measure is considered. The order type defines what resource volume is considered for price tier selection:

When making a purchase, only resource quantity in the order is considered to define the price tier.
When upsizing, the price tier used to define unit price in the order cannot be lower than in the previous order but can be higher if resource quantity in this order is sufficient to reach a higher tier.
When renewing, the price tier is based on the resource quantity already owned within the subscription.

Tip: This pricing model matches the pricing rules for Adobe products.

When migrating subscriptions with this price model to CloudBlue Commerce, you need to specify the current price tier of such subscriptions using the migrationPriceLevel migration order attribute.

Important: This feature requires the specified or higher versions of the following components:
- BSS 21.8
- Rating Engine 1.14
- Order Management 1.8
- UX1 Subscription Management 4.7
- UX1 Marketplace 6.7

In this release, the following issues were fixed:

RE-2093 A resource purchased additionally within a plan to which the subscription was upgraded could not be downsized.
RE-1959 Sometimes discounts could not be applied when recalculating a change order.
RE-2322 The statement date for a subscription was incorrect after it was shifted to Rating Engine on February 28.
RE-2291 An inaccurate error message was displayed when the start date of an imported subscription was incorrect.
RE-2155 A negative discount could be applied to order details if a subscription was upsized and downsized in the same day.
RE-2059 A subscription switched to other plans multiple times could not be shifted to Rating Engine.
RE-2095 A subsequent dry run for a subscription in the REVENUE_ONLY mode could not be initiated if the first one failed.
RE-2149 The discount was sometimes missing from the refund invoice.
RE-2231 When upsizing a subscription switched to another plan, order detail start and end date could be incorrect.

Dependencies

This version requires components of the following versions:

BSS 21.6 or higher.

Rating Engine 1.13-3171 (August 5, 2022)

This is a patch release.

Fixes

RE-2215 When a subscription was partially upgraded, the billing order contained multiple details with date ranges for the same resource instead of a single detail.

Note: As of this version, PostgreSQL 13 can now be used for the database of this component.

Rating Engine1.13-3158 (July 25, 2022)

In this release, an additional migration program was added for migration orders: prorate_migration_billing_period. This program can be used to bill for the remaining part of the billing period after a subscription is migrated.

This release also includes the following fixes:

RE-1647 Unable to transfer an account with a migrated subscription to a reseller on a different level in the delegation chain.
RE-1976 Placing an order for a service plan with custom statement day set to 31 could fail.
RE-1978 Additional resource amount could not be purchased within a subscription switched to another service plan if during the switch, an additional resource amount had already been purchased.
RE-2036 Shifting a service plan with a recurring fee to Rating Engine with REVENUE_ONLY mode failed if previously a subscription was switched from a plan with a recurring fee to that plan.
RE-2067 A subscription switched to a different service plan could not be renewed.

Rating Engine 1.12-3134 (June 17, 2022)

In this release, the following issues were fixed:

RE-1970 Subscription renewal could fail with an error.
RE-2060 Rating Engine failed to rate orders with the Custom unsupported cancellation fee type. Now orders are successfully rated and such fees are ignored in calculations.
RE-2031 Renewal orders could hang in the "Creating Order Details" status.
RE-2062 Billing orders could hang in the EC status because of a timed-out operation.
RE-1099 A repeated billing order could result in incorrect charges if there was a change order between the attempts to process the billing order.

Rating Engine 1.11-3090 (April 29, 2022)

In this release, the following issues were fixed:

RE-1973 Processing of renewal orders with deal prices failed if different sales currencies were configured for provider and resellers
RE-1967 If the Billing time zone was configured as ahead of GMT, some customers could be billed for two periods in advance instead of one.
RE-1946 Orders could hang in the RE status.

Rating Engine 1.10-3072 (April 5, 2022)

This release adds support for cancellation fees was added to Rating Engine. Now, service plans that use Rating Engine can include cancellation fees of the following types:

None.
Plan and Resource Rates until Expiration Dates. This type can be selected only if no refunds are permitted for the subscription period.

Note: Service plans with these cancellation fee types can also be shifted to Rating Engine.

A cancellation policy can also be configured for plans that are managed in PLM. In this case, fees from that policy are used instead of the ones configured in Billing.

Additionally, if any policy is configured in PLM for a plan, the cancellation fee type and non-refundable amount will not be displayed for that plan in classic provider (PCP) and reseller control panels (RCP).

The following issues were fixed:

RE-1862 A discount "By Customer Class" was applied instead of the "By Account" discount when both discounts were applicable.
RE-1708 Orders related to subscriptions whose plans were shifted to Rating Engine could get stuck in the "Rate" status.
RE-1717 Some orders for subscriptions with only usage-based resources, such as a switch order, failed when being processed by Rating Engine.

Dependencies

This Rating Engine version requires BSS of version 21.6 or higher.

Rating Engine 1.9-3029 (March 4, 2022)

This release brings the following improvements:

The Charge Before Subscription Period (BSP) billing model is now fully supported in Rating Engine.

The following issues were fixed:

RE-1810 If there were transferred accounts on the installation, Rating Engine shift could fail.
RE-1721 During purchase or migration of a subscription with resources from two different applications, an error could occur.
RE-1848 Rating Engine did not have a parameter to store the number of its instances in Kubernetes.
RE-1756 Cancel Orders for subscriptions with overuse could fail with the error "No value present".
RE-1718 Orders could get stuck in the Rating Engine Call status with the error "HTTP server returns error with code 500: The application returned an empty error message".
RE-1691 Shifting a service plan to Rating Engine could fail if there were subscriptions that were recently upsized or downsized.
RE-1678 Charges could be incorrectly calculated for a subscription after a service plan was shifted to Rating Engine.

Rating Engine 1.8-2981 (January 20, 2022)

This release includes the following improvements:

RE-1733: Vendor Contract IDs are now available for products created using Product Lifecycle Management. Rating Engine now retrieves Vendor Contract IDs from reseller profiles.
RE-1736: Vulnerabilities caused by third-party libraries were eliminated
You can now change the log level of this component at runtime. To learn more, please refer to Managing the Log Level of a Component.

In this release, the following issues were fixed:

RE-1762: A timezone conflict occurred for a delegated plan created using Product Lifecycle Management
RE-1757: Incorrect customer order total calculation in UX1 Marketplace
RE-1751: Shifting a subscription to Rating Engine failed for a subscription that was switched to another service plan

Rating Engine 1.8-2965 (December 30, 2021)

Rating Engine is a CloudBlue Commerce component responsible for calculation of all charges across the distribution chain, including provider and reseller revenue as well as end-customer charges. It can work together with classic BSS rating functionality or act as the main rating component, with BSS rating kept inactive.

Rating Engine supports and provides charge calculation for the following business and technical use cases:

Revenue rating for the whole distribution chain.
Support for new policies for subscription cancellation and resource downsizing, including Office NCE subscriptions. Configuration of new policies can be performed only through Product Lifecycle Management.
Customer account transfers between distributors
Subscription transfers between customers
Shift existing service plans and subscriptions to Rating Engine
Minimum commitment-based offers
Usage-based services (rated according to PR, CR, TR, and QT rating models)
Volume Pricing for new service plans
Combined discounts
Auto-renewal of subscriptions to another service plan period
Tax calculation for:
- Tax rates effective on the AR document date.
- Tax rates effective on the billing period end date. This taxation mode allows you to comply more flexibly with taxation rules of a number of European as well as non-European countries. An example is tax relief measures in Germany, where the VAT rate was temporarily reduced from 19% to 16% from July 01 to December 31, 2020.