Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 340.1
bearbeitet von Carina Enke
am 15.10.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.12.
Auf Version 401.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Schnittstelle ONYX Reporter
1 +10 Schnittstelle ONYX Reporter
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,28 +2,18 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
2 +{{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -
6 -
7 -(% class="removedPlaceholderWrapper" %)
8 -
9 -
10 -
4 +
11 11  {{/layout-cell}}
12 -{{/layout-section}}
13 13  
14 -{{layout-section ac:type="two_right_sidebar"}}
15 15  {{layout-cell}}
16 -====== Inhalt: ======
8 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
9 +{{toc start="2"/}}
17 17  
11 + **Weitere Informationen:**
18 18  
19 -
20 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
13 +* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
14 +{{/panel}}
21 21  {{/layout-cell}}
22 -
23 -{{layout-cell}}
24 -
25 -{{/layout-cell}}
26 26  {{/layout-section}}
27 27  
28 28  {{layout-section ac:type="single"}}
... ... @@ -31,6 +31,7 @@
31 31  
32 32  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
33 33  
24 +(% class="wrapped" %)
34 34  |(((
35 35  armSite
36 36  )))|(((
... ... @@ -76,6 +76,7 @@
76 76  
77 77  === Parameter armSite ===
78 78  
70 +(% class="wrapped" %)
79 79  |(((
80 80  version
81 81  )))|(((
... ... @@ -118,6 +118,7 @@
118 118  
119 119  === ReturnValue armSite ===
120 120  
113 +(% class="wrapped" %)
121 121  |(((
122 122  String
123 123  )))|(((
... ... @@ -140,6 +140,7 @@
140 140  
141 141  === Parameter initiateSite ===
142 142  
136 +(% class="wrapped" %)
143 143  |(((
144 144  version
145 145  )))|(((
... ... @@ -175,6 +175,7 @@
175 175  
176 176  === ReturnValue initiateSite ===
177 177  
172 +(% class="wrapped" %)
178 178  |(((
179 179  String
180 180  )))|(((
... ... @@ -198,7 +198,6 @@
198 198  
199 199  == Abmeldung durch LMS ==
200 200  
201 -
202 202  
203 203  {{code}}
204 204  @WebMethod(operationName = „disarmSite")
... ... @@ -210,10 +210,10 @@
210 210  }
211 211  {{/code}}
212 212  
213 -
214 214  
215 215  === Parameter disarmSite ===
216 216  
210 +(% class="wrapped" %)
217 217  |(((
218 218  version
219 219  )))|(((
... ... @@ -239,6 +239,7 @@
239 239  
240 240  === ReturnValue disarmSite ===
241 241  
236 +(% class="wrapped" %)
242 242  |(((
243 243  Boolean
244 244  )))|(((
... ... @@ -261,6 +261,7 @@
261 261  
262 262  === Parameter getResultValues ===
263 263  
259 +(% class="wrapped" %)
264 264  |(((
265 265  version
266 266  )))|(((
... ... @@ -291,6 +291,7 @@
291 291  
292 292  === ReturnValue getResultValues ===
293 293  
290 +(% class="wrapped" %)
294 294  |(((
295 295  HashMap<String, String>
296 296  )))|(((
... ... @@ -310,6 +310,7 @@
310 310  
311 311  === Parameter getResultVariables ===
312 312  
310 +(% class="wrapped" %)
313 313  |(((
314 314  version
315 315  )))|(((
... ... @@ -328,6 +328,7 @@
328 328  
329 329  === ReturnValue getResultVariables ===
330 330  
329 +(% class="wrapped" %)
331 331  |(((
332 332  HashMap<String, String>
333 333  )))|(((
... ... @@ -342,377 +342,15 @@
342 342  
343 343  HashMapWrapper.java:
344 344  
345 -[[image:attach:HashMapWrapperjava.png]]
344 +[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
346 346  
347 -[[image:attach:HashMapWrapperjava2.png]]
346 +[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
348 348  
349 349  === Wrapper für die ArrayList<ResultsForStudent> ===
350 350  
351 351  ResultsForStudentsWrapper.java:
352 352  
353 -[[image:attach:ResultsForStudentsWrapperjava.png]]
352 +[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
354 354  {{/layout-cell}}
355 355  {{/layout-section}}
356 -
357 -{{layout-section ac:type="two_right_sidebar"}}
358 -{{layout-cell}}
359 -
360 -{{/layout-cell}}
361 -
362 -{{layout-cell}}
363 -====== relevante Links: ======
364 -
365 -* [[doc:ONYX Player Interface]]
366 -{{/layout-cell}}
367 -{{/layout-section}}
368 368  {{/layout}}
369 -{{/sv-translation}}
370 -
371 -{{sv-translation language="en"}}
372 -{{layout}}
373 -{{layout-section ac:type="two_equal"}}
374 -{{layout-cell}}
375 -====== Content: ======
376 -
377 -
378 -
379 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
380 -{{/layout-cell}}
381 -
382 -{{layout-cell}}
383 -
384 -{{/layout-cell}}
385 -{{/layout-section}}
386 -
387 -{{layout-section ac:type="single"}}
388 -{{layout-cell}}
389 -== General information ==
390 -
391 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
392 -
393 -|(((
394 -armSite
395 -)))|(((
396 -Registration of sequence requests at the ONYX Reporter
397 -)))
398 -|(((
399 -initiateSite
400 -)))|(((
401 -Initiates the Reporter session (transmission of the CP).
402 -)))
403 -|(((
404 -disarmSite
405 -)))|(((
406 -Release of all Reporter resources for this session.
407 -)))
408 -|(((
409 -getResultValues
410 -)))|(((
411 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
412 -)))
413 -|(% colspan="1" %)(% colspan="1" %)
414 -(((
415 -getResultVariables
416 -)))|(% colspan="1" %)(% colspan="1" %)
417 -(((
418 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
419 -)))
420 -
421 -== Login through the LMS ==
422 -
423 -{{code language="xml" title="Login through the LMS"}}
424 -@WebMethod(operationName = „armSite")
425 -public String armSite(
426 -@WebParam(name = „version") final Integer version,
427 -@WebParam(name = „userId") final String userId,
428 -@WebParam(name = „optionalRole") final Integer role,
429 -@WebParam(name = „secretToShare") final String secretToShare,
430 -@WebParam(name = „optionalUserLastName") final String userLastName,
431 -@WebParam(name = „optionalUserFirstName") final String userFirstName,
432 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
433 -}
434 -{{/code}}
435 -
436 -=== Parameter armSite ===
437 -
438 -|(((
439 -version
440 -)))|(((
441 -Requested version: 1
442 -)))
443 -|(((
444 -userId
445 -)))|(((
446 -UserId of the requested Reporter user
447 -)))
448 -|(((
449 -optionalRole
450 -)))|(((
451 -Optional. User role. 0 = student, 1 = tutor
452 -)))
453 -|(((
454 -secretToShare
455 -)))|(((
456 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
457 -)))
458 -|(((
459 -optionalUserLastName
460 -)))|(((
461 -Optional. Last name of the user.
462 -)))
463 -|(% colspan="1" %)(% colspan="1" %)
464 -(((
465 -optionalUserFirstName
466 -)))|(% colspan="1" %)(% colspan="1" %)
467 -(((
468 -Optional. First name of the user.
469 -)))
470 -|(% colspan="1" %)(% colspan="1" %)
471 -(((
472 -additionalParams
473 -)))|(% colspan="1" %)(% colspan="1" %)
474 -(((
475 -Reserved for future use.
476 -)))
477 -
478 -=== ReturnValue armSite ===
479 -
480 -|(((
481 -String
482 -)))|(((
483 -Session ID which has to be used to mark any other Reporter call.
484 -)))
485 -
486 -== Initialisation through LMS ==
487 -
488 -{{code language="xml" title="Initialisation through LMS"}}
489 -@WebMethod(operationName = „initiateSite")
490 -public String initiateSite(
491 -@WebParam(name = „version") final Integer version,
492 -@WebParam(name = „sessionId") final String sessionId,
493 -@WebParam(name = „secretToShare") final String secretToShare,
494 -@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
495 -@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
496 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
497 -}
498 -{{/code}}
499 -
500 -=== Parameter initiateSite ===
501 -
502 -|(((
503 -version
504 -)))|(((
505 -Requested version: 1
506 -)))
507 -|(% colspan="1" %)(% colspan="1" %)
508 -(((
509 -sessionId
510 -)))|(% colspan="1" %)(% colspan="1" %)
511 -(((
512 -SessionId, as returned by armSite.
513 -)))
514 -|(((
515 -secretToShare
516 -)))|(((
517 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
518 -)))
519 -|(((
520 -students
521 -)))|(((
522 -List of students and their results. See below.
523 -)))
524 -|(((
525 -optionalContentPackage
526 -)))|(((
527 -Optional. Content package (zipped) as byte array.
528 -)))
529 -|(((
530 -additionalParams
531 -)))|(((
532 -Reserved for future use.
533 -)))
534 -
535 -=== ReturnValue initiateSite ===
536 -
537 -|(((
538 -String
539 -)))|(((
540 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
541 -
542 -* sid: Session ID, as returned by armSite
543 -* (((
544 -uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
545 -)))
546 -)))
547 -
548 -{{code language="xml"}}
549 -public class ResultsForStudent {
550 -   private String studentId = „";
551 -   private String firstname = „";
552 -   private String lastname = „";
553 -   private String groupname = „";
554 -   private String tutorname = „";
555 -   private File contentFile = null;
556 -   private byte[] resultsFile = null;
557 -}
558 -{{/code}}
559 -
560 -== Logout through the LMS ==
561 -
562 -
563 -
564 -{{code}}
565 -@WebMethod(operationName = „disarmSite")
566 -public Boolean disarmSite(
567 -@WebParam(name = „version") final Integer version,
568 -@WebParam(name = „sessionId") final String sessionId,
569 -@WebParam(name = „secretToShare") final String secretToShare,
570 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
571 -}
572 -{{/code}}
573 -
574 -
575 -
576 -=== Parameter disarmSite ===
577 -
578 -|(((
579 -version
580 -)))|(((
581 -Requested version: 1
582 -)))
583 -|(% colspan="1" %)(% colspan="1" %)
584 -(((
585 -sessionId
586 -)))|(% colspan="1" %)(% colspan="1" %)
587 -(((
588 -SessionId, as returned by armSite.
589 -)))
590 -|(((
591 -secretToShare
592 -)))|(((
593 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
594 -)))
595 -|(((
596 -additionalParams
597 -)))|(((
598 -Reserved for future use.
599 -)))
600 -
601 -=== ReturnValue disarmSite ===
602 -
603 -|(((
604 -Boolean
605 -)))|(((
606 -True in the case of success, otherwise false.
607 -)))
608 -
609 -== Request of learner results through the LMS ==
610 -
611 -{{code language="xml" title="Request of learner results through the LMS"}}
612 - @WebMethod(operationName = „getResultValues")
613 -public HashMapWrapper getResultValues(
614 - @WebParam(name = „version") final Integer version,
615 - @WebParam(name = „sessionId") final String sessionId,
616 - @WebParam(name = „secretToShare") final String secretToShare,
617 - @WebParam(name = „requestedValues") final HashMap<String, String>
618 - requestedValues,
619 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
620 -}
621 -{{/code}}
622 -
623 -=== Parameter getResultValues ===
624 -
625 -|(((
626 -version
627 -)))|(((
628 -Requested version: 1
629 -)))
630 -|(% colspan="1" %)(% colspan="1" %)
631 -(((
632 -sessionId
633 -)))|(% colspan="1" %)(% colspan="1" %)
634 -(((
635 -SessionId, as returned by armSite.
636 -)))
637 -|(((
638 -secretToShare
639 -)))|(((
640 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
641 -)))
642 -|(((
643 -requestedValues
644 -)))|(((
645 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
646 -)))
647 -|(((
648 -additionalParams
649 -)))|(((
650 -Reserved for future use.
651 -)))
652 -
653 -=== ReturnValue getResultValues ===
654 -
655 -|(((
656 -HashMap<String, String>
657 -)))|(((
658 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
659 -)))
660 -
661 -== Request of result variables through the LMS ==
662 -
663 -{{code language="xml" title="Request of result variables through the LMS"}}
664 - @WebMethod(operationName = „getResultVariables")
665 -public HashMapWrapper getResultVariables(
666 -@WebParam(name = „version") final Integer version,
667 -@WebParam(name = „contentPackage") final byte[] contentPackage,
668 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
669 -}
670 -{{/code}}
671 -
672 -=== Parameter getResultVariables ===
673 -
674 -|(((
675 -version
676 -)))|(((
677 -Requested version: 1
678 -)))
679 -|(((
680 -contentPackage
681 -)))|(((
682 -Content package (zipped) as byte array.
683 -)))
684 -|(((
685 -additionalParams
686 -)))|(((
687 -Reserved for future use.
688 -)))
689 -
690 -=== ReturnValue getResultVariables ===
691 -
692 -|(((
693 -HashMap<String, String>
694 -)))|(((
695 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
696 -)))
697 -
698 -== Wrapper ==
699 -
700 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
701 -
702 -=== Wrapper for HashMap<String, String> ===
703 -
704 -HashMapWrapper.java:
705 -
706 -[[image:attach:HashMapWrapperjava.png]]
707 -
708 -[[image:attach:HashMapWrapperjava2.png]]
709 -
710 -=== Wrapper for the ArrayList<ResultsForStudent> ===
711 -
712 -ResultsForStudentsWrapper.java:
713 -
714 -[[image:attach:ResultsForStudentsWrapperjava.png]]
715 -{{/layout-cell}}
716 -{{/layout-section}}
717 -{{/layout}}
718 -{{/sv-translation}}
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 -182518281
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/182518281/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter