Add, Edit, or Copy a Pattern

Home > selected Project > menu or right-click > Settings > Patterns > New Pattern | Edit | Copy
Project > Settings drop-down > Project Settings > Patterns > New Pattern | Edit | Copy

Requires Project - Patterns - View, Add/Edit Permissions

Home > selected Organization > menu or right-click > Settings > eDiscovery Templates > Patterns New Pattern | Edit | Copy

Requires Organization - Patterns - Add/Edit Permissions

Home > Settings drop-down >System Settings > Templates > Patterns New Pattern | Edit | Copy

Requires System User with a System-level Role and Permissions

Users in a role with the appropriate permissions can add , edit, or copy Patterns as follows:

• Add a new Custom Pattern.
• Edit all information for a Custom Pattern.
• Edit a selected System Pattern to control the pattern's enabled state and/or the ability to store values.

• Copy the content and settings of a selected Pattern to a newly named Pattern (either copy a System Pattern into a new Pattern or copy a Custom Pattern).

Pattern Options

When you create a new Pattern, you must fill out all required fields and select the settings you want for the Custom Pattern. When you edit an existing Custom Pattern, you can edit all fields. For a System Pattern, you can edit only the Enable and Store Value fields. Copying a Pattern enables you to copy System Pattern content into a newly named Custom Pattern, or to copy the content of another Custom Pattern. The Add, Edit, Copy options all display a dialog with the following fields (available based on the type of Pattern selected for the operation):

Note: Required fields are identified in the UI with a red asterisk *. You cannot submit the operation until you have provided information for all required fields.

• Name The unique name of an item. For many items, the name can have up to 100 characters. Some items, such as a Connector name, can have up to 255 characters. An Excluded Content Block name is limited to 32 characters. (required) – Each Pattern has a name. For data processed prior to 4.3.11.0, this name also serves as a searchable Token Name. When you add or edit a Custom Pattern, the assigned name must be unique within the Project. You cannot create multiple Patterns that are just uppercase and lowercase versions of the Pattern name (for example, you cannot add a Pattern named SSN as long as the default Pattern ssn exists). You cannot edit the name of a predefined System Pattern, but you can use the Copy option to copy the Pattern and assign a new name and other Pattern information that you want. The name appears in the Pattern list. In data processed prior to 4.3.11.0, a Token name may also appear in a Cluster top terms list but only if the Store Value check box is enabled. Note the following restrictions concerning the name:

The name for a Pattern is subject to validation upon creation or edit. The name can include alphanumeric characters and some supported characters (such as a hyphen, underscore, and apostrophe). You can use uppercase or lowercase letters in the name and the software will normalize the name to lowercase for the purposes of search. During validation, the software will also allow characters from foreign languages (for example, Korean characters).

However, spaces as well as the following characters are not supported for names for Patterns:

! " # $ % & * + . / : ; < = > ? @ [ \ ] ^ { | } ~ “ ”

Specifying a space and/or any of the unsupported characters will generate the following error message:

Contains a space or one of these invalid character(s): ! " # $ % & * + . / : ; < = > ? @ [ \ ] ^ { | } ~“ ”

The length of a Pattern name is also subject to validation upon creation or edit. An error message appears if you try to add or edit a Custom Pattern whose name exceeds the maximum number of characters allowed.

Note: In newly processed, updated, or reprocessed data as of Release 4.3.11.0, you can search for an enabled Pattern using the pattern metadata field and the Pattern name (pattern::<pattern_name>, such as pattern::email). In data processed prior to 4.3.11.0, the Searchable Token Name column in the Patterns list shows how to search for the token using the 'token-<token_name>' format. This format requires you to place the search within single quotes and specify the Token name in lowercase, since the software normalizes a Token name to lowercase.

• Description Provides a helpful description of an item. A description can have up to 255 characters. – A description that can help identify the purpose of a Custom Pattern. You can edit the description of a Custom Pattern, but you cannot edit the description of a predefined System Pattern.
• Pattern (required) – The actual Pattern that will be used to evaluate content during the parsing process. A Pattern can have a maximum length of 4000 characters. Note that if your Pattern captures values as case-sensitive, the data can be stored case-sensitive and then a search for that data in the patternvalue field must be case-sensitive as well. You can edit the content of a Custom Pattern, but not a predefined System Pattern. Your Pattern is validated for regex syntax when you click away or tab away from the Pattern text box. If the Pattern has invalid regex syntax, you will see a message stating that the regular expression syntax is incorrect. You cannot use the OK button to create or commit any Pattern changes until you resolve the error in the Pattern text box. Once you correct the error, the OK becomes available, allowing you to proceed.

• Enable (for a new Pattern ) – By default, a new Custom Pattern has a check mark in this field to indicate that this Pattern is enabled. Otherwise, this checkbox reflects the current enabled or disabled state of the selected Pattern. Each Pattern must be enabled to make it available to the parsing process. You can edit this field for either a Custom or System Pattern. Three System Patterns are enabled by default: email, unc, and uri.

• Store Value (for new Pattern) – Determines how Pattern matches are treated during the parsing process. If this check box is disabled for a new Custom Pattern, when the Pattern is used during the parsing process, documents processed prior to 4.3.11.0 have the token applied, which means that you can identify the documents that contain matching data but you cannot search for specific values. For documents processed in 4.3.11.0, having this checkbox disabled means that you can search for documents with matching Pattern data using the pattern metadata field, but you cannot search for specific values using the patternvalue field. If this check box is enabled, you can search for both matching Pattern data and specific values found in document or email content (which does not include the email header). This check box is disabled by default for a new Custom Pattern, but will reflect the current Store Value state of the Pattern for edit or copy operations. Three System Patterns store values by default: email, unc, and uri. You can edit this field for either a Custom or System Pattern. The system can then support the following operations:
  • Search for a list of all documents that contain data matched by the Pattern.
  • Search for specific values that were identified by the Pattern in document or email content. Note that for an email, the email header is not included in the content analyzed for Patterns.
  • Search for documents that contain duplicate and similar values that were identified by the Pattern.
  • For data processed prior to 4.3.11.0, form Clusters based on similar content that includes values that were identified by the Pattern.

OK or Cancel Actions

The following actions control whether the new or modified Pattern is saved or discarded:

• OK – Saves the new or modified Pattern, as long as the Pattern contains valid syntax. If not, this button will become unavailable until you fix the reported syntax error.
• Cancel – Cancels the addition or modification of the Pattern and closes the dialog.