Skip to content

Position Settings

This page allows defining settings which apply to an individual Kiosk position. Each Kiosk position has its own name for easy identification as well as its own connected devices.

  • To add a new Kiosk position, click on the Add Kiosk Position button and then fill in the properties on the right-side panel. Click Save at the bottom of the page when done.
  • To edit details of an existing Kiosk Position, select the position on the left side list and then edit the desired properties on the right-side panel. Click Save at the bottom of the page when done.
  • To delete details for an existing Kiosk Position, click on the corresponding trash icon. You will be prompted to confirm the deletion. Confirming the deletion will result in the individual settings for the respective Kiosk Position to be removed from the system.
  • To copy a Kiosk position, click on the corresponding copy icon. This will copy the settings from the Kiosk Position to add a new position.
  • To download the configuration file for an existing Kiosk Position, click on the corresponding secure file icon. Downloading a configuration file will disconnect the Kiosk Position (if it is currently connected) until the new file is installed on the Kiosk Position.

//

Warning

A Kiosk Client that does not have a corresponding Kiosk Position will not be able to connect to Kiosk Services.

Add/Edit Kiosk Position

  • Kiosk Position: represents the unique identifier of the kiosk client machine. It is recommended to be set to the machine name or to a meaningful value. For example, "kiosk_1_east-wing" etc.
  • Description: it is recommended to set this to a value that would allow identifying the physical location of the kiosk machine in an easy manner.

  • Keycard: This setting group defines how the system handles the keycard programming devices (keycard encoder and keycard dispenser).

    • Keycard Dispenser Id: Uniquely identifies the dispenser device that is used by the kiosk machine. May be left empty if the Kiosk position is not using a card dispenser device.

    • Keycard Dispenser Wait time (sec): Defines how long the system waits for the dispenser to respond when the guest returns a card. Default value is 15 seconds.

      Note

      This timer is only applicable when Keycard return is checked under System Settings > Keycard Settings.

    • Keycard Encoder Id: Uniquely identifies the encoder device that is used by the kiosk machine.

    • Keycard Encoder Mode: Identifies the operation mode used by the encoder device. Default value: "E"(meaning: eject mode).

      Note

      It is recommended to leave encoder mode set to "E" which tells the system to wait for the key to be removed from the encoder before proceeding.

  • Payment: Currently the Kiosk application accepts only "credit" as payment method type, representing payment by credit card swiped in a pin pad as opposed to “cash” entered into an integrated cash machine.

    • Terminal Id: A value that uniquely identifies the payment device/terminal. The ID should match the ID associated with the external payment system.
    • *Adapter: The name of the payment adapter used by this Kiosk Position. This only applies when the Kiosk is integrated directly with the payment provider.
    • *Cashier ID: A unique ID 1-8 digits in length to differentiate between different kiosks on the property. This is not the same as the Kiosk Position name, but the same value could be used for both if the Kiosk Position name was digits and up to 8 digits long.
    • *Chain Code: The chain code is provided by the external payment provider after the customer has set up their account with the payment provider. The chain code is passed with every transaction.
    • *Location: This is a value that is provided by the external payment provider to know the location of the customer using the credit card pinpad. The location is passed with every transaction.
    • *Authorize Amount: The value is used as the pre-auth amount at guest check-in. The value should be in the form xx.xx. (Ex. 50.00). When this is set to 0, the effective amount is calculated by Kiosk Client, as the room rate multiplied by the stay duration in days.

    • Enable Payment: Check this box if the application should effectively use the payment options.

      Note

      Settings marked with * are applicable if the Kiosk System integrates directly with the payment provider.

Applying Kiosk Client Position Configuration File

  • Download the Kiosk Client Position Configuration File for each Kiosk Client position configured in Kiosk Admin.

    Follow these guidelines for copying the Kiosk Position file to the Kiosk Client machine:

    Warning

    Important:  When upgrading and uninstalling Kiosk Client, files placed in the Kiosk Client installation folder will get removed. It is recommended to not copy the "<kiosk_client_id>-config.json" to the install folder as it will get removed during an upgrade or uninstall.

    • The Kiosk Client will automatically look in the C:\ProgramData\NEC\kiosk folder for the Kiosk Client Position Configuration File. Putting the file in C:\ProgramData\NEC\kiosk will result in Kiosk Client being able to read it without needing to update the path for kiosk_position_file_path in the kioskconf.json file.
    • If saving to any other location:
      • Edit the Kiosk configuration file located in C:\ProgramData\NEC\kiosk\kioskconf.json with any text editor app - such as Notepad or Notepad++
      • Identify the kiosk_position_file_path setting within the file and set its value to the full path of the position file - such as e.g. C:\PositionFilePath\mykiosk1.json.
      • Caution: When defining file system paths in a JSON file, you need to use either double backslashes ( \ ) or simple slashes ( / ) as path delimiters
        • From this perspective, C:\\PositionFilePath\\mykiosk1.json and C:/PositionFilePath/mykiosk1.json are both valid, and they represent the same file system path

  • The Kiosk Client to Kiosk Server communication is now secured. The Kiosk Client will attempt to connect to the Kiosk Server securely using the FQDN or IP Address seen in the position file. The server connection address comes from the first entry of the "server_addresses" property in the Kiosk Services template.  See Kiosk Services Deployment steps section for more details about the server addresses.