Manual backup and restore

Last modified by Aurelie Bertrand on 2025/12/19 08:51


Backing up data

Data can be backed up manually from the DigDash Configuration module.
Select the items you wish to back up and then generate the backup in the form of a zip file, which you can then use to restore them to the new environment or version.

General procedure

To back up data :

  1. From the home page, go to Configuration then Backups Management
  2. Click on Backup.
  3. In the login box, enter the user's name and password.
    ➡ The Backup page appears.
    The menu on the left allows you to navigate through the different types of items. The list of items corresponding to the selected type is displayed in the central area.
    Backups management
  4. Select the data to be backed up: see Selecting the data to save below for a detailed description of the items.
  5. Click the Download button.
    ➡ The Options window appears.
  6. Select the options you want: see the paragraph Options below for more details.
  7. Finally, click Download to obtain the backup file (.zip file).

Selecting the data to be backed up

You can choose to select all the data directly by clicking on the Select button in the top left-hand corner, or you can select the items you want to back up in each section.

ℹ If the item is a file, it is located in the DigDash domain data directory. For example: ( appdata>/Enterprise Server/ddenterpriseapi/config directory). The file paths below are relative to this directory.

Users

This section lists the data relating to each user. In particular, it allows you to save the data models, flows and tables for their personal role.
Here you can check the box in front of each user to select all the items corresponding to that user, or select the items one by one.
Similarly, you can check the box in front of an item (for example, Wallets) to select that item for all users.
It is also possible to select all the data in the section by clicking on the Select all results button.

ItemDescription
LDAPUser information stored in LDAP:
  • User attributes (name, username, password, variables, etc.)
  • User roles
  • User authorisations and authorisation groups
Wallets

User's personal Flows

File: /server/<user>/config/wallet.iwt

Dashboards

User's personal dashboards

File: /server/<user>/config/dashboard.xml

Data templates

User's personal data templates

File: /server/<user>/config/tabledatamodelrepository.xml

Private viewsUser's private views saved in ad-hoc analysis
PreferencesUser preferences: display of context-sensitive help, order of roles in the dashboard, etc.

User profiles

This section lists the user profiles. See the paragraph Managing user profiles to find out more about user profiles.

Roles

This section lists the data relating to each role. The user can only see the user assigned to him.
Items are selected in the same way as for users.
It is, however, possible to make a more detailed selection for wallets, dashboards and data models. For these, a counter in brackets indicates the number of items selected / the number of items available. Click on this counter to access the detailed list of items. For example, for a wallet, you can select the Flows one by one.

💡 Tip: Select the role allows you to select all the items attached to the role with a single click.

Roles

ItemDescription
LDAPRole information stored in LDAP:
  • Role attributes (name, identifier)
  • Role users
Wallets

Role information flows

File: /config/role/RoleID/wallet_<Id_Role>.xml

Dashboards

Role dashboards

File: /config/role/RoleID/dashboard_<Id_Role>.xml

Data models

Role data templates

File: /config/role/RoleID/tabledatamodelrepository_<Id_Role>.xml

Libraries

Libraries of elements assigned to the role. These correspond to the following files (config/role directory):

  • Colour palette: colortablerepository_<role_id>.xml
  • Flow styles: cssrepository_<role_id>.xml
  • Database connections: dbcnxrepository_<role_id>.xml
  • Number and date formats : formatrepository_<role_id>.xml
  • Flow output devices: favoritedevicesrepository_<role_id>.xml
  • Forms: formrepository_<role_id>.xml
  • Hierarchies: hierarchyrepository_<role_id>.xml
  • Javascript functions : jsfunctionrepository_<role_id>.xml
  • Maps: maprepository_<role_id>.xml
  • Refresh schedules: schedulerepository_<role_id>.xml
  • Document servers : serverurlrepository_<role_id>.xml

Authorisation groups

This section lists the definition of authorization groups provided by DigDash or added by the user. Authorisation groups are only stored in LDAP.

System Files

This section lists the system files common to all users and roles ( appdata>/Enterprise Server/ddenterpriseapi/config directory).

ItemDescription
apikeys.csvAPI key storage file.
quotarepository.xml

Parameters for Quota management parameters defined to limit the size of cubes or the memory used by cubes.

serversettings.xml

DigDash Enterprise server settings:

  • HTTP proxy
  • LDAP connection
  • Scheduler parameters
  • Performance parameters
  • And the settings on the Server Settings page

Recommendation: Do not port this file between several different configurations

system.xml

System information and some hidden parameters described on the Advanced performance parameters.

Recommendations: Do not port this file between several different configurations

userssettings.xml

User settings including the settings you have created.

Libraries

This section lists the libraries for all the users and roles linked to the various managers. These files may or may not be present depending on the parameters used by the Flows or data models ( appdata>/Enterprise Server/ddenterpriseapi/config directory).
A counter in brackets indicates the number of items selected / the number of items available for each dictionary. You can click on this counter to access the detailed list of elements and select them one by one. You can also view which elements are assigned to a role and which one.

💡 Tip: by clicking on the name of a role in the list, all the items associated with that role are automatically selected/deselected.

Libraries

Ite mDescriptio nScope
colortablerepository.xml

Colour palette library

Flow configuration
cssrepository.xml

Library of Flow styles

Flow configuration
dashboard_ddhome.xmlDashboard home page definition 
dashboard_foreground.xmlDashboard foreground page definition 
dashboardsettings.xmlDashboard parameters 
clustersettings.xml

Cluster mode configuration (advanced)

System configuration
DDComments.mv.db

Database of comments on flows and dashboard data models.

Display of dashboards and flows
dbcnxrepository.xml

Database connections library (advanced)

Configuration of data models (connections to data sources)
favoritedevicesrepository.xml

Library of Flow output devices

Export flows
flowsnapshotrepository.xml

Library of user views of flows saved as ad-hoc analyses

Display of flows (editable in the dashboard)
formatrepository.xml

Library of number and date formats

Configuration of data models and flows
hierarchyrepository.xml

Library of shared hierarchies used by data model dimensions

Configuration of data models
jsfunctionrepository.xml

Library of javascript functions used in derived measures, filters, source transformations, etc.

Configuration of data models and flows
maprepository.xml

Library of map definitions used to create geographic maps.

Configuration of data models and flows
navigationsentencerepository.xml

Library of sentences created for text reports.

Flow configuration
schedulerepository.xml

Library of shared refresh schedules.

Configuration of data models and Flows
serverurlrepository.xml

Library of document servers used in DigDash Enterprise.

Configuration of data models
vectoriconrepository.xml

Library of vector icons used in particular by computer graphics.

Flow configuration
vizmodelrepository.xml

Library of shared visualisation models associated with flows.

Flow configuration

Translation files

This section lists the translation dictionaries containing messages in different languages ( appdata>/Enterprise Server/ddenterpriseapi/config directory).
Each of the following translation files may be accompanied by a file corresponding to the chosen language. For example, the files dm.properties, dm_fr.properties, dm_es.properties are translations of messages corresponding to the English (default), French and Spanish languages.

ElementDescriptionScope
dashboard.properties

Dictionary of translations used in elements specific to the dashboard:

  • Page names
  • Portlet names
 
dm.properties

Dictionary of translations used in data models and flows.

Display of flows and data model elements
dmvoc.properties

Dictionary of spoken values for data model expressions.

Video export of flows (optional)
dmtag.properties

Dictionary of synonyms created in data models. These dictionaries are used by the dashboard search function: natural language query.

Text search in the dashboard

Data sources

This section lists the data sources contained in the Common Datasources file server.

Other

This section lists other files related to dashboard configuration.

ItemDescription

Images
(*.png, *.jpg, *.gif...)

(*.svg)

List of images added from the dashboard editor.
Folder: /config/web/public/, /config/web/public/<Id_Role>/, /config/web/public/<user>/

List of SVG map images.

Styles

default.css

*.css

D3 templates

Files containing custom styles for the dashboard. CSS style sheets can be edited in the dashboard editing interface.

File: /config/web/public/default.css,

