Skip Headers
Oracle® Fusion Middleware Oracle WebCenter Analytics Installation and Upgrade Guide (for Oracle WebLogic Portal)
10g Release 4 (10.3.0.2.0)

Part Number E14440-07
Go to Documentation Home
Home
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 Installation

This chapter describes the steps you take to install Oracle WebCenter Analytics and its components, including granting user and group rights, running the installer, integrating Oracle WebCenter Analytics with the portal, coonfiguring the Oracle WebCenter Analytics database, configuring the Oracle WebCenter Analytics console, registering portal events, and starting Oracle WebCenter Analytics.

  1. Ensure you have completed pre-installation steps. For details, see Chapter 1, "Installation Prerequisites."

  2. Grant user and group access rights to Oracle Inventory directories. For details, see Granting User and Group Access Rights to Oracle Inventory Directories.

  3. Install the Analytics Console component on the remote server host computer. For details, see Installing the Analytics Console Component.

  4. Integrate Oracle WebCenter Analytics with the portal. For details, see Integrating Oracle WebCenter Analytics with Oracle WebLogic Portal.

  5. Configure the Oracle WebCenter Analytics database. For details, see Configuring the Oracle WebCenter Analytics Database.

  6. Configure Oracle WebCenter Analytics console using the Oracle WebCenter Configuration Manager. For details, see Configuring Oracle WebCenter Analytics Console.

  7. Register portal events. For details, see Registering Core and Portal Events.

  8. Install the Analytics Collector component and, optionally, cluster the BEA AL Analytics Collector service. For details, see Installing the Analytics Collector Component and Clustering the BEA AL Analytics Collector Service.

  9. Start Oracle WebCenter Analytics and portal services. For details, see Starting the BEA AL Analytics and BEA AL Analytics Collector Services.

Granting User and Group Access Rights to Oracle Inventory Directories

(Linux/UNIX only) Oracle Inventory contains files that provide the Oracle Universal Installer with the locations of the ORACLE_HOME directories on a particular machine. For Oracle Inventory to function properly, the user that installs Oracle WebCenter Analytics must have access rights to the directories that contain Oracle Inventory's files. This section describes how to run the ouais.sh shell script, which sets user and group access rights for these directories.

Note:

You do not need to perform this procedure if you are installing Oracle WebCenter Analytics on Windows.

To grant user and group access rights to Oracle Inventory directories:

  1. Log in to the remote server host computer as the root user.

  2. Copy the ouais.sh script to the machine onto which you will be installing Oracle WebCenter Analytics.

    This script is located in the same location as the Oracle WebCenter Analytics installer file.

  3. Change the current directory (cd) to be the directory to which you copied the ouais.sh script.

  4. Run the ouais.sh shell script.

    As arguments to the script, specify the user and group that will be running the Oracle WebCenter Analytics installer. For example, you would use the following command to run the ouais.sh script from the root shell:

    ./ouais.sh -u oracleuser -g oraclegroup
    

    The ouais.sh script creates the Oracle Inventory directory if it did not exist before you ran the script. Additionally, the script grants user and group ownership to the directories that contain the files that are used by Oracle Inventory.

Installing the Analytics Console Component

This section describes how to install the Analytics Console component, which includes the Analytics user interface and the BEA AL Analytics service. The instructions are the same for installing on a Windows, UNIX, or Linux host, with slight exceptions as noted. To install the Analytics Console component:

  1. Log in to the remote server host computer as the local administrator (on Windows) or a user with directory write privileges (on UNIX or Linux).

    Note:

    For UNIX and Linux installations, you must run the Oracle WebCenter Analytics installer as the user that you specified in the procedure Granting User and Group Access Rights to Oracle Inventory Directories. You specified the user who will run the product installer as an argument to the ouais.sh script.

  2. Copy the installer to the disk location from where you plan to launch it. The installer file is one of the following:

    • Windows: WebCenterAnalytics_WLP_10.3.0.1.0.exe

    • UNIX/Linux: WebCenterAnalytics_WLP_10.3.0.1.0

  3. Close all unnecessary applications.

  4. Execute the installer file.

  5. Complete the installation wizard pages as described in the following table and based on the computers you provisioned for your Oracle WebCenter Analytics deployment.

Table 3-1 Installation Wizard Pages - Analytics Console Component

