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 Salesforce repository with. |
connectorSource/password | String | The password to connect to Salesforce repository with. |
connectorSource/securityToken | String | The Security Token to connect to Salesforce repository with. |
Configuration
The scanner recognizes the following configuration parameters:
Element | Type | Default | Description |
---|---|---|---|
url | String | The url to the Salesforce repository. | |
username | String | The username to use when accessing Salesforce repository. | |
password | String | The password to use when accessing Salesforce repository. | |
securityToken | String | The Security Token to connect to Salesforce repository with. | |
timeOut | int | 10000 (10sec) | The number of milliseconds for timeout of the connection. |
snapshotDir | String | . | The directory for snapshot files. |
debug | boolean | false) | . |
Branch 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. |
Example Configuration
<component name="Scanner" subType="scanner" factoryName="aspire-salesforce-scanner"> <debug>${debug}</debug> <fullRecovery>${fullRecovery}</fullRecovery> <incrementalRecovery>${incrementalRecovery}</incrementalRecovery> <snapshotDir>${snapshotDir}</snapshotDir> <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" /> </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>
Overview
Content Tools