|
chunkSize
Fetch batch size
|
The number of items to batch for each round of fetching. A higher value can make crawling faster, but memory usage is also increased. The default is 1.
type: integer
default value: '1'
|
|
collection
Collection
|
Collection documents will be indexed to.
type: string
pattern: ^[a-zA-Z0-9_-]+$
|
|
commitAfterItems
Commit After This Many Items
|
Commit the crawlDB to disk after this many items have been received. A smaller number here will result in a slower crawl because of commits to disk being more frequent; conversely, a larger number here will cause a resumed job after a crash to need to recrawl more records.
type: integer
default value: '10000'
|
|
crawlDBType
Crawl database type
|
The type of crawl database to use, in-memory or on-disk.
type: string
default value: 'on-disk'
enum: {
on-disk
in-memory
}
|
|
db
Connector DB
|
Type and properties for a ConnectorDB implementation to use with this datasource.
type: object
object attributes: {
}
object attributes: {
}
object attributes: {
}
|
|
dedupe
Dedupe documents
|
If true, documents will be deduplicated. Deduplication can be done based on an analysis of the content, on the content of a specific field, or by a JavaScript function. If neither a field nor a script are defined, content analysis will be used.
type: boolean
default value: 'false'
|
|
dedupeField
Dedupe field
|
Field to be used for dedupe. Define either a field or a dedupe script, otherwise the full raw content of each document will be used.
type: string
|
|
dedupeSaveSignature
Save dedupe signature
|
If true,the signature used for dedupe will be stored in a 'dedupeSignature_s' field. Note this may cause errors about 'immense terms' in that field.
type: boolean
default value: 'false'
|
|
dedupeScript
Dedupe script
|
Custom javascript to dedupe documents. The script must define a 'genSignature(content){}' function, but can use any combination of document fields. The function must return a string.
type: string
|
|
delete
Delete dead URIs
|
Set to true to remove documents from the index when they can no longer be accessed as unique documents.
type: boolean
default value: 'true'
|
|
deleteErrorsAfter
Fetch failure allowance
|
Number of fetch failures to tolerate before removing a document from the index. The default of -1 means no fetch failures will be removed.
type: integer
default value: '-1'
|
|
depth
Max crawl depth
|
Number of levels in a directory or site tree to descend for documents.
type: integer
default value: '-1'
|
|
diagnosticMode
Diagnostic mode
|
Enable to print more detailed information to the logs about each request.
type: boolean
default value: 'false'
|
|
emitThreads
Emit threads
|
The number of threads used to send documents from the connector to the index pipeline. The default is 5.
type: integer
default value: '5'
|
|
enable_security_trimming
Enable Security Trimming
|
type: object
object attributes: {
}
|
|
excludeExtensions
Excluded file extensions
|
File extensions that should not to be fetched. This will limit this datasource to all extensions except this list.
type: array of string
|
|
excludeRegexes
Exclusive regexes
|
Regular expressions for URI patterns to exclude. This will limit this datasource to only URIs that do not match the regular expression.
type: array of string
|
|
f.avoid_ssl_hostname_verification
Avoid SSL hostname verification
|
Enable this in cases when the CN on the SSL certificate does not match the host name of the server.
type: boolean
default value: 'true'
|
|
f.bulkStartLinks
Bulk Start Links
|
If a large number of start links must be defined, you can provide them here. One link per line.
type: string
|
|
f.domain
Sharepoint domain
|
Authentication domain for the Sharepoint user.
type: string
|
|
f.enable_http_headers_debugging
Enable HTTP headers debugging
|
Prints DEBUG level information to the logs.
type: boolean
default value: 'false'
|
|
f.enable_retry
Retry requests
|
Enable this to make the connector automatically try again if a request to sharepoint fails unexpectedly.
type: boolean
default value: 'false'
|
|
f.firstLoginUrl
First Login URL
|
You will need to specify this property if your SharePoint instance has Forms authentication enabled. This will resolve the error: "Before opening files in this location you must first browse to the web site and select the option to login automatically". If your sharepoint url is http://sphost/sites/test_site the first login URL will be http://sphost/_windows/default.aspx?ReturnUrl=%2f_layouts%2f15%2fAuthenticate.aspx%3fSource%3d%252Fsites%252Ftest%255Fsite%252F&Source=%2Fsites%2Ftest_site%2F
type: string
|
|
f.index_items_discarded
Index discarded document metadata
|
Enable to index discarded document metadata
type: boolean
default value: 'true'
|
|
f.kerberosEnabled
Enable Spnego/Kerberos Authentication
|
This tells the web connector to enable Spnego/Kerberos authentication scheme.
type: boolean
|
|
f.kerberosKeytabBase64
Kerberos Keytab in Base64
|
This value is set as the base64 string of the to a keytab file of your principal that is used to authenticate. Optionally you can supply the keytab file path in the "Kerberos Keytab File Path" property, or the "Kerberos Password".
type: string
|
|
f.kerberosKeytabFile
Kerberos Keytab File Path
|
This value is set as the file path on the server to a keytab file of the principal that is used to authenticate. Optionally you can supply the keytab as a base64 encoded string in the "Kerberos Keytab in Base64" property, or the "Kerberos Password".
type: string
|
|
f.kerberosLoginContextName
Kerberos Login Context Name
|
If you are using a login configuration file with the JVM property "java.security.auth.login.config" then this value will tell what login context name to choose from this file when authenticating with Kerberos.
type: string
|
|
f.kerberosPassword
Kerberos Password
|
The password of the principal to use when authenticating with kerberos. You can also specify a keytab in the "Kerberos Keytab File Path" or "Kerberos Keytab in Base64" properties.
type: string
|
|
f.kerberosPrincipal
Kerberos Principal Name
|
When this value is specified along with a keytab, this value is the "Kerberos Principal" of the login user that has authorization to crawl your web site(s). If you do not specify this when kerberos/spnego is enabled, the default principal name will be used.
type: string
|
|
f.kerberosSpn
Kerberos Service Principal Name
|
If you specify this value, this service principal name (SPN) will be used. If not specified, the resource you are accessing will be used to create this value from the client. An example of an SPN would be: "http@your.realm.com"
type: string
|
|
f.log_sharepoint_xml
Log Sharepoint Soap XML
|
When analyzing Sharepoint crawls, it can be helpful to log the Soap XML messages between Fusion and Sharepoint. By selecting this, Sharepoint will log the xml of all messages to the connectors log.
type: boolean
default value: 'false'
|
|
f.maxSizeBytes
Maximum file size (bytes)
|
Maximum size, in bytes, of a document to crawl.
type: integer
default value: '4194304'
|
|
f.minSizeBytes
Minimum file size (bytes)
|
Minimum size, in bytes, of a document to crawl.
type: integer
default value: '0'
|
|
f.password
Sharepoint password
|
Password for the Sharepoint user.
type: string
|
|
f.proxyHost
Proxy host
|
The address to use when connecting through the proxy.
type: string
|
|
f.proxyPort
Proxy port
|
The port to use when connecting through the proxy. (HTTP or SOCKS)
type: integer
|
|
f.proxyType
Proxy type
|
Type of proxy to use, if any. Allowed values are 'HTTP' and 'SOCKS'. Leave empty for no proxy.
type: string
default value: 'HTTP'
|
|
f.remove_prepended_ids
Remove prepended IDs
|
If fields have been defined to include PrependIds, this option will remove those IDs before indexing.
type: boolean
default value: 'true'
|
|
f.replace_invalid_xml_entities
Replace invalid xml entities
|
Replace invalid xml entities to avoid the error: \"Unmarshalling Error: Illegal character entity: expansion character ...\"
type: boolean
default value: 'false'
|
|
f.retry_attempts
Number of retries
|
If Retry requests is enabled, this number determines how many times the connector should retry a request before giving up.
type: integer
default value: '4'
|
|
f.sharepoint_online
Sharepoint Online
|
type: boolean
default value: 'false'
|
|
f.sharepoint_services_timeout
Sharepoint services timeout
|
Time in milliseconds to wait for a server response.
type: integer
default value: '600000'
|
|
f.username
Sharepoint username
|
Name of a Sharepoint user who has the required permissions to access Sharepoint via the SOAP API.
type: string
|
|
failFastOnStartLinkFailure
Fail crawl if start links are invalid
|
If true, when Fusion cannot connect to any of the provided start links, the crawl is stopped and an exception logged.
type: boolean
default value: 'true'
|
|
fetchDelayMS
Fetch delay
|
Number of milliseconds to wait between fetch requests. The default is 0. This property can be used to throttle a crawl if necessary.
type: integer
default value: '0'
|
|
fetchThreads
Fetch threads
|
The number of threads to use during fetching. The default is 5.
type: integer
default value: '5'
|
|
forceRefresh
Force recrawl
|
Set to true to recrawl all items even if they have not changed since the last crawl.
type: boolean
default value: 'false'
|
|
forceRefreshClearSignatures
Clear signatures
|
If true, signatures will be cleared if force recrawl is enabled.
type: boolean
default value: 'true'
|
|
includeExtensions
Included file extensions
|
File extensions to be fetched. This will limit this datasource to only these file extensions.
type: array of string
|
|
includeRegexes
Inclusive regexes
|
Regular expressions for URI patterns to include. This will limit this datasource to only URIs that match the regular expression.
type: array of string
|
|
indexCrawlDBToSolr
Index crawl database to Solr
|
EXPERIMENTAL: Set to true to index the crawl-database into a 'crawldb_' collection in Solr.
type: boolean
default value: 'false'
|
|
initial_mapping
Initial field mapping
|
Provides mapping of fields before documents are sent to an index pipeline.
type: object
object attributes: {
}
object attributes: {
}
object attributes: {
}
object attributes: {
}
unsafe: false
|
|
parserRetryCount
Max Parser Retries
|
The maximum number of times the configured parser will try getting content before giving up
type: integer
default value: '0'
|
|
refreshAll
Recrawl all items
|
Set to true to always recrawl all items found in the crawldb.
type: boolean
default value: 'true'
|
|
refreshErrors
Recrawl errors
|
Set to true to recrawl items that failed during the last crawl.
type: boolean
default value: 'false'
|
|
refreshIDPrefixes
Recrawl ID prefixes
|
A prefix to recrawl all items whose IDs begin with this value.
type: array of string
|
|
refreshIDRegexes
Recrawl ID regexes
|
A regular expression to recrawl all items whose IDs match this pattern.
type: array of string
|
|
refreshOlderThan
Recrawl age
|
Number of seconds to recrawl items whose last fetched date is longer ago than this value.
type: integer
default value: '-1'
|
|
refreshScript
Recrawl script
|
A JavaScript function ('shouldRefresh()') to customize the items recrawled.
type: string
|
|
refreshStartLinks
Recrawl start links
|
Set to true to recrawl items specified in the list of start links.
type: boolean
default value: 'false'
|
|
retryEmit
Retry emits
|
Set to true for emit batch failures to be retried on a document-by-document basis.
type: boolean
default value: 'true'
|
|
rewriteLinkScript
URI rewrite script
|
A Javascript function 'rewriteLink(link) { }' to modify links to documents before they are fetched.
type: string
|
|
startLinks
Start Links
|
Sharepoint Sites, Sharepoint Lists e.g. http(s):///Lists//AllItems.aspx and Sharepoint Libraries e.g. http(s):////Forms/AllItems.aspx are allowed.
type: array of string
|
|
trackEmbeddedIDs
Track embedded IDs?
|
Track IDs produced by splitters to enable dedupe and deletion of embedded content?
type: boolean
default value: 'true'
|
General Configuration
| Property |
Description |
|
description Description
|
Optional description for datasource instance. |
|
id Datasource ID
|
Unique name for datasource instance. |
|
parserId Parser
|
The parser used to process raw content. |
|
pipeline Pipeline ID
|
The index pipeline used to process documents. |
