Skip to content

Quick Start

Introduction

Getting started with Discover has never been easier, capturing data and behaviours from your website with Discover is achievable in minutes, not hours or days. With only one simple key configuration item to update in your UIC, getting started capturing visitor data is simple.

If you don't have a UIC to configure, or it has not been provided by your business partner, or HCL Discover specialist then switch to the Creating a UIC file page, follow the steps and return here to continue.

Basic setup to start capturing data quickly

endpoint

The key configuration item to update and specify is the endpoint where the visitor data payload is to be transmitted. The endpoint is specific to every Discover customer, regardless of deployment type, on-premise, cloud, or managed services deployment.

endpoint URL format
 https://domain/DiscoverUIPost.php
Replace the default endpoint with the URL for your deployment, highlighted below:

UIC configuration
services: {
    queue: {
        asyncReqOnUnload: true, // Must be set to true due to changes in browser technology
        useBeacon: false, // DNCA must be version 12.1.5 or higher
        useFetch: true, // Set to true to help prevent data loss
        xhrLogging: false, // Useful for debgging
        // dcxWorker: window.fetch && window.Worker ? new Worker("dcxWorker.js") : null,
        queues: [{
                qid: "DEFAULT",
                endpoint: "https://domain/DiscoverUIPost.php", // Replace with your specific endpoint URL
                maxEvents: 20,
                timerInterval: 30000,
                maxSize: 300000,
                checkEndpoint: false,
                encoder: "gzip",
                endpointCheckTimeout: 3000
        }]
    },

That's all you need to do!

Save your file and deploy it to every page on the website requiring tracking, the UIC will now start capturing the basic actions, activities and behaviours of your visitors.

Embedding the UIC

There is no specific defined process or preferred method to embed the UIC in a page, this is entirely at your discretion but is typically achieved using these methods:

  • a Tag Manager (Google, Tealium, etc ..)
  • Manually / static
  • Programmatically
  • A reusable CMS component

It is recommended that you place the embedded script within the <HEAD></HEAD> tags at the earliest point possible on the page.

Optional

Additionally, the internal version data to keep track of when new UIC versions are implemented can be tracked. Updating the following code:

UIC version
// Internal version for reporting & tracking purposes.  Can be a single string or JSON object.
version: {
    author: "HCL Discover",
    date: "",
},