Configure a page overlay
Page overlays are configured only in the Site application, but they can be configured for other applications.
For information about configuring page overlay for another application, contact Adobe Consulting Services.
The page overlay visualization is a tool for HTML link analysis. When you request an overlay for a particular page, Data Workbench takes a snapshot of the actual page as it would appear in a web browser and parses the HTML code that represents links according to a list of regular expressions that you define. For each link on the selected page, the software attempts to find a regular expression pattern match by working down the list until the first match is found. If there is a match, the link appears highlighted in the page overlay.
Page overlay shows data only when you add a color legend to the workspace containing the page overlay.
Configuring page overlay requires careful configuration work, and it is possible to create misleading results if links are inappropriately mapped to the data. The work involved in configuring page overlay for a specific site depends on how links are presented within the HTML code on the site’s pages.
Page overlay, by its nature, suggests to the user the mental model that it displays “where people click.” If the data backing the visualization does not match this model, the potential for confusion is high.
In Site, a link typically represents an element from the Next URI or Next Link dimension, but you can map a link to any dimension that makes sense for your analysis. For information about configuring page overlay for other dimensions, contact Adobe Consulting Services.
Using the Page dimension for page overlay is not recommended. Users can rename the elements of the Page dimensions, thereby altering the link syntax on which the page overlay functionality relies.
To configure page overlay for Site, you must edit two files:
- Page Overlay.vw: This file is a template file for creating page overlay visualizations. At least one template file must be present in the profile for which you are configuring page overlay.
- Page Overlay Link Templates.cfg: When the page overlay visualization loads a page, it automatically identifies the links in the page and their destinations. To relate these links to elements in the data, you must define a set of regular expressions in this file.You can define multiple regular expressions to match against the elements of the dimension. The order in which you define the expressions is important. When you request an overlay for a particular page, Data Workbench takes a snapshot of the actual page as it would appear in a web browser and parses the HTML code that represents links according to a list of regular expressions that you define. For each link on the selected page, the software attempts to find a regular expression pattern match by working down the list until the first match is found. The first expression to match a dimension element is the one used. Therefore, it is best to list the regular expression with the most specific matching pattern first, followed by less specific expressions. If there is a match, the link appears highlighted in the page overlay visualization.
To configure page overlay for Site
- In the Profile Manager, navigate to Context > Dimension Element > URI .The Dimension Element directory contains the context menu items that appear when you right-click a dimension element. For example, open a URI table, then select a URI element. Right-click the URI and Page Overlay appears.
- In the URI folder, right-click the check mark next to the Page Overlay.vw file and click Make Local . A check mark for this file appears in the User column.
- Right-click the newly created check mark and click Open > in Notepad .
- Specify the Domain (and Browser Height, if required).
window = simpleBorderWindow: client = scrollWindow: client = PageOverlay: URI Template = string: http://%Domain%%Element% URI Parameters = map: Domain = string: domain name Element = ref: Element/Name Dim = ref: wdata/model/dim/URI Dim Element = ref: Element/Name Level = ref: wdata/model/dim/Page View Group = ref: wdata/model/dim/Session Browser Height = int: browser height pos = v3d: (518, 202, 0) size = v3d: (810, 610, 0) titleBar = editor: size = v3d: (61, 19, 0) text = string:
- Save the file.
- To make this change available to all users of the working profile, in the Profile Manager, right-click the check mark for the .vw file in the User column and click Save to > < working profile name > .You can create additional template files for other sites or subdomains. Each template that you create appears in the Page Overlay menu.
- In the Context folder of the Profile Manager, right-click the check mark next to the Page Overlay Link Templates.cfg file and click Make Local .A check mark for this file appears in the User column.
- Right-click the newly created check mark and click Open > from the workbench .
- Right-click Link Templates and click Add new > Regular Expression .
- Edit the parameters for LinkRegex vector as necessary:
|For this parameter...||Provide this information...|
The dimension (typically the Next URI dimension) that is represented by the link.
The regular expression used to select the relevant part of the HTML link to find the next element from the Dimension. The regular expression must be an exact match, and the desired output pattern is grouped with parentheses. For details about regular expressions, see the Dataset Configuration Guide .
The output pattern of the regular expression used to extract the resulting element of the Dimension parameter.
The following sample file shows three regular expressions:
- To save the file, right-click (modified) at the top of the window and click Save .
- To make this change available to all users of the working profile, right-click the check mark for Page Overlay Link Templates.cfg in the User column and click Save to > < working profile name > .