4 Order-to-Activate Cartridge Contents

This chapter describes the various Order-to-Activate cartridges, their entities, and how these entities can be extended.

Note:

In the Oracle Communications Order to Cash solution, Oracle Communications Order and Service Management (OSM) does not directly interact with Oracle Communications Billing and Revenue Management (BRM), Siebel Customer Relationship Management (Siebel CRM), or provisioning systems. OSM uses Oracle Application Integration Architecture (Oracle AIA), which in turn uses BRM Application Business Connector Service (ABCS) for billing and CRM ABCS for Siebel CRM.

Cartridge Overview

Following is an overview of the cartridges. You should not modify productized cartridges, but demonstration cartridges are sample cartridges provided so that you can modify them to meet your needs.

Common Order Management Cartridges

Common order management cartridges contain data and entities that are available in all solution options and topologies.

Table 4-1 lists and describes the common order management cartridges.

Table 4-1 Common Order Management Cartridges

Cartridge Name	Description
OracleComms_OSM_CommonDataDictionary	Productized cartridge. Orchestration Common ControlData dictionary (core Oracle Communications Design Studio product cartridge)
OracleComms_OSM_O2A_AIAEBMDataDictionary	Productized cartridge. This data dictionary cartridge contains the data schema that defines the data elements from the Oracle AIA Enterprise Business Message (EBM) schema.
OracleComms_OSM_O2A_CommonUtility	Productized cartridge. This data dictionary cartridge contains the data schema that defines the data elements for modeling orchestration entities in OSM.
OracleComms_OSM_O2A_ControlMap	Productized cartridge. This cartridge provides testing utilities including breakpoints, point of no return disabling, and support for fault simulation.
OracleComms_OSM_O2A_RecognitionFallout	Productized cartridge. This cartridge generates Oracle AIA trouble ticket creation request messages for unrecognizable customer order messages.
OracleComms_OSM_O2A_SystemAdmin	Productized cartridge. This cartridge works in conjunction with the Inbound Message Recovery message-driven bean (MDB) to create fallout tasks that help you recover from inbound message processing errors.

Central Order Management Cartridges

Central order management cartridges contain the processes for the central order management functionality and also the Oracle AIA interaction mechanism which in turn interacts with Siebel CRM, BRM, and OSM in its service order management role.

Some central order management cartridges are common to both the solution option that uses calculate service order and the solution option that does not. Other cartridges are specific to one solution option or the other.

Common Central Order Management Cartridges

Table 4-2 lists the central order management cartridges that are used by both the calculate service order solution option and the service option without calculate service order.

Table 4-2 Common Central Order Management Cartridges

Cartridge Name	Description
OracleComms_OSM_O2A_COM_Base	Productized cartridge. This cartridge supports the orchestration of customer orders from Oracle AIA.
OracleComms_OSM_O2A_COM_SalesOrderFulfillment	Productized cartridge. This cartridge supports the communications between central order management and fulfillment systems.
OracleComms_OSM_O2A_COM_Billing	Productized cartridge. This cartridge supports billing fulfillment functions.
OracleComms_OSM_O2A_COM_Provisioning	Productized cartridge. This cartridge supports provisioning fulfillment functions.
OracleComms_OSM_O2A_COM_Shipping_Sample	Demonstration cartridge. This cartridge supports shipping fulfillment functions.
OracleComms_OSM_O2A_COM_Install_Sample	Demonstration cartridge. This cartridge supports installation fulfillment functions.
OracleComms_OSM_O2A_COM_Recognition_Sample	Demonstration cartridge. This cartridge recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. It is used for both solution options when the workspace contains only central order management.
OracleComms_OSM_O2A_COM_Asset	Demonstration cartridge. This cartridge recognizes an order that should create a COM_AssetIntegration order for an external asset management system, triggers creation of the order, and handles order processing.

Central Order Management Cartridges for the Calculate Service Order Solution Option

Table 4-3 lists and describes the central order management cartridges for the Calculate Service Order solution option.

Table 4-3 Central Order Management Cartridges for the Calculate Service Order Solution Option

Cartridge Name	Description
OracleComms_OSM_O2A_COM_CSO_Base	Productized cartridge. This cartridge contains entities, like orchestration processes, order items, and transformation sequences, that support the orchestration of orders for the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_Broadband_Internet_Access_CFS	Demonstration cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for broadband internet access.
OracleComms_OSM_O2A_COM_CSO_Email_CFS	Demonstration cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for email service.
OracleComms_OSM_O2A_COM_CSO_FulfillmentPattern	Productized cartridge. This cartridge contains fulfillment patterns and orchestration dependencies for the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_FulfillmentStateMap	Productized cartridge. This cartridge contains fulfillment state maps and transformed order item fulfillment state composition rule sets specific to the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_Internet_Media_CFS	Productized cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for Internet media service.
OracleComms_OSM_O2A_COM_CSO_IP_Fax_CFS	Productized cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for IP fax service.
OracleComms_OSM_O2A_COM_CSO_Model_Container	Demonstration cartridge. This cartridge defines the common model projects that contain elements that might need to be included in the deployment and contains the transformation manager for the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_Provisioning	Demonstration cartridge. This cartridge contains order components for provisioning that are specific to the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_SalesOrders	Demonstration cartridge. This cartridge contains sample customer orders for use with the calculate service order solution option.
OracleComms_OSM_O2A_COM_CSO_Solution	Demonstration composite cartridge. This cartridge references all cartridges required when the calculate service order solution option is used and the current workspace is for central order management only.
OracleComms_OSM_O2A_COM_CSO_Topology	Productized cartridge. This cartridge contains decomposition rules and order components for the topology you selected when installing the Order-to-Activate cartridges.
OracleComms_OSM_O2A_COM_CSO_VoIP_Access_CFS	Demonstration cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for Voice over Internet Protocol (VoIP) access.
OracleComms_OSM_O2A_COM_CSO_Web_Conferencing_CFS	Productized cartridge. This cartridge contains the mapping rules and order item parameter bindings associated with the customer facing service for web conferencing service.
OracleComms_OSM_O2A_COM_FulfillmentPattern	Productized cartridge. This cartridge contains the base fulfillment pattern from which other fulfillment patterns can inherit.
OracleComms_OSM_O2A_COM_FulfillmentStateMap_Sample	Demonstration cartridge. This cartridge contains fulfillment state entities used by the solution.
OracleComms_OSM_O2A_COMSOM_CSO_Recognition	Demonstration cartridge. This cartridge recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. It is used when the current workspace includes both central order management and service order management.
OracleComms_OSM_O2A_COMSOM_CSO_Solution	Demonstration composite cartridge. This cartridge references all cartridges required when the calculate service order solution option is used and the current workspace is for both central order management and service order management.

Central Order Management Cartridges for the Solution Option Without Calculate Service Order

Table 4-4 lists and describes the central order management cartridges for the solution option without Calculate Service Order.

Table 4-4 Central Order Management Cartridges for the Solution Option Without Calculate Service Order

Cartridge Name	Description
OracleComms_OSM_O2A_BBVoIP_FP_NP_Danube_Sample	Demonstration cartridge. This cartridge contains fulfillment patterns and orchestration dependencies for the Simple topology.
OracleComms_OSM_O2A_BBVoIP_FP_NP_Nile_Sample	Demonstration cartridge. This cartridge contains fulfillment patterns and orchestration dependencies for the Typical or Complex topologies.
OracleComms_OSM_O2A_COM_NCSO_Base	Productized cartridge. This cartridge supports the orchestration of customer orders from Oracle AIA.
OracleComms_OSM_O2A_COM_NCSO_Provisioning	Productized cartridge. This cartridge supports provisioning fulfillment functions.
OracleComms_OSM_O2A_COM_Simple_NP_Soln	Demonstration composite cartridge. This cartridge references all cartridges required for the Simple topology for central order management.
OracleComms_OSM_O2A_COM_Typical_NP_Soln	Demonstration composite cartridge. This cartridge references all cartridges required for the Typical or Complex topologies for central order management.
OracleComms_OSM_O2A_COMSOM_Recognition_Sample	Demonstration cartridge. This cartridge recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. It is used when the current workspace includes both central order management and service order management.
OracleComms_OSM_O2A_COMSOM_Simple_NP_Soln	Demonstration composite cartridge. This cartridge references all cartridges required for the Simple topology. It is used when the current workspace includes both central order management and service order management.
OracleComms_OSM_O2A_COMSOM_Typical_NP_Soln	Demonstration composite cartridge. This cartridge references all cartridges required for the Typical or Complex topologies. It is used when the current workspace includes both central order management and service order management.
OracleComms_OSM_O2A_FulfillmentPatternMap_Sample	Demonstration cartridge. This cartridge contains the mappings between product specifications and fulfillment patterns.
OracleComms_OSM_O2A_SalesOrders_NP_Sample	Demonstration cartridge. This cartridge contains sample customer orders.
OracleComms_OSM_O2A_SimpleTopology_Sample	Demonstration cartridge. This cartridge contains decomposition rules and order components for the Simple topology.
OracleComms_OSM_O2A_TypicalTopology_Sample	Demonstration cartridge. This cartridge contains decomposition rules and order components for the Typical or Complex topology

Note:

Danube and Nile are the names for the process fulfillment patterns in the Simple and Typical topologies, respectively. See "About Fulfillment Topologies" for more details on topologies.

Service Order Management Cartridges

Service order management cartridges contain the OSM functionality that handles a provisioning request as a service order from central order management and completes the predetermined tasks to fulfill the service order.

Service order management cartridges are specific to either the solution option that uses calculate service order or the solution option that does not.

Service Order Management Cartridges for the Calculate Service Order Solution Option

Table 4-5 lists and describes the service order management cartridges for the Calculate Service Order solution option.

Table 4-5 Service Order Management Cartridges for the Calculate Service Order Solution Option

Cartridge Name	Description
OracleComms_OSM_O2A_SOM_CSO_Base	Productized cartridge. This cartridge supports the orchestration of service orders.
OracleComms_OSM_O2A_SOM_CSO_Broadband_Internet_Access_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for broadband internet access.
OracleComms_OSM_O2A_SOM_CSO_Common	Productized cartridge. This cartridge contains data elements and fulfillment modes for service order management with the calculate service order solution option.
OracleComms_OSM_O2A_SOM_CSO_CompleteProvisioning	Demonstration cartridge. This cartridge supports provisioning fulfillment functions for service order management.
OracleComms_OSM_O2A_SOM_CSO_DeliverOrder	Demonstration cartridge. This cartridge supports order delivery fulfillment functions for service order management.
OracleComms_OSM_O2A_SOM_CSO_DesignService	Demonstration cartridge. This cartridge supports service design functions for service order management.
OracleComms_OSM_O2A_SOM_CSO_Email_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for email service.
OracleComms_OSM_O2A_SOM_CSO_FulfillmentPattern	Productized cartridge. This cartridge contains fulfillment patterns for service order management.
OracleComms_OSM_O2A_SOM_CSO_FulfillmentStateMap	Productized cartridge. This cartridge contains fulfillment state entities for service order management.
OracleComms_OSM_O2A_SOM_CSO_Internet_Media_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for Internet media service.
OracleComms_OSM_O2A_SOM_CSO_IP_Fax_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for IP fax service.
OracleComms_OSM_O2A_SOM_CSO_ModelContainer	Demonstration cartridge. This cartridge defines the common model projects that contain elements that might need to be included in the deployment.
OracleComms_OSM_O2A_SOM_CSO_PlanDelivery	Demonstration cartridge. This cartridge supports delivery planning functions for service order management
OracleComms_OSM_O2A_SOM_CSO_Recognition	Demonstration cartridge. This cartridge recognizes a service order from central order management and triggers the creation of a SOM_ProvisionServiceOrderFulfillment order. Catches all in-bound messages not recognized by any other provisioning recognition rules.
OracleComms_OSM_O2A_SOM_CSO_Solution	Demonstration composite cartridge. This cartridge references all cartridges required when the calculate service order solution option is used and the current workspace is for service order management only.
OracleComms_OSM_O2A_SOM_CSO_Topology	Productized cartridge. This cartridge contains entities, such as decomposition rules and order components, for service order management.
OracleComms_OSM_O2A_SOM_CSO_VoIP_Access_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for VoIP access.
OracleComms_OSM_O2A_SOM_CSO_Web_Conferencing_CFS	Demonstration cartridge. This cartridge contains the order item parameter bindings associated with the customer facing service for web conferencing service.

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

Table 4-6 lists and describes the service order management cartridges for the solution option without Calculate Service Order.

Table 4-6 Service Order Management Cartridges for the Solution Option Without Calculate Service Order

Cartridge Name	Description
OracleComms_OSM_O2A_SOM_Base	Productized cartridge. This cartridge supports the orchestration of service orders, including handling status and data updates from fulfillment requests back to central order management.
OracleComms_OSM_O2A_SOM_Provisioning	Productized cartridge. This cartridge supports provisioning fulfillment functions in service order management.
OracleComms_OSM_O2A_SOM_Solution	Demonstration composite cartridge. This cartridge references all cartridges required for service order management.
OracleComms_OSM_O2A_SOM_Recognition_Sample	Demonstration cartridge. This cartridge recognizes a service order from central order management and triggers the creation of a SOM_ProvisionServiceOrderFulfillment order. Catches all in-bound messages not recognized by any other provisioning recognition rules.
OracleComms_OSM_O2A_SomBBVoIP_FP_NP_Sample	Demonstration cartridge. This cartridge contains fulfillment patterns, decomposition rules, and order components for service order management functions.
OracleComms_OSM_O2A_SomProvisionBroadband_Sample	Demonstration cartridge. This cartridge supports service orders for broadband services.
OracleComms_OSM_O2A_SomProvisionVoIP_Sample	Demonstration cartridge. This cartridge supports service orders for VoIP services.

Conceptual Model Projects

Conceptual model projects contain the relationships between your commercial products, the services that they represent, and the resources that are required to implement the services. These projects are not deployed, but the information in them that is needed for deployment is deployed with the OracleComms_OSM_O2A_COM_CSO_Model_Container cartridge.

For more information about the conceptual model, see Design Studio Concepts.

Common Conceptual Model Projects

Table 4-7 lists the conceptual model projects that are present in both central order management and service order management workspaces.

Table 4-7 Common Conceptual Model Projects

Cartridge Name	Description
OracleComms_Model_Base	Productized cartridge. This cartridge contains entities, like provider functions and functional areas, that support conceptual modeling.
OracleComms_Model_BaseCatalog	Productized cartridge. This cartridge contains conceptual model fulfillment patterns.
OracleComms_Model_Common	Productized cartridge. This cartridge contains a data schema with common data element definitions.
OracleComms_Model_O2A_Broadband_Internet_Access_CFS	Productized cartridge. This cartridge contains the customer facing services for broadband Internet access.
OracleComms_Model_O2A_Broadband_Internet_Access_SA	Productized cartridge. This cartridge contains the actions for broadband Internet access.
OracleComms_Model_O2A_Broadband_Internet_DataModel	Productized cartridge. This cartridge contains a data schema for data specific to broadband Internet access.
OracleComms_Model_O2A_Email_CFS	Productized cartridge. This cartridge contains the customer facing services for email.
OracleComms_Model_O2A_Email_DataModel	Productized cartridge. This cartridge contains a data schema for data specific to email.
OracleComms_Model_O2A_Email_SA	Productized cartridge. This cartridge contains the actions for email.
OracleComms_Model_O2A_Internet_Media_CFS	Productized cartridge. This cartridge contains the customer facing services for Internet media.
OracleComms_Model_O2A_Internet_Media_DataModel	Productized cartridge. This cartridge contains a data schema for data specific to Internet media.
OracleComms_Model_O2A_Internet_Media_SA	Productized cartridge. This cartridge contains the actions for Internet media.
OracleComms_Model_O2A_VoIP_Access_CFS	Productized cartridge. This cartridge contains the customer facing services for VoIP.
OracleComms_Model_O2A_VoIP_Access_SA	Productized cartridge. This cartridge contains the actions for VoIP.
OracleComms_Model_O2A_VoIP_DataModel	Productized cartridge. This cartridge contains a data schema for data specific to VoIP.

Conceptual Model Projects for Central Order Management

Table 4-8 lists the conceptual model projects that are only present in workspaces with central order management installed.

Table 4-8 Conceptual Model Projects for Central Order Management

Cartridge Name	Description
OracleComms_Model_O2A_Billing_PS	Productized cartridge. This cartridge contains the domains and products for billing services.
OracleComms_Model_O2A_Broadband_Internet_PS	Productized cartridge. This cartridge contains the domains and products for broadband Internet access services.
OracleComms_Model_O2A_Email_PS	Productized cartridge. This cartridge contains the domains and products for email services.
OracleComms_Model_O2A_Install_PS	Productized cartridge. This cartridge contains the domains and products for installation services.
OracleComms_Model_O2A_Internet_Media_PS	Productized cartridge. This cartridge contains the domains and products for Internet media services.
OracleComms_Model_O2A_VoIP_PS	Productized cartridge. This cartridge contains the domains and products for VoIP services.

Conceptual Model Projects for Service Order Management

Table 4-9 lists the conceptual model projects that are only present in workspaces with service order management installed.

Table 4-9 Conceptual Model Projects for Service Order Management

Cartridge Name	Description
OracleComms_Model_O2A_SOM_PS	Productized cartridge. This cartridge contains the products for service order management. This cartridge is only present when the service option without calculate service order is used.

Common Order Management Cartridges

The following cartridges provide common data dictionary elements that are used by or referenced by other Order-to-Activate cartridges.

OracleComms_OSM_CommonDataDictionary

The OracleComms_OSM_CommonDataDictionary cartridge is a productized data dictionary cartridge. It contains the data schema that defines the data elements for modeling orchestration entities in OSM.

This cartridge is referenced by many other cartridges, including OracleComms_OSM_O2A_COM_Base, OracleComms_OSM_O2A_SOM_CSO_Base, and OracleComms_OSM_O2A_SOM_Base.

OracleComms_OSM_O2A_AIAEBMDataDictionary

The OracleComms_OSM_O2A_AIAEBMDataDictionary cartridge is a productized data dictionary cartridge that is part of the core OSM product. It contains the data schema that defines the data elements from the Oracle AIA EBM schema. Cartridges that must include data elements from Oracle AIA EBM can reuse the elements defined in this cartridge.

This cartridge is referenced by the OracleComms_OSM_O2A_COM_Base cartridge.

OracleComms_OSM_O2A_CommonUtility

The OracleComms_OSM_O2A_CommonUtility cartridge is a productized component cartridge. It contains the data schema that defines the data elements for Order-to-Activate cartridges. Cartridges that extend Order-to-Activate cartridges can reuse the elements defined in this cartridge.

This cartridge is referenced by many other cartridges, including OracleComms_OSM_O2A_COM_Base, OracleComms_OSM_O2A_SOM_CSO_Base, and OracleComms_OSM_O2A_SOM_Base.

Table 4-10 describes the data schema elements that can be reused when extending Order-to-Activate cartridges:

Table 4-10 OracleComms_OSM_O2A_CommonUtility Extensible Data Dictionary Elements

Data Dictionary Element	Extension
Order Component	New fulfillment functions should use this data dictionary element or its extended type as the base fulfillment function type.

Table 4-11 describes the XQuery modules in the cartridge.

Table 4-11 OracleComms_OSM_O2A_CommonUtility XQuery Modules

XQuery Module	Extendable	Description
AIAEBMUtilityModule	No	Provides utilities for manipulating Oracle AIA EBM.
AIAFaultMsgEBMUtilityModule	No	Provides utilities for handling Oracle AIA fault messages.
BreakpointControlModule	No	Provides services related to breakpoint control in Order-to-Activate. Please refer to the OracleComms_OSM_O2A_ControlMap cartridge for an extensible way to control breakpoints.
ComponentDataManagementModule	No	Manipulates data structures for fulfillment functions.
ExtensionPointModule	No	Defines XQuery extension points for fulfillment functions.
ExtensionPointSelector	No	Sets the order of the fulfillment function's extension points based on priority.
FalloutLifecycleModule	No	Provides services related to message fallout and trouble ticket tracking.
FalloutSimulationModule	No	Simulates fallout.
FulfillmentOrderEventModule	No	Manages the fulfillment request's events in central order management and service order management.
FulfillmentOrderLifecycle-ManagementModule	No	Provides services related to the fulfillment request's order lifecycle management.
LogModule	No	Provides logging facility for Order-to-Activate cartridges.
OrderComponentMetadataBuilder	No	Provides an internal framework for data discrepancy detection.
OrderExtensionPointModule	No	Provides support for order event extension points.
OrderExtensionPointSelector	No	Provides support for order event extension point selection.
OrderLifecycleModule	No	Provides services related to the fulfillment request's external fulfillment state, milestone tracking, upstream order status map, and status context calculation.
OSMEBMUtilityModule	No	Provides utilities for manipulating EBM in central order management.
OsmWebServiceModule	No	Provides services for OSM Web service requests.
PerspectiveModule	No	Provides utilities for retrieving historical perspectives.
ProductClassToFulfillmentPatternModule	No	Provides utilities for order line retrieval for both fulfillment request and service order.
ProductClassToProductSpec	Yes	Provides services related to the mapping between product specifications and fulfillment patterns.
ProvisionOrderLifecycle-ManagementModule	No	Provides services related to service order management-to-fulfillment request lifecycle management.
ServiceActionCodeModule	No	Provides services related to service action calculation.
SOMEBMUtilityModule	No	Provides utilities for manipulating the EBM in service order management.
SomProductClassToProductSpec	Yes	Provides services related to the mapping between product specifications and fulfillment patterns in SOM.
SystemConfigModule	No	Provides constants and utilities for the calculate service order solution option.
SystemInteractionModule	No	Provides services related to message sequencing and generation and order locking.
TargetMapping	No	Returns the target system name for a given active interaction ID during fallout handling.
TargetSystemManagementModule	No	Provides services related to target system information such as target system identifier and code.
Topology	No	Calculates the system topology for the calculate service order solution option.
TroubleTicket	No	Provides utilities for trouble ticketing during fallout handling.
UpdateServiceOrderStatusFunctionsModule	No	Provides services to create EBM message for the service provisioning order to update the service order management order.

OracleComms_OSM_O2A_ControlMap

The OracleComms_OSM_O2A_ControlMap cartridge is a productized cartridge that provides the ability to:

Stop at a breakpoint when OSM executes central order management tasks
Disable a point of no return
Simulate a fallout scenario
Configure the processing granularity of billing fulfillment functions dynamically
Manage the frequency of order updates to the upstream system for debugging

To use these functions:

Create a control file in XML, using the parameters listed in the following sections. The same control file can contain more than one control function.
Validate your control file against the BFPMap.xsd schema located in OracleComms_OSM_O2A_ControlMap\resource.

You must validate your control file against the schema because OSM will not validate control files and report errors during order processing. If the file is not a valid XML file, the entire file will be ignored by OSM. If a file contains an invalid element or value, the control function containing the invalid element or value will be ignored.
Put your control file into the OracleComms_OSM_O2A_ControlMap\resource directory.
When you want to use the control file for an order, preface the order number with the name of the control file inside square brackets and without the .xml extension. For example, if you have a control file named control001.xml in the OracleComms_OSM_O2A_ControlMap\resource directory, and you want to use it with an order numbered VOIP01, send the order in with the orderID [control001]VOIP01.

Configuring Breakpoints for Central Order Management and for Service Order Management Without Calculate Service Order

This section applies to configuring breakpoints for central order management for both the calculate service order solution option and the service option without calculate service order and configuring breakpoints for service order management for the solution option without calculate service order. For information about configuring breakpoints for service order management with the calculate service order solution option, see "Configuring Breakpoints for Service Order Management with Calculate Service Order."

If you enable breakpoint control, you can set a breakpoint in the order process to cause the order to go through a particular manual task or a special automated task before or after an interaction with an external system. This enables you to do things like check status and define data.

A breakpoint task for central order management or for service order management for the solution option without calculate service order is defined by:

BreakComponent: This is an order component name; for example, SyncCustomerFunction
ExecutionMode: do, redo, undo, and amend_do
Event: Component_PRESTART (before the component has started), only applicable to FulfillBillingFunction), Component_START (after the component has started), and Component_COMPLETE (after the component has completed)
TargetSystem: ANY, or a particular target system such as BRM-ALL

Example 4-1 contains a control file to configure a breakpoint before FulfillBillingFunction starts.

Example 4-1 Control File to Configure a Breakpoint in FulfillBillingFunction

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">
    <oms:BreakPointControlMap>
        <oms:BreakComponent>FulfillBillingFunction</oms:BreakComponent>
        <oms:ExecutionMode>do</oms:ExecutionMode>
        <Event>Component_PRESTART</Event>
        <TargetSystem>ANY</TargetSystem>
    </oms:BreakPointControlMap>
</oms:ControlMap>

The valid component names for central order management are:

SyncCustomerFunction
InitiateBillingFunction
ProvisionOrderFunction
FulfillBillingFunction

The valid component names for service order management for the solution option without calculate service order are:

SomProvisionOrderFunction

Configuring Breakpoints for Service Order Management with Calculate Service Order

This section applies to configuring breakpoints for service order management for the calculate service order solution option. For information about configuring breakpoints for other situations, see "Configuring Breakpoints for Central Order Management and for Service Order Management Without Calculate Service Order."

A breakpoint task for service order management for the calculate service order solution option is defined by:

BreakComponent: This is an order component name; for example, DesignServiceFunction
ExecutionMode: do, redo, undo, and amend_do
Event: The task name in the sub-process of the component
TargetSystem: ANY, or a particular target system such as SOM_DeliverySystem

Table 4-12 describes the components and events used for breakpoints for service order management with the calculate service order option.

Table 4-12 Breakpoint Events for Service Order Management with the Calculate Service Order Solution Option

Component Name	Events
DesignServiceFunction	CaptureBITask ProcessBITask ApproveBITask
PlanDeliveryFunction	IssueBITask CalculateTechnicalActionsTask
DeliverOrderFunction	CreateTechnicalOrderTask
CompleteProvisioningFunction	CompleteBITask

Example 4-2 contains a control file to configure a breakpoint before FulfillBillingFunction starts.

Example 4-2 Control File to Configure a Breakpoint in DesignServiceFunction

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">
    <oms:BreakPointControlMap>
        <oms:BreakComponent>DesignServiceFunction</oms:BreakComponent>
        <oms:ExecutionMode>do</oms:ExecutionMode>
        <Event>CaptureBITask</Event>
        <TargetSystem>ANY</TargetSystem>
    </oms:BreakPointControlMap>
</oms:ControlMap>

Controlling Point of No Return

During testing, a user may want to disable OSM's ability to set or check for points of no return. This allows the user to submit an amendment order successfully in situations that would not be allowed under normal circumstances.

You can disable point of no return processing either for all order components or selectively using the following field:

PONRComponent: This can contain any of the following
- Order Component Name - For example, SyncCustomerFunction
- ALL - Disable point of no return setting and checking for all order components
- CONFIG - Disable point of no return checking for all order components when an order amendment is received

Example 4-3 contains a control file that disables point of no return setting and checking for all order components.

Example 4-3 Control File to Disable Points of No Return

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">                
    <oms:PONRControlMap>
        <oms:PONRComponent>ALL</oms:PONRComponent>
    </oms:PONRControlMap>    
</oms:ControlMap>

Controlling Fault Simulation

If you are using the Oracle AIA emulators included with the Order-to-Activate cartridges, you can simulate fallout scenarios using control files.

There are two ways to trigger the emulator to generate a fault response rather than a successful response:

Using the VerbCode field in the EBM
Using a control file

Both methods are discussed in the following sections.

Simulating Faults in Central Order Management

To simulate a fault in central order management using the VerbCode field in the EBM, populate the following XPath location:

ProcessSalesOrderFulfillmentEBM/EBMHeader/VerbCode

Table 4-13 lists the valid values to put in the field and their descriptions.

Table 4-13 VerbCode Values for Central Order Management

VerbCode Value	Description
SIMULATE_FAIL_SYNCCUST_FAULT	The SyncCustomer emulator generates a fault to the AIA error handler.
SIMULATE_FAIL_SYNCCUST_RESP	The SyncCustomer emulator sends back an invalid response.
SIMULATE_FAIL_SYNCCUST_NOTIF	The SyncCustomer emulator sends back a response with a fault indicator.
SIMULATE_FAIL_INITBILL_FAULT	The InitiateBilling emulator generates a fault to the AIA error handler.
SIMULATE_FAIL_INITBILL_RESP	The InitiateBilling emulator sends back an invalid response.
SIMULATE_FAIL_INITBILL_NOTIF	The InitiateBilling emulator sends back a response with a fault indicator.
SIMULATE_FAIL_FULFILLBILL_FAULT	The FulfillBilling emulator generates a fault to the AIA error handler.
SIMULATE_FAIL_FULFILLBILL_RESP	The FulfillBilling emulator sends back an invalid response.
SIMULATE_FAIL_FULFILLBILL_NOTIF	The FulfillBilling emulator sends back a response with a fault indicator.
SIMULATE_FAIL_PROV_FAULT	The ProvisionOrder emulator generates a fault to the AIA error handler.
SIMULATE_FAIL_PROV_RESP	The ProvisionOrder emulator sends back an invalid response.
SIMULATE_FAIL_PROV_NOTIF	The ProvisionOrder emulator sends back a response with a fault indicator.

To create a control file to simulate fault situations in central order management, use the following parameters:

FaultComponent: this is an order component name, for example, SyncCustomerFunction
ExecutionMode: do, redo, undo, and amend_do
FaultMode:
- Fault: generate a fault to the AIA error handler
- InvalidRESP: send back an invalid response
- FailNotification: send back a response with a fault indicator

Example 4-4 contains a control file that simulates an invalid response for SyncCustomerFunction.

Example 4-4 Control File to Simulate a Fault in Central Order Management

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">                
    <oms:FaultControlMap>
        <oms:FaultComponent>SyncCustomerFunction</oms:FaultComponent>
        <oms:ExecutionMode>do</oms:ExecutionMode>
        <FaultMode>InvalidRESP</FaultMode>
    </oms:FaultControlMap>    
</oms:ControlMap>

Simulating Faults in Service Order Management Without Calculate Service Order

To simulate a fault in service order management without the calculate service order solution option using the VerbCode field in the EBM, populate the following XPath location:

ProcessSalesOrderFulfillmentEBM/EBMHeader/VerbCode

Table 4-14 lists the valid values to put in the field and their descriptions.

Table 4-14 VerbCode Values for Service Order Management Without Calculate Service Order

VerbCode Value	Description
SIMULATE_FAIL_BRD_SERVICEBUNDLE_FAULT	Service order management generates a fault to the AIA error handler during broadband service bundle provisioning.
SIMULATE_FAIL_BRD_EMAILSERVICEBUNDLE_FAULT	Service order management generates a fault to the AIA error handler during broadband email service provisioning.
SIMULATE_FAIL_BRD_MEDIASERVICEBUNDLE_FAULT	Service order management generates a fault to the AIA error handler during broadband media service provisioning.
SIMULATE_FAIL_BRD_CPE_FAULT	Service order management generates a fault to the AIA error handler during broadband customer premise equipment provisioning.
SIMULATE_FAIL_VOIP_SERVICEBUNDLE_FAULT	Service order management generates a fault to the AIA error handler during VoIP service bundle provisioning.
SIMULATE_FAIL_VOIP_CPE_FAULT	Service order management generates a fault to the AIA error handler during VoIP customer premise equipment provisioning.

To create a control file to simulate fault situations in service order management without the calculate service order solution option, use the following parameters:

ExecutionMode: do, redo, undo, and amend_do
VerbCode: This can contain any of the values in Table 4-14.

Example 4-5 contains a control file that simulates a failure in provisioning broadband customer premise equipment in execution mode redo.

Example 4-5 Control File to Simulate a Fault in Service Order Management Without Calculate Service Order

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">                
    <oms:LF_FaultControlMap>
        <oms:ExecutionMode>redo</oms:ExecutionMode>
        <VerbCode>SIMULATE_FAIL_BRD_CPE_FAULT</VerbCode>
    </oms:LF_FaultControlMap>    
</oms:ControlMap>

Simulating Faults in Service Order Management With Calculate Service Order

To simulate a fault in service order management with the calculate service order solution option using the VerbCode field in the EBM, populate the following XPath location:

ProcessSalesOrderFulfillmentEBM/EBMHeader/VerbCode

Table 4-15 lists the valid values to put in the field and their descriptions.

Table 4-15 VerbCode Values for Service Order Management With Calculate Service Order

VerbCode Value	Description
SIMULATE_FAIL_CAPTURE_BI_RESP	The CaptureBI emulator generates a SOAP fault response message.
SIMULATE_FAIL_CAPTURE_BI_NOTIF	The CaptureBI emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_PROCESS_BI_RESP	The ProcessBI emulator generates a SOAP fault response message.
SIMULATE_FAIL_PROCESS_BI_NOTIF	The ProcessBI emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_APPROVE_BI_RESP	The ApproveBI emulator generates a SOAP fault response message.
SIMULATE_FAIL_APPROVE_BI_NOTIF	The ApproveBI emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_ISSUE_BI_RESP	The IssueBI emulator generates a SOAP fault response message.
SIMULATE_FAIL_ISSUE_BI_NOTIF	The IssueBI emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_CALCULATE_TA_RESP	The CalculateTA emulator generates a SOAP fault response message.
SIMULATE_FAIL_CALCULATE_TA_NOTIF	The CalculateTA emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_CREATE_TO_RESP	The CreateTO emulator generates a SOAP fault response message.
SIMULATE_FAIL_CREATE_TO_NOTIF	The CreateTO emulator generates a normal response message with missing mandatory data.
SIMULATE_FAIL_COMPLETE_BI_RESP	The CompleteBI emulator generates a SOAP fault response message.
SIMULATE_FAIL_COMPLETE_BI_NOTIF	The CompleteBI emulator generates a normal response message with missing mandatory data.

To create a control file to simulate fault situations in service order management with the calculate service order solution option, use the following parameters:

ExecutionMode: do, redo, undo, and amend_do
VerbCode: This can contain any of the values in Table 4-15.

Example 4-6 contains a control file that simulates a failure in provisioning broadband customer premise equipment in execution mode redo.

Example 4-6 Control File to Simulate a Fault in Service Order Management Without Calculate Service Order

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">                
    <oms:LF_FaultControlMap>
        <oms:ExecutionMode>redo</oms:ExecutionMode>
        <VerbCode>SIMULATE_FAIL_CAPTURE_BI_RESP</VerbCode>
    </oms:LF_FaultControlMap>    
</oms:ControlMap>

Controlling Order Updates

In Order-to-Activate, order updates are sent by central order management to upstream systems at every milestone update on the order, unless the order is in the Canceling state. The milestones are defined in OracleComms_OSM_O2A_Configuration\solution-config\ComponentMilestoneMap.xml. You can use a control file to disable the order updates for one or more specific milestones.

Following are the attributes and elements to use in your control file to disable updates for a breakpoint:

system: OracleComms_OSM_O2A_SystemAdmintarget system name defined in the <oms:targetSystem> element of the resources/SolutionConfig/TargetSystemMap.xml file in the Order-to-Activate composite cartridge.
execMode: do, redo, and amend_do
ComponentMilestone: COMPONENT-START, COMPONENT-UPDATE, or COMPONENT-COMPLETE
Milestone: Milestone defined by external system such as PROVISION DESIGNED. This field is optional and only applicable to the COMPONENT-UPDATE component milestone.
UpdateUpstreamSystem: Set this to false to disable the event

Example 4-7 contains a control file that disables the sending of updates for the PROVISION START milestone.

Example 4-7 Control File to Disable Updates for PROVISION START

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1">                
    <oms:MilestoneMap system="OSMPROV" systemName="*" execMode="do">
        <oms:ComponentMilestone>COMPONENT-START</oms: ComponentMilestone >
        <oms:Milestone>PROVISION START</oms:Milestone>
        <oms:UpdateUpstreamSystem>false</oms:UpdateUpstreamSystem>
    </oms: MilestoneMap>    
</oms:ControlMap>

Controlling Processing Granularity for FulfillBillingFunction

In Order-to-Activate, the granularity decomposition rule for FulfillBillingFunction uses ServiceBundle granularity by default. If you want to test Order granularity on FulfillBillingFunction, use a control file.

Following are the elements in the control file to change processing granularity:

GranularityFunction: Only FulfillBillingFunction is supported for this element. Any other value is ignored.
Granularity: Only Order and ServiceBundle are supported for this element. Any other value is ignored.

Example 4-8 contains a control file that changes the processing granularity to Order:

Example 4-8 Control File to Change Processing Granularity

<?xml version="1.0" encoding="UTF-8"?>
<oms:ControlMap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="urn:com:metasolv:oms:xmlapi:1 BFPMap.xsd"
 xmlns="urn:com:metasolv:oms:xmlapi:1"
 xmlns:oms="urn:com:metasolv:oms:xmlapi:1"> 
    <oms:GranularityControlMap>
        <oms:GranularityFunction>FulfillBillingFunction</oms:GranularityFunction>
        <oms:Granularity>Order</oms: Granularity>
    </oms:GranularityControlMap>
</oms:ControlMap>

OracleComms_OSM_O2A_RecognitionFallout

The OracleComms_OSM_O2A_RecognitionFallout cartridge is a productized cartridge that generates Oracle AIA trouble ticket creation request messages for unrecognizable customer order messages.

Table 4-16 lists entities that are defined in this cartridge.

Table 4-16 OracleComms_OSM_O2A_RecognitionFallout Entities

Entity Name	Entity Type	Description
ORPFalloutPIPOrder	Order	The order that is created when an unrecognizable message is received.
CreationORPFalloutTask	Manual Task	Creation task that is used to create an ORPFalloutPIPOrder.
ORPQueryTask	Manual Task	Query task used by a manual user to view the fallout order.
ORPFalloutProcessErrorTask	Manual Task	Task that handles error when creating a fault message in service order management or when creating a fulfillment request for the trouble ticketing system.
ORPFalloutProcess	Process and tasks	Fallout process that creates a trouble ticket for Oracle AIA.
orpfalloutrole	Role	Role with privileges to create and view fallout orders.

Table 4-17 lists XQuery modules defined in this cartridge.

Table 4-17 OracleComms_OSM_O2A_RecognitionFallout XQuery Modules

XQuery Module	Extendable	Description
CreateErrorFault	No	Used by service order management to create a fault notification.
CreateORPFalloutTroubleTicket	No	Creates a trouble ticket EBM for Oracle AIA indicating an ORP error.
CreateORPFalloutTroubleTicketResponse	No	Handles responses from the ORP trouble ticket request.
DetectORPFalloutHandlingType	No	Determines the fallout mode depending on whether this is used in a central order management or service order management context. For central order management, the fallout processing requires creation of a trouble ticket request to the upstream system. For service order management, fallout processing requires creation of a fault notification that is sent to the Oracle AIA error handling queue.

Table 4-18 lists the automation modules (with their associated automated tasks) defined in this cartridge.

Table 4-18 OracleComms_OSM_O2A_RecognitionFallout Automation Modules

Automation Module	Automated Task	Description
CreateErrorFaultBean	CreateFaultErrorTask	Calls the CreateErrorFault XQuery.
CreateORPFalloutTroubleTicketRequestBean	CreateORPFalloutTroubleTicketTask	Calls the CreateORPFalloutTroubleTicket XQuery.
ORPTTResponseBean	CreateORPFalloutTroubleTicketTask	External event receiver to invoke CreateORPFalloutTroubleTicketResponse XQuery.
DetectORPFalloutHandlingTypeBean	DetectORPFalloutHandlingTypeTask	Calls the DetectORPFalloutHandlingType XQuery.

OracleComms_OSM_O2A_SystemAdmin

The OracleComms_OSM_O2A_SystemAdmin cartridge is a productized cartridge that works in conjunction with the Inbound Message Recovery MDB to create fallout tasks that help you recover from inbound message processing errors. The OracleComms_OSM_O2A_SystemAdmin cartridge and Inbound Message Recovery MDB handle errors caused by the following:

Suspended orders (See "Recovering from Inbound Message Errors Due to Suspended Orders")
Order-to-Activate resource issues (See "Recovering from Inbound Message Errors Due to Resource Issues")

Table 4-19 describes the XQuery modules in the cartridge.

Table 4-19 OracleComms_OSM_O2A_SystemAdmin XQuery Modules

XQuery Module	Extendable	Description
InboundMessageHandlerDetection	No	Utility module for fallout recovery. Used to find out the handling component type from the response message based on the EBM type.
InBoundMessageRecovery	No	Routes the inbound message for recovery to appropriate target system.
ResumePendingInBoundMessage_OrderDataRule	No	Module used as order data rule when recognizing the inbound message to create the ResumePendingInBoundMessage order.

How the Inbound Message Recovery MDB Works

The Inbound Message Recovery MDB works with the OracleComms_OSM_O2A_SystemAdmin cartridge to handle inbound message errors. When the message cannot be delivered to the response queue due to JMS system errors, the response queue uses the OSM Integration Pack Fallout Queue. The Inbound Message Recovery MDB listens to the OSM Integration Pack Fallout Queue and does the following:

Routes the message (response) to the OSM InBoundMessageRecoveryQueue queue.
Produces a request to OSM to create the ResumePendingInBoundMessage order (using the OracleComms_OSM_O2A_SystemAdmin cartridge) by doing the following:
1. Running a manual task that enables order management personnel to confirm that resource or XQuery logic errors have been resolved.
  
  This step can be configured to redeliver the inbound message automatically, by setting the JVM parameter pip.require.ack to NO. The number of automatic redelivery attempts for inbound messages is configured in the model variable named IB_MSG_MAX_RETRY in the Order-to-Activate composite cartridge.
2. Running an automated task that moves the message from the recovery queue to the response queue.

OSM recognizes the ResumePendingInBoundMessage order, and the OracleComms_OSM_O2A_SystemAdmin cartridge begins to process.

Recovering from Inbound Message Errors Due to Suspended Orders

The following steps demonstrate how the Inbound Message Recovery MDB and the OracleComms_OSM_O2A_SystemAdmin cartridge recover from an error scenario where an inbound message is not processed because its associated order is suspended.

OSM sends a message to an external system using an automation task.
Before the automation task receives the inbound response message from the external system, the order associated with the automation task is suspended.
OSM receives the response message from the external system.
The automation task that receives the inbound response message does the following:
1. Checks the order state while processing the response.
2. If the order state is Suspended, moves the message to the OSM Inbound Message Recovery Queue (passing required order information such as order ID and FulfillmentFunction name, etc.).
  
  This logic is implemented in the resource AIAEBMResponse.xqy, which is located in OracleComms_OSM_O2A_COM_SalesOrderFulfillmentPIP/resources/ComponentInteraction.
When the order state changes from Suspended to In Progress, the order state change event handler creates the ResumePendingInBoundMessage order (using the OracleComms_OSM_O2A_SystemAdmin cartridge).
The ResumePendingInBoundMessage automation task of the process associated with the ResumePendingInBoundMessage order moves the original response message from the OSM Inbound Message Recovery Queue back to the response queue.
The automation task that could not process the inbound message in the response queue originally (due to its associated order being suspended) processes the inbound message successfully.

Recovering from Inbound Message Errors Due to Resource Issues

The following steps demonstrate how the Inbound Message Recovery MDB and the OracleComms_OSM_O2A_SystemAdmin cartridge recover from an error scenario where an inbound message processing error occurs due to a resource issue such as a Global Transaction Error (GTX) or an incorrect XQuery script.

OSM sends a message to an external system using an automation task and receives a response back from the external system.
The automation task receives the inbound response message in the response queue but cannot process the message because a resource required to process the message is currently locked by another task.

For example, the resource could be locked because of a GTX timeout or because of an error in the logic of an XQuery script.
After a few retries, the automation task raises a fallout.
The fallout message goes to the OSM Integration Pack Fallout Queue.
The Inbound Message Recovery MDB, listening on the OSM Integration Pack Fallout Queue, moves the response message to the OSM Inbound Message Recovery Queue.
The MDB creates the ResumePendingInBoundMessage order (using the OracleComms_OSM_O2A_SystemAdmin cartridge), and its process begins to run.
The order process assigns a manual task (a fallout or confirmation task) to order management personnel who manage fallout.
The fallout task is displayed on the worklist of the Task Web client.

