Breadcrumbs

How to set up eduPersonAnalyticsTag

The eduPersonAnalyticsTag attribute is a new attribute designed for COUNTER reports. You can use it to pass group information for service providers to include in your COUNTER reports. E.g: department, location, course and so on.

Not all service providers are able to support this, so you should discuss it with them before setting it up.

See the attribute spec for eduPersonAnalyticsTag.

This attribute should not be used to send information that could enable the identification of specific users.

The eduPersonAnalyticsTag is a multi-value attribute, which means that it is possible to pass more than one value at once for a single user. For example, if a student is on a course covered by two different departments, eduPersonAnalyticsTag might have two values: one for each department.

Because eduPersonAnalyticsTag is an attribute, the information can come from the same sources as any other attribute:

  • For OpenAthens managed accounts, it is provided when the user accounts are created or modified.

  • If you have a local connector, you can send the information from your local directory and map it in.

  • You could also assign values using permission sets.

Using an existing attribute

You may already have an attribute within OpenAthens that you use in reports. You can release it to service providers as eduPersonAnalyticsTag by setting an alias.

  1. Go to Preferences > Attribute release

  2. Click Add a release policy

  3. Search for the resource that you are creating the policy for. Searching by the entityId is the most reliable way to find the specific resource

    Attribute release page. Under 'Add a resource policy', there is a search field containing an entity ID and a suggested search result that matches that ID.

  4. Select your attribute from the attribute list, along with any others the resource needs

  5. Click on the Advanced button

  6. Select your attribute from the drop-down list in the Attribute aliases section

  7. Enter urn:oid:1.3.6.1.4.1.5923.1.1.1.17 as the name to be mapped to

    List of attributes in a custom release policy, followed by advanced editing options - 'SAML NameID format', 'SAML NameID attribute' and 'Attribute aliases'. Following these controls are buttons labeled 'Done', 'Cancel' and 'Advanced'.


  8. Click Done

  9. Save and repeat for any other resources that you know support the attribute

Using a new attribute

Create a custom attribute

To start with, you will need to define a new attribute in the schema editor. If you are using self-registration, you will need to contact our service desk and ask them to set this up for you.

  1. Log in to your admin account and go to Preferences > Schema editor

    1. If you are going to use permission sets to assign values, go to the permission set tab, otherwise stay on the personal account tab

  2. Click and drag the Text option to the custom attributes section. If you are using OpenAthens accounts, the choice attribute may be a better option as it will let you control which values can be selected.

    Schema editor. A sidebar lists available attribute types under the heading 'Add attributes'. These include 'text', 'choice', 'yes or no', 'email address', 'web URL', 'IP address ranges' and 'date'. The main content area shows example custom attributes, including 'favorite color'. There is an option to edit each attribute.


    The attribute type 'text' has been dragged from the sidebar into the content area, creating a new editable custom attribute.


  3. Enter a target name of urn:oid:1.3.6.1.4.1.5923.1.1.1.17

  4. Set eduPersonAnalyticsTag as the display name

  5. Mark the attribute as releasable and reportable using the checkboxes

    Options for configuring a new custom attribute. These include target name, display name, and whether the attribute is required, releasable and reportable. Following these fields are buttons labeled 'Done' and 'Cancel'.


  6. Click Done

  7. Save

Retrieving/setting the information

If you are using local accounts

Next, you need to add a new mapping rule to your local connector. You should make sure that you have configured your local authentication service to release the necessary attribute before starting.

  1. Go to Management > Connections and click on your local connector in the left sidebar

  2. Open up the Attributes tab

  3. Click on Add rule and select Add a mapping rule

    Attributes tab of a local connector. There are no existing mapping rules. The option to add a new mapping rule is highlighted.


  4. Start typing urn:oid:1.3.6.1.4.1.5923.1.1.1.17 in the target name field and select it from the drop-down

  5. The SAML attribute name needs to be the name of the attribute or claim as it is released from your local authentication service

  6. The display name should be eduPersonAnalyticsTag

    Attributes tab of a local connector, showing options for configuring a rule. There are text fields labeled 'Target name', 'SAML attribute name' and 'Display name', and a check box labeled 'Releasable'. Following these fields are buttons labeled 'Done' and 'Cancel'.

  7. Click Done

  8. Save your changes

If you are using OpenAthens managed accounts

Values for eduPersonAnalyticsTag can be provided along with all the usual information when new accounts are created. Existing accounts can be modified individually or in bulk.

If you are using Permission sets

You’ll need to set the value of eduPersonAnalyticsTag for each applicable permission set.

  1. Go to Resources > Permission sets

  2. Click on the permission set that you want to associate a value with

  3. Go to the Attributes tab

  4. Enter the value into the box labelled eduPersonAnalyticsTag

    Attributes tab of a permission set called 'Biochemistry Department'. There is a drop-down list called 'Role', which is set to 'student', a field called 'Entitlement' that takes a resource, and a large text field called 'eduPersonAnalyticsTag' which contains the value 'Biochem'. At the top of the page is a button labeled 'Save changes'.


  5. Save changes

Add an attribute release policy

Finally, you need to set up an attribute release policy for each resource that you wish to release your new attribute to.

  1. Go to Preferences > Attribute release

  2. Click Add a release policy

  3. Search for the resource that you are creating the policy for. Searching by the entityId is the most reliable way to find the specific resource

    Attribute release page. Under 'Add a resource policy', there is a search field containing an entity ID and a suggested search result that matches that ID.


  4. Select eduPersonAnalyticsTag from the attribute list along with any other attributes the resource needs

    List of released and unreleased attributes in a custom release policy. Two attributes are marked as released - 'Targeted ID' and 'eduPersonAnalytics Tag'. Following the list are buttons labeled 'Done', 'Cancel' and 'Advanced'.


  5. Click Done

  6. Save