Feature Deployment Instruction: Support Canada Air pump

This document will show you the steps on how Ultra VQ-M works as MCC plus Tap to replace the outdated MCC in Canada Air pump.

TMS (Terminal Management System) serves to be the server platform to support the Canadian Air Pump working with the Ultra VQ-M, which will be utilized to configure the relative parameters to support the features or updates to be released or to achieve the functionalities that requires custom settings.

It’s worth noting that, the platform is only accessible to KioSoft internal teams. If any features or updates would be supported by the configured parameters on the platform, you should contact the KioSoft support team to proceed with the corresponding settings. The procedures related to the TMS/NMS’s configurations mentioned below will be provided as a reference for the KioSoft internal team.

The Ultra VQ-M now supports English and French as the display language (English is set by default). If you wish to add French as another language option or set French as the sole language option, you should ask the KioSoft support team to do the configuration. The KioSoft support team can go to the TMS system to set the language based on your preference or business needs.

Systems Integration

Before deploying the AirPump VQ-M terminal to business locations, we need to integrate the user AIRserv VQ-M Terminal Setup file into our system RSS.

1. Check and update the VQ-M to the latest versions, if any. Ship them to the user with a full list of their serial numbers.

2. Add the VQ-M device to the RSS/DB system.

   a. Import MCC: Log in to RSS and go to Management → System Configuration → Manage MCC → Import MCC. On this page, you can add a new VQ-M device(s) to RSS by importing a SN & MAC Import file (in Excel format). VQ-M MAC is the WiFi MAC address.

   b. Add New MCC: RSS, Management → System Configuration → Manage MCC → Add New MCC. On this page, you can add a new VQ-M device to RSS manually. VQ-M MAC is the WiFi MAC address.

• Verify the serial number length in the import file; it should be 16 digits and not be a duplicate of the one already in the DB.  

• Verify the MAC address on the "Add New MCC" page; it should be in MAC address format and not be a duplicate of the one already in the DB.

3. A clerk at AIRserv will complete the VQ-M Terminal Setup file with Moneris payment processor configurations.

4. Add Terminal Type options: MCC and VQ-M.

   a. Terminal Type: MCC, same as the current procedure, but requires terminal type verification via device serial number.

   b. Terminal Type: VQ-M

• Import Terminals: RSS, Management → System Configuration →  Manage Terminals → Import Terminals.  On this page, you can add a new terminal(s) to RSS by importing the VQ-M Terminal Setup file (in Excel format).

• Add New Terminal: RSS, Management → System Configuration→ Manage Terminals→ Add New Terminal. This page will display Moneris's Store ID, API Token, and Device ID credentials instead of the Monex ones, VQ-M S/N instead of MCC S/N. On this page, you can add a new VQ-M terminal manually. After successfully submitting, an "update config" file shall be generated and uploaded to the NMS and shall be paired in mcc table.

  -Extend "AirServ S/N" length limit to 10 and "Store #" to 12 digits.

  -Verify MLID. If it exists in the DB, it shall display a warning message that the MLID xxxxxx already exists.  And add a Verify button besides the Machine Location ID field.

  -MCC/VQ-M S/N length limit to 8.  Verify the VQ-M/MCC, which the S/N should exist in the DB MCC table and not "paired".  Otherwise, display a warning message of the serial number not found or the VQ-M/MCC already paired with MLID xxxxxx.

  -Also, verify the terminal type by the device serial number. And add a Verify button besides the MCC/VQ-M S/N field.

Card Reading under Different Scenarios

Users are allowed to tap four function cards when using the Canada Air Pump. The card reading logic, along with the error codes that may appear, will be introduced as a reference for the KioSoft team, ensuring customers can have a smooth user experience when using the Air Pump.

Function Card 1: Test Card

Test Card is used to do network connection and the screen UI tests. A test report will be uploaded to RSS for the customer’s reference. When the customer taps the test card, the Ultra VQ-M reader will follow these steps to ensure proper operation:

a. Card Verification: “Verifying Test Card” will prompt.

b. Network Check: “Public Network Testing” will prompt.

Please note that if the modem is connected, it will involve local and public network testing. If the SIM card is used, only public network testing will be executed.

c. Machine Start: “Starting Machine” will prompt.

d. Upload Report: “Uploading Test Result Report” will prompt.

If the test has been completed successfully without any errors, "Full Test Successfully" will be displayed, and the device will return to the idle screen.

Error Codes to Note:

Function Card 2: Setup Card

