User Management
The user management console is where you can view a list of all users, their assigned access control groups and audit logs ensuring secure and managed access to building data and insights.
Summary
The main page of the user management console provides a summary of the key metrics related to the organisation. The user management is structured in four sections: Summary, Members, Access Control and Audit.
[Insert Image]
Admin Members The total count of members with administrative access in the organisation.
Active Members The total count of active members in the organisation
Total Members The total count of members in the organisation.
Groups The total count of groups which are used to manage user permissions in the organisation.
Members
This page provides a detailed list of all users within the organisation. This is a key part of the user management console, allowing administrators to see and interact with user accounts.
[Insert Image]
Add Member An "Add New Member" modal window will appear when an administrator wants to invite a new user to the organisation. It is designed to capture the necessary information to set up a new user account and define their permissions.
[Insert Image]
The details to be entered are:
Email Address: A text field where the administrator must enter the email address of the new member. This email will be used to send an invitation to join the platform.
Organisation Admin Toggle: A toggle switch that, when enabled, designates the new member as an "Organisation Admin." This would grant them a higher level of administrative privileges across the entire organisation.
Groups: This section allows the administrator to assign the new member to specific access control groups.
Find Group: A search bar to quickly find and select specific groups.
Group List: A table that lists the available groups (e.g., "default," "read," "write").
Access Level: For each group, there are three options to define the member's access: "Admin," "User," and "None." The administrator can select one of these options to control the member's permissions within that specific group.
Delete button Organisation Admins can select users from the list and delete multiple at a time.
Find Member Search It lists the specific access control groups that each user is assigned to.
The table on this page shows the following data for each member:
Member Name The full name and email address of each user.
Access This column specifies the user's role or level of access, such as "User."
Groups It lists the specific access control groups that each user is assigned to.
Date Added This shows the date on which the user joined the organization.
Last Login This indicates the date and time of the user's most recent login.
Access Control
This section is dedicated to managing access control groups, which are used to define permissions for different sets of users.
Add Group Allows an administrator to create a new access control group. Clicking this button opens a modal window with the following fields and tabs for defining the new group's permissions.
[Insert Image]
General Tab
The details to be entered are:
Name: A text field to enter the name of the new group.
Default: A toggle switch to set this group as the default for new members.
Bitpool AI: A toggle for "Access Level" (Enable/Disable).
Dashboards: Configures permissions related to dashboards:
Access Level: Options for "Write," "Read," or "Disable."
Access Scope: "All" or "Custom" to define which dashboards can be accessed.
Comments: Options for "Write," "Read," or "Disable" for adding comments.
Sharing and Presentations: A toggle for "Enable/Disable" to control sharing capabilities.
Data and Sites: Configures "Access Level" for data and sites, with options for "Write," "Read," or "Disable."
Report Manager: Configures "Access Level" for the report manager, with options for "Write," "Read," or "Disable."
[Insert Image]
Members Tab
This tab allows an administrator to define which users belong to a newly created or existing access control group:
Add Member: Add new members to the specific group being created or edited from a list of existing members within the organisation.
Manage Acceess: The table displayes the members who have been added to the group and provides a quick way to manage their access level within that specific group. The table shows the following details:
Member Name: The name and email of the member.
Access: This column contains a toggle with two options: "Admin" and "User." This allows the administrator to quickly assign a specific access level for each member.
Date Added: The date on which the member was added to the group.
[Insert Image]
Dashboards Tab
This tab allows an administrator to define which dashboards a new group will have access to.
Find Dashboards: Search through the dashboards to quickly find specific dashboards by name.
Select Dashboards from Navigation Tree: Each dashboard and dashboard group has a checkbox next to it. By checking a box, an administrator can grant access to that specific dashboard or to all dashboards within that group.
[Insert Image]
Data Tab
This tab allows an administrator to define which data pools a new or existing group will have access to.
Add Pool: Clicking this button opens a modal window titled "Add Pools" which prompts the user to select the desired pools from a list.
Select Pools from Drop-down List: Within the "Add Pools" modal, a drop-down list and checkboxes are used to select the data pools. The drop-down menu lists all available data pools that can be added.
[Insert Image]
Site Tab
This tab allows an administrator to define which sites a new or existing group will have access to.
Add Site: Clicking this button opens a modal window titled "Add Sites" which prompts the user to select the desired sites from a list.
Select Sites from Drop-down List: Within the "Add Sites" modal, a drop-down list and checkboxes are used to select the Sites. The drop-down menu lists all available Sites that can be added.
Audit
This section is a crucial feature for security and accountability. It provides a comprehensive log of user actions and system events, allowing administrators to monitor activity within the platform.
[Insert Image]
Audit Log Table: The audit log is displayed in a table format with the following columns, providing detailed information for each logged event:
Username: The username or email of the user who performed the action. This clearly identifies the individual responsible for the event.
Timestamp: The date and time when the event occurred. This allows administrators to track the exact sequence of events. The format shown is
DD/MM/YYYY HH:MM:SS.Action: A brief description of the specific action that was performed. In the screenshot, all actions are "Login," indicating that the log is tracking user authentication events. Other actions could include "API Key Expired", "Create API Key" etc.
Description: A more detailed explanation of the action, often including contextual information. This detail helps to verify the source and method of the login.
Search: The search bar on the audit log page enables you to find specific entries by searching for a username, action, or keyword in the description.
Last updated