Before You Start

This document

OS and Application information

OS Requirements

• 64-bit edition of Windows Server 2008 R2 Service Pack 1 (SP1) Standard, Enterprise, or Datacenter
• Or 64-bit edition of Windows Server 2012 Standard or Datacenter

Requirements by Component

Notification Service

• SharePoint 2013

Aspire BDC Service

In Windows Server 2008 R2 SP1

• IIS Server role
  • Common HTTP Features
    • Static Content
    • Default Document
    • Directory Browsing
    • HTTP Errors
    • HTTP Redirection
  • Application Development
    • ASP.Net
    • .Net Extensibility
    • ISAPI Extensions
    • ISAPI Filters
  • Security
    • Basic Authentication
    • Windows Authentication
    • Digest Authentication
    • Client Certificate Mapping Authentication
    • IIS Client Certificate Mapping Authentication
    • URL Authorization
    • Request Filtering
    • IP and Domain Restrictions
  • Management Tools
    • IIS Management Console
    • IIS Management Scripts and Tools
    • Management Service

• Application Server role
  • All role features (confirm all dependencies)

• Microsoft .NET Framework version 4.5

In Windows Server 2012

• IIS Server role
  • Common HTTP Features
    • Static Content
    • Default Document
    • Directory Browsing
    • HTTP Errors
    • HTTP Redirection
  • Application Development
    • ASP.Net 3.5
    • ASP.Net 4.5
    • .Net Extensibility 3.5
    • .Net Extensibility 4.5
    • ISAPI Extensions
    • ISAPI Filters
    • Server Side Includes
  • Security
    • Basic Authentication
    • Windows Authentication
    • Digest Authentication
    • Client Certificate Mapping Authentication
    • IIS Client Certificate Mapping Authentication
    • URL Authorization
    • Request Filtering
    • IP and Domain Restrictions
  • Management Tools
    • IIS Management Console
    • IIS Management Scripts and Tools
    • Management Service

• Application Server role (confirm all dependencies)
  • .Net Framework 4.5
  • TCP Port Sharing
  • Web Server (IIS) support
  • Windows Process Activation Service Support
    • Named Pipes Activation
    • HTTP Activation
    • TCP Activation

User Account Requirements 

To run the deploy scripts use an account with the following requirements:

• Domain user.
• Member of the Administrators user group.

The following are the user requirements for each component of the Endpoint:

Intermediate Repository

• Domain user
• Member of AspireUsers user group

Aspire BDC Service

• Domain user
• Member of AspireUsers user group

Notification Service

• Domain user
• Member of AspireUsers user group
• SharePoint Shell Admin (user who has SharePoint_Shell_Access role in farm configuration database, and member of WSS_Admin_WPG group)
• The SharePoint Application Pool Account has to be Search Service Application administrator
• Default content access account
• BDC Service Application administrator
• BDC Metadata Store Permissions:
  • Edit
  • Execute
  • Selectable in Clients
  • Set Permissions
• “WSS_Content_Application_Pools” administration content database role.

 If the user running the SharePoint Application Pool is different from the user you are using to access the Notification Service, then the Application Pool account should be the one that has the Search Service Application administrator permission and not the account that has access to the service. In that case, after setting the application pool account as a Search Service Application administrator, confirm that you have the following permissions on that account in the Search Databases, if not, add them manually:

• SPSearchDBAdmin

• SPSearchDBAdmin

• SPSearchDBAdmin

• SPSearchDBAdmin

Manually add user permissions

