Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 304.1
bearbeitet von Carina Enke
am 29.01.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.6.
Auf Version 363.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.carina
1 +XWiki.sandra_riediger
Inhalt
... ... @@ -1,86 +1,42 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
3 +{{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 +====== Inhalt: ======
5 5  
6 6  
7 -{{conditionalcontent 0="Zielgruppe: (BPS)" sv-attr:866DE48701525447C13BC59401CD793F="866DE48701525447C13C469E1E314A59" atlassian-macro-output-type="INLINE"}}
8 -{{details}}
9 -|=(((
10 -Verantwortlicher
11 -)))|(((
12 -
13 -)))
14 -|=(% colspan="1" %)(% colspan="1" %)
15 -(((
16 -Status
17 -)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 -(((
19 -{{sv-metadata type="workflow-status"/}}
20 20  
21 -{{status colour="Green" title="Fertig"/}}
22 -)))
9 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
10 +{{/layout-cell}}
11 +
12 +{{layout-cell}}
23 23  |=(% colspan="1" %)(% colspan="1" %)
24 24  (((
25 -Varianten
15 +Programmversion
26 26  )))|(% colspan="1" %)(% colspan="1" %)
27 27  (((
28 -{{sv-metadata type="variants"/}}
18 +
29 29  )))
30 -|=(% colspan="1" %)(% colspan="1" %)
31 -(((
32 -Attribute
33 -)))|(% colspan="1" %)(% colspan="1" %)
34 -(((
35 -{{sv-metadata type="attributes"/}}
20 +|=(((
21 +Status
22 +)))|(((
23 +(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
36 36  )))
37 -|=(% colspan="1" %)(% colspan="1" %)
38 -(((
39 -Pagekey
40 -)))|(% colspan="1" %)(% colspan="1" %)
41 -(((
42 -{{sv-metadata type="pagekey"/}}
43 -)))
44 -|=(% colspan="1" %)(% colspan="1" %)
45 -(((
46 -Übersetzung
47 -)))|(% colspan="1" %)(% colspan="1" %)
48 -(((
25 +|=(((
26 +Aufgaben
27 +)))|(((
28 +
49 49  
50 -
51 -{{status colour="Green" title="Fertig"/}}
30 +
52 52  )))
53 -|=(% colspan="1" %)(% colspan="1" %)
54 -(((
55 -TODOs
56 -)))|(% colspan="1" %)(% colspan="1" %)
57 -(((
58 -(% class="task-list" %)
59 -(((
60 -{{task reference="/Tasks/Task_9" status="Done"}}
61 -carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-uVFeS"/}}: Übersetzung offen
62 -{{/task}}
32 +|=(((
33 +JIRA
34 +)))|(((
35 +
63 63  )))
64 -)))
65 -{{/details}}
66 -{{/conditionalcontent}}
67 67  {{/layout-cell}}
68 68  {{/layout-section}}
69 69  
70 -{{layout-section ac:type="two_right_sidebar"}}
71 -{{layout-cell}}
72 -====== Inhalt: ======
73 -
74 -
75 -
76 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
77 -{{/layout-cell}}
78 -
79 -{{layout-cell}}
80 -
81 -{{/layout-cell}}
82 -{{/layout-section}}
83 -
84 84  {{layout-section ac:type="single"}}
85 85  {{layout-cell}}
86 86  == Allgemeines ==
... ... @@ -117,7 +117,7 @@
117 117  
118 118  == Anmeldung des LMS ==
119 119  
120 -{{code language="xml" title="Anmeldung des LMS"}}
76 +{{code title="Anmeldung des LMS" language="xml"}}
121 121  @WebMethod(operationName = „armSite")
122 122  public String armSite(
123 123  @WebParam(name = „version") final Integer version,
... ... @@ -182,7 +182,7 @@
182 182  
183 183  == Initialisierung durch LMS ==
184 184  
185 -{{code language="xml" title="Initialisierung durch LMS"}}
141 +{{code title="Initialisierung durch LMS" language="xml"}}
186 186  @WebMethod(operationName = „initiateSite")
187 187  public String initiateSite(
188 188  @WebParam(name = „version") final Integer version,
... ... @@ -303,7 +303,7 @@
303 303  
304 304  == Abfrage von Lernerresultaten durch LMS ==
305 305  
306 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
262 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
307 307   @WebMethod(operationName = „getResultValues")
308 308  public HashMapWrapper getResultValues(
309 309   @WebParam(name = „version") final Integer version,
... ... @@ -355,7 +355,7 @@
355 355  
356 356  == Abfrage von Ergebnisvariablen durch LMS ==
357 357  
358 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
314 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
359 359   @WebMethod(operationName = „getResultVariables")
360 360  public HashMapWrapper getResultVariables(
361 361  @WebParam(name = „version") final Integer version,
... ... @@ -392,7 +392,7 @@
392 392  
393 393  == Wrapper ==
394 394  
395 -Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
351 +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.
396 396  
397 397  === Wrapper für die HashMap<String, String> ===
398 398  
... ... @@ -418,7 +418,7 @@
418 418  {{layout-cell}}
419 419  ====== relevante Links: ======
420 420  
421 -* [[doc:ONYX Player Interface]]
377 +* [[doc:Schnittstelle ONYX WebPlayer]]
422 422  {{/layout-cell}}
423 423  {{/layout-section}}
424 424  {{/layout}}
... ... @@ -432,39 +432,64 @@
432 432  
433 433  
434 434  
435 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
391 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
436 436  {{/layout-cell}}
437 437  
438 438  {{layout-cell}}
395 +|=(% colspan="1" %)(% colspan="1" %)
396 +(((
397 +Programmversion
398 +)))|(% colspan="1" %)(% colspan="1" %)
399 +(((
439 439  
401 +)))
402 +|=(((
403 +Status
404 +)))|(((
405 +(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT
406 +)))
407 +|=(((
408 +Aufgaben
409 +)))|(((
410 +
411 +
412 +
413 +)))
414 +|=(((
415 +JIRA
416 +)))|(((
417 +
418 +)))
440 440  {{/layout-cell}}
441 441  {{/layout-section}}
442 442  
443 443  {{layout-section ac:type="single"}}
444 444  {{layout-cell}}
445 -== General information ==
424 +
446 446  
447 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
426 +== General ==
448 448  
428 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
429 +
449 449  |(((
450 450  armSite
451 451  )))|(((
452 -Registration of sequence requests at the ONYX Reporter
433 +Registration of sequence requests at the ONYX reporter
453 453  )))
454 454  |(((
455 455  initiateSite
456 456  )))|(((
457 -Initiates the Reporter session (transmission of the CP).
438 +Initiates the reporter session (transmission of the CP).
458 458  )))
459 459  |(((
460 460  disarmSite
461 461  )))|(((
462 -Release of all Reporter resources for this session.
443 +Release of all reporter resources for this session.
463 463  )))
464 464  |(((
465 465  getResultValues
466 466  )))|(((
467 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
448 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
468 468  )))
469 469  |(% colspan="1" %)(% colspan="1" %)
470 470  (((
... ... @@ -471,12 +471,12 @@
471 471  getResultVariables
472 472  )))|(% colspan="1" %)(% colspan="1" %)
473 473  (((
474 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
455 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
475 475  )))
476 476  
477 -== Login through the LMS ==
458 +== Connection to the LMS ==
478 478  
479 -{{code language="xml" title="Login through the LMS"}}
460 +{{code title="Anmeldung des LMS" language="xml"}}
480 480  @WebMethod(operationName = „armSite")
481 481  public String armSite(
482 482  @WebParam(name = „version") final Integer version,
... ... @@ -499,22 +499,22 @@
499 499  |(((
500 500  userId
501 501  )))|(((
502 -UserId of the requested Reporter user
483 +UserId of the requested reporter user
503 503  )))
504 504  |(((
505 505  optionalRole
506 506  )))|(((
507 -Optional. User role. 0 = student, 1 = tutor
488 +Optional. User role. 0=student, 1=tutor
508 508  )))
509 509  |(((
510 510  secretToShare
511 511  )))|(((
512 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
493 +Shared secret. Has to remain identical for every communication.
513 513  )))
514 514  |(((
515 515  optionalUserLastName
516 516  )))|(((
517 -Optional. Last name of the user.
498 +Optional. User lastname.
518 518  )))
519 519  |(% colspan="1" %)(% colspan="1" %)
520 520  (((
... ... @@ -521,7 +521,7 @@
521 521  optionalUserFirstName
522 522  )))|(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 -Optional. First name of the user.
505 +Optional. User firstname.
525 525  )))
526 526  |(% colspan="1" %)(% colspan="1" %)
527 527  (((
... ... @@ -536,12 +536,12 @@
536 536  |(((
537 537  String
538 538  )))|(((
539 -Session ID which has to be used to mark any other Reporter call.
520 +Session ID that has to be used to mark any further reporter call.
540 540  )))
541 541  
542 542  == Initialisation through LMS ==
543 543  
544 -{{code language="xml" title="Initialisation through LMS"}}
525 +{{code title="Initialisierung durch LMS" language="xml"}}
545 545  @WebMethod(operationName = „initiateSite")
546 546  public String initiateSite(
547 547  @WebParam(name = „version") final Integer version,
... ... @@ -570,17 +570,17 @@
570 570  |(((
571 571  secretToShare
572 572  )))|(((
573 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
554 +Shared secret. Has to remain identical at every communication.
574 574  )))
575 575  |(((
576 576  students
577 577  )))|(((
578 -List of students and their results. See below.
559 +List of students with their results. See below.
579 579  )))
580 580  |(((
581 581  optionalContentPackage
582 582  )))|(((
583 -Optional. Content package (zipped) as byte array.
564 +Optional. Content Package (zipped) as byte array.
584 584  )))
585 585  |(((
586 586  additionalParams
... ... @@ -593,11 +593,11 @@
593 593  |(((
594 594  String
595 595  )))|(((
596 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
577 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
597 597  
598 -* sid: Session ID, as returned by armSite
579 +* sid: Session ID as returned by armSite
599 599  * (((
600 -uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
581 +uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
601 601  )))
602 602  )))
603 603  
... ... @@ -613,7 +613,7 @@
613 613  }
614 614  {{/code}}
615 615  
616 -== Logout through the LMS ==
597 +== Deconnection through the LMS ==
617 617  
618 618  
619 619  
... ... @@ -646,7 +646,7 @@
646 646  |(((
647 647  secretToShare
648 648  )))|(((
649 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
630 +Shared secret. Has to remain identical at every communication.
650 650  )))
651 651  |(((
652 652  additionalParams
... ... @@ -659,12 +659,12 @@
659 659  |(((
660 660  Boolean
661 661  )))|(((
662 -True in the case of success, otherwise false.
643 +True if successful, otherwise false.
663 663  )))
664 664  
665 -== Request of learner results through the LMS ==
646 +== Request of learning results through the LMS ==
666 666  
667 -{{code language="xml" title="Request of learner results through the LMS"}}
648 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
668 668   @WebMethod(operationName = „getResultValues")
669 669  public HashMapWrapper getResultValues(
670 670   @WebParam(name = „version") final Integer version,
... ... @@ -693,12 +693,12 @@
693 693  |(((
694 694  secretToShare
695 695  )))|(((
696 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
677 +Shared secret. Has to remain identical at every communication.
697 697  )))
698 698  |(((
699 699  requestedValues
700 700  )))|(((
701 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
682 +Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
702 702  )))
703 703  |(((
704 704  additionalParams
... ... @@ -711,12 +711,12 @@
711 711  |(((
712 712  HashMap<String, String>
713 713  )))|(((
714 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
695 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
715 715  )))
716 716  
717 717  == Request of result variables through the LMS ==
718 718  
719 -{{code language="xml" title="Request of result variables through the LMS"}}
700 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
720 720   @WebMethod(operationName = „getResultVariables")
721 721  public HashMapWrapper getResultVariables(
722 722  @WebParam(name = „version") final Integer version,
... ... @@ -748,12 +748,13 @@
748 748  |(((
749 749  HashMap<String, String>
750 750  )))|(((
751 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
732 +Map of result variables, key is the variable name, value the corresponding
733 +value (HashMap is wrapped).
752 752  )))
753 753  
754 754  == Wrapper ==
755 755  
756 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
738 +As the transmission of maps and lists generate problems via JAX-WS (lists filled by the customer are sent without any data and thus reach the server without data) they have to be wrapped.
757 757  
758 758  === Wrapper for HashMap<String, String> ===
759 759  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -202113242
1 +3342826
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/202113242/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342826/Schnittstelle ONYX Reporter