# Administrator Guide

# Overview of Analytics

Analytics allows portal managers and business owners to track and analyze portal usage. Analytics provides the following basic functionality:

- Usage Tracking Metrics: Analytics collects and reports metrics of common portal functions, including community, portlet and document hits.
- Behavior Tracking: Users of Analytics reports can analyze portal metrics to determine usage patterns, such as portal visit duration and usage over time.
- User Profile Correlation: Users of Analytics reports can correlate metric information with user profile information. Usage tracking reports can be viewed and filtered by user profile data such as country, company or title.
- Custom Event Tracking: Portal Administrators and developers can register custom portal and non-portal events that are sent to Analytics using the OpenUsage API. Event data is saved to the Analytics database, which can then be queried for reporting to a portal or non-portal application.

Note: | You must understand star schema database concepts in order to use Analytics’ custom event tracking features.

## Components of Analytics

Analytics is comprised of the following components:

Figure 2-1 Analytics Architecture

## Overview of Analytics Components

The following table describes the components that are delivered with Analytics. For a list of ports used by Analytics, see Installation and Upgrade Guide for BEA AquaLogic Analytics.

Table 2-1 Analytics components
Component | Description
--- | ---
Interaction Analytics component | The Interaction Analytics component gathers portal usage tracking metrics. It is installed on the same server that hosts the portal. For details on installing the Interaction Analytics component, see Installation and Upgrade Guide for BEA AquaLogic Analytics.
OpenUsage API | The OpenUsage API sends the following metrics to the BEA AL Analytics Collector service via UDP: Portal usage tracking metrics. Custom portal and non-portal events. For details on using the OpenUsage API, see the document Using the AquaLogic Analytics OpenUsage API at dev2dev.bea.com/pub/a/2006/08/openusage-analytics.html
Analytics Query API | Facilitates communication between external applications and Analytics. For more information on using the Analytics Query API, see http://download.oracle.com/docs/cd/E13183_01/en/alui/analytics/docs25/AquaLogicAnalytics_QueryAPI_2-5/
Analytics Console | The Analytics Console component includes the Analytics user interface and the BEA AL Analytics service, and is installed on a stand-alone server. The BEA AL Analytics service provides Analytics data to the end user through the Analytics Console or portlets that are created from Analytics portlet templates. For details on installing the Analytics Console component, see Installation and Upgrade Guide for BEA AquaLogic Analytics.
Analytics Collector component | The Analytics Collector component includes the BEA AL Analytics Collector service. The BEA AL Analytics Collector service receives data from the Interaction Analytics component and gathers data from the portal database through the AquaLogic Interaction Development Kit (“IDK”). The BEA AL Analytics Collector service can be clustered to provide increased scalability and reliability. For details on installing the Analytics Collector component and clustering the BEA AL Analytics Collector service, see Installation and Upgrade Guide for BEA AquaLogic Analytics.
Image Service component (not shown in diagram) | Provides the Image Service with the necessary files to run Analytics. For details on installing the Image Service component, see Installation and Upgrade Guide for BEA AquaLogic Analytics.
Analytics Automation Jobs component (not shown in diagram) | Provides the Automation Service with the necessary jobs to synchronize Analytics with the portal. For details on installing the Analytics Automation Jobs component, see Installation and Upgrade Guide for BEA AquaLogic Analytics.
Analytics database | The Analytics database provides storage for metrics that are gathered from custom portal and non-portal events. For details on configuring the Analytics database, see Installation and Upgrade Guide for BEA AquaLogic Analytics.

## Overview of AquaLogic Interaction Components

Analytics is designed to integrate with the AquaLogic Interaction portal. When Analytics is installed, a number of administrative objects, activity rights, and the Analytics Administration Utility are created in the portal.

The following table describes the AquaLogic Interaction components that are used by Analytics.

Table 2-2 Summary of AquaLogic Components
Component | Description
--- | ---
Portal Database | The portal database stores portal objects, such as user and group configurations, document records, and administrative objects. The portal database does not store the documents available through your portal. Source documents are left in their original locations. For information on setting up the portal database, see the Installation and Upgrade Guide for BEA AquaLogic Interaction.
Administrative Portal | The administrative portal handles portal setup, configuration, and content. It enables administrative functions, such as creating and managing portlets and other web services. For information on installing the Administrative Portal, see the Installation and Upgrade Guide for BEA AquaLogic Interaction.
Portal | The portal serves end user portal pages and content. It enables end users to access portal content via My Pages, community pages, the Knowledge Directory, and search. The portal also enables some administrative actions, such as setting preferences on portlets or managing communities.. For information on installing the portal, see the Installation and Upgrade Guide for BEA AquaLogic Interaction.
Image Service | The Image Service serves static content used or created by portal components. It serves images and other static content for use by the AquaLogic User Interaction system. Whenever you extend the base portal deployment to include additional components, such as portal servers or integration products, you may have to install additional Image Service files. For information on installing the Image Service files for those components, refer to the documentation included with the component software. For information on installing the Image Service, see the Installation and Upgrade Guide for AquaLogic Interaction.
ALUI Directory Service | The ALUI Directory Service enables AquaLogic Interaction to act as an LDAP server, exposing the user, group, and profile data in portal database through an LDAP interface.This enables other ALUI products (and other third-party applications) to authenticate users against the portal database.
Automation Service | The Automation Service runs jobs and other automated portal tasks. You run jobs to perform tasks such as crawling documents into the Knowledge Directory, synchronizing groups and users with external authentication sources, and maintaining the search collection. For information on installing the Automation Service, see the Installation and Upgrade Guide for AquaLogic Interaction.
API Service | The API Service provides access to the SOAP API. For information on installing the API Service, see the Installation and Upgrade Guide for AquaLogic Interaction.