Prior Versions of Order-to-Activate Cartridges

Updating Prior Versions of the Cartridges to Work with Newer Versions of OSM

It is possible to update prior versions of the Order-to-Activate cartridges to work with newer versions of OSM. To update Order-to-Activate cartridges to work with OSM 7.2 and earlier, see OSM Cartridge Guide for Oracle Application Integration Architecture for the version of OSM you want to use. To update Order-to-Activate cartridges to work with OSM 7.2.2 or later, see OSM Installation Guide for the version of OSM you want to use.

Changes from Order-to-Activate 2.1.1 to Version 2.1.2

This section provides a high-level description of the changes between Order-to-Activate 2.1.1 cartridges and Order-to-Activate 2.1.2 cartridges.

Removed Support for Asset Processing

The changes that were made in version 2.1.1 to the Order-to-Activate cartridges to support managing assets on orders that come from Oracle Configure, Price, and Quote Cloud (Oracle CPQ Cloud) have been removed. The corresponding functionality is no longer available in the OSM product. Oracle recommends that you use corresponding functionality in Oracle Configure, Price, Quote (CPQ) Cloud for your hybrid cloud solution.

Processes Changed to Use a Single Task for Sending and Receiving

Starting in the Order-to-Activate cartridges version 2.1.2, system interaction processes have been modified to use a single task to handle both sending a message to an external system and receiving the response messages. The purpose of this change is to greatly simplify the process design by allowing the same task to handle all of the normal and exception processing for the message, and complements functionality introduced in OSM 7.3.

Central Order Management Fulfillment Functions

Following is a summary of the processing for the central order management fulfillment functions.

SyncCustomerFunction: The process for this function is SyncCustomerSubProcess. The tasks are:
- SyncCustomerEntryPointTask: This task sets up the data for the system interaction task, determines whether there are any open trouble tickets for the current instance of the function, and if so closes them. It also provides a breakpoint.
- SyncCustomerSITask: This task creates and sends a request to the billing system. If the billing system has an error, it notifies fallout management directly, and then fallout management sends a notification to this task, which causes the state of the task to enter fallout mode and change its state to WaitForFalloutRecovery. You can manually transition the task from this state to the resolveFailAndRetry state to return to normal mode and retry the task. Alternatively, an amendment can be received to retry the task automatically. The task also provides a breakpoint if a successful response ifs received.
InitiateBillingFunction: The process for this function is InitiateBillingSubProcess. The tasks are:
- InitiateBillingEntryPointTask: This task works like SyncCustomerEntryPointTask.
- InitiateBillingSITask: This task works like SyncCustomerSITask.
FulfillBillingFunction: The process for this function is FulfillBillingSubProcess. The tasks are:
- FulfullBillingStartTask: This task provides the opportunity for an extra breakpoint for this process.
- InitiateBillingEntryPointTask: This task works like SyncCustomerEntryTask.
- InitiateBillingSITask: This task works like SyncCustomerSITask.
ProvisionOrderFunction: The process for this function is ProvisionOrderSubProcess. The tasks are:
- ProvisionOrderEntryPointTask: This task works like SyncCustomerEntryPointTask.
- ProvisionOrderSITask: This task works like SyncCustomerSITask, except that it sends the request to the service order management system rather than the billing system.

Service Order Management Fulfillment Functions

Following is a summary of the processing for the service order management fulfillment functions. These fulfillment functions are available only with the Calculate Service Order solution option.

DesignServiceFunction: The process for this function is DesignServiceProcess. The tasks are:
- CaptureBITask: This task creates and sends the capture business interaction request to the inventory system. If the inventory system has an error, it returns a failure response directly to the task, which causes the state of the task to enter fallout mode. You can manually retry the task by changing the state to received, or you can transition the task to WaitForFalloutRecovery, which causes a failure message to be sent to the central order management system. You can manually transition the task from this state to the resolveFailAndRetry state to return to normal mode and retry the task. Alternatively, an amendment can be received to retry the task automatically. It also provides a breakpoint if a successful response ifs received.
- ProcessBITask: This task creates and sends the process business interaction request to the inventory system. If the inventory system has an error, it returns a failure response directly to the task, which causes the state of the task to enter fallout mode. You can manually retry the task by changing the state to received, or you can transition the task to WaitForFalloutRecovery, which causes a failure message to be sent to the central order management system. You can manually transition the task from this state to the resolveFailAndRetry state to return to normal mode and retry the task. Or you can transition the task to clearFallout to ignore the error and complete the task successfully. Alternatively, an amendment can be received to retry the task automatically. The task also provides a breakpoint if a successful response ifs received.
- ApproveBITask: This task works like ApproveBITask, except that it sends the approve business interaction request.
PlanDeliveryFunction: The process for this function is PlanDeliveryProcess. The tasks are:
- IssueBITask: This task works like ApproveBITask, except that it sends the approve business interaction request.
- CalculateTechnicalActionsTask: This task works like ApproveBITask, except that it sends the calculate technical actions request.
DeliverOrderFunction: The process for this function is DeliverOrderProcess. The tasks are:
- CreateTechnicalOrderTask: This task works like ApproveBITask, except that it sends the create technical order request to the technical order management system.
- QueryBITask: This task gets the Service Configuration details from the Inventory system and updates the service order with the new Service Configuration.
CompleteProvisioningFunction: The process for this function is CompleteProvisioningProcess. The tasks are:
- CompleteBITask: This task works like ApproveBITask, except that it sends the complete business interaction request.

Changes from Order-to-Activate 2.1.0.2 to Version 2.1.1

This section provides a high-level description of the changes between Order-to-Activate 2.1.0.2 cartridges and Order-to-Activate 2.1.1 cartridges.

Support for Asset Processing

Changes have been made to the Order-to-Activate cartridges to support managing assets on orders that come from Oracle Configure, Price, and Quote Cloud (Oracle CPQ Cloud). During installation of the Order-to-Activate cartridges, you can select whether to enable asset processing using the standard OSM Customer Asset Manager, an external asset manager, or both. If you decide to use an external asset manager, you can configure the format of the message.

Support for Order Lifecycle Management User Interface

The Order-to-Activate cartridges have been updated to include an Order Lifecycle Manager entity in support of the new OSM Order Lifecycle Management user interface.

OSM order components previously included a "Minimum Processing Duration." Now, instead of one duration, there are three: Optimistic, Most Likely, and Pessimistic Processing Durations. These processing durations drive information in the Order Lifecycle Manager user interface. Since the order components for the Order -to-Activate cartridges are in sealed cartridges, changing these durations in Order Component Specification editor is not recommended. An XML file is provided to allow changing these durations without needing to unseal the cartridge. See "Changing Durations for Order Components" for more information on changing durations.

Support for Processing States

Processing states were added in OSM 7.3 at both the order item level and the order component order item level. The use of processing states provides better visibility into fulfillment progress, including warnings and errors that occur during the processing of order items. The Order-to-Activate 2.1.1 cartridges incorporate this new OSM feature.

Changes from Order-to-Activate 2.1.0.1 Cartridges to Version 2.1.0.2

This section provides a high-level description of the changes between Order-to-Activate 2.1.0.1 cartridges and Order-to-Activate 2.1.0.2 cartridges.

Changes to Fulfillment Function Extension Points

This section describes the changes to the fulfillment function extension points for the Order-to-Activate 2.1.0.2 cartridges.

New Extension Points

The following extension points were added in version 2.1.0.2:

CREATE-EBM-CUSTOM
CREATE-EBM-ALL-ORDERITEMS
CREATE-EBM-ORDERITEM
CREATE-EBM-ORDERITEM-CUSTOM
CREATE-EBM-PRIORORDERITEM
CREATE-EBM-PRIORORDERITEM-CUSTOM

Extension Points Added to the Billing Components

XQuery files for the following extension points have been added in the OracleComms_OSM_O2A_COM_Billing cartridge for the SyncCustomerFunction, InitiateBillingFunction, and FulfillBillingFunction billing functions:

CREATE-EBM-ALL-ORDERITEMS
CREATE-EBM-CUSTOM
CREATE-EBM-ORDERITEM-CUSTOM
CREATE-EBM-ORDERITEM (execution mode: do)
CREATE-EBM-ORDERITEM (execution mode: redo)
CREATE-EBM-ORDERITEM (execution mode: undo)
CREATE-EBM-PRIORORDERITEM-CUSTOM
CREATE-EBM-PRIORORDERITEM
COMPONENT-RESPONSE-UPDATE

For more information, see "OracleComms_OSM_O2A_COM_Billing."

Changes to Action Code Mappings

