5.3.1.1 Restricted words validation

Note:

Restricted words validation is done on the user inputs instead of generated narrative to restrict the validation on user input. Since, the narrative is generated by using seeded templates, selection values and the values of attributes, implementer should ensure that seeded template and selection values mustn't have restricted words. The validation will validate usage of restricted words in user input but will skip the values from source system.

Enable restricted word validation for overridable attribute

Restricted word validation for overridable attribute can be enabled by setting the key enableRestrictedWordValidationInOverride to true in CS_IH_CONFIG table. This global configuration will enable restricted word validation for overridable attribute throughout the investigation toolkit notebook.

Enable restricted word validation for additional attributes

Restricted word validation for additional attributes like user remarks can be enabled by setting the key enableRestrictedWordValidationInAdditional to true in the CS_IH_CONFIG table. This global configuration will ensure restricted word validation for all additional attributes within the Investigation Toolkit notebook.

Error or Warning mode for Overridable attributes

You can control the system’s response when restricted words are found in overridable attributes by configuring the error mode in the CS_IH_CONFIG table by setting the key restrictedWordValidationErrorModeInOverride value. Set this value to true to enforce ERROR mode (which blocks the entry), or to false for WARNING mode (which logs a warning but allows the input to be saved).

  • When set to true (ERROR mode):
    • The system throws an exception if any restricted word is detected in the input.
    • The value is not saved.
    • An error message is recorded in the log.
    • No audit entry is created, as the update did not occur.
  • When set to false (WARNING mode):
    • The system logs a warning but still saves the value.
    • An audit entry is created to record the update.

Error or Warning mode for Additional attributes

For additional attributes, you can control how the system handles restricted words by configuring the error mode in the CS_IH_CONFIG table by setting the restrictedWordValidationErrorModeInAdditional value. Set the value to true to enforce ERROR mode (which blocks the entry) or to false for WARNING mode (which logs a warning but still allows the entry to be saved).

Condition Description
ERROR
  • A consolidated Exception is thrown with restricted word details
  • An error message is logged in the log file.
  • The value is not saved in the table.
  • Audit message is not added as the value wasn't updated.
WARN
  • A warning message is logged in the log file.
  • The value is saved in the table.
  • Audit message is added as the value was updated.

Case Sensitivity

Note:

Restricted word comparison is case-insensitive by default.