13 Managing the Analytics Service

This chapter describes how to configure and manage the Analytics service for WebCenter Spaces and for WebCenter Portal applications. The Analytics service enables you to display usage and performance metrics for WebCenter applications.

Always use Fusion Middleware Control or the WLST command-line tool to review and configure back-end services for WebCenter applications. Any changes that you make to WebCenter applications, post deployment, are stored in MDS metadata store as customizations. See Section 1.3.5, "WebCenter Configuration Considerations." Any changes that you make to Analytics Collector configuration are stored in the Analytics database.

The content of this chapter is intended for Fusion Middleware administrators who are responsible for setting up Oracle WebCenter Analytics, and configuring Analytics Collector details for WebCenter Spaces or WebCenter Portal applications.

13.1 What You Should Know About Oracle WebCenter Analytics

Analytics allows WebCenter administrators and business users to track and analyze portal usage. Analytics provides the following basic functionality:

The Analytics schema (ACTIVITIES) and the WebCenter schema can be installed on the same database or on separate databases.

13.3.2 Analytics - Configuration

The Analytics Collector is configured to receive events out-of-the-box, using installation defaults. If the default values are not suitable for your installation or you have a cluster, you may configure different values using WLST or MBeans Browser. For more details, Section 13.4, "Configuring Analytics Collector Settings".

Out-of-the-box, WebCenter Spaces is not configured to send events to the Analytics Collector. If you want to collect usage and performance metrics for WebCenter Spaces (or any WebCenter Portal application) you must register the Analytics Collector and enable event collection. For more details, Section 13.5, "Registering an Analytics Collector for Your Application". Once connected, analytics data is collected and displays in your application (through analytics task flows) without further configuration.

Alternatively, search for CollectorConfiguration or filter the System MBean Browser tree using the MBean pattern: oracle.webcenter.analytics:*

Figure 13-3 System MBeans Browser - Analytics Collector Properties

Modify configuration properties for the Analytics Collector. For details, see Table 13-3.

Table 13-3 Analytics Collector - Configuration Properties

Field

Description

BroadcastType

Specify the network channel on which the Analytics Collector broadcasts a 'heartbeat' to advertise its location to event producers. Valid values are Broadcast and Multicast:

Broadcast - use the standard network broadcast channel.

Multicast - use a special fixed multicast address.

CollectorHostName

Enter the name of the host on which the Analytics Collector is running.

The default setting is localhost.

CollectorDefaultPort

Enter the default port number on which the Analytics Collector listens. The default value is 31314.

CollectorMaximumPort

Enter the highest port number that an Analytics Collector can use when allocating a listener.

This property is mostly used in a clustered environment where multiple collectors run in the same box. Each collector listens for incoming UDP messages on a free port within a given port range. The range is from the default port number to the maxPort number.

ClusterEnabled

Specify whether the Analytics Collector is deployed in a cluster. Valid values are true and false. If set to true, clusterName must also be defined.

ClusterName

Enter the name of the Analytics Collector cluster. This property is only required when clusterEnabled=1.

The Analytics Collector periodically broadcasts a 'heartbeat' to advertise its location (CollectorHostname). In a clustered environment, WebCenter applications use the heartbeat to determine which Analytics Collectors are available.

13.5 Registering an Analytics Collector for Your Application

Events raised in WebCenter applications using OpenUsage APIs can be sent to an Analytics Collector for use by the Analytics service, Recommendations service, and the Activity Graph Engine. If your WebCenter application intends to use any of the features or task flows provided by these services you must connect the application to an Analytics Collector.

While you can register multiple Analytics Collector connections for a WebCenter application, only one Analytics Collector is used - the default (or active) connection.

To start using a new configuration you must restart the managed server on which the WebCenter application is deployed.

If the WebCenter application was recently upgraded, verify that the domain startup script does not contain legacy Analytics Collector settings as these values override any connection details that you specify through Fusion MIddleware Control or using WLST.

Shutdown the managed server on which WebCenter application is deployed.

Edit the domain startup script setDomainEnv located at:

UNIX: DOMAIN_HOME/bin/setDomainEnv.sh

Windows: DOMAIN_HOME\bin\setDomainEnv.cmd

Remove Analytics Collector settings.

Restart the managed server.

Scripting on this page enhances content navigation, but does not change the content in any way.