Skip to content

Scanner Service Configuration

The config.json file for the NEC AI Scanner Service is located in the installation folder.

config.json

{
    tcpoptions": {
        "serveraddress": "",
        "port": "60080",
        "certificatefilepath": "",
        "certificatepassword": ""
    },
    "scanneroptions": {
        "frontwhite": "false",
        "backwhite": "false",
        "frontir": "false",
        "backir": "false",
        "frontuv": "false",
        "backuv": "false"
    }
}

tcpoptions: Connection settings to the Kiosk Client.

  • serveraddress: represents the IP address in which the scanner service listens for incoming connections from the Kiosk Client. By default, this setting is empty, which means that the wrapper service listens on all available addresses. When it is required to listen only on a particular address, "serveraddress" can be set to a particular IP address associated to the Kiosk Client's machine. Usually, this value will remain empty.
  • port: represents the TCP port number the scanner service listens on for incoming connections from the Kiosk client. This setting does not need to be changed unless port 60080 is not available on the machine.
  • certificatefilepath and certificatepassword: parameters that need to be set in order to secure the communication channel between the Kiosk Client and the NEC Scanner service. These values are explained in the section "Securing the Communication between Kiosk Applications".

scanneroptions: If one or more of these values are set to true, an image of that type is sent to the UIP. These images are not used by the Kiosk, however custom workflows can be written to extract those images when the Kiosk sends them to be used for other purposes.

Important

Sending multiple images of the scanned photo will greatly increase the size of the data being sent to the UIP. If photo verification fails after setting the scanner options to true, you may need to increase the UIP webhook data limits.