The following Web Services features are available in Oracle CPQ 20B. Migration REST APIs
Task REST API Updates MIGRATION REST APIS
Oracle CPQ 20B provides the following Migration REST APIs to streamline the distribution and deployment of migration packages to different environments. Refer to REST API topics in Oracle CPQ Administration Online Help or REST API Services for Oracle CPQ in the Oracle Help Center for additional information and examples. Get List of Migration Packages
Use this endpoint to retrieve a list of migration packages. The REST API returns the following items for each package: name, identifier, version, description, release date, date added, date modified, and dependencies.
Endpoint: /rest/v9/migrationPackages Method: GET
1. 2.
Use this endpoint to retrieve the properties for the specified migration package. The REST API returns the following items: name, identifier, version, description, release date, date added, date modified, and dependencies.
:
Endpoint /rest/v9/migrationPackages/{identifier} : GET
Method
Import Migration Package
Use this endpoint to import and apply a migration package. Specify the file to import in the request body. The request can also contain a description, target process name, a notification email address, an option to include a snapshot, and the option to delete other versions of the package. The REST API returns the import task Id.
:
Endpoint /rest/v9/migrationPackages/actions/import : POST
Method
A task is initiated when you import a migration package. After importing the migration package, you can view the status of the import and cancel the migration package, if required.
To view the status of the migration package import initiate the Get Task REST API using the task id from the Import Migration Package REST API response.
To cancel the migration package import initiate the Cancel Task REST API using the task id from the Import Migration Package REST API response.
Export Migration Package
Use this endpoint to export the specified migration package. Dependencies are included by default, but the request can contain an optional parameter to exclude dependencies. The REST API returns the export task Id.
:
Endpoint /rest/v9/migrationPackages/{identifier}/actions/export : POST
Method
A task is initiated when you export a migration package and the migration package zip file will be associated with the task. After exporting the migration package, you can view the status of the export and download the exported migration package.
To view the status of the migration package export initiate the Get Task REST API using the task id from the Export Migration Package REST API response.
To download the exported migration package complete the following:
Initiate the Get Task File List REST API using the task id from the Export Migration Package REST API response.
Initiate the Download Task File REST API using the file name from the Get Task File List REST API. STEPS TO ENABLE
Review the REST service definition in the REST API guides, available from the Oracle Help Center > your apps > REST API. If you're new to Oracle's REST services you may want to begin with the service area of interest
Quick Start section.
TIPS AND CONSIDERATIONS
Refer to the Get List of Tasks REST API for instructions to view migration package status items. TASK REST API UPDATES
Oracle CPQ 20B introduces new task categories to support migration services. In addition to new categories, there is a new endpoint and method for cancelling tasks.
Get List of Tasks
The Get List of Tasks REST API was introduced in Oracle CPQ 19D to retrieve data table status tasks. Oracle CPQ 20B adds the following categories to support migration tasks:
'51' Migration Package import tasks '52' Migration Package export tasks
You can use the following category query to list migration tasks: :
Endpoint /rest/v9/tasks/?q={category:{$in:['51','52']}} Cancel Task
IMPORTANT: The /tasks/{taskId}/actions/cancel endpoint is deprecated in Oracle CPQ 20B. Use the following endpoint to cancel tasks.
Oracle CPQ 20B introduces a new endpoint and method for cancelling tasks, such as deploying, exporting, and importing data tables. This endpoint also supports cancelling migration package imports. The request must contain the "Cancellation Requested" status. The REST API returns the id, date modified, name, category, status, execution time, and date added for the task being cancelled.
:
Endpoint /rest/v9/tasks/{taskId} : PATCH
Method
:
Required Request Body Parameter {"status": "Cancellation Requested"} STEPS TO ENABLE
Review the REST service definition in the REST API guides, available from the Oracle Help Center > your apps service area of interest > REST API. If you're new to Oracle's REST services you may want to begin with the Quick Start section.
To enhance Oracle CPQ security, the bulk upload services no longer support upload of custom XML files that contain <!DOCTYPE> tags. An attempt to upload a custom document type definition using the bulk uploader results in the following error message: Could not parse the Upload XML: DOCTYPE is disallowed when the feature "http://apache.org/xml/features/disallow-doctype-decl" set to true. Oracle CPQ 20B implements XML Translation Line Limits to prevent performance issues that could occur when generating XML for quotes with an extremely large number of transaction lines.
The Deal Negotiation "Last Price Paid" functionality is now implemented using the Price Guidance feature. The attribute values for existing line items using the Last Price Paid object for Commerce transaction line Currency attributes will remain, but the attribute value will not be populated for new line items. Refer to the Price Guidance topic in Oracle CPQ Administration Online Help for an alternative solution for this functionality.
Beginning in Oracle CPQ 21A, we will support the current REST version and the two previous REST versions. Older (three versions back and earlier) REST versions may continue to function; however, Oracle will not address new issues that arise. We recommend you plan for this transition.
As previously announced, Oracle CPQ 20B supports Antenna House for XSL/XML formatting. We are no longer supporting Apache FOP. We recommend you plan for this transition prior to upgrading to 20B.
Custom JavaScript
If customers have added custom JavaScript that leverages the Document Object Model structure or specific elements, classes or IDs, this customization should be thoroughly tested and may require refactoring. For more information about custom JavaScript, go to Style & Templates > JET JavaScript Customization in the Oracle CPQ Administration Online Help.
Migration
When migrating directly from a source site or to a destination site using the Migration Center, both sites must use the same major update. The migration of content can only occur across minor updates within the same major update.
“Major update” = Update 20B
“Minor update” = Update 20B Patch 1
For Oracle CPQ 20B, migration packages from 19A and forward can be uploaded to the latest site version. Resolved Known Issues
For information on bugs fixed in Update 20B, refer to the Oracle CPQ 20B Resolved Known Issues document available on My Oracle Support and the Oracle CPQ Administration Online Help.
Translation
For some system-defined messages and components, strings were removed and others added in Oracle CPQ 20B. If you have created your own implementation-specific translations of system-defined strings, some of these strings may no longer appear. Other strings may appear in English. The strings appearing in English are new and require translation.
Most of these messages and components are on the Administration side of Oracle CPQ, but you should review both your end user and administration pages before deploying your updated installation to confirm that all