lab 1 portal analytics

IBM Software

WebSphere Portal V8Lab: Integration with IBM Digital Analytics (Coremetrics)

Authors: Bryan Daniel ([email protected])Stefan Behl ([email protected])Mareike Lattermann ([email protected])

An IBM Proof of TechnologyCatalog Number

Contents

OVERVIEW..........................................................................................................................................................................INTRODUCTION.................................................................................................................................................................................

REQUIREMENTS................................................................................................................................................................................

LAB 1 PORTAL ANALYTICS.......................................................................................................................................................71.1 CONFIGURING THE COREMETRICS AGGREGATOR FOR PORTAL PAGES...........................................................................71.2 VERIFY COREMETRICS AGGREGATOR IS COLLECTING DATA.............................................................................................121.3 ENABLING OVERLAY REPORTS.................................................................................................................................................21

1.4 ANALYTIC TAGS AND SITE PROMOTIONS................................................................................................................................331.5 COREMETRICS WEB ANALYTIC DASHBOARD AND EXPLORE REPORTS............................................................................41

APPENDIX A ANALYTICS MICROFORMATS......................................................................................................................................45APPENDIX B COREMETRICS MAPPING TABLES.............................................................................................................................47APPENDIX C NOTICES.........................................................................................................................................................................49APPENDIX D TRADEMARKS AND COPYRIGHTS..............................................................................................................................51

© Copyright IBM Corporation, 2014

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.


Overview

IBM WebSphere Portal allows for both Passive Site Analytics and Active Site Analytics. In Passive Site Analytics, usage information is logged on a server based log file. A third party tool can then parse this log file and generate reports. Active Site Analytics performs client side scripting to capture information, and then sends the collected information to an analytic provider (i.e. Coremetrics) for processing. This lab will focus on Active Site Analytics with IBM Coremetrics. Note that like many other analytic providers, Coremetrics is a SaaS based offering (meaning there are no on-premise servers you need to install in order to leverage web analytics).

The following figure depicts the architecture of Active Site Analytics. (1)The process begins when a web browser client makes a request for a portal page. (2) The server responds by providing the HTML for the requested page. Within the HTML, the server embeds hidden tags that contain analytic data. Examples of this analytic data include page title, portlet names, content names, user information, etc. (3) Once the page is loaded, a JavaScript based aggregator parses the HTML for these hidden analytic tag values. (4) After collecting the data, the aggregator automatically inserts an item into the browser page (ie blank image/dot) that causes the browser to make a request to the Coremetrics server. The collected analytic data is included in the URL as parameters. (5) The Coremetrics server will parse the URL parameters for the analytic data and save it into a database log file. (6) Lastly, Coremetrics will process the collected data and make it available on the analytic dashboards. The process is seamless to the user and allows data to be collected regardless of the browser being used.




Introduction

In this lab you will learn how to deploy the IBM Coremetrics aggregator. You will then learn how to verify that data is being collected. In the last part of the lab, you will learn how to use the IBM WebSphere Portal Overlay Reports and IBM Coremetrics Dashboard to view the collected data.

Requirements

You will need your own Coremetrics ClientID account information in order to complete this lab .

This document was written using a conference hands-on lab machine. However, the steps can also be followed and applied to your own Portal Server. You will need to substitute the user information and file paths with that of your own environment.



IBM Software

Lab 1 Portal Analytics

1.1 Configuring the Coremetrics aggregator for portal pages

In this section you will learn how to enable the Coremetrics aggregator and how to associate it with specific portal pages. An aggregator can be set for a page using a special page parameter (page metadata) called “asa_aggregator”. If the aggregator depends on other scripts, you can declare these dependencies via page metadata as well. In the case of dependencies, the page parameters need to start with the prefix “asa_dependency”. Note that page parameters are passed on to all sub pages in the portal page hierarchy. This allows you to enable the aggregator for multiple pages at once by setting it on the common parent page.

The out-of-box Coremetrics aggregator is named CoremetricsAggegator.js, and can be found in the <portal_root>\doc\js-samples directory.

__1. Navigate to the <portal_root>\doc\js-samples directory and open the CoremetricsAggregator.js file in a text editor.

__2. Set the clientID to your Coremetrics clientid. Set the dataCollectionDomain to testdata.coremetrics.com, and the cookieDomain to your domain (i.e ibm.com). When done, save and close the file.

__3. The CoremetricsAggregator.js file must be copied into the theme directory on WebDAV. The Linux OS has a built in WebDav Client. If you are running on Windows, you may use a WebDAV Client such as AnyClient. Complete the following steps to copy the aggregator:

Portal Analytics Page 7

IBM Software

__a. Double-click on My Computer (located on the Desktop) and select File-->Connect to Server from the menu bar.

__b. Enter the following values and then click the Connect button.

Service type : WebDAV (HTTP)Server : portalww.demos.ibm.comPort : 10039Folder : /wps/mycontenthandler/dav/fs-type1User Name : wpadminConnection Name : fs-type1

__c. Open the fs-type1 drive. When prompted to enter a password, enter password.

Page 8 Portal Analytics

IBM Software

__d. Copy the modified CoremetricsAggregator.js file into the fs-type1/themes/<theme_name>/js directory.

__e. Close the file explorer window.


IBM Software

__4. Using a web browser, go to http://portal.ibm.com:10039/wps/portal and login as wpadmin (password is password).

__5. Click on the CTC Demo link located towards the top of the page:

__6. Click the Edit Mode link to switch from view mode to edit mode.


http://portal.ibm.com:10039/wps/portal

http://portal.ibm.com:10039/wps/portalThe






IBM Software

__7. Move your mouse into the Page Properties section and click the edit link (as shown in the figure below).

__8. From the Page Properties dialog window, go to the Advanced tab.

__9. Create a new page parameter by entering the key “asa_dependency” and the value “http://libs.coremetrics.com/eluminate.js”. Click the Add link which is displayed next to the input fields.

__10. Create another new page parameter by entering the key “asa_aggregator” and the value “CoremetricsAggregator.js”. Click the Add link which is displayed next to the input fields.


IBM Software

__11. Click the Save button to save the updated page properties.

__12. Click the View Mode link to switch from edit mode to view mode.

__13. Navigate through some of the pages on the CTC Demo Site. Be sure to click on the Registration page a few times to generate some data on the registration page.

1.2 Verify Coremetrics Aggregator is Collecting Data

In this section you will learn how to verify if the Coremetrics aggregator is collecting data, what the data looks like, and if the data is being received by the Coremetrics server. You will learn how to use both the FireFox Firebug plugin and the Coremetrics Tagbar to verify the aggregator. The concepts covered in this section are particular useful when you want to understand what the aggregator is doing “behind the scenes”.

__1. From the FireFox web browser, open Firebug by pressing the F12 key (alternatively open the View menu of Firefox and select the Firebug menu item).


IBM Software

__2. In the Firebug window, navigate to the Net-->JS tab (to only display HTTP requests that are used to load JavaScript resources):

__3. Reload the browser page. Verify that you see request to load the Eluminate API (eluminate.js) and the aggregator script (CoremetricsAggregator.js). Note that the status code might be different depending on the caching characteristics of the loaded script resources. Close the Firebug window when you are ready to continue.

As soon as at least one analytics aggregator is enabled for a portal page, the portal will automatically inject analytics-specific HTML microformats into the page markup (for performance reasons, these microformats are not emitted if there is no active aggregator). The aggregator scans the HTML DOM for the analytics microformats and then sends the data to the analytic service (which in this case is Coremetrics).

In the next step, you will learn how to check for these HTML analytic microformats.


IBM Software

__4. Click on View-->Source from the browser menu bar. Search for “asa.” These tags are not visible to the user, but contain information that is read by the analytics aggregator. The “asa.” tags can be found throughout the HTML source. The figure below represents just a section of the html source. Close the Source View window when you are ready to continue to the next step.

The aggregator parses the HTML DOM for the special “asa” tags. Once it collects the data, the aggregators calls the Coremetrics tags (which can be thought of as Javascript based APIs) that sends data to the Coremetrics server. For example, there is a tag for storing page information and another tag for storing portlet information. Coremetrics provides a web browser plugin that is useful for monitoring what data is being captured by the aggregator. You will learn about this plugin in the next set of steps.

__5. Click on the Coremetrics browser plugin, as shown in the figure below:

NOTE: If you do not have the the Coremetrics browser plugin installed, you can download it from “https://welcome.coremetrics.com/band/coremetricstools.xpi”. Once downloaded, drag and drop the xpi file from the file explorer onto the Firefox web browser window to install.

__6. Login using the Coremetrics client id, username, and password that was assigned to you. (Please refer to Appendix A.)


IBM Software

__7. Click the TagBar option.

__8. Check the Debug Mode option so additional data will be displayed (such as the tag attribute values).


IBM Software

__9. Reload the browser page. Observe the Coremetrics plugin shows the data that is being picked up by the aggregator and being sent to the Coremetrics server.

To recap, CoremetricsAggregator.js is the aggregrator library. When the page loads, the aggregator will parse the portal page and look for data stored in the asa tags (i.e. page name, user information, portlet titles, content titles, etc). Once it obtains the data, it then calls the respective Coremetrics method/tag to pass the information onto the Coremetrics servers. These tags are made available from the eluminate.js library (which you may recall configuring in the first part of this lab).

For example, for page names, the following Coremetric page view tag is used:

cmCreatePageviewTag(<page id>,<category id>);

What you are seeing in the Tagbar is the execution of these Coremetrics tags and the parameters passed to them. Typically you will first see a Page View tag followed by a number of Element tags. The page view tag represents the portal page. The element tags represent the elements of the portal page. You should see one element tag for each portlet and one for each web content item.


IBM Software

Thur far, all verification has been done on the browser client (i.e. verified that the aggregator javascript libraries are being loading, verified that the analytic asa HTML tags are embedded in the HTML source, and verified that the Coremetrics tags are being executed). In the next set of steps, you will verify that the data has been received on the Coremetrics Server.


IBM Software

__10. Using a second web browser window, go to https://itt.coremetrics.com. Login using the Coremetrics client id, username, and password that was assigned to you. (Please refer to Appendix A.)

NOTE: Your Coremetrics account must be entitled/setup to allow you to login to the Implementation Test Tool. If you are unable to access, you can skip over this section as these steps are just an additional “setup check”.

__11. Select the Page Views option and click the Show Test Data button.


IBM Software

As you can probably tell from the above screenshot, there are many types of “tagging” that can be done. Typically, these other types of tagging are specific for each customer, and as such, requires some customization. For example, a conversion event for one customer may be how many people signed up for a new offer, while for another customer, it may be how many people choose to add an item to a shopping cart. The full list of available tags can be found in the Coremetrics Implementation Guide.

__12. Observe that the data from the Coremetrics page view tags that were reported for this client ID is shown. Scroll to the right to see attributes that might have been passed as part of the page view tag.

NOTE: Note that all the data for a specific client ID will be shown. As such, you might also see data from other individuals, as this is shared client ID.

__13. Click your web browser Back button.


IBM Software

__14. Select the Elements option and click the Show Test Data button.

__15. Observe that the data from the Coremetrics element tags that were reported for this client ID is shown. (Element tags consists of Portlets and WCM content items.) Scroll to the right to see attributes that might have been passed as part of the page view tag.

NOTE: The element id format is “page_name::portlet_title::content_title” (this can be changed if desired). Naming portlets and content with a recognizable name that makes sense to you will allow you to better interpret the data when viewing analytic reports.

__16. At this point, you have verified that the aggregator is running and data is being received by the Coremetrics server. Close the http://itt.coremetrics.com web browser as it is no longer needed.


IBM Software

__17. Close the IBM Coremetrics Plugin by clicking on the X in the upper right corner of the plugin sidebar window (as shown in the figure below):

1.3 Enabling Overlay Reports

In the previous section, you enabled the Coremetrics aggregator so usage date could be collected. In this section, you will learn how to enable the web analytics overlay reports in WebSphere Portal. The overlay reports feature retrieves collected data from Coremetrics and shows graphical statistics about individual portal resources, such as pages or portlets, directly on the page. The reports are customizable and allows business owners to quickly analyze how pages, portlets, and content are performing.

Communication from the WebSphere Portal server to the Coremetrics Server is done via the WebSphere Portal AJAX Proxy. The next set of steps will walk you through the process of configuring the AJAX Proxy for use with Coremetrics.

__1. Using a web browser, go to http://portal.ibm.com:10042/ibm/console and login as wpadmin (password is password).

__2. Click Resources-->Resource Environment-->Resource Environment Providers.











IBM Software

__3. Locate WP ConfigService and click on it.

__4. Under the Additional Properties section, click on Custom Properties.









IBM Software

__5. Add the following property. Note that the names/values ARE CASE-SENSITIVE. Name : wp.proxy.config.urlreplacement.default_policy.1Value : https://welcome.coremetrics.com/*

