Migrating WebReports from Microsoft SQL Server to MySQL

WebReports includes a database import tool that allows administrators to migrate data from an existing Microsoft SQL Server-based WebReports environment to a new MySQL-based environment.

The import tool can migrate users, roles, reports, assignments, connection profiles, schedules, completed reports, logs, and other WebReports configuration data.

Before You Begin

Before starting the migration, confirm that the new WebReports environment is installed, configured to use MySQL, and accessible.

You will need the following information from the existing Microsoft SQL Server-based WebReports environment:

• The source database unique ID
• The complete Microsoft SQL Server connection string
• Administrative access to the new WebReports environment

Important: Obtain the database unique ID and connection string before the source WebReports environment is taken offline.

Locate the Source Database Unique ID

The source database unique ID is located on the Registration page of the existing WebReports environment.

1. Sign in to the existing WebReports environment.
2. Select Management.
3. Select Registration.
4. Locate the Registration ID field near the bottom of the page.
5. Copy the ID for use during the import.

The ID must be obtained from the source WebReports environment, not the new MySQL environment.

Locate the Source Connection String

The source connection string is located in the production appsettings.json file for the existing WebReports environment.

1. On the source WebReports server, open the production appsettings.json file.
2. Under "ConnectionStrings", locate the active "DefaultConnection" entry for Microsoft SQL Server.
3. Copy everything contained within the quotation marks after "DefaultConnection":.

Do not copy the quotation marks, the "DefaultConnection": label, or any comments that may be present in the connection string, like //Microsoft SQL.

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

After collecting the source information, sign in to the new MySQL-based WebReports environment.

1. Select Management.
2. Select Database.
3. Under Import WebReports Data, select Import WebReports Data.

The Import WebReports Data window opens.

Enter the Source Database Information

Complete the following fields using the information from the existing WebReports environment:

• Source Database Unique ID: Enter the ID copied from the source Registration page.
• Source Database Type: Select MSSQL.
• Source Connection String: Paste the complete Microsoft SQL Server connection string copied from the source application settings.

All information entered in these fields must reference the source Microsoft SQL Server-based WebReports environment.

Select the Data to Import

Under Data to Import, select the information that you want to migrate.

Available selections include:

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

Some selections have dependencies and require other data to be imported. For example:

• Connection Profiles are required by Report Assignments and Logs.
• Roles are required by Users and Report Assignments.
• Reports are required by Report Assignments and Logs.
• Users are required by API Keys, UDFs, Schedules, Completed Reports, and Logs.
• Report Assignments are required by Schedules and Completed Reports.

When a selected item requires other information, WebReports automatically selects the required dependencies. Required selections appear disabled and cannot be cleared unless the dependent selection is cleared first.

Review the selections before beginning the import.

Start the Import

1. Select Import WebReports Data.
2. Monitor the progress displayed in the Import WebReports Data window.
3. Wait for the import to reach 100%.

The progress area displays the type of data currently being imported, the completion percentage, and detailed migration information.

Use Copy Details to copy the displayed import information or Download Details to save it for review.

Do not close the Import WebReports Data window or sign out while the import is running.

Confirm the Import Completed

When the migration is finished, the Import WebReports Data window displays the following:

• Complete
• Import completed successfully
• 100% complete

A green WebReports data import completed successfully notification also appears at the bottom of the page.

Review the import details for skipped items, warnings, or errors. Existing configuration options may be skipped when the corresponding setting already exists in the new environment.

Sign Out and Sign Back In

After the import completes successfully:

1. Select the X in the upper-right corner to close the Import WebReports Data window.
2. Select Logout in the upper-right corner of WebReports.
3. Sign back in to the new WebReports environment.

Important: You must sign out after completing the import. Imported roles and permissions are applied the next time the current user signs in. Sign out and back in before running reports or opening completed reports.

Verify the Migration

After signing back in, review the areas selected during the import and confirm that the information migrated successfully.

Depending on the selections made during the import, verify the following:

• Users and roles
• Reports and report assignments
• Connection profiles
• Scheduled jobs
• Completed reports
• User-defined fields
• API keys
• Email settings
• Tenants
• Configuration settings
• Logs

Open and run several migrated reports to confirm that their connections, parameters, assignments, and output work correctly in the new MySQL-based WebReports environment.