Installing the Package

1) Obtain XConnect Hawksearch Loader (License + Code File)

Xngage will provide a single file which you will need to add to your Extensions project.

2) Install XConnect Hawksearch Loader to Extensions

Create a new directory in the Extensions project named XngageHawksearch and place the provided XngageHawksearchLoader.cs into the newly created directory.

3) Build Project / Deploy to Sandbox

Once you add the XngageHawksearchLoader.cs, you can now build your Extensions.dll and/or deploy to your Optimizely Sandbox environment, as you do now with your Extension customizations.

4) Check XConnect Loaded

To check and ensure XConnect loaded properly, navigate to the Application Logs in the Optimizely Admin Console. Change the filter search bar to "Source" if not already, and search for "Xngage". You should see two messages:

XngageHawksearchBootstrapper INFO 
Skipping XConnect Hawksearch initialization (search provider not set to Xngage - Hawksearch) - Xngage Hawksearch Connector for Optimizely (B2B) Configured Commerce. Copyright Xngage LLC

XngageHawksearchLoader INFO
Loading XConnect - Xngage Hawksearch Connector for Optimizely (B2B) Configured Commerce. Copyright Xngage LLC.

5) Change Search System Setting + Configure Hawksearch Settings

Once you verified the XConnect integration has loaded, you can now change the system settings. Go to the Search General settings and find the "Search Provider Name" and "Search Indexer Name" settings. Switch these to "Xngage - Hawksearch"

This will now show the "Xngage Hawksearch" specific settings further down in the settings list. Enter your API key and Tracking Key and Save the settings page.

📘
If changing the Environment option, the API URLs below will automatically update to the defaults if you save and reload the settings page.
We have setup the URL defaults to be dependent upon the value of the Environment dropdown. This way you don't have to memorize all of the URLs, but can change them if need be. If you want to change the environment you are indexing to:

Change the Environment dropdown to the correct environment

Save the settings page

Reload the settings page

Notice the API URLs are now updated / defaulted to the standard Hawksearch URLs for the chosen environment.

6) Restart Server / Redeploy To Restart

In order for the new Indexer changes to take effect, you need to restart the server. This will properly reload the XConnect integration when the server is rebooted.

7) Confirm Licenses Loaded

Once the server has rebooted, you should now have new log messages in the Application Log:

XngageHawksearchBootstrapper INFO
Domain localhost has valid XConnect Hawksearch license: Domains: localhost,*.local.com | Partner: [hawk.local.com <> MACHINE] | Client: [Development <> localhost] | Version: 0.2308.24.1512 | Exp: 12/31/9999 11:59:59 PM +00:00 | Gen: 9/27/2023 5:14:59 PM -04:00

XngageHawksearchBootstrapper INFO
Domain bridgeline.commerce.insitesandbox.com has valid XConnect Hawksearch license: Domains: xconnect.hawksearch.net,bridgeline.commerce.insitesandbox.com | Partner: [Xngage <[email protected]> https://xngage.com] | Client: [Hawksearch <[email protected]> https://bridgeline.com] | Version: 0.2308.31.0940 | Exp: 1/1/2024 12:00:00 AM +00:00 | Gen: 9/5/2023 11:34:10 AM -04:00

XngageHawksearchBootstrapper INFO
Found XConnect Hawksearch license: Domains: xconnect.hawksearch.net,bridgeline.commerce.insitesandbox.com | Partner: [Xngage <[email protected]> https://xngage.com] | Client: [Hawksearch <[email protected]> https://bridgeline.com] | Version: 0.2308.31.0940 | Exp: 1/1/2024 12:00:00 AM +00:00 | Gen: 9/5/2023 11:34:10 AM -04:00

XngageHawksearchBootstrapper INFO
Initializing XConnect Hawksearch - Xngage Hawksearch Connector for Optimizely (B2B) Configured Commerce. Copyright Xngage LLC

XngageHawksearchLoader INFO
Loading XConnect - Xngage Hawksearch Connector for Optimizely (B2B) Configured Commerce. Copyright Xngage LLC.