CloudSync - Data resending

This documentation describes how to verify and transfer End-of-Day documents. Currently, this function is only supported for Germany.

Overview

The cloud sync process securely stores your End-of-Day documents in the cloud and performs the following tasks:

1. checks whether all the required EOD files (the generic EOD document and the Germany-specific TAR archive) are present in the cloud storage
2. transfer any missing files from the local client to the cloud.

Prerequisites

• Organisational permission: This must be enabled to resend data. Activation must be performed via support.
• Fiscal country: Currently only available for Germany.
• Configuration: The local file storage and cloud storage paths must be configured in the RetailForce portal

Portal Configuration

1. Log in to the RetailForce portal.
2. Navigate to Configuration → Relevant Configuration
3. File storage
   1. Click on + Storage path.
   2. The Storage path field remains empty and requires no input.
4. Cloud storage
   1. Click on + Storage path.
   2. The Storage path field is also initially empty.
5. Save changes.

Client Workflow

After generating and posting a transaction-based EOD on the client, the following API calls must be made in the given order:

• Update configuration
  POST /api/v1/management/clients/byCloud/{clientId}
  Updates the configuration and ensures the middleware is using the current file and cloud storage paths.
• CloudConnect
  POST /api/v1/management/cloud/connect
  Establishes a connection to the cloud.
• Create End-of-Day
  GET /api/v1/closing/{clientId}/endofdayDocument
  Creates the local EOD document.
• Book End-of-Day
  POST /api/v1/transactions/storeDocument
  Books the created EOD document.

• Check sync requirement
  GET /api/v1/cloudsync/{clientId}/isSyncRequired
  Determines whether there are still EOD files in the local message queue.

  Possible errors

  • EndOfDay required – No EOD document found; generate EOD!
  • CloudConnect required – CloudConnect call required.
  • Files are in Message Queue (cloudTemp folder) – Pending files must be uploaded.
  • Terminal is not allowed to sync with cloud – Client has no permission.
  • Not implemented for country – Supported only for Germany.

  Response

  • false – All files are already in the cloud; no further action required.
  • true – One or more files need to be sent; proceed to the next step.

• Start transfer to cloud
  POST /api/v1/cloudsync/{clientId}/startSendingToCloud
  Initiates the asynchronous file upload.

  Possible errors

  • All errors from isSyncRequired.
  • Insufficient rights – Client cannot write to cloud storage.
  Note: Success indicates that the upload process has started; it does not guarantee immediate transfer.
• Verify completeness
  Repeat the isSyncRequired call.
  • If false: Upload completed.
  • If still true: Wait briefly and retry until all files have left the queue.

Trigger Conditions

This sync routine should be executed when:

• A transaction has been processed and
• File storage or Cloud storage was not previously enabled (i.e., initial setup) or
• A previous sync attempt failed and left files in the local queue.