Device Backup - Backup settings reference
Who is this article for?
Instructor, no.
Incydr Professional, Enterprise, Gov F2, and Horizon, no.
Incydr Basic, Advanced, and Gov F1, no.
CrashPlan Cloud, no.
Retired product plans, yes.
CrashPlan for Small Business, no.
Overview
The settings in Administration > Settings > Device Backup > Backup allow you to control how and when backup operations take place, what files to include and exclude from backup, the frequency of backups, and how long versions should be retained.
General
| Item | Description | |
|---|---|---|
| a | Backup Sets | Displays Backup Sets sheet in which you can create and configure backup sets. |
| b | Backup will run | Indicates whether backups are always running or running only at specific times. |
| Always - Backup is always running. | ||
|
Between specified times - Backup will run only at specified times. When set to run between specified times, the Code42 app uses the time provided by the device's operating system.
|
||
| c |
Preferred time for verification scan
Verify selection every |
Scans the system for file changes and deleted files within your backup selection at the interval and time of day that you specify. If the device is powered off or asleep at the scheduled scan time, the scan runs 15 minutes after the device reconnects. |
| d | Lock | Locks this setting to prevent users from changing it in their personal settings. |
| e | Push | Applies these settings to existing users in addition to new users. |
Video
Watch the video below for an overview of general backup settings. For more videos, visit the Code42 University.
File selection
| Item | Description | |
|---|---|---|
| a | Included files | Adds pathnames of directories that should be included in backups of this device. Pathnames are case sensitive (see alert below). |
| b | + | Adds item to the Included Files list. |
| c | Included filenames list |
Displays pathnames of directories that are included in backups.
If the File Selection settings are not locked, users are allowed to add to this list and to remove selections from this list. Click the X to remove an item from the list. |
| d | Excluded files | Adds pathnames of directories that should be excluded from backups of this device. |
| e | + | Adds item to the Excluded Files list. |
| f | Excluded filenames list |
Displays pathnames of directories that are excluded from backups.
If the File Selection settings are not locked, users are allowed to add to this list, and to remove selections from this list. Click the X to remove an item from the list. |
| g | Lock | Locks this setting to prevent users from changing it in their personal settings. |
| h | Push | Applies these settings to existing users in addition to new users. |
A yellow folder icon indicates a folder.
A purple document icon indicates a file.Consideration: Keep in mind that excluding previously selected files results in excluded files being deleted from the backup archive. The now-excluded files will not be available for restoring.
Inclusions are processed first, followed by exclusions. Files that are in both the inclusions and exclusions will be excluded, since the exclusion list is processed last.
Files whose names differ only in capitalization are recognized as distinct files on Linux devices when you select files for backup, as well as when you select files for download. On Windows and Mac devices, files whose names differ only in capitalization are treated as the same file. When you restore two or more Linux files whose names differ only in capitalization to a Windows or Mac device, the files have "original<number>" prefixed to their names to differentiate them from one another.
Video
Watch the video below to learn how to change backup file selection. For more videos, visit the Code42 University.
User profile backup
This section allows you to view or modify Windows user profile backup settings for all organizations in your Code42 environment.
| Item | Description | |
|---|---|---|
| a | Enable User Profile Backup | Enables Windows user profile backup. |
| b | Backup Frequency | Defines how often Windows user profile backup runs. |
| c | User | Specifies a custom MigUser.xml. When an .xml is selected, the filename is displayed. |
| d | App | Specifies a custom MigApp.xml. When an .xml is selected, the filename is displayed. |
| e |
Docs |
Specifies a custom MigDocs.xml. When an .xml is selected, the filename is displayed. |
| f | Exclusion | Specifies a custom Custom.xml. When an .xml is selected, the filename is displayed. |
| g | Custom | Specifies a custom .xml. When an .xml is selected, the filename is displayed. |
| h | ScanState Options | Specifies command line options for the USMT ScanState. |
| i | LoadState Options | Deprecated - no effect. |
| j | Push | Applies these settings to existing users in addition to new users. |
Destinations
This section allows you to choose which destinations are used by newly added devices immediately upon first signing in.
Selecting a destination will cause new devices to automatically start backing up to it. Deselecting a destination will allow users to back up to the destination by clicking Start Backup in the Code42 app.
When you select at least one destination, the label changes from Auto-start to Use:
Video
Watch the video below to learn how to set backup destinations. For more videos, visit the Code42 University.
Filename exclusions
| Item | Description | |
|---|---|---|
| a | Platforms | Tabs display filename patterns to hide. |
| b | Enter filename pattern to exclude from backup. | |
| c | Regular Expression | Enter text in the form of a Regular Expression (regex). |
| d | + | Adds text in text box to list of filename patterns to exclude. |
| e | Import | Displays window in which you can paste the contents of a text file with filename patterns / regex items you wish to exclude. |
| f | Export | Displays window in which you can copy the contents of the excluded files list, which you can in turn paste into your favorite text editor for editing. |
| g | Lock | Locks this setting to prevent users from changing it in their personal settings. |
| h | Push | Applies these settings to existing users in addition to new users. |
Video
Watch the video below to learn how to set filename exclusions. For more videos, visit the Code42 University.
Frequency and versions
| Item | Description | |
|---|---|---|
| a | Frequency - Back up new version | Indicates how often Code42 for Enterprise backs up and creates new versions of files in your archive. |
| b | Versions to keep from last week | Indicates which versions to keep from last week (not including today). |
| c | Versions to keep from last 90 days | Indicates which versions to keep from last 90 days (not including last week). |
| d | Versions to keep from last year | Indicates which versions to keep from last year (not including the last 90 days). |
| e | Versions to keep from previous years | Indicates which versions to keep from previous years (not including last year). |
| f | Remove deleted files after | Period after which deleted files are removed from the archive. |
| g | Lock1 | Locks this setting to prevent users from changing it in their personal settings. |
| h | Push1 | Applies these settings to existing users in addition to new users. |
1 Code42 server versions prior to 5.4 had two pairs, one for frequency, one for retention. If either Frequency or Version retention is locked when a Code42 server upgrades to 6.0, then both will be locked when the upgrade completes.
Known issue in versions 6.0 through 6.5. Fixed in versions 6.0.4 and 6.5.1 and later.
When the frequency and versions settings are locked, and you attempt to change the Remove deleted files value, the setting becomes unlocked. To resolve this issue, unlock and relock the frequency and version settings.
Video
Watch the video below to learn how to set frequency and versions. For more videos, visit the Code42 University.
Advanced settings
| Item | Description | |
|---|---|---|
| a | Back up open files | Indicates whether files that are open (in use) at the time of back up are backed up. |
| b | Lock | Locks this setting to prevent users from changing it in their personal settings. Available in Code42 for Enterprise only. |
| c | Push | Applies these settings to existing users in addition to new users. |
Advanced settings in the Code42 API
In version 6.8.3, the following settings were removed from Advanced settings in the Code42 console.
These settings can still be set using Code42 APIs. For assistance with setting these APIs, we recommend you contact your Customer Success Manager (CSM) to engage the Code42 Professional Services team. For documentation of the APIs, see the appropriate section of the API Documentation Viewer:
- Org: To set device backup defaults at the system level, send the API call from
/api/Org/1(Org 1 represents the system). To set device backup defaults at the organization level, send the API call from/api/Org/<OrgId>. -
Computer: To set device backup defaults at the device level, send the API call from
/api/Computer/<computerId>.
Pausing controls
(Version 6.8.3 and later)
| Item | Description | |
|---|---|---|
| a | Backup |
Allow users of the Code42 app to pause backups. Leave unselected to remove all pause controls from the Code42 app. |
| b | Legal Hold Backup | Allow backups of files under legal hold to be paused. Leave unselected to disallow pausing of backups with files under legal hold. |
| c | Lock | Locks this setting to prevent users from changing it in their personal settings in the Code42 console. |
Disallowing users of the Code42 app from pausing backups ensures more complete sets of backed up files. If they pause backups often, users may not get complete sets of backed-up files.