How-to: Upgrade Intelligence Hub when appData directory and storeForwardData directory is set up

Jump to Section

What Does This Article Cover?

This article details how to upgrade your Intelligence Hub if you have the recommended appData directory and storeForwardData directory set up.

While enabling the appData and storeForwardData directory can make upgrades more streamlined by separating application code from configuration state and application state, it is not created by default. If you have not enabled either directory and are looking to upgrade or migrate, *please see this article to upgrade or migrate. *After migrating without appData and storeForwardData directories set up it is recommended to setup these directories. Please see this article to do so.

Steps to Upgrade when appData directory & storeForwardData directory is set up:

  1. Stop HighByte Intelligence Hub if it is currently running

    • If HighByte is running as a service stop the service. In step 4 make sure to install the new version of HighByte Intelligence Hub to the same directory to use the same service. Conversely you can uninstall the service and reinstall it from the new directory.

  2. Create a backup of your runtime, appData and storeForwardData directory

    • Create a copy of ‘/runtime’, appData and storeForwardData directories to ensure you have a working copy and to safeguard against potential data loss. A copy of your runtime can also be used as a reference point for testing and validating your upgrade or migration.

  3. Install the latest version of HighByte Intelligence Hub to a new folder

  4. Take a copy of ‘Intelligencehub-settings.json’ from your previous runtime and put it into your new runtime.

    • remove intelligencehub-settings.json.template

    • take a copy of intelligencehub-settings.json from your previous runtime and put it in the runtime folder

    • open intelligencehub-settings.json in a text editor

    • within the file go to the directories section within the settings

    • ensure that the “appData” and “storeForwardData” values are pointing to the correct directories

      jsonc 
      "settings": {
    "directories" : {
        "appData" : "C:\\HighByte\\AppData\\EnvName",
        "storeForwardData" : "D:\\HighByte\\storeForwardData\\EnvName"
    },
}

On Windows, backslashes must be escaped using \ syntax.

  1. Ensure your migration or upgrade was successful.

    • Ensuring that your migration is successful will be different for everyone. We suggest that you always first test your environment in a Dev/QA environment before pushing to it into production.