Note:
OSM does not raise a fallout notification to inform order management personnel that a fallout task has been created on the worklist.
Order management personnel resolve the resource error. For example, they correct the XQuery script logic and restart the system.
In the worklist, order management personnel click the Confirm button on the task and (optionally) specify the name of the response queue of the automation task that could not originally process the inbound message. If the name of the response queue is not specified, the ResumePendingInBoundMessage automated task uses the EBM type to detect which queue is the response queue and routes the message accordingly.
After the confirmation task completes, the process in the OracleComms_OSM_O2A_SystemAdmin cartridge runs the ResumePendingInBoundMessage automation task, which moves the original response message back to the response queue.
The original automation task that could not process the inbound message in the response queue is retried, and the message processes successfully.

Common Central Order Management Cartridges

The following cartridges operate in the central order management role, which coordinates fulfillment functions across the Business Support Systems (BSS) and Operations Support Systems (OSS) such as Siebel CRM, BRM, and provisioning.

OracleComms_OSM_O2A_COM_Base

The OracleComms_OSM_O2A_COM_Base cartridge is a productized cartridge supporting the orchestration of customer orders from Oracle AIA. It includes communication to and from fulfillment providers and handles status and data updates.

Order Events

When the COM_SalesOrderFulfillment order reaches one of the order events listed in Table 4-20, it triggers the listed XQuery module to send an order update to the upstream system.

Table 4-20 OracleComms_OSM_O2A_COM_Base Order Events

Order Event	Description
stateChange	Calls the OrderStateChangeHandler XQuery module to send an order update to the Siebel CRM system.
completion	Calls the OrderCompletionHandler XQuery module to send the order completion to the Siebel CRM system.

Processing Granularity Rules

There are four orchestration stages defined in the orchestration sequence to decompose the order line items. The result of each stage of decomposition is the source for the next stage of decomposition.

In the first stage, the order line items are decomposed by fulfillment function.
In the second stage, the order line items are decomposed by fulfillment provider.
In the third stage, the order line items are decomposed by granularity rule.
In the fourth stage, depending on the fulfillment function process, central order management will use the fulfillment function process to determine whether to create an executable order component with all of the order line items if a significant change is detected on any order line item.

Granularity rules provide the configuration for the third stage of decomposition. During orchestration plan generation at run time, the granularity rule takes as input the order line items that have already been grouped by fulfillment function and subdivided by fulfillment provider.

The behavior of granularity rules varies between design time and run time.

For example, during design time, a granularity rule such as ServiceBundleGranularity or BundleGranularity is selected per fulfillment function by creating one decomposition rule per fulfillment function for use in the third stage of decomposition.

During run time, granularity rules group the order line items into one or more fulfillment requests. Granularity rules group the order line items that are targeted at the same fulfillment function and are specific to a fulfillment provider.

Table 4-21 lists the processing granularity rules.

Table 4-21 OracleComms_OSM_O2A_COM_Base Processing Granularity Rules

Name	Entity Type	Description
BundleGranularity	Order Component Specification	This granularity rule selects: An order line item that represents a bundle along with bundle components and related order line items Nested bundles are considered components of the root bundle and are processed in the same fulfillment request. In Siebel CRM, a bundle is referred to as a Commercial Bundle. Order line items of any other root node on the order along with their related order line items
OfferGranularity	Order Component Specification	This granularity rule selects: An order line item that represents an offer along with offer components and Related order line items In Siebel CRM, an offer is referred to as a promotion. Order line items of any other root node on the order along with their related order line items
OrderGranularity	Order Component Specification	This granularity rule selects all lines targeted at the same fulfillment function and specific to a fulfillment provider make a single fulfillment request.
ServiceBundleGranularity	Order Component Specification	This granularity rule selects: An order line item that represents a service bundle along with service bundle components and related order line items Nested service bundles and their components make separate fulfillment requests. Order line items of any other root node on the order along with their related order line items This granularity rule implements an optimization to group together offers and non-service billing items into a single fulfillment request to be fulfilled at the same time
WholeItemGranularity	Order Component Specification	This granularity rule selects: An order line item that represents a whole item along with whole item components and related order line items Nested whole items and their components make separate fulfillment requests. Order line items of any other root node on the order along with their related order line items

Abstract Orchestration Entities

Table 4-22 lists the orchestration entities that are used as base entities for fulfillment function, fulfillment system, process granularity rule, and fulfillment function updates.

Table 4-22 OracleComms_OSM_O2A_COM_Base Abstract Orchestration Entities

Name	Type	Description
COM_FulfillmentFunction	Order Component Specification	This order component specification represents the base fulfillment function in central order management. All fulfillment functions, such as SyncCustomerFunction, should extend from it. This order component also contains the external fulfillment state definitions.
COM_FulfillmentGranularity	Order Component Specification	This order component specification represents the processing granularity rule used in the orchestration stage. All processing granularity rules should extend from it.
COM_FulfillmentSystem	Order Component Specification	This order component specification represents the base fulfillment system in central order management. All fulfillment systems, such as BRM-VOIP, should extend from it.
COM_FulfillmentSignificantUpdates	Order Component Specification	This order component specification represents the base fulfillment function with significant updates in the fourth orchestration stage.

Order Lifecycle Manager Configuration

The Order-to-Activate order lifecycle manager is configured with the header values for the Order Lifecycle Management user interface. It also contains mappings between Order-to-Activate central order management fulfillment states and standard order lifecycle manager states.

Table 4-23 displays the mappings that are configured. The high-level fulfillment states are mapped, which causes the child states to be mapped as well.

Table 4-23 Fulfillment State to Order Lifecycle Manager State Mapping

Fulfillment State	Order Lifecycle Manager State
CANCELLED	Canceled
COMPLETE	Complete
FAILED	Failed
IN_PROGRESS	In Progress

Note:

If you have both central order management and service order management in the same Design Studio workspace, you will see service order management fulfillment states in the list in the order lifecycle manager. The names of the high-level fulfillment states for service order management all start with SOM_. The service order management fulfillment states do not need to be mapped here, because they are mapped in the order lifecycle manager in the service order management configuration. See "Order Lifecycle Manager Configuration" for information about service order management state mappings.

XQuery Modules in the OracleComms_OSM_O2A_COM_Base Cartridge

Table 4-24 through Table 4-32 list the different types of XQuery modules in this cartridge.

No table is included for the Order Item Property XQuery modules because none are extendable and each XQuery module does the same thing: retrieves the specified order item property from the appropriate location in the order data.

Table 4-24 OracleComms_OSM_O2A_COM_Base XQuery Modules for Constants

Constants XQuery Module	Extendable	Description
O2AConstants	No	Defines overall solution constants.
PromotionGroupConstants	No	Defines constants for processing promotion groups in central order management.
QueryViewConstants	No	Defines constants for querying views in central order management.

Table 4-25 OracleComms_OSM_O2A_COM_Base XQuery Modules for Fallout Handling

Fallout Handling XQuery Module	Extendable	Description
AbortOrderRequest	No	Sends an order termination request for the fulfillment request through the Web service API.
AbortOrderResponse	No	Receives the response to the order termination request for the fulfillment request through the Web service API.
CFwsResponseHandler	No	Utility module for providing retrieval and update to central order management order.
CloseCreationFailedTroubleTickets	No	Sends a request to the trouble ticketing system to close the trouble tickets for orders with the same Oracle AIA sales order key.
CloseTroubleTicket	No	Creates a request to the trouble ticketing system to close a trouble ticket.
CreateSIFalloutTroubleTicket	No	Creates a trouble ticket for system interaction.
CreateTroubleTicket	No	Creates a trouble ticket for both system interactions and Order Request Processor (ORP) errors.
FalloutNotificationRouter	No	Routes fallout notifications to different fallout process to handle updating EBM, creating a trouble ticket, and keeping track of the trouble ticket in the OSM order.
FalloutNotificationToCFTask	No	Directs fallout notifications to central order management.
FindFulfillmentOrderData	No	Retrieves the fulfillment request data in fallout.
FindOrderCreationFailedTroubleTickets	No	Finds an order that failed at creation with the Oracle AIA sales order key.
GetCreationFailFulfillmentOrder	No	Retrieves the order data for an order that failed at creation.
GetFulfillmentOrderResponse	No	Utility module to handle the web service response for the find order request.
GetTroubleTicketData	No	Updates trouble ticket data on the OSM order.
OrderAbortPropagation	No	Sends an order termination request to the service order through the Oracle AIA provisioning order queue.
OrderAbortPropagationCheck	No	Checks the status of the order termination request for the service order.
OrderAbortPropagationResp	No	Handles the response of the order termination request to the service order.
SuspendCFOrder	No	Suspends a central order management order.
SuspendCFOrderResponse	No	Utility module to handle the web service response for the suspend order request.
UpdateCreationFailFulfillmentOrder	No	Updates the trouble ticket information back to the OSM order that failed at creation.
UpdateFulfillmentOrder	No	Updates the trouble ticket data on the OSM order. This is used by both UpdateCreationFailFulfillmentOrder and UpdateSIFalloutTroubleTicket XQuery file.
UpdateSIFalloutTroubleTicket	No	Updates the trouble ticket information back to the OSM order that has system interaction fallout.
UpdateStatusRequest	No	Creates an update status EBM to the Siebel CRM system for fallout.
UpdateTroubleTicket	No	Creates the trouble ticket payload for the trouble ticketing system.

Table 4-26 OracleComms_OSM_O2A_COM_Base Orchestration Sequence XQuery Modules

Orchestration Sequence XQuery Module	Extendable	Description
FulfillmentModeExpression	No	Marshals the fulfillment mode code from the customer order.
OrderItemSelector	No	Selects all order line items from the customer order.

Table 4-27 OracleComms_OSM_O2A_COM_Base Order Data Change XQuery Modules

Order Data Change XQuery Module	Extendable	Description
CloseFalloutTroubleTicket	No	Creates a request to close a trouble ticket.
CreateFalloutOrderNotification	No	Creates a fallout order notification to handle fallout for an order that failed at creation.
UpdateSalesOrderFalloutStatusRequest	No	Creates an EBM with order status context being populated with fallout information.

Table 4-28 OracleComms_OSM_O2A_COM_Base Order Item Hierarchy XQuery Modules

Order Item XQuery Module	Extendable	Description
InterOrderDependency	No	Determines the inter-order dependency based on the order item's dependencies across different orders.
LineIdKey	No	Retrieves the order line item's ID.
ParentLineIdKey	No	Retrieves the parent order line item's ID.
PromotionGroupKey	No	Retrieves the order line item's promotion group.
PromotionGroupParentKey	No	Retrieves the parent order line item's promotion group.
RelatedSalesOrderLineIdKey	No	Retrieves the related sales order line item's ID.
RootParentSalesOrderLineIdKey	No	Retrieves the root order item business component ID.

Table 4-29 OracleComms_OSM_O2A_COM_Base Order Recognition XQuery Modules

Order Recognition XQuery Module	Extendable	Description
AIAOrderData	No	Transforms the customer order to an OSM order.
AIAOrderPriority	No	Retrieves the priority of the customer order.
AIAOrderRecognition	No	Recognizes the customer order.
AIAOrderReference	No	Adds the -TSQ suffix to order identification if the order is to be processed in Technical Service Qualification mode. (This allows the same customer order to be sent later as a DELIVER order with the same order ID.)
AIAOrderValidation	No	Validates the customer order.

Table 4-30 OracleComms_OSM_O2A_COM_Base Order State XQuery Modules

Order State XQuery Module	Extendable	Description
OrderAbortedStateHandler	No	Creates an EBM to update the Siebel CRM order with an aborted status context.
OrderCancelledStateHandler	No	Creates an EBM to update the Siebel CRM order with a canceled status context.
OrderCompletedStateHandler	No	Creates an EBM to update the Siebel CRM order with a completed status context.
OrderCompletionHandler	No	Responds to the central order management order completion event and triggers the OrderCompletedStateHandler module.
OrderFailedStateHandler	No	Creates an EBM to update the Siebel CRM order with a failed status context.
OrderInProgressStateHandler	No	Creates an EBM to update the Siebel CRM order with an in-progress status context.
OrderStateChangeHandler	No	Responds to the central order management order state change event and triggers the appropriate OrderStateHandler according to the order state.
OrderStateUtilityModule	No	Provides utility functions related to order state.

Table 4-31 OracleComms_OSM_O2A_COM_Base Order Transformation Manager XQuery Modules

Order Transformation Manager XQuery Module	Extendable	Description
OTMMappingModule	No	Utilities to support the order transformation manager.

Table 4-32 OracleComms_OSM_O2A_COM_Base Processing Granularity XQuery Modules

Processing Granularity XQuery Module	Extendable	Description
BundleGranularity	No	Groups related order items as a bundle for processing.
GranularityModule	No	Utility module to group order items based on service action code.
OfferBundleGranularity	No	Groups related order items as an offer for processing.
OrderGranularity	No	Groups related order items as an order for processing.
ServiceBundleGranularity	No	Groups related order items as a service for processing.
WholeItemGranularity	No	Groups related order items as a whole item for processing.

Automation Modules in the OracleComms_OSM_O2A_COM_Base Cartridge

Table 4-33 lists the automation modules in the cartridge with their associated automated tasks.

Table 4-33 OracleComms_OSM_O2A_COM_Base Automation Modules

Automation Module	Automated Task	Description
AbortOrderRequestBean	AbortFulfillmentOrderTask	Calls the AbortOrderRequest XQuery.
CloseOrderCreationFailedTroubleTicketsBean	CloseCreationFailedTroubleTicketTask	External event receiver to invoke CloseCreationFailedTroubleTicket XQuery.
FindOrderCreationFailedTroubleTicketsBean	CloseCreationFailedTroubleTicketTask	Calls the FindOrderCreationFailedTroubleTickets XQuery.
CreateSIFalloutTroubleTicketRequestBean	CreateSIFalloutTroubleTicketTask	Calls the CreateSIFalloutTroubleTicket XQuery.
GetSIFalloutTroubleTicketResponse	CreateSIFalloutTroubleTicketTask	External event receiver to invoke GetTroubleTicketData XQuery.
FalloutnotificationRouterBean	FalloutNotificationRouterTask	Calls the FalloutNotificationRouter XQuery.
SIFalloutNotificationToCF	FalloutNotificationToCFTask	Internal event receiver to invoke FalloutNotificationToCFTask XQuery.
GetCreationFailFulfillmentOrderBean	GetCreationFailFulfillmentOrderTask	Internal event receiver to invoke GetCreationFailFulfillmentOrder XQuery.
GetFulfillmentOrder	GetFulfillmentOrderTask	Calls the FindFulfillmentOrderData XQuery.
GetFulfillmentOrderResponse	GetFulfillmentOrderTask	External event receiver to invoke CFwsResponseHandler XQuery.
OrderAbortPropagationCheckPlugin	OrderAbortPropagationCheck	Calls the OrderAbortPropagationCheck XQuery.
OrderAbortPropagationPlugin	OrderAbortPropagationTask	Calls the OrderAbortPropagation XQuery.
OrderAbortPropagationRespPlugin	OrderAbortPropagationTask	External event receiver to invoke OrderAbortPropagationResp XQuery.
SuspendCFOrderPlugin	SetCFOrderAbortInProgressTask	Calls the SuspendCFOrder XQuery.
SuspendCFOrderRespPlugin	SetCFOrderAbortInProgressTask	External event receiver to invoke CFwsResponseHandler XQuery.
UpdateCreationFailFulfillmentOrderBean	UpdateCreationFailFulfillmentOrderTask	Calls the UpdateCreationFailFulfillmentOrder XQuery.
UpdateFulfillmentOrderBean	UpdateFulfillmentOrderTask	Calls the UpdateFulfillmentOrder XQuery.
UpdateSIFalloutTroubleTicketRequest	UpdateSIFalloutTroubleTicketTask	Calls the UpdateSIFalloutTroubleTicket XQuery.
UpdateStatusRequestBean	UpdateStatusToCRMTask	Calls the UpdateStatusRequest XQuery.

External Fulfillment States

External fulfillment states in the OracleComms_OSM_O2A_COM_Base cartridge are defined in the COM_FulfillmentFunction order component specification, representing the base fulfillment function. All fulfillment functions, such as SyncCustomerFunction, extend from COM_FulfillmentFunction.

The following external fulfillment states are defined in this cartridge:

OPEN
IN_PROGRESS
IN_PROGRESS-FULFILL_BILLING_START
IN_PROGRESS-INITIATE_BILLING_START
IN_PROGRESS-INSTALL_START
IN_PROGRESS-INSTALL_PLANNED
IN_PROGRESS-INSTALL_COMMITTED
IN_PROGRESS-PROVISION_START
IN_PROGRESS-PROVISION_DESIGNED
IN_PROGRESS-SHIP_ORDER_START
IN_PROGRESS-SHIP_ORDER_PLANNED
IN_PROGRESS-SYNC_CUSTOMER_START
COMPLETE
COMPLETE-FULFILL_BILLING_COMPLETE
COMPLETE-INITIATE_BILLING_COMPLETE
COMPLETE-INSTALL_COMPLETE
COMPLETE-PROVISION_COMPLETE
COMPLETE-SHIP_ORDER_SHIPPED
COMPLETE-SYNC_CUSTOMER_COMPLETE
CANCELLED
CANCELLED-FULFILL_BILLING_COMPLETE
CANCELLED-FULFILL_BILLING_START
CANCELLED-INITIATE_BILLING_COMPLETE
CANCELLED-INITIATE_BILLING_START
CANCELLED-INSTALL_COMMITTED
CANCELLED-INSTALL_COMPLETE
CANCELLED-INSTALL_PLANNED
CANCELLED-INSTALL_START
CANCELLED-PROVISION_COMPLETE
CANCELLED-PROVISION_DESIGNED
CANCELLED-PROVISION_START
CANCELLED-SHIP_ORDER_PLANNED
CANCELLED-SHIP_ORDER_SHIPPED
CANCELLED-SHIP_ORDER_START
CANCELLED-SYNC_CUSTOMER_COMPLETE
CANCELLED-SYNC_CUSTOMER_START
FAILED
FAILED-FULFILL_BILLING_COMPLETE
FAILED-FULFILL_BILLING_START
FAILED-INITIATE_BILLING_COMPLETE
FAILED-INITIATE_BILLING_START
FAILED-INSTALL_COMMITTED
FAILED-INSTALL_COMPLETE
FAILED-INSTALL_PLANNED
FAILED-INSTALL_START
FAILED-PROVISION_COMPLETE
FAILED-PROVISION_DESIGNED
FAILED-PROVISION_START
FAILED-SHIP_ORDER_PLANNED
FAILED-SHIP_ORDER_SHIPPED
FAILED-SHIP_ORDER_START
FAILED-SYNC_CUSTOMER_COMPLETE
FAILED-SYNC_CUSTOMER_START
TSQ_Passed
TSQ_Passed-PROVISION_DESIGNED
TSQ_Failed
TSQ_Failed-PROVISION_DESIGNED

OracleComms_OSM_O2A_COM_SalesOrderFulfillment

The OracleComms_OSM_O2A_COM_SalesOrderFulfillment cartridge is a productized cartridge supporting the communications between central order management and fulfillment systems. It includes resources to generate requests to fulfillment providers and consume their responses and to do validation and condition evaluation.

Table 4-34 lists the XQuery modules defined in this cartridge.

Table 4-34 OracleComms_OSM_O2A_COM_SalesOrderFulfillment XQuery Modules

XQuery Module	Extendable	Description
AIAEBMRequest_do	No	Generates Oracle AIA EBM requests to a fulfillment provider.
AIAEBMRequest_redo	No	Generates Oracle AIA EBM requests to a fulfillment provider for redo.
AIAEBMRequest_undo	No	Generates Oracle AIA EBM requests to a fulfillment provider for undo.
AIAEBMResponse_ValidationModule	No	Validates Oracle AIA EBM responses from a fulfillment provider.
AIAEBMResponse	No	Consumes Oracle AIA EBM responses from a fulfillment provider.
DoublePlayComponentDependency	No	Order component dependency rule used to create the orchestration plan.
FalseRevision	No	Utility module to detect a false revision order.
InitiateWaitForProvisioningResponse	No	Initiates the wait for a provisioning response.
OrderLifecycleManagementModule	No	Utility module to support order lifecycle management for order and order line items.
PostSIBreakpoint	No	Supports breakpoints for the automated task FunctionPostSIBreakTask during undo.
PreSIBreakpoint	No	Supports breakpoints for the automated task FunctionPreSIBreakTask during undo.
SIEntryPoint	No	Provides lifecycle management for both customer order and service order. Used by automated task FunctionEntryPointTask. (This task should be used as the entry point task for a new fulfillment function.)
SIExitPoint	No	Module used by automated task FunctionExitPointTask to simulate order item data updates for the InstallOrder and ShipOrder fulfillment functions.
SIMilestone_doredo	No	Simulates milestone updates for the automated task FunctionPlannedTask for both InstallOrder and ShipOrder fulfillment function.
SIStartPoint	No	Module used by automated task FulfillBillingStartTask to provide a breakpoint before the start of the FulfillBilling function.
UpdateSalesOrderStatusFunctions	No	Provides functions for updating customer order's status.
FulfillmentStateModule	No	Contains configuration for calculating order and order item fulfillment state.
PointOfNoReturn	No	Checks whether an order component or order item has reached the point of no return.

OracleComms_OSM_O2A_COM_Billing

The OracleComms_OSM_O2A_COM_Billing cartridge is a productized cartridge that supports billing fulfillment functions. These functions specify subprocesses to handle delivery of a relevant subset of order data to the BRM ABCS, and handle responses from BRM ABCS. The modeled interaction includes coping with fallout, order change management, and status or data updates back to the CRM ABCS.

Table 4-35 lists the fulfillment functions defined in the cartridge.

Table 4-35 OracleComms_OSM_O2A_COM_Billing Fulfillment Functions

Fulfillment Function	Billing Pattern	Description
SyncCustomerFunction	Single-phase, two-phase	Provides the ability to synchronize only accounts from CRM to Billing as part of an order. SyncCustomerFunction is used in both single-phase and two-phase billing patterns. This function is essential because the pre-existence of a customer account in the billing provider is assumed before billing.
InitiateBillingFunction	Two-phase	Provides the ability to start the usage cycle. InitiateBillingFunction is the first phase in the two-phase billing pattern. In two-phase billing patterns, the first phase invokes InitiateBillingFunction, and the second phase invokes FulfillBillingFunction.
FulfillBillingFunction	Single-phase, two-phase	Provides the ability to start the billing cycle. FulfillBillingFunction is the single phase in the single-phase billing pattern and the second phase in the two-phase billing pattern.

Table 4-36 lists the XQuery modules in the cartridge that support component interaction.

Table 4-36 OracleComms_OSM_O2A_COM_Billing Component Interaction XQuery Modules

Component Interaction XQuery Module	Extendable	Description
BillingPatternModule	No	Determines the billing pattern based on order item's billing product type and product specification.
BillingInteractionModule	No	Creates a fulfillment request (in the format of an Oracle AIA EBM) to send to the billing system.
SyncCustomerInteractionModule	No	Provides functions to support SyncCustomerFunction.
InitiateBillingInteractionModule	No	Provides functions to support InitiateBillingFunction, using the BillingInteractionModule utility module.
FulfillBillingInteractionModule	No	Provides functions to support FulfillBillingFunction, using the BillingInteractionModule utility module.

SyncCustomerFunction

This section provides details of SyncCustomerFunction, one of the three fulfillment functions in the OracleComms_OSM_O2A_COM_Billing.

SyncCustomerFunction and Decomposition Rules

For the fulfillment request to be relevant for the billing provider to process, there must be at least one order line item with a service action that is relevant for the SyncCustomerFunction function to process. The decomposition rules in Table 4-37 ensure that SyncCustomerFunction is called only if relevant.

Table 4-37 Decomposition Rules for SyncCustomerFunction

Configuration	Cartridge	Decomposition Rule
Solution option without calculate service order, Simple Topology	OracleComms_OSM_O2A_SimpleTopology_Sample	Simple_DetermineSignificantUpdates_For_SyncCustomer
Solution option without calculate service order, Typical or Complex Topology	OracleComms_OSM_O2A_TypicalTopology_Sample	Typical_DetermineSignificantUpdates_For_SyncCustomer
Calculate service order solution option, all topologies	OracleComms_OSM_O2A_COM_CSO_Topology	Typical_DetermineSignificantUpdates_For_SyncCustomer

The decomposition conditions in the rules above return true() if fromOrderComponent (the order component being decomposed from) has at least one order line item that is relevant for SyncCustomerFunction to process. An order line item property is initialized to YES if the order line item is relevant for the billing provider's SyncCustomerFunction to process. By default, the service actions that are relevant for SyncCustomerFunction to process are:

Order line items with ServiceActionCode=ADD
SyncCustomer compensation-significant updates: Order line items with ServiceActionCode=UPDATE or MOVE-ADD with compensation-significant updates as determined by a comparison of the new and prior values from Siebel CRM in the customer order

SyncCustomerFunction and Fulfillment Patterns

The SyncCustomerFunction order component for fulfillment mode DELIVER is selected for each fulfillment pattern that supports the single and two-phase billing patterns. The order component SyncCustomerFunction is included in the BaseProductSpec fulfillment pattern. As a result, all fulfillment patterns which inherit from BaseProductSpec include SyncCustomerFunction as part of their fulfillment flow. This applies to each entity in the cartridge that configures fulfillment patterns, including any custom cartridge specifying the COM_SalesOrderFulfillment namespace.

SyncCustomerFunction XQuery Modules

