Data Dictionary Overview

The Data Dictionary is a reference tool that lists names, definitions, and attributes of data that can be imported into Ripple. It specifies the values allowed in a global or study-specific Template, ensuring correct data formatting. Since Ripple's import tool is case-sensitive, it's important to follow the exact format, including capitalization, for variables, dates, times, and custom options to avoid errors.

Steps for Using the Data Dictionary

1. Review the Data Dictionary:

   • Navigate to Site Admin-->Import. Locate the Dictionary button in for your specific study or the global template.
   • Identify the required variables, definitions, and expected formats.
     

2. Check Formatting Requirements:

   • Pay attention to letter case (uppercase/lowercase matters).
   • Ensure dates, times, and custom variable options match exactly as specified.

3. Prepare Your Import Template File:

   • Use the correct variable names and values as listed in the Data Dictionary.
   • Double-check that the format is consistent for all entries.

4. Verify Before Importing:

   • Scan for typos or incorrect capitalization.
   • Confirm that all data entries follow the expected structure.

5. Import the Data into Ripple:

   • Upload the prepared template using Ripple’s import tool.
   • If an error occurs, refer back to the Data Dictionary to correct formatting issues.

Reading Your Data Dictionary in Ripple

The Data Dictionary consists of four columns that provide details on the variables you can import into Ripple. It specifies the type of data allowed, the correct formatting, and any special instructions. This ensures that you enter data accurately and avoid import errors.

Understanding the Four Columns in the Data Dictionary:

1. Field:

   • This column lists the variable name or data field where you will input data.
   • Global Data Dictionary fields include standard fields like name, global and family IDs, demographics, tags, contact info, global contact,  email, consent, comment logs and global custom variables.
   • Study-Specific Data Dictionary fields include all fields from your Global Data Dictionary and extra fields for events, statuses, custom IDs, recruitment sources, sites, strategies and other study-specific custom variables.

2. Type:

   • Defines the type of value for each field. Based on Ripple's pre-set variable options and how you set up your custom variable options.
   • Possible types:
     • Short text / Long text (e.g., names, comments)
     • Single select / Multi select (preset choices)
     • Number (numerical values)
     • Boolean (true/false)
     • Option (predefined choices)
     • Date / DateTime (formatted date values)

3. Allowed:

   • Specifies the required format for the data.
   • Lists acceptable options for single/multi-select fields.
   • Defines the correct date format to prevent errors.

4. Description:

   • Provides additional notes on data requirements.
   • Indicates if a variable is global or study-specific.
   • Gives formatting tips and specific entry rules.

Additional Formatting Rules for Data Dictionary

The Data Dictionary enforces strict formatting rules to ensure smooth data imports. These include lowercase text, specific date formatting, underscores instead of spaces, and pipe-separated (|) multi-select entries. Following these rules exactly will prevent errors in Ripple’s import process.

Instructional Steps for Correct Formatting:

1. Text Formatting Rules

✅ Use lowercase for all words (except Boolean values).
✅ Boolean values must be in ALL CAPS → TRUE or FALSE.
✅ Variable names with spaces → Replace spaces with underscores (_) in your template.

2. Date Formatting (MM/DD/YYYY)

✅ Ensure dates follow the MM/DD/YYYY format.
✅ To format date columns in Excel or Google Sheets:

1. 1. 1. Highlight the column containing date data.
      2. Right-click → Select "Format Cells".
      3. Choose the “Date” category.
      4. Select the second-to-last option at the bottom of the list.
      5. ❌ Do NOT use the option with an asterisk (*).

3. Multi-Select Variables

✅ Separate multiple values with the "|" character (pipe symbol).
✅ No spaces between values → Example: option1|option2|option3.
✅ Enter all multi-select options in one cell during upload.
✅ If not all values are included, Ripple will overwrite existing data instead of appending.

 

 

 

 

 

 

 

 

Was this article helpful?0 out of 0 found this helpful