Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite
11g Release 1 (11.1.1.6.1)

Part Number E10226-12
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

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

23 Configuring Oracle Business Activity Monitoring

This chapter describes how to configure basic properties of Oracle Business Activity Monitoring (Oracle BAM) Server components and Oracle BAM web applications using Oracle Enterprise Manager Fusion Middleware Control, advanced properties using System MBean Browser, and Oracle BAM Adapter properties and connection factories using Oracle WebLogic Server Administration Console. It also explains how to configure logging and log levels, security, distribution lists for alerts and reports, and Oracle User Messaging Service to send email notifications to Oracle BAM users.

This chapter includes the following topics:

23.1 Introduction to Configuring Oracle BAM

Oracle BAM Server is the collection of the components Oracle BAM Active Data Cache (Oracle BAM ADC), Oracle BAM Report Cache, Oracle BAM Enterprise Message Sources (EMS), and Oracle BAM Event Engine.

The Oracle BAM web applications are a collection of thin clients (Active Studio, Architect, Administrator, and Active Viewer) and Oracle BAM Report Server.

For more information about each of the subcomponents of Oracle BAM Server and Oracle BAM web applications, see the Oracle Fusion Middleware User's Guide for Oracle Business Activity Monitoring.

At runtime, the Oracle BAM application checks the configuration property values. If they are set to DEFAULT, Oracle BAM dynamically determines the values of all the parameters by querying the JRF API, that in turn queries the MBean Server. This feature enables you to set up Oracle BAM on any port number and work out of the box without any configuration changes. By default all of the parameters are set to DEFAULT.

If the administrator provides the configuration values during initial postinstallation configuration then Oracle BAM honors them as the values going forward. If for some reason the parameters are not present, Oracle BAM first looks for host and port details in JRF. If Oracle BAM is not able to access JRF, hard-coded default values are provided from the code.

The most commonly used Oracle BAM Server and web applications properties are configured in Oracle Enterprise Manager Fusion Middleware Control. For more information, see Section 23.3, "Configuring Oracle BAM Server Basic Properties" and Section 23.2, "Configuring Oracle BAM Web Basic Properties".

Security configuration is discussed in Section 23.9, "Configuring Security", and adding and managing Oracle BAM roles (permissions) and user accounts is discussed in Section 25.3, "Managing Oracle BAM Users."

Oracle User Messaging Service (UMS) must be configured so that alerts are delivered to Oracle BAM users. For more information, see Section 23.5, "Configuring Oracle User Messaging Service".

When using Oracle BAM in a SOA composite application, the Oracle BAM Adapter configuration must be completed. For more information, see Section 23.7, "Configuring Oracle BAM Adapter".

Advanced properties are located in configuration files that must be edited using the System MBean Browser. For more information, see Section 23.10, "Configuring Advanced Properties". Also, see Section 23.11, "Oracle BAM Configuration Property Reference" for a listing of all properties available for Oracle BAM configuration.

Oracle BAM distribution lists are used to send alerts and reports to multiple Oracle BAM users, rather than having to specify several individual recipients. Distribution lists are configured in the Oracle BAM Administrator application. For more information, see Section 23.6, "Configuring Oracle BAM Distribution Lists".

For performance tuning information for Oracle BAM, see the Oracle Fusion Middleware Performance and Tuning Guide.

For Oracle BAM high availability configuration information, see the Oracle Fusion Middleware High Availability Guide.

23.2 Configuring Oracle BAM Web Basic Properties

Some basic Oracle BAM web applications properties are configured using Oracle Enterprise Manager Fusion Middleware Control.

Oracle BAM web applications must be restarted when changes are made to any Oracle BAM properties. For information about restarting Oracle BAM, see Section 25.2, "Managing Oracle BAM Availability".

The following topics describe how to configure each property:

For information about configuring advanced properties, see Section 23.10, "Configuring Advanced Properties" and Section 23.11, "Oracle BAM Configuration Property Reference."

23.2.1 Configuring Oracle BAM Web Applications Properties

The Oracle BAM web applications properties are configured in the BAM Web Properties page in Fusion Middleware Control.

To configure Oracle BAM web applications properties:

  1. Go to the BAM Web Properties page in Fusion Middleware Control by selecting the OracleBamWeb node in the BAM folder.

    Description of bam_em_nav.gif follows
    Description of the illustration bam_em_nav.gif

  2. Choose BAM Web Properties from the BAM Web menu.

    Description of bam_config_web_menu.gif follows
    Description of the illustration bam_config_web_menu.gif

    The BAM Web Properties page opens.

    Description of bam_config_web.gif follows
    Description of the illustration bam_config_web.gif

  3. Enter the appropriate values in each of the fields provided.

    See the following sections for information about configuring each of the properties:

  4. Click Apply.

    You must restart Oracle BAM after any property changes.

23.2.2 Configuring the Application URL

The Application URL property value must be updated from localhost to the actual hostname to generate the correct URLs for reports and alerts.

The Application URL property is configured in both the Oracle BAM web applications properties page and the Oracle BAM Server properties page. In Oracle BAM web applications page, the URL is used to generate the full URL for reports and alerts.

This property is common to both Oracle BAM web applications and Oracle BAM Server. If it is configured on one page, the same value appears on the other configuration page.

23.2.3 Configuring the Report Loading Indicator

The Report Loading Indicator property specifies whether the report loading indicator is enabled or disabled by default when viewing reports in Oracle BAM Active Studio and Oracle BAM Active Viewer.

With this property enabled, the report loading indicator is shown by default when a report is viewed; however, individual users can choose to disable the report loading indicator in their user preferences configuration. For more information, see the Oracle Fusion Middleware User's Guide for Oracle Business Activity Monitoring.

23.2.4 Configuring the Server Name

The Server Name property provides the hostname of Oracle BAM Server. Oracle BAM web applications are separate applications that require the location of Oracle BAM Server to get data from the Active Data Cache and Report Cache for the Oracle BAM Report Server.

23.3 Configuring Oracle BAM Server Basic Properties

Some basic Oracle BAM Server properties are configured using Oracle Enterprise Manager Fusion Middleware Control.

Oracle BAM Server must be restarted after any changes to Oracle BAM properties. For information about restarting Oracle BAM, see Section 25.2, "Managing Oracle BAM Availability".

The following topics describe how to configure each property:

For information about configuring advanced properties, see Section 23.10, "Configuring Advanced Properties" and Section 23.11, "Oracle BAM Configuration Property Reference."

23.3.1 Configuring Oracle BAM Server Properties

Oracle BAM Server properties are configured in the BAM Server Properties page in Oracle Enterprise Manager Fusion Middleware Control.

To configure Oracle BAM Server properties:

  1. Go to the BAM Server Properties page by selecting the OracleBamServer node in Fusion Middleware Control BAM folder.

    Description of bam_em_nav_server.gif follows
    Description of the illustration bam_em_nav_server.gif

  2. Choose BAM Server Properties from the BAM Server menu.

    Description of bam_config_server_menu.gif follows
    Description of the illustration bam_config_server_menu.gif

    The BAM Server Properties page opens.

    Description of bam_config_server.gif follows
    Description of the illustration bam_config_server.gif

  3. Enter the appropriate values in each of the fields provided.

    See the following sections for information about configuring each of the properties:

  4. Click Apply.

    You must restart the Oracle BAM application after any property changes.

23.3.2 Configuring the Data Source JNDI

The Data Source JNDI property specifies the database used by Oracle BAM ADC. Enter the data source JNDI name created for Oracle BAM ADC. For general information about configuring data sources see Oracle Fusion Middleware Configuring and Managing JDBC Data Sources for Oracle WebLogic Server

23.3.3 Configuring the Application URL

The Application URL property is used only by Oracle BAM web applications. This configuration property is no longer used by Oracle BAM Server. For information about configuring this property for Oracle BAM web applications, see Section 23.2.2, "Configuring the Application URL".

23.3.4 Configuring Viewset Sharing

The Viewset Sharing property enables view set sharing when possible. A view set is an object that represents a query to a given Oracle BAM data object. A view set can include fields (which can be columns from the data object or lookups from other data objects), aggregates, groups, or calculated fields. A view set can also be sorted, filtered, and row-level security is applied implicitly to it.

Typically, a particular view set can be shared with other users if they are trying to access the same Oracle BAM dashboard, if the view sets are not dissimilar due to factors such as row-level security, prompts or parameters used in filters, and so on.

