Systems
Backup/Restore
Overview
The Backup/Restore menu is used to create backups of OneDB configuration and restore them when required.
This function helps administrators protect important OneDB settings and recover the system configuration in case of failure, migration, or configuration rollback.
Main Functions
Administrators can use the Backup/Restore menu to:
- Create a backup of OneDB configuration
- Download or store backup files
- Restore OneDB configuration from a backup file
- Support migration between environments
- Recover configuration after accidental changes
- Roll back to a previous known-good configuration
Typical Backup Scope
Depending on the OneDB version and enabled modules, backup may include configuration related to:
| Configuration Area | Description |
|---|---|
| Users and Groups | Administrative users, groups, and access-related settings. |
| API Users | API user configuration and access settings. |
| Connections | Database connection profiles managed by OneDB. |
| Field Settings and Permission | Sensitive field definitions and protection configuration. |
| Keys | Key metadata or key configuration, depending on implementation. |
| Masks | Masking rules used for protected data display. |
| Templates | Token templates and related protection behavior. |
| Site Configuration | General OneDB site-level configuration. |
| Menu and Menu Permission | Navigation structures, sidebar layouts, and access rules defining UI visibility for specific roles. |
The exact backup content may depend on the OneDB deployment and version.
Recommended Practice
Create a backup before making major configuration changes, such as:
- Adding or changing database connections
- Updating field settings
- Modifying token templates
- Changing masking rules
- Updating license or site configuration
- Performing system upgrade or migration
For production environments, backup files should be stored securely and access should be limited to authorized administrators only.
