Publish to SharePoint 2013 Application Bundle (Aspire 2)

Revision as of 00:17, 9 December 2015 by Dherrera (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Publish to SharePoint 2013 Application Bundle (Aspire 2)
AppBundle Name  Publish To SharePoint 2013
Maven Coordinates  com.searchtechnologies.aspire-publish-to-sp2013
Versions  2.2.2
Type Flags  job-input
Inputs  AspireObject from a connector's subjob with metadata and content extracted from a specific file/folder in a Fileshare.
Outputs  An XML transformation batch of the AspireObjects sent to the Fileshare Repository.

The Publish to SharePoint 2013 application sends document feeds, to a Fileshare Repository, of metadata and content of files extracted by Aspire connectors and send a notification to the SharePoint 2013 Notification Service to fetch the batches. The feed to the Fileshare Repository can be customized by editing the XSL transformation file provided by the user.

NOTE: Publish to SharePoint 2013 Application Bundle has malfunctions when a CIFS Connector is installed on the same server and configure for another server on another domain


Property Type Default Description
repository String Location of the Fileshare repository.
repDomain String Fileshare repository user domain.
repUsername String Fileshare repository username with permissions to write.
repPassword String Fileshare repository password of the username.
aspireToSPXsl String ${appbundle.home}/config/xsl/aspireToSP2013.xsl Location of the XSL to transform the job data to a Solr feed. See Edit Xsl.
claimIssuer String windows Claim issuer for the acls applied to each document.
useFullName boolean false True if you want to index the full name (domain\user) as the ACL rather than just the username
connectNotificationService boolean false Indicates if the publisher must connect to a SharePoint Notification Service.
notificationUrl String The URL to the SharePoint Notification Service
aspireBDC  (2.2 Release)   String The URL to the Aspire BDC Service
searchApp  (2.1 Release)   string Search Service Application The name of the SharePoint search service.
bdcsApp  (2.2 Release)   String Business Data Connectivity Service The name of the SharePoint BDC service
endDomain String The domain of the user with permission to run the Notification Service
endUsername String The user with permission to run the Notification Service
endPassword String The user's password
bgThread integer 1 Wait time in minutes of the background thread, that waits to resend the notification to the endpoint.
cleanupEnable  (2.2 Release)   boolean false True if you want to enable the CleanUP to delete processed batches on the Intermediate Folder
cleanUpFrequency  (2.2 Release)   integer 10 The frequency (minutes) of the CleanUp to look for processed batches and delete them
debug boolean false True if you want debug messages enabled<

Configuration Example

  <application config="com.searchtechnologies.aspire:app-publish-to-sp2013" name="/PublishToSP2013">
        <property name="notificationUrl">http://ws2012-sp2013/_vti_bin/AspireNotificationService/AspireNotificationService.svc</property>
        <property name="bdcsApp">Business Data Connectivity Service</property>
        <property name="repDomain">qa</property>
        <property name="debug">false</property>
        <property name="searchApp">Search Service Application</property>
        <property name="aspireToSPXsl">${appbundle.home}/config/xsl/aspireToSP2013.xsl</property>
        <property name="repository">\\WS2012-SP2013\IntermediateRepository</property>
        <property name="claimIssuer">windows</property>
        <property name="useFullName">false</property>
        <property name="aspireBDC">net.tcp://</property>
        <property name="cleanUpFrequency">10</property>
        <property name="bgThread">2</property>
        <property name="repUsername">spadmin</property>
        <property name="connectNotificationService">true</property>
        <property name="endDomain">qa</property>
        <property name="cleanupEnable">true</property>
        <property name="endUsername">spadmin</property>
        <property name="repPassword">encrypted:562E81591F85B858E5A5D3876F9C9FDB</property>
        <property name="endPassword">encrypted:562E81591F85B858E5A5D3876F9C9FDB</property>

Note: Any optional properties can be removed from the configuration to use the default value described on the table above.

Edit Xsl

The default XSL transformation file can be found in File:AspireToSP2013.xml.

The default transformation XSL file provided by the publisher expects metadata as described in Connector AspireObject Metadata.

Add metadata field

To add a new metadata field extracted by an Aspire Connector add an XSL element under the <doc> tag.

<field name="metafieldNameInSharepoint 2013">
  <xsl:value-of select="metafieldNameFromAspireObject" />

Change the document ID

The id of a SharePoint 2013 document is used to uniquely identify a file in the index. By default, Publish To SharePoint 2013 will use the following fields from the Aspire document in order of precedence (if one is missing, then the next will be used):

  • fetchUrl
  • url
  • displayUrl
  • id

If you want to change this behavior, edit or create a new XSL file which has the following element:

<field name="id">
  <xsl:value-of select="idFieldNameFromAspireObject" />