This document describes the new functionalities and improvements in CloudBlue Commerce20.4. Using this version of the product you can:
- Sell better using quotes
- Sell efficiently in the powerful new end-customer Marketplace
- Conveniently manage your portfolio with Product Inventory
- Bill and reconcile simpler and correctly thanks to a unified way of working with PAYG usage and aligning with vendor billing dates
- Integrate with new API methods.
Platform Features and Changes
Odin Automation Is Now CloudBlue Commerce
Odin Automation products become CloudBlue Commerce. For additional information, refer to https://www.cloudblue.com/commerce/.
Since Odin Automation is renamed to CloudBlue Commerce, the Product name and all related information were updated:
- UI (Product names, the default Product skin)
- Links (contacts, links to Knowledge Base articles, and so on)
- Changes in Documentation (Product names and Brand names, links, contacts; throughout all officially published guides).
Also, starting with this release, version 20.4 and later are to be released after version 8.3.
Note: Documentation for released Product versions is left as is.
UX1 Panels and the Marketplace
This release of CloudBlue Commerce brings the following additions and enhancements.
UX1 Management Panel
Providers can use UX1 Panel for Providers to configure the Marketplace and offers for their L1 resellers. The UX1 Panel for Providers is the foundation of the new provider experience. Many more useful functions will be delivered in upcoming releases.
Backward Compatibility
N/A
Activation
To enable it, change the settings in Provider Panel > System > Settings > Enable/Disable UX1 for the Provider.
Known Limitations
N/A
Self-serve Marketplaces for End Customers
End customers of providers, resellers, and subresellers can purchase services through UX1 Marketplace, which is now available from the UX1 for Customers panel. The new Marketplace offers better navigation, search, and a shopping cart with the option to buy several products at once.
Backward Compatibility
N/A
Activation
To use UX1 Marketplace for Customers, you need to install the UX1 Marketplace extension and activate it in Sales Channels.
Known Limitations
Domain registration services and SSL certificates cannot be sold at this moment. Web hosting and Office 365 subscriptions can be sold separately, without domain names. If you need to sell these services, continue using the default Marketplace component that is built into the Customer Panel.
Domain services will be supported in the next coming releases.
Learn More
Setting Up the Customers' Marketplace
Shareable Sales Quotes
Now, resellers can print a quote to a PDF file and share the file with customers.
To do that, they need to add products to a cart, go to the cart, click Print a Quote, add a comment or description for a quote, select the columns to be displayed in a quote, and click Print a Quote. After that, they can share it with customers.
- Providers (L0) can provide quotes to their customers (L1) if the Marketplace is configured at the provider (L0) level.
- L1 resellers can provide quotes to L2 resellers if the Marketplace is configured at the L1 reseller level.
- L2 resellers can provide quotes to their L3 customers if the Marketplace is configured at the L2 reseller level.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
Providers and resellers can prepare a quote for their subresellers only after configuring UX1 Marketplace for subresellers and logging in to the UX1 for Resellers panel on behalf of a subreseller.
Expanded Options for Payment Methods
When a reseller purchases services for their customers or for their own use through the Marketplace, they can add a new credit card in the last step of the wizard. That card is then used for payments of the reseller to their provider.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
Featured Bundled Products
Providers and resellers can now motivate their subresellers and customers to buy more services: When users buy a service, they see a section titled "Frequently bought together", which offers relevant or complementary services, which will help increase your average order value.
Backward Compatibility
N/A
Activation
Providers and resellers can configure the items to be displayed under "Frequently bought together" in UX1 Marketplace > Sales Channels.
Known Limitations
Currently, this allows you to configure plans that are complementary to plans within a category. There is one limitation: you cannot configure complementary services for a specific service plan.
Learn More
Selling More with the "Frequently Bought Together" Option
Viewing the History of Changes in Subscriptions
Resellers and operating companies can view the history of changes to subscriptions in subscription properties. The history displays all orders related to a subscription, including sales, change, upgrade, downgrade, renewal, and cancellation orders.
Backward Compatibility
N/A
Activation
No actions are required to activate this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
Viewing the History of Changes in Subscriptions
Renaming Subscriptions
Resellers can change the names of subscriptions.
Backward Compatibility
N/A
Activation
To enable resellers to do this, providers must install the UX1 UI extension and grant the permission to Manage Customers' Subscriptions in UX1.
Known Limitations
N/A
Learn More
Expanded Subscription Management Capabilities
- Resellers can log in as a customer from the subscription overview page. A new button called "Log in" was added.
- Resellers no longer need to approve their own cancellation orders. Approval is only required for cancellation orders received from customers.
- Technical settings and plan options with zero prices are no longer displayed in subscription details.
- The "Home" page of UX1 Panels was renamed to "Dashboard".
- The size of elements in UX1 for Resellers was increased to make interaction with the panel easier.
- For easier reconciliation, a new column called "Reconciliation ID" has been added to the subscription profile. The column is displayed only if reconciliation ID is not empty for at least one subscription resource. Reconciliation IDs are configured by providers.
-
Resellers can see the total price of a customer's order in UX1 for Resellers Panel. This is convenient when resellers purchase on behalf of their customers and need to know the price to communicate it to users before the purchase.
-
Application developers can embed custom screens into the subscription change wizard (this is displayed when users upsize, downsize, or upgrade subscriptions) in UX1 for Resellers Panel.
-
Marketplace screens are now loaded faster and are more responsive.
Backward Compatibility
N/A
Activation
No actions are required to gain access to these improvements. They are enabled automatically after the upgrade.
Known Limitations
N/A
Billing
Prorated Orders Based on Provisioning Duration
To minimize efforts on manual refunds caused by delays in provisioning, all orders will be prorated according to actual provisioning.
If for some reason you do not want to prorate all orders and wish to return to the previous system behavior, please contact support to get assistance.
Backward Compatibility
All service plans and subscriptions will continue working. However, the default behavior will affect all newly created orders.
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Importing MPNs and Vendor Contract IDs from CloudBlue Connect
Now, when you import a service template from CloudBlue Connect to create an offer in CloudBlue Commerce, the imported data will include MPNs and Vendor Contract IDs. This will allow provider sales teams to quickly identify the corresponding vendor resources in CloudBlue Commerce and simplify reconciliation and revenue recognition.
Backward Compatibility
The feature is backward compatible. For resources without MPN or Vendor Contract ID, the system behaves in the same way as before.
Activation
The feature is enabled automatically after the deployment of Export Engine version TBD.
Known Limitations
The feature is effective only for newly imported services from CloudBlue Connect.
Learn More
MPN import:
Vendor Contract ID configuration:
Expanded Multi-tier Rating Capabilities for Usage-based Products
Now CloudBlue Commerce supports vendor-rated usage data import and rating for usage-based services integrated through CloudBlue Connect and other connectors in the following way:
- Providers can import a unified set of usage data to CloudBlue Commerce by uploading it in the Provider Control Panel or by using API.
- CloudBlue Commerce rates the imported usage data based on the following rating models:
- Usage data rated by the vendor for all parties (Tiers Rated): CloudBlue Commerce receives usage data rated for all distribution chain parties. In this case, CloudBlue Commerce invoices resellers and end customers based on the imported data without any recalculations.
- Usage data rated by the vendor for the End Customer (Price Rated): CloudBlue Commerce receives usage data rated only for end customers. In this case, CloudBlue Commerce rates the charges for the rest of the distribution chain based on the respective markdowns configured in CloudBlue Commerce.
- Usage data rated by the vendor for the Provider (Cost Rated): CloudBlue Commerce receives usage data rated only for the provider. In this case, CloudBlue Commerce rates the charges for the rest of the distribution chain based on the respective markups configured in CloudBlue Commerce.
A product offered through CloudBlue Commerce can contain a combination of both PAYG items billed using the new feature and non-PAYG items billed using the existing functionality.
Backward Compatibility
After the upgrade:
- The existing subscriptions will not be affected.
- The existing Vendor-rated Data Manager functionality will not be affected.
Activation
The feature is enabled automatically after:
- CloudBlue Commerce upgrade
- Vendor-rated Data Manager microservice upgrade to version 1.0.204
Known Limitations
N/A
Learn More
Storing and Displaying Reconciliation IDs
Now, for reconciliation and troubleshooting purposes, CloudBlue Commerce can store and display vendor reconciliation IDs.
Backward Compatibility
After the upgrade, new empty fields will appear in existing subscription profiles, which can be populated or manually set with the respective reconciliation IDs. To import reconciliation IDs from vendors, providers will have to perform a one-time procedure.
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
Definable Billing Periods
Now, when configuring a service plan with the active Align Billing Order with Statement Day option, you can set the date when statements will be generated. The new date of statement can also be aligned with the first sales order.
Also, when you align a billing period with a calendar month, you can provide a first period (up to the next billing date) for free.
This is to align billing cycles of subscriptions with vendor rules, so that revenue and cost will be reconciled with a vendor's invoice.
Note: A statement date defined on the service plan level overrides the one defined in a customer class.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
For configuration, refer to Configure Billing Terms.
Marking Transactions out of SCA Scope
Functionality of PHP Payment SDK has been extended. MOTO (Mail Order/Telephone Order) payment transactions that do not require SCA (Strong Customer Authentication) are now marked with a special flag by Payment SDK on the fly when calling a payment plugin. PHP payment plugins can be updated to pass this information to payment gateways, so that it is received by the customer’s bank, which will then make the final decision whether to request SCA or not.
Reducing the friction required for cardholder authentication (where it is allowed by the financial legislation) will smooth both the customer and reseller purchasing experience.
Backward Compatibility
N/A
Activation
After the upgrade, the feature is enabled in the Stripe payment plugin. To enable it in a different PHP payment plugin, update that plugin according to the documentation.
Note: To use this functionality in CloudBlue Commerce a provider must explicitly enable it for their account in Stripe.
Known Limitations
Transactions made on behalf of resellers or customers through their classic panels (CCPv1) using the login as
functionality are not marked as MOTO.
We recommend you to use UX1 or perform actions on behalf of a customer (reseller or end customer) through own control panel.
Learn More
For information, refer to Input Parameters Format and Support for SCA and 3D Secure.
Token Removal on the Gateway Side
Capabilities of the PHP Payment SDK have been extended in this version. Plugin developers can now implement a payment token removal on a gateway side to synchronize this action with a payment method removal on the platform. Therefore, it is now possible to support specific gateway scenarios that require explicit token removal. For example, token creation for a credit card with the same number but a new expiration date.
Backward Compatibility
The feature is fully backward compatible. After the upgrade, all existing payment methods will continue to work.
Activation
This feature is enabled in the Worldpay payment plugin after the upgrade. To enable it in other PHP payment plugins, update that plugins according to the documentation (if respective payment gateways support explicit token removal).
Known Limitations
This feature is not supported in CCPv1.
Learn More
For information and usage, refer to API Overview and Method Descriptions on how to implement the CanRemovePayTool and RemovePayTool methods.
Fake Reseller
Is Now Operating Unit
To make our UI clearer, we replaced the Fake reseller
term with Operating Unit
.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Support for a New Currency: ZMK
Zambian kwacha is now available for selection as the default currency for new accounts.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Inclusion of a Secondary Currency
Now providers can configure CloudBlue Commerce to display the AR document total and tax values in one additional currency for their direct resellers and customers in email notifications and PDF. When enabled by a provider, the provider's resellers of any level also can configure their own additional currency for their direct resellers and customers.
This allows providers and resellers who trade internationally to display the total and tax values of invoices and other AR documents in local currencies. The values are calculated based on the currency exchange rate configured by providers and resellers together with the secondary currency. The exchange rate is also included in email notifications and PDF documents.
Backward Compatibility
After the upgrade, new placeholders will be available for AR document email notifications and PDF forms. However, the existing AR document functionality, including email notifications and PDF forms, will not be affected.
Activation
To enable the feature, a provider must:
- Enable the secondary currency settings in the BSS database.
- Configure the secondary currency together with the base currency exchange rate.
- Configure email notifications to include the AR document tax and total in the secondary currency.
To enable the feature, a reseller must:
- Ask their provider to activate the feature.
- Configure the secondary currency together with the base currency exchange rate.
- Configure email notifications to include the AR document tax and total in the secondary currency.
Known Limitations
- In the UI, the AR document total and tax are displayed in the base currency configured for the system. All financial management and accounting in the system is done using the base currency.
- When an invoice or a notification is regenerated, the AR document total and tax are displayed based on the current exchange rate, which may be different from the exchange rate at the time the document was generated originally.
Learn More
- Provider: Enabling the AR Document Tax and Total to Be Displayed in an Additional Currency
- Reseller: Enabling the AR Document Tax and Total to Be Displayed in an Additional Currency
Product Configuration Management
Improved Product Import
Resellers can now save time when importing products from the vendor catalog by mass editing service plan prototypes. For multiple service plan prototypes, resellers can now simultaneously configure the following:
- Assign a plan, sales and resource categories
- Adjust provisioning notifications
- Assign Service Terms and Terms and Conditions
- Specify the Service Template to be used for delegation
- Configure autorenewal
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Product Inventory View
You can now access the catalog of products offered to your customers and download it for analysis or to update prices. This catalog is accessible from both Operations and Billing control panels and contains only the products with assigned MPNs. Each product in the catalog represents a resource rate for an MPN. Tiered prices are also highlighted in the catalog for convenience.
Backward Compatibility
N/A
Activation
After the upgrade, a new application Product Inventory is added to the system. To enable this feature, you need to create an instance of this application.
Known Limitations
Bundles are not supported in the catalog.
Faster Creation of Application Instances with Default Configurations
Now, when initializing an APS application instance, providers can instruct CloudBlue Commerce to automatically create Resource Types, Service Templates, and Service Profiles with default settings defined by the application. The capability is available in the Add Application Instance wizard through the new Initialization Settings section.
Backward Compatibility
After the upgrade, the existing application instances will not be affected.
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
The capability is available only for APS applications that support Product Configuration Manager (PCM).
Learn More
Platform SDK
Additional Capabilities for Payment Management API
The PaymentManagement APS type is extended with a new custom operation update that enables external systems to request for payment release and payment void billing operations, which were previously available only in the user panels. The improved payments operation is extended with a set of RQL-style operators and functions that allow external systems to narrow down the list of payments they want to get from the payment manager.
These extensions are useful for providers and resellers who want to process SEPA payments outside the platform through their own intermediate systems that support specific requirements of banks they use. A typical business scenario includes the following interaction between the platform (API server), an intermediate management system (API client), and an external payment management system:
- The API client calls the payments operation (RQL functions may or may not be used) to read new payments created in the platform.
- The API client sends the payment data to an external payment management system that performs the money capture (a bank or payment gateway).
- Depending on the results of the payment capturing, the API client calls the update operation to either release or void the corresponding payment documents in the platform.
Learn More.
For detailed explanation and examples, refer to:
Spot Pricing Management API
To change prices for existing subscriptions, the BSSSubscription APS type exposes three operations that enable the provider to assign, read, and delete spot prices.
Following the typical sales chain, the provider can change the prices (how much the customer pays to the reseller) and costs (how much the reseller pays to the provider) for an existing subscription that a customer purchased from a reseller. Spot prices can influence the current subscription period or all further periods as well.
For more details, refer to the Spot Pricing description and example.
Provider Costs in Sales Orders
The Order Management API is extended with a new structure providerCosts applicable to sales orders. This enables the provider to record special fees they pay to service vendors for particular services.
This API extension helps the provider consolidate their balance when they pay special fees for the services they resell.
For more details, refer to an example and limitations.
API Authentication with an IDP Token
The identity provider (IDP) is a microservice that extends the platform capabilities to interact with various authentication services using the OAuth 2 framework with the OpenID Connect extension. External systems functioning as API clients on the APS bus can request a platform user's authorization from the IDP. The authorization is granted by a security token generated by the IDP and used by the API client to authorize its requests on the APS bus.
For more details, refer to Authorization through the Identity Service.
Vendor-Specific APS Types
In addition to the VendorContract APS type, the platform exposes two more abstract vendor-specific APS types: ExternalIdentifiers and ItemProfile. Together, these three APS types enable software vendors to provide the following vendor-specific data through their integration packages:
- vendorContract: The ID of the distribution contract signed by the provider and vendor. This property is inherited from the VendorContract APS type.
- vendorSubscriptionId: A subscription ID inherited from the ExternalIdentifiers APS type and assigned on the vendor side.
- profileName: A profile name inherited from the ItemProfile, which implements the ServiceProfile APS type. This property is assigned by the vendor or provider.
- itemId: A vendor-specific resource ID inherited from the ItemProfile APS type and assigned by the vendor.
- mpn: The product MPN inherited from the ItemProfile APS type and assigned by the vendor or provider.
Implementation of these three abstract APS types enables vendors and the provider to monitor products sold and resource usage in detail.
For more details, please refer to vendor-specific abstract APS types.
The Pending Status Is Supported by the Payment SDK (PHP) Capture Method
The CloudBlue Commerce Payment SDK (PHP) now supports the PENDING status for the Capture method: When a plugin passes PENDING to CloudBlue Commerce in response to a Capture method request, the system executes the CheckStatus method repeatedly until one of the final statuses, such as APPROVED or DECLINED, is received. As a result, plugin developers can use it to support gateway scenarios where payment capture processing takes time.
Backward Compatibility
After the upgrade, the existing payment plugins will not be affected.
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Payment plugins must be enhanced to support gateway scenarios where payment capture may be delayed.
Known Limitations
N/A
Learn More
Domain Management
InterNetX Plugin Support for DNSSEC
The InterNetX plugin now supports the DNSSEC extensions.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
For configuration, refer to Selling DNSSEC as Complementary Service to Domain Registration.
OpenSRS Plugin Option to Switch from C++ to PHP
Now you can switch management of your registered domains from the C++ OpenSRS plugin to the PHP OpenSRS plugin.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Learn More
For information on EOL of C++ plugins, refer to this KB article.
Infrastructure
Increased Fault Tolerance
In 20.4, it is possible to add an additional management node to cloud-based installations. It adds the following features:
- Order provisioning becomes fault-tolerant. Now, if one management node fails, new orders will still be placed and the resources will be provisioned. Previously, resources were provisioned only if provisioning had started before the first management node failure.
- Amount of additional management nodes can be flexibly changed in response to system load growth.
- Ability to rollback installation of a hotfix.
Backward Compatibility
N/A
Activation
You need to deploy or migrate the additional management node to Azure to enable these features.
Known Limitations
N/A
Performance
UX1 Performance Increased
The loading speed of UX1 screens has been greatly improved, especially for resellers with many customers.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
N/A
Online Store
GDPR Cookie Consent Collection
To address the recent updates to GDPR, the online store templates are changed as follows:
- The notification about cookies being used on the website now informs users that some of the cookies are necessary for the website to work.
- The same notification also contains a link to a page with a complete list of both necessary and optional cookies used by the site.
- Online store visitors are prompted to choose whether to enable optional cookies on the website.
Backward Compatibility
N/A
Activation
Online store template pages must be updated to enable this feature.
Known Limitations
N/A
Learn More
For information and configuration, refer to Configuring the Online Store in Compliance with the Cookie Policy.
Miscellaneous
Improved Provisioning Error Messages
In case of a provisioning error, it is now easier to identify the problem. For this purpose, these changes were made:
- Now, all provisioning error messages include: request URL, HTTP method, and the returned Error code.
- Application instance URI is included in each provisioning tasks.
- Provisioning status is now reflected as a subscription parameter.
- When a subscription is deleted, its status changes to Terminated. Such subscriptions can be discovered until cleaned up from the system.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
None
Features and Changes Available Since 8.3
Default Payment Management API
The BSSSubscription APS type exposes new operations to attach a payment method to a subscription and use it as the per-subscription default in further operations with the subscription such as paying billing and renewal orders. These new operations enable an external management system to have different payment methods attached to different subscriptions.
Backward Compatibility
After the upgrade, the existing subscriptions will not be affected.
Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.
Known Limitations
The new payment method is not applicable to consolidated invoices. When an invoice includes several subscriptions, the default payment method of the account is used.
Learn More
Reorganized Detailed Invoice Formatting
For more convenient reconciliation, invoices for resellers in the PDF format are now split by customers with detailed information on their subscriptions.
The following two notification subtemplates has been implemented to be included in the Invoice template:
- Customer Invoice Details
- Reseller Invoice Details
Backward Compatibility
The feature is fully backward compatible.Activation
No actions are required to enable this feature. It is enabled automatically after the upgrade.Known Limitations
N/A
Learn More
For information and configuration, refer to Creating Notification Templates, Using Subtemplates, and this KB article.
End of Life
Upcoming End of Life
Hosted Exchange 2013
As of this version, the ability to create Hosted Exchange 2013 subscriptions is turned off. Existing Hosted Exchange 2013 subscriptions remain functional so that customers can continue to use existing and create new Hosted Exchange 2013 mailboxes, public folders, and so on.
Starting from the next version, Hosted Exchange 2013 will not be supported. Service providers that have Hosted Exchange 2013 subscriptions on their installations must migrate these subscriptions from Hosted Exchange 2013 to Hosted Exchange 2016 by using these migration instructions.
Backward Compatibility
N/A
Activation
The feature is automatically enabled after upgrade.
Known Limitations
N/A
Linux Mail Module
Note: This is an update to the announcement made in the Odin Automation 8.3 Release Notes.
Starting from one of the next CloudBlue Commerce versions, the Linux Mail Hosting module will no longer be supported.
Resolved Issues
Application Packaging Standard
OA-12825
Issue Summary: The "Service Profiles" tab performance degraded significantly when there was a large amount of service profiles.
Fix Description: The method that provides data for this screen was run with an enabled transaction. A large number of service profiles were processed within this transaction, which caused degradation of this method. This transaction is now eliminated.
OA-12586
Issue Summary: Issues with the Microsoft (Office) 365 package upgrade from 19.3.1 to 20.1 on OA 8.2 and later.
Fix Description: Obsolete properties have been removed from application resources in the upgrade.
OA-12533
Issue Summary: The new required boolean resource property "show_service_plans" in the Microsoft (Office) 365 application resource was not correctly initialized during upgrade from 19.3.1 to 20.1.
Fix Description: Now, the default value for the new required boolean resource property is set on application upgrade.
OA-11380
Issue Summary: An APS subscription unprovisioning task failed with the error: "Transaction cannot proceed: STATUS_MARKED_ROLLBACK'" after upgrade to 8.3.
Fix Description: Now, an existing transaction will not be rolled back at an APS "DELETE" request for a resource that does not exist.
OA-10598
Issue Summary: After transferring an account to another vendor, only a direct vendor could read the transferred account's information.
Fix Description: After changing the owner of the subscription, all parents of the new owner have access to the subscription resources through the APS.
OA-9907
Issue Summary: An error occurred when changing parameters of an APS-based resource type.
Fix Description: The mechanism of a service template's resource and resource type activation parameter retrieval has been fixed.
OA-9313
Issue Summary: The pem.upgradeSubscription method allowed the provider changing resource limit that is below current usage.
Fix Description: The wrong name was assigned to the OpenAPI method's parameter after refactoring. The parameter's name has been fixed.
OA-8813
Issue Summary: The APS controller did not update operation information on type reimport.
Fix Description: Information about new or missing operations has been restored on APS type reimport.
OA-2762
Issue Summary: Could not install a locale on a UI Cluster.
Fix Description: The KB article on how to do this has been created: https://cloudblue.freshdesk.com/support/solutions/articles/44001910605.
OA-11643
Issue Summary: It was not possible to create a VoIP account.
Fix Description: The issue happened because of an error in an HQL query. The query error is now eliminated.
OA-11484
Issue Summary: Installation of the Hostopia APS instance failed due to incorrect handling of parameter logic when using the installation application wizard. The application received an incorrect value from the UI.
Fix Description: The UI logic has been changed for the application to receive the correct value.
OA-10976
Issue Summary: Timeout when creating service templates using the pem.addServiceTemplate method for templates with a large amount of resources.
Fix Description: The logic has been changed to use direct EJB calls to eliminate such timeouts.
OA-10499
Issue Summary: WildFly terminated a connection for requests larger than 10 MB.
Fix Description: The packet size limit for WildFly has been set to 100 MB.
OA-12048
Issue Summary: The "Synchronize resource usage for APS application instance" task ran for a long time and blocked other tasks.
Fix Description: A feature to set periodic task priorities has been added to reduce the impact of slow-running tasks.
OA-11356
Issue Summary: The "On-screen Notification Cleanup" task sometimes failed in case of many UX1 notifications.
Fix Description: Cleanup queries have been optimized for better performance.
OA-11250
Issue Summary: The SIOOBE exception arose when processing strings with non-ASCII symbols.
Fix Description: A password containing non-ASCII symbols can now be set.
OA-11008
Issue Summary: Slow processing of custom asynchronous tasks.
Fix Description: A feature to set periodic task priorities has been added to reduce the impact of slow-running tasks.
OA-9826
Issue Summary: Updates to VPS CPU Power settings were not synchronized with Instance Manager.
Fix Description: The APS controller now properly processes the limit change of hierarchical counters.
OA-9711
Issue Summary: The "corePower" resource was not added to subscriptions that were switched to a plan with this resource.
Fix Description: Resource propagation through the APS bus has been fixed.
OA-9601
Issue Summary: Connect application installation sometimes failed with a timeout due to slow query execution.
Fix Description: PostgreSQL database statistics are now extended to handle this issue.
OA-9518
Issue Summary: A DB connection acquisition error caused the APS booster to deactivate permanently on the MN.
Fix Description: DB recovery is properly detected now, and the MN returns to operations automatically.
OA-9506
Issue Summary: Changing OACI resource limits in a subscription did not actually change the limits.
Fix Description: Subscription limit updates through the APS bus have been fixed.
OA-9161
Issue Summary: A timeout error when attempting to upgrade Office 365 resources for subscriptions with a large number of users.
Fix Description: The "setResourceTypeLimits" API method performance degradation has been fixed.
General
OA-10450
Issue Summary: a8n-operator used a method to provide application instances that did not guarantee a rollback of all actions.
Fix Description: Now, a8n-operator does not retry an APS instance creation after a failed attempt.
OA-9476
Issue Summary: Synchronization of delegated-on-demand service plans took a significant amount of time.
Fix Description: The synchronization process of Billing entities has been reworked to support parallel processing, making synchronization much faster.
OA-9387
Issue Summary: Security links to L2 resellers were sometimes missing in billing plans and resources.
Fix Description: The problem has been fixed by adding missing security links between resources and accounts to give accounts access to resources.
OA-9128
Issue Summary: Could not specify HTTPS URLs for YUM configuration in the PCP.
Fix Description: Now, HTTPS links can be specified for "Repository proxy URL" and "Repository base URL" in YUM configuration in the PCP and in the "repo-base-url" and "repo-proxy-url" options of the update.py script.
OA-11627
Issue Summary: Prices for disk resources in Cloud Infrastructure offers in the Online Store were sometimes incorrectly displayed as equal to zero due to two types of precision.
Fix Description: The corresponding API has been fixed to return prices with higher precision.
OA-11526
Issue Summary: The "Billing APS entities synchronization" task stalled during resource collection.
Fix Description: Now, Billing APS entities synchronization queue processing is not blocked by any periodic task.
OA-11169
Issue Summary: A deadlock was possible when a reseller was initialized during the reseller synchronization process.
Fix Description: Reseller synchronization task stability has been improved.
OA-10550
Issue Summary: A service plan import failed if an old resource record existed in the source system in the PlanBMResource table but this resource was not used in plans.
Fix Description: Corresponding rows are now removed from the PlanBMResource table on PlanRate removal.
OA-10127
Issue Summary: After synchronization, a reseller was unable to sell delegated plans or their own through UX1 Marketplace.
Fix Description: Now, delegated reseller plans are present in the reseller public context after reseller synchronization.
OA-9848
Issue Summary: Product Helm charts do not support K8s v1.16.
Fix Description: All Deployment and DaemonSet controllers were updated to use apps/v1 as the apiVersion instead of extensions/v1beta1.
OA-9223
Issue Summary: The "Available to modify in trial" option was not propagated to a delegated service plan during synchronization.
Fix Description: The "Available to modify in trial" flag is now synchronized if any option in the "Resources" section is selected.
OA-9195
Issue Summary: An unclear error message was displayed on attempt to open the WHP instance.
Fix Description: A clear error message is now displayed that describes the root cause of the issue.
Account and Plan Configuration
OA-10561
Issue Summary: A role ID of an account's staff member in the APS bus was incorrect after account transfer.
Fix Description: Staff member roles on an APS bus for transferred accounts are correctly updated now.
OA-9101
Issue Summary: The pem.setAccountInfo method must support the "originator" parameter.
Fix Description: The optional parameter "originator" has been introduced for the pem.setAccountInfo OpenAPI method.
OA-12171
Issue Summary: The task that enables the IDP service failed.
Fix Description: Migration from the platform to IDP is now performed without a transaction.
OA-9812
Issue Summary: The IDP database schema differed between clean installation and upgrade.
Fix Description: The database schema is now the same for clean installation and upgrade.
OA-9798
Issue Summary: The "Check and unlock users" task failed.
Fix Description: The non-existing user unlock issue has been fixed.
Control Panel
OA-9485
Issue Summary: Limited cross-site scripting was possible due to the lack of character escaping.
Fix Description: Now a parameter is escaped properly; additional restrictions are also added.
Domains
OA-11506
Issue Summary: DNS zones of disabled domains were propagated to name servers when the pem.syncNameServers API method was called for domains.
Fix Description: The code has been updated to resolve this issue.
OA-11056
Issue Summary: Inactive DNS records are propagated to a NS server after being edited.
Fix Description: The service controller's code is now changed to avoid this issue.
OA-9092
Issue Summary: It was not possible to save custom DNS Hosting settings for a service template.
Fix Description: Now, the issue has been fixed and service template settings are saved correctly.
Platform
OA-10500
Issue Summary: Some MS Office 365 installations failed to open .xls files with "XML Spreadsheet 2003" content.
Fix Description: Now, an Excel file is generated in the .xml format with "XML Spreadsheet 2003" content.
Hosted Exchange
OA-11600
Issue Summary: The CCP stopped responding due to the incorrect column size in a database.
Fix Description: The column size has been increased.
OA-11432
Issue Summary: Hosted Exchange subscriptions with more than 30,000 service users consumed a large amount of memory, which sometimes lead to CCP unavailability.
Fix Description: The SQL query that returns service users has been optimized in the ActiveDirectory service controller. The updated query is faster and uses less memory.
OA-11202
Issue Summary: Migration of Public Folders from Exchange 2007/2010 to Exchange 2013 failed with the error: "PyFormatConnection instance has no attribute 'close'".
Fix Description: The database connection issue has been fixed.
OA-10588
Issue Summary: Empty property values specified in a user profile in OA were not propagated to an AD user.
Fix Description: Propagation of empty property values has been corrected.
OA-9980
Issue Summary: The task for propagation of changed data of a user account that has an Exchange mailbox sometimes failed during removal of that user.
Fix Description: The task for propagation of changed user data has been corrected.
Product Configuration Manager
OA-10328
Issue Summary: Prices for L1 delegated plans were not exported by PCM.
Fix Description: Now, prices for delegated plans are exported as part of changes and applied during import in Product Modeler.
OA-9637
Issue Summary: It was not possible to import offer configuration changes using PCM because the configuration file exceeded the size limit.
Fix Description: The size has been reduced by optimizing "Terms & Conditions" transmission.
OA-10106
Issue Summary: The task to update service templates in PCM failed.
Fix Description: The problem has been fixed by adding a new index in a table column.
OA-9890
Issue Summary: Resource Type limits were not synchronized in a reseller subscription when adding new counted references through PCM.
Fix Description: Limits are now ignored if at least one modified service template is not for a L0 reseller.
OA-9817
Issue Summary: The billing period type was always "Month" in the PCM export file.
Fix Description: Billing period type data is now added to the export JSON structure.
OA-8997
Issue Summary: The "APS Edit Wizard" task failed.
Fix Description: The "APS Edit Wizard: synchronize subscriptions for template(s) {templateId} for "{appUuid}" synchronization task has been changed to process each reseller subscription in a separate transaction.
E-Commerce
OA-8705
Issue Summary: The "Payment_PaymentMethod_Number" placeholder sometimes produced a duplicate payment method number if there were two fraud checks with the same CheckDate.
Fix Description: The filter condition has been edited. Previously, entries were compared by date, whereas now they are compared by ID.
Billing
OA-12431
Issue Summary: A usage report stayed in the "In Progress" status.
Fix Description: A non-empty description in a resource type no longer causes the "Charge Rate" task to fail.
OA-12407
Issue Summary: A usage report could not be uploaded for a canceled subscription.
Fix Description: Now, for subscription mapping, the internal subscription ID is used instead of the pa-subscription UUID.
OA-12371
Issue Summary: A usage report could not be uploaded for a canceled subscription.
Fix Description: Now, during import of charges, the microservice looks up a vendor contract in custom account attributes if a reseller profile was not created in an APS application or cannot be accessed.
OA-11287
Issue Summary: Document import stopped working sometimes.
Fix Description: The algorithm that handles imported documents has been modified to filter out invalid transactions.
OA-11099
Issue Summary: A credit balance was displayed incorrectly in UX1.
Fix Description: The mistake with credit balance calculation has been fixed.
OA-11010
Issue Summary: A customer was wrongly charged during DBP.
Fix Description: Reseller billing now correctly reserves a balance on the SAP side. A SAP balance is not reserved during a reseller's customers’ billing if a reseller has a default payment method configured. The balance is reserved during reseller invoice generation only.
OA-10986
Issue Summary: An issue with special characters processing caused an error.
Fix Description: Special characters are now encoded properly.
OA-10732
Issue Summary: Incorrect text for the Italian locale in UX1.
Fix Description: The text has been corrected.
OA-10410
Issue Summary: A billing order is created for a L1 fake reseller.
Fix Description: Now, provider costs are not included in a fake reseller invoice. Therefore, a fake reseller is not billed for any reseller transactions.
OA-10038
Issue Summary: Documents with the status "Processing Payments" were sometimes displayed as "Open" in UX1 because they ran in parallel.
Fix Description: Threads responsible for document processing and screen reloading are now queued.
OA-9850
Issue Summary: The Rating Engine did not fill the baseBillingDate property for one-time charges.
Fix Description: One-time charges have only "order" and "shipment date" properties. The Rating Adapter now fills baseBillingDate for one-time charges by order or shipment date.
OA-9760
Issue Summary: The Rating Engine service tries to rate a resource that was not defined in the RATING_APPLICATIONS run parameter.
Fix Description: Now, the Rating Adapter component filters resources by the RATING_APPLICATIONS list before passing them to the Rating Engine core for rating.
OA-9755
Issue Summary: The subscriptionID and OItem values were empty in ResellerTrans for subscriptions migrated to Rating Engine.
Fix Description: Now, Rating Adapter fills the order ID field during the conversion of a Rating Engine charge into an order detail by identifying the order ID from the BSS database on the fly.
OA-9659
Issue Summary: Rating Engine failed when selecting a billing period from BSS to rate a change in this period for a migrated subscription.
Fix Description: The billing period selection algorithm has been changed.
OA-9658
Issue Summary: API of the Rating Engine core did not allow passing a quantity for an order line with the CANCEL action.
Fix Description: The Rating Adapter mapper of a BSS order to Rating Engine order has been fixed to skip the quantity when creating an order line with the CANCEL action.
OA-9005
Issue Summary: Cost is calculated only for one subscription when a billing order is created per account.
Fix Description: Filtration by subscription has been added for cost calculation.
OA-8994
Issue Summary: The Rating Engine migrator incorrectly validated dates and amounts for migrated resources due to an incorrect MPN of a purchased resource passed by APS Connector.
Fix Description: Now, the Rating Engine migrator fixes an MPN if it is incorrect.
OA-8863
Issue Summary: The Rating Engine migrator failed during the archiving process because it tried to archive too much data at once.
Fix Description: The archiving process has been split into simple steps.
OA-8862
Issue Summary: The Rating Engine migrator failed because it called Rating Engine with a wrong request to bill a subscription.
Fix Description: The billing request from the Rating Engine migrator has been changed according to the new request structure.
OA-11413
Issue Summary: The "Daily Billing Finished" event failed due to a missing row in ScheduleDetail.
Fix Description: Missing rows are now ignored in ScheduleDetail while calculating subscriptions set to be notified.
OA-11193
Issue Summary: A reseller was billed for a customer's subscription that was transferred to another reseller.
Fix Description: A respective check has been added to Rating Engine. Now, transferred accounts cannot be billed and no extra charges are created.
OA-10234
Issue Summary: BSS APIs applied the wrong "discount versus promotion" priority when both were configured.
Fix Description: Now, a reseller promotion has priority over a discount.
OA-9427
Issue Summary: Control panel outage due to high memory consumption by a scheduler process.
Fix Description: Error handling in Template Condition parsing has been fixed to avoid memory leak.
OA-8699
Issue Summary: A subscription cancelation order changed to "Provisioning Failed" due to an exception in PEMGATE::StopService.
Fix Description: Processing of the rescheduled PemRequest has been fixed to resolve the issue.
OA-8748
Issue Summary: Incorrectly reported resource limits for trial subscriptions in UX1.
Fix Description: The condition that affected resource usage calculation is now fixed.
Web Hosting Module
OA-8458
Issue Summary: The PHP implementation list in webspace settings in UX1 was not sorted.
Fix Description: PHP handlers are now displayed as sorted.
OA-11027
Issue Summary: Resource usage collection on web servers did not work.
Fix Description: The "Collect resources usage statistics from web clusters" task no longer fails on the latest CloudLinux servers.
Migration Manager
OAM-3734
Issue Summary: The Migration Manager updated accounts' locales during the migration between OA modules.
Fix Description: Migration Manager now updates account details during migration between OA modules.
OAM-3731
Issue Summary: Migration manager did not set permissions for a directory after migration from WHL.
Fix Description: Migration Manager now sets permissions for copied web content files from WebHosting Linux.
OAM-3725
Issue Summary: The migration from WebHosting Linux failed if a subscription used a wildcard subdomain.
Fix Description: Migration Manager now skips wildcard subdomains during migration from WebHosting Linux.
OAM-3723
Issue Summary: DNS hosting could not be migrated if DNS zones were configured by using a PHP plug-in.
Fix Description: Migration Manager now links a domain with the PHP plugin if DNS zones were configured using the PHP plugin.
OAM-3721
Issue Summary: Migration to WebHosting Plesk failed with the error: "Request to APS controller failed with status 500." The Migration Manager incorrectly detected the version of an APS resource.
Fix Description: The method for detecting the latest resource version was improved.
OAM-3685
Issue Summary: Pre-migration checks allowed users to migrate subscriptions with exclusive IP addresses even if exclusive IP addresses were not available in the target system.
Fix Description: The pre-migration check now displays the correct text on the pre-check screen.
OAM-3680
Issue Summary: Users could not migrate subscriptions with international domain names from OBAS with Plesk 9.
Fix Description: Migration Manager can now migrate subscriptions with international domain names from OBAS to Plesk 9.
OAM-3673
Issue Summary: After refreshing data about the source system, it took too much time to retrieve information about the objects contained in migration projects.
Fix Description: SQL queries to retrieve information about the source system have been optimized.
OAM-3671
Issue Summary: Web applications installed on subdomains could not be migrated from Plesk 9.
Fix Description: Migration Manager now exports information about web applications installed on subdomains on Plesk 9.
OAM-3665
Issue Summary: Migration Manager reported about the successful completion of migration even if it could not migrate MySQL databases.
Fix Description: Migration Manager now checks the status of MySQL database migration.
OAM-3662
Issue Summary: Microsoft SQL Server databases could not be migrated if the Microsoft SQL Server was registered by its IP address.
Fix Description: Migration Manager searches for a database server by IP address and hostname.
OAM-3661
Issue Summary: Migration Manager could not merge source subscriptions with existing subscriptions in Odin Automation that belonged to another account.
Fix Description: Migration Manager now provides the ability to merge source subscriptions with existing subscriptions in CloudBlue.
Miscellaneous
OA-10831
Issue Summary: An existing promo code was not applied automatically on plan switch in UX1.
Fix Description: Now, a promo code already applied to a subscription is automatically applied on service plan switch in UX1.
OA-10260
Issue Summary: MSRP prices were missing for delegated service plans in UX1.
Fix Description: Now, MSRP prices for delegated service plans are displayed in UX1.
OA-12083
Issue Summary: A promoted subscription was renewed without the promotion applied if a subscription limit was exceeded.
Fix Description: Now, subscriptions stay promoted after renewal. During subscription renewal, the "subscription counter limit" value is no longer checked for an applied promotion. This check is required for purchase orders only.
Documentation
OA-11122
Issue Summary: Ambiguous German localization of "Canceled" in Task Manager.
Fix Description: The German localization of "Canceled" has been corrected.
DOC-1268
Issue Summary: Description of the DocumentsForPeriodByVendorListGet_API method must be improved in Public API Reference.
Fix Description: The "DocumentsForPeriodByVendorListGet_API" section of the Platform XML-RPC API Reference (BSS) has been updated.
DOC-1183
Issue Summary: Information that the PersEmail property must be passed for business accounts in the AccountAdd_API method was absent.
Fix Description: The "AccountAdd_API" section of the Platform XML-RPC API Reference (BSS) guide has been updated to state that PersEmail is relevant for both account types (Business and Personal).
DOC-1176
Issue Summary: The Migration Manager limitation for Plesk Hosting with password containing the "&" symbol was not described.
Fix Description: The corresponding documentation is now updated.
DOC-1165
Issue Summary: An example of an error returned by GetContactsStatus needed to be added to the Domain Plug-in SDK Guide (PHP) guide.
Fix Description: The description of the GetContactsStatus method has been updated in the Domain Plug-in SDK Guide (PHP) guide.
DOC-1151
Issue Summary: The "Additional Information" field in the service plan selection list displayed when placing an order was not described.
Fix Description: The following chapters of the Billing Provider Guide have been updated with information about the "Additional Information" field in the service plan selection pop-up window:
- "Subscribing Customers to Service Plans"
- "Viewing Incompatible Service Plans"
DOC-1141
Issue Summary: The Reporting and Data Export guide was missing information regarding deployment using proxy.
Fix Description: The "Deploying Reporting and Data Export" section of the Reporting and Data Export guide is now updated with the requested information.
DOC-1140
Issue Summary: The description of the "GeoIP" plugin must be updated.
Fix Description: The "Configuring the “GeoIP” Plugin" chapter of the Billing Provider Guide has been updated with a new "Limitations" section.
DOC-1084
Issue Summary: A firewall requirement for the 6310 port was missing in documentation.
Fix Description: The "Hardware and Software Requirements" section of the Linux Platform Deployment guide and the "Odin Automation Management Node" section of the Firewall Configuration guide have been updated.
DOC-938
Issue Summary: An on-screen help topic for a subscription on the "Billing > Subscriptions" screen was missing.
Fix Description: For the subscription "General" tab on-screen help topic, the "Operations Available" subtopic is now added, which describes actions for all available buttons on that tab.
DOC-936
Issue Summary: Actions for bulk import needed to be updated in the Azure CSP documentation.
Fix Description: The "Importing Multiple Azure CSP Subscriptions" section of the Azure CSP Integration guide has been updated.
DOC-930
Issue Summary: Requirements regarding email verification for import needed to be updated in the Azure CSP documentation.
Fix Description: The "Importing an Azure CSP Subscription" section of the Azure CSP Integration guide has been updated.
DOC-895
Issue Summary: The order of purchase scenario representation in the Online Store needed to be described.
Fix Description: The "Adding Custom Store Purchase Scenario" section of the Online Store Guide has been updated with the respective information.
DOC-875
Issue Summary: The description of "Global admin" permissions needed to be improved in the Azure CSP documentation.
Fix Description: The corresponding documentation is now updated.
DOC-846
Issue Summary: Additional details were required regarding "Canceling Usage-based Subscriptions".
Fix Description: The following documentation parts have been updated with the necessary information about how to ensure the correct usage calculation and billing of canceled usage-based subscriptions:
- Billing Provider Guide: "Canceling Usage-based Subscriptions"
- Operations Provider Guide: "Ensuring the Correct Usage Calculation for Canceled Subscriptions" (new),"Creating a Service Template", and "Creating a Custom Service Template"
DOC-815
Issue Summary: The description of the VendorID identifier for the UserValidate_API method was incorrect.
Fix Description: The "UserValidate_API" section of the Platform XML-RPC API Reference (BSS) guide has been updated.
DOC-808
Issue Summary: Firewall requirements for OA DB Replica nodes were not described.
Fix Description: The Firewall Configuration Guide and Linux Platform Deployment Guide have been updated with firewall configuration instructions and deployment instructions for OA Operations DB Replica nodes.
Available Updates (Hotfixes)
CB 20.4.0 HOTFIX PLATFORM v30New features:
The Publication Status of a Resource Rate
Now, a provider can use a resource rate publication status to control its availability at the operating unit level. That is, a service plan can be delegated with or without a resource rate included in this service plan.
For example, if a provider sells the same service plan in different countries controlled by different operating units, they can disable one or more resource rates in this plan for one or more units to make it unavailable for sale in the respective country or countries.
Backward Compatibility
N/A
Activation
No actions are required to enable this feature. It is enabled automatically after the hotfix installation.
Known Limitations
N/A
Learn More
For more details, refer to Managing a Resource Rate Publication Status.
Fixed Issues:
- OA-18376 Purchase from anonymous context was not available from OACI Online Store.
- OA-18359 Java.lang.RuntimeException: Cannot update plan rate.
- OA-17963 Stripe plugin detachment requests to the Credit Card payment method led to the card being blocked.
CB 20.4.0 HOTFIX PLATFORM v20New features:
Invoice Correcting Wizard
Now, the provider can correct non-paid invoices issued incorrectly with Credit or Debit Memos using the invoice correcting wizard. Correcting invoices can be useful when:
A customer is incorrectly charged.
A customer subscription was autorenewed without the customer's consent.
A customer transferred out their services, however, these services were not terminated on the platform.
With the invoice correcting wizard, you can:
Apply a Credit Memo automatically and to one invoice only.
Link a Credit or Debit Memo to an invoice to make reporting more transparent.
Use new notification placeholders:
@@CorrectedDocNUM@and@@CorrectedDocID@.Receive a tax rate used for the invoice calculation and apply it to a Credit or Debit Memo.
Activation
No actions are required to enable this feature. It is enabled automatically after the hotfix installation.
Known Limitations
You cannot create a correcting document for an invoice detail that has a Credit Memo applied. Select uncorrected details to create a new correcting document.
Learn More
For more details, refer to Correcting Invoices.
Fixed Issues:
- OA-16768 Long-running periodic task could block other unrelated periodic tasks.
- OA-17098 It was impossible to switch a plan in UX1 if old and new resources conflict on account level.
- OA-17104 "contains" and "linkedWith" RQL operators missed jsonb.
Available Hotfix List
| Name | Fixed Issues | Comment |
|---|---|---|
| CB 20.4.0 HOTFIX PLATFORM v40 |
| This hotfix also requires:
This hotfix supersedes:
|
| CB 20.4.0 HOTFIX PUI v20 |
| This hotfix also requires:
This hotfix supersedes:
|
| CB 20.4.0 HOTFIX WebCluster v1 |
| |
| CB 20.4.0 HOTFIX Domain SDK v2 |
| This hotfix supersedes:
|
| CB 20.4.0 HOTFIX APS Init Wizard v3 |
| This hotfix also requires: This hotfix supersedes:
|