Skip to main content
All CollectionsGetting StartedHelm
Users Page User Guide
Users Page User Guide
Updated over 4 months ago

Welcome to the Users Page of RentalTide! This guide will help you navigate and utilize all the features available on the Users Page, ensuring efficient management of user accounts and permissions within your organization's Point of Sale (POS) system.

Introduction

The Users Page is a critical component of RentalTide's POS system, designed to provide administrators with the tools necessary to manage user accounts effectively. This page allows authorized users to:

  • View Users: Access a comprehensive list of users associated with your customer account.

  • Add Users: Create new user accounts with specific roles and permissions.

  • Edit Users: Modify existing user details, roles, and permissions.

  • Delete Users: Remove user accounts that are no longer needed.

  • Search and Filter Users: Easily locate users through search functionality and pagination.

  • Manage Permissions: Assign and update user roles and permissions to control access to various system functionalities.

Dashboard Overview

Upon accessing the Users Page, you'll encounter the following key components:

  • Dashboard Header:

    • Title: "Users"

    • Subtitle: "Add, edit, and manage user accounts and permissions."

    • Actions:

      • Add User Button: Located in the header, represented by the AddIcon, allows authorized users to create new user accounts.

      • Refresh Users Button: Represented by the RefreshIcon, enables users to refresh the list of users to view the most recent data.

  • Users Table:

    • Columns:

      • Name: Displays the full name of the user.

      • Email: Shows the user's email address.

      • User Role: Indicates the role assigned to the user (e.g., Admin, Manager, Staff).

      • Actions: Provides buttons for editing and deleting user accounts.

    • Rows: Each row represents an individual user with their respective details and action buttons.

  • Pagination Controls:

    • Located at the bottom of the table, allowing users to navigate through multiple pages of user data.

    • Options: Users can select the number of rows displayed per page (e.g., 5, 10, 25).

  • Loading Indicators:

    • CircularProgress: Displays while data is being fetched or processed to indicate loading states.

  • Modals:

    • Add User Modal: Form for creating new user accounts.

    • Edit User Modal: Form for updating existing user details.

    • Delete User Modal: Confirmation prompt before deleting a user account.

  • Notifications:

    • Snackbar Notifications: Provide real-time feedback on actions such as successful creations, updates, deletions, and error messages.

Managing Users

Efficiently manage your organization's user accounts with the intuitive features available on the Users Page. This section covers viewing users, adding new users, editing existing users, deleting users, and handling permissions.

1. Viewing Users

The Users Table provides a comprehensive view of all users associated with your customer account.

Features:

  • User Details:

    • Name: Displays the user's full name for easy identification.

    • Email: Shows the user's email address, which is unique to each user.

    • User Role: Indicates the role assigned to the user, determining their access level within the system.

  • Interactive Actions:

    • Edit User: Click the EditIcon to open the Edit User Modal and update the user's details.

    • Delete User: Click the DeleteIcon to open the Delete User Modal and remove the user account.

Usage Tips:

  • Quick Identification: Utilize the displayed user details to quickly identify and differentiate between various users.

  • Efficient Management: Use the action buttons to perform edits or deletions directly from the list without navigating away.

  • Pagination: Navigate through multiple pages of users using the pagination controls to manage large user bases effectively.

2. Adding a New User

Adding new users allows you to expand your team and assign specific roles and permissions to control access to various system functionalities.

Steps to Add a New User:

  1. Locate the Add User Button:

    • Found in the Dashboard Header, click on the Add User Button (represented by the AddIcon) to open the Add Users Modal.

  2. Fill in User Details:

    • Name: Enter the full name of the new user.

    • Email: Provide a valid email address for the user.

    • User Role: Select the appropriate role for the user (e.g., Admin, Manager, Staff) from a predefined list.

    • User Permissions: Assign specific permissions based on the user's role to control their access within the system.

    • User View Settings: Optionally, configure view settings to tailor the user's interface experience.

    • Locations: Assign the user to specific locations if applicable, determining which operational areas they have access to.

  3. Submit the Form:

    • After filling in all required fields, click the "Create User" button.

    • Loading Indicator: A CircularProgress spinner will display to indicate the ongoing creation process.

  4. Confirmation:

    • Upon successful creation, the new user will appear in the Users Table, and a success snackbar notification will confirm the action.

    • If the creation fails, an error notification will inform you of the issue.

Usage Tips:

  • Accurate Information: Ensure all fields are filled out accurately to maintain data integrity and provide a professional appearance.

  • Role Appropriateness: Assign roles carefully to ensure users have the appropriate level of access based on their responsibilities.

  • Permissions Management: Regularly review and update user permissions to adapt to changing roles and organizational needs.

3. Editing an Existing User

Editing user accounts allows you to update user details, roles, and permissions to reflect changes in responsibilities or organizational structure.

Steps to Edit a User:

  1. Locate the User in the Table:

    • In the Users Table, find the user you wish to edit based on their name or email.

  2. Initiate Editing:

    • Click on the EditIcon associated with the user to open the Edit Users Modal.

  3. Update User Details:

    • Name: Modify the user's full name if necessary.

    • Email: Update the user's email address, ensuring it remains unique.

    • User Role: Change the user's role from the dropdown menu to adjust their access level.

    • User Permissions: Assign or revoke specific permissions based on the updated role.

    • User View Settings: Adjust view settings to enhance the user's interface experience.

    • Locations: Modify the locations assigned to the user if their operational area changes.

  4. Submit the Changes:

    • After making the necessary updates, click the "Save Changes" button.

    • Loading Indicator: A CircularProgress spinner will display to indicate the ongoing update process.

  5. Confirmation:

    • Upon successful update, the user's details in the Users Table will reflect the changes, and a success snackbar notification will confirm the action.

    • If the update fails, an error notification will inform you of the issue.

Usage Tips:

  • Consistent Updates: Regularly update user details to ensure information remains current and accurate.

  • Role Reassessment: Periodically review user roles and permissions to align with evolving responsibilities and organizational changes.

  • Data Integrity: Maintain unique email addresses to prevent conflicts and ensure proper communication channels.

4. Deleting a User

Removing user accounts that are no longer needed helps maintain an organized and efficient user management system.

Steps to Delete a User:

  1. Locate the User in the Table:

    • In the Users Table, find the user you wish to delete based on their name or email.

  2. Initiate Deletion:

    • Click on the DeleteIcon associated with the user to open the Delete Users Modal.

  3. Confirm Deletion:

    • Review the confirmation message to ensure you intend to delete the user account.

    • Click the "Delete" button to proceed.

    • Loading Indicator: A CircularProgress spinner will display to indicate the ongoing deletion process.

  4. Confirmation:

    • Upon successful deletion, the user will be removed from the Users Table, and a success snackbar notification will confirm the action.

    • If the deletion fails, an error notification will inform you of the issue.

Usage Tips:

  • Accidental Deletion Prevention: Always confirm deletions to avoid accidental removal of important user accounts.

  • Role Considerations: Ensure that critical roles (e.g., Admin) are not deleted inadvertently to maintain system integrity.

  • Permission Restrictions: Only users with the appropriate permissions can delete user accounts to prevent unauthorized access.

5. Searching and Filtering Users

Efficiently locate specific users through search functionality and manage large user bases with ease.

Features:

  • Search Query:

    • A search bar allows you to input queries to filter users based on their name or email.

  • Pagination Controls:

    • Navigate through multiple pages of users using the pagination controls.

    • Options: Choose the number of users displayed per page (e.g., 5, 10, 25).

Usage Tips:

  • Keyword Usage: Use specific keywords related to the user's name or email to quickly locate the desired user.

  • Page Navigation: Utilize pagination to manage and navigate through large numbers of users without overwhelming the interface.

  • Combination of Search and Pagination: Combine search queries with pagination to efficiently handle extensive user lists.

Permissions and Access Control

Access to the Users Page is governed by a robust permissions system to ensure that only authorized users can view and manage user data.

