Backup/Restore [Utsav]

Best Practice:

Once a Program has been tested and is consider fully functioning we recommend you make a backup of the Program. Equally, if you are making changes or updates to an existing Program you should make a backup prior to making any changes.

Please note that a Backup only includes the metadata, it does not include the Sharing settings or the actual data at that point.

To create or restore a Backup, you need to be logged in to DHIS 2 and on the Program Config App Home Screen (List of programs).

To access the Backup menu, click the (1) Three Dots on the right-hand side of the relevant Program to open the dropdown menu, next click on (2) Backup/Restore and select the relevant option for the popup menu, as shown below.

Export JSON Metadata

This function call DHIS2 export functionality and produces a self-contained single JSON for the selected program with all dependencies, but without (1) sharing, (2) Org Unit assignment (3) ???, which ensures its importation into any other DHIS2 server.

You can use the downloaded JSON to import into any other DHIS2 server using the standard Import/Export DHIS2 app, Metadata Import option. This is the recommended way to move your configurations from a development server to a staging or production server.

Read more about DHIS2 import/export, and metadata import.

Backup (server)

With the PCA you can create snapshots of your configurations as you progress in your implementation. These metadata backups include all the related objects (prog Stages, Sections, DEs, Option Set, Prgr Rules, Prg Indicators, Prg Variables) in your program, but do not include the sharing or the data itself.

In the popup, the ‘Backup Name’ and ‘Version’ are already provided but you can change them as per your convenience.

You can also provide more details in the ‘Comments’ section for future reference.

Please note all the fields marked with ( * ) are mandatory fields.

After providing all the required information, you can save the Program backup by clicking on ‘Save Backup’ button. A notification on the top center of the screen will appear notifying you ‘The backup for the selected Program has been created successfully.’

You can also close the popup by simply clicking on the ‘Close’ button but it won’t create or save any backup.

Feel free to create as many backups as needed. The Backup name (with the timestamp) and Version will be helpful to differentiate your backups.

Restoring Backups

Once the programs are backed up, You can restore them if anything went wrong with your program. From the Program menu, you can select ‘Backup / Restore’ option to open a submenu and select ‘Restore Program’ option to open ‘Available Backup’ popup.

If the program has previous backups, you can see list of those backups in this popup. But if there isn’t any previous backup, then it will show a warning message with ‘No Backups found’ message.

In this popup, you can notice two action buttons on the right of each backups.

Restore: This option will open another ‘Restoring’ popup window.

Download: This option will download the specific backup version of that program. You can review the file json file and import it using ‘import / export’ app in DHIS2.

Close: As the name suggest will close the popup window without affecting anything.

Restoring Program

This popup will allow you to fine tune your requirement for the restoring purpose.

Restore Elements: You can chose which object you want to restore from the backup file. You can simply restore Program if your changes were specific to the Program and you can also chose the ‘Data Elements’ which in turn will also restore ‘Program Stage Data Elements’, ‘Program Stages’ and ‘Program’. The indentation shows the Parent-Child relationship between the elements. You cannot restore ‘Child’ without restoring the ‘Parent’.

Select All / Select None: You can use these buttons to check all the Elements or None of them.

Organisation Units: While restoring, you can keep your current Organisation Unit assignment by selecting ‘Keep current settings’ or you can replace all you existing configuration with backup assignment by selecting ‘Overwrite with backed up configuration’.

Sharing Settings: Similar to Organisation Units restore, you can either keep the settings or overwrite them by selecting one of the two option available.

Cancel: As the name suggest will simply close the popup window without impacting the program.

Dry Run: It will test the import settings without impacting / importing any data.

After running the dry run, it will show how many elements will be created or impacted. In above example 291 elements will be impacted, but the number will vary based on the Program you want to restore and Elements you have selected.

Please run ‘Dry Run’ before Restoring the program

Restore: After selecting all the required option and running dry run, you can click ‘Restore’ button to restore the backed up copy of the program. It will take sometime to restore and will show a Success notification once completed.