Vendor Portal - Locations - View Location - Rooms

Once a location is created, the preset Rooms will be available, and you can create rooms under the location.

Create Room

Click Rooms -> Create Room, then a form to create a room will open. You may refer to the table below for descriptions of the fields. Fill in the fields and click “Save” at the bottom to save the room.

The room created will be displayed in the list. If there are multiple rooms at a location, you can use the search bar to search for it by keyword in the Room Name.

View Room

Click the “View” button in the Actions column, then you can see the general conditions of different types of machines registered in the room.  You may refer to the table below for the field descriptions.

Roles that have access to features in Room View include Laundry/Amusement/Integration Vendor Admin, Laundry/Amusement/Integration Staff, Laundry Portal Role, Integration Portal Staff, KioSoft Express Laundry/Amusement User, and Laundry Technician. Roles that do not have the Room Management permission won’t be able to access this section.

At the bottom of each machine information card, you may find a section called Reader Credentials. This feature is designed to automate the process of generating and assigning payment processing credentials to each terminal, eliminating the need for manual input. But it does not apply to kiosks. Below are descriptions of the fields and feature buttons in this section.

Please make sure the section “Credentials for New Development (Automation) (Payroc)” in General Settings has been well configured so that this feature can be supported.

RPCMs

In the RPCMs section, if your modem is paired with an RPCM (short for Remote Power Cycle Module), a double-outlet plug icon will show behind the machine name. When a network error related to RPCM Wi-Fi signal strength, modem cellular signal strength, KioSoft Edge Box, or general network connection is detected, the RPCM will automatically cycle power to its paired modem, thus reducing the need for technician site visits.

Reader Credentials

At the bottom of each machine information card, you may find a section called Reader Credentials. This feature is designed to automate the process of generating and assigning payment processing credentials to each terminal, eliminating the need for manual input. Below are descriptions of the fields and feature buttons in this section.

Readers which support this feature include Ultra VX Series [2100.006.001.008]; Ultra LX [2300.006.001.008]; Ultra VQ [2500.006.001.008]. Kiosks that support this feature include AVU Kiosk [USA][v1.16.1] ; AVU Kiosk VQ-FM[USA][v4.16.3].

Please make sure the section “Credentials for New Development (Automation) (Payroc)” in General Settings has been well configured so that this feature can be supported.

• Status (Active / Inactive / Activation in Progress / Null / Error / Pre-auth / Demo):

Active: Indicates that payment credentials have been successfully returned from Tsys and the terminal is activated.

Inactive: Signals that the terminal is not activated, with a prompt on the reader’s idle screen indicating activation failure. When credentials are obtained but the reader is not activated, the system will automatically attempt activation one more time.

Activation in Progress: Represents the status when a request for credentials has been sent but not yet returned.

Null: Appears if the credentials have been deleted by clicking the Edit => Delete => Save button.

Error: Will display when it fails to get the reader credentials. When it fails to get callback data from the payment gateway provider, the system will automatically attempt to get them one more time.

If the status is Error, you can view the detailed error message on hover.

Pre-auth: The auth mode of the machine is set to Pre-auth mode.

Demo: Indicates that the machine is in demo mode.

• Provider (Tsys): Specifies the payment gateway provider. Currently, Tsys is supported.

• POS ID & Auth Code & Auth Factor: These are payment processing credentials. They can be auto-generated using the Request New Credentials button, manually edited with the Edit Credentials button, or uploaded from manually defined CCM profiles.

• Request New Credentials: This button can be used to call the Payroc-Tsys API to get new credentials. The credentials will be updated in about 2-3 minutes, and the reader will be activated immediately after credentials are received. This only works with Payroc-Tsys. This button is hidden for all the other providers.

• Edit Credentials button allows you to manually modify credentials for operational flexibility. Like the Request button, it is available only when all specified conditions are met. During editing, you need to click the Save button to apply changes and/or exit editing mode. Immediately, the credentials will be updated, and the reader will be activated.

• Delete button appears after clicking the Edit Credentials button. Clicking it will clear all credentials and disable credit/debit card transactions when confirmed, and the reader will become inactive immediately.

