HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Preventing indexing of PII data

This topic describes how to filter out personally identifiable information (PII) data to prevent indexing of this in Optimizely Search & Navigation.

This is an important part when managing GDPR compliance.

How it works

IGDPRConventions and ITrackSanitizerPatternRepository are used for adding the filtering.

Conventions

IGDPRConventions has these methods.

DescriptionSample
Set patterns to remove GDPR data from a search query.public virtual void SetGDPRPatterns(List<GDPRPattern> gdprPatterns)
Get the GDPR patterns to be removed in search querypublic virtual IEnumerable<GDPRPattern> Get

GDPRPatterns()
Delete the GDPR data in the search query that matches the patterns.public string RemoveGDPRDataInQuery(string queryStringQuery)

ITrackSanitizerPatternRepository

The ITrackSanitizerPatternRepository has these methods.

Method descriptionSample
Add patterns to remove PII data from search query
Add single patternpublic string Add(TrackSanitizerPattern pattern)
Add multiple patternspublic void Add(IEnumerable<TrackSanitizerPattern> patterns)
Update patterns to remove PII data from search query
Update single patternpublic string Update(TrackSanitizerPattern pattern)
Update multiple patternspublic bool Update(IEnumerable<TrackSanitizerPattern> patterns)
Get patterns to remove PII in search query
Get all patternspublic IEnumerable<TrackSanitizerPattern> GetAll()
Get pattern by Idpublic TrackSanitizerPattern Get(string patternId)
Delete PII data in the search query that matched the patterns
Delete pattern by Idpublic void Delete(string patternId)
Delete all patternspublic void DeleteAll()

Example

The patterns support plain text, wildcard, regex. Here are some example filters.

  • Full name: “John Smith”, “Steven” …
  • Keyword contains email: “*@gmail.com”, “*@yahoo.com” …
  • Regex string: “\w+([-+.]\w+)*@\w+([-.]\w+)*.\w+([-.]\w+)*” …
public class Sample
  {
    protected IClient _client;
    protected IStatisticsClient _statisticsClient;
    protected ITrackSanitizerPatternRepository _trackSaniziterRepository;
    public Sample(IClient client)
      {
        _client = client;
        _trackSaniziterRepository = new DefaultTrackSanitizerRepository(_client);
      } 
    // Setting and add sanitizer patterns.
    _trackSaniziterRepository.Add(new List<TrackSanitizerPattern>
      {
        new TrackSanitizerPattern 
          { 
            PatternString = "admin", 
            PatternType = TrackSanitizerFilterType.PlainText 
          },
        new TrackSanitizerPattern 
          { 
            PatternString = "email",
            PatternType = TrackSanitizerFilterType.PlainText 
          },
        new TrackSanitizerPattern 
          { 
            PatternString = "*@mail.com", 
            PatternType = TrackSanitizerFilterType.Wildcard 
          },
        new TrackSanitizerPattern 
          {
            PatternString = "1#1", 
            PatternType = TrackSanitizerFilterType.Wildcard 
          },
        new TrackSanitizerPattern 
          { 
            PatternString = "c[a-e]ll", 
            PatternType = TrackSanitizerFilterType.Wildcard 
          },
        new TrackSanitizerPattern 
          { 
            PatternString = @"\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*", 
            PatternType = TrackSanitizerFilterType.Regex 
          }
      });

    // Doing Tracking behavior
    var result = _client
      .UnifiedSearchFor(@"email admin [email protected] [email protected] 
        [email protected] ball bell bill 121 131 141 call cell")
      .StatisticsTrack()
      .GetResult();

    // Try to get GDPR data by keyword matched sanitize pattern.
    var response = _statisticsClient.GetGDPR("@mail.com", x => { });
  };

Installation and verification

In the steps below we describe how to implement and verify the PII filtering.

Prerequisites<o:p></o:p>

Installation

  1. In Visual Studio, set the default project to Templates.Alloy.

  2. Install the following NuGet packages (use the “-pre” option to get latest development package).

    • Find.Cms
    • Find.Statistics
  3. Open the Alloy web.config file and update the following entries: 

    • In the <episerver.find> tag
      • serviceUrl
      • defaultIndex
    • In the <episerver.find.ui> tag 
      • clientSideResourceBaseUrl
  4. Access Admin Mode and add a GDPR test page.
    a. Go to CMS > Admin **Mode > Content Type tab > Page Types > [Specialized] Start Page > Settings**.

10241024
b. Click **Available Page Types** and check  **[Specialized] Find GDPR API Demo Page** and click **Save**.   
10241024
3. Go to the CMS **Edit** &gt; navigation pane &gt; **Pages** tab &gt; **Start** branch of the tree structure.
4. Create a GDPR Seach page and publish it.  
12931293
5. Return to CMS &gt; **Admin ****Mode.**
6. Under **Scheduled jobs**, click **Optimizely Find Content Indexing Job** and start that job manually.

Verification

In these steps we perform a search, delete the GDPR-related data, and add a filtering pattern to prevent it from being indexed.

  1. Open the GDPR Demo page created in previous steps. Clear the GDPR pattern settings to verify that the tracking function is running well.
12931293
  1. Go to the search page and execute a search with some keywords.
790790
  1. Go to the GDPR Demo page and review the displayed data.
991991 970970
  1. Delete the existing GDPR data and set patterns to prevent it.
745745
  1. Search again and recheck for the GDPR data. This should now have been filtered out.
796796 698698

Did this page help you?