Richtlinie zur Prozessdatenaufbewahrung

Überblick

Beim Ausführen von Prozessen werden große Mengen an Auftragsdaten generiert, die Ihre Orchestrator-Datenbank schnell überfüllen können. Eine Aufbewahrungsrichtlinie hilft Ihnen, die Datenbank auf organisierte Weise freizugeben.

Was ist eine Aufbewahrungsrichtlinie? Es handelt sich um eine Vereinbarung, um integrierte Funktionen zum Entfernen von Daten sicherzustellen, indem eine Aktion festgelegt wird, mit der Daten nach einem bestimmten Zeitraum aus Ihrer Datenbank entfernt werden. Was ist zu erwarten? Aufgrund einer einfacheren Datenbank bietet Ihr Cloud-Orchestrator eine bessere Leistung.

Auftragsbedingungen

Für den angegebenen Prozess gilt die von Ihnen konfigurierte Aufbewahrungsrichtlinie für alle Aufträge, die gleichzeitig die folgenden Bedingungen erfüllen:

• Sie haben einen endgültigen Status, z. B. Fehlerhaft, Erfolgreich oder Angehalten
• sie wurden vor mehr als X Tagen beendet, wobei X die Aufbewahrungsdauer ist.

Festlegen, wann ein Auftrag gelöscht wird

Die Aufbewahrung wird basierend auf Kalendertagen berechnet. Daher werden qualifizierte Aufträge am Kalendertag X+1 gelöscht, wobei X die Aufbewahrungsdauer und +1 die Löschung am folgenden Kalendertag darstellt.

Beachten Sie, dass die Löschung zu Beginn des nächsten Kalendertages ausgeführt werden kann, also einige Stunden nach dem Ende der Aufbewahrungsfrist.

Angenommen, Sie legen eine Aufbewahrungsdauer von einem Tag fest:

Wenn die Endzeit eines Auftrags entweder der 6. Juni 2022 00:01:00 (die erste Minute des Kalendertages) oder der 6. Juni 2022 23:59:00 (die letzte Minute des Kalendertages) ist, kommt er für die Löschung in Frage, die am 8. Juni ausgeführt wird (6. Juni + ein Tag Aufbewahrungsdauer + einen Tag danach = 8. Juni).

Daher:

• Wir stellen sicher, dass Ihre Auftragsdaten für mindestens einen Kalendertag (die Aufbewahrungsdauer) aufbewahrt werden, indem wir sie am nächsten Kalendertag archivieren, und
• Wir möchten sicherstellen, dass Ihre Elemente bis zum Ende des nächsten Kalendertages archiviert werden.

Richtlinientypen

Es gibt drei Arten von Aufbewahrungsrichtlinien:

• die Standardrichtlinie für neu erstellte Prozesse – alle Aufträge, die aus neuen Prozessen erstellt werden, werden nach 30 Tagen gelöscht, ohne dass das Löschen rückgängig gemacht werden kann. Dies ist die integrierte Option.
• Die benutzerdefinierte Richtlinie – Alle Aufträge werden nach einer Aufbewahrungsdauer Ihrer Wahl, die maximal 180 Tage beträgt, gelöscht oder archiviert. Diese Option kann gemäß den Anweisungen im Abschnitt Konfigurieren einer benutzerdefinierten Aufbewahrungsrichtlinie konfiguriert werden.
• Die Aufbewahrungsrichtlinie – Für bereits vorhandene Prozesse und Aufträge ist keine anfängliche Aufbewahrungsrichtlinie definiert, d. h. ihre Daten werden auf unbestimmte Zeit aufbewahrt, bis Sie eine Standard- oder benutzerdefinierte Richtlinie festlegen.

Wichtig:

Die Standardrichtlinie von 30 Tagen gilt für:

• Aufträge ohne zugeordneten Prozess
• Aufträge, deren zugehöriger Prozess gelöscht wurde

Richtlinienergebnisse

Eine benutzerdefinierte Aufbewahrungsrichtlinie hat die folgenden Ergebnisse:

• Es löscht die Aufträge, die älter als die angegebene Dauer sind.

