Direct Answer: How to Use the OnePlan Backup Utility in OnePlan
To use the OnePlan Backup Utility, install it, sign in with your OnePlan credentials, select your environment, and select a group if you belong to more than one. From there, choose whether to include content in your backup, decide whether to back up all plans or select specific plans, choose how resources are backed up, and click Download Backup.
What This Article Covers: OnePlan Backup Utility
This article covers installing and signing in to the OnePlan Backup Utility, selecting an environment and group, and downloading a backup with or without content, including how to back up all plans versus select plans and how to configure resource backup options.
What you will accomplish: By the end of this article, you will be able to sign in to the OnePlan Backup Utility and download a configuration-only backup, a full backup of all plans, or a backup of specific plans you choose.
Before You Begin: OnePlan Backup Utility
- You must be a OnePlan Administrator to perform a backup using the OnePlan Backup Utility.
- You must have valid OnePlan credentials for the group(s) you want to back up. An integration key is no longer required.
- Know which OnePlan environment your group is hosted in (for example, my.oneplan.ai, ca.oneplan.ai, au.oneplan.ai, eu.oneplan.ai, or QA).
- Review OnePlan Backup Options and Best Practices before choosing a backup type.
- The OnePlan Backup Utility should be used to back up OnePlan groups with more than 100 plans.
Why This Matters: OnePlan Backup Utility
Simplified Sign-In
The OnePlan Backup Utility now authenticates with your OnePlan login instead of an integration key. This removes the extra step of generating and copying a key from the Admin > Integration settings, and reduces the risk of an exposed or expired key.
Flexible Backup Scope
You can back up your group's configuration only, or include content for all plans or a specific selection of plans. You can also control how resource data is handled, which is useful for protecting personal information when sharing a backup outside your organization.
Step-by-Step: Using the OnePlan Backup Utility in OnePlan
Task: Install and Sign In to the OnePlan Backup Utility
- Go to https://oneplantemplates.azurewebsites.net/backuputil/.
- Review the prerequisites to use the backup utility.
- Click Install to download the utility.
- Open the setup.exe file from your Downloads folder. The OnePlan Backup Utility will install and open on your machine.
- On the Auth screen, sign in with Sign in with Microsoft, or enter your Email and Password and click Sign In.
Note: An integration key is no longer required to connect to your group. Signing in with your OnePlan credentials is sufficient.
- On the Select Location screen, select your Environment from the dropdown (my.oneplan.ai, ca.oneplan.ai, au.oneplan.ai, eu.oneplan.ai, or QA), then click Go.
Note: Trial environments
Trial environments are hosted in the my.oneplan.ai environment. If you are backing up a trial environment, select my.oneplan.ai.
- If you belong to more than one group in that environment, a Select Group to Continue screen appears. Select your group from the dropdown.
Note: If you belong to only one group in the selected environment, the OnePlan Backup Utility skips this screen and opens directly to the backup form for that group.
Task: Download a Configuration Backup (No Content)
- Confirm the correct Group is displayed under Group Info.
- Leave the Include Content checkbox unchecked.
- Click Download Backup.
- Wait for the progress bar to complete. The download is finished when the View File link appears.
- Click View File to open the downloaded backup file in your Downloads folder.
Task: Download a Full Backup (Include Content) for All Plans
- Confirm the correct Group is displayed under Group Info.
- Check the Include Content checkbox. Additional options appear.
- Leave Select Plans unchecked to include all plans in your group.
-
From the Resource Backup dropdown, choose an option:
- Only Generics — Backs up only generic resources, such as placeholder roles or skill sets (for example, "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 protects privacy while keeping role-based data.
- Backup All Users (Full Backup) — Creates a complete backup of all user data, including names and details.
Note: Contact OnePlan support if you would like to take a Full Backup, as it requires several additional steps.
- 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.
- Click Download Backup.
- Wait for the progress bar to complete. The download is finished when the View File link appears.
- Click View File to open the downloaded backup file in your Downloads folder.
Task: Download a Backup for Select Plans
- Confirm the correct Group is displayed under Group Info.
- Check the Include Content checkbox.
- Check the Select Plans checkbox.
- From the Resource Backup dropdown, choose an option (see the resource backup definitions above).
- Click Download Backup. A list of all plans in your group appears.
- Check the box next to each plan you want to include in the backup. Click Select All to include every plan instead.
- Click Download.
- Wait for the progress bar to complete. The download is finished when the View File link appears.
- Click View File to open the downloaded backup file in your Downloads folder.
Frequently Asked Questions: OnePlan Backup Utility
Q: Do I still need an integration key to use the OnePlan Backup Utility?
A: In OnePlan, no. You now sign in to the OnePlan Backup Utility with your OnePlan credentials. An integration key is no longer required to connect to your group.
Q: What happens if I belong to more than one group in an environment?
A: In OnePlan, after you sign in and select your Environment, the OnePlan Backup Utility prompts you to select which group you want to back up from a Select Group to Continue dropdown.
Q: Can I back up only certain plans instead of my entire group?
A: In OnePlan, yes. Check Include Content and Select Plans, then click Download Backup. A list of all plans in your group appears so you can choose which ones to include before clicking Download.
Q: Where does my backup file go after I download it?
A: In OnePlan, backup files download to your Downloads folder. Click View File after the download completes to open the file directly.
What to Do Next: OnePlan Backup Utility
Set up recurring backups:
Learn about your backup options:
Restore a backup or archived plan:
Comments
0 comments
Article is closed for comments.