Setup card is used for new installations, swaps, parameter modifications, and upgrades (if any new firmware/software is available) of VQ-M. All of these operations require the use of TMS. When the user taps the setup card, the Ultra VQ-M reader will execute the following steps to ensure correct operation:

a. Card Verification: “Verifying Setup Card” will prompt.

b. NMS Update: “NMS Update Processing” will prompt.

c. Time Synchronization: “Sync Time with Server” will prompt.

d. Report Upload: “Uploading Report” will prompt.

e. Start Machine: “Starting Machine” will prompt.

If the operation is completed smoothly, “Setup Successfully” will be prompted, and the reader will return to the idle screen.

Error codes to note:

Function Card 3: Service Card or Cash Collection Card

Service Card can be used when the user wishes to track coin usage at the terminal.  The usage includes the time the machine is activated by coins, the number of times the machine started for coins, the coin balance, and total coins dropped in the vault since the last collection, and the last time coins were picked up, etc.

When the card is used, the Ultra VQ-M reader will perform these steps to facilitate the cash collection process:

a. Card Verification: “Verifying Collection Card” will prompt.

b. Machine Start: “Starting Machine” will prompt. Reset the coin balance and update the last collection time.

c. Cash Collection Process: “Cash Collection Processing" will prompt.

If all steps are completed without any errors, the coin counters will be reset, and the pickup time will be recorded. Then "Cash Collection Successfully" will prompt, and it will return to the idle mode.

Error Codes to Note:

Function Card 4: Deactivation Card

Deactivation Card is used when a VQ-M needs to be reset to factory settings. When the user taps the deactivate card, the Ultra VQ-M reader goes through the following steps to complete the deactivation process:

a. Card Verification: “Verifying Deactive Card” will prompt.

b. Reports Upload: “Uploading All Transaction Reports” will prompt.

c. Reset EEM Counters: “Resetting EEM Counters” will prompt.

d. Delete Transaction Records: “Deleting All Transaction Records” will prompt.

e. Deactivate Report Upload: “Uploading Deactive Report” will prompt.

If the operation is done successfully, “Deactive Successfully” will prompt, and the reader will begin rebooting (with “Rebooting” displayed on the screen).

Error Codes to Note:

Start Air Pump Machine

You can start the Air Pump using one of the three methods: by Credit/Debit card (Visa/Mastercard/Amex/Discover/Interac), by coin, or remotely via server command.

Method 1: Start by Credit/Debit Card

The customer should check and ensure that the VQM displays the price on the idle screen. The current price configured on the NMS will be displayed. Then tap Your Credit/Debit Card:

a. Tap your Credit/Debit card to initiate the transaction:

If the card is invalid, the message "READ CARD ERROR" will appear.

If the card is removed too early, the message "READ CARD ERROR TRY AGAIN" will display.

b. Transaction Process:

If the card is read successfully, "SALE PROCESSING” will prompt. While the transaction result will be displayed as “SALE APPROVED.”

c. Transaction Outcome:

If the transaction fails, the VQM returns to the idle screen with the prompt stating the reason for the transaction failure:

a. If the card fails verification, such as the card is expired, it will prompt “SALE DECLINED”.

b. If there comes a network connection or a payment processor configuration problem, it will prompt “SALE FAILED.”

c. If there is any network error, it will prompt “ER06/Network Error.”

d. If the machine failed to start, it will prompt “ER05 Start Machine Failed.”

When the transaction is successful, but the air pump machine fails to start, the transaction reversal action will be triggered. The terminal will prompt “REVERSAL PROCESSING”.

If the reversal is successfully done, it will prompt “REVERSAL APPROVED”. If not, it will prompt “REVERSAL FAILED”.

If the transaction is successfully initiated and the air pump machine is successfully started, the terminal displays a countdown of the run time. Once the countdown ends, the screen returns to idle mode.

Method 2: Start by Coin

a. Insert Coins:

Insert coins into the coin drop until the required amount is reached. The machine will start immediately once a sufficient amount is inserted. Note that the coin price is set in the NMS in advance.

b. Monitor Operation:

While the Air Pump is running, the VQM displays the duration in a countdown manner.

c. Completion:

After the machine stops, the VQM will return to the idle screen.

Method 3: Remote Start by Server

a. Trigger Remote Start:

Utilize the RSS to initiate a remote start through the "Get remote diagnostic data" or "Dispatch start" sections.

b. Machine Start:

Upon receiving the remote start command, the VQM starts the machine and displays the operation duration provided by the server.

c. Upload Diagnostic Data:

The VQM uploads the diagnostic data report to the RSS during the operation. Once the machine stops, the VQM reverts to the idle screen.

