Skip Headers
Oracle® Real User Experience Insight User's Guide
Release 6.0.1 for Linux x86-64

Part Number E16359-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 Working With the Data Browser

This chapter explains the use of the Data browser. This is at the heart of RUEI, and provides direct access to the information gathered during monitoring. Through it, you can drill down, search, and filter information in an intuitive and user-friendly manner.

3.1 Introducing the Data Browser

The information shown in each report is derived from a multi-dimensional data structure that contains all the information captured during monitoring. Through this structure, you can explore Web data by simply clicking down through increasing levels of detail, and view by different dimensions (such as period, referrer, visitor type, and so on). This data structure can be viewed through the Data browser tab.

You can use the Data browser to understand the context of the data shown in a report, and to drill down, rank, sort, and filter information to gain insight into causes, effects, and trends. To open the Data browser from within a report, select the Browse option from the report menu. To open the Data Browser from elsewhere, click the Browse data tab. A window similar to one shown in Figure 3-1 appears:

3.1.1 The Data Browser Toolbar

The toolbar icons at the top of the Data browser screen are shown in Figure 3-2, and are described in Table 3-1:

Figure 3-2 Data Browser Toolbar

Description of Figure 3-2 follows
Description of "Figure 3-2 Data Browser Toolbar"

Table 3-1 Data Browser Icons

Icon Description
Description of barcharticon.gif follows
Description of the illustration barcharticon.gif

Graph.

Displays the standard graphic visualization (pie chart, line chart, or bar chart) for the data. The graphic form depends on the underlying data.

Description of barrcharthorizicon.gif follows
Description of the illustration barrcharthorizicon.gif Description of piecharticon.gif follows
Description of the illustration piecharticon.gif

Additional visualizations.

In addition to the standard graphical visualization, depending on the underlying data, additional visualizations may be available, and can be selected by clicking the appropriate icon.

You can also use the Type option from the Graph menu to select a visualization.

Description of valuelisticon.gif follows
Description of the illustration valuelisticon.gif

Values.

Shows the underlying data values for the data in the browser. See Section 3.3, "Working With Value Lists" for more information about working with value lists.

Description of rightgreenarrow.gif follows
Description of the illustration rightgreenarrow.gif Description of leftgreenarrow.gif follows
Description of the illustration leftgreenarrow.gif

Previous and Next page.

Use these controls to move between pages in the displayed data set.

Description of informscreenicon.gif follows
Description of the illustration informscreenicon.gif

Glossary.

Provides a brief explanation of the metrics currently shown within the Data Browser. This includes both the dimensions shown in the graph or values table, and any filters that have been applied to it. The use of filters is explained in Section 3.6, "Working With Filters".

Description of searchicon.gif follows
Description of the illustration searchicon.gif

Search.

Allows you to search for strings within in the currently displayed data set. The use of the search facility is described in Section 3.4, "Searching in the Data Browser".

Description of zoomin.gif follows
Description of the illustration zoomin.gif Description of zoomout.gif follows
Description of the illustration zoomout.gif

Zoom in and Zoom out.

Allows you to change the level of displayed detail. When zooming in and out, you change the dimension of the viewed data. The new dimension depends on the currently selected dimension. For example, if you are viewing yearly data, zooming in will change the view to a monthly one. If you are viewing client location by country, zooming in will change the displayed dimension to providers within the client location country.

To quickly return to the original dimension, select Reset view from the View menu.

Description of openasreporticon.gif follows
Description of the illustration openasreporticon.gif

Open as report.

Opens a new window with the currently shown data in report print layout mode. The creation and customization of reports is described in Chapter 2, "Working With Reports."

Description of exporticon.gif follows
Description of the illustration exporticon.gif

Open as export.

Opens a new window in which you can further customize the currently shown data prior to exporting it to a wide variety of applications (such as Microsoft Excel). This facility is described in Section 3.7, "Exporting Data".

Description of addtodashboardicon.png follows
Description of the illustration addtodashboardicon.png

Add to dashboard.

Adds the current view to a selected dashboard. This facility is described in Section 1.7.4, "Adding a Data Browser or KPI View to a Dashboard".


3.2 Understanding the Data Structure

The information available within the Data Browser is divided across groups. At the highest level, there are two types of groups: application-related groups and services-related groups. Each group provides a number of perspectives, or views, on the collected data. These views can be selected from the View selection panel, located on the left-hand side of the Data Browser window (Figure 3-1).

Each main group within the View selection panel relates to a broad category of information. There are groups available about the pages visited on the monitored Web environment, visitor sessions, transactions, failed URLs and pages, and key pages.

Within each of these groups, sub-groups offer information about a specific aspect of the selected category. More specifically, they offer information across specific dimensions. These dimensions are indicated in the name of the sub-group. For example, within the All sessions group, views are available across the dimensions domain, period, user ID, and client browser, language, location, and operating system. This is shown in Figure 3-3:

Figure 3-3 Data Structure Selection Panel

Description of Figure 3-3 follows
Description of "Figure 3-3 Data Structure Selection Panel"

Individual views are grouped according to a standard classification (failure, performance, overall, and size) that reflects the type of information they provide. Within these, you can select the active dimension you want to use to explore the underlying data.