• Sie löscht die gültigen Aufträge, die älter als die angegebene Dauer sind, archiviert ihre Daten jedoch in einem vorhandenen Speicher-Bucket, um später darauf zurückgreifen zu können. Auf diese Weise können Sie Ihre Orchestrator-Datenbank entlasten, ohne die Informationen zu verlieren.

  Hinweis:

  Insights-Dashboards, die Informationen zu gelöschten Aufträgen enthalten, zeigen weiterhin die richtigen Daten an.

  Die Löschung im Orchestrator wird nicht an Insights weitergegeben.

  Hinweis: Wir behalten eindeutige Referenzen gelöschter Aufträge bei, daher wird beim Hinzufügen eines neuen Auftrags keine doppelte eindeutige Referenz erstellt.

Implementierungsphasen

Wir wissen um die Auswirkungen, die diese Funktion auf Ihre Daten haben kann, und führen daher die Option zur Aufbewahrungsrichtlinie in drei Phasen ein. Dies soll Ihnen genügend Zeit geben, um zu beurteilen und zu bestimmen, welche Richtlinie am besten zu Ihren Geschäftsanforderungen passt. Beachten Sie, dass auch dann, wenn Sie keine benutzerdefinierte Aufbewahrungsrichtlinie konfigurieren, die Standardrichtlinie gilt und alle vorhandenen Prozesselemente, die älter als 120 Tage sind, gelöscht werden.

Phase	Was passiert?
Phase 0	Dies ist eine Informationsphase, in der alle Organisationen über die bevorstehende Richtlinie, ihre Auswirkungen auf Konten, das Funktionsverhalten und den Einführungsmechanismus informiert werden. Am Ende von Phase 0 werden die Benutzeroberfläche und die Funktionen in allen Umgebungen bereitgestellt, aber es wird keine Richtlinie aktiviert.
Phase 1	Dies ist ein Zeitraum von sechs Wochen zwischen der Funktionsbereitstellung und der ersten Richtlinienaktivierung, in dem Sie Ihre Prozesse anpassen und vorbereiten können. Ein Leistungsindikator „Anwendungsinformationen“ zeigt die verbleibenden Tage bis zum Beginn der Aufbewahrungsrichtlinie an, sodass Sie nicht übersehen, Ihr Konto vor dem Live-Datum der Richtlinien vorzubereiten. Zum Ende von Phase 1 werden alle Richtlinien, entweder die Standardrichtlinien oder die von Ihnen konfigurierten, angewendet.
Phase 2	Alle Richtlinien werden aktiv und Ihre Kontodaten werden basierend auf der Richtlinienkonfiguration ausgelagert. Phase 2 hat kein Enddatum. Das bedeutet, dass eine neue Richtlinie sofort angewendet wird, wenn Sie sie konfigurieren.

Auslagerungsmechanismus

Ein Hintergrundauftrag wird täglich zu einer Zeit ausgeführt, zu der Ihr Server nicht ausgelastet ist, und führt die für alle Aufbewahrungsrichtlinien erforderlichen Aktionen durch.

Zu Beginn muss eine große Datenmenge verarbeitet werden. Um Auswirkungen auf die Betriebsleistung zu vermeiden, kann es etwa einen Monat dauern, bis der Auftrag seinen Datenrückstand analysiert hat und auf den Tag genau ist.

Daher gelten die Richtlinien möglicherweise nicht sofort, aber sie werden in etwa einem Monat nachgeholt.

Angenommen, Sie konfigurieren eine Löschrichtlinie von 45 Tagen für einen Prozess. Die Richtlinie wird am Ende von Phase 1 aktiv, aber es dauert etwa einen Monat, bis garantiert ist, dass alle Ihre 45 Tage alten Aufträge verarbeitet werden. Dies ist eine erstmalige Ausnahme, damit der Auftrag den Datenrückstand abarbeiten kann.

Konfigurieren einer benutzerdefinierten Aufbewahrungsrichtlinie

So konfigurieren Sie eine benutzerdefinierte Aufbewahrungsrichtlinie:

