Task #12209

Add Google Analytics custom dimension for institution names

Added by José Raddaoui Marín 8 months ago. Updated 8 months ago.

Status:DocumentStart date:03/29/2018
Priority:MediumDue date:
Assignee:Sara Allain% Done:


Target version:Release 2.5.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:Yes


This feature enhancement will add support for Google Analytics code to record institution names as a custom dimension in Google Analytics pageview reports. By doing so, users who set up an Analytics account will be able to collect data on a per-institution basis, making this useful for multi-repository installations.

Deliverables: Add Google Analytics custom dimension to record institution name on the archival description, authority record, and archival institution view pages when:
  • the AtoM site is configured with a valid Google Analytics tracking id.
  • the resource is linked the an archival institution (e.g. an archival description, or one of its ancestors, is linked to an archival institution).

Related issues

Related to Access to Memory (AtoM) - Feature #6090: Google Analytics - add support for Universal Analytics Verified 12/06/2013


#3 Updated by Dan Gillean 8 months ago

  • Description updated (diff)
  • Category set to SEO
  • Sponsored changed from No to Yes
  • Requires documentation set to Yes

#4 Updated by José Raddaoui Marín 8 months ago

Notes for test and documentation:

As a good side effect, we have moved from the old 'ga.js' deprecated method to Universal Analytics with this changes, it doesn't require any change in the configuration and the old method doesn't allow custom dimensions. See:


To enable the custom dimension for institutions:

In the Google Analytics property used to track the AtoM site, the one with the key that's is set in 'config/app.yml', create a custom dimension to track repository related views. Use 'Hit' as the scope and set it to active while following:


Set the created dimension index number in 'config/app.yml' bellow the API key and un-comment that setting. Clear the Symfony cache and restart PHP-FPM.

This will set the source culture authorized form of name from the repository (or related repository) as the dimension value before sending the page view hit in the following pages:

- IOs inde page (all templates): repository value (direct or inherited)
- Actors index page: maintaining repository
- Repository index page

#5 Updated by José Raddaoui Marín 8 months ago

Browser cache may be impeding to get this data from some users for a while.

#6 Updated by José Raddaoui Marín 8 months ago

  • Status changed from New to Document
  • Assignee changed from José Raddaoui Marín to Dan Gillean

Merged in qa/2.5.x

#7 Updated by José Raddaoui Marín 8 months ago

  • Assignee changed from Dan Gillean to Nick Wilkinson

#8 Updated by Nick Wilkinson 8 months ago

  • Assignee changed from Nick Wilkinson to Sara Allain

#9 Updated by Dan Gillean 7 months ago

  • Related to Feature #6090: Google Analytics - add support for Universal Analytics added

Also available in: Atom PDF