Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 272.1
bearbeitet von Carina Enke
am 07.06.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.
Auf Version 313.1
bearbeitet von Carina Enke
am 24.09.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,23 +1,84 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}{{/layout-cell}}
5 -{{/layout-section}}
6 -
7 -{{layout-section ac:type="two_right_sidebar"}}
8 8  {{layout-cell}}
5 +
6 +
7 +{{conditionalcontent 0="Zielgruppe: (BPS)" sv-attr:866DE48701525447C13BC59401CD793F="866DE48701525447C13C469E1E314A59" atlassian-macro-output-type="INLINE"}}
8 +{{details}}
9 +|=(((
10 +Verantwortlicher
11 +)))|(((
9 9  
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 +
21 +{{status colour="Green" title="Fertig"/}}
22 +)))
23 +|=(% colspan="1" %)(% colspan="1" %)
24 +(((
25 +Varianten
26 +)))|(% colspan="1" %)(% colspan="1" %)
27 +(((
28 +{{sv-metadata type="variants"/}}
29 +)))
30 +|=(% colspan="1" %)(% colspan="1" %)
31 +(((
32 +Attribute
33 +)))|(% colspan="1" %)(% colspan="1" %)
34 +(((
35 +{{sv-metadata type="attributes"/}}
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 +(((
49 +
50 +
51 +{{status colour="Green" title="Fertig"/}}
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-phXzt"/}}: Übersetzung offen
62 +{{/task}}
63 +)))
64 +)))
65 +{{/details}}
66 +{{/conditionalcontent}}
10 10  {{/layout-cell}}
68 +{{/layout-section}}
11 11  
70 +{{layout-section ac:type="two_right_sidebar"}}
12 12  {{layout-cell}}
13 -{{scroll-ignore}}
14 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
72 +====== Inhalt: ======
15 15  
16 16  
17 -{{toc/}}
18 -{{/panel}}
19 -{{/scroll-ignore}}
75 +
76 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
20 20  {{/layout-cell}}
78 +
79 +{{layout-cell}}
80 +
81 +{{/layout-cell}}
21 21  {{/layout-section}}
22 22  
23 23  {{layout-section ac:type="single"}}
... ... @@ -381,29 +381,29 @@
381 381  
382 382  {{layout-section ac:type="single"}}
383 383  {{layout-cell}}
384 -== General information ==
445 +== General ==
385 385  
386 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
447 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
387 387  
388 388  |(((
389 389  armSite
390 390  )))|(((
391 -Registration of sequence requests at the ONYX Reporter
452 +Registration of sequence requests at the ONYX reporter
392 392  )))
393 393  |(((
394 394  initiateSite
395 395  )))|(((
396 -Initiates the Reporter session (transmission of the CP).
457 +Initiates the reporter session (transmission of the CP).
397 397  )))
398 398  |(((
399 399  disarmSite
400 400  )))|(((
401 -Release of all Reporter resources for this session.
462 +Release of all reporter resources for this session.
402 402  )))
403 403  |(((
404 404  getResultValues
405 405  )))|(((
406 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
467 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
407 407  )))
408 408  |(% colspan="1" %)(% colspan="1" %)
409 409  (((
... ... @@ -410,12 +410,12 @@
410 410  getResultVariables
411 411  )))|(% colspan="1" %)(% colspan="1" %)
412 412  (((
413 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
474 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
414 414  )))
415 415  
416 -== Login through the LMS ==
477 +== Connection to the LMS ==
417 417  
418 -{{code language="xml" title="Login through the LMS"}}
479 +{{code language="xml" title="Anmeldung des LMS"}}
419 419  @WebMethod(operationName = „armSite")
420 420  public String armSite(
421 421  @WebParam(name = „version") final Integer version,
... ... @@ -438,22 +438,22 @@
438 438  |(((
439 439  userId
440 440  )))|(((
441 -UserId of the requested Reporter user
502 +UserId of the requested reporter user
442 442  )))
443 443  |(((
444 444  optionalRole
445 445  )))|(((
446 -Optional. User role. 0 = student, 1 = tutor
507 +Optional. User role. 0=student, 1=tutor
447 447  )))
448 448  |(((
449 449  secretToShare
450 450  )))|(((
451 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
512 +Shared secret. Has to remain identical for every communication.
452 452  )))
453 453  |(((
454 454  optionalUserLastName
455 455  )))|(((
456 -Optional. Last name of the user.
517 +Optional. User lastname.
457 457  )))
458 458  |(% colspan="1" %)(% colspan="1" %)
459 459  (((
... ... @@ -460,7 +460,7 @@
460 460  optionalUserFirstName
461 461  )))|(% colspan="1" %)(% colspan="1" %)
462 462  (((
463 -Optional. First name of the user.
524 +Optional. User firstname.
464 464  )))
465 465  |(% colspan="1" %)(% colspan="1" %)
466 466  (((
... ... @@ -475,12 +475,12 @@
475 475  |(((
476 476  String
477 477  )))|(((
478 -Session ID which has to be used to mark any other Reporter call.
539 +Session ID that has to be used to mark any further reporter call.
479 479  )))
480 480  
481 481  == Initialisation through LMS ==
482 482  
483 -{{code language="xml" title="Initialisation through LMS"}}
544 +{{code language="xml" title="Initialisierung durch LMS"}}
484 484  @WebMethod(operationName = „initiateSite")
485 485  public String initiateSite(
486 486  @WebParam(name = „version") final Integer version,
... ... @@ -509,17 +509,17 @@
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.
573 +Shared secret. Has to remain identical at every communication.
513 513  )))
514 514  |(((
515 515  students
516 516  )))|(((
517 -List of students and their results. See below.
578 +List of students with their results. See below.
518 518  )))
519 519  |(((
520 520  optionalContentPackage
521 521  )))|(((
522 -Optional. Content package (zipped) as byte array.
583 +Optional. Content Package (zipped) as byte array.
523 523  )))
524 524  |(((
525 525  additionalParams
... ... @@ -532,11 +532,11 @@
532 532  |(((
533 533  String
534 534  )))|(((
535 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
596 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
536 536  
537 -* sid: Session ID, as returned by armSite
598 +* sid: Session ID as returned by armSite
538 538  * (((
539 -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.
540 540  )))
541 541  )))
542 542  
... ... @@ -552,7 +552,7 @@
552 552  }
553 553  {{/code}}
554 554  
555 -== Logout through the LMS ==
616 +== Deconnection through the LMS ==
556 556  
557 557  
558 558  
... ... @@ -585,7 +585,7 @@
585 585  |(((
586 586  secretToShare
587 587  )))|(((
588 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
649 +Shared secret. Has to remain identical at every communication.
589 589  )))
590 590  |(((
591 591  additionalParams
... ... @@ -598,12 +598,12 @@
598 598  |(((
599 599  Boolean
600 600  )))|(((
601 -True in the case of success, otherwise false.
662 +True if successful, otherwise false.
602 602  )))
603 603  
604 -== Request of learner results through the LMS ==
665 +== Request of learning results through the LMS ==
605 605  
606 -{{code language="xml" title="Request of learner results through the LMS"}}
667 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
607 607   @WebMethod(operationName = „getResultValues")
608 608  public HashMapWrapper getResultValues(
609 609   @WebParam(name = „version") final Integer version,
... ... @@ -632,12 +632,12 @@
632 632  |(((
633 633  secretToShare
634 634  )))|(((
635 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
696 +Shared secret. Has to remain identical at every communication.
636 636  )))
637 637  |(((
638 638  requestedValues
639 639  )))|(((
640 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
701 +Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
641 641  )))
642 642  |(((
643 643  additionalParams
... ... @@ -650,12 +650,12 @@
650 650  |(((
651 651  HashMap<String, String>
652 652  )))|(((
653 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
714 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
654 654  )))
655 655  
656 656  == Request of result variables through the LMS ==
657 657  
658 -{{code language="xml" title="Request of result variables through the LMS"}}
719 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
659 659   @WebMethod(operationName = „getResultVariables")
660 660  public HashMapWrapper getResultVariables(
661 661  @WebParam(name = „version") final Integer version,
... ... @@ -687,12 +687,13 @@
687 687  |(((
688 688  HashMap<String, String>
689 689  )))|(((
690 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
751 +Map of result variables, key is the variable name, value the corresponding
752 +value (HashMap is wrapped).
691 691  )))
692 692  
693 693  == Wrapper ==
694 694  
695 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
757 +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.
696 696  
697 697  === Wrapper for HashMap<String, String> ===
698 698  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -301073198
1 +178880909
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073198/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/178880909/Schnittstelle ONYX Reporter