ERoom Scanner (Aspire 2)

The Eroom Scanner component performs full and incremental scans over a Eroom Community, maintaining a snapshot of the community and comparing it with the current content to establish what content has been updated. Updated content is then submitted to the configured pipeline in AspireObjects attached to Jobs. As well as the URL of the changed item, the AspireObject will also contain metadata extracted from the repository. Updated content is split in to three types: add, update, and delete. Each type of content is published on a different event so that it may be handled by different Aspire pipelines

The scanner reacts to an incoming job. This job may instruct the scanner to start, stop, pause or resume. 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. When pausing or stopping, the scanner will wait until all the jobs it published have completed before itself completing.

ERoom Scanner (Aspire 2)
Factory Name	com.searchtechnologies.aspire:aspire-eroom-connector
subType	default
Inputs	AspireObject from a content source submitter holding all the information required for a crawl
Outputs	Jobs from the crawl

Input Job Parameters

The scanner recognizes the following parameters on the control Job:

Element	Type	Description
id	int	The database id from the aspire_content_sources table.
@crawlId	int	The crawl id from the content database.
@action	String	The control job action - start, stop, pause or resume.
@actionProperties	String	Properties for the crawl - full or incremental.
connectorSource/displayName	String	The name of the crawl.
connectorSource/url	String	The URL to scan.
connectorSource/username	String	The username to connect to Eroom Community with.
connectorSource/password	String	The password to connect to Eroom Community with.
connectorSource/indexFolders	boolean	true if folders (as well as documents) should be published.

Configuration

The scanner recognizes the following configuration parameters:

Element	Type	Default	Description
url	String		The url to the Eroom Site.
username	String		The username to use when accessing Eroom Site..
password	String		The password to use when accessing Eroom Site.
snapshotDir	String	.	The directory for snapshot files.

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.

Example Configuration

<component name="EroomScanner" subType="default" factoryName="aspire-eroom-connector">
	<debug>true</debug>
        <snapshotDir>${app.data.dir}/snapshots</snapshotDir>
	<branches>
		<branch event="onAdd" pipelineManager="../ProcessPipelineManager" pipeline="add-update-pipeline"
                        allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2"/>
		<branch event="onUpdate" pipelineManager="../ProcessPipelineManager" pipeline="add-update-pipeline"
                        allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2"/>
		<branch event="onDelete" pipelineManager="../ProcessPipelineManager" pipeline="post-to-search-engine-pipeline"
                        allowRemote="true" batching="true" batchSize="50" batchTimeout="60000" simultaneousBatches="2"/>
	</branches>
</component>

Page tree