Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 402.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 374.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,17 +1,38 @@
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -
4 +====== Inhalt: ======
5 +
6 +
7 +
8 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
5 5  {{/layout-cell}}
6 6  
7 7  {{layout-cell}}
8 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
9 -{{toc start="2"/}}
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 +
10 10  
11 - **Weitere Informationen:**
12 -
13 -* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
14 -{{/panel}}
29 +
30 +)))
31 +|=(((
32 +JIRA
33 +)))|(((
34 +
35 +)))
15 15  {{/layout-cell}}
16 16  {{/layout-section}}
17 17  
... ... @@ -21,7 +21,6 @@
21 21  
22 22  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
23 23  
24 -(% class="wrapped" %)
25 25  |(((
26 26  armSite
27 27  )))|(((
... ... @@ -40,7 +40,9 @@
40 40  |(((
41 41  getResultValues
42 42  )))|(((
43 -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.
44 44  )))
45 45  |(% colspan="1" %)(% colspan="1" %)
46 46  (((
... ... @@ -52,8 +52,7 @@
52 52  
53 53  == Anmeldung des LMS ==
54 54  
55 -{{code language="xml" title="Anmeldung des LMS"}}
56 -@WebMethod(operationName = „armSite")
77 +{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite")
57 57  public String armSite(
58 58  @WebParam(name = „version") final Integer version,
59 59  @WebParam(name = „userId") final String userId,
... ... @@ -62,294 +62,53 @@
62 62  @WebParam(name = „optionalUserLastName") final String userLastName,
63 63  @WebParam(name = „optionalUserFirstName") final String userFirstName,
64 64  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
65 -}
66 -{{/code}}
86 +}{{/code}}Parameter armSite
67 67  
68 -=== Parameter armSite ===
69 -
70 -(% class="wrapped" %)
71 71  |(((
72 -version
89 +
73 73  )))|(((
74 -Angefragte Version: 1
91 +
75 75  )))
76 76  |(((
77 -userId
94 +
78 78  )))|(((
79 -UserId des anfragenden Reporter-Benutzers
96 +
80 80  )))
81 81  |(((
82 -optionalRole
99 +
83 83  )))|(((
84 -Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
101 +
85 85  )))
86 86  |(((
87 -secretToShare
104 +
88 88  )))|(((
89 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
106 +
90 90  )))
91 91  |(((
92 -optionalUserLastName
109 +
93 93  )))|(((
94 -Optional. Nachname des Benutzers.
111 +
95 95  )))
96 -|(% colspan="1" %)(% colspan="1" %)
97 -(((
98 -optionalUserFirstName
99 -)))|(% colspan="1" %)(% colspan="1" %)
100 -(((
101 -Optional. Vorname des Benutzers.
102 -)))
103 -|(% colspan="1" %)(% colspan="1" %)
104 -(((
105 -additionalParams
106 -)))|(% colspan="1" %)(% colspan="1" %)
107 -(((
108 -Reserved for future use.
109 -)))
110 110  
111 -=== ReturnValue armSite ===
114 += Überschrift2 =
112 112  
113 -(% class="wrapped" %)
114 -|(((
115 -String
116 -)))|(((
117 -Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
118 -)))
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.
117 +{{/layout-cell}}
118 +{{/layout-section}}
119 119  
120 -== Initialisierung durch LMS ==
120 +{{layout-section ac:type="two_right_sidebar"}}
121 +{{layout-cell}}
122 +====== untergeordnete Seiten: ======
121 121  
122 -{{code language="xml" title="Initialisierung durch LMS"}}
123 -@WebMethod(operationName = „initiateSite")
124 -public String initiateSite(
125 -@WebParam(name = „version") final Integer version,
126 -@WebParam(name = „sessionId") final String sessionId,
127 -@WebParam(name = „secretToShare") final String secretToShare,
128 -@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
129 -@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
130 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
131 -}
132 -{{/code}}
133 133  
134 -=== Parameter initiateSite ===
135 135  
136 -(% class="wrapped" %)
137 -|(((
138 -version
139 -)))|(((
140 -Angefragte Version: 1
141 -)))
142 -|(% colspan="1" %)(% colspan="1" %)
143 -(((
144 -sessionId
145 -)))|(% colspan="1" %)(% colspan="1" %)
146 -(((
147 -SessionId, wie von armSite zurück geliefert.
148 -)))
149 -|(((
150 -secretToShare
151 -)))|(((
152 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
153 -)))
154 -|(((
155 -students
156 -)))|(((
157 -Liste der Studenten mit ihren Resultaten. Siehe unten.
158 -)))
159 -|(((
160 -optionalContentPackage
161 -)))|(((
162 -Optional. Content Package (gezippt) als Byte-Array.
163 -)))
164 -|(((
165 -additionalParams
166 -)))|(((
167 -Reserved for future use.
168 -)))
126 +{{children all="true"/}}
127 +{{/layout-cell}}
169 169  
170 -=== ReturnValue initiateSite ===
129 +{{layout-cell}}
130 +====== relevante Links: ======
171 171  
172 -(% class="wrapped" %)
173 -|(((
174 -String
175 -)))|(((
176 -Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
177 -
178 -* sid: Session ID, wie von armSite zurück gegeben
179 -* uid: Student ID, wie in initiateSite beim Reporter angemeldet
180 -)))
181 -
182 -{{code language="xml"}}
183 -public class ResultsForStudent {
184 -   private String studentId = „";
185 -   private String firstname = „";
186 -   private String lastname = „";
187 -   private String groupname = „";
188 -   private String tutorname = „";
189 -   private File contentFile = null;
190 -   private byte[] resultsFile = null;
191 -}
192 -{{/code}}
193 -
194 -== Abmeldung durch LMS ==
195 -
196 -
197 -{{code}}
198 -@WebMethod(operationName = „disarmSite")
199 -public Boolean disarmSite(
200 -@WebParam(name = „version") final Integer version,
201 -@WebParam(name = „sessionId") final String sessionId,
202 -@WebParam(name = „secretToShare") final String secretToShare,
203 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
204 -}
205 -{{/code}}
206 -
207 -
208 -=== Parameter disarmSite ===
209 -
210 -(% class="wrapped" %)
211 -|(((
212 -version
213 -)))|(((
214 -Angefragte Version: 1
215 -)))
216 -|(% colspan="1" %)(% colspan="1" %)
217 -(((
218 -sessionId
219 -)))|(% colspan="1" %)(% colspan="1" %)
220 -(((
221 -SessionId, wie von armSite zurück geliefert.
222 -)))
223 -|(((
224 -secretToShare
225 -)))|(((
226 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
227 -)))
228 -|(((
229 -additionalParams
230 -)))|(((
231 -Reserved for future use.
232 -)))
233 -
234 -=== ReturnValue disarmSite ===
235 -
236 -(% class="wrapped" %)
237 -|(((
238 -Boolean
239 -)))|(((
240 -True bei Erfolg, sonst false.
241 -)))
242 -
243 -== Abfrage von Lernerresultaten durch LMS ==
244 -
245 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
246 - @WebMethod(operationName = „getResultValues")
247 -public HashMapWrapper getResultValues(
248 - @WebParam(name = „version") final Integer version,
249 - @WebParam(name = „sessionId") final String sessionId,
250 - @WebParam(name = „secretToShare") final String secretToShare,
251 - @WebParam(name = „requestedValues") final HashMap<String, String>
252 - requestedValues,
253 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
254 -}
255 -{{/code}}
256 -
257 -=== Parameter getResultValues ===
258 -
259 -(% class="wrapped" %)
260 -|(((
261 -version
262 -)))|(((
263 -Angefragte Version: 1
264 -)))
265 -|(% colspan="1" %)(% colspan="1" %)
266 -(((
267 -sessionId
268 -)))|(% colspan="1" %)(% colspan="1" %)
269 -(((
270 -SessionId, wie von armSite zurück geliefert.
271 -)))
272 -|(((
273 -secretToShare
274 -)))|(((
275 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
276 -)))
277 -|(((
278 -requestedValues
279 -)))|(((
280 -Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
281 -)))
282 -|(((
283 -additionalParams
284 -)))|(((
285 -Reserved for future use.
286 -)))
287 -
288 -=== ReturnValue getResultValues ===
289 -
290 -(% class="wrapped" %)
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 -(% class="wrapped" %)
311 -|(((
312 -version
313 -)))|(((
314 -Angefragte Version: 1
315 -)))
316 -|(((
317 -contentPackage
318 -)))|(((
319 -Content Package (gezippt) als Byte-Array.
320 -)))
321 -|(((
322 -additionalParams
323 -)))|(((
324 -Reserved for future use.
325 -)))
326 -
327 -=== ReturnValue getResultVariables ===
328 -
329 -(% class="wrapped" %)
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 machen kann, müssen diese gewrappt werden.
339 -
340 -=== Wrapper für die HashMap<String, String> ===
341 -
342 -HashMapWrapper.java:
343 -
344 -[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
345 -
346 -[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
347 -
348 -=== Wrapper für die ArrayList<ResultsForStudent> ===
349 -
350 -ResultsForStudentsWrapper.java:
351 -
352 -[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
132 +* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
353 353  {{/layout-cell}}
354 354  {{/layout-section}}
355 355  {{/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 +3342392
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/3342392/Schnittstelle ONYX Reporter