Logging web analytics based on consent

By default, web analytics log data for all visitors on the live website. Developers can customize the system to log web analytics only for visitors who give some form of consent.

The system’s API provides the WebAnalyticsEvents.CheckAnalyticsConsent global event, which triggers before any type of web analytics are logged for visitors (before processing of visitor personal data). By assigning a handler to the event, developers can perform the following:

• Define a condition according to the website’s consent requirements. The condition can be based on consents managed within Xperience or on any other data available in the context of the request.
• Set the HasConsent property of the handler’s CheckAnalyticsConsentEventArgs parameter based on the result. If the property is false, the system does not process or log web analytics for the given request.

Example

The following example demonstrates how to disable logging of web analytics for all visitors (contacts) who have not accepted a consent with the WebAnalytics code name.

1. Open your live site project in Visual Studio.

2. Add a custom assembly (Class Library project) with class discovery enabled to the solution, or re-use an existing assembly.

3. Create a custom module class within the project.

4. Override the module’s OnInit method and assign a handler method to the WebAnalyticsEvents.CheckAnalyticsConsent.Execute event.

5. Perform the required actions within the handler method:

   • To disable logging of web analytics for a given request, set the HasConsent property of the handler’s CheckAnalyticsConsentEventArgs parameter to false.
   • You can evaluate whether to log web analytics based on any custom condition. Access data from request contexts or use the ContactId property of the handler’s CheckAnalyticsConsentEventArgs parameter to get the ID of the contact object for which the analytics are being logged.

using CMS;
using CMS.DataEngine;
using CMS.Core;
using CMS.DataProtection;
using CMS.ContactManagement;
using CMS.WebAnalytics;

// Registers the custom module into the system
[assembly: RegisterModule(typeof(CustomConsentModule))]

public class CustomConsentModule : Module
{
    // Module class constructor, the system registers the module under the name "CustomConsent"
    public CustomConsentModule()
        : base("CustomConsent")
    {
    }

    // Contains initialization code that is executed when the application starts
    protected override void OnInit()
    {
        base.OnInit();

        // Assigns a handler to the WebAnalyticsEvents.CheckAnalyticsConsent.Execute event
        // This event occurs before the system logs web analytics for visitors and processes their personal data
        WebAnalyticsEvents.CheckAnalyticsConsent.Execute += Analytics_CheckConsent;
    }

    private void Analytics_CheckConsent(object sender, CheckAnalyticsConsentEventArgs e)
    {
        // Gets the contact for which the analytics are being logged
        // Note: The contact is null for visitors who have not given consent for contact tracking
        ContactInfo contact = ContactInfo.Provider.Get(e.ContactId);

        // Gets the consent that will be evaluated
        ConsentInfo consent = ConsentInfo.Provider.Get("WebAnalytics");

        // Disables web analytics logging for all visitors (contacts) who have not accepted the "WebAnalytics" consent declaration
        IConsentAgreementService consentService = Service.Resolve<IConsentAgreementService>();
        e.HasConsent = (contact != null && consent != null) && consentService.IsAgreed(contact, consent);
    }
}