11.18.Configuration of File system recovery job
File system recovery jobs are used to re-generate a file system from the archive back into the original file location. This processing type can be used in the following cases:
- The entire folder structure has been deleted;
- One or more folders have been deleted;
- One or more documents from the folder(s) have been deleted and the user needs to get back these already archived documents from the archive.
The file system recovery can reconstruct the entire folder structure from the archive: the items that have been already archived will be put back into their source location. It will also create the folder if it was deleted from the folder structure. It is possible to recover any part of the structure:
- One or multiple folders;
- Recursive folder structure;
- One or more folder contents.
The file system recovery job is checking for the duplicates, so the same recovery job can be run safely multiple times, duplicates will not be created:
- If there is a shortcut for the recovered file in the folder – the file won’t be recovered;
- If the file is already present in the folder – the file won’t be recovered;
- If the same file is archived multiple times into the same folder – only the youngest file will be recovered.
The user has multiple options what to recover; it is possible to recover either the original file or the shortcut. The recovery job can be also used if the user archived the files with the “delete” method and these files should be put back into the file system.
To create a recovery job, navigate to File Archive ⇒ Archive ⇒ Jobs control button and click on +new. In the Add new job instance dialog, select File system recovery job from the dropdown list, select a node where the job should run from the Run on node dropdown list (if you would not like to specify a node here and the job should run on any available node, then select “Any available”), enter a Display name and click on Add.
✓ Report mode settings:
If the Use report mode checkbox is checked, the job will run in report mode. After the job finishes its run in this mode, the user will be able to download a .csv report file here in this section. The file will contain a list of files that belong to the folder(s) that is (are) selected in section Folders to process of the job and some information to them, including whether they will be processed or not.
✓ Scheduling settings:
In this step the running times of the recovery job must be selected. It is possible either to select a scheduler from the list or to create a new scheduler via create new option. Recovery jobs are run only in specific cases. In most of the cases it is recommended to set a One time scheduler for the recovery job (e.g. with start date 7th of September at 6 PM), or to start the job manually from the status bar. (For more information about how to set schedulers refer to the section Schedules above.)
✓ Processing settings:
In this section, the user configures what will be recovered and how it will be recovered:
Recover – what will be recovered
- Files and structure: the recovery job will create the archived folder structure and recover the files from the archive
- Structure only: the recovery job will create the archived folder structure, but no files will be recovered
Overwrite existing file – when to overwrite the file if it already exists in the target location
- Never: do not overwrite existing files with the archived version
- Always: always overwrite existing files with the archived version
- If older than the archived version: overwrite only if the modification date of the existing file is older than the modification date of the archived file
- If newer than the archived version: overwrite only if the modification date of the existing file is newer than the modification date of the archived file
Set the modification date of recovered items to
- Original: the modification date of the archived item will be set on the recovered file
- Recovery date: the date, when the recovery job is running will be set on the recovered file
What to recover
- Last known version: the job will recover the latest version of the item from archive
- Specific date: the job will recover the version that was valid at the specified time. It means the version having modification date older or equal to the specified date.
Shortcut processing type
- Recover original: the job will recover the original file
- Recover shortcut: the job will recover the shortcut. If the user selects the shortcutting option, it is also required to specify the Virtual drive server name. By using the Use default option, the Virtual Drive that was already configured on the Virtual Drive configuration page will be automatically preselected. It is recommended to use this option, because if the settings are changed on the Virtual Drive configuration page, the value will be automatically used by the job, too, without a need to change the job’s settings.
✓ Folders to process:
In this section the user is required to specify one or multiple archive folder(s), or recursive folder structure(s) that were deleted and need to be recovered from the archive. There are multiple options how to add new source location(s) with content needed to be recovered:
- Via the + new option:
Click + new. The Folder to process dialog will open. First, we select the Root (source) file path from the dropdown list and enter the subfolder to the Relative path text box if necessary. Next, select where the files from the folder will be recovered to:
To original location – items will be recovered to the place where they were archived from
Click on the To original button. You can test the accessibility by clicking on the Test button. Click OK.
To specific location – items will be recovered to a different folder
Click on the To specific location button. A new dropdown list will appear. Here you select the destination folder for the recovery (it must also be previously configured as a Root folder). You can also enter the subfolder to the Relative path text box if necessary. You can test the accessibility by clicking on the Test button – in this case, it checks the accessibility of both locations (the upper “source” and the below “target” location). Click OK.
- It is also possible to import the files to recover from a file, where the file path(s) are specified. To import this file, click the “import” button and follow the steps specified in chapter Importing contentACCESS configurations from files of this guide.
✓ Exclude folders
With this function you may set, which folders/subfolders should not be recovered. The same rules apply for these settings is in the file archive job. If you would not like to exclude any folder from the recovery process, you can skip these settings.
The folders may be excluded using one of the available methods: a) They may be added manually via the + new option; b) or may be imported in one of the available file formats via the import option.
- Add exclude folders manually:
Click on + new option. In the Exclude folder dialog’s textbox specify the folder(s) to be excluded. Use the hints that are featured in the same dialog.
- Import the list of exclude folders:
Exclude folders may be imported as files in one of the available formats: CSV, XML, Tab delimited files or Space delimited file. The file to be imported must contain the list of folders. To import such a file with the list of folders refer to chapter Importing contentACCESS configurations from files of this guide.
✓ Filtering settings:
Click on the Change filter button and set the filtering according to your needs and/or regulations. To learn more about how to work with filtering settings, please, check this section of our documentation.
For this reason, it is recommended to always check also the size filter settings if an item has not been processed.
✓ Modification date
The files can be recovered either with the original modification date or with the recovery date. It is recommended to set the recovery date if the folder is already processed by an archive job and the user wants to prevent the folder from re-archiving.
✓ Notification settings:
The user may select here, in which cases he needs to get notifications from the recovery job. It is possible to set here that the notification emails will be sent only in case of errors or warnings, or they can be sent in all cases, too. Into the Recipient list textbox the user should insert the email addresses of the people, whom these emails should be sent to. Notifications emails may be used as tools of the troubleshooting process.
✓ Resource settings:
The user may set a value here, which will determine how many items will be processed simultaneously by the recovery job.