Extending Component Cartridges

Cartridge extensibility is the ability to extend the functionality of sealed cartridges by building on to them, rather than unsealing them and modifying the contents directly.

This type of extensibility applies to any OSM component cartridge, including productized cartridges.

To understand the features and functionality that enable cartridge extensibility, see the following topics:

When working with OSM cartridge extensibility, see the following topics:

Adding a New Fulfillment Function

This topic describes design steps to add a new fulfillment function.

To add a new fulfillment function for a new service offering:

  1. Import all of the component cartridges to be included in the solution into Design Studio.

    For example, this might include a sealed base cartridge, Billing cartridge, Provisioning cartridge, Fulfillment Pattern cartridge, and Product Mapping cartridge.

  2. Create a new Order and Service Management project to host the new fulfillment function.

    See "Creating New Cartridge Projects" for more information.

  3. In the Order and Service Management Project editor Properties tab, deselect the Standalone check box.

    This allows the cartridge to be referenced in the composite cartridge as part of the solution (rather than as a standalone cartridge with no dependencies).

  4. Delete the Order entity.

  5. Create a base task for the new function that will serve as the base from which to extend all other new tasks.

    See "Creating New Tasks" and "About Task Extensions and Inheritance" for more information.

  6. Create any other tasks required by the new function by extending from the base task created in the previous step.

  7. Create a new process or extend from a process that will execute when fulfilling the new function.

    See "Creating New Processes" for more information.

  8. Create the new fulfillment function.

    See "Adding New Functional Order Components" for detailed instructions.

  9. Select an orchestration fulfillment pattern that maps to the new function or create a new orchestration fulfillment pattern.

  10. (Optional) Create a new fulfillment system for the fulfillment function.

    Often, when you introduce a new fulfillment function, you will also require a new fulfillment system. See "Adding New Fulfillment Systems" for more information.

  11. Create a new decomposition rule that maps from the fulfillment function to the fulfillment system.

    See "Creating New Decomposition Rules" for detailed information.

  12. If you do not already have a composite cartridge to use, create a new Order and Service Management Composite project.

    See "Creating New Cartridge Projects" for more information.

  13. Add the necessary cartridges, including the cartridge you created for the new fulfillment function, to the Dependency tab for the composite cartridge.

    See "Project Editor Dependency Tab" for more information.

  14. Check entity-level dependencies.

  15. Create a composite cartridge view in the cartridges containing the orders that will use the new fulfillment function.

    See "Creating New Cartridge Composite Views" for more information.

  16. Add the data for the new tasks you created to the composite cartridge view.

    See "Adding Task Data to a Composite Cartridge View" for more information.

  17. Create a task data contribution to extend the existing sales order creation task and order query task.

    See "Contributing Task Data to a Composite Cartridge" for more information.

  18. Package and deploy the composite cartridge.

    See "Packaging and Deploying Orchestration Cartridges" for more information.

Adding a New Fulfillment Mode

This topic describes design steps to add new fulfillment mode.

To add new fulfillment mode:

  1. Import all of the component cartridges to be included in the solution into Design Studio.

    For example, this might include a sealed base cartridge, Billing cartridge, Provisioning cartridge, Fulfillment Pattern cartridge, and Product Mapping cartridge.

  2. Create a new Order and Service Management project to host the new fulfillment function.

    See "Creating New Cartridge Projects" for more information.

  3. In the Order and Service Management Project editor Properties tab, deselect the Standalone check box.

    This allows the cartridge to be referenced in the composite cartridge as part of the solution (rather than as a standalone cartridge with no dependencies).

  4. Add a new fulfillment mode.

    See "Creating New Fulfillment Modes" for more information.

  5. Create a new recognition rule that recognizes the new fulfillment mode inside either the new cartridge or an unsealed existing cartridge.

    See "Creating New Recognition Rules" for more information.

  6. Add the new fulfillment mode to the base orchestration fulfillment pattern or to any applicable orchestration fulfillment patterns.

    See "Orchestration Fulfillment Pattern Editor Details Tab" for more information.

  7. Model the orchestration plan for the new fulfillment mode for all of the affected orchestration fulfillment patterns.

    See "Orchestration Fulfillment Pattern Editor Orchestration Plan Tab" for more information.

  8. If you do not already have a composite cartridge to use, create a new Order and Service Management Composite project.

    See "Creating New Cartridge Projects" for more information.

  9. Add the necessary cartridges, including the cartridge you created for the new fulfillment function, to the Dependency tab for the composite cartridge.

    See "Project Editor Dependency Tab" for more information.

  10. Ensure that the appropriate orders, fulfillment patterns, and recognition rules are included in the manifest for the solution cartridge.

    See "Composite Cartridge Editor Manifest Tab" for more information.

  11. Package and deploy the composite cartridge.

    See "Packaging and Deploying Orchestration Cartridges" for more information.

Adding a New Product

This topic describes design steps to add a new product.

