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 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 script for the corresponding SharePoint version:

   Code Block
   language bash theme FadeToGrey
   .\DeployStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployStagerPlugin_2016.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 script for the corresponding SharePoint version:

   Code Block
   language bash theme FadeToGrey
   .\DeployModel_2013.ps1 -configurationFilePath ..\config\<the file name of the new xml> .\DeployModel_2016.ps1 -configurationFilePath ..\config\<the file name of the new xml>

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

Step 4: Content Processing Module 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:
   • stagerFolderPath: The local 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
   language bash theme FadeToGrey
   .\DeployContentProcessingModule.ps1 -configurationFilePath ..\config\<the file name of the new xml>

5. No error should appear if all went well.

Step 4a: Manual Setup

This applies for non-Windows operating systems.

1. Copy the SharePointBCSMapping.js file to STageR's \process_modules directory.

2. From a REST client run the following command:

   Code Block
   theme FadeToGrey
   http://<host:port>/admin/setContentProcessingModules/<Storage Unit Name> {"modules" : {"<Storage Scope Name>":[{"module" : "SharePointBCSMapping"}]}}

Step 5: 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

In order to remove the StageR BDC Plugin, there are two options: manual and automatic removal 

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.

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
   language bash theme FadeToGrey
   .\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 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.

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

2. Go to the Deploy\scripts directory.

3. Run the following script for the corresponding SharePoint version:  

   Code Block
   language bash theme FadeToGrey
   .\RemoveStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveStagerPlugin_2016.ps1 -configurationFilePath ..\config\configurationParameters.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 the STageR's processing_modules directory and the storage unit has been configured to use it. For more information, go Configure Storage Unit.
The SharePointBCSMapping.js file can be modified to add, rename, update or delete fields that will be uploaded to SharePoint.  However, the following fields are expected by the BDC connector and therefore cannot be changed:

• action
• docId
• name
• claims_issuer
• use_full_name
• author
• last_modified
• title
• description
• url
• text
• acls

Security Pre-Trimmer Installation