A snapshot is a query result set that can be created by the view set. Snapshots can be produced from a view set after it is opened. Because snapshot generation is so performance-intensive, view set sharing allows Oracle BAM Server to take only one snapshot of a given view to share across multiple users of the same dashboard.

Sharing view sets between users of the same views improves performance, but requires that new users wait for view sets to be synchronized as each new user begins sharing the view set.

The first user who opens an Oracle BAM dashboard receives a new snapshot (which is cached) and immediately receives active data in real time. Changes for active data, called change lists, are cached.

When additional users open the same dashboard, they receive the cached snapshot that was generated for the first user, and they receive cached change lists (more rapidly than the first user) while the Synchronizing Active Data message is displayed.

By default, up to 50 change lists are cached, so if multiple users open a dashboard, secondary users must wait for up to 50 change lists to be sent to the dashboard before they begin receiving real-time active data.

The ElementsCountLimit property can be set to allow fewer change lists to be cached. For information about configuring advanced properties, see Section 23.11, "Oracle BAM Configuration Property Reference".

23.3.5 Configuring the Report Cache Persistence Manager

The Report Cache Persistence Manager property specifies the persistence location (file based or memory based). Select the appropriate persistence location for your Oracle BAM Report Cache.

23.3.6 Configuring Oracle Data Integrator Integration Properties

The Oracle Data Integrator integration properties specify values for integrating Oracle Data Integrator with Oracle BAM Server.

Enter the appropriate values for the following properties:

ODI User: The user that executes the scenarios in Oracle Data Integrator.

ODI Password: The encoded Oracle Data Integrator password.

ODI Work Repository Name: The name of the Oracle Data Integrator work repository database.

ODI Agent Host: The IP address or hostname of the server where the Oracle Data Integrator agent is running.

ODI Agent Port: The Transmission Control Protocol (TCP) port on which the Oracle Data Integrator agent is listening.

23.3.7 Configuring the Outbound Email Account

This section explains how to configure the email address that appears in the From header of email notifications sent by the Oracle BAM Event Engine.

The Outbound Email Account property on Oracle BAM Server must point to a dedicated email account for delivering Oracle BAM alert notification email messages and Oracle BAM report link email messages.

If an Oracle BAM alert configured with a secondary action to send an email notification fails on the primary action, this property must be configured with an email address that Oracle UMS can access at runtime. Creating a dedicated email account for this purpose is recommended.

Note:

Administrators should not use personal email accounts to test alerts, because Oracle UMS may delete email notifications in the mail box and continue deleting messages as they arrive.

To complete the configuration, you must configure the Oracle UMS usermessagingdriver-email driver. For details, see Section 23.5, "Configuring Oracle User Messaging Service".

Oracle BAM Event Engine has another configuration property, TimeoutPeriodToGetFailedStatusesInMins, which is the time interval for which the Event Engine waits after delivering an email notification, to see if it receives any failure notification from Oracle UMS. The default value for this property is 10 minutes. If a failure notification does not arrive within this time, the Event Engine assumes that email delivery was successful, and the failover action is discarded. Failure notifications arriving after this time are ignored by the Event Engine. For information about configuring TimeoutPeriodToGetFailedStatusesInMins, see Section 23.11, "Oracle BAM Configuration Property Reference".

23.4 Configuring the Logger

Use the Log Configuration page to configure logging levels. For information about viewing the logs, see Section 24.6, "Monitoring Oracle BAM Logs." Also, see Section 3.4, "Configuring Log Files" and the Oracle Fusion Middleware Administrator's Guide for general information about logging and log levels.

To open the Log Configuration page, right-click the OracleBamServer node or OracleBamWeb node in the navigation tree and choose Logs > Log Configuration.

Description of bam_log_menu_config.gif follows
Description of the illustration bam_log_menu_config.gif

For each logger, select the desired notification level.

Description of bam_log_config.gif follows
Description of the illustration bam_log_config.gif

23.5 Configuring Oracle User Messaging Service

Oracle User Messaging Service (UMS) must be configured properly in Fusion Middleware Control to send email notifications when alerts are issued.

The UMS email driver monitors the outbound email account configured for Oracle BAM Server for any delivery failures, including rejected emails. Email delivery failure notifications are asynchronous, that is, there is no definite time within which email rejection notification is received.

To configure the outbound email account see Section 23.3.7, "Configuring the Outbound Email Account."

To configure the service:

  1. In Fusion Middleware Control, go to the usermessagingdriver-email (User Messaging Email Driver) page by expanding the User Messaging Service folder, then selecting the usermessagingdriver-email (bam_server1) node.

    Description of bam_ums_nav.gif follows
    Description of the illustration bam_ums_nav.gif

  2. From the User Messaging Email Driver shortcut menu, choose Email Driver Properties.

    Description of bam_ums_menu.gif follows
    Description of the illustration bam_ums_menu.gif

  3. In the Driver-Specific Configuration section, the properties IncomingMailServer, IncomingUserIDs, and IncomingUserPasswords must be provided with the Internet Message Access Protocol (IMAP) server name (Oracle UMS also supports POP3), email account name, and password to access this email account.

    Description of bam_ums_driver.gif follows
    Description of the illustration bam_ums_driver.gif

    For more information, see Section 26.4, "Configuring User Messaging Service Drivers". Table 26-7, "Custom Email Properties" contains specific information about the properties you must configure.

  4. Click Apply to save the changes.

  5. Enter the email account in the Outbound Email Account property in the Oracle BAM Server configuration. For details, see Section 23.3.7, "Configuring the Outbound Email Account".

23.6 Configuring Oracle BAM Distribution Lists

Oracle BAM distribution lists are used to send alerts and reports to multiple Oracle BAM users, rather than having to specify several individual recipients. Oracle BAM distribution lists are configured using the Oracle BAM Administrator application.

To configure distribution lists:

  1. Go to the Oracle BAM start page, log in, and select Administrator.

    Description of bam_start_page.gif follows
    Description of the illustration bam_start_page.gif

    The Oracle BAM start page is located at:

    http://host_name:port_number/OracleBAM/
    
  2. Select Distribution List management from the list.

    Description of bam_admin_menu_distlist.gif follows
    Description of the illustration bam_admin_menu_distlist.gif

  3. Click Create.

  4. Enter a unique Distribution List Name and click Create.

    Description of bam_dist_list.gif follows
    Description of the illustration bam_dist_list.gif

  5. Click Continue to save the distribution list name.

    Description of bam_dist_list_cont.gif follows
    Description of the illustration bam_dist_list_cont.gif

  6. Select the new distribution list that is displayed in the Distribution Lists list on the left side of the page, and click Edit.

    Description of bam_dist_list_edit.gif follows
    Description of the illustration bam_dist_list_edit.gif

  7. Select user accounts to add to the distribution list from the Select Members list.

    You can select multiple users by clicking on several user names. The highlighted user names are added to the distribution list.

    Description of bam_dist_list_add_mem.gif follows
    Description of the illustration bam_dist_list_add_mem.gif

  8. Click Save.

    The users are added to the distribution list.

23.7 Configuring Oracle BAM Adapter

Oracle BAM Adapter properties, including the adapter batching properties, are configured in Oracle WebLogic Server Administration Console. For details, see Section 23.7.1, "Configuring Oracle BAM Adapter Properties".

Some issues that must be considered when Oracle BAM Adapter (including Oracle BAM sensor actions in a BPEL process) is used in a SOA composite application are configuring connection factories, trusted domains, and credential mapping.

Before deploying applications that use Oracle BAM Adapter, a connection factory to Oracle BAM Server must be configured. You can configure both Remote Method Invocation (RMI) and Simple Object Access Protocol (SOAP) connection factories. For details, see Section 23.7.2, "Configuring Oracle BAM Connection Factories".

When using the RMI connection between a SOA composite application and Oracle BAM Server, that is when they are deployed in different domains, trusted domain configuration must be done in Oracle WebLogic Server Administration Console. For more information, see Section 23.7.3, "Configuring Trusted Domains".

If the Oracle BAM Adapter is using credentials rather than a plain text user name and password, in order for Oracle BAM Adapter (including Oracle BAM sensor actions in a BPEL process) to connect to Oracle BAM Server, the credentials must also be established and mapped. For more information, see Section 23.7.4, "Configuring Credential Mapping".

The oracle.bam.adapter logger should be configured to troubleshoot issues with Oracle BAM Adapter. For information about logger configuration, see Section 23.4, "Configuring the Logger".

