Use the Report Viewer

The Report Viewer allows you to open the SQLite database that contains your error data directly on your machine and without using a browser. It also offers search and filter options that help you find important data faster.

If you want to coordinate with others on your QA and business teams, you can share your reports.

Get the Report Viewer

The Report Viewer is part of the Tricentis Tosca installation. After a default installation, you can find the executable file Tricentis.DataIntegrity.Report.Viewer.exe at %TRICENTIS_DI_HOME%\tools.

Open a report

Once you've created your error report, you can open it in the Report Viewer. To do so, follow these steps:

  1. To open the Report Viewer, go to %TRICENTIS_DI_HOME%\tools and run the file Tricentis.DataIntegrity.Report.Viewer.exe.

  2. This opens the Report Viewer. Choose one of the following options to open a particular report:

    • Drag and drop the report SQLite file.

    • Click Browse to browse for a file on your machine.

This opens the Summary page of your report. It displays the comparison results, an overview of the processed data and errors, and a description of the source and target.

Data Integrity Report Viewer displays a report of a successful comparison.

Report Viewer displays a report of a successful comparison

Navigate the Report Viewer

The Report Viewer sorts the results of your comparison by various criteria. Which tabs you see depends on the comparison results and what you specified in your TestCase.

To display specific information, click on the tabs at the top of the Report Viewer:

  • Differences: get an overview of rows that are in source and target.

  • In source only: view rows that are only in the source.

  • In target only: view rows that are only in the target.

  • Invalid in source: see rows in the source that couldn't be processed.

  • Invalid in target: see rows in the target that couldn't be processed.

  • Matched: check all rows that are the same in source and target.

Modify your report

To check results and filter your report, use the following features of the Report Viewer:

  • Click Columns visibility to select which columns you want to display.

  • Select Shows columns with differences only to display only columns with differences.

  • Enter a search query into the Content Search field to highlight data in the results.

  • Click on the Menu icon in the top right corner of each column to sort and filter. You can combine filters on multiple columns to refine your results.

  • Use the Display records field below the data table to specify how many records you want to display per page.

  • Click on Previous, one of the numbers, or Next below the data table to navigate between pages.

  • Click on the Exit icon to go back to the start page, where you can select another report to view.

Use search, sort, filter and export options in the Data Integrity Report Viewer.

Report Viewer search, sort, and filter options

Share reports

The Report Viewer gives you key insights into the integrity of your data. If you want to coordinate with others on your QA and business teams, you can share this information.

To do so, forward the following files to your teams:

Alternatively, you can export an HTML report.

Export reports

You can export reports, for instance if you want to share data with others without having to forward database and executable files. Or if you want to process results in your own reporting tools.

Your next steps depend on what you want to do:

You can trigger the HTML export in one of the following ways:

  • Via command line, as part of a script.

  • Via Tosca TestCase, if you want to automate triggering report exports. In this case, Tricentis Tosca automatically exports a report whenever you run your TestCase.

If your error report is large, consider splitting it up into multiple files; browsers can't display HTML files that are bigger than 50 MB.

Trigger the HTML report via command line

  1. Go to the directory that contains the command line tool Tricentis.DataIntegrity.Report.Exporter.exe:

    • On Windows, this is %TRICENTIS_DI_HOME%/tools/windows.

    • On Linux, this is %TRICENTIS_DI_HOME%/tools/tools/linux.

  2. Enter the command line Tricentis.DataIntegrity.Report.Viewer.exe export <arguments> and replace <arguments> with the arguments you want to use.

In this example, the Report Viewer takes the information from the report file example_report.db, which is in C:/ExampleFolder. It creates separate files for the tabs Summary and Differences and saves them to C:\ExampleFolder.

Tricentis.DataIntegrity.Report.Exporter.exe --input C:\ExampleFolder\example_report.db  --output C:\ExampleFolder --t Summary --t Differences --format html

In this example, the Report Viewer takes the information from the report file report.db, which is in the same directory as the file Tricentis.DataIntegrity.Report.Exporter.exe. It creates an HTML output named my_report.html in C:\ExampleFolder.

Tricentis.DataIntegrity.Report.Exporter.exe --input report.db  -output C:\ExampleFolder\my_report.html -f html

In this example, the Report Viewer takes the information from the report file myreport.db, which is in the same folder as the file Tricentis.DataIntegrity.Report.Exporter.exe. It exports a report on the Summary tab, and saves it to C:\ExampleFolder\summary_report.json.

Tricentis.DataIntegrity.Report.Exporter.exe --myreport.db  -output C:\ExampleFolder\summary_report.json  --table Summary

Trigger the HTML report via TestCase

To trigger the export of an HTML file via TestCase, follow these steps:

  1. In Tosca Commander, access your DI subset and go to Data Integrity Testing->_DI Sample Tests and Execution Lists->TestCases->Reconciliation->Miscellaneous->Export differences to db and generate shareable HTML report.

  2. Copy and paste the sample Generate html report into your Complete Row by Row Comparison TestCase.

  3. Fill out the TestStepValues:

TestStepValue

Description

Path

Enter the full path to the Report Exporter:

  • On Windows, this is %TRICENTIS_DI_HOME%/tools/windows/Tricentis.DataIntegrity.Report.Exporter.exe.

  • On Linux, this is %TRICENTIS_DI_HOME%/tools/tools/linux/Tricentis.DataIntegrity.Report.Exporter.exe.

Arguments

Enter the arguments you want to use.

WaitForExit

Enter True. This is crucial; if you don't enter True, the TestCase triggers the command line, but immediately closes it again.

ExitCode

Enter a command line exit code. We recommend that you enter 0 and select ActionMode Verify. In this case, you receive a warning right in your TestCase if the command fails.

In this example, you trigger the export automatically, directly in your TestCase.

The Report Viewer takes the information from the report file report.db, which is in C:/Temp. It exports all information in HTML format and saves a file named summary_report.html to C:\ExampleFolder.

Automatically trigger the export in your TestCase

List of available arguments

You can use the following arguments to trigger an HTML report export:

Argument name

Value

--i, --input

Path to the database file that contains the comparison report you created.

--o, --output

Path to where you want to save the output:

  • If you export one table or all tables, you can enter the path to a directory or a file.

  • If you export multiple specific tables, enter the path to a directory. The Report Viewer saves the report files in the format <name of the report file>_<table>.

Note: the export file of the Summary tab is always a JSON file. If you want to export the Summary tab and you specify the path to the file, the file name must have the extension .json.

--f, --format

Output format. Enter HTML.

--t, --table

Name of the table for which you want to export a report. Enter one of the following values: Differences, Matched, Unmatched, Invalid, UnmatchedSource, UnmatchedTarget, InvalidSource, InvalidTarget, or Summary.

You can export reports for multiple tables in one of the following ways:

  • Use the argument multiple times, one argument per table.

  • Don't use the argument at all. In this case, the Report Viewer exports reports on all tables.

--progress

Show export progress.

--h, --help

Show help.

--V, --version

Show version information.

You can trigger the extraction in one of the following ways:

  • Via command line, as part of a script.

  • Via Tosca TestCase, if you want to automate this process. In this case, Tricentis Tosca automatically exports a report whenever you run your TestCase.

Trigger the extraction via command line

  1. Go to the directory that contains the command line tool Tricentis.DataIntegrity.Report.Exporter.exe:

    • On Windows, this is %TRICENTIS_DI_HOME%/tools/windows.

    • On Linux, this is %TRICENTIS_DI_HOME%/tools/tools/linux.

  2. Enter the command line Tricentis.DataIntegrity.Report.Viewer.exe export <arguments> and replace <arguments> with the arguments you want to use.

In this example, the Report Viewer takes the information from the report file example_report.db, which is in C:/ExampleFolder. It creates separate files for the tabs Summary and Differences and saves them to C:\ExampleFolder.

Tricentis.DataIntegrity.Report.Exporter.exe --input C:\ExampleFolder\example_report.db  --output C:\ExampleFolder --t Summary --t Differences

