How To Install

Download the latest version of the installation files from our repository.

Single Server Installation

1. Log in to a SharePoint 2013 server
2. Copy the installation package (Deploy file) to that server
3. Extract it to some directory (C:\Deploy)
4. Fill up the configurationParameters.xml
5. Start PowerShell as administrator
6. cd to scripts directory (cd “C:\Deploy\scripts”)
7. Run .\DeployPublisher.ps1 -configurationFilePath ..\config\configurationParameters.xml
8. (Optional) Install the Security Trimmer. Run .\DeployAspireSecurityTrimmer.ps1 -configurationFilePath ..\config\configurationParameters.xml
9. Reboot the server to ensure security group memberships are updated
10. Deploy and configure Aspire component (Publish to SharePoint 2013 Tutorial)

Multi Server Installation

1. First install the intermediate repository

a. Log in to the server that you plan to install the intermediate repositoryb. Copy the installation package Deploy File to that serverc. Extract it to some directory (C:\DeployRepository)d. Fill up the configurationParameters.xmle. Start PowerShell as administratorf. cd to scripts directory (cd “C:\ DeployRepository\scripts”)g. Run .\DeployIntermediateRepository.ps1 -configurationFilePath ..\config\configurationParameters.xmlh. Reboot the server to ensure security group memberships are updated

2. Deploy Aspire BDC Service

a. Copy the extracted installation folder content (C:\DeployRepository\...) with updated configuration file, from Intermediate Repository serverb. Log in to the server that you planned to install Aspire Service, and paste copied content to some directory (C:\DeployAspireService)c. Make sure the configuration file has been updated from the previous installation and filled piped parameters inside Aspire Service inputs.d. Start PowerShell as administratore. cd to scripts directory (cd “C:\DeployAspireService\scripts”)f. Run .\DeployAspireBDCService.ps1 -configurationFilePath ..\config\configurationParameters.xmlg. Reboot the server to ensure security group memberships are updated

3. Deploy Notification Service

a. Copy the installation package (C:\DeployAspireService) with updated configuration file, from Aspire Service serverb. Log in to any SharePoint server that you planned to install Notification Service, and paste copied content to some directory (C:\DeployEndpoint)c. Make sure the configuration file has been updated from the previous installation and filled piped parameters inside Notification Service inputs.d. Start PowerShell as administratore. cd to scripts directory (cd “C:\DeployEndpoint\scripts”)f. Run .\DeployNotificationService.ps1 -configurationFilePath ..\config\configurationParameters.xmlh. Reboot the server to ensure security group memberships are updated

4. Deploy and Configure Aspire Component

(Publish to SharePoint 2013 Tutorial)

Security Trimmer

1. Fill up the configurationParameters.xml
2. Start the SharePoint Management Shell as Administrator.
3. cd to scripts directory (cd “C:\DeployEndpoint\scripts”).
4. Run .\DeployAspireSecurityTrimmer.ps1 -configurationFilePath ..\config\configurationParameters.xml
5. RESTART The SharePoint Search Host Controller service

Note: Install the Security Trimmer on all servers hosting a Query Processing component.

Fill up the configurationParameters.xml

You can find this file here "..\Deploy\config\configurationParameters.xml".

Here is an example on how to fill up the configuration file using the QA\spadmin for all the services.

<?xml version="1.0"?>
<parameters>
  <security>
    <usersGroupName>AspireUsers</usersGroupName>
    <ldapGroupQuery>CN=Users,DC=QA,DC=local</ldapGroupQuery>
  </security>
  <users>
    <AspireBDCServiceAppPool>QA\spadmin</AspireBDCServiceAppPool>
    <contentAccess>QA\spadmin</contentAccess>
    <aspirePropertyRepositoryUser>QA\spadmin</aspirePropertyRepositoryUser>
    <aspirePropertyEndpointUser>QA\spadmin</aspirePropertyEndpointUser>
  </users>
  <repository>
    <inputs>
      <folderPath>C:\Repository</folderPath>
      <shareName>IntermediateRepository</shareName>
    </inputs>
    <outputs>
      <repositorySharePath></repositorySharePath>
    </outputs>
  </repository>
  <aspireService>
    <inputs>
      <folderPath>C:\inetpub\wwwroot\AspireService</folderPath>
      <repositorySharePath piped="true"></repositorySharePath>
    </inputs>
    <outputs>
      <aspireServiceUrl></aspireServiceUrl>
    </outputs>
  </aspireService>
  <notificationEndpoint>
    <outputs>
      <notificationEndpointUrl></notificationEndpointUrl>
    </outputs>
  </notificationEndpoint>
  <securityTrimmer>
    <inputs>
      <groupExpansionService>http://localhost:50505/groupExpansion</groupExpansionService>
      <groupExpansionTimeout>15000</groupExpansionTimeout>
      <useDomain>false</useDomain>
      <claimIssuer>aspire</claimIssuer>
      <searchApplicationName>Search Service Application</searchApplicationName>
      <id>1</id>
      <assemblyVersion>2.2.0.2</assemblyVersion>
    </inputs>
  </securityTrimmer>
