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. |
<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 |
|---|
| url | string | none | The url to the Salesforce repository. |
| username | string | none | The name of the user that is going to be use for the crawl |
| password | string | none | The password of the user. |
| pageSize | string | none | The Page Size that will specify the number of elements to retrieve per request to the server. |
| timeOut | string | none | Time in seconds before the connection gives a timeout. |
| maxRetries | string | none | Number of attempts before the connection gives error. |
| sQueries | string | none | Directory where the mapDBs for the ACLs and the Hierarchy will be placed. |
| mapsDBDir | string | none | Directory where the mapDBs for the ACLs and the Hierarchy will be placed. |
| timestampDir | string | none | Directory where timestamp will be placed. |
| fetchAttach | string | none | Check if you want fetch all the available attachments. |
| fileNamePatterns/include/@pattern | regex | none | Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is included by the scanner. Multiple include nodes can be added. |
| fileNamePatterns/exclude/@pattern | regex | none | Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is excluded by the scanner. Multiple exclude nodes can be added. |
Scanner Configuration Example
<doc action="start" actionProperties="full" normalizedCSName="testFile">
<connectorSource type="salesforce">
<url>https://na15.salesforce.com</url>
<useGE>false</useGE>
<username>[email protected]</username>
<password>encrypted:0DA6E11EA40804BADERA6B234704BE1A</password>
<securityToken>encrypted:792C58539917465DFRS349B392ED871094EF7F7A7097008F8A9AEC5743DD2ACF</securityToken>
<pageSize>500</pageSize>
<timeOut>5</timeOut>
<maxRetries>3</maxRetries>
<fileNamePatterns>
<include pattern=".*pattern.*"/>
<exclude pattern=".*pattern.*"/>
</fileNamePatterns>
<sQueries>C:\Lasith\MyWork\CSL\ST\salesforce\2.22\target\dist-1.0-SNAPSHOT-distribution/cache/appbundles/com.searchtechnologies.aspire/app-salesforce-connector/2.1-SNAPSHOT/config/xml/sQueries.xml</sQueries>
<mapsDBDir>C:\Lasith\MyWork\CSL\ST\salesforce\2.22\target\dist-1.0-SNAPSHOT-distribution\data/salesforce001/mapsDB</mapsDBDir>
<timestampDir>C:\Lasith\MyWork\CSL\ST\salesforce\2.22\target\dist-1.0-SNAPSHOT-distribution\data/salesforce001/timestamp</timestampDir>
<fetchAttach>true</fetchAttach>
<indexSpecific>false</indexSpecific>
<chatterFeed>false</chatterFeed>
<displayName>salesforce001</displayName>
</connectorSource>
<displayName>testFile</displayName>
</doc>
Note: To launch a crawl, the job should be sent (processed/enqueued) to the "/SalesforceConnector/Main" pipeline.
