feat: initialize project backend structure and document system specifications across all modules
This commit is contained in:
47
docs/specs/oneaccess/user_group.md
Normal file
47
docs/specs/oneaccess/user_group.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: "User Group"
|
||||
type: OpenSpec
|
||||
status: Draft
|
||||
domain: OneAccess
|
||||
---
|
||||
|
||||
# User Group
|
||||
|
||||
## Requirement Definition
|
||||
The User Group module is utilized to categorize users who share identical permissions within OLS. It defines the group to be assigned to a particular user or group of users.
|
||||
|
||||
## Process Flow
|
||||
|
||||
### Trigger
|
||||
- A new user group needs to be defined.
|
||||
- An existing user group needs to be modified, or a user needs to review the existing group.
|
||||
|
||||
### Pre-Conditions
|
||||
- Users must have access rights to the User Group module to view, add, or edit user group records.
|
||||
|
||||
## Business Rules
|
||||
- The user group ID must be a unique value.
|
||||
|
||||
### Data Schema
|
||||
|
||||
#### General Information
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| User Group ID | The identity of the user group. | String (10) | Required. Must be unique. |
|
||||
| User Group Name | The name of the user group. | String (100) | Required. |
|
||||
| Description | Description for the user group. | String (200) | Optional. |
|
||||
|
||||
#### Group Users (View Only)
|
||||
*Lists all active User Profile records assigned to this group.*
|
||||
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| User ID | The identity of the user belonging to the chosen group. | String | Read-only |
|
||||
| User Name | The name of the user. | String | Read-only |
|
||||
| Email | Email address of the user. | String | Read-only |
|
||||
|
||||
## Post-Conditions
|
||||
- The data is updated in the database and related screens.
|
||||
|
||||
## Exception Flow
|
||||
- If input data fails validation, the action is canceled, and the operation fails.
|
||||
Reference in New Issue
Block a user