1. Navigieren Sie im Orchestrator zum gewünschten Ordner in Ihrem Mandanten.
2. Öffnen Sie die Seite Prozesse.
3. Um einen neuen Prozess hinzuzufügen, klicken Sie auf Prozess hinzufügen. Um einen vorhandenen Prozess zu bearbeiten, klicken Sie für den gewünschten Prozess auf Weitere Aktionen > Bearbeiten.
4. Wählen Sie im Abschnitt Aufbewahrungsrichtlinie das Ergebnis Ihrer Richtlinie aus dem Dropdown-Menü Aktion aus.

   Um Aufträge zu löschen, aber ihre Informationen beizubehalten, lesen Sie die Schritte im Abschnitt Archivieren von Aufträgen.

   Um Aufträge endgültig zu löschen, lesen Sie die Schritte im Abschnitt Aufträge löschen.

Archivierungsaufträge

Wenn Sie Ihre Auftragsdaten nicht verlieren möchten, diese Informationen jedoch aus der Orchestrator-Datenbank auslagern müssen, archivieren Sie Ihre Aufträge.

Voraussetzung: Sie benötigen einen Speicher-Bucket, um Ihre archivierten Aufträge zu speichern.

1. Wählen Sie Archivieren aus dem Dropdown-Menü Aktion aus.
2. Wählen Sie eine Aufbewahrungsdauer aus. Geben Sie einen Wert zwischen 1 und 180 ein. Der Standardwert ist 30.

   Am Ende dieser Dauer werden alle Aufträge mit endgültigem Status (einschließlich Auftragsereignisse und Ausführungsmedien), die in der Zwischenzeit nicht aktualisiert wurden, gelöscht und ihre Informationen in einem Ziel-Bucket gespeichert.

3. Wählen Sie einen Ziel-Bucket aus, um Ihre archivierten Elemente zu speichern.

Um die archivierten Informationen abzurufen, greifen Sie über den zugehörigen Speicher-Bucket auf die Archivdateien zu.

Hinweis:

Hinweis 1: Sie können entweder einen Orchestrator Speicher-Bucket verwenden oder einen externen Speicher-Bucket verknüpfen.

Hinweis 2: Der von Ihnen verwendete Speicher-Bucket darf nicht schreibgeschützt sein, damit der Archivierungsvorgang Elemente hinzufügen kann.

Hinweis 3: Sie können denselben Speicher-Bucket verwenden, um Prozesselemente aus verschiedenen Prozessen zu archivieren.

Hinweis 4: Dieses Feld ist nur für die Option Archivieren verfügbar.

Hinweis 5: Ein erfolgreicher Archivierungsvorgang wird auf der Seite Mandant > Prüfung protokolliert, erkennbar am Aktionstyp Archiv.

Hinweis 6: Wenn ein Fehler den Archivierungsvorgang unterbricht, wird eine Warnung angezeigt, damit Sie den Fehler beheben können.Der Archivierungsvorgang wird bei der nächsten Ausführung der Löschung (am nächsten Kalendertag) wiederholt.Bis die Archivierung erfolgreich wiederholt wurde, können die betroffenen Aufträge nicht angezeigt oder darauf zugegriffen werden.

Löschen von Aufträgen

Wenn Sie feststellen, dass verarbeitete Auftragsdaten nicht mehr nützlich sind, können Sie alle diese Informationen aus Ihrer Orchestrator-Datenbank entfernen.

1. Wählen Sie Löschen aus dem Dropdown-Menü Aktion aus.
2. Wählen Sie eine Aufbewahrungsdauer aus. Geben Sie einen Wert zwischen 1 und 180 ein. Der Standardwert ist 30.

   Am Ende dieser Dauer werden alle Aufträge mit endgültigem Status (einschließlich Auftragsereignisse und Ausführungsmedien), die in der Zwischenzeit nicht aktualisiert wurden, endgültig gelöscht.

Aufträge beibehalten

Wenn Sie verarbeitete Auftragsdaten auf unbestimmte Zeit aufbewahren möchten, wählen Sie Behalten im Dropdown-Menü Aktion aus.

All final state jobs are kept indefinitely in your configured database.

Archivausgabe

Die ZIP-Datei

Wenn Sie Ihre Aufträge archivieren, wird am Ende der Aufbewahrungsdauer eine .zip-Datei mit dem Pfad erstellt:

"Archive/Processes/Process-{process_key}/{archiving_operation_date}-{archiving_operation_timestamp}.zip", wobei Folgendes zutrifft:

