generated from susom/redcap-em-template
-
Notifications
You must be signed in to change notification settings - Fork 6
/
config.json
149 lines (133 loc) · 5.2 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
{
"name": "Multi Signature Consent",
"namespace": "Stanford\\MultiSignatureConsent",
"description": "This module allows you to combine data from one or more forms into a single PDF. It was designed for use in projects where you have multiple consent forms completed by multiple participants or coordinators and wish to merge them into a single, 'final', consent. You can then use an Alert and Notification to email the final consent to participants.",
"documentation": "README.md",
"framework-version": 9,
"authors": [
{
"name": "Andrew Martin",
"email": "[email protected]",
"institution": "Stanford University"
},
{
"name": "Jae Lee",
"email": "[email protected]",
"institution": "Stanford University"
}
],
"permissions": [
"redcap_module_system_enable",
"redcap_module_project_enable",
"redcap_module_save_configuration",
"redcap_save_record",
"redcap_pdf",
"redcap_every_page_before_render"
],
"enable-every-page-hooks-on-system-pages": false,
"links": {
"project": [
],
"control-center": [
]
},
"no-auth-pages": [
],
"project-settings": [
{
"key": "instance",
"name": "<b>Instruments to Merge</b>",
"required": true,
"type": "sub_settings",
"repeatable": true,
"sub_settings": [
{
"key": "form-name",
"name": "<b>Form</b>",
"required": true,
"type": "form-list"
}
]
},
{
"key": "destination-file-field",
"name": "<b>File Field</b><br>This is where the PDF will be saved in the record and it must be a file-upload field",
"required": true,
"type": "field-list"
},
{
"key": "eval-logic",
"name": "<b>Update Logic</b><br>When this logic is true and one of the above forms is saved, then create the PDF. This logic should not be true until all forms are complete AND should not remain true after the PDF has been generated or else it might lead to multiple PDFs being created on each SAVE event.<br><i>e.g.</i> <code>[coordinator_signature]<>\"\" AND [dest_file_field]=\"\"</code>",
"required": true,
"type": "textarea"
},
{
"key": "header",
"name": "<b>Custom Header</b><br>This header will appear in the upper-right corner of the PDF",
"required": false,
"type": "note"
},
{
"key": "footer",
"name": "<b>Custom Footer</b><br>This footer will appear on the bottom center of the PDF",
"required": false,
"type": "note"
},
{
"key": "keep-page-breaks",
"name": "<b>Keep Page Breaks</b><br>Normally page breaks between forms are removed. Check here to keep each form on a separate page in the PDF",
"required": false,
"type": "checkbox"
},
{
"key": "keep-record-id-field",
"name": "<b>Keep Record ID Field Row</b><br>The record id is always in the header, but if you check this it will also be part of the PDF if on the first instrument",
"required": false,
"type": "checkbox"
},
{
"key": "save-to-file-repo",
"name": "<b>Save in File Repository</b><br>Check to save a permanent copy in the local file repository",
"required": false,
"type": "checkbox"
},
{
"key": "save-to-external-storage",
"name": "<b>Save to External Storage</b><br>Check to save a permanent copy in the external storage (the same location that is configured for the econsent module)",
"required": false,
"type": "checkbox"
},
{
"key": "save-to-as-survey",
"name": "<b>Save As This Survey In File Repository</b><br>If you check the previous option, set which survey you want this to appear as in the File Repository. If you are using the eConsent Framework on one of the surveys in this config, then be sure to select a different survey as you can only have one entry per record, per survey id in the File Repository. Will default to first form otherwise",
"required": false,
"type": "form-list"
},
{
"key": "save-only-completed",
"name": "<b>Save Only Completed Forms</b><br>If checked, only forms that were completed (status=2) will be added to the merged PDF",
"required": false,
"type": "checkbox"
},
{
"key": "enable-project-debug-logging",
"name": "<b>Enable Debug Logging</b><br><i>(optional)</i> Requires installation and configuration of emLogger",
"required": false,
"type": "checkbox"
}
],
"system-settings": [
{
"key": "enable-system-debug-logging",
"name": "<b>Enable Debug Logging (system-wide)</b><i>(optional)</i> Requires installation and configuration of emLogger",
"required": false,
"type": "checkbox"
}
],
"compatibility": {
"php-version-min": "",
"php-version-max": "",
"redcap-version-min": "",
"redcap-version-max": ""
}
}