This article details how to install BrightWork on Microsoft SharePoint.
At a high-level the sequence of steps are as follows:
Please review the checklist below before installing BrightWork. If you have any questions regarding any of the items on this list, please contact our support team before proceeding with the install or upgrade.
BrightWork has the same system requirements as SharePoint. The correct and same version of SharePoint must be installed on all servers in your farm. See detailed hardware and software requirements for SharePoint 2019 for more information.
Note: SharePoint 2019 RTM (v16.0.10337.12109) is the minimum version of SharePoint 2019 required to install BrightWork.
Note: Installing BrightWork writes updates to your web.config to facilitate charting and other reporting features.
Note: If installing BrightWork in an environment with SharePoint side-by-side upgrade functionality enabled, follow these steps:
Install-SPApplicationContent
, run Copy-SPSideBySideFiles
on all servers.Right-click on the SharePoint 2019 Management Shell and select Run as administrator.
Run this command to change to the install files folder:
cd "C:\Program Files (x86)\BrightWork\16\Install Files"
Next, run this command:
.\InstallSolution.ps1 "C:\Program Files (x86)\BrightWork\16\Install Files\BrightWork.wsp"
This will:
Close the SharePoint Management Shell when "Solution BrightWork.wsp is now installed" displays.
Note: Please ensure you close the SharePoint Management Shell before proceeding with the next step. This ensures that it is running under a different process.
Install-BWDiagnosticsService
The SharePoint Products Configuration Wizard (psconfig) is a SharePoint Utility that needs to be run periodically for proper SharePoint maintenance, for instance, after a SharePoint Cumulative Update or to update the SharePoint databases with changes specified.
It is needed in a new BrightWork install to update SharePoint after installing BrightWork. Please note that the psconfig utility can highlight issues with the configuration of your SharePoint Server Farm.
To run psconfig:
Next, run this command to perform a build-to-build upgrade:
psconfig.exe -cmd upgrade -inplace b2b -force -includesiteupgrade
The below screen should display.
iisreset
and close the Command Prompt window once "Internet services successfully restarted" is displayed.If you are upgrading from BrightWork for SharePoint 2010 you will also need to deploy an additional solution.
Note: This section only needs to be carried out if you are upgrading BrightWork 2010 and SharePoint via the Database Attach method. BrightWork 14 refers to the version of the Microsoft Office family of products that BrightWork was installed on.
Run this command to change to the install files folder:
cd "C:\Program Files (x86)\BrightWork\16\Install Files"
Next, enter this command:
.\InstallSolution.ps1 "C:\Program Files (x86)\BrightWork\16\Install Files\BrightWork_14.wsp"
This will:
BrightWork for SharePoint 2019 licensing requires a unique license per farm. You should already have your BrightWork license for your main farm. If you do not have your license, or require licenses for other farms in your organization, follow the steps in Obtain BrightWork License.
Click Add.
Note: The BrightWork license can take up to 10 minutes to propagate. To apply it immediately, you can run iisreset
.
To replace an existing BrightWork for SharePoint license follow these steps:
BrightWork for SharePoint 2019 licensing requires a unique license per farm. You should already have your BrightWork license for your main farm. If you do not have your license, or require licenses for other farms in your organization, follow the steps below.
To obtain your BrightWork license, you must supply BrightWork with your unique Farm ID and BrightWork will use this to generate a license for your farm.
Copy the Farm ID and email it to [email protected].
To use BrightWork on an SSL-enabled SharePoint server, you must add the Root Certificate from the SSL Authority to establish a Trust Relationship.
To establish a Trust Relationship:
Run the steps below on all other servers in the farm.
Run the following commands (in sequence) on each front end server the solution has been deployed to:
iisreset
net stop sptimerv4
net start sptimerv4
Install-SPApplicationContent
Install-BWDiagnosticsService
BrightWork includes timer jobs that require feature activation to take advantage of the functionality they provide.
The features that need to be activated include:
Note: This task requires administrator access to the server and some knowledge of administering SharePoint.
To activate the timer job features:
Click Activate beside relevant timer jobs.
Note: The timer job features must be activated on a web application by web application basis.
The Project Schedule Recalculation Timer Job supports a deprecated BrightWork feature – you do not have to activate this timer job.
There are two ways to create a BrightWork Site Collection. The first way is to create a Training Zone site collection as part of the install process.
To create a Training Zone site collection:
Run this command to change to the install files folder:
cd "C:\Program Files (x86)\BrightWork\16\Install Files"
Next, enter this command:
.\ProvisionTrainingSite.ps1
Note: The Training Zone may take a number of minutes to create, due to the number of sites and templates being created.
The other method is to create an empty BrightWork site collection:
Select BrightWork Site from the Template Selection box.
Specify the Primary Site Collection Administrator.
Note: The Primary or Secondary Site Collection Administrator of a BrightWork Site Collection must be a farm-level administrator (this applies even if no SharePoint farm exists).
If you are using SharePoint Server, you may encounter a SiteFeedFeatureReceiver error when you try to create a BrightWork Site Collection. If so, you should deploy the User Profile Service Application with the service account added as an administrator. You do not have to deploy My Sites.
When you have completed installation of BrightWork, it is recommended to run through the Post-Install Checklist to make sure everything is working correctly.