• {process_key} – Die eindeutige Kennung des Prozesses, der die Aufträge enthält
• {archiving_operation_date} – das UTC-Datum, an dem das Archiv generiert wurde, im Format yyyy-MM-dd
• {archiving_operation_timestamp} – Die UTC-Zeit, zu der das Archiv generiert wurde, im Format HH-mm-ss-fff
  Beispielsweise könnte eine Archivdatei den Namen Archive/Processes/Process-1d1ad84a-a06c-437e-974d-696ae66e47c2/2022-05-26-03-00-08-496.zip haben.

Die .csv-Datei

Nach dem Extrahieren zeigt die .zip-Datei eine .csv-Datei mit derselben Namenssyntax an:

"Process-{process_key}-{archiving_operation_date}-{archiving_operation_timestamp}.csv".

Die Metadata.json-Datei

Die Datei .json enthält Details zum Containerprozess, damit Sie ihn leichter identifizieren können.

Große Datenmengen

Bei Prozessen, die eine große Anzahl von Aufträgen verarbeitet haben, werden diese in Batches archiviert. In diesem Fall hat die .zip-Datei jedes Stapels einen anderen {archiving-operation-timestamp}, je nachdem, wann das Batch-Archiv erstellt wurde.

APIs für Richtlinien zur Aufbewahrung von Prozessen

Um die Aufbewahrungsrichtlinie in Ihren Client zu integrieren, verwenden Sie die dedizierten Endpunkte der ReleaseRetention-API in Ihrer Swagger-Datei:

• GET /odata/ReleaseRetention – Gibt die Liste aller aktiven Richtlinien zurück, die Informationen wie die Richtlinienaktion, die Aufbewahrungsdauer in Tagen und die ID des Prozesses enthält, für den die Richtlinie gilt.
• GET /odata/ReleaseRetention({key}) – Gibt die Richtlinieninformationen über den angegebenen Prozess zurück.
• PUT /odata/ReleaseRetention({key}) – Aktualisiert die Richtlinieninformationen über den angegebenen Prozess.
• DELETE /odata/ReleaseRetention({key}) – Setzt die angegebene Prozessrichtlinie auf den Standardwert von 30 Tagen Aufbewahrung plus Löschung zurück.

Hinweis: Wenn Sie den DELETE-Endpunkt für Prozesse aufrufen, der vor der Einführung der Aufbewahrungsrichtlinienfunktion erstellt wurde, gilt die integrierte Aufbewahrungsrichtlinie von 30 Tagen plus Löschung.

Ein Beispiel finden Sie in unserem Referenzhandbuch.

Spalten zur Richtlinienverfolgung und Prüfung

Um einfach zu identifizieren, welche Prozesse eine benutzerdefinierte Aufbewahrungsrichtlinie haben, aktivieren Sie die Spalten Aufbewahrungsaktion und Aufbewahrung (Tage) auf der Seite Prozesse, indem Sie die entsprechenden Kontrollkästchen in der Dropdownliste Spalten auswählen.

Die Spalte Aufbewahrungsaktion zeigt das Richtlinienergebnis an, während die Spalte Aufbewahrung (Tage) die verbleibende Zeit bis zur Anwendung der Richtlinie anzeigt.

Wie bereits erwähnt, gilt eine 30-tägige Aufbewahrungsrichtlinie für neu erstellte Prozesse. Sie können sich jedoch nicht immer auf diesen Wert verlassen, um die Prozesse zu identifizieren, die über eine Standardrichtlinie verfügen. Wenn Sie beispielsweise eine benutzerdefinierte Aufbewahrungsdauer von 55 Tagen festlegen und diese später auf 30 Tage aktualisieren, ist die resultierende Richtlinie nicht die Standardrichtlinie. Ob diese Szenarien Standardrichtlinien darstellen oder nicht, können Sie auf der Seite Prüfung nachlesen.

Immer wenn der Hintergrundauftrag Bereinigungsaktionen im Zusammenhang mit der Aufbewahrungsrichtlinie ausführt (Archivieren + Löschen oder nur Löschen), wird im Auftrag des Administrators ein entsprechender Eintrag in der Prüfung erstellt.

1 steht für den Aktionstyp Archivieren. 0 steht für den Aktionstyp Löschen.