Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 377.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 404.1
bearbeitet von Carina Enke
am 26.11.2025
Änderungskommentar: Migrated property [stableId] from class [Confluence.Code.ConfluencePageClass]

Zusammenfassung

Details

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