Dokumentation für B2B MPID-Editor

Beschreibung des MPID-Editor-Moduls

Der MPID-Editor zeigt alle Marktpartnerbeziehungen und Kontaktinformationen, die in einer speziellen Erweiterung gespeichert sind. Der Editor kann verwendet werden, um neue MPID-Einträge zu erstellen, bestehende Einträge zu löschen und die Gültigkeit bestehender Einträge anzupassen.

Abbildung 1.1: MPID Editor

Marktpartnersuche & CRUD

Marktpartner-Suche

Standardmäßig werden alle vorhandenen Einträge angezeigt.

Abbildung 2.1: Aufzeichnungen der Marktpartner

Marktpartner Suche nach Text

Geben Sie die MPID’s, den Partnernamen, die SA-ID oder die E-Mail-Adresse ein und klicken Sie auf “Suchen” . Alle Datensätze werden mit den in Abbildung 2.2 dargestellten Suchkriterien abgeglichen.

Abbildung 2.2: Suche nach Text

Marktpartner Suche nach Gültigkeit

Die Gültigkeit eines Eintrages im MPID Editor kann nach dem Status Alle, Aktiv oder Inaktiv gefiltert werden, wie in Abbildung 2.3 dargestellt. Die Gültigkeit (aktiv, inaktiv) bezieht sich auf die Zeitscheibe eines Marktpartners.

Abbildung 2.3: Gültigkeit
Abbildung 2.4: Alle Marktpartner-Datensätze mit aktivem Status
Abbildung 2.5: Alle Marktpartner-Datensätze mit dem Status Inaktiv

Marktpartner CRUD

Marktpartner erstellen

Wenn Sie auf die Schaltfläche klicken, öffnet sich ein Dialog zur Eingabe der notwendigen Informationen, wie in Abbildung 2.6 dargestellt. Nachdem Sie die Pflichtfelder eingegeben haben, wird die Schaltfläche aktiviert. Klicken Sie einfach auf , dann wird ein neuer Marktpartner-Datensatz erstellt, wie in Abbildung 2.7 dargestellt.

Abbildung 2.6: Anlegen eines neuen Marktpartners
Abbildung 2.7: Ein Datensatz wird nach dem Speichern erstellt

Marktpartner Aktualisieren/Bearbeiten

Klicken Sie auf die Schaltfläche , um die Daten wie in Abbildung 2.8 dargestellt zu ändern.

Abbildung 2.8: Schaltfläche Bearbeiten

Wenn Sie auf die Schaltfläche klicken, erscheint ein Dialog, in dem Sie Name, Dienstanbieter-ID, E-Mail, Von-Datum, Bis-Datum und Kommunikationsanforderungen wie in Abbildung 2.9 dargestellt ändern können.

Abbildung 2.9: Marktpartner-Datensatz bearbeiten

Klicken Sie auf die Schaltfläche Der Datensatz aktualisiert die neuen Informationen, die sich gerade geändert haben, wie in Abbildung 2.10 dargestellt.

Abbildung 2.10: Marktpartner-Datensatz nach dem Speichern bearbeiten

Marktpartner löschen

Der Löschen Button ist immer deaktiviert, wenn kein Datensatz markiert ist, wie in Abbildung 2.11 gezeigt.

Abbildung 2.11: Deaktivierter Löschen Button

Sobald Sie einen Eintrag markieren wird der Löschen Button aktiv

Abbildung 2.12: Schaltfläche "Löschen" aktivieren

Klicken Sie auf den Löschen Button , es öffnet sich ein Dialog in dem Sie bestätigen müssen, ob Sie diesen Datensatz löschen möchten (siehe Abbildung 2.13).

Abbildung 2.13: Dialog zum Bestätigen des Löschvorgangs

Klicken Sie einfach , wenn Sie diesen Datensatz nicht löschen möchten. Klicken Sie wenn dieser Datensatz endgültig gelöscht werden soll. Der Datensatz wird nicht mehr auf dem Bildschirm angezeigt, nachdem der Datensatz gelöscht wurde, wie in Abbildung 2.14 dargestellt.

