In dieser Dokumentation wird die Verifizierung und Übertragung von Tagesabschlussdokumenten (End-of-Day Document) beschrieben. Diese Funktion wird derzeit nur für Deutschland unterstützt.
Überblick
Der Cloud-Sync-Prozess gewährleistet die sichere Speicherung Ihrer Tagesabschlussdokumente in unserer Cloud und führt die folgenden Aufgaben aus:
- Prüfung, ob alle erforderlichen EOD-Dateien (generisches EOD-Dokument sowie deutschlandspezifisches TAR-Archiv) im Cloud-Speicher vorhanden sind
- Übertragung fehlender Dateien vom lokalen Client in die Cloud.
Voraussetzungen
- Organisationsberechtigung: Für das erneute Senden von Daten muss sie aktiviert sein. Die Aktivierung muss über den Support erfolgen.
- Fiskalland: Derzeit nur für Deutschland verfügbar.
- Konfiguration: Die lokalen Dateispeicher- und Cloud-Speicher-Pfade müssen im RetailForce-Portal konfiguriert werden.
Portal-Konfiguration
- Anmeldung im RetailForce Portal.
- Navigation zu Configuration → Entsprechende Configuration
- File storage
- auf + Storage path klicken.
- Das Feld Storage path bleibt leer und erfordert keine Eingabe.
- Cloud storage
- auf + Storage path klicken.
- Auch hier ist das Feld Storage path zunächst leer.
- Änderungen speichern.
Client-Workflow
Nach der Generierung und Buchung eines transaktionsbasierten EOD auf dem Client sind die folgenden API-Aufrufe in der angegebenen Reihenfolge erforderlich:
- Konfiguration aktualisieren
POST/api/v1/management/clients/byCloud/{clientId}
Aktualisiert die Konfiguration und gewährleistet, dass die Middleware die aktuellen File- und Cloud-Speicherpfade verwendet. - CloudConnect
POST/api/v1/management/cloud/connect
Etabliert eine Verbindung zum Cloud. - Tagesabschluss erstellen
GET/api/v1/closing/{clientId}/endofdayDocument
Erstellt das lokale EoD-Dokument. - Tagesabschluss buchen
POST/api/v1/transactions/storeDocument
Bucht das erstellte EoD-Dokument. Sync-Anforderung prüfen
GET/api/v1/cloudsync/{clientId}/isSyncRequired
Bestimmt, ob noch EoD‑Dateien in der lokalen Message‑Queue vorhanden sind.Mögliche Fehler
EndOfDay required– Kein EoD-Dokument gefunden; EoD generieren!CloudConnect required– Erfolgreicher CloudConnect-Aufruf erforderlich.Files are in Message Queue (cloudTemp folder)– Ausstehende Dateien müssen hochgeladen werden.Terminal is not allowed to sync with cloud– Client hat keine Berechtigung.Not implemented for country– Nur für Deutschland unterstützt.
Antwort
false– Alle Dateien sind bereits in der Cloud; keine weitere Aktion erforderlich.true– Eine oder mehrere Dateien müssen gesendet werden; Fortsetzung mit dem nächsten Schritt erforderlich.
Übertragung zur Cloud starten
POST/api/v1/cloudsync/{clientId}/startSendingToCloud
Startet den asynchronen Datei-Upload.Mögliche Fehler
- Alle Fehler von isSyncRequired.
Insufficient cloud-store rights– Client kann nicht in den Cloud-Speicher schreiben.
Hinweis: Erfolg bedeutet, dass der Upload-Prozess gestartet wurde; es garantiert nicht eine sofortige Übertragung.- Vollständigkeit überprüfen
Wiederholung des isSyncRequired Aufrufs.- Falls
false: Upload abgeschlossen. - Falls noch
true: Kurze Wartezeit und erneuter Versuch, bis alle Dateien die Warteschlange verlassen haben.
- Falls
Auslösebedingungen
Diese Sync-Routine sollte ausgeführt werden, wenn:
- Eine Transaktion verarbeitet wurde und
- File storage oder Cloud storage zuvor nicht aktiviert war (d.h. Ersteinrichtung) oder
- Ein vorheriger Sync-Versuch fehlgeschlagen ist und Dateien in der lokalen Warteschlange hinterlassen hat.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.