Data Dictionaries

The data dictionary is a system-generated blueprint of the forms and their properties. These are especially valuable when performing validation of the various behaviors which have been built on a form. The data dictionary covers all the elements (described in detail below), across three main categories:

• Form properties and form level conditional actions

• Field properties

• Field  conditional actions

These are accessible via the following link (web only):

Select which study version or other form types, followed by the export button for the type of details needed:

The exported file name will contain the date exported and the study name.

Each export will contain the following details:

Form Properties 

• Form_ID

• Form_Name

• Sequence

• Omit Review 1

• Omit Review 2

• Omit Review 3

• Omit Review 4

• Omit Review 5

• Record Relation

• Log Form

• Suppress VOW

• Omit Error Msg

• ePRO form

• Lab form

• CA id

• Conditional Action Type

• Conditional Action Name

• Message (only for validations)

• Condition(s)

• Email Message (Subject: Body)

• Email distribution (roles)

• Date_Last_save

• User_save

• Query Override - applicable roles

• View Roles (delimited)

• Edit roles (delimited)

• Subform details - IDs and names

• Preserve deleted

Field Conditional Actions

• Field_ID

• Field_Name

• Field_Label

• Field_Type 

• CA Id

• Conditional Action Type

• Conditional Action Name

• Message (only for validations)

• Condition(s)

• Email Message (Subject: Body)

• Email distribution (roles)

• Query Override - applicable roles

• SubForm - ID, and Name

Field Properties

• Field_ID - These include any normalized table fields on the form as well

• Field_Name

• Field_Label

• Field_Type

• Norm_table_ID (if applicable) 

• Text_label - For labels that have a related field

• Hidden (true/false)

• Blinded roles (delimited)

• FLSV (true/false)

• Required (true/false)

• Valid range (numbers)

• Decimal places (numbers)

• Max length (text/memo)

• Field mask (text)

• Single Select codes (choice fields)    

• Date_time_type (date/time fields)

For a summarized data dictionary focused only on the field conditional actions and primary field components, use the quick link here:

The following details are provided in the summarized data dictionary:

• Form Name

• Form ID

• Field Name

• Field Label

• Field ID

• Field Type

• Field Choices - select/dropdown fields only

• Conditional Actions (concatenated)

How to use these documents for documenting User Acceptance Testing (Requirement Trace Matrix)

1. The first step is to auto validate the crfs Auto-Validating Forms

2. The second step is to Export data dictionaries described above in Excel.

   1. The summarized data dictionary

   2. Export Form Properties

   3. Export Field Conditional Actions

   4. Export Field Properties

3. On each export above add the following columns to the end of the document.

   1. Pass or Fail

   2. Results - Common answers are “As expected”, “Failure”, or “Test Script Failure” Always want to answer as expected if it passes not just pass. You have to refer to the requirement of the row.

   3. Notes Failure documentation

   4. Issue Tracking ID - Track a report of the issue

   5. By Whom (Testers initials)

   6. Date of the test(s)

   7. Notes

4. Conduct test of each (pertinent) row of spreadsheet testing the Columns A-J.

See the Example here:

Related articles