Prerequisites

  1. Python 3 must be installed. Visit https://www.python.org/downloads/ and download the latest Python 3.x.x installer.

  2. During install, ensure "Add Python 3.x to PATH" is checked.

Note: If Python 2 was installed previously, use py -3 to explicitly run the scripts with Python 3.


How to Run backup.py

  1. Close Navigator Server and related apps (especially RIP Manager and Client).

  2. Open File Explorer and go to:

    C:\Navigator\User Resources\Utilities\DFEBackRest
  3. Hold Shift + Right Click inside this folder, and choose:

    Open PowerShell window here

    Or, in Windows 11, choose:

    Open in Terminal
  4. Type the following and press Enter:

    py -3 backup.py
  5. A dialog will prompt you to choose a folder where the backup should be saved.

  6. After processing, a .zip file will be created and the temporary folders removed.


How to Run restore.py

  1. Ensure Navigator Server, Client, and RIP Manager are not running.

  2. Open the same DFEBackRest folder.

  3. Open a Terminal or PowerShell window as before.

  4. Run:

    py -3 restore.py
  5. You’ll be prompted to select a backup .zip file.

  6. The script will restore the files to their expected locations.


Key Caveats

  • Does Not Backup:

    • Job or archive folders

    • _template file (very important for RIP behavior)

    • Any branding images used in the DFE interface

    • .jobs archive (only active jobs via Xiflow.jobs)

  • Overwrites without merge: Restoring overwrites INI/JSON configurations with the previous backup’s versions. New presets or settings in newer Navigator versions may be lost or mismatched. Proceed with caution after a system upgrade .

  • Security Files: Licensing files are backed up (Security/), but not restored by default, likely to avoid conflicts with activation servers.


Troubleshooting Tips

  • If double-clicking backup.py or restore.py does nothing, run them via py -3 in a terminal.

  • If the py command doesn’t work, try python or python3 instead.

  • If restore fails:

    • Verify the backup ZIP isn't corrupted.

    • Make sure Renderers folder exists under C:\Navigator.

    • Ensure the script resides in: C:\Navigator\User Resources\Utilities\DFEBackRest