How to Update Patterns

Selected Content or Analytic Data Set > Update Patterns

Requires Imports - Add/Edit Permissions

Users in a role with the appropriate permissions can use the Update Patterns operation to update the Patterns for a Data Set (that is, Patterns that have been modified since import). This option is available for an entire Data Set view (a Private Data Set or a Shared Data Set in the originating Project) as along as the Data Set is at the Content or Analytic level.

Note: Patterns apply to initial import, a Pattern update, or reprocessing. If you change the System Patterns or Custom Patterns for your Project, you can either use the standalone Update Patterns option for a selected Data Set to pick up the latest Pattern changes, or you can use the Reprocess option from results. Otherwise, your Pattern changes will have no effect on the existing Data Set documents.

As of 5.1, this operation applies to Shared Data Sets in the originating Project as well as Private Data Sets. If you update Patterns in the originating Project for a Shared Data Set, all sub-Projects using the Shared Data Set will receive the Pattern changes for that particular Data Set, and View Configuration for the originating Project and all sub-Projects will show the enabled, most recent Patterns. Sub-Projects will be blocked while the Pattern update is in progress. You cannot update Patterns for a Shared Data Set in a sub-Project (that is, a child Project that is using the Shared Data Set). In this situation, the Update Patterns option will be grayed out in the sub-Project.

Enabled Pattern matches will be stored in the pattern metadata field. Pattern matches for enabled Patterns with Store Value enabled will be stored in the patternvalue field. This means you can search for documents that match enabled Patterns using the pattern metadata field, and if Store Value is enabled for an enabled Pattern, you can search for individual matching values stored in the patternvalue metadata field. You can view the field information in the Metadata pane of the Document Viewer.

About the CSV Warnings File for Updating Patterns

If the Update Patterns operation encounters exceptions, the associated Work Basket task displays a Warning icon (). You can then right-click and use the Download option to download a CSV (WARNING_DETAILS_REPORT.csv) that contains the following column information:

  • Document Handle
  • Reason

The following information can appear in the Reason column, which provides information about why a Pattern update did not occur for a given document:

  • Document Skipped — Reported for a document that was skipped because it has no text and is therefore not eligible for a Pattern update. Such a document would have an exceptiontext field value of Y.
  • Open Error — Reported for a document whose text representation could not be found and/or read.
  • Processing halted — Reported when the XML file containing the Patterns is corrupted.
  • Processing Failure — Reported for any other type of processing error.