Matcher

A matcher is an auxiliary object in XDM for analyzing the data of a column. It checks the data of one column and returns the number of cells matching the criteria for personally identifiable information.

A matcher defines a strategy to identify data classes in usage with the PII finder task. There are two basic strategies for matchers: dictionary based and regex based matchers. Matchers are always applied against every column in the analyzed data set and return a match.

Matchers are categorized according to country. It is possible to select multiple matchers or to select all matchers.

Useful Examples

Find useful examples for matcher in the matcher section of useful examples.

Permissions

Matchers have specific permissions to manage user access. The table below displays the available permissions and their purposes.

For more details about the concept of XDMs permission management refer to Permission Management.

Permission

Description

ADMINISTRATION

Specifies that the grantee can grant and revoke permissions to and from other users.

A user that creates an object automatically receives the ADMINISTRATION permission on that object.

DELETE

Specifies that the grantee can delete objects of the selected types.

READ

Specifies that the grantee has read permission on the object. The grantee is able to see the object in lists and can see all of the object’s details, such as rules or access permissions.

In addition, the grantee can reference this object. For example, a user who has READ permission on a credential object can refer to this credential object when creating a new database connection.

WRITE

Specifies that the grantee has the permission to change the settings and attributes of an object. This also includes modifying any rule lists that might be associated with the object (for example, the selection rules of a task template).

Properties

The table below documents the available properties for matchers. The 'name' column displays the property name as it can be used in Groovy and Java Scripts.

Name

Type

Default

Description

Content

content

String

n/a

The value in this field depends on the chosen matcher and the matcher type.

If the matcher type is Regular expression, then this field must contain a valid regular expression. For details on valid regular expressions see, for example, the Java regex documentation.

The matcher type can also be a Dictionary if the matcher is one of those supplied with XDM. In this case the field will be automatically filled with the dictionary path and should not be changed.

Country

country

String

n/a

Specifies the country the matcher belongs to. This is a user defined value which might contain an abbreviation of a country name. Adding a country allows different matching criteria for the same object to be taken into account.

Description

description

String

n/a

An optional description for this object. The description can contain multiple lines to give more context on the configured object. The description is not used in a technical context.

Name

displayName

String

n/a

Specifies the name of the object. The name is used to display and identify the object in lists. The name can contain any valid UTF-8 characters. This field is mandatory.

Match Parts

matchParts

Boolean

false

Specifies if a matcher should notice subsets that match as a hit. For example, you have a matcher that searches for first names, but there are also columns that contain first and last name in a single column. Then this property gives you the option to find these columns as well.

When this property is activated, and you use a dictionary matcher, then the compared tokens are separated by a non character and numeric symbol like , ,; or also white spaces. For example, the name Thomas Schneider is stored in a single column "name" as Thomas;Schneider. Then XDM would split the name by thy semicolon into 2 values, that can be compared by the values in the dictionary. The name Thomas or Schneider must be in the dictionary for a match. In situations where the name is stored like ThomasSchneider XDM could not separate the name.

Minimum length

minimumLength

Number

0

Specifies the minimum length of values. This option serves as an additional condition. If a value is shorter than the specified length or empty, XDM will regard it as not having matched the criteria for this matcher.

Priority

priority

Number

50

In a situation where a column is matched by more than one matcher, the priority determines which matcher applies. The priority is ranked from lowest priority number to highest priority number. Thus, a matcher with priority of 1 has precedence over a matcher with a priority of 2, which in turn has precedence over a matcher with a priority of 3, and so on.

Tags

tags

Tag

n/a

Contains the tags that apply to this object. These tags can be used in the search to find objects quickly and effortlessly.

Type

type

MatcherType

REGEX

Specifies one of two types of matcher:

Dictionary matcher

This type is only valid for the pre-defined matchers supplied with XDM. This matcher checks whether the data matches values in a dictionary. A dictionary is a text file containing possible values for the data, for example first names, city names, or countries. A dictionary matcher type cannot be specified for user defined matchers.

Regular expression

This matcher checks whether the data matches a regular expression. The regular expression is set in the Content panel. The regular expression is case-insensitive.

This matcher type is useful if the data has a characteristic structure (such as email addresses, postal codes, or national identification numbers). For example, a regular expression for a German postal code could be \d or [0-9]{5}.

For more information on valid regular expressions refer to the Java documentation

Actions

The available actions are described below. Some actions apply to the list, while others are specific to selected matchers.

List Actions

The following actions are available on the matchers list. If the action is disabled a tooltip will provide the exact reason for the deactivation. The required permissions are described in detail for each action.

  • Bulk Create Permission

  • Bulk Delete

  • Bulk Export

  • Create

  • List History

Create a new permission on the selected objects. Shows in the result list whether the permission could be granted on the respective object. Only these permissions can be granted that are existing on the underlying object.

A permission in the result list can have three different states, these are:

CREATED

The permission successfully granted on the object.

MERGED

The granted permission already exists on the object and merged with the new permission.

SKIPPED

The permission could not be granted, because of missing administration permission on the object.

The following permissions are required on the list:

  • ADMINISTRATION

  • READ

Delete the selected objects.

The following options are available:

Cascade

Recursively delete depending objects.

When using cascade, dependent objects are deleted first also with cascade enabled. Thus, a cascade deletion is a recursive function that deeply searches for dependent objects and deletes them first. There is only a confirmation for the first object. The dependent objects are deleted without confirmation but only when the user has the DELETE permission.

This feature is only available in development mode. More information about development mode can be found in the chapter User Settings. It should be used with caution.