Key Permissions:

  • users_access: Grants access to the Users Page and its functionalities.

  • users_add: Allows users to add new user accounts.

  • users_edit: Permits users to edit existing user accounts.

  • users_delete: Enables users to delete user accounts.

Managing Permissions:

  • Role-Based Access: Permissions are typically assigned based on user roles within the organization (e.g., Admin, Manager, Staff).

  • Verification: The Users 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 Users Page.

  • Requesting Access: If you lack certain permissions but require them for your role, contact your system administrator or support team to request access.

  • Regular Audits: Periodically review and update user permissions to align with organizational changes and role evolutions.

Error Handling and Notifications

The Users 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 user creations, updates, deletions, and error messages when operations fail.

  • Loading Indicators:

    • CircularProgress: Indicates ongoing operations like data fetching, user creation, updates, and deletions.

  • Error Messages:

    • Inform users of any failures during operations like fetching users, creating new users, updating existing users, or deleting users.

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 alerts immediately to ensure smooth operations and accurate user management.

  • Maintain Connectivity: Ensure a stable internet connection to facilitate seamless data fetching and user management.

Frequently Asked Questions (FAQs)

1. How do I add a new user?

  • Answer:

    1. Click on the Add User Button (represented by the AddIcon) located in the Dashboard Header.

    2. Fill in the required user details in the Add Users Modal.

    3. Assign the appropriate role and permissions to the new user.

    4. Click the "Create User" button to finalize the creation.

    5. A success notification will confirm the successful addition of the user.

2. Why can't I edit a specific user?

  • Answer:

    • Possible Causes:

      • Your user account lacks the users_edit permission.

      • The user you are trying to edit has restricted permissions or is a system-critical account.

    • Solutions:

      1. Check Permissions: Ensure your account has the users_edit permission.

      2. Contact Administrator: If you believe you should have access, reach out to your system administrator or support team.

      3. Review User Roles: Confirm that the user you are attempting to edit is eligible for modifications based on their role.

3. Why is the "Add User" button disabled?

  • Answer:

    • The "Add User" button may be disabled if:

      • Your user account lacks the users_add permission.

      • The system has reached the maximum number of users allowed for your customer account.

    • Solutions:

      1. Check Permissions: Verify that your account has the users_add permission.

      2. Review User Limits: Confirm if your customer account has a limit on the number of users and whether it has been reached.

      3. Contact Support: If you require the ability to add more users, contact RentalTide support or your account manager to discuss upgrading your plan.

4. How can I refresh the list of users?

  • Answer:

    • Click on the Refresh Users Button (represented by the RefreshIcon) located in the Dashboard Header.

    • The system will re-fetch the latest user data, updating the Users Table accordingly.

    • A success notification will confirm the successful refresh of the user list.

5. Why am I receiving an error when trying to delete a user?

  • Answer:

    • Possible Causes:

      • Your user account lacks the users_delete permission.

      • The user account you are attempting to delete is currently active or in use.

      • Network connectivity issues preventing the deletion process.

    • Solutions:

      1. Check Permissions: Ensure your account has the users_delete permission.

      2. Verify User Status: Confirm that the user is not actively engaged in critical operations or system processes.

      3. Retry Deletion: Attempt to delete the user again after ensuring stable internet connectivity.

      4. Contact Support: If the issue persists, reach out to support with specific error details for assistance.

6. Can I assign multiple locations to a user?

  • Answer:

    • Yes, during the user creation or editing process, you can assign multiple locations to a user, determining which operational areas they have access to within the system.

7. Is there a limit to the number of users I can manage?

  • Answer:

    • The maximum number of users you can manage is determined by your customer account's plan and the maxUsers setting retrieved from your user permissions. If you reach this limit, you may need to upgrade your plan or contact RentalTide support to discuss your requirements.

Troubleshooting