For machines where Credit/Debit card functionality is enabled at the location level but not in its CCM profile, the status will display as Inactive. If a user clicks the Request New Credentials button or the Edit button, we interpret this action as intending to enable Credit/Debit card payment and will execute the command to activate the payment gateway.

For backup reader, it is automatically linked to the master reader's credential. It will not trigger VAR calls on its own and has no separate POS ID, Auth Code, or Auth Factor in its profile. For normal readers in the room, the Request New Credentials and Edit Credentials buttons are greyed out.

Update Profile

In the Room View section, you can also update each machine's profile remotely with the following steps. This feature applies to both CCM profiles created in Profile Builder and the CleanReader Ultra Data Profile.

Readers supporting this feature include Elevate Card Connect [1.23.9.3], Ultra One [1.19.0], Ultra V2 [1.17.0], Ultra VQM and Ultra VQFM [2500.006.007.004], Ultra LX and Ultra LX Pro [v2300.006.007.004], Ultra VX series [V2100.006.007.004].

1) Click the “Update Profile” tab.

2) You can tick the radio button “Now” to perform an immediate update upon clicking the Submit button, or you can schedule a future update by clicking the radio button, then using the calendar picker to configure the date and time of the update.

The date and time will follow the reader host time.

The real time update presently can be supported only when the machine is connected to a KioSoft modem.

3) Locate the machine for which you would like to change the profile.

a. If you need to replace the current profile with another one, click “Select Profile or Ultra Data” and a drop-down list of the profiles will be displayed. You can use the smart search bar to filter your desired profile with keywords. Then click “Submit Update” directly to save the update. The profile or Ultra Data will be sent to the target reader via MQTT.

After the profile or Ultra Data is successfully updated, the View Pending Updates page will show “Completed” for the reader.

b. If you will continue to use the current profile with some modifications, click the “Edit Current Profile” or “Edit Current Ultra Data” button to enter the profile builder page. Modify the profile parameters as needed and remember to save the modified profile. Return to the profile update page after your editing is completed, find and choose the modified profile from the option bar of “Select Profile or Ultra Data”, then click “Submit Update.”

Set Up Test

After a room is completed with machines configured, you can set up a test to see if there are issues like repeated Machine IDs, weak signals, or package loss, etc. Click the “Set Up Test” button in blue to enter the SUT page.

Click the “Start UAT” button to start the test. If there is any issue with the machine deployed in the room, the details will be displayed as shown below.

View Usage Statistics

On the Room View page, click “Usage Statistics”, then you will see the transaction totals of different payment options for each machine or the totals of all machines.

You can use the filter to define the matching period/machines that you would like to view. Click the “Filter” button in blue to perform the search.

View Report

Click the “Report” tab on the Room View page; you will be redirected to the Report Server System (RSS) -> Signal Reports section to view the Cellular Signal and Packet-loss Rate Report and WiFi Signal Report of the room. You can use the filters to search for the room needed and click the corresponding tab to toggle between the reports. For details of the two reports, please see the Chapter Signal Reports.

Remote Command

This feature can be accessed by Laundry/Integration/Amusement Vendor Admin. Only roles with both Room Management and Remote Command permissions can use this feature.

Click the “Remote Command” tab on the Room View page; you will see a new section displayed. This feature allows users to send remote commands to devices including readers, modems, and kiosks, etc. In this way, operators don’t need to physically visit the field to execute actions like rebooting readers, kiosks, and modems, starting machines, setting readers in/out of service, and cycling the power to devices. You can follow the major steps below to issue a remote command.

To perform the tasks remotely, all hardware must be online and connected to internet.

Terminals below following versions do not support Remote Command: Ultra VXT USA [1300.847.013.012]; Ultra VXT CAN [1400.841.000.019]; Elevate Card Connect & PCS [0100.295.001.007]; Ultra LX [1200.834.013.011]; AVU Touch [1.7.0.0].      

1) Click the drop-down list of “Action”, then the remote commands will be revealed. Click to select the action you’d like to perform.

• The Remote Power Cycle command requires a Remote Power Cycle Module (RPC-M) paired to the machine that you’d like to cycle the power to. If the machine is paired with the RPC-M, you will see a plug-shaped icon displayed beside it in the Room View.

• The Reboot Modem command applies to the KioSoft modem only.

2) In the Comments field, you can leave a note which will be displayed on the Activity Detail page of the Activity Audit Log. This field is not mandatory.

3) Click the Date/Time picker of the field “Issue Command Time”,  which follows the server time, to schedule the remote command. Pick a date on the calendar, then choose a specific time on the page that follows. You can schedule a remote command up to a maximum of 1 month later. Or you can click the “Today” button to issue the command immediately after all steps are completed.

If you select Today to issue an immediate remote command, you’ll need to finish the remaining steps within 1 minute otherwise it will fail and prompt the message “Issue Command Time cannot be earlier than the current time.”

4) Then it comes to the step of selecting the device(s) to issue the command. There are basically two ways to make the selection. You can use the search bar to input the supported keywords, including machine #, SN, and Machine ID / Name, to search for the desired device, tick its checkbox, then click the “Submit” button. Or you can look through the list to tick the checkbox(es) of the desired device(s), then click the “Submit” button. The checkbox in the list heading can be used to select all devices. The latter method supports issuing one command to multiple devices.

Offline devices are not selectable. If a reader’s offline status is caused due to failure to connect to MQTT, reconnection action will be performed during the next daily reboot or manual power cycle. And if a modem is rebooting, all its connected readers will also turn to offline status in about 2 minutes and in about 5 minutes after the modem reboots, the readers will be online and available for remote command.

5) After all parameters are set, click “Submit” to issue the remote command. You need to click the Search button again to obtain the updated command status. You may experience the following scenarios after the remote command is submitted.

• If it’s a scheduled task in the future, you will see it listed with Command Status being “Wait To Process” and a Cancel button in red. When there is a time conflict between the reader and the paired router, a prompt message will be displayed to the user as a reminder. The cancellation action will impact both devices.

  

• When the command is not successfully executed, a Retry option will be displayed in the list. It is an immediate action upon clicking.

  

• If a device is busy, the remote command won’t be executed so as not to interfere with the ongoing operations. It will also indicate the busy status in the record list.

  

• When the command is issued and no response is received, its Command Status will be displayed as Wait to Process (otherwise it will be Processing). For Remote Power Cycle, after 10 mins with no result returned, its status will be marked as failed; for the other commands, the status will be marked as failed after 5 minutes with no result returned.

• For the Remote Power Cycle command, you may need to wait for 10 minutes or so to get the final status of the command. If the command status displays as successful, it means the command is successfully received by the reader. You can go to the Activity Audit Log to view the execution result of this command. Please see the chart for the remote commands and their related activity types to select in the Activity Audit Log.

  No.	Remote Command	Activity to Select
  1	Reboot Reader	Reboot Reader
  2	Reboot Kiosk	Reboot Kiosk
  3	Reboot Modem	Reboot Modem
  4	Start Machine	Start Machine
  5	Set Reader In Service	Set Reader In Service
  6	Set Reader Out of Service	Set Reader Out of Service
  7	Remote Power Cycle	Manual Power Cycle
  8	All Remote Commands	Canceled Remote Control

• For the command to Start Machine, if it is issued successfully but the machine user does not press the Start button of the machine within 1 minute, the command status will indicate start failed, and the reader will return to the idle page.

• If you set a reader out of service, it will not accept any payment and displays OOS on the reader screen. You can issue another remote command like reboot, but it will stay in out-of-service status after the reboot. You need to set an OOS reader to in service for it to start working and accept payments again.

Edit Room

Click the “Edit” button in the Actions column to change the information of the room. Click the “Save” button at the bottom to save the changes to the room.

Delete Room

Click the “Delete” button in the Actions column to delete the room. Click “Yes” on the pop-up window to confirm the deletion or “No” to cancel the action.

After completing the configurations for all tabs of creating a location, be sure to click the “Save” button at the upper-right corner to save your newly created location info. All locations will be displayed on the Location Management page.