Some action code mappings for solutions using the Calculate Service Order solution option were changed to support the Oracle Communications Rapid Offer Design and Order Delivery (RODOD) and Oracle Communications Rapid Service Design and Order Delivery (RSDOD) solutions. The changes are summarized in the following table:

Table 7-1 Changes to Action Code Mappings for Order-to-Activate 2.1.0.2

Upstream Action Code	Action Code Prior to Version 2.1.0.2	Action Code in Version 2.1.0.2 and later
Move-Delete	Move-Delete	[Action is no longer mapped]
Move-Add	Move-Add	Move
Update	Update	Change

New XML-type Parameter Added to Contain Custom Order Item Properties

A new XML-type parameter is available in the COM_Sales_OrderFulfillment order template. It allows you to add custom order item properties to your order template without unsealing any cartridges. For more information, see "Adding Custom Order Item Properties."

Changes from Order-to-Activate 2.1.0 Cartridges to Version 2.1.0.1

This section provides a high-level description of the changes between Order-to-Activate 2.1.0 cartridges and Order-to-Activate 2.1.0.1 cartridges.

New Silent Installation Option

A new option to install and deploy the Order-to-Activate cartridges in an OSM environment without running the interactive installers has been added. See "Performing a Silent Installation of the Order-to-Activate Cartridges" for more information.

Changes from Order-to-Activate 2.0.1 Cartridges to Version 2.1.0

This section provides a high-level description of the changes between Order-to-Activate 2.0.1 cartridges and Order-to-Activate 2.1.0 cartridges.

Support for Calculate Service Order

The order transformation manager was introduced in OSM 7.2.4 to provide a mechanism to transform order items from transform incoming order items into different order items. The Order-to-Activate 2.1.0 cartridges provide the option to use this feature.

Two Solution Options: With and Without Calculate Service Order

The Order-to-Activate 2.1.0 cartridges provide two distinct solution options: the calculate service order solution option and the solution option without calculate service order. Although most new Order-to-Activate users will want the increased functionality of the calculate service order solution option, having the solution option without calculate service order enables existing customers to access the new functionality of Order-to-Activate 2.1.0 without using the order transformation manager if desired.

Note:

Oracle Communications Order and Service Management Order Transformation Manager, available in OSM 7.2.4 and later, is a pre-requisite for using the calculate service order functionality in the Order-to-Activate cartridges.

The same Order-to-Activate cartridge installer contains both the cartridges for the calculate service order solution option and the solution option without calculate service order. At a high level, the two options are:

The calculate service order solution option incudes:
- Central order management: This includes cartridges with support for the calculate service order implementation of the OSM order transformation manager. It also includes enhancements like large order support and sharing groups.
- Service order management: This includes new service order management cartridges designed to work with the central order management cartridges that use calculate service order. For more information, see "New Service Order Management Cartridges for the Calculate Service Order Solution Option."
The solution option without calculate service order includes:
- Central order management: This includes cartridges that do not have support for calculate service order, but do include other enhancements like large order support and sharing groups
- Service order management: These cartridges are functionally the same as the service order management cartridges in the Order-to-Activate 2.0.1.

For more information about the solution options, see "Order-to-Activate Cartridge Solution Options."

The Calculate Service Order Solution Option

The calculate service order solution option uses the OSM order transformation manager feature. It is driven by a transformation sequence that is configurable with any number of transformation stages. Each sequence uses original order items as input, executes simple transformation logic for each stage, and creates transformed order items as output.

Productized Order-to-Activate cartridges are enhanced to support transformation of customer order items to service order items using the order transformation manager. The function that transforms customer order lines to service order lines is referred to as calculate service order. Calculate service order is a stable and domain-agnostic function that requires few changes when new products or services are introduced, which reduces the time to market for new product or service introduction. In the Order-to-Activate 2.1.0 cartridges, the calculate service order function is added in the central order management layer.

New Service Order Management Cartridges for the Calculate Service Order Solution Option

New service order management cartridges are added to work with the central order management calculate service order functionality. Domain-agnostic service order management cartridges contain features to support different types of orders such as new orders, revision orders, and change orders. It also has a framework to support fallout and point-of-no-return processing. It has emulators for inventory and technical order management (typically used for activation), so that service order management cartridges can be tested independently of external systems.

For more information about the service order management cartridges for the calculate service order option, see "Service Order Management Cartridges for the Calculate Service Order Solution Option."

Inclusion of Conceptual Model Projects