In addition to the standard dimensions discussed in this section, it is also possible to extend the information available within the Data Browser through the use of custom dimensions. These are described in Section 3.8, "Working With Custom Dimensions".

The Session diagnostics facility is described in Section 3.9, "Working With the Session Diagnostics Facility".

3.2.1 Real-Time and Session-Based Data

Within RUEI, two types of information are available: information derived from all active sessions detected during a 5-minute period, and information derived from finished (closed) sessions. Each of these are described in the following sections.

Active Sessions-Derived Information

Nearly all information reported in RUEI is based on the open (active) sessions detected within a 5-minute period. There are three exceptions to this: the All transaction group, and the reporting of multiple-day periods within the All sessions group. These are discussed in the next session.

Be aware that the properties reported for a session within the 5-minute period, such as IP address and user ID, are effectively snapshots taken at the end of the 5-minute period. While the value of these properties can potentially change during the 5-minute period, it is their values at the end of the period that are reported.

Closed Sessions-Derived Information

Information reported within the All transactions groups, as well as for multiple-day periods within the All sessions group, is derived from finished (closed) sessions. As a result, this information has a delay associated with it. The delay arises from the defined session idle time. This specifies the period of inactivity after which a visitor session is regarded as terminated. By default, this is 15 minutes.

As a result of how this information is derived, it is not possible to drill-down to the level of 5-minute intervals. In addition, imagine a visitor session starting at 9 AM, and finishing at 5 PM. The session is active throughout the day, except for lunch, from 12 AM to 1 PM. This session would normally be reported as one session. However, within the All transactions groups, as well as for multiple-day periods with in the All sessions group, it would be reported as two sessions because of the inactive period.

Why are There Sometimes Differences in Reported Data?

It is possible that small differences arise between the data reported for a single-day period and a multiple-day period. For example, the number of reported visitors in the All pages view for a day may be slightly different to that reported for the same day when viewed within a two-day period in the All session view. In order to understand why these differences arise, it is necessary to understand how data for a single day and for a multiple-day period is processed.

Note that the total number of reported sessions between a single-day period and a multiple-day period can differ. In order to prevent, you should ensure that the specified session idle time matches that of the monitored application.

3.2.2 Problem Analysis Groups

The Problem analysis category of views (shown in Table 1-3) provides, for applications, in-depth information about failing or problematic page views and hits. It contains the following views:

  • Failed URLs

    Reports on the objects (hits) within failed pages. For example, those pages that contain broken images and unavailable downloads. Note that it logs a maximum of 5000 objects per 5-minute period. All technical errors (described in Appendix E, "Explanation of Failure Codes") for that object are reported. Because this view is does not use application information, it can still report possible reasons for failed pages when no applications have been configured.

  • Failed pages

    Reports on the server, network, Web site, and content errors experienced with application pages.

  • Slow URLs

    Reports on the slowest 5000 objects per 5-minute period detected by the system, based on the object's end-to-end time. Note that objects must have an end-to-end time of at least five seconds to be reported in this view. Applications do not need to be configured for this view.

For services, it contains the following view:

  • Failed functions

    Reports on the server, network, Web site, and content errors experienced with function calls.

Note:

The period for which information about failed URLs, pages, and service calls is available is determined by the Reporter system's data retention policies. These are described in Section 9.6.1, "Defining Reporter Retention Policies".

3.2.3 Page Delivery Dimension

The page delivery dimension is available within the Failed pages, All pages, Key pages views, and reports which errors have been detected on a monitored Web site. All errors reported in the page delivery dimension are also available through the Session diagnostics replay facility (see Section 3.9, "Working With the Session Diagnostics Facility").

Note if a page or object experienced several types of errors (for example, both a network and a Web service error), the page or object error is not recorded multiple times. Instead, it is reported according to the following order: Web site, server, network, and content. For example, an object that experienced both a Web site and a network error, is recorded as a Web site error rather than a network error.

The errors reported in this dimension are also available as the basis for KPIs as metrics expressed both as counters and percentages. This is shown in Figure 3-4.

Figure 3-4 Page Availability Metrics

Description of Figure 3-4 follows
Description of "Figure 3-4 Page Availability Metrics"

3.2.4 The URL Diagnostics Group

Hit-based information is available via the Failed URLs and Slow URLs groups. These groups contain extensive information about images and other static objects, as well as dynamic objects. As a result, the URLs reported in these groups can contain a large amount of session and unique information (such as user IDs and any identifiers shared between different objects). An additional consideration is that these groups are limited to 5000 objects per 5-minute interval. This can make it difficult to isolate the specific hit-related information within a reported URL.

The URL diagnostics group is specifically orientated towards the separate recording of dynamic objects within pages (such as portlets and frames). Instead of reporting the literal URLs associated with particular hits, the URL diagnostics group reports functional URLs. These are customizable reporting schemes where session and unique information is typically stripped from the reported URLs. The information available within this group enables you to access dynamic server-interacting URLs independently of pages. This approach has the advantage that relevant hit-based information is more quickly located. For example, you could specify that you are only interested in the monitoring of Java or PHP-based calls. This is supplemented by a powerful clickout facility that provides dedicated support for Java diagnostic utilities, such as CAMM and AD4J.

