During regular cash register operation, it may be necessary to restore data, for example due to hardware defects, in order to continue working with the recording system.
Attention: In some countries, the processes described below for restoring clients of the RetailForce fiscalisation service are not permitted due to legal regulations. If the recording system (cash registers, etc.) is defective, no data recovery may be performed; instead, a new cash register must be put into operation. For further information, see below.
Restoration via RetailForce Cloud
A system restore can be performed based on the data stored in the RetailForce Cloud.
Prerequisites
- Licence for cloud archiving activated,
- licence GetConfiguration activated,
- cloud Archive option activated in the configuration,
- data directory of the client to be restored (e.g. on Windows systems: C:\ProgramData\RetailForce\Fiscal Webservice\{clientId} must not exist,
- the configuration of the client to be restored must not be contained in the config store (no entry for the corresponding clientId in fiscalService.config.json).
Attention: Recovery can only take place if the corresponding client was already in operation at an earlier point in time, i.e. data for recovery is available. If an error occurred during initial start-up (before initialisation), recovery will also fail! In this case, only a complete re-start is possible. Check whether the necessary hardware components (TSE/TSS in DE, security module in LT, etc.) have already been initialised. If this is the case, they may need to be replaced!
Function
Data recovery is performed by calling the endpoints:
-
POST /api/v1/management/clients/recovery/restoreByCloud
or - POST /api/v1/management/clients/recovery/restoreByCloud/id
Note: Only data that has already been transferred to the RetailForce Cloud can be restored. Data that has not been transferred to the cloud system (data that was located in the \tempcloud folder and, for example, has not yet been transferred to the cloud due to a network interruption) cannot be restored and may be lost.
Important: Client recovery using the above-mentioned functions can only be performed successfully if at least one daily closing (EndOfDay document) has been saved in the past for the cash register (client/terminal) in question and transferred to the cloud archive.
Restart
In order to continue working with the new cash registers, it is necessary to know the last document processed by the client.
This can be retrieved from the document storage via the endpoint
- GET /api/v1/transactions/document/{clientId}/last
However, only the JSON payload that the POS system sent to the client is retrieved, not the response (fiscalResponse).
To also call the corresponding fiscalResponse, the endpoint
- GET /api/v1/transactions/document/{clientId}/{documentGuid}/response
must be used, specifying the parameters
- ClientId and
- documentGuid (from the JSON object that was previously returned when calling GET /api/v1/transactions/document/{clientId}/last)
Using the information contained in Payload and fiscalResponse, the POS system should be able to continue with the next document number in sequence.
Recovery via backup data
The RetailForce fiscalisation service allows local data backups to be created. These can be generated at any time by calling up the endpoint:
- GET /api/v1/management/clients/recovery/{clientId}/backup
This creates a zip file containing all master and transaction data relevant to the client that was available locally (!) at the time the backup was created.
In the event of a system failure (cash register PC defective and needs to be reinstalled), an existing backup file can be used to restore the respective client using the endpoint
- POST /api/v1/management/clients/recovery/restore
The data set corresponds to each backup creation. No data is downloaded from the RetailForce Cloud (e.g. data that was transferred to the RetailForce Cloud after the backup file was created).
The procedure is identical to that for moving a FiscalClient from one computer to another.
Attention: To avoid data discrepancies between the cash register and the RetailForce Cloud archive, we recommend using this function only for offline systems (e.g. if a licence package WITHOUT cloud archiving has been selected).
Restart
Restarting by importing a local backup file works in exactly the same way as restoring via the RetailForce Cloud. However, please note that if cloud archiving of fiscal data is activated for the respective client, there may be a data discrepancy between the backup file and the cloud system.
To check this, use the data export functions of the respective client in the RetailForce portal.
New installation
In some cases, the only solution is to set up the cash register completely from scratch, without data recovery. Legal regulations in the respective countries may also require a new installation, e.g. if the Lithuanian security module (hardware) is defective, a new cash register must be registered.
The new installation of a terminal/client is carried out according to the familiar procedure.
Countries where client recovery is not permitted:
- Lithuania
Comments
0 comments
Please sign in to leave a comment.