Änderungen von Dokument 08 Schnittstelle ONYX Reporter
Zuletzt geändert von Carina Enke am 13.02.2024
Zusammenfassung
-
Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
-
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Dokument-Autor
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. sandra_riediger1 +XWiki.tleu - Inhalt
-
... ... @@ -60,7 +60,9 @@ 60 60 |((( 61 61 getResultValues 62 62 )))|((( 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. 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. 64 64 ))) 65 65 |(% colspan="1" %)(% colspan="1" %) 66 66 ((( ... ... @@ -72,8 +72,7 @@ 72 72 73 73 == Anmeldung des LMS == 74 74 75 -{{code title="Anmeldung des LMS" language="xml"}} 76 -@WebMethod(operationName = „armSite") 77 +{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite") 77 77 public String armSite( 78 78 @WebParam(name = „version") final Integer version, 79 79 @WebParam(name = „userId") final String userId, ... ... @@ -82,298 +82,53 @@ 82 82 @WebParam(name = „optionalUserLastName") final String userLastName, 83 83 @WebParam(name = „optionalUserFirstName") final String userFirstName, 84 84 @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 85 -} 86 -{{/code}} 86 +}{{/code}}Parameter armSite 87 87 88 -=== Parameter armSite === 89 - 90 90 |((( 91 - version89 + 92 92 )))|((( 93 - AngefragteVersion: 191 + 94 94 ))) 95 95 |((( 96 - userId94 + 97 97 )))|((( 98 - UserIddes anfragenden Reporter-Benutzers96 + 99 99 ))) 100 100 |((( 101 - optionalRole99 + 102 102 )))|((( 103 - Optional.Rolle des Benutzers. 0 = Student, 1= Tutor101 + 104 104 ))) 105 105 |((( 106 - secretToShare104 + 107 107 )))|((( 108 - Eingeheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.106 + 109 109 ))) 110 110 |((( 111 -optionalUserLastName 112 -)))|((( 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 - 214 -{{code}} 215 -@WebMethod(operationName = „disarmSite") 216 -public Boolean disarmSite( 217 -@WebParam(name = „version") final Integer version, 218 -@WebParam(name = „sessionId") final String sessionId, 219 -@WebParam(name = „secretToShare") final String secretToShare, 220 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 221 -} 222 -{{/code}} 223 - 224 224 225 - 226 -=== Parameter disarmSite === 227 - 228 -|((( 229 -version 230 230 )))|((( 231 - AngefragteVersion: 1111 + 232 232 ))) 233 -|(% colspan="1" %)(% colspan="1" %) 234 -((( 235 -sessionId 236 -)))|(% colspan="1" %)(% colspan="1" %) 237 -((( 238 -SessionId, wie von armSite zurück geliefert. 239 -))) 240 -|((( 241 -secretToShare 242 -)))|((( 243 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 244 -))) 245 -|((( 246 -additionalParams 247 -)))|((( 248 -Reserved for future use. 249 -))) 250 250 251 -= ==ReturnValue disarmSite===114 += Überschrift2 = 252 252 253 -|((( 254 -Boolean 255 -)))|((( 256 -True bei Erfolg, sonst false. 257 -))) 258 - 259 -== Abfrage von Lernerresultaten durch LMS == 260 - 261 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}} 262 - @WebMethod(operationName = „getResultValues") 263 -public HashMapWrapper getResultValues( 264 - @WebParam(name = „version") final Integer version, 265 - @WebParam(name = „sessionId") final String sessionId, 266 - @WebParam(name = „secretToShare") final String secretToShare, 267 - @WebParam(name = „requestedValues") final HashMap<String, String> 268 - requestedValues, 269 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 270 -} 271 -{{/code}} 272 - 273 -=== Parameter getResultValues === 274 - 275 -|((( 276 -version 277 -)))|((( 278 -Angefragte Version: 1 279 -))) 280 -|(% colspan="1" %)(% colspan="1" %) 281 -((( 282 -sessionId 283 -)))|(% colspan="1" %)(% colspan="1" %) 284 -((( 285 -SessionId, wie von armSite zurück geliefert. 286 -))) 287 -|((( 288 -secretToShare 289 -)))|((( 290 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 291 -))) 292 -|((( 293 -requestedValues 294 -)))|((( 295 -Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück. 296 -))) 297 -|((( 298 -additionalParams 299 -)))|((( 300 -Reserved for future use. 301 -))) 302 - 303 -=== ReturnValue getResultValues === 304 - 305 -|((( 306 -HashMap<String, String> 307 -)))|((( 308 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 309 -))) 310 - 311 -== Abfrage von Ergebnisvariablen durch LMS == 312 - 313 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}} 314 - @WebMethod(operationName = „getResultVariables") 315 -public HashMapWrapper getResultVariables( 316 -@WebParam(name = „version") final Integer version, 317 -@WebParam(name = „contentPackage") final byte[] contentPackage, 318 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) { 319 -} 320 -{{/code}} 321 - 322 -=== Parameter getResultVariables === 323 - 324 -|((( 325 -version 326 -)))|((( 327 -Angefragte Version: 1 328 -))) 329 -|((( 330 -contentPackage 331 -)))|((( 332 -Content Package (gezippt) als Byte-Array. 333 -))) 334 -|((( 335 -additionalParams 336 -)))|((( 337 -Reserved for future use. 338 -))) 339 - 340 -=== ReturnValue getResultVariables === 341 - 342 -|((( 343 -HashMap<String, String> 344 -)))|((( 345 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 346 -))) 347 - 348 -== Wrapper == 349 - 350 -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. 351 - 352 -=== Wrapper für die HashMap<String, String> === 353 - 354 -HashMapWrapper.java: 355 - 356 -[[image:attach:HashMapWrapperjava.png]] 357 - 358 -[[image:attach:HashMapWrapperjava2.png]] 359 - 360 -=== Wrapper für die ArrayList<ResultsForStudent> === 361 - 362 -ResultsForStudentsWrapper.java: 363 - 364 -[[image:attach:ResultsForStudentsWrapperjava.png]] 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. 365 365 {{/layout-cell}} 366 366 {{/layout-section}} 367 367 368 368 {{layout-section ac:type="two_right_sidebar"}} 369 369 {{layout-cell}} 370 - 122 +====== untergeordnete Seiten: ====== 123 + 124 + 125 + 126 +{{children all="true"/}} 371 371 {{/layout-cell}} 372 372 373 373 {{layout-cell}} 374 374 ====== relevante Links: ====== 375 375 376 -* [[ doc:SchnittstelleONYX WebPlayer]]132 +* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]] 377 377 {{/layout-cell}} 378 378 {{/layout-section}} 379 379 {{/layout}}
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -3342 7891 +3342392 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342 789/Schnittstelle ONYX Reporter1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342392/Schnittstelle ONYX Reporter