Skip Headers
Oracle® Business Activity Monitoring Installation Guide
10g (10.1.3.1.0)

Part Number B28988-02
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
View PDF

3 Additional Configuration Procedures

This chapter includes the following topics:

3.1 Downloading and Applying Mandatory Postinstallation Patches

Oracle Business Activity Monitoring periodically releases patch updates that you must download and install.

  1. Visit the following URL:

    http://www.oracle.com/technology/products/integration/index.html
    
  2. Go to the Business Activity Monitoring section to find out if any patches have been released. A README.txt file is included in the patch zip file that you download. This file provides installation instructions.

3.2 Performance Configuration Settings

This section describes additional configuration steps that are recommended to improve performance for Enterprise Link and the Oracle Business Activity Monitoring servers.

  1. Open Enterprise Link Admin.

  2. Click the Servers tab.

  3. Click the Data Flow Service name and click the Configuration tab.

  4. Apply the following changes to the settings. Depending on your particular environment, you may need to make additional adjustments. These are some base adjustments that improve performance in most cases.

    • AgentVMMemory - 25000

    • MaxFieldLength - 4000

    • MaxMemoryBlocks - 25000

    • MaxUsrMemoryBlocks - 25000

3.3 Configuring JMS Messaging Credentials

If you want to use JMS message sources (Oracle OC4J JMS or Oracle JMS based on advanced queuing) with Oracle Business Activity Monitoring, you must manually configure your JMS messaging credentials.

  1. Open the OracleBAM_Home\BAM\j2re1.4.1_01\lib\jndi.properties file with a text editor.

  2. Replace admin and welcome with JMS messaging credentials appropriate to your environment:

    java.naming.security.principal=admin
    java.naming.security.credentials=welcome
    
  3. Save this file with your updates.

3.4 LDAP Configuration

This section describes the configuration steps needed to setup Oracle Business Activity Monitoring with LDAP. It contains the following topics:

3.4.1 LDAP Using Active Directory

  1. Open Control Panel>Administrative Tools>Internet Information Services.

  2. Expand the local computer, Web Sites, and Default Web Site nodes.

  3. Right-click OracleBam and select Properties.

  4. Select the Directory Security tab.

  5. Click Edit in the Anonymous access and authentication control group.

  6. Select the Anonymous access check box, and uncheck Integrated Windows authentication.

  7. Click OK to close the Authentication Methods dialog, and click OK to close the OracleBAM Properties window.

  8. In this example Active Directory is running on rts-mail01 with user demoadmin/tanager.

  9. Open OracleBAM home\Web.config for editing.

  10. Search for /appSettings and insert the following text before the end appSettings tag.

    <add key="AuthenticationModule" value="Oracle.BAM.Common.Security.Authentication.LDAPAuthenticationModule, Oracle.BAM.Common.Core"/>
    
    <add key="ADCPrincipalType" value="Oracle.BAM.Common.Security.Ldap.LdapPrincipal, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCIdentityType" value="Oracle.BAM.Common.Security.Ldap.LdapIdentity, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCGroupsGetterType" value="Oracle.BAM.Common.Security.Groups.LdapGroupsGetter, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    
    <add key="LdapAuthenticationServer" value="rts-mail01"/>
    <add key="LdapAuthenticationConnectionType" value="credentials"/>
    <add key="LdapAuthenticationUser" value="CN=demoadmin,CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationPassword" value="tanager"/>
    <add key="LdapAuthenticationUsersRoot" value="CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationGroupsRoot" value="CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationUserNameAttribute" value="sAMAccountName"/>
    <add key="LdapAuthenticationGroupMemberAttribute" value="member"/>
    
  11. Open OracleBAM home\OracleBAMActiveDataCache.exe.config for editing.

  12. Search for /appSettings and insert the following text before the end appSettings tag.

    <add key="ADCPrincipalType" value="Oracle.BAM.Common.Security.Ldap.LdapPrincipal, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCIdentityType" value="Oracle.BAM.Common.Security.Ldap.LdapIdentity, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCGroupsGetterType" value="Oracle.BAM.Common.Security.Groups.LdapGroupsGetter, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    
    <add key="LdapAuthenticationServer" value="rts-mail01"/>
    <add key="LdapAuthenticationConnectionType" value="credentials"/>
    <add key="LdapAuthenticationUser" value="CN=demoadmin,CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationPassword" value="tanager"/>
    <add key="LdapAuthenticationUsersRoot" value="CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationGroupsRoot" value="CN=Users,DC=IterationSoftware,DC=com"/>
    <add key="LdapAuthenticationUserNameAttribute" value="sAMAccountName"/>
    <add key="LdapAuthenticationGroupMemberAttribute" value="member"/>
    
  13. Restart the Active Data Cache service.

  14. Restart Microsoft IIS service.

  15. Open the Oracle Business Activity Monitoring start page:.

    http://<host>:<http_port>/oraclebam
    

    A login dialog box should appear. If you are able to log in but the buttons are grayed out, you will need to change the roles in Administrator and add yourself to the administrative role.

3.4.2 LDAP Using Oracle Internet Directory

  1. Open Control Panel>Administrative Tools>Internet Information Services.

  2. Expand the local computer, Web Sites, and Default Web Site nodes.

  3. Right-click OracleBam and select Properties.

  4. Select the Directory Security tab.

  5. Click Edit in the Anonymous access and authentication control group.

  6. Select the Anonymous access check box, and uncheck Integrated Windows authentication.

  7. Click OK to close the Authentication Methods dialog, and click OK to close the OracleBAM Properties window.

  8. Install 10.1.2.0.0 iAS infra+midtier with Oracle Internet Directory on a separate machine. In this example, ipqa6-pc is the host running Oracle Internet Directory on port 3060.

  9. Open OracleBAM home\Web.config and OracleBAM home\OracleBAMActiveDataCache.exe.config for editing.

  10. Search for /appSettings and insert the following text before the end appSettings tag.

    <add key="AuthenticationModule" value="LDAP"/>
    
    <add key="AuthenticationModule" value="Oracle.BAM.Common.Security.Authentication.LDAPAuthenticationModule, Oracle.BAM.Common.Core"/>
    
    <add key="ADCPrincipalType" value="Oracle.BAM.Common.Security.Ldap.LdapPrincipal, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCIdentityType" value="Oracle.BAM.Common.Security.Ldap.LdapIdentity, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    <add key="ADCGroupsGetterType" value="Oracle.BAM.Common.Security.Groups.LdapGroupsGetter, Oracle.BAM.Common.Core, Culture=neutral, PublicKeyToken=acdd5a747bafa1a8"/>
    
    <add key="LdapAuthenticationServer" value="ipqa6-pc:3060"/>
    <add key="LdapAuthenticationConnectionType" value="anonymous"/>
    <add key="LdapAuthenticationUser" value="cn=orcladmin,cn=Users,dc=us,dc=oracle,dc=com"/>
    <add key="LdapAuthenticationPassword" value="welcome1"/>
    <add key="LdapAuthenticationUsersRoot" value="cn=Users,dc=us,dc=oracle,dc=com"/>
    <add key="LdapAuthenticationGroupsRoot" value="cn=Users,dc=us,dc=oracle,dc=com"/>
    <add key="LdapAuthenticationUserNameAttribute" value="uid"/>
    <add key="LdapAuthenticationGroupMemberAttribute" value="member"/>
    
  11. Restart the Active Data Cache service.

  12. Restart Microsoft IIS service.

  13. Open the Oracle Business Activity Monitoring start page:

    http://<host>:<http_port>/oraclebam
    

    A login dialog box should appear. If you are able to log in but the buttons are grayed out, you will need to change the roles in Administrator and add yourself to the administrative role.

3.5 Upgrading an Installation

This section provides instructions for existing customers upgrading from a previous version.

To upgrade an installation from the previous version:

  1. Create backup copies of any customized configuration files and database files.

  2. Create a full backup of the Active Data Cache data using your Oracle tools.

  3. Back up the Enterprise Link Repository using SARPUTIL.

  4. Make note of any Enterprise Link Data Flow Service settings prior to deinstallation. You must re-enter these settings after upgrading.

  5. Install any patches to the Oracle database. Oracle Business Activity Monitoring release 10.1.3.1 supports only the latest patches of the Oracle database (9.2.0.7, 10.1.0.5, and 10.2.0.2).

  6. Stop all of the Oracle Business Activity Monitoring services.

  7. Open Control Panel > Add or Remove Programs and remove the Oracle Business Activity Monitoring applications. The Active Data Cache is not deleted.

  8. Restart the host.

    Caution:

    User accounts are case-sensitive in the Oracle Business Activity Monitoring 10g release. Be certain that you enter the account information using the same case that is stored on the domain server. If not, update the accounts in BAM Administrator before exporting for migration.
  9. Run setup.exe for the new Oracle Business Activity Monitoring installation following the instructions in "Installing Oracle Business Activity Monitoring".

  10. If you have an existing Active Data Cache, a message displays asking if you want to upgrade the existing Active Data Cache. Click Yes to run Morpheus.exe, a utility for updating data in an Active Data Cache from version to version. Click the Update button.

    The data is converted and a message displays that it is completed.

  11. If you have installed Oracle Business Activity Monitoring and then uninstalled it, the uninstall does not remove the virtual directory. If you want to use a different virtual directory, then you must open Microsoft Internet Information Services and manually remove the virtual directory before reinstalling.

  12. After installing Enterprise Link, you may receive a message that the Oracle Business Activity Monitoring user cannot be created in the Enterprise Link Repository. You can confirm that the user already exists by using Enterprise Link Admin.

  13. After upgrading the Active Data Cache and the installation are complete, start the Oracle Business Activity Monitoring services.

    See Also:

    Oracle BAM Enterprise Link Utilities User's Guide for instructions on using SARPUTIL to back up the Enterprise Link Repository

Note:

If your attempt at upgrading fails run the Morpheus utility at the command line prompt:
C:\OracleBAM\BAM> morpheus

3.5.1 Upgrading Reports

After a new version installation, reports are automatically upgraded for users when they open reports. If you create a columnar report with an image in the header, and upgrade to a new version without saving and replacing the images into the Oracle Business Activity Monitoring directory, the columnar report displays a red X where the image was inserted.

If the image is placed into the directory, then the columnar report displays the image instead of the red X symbol.

You must also allow ASP.NET access to the images directory. You should copy images back into this directory after reinstalling.

3.6 Installing Multiple Plan Monitors

You can install multiple Plan Monitors for implementations that run large numbers of Plans. This section contains the following topics:

3.6.1 Uses and Restrictions

  • There can only be one Enterprise Link Data Flow Service (DFS) on each host. This is a Enterprise Link Restriction.

  • There can be any number of Plan Monitors on each host. However, all Plan Monitors on the same host are registered to a single Data Flow Service whether that Data Flow Service is on the same or a different host. Whatever the default Data Flow Service is set to when logging into Design Studio, that is the one that Plan Monitors on the same host use.

  • Multiple Plan Monitors can connect to the same Data Flow Service.

  • Each Plan Monitor can use its own individual Enterprise Link Repository, even when they reside on the same host.

  • It is okay for multiple Plan Monitors, each using different Repositories, to connect to the same Data Flow Service because a single Data Flow Service can handle multiple Repositories.

  • Plan Monitors do not necessarily have to be on the same host as the Data Flow Services to which they connect. The only restriction is that Enterprise Link must be at least installed on the host for Plan Monitor to run on the host. However, the Data Flow Service can be turned off.

  • If the Active Data Cache Service is restarted for any reason, the dependent service on the additional Plan Monitor server may need to be restarted.

3.6.2 How Connections to Plan Monitors are Established

Plan Monitors are identified by a name, known as the Plan Monitor Service Name.Any portion of the system (such as ICommand or the Event Engine) that must connect to a Plan Monitor does so by referring to its name. The format of the name must be valid according the rules for both data object names and Windows Service names. All of the Plan Monitors connected to the same Active Data Cache must each have unique service names.

Every Plan Monitor registers itself with the Active Data Cache by name. When some portion of the system needs to connect to a Plan Monitor, it goes to the Active Data Cache to look up how to contact that Plan Monitor. Therefore, when configuring other portions of the system, besides the Plan Monitors, there is no need to enter host names or port numbers for Plan Monitors. There are optional backup mechanisms in the configuration files to refer to Plan Monitors by URL or by host name and port, but these should generally not be used.

Portions of the system that refer to Plan Monitor have a default Plan Monitor Service Name specified in their configuration files. Some portions of the system, such as ICommand and Administrator, allow the end user to specify which Plan Monitor is to be used.

Because Plan Monitors are not registered with the Active Data Cache until the first time they are run, no information appears in Administrator for a Plan Monitor until after the first time it has been run.

The information about the Plan Monitors is stored in a Data Objects directory named /System/Plan Monitor. There is subdirectory for each Plan Monitor. The name of the subdirectory is the Plan Monitor Service Name. The Data Objects are:

  • Journal

  • Plan Status

  • Service Status

  • Lock (used to detect naming conflicts between Plan Monitors)

The Plan Monitor page in Administrator shows the status of all known Plan Monitors, and allows interaction with each one individually. Note that no entries appear in this display until the Plan Monitor has been run at least once.

3.6.3 Editing the Monitoring Settings of Plans

When the monitoring settings for a Plan are edited in Architect, a new drop-down menu appears called Monitor Service Name. It lists the registered Plan Monitor Service Names. Either the name of a specific Plan Monitor must be chosen, or else the (No preference) option. Any Plan with the (No preference) option is monitored by any Plan Monitor that is configured to run such Plans. The setting in the Plan Monitor's configuration file is:

<add key="PlanMonitor.MonitorPlansWithNoServicePreference" value="1" />

Set value="0" to disable. Normally there is only one such Plan Monitor. If there is more than one, they all run and monitor their own separate instances of that same Plan. By default, all monitored Plans from prior releases are set to (no preference).

3.6.4 Using ICommand with Multiple Plan Monitors

All ICommand commands that deal with Plans, directly or indirectly, have an optional parameter called PlanMonitorServiceName to specify which Plan Monitor is to be used to process Plans for that command. If this parameter is omitted, the default Plan Monitor as specified in the ICommand configuration file uses:

<add key="PlanMonitor.ServiceName" value="Oracle BAM Plan Monitor" />

The monitoring settings for individual Plans can be changed by using the ICommand SETMONITORING command. This command supports pattern-matching and all options. If no monitoring parameters are given, monitoring is turned off.

SETMONITORING
  [name=plan_name]
  [type=plan]
  [match=dos_pattern]
  [regex=regular_expression]
  [all[=0|1]]
  [planmonitorservicename=service_name]
  [enabled[=0|1]]
  [restartoncompletion=never|always|count]
  [restartonfailure=never|always|count]
  [restartfrequencymax=none|count_in_minutes]
  [preferredservicename=service_name|empty_string]

Note:

Use either the name or match keyword, but not both, in the same SETMONITORING command.

3.6.5 Event Engine

The Event Engine currently only has the option to connect to a single Plan Monitor. Whenever it runs a Plan as a result of a Rule Action, it uses that Plan Monitor. The name of the Plan Monitor used by the Event Engine is specified in the Event Engine's configuration file:

<add key="PlanMonitor.ServiceName" value="Oracle BAM Plan Monitor" />

3.6.6 Plan Setting Change Detection

By default, Plan Monitors only periodically check for changes to the settings for the individual Plans. They can also be set to check only once at startup, or to never check automatically. These options are selected in the Plan Monitor configuration file.

<add key="PlanMonitor.PlanChangeDetectFrequency" value="10" />

