Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Service Bus
11g Release 1 (11.1.1.7)

Part Number E15867-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

32 Customization

This chapter provides details on customizing an Oracle Service Bus (OSB) environment. Instructions include finding and replacing the values of environment variables associated with different resources, and creating customization files that invoke automated changes to resources and environment values when moving an OSB configuration from one environment to another.

This chapter includes the following sections:

32.1 Finding and Replacing Environment Values

Use the Find and Replace page to search for environment values that differ between domains. Environment values are certain predefined fields in the configuration data whose values are very likely to change when you move your configuration from one domain to another (for example, from test to production). Environment values represent entities such as URLs, URIs, file and directory names, server names, emails, and such. Also, environment values can be found in alert destinations, proxy services, business services, SMTP Server and JNDI Provider resources, and UDDI Registry entries.

This page behaves differently based on whether or not you are in a session. If you are in a session, you can find and replace environment values. However, if you are outside a session, you can find environment values only; Replace All is disabled.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Section 3.1, "Using the Change Center."

  2. Select System Administration > Find & Replace.

  3. In the Find Value field, enter the environment value that you want to locate.

  4. To display a list of environment values in your configuration that contain the value you entered, click Find.

    A list of relevant values is displayed, which includes the Owner, Type, and the Environment Value columns.

  5. To locate only items changed in your current session, select the Only Items Changed In Current Session check box.

  6. Select the variable type for which to search, from the Find in Variable Type list, described in Table 32-1.

    Table 32-1 Variable Types

    Variable Type Found In Description

    Alert SNMP Trap

    Alert Destination

    SNMP trap (enable or disable) for an alert destination.

    Alert to Log

    Alert Destination

    Alert Logging (enable or disable) for an alert destination.

    Alert To Reporting Data

    Alert Destination

    Alert to reporting data (enable or disable) for an alert destination.

    Email Archive Directory

    Email proxy

    Archive directory for an email proxy service.

    Email Destination URI

    Alert Destination

    URI in an email alert destination.

    Email Download Directory

    Email proxy

    Download directory for an email proxy service.

    Email Error Directory

    Email proxy

    Error directory for an email proxy service.

    FTP Archive Directory

    FTP proxy

    Archive directory for an FTP proxy service.

    FTP Download Directory

    FTP proxy

    Download directory for an FTP proxy service.

    FTP Error Directory

    FTP proxy

    Error directory for an FTP proxy service.

    File Archive Directory

    File proxy

    Archive directory for a file proxy service.

    File Error Directory

    File proxy

    Error directory for a file proxy service.

    File Stage Directory

    File proxy

    Stage directory for a file proxy service.

    IMAP Move Folder

    Email proxy

    IMAP Move directory for an email proxy service.

    JCA Always Use WSDL Flag

    JCA proxy and business service

    Determines whether connection factory properties, activation spec properties (proxy services), and interaction spec properties (business services) are always used from the WSDL.

    JCA Connection Mode

    JCA proxy and business service

    Determines how a service connects to an associated JCA adapter: managed or non-managed mode.

    JCA Overwrite Connection Authentication Flag

    JCA proxy and business service

    Determines whether the authentication credentials in the JCA adapter connection factory are overridden in a development/test environment (non-managed connection mode).

    JMS Alert Destination URI

    Alert Destination

    URI in a JMS alert destination.

    JMS Managed Server

    JMS business service

    Managed Server entry in the table of Managed Server vs. destination of a JMS business service with a response correlation pattern as Message ID pattern.

    JMS Queue Connection Factory

    JMS proxy and business service

    A response queue connection factory of a JMS proxy or business service with the response correlation pattern as Message ID.

    JMS Response Destination

    JMS business service

    Destination entry in the table of Managed Server vs. destination of a JMS business service with a response correlation pattern as Message ID pattern.

    JMS Response URI

    JMS proxy and business service

    The URI of the response queue for JMS proxy or business services using response correlation pattern of JMS Correlation ID.

    JNDI Provider URL

    JNDI Provider

    JNDI Provider URLs.

    MQ Connection Pool Size

    MQ Connection Resource

    The size of the MQ connection pool.

    MQ Connection Timeout

    MQ Connection Resource

    The time interval after which unused connections are destroyed.

    MQ Dead Letter URI

    MQ proxy

    The URI of the dead letter queue to which request messages are redirected after a pipeline retries a message a specified number of times.

    MQ Host Name

    MQ Connection Resource

    The host name of the MQ queue manager.

    MQ Port Number

    MQ Connection Resource

    The port number of the MQ queue manager listener.

    MQ Queue Manager Channel Name

    MQ Connection Resource

    The queue manager server connection channel name.

    MQ Queue Manager Name

    MQ Connection Resource

    The name of the MQ queue manager.

    MQ Response URI

    MQ proxy and business service

    Proxy or business service URI.

    MQ Unrecognized Response URI

    MQ business service

    The URI of the queue to which unrecognized response messages are sent.

    MQ Version

    MQ Connection Resource

    The version of WebSphere MQ being used.

    Managed Server for Polling

    Email, File, FTP, or SFTP proxy service in a clustered domain

    Managed Server for polling in a clustered domain.

    Proxy Server Host

    Proxy Server Resource

    The host name of the proxy server.

    Proxy Server Port

    Proxy Server Resource

    The port number of the proxy server.

    Proxy Server SSL Port

    Proxy Server Resource

    The SSL port of the proxy server.

    SFTP Archive Directory

    SFTP proxy

    Archive directory for a SFTP proxy service. If direct-streaming is on, the archive directory is present on the remote SFTP server; otherwise, it is present locally.

    SFTP Download Directory

    SFTP proxy

    Download directory for a SFTP proxy service.

    SFTP Error Directory

    SFTP proxy

    Error directory for a SFTP proxy service. If direct-streaming is on, the error directory is present on the remote SFTP server; otherwise, it is present locally.

    SMTP Server URL

    SMTP Server

    SMTP Server URLs.

    Secure Connections to JMS Server

    JMS proxy or business service

    If true, Oracle Service Bus connects to the JMS server and JNDI tree using SSL (t3s); otherwise, connections occur over a clear text (t3) channel.

    Service Retry Count

    Business service

    The number of times endpoint URIs are retried; in other words, the number of failover attempts.

    Service Retry Iteration Interval

    Business service

    The length of time that a business service waits before iterating over the entire set of URIs again.

    Service URI

    Proxy or business service

    Proxy or business service URI.

    Service URI Weight

    Business service

    The individual weights assigned to business service URIs.

    Split-Join Work Manager

    Split-Join

    Work Manager name (Dispatch Policy) for a split-join resource.

    Tuxedo Access Point Map

    Proxy or business service

    Name and address of the local access point(s) per Managed Server; there is one location per URI.

    Tuxedo Access Point Name

    Business service

    Name of the remote WTC access point associated with the URI.

    Tuxedo Network Address

    Business service

    Network address of the remote WTC access point associated with the URI.

    UDDI Auto Import

    UDDI Registry

    Auto-synchronize property of an imported business service from a UDDI Registry. This property is per registry.

    UDDI Auto Publish

    Proxy service

    Auto-publish property of a proxy service to a UDDI Registry.

    UDDI Inquiry URL

    UDDI Registry

    Inquiry URL for a UDDI Registry.

    UDDI Publish URL

    UDDI Registry

    Publish URL for a UDDI Registry.

    UDDI Security URL

    UDDI Registry

    Security URL for a UDDI Registry.

    UDDI Subscription URL

    UDDI Registry

    Subscription URL for a UDDI Registry.

    WS Error Queue URI

    WS business service

    The URI of the JMS queue for storing error messages.

    Work Manager

    Proxy or business services

    Work Manager name (Dispatch Policy) in all proxy and business services.


  7. To locate environment values located in a particular project, select the project name from the Located in Project list.

  8. In the Replace with field, enter the new environment value.

  9. To replace the original environment value with the new value, click Replace All.

    All occurrences of the environment value you entered in the Find Value field are replaced with the environment value you entered in the Replace with field in the current session.

    Note:

    Certain environment values are complex XML objects that cannot be found and replaced using the Administration Console. However, you can still set these environment values directly by using the ALSBConfigurationMBean from a script. For detailed information about ALSBConfigurationMBean, see the Oracle Service Bus API Reference. In addition to setting them through the API, you can set complex type environment values using customization files. See Section 32.3, "Executing Customization Files."

  10. To end the session and deploy the configuration to the runtime, click Activate under Change Center.