Abbildung 2.14: Der Datensatz mit der E-Mail nguyenminh-test wurde gelöscht

Marktpartner Detailansicht

Kontaktdaten

Kontakt-Liste

In Abbildung 3.1. wird die Kontaktliste angezeigt

Abbildung 3.1: Kontakte

Kontakte als inaktiv markieren

Klicken Sie einfach auf die Schaltfläche wie in Abbildung 3.2 dargestellt. Der Datensatz wechselt dann in den inaktiven Status wie in Abbildung 3.3 zu sehen ist.

Abbildung 3.2: Aktive Schaltfläche
Abbildung 3.3: Schaltfläche inaktiv

Kontakt als aktiv markieren

Wenn Sie auf die Schaltfläche klicken , wie in Abbildung 3.4 dargestellt, wird der markierte Kontakt aktiv gesetzt. Mit einem weiteren Klick auf wird der Kontakt wieder als inaktiv markiert, wie in Abbildung 3.5 dargestellt.

Abbildung 3.4: Inaktiven Kontakt aktivieren
Abbildung 3.5: Aktiven Kontakt inaktivieren

Wenn der Button für einen Kontakt verwendet wird, der keine Daten für das Von-Datum und das Bis-Datum enthält, wird ein Fehler “Bitte geben Sie eine gültige Zeitscheibe nach 1970 ein” angezeigt, wie in Abbildung 3.6 dargestellt.

Abbildung 3.6: Keine gültige Zeitscheibe

Es können keine Kontakte mit gleicher Kontaktklasse und überlappenden Zeitscheiben gleichzeitig aktiv gesetzt werden. In diesem Fall wird ein Fehler erzeugt, wie in Abbildung 3.7 dargestellt

Abbildung 3.7: Überlappung der Zeitscheiben

Kontakt anlegen

Klicken Sie auf die Schaltfläche. Es erscheint ein Dialog zum Eingeben von Kontaktinformationen, wie in Abbildung 3.8 dargestellt. Sie können Kontaktklassen wie in Abbildung 3.9 auswählen und weitere Informationen eingeben

Abbildung 3.8: Kontakt hinzufügen
Abbildung 3.9: Kontaktklasse auswählen

Im folgenden Datensatz ist das Kontrollkästchen “Aktiv” deaktiviert. Sie können so viele deaktivierte Datensätze erstellen wie sie möchten, sogar mit gleichen Kontaktklassen oder ohne Zeitscheiben oder Zeitscheibenüberlappungen. Mit einen Klick auf den Button wird der Eintrag angelegt wird wie in Abbildung 3.11 zu sehen ist.

Abbildung 3.10: Inaktiven Kontakt anlegen
Abbildung 3.11: Inaktiver Kontakt wird erstellt

Wenn Sie einen aktiven Kontakt erstellen möchten, muss die “Aktiv” Checkbox markiert sein. Es wird jeweils ein Fehler angezeigt, wenn die Kontaktklasse mit einem bereits vorhandenen aktiven Kontakt übereinstimmt und eine ungültige Zeitscheibe, wie in Abbildung 3.12 und Abbildung 3.13 besitzt, oder eine Zeitscheibe überlappt, wie in Abbildung 3.14 und Abbildung 3.15 dargestellt.

Abbildung 3.12: Keine gültige Zeitscheibe für aktiven Kontakt
Abbildung 3.13: Fehlerwarnung, keine gültige Zeitscheibe beim Erstellen eines aktiven Kontakts
Abbildung 3.14: Überlappung der Zeitscheiben bei aktivem Kontakt
Abbildung 3.15: Fehlerwarnung, Zeitscheibe überlappt sich beim Erstellen eines aktiven Kontakts

Kontakt Aktualisieren/Bearbeiten

Klicken Sie auf die Schaltfläche wie in Abbildung 3.16, um die Daten eines Kontaktes zu ändern

