INHALTSVERZEICHNIS

• Einleitung
• Clearing Plattform
• DIM - Digital Identity Management
  • Benutzer
  • Benutzerrollen
• DIM Anmeldung als Administrator
• Anlegen einer Organisation
• Erfassen der Clearingdaten
• Zugriff über die Schnittstelle (API)

Einleitung

DIM steht für Digital Identity Management und ist ein Dienst der relevante Informationen für die Kommunikation zwischen Carriern bereitstellt. 

Derzeit beschränkt sich diese Information auf die Clearingplattform. Weitere Bereiche sind in Planung. 

Clearing Plattform

Auf der Clearingplattform können registrierte Carrier Clearingfälle erstellen.  

Manche Carrier unterstützen dabei anfangs noch nicht alle Clearingfälle (auch Szenarien genannt). Für diese Szenarien soll weiterhin der E-Mail Kanal genutzt werden. Erst mit dem Ende dieser sogenannten Ramp-Up Phase sollen dann schließlich alle Szenarien von allen registrierten Carriern unterstützt werden.

Grundsätzlich können auch Szenarien dauerhaft blockiert, d.h. weder auf der Plattform noch per E-Mail unterstützt, werden.  

Die Information über die Unterstützung von Szenarien auf der Clearingplattform ist nicht Teil der Clearingspezifikation. 

Sie wird daher im Digital Identity Management verwaltet. 

Die Clearing Plattform berücksichtigt jedoch diese Information:

• im Webgui der Clearingplattform werden für einen Empfänger nur Szenarien angeboten, die er laut DIM auch unterstützt
• die Schnittstelle (API) der Clearingplattform nimmt grundsätzlich alle Tickets an, also auch solche, die  laut DIM vom Empfänger nicht unterstützt sind.
  Diese Tickets werden anschließend automatisch "erledigt", mit dem Hinweis "nicht erfolgreich" und einem erklärenden Text, der auf diesen Umstand detailliert hinweist.

DIM - Digital Identity Management

Das Digital Identity Management läuft jeweils parallel zu der entsprechenden Clearingplattform und wird über die Subdomain dim wie folgt andressiert:

• für das Testsystem: https://dim.clearing-service-test.de
• für das Produktivsystem (demnächst): https://dim.clearing-service.de

Benutzer

Das DIM kann von allen Benutzern genutzt werden, die einen Benutzer auf der jeweiligen Clearingplattform besitzen. 

Die Anmeldung erfolgt mit diesem Benutzer und dem bekannten Passwort.

Benutzerrollen

Unterscheidung zwischen folgenden Benutzerrollen:

• Alle Benutzer - Administratoren, Agenten und Manager - dürfen die Informationen von allen in DIM registrierten Carriern auswerten. Für diese Nutzung existiert eine eigenes "DIM" Handbuch für Agenten.
• Nur ein Administrator darf die Daten der eigenen Organisation anlegen und ändern.

DIM Anmeldung als Administrator

Nach dem Einloggen wird auch für den Administrator zunächst das Dashboard angezeigt. 

Hier können Informationen von allen in DIM registrierten Carriern ausgewertet werden. 

Dieses Dashboard unterscheidet sich für den Administrator lediglich durch den Bereich "Nachrichten".  

Für eine ausführliche Dokumentation des Dashboards nutzen Sie bitte das "DIM" Handbuch für Agenten.

Anlegen einer Organisation

Die Daten der eigenen Organisation werden nach Auswahl von "Meine Organisation" erfasst.

Bei erstmaliger Auswahl erscheint ein Hinweis: 

Die Organisation ist jetzt in DIM angelegt. Es existieren allerdings noch keine Daten zum Bereich Clearing. 

Zunächst sollten die Allgemeinen Daten wie Name der Organisation, Kontaktdaten und Adresse ergänzt und gespeichert werden:

Hinweis: Dieser Punkt kann auch übersprungen werden.

Erfassen der Clearingdaten

Die Clearingdaten der eigenen Organisation werden erfasst nach Auswahl von "Clearing anlegen".

Bei erstmaliger Auswahl erscheint ein Hinweis:

Jetzt muss entschieden werden, welche Szenarien die eigene Organisation über die Clearingplattform unterstützt.

Zur Auswahl stehen 3 Optionen: 

