Crawling, indexing and search parameters.
Declaration Syntax| C# | Visual Basic |
public class Configuration : INotifyPropertyChanged
Public Class Configuration Implements INotifyPropertyChanged
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | Configuration()()()() | |
 | AutoCompleteSuggestionWordMaxLength |
Maximum length of words to suggest to the user in the auto-complete drop down, when words originate in the lexicon.
|
| BoostFactorTagName |
The boost factor tag name.
|
| CacheCrawlLinks | Whether to store links found on a page before that page is crawled. Set false to conserve memory. |
| CaseSensitivity | Obsolete.
The case sensitivity setting for building and searching.
|
| CentralEventDispatcher |
The centralized event dispatcher that will fire all central events.
|
| CrawlSubdomains |
Whether to let the crawler crawl [other] subdomains that it finds links to, otherwise the crawler will stay on the exact hostname that it started on.
|
| CreateForwardIndex | Whether to create a 'forward index' which allows for result summary generation and result preview features. |
| credentials | Obsolete.
Map of web-site domain-names/server-names to usernames and passwords.
|
  | CurrentIndexVersion |
The index version that this build works with.
|
| CurrentMajorVersion |
The major version of this build.
|
| CustomDataFilterLiveDataMaximum |
The maximum amount of live data to report with results to the client, for AJAX custom data filters.
|
| DataAccessExceptionsThreshold | Obsolete.
Number of exceptions that will be tolerated in the data access layer.
|
| DbCommandTimeout |
The number of seconds to set CommandTimeout to for MSSQL commands.
|
| DbImportPageSize |
The number of records to read in each database import paging operation.
|
| DbType |
The storage method for the document index - possible values "sql" or "xml"
|
| DefaultPageNames |
List of strings with default page names, these pages are synonomous with a URL ending in a directory.
|
| DocumentWorkTimeout |
The length of time, in milliseconds, until the document work times out
|
| Equals(Object) | (Inherited from Object.) |
| ErrorPageRedir |
Error page URL pattern
|
| EventHandlerAssemblyPath |
The absolute file path of an external assembly that will be automatically registered to handle operational events.
|
| exceptionThresholds | Obsolete.
Contains exception thresholds.
|
| ExpressionOperatorsCollection |
Collection of logic operators, containing the default pair (AND,OR)
|
| FileTypesSettings |
Maps mime-type strings to file extensions.
|
 | Finalize()()()() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| ForceGCollectOnDocRead |
Whether to force a garbage collect before and after reading a document. ONLY set true when debugging memory issues.
|
| GetApplicationDataFolderPath()()()() |
Returns the folder under LocalApplicationData where install info is stored.
|
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetMimeFromFileExtension(String) |
Returns the mime-type for a particular file extension, as per settings in fileTypesSettings |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| IgnoreBlockBeginPattern |
Pattern that marks the start of a block that should be ignored in the search process
|
| IgnoreBlockEndPattern |
Pattern that marks the end of a block that should be ignored in the search process
|
| IgnoreCommonResourceTypes | Whether to ignore links to common resource types, eg. .jpg, .gif, .js. |
| IgnoreDiacritics |
Whether to ignore diacritic marks, eg. treat 'é' in a word the same as 'e', so 'sake' will find 'saké' (default is true).
|
| IgnoreLastModifiedDate |
Whether to ignore the 'last modified date' returned from the server, during build operations.
|
| IgnoreSSLErrors | Whether to ignore SSL issues on the website being imported - eg. expired certificate. |
| ImpliedLogicOperator |
The implied logic operator between query expression words.
|
| IndexDirectory |
The path to the index directory - eg "c:\documentIndex"
|
| IndexedDocumentBufferSize |
The number of documents to index to the memory buffer before writing to disk.
|
| IndexingInterval |
The length of time in days that must pass before the document is re-indexed.
|
| IndexNumbers | Whether to index numbers. |
| LemmaLanguage |
The language to look for lemmas in.
|
| LemmaSearchEnabled |
Whether to look for variations of query words, eg plural forms, see LemmaWeightFactor and LemmaLanguage also.
|
| LemmaWeightFactor |
Factor to adjust weight of lemma (word variations) matches.
|
| LogFileMaxSize |
The size in bytes at which log files are refreshed.
|
| Logging |
Whether to log activity and errors to files stored in the index directory.
|
| MaxDocumentSizeToIndex |
Documents smaller than this number of kilobytes will be indexed, and documents larger than this will be skipped.
|
| MaximumCrawlDepth | Specifies the maximum 'link depth' that should be crawled. |
| MaxResponseHeaderLength |
The length in kilobytes of the response headers. A value of -1 means no
limit will be imposed on the response headers
|
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnNotifyPropertyChanged(String) |
Fires the PropertyChanged event.
|
| ParseMSWordDocUsingIFilter |
Whether to parse MS Word .doc files using the Windows IFilter (COM interop), if false the pure .NET parser is used (default false).
|
| ParseRTFDocUsingIFilter |
Whether to use the built-in Windows IFilter to parse RTF files. Default is true.
|
| PdfDocumentTitleSource |
Where the title of a Pdf document is obtained from.
|
 | PropertyChanged |
Fired when a property value changes.
|
| ProxyAddress |
The address of a proxy server to use to make outbound connections during indexing. Leave empty to not use a proxy.
|
| ProxyPort |
The port to connect to the proxy server on (if a proxy is used).
|
| ReadDocumentInNewThread |
Whether to read document text in a separate thread, to enable timeouts.
|
| ReaderExceptionsThreshold |
Number of exceptions that will be tolerated in the reader layer.
|
| ReadGlobalConfigKey(String) |
Reads a value from the global install config (located under the user's application data folder).
|
| RequestThrottle |
The length of time, in milliseconds, that the application will wait before each request is made, in order to limit the server load.
|
| RequestTimeout |
The length of time, in milliseconds, until the request times out
|
| RespectsRobotsMetaTags |
Whether to consider the robots meta tags (noindex, nofollow).
|
| RespectsRobotsTXT |
Whether to consider the robots.txt specifications
|
| ResultSummaryType |
The type of summary that will be shown.
|
| ServiceRebuildFrequency |
Indexing interval (hours)
|
| ServiceRebuildHour |
The hour when the reindexing will start (int hour, 0-23)
|
| ServiceWillOptimizeIndex |
Whether the service should automatically optimize the index for searching.
|
| ServiceWillSendEmailLog |
Whether the service should send an email log after it has run.
|
| SmtpEmailFrom |
The email from address that the log will be sent 'from'.
|
| SmtpEmailTo |
The email from address that the log will be sent to.
|
| SmtpMailServer |
The email server to use to send email with service run logs.
|
| SmtpPassword |
The email server password if required. Password will be encrypted and the unencrypted form is not available from configuration files or API.
|
| SmtpServerPort |
The email server port number to use to send email with service run logs.
|
| SmtpUsername |
The email server username if required.
|
| StopWords |
List of 'common' words which are not searchable.
|
| SummaryTextSplitter |
The string used to split apart summary text from different parts of the result document, default is '...'.
|
| SummaryWordLength |
Number of words to show in result summaries.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| UpgradeCrawledURLsToHTTPS |
If the start URL is HTTPS, then upgrade all crawled links to HTTPS.
|
| URLCaseSensitive |
Whether, during indexing, to compare URLs in a case sensitive manner (default is false) - some web servers are case sensitive, IIS is not.
|
| UseFileSizeToIdentifyChange |
Whether to use the file size of a document to identify if it has been changed or not since it was last indexed (also see IgnoreLastModifiedDate).
|
| UserAgent |
The user agent that the search engine identifies itself to the server as.
|
| WebProxy |
Proxy object to use for connections. Setting can speed up access to external servers.
|
| WebProxySet |
Whether a proxy has been set.
|
| WebsiteCredentials |
Map of web-site domain-names/server-names to usernames and passwords.
|
| WordBreakingCharacters |
Characters that will not be considered parts of 'words' and will break a string apart. Any space characters will be ignored.
|
| WordNonBreakingCharacters |
Characters that will be considered parts of 'words' and not break a string apart. Eg. To be able to search for strings like my_email@blah.com - ensure that @ . and _ are in this list of characters. Any space characters will be ignored.
|
| WordsAroundNumber |
Number of words to show around non-continguous summary occurrences.
|
| WordWeightFactorBody | The weighting factor given to words in the document body - increase to make words in the body text more important. |
| WordWeightFactorTitle | The weighting factor given to words in the document title - increase to make words in the title text more important. |
| WordWeightFactorUrl | The weighting factor given to words in the document title - increase to make words in the URL more important. |
| xmlLocation | Obsolete.
The path to the XML document index directory - eg "c:\documentIndex"
|
Inheritance Hierarchy| Object | |
 | Configuration |
Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610