Software/Firmware Upgrade of Ultra VQ-M

To upgrade the software/firmware version parameters for Ultra VQ-M, the user can resort to one of the four methods to upgrade the Ultra VQ-M.

Method 1: Upgrade with Setup card

When either of the two commands has been well configured via NMS/TMS, the KioSoft team will notify you of the status, and you can directly tap the setup card on the reader to initiate the upgrade.

Method 2: Remote Trigger via RSS

The upgrade via the remote trigger can be achieved on the RSS system.

a. Log in to RSS and select Management → Software/Firmware Updates.

b. Select “Update MCC Package.”

c. Tick the target MLIDs checkbox. Click on Update.

d. Then the upgrade will be initiated from a remote location.

Method 3: Hard Reboot (Power Cycle)

If you choose this channel for upgrading, you should contact the KioSoft support team to ensure that the parameters have been well configured on the TMS/NMS system and a new version has been ready for the reader to proceed with the upgrade. Then you can power cycle the Ultra VQ-M (manually power off and power on the terminal) to initiate the upgrade.

Method 4: Daily NMS

The Ultra VQ-M will proceed with the automatic checking at a specific time daily to confirm if there is any software/firmware update request or any updated parameters made on NMS. If there is any, the terminal will proceed with the upgrade automatically. You can contact the KioSoft support team to define a specific time when the SW/FW checking will be initiated. The KioSoft support team can log in to TMS and select NMS -> Present Config to change the value of “NMS Upload Time” to define a time. The default automatic checking time is 2:50 am daily, and the default value set on TMS is "0250” on TMS.

Check Reports

The Ultra VQ-M will upload the reports into RSS to reflect the running status of the terminals. The Reports will vary depending on the pump’s status, payment type, etc., as a reference for you to conduct the machine or business analysis.

You can log in to RSS and check the reports in the Navigation section:

• Realtime Active Terminals: Same as MCC (hereinafter the same), this will show terminals that checked in the last 24 hours from the minute you clicked on this option. VQ-M connects home once every 24 hours. You need to be able to search for a specific group, a client or a terminal.  The info displayed includes MLID, Date Time, Address, etc. Note: Make Search and Filter for all Reports as dynamic ones. Every field/column is able to be sorted.

• Active Terminals: This will show terminals that checked in the last 24 hours based on the cutoff time. You need to be able to search for a specific group, a client, or a terminal. The info displayed is MLID, Date Time, Address, etc.

• Inactive Terminals: This will show terminals that did not check in the last 24 hours based on the cutoff time. You need to be able to search for a specific group, a client, or a terminal. The info displayed is MLID, Date Time, Address, etc.

• New Active Terminals: This will show terminals that were not on the active report yesterday but showed up today. You need to be able to search for a specific group, a client, or a terminal. The info displayed is MLID, Date Time, Address, etc.

• Zero Revenue Terminals (Air): This will show air pump terminals that had no business ($0 in revenue) for the last 24 hours. You need to be able to search for a specific group, a client, or a terminal. The info displayed is MLID, DateTime, Address, etc., and Total Revenue that is always shown as $0.

• Zero Revenue Terminals (Vac): This will show vacuum terminals that had no business ($0 in revenue) for the last 24 hours. You need to be able to search for a specific group, a client, or a terminal. The info displayed is MLID, DateTime, Address, etc., and Total Revenue that is always shown as $0. Note: The hardware is not currently available.

• Card Usage Report: This shows transaction info of bank cards and the total revenue for either 1 terminal, terminals belonging to a group, a client, or a period of time. The fields include Site ID, MLID, Date/Time, Authorization #, Store ID (shown as TID), Response, Machine Status, Amount, etc.

• Cash Usage Report: This shows coin transactions and the total revenue for either 1 terminal, terminals belonging to a group, a client, or a period of dates. The coin is separated into loonies and quarters for the user. The fields include Site ID, MLID, Date/Time,  Coin-L Count (Loonie), Cash-R Count (Quarter),  Machine Status, Total Cash, etc.

• Other Usage Report: Not applicable at the present phase.

• Usage Statistics Report: This cash, card, or Petro (not applicable now) report shows detailed transaction info and a total transaction count for either 1 terminal, a client, a date range, or a Payee ID, or terminals belonging to a group of machine types, province, etc., combined upon search criteria. An Export function allows you to export a report in an Excel format.

• Revenue Totals Report: This shows the total revenue records, including both coin and card total amounts.

• Diagnostic Data: VQ-M will upload the diagnostic data each time the VQ-M is powered on. Or get the remote commands from the server.

