Configuring the RFID

Configuring the RFID

Configuration files
  • ..\parameter\client\hal.properties
  • ..\parameter\client\jpos.xml
  • ..\parameter\client\ui.properties
  • ..\parameter\client\rfidProcessor.properties
  • ..\parameter\client\barcodeProcessor.properties
  • ..\parameter\client\flow\paymentEndConfigs.properties
  • ..\parameter\client\flow\rfidReadingConfigs.properties

Installation

The add-on pack for RFID must be assigned to POS Clients in Storemanager.

Activation of the RFID Device

Note:
The following are supported: RFID middleware from Detego and GK RFID interface to be implemented by an RFID provider
To activate the RFID device, adjust the configuration in file hal.properties as follows:
DeviceEntryTypes.DETEGO_JPOS.id=DetegoJposRfidScanner
 DeviceEntryTypes.DETEGO_JPOS.descriptionKey=device.entry.DETEGO.rfid
DeviceEntryTypes.DETEGO_JPOS.description=Detego RFID Scanner
DeviceEntryTypes.DETEGO_JPOS.deviceCategory=RFID_SCANNER
DeviceEntryTypes.DETEGO_JPOS.enabled=true
DeviceEntryTypes.DETEGO_JPOS.active=true
 DeviceEntryTypes.DETEGO_JPOS.className=com.gk_software.pos.hal.device.rfid.JPosRfidScanner
 DeviceMappingEntryTypes.DefaultRfidScanner.mappedTo=DetegoJposRfidScanner
The configuration of the RFID device is also done in the file hal.properties:
RfidScannerConfigs.DETEGO_JPOS.readTimerInterval=1000

There is the following setting:

  • readTimerInterval: Defines the interval (in milliseconds) of reading operations when the device continuous reading mode is started. This means that if the RFID device is activated, it reads every second and checks if there are new items for registration. This parameter is only supported for continuous reading mode (readingMode=Continuous).
Additional settings for the RFID device can be made in the file jpos.xml in the corresponding JPOS entry:
<JposEntry logicalName="DetegoJposRfidScanner">
<creation factoryClass="gk.javapos.GkServiceInstanceFactory" serviceClass="com.gk_software.pos.plugin.rfid.hal.device.detego.DetegoJposRfidScannerService"/>
<vendor name="Detego" url="http://www.detego.com"/>
<jpos category="RFIDScanner" version="1.14"/>
<product description="Detego RFIDScanner by GK Software SE, JPOS1.14" name="Detego Services for JavaPOS(TM) Standard" url="http://www.detego.com"/>
<!--Other non JavaPOS required property (mostly vendor properties and bus specific properties i.e. RS232 )-->
<prop name="deviceClass" type="String" value="com.gk_software.pos.plugin.rfid.hal.device.detego.DetegoRfidImpl"/>
<prop name="enableBatchProcessing" type="Boolean" value="false"/>
<prop name="address" type="String" value="http://localhost:8088/rfid"/>
<prop name="connectionTimeout" type="Integer" value="2000"/>
<prop name="timeout" type="Integer" value="15000"/>
<prop name="username" type="String" value=""/>
<prop name="password" type="String" value=""/>
</JposEntry>

There are the following settings:

  • enableBatchProcessing: This parameter defines whether items are sent in one (= true) or multiple (= false) requests to the RFID middleware.
  • address: Address to the RFID middleware.

Master Data

RFID items have to be maintained in the master data accordingly as they are handled differently on the Omnichannel Point-of-Sale. RFID items have the following setting:

  • ItemSO.RFIDFlag = true

As the default is set to true, especially non-RFID items have to be maintained as well:

  • ItemSO.RFIDFlag = false

Recommended Settings

In addition, it is recommended to use the following settings:

Enable Display Panel

During the RFID registration of multiple items, it may be the case that the operator has to enter some item-related information or an item-related dialog is displayed. In this case, it is helpful to see to which item the message belongs to. Therefore, the display panel should be activated. This leads to additional information with the registration number and item name being displayed in warning and hint dialogs, tables, and input dialogs. To configure this, the following changes must be made in the ui.properties file: 
UiEnrichmentConfig.enrichmentPanelConfigs.0.displayPanel=true

The display panel is restricted to item-related dialogs (the dialog relates to one item).

Restriction:
In some dialogs, it is not possible to display the full item information as the item is not yet loaded.

2D Barcode Scanning and RFID Reading

In addition to the RFID Bulk Item Registration using the RFID device, it is possible to scan the corresponding 2D barcode and enter the item using the RFID Bulk Item Registration as well. The configuration of the 2D barcode scanning is done in the file barcodeProcessor.properties .

RFID reading by the RFID device is configured in the file rfidProcessor.properties .

Configuration for Starting and Stopping the RFID Device

The processes in which the RFID reader is reading or stops reading can be configured. There are the following possibilities:

Automatic Activation

It is possible to configure that the RFID device is activated automatically when a process or context is entered:

  • process: The corresponding process is listed as "processName"
  • context: The corresponding context is listed in the "contextIds"
The configuration is done in the file hal.properties. See also the following example:
 DeviceActivityConfigs.RfidScanner.enableProcesses.0.processName=ItemRegistration
 DeviceActivityConfigs.RfidScanner.enableProcesses.0.contextIds.0=Return
 DeviceActivityConfigs.RfidScanner.enableProcesses.1.processName=ReturnWithTransaction

In this case, the RFID device is activated automatically in goods return mode (without registration) and in goods return with transaction. It is not started automatically in the item registration.

In addition, it is possible to add multiple context IDs to one process name:
 DeviceActivityConfigs.RfidScanner.enableProcesses.0.processName=ItemRegistration
 DeviceActivityConfigs.RfidScanner.enableProcesses.0.contextIds.0=Return
 DeviceActivityConfigs.RfidScanner.enableProcesses.0.contextIds.1=AdditionalProcess

In this case, the RFID device is activated automatically in the goods return without transaction mode and in the "AdditionalProcess".

Note:
The process name where the RFID scanner is reading has to be configured as well in the file rfidProcessor.properties . See also 2D Barcode Scanning and RFID Reading.

Automatic Reset

To prevent the RFID device from being activated in masks where this is not expected or desired, it is possible to configure event keys which should reset the behavior of the RFID device. The configuration is done in the file hal.properties. See also the following example:
 DeviceActivityConfigs.RfidScanner.resetEventKeys.0=FLOW_EVENT_GOODS_RETURN_EXITED
 DeviceActivityConfigs.RfidScanner.resetEventKeys.1=FLOW_EVENT_RETURN_WITH_TX_EXITED
 DeviceActivityConfigs.RfidScanner.resetEventKeys.2=FLOW_EVENT_PAYMENT_MAIN_ENTERED
 DeviceActivityConfigs.RfidScanner.resetEventKeys.3=FLOW_EVENT_SIGNED_OFF
 DeviceActivityConfigs.RfidScanner.resetEventKeys.4=FLOW_EVENT_POS_LOCKED
 DeviceActivityConfigs.RfidScanner.resetEventKeys.5=EVENT_TRANSACTION_CLOSED

In this case, the RFID device is reset in the following cases:

  • The goods return mask (with and without receipt) is exited
  • The payment mask is entered
  • The transaction is finished (e.g. also by receipt cancellation)
  • The operator signs off or starts a break

Advanced Configuration

Add RFID Reading to Additional Processes

At the moment, RFID reading is configured for the Item Registration Mask and the Goods Return Masks (with and without transactions). To add RFID reading to additional processes, the following steps are required:

  • Add the RFID button to the corresponding tableau
  • For the scanning with the RFID device, ensure that the process is listed in the file rfidProcessor.properties
  • For scanning with the 2D Barcode, ensure that the process is configured accordingly in the file barcodeProcessor.properties
  • If the RFID device should be activated automatically when the process is entered, it must be added to the "enableProcesses" in the file hal.properties . See also Automatic Activation.
  • If the RFID device should be reset automatically when such a process is left, it must be added to the "resetEventKeys" in the file hal.properties . See also Automatic Reset.

Switch From Continuous RFID Reading to Single RFID Reading

RFID reading can be done in two modes:

  1. Continuous RFID Reading
  2. Single RFID Reading

By default, continuous RFID reading is configured. This means that, once it is activated, the RFID device reads permanently until it is deactivated manually or a "reset event" happens.

This behavior can be switched to Single RFID Reading. This means that the RFID device reads once it is started until no further items are available for reading. To switch to this Single RFID Reading, perform the following steps:

  • In the file rfidReadingConfigs.properties , set the RFID Reading Mode:
#RfidReadingConfigs.Default.readingMode=Continuous
RfidReadingConfigs.Default.readingMode=Single
  • In the file hal.properties , remove (here: commented out) the reference to the DeviceActivityConfigs:
    #RfidScannerConfigs.DETEGO_JPOS.deviceActivityConfig=reference\:DeviceActivityConfigs.RfidScanner

Error Handling

Start of the POS

During the POS start, the RFID device is initialized. If this is not possible, the RFID device is marked as not initialized in the start up screen. However, the start process itself continues. This behavior is configured in the ui.properties :
StartupScreenConfig.initFailActions.DetegoJposRfidScanner=CONTINUE

Possible different values are:

  • ABORT: The only option in the case of an error is to abort the start manually.
  • MANDATORY: Possible options in the case of an error are to abort or to retry the initialization.
  • OPTIONAL: Possible options in the case of an error are to abort, to retry the initialization or to continue without initialization.

This configuration is also possible for other devices in general.

This setting is recommended as the RFID device can also be initialized after the POS start by the device manager.

During Registration

If the RFID device is reading, a general error message is always displayed if the RFID middleware cannot be reached. In continuous reading mode (=default), the RFID device reads every X seconds (X is defined in the parameter "readTimerInterval", see also Activation of the RFID Device).

During Payment End

If the RFID middleware cannot be reached due to an offline error, a corresponding confirm dialog is displayed. The process can be repeated or finished without sending the items to the RFID middleware.

In the event of any other error, it can be configured whether a table with not booked items should be displayed. This can be configured in the file paymentEndConfigs.properties :
PaymentEndConfigs.Default.showRfidWarning=true