Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 315.1
bearbeitet von Carina Enke
am 30.05.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.
Auf 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.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,7 +1,70 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}{{/layout-cell}}
4 +{{layout-cell}}
5 +
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 +
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-uVFeS"/}}: Übersetzung offen
62 +{{/task}}
63 +)))
64 +)))
65 +{{/details}}
66 +{{/conditionalcontent}}
67 +{{/layout-cell}}
5 5  {{/layout-section}}
6 6  
7 7  {{layout-section ac:type="two_right_sidebar"}}
... ... @@ -379,29 +379,29 @@
379 379  
380 380  {{layout-section ac:type="single"}}
381 381  {{layout-cell}}
382 -== General ==
445 +== General information ==
383 383  
384 -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:
385 385  
386 386  |(((
387 387  armSite
388 388  )))|(((
389 -Registration of sequence requests at the ONYX reporter
452 +Registration of sequence requests at the ONYX Reporter
390 390  )))
391 391  |(((
392 392  initiateSite
393 393  )))|(((
394 -Initiates the reporter session (transmission of the CP).
457 +Initiates the Reporter session (transmission of the CP).
395 395  )))
396 396  |(((
397 397  disarmSite
398 398  )))|(((
399 -Release of all reporter resources for this session.
462 +Release of all Reporter resources for this session.
400 400  )))
401 401  |(((
402 402  getResultValues
403 403  )))|(((
404 -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.
405 405  )))
406 406  |(% colspan="1" %)(% colspan="1" %)
407 407  (((
... ... @@ -408,12 +408,12 @@
408 408  getResultVariables
409 409  )))|(% colspan="1" %)(% colspan="1" %)
410 410  (((
411 -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.
412 412  )))
413 413  
414 -== Connection to the LMS ==
477 +== Login through the LMS ==
415 415  
416 -{{code language="xml" title="Anmeldung des LMS"}}
479 +{{code language="xml" title="Login through the LMS"}}
417 417  @WebMethod(operationName = „armSite")
418 418  public String armSite(
419 419  @WebParam(name = „version") final Integer version,
... ... @@ -436,22 +436,22 @@
436 436  |(((
437 437  userId
438 438  )))|(((
439 -UserId of the requested reporter user
502 +UserId of the requested Reporter user
440 440  )))
441 441  |(((
442 442  optionalRole
443 443  )))|(((
444 -Optional. User role. 0=student, 1=tutor
507 +Optional. User role. 0 = student, 1 = tutor
445 445  )))
446 446  |(((
447 447  secretToShare
448 448  )))|(((
449 -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.
450 450  )))
451 451  |(((
452 452  optionalUserLastName
453 453  )))|(((
454 -Optional. User lastname.
517 +Optional. Last name of the user.
455 455  )))
456 456  |(% colspan="1" %)(% colspan="1" %)
457 457  (((
... ... @@ -458,7 +458,7 @@
458 458  optionalUserFirstName
459 459  )))|(% colspan="1" %)(% colspan="1" %)
460 460  (((
461 -Optional. User firstname.
524 +Optional. First name of the user.
462 462  )))
463 463  |(% colspan="1" %)(% colspan="1" %)
464 464  (((
... ... @@ -473,12 +473,12 @@
473 473  |(((
474 474  String
475 475  )))|(((
476 -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.
477 477  )))
478 478  
479 479  == Initialisation through LMS ==
480 480  
481 -{{code language="xml" title="Initialisierung durch LMS"}}
544 +{{code language="xml" title="Initialisation through LMS"}}
482 482  @WebMethod(operationName = „initiateSite")
483 483  public String initiateSite(
484 484  @WebParam(name = „version") final Integer version,
... ... @@ -507,17 +507,17 @@
507 507  |(((
508 508  secretToShare
509 509  )))|(((
510 -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.
511 511  )))
512 512  |(((
513 513  students
514 514  )))|(((
515 -List of students with their results. See below.
578 +List of students and their results. See below.
516 516  )))
517 517  |(((
518 518  optionalContentPackage
519 519  )))|(((
520 -Optional. Content Package (zipped) as byte array.
583 +Optional. Content package (zipped) as byte array.
521 521  )))
522 522  |(((
523 523  additionalParams
... ... @@ -530,11 +530,11 @@
530 530  |(((
531 531  String
532 532  )))|(((
533 -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:
534 534  
535 -* sid: Session ID as returned by armSite
598 +* sid: Session ID, as returned by armSite
536 536  * (((
537 -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
538 538  )))
539 539  )))
540 540  
... ... @@ -550,7 +550,7 @@
550 550  }
551 551  {{/code}}
552 552  
553 -== Deconnection through the LMS ==
616 +== Logout through the LMS ==
554 554  
555 555  
556 556  
... ... @@ -583,7 +583,7 @@
583 583  |(((
584 584  secretToShare
585 585  )))|(((
586 -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.
587 587  )))
588 588  |(((
589 589  additionalParams
... ... @@ -596,12 +596,12 @@
596 596  |(((
597 597  Boolean
598 598  )))|(((
599 -True if successful, otherwise false.
662 +True in the case of success, otherwise false.
600 600  )))
601 601  
602 -== Request of learning results through the LMS ==
665 +== Request of learner results through the LMS ==
603 603  
604 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
667 +{{code language="xml" title="Request of learner results through the LMS"}}
605 605   @WebMethod(operationName = „getResultValues")
606 606  public HashMapWrapper getResultValues(
607 607   @WebParam(name = „version") final Integer version,
... ... @@ -630,12 +630,12 @@
630 630  |(((
631 631  secretToShare
632 632  )))|(((
633 -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.
634 634  )))
635 635  |(((
636 636  requestedValues
637 637  )))|(((
638 -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.
639 639  )))
640 640  |(((
641 641  additionalParams
... ... @@ -648,12 +648,12 @@
648 648  |(((
649 649  HashMap<String, String>
650 650  )))|(((
651 -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)
652 652  )))
653 653  
654 654  == Request of result variables through the LMS ==
655 655  
656 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
719 +{{code language="xml" title="Request of result variables through the LMS"}}
657 657   @WebMethod(operationName = „getResultVariables")
658 658  public HashMapWrapper getResultVariables(
659 659  @WebParam(name = „version") final Integer version,
... ... @@ -685,13 +685,12 @@
685 685  |(((
686 686  HashMap<String, String>
687 687  )))|(((
688 -Map of result variables, key is the variable name, value the corresponding
689 -value (HashMap is wrapped).
751 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
690 690  )))
691 691  
692 692  == Wrapper ==
693 693  
694 -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.
695 695  
696 696  === Wrapper for HashMap<String, String> ===
697 697  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -162758939
1 +202113242
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/162758939/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/202113242/Schnittstelle ONYX Reporter