33 Provisioning Service Bus Resources

Service Bus is an enterprise-class service bus that connects, manages, and mediates interactions between heterogeneous services. Service Bus accelerates service configuration, integration, and deployment, thus simplifying management of shared services across the Service-Oriented Architecture (SOA).

The resources of Service Bus can be organized into individual projects. Projects are non-hierarchical, disjointed, top-level grouping constructs. All resources (such as business services, proxy services, WS-Policies, WSDLs, schemas, XQuery transformations, JARs, and so on) reside in exactly one non-overlapping project. Resources can be created directly under a project or be further organized into folders. Folders may be created inside projects or inside other folders, and the folders are similar to directories in a file system, with the project level being the root directory.

While Oracle Enterprise Manager Cloud Control (Cloud Control) allows you to discover and monitor these Service Bus targets, it also provides Deployment Procedures that help you provision Service Bus resources.

This chapter explains how you can provision Service Bus resources. In particular, this chapter covers the following:

33.1 Getting Started with Provisioning Service Bus Resources

This section helps you get started with this chapter by providing an overview of the steps involved in provisioning Service Bus resources. Consider this section to be a documentation map to understand the sequence of actions you must perform to successfully provision Service Bus resources. Click the reference links provided against the steps to reach the relevant sections that provide more information.

Table 33-1 Getting Started with Provisioning Service Bus Resources

Step Description Reference Links

Step 1

Knowing About The Supported Releases

Know what releases of Service Bus can be provisioned by the Deployment Procedure.

To learn about the releases supported by the Deployment Procedure, see Section 33.2.

Step 2

Selecting the Use Case

This chapter covers a few use cases for provisioning Service Bus resources. Select the use case that best matches your requirements.

  • To learn about provisioning Service Bus resources from the an Service Bus domain, see Section 33.3.

  • To learn about provisioning Service Bus resources from the Software Library, see Section 33.5.

Step 3

Meeting the Prerequisites

Before you run any Deployment Procedure, you must meet the prerequisites, such as setting up of the provisioning environment, applying mandatory patches, and setting up of Oracle Software Library.

  • To learn about the prerequisites for provisioning Service Bus resources from the an Service Bus domain, see Section 33.3.

  • To learn the prerequisites for provisioning Service Bus resources from the Software Library, see Section 33.5.

Step 4

Running the Deployment Procedure

Run the Deployment Procedure to successfully provision Service Bus resources.

  • To provision Service Bus resources from the an Service Bus domain, follow the steps explained in Section 33.3.

  • To provision Service Bus resources from the Software Library, follow the steps explained in Section 33.5.


33.2 Supported Releases

Using this Deployment Procedure, you can provision the resources for Service Bus 2.6, 2.6.1, 3.0, and 10gR3 (3.1).

33.3 Provisioning Service Bus Resources from Service Bus Domain

This section describes how you can provision Service Bus resources directly from an Service Bus domain.

Before running the Deployment Procedure, meet the following prerequisites:

Prerequisites for Designers

  • Ensure that you meet the prerequisites described in Chapter 2.

  • Ensure that the source Service Bus (from where you want to export the resources) is already discovered and monitored in Cloud Control.

  • If you want to use a customization file to customize the environment variables in the changed (target) environment, then you must ensure that the customization file is available as a generic component in Oracle Software Library. For instructions to create generic components, see Section 2.2.

Prerequisites for Operators

  • If you have PAM/LDAP enabled in your environment, then ensure that the target agents are configured with PAM/LDAP. For more information, see My Oracle Support note 422073.1.

  • Ensure that you use an operating system user that has the privileges to run the Deployment Procedure, and that can switch to root user and run all commands on the target hosts. For example, commands such as mkdir, ls, and so on.

    If you do not have the privileges to do so, that is, if you are using a locked account, then request your administrator (a designer) to either customize the Deployment Procedure to run it as another user or ignore the steps that require special privileges.

    For example, user account A might have the root privileges, but you might use user account B to run the Deployment Procedure. In this case, you can switch from user account B to A by customizing the Deployment Procedure.

    For information about customization, see Section 2.3.

