This document introduces the general process for deploying the VQ-FM. Please pay special attention to the highlighted tips or notes with icons to ensure proper functionality.
Create Vendor on Universal Server (Internal)
First, as a server owner, admin or distributor admin, you can go to Universal Server (KioCentral) => Company Management => Create Company to create a vendor company. The newly created company will be laid out in the list with a Login button via which you can log in to your vendor portal for further deployment from location, room, staff, CCM, etc. perspectives.
Server Setup (External)
Create Location and Room
Please navigate to Location Management of Vendor Portal to create the location and room where the product will be deployed. For improved management, you can also create the Branch and Cluster to which this product will belong.
Create Staff
Please navigate to Vendor Portal => User Management => Staff to create the staff accounts that will assist in managing the products.
Create CCM Profile
In CCM Profile Builder, you can build up/edit a Universal Pulse profile for the reader. The Universal pulse profile is developed to consolidate multiple pulse profiles from different markets into a single profile on the server. Users can configure and control multiple types of pulse and electromechanical devices with a single profile.
Click CCM > Universal > Universal Pulse to enter this section. You will see seven sub-tabs; each of the seven tabs will be introduced in the following content.
Location
Under the “Location” tab, you can fill in the values for Location ID, Room ID and Site Code, respectively.
Note: Make sure values set up herein shall be in accordance with those configured previously in Location Management. You can refer to the table below to be aware of the fields with descriptions.
Field Name | Value Needed | Description |
|---|---|---|
Location ID | Drop-down choice | A unique Location Code that identifies the Location. Click the input box then a drop-down menu containing the locations created will be shown. You can input the keyword of the desired location and as you are inputting, the search results will narrow down to match the keyword. |
Room ID | Numeric | Input the desired Room number. |
Site Code | Numeric | A six-digit Site Code for the Location. When Location ID is configured, its Site Code will be auto-populated. |
Machine Profile
Machine Profile allows users to define the machine-related parameters. Click the tab to enter this section for configurations.
Field Name | Description |
Machine Category | For VQ-FM products, please select the amusement-related category as the product will be initially used in the amusement market. If there is no existing machine category, you should click “Machine Management” > “Machine Category” on the navigation bar to create a new machine category. |
Machine Name | In the drop-down list, it will display the machine names belonging to the category you selected in the “Machine Category” section. If there is no existing name of the category you select, you could click “Machine Management” > “Machine List” on the navigation bar to create a new machine name. |
Machine Type | Please select “Amusement” as the machine type so that the VQ-FM will go through the amusement workflow and display the corresponding UIs. |
Hardware Interface | Please select “Gameboard Version 2” if it’s equipped for VQ-FM. The Pulse tab should be configured along with it. If Gameboard is not needed per your needs, you can keep it as the default option “None.” |
Pocket Configuration | N/A |
Pocket Price | N/A |
Reader Mode | It is used to allow end users to do transactions with Value or Credits accordingly in the location selected. When the Location Mode is defined in the Location Management section, the Reader Mode will be synchronized to the same definition. |
Special Mode | Special Mode is designed to provide promotional solutions to customers. 1) One Time means the special price is available within the specific time and date you select. For instructions, please refer to Start/End Time & Start/End Date sections. 2) Recurring means the special price is recurred within the time and days (e.g., if you check “Tuesday,” the price is available in the selected time on every Tuesday) you select. For instructions, please refer to Chapter Start/End Time and Days of Week sections. |
Special Type | It provides you with two special types for configuration: 1) Fixed Amount allows you to define the special price for machines in special mode. In the selected day/time period, machines will process payment with the special price. 2) Discount Percentage allows you to define the special price in discount off method. For example, in a “Value” reader, if the original price is set as $2.00 and the discount is set as 30, then in the selected day/time, the machine will charge $1.40 per play. |
Start/End Time | When “One Time” or “Recurring” is selected for “Special Mode,” you need to define the Start/End time for the special price. Click the option box beside the Start/End Time parameter and a drop-down electronic clock will show. It allows you to select the start time and end time directly. |
Start/End Date | When “One Time” is previously selected for “Special Mode,” you need to define the start/end day for the effective time of the special price. Click the option box beside the Start/End Date parameter and a drop-down calendar will show, which allows you to pick the start day and end day from the calendar directly. |
Days of Week | When “Recurring” is previously selected for “Special Mode,” you need to define the day or days of the week for the special price to be recurrently effective. Click the option box beside the “Days of Week” parameter and a drop-down list will be displayed. You could check one, multiple or all days of the week for this parameter. |
Audio Visual
The features in the Audio Visual tab allow users to configure the display on the reader.
Click on the Audio Visual tab to enter this section to define the audio and visual related parameters.
Products Price and Timing
Click the tab Products Price and Timing to enter this section for configurations on product price and time related parameters.
There are three categories under this section namely “Basic,” “Incremental” and “Multi Price” among which Basic and Multi Price are applicable to Amusement Market.
Basic Mode
In Basic mode, you can define the fields of Price, Pulses to Start, and Coin Value. You may also see Credit related fields when Credit Mode is defined as the Location and Reader Mode. And if Special Mode is enabled for promotion purposes, special price related parameters are also available for configurations.
Click “Basic” and input the parameters accordingly. You can refer to table below for descriptions of the fields.
The parameters marked out in the red boxes are for Special Mode only. If the mode is not enabled in Machine Profile>Special Mode, the parameters will not show.
Different definitions for “Special Type” (Fixed Amount/Discount Percentage) made previously in Machine Profile will lead to some differences in parameters to be configured in this chapter, for which illustrations are made separately with notes in below pictures.
 When “Fixed Amount” is selected as the “Special Type”
|
 When “Discount Percentage” is selected for “Special Type”
|
Field Name | Value Needed | Description |
Price | Numeric | The amount needed to start the machine. Unit is cent. Range is 1~99999. |
Pulses to Start | Numeric | The quantity of pulse needed to start the machine. Range is 1~200. |
Run Time | Numeric | You can ignore this field. The length of time applied to each cycle. Unit is minute. Range is 0~65535. |
Top off | Drop-down choice (Enable/Disable) | You can ignore this field. Defines whether to allow top off on dryer machines. |
Top off Price | Numeric | You can ignore this field. Amount needed for each top off. Unit is cent. Range is 1~99999. |
Pulses to Top Off | Numeric | You can ignore this field. The quantity of pulse needed for each top off. Range is 1~200. |
Top Off Run Time | Numeric | You can ignore this field. The length of time applied to each top off. Unit is minute. Range is 1~65535. |
Price (Credits) | Numeric | The credits needed to start the machine. Range is 1~99999. |
Special Price | Numeric | The amount needed to start the machine for promotions. Unit is cent. Range is 1~99999 on the condition that it is not bigger than the value set for “Price”. |
Special Price (Credits) | Numeric | The credits needed to start the machine for promotions. Range is 1~99999 on the condition that it is not bigger than the value set for “Price (Credits)”. |
Special Top off Price | Numeric | You can ignore this field. Amount needed for each top off during promotions. Unit is cent. Range is 1~99999 on the condition that it is not bigger than the value set for “Top off Price”. |
Discount | Numeric | Defines the discount percentage offered to start the machine during promotions. Unit is percent. Range is integers between 0~100. Value 0 means no discount and 100 means free of charge. |
Top off Discount | Numeric | You can ignore this field. Defines the discount percentage offered for each top off during promotions. Unit is percent. Range is integers between 0~100. Value 0 means no discount and 100 means free of charge. |
Coin Value | Numeric | Defines the coin value accepted by the machine. |
Mix Tender Transaction | Drop-down choice (Enable/Disable) | It defines whether to support multiple payment methods in basic mode. For example, when it’s enabled, users can pay 50 cents in coin and remaining 150 cents with credit cards for a 200-charge. But if it is disabled, after a payment of 50 cents in coin, users still need to pay the full amount in 200 cents with a changed payment method. |
Pulse
If the VQ-FM is installed with Gameboard V2, you can refer to the following content for its Pulse configuration.
The fields below can be configured for the reader’s credit pulse output:
Output Pulse Duration: This is the width of a credit pulse in milliseconds. It is set to 50 by default. The range is 1-65535.
Output Pulse Gap: This is the space between pulses in milliseconds. It is set to 100 by default. The range is 1-65535.
Output Pulse Polarity: This determines whether the pulse output is normally open and closed to send a pulse, or normally closed and opened to send a pulse. The values are Idle Open and Idle Closed.
Output Channel: This selects the channel to use for sending credit pulses to the game. It can be set to Channel 1, Channel 2, or Channel 3, but will usually be Channel 1.
Channel 1~6 can be configured for Gameboard V2’s input channels:
Field | Description |
Channel 1 | This field is used for monitoring Coin or Bill Input. Other options in the Type dropdown are for future use and are not currently supported. The Pulse Polarity should be set to "Idle Open/Idle Closed" depending on whether the coin or bill acceptor output is normally open or normally closed. Most games will use Idle Open. Pulse value: This is the value of a single pulse input. For coin, this will typically be 25 (for $0.25 or one quarter), and for bill this will either be 25 (when the bill acceptor is set to four pulses per dollar) or 100 (when the bill acceptor is set to one pulse per dollar). The range is 1-65535. |
Channel 2 | Same as Channel 1. |
Channel 3 | Same as Channel 1. |
Channel 4 | Same as Channel 1. |
Channel 5 | This channel is used to count Tickets. It can be used to count physical tickets, or to count emulated tickets (see Channel 6). When counting physical tickets, only Channel 5 will be used. This channel must be configured when using Channel 6 for Ticket Emulation.
|
Channel 6 | This channel is used to enable Ticket Emulator Output, where the Gameboard acts as a virtual ticket dispenser to the game. Channel 5 must be configured when using Channel 6 for Ticket Emulation in order to monitor the ticket counts.
|
When Channel 6 is configured, there are three fields that can be used to configure the ticket output for Gameboard Version 2.
Ticket Output Polarity: This is used to set the idle state of the Notch/Ticket signal. It must match the Polarity value used in Channel 5.
Output Pulse Gap: This is the gap between two ticket pulses. This must be greater than the Min Gap value used in Channel 5 or else the emulated tickets will not be properly counted by the Gameboard. This is set as 100 by default. The range limit is 1-65535.
Output Pulse Duration: This is the width of a ticket pulse. This must be within the Min/Max values used in Channel 5 or else the emulated tickets will not be properly counted by the Gameboard. This is set as 50 by default.
Data and Processing
Click on the tab Data and Processing to enter this section and define the fields based on your situation. For detailed description of all the fields, please refer to the table below.
Field Name | Value Needed | Description |
Data Upload | Drop-down choice | This parameter determines whether to upload the report. |
Data Upload Time | Drop-down choice | The settlement time of the readers. |
Offline Mode | Drop-down choice | Defines whether to support offline transactions with bank cards. - This feature supports Ultra series only. |
WiFi SSID | Alpha-numeric | The WiFi SSID of the router. Must be the same as the WLAN WiFi SSID in router’s setup. |
Reboot Time | Drop-down choice | The reboot time every day. |
Payment Gateway Options | Drop-down choice | It is determined by the gateway selected in Location Management => Payment Gateway => Reader Transactions. Only TSYS supports Offline Mode and automated VAR. |
POS ID | Numeric | This is a unique ID provided that associates the POS device with a unique merchant hierarchy. If this machine is located in USA, using TSYS as payment gateway, its work mode set to Retail, and auth mode set to Single Auth, you can leave this value and the following Auth Code, Auth Code as 0. The system will automatically request the credentials from Payroc when setting up this reader using KLM. The obtained credentials will be displayed in Room View. The above feature is called automated VAR. |
Auth Code | Alpha-numeric | It is a TSYS related code provided to POS for the user to enter when doing POS Authentication. |
Auth Factor | Numeric | It is the Merchant's 5 digits’ US Zip Code or 6 characters’ Postal Code relating to TSYS. |
Work Mode | Drop-down choice | There are four work modes: Retail/Master/Backup/Normal Normally when you have multiple machines in a room to share one POS ID for bank card transactions, you need to define one machine as the Master machine to own the POS ID and other machines will go through this one for bank communication. For security purposes, one Backup machine shall also be configured just in case the Master machine goes down. And all other remaining machines can be defined as Normal machines. If only one machine uses the POS ID for bank card transaction in this room, you can define it as Retail mode. |
Payment Types and Methods
In this section you can configure payment related parameters for your profile. Click the tab Payment Types and Methods to access this section and define the fields respectively. You can refer to table below for descriptions of the fields.
Field Name | Value Needed | Description |
Payment Method | Checkbox | At the present phase, 3 payment types are supported: Credit Card/Debit Card, Bill/Coin, and Cloud-Based Card. |
CR/DB Card Type | Checkbox | There are 5 options: VISA/Master Card/Discover/American Express/Interac. Check the one or ones you’d use on the terminal. |
Double Tap Delay | Numeric | You can ignore this field. It is the double tap of value card. Tap for the first time, you will see the card balance. You need to tap for the second time to confirm the payment. This parameter defines the time between the two taps. If the second tapping exceeds the time you set here, the terminal will return to idle screen. |
Auth Mode | Drop-down choice | This is the transaction type of the bank card. At present, only “Single” and “Pre-Auth” are supported. “Single” means the users pay for a cycle each time on a fixed amount. “Pre-auth” allows users to pre-authorize a specific amount, start the machine and pay till they terminate the machine. |
Pre Auth Amount | Numeric | N/A |
Site Code Check | Drop-down choice | To check whether the site code of cloud-based cards and value cards is in accordance with that of the machine profile. When it is enabled, the site code of the two shall be the same in order to start the machine, otherwise the machine won’t start. If it is disabled, all cards under the same vendor can start machines with any site codes. |
Save CCM Profile
After the parameters are configured, don’t forget to save the profile with the following steps otherwise the configurations will be lost.
1) Click on the drop-down menu of “Profile” and then select “Save Profile.”
2) Two text boxes will allow you to enter information for the Profile. Custom text is a searchable field for the profile. The Description text is for making relevant notes.
Note: It is best practice to use a standard naming convention in the custom text field to help you quickly find the correct profile.
3) Save the profile by clicking “Save.”
Set Up via KLM
After creating the profile on the Server, you need to inject the profile into the reader via KLM. Please follow the steps below to set up the reader.
|
|
|
|
|
|
|
|
|
Note: Please make sure the Machine Number matches the number on the machine. |
|
|
Note: Scan QR code should be recommended as the machine number may change as needed going forward. | |
| |
|
|
|
|