In Administrator, there is a Request Plan settings check link for each Plan Monitor that requests that it check for changes to Plans. The check does not necessarily happen immediately, but is done the next time that Plan Monitor has an opportunity to do so. The length of time may vary depending upon how busy Plan Monitor is.

Checking for Plan setting changes can be an expensive operation on large systems. One possible approach for production systems in which Plans are not changing much is to use the once option in the configuration setting, and then manually request a check through Administrator only when it is known that a Plan has been changed.

Plan Monitor is also used for other functions aside from monitoring Plans (for example, exporting and importing of Plans through Icommand). There may be times when you want to bring up a Plan Monitor with the never check option so that exporting, importing, or editing can be done without any monitoring occurring. For performance or load distribution reasons, in some situations it can be desirable to have an extra Plan Monitor running strictly for export/import purposes with no actual monitoring. (Set monitoring to never and specify that Plan Monitor Service name in the ICommand command or in ICommand's configuration file.)

Because Plan Monitors only check for changes periodically, and because there is no coordination of timing among multiple Plan Monitors, be aware that there can be timing windows. Changes to Plans do not take effect instantly. For example, if a Plan is being monitored by one Plan Monitor and its settings are changed to a different Plan Monitor, then depending upon timing there can be a window wherein both Plan Monitors are running that Plan. You may need to stop the extra instance of the plan in the Administrator > Data Flow Service status using Request that a running Plan be stopped.

3.6.7 Using Multiple Enterprise Link Repositories

Each Plan Monitor uses a single Enterprise Link Repository. Each Plan Monitor can use a different repository regardless of which Data Flow Service it is connected to, because a single Data Flow Service can handle multiple Repositories.

The repository that a Plan Monitor uses is specified by name in the Plan Monitor configuration file. Repositories can be named in the Enterprise Link Admin Tool. If no name is given, the default repository is used.

<add key="PlanMonitor.PlanLibraryName" value="" />
<add key="PlanMonitor.PlanLibraryUser" value="BAM" />
<add key="PlanMonitor.PlanLibraryPassword" value="" />

3.6.8 Installing Plan Monitors on Multiple Hosts

The Oracle Business Activity Monitoring installation does not provide assistance for installing multiple Plan Monitors. It installs a single Plan Monitor with the service name Oracle BAM Plan Monitor.

When Plan Monitors are to run on multiple hosts, run the installation on each host, and then adjust each host as required using the following steps:

  1. Using the Oracle Business Activity Monitoring installation, install the default Plan Monitor. You must install at a minimum the following components:

    • Command-line utility

    • Enterprise Link Standard components

    • Enterprise Link Plan Monitor

  2. Using sc, installutil, or a similar Windows utility, uninstall Plan Monitor from the Windows services. The sc syntax is:

    sc <server> [command] [service name] <option1> <option2>...
    
  3. Edit the OracleBAMPlanMonitor.exe.config file and change the following settings:

    1. Change the value of the PlanMonitor.ServiceName setting to the new service name. This must be the same name to use when this Plan Monitor is installed as a Windows service. This name must be unique among all the Plan Monitors.

    2. Change the value of the PlanMonitor.MonitorPlansWithNoServicePreference setting as appropriate so that only one Plan Monitor has this option enabled.

    3. Change any other settings as appropriate to tailor the behaviors of the different Plan Monitors as needed. Note that changing settings is an advanced user operation. Great care must be taken if changing these options.

  4. Using sc, installutil, or a similar Windows utility, re-install the Plan Monitor executable (OracleBAMPlanMonitor) as a Windows service with the new name (must match the name from step 3a). The sc syntax is:

    sc <server> [command] [service name] <option1> <option2>...
    

    For example:

    sc  create "ORACLEBAMPLANMONITOR1" binpath= c:\oraclebam\oracleplanmonitor1.exe
    
  5. Edit the service properties to set the logon user appropriately and allow access to the Active Data Cache.

    See Also:

    "Plan Monitor Configuration File Entries" for an example of plan monitor configuration file contents

3.6.9 Installing Multiple Plan Monitors on a Single Host

When more than one Plan Monitor is to be run on a single host, do the following steps:

  1. Using the Oracle Business Activity Monitoring installation, install the default Plan Monitor. You must install at minimum the following components:

    • Command-line utility

    • Enterprise Link Standard components

    • Enterprise Link Plan Monitor

  2. Make copies of OracleBAMPlanMonitor.exe and OracleBAMPlanMonitor.exe.config and rename them to have different file names.

  3. Edit the new configuration files and change the following settings:

    1. Change the log file name from ELPlanMonitorService.log so that each Plan Monitor on this host has a unique log file name.

    2. Change the value of the PlanMonitor.ServiceName setting to the service name. This must be the same name to use when this Plan Monitor is installed as a Windows service. This name must be unique among all the Plan Monitors.

    3. Change the value of the PlanMonitor.Port setting so that each Plan Monitor on this host has a unique port number.

    4. Change the value of the PlanMonitor.MonitorPlansWithNoServicePreference setting as appropriate so that only one Plan Monitor has this option enabled.

    5. Change any other settings as appropriate to tailor the behaviors of the different Plan Monitors as needed. Note that changing settings is an advanced user operation. Great care must be taken if changing these options.

  4. Using sc, installutil, or a similar Windows utility, install the copies of the executables as additional Windows services (the names must match the names from step 3b).

  5. Edit the service properties to set the logon user appropriately and allow access to the Active Data Cache.

    See Also:

    "Plan Monitor Configuration File Entries" for an example of plan monitor configuration file contents

3.6.10 Plan Monitor Configuration File Entries

This section provides an example of the OracleBAMPlanMonitor.exe.config file:

<!-- PlanMonitor server configuration parameters -->
    
    <!-- This "ServiceName" should match the name used when the Windows Service was installed -->
    <add key="PlanMonitor.ServiceName" value="Oracle BAM Plan Monitor" />
    <!-- "Channel" should be either "tcp" or "http" -->
    <add key="PlanMonitor.Channel" value="tcp" />
    <add key="PlanMonitor.Port" value="4441" />
    <!-- Use "ServiceURL" only if it is necessary to override the standard internally-constructed URL -->
    <!--<add key="PlanMonitor.ServiceURL" value="tcp://machine:port/PlanMonitorRequests" />-->
    <add key="PlanMonitor.StatusInterval" value="30" />
    <!-- Valid values for PlanChangeDetectFrequency are "never", "once", or an integer greater than zero -->
    <add key="PlanMonitor.PlanChangeDetectFrequency" value="10" />
    <!-- Setting "MonitorPlansWithNoServicePreference" to nonzero means this service
         will monitor Plans that do not have a specific service name set.  Usually only
         one monitor for a given Repository should have this setting. -->
    <add key="PlanMonitor.MonitorPlansWithNoServicePreference" value="1" />
    <!-- An empty string for "PlanLibraryName" means use the default Enterprise Link Repository -->
    <add key="PlanMonitor.PlanLibraryName" value="" />
    <add key="PlanMonitor.PlanLibraryUser" value="BAM" />
    <add key="PlanMonitor.PlanLibraryPassword" value="" />
    <add key="PlanMonitor.ClearJournalOnStart" value="0" />
    <add key="PlanMonitor.StopPlansOnShutdown" value="1" />
    <add key="PlanMonitor.ADCConnect.RetryMax" value="5" />
    <add key="PlanMonitor.ADCConnect.RetryInterval" value="60" />
    <add key="PlanMonitor.PlanLibraryConnect.RetryMax" value="5" />
    <add key="PlanMonitor.PlanLibraryConnect.RetryInterval" value="60" />
    <add key="PlanMonitor.DFSConnect.RetryMax" value="5" />
    <add key="PlanMonitor.DFSConnect.RetryInterval" value="60" />
    <add key="PlanMonitor.DebugMode" value="0" />
    
    <!-- End of PlanMonitor server configuration parameters -->

3.6.11 Plan Monitor Client Configuration File Settings

This section provides an example of a plan monitor client configuration file. Examples of this file are ICommand.exe.config, Web.config, and OracleBAMEventEngine.exe.config.

<!-- PlanMonitor remote server parameters -->
    
<!-- Normally, use "ServiceName".  Use the other two groups only if necessary.
      It looks for the groups in the order they are shown here.
-->

<add key="PlanMonitor.ServiceName" value="Oracle BAM Plan Monitor" />

<!--
<add key="PlanMonitor.ServiceURL" value="tcp://localhost:4441/PlanMonitorRequests" />
-->

<!--
<add key="PlanMonitor.ServiceMachine" value="localhost" />
<add key="PlanMonitor.ServiceChannel" value="tcp" />
<add key="PlanMonitor.ServicePort" value="4441" /> 
--> 

<!-- End of PlanMonitor remote server parameters -->

3.7 Deinstalling Oracle Business Activity Monitoring

Note:

If you are deinstalling and reinstalling, you should create backup copies of any customized configuration files and database files, the Active Data Cache, and the Enterprise Link Repository (using SARPUTIL); deinstall older versions of Oracle Business Activity Monitoring; and then install the new version. Also make note of any Enterprise Link Data Flow Service settings prior to deinstallation. You must re-enter these settings after reinstallation.

To deinstall the Oracle Business Activity Monitoring applications:

  1. Ensure that you stop all Oracle Business Activity Monitoring services from running.

    You can stop the services from the Start menu or the Services Control Panel.

  2. Click the Start button, and click Control Panel.

  3. Double-click Add or Remove Programs.

    Note:

    When deinstalling Enterprise Link first insert the Oracle Business Activity Monitoring CD, start setup.exe in the EnterpriseLink directory, and click Cancel to cancel the install.
  4. Click each Oracle Business Activity Monitoring application that was installed, and click Remove.

    The Oracle Business Activity Monitoring applications are removed.

    See Also:

    • "Deinstalling Enterprise Link" if you need to troubleshoot Enterprise Link deinstallation errors

    • Oracle BAM Enterprise Link Utilities User's Guide for instructions on using SARPUTIL to back up the Enterprise Link Repository

  5. Remove files left in the C:\OracleBAM directory from the system.

    After removing the applications, files left in the C:\OracleBAM directory can be deleted. These may include backup configuration files, log files, and cached data.

  6. If you are reinstalling after deinstalling, use SQL*Plus to drop the Oracle Business Activity Monitoring and Enterprise Link database users (defaults orabam and orasagent).

    C:\> sqlplus
    SQL> drop user Oracle_BAM_User cascade
    SQL> drop user Oracle_EL_User cascade
    

    Where:

    • Oracle_BAM_User is the username for the Oracle Business Activity Monitoring user

    • Oracle_EL_User is the username for the Enterprise Link user

      Note:

      If you created a database user for the Enterprise Link Samples, you must also drop this user.

      Note:

      If you have installed Oracle Business Activity Monitoring and then deinstalled it, the deinstall does not remove the virtual directory. Before reinstalling Oracle Business Activity Monitoring you must open Microsoft Internet Information Services and manually remove the virtual directory.

3.8 Configuring Web Applications in a Web Farm

When setting up a Web farm, the configuration files for all Web Applications hosts must match. When installing each Web Applications server and specifying the Web Applications host name and the location of the various back-end services, use the same string (case sensitive).

3.9 Changing an Oracle Business Activity Monitoring Machine Host Name

You cannot change the host name of a computer on which Oracle Business Activity Monitoring components are installed. Instead, you must deinstall and reinstall the components after changing the host name. See "Deinstalling Oracle Business Activity Monitoring" for information about deinstalling Oracle Business Activity Monitoring.

3.10 Running Multiple Browsers with Active Reports

If multiple browsers are open and running active reports, the browsers can sometimes run out of connections to the server and stop responding. This might happen if you view an active report in Active Studio, then you receive an alert, and you open the report in Active Viewer by clicking the link. To increase the maximum number of connections, create one of the following registry settings on the client machine in the HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Internet Settings registry key:

For an HTTP 1.1 server, add the registry setting MaxConnectionsPerServer and set the DWORD value to 4.

For an HTTP 1.0 server, add the registry setting MaxConnectionsPer1_0Server and set the DWORD value to 8.

3.11 Creating a Connection from JDeveloper over SSL

To create a connection to Oracle Business Activity Monitoring from JDeveloper when Oracle Business Activity Monitoring is running over SSL you must do the following procedures.

Configure Oracle Business Activity Monitoring on SSL:

  1. Set up an HTTPS Service in IIS. See the following Microsoft document for more information.

    http://support.microsoft.com/kb/324069/en-us
    

    For more information also see

    http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/89c7ef2f-f7d6-483c-8b08-ae0c6584dd4d.mspx?mfr=true
    
  2. In the C:\OracleBAM\BAM\web.config file, add the following key and set the value to https:

    <add key="ApplicationProtocol" value="https" />
    
  3. Add the following key and set the value to the server internet address or IP address. If you are using a port number different from 80 or 443, you must add :portnumber to the address. Examples:

    <add key="ApplicationHostName" value="www.company.com" />
    <add key="ApplicationHostName" value="209.220.15.158" />
    <add key="ApplicationHostName" value="209.220.15.158:300" />
    
  4. In the OracleBAMEvent.exe.config file, set the value for the WebServerProtocol key to https.

    <add key="WebServerProtocol" value="https" />
    
  5. Open the Oracle Business Activity Monitoring start page using https:hostname:port/OracleBAM and make sure that all the application can be launched.

Configure BPEL and JDeveloper to talk to Oracle Business Activity Monitoring on SSL:

  1. Copy signed certificate (imported onto IIS) into <BPEL_HOME>\jdk\jre\lib\security dir and <JDev_HOME>\jdk\jre\lib\security directory.

  2. Before you import, run which keytool to confirm that you are using the correct keytool utility.

    Before importing to BPEL JDK, you must set your PATH to pick up the BPEL JDK's keytool.exe, and before importing to JDeveloper JDK, you must set your PATH to pick up JDeveloper JDK's keytool.exe. Import copied certificates into cacerts keystore using keytool both onto JDeveloper and BPEL.

    For example, to import signed certificate such as sumacert.cer into JDeveloper cacerts keystore, you should run the following command from <JDev_HOME>\jdk\jre\lib\security dir:

    keytool -import -file sumacert.cer -alias sumacert -keystore cacerts
    

    You can check the imported certificate by running the command

    keytool -list -keystore cacerts
    
  3. Restart JDeveloper and the BPEL server.

  4. Create a BAM connection from JDeveloper pointing to the BAM server on HTTPS and test the connection.

3.12 Additional Configuration Settings

This section describes optional configuration settings that you can choose to set depending on your preferences. It contains the following topics:

3.12.1 Using the Configuration Files

The configuration files are located in the OracleBAM_Home\BAM subdirectory (where OracleBAM_Home is the directory you specified during Oracle Business Activity Monitoring installation). Any new keys must be added inside the <appsettings> tag and the </appsettings> tag. You must restart the related service of the configuration file for the new setting to take effect. For example, restart the Event Service for changes to the OracleBAMEventEngine.exe.config file to take effect.

3.12.2 Configuring Firewall Settings

The Web Server HTTP port should be added to the firewall exceptions.

3.12.3 Working with Post-Install Password Changes and Password Expiration Policies

If passwords expire periodically (for example, every 90 days) store the database password in clear text in the OracleBAMActiveDataCache.exe.config file, and use Windows folder security to restrict file access.

In the OracleBAMActiveDataCache.exe.config file, set the OracleEncrypted key to False, and the OracleConnectionString value is changed to clear text. For example:

<add key="OracleConnectionString" value="Data Source=oraclebam;User ID=orabam;Password=orabam;" />

<add key="OracleEncrypted" value="False" />

The changes should be made not only in the OracleBAMActiveDataCache.exe.config file but others which contain these keys:

  • Adcversionchecker.exe.config

  • Cacheinit.exe.config

  • Icommand.exe.config

  • Morpheus.exe.config

If the password change is a one time event, rather than a regular event (that is driven by expiration policies), use pwencrypt.exe to update the configuration files.

  1. Open a command line window.

  2. Enter pwencrypt. The Password Encrypter dialog opens.

  3. In the dialog, enter the credentials:

    • User name: orabam

    • Password: orabam

    • Data source: oraclebam

  4. Click Save to .config file.

  5. Save to the following files:

    • Adcversionchecker.exe.config

    • Cacheinit.exe.config

    • Icommand.exe.config

    • Morpheus.exe.config

    • OracleBAMActiveDataCache.exe.config

  6. Start the Oracle BAM services.

3.12.4 Writing Alert History to the Event Log

Alert history displayed in Active Studio and Architect is truncated after 25 alerts. You can change a configuration setting to write the complete alert history to the Windows Event log.

In the OracleBAMEventEngine.exe.config file, set the value for the EventEngineAlertHistoryEventLogging key to true and restart the Event Service. The default value for this setting is false.

3.12.5 Additional Security Measure for the Active Data Cache

An information message displays in the Event Viewer when you start the Active Data Cache Service saying:

Starting unsecure server. Set Oracle BAM Security Server key to secure the server.

You can add a value in the OracleBAMActiveDataCache.exe.config configuration file to guarantee that the Active Data Cache client is authorized to talk to the Active Data Cache server. Add a string value for the BAMSecureServerKey that is specified in all of the configuration files. If the values do not match, calls from the client to the server are refused.

If you want to use existing configuration files from a previous version, the configuration key must be renamed to BAMSecureServerKey after upgrading to this version.

3.12.6 Adjusting the Data Returned Limit

You can adjust the default limit for data displayed in a view. In the OracleBAMActiveDataCache.exe.config file, set the value for the ADCMaxViewsetRowCount key and restart the Active Data Cache Service. The default value for this setting is 64,000 rows of data. Note that the higher you set this value, the more performance is impacted. In addition, the limit also applies when using the BAM Reader Transform on a report.

3.12.7 Increasing the Record Limit for E-mail

You can increase the number of rows allowed in a List, OWC, or Columnar report used in an e-mail attachment before a limit error displays. In the Web.config file, increase the value for the RecordsLimitForEmail key. The default value for this setting is 1000 rows. Attachments containing reports can become large since they include data compared to a report link that accesses the report and data. The Web.config file is located in the OracleBAM_Home\ BAM subdirectory (where OracleBAM_Home is the directory you specified during Oracle Business Activity Monitoring installation).

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.8 Disabling the Automatic Addition of Users

You can turn off the setting that automatically adds users in Administrator when they access Oracle Business Activity Monitoring Web applications for the first time. You may want to disable this setting to prevent unauthorized users from adding themselves as Oracle Business Activity Monitoring users if they obtain the URL.

In the Web.config file, set the value for the ADCAutomaticallyAddUsers key to false to disable the automatic addition of users. Set the value to true to enable the automatic addition of users.

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.9 Increasing the Server Thread Pools for More Users

If you have more than 25 concurrent users, you can increase the maximum number of threads allowed. Otherwise, an active data error can sometimes display. In the OracleBAMReportCache.exe.config file, set the value for the ReportCacheMaxThreadPoolWorkerThread key to 100. Adjust as necessary in increments of 25. Do not use allocate than 100 threads for each processor. Next, in the OracleBAMActiveDataCache.exe.config file, set the ADCMaxThreadPoolWorkerThread key to 100. The default value for both settings is 25.

3.12.10 Adjusting Plan Monitor Settings

In the OracleBAMPlanMonitor.exe.config file, you can adjust settings for the Plan Monitor behavior.

PlanMonitor.StatusInterval sets the number of seconds the Plan Monitor waits between each check of running Plans.

PlanMonitor.PlanChangeDetectFrequency sets the number of times the Plan Monitor checks the running Plans before it looks for changes to Plans.

For example, if PlanMonitor.StatusInterval is set to 10 and PlanMonitor.PlanChangeDetectFrequency is set to 3, the Plan Monitor checks running Plans approximately every 10 seconds, and checks for changes to Plans approximately every 30 seconds.

If these settings are too frequent, it can use large amounts of system resources. PlanMonitor.PlanChangeDetectFrequency is particularly costly if you have many Plans, because every time it checks, it must load all Plans in the repository and examine the Custom Plan Properties.

The PlanMonitor.ClearJournalOnStart setting controls whether the Journal is cleared on startup. When set to 0, the Plan Journal is not cleared on startup. When set to any other value, the Plan Journal is cleared on startup. The default value is 0.

See Also:

"Plan Setting Change Detection" for additional details

3.12.11 Using HTTPS Protocol

If you are using HTTPS, Hypertext Transfer Protocol over Secure Socket Layer, you must set the following configuration settings so that e-mail report links, copy shortcuts, and alert URLS work properly. These settings provide the correct parameters to create report URLs.

In the Web.config file, add the following key and set the value to https.

<add key="ApplicationProtocol" value="https" />

Then, add the following key and set the value to the server internet address or IP address. If you are using a port number different from 80 or 443, you must add :portnumber to the address.

<add key="ApplicationHostName" value="www.company.com" />

or

<add key="ApplicationHostName" value="209.220.15.158" />

or

<add key="ApplicationHostName" value="209.220.15.158:300" />

In the OracleBAMEventEngine.exe.config file, set the value for the WebServerProtocol key to https. The default is http.

<add key="WebServerProtocol" value="https" />

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.12 Configuring Oracle BAM When IIS Runs on Ports Other Than 80

If you configure IIS to run on a port other than 80 there are some additional configuration steps in Oracle BAM:

In the OracleBAMEventEngine.exe.config file change the WebServerName key value to include the port number:

<add key="WebServerName" value="SERVERNAME:PORT_NUMBER" />

In the Web.config file change the ApplicationHostName and the EventEngineServerName key values to include the port number:

<add key="ApplicationHostName" value="SERVERNAME:PORT_NUMBER" />

<add key="EventEngineServerName" value="SERVERNAME:PORT_NUMBER" />

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.13 Changing Windows Locale After Installation

It is recommended that the operating systems for all hosts be set to the same correct target locale before installing Oracle Business Activity Monitoring. However, if the Windows locale must be changed for an existing installation, you should stop all services on all hosts. Then, change all hosts to the new locale. Ensure that you check Apply all settings to the current user account and to the default user profile on the Advanced tab. Then, restart all services on all hosts.

Note:

All servers and clients running Oracle Business Activity Monitoring components must be set to the same locale.

3.12.14 Changing Culture Codes for Different Locales

If your host is running in a locale that does not match the default locale for the version of Windows that the product is running on, you must make additional changes to the Web.config file. This applies if you are running a different language version of Windows, such as running an English version of Windows in Germany. It also applies if you are running the same language, but with a different culture, such as running a German version of Windows in Switzerland.

If you want to override the locale setting make the following changes in the Web.config file:

In the line:

<!--globalization culture="en-US"/-->

Remove the comment characters and change the culture code:

<globalization culture="de-DE"/>

Any valid Language-Territory culture code is supported. A valid culture code consists of Language and Territory. Entering only de will not work.

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.14.1 Translations in Active Viewer

For the following Language-Territory codes, Active Viewer displays the appropriate language:

  • English, USA (en-US)

  • German, Germany (de-DE)

  • French, France (fr-FR)

  • French, Canada (fr-CA)

  • Italian, Italy (it-IT)

  • Spanish, Spain (es-ES)

  • Portuguese, Brazil (pt-BR)

  • Japanese, Japan (ja-JP)

  • Korean, Korea (ko-KR)

  • Simplified Chinese, China (zh-CN)

  • Traditional Chinese, Taiwan (zh-TW)

3.12.15 Batch Processing

To improve performance of batch processing, you can control the batching process (insert/update/delete/upsert) that is done in the Active Data Cache API.

You can also flush by demand, which means that the client of the Active Data Cache does not send the batch to the server when it is full or on a time out, but rather waits for the user to call flush.

In configuration files, you can add keys and values using the following syntax:

<add key="ActiveDataCache.Datasets.Batching.Inserts.Limit.Lower " value="800" />

In the OracleBAMELProxyMain.exe.config file the following settings can be added by following the syntax conventions:

  • ActiveDataCache.Datasets.Batching.Inserts.Limit.Lower (default is 1000)

  • ActiveDataCache.Datasets.Batching.Inserts.Limit.Upper (default is 5000)

  • ActiveDataCache.Datasets.Batching.Inserts.Timeout (default is 50 (msec))

  • ActiveDataCache.Datasets.Batching.Inserts.FlushOnDemand.Limit (default is 1000)

Change Inserts to Updates, Upserts, or Deletes to apply to them.

You can also limit the amount of pending calls (remote calls that have not returned yet) by setting:

ActiveDataCache.Datasets.Batching.PendingCalls.Limit (default is 10)

In the ReportCache .config file, there is an option to disable ViewSetSharing:

ViewSetSharing (defaults to true, which means ViewSetSharing is on).

3.12.16 Configuring the Oracle Database OPEN_CURSORS Value

OPEN_CURSORS specifies the maximum number of open cursors (handles to private SQL areas) a session can have at once. You can use this parameter to prevent a session from opening an excessive number of cursors. This parameter also constrains the size of the PL/SQL cursor cache which PL/SQL uses to avoid having to reparse as statements are reexecuted by a user.It is important to set the value of OPEN_CURSORS high enough to prevent your application from running out of open cursors. The number will vary from one application to another. Assuming that a session does not open the number of cursors specified by OPEN_CURSORS, there is no added overhead to setting this value higher than actually needed.

Setting the OPEN_CURSORS value at 400 is recommended.

3.12.17 Setting the Report Loading Indicator Default

To set the default behavior for the report loading indicator, edit the web.config file in OracleBAM_Home/BAM and edit the following element:

<add key="ReportLoadingSetting" value="off"/>

If ReportLoadingSetting value is off then it does not show report loading indicator. If ReportLoadingSetting value is on then it shows report loading indicator.

Note:

Restart Microsoft IIS after making changes to the web.config file.

3.12.18 Backing Up the Active Data Cache

The Active Data Cache database should be regularly backed up using your Oracle database tools. When performing backup and restore operations, make sure that the Active Data Cache Service is not running.

Do not directly edit the information in the Active Data Cache.