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

Download Configuration Backup Without Data

If you would like to download a backup of the OnePlan site configuration without any data:

  1. In the OnePlan Backup Utility, in the Enter Integration Key field, paste the integration key for the desired group.

  2. Click Download Backup.

Download_Backup_without_Content.png

The download is complete when the View File link appears. Click View File to access your backup file (which will be available in your Downloads folder).

Backup_Without_Data_Download_Complete.png

Download Backup with Data (All Plans)

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

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

    • Include Content: Check the check box if you would like to include content from the group. if you check Include Content, additional options will dynamically appear.

    • Select Plans: Allows you to select the plans to include in the backup. Download Backup With Data (Select Plans) forinstructions on selecting plans for your backup.

    • Resource Backup: Choose how you want to save or copy resource data from your OnePlan group. The options below let you control what kind of data is backed up.

      • Select Plans: Allows you to select the plans to include in the backup.

      • Resource Backup: Choose how you want to save or copy resource data from your OnePlan group. The options below let you control what kind of data is backed up.

        • Only Generics: Backs up only generic resources. These are placeholder roles or skill sets (like “Developer” or “Designer”) rather than specific people.

        • Convert All Resources to Generic: Backs up all resources, but replaces individual user names with generic roles. This helps protect privacy while keeping role-based data.

        • Backup All Users (Full Backup): Creates a complete backup of all user data, including names and details.

          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.

        • Backup All Users (Anonymize): Backs up all user data but removes or replaces personal information to keep it anonymous. Useful for analysis without exposing identities.

    Download_Backup_with_Content_All_Plans.png

  2. Click Download Backup.

The download is complete when the View File link appears. Click View File to access your backup file (which will be available in your Downloads folder).

Download_Backup_with_Content_All_Plans_Complete.png

Download Backup With Data (Select Plans)

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

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

    • Include Content: Check the check box if you would like to include content from the group. if you check Include Content, additional options will dynamically appear.

    • Select Plans: Allows you to select the plans to include in the backup. Download Backup With Data (Select Plans) forinstructions on selecting plans for your backup.

    • Resource Backup: Choose how you want to save or copy resource data from your OnePlan group. The options below let you control what kind of data is backed up.

      • Select Plans: Allows you to select the plans to include in the backup.

      • Resource Backup: Choose how you want to save or copy resource data from your OnePlan group. The options below let you control what kind of data is backed up.

        • Only Generics: Backs up only generic resources. These are placeholder roles or skill sets (like “Developer” or “Designer”) rather than specific people.

        • Convert All Resources to Generic: Backs up all resources, but replaces individual user names with generic roles. This helps protect privacy while keeping role-based data.

        • Backup All Users (Full Backup): Creates a complete backup of all user data, including names and details.

          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.

        • Backup All Users (Anonymize): Backs up all user data but removes or replaces personal information to keep it anonymous. Useful for analysis without exposing identities.

    Download_Backup_with_Content_Select_Plans.png

  2. Click Download Backup.

  3. If you chose the Select Plans option, you'll need to pick which plans to include in your backup. To do this, simply check the box next to each plan you want to back up.

    Select_Plans_for_Backup.png

  4. Click Download. The download is complete when the View File link appears. Click View File to access your backup file (which will be available in your Downloads folder).

Was this article helpful?

3 out of 4 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.