Migration Reports

Scope: All migration projects

To view one or more migration reports first navigate to the Execution View using the View menu.

It is possible to view reports for any completed execution. CSV reports for historic executions can also be re-loaded for viewing.

To view reports written to database (if this execution option was selected), see the article Writing Migration Reports to Database Tables regarding the tables you will need to query.

There are 3 report types for each execution:

Summary Report:  This shows a one-line summary with a count of all updates/creates/errors etc as well as the timestamps for start and finish. Timestamps will be in the timezone of the client machine on which the migration was executed.

Form Mapping Summary Report: This shows the counts for all target forms that data was migrated to. It will not include forms where there was no data migrated. One row is presented for each Form Mapping.

Form Mapping Detailed Migration Report: This report is generated based on the reporting options specified for the migration (see previous section). A report will only be generated for forms where some record migrations fulfil the report criteria. For example, if ‘errors only’ are specified in the options, a report will be generated only for forms where one or more errors occurred while migrating records. One row is presented for each migrated record that satisfies the reporting criteria.

All completed executions from the current Execution List generate a separate summary report which is listed in the Reporting window (bottom half of Execution View):

For each migration, the total number of records created, updated or skipped are displayed in the right-hand columns.

To remove a report from the list, select the checkbox on the left and click the Clear Checked button. To clear all reports from the list, click the Clear All button.

To load a report from another project execution (not on the current Loaded Execution List), click the Load From File button or select Reports->Load Migration Report from the menu. This brings up a separate window like this:

Select the Project folder from the drop-down list of recent projects or use the Browse button to select a specific project folder, then select the execution timestamp from the list of executions. Note that if the option to write reports CSV files was not selected at execution, you will not be able to view it in this way.

Alternatively, use the Select Report Folder to open a specific folder holding the migration reports that you want to load.

From the list of loaded execution reports, double-click any row or click the View Migration Summary button to see the Form Mapping Summary Report in a separate tab like this:

Note that if the reports were not written to CSV, you will not be able to double click the rows to view the Form Mapping Summary Report.

To view the Form Mapping Detailed Migration Report for a particular Form Mapping, double click the row in the table above or click the View Migration Report button.

Note that the records listed here will depend on the options selected in the Execution Logging and Reporting Options. If you have selected the default (Errors and Warnings), then successfully migrated records will not be listed in this report. Also, if no records were reported for a given form (based on the Report Level option in execution settings) you will not be able to view the Form Mapping Detailed Migration Report.

By default, the full report output is displayed with a number of column headings (see table below). To sort by a particular column, simply click on the column heading. To reverse the sort order, click on the same column heading again.

To restrict the report to a particular set of records, use the filtering section at the top. Enter one or more values in the Filter fields, then click on the Apply Filters button to filter the report output to match the criteria specified. For example, to just view those records where the migration was not completed, select “Not Completed’ from the Result Field and click on Apply Filters.

To return to the full list of records in this report, click on the Clear Filters button.

Report Column Heading	Description
Timestamp	The date and time that the migration of this record took place
Result	Either Created, Updated or Not Completed
Status	Either Success, Warning, Skip or Error
Target ID	The unique ID of the Target record used to identify which record to create/update.
Source ID	The unique ID of the Source record used to identify which record to migrate.
Message	Any associated message text for the migration of this record including any warnings or errors.

Note that the Source ID and Target ID columns can be changed to any other field on the source/target table. To change this setting, open the corresponding Form Mapping and choose the Report Source and Report Target fields on the Options Tab. For more information see Form Mapping Options Article.

Note on Migration Reports:

If the write to CSV option is selected, every report generated will be stored as a CSV file in the following location:

<project root>\reports\Execution<Execution ID>\<form mapping>

This includes all three report types as follows:

Report Type	Report File Name
Summary Report	summary_report.csv
Form Mapping Summary Report	form_mapping_summary_report.csv
Form Mapping Detailed Migration Report	<form mapping>.csv

These report files can be opened in a spreadsheet application for more in depth interrogation.

Related Articles

Writing Migration Reports to Database Tables