Skip to content

Commit 21b6bd0

Browse files
authored
Merge pull request #1033 from david-roper/record-array-docs
2 parents 99dc341 + 348aed7 commit 21b6bd0

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

docs/en/3-guides/3.3-how-to-upload-data.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Open Data Capture allows you to visualize numeric measures over time in a single
2323

2424
3. **Select the Upload tab**
2525

26-
Select the upload tab within the side navigation bar. This will reveal a page displaying all the Form instruments that are available in the current OpenDataCapture instance.
26+
Select the upload tab within the side navigation bar. This will reveal a page displaying all the form instruments that are available in the current OpenDataCapture instance.
2727

2828
4. **Select Instrument to Upload to**
2929

@@ -41,12 +41,30 @@ Open Data Capture allows you to visualize numeric measures over time in a single
4141

4242
Some forms may have Zod field types that are challenging to represent in a standard CSV format. Therefore, specific notations must be used to ensure the upload feature can properly parse the data.
4343

44-
For example: If a form has a field that accepts a set of data, such as a multi-option checklist with options a, b, and c, the proper notation for the data would be:
44+
- **_Set Data_**
4545

46-
- SET(a,b)
47-
- SET(a,b,c)
48-
- SET(a)
46+
If a form has a field that accepts a set of data, such as a multi-option checklist with options a, b, and c, the proper notation for the data would be:
4947

50-
This format allows the upload feature to correctly interpret the selected options.
48+
- SET(a,b)
49+
- SET(a,b,c)
50+
- SET(a)
51+
52+
This format allows the upload feature to correctly interpret the selected options.
53+
54+
- **_Record Array Data_**
55+
56+
Record array data is a custom form of data entry for when there can be multiple records for one column field. For example, the types of scans and their info in an MRI form would be record array data. If a record contains a set of questions/ data fields A, B, and C, the proper notation for data entry would be as follows:
57+
58+
- RECORD_ARRAY(A: dataEntryForA, B: dataEntryForB, C: dataEntryForC ;)
59+
60+
If the record array question contains multiple records the data entry would look like so:
61+
62+
- RECORD_ARRAY(A: dataEntryForA, B: dataEntryForB, C: dataEntryForC ; A: dataEntryForA2, B: dataEntryForB2, C: dataEntryForC2 ;)
63+
64+
Note that every "," notates a new entry in the record, whilst every ";" notates a new record in the record array
65+
66+
- **_Optional Data_**
67+
68+
Whenever data is optional within a form it can be left empty and still be properly submitted. Any optional data column in the csv template will have an "(optional)" tag attached to its sample data entry, which means any entry in the column can be left blank. This is usually done in that case of when one column value depends on another. For example, a sessionFailed column would be followed by an optional reasonForFailure column.
5169

5270
</Steps>

0 commit comments

Comments
 (0)