Skip to main content

Migrating WebReports from Microsoft SQL Server to MySQL

Garrick Guillory
Updated

Use this article to migrate WebReports application data from an existing Microsoft SQL Server environment to a new MySQL-based WebReports environment.

Before You Begin

Before starting the migration:

  • Confirm that the new MySQL-based WebReports environment is installed and working.
  • Confirm that you can access both the source and destination WebReports environments.
  • Back up the existing Microsoft SQL Server WebReports database.
  • Make sure you have access to the source WebReports appsettings.json file.
  • Have administrator access to the new WebReports environment.

Keep the source database information secure. The connection string may contain the SQL Server name, database name, username, and password.

Locate the Source Database ID

Before starting the migration, locate the unique ID for the existing WebReports database.

  1. Sign in to the source WebReports environment.
  2. From the left navigation menu, expand Configuration.
  3. Select Registration.
  4. Scroll to the ID section at the bottom of the Registration page.
  5. Copy the value displayed in the ID field.

Locating the source WebReports database ID from Configuration → Registration

Save this ID. You will need it when configuring the import in the new MySQL WebReports environment.

Copy the Source Connection String

  1. On the source WebReports server, navigate to the WebReports installation directory.
  2. Open appsettings.json.
  3. Locate the DefaultConnection value.
  4. Copy the complete source SQL Server connection string.

The copied value should begin with Server= and include the entire connection string. Paste this value into the Source Connection String field on the Import WebReports Data screen.

Security: The connection string may contain the database server name, database name, user ID, and password. Store and transmit this information securely and redact these values from screenshots or public documentation.

Open the WebReports Import Tool

  1. Sign in to the new WebReports environment that will receive the migrated data.
  2. From the left navigation menu, expand Configuration.
  3. Select Database.
  4. On the Database Maintenance page, select IMPORT WEBREPORTS DATA at the top of the page, next to SHRINK DATABASE.

Opening the WebReports import tool from Configuration → Database

  1. The Import WebReports Data window opens.

Select the Source Database Type

After the Import WebReports Data window opens:

  1. Select the Source Database Type dropdown.
  2. Select MSSQL.

Selecting MSSQL as the source database type

For a migration from Microsoft SQL Server to MySQL, select MSSQL as the source database type.

Configure the Import Settings

After selecting MSSQL:

  1. In Source Database Unique ID, enter the ID copied from the source WebReports environment.
  2. In Source Connection String, paste the DefaultConnection value copied from the source appsettings.json file.
  3. Review the options under Data to Import.

The import window includes options such as:

  • Connection Profiles
  • API Keys
  • Email
  • Roles
  • Reports
  • Schedules
  • Logs
  • Configuration Settings
  • Tenants
  • UDFs
  • Users
  • Report Assignments
  • Completed Reports
  • Statistics History

Configuring the WebReports data import

Some items are automatically selected because they are required dependencies for other selected data.

Select the Data to Import

Select the WebReports data that should be migrated to the new environment.

Review the automatically selected dependency items before starting the import.

For example:

  • Roles may be required by Users or Report Assignments.
  • Reports may be required by Report Assignments or Logs.
  • Users may be required by API Keys, UDFs, Schedules, Completed Reports, or Logs.
  • Report Assignments may be required by Schedules or Completed Reports.
  • Connection Profiles may be required by Report Assignments or Logs.

Do not clear required dependency items unless the WebReports interface allows them to be changed.

Run the Import

After the source information and import options have been configured:

  1. Review the Source Database Unique ID.
  2. Confirm that MSSQL is selected as the Source Database Type.
  3. Verify the Source Connection String.
  4. Review the selected Data to Import.
  5. Select IMPORT WEBREPORTS DATA.

The import status appears at the bottom of the window.

WebReports import status at the start of the migration

The status area displays:

  • The current migration status
  • Validation or error messages
  • The completion percentage
  • Copy Details and Download Details options when available

If required source information is missing, WebReports displays a validation message in the status area. Correct the missing information before starting the migration again.

Monitor the Migration

Monitor the status area while WebReports imports the selected data.

The percentage should increase as the migration progresses. When the migration finishes, confirm that the status reaches 100% complete and indicates that the import completed successfully.

Do not close the import window while the migration is running.

Sign Out and Back In

After the migration completes:

  1. Sign out of WebReports.
  2. Sign back in.

This allows the new session to apply imported roles and permissions.

Verify the Migrated Data

After signing back in, verify that the expected WebReports data is available.

Review items such as:

  • Users
  • Roles
  • Reports
  • Report Assignments
  • Schedules
  • Completed Reports
  • Connection Profiles
  • API Keys
  • UDFs
  • Email settings
  • Tenants
  • Configuration settings
  • Logs
  • Statistics History

Compare the new MySQL WebReports environment with the original Microsoft SQL Server environment.

Verify API Keys After Migration

After the migration is complete, review any API keys used by WebReports.

Confirm that:

  • The expected API keys are present.
  • The keys are associated with the correct configuration.
  • Any Bridgit or OpenAI-related integration is still working as expected.
  • The API key can be re-entered if needed.

API keys should be included in your post-migration verification rather than assumed to be working automatically.

Troubleshooting

Migration Does Not Complete

If the migration does not reach 100% / Complete:

  • Review the migration status for errors.
  • Confirm that the source SQL Server connection string is correct.
  • Confirm that the source database is accessible from the new WebReports environment.
  • Verify that the correct source database unique ID was entered.
  • Confirm that the MySQL WebReports environment is running correctly.

Imported Roles or Permissions Do Not Appear

  1. Sign out of WebReports.
  2. Sign back in.
  3. Verify the imported roles and permissions again.

Imported Data Is Missing

  • Confirm that the appropriate migration options were selected.
  • Review the migration results for errors.
  • Verify that required dependencies were included.
  • Compare the migrated environment with the original SQL Server environment.

API Keys or Integrations Do Not Work

  • Verify that the expected API keys are present.
  • Re-enter the API key if necessary.
  • Test the associated integration after saving the configuration.

If the issue continues, contact BridgeWorks Support.

Related Articles

Related articles

Comments

0 comments

Please sign in to leave a comment.