-
Notifications
You must be signed in to change notification settings - Fork 42
/
properties.schema
392 lines (392 loc) · 18.1 KB
/
properties.schema
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"required": false,
"properties": {
"pluginLocations": {
"type": "object",
"required": true,
"properties": {
"config": {
"type": "object",
"properties": {
"_spoor": {
"type": "object",
"required": false,
"legend": "Spoor (SCORM)",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": true,
"title": "Is Enabled",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the plugin will try to find and track to a SCORM conformant LMS. Uncheck to switch off SCORM tracking."
},
"_tracking": {
"type": "object",
"required": false,
"title": "Tracking",
"properties": {
"_shouldStoreResponses": {
"type": "boolean",
"required": false,
"default": true,
"title": "Store question state",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the user's responses to questions will be saved and restored in each session. Note: this setting should be enabled in the majority of cases."
},
"_shouldStoreAttempts": {
"type": "boolean",
"required": false,
"default": false,
"title": "Store question attempt states",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a history of the user's responses to questions will be saved and restored in each session. Note: this setting should be disabled in the majority of cases."
},
"_shouldRecordInteractions": {
"type": "boolean",
"required": false,
"default": true,
"title": "Record interactions",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the course will record the user's responses to questions to the cmi.interactions SCORM data fields."
},
"_shouldRecordObjectives": {
"type": "boolean",
"required": false,
"default": true,
"title": "Record objectives",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the course will be able to record the status and scores of the course objectives to the cmi.objectives SCORM data fields."
},
"_shouldCompress": {
"type": "boolean",
"required": false,
"default": false,
"title": "Should compress data",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the data stored at the lms will be further compressed."
}
}
},
"_reporting": {
"type": "object",
"required": true,
"title": "Reporting",
"properties": {
"_onTrackingCriteriaMet": {
"type":"string",
"required":true,
"default": "completed",
"title":"Tracking success status",
"enum": ["completed", "passed", "failed", "incomplete"],
"inputType": {
"type": "Select",
"options": ["completed", "passed", "failed", "incomplete"]
},
"validators": [],
"help": "What status to report back to the LMS when the tracking criteria are met."
},
"_onAssessmentFailure": {
"type": "string",
"required": false,
"default": "incomplete",
"title": "Assessment failure status",
"enum": ["completed", "failed", "incomplete"],
"inputType": {
"type": "Select",
"options": ["completed", "failed", "incomplete"]
},
"validators": [],
"help": "What status to report back to the LMS when the assessment is failed."
},
"_resetStatusOnLanguageChange": {
"type": "boolean",
"required": false,
"default": false,
"title": "Reset status when language changed?",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the the course status will be reset to 'incomplete' when the user changes the course language."
}
}
},
"_advancedSettings": {
"type": "object",
"required": false,
"title": "Advanced Settings",
"properties": {
"_scormVersion": {
"type": "string",
"required": false,
"default": "1.2",
"title": "SCORM version",
"enum": ["1.2", "2004"],
"inputType": {
"type": "Select",
"options": ["1.2", "2004"]
},
"validators": [],
"help": "What SCORM standard to use - SCORM 1.2 or SCORM 2004 4th Edition."
},
"_showDebugWindow": {
"type": "boolean",
"required": false,
"default": false,
"title": "SCORM debug window",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a popup window will be shown on course launch that gives detailed information about what SCORM calls are being made. This can be very useful for debugging SCORM issues. Note that this popup window will appear automatically if the SCORM code encounters an error, even if this is set to false."
},
"_commitOnStatusChange": {
"type": "boolean",
"required": false,
"default": true,
"title": "Commit data on status change",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a 'commit' call will be made any time the lesson_status is changed."
},
"_commitOnAnyChange": {
"type": "boolean",
"required": false,
"default": false,
"title": "Commit data on any change",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a 'commit' (save all data) call will be made any time a value is changed. Note that enabling this setting may have a detrimental impact on the server and should only be used if absolutely necessary and only after careful load testing. Consider trying a lower value for 'Frequency of automatic commits' before changing this setting."
},
"_timedCommitFrequency": {
"type": "number",
"required": false,
"default": "10",
"title": "Frequency (mins) of automatic commits",
"inputType": "Number",
"validators": ["number"],
"help": "The frequency (in minutes) at which a 'commit' call should be made automatically. Set to 0 to disable automatic commits altogether."
},
"_maxCommitRetries": {
"type": "number",
"required": false,
"default": "5",
"title": "Maximum number of commit retries",
"inputType": "Number",
"validators": ["number"],
"help": "If a 'commit' call fails, this setting controls how many times it should be retried before giving up and throwing an error."
},
"_commitRetryDelay": {
"type": "number",
"required": false,
"default": "2000",
"title": "Commit retry delay",
"inputType": "Number",
"validators": ["number"],
"help": "How much of a delay (in milliseconds) to leave between commit retries."
},
"_suppressErrors": {
"type": "boolean",
"required": false,
"default": false,
"title": "Supress LMS errors",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, error messages will not be displayed when SCORM tracking problems occur."
},
"_commitOnVisibilityChangeHidden": {
"type": "boolean",
"default": true,
"title": "Commit on visibility change hidden",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a 'commit' call will be made whenever the course window is hidden/minimised. Requires a browser that supports the 'visibilitychange' event."
},
"_manifestIdentifier": {
"type": "string",
"required": true,
"default": "adapt_manifest",
"title": "Manifest identifier",
"inputType": "Text",
"validators": ["required"],
"help": "Sets the 'identifier' attribute in the imsmanifest.xml"
},
"_exitStateIfIncomplete": {
"type": "string",
"required": false,
"default": "auto",
"title": "Exit state if incomplete",
"enum": ["auto", "suspend", "normal", ""],
"inputType": {
"type": "Select",
"options": [
"auto",
"suspend",
"normal",
{
"val": "",
"label": "'' (empty string)"
}
]
},
"validators": [],
"help": "What exit status to use if the course is incomplete."
},
"_exitStateIfComplete": {
"type": "string",
"required": false,
"default": "auto",
"title": "Exit state if complete",
"enum": ["auto", "suspend", "normal", ""],
"inputType": {
"type": "Select",
"options": [
"auto",
"suspend",
"normal",
{
"val": "",
"label": "'' (empty string)"
}
]
},
"validators": [],
"help": "What exit status to use if the course is complete."
},
"_setCompletedWhenFailed": {
"type": "boolean",
"required": false,
"default": true,
"title": "Completed when failed",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, `cmi.completion_status` will be set to \"completed\" if the assessment is \"failed\". Only valid for SCORM 2004, where the logic for completion and success is separate."
},
"_maxCharLimitOverride": {
"type": "number",
"required": false,
"default": "0",
"title": "Override value for maximum character limit on fill-in type answers",
"inputType": "Number",
"validators": ["number"],
"help": "If your LMS allows it, you may set a value to override the default character limit for fill-in answers (250 for SCORM2004, 255 for SCORM1.2)."
},
"_connectionTest": {
"type": "object",
"required": true,
"title": "Connection Test",
"properties": {
"_isEnabled": {
"type": "boolean",
"default": true,
"title": "Is Enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Determines whether the connection should be tested."
},
"_testOnSetValue": {
"type": "boolean",
"default": true,
"title": "Test on set value",
"inputType": "Checkbox",
"validators": [],
"help": "Determines whether the connection should be tested for each call to set data on the LMS."
},
"_silentRetryLimit": {
"type": "number",
"required": false,
"default": "2",
"title": "Silent Retry Limit",
"inputType": "Number",
"validators": ["number"],
"help": "The limit for silent retry attempts to establish a connection before raising an error."
},
"_silentRetryDelay": {
"type": "number",
"required": false,
"default": "1000",
"title": "Silent Retry Delay",
"inputType": "Number",
"validators": ["number"],
"help": "The interval in milliseconds between silent connection retries."
}
}
},
"_uniqueInteractionIds": {
"type": "boolean",
"required": false,
"default": false,
"title": "Unique Interaction Ids",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, `cmi.interactions.n.id` will be prepended with an index, making the id unique. Some LMSes require unique ids, this will inhibit the grouping of interactions by id on the server-side."
}
}
},
"_showCookieLmsResetButton": {
"type": "boolean",
"required": false,
"default": false,
"title": "Show reset button (scorm_test_harness.html only)",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a reset button will be available to relaunch the course and optionally clear tracking data (scorm_test_harness.html only)."
},
"_shouldPersistCookieLMSData": {
"type": "boolean",
"required": false,
"default": true,
"title": "Persist cookie data (scorm_test_harness.html only)",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the course data will persist over browser sessions (scorm_test_harness.html only)."
}
}
}
}
},
"course": {
"type":"object",
"properties": {
"_spoor": {
"type": "object",
"required": false,
"legend": "Spoor (SCORM)",
"properties": {
"_messages": {
"type": "object",
"default": {},
"title": "Error messages",
"inputType": {
"type": "CodeEditor",
"mode": "json"
},
"validators": [],
"help": "Optional object that can be used to amend/translate the error messages shown by the spoor extension"
}
}
}
}
},
"contentobject": {
"type":"object"
},
"article": {
"type":"object"
},
"block": {
"type":"object"
},
"component": {
"type":"object"
}
}
}
}
}