Dokumentation für Revision Info

Revision Info Manager

Der Revision Info Manager ist eine eigenständige Anwendung, mit der alle Änderungen am B2B-Customizing protokolliert werden können. Es wird z.B. protokolliert, welcher Benutzer eine Extension oder Action angelegt, geändert oder gelöscht hat und wann die Änderungen vorgenommen werden. Diese Änderungen werden in einer Datenbanktabelle gespeichert und können über die Oberfläche des Revision Info Manager angezeigt, gefiltert und gesucht werden.

Rollen

Rolle Beschreibung
RevisionManager-Read Obligatorische Rolle

Übersicht

  • Nachdem die Seite geladen ist, werden die Revisionsinformationen abgerufen und in der Tabelle angezeigt.
  • Die Revisionsinfo ist paginiert.

Abbildung 1.1

Tabellenspalten

Spalte Beschreibung
Datum/Zeit Datum und Zeit der Änderung
Revision Executor Ausführender der Customizingänderung
1. Alt wenn ein Mensch die Änderung durchgeführt hat
2. Alt wenn die Änderung automatisch ausgeführt wurde
B2B-User Benutzer, der die Änderungen vorgenommen hat
Typ Art der Customizingänderung
Operation Art der Aktion
Revision ID ID der Customizing-Eigenschaften
Revision Name Name der Customizing-Eigenschaften

Filter

  • Benutzer können die Revisionsinformationen nach vorgegebenen Feldern filtern
  • Die gefilterten Revisionsinformationen werden abgerufen und in der Tabelle angezeigt

Abbildung 1.2

Mögliche Filter

Filter Typ Kommentar Pflichtfeld Beispiel
Zeitraum Date-Picker Spezifischer Da-tumsbereich für die Revisionsinfo. Der Datumsbereich ist standardmäßig auf heute eingestellt. Ja 01.10.2020 00:00 - 17.10.2020 23:59
Benutzer Dropdown-Menu Benutzer, der die Änderungen vorgenommen hat. Dieses Feld akzeptiert freien Text. Nein admin
Typ Dropdown-Menu Typ der Änderungen. Nein ACCOUNT, ACTION, CHANNEL, EXTENSION, GLOBAL_PROPERTY, etc.
Operation Dropdown-Menu Art der Änderung Nein SAVE, UPDATE, REMOVE, REMOVE_ALL, UNKNOWN, DUPLICATE

Text-Suche

Benutzer kann eine Schnellsuche in der Tabelle durchführen, indem er Text in das Textfeld eingibt.

Abbildung 1.3

Revision Info Details

  • Der Benutzer kann die Details einsehen, indem er eine der Revisionsinformationen auswählt
  • Die linke Seite zeigt die Details vor den Änderungen
  • Die rechte Seite zeigt die Details nach den Änderungen

Abbildung 1.4

E-Mail-Benachrichtigungen

Im RevisionManager können E-Mail-Benachrichtigungen für neue Revision-Einträge aktiviert werden. Dabei wird ein CronJob eingeplant, der regelmäßig läuft und auf neue Revision-Einträge für den konfigurierten Filter prüft. Sind neue Einträge seit dem letzten Job-Lauf (oder Aktivierung des Jobs) vorhanden, so wird eine E-Mail-Benachrichtigung an die hinterlegten Empfänger verschickt.

Die Konfiguration erfolgt über die application.yml

notification-schedule:
  jobInterval: "0 */1 * * *"
  revisionFilters:
    - type: EXTENSION
      name: EXT_CHANNEL_DIST
    - type: ACTION_$PROPERTY
      name: B3P_USED_SERVICE_ID
    - type: GLOBAL_PROPERTY
      name: VERSION_INFO_NODE_1
  recipients: >
    test@mail.com,
    test2@mail.com
  subject: Es wurde eine Änderung vorgenommen
Eigenschaft Beschreibung
jobInterval Cron-Ausdruck, wann und wie oft der Job ausgeführt wird
revisionFilters Liste von Elementen, für die Benachrichtigung bei Änderungen verschickt werden sollen.
Der type gibt den Revision-Typ an (EXTENSION, CHANNEL, GLOBAL_PROPERTY, …). Der name gibt den Namen der Extension, des Channel, … an
recipients Liste der E-Mail-Empfänger
subject E-Mail-Betreff

Weiterhin müssen die Verbindungsdaten zum Mail-Server konfiguriert werden.

mail:
  host: localhost
  port: 25
  username: test@mail.com
  password: password!
  properties:
    mail:
      smtp:
        auth: true
        starttls:
          enable: true

AMQP Event Verarbeitung

Im RevisionManager können AMQP Events (z.B. Erstellen eines CSRs für AS4-Zertifikate) als neue Revision-Einträge gespeichert werden. Dabei wird ein Message-Broker benutzt, um die Events vom AS4-System an den Revision-Manager zu übertragen.

Die Konfiguration erfolgt über application.properties. Events werden aus der Queue aep.revision.default konsumiert.

spring.profiles.active=rabbitmq

#=== Rabbitmq Configuration ===#
rabbitmq.host=rabbitmq3
rabbitmq.port=5672
rabbitmq.username=guest
rabbitmq.password=${RABBITMQ_PASSWORD}

#=== Queues Configuration ===#
b2bRevisionInExchangeName=aep.revision
b2bRevisionInGroup=default
b2bRevisionMaxConcurrency=50
b2bRevisionInConsumerType=topic

Die zugehörigen Exchanges müssen per Binding an die Queue angebunden werden. Eine Auflistung der betroffenen Exchanges finden Sie in der [AS4-Revision-Doku]J(https://b2bbp.next-level-help.org/as4_hu_audit.html).

View Me   Edit Me