Skip to main content

Update WebReports to the Latest Version

Cory Fifield
Updated

This article is currently being updated. Some information may change while revisions are in progress. Please check back soon for the latest version.

 

WebReports updates are currently performed manually by replacing the existing application files with the files from the latest WebReports build.

Use this article to safely update an existing WebReports installation while preserving the current configuration.

Before You Begin

Before updating WebReports:

  • Confirm that you have administrative access to the WebReports server.
  • Confirm that you have access to Internet Information Services (IIS) Manager.
  • Back up the existing WebReports installation before replacing any files.
  • Review the current WebReports Deployment Requirements and Network Architecture to confirm that the server meets the requirements for the latest release.
  • Make sure the required ASP.NET Core Hosting Bundle is installed for the WebReports version being deployed.

Important: Do not overwrite the existing appsettings.json file. This file contains environment-specific WebReports configuration settings.

Stop WebReports in IIS

Before replacing the WebReports files:

  1. Open Internet Information Services (IIS) Manager.
  2. Locate the WebReports application pool.
  3. Stop the WebReports application pool.
  4. Stop the WebReports site or IIS service as used in your environment.

mceclip9.png

Stopping WebReports in IIS before the update

Back Up the Current WebReports Installation

  1. Open File Explorer.
  2. Navigate to the directory containing the current WebReports installation.
  3. Copy the entire WebReports folder.
  4. Paste the folder into a safe backup location.

Examples include:

  • A designated backup directory
  • A temporary folder outside the live WebReports directory
  • Another secured storage location

mceclip2.png

Creating a backup of the current WebReports installation

Keep this backup until the updated WebReports installation has been tested successfully.

Clean the WebReports Directory

Before copying the new application files, remove the files from the existing installation that will be replaced.

  1. Open the WebReports installation directory.
  2. Select the existing application files.
  3. Keep the following items:
    • appsettings.json
    • The existing wwwroot folder
  4. Delete the remaining application files.
  5. Open the existing wwwroot folder.
  6. Delete the existing CSS and JS folders.

mceclip1.png

Preparing the existing WebReports directory for the update

Important: Do not delete appsettings.json. This file contains the current WebReports configuration.

Download the Latest WebReports Version

Download the latest WebReports ZIP package:

Download the Latest WebReports Version

Save the ZIP file to the WebReports server.

Latest WebReports ZIP package

Unblock the WebReports ZIP File

Before extracting the downloaded package:

  1. Right-click the WebReports ZIP file.
  2. Select Properties.
  3. If the Unblock option is available, select it.
  4. Select Apply.
  5. Select OK.

Unblocking the downloaded WebReports ZIP file

Windows may block files downloaded from the internet. Unblocking the ZIP before extraction helps prevent the extracted application files from retaining the blocked status.

Extract the New WebReports Files

  1. Extract the WebReports ZIP file to a temporary folder.
  2. Open the extracted folder.
  3. Locate appsettings.json.
  4. Delete appsettings.json from the extracted update files.

Removing appsettings.json from the update files

Important: Deleting the new appsettings.json before copying the update prevents the current WebReports configuration from being overwritten.

Copy the Updated WebReports Files

  1. Select all remaining files and folders in the extracted WebReports directory.
  2. Copy the selected files.
  3. Paste them into the live WebReports installation directory.
  4. If Windows prompts you to replace existing files, select Replace the files in the destination or Yes to All.

Copying the latest WebReports files into the existing installation

Check Version-Specific Requirements

Some WebReports releases may require additional configuration changes or updated dependencies.

For current WebReports releases:

Encrypt=Yes;TrustServerCertificate=Yes

Example:

Server=SQLServerName\SQLInstanceName;Database=WebReports;User Id=YourSQLUser;Password=YourSQLPassword;Connect Timeout=60;Encrypt=Yes;TrustServerCertificate=Yes

Review appsettings.json and confirm that the existing database connection string includes any settings required by the version being installed.

Always review the requirements for the WebReports version being deployed before starting the application.

Start WebReports in IIS

After the updated files have been copied:

  1. Open IIS Manager.
  2. Start the IIS service or WebReports site.
  3. Start the WebReports application pool.

mceclip7.png

Starting IIS after the WebReports update

mceclip8.png

Starting the WebReports application pool

Verify the Update

  1. Open a supported web browser.
  2. Navigate to the WebReports URL.
  3. Confirm that WebReports loads successfully.
  4. Verify that the expected WebReports functionality is available.
  5. Confirm that the application is running the expected version.

Verifying WebReports after the update

Do not remove the backup of the previous installation until the updated environment has been successfully verified.

Troubleshooting

WebReports Does Not Start After the Update

If WebReports does not start:

  • Confirm that the WebReports application pool is running.
  • Confirm that the WebReports site is running in IIS.
  • Verify that the required ASP.NET Core Hosting Bundle is installed.
  • Confirm that the original appsettings.json was preserved.
  • Review the WebReports and Windows event logs for errors.

WebReports Cannot Connect to SQL Server

  • Verify the existing connection string in appsettings.json.
  • Confirm that the SQL Server name, database, username, and password are correct.
  • Confirm that the connection string contains Encrypt=Yes;TrustServerCertificate=Yes when required.
  • Confirm that SQL Server is accessible from the WebReports server.

Configuration Settings Are Missing

If existing WebReports settings are missing after the update:

  • Confirm that the original appsettings.json was not overwritten.
  • Compare the current configuration against the backup created before the update.
  • Restore the previous configuration if necessary.

The Updated Version Does Not Work Correctly

If the update cannot be completed successfully:

  1. Stop WebReports in IIS.
  2. Restore the backup of the previous WebReports installation.
  3. Start WebReports again.
  4. Confirm that the previous installation is working.

Contact BridgeWorks Support if the issue continues.

Related Articles

Related articles

Comments

0 comments

Please sign in to leave a comment.