Migration of the Reporting database (Db-to-file)

This section is applicable to the SaaS customers with self-hosted reporting database.

The XMDBTool Client or a bkg process executes an incremental ETL process to transform the data from the Transactional database to the Reporting database, after the reporting database migration is completed.

Auto-migration of the self-hosted reporting database creates a migration script. The migration script generated by the auto-migration of the Reporting database, is prepended to the incremental ETL script and run by the ETL utility.

Configure these application parameters:

  • migrate.rptdb.outFile: The value of the application parameter must be set to True. By default, the value of this application parameter is set to False.
  • migrate.rptdb.outFileDbType: Type of database to be used, must be specified in the generated script. Valid values: mssql, oracle, psql. By default, the database type is mssql.
    Note: PostgreSQL 16.6 is the certified version for release 2026.x.
  • migrate.rptdb.outFilePath: The location of the outFile must be specified. The suggested location is ../../../xmshare/migration.
    Note: You must add the migrate.rptdb.outFilePath application parameter manually. If the application parameter is not located during the migration process, the XMDBTool application displays the ‘There is no migration script currently available for this tenant because folder specifed in migrate.rptdb.outFilePath DOES NOT EXIST’ error message.

When the migrate.rptdb.outFile application parameter is set to True, the migration outfile and the migrateRptDb_yyyyMMdd.sql is created in the outFilePath/<tenantID> folder. When an incremental ETL process is executed by the XMDBTool client or a bkg process and if the migrateRptDb_yyyyMMdd.sql migration script is found, the content is prepended to the incremental ETL outfile. Once the migration script is successfully copied, the ETL outfile is renamed to migrateRptDb_yyyyMMdd.sql.old.