- Created by Johnny Vargas on Jun 29, 2018
Available as of Aspire (2.2 Release)
The Feed One Scanner component produces a single job to be processed every time a crawl gets started.
The scanner reacts to an incoming job. This job may instruct the scanner to start. Typically the start job will contain all information required by the job to perform the crawl. However, the scanner can be configured with default values via application.xml file. Once a job has been sent, it cannot be stopped or paused until it finish processing.
Feed One Scanner (Aspire 2) | |
---|---|
Factory Name | com.searchtechnologies.aspire:aspire-feedone-scanner |
subType | default |
Inputs | AspireObject from a content source submitter holding all the information required for a crawl |
Outputs | Jobs from the crawl |
Configuration
This section lists all configuration parameters available to configure the Feed One Scanner component.
General Scanner Component Configuration
Basic Scanner Configuration
Element | Type | Default | Description |
---|---|---|---|
snapshotDir | String | snapshots | The directory for snapshot files. |
numOfSnapshotBackups | int | 2 | The number of snapshots to keep after processing. |
waitForSubJobsTimeout | long | 600000 (=10 mins) | Scanner timeout while waiting for published jobs to complete. |
maxOutstandingTimeStatistics | long | 1m | The max about of time to wait before updating the statistics file. Whichever happens first between this property and maxOutstandingUpdatesStatistics will trigger an update to the statistics file. |
maxOutstandingUpdatesStatistics | long | 1000 | The max number of files to process before updating the statistics file. Whichever happens first between this property and maxOutstandingTimeStatistics will trigger an update to the statistics file. |
usesDomain | boolean | true | Indicates if the group expansion request will use a domain\user format (useful for connectors that does not support domain in the group expander). |
Branch Handler Configuration
This component publishes to the onAdd, onDelete and onUpdate, so a branch must be configured for each of these three events.
Element | Type | Description |
---|---|---|
branches/branch/@event | string | The event to configure - onAdd, onDelete or onUpdate. |
branches/branch/@pipelineManager | string | The name of the pipeline manager to publish to. Can be relative. |
branches/branch/@pipeline | string | The name of the pipeline to publish to. If missing, publishes to the default pipeline for the pipeline manager. |
branches/branch/@allowRemote | boolean | Indicates if this pipeline can be found on remote servers (see Distributed Processing for details). |
branches/branch/@batching | boolean | Indicates if the jobs processed by this pipeline should be marked for batch processing (useful for publishers or other components that support batch processing). |
branches/branch/@batchSize | int | The max size of the batches that the branch handler will created. |
branches/branch/@batchTimeout | long | Time to wait before the batch is closed if the batchSize hasn't been reached. |
branches/branch/@simultaneousBatches | int | The max number of simultanous batches that will be handled by the branch handler. |
Feed One Specific Configuration
Element | Type | Default | Description |
---|---|---|---|
maxBytes | long | unlimited | The maximum file size in bytes. Files whose size is greater than this parameter will not be sent to the pipeline. |
Configuration Example
<component name="Scanner" subType="default" factoryName="aspire-feedone-scanner"> <debug>false</debug> <fullRecovery>incremental</fullRecovery> <incrementalRecovery>incremental</incrementalRecovery> <waitForSubJobsTimeout>600000</waitForSubJobsTimeout> <enableAuditing>true</enableAuditing> <emitCrawlStartJobs>false</emitCrawlStartJobs> <emitCrawlEndJobs>false</emitCrawlEndJobs> <branches> <branch event="onAdd" pipelineManager="../ProcessPipelineManager" pipeline="addUpdatePipeline" allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2" /> <branch event="onUpdate" pipelineManager="../ProcessPipelineManager" pipeline="addUpdatePipeline" allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2" /> <branch event="onDelete" pipelineManager="../ProcessPipelineManager" pipeline="deletePipeline" allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2" /> <branch event="onCrawlStart" pipelineManager="../ProcessPipelineManager" pipeline="crawlStartEndPipeline" allowRemote="true" /> <branch event="onCrawlEnd" pipelineManager="../ProcessPipelineManager" pipeline="crawlStartEndPipeline" allowRemote="true" /> </branches> </component>
Source Configuration
Scanner Control Configuration
The following table describes the list of attributes that the AspireObject of the incoming scanner job requires to correctly execute and control the flow of a scan process.
Element | Type | Options | Description |
---|---|---|---|
@action | string | start, stop, pause, resume, abort | Control command to tell the scanner which operation to perform. Use start option to launch a new crawl. |
@actionProperties | string | full, incremental | When a start @action is received, it will tell the scanner to either run a full or an incremental crawl. |
@normalizedCSName | string | Unique identifier name for the content source that will be crawled. | |
displayName | string | Display or friendly name for the content source that will be crawled. |
Header Example
<doc action="start" actionProperties="full" actionType="manual" crawlId="0" dbId="0" jobNumber="0" normalizedCSName="FeedOne_Connector" scheduleId="0" scheduler="##AspireSystemScheduler##" sourceName="ContentSourceName"> ... <displayName>testSource</displayName> ... </doc>
All configuration properties described in this section are relative to /doc/connectorSource of the AspireObject of the incoming Job.
Element | Type | Default | Description |
---|---|---|---|
jobMetadata/fieldMeta/name | string | none | Optional. Field name for metadata property. This will be added to the single job sent to be processed. |
jobMetadata/fieldMeta/value | string | none | Optional. Field value for metadata property. This will be added to the single job sent to be processed. |
Scanner Configuration Example
<doc action="start" actionProperties="full" actionType="manual" normalizedCSName="FeedOne_Connector" sourceName="FeedOne_Connector"> <connectorSource> <jobMetadata> <fieldMeta> <name>testName</name> <value>testValue</value> </fieldMeta> </jobMetadata> </connectorSource> <displayName>FeedOne Connector</displayName> </doc>
Output
<doc> <testName>testValue</testName> <connectorSource> <displayName>FeedOne Connector</displayName> </connectorSource> <action>add</action> </doc>
- No labels