Creating a Custom Entity Type in Entity Manager

Entities are the personally identifiable information (PII) types that you can discover with Activate. You can create new entity types based on the built-in entity types available in Entity Manager, or you can create entirely new entity types based on your own regular expressions.

Procedure

From the navigation pane, go to Activate.

The Activate page appears.
Under Settings, click the Entity Manager tile.

The Entity manager page appears.
To the right of Entity List, click Add entity.
In the Entity Details section, in Entity Name, enter a name.

Select the method for matching the new entity:

Method	Description	Instructions
Match based on Python regular expressions.	You can use a Python regular expression to match the new type of personally identifiable information (PII) in the content. For example, to add an entity type for a custom ID number comprised of two upper-case alphabet characters followed by four digits (as in AB1234), enter `[A-Z]{2}[0-9]{4}`. For information about non-capturing groups and backslash characters, see Python Regular Expressions for Custom Entities. For more information about Python regular expressions, go to the Python documentation.	In Regular Expression, enter the Python regular expression to match the entity. Tip s: Test your regular expression by clicking the Regular expression link, and then entering the regular expression and sample text in the dialog box that appears. Optional: In Keywords, add one or more keywords that must appear within close proximity to the entity.
Match based on built-in entity types.	Many common entity types, such as dates and phone numbers, are built in to Entity Manager. You can select one of these entity types, and customize or narrow the match parameters using the Keyword field. For example, to create an entity for employment start date, select the Date entity and add keywords such as "employment" and "start". Only dates that have those keywords in close proximity in the content are identified as potential matches.	Click the Derived From list and select an entity type. In Keywords, add one or more keywords that must appear within close proximity to the entity.

Method

Description

Instructions

Match based on Python regular expressions.

You can use a Python regular expression to match the new type of personally identifiable information (PII) in the content.

For example, to add an entity type for a custom ID number comprised of two upper-case alphabet characters followed by four digits (as in AB1234), enter [A-Z]{2}[0-9]{4}.

For information about non-capturing groups and backslash characters, see Python Regular Expressions for Custom Entities. For more information about Python regular expressions, go to the Python documentation.

In Regular Expression, enter the Python regular expression to match the entity.

Tip

s: Test your regular expression by clicking the Regular expression link, and then entering the regular expression and sample text in the dialog box that appears.
Optional: In Keywords, add one or more keywords that must appear within close proximity to the entity.

Match based on built-in entity types.

Many common entity types, such as dates and phone numbers, are built in to Entity Manager. You can select one of these entity types, and customize or narrow the match parameters using the Keyword field.

For example, to create an entity for employment start date, select the Date entity and add keywords such as "employment" and "start". Only dates that have those keywords in close proximity in the content are identified as potential matches.

Click the Derived From list and select an entity type.
In Keywords, add one or more keywords that must appear within close proximity to the entity.

Click the Sensitivity list, and then select a sensitivity level for the entity.
Click Save.

The entity name appears in the Entity List.

Importing Custom Entities in Entity Manager

Creating a Custom Entity Type in Entity Manager

Procedure

Related Topics