The configuration of URL diagnostics is specified at application level, and is described in Section 6.2.15, "Controlling Reporting Within the URL Diagnostics Group". Note that URL diagnostics information about suites is available within suite diagnostic groups (described in Section 3.2.5, "Suite Groups").

The context menu for a URL allows you to clickout to the configured external utilities. An example is shown in Figure 3-5.

Figure 3-5 URL Diagnostics Group

Description of Figure 3-5 follows
Description of "Figure 3-5 URL Diagnostics Group"

CAMM and AD4J Clickout Support

Oracle Composite Application Monitor and Modeler (CAMM) is a utility that allows you to monitor highly distributed Java EE and SOA applications running within an organization. Using it, application bottlenecks, performance trends, and overall application efficiency can be quickly identified. Oracle Application Diagnostics for Java (AD4J) is part of the Oracle diagnostics pack for Oracle middleware, and provides low-overhead monitoring and diagnostics functionality to improve Java application availability and performance.

The ability to clickout from RUEI to external diagnostics utilities provides critical insight into the internal calls used to generate hits, and the relevant Java layer methods employed within the Web server. An example of a clickout to AD4J from a selected URL is shown in Figure 3-6.

Figure 3-6 Example URL Clickout to AD4J

Description of Figure 3-6 follows
Description of "Figure 3-6 Example URL Clickout to AD4J"

The procedure for configuring external utilities for clickout from within RUEI is described in Section 7.7, "Configuring Clickouts to External Utilities".

3.2.5 Suite Groups

The suites category of views (shown in Table 1-3) provides in-depth information about the operation of monitored suites. The availability of individual suite groups depends on the accelerator packages installed on your RUEI installation. In addition, at least one suite must be configured for each suite to be available.

For each installed and configured suite, a diagnostics group is available that provides for the suite the equivalent information available for applications through the URL diagnostics group. Note that, unlike applications, the scheme used to report suite URLs diagnostics is preconfigured, and cannot be modified.

A major difference between the two type of suite groups is that session-related information is only available through suite groups, and not through suite diagnostics groups. In addition, session-related information is primarily reported through suite groups.

3.3 Working With Value Lists

When working with value lists, you can add additional columns to the displayed list. Select Show percentage or Show growth from the Values menu to add indicator columns to the displayed data. Note that availability of these options depends on the currently viewed list, and the columns are also carried forward when you view the list as a report (by selecting Open as report from the View menu).

3.3.1 Changing the Sort Order

You can also change the sort order by selecting a column header at the top of the Values list. The view changes to reflect the selected column sorted in ascending order. Click it again, and the sort order becomes descending. The order symbol within a column heading indicates the current order. An example is shown in Figure 3-7:

3.3.2 Inclusive and Exclusive Filters

Within value lists, you can also right click items to open the context menu shown in Figure 3-8:

Figure 3-8 Values Context Menu

Description of Figure 3-8 follows
Description of "Figure 3-8 Values Context Menu"

The following options are available:

  • Select value: adds the selected value as an inclusive filter to the Filters panel. That is, only values that match the selected value are displayed in the browser.

  • Exclude value: adds the selected value as an exclusive filter to the filters panel. That is, only values not matching the selected value are displayed in the browser.

3.4 Searching in the Data Browser

You can use the Search facility to locate the incidence of strings in the currently displayed data set. This is shown in Figure 3-9.

The search facility will try to match any search pattern you specify either as a full match or as a substring. Hence, the search pattern "fire" will match the occurrences of "firefox", "x-fire", and "sefirewall", as well as, of course, all occurrences "fire". As mentioned earlier, the search is restricted to the currently displayed data. To extend the search further, you will need to modify the current view, or remove applied filters, and repeat the search. If the search did not find any matches, a pop-up dialog informs you that "No results were found".

Note:

The search facility does not support the use of wildcard characters (such as *). All characters are treated as literals. The results list is a values list and has the same functionality (see Section 3.3, "Working With Value Lists").

3.5 Sorting Data

To sort data in a graphic visualization, select the corresponding dimension from the legend beneath the graph. This is shown in Figure 3-10:

For information on sorting within a value list, see Section 3.3.1, "Changing the Sort Order".

In addition, you can use the Sorting option within the Data menu to undo any specified sorting specifications (Remove sorting), or swap the current sorting specification (Invert sorting).

3.6 Working With Filters

You can use the Filter panel at the top of the Data Browser window to tighten the profile of the information you want to view. An example is shown in Figure 3-11:

Figure 3-11 Example Filter Panel

Description of Figure 3-11 follows
Description of "Figure 3-11 Example Filter Panel"

The first item shown in the Filter panel is always the date or period for which information is required. In the example shown in Figure 3-11, this is the year period 2007. This can be thought of as the highest-level filter, and can be changed through the calendar (explained in Section 2.4, "Using the Calendar").

After that, additional filters can be set. There are two kinds of filters: inclusive and exclusive. Inclusion filters specify that only data items that match the data value in the filter should be shown. Exclusive filters specify that only data items that do not match the data value in the filter should be shown.

For example, the filter profile in Figure 3-11 specifies that only information should be displayed for the year 2007 in which the client location was Liechtenstein, and the client browser was not Firefox.

3.6.1 Defining Filters

