Manage Mappings in Mapper

This article is currently being updated. Please come back later for updates.

Within Mapper, mappings and mapped domains that have been created can be managed. This includes importing, exporting, migrating, and executing mappings.

When viewing the main Mapper window, options are available for both mapping and each domain.

Manage Mappings

View Study Snapshots

When viewing the available mappings and domains, Mapper defaults to displaying the current mappings.

If Study Snapshots have been created, it may still be necessary to view details for previous versions of study mappings. The mappings and domains that were current at the time of the snapshot can be viewed and reported on. The Study Snapshots field is displayed for studies that have at least one snapshot available.

Mappings - Manage Snapshots

Click the Study Snapshots field to display a list of snapshots and the current settings. The currently selected snapshot is indicated by a checkmark. 

While viewing the details of a snapshot other than the current one, the following actions are available:

  • Use the Export button in the Mapper section of the window to export a mapping.
  • In the Domain section, the Export, Report, and Design buttons are active, allowing export of a domain, creation of a report, and opening of the Domain Editor for viewing.

When editing a domain in a snapshot, details and data can be viewed, but no changes can be made.

Edit Mappings and Domains

Select a mapping and click Edit to open the Custom Mapping window, which allows editing of settings chosen when the mapping was created.

Select a domain and click Edit to open the Edit Domain window, which allows editing of the settings selected when the domain was created, such as the domain name and description. For more information about managing mapped domains, refer to the Manage a Mapped Domain in Mapper article.

Delete Mappings and Domains

Select a mapping and click Delete on the top toolbar to delete that mapping, including ALL mapped domains from the system.

Select a domain and click Delete on the bottom toolbar to delete that domain, including ALL versions from the system.

Import and Export Mappings and Domains

Because data transformation and mapping are often long processes that begin in a test environment, the Import and Export buttons allow creation of a mapping in a test or development environment and migration to a production environment without having to rebuild the mapping. 

Mapper also allows exporting of a mapped domain from one study and importing it into another, provided both studies have a similar structure. The import function automatically detects schemas used in the source mapping and substitutes them with the target schema names from the study into which the mapping is being imported.

The Import and Export features affect only the selected mapping. The Import and Export buttons in the domain section correspond only to the currently selected domain transformation.

  • For Mappings, the Export button exports a ZIP file containing the JSON definitions of the domains in the mapping.
  • For Domains, a single JSON file is created with the domain name and a .json extension.
  • The exported JSON or ZIP file is saved to the system's default download directory. For more information about managing mapped domains, refer to the Manage a Mapped Domain in Mapper article.
  • The Import button allows importing the JSON definition of a mapping or domain.

    IMPORTANT: elluminate supports importing XML files exported from previous versions of Mapper.

Example: Exporting and Importing Between Studies

When exporting and importing to another study, if a mapping domain called LB is exported from a study called SourceStudy and is using a DM table from the Clinical data store and an LB table from the External data store, the two tables would be qualified as follows:

  • SourceStudy_Clinical.DM
  • SourceStudy_External.LB

If the LB domain definition is exported and then re-imported to a study called TargetStudy, the schemas for the DM and LB tables in that mapping are automatically be updated as follows:

  • TargetStudy_Clinical.DM
  • TargetStudy_External.LB

Note: This applies only to source tables in the mapping. Tables referenced directly from an SQL transformation are not updated automatically. If importing domains from a different URL, the data stores used in the mapping must be identical in both URLs (name and suffix). If the source tables do not exist in the target study, the domain is imported successfully and the schemas are updated, but execution fails due to the missing tables. This is expected behavior.

Note: When importing a mapping or mapped domain, any study blinding is respected when the imported mapping domain is executed.

Note: Mapping properties, such as the Description, Target Data Store, Standards (or Specification), and others are not included in the export.

Export Mappings

  1. From Mapper, select the mapping to export.
  2. Click Export. A ZIP file with the name of the mapping is saved to the downloads folder.

Note: If a file with the same name already exists in the downloads folder, the system adds a number in parentheses. For example, STDM(1).zip.

Import Mappings

Importing a mapping imports all domain transformation rules that were part of the exported mapping.

  1. Click the Import button above the mappings. A Custom Mapping window opens.
    Custom Mapping Window
  2. Click Choose File to browse for and select the exported JSON to import.
  3. Click Save to import the mapping rules.
    1. If a mapping with the same name as the ZIP file already exists, the Custom Mapping window populates with that mapping's details. 
    2. If no mapping exists in the current project, the window is blank.

      Custom Mapping Window
  4. Make the appropriate selections and entries in the Custom Mapping window.
  5. Click Save to complete import process.

Migrate Mappings

The Migrate button allows a one-step migration of mapping rules from one environment to another. Clicking Migrate displays a drop-down list of available target URLs for receiving the migrated mapping.

Migrate Mapping

  1. Click Migrate on the toolbar.
  2. In the drop-down list, select the target study for the migration.
  3. Click OK to confirm the selection and begin the migration process.

Important: The source and target URLs must have the same study and data store names for the migration to be successful. 
The user account must have Mapper and Study Configure privileges in the target study. If not, an error message displays and the migration is cancelled.

Execute Mappings

The Execute button above the mappings executes any active domains in the mapping and publishes the data to the selected data store.
When a mapping is executed, associated visualizations can also be published for the resulting mapped data. However, because publishing may be time- and resource-intensive, the Execute Mapping window includes the option to Republish all visualizations to control this behavior.

Execute Mapping

While mappings are executing, the status indicates that processing is underway, and the Status Details column displays the name of the domain currently being processed. This information can help troubleshoot slow mapping.

Manage Mappings - Execute Status

Schedule Mappings

Mappings for studies and global data stores can be scheduled to run automatically. Clicking the Schedule button opens the New Task window, where new tasks can be created, scheduled, and managed, including adding, editing, or deleting actions.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request