NOTE: If this name is already in use, increment the counter of the key name(ie wp.proxy.config.urlreplacement.default_policy.2)

__6. Click the Save link (located at the top of the page) to save the changes.

__7. The AJAX Proxy must be restarted in order for this change to take effect. Complete the following steps to restart the proxy:

__a. Navigate to Applications-->Application Types-->WebSphere Enterprise Applications.

__b. Check the box next to the AJAX Proxy Configuration application and click the Stop button to stop the application.


IBM Software

__c. Check the box next to the AJAX Proxy Configuration application and click the Start button to start the application.

The communication with Coremetrics will be over HTTPS. As such, the Coremetrics SSL certificate must be added to the to the WebSphere Application Server Truststore. If you do not, then the certificate returned by Coremetrics will not be trusted and communication will fail.


IBM Software

__8. Navigate to the Global Security-->SSL certificate and key management section/page.

__9. From the right pane, navigate to SSL configurations-->NodeDfaultSSLSettings-->Key stores and certificates-->NodeDefaultTrustStore-->Signer Certificates. Once there, click on the “Retrieve from port” button.


IBM Software

__10. Enter the following values and then click the “Retrieve signer information” button:

Host : welcome.coremetrics.comPort : 443Alias : Coremetrics

__11. Verify that the certificate was received (as shown in the figure below) and then click OK.

__12. Verify that the coremetrics certificate is now listed. Click the Save link to save the changes.


IBM Software

__13. Logout from the WebSphere Admin Console.

__14. (Optional) You can verify the AJAX Proxy is configured correctly by opening a web browser and going to “http://portal.ibm.com:10039/wps/proxy/https/welcome.coremetrics.com”. The Coremetrics web page may not render fully, but even if once some content is returned then proxy rules are working. If you instead get a “403 … cannot be access through proxy” message, then you need to re-check your steps.

At this point, you have configured the AJAX Proxy for communication with Coremetrics and have stored the Coremetrics SSL certificated in the Truststore. The remaining configuration step is to configure a credential vault. In order for the Overlay Reports to be able to access the Coremetrics Web Analytics system, you have to store your user information in a Credential Vault slot. The next set of steps will walk you through this process.


IBM Software

__15. Open the web browser window that is displaying the Portal page. If you have already closed, open a new browser window, go to http://portal.ibm.com:10039/wps/portal and login as wpadmin (password is password).

__16. Navigate to Administration-->Credential Vault.

__17. Click on the Add a vault segment option.

__18. Enter com.ibm.portal.asa.coremetrics.segment as the name, and “Segment for Coremetrics” as the description. Click OK to create the new vault segment.

__19. Click on the Add a vault slot option.




















IBM Software

__20. Specify the following values and then click OK:

Name : com.ibm.portal.asa.coremetrics.slotAssociated vault resource : select New and enter com.ibm.portal.asa.coremetrics.slot Vault Segment : com.ibm.portal.asa.coremetrics.segmentVault slot is shared : checkedDescription : Credentials for accessing CoremetricsShare Userid : <coremetrics userid>#<coremetrics clientid> (i.e. jdoe#12345679)Shared password : <user authorization key> (NOT the user password)

NOTE: The following figure demonstrates how to obtain your Coremetrics API User Authorization Key. After logging into the Coremetrics dashboard, go to Manage->API. Click the “Generate API URL” button. The generated url will contain a parameter named userAuthKey. This value is what you should enter in the credential vault shared password field.


IBM Software

At this point you are ready to test the overlay reports. As you are using an administrative user for this lab, you have full access to the overlay reports.

IBM WebSphere Portal V8 introduces a virtual resource named OVERLAY_REPORTS which allows portal administrators to control which users (or user groups) may consume overlay reports. This allows you to allow non-administrators access to the analytic data as well. For details on how to setup access control, please refer to the IBM WebSphere Portal InfoCenter.

__21. Navigate to the CTC Demo-->Registration page.

__22. Complete the following steps to view the page overlay report:


IBM Software

I M P O R T A N T ! ! !

In the previous sections, you verified that data was being sent from your WebSphere Portal Server to the Coremetrics server. Coremetrics does provide some real-time information. However, the analytic “dashboard report” data that the Overlay Reports rely on are generated periodically. As such, your collected data will not show up in the Overlay Report immediately. While this may not be convenient for a hands-on lab, the delay is typically not an issue for the in-context reports as users look at the overall daily average. If 'real-time' monitoring of KPIs are needed, Coremetrics provides a customizable Monitor Dashboard.

__a. Click on Actions-->Show Page Reports.

__b. Observe that the page overlay report is shown.

The default overlay report shows 'weekly' data, for a period of 4 weeks back. The granularity and number of periods can be adjusted by setting parameters. Please refer to the chapter named “Customizing Overlay Reports” in the WebSphere Portal InfoCenter.


IBM Software

The overlay graph in the above figure shows a rise in page views occurred. If such activity continues, one might consider re-opening registration.

__c. Click on Close all link to close the overlay report.

__23. Complete the following steps to view the portlet overlay reports:

__a. Click on Actions-->Show Portlet Reports.

You may receive a message indicating that to many API calls were made to the Coremetrics server. This is a known problem which is being investigated. Please reload the browser window to retry the operation.

__b. Observe that the portlet overlay reports are shown.

__c. Click on Close all link to close the overlay report.


IBM Software

1.4 Analytic Tags and Site Promotions

In this section, you will learn about the analytic tagging and site promotion feature provided by WebSphere Portal. By using analytic tags, business users can assign a descriptive name to resources such as pages, portlets, and content. These tags are read by the Coremetrics Aggregator and saved into the analytic dashboard as elements.

__1. Click on the CTC logo to return to the CTC Demo home:

__2. Complete the following steps to add a analytic tag on a portlet:

__a. Click the Edit Mode link to switch from view mode to edit mode.

__b. Click in the upper right corner of the Landing Navigation portlet (as shown in the figure below) and select Analytic Tags from the drop-down menu.


IBM Software

__c. Enter “After Work Promo” as the tag name and “Visiting Sydney Landing Spot” as the tag value. Click the Add button to add the tag.

__d. Verify the tag is added and then click the Done button.


IBM Software

__e. Click the View Mode link to switch from edit mode to view mode.

__f. (Optional) Turn on the Coremetrics web browser plugin and select the TagBar view (as you did in the previous section of this lab). Reload the page and observe that an additional “element” tag is now being found. The category of the element is “asa.tag.After Work Promo” and the id of the element is “Visiting Sydney Landing Spot::CTC Demo::Landing Navigation” (which is the analytic tag value, followed by the page name, and then the portlet name). When done, close the Coremetrics web browser plugin to continue.


IBM Software

__3. Click on the Read more link of the Visiting Sydney content spot, as shown in the figure below.

__4. You should now be on the Location page. Complete the following steps to add a analytic tag on a page:

__a. Click on the Actions link and select Analytic Tags from the drop down menu.


IBM Software

__b. Enter “After Work Promo” as the tag name and “Tourism Landing Page” as the tag value. Click the Add button to add the tag.

You might be wondering what the difference is between the “Analytic Tags” and “Site Promotions” menu items. The site promotions option will automatically set the tag name to “SitePromotion” (as opposed to the Analytic Tags option which lets you use whatever tag name is desired). As such, the Site Promotions menu option can be considered a convenience. Regardless of which option is selected, the tagged item (i.e. page, portlet, or content) will show up as an element in Coremetrics.

__c. Verify the tag is added and then click the Done button.


IBM Software

__d. (Optional) Turn on the Coremetrics web browser plugin and select the TagBar view (as you did in the previous section of this lab). Reload the page and observe that an additional “element” tag is now being found. The category of the element is “asa.tag.After Work Promo” and the id of the element is “Tourism Landing Page::About-detail-hidden” (which is the analytic tag value, followed by the page name). When done, close the Coremetrics web browser plugin to continue.

__5. Click on the Read more link for the “Harbour City” content item.

__6. You should now be on viewing the Habour City content item. Complete the following steps to add a analytic tag on a content item:

__a. Move your mouse over the content item, and select the Edit toolbar icon:


IBM Software

__b. Scroll down to the Body element and Add the following plugin tag to the end of the body content (as shown in the figure below):

[Plugin:AnalyticsData value="Accomodation" css-class ="asa.tag.After Work Promo"]

This plugin will cause the “asa.tag.After Work Promo” microformat to be a written to the HTML markup of the content item. Note that this plugin can be used for other WCM artifacts as well (i.e inside of a presentation template or even an authoring template).

__c. Select the Save and Publish option (as shown in the figure below).


IBM Software

__d. Click the Close button to close the updated content item.