Related Topics

For detailed information about EnvValueTypes, see the Oracle Service Bus API Reference. The Java types and location values of these environment values are specified in the API reference.

32.2 Creating Customization Files

The Create Customization File page provides a convenient way to generate a customization file for a set of resources or projects that you select. You can then use this file as a starting point for making your desired modifications by specifying the actual values for an environment.

You can use customization files to make changes to environment values as well as to change references within resources. Customization files can include customizations for all the environment values found in the resources you selected, including complex environment values types defined inside the EnvValueTypes class. In addition, it includes a reference customization type for changing resource references inside resources with dependencies.

The customization schema (Customization.xsd), which describes the customization types, is available at the following location in your Oracle Service Bus installation:

OSB_ORACLE_HOME\modules\com.bea.common.configfwk_version.jar.

To create a customization file:

  1. Select System Administration > Create Customization File.

    The Create Customization File page displays the list of objects in your configuration. The name and type of each object is displayed.

  2. Select the projects or resources you want to include in the customization file.

    1. Expand the project folders. The name and type for each resource contained in the project is displayed.

    2. Select the check boxes associated with the projects or resources you want to include in the customization file.

    3. Clear the check boxes associated with the projects or resources that you do not want to include in the customization file.

  3. Click Create File to create a customization XML file.

  4. In the File Download dialog box, click Open to open the customization file or click Save to save the XML file to your desktop.

  5. In an XML editor, use the customization schema in conjunction with the base customization file you created to make the necessary modifications to resources and environment variables.

    Your base customization file may already be populated with environment variables. Table 32-1 shows which environment variables are automatically included with different resources.

32.3 Executing Customization Files

Use this page to execute a customization XML file that has been previously saved on your system. Customization files provide a convenient way to modify your environment during deployment, from development to staging, from staging to production, or during design time.

You must be in a session to execute a customization file.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Section 3.1, "Using the Change Center."

  2. Select System Administration > Execute Customization File.

  3. Select a customization file to execute.

    1. In the File Name field, click Browse to locate the directory where the customization file is stored.

    2. Select the XML file, then click Open.

  4. Click Next. The following customization details are displayed, shown in Table 32-2.

    Table 32-2 Customization Details

    Property Description

    Operation

    • Find & Replace—modify environment values by doing string substitutions.

    • Map References—maps existing references found in resources to other references.

    • Set Environment Values—modify environment values for resources.

    Apply To

    Name of the service, project, folder, or resource to be customized.

    The name is a link to the Configuration Details page of the service or resource, or to the project or folder in the Project Explorer.

    Description

    A description of each customization.


  5. To customize only resources, services, projects, or folders changed in the current session, select the Only Items Changed In Current Session check box.

    If you limit customizations to only resources modified in the current session, the Apply To column gets updated with the resources modified in current session. If you limit customizations of a project or folder, then the resources modified in current session within that project or folder are displayed in Apply To column.

  6. Click Execute to commit the updates in the current session.

    To view customization details, within the session, select View Changes under Change Center, and click the Customization task. See Section 3.4, "Viewing Configuration Changes."

  7. To end the session and deploy the configuration to the runtime, click Activate under Change Center.