generated from susom/redcap-em-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.json
148 lines (132 loc) · 4.24 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
{
"name": "REDCap_Notifications",
"namespace": "Stanford\\RedcapNotifications",
"description": "Notification System that can display messages to REDCap users",
"documentation": "README.md",
"authors": [
{
"name": "Irvin Szeto",
"email": "[email protected]",
"institution": "Stanford University"
},
{
"name": "Lee Ann Yasukawa",
"email": "[email protected]",
"institution": "Stanford University"
}
],
"framework-version": 9,
"permissions": [
"redcap_every_page_top",
"redcap_save_record"
],
"enable-every-page-hooks-on-system-pages": true,
"links": {
"project": [
],
"control-center": [
{
"name": "Test Notification Page",
"icon": "pencil",
"url": "pages/TestPage.php",
"show-header-and-footer": true
},
{
"name": "DemoNote",
"icon": "pencil",
"url": "pages/DemoNote.php",
"show-header-and-footer": true
}
]
},
"enable-ajax-logging": true,
"auth-ajax-actions": [
"MyAction"
,"get_full_payload"
,"check_forced_refresh"
,"save_dismissals"
],
"no-auth-ajax-actions": [
"MyAction"
,"refresh"
,"dismiss"
,"force_refresh"
],
"project-settings": [
{
"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": "header",
"name": "<h6><b>REDCap Notification EM</b></h6></div>",
"type": "descriptive"
},
{
"key": "instructions",
"name": "<b>For First time setup</b><p>Please check the boxes above to enable this EM on all projects by default and to hide this EM from all non-admins</i></div>",
"type": "descriptive"
},
{
"key": "notification-pid",
"name": "<b>Notifications PID</b><i></i> Project ID where notifications are created and stored",
"required": true,
"type": "project-id"
},
{
"key": "dismissal-pid",
"name": "<b>Notifications that were dismissed PID</b><i></i> Project ID where notifications were viewed and dismissed",
"required": true,
"type": "project-id"
},
{
"key": "redcap-notifs-snooze-minutes",
"name": "Time in <b>minutes</b> that the snooze button will hide REDCap Notifications",
"required": false,
"type": "text"
},
{
"key": "redcap-notifs-refresh-limit",
"name": "Time in <b>hours</b> before forcing a notification payload refresh",
"required": false,
"type": "text"
},
{
"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"
},
{
"key": "max-expiry-days",
"name": "<b>Max number of days notifications will be displayed</b><i></i> If an expiry date is not entered, the notification will expire after this many days",
"required": true,
"type": "text"
},
{
"key": "user-specific-log-list",
"name": "<b>Comma separated List of UserIDs to trigger custom debugs</b><i></i> We are tryign to figure out why a subset of userids are triggering callbacks every 30 seconds instead of honoring the 6 hour grace time",
"required": false,
"type": "note"
}
],
"crons": [
{
"cron_name": "redcap_notifs_refresh_queue",
"cron_description": "This cron will run every N seconds to process notif payload refresh requests.",
"method": "processJobQueue",
"cron_frequency": "60",
"cron_max_run_time": "300"
}
],
"compatibility": {
"php-version-min": "",
"php-version-max": "",
"redcap-version-min": "",
"redcap-version-max": ""
}
}