| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
When uploading a data dictionary file, everything essentialgetswill be overrode!
| ||||||
| Panel | bgColor | #DEEBFF
...
Initial Considerations
| Info |
|---|
Each row in a Data Dictionary spreadsheet corresponds to a field in your data entry form. The order of questions in a Data Dictionary file defines the order they appear in the database. |
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
The Data Dictionary is a spreadsheet in CSV format representing the structure of your instrument database. Your Data Dictionary contains the metadata used to construct your data collection instruments. It captures the same information as the Online Designer, but displays it in a more concise format
...
.
Changes you make with the Data Dictionary are not propagated in real time to your project; changes are not committed until you upload the modified Data Dictionary file.
Changes for development databases will take effect immediately, but changes to production databases will need to be reviewed and approved by the REDCap administrator before they take effect. The new structure will apply to both new and existing records.
Once your project is in Production you can make changes using the Data Dictionary. However, there are potential data loss ramifications. Take precaution by saving a copy of your project data so it can be retrieved in the case of data loss.
The REDCap project will store backup copies of previous data dictionaries in case a reversion is needed; but it does not store backup copies of project data.
...
Commonly requested changes & considerations to be mindful of:
| Expand |
|---|
Reference the "Best Practices" Knowledge Article which provides a detailed chart of the impact specific changes will have on your project. This is relevant to users whose project is in Production mode where real data collection has begunalready began. Commonly requested changes and considerations to be mindful of:Deletion of Field annotations:
Changing Field Calculations:
Branching Logic Changes:
Changing field types:
Changing variable names (rename a field)
Renaming the instrument
|
...
How to edit
...
the Data Dictionary
...
Column
...
Column Name (Row 1)
...
Description
...
Required?
...
A
...
Variable / Field Name
...
Lists the variable name
...
Yes
...
B
...
Form Name
...
Lists the auto generated form name
...
Yes
...
C
...
Section Header
...
Lists header that appears above question
...
No
...
D
...
Field Type
...
Lists field type, which is one of the following:
text, notes, calc, dropdown, radio, checkbox
yesno, truefalse, file, slider, or descriptive
...
Yes
...
E
...
Field Label
...
Label that appears on forms / surveys
...
Yes
...
F
...
Choices, Calculations, OR Slider Labels
...
Lists the choices, calculation, or slider labels.
Separates choices with |
...
:
...
calc, dropdown, radio button, and checkbox
...
G
...
Field Note
...
Text that appears below answers
...
No
...
H
...
Text Validation Type OR Show Slider Number
...
Used to validate text questions and the type
of data it will hold
(E.g. date_mdy, number, phone, etc.)
...
No
...
I
...
Text Validation Min
...
...
No
...
J
...
Text Validation Max
...
...
No
...
K
...
Identifier?
...
Has 1 if question is marked as an identifier
...
No
...
L
...
Branching Logic (Show field only if...)
...
Lists branching logic
...
No
...
M
...
Required Field?
...
Lists 1 for yes
...
No
...
N
...
Custom Alignment
(Where the answers or text box is located,
if left empty, automatically is RV)
...
RV = Right / Vertical
RH = Right / Horizontal
LV = Left / Vertical
LH = Left / Horizontal
...
No
...
O
...
Question Number (surveys only)
...
...
No
...
P
...
Matrix Group Name
...
...
Required for Matrix fields
...
Q
...
Matrix Ranking?
...
...
No
...
R
...
Field Annotation
...
...
No
| Expand | ||
|---|---|---|
| ||
The below steps only apply if your project is already in Production 7. Review the changes made by clicking on "View detailed summary of all drafted changes", this is located in the yellow box at the top of the "Data Dictionary" page and/or the "Online Designer" page 8. Once you have made all the changes, next submit the changes. Do this by clicking on “Submit Changes for Review”, this is located at the top of the "Data Dictionary" page and/or the "Online Designer" page (circled in red in image below).  9. The changes will then be reviewed someone on the REDCap Support Team. You will receive an email that either says the changes have been approved or an email that warns you of errors that may happen if the changes are approved. |
...