Table 4-38 lists the XQuery modules defined for the SyncCustomerFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-38 SyncCustomerFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
SyncCustomerComplete_Event	COMPONENT-COMPLETE	Invoked when the SyncCustomerFunction component is completed.
SyncCustomerCreateAllOrderItemsEBM_Event	CREATE-EBM-ALL-ORDERITEMS	Invoked after CREATE-EBM-CUSTOM for the SyncCustomerFunction component to create all order items. This should always be invoked unless you want to create only the order header without any order items.
SyncCustomerCreateCustomEBM_Event	CREATE-EBM-CUSTOM	Invoked after CREATE-EBM for the SyncCustomerFunction component. Invokes extension logic on the order-level CUSTOM element.
SyncCustomerCreateEBM_DoEvent	CREATE-EBM (execution mode: do)	Invoked when the EBM is created in the do execution mode for the SyncCustomerFunction component.
SyncCustomerCreateEBM_ReDoEvent	CREATE-EBM (execution mode: redo)	Invoked when the EBM is created in the redo execution mode for the SyncCustomerFunction component.
SyncCustomerCreateEBM_UnDoEvent	CREATE-EBM (execution mode: undo)	Invoked when the EBM is created in the undo execution mode for the SyncCustomerFunction component.
SyncCustomerCreateOrderItemCustomEBM_Event	CREATE-EBM-ORDERITEM-CUSTOM	Invoked after CREATE-EBM-ORDERITEM for the SyncCustomerFunction component. Invokes extension logic on the order-item-level CUSTOM element.
SyncCustomerCreateOrderItemEBM_DoEvent	CREATE-EBM-ORDERITEM (execution mode: do)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the SyncCustomerFunction component in do execution mode. Invokes extension logic on the order item element.
SyncCustomerCreateOrderItemEBM_ReDoEvent	CREATE-EBM-ORDERITEM (execution mode: redo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the SyncCustomerFunction component in redo execution mode. Invokes extension logic on the order item element.
SyncCustomerCreateOrderItemEBM_UnDoEvent	CREATE-EBM-ORDERITEM (execution mode: undo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the SyncCustomerFunction component in undo execution mode. Invokes extension logic on the order item element.
SyncCustomerCreatePriorOrderItemCustomEBM_Event	CREATE-EBM-PRIORORDERITEM-CUSTOM	Invoked after CREATE-EBM-PRIORORDERITEM for the SyncCustomerFunction component. Invokes extension logic on the prior-order-item-level CUSTOM element.
SyncCustomerCreatePriorOrderItemEBM_Event	CREATE-EBM-PRIORORDERITEM	Invoked after CREATE-EBM-ORDERITEM-CUSTOM for the SyncCustomerFunction component. Invokes extension logic on the prior order item element.
SyncCustomerStart_Event	COMPONENT-START	Invoked when the SyncCustomerFunction component is started.
SyncCustomerUpdate_Event	COMPONENT-RESPONSE-UPDATE	Invoked when the SyncCustomerFunction updates are received to process order items on the billing response.
SyncCustomerValidateResponseEBM_Event	VALIDATE-RESPONSE-EBM	Invoked to validate the EBM response for the SyncCustomerFunction component.

SyncCustomerFunction Automation Modules

Table 4-39 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Billing cartridge for the SyncCustomerFunction fulfillment function.

Table 4-39 SyncCustomerFunction Automation Modules

Automation Module	Automated Task	Description
SyncCustomerEntryPointBean_doredo	SyncCustomerEntryPointTask	Calls the SIEntryPoint XQuery.
SyncCustomerBreakpointRequestBean	SyncCustomerPreSIBreakTask	Calls the PreSIBreakpoint XQuery.
SyncCustomerRequestBean_do	SyncCustomerSITask	Calls the AIAEBMRequest_do XQuery.
SyncCustomerRequestBean_redo	SyncCustomerSITask	Calls the AIAEBMRequest_redo XQuery.
SyncCustomerRequestBean_undo	SyncCustomerSITask	Calls the AIAEBMRequest_undo XQuery.
SyncCustomerResponseBean	SyncCustomerSITask	External event receiver to invoke AIAEBMResponse XQuery.
SyncCustomerBreakpointRequestBean	SyncCustomerPostSIBreakTask	Calls the PostSIBreakpoint XQuery.

InitiateBillingFunction

This section provides details of InitiateBillingFunction, one of the three fulfillment functions in the OracleComms_OSM_O2A_COM_Billing.

InitiateBillingFunction and Decomposition Rules

For the fulfillment request to be relevant for the billing provider to process, there must be at least one order line item with a service action that is relevant for the InitiateBillingFunction function to process. The decomposition rules in Table 4-40 ensure that InitiateBillingFunction is called only if relevant.

Table 4-40 Decomposition Rules for InitiateBillingFunction

Topology	Cartridge	Decomposition Rule
Solution option without calculate service order, Simple Topology	OracleComms_OSM_O2A_SimpleTopology_Sample	Simple_DetermineSignificantUpdates_For_InitiateBilling
Solution option without calculate service order, Typical or Complex Topology	OracleComms_OSM_O2A_TypicalTopology_Sample	Typical_DetermineSignificantUpdates_For_InitiateBilling
Calculate service order solution option, all topologies	OracleComms_OSM_O2A_COM_CSO_Topology	Typical_DetermineSignificantUpdates_For_InitiateBilling

Order line items with ServiceActionCode=ADD

InitiateBillingFunction and Fulfillment Patterns

The InitiateBillingFunction order component for fulfillment mode DELIVER is selected for each fulfillment pattern that supports the two-phase billing pattern. This includes the OracleComms_OSM_O2A_BBVoIPFulfillmentPatternNileFlow_Sample, OracleComms_OSM_O2A_BBVoIPFulfillmentPatternDanubeFlow_Sample, or any custom cartridge specifying the COM_SalesOrderFulfillment namespace.

Some of the sample fulfillment patterns included in the InitiateBillingFunction in the fulfillment flow are:

Service.VoIP
Service.CPE.VoIP (The IntiateBillingFunction order component is conditional based on whether the VoIP CPE is contained in a VoIP service. This condition is included in decomposition rules InitiateBillingFunction_To_YourSystemInstanceName1… InitiateBillingFunction_To_YourSystemInstanceNameN)
NonService.Offer (The IntiateBillingFunction order component is conditional based on whether the Offer contains VoIP services. This condition is included in decomposition rules InitiateBillingFunction_To_YourSystemInstanceName1… InitiateBillingFunction_To_YourSystemInstanceNameN)
NonService.BillingInitiatedItem
Non.Service.BillingItem

InitiateBillingFunction XQuery Modules

Table 4-41 lists the XQuery modules defined for the InitiateBillingFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-41 InitiateBillingFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
InitiateBillingComplete_Event	COMPONENT-COMPLETE	Invoked when the InitiateBillingFunction component is completed.
InitiateBillingCreateAllOrderItemsEBM_Event	CREATE-EBM-ALL-ORDERITEMS	Invoked after CREATE-EBM-CUSTOM for the InitiateBillingFunction component to create all order items. This should always be invoked unless you want to create only the order header without any order items.
InitiateBillingCreateCustomEBM_Event	CREATE-EBM-CUSTOM	Invoked after CREATE-EBM for the InitiateBillingFunction component. Invokes extension logic on the order-level CUSTOM element.
InitiateBillingCreateEBM_DoEvent	CREATE-EBM (execution mode: do)	Invoked when the EBM is created in the do execution mode for the InitiateBillingFunction component.
InitiateBillingCreateEBM_ReDoEvent	CREATE-EBM (execution mode: redo)	Invoked when the EBM is created in the redo execution mode for the InitiateBillingFunction component.
InitiateBillingCreateEBM_UnDoEvent	CREATE-EBM (execution mode: undo)	Invoked when the EBM is created in the undo execution mode for the InitiateBillingFunction component.
InitiateBillingCreateOrderItemCustomEBM_Event	CREATE-EBM-ORDERITEM-CUSTOM	Invoked after CREATE-EBM-ORDERITEM for the InitiateBillingFunction component. Invokes extension logic on the order-item-level CUSTOM element.
InitiateBillingCreateOrderItemEBM_DoEvent	CREATE-EBM-ORDERITEM (execution mode: do)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the InitiateBillingFunction component in do execution mode. Invokes extension logic on the order item element.
InitiateBillingCreateOrderItemEBM_ReDoEvent	CREATE-EBM-ORDERITEM (execution mode: redo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the InitiateBillingFunction component in redo execution mode. Invokes extension logic on the order item element.
InitiateBillingCreateOrderItemEBM_UnDoEvent	CREATE-EBM-ORDERITEM (execution mode: undo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the InitiateBillingFunction component in undo execution mode. Invokes extension logic on the order item element.
InitiateBillingCreatePriorOrderItemCustomEBM_Event	CREATE-EBM-PRIORORDERITEM-CUSTOM	Invoked after CREATE-EBM-PRIORORDERITEM for the InitiateBillingFunction component. Invokes extension logic on the prior-order-item-level CUSTOM element.
InitiateBillingCreatePriorOrderItemEBM_Event	CREATE-EBM-PRIORORDERITEM	Invoked after CREATE-EBM-ORDERITEM-CUSTOM for the InitiateBillingFunction component. Invokes extension logic on the prior order item element.
InitiateBillingStart_Event	COMPONENT-START	Invoked when the InitiateBillingFunction component is started.
InitiateBillingUpdate_Event	COMPONENT-RESPONSE-UPDATE	Invoked when the InitiateBillingFunction updates are received to process order items on the billing response.
InitiateBillingValidateResponseEBM_Event	VALIDATE-RESPONSE-EBM	Invoked to validate the EBM response for the InitiateBillingFunction component.

InitiateBillingFunction Automation Modules

Table 4-42 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Billing cartridge for the InitiateBillingFunction fulfillment function.

Table 4-42 InitiateBillingFunction Automation Modules

Automation Module	Automated Task	Description
InitiateBillingEntryPointBean_doredo	InitiateBillingEntryPointTask	Calls the SIEntryPoint XQuery.
InitiateBillingBreakpointRequestBean	InitiateBillingPreSIBreakTask	Calls the PreSIBreakpoint XQuery.
InitiateBillingRequestBean_do	InitiateBillingSITask	Calls the AIAEBMRequest_do XQuery.
InitiateBillingRequestBean_redo	InitiateBillingSITask	Calls the AIAEBMRequest_redo XQuery.
InitiateBillingRequestBean_undo	InitiateBillingSITask	Calls the AIAEBMRequest_undo XQuery.
InitiateBillingResponseBean	InitiateBillingSITask	External event receiver to invoke AIAEBMResponse XQuery.
InitiateBillingBreakpointRequestBean	InitiateBillingPostSIBreakTask	Calls the PostSIBreakpoint XQuery.

FulfillBillingFunction

This section provides details of FulfillBillingFunction, one of the three fulfillment functions in the OracleComms_OSM_O2A_COM_Billing.

FulfillBillingFunction and Decomposition Rules

For the fulfillment request to be relevant for the billing provider to process, there must be at least one order line item with a service action that is relevant for the FulfillBillingFunction function to process. The decomposition rules in Table 4-43 ensure that FulfillBillingFunction is called only if relevant.

Table 4-43 Decomposition Rules for FulfillBillingFunction

Topology	Cartridge	Decomposition Rule
Solution option without calculate service order, Simple Topology	OracleComms_OSM_O2A_SimpleTopology_Sample	Simple_DetermineSignificantUpdates_For_FulfillBilling
Solution option without calculate service order, Typical or Complex Topology	OracleComms_OSM_O2A_TypicalTopology_Sample	Typical_DetermineSignificantUpdates_For_FulfillBilling
Calculate service order solution option, all topologies	OracleComms_OSM_O2A_COM_CSO_Topology	Typical_DetermineSignificantUpdates_For_FulfillBilling

Order line items with ServiceActionCode=ADD, DELETE, UPDATE, SUSPEND, RESUME, MOVE-ADD, or MOVE-DELETE

FulfillBillingFunction and Fulfillment Patterns

The order component FulfillBillingFunction is included in the orchestration plan for the BaseProductSpec fulfillment pattern. This ensures that FulfillBillingFunction is included in the fulfillment flow for all fulfillment pattern entities that extend from BaseProductSpec. This includes any cartridge specifying the COM_SalesOrderFulfillment namespace.

All sample fulfillment patterns include FulfillBillingFunction.

Sample fulfillment patterns that include FulfillBillingFunction in a single-phase billing pattern (without InitiateBillingFunction) in the fulfillment flow are:

Service.Broadband
Service.CPE.Broadband
NonService.BillingItem

FulfillBillingFunction XQuery Modules

Table 4-44 lists the XQuery modules defined for the FulfillBillingFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-44 FulfillBillingFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
FulfillBillingComplete_Event	COMPONENT-COMPLETE	Invoked when the FulfillBillingFunction component is completed.
FulfillBillingCreateAllOrderItemsEBM_Event	CREATE-EBM-ALL-ORDERITEMS	Invoked after CREATE-EBM-CUSTOM for the FulfillBillingFunction component to create all order items. This should always be invoked unless you want to create only the order header without any order items.
FulfillBillingCreateCustomEBM_Event	CREATE-EBM-CUSTOM	Invoked after CREATE-EBM for the FulfillBillingFunction component. Invokes extension logic on the order-level CUSTOM element.
FulfillBillingCreateEBM_DoEvent	CREATE-EBM (execution mode: do)	Invoked when the EBM is created in the do execution mode for the FulfillBillingFunction component.
FulfillBillingCreateEBM_ReDoEvent	CREATE-EBM (execution mode: redo)	Invoked when the EBM is created in the redo execution mode for the FulfillBillingFunction component.
FulfillBillingCreateEBM_UnDoEvent	CREATE-EBM (execution mode: undo)	Invoked when the EBM is created in the undo execution mode for the FulfillBillingFunction component.
FulfillBillingCreateOrderItemCustomEBM_Event	CREATE-EBM-ORDERITEM-CUSTOM	Invoked after CREATE-EBM-ORDERITEM for the FulfillBillingFunction component. Invokes extension logic on the order-item-level CUSTOM element.
FulfillBillingCreateOrderItemEBM_DoEvent	CREATE-EBM-ORDERITEM (execution mode: do)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the FulfillBillingFunction component in do execution mode. Invokes extension logic on the order item element.
FulfillBillingCreateOrderItemEBM_ReDoEvent	CREATE-EBM-ORDERITEM (execution mode: redo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the FulfillBillingFunction component in redo execution mode. Invokes extension logic on the order item element.
FulfillBillingCreateOrderItemEBM_UnDoEvent	CREATE-EBM-ORDERITEM (execution mode: undo)	Invoked after CREATE-EBM-ALL-ORDERITEMS for the FulfillBillingFunction component in undo execution mode. Invokes extension logic on the order item element.
FulfillBillingCreatePriorOrderItemCustomEBM_Event	CREATE-EBM-PRIORORDERITEM-CUSTOM	Invoked after CREATE-EBM-PRIORORDERITEM for the FulfillBillingFunction component. Invokes extension logic on the prior-order-item-level CUSTOM element.
FulfillBillingCreatePriorOrderItemEBM_Event	CREATE-EBM-PRIORORDERITEM	Invoked after CREATE-EBM-ORDERITEM-CUSTOM for the FulfillBillingFunction component. Invokes extension logic on the prior order item element.
FulfillBillingStart_Event	COMPONENT-START	Invoked when the FulfillBillingFunction component is started.
FulfillBillingUpdate_Event	COMPONENT-RESPONSE-UPDATE	Invoked when the FulfillBillingFunction updates are received to process order items on the billing response.
FulfillBillingValidateResponseEBM_Event	VALIDATE-RESPONSE-EBM	Invoked to validate the EBM response for the FulfillBillingFunction component.

FulfillBillingFunction Automation Modules

Table 4-45 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Billing cartridge for the FulfillBillingFunction fulfillment function.

Table 4-45 FulfillBillingFunction Automation Modules

Automation Module	Automated Task	Description
FulfillBillingEntryPointBean_doredo	FulfillBillingEntryPointTask	Calls the SIEntryPoint XQuery.
FulfillBillingBreakpointRequestBean	FulfillBillingPreSIBreakTask	Calls the PreSIBreakpoint XQuery.
FulfillBillingRequestBean_do	FulfillBillingSITask	Calls the AIAEBMRequest_do XQuery.
FulfillBillingRequestBean_redo	FulfillBillingSITask	Calls the AIAEBMRequest_redo XQuery.
FulfillBillingRequestBean_undo	FulfillBillingSITask	Calls the AIAEBMRequest_undo XQuery.
FulfillBillingResponseBean	FulfillBillingSITask	External event receiver to invoke AIAEBMResponse XQuery.
FulfillBillingBreakpointRequestBean	FulfillBillingPostSIBreakTask	Calls the PostSIBreakpoint XQuery.
FulfillBillingStart	FulfillBillingStartTask	Calls the SIStartPoint XQuery.

Billing Dates for Billing Patterns

Billing dates are set when usage events start being rated (usage start date time), when cycle charges start being billed (cycle start date time), and when one time purchase charges should be billed (purchase start time). This section discusses how billing dates are generated.

Default Billing Dates for Two-Phase Billing Patterns

In a two-phase billing pattern, the billing dates are calculated based on data from the customer order and the determination of whether the LATENCY or VALIDATION pattern is used.

The billing dates are reset between the two billing phases (InitiateBillingFunction and FulfillBillingFunction).Billing dates are only set for order line items having the ServiceActionCode of ADD. The following order item properties are updated with the billing dates:

For phase 1, order item properties in ControlData/Functions/IntiateBillingFunction/orderItem/orderItemRef/WorkLineItemData/SalesOrderSchedule
- ServiceUsageStartDate
- PurchaseDate
- CycleStartDate
Note:
The three elements above have a data type of DateTime. However the names of the data elements as defined in the Oracle AIA EBM do not end with DateTime but Date only. O2A is following the names defined in the Oracle AIA EBM.
For phase 2, the order item properties from phase 1 are copied into properties with the same names in ControlData/Functions/FulfillBillingFunction/orderItem/orderItemRef/WorkPriorLineItemData/SalesOrderSchedule and all three Date fields are re-calculated as indicated in the Default Billing Dates for Phase 2 column in Table 4-46.

Table 4-46 lists the default date calculations applicable to two-phase billing patterns.

Table 4-46 Two-Phase Billing Pattern Date Calculations

Billing Pattern	Default Billing Dates for Phase 1	Default Billing Dates for Phase 2
LATENCY	ServiceUsageStartDate= OrderingBaseDateTime PurchaseDate = OrderingBaseDateTime CycleStartDate = OrderingBaseDateTime + 1 year	CycleStartDate = SalesOrderLine/CycleStartDate if populated; otherwise compute as Actual Delivery Date Time or Requested Delivery Date Time, whichever is later.
VALIDATION	ServiceUsageStartDate= OrderingBaseDateTime + 1 year PurchaseDate=OrderingBaseDateTime + 1 year CycleStartDate = OrderingBaseDateTime + 1 year	ServiceUsageStartDate = SalesOrderLine/ ServiceUsageStartDate if populated; otherwise Actual Delivery Date Time PurchaseDate = SalesOrderLine/PurchaseDate if populated; otherwise Actual Delivery Date Time CycleStartDate = SalesOrderLine/ CycleStartDate if populated; otherwise Actual Delivery Date Time or Requested Delivery Date Time, whichever is later.

Billing Pattern

Default Billing Dates for Phase 1

Default Billing Dates for Phase 2

LATENCY

ServiceUsageStartDate= OrderingBaseDateTime

PurchaseDate = OrderingBaseDateTime

CycleStartDate = OrderingBaseDateTime + 1 year

CycleStartDate = SalesOrderLine/CycleStartDate if populated; otherwise compute as Actual Delivery Date Time or Requested Delivery Date Time, whichever is later.

VALIDATION

ServiceUsageStartDate= OrderingBaseDateTime + 1 year

PurchaseDate=OrderingBaseDateTime + 1 year

CycleStartDate = OrderingBaseDateTime + 1 year

ServiceUsageStartDate = SalesOrderLine/ ServiceUsageStartDate if populated; otherwise Actual Delivery Date Time

PurchaseDate = SalesOrderLine/PurchaseDate if populated; otherwise Actual Delivery Date Time

CycleStartDate = SalesOrderLine/ CycleStartDate if populated; otherwise Actual Delivery Date Time or Requested Delivery Date Time, whichever is later.

Default Billing Dates for Single-Phase Billing Patterns

In a single-phase billing pattern, the billing dates are calculated based on data from the customer order.

Billing dates are only set for order line items having the ServiceActionCode of ADD. The following order item properties are updated with the billing dates:

Order item properties in ControlData/Functions/IntiateBillingFunction/orderItem/orderItemRef/WorkLineItemData/SalesOrderSchedule
- ServiceUsageStartDate: This is set to SalesOrderLine/ ServiceUsageStartDate if populated; otherwise ActualDeliveryDateTime
- PurchaseDate: This is set to SalesOrderLine/PurchaseDate if populated; otherwise ActualDeliveryDateTime
- CycleStartDateTime: This is set to SalesOrderLine/CycleStartDateTime if populated; otherwise Actual Delivery Date Time or Requested Delivery Date Time, whichever is later.

OracleComms_OSM_O2A_COM_Provisioning

The OracleComms_OSM_O2A_COM_Provisioning cartridge is a productized cartridge that supports the provisioning fulfillment functions. These functions specify a subprocess to handle delivery of a relevant subset of order data to the provisioning ABCS and to handle responses from the provisioning ABCS.

Table 4-47 lists the XQuery modules in the cartridge that support component interaction.

Table 4-47 OracleComms_OSM_O2A_COM_Provisioning Component Interaction XQuery Modules

Component Interaction XQuery Module	Extendable	Description
ProvisionOrderInteractionModule	No	Provides functions to support ProvisionOrderFunction when the calculate service order solution option is not being used.
ProvisionOrderInteractionModule_base	No	Provides base functions to support ProvisionOrderFunction when the calculate service order solution option is being used.
ProvisionOrderInteractionModule_do	No	Provides functions to support ProvisionOrderFunction for the do execution mode when the calculate service order solution option is being used.
ProvisionOrderInteractionModule_events	No	Provides event-related functions to support ProvisionOrderFunction when the calculate service order solution option is being used.
ProvisionOrderInteractionModule_redo	No	Provides functions to support ProvisionOrderFunction for the redo execution mode when the calculate service order solution option is being used.
ProvisionOrderInteractionModule_undo	No	Provides functions to support ProvisionOrderFunction for the undo execution mode when the calculate service order solution option is being used.

Table 4-48 lists the XQuery modules defined for the ProvisionOrderFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-48 ProvisionOrderFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
ProvisionOrderComplete_Event	COMPONENT-COMPLETE	Invoked when the ProvisionOrderFunction component is completed.
ProvisionOrderCreateEBM_DoEvent	CREATE-EBM (execution mode: do)	Invoked when the EBM is created in the do execution mode for the ProvisionOrderFunction component.
ProvisionOrderCreateEBM_ReDoEvent	CREATE-EBM (execution mode: redo)	Invoked when the EBM is created in the redo execution mode for the ProvisionOrderFunction component.
ProvisionOrderCreateEBM_UnDoEvent	CREATE-EBM (execution mode: undo)	Invoked when the EBM is created in the undo execution mode for the ProvisionOrderFunction component.
ProvisionOrderStart_Event	COMPONENT-START	Invoked when the ProvisionOrderFunction component is started.
ProvisionOrderValidateResponseEBM_Event	VALIDATE-RESPONSE-EBM	Invoked to validate the EBM response for the ProvisionOrderFunction component.
ProvisionOrderUpdate_Event	COMPONENT-RESPONSE-UPDATE	Invoked when the EBM response for ProvisionOrderFunction component is updated.

Table 4-49 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Provisioning cartridge for the ProvisionOrderFunction fulfillment function.

Table 4-49 ProvisionOrderFunction Automation Modules

Automation Module	Automated Task	Description
ProvisionOrderEntryPointBean_doredo	ProvisionOrderSIEntryPointTask	Calls the SIEntryPoint XQuery.
ProvisionOrderBreakpointRequestBean	ProvisionOrderPreSIBreakTask	Calls the PreSIBreakpoint XQuery.
ProvisionOrderRequestBean_do	ProvisionOrderSITask	Calls the AIAEBMRequest_do XQuery.
ProvisionOrderRequestBean_redo	ProvisionOrderSITask	Calls the AIAEBMRequest_redo XQuery.
ProvisionOrderRequestBean_undo	ProvisionOrderSITask	Calls the AIAEBMRequest_undo XQuery.
ProvisionOrderResponseBean	ProvisionOrderSITask	External event receiver to invoke AIAEBMResponse XQuery.
ProvisionOrderBreakpointRequestBean	ProvisionOrderPostSIBreakTask	Calls the PostSIBreakpoint XQuery.
InitiateWaitforProvisioningResponseBean	ProvisionOrderSIResponseTask	Calls the InitiateWaitforProvisioningResponse XQuery.
ProvisioningResponseBean	ProvisionOrderSIResponseTask	External event receiver to invoke AIAEBMResponse XQuery for do, redo and amend-do mode.

OracleComms_OSM_O2A_COM_Shipping_Sample

The OracleComms_OSM_O2A_COM_Shipping_Sample cartridge is a demonstration cartridge that supports the shipping fulfillment functions. These functions specify subprocesses to handle delivery of a relevant subset of order data to supply chain management.

Table 4-50 lists he XQuery modules in the cartridge that support component interaction.

Table 4-50 OracleComms_OSM_O2A_COM_Shipping_Sample Component Interaction XQuery Modules

Component Interaction XQuery Module	Extendable	Description
ShipOrderInteractionModule	Yes	Provides functions to support ShipOrderFunction.

Table 4-51 lists the XQuery modules defined for the ShipOrderFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-51 ShipOrderFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
ShipOrderComplete_Event	COMPONENT-COMPLETE	Invoked when the ShipOrderFunction component is completed.
ShipOrderStart_Event	COMPONENT-START	Invoked when the ShipOrderFunction component is started.

Table 4-52 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Shipping_Sample cartridge for the ShipOrderFunction fulfillment function.

Table 4-52 ShipOrderFunction Automation Modules

Automation Module	Automated Task	Description
ShipOrderEntryPointBean	ShipOrderEntryPointTask	Calls the SIEntryPoint XQuery.
ShipOrderPlannedBean	ShipOrderPlannedTask	Calls the SIMilestone_doredo XQuery to return the SHIP ORDER PLANNED milestone.
ShipOrderExitPointBean	ShipOrderExitPointTask	Calls the SIExitPoint XQuery.

OracleComms_OSM_O2A_COM_Install_Sample

The OracleComms_OSM_O2A_COM_Install_Sample cartridge is a demonstration cartridge that supports the installation fulfillment functions for High-Speed Internet. These functions specify subprocesses to handle delivery of a relevant subset of order data to supply chain management.

Table 4-53 lists he XQuery modules in the cartridge that support component interaction.

Table 4-53 OracleComms_OSM_O2A_COM_Install_Sample Component Interaction XQuery Modules

Component Interaction XQuery Module	Extendable	Description
InstallOrderInteractionModule	Yes	Provides functions to support InstallOrderFunction.

Table 4-54 lists the XQuery modules defined for the InstallOrderFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-54 InstallOrderFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
InstallOrderComplete_Event	COMPONENT-COMPLETE	Invoked when the InstallOrderFunction component is completed.
InstallOrderStart_Event	COMPONENT-START	Invoked when the InstallOrderFunction component is started.

Table 4-55 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Install_Sample cartridge for the InstallOrderFunction fulfillment function.

Table 4-55 InstallOrderFunction Automation Modules

Automation Module	Automated Task	Description
InstallOrderEntryPointBean	InstallOrderEntryPointTask	Calls the SIEntryPoint XQuery.
InstallOrderPlannedBean	InstallOrderPlannedTask	Calls the SIMilestone_doredo XQuery to return the INSTALL PLANNED milestone.
InstallOrderCommittedBean	InstallOrderCommittedTask	Calls the SIMilestone_doredo XQuery to return the INSTALL COMMITTED milestone.
InstallOrderExitPointBean	InstallOrderExitPointTask	Calls the SIExitPoint XQuery.

OracleComms_OSM_O2A_COM_Recognition_Sample

The OracleComms_OSM_O2A_COM_Recognition_Sample cartridge is a demonstration cartridge that recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. In addition, this cartridge recognizes order fallout notifications, trouble ticket requests, and inbound message errors due to suspended orders or resource issues. It also catches all unrecognizable messages.

Table 4-56 lists the order recognition rules defined in this cartridge.

Table 4-56 OracleComms_OSM_O2A_COM_Recognition_Sample Order Recognition Rules

Order Recognition Rule	Description
COM_CloseTroubleTicketWorkOrder_Recognition	Recognizes a request to close an order as a result of a trouble ticket.
COM_FaultNotificationOrder_Recognition	Recognizes order fallout notifications from Oracle AIA.
COM_ORPFallout_CTT_OrderRecognitionRule	Recognizes an ORP fallout and triggers creation of a fulfillment request for a trouble ticketing system.
COM_ResumePendingIbMsg_OrderRecognitionRule	Recognizes an inbound message and triggers creation of a ResumePendingInBoundMessage order.
COM_SalesOrderFulfillment_Recognition	Recognizes an Oracle AIA customer order and triggers the creation of a COM_SalesOrderFulfillment order.

Revision Number Update for Canceled Orders

When AIA receives an order that has a mode of CANCEL, or when an order is received in which all of the order line items have an action code of NONE, AIA does not update the revision number. Because OSM will ignore a revision order if its revision number is the same as on a previously received order revision, the OTA recognition cartridges update the revision number on orders of this type to 999999999. This ensures that the cancelation is processed.

OracleComms_OSM_O2A_COM_Asset

The OracleComms_OSM_O2A_COM_Asset cartridge is a cartridge supporting asset management for an external system. It is present in the workspace for any central order management configuration, but is only included in the solution cartridge if, during system configuration, you selected to use an external asset management system.

Table 4-57 to Table 4-60 list the entities in the OracleComms_OSM_O2A_COM_Asset cartridge.

Table 4-57 OracleComms_OSM_O2A_COM_Asset Entities

Name	Type	Description
COM_AssetIntegration_Recognition	Order Recognition Rule	Recognizes an asset order and creates a COM_AssetIntegration order to manage its fulfillment.
COM_AssetIntegration	Order	Local asset order structure for managing an asset order for an external system.
COM_AssetIntegration_Policy	Lifecycle Policy	Defines the security permissions for order transactions.
COM_AssetIntegration_Role	Role	Role with permissions to create and view COM_AssetIntegration orders.
COM_AssetIntegration_Process	Process and Tasks	Process to handle provisioning of asset orders to an external system.
COM_AssetIntegration_CreationTask	Manual Task	Creation task to create a COM_AssetIntegration order.
COM_AssetIntegration_QueryTask	Manual Task	Query task used by a manual user to view the asset order.
OracleComms_OSM_O2A_COM_Asset	Data Schema	Data structures for managing assets.

Table 4-58 OracleComms_OSM_O2A_COM_Asset XQuery Modules

XQuery Module	Extendable	Description
AssetCreationRequet	Yes	Creates a message to send to the external asset management system via JMS. The message will contain a request to create an asset. You can modify this file to change the format of the message sent to what is expected by the actual system. The default format is the same as what is expected by the OSM Customer Asset Manager.
AssetCreationResponse	Yes	Consumes the response from the external asset management system. You can modify this file to change the way the response message is handled. The default implementation is to save the response to the order template then complete the task.
AssetIntegrationData	Yes	Populates order creation data.
AssetIntegrationRecognition	Yes	Supports the order creation recognition rule.
AssetExtensionPoint	Yes	Defines XQuery extension points for assets. This will be added to the registration of the extension point ORDER-EXTENSION-UPDATE-STATUS-EBM.

Table 4-59 OracleComms_OSM_O2A_COM_Asset XML Configuration Files

XML File	Description
AssetCreationConfiguration	Contains the system IDs for the upstream sales order management systems that can create assets. If the order comes from a system in this file, and contains services that are configured to create assets, the assets will be created in either the OSM asset management system or an external asset management system, or both, depending on how you have configured your system.
assetcatalog	Template for creating XML catalog entries for assets.

Table 4-60 OracleComms_OSM_O2A_COM_Asset Automation Modules

Automation Module	Automated Task	Description
ExternalAssetCreationRequest	AssetIntegrationSITask	Calls the AssetCreationRequet XQuery.
ExternalAssetCreationResponse	AssetIntegrationSITask	Calls the AssetCreationResponse XQuery.

Central Order Management Cartridges for the Calculate Service Order Solution Option

OracleComms_OSM_O2A_COM_CSO_Base

The OracleComms_OSM_O2A_COM_CSO_Base cartridge is a productized cartridge. It contains entities that support the orchestration of orders for the calculate service order solution option. It includes the following entities:

Order Item Specification: COM_TransformedServiceLine: This order item specification defines the order item information for transformed order items.
Data Schema: OracleComms_OSM_O2A_COM_CSO_Data: This data schema contains elements relating to transformed order items.
Orchestration Process: COM_SalesOrderFulfillmentOrchestrationProcess: This orchestration process invokes the order transformation manager.
Transformation Sequence: COM_OTM_Sequence: This orchestration sequence has four stages. For more information, see the discussion of transformation sequences in OSM Concepts.

OracleComms_OSM_O2A_COM_CSO_Broadband_Internet_Access_CFS

The OracleComms_OSM_O2A_COM_CSO_Broadband_Internet_Access_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for broadband internet access. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_CSO_Email_CFS

The OracleComms_OSM_O2A_COM_CSO_Email_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for email service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_CSO_FulfillmentPattern

The OracleComms_OSM_O2A_COM_CSO_FulfillmentPattern cartridge is a productized cartridge that contains fulfillment patterns and orchestration dependencies for the calculate service order solution option.

OracleComms_OSM_O2A_COM_CSO_FulfillmentStateMap

The OracleComms_OSM_O2A_COM_CSO_FulfillmentStateMap cartridge is a productized cartridge. It fulfillment state maps and transformed order item fulfillment state composition rule sets specific to the calculate service order solution option.

OracleComms_OSM_O2A_COM_CSO_Internet_Media_CFS

The OracleComms_OSM_O2A_COM_CSO_Internet_Media_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for Internet media service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_CSO_IP_Fax_CFS

The OracleComms_OSM_O2A_COM_CSO_IP_Fax_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for IP fax service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_CSO_Model_Container

The OracleComms_OSM_O2A_COM_CSO_Model_Container cartridge is a demonstration cartridge. It defines the common model projects that contain elements that might need to be included in the deployment and contains the transformation manager for the calculate service order solution option.

To see the common model projects that are contained by this cartridge, open the Properties tab of the cartridge editor. For more information about the common model projects included with the Order-to-Activate cartridges, see "Conceptual Model Projects."

OracleComms_OSM_O2A_COM_CSO_Provisioning

The OracleComms_OSM_O2A_COM_CSO_Provisioning cartridge is a demonstration cartridge. It contains order components for provisioning that are specific to the calculate service order solution option.

External Fulfillment States

External fulfillment states in the OracleComms_OSM_O2A_COM_CSO_Provisioning cartridge are defined in the ProvisioningOrderFunction order component specification for use withy the calculate service order solution option.

The following external fulfillment states are defined in this cartridge:

IN_PROGRESS-BROADBANDINTERNETDOMAIN_PROVISION_DESIGNED
IN_PROGRESS-BROADBANDINTERNETDOMAIN_PROVISION_ISSUED
IN_PROGRESS-VOIPDOMAIN_PROVISION_DESIGNED
IN_PROGRESS-VOIPDOMAIN_PROVISION_ISSUED
FAILED-VOIPDOMAIN_PROVISION_FAILED
FAILED-BROADBANDINTERNETDOMAIN_PROVISION_FAILED
IN_PROGRESS-BROADBANDINTERNETDOMAIN_PROVISION_START
IN_PROGRESS-VOIPDOMAIN_PROVISION_START
CANCELLED-VOIPDOMAIN_PROVISION_DESIGNED
CANCELLED-VOIPDOMAIN_PROVISION_START
CANCELLED-VOIPDOMAIN_PROVISION_ISSUED
CANCELLED-BROADBANDINTERNETDOMAIN_PROVISION_DESIGNED
CANCELLED-BROADBANDINTERNETDOMAIN_PROVISION_START
CANCELLED-BROADBANDINTERNETDOMAIN_PROVISION_ISSUED
COMPLETE-VOIPDOMAIN_PROVISION_COMPLETE
COMPLETE-BROADBANDINTERNETDOMAIN_PROVISION_COMPLETE
FAILED-BROADBANDINTERNETDOMAIN_PROVISION_AUXILIARY_FAILED
FAILED-VOIPDOMAIN_PROVISION_AUXILIARY_FAILED
IN_PROGRESS-INTERNETMEDIADOMAIN_PROVISION_START
IN_PROGRESS-INTERNETMEDIADOMAIN_PROVISION_DESIGNED
IN_PROGRESS-INTERNETMEDIADOMAIN_PROVISION_ISSUED
IN_PROGRESS-EMAILDOMAIN_PROVISION_START
IN_PROGRESS-EMAILDOMAIN_PROVISION_DESIGNED
IN_PROGRESS-EMAILDOMAIN_PROVISION_ISSUED
CANCELLED-EMAILDOMAIN_PROVISION_DESIGNED
CANCELLED-EMAILDOMAIN_PROVISION_START
CANCELLED-EMAILDOMAIN_PROVISION_ISSUED
CANCELLED-INTERNETMEDIADOMAIN_PROVISION_DESIGNED
CANCELLED-INTERNETMEDIADOMAIN_PROVISION_START
CANCELLED-INTERNETMEDIADOMAIN_PROVISION_ISSUED
COMPLETE-EMAILDOMAIN_PROVISION_COMPLETE
COMPLETE-INTERNETMEDIADOMAIN_PROVISION_COMPLETE
FAILED-EMAILDOMAIN_PROVISION_FAILED
FAILED-EMAILDOMAIN_PROVISION_AUXILIARY_FAILED
FAILED-INTERNETMEDIADOMAIN_PROVISION_FAILED
FAILED-INTERNETMEDIADOMAIN_PROVISION_AUXILIARY_FAILED

OracleComms_OSM_O2A_COM_CSO_SalesOrders

The OracleComms_OSM_O2A_COM_CSO_SalesOrders cartridge is a demonstration cartridge that contains sample customer orders for use with the calculate service order solution option. These orders are in the same format as orders that are received in an integrated environment with Oracle AIA, Siebel CRM, and CRM ABCS. In a standalone OSM environment, you can submit them to central order management to generate and execute an orchestration plan. In a standalone OSM environment, EBMs are placed on OSM JMS queues for pickup by Oracle AIA.

Note:

Each customer order that you send must contain a unique EBM ID. For example, the EBM ID of a cancel order request (revision order) cannot be the same as the EBM ID of the original base order (new order).

Table 4-61 describes the order numbers for new and change orders:

Table 4-61 OracleComms_OSM_O2A_COM_CSO_SalesOrders Order Descriptions

Order ID	Order XML File	Description
testcso-doubleplay-voip-broadband	testcso-all.xml	Adds all domain services (Broadband, VoIP, Email and Internet Media) and creates all CFS services lines.
testcso-bandwidth	testcso-bandwidth.xml	Add primary broadband line with auxiliary line that defines upload/download bandwidth.
testcso-broadband	testcso-broadband.xml	Add primary basic broadband line only.
testcso-cme-voip	testcso-cme-voip_base.xml	Add VoIP feature services.
testcso-cme-voip	testcso-cme-voip_revision.xml	Revision to add extra VoIP services
testcso-doubleplay-voip-delete	testcso-doubleplay-voip-broadband.xml	Add Broadband and VoIP services.
testcso-email	testcso-email.xml	Add Email service.
testcso-firewall	testcso-firewall.xml	Add Firewall service.
TestCSO_InternetMedia_1	testcso-internetmedia.xml	Add Internet Media service.
TestCSO_IP_FAX	testcso-ip-fax.xml	Add IP Fax service.
testcso-modem	testcso-modem.xml	Add Broadband Modem service.
testcso-modem	testcso-modem-cancel.xml	Cancel Broadband Modem service.
testcso-router	testcso-router.xml	Add Broadband Router service.
testcso-voip-callerid	testcso-voip-callerid.xml	Add VoIP Caller ID service via Value Added Services.
testcso-voip	testcso-voip.xml	Add VoIP Services.
testcso-web-conference	testcso-web-conference.xml	Add Web Conference service.

OracleComms_OSM_O2A_COM_CSO_Solution

The OracleComms_OSM_O2A_COM_CSO_Solution cartridge is a demonstration composite cartridge that references all cartridges required for central order management in the topology you selected when installing the Order-to-Activate cartridges.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_COM_CSO_Topology

The OracleComms_OSM_O2A_COM_CSO_Topology cartridge is a demonstration cartridge containing decomposition rules and order component specifications to decompose billing, provisioning, shipping, and install fulfillment functions into the topology you selected when installing the Order-to-Activate cartridges.

Table 4-62 contains a list of the order component specifications defined in this cartridge.

Table 4-62 OracleComms_OSM_O2A_COM_CSO_Topology Order Component Specifications

Order Component Specification	Description
BRM-ALL	Represents the billing fulfillment system if there is a single billing system.
BRM-BIZBDB	Represents the billing fulfillment system for business broadband customers.
BRM-REZBDB	Represents the billing fulfillment system for residential broadband customers.
BRM-VIRTUAL	Represents the billing fulfillment system for non-service billing functions.
BRM-VoIP	Represents the billing fulfillment system for VoIP customers.
Provisioning-ALL	Represents the provisioning fulfillment system if there is a single provisioning system.
Provisioning-Broadband	Represents the provisioning system for broadband customers.
Provisioning-VoIP	Represents the provisioning system for VoIP customers.
Shipping-ALL	Represents the shipping fulfillment system if there is a single shipping system.
Shipping-InHouse	Represents the shipping system for shipments without partner involvement.
Shipping-PartnerInc	Represents the shipping system for shipments with partner involvement.
WFM-A	Represents the first workflow management fulfillment system if there is more than one workflow management system.
WFM-ALL	Represents the workflow management fulfillment system if there is a single workflow management system.
WFM-B	Represents the second workflow management fulfillment system if there is more than one workflow management system.

OracleComms_OSM_O2A_COM_CSO_VoIP_Access_CFS

The OracleComms_OSM_O2A_COM_CSO_VoIP_Access_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for VoIP access. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_CSO_Web_Conferencing_CFS

The OracleComms_OSM_O2A_COM_CSO_Web_Conferencing_CFS cartridge is a demonstration cartridge that contains the mapping rules and order item parameter bindings associated with the customer facing service for Web conferencing service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_COM_FulfillmentPattern

The OracleComms_OSM_O2A_COM_FulfillmentPattern cartridge is a productized cartridge. It contains the base fulfillment pattern, BaseProductSpec, from which other fulfillment patterns can inherit.

OracleComms_OSM_O2A_COM_FulfillmentStateMap_Sample

The OracleComms_OSM_O2A_COM_FulfillmentStateMap_Sample cartridge is a productized cartridge that contains fulfillment state entities used by the solution.

This cartridge contains the following common fulfillment state definitions, which are used in composition rules. Listed under each main fulfillment state are its child states.

OPEN
IN_PROGRESS
- IN_PROGRESS-FULFILL_BILLING_START
- IN_PROGRESS-INITIATE_BILLING_START
- IN_PROGRESS-INSTALL_COMMITTED
- IN_PROGRESS-INSTALL_PLANNED
- IN_PROGRESS-INSTALL_START
- IN_PROGRESS-PROVISION_DESIGNED
- IN_PROGRESS-PROVISION_ISSUED
- IN_PROGRESS-PROVISION_START
- IN_PROGRESS-SHIP_ORDER_PLANNED
- IN_PROGRESS-SHIP_ORDER_START
- IN_PROGRESS-SYNC_CUSTOMER_START
COMPLETE
- COMPLETE-FULFILL_BILLING_COMPLETE
- COMPLETE-FULFILL_BILLING_START
- COMPLETE-INITIATE_BILLING_COMPLETE
- COMPLETE-INITIATE_BILLING_START
- COMPLETE-INSTALL_COMPLETE
- COMPLETE-INSTALL_START
- COMPLETE-PROVISION_COMPLETE
- COMPLETE-PROVISION_DESIGNED
- COMPLETE-PROVISION_ISSUED
- COMPLETE-PROVISION_START
- COMPLETE-SHIP_ORDER_SHIPPED
- COMPLETE-SHIP_ORDER_START
- COMPLETE-SYNC_CUSTOMER_COMPLETE
- COMPLETE-SYNC_CUSTOMER_START
CANCELLED
- CANCELLED-FULFILL_BILLING_COMPLETE
- CANCELLED-FULFILL_BILLING_START
- CANCELLED-INITIATE_BILLING_COMPLETE
- CANCELLED-INITIATE_BILLING_START
- CANCELLED-INSTALL_COMMITTED
- CANCELLED-INSTALL_COMPLETE
- CANCELLED-INSTALL_PLANNED
- CANCELLED-INSTALL_START
- CANCELLED-PROVISION_COMPLETE
- CANCELLED-PROVISION_DESIGNED
- CANCELLED-PROVISION_ISSUED
- CANCELLED-PROVISION_START
- CANCELLED-SHIP_ORDER_PLANNED
- CANCELLED-SHIP_ORDER_SHIPPED
- CANCELLED-SHIP_ORDER_START
- CANCELLED-SYNC_CUSTOMER_COMPLETE
- CANCELLED-SYNC_CUSTOMER_START
FAILED
- FAILED-FULFILL_BILLING_COMPLETE
- FAILED-FULFILL_BILLING_START
- FAILED-INITIATE_BILLING_COMPLETE
- FAILED-INITIATE_BILLING_START
- FAILED-INSTALL_COMMITTED
- FAILED-INSTALL_COMPLETE
- FAILED-INSTALL_PLANNED
- FAILED-INSTALL_START
- FAILED-PROVISION_AUXILIARY
- FAILED-PROVISION_COMPLETE
- FAILED-PROVISION_DESIGNED
- FAILED-PROVISION_FAILED
- FAILED-PROVISION_ISSUED
- FAILED-PROVISION_START
- FAILED-SHIP_ORDER_PLANNED
- FAILED-SHIP_ORDER_SHIPPED
- FAILED-SHIP_ORDER_START
- FAILED-SYNC_CUSTOMER_COMPLETE
- FAILED-SYNC_CUSTOMER_START

OracleComms_OSM_O2A_COMSOM_CSO_Recognition

The OracleComms_OSM_O2A_COMSOM_CSO_Recognition cartridge is a demonstration cartridge that recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. In addition, this cartridge recognizes order fallout notifications, trouble ticket requests, and inbound message errors due to suspended orders or resource issues. It also catches all unrecognizable messages.

Table 4-63 lists the order recognition rules defined in this cartridge.

Table 4-63 OracleComms_OSM_O2A_COMSOM_CSO_Recognition Order Recognition Rules

Order Recognition Rule	Description
COM_CloseTroubleTicketWorkOrder_Recognition	Recognizes a request to close an order as a result of a trouble ticket.
COM_FaultNotificationOrder_Recognition	Recognizes order fallout notifications from Oracle AIA.
COM_ORPFallout_CTT_OrderRecognitionRule	Recognizes an ORP fallout and triggers creation of a fulfillment request for a trouble ticketing system.
COMSOM_CSO_Recognize_AbortPropagationServiceOrder	Recognizes a termination request for an order.
COMSOM_CSO_RecognizeEBM_ProvisioningOrder	Recognizes and EBM provisioning order.
COM_ResumePendingIbMsg_OrderRecognitionRule	Recognizes an inbound message and triggers creation of a ResumePendingInBoundMessage order.
COM_SalesOrderFulfillment_Recognition	Recognizes an Oracle AIA customer order and triggers the creation of a COM_SalesOrderFulfillment order.

Revision Number Update for Canceled Orders

OracleComms_OSM_O2A_COMSOM_CSO_Solution

The OracleComms_OSM_O2A_COMSOM_CSO_Solution cartridge is a demonstration composite cartridge that references all cartridges required for central order management and service order management in the topology you selected when installing the Order-to-Activate cartridges.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

Central Order Management Cartridges for the Solution Option Without Calculate Service Order

OracleComms_OSM_O2A_BBVoIP_FP_NP_Danube_Sample

The OracleComms_OSM_O2A_BBVoIP_FP_NP_Danube_Sample cartridge contains fulfillment patterns and orchestration dependencies for the Simple topology.

The following fulfillment patterns are configured in this cartridge:

BaseProductSpec – All other fulfillment patterns extend from this.
NonService.BillingInitiatedItem
NonService.BillingItem
NonService.Offer
Service.Broadband
Service.CPE.Broadband
Service.CPE.VoIP
Service.Install
Service.VoIP

OracleComms_OSM_O2A_BBVoIP_FP_NP_Nile_Sample

The OracleComms_OSM_O2A_BBVoIP_FP_NP_Nile_Sample cartridge contains fulfillment patterns and orchestration dependencies for the Typical or Complex topologies.

The following fulfillment patterns are configured in this cartridge:

BaseProductSpec – All other fulfillment patterns extend from this.
NonService.BillingInitiatedItem
NonService.BillingItem
NonService.Offer
Service.Broadband
Service.CPE.Broadband
Service.CPE.VoIP
Service.Install
Service.VoIP

OracleComms_OSM_O2A_COM_NCSO_Base

The OracleComms_OSM_O2A_COM_NCSO_Base cartridge is a productized cartridge. It contains the orchestration process, COM_SalesOrderFulfillmentOrchestrationProcess, that supports the orchestration of orders for the solution option without calculate service order.

OracleComms_OSM_O2A_COM_NCSO_Provisioning

The OracleComms_OSM_O2A_COM_NCSO_Provisioning cartridge is a demonstration cartridge. It contains an order component for provisioning, ProvisionOrderFunction, that is specific to the service option without calculate service order.

Table 4-64 lists the XQuery modules defined for the ProvisionOrderFunction fulfillment function. Customers can provide their own implementation of the XQuery modules in this fulfillment function indicated extension points. See "Extending XQuery Modules" for more information about XQuery extension points.

Table 4-64 ProvisionOrderFunction XQuery Modules

XQuery Module	XQuery Extension Point	Description
ProvisionOrderComplete_Event	COMPONENT-COMPLETE	Invoked when the ProvisionOrderFunction component is completed.
ProvisionOrderCreateEBM_DoEvent	CREATE-EBM (execution mode: do)	Invoked when the EBM is created in the do execution mode for the ProvisionOrderFunction component.
ProvisionOrderCreateEBM_ReDoEvent	CREATE-EBM (execution mode: redo)	Invoked when the EBM is created in the redo execution mode for the ProvisionOrderFunction component.
ProvisionOrderCreateEBM_UnDoEvent	CREATE-EBM (execution mode: undo)	Invoked when the EBM is created in the undo execution mode for the ProvisionOrderFunction component.
ProvisionOrderStart_Event	COMPONENT-START	Invoked when the ProvisionOrderFunction component is started.
ProvisionOrderValidateResponseEBM_Event	VALIDATE-RESPONSE-EBM	Invoked to validate the EBM response for the ProvisionOrderFunction component.
ProvisionOrderUpdate_Event	COMPONENT-RESPONSE-UPDATE	Invoked when the EBM response for ProvisionOrderFunction component is updated.

Table 4-65 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_COM_Provisioning cartridge for the ProvisionOrderFunction fulfillment function.

Table 4-65 ProvisionOrderFunction Automation Modules

Automation Module	Automated Task	Description
ProvisionOrderEntryPointBean_doredo	ProvisionOrderSIEntryPointTask	Calls the SIEntryPoint XQuery.
ProvisionOrderBreakpointRequestBean	ProvisionOrderPreSIBreakTask	Calls the PreSIBreakpoint XQuery.
ProvisionOrderRequestBean_do	ProvisionOrderSITask	Calls the AIAEBMRequest_do XQuery.
ProvisionOrderRequestBean_redo	ProvisionOrderSITask	Calls the AIAEBMRequest_redo XQuery.
ProvisionOrderRequestBean_undo	ProvisionOrderSITask	Calls the AIAEBMRequest_undo XQuery.
ProvisionOrderResponseBean	ProvisionOrderSITask	External event receiver to invoke AIAEBMResponse XQuery.
ProvisionOrderBreakpointRequestBean	ProvisionOrderPostSIBreakTask	Calls the PostSIBreakpoint XQuery.
InitiateWaitforProvisioningResponseBean	ProvisionOrderSIResponseTask	Calls the InitiateWaitforProvisioningResponse XQuery.
ProvisioningResponseBean	ProvisionOrderSIResponseTask	External event receiver to invoke AIAEBMResponse XQuery for do, redo and amend-do mode.

OracleComms_OSM_O2A_COM_Simple_NP_Soln

The OracleComms_OSM_O2A_COM_Simple_NP_Soln cartridge is a demonstration composite cartridge that references all cartridges required for central order management in the Simple topology.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_COM_Typical_NP_Soln

The OracleComms_OSM_O2A_COM_Typical_NP_Soln cartridge is a demonstration composite cartridge that references all cartridges required for central order management in the Typical or Complex topologies.

The OracleComms_OSM_O2A_COM_Simple_NP_Soln cartridge is a demonstration composite cartridge that references all cartridges required for central order management in the Simple topology.

OracleComms_OSM_O2A_COMSOM_Recognition_Sample

The OracleComms_OSM_O2A_COMSOM_Recognition_Sample cartridge is a demonstration cartridge that is used when central order management and service order management are deployed together in the same OSM instance. It recognizes a customer order from Oracle AIA and triggers the creation of a COM_SalesOrderFulfillment order. In addition, this cartridge recognizes order fallout notifications, trouble ticket requests, and inbound message errors due to suspended orders or resource issues. It also catches all unrecognizable messages.

Table 4-66 lists the order recognition rules defined in this cartridge.

Table 4-66 OracleComms_OSM_O2A_COMSOM_Recognition_Sample Order Recognition Rules

Order Recognition Rule	Description
COMSOM_CloseTroubleTicketWorkOrder	Recognizes a request to close an order as a result of a trouble ticket.
COMSOM_FaultNotificationOrder	Recognizes order fallout notifications from Oracle AIA.
COMSOM_LFAbortOrderPropagationOrder	Recognizes a termination request for an order.
COMSOM_ORPFallout_CTT_Order	Recognizes an ORP fallout and triggers creation of a fulfillment request for a trouble ticketing system.
COMSOM_ProvisionOrderFulfillment	Recognizes a service order that must be executed and creates a SOM_ProvisionOrderFulfillment order.
COMSOM_ResumePendingIbMsg	Recognizes an inbound message and triggers creation of a ResumePendingInBoundMessage order.
COMSOM_SalesOrderFulfillment	Recognizes an Oracle AIA customer order and triggers the creation of a COM_SalesOrderFulfillment order.

Revision Number Update for Canceled Orders

For information about special revision number processing for canceled orders, see "Revision Number Update for Canceled Orders."

OracleComms_OSM_O2A_COMSOM_Simple_NP_Soln

The OracleComms_OSM_O2A_COMSOM_Simple_NP_Soln cartridge is a demonstration composite cartridge that references all cartridges required for central order management and service order management in the Simple topology.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_COMSOM_Typical_NP_Soln

The OracleComms_OSM_O2A_COMSOM_Typical_NP_Soln cartridge is a demonstration composite cartridge that references all cartridges required for central order management and service order management in the Typical or Complex topology

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_FulfillmentPatternMap_Sample

The OracleComms_OSM_O2A_FulfillmentPatternMap_Sample cartridge is a demonstration cartridge. It contains the mappings between product specifications and fulfillment patterns, where the product specifications are either imported from customer's Siebel CRM system or manually created. In either case, this cartridge can be extended and can contain custom product specification information.

This cartridge also contains the following common fulfillment state definitions, which are used in composition rules. Listed under each main fulfillment state are its child states.

OPEN
IN_PROGRESS
- IN_PROGRESS-FULFILL_BILLING_START
- IN_PROGRESS-INITIATE_BILLING_START
- IN_PROGRESS-INSTALL_COMMITTED
- IN_PROGRESS-INSTALL_PLANNED
- IN_PROGRESS-INSTALL_START
- IN_PROGRESS-PROVISION_DESIGNED
- IN_PROGRESS-PROVISION_START
- IN_PROGRESS-SHIP_ORDER_PLANNED
- IN_PROGRESS-SHIP_ORDER_START
- IN_PROGRESS-SYNC_CUSTOMER_START
COMPLETE
- COMPLETE-FULFILL_BILLING_COMPLETE
- COMPLETE-FULFILL_BILLING_START
- COMPLETE-INITIATE_BILLING_COMPLETE
- COMPLETE-INITIATE_BILLING_START
- COMPLETE-INSTALL_COMPLETE
- COMPLETE-INSTALL_START
- COMPLETE-PROVISION_COMPLETE
- COMPLETE-PROVISION_START
- COMPLETE-SHIP_ORDER_SHIPPED
- COMPLETE-SHIP_ORDER_START
- COMPLETE-SYNC_CUSTOMER_COMPLETE
- COMPLETE-SYNC_CUSTOMER_START
CANCELLED
- CANCELLED-FULFILL_BILLING_COMPLETE
- CANCELLED-FULFILL_BILLING_START
- CANCELLED-INITIATE_BILLING_COMPLETE
- CANCELLED-INITIATE_BILLING_START
- CANCELLED-INSTALL_COMMITTED
- CANCELLED-INSTALL_COMPLETE
- CANCELLED-INSTALL_PLANNED
- CANCELLED-INSTALL_START
- CANCELLED-PROVISION_COMPLETE
- CANCELLED-PROVISION_DESIGNED
- CANCELLED-PROVISION_START
- CANCELLED-SHIP_ORDER_PLANNED
- CANCELLED-SHIP_ORDER_SHIPPED
- CANCELLED-SHIP_ORDER_START
- CANCELLED-SYNC_CUSTOMER_COMPLETE
- CANCELLED-SYNC_CUSTOMER_START
FAILED
- FAILED-FULFILL_BILLING_COMPLETE
- FAILED-FULFILL_BILLING_START
- FAILED-INITIATE_BILLING_COMPLETE
- FAILED-INITIATE_BILLING_START
- FAILED-INSTALL_COMMITTED
- FAILED-INSTALL_COMPLETE
- FAILED-INSTALL_PLANNED
- FAILED-INSTALL_START
- FAILED-PROVISION_COMPLETE
- FAILED-PROVISION_DESIGNED
- FAILED-PROVISION_START
- FAILED-SHIP_ORDER_PLANNED
- FAILED-SHIP_ORDER_SHIPPED
- FAILED-SHIP_ORDER_START
- FAILED-SYNC_CUSTOMER_COMPLETE
- FAILED-SYNC_CUSTOMER_START

OracleComms_OSM_O2A_SalesOrders_NP_Sample

The OracleComms_OSM_O2A_SalesOrders_NP_Sample cartridge is a demonstration cartridge that contains sample customer orders. These orders are in the same format as orders that are received in an integrated environment with Oracle AIA, Siebel CRM, and CRM ABCS. In a standalone OSM environment, you can submit them to central order management to generate and execute an orchestration plan. In a standalone OSM environment, EBMs are placed on OSM JMS queues for pickup by Oracle AIA.

This cartridge contains sample orders in XML files. The names of the XML files use the following conventions:

NSalesOrder: Order to add services
CSalesOrder: Change order, otherwise known as a Move Add Change Delete (MACD) order
FSalesOrder: Follow-on order, used to update an order that has passed the point of no return
R1, R2, R3, R4: revision order for submission after the original base order with the same name
TBO: An order specifying time-based offerings
Cancel: Cancel order

Note:

Table 4-67 describes the order numbers for new and change orders:

Table 4-67 OracleComms_OSM_O2A_SalesOrders_NP_Sample Order Descriptions

Order Number	Description
Sales Order 10000	Double Play First-Time Purchase
Sales Order 10010	Double Play Promotion change orders for broadband
Sales Order 10020	Double Play Promotion change orders for VoIP
Sales Order 10030	Double Play Change Purchased Products
Sales Order 10040	Double Play Update Attributes of a Product
Sales Order 10050	Double Play Suspend Services
Sales Order 10060	Double Play Suspend and Resume on the Same Order
Sales Order 10070	Double Play Move Services to Different Address
Sales Order 10080	Double Play Disconnect Optional Products

Following is a list of the order XML files included in the cartridge:

NEWPROD_NSalesOrderTBOEBM.xml
NEWPROD_CSalesOrderTBOEBM.xml
NEWPROD_GoldFSalesOrder10000F-1FFEBM.xml
NEWPROD_GoldNSalesOrder10000-V2EBM-Predecessor.xml
NEWPROD_GoldNSalesOrder10000-V2EBM-Successor.xml
NEWPROD_GoldNSalesOrder10000-V2EBM.xml
NEWPROD_GoldNSalesOrder10000F-1EBM.xml
NEWPROD_GoldNSalesOrder10000F-1FO1EBM.xml
NEWPROD_GoldNSalesOrder10000WithAdditionalFulfillmentItemCodeEBM.xml
NEWPROD_GoldNSalesOrder10010-V2EBM.xml
NEWPROD_GoldCSalesOrder10010-V2EBM.xml
NEWPROD_GoldCSalesOrder10020-2-1EBM.xml
NEWPROD_GoldCSalesOrder10020-2-1R1EBM.xml
NEWPROD_GoldCSalesOrder10020-V2EBM.xml
NEWPROD_GoldNSalesOrder10020-2-1EBM.xml
NEWPROD_GoldNSalesOrder10020-V2EBM.xml
NEWPROD_GoldNSalesOrder10030-V2EBM.xml
NEWPROD_GoldNSalesOrder10030_2V1EBM.xml
NEWPROD_GoldCSalesOrder10030-V2EBM.xml
NEWPROD_GoldCSalesOrder10030R1_2V1EBM.xml
NEWPROD_GoldCSalesOrder10030R3_2V1EBM.xml
NEWPROD_GoldCSalesOrder10030R4_2V1EBM.xml
NEWPROD_GoldCSalesOrder10030_2V1EBM.xml
NEWPROD_GoldNSalesOrder10040-V2EBM.xml
NEWPROD_GoldNSalesOrder10040_2V1EBM.xml
NEWPROD_GoldCSalesOrder10040-V2EBM.xml
NEWPROD_GoldR1SalesOrder10040-V2EBM.xml
NEWPROD_GoldCSalesOrder10040R2_2V1EBM.xml
NEWPROD_GoldR3SalesOrder10040-V2EBM.xml
NEWPROD_GoldCSalesOrder10040R4_2V1EBM.xml
NEWPROD_GoldCSalesOrder10040_2V1EBM.xml
NEWPROD_GoldNSalesOrder10050-V2EBM.xml
NEWPROD_GoldCSalesOrder10050-V2EBM.xml
NEWPROD_GoldNSalesOrder10060-V2EBM.xml
NEWPROD_GoldCSalesOrder10060-V2EBM.xml
NEWPROD_GoldNSalesOrder10070-V2EBM.xml
NEWPROD_GoldCSalesOrder10070-V2EBM.xml
NEWPROD_GoldCSalesOrder10070R1-V2EBM.xml
NEWPROD_GoldNSalesOrder10080-V2EBM.xml
NEWPROD_GoldCSalesOrder10080-V2EBM.xml
NEWPROD_GoldR1SalesOrder10080-V2EBM.xml
NEWPROD_GoldR2SalesOrder10080-V2EBM.xml
NEWPROD_NSalesOrderWirelessProductsEBM.xml
NEWPROD_SalesOrder10000CancelEBM.xml
NEWPROD_SalesOrder10000DeliverEBM.xml

Note:

The NEWPROD_testfalloutnotification.xml file is a sample order fallout notification but not a sample customer order. This XML file is used to send a particular task to fallout manually by pausing the corresponding queue.

Table 4-68 contains information about the changes included in the specific revision orders above:

Table 4-68 OracleComms_OSM_O2A_SalesOrders_NP_Sample Order Revision Details

Order Number	Description
GoldCSalesOrder10030R1_2V1EBM	ADD canceled on revision, DELETE canceled on revision
GoldCSalesOrder10030R3_2V1EBM	ADD modified on revision
GoldCSalesOrder10030R4_2V1EBM	New ADD on revision
GoldR1SalesOrder10040-V2EBM	UPDATE modified on revision
GoldCSalesOrder10040R2_2V1EBM	UPDATE canceled on revision
GoldR3SalesOrder10040-V2EBM	New ADD on revision
GoldCSalesOrder10040R4_2V1EBM	DELETE added on revision
GoldCSalesOrder10070R1-V2EBM	MOVE canceled on revision
GoldR1SalesOrder10080-V2EBM	DELETE modified on revision (future date)
GoldR2SalesOrder10080-V2EBM	UPDATE added on revision

OracleComms_OSM_O2A_SimpleTopology_Sample

The OracleComms_OSM_O2A_SimpleTopology_Sample cartridge is a demonstration cartridge containing decomposition rules and order component specifications to decompose billing and provisioning fulfillment functions into the Simple topology: a single billing instance and a single local fulfillment instance.

Table 4-69 contains a list of the order component specifications defined in this cartridge.

Table 4-69 OracleComms_OSM_O2A_SimpleTopology_Sample Order Component Specifications

Order Component Specification	Description
BRM-ALL	Represents the billing fulfillment system.
Provisioning-ALL	Represents the provisioning fulfillment system.

OracleComms_OSM_O2A_TypicalTopology_Sample

The OracleComms_OSM_O2A_TypicalTopology_Sample cartridge is a demonstration cartridge containing decomposition rules and order component specifications to decompose billing, provisioning, shipping, and install fulfillment functions into the Typical topology: multiple billing, local fulfillment, supply chain management, and workforce management instances.

Table 4-70 contains a list of the order component specifications defined in this cartridge.

Table 4-70 OracleComms_OSM_O2A_TypicalTopology_Sample Order Component Specifications

Order Component Specification	Description
BRM-ALL	Represents the billing fulfillment system if there is a single billing system.
BRM-BIZBDB	Represents the billing fulfillment system for business broadband customers.
BRM-REZBDB	Represents the billing fulfillment system for residential broadband customers.
BRM-VIRTUAL	Represents the billing fulfillment system for non-service billing functions.
BRM-VoIP	Represents the billing fulfillment system for VoIP customers.
Provisioning-ALL	Represents the provisioning fulfillment system if there is a single provisioning system.
Provisioning-DSL	Represents the provisioning system for DSL customers outside the UK.
Provisioning-UKDSL	Represents the provisioning system for DSL customers inside the UK.
Provisioning-VOIP	Represents the provisioning system for VoIP customers.
Shipping-ALL	Represents the shipping fulfillment system if there is a single shipping system.
Shipping-InHouse	Represents the shipping system for shipments without partner involvement.
Shipping-PartnerInc	Represents the shipping system for shipments with partner involvement.
WFM-A	Represents the first workflow management fulfillment system if there is more than one workflow management system.
WFM-ALL	Represents the workflow management fulfillment system if there is a single workflow management system.
WFM-B	Represents the second workflow management fulfillment system if there is more than one workflow management system.

Service Order Management Cartridges for the Calculate Service Order Solution Option

The following cartridges operate in the service order management role, which translates Oracle AIA service orders into OSM service orders and processes those orders. These cartridges are used in the calculate service order solution option.

OracleComms_OSM_O2A_SOM_CSO_Base

The OracleComms_OSM_O2A_SOM_CSO_Base cartridge is a productized cartridge that supports the provisioning of service orders.

Order Events

When the COM_SalesOrderFulfillment order reaches one of the order events listed in Table 4-71, it triggers the listed XQuery module to send an order update to the upstream system.

Table 4-71 OracleComms_OSM_O2A_SOM_CSO_Base Order Events

Order Event	Description
creation	Calls the SOMOrderCreationFailure XQuery module to determine if a failure has occurred. If so, generates a message to central order management through the Oracle AIA error handling framework.
completion	Calls the SOMCompletionStatusSender XQuery module to send the order completion to central order management.

Order Lifecycle Manager Configuration

Table 4-72 displays the mappings that are configured. The high-level fulfillment states are mapped, which causes the child states to be mapped as well.

Table 4-72 Fulfillment State to Order Lifecycle Manager State Mapping

Fulfillment State	Order Lifecycle Manager State
SOM_CANCELLED	Canceled
SOM_COMPLETE	Complete
SOM_FAILED	Failed
SOM_INPROGRESS	In Progress

Note:

If you have both central order management and service order management in the same Design Studio workspace, you will see service order management fulfillment states in the list in the order lifecycle manager. The names of the high-level fulfillment states for central order management do not start with SOM_. The central order management fulfillment states do not need to be mapped here, because they are mapped in the order lifecycle manager in the central order management configuration. See "Order Lifecycle Manager Configuration" for information about central order management state mappings.

XQuery Modules in the OracleComms_OSM_O2A_SOM_CSO_Base Cartridge

Table 4-73 through Table 4-76 list the different types of XQuery modules in this cartridge.

Table 4-73 OracleComms_OSM_O2A_SOM_CSO_Base XQuery Modules for Fallout Handling

Fallout Handling XQuery Module	Extendable	Description
SendAbortLFOrderFailure	No	Sends a fulfillment order failure update when the order termination request failed.
SendAbortLFOrderSuccess	No	Sends a fulfillment order success update when the order termination request succeeded.
SomAbortOrder	No	Sends an order termination request for a given fulfillment request.
SomFindOrder	No	Creates a find order request for a fulfillment request with a given order key.
SomSuspendOrder	No	Creates a suspend order request for a fulfillment request with a given order key.
SomWebServicesResponseHandler	No	Utility module for providing retrieval and update to service order.

Table 4-74 OracleComms_OSM_O2A_SOM_CSO_Base Orchestration Sequence XQuery Modules

Orchestration Sequence XQuery Module	Extendable	Description
SOM_FulfillmentModeExpression	No	Marshals the fulfillment mode code from the service order.
SOM_OrderItemSelector	No	Module to select all order line items from the service order.

Table 4-75 OracleComms_OSM_O2A_SOM_CSO_Base Order Recognition XQuery Modules

Order Recognition XQuery Module	Extendable	Description
SOM_DataTransform	No	Transforms the Oracle AIA service order to an OSM service order.
SOM_DataValidation	No	Validates the Oracle AIA service order.

Table 4-76 OracleComms_OSM_O2A_SOM_CSO_Base Order State XQuery Modules

Order State XQuery Module	Extendable	Description
SOM_Reference	No	Accesses the sales order reference.

Automation Modules in the OracleComms_OSM_O2A_SOM_CSO_Base Cartridge

Table 4-77 lists the automation modules in the cartridge with their associated automated tasks.

Table 4-77 OracleComms_OSM_O2A_SOM_CSO_Base Automation Modules

Automation Module	Automated Task	Description
AbortSomOrderRequest	AbortSomOrderTask	Calls the SomAbortOrder XQuery.
AbortSomOrderResponse	AbortSomOrderTask	External event receiver to invoke SomWebServicesResponseHandler XQuery.
FindSomOrderRequest	FindSomOrderTask	Calls the SomFindOrder XQuery.
FindSomOrderResponse	FindSomOrderTask	External event receiver to invoke SomWebServicesResponseHandler XQuery.
SendAbortStatusToUpstream	SendAbortStatusToUpstreamTask	Calls the SendAbortLFOrderSuccess XQuery
SuspendSomOrderRequest	SuspendSomOrderTask	Calls the SomSuspendOrder XQuery.
SuspendSomOrderResponse	SuspendSomOrderTask	External event receiver to invoke SomWebServicesResponseHandler XQuery

OracleComms_OSM_O2A_SOM_CSO_Broadband_Internet_Access_CFS

The OracleComms_OSM_O2A_SOM_CSO_Broadband_Internet_Access_CFS cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for broadband Internet access. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_SOM_CSO_Common

The OracleComms_OSM_O2A_SOM_CSO_Common cartridge is a productized cartridge that contains data elements and fulfillment modes for service order management with the calculate service order solution option.

The following fulfillment modes are defined in this cartridge:

SOM_CANCEL
SOM_DELIVER
SOM_TSQ

OracleComms_OSM_O2A_SOM_CSO_CompleteProvisioning

The OracleComms_OSM_O2A_COM_CSO_Base cartridge is a demonstration cartridge that supports provisioning fulfillment functions for service order management.

OracleComms_OSM_O2A_SOM_CSO_DeliverOrder

The OracleComms_OSM_O2A_SOM_CSO_DeliverOrder cartridge is a demonstration cartridge that supports order delivery fulfillment functions for service order management.

OracleComms_OSM_O2A_SOM_CSO_DesignService

The OracleComms_OSM_O2A_SOM_CSO_DesignService cartridge is a demonstration cartridge that supports service design fulfillment functions for service order management.

OracleComms_OSM_O2A_SOM_CSO_Email_CFS

The OracleComms_OSM_O2A_SOM_CSO_Email_CFS cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for email service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_SOM_CSO_FulfillmentPattern

The OracleComms_OSM_O2A_SOM_CSO_FulfillmentPattern cartridge is a productized cartridge that contains service order management fulfillment patterns for the calculate service order solution option.

OracleComms_OSM_O2A_SOM_CSO_FulfillmentStateMap

The OracleComms_OSM_O2A_COM_CSO_Base cartridge is a productized cartridge that contains fulfillment state entities used by the solution.

This cartridge contains the following common fulfillment state definitions, which are used in composition rules. Listed under each main fulfillment state are its child states.

SOM_PENDING
SOM_INPROGRESS
- IN_PROGRESS-BI_CAPTURED
- IN_PROGRESS-BI_ISSUED
- IN_PROGRESS-BI_PROCESSED
- IN_PROGRESS-TO_CREATE
SOM_COMPLETED
- COMPLETE-BI_APPROVED
- COMPLETE-BI_COMPLETED
- COMPLETE-TA_CALCULATED
- COMPLETE-TO_COMPLETED
SOM_CANCELLED
- CANCELLED-BI_APPROVED
- CANCELLED-BI_CAPTURED
- CANCELLED-BI_COMPLETED
- CANCELLED-BI_ISSUED
- CANCELLED-BI_PROCESSED
- CANCELLED-TA_CALCULATED
- CANCELLED-TO_COMPLETED
- CANCELLED-TO_CREATE
SOM_FAILED
- FAILED-BI_APPROVED
- FAILED-BI_CAPTURED
- FAILED-BI_COMPLETED
- FAILED-BI_ISSUED
- FAILED-BI_PROCESSED
- FAILED-SERVICE
- FAILED-TO_COMPLETED
- FAILED-TO_CREATE

OracleComms_OSM_O2A_SOM_CSO_Internet_Media_CFS

The OracleComms_OSM_O2A_SOM_CSO_Internet_Media_CFS cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for Internet media service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_SOM_CSO_IP_Fax_CFS

The OracleComms_OSM_O2A_COM_CSO_Base cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for IP fax service. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_SOM_CSO_ModelContainer

The OracleComms_OSM_O2A_SOM_CSO_ModelContainer cartridge defines the common model projects that contain elements that might need to be included in the deployment.

OracleComms_OSM_O2A_SOM_CSO_PlanDelivery

The OracleComms_OSM_O2A_COM_CSO_Base cartridge is a demonstration cartridge that supports delivery planning fulfillment functions for service order management.

OracleComms_OSM_O2A_SOM_CSO_Recognition

The OracleComms_OSM_O2A_SOM_CSO_Recognition cartridge is a demonstration cartridge that recognizes a service order and triggers the creation of a SOM_ProvisionOrderFulfillment order. In addition, this cartridge catches all in-bound messages not recognized by any other provisioning recognition rules.

Table 4-78 lists the order recognition rules defined in this cartridge.

Table 4-78 OracleComms_OSM_O2A_SOM_CSO_Recognition Recognition Rules

Order Recognition Rule	Description
Recognize_AbortPropagationServiceOrder	Recognizes a termination request for an order.
SOM_ORPFallout_CFM_OrderRecognitionRule	Recognizes an ORP fallout to create a fault message to be sent to Oracle AIA error handling queue.
RecognizeEBM_ProvisioningOrder	Recognizes a service order that must be executed and creates a SOM_ProvisionOrderFulfillment order.
SOM_ResumePendingIbMsg_OrderRecognitionRule	Recognizes an inbound message to create a ResumePendingInBoundMessage order in service order management.

Revision Number Update for Canceled Orders

For information about special revision number processing for canceled orders, see "Revision Number Update for Canceled Orders."

OracleComms_OSM_O2A_SOM_CSO_Solution

The OracleComms_OSM_O2A_SOM_CSO_Solution cartridge is a demonstration composite cartridge that references all cartridges required for service order management.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_SOM_CSO_Topology

The OracleComms_OSM_O2A_SOM_CSO_Topology cartridge is a demonstration cartridge. This cartridge contains entities, such as decomposition rules and order components, for service order management.

OracleComms_OSM_O2A_SOM_CSO_VoIP_Access_CFS

The OracleComms_OSM_O2A_SOM_CSO_VoIP_Access_CFS cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for VoIP access. It also contains XQuery modules to support the order item parameter bindings.

OracleComms_OSM_O2A_SOM_CSO_Web_Conferencing_CFS

The OracleComms_OSM_O2A_SOM_CSO_Internet_Media_CFS cartridge is a demonstration cartridge that contains the order item parameter bindings associated with the customer facing service for Web conferencing service. It also contains XQuery modules to support the order item parameter bindings.

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

OracleComms_OSM_O2A_SOM_Base

The OracleComms_OSM_O2A_SOM_Base cartridge is a productized cartridge supporting the orchestration of service orders that have come from Oracle AIA. It includes handling status and data updates from fulfillment requests back to central order management.

Order Events

When the COM_SalesOrderFulfillment order reaches one of the order events listed in Table 4-79, it triggers the listed XQuery module to send an order update to the upstream system.

Table 4-79 OracleComms_OSM_O2A_SOM_Base Order Events

Order Event	Description
creation	Calls the LFCheckCreationOrderFailure XQuery to determine if a failure has occurred. If so, generates a message to central order management through the Oracle AIA error handling framework.
completion	Calls the ProvisionOrderCompleteEventHandler XQuery module to send the order completion to central order management.

Processing Granularity Rules

There are three orchestration stages defined in the orchestration sequence to decompose the order line items. The result of each stage of decomposition is the source for the next stage of decomposition.

In the first stage, the order line items are decomposed by fulfillment function.
In the second stage, the order line items are decomposed by fulfillment provider.
In the third stage, the order line items are decomposed by granularity rule.

Table 4-80 lists the processing granularity rule entities.

Table 4-80 OracleComms_OSM_O2A_SOM_Base Processing Granularity Rules

Entity Name

Entity Type

Description

ServiceGranularity

Order Component Specification

This granularity rule selects:

An order line item that represents a service along with service components and related order line items
Order line items of any other root node on the order along with their related order line items

XQuery Modules in the OracleComms_OSM_O2A_SOM_Base Cartridge

Table 4-81 through Table 4-87 list the different types of XQuery modules in this cartridge.

Table 4-81 OracleComms_OSM_O2A_SOM_Base XQuery Modules for Constants

Constants XQuery Module	Extendable	Description
SomQueryViewConstants	No	Defines constants for querying views in service order management.

Table 4-82 OracleComms_OSM_O2A_SOM_Base XQuery Modules for Fallout Handling

Fallout Handling XQuery Module	Extendable	Description
AbortLFOrderRequest	No	Sends an order termination request for the fulfillment request through the Web service API.
FindLFOrder	No	Creates a find order request for a fulfillment request with a given order key.
LFAbortOrderPropagation	No	Sends an order termination request for a given fulfillment request.
LFAbortOrderPropagationCheck	No	Checks the status of the order termination request for fulfillment request.
LFAbortOrderPropagationResp	No	Handles the response of the order termination request for the fulfillment request.
LFwsResponseHandler	No	Utility module for providing retrieval and update to service order.
SendAbortLFOrderFailure	No	Sends a fulfillment order failure update when the order termination request failed.
SendAbortLFOrderSuccess	No	Sends a fulfillment order success update when the order termination request succeeded.
SuspendLFOrder	No	Creates a suspend order request for a fulfillment request with a given order key.

Table 4-83 OracleComms_OSM_O2A_SOM_Base Orchestration Sequence XQuery Modules

Orchestration Sequence XQuery Module	Extendable	Description
FulfillmentModeExpression	No	Marshals the fulfillment mode code from the service order.
OrderItemSelector	No	Module to select all order line items from the service order.

Table 4-84 OracleComms_OSM_O2A_SOM_Base Order Data Change XQuery Modules

Order Data Change XQuery Module	Extendable	Description
CreateLFFaultToAIAEH	No	Creates an error message to be sent to the Oracle AIA error handling queue.

Table 4-85 OracleComms_OSM_O2A_SOM_Base Order Item Hierarchy XQuery Modules

Order Item XQuery Module	Extendable	Description
LineIdKey	No	Retrieves the order line item's ID.
ParentLineIdKey	No	Retrieves the parent order line item's ID.

Table 4-86 OracleComms_OSM_O2A_SOM_Base Order Recognition XQuery Modules

Order Recognition XQuery Module	Extendable	Description
ProvisionOrderData	No	Transforms the Oracle AIA service order to an OSM service order.
ProvisionOrderPriority	No	Retrieves the priority of the Oracle AIA service order.
ProvisionOrderRecognition	No	Recognizes the Oracle AIA service order.
ProvisionOrderValidation	No	Validates the Oracle AIA service order.

Table 4-87 OracleComms_OSM_O2A_SOM_Base Order State XQuery Modules

Order State XQuery Module	Extendable	Description
LFCheckCreationOrderFailure	No	Determines if a failure has occurred. If so, generates an error message to central order management through the Oracle AIA error handling framework.
ProvisionOrderCompleteEventHandler	No	Sends service order status update with COMPLETE status code back to central order management.

Automation Modules in the OracleComms_OSM_O2A_SOM_Base Cartridge

Table 4-88 lists the automation modules in the cartridge with their associated automated tasks.

Table 4-88 OracleComms_OSM_O2A_SOM_Base Automation Modules

Automation Module	Automated Task	Description
AbortLFOrderPlugin	AbortLFOrderTask	Calls the AbortLFOrderRequest XQuery.
AbortLFOrderRespPlugin	AbortLFOrderTask	External event receiver to invoke LFwsResponseHandler XQuery.
FindLFOrderPlugin	GetLFOrderTask	Calls the FindLFOrder XQuery.
GetLFOrderDataPlugin	GetLFOrderTask	External event receiver to invoke LFwsResponseHandler XQuery.
SendAbortLFOrderFailurePlugin	LFAbortOrderFailureTask	Calls the SendAbortLFOrderFailure XQuery.
SendAbortLFOrderSuccessPlugin	LFAbortOrderSuccessTask	Calls the SendAbortLFOrderSuccess XQuery.
LFOrderAbortPropagationCheckPlugin	LFOrderAbortPropagationCheck	Internal event receiver to invoke LFAbortOrderPropagationCheck XQuery.
LFAbortOrderPropagationPlugin	LFOrderAbortPropagationTask	Internal event receiver to invoke LFAbortOrderPropagation XQuery.
LFAbortOrderPropagationRespPlugin	LFOrderAbortPropagationTask	External event receiver to invoke LFAbortOrderPropagationResp XQuery.
SuspendLFOrderPlugin	SuspendLFOrderTask	Internal event receiver to invoke SuspendLFOrder XQuery.
SuspendLFOrderRespPlugin	SuspendLFOrderTask	Calls the LFwsResponseHandler XQuery.

OracleComms_OSM_O2A_SOM_Provisioning

The OracleComms_OSM_O2A_SOM_Provisioning cartridge is a productized cartridge that supports provisioning fulfillment functions. These functions specify a subprocess to handle delivery of a relevant subset of order data to the provisioning system and handle responses from the provisioning system.

Table 4-89 lists he XQuery modules in the cartridge that support component interaction.

Table 4-89 OracleComms_OSM_O2A_SOM_Provisioning Component Interaction XQuery Modules

Component Interaction XQuery Module	Extendable	Description
SomProvisionOrderInteractionModule	Yes	Provides functions to support ProvisionOrderFunction in service order management.

Table 4-90 lists the XQuery modules defined for the SomProvisionOrderFunction fulfillment function.

Table 4-90 SomProvisionOrderFunction XQuery Modules

XQuery Module	Extendable	Description
CreateProvisioningOrderRequest_do	No	Generates the Oracle AIA EBM requests to the external provisioning system.
CreateProvisioningOrderRequest_redo	No	Generates the Oracle AIA EBM requests to the external provisioning system.
CreateProvisioningOrderRequest_undo	No	Generates the Oracle AIA EBM requests to external provisioning system for undo.
CreateProvisioningOrderResponse	No	Consumes the Oracle AIA EBM response from the external provisioning system.
InitialSomProvisionOrderSIResponse	No	Sets the correlation context before consuming Oracle AIA EBM response from the external provisioning system.
RetryCreateProvisioningOrderResponse	No	Handles fallout in service order management's provisioning order by re-creating the response from the external provisioning system.
SomProvisionOrderSIEntryPoint	No	Handles extension point COMPONENT-START, updates order item properties, and reports milestones to lifecycle management for service order management and then to central order management.
SomProvisionOrderSIResponse	No	Consumes the Oracle AIA EBM response from the external provisioning system.
SomProvisionOrderSIResponseFalloutPrepare	No	Handles manual retry process to re-submit EBM to the external provisioning system.
UpdateProvisionOrderStatusFunctions	No	Provides functions to create an EBM that contains the fulfillment request's update and send the EBM to central order management.

Table 4-91 lists the automation modules (with their associated automated tasks) defined in the OracleComms_OSM_O2A_SOM_Provisioning cartridge for the SomProvisionOrderFunction fulfillment function.

Table 4-91 SomProvisionOrderFunction Automation Modules

Automation Module	Automated Task	Description
SomProvisionOrderSIEntryPointBean	SomProvisionOrderSIEntryPointTask	Calls the SomProvisionOrderSIEntryPoint XQuery.
SomProvisionOrderSIResponseFalloutPrepareBean	SomProvisionOrderSIResponseFalloutPrepareTask	Calls the SomProvisionOrderSIResponseFalloutPrepare XQuery.
InitialSomProvisionOrderSIResponseBean	SomProvisionOrderSIResponseTask	Calls the InitialSomProvisionOrderSIResponse XQuery.
SomProvisionOrderSIResponseBean	SomProvisionOrderSIResponseTask	External event receiver to invoke SomProvisionOrderSIResponse XQuery.
RetryCreateProvisioningOrderRequestBean	SomProvisionOrderSIRetryTask	Calls the CreateProvisioningOrderRequest_do XQuery.
RetryCreateProvisioningOrderResponseBean	SomProvisionOrderSIRetryTask	External event receiver to invoke RetryCreateProvisoningOrderResponse XQuery.
CreateProvisiongOrderRequestBean_do	SomProvisionOrderSITask	Calls the CreateProvisioningOrderRequest_do XQuery.
CreateProvisiongOrderRequestBean_redo	SomProvisionOrderSITask	Calls the CreateProvisioningOrderRequest_redo XQuery.
CreateProvisiongOrderRequestBean_undo	SomProvisionOrderSITask	Calls the CreateProvisioningOrderRequest_undo XQuery.
CreateProvisioningOrderResponseBean	SomProvisionOrderSITask	External event receiver to invoke CreateProvisoningOrderResponse XQuery.
SomProvisionOrderSIResponseUndoBean	SomProvisionOrderSITask	External event receiver to invoke SomProvisionOrderSIResponse XQuery.

OracleComms_OSM_O2A_SOM_Solution

The OracleComms_OSM_O2A_SOM_Solution cartridge is a demonstration composite cartridge that references all cartridges required for service order management.

To see the component cartridges referenced in this cartridge for your solution, open the Dependencies tab in the composite cartridge editor.

OracleComms_OSM_O2A_SOM_Recognition_Sample

The OracleComms_OSM_O2A_SOM_Recognition_Sample cartridge is a demonstration cartridge that recognizes a service order and triggers the creation of a SOM_ProvisionOrderFulfillment order. In addition, this cartridge catches all in-bound messages not recognized by any other provisioning recognition rules.

Table 4-92 lists the order recognition rules defined in this cartridge.

Table 4-92 OracleComms_OSM_O2A_SOM_Recognition_Sample Recognition Rules

Order Recognition Rule	Description
SOM_LFAbortOrderPropagationOrder_Recognition	Recognizes a termination request for an order.
SOM_ORPFallout_CFM_OrderRecognitionRule	Recognizes an ORP fallout to create a fault message to be sent to Oracle AIA error handling queue.
SOM_ProvisionOrderFulfillment_Recognition	Recognizes a service order that must be executed and creates a SOM_ProvisionOrderFulfillment order.
SOM_ResumePendingIbMsg_OrderRecognitionRule	Recognizes an inbound message to create a ResumePendingInBoundMessage order in service order management.

Revision Number Update for Canceled Orders

For information about special revision number processing for canceled orders, see "Revision Number Update for Canceled Orders."

OracleComms_OSM_O2A_SomBBVoIP_FP_NP_Sample

The OracleComms_OSM_O2A_SomBBVoIP_FP_NP_Sample cartridge is a demonstration cartridge containing fulfillment patterns, each of which configures a fulfillment flow for provisioning fulfillment functions. The demonstration VoIP and Broadband products map to the fulfillment patterns.

The following fulfillment patterns are configured in this cartridge:

SOM_Service.Provision – All other fulfillment patterns extend from this.
SOM_Service.Broadband
SOM_Service.CPE.Broadband
SOM_Service.CPE.VoIP
SOM_Service.VoIP

OracleComms_OSM_O2A_SomProvisionBroadband_Sample

The OracleComms_OSM_O2A_SomProvisionBroadband_Sample cartridge is a demonstration cartridge supporting service orders for broadband services.

Table 4-93 to Table 4-95 list the entities in the OracleComms_OSM_O2A_SomProvisionBroadband_Sample cartridge.

Table 4-93 OracleComms_OSM_O2A_SomProvisionBroadband_Sample Entities

Name	Type	Description
OSM_O2A_SomProvisionBroadband_Recognition	Order Recognition Rule	Recognizes a broadband service order and creates an OracleComms_OSM_O2A_SomProvisionBroadband_SampleOrder service order to manage its fulfillment.
OracleComms_OSM_O2A_SomProvisionBroadband_SampleOrder	Order	Local service order structure for managing a service order for broadband services.
BroadbandProvisioningOrderLifeCycle	Lifecycle Policy	Defines the security permissions for order transactions.
BroadbandProvisioningRole	Role	Role with permissions to create and view OracleComms_OSM_O2A_SomProvisionBroadband_SampleOrder.
BroadbandServicesProvisioningProcess	Process and Tasks	Process to handle provisioning of broadband services such as email, Internet and customer premise equipment.
CreateBroadbandServicesProvisioningOrderTask	Manual Task	Creation task to create an OracleComms_OSM_O2A_SomProvisionBroadband_SampleOrder.
OracleComms_OSM_O2A_SomProvisionBroadband_Sample	Data Schema	Data structures for managing broadband services.

Table 4-94 OracleComms_OSM_O2A_SomProvisionBroadband_Sample XQuery Modules

XQuery Module	Extendable	Description
ActivityRouterTask	Yes	Transit to the next task with different task exit status depending on broadband provisioning service.
BroadbandServiceErrorFault	Yes	Creates error fault for broadband provisioning service.
BroadbandServiceOrderCompleteEventHandler	Yes	Sends broadband service order status update with COMPLETE status code back to service order management.
BroadbandServiceProcessEntryUndoBean	Yes	Updates the provisioning order and sends broadband service order status.
BroadbandServiceProvisioningOrderDataRule	Yes	Transforms the Oracle AIA service order to an OSM service order.
BroadbandServiceUtilityModule	Yes	Utility module to provide functions to support provisioning broadband service.
ProvisionTaskComplete	Yes	Completes a provisioning task.
ProvisionTaskStart	Yes	Starts a provisioning task.

Table 4-95 OracleComms_OSM_O2A_SomProvisionBroadband_Sample Automation Modules

Automation Module	Automated Task	Description
ActivityRouterBean	ActivityRouterTask	Calls the ActivityRouterTask XQuery.
BroadbandServiceErrorFaultBean	BroadbandServiceErrorFaultTask	Calls the BroadbandServiceErrorFault XQuery.
BroadbandServiceErrorFaultBean_redo	BroadbandServiceErrorFaultTask	Calls the BroadbandServiceErrorFault XQuery for redo mode.
BroadbandServiceProcessEntryUndoBean	BroadbandServiceProcessEntryTask	Calls the BroadbandServiceProcessEntryUndoBean XQuery.
BroadbandServiceProcessExitBean	BroadbandServiceProcessExitTask	Calls the BroadbandServiceProcessExitBean XQuery.
ProvisionCPEEntryPointBean	ProvisionCPEEntryPointTask	Calls the ProvisionTaskStart XQuery.
ProvisionCPEExitPointBean	ProvisionCPEExitPointTask	Calls the ProvisionTaskComplete XQuery.
ProvisionInternetEmailServiceBundleEntryPointBean	ProvisionInternetEmailServiceBundleEntryPointTask	Calls the ProvisionTaskStart XQuery.
ProvisionInternetEmailServiceBundleExitPointBean	ProvisionInternetEmailServiceBundleExitPointTask	Calls the ProvisionTaskComplete XQuery.
ProvisionInternetMediaServiceBundleEntryPointBean	ProvisionInternetMediaServiceBundleEntryPointTask	Calls the ProvisionTaskStart XQuery.
ProvisionInternetMediaServiceBundleExitPointBean	ProvisionInternetMediaServiceBundleExitPointTask	Calls the ProvisionTaskComplete XQuery.
ProvisionInternetServiceBundleEntryPointBean	ProvisionInternetServiceBundleEntryPointTask	Calls the ProvisionTaskStart XQuery.
ProvisionInternetServiceBundleExitPointBean	ProvisionInternetServiceBundleExitPointTask	Calls the ProvisionTaskComplete XQuery.

OracleComms_OSM_O2A_SomProvisionVoIP_Sample

The OracleComms_OSM_O2A_SomProvisionVoIP_Sample cartridge is a demonstration cartridge supporting service orders for VoIP services.

Table 4-96 to Table 4-98 list the entities in the OracleComms_OSM_O2A_SomProvisionVoIP_Sample cartridge.

Table 4-96 OracleComms_OSM_O2A_SomProvisionVoIP_Sample Entities

Name	Type	Description
OSM_O2A_SomProvisionVoIP_Recognition	Order Recognition Rule	Recognizes a VoIP service order and creates an OracleComms_OSM_O2A_SomProvisionVoIP_SampleOrder service order to manage its fulfillment.
OracleComms_OSM_O2A_SomProvisionVoIP_SampleOrder	Order	Local service order structure for managing a service order for VoIP services.
VoIPProvisioningOrderLifeCycle	Lifecycle Policy	Defines the security permissions for order transactions.
VoIPProvisioningRole	Role	Role with permissions to create and view OracleComms_OSM_O2A_SomProvisionVoIP_SampleOrder.
VoIPServicesProvisioningProcess	Process and Tasks	Process to handle provisioning of VoIP services such as VoIP service and customer premise equipment.
CreateVoIPServicesProvisioningOrderTask	Manual Task	Creation task to create an OracleComms_OSM_O2A_SomProvisionVoIP_SampleOrder.
OracleComms_OSM_O2A_SomProvisionVoIP_Sample	Data Schema	Data structures for managing VoIP services.

Table 4-97 OracleComms_OSM_O2A_SomProvisionVoIP_Sample XQuery Modules

XQuery Module	Extendable	Description
VoIPActivityRouterTask	Yes	Transit to the next task with different task exit status depending on VoIP provisioning service.
VoIPServiceErrorFault	Yes	Creates error fault for VoIP provisioning service.
VoIPServiceOrderCompleteEventHandler	Yes	Sends VoIP service order status update with COMPLETE status code back to service order management.
VoIPServiceProcessEntryBean	Yes	Updates the provisioning order and sends VoIP service order status.
VoIPServiceProvisioningOrderDataRule	Yes	Transforms the Oracle AIA service order to an OSM service order.
VoIPServiceUtilityModule	Yes	Utility module to provide functions to support provisioning VoIP service.
VoIPProvisionTaskComplete	Yes	Completes a provisioning task.
VoIPProvisionTaskStart	Yes	Starts a provisioning task.
VoIPServiceProcessExitBean	Yes	Completes a task using a successful status.

Table 4-98 OracleComms_OSM_O2A_SomProvisionVoIP_Sample Automation Modules

Automation Module	Automated Task	Description
VoIPActivityRouterBean	VoIPActivityRouterTask	Calls the VoIPActivityRouterTask XQuery.
VoIPServiceErrorFaultBean	VoIPServiceErrorFaultTask	Calls the VoIPServiceErrorFault XQuery.
VoIPServiceErrorFaultBean_redo	VoIPServiceErrorFaultTask	Calls the VoIPServiceErrorFault XQuery for redo mode.
VoIPServiceProcessEntryBean	VoIPServiceProcessEntryTask	Calls the VoIPServiceProcessEntryBean XQuery.
VoIPServiceProcessExitBean	VoIPServiceProcessExitTask	Calls the VoIPServiceProcessExitBean XQuery.
ProvisionVoIPCPEEntryPointBean	ProvisionVoIPCPEEntryPointTask	Calls the VoIPProvisionTaskStart XQuery.
ProvisionVoIPCPEExitPointBean	ProvisionVoIPCPEExitPointTask	Calls the VoIPProvisionTaskComplete XQuery.
ProvisionVoIPServiceBundleEntryPointBean	ProvisionVoIPServiceBundleEntryPointTask	Calls the VoIPProvisionTaskStart XQuery.
ProvisionVoIPServiceBundleExitPointBean	ProvisionVoIPServiceBundleExitPointTask	Calls the VoIPProvisionTaskComplete XQuery.

Common Conceptual Model Projects

The following cartridges provide entities that are used by or referenced by other Order-to-Activate cartridges.

For more information about the conceptual model, see Design Studio Concepts.

OracleComms_Model_Base

The OracleComms_Model_Base project contains entities that are used for multiple services, including provider functions, functional areas, relationship types, action codes, and units of measure.

OracleComms_Model_BaseCatalog

The OracleComms_Model_BaseCatalog project contains conceptual model fulfillment patterns. It also contains the data schema that defines the data elements from the Oracle AIA EBM schema. Cartridges that must include data elements from Oracle AIA EBM can reuse the elements defined in this cartridge.

OracleComms_Model_Common

The OracleComms_Model_Common project contains common data elements for all of the services.

OracleComms_Model_O2A_Broadband_Internet_Access_CFS

The OracleComms_Model_O2A_Broadband_Internet_Access_CFS project contains the customer facing services for broadband Internet access.

The following customer facing services are defined in this project:

Broadband_Internet_Access_CFS

OracleComms_Model_O2A_Broadband_Internet_Access_SA

The OracleComms_Model_O2A_Broadband_Internet_Access_SA project contains the actions for broadband Internet access.

The following action codes are defined in this project for the customer facing service in the OracleComms_Model_O2A_Broadband_Internet_Access_CFS project:

Add
Change
Disconnect
Modify
Move-Add
Move-Delete
Query
Remove
Resume
Suspend

OracleComms_Model_O2A_Broadband_Internet_DataModel

The OracleComms_Model_O2A_Broadband_Internet_DataModel project contains the data schema for data specific to broadband Internet access.

OracleComms_Model_O2A_Email_CFS

The OracleComms_Model_O2A_Email_CFS project contains the customer facing services for email service.

The following customer facing services are defined in this project:

Email_CFS

OracleComms_Model_O2A_Email_DataModel

The OracleComms_Model_O2A_Email_CFS project contains the data schema for data specific to email service.

OracleComms_Model_O2A_Email_SA

The OracleComms_Model_O2A_Email_CFS project contains the actions for email service.

The following action codes are defined in this project for the customer facing service in the OracleComms_Model_O2A_Email_CFS project:

Add
Change
Disconnect
Modify
Move-Add
Move-Delete
Query
Remove
Resume
Suspend

OracleComms_Model_O2A_Internet_Media_CFS

The OracleComms_Model_O2A_Internet_Media_CFS project contains the customer facing services for Internet media service.

The following customer facing services are defined in this project:

InternetMedia_CFS

OracleComms_Model_O2A_Internet_Media_DataModel

The OracleComms_Model_O2A_Internet_Media_DataModel project contains the data schema for data specific to Internet media service.

OracleComms_Model_O2A_Internet_Media_SA

The OracleComms_Model_O2A_Internet_Media_SA project contains the actions for internet media service.

The following action codes are defined in this project for the customer facing service in the OracleComms_Model_O2A_Internet_Media_CFS project:

Add
Change
Disconnect
Modify
Move-Add
Move-Delete
Query
Remove
Resume
Suspend

OracleComms_Model_O2A_VoIP_Access_CFS

The OracleComms_Model_O2A_VoIP_Access_CFS project contains the customer facing services for VoIP access.

The following customer facing services are defined in this project:

IP_Fax_CFS
VoIP_Access_CFS
Web_Conferencing_CFS

OracleComms_Model_O2A_VoIP_Access_SA

The OracleComms_Model_O2A_VoIP_Access_CFS project contains the actions for VoIP access.

The following action codes are defined in this project for each of the customer facing services in the OracleComms_Model_O2A_VoIP_Access_CFS project:

Add
Change
Delete
Disconnect
Modify
Move-Add
Move-Delete
None
Query
Remove
Resume
Suspend
Update

OracleComms_Model_O2A_VoIP_DataModel

The OracleComms_Model_O2A_VoIP_Access_CFS project contains the data schema for data specific to VoIP access.

Conceptual Model Projects for Central Order Management

The following cartridges provide entities that are used by or referenced by central order management Order-to-Activate cartridges.

For more information about the conceptual model, see Design Studio Concepts.

OracleComms_Model_O2A_Billing_PS

The OracleComms_Model_O2A_Billing_PS project contains the products for billing services.

The following products are defined in this project:

Broadband_Pricing_Event_PS
Group_Member_PS
Group_Owner_PS
Offer_Sponsorship_PS
Pricing_Event_PS
Promotion_Group_PS
VoIP_Pricing_Event_Billing_Validation_PS
VoIP_Pricing_Event_PS

OracleComms_Model_O2A_Broadband_Internet_Access_PS

The OracleComms_Model_O2A_Broadband_Internet_Access_PS project contains the domains and products for broadband Internet services.

The following domains are defined in this project:

BroadbandInternetDomain

The following products are defined in this project:

Broadband_Bandwidth_PS
Broadband_Modem_PS
Broadband_Offer_Charge_Class
Broadband_PS
Broadband_Router_PS
Firewall_PS

OracleComms_Model_O2A_Email_PS

The OracleComms_Model_O2A_Email_PS project contains the domains and products for email services.

The following domains are defined in this project:

EmailDomain

The following products are defined in this project:

Email_Service_PS

OracleComms_Model_O2A_Install_PS

The OracleComms_Model_O2A_Install_PS project contains the products for installation services.

The following products are defined in this project:

High_Speed_Internet_Installation_PS

OracleComms_Model_O2A_Internet_Media_PS

The OracleComms_Model_O2A_Internet_Media_PS project contains the domains and products for Internet media services.

The following domains are defined in this project:

InternetMediaDomain

The following products are defined in this project:

Internet_Media_PS

OracleComms_Model_O2A_VoIP_PS

The OracleComms_Model_O2A_VoIP_PS project contains the domains and products for VoIP services.

The following domains are defined in this project:

VoIPDomain

The following products are defined in this project:

Value_Added_Features_PS
VoIP_Adaptor_PS
VoIP_Fax_Service_PS
VoIP_Offer_Charge_Class
VoIP_Phone_PS
VoIP_PS
VoIP_Soft_Phone_PS
VoIP_Visual_Voicemail_PS
VoIP_Voicemail_PS
Web_Conferencing_PS

Conceptual Model Projects for Service Order Management

The following cartridges provide entities that are used by or referenced by service order management Order-to-Activate cartridges when the service option without calculate service order is used.

For more information about the conceptual model, see Design Studio Concepts.

OracleComms_Model_O2A_SOM_PS

The OracleComms_Model_O2A_SOM_PS project contains the products for service order management services when the service option without calculate service order is used.

The following products are defined in this project:

SOM_Broadband_Bandwidth_PS
SOM_Broadband_Modem_PS
SOM_Broadband_PS
SOM_Broadband_Router_PS
SOM_Email_Service_PS
SOM_Firewall_PS
SOM_Internet_Media_PS
SOM_Value_Added_Features_PS
SOM_VoIP_Adaptor_PS
SOM_VoIP_Fax_Service_PS
SOM_VoIP_Phone_PS
SOM_VoIP_PS
SOM_VoIP_Service_Feature_Billing_Validation_PS
SOM_VoIP_Service_Plan_Billing_Validation_PS
SOM_VoIP_Soft_Phone_PS
SOM_VoIP_Visual_Voicemail_PS
SOM_VoIP_Voicemail_PS
SOM_Web_Conferencing_PS

Oracle AIA Emulators

The Oracle AIA emulators are used in development and testing when Oracle AIA is not available.

Table 4-99 lists and describes the emulators contained in the OracleComms_OSM_O2A_Install project.

Note:

In the Order to Cash solution, OSM interacts with billing, CRM, and Provisioning systems using Oracle AIA. It does not directly interact with Siebel CRM, BRM, and provisioning systems.

Table 4-99 Emulators in OSM

Name	Description
osm_AIASyncCustomerEmulator	Emulates Oracle AIA billing service (for example, BRM ABCS by generating response messages in EBM format for requests targeted at a billing provider to synchronize customer account details.
osm_AIAInitiateFulfillBillingEmulator	Emulates Oracle AIA billing service by generating response messages in EBM format for requests targeted at a billing provider to initiate or fulfill billing.
osm_AIAFalloutNotificationToOrderEmulator	Emulates Oracle AIA error handling by generating order fallout notification messages for faults targeted at Oracle AIA error handling. These are error faults generated by the external systems (such as Provisioning). Error faults are sent to Oracle AIA which then translate them into fallout notifications and sent to OSM central order management.
osm_AIATroubleTicketEmulator	Emulates an Oracle AIA trouble ticket Siebel CRM service by generating response messages in EBM format for requests targeted at Siebel CRM to create trouble tickets. Note that no trouble ticket response is generated for Update Trouble ticket EBMs but only for Create Trouble ticket EBMs.
osm_CF2LFProvisionOrderCreateEmulator	Emulates an OSM service (for example, OSM ABCS) for service order creation by wrapping EBM format messages in OSM format for requests targeted at OSM service order management fulfillment to process service orders.
osm_LF2CFProvisionOrderUpdateEmulator	Emulates an OSM service (for example, OSM ABCS) for order update by wrapping EBM format messages in OSM format for messages targeted at OSM central order management fulfillment to update service orders.
osm_AIAProvisionOrderEmulator	Emulates Oracle AIA Provisioning service (for example, order management) fulfillment by generating response messages in EBM format for requests targeted at OSM service order management fulfillment to process service orders.
osm_InventoryOrderEmulator	Emulates UIM by setting simulated enriched data from inventory such as Service ID and MAC Address.
osm_TomOrderEmulator	Emulates a technical order management system by returning a successful status to requests.