Channels

Channels are considered as message conduits. They are responsible for the messages exchange between Clients and act as message topic that can be published or subscribed to by multiple Clients.

Clients are able to publish or subscribe to a channel depending on the connection type they have.

Create a Channel

To create a channel, click on the + Create button present on the top-left corner of the page. You can also create multiple channels by clicking on the + Create Channels button and uploading a .csv file with channel names and any other fields you would like to add.

Channel Information

Add a channel name and optionally tags and metadata.

Bulk Creation

You can be able to create channels in bulk by uploading a .csv file with the following fields in order:

1. Name (Required)
2. Metadata
3. Tags

A sample of the .csv file can be found here.

View a Channel

After creating a channel, you will be able to see the created channel on the channels table. To view that channel click on the row or the view button in the row actions

This will lead you to the channel settings page, where you can view all the channel settings.

Update a Channel

In the channel settings page, you are able to update the following channel details:

1. Name
2. Metadata
3. Status

To update a field, click on the pencil icon on the far end of the field to edit. Once you have updated the value, click on the tick icon to update the changes or the cross icon to cancel the change. To update the channel status, toggle the switch on the far end of the status field.

Connect to a Client

Navigate to the Connections section of the channel navigation. This will lead you to the connections page where you can view the clients connected to a channel.

In this page you are able to add a connection by clicking on the Connect button on the top right corner.

This opens up a dialog box that allows you to select the clients you want to connect and with which connection type. A client can have both connection types selected.
There are two connection type options:

1. Publish: Allows the client to send messages in the channel
2. Subscribe: Allows the client to read messages in the channel

To disconnect the client, click on the Disconnect button at the end of the channel row.

This will open up a dialog that allows you to select which connection type you want to remove. You can remove one or both of the connection types if you have multiple.

Channel Members

Roles

Roles allow you to group a specific set of actions and allocate them to users. To create a role, navigate to the roles section on the client navbar. Click on the + Create button and provide a role name. The actions and members are optional fields.

Role Information

The role name is complusory. You can optionally provide the role actions by selecting from the available actions. You can also optionally provide the members by searching for a user with their username.

The following is the list of available actions for a channel:

• update
• read
• delete
• set_parent_group
• connect_to_client
• publish
• subscribe
• manage_role
• add_role_users
• remove_role_users
• view_role_users

Update

To update a role name, click on the pencil icon on the far right end of the field, update the value then click on the tick icon to update the changes or the cross icon to cancel the changes.

To update the actions and members click on the pencil icon, it will pop up a dialog box allowing you to select the actions and users you want to add.

Delete

You can also delete actions and members by clicking on the trash icon. It pops up a dialog that allows you to select which action or member you want to remove. Optionally you can delete all of the actions or members by clicking on the Delete All Actions or Delete All Members buttons.

Users

This feature is currently under development 🔨

Audit Logs

Audit logs track all group events, from creation to updates and disabling.

This feature is currently under development 🔨