Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

In this article you’ll find:

Goal

This article provides information on how to configure the connector for a Kentico project.

Prerequisite

Installed Kentico connector - Kentico: Installing the connector

Steps to configure Kentico connector

  1. From the application selector side menu (F2 or button top left) choose the Settings application.

  2. Go to Integration / Hawksearch where you’ll find the settings for the connector.

Search settings

  1. Client Guid / Tracking Key - The client guid / tracking key for your Hawksearch instance. You can find this in your Hawksearch user profile at e.g. https://dev.hawksearch.net/admin/contact.aspx in the Setup Info category.

  2. Base search API Url - This is the base Hawksearch search API Url, e.g. https://searchapi-dev.hawksearch.net

  3. Tracking Url - This is the Hawksearch tracking Url, e.g. https://tracking-dev.hawksearch.net/api/trackevent/Indexing settings

Indexing settings

  1. Indexing enabled - Is the indexing functionality enabled.

  2. Delta indexing enabled - Is delta indexing enabled. Delta indexing means that whenever you insert / update / delete an object that has a corresponding WebApi Field Mapping defined, the connector automatically sends the updated information to Hawksearch.

  3. Indexing type - Here you can choose between the 2 indexing options - File Export and Web Api. The File Export option generates text files which need to be submitted to Hawksearch while the Web Api option sends API requests to Hawksearch with the necessary information.

  4. API Key - The API key for your Hawksearch instance. You can find this in your Hawksearch user profile at e.g. https://dev.hawksearch.net/admin/contact.aspx in the Setup Info category.

  5. Base dashboard API Url - This is the base Hawksearch dashboard API Url, e.g. https://dev.hawksearch.net/api/v9

File Export settings

  1. Build Landing Pages - Whether landing pages will be built.

  2. Landing Pages Base Path - The base path for landing page urls, added as a prefix to the landing page url while generating landing pages if that feature is enabled.

  3. Output Path - This path is relative to the CMS project folder. This is where the Hawksearch feed files will be generated at, e.g. /HawksearchFeed. Make sure that this folder exists beforehand.

  4. Item types - a semicolon separated list of page / module class code names, used to determine what gets included in the items.txt file.

  5. Attribute types - a semicolon separated list of page / module class code names, used to determine what gets included in the attributes.txt file.

  6. Content types - a semicolon separated list of page / module class code names, used to determine what gets included in the content.txt file.

  7. Hierarchy types - a semicolon separated list of page / module class code names, used to determine what gets included in the hierarchy.txt file.

Web Api settings

  1. Base indexing API Url - This is the base Hawksearch indexing API url, e.g. https://indexing-dev.hawksearch.net/api/v2/indexing

  2. Use deferred indexing - Whether deferred indexing will be used or not. Deferred indexing delays the deletion and swapping of the index until after the new index has been created and rebuilt.

  3. Enable index trace logging - Whether trace logging will be enabled for indexing requests. If enabled, a message is logged in the event log for each request and response.

  4. Field types - a semicolon separated list of page / module class / custom table code names, used to determine what gets included in the index.

Next steps

Kentico: Creating Web API field mappings

  • No labels