Abbildung 3.16: Schaltfläche Kontakt bearbeiten

Wenn ein aktiver Kontakt bearbeitet wird, erscheint ein Fehler, wenn die Kontaktklasse mit einem aktiven Kontakt übereinstimmt und eine ungültige Zeitscheibe, wie in Abbildung 3.17 gezeigt, besitzt. Ebenfalls zu einen Fehler kommt es bei einer Überlappung der Zeitscheiben, wie in Abbildung 3.18 und Abbildung 3.19 gezeigt.

Abbildung 3.17: Kontakt bearbeiten
Abbildung 3.18: Überlappung von Zeitscheiben für den aktiven Kontakt
Abbildung 3.19: Fehlerwarnung, Zeitscheibe überlappt sich beim Bearbeiten eines aktiven Kontakts

Kontakt löschen

Klicken Sie auf , um einen Kontakt zu löschen. Das System erlaubt immer nur das löschen eines einzelnen Kontaktes gleichzeitig. Ein Bestätigungsdialog wird eingeblendet. Klicken Sie auf um das Löschen dieses Kontakts abzubrechen. Klicken Sie auf um den Kontakt endgültig zu löschen, wie in Abbildung 3.20 und Abbildung 3.21 dargestellt.

Abbildung 3.20: Löschen eines Kontakts in der Kontaktliste
Abbildung 3.21: Löschergebnis - Kein Kontakt mehr hat E-Mail nguyentest in der Kontaktliste

Dokumente

Dokument Liste

Für jeden Eintrag im MPID Editor können diverse Dokumente hochgeladen werden, wie in Abbildung 3.22. Zu sehen ist.

Abbildung 3.22: Eine Liste von Dokumenten

Dokument hinzufügen

Abbildung 3.23 zeigt den Dialog zum Hinzufügen eines neuen Dokuments. Es muss ein Typ ausgewählt werden (Abbildung 3.24) und ein Dokument. Klicken Sie dann auf , um dieses Dokument zu speichern (Abbildung 3.25 ist das Ergebnis) oder klicken Sie auf , um die Speicherung dieses Dokuments abzubrechen.

Abbildung 3.23: Dialog zum Hinzufügen eines neuen Dokuments
Abbildung 3.24: Eine Liste von Dokumenttypen
Abbildung 3.25: Ergebnis Hinzufügen eines neuen Dokuments

Dokument herunterladen

Abbildung 3.26 zeigt, wie ein Dokument heruntergeladen wird

Abbildung 3.26: Dokument herunterladen

Dokument löschen

Um ein Dokument zu löschen klicken Sie auf , ein Dialog wird geöffnet, um zu bestätigen, ob Sie dieses Dokument löschen möchten, wie in Abbildung 3.27 gezeigt. Klicken Sie weiterhin auf um das Dokument aus der Dokumentenliste zu entfernen oder um diese Aktion abzubrechen

Abbildung 3.27: Löschen eines Dokuments
Abbildung 3.28: Ergebnis nach dem Löschen eines Dokuments

Geplante Jobs “Jetzt ausführen”.

Klicken Sie auf den Button um den konfigurieren Job sofort im Hintergrund auszuführen (siehe Abbildung 4.1). Mit dieser Schaltfläche können geplante Jobs, die einem bestimmten Schlüssel, z.B. einem Benutzernamen oder einer Mandanten-ID in einer Extension (MPID_EDITOR_SHEDULED_JOBS) zugeordnet sind, sofort gestartet werden. Es können auch mehrere Service-IDs angegeben werden (Komma-getrennt).

  • MPID_EDITOR_SHEDULED_JOBS
    • <Schlüssel1>=<DienstId1>,<DienstId2>
    • <Schlüssel2>=<DienstId1>,<DienstId3>
Abbildung 4.1: Geplanter Job "Jetzt ausführen”

Somit können Benutzer die für ihre Rolle relevante Marktpartner-Synchronisation manuell starten.

1:1 Adresswechsel

