XDM3 Configuration Examples

The XDM3 Configuration Examples repository contains ready-to-use examples of common XDM objects, such as matcher, modification methods, task execution reports, attribute generators, task stage hooks, and workflows. These examples are intended to help you implement typical use cases faster, by providing preconfigured objects that you can import into your XDM environment and adapt to your own data and processes.

Each section in this chapter introduces one object type and links to the corresponding example files in the repository, as well as to the detailed reference documentation for further configuration options and background information.

Matcher

A matcher is an auxiliary object that is used to analyze the values of a column and identify data that matches specific criteria. This repository contains some pre-defined matcher which can be used directly in your PII Finder tasks after importing them.

These matcher examples can be used, for example, to:

  • Detect personal data (such as email addresses or phone numbers) in existing tables.

  • Classify columns by content type to support data discovery.

  • Pre-check or validate input data before further processing.

For more information, see the Matcher section in the Reference documentation.

Examples for this topic can be found in Matcher.

Modification Methods

A modification method contains the script and the parameters required for data modification. The examples in this repository provide ready-made modification methods for common masking, pseudonymization, and value transformation scenarios that you can directly use or adapt in your tasks.

Typical uses for these modification method examples include:

  • Masking or pseudonymizing sensitive attributes before using data in test environments.

  • Normalizing or transforming values into a standard format.

  • Generating realistic but artificial replacement values for production-like test data.

For more information about modification methods, see the Modification Method section in the Object Reference.

More information about the concept of modification methods can be found in the Modify Data chapter of Working with XDM.

Some modification methods need the lookup tables to be uploaded in your XDM environment as mapping table XDM Lookup Table. For further information, see the Installation of lookup tables section in the Reference documentation.

The following examples are grouped by the type of data they modify.

Examples of Common Value Generation

These examples provide modification methods that generate new values, for example random but realistic personal or technical data, to create production-like test data without exposing real sensitive information.

See Value Generation for examples.

Examples of Common Identifiers

These examples focus on modification methods for identifiers, such as customer numbers, account numbers, or other business keys. They can be used to consistently mask or regenerate identifiers while preserving referential integrity across tables.

See Identifiers for examples.

Examples of Common Address and Personal Data

These examples cover modification methods for typical address and personal attributes, such as names, street addresses, or contact details. They help you anonymize or pseudonymize personal data while keeping the data structurally valid.

See Address and Personal Data for examples.

Task Execution Reports

A task execution report is an object on a task or workflow template that collects selected task execution information using SQL statements. The examples in this repository provide predefined reports that you can attach to your tasks or workflows to monitor results and quality metrics without writing your own SQL from scratch.

These task execution report examples can be used to:

  • Summarize key statistics from a task run, such as processed rows or error counts.

  • Track data quality metrics or rule violations over time.

  • Create standardized reports for recurring test or load processes.

For more information, refer to section Task Execution Reports in the Object Reference.

See Task Execution Reports for examples.

Attribute Generators

An attribute generator contains the script that defines how an entity attribute is generated. The examples in this repository deliver reusable generators for frequently needed attribute types, so you do not have to implement every value generation rule yourself.

You can use these attribute generator examples to:

  • Derive new attributes from existing data (for example, flags, classifications, or combined values).

  • Generate realistic synthetic attributes for test entities.

  • Standardize how certain attribute types are calculated across multiple entities.

For more information, see the Attribute Generator section in the Object Reference.

The following examples are grouped by the type of data they generate.

Basic Attribute Generators

These examples cover simple and generally applicable attribute generators, for example generators for static values, simple calculations, or basic concatenations that can be reused in many different entities.

See Basic Attribute Generators for examples.

Address Attribute Generators

These examples focus on address-related attributes, such as building full address strings from components or generating plausible address data for test purposes.

See Address Attribute Generators for examples.

Banking Attribute Generators

These examples provide generators for banking-related attributes, such as account numbers or IBAN-like values, that are structurally valid and suitable for testing banking applications.

See Banking Attribute Generators for examples.

Identity Attribute Generators

These examples concentrate on identity-related attributes, such as personal identifiers or profile keys, and can be used to create consistent and realistic identity structures for test data.

See Identity Attribute Generators for examples.

Task Stage Hooks

Task stage hooks are code snippets that can be executed during task or workflow execution. The examples in this repository show common patterns for adding custom logic at specific execution stages without modifying the core task or workflow definition.

These task stage hook examples can help you to:

  • Perform preparatory or cleanup actions around task execution.

  • Implement additional checks, logging, or audit information.

  • Integrate external systems or trigger follow-up processes during a workflow run.

For further information about the concept, see Task Stage Hook in the Object Reference, see Task Stage Hook examples in the Script Reference, and Task Stage Hooks in Working with XDM.

See Task Stage Hooks for examples.

Workflows

A workflow is an executable instance of a workflow template. The workflow examples in this repository provide preconfigured workflows that combine multiple tasks, hooks, and reports into end-to-end processes for common data management and test scenarios.

You can use these workflow examples to:

  • Orchestrate typical test data provisioning or masking processes.

  • Establish standardized sequences of tasks for recurring jobs.

  • Learn best practices for structuring workflows in your own projects.

For more information about workflows, see the Workflow section in the Reference.

See Workflows for examples.