Write, Test and Switch On a Content Rule
3 min read · Last updated · Page version 1
Where content classification is enabled on a deployment.
Purpose: tell Forage what to look for, check what it would find, and switch it on.
- Open Records, then Content Rules, and press New rule.
- Give it a Name and choose the label it records under Records the label. If there is no label yet, create one first.
- Under Index expression, write the words that pick out candidate documents, the way you would write a search, for example
passport | "date of birth". - Add at least one detector under Detectors, and choose its type:
- phrase: any one of the terms, matched as whole words;
- all: every one of the terms must appear somewhere in the document;
- regex: a pattern anywhere in the text, with an optional Checksum, so a value that fails the check is not reported.
- To require words nearby, fill in Context terms and Within this many characters. A match then counts only with one of those words close to it. Press Add detector for more.
- Optionally press Add condition to add File conditions: file name, folder path, file type, size, modified date, read state, reason not read, source or site. Every condition must hold. A rule made only of conditions decides on those facts alone, so it can label files Forage could not read, such as every password-protected file.
- Press Dry run. It shows how many documents contain the rule's words, which is the most it could match, a sample checked against the full rule with each match in context, and a projected range across the documents read so far. Nothing is saved or labelled.
- Press Save rule. The rule is saved inactive.
- Select the rule to see its detectors and versions. On the version you want, press Activate, then Activate this version. Any other live version of the rule is retired at the same time, and Forage examines everything it has read again, in the background.
- To change a rule, press Edit as new version, or New version from this on an older version, make your changes, press Save as new version, and activate it. The version you started from is not changed.
- To switch a rule off, press Retire, then Retire this version. What it already found is kept.
- A version that has never been active can be removed with Delete. A version that has been active is kept as history and can only be retired.
Good to know: the dry run is offered, not required, and can be run on any version from its row. While Forage re-examines after a change, the examined figure on Labels falls and then climbs again. A pattern that matches digits needs a checksum or context terms.
See what each page shows for the rest of the Records section, and limitations for what Forage does not do.
Questions go to sales@smikar.com.