Die Schaltfläche ist standardmäßig deaktiviert, wie in Abbildung 5.1 zu sehen ist.

Abbildung 5.1: Deaktivierter Button für 1:1 Adresswechsel

Die Schaltfläche wird aktiviert, wenn Sie auf eine beliebige Marktpartnerzeile klicken, wie in Abbildung 5.2 dargestellt

Abbildung 5.2: Schaltfläche 1:1 Adresswechsel

Klicken Sie auf die Schaltfläche , ein neuer Bildschirm öffnet sich, um die E-Mail-Adressen der Marktparnter zu aktualisieren. Geben Sie die Pflichtfelder wie E-Mail-Adresse und Gültig ab-Datum für den 1:1 Adresswechsel ein, wie in Abbildung 5.3 oder Abbildung 5.4 dargestellt

Abbildung 5.3: E-Mail ohne Zeitscheibenanpassung ändern
Abbildung 5.4: E-Mail mit Zeitscheibenanpassung ändern

Klicken Sie auf die Schaltfläche diese Änderung abzubrechen und klicken Sie auf um die E-Mail und das Gültig ab-Datum für den Marktpartner zu aktualisieren, wie in Abbildung 5.5

Abbildung 5.5: Änderungs-E-Mail mit Ergebnis der Zeitscheibenanpassung

CSV-Export

Um CSV-Dateien für Marktpartner oder Kontaktdaten zu exportieren, klicken Sie auf . Es wird ein Dialog geöffnet, in dem Sie wählen können, welche Daten Sie exportieren möchten. Klicken Sie anschließend auf den Exportieren Button um den Export auszuführen.

Abbildung 6.1: Export Marktkommunikationsdaten
Abbildung 6.2: Export Marktkommunikationsdaten CSV Datei

Beim Export von Kontaktklassen muss zunächst die gewünschte Kontaktklasse ausgewählt werden, Abbildung 6.3

Abbildung 6.3: Eine Liste von Kontakttypen
Abbildung 6.4: Kontaktdaten exportieren
Abbildung 6.5: Ergebnis des Exports von Kontaktdaten

Administation

Benutzer ohne Lese- und Schreibberechtigung

Benutzer, die nicht die Rolle B2B-MpidEditor-Read und B2B-MpidEditor-Write haben, wie in Abbildung 7.1 dargestellt, können das MPID Editor Modul nicht sehen, wie in Abbildung 7.2 dargestellt.

Abbildung 7.1: Benutzer ohne Lese- und Schreibrolle in keycloak
Abbildung 7.2: Mpid-Editor ist nicht sichtbar

Benutzer mit Lese-Rolle

Benutzer, die, wie in Abbildung 7.3 dargestellt, die Rolle B2B-MpidEditor-Read haben, sehen den Mpid Editor, wie in Abbildung 7.4 dargestellt

Abbildung 7.3: Benutzer mit Lese-Rolle in keycloak
Abbildung 7.4: Mpid-Editor ist sichtbar

Benutzer mit Schreibrolle

Benutzer ohne Lese-Rolle

Benutzer, die nicht die Rolle B2B-MpidEditor-Read dafür aber die Rolle B2B-MpidEditor-Write haben, wie in Abbildung 7.5 dargestellt, sind im Frontend nutzlos, da das MPID Editor Modul nicht sichtbar ist

Abbildung 7.5:Benutzer hat eine Schreibrolle aber keine ohne Lese-Rolle in keycloak

Benutzer mit Lese und Schreib-Rolle

Benutzer, die die Role B2B-MpidEditor-Read und die B2B-MpidEditor-Write haben, wie in Abbildung 7.6 dargestellt, können Daten wie Hinzufügen, Bearbeiten, Löschen usw. ändern, wie in Abbildung 7.7 dargestellt

Abbildung 7.6: Benutzer hat eine Schreib- und eine Lese-Rolle in keycloak
Abbildung 7.7: Der MPID Editor ist sichtbar und Daten können geändert werden.
View Me   Edit Me