-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathconfig.json
191 lines (191 loc) · 7.26 KB
/
config.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
{
"name": "Custom Record Auto-numbering",
"namespace": "MCRI\\RecordAutonumber",
"authors": [
{
"name": "Luke Stevens",
"email": "[email protected]",
"institution": "Murdoch Children's Research Institute"
}
],
"description": "Allows users to create a custom record auto-numbering schema for their REDCap project. This works during data entry but not in public surveys or API/CSV data import.",
"framework-version": 8,
"compatibility": {
"redcap-version-min": "11.1.1"
},
"permissions": [
"redcap_add_edit_records_page",
"redcap_data_entry_form_top",
"redcap_every_page_before_render",
"redcap_every_page_top",
"redcap_save_record",
"redcap_module_project_enable"
],
"enable-every-page-hooks-on-system-pages": false,
"system-settings": [
{
"key": "project-setup-dialog-text",
"name": "Project Setup page dialog box text<p class=\"text-muted\">Default:<br>\"REDCap's built-in record auto-numbering is being overridden by the \"Custom Record Auto-numbering\" External Module.\"</p>",
"required": false,
"type": "text"
},
{
"key": "unsaved-record-lock-text",
"name": "Text for Lock option of data entry form for unsaved record<p class=\"text-muted\">Default:<br>\"Record must be saved prior to locking when using the \"Custom Record Auto-numbering\" External Module.\"</p>",
"required": false,
"type": "text"
}
],
"project-settings": [
{
"key": "descriptive-text-1",
"name": "Options for record autonumbering in this project.",
"type": "descriptive"
},
{
"key": "autonumber-option",
"name": "Record auto-numbering option",
"required": true,
"type": "dropdown",
"choices": [
{ "value": "IncrementFromSeed", "name": "Integer increment from specifed start value" },
{ "value": "PrefixAndPad", "name": "Padded integer increment with prefix" },
{ "value": "DAGIncrement", "name": "Increment within DAG using part of DAG name" },
{ "value": "DateTimeFormat", "name": "Date/time in selected format" },
{ "value": "Timestamp", "name": "Unix timestamp (16 digits)" },
{ "value": "Custom", "name": "A project-specific custom auto-numbering schema" }
]
},
{
"key": "option-setting-increment-from-seed",
"name": "Specify the first record id. Subsequent ids will increment from this project-wide (even for users in a DAG)",
"required": true,
"type": "text",
"branchingLogic": {
"field": "autonumber-option",
"value": "IncrementFromSeed"
}
},
{
"key": "option-setting-prefixandpad-prefix",
"name": "Specify a fixed prefix (can be blank)",
"required": false,
"type": "text",
"branchingLogic": {
"field": "autonumber-option",
"value": "PrefixAndPad"
}
},
{
"key": "option-setting-prefixandpad-padlen",
"name": "Padding (with zeros) length",
"required": true,
"type": "dropdown",
"choices": [
{ "value": "1", "name": "1 digit 1 - 9, 10, 11, ..." },
{ "value": "2", "name": "2 digits 01 - 99, 100, 101, ..." },
{ "value": "3", "name": "3 digits 001 - 999, 1000, 1001, ..." },
{ "value": "4", "name": "4 digits 0001 - 9999, 10000, 10001, ..." },
{ "value": "5", "name": "5 digits 00001 - 99999, 100000, 100001, ..." },
{ "value": "6", "name": "6 digits 000001 - 999999, 1000000, 1000001, ..." }
],
"branchingLogic": {
"field": "autonumber-option",
"value": "PrefixAndPad"
}
},
{
"key": "option-setting-dag-part-len",
"name": "Specify the characters to extract from DAG full name",
"required": true,
"type": "dropdown",
"choices": [
{ "value": "1", "name": "First character" },
{ "value": "2", "name": "First two characters" },
{ "value": "3", "name": "First three characters" },
{ "value": "4", "name": "First four characters" },
{ "value": "5", "name": "First five characters" },
{ "value": "6", "name": "First six characters" },
{ "value": "-1", "name": "Last character" },
{ "value": "-2", "name": "Last two characters" },
{ "value": "-3", "name": "Last three characters" },
{ "value": "-4", "name": "Last four characters" },
{ "value": "-5", "name": "Last five characters" },
{ "value": "-6", "name": "Last six characters" },
{ "value": "id", "name": "Use Group ID" },
{ "value": "un", "name": "Use DAG unique name" }
],
"branchingLogic": {
"field": "autonumber-option",
"value": "DAGIncrement"
}
},
{
"key": "option-setting-separator",
"name": "Specify the character(s) to use as separator between DAG part and incrementing part (e.g. \"-\"; can be blank)",
"required": false,
"type": "text",
"branchingLogic": {
"field": "autonumber-option",
"value": "DAGIncrement"
}
},
{
"key": "option-setting-inc-part-len",
"name": "Specify the length of the incrementing part (will begin at 1 and be left-padded with zeros; overflows to additional digits)",
"required": true,
"type": "dropdown",
"choices": [
{ "value": "1", "name": "1 digit 1 - 9, 10, 11, ..." },
{ "value": "2", "name": "2 digits 01 - 99, 100, 101, ..." },
{ "value": "3", "name": "3 digits 001 - 999, 1000, 1001, ..." },
{ "value": "4", "name": "4 digits 0001 - 9999, 10000, 10001, ..." },
{ "value": "5", "name": "5 digits 00001 - 99999, 100000, 100001, ..." },
{ "value": "6", "name": "6 digits 000001 - 999999, 1000000, 1000001, ..." }
],
"branchingLogic": {
"field": "autonumber-option",
"value": "DAGIncrement"
}
},
{
"key": "option-setting-dag-inc-desc",
"name": "Examples:<br><br>DAG names: \"Royal Children's RCH\", \"Children's Hospital Westmead CHW\"<br>Settings: Last 3 chars; - separator; 3 incrementing digits<br>Auto-numbering: RCH-001, RCH-002, ...; CHW-001, CHW-002, ...<br><br>DAG names: \"11 RCH\", \"12 CHW\"<br>Settings: First 2 chars; no separator; 4 incrementing digits<br>Auto-numbering: 110001, 110002, ...; 120001, 120002, ...",
"type": "descriptive",
"branchingLogic": {
"field": "autonumber-option",
"value": "DAGIncrement"
}
},
{
"key": "option-setting-date-time-format",
"name": "Specify the required datetime format using a PHP datetime format string (e.g. \"Y-m-d H:i:s\"; \"YmdHis\") ",
"required": true,
"type": "text",
"branchingLogic": {
"field": "autonumber-option",
"value": "DateTimeFormat"
}
},
{
"key": "option-setting-custom-class-name",
"name": "File/class name of custom auto-numbering code",
"required": true,
"type": "text",
"branchingLogic": {
"field": "autonumber-option",
"value": "Custom"
}
},
{
"key": "option-setting-custom-params",
"name": "Configuration settings for custom auto-numbering class as JSON string.",
"required": false,
"type": "textarea",
"branchingLogic": {
"field": "autonumber-option",
"value": "Custom"
}
}
]
}