__e. (Optional) Turn on the Coremetrics web browser plugin and select the TagBar view (as you did in the previous section of this lab). Reload the page and observe that an additional “element” tag is now being found. The category of the element is “asa.tag.After Work Promo” and the id of the element is “Tourism Landing Page::About-detail-hidden” (which is the analytic tag value, followed by the page name). When done, close the Coremetrics web browser plugin to continue.


IBM Software

In the next section, you will learn how the data collected by the Analytic Tag is shown in the Coremetrics Web Analytics Dashboard.

1.5 Coremetrics Web Analytic Dashboard and Explore Reports

In the previous sections, you learned how to view analytic data from within the WebSphere Portal browser interface. For deeper analysis of data, the Coremetrics Web Analytic Dashboard and Explore reports can be used. In this section, you will be introduced to these tools.

__1. Using a web browser, go to http://welcome.coremetrics.com.

__2. Login using your Coremetrics client id, username, and password.



http://welcome.coremetrics.com/

IBM Software

I M P O R T A N T ! !

While Coremetrics does provide some real-time information, the data shown in the web analytic “dashboard report” are generated periodically. As such, your collected data from the previous sections of this lab will not immediately show up in the report. While this may not be convenient for a hands-on lab, the delay is typically not an issue as users look at the overall daily average. If 'real-time' monitoring of KPIs are needed, Coremetrics provides a customizable Monitor Dashboard.

__3. Once logged in, navigate to Reports-->Content-->Page Categories-->Full List-->Default View. You will see a list of page names. The data shown in this view was generated by the Coremetrics Page View tags. Select the page names of interests (i.e CTC Demo, Overview, Registration, Design Track, and About), as shown in the figure below. If needed, adjust the Period A date range.


IBM Software

__4. To view another type of page report, navigate to Reports-->Content-->Top Pages. As in the previous step, you may need to adjust the Period A date and select specific pages of interest (i.e CTC Demo, Overview, Registration, Design Track, and About).


IBM Software

The previous reports looks at your most popular visited pages on your portal. Also, the reports allows you to better understand where your users are going on your portal and what the most popular pages of your portal are for your users.

Monitor bounce rate and average time on page for key landing pages to ensure users continually find content they are looking for. Watch for opportunities to optimize pages with a high entry rate but a high bounce rate to capitalize on traffic not being engaged

__5. Coremetrics refers to the items (i.e. portlets and content) on a page as an “element”. Navigate to the Reports-->Content-->Elements-->By Category-->Default View to view the elements that were tagged. As in the previous steps, you may need to adjust the Period A date and select specific elements of interest (as data from other persons will also be shown since this is a shared client id).

__6. Explore the other types of data reports available from this dashboard. When complete, logout from the dashboard and close the web browser.


IBM Software

Appendix A Analytics Microformats

The following table lists the analytics microformats that are provided out-of-box by IBM WebSphere Portal 8.

Name Description Microformat Tag (CSS Classname)

Page title The localized page title asa.page.title

Page markup locale The locale of the page markup asa.page.locale

Page markup text direction

The text direction of the page markup asa.page.direction

Page ID The serialized ObjectID of the page asa.page.id

Friendly URL The friendly URL of the page without navigational state information

asa.url

Navigation breadcrumb The selection path in the navigation hierarchy containing the localized page titles

asa.page.breadcrumb

Visitor ID The serialized ObjectID of the portal user (may be null)

asa.visitor

Portlet window title The localized title of the portlet window (might be dynamic title)

asa.portlet.title

Portlet window markup locale

The locale of the portlet window markup asa.portlet.locale

Portlet window markup text direction

The text direction of the portlet window markup

asa.portlet.direction

Portlet screen ID The unique identifier of the current portlet view

asa.portlet.screen.id

Portlet screen title The readable title of the current portlet view

asa.portlet.screen.title

Selected portlet A flag which marks the portlet window that was the target of the current action

asa.portlet.selected

WCM content ID The serialized ID of the WCM content item

asa.wcm.content_item.id

WCM content title The title of the WCM content item asa.wcm.content_item.title

WCM content path The path to the WCM content item in the WCM content library

asa.wcm.content_item.path

WCM content authors The authors of the WCM content item asa.wcm.content_item.authors

WCM content last modified date

The date of the last modification of the WCM content item

asa.wcm.content_item.lastmodified

Search term The search term the user has entered asa.search.query

Search result count The number of search results asa.search.results

Appendix Page 45

IBM Software

Search scope ID The identifier of the search scope asa.search.scope.id

