Add & Edit User Groups

User Groups in Rayven provide a secure and scalable way to manage permissions and access across users. By configuring user groups, you define exactly what users can see, do, and interact with — from interfaces and data to workflows and reports.

➕ Add a New User Group

To create a new user group:

Navigate to User Groups from the main menu.
Click Add New.
Fill in the following fields:
- User Group Name – A clear, descriptive name.
- Description (optional) – Add context for the group's purpose.
- Filter By – Apply data filters (e.g., Customer = Rayven) to restrict data access.
- Time Zone – Set the default time zone for this group.
- Group Type – Choose from:
  - Shared Group – Access shared across users.
  - Shared Device Filters – Enforces filter-based data access.
Click Save to create the group.

✏️ Edit an Existing User Group

To edit a group (e.g., "Admin" in "Water Basic"):

Navigate to User Groups and click on the group you want to edit.
Update the following as needed:

🔧 Group Details

Field	Description
User Group Name*	Required field; update the group’s name if necessary
Description	Optional description for context or notes
Filter By	Apply or change data filters (e.g., `Customer=Rayven`)
Label Settings	Click to manage label options for data segmentation
Time Zone	Set or update the default time zone
Group Type	Modify between Shared Group and Shared Device Filters

🔍 Filtering Data by Labels

Rayven allows you to filter data for user groups using label-based filters, ensuring users only access the specific slice of data relevant to their role, location, customer, or business unit.

Filtering is configured within the User Group settings under the "Filter By" section.

📌 What Are Labels?

Labels are key-value tags attached to devices, data streams, or workflows. Common examples include:

Customer = Rayven
Site = Plant A
Region = NSW
Team = Maintenance

These labels can be used as filters to segment data across interfaces, dashboards, and workflows.

🛠️ How to Set Up Filters

In the User Group settings, locate the "Filter By" field.
Add your desired filter(s) in the format:
LabelKey = Value
Example:
Customer = Rayven
Region = NSW
Multiple filters can be stacked, and the system will apply them using AND logic (i.e., all conditions must match).
When a user in this group logs in, they will only see data associated with those label values — across all assigned interfaces and reports.

💡 Use Cases for Filtering

Use Case	Example Filter	Outcome
Customer-Specific Views	`Customer = Rayven`	Users only see data from Rayven’s environments
Region-Based Access	`Region = North`	Dashboards and workflows show only North region data
Department-Specific Interfaces	`Team = Maintenance`	Maintenance users see only relevant devices and controls
Client Portal Separation	`ClientID = 3249`	Enables full white-label data separation for different clients

🧩 Tip

You can manage and configure label keys centrally, and then apply them consistently across devices and workflows. This makes it easy to scale access controls without complex permission logic.

👥 Manage Users in the Group

To assign or remove users:

Use the Add a new user dropdown to select from available users.
To remove users, click the Remove icon next to their name or use Remove All to clear the group.

📊 Interface & Access Assignment

Assign access to interfaces, forms, reports, and templates:

Section	Description
Select Interfaces	Choose from available interfaces (e.g. Tank Storage, Valve, Workforce)
Select Forms	Assign form access (if applicable)
Select Report Templates	Give access to specific report templates
Select Reports	Assign full reports for view or interaction
Messages	View system messages or alerts associated with this group (if any)

You’ll see a live count of selected items (e.g. "7 Interfaces Selected").

✅ Save Changes

Once your updates are complete, click Save to apply the changes to the group.