Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Basic Setup


Step 1: Download

plug-in deployment package

Plugin Deployment Package

On this page:

Table of Contents

The deployment package zip is located here.

 Download

Download it and unzip it.

The following is the directory structure within the zip file:

Step 2:

Plug-In

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
    • host port where the STageR is running
    • sharePointServiceUrl: The
    Host:
    • 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:

    Code Block
    languagebash
    themeFadeToGrey
    .\DeployStagerPlugin.ps1 -configurationFilePath ..\config\configurationParameters.xml


  5. If all went well it should present the following:

Image Modified

Step 3: Model and Content Source Setup

  1. Under the \config folder, locate the file named configurationParameters.xml (The 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
    where
    • from which the content will be extracted
    from
    • storageUnitScope: The scope within the Storage Unit.
     The
    • The value of 'publisher' is
    recomended 
    • recommended. 
    • maxBatchesToProcess: The maximum number of batches processed by the
    plug-in
    • 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.
     Leave empty if not
    • If not, leave the field empty.
    • certPassword:  The password to the .p12/.pfx file if SSL is needed.
     Leave empty if not
    •  If not, leave the field empty.
    • claimsIssuer:  The issuer of the access claims.
     Accepted
    • Accepted values are 'public' for no issuer, 'aspire' to use the Aspire Group Expansion or 'windows'.
    • useFullName:  Specifies if claims should use full name (
    i.e.
    • 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:

    Code Block
    languagebash
    themeFadeToGrey
    .\DeployModel.ps1 -configurationFilePath ..\config\<the file name of the new xml>


  5. If all went well, it should present the following:

Image Modified

Step 4: Schedule the Content Source

crawls

Crawls

  1. Go to SharePoint Central Admin → Admin > Manage Service Applications → Applications > Search Service Application (the name specified in the configuration) →  > Content Sources
  2. Locate the Content Source content source you configured in the previous step.
  3. Hover the mouse over it and click the dropdown
  4. Here From the drop-down, you can trigger crawls directly, but to . To schedule automatic crawls, select Edit.
  5. 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 → Admin > Manage Service Applications → Applications > Search Service Application (the name specified in the configuration) →  > Content Sources
  2. Locate the Content Source content source you want to remove.
  3. Hover the mouse over it and click the dropdown
  4. Select From the drop-down, select Delete and confirm.

Step 2: Remove Model

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


Step 3: Remove the

Plug-In

Plugin from Farm Solutions

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

    Note
    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 → Admin > System Settings → Manage farm solutionsSettings > Manage Farm Solutions
  4. Select Click on stagerbdcplugin.wsp Click on and Retract Solution.
  5. In the following page, make sure the option under Retract When? is set to Now.
  6. Click Select OK.

    Note
    The user needs to be machine administrator for this to work.


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




Automatic Removal

Step 1: Remove Content Source and Model

  1. Open SharePoint Management Shell as administrator.

    Note
    A machine and farm administrator user is needed for this.


  2. Go to the Deploy\scripts directory.
  3. Run the following:

    Code Block
    languagebash
    themeFadeToGrey
    .\RemoveModelAndContentSource.ps1 -configurationFilePath ..\config\<The Content Source configuration>.xml


    Note
    Make sure the configuration file you specified is the same one you used when creating the Content Source content source you want to remove.


  4. Both the Content Source content source and Model model should have been removed.


Step 2: Remove

Plug-In

Plugin

  1. Open SharePoint Management Shell as administrator.

    Note
    A machine and farm administrator user is needed for this.


  2. Go to the Deploy\scripts directorythe Deploy\scripts directory.
  3. Run the following:  

    Code Block
    languagebash
    themeFadeToGrey
    .\RemoveStagerPlugin.ps1 -configurationFilePath ..\config\configurationParamenters.xml


  4. The farm solution should have been removed.


Custom Content Configuration


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


Security Pre-Trimmer Installation


For the Security Pre-Trimmer installation go here.