Wizard Page Description

Choose Components

Choose Analytics Console.

Analytics Console - Installation Directory

The default is:

  • install_dir\ptanalytics (Windows)

  • install_dir/ptanalytics (UNIX and Linux)

Note: By default, install_dir is C:\bea\alui (Windows) and /opt/bea/alui (UNIX/Linux)

Analytics Persistence Library Update

Specify the path to the file containing the Hibernate 3.0.5 distribution.

Analytics Chart Library Update

Specify the path to the file containing the Cewolf 0.10.3 distribution.

Configuration Manager - Port and Password

This page is displayed if you chose to update Oracle WebCenter Configuration Manager's password and port information or if you are installing Oracle WebCenter Configuration Manager for the first time.

Type the port number on which you want Oracle WebCenter Configuration Manager to service requests.

By default, the port number is 12345. After running the installer, you will be able to access Oracle WebCenter Configuration Manager by using the following URL: https://localhost:port_number.

Also type and confirm the Administrator password that you will use to log into Oracle WebCenter Configuration Manager. The password is case-sensitive.

In Windows, the Oracle WebCenter Configuration Manager runs as the BEA AL Configuration Manager(port_number) service.

Pre-Installation Summary

Click Install to begin the installation. The installer copies the BEA AL Analytics service and core application files to the installation directory.

Note: The installer writes a log file to the directory where it is installed (for example: C:\bea\alui\installlogs). If you encounter problems during installation, examine the error messages in the log file.

Launch Configuration Manager

This installation wizard page lets you access Oracle WebCenter Configuration Manager to configure settings for the core Oracle WebCenter Analytics application. It is important that you perform these steps in the following order:

  1. Before launching Oracle WebCenter Configuration Manager, you must configure the Oracle WebCenter Analytics database, described in Configuring the Oracle WebCenter Analytics Database.

  2. Click the link on this installation wizard page to access Oracle WebCenter Configuration Manager.

    The default username for logging into Oracle WebCenter Configuration Manager is administrator. Use the password that you typed into the Configuration Manager - Port and Password installation wizard page.

  3. In Oracle WebCenter Configuration Manager, click the + symbol next to the Analytics Console application name to view its components.

  4. Configure all settings for all of the Analytics Console components based on the computers you provisioned for your Oracle WebCenter Analytics deployment.

    For information on the settings in the Configuration Manager, refer to the Configuration Manager online help or to Configuring Oracle WebCenter Analytics Console.

    Note: We recommend that you sync the clocks on the servers that run Oracle WebCenter Analytics and the portal before proceeding with configuration. If the clocks are not aligned, some events and sync jobs behave incorrectly.

  5. (Optional) Click LOGOUT in Oracle WebCenter Configuration Manager.

Application Settings Confirmation

Select Yes if you have completed configuration of the Oracle WebCenter Analytics settings.

Select No, configure later to complete the installer without configuring the Oracle WebCenter Analytics settings. You must run the Oracle WebCenter Configuration Manager and configure Oracle WebCenter Analytics settings before starting Oracle WebCenter Analytics.

Install Complete

Click Done to complete the Analytics Console component installation.


Install Apache Proxy or OHS

For security purposes, the host and port used to access the Oracle WebLogic Portal Administrative console must be the same as the host and port used to access the Oracle WebCenter Analytics server.

  1. Install Apache httpd or OHS.

  2. Add mod_wl_22.so to the apache/modules directory.

  3. Edit httpd.conf to include the following (replacing the variables appropriately for your deployment, so that the protocol, host, and port match those used to access Oracle WebLogic Portal Administrative console):

    LoadModule weblogic_module   modules/mod_wl_22.so
    <Location /portalAppAdmin>
    SetHandler weblogic-handler
    WebLogicHost localhost
    WebLogicPort port_number
    WLLogFile c:/temp/wl_proxy_portalAdmin.log
    RequireSSLHostMatch false
    DebugConfigInfo ON
    Debug ALL
    </Location>
    <Location /contentpresenter>
    SetHandler weblogic-handler
    WebLogicHost localhost
    WebLogicPort port_number
    WLLogFile c:/temp/wl_proxy_portalAdmin.log
    RequireSSLHostMatch false
    DebugConfigInfo ON
    Debug ALL
    </Location>
    <Location /analytics>
    SetHandler weblogic-handler
    WebLogicHost analytics_server.example.com
    WebLogicPort port_number
    WLLogFile c:/temp/wl_proxy_analytic.log
    RequireSSLHostMatch false
    DebugConfigInfo ON
    Debug ALL
    </Location>
    <Location /asmanager>
    SetHandler weblogic-handler
    WebLogicHost analytics_server.example.com
    WebLogicPort port_number
    WLLogFile c:/temp/wl_proxy_asmanager.log
    RequireSSLHostMatch false
    DebugConfigInfo ON
    Debug ALL
    </Location>
    <Location /imageserver>
    SetHandler weblogic-handler
    WebLogicHost analytics_server.example.com
    WebLogicPort port_number
    WLLogFile c:/temp/wl_proxy_imageserver.log
    RequireSSLHostMatch false
    DebugConfigInfo ON
    Debug ALL
    </Location>
    
  4. Edit analytics-config.xml to reflect the following (replace the serve name; you must use port 80):

    <reports-url>http://analytics_server.example.com:80/analytics/ui/console.jsf?EnterpriseAppName={url:enterpriseAppName}&WebAppName={url:webAppName}</reports-url>
    <admin-url>http://analytics_server.example.com:80/asmanager/ui/runtimemgr.jsf?EnterpriseAppName={url:enterpriseAppName}&WebAppName={url:webAppName}</admin-url>
    

Integrating Oracle WebCenter Analytics with Oracle WebLogic Portal

To integrate Oracle WebCenter Analytics with your Oracle WebLogic Portal, you must add Oracle WebCenter Analytics-specific facets to both your enterprise application and your web application. Additionally, you must edit the analytics-config.xml file, then deploy Oracle WebCenter Analytics. This section discusses:

  1. Adding the Analytics Facet to Your EAR Application

  2. Adding the Analytics Facet to Your Web Application

  3. Editing the analytics-config.xml File

These instructions assume that you already have configured a portal to integrate with Oracle WebCenter Analytics. For more information about Oracle WebLogic Portal projects, EAR applications, and portal web applications, see the Oracle Fusion Middleware Portal Development Guide for Oracle WebLogic Portal.

Adding the Analytics Facet to Your EAR Application

To add the Analytics facet to your EAR application:

  1. Launch Oracle Workshop for WebLogic.

    Open the workspace that contains the Oracle WebLogic Portal project for which you want to deploy Oracle WebCenter Analytics.

  2. In the Package Explorer view, right-click the EAR Project to which you want to add the Analytics facet, and choose Properties.

  3. Click Project Facets in the tree that is displayed in the left pane of the dialog.

  4. Click Modify Project.

    The Project Facets dialog appears.

  5. Expand and select the WebLogic Portal (Optional) check box.

    All the optional facets for Oracle WebLogic Portal are selected by default, including the WebCenter Analytics Integration facet. You can de-select facets you do not need, but leave the WebCenter Analytics Integration facet selected.

  6. Click Finish.

    The Project Facets dialog closes.

  7. Click OK.

    The Package Explorer view includes the new facet content.

Adding the Analytics Facet to Your Web Application

To add the Analytics facet to your web application:

  1. In the Package Explorer view, right-click the web project to which you want to add the Analytics facet and choose Properties.

  2. Click Project Facets in the tree that is displayed in the left pane of the dialog.

    The project facets associated with your web project appear in the table.

  3. Click Modify Project.

    The Project Facets dialog displays.

  4. Expand and select the WebLogic Portal (Optional) check box.

    All the optional facets for Oracle WebLogic Portal are selected by default, including the WebCenter Analytics Integration facet. You can de-select facets you do not need, but leave the WebCenter Analytics Integration facet selected.

  5. Click Finish to add the selected facet.

  6. Click OK.

Editing the analytics-config.xml File

To complete the Oracle WebCenter Analytics integration within your development environment, you need to edit the Oracle WebCenter Analytics configuration file. To do this, you must know:

  • The Analytics Administration URL.

  • The Analytics Reports URL.

  • The Open API Config fully-qualified domain name and port number.

To edit the configuration file:

  1. In Oracle Workshop for WebLogic, on the Merged Projects tab, navigate to the analytics-config.xml file in the navigation tree: //yourEAR/META-INF/templates/analytics-config.xml.

  2. Right-click the analytics-config.xml file and select Copy To Project.

  3. On the Project Explorer tab, navigate to the copied analytics-config.xml file: //yourEAR/EarContent/META-INF/analytics-config.xml

  4. Right-click the file and select Open With > Text Editor.

  5. Edit the analytics-config.xml file to match the configuration of your Oracle WebCenter Analytics environment.

    See below for a sample analytics-config.xml file that includes explanatory comments.

  6. Save the edited configuration file.

Sample analytics-config.xml File

<?xml version="1.0"?>
<analytics-config xmlns="http://www.bea.com/ns/portal/90/analytics-config">
<! -- Ensure that the enabled attribute is defined as "true". --!>
    <enabled>true</enabled>
<! -- When configuring Analytics to work with WebLogic Portal, you must use fully-qualified domain names (server.domain.com) when referencing Analytics Administration, the WebLogic Portal Administration Console, and the Analytics Configuration Tool when editing the XML configuration file. You cannot use IP addresses. --!>
<! -- Use the open-api-config element to define the fully-qualified domain name and port of the machine on which Analytics is installed. --!>
    <open-api-config>
        <host-name>work.bea.com</host-name>
        <port>31314</port>z
    </open-api-config>
<! -- In the reports-url element, replace work.bea.com with the fully-qualified domain name that you defined in the open-api-config element. --!>
<reports-url>http://work.bea.com:11944/analytics/ui/console.jsf?EnterpriseAppName={url:enterpriseAppName}&amp;WebAppName={url:webAppName}</reports-url>
<! -- In the admin-url element, replace work.bea.com with the fully-qualified domain name that you defined in the open-api-config element. --!>
<admin-url>http://work.bea.com:11944/asmanager/ui/runtimemgr.jsf?EnterpriseAppName={url:enterpriseAppName}&amp;WebAppName={url:webAppName}</admin-url>
<! -- Optionally, add references to WebLogic Portal property sets for collection of Analytics user profile information. User profile values for the referenced Property Set attributes will be collected on behalf of users when they log into a portal application and sent along for storage in the Analytics database. These profile values can then be used for report filtering in the Analytics Administration Console.
For more information about property sets, see the WebLogic Portal User Management Guide. --!>
<profile-property>GroupSpace:im_id</profile-property>
<profile-property>GroupSpace:phone_number</profile-property>
<profile-property>GroupSpace:first_name</profile-property>
<profile-property>GroupSpace:timezone</profile-property>
<profile-property>GroupSpace:email</profile-property>
<profile-property>GroupSpace:last_name</profile-property>
<profile-property>GroupSpace:title</profile-property>
</analytics-config>

Deploying Oracle WebCenter Analytics

Use the WebLogic Server Console to add the Analytics library to your production domain and ensure that it is deployed on every server within your cluster. The steps that you take and issues you need to consider might differ depending on the environment to which you are deploying Oracle WebCenter Analytics (deployment, staging, or production).

Example: Deploying Oracle WebCenter Analytics in a Production Environment

The following procedure provides an example of deploying Oracle WebCenter Analytics to a Oracle WebLogic Portal domain in a production environment:

  1. In Oracle Workshop for WebLogic, ensure that the server on which you want to run Oracle WebCenter Analytics is running.

    If you need to start the server, be aware that it will probably take a few minutes to complete the startup process. Wait until the server's state has changed to Started.

  2. In Oracle Workshop for WebLogic, deploy the EAR Project to the server that you ensured was running in Step 1.

  3. From the WebLogic Portal domain on which you wish to deploy Oracle WebCenter Analytics, run the WebLogic Server Administration Console.

    The default URL to access the WebLogic Server Console is: http://localhost:7001/console

  4. Log in to WebLogic Server Administration Console.

    The default username is weblogic; the default password is weblogic.

  5. In the Change Center section, click Lock & Edit.

  6. In the Domain Structure section, click Deployments. This displays a list of the deployed components.

  7. In the Summary of Deployments section, click the Control tab.

  8. Navigate to and select the portal EAR Project that you want to install.

  9. Click Install.

    The portal .EAR Project is installed.

  10. In the Install Application Assistant window, navigate to the location of the wlp-analytics-web-lib.war file and select it (WebLogic_Portal_Home/analytics/lib/j2ee-modules/wlp-analytics-web-lib.war).

  11. Click Next.

  12. Select Install this deployment as a library and click Next.

  13. On the Install Application Assistant page, make any configuration changes that are necessary.

    To access additional documentation for changing the configuration on this page, click the Help button on this page

  14. Click Finish.

  15. Optionally, verify that the library is deployed to the server.

    1. In the Deployments table, navigate to the library you just deployed.

    2. Click the name of the library to new its configuration.

    3. In the Targets tab, verify that the library is targeting the correct server(s).

    4. Click Save.

  16. In the Change Center section, click Activate Changes.

  17. Repeat steps 6-17 for to install the deployed wlp-analytics-app-lib.ear library.

Configuring the Oracle WebCenter Analytics Database

This section describes how to set up the Oracle WebCenter Analytics database. It contains the following sections:

Configuring the Oracle WebCenter Analytics Database on Microsoft SQL Server

To create and set up the Oracle WebCenter Analytics database on Microsoft SQL Server:

  1. On the machine to which you installed the Analytics Console component, copy the scripts from install_dir\ptanalytics\10.3.0.1\sql\mssql to the database host computer.

  2. In SQL Server Management Studio, access database engine's properties.

  3. Configure the database engine to use SQL Server and Windows Authentication mode.

  4. Restart the database engine.

  5. Create the Oracle WebCenter Analytics database user:

    1. Create the Oracle WebCenter Analytics database user.

    2. Configure the Oracle WebCenter Analytics database user to use SQL Server Authentication.

    3. Set the Oracle WebCenter Analytics database user password.

  6. Create the Oracle WebCenter Analytics database with the following properties:

    • Create a database.

    • Configure the size of the database. The growth of the database is directly correlated to the number of events present in the system. Events include such things as page views, portlet views, user logins, and discussion posts. Estimate 100 MB of growth per 1 million events. For example, if your portal receives roughly 1 million events per day, you should anticipate growth of 36.5 GB per year.

    • Change the default database for the Oracle WebCenter Analytics database user to the Oracle WebCenter Analytics database.

  7. Grant the Oracle WebCenter Analytics database user the db_owner role for the Oracle WebCenter Analytics database.

  8. Create the Oracle WebCenter Analytics database schema. Specify the Oracle WebCenter Analytics database user as the schema owner.

  9. Connect to the Oracle WebCenter Analytics database as the Oracle WebCenter Analytics database user, using SQL Server Authentication.

  10. Run the setup scripts for the database, located in the install_dir\ptanalytics\10.3.0.1\sql\mssql\ folder, in the following order (make sure that you are running the scripts on the Oracle WebCenter Analytics database):

    1. create_analytics_schema.sql

    2. install_analytics_data.sql

Configuring the Oracle WebCenter Analytics Database on Oracle

Notes:

  • If you are upgrading Oracle Database from 10.1.x to 10.2.x, you should perform this upgrade before upgrading Oracle WebCenter Analytics.

  • When running Oracle 11g versions prior to 11.1.0.7.0 the Oracle system parameter _optimizer_group_by_placement must be set to false. This can either be set in the init.ora file of the respective database instances or by issuing an ALTER SYSTEM command as follows:

    SQLPLUS /nolog
    CONNECT / AS SYSDBA
    ALTER SYSTEM SET "_optimizer_group_by_placement"=false
    

To create and set up the Oracle WebCenter Analytics database on Oracle:

  1. On the machine to which you installed the Analytics Console component, copy the \oracle directory from install_dir\ptanalytics\10.3.0.1\sql to the Oracle WebCenter Analytics database's host computer. This folder contains the scripts that you will use to set up and configure the Oracle WebCenter Analytics Oracle database.

  2. Log on to the host computer for the Oracle WebCenter Analytics database as owner of the Oracle system files.

  3. Execute the following steps as the system user in your Oracle database.

    1. Determine the name of the SID that you will be using for this installation. If you changed the SID from the default when you installed the portal, you need to update create_analytics_tablespaces.sql to reflect the SID that you used, substituting all occurrences of the default SID name with your SID name. The default SID name is BEAS.

      If you are creating a new SID, configure AL32UTF8 as the database character set and AL16UTF16 as the national character set.

    2. Run the script create_analytics_tablespaces.sql for your platform. This file is located in a platform specific subdirectory within the \oracle directory that you copied in Step 1.

    3. Run the script create_analytics_user.sql.

      Note:

      If you do not want the script to use the defaults when creating the Oracle database user and password, edit the script. The default user is analyticsdbuser; the default password is analyticsdbuser. The create_analytics_user.sql script is located in the \oracle directory that you copied in Step 1.

    4. Record the Oracle database user and password values (you will enter these values into Oracle WebCenter Configuration Manager when configuring Oracle WebCenter Analytics database settings).

  4. Execute the following steps as the analytics user that you just created.

    1. Run the script create_analytics_schema.sql. This script creates all of the tables and indexes that are necessary to run Oracle WebCenter Analytics. The create_analytics_schema.sql script is located in the oracle directory that you copied in Step 1.

    2. Run the script install_analytics_data.sql. This script adds all of the initial seed data that are necessary to run the Oracle WebCenter Analytics product. The install_analytics_data.sql script is located in the \oracle directory that you copied in Step 1.

  5. Run your database's analysis tool on the portal database to the efficiency of the database.

Configuring Oracle WebCenter Analytics Console

This section describes how to configure Oracle WebCenter Analytics Console.

Note:

  • We recommend that you sync the clocks on the servers that run Oracle WebCenter Analytics and the portal before proceeding with configuration. If the clocks are not aligned, some events and sync jobs behave incorrectly.

  • Different sets of component-specific configuration pages appear, depending on the components that you just installed.

To configure Oracle WebCenter Analytics Console:

  1. Open the Configuration Manager by opening the following location in a web browser: http://localhost:port_number. By default, the port number is 12345.

    To log in, use the default username, administrator and the password that you typed into the Configuration Manager - Port and Password installation wizard page.

  2. Configure all settings for all of the Analytics Console components based on the computers you provisioned for your Oracle WebCenter Analytics deployment. Click the + symbol next to the Analytics Console application name to view its components. For information on the settings in the Configuration Manager, refer to the Configuration Manager online help.

    • Configure Analytics Database Information

      • Analytics DB Vendor

      • Analytics DB Server Name

      • Analytics DB Port

      • Analytics DB Name (for Microsoft SQL Server) or Analytics DB SID (for Oracle)

      • Analytics DB Username

      • Analytics DB Password

    • Configure WLP Server Information

      • WLP Server URL

        Example: http://WebLogicPortal_Hostname:port/WLPAnalyticsSync

        WLPAnalyticsSync is defined in the weblogic-application.xml of the WLP application; the default is EARnameAnalyticsSync.

        Use the fully qualified domain hostname

  3. On the final page, click Finish.

Registering Core and Portal Events

You must register core and portal events if you want Oracle WebCenter Analytics to report on events that occur in the portal. To register core and portal events, run the following from the command line on the Oracle WebCenter Analytics host machine:

Updating Portal Elements

You must update portal elements, such as desktops, pages, and portlets. To register core and portal events, run the following scripts from the command line on the Oracle WebCenter Analytics host machine:

Installing the Analytics Collector Component and Clustering the BEA AL Analytics Collector Service

This section includes the following topics:

Installing the Analytics Collector Component

This section describes how to install the Analytics Collector component, which includes the BEA AL Analytics Collector service. The instructions are the same for installing on a Windows, UNIX, or Linux host, with slight exceptions as noted.

Note:

If you want to cluster the BEA AL Analytics Collector service, we recommend that you install each node in the cluster on a separate machine (one installation of the Analytics Collector component is one instance of the BEA AL Analytics Collector service. One instance of the BEA AL Analytics Collector service operates as one node in the cluster). For details on clustering the BEA AL Analytics Collector service, see Clustering the BEA AL Analytics Collector Service.

To install the Analytics Collector component:

  1. Log in to the remote server host computer as the local administrator (on Windows) or a user with directory write privileges (on UNIX or Linux).

  2. Copy the installer to the disk location from where you plan to launch it. The installer file is one of the following:

    • Windows: WebCenterAnalytics_WLP_10.3.0.1.0.exe

    • UNIX/Linux: WebCenterAnalytics_WLP_10.3.0.1.0

  3. Close all unnecessary applications.

  4. Execute the installer file.

  5. Complete the installation wizard pages as described in the following table and based on the computers you provisioned for your Oracle WebCenter Analytics deployment.