An object in the result list can have two different states, these are:

DELETED

The object could be deleted.

NOT_DELETED

The object could be not deleted. This may be because the executing person does not have a delete permission on the object or the object is still referenced by others. A detailed reason can be determined with the help of the error message. If the object is still in use, these objects are also displayed.

The following permissions are required on the list:

  • DELETE

  • READ

Exports the selected objects.

YAML

Generates a YAML file containing all the object’s settings. The user has the option to download the export file, or to paste the content in the import dialog. The YAML export is particularly suitable for importing the exported objects again via the XDM UI.

ZIP

This export writes several individual YAML-files. Each YAML-file is stored in a directory according to its type. For example, when exporting a native table backup task template named 'A backup template', a YAML-file 'A backup template.yaml' is created inside the directory /TaskTemplate/native-table-backup-task-template/ of the ZIP-file. This kind of export is suitable for usage in git-repositories together with XDM’s configuration as code feature.

Related and dependent objects can optionally be included in the export. The export dialog has the following options:

Include dependent objects

Dependent objects only belong to the exported object like rules and tasks.

Include permissions

Permissions of each exported object, only when the object supports permissions. Some objects like rules don’t have permissions.

Include referenced objects

Referenced objects exist by their own and are used in the exported object like connections and environments.

Include objects that depend on referenced objects

Also include the dependent objects of the referenced objects. E.g. the rules of a modification set or the rules in an application model version.

Objects on which the user does not have READ permission are not exported. This includes dependent and referenced objects. However, the reference to an object will be exported. For example a connection object would refer to the credential, even if the user does not have READ permission on the credential. The definition of the credential object itself will not be part of the export file. This can lead to issues during the import, because the connection cannot be created without an existing credential.

The following permissions are required on the list:

  • READ

Creates a new object in the current list. Depending on the object type either a popup dialog is shown for the most important settings, or the complete object is shown in edit mode. The dialog provides the option to create the object and remain in the current list or to switch to the newly created object in edit mode to perform further changes.

The following permissions are required on the list:

  • CREATE

The history list tracks all modifications made to objects within it. A new record is added each time an object is created, edited, or deleted. A record indicates who made the change, which object was affected, and when the change was made.

For more information about the concept of the history refer to the history concepts.

The following permissions are required on the list:

  • READ

Object Actions

The following actions are available on specific matchers. In order to execute the action, the user must possess the necessary permissions for the object. The permissions required for each action are described individually. If the user does not have these permissions, the action will be disabled and the tooltip will provide the exact reason for the deactivation.

  • Delete

  • Edit

  • Event List

  • Export

  • Object History

  • Permission Check

  • Usage

Delete the object. If the object is still used by another entity, an error message is displayed, and the object is not deleted. The delete operation must be confirmed in a separate popup.

The following options are available:

Cascade

Recursively delete depending objects.

When using cascade, dependent objects are deleted first also with cascade enabled. Thus, a cascade deletion is a recursive function that deeply searches for dependent objects and deletes them first. There is only a confirmation for the first object. The dependent objects are deleted without confirmation but only when the user has the DELETE permission.

This feature is only available in development mode. More information about development mode can be found in the chapter User Settings. It should be used with caution.

The following permissions are required:

  • DELETE

  • READ

Opens the current entity in edit mode.

The following permissions are required:

  • READ

  • WRITE

This list shows all registered events for the object. It includes events that are specific to the object, or for that type.

The following permissions are required:

  • READ

This action allows to export XDM objects in different formats in order to import them via export or CasC in another environment.

Refer to configuration of export for more information.

Related and dependent objects can optionally be included in the export. The export dialog has the following options:

Include dependent objects

Dependent objects only belong to the exported object like rules and tasks.

Include permissions

Permissions of each exported object, only when the object supports permissions. Some objects like rules don’t have permissions.

Include referenced objects

Referenced objects exist by their own and are used in the exported object like connections and environments.

Include objects that depend on referenced objects

Also include the dependent objects of the referenced objects. E.g. the rules of a modification set or the rules in an application model version.

Include implicit created objects

Implicit created objects are tasks or workflows which were automatically created for execution. These objects won’t be exported by default, but can be included by setting this flag. When exporting implicit objects, make sure that the Include dependent objects flag is also enabled.

Objects on which the user does not have READ permission are not exported. This includes dependent and referenced objects. However, the reference to an object will be exported.

For example a connection object would refer to the credential, even if the user does not have READ permission on the credential. The definition of the credential object itself will not be part of the export file. This can lead to issues during the import, because the connection cannot be created without an existing credential.

The following permissions are required:

  • READ

The history displays all changes made to the respective XDM object, including any changes made to its rules.

Each change record includes information about the operation performed (e.g. CREATE, UPDATE, DELETE), the timestamp, and the user responsible for the change.

For more information about the concept of the history refer to the history concepts.

The following permissions are required:

  • READ

The check verifies that the current user has the authorization to access the object. The check can also be performed for a specific user or role, if needed. By default, the check is performed using the current user’s credentials. It is then applied to child and referenced objects.

Additional permission checks are applied when these can be inferred from the context in which the check was started. For example, if the check is performed on a table copy task, the referenced source and target connections are checked to determine whether the given identity has source or target usage permission respectively.

The following permissions are required:

  • READ

The Usage List shows all objects that refer to the current object. It provides an overview of the relationships and makes it easy to track these relationships.

The following permissions are required:

  • READ

License Options

This object is available if the following license option is enabled:

  • TASK_TYPE:ANALYSE_TASK

The object is also available if the license package is at least: STANDARD.