Working with Syntactic Mapping Configurations in JSON format – Rhino Health

This topic explains how to work with syntactic mapping configurations in JSON format.

The Syntactic Mapping contains a mapping of source fields to target fields along with transformations to be applied during the mapping process. This mapping can be edited in the FCP UI, and it can be viewed, downloaded, edited, and uploaded in JSON format. The JSON format is simply a different representation of the syntactic mapping configuration and has the same capabilities as in the FCP UI.

Prerequisites

You must have Manage Data Mappings permission.

What You'll Learn

In this topic, you will learn how to:

Access the Syntactic Mapping Page
View a Syntactic Mapping Configuration in JSON format
Download a Syntactic Mapping Configuration in JSON format
Create a new Syntactic Mapping from a configuration file in JSON format

Access the Syntactic Mappings Page

To access the Syntactic Mappings page, do the following.

Select Data Mappings from the main menu.
In the Data Mappings page, select Syntactic Mappings.

The Syntactic Mappings page shows syntactic mappings that have been created.

The fields in the screenshot above are defined in the table below.

Button or Field	Description
Create Syntactic Mapping	Click this button to create a new syntactic mapping.
New version	Click this button to create a new version of an existing syntactic mapping.
Syntactic Mapping Name	Name of the mapping.
Version	Indicates the version of the Syntactic Mapping. The first version of a Syntactic Mapping is the number 0.
Information icon (on hover)	Displays additional information about the syntactic mapping, such as the description provided during creation of the syntactic mapping.
Date Created	Indicates the date the syntactic mapping was created.
Target Data Model	Indicates the target data model for the mapping, such as OMOP v5.4.
Source Data Schemas	Indicates the source data schemas of the datasets that you would like to map. If there is more than one, the number of source schemas will appear (e.g. “3 Schemas”). If there is more than one schema, hover to see the names of the schemas.
Target Tables	Indicates the target tables for the transformation. If there is more than one, the number of target tables will appear (e.g. "2 Tables"). If there is more than one table, hover to see the names of the tables.
Creator	Name of the person who created the syntactic mapping.
3 Dot Menu	The three dot menu (also known as the "context menu") provides access to additional options: Copy UID, Show Configuration, Download Mapping Config, and Remove Syntactic Mapping.

View a Syntactic Mapping Configuration in JSON format

You can view a syntactic mapping configuration in JSON format, by completing the following steps.

In the Syntactic Mappingד page, select the three-dot menu for the version of the syntactic mapping you want to view and select "Show configuration".
The Syntactic Mapping Configuration page appears. Scroll down to see the Mapping Configuration if it is not visible.

If you want to copy the configuration mapping to your computer's clipboard, select the rectangle on the right side of the page.

Select Close.

Downloading a Syntactic Mapping Configuration in JSON Format

To download a syntactic mapping configuration, do the following.

In the Syntactic Mappings page, click the three-dot menu for the version of the syntactic mapping you want to download and click "Download mapping config".
The configuration file downloads to your computer.

Creating a Syntactic Mapping from JSON Configuration

To create a syntactic mapping configuration from a JSON configuration file, do the following.

In the Syntactic Mappings page, click the "Create Syntactic Mapping" button. The Create Syntactic Mapping Page appears.
Enter a name, optionally also a description, and select your target data model.
Under configuration, select "Upload From File", and then select your JSON configuration file.
Click Create Syntactic Mapping.