Notes:

Use plain text user names and passwords only in nonproduction mode. Do not mix using credential mapping and plain text user information; apply one at a time to avoid confusion.

Because Oracle BAM and Oracle SOA Infrastructure use different identity stores, an Oracle BAM user must be configured in the service infrastructure identity store if there is not a common service infrastructure user and Oracle BAM user.

Oracle BAM Adapter does not support transactional behavior. Even though there is a section in Oracle WebLogic Server Administration Console for configuring transaction support, Oracle BAM Adapter must remain at the No Transaction level.

23.7.1 Configuring Oracle BAM Adapter Properties

Oracle BAM Adapter properties are configured in Oracle WebLogic Server Administration Console.

To configure Oracle BAM Adapter properties:

  1. Go to the Oracle WebLogic Server Administration Console
    (http://host_name:port_number/console), and log on.

  2. In the Domain Structure menu, select Deployments.

    Description of bam_wls_domstructmenu.gif follows
    Description of the illustration bam_wls_domstructmenu.gif

  3. In the Deployments summary table, search for OracleBamAdapter and click it.

    Description of bam_wls_adapterdeploy.gif follows
    Description of the illustration bam_wls_adapterdeploy.gif

  4. In the Settings for OracleBamAdapter page, click the Configuration tab, and then the Properties tab in the second row.

    Description of bam_wls_adapprop1.gif follows
    Description of the illustration bam_wls_adapprop1.gif

  5. Enter the new values, select the checkboxes for each updated value, and click Save.

    For information about each property, see Table 23-1, "Oracle BAM Adapter Configuration Properties".

    Also, see Section 23.8, "Configuring Oracle BAM Batching Properties" for general information about configuring batching properties.

    Note:

    To commit these changes to the deployment plan you must click Activate Changes in the Change Center. If the Activate Changes button does not appear, see the "Oracle BAM Issues With Oracle WebLogic Server Administrative Console" section in the Oracle Fusion Middleware User's Guide for Oracle Business Activity Monitoring for a workaround.

  6. Restart the SOA domain server.

    It must be restarted because that is where the Oracle BAM Adapter is deployed.

Table 23-1 lists the Oracle BAM Adapter configuration properties.

Table 23-1 Oracle BAM Adapter Configuration Properties

RMI Property SOAP Property Default Description

Batch_Lower_Limit

SOAP_Batch_Lower_Limit

1000

The minimum amount of elements in a batch before it is sent out.

Batch_Upper_Limit

SOAP_Batch_Upper_Limit

5000

The maximum amount of elements in a batch before it is sent out.

Batch_Timeout

SOAP_Batch_Timeout

5000

The timeout in milliseconds after which the batch is sent out even if it is not full.

Block_On_Batch_Full

SOAP_Block_On_Batch_Full

false

The default setting for block on batch full, which indicates whether batching operations should block when the batch is full. If true then batching calls block until room is freed up in the batch for the operation. If false then BatchIsFullException exception is thrown.

Number_Batches

SOAP_Number_Batches

10

The limit of the number of pending calls allowed.


23.7.1.1 Configuring the Adapter to Retry Sending Messages

If messages from BPEL process monitors are published when Oracle BAM Server is unavailable, the messages are not persisted and therefore are not published to the Oracle BAM data objects when Oracle BAM Server comes back online.

You can change this behavior by setting the Oracle BAM Adapter property
Block_On_Batch_Full to true in Oracle BAM Adapter configuration as described in Section 23.7.1, "Configuring Oracle BAM Adapter Properties."

For more information about BPEL process monitors see the Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.

23.7.2 Configuring Oracle BAM Connection Factories

Some configuration in the Oracle WebLogic Server Administration Console is necessary before using Oracle BAM Adapter.

Use the Oracle WebLogic Server Administration Console to configure the Oracle BAM connection factories for connections with Oracle BAM Server.

To configure Oracle BAM connection factories:

  1. Go to the Oracle WebLogic Server Administration Console
    (http://host_name:port_number/console), and log on.

  2. In the Domain Structure menu, select Deployments.

    Description of bam_wls_domstructmenu.gif follows
    Description of the illustration bam_wls_domstructmenu.gif

  3. In the Deployments summary table, search for OracleBamAdapter and click it.

    Description of bam_wls_adapterdeploy.gif follows
    Description of the illustration bam_wls_adapterdeploy.gif

  4. In the Settings for oracle-bam-adapter page, click the Configuration tab, and then the Outbound Connection Pools tab in the second row.

    Description of bam_wls_connpooltabs.gif follows
    Description of the illustration bam_wls_connpooltabs.gif

  5. Configure the connection factory interface that you intend to use in Oracle JDeveloper, by expanding the appropriate Group and Instance target and clicking the Java Naming and Directory Interface (JNDI) name.

    Description of bam_wls_connpoolexpand.gif follows
    Description of the illustration bam_wls_connpoolexpand.gif

    To configure the connection factory for RMI-based calls, click to expand the oracle.bam.adapter.adc.RMIConnectionFactory group and select the JNDI name that the user uses in Oracle JDeveloper. The eis/bam/rmi connection factory is provided out of the box.

    To configure the connection factory for SOAP-based calls, click to expand the oracle.bam.adapter.adc.SOAPConnectionFactory group and select the JNDI name that the user uses in Oracle JDeveloper. The eis/bam/soap connection factory is provided out of the box.

    Description of bam_wls_connpool.gif follows
    Description of the illustration bam_wls_connpool.gif

  6. Configure each of the properties by clicking in the table cells and entering the values.

    Description of bam_wls_connpoolprop.gif follows
    Description of the illustration bam_wls_connpoolprop.gif

    Note:

    Press Enter after entering a value in the table.

    Note:

    The UserName field should contain an Oracle BAM user who is a member of application-level role Administrator or Report Architect. For information about assigning users to Oracle BAM application roles, see Section 25.3.3, "Adding Members to Application Roles" and Section 25.3.4, "Introduction to Oracle BAM Application Roles".

    This configuration creates the connection factory with HTTP. To configure an HTTPS connection factory, see Section 23.7.2.1, "Configuring HTTPS for Oracle BAM Adapter".

    The RMI protocol has different configuration properties. You must provide InstanceName and IsClustered in addition to the standard connection properties.

    Description of bam_wls_connpoolprop_rmi.gif follows
    Description of the illustration bam_wls_connpoolprop_rmi.gif

  7. Select the checkboxes next to the values you have updated and click Save.

    Note:

    To commit these changes to the deployment plan you must click Activate Changes in the Change Center. If the Activate Changes button does not appear, see the "Oracle BAM Issues With Oracle WebLogic Server Administrative Console" section in the Oracle Fusion Middleware User's Guide for Oracle Business Activity Monitoring for a workaround.

23.7.2.1 Configuring HTTPS for Oracle BAM Adapter

To configure HTTPS:

  1. Locate the oracle.bam.adapter.adc.soap.SOAPConnectionFactory connection factory in the Oracle WebLogic Server Administration Console as described in Section 23.7, "Configuring Oracle BAM Adapter".

    Description of bam_wls_connpooltabs.gif follows
    Description of the illustration bam_wls_connpooltabs.gif

  2. Click to expand the oracle.bam.adapter.adc.soap.SOAPConnectionFactory node, select the eis/bam/soap option, and click New.

    Description of bam_wls_connpoolnew_start.gif follows
    Description of the illustration bam_wls_connpoolnew_start.gif

  3. Select the oracle.bam.adapter.adc.soap.SOAPConnectionFactory option and click Next.

    Description of bam_wls_connpoolnew.gif follows
    Description of the illustration bam_wls_connpoolnew.gif

  4. Enter a JNDI name for this connection factory and click Finish.

    Description of bam_wls_connpoolnewjndi.gif follows
    Description of the illustration bam_wls_connpoolnewjndi.gif

  5. Select the eis/bam/https connection pool instance in the Groups and Instances list.

    Description of bam_wls_connpoolnew_https.gif follows
    Description of the illustration bam_wls_connpoolnew_https.gif

  6. Complete the configuration properties as shown in Section 23.7, "Configuring Oracle BAM Adapter," and change the IsHTTPSEnabledWebService value to true.

    Description of bam_wls_connpoolprop_https.gif follows
    Description of the illustration bam_wls_connpoolprop_https.gif

23.7.3 Configuring Trusted Domains

When using the RMI connection between a SOA composite application and Oracle BAM Server, that is when they are deployed in different domains, trusted domain configuration must be done in Oracle WebLogic Server Administration Console.

To configure trusted domains:

  1. Using the Oracle WebLogic Server Administration Console, in both SOA and Oracle BAM Server domains, go to base_domain > Security > General, and expand the Advanced settings.

    Description of bam_wls_trust.gif follows
    Description of the illustration bam_wls_trust.gif

  2. Enter the credential for the Oracle WebLogic Server domain in the Credential and Confirm Credential fields.

    Enter the same credential in both the SOA and Oracle BAM Server domains to establish trust between the domains.

  3. Save and activate the changes, then restart Oracle WebLogic Server.

For more information about trusted domains see "Enabling Global Trust" in Oracle Fusion Middleware Securing Oracle WebLogic Server.

23.7.4 Configuring Credential Mapping

Configure Oracle BAM Adapter to securely store user name and password properties using Oracle WebLogic Server credential mapping functionality.

Note:

Use plain text user names and passwords only in nonproduction mode. Do not mix using credential mapping and plain text user information; apply one at a time to avoid confusion.

To configure credential mapping:

  1. Using the Oracle WebLogic Server Administration Console, go to Deployment > OracleBamAdapter > Security > Credential Mappings.

    Description of bam_wls_credmap_locate.gif follows
    Description of the illustration bam_wls_credmap_locate.gif

  2. Click New and select an outbound connection pool instance for which to create a credential mapping entry, then click Next (By default, Oracle BAM is installed with two connection pools, eis/bam/rmi and eis/bam/soap).

    Description of bam_wls_credmap_select.gif follows
    Description of the illustration bam_wls_credmap_select.gif

    Note:

    Ensure that a separate credential mapping entry for each outbound connection pool is created. If there are any additional outbound connection pools other than the defaults, you must create corresponding credential mappings for them as well.

  3. Select Unauthenticated WLS User, and click Next (Unauthenticated WLS User is similar to an anonymous user).

    Description of bam_wls_credmap_user.gif follows
    Description of the illustration bam_wls_credmap_user.gif

  4. Specify a corresponding user name and password for connecting to Oracle BAM Server, then click Finish to complete the credential mapping.

    Description of bam_wls_credmap_eis.gif follows
    Description of the illustration bam_wls_credmap_eis.gif

  5. Repeat these steps to create the credential mapping for the other Oracle BAM connection pool entries.

    After you configure the credential mappings for each of the outbound connection pool entries, the mappings appear in the Credential Mappings table.

    Description of bam_wls_credmap_list.gif follows
    Description of the illustration bam_wls_credmap_list.gif

  6. For these changes to take effect, Oracle WebLogic Server must be restarted.

23.8 Configuring Oracle BAM Batching Properties

The batch processor batches operations (for example, insert, update, upsert, and delete) between the client and the Active Data Cache server to improve performance by limiting the number of remote calls. For example, 10 update operations could be processed in a single remote call with batching enabled, rather than making 10 remote calls.

Note:

Batching is used only on incoming data, not on internal Oracle BAM processes.

For Oracle BAM Adapter, the batching properties are configured using the Oracle BAM Adapter configuration page in the Oracle WebLogic Server Administration Console.

Oracle BAM batching properties are located in the BAMWebConfig.xml file for configuring batching to send data from Oracle BAM web applications (that is, to send data using Oracle BAM Architect), and to send data from the Oracle BAM DataObjectOperation web service using the batch method.

Oracle BAM configuration files are located in the following directory:

WL_HOME/user_projects/domains/base_domain/config/fmwconfig/servers/bam_server
1/applications/oracle-bam_11.1.1/config/ 

Oracle BAM must be restarted after any changes to Oracle BAM properties. For information about restarting Oracle BAM, see Section 25.2, "Managing Oracle BAM Availability".

Note:

The Oracle BAM ADC API properties are the properties used by all Oracle BAM clients (such as ICommand and Oracle Data Integrator), and the SOAP properties are only used by Oracle BAM Adapter when configured to use SOAP.

Table 23-2 lists the batching properties for Oracle BAM ADC API and SOAP.

Table 23-2 Active Data Cache API and SOAP (Oracle BAM Adapter) Batching Properties

Oracle BAM ADC API Property SOAP Property Default Description

ActiveDataCache_Datasets_Batching_Limit_PendingCalls

Adapter_SOAP_Batching_Limit_PendingCalls

10

The limit of the number of pending calls allowed.

ActiveDataCache_Datasets_Batching_Limit_Lower

Adapter_SOAP_Batching_Limit_Lower

1000

The minimum number of elements in a batch before it is sent out.

ActiveDataCache_Datasets_Batching_Limit_Upper

Adapter_SOAP_Batching_Limit_Upper

5000

The maximum number of elements in a batch before it is sent out.

ActiveDataCache_Datasets_Batching_Timeout

Adapter_SOAP_Batching_Timeout

5000

The timeout interval in milliseconds after which the batch is sent out even if it is not full.

ActiveDataCache_Datasets_Batching_BlockOnBatchFull

Adapter_SOAP_Batching_BlockOnBatchFull

false

The block on batch full properties indicate whether batching operations should block when the batch is full. If set to true, then batching calls block until room is freed up in the batch for the operation. If set to false, a BatchIsFullException exception is thrown.

ActiveDataCache_Datasets_Batching_RetryInterval

Adapter_SOAP_Batching_RetryInterval

30000

The interval in milliseconds at which batch processing should attempt to retry failed flush attempts.

ActiveDataCache_Datasets_Batching_MaxRetryInterval

Adapter_SOAP_Batching_MaxRetryInterval

3600000

The maximum interval in milliseconds at which batch processing should attempt to retry failed flush attempts.

ActiveDataCache_Datasets_Batching_MaximumRetries

Adapter_SOAP_Batching_MaximumRetries

Integer.MAX_VALUE

The maximum number of times batch processing should attempt to retry failed flush attempts. Zero indicates no retry.

ActiveDataCache_Datasets_Batching_SuspendOnDisconnect

Adapter_SOAP_Batching_SuspendOnDisconnect

false

Suspend on disconnect, which indicates whether batching operations should be permanently suspended if and when the connection to Oracle BAM Server is lost.


Batching Retry Mechanism

The batching retry mechanism is designed to retry remote calls to the server in the event communication with the server is lost due to, for example, network problems or Oracle BAM Server going offline. The operation of this retry mechanism is governed by the configuration properties detailed in this section. The term flush refers to the attempt to send the batch calls to the Oracle BAM Server for processing.

The RetryInterval property specifies the interval between retry attempts in milliseconds. If the MaxRetryInterval value is unspecified (0), then the code continues retrying at the RetryInterval value until the batch flush is successful or the MaximumRetries value is exceeded.

If the MaxRetryInterval value is specified, then the retry interval value is doubled on each retry up to the MaxRetryInterval value. It stays at the MaxRetryInterval rate until the batch flush is successful, or the MaximumRetries value is exceeded. This allows the retry rate to decline over time to a more reasonable long-term rate. If the server does not recover quickly, do not continue to retry at a rapid rate.

If the MaximumRetries value is 0, then no retries are attempted and failed batches are discarded.

If the SuspendOnDisconnect value is true, then all batching is permanently suspended until the client application is restarted, regardless of whether communication with Oracle BAM Server is reestablished.

If the pending batch limit is reached and the current batch is full (maximum size reached), then batch calls are blocked. There is no place to queue the operation from the current call, so Oracle BAM blocks the client until the condition resolves itself.

Table 23-2 describes the configuration properties that can be specified for the Active Data Cache API batching (which is used by the RMI connection factory, configured in Section 23.7.2, "Configuring Oracle BAM Connection Factories").

The Oracle BAM Adapter batching mechanism (used by the SOAP connection factory) has an identical set of configuration properties and default values.

23.9 Configuring Security

Security is configured in Oracle WebLogic Server. For information about the topics listed in this section, see Oracle Fusion Middleware Securing Oracle WebLogic Server. General information about Oracle WebLogic Server security is available in Oracle Fusion Middleware Understanding Security for Oracle WebLogic Server.

This section address the following security topics as they relate to Oracle BAM:

23.9.1 Configuring Credential Mapping

Credential mapping is used to securely store user name and password properties when using the Oracle BAM Adapter. For information see Section 23.7.4, "Configuring Credential Mapping."

23.9.2 Configuring Oracle BAM User Permissions

To provide secure access to the Oracle BAM applications, users are assigned to roles that provide the necessary permissions. For more information, see Section 25.3, "Managing Oracle BAM Users".

23.9.3 Configuring Secure Socket Layer

Oracle WebLogic Server provides the facilities needed to enable Secure Socket Layer (SSL) on any Oracle SOA Suite and Oracle WebCenter Portal connections into Oracle WebLogic Server.

Use the Java Development Kit (JDK) keytool utility to create and manage keystores and certificates, and use the Oracle WebLogic Server Administration Console to configure Oracle WebLogic Server listeners.

For more information, see "Configuring SSL" in Oracle Fusion Middleware Securing Oracle WebLogic Server.

Although Oracle WebLogic Server lets you configure the Oracle BAM web applications on both SSL and non-SSL ports, and Oracle BAM can also be configured to run on both SSL and non-SSL ports, it causes issues with the URL configured for Oracle BAM alerts. When Oracle BAM is running on both SSL and non-SSL ports, it cannot send two Oracle BAM report URLs to the alert email receiver. It is the responsibility of the administrator to decide which mode of access (SSL or non-SSL) to use for the Oracle BAM report URL recipients.

To start Oracle BAM in SSL mode, and enable Oracle BAM clients (like ICommand) to invoke Oracle BAM ADC, invoke EJBs, JMS resources, and JDBC resources using SSL, you must configure the following Oracle BAM properties:

  • Communication_Protocol in the BAMCommonConfig.xml, BAMServerConfig.xml, and BAMICommandConfig.xml files, as follows:

    Default value: <Communication_Protocol>t3</Communication_Protocol>

    For SSL using t3s: <Communication_Protocol>t3s</Communication_Protocol>

  • ListenPort in BAMCommonConfig.xml file, as follows:

    Default value: <ListenPort>ListenPort</ListenPort>

    For SSL: <ListenPort>SSLListenPort</ListenPort>

23.9.4 Using Oracle Internet Directory With Oracle BAM

For general information about configuring Oracle Internet Directory, see "Configuring Users and Groups in the Oracle Internet Directory and Oracle Virtual Directory Authentication Providers" in Oracle Fusion Middleware Securing Oracle WebLogic Server.

To use Oracle Internet Directory with Oracle BAM:

  1. Configure Oracle Internet Directory using the Oracle WebLogic Server Administration Console.

  2. Create OracleSystemUser in Oracle Internet Directory, by connecting to Oracle Internet Directory with a Lightweight Directory Access Protocol (LDAP) browser and creating a user in the same base user Distinguished Name that was provided in the Oracle WebLogic Server Administration Console while configuring Oracle Internet Directory.

  3. Run the following SQL statements to nullify the user global unique identifiers (GUID) in the Oracle BAM schema:

    UPDATE "SysIterUser" SET "SysIterUser"."GUID" = NULL,
    "SysIterUser"."Inactive" = NULL;
    

23.9.5 Securing Oracle BAM JMS Resources

This is an optional procedure to restrict access to the Oracle BAM system JMS topics.

To secure Oracle BAM JMS resources:

  1. Create a group with any group name using Oracle WebLogic Server Administration Console. For example, OracleSystemGroup.

  2. Go to WL_HOME/AS11gR1SOA/bam/bin and invoke secure_jms_system_resource.py using Oracle WebLogic Scripting Tool (WLST).

    The usage should be:

    <JAVA_HOME>/bin/java -classpath <weblogic.jar_location> weblogic.WLST 
    
    ./secure_jms_system_resource.py --username admin_user_name --password 
    
    admin_password --url admin_server_t3_url --jmsSystemResource 
    
    JMS_system_resource_name --group security_group_to_use
    
  3. Assign OracleSystemUser to this group.

  4. Assign all those Oracle BAM users to this group.

23.9.6 Calling Secure Web Services

Currently, the Oracle BAM Alerts Call a Web Service action supports invoking web services protected by one-way SSL. In one-way SSL, the web service to be invoked presents a digital certificate to its client (the Oracle BAM Alert action client in this case), and the client verifies whether certificate presented to it can be trusted. If the client trusts the server certificate, then further communication between client and server continues over a secure SSL channel.

To accomplish one-way SSL, the Alert web service client must be pointed to a trust store in which it can perform a lookup, to determine if the certificate presented to it exists in it or not. This can be done by adding the following properties in BAMCommonConfig.xml.

<SSL.TrustStore.Location>wls.home/lib/DemoTrust.jks</SSL.TrustStore.Location>
<SSL.TrustStore.Type>JKS</SSL.TrustStore.Type>
<SSL.TrustStore.Password>password</SSL.TrustStore.Password>
<SSL.TrustStore.Provider>SUN</SSL.TrustStore.Provider>

By default, if these properties are not specified in the configuration file, the values mentioned above are used (except for password, in which no value is used). You can provide different values to these properties to override the default trust store configuration. Currently you must edit the configuration files to set these properties, as they are not exposed in Oracle Enterprise Manager Fusion Middleware Control.

The default trust store is Java Key Store (JKS), which is file based. Certificates can be added and deleted using the Java keytool command-line utility.

For information about configuring the Call a Web Service alert action, see "Call a Web Service" in the Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.

23.9.6.1 Example: Protecting Oracle BAM Web Services

The following is an example illustrating how to invoke SSL protected Oracle BAM web services. It is specific to the Call a Web Service alert action calling the Oracle BAM ManualRuleFire web service. The steps in this section do not need to be done if you are invoking external one-way SSL-protected non-BAM web services.

Note:

After this configuration the entire Oracle BAM application is behind the SSL layer and must be accessed using the SSL port number and HTTPS protocol.

To configure properties for calling secure web services:

  1. Open Oracle WebLogic Server Administration Console and go to Domain Structure > Environment > Servers > BAM_Server > General.

  2. Check SSL Listen Port checkbox and specify the SSL Listen Port number to use.

  3. Modify the Oracle BAM configuration properties.

    1. These properties must be modified in BAMCommonConfig.xml:

      <Communication_Protocol>t3s</Communication_Protocol>
      <ListenPort>SSLListenPort</ListenPort>
      <ApplicationURL>http://SSL_HOST:SSL_PORT</ApplicationURL>
      
    2. This property must be modified in BAMWebConfig.xml:

      <ServerPort>SSL_PORT</ServerPort>
      
  4. Restart Oracle WebLogic Server.

  5. Open Oracle BAM Active Studio or Oracle BAM Architect, and go to Alerts.

  6. Create an alert with the Call a Web Service action using a secure web service, such as

    https://host_name:SSL_port_number/OracleBAMWS/WebServices/ManualRuleFire?wsdl
    

    as the WSDL URL for the action.

  7. Map the parameters and save the alert.

23.10 Configuring Advanced Properties

Oracle BAM provides many advanced properties not available for configuration using the BAM Web Properties and BAM Server Properties pages in Fusion Middleware Control. These advanced properties are configured using the System MBean Browser.

For a listing of all properties available for Oracle BAM configuration, see Section 23.11, "Oracle BAM Configuration Property Reference".

To configure the advanced properties using the System MBean Browser:

  1. Choose System MBean Browser from the menu on the OracleBAMWeb or OracleBAMServer page.

    Description of bam_admin_menu_mbean.gif follows
    Description of the illustration bam_admin_menu_mbean.gif

  2. Select the path to the appropriate Application Defined MBeans page:

    • For properties common to all Oracle BAM components select Application Defined MBeans > oracle.bam.common > Server: bam_server1 > Application: oracle-bam > Config > BAMCommonConfig (see Figure 23-1).

    • For Oracle BAM Server-specific properties select Application Defined MBeans > oracle.bam.server > Server: bam_server1 > Application: oracle-bam > Config > BAMServerConfig.

    • For Oracle BAM web applications-specific properties select Application Defined MBeans > oracle.bam.web > Server: bam_server1 > Application: oracle-bam > Config > BAMWebConfig.

    Figure 23-1 System MBean Browser Navigation Tree

    Description of Figure 23-1 follows
    Description of "Figure 23-1 System MBean Browser Navigation Tree"

    The associated configuration properties are displayed in the System MBean Browser.

    Description of bam_em_mbean.gif follows
    Description of the illustration bam_em_mbean.gif

  3. Edit property values in the Values column, and click Apply.

  4. Oracle BAM must be restarted after any changes to Oracle BAM properties. For information about restarting Oracle BAM, see Section 25.2, "Managing Oracle BAM Availability".

Oracle BAM Configuration Property Files

All Oracle BAM properties are located in configuration files. These files are located in the following directory on the host where the Oracle BAM components are installed:

WL_HOME/user_projects/domains/base_domain/config/fmwconfig/servers/bam_server
1/applications/oracle-bam_11.1.1/config

The configuration properties usually go into the BAMCommonConfig.xml file, which contains the properties global to all Oracle BAM components. These properties can also be specified in component-specific configuration files:

The properties set in the BAMCommonConfig.xml file are always loaded. Any additional configuration files must be loaded explicitly. Oracle BAM Server explicitly loads the BAMServerConfig.xml file, Oracle BAM web applications explicitly load the BAMWebConfig.xml file, and ICommand explicitly loads the BAMICommandConfig.xml file. When a configuration file is loaded, its properties override any properties previously set, that is properties specified in BAMServerConfig.xml override properties set in BAMCommonConfig.xml.

23.11 Oracle BAM Configuration Property Reference

This section provides a brief description of each Oracle BAM configuration property that may be used in the Oracle BAM configuration files.

Advanced properties are configured in the Fusion Middleware Control System MBean Browser. For information about configuring properties that do not appear in the Oracle BAM configuration pages in Fusion Middleware Control, see Section 23.10, "Configuring Advanced Properties".

Some of these properties correspond to properties you can set in the Fusion Middleware Control and Oracle WebLogic Server Administration Console, and references to specific sections about these configuration procedures are provided in Table 23-3.

Note:

The Oracle BAM ADC API properties are the properties used by all Oracle BAM clients (such as ICommand and Oracle Data Integrator), and the SOAP properties are only used by Oracle BAM Adapter when configured to use SOAP.

Table 23-3 Oracle BAM Configuration Properties

Property Name Description
ActiveDataCache.API.Batching.ThreadPool.
CoreSize

Indicates how many threads to keep in the Oracle BAM ADC API thread pools when idle.

Default: 5

ActiveDataCache.API.Batching.ThreadPool.
KeepAliveTimeInSecs

Amount of time (in seconds) to keep an idle thread in the Oracle BAM ADC API thread pools.

Default: 20

ActiveDataCache.API.Batching.ThreadPool.
MaxSize

Maximum number of threads in the Oracle BAM ADC API thread pools.

Default: 100

ActiveDataCache.API.Batching.ThreadPool.
QueueSize

Maximum number of messages that can be queued in the Oracle BAM ADC API thread pools.

Default: 30

ActiveDataCache.API.BufferedDataReader.
ThreadPool.CoreSize

Indicates how many threads to keep in the Oracle BAM ADC buffered data reader thread pools when idle.

Default: 10

ActiveDataCache.API.BufferedDataReader.
ThreadPool.KeepAliveTimeInSecs

Configured in BAMCommonConfig.xml

Amount of time (in seconds) to keep an idle thread in the Oracle BAM ADC buffered data reader thread pools.

Default: 20

ActiveDataCache.API.BufferedDataReader.
ThreadPool.MaxSize

Maximum number of threads in the Oracle BAM ADC Buffered Data Reader Thread Pools.

Default: 100

ActiveDataCache.API.BufferedDataReader.
ThreadPool.QueueSize

Maximum number of messages that can be queued in the Oracle BAM ADC Buffered Data Reader Thread Pools.

Default: 30

ActiveDataCache.Kernel.ActiveDataQueue.
ThreadPool.CoreSize

Indicates how many threads to keep in the Oracle BAM ADC Active Data Queue Thread Pools when idle.

Default: 20

ActiveDataCache.Kernel.ActiveDataQueue.
ThreadPool.KeepAliveTimeInSecs

Amount of time (in seconds) to keep an idle thread in the Oracle BAM ADC Active Data Queue Thread Pools.

Default: 20

ActiveDataCache.Kernel.ActiveDataQueue.
ThreadPool.MaxSize

Maximum number of threads in the Oracle BAM ADC Active Data Queue Thread Pools.

Default: 100

ActiveDataCache.Kernel.ActiveDataQueue.
ThreadPool.QueueSize

Maximum number of messages that can be queued in the Oracle BAM ADC Active Data Queue Thread Pools.

Default: 30

ActiveDataCache_Datasets_Batching_
BlockOnBatchFull

Block on batch full properties indicate whether batching operations should block when the batch is full. If set to true, then batching calls block until room is freed up in the batch for the operation. If set to false, a BatchIsFullException exception is thrown.

Default: false

ActiveDataCache_Datasets_Batching_Limit_
Lower

The minimum amount of elements in a batch before it is sent to the server. Depending on the load, batches may contain more than this minimum (up to the maximum), but they never contain less than this minimum (unless the timeout expires).

See ActiveDataCache_Datasets_Batching_Timeout for the exception to this rule.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 1000

ActiveDataCache_Datasets_Batching_Limit_
PendingCalls

The limit of the number of pending batches that are waiting to be sent to the server. When this limit is reached and the current batch is full (at its upper limit), further batched operations become blocking calls until this condition is cleared. This limit throttles the client and keeps it from overrunning the server.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 10

ActiveDataCache_Datasets_Batching_Limit_
Upper

The maximum amount of elements in a batch before it is sent out. A batch never contains more than this maximum.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 5000

ActiveDataCache_Datasets_Batching_
MaximumRetries

The maximum number of times batch processing retries failed attempts to send the batch to the server. A value of 0 (zero) indicates no retry.

Default: 2147483647

ActiveDataCache_Datasets_Batching_
MaxRetryInterval

The maximum interval in milliseconds at which batch processing retries failed attempts to send the batch to the server. If this maximum retry interval is specified, the retry interval is doubled on each retry attempt until the interval reaches this maximum value. Further retries use this maximum value. This interval enables the configuration of retry attempts that taper off should the failure not resolve itself quickly. If a maximum retry interval of 0 (zero) is specified, the retry interval does not change.

Default: 3600000

ActiveDataCache_Datasets_Batching_
RetryInterval

The interval in milliseconds at which batch processing retries failed attempts to send the batch to the server. Retry is attempted when the failure is due to server connectivity problems such as the server being restarted.

Default: 30000

ActiveDataCache_Datasets_Batching_
SuspendOnDisconnect

Indicates whether batching operations are permanently suspended if and when the connection to Oracle BAM Server is lost.

Default: false

ActiveDataCache_Datasets_Batching_
ThreadPoolSize 

The constant size thread pool (that is, containing a fixed number of threads).

Default: 25

ActiveDataCache_Datasets_Batching_
Timeout

The timeout in milliseconds after which the batch is sent out even if it is not full (has less than the configured minimum in ActiveDataCache_Datasets_Batching_Limit_Lower).

The timeout ensures that operations are not waiting overlong in a batch due to inactivity. A batched operation never waits longer than this timeout to be sent to the server.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 50

ActiveDataCache_Query_Command_Timeout

The configuration key for a query command timeout in seconds. If the time to execute a query command exceeds this timeout, an exception is thrown.

Default: 60

ActiveDataCache_Update_Command_Timeout

The configuration key for an update command timeout in seconds. If the time to execute an update command exceeds this timeout, an exception is thrown.

Default: 60

Adapter_SOAP_Batching_BlockOnBatchFull

Block on batch full properties indicate whether batching operations should block when the batch is full. If set to true, then batching calls block until room is freed up in the batch for the operation. If set to false, a BatchIsFullException exception is thrown.

Default: false

Adapter_SOAP_Batching_Limit_Lower

The minimum amount of elements in a batch before it is sent out.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 1000

Adapter_SOAP_Batching_Limit_Upper

The maximum amount of elements in a batch before it is sent out.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 5000

Adapter_SOAP_Batching_Timeout

The timeout interval in milliseconds after which the batch is sent out even if it is not full.

See Section 23.8, "Configuring Oracle BAM Batching Properties" for more information.

Default: 50

ADC_PassThrough_Import_BatchSize

The maximum number of rows that are imported from an external data object.

Default: 50

ADC_PassThrough_Import_
MaxRowsToImportAtOnce

Maximum number. of rows imported by ExternalDataManager at one time.

Default: 100

ADC_PassThrough_Import_MaxSize

Maximum size imported by ExternalDataManager.

Default: -1

ADCBatchSize

Refers to JDBC statement batching. When the Oracle BAM ADC executes SQL statements it uses JDBC batching to reduce the number of calls to the database, improving performance. Each call executes a batch of statements rather than a single statement.

Default: 100

ADCChannelName

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: invm:topic/oracle.bam.messaging.activedatacache.activedata

ADCDataSource

The data source for the Active Data Cache. See Section 23.3.2, "Configuring the Data Source JNDI" for more information.

Default: jdbc/oracle/bam/adc

ADCLogBatchInsertLocks

Indicates whether to log Oracle BAM ADC batch insert locks.

Default: false

ADCLogFolderLocks

Indicates whether to log Oracle BAM ADC folder locks.

Default: false

ADCLogSqlStatements

Indicates whether to log Oracle BAM ADC SQL statements.

Default: false

ADCLogTransactionLocks

Indicates whether to log Oracle BAM ADC transaction locks.

Default: false

ADCMaxViewsetRowCount

The default limit for rows of data displayed in a view with this property. The higher you set this value, the more performance is impacted.

Default: 64000

ADCPreloadDataObjectIDs

Indicates whether data objects should be loaded at Oracle BAM ADC startup rather than on-demand as they are accessed. Pre-loading the data objects increases startup time but decreases initial data object access time. Not pre-loading the data objects decreases startup time but increases initial data object access time. Also, pre-loading all data objects where many data objects are rarely referenced may needlessly increase memory requirements.

ADCPushInterval

The rate at which Oracle BAM Active Data Cache pushes events to Oracle BAM Report Server. This is one factor that affects the frequency at which active events occur on Oracle BAM dashboard pages. Increasing this interval reduces the load on Oracle BAM Server. However, larger intervals increase the likelihood of multiple updates in the dashboard being collapsed into single updates.

You can override the default ADCPushInterval within particular reports by setting the Active Data Retrieval Interval property in the Report Properties dialog for a particular Oracle BAM dashboard or report. Open a report in Active Studio, then select Edit > Change Report Properties > Advanced to set the active data retrieval interval. Nonzero values override the ADCPushInterval value for that particular report.

Default: 1000

ADCPushThreadPoolSize

Indicates the size of the threadpool for Oracle BAM ADC push functionality.

Default: 10

ADCRetryCount

Number of times to retry the Oracle BAM Active Data Cache connection.

Default: 2

ADCSecurityFiltersEnabled

Indicates whether Oracle BAM ADC security filters are to be enabled.

Default: true

ADCViewsetTimeoutSec

Specifies the timeout for retrieving a view set.

Default: 0

ADCWaitTime

Interval between Active Data Cache connection attempts.

Default: 20

ApplicationURL

URL for Oracle BAM web applications and Oracle BAM Server. See Section 23.3.3, "Configuring the Application URL" and Section 23.2.2, "Configuring the Application URL" for more information.

Default: DEFAULT

Architect_Content_PageSize

Controls how many rows are shown when viewing data object contents in Oracle BAM Architect.

Default: 100

AutoIncrementBlockSize

Indicates amount of increment for block size.

Default: 100

CacheDirectory

Designates the directory used by Report Cache to cache snapshots and active data.

Default: cache

ChangeListDelay

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 1

ChannelName

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: OracleBAM

CheckViewsFallingBehindInterval

Indicates the interval to check whether views are falling behind.

Default: 20

CollaborationNILogin

Whether NI Login is used.

Default: false

ColumnarTimeout

Indicates the columnar timeout.

Default: 0

Communication_Protocol

Specifies the communication protocol for JNDI communication.

For SSL using t3: <Communication_Protocol>t3s</Communication_Protocol>

See Section 23.9.3, "Configuring Secure Socket Layer."

Default: DEFAULT

ConnectionFactoryName

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: jms/QueueConnectionFactory

DeletesActiveDataSize

InsertsActiveDataSize, UpdatesActiveDataSize, UpsertsActiveDataSize, and DeletesActiveDataSize determine how many inserts, updates, upserts, and deletes, respectively, should be executed before releasing and then requiring the lock on the data object being modified. This keeps the operation from holding the data object lock for long periods of time when there are view sets open on this data object.

Default: 50

DisplayUIStackTrace

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

This property enables user interface stack traces (by setting this property value to true). This property is used for temporary diagnostic purposes only because exposing a stack with internal details is a potential security threat.

Default: false

DistributionListGroupType

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: none

EDS_Query_Timeout

The timeout in seconds after which the execution of BAM report queries on external data objects stop because it is taking too long to retrieve the information for display. Also set Import_MaxSize, which determines the maximum number of rows that are pulled from the external data object (the larger the number, the slower the performance).

Default: 180

ElementsCountLimit

The number of change lists that are cached before rewriting the cache file.

The default value is 50. When the 51st change list is received, it is cached by replacing the 1st change list.

Default: 50

ElementsSizeLimit

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 500

EmailIDForSender

Email address that appears in the From header of notifications sent by the Event Engine. See Section 23.3.7, "Configuring the Outbound Email Account" for more information.

Default: BAM-NOTIFICATION_AR@oracle.com

EMSConnectionRecoveryDuration

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

EnableADCDatasetLockTimeout

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Indicates whether data set lock timeout is enabled.

Default: false

EnableDataTruncationMsg

Indicates whether to enable the data truncation message.

Default: false

EnableGetAllViewsInOneRoundTrip

Allows all views to be retrieved in one round trip.

Default: true

EvaluatorMaxExpressionDepth

Maximum number of nested logical expressions that can be included in one method in the class that gets compiled to evaluate a filter expression.

Default: 200

When opening a view that uses a filter with a large number of distinct values, the compiler could run out of memory and you would get the error: "BAM-01317: Compilation for class ... failed with error 3." If this error continues to happen, lower the value for EvaluatorMaxExpressionDepth and restart the server.

Although this property does not significantly affect performance, you can turn it off by setting EvaluatorMaxExpressionDepth to zero, which would result in one method in the evaluator class for the entire filter expression.

EventEngine.Action.ThreadPool.CoreSize

Indicates how many threads to keep in the Event Engine Action Thread Pools when idle.

Default: 4

EventEngine.Action.ThreadPool.
KeepAliveTimeInSec

Amount of time (in seconds) to keep an idle thread in the Event Engine Action Thread Pools.

Default: 20

EventEngine.Action.ThreadPool.MaxSize

Maximum number of threads in the Event Engine Action Thread Pools.

Default: 100

EventEngine.Action.ThreadPool.QueueSize

Maximum number of messages that can be queued in the Event Engine Action Thread Pools.

Default: 4

EventEngine.AlertHistory.ThreadPool.
CoreSize

Indicates how many threads to keep in the Event Engine Alert History Thread Pools when idle.

Default: 4

EventEngine.AlertHistory.ThreadPool.
KeepAliveTimeInSecs

Amount of time (in seconds) to keep an idle thread in the Event Engine Action Thread Pools.

Default: 20

EventEngine.AlertHistory.ThreadPool.
MaxSize

Maximum number of threads in the Event Engine Alert History Thread Pools.

Default: 100

EventEngine.AlertHistory.ThreadPool.
QueueSize

Maximum number of messages that can be queued in the Event Engine Rule Fire Thread Pools.

Default: 10

EventEngineAlertHistoryEventLogging

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: false

EventEngineAlertHistoryRecordsPerWrite

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 10

EventEngine.RuleFire.ThreadPool.CoreSize

Indicates how many threads to keep in the Event Engine Rule Fire Thread Pools when idle.

Default: 4

EventEngine.RuleFire.ThreadPool.
KeepAliveTimeInSecs

Amount of time (in seconds) to keep an idle thread in the Event Engine Rule Fire Thread Pools.

Default: 20

EventEngine.RuleFire.ThreadPool.MaxSize

Maximum number of threads in the Event Engine Rule Fire Thread Pools.

Default: 100

EventEngine.RuleFire.ThreadPool.
QueueSize

Maximum number of messages that can be queued in the Event Engine Rule Fire Thread Pools.

Default: 4

EventEngineCheckADCIntervalSecs

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 5

EventEngineMaxConnections

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 25

EventEngineMaxShutdownWaitInterval

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 10

EventEngineSaveLastFireIntervalSecs

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 10

FileHandleCacheSize

Used by Oracle BAM Report Cache to cache file handles of the files used for caching when file-based persistence is used (see Section 23.3.5, "Configuring the Report Cache Persistence Manager" for information about persistence management).

Handle caching increases the speed of reading and writing active data and snapshots. Each view set has two file handles--one for the snapshot and another for active data.

The value for this property sets the number of file handles that are cached by default.

To disable file handle caching, set this property value to zero (0).

The cost of file handle caching is that all of the cached file handles remain open, and so a) on servers configured for a very small number of concurrent open file handles, and b) on servers heavily loaded with open file handle count reaching the maximum value, this could create a problem. For these scenarios, reduce FileHandleCacheSize to an appropriate smaller value.

Default: 100

FractionInIntegerDivision

Setting this property to true shows fractions in Integer divisions in calculations.

Saved reports must be re-saved after a server restart (following configuration change) to see this behavior.

Default: false

GenericSatelliteChannelName

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default:

invmjms:topic/oracle.bam.messaging.
systemobjectnotification
GenericSatelliteSystemObjectNames

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default values:

SystemObjectName=SysIterReport,MonitorColumnName=SysIterL
astModified,MessageColumn1=SysIterID,MessageColumn2=SysIt
erLastModified;

SystemObjectName=SysIterUser,MonitorColumnName=SpecificTi
meZoneOffset,MessageColumn1=SysIterID;

SystemObjectName=SysIterUser,MonitorColumnName=AdjustTime
ZoneSetting,MessageColumn1=SysIterID;

SystemObjectName=SysIterUser,MonitorColumnName=AdjustDayl
ightSavingsSetting,MessageColumn1=SysIterID;

SystemObjectName=SysIterDataset,MonitorColumnName=SysIter
LastModified,MessageColumn1=SysIterID;
HelpAppLocation

This property is no longer used in Oracle BAM.

iActiveDataCloseReportsTimeout

Timeout to close reports.

Default: 500

iActiveDataMaxDiffCounter

The maximum difference counter for iActiveData.

Default: 10

iActiveDataMinIntervalsToWait

The minimum interval to wait for iActiveData.

Default: 5

iActiveDataReloadOnSecsBehindThreshold

The threshold value for reloading iActiveData.

Default: 10

iActiveDataRestartInterval

The restart interval for iActiveData.

Default: 3000

iActiveDataRestartTimeout

The restart timeout value for iActiveData.

Default: 10000

iActiveDataScriptsCleanupFactor

A property to address a Microsoft Internet Explorer memory leak, when active data is coming into the dashboard at a fast pace, by forcing periodic browser refreshes. This value may be further increased when active data is coming to the dashboard at a rate of 25 events per second or greater. You can monitor the Microsoft Internet Explorer memory consumption to determine an appropriate value.

Default: 1048576

ICommand_Default_User_Name

Specifies default security credentials for running ICommand operations. See Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite for more information.

ICommand_Default_Password

Specifies default security credentials for running ICommand operations. See Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite for more information.

Import_BatchSize

Batch size for import by ExternalDataManager.

Default: 50

Import_MaxRowsAtOnce

Maximum number of rows imported by ExternalDataManager at one time.

Default: 100

Import_MaxSize

Maximum size imported by ExternalDataManager.

Default: -1

InsertsActiveDataSize

InsertsActiveDataSize, UpdatesActiveDataSize, UpsertsActiveDataSize, and DeletesActiveDataSize determine how many inserts, updates, upserts, and deletes, respectively, should be executed before releasing and then requiring the lock on the data object being modified. This keeps the operation from holding the data object lock for long periods of time when there are view sets open on this data object.

