Skip to main content
Language Selector

  1. Other Languages

    (machine translation)

Planview Customer Success Center

Backup

  1. Last updated
  2. Save as PDF
You are viewing content for Planview Hub version .

This page is not applicable to Planview Hub Cloud.

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: Any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/data/h2 (on Linux from 23.2 and later)

    • keycloak/standalone/data

Note: The location of keycloak or operation data are configurable in tasktop-hub.properties. If the defaults are overridden by this configuration, please back up the configured directories.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

 

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: Any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/data/h2 (on Linux from 23.2 and later)

    • keycloak/standalone/data

Note: The location of keycloak or operation data are configurable in tasktop-hub.properties. If the defaults are overridden by this configuration, please back up the configured directories.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: Any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/data/h2 (on Linux from 23.2 and later)

    • keycloak/standalone/data

Note: The location of keycloak or operation data are configurable in tasktop-hub.properties. If the defaults are overridden by this configuration, please back up the configured directories.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

 

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: Any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/data/h2 (on Linux from 23.2 and later)

    • keycloak/standalone/data

Note: The location of keycloak or operation data are configurable in tasktop-hub.properties. If the defaults are overridden by this configuration, please back up the configured directories.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in the section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: Any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/data/h2 (on Linux from 23.2 and later)

    • keycloak/standalone/data

Note: The location of keycloak or operation data are configurable in tasktop-hub.properties. If the defaults are overridden by this configuration, please back up the configured directories.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in the section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Backup 

A working backup strategy is a critical element of disaster recovery, since only backups can mitigate complete hardware failure and user error. A strategy that ensures correct and current backups is essential. Backups of the Hub database include both configuration and operational data.  

Backup frequency should mirror your practices for all software tools your organization utilizes. Backup frequency should be daily, ideally with incremental backups performed more frequently.

General Application Configuration

The recommended practice is to back up the entire installation/program data directory to cover all customizations (excluding logs)

  • Back up Tomcat customizations (in Linux install directory or Windows Program Data)

    • container/conf/server.xml

    • Any keystores for certificates

    • For Linux: bin/setenv.sh

    • For Windows: any changes to the Java section of the Manage Planview Hub application (e.g., memory, command line parameters, etc)

  • Back up keycloak data and customizations

    • keycloak/standalone/data

    • keycloak/standalone/configuration/standalone.xml

Note: We recommend backing up the standalone.xml file in the event of a rollback; however, when upgrading, this file should not be preserved to prevent keycloak errors. Instead, the standalone.xml file in the new Hub package should be used.

Operational Data Configuration

Default Derby Database

Planview automatically stores operational data to a built-in database. However, for production environments, we strongly recommend that operational data is stored to an external database for improved maintainability. This enables you to perform frequent backups without stopping Hub and ensures that your Hub practices are consistent with your existing disaster and recovery process. For details on how to store your operational data to an external database rather than Planview's built-in database, please refer here.

If utilizing Planview's built-in Derby Database, ensure you've backed up the following:

  • File backup of db directory (in Linux install directory or Windows Program Data)

Note: We strongly recommend disabling LDAP if using the Derby database due to an existing security vulnerability (CVE-2022-46337) that is present when LDAP is enabled. This vulnerability will be addressed in a future release of Hub and should not affect current functionality. 

External Database

In order to back up Hub, follow the instructions below:

  1. Ensure that you have migrated your operational data to an external database. For details on how to set up your external database, please see here.

  2. Back up the following folders

    1. on Linux:

      1. /tasktop/db

      2. /tasktop/drivers

      3. /tasktop/libraries

    2. on Windows:

      1. The Hub data folder, typically C:\ProgramData\Tasktop

  3. Back up the external database using that database's backup tools.

  4. Back up the Tomcat and Catalina configuration

    Note: This is only applicable if changes are made to the Tomcat and Catalina configuration.

Restore from Backup 

If Planview Hub fails to restart after an upgrade or if there are unresolvable errors preventing your integrations from running, Planview Hub may need to be returned to the previous version. Please ensure to stop Hub before restoring to a previous version.

Note: If restoring from backup, you should be cautious as the state of the integration is maintained in the database and restoring to an older version could result in duplicated items and data (e.g., comments and attachments). It is recommended to only restore when directed by Planview support or after a failed upgrade where no items were processed. 

Tip: If integrations were resumed individually during an upgrade, you can prevent duplicating items and data when restoring to an earlier version by utilizing the upgrade from backup file feature described below.

General Configuration

You should restore any changes identified in the backup.

Operational Data

Default Derby Database

In order to restore Hub, follow the instructions below:

  1. Copy the database directory from backup to the Hub data folder.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

External Database

In order to restore Hub, follow the instructions below:

  1. Restore the external database backup using the tools from that database.

  2. Restore the backed up Tomcat and Catalina configuration files from part 4 of the backup instructions.

Operating Systems

Windows Backup

  1. Shut down Hub.
  2. Uninstall Hub, then run the previous installer.
  3. Restore from backup as described in the section above.
  4. Restart Hub.
    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.

Linux Backup

  1. Shut down Hub.

  2. Remove the new Hub installation folder and restore the old Hub installation folder from step 3 of the upgrade steps.

  3. If you are using an external database for Hub's configuration, restore the external database as described above.

  4. Restart Hub.

    1. If you'd like, you can restart Hub in 'safe mode' which ensures all integrations are paused.