Encrypting Your WebReports Connection String in VDM

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Article Goal

Learn how to encrypt your WebReports connection string and Okta settings using VDM’s built-in WR App Settings tool to securely update your appsettings.json file.

What Is an Encrypted Connection String?

An encrypted connection string protects your sensitive connection details—like SQL Server credentials—by encoding them into a secure format. This encrypted string is then used in your appsettings.json file to safeguard your WebReports configuration.

Tip: Encrypting your connection string is strongly recommended for production environments to avoid exposing credentials in plain text.

Why Encrypt WebReports Settings?

• Protects your database credentials

• Reduces risk of unauthorized access

• Required for secure deployment in WebReports

• Simplifies management via VDM’s WR App Settings interface

Use Case: You're deploying WebReports to a client environment and want to keep their database credentials secure inside the appsettings file.

Where Do You Encrypt WebReports Settings?

Encryption for WebReports is handled within VDM. Navigate to the Help menu, then select WR App Settings to launch the encryption utility.

Steps to Encrypt Your SQL Connection String

Step 1: Open WR App Settings in VDM

• Launch VDM

• Click the Help menu at the top

• Select WR App Settings

Step 2: Open Your appsettings.json

• Locate your WebReports appsettings.json file

• Open it using a text editor (e.g., Notepad++ or VS Code)

Step 3: Copy Configuration Values

Inside the appsettings.json, locate and copy the following values only (not the quotes):

• Company ID

• WR License Key

• Connection String

Important Note: If you're using a SQL Instance, remove the extra backslash when copying.

• Incorrect: Server=SQLServerName\\SQLInstanceName;...
• Correct: Server=SQLServerName\SQLInstanceName;...

Step 4: Paste into WR App Settings

• In the WR App Settings window in VDM, paste the values into the matching fields:

  • Company ID

  • License Key

  • Connection String

Step 5: Create the Encrypted String

• Click the Create WebReports Database Connection String button

• A secure, encrypted string will appear in the text box below

Tip: Use Ctrl + A and Ctrl + C to quickly select and copy the entire encrypted string.

Step 6: Update the appsettings.json File

Example:

• Replace the unencrypted connection string with the new encrypted version within the quotes

  • "DefaultConnection": "s2XH69uAb+dCsiZEJjNPV1b9Jr5uRdb84EyZpao6/3wu3Jz53C"

• Then, set: "EncryptedConnection": "true"

Important Note: Ensure the encrypted string is properly enclosed in double quotes to avoid syntax errors.

Step 7: Save Your Changes

• Save the updated appsettings.json file

• Restart your WebReports service or application if applicable

Article Summary

Encrypting your WebReports connection string is an essential step in protecting sensitive SQL credentials and securing your deployment. Using VDM’s built-in WR App Settings tool, you can easily convert your plain-text connection string into an encrypted value, paste it into your appsettings.json, and toggle the EncryptedConnection flag to true. This ensures your data remains protected while allowing WebReports to function as intended without exposing critical information.

Use Case: You’re preparing a secure deployment of WebReports and need to ensure the SQL connection string is not readable in plain text—encryption is your answer.