How to Set Up Telemetry

Note: Telemetry configuration is available as of WikiPakk 2.9.0.

How to Turn on Usage Tracking

The following eight-minute video will walk you through:

• setting up a central configuration site to store the data
• pointing WikiPakk to this central location
• creating the SharePoint list that is used to store the data
• watching recorded usage events

Access and Permissions Overview

Let’s take a quick look at the permission configuration involved when setting up usage tracking.

• Central Configuration Site
  • READ ACCESS for all WikiPakk users
  • the site is not only used to store metrics, but also to store the license key centrally and - in the future - further WikiPakk settings
• WikiPakkTelemetry list in the central configuration site
  • CONTRIBUTE ACCESS for all WikiPakk users
  • permission inheritance must be broken MANUALLY to allow that, otherwise users won’t be able to contribute their metrics; you might also use that to only record metrics for specific groups of users
  • the list must be configured so that each user can only see their own list items; WikiPakk takes care of configuring this, but you should double check that in the list settings

What You Need to Configure

Here is what you need to do, with regard to permissions:

• grant read access to all WikiPakk users to the central configuration site
• grant Contribute access to all WikiPakk users to the WikiPakkTelemetry list in the central configuration site; you need to break permission inheritance on the list

Here is what WikiPakk already does, but what you should double-check:

• create the WikiPakkTelemetry list (see video on how to do that)
• configure the WikiPakkTelemetry list so that each user can only see their own list items

Where Is Usage Data Stored?

The usage data is stored in the WikiPakkTelemetry list in the central configuration site, in your SharePoint Tenant.

Maintenance

Depending on WikiPakk usage, the WikiPakkTelemetry list might get very large. Usability of SharePoint lists degrades starting at 5000 list items, although SharePoint can handle millions of list items.

Nevertheless, you should delete old usage data regularely.

How to Turn off Telemetry and Usage Tracking?

Delete the WikiPakkTelemetry list. (You can re-create it at any time, following the instructions in the setup video.)