Sollten Sie bereits auf der Clearingplattform aktiv sein, so sollten Sie zunächst die Option alle Szenarien wählen und speichern. Ansonsten können nach dem Speichern keine Tickets mehr an Sie gesendet werden.

Beachten Sie auch die Meldung: 

Hinweis: Die Option alle Szenarien erlaubt im Tab Szenarien die Angabe von Szenarien, die grundsätzlich blockiert werden sollen, also nicht einmal per E-Mail eingereicht werden dürfen. 

Anschließend nehmen Sie bei Bedarf durch die Auswahl der Option selektiv die genaue Spezifizierung der unterstützen Szenarien vor.

Hier ergänzen Sie zunächst im Tab Eingangstore mindestens den Namen und die E-Mail Adresse unter Haupt-Eingangstor. Sie können auch weitere Eingangstore erfassen, deren Verwendung gleich beschrieben wird. 

Hinweis: Sofern vorhanden, können Sie hier auch Ihren Public Key für die S/MIME Verschlüsselung eintragen, für den Fall, dass Sie die E-Mail für Clearing bereits verschlüsselt erwarten.  

Nach dem Wechsel zum Tab Szenarien legen Sie fest, welche Szenarien über die Clearing Plattform unterstützt werden. 

Initial sind alle Szenarien in der Kategorie "per E-Mail oder nicht unterstützt" eingeordnet.   

Die 4 Buttons in der Mitte erlauben jetzt folgende Aktionen (von oben nach unten):

• Alle Hauptszenarien in die Kategorie "per Clearing Plattform" verschieben
• das ausgewählte Hauptszenario in die Kategorie "per Clearing Plattform" verschieben
• das ausgewählte Hauptszenario in die Kategorie "per E-Mail oder nicht unterstützt" verschieben
• Alle Hauptszenarien in die Kategorie "per E-Mail oder nicht unterstützt" verschieben

Die beiden letzten Aktionen machen selbstverständlich erst Sinn, wenn bereits Szenarien in die Kategorie "per Clearing Plattform" verschoben wurden. 

Hinweis: Die "Einzeloperationen" können alternativ auch per "Drag&Drop" bzw. durch Doppelklick ausgeführt werden.

Sollte die Auswahl auf der Ebene von Hauptszenarien nicht genügen, dann kann jedes Hauptszenario aufgeklappt und anschließend entsprechend auf der Ebene der Unterszenarien selektiert werden. 

Alle Szenarien, die sich in der Kategorie "per E-Mail oder nicht unterstützt" befinden, werden automatisch mit der E-Mail-Adresse des Haupt-Eingangstors verknüpft. Dies wird in der Liste durch Wiederholung dieser E-Mail-Adresse mit dem Zusatz "(default)" ebenfalls dargestellt. 

 Zur Illustration der verschiedenen Alternativen legen wir im Tab Eingangstore ein weiteres Eingangstor an: 

In der Liste der Szenarien der Kategorie "per E-Mail oder nicht unterstützt" kann jetzt jeder Eintrag individuell angepasst werden. In diesem Beispiel besteht die Auswahl aus 

• dem Haupt-Eingangstor
• dem 2. Eingangstor
• der Option "nicht unterstützt", was dem vollständigen Blockieren dieses Szenarios entspricht

Die Unterszenarien "erben" automatisch die Auswahl im Hauptszenario, können aber individuell angepasst werden: 

Das Papierkorbsymbol   zeigt die individuelle Einstellung an und erlaubt das Zurücksetzen auf den "Default".

Nach dem Speichern kann im Dashboard durch Selektion der eigenen Organisation das Ergebnis überprüft werden:

Zugriff über die Schnittstelle (API)

Die URL für den Zugriff über die Schnittstelle (API) entspricht der URL für das GUI, allerdings mit der Subdomain dimapi:

• für das Testsystem: https://dimapi.clearing-service-test.de
• für das Produktivsystem (demnächst): https://dimapi.clearing-service.de

Im Browser öffnet sich das sogenannte "Swagger UI" und erlaubt den interaktiven Aufruf der API-Methoden.

Über den markierten Link (v3/api-docs) kann die Beschreibung der Schnittstelle im JSON-Format angezeigt und heruntergeladen werden. 

Authentifizierung 

Für die Authentifizierung gelten derzeit exakt die gleichen Regeln wie für die Cleasin