In this example, the Report Viewer takes the information from the report file report.db, which is in the same directory as the file Tricentis.DataIntegrity.Report.Exporter.exe. You don't use the table parameter, so the Report Viewer exports reports on all tables and saves them to C:\ExampleFolder.

Tricentis.DataIntegrity.Report.Exporter.exe --input report.db  -output C:\ExampleFolder

In this example, the Report Viewer takes the information from the report file myreport.db, which is in the same folder as the file Tricentis.DataIntegrity.Report.Exporter.exe. It exports a report on the Summary tab, and saves it to C:\ExampleFolder\summary_report.json.

Tricentis.DataIntegrity.Report.Exporter.exe --myreport.db  -output C:\ExampleFolder\summary_report.json  --table Summary

Trigger the extraction via TestCase

To trigger the export of a CSV file via TestCase, follow these steps:

  1. In Tosca Commander, access your DI subset and go to Data Integrity Testing->_DI Sample Tests and Execution Lists->TestCases->Reconciliation->Miscellaneous->Export differences to db and generate shareable HTML report.

  2. Copy and paste the sample Generate html report into your Complete Row by Row Comparison TestCase.

  3. Change the format, so your TestCase triggers the export in CSV format. To do so, choose one of the following options:

    • Delete the Argument with the value --format and the Argument with the value HTML. If you don't use the --format parameter, the TestCase automatically exports in CSV format.

    • Change the value from HTML to CSV.

  4. Fill out the TestStepValues:

TestStepValue

Description

Path

Enter the full path to the Report Exporter:

  • On Windows, this is %TRICENTIS_DI_HOME%/tools/windows/Tricentis.DataIntegrity.Report.Exporter.exe.

  • On Linux, this is %TRICENTIS_DI_HOME%/tools/tools/linux/Tricentis.DataIntegrity.Report.Exporter.exe.

Arguments

Enter the arguments you want to use.

WaitForExit

Enter True. This is crucial; if you don't enter True, the TestCase triggers the command line, but immediately closes it again.

ExitCode

Enter a command line exit code. We recommend that you enter 0 and select ActionMode Verify. In this case, you receive a warning right in your TestCase if the command fails.

In this example, you trigger the export automatically, directly in your TestCase.

The Report Viewer takes the information from the report file report.db, which is in C:/Temp. It exports reports for the tables Differences and Matched and saves them to C:\ExampleFolder.

Automatically trigger the export in your TestCase

List of available arguments

You can use the following arguments to trigger a CSV report export:

Argument name

Value

--i, --input

Path to the database file that contains the comparison report you created.

--o, --output

Path to where you want to save the output:

  • If you export one table, you can enter the path to a directory or a file.

  • If you export multiple specific tables, enter the path to a directory. The Report Viewer saves the report files in the format <name of the report file>_<table>.

  • If you don't use the table argument because you want to export all tables, enter the path to a directory.

Note: the export file of the Summary tab is always a JSON file. If you want to export the Summary tab and you specify the path to the file, the file name must have the extension .json.

--t, --table

Name of the table for which you want to export a report. Enter one of the following values: Differences, Matched, Unmatched, Invalid, UnmatchedSource, UnmatchedTarget, InvalidSource, InvalidTarget, or Summary.

You can export reports for multiple tables in one of the following ways:

  • Use the argument multiple times, one argument per table.

  • Don't use the argument at all. In this case, the Report Viewer exports reports on all tables.

--d, --delimiter

Delimiter to separate the values.

The default delimiter is a comma. If you want to separate values in a different way, enter the desired delimiter.

--progress

Show export progress.

--h, --help

Show help.

--V, --version

Show version information.

If your Report Viewer is already open, you can trigger a quick one-off. The Report Viewer exports the information in CSV format. You can export all tabs except the Summary tab.

These are your next steps:

  1. In the Report Viewer, click on the tab whose information you want to export.

  2. Click Export to CSV.

  3. In the subsequent dialog, select a location and name for the export file.

  4. Click Save.