DOCS-680 - Update role filter article

Author: jpipkin1

docs/manage/users-roles/roles/construct-search-filter-for-role.md

@@ -5,7 +5,7 @@ description: Construct a role search filter to control what log data users with
 ---
 
 import useBaseUrl from '@docusaurus/useBaseUrl';
-
+import RoleStacking from '../../../reuse/role-stacking-tip.md';
 
 This page describes how to define search filters for a role. These instructions apply to the **Search Filter** option in Step 6 of the [Create a role](/docs/manage/users-roles/roles/create-manage-roles/#create-a-role) procedure. 
 
@@ -25,23 +25,25 @@ When a user with this filter enters a query like:
 _sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count
 ```
 
-Sumo silently (it’s transparent to the user) adds the role filter to the beginning of the query with an AND:
+Sumo Logic silently (it’s transparent to the user) adds the role filter to the beginning of the query with an `AND`:
 
 ```sql
 _sourceCategory=labs* AND (_sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count)
 ```
 
+<!-- Hiding the following for work on DOCS-680
 The example above positively grants access to log data. You can do the opposite: explicitly deny access to data, with an exclamation point (!). For example:
 
 ```
 !_sourceCategory=JobX*
 ```
 
 The role filter above denies access to log data whose  `_sourceCategory` begins with “JobX”. (Access to log data with other source category values is not restricted.)
+-->
 
 The examples above are simple: they involve a single role, and hence a single role filter. 
 
-Typically however, a Sumo user will have multiple roles. If a user has multiple roles, Sumo `OR`s the several role filters and prepends that expression to the user’s queries with an `AND`, as discussed in [Multiple role filters and filter precedence](#multiple-role-filters-and-filter-precedence).
+Typically however, a Sumo Logic user will have multiple roles. If a user has multiple roles, Sumo Logic `OR`s the several role filters and prepends that expression to the user’s queries with an `AND`, as discussed in [Multiple role filters and filter precedence](#multiple-role-filters-and-filter-precedence).
 
 ## Search filter basics
 
@@ -69,33 +71,33 @@ You can use metadata fields in a role search filter. The following search filter
 _collector=HR_Tools
 ```
 
-When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
+When a user with that role filter runs a query, Sumo Logic prepends the filter to the query with an `AND`:
 
 ```sql
 _collector=HR_Tools AND <user-query>
 ```
 
 ### Using AND and OR in a search filter
 
-You can use AND and OR in a search filter. For example, this role filter uses OR to grant access to log data from two source categories:
+You can use `AND` and `OR` in a search filter. For example, this role filter uses `OR` to grant access to log data from two source categories:
 
 ```sql
 _sourceCategory=stock OR _sourceCategory=insurance
 ```
 
-When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
+When a user with that role filter runs a query, Sumo Logic prepends the filter to the query with an `AND`:
 
 ```sql
 (_sourceCategory=stock OR _sourceCategory=insurance) AND <user-query>
 ```
 
-This role filter below uses AND to grant access to log data with the source category “insurance” from the collector named “HR_Tools”:
+This role filter below uses `AND` to grant access to log data with the source category “insurance” from the collector named “HR_Tools”:
 
 ```sql
 _collector=HR_Tools AND _sourceCategory=insurance
 ```
 
-When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
+When a user with that role filter runs a query, Sumo Logic prepends the filter to the query with an `AND`:
 
 ```sql
 (_collector=HR_Tools AND _sourceCategory=insurance) AND <user-query>
@@ -109,7 +111,7 @@ You can include a string you want to search for in a role search filter. This ro
 _collector=HR_Tools AND enrollment
 ```
 
-When a user with that role filter runs a query, Sumo runs it like this:
+When a user with that role filter runs a query, Sumo Logic runs it like this:
 
 ```sql
 (_collector=HR_Tools AND enrollment) AND <user-query>
@@ -123,7 +125,7 @@ You can use an asterisk (\*) as a wildcard in a role search filter. This role fi
 _collector=HR* 
 ```
 
-When a user with that role filter runs a query, Sumo runs it like this:
+When a user with that role filter runs a query, Sumo Logic runs it like this:
 
 ```sql
 _collector=HR* AND <user-query>
@@ -135,7 +137,7 @@ This role filter grants access to logs that contain the string “violation” f
 _collector=HR* AND violation
 ```
 
-When a user with that role filter runs a query, Sumo runs it like this:
+When a user with that role filter runs a query, Sumo Logic runs it like this:
 
 ```sql
 (_collector=HR* AND violation) AND <user-query>
@@ -155,15 +157,21 @@ denies access to log data whose:  
 * `_sourceName` contains “finance”
 * `_sourceCategory` contains “secret”
 
-When a user with that role filter runs a query, Sumo runs it like this:
+When a user with that role filter runs a query, Sumo Logic runs it like this:
 
 ```sql
 (!_sourceHost=humanresources* AND !_sourceName=*finance* AND !_sourceCategory=*secret*) AND <your-query>
 ```
 
+:::warning
+Although we provide this an example to show that it's possible, we do not recommend filtering to deny access. That's because if multiple roles are applied to a user, a situation can arise where one role denies access to a certain area, but another role allows access to that same area. Therefore, if possible, always apply filtering that allows access rather than denies access. Then roles can be used in an additive way to build access for users.
+:::
+
 ## Multiple role filters and filter precedence
 
-When a user is assigned to multiple Sumo roles, Sumo combines the role filters from each of the roles using a logical OR to come up with the combined role filter.
+When a user is assigned to multiple Sumo Logic roles ("role stacking"), Sumo Logic combines the role filters from each of the roles using a logical `OR` to come up with the combined role filter.
+
+<RoleStacking/>
 
 When multiple roles filters are applied to a query, the least restrictive filter takes precedence. That this rule doesn’t apply if any of the role filters applied to a query is simply blank, which effectively grants access to all data, and would be the least restrictive filter. If the combined search filters applied to a query includes filters that are blank, the blank search filter is ignored and the next least restrictive filter takes precedence. So, if you actually want to grant a role access to all data, set the search filter to an asterisk (`*`). A search filter that is configured in that fashion will take precedence when combined with more restrictive search filters.
 
@@ -180,7 +188,7 @@ Role A allows access to log data whose `_source` tag is “GCP Audit” and `_co
 
 Role B Allows access to log data whose `_sourceCategory` tag begins with “Vx”.  
 
-When a user with Roles A and B runs a query, Sumo applies the filters with an OR, and prepends them with an AND to your query, like this:
+When a user with Roles A and B runs a query, Sumo Logic applies the filters with an `OR`, and prepends them with an `AND` to your query, like this:
 
 ```sql
 ((_source="GCP Audit" AND _collector="GCP") OR _sourceCategory="Vx*")
@@ -196,19 +204,19 @@ Assume the following role filters.
 | Role | Filter |
 |:----------|:-------------------|
 | Role A   | `_collector=fee*` |
-| Role B   | `!_collector=fi*` |
+| Role B   | `_collector=f*` |
 
 Role A allows access only to log data whose `_collector` tag matches “fee\*”, and not to data whose `_collector` tag is any other value.
 
-Role B Allows access to any log data whose `_collector` tag does not match “fi”.  
+Role B Allows access to any log data whose `_collector` tag matches “f\*”, and not to data whose `_collector` tag is any other value.  
 
-When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, and prepends them with an AND to your query, like this:
+When a user with Roles A and B runs a query, Sumo Logic combines the two filters with an `OR`, and prepends them with an `AND` to your query, like this:
 
 ```sql
-(_collector=fee  OR !_collector=fi) AND <your-query>
+(_collector=fee  OR _collector=f) AND <your-query>
 ```
 
-**The least restrictive of the role filters takes precedence**. So, although Role A effectively restricts results to log data that matches `_collector=fee*`, Role B allows grants access to all collectors, except for those that match `_collector=fi*`. So, Role B takes precedence and Role A has no effect.
+**The least restrictive of the role filters takes precedence**. So, although Role A effectively restricts results to log data that matches `_collector=fee*`, Role B allows grants access to all collectors that match `_collector=f*`. So, Role B takes precedence and Role A has no effect.
 
 ### Example 3 
 
@@ -224,14 +232,15 @@ Role A allows access only to log data whose `_sourceCategory` is “analytics-la
 
 Role B Allows access to log data whose `_sourceCategory` begins with “analytics”.
 
-When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, like this:
+When a user with Roles A and B runs a query, Sumo Logic combines the two filters with an `OR`, like this:
 
 ```sql
 (_sourceCategory=analytics-lab OR _sourceCategory=analytics*) AND <your-query>
 ```
 
 **The least restrictive of the role filters takes precedence.** Role A alone grants access to a log data from a single  source category, “analytics-lab”.  Role B grants access to log data to any source category that starts with “analytics”. Since the least restrictive filter takes precedence, data tagged `_sourceCategory=analyticsLong` could be returned in addition to data tagged `_sourceCategory=analytics-lab`.
 
+<!-- Hiding the following for work on DOCS-680
 ### Example 4
 
 Assume the following role filters.
@@ -245,15 +254,16 @@ Role A allows access to log data whose `_collector` tag matches “prod\*”, an
 
 Role B prevents access to log data whose `_sourceCategory` tag does contain “shoguns”. Data with any ` _sourceCategory` tag that does not contain “shoguns” is available. 
 
-When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, and prepends them with an AND to your query, like this:
+When a user with Roles A and B runs a query, Sumo Logic combines the two filters with an `OR`, and prepends them with an `AND` to your query, like this:
 
 ```sql
 (_collector=prod* OR !_sourceCategory=*shoguns*) AND <your-query>
 ```
 
 Role B is the least restrictive. Users with the combined role filter will be able to view any log data whose  `_sourceCategory` does not contain the string “shoguns”, regardless of the value of the `_collector` tag.
+-->
 
-### Example 5
+### Example 4
 
 Assume the following role filters.
 
@@ -266,4 +276,8 @@ Role A allows access to all indexes whose name starts with "sumologic".
 
 Role B, with a blank search filter (user did not enter anything as the search filter for the role), allows access to all data.
 
-When a user with Roles A and B runs a query, Sumo combines the two filters and since Role B has a blank search filter, the more restrictive search filter, Role A, takes precedence. Users with the combined role filter will be able to  view any log data in any of the indexes prefixed with "sumologic".
+When a user with Roles A and B runs a query, Sumo Logic combines the two filters and since Role B has a blank search filter, the more restrictive search filter, Role A, takes precedence. Users with the combined role filter will be able to  view any log data in any of the indexes prefixed with "sumologic".
+
+## Test role filtering
+
+To test whether filtering works as expected, select a role and click the **Emulate log search** button. For more information, see [Test a role](/docs/manage/users-roles/roles/create-manage-roles/#test-a-roles-log-access-rights).