Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

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

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,42 +1,86 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-section ac:type="single"}}
4 4  {{layout-cell}}
5 -====== Inhalt: ======
6 6  
7 7  
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"/}}
8 8  
9 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
10 -{{/layout-cell}}
11 -
12 -{{layout-cell}}
21 +{{status colour="Green" title="Fertig"/}}
22 +)))
13 13  |=(% colspan="1" %)(% colspan="1" %)
14 14  (((
15 -Programmversion
25 +Varianten
16 16  )))|(% colspan="1" %)(% colspan="1" %)
17 17  (((
18 -
28 +{{sv-metadata type="variants"/}}
19 19  )))
20 -|=(((
21 -Status
22 -)))|(((
23 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
30 +|=(% colspan="1" %)(% colspan="1" %)
31 +(((
32 +Attribute
33 +)))|(% colspan="1" %)(% colspan="1" %)
34 +(((
35 +{{sv-metadata type="attributes"/}}
24 24  )))
25 -|=(((
26 -Aufgaben
27 -)))|(((
28 -
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 +(((
29 29  
30 -
50 +
51 +{{status colour="Green" title="Fertig"/}}
31 31  )))
32 -|=(((
33 -JIRA
34 -)))|(((
35 -
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}}
36 36  )))
64 +)))
65 +{{/details}}
66 +{{/conditionalcontent}}
37 37  {{/layout-cell}}
38 38  {{/layout-section}}
39 39  
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 +
40 40  {{layout-section ac:type="single"}}
41 41  {{layout-cell}}
42 42  == Allgemeines ==
... ... @@ -73,7 +73,7 @@
73 73  
74 74  == Anmeldung des LMS ==
75 75  
76 -{{code title="Anmeldung des LMS" language="xml"}}
120 +{{code language="xml" title="Anmeldung des LMS"}}
77 77  @WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
... ... @@ -138,7 +138,7 @@
138 138  
139 139  == Initialisierung durch LMS ==
140 140  
141 -{{code title="Initialisierung durch LMS" language="xml"}}
185 +{{code language="xml" title="Initialisierung durch LMS"}}
142 142  @WebMethod(operationName = „initiateSite")
143 143  public String initiateSite(
144 144  @WebParam(name = „version") final Integer version,
... ... @@ -259,7 +259,7 @@
259 259  
260 260  == Abfrage von Lernerresultaten durch LMS ==
261 261  
262 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
306 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
263 263   @WebMethod(operationName = „getResultValues")
264 264  public HashMapWrapper getResultValues(
265 265   @WebParam(name = „version") final Integer version,
... ... @@ -311,7 +311,7 @@
311 311  
312 312  == Abfrage von Ergebnisvariablen durch LMS ==
313 313  
314 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
358 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
315 315   @WebMethod(operationName = „getResultVariables")
316 316  public HashMapWrapper getResultVariables(
317 317  @WebParam(name = „version") final Integer version,
... ... @@ -348,7 +348,7 @@
348 348  
349 349  == Wrapper ==
350 350  
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.
395 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
352 352  
353 353  === Wrapper für die HashMap<String, String> ===
354 354  
... ... @@ -374,7 +374,7 @@
374 374  {{layout-cell}}
375 375  ====== relevante Links: ======
376 376  
377 -* [[doc:Schnittstelle ONYX WebPlayer]]
421 +* [[doc:ONYX Player Interface]]
378 378  {{/layout-cell}}
379 379  {{/layout-section}}
380 380  {{/layout}}
... ... @@ -388,64 +388,39 @@
388 388  
389 389  
390 390  
391 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
435 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
392 392  {{/layout-cell}}
393 393  
394 394  {{layout-cell}}
395 -|=(% colspan="1" %)(% colspan="1" %)
396 -(((
397 -Programmversion
398 -)))|(% colspan="1" %)(% colspan="1" %)
399 -(((
400 400  
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 -)))
419 419  {{/layout-cell}}
420 420  {{/layout-section}}
421 421  
422 422  {{layout-section ac:type="single"}}
423 423  {{layout-cell}}
424 -
445 +== General information ==
425 425  
426 -== General ==
447 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
427 427  
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 -
430 430  |(((
431 431  armSite
432 432  )))|(((
433 -Registration of sequence requests at the ONYX reporter
452 +Registration of sequence requests at the ONYX Reporter
434 434  )))
435 435  |(((
436 436  initiateSite
437 437  )))|(((
438 -Initiates the reporter session (transmission of the CP).
457 +Initiates the Reporter session (transmission of the CP).
439 439  )))
440 440  |(((
441 441  disarmSite
442 442  )))|(((
443 -Release of all reporter resources for this session.
462 +Release of all Reporter resources for this session.
444 444  )))
445 445  |(((
446 446  getResultValues
447 447  )))|(((
448 -Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
467 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
449 449  )))
450 450  |(% colspan="1" %)(% colspan="1" %)
451 451  (((
... ... @@ -452,12 +452,12 @@
452 452  getResultVariables
453 453  )))|(% colspan="1" %)(% colspan="1" %)
454 454  (((
455 -Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
474 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
456 456  )))
457 457  
458 -== Connection to the LMS ==
477 +== Login through the LMS ==
459 459  
460 -{{code title="Anmeldung des LMS" language="xml"}}
479 +{{code language="xml" title="Login through the LMS"}}
461 461  @WebMethod(operationName = „armSite")
462 462  public String armSite(
463 463  @WebParam(name = „version") final Integer version,
... ... @@ -480,22 +480,22 @@
480 480  |(((
481 481  userId
482 482  )))|(((
483 -UserId of the requested reporter user
502 +UserId of the requested Reporter user
484 484  )))
485 485  |(((
486 486  optionalRole
487 487  )))|(((
488 -Optional. User role. 0=student, 1=tutor
507 +Optional. User role. 0 = student, 1 = tutor
489 489  )))
490 490  |(((
491 491  secretToShare
492 492  )))|(((
493 -Shared secret. Has to remain identical for every communication.
512 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
494 494  )))
495 495  |(((
496 496  optionalUserLastName
497 497  )))|(((
498 -Optional. User lastname.
517 +Optional. Last name of the user.
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
... ... @@ -502,7 +502,7 @@
502 502  optionalUserFirstName
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -Optional. User firstname.
524 +Optional. First name of the user.
506 506  )))
507 507  |(% colspan="1" %)(% colspan="1" %)
508 508  (((
... ... @@ -517,12 +517,12 @@
517 517  |(((
518 518  String
519 519  )))|(((
520 -Session ID that has to be used to mark any further reporter call.
539 +Session ID which has to be used to mark any other Reporter call.
521 521  )))
522 522  
523 523  == Initialisation through LMS ==
524 524  
525 -{{code title="Initialisierung durch LMS" language="xml"}}
544 +{{code language="xml" title="Initialisation through LMS"}}
526 526  @WebMethod(operationName = „initiateSite")
527 527  public String initiateSite(
528 528  @WebParam(name = „version") final Integer version,
... ... @@ -551,17 +551,17 @@
551 551  |(((
552 552  secretToShare
553 553  )))|(((
554 -Shared secret. Has to remain identical at every communication.
573 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
555 555  )))
556 556  |(((
557 557  students
558 558  )))|(((
559 -List of students with their results. See below.
578 +List of students and their results. See below.
560 560  )))
561 561  |(((
562 562  optionalContentPackage
563 563  )))|(((
564 -Optional. Content Package (zipped) as byte array.
583 +Optional. Content package (zipped) as byte array.
565 565  )))
566 566  |(((
567 567  additionalParams
... ... @@ -574,11 +574,11 @@
574 574  |(((
575 575  String
576 576  )))|(((
577 -Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
596 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
578 578  
579 -* sid: Session ID as returned by armSite
598 +* sid: Session ID, as returned by armSite
580 580  * (((
581 -uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
600 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
582 582  )))
583 583  )))
584 584  
... ... @@ -594,7 +594,7 @@
594 594  }
595 595  {{/code}}
596 596  
597 -== Deconnection through the LMS ==
616 +== Logout through the LMS ==
598 598  
599 599  
600 600  
... ... @@ -627,7 +627,7 @@
627 627  |(((
628 628  secretToShare
629 629  )))|(((
630 -Shared secret. Has to remain identical at every communication.
649 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
631 631  )))
632 632  |(((
633 633  additionalParams
... ... @@ -640,12 +640,12 @@
640 640  |(((
641 641  Boolean
642 642  )))|(((
643 -True if successful, otherwise false.
662 +True in the case of success, otherwise false.
644 644  )))
645 645  
646 -== Request of learning results through the LMS ==
665 +== Request of learner results through the LMS ==
647 647  
648 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
667 +{{code language="xml" title="Request of learner results through the LMS"}}
649 649   @WebMethod(operationName = „getResultValues")
650 650  public HashMapWrapper getResultValues(
651 651   @WebParam(name = „version") final Integer version,
... ... @@ -674,12 +674,12 @@
674 674  |(((
675 675  secretToShare
676 676  )))|(((
677 -Shared secret. Has to remain identical at every communication.
696 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
678 678  )))
679 679  |(((
680 680  requestedValues
681 681  )))|(((
682 -Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
701 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
683 683  )))
684 684  |(((
685 685  additionalParams
... ... @@ -692,12 +692,12 @@
692 692  |(((
693 693  HashMap<String, String>
694 694  )))|(((
695 -Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
714 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
696 696  )))
697 697  
698 698  == Request of result variables through the LMS ==
699 699  
700 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
719 +{{code language="xml" title="Request of result variables through the LMS"}}
701 701   @WebMethod(operationName = „getResultVariables")
702 702  public HashMapWrapper getResultVariables(
703 703  @WebParam(name = „version") final Integer version,
... ... @@ -729,13 +729,12 @@
729 729  |(((
730 730  HashMap<String, String>
731 731  )))|(((
732 -Map of result variables, key is the variable name, value the corresponding
733 -value (HashMap is wrapped).
751 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
734 734  )))
735 735  
736 736  == Wrapper ==
737 737  
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.
756 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
739 739  
740 740  === Wrapper for HashMap<String, String> ===
741 741  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342826
1 +202113242
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342826/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/202113242/Schnittstelle ONYX Reporter