xAPI Governance is a set of processes and controls to ensure the quality of your xAPI data. Good governance keeps your data tidy and makes your life easier when reporting on and using your data. You can read more about xAPI Governance in our blog series, starting with the introduction, What's xAPI Governance and why is it important?
Part of good xAPI governance is keeping track of what identifiers are being used in your LRS. This guide explains how to set up a report that will list all of the activity ids in use.
Related Blog Post: As part of our xAPI Governance series, Test, Monitor and Enforce explains why it’s important to monitor the identifiers being used in your LRS.
- User Types
- Any user with access to the report builder (Global Admins, Area Admins, and some Users) can create and use this report, but users cannot save it to a public dashboard.
- Available on paid plans (Analyst, CLO, and Enterprise).
- Anybody (both beginners and experts) can use this feature.
The first step is to use Measure Editor to configure to configure the measures to be used in the report. These measures will be used to show the full identifier, when it was first and last used and how many times it has been used.
Hint: Why not create a 'xAPI Governance' Measure Category?
Build the report
Once the measures are created, you can create a leaderboard organized by First Used and add the measures.
Hint: Consider creating a separate dashboard for xAPI governance reports.
Warning: This report may not run on accounts containing a large number of activity ids. In that case, you can reduce the amount of data generated by the report by adding time based filters, adding regex activity id filters and removing measures. You may also find that the report will run if it is organized by Activity instead of 'First Used'.
Interpret the report
Once the report is created, you should check it on a regular basis to watch for newly created activity ids that are duplicates of existing activity ids or do not follow your xAPI governance rules.
Related Blog Post: As part of our xAPI Governance series, Processes & Rules explains why and how to define xAPI Governance rules.
If you do find issues, you may be able to resolve them by aliasing the incorrect activity ids to correct ones.