3 Configuring Oracle SOA Suite

This chapter describes how to configure Oracle SOA Suite after the components have already been installed.

The following topics are covered:

3.1 Configuration Instructions

After the installation is complete, you must configure the components. The instructions in this section describe how to do so.

3.1.1 Using Default Settings for Managed Servers

During the configuration, the Oracle Fusion Middleware Configuration Wizard automatically creates managed servers in the domain to host the Fusion Middleware system components. Oracle recommends that you use the default configuration settings for these managed servers. If you modify the default configuration settings, then you will have to perform some manual configuration steps before the Fusion Middleware environment can be started.

3.1.2 Shutting Down Running Managed Servers

Before you start the Configuration Wizard, you must shut down any managed servers that are currently running. If you do not, validation of your managed servers will fail due to port number conflicts from the managed servers that are currently running.

For more information, see "Starting and Stopping Oracle Fusion Middleware" in Oracle Fusion Middleware Administrator's Guide.

3.1.3 Running the Configuration Wizard with an Oracle RAC Database

If you are running the Configuration Wizard with a backend Oracle RAC database, Oralce recommends that you keep all the RAC instances configured for the service to be up and running. This will ensure that JDBC validation checks are reliable and minimize the possibility of accidental misconfiguration.

3.1.4 Starting the Oracle Fusion Middleware Configuration Wizard

The Configuration Wizard is located in the SOA_ORACLE_HOME/common/bin (on UNIX operating systems) or SOA_ORACLE_HOME\common\bin (on Windows operating systems) directory. Go to this directory, then run the config.sh (on UNIX operating systems) or config.cmd (on Windows operating systems) script to start the Configuration Wizard:

On UNIX operating systems:

./config.sh

On Windows operating systems:

config.cmd

If this is a new installation and you need to create a new WebLogic domain, follow the instructions in Section 3.1.6, "Creating a New Domain". You can also run the Configuration Wizard to extend an existing WebLogic domain, as described in Section 3.1.7, "Extending an Existing Domain".

If you are using a 32-bit operating system, Oracle JRockit SDK is installed as part of the Oracle WebLogic installation (see Section 2.1.4, "Install Oracle WebLogic Server and Create the Middleware Home"). This is the JDK that the Configuration Wizard will use by default. If you want to invoke the Configuration Wizard with the Sun JDK, do the following prior to starting the Configuration Wizard:

  1. Set the JAVA_HOME environment variable to the location of the Sun JDK. For example, you can set it to the Sun JDK that was installed with Oracle WebLogic Server in the MW_HOME/jdk160_14_R27.6.4-18 (on UNIX operating systems) or MW_HOME\jdk160_14_R27.6.4-18 (on Windows operating systems) directory.

  2. Set the JAVA_VENDOR environment variable to "Sun."

3.1.5 Configuration Log Files

To create a log file of your configuration session, start the Configuration Wizard with the -log option, as shown below:

On UNIX operating systems:

./config.sh -log=log_filename

On Windows operating systems:

config.cmd -log=log_filename

If you specify an absolute path with your log_filename then your log file will be created there. If you only specify a file name with no path, then the log files are created in the SOA_ORACLE_HOME/common/bin (on UNIX operating systems) or SOA_ORACLE_HOME\common\bin (on Windows operating systems) directory.

3.1.6 Creating a New Domain

Follow the instructions in Table 3-1 to create a new WebLogic domain for your Oracle SOA components.

Note:

For more information about WebLogic Server domains, refer to "WebLogic Server Domain" in Oracle Fusion Middleware Installation Planning Guide.

If you need additional help with any of the configuration screens, refer to Appendix B, "Oracle SOA Suite Configuration Screens" or click Help at the bottom of each screen to access the online help for that screen.

Table 3-1 Configuration Flow for Creating a New Domain

No. Screen Description and Action Required

1

Welcome Screen

Select Create a new WebLogic Domain.

Click Next to continue.

2

Select Domain Source Screen

Select products you want to create in your domain.

Click Next to continue.

3

Specify Domain Name and Location Screen

Specify the name and location for the new domain.

Click Next to continue.

4

Configure Administrator Username and Password Screen

Specify a user and password for the Administrator role.

Click Next to continue.

5

Configure Server Start Mode and JDK Screen

Select the WebLogic domain startup mode and the JDK to be used for the domain.

Click Next to continue.

6

Configure JDBC Component Schema Screen

Configure the schema owner and password for each component schema listed on this screen. Changes to any of the fields on this screen are applied to all selected component schema in the table.

For example, if all of your schemas reside on the same database, select all of the schemas in the table, then specify the appropriate database values for the schemas (DBMS/Service, Host Name, and Port).

If, for example, you have a different password for each schema, then you must select each schema individually and specify the password for the selected schema only.

Click Next to continue.

7

Test Component Schema Screen

Test and verify the connections to your component schema.

Click Next to continue.

8

Select Optional Configuration Screen

Select the category or categories for which you want to make additional configuration changes:

If you choose not to select anything on this screen, skip to the Configuration Summary Screen.

Click Next to continue.

9

Configuration Summary Screen

Review the contents of your domain.

Click Create to continue.

10

Creating Domain Screen

Click Done when finished.


3.1.7 Extending an Existing Domain

While creating your SOA domain, if you chose not to configure all of the components in Oracle SOA Suite, you can add these components at a later date by extending your domain. If this is a first time installation or you do not want to add more components, you can skip this section and move to the next section.

Note:

Before proceeding, make sure that schemas exist in your database for the components you are configuring when you extend the domain. For example, if you are planning to extend the domain and configure Oracle BAM, then make sure the required schemas for Oracle BAM (MDS, ORASDPM, and ORABAM) exist in your database before you continue.

Follow the instructions in Table 3-2 to extend an existing domain.

Table 3-2 Configuration Flow for Extending an Existing Domain

No. Screen Description and Action Required

1

Welcome Screen

Select Extend an existing WebLogic Domain.

Click Next to continue.

2

Select a WebLogic Domain Directory Screen

Select the WebLogic Domain directory to which you want to add your applications and services. The domain name and location were specified on the Specify Domain Name and Location Screen when you created the domain.

Click Next to continue.

3

Select Extension Source Screen

Select the products with which you want to extend this domain.

NOTE - if you select only Oracle JRF WebServices Asynchronous services - 11.1.1.0 (oracle_common) there are special instructions you must follow. See Section 3.1.8, "Extending an Existing Domain with Oracle JRF" for more information.

Click Next to continue.

4

Configure JDBC Component Schema Screen

Configure the schema owner and password for each component schema listed on this screen. Changes to any of the fields on this screen are applied to all selected component schema in the table.

For example, if all of your schemas reside on the same database, select all of the schemas in the table, then specify the appropriate database values for the schemas (DBMS/Service, Host Name, and Port).

If, for example, you have a different password for each schema, then you must select each schema individually and specify the password for the selected schema only.

Click Next to continue.

5

Test Component Schema Screen

Verify the connection to your component schemas.

Click Next to continue.

6

Select Optional Configuration Screen

Select the category or categories for which you want to make additional configuration changes:

If you choose not to select anything on this screen, skip to the Configuration Summary Screen.

Click Next to continue.

15

Configuration Summary Screen

Review the contents of your domain.

Click Extend to continue.

16

Creating Domain Screen

Click Done when finished.


3.1.8 Extending an Existing Domain with Oracle JRF

3.1.9 Configuration Wizard Optional Configuration Screens

The Select Optional Configuration Screen gives you the following advanced configuration options:

3.1.9.1 Administration Server Options

If you select Administration Server on the Select Optional Configuration Screen, you will see the Configure Administration Server Screen. This screen enables you to customize your Administration Server settings, such as the server name, port number, and secure connection settings.

3.1.9.2 Managed Server, Clusters and Machines Options

If you select Managed Servers, Clusters, and Machines on the Select Optional Configuration Screen, you will see the screens described in Table 3-3:

Table 3-3 Managed Servers, Clusters, and Machines Advanced Settings Screens

No. Screen Description and Action Required

1

Configure Managed Servers Screen

Add new managed servers, or edit and delete existing managed servers.

Click Next to continue.

2

Configure Clusters Screen

Create clusters if you are installing in a high availability environment. For more information, refer to Oracle Fusion Middleware High Availability Guide.

Click Next to continue.

3

Assign Servers to Clusters Screen

Assign your managed servers to a cluster in your domain.

Click Next to continue.

4

Create HTTP Proxy Applications Screen

Select whether or not you want a configure an HTTP proxy server for your cluster.

Click Next to continue.

5

Configure Machines Screen

Configure the machines that will host the managed servers.

Click Next to continue.

6

Assign Servers to Machines Screen

Assign each managed server to the machine on which it runs.

Click Next to continue.


3.1.9.3 Deployments and Services Options

If you select Deployments and Services on the Select Optional Configuration Screen, you will see the screens described in Table 3-4.

The Configuration Wizard automatically takes care of all necessary deployment and services targeting. You should not have to change anything on these screens unless specifically directed to do so. Typically, this will happen in an enterprise deployment configuration. For more information, see Oracle Fusion Middleware Enterprise Deployment Guide for Oracle SOA Suite.

Table 3-4 Deployments and Services Advanced Settings Screens

No. Screen Description and Action Required

1

Target Deployments to Servers or Clusters Screen

Target your deployments to servers or clusters.

Click Next to continue.

2

Target Services to Servers or Clusters Screen

Target your services to servers or clusters.

Click Next to continue.


3.1.9.4 JMS File Store Options

If you select JMS File Store on the Select Optional Configuration Screen, you will see the Configure JMS File Stores Screen. This screen enables you to configure the names, location, and write policy for your file stores.

3.1.9.5 RDBMS Security Store Options

If you select RDBMS Security Store on the Select Optional Configuration Screen, you will see the Configure RDBMS Security Store Database Screen. This screen enables you to configure an external relational database management system (RDBMS) as a data store for various security providers.

3.2 Manual Configuration for Oracle BAM

Depending on your configuration options and environment, Oracle BAM may require some custom configuration steps, as described in this section.

3.2.1 Configuring Oracle BAM with Custom Port Numbers

The default port number of the Oracle BAM managed server (bam_server1) is 9001. If, during configuration, you changed this port number or specified a listen address using the WebLogic Configuration Wizard, you must make the following changes:

  1. Manually change the port number from 9001 to the new port number in the SOA_ORACLE_HOME/bam/config/BAMICommandConfig.xml (on UNIX operating systems) or SOA_ORACLE_HOME\bam\config\BAMICommandConfig.xml (on Windows operating systems) file. The parameter that needs to be changed is shown below:

    <ADCServerPort>9001</ADCServerPort>
    
  2. Oracle BAM single-instance web application configuration information is maintained in the MW_HOME/user_projects/domains/domain_name/servers/BAM_server_name/tmp/_WL_user/oracle-bam_11.1.1/yhryfp/APP-INF/classes/config (on UNIX operating systems) or MW_HOME\user_projects\domains\domain_name\servers\BAM_server_name\tmp\_WL_user\oracle-bam_11.1.1\yhryfp\APP-INF\classes\config (on Windows operating systems) directory. The properties in these files can be modified by using the Mbeans exposed in the Oracle Enterprise Manager Fusion Middleware Control. The properties exposed through MBeans are specific to each server:

    Note:

    The folder name under oracle-bam_11.1.1 is randomly generated (in this case, it is yhryfp). When you are looking for this directory on your system, be aware that the name of the directory on your system may not match the name of the directory shown in the documentation.
    1. Changes in BAMCommonConfig.xml:

      The <ApplicationURL> parameter should contain the new URL.

    2. Changes in BAMServerConfig.xml:

      <ADCServerName>localhost</ADCServerName>
      <ADCServerPort>9001</ADCServerPort>
      
    3. Changes in BAMWebConfig.xml:

      <ServerName>localhost</ServerName>
      <ServerPort>9001</ServerPort>
      

3.2.2 Deploying Oracle SOA and Oracle BAM on Different Servers

Oracle SOA and Oracle BAM are configured in their own managed servers by default (soa_server1 for Oracle SOA and bam_server1 for Oracle BAM). If you choose to configure Oracle SOA on AdminServer by deleting soa_server1 in the Configuration Wizard, and if Oracle BAM is also selected for configuration, then Oracle BAM also needs to be targeted on AdminServer by deleting bam_server1 in the Configuration Wizard.

3.2.3 Configuring Oracle SOA and Oracle BAM Against an External LDAP Server

If you are configuring Oracle SOA and Oracle BAM against an external LDAP server, make sure the following are present in the external LDAP server:

  • OracleSystemUser (a user in the external LDAP server)

  • OracleSystemGroup (a group in the external LDAP server)

  • OracleSystemUser must be a part of the OracleSystemGroup

3.3 Applying Java Required Files (JRF)

Java Required Files (JRF) consists of those components not included in the Oracle WebLogic Server installation and that provide common functionality for Oracle business applications and application frameworks.

JRF consists of a number of independently developed libraries and applications that are deployed into a common location (the Oracle Common Home or oracle_common directory). The components that are considered part of Java Required Files include: Oracle Application Development Framework, Oracle Fusion Middleware Audit Framework, Dynamic Monitoring Service, Infrastructure Security, Java Object Cache, Oracle Platform Security Services, logging, MDS, Oracle Web Services, and Oracle Web Services Manager.

If you are creating or extending a domain and JRF is the only component seleted on the Select Domain Source Screen or Select Extension Source Screen, you must manually apply JRF to a Managed Server or cluster. To do so:

  1. Start the Configuration Wizard (see Section 3.1.4, "Starting the Oracle Fusion Middleware Configuration Wizard").

  2. When you reach the Select Optional Configuration Screen, select Deployments and Services.

  3. On the Target Services to Servers or Clusters Screen, target the mds-owsm data source to the Administration Server (by default, it is not targeted to any server).

  4. Finish the domian creation or extension.

3.4 Starting the Servers

To get your deployments up and running, you must start the Administration Server and various Managed Servers:

  1. To start the Administration Server, run the startWebLogic.sh (on UNIX operating systems) or startWebLogic.cmd (on Windows operating systems) script in the directory where you created your new domain.

    On UNIX systems:

    MW_HOME/user_projects/domains/domain_name/startWebLogic.sh
    

    On Windows systems:

    MW_HOME\user_projects\domains\domain_name\startWebLogic.cmd
    

    You entered the domain name and location on the Specify Domain Name and Location Screen in the configuration wizard.

  2. To start the Managed Servers, run the startManagedWebLogic.sh (on UNIX operating systems) or startManagedWebLogic.cmd (on Windows operating systems) script in the bin directory inside the directory where you created your domain. These managed servers must be started from the command line.

    This command also requires that you specify a server name. The servers that need to be started are:

    • soa_server1 (Oracle SOA Server)

    • bam_server1 (Oracle BAM Server)

    For example, to start Oracle SOA Server on a UNIX system:

    MW_HOME/user_projects/domains/domain_name/bin/startManagedWebLogic.sh soa_server1
    

    On Windows systems:

    MW_HOME\user_projects\domains\domain_name\bin\startManagedWebLogic.cmd soa_server1 
    

    Before the managed server is started, you will be prompted for the WebLogic Server user name and password. These were provided on the Configure Administrator Username and Password Screen in the Configuration Wizard.

    Note:

    If this is the first time that both Oracle SOA Server and Oracle BAM Server are being started after installation and configuration, you must make sure that your startup of Oracle SOA Server is complete before starting Oracle BAM Server.

    If your Administration Server is using a non-default port, or resides on a different host than your managed servers (in a distributed environment), you must also specify the URL to access your Administration Server.

    On UNIX systems:

    MW_HOME/user_projects/domains/domain_name/bin/startManagedWebLogic.sh soa_server1 http://host:admin_server_port
    

    On Windows systems:

    MW_HOME\user_projects\domains\domain_name\bin\startManagedWebLogic.cmd soa_server1 http://host:admin_server_port
    

    Instead of being prompted for the Administration Server user name and password, you can also specify them directly from the command lime.

    On UNIX systems:

    MW_HOME/user_projects/domains/domain_name/bin/startManagedWebLogic.sh soa_server1 http://host:admin_server_port -Dweblogic.management.username=user_name -Dweblogic.management.password=password
    

    On Windows systems:

    MW_HOME\user_projects\domains\domain_name\bin\startManagedWebLogic.cmd soa_server1 http://host:admin_server_port -Dweblogic.management.username=user_name -Dweblogic.management.password=password
    

If you do not know the names of the managed servers that need to be started, you can view the contents of the following file on UNIX systems:

MW_HOME/user_projects/domains/domain_name/startManagedWebLogic_readme.txt

On Windows systems:

MW_HOME\user_projects\domains\domain_name\startManagedWebLogic_readme.txt

Or, you can access the Administration Server console at the following URL:

http://host:admin_server_port/console

Supply the user name and password that you specified on the Configure Administrator Username and Password Screen of the Configuration Wizard. Then, navigate to Environment > Servers to see the names of your managed servers.

3.5 Creating an Administration Server Only Domain

When the Administration Server is started, the contents of the soa-infra directory under DOMAIN_HOME/config (on UNIX systems) or DOMAIN_HOME\config (on Windows systems) are overwritten by the Administration Server. However, since SOA configuration parameters are updated only on managed servers and on a per-server basis, all updates to the SOA configuration are lost when the managed servers are restarted if the system hosting the Administration Server does not have an updated copy.

The SOA_ORACLE_HOME/bin/ant-soa-util.xml (on UNIX operating systems) or SOA_ORACLE_HOME\bin\ant-soa-util.xml (on Windows operating systems) script can be used to resolve this issue. The script does the following:

Note:

The script must be run before you try to start the Administration Server or any of the Managed Servers.
  • Moves the config/soa-infra (on UNIX operating systems) or config\soa-infra (on Windows operating systems) to the DOMAIN_HOME/soa_backup/config/soa-infra (on UNIX operating systems) or DOMAIN_HOME\soa_backup\config\soa-infra (on Windows operating systems) directory.

  • Replaces the startManagedWebLogic.sh (on UNIX operating systems) or startManagedWebLogic.cmd (on Windows operating systems) scripts with versions that prevent the Managed Servers from starting.

3.6 Starting Node Manager

Node Manager is a Java utility that runs as separate process from Oracle WebLogic Server and allows you to perform common operations for a Managed Server, regardless of its location with respect to its Administration Server. While use of Node Manager is optional, it provides valuable benefits if your WebLogic Server environment hosts applications with high-availability requirements.

If you run Node Manager on a system that hosts Managed Servers, you can start and stop the Managed Servers remotely using the Administration Console or the command line. Node Manager can also automatically restart a Managed Server after an unexpected failure.

For more information about Node Manager, refer to Oracle Fusion Middleware Node Manager Administrator's Guide for Oracle WebLogic Server.

3.7 Verifying the Installation

To verify the installation, start your browser and enter the following URLs:

  • To access the Administration Server console:

    http://host:admin_server_port/console
    
  • If you configured your Administration Server to accept SSL connection, use the following URL to access the Administration Server console in secure mode:

    https://host:secure_admin_server_port/console
    
  • To access Enterprise Manager:

    http://host:admin_server_port/em