Publish to SharePoint 2013 Tutorial (Aspire 2)

Jump to: navigation, search

For Information on Aspire 3.1 Click Here

SharePoint 2013 Security Pre-Trimmer

  • Install the Security Pre-Trimmer on all servers hosting a Query Processing component. Check this from SharePoint Central Administration > Manage Service Applications > Search Service Application.
  • Make sure all firewalls to the Aspire server are open for the Aspire service port (default: 50505).

From the Deploy\scripts folder run DeployAspireSecurityTrimmer.ps1 in a SharePoint 2013 Management Shell (run as Administrator):


To make sure the security trimmer DLL is registered correctly, restart the SharePoint Search Host Controller service.


Step 1: Launch Aspire and open the Content Source Management Page

Aspire Content Source Management Page

Launch Aspire (if it's not already running). See:

Browse to: http://localhost:50505. For details on using the Aspire Content Source Management page, please refer to UI Introduction.

Step 2: Create a new Content Source

For this step please follow the step from the Configuration Tutorial of the connector of you choice, please refer to Connector list.

Advanced Connector Properties

Make sure to enable Emit start job in the advanced properties (enabled by default). Otherwise, only incremental crawls will be triggered for the SharePoint Content Source and full crawls will not work.

Step 3: Add a new Publish to SP2013 to the Workflow

To add a Publisher to Sharepoint 2013 drag from the Publish to SP2103 rule from the Workflow Library and drop to the Workflow Tree where you want to add it. This will automatically open the Publish to SP2013 window for the configuration of the publisher.

Step 3a: Specify Publisher Information

Publish to SP2013 Configuration

In the Publish to SP2013 window, specify the connection information to publish to the SharePoint 2013.

  1. Enter the name of the publisher. (This name must be unique).
  2. Enter the description of the publisher that will be shown in the Workflow Tree.
  3. Repository Path: The url for the file share repository where the batches are going to be created.
  4. Enter the Domain for the file share repository.
  5. Enter the Username with permissions to write for the file share repository.
  6. Enter the Password of the username for the file share repository.
  7. XSL File Path: set to the default parameter to use the default XSL transformation file. To use a custom file, follow the instructions in Edit Xsl
  8. Security Type:
    1. Active Directory:
    2. Aspire Group Expansion: To use custom security trimming.
    3. Public Content: To mark all documents as public.
  9. Index Acl Full Name: To use the fullname (domain\username) as the ACL instead of just the username.
  10. Connect to SharePoint Notification Service: check this option if you have the Notification Service installed on SharePoint and you want to control the crawl of the batches from Aspire.
    1. Notification Service URL: The url of the service to which Aspire is going to send the notifications. Verify that the URL provided by the Notification Service installation is the correct one. In some cases you'll have to use the full quallified DNS name instead of hostname only or change the URL protocol (http/https). It should be the root site of an existing web application or the Central Administration web application site.
    2. Aspire BDC Service URL: The url of the AspireBDCService web service
    3. Enter the Search Service Application where you want to create the SP content sources.
    4. Enter the BDC Service Application where you want to create the bdc models.
    5. Enter the Domain to access the Notification Service.
    6. Enter the Username with access permission for the Notification Service.
    7. Enter the Password of the username for the Notification Service.
    8. Background thread frequency: time (in minutes) to wait before sending a new crawl notification until the repository is empty.
  11. Enable CleanUp: check this option to enable a background thread that will remove old batches from the intermediate repository.
    1. Execution Frequency: time (in minutes) in between each run of the clean up.
  12. Debug: Check if you want to run the publisher in debug mode.
  13. Click on the Add button.

Once you've clicked on the Add button, it will take a moment for Aspire to download all of the necessary components (the Jar files) from the Maven repository and load them into Aspire. Once that's done, the publisher will appear in the Workflow Tree.

For details on using the Workflow section, please refer to Workflow Introduction.

Step 4: Run a Test

Test SharePoint 2013 Content Source
The SharePoint 2013 Endpoint must be up and running before performing this test.

Change the indexing mode to Test by clicking on the indexing mode (this will cycle through the values Incremental, Full and Test). After the test has run, these things will have happened on the SharePoint server:

  1. A directory [Content Source name] will have been created in the Shared Repository folder.
  2. An External Content Type [Content Source name]-Model-ECT will have been created in the SharePoint Business Data Service Application.
  3. A Content Source [Content Source name] will have been created in the SharePoint Search Service Application.
  4. Crawled Properties will have been created in the Business Data category for every <field> entry found in the XML batch.

Step 5: Map Crawled Properties to Managed Properties

Per configuration default every Crawled Property in the Business Data category is mapped to the indexed document's full text. Thus, every indexed document is searchable per se. If you need to use different titles, store the size or assign file types, you need to adjust the property mappings.

Open SharePoint Central Administration and click Manage Service Applications, Search Service Application, Search Schema, Categories and Business Data.

Check the list of Crawled Properties and add a mapping to Managed Properties where needed. Make sure that your Crawled Property is in a good position in the mapping list in case the value of the first non-empty Crawled Property is used to populate the Managed Property.