Page tree
Skip to end of metadata
Go to start of metadata

The SharePoint 2016 Connector performs full and incremental scans over a SharePoint 2013 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 2016 Application Bundle
Factory Namecom.searchtechnologies.aspire:app-sharepoint2016-connector
subTypedefault
InputsAspireObject from a content source submitter holding all the information required for a crawl
OutputsAn AspireObject containing the URL, content, ACLs and Metadata processed for each file.
Versions

3.2

Type Flagsscheduled, group-expansion

Configuration


This section lists all configuration parameters available to configure the SharePoint 2016 Application Bundle component.


General Application Configuration

ElementTypeDefaultDescription
snapshotDirstring${aspire.home}/snapshotsThe directory for snapshot files to be stored.
disableTextExtractbooleanfalseBy 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.
workflowReloadPeriodint15mThe 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.
workflowErrorTolerantbooleanfalseWhen 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.
debugBooleanfalseControls whether debugging is enabled for the application. Debug messages will be written to the log files.


SharePoint 2016 Specific Configuration

ElementTypeDefaultDescription
urlstring
The URL to crawl (http:// format). Can be HTTP or HTTPs.
userNameStringusernameThe user name to connect to SharePoint with, if one is not given in the control job.
passwordStringsecretpasswordThe password to connect to SharePoint with, if one is not given in the control job.
domainstring
Domain used to authenticate against SharePoint.
defaultDisplayNameStringSharePoint2013The name of the crawl, if one is not given in the control job.
groupPrefixSeparatorString|The separator inserted between the site URL and group name when extracting groups from sites.
snapshotDirString.The directory for snapshot files.
waitForSubJobsTimeoutlong600000
(=10 mins)
Scanner time out while waiting for published jobs to complete.
scanRecursivelybooleanfalseIndicates whether the child containers should be scanned or not.
indexContainersbooleanfalseIndicates whether the container items should be indexed or not.
crawlAttachmentsbooleanfalseCrawl attachments from list items. E.g. documents attached to an Event.
crawlExtraSiteCollectionsbooleanfalseIndicates if the user will crawl more than one site collection.
subSiteCollections/siteCollectionUrlstringemptyList of sub site collections to crawl. More than one allowed.
useLDAPCachebooleanfalseCheck for an installed "Aspire LDAP Cache" component for group expansion.
externalGroupServerPathstringemptyList of installed "Aspire LDAP Cache" components.


Example Configuration


Simple

   <application config="com.searchtechnologies.aspire:app-sharepoint2016-connector">
    <properties>
      <property name="snapshotDir">${aspire.home}/snapshots</property>
      <property name="scanRecursively">true</property>
      <property name="indexContainers">true</property>
      <property name="crawlAttachments">true</property>
      <property name="debug">true</property>
    </properties>
  </application>


Output


<doc>
  <url>http://10.10.21.127/sites/aspire/_api/Web</url>
  <snapshotUrl>001 http://10.10.21.127/sites/aspire/_api/Web</snapshotUrl>
  <repItemType>aspire/sharePoint</repItemType>
  <docType>container</docType>
  <GUID>0f7bc97f-ac37-40b7-89be-5c009d79173b</GUID>
  <description/>
  <title>Aspire</title>
  <lastModified>2016-08-22T15:30:01Z</lastModified>
  <dateCreated>2016-01-15T23:38:39Z</dateCreated>
  <dataSize>0</dataSize>
  <displayUrl>http://10.10.21.127/sites/aspire</displayUrl>
  <id>http://10.10.21.127/sites/aspire/_api/Web</id>
  <fetchUrl>http://10.10.21.127/sites/aspire</fetchUrl>
  <sourceName>SharePoint2016</sourceName>
  <sourceType>sp2016</sourceType>
  <connectorSpecific type="sp2016">
    <field name="AllowRssFeeds">true</field>
    <field name="AppInstanceId">00000000-0000-0000-0000-000000000000</field>
    <field name="Configuration">0</field>
    <field name="Created">2016-01-15T23:38:39</field>
    <field name="CustomMasterUrl">/sites/aspire/_catalogs/masterpage/seattle.master</field>
    <field name="DocumentLibraryCalloutOfficeWebAppPreviewersDisabled">false</field>
    <field name="EnableMinimalDownload">true</field>
    <field name="Id">0f7bc97f-ac37-40b7-89be-5c009d79173b</field>
    <field name="Language">1033</field>
    <field name="LastItemModifiedDate">2016-08-22T15:30:01Z</field>
    <field name="MasterUrl">/sites/aspire/_catalogs/masterpage/seattle.master</field>
    <field name="QuickLaunchEnabled">true</field>
    <field name="RecycleBinEnabled">true</field>
    <field name="ServerRelativeUrl">/sites/aspire</field>
    <field name="SyndicationEnabled">true</field>
    <field name="Title">Aspire</field>
    <field name="TreeViewEnabled">false</field>
    <field name="UIVersion">15</field>
    <field name="UIVersionConfigurationEnabled">false</field>
    <field name="Url">http://10.10.21.127/sites/aspire</field>
    <field name="WebTemplate">STS</field>
  </connectorSpecific>
  <acls>
    <acl Permissions="Read, Limited Access, " Sid="s-1-5-21-3023650700-3092893521-1383129343-1112" access="allow" domain="qa" entity="user" fullname="qa\spadmin" name="spadmin" scope="global"/>
    <acl Permissions="Full Control, " access="allow" domain="" entity="group" fullname="902A40CF40D9CD503EE3199DA5D7F113|Aspire Owners" name="Aspire Owners" scope="machine"/>
    <acl Permissions="Read, Limited Access, " Sid="s-1-5-21-3023650700-3092893521-1383129343-1107" access="allow" domain="qa" entity="user" fullname="qa\sp_farm" name="sp_farm" scope="global"/>
    <acl Permissions="Edit, " access="allow" domain="" entity="group" fullname="902A40CF40D9CD503EE3199DA5D7F113|Aspire Members" name="Aspire Members" scope="machine"/>
    <acl Permissions="Read, " access="allow" domain="" entity="group" fullname="902A40CF40D9CD503EE3199DA5D7F113|Aspire Visitors" name="Aspire Visitors" scope="machine"/>
    <acl Permissions="View Only, " access="deny" domain="" entity="group" fullname="902A40CF40D9CD503EE3199DA5D7F113|Excel Services Viewers" name="Excel Services Viewers" scope="machine"/>
    <acl Permissions="Limited Access, " Sid="S-1-0-0" access="deny" domain="" entity="user" fullname="SHAREPOINT\system" name="System Account" scope="global"/>
    <acl Permissions="Limited Access, View Only, " access="deny" domain="" entity="group" fullname="Everyone" name="Everyone" scope="global"/>
  </acls>
  <hierarchy>
    <item id="73886DD2E0982FC87918CD9006F4456A" level="1" name="Aspire" type="aspire/sharePoint" url="http://10.10.21.127/sites/aspire"/>
  </hierarchy>
  <connectorSource>
    <url>http://10.10.21.127/sites/aspire</url>
    <crawlExtraSiteCollections>true</crawlExtraSiteCollections>
    <subSiteCollections>
      <siteCollectionUrl>http://10.10.21.127/sites/lasith</siteCollectionUrl>
    </subSiteCollections>
    <domain>qa</domain>
    <username>sp_farm</username>
    <password>encrypted:562E81591F85B858E5A5D3876F9C9FDB</password>
    <scanRecursively>true</scanRecursively>
    <indexContainers>true</indexContainers>
    <crawlAttachments>true</crawlAttachments>
    <fileNamePatterns/>
    <displayName>SharePoint2016</displayName>
  </connectorSource>
  <action>add</action>
  <content/>
</doc>