Conceptual model projects were introduced in Oracle Communications Design Studio 7.2.4 to help you define the relationships between your commercial products, the services that they represent, and the resources that are required to implement the services. Both of the solution options include conceptual model projects.

For more information about the conceptual model, see Design Studio Concepts. For more information about the conceptual model projects included with the Order-to-Activate cartridges, see "Conceptual Model Projects."

Large Order Support

OSM 7.2.4.1 introduced functionality to support the processing of orders containing thousands of lines. The Order-to-Activate 2.1.0 cartridges have incorporated this functionality in both of the solution options (with and without calculate service order).

Support for Sharing Groups

The Sharing Groups feature allows discounts, resources and charges like free minutes to be shared across multiple accounts. For example, if a group owner is sharing free minutes, a member is charged for usage, and then discount credits are applied to the member's account and free minutes are deducted from the group owner.

This feature is introduced in the Oracle Communications Rapid Offer Design and Order Delivery (RODOD) solution, and the central order management cartridges for both of the solution options (with and without calculate service order) have been enhanced to support this feature. For more information about this feature, see the information about promotion groups in Oracle Application Integration Architecture Oracle Communications Order to Cash Integration Pack Implementation Guide for Siebel CRM, Oracle Communications Order and Service Management, and Oracle Communications Billing and Revenue Management, Release 11.4.

Changes from Order-to-Activate 7.2 Cartridges to Version 2.0.1

This section provides a high-level description of the changes between Order-to-Activate 7.2 cartridges and Order-to-Activate 2.0.1 cartridges.

Release Number Changes and Packaging Changes

This release of the Order-to-Activate cartridges contains changes to the way releases are numbered and changes to the way the cartridges are packaged.

Through the OSM 7.2 release, the Order-to-Activate cartridges were released at the same time as the OSM software, and the release numbers for OSM and Order-to-Activate were the same. Now however, Oracle has decided to separate the OSM and Order-to-Activate releases. The Order-to-Activate releases are now being aligned toward the Oracle Application Integration Architecture (Oracle AIA) releases. Because of these changes, the Order-to-Activate cartridges are being given their own release numbers. Order-to-Activate 2.0.1 is the first in the new version number series. Release numbers for the older versions of the Order-to-Activate cartridges are not being updated.

Order-to-Activate cartridges are also separate from the OSM software on the Oracle Software Delivery website, and patches for the Order-to-Activate cartridges will be released separately from OSM patches. For more information, see Cartridges for Oracle Application Integration Architecture Release Notes, Release 2.0.1.

Support for Multiple Price Lists

Previously, the productized integration supported only one default price list, so price list information was not included on the order. In Order-to-Activate 2.0.1, the price list has been added to the order so that multiple price lists can be supported.

Price list information is passed from Oracle AIA to the Order-to-Activate cartridges as part of the ProcessSalesOrderFulfillmentEBM message. the Order-to-Activate cartridges then populate the order item into the order template. When interacting with the billing system, the Order-to-Activate cartridges generate a ProcessFulfillmentOrderBillingEBM, which includes the price list information base on the Oracle AIA EBM schema.

The price list information is populated into the following structure in OSM:

/ControlData/Functions/FunctionName/orderItemRef/orderItem/BaseLineItemData/SalesOrderSchedule/PriceListReference

Support for Importing Product Classes Directly from Oracle Product Hub

It is possible to query product classes and transaction attributes into Design Studio directly from the Oracle Product Hub. Design Studio users use the existing Oracle AIA interface QueryProductClassAndAttributesSCECommsReqABCSImpl to import product classes from both Siebel Customer Relationship Management (Siebel CRM) and the Product Hub. When product classes are queried using this interface, the interface API checks for Product Hub implementation in the Oracle Communications Order to Cash implementation, and if it is there, the product classes are imported to Design Studio from Product Hub. If Product Hub is not present in the Order to Cash implementation, the product classes are imported into Design Studio from Siebel CRM.

Changes from Order-to-Activate 7.0.3 Cartridges to Version 7.2

This section provides a high-level description of the changes between Order-to-Activate 7.0.3 cartridges and Order-to-Activate 7.2 cartridges.

Cartridge Re-Factoring Overview

In version 7.2, the Order-to-Activate cartridges have been reorganized to make use of cartridge extensibility. The changes include:

The cartridges have been renamed with the prefix OracleComms_OSM_O2A_.
Composite cartridges have been introduced.
The base cartridges for central order management and service order management have been re-factored into multiple cartridges per fulfillment system.
Cartridges that ordinarily should not be modified have been sealed. Cartridges that can be modified are not sealed and have the suffix _Sample.
Fulfillment states have been implemented.
The order template for a function is now constructed from OracleComms_OSM_CommonDataDictionary and the local data dictionary OracleComms_OSM_O2A_COM_Function according to general recommendations for working with the common data dictionary.
Composite cartridge views have been created to add task data to COM_SalesOrderFulfillment_CreationTask, COM_SalesOrder_StateChangeView, and COM_SalesOrder_AggregatedOLMView.
The order component GetCommunicationsServiceConfigurationDetails has been removed from service order management.

Cartridge Mapping Between Order-to-Activate 7.0.3 and Order-to-Activate 7.2

Table 7-2 shows the functional mapping between the Order-to-Activate 7.0.3 cartridges and the Order-to-Activate 7.2 cartridges. See "Cartridge Overview" for descriptions of the Order-to-Activate 7.2 cartridges.

Table 7-2 7.0.3-to-7.2 Order-to-Activate Cartridge Mapping

Order-to-Activate 7.0.3 Cartridge	Order-to-Activate 7.2 Cartridge
[No equivalent]	OracleComms_OSM_CommonDataDictionary
OracleCgbuOsmAIAInstallation	OracleComms_OSM_O2A_Install
OracleCgbuAIAComponentsDataDictionaryPIP	OracleComms_OSM_O2A_AIAEBMDataDictionary
OracleCgbuCommonDataDictionaryPIP	OracleComms_OSM_O2A_CommonUtility
OracleCommSystemAdminOrders	OracleComms_OSM_O2A_SystemAdmin
OracleCgbuControlMap	OracleComms_OSM_O2A_ControlMap
OracleCgbuSIFalloutPIP	[Merged into OracleComms_OSM_O2A_COM_Base]
CommunicationsSalesOrderFulfillmentPIP	OracleComms_OSM_O2A_COM_Base OracleComms_OSM_O2A_COM_SalesOrderFulfillment OracleComms_OSM_O2A_COM_Shipping_Sample OracleComms_OSM_O2A_COM_Billing OracleComms_OSM_O2A_COM_Provisioning OracleComms_OSM_O2A_COM_Install_Sample
OracleCgbuProvisioningFallout	[Merged into OracleComms_OSM_O2A_SOM_Base]
CommunicationsProvisioningOrderFulfillmentPIP	OracleComms_OSM_O2A_SOM_Base OracleComms_OSM_O2A_SOM_Provisioning OracleComms_OSM_O2A_SomBBVoIPFulfillmentPattern_Sample
OracleCgbuCommunicationsORPFalloutPIP	OracleComms_OSM_O2A_RecognitionFallout
[Drawn from various base cartridges]	OracleComms_OSM_O2A_COMSOM_Recognition_Sample
[Drawn from various base cartridges]	OracleComms_OSM_O2A_COM_Recognition_Sample
[Drawn from various base cartridges]	OracleComms_OSM_O2A_SOM_Recognition_Sample
OracleCgbuDoublePlayProductMap	OracleComms_OSM_O2A_FulfillmentPatternMap_Sample
DoublePlayProductSpecificationNile	OracleComms_OSM_O2A_BBVoIPFulfillmentPatternNileFlow_Sample
DoublePlayProductSpecificationDanube	OracleComms_OSM_O2A_BBVoIPFulfillmentPatternDanubeFlow_Sample
OracleCgbuDoublePlayProductSpecNileTdDcn	OracleComms_OSM_O2A_BBVoIPFulfillmentPatternNileFlowDcn_Sample
TypicalSalesOrderFulfillment	OracleComms_OSM_O2A_TypicalTopology_Sample
SimpleSalesOrderFulfillment	OracleComms_OSM_O2A_SimpleTopology_Sample
OracleCgbuTypicalSalesOrderFulfillment	[Cartridge has been removed, but functionality is duplicated in OracleComms_OSM_O2A_ControlMap]
BroadbandServicesProvisioning	OracleComms_OSM_O2A_SomProvisionBroadband_Sample
VoIPServiceProvisioning	OracleComms_OSM_O2A_SomProvisionVoIP_Sample
SalesOrderSubmission	OracleComms_OSM_O2A_SalesOrders_Sample