• To add a user as a SharePoint Shell Admin execute “Add-SPShellAdmin” cmdlet (http://technet.microsoft.com/en-us/library/ff607596.aspx):
  • Start SharePoint shell as administrator.
  • Run “Add-SPShellAdmin -UserName <username>".

• Make the SharePoint Application Pool account a Search Service Application administrator:
  • Central Admin -> Application Management -> Manage Service Applications.
  • Select “Search Service Application” row (not the link).
  • Click on the “Administrators” button on the ribbon.
  • Add the user and give it “Full Control” permissions.

• Make the user the Default content access account:
  • Go to Central Admin -> Application Management -> Manage Service Applications -> Search Service Application.
  • Click the current access account.
  • Enter the new account credentials

• Make the user a Business Data Connectivity Service administrator:
  • Central Admin -> Application Management -> Manage Service Applications.
  • Select “Business Data Connectivity Service” row (not the link).
  • Click on the “Administrators” button on the ribbon.
  • Add the user and give it “Full Control” permissions.

• Give the user Metadata Store permissions:
  • Central Admin -> Application Management -> Manage Service Applications -> Business Data Connectivity Service.
  • On the ribbon, select "Set Metadata Store Permissions".
  • Add the user and select all the permissions.
  • Click OK.

• Add administration content database role membership:
  • Add database role membership “WSS_Content_Application_Pools” of SharePoint_AdminContent_<GUID> to Notification Endpoint app pool user:

• For search databases, confirm that you have the SPSearchDBAdmin database role. This should be added to the account you set up as the Search Service Application administrator, if not, add them manually.
  • To access the list of database roles on SQLSERVER:
    • Open the SQL Server Management Studio.
    • Go to Security -> Logins.
    • Right click on the user and select Properties.
    • Select "User Mappings".

After doing all the changes specified previously, this is the complete list of user database roles as they should be.

• SPDataAccess
• SharePoint_Shell_Access

• SPDataAccess
• WSS_Content_Application_Pools
• SharePoint_Shell_Access

• SPDataAccess

• SPSearchDBAdmin

• SPSearchDBAdmin

• SPSearchDBAdmin

• SPSearchDBAdmin

Security Pre-Trimmer

The Security PreTrimmer requires that the user identity sent to it contains at least one of the following claim types:

• claims/userlogonname: This is for windows authentication. The pretrimmer will use this value to send it to the Aspire Group Expansion.
• claims/primarysid: This is for other types of authentication (e.g. ADFS). The pretrimmer will take the primary SID value and translate it into a valid user id to send it to the Aspire Group Expansion.

SharePoint 2013 Aspire Components Installation

This describes the steps needed for installing the various Aspire components of the SharePoint 2013 Publisher Endpoint.

This installation is done through a powershell script that will setup and configure the following components:

• Intermediate Repository. Shared folder created to be used as a SharePoint External Source.
• (IIS Service) Aspire Service. Acts as a data source for the Aspire ECT (External Content Type).
  • Reads XML files from the Repository using a separate timestamp file to managed updated content.
  • Protected using NTLM authentication mechanism.
  • Any user accessing this service must be member of the AspireUsers Active Directory or local Windows group.
• (SharePoint Solution) Notification Endpoint. Receives requests for crawling the Aspire Content Source.
  • Creates the Content Source specific directory in the publisher file share.
  • Creates the Search Service Application Content Source.
  • Creates the BDC Model and External Content Type (ECT) in SharePoint Business Data Connectivity Services.
• Security Trimmer. Used to enhance the search query in SharePoint Search using group expansion from Aspire.
• Error Crawl Logs. Used to get crawled document logs from a content source.
  
  

Installation and Prerequisites

• SharePoint 2013 Publisher EndPoint Prerequisites
• SharePoint 2013 Publisher EndPoint Installation
• Removing the SharePoint 2013 Publisher EndPoint

Single Server Installation

1. Download the latest version of the installation files from our repository 
2. Log in to a SharePoint 2013 server
3. Copy the installation package (Deploy file) to that server
4. Extract it to some directory (i.e.: C:\Deploy)
5. Fill up the configurationParameters.xml
6. Start PowerShell as administrator
7. cd to scripts directory (cd “C:\Deploy\scripts”)

8. Run 

   Code Block
   language text theme FadeToGrey
   .\DeployPublisher.ps1 -configurationFilePath ..\config\configurationParameters.xml

9. (Optional) Install the Security Trimmer. Run 

   Code Block
   language text theme FadeToGrey
   .\DeployAspireSecurityTrimmer.ps1 -configurationFilePath ..\config\configurationParameters.xml

10. Reboot the server to ensure security group memberships are updated
11. Deploy and configure Aspire component (SharePoint 2013 Publisher Configuration Tutorial)

Multi-Server Installation

1. Install the intermediate repository
   1. Log in to the server that you plan to install the intermediate repository
   2. Copy the installation package Deploy File to that server
   3. Extract it to some directory (C:\DeployRepository)
   4. Fill up the configurationParameters.xml
   5. Start PowerShell as administrator
   6. cd to scripts directory (cd “C:\ DeployRepository\scripts”)

   7. Run

      Code Block
      language text theme FadeToGrey
      .\DeployIntermediateRepository.ps1 -configurationFilePath ..\config\configurationParameters.xml

   8. Reboot the server to ensure security group memberships are updated
2. Deploy Aspire BDC Service
   1. Copy the extracted installation folder content (C:\DeployRepository\...) with updated configuration file, from Intermediate Repository server
   2. Log in to the server that you planned to install Aspire Service, and paste copied content to some directory (C:\DeployAspireService)
   3. Make sure the configuration file has been updated from the previous installation and filled piped parameters inside Aspire BDC Service inputs.
   4. Start PowerShell as administrator
   5. cd to scripts directory (cd “C:\DeployAspireService\scripts”)

   6. Run 

      Code Block
      language text theme FadeToGrey
      .\DeployAspireBDCService.ps1 -configurationFilePath ..\config\configurationParameters.xml

   7. Reboot the server to ensure security group memberships are updated
3. Deploy Notification Service
   1. Copy the installation package (C:\DeployAspireService) with updated configuration file, from Aspire Service server
   2. Log in to any SharePoint server that you planned to install Notification Service, and paste copied content to some directory (C:\DeployEndpoint)
   3. Make sure the configuration file has been updated from the previous installation and filled piped parameters inside Notification Service inputs.
   4. Start PowerShell as administrator
   5. cd to scripts directory (cd “C:\DeployEndpoint\scripts”)

   6. Run 

      Code Block
      language text theme FadeToGrey
      .\DeployNotificationService.ps1 -configurationFilePath ..\config\configurationParameters.xml

   7. Reboot the server to ensure security group memberships are updated
4. Deploy and Configure Aspire Component
   1. See SharePoint 2013 Publisher Configuration Tutorial