Issue 1: Unable to Fetch Users

  • Possible Cause: Network connectivity issues, server downtime, or insufficient permissions.

  • Solution:

    1. Check Internet Connection: Ensure your device is connected to the internet.

    2. Verify Permissions: Make sure your user account has the users_access permission.

    3. Refresh the Page: Click the Refresh Users Button to attempt fetching users again.

    4. Retry Later: The server might be experiencing downtime. Wait a few minutes and try again.

    5. Contact Support: If the issue persists, reach out to the support team with specific error details for assistance.

Issue 2: Add User Functionality Not Working

  • Possible Cause: JavaScript errors, UI glitches, or insufficient permissions.

  • Solution:

    1. Check Permissions: Ensure your user account has the users_add permission.

    2. Refresh the Page: Reload the Users Page to reset UI components.

    3. Inspect Console for Errors: Open your browser’s developer console to check for JavaScript errors that may be preventing the modal from opening.

    4. Disable Browser Extensions: Some extensions might interfere with modal functionalities. Disable them and try again.

    5. Clear Browser Cache: Clear your browser’s cache and attempt to add a user again.

    6. Contact Support: If the issue persists, notify support with specific error details for further assistance.

Issue 3: Edit User Modal Not Opening

  • Possible Cause: UI glitches, permissions issues, or JavaScript errors.

  • Solution:

    1. Check Permissions: Ensure your user account has the users_edit permission.

    2. Refresh the Page: Reload the Users Page to reset UI components.

    3. Inspect Console for Errors: Open your browser’s developer console to check for JavaScript errors.

    4. Disable Browser Extensions: Some extensions might interfere with modal functionalities. Disable them and try again.

    5. Clear Browser Cache: Clear your browser’s cache and attempt to edit a user again.

    6. Contact Support: If the issue persists, notify support with specific error details for further assistance.

Issue 4: Delete User Functionality Not Working

  • Possible Cause: Insufficient permissions, attempting to delete the current user, or JavaScript errors.

  • Solution:

    1. Check Permissions: Ensure your user account has the users_delete permission.

    2. Prevent Self-Deletion: The system prevents users from deleting their own accounts to maintain system integrity.

    3. Refresh the Page: Reload the Users Page to reset UI components.

    4. Inspect Console for Errors: Open your browser’s developer console to check for JavaScript errors.

    5. Disable Browser Extensions: Some extensions might interfere with modal functionalities. Disable them and try again.

    6. Clear Browser Cache: Clear your browser’s cache and attempt to delete a user again.

    7. Contact Support: If the issue persists, notify support with specific error details for further assistance.

Issue 5: Users Not Displaying Correctly in the Table

  • Possible Cause: Data fetching errors, rendering issues, or corrupt user data.

  • Solution:

    1. Check Internet Connection: Ensure your device is connected to the internet.

    2. Refresh the Page: Click the Refresh Users Button to re-fetch the latest user data.

    3. Inspect Console for Errors: Open your browser’s developer console to check for JavaScript or data fetching errors.

    4. Verify Data Integrity: Ensure that the user data being fetched is correctly formatted and not corrupt.

    5. Disable Browser Extensions: Some extensions might interfere with data rendering. Disable them and try again.

    6. Contact Support: If the issue persists, reach out to support with specific error details and screenshots for assistance.

Issue 6: Pagination Not Working as Expected

  • Possible Cause: Incorrect implementation of pagination logic, rendering issues, or state management errors.

  • Solution:

    1. Verify Pagination Settings: Ensure that the rowsPerPage and page state variables are correctly managed and updated.

    2. Check Data Slicing: Confirm that the user data is being sliced correctly based on the current page and rows per page.

    3. Inspect Console for Errors: Open your browser’s developer console to identify any JavaScript errors affecting pagination.

    4. Refresh the Page: Reload the Users Page to reset state and pagination controls.

    5. Disable Browser Extensions: Some extensions might interfere with pagination functionalities. Disable them and try again.

    6. Contact Support: If the issue persists, notify support with specific error details and examples for further assistance.

Related Articles
Transaction Page User Guide
Accounts Page User Guide
Email Templates Management Page User Guide
Text Templates Management Page User Guide
Stores Page User Guide
Did this answer your question?