Channel Rules

What are Channel Rules?

Channel Rules are an easy way to automatically assign a group of people to a particular Channel, rather than having to scroll through a large list of people to manually assign them.

How do the automated rules work?

The automated rules work very closely with the information that is used in the user's profile. You can't configure Channel Rules without some type of user profile information.
You will need to check what information a group of people may have in common (e.g. their location or job title) and then use that information to create the rule.
For customers using SAML (Azure AD, ADFS etc.) we can use the groups provided in the claims to allocate people to Channels. See below to find out how this works.

Who can create a Channel Rule?

Only Admins can create or edit a channel rule.

How to create Channel Rules

On the "Create Channel" and "Edit Channel" pages is an input box titled "Channel Rules"

Step 1: Choose the Profile field you want to match employees against:

The below fields are available for a customer to map their data to:
  • firstName
  • lastName
  • title
  • location
  • department
  • claims
Note that actual values and actual fields available will vary from customer to customer.
Mumba Enterprise Customers are able to customise and add additional profile fields should they be required.

Step 2: Choose how you want to match these fields:

  • == - Strict equals (case-sensitive)
  • != - Strict does not equal - used to exclude
  • =~ - Loose equals (not case-sensitive)
  • !~ - Loose does not equal
  • > - Greater than
  • >= - Greater than or equal to
  • < - Less than
  • <= - Less than or equal to
  • =? - Match a regular expression
  • !? - Does not match a regular expresion
You can add more than just one rule to a channel
  • || means add another rule for ANY matching
  • && means add another rule for ALL matching

Step 3: Write up your rule in the input box under "Channel Rules"

Type in the value you want your profile field to match against. Make sure that your rules are in brackets.
Please Note: everything is case-sensitive and watch your character spacing

Example Channel Rule

Additional examples:

Add everyone
(id > 0)
Note, allow a few minutes for Apply Rules to run on a large user base.
Adding everyone in VIC
(location == VIC)
Adding everyone in VIC and NSW
(location == VIC) || (location == NSW)
Adding everyone in NSW with the word Manager in their title
(location == NSW) && (title =? /Manager/)
Matching strings with spaces or other characters requires quotation marks
(location == "Brisbane Airport.")

You can also add a channel member rule using Regular Expressions

You can still use the normal profile fields as well as a regular expression to create your channel rules.
Regular expressions allows the user to create various combinations of complicated rules that are extremely specific i.e. everyone whose first name begins with the letter "A" etc.

How to write a regular expression

=? - By using an =? you are telling the rule to match to a regular expression
// - The regular expression is a string of text in between forward slashes.
| - To add more than one regular expression, you can add a pipe in between each one. This means "or". The pipes will allow you to include as many variations as required.
"" - The brackets before and after each string of text is important as this indicates the claim name within the string. The quotes ensure the exact string will be matched.

Adding members to a channel from an ADFS Group

Using regular expressions, we have the capability to leverage ADFS groups to create channel member rules.
The available field name for an ADFS group is "claims"
Examples of Groups:
• Mumba_Managment • Mumba_NSW_All_Staff • Mumba_Workplace_Health_Safety

Example for adding everyone in an ADFS group using a regular expression

claims =? /"Mumba_Management"|"Mumba-NSW_All_Staff"/

Step 4: Applying Channel Rules

Once you've created your rules, you can trigger the rule to run by clicking on the Channel List page, under the "More" menu is a button saying "Apply Rules". When this button is selected, the rules will be triggered to run immediately.
Channel Rules will also be triggered for users when they login to the app, ensuring that people are correctly allocated to Channels automatically.
When a user has been added to a channel using the Channel Rules, the Channel will appear in their Channel List under the "My Channels" tab.