Table 3-2 Installation Wizard Pages - Analytics Collector Component

Wizard Page Description

Choose Components

Choose Analytics Collector.

Analytics Collector - Installation Directory

The default is:

  • install_dir\ptcollector (Windows)

  • install_dir/ptcollector (UNIX and Linux)

Note: By default, install_dir is C:\bea\alui (Windows) and /opt/bea/alui (UNIX/Linux)

Configuration Manager - Port and Password

This page is displayed if you chose to update Oracle WebCenter Configuration Manager's password and port information.

Type the port number on which you want Oracle WebCenter Configuration Manager to service requests.

By default, the port number is 12345. After running the installer, you will be able to access Oracle WebCenter Configuration Manager by using the following URL: https://localhost:port_number.

Also type and confirm the Administrator password that you will use to log into Oracle WebCenter Configuration Manager. The password is case-sensitive.

Pre-Installation Summary

Click Install to begin the installation. The installer copies BEA AL Analytics Collector service files to the installation directory.

Note: The installer writes a log file to the directory where it is installed (for example: C:\bea\alui\installlogs). If you encounter problems during installation, examine the error messages in the log file.

Launch Configuration Manager

Click the link to access Oracle WebCenter Configuration Manager. The default username for logging into Oracle WebCenter Configuration Manager is administrator. Use the password that you typed into the Configuration Manager - Port and Password installation wizard page.

In Oracle WebCenter Configuration Manager:

  1. Click the + symbol next to the Analytics Collector application name to view its components.

  2. Configure all settings for all of the components.

Online Help for these settings is available in the Oracle WebCenter Configuration Manager application.

Note: If this computer includes an installation of Oracle WebCenter Analytics Console, the settings you configured for Oracle WebCenter Analytics Console apply to this installation of Analytics Collector. Changes you make to the configuration settings for Oracle WebCenter Analytics Console affect the configuration settings for an instance of Analytics Collector installed on the same computer, and vice versa.

Application Settings Confirmation

Select Yes if you have completed configuration of the Oracle WebCenter Analytics Collector settings.

Select No, configure later to complete the installer without configuring the Oracle WebCenter Analytics Collector settings. You must run Oracle WebCenter Configuration Manager and configure Oracle WebCenter Analytics Collector settings before starting Oracle WebCenter Analytics.

Install Complete

Click Done to complete the installation.


Clustering the BEA AL Analytics Collector Service

(Optional) A Collector service cluster consists of multiple BEA AL Analytics Collector service nodes running simultaneously and working together to provide increased scalability and reliability. One instance of the BEA AL Analytics Collector service operates as one node in the cluster.

Note:

You do not need to perform these steps if you do not want to cluster the BEA AL Analytics Collector service.

To learn how clustering works, see Section 3.9.2.1, "How a Cluster Works."

To cluster the BEA AL Analytics Collector service:

  1. Configure Oracle WebLogic Portal to send events to the Oracle WebCenter Analytics Collector cluster. For details, see Configuring Oracle WebLogic Portal to Send Events to the Cluster.

  2. Configure the nodes in the BEA AL Analytics Collector service cluster. For details, see Configuring Nodes in a Cluster.

How a Cluster Works

This section describes how a BEA AL Analytics Collector service cluster works.

In an unclustered environment the producer is configured with the location of the collector, and all events are transmitted to that location. If the collector is unavailable, the producer will not be aware of this and will continue to transmit events regardless. In this configuration, multiple collectors and producers can still be set up in parallel, one collector per producer, all persisting to the same database.

Figure 3-1shows an example of a clustered Oracle WebCenter Analytics environment. In a clustered environment producers and collectors are configured with a cluster-specific channel name. Each collector periodically broadcasts a heartbeat with its location to the cluster-specific channel. The producer listens to the channel for these collector heartbeats, and when it hears one, adds the collector to its list of known collectors. When the producer needs to send an event it randomly selects a collector from its list and sends the event to that collector. If a collector stops (either being stopped purposefully or failing) it stops broadcasting a heartbeat. When the producer stops hearing the heartbeat it removes the collector from its list and stops sending events to that collector. If the producer does not hear any collector heartbeats it does not send any events.