</parameters>

Security

 <security>
   <usersGroupName>AspireUsers</usersGroupName>
   <ldapGroupQuery>CN=Users,DC=QA,DC=local</ldapGroupQuery>
 </security>

The security section is an initial approach to have the users group name configurable. Right now it is hardwired to AspireUsers and cannot be changed due to code limitations.

Right now this configuration is used to determine if the AspireUsers group exists as an Active Directory group and if not, it will create it locally.

• Users Group Name User group to which the users must belong to.
• LDAP Group Query The LDAP query (minus the group name) that will be used to check for the existence of the group.

Users

 <users>
   <aspireServiceAppPool>QA\spadmin</aspireServiceAppPool>
   <contentAccess>QA\spadmin</contentAccess>
   <aspirePropertyRepositoryUser>QA\spadmin</aspirePropertyRepositoryUser>
   <aspirePropertyEndpointUser>QA\spadmin</aspirePropertyEndpointUser>
 </users>

• Aspire Service app pool user. User who runs the app pool of Aspire Service. Specify any domain user
• Content access user. SharePoint default content access account
• Aspire property repository user. Repository user, which is specified in Aspire PublishToSP2013 application properties. This can be any domain user
• Aspire property endpoint user. Endpoint user, which is specified in Aspire PublishToSP2013 application properties. This can be any domain user.

Repository

 <repository>
   <inputs>
     <folderPath>C:\Repository</folderPath>
     <shareName>IntermediateRepository</shareName>
   </inputs>
   <outputs>
     <repositorySharePath></repositorySharePath>
   </outputs>
 </repository>

• Folder Path. Location used to mapped the Shared folder
• Share Name. Name of the Shared folder

Aspire BDC Service

 <aspireService>
   <inputs>
     <folderPath>C:\inetpub\wwwroot\AspireService</folderPath>
     <repositorySharePath piped="true"></repositorySharePath>
   </inputs>
   <outputs>
     <aspireServiceUrl></aspireServiceUrl>
   </outputs>
 </aspireService>

• Folder Path. Location to install the Aspire Service (IIS)

Notification Service

 <notificationEndpoint>
   <outputs>
     <notificationEndpointUrl></notificationEndpointUrl>
   </outputs>
 </notificationEndpoint>

Security Trimmer

 <securityTrimmer>
   <inputs>
     <groupExpansionService>http://localhost:50505/groupExpansion</groupExpansionService>
     <groupExpansionTimeout>15000</groupExpansionTimeout>
     <useDomain>false</useDomain>
     <claimIssuer>aspire</claimIssuer>
     <searchApplicationName>Search Service Application</searchApplicationName>
     <id>1</id>
     <assemblyVersion>2.2.0.2</assemblyVersion>
   </inputs>
 </securityTrimmer>

• Group Expansion Service. Url of the Aspire Group Expansion service
• Group Expansion Timeout. Timeout to wait for Group Expansion response
• Use Domain. Use domain in security trimmer
• Claim Issuer. If you are using "Use Aspire" option in the SharePoint2013 Publisher, type "aspire"
• Search Application Name. Name of the Seach Application
• Id.
• Assembly Version Version of the dll registered on the GAC

Verify your Installation

Repository

Check in your that the folder was created. The location can be found in the output parameter <repositorySharePath>.

\\SP13TEST\IntermediateRepository

Aspire BDC Service

• Go to IIS.
• On the left side (on the Connections Panel).
• Expand in your server, the "Sites" folder.
• Check that "AspireBDCService" is in there.
• Right click on it -> Manage WebSite -> Browse.
• You should see something like this:

Notification Service component

• Go to http://<sp2013_server>/_vti_bin/AspireNotificationService/AspireNotificationService.svc
  • 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.
• You should see something like:

Security Trimmer

• Open SharePoint 2013 Management Shell
• Run the following command: Get-SPEnterpriseSearchServiceApplication -Identity MySSA | Get-SPEnterpriseSearchSecurityTrimmer
• You should see something like this: