How To Create and Use Upgrade/Downgrade Paths

Overview

The Upgrade/Downgrade path feature allows you to define product and/or package transition pathways so that provisioned products and/or packages automatically change based on start and end date rules. This is useful for scenarios where, for example, a customer is provisioned a certain type of subscription that will automatically switch to a lower tier or higher tier after a period of 3 months.

This will automate the provisioning of products to customers to a certain extent and make it so that the billing or product administrator need not provision the next product in the upgrade/downgrade path separately.

The feature supports upgrading or downgrading to a package from a product as well as upgrading or downgrading to a product from a package. Upgrading or downgrading to a package assumes that the package will be provisioned to the account so as part of the preparation process, make sure that there are package products configured to have a minimum required quantity of 1. Otherwise, an empty package will be provisioned to the account.

Procedures

1. Prepare the products and/or packages to be used.

The products or packages that will be used for creating the rules need to be existing and active in the system. For more information, refer to the following articles:

2. Create the Upgrade/Downgrade Path rules.

Navigate to Products > Upgrade/Downgrade Management > Upgrade/Downgrade Paths and click New to create a new rule. This will display the data entry page such as the example below.

Rule_Data_Entry.png 

Fill in the data by using the field definition table below as a guide.

Field Definition
Name Unique name for the rule.
Source Type Choose whether the source (starting point) is a product or a package.
Source Product/Package This will display the list of active products or packages depending on the Source Type selected. 
Destination Type Choose whether the destination (upgrade/downgrade path) is a product or a package.
Destination Product/Package This will display the list of active products or packages depending on the Destination Type selected.
Effective From/To Date Date range when the rule is active. When the rule is active, the upgrade/downgrade activities are performed. Otherwise, no upgrade or downgrade is performed even if there are eligible packages or products.
Migrate Product Attributes

This grid allows the mapping of custom attributes between the source product/package and the destination product/package. If the source or destination is a package, the grid is expanded to include the custom attributes of the packages as well as package products with custom attributes. This allows detailed mapping of specific field attributes if necessary such as the example below.

Product to Product path:

Product_to_Product.png

Product to Package path:

Product_to_Package.png

Package to Product path:

Package_to_Product.png

Package to Package path:

Package_to_Package.png

Note that there is a grid for Migrate Products when upgrading/downgrading between two packages. This is used when dealing with multiple instances of the same product in the source. This means that when multiple instances of the same package product is provisioned to the account, the destination package should also be provisioned with the same number of package products. Then, the package product attributes listed under the Migrate Product Attributes will be mapped and copied over to the new account package product instances.

Description Free-form text field where additional information about the rule can be documented.

3. Add the rules to products or packages.

Navigate to the product or package where the rule will apply and open it for editing. Update the Update/Downgrade field as illustrated in the screenshots below.

Product:

Product_Rule_Adding.png

Package:

Package_Rule_Adding.png

4. Provision the starting product to the customer.

The starting/source product or package can now be provisioned to the account. The same process for provisioning account products or account packages will be followed. The only additional step is to update the Upgrade/Downgrade section with the appropriate configuration.

Provisioned_Source_Product.png

Use the table of field definition below to help you populate the fields.

Field Definition
Current Upgrade/Downgrade This indicates the rule that will be used. By default, it will have the rule that is configured on the product or package in the catalogue. Tick the Override checkbox if a rule other than the default is needed for the provisioned product or package.
Apply Upgrade/Downgrade

Indicates when the downgrade or upgrade happens. The options are:

  • On End Date - The transition to the new product or package according to the rule will happen when the current account product or package ends (e.g. the End Date value lapses).
  • From Date - Exposes the From Date field. The transition to the new product or package according to the rule will happen on the date that is indicated in the From Date field. When the date is met, the current product or package will automatically be ended and the new one provisioned and started.
From Date

Visible only when the Apply Upgrade/Downgrade value is From Date. This indicates when the upgrade/downgrade will happen.

Once the product or package is provisioned, the system will then execute the upgrade/downgrade based on the configured parameters on the account package/product when the date conditions are satisfied. The current product or package is ended (you can see this when the End Date field is populated automatically), and the upgrade/downgrade product or package is provisioned to the account. The Start Date of the new product or package is the End Date of the old product or package plus one day.

5. View the status of the Upgrade/Downgrade Path rules.

On the rule UI, you can see the upgrades/downgrades that have taken effect for the rule. Navigate to Products > Upgrade/Downgrade Management > Upgrade/Downgrade Paths and select an existing rule. The details page will be displayed such as the example below:

Rule_Details.png

At the bottom of the page, the history of the transitions that took effect for the rule are listed. This will give an idea which accounts along with account product or account package Ids that were changed and when they were "upgrade" or "downgraded".

Have more questions? Submit a request

Comments

Powered by Zendesk