Versions Compared

Old Version 14

changes.mady.by.user Robin Taylor

Saved on

compared with

New Version 15

changes.mady.by.user Peter Dietz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add pictures and more detail to the steps to enable google analytics statistics

...

  1. Enable the Google Analytics XMLUI aspect by editing the configuration file {dspace.dir}/config/xmlui.xconf.
  2. Logon to the Google Developers Console https://console.developers.google.com/project with whatever email address you use to access/manage your existing Google Analytics account(s).
  3. Create a new Google Project. The assumption is that you are developing some new software and will make use of the Google code repository. This is not the case but you need to create the skeleton project before you can proceed to the next step.
  4. Enable the Analytics API for the project. In the sidebar on the left, expand APIs & auth. Next, click APIs. In the list of APIs, make sure the status is ON for the Analytics API.
  5. In the sidebar on the left, select Credentials.
  6. Select OAuth / Create new Client ID, then in the subsequent popup screen select Service account. This will automatically generate the required Service Account email address and certificate.
  7. Go to your Google Analytics dashboard http://www.google.com/analytics/. Create an account for the newly generated Service Account email address and give it permission to 'Read and Analyze' at account level. See *Note below.
  8. The generated certificate needs to be placed Download the P12 key file, and place it somewhere that your DSpace application can access and be referenced as described below in the configuration section.. 

Image Added

*Note:- The Google documentation specifies that the Service Account email address should only require 'Read and Analyze' permission . Howeverto this specific Property, it would appear this may not be the case and it may be necessary to grant greater permissions, at least initiallydoes not need permissions to your Account level Google Analytics.

Configuration settings for Google Analytics Statistics

...

Property:

application.name

Value:

Dummy Project

Informational Note:

Not sure if this property is required but it was in the example code provided by Google. Please do not delete.

Property:

table.id

Example Value:

ga:12345678

Informational Note:

Logon to the Google Analytics Dashboard and select the Property (or website in plain English) that you wish to target. Then select the Admin section for the property. You should then be able to select the 'view settingsView Settings' for the view (i.e. All Web Site Data) you are interested in. The View ID should replace 12345678 below (note - confusingly the Reporting API documentation refers to the View ID as Table ID). This is not the same as your Property Settings Tracking ID (i.e. UA-112233-6)

Account[Longsight DSpace Clients] -> Property[SUNY Dev] -> View[All Web Site Data] -> View Settings

Image Added

 

Then this value is the View ID:

Image Added

 

Property:

account.email

Example Value:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@developer.gserviceaccount.com

Informational Note:

The email address automatically generated when you created the Service Account.

Property:

certificate.location

Example Value:

/home/examplemyudspace/var/dslwebMYU--privatekeyabc123.p12

Informational Note:

The certificate file automatically generated when you created the Service Account. The credentials site will generate a JSON file, and then separately you have to download a new P12 file. Copy it somewhere to your DSpace server, and set this property to the path.

Property:

authorization.admin.usage

Example Value:

true

Informational Note:

Control if the statistics pages should be only shown to authorized users. If enabled, only the administrators for the DSpaceObject will be able to view the statistics. If disabled, anyone with READ permissions on the DSpaceObject will be able to view the statistics.

 

Once Google Analytics Statistics is enabled and configured, you can then view reports. An example report looks like:

http://localhost:8080/xmlui/handle/999/1/google-stats

Image Added