Table of Contents:
There are three levels at which auto correct rules can be configured: MSP, Client, and Survey.
MSP-level rules will be applied to all surveys that have auto correct enabled.
Only administrators with access to all clients can add/edit/delete MSP rules.
Client-level rules will apply to all surveys that have auto correct enabled under that specific client.
Survey-level rules will only apply to a specific survey. Survey level rules can only be defined for surveys that have auto correct enabled. Administrators with access to a specific client can add/edit/delete both client and survey level rules.
If a string is configured to be replaced on multiple levels, only the most specific version of that definition will be applied - a survey rule will always override a client rule, and a client rule will always override an MSP rule for any given string. If you select the client or survey level rules, you will see a list of all inherited definitions below the current level. Any rules that are currently being overridden by a higher-specificity level rule will have a warning icon next to them.
Example of Inheritance/overriding rules:
The rule - 'Shopper' is replaced with 'Evaluator' - is defined on the MSP Level
For Client A: 'Shopper' is replaced with 'Auditor'
For Survey I on Client A: 'Shopper' is replaced with 'Self-Auditor'
On Survey I, 'Shopper' will always be replaced with 'Self-Auditor', but for all other surveys on Client A, it will use 'Auditor'. For all other auto correct enabled surveys on the MSP it will use 'Evaluator', unless additional 'Shopper' rules are defined on other clients or surveys.
To add a rule, you must first select the level you wish to configure it for - MSP, Client, or Survey. Once you have selected your level, click the 'Add' button to bring up a text field input. This text field can accept multiple rules, with one rule being defined per line.
Each rule definition has at least two, but up to three parts to it.
a) Text to search for - the word(s), symbols, letters, spaces or numbers for which the system will search (everything except | and line breaks are allowed). Each string is treated as a stand alone word phrase or number, so if you have a rule to replace "add" with "plus" it will replace "add" but not "adds" or "addition". Likewise If you have a rule to replace "1" It will replace "1" but not "10" or "$1.00". White space is allowed, so you can also add phrases such as "would have" to your rules library. The search term is defined as everything before the first bar delimiter, no quotations are necessary.
b) Text to replace with - the word(s), symbols, letters, spaces or numbers which the system will replace the search term with (everything except | and line breaks are allowed). This will directly replace the string and maintain any spaces, punctuation, etc.. before and after the existing text being replaced. The replace string is defined as everything after the first bar "|" and before the second bar (if it exists).
c) Case Sensitive (Y/N) - This optional definition allows you to determine if case should be taken into account when matching. If a search term is case sensitive it will only count as a match if the string matches capitalization exactly. Example - "aNd" would not match on "And", "AND", or "anD" if case sensitive is Y, but would match of all three of those iterations of "and" if case sensitive is N. Case sensitive only accepts "Y" or "N" as inputs. Case sensitive is defined as anything after the second bar "|". Case sensitivity is optional, and defaults to not case sensitive "N" if there is no second bar and input.
Rules are added to the library in the order in which they are defined. Each rule is executed in that defined order, so rules can influence each other. Since rules execute in a predictable order, they can be chained together. If there is a rule defined to replace "is eating" with "has eaten" and a subsequent rule is defined to replace "eaten" with "eaten!" it would result in the string "is eating" being replaced with "has eaten!". When editing rules libraries, you can redefine rule execution order at any time by dragging and dropping the rules in a new order. The first rule in the list will alls be executed first and the last rule will always be executed last.
1|one|N Would replace '1' with 'one' and is not case sensitive
one hundred|100 Would replace 'one hundred' with '100' and is not case sensitive
alot|a lot|Y Would replace 'alot' with 'a lot' and is case sensitive so it would not replace 'Alot'
For more rules see Suggested Rules (English)
To edit an existing rule, you must first select what level you wish to configure rules for - MSP, Client, or Survey. Once you have selected your level, click the 'Edit' button. This will bring up editable fields in the existing auto correct library. The following options are available to edit:
a) Modifying the Search term - replace what is being search for
b) Modifying the Replacement term - replace what the search term will be replaced with
c) Toggle case sensitivity - toggles the case sensitive option on or off for this rule
d) Delete rule - removes this rule from the rule library entirely upon saving
e) Change rule order - Drag and drop the rules by clicking on the dotted area in the far left side of the row and moving it above or below other rows. This will affect the order in which the rules are applied. The first rule in the list will be executed first and the last rule last.
No changes will occur until you click the 'Save' button.
To delete an existing rule, you must first select what level you wish to delete the rule from - MSP, Client, or Survey. There are two deletion options.
a) The first option is to delete all rules for a specific rule level. This can be done by clicking the 'Remove All' button. This will remove all rules for the current level. It will not modify any rule libraries for the other levels, so if you want to clear out all the rules in your library, you will need to do so on the MSP, Survey, and Client levels separately.
b) The second option is to delete an individual rule. To do this, first click on the edit button, then click on the trash icon in the 'Select for deletion' column next to that rule. Once you click Save, all rules marked for deletion will be removed from that library.
You can find a list of predefined example rules here.