Testing OSM Cartridge Models

Design Studio enables you to make changes to OSM cartridges, deploy them to an environment, and review the changes without leaving the Design Studio user interface. Using the Submit Test feature, you can submit sample XML orders to run-time environments for the purpose of reviewing the cartridge model behavior. Once you have deployed the full cartridge to an environment, you can use the Optimize Deploy feature in conjunction with Submit Test to model and test your cartridges efficiently.

When testing OSM cartridge models, see the following topics:

About Submit Test

The Design Studio Submit Test feature enables you to submit a sample XML order to a run-time environment for the purpose of testing your cartridge model. For example, if you were creating recognition rules for an orchestration cartridge, you could submit sample orders to ensure that the OSM server was properly recognizing the input messages for each recognition rule and directing the order to the right cartridge. Additionally, you could target the sample order to a specific version of a cartridge, test OSM behaviors, and so forth.

When submitting sample orders to run-time environments, the root level of the sample order XML document must be either the CreateOrder or the CreateOrderBySpec XML API request. For example:

<?xml version="1.0" encoding="UTF-16"?>
<ord:CreateOrder xmlns:ord="http://xmlns.oracle.com/communications/ordermanagement">
<zeb:order xmlns:zeb="http://www.example.org/zebra" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <zeb:sampleLine>
          <zeb:lineName>newPhoneLine</zeb:lineName>
          <zeb:class>potsService</zeb:class>
     </zeb:sampleLine>
</zeb:order>
</ord:CreateOrder>

You save all sample XML orders in a project samples directory, accessible from the Package Explorer view.

Submitting Test Orders to Run-time Environments

The Design Studio Submit Test feature enables you to submit a sample XML order to a run-time environment for the purpose of testing your cartridge model.

To submit test orders to run-time environments:

  1. From the Package Explorer view, copy a sample XML order into the project samples directory.

  2. Connect to an environment.

    See "Testing Run-Time Environment Connectivity" for more information.

    Note:

    When connecting to the environment, ensure that the account that you use to log-in is set up properly in WebLogic. To submit tests from Design Studio, user accounts must be assigned to the OMS_client and OMS_ws_api groups in WebLogic.
  3. If necessary, deploy the full cartridge to the run-time environment.

    See "Deploying Cartridge Projects" for more information.

  4. From the Studio menu, select Show Design Perspective.

  5. In the Studio Projects view, right-click a cartridge and select Submit Test.

    If you have successfully connected to an environment, and your project contains a valid sample order in the project samples directory, Design Studio displays a list of environments and files available to submit.

  6. Select an environment and order combination.

    The Console view is displayed, indicating the status of the submitted order. If the connection is successful, the Console view displays the OSM server response, which includes the order ID, version number, the cartridge name, and so forth. Design Studio opens a browser window in the editor area that points to the log-in window for the environment.

    Note:

    For the browser window in the editor area of Design Studio to work with OSM, you must configure Eclipse to use a supported external browser. See "Defining Web Browser Preferences" for more information.

    Note:

    Starting with OSM 7.2, order IDs are allocated in blocks. For OSM running on a standalone database, there is no visible impact. However, if OSM is running on an Oracle RAC database, Order IDs are assigned from different blocks, one for each Oracle RAC instance. This means that when orders are submitted, the Order IDs may not be sequential.
  7. Log into the environment.

    The web client displays a list of orders submitted to the environment.

  8. Locate the table row that contains your sample order.

    For example, you might locate the row using the order ID displayed in the Console view.

  9. Double-click the sample order to open the order and review the order data in the web client tabs.

    For example, if you were submitting a sample order for an orchestration cartridge, you could review the information in the Summary tab, Data tab, Orchestration Plan tab, and so forth.

    For information about the fields in the Order Management web client, see OSM Order Management Web Client User's Guide. For information about the fields in the Task web client, see OSM Task Web Client User's Guide.

  10. (Optional) Update the cartridge with additional changes, save the changes, and use the optimize deploy feature to deploy only the cartridge metadata changes.

    See "Deploying Cartridge Projects with Optimize Deploy" for more information.

  11. (Optional) Connect to another environment to test the cartridge model in multiple environments.

    For each environment that you submit tests to, Design Studio opens a separate browser window. See "Testing Run-Time Environment Connectivity" for more information.

  12. (Optional) Clear the environment connection information if you want to submit a sample order as a different user.

    From the Studio Projects view, right-click a cartridge and select Submit Test, then select an environment, then select Clear Environment Credentials to clear the environment connection information.