Skip to main content

Use the OnePlan Backup Utility

© 2024 OnePlan Solutions. All Rights Reserved.
Download Article

Use the OnePlan Backup Utility

  • Updated

This article explains how to use the OnePlan Backup Utility. This utility should be used to backup OnePlan groups with more than 100 plans.

  1. Go to https://oneplantemplates.azurewebsites.net/backuputil/.

  2. Review the prerequisites to use the backup utility.

  3. Click Install to download the utility.

    Screenshot_2021-12-06_123212.png

  4. Open the setup.exe file from your Downloads folder. The OnePlan Backup Utility will install and open on your machine.

  5. Select the region where your OnePlan environment is located. Then click Go.

    Screenshot_2022-03-16_102034.png

    Note

    Trial environments are hosted in the my.oneplan.ai environment. If you are backing up a trial environment, select my.oneplan.ai.

  6. Get an integration key for the group you would like to backup.

    1. In OnePlan, go to Admin Settings.png > Integration.

    2. In Authentication Keys, click New Key Screenshot_2021-12-06_134934.png. The New Key form will open.

      In the New Key form, give your new key a name and click ADD.

    3. Copy the new key and save for later use. The key will be hidden when the page refreshes.

    Screenshot_2021-12-06_130138.png

  7. In the OnePlan Backup Utility, complete the OnePlan Backup form.

    • Enter Integration Key: Paste the integration key for the desired group.

    • Backup Type: Select the backup type.

      • Normal: Backs up only generics and ignores named users

      • Generics: Switches all names resources to generic resources for troubleshooting or templating.

      • Full: Backs up all resources as is. Used for tenant migrations or moves within the same tenant.

        Note

        Please contact OnePlan support if you would like to take a Full backup as there are several additional steps required for this backup type.

    • Include Content: Check the check box if you would like to include content from the group. If unchecked, the backup will just save the group configuration.

    Screenshot_2021-12-06_123322.png

  8. Click Download Backup. The download is complete when the View File link appears. Click View File to access your backup file.

    Screenshot_2021-12-06_130722.png

    Note

    Even if the download progress bar is not filled, the download is complete once the View File link is visible.

    Note

    The backup utility creates a folder in your machine's App Data folder where backup files are downloaded.

    Screenshot_2021-12-06_130743.png

Related articles

Comments

0 comments

Article is closed for comments.