To provision Service Bus resources from a source Service Bus domain, follow these steps:

  1. From the Enterprise menu, select Provisioning and Patching, then select Middleware Provisioning.

  2. From the Deployment Procedures section, select the Service Bus Resource Provisioning procedure from the list and click Launch.

  3. On the Select Source page, in the Source section, select Service Bus Domain.

    1. For Domain, click the torch icon and select the Service Bus domain from where the resources can be exported and deployed to a target Service Bus domain. In the following page of the wizard, you will be allowed to select the domain's projects that you want to export.

    2. For BEA Home Directory, specify the full path to the BEA home directory where all BEA product-related files are stored. For example, /home/mark/bea.

    3. Click Next.

  4. On the Select Projects page, do the following:

    1. In the Resource Summary section, select the projects you want to export and deploy to the target Service Bus domain. The selected projects are exported to a JAR file, and the JAR file is moved to the host where the target Service Bus domain is running.

      Note that the resources of the selected projects that exist in the target Service Bus domain but not in the exported JAR file will be deleted.

    2. In the Export Mode section, do one of the following:

      Select Export Projects if you want to export the resources at project level. While deploying the exported JAR file to the target host, the entire project is deployed. This may add, overwrite, or delete resources depending on the availability of resources on the target host.

      Select Export Resources if you want to export the resources at resource level. While deploying the exported JAR file to the target host, only the resources are deployed. This may add or overwrite resources depending on the availability of resources on the target host.

      To understand these options better, read the use cases described in Section 33.4.

    3. (Optional) In the Security Options section, if the projects you want to export contain any resources with sensitive data, then specify a pass-phrase to protect them. The same pass-phrase will be used to import the protected resources during deployment.

    4. (Optional) In the Save Projects to Software Library section, select Save Projects to Software Library and specify a component name and location if you want to save the exported project JAR file as a generic component in the Software Library.

      By default, the projects you select here are exported to a JAR file and moved to the host where the Administration server of the target Service Bus domain is running. However, the JAR files are not saved in the Software Library for future use. Using this option, you can save them as a component in the Software Library.

  5. On the Select Target page, do the following:

    1. In the Target section, specify the following:

      For Domain, click the torch icon and select the Service Bus domain where you want to deploy the selected resources.

      For BEA Home Directory, specify the full path to the BEA home directory where all BEA product-related files are stored.

    2. (Optional) In the Advanced Options section, select the settings you want to retain if you have done some customization to the resources selected for deployment, and if you want to preserve those changes in the target Service Bus domain.

      Note that for Service Bus 2.6.x, Security and Policy Configuration, Credentials, and Access Control Policies cannot be preserved.

    3. In the Customization section, provide details about the customization file that can be used to modify the environment settings in the target Service Bus domain.

      If you do not want to use a customization file, select None.

      If you are using a customization file and if it is available on the host where the target Service Bus domain is running, then select Use the Customization file on the target host and specify the full path to the location where the file is present.

      If the customization file is stored as a generic component in Oracle Software Library, then select Select the customization file from the Software Library and specify the full path to the location in Oracle Software Library where the generic component is stored.

    4. Click Next.

  6. On the Set Credentials page, specify the following and click Next.

    1. Specify the login credentials of the source and target Service Bus domains.

    2. Specify the credentials of the hosts where the Management Agents, which are monitoring the administration servers of the Service Bus domains, are running

  7. In the Schedule page, specify a Deployment Instance name. If you want to run the procedure immediately, then retain the default selection, that is, One Time (Immediately). If you want to run the procedure later, then select One Time (Later) and provide time zone, start date, and start time details. You can set the notification preferences according to deployment procedure status. If you want to run only prerequisites, you can select Pause the procedure to allow me to analyze results after performing prerequisite checks to pause the procedure execution after all prerequisite checks are performed. Click Next.

  8. On the Review page, review the details you have provided for the Deployment Procedure. If you are satisfied with the details, then click Submit to run the Deployment Procedure according to the schedule set. If you want to modify the details, click the Edit link in the section to be modified or click Back repeatedly to reach the page where you want to make the changes.

  9. In the Procedure Activity page, view the status of the execution of the job and steps in the deployment procedure. Click the Status link for each step to view the details of the execution of each step. You can click Debug to set the logging level to Debug and click Stop to stop the procedure execution.

33.4 Understanding the Export Modes for Service Bus Resources

The following describes the different use cases and explains how the export modes will work for those circumstances.

While the first column shows the project selected from the source domain and the resources contained in that selected project, the second column shows the availability of that project in the target domain. And, while the third column shows how Export at Project Level work, the fourth column shows how Export at Resource Level works.

Table 33-2 Understanding Export Modes

Source Domain Target Domain Export at Project Level Export at Resource Level

You have selected Project_1 from the source domain, and this project has Resource_1, Resource_2, and Resource_3.

The target domain has no projects at all.

The entire Project_1 will be deployed to the target domain.

The entire Project_1 will be deployed to the target domain.

You have selected Project_1 from the source domain, and this project has Resource_1, Resource_2, and Resource_3.

The target domain has Project_1, and this project has Resource_1.

The entire Project_1 will be deployed to the target domain, wherein, Resource_1 will be overwritten because it is already available in the target domain, and Resource_2 and Resource_3 will be ADDED.

Only the resources of Project_1 will be deployed to the target domain, wherein, Resource_1 will be overwritten because it is already available in the target domain, and Resource_2 and Resource_3 will be ADDED.

You have selected Project_1 from the source domain, and this project has Resource_1.

The target domain has Project_1, and this project has Resource_1, Resource_2, and Resource_3.

The entire Project_1 will be deployed to the target domain, wherein, Resource_1 will be overwritten because it is already available in the target domain, and Resource_2 and Resource_3 will be DELETED.

Only the resources of Project_1 will be deployed to the target domain, wherein, only Resource_1 will be overwritten because it is already available in the target domain. The other two resources already available in the target domain, that is, Resource_2 and Resource_3 will NOT be affected.


33.5 Provisioning Service Bus Resources from Oracle Software Library

This section describes how you can provision Service Bus resources from the Software Library.

Before running the Deployment Procedure, meet the following prerequisites:

Prerequisites for Designers

  • Ensure that you meet the prerequisites described in Chapter 2.

  • Export the resources of an Service Bus domain as a JAR file. Use Service Bus console for this.

  • Ensure that the JAR file is available as a generic component in Oracle Software Library. For instructions to create generic components, see Section 2.2.

  • If you want to use a customization file to customize the environment variables in the changed (target) environment, then you must ensure that the customization file is available as a generic component in Oracle Software Library. For instructions to create generic components, see Section 2.2.

Prerequisites for Operators

  • If you have PAM/LDAP enabled in your environment, then ensure that the target agents are configured with PAM/LDAP. For more information, see My Oracle Support note 422073.1.

  • Ensure that you use an operating system user that has the privileges to run the Deployment Procedure, and that can switch to root user and run all commands on the target hosts. For example, commands such as mkdir, ls, and so on.

    If you do not have the privileges to do so, that is, if you are using a locked account, then request your administrator (a designer) to either customize the Deployment Procedure to run it as another user or ignore the steps that require special privileges.

    For example, user account A might have the root privileges, but you might use user account B to run the Deployment Procedure. In this case, you can switch from user account B to A by customizing the Deployment Procedure.

    For information about customization, see Chapter 50.

To provision Service Bus resources from a source Service Bus domain, follow these steps:

  1. From the Enterprise menu, select Provisioning and Patching, then select Middleware Provisioning.

  2. From the Deployment Procedures section, select the Service Bus Resource Provisioning procedure from the list and click Launch.

  3. On the Select Source page, in the Source section, select Oracle Software Library.

    1. For Component, click the torch icon and select the generic component that contains the resources to be deployed to a target Service Bus domain.

    2. (Optional) For Pass Phrase, specify a pass-phrase if any of the resources in the JAR file contain sensitive data and are protected. The same pass-phrase is used while importing these resources to the target domain.

    3. Click Next. Cloud Control displays Select Target page.

  4. On the Select Target page, do the following:

    1. In the Target section, specify the following:

      For Domain, click the torch icon and select the Service Bus domain where you want to deploy the selected resources.

      For BEA Home Directory, specify the full path to the BEA home directory where all BEA product-related files are stored.

    2. (Optional) In the Options section, select the settings you want to retain if you have done some customization to the resources selected for deployment, and if you want to preserve those changes in the target Service Bus domain.

      Note that for Service Bus 2.6.x, Security and Policy Configuration, Credentials, and Access Control Policies cannot be preserved.

    3. In the Customization section, provide details about the customization file that can be used to modify the environment settings in the target Service Bus domain.

      If you do not want to use a customization file, select None.

      If you are using a customization file and if it is available on the host where the target Service Bus domain is running, then select Use the Customization file on the target host and specify the full path to the location where the file is present.

      If the customization file is stored as a generic component in Oracle Software Library, then select Select the customization file from the Software Library and specify the full path to the location in Oracle Software Library where the generic component is stored.

    4. Click Next.

  5. On the Set Credentials page, specify the following and click Next.

    1. Specify the login credentials of the source and target Service BusService Bus domains.

    2. Specify the credentials of the hosts where the Management Agents, which are monitoring the administration servers of the Service Bus domains, are running

  6. In the Schedule page, specify a Deployment Instance name. If you want to run the procedure immediately, then retain the default selection, that is, One Time (Immediately). If you want to run the procedure later, then select One Time (Later) and provide time zone, start date, and start time details. You can set the notification preferences according to deployment procedure status. If you want to run only prerequisites, you can select Pause the procedure to allow me to analyze results after performing prerequisite checks to pause the procedure execution after all prerequisite checks are performed. Click Next.

  7. On the Review page, review the details you have provided for the Deployment Procedure. If you are satisfied with the details, then click Submit to run the Deployment Procedure according to the schedule set. If you want to modify the details, click the Edit link in the section to be modified or click Back repeatedly to reach the page where you want to make the changes.

  8. In the Procedure Activity page, view the status of the execution of the job and steps in the deployment procedure. Click the Status link for each step to view the details of the execution of each step. You can click Debug to set the logging level to Debug and click Stop to stop the procedure execution.