Overview

This guide walks you through the process of uploading and managing license files for HawkSearch directly through the Media Library. This allows license management to occur independently from code deployments.

Prerequisites

Before uploading a license file, ensure the settings in Optimizely is properly configured to recognize HawkSearch extensions in the Media Library.

Enable Media Library Extension for License Uploads

1. Navigate to:
   Administration > System > Settings > System Settings > General
2. Locate the field:
   Additional Media Manager Extensions
3. Add this value if not already present: xhawk

📘

Note

If you deploy the HawkSearch Connector package, this setting will be added automatically. However, if you wish to upload license files before deployment, this step must be completed manually.

Uploading the License file

Once the system is configured, follow the steps below to upload the license file.

1. Step 1: Navigate to Media Library:

   1. Go to: Library > Media > UserFiles > _system

2. Step 2: Create the License Folder

   
   1. Click "New Subfolder"
   2. Name the folder: xconnect
   3. Confirm that the folder xconnect is created under _system.

3. Step 3: Upload the License File

   
   1. Open the xconnect folder.
   2. Click "Upload File" and select your license file.
   3. Ensure the file has a .xhawk extension (e.g., hawksearch.license.xhawk).

📘

Note

Any file with a .xhawk extension will be recognized by the system.You may upload multiple license files, but the system will use the most relevant one, typically the latest version.

Activating the License

Once your license file is uploaded and the code package has been deployed, follow these steps to activate the license immediately:

1. Go to the Admin Console in your site header.
2. Open the Debug Tool.
3. Select "Clear Cache".

Best Practice

1. Always verify that .xhawk is added to Media Manager Extensions before upload.
2. Keep only the most relevant and active license file(s) in the folder.
3. Remember to clear cache after upload to ensure immediate effect.

License File Structure

Each .xhawk license file is a structured JSON file that contains licensing and environment information used by the HawkSearch system. Below is an example of the expected structure with sample values:

"Info": {
  "Client": {
    "Name": "Test Client",
    "Email": "[email protected]",
    "Website": "https://www.testclientsite.com"
  },
  "Partner": {
    "Name": "Test Partner",
    "Email": "[email protected]",
    "Website": "https://www.partnerexample.com"
  },
  "Environment": "Sandbox",
  "DomainNames": [
    "*commerce.insitesandbox.com",
    "site1.testclient.com",
    "site2.testclient.com"
  ],
  "Version": "2.25.05.1",
  "LicenseDate": "2025-06-13T16:07:54.3148236+00:00",
  "ExpirationDate": "2026-12-31T00:00:00+00:00",
  "Key": ""
}

📘

Note

The Keyvalue is a secure encrypted string and is required for license validation. Do not alter or modify it manually.