Business Rules Filtering: Command Line Configuration

Version 19 provides a user interface to configure Business Rules Filtering (the recommended method, as described in previous sections). For previous versions, users had to edit business rule configuration files through the command line instead; we have provided the information on how to do this in case you need it to customize your installation.

Notes:

•	Business Rule Filtering only applies to Marquee sites and is not supported for sites using the Exhibit theme.

•	For Marquee Only: Business Rule Filters apply to both files and folders using Solr Search and Advanced Search. In addition, if the Business Rules are set to filter out InDesign files, linked files are not displayed in the search query results.

•	IMPORTANT: Your filter must be named solrfilters.json and saved to the following directory: /var/adm/webnative/.

General Filter Structure

The following table provides an explanation for the general filter structure. See the examples below to learn how they are being used.

 

Key	Value	Description
enabled	true|false	Set value to true or false to turn on or off.
name	<string>	Set the name for the filter.
description	<string>	Set a description for the filter.
groups	group1, group2	A comma delimited list of user groups to apply this filter rule to.
primaryGroup	true|false	If primaryGroup is true, the users primary group must be listed in the groups list for the filter to apply. If primaryGroup is false, the user must be a member of one of the groups listed in the groups list for the filter to apply.
negateGroups	true|false	If negateGroups is true, this negates the groups. The filter would therefore apply to every user who is not a member of one of the groups listed in the groups list.

Filters and Match Options

Each filter supports only a single match option with the following fields being configurable within a ‘match’ node.

 

Key	Value	Description
filterType	filename|dirname|keywordStr|keywordDate| keywordInt|keywordFloat|keywordBool	filterType specifies the type of filter to be applied.
flag	<integer>	flag indicates the type of match to be made. The value specified here depends upon the filterType. See Filters and Flag Options in the table below.
filterValue	<string>|<date>|<int>|<float>|<bool>	Specifies the filter value. The value specified here also depends upon the filterType. See Example

Filters and Flag Options

Xinet supports the following filters and match options.

When specifying a " (quote) or a \ (backslash) character in any of the Business Rules match or pre-requisite 'filterValue' fields, these two characters must be escaped by an additional backslash character. For example, if I have the pre-requisite to filter only if the parent directory is named: My "Folder01 \ Folder02" Dir.

The Business Rule would be constructed as follows:

"prerequisites" : [

{ "parentdir" : {

"filterValue" : "My \"Folder01 \\ Folder02\" Dir"

}

}

]

 

 

Filter Type	Description	Available Flag Options	Examples	What it does
filename	Hide assets based upon an asset’s filename.	• matches exactly flag: 1 • starts with flag: 2 • contains flag: 3 • ends with flag: 4	"filename" : { "flag" : 3, "filterValue" : "draft" }	Hide any asset that contains the string draft in the filename.
dirname	Hide a directory, based upon the folder name.	• matches exactly flag: 1 • starts with flag: 2 • contains flag: 3 • ends with flag: 4	"dirname" : { "flag" : 1, "filterValue" : "Uploads" }	Hide any folder called Uploads.
keywordStr*	Hide assets, based upon a Keyword value of type text.	• matches exactly flag: 1 • starts with flag: 2 • contains flag: 3 • ends with flag: 4 • Filter NULL flag: 10	"keywordStr" : { "flag" : 1,"id" : 114, "filterValue" : "Not Approved" }	Hide any asset with a Keyword value set to Not Approved for field 114.
keywordInt*	Hide assets, based upon a Keyword value of type integer.	• is equal to flag: 1 • is less than flag: 5 • is greater than flag: 6 • Filter NULL flag: 10	"keywordInt" : { "flag" : 6, "id" : 117, "filterValue" : "200" }	Hide any asset a Keyword value greater than 200 for field 117.
keywordFloat*	Hide assets, based upon a Keyword value of type floating point.	• is equal to flag: 1 • is less than flag: 5 • is greater than flag: 6 • Filter NULL flag: 10	"keywordFloat " : { "flag" : 5, "id" : 134, "filterValue" : "50.5" }	Hide any asset with a Keyword value lower than 50.5 for field 134.
keywordDate*	Hide assets, based upon a Keyword value of type date.	• matches exactly (whole day, time is ignored) flag: 1 • date and time up to but not including flag: 8 • date and time including and after flag: 9 • Filter NULL flag: 10	"keywordDate" : { "flag" : 9, "id" : 149, "filterValue" : "2015-01-20T10:00:00Z" }	Hide any asset with a Keyword value set the Jan 20th - 10AM or later for field 149.
keywordBool*	Hides assets, based upon a Keyword value of type boolean.	• matches exactly flag: 1 • Filter NULL flag: 10	"keywordBool" : { "flag" : 1, "id" : 154, "filterValue" : true }	Hides any asset with Keyword value set to true (on) for field 154.

* Keyword values apply to files only (not folders) - keywordInt, keywordStr, keywordFloat, keywordDate, and keywordBool.

Prerequisites

In order to limit validity, pre-requisites can be applied to any of the filters (as listed above). For each filter, multiple pre-requisites can be added.

 

Pre-requisite Type	Description	Examples	What it does
parentdir	Allows you to specify the name of a parent folder. The pre-requisite filter would only apply if the name of the matched assets parent directory matches the parentdir filterValue value.	"parentdir" : { "filterValue" : "WIP Jobs", "recursive":false }	Hides assets based upon a filter match only if the asset’s parent directory is named WIP Jobs. If ”recursive":false—Only the files at parentdir level are filtered and not files of the subfolders If "recursive":true—All the files at parentdir and subfolders are filtered
path	Allows you to specify a full path. The pre-requisite filter would only apply if the matched assets path matches the path filterValue value.	"path" : { "filterValue" : "/Volumes/Customers/General", "recursive":false }	Hide assets based upon a filter match only if the asset lives directly inside of /Volumes/Customers/General. If ”recursive":false (the default)— Only the files at path level are filtered and not files in the subfolders. If "recursive":true—All the files at path and subfolders are filtered.
depth	Allows you to specify the depth of the match. The pre-requisite filter would only apply if the matched assets depth matches the depth filterValue value.	"depth" : { "filterValue" : "4", "recursive":false }	The depth value starts at the top of the published volume. If I have a published volume /Volumes/MyVolume and the full path is /Volumes/MyVolume/FreeSamples/Customer1, the following would be corresponding paths and depth values:   Depth value of 1 = /Volumes/MyVolume Depth value of 2 = /Volumes/MyVolume/FreeSamples Depth value of 3 = /Volumes/MyVolume/FreeSamples/Customer1   For example, if the depth value is set to 2, this would filter out any matching files in /Volumes/MyVolume/FreeSamples. It would not filter files from /Volumes.   If ”recursive":false—Only the files at the specified level are filtered and not the files of the subfolders If "recursive":true—All the files at the specified level and sub-folders are filtered