General Deployment Process

Prev Next

This document introduces the general process for deploying the Elevate Card-D. 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.


Section 1 Profile Builder

After clicking the CCM section as stated above you will enter the Profile Builder of CCM by default. You can also click the Profile Builder on the navigation menu as shown below for entry if it is presented otherwise.

In Profile Builder, you can communicate with the machines, which is the major focus of this chapter. There are also other function buttons displayed under the Action tab located at the upper-left corner of the screen; these actions including making cards, reading cards, and programming CleanReader will be elaborated in later chapters.

We provide two different ways to build the CCM profile:  

(1) through the combination of Site Data and Machine Data and (2) through the Universal tab.

You can refer to the guidance below to choose the proper way that fits the product.

After the parameters under Site Data + Machine Data or Universal are configured, don’t forget to save the profile with the following steps otherwise the configurations will be lost.

1) Click dropdown 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”.


Section 2 Site Data

Site Data contains the parameters of the site where the product is to be deployed, such as site code, location information, payment options, etc. Follow the instructions below to configure the parameters for that site.

Click “Site Data” then all fields to configure will be displayed. Please define the fields one by one and you can refer to table 4-1 below for descriptions of the fields.

The Location ID and Site Code defined herein should be same as the Location ID and Site Code that you created on Vendor Portal.

Field Name

Value Needed

Description

Location ID

Alpha-Numeric

To select a certain location that is created in Location Management>Create Location.

You can enter keyword of the location name to narrow down the display list.

Room#

Numeric

To enter the room number that is created in Location Management-Location-Rooms.

Double Tap Timeout

Numeric

This value is set for the laundry cards that require double taps to make transactions when starting a machine. If the time interval between the two taps exceeds the value defined here, the transaction will be terminated.

The default value 0 means double tap is not required to start a machine.

Site Code

Numeric

When a certain location is selected, the corresponding Site Code will be automatically matched.

Machine #

Numeric

Keep the default settings here.

When the reader profile is setup in KLM, the Machine# will be filled out.

Screen Rotation

Dropdown Choice (0/90/180/270 degrees)

This field applies to Ultra LX Series only.

When the Ultra LX Series reader is installed in a rotated position other than the default upright one, this parameter should be defined accordingly so the screen display is readable to users.

Ignore Site Code

Check Box

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

When it is checked, WiFi based functions will be disabled so the reader won’t upload any report.

Card Holder Mode

Check Box

This field applies to Prime Connect Select and Elevate Card Connect reader of Laundry market only.

When it is checked, unlike the single-tap or double-tap cards, customers need to hold the laundry card to the reader until the machine is started.

Hide Machine #

Check Box

This field applies to Elevate Card Connect reader.

When it is checked, the reader will not display Label ID.

Payment Options

Check Box

Select the payment options to be supported.

CR/DR Card Type

Check Box

Select the card icons to be displayed on readers. This field is required when “Credit Card/Debit Card” is selected as the “Payment Options”.

Converter Reader Type

Dropdown Choice

Unused.


Section 3 Machine Data

Click the tab Machine Data then you will see different types of machines displayed. This multi-level menu will lead you to the specific machine type that you are going to configure as you are selecting the corresponding tab. When you see the fields of the machine parameters are displayed, you can define them one by one to build up the machine related data.

At the present stage, Alliance, Maytag, ADC, Whirpool, Wascomat, LG, CommonPulse, Girbau, Domus/Fagor can be configured with the profile correspondingly, while the Dexter or e-Drop series cannot be supported at the present phase, whose profiles won’t take effect even though the parameters can be saved successfully.

Most common laundry machines are supported by the system. Different machines have their own work mode therefore the parameters to be configured vary depending on the machine models. You need to locate the exact machine to be configured in the multi-level menu then define the fields as needed. Despite of the variety of machine models, the laundry-related parameters to configure are simple to understand so this chapter will not go over the details of the laundry machines one by one. You can move your mouse over to the fields for their descriptions to facilitate your understanding.


Section 4 Universal > Universal Pulse

The Universal pulse profile is developed to consolidate multiple pulse profiles from different markets into a single profile on the server.

With the Universal Pulse profile, users of the management system will be free from accessing multiple profiles on multiple servers. Instead, they can configure and control multiple types of pulse and electromechanical devices with a single profile 

Click Universal>Universal Pulse to enter this section. You will see 7 sub-tabs and each of the 7 tabs will be introduced in the following content.  

图片 1, Picture 

 

 

Location 

After you click the tab Universal Pulse, the content of Location will be displayed by default. If it presents otherwise, you can click the tab Location to enter this section. Fill in the values for Location ID, Room ID and Site Code respectively. For your reference, explanations of the fields are provided in the table 4-112 below. 

Make sure values set up herein shall be in accordance with those configured previously in Location Management.

 

图片 1, Picture 

 

Field Name 

Value Needed 

Description 

Location ID 

Dropdown choice 

A unique Location Code that identifies the Location.  

E:\task\参考文档\Snipaste_2023-05-11_14-31-54.png, PictureClick the input box then a dropdown menu containing the locations created will be shown. You can input the key word of the desired location and as you are inputting the searching results will narrow down to match the key word. 

Room ID 

Numeric 

Input the desired Room number. 

Site Code 

Numeric 

A six-digit Site Code for the Location. Input the desired Site Code. 

 

Machine Profile

Machine Profile allows users to define the machine-related parameters. Click the tab to enter this section for configurations. 

图片 1, Picture 

Machine Category 

This field is frequently used in Amusement market and for products of other markets, you can also configure this field based on your actual needs.

Click on the Machine Category box and enter one or more characters to easily select the category that your machine belongs to. 

图片 23, Picture 

If there is no existing machine category, you should click “Machine Management”> “Machine Category” on the navigation bar as marked with the red box and enter the page below to create a new machine category. In this page, you can enter the machine category name and configure the color effect for this category (for details of color effect fields, please refer to the section Audio Visual>Color Effect). Click on Create to save the profile. As soon as one of the created machine categories is selected in the Machine Profile, its effects configured will be auto-populated into its Audio Visual tables.

图片 1, Picture  

图片 1, Picture 

You could also edit or delete the existing categories by clicking the “Edit” and “Delete” buttons in the machine category list. 

图片 1, Picture 

 

 

Machine Name 

This field is frequently used in Amusement market and for products of other markets, you can also configure this field based on your actual needs.

Click the Machine Name box and the drop-down list of names belonging to the category you selected in the “Machine Category” section will be displayed. You could enter keyword of the machine to narrow down the list and click from the list to choose the desired machine. 

图片 1, Picture 

If there is no existing name of the category you select, you could click “Machine Management”> “Machine List” on the navigation bar as marked with the red box and enter the page to create a new machine name. Enter your machine name in the input box, select the category and click “Create Machine” button in blue to create a new machine name. In this way, you can create a machine list for a single category. You can also edit or delete the existing machine names by clicking the “Edit” and “Delete” buttons.

图片 1, Picture 

图片 1, Picture 

图片 1, Picture 

图片 1, Picture 

 

Machine Type 

Click on the Machine Type box, the drop-down list will be displayed. There are 9 options available in the list but at present stage, the supporting functions are developed for the following machine types: Custom, Washer, Dryer and Amusement.

At the present stage, the Door Access, Donation, Air Vac, Vacuum and Car Wash are not supported by Elevate Card-D. They can be selected from the drop-down but won’t take effect for use.

图片 36, Picture 

The machine type you select shall match with your machines and will be displayed on the reader screen and the reports delivered to you. See the picture for the reader display when “Washer” is selected as the machine type. 

图片 1166042679, Picture

You can also name your own machine by selecting “Custom” and follow the steps in Channel 1 Name of Audio Visual for customized machine type. 

Hardware Interface 

There are five types of hardware interfaces available in the drop-down menu of “Hardware Interface”. Select the one applicable to your machine accordingly. You can refer to table  for explanations of the interfaces. 

At present stage, Coin Monitor and Gameboard Version2 are not supported by the Elevate Card-D. They can be selected from the drop-down but won’t take effect for use.

 

图片 45, Picture 

 

Field Name 

Description 

Amusements Game Board 

This interface generally matches with amusement related machines and devices. 

Retail Pulse Board 

This interface is applied to machines that require a special interface not supplied by the interface built into the reader. 

Laundry Signal Board 

This interface is mainly applied to Dexter machines. 

None 

All other devices not requiring one of the above interfaces shall choose this interface. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureFor Air Vac, Vacuum and Car Wash, if the pulse output type needs to be selectable (to be configured in the tab Pulse), the Hardware Interface option herein shall be defined as None. 

Coin Monitor 

This interface is applied to Air Vac, Vacuum and Car Wash. When you select any one of these three machines as the machine type, “Coin Monitor” will be one of the selectable options in the Hardware Interface. If Coin Monitor is selected, the field for Pulse>Output Type will automatically be set as Relay Pulse.  

 

Pocket Configuration 

If “Retail Pulse Board”/ “Laundry Signal Box” is previously selected as the Hardware Interface, the field of Pocket Configuration will become editable. There are three options in the drop-down list: Single, Shared and Dual. Click on the option box and select the one that fits your machine. You can refer to the explanations below for the configuration. 

图片 52, Picture 

 

Field Name 

Description 

Single 

This option fits for the conditions when a reader controls one machine. 

Shared 

This option applies when a reader controls two machines (typically stack machines) with a single source of payment and control. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureElevate Card Connect is not supported. 

Dual 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureWhen a reader controls two machines (typically stack machines) with independent payment and controls, this option shall be applied. 

Elevate Card Connect is not supported. 

 

Pocket Price 

When “Shared” or “Dual” is previously selected for Pocket Configuration, you need to define the settings for its price in “Pocket Price”. 

Click on the option box after “Pocket Price” then you will see two options in the drop-down list—Same & Independent—select the one fits your machines. You can refer to the table below for descriptions of the options. 

If “Independent” is selected as the Pocket Price option for the machine, then you should refer to For Machine with Independent Pocket Price when it comes to the next step of configuration under “Products, Price and Timing” section. The structure of “Products, Price and Timing” section for machines with independent pocket pricing is different from that of the other machines.

图片 1, Picture 

Field Name 

Description 

Same 

The two machines controlled by the same reader shares the same pricing. 

Independent 

The two machines controlled by the same reader has different pricing, which needs to be configured separately in later steps under the section of “Products, Pricing and Timing”. 

Reader Mode 

It is used to allow end users to do transactions with Value or Credits accordingly in the location selected.

At the present development stage, only “Value” mode is assceesible to the Elevate Card-D.

When the Location Mode is defined in the Location Management section, the Reader Mode will be synchronized to the same definition. 

图片 97, Picture 

Special Mode 

Special Mode is designed to provide promotion solutions to customers. It is available for Basic, Incremental and Multi-Price whose details will be introduced in Products Price and Timing. 

Special mode is disabled as default. When it is disabled, its related parameters will not be displayed. When it is enabled, a drop-down menu as shown in the below picture will be displayed. 

-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. 

-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 & Days of Week sections. 

图片 1, Picture 

 

Special Type 

Click the option box beside the Special Type parameter, a drop-down list marked with red box will be displayed as shown. 

-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. 

-Discount Percentage allows you to define the special price in discount off method. For example, in a “Value” reader, if original price is set as $2.00, discount is set as 30, then in the selected day/time, the machine will charge in $1.40 per play. 

The Special Type selected here will affect the parameters of special pricing to be configured in the section of “Products, Price and Timing”.

图片 1, Picture 

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 Start/End Time parameter and a drop-down electronic clock will show. It allows you to select start time and end time directly. 

图片 1, Picture 

1) Press Hour dropdown list, user can select a specific hour from 01 to 12; 

2) Press Minute dropdown list, user can select a specific minute from 00, 05, 10… 

50, 55 and 60, every 5 minutes as a time. 

3) Press AM/PM icon on the right side, user can switch day/night. 

There is no confirm button. Once the start/end time is selected, the period is defined and the option box displays the selected period automatically. Press the option box or anywhere else on the screen can withdraw the dropdown electronic clock.

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. 

图片 1, Picture 

 

1) Calendar will display 2 recent months as default and allow you to select date across months. 

2) Start date and end date will be highlighted in deep blue color while period between them will be light blue color. 

3) You could press < or > icon on the top of calendar to change the month. 

There is no confirm button. Once the start day and end day are selected, the period is defined and the option box will display the selected period automatically. Press the option box or anywhere else on the screen can withdraw the dropdown calendar.

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. 

图片 1, Picture 

Show Cash Price (Special Mode) 

This field is displayed only when the special price function is activated. You can select “Enable” or “Disable” for this field. If “Enable” is selected, the original price and the special price will be alternatively presented on the reader as shown below. And if “Disable” is chosen, only the Special Price will be displayed. 

Original Price 

Special Price 

图片 252067444, Picture 

图片 248029645, Picture 

Audio Visual

The features in Audio Visual tab allow users to configure the display on the reader. 

Click on Audio Visual tab to enter this section to define the audio and visual related parameters.  

图片 1, Picture 

 

VXT Display Mode  

Click the option box beside the VXT Display Mode parameter and a drop-down list will be displayed. The prices are displayed on the reader in two ways, i.e., Linear and Multi-price. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureIn addition to Ultra VXT Series, this feature also supports Ultra LX Series now. 

图片 1, Picture 

 

-If you select Linear, there is only one price displayed in the center as shown in the picture on the right. You could click the < or > to toggle the price shown. 

图片 1207063718, Picture

 

-If you select Multi-Price, four prices will be displayed on one page. You could click < or > to toggle to another price page. 

图片 57, Picture

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureFor Ultra LX Series, when the price options are no more than 4 in number, the price options will be displayed in the form of Multi-Price; however when there are more than 4 options, they will be displayed linearly as in the Linear Mode. 

 

Hide Machine # 

This feature applies to Ultra LX Series and Ultra VXT Series reader. 

图片 409973007, Picture 

This parameter defines whether to hide the machine type and machine number displayed at the lower-left corner of the reader screen.  

Click input box of “Hide Machine #” and select Enable/Disable as needed. If it is enabled then the machine type and number will be hidden and vice versa.  

图片 1, Picture 

Screen Rotation 

The Elevate Card - D doesn’t support the customization of screen rotation at the present stage.

Low Power Mode (Shallow) & Low Power Timeout  

The Elevate Card - D doesn’t support the configurations of low power mode at the present stage.

Vendor Logo 

The Elevate Card - D doesn’t support the customization of vendor logo at the present stage.

Customer Logo 

This feature is not supported at present stage. 

The Customer Logo displays on the middle screen of the reader’s idle screen. Click “Upload Image” button then choose the logo you would like to display from your local storage. 

图片 1, Picture 

Color Effect

The  LED effects under “Color Effect” is not supported at the present stage.

Idle Screen Title 

You could customize the idle screen title by entering the content you desire in the input box beside the Idle Screen Title parameter. 

图片 1, Picture 

图片 67, Picture 

The title will be displayed on the top of the reader as marked with red box.  

 

图片 431537589, PictureSpecial Mode Idle Screen Title 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureThis feature applies to Ultra LX Series and Ultra VXT Series readers. 

This field defines the text displayed on the top of the reader idle screen for Special Mode (“Tap for Special” in this case).  

Click on the input box of “Special Mode Idle Screen Title” and input the content you would like to display on the reader for promotion. 

图片 1, Picture 

 

Channel 1 Name 

When “Custom” is previously selected as the Machine Type in Machine Profile, the Channel 1 Name field will become accessible for customization. Otherwise, the field will not be displayed. The customized channel name will also be displayed on the readers or reports. 

图片 499953884, Picture 

图片 395058313, Picture 

 

Channel 2 Name 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureElevate Card Connect is not supported. 

 

When “Retail Pulse Board” is selected for “Hardware Interface” and “Shared” or “Dual” is selected for “Pocket Configuration” in Machine Profile, you need to name the Channel 2 for your machine. This customized channel name like “Channel 1 Name” will be displayed on the readers or reports as well. See the picture for the reader display when both channel names (channel 1 & 2) are customized as “Lower” & “Upper” respectively. 

图片 1437216836, Picture图片 1171221001, Picture 

Products Price and Timing 

There are three types of configurations for the Products Price and Timing which are the configurations for generic machines, for machines with Independent Pocket Price and for machines with Count Up mode. You can refer to the corresponding section according to the machine conditions. 

Click the tab Products Price and Timing to enter this section. 

图片 1, Picture 

 

a. Generic Type 

Most machines share the same section of “Products, Price and Timing” in terms of structure and layout. There are three categories under this section namely “Basic”, “Incremental” and “Multi Price”. You can look through all the three combinations and see which one fits your machines. 

Products Price and Timing - Basic Mode

In Basic mode, you can define the fields of Price, Pulses to Start, Run Time, Top off, Top Off price, Pulses to Top Off, Top Off Run Time, Coin Value and Mix Tender Transaction for your machine. If Special Mode is enabled for promotion purposes, special price related parameters are also available for configurations. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureClick “Basic” and input the parameters accordingly. You can refer to table 4-17 below for descriptions of the fields. 

  •      Only Basic Mode supports Relay ON Output Type, which will be configured later in Pulse section. 

  • Parameters related to Top Off are preliminarily set for dryers but they can also be configured for other machines in need of such configurations. 

  • 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. 

Elevate Card supports “Free Play” mode. If you wish to enable it, you should enter “0” in the field "Special Price” (if Fixed Amount has been selecte as the special type) or “Discount” (if Disocunt Percentage is selected as the special type).

When “Fixed Amount” is selected as the “Special Type” 

图片 1, Picture 

When “Discount Percentage” is selected for “Special Type” 

图片 1, Picture 

 

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 

The length of time applied to each cycle. Unit is minute. Range is 0~65535.  

Top off 

Drop-down choice 

(Enable/Disable) 

Defines whether to allow top off on dryer machines. 

Top off Price 

Numeric 

Amount needed for each top off. Unit is cent. Range is 1~99999. 

Pulses to Top Off 

Numeric 

The quantity of pulse needed for each top off. Range is 1~200. 

Top Off Run Time 

Numeric 

The length of time applied to each top off. Unit is minute. Range is 1~65535. 

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 Top off Price 

Numeric 

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  

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) 

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. 

The default value is “Enabled”. 

This field is not applicable when Amusement Gameboard or Retail Pulse Board is selected as the Hardware Interface in Machine Profile. 

 

  1. “Incremental” mode and “Multi-Price” mode will not supported by Elevate Card-D at the present development stage.

b. For Machine with Independent Pocket Price 

If the Pocket Configuration is “Dual” or “Shared” and Independent Pricing is selected as the Pocket Price in Machine Profile, the parameters relating to “Products, Price and /Timing” shall be configured independently under the section of “Lower Pocket” and “Upper Pocket” though the parameters themselves aren’t of much differences compared with those of Generic Type previously mentioned. And when Special Mode is enabled for promotion purposes, special price related parameters are also available for configurations. 

Click on the tab “Products, Price and Timing” then the tabs of “Lower Pocket” and “Upper Pocket” together with their second-row tabs “Basic” “Incremental” and “Multi Price” will be displayed.  

图片 717053778, Picture 

Click on “Lower Pocket” first to enter the configurations then select the proper price mode among Basic/Incremental/Multi Price for your machine. For detailed descriptions regarding Basic/Incremental/Multi Price, please refer to the corresponding chapters by clicking the linked chapter title respectively. The same process applies to the “Upper Pocket”. 

图片 1, Picture 

 

Pulse 

The display of “Pulse” section is determined by the field “Hardware Interface” of “Machine Profile” section. 

There are 5 options for the current phase in the “Hardware Interface” field: “None”, “Amusements Game board”, “Retail Pulse Board”, “Laundry Signal Box” and “Coin Monitor” as introduced in Universal Pulse → Machine Profile. And the displays of Pulse for the 5 options mentioned can be summarized into the following 3 scenarios. 

Since “Coin Monitor” and "“Gameboard Version2” are not supported by Elevate Card-D at present, the configuration of Pulse relative to these two hardware interface will not be involved in this section.

a. For Hardware Interface: None& Laundry Signal Box

If you select “None” or “Laundry Signal Box”  for the “Hardware Interface” field, the “Pulse” section will be displayed as in below picture. Please refer to table below for detailed descriptions of the fields. 

图片 1, Picture 

 

Field Name 

Value Needed 

Description 

Output Type 

Dropdown choice 

Four types could be selected:  

No Pulse/Coin Pulse/Relay ON/Relay Pulse. 

The selection here should be based on your machines.  

“No Pulse” is not supported at present. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PicturePlease note that when “Coin Monitor” is selected as the “Hardware Interface”, “Relay Pulse” is automatically selected as the Output Type. 

Pulse Polarity 

Dropdown choice 

This parameter refers to the idle state of the output pins. There are two options: Idle Open/Idle Close. 

Relay On Time 

Numeric 

As the field name suggests, it is only applicable when the “Output Type” is “Relay On”. The unit is selectable, being minute or second. 

Output Pulse Gap 

Numeric 

The gap between pulses whose unit is millisecond. (Default: 100ms). 

Output Pulse Duration 

Numeric 

The duration of the pulse whose unit is millisecond. (Default: 50ms). 

Available Signal 

Dropdown choice 

This parameter determines whether the terminal could detect the signal of the machine. You should select from the three options: Disable/Low/High depending on your machines. 

 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureWhen “Relay On” is selected in the “Output Type” field, only “Basic” mode is supported in the “Products, Price and Timing” section. 


b. For Hardware Interface: Amusements Game Board 

If you select “Amusements Game board” in the “Hardware Interface” field of Machine Profile, the “Pulse” section will be displayed as in below picture. Please refer to table 4-22 for detailed descriptions of the fields. 

图片 330033509, Picture 

 

Field Name 

Value Needed 

Description 

Reader Mode 

Dropdown choice 

There are two options for this parameter: Value or Credits. It is used to allow end users to do transactions with Value or Credits accordingly in this location. 

Output Pulse Duration 

Numeric 

The duration of the pulse whose unit is millisecond with the length limitation ranging from 1 to 65535(Default: 50ms). 

Output Pulse Gap 

Numeric 

The gap between pulses whose unit is millisecond with the length limitation ranging from 1 to 65535. (Default: 100ms). 

Output Pulse Polarity 

Dropdown choice 

There are two selections: Idle Open/Idle Closed. This parameter determines how the pulse output is sent to the game. You should select “Idle Open” for most of the games. 

Input Channel 

N/A 

Defines the 8 input channels of the Game board. The first 4 channels are supported at present phase. The ticket related settings are restricted to Channel 4. 

Type 

Dropdown choice 

Six types could be selected in this parameter: Coin/Bill/Door/Collection/Re-fill/Unused. 

Default: Unused. Only Coin & Bill are supported at present stage and ticket is supported in Channel 4. 

 

Polarity 

Dropdown choice 

There are two selections: Idle Open/Idle Closed. This parameter determines how to interpret the input to the game. Most game inputs such as coins and bill acceptors will be “Idle Open”.  

Value 

Numeric 

It differs based on the “Type” field that is enabled and defined. The value length for this parameter is 1 – 65535. 

Min Duration (ms) 

Numeric 

This is how long the input must be present to be considered a valid input. Its unit is millisecond and it ranges from 1 to 65535.  

Max Duration (ms) 

Numeric 

This is the maximum time that the input can be present to be considered a valid input and it ranges from 1 to 65535. 

Min Gap (ms) 

Numeric 

This is the minimum time between multiple inputs. Units are millisecond. Range 1-65535  

Timeout (ms) 

Numeric 

For inputs that can accumulate (Coins, Bills, Tickets), the Input Timeout specifies how long to wait for additional inputs before sending the accumulated total. Range 1-65535. 

 


c. For Hardware Interface: Retail Pulse Board 

If you select “Retail Pulse Board” in the “Hardware Interface” field of Machine Profile, the “Pulse” section will be displayed as in below picture. Please refer to table 4-23 for detailed descriptions of the fields. 

图片 1, Picture 

图片 1676473908, Picture 

 

 

Field Name 

Value Needed 

Description 

Coin Inputs 

Dropdown choice 

This is the coin input configuration, which decides whether to use one, two similar or two different coin inputs. 

You could select either “Single” or “Dual”. The selection of “Single” will gray out the row of Package 2. If you select “Dual”, then you could set up values for both Package 1 and Package 2. 

Operation Mode 

Dropdown choice 

This parameter defines the way that machines send pulses.  

There are two options: 

Pulse/Electromechanical. 

“Electromechanical” is not supported at present. 

Pocket State Table 

Dropdown choice 

This depends on the “Pocket Configuration” field of the “Machine Profile” section.  

If you select “Single” for the “Pocket Configuration”, the options here are “Single Pulse High In Use” & “Single Pulse Low In Use”.  

If you select “Shared” for the “Pocket Configuration”, the options here are “Shared Pulse High In Use” & “Shared Pulse Low In Use”. 

If you select “Dual” for the “Pocket Configuration”, the options here are “Dual Pulse High In Use” & “Dual Pulse Low In Use”. 

E:\task\参考文档\Snipaste_2023-05-11_14-31-54.png, PictureIf no option is displayed in the drop-down menu, you can press CTRL+SHIFT+R to refresh the page. 

Lower Timer 1/ Lower Timer 2/ Lower Timer 3 

Numeric 

Timer 1/2/3 of the Lower Pocket. 

The use of these fields depends on the “Pocket State Table” chosen above and should not be changed unless instructed to do so by a KioSoft customer service representative. 

Upper Timer 1/ Upper Timer 2/ Upper Timer 3 

Numeric 

Timer 1/2/3 of the Upper Pocket. When “Single” is selected for the field “Pocket Configuration” in the “Machine Profile” section, all timers for the Upper Pocket will be grayed out. 

Package # 

N/A 

The package number. 

Coin Value 

Numeric 

The value of the coin whose unit is cents. Default: 25. 

Min Duration (ms) 

Numeric 

This is the minimum time that the input can be presented to be considered a valid input. Its unit is millisecond. 

Max Duration (ms) 

Numeric 

This is the maximum time that the input can be presented to be considered a valid input. Its unit is millisecond. 

Min Gap (ms) 

Numeric 

This is the minimum time between multiple inputs. Its unit is millisecond. 

Timeout (ms) 

Numeric 

For inputs that can accumulate, the Input Timeout specifies how long to wait for additional inputs before sending the accumulated total.  

Coin Output Duration (ms) 

Numeric 

This is the duration that a round of coin output is completed. 

Coin Output Type 

Dropdown choice 

The selection of this parameter is subject to that of the “Operation Mode”. If you select “Pulse” in the “Operation Mode”, Coin Output can be “Normal” or “Via Relay”. When you select “Electromechanical” in the “Operation Mode”, this field is not used. 

 

Data and Processing 

Click 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 4-24 below. 

 

图片 2051215750, Picture 

 

Field Name 

Value Needed 

Description 

Data Upload 

Dropdown choice 

This parameter determines whether or not to upload the report. 

Data Upload Time 

Dropdown choice 

The settlement time of the readers.  

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PicturePls set this value to 6 PM. 

Offline Mode 

Dropdown choice 

Defines whether to support the offline transactions with bank cards. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureThis feature supports Ultra series only. 

WiFi SSID 

Alpha-numeric 

The WiFi SSID of the router. Must be exactly the same as the WLAN WiFi SSID in router’s setup. 

Reboot Time 

Dropdown choice 

The reboot time every day. 

Payment Gateway Options 

Dropdown choice 

It is determined by the gateway selected in Location Management => Payment Gateway => Reader Transactions. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureOnly TSYS supports Offline Mode and automated VAR. 

POS ID / Terminal ID 

Numeric 

This is a unique ID provided that associates the POS device with a unique merchant hierarchy. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureIf 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 

Dropdown 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 purpose, 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.  

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, PictureOnly Retail supports automated VAR. 

 

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 4-25 for descriptions of the fields. 

图片 1, Picture 

 

 

Field Name 

Value Needed 

Description 

Payment Method 

Checkbox 

There are 9 payment methods: 

KioSoft Mobile App & KioSoft Laundry Card & Credit Card/Debit Card & Bill/Coin & Cloud-Base Card/Transact Credentials & Card Holder & Atrium Credentials & TouchNet Credentials 

  • Elevate Card-D supports KioSoft Mobile App, KioSoft Laundry Card, Bill/Coin, Cloud-based Card and Desfire Card at the present stage.

CR/DB Card Type 

Checkbox 

There are 5 options: VISA/Master Card/Discover/American Express/Interac.

  • Elevate Card-D does not support any type of CR/DB card at the present stage.

Double Tap Delay 

Numeric 

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 tapping. If the second tapping exceeds the time you set here, the terminal will return idle screen. 

Auth Mode 

Dropdown choice 

This is the transaction type of the bank card. 

At present, only “Single” and “Pre-Auth” are supported.  

“Single”: A separate fee is deducted for each transaction. 

“Pre-auth”: Request the bank to reserve the Pre-Authorization Amount for one day, during which transactions are deducted directly from the reserved amount. 

E:\task\参考文档\Snipaste_2023-05-11_14-32-31.png, Picture 
Only Single Auth supports automated VAR. 

Pre Auth Amount 

Numeric 

The amount of the Pre-Authorization type of transaction.  

The default value is 200 and the unit is cent. 

Site Code Check 

Dropdown choice 

To check whether the site code of cloud-based cards and laundry 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.  

 


Section 5 Loyalty Program

Loyalty program is used to reward consumers (end-users) with points for each purchase. As a vendor, you can set up and determine the value of loyalty points to define how many points are earned per $ or credit used, and the redemption rate of points back to $ and credits. When consumers have enough points to redeem, they will be able to purchase KioSoft products and services using those points. 

You can navigate to the menu on the right and locate the “Rewards Program” -> “Loyalty Program” section to configure a loyalty program. There are two categories of the loyalty program: loyalty program for all locations & loyalty program for a single/ multiple location (s). 

Loyalty Program for All Locations 

All locations loyalty program, as the name suggests, is applicable to all locations that belong to you. 

a. Add Loyalty Program for all locations 

When you click on “Rewards Program” -> “Loyalty Program” subsequently for the first time, the loyalty program will be automatically created. And this is the only way of creating a loyalty program for all locations. 

The default loyalty program for all locations of the laundry market has the following columns: “Refill Bonus”, “Refill Amount”, “Bonus Amount”, “Expire Date”, “Created By”, “Status” and “Action” as shown in the picture below.

 

 

b. Edit All Locations’ Loyalty Program 

You can edit all locations’ loyalty program by clicking the “Edit” button under the Action column to modify its content and limitation. 

For the detailed content of how to set specific values for all fields, please refer to Create a Loyalty Program. When all the settings are completed, click the “Save Loyalty Program” button at the bottom. 

 

 

c. Change Status of the All Locations’ Loyalty Program 

If you’d like to change the status of all locations’ loyalty program, click the button under Status to toggle among the two statuses.  

Click the green “Enabled” button, and a “Disabled” button in orange will show along with a message “Loyalty program disabled” appearing on the top of the page as marked in red. 

Click the orange “Disabled” button, and an “Enabled” button in green will show along with a message “Loyalty program enabled” appearing on the top. 


Loyalty Program for a Single/Multiple Location (s) 

To manage the loyalty program for a single/multiple location (s), you should mainly operate on the two areas as marked in red below. 

 

a. Create a Loyalty Program 

You can click the “Add Loyalty Program” button to create a loyalty program for a single or multiple location (s) following the instructions below. There are six components in adding a loyalty page, i.e., Location, Refill Bonus, Usage Bonus, Conversion Rate, Expiry Date and Comments. 

1) Define Location (s) 

Click inside the “Location” text box to select single or multiple locations. When you click it, you will see a drop-down menu appear with clickable text. You can enter the location name or location ID to speed up your search for a location (s) with this smart search bar. When the location is selected, there will be a cross mark “x” ahead of it. You can click the “x” to deselect the location from the list. 

 

2) Set Refill Bonus 

This feature is to set the bonus that is awarded to the consumers after they refill the account. The name of this field is changed from “Bonus Type” to “Refill Bonus”. An additional field “Disabled” is added. 

 

  • When you select “Disabled”, this feature will be disabled at the selected location (s) and all columns will be greyed out. 

 

  • If you’d like to set the refill bonus for consumers, select either “Fixed Amount” or “Percentage”. 

 

Below is an example intending to specify the principle of refill bonus to you. 

Refill Bonus Setting 

 

Bonus Amount Obtained 

Refill Amount ($) 

Bonus Amount ($) 

<10 

0 

10-19 

10 

20-29 

20 

30-39 

30 

40-49 

40 

>=50 

50 

E:\task\参考文档\Snipaste_2023-05-11_14-31-10.pngThe refill amount and bonus amount only accept numbers, and the number you input cannot be longer than 3 digits. 

E:\task\参考文档\Snipaste_2023-05-11_14-31-10.pngUnless you select “Disabled” here, otherwise the input fields cannot be empty. 

 

3) Set Usage Bonus 

This feature is to set the bonus that is awarded to consumers after they make transactions. You can see two options in the drop-down list, i.e. “Fixed Amount” & “Disabled”. “Disabled” is the default option. 

 

  • When you select “Disabled”, both the usage bonus feature and the conversion rate feature will be disabled for the selected location (s), and all columns will be greyed out and disabled from entering a value. 

 

  • When you select “Fixed Amount”, you can input the amount for the value used and the corresponding number of points earned when that value is used by the consumers in the KioSoft mobile app and with a cloud card. The minimum amount to be set here is $1, and the minimum point is 0. 

Regarding the configuration of Amount and Points, 3 examples are displayed below to facilitate your understanding of the principle. Please note that the points that consumers get in return conform to the rule: below 5, round down; equal or above 5, round up. 

Example 1: Set Amount as 1 and Points as 1. 

 

 

The different amount of money that consumers spend and points they get are demonstrated in the table. 

 

Money spent ($) 

Points obtained 

0.01-1.49 

1 

1.5-2.49 

2 

2.5-3.49 

3 

3.5-4.49 

4 

4.5-5.49 

5 

 

 

Example 2: Set Amount as 10 and Points as 10. 

 

The different amount of money that consumers spend and points they get are demonstrated in the table. 

Money spent ($) 

Points obtained 

0.01-1.49 

1 

1.5-2.49 

2 

2.5-3.49 

3 

3.5-4.49 

4 

4.5-5.49 

5 

4.5-6.49 

6 

6.5-7.49 

7 

7.5-8.49 

8 

8.5-9.49 

9 

9.5-10.49 

10 

 

 

 

Example 3: Set Amount as 10 and Points as 1. 

 

The different amount of money that consumers spend and points they get are demonstrated in the table below. 

Money spent ($) 

Points obtained 

0.01-14.99 

1 

15-24.99 

2 

25-34.99 

3 

35-44.99 

4 

45-54.99 

5 

 

 

E:\task\参考文档\Snipaste_2023-05-11_14-31-54.pngIf the point is set to be 0, then the consumers will not earn points, however, they will still be able to use the remaining loyalty points stored in their account until they consume all the points. 

E:\task\参考文档\Snipaste_2023-05-11_14-31-10.pngE:\task\参考文档\Snipaste_2023-05-11_14-31-10.pngDecimal points are not allowed for “Amount” & “Points”, only whole numbers. And the number you input cannot be longer than 3 digits. 

Unless you select “Disabled” here, otherwise the input fields cannot be empty. 

 

4) Configure Convrsion Rate 

This is to set the amount of loyalty points to be redeemed while consumers use them to make payments. 

This feature is applicable on condition that you select “Fixed Amount” for the “Usage Bonus”. You can input the associated points corresponding to the fixed amount of $1 to redeem that amount. For example, if you input 10 into the “Points” box, it means that $1 = 10 points. Based on that, if you’d like to start a machine with a $1 cycle using points, it costs you 10 points to start the machine. 

 

E:\task\参考文档\Snipaste_2023-05-11_14-31-10.pngDecimal points are not allowed for “Points”, you should only input whole numbers, and the number you input cannot be longer than 3 digits. 

The points’ calculation follows the rules below:  

Below 5 points, round down. 

Equal or above 5 points, round up. 

E.g.: If the machine’s starting price is $1.65, the conversion rate is 10 points = $1, then points cost = 10*1.65 = 16.5. According to the points calculation rule, 16.5 will be rounded up to 17 points. 

 

5) Set Expiry Date 

This is the last date after which the loyalty program is no longer in effect. Click the input box and a calendar picker will pop up for you to select the expiry date. 

 

If you’d like to set the validity period to forever, please leave this field blank. It will display “Forever” under the “Expire Date” column on the Loyalty Program Records page. When a loyalty program is expired, a transparent light pink box will cover the date under the “Expire Date” column for the specific location as shown below. 

 

6) Add Comments 

This part is for you to leave comments for a specified loyalty program. 

After you’ve set all the parameters, click the “Add Loyalty Program” button to submit. 

 

b. Change Status, Edit and Delete Loyalty Program 

For the added loyalty program, you can change the status of it, edit and delete it on the Loyalty Program’s Records page. 

 

Under the “Status” column, click “Enabled” and it will change to “Disabled”, and vice versa. 

Under the “Action” column, click “Edit” to open the Loyalty Program information page and make your modification to a specific loyalty program; click “Delete” to delete the loyalty program that is not applicable.