Skip to content

[Epic] Attachments - Ergonomie

Ziel

Für die Nutzer von FIT-Connect soll der Umgang mit Attachments vereinfacht werden. Fokus in diesem Epic liegt auf Umgang mit UUIDs und der frühzeitigen Transparenz zu der Größe der ausgetauschten Anhänge.

Why

Die Vergabe von UUIDs der Anhänge in Anträgen führt zur Verwirrung bei einigen Nutzern. Die Vergabe von identischen UUIDs bei demselben Anhang in mehreren Anträgen verursacht eine nicht verständliche Fehlermeldung bei den Onlinediensten. Das Anhängen von derselben Datei bei unterschiedlichen Anträgen soll dem Nutzer mit der Unterteilung in interne und externe UUIDs ermöglicht werden.

Die Größe der Dateien sollen vor dem Upload angegeben werden und auch für die Empfänger vor dem Abholen einsehbar sein. In den SDKs soll es die optionale Möglichkeit geben Anhänge einzeln abzurufen. Validierung der Submission bleibt weiterhin erst dann möglich, wenn vorab alle Anhänge validiert wurden.

Links, Notes, Remarks

Stories

  1. Interne und externe UUIDs bei den Anhängen: #1134 (closed)
    • Konzept zum Einsatz von internen und externen UUIDs bei den Anhängen #1344
  2. Angabe der Attachmentgröße in den Metadaten(ggf. API) und Grenzen im Zustelldienst konfigurieren [TEAM ZSD & TEAM SDK]
  3. Option zum Abruf einzelner Anhänge in den SDKs – Java SDK [TEAM SDK]
  4. Option zum Abruf einzelner Anhänge in den SDKs – .NET SDK [TEAM SDK]

Acceptance criteria

  1. Die Nutzer sind bei der Vergabe der UUIDs der Attachments nicht unnötig eingeschränkt
  2. Die Größe der Anhänge ist vor dem Abruf abfragbar und auch in den SDKs können Anhänge einzeln abgerufen werden

Implementation plan (to be completed by the developer)

offene Fragen

Beantwortete und eingearbeitete Fragen
  • Unterscheidung in interne und externe UUID sinnvoll
    • Idee: Wir unterscheiden in Transport-IDs(bisherige attachmentID) und Referenz-IDs (optional) - Benennung prüfen (ggf. Attachment-ID und File-ID) - siehe auch https://git.fitko.de/fit-connect/arch/-/blob/ideas/andreas-huber/72-1134-transport-ids/backlog/ideas/transport-ids/transport-ids.adoc
    • Navo sendet zum Beispiel mit einer UUID einen Anhang in zwei Anträgen - Dieses Problem werden auch andere Online-Dienste haben
    • wir wollen es angehen, weil es ansonsten dazu führt, dass es jedes Onlinediest angeht und "Individualabsprachen" erfolgen, was nicht im Sinne der Nachnutzung wäre
    • TODO: Konzept mit Benennung und Abgrenzung noch im ersten Schritt einzuplanen
    • TODO: vom Support einholen wer diesen Bedarf alles hat
    • ggf. sollten wir es erst umsetzen, sobald wir das Konzept für große Dateien final haben
Neue Fragen
Edited by Andreas Huber