/config/web/public/*.css

/config/web/public/D3templates/*.css

Javascript constants

Server constants (properties in the Server settings > Cubes > Constants page) and export parameters (Server settings > Exports and API> Export options)
File: /config/web/session/js-const.js

Default custom Javacript file for the dashboard

Default custom script file for the dashboard. This file can be edited directly from the dashboard editing interface.
File: /config/web/session/js-default.js

Custom script files

Custom script files for the dashboard and D3 templates.

Options

OptionDescription
Also export the objects on which the selected elements depend (formats, colours, scripts, etc.)

Include all the objects used for the selected elements in the backup. For example, the colour palette or measurement format used for a Flow ticked in the items to be saved.

The following 3 boxes are then ticked by default.

Export definitions of dependent roles/profiles/authorisation groups from LDAPInclude the definitions of LDAP-dependent roles/profiles/authorisation groups.
Export dependent content server definitions (serverurlrepository.xml)Include the definitions of the document servers used for the selected elements. These definitions are stored in the serverurlrepository.xml file.
Export dependent files (server Common Datasources, icons, style sheets, etc.)

Include all files dependent on selected elements: the data source of a selected data model, the icon used in a selected Flow, etc....

Images referenced in dashboards are included.

Export custom JavaScript files from the dashboard tooInclude custom JavaScript files created in the Dashboard Editor.
Prepare backup for incremental restore

Checked by default. It is recommended to leave it ticked in most cases.

Used to prepare the backup so that, when it is restored, existing elements in the restore environment are completed rather than overwritten by elements from the backup.

For example, if the backup contains a single colour palette and the box is checked, the palette will be added to the existing palettes in the restore environment. If the box is unchecked, the palettes in the restore environment will be overwritten and only the palette from the backup will be retained.

Restoring data

❗ It is recommended that you only import data from the same or an earlier version of DigDash.

Restoring data from an archive

💡Before restoration, an automatic backup of the data is made to avoid any loss in the event of an error. The file generated is copied to the Working Directory (AppData):
<digdash.appdata>/Enterprise Server/<domain>/backups/<day's date>_prerestore_backup-auto.zip.
Data sources are not included in this backup.

Only one automatic backup per day is kept. If you perform several restores on the same day, only the automatic backup performed during the first restore is retained. If the file is deleted, the file is regenerated on the next restore for the current day.
The file retention period is defined, as for the automatic maintenance service, by the autoBackupKeepDays property in the digdash.properties file.

To restore data from an archive file :

  1. From the home page, go to Configuration then Backup Management.
  2. Click Restore.
    ➡ The Restore page appears.
  3. Click Browse to select the zip file corresponding to the backup you wish to restore.
    Upload backup

    ➡ The Restore page displays the data contained in the backup. They are all selected by default.
    The name of the file and the restore mode (incremental or not) are indicated at the bottom left.
    Restore archive
  4. You can modify the items selected in the same way as for the backup.
    • In the Roles section, an asterisk is added to the counters for wallets, dashboards and data models if the restore is incremental (similarly, in the Libraries section): existing items in the restore environment will be supplemented rather than overwritten by items from the backup.
    • When you click on a counter to display the details of the items, you can see their status in comparison with the items already present in your environment: new, identical, older, etc. See paragraph Status of backup items for more details.
  5. Click Restore at the top of the page.
    ➡ A message tells you that the data has been reloaded and prompts you to restart the server.
    In the case of restoring a data model whose structure has been modified, a message is displayed to suggest the automatic update of any dependent data models (Union, Join and Transformer). See the paragraph Restoring data models and dependent models for more details.

Restoring an automatic backup

An automatic backup of your environment is performed before an archive is restored or by the automatic maintenance service environment before files are cleaned. You can restore these backups:

  1. On the Restore page, select a backup from the Choose a saved automatic backup drop-down list :
    • regular automatic backups performed by the maintenance service are marked (Automatic);
    • automatic backups performed before restoration are marked (Pre-restoration).
      Restore auto backup

ℹ The date/time displayed here is not the date extracted from the file name but the actual date on which the file was last modified.
In the particular case where a backup starts on 20/09 at 23:59 and lasts 3 minutes, its file name will be of the type 20250920_..., but its actual date will be 21/09/2025 at 00:02.

If a user time zone is specified (or deduced, for example via the browser), the time displayed is converted accordingly.

  1. Click Load.
    ➡ The restore interface is then displayed in the same way as for restoring from an archive file. Proceed in the same way as above for the rest of the restore.

Status of backup items

As mentioned above, when you click on a counter to display the details of the items, you can view their status in comparison with the items already present in your environment.

Items status

Items can have the following statuses:

NewThe backup item does not yet exist in the recovery environment.
IdenticalThe item in the backup and the corresponding item in the restore environment: they have the same last modification date.
OlderThe item in the backup is older than the corresponding item in the recovery environment.
N/AThe status is unknown because the item in the backup does not have a last modification date.
AbsentThe item pointed to by the backup does not exist in the zip archive.
This can happen if a shared item has been deleted from a library while it was in use.

In the case of libraries, you can also view which items are assigned to a role and which.

💡Hint: clicking on the name of a role in the list automatically selects/deselects all items associated with that role.

1762250048416-265.png

Restoring data models and dependent models

When restoring data models with structural modifications (addition/removal of dimensions or measures, modification of column names, etc) compared with the current environment, it is possible to automatically update the dependent models (Union, Join or Transformer using the data model). For example, if you restore a data model in which a calculated measure has been added, a join using this model will automatically have this calculated measure available.

When you click on Restore, all the models dependent on the restored models - Union, Join or Transformer - are searched for.
A message listing the dependent models affected by modifications to the restored models is then displayed:
Info

  • Click OK to "propagate" the update from the restored models to the dependent models.
    For each model updated, a dependency calculation is performed so that all models are updated (if a transformer uses a model from a union, it will be updated automatically after the union).
    ➡ An information message indicates which models have been successfully updated

ℹ If there is a conflict, the changes will not be applied (the failed templates will appear in the restore page) and you will need to repair the templates in the Studio.

  • Click Cancel if you want to update the data models manually later.

Migrating database connections and file servers

To make it easier to migrate these elements, you can change their identifiers so that they are identical between the development and production servers.

During the first migration between a development server and a production server :

  1. Make a full backup of the development environment.
  2. Restore the backup on the production environment.
  3. Modify the connection strings to the databases and file servers on the production environment from, respectively, the Database Connection Manager and the File Server Manager in the Studio.

During the following migrations to production environments :

  1. Make a selective backup of data: data models, wallets, modified or new dashboards, etc.

Do not save the file containing the connections (dbcnxrepository.xml) or the file containing the document servers (serverurlrepository.xml), even if they contain modifications.

  1. Restore the backup to the production environment.
  2. If changes have been made to the connections or file servers in the development environment, transfer them manually to the production environment.

For new connections or document servers, transfer the identifier used to the development environment:

  • To transfer the database connection ID, open Database connection manager in the Studio. Edit the connection you want to change, then click the Edit button to the right of the ID field to change the ID.
    ID edit
  • To transfer the identifier of a document server, open File server manager in the Studio. Edit the file server you want to change, then click the Edit button to the right of the Identifier field to change the ID.