Skip to main content

Encrypting Your WebReports Connection String in VDM

Garrick Guillory
Updated

WebReports can use an encrypted database connection string instead of storing the connection information in plain text.

Use this article to generate an encrypted WebReports database connection string in VDM and update the WebReports appsettings.json file.

Before You Begin

Before encrypting the WebReports connection string:

  • Make sure you have access to VDM.
  • Make sure you have access to the WebReports installation directory.
  • Make sure you have permission to edit appsettings.json.
  • Create a backup copy of appsettings.json before making changes.
  • Have the WebReports Company ID, WR License Key, and current database connection string available.

Use caution when editing appsettings.json. Incorrect formatting can prevent WebReports from loading correctly.

Open WR App Settings in VDM

  1. Open VDM.
  2. Select Help.
  3. Select WR App Settings.

Opening WR App Settings in VDM

Open the WebReports appsettings.json File

  1. Navigate to the WebReports installation directory.
  2. Locate appsettings.json.
  3. Open the file in a text editor with the appropriate permissions.

WebReports appsettings.json configuration file

Locate the Required WebReports Values

In appsettings.json, locate the following values:

  • Company ID
  • WR License Key
  • Connection String

Copy these values so they can be entered into WR App Settings in VDM.

WebReports values required for connection-string encryption

SQL Server Instance Note:
If the SQL Server instance in the connection string contains a double backslash (\\), change it to a single backslash (\) before entering the connection string in VDM.

Enter the WebReports Information in VDM

In WR App Settings, enter or paste the following:

  1. Company ID
  2. WR License Key
  3. Connection String

Confirm that the information matches the values from the WebReports appsettings.json file.

Entering the WebReports configuration information in VDM

Create the Encrypted Connection String

  1. Select Create WebReports Database Connection String.
  2. VDM generates the encrypted database connection string.

Generating the encrypted WebReports database connection string

  1. Copy the encrypted connection string.

Keep the encrypted value available until the WebReports configuration has been updated.

Update appsettings.json

Return to the WebReports appsettings.json file.

  1. Locate the DefaultConnection setting.
  2. Replace the existing connection string with the encrypted connection string generated in VDM.
  3. Locate the EncryptedConnection setting.
  4. Set the value to:
"EncryptedConnection": "true"

WebReports configured to use the encrypted connection string

Save the Configuration

  1. Save the changes to appsettings.json.
  2. Close the text editor.
  3. Confirm that the encrypted connection string was saved under DefaultConnection.
  4. Confirm that EncryptedConnection is set to "true".

If WebReports does not recognize the updated configuration, restart the WebReports application and verify the settings again.

Troubleshooting

WebReports Cannot Connect to the Database

If WebReports cannot connect after updating the connection string:

  • Confirm that the complete encrypted connection string was copied from VDM.
  • Confirm that the encrypted value was entered under DefaultConnection.
  • Confirm that EncryptedConnection is set to "true".
  • Verify that the correct appsettings.json file was edited.

VDM Does Not Generate the Connection String

  • Confirm that the Company ID is correct.
  • Confirm that the WR License Key is correct.
  • Confirm that the database connection string was entered correctly.
  • If using a named SQL Server instance, confirm that the instance uses a single backslash (\) in VDM.

WebReports Does Not Start After Editing appsettings.json

  • Reopen appsettings.json.
  • Confirm that the JSON formatting is valid.
  • Confirm that quotation marks and commas were not accidentally removed.
  • Restore the backup copy if necessary.

If the issue continues, contact BridgeWorks Support.

Related Articles

Related articles

Comments

0 comments

Please sign in to leave a comment.