Customizing overlay reports | HCL Digital Experience
You can customize your own overlay reports by setting specific parameters as required. Learn about the parameters and the levels at which you can specify them.
The scheme described here applies to all parameters that are available for overlay reports.
Report parameters for customizing overlay reports
- metrics [page|portlet]
- You can specify metrics for the page only, for the portlets only, or for a page and all portlets on it:
- metrics
- This affects both page and portlet metrics.
- metrics.page
- This affects only page metrics.
- metrics.portlet
- This affects only portlet metrics.
For these parameters, specify a comma separated list of metrics that you want to show in the overlay report. Do not include spaces between the items in the comma separated list. Specify the metrics by their column ID. You can use all metrics that are available in an IBM® Coremetrics® Web Analytics trend report. The default value is SESSIONS,PAGE_VIEWS. Note that the type of the overlay reports is optimized for displaying two metrics. Specifying fewer than one or more than two metrics may yield unexpected display results. The list of applicable metrics depends on the type of your Coremetrics® account.
- granularity
- Specify the interval granularity of the displayed metrics. Specify
an uppercase letter. The default value is W for
weekly reports. Possible values are as follows:
- D
- Daily
- W
- Weekly. This is the default.
- M
- Monthly
- Q
- Quarterly
- Y
- Yearly
- numPeriods
- Specify the number of periods that you want to have reported.
This starts backwards from the value that you specify for the parameter
period_a
. Specify a numerical value larger than 1 . The default value is 4 . - period_a
- Specify the ending date for reports in the format YYYYMMDD .
Specify a valid date in the past. Reports will show data from this
date backwards, with the number of periods as specified by the parameter
numPeriods
and the granularity as specified by the parameter granularity . The default value isyesterday
; it is computed at the time of the HTTP request in the format YYYYMMDD .
Providing parameters at multiple levels
Level hierarchy | Specify the parameter at this level: | Prefix the parameter with the following string: | Configure the parameter at this layer: | Set this parameter by using the following method: |
---|---|---|---|---|
1 | HTTP request parameter | — | HTTP request | Custom code in the theme or skin |
2 | Portlet parameter - metadata | asa.report. |
portlet window | XML configuration interface |
3 | Portlet preference | asa.report. |
portlet | Portlet Edit mode, XML configuration interface |
4 | Page parameter - metadata | asa.report. |
page | Page Properties dialog, XML configuration interface |
5 | Portal Configuration Service parameter | asa.report. |
WP Config Service | WebSphere® Integrated Solutions Console |
6 | Default value | — | HCL Portal product code | N/A - product code. You cannot change this default value, but you can override it in the layers listed previously. |
Customization examples
- Example 1:
- Scenario: No configuration provided.
- Example 2:
- Scenario: Interval granularity is overridden on the page level.
- Example 3:
- Scenario: Interval granularity is overridden at request level.