Skip to content

Commit 691bd3e

Browse files
authored
Merge pull request SkylineCommunications#479 from Joachim-Ally-Skyline/patch-3
Updated Skyline DOM Backup Manager after feedback of DOM Expert Panel.
2 parents 9ecd7b1 + 7e1122e commit 691bd3e

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

connector/doc/Skyline_DOM_Backup_Manager.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ uid: Connector_help_Skyline_DOM_Backup_Manager
66

77
This is a generic connector that ingests all of the available **DOM modules in the DMS** and takes a backup of each module based on user requirements.
88

9-
It is intended for users that depend a lot on DOM for their day-to-day operations, so they can have the peace of mind of knowing that if something goes wrong with their system, all their DOM modules will be backed up.
9+
It is intended for users that depend a lot on DOM for their day-to-day operations, so they can have the peace of mind of knowing that if something goes wrong with their system, all their DOM modules will be backed up. This connector offers the ability to include DOM instances in the backups along with some quality-of-life configuration for e.g. frequency of backups, maximum backups, etc.
1010

11-
This connector offers the ability to include DOM instances in the backups along with some quality-of-life configuration for e.g. frequency of backups, maximum backups, etc.
11+
Furthermore, it is possible to restore previous backups. This gives the user the possibility to easily go back to an earlier point in time.
12+
13+
> [!WARNING]
14+
> Only use this connector in production systems after evaluating internally within Skyline. Whether using this connector is recommended depends on the size of a certain module, its instances, and the DMS to which you want to deploy it.
1215
1316
## About
1417

@@ -46,16 +49,16 @@ The **Backups Schedule** page lists all the **available DOM modules** in a table
4649

4750
There are also two standalone configuration parameters on this page:
4851

49-
- **Backup File Path**: The path where the backup will be stored. Default: `C:\Skyline DataMiner\Documents`.
52+
- **Backup File Path**: The path where the backup will be stored. Default: `C:\Skyline DataMiner\Documents\DMA_COMMON_DOCUMENTS\DOM Backups`.
5053
- **Sync button**: This allows you to manually **update the table** with all DOM modules in the DMS.
5154

5255
### Restorables Page
5356

54-
The **Restorables** page of this connector contains two tables: the [DOM Module Overview Table](#dom-module-overview-table), listing all the DOM modules inside a specified folder, and the [Restorables Overview Table](#restorables-overview-table), listing the zip files that can be restored.
57+
The **Restorables** page of this connector contains two tables: the **DOM Module Overview Table**, listing all the DOM modules inside a specified folder, and the **Restorables Overview Table**, listing the zip files that can be restored.
5558

5659
There are also several standalone configuration parameters on this page:
5760

58-
- **Restore Folder Path**: Syncs the modules across the zip files at the specified path.
61+
- **Restore Folder Path**: Syncs the modules across the zip files at the specified path. Default: `C:\Skyline DataMiner\Documents\DMA_COMMON_DOCUMENTS\DOM Backups`.
5962
- **Update Folder Path**: Updates the **DOM Module Overview** table with the modules found inside the folder specified with the Restore Folder Path parameter.
6063
- **Update Path**: Updates the **Restorables Overview** table with the zip files found inside the folder specified with the Restore Folder Path parameter.
6164

@@ -79,6 +82,12 @@ This table allows you to select a zip file to restore the information for the de
7982
- **Restore State**: Displays the current state of the row. Possible values are **Not Restored**, **Processing**, **Failed**, and **Restored**.
8083
- **Restore Button**: Allows the connector to restore the desired row.
8184

85+
> [!NOTE]
86+
> The restorables displayed in this table are **unique**. They are determined by comparing the Last Modification parameter of each created backup. This comparison process runs in the background. The advantage of this approach is that when the user sorts the table by the Last Modification column, it effectively creates a version history of DOM backups, showing only the distinct backup moments that are meaningful for restoration. It is normal not to see all backups of the backup folder in this table, especially if multiple backups were taken without any changes made in between.
87+
88+
> [!WARNING]
89+
> In the background, when a previous backup is restored, the system first checks if the module already exists. If it does, an automatic backup is created before the existing module is deleted and the old backup is imported. Although this approach ensures safety, it can be time-consuming depending on your system's computing power and the read/write speed of your indexing engine.
90+
8291
### Configuration Page
8392

8493
On the **Configuration** page of this connector, you can configure the following parameters:

0 commit comments

Comments
 (0)