Page History
Table of Contents |
---|
Basic Setup
Step 1: Download plug-in deployment package
The deployment package zip is located here. Download it and unzip it.
The following is the directory structure within the zip file:
Step 2: Plug-In Setup
- Under the \config folder, locate the file named configurationParameters.xml and open it in a file editor.
- 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
- Open SharePoint Management Shell as an administrator and go to the \scripts folder
Run the following:
Code Block language bash theme FadeToGrey .\DeployStagerPlugin.ps1 -configurationFilePath ..\config\configurationParameters.xml
- If all went well it should present the following:
Step 3: Model and Content Source Setup
- Under the \config folder, locate the file named configurationParameters.xml (The one you modified in the previous step) and create a copy of it.
- 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 the content will be extracted from
- storageUnitScope: The scope within the Storage Unit. The value of 'publisher' is recomended
- maxBatchesToProcess: The maximum number of batches processed by the plug-in 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
- certPassword: The password to the .p12/.pfx file if SSL is needed. Leave empty if not
- claimsIssuer: The issuer of the access claims. Accepted values are 'public' for no issuer, 'aspire' to use Aspire Group Expansion or 'windows'
- useFullName: Specifies if claims should use full name (i.e. domain/name) when sent to the group expander
- Open the SharePoint Management Shell as an administrator and go to the \scripts folder
Run the following:
Code Block language bash theme FadeToGrey .\DeployModel.ps1 -configurationFilePath ..\config\<the file name of the new xml>
- If all went well, it should present the following:
Step 4: Schedule the Content Source crawls
- Go to SharePoint Central Admin → Manage Service Applications → Search Service Application (the name specified in the configuration) → Content Sources
- Locate the Content Source you configured in the previous step
- Hover the mouse over it and click the dropdown
- Here you can trigger crawls directly, but to schedule automatic crawls select Edit
- In the new page, scroll down to Crawl Schedules and set the schedule as needed.
Uninstallation
Manual Removal
Step 1: Remove Content Source
- Go to SharePoint Central Admin → Manage Service Applications → Search Service Application (the name specified in the configuration) → Content Sources
- Locate the Content Source you want to remove
- Hover the mouse over it and click the dropdown
- Select Delete and confirm
Step 2: Remove Model
- Go to SharePoint Central Admin → Manage Service Applications → Business Data Connectivity Service
- From the top dropdown select BDC Models
- Select the Model you want to remove (its name should be similar to the Content Source's)
- Click Delete and confirm
Automatic Removal
Step 1: Remove Content Source and Model
Open SharePoint Management Shell as administrator
Note A machine and farm administrator user is needed for this - Go to the Deploy\scripts directory
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 - Both the Content Source and Model should have been removed
Step 2: Remove Plug-In
Open SharePoint Management Shell as administrator
Note A machine and farm administrator user is needed for this - Go to the Deploy\scripts directory
Run the following:
Code Block language bash theme FadeToGrey .\RemoveStagerPlugin.ps1 -configurationFilePath ..\config\configurationParamenters.xml
- The farm solution should have been removed
Overview
Content Tools