You can define any data item within the Data Browser window as a filter by right clicking it to open the menu shown in Figure 3-8. After you have defined a filter, you are free to modify it by clicking it and using the context menu shown in Figure 3-12:

Figure 3-12 Filter Context Menu

Description of Figure 3-12 follows
Description of "Figure 3-12 Filter Context Menu"

The following options are available:

  • Invert: changes an inclusive filter into an exclusive filter, and vice versa.

  • Mark as report filter: the use of this option is described in Section 3.6, "Working With Filters".

  • Remove: deletes the selected filter.

    Note:

    Filters are applied in the order in which you define them. Once defined, it is not possible to change the order in which they appear in the Filter panel. To re-order them, you must remove and redefine them in the required order.

3.6.2 Working With Multiple Filters

Within value lists, you can select multiple values by clicking the Multiple section command button, and then clicking each required value outside of the its associated link. The selected item(s) are then highlighted. An example is shown in Figure 3-15.

Figure 3-13 Multiple Value Selection

Description of Figure 3-13 follows
Description of "Figure 3-13 Multiple Value Selection"

After selecting the required values, you can use the toolbar at the bottom of the screen to specify whether the values should be inclusive or exclusive filters. You can also use the toolbar to invert all currently defined filters, or to remove them.

3.6.3 Using Report Filters

Report filters can be used with reports that you create from the Data Browser. When you specify a report filter for information you include in a report, the user opening the report can use the defined filter when viewing the report's contents.

For example, if you are viewing client location information (via the All sessions groups, and the client-location sub-group), you could create a report that allowed its users to select on client location. To define the filter, do the following:

  1. Select a value from the displayed list of locations, and define it as a filter.

  2. When displayed in the filter panel, right click it, and select Mark as report filter from the menu. An example is shown in Figure 3-14:

    Figure 3-14 Example Report Filter

    Description of Figure 3-14 follows
    Description of "Figure 3-14 Example Report Filter"

    Note:

    Only one report filter can be defined for each dimension. However, it is possible to define multiple report filters across different dimensions. Care should be taken when designing reports with multiple filters because it can make the report difficult to view.
  3. Select Open as report from the View menu, and finalize the structure of the required report. Notice that the selected filter is now shown within the report. An example is shown in Figure 3-15:

    Figure 3-15 Report With Filter

    Description of Figure 3-15 follows
    Description of "Figure 3-15 Report With Filter"

  4. Highlight the filter by placing the mouse pointer over it, and select Edit filter type from the menu. A dialog similar to the one shown in Figure 3-16 appears:

    Figure 3-16 Edit Filter Type(s) Dialog

    Description of Figure 3-16 follows
    Description of "Figure 3-16 Edit Filter Type(s) Dialog"

  5. Use the check box(s) shown in the Edit filter type(s) dialog to control which filters can be selected by a user when the report is run. There will be a check box for each defined report filter. When ready, click Apply.

  6. Save the report, as described in Section 2.9, "Creating New Reports".

Running the Report

When the report is opened, and a report filter has been enabled, the value selected as the report filter becomes the default selection in a list of dimension values. An example is shown in Figure 3-17:

Figure 3-17 Report Using a Filter

Description of Figure 3-17 follows
Description of "Figure 3-17 Report Using a Filter"

3.7 Exporting Data

You can export the data currently shown in the Data Browser to a wide variety of applications, such as spreadsheets. To start working with export data, open the Export window by clicking the Open as export icon, or selecting Open as export from the View menu. A new window with the current data is opened. An example is shown in Figure 3-18:

Figure 3-18 Export Window

Description of Figure 3-18 follows
Description of "Figure 3-18 Export Window"

3.7.1 Modifying the Exported Data

The Export window (Figure 3-18) shows the raw data that is available for export. However, you can customize how the data should be exported. To do so, right click within the export window, and select Edit. A dialog similar to the one shown in Figure 3-19 appears:

Figure 3-19 Customize Export Dialog

Description of Figure 3-19 follows
Description of "Figure 3-19 Customize Export Dialog"

This dialog allows you to modify the order of data columns, the order in which values appear in those columns, and specify additional columns that will appear in the Microsoft Excel export.

Within the Data columns and Value columns fields, you can use the lists to add additional primary (index) columns, and the data columns that should appear within them. The exact selection of data and value columns that are available within each list depends on the view group with which you are working. For example, if you are viewing data from the All clients group, the selection of Web site/page data columns is limited to domain and Web site. However, if you are working in All pages group, additional data columns are available for such things as page-content and page-transaction. For a complete description of the data and value columns that are available for export within each view group, see Appendix D, "Summary of Data Items."

The Percentage check box allows you to specify whether an additional column, showing the percentage make up from the reported values, is added to the Microsoft Excel export.

The Growth check box allows you to specify whether an additional column, showing the actual increase in the reported metric, is added to the Microsoft Excel export.

You can use the Up, Down, and Remove icons next to a data column selection to control the sort order hierarchy, or to remove a data column as an index to the data. Similarly, you can use these controls within the value column field to rearrange the order in which they appear in the export.

You can save the export to a new or existing file, or append it to an existing export.

3.7.2 Selecting the Export Format

In addition to controlling how the exported data will appear, you can also specify the format in which the data will be exported. To do so, select the Download menu. The following export formats are available:

  • Comma-separated values (CSV).

  • Tab-separated values (TSV).

  • Microsoft Excel (2000 compatible) worksheets.

  • Webquery format.

Be aware that the exported data is in Unicode (UTF-8) format.

3.8 Working With Custom Dimensions

Custom dimensions allow you to add your own user-defined dimensions to views in the Data Browser. These new dimensions are then also available for use within KPIs, as well as reports and exports. For example, you might want to add a dimension "supplier" so that you could more easily track and analyze your organization's suppliers. Using this facility, you could determine which suppliers have the highest conversion rates associated with them within key business operations, or which suppliers attract the most pageviews on the organization's Web site.

Note:

Custom dimensions can be page, session, or function-based. Because KPIs are based on real-time data, session-based custom dimensions cannot be used as metrics within KPIs. However, page-based custom dimensions can be used as KPI filters.

Reporting of Custom Dimensions

Each custom dimension has a unique name, and is page, session, or function-based. This determines the Data Browser groups within which it is reported and, as explained in the following section, how dimension information is preserved between pageviews. The reporting of custom dimensions within Data Browser groups is highlighted in Table 3-2.

Table 3-2 Reporting of Custom Dimensions Within Data Browser Groups

Source All pages Key pages All sessions Failed pages Failed URLs Slow URLs All functions Failed functions (named) Suite URL diagnostics All transactions

Page

X

X

 

X

X

X

   

X

X

 

Page (session aware)

X

X

 

X

X

X

   

X

   

Session

 

X

X

X

X

X

       

X

Function

           

X

X

     

Be aware that when reviewing live session-based custom dimension information (that is, during the same day as the session), the reported user name can change. When viewing the same information the following day (after the session has been completed), the reported user name is based on the last one detected during the session.

Preserving Dimensional Information

As previously explained, the entity (page, session, or function) upon which a custom dimension is based, determines how information within the dimension is preserved between pageviews. This section provides a detailed explanation of how the selected scheme effects the reporting of custom dimension information. This is based on the presentation of example visitor sessions. Each example session refers to a monitored Web site containing a sales catalog. To capture information about which collections within the catalog visitors are viewing, a custom dimension with three levels is defined. These three levels are derived from three arguments: a, b, and c.

When a custom dimension is specified as page-based, the values shown in Table 3-3 are reported.

Table 3-3 Page-Based Custom Dimension Information Retention

Input Dimension level
 

1 (a)

2 (a » b)

3 (a » b » c)

a=men

men

men » none

men » none » none

a=men, b=coats

men

men » coats

men » coats » none

a=men, b=coats, c=winter

men

men » coats

men » coats » winter

a=men, b=hats

men

men » hats

men » hats » none

a=men, b=hats, c=trilby

men

men » hats

men » hats » trilby

a=children

children

children » none

children » none » none


Notice that when using this scheme, only the information available within the current pageview is used when reporting on the custom dimension levels. No information is inherited from previous pageviews.

When a custom dimension is specified as page (session aware)-based, the values shown in Table 3-4 are reported.

Table 3-4 Page (Session Aware)-Based Custom Dimension Information Retention

Input Dimension level
 

1 (a)

2 (a » b)

3 (a » b » c)

a=men

men

men » none

men » none » none

(a=men,) b=coats

men

men » coats

men » coats » none

(a=men,) (b=coats,) c=winter

men

men » coats

men » coats » winter

(a=men,) b=hats

men

men » hats

men » hats » none

(a=men,) (b=hats,) c=trilby

men

men » hats

men » hats » trilby

a=children

children

children » none

children » none » none


Notice that now when custom dimension level information is not available on a pageview, the information is inherited from the previous pageview. This inheritance is indicated with the use of brackets. The information between the brackets is not available in the current pageview, and so is derived from the previous pageview.

When a custom dimension is specified as session-based, the values shown in are Table 3-5 are reported.

Table 3-5 Session-Based Custom Dimension Information Retention

Input Dimension level
 

1 (a)

2 (a » b)

3 (a » b » c)

b=coats

none

none » coats

none » coats » none

b=coats, c=winter

none

none » coats

none » coats » none

c=winter

none

none » none

none » none » winter

......

none

none » none

none » none » none


Notice that no inheritance occurs for custom dimension information. In addition, be aware that only one pageview can be reported using this scheme. This is the first pageview for which custom dimension information is available. In this case, that is the first page in the viewing history (none » coats » none). All custom dimension information on other pageviews is discarded.

Translations for Custom Dimensions

Optionally, you can also define a set of translations for each unique source value reported for the dimension. For example, you could define the service-based custom dimension "server ID" with the associated translations shown in Table 3-6:

Table 3-6 Example Custom Dimension Translations

Value Translation

178349

Business Partnerships

561808

Newsletter and Events

405969

Catalog

969533

Payment Handling


Defining Custom Dimensions

