Permissions: Users must have Mapper and Mapper Advanced privileges to create Dynamic Mapping Templates.
Dynamic Mapping Templates (DMTs) enable users to define reusable mapping rules that handle variations in source table names. They can perform two transformations:
- Union: Uses wildcards to merge multiple, similarly structured tables into a single domain.
- Rename: Maps a single source table directly to a target domain.
DMTs provide an alternative way to create mappings and mapped domains. Created globally, templates can be linked to study data by scope or manually added to a specific mapping within a study. A template can automatically create its target mapping and domain, or work alongside existing, study-specific mappings.
Why Use Dynamic Mapping Templates?
- Automate Repetitive Mappings: A single Union template with wildcards can capture entire families of similarly named tables (e.g., AE1, AE2, AE_OLD), eliminating the need to build identical mappings one by one.
- Enforce Cross-Study Consistency: Because templates execute at import and can be scoped globally or per study, the same Rename or Union rules are applied everywhere, ensuring uniform domain structures and variable handling.
- Centralized Maintenance: Update a template once, including auto‑create options or variable exclusions, and every linked study inherits the change automatically, eliminating the need to edit individual mappings across multiple projects.
Create Dynamic Mapping Template
- Click the 9-dot icon to open the Platform Menu.
- From the Platform Menu under the Data Mapping & Computing, select Dynamic Mapping Templates.
- From the Dynamic Mapping Templates page, click the Add icon in the master header.
The New Dynamic Mapping Template window opens.
The values in the image below illustrate how fields are populated when creating a Dynamic Mapping Template. Any item marked with a red asterisk is required.
Define Template Settings
- Template Name (required): Enter a clear, descriptive name for the Dynamic Mapping Template.
- Template Description: Provide a concise summary describing the purpose of the template.
- Transformation (required): Select one of the two options. The fields available for variable settings adjust depending on the selection.
- Union: Merges two or more similarly structured tables, resolving minor differences, such as extra fields, column order, or renamed variables.
- Rename: Performs a one‑to‑one mapping, directly renaming a single source table to a new target domain.
Source Table(s) (required): Enter the name(s) of the source tables that the template monitors. This field is case-insensitive.
- Union: Use wildcards to match multiple source tables (e.g., LB_* to merge all tables beginning with LB_).
- * matches any sequence of characters.
- ? matches exactly one character.
- Rename: Enter the exact source table name without wildcards (e.g., AE to rename it to AE_NEW).
Note: For a Union transformation, if a wildcard only matches one table, the template still processes that single table into the target domain.
- Union: Use wildcards to match multiple source tables (e.g., LB_* to merge all tables beginning with LB_).
Specify Target Mapping & Domain
Target Mapping: Enter the mapping that will receive the new domain created by the template.
- Mapping Already Exists: The template sends results to the existing data store defined in that mapping; the Target Datastore field is ignored.
- Mapping Does Not Exist: When Auto Create is checked, a new mapping is automatically created in the selected Target Datastore.
Note: A domain created by a template never overwrites an existing domain in the specified mapping.
- Target Datastore: From the drop-down menu, select the data store that will hold the new domain. Only use this field when the target mapping does not exist and Auto Create is checked. If the mapping already exists, its current data store overrides the selection.
Auto Create:
- Checked: elluminate creates the target mapping if it does not exist and then adds the target domain if it is not already present.
- Unchecked: The template does not create the mapping or domain automatically. Create them manually to control when the template can be used.
Important: When Auto Create is checked, Target Mapping and Target Datastore become mandatory fields.
- Target Domain (required): Enter the name of the new domain the template will generate.
- Target Domain Label: Specify an optional descriptive label for the newly created domain.
- Active: When checked, the template runs automatically when imported data match its scope. If unchecked, the template does not run automatically but can be triggered manually.
- Domain Tags: Click the drop-down menu and select one or more applicable tags for categorizing the domain.
Set Variables & Scope
- Exclude variables: Enter a comma-separated list of columns / variables to omit from source table(s). These fields are not included in the resulting domain. Common examples include userid, project, EnvironmentName, or DataPageName.
- Always Add Variables: Enter any variables that must be present in the resulting domain, even when they are missing from some of the source tables. elluminate creates these columns / variables and populates them with NULL values.
Variable Configuration: Select from the options below.
(The options outlined in red, display only when Union is selected.)- Include All Variables: Adds every column found in any source table included in the union transformation. Columns missing from some tables are added to the resulting domain and filled with NULLS.
Include Matching Variables: Limits the merged domain to columns shared by every source table, excluding any variable missing from even a single table.
Important: While users can select either Include All Variables or Include Matching Variables, these options cannot be selected simultaneously.
- Append Source Identifier: Adds a FormOID column to the resulting domain, recording the source table name for each row. This option is particularly helpful when merging tables with the Union transformation but is also available with the Rename transformation.
- Scope (required): Select one or more categories, such as Therapeutic Areas, Programs, Compounds, Studies, or Global Data Stores. Each selection broadens the scope: the template monitors every import within these criteria, and if Active is selected, it executes automatically when matching source tables are imported into the Input Data Store.
- Input Data Stores (required): Select one or more Input Data Stores the template should monitor. This field is mandatory. The template executes automatically when data matching its scope are imported into these selected data stores, provided the Active box is checked.
- Click Save to add the template to the Dynamic Mapping Templates list. When data are imported into the selected Input Data Store and match the defined scope, the template triggers automatically (if Active is checked). During its initial run, the template creates the target mapping and domain (if Auto Create is checked); it refreshes the domain’s data on every subsequent import.
Verify Results of a Dynamic Mapping Template
Use the following steps to confirm that the Dynamic Mapping Template executed successfully and that the mapping and domain were created in the target data store.
- Import data into the selected Input Data Store within the specified scope.
- If the template is active, it runs automatically. On the initial run, it creates the new mapping and domain if Auto Create is enabled.
- Open Mapper to verify the results.
- In the Mappings section, confirm that the mapping is present.
- In the Domains section, confirm that the domain is present and displays a lightning‑bolt icon, indicating that it was generated by a Dynamic Mapping Template.
- Open the domain in the Domain Editor to review the transformation.
- The left panel displays the domain under the target data store. The right panel displays the applied transformation.
- The left panel displays the domain under the target data store. The right panel displays the applied transformation.
- In Data Central, verify that the domain appears in the Data subpanel.
- Select the domain to review the column configuration, including excluded variables and appended columns such as FormOID.
- This step requires the study to be configured for Data Central.
Migrate DMT Configurations Between elluminate URLs
Dynamic Mapping Template configurations can be migrated by exporting completed templates to an Excel file and importing the file into another elluminate environment. The exported file contains all configuration fields and is validated on import to ensure successful deployment.
Export DMT Configurations
- Click the 9-dot icon to open the Platform Menu.
- From the Platform Menu under the Data Mapping & Computing, select Dynamic Mapping Templates.
- From the Dynamic Mapping Templates page, select the templates to be migrated.
- Click the Export icon in the master header to generate an Excel file containing the template configurations. The file downloads to the computer; save the file locally.
The exported file can be edited if necessary before importing; however, editing is discouraged to prevent potential errors.
Import DMT Configurations
Open Dynamic Mapping Templates in the target elluminate environment.
Click the Import icon. The Import Dynamic Mapping Templates window opens.
Select or drop the Excel file containing the exported template configurations.
If validation is successful, review the summary of new templates to be added and existing templates to be updated. When no validation issues are present, the window displays the number of new and existing templates.
When validation errors occur, messages display in the window. Review the messages and update the Excel file as needed to resolve the issues.
Click Import.
Tips and Troubleshooting
- Ensure that the exported Excel file is saved locally before import.
- Avoid modifying column names, field structure, or required values in the file to prevent validation errors.
- If validation errors appear, review each message and correct the corresponding entries in the Excel file.
- Confirm that the target elluminate environment contains any dependencies referenced by the imported DMTs.
- Re-export the DMT configurations if errors persist and compare the original export with the edited version to identify discrepancies.