Admin: Substitution Settings

These are the settings you can configure on the Add or Edit Substitution page. 

Substitution Type 

This is a drop-down menu that includes the three types of substitutions that you can create: Literal, Regex, or Regex Plus.
Select the type of substitution you'd like to create:

• A Literal substitution replaces a literal sequence of text characters (or "string") with another literal text string.
• A Regex substitution defines text matching a particular sequence of characters (or "string") and replaces it with a Regex "backreference", a literal text string, or both. 
• A Regex Plus substitution uses JavaScript to reference variables. 

See Substitution Types for more information and examples.

Spoken

In the Spoken field enter what a user will say in the dictation to elicit the substitution.
This is the word, words, or pattern in the transcript for which the dictation engine will search. There is a 764 character limit for this field. Spoken forms are not case sensitive.

• For a Literal substitution, the Spoken form needs to be a word or phrase that the dictation client UNDERSTANDS when the user says it. If the word/phrase does not return consistently for the user when it is dictated, the substitution won't work consistently either. (If that happens, you can try adding the word or phrase to sentence modeling via nVoq.Administrator.)
  • Literal substitutions are case-sensitive.

    If the text in the Written field begins with a lowercase letter, it will always return with a lowercase letter, even at the beginning of a sentence.
• For a Regex substitution, the Spoken form is a search pattern for text matching a particular sequence of characters (or "string"). 
• For a Regex Plus substitution, the Spoken form is a search pattern for text matching a particular sequence of characters (or "string").  

Written

In the Written field enter the text that the dictation client is to return when the word, phrase, or pattern is found in the dictation transcript.
There is a 10,000 character limit to the written form for all types.

• For a Literal substitution, the Written form is the text that displays in the transcript when the spoken form is dictated.            
• For a Regex substitution, the written form could be literal text or Regex backreferences.
• For a Regex Plus substitution, the written form is a JavaScript which programmatically determines the text to substitute. 

Description (optional)

Optionally, in the Description field enter helpful information about the substitution, like what it is expected to do. This can be especially helpful for Regex or Regex Plus substitutions when it is not obvious by looking at the Spoken or Written information what the substitution will do. The description will only display in nVoq.Administrator. There is a 64 character limit for this field. 

Enabled

By default the toggle is ON/blue to indicate that the substitution will be active and can be used by the account or organization selected at the top of the page. To disable the substitution, click on the toggle to turn it OFF/white. A disabled substitution cannot be used by accounts or organizations.