In order to put the VC Touch kiosk into use, basic configurations must be performed on the server prior to any operation on the Kiosks. Please follow the instructions below to conduct server setup.
1. Location Management: Create Location & Room
Click “Location Management” on the right navigation menu. You will see two subsets: “Locations” and “Branch Management,” using which you will perform related configurations step by step.
Click the “Create Location” button in blue and you will see that the parameters needed for creating a location are summarized and divided into 4 subsets namely “Location”, “Options”, “Address”, and “Rooms”. You can toggle among the subsets by clicking the corresponding tab at the top of the page.
The subset “Rooms” is greyed out by default and will become editable after all necessary information in the subsets is completed.
1.1 Create Location
Click the input box of the fields under the location tab to define them respectively and then click the “Save” button on the upper-right corner.
You can refer to Table 2-1 for descriptions of the fields as needed.
Table 2-1
Field Name | Value Needed | Description |
---|---|---|
Location Name | Alpha-Numeric | The name of the Location will be displayed in the system. Length limitation is 40 digits. |
Site Code | Numeric | A six-digit Site Code for the Location which defines the value cards that can be used in the location. If you want value cards to be used between locations, use the same site code. If the Site Code you input is not 6 digits, e.g.,003, the webpage and Ultra will add leading zeros; e.g., 000003. |
Location ID | Alpha-Numeric | A unique Location Code that identifies the Location. You can use the auto-generated one by the system or define it by yourself. It must be different for every Location created in the system. Length limitation is 9 digits. |
Branch | Drop-down choice | Defines the branch that the location belongs to. One location can only be assigned to a single branch. Branches in the drop-down list are created in the “Branch Management” section. |
TID | Numeric | Short for Terminal ID. It is required that the TID be entered in one row; the duplicates in different rows will be merged as one. |
SRC Codes (Smartphone Registration Code) | Alpha-Numeric | SRC is used to link the apps/software that will be used on the Kiosk and KLM Mobile location to the system. When creating a location in the server, the SRC will be used to identify the location and route the end users to the correct system. Length limitation is 7 characters. You can use the auto-generated one by the system or define it by yourself. |
1.2 Options
Supported Payment Type
The fields under this section are not applicable to VC Touch kiosks at present stage and the default settings herein will not affect the functioning of the kiosks either so you can keep the default ones and skip this part.
Mobile App Options
Only one field in this section is related to VC Touch: Mobile App Options/Location Mode. There are two options for this parameter: Value or Credits. It is used to allow end users to do transactions with Value (Bill) or Credits (points) accordingly in this location.
Click the radio button of the options behind the Location Mode as needed.
Social Login
The fields under this section do not apply to VC Touch kiosks at the present stage and the default settings herein will not affect the functioning of the kiosks either so you can keep the default ones and skip this part.
Others
All required fields which are marked with red asterisks demand configurations otherwise the location information cannot be saved. You can move your mouse over the field name or refer to Table 2-2 below for descriptions of the fields.
The parameters defined herein are for the purpose of saving the location information only. If there is any difference between the settings defined here and those in the CCM profile, the latter will prevail.
When the Location Mode is set to Credit Mode, a table regarding the exchange rate between refill amount and its corresponding credits to get will be displayed at the bottom of the page for users to configure.
Table 2-2
Field Name | Value Needed | Description |
Language | Drop-down List | Only English is supported at the present stage. |
Maximum Top Up Amount ($) | Numeric | The maximum amount users can add at a time. The unit is dollar and the range is 0~99.99. |
Max Account Balance ($) | Numeric | Define the maximum account balance in the account. |
Card Price ($) | Numeric | The card cost charged from users for buying a card. |
Convenience Fee ($) | Numeric | An additional fee is charged for online transactions by vendors. |
Refill Account Amount Dropdown List ($) | Numeric | The refill amount options are displayed on the screen when adding value. |
1.3 Address
Fill in address-related information especially those marked with red asterisks in order to save the location. You can move your mouse over the field name or refer to Table 2-3 below for description of the fields.
Table 2-3
Field Name | Value Needed | Description |
---|---|---|
Province/State | Drop-down choice | Click and choose from the list of States available in the list. You may type the first few letters of your option to narrow the search. |
Address Line 1 | Text | Enter the address of the Location. |
Address Line 2 | Text | Enter additional address information if needed. |
City | Text | Enter the city of the Location. |
Postal/Zip Code | Alpha-Numeric | Enter the Zip code of the Location. |
Contact Name | Text | Name of the location creator or primary contact. |
Contact Phone Number | Numeric | Phone number of the location creator or primary contact. |
Contact Email Address | Text | Email address of the location creator or primary contact. |
Number of Units | Numeric | The amount of units/apartments in this location. |
Comments | Text | Descriptions or notes of the profile. |
1.4 Rooms
After all previous necessary information is completed, the Rooms section will become editable. Click the sub-tab Create Room under Rooms and define the fields as needed then click the Save button at the bottom of the page to keep the room information. You can refer to Table 2-4 below for description of the fields.
Table 2-4
Field Name | Value Needed | Description |
---|---|---|
Room Name | Alpha-Numeric | The room name that will be displayed in the system. This feature is not supported at present stage for AVU Touch kiosks. |
Room# | Numeric | Customize the room number. There should not be repeated numbers in one location. Range is 1~500. |
Machine Number Range | Numeric | This parameter is used to limit a range of numbers for machines in your room. Range is 1~255. |
The Branch Management section as shown below is not applicable to the VC Touch kiosks at present stage so you can skip this part during deployment.
2. Create Staff
You can create a staff account for the management of the kiosks or the admin menu of the tablet installed on the kiosks via the server system. Follow the steps below to create a staff account and you can refer to table 2-5 for descriptions of the fields to configure.
1) Click User Management/Staff to enter this section.
2) Click the Create User button and fill in the information needed for the staff account and click the “Save” button at the bottom to save the information. You can refer to the table 2-5 below for descriptions of the fields.
The field Location Assignment is not applicable to AVU Touch kiosks at present stage so you can ignore it and keep the default choice.
Table 2-5
Field Name | Value Needed | Description |
---|---|---|
First Name | Text | Enter the first name. |
Last Name | Text | Enter the last name. |
Username | Text | Enter the username that will be displayed in the system. |
Text | It will be used to log in to the server system and the admin menu of the tablet installed on the AVU Touch kiosk. An email containing password for login will be sent to this email address. | |
Role | Drop-down list | Select one or more roles for the staff. The role/roles you’ve selected are created in advance by the Server Owner Admin account in the Role Management section. Note: You can see the detailed permission information for the role/roles by clicking the “See Permission” button in blue on the right. The permissions for roles are defined in advance by server owner admin accounts in the process of creating roles. |
3. Create CCM Profile for VC Touch Tablet
A special CCM profile is designed for the VC Touch tablet. Go to Server>CCM>Profile Builder to create the CCM profile for the tablet.
Click on the tab Universal>Universal AVU to configure the profile from the following aspects: Location, Machine Profile, Audio Visual, Price and Configuration, Data and Processing, Payment Type, and Methods.
3.1 Location
Click on the tab Location to enter this section and define the parameters as needed. You can refer to Tables 2-6 for descriptions of the fields.
Table 2-6
Field Name | Value Needed | Description |
---|---|---|
Location ID | Alpha-Numeric | To select a certain location that is created in Location Management>Create Location. |
Room# | Numeric | To enter the room number that is created in Location Management-Rooms. |
Site Code | Numeric | When a certain Location ID is selected, the corresponding Site Code will be automatically matched. |
3.2 Machine Profile
Click on the tab Machine Profile to enter this section and define the parameters relating to the machine. You can refer to table 2-7 for descriptions of the fields.
Table 2-7
Field Name | Value Needed | Description |
---|---|---|
AVU Type | Drop-down Choice (AVU Touch 21”/ AVU Touch 17”) | Defines the machine type for which you are creating the profile. |
Card Mode | Drop-down Choice (Value Card/ Cloud-based Card/ Value & Cloud Card) | Setting the card mode is mainly for the Ultra VXT to recognize & read the card when a user taps card on it. The default value is Value & Cloud Card. |
Machine Number | Numeric | The range limit is between 1-255. This information can be used for cash collection. |
Machine ID | Text | The range limit is within 20 characters. It cannot be empty. This information can be used for cash collection. |
3.3 Audio Visual
Click on the tab Audio to enter this section and define the parameters as needed. You can refer to Table 2-8 for descriptions of the fields.
|
Table 2-8
Field Name | Value Needed | Description |
---|---|---|
Background Image | Upload image | Users can upload background image for the kiosk tablet to display. Image standard for AVU Touch 21: Image standard 1920 x 1080 px; Image Format: .jpg or .png; Image Orientation: Horizontal; Image Size: Less than 500 KB. Image standard for AVU Touch 17: Image standard 1280 x 1024 px; Image Format: .jpg or .png; Image Orientation: Horizontal Image; Size: Less than 500 KB. |
Vendor Logo | Upload image | Users can upload vendor logo for the tablet to display at the top-left corner. Image standard 400 x 100 px; Image Format: .jpg or .png; Image Orientation: Horizontal Image; Size: Less than 500 KB. . |
3.4 Price and Configuration
In this section you will perform price-related configurations from 4 aspects: Basic Configuration, Price Configuration, Cash Configuration and Dispenser Configuration. You may define the parameters based on your practice, referring to the explanations in the tables as needed.
Click on Price and Configuration tab to enter this section.
Basic Config
Click on Basic Config tab to define the basic settings relating to price configuration. You can refer to table 2-9 for description of the fields.
Table 2-9
Field Name | Value Needed | Description |
---|---|---|
Display Timeout (s) | Numeric | Defines the time length to display a specific page when there’s no operation performed. The screen display will return to the Idle Screen after the timeout defined herein. Default value is 60 seconds. |
Cash Timeout (s) | Numeric | Defines the time length allowed for users to insert each cash. It will return to the page of payment options if no bill is inserted within the time defined. Default value is 60 seconds. |
Service Call | Numeric | Defines the help desk phone number displayed on the idle screen. Default value is set as 123-456-7890. |
Email Receipt | Drop-down Choice (Enabled/Disabled) | Defines whether users can receive a receipt of payment details after buying card(s) or adding funds on VC Touch. |
Price Config
Click on the tab Price Config to enter this section and define the parameters relating to amount display for refilling and pricing. Please see table 2-10 for description of the fields.
When a Loyalty Program is enabled for the location, the amount related options defined in the Program will prevail over the display options defined herein.
The value defined herein must be a full dollar amount as being the integer multiple of 100 cents. 50 cents or its odd multiples are not supported otherwise it will lead to failure of cash collection.
|
|
Table 2-10
Field Name | Value Needed | Description |
Amount 1/2/3/4/5/6 (cent) | Numeric | Defines the refill amount options displayed on the screen when adding funds. Default values are set as 500, 1000, 1500, 2000, 2500 and 3000. Unit is cent. |
Amount 1/2/3/4/5/6 (credit) | Numeric | Defines the equivalent number of credits for the corresponding refill amount. 10 cents equal to 1 credit by default. |
Card Price | Numeric | Defines the cost per card charged from users and can be set as 0. Default value is set as 100. Unit is cent. |
Max Card Balance | Numeric | Defines the maximum value stored on each value/cloud-based card. A message “Card Balance Can Not Exceed $ amount defined” will prompt when the card balance exceeds the defined amount during refill. Default value is set as 9999. |
Cash Config
Click on the tab Cash Config to define related fields. Please see table 2-11 for description of the parameters.
Table 2-11
Field Name | Value Needed | Description |
---|---|---|
Max Cash Collect Qty | Numeric | Defines the maximum quantity of the notes (bills) that the bill acceptor can store. If the notes in the bill acceptor already reaches the Max quantity, when a user tries to insert another note, the bill acceptor will reject and return it to user. Meanwhile, the tablet will send the vendor (as defined in Vendor Portal/Settings/Help Desk Information) a reminder email for cash collection. Default value is set as 25. |
Cash Collect Threshold (cent) | Numeric | Defines the amount that will trigger the tablet to send a reminder email of collecting the cash to the vendor email (as defined in Vendor Portal/Settings/Help Desk Information). Default value is set as 5000 and unit is cent. |
Supported Cash Type ($) | Numeric |
Denomination $2 is not supported presently. |
Dispenser Config
Click on the tab Dispenser Config to define the parameters relating to the dispenser used. You can refer to table 2-12 for descriptions of the fields as needed.
Table 2-12
Field Name | Value Needed | Description |
---|---|---|
Card Counter | Numeric | The maximum capacity of one card dispenser. Capacity range is 0~350. Default value is set as 350. |
Low Card Level | Numeric | When the value of Card Counter deducting the cumulative dispensed card quantity reaches Low Card Level value defined herein, a notification will be sent to vendor’s help desk email account. |
Dispenser Type | Drop-down Choice (Single/Dual) | Defines the quantity of the card dispenser(s) equipped for the Kiosk. |
Combine Buy & Add | Drop-down Choice (Enabled/Disabled) | Defines whether to combine the process of buying the card and adding value into one step load. If it is enabled, after the user selects the card quantity to buy, the process will go to the adding value section directly before dispensing the card. Otherwise, the kiosk will only charge the user for the card cost defined and dispense an empty card. Default value is set as enabled. |
Buy/Add Multiple Cards | Drop-down Choice (Enabled/Disabled) | Defines whether to allow users to purchase multiple cards at a time. Default is set as enabled. |
Buy/Add Max Card Qty | Numeric | Defines the maximum card quantity that users can purchase at a time. It will be greyed out if the Buy/Add Multiple Cards is set as disabled. |
3.5 Data and Processing
Click on the tab “Data and Processing” to define data-related parameters. You can refer to table 2-13 for description of the fields.
Table 2-13
Field Name | Value Needed | Description |
---|---|---|
Data Upload Time | Drop-down Choice | Defines the time for the tablet to upload transaction-related data and download the updated VC Touch software (if any) on a daily basis. |
Data Upload | Drop-down Choice (Enabled/Disabled) | Determines whether to upload transaction-related data to the server. |
Washboard Upload Port | Numeric | It is used to define the upload port. |
3.6 Payment Types and Methods
Click on the tab Payment Types and Methods to define payment options supported. Tick the checkbox behind the payment option to enable it and the checkbox will turn to color blue. Ticking it again will disable the payment option selected.
Save the Profile
1) After all parameters are configured, click 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.
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”. A message for saved profile will pop up on the page.
If an VC Touch profile has been established for a location in Value Mode, and you want to switch the location to Credits Mode, the corresponding VC Touch profile needs to be created from the beginning instead of modifying the existing one and saving as new for the Value Mode. Otherwise, system errors may occur.
Similarly, you cannot edit one VC Touch profile created for a location in Value Mode then save it for another location in Credits Mode.
In conclusion, when it involves location mode change, the profile for VC Touch Tablet needs to be created completely from step 1 in this chapter rather than loading an existing one and modifying it.
4. Create CCM Profile for Ultra VXT
The two setup menus marked in red are the items we need to configure in this section: Site Data and Machine Data. These are used to configure the data that will be programmed onto the reader.
You can access this section via Vendor portal>CCM>Profile Builder
4.1 Site Data
Site Data contains the parameters needed for configuring the reader site codes, location information, payment options, etc.
Click the tab Site Data then all fields under the tab will be displayed. Define the parameters accordingly and you can refer to table 2-14 for description of the fields.
Table 2-14
Field Name | Value Needed | Description |
---|---|---|
Location ID | Alpha-Numeric | To select a certain location that is created in Location Management>Create Location. |
Room# | Numeric | To enter the room number that is created in Location Management-Rooms. |
Double Tap Timeout | Numeric | Default as 0. |
Site Code | Numeric | When a certain Location ID is selected, the corresponding Site Code will be automatically matched. |
Machine # | Numeric | Not applicable to this product. When the reader profile is configured in KLM, the Machine# will be filled out. |
Screen Rotation | Drop-down Choice (0/90/180/270 degrees) | Not applicable to this product. When the Ultra VXT reader is installed in a rotated position other than the upright one by default, this parameter should be defined accordingly so the screen display is readable to users. |
Ignore Site Code | Check Box | Not applicable to this product. It decides whether to verify the site code of the cloud-based card/value card used by customers. If it is checked, then the cards mentioned can be used across different sites under the same Vendor. If it is not checked, the site code of the card has to be consistent with that of the reader equipped for the machine. |
Non-Network Mode | Check Box | Not applicable to this product. |
Card Holder Mode | Check Box | Not applicable to this product. |
Hide Machine # | Check Box | Not applicable to this product. |
Payment Options | Check Box | Determines the payment option icons to be displayed at the bottom of the Ultra VXT reader. Tick credit card/debit card for the product. |
CR/DR Card Type | Check Box | Select the specific CR/DR card icons that will display on the reader. This field is required when “Credit Card/Debit Card” is selected as the “Payment Options”. |
4.2 Machine Data
Machine Data is a multi-level drop-down menu which contains all the parameters of specific machine types for configuration. A profile needs to be created for each type of machine at a location.
Click the tab Machine Data>KioSoft>Ultra API then all fields under the tab will be displayed. Define the parameters accordingly and you can refer to table 2-15 for description of the fields.
Table 2-15
Field Name | Value Needed | Description |
---|---|---|
Upload Reports | Drop-down choice (Enabled/Disabled) | This parameter is used to control if terminal should upload report to the server Default value is enabled. |
Machine Type | Drop-down choice | Select AVU Touch for AVU Touch kiosks. Available options include Vending, Redemption, Car Wash, Coffee Machine, High Way, AVU Touch and Cash Register. |
Vendor Logo | Upload Image | Will be displayed on the top-right of the reader idle screen. Image Format: .jpeg .jpg or .png; Image Size: Less than 500 KB. |
Customer Logo | Upload Image | Will be displayed at the center of the reader idle screen. Image Format: .jpeg .jpg or .png; Image Size: Less than 500 KB. |
Background Theme | Drop-down choice (Light / Dark) | The background theme for the reader. |
Screen Title | Text |
|
Sub Screen Title first line | Text | The 1/2 line of the text displayed when making payment. |
Sub Screen Title second line | Text | The 2/2 line of the text displayed when making payment. (see picture above). |
4.3 Save the Profile
1) After all parameters are configured, click 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.
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”. A message for saved profile will pop up on the page.
5. Create CleanReader Ultra Data for Ultra VXT
Click on CleanReader Ultra Data and create the record for each reader that needs to be deployed.
1) Choose “CleanReader Ultra Data” in the navigation menu, click “Add” to set up a new CleanReader Ultra Data or input a few characters to select existing one for editing.
2) Configure the parameters below according to your requirements, then click “Save” or “Save as new”. Please refer to the Table 2-16 for a description of the fields required to create the Ultra data.
Table 2-16
Field Name | Value Needed | Description |
---|---|---|
Location Code | Numeric | The Location ID that’s assigned to you when you create a Location. |
Room# | Numeric | The Room # when you create the room. But if you don’t create the room, please fill in 0. |
Work Mode | Fixed Value | Ultra readers will use Retail work mode. |
Customer Text | Alpha-Numeric | The suffix of the Ultra Data name displayed in the system; no length limitation. |
Washboard Address | Alpha-Numeric | The URL of the Report Server |
Ultra Transaction Type | Drop-down choice (Pre-Authorization / Single Authorization | Not applicable to this product. |
HCS POS | Text | Fill in according to customer’s actual situation |
HCS Auth Code | Text | |
HCS Auth Factor | Text | |
Pre-Authorization Amount | Numeric | Not applicable to this product. |
Reboot Time | Drop-down choice | Choose a time for the daily reboot of the reader. |
Washboard Upload Port | Numeric | The port of the Report Server. |
Washboard Upload Time | Drop-down choice | The settlement time of the Ultra reader. Please change this field from default 12am to 6pm. |
Ultra Work Mode | Drop-down choice (Master, Backup, Normal, Retail) | Select Retail for this product. |
Ultra Coin Support | Drop-down choice (ON / OFF) | Select OFF for this product. |
Ultra Coin Timeout | Numeric | Not applicable to this product. One unit per minute. This is the time a coin transaction is valid after inserting coin. Supports 2-9. |
Ultra Offline Mode | Drop-down choice (ON / OFF) | Select OFF for this product. If you choose ON, the Ultra will still work after it is offline. |
Offline Washer Use | Numeric | Not applicable to this product. The maximum times a card can be used on the washer in offline mode. |
Offline Dryer Use | Numeric | Not applicable to this product. The maximum times a card can be used on the dryer in offline mode. |
Max Card Use Offline | Numeric | Not applicable to this product. The maximum times a card can be used in offline mode in this Room. |
WIFI SSID | Alpha-Numeric | The WIFI SSID of the router. Must be exactly the same as the WLAN WIFI SSID in router’s setup. |
Label ID | Numeric | The Machine # that will be used when you setup the reader by KLM. |
6. Upload APK for Remote Upgrade
The VC Touch software installed on the kiosk can be updated automatically with Remote Upgrade.
To achieve this function, first, the APK-format software of the newest version shall be uploaded via the route Server Vendor Portal > Settings > AVU Touch Remote Upgrade.
Next, click the blue button “Browse Files”, and locate and select the APK to upload the newest software. Input the version number of the software then click “Save changes” in green right below the field.
Do not leave this page before the changes are saved successfully.