Difference between revisions of "SharePoint Application Bundle (Aspire 2)"

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Line 4: Line 4:
|appBundleName=SharePoint Connector
|appBundleName=SharePoint Connector
|typeFlags=scheduled, group-expansion
|typeFlags=scheduled, group-expansion

Latest revision as of 23:35, 8 December 2015

SharePoint Application Bundle (Aspire 2)
AppBundle Name  SharePoint Connector
Maven Coordinates  com.searchtechnologies.aspire:app-sharepoint-connector
Versions  2.2.2
Type Flags  scheduled, group-expansion
Inputs  AspireObject from a content source submitter holding all the information required for a crawl.
Outputs  An AspireObject containing the URL, content, ACLs and Metadata processed for each file.

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.


This section lists all configuration parameters available to install the Sharepoint Application Bundle and to execute crawls using the connector.

General Application Configuration

Property 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.

SharePoint 2010 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.
snapshotDir String . The directory for snapshot files.
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.

Configuration Example

To install the application bundle, add the configuration, as follows, to the <autoStart> section of the Aspire settings.xml.

  <application config="com.searchtechnologies.aspire:app-sharepoint-connector">
      <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>

Group Expansion Configuration

Property 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.


  <Title>Documents Site</Title>
  <Author>System Account</Author>
  <Description>The documents site</Description>
  <sourceName>Sharepoint 2010</sourceName>
    <acl access="allow" domain="" entity="group" fullname=" Members" name=" 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=" Visitors" name=" 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=" Center Web Service Submitters for recordCenter" name=" Center Web Service Submitters for recordCenter" scope="global"/>
    <acl access="deny" domain="" entity="group" fullname=" Owners" name=" Owners" scope="global"/>
    <acl access="deny" domain="" entity="user" fullname="System Account" name="System Account" scope="global"/>
    <displayName>Sharepoint 2010</displayName>
    <item id="D409112AAA5F4E6160FCD598F78A7336" level="2" name="docSite" type="aspire/SPSite" url="">
        <ancestor id="031FFB67B549BBB52613CCA03F1A085A" level="1" name="Sharepoint 2010" parent="true" type="aspire/SPSite" url=""/>