Figure 3-1 Clustered Oracle WebCenter Analytics Environment

Description of Figure 3-1 follows
Description of "Figure 3-1 Clustered Oracle WebCenter Analytics Environment"

Configuring Oracle WebLogic Portal to Send Events to the Cluster

To configure Oracle WebLogic Portal to send events to the BEA AL Analytics Collector service cluster:

  1. Access Oracle WebCenter Configuration Manager on the machine on which Oracle WebLogic Portal is installed.

  2. Click the + symbol next to the Portal Service application name to view its components.

  3. Configure the following settings in the Analytics Communication component:

    • Confirm that the Enabled check box is selected in the Enable Analytics Communication area.

    • Click Enabled in the Use Clustering area.

    • Configure the following settings in the Cluster Communication area: Cluster name and Cluster node timeout period.

    Online help for these settings is available in the Oracle WebCenter Configuration Manager application.

Configuring Nodes in a Cluster

This section discusses how to configure nodes in a BEA AL Analytics Collector service cluster.

If you are configuring nodes of the BEA AL Analytics Collector service to use broadcast mode, IP broadcast packets are not automatically forwarded from one subnet to another. For this reason, you should configure each instance of the BEA AL Analytics Collector service to be in the same subnet as the application from which it receives events. This configuration ensures that the event-generating applications can successfully receive broadcast messages from the Collector service cluster. If you use virtualization software, we recommend that you configure nodes of the BEA AL Analytics Collector service to use broadcast mode.

Note:

  • Perform this procedure for each node in the cluster.

  • If this computer includes an installation of Oracle WebCenter Analytics Console, the settings you configured for Oracle WebCenter Analytics Console apply to this installation of Analytics Collector. Changes you make to the configuration settings for Oracle WebCenter Analytics Console affect the configuration settings for an instance of Analytics Collector installed on the same computer, and vice versa.

To configure a node in a BEA AL Analytics Collector service cluster:

  1. Ensure that you have installed the BEA AL Analytics Collector service on each machine that will host a node in the cluster.

    Note:

    We recommend that each instance of the BEA AL Analytics Collector service exist on a separate machine.

    For installation instructions, see Installing the Analytics Collector Component.

  2. Access Oracle WebCenter Configuration Manager on the BEA AL Analytics Collector service host.

  3. Click the + symbol next to the Analytics Collector application name to view its components.

  4. Configure the settings in the Analytics Database component.

  5. Configure the settings in the Clustering component.

    Note:

    The value for the Cluster name field should match the value set for the Cluster name field in the Portal Service application, Analytics Communication component of Oracle WebCenter Configuration Manager on the portal host. You configured this setting when you performed the procedure Configuring Oracle WebLogic Portal to Send Events to the Cluster.

  6. Configure the settings in the Logging component.

    Online help for these settings is available in the Oracle WebCenter Configuration Manager application.

Starting the BEA AL Analytics and BEA AL Analytics Collector Services

This section provides information on starting the BEA AL Analytics and BEA AL Analytics Collector services. Perform the procedure that is appropriate to your operating system.

Starting the BEA AL Analytics and BEA AL Analytics Collector Services on Windows

After you have installed all Analytics components:

  • Ensure that the BEA AL Analytics service has been started. From Windows NT Services, click Administrative Tools > Services; if the BEA AL Analytics service has not started, right-click it and choose Start.

  • Ensure that the BEA AL Analytics Collector service has been started. From Windows NT Services, click Administrative Tools > Services; if the Collector service has not started, right-click it and choose Start.

You can also start and stop these services using Oracle WebCenter Configuration Manager. Log in to Oracle WebCenter Configuration Manager using the user name Administrator and the password you specified during installation. Follow the instructions in Oracle WebCenter Configuration Manager to start the Analytics Console and Analytics Collector applications.

Starting the BEA AL Analytics and BEA AL Analytics Collector Services on UNIX and Linux

After you have installed all Analytics components:

  • Ensure the BEA AL Analytics service has been started: install_dir/ptanalytics/10.3.0.1/bin/analyticsd.sh start

  • Ensure the BEA AL Analytics Collector service has been started: install_dir/ptcollector/10.3.0.1/bin/collectord.sh start