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

Jump to Section

What Does This Article Cover?

This article details how to upgrade your Intelligence Hub if you do not have the appData directory or 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 turned on by default.

If you have not enabled either of directory and are looking to upgrade or migrate, this article is for you.

Steps to Upgrade when appData directory is NOT set up:

  1. Stop HighByte Intelligence Hub if it is currently running

  2. Create a backup of your runtime

    • Create a copy of ‘/runtime’ 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 HBIH to a new folder

  4. Replace the following files in the new runtime with the files in your previous runtime

    • Intelligencehub-settings.json

      • Contains application settings like the REST API port, location of configuration directory, max events to log, etc. See Application Settings for details.

    • Intelligencehub-systemvariables.json

      • Contains system variables.

    • Intelligencehub-users.json

      • Contains local users, passwords, roles and claims settings.

    • Intelligencehub-cache.db

      • Cached state of connections in the Intelligence Hub (e.g., SQL indexed query, getting only data newer than a certain date, etc.)

    • Intelligencehub-configuration.json

      • The project configuration for the Intelligence Hub (e.g., connections, models, flows, etc.) stored as JSON.

    • Intelligencehub-events.log

      • A copy of the log in text format.

    • Intelligencehub-remoteconfig.json

      • Contains the URL of the central Intelligence Hub instance to connect to and the token required to authenticate the connection. This is only applicable when using central configuration

    • Intelligencehub-certificatestore.pkcs12

      • Certificate store that contains the keys for encrypting passwords in the intelligencehub-configuration.json file.

    • Intelligencehub-users.json

      • Contains local users, passwords, roles and claims settings.

    • Intelligencehub-state.db

    • intelligencehub-events.db

      • Event log files stored in an encrypted SQLite format.

    • Intelligencehub-identityproviders.json

    • Intelligencehub-writestore-CONNECTIONNAME.db

      • Store and forward file for a specific connection (only present when store and forward is enabled on the connection).

It is possible that not all of the files listed will exist in your current runtime. If they exist move them to your new runtime.

Do not move intelligencehub-state.dat

  1. Ensure your migration 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.
  2. Consider setting up a dedicated appData and storeForwardData directory to make your next migration easier. More information can be found here : How-To: Setup dedicated appData and storeForwardData directories