Änderungen von Dokument 08 Schnittstelle ONYX Reporter
Zuletzt geändert von Carina Enke am 13.02.2024
Zusammenfassung
-
Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
-
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -60,9 +60,7 @@ 60 60 |((( 61 61 getResultValues 62 62 )))|((( 63 -Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: 64 - 65 -Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste. 63 +Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste. 66 66 ))) 67 67 |(% colspan="1" %)(% colspan="1" %) 68 68 ((( ... ... @@ -74,7 +74,8 @@ 74 74 75 75 == Anmeldung des LMS == 76 76 77 -{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite") 75 +{{code title="Anmeldung des LMS" language="xml"}} 76 +@WebMethod(operationName = „armSite") 78 78 public String armSite( 79 79 @WebParam(name = „version") final Integer version, 80 80 @WebParam(name = „userId") final String userId, ... ... @@ -83,53 +83,286 @@ 83 83 @WebParam(name = „optionalUserLastName") final String userLastName, 84 84 @WebParam(name = „optionalUserFirstName") final String userFirstName, 85 85 @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 86 -}{{/code}}Parameter armSite 85 +} 86 +{{/code}} 87 87 88 +=== Parameter armSite === 89 + 88 88 |((( 89 - 91 +version 90 90 )))|((( 91 - 93 +Angefragte Version: 1 92 92 ))) 93 93 |((( 94 - 96 +userId 95 95 )))|((( 96 - 98 +UserId des anfragenden Reporter-Benutzers 97 97 ))) 98 98 |((( 99 - 101 +optionalRole 100 100 )))|((( 101 - 103 +Optional. Rolle des Benutzers. 0 = Student, 1= Tutor 102 102 ))) 103 103 |((( 104 - 106 +secretToShare 105 105 )))|((( 106 - 108 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 107 107 ))) 108 108 |((( 109 - 111 +optionalUserLastName 110 110 )))|((( 113 +Optional. Nachname des Benutzers. 114 +))) 115 +|(% colspan="1" %)(% colspan="1" %) 116 +((( 117 +optionalUserFirstName 118 +)))|(% colspan="1" %)(% colspan="1" %) 119 +((( 120 +Optional. Vorname des Benutzers. 121 +))) 122 +|(% colspan="1" %)(% colspan="1" %) 123 +((( 124 +additionalParams 125 +)))|(% colspan="1" %)(% colspan="1" %) 126 +((( 127 +Reserved for future use. 128 +))) 129 + 130 +=== ReturnValue armSite === 131 + 132 +|((( 133 +String 134 +)))|((( 135 +Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen. 136 +))) 137 + 138 +== Initialisierung durch LMS == 139 + 140 +{{code title="Initialisierung durch LMS" language="xml"}} 141 +@WebMethod(operationName = „initiateSite") 142 +public String initiateSite( 143 +@WebParam(name = „version") final Integer version, 144 +@WebParam(name = „sessionId") final String sessionId, 145 +@WebParam(name = „secretToShare") final String secretToShare, 146 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students, 147 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage, 148 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 149 +} 150 +{{/code}} 151 + 152 +=== Parameter initiateSite === 153 + 154 +|((( 155 +version 156 +)))|((( 157 +Angefragte Version: 1 158 +))) 159 +|(% colspan="1" %)(% colspan="1" %) 160 +((( 161 +sessionId 162 +)))|(% colspan="1" %)(% colspan="1" %) 163 +((( 164 +SessionId, wie von armSite zurück geliefert. 165 +))) 166 +|((( 167 +secretToShare 168 +)))|((( 169 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 170 +))) 171 +|((( 172 +students 173 +)))|((( 174 +Liste der Studenten mit ihren Resultaten. Siehe unten. 175 +))) 176 +|((( 177 +optionalContentPackage 178 +)))|((( 179 +Optional. Content Package (gezippt) als Byte-Array. 180 +))) 181 +|((( 182 +additionalParams 183 +)))|((( 184 +Reserved for future use. 185 +))) 186 + 187 +=== ReturnValue initiateSite === 188 + 189 +|((( 190 +String 191 +)))|((( 192 +Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern: 193 + 194 +* sid: Session ID, wie von armSite zurück gegeben 195 +* uid: Student ID, wie in initiateSite beim Reporter angemeldet 196 +))) 197 + 198 +{{code language="xml"}} 199 +public class ResultsForStudent { 200 + private String studentId = „"; 201 + private String firstname = „"; 202 + private String lastname = „"; 203 + private String groupname = „"; 204 + private String tutorname = „"; 205 + private File contentFile = null; 206 + private byte[] resultsFile = null; 207 +} 208 +{{/code}} 209 + 210 +== Abmeldung durch LMS == 211 + 212 +Abfrage von Lernerresultaten durch LMS 213 + 111 111 215 + 216 +|((( 217 +version 218 +)))|((( 219 +Angefragte Version: 1 112 112 ))) 221 +|(% colspan="1" %)(% colspan="1" %) 222 +((( 223 +sessionId 224 +)))|(% colspan="1" %)(% colspan="1" %) 225 +((( 226 +SessionId, wie von armSite zurück geliefert. 227 +))) 228 +|((( 229 +secretToShare 230 +)))|((( 231 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 232 +))) 233 +|((( 234 +additionalParams 235 +)))|((( 236 +Reserved for future use. 237 +))) 113 113 114 -= Überschrift2=239 +=== ReturnValue disarmSite === 115 115 116 -Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris. 241 +|((( 242 +Boolean 243 +)))|((( 244 +True bei Erfolg, sonst false. 245 +))) 246 + 247 +== Abfrage von Lernerresultaten durch LMS == 248 + 249 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}} 250 + @WebMethod(operationName = „getResultValues") 251 +public HashMapWrapper getResultValues( 252 + @WebParam(name = „version") final Integer version, 253 + @WebParam(name = „sessionId") final String sessionId, 254 + @WebParam(name = „secretToShare") final String secretToShare, 255 + @WebParam(name = „requestedValues") final HashMap<String, String> 256 + requestedValues, 257 + @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 258 +} 259 +{{/code}} 260 + 261 +=== Parameter getResultValues === 262 + 263 +|((( 264 +version 265 +)))|((( 266 +Angefragte Version: 1 267 +))) 268 +|(% colspan="1" %)(% colspan="1" %) 269 +((( 270 +sessionId 271 +)))|(% colspan="1" %)(% colspan="1" %) 272 +((( 273 +SessionId, wie von armSite zurück geliefert. 274 +))) 275 +|((( 276 +secretToShare 277 +)))|((( 278 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 279 +))) 280 +|((( 281 +requestedValues 282 +)))|((( 283 +Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück. 284 +))) 285 +|((( 286 +additionalParams 287 +)))|((( 288 +Reserved for future use. 289 +))) 290 + 291 +=== ReturnValue getResultValues === 292 + 293 +|((( 294 +HashMap<String, String> 295 +)))|((( 296 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 297 +))) 298 + 299 +== Abfrage von Ergebnisvariablen durch LMS == 300 + 301 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}} 302 + @WebMethod(operationName = „getResultVariables") 303 +public HashMapWrapper getResultVariables( 304 +@WebParam(name = „version") final Integer version, 305 +@WebParam(name = „contentPackage") final byte[] contentPackage, 306 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 307 +} 308 +{{/code}} 309 + 310 +=== Parameter getResultVariables === 311 + 312 +|((( 313 +version 314 +)))|((( 315 +Angefragte Version: 1 316 +))) 317 +|((( 318 +contentPackage 319 +)))|((( 320 +Content Package (gezippt) als Byte-Array. 321 +))) 322 +|((( 323 +additionalParams 324 +)))|((( 325 +Reserved for future use. 326 +))) 327 + 328 +=== ReturnValue getResultVariables === 329 + 330 +|((( 331 +HashMap<String, String> 332 +)))|((( 333 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 334 +))) 335 + 336 +== Wrapper == 337 + 338 +Da die Übertragung von Maps und Listen über JAX-WS Probleme macht (clientseitig gefüllte Listen werden leer über den WS versandt und kommen daher auch leer serverseitig an), müssen diese gewrappt werden. 339 + 340 +=== Wrapper für die HashMap<String, String> === 341 + 342 +HashMapWrapper.java: 343 + 344 +[[image:attach:HashMapWrapperjava.png]] 345 + 346 +[[image:attach:HashMapWrapperjava2.png]] 347 + 348 +=== Wrapper für die ArrayList<ResultsForStudent> === 349 + 350 +ResultsForStudentsWrapper.java: 351 + 352 +[[image:attach:ResultsForStudentsWrapperjava.png]] 117 117 {{/layout-cell}} 118 118 {{/layout-section}} 119 119 120 120 {{layout-section ac:type="two_right_sidebar"}} 121 121 {{layout-cell}} 122 -====== untergeordnete Seiten: ====== 123 - 124 - 125 - 126 -{{children all="true"/}} 358 + 127 127 {{/layout-cell}} 128 128 129 129 {{layout-cell}} 130 130 ====== relevante Links: ====== 131 131 132 -* [[ lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]364 +* [[doc:Schnittstelle ONYX WebPlayer]] 133 133 {{/layout-cell}} 134 134 {{/layout-section}} 135 135 {{/layout}}
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -3342 3921 +3342787 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342 392/Schnittstelle ONYX Reporter1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342787/Schnittstelle ONYX Reporter