Modification of configuration files

Storage of configuration files

The configuration files are saved to the folders ui, processes and parameter/client which are respectively located under:

  • ..\config\standard\
  • ..\config\custom\

The configuration under custom contains customer-specific adjustments. These values will overwrite the configuration set under standard.

Basically, the folder structure under custom must be identical to the structure under standard. The files to be adjusted are saved to these folders.

Note:
The storage location of the configuration files is indicated in the file defaultVars.cmd :
SET classpath=%classpath%;config/custom/ui;config/standard/ui
SET classpath=%classpath%;config/custom/processes;config/standard/processes
SET classpath=%classpath%;config/custom/parameter/client;config/standard/parameter/client

Properties of configuration files

The changes are made in different ways for XML files and properties files:

XML files

  1. Copy the file to be adjusted to the corresponding directory. The file is located under custom at the same location in the folder structure as under standard.
  2. Adjust the file.

The XML file in the custom folder will overwrite the file in the standard folder.

Properties Files

  1. Save the properties files to the same location in the folder structure as they are saved under standard.
  2. Change the file as desired.

    The properties files from the custom folder and the standard folder will be merged. Therefore, it is sufficient to enter the required changes in the custom file. The remaining content does not need to be adopted.

The example below shows changes of two parameters for the Return function:

  • Save the file promptReceiptDataConfigs.properties to the corresponding directory:

    ..\pos-client\config\custom\parameter\client\flow\

  • Enter the parameters to be changed:
     PromptReceiptDataConfigs.ReturnWithTransaction.workstationIdUseCurrent=true
 PromptReceiptDataConfigs.ReturnWithTransaction.receiptNumberUseCurrent=true

Special features for properties files

Removing Properties

To remove entries from properties files, proceed as follows:

  1. Under custom , save the properties file to the same location in the folder structure as it is saved under standard .
  2. Copy the desired entry to the respective file.
  3. Add the prefix - to the whole entry.

For example, the following entry in the file barcodeProcessor.properties will be ignored:

-BarcodeProcessorConfig.barcodes.1.name=Operator (sign off)
-BarcodeProcessorConfig.barcodes.1.type=EAN8
-BarcodeProcessorConfig.barcodes.1.length=8
-BarcodeProcessorConfig.barcodes.1.templates.0.name=prefix
-BarcodeProcessorConfig.barcodes.1.templates.0.value=99
-BarcodeProcessorConfig.barcodes.1.templates.0.index=0
-BarcodeProcessorConfig.barcodes.1.posStates.0.id=1
 -BarcodeProcessorConfig.barcodes.1.posStates.0.processName=Logout
 -BarcodeProcessorConfig.barcodes.1.actions.0.processReactions.0.processName=Logout
 -BarcodeProcessorConfig.barcodes.1.actions.0.processReactions.0.reactionName=REINIT
 -BarcodeProcessorConfig.barcodes.1.actions.0.configId=LogoutConfigs.Default
 -BarcodeProcessorConfig.barcodes.1.actions.0.configParameters.0.name=authenti
 -BarcodeProcessorConfig.barcodes.1.actions.0.configParameters.0.patternStart=2
 -BarcodeProcessorConfig.barcodes.1.actions.0.configParameters.0.patternEnd=6
 -BarcodeProcessorConfig.barcodes.1.actions.0.configParameters.0.trimZeroesLeft=true
-BarcodeProcessorConfig.barcodes.1.actions.0.id=1

The file is located under:

..\config\custom\parameter\client\

Preventing the Merge Process

It is possible to completely prevent the merge process or interrupt it from a defined instant on. To do so, proceed as follows:

  1. Under custom , save the properties files to the same location in the folder structure as they are saved under standard.
  2. Add the entry disableConfigMerge=true to the respective file.

    All entries from the original file, which are still included under standard , will now be ignored. New entries can be added.

Index Numbering

Lists are mapped in properties files by means of an index of elements. Nevertheless, it is possible to define new list elements outside of the existing range. Therefore, the numbering resulting from the standard folder files may have gaps with respect to the numbering defined in the custom folder.

For example, the numbering ends with 8 according to the file additionalPrintouts.properties in the folder standard :

AdditionalPrintoutsConfig.triggers.8.type=Custom
 AdditionalPrintoutsConfig.triggers.8.value=com.gk_software.pos.pos_hal.print.report.additional_printouts.trigger.impl.WarrantyAdditionalPrintoutTrigger
 AdditionalPrintoutsConfig.triggers.8.printouts.0.report=WARRANTY

In the custom folder, you can continue the numbering with 11 and create a new entry:

AdditionalPrintoutsConfig.triggers.11.type=LineItemType
 AdditionalPrintoutsConfig.triggers.11.value=PR AdditionalPrintoutsConfig.triggers.11.printouts.0.report=TRANSACTION
AdditionalPrintoutsConfig.triggers.11.printouts.0.count=1
 AdditionalPrintoutsConfig.triggers.11.printouts.0.asDuplicate=true

The maximum numbering gap between two entries resulting from standard and custom files is 1000.