forked from adaptlearning/adapt-contrib-spoor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
properties.schema
195 lines (195 loc) · 8.77 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
{
"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",
"properties":{
"_isEnabled": {
"type":"boolean",
"required":true,
"default": "true",
"title":"Is Enabled",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, the plugin will try to find and track to a SCORM conformant LMS. Set to false to switch off SCORM tracking."
},
"_tracking": {
"type":"object",
"required":false,
"title": "Tracking",
"properties":{
"_requireCourseCompleted": {
"type":"boolean",
"required":false,
"default": "true",
"title":"Course completion required",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, the plugin will require that the user must complete all the components in the course before the course can be marked as finished in the LMS."
},
"_requireAssessmentPassed": {
"type":"boolean",
"required":false,
"default": "false",
"title":"Assessment pass required",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, the plugin will require that the user must pass the course assessment before the course can be marked as finished in the LMS."
},
"_shouldSubmitScore": {
"type":"boolean",
"required":false,
"default": "false",
"title":"Submit score",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, the score attained in any assessment will be reported back to the LMS (regardless of whether the user passes or fails the assessment)."
},
"_shouldStoreResponses": {
"type":"boolean",
"required":false,
"default": "false",
"title":"Store responses",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, the user's question responses will be saved to the LMS."
}
}
},
"_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."
}
}
},
"_advancedSettings": {
"type":"object",
"required":false,
"title": "Advanced Settings",
"properties":{
"_showDebugWindow": {
"type":"boolean",
"required":false,
"default": "false",
"title":"SCORM debug window",
"inputType": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "If set to true, 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": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "Whether a 'commit' call should be made automatically every time the lesson_status is changed or not."
},
"_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": {"type": "Boolean", "options": [true, false]},
"validators": [],
"help": "Set this to 'true' to stop this plugin from displaying error messages when tracking problems occur."
},
"_commitOnVisibilityChangeHidden": {
"type": "boolean",
"default": true,
"title": "Commit on visibility change hidden",
"inputType": { "type": "Boolean", "options": [ true, false ] },
"validators": [],
"help": "Whether a 'commit' call should be made whenever the course becomes hidden."
}
}
}
}
}
}
},
"course": {
"type":"object"
},
"contentobject": {
"type":"object"
},
"article": {
"type":"object"
},
"block": {
"type":"object"
},
"component": {
"type":"object"
}
}
}
}
}