Install BrightWork

This article details how to install BrightWork on Microsoft SharePoint.

At a high-level the sequence of steps are as follows:

1. Pre-Install Steps
2. Install BrightWork
3. Deploy BrightWork 14 Solution
4. BrightWork License
5. Using SSL
6. Update Other Servers in the Farm
7. Activate BrightWork Timer Job Features
8. Create a BrightWork Site Collection
9. Post-install Checklist

Pre-Install Steps

Pre-Install Recomendation

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.

• Ideally carry out an upgrade or a new install on a test server first.

System Requirements

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 2016 for more information.

Pre-Requisites

• Installing or upgrading BrightWork should be performed by an experienced SharePoint Administrator. You need administrative privileges on your SharePoint server to install BrightWork.
• While installing, you need full control access to the SQL Admin Content Database.
• We recommend you create a full backup of your SharePoint installation before starting the installation.
• Your setup meets the minimum System Requirements - these also need to be checked for upgrades.
• The correct and same version of SharePoint is installed on all servers in your farm.
• All SharePoint servers are fully configured and none have updates pending.
• You have administrative privileges on your SharePoint server (including all servers in a SharePoint Farm).
• You have full control access to the SQL Admin Content Database.
• We strongly recommend that you perform both installations and upgrades of BrightWork during a maintenance window, as the process will render SharePoint sites temporarily unavailable.
• The maximum number of worker processes is set at 1 per Application Pool (i.e. no web gardens).
• IP Affinity is enabled between Multiple Web Front End Servers (if multiple WFEs exist).
• Your web.config is configured as expected - an incorrectly configured web.config is the most common source of issues relating to installs or upgrades.

  Note: Installing BrightWork writes updates to your web.config to facilitate charting and other reporting features.

Install BrightWork

Install BrightWork on Central Admin Server

1. Copy the BrightWork installer to your server desktop and double-click on it to begin the installation.
2. Click Next.
3. Review the License Agreement, select I Accept and click Next.
4. Click Install, then click Finish.

Deploy the BrightWork Solution

1. Right-click on the SharePoint 2016 Management Shell and select Run as administrator.

   

2. Run this command to change to the install files folder:

   cd "C:\Program Files (x86)\BrightWork\16\Install Files"

3. Next, run this command:

   .\InstallSolution.ps1 "C:\Program Files (x86)\BrightWork\16\Install Files\BrightWork.wsp"

   This will:

   • Add solution
   • Deploy solution
   • Restart IIS
   • Restart timer
   • Install-SPApplicationContent

4. Close the SharePoint Management Shell when "Solution BrightWork.wsp is now installed" displays.

   

   Note: If you experience a long delay, seeing Deployment Status: Scheduled, it may relate to a known issue with timer jobs. See this Microsoft article, Administrative Timer Jobs not running after upgrade, for details. This article also applies to later versions of SharePoint.

5. Right-click on the SharePoint 2016 Management Shell, click Run as administrator and run this command: Install-BWDiagnosticsService
6. Close the SharePoint Management Shell.

Run psconfig

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:

1. Right-click on the SharePoint 2016 Management Shell and click Run as administrator.

2. Next, run this command to perform a build-to-build upgrade:

   psconfig.exe -cmd upgrade -inplace b2b -force -includesiteupgrade

3. The below screen should display.

   

4. Run iisreset and close the Command Prompt window once "Internet services successfully restarted" is displayed.

Deploy BrightWork 14 Solution

If you are upgrading from BrightWork for SharePoint 2010 you will also need to deploy an additional solution.

1. Right-click on the SharePoint 2016 Management Shell and select Run as administrator.

2. Run this command to change to the install files folder:

   cd "C:\Program Files (x86)\BrightWork\16\Install Files"

3. Next, enter this command:

   .\InstallSolution.ps1 "C:\Program Files (x86)\BrightWork\16\Install Files\BrightWork_14.wsp"

   This will:

   • Add solution
   • Deploy solution
   • Restart IIS
   • Restart timer
   • Install-SPApplicationContent
4. Close the SharePoint Management Shell when "Solution BrightWork_14.wsp is now installed" displays.

BrightWork License

Add BrightWork License

BrightWork for SharePoint 2016 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.

1. Unzip the License file you received from BrightWork to a suitable location on your server.
2. Login to SharePoint Central Admin and click General Application Settings.
3. Click Add BrightWork License.
4. Click Browse and select the BrightWork license XML file.

5. Click Add.

   

Obtain BrightWork License

BrightWork for SharePoint 2016 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.

1. Login to SharePoint Central Admin and click General Application Settings.
2. Click Manage BrightWork License.

3. Copy the Farm ID and email it to [email protected].

   

   Using SSL

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:

1. Login to SharePoint Central Administration and click Security.
2. Click Manage trust.
3. Click New.
4. Fill out the form and click OK.

Update Other Servers in the Farm

Run the steps below on all other servers in the farm.

1. Right-click on the SharePoint 2016 Management Shell and select Run as administrator.

2. 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

3. Close the SharePoint Management Shell.
4. Right-click on the SharePoint 2016 Management Shell and select Run as administrator.
5. Run this command: Install-BWDiagnosticsService

Activate BrightWork Timer Job Features

BrightWork includes timer jobs that require feature activation to take advantage of the functionality they provide.

The features that need to be activated include:

• Project Metrics Recalculation Timer Job
  • The Project Metrics Recalculation Timer automatically recalculates all the active metrics.
• BrightWork Project Cache Maintenance Timer Job
  • The BrightWork Project Cache Maintenance Timer Job validates and updates the Project Cache.
• BrightWork Project Status Report Cache Maintenance Timer Job
  • The BrightWork Project Status Report Cache Maintenance Timer Job validates and updates the Project Status Report Cache.
• BrightWork Scheduled Email Timer Job
  • The BrightWork Scheduled Email Timer Job sends Scheduled Email Reports.
• BrightWork Task Scheduling Timer Job
  • The BrightWork Task Scheduling Timer Job recalculates task scheduling enabled lists.
• BrightWork User Access Report Timer Job
  • The BrightWork User Access Report Timer Job generates a User Access Report in CSV format on the server.
• BrightWork Work Cache Maintenance Timer Job
  • The BrightWork Work Cache Maintenance Timer Job validates and updates the Work Cache.

To activate the timer job features:

1. Login to SharePoint Central Administration.
2. Click Manage web applications.
3. Ensure you have the correct web application selected and click Manage Features.

4. Click Activate beside relevant timer jobs.

   

5. Click OK.

Create a BrightWork Site Collection

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:

1. Right-click on the SharePoint 2016 Management Shell and select Run as administrator.

2. Run this command to change to the install files folder:

   cd "C:\Program Files (x86)\BrightWork\16\Install Files"

3. Next, enter this command:

   .\ProvisionTrainingSite.ps1

4. When prompted for a URL for the new site collection, you can use the default URL provided by hitting Enter or you can create your own.
5. You can use the default site collection title provided by hitting Enter, or you can create your own.

The other method is to create an empty BrightWork site collection:

1. Login to the SharePoint Central Administration page.
2. Click Create site collections.
3. Ensure you have the correct Web Application.
4. Give the site a Title and Description.
5. Specify the URL name and URL path to create a new site, for example: http://myserver/sites/mysitename

6. Select BrightWork Site from the Template Selection box.

   

7. 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).

8. Click OK.

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.

Post-install Checklist

When you have completed installation of BrightWork, it is recommended to run through the Post-Install Checklist to make sure everything is working correctly.