In this article you will find:
| Table of Contents |
|---|
Goal
This article contains descriptions of all of the Hawksearch configurations.
Overview of the Connector’s settings
Enabling and versioning
IsEnabled
...
Versioning
Version
Specifies which version of Hawksearch is supposed to be used.
...
Document size
Document Size Limit
Controls the maximum size in KB of the documents that can be indexed. The default value is 200KB and the maximum is 4000KB. If you wish to index larger documents a custom search service must be implemented.
...
Logging information
Enable Trace logging when Indexing
Specifies whether the index requests and responses should be logged in Sitefinity’s Trace log file.
Enable Trace logging when Searching
Specifies whether the search requests and responses should be logged in Sitefinity’s Trace log file.
...
Deferred index
Deferred Index Activation
...
Controls the interval for deleting the index In seconds. Used when creating delete scheduled tasks.
...
Tracking
Enable Hawksearch Event tracking
Select whether the Hawksearch Event Tracking functionality should be enabled.
...
Provider configuration
Default provider
Specifies the default data provider. Can be accessed through the HawkManager class.
...
Export information
LastDeltaExportTime
Used to display information in the Hawksearch admin page about the last time the delta export was used.
...
Specifies whether the last export was full or delta (empty if none of them was used).
...
Filter results
Filter by permissions [Obsolete]
Choose if search results should be filtered by the permissions of the user when using the built-in Sitefinity search widgets.
...
Export directory for data files
ExportDirectory
Specifies the directory for the export of the files.
...
Scheduling
ExportScheduleType
Specifies how often a full export should be executed – choose between none, daily and wekly
...
Controls for how long removed delta items will be persisted in the database. Enter 0 if you don't want to delete the removed items.
...
Task keys
ExportTaskKey
An ID used to mark scheduled full export tasks or deleting full export schedule. If there are more than 2 tasks with that ID further tasks will not be scheduled. The number of concurrent tasks can be modified throught through the QueuedExportTasksLimit setting.
...
Used to limit the number of concurrent export or delete tasks for full or delta export. Default value is 2
...
API keys and endpoints
HawkSearchApiKey
The key used to identify against the Hawksearch engine when indexing. Used In the Initialization of the Hawksearch client.
...
HawkSearchIndex
When using the Elastic V4 version this setting contains the URL for the Hawksearch Indexing API
When using the Lucene V4L version it contains the name of the index for the corresponding engine
...
Run Rebuild on Server
Choose if index rebuild should be triggered on exportFull or Delta export should trigger a rebuild on the Hawksearch engine.
Default value: True
IsTestMode
Specifies whether we are in test mode or not in order to use the proper staging domain or production domain.
...
Authentication
WindowsAuthLogin
Used to identify the client username against the engine when using Windows authentication
...
Used to specify the authorization header value. Endpoints marked with the [Authorize] attribute check whether the request contains the specified header and are declined if not
...
Additional configurations
UseHawkSearchAPIAfterExport
...
Used to specify whether this format [yyyy/MM/dd hh:mm] should be applied to the field Publication Date when getting Dynamic or Static type fields needed when accessing the index settings.
SearchProxyURLSpecifies the HawkseachBaseAPI URL when the Lucene version of Hawksearch is used.
When using V4L, the field must contain - your-site-domain/hawk/search/index
RenderRelatedDataIdentifiesAs
...
Specifies the URL for listing the result
...
External domain configuration
RunExportTaskOnSpecifiedDomainOnly
...
Specifies an identification key used to validate the user when the export should run on an external host.
...
FTP and SFTP configurations
PushExportFilesToFTP
Specifies whether the export files should be pushed over FTP or SFTP.
...