6 Publish Catalogs
Publish Catalog Entities
Use this topic to know how you can publish your catalog entities to the spoke systems, such as CRM applications for ordering, billing applications for rating and charging, or provisioning applications for fulfillment.
You can publish catalog definitions using either UI or API using initiative-based publishing.
Before publishing, ensure that you have registered the spoke systems and validated the integration between the applications.
For more information on integration, see CX Industries Framework, Doc ID 2720527.1, on My Oracle Support.
Publishing Process
Here's an overview of the publishing process:
-
Register destinations or spoke systems to receive publishing events
-
Package catalog entities for publish using initiatives. Optionally, you can use initiatives to seek and acquire approvals for a lifecycle status completion of your catalog entities, for example, design completion.
-
Publish initiatives
-
Monitor publish jobs
Register destinations or spoke systems to receive publishing events
Register publish destinations before you start the publishing process.
- Log on to the Launch Cloud Service application as a Catalog Administrator.
- Go to Administration > Lifecycle Management.
- Click Save as New Version. This creates a new LCM version (Pending state) in the editable mode.
- Select the new version from the combination box if not already selected.
- Select the Lifecycle Status (LS) state you want to associate with this destination.
In this case it would be Ready to publish. Click the
Edit icon on that row.
Note:
Add destinations to the LS where you enabled publishing (Enable Publish = “Y”). Taking the seeded LS as an example, there are two states that have publishing enabled – Ready to Publish (for publishing to a test workspace of the spoke system) and Active (for publishing to a production workspace of the spoke system). - Click Add Destination.
- Enter the following information:
- Name - <Name of the destination matching with what you will configure in TIC> (CX Industries Framework)
- Type - <Type of application> - for example, CRM, billing, provisioning and so on
- Publish Sequence - <The sequence number in which the publishing should happen>
- Click Add.
After you add the destination, complete the following steps:
- Select the Destinations textbox, where the destination you just created would be listed. Select it and save it.
- On the Entity Lifecycle Status Configuration screen, choose the version you just created.
- Click on the ellipses menu on the right-hand side and click Activate.
- Ensure that the newly created version is in the Active state.
- You've successfully registered a publishing destination in Launch Cloud Service.
- Now the same Destination name should be added as a TIC entry to enable the routing rules (see CX Industries Framework, Doc ID 2720527.1, on My Oracle Support)
- Now you are ready to create a new initiative with artifacts and start publishing to the configured destination.
Note:
Ensure that the destination name you configured here (BuyingTest in the example above) matches with the Fabric routing rules.To view sample screenshots of destination configuration for an Active lifecycle status, see Launch Cloud Service Integration Guide.
For sample payloads on how to create a publish destination, see REST API Reference for Launch Cloud Service.
Package catalog entities for publish using initiatives
For an understanding on catalog entities and how you can collate the entities in an initiative, see Launch Cloud Service User's Guide.
Publish initiatives
When you publish an initiative, the entities such as Catalog, Product Offers, Product Offering Prices and so on are published to spoke systems. You must implement the projectPublishEvent POST operation in the spoke system. To understand the payload and the interface contract, see REST API Reference for Launch Cloud Service
Monitor publish jobs
The publish process is driven by the lifecycle statuses. After you have created a publish job, you can track its status either through API or through the UI.
-
To verify status through UI, see Launch Cloud Service User's Guide.
-
For publishing acknowledgment REST endpoints, see REST API Reference for Launch Cloud Service.
Things to Remember
Do keep the following in mind when preparing to publish:
-
You must set up destinations before initiating a publish action. Try a GET on
https://hostname/crmRestApi/resources/11.13.18.05/atcPublishWorkspaceDestinations/
to verify whether destinations are created. If these aren't created, you must create them using POST payload.Note:
DestinationName should match with the spoke system configuration in CX Industries Framework and the EntryLifecycleStatus must be the initiative lifecycle status from which you would like to publish.
-
After you have registered the spoke systems and implemented the projectPublishEvent POST operation in the spoke systems, you must register the spoke system projectPublishEvent endpoint in the routing rules by initiating the Digital Experience for Communications configuration API.
For more information on setting up routing rules, see CX Industries Framework (2720527.1) on My Oracle Support at https://support.oracle.com. Ensure that the target-preselection-key in the routing rule setup matches with the destination name configured in the first step.
-
The payload received in the spoke system for publishing will contain a bunch of Launch Cloud Service API URLs as HREF as well as acknowledgment URLs.
-
The spoke system must configure the proper user in Launch Cloud Service with the required roles and privileges, so that this user information can be used to generate OAuth token that will be used when the user will initiate direct Launch API calls to gather more details about the referred objects in Launch Cloud Service.
-
After the payload is processed, the spoke system must send the acknowledgment back to Launch Cloud Service about the processing status of the payload using the acknowledgment URL seeded in the payload. The OAuth token must be generated using the same user used in the earlier step.