Version 2.X introduces important changes in installation and upgrades. For new installations continue in this section, otherwise look for the corresponding section below. |
Run the following script for the corresponding SharePoint version. This will install the root assembly of the BDC Plugin. Once installed and crawls have been performed further updates will be explained in the corresponding section.
.\DeployStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployStagerPlugin_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployStagerPlugin_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Run the following script for the corresponding SharePoint version. This will install the business logic assemblies of the BDC Plugin.
.\DeployBDCBusinessLogic_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Once the BDC model has been created in SharePoint, it is wired to the version of the root assembly, therefore any attempt to update the model with a different version will cause the content source to run a full crawl the next time regardless of the crawl type that was selected and ultimately deleting all content that was previously crawled by the content source.
After trying several solutions, the one that would best address the issue was to separate the root assembly from the actual business logic through reflection. The upgrade consists on overwriting the root assembly with the one provided in the new deployment zip file and then deploying the business logic.
.\RemoveStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveStagerPlugin_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveStagerPlugin_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Sometimes SharePoint doesn't remove the solution after running the script. It is a good practice to check under SharePoint's Central Administration → Manage Farm Solutions and if the solution is still there, remove it manually from the UI. See Manual Removal below. |
.\DeployStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployStagerPlugin_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployStagerPlugin_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
.\DeployBDCBusinessLogic_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Upgrades from version 2.X are easier since they only require removing the previous Business Logic components and then installing the new ones, and updating the registry settings.
Go to the \scripts folder and run the following to uninstall only the SharePoint solution:
.\RemoveBDCBusinessLogic_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveBDCBusinessLogic_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveBDCBusinessLogic_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Sometimes SharePoint doesn't remove the solution after running the script. It is a good practice to check under SharePoint's Central Administration → Manage Farm Solutions and if the solution is still there, remove it manually from the UI. See Manual Removal below. |
.\DeployBDCBusinessLogic_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\DeployBDCBusinessLogic_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Run the following script for the corresponding SharePoint version:
.\DeployModel_2013.ps1 -configurationFilePath ..\config\<the file name of the new xml> .\DeployModel_2016.ps1 -configurationFilePath ..\config\<the file name of the new xml> .\DeployModel_2019.ps1 -configurationFilePath ..\config\<the file name of the new xml> |
The default values defined in the configurationParameters.xml file in the StagerBDCModel node will crawl 500 items in the Storage Unit specified (maxBatchesToProcess times batchSize). If the Storage Unit contains more than that amount they will no be crawled in the first full crawl. |
Currently, the content source/model installation script doesn't support the setup of the content processing module in StageR when it's configured to use SSL. Configure the content processing module using a REST client as explained here. Also, this only works for Windows hosts. For other operating systems use the manual approach. |
Run the following:
.\DeployContentProcessingModule.ps1 -configurationFilePath ..\config\<the file name of the new xml> |
This has to be done on every machine that will host STageR. You can just copy the whole Deploy folder to each machine, change the stagerFolderPath value as needed and then run the script. |
This applies for non-Windows operating systems.
From a REST client run the following command:
http://<host:port>/admin/setContentProcessingModules/<Storage Unit Name> {"modules" : {"<Storage Scope Name>":[{"module" : "SharePointBCSMapping"}]}} |
In order to remove the StageR BDC Plugin, there are two options: manual and automatic removal
Please note that uninstallation process requires a user with Machine Administrator rights. |
Open SharePoint Management Shell as administrator.
A machine and farm administrator user is needed for this. |
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. |
Open SharePoint Management Shell as administrator.
A machine and farm administrator user is needed for this. |
Run the following script for the corresponding SharePoint version:
.\RemoveStagerPlugin_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveStagerPlugin_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveStagerPlugin_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Run the following script for the correspondint SharePoint version:
.\RemoveBDCBusinessLogic_2013.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveBDCBusinessLogic_2016.ps1 -configurationFilePath ..\config\configurationParameters.xml .\RemoveBDCBusinessLogic_2019.ps1 -configurationFilePath ..\config\configurationParameters.xml |
Sometimes SharePoint doesn't remove the solution after running the script. It is a good practice to check under SharePoint's Central Administration → Manage Farm Solutions and if the solution is still there, remove it manually from the UI. See Manual Removal below. |
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: