User Manual

Import or Export System

Updated on

In this article, you will learn

  • which steps are required to export and import a minimal system-backup, and
  • how to manage backups and instances using the Backup Management tool.

1. Introduction

The PPDTC System Import/Export allows you to create a minimal backup of the $PRODUCT_NAME_WORKFLOW application and import it into the same or another instance of the application. The backup does not include Production Jobs, Print Items, or Print Jobs – this keeps the export size as small as possible.

All settings, templates, color setups, profiling projects, and profiles are preserved. Typical use cases include cleaning up an existing workflow, migrating to new hardware, or reproducing an issue on another machine.

To ensure that all functions are available, the PPD Tools Collection must be as administrator.

Version 1.22.0.9 or higher required

The functions described in this article are only available starting from PPDTC version 1.22.0.9 and higher. In addition, the $PRODUCT_NAME_WORKFLOW application must use at least PostgreSQL 12 and a $PRODUCT_NAME_WORKFLOW version higher than 1.14.0. For information on how to update PPDTC, refer to the article Update.

2. General

Before you export or import a system, it is recommended to clarify the basic terms:

  • Import / Backup – imports and backups are equivalent and are managed in the same way.
  • Instance – an instance is a matching pair consisting of a file management directory and a database directory, and corresponds to a backup or an import. A system can contain any number of instances.
  • Default Instance – the main instance. Ony one default instance can exist per system. It cannot be deleted via the user interface. The folders of an inactive default instance are named FileManagement_PPDTC and PMSDataBase16_PPDTC.
  • Backup Instance – multiple backup instances can exist. Each backup instance can be set as the default instance, deleted, cleaned up, or renamed. The folders of an inactive backup instances follow the format JJJJ-MM-TT-hh-mm-ss_xxxxx.

Exports can only be used on another machine if the $PRODUCT_NAME_WORKFLOW version of the export is older than or equal to the $PRODUCT_NAME_WORKFLOW version on the target machine. There must be no migration break between the versions – such incompatibilities are typically detected and reported accordingly. Database tables for Production Jobs, Print Data, and orders are not fully cleared during export; instead they are only marked as deleted. After starting the application with the imported backup, you must either execute the Empty Trash routine in Administration > Routines or manually empty the corresponding trash areas in Articles > Articles, Orders > Print Items, and Production Jobs.

Data is not deleted

Importing a backup does not delete any existing data. The $PRODUCT_NAME_WORKFLOW application can be restarted at any time using the original data.

3. Export System

Mit der Funktion System Export im Menüpunkt Application > Local Workflow > System Export / Import kann ein minimales Backup der Applikation $PRODUCT_NAME_WORKFLOW erstellt werden, das alle Einstellungen, Vorlagen, Color-Setups, Profilierungsprojekte und Profile enthält – Produktionsaufträge, Artikel bzw. Motive und Aufträge werden dabei nicht berücksichtigt. Der Export ist so konzipiert, dass die Ausfallzeit der Applikation so kurz wie möglich gehalten wird.

The System Export function, located under the menu item Application > Local Workflow > System Export / Import, allows you to create a minimal backup of the  $PRODUCT_NAME_WORKFLOW application that includes all settings, templates, color setups, profiling projects, and profiles – Production Jobs, Articles, and Print Items and Orders are not included. The export is designed to keep application downtime as short as possible.

Application Downtime

The downtime of the workflow during the export depends on the size of the database. In most cases, the database backup and file backup are completed within approximately 10 minutes. The cleanup of the export is then performed in a sandbox environment and has no impact on the running system.

3.1. Performing the Export

The PPDTC System Export is available in the Applications under Local Workflow > System Export / Import > Export.

Figure 1: The menu item Export in the menu Applications > Local Workflow > System Export / Import

To export the system, proceed as follows:

  1. Open the PPDTC application.
  2. Navigate to Applications > Local Workflow > System Export / Import > Export. This opens the System Export dialog.
  3. At the same time, an additional dialog Backup Options opens. The following configuration options are available in this dialog:

Additional Options – basic export settings for the system export:

  • Delete File Versions [1] – when enabled, all intermediate file versions of a Print Item are deleted, reducing the export size.
  • Check and Repair Export [2] – when enabled, the export is validated and cleaned, ensuring a consistent and optimized export package.
  • Upload to PPD Cloud (ZIP only) [3] – when enabled, the export is uploaded to the PPD Cloud. This option is intended exclusively for support cases. A re-download of this export from the PPD Cloud is not possible.

Exclude additional Data – defines which additional data should be excluded from the export. The more data is excluded, the smaller the export size becomes.

  • Spot Color Profiles [4] – durch Aktivierung dieser Option werden Sonderfarbprofile vom Export ausgeschlossen.
  • Fonts [5] – durch Aktivierung dieser Option werden Schriftarten vom Export ausgeschlossen.
  • Analytics Data [6] – durch Aktivierung dieser Option werden Analysedaten vom Export ausgeschlossen.
  • Color Server Data [7] – durch Aktivierung dieser Option werden Color-Server-Daten vom Export ausgeschlossen.
  • Program Files (PPD Folder) [8] – durch Aktivierung dieser Option werden PPD-Programmdateien vom Export ausgeschlossen.
  1. Sobald Sie die gewünschten Einstellungen getroffen haben, klicken Sie auf Continue. Damit wird mit dem Export des Systems gestartet.

Abbildung 2: Der Dialog System Export mit den Backup-Optionen

Die Standardeinstellungen in diesem Dialog müssen in der Regel nicht geändert werden. Der Dialog schließt sich daher automatisch nach 15 Sekunden, wenn keine Benutzerinteraktion erfolgt.

Die ZIP-Datei wird im Ordner C:\PMS_DATA oder D:\PMS_DATA gespeichert. Die Dateigröße hängt hauptsächlich von der Anzahl der in der Applikation hinterlegten Farbprofile ab. In der Regel liegt ein Export zwischen 1 und 2 GB.

3.2. Import durchführen

Der PPDTC System-Import ist im Menü Applications > Local Workflow > System Export / Import > Import verfügbar.

Default-Instanz

Vor dem Import wird automatisch immer auf die Default-Instanz umgeschaltet, um etwaige Fehler zu vermeiden.

Abbildung 3: Der Menüpunkt Import im Menü Applications > Local Workflow > System Export / Import

Um einen durchgeführten Export zu importieren, gehen Sie folgendermaßen vor:

  1. Öffnen Sie die Anwendung PPDTC.
  2. Wählen Sie den Menüpunkt Import in Applications > Local Workflow > System Export / Import > Import aus.
  3. Wählen Sie die zuvor exportierte ZIP-Datei aus.
  4. Nach Abschluss des Entpackvorgangs werden Sie gefragt, ob die Instanz sofort gestartet werden soll. Beantworten Sie die Frage »Do you want to start the instance?« mit »Ja«, um die Applikation $PRODUCT_NAME_WORKFLOW mit den neu importierten Daten zu starten.
  5. Wird anschließend die Frage »Should the import be the new default instance?« mit »Ja« beantwortet, wird der Import als Hauptinstanz markiert.

Falls der Export auf anderer Hardware eingespielt wird, muss nach dem Start der Applikation $PRODUCT_NAME_WORKFLOW eine entsprechende Lizenz installiert werden.

Abbildung 4: Die Bestätigungsdialoge

Backup

Weitere Möglichkeiten zur Erstellung eines Backups sowie die Verwaltung von Instanzen stehen im Artikel Backup erstellen zur Verfügung.

Artikel Update: $PRODUCT_NAME_WORKFLOW 2.1.0 – 05/2026

Previous Article Move the data from $PRODUCT_NAME_WORKFLOW to another drive