SSP: Hilfekomponente aus Doku zur Hilfestellung in React

Why

  • Ein Absprung aus dem SSP kann verwirrend sein, daher soll die Hilfe direkt dort angezeigt werden wo sie benötigt wird - heißt im SSP Formular.
  • Dies muss sowohl bei der Client-Anlegung als auch bei der Zustellpunkt-Anlegung sein.
  • Hierbei sollten alle Überkapitel zu einem Eintragungsfeld mit einer Informationsnachricht der Dokumentation versehen sein.
  • Idee ist den jeweiligen Ausschnitt aus der Dokumentation anzuzeigen anstatt einen Absprung zu haben.
  • Optional (Nach Möglichkeit von Unterteilung in Sender und Subscriber Übersicht): Bei der Darstellung des Dokumentationsausschnittes sollte eine Anpassung stattfinden, ob es ein Sender oder Empfänger ist. --> Muss bei den unten dargestellten Punkten nicht bedacht werden. Sollte bei Umsetzung trotzdem überprüft werden, sodass es noch dem aktuellen Stand entspricht.

Clients:

  • Allgemeine Information bei Clients
  • Unter Empfänger-Client die Information zur Destination Management API

Zustellpunkt:

  • Status
  • Callback
  • Kontaktdaten
  • Antwortkanäle
  • Metadatenschema
  • Sicherheit
  • Leika
  • ARS
  • Fachdatenschema

Offene Fragen:

  • Wie wird es geholt: Markdown-File auslesen oder Ankerpunkte auslesen? --> Ankerpunkte werden ausgelesen
  • Gibt es Instanzen die einen Abruf aus dem SSP verhindern? -> siehe Kommentar unten.

Links, Notes, Remarks

Acceptance criteria

  1. Technische Machbarkeitsprüfung der verschiedenen Technologien (iFrame, Mbad-Tag, Ajax)
  2. Dokutext wird jeweils in einem kleinen Widget angezeigt, sodass der Dokuschnipsel direkt umgesetzt werden kann im SSP
  3. Ein Link für die Doku wird nur hinterlegt, wenn der Dokuschnipsel nicht aussagekräftig genug ist
  4. ...

Implementation plan (to be completed by the developer)

Edited by Mark Kane