Overview
Channel properties allow for structured meta data to be added to channels that can optionally be shown as labels in the channel header. This unlocks use cases for data classification and channel organization using organizational conventions and color coding.
System admin setup
Similar to the Customer User Properties will be configured, admins can configure preset channel properties to be available for use throughout the system. This can be accessed from the System Console > System Properties
page.
Empty state
Before any channel properties are added, an empty state displays stating ‘No properties added yet’.
Adding a property
When Add property
is clicked, the property type is chosen first. For channel properties, we will limit the property type to Text
, Select
, and Multi-select
for starters.
Once the type is selected the property table displays with a row added for the new property and the name field focused in the edit property popover. From here users can change the type or delete the property. This behaves the same as Boards properties.
Adding options for select and multi-select properties
For select and multi-select properties, admins can add preset values for end users to select from when the property is in use in a channel.
Changing colors for a select or multi-select option
By default, options use the standard 8% center channel color for the background and center channel color for the text label.
Users who have edit access for property options can click on an option chip to open the menu and select a preset color or custom color using a hex code.
Locking/unlocking a property
Channel properties can be locked to prevent editing by other lower-level users. This means that all values of the property cannot be edited and the property cannot be optional
When a property is locked, lower-level users cannot:
Rename the property
Reorder the property
Delete the property
Changed the property’s visibility setting
Showing/hiding a property
Admins can set the default visibility setting. Again, if the property is locked, its visibility cannot be overridden by lower-level users.
More actions
The ••• icon button reveals a menu with more available actions. For starters, this will include Allow new values
, Duplicate property
, and Delete property
.
Deleting a property
When Delete property
is selected, a confirmation modal displays. Users must confirm before the property is deleted.
Permissions
Under Manage Public channels
and Manage Private channels
, a new permission will be needed: Manage channel properties
.
Team settings
In order to apply channel properties at scale, a new section called Properties
in the Team settings
modal will be available. In addition, system admins can apply this from the System console > Teams > Team detail
view.
Channel settings
Properties can also be configured at the channel level if that has been allowed by the system and team admin.
NOTE: If this new Channel settings
modal is not yet available when we begin work on channel properties, Ideally we would incorporate it as part of this initiative since the channel menu is already getting too long.
How properties display in the channel
Properties that have been set to Show
in the channel settings, will display in the channel header to the left of the channel header description. Only the property values will display. When hovering, the property name will also display.