To define a custom dimension, do the following:

  1. For function-based custom dimensions, select Configuration, then Services, and then Custom dimensions. For application-based custom dimensions, select Configuration, then Applications, and then Custom dimensions. A list of the currently defined custom dimensions appears. A maximum of five page or session-based custom dimensions can be defined. For function-based custom dimensions, the maximum is 10. Click the New dimension command button. The a dialog similar to the one shown in Figure 3-20 appears.

    Figure 3-20 New Custom Dimension

    Description of Figure 3-20 follows
    Description of "Figure 3-20 New Custom Dimension"

  2. Specify a unique name for the new dimension. Note that in displays (such as within the Data Browser or a report) that feature the defined custom dimension, the dimension's name is appended with an asterisk (*).

  3. Use the Based on menu to specify the entity type upon which the dimension should be based. For function-based dimensions, this is automatically selected as function, and cannot be modified. For application-based dimensions, you can selected this to be page, page (session aware), or session. The use of these options is explained in a previous section. Note a maximum of five page or session-based custom dimensions, and a maximum of 10 function-based custom dimensions, can be defined.

  4. Use the Number of levels menu to specify the level of dimension information that should be retained. By default, only one level of information is retained for the defined custom dimension. However, you can use this facility to build a hierarchy of retained session information. For example, you might want to capture information about the user's location using the three levels of country, region, and city.

  5. Within the displayed Level tabs, specify a name for the dimension level. Use the Source type menu and Source value field to specify the scope of the search for the dimension, and whether the search should use an XPath expression, a header, the cookie, a URL argument (request), or a custom tag or function. More information about using XPath queries is available in Appendix B, "Cookie Structures". Note if the source is a URL argument, the raw (original) input is used. However, in the case of an HTTP header, only ASCII input is allowed. Non-ASCII characters are replaced by an underscore (_) character when reported. For more information encoding support, see Appendix B, "Cookie Structures".

    If the custom tag or custom function options are selected, the tag or function name must be specified within the Source value field. Note that, in the case of a custom function, only the first parameter is used, and it must be enclosed in single or double quotes. For example:

    wiViewState('wi_menu_main_menu');
    

    More information about how custom tags and functions are interpreted within pages is available in Appendix A, "Tagging Conventions".

    When ready, click Save. An overview of the defined custom definition (similar to the one shown in Figure 3-21) appears.

    Figure 3-21 Custom Dimension Overview

    Description of Figure 3-21 follows
    Description of "Figure 3-21 Custom Dimension Overview"

  6. Optionally, you can also define a set of translations for each unique source value reported for the dimension. To do so, click « Add new translations ». The dialog shown in Figure 3-22 appears.

    Figure 3-22 Add Translation

    Description of Figure 3-22 follows
    Description of "Figure 3-22 Add Translation"

    Specify the required source value and its translation. When ready, click Save.

Note that if the list of imported translations is very large, you can use the controls in the toolbar at the bottom of Figure 3-21 to scroll through the displayed list. In addition, you can use the search facility to locate a required translation. The search string can be specified in terms of either a source value or a translation. The use of wildcard characters (such as *) is not supported, and all characters are treated as literals.

Importing Lists of Translations

Instead of separately defining each translation, you can click the Upload list icon within the toolbar (at the bottom of Figure 3-21) to import a file containing a list of translations. The dialog shown in Figure 3-23 appears.

Figure 3-23 Upload Custom Dimension Translations

Description of Figure 3-23 follows
Description of "Figure 3-23 Upload Custom Dimension Translations"

Use the Browse button to locate and select the required file. Optionally, use the File encoding menu to specify the file's character encoding. For more information on international character set support, see Appendix B. If an unsupported encoding is encountered, or the transcoding fails, an error is reported.The file may only contain one translation per line, with source values and translations tab separated. When ready, click Merge.

Note:

You can also use the custom dimension facility to redefine the functionality of standard dimensions.

Fallback Values Reported For Custom Dimensions

Within custom dimensions, two fallback values can be reported:

3.8.1 Removing Custom Dimensions

To remove a custom dimension, do the following:

  1. For application-based dimensions, select Configuration, then Applications, and then Custom dimensions. For function-based dimensions, select Configuration, then Services, and then Custom dimensions. A list of the currently defined custom dimensions appears. Right click the required custom dimension, and select Remove from the menu.

  2. If the custom dimension is used as a filter in a KPI or a report, you are warned that deleting the custom dimension also results in the deletion of the associated KPI or report. Click Yes or No.

3.9 Working With the Session Diagnostics Facility

Session diagnostics provides a powerful facility for Application Managers and IT technical staff to perform root-cause analysis of operational problems. It supports session performance breakdown, including the impact of failing pages, hits, and functions on sessions, the full content of each failed page, and the relationship between objects, pageviews, and sessions.

When problems are identified, session diagnostics offers a means to drill-down into RUEI's rich data structure and both assess the impact of the problem on your Web site's visitors, and obtain direct insight into possible causes.

The Error Recording Facility

In addition to the information described above, RUEI also offers the opportunity to track exactly what error messages visitors to the monitored Web site receive and when. With this ability to recreate application failures, you can accurately and immediately eliminate annoying and problematic parts of your Web pages.

Understanding Session Reporting

Information about user sessions is reported within the Session Diagnostics facility as user records. It is important to understand that information is reported using a resolution of five minutes. The properties associated with it, such as IP address and user ID, are effectively snapshots taken at the end of the 5-minute period. Note that while the value of these properties can potentially change during the 5-minute period, it is their values at the end of the period that are reported.

Using the Diagnostics Facility

To locate the diagnostics information you require, do the following:

  1. Select Browse data, and select the group from which you want to start. Diagnostics information is available from within the All sessions group, the Failed URLs, pages, and functions groups, as well as the accelerator-specific groups (such as Oracle E-Business Suite and Siebel). Click the required diagnostics option. Note the name of the option reflects the selected group. For example, Page diagnostics or URL diagnostics. A diagnostics panel similar to the one shown in Figure 3-24 appears.

    Figure 3-24 Session Diagnostics Panel

    Description of Figure 3-24 follows
    Description of "Figure 3-24 Session Diagnostics Panel"

  2. Use the Calendar controls (described in Section 2.4, "Using the Calendar") to select the required period. The selected viewing range must be a single day (or less). If you attempt to search outside this limit, an error is reported. The availability of replay content is determined by the associated Collector retention policies (described in Section 9.6.2, "Defining Collector Data Retention Policies"). When ready, click Search. The results of the search are shown in the main part of the window. An example is shown in Figure 3-25.

    Figure 3-25 Session Diagnostics Window

    Description of Figure 3-25 follows
    Description of "Figure 3-25 Session Diagnostics Window"

  3. You can use the controls in the toolbar at the top of the window to scroll between result pages. A maximum of 100 user records are listed per page. You can select a specific user record from the displayed list by clicking it, or use the search facility to further restrict the displayed list.

    To use the search facility, specify a search pattern, and click Go. The specified search pattern must refer to the user's IP address or (in the case of the sessions and pages) to the user's ID. Note that the search's scope is restricted to the currently displayed user records, the search uses partial matching, and the use of wildcard characters (such as *) is not supported. All characters are treated as literals. You can also use the extensive search capabilities available within the View selection facility.

    Note that you can select the Export session option from the user record context menu shown in Figure 3-25. The use of this facility is described in Section 3.9.3, "Exporting Full Session Information".

  4. After selecting a user record, the View part of the panel in the left-hand side of the window allows you to view information about the selected user record. Use the Pages, Object, and Info items under the Session part to view information concerning specific aspects of the selected user record. An example is shown in Figure 3-26.

    Figure 3-26 Example Diagnostics Panel

    Description of Figure 3-26 follows
    Description of "Figure 3-26 Example Diagnostics Panel"

    Session pages are grouped so that when expanded their associated objects can be viewed. The overview shows the pages (and their times) recorded within the selected user record. Icons indicate slow or failed objects, page loading satisfaction, whether the pages are transaction or key pages, and whether replay content for them is available. The use of the Replay viewer is described in Section 3.9.1, "Replaying User Sessions".

    Note you can use the Include/Exclude spurious objects command button within the toolbar to control whether hits not directly associated with a reported page are included in its displayed list of objects. This facility is particularly useful in the identification of problem objects that have an extremely long load time. Normally, these objects would not have associated pages and, therefore, would not be listed in the session page report.

    The Export session pages command button within the toolbar allows you to export a summary of the currently selected session to Microsoft Excel. The use of this facility is explained in Section 3.9.2, "Exporting Session Pages to Microsoft Excel".

  5. You can click the Pages or Objects option under the Content part of the panel to review a summary of pages viewed by the visitor or the objects within them. An example is shown in Figure 3-27.

    Figure 3-27 Example Page Properties Dialog

    Description of Figure 3-27 follows
    Description of "Figure 3-27 Example Page Properties Dialog"

    Within the displayed page history, the full page content, as well as the underlying HTML code of the messages received by the server and client are also available. Be aware that the reported contents are subject to the currently defined masking options for HTTP protocol items. Detailed application and session-related information about the page or URL is available via the Info option. An example is shown is shown in Figure 3-28.

    Figure 3-28 Example Session Information

    Description of Figure 3-28 follows
    Description of "Figure 3-28 Example Session Information"

  6. When ready, you can click the Remove icon beside the selected user record. You are returned to the diagnostics window shown in Figure 3-25. From here, you can select and drill down into other user records.

Masking Sensitive Information Within Session Diagnostics

As mentioned earlier, the availability of information (such as header or URL information) within the Session Diagnostics facility can be controlled through the appropriate HTTP protocol item masking facility. This is described in Section 8.4, "Masking User Information".

3.9.1 Replaying User Sessions

When available, you can click the Replay icon beside a viewed page to replay the complete user session. This provides the opportunity to review each page viewed by the visitor during the session, together with any reported error messages. An example is shown in Figure 3-29.

Figure 3-29 Example Session Replay

Description of Figure 3-29 follows
Description of "Figure 3-29 Example Session Replay "

The replay details are shown in a new window which is the same size as the main window. Note that when selected from the main Session Diagnostics window (shown in Figure 3-25), the complete session page history is available on the left-hand side of the Replay window. However, if selected by clicking the Replay icon for a page within a selected user record, the displayed page history starts from the point of the selected page.

The controls below the page listing allow you to navigate through the page history. The Page information section indicates the currently highlighted page's loading satisfaction, whether it is key page, whether it is used in a transaction, and whether it contains an error.

Reporting Page Events

If a viewed page contained HTTP form elements, these and the visitor replies are reported in the Page events panel. Unnamed elements are reported as "NO_NAME_number" (where number is incremented for each unnamed element). Hidden form elements are also reported. Be aware that the replies made by a visitor to form elements is derived from the request body of the next page in the session page view history. Therefore, if the visitor switched context to another page between the request and response pages, the user response cannot be extracted and reported.

The status bar at the bottom of Figure 3-29 provides information about the session user ID, each page's recorded timestamp, loading time, number of objects and (in the case of static pages) an indication that reported pages are retrieved from the live source (such as the application server).

Viewing Page Content

The HTTP content command button on the toolbar allows you to view the actual request and response content of the currently selected page. An example is shown in Figure 3-30.

Figure 3-30 Example Page Content

Description of Figure 3-30 follows
Description of "Figure 3-30 Example Page Content"

Note that external JavaScript files can also be viewed by clicking the link within the page content. The reported content of these files is retrieved from the live source (for example, an application server).

Viewing Static Page Content

If no Replay icon is available beside a page in the displayed viewing history, this indicates that the page's contents are not available.This can be because the information is expired due to data storage constraints, or because the viewed page was a static page. In the case of the latter, you can still view the static page's content by highlighting the page immediately before or after the static page in the viewing history, and via this page, view the static page's content.

Be aware that the reported content for the static page is retrieved from the live source. Hence, if the live source is not available for any reason, the page's content cannot be reported. In addition, data masking and JavaScript execution rules are not applied to any page contents retrieved from the live source. The page contents are shown "as is". Finally, be aware the reported page contents reflect the live source's current content. Therefore, depending upon the configuration of the monitored Web site, this may have been modified since the visitor actually viewed the page. For example, a page listing current stock market prices. When live source data is reported, this is indicated in the Replay status bar.

JavaScript Execution Within the Replay Viewer

Pages viewed by visitors can contain inline JavaScript code. The application definition facility allows you to specify how execution of this JavaScript code should be handled within the replay facility. This is fully described in Section 6.2.16, "Controlling JavaScript Replay Execution". In addition, be aware that suites (such as Siebel and PeopleSoft) have preconfigured JavaScript execution rules that optimize their reporting within the Replay viewer.

3.9.2 Exporting Session Pages to Microsoft Excel

You can export a summary of the pages within the currently selected session to Microsoft Excel. To do so, do the following:

  1. Select the required session using the procedure described earlier. Click the Export session pages command button. Depending on how your browser is configured, you are either prompted to specify the tool with which to open the file directly (by default, Microsoft Excel), or it is immediately saved to the defined default location.

  2. Within Microsoft Excel, you can view and edit the generated file. An example is shown in Figure 3-31.

    Figure 3-31 Example Microsoft Excel Session Pages Export

    Description of Figure 3-31 follows
    Description of "Figure 3-31 Example Microsoft Excel Session Pages Export"

The exported page view history and session summary can be used to compile sets of real-user sessions. For example, to be used as the basis for testing or performance analysis.

3.9.3 Exporting Full Session Information

In addition to viewing session information, you can also export complete session contents to external utilities for further analysis or integration with other data. For example, this offers the opportunity to use complete real-user sessions as the basis for test script generation. Test platforms, such as Oracle Application Testing Suite (ATS), can easily be configured to generate automated test scripts for an application's most commonly encountered usage scenarios.

In addition, this facility can also be used to support powerful root-cause analysis. Complete user session information can be provided to application or operations specialists to help identify unusual or difficult to isolate issues. Sensitive information within the exported data is masked according to the actions defined in the HTTP protocol item masking facility. This is described in Section 8.4, "Masking User Information".

To export session information, do the following:

  1. Locate the required session and select the Export session option from its context menu. This is shown in Figure 3-32.

    Figure 3-32 User Record Context Menu

    Description of Figure 3-32 follows
    Description of "Figure 3-32 User Record Context Menu"

    Alternatively, within the Replay facility, select the Session menu, and then select the Export session option. In either case, a dialog appears prompting you to confirm exportation of the selected session.

    It is important to understand that the exported data may contain sensitive information. It is recommended that you carefully review the session's contents to ensure that sensitive information has been correctly masked. To confirm export of the selected session, click Yes.

  2. Depending on how your browser is configured, you are either prompted to specify the location to which the zip file should be saved, or it is immediately saved to the defined default location.

Understanding the Structure of the Exported Data

The exported session zip file contains the following files:

  • data.tab: contains the direct (raw) hit information for the selected session extracted from the Collector log file.

  • content_hitno.tab: contains the complete (raw) content information for the indicated hit. There is a file for each hit within the data.tab file that has content. For example, if the third and sixth hits had content available for them, two files would be created: content_3.tab and content_6.tab. An example of a hit file is shown in Figure 3-33.

    Figure 3-33 Example Hit Information File

    Description of Figure 3-33 follows
    Description of "Figure 3-33 Example Hit Information File"

    The first line within the file (in this case, 589 68 313 221) contains four integers that indicate respectively the length (in bytes) of the request header, the request body, the response header, and the response body. In addition, note how the user's password has been masked in the file.

Note:

The log files used as the basis for creating exported session files are also used internally by RUEI. The format and contents of these files is subject to change without notice.