Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 402.2
bearbeitet von Carina Enke
am 16.11.2025
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 377.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -08 Schnittstelle ONYX Reporter
1 +Schnittstelle ONYX Reporter
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.carina
1 +XWiki.tleu
Inhalt
... ... @@ -1,30 +1,47 @@
1 -{{section}}
2 -{{column width="60%"}}
1 +{{layout}}
2 +{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-cell}}
4 +====== Inhalt: ======
3 3  
4 -
5 -{{/column}}
6 6  
7 -{{column width="30%"}}
8 -{{panel title="Inhalt"}}
9 -{{toc start="2"/}}
10 -{{/panel}}
11 11  
8 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
9 +{{/layout-cell}}
12 12  
11 +{{layout-cell}}
12 +|=(% colspan="1" %)(% colspan="1" %)
13 +(((
14 +Programmversion
15 +)))|(% colspan="1" %)(% colspan="1" %)
16 +(((
17 +
18 +)))
19 +|=(((
20 +Status
21 +)))|(((
22 +(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
23 +)))
24 +|=(((
25 +Aufgaben
26 +)))|(((
27 +
13 13  
14 -{{panel title="Weiterführende Inhalte"}}
15 -* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
29 +
30 +)))
31 +|=(((
32 +JIRA
33 +)))|(((
34 +
35 +)))
36 +{{/layout-cell}}
37 +{{/layout-section}}
16 16  
17 -{{/panel}}
18 -
19 -{{/column}}
20 -{{/section}}
21 -
22 -
39 +{{layout-section ac:type="single"}}
40 +{{layout-cell}}
23 23  == Allgemeines ==
24 24  
25 25  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
26 26  
27 -(% class="wrapped" %)
28 28  |(((
29 29  armSite
30 30  )))|(((
... ... @@ -43,7 +43,9 @@
43 43  |(((
44 44  getResultValues
45 45  )))|(((
46 -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.
47 47  )))
48 48  |(% colspan="1" %)(% colspan="1" %)
49 49  (((
... ... @@ -55,7 +55,7 @@
55 55  
56 56  == Anmeldung des LMS ==
57 57  
58 -{{code language="xml" title="Anmeldung des LMS"}}
77 +{{code title="Anmeldung des LMS" language="xml"}}
59 59  @WebMethod(operationName = „armSite")
60 60  public String armSite(
61 61  @WebParam(name = „version") final Integer version,
... ... @@ -70,7 +70,6 @@
70 70  
71 71  === Parameter armSite ===
72 72  
73 -(% class="wrapped" %)
74 74  |(((
75 75  version
76 76  )))|(((
... ... @@ -113,7 +113,6 @@
113 113  
114 114  === ReturnValue armSite ===
115 115  
116 -(% class="wrapped" %)
117 117  |(((
118 118  String
119 119  )))|(((
... ... @@ -122,7 +122,7 @@
122 122  
123 123  == Initialisierung durch LMS ==
124 124  
125 -{{code language="xml" title="Initialisierung durch LMS"}}
142 +{{code title="Initialisierung durch LMS" language="xml"}}
126 126  @WebMethod(operationName = „initiateSite")
127 127  public String initiateSite(
128 128  @WebParam(name = „version") final Integer version,
... ... @@ -136,7 +136,6 @@
136 136  
137 137  === Parameter initiateSite ===
138 138  
139 -(% class="wrapped" %)
140 140  |(((
141 141  version
142 142  )))|(((
... ... @@ -172,7 +172,6 @@
172 172  
173 173  === ReturnValue initiateSite ===
174 174  
175 -(% class="wrapped" %)
176 176  |(((
177 177  String
178 178  )))|(((
... ... @@ -194,158 +194,33 @@
194 194  }
195 195  {{/code}}
196 196  
197 -== Abmeldung durch LMS ==
198 -
199 -
200 -{{code}}
201 -@WebMethod(operationName = „disarmSite")
202 -public Boolean disarmSite(
212 +{{code title="Initialisierung durch LMS" language="xml"}}
213 +@WebMethod(operationName = „initiateSite")
214 +public String initiateSite(
203 203  @WebParam(name = „version") final Integer version,
204 204  @WebParam(name = „sessionId") final String sessionId,
205 205  @WebParam(name = „secretToShare") final String secretToShare,
218 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
219 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
206 206  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
207 207  }
208 208  {{/code}}
223 +{{/layout-cell}}
224 +{{/layout-section}}
209 209  
226 +{{layout-section ac:type="two_right_sidebar"}}
227 +{{layout-cell}}
228 +====== untergeordnete Seiten: ======
210 210  
211 -=== Parameter disarmSite ===
212 212  
213 -(% class="wrapped" %)
214 -|(((
215 -version
216 -)))|(((
217 -Angefragte Version: 1
218 -)))
219 -|(% colspan="1" %)(% colspan="1" %)
220 -(((
221 -sessionId
222 -)))|(% colspan="1" %)(% colspan="1" %)
223 -(((
224 -SessionId, wie von armSite zurück geliefert.
225 -)))
226 -|(((
227 -secretToShare
228 -)))|(((
229 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
230 -)))
231 -|(((
232 -additionalParams
233 -)))|(((
234 -Reserved for future use.
235 -)))
236 236  
237 -=== ReturnValue disarmSite ===
232 +{{children all="true"/}}
233 +{{/layout-cell}}
238 238  
239 -|(((
240 -Boolean
241 -)))|(((
242 -True bei Erfolg, sonst false.
243 -)))
235 +{{layout-cell}}
236 +====== relevante Links: ======
244 244  
245 -== Abfrage von Lernerresultaten durch LMS ==
246 -
247 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
248 - @WebMethod(operationName = „getResultValues")
249 -public HashMapWrapper getResultValues(
250 - @WebParam(name = „version") final Integer version,
251 - @WebParam(name = „sessionId") final String sessionId,
252 - @WebParam(name = „secretToShare") final String secretToShare,
253 - @WebParam(name = „requestedValues") final HashMap<String, String>
254 - requestedValues,
255 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
256 -}
257 -{{/code}}
258 -
259 -=== Parameter getResultValues ===
260 -
261 -|(((
262 -version
263 -)))|(((
264 -Angefragte Version: 1
265 -)))
266 -|(% colspan="1" %)(% colspan="1" %)
267 -(((
268 -sessionId
269 -)))|(% colspan="1" %)(% colspan="1" %)
270 -(((
271 -SessionId, wie von armSite zurück geliefert.
272 -)))
273 -|(((
274 -secretToShare
275 -)))|(((
276 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
277 -)))
278 -|(((
279 -requestedValues
280 -)))|(((
281 -Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
282 -)))
283 -|(((
284 -additionalParams
285 -)))|(((
286 -Reserved for future use.
287 -)))
288 -
289 -=== ReturnValue getResultValues ===
290 -
291 -|(((
292 -HashMap<String, String>
293 -)))|(((
294 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
295 -)))
296 -
297 -== Abfrage von Ergebnisvariablen durch LMS ==
298 -
299 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
300 - @WebMethod(operationName = „getResultVariables")
301 -public HashMapWrapper getResultVariables(
302 -@WebParam(name = „version") final Integer version,
303 -@WebParam(name = „contentPackage") final byte[] contentPackage,
304 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
305 -}
306 -{{/code}}
307 -
308 -=== Parameter getResultVariables ===
309 -
310 -|(((
311 -version
312 -)))|(((
313 -Angefragte Version: 1
314 -)))
315 -|(((
316 -contentPackage
317 -)))|(((
318 -Content Package (gezippt) als Byte-Array.
319 -)))
320 -|(((
321 -additionalParams
322 -)))|(((
323 -Reserved for future use.
324 -)))
325 -
326 -=== ReturnValue getResultVariables ===
327 -
328 -|(((
329 -HashMap<String, String>
330 -)))|(((
331 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
332 -)))
333 -
334 -== Wrapper ==
335 -
336 -Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
337 -
338 -=== Wrapper für die HashMap<String, String> ===
339 -
340 -HashMapWrapper.java:
341 -
342 -[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
343 -
344 -[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
345 -
346 -=== Wrapper für die ArrayList<ResultsForStudent> ===
347 -
348 -ResultsForStudentsWrapper.java:
349 -
350 -[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
351 -
238 +* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
239 +{{/layout-cell}}
240 +{{/layout-section}}
241 +{{/layout}}
HashMapWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342390
1 +3342394
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342394/Schnittstelle ONYX Reporter