To add a new product:

  1. Import all of the component cartridges to be included in the solution into Design Studio.

    For example, this might include a sealed base cartridge, Billing cartridge, Provisioning cartridge, Fulfillment Pattern cartridge, and Product Mapping cartridge.

  2. Create or select an Order and Service Management project to host any new OSM entities.

    See "Creating New Cartridge Projects" for more information.

  3. In the Order and Service Management Project editor Properties tab, ensure that the Standalone check box is not selected.

    This allows the cartridge to be referenced in the composite cartridge as part of the solution (rather than as a standalone cartridge with no dependencies).

  4. Create or select a common model project to contain common model entities.

    See "Creating New Cartridge Projects" for more information.

  5. Ensure that an appropriate container relationship is defined for the common model project you are going to use.

    See "Project Editor Properties Tab" for more information.

  6. Create or import the new product into the common model project.

    See "Importing Products" or "Product Editor" for more information.

  7. (Optional) Associate the new product with a domain in the conceptual model.

    See "Domain Editor" for more information.

  8. (Optional) Create an order item parameter binding for the new product if you are planning to use the distributed order template or order transformation manager.

    See "Working with Order Item Parameter Bindings" for more information.

  9. Map the new product to an existing fulfillment pattern or create a new fulfillment pattern and map it to the new product in the common model project.

    See "Product Editor Properties Tab" for more information.

  10. If you created a new fulfillment pattern in the common model project, create a new OSM orchestration fulfillment pattern and set it to realize the common model fulfillment pattern you created.

    See "Creating New Orchestration Fulfillment Patterns" and "Orchestration Fulfillment Pattern Editor Realization Tab" for more information.

  11. If you added a new orchestration fulfillment pattern, model the orchestration for the new orchestration fulfillment pattern.

    See "Orchestration Fulfillment Pattern Editor" and "Decomposition Rule Editor Details Tab" for more information.

  12. If you do not already have a composite cartridge to use, create a new Order and Service Management Composite project.

    See "Creating New Cartridge Projects" for more information.

  13. Add the necessary cartridges, including any OSM cartridge you created, to the Dependency tab for the composite cartridge.

    See "Project Editor Dependency Tab" for more information.

  14. Ensure that the appropriate orders, fulfillment patterns, and recognition rules are included in the manifest for the solution cartridge.

    See "Composite Cartridge Editor Manifest Tab" for more information.

  15. Package and deploy the composite cartridge.

    See "Packaging and Deploying Orchestration Cartridges" for more information.

Adding a New Service

Describes design steps to implement triple-play solution (broadband, VoIP, TV).

  1. Import all of the component cartridges to be included in the solution into Design Studio.

    For example, this might include a sealed base cartridge, Billing cartridge, Provisioning cartridge, Fulfillment Pattern cartridge, and Product Mapping cartridge.

  2. Create or select an Order and Service Management project to host any new OSM entities.

    See "Creating New Cartridge Projects" for more information.

  3. In the Order and Service Management Project editor Properties tab, ensure that the Standalone check box is not selected.

    This allows the cartridge to be referenced in the composite cartridge as part of the solution (rather than as a standalone cartridge with no dependencies).

  4. Create or select a common model project to contain common model entities.

    See "Creating New Cartridge Projects" for more information.

  5. Ensure that an appropriate container relationship is defined for the common model project you are going to use.

    See "Project Editor Properties Tab" for more information.

  6. Add a new orchestration fulfillment pattern that extends from the base orchestration fulfillment pattern.

    See "Creating New Orchestration Fulfillment Patterns" for more information.

  7. Model the orchestration plan for the new orchestration fulfillment pattern.

    See "Orchestration Fulfillment Pattern Editor Orchestration Plan Tab" for more information.

  8. If the new service requires communicating with one or more new external systems, create order component specifications for the new systems.

    See "Creating New Order Component Specifications" for more information.

  9. If you have created new order component specifications, ensure the Order Component Executable check box is deselected.

  10. Create or import the new product into the common model project.

    See "Importing Products" or "Product Editor" for more information.

  11. (Optional) Associate the new product with a domain in the conceptual model.

    See "Domain Editor" for more information.

  12. (Optional) Create an order item parameter binding for the new product if you are planning to use the distributed order template or order transformation manager.

    See "Working with Order Item Parameter Bindings" for more information.

  13. Map the new product to the appropriate fulfillment pattern in the common model project.

    See "Product Editor Properties Tab" for more information.

  14. Add decomposition rules for the new service.

    See "Creating New Decomposition Rules" for more information.

  15. If you do not already have a composite cartridge to use, create a new Order and Service Management Composite project.

    See "Creating New Cartridge Projects" for more information.

  16. Add the necessary cartridges, including any OSM cartridge you created, to the Dependency tab for the composite cartridge.

    See "Project Editor Dependency Tab" for more information.

  17. Ensure that the appropriate orders, fulfillment patterns, and recognition rules are included in the manifest for the solution cartridge.

    See "Composite Cartridge Editor Manifest Tab" for more information.

  18. Package and deploy the composite cartridge.

    See "Packaging and Deploying Orchestration Cartridges" for more information.