Upgrading to jCustomer 2.5.0

August 27, 2024

Migrating from jCustomer 1.x to jCustomer 2.5.0

A dedicate page on the academy details the migration procedure from jCustomer 1x.

Migrating from jCustomer 2.x to jCustomer 2.5.0

Before continuing with the migration, please make sure you are currently running jCustomer 2.0.0 or above.

Please note that during the migration and as long as the jExperience module is started, the fallback variants are displayed by personalizations/optimizations on the site.

To migrate you platform, please follow these steps carefully:

  1. Backup your current jCustomer instance (in case you run jCustomer in cluster, backup the whole cluster)
    For a detailed description of how to backup jCustomer please follow the section How to backup jCustomer on this page
  2. Stop your current jCustomer instance
  3. Download the new version of jCustomer from jExperience customer center and install it
  4. If you're handling custom events, make sure you created the corresponding migration scripts and placed those in jCustomer: data/migration/scripts
  5. Start a single jCustomer migration node following instructions from Apache Unomi 2.0.0 documentation. This node will be handling all of the data transformations, make sure to review all items in the "Checklist" section. The documentation details two approaches for triggering the migration (replacing with your source Unomi version):
    • Manually using the Karaf shell with the command: unomi:migrate 2.0.0
    • Or, with Docker using the environment variable: KARAF_OPTS="-Dunomi.autoMigrate=2.0.0" 
  6. Verify that the migration was successful by reviewing the file data/migration/history.json, all steps in this file must have the status "COMPLETED"
  7. Apply all your custom configurations to the new jCustomer instance
  8. Optionally: Upgrade jExperience and jExperience-dashboards to their latest version and start them.
  9. Start jCustomer using ./start command in the operating system shell.
  10. Connect to the jCustomer Karaf SSH shell using an SSH client such as in the following example (default password karaf):
    ssh -p 8102 karaf@localhost
  11. Start jCustomer (only needed when running jCustomer for the first time).
    unomi:start