Default: 50

ListenPort

For SSL: <ListenPort>SSLListenPort</ListenPort>

See Section 23.9.3, "Configuring Secure Socket Layer."

Default: ListenPort

MaxDBNodeFailoverRetries

Used in Oracle RAC High Availability configuration. Indicates the number of retries Oracle BAM Server attempts in an event of an Oracle RAC failover.

Default: 5

MTTimerThreadPoolSize

Oracle BAM has a timer implementation that dispatches timer events using a thread pool. This allows timer events to be processed in parallel. This property determines the thread pool size for this timer implementation.

Default: 5

ODIAgentHost

The IP address or hostname of the server where the Oracle Data Integrator agent is running. See Section 23.3.6, "Configuring Oracle Data Integrator Integration Properties" for more information.

Default: localhost

ODIAgentPort

The TCP port on which the Oracle Data Integrator agent is listening. See Section 23.3.6, "Configuring Oracle Data Integrator Integration Properties" for more information.

Default: 20910

ODIPassword

The encoded Oracle Data Integrator password. See Section 23.3.6, "Configuring Oracle Data Integrator Integration Properties" for more information.

Default: SUNOPSIS

ODIUser

The user that executes the scenarios in Oracle Data Integrator. See Section 23.3.6, "Configuring Oracle Data Integrator Integration Properties" for more information.

