Partners Blog Contact Us

VidyoEngage Kiosk: Local Configuration

Follow

The VidyoEngage™ Kiosk installation folder contains a “Settings.txt” settings file. When the application starts, all configured values are loaded, so any changes on the settings file are executed upon restarting the application. Before running the application, it is mandatory to enter a value for the Server URL and Tenant fields. Other values are optional and there are default values for the other settings. If an upgrade is taking place, the current settings file is saved as a backup file and named “Settings-MMDDYYYY-HHMMSS.txt”. All configuration options are described below.

Settings File Structure

The settings file contains many configuration values in the form of key=value, where key is configuration name and value is its deployment-specific value. The left side of the “=” sign should not be changed. If a line starts with “;”, then that line will be ignored. All other characters at the beginning of the line will be ignored.

Key/Values Details

  • SERVER
    • Valid values: URL schema only
    • This is the VidyoEngage backend server URL.
  • ISGENESYS
    • Valid values: True or False
    • This indicates if the Kiosk works with the VidyoEngage Express backend (if True) or Genesys backend (if False).
  • Genesys_serverUrl
    • Valid values: URL schema with port + path
    • This is the Genesys backend server URL (including port + path).
  • AdditionalKVP
    • Valid values: Key Value Pair
    • This consists of key value pairs where key and value are separated by “:” and each pair is separated by “,” (this is only valid for Genesys backend and it represents other values sent to the server).
  • TENANT
    • Valid values: Numeric values only
    • Tenant Id that will be used by the VidyoEngage Kiosk.
  • API_KEY
    • Valid values: Alphanumeric values only
    • API Key that is configured for this tenant
  • KEYBOARD
    • Valid values: SMALL, MEDIUM, or LARGE
    • Depending on the display screen size, the appropriate keyboard size would look nice. Verify the size that works best for the applicable display screen.
  • CAMERA
    • Valid values: Numeric values only
    • The index for the camera to be used by the VidyoEngage Kiosk. For example, 0 for the first camera, 1 for the second camera, and so on.
  • MICROPHONE
    • Valid values: Numeric values only
    • The index for the microphone to be used by the VidyoEngage Kiosk. For example, 0 for the first microphone, 1 for the second microphone, and so on.
  • SPEAKER
    • Valid values: Numeric values only
    • The index for the speaker to be used by the VidyoEngage Kiosk. For example, 0 for the first speaker, 1 for the speaker, and so on.
  • TIMEOUT_OPTION
    • Valid values: Numeric values only
    • This option is used to determine whether there will be a screen timeout in the application. If the TIMEOUT_OPTION is set to 1, then the application screen timeout is active. If it is set to 0 or any other values, there will not be a screen timeout.
  • TIMEOUT
    • Valid values: Numeric values only
    • A timeout value (in seconds) is used to take users back to the Home screen. For example, for a five minute timeout, the TIMEOUT should equal 300.
  • SPLASH_SCREEN_LEFT_IMAGE
    • Valid values: URL schema only
    • The Start screen left image name must be the PNG image URL and the image name should not have any quotes. The name should appear after the "=" symbol.
  • SPLASH_SCREEN_RIGHT_SIDE_TEXT
    • Valid values: Alphanumeric values only
    • The Start screen right side text.
  • INSTRUCTION_OPTION
    • Valid values: Numeric values only
    • The instructions on the ENTER NAME and SELECT TOPIC screens.
    • 1 will enable the instructions on the screen and 0 will disable them. Any other settings for INSTRUCTION_OPTION will be disabled by default.
  • INSTRUCTION_TEXT
    • Valid values: Alphanumeric values only (limited to 70 characters)
    • The instructions on the ENTER NAME and SELECT TOPIC screens.
  • INSTRUCTION_OPTION_WAITING_ROOM
    • Valid values: Numeric values only
    • The instructions on the waiting room screen.
    • 1 will enable the instruction on screen and 0 will disable it.
    • Any other settings for INSTRUCTION_OPTION_WAITING_ROOM will be disabled by default.
  • INSTRUCTION_TEXT_WAITING_ROOM
    • Valid values: Alphanumeric value only (limited to 70 characters)
    • The instructions on the waiting room screen.
  • SHOW_ERROR_ON_SCREEN
    • Valid values: Numeric values only
    • This parameter determines whether error messages will be shown on the screen.
    • 1 will cause an error message to appear on the screen.
  • ERROR_MESSAGE
    • Valid values: Alphanumeric values only (limited to 70 characters)
    • The error message that will be shown on the screen.
  • THEME_OPTION
    • Valid values: Numeric values only
    • This parameter determines whether to change the application theme.
    • 1 will enable the theme and 0 will disable it.
    • Any other settings for THEME_OPTION will be disabled by default.
  • COLOR_THEME
    • Valid values: A range of 140 HTML color names from https://www.w3schools.com/colors/colors_names.asp

    • HEAD_LINE_TEXT_COLOR
      • Color for the headline text
    • BODY_TEXT_COLOR
      • Color for the body text
    • SCROLLBAR_COLOR
      • Color for the scrollbar
    • ARROW_COLOR
      • Color for the arrows, which are used to navigate back to the previous screen or navigate to the next screen
    • BUTTON_BACKGROUND_COLOR_PRIMARY
      • Background color of the primary buttons (ACCEPT, SUBMIT, etc.)
    • BUTTON_BACKGROUND_COLOR_SECONDARY
      • Background color of the secondary buttons (REJECT, CANCEL, etc.)
    • BUTTON_FONT_COLOR
      • Color for the button text
    • BORDER_COLOR
      • Color for all borders/underlines in the body
    • TOP_DOT_INNER
      • Color for the top dots, which indicates the screen that is currently displaying
    • SURVEY_STAR_COLOR
      • Color for the asterisk ("*”) on the Survey screen
    • LOCATION
      • Location of the Kiosk

Settings Default and Valid Value Matrix

Parameter Default
Value
No Value
Action
Wrong Value Action
Server URL  No  Stay on the loading screen with the error message displaying  Stay on the loading screen with the error message displaying 
ISGENESYS False Assumes the Kiosk will operate against the VidyoEngage Express backend Assumes the Kiosk will operate against the VidyoEngage Express backend
Genesys_serverUrl 0 N/A N/A
AdditionalKVP 0 N/A N/A
Tenant  No  Stay on the loading screen with the error message displaying  Stay on the loading screen with the error message displaying 
API_KEY  No  N/A N/A
KEYBOARD  SMALL Default Value  Default Value
CAMERA  0 Default Value   If it is not an integer, the default value is set to 0; otherwise, it will not use the appropriate device. 
MICROPHONE  Default Value   If it is not an integer, the default value is set to 0; otherwise, it will not use the appropriate device. 
SPEAKER  Default Value   If it is not an integer, the default value is set to 0; otherwise, it will not use the appropriate device. 
TIMEOUT_OPTION  1(true)  Default Value   If it is not an integer, the default value is set to 1. 
TIMEOUT  300 Default Value   If it is not an integer, the default value is set to 300. 
SPLASH_SCREEN
_LEFT_IMAGE
https://apps.
vidyoclouddev.com/
vex/media/
Vidyo-Logo-Color-Vert.png
 
Default Value   The application will check whether it is a PNG, JPEG, or GIF file. If it is not in any of these formats, the default image will appear. Also, the application will check whether an image exists in a remote location. If it does not exist, the default image will appear. 
SPLASH_SCREEN
_RIGHT_SIDE_
TEXT 
Face-to-face live video conferences for your customer engagement needs.  Default Value  If the length is greater than 70 characters or the parameter is left empty, the default line will appear. 
INSTRUCTION_
OPTION 
1(true)  Default Value  If it is not an integer, the default value is set to 1. 
INSTRUCTION_
TEXT 
Click the green arrows, '<' to go back and '>' to continue to next screen  Default Value  If the length is greater than 70 characters or the parmeter is left empty, the default line will appear. 
INSTRUCTION_
OPTION_
WAITING_ROOM 
1(true) Default Value  If it is not an integer, the default value is set to 1. 
INSTRUCTION_
TEXT_
WAITING_ROOM 
Please select one of the following videos while you wait for an agent  Default Value  If the length is greater than 70 characters or the parameter is left empty, the default line will appear. 
SHOW_ERROR_
ON_SCREEN 
1(true)  Default Value  If it is not an integer, the default value is set to 1. 
ERROR_MESSAGE  Application settings error  Default Value  Default Value 
THEME_OPTION  0 (false) Default Value  If it is not an integer, the default value is set to 0; otherwise, it will not use the appropriate device. 
HEAD_LINE_TEXT
_COLOR 
YellowGreen  Default Value  Default Value 
BODY_TEXT_
COLOR 
White Default Value  Default Value 
SCROLLBAR_
COLOR 
YellowGreen   Default Value  Default Value 
ARROW_COLOR  YellowGreen   Default Value  Default Value 
BUTTON_
BACKGROUND_
COLOR_PRIMARY 
YellowGreen   Default Value  Default Value 
BUTTON_
BACKGROUND_
COLOR_
SECONDARY 
Gray Default Value  Default Value 
BUTTON_FONT
_COLOR 
YellowGreen    Default Value  Default Value 
BORDER_COLOR  YellowGreen    Default Value  Default Value 
TOP_DOT_INNER  YellowGreen    Default Value  Default Value 
SURVEY_STAR_
COLOR 
YellowGreen    Default Value  Default Value 
LOCATION  New York Branch  Default Value  Default Value 
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.