General information on configuration

This article contains general information on how to create a configuration object for RetailForce Fiscal Middleware in the cloud. Configurations are downloaded and applied by fiscal clients during initialisation, via ConfigClient byCloud (PUT /api/v1/management/clients/byCloud). For more information, see the article on initialisation.

In the RetailForce portal, configuration can be inherited downwards within the organisational structure. This means that a configuration can be used for a number of terminals at the same time and it is not necessary to create it for each terminal. It is also possible to overwrite some configurations in the inherited object.

Example:

In the example below, configuration object A is assigned to the organisation "XYZ Holding GmbH". The configuration is inherited by all subordinate units in the organisational structure. The cash register "099" (terminal) is assigned configuration object B and thus overwrites the inherited configuration object A.

The configuration object is always independent of the master data object, such as organisation, etc.

It is possible to transfer a configuration object to any level of inheritance. A configuration object can be transferred at each level (organisation, company, stores and terminals).

Important: It is not possible to share a configuration object between different organisations. A separate configuration object must be created for each organisation. Exception: Master Organisation

Cloud data inheritance structure:

Organisation
- Company - optional
  - Store
    - Terminal

Example:

Your organisation consists of 13 shops in Germany and is now planning a new branch in Austria. The POS system hardware used is the same in Germany and Austria.

You will need:

An organisation based in Germany (FiscalCountry = Germany)
An additional optional company resident in Austria (FiscalCountry = Austria)
13 Shops/branches with connection to the organisation
1 branch with connection to the organisation AND to the company in Austria

You need to define 2 configuration objects:

a configuration object with all configurations needed for Germany
- you can define the entire hardware configuration in the configuration object for Germany
a configuration object with all the configurations needed for Austria
- you do not have to define the hardware configuration in the configuration for Austria
- overwrite the FiscalCountry and the country-specific configuration for the configuration for Austria

Assigning configurations

The assignment of a configuration object is carried out in the RetailForce Portal, via the details of the respective entities (organisation objects: Organisation, Company, Store, Terminal).

To do this, select the relevant configuration in the Configuration area via the drop-down menu and click "Save".

Note: If no configuration object is displayed in the selection, either no configuration has been created yet or the created configuration does not match the set fiscal country of the entity. Configurations can only be assigned if the fiscal country of the entity (e.g. the company) matches that of the configuration.

The menu item "New Config" can be used to specify that a new configuration is valid from a certain date ("New valid from").

Update configuration

Attention: If a configuration object is changed in the cloud, this change is NOT automatically distributed to the relevant clients (middleware mandates)!

The configurations of the individual clients must be transmitted via:

PUT /api/v1/management/clients/byCloud/{clientId}

must be updated.

Error Handling

Error: License

If you receive the following error when calling the GetConfiguration endpoint. you receive:

[error] (exception): License 'GetConfiguration' for client '<ClientID>' not found.

The licence option that allows the client to retrieve configuration data from the cloud is missing. Please check in the RetailForce Cloud Portal whether the assigned license contains the option "Access configuration download".

Configuration Germany - [0] = Germany

Configuration Austria - [1] = Austria

Configuration France - [2] = France

Configuration Bulgaria [3] = Bulgaria

Configuration Denmark [4] = Denmark

Configuration Sweden [5] = Sweden

Configuration Slovenia [6] = Slovenia

Configuration Poland [7] = Poland

Configuration Serbia [8] = Serbia

Configuration Italy [9] = Italy

Configuration Croatia [10] = Croatia

Configuration Romania [12] = Romania