Welcome to the Terminal Management Page of RentalTide! This guide will help you navigate and utilize all the features available on the Terminal Management Page, ensuring efficient management of terminal readers within your Point of Sale (POS) system.
Introduction
The Terminal Management Page is an essential component of RentalTide's POS system, designed to streamline the management of terminal readers. This page allows authorized users to:
View Terminal Readers: Access detailed information about each terminal reader associated with your locations.
Pair New Readers: Connect new terminal readers using registration codes.
Edit Terminal Readers: Update reader details such as labels and locations.
Delete Terminal Readers: Remove terminal readers from the system.
Order New Terminals: Submit orders for new terminal devices.
Handle Multiple Locations: Manage terminal readers across various locations seamlessly.
Dashboard Overview
Upon accessing the Terminal Management Page, you'll encounter the following key components:
Dashboard Header:
Title: "Manage Terminal Readers"
Subtitle: "Manage your Terminal readers."
Actions:
Order a Terminal Button: Allows authorized users to order new terminal devices.
Pair Terminal Button: Facilitates the pairing of new terminal readers using registration codes.
Loading Indicators:
CircularProgress: Indicates ongoing operations like data fetching or processing actions.
Error Handling:
Error Messages: Displayed prominently to inform users of any issues encountered while fetching or managing terminal readers.
Readers Table:
Table Columns:
Label: The name assigned to the terminal reader.
Location: The location associated with the reader.
Serial Number: The unique serial number of the reader.
Device Type: The type of terminal device.
Status: Current status of the reader (e.g., active, inactive).
Actions: Options to edit or delete the reader.
Dialogs:
Pair Reader Dialog: Guides users through the process of pairing a new reader.
Edit Reader Dialog: Allows users to update reader details.
Order Terminal Dialog: Facilitates the ordering of new terminal devices.
Managing Terminal Readers
Efficiently manage your terminal readers with the intuitive features available on the Terminal Management Page. This section covers viewing readers, pairing new readers, editing existing readers, deleting readers, and ordering new terminals.
Viewing Terminal Readers
The Readers Table provides a comprehensive view of all terminal readers associated with your selected location or across all locations.
Features:
Reader Details:
Label: Displays the assigned name of the reader. If unnamed, it shows as "Unnamed".
Location: Indicates the location to which the reader is assigned.
Serial Number: Shows the unique serial number of the reader.
Device Type: Specifies the type of terminal device.
Status: Reflects the current operational status of the reader (e.g., active, inactive).
Interactive Actions:
Edit Button: Click to open the Edit Reader Dialog for updating reader details.
Delete Button: Click to remove the reader from the system after confirmation.
Usage Tips:
Quick Identification: Utilize the displayed reader details to quickly identify and differentiate between terminal readers.
Efficient Management: Use the action buttons to perform edits or deletions directly from the table without navigating away.
Pairing New Readers
Pairing new terminal readers ensures that your POS system recognizes and communicates with the physical devices.
How to Pair a New Reader:
Access Pair Terminal Button:
Located in the Dashboard Header, click on the "Pair Terminal" button to open the Pair Reader Dialog.
Select Location:
In the dialog, choose the location where the reader will be paired. This ensures the reader is associated with the correct branch.
Enter Registration Code:
Input the registration code displayed on the terminal device. If you don't have a registration code:
Swipe right on the terminal screen.
Click on Device Settings.
Type 07139.
Click Generate pairing code to obtain a new code.
Submit Pairing Request:
After entering the necessary details, click the "Pair" button.
The system will process the pairing, updating both Stripe and your local data.
Confirmation:
Upon successful pairing, a success notification will appear, and the new reader will be listed in the Readers Table.
Usage Tips:
Accurate Codes: Ensure the registration code entered matches the one displayed on the terminal to avoid pairing errors.
Location Verification: Double-check the selected location to ensure the reader is assigned correctly.
Network Connectivity: Ensure a stable internet connection during the pairing process to facilitate seamless communication with Stripe.
Editing Terminal Readers
Updating reader details allows for accurate identification and management of terminal devices.
How to Edit a Reader:
Locate the Reader:
In the Readers Table, find the reader you wish to edit.
Open Edit Reader Dialog:
Click on the Edit Icon (represented by the EditIcon) associated with the reader.
This action opens the Edit Reader Dialog pre-filled with the reader's current details.
Update Reader Details:
Label: Modify the name assigned to the reader.
Location: (Optional) Change the location if the reader has been moved to a different branch.
Submit Changes:
After updating the desired fields, click the "Save" button.
The system will update the reader's information in both Stripe and your local data.
Confirmation:
A success notification will appear, and the updated details will reflect in the Readers Table.
Usage Tips:
Consistent Naming: Use clear and consistent labels for readers to facilitate easy identification.
Location Accuracy: Ensure that the location is updated accurately if the reader has been relocated.
Review Changes: Double-check all changes before saving to prevent data inconsistencies.
Deleting Terminal Readers
Removing terminal readers that are no longer in use helps maintain an organized and efficient system.
How to Delete a Reader:
Locate the Reader:
In the Readers Table, find the reader you wish to delete.
Initiate Deletion:
Click on the Delete Icon (represented by the DeleteIcon) associated with the reader.
A confirmation prompt will appear to prevent accidental deletions.
Confirm Deletion:
Confirm the deletion by clicking "OK" or the equivalent confirmation button.
The system will remove the reader from both Stripe and your local data.
Confirmation:
A success notification will appear, and the reader will no longer be listed in the Readers Table.
Usage Tips:
Confirmation Prompt: Always confirm deletions to avoid accidental removal of active readers.
Review Dependencies: Ensure that the reader is not associated with any ongoing transactions or operations before deletion.
Permission Checks: Only users with the appropriate permissions can delete readers to maintain system integrity.
Ordering New Terminals
Submitting orders for new terminal devices ensures that your operations remain smooth and up-to-date with the latest hardware.
How to Order a Terminal:
Access Order a Terminal Button:
Located in the Dashboard Header, click on the "Order a Terminal" button to open the Order Terminal Dialog.
Specify Order Details:
Number of Terminals: Enter the desired quantity of terminal devices.
Shipping Address: Provide the address where the terminals should be shipped.
Review Order Summary:
An estimated total cost is displayed, including the price per terminal, shipping cost, and applicable taxes.
Submit Order:
Click the "Submit Order" button to finalize the order.
The system will send the order details to the designated Slack channel for processing.
Confirmation:
Upon successful submission, a success notification will appear, and the order dialog will close.
Usage Tips:
Accurate Quantities: Ensure that the number of terminals ordered matches your operational needs.
Valid Shipping Address: Double-check the shipping address to prevent delivery issues.
Review Costs: Verify the total cost to ensure it aligns with your budget before submitting the order.
Permissions and Access Control
Access to the Terminal Management Page is governed by a robust permissions system to ensure that only authorized users can view and manage terminal readers.
Key Permissions:
pos_manage_terminals: Grants access to view, add, edit, and delete terminal readers.
Managing Permissions:
Role-Based Access: Permissions are typically assigned based on user roles within the organization (e.g., Admin, Manager, Technician).
Verification: The Terminal Management Page checks user permissions before rendering action buttons or enabling functionalities to prevent unauthorized access.
Usage Tips:
Ensure Proper Access: Verify that your user account has the necessary permissions to perform desired actions on the Terminal Management Page.
Requesting Access: If you lack certain permissions but require them for your role, contact your system administrator or support team to request access.
Error Handling and Notifications
The Terminal Management Page incorporates robust error handling and user-friendly notifications to keep you informed about the system's status and any issues that may arise.
Key Features:
Snackbar Notifications:
Provide real-time feedback on actions such as successful pairings, deletions, edits, and error messages when operations fail or encounter issues.
Loading Indicators:
CircularProgress: Indicates ongoing operations like data fetching or processing actions.
Skeleton Loaders: Displayed while data is being loaded to indicate ongoing processes and improve user experience.
Dialogs and Alerts:
Pair Reader Dialog: Guides users through the reader pairing process with necessary inputs and instructions.
Edit Reader Dialog: Facilitates the updating of reader details with form inputs.
Order Terminal Dialog: Assists users in submitting orders for new terminals with required details.
Error Messages: Inform users of any failures during operations like fetching data, pairing readers, or deleting readers.
Usage Tips:
Immediate Feedback: Pay attention to snackbar notifications for instant updates on your actions and system status.
Handle Errors Promptly: Address any error messages or dialogs immediately to ensure smooth operations and accurate terminal management.
Maintain Connectivity: Ensure a stable internet connection to facilitate seamless data fetching and terminal reader management.
Frequently Asked Questions (FAQs)
1. How do I pair a new terminal reader?
Answer: Click on the "Pair Terminal" button in the Dashboard Header to open the Pair Reader Dialog. Select the desired location, enter the registration code displayed on the terminal device, and submit the pairing request. Upon successful pairing, the reader will appear in the Readers Table.
2. Why is the "Pair" button disabled or not responding?
Answer: The "Pair" button may be disabled if required fields like Location or Registration Code are not filled. Ensure all necessary information is provided. Additionally, verify that your user account has the pos_manage_terminals permission. If the issue persists, contact support for assistance.
3. How can I edit the details of an existing reader?
Answer: In the Readers Table, locate the reader you wish to edit and click on the Edit Icon (represented by the EditIcon). Update the desired fields in the Edit Reader Dialog and click "Save" to apply the changes. The reader's details will be updated in both Stripe and your local data.
4. Why am I seeing an error message when trying to delete a reader?
Answer: Error messages during deletion can occur due to network issues, insufficient permissions, or server errors. Ensure you have the pos_manage_terminals permission and a stable internet connection. If the problem persists, contact support with specific error details for further assistance.
5. Can I manage terminal readers across all locations simultaneously?
Answer: Yes, by selecting "All Locations", you can view and manage readers across all branches. However, certain actions like pairing or deleting may require specifying individual locations to ensure accurate management.
6. How do I order new terminals, and how are the costs calculated?
Answer: Click on the "Order a Terminal" button in the Dashboard Header to open the Order Terminal Dialog. Specify the number of terminals and provide the shipping address. The total cost is calculated based on the number of terminals, shipping costs, and applicable taxes. Upon submission, the order details are sent to the designated Slack channel for processing.
7. Is my terminal reader data secure on this page?
Answer: Yes, all terminal reader data displayed on the Terminal Management Page is securely transmitted and stored in compliance with data protection standards. Access is restricted based on user permissions to ensure data privacy and security.
Troubleshooting
Issue 1: Unable to Pair a New Reader
Possible Cause: Incorrect registration code, network issues, or insufficient permissions.
Solution:
Verify Registration Code: Ensure that the registration code entered matches the one displayed on the terminal device.
Check Permissions: Confirm that your user account has the pos_manage_terminals permission.
Ensure Connectivity: Make sure your device has a stable internet connection.
Retry Pairing: Attempt to pair the reader again after verifying the above.
Contact Support: If the issue persists, reach out to the support team with specific error details.
Issue 2: Reader Not Appearing After Pairing
Possible Cause: Delayed synchronization with Stripe, network issues, or API errors.
Solution:
Wait and Refresh: Allow some time for the system to process the pairing and refresh the page.
Check Network: Ensure there are no connectivity issues that might prevent data synchronization.
Verify API Status: Confirm that RentalTide's Stripe integration services are operational.
Manual Refresh: Use the refreshLocations function or refresh the page manually.
Contact Support: If the reader still does not appear, report the issue to support for further investigation.
Issue 3: Cannot Edit Reader Details
Possible Cause: Insufficient permissions, network issues, or API errors.
Solution:
Check Permissions: Ensure your user account has the pos_manage_terminals permission.
Verify Connectivity: Confirm that your device is connected to the internet.
Retry Editing: Attempt to edit the reader again after verifying permissions and connectivity.
Contact Support: If the problem continues, contact support with specific error details for assistance.
Issue 4: Delete Reader Button Not Working
Possible Cause: Insufficient permissions, network issues, or API errors.
Solution:
Check Permissions: Verify that your user account has the pos_manage_terminals permission.
Ensure Connectivity: Make sure your device has a stable internet connection.
Confirm Deletion: Ensure that you have confirmed the deletion when prompted.
Retry Deletion: Attempt to delete the reader again.
Contact Support: If deletion fails repeatedly, reach out to support with detailed information.
Issue 5: Order Terminal Submission Fails
Possible Cause: Network issues, incorrect shipping address, or API errors.
Solution:
Verify Shipping Address: Ensure that the shipping address entered is accurate and complete.
Check Network Connection: Confirm that your device is connected to the internet.
Retry Ordering: Attempt to submit the order again after verifying the above.
Contact Support: If the submission continues to fail, provide the error details to support for further assistance.
Issue 6: Order Terminal Confirmation Message Not Appearing
Possible Cause: Popup blockers, browser issues, or network delays.
Solution:
Disable Popup Blockers: Ensure that your browser allows popups from RentalTide.
Refresh the Page: Reload the Terminal Management Page to reset UI components.
Check Browser Compatibility: Use a supported and updated browser version.
Contact Support: If confirmation messages still do not appear, notify support with specific details.
Issue 7: All Locations Modal Appears Unexpectedly
Possible Cause: Selecting "All Locations" triggers the modal to prompt for a specific location.
Solution:
Select Specific Location: Choose a single location from the location selector to proceed with terminal management.
Understand Modal Purpose: The modal ensures that actions are performed for individual locations to maintain data accuracy.
Contact Support: If the modal appears without selecting "All Locations," reach out to support for troubleshooting.