Extracting Platform Reports Using Reports Migration Utility (RMU)

Introduction

Reports Migration Utility (RMU) is a command-line application that extracts Noetix Platform reports from a SQL Server database and consolidates them into a single portable file. The utility connects to a specified reports database (typically named "nqsdb"), retrieves reports based on user-defined criteria such as date ranges, usernames, or specific report IDs, and saves them in a .noetix file format. This extracted file can then be used for report migration, backup, archival, or restoration purposes across different environments.

Prerequisites

1. Go to the location where Reports Migration Utility (RMU) file (for example: C:\Users\Administrator\Desktop\Builds\11-03-2025\25.2\RMU) is stored and then open app.Settings.json file

2. In the connection details section, provide the following details:

   1. Machine: Indicates the server where the SQL server is hosted, containing the reports database.

   2. SQL server: Indicates the server hosting the reports database.

   3. Database: Indicates the name of the specific database where the reports are stored, often named as "nqsdb".

   4. Username: Indicates the name used for connecting to the database

   

3. If a user needs specific reports, they can identify them by either a date range or report IDs. To enable this, configure the corresponding parameters in the app.Settings.json file located in the application directory (for example: C:\Program Files\YourApplication\).

   1. Mandatory Parameters: FromDate and ToDate

   2. Optional Parameters: UserName

   3. Overridden parameters: ReportIds

   

   These settings will be applied during the report extraction process.

Run PlatformReportsExtractor.exe file

1. Go to the location where the RMU file is stored (for example: C:\Users\Administrator\Desktop\Builds\11-03-2025\25.2\RMU) in File Explorer. In the address bar, enter cmd and click Enter on your keyboard. The Command Prompt window is displayed.

2. In the Command Prompt, enter PlatformReportsExtractor.exe and click Enter on keyboard.

3. When you run the executable (.exe) file, the application will prompt you to enter a password. This password is required to establish a connection to the SQL Server instance of the machine specified in the app.Settings.json file located in the application directory (for example: C:\Program Files\YourApplication\).

   

4. After you enter the correct password, the application will begin the report extraction process. Once all reports have been successfully extracted, the application will display summary statistics, including:

   • Total number of original reports

   • Number of reports successfully saved

   • Number of reports that failed to save

   

5. After the extraction process is complete, all reports will be saved in a single file named PlatformReports.noetix in the same directory as the executable (.exe) file.

Best Practices

• Ensure that all configuration details in the appSettings.json file are correctly provided before running the utility, including the machine name, SQL server details, database name, and username for database connection.

• Verify that the parameter details (either report IDs or a date range) are correctly specified in the appSettings.json file to extract the intended set of reports. Use FromDate and ToDate for date range filtering, or specify ReportIds for extracting specific reports.

• Confirm that the machine specified in the appSettings.json file (where the SQL Server and Noetix Platform database are hosted) is up and running and accessible from your network location. Verify that the Noetix Platform service on this machine is properly configured and operational before initiating the extraction process.

• Provide the correct database password when prompted during the execution of the PlatformReportsExtractor.exe file to establish a successful connection to the SQL Server database.