Users
=====

The \"Users\" module focuses on account management, enabling administrators to control access, assign roles, and maintain user details.

The Users section focuses on user account management. Administrators can:

- **Create User**: Add new users with specific roles.
- **View Users**: Display a list of users in a table format.
- **Update User**: Modify user details and roles.
- **Delete User**: Remove users from the system.


The "Users" module focuses on user account management, empowering administrators to control access, assign roles, and maintain user details. Refer to the **Users** section for detailed instructions on managing users.

====================
Navigating to Users
====================

To access the "Users" section:

1. On the **Home Page**, locate the **Sidebar Menu**.
2. Click on the **Users** menu item. This will expand a dropdown menu.
3. Select **View Users** to open the user management page.

====================
View All Users
====================

.. image:: /_static/en/view_all_users.png
    :alt: Optional alt text for the image
    :align: center
    :width: 800px

.. raw:: html

      <br><br>

**Actions**
    This column contains interactive icons for various actions:
- **View Icon**: Opens a detailed view of the user.  
- **Delete Icon**: Removes the user from the system.  
- **Update Icon**: Opens the user form for editing.

====================
User Fields
====================

.. image:: /_static/en/user_fields.png
    :alt: Optional alt text for the image
    :align: center
    :width: 600px
    :height: 550px


The following fields are available in the **Create/Update User**  form:

1. **Email**:  
   - The email address of the user. This field allows users to provide their contact information.

2. **Phone**:  
   - The phone number of the user. Useful for direct communication or verification purposes.

3. **Username**:  
   - The username selected by the user. This field is used for login and identification.

4. **Password**:  
   - The password associated with the user account. Ensures account security.

5. **Role**:  
   - The user’s role in the system, Helps assign appropriate permissions and responsibilities.
    - The options are following: Tenant-Admin, Manager, Accountant, Sales-Rep, Support-Rep, Teacher, Affiliate, User, Guest.

6. **First Name**:  
   - The first name of the user. Provides clarity on the user’s identity.

7. **Last Name**:  
   - The last name of the user. Completes the user’s full name.

8. **Gender**:  
   - The user’s gender, e.g., Male, Female, Other. Used for demographic categorization.

9. **Address**:  
   - The user’s address. Used for delivery purposes.

10. **City**:  
    - The city part of the address. Specifies the user's location within a country.

11. **Country**:  
    - The country part of the address. Essential for delivery categorization. The options are list of countries. 

12. **Zip Code**:  
    - The postal code for the address. Ensures accurate delivery.

**Save Button**: A button to save the user information.Submits the form for processing.  
   

Each field helps in managing and organizing the user's information effectively.


====================
Managing User
====================


Create a User
---------------------


.. image:: /_static/en/create_user.png
   :alt: Optional alt text for the image
   :align: center
   :width: 800px

.. raw:: html

   <br><br>

1. Navigate to the **View Users** page.  
2. Click the **Create User** button.  
3. Fill in the required fields and click **Save.**

View a User
-----------

   .. image:: /_static/en/view_user.png
      :alt: Optional alt text for the image
      :align: center
      :width: 800px
   
   .. raw:: html

      <br><br>

   1. Navigate to the **View Users** page.
   2. Users are displayed in a table format with all relevant details.

Update a User
---------------

   .. image:: /_static/en/update_user.png
    :alt: Optional alt text for the image
    :align: center
    :width: 800px

   .. raw:: html

      <br><br>

   1. On the **View Users** page, locate the user you want to modify.
   2. Click the **Edit** button in the **Actions** column.
   3. Make the necessary changes and click **Save.**

Delete a User
---------------

    .. image:: /_static/en/delete_user.png
      :alt: Optional alt text for the image
      :align: center
      :width: 800px

    .. raw:: html

       <br><br>


   1. On the **View Users** page, locate the user you want to delete.
   2. Click the **Delete** button in the **Actions** column.
   3. Confirm the deletion to remove the user permanently.