You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Basic Setup

Step 1: Download Plugin Deployment Package

The deployment package zip is located here. Download it and unzip it.

The following is the directory structure within the zip file:


On this page:

Step 2: Plugin Setup

  1. Under the \config folder, locate the file named configurationParameters.xml and open it in a file editor.
  2. In the xml structure, under StagerBDCModel specify the following values:
    • stagingRepositoryUrl: The host port where the STageR is running
    • sharePointServiceUrl: The host port where the SharePoint 2013 Central Administration is running
    • searchServiceApplicationName: The name of the search service application within SharePoint
    • stagerFolderPath: The path to the root directory of STageR
  3. Open SharePoint Management Shell as an administrator and go to the \scripts folder.

  4. Run the following:

    .\DeployStagerPlugin.ps1 -configurationFilePath ..\config\configurationParameters.xml
  5. If all went well it should present the following:

Step 3: Model and Content Source Setup

  1. Under the \config folder, locate the file named configurationParameters.xml (the one you modified in the previous step) and create a copy of it.
  2. Modify the following fields in the new copy:
    • contentSourceName: The name of the content source that will appear under Search Service Application in SharePoint
    • storageUnitName: The name of the Storage Unit within STageR from which the content will be extracted
    • storageUnitScope: The scope within the Storage Unit. The value of 'publisher' is recommended. 
    • maxBatchesToProcess: The maximum number of batches processed by the plugin per execution
    • batchSize: The maximum number of documents per batch processed
    • certPath: The path to the .p12 or .pfx file if SSL is needed. If not, leave the field empty.
    • certPassword:  The password to the .p12/.pfx file if SSL is needed. If not, leave the field empty.
    • claimsIssuer:  The issuer of the access claims. Accepted values are 'public' for no issuer, 'aspire' to use the Aspire Group Expansion or 'windows'.
    • useFullName:  Specifies if claims should use full name (domain/name) when sent to the group expander
  3. Open the SharePoint Management Shell as an administrator and go to the \scripts folder.

  4. Run the following:

    .\DeployModel.ps1 -configurationFilePath ..\config\<the file name of the new xml>
  5. If all went well, it should present the following:

Step 4: Schedule the Content Source Crawls

  1. Go to SharePoint Central Admin > Manage Service Applications > Search Service Application (the name specified in the configuration) > Content Sources
  2. Locate the content source you configured in the previous step.
  3. From the drop-down, you can trigger crawls directly. To schedule automatic crawls, select Edit.
  4. In the new page, scroll down to Crawl Schedules and set the schedule as needed.


Uninstallation

Manual Removal

Step 1:  Remove Content Source

  1. Go to SharePoint Central Admin > Manage Service Applications > Search Service Application (the name specified in the configuration) > Content Sources
  2. Locate the content source you want to remove.
  3. From the drop-down, select Delete and confirm.

Step 2: Remove Model

  1. Go to SharePoint Central Admin > Manage Service Applications > Business Data Connectivity Service
  2. From the top drop-down, select BDC Models.
  3. Select the model you want to remove. (Its name should be similar to the content source's name.)
  4. Click Delete and confirm.


Step 3: Remove the Plugin from Farm Solutions

  1. Go to the Services Management console and restart the service named SharePoint Server Search 15.

    Sometimes this service doesn't release the farm solution and it becomes impossible to remove it from the SharePoint Central Admin.
  2. Make sure the service named SharePoint Timer Service is up and running.
  3. Go to SharePoint Central Admin > System Settings > Manage Farm Solutions
  4. Select stagerbdcplugin.wsp and Retract Solution.
  5. In the following page, make sure the option under Retract When? is set to Now.

  6. Select OK.

    The user needs to be machine administrator for this to work.
  7. Wait for the solution to retract. (Keep refreshing the browser window.)
  8. Once the solution is retracted, click on it again and once inside the page, select Remove Solution.
    Removal should be quick.




Automatic Removal

Step 1: Remove Content Source and Model

  1. Open SharePoint Management Shell as administrator.

    A machine and farm administrator user is needed for this.
  2. Go to the Deploy\scripts directory.

  3. Run the following:

    .\RemoveModelAndContentSource.ps1 -configurationFilePath ..\config\<The Content Source configuration>.xml
    Make sure the configuration file you specified is the same one you used when creating the content source you want to remove.
  4. Both the content source and model should have been removed.


Step 2: Remove Plugin

  1. Open SharePoint Management Shell as administrator.

    A machine and farm administrator user is needed for this.
  2. Go to the Deploy\scripts directory.

  3. Run the following:  

    .\RemoveStagerPlugin.ps1 -configurationFilePath ..\config\configurationParamenters.xml
  4. The farm solution should have been removed.


Custom Content Configuration

The plugin uses the content processing capability of STageR to normalize the content that is stored in STageR, but the structure and data may be different depending on the source. The content is processed by SharePointBCSMapping.js after the file is in STageR's processing_modules directory and the storage unit has been configured to use it. For more information go here.


Security Pre-Trimmer Installation

For the Security Pre-Trimmer installation go here.


  • No labels