• Get Remote Diagnostic Data: This allows you to retrieve terminal info or remotely start the airpump machine through the terminal IP address obtained by MLID. The machine cycle duration is editable. The fields include  VQ-M S/N, Air Relay Voltage, Air Current, Coin Balance, Card Trans Total, Price, Cycle Duration, Last Coin Pick Up Time, Last Terminal Run Time, etc.

• Dispatch Start: Same as “Remote Diagnostic Data” above, except the machine free cycle duration is fixed at 240 seconds.

• Manage Terminals: This shows AIRserv terminal info for either 1 terminal or terminals belonging to a group. The info displayed includes MLID, VQ-M S/N, address, and Postal Code, etc. You need to be able to sync terminal time with the RSS, Swap terminal, Unpair terminal, Edit terminal profile including MLID and AIRserv sn, and also be able to add a new terminal to the Moneris platform.

• Manage MCC: This shows VQ-M/MCC info for either 1 device or devices belonging to a group. The info displayed includes S/N, is swapped, paid, MAC address, full S/N, etc. You need to be able to put a device(s) in or out of the swap pool, as well as be able to edit the S/N and MAC address.

Manage Parameters and Settings of Ultra VQ-M

You can search the target Ultra VQ-M profile in RSS to manage or configure the functionalities at the terminal’s side. Log in to RSS and navigate to “Management” → “Management Terminals.” Enter the MLID/MCC S/N to search for the target terminal.

a. Modify Basic Parameters

You can click on “Edit” to check and modify the basic parameters such as Location Name, Store #, Payee info, etc.

Click on the “Submit” button, and the modified parameters will be applied to the VQ-M successfully.

b. Change Settings

You can navigate to “Management” → “Change Settings” menu to change the relevant settings of the terminal. Search the target terminal by entering its MLID. Click on “Edit” to enter the page where you can modify the VQ-M’s parameters relative to prices, duration, and temperature, etc.

Click on the “Submit” button, and the modified settings will then be applied to the Ultra VQ-M.

Swap Device and Method

1. Prepare a Swap Device

The swap method is typically involved and used in two scenarios:

• The new VQ-M to be used for swap is not in RSS. Follow Step 2 in the Systems Integration section above to import VQ-M in RSS.

• The VQ-M to be used for swap is in RSS but not in the swap pool. Place it into the swap pool via Edit the VQ-M on the Manage MCC page or an Import Swap VQ-M file (in Excel format).

2. Swap Method

Swap a malfunctioning device with a new one. Go to RSS “Manage Terminals” and locate the device that needs to be replaced and click on “Swap”.

In the Swap Terminal page, select one of the swap methods: To VQ-M or To MCC.

The available VQ-M/MCC S/N will be shown in the drop-down list of Select Main Controller once the swap method is selected.

a. Swap to VQ-M

1) The malfunctioning device is a MCC.

Select a VQ-M from the drop-down list, and three Moneris mandatory fields will be displayed: Store ID, API Token, and Device ID. Once filled out, click on the “Update” button.

2) The malfunctioning device is a VQ-M

Select a VQ-M from the drop-down list, and then click on the “Update” button.

b. Swap to MCC

1) The malfunctioning device is a MCC

Select an MCC from the drop-down list, and then click on the “Update” button.

2) The malfunctioning device is a VQ-M

Select an MCC from the drop-down list, and two Moneris mandatory fields will be displayed: Merchant ID and Terminal ID. Once filled out, click on the “Update” button.

Database Table Configuration Rules (Only for Support Team’s Reference)

The mode of a device VQ-M is determined by two parameters in the database table “mcc” , "is_swap" and "paired".

The two parameters may vary depending on the state of device by the time it is imported, swapped, deactivated, or any updated manually.

a. For a device that is first imported in the database throuth the VQ-M Import file, the "is_swap" value should be set to "1" and the "paired" value should be set to "0".

b. When the Terminal Setup file is imported, the device is bound.  The "is_swap" should be "0" and the "paired" should be "1".

c. When a device in the swap pool swaps a malfunctional device, the "is_swap" should change to "0" and the "paired" should change to "1".

d. After a device is deactivated by the Deactivation Card, put it into the swap pool by changing its "is_swap" to "1" and "paired" to "0".  Then the device should be reset to the factory settings.

3. Swap Device Configuration File

After the “Update” button is clicked, a configuration file will be generated and uploaded to the “Update Config” category of the TMS/NMS.

This new configuration file will be used to configure the newly swapped-in device via NMS.

The user can now physically swap the device on-site, and then tap the Setup Card to trigger an NMS update to activate the new device into operation.