Grid Behaviours Feature -v2.5.0
- Hung Techlead
Release Notes: Grid Behaviours - v2.5
Release Date: January 6th, 2025
This release document provides a detailed overview of the new Grid Behaviours Feature, outlining its purpose, functionality, and key benefits.
It aims to help users understand how the feature facilitates editable and read-only access management within grids. It includes step-by-step instructions for using the feature, and highlights any technical dependencies or requirements.
By providing this information, the document ensures smooth adoption and integration of the Grid Behaviours Feature into existing workflows.
Overview
Idea: Grid Behaviours feature enables restrictions on editing grid content based on user group and issue status. It simplifies access management within grids by defining editable and read-only permissions.
Goal: The primary goal is to provide a streamlined workflow and interface for configuring and applying grid editing restrictions, ensuring flexible yet controlled access to grid content.
Key Features
Grid Configuration UI Update
A new "Grid Behaviours" tab is added to the grid configuration interface for managing grid behaviours.
Configure New Grid Behaviours
A button labelled "Add Grid Behaviours" allows users to create and configure grid behaviours. Clicking opens a form-based popup.
Edit Grid Behaviours Configuration
Users can edit the existing grid behaviours configuration by clicking “Edit” button on each one.
Delete Grid Behaviours
Users can delete the existing grid behaviours by clicking “Delete” button on each one.
Apply Grid Behaviours to Grids
Apply access for a user to a grid on an issue based on:
Attribute (Editable/Read-only)
Condition (Issue Status)
Restriction (Users/Groups/Everyone)
In the current version, Grid Behaviours are not supported for team-managed projects; they are only available for company-managed projects.
Audit Log Monitoring
Tracks grid behaviour logs with a focus on conflicts and errors. Automatic cleanup of logs older than 24 hours (daily at 00:00 UTC).
Instructions for Use
Add Grid Behaviour
Step 1: Open Grid Behaviours tab
Navigate to the grid configuration interface.
Select the "Grid Behaviours" tab.
Step 2: Adding a new Grid Behaviour
Click "Add Grid Behaviours" button to add your first grid behaviour.
When you already have grid behaviours, click “Add” button to add a new grid behaviour.
Step 3: Configuring Grid Behaviour
Name Input: Enter your grid behaviour’s name
Element Input: Pre-selected as "Grid" (default) and you can not change it.
Attribute Input: Choose between "Editable" or "Read-only".
Editable: Users who have this access can read and edit the grid.
Read-only: Users who have this access can read and can not edit the grid.
Condition Input: Select "Issue Status".
Issue Status Input: Select applicable statuses (e.g., "Open", "Closed").
6. Restriction Input: Select "Everybody", specific "Users", or specific "Groups".
6.1 Everybody: Apply the access of this grid behaviour to all users in the current organization.
6.2 Users: Apply the access of this grid behaviour to all the selected users.
6.3 Groups: Apply the access of this grid behaviour to all users in the selected groups.
Click "Save" to temporarily save the grid behaviour configuration.
After saving, the new grid behaviour will be displayed on the Behaviours List.
Click “Save” to save the grid configuration and the grid behaviour also.
Apply Grid Behaviours to Grids
Example:
John Doe opens Issue A has Issue Status Done, including Grid 1.
Step 1: Rearrange grid behaviours based on Issue Status, Restriction, and Created Date.
Grid 1 includes 7 grid behaviours sorted by earlier created date.
There are 3 steps to rearrange the initial behaviours list:
Rank up grid behaviours including Issue Status = Done
For grid behaviours have the same Issue Status, rank up grid behaviours including current user (John Doe) in Restriction and sort by the order Users>Groups>Everyone
For grid behaviours have the same Issue Status and Restriction, rank up grid behaviours created earlier than others → GB2 > GB5
Initial Behaviours List in Grid 1
Scenario: John Doe opens Issue A (Issue Status Done) including Grid 1 | ||||
Order by earlier created date | Name | Attribute | Issue Status | Restriction |
1 | GB1 | Read-only | Todo | Groups (including John Doe) |
2 | GB2 | Read-only | Done | Users (John Doe) |
3 | GB3 | Read-only | In Progress | Users (Jessica) |
4 | GB4 | Read-only | Done | Everyone |
5 | GB5 | Editable | Done | Users (John Doe) |
6 | GB6 | Editable | Done | Groups (including John Doe) |
7 | GB7 | Editable | Done | Groups (not including John Doe) |
Rearranged Behaviours List following the rule in Step 1
Scenario: John Doe opens Issue A (Issue Status DONE) including Grid 1 | ||||
Order by earlier created date | Name | Attribute | Issue Status | Restriction |
2 | GB2 | Read-only | Done | Users (John Doe) |
5 | GB5 | Editable | Done | Users (John Doe) |
6 | GB6 | Editable | Done | Groups (including John Doe) |
4 | GB4 | Read-only | Done | Everyone |
7 | GB7 | Editable | Done | Groups (not including John Doe) |
1 | GB1 | Read-only | Todo | Groups (including John Doe) |
3 | GB3 | Read-only | In Progress | Users (Jessica) |
Step 2: Apply the first grid behaviours in the list to the grid
Order by earlier created date | Name | Attribute | Issue Status | Restriction | Apply or not | Explanation |
|---|---|---|---|---|---|---|
2 | GB2 | Read-only | Done | Users (John Doe) | Apply | GB2 is the first grid behaviour in the list in Step 1 |
5 | GB5 | Editable | Done | Users (John Doe) | Conflict | GB5 has sastified Issue Status/Restriction but it has the different Attribute from GB2 |
6 | GB6 | Editable | Done | Groups (including John Doe) | Conflict | GB6 has sastified Issue Status/Restriction but it has the different Attribute from GB2 |
4 | GB4 | Read-only | Done | Everyone | Apply | GB4 has sastified Issue Status/Restriction and it has the same Attribute to GB2 |
7 | GB7 | Editable | Done | Groups (not including John Doe) | Not apply | GB7 has sastified Issue Status but it has unsastified Restriction |
1 | GB1 | Read-only | Todo | Groups (including John Doe) | Not apply | GB1 has sastified Restriction but it has unsastified Issue Status |
3 | GB3 | Read-only | In Progress | Users (Jessica) | Not apply | GB3 has unsastified Issue Status/Restriction |
View Recent Failed Audit Logs
Open the "Recent Failed Audit Logs" from the "Grid Behaviours" tab by clicking
button.
Review conflict and error logs. View details by clicking “Show more” button.
a. Not applied grid behaviour:
A grid behavior will not be applied if either of the following conditions occurs:
User who opened the issue including this grid isn’t in Restriction of this grid behaviour.
Or the issue opened by user doesn’t sastify Condition of this grid behaviour.
b. Conflicted grid behaviour:
A grid behavior will conflict if the following 4 conditions occur simultaneously:
The issue opened by user sastifies Condition of this grid behaviour.
User who opened the issue including this grid is in Restriction of this grid behaviour.
This grid behaviour isn’t applied.
Attribute of this grid behaviour is different from the applied one.
Feedback and Support
For more information, visit our Support Portal here.
Conclusion
The Grid Behaviours feature empowers administrators to control grid content access efficiently by defining restrictions based on user roles and issue statuses. With intuitive configuration options and robust monitoring via the Audit Log, this feature ensures that editing permissions align with organizational requirements while resolving conflicts through a clear prioritization hierarchy.
By leveraging this feature, users can streamline grid management while maintaining precise control over who can edit content and under what circumstances. This functionality is designed to reduce complexity and enhance productivity within your organization. We encourage users to explore the "Grid Behaviours" tab and customize access rules to suit their unique workflows. If you encounter any challenges or have feedback, our support team is available to assist and improve your experience further.