Default: SUPERVISOR

ODIWorkRepositoryName

The name of the Oracle Data Integrator work repository database. See Section 23.3.6, "Configuring Oracle Data Integrator Integration Properties" for more information.

Default: WORK_DEV

oracle.bam.common.messaging.util.
MessageConsumerRegistryQueuedPusher_
CorePoolSize

Indicates how many threads to keep in Message Registry Thread Pool when idle.

Default: 20

oracle.bam.common.messaging.util.
MessageConsumerRegistryQueuedPusher_
KeepAliveTime

Amount of time (in seconds) to keep an idle thread in the Message Registry Thread Pool.

Default: 60

oracle.bam.common.messaging.util.
MessageConsumerRegistryQueuedPusher_
MaximumPoolSize

Maximum number of threads in the Message Registry Thread Pool.

Default: 100

oracle.bam.common.messaging.util.
MessageConsumerRegistryQueuedPusher_
MaximumQueueSize

Maximum number of messages that can be queued in the Message Registry Thread Pool.

Default: 30

RecordsLimitForEmail

The number of rows allowed in a List view or Columnar report used in an email attachment before a limit error is displayed. Attachments containing reports can become large because they include data compared to a report link that accesses the report and data on Oracle BAM Server.

Default: 1000

RecordsLimitForSaveOffline

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 0

