Page History
The SharePoint Connector performs full and incremental scans over a SharePoint site collection and will extract ACLs, metadata, and content from each file scanned. Each scanned file will be tagged with one of three possible actions--add, update, or delete--and can be routed to any Aspire pipeline as desired. The connector, once started, can be stopped, paused or resumed via the Scheduler Component. Typically the start job will contain all information required by the job to perform the scan. When pausing or stopping, the connector will wait until all the jobs it published have completed before updating the statistics and status of the connector.
| SharePoint Application Bundle | |
|---|---|
| Factory Name | com.searchtechnologies.aspire:app-sharepoint-connector |
| subType | default |
| Inputs | AspireObject from from a content source submitter holding all the information required for a crawl. |
| Outputs | An AspireObject containing containing the URL, content, ACLs and Metadata processed for each file. |
| Versions | 3.0, 3.1, 3.2 |
| Type Flags | scheduled, group-expansion |
Configuration
This section lists all configuration parameters available to configure the SharePoint Application Bundle component.
| Element | Type | Default | Description |
|---|---|---|---|
| snapshotDir | string | ${aspire.home}/snapshots | The directory for snapshot files to be stored. |
| disableTextExtract | boolean | false | By default, connectors use Apache Tika to extract text from downloaded documents. If you wish to apply special text processing to the downloaded document in the workflow, you should disable text extraction. The downloaded document is then available as a content stream. |
| workflowReloadPeriod | int | 15m | The period after which to reload the business rules. Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units. |
| workflowErrorTolerant | boolean | false | When set, exceptions in workflow rules will only effect the execution of the rule in which the exception occurs. Subsequent rules will be executed and the job will complete the workflow sucessfully. If not set, exceptions in workflow rules will be re-thrown and the job will be moved to the error workflow. |
| debug | Boolean | false | Controls whether debugging is enabled for the application. Debug messages will be written to the log files. |
Specific Configuration
| Element | Type | Default | Description |
|---|---|---|---|
| url | string | The URL to crawl (http:// format). Can be HTTP or HTTPs. | |
| userName | String | username | The user name to connect to SharePoint with, if one is not given in the control job. |
| password | String | secretpassword | The password to connect to SharePoint with, if one is not given in the control job. |
| domain | string | Domain used to authenticate against SharePoint. | |
| defaultDisplayName | String | SharePoint | The name of the crawl, if one is not given in the control job. |
| groupPrefixSeparator | String | @ | The separator inserted between the site URL and group name when extracting groups from sites. |
| standardWebService | boolean | false | Use standard SharePoint web services only. |
| waitForSubJobsTimeout | long | 600000 (=10 mins) | Scanner time out while waiting for published jobs to complete. |
| allowLimitedAccess | boolean | false | Indicates if an ACL should be set as allow or deny on an item where the user has Limited Access. |
| scanRecursively | boolean | false | Indicates whether the child containers should be scanned or not. |
| indexContainers | boolean | false | Indicates whether the container items should be indexed or not. |
| claimsAuthentication | boolean | false | Indicates whether the group expansion should check for claims authentication or not |
| useLDAPCache | boolean | false | Check for an installed "Aspire LDAP Cache" component for group expansion. |
| externalGroupServerPath | string | empty | List of installed "Aspire LDAP Cache" components. |
Group Expansion Configuration
| Element | Type | Default | Description |
|---|---|---|---|
| Default Domain | string | Domain to authenticate within. | |
| Default User Name | string | User name for SharePoint authentication. | |
| Default Password | string | User password for SharePoint authentication. | |
| URL | string | Designates a site collection to scan for groups. |
Example Configuration
| Code Block | ||
|---|---|---|
| ||
<application config="com.searchtechnologies.aspire:app-sharepoint-connector">
<properties>
<property name="snapshotDir">${aspire.home}/snapshots</property>
<property name="standardWebService">false</property>
<property name="claimsAuthentication">false</property>
<property name="allowLimitedAccess">false</property>
<property name="debug">true</property>
</properties>
</application> |
Output
<doc>
<url>http://10.10.23.89/docSite</url>
<fetchUrl>http://10.10.23.89/docSite</fetchUrl>
<displayUrl>http://10.10.23.89/docSite</displayUrl>
<snapshotUrl>002 http://10.10.23.89/docSite</snapshotUrl>
<repItemType>aspire/SPSite</repItemType>
<docType>container</docType>
<id>http://10.10.23.89/docSite</id>
<spId>{192EE573-5ADB-40C5-A32A-965B2360997F}</spId>
<lastModified>2014-01-30T01:34:25Z</lastModified>
<Title>Documents Site</Title>
<Author>System Account</Author>
<Description>The documents site</Description>
<NoIndex/>
<sourceName>Sharepoint 2010</sourceName>
<sourceType>sp</sourceType>
<acls>
<acl access="allow" domain="" entity="group" fullname="http://10.10.23.89@Test Members" name="http://10.10.23.89@Test Members" scope="global"/>
<acl access="allow" domain="NT AUTHORITY" entity="user" fullname="NT AUTHORITY\LOCAL SERVICE" name="LOCAL SERVICE" scope="global"/>
<acl access="allow" domain="NT AUTHORITY" entity="user" fullname="NT AUTHORITY\NETWORK SERVICE" name="NETWORK SERVICE" scope="global"/>
<acl access="allow" domain="" entity="group" fullname="http://10.10.23.89@Test Visitors" name="http://10.10.23.89@Test Visitors" scope="global"/>
<acl access="allow" domain="" entity="user" fullname="SP Farm" name="SP Farm" scope="global"/>
<acl access="deny" domain="" entity="user" fullname="FASTAdmin" name="FASTAdmin" scope="global"/>
<acl access="deny" domain="QA" entity="group" fullname="QA\sp_farm group" name="sp_farm group" scope="global"/>
<acl access="deny" domain="" entity="group" fullname="http://10.10.23.89@Records Center Web Service Submitters for recordCenter" name="http://10.10.23.89@Records Center Web Service Submitters for recordCenter" scope="global"/>
<acl access="deny" domain="" entity="group" fullname="http://10.10.23.89@Test Owners" name="http://10.10.23.89@Test Owners" scope="global"/>
<acl access="deny" domain="" entity="user" fullname="System Account" name="System Account" scope="global"/>
</acls>
<connectorSource>
<url>http://10.10.23.89</url>
<domain>QA</domain>
<username>sp_farm</username>
<password>encrypted:562E81591F85B858E5A5D3876F9C9FDB</password>
<standardWebService>false</standardWebService>
<allowLimitedAccess>false</allowLimitedAccess>
<claimsAuthentication>false</claimsAuthentication>
<scanRecursively>true</scanRecursively>
<indexContainers>true</indexContainers>
<fileNamePatterns/>
<displayName>Sharepoint 2010</displayName>
</connectorSource>
<action>add</action>
<hierarchy>
<item id="D409112AAA5F4E6160FCD598F78A7336" level="2" name="docSite" type="aspire/SPSite" url="http://10.10.23.89/docSite">
<ancestors>
<ancestor id="031FFB67B549BBB52613CCA03F1A085A" level="1" name="Sharepoint 2010" parent="true" type="aspire/SPSite" url="http://10.10.23.89"/>
</ancestors>
</item>
</hierarchy>
<content/>
</doc>
Overview
Content Tools