Search scope label The label of the search scope asa.search.scope.label

Analytics tags The set of analytics tags the resource is annotated with

asa.tag.<analytics-tag-name>

Site promotions The set of site promotions the resource is annotated with

asa.tag.SitePromotion


IBM Software

Appendix B Coremetrics Mapping Tables

Categories

When data is sent to the Coremetrics server, it can be placed into a “category“. The following table shows the out-of-box category names used for the different portal resources.

Portal resource Coremetrics category

Portal page asa.page

Portlet asa.portlet

Portlet screen asa.portlet.screen

WCM content item asa.wcm.content_item

Analytics tags asa.tag.<analytics-tag-name>

Site promotions asa.tag.SitePromotion

Portal user asa.visitor

Attributes

Each Coremetrics tag can have up to 50 attributes. The set of attributes is divided into three ranges which are defined as follows. The attributes provide additional detail to tagged data (ie page, portlet, content).

2x: Page attributes 3x: Portlet attributes 4x: WCM content attributes

20 Page ID 30 Portlet window ID 40 WCM content item ID

21 Localized page title 31 Localized portlet title 41 WCM content item title

22 Locale of the page markup 32 Locale of the portlet markup 42 WCM content item path

23 Text direction of the page markup

33 Text direction of the portlet markup

43 WCM content authors

24 Friendly page URL 34 Portlet screen titles 44 Not used

25 Navigation breadcrumb 35 Portlet screen ID 45 Not used

26 Not used 36 Portlet target flag 46 Not used

27 Not used 37 Not used 47 Not used



Appendix Page 47

IBM Software

Tags

Portal resource Tag Tag ID Category Attributes

Portal page Page view <page-title> asa.page Page

Portlet Element <page-title>::<portlet-title>

asa.portlet Page, portlet

Portlet screen Element <page-title>::<portlet-title>::<screen-title>

asa.portlet.screen Page, portlet

WCM content item Element <page-title>::<portlet-title>::<content-item-title>

asa.wcm.content_item

Page, portlet, content item

Page-specific analytics tags

Element <tag-value>::<page-title> asa.tag.<tag-name> Page

Portlet-specific analytics tags

Element <tag-value>::<page-title>::<portlet-title>

asa.tag.<tag-name> Page, portlet

Portal user Registration <user-id> asa.visitor -


IBM Software

Appendix C Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Appendix Page 49

IBM Software

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction and intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. All references to fictitious companies or individuals are used for illustration purposes only.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.


IBM Software

Appendix D Trademarks and copyrights

The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both:

IBM AIX CICS ClearCase ClearQuest CloudscapeCube Views DB2 developerWorks DRDA IMS IMS/ESAInformix Lotus Lotus Workflow MQSeries OmniFindRational Redbooks Red Brick RequisitePro System iSystem z Tivoli WebSphere Workplace System p

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.

IT Infrastructure Library is a registered trademark of the Central Computer and Telecommunications Agency which is now part of the Office of Government Commerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

ITIL is a registered trademark, and a registered community trademark of The Minister for the Cabinet Office, and is registered in the U.S. Patent and Trademark Office.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United States, other countries, or both and is used under license therefrom.

Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo are trademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.

Appendix Page 51

NOTES

© Copyright IBM Corporation 2014

The information contained in these materials is provided for

informational purposes only, and is provided AS IS without warranty

of any kind, express or implied. IBM shall not be responsible for any

damages arising out of the use of, or otherwise related to, these

materials. Nothing contained in these materials is intended to, nor

shall have the effect of, creating any warranties or representations

from IBM or its suppliers or licensors, or altering the terms and

conditions of the applicable license agreement governing the use of

IBM software. References in these materials to IBM products,

programs, or services do not imply that they will be available in all

countries in which IBM operates. This information is based on

current IBM product plans and strategy, which are subject to change

by IBM without notice. Product release dates and/or capabilities

referenced in these materials may change at any time at IBM’s sole

discretion based on market opportunities or other factors, and are not

intended to be a commitment to future product or feature availability

in any way.

IBM, the IBM logo, and ibm.com are trademarks of International

Business Machines Corp., registered in many jurisdictions

worldwide. Other product and service names might be trademarks of

IBM or other companies. A current list of IBM trademarks is

available on the Web at “Copyright and trademark information” at

www.ibm.com/legal/copytrade.shtml.

lab 1 portal analytics

Documents