RecordsLimitForValueBrowser

Number of values that are presented in values browser for constructing filter expressions.

Default: 50

ReportCache.ViewSets.ThreadPool.CoreSize

Number of threads to keep in Report Cache Thread Pool when idle.

Default: 5

ReportCache.ViewSets.ThreadPool.
KeepAliveTimeInSecs

Amount of time (in seconds) to keep an idle thread in the Report Cache Thread Pool.

Default: 20

ReportCache.ViewSets.ThreadPool.MaxSize

Maximum number of threads in the Report Cache Thread Pool.

Default: 100

ReportCache.ViewSets.ThreadPool.
QueueSize

Maximum no. of messages that can be queued in the Report Cache Thread Pool.

Default: 30

ReportCacheChannelName

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: invmjms:topic/oracle.bam.messaging.reportcache.activedata

ReportCacheMaxConnections

The maximum number of connections allowed by Report Cache to its clients.

Default: 25

ReportCacheMaxShutdownWaitInterval

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 10

ReportCachePersistenceManager

See Section 23.3.5, "Configuring the Report Cache Persistence Manager" for more information.

Default: FileBasedPersistenceManager

ReportLoadingSetting

The report loading indicator to be enabled. See Section 23.2.3, "Configuring the Report Loading Indicator" for more information.

Default: on

SensorFactory

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: oracle.bam.common.statistics.noop.SensorFactoryImpl

ServerName

The Oracle BAM Server hostname. See Section 23.2.4, "Configuring the Server Name" for more information.

Default: DEFAULT

ServerPort

The Oracle BAM Server port number.

Default: DEFAULT

UpdatesActiveDataSize

InsertsActiveDataSize, UpdatesActiveDataSize, UpsertsActiveDataSize, and DeletesActiveDataSize determine how many inserts, updates, upserts, and deletes, respectively, should be executed before releasing and then requiring the lock on the data object being modified. This keeps the operation from holding the data object lock for long periods of time when there are view sets open on this data object.

Default: 50

UpsertsActiveDataSize

InsertsActiveDataSize, UpdatesActiveDataSize, UpsertsActiveDataSize, and DeletesActiveDataSize determine how many inserts, updates, upserts, and deletes, respectively, should be executed before releasing and then requiring the lock on the data object being modified. This keeps the operation from holding the data object lock for long periods of time when there are view sets open on this data object.

Default: 50

UseDBFailover

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: true

ViewSetExpiryTimeout

This property is for Oracle BAM internal use only. Do not change it unless instructed to do so by Oracle Support Services.

Default: 120

ViewSetSharing

See Section 23.3.4, "Configuring Viewset Sharing" for more information.

Default: true