Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 390.8 nach 390.7 Von 400.1 nach 399.1

Von Version 399.1

bearbeitet von Carina Enke
am 13.02.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 390.8

bearbeitet von Carina Enke
am 18.12.2023

Änderungskommentar: Update document after refactoring.

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--10 Schnittstelle ONYX Reporter
++Schnittstelle ONYX Reporter

Übergeordnete Seite

@@ -1,1 +1,1 @@
--ONYX.Systeminformationen.WebHome
++Hilfe.Systeminformationen.WebHome

Inhalt

@@ -1,771 +1,25 @@
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
++{{sv-translation language="de"}}
++{{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}{{/layout-cell}}
++{{/layout-section}}
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--)))
--
--{{layout-cell}}
--
--{{/layout-cell}}
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--{{toc start="2"/}}
--
-- **Weitere Informationen:**
--
--* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--)))
--
--{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--{{toc start="2"/}}
--
-- **Weitere Informationen:**
--
--* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--{{/panel}}
--)))
--
--{{layout-cell}}
--{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--{{toc start="2"/}}
--
-- **Weitere Informationen:**
--
--* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--{{/panel}}
--{{/layout-cell}}
--)))
--
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
++\\
  {{/layout-cell}}
  {{layout-cell}}
++{{scroll-ignore}}
  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--{{toc start="2"/}}
-- **Weitere Informationen:**
--* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
++{{toc/}}
  {{/panel}}
++{{/scroll-ignore}}
  {{/layout-cell}}
  {{/layout-section}}
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--== Allgemeines ==
--
--Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
--
--(% class="wrapped" %)
--|(((
--armSite
--)))|(((
--Anmeldung von Folgerequests beim ONYX Reporter.
--)))
--|(((
--initiateSite
--)))|(((
--Initiiert die Reporter-Session (Übertragung des CPs).
--)))
--|(((
--disarmSite
--)))|(((
--Freigabe von allen Reporter-Ressourcen für diese Session.
--)))
--|(((
--getResultValues
--)))|(((
--Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--getResultVariables
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
--)))
--
--== Anmeldung des LMS ==
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-parameter-name="title" class="xwiki-metadata-container">Anmeldung des LMS
--)))
--
--{{code language="xml" title="Anmeldung des LMS"}}
--@WebMethod(operationName = „armSite")
--public String armSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „userId") final String userId,
--@WebParam(name = „optionalRole") final Integer role,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „optionalUserLastName") final String userLastName,
--@WebParam(name = „optionalUserFirstName") final String userFirstName,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter armSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(((
--userId
--)))|(((
--UserId des anfragenden Reporter-Benutzers
--)))
--|(((
--optionalRole
--)))|(((
--Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--optionalUserLastName
--)))|(((
--Optional. Nachname des Benutzers.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--optionalUserFirstName
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Optional. Vorname des Benutzers.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--additionalParams
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Reserved for future use.
--)))
--
--=== ReturnValue armSite ===
--
--(% class="wrapped" %)
--|(((
--String
--)))|(((
--Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
--)))
--
--== Initialisierung durch LMS ==
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-parameter-name="title" class="xwiki-metadata-container">Initialisierung durch LMS
--)))
--
--{{code language="xml" title="Initialisierung durch LMS"}}
--@WebMethod(operationName = „initiateSite")
--public String initiateSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
--@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter initiateSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--students
--)))|(((
--Liste der Studenten mit ihren Resultaten. Siehe unten.
--)))
--|(((
--optionalContentPackage
--)))|(((
--Optional. Content Package (gezippt) als Byte-Array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue initiateSite ===
--
--(% class="wrapped" %)
--|(((
--String
--)))|(((
--Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
--
--* sid: Session ID, wie von armSite zurück gegeben
--* uid: Student ID, wie in initiateSite beim Reporter angemeldet
--)))
--
--{{code language="xml"}}
--public class ResultsForStudent {
--   private String studentId = „";
--   private String firstname = „";
--   private String lastname = „";
--   private String groupname = „";
--   private String tutorname = „";
--   private File contentFile = null;
--   private byte[] resultsFile = null;
--}
--{{/code}}
--
--== Abmeldung durch LMS ==
--
--
--{{code}}
--@WebMethod(operationName = „disarmSite")
--public Boolean disarmSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--
--=== Parameter disarmSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue disarmSite ===
--
--(% class="wrapped" %)
--|(((
--Boolean
--)))|(((
--True bei Erfolg, sonst false.
--)))
--
--== Abfrage von Lernerresultaten durch LMS ==
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-parameter-name="title" class="xwiki-metadata-container">Abfrage von Lernerresultaten durch LMS
--)))
--
--{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
-- @WebMethod(operationName = „getResultValues")
--public HashMapWrapper getResultValues(
--   @WebParam(name = „version") final Integer version,
--   @WebParam(name = „sessionId") final String sessionId,
--   @WebParam(name = „secretToShare") final String secretToShare,
--   @WebParam(name = „requestedValues") final HashMap<String, String>
--        requestedValues,
--   @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultValues ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--requestedValues
--)))|(((
--Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultValues ===
--
--(% class="wrapped" %)
--|(((
--HashMap<String, String>
--)))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
--)))
--
--== Abfrage von Ergebnisvariablen durch LMS ==
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-parameter-name="title" class="xwiki-metadata-container">Abfrage von Ergebnisvariablen durch LMS
--)))
--
--{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
-- @WebMethod(operationName = „getResultVariables")
--public HashMapWrapper getResultVariables(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „contentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultVariables ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(((
--contentPackage
--)))|(((
--Content Package (gezippt) als Byte-Array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultVariables ===
--
--(% class="wrapped" %)
--|(((
--HashMap<String, String>
--)))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
--)))
--
--== Wrapper ==
--
--Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
--
--=== Wrapper für die HashMap<String, String> ===
--
--HashMapWrapper.java:
--
--[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--=== Wrapper für die ArrayList<ResultsForStudent> ===
--
--ResultsForStudentsWrapper.java:
--
--[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--)))
--
--{{layout-cell}}
--== Allgemeines ==
--
--Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
--
--(% class="wrapped" %)
--|(((
--armSite
--)))|(((
--Anmeldung von Folgerequests beim ONYX Reporter.
--)))
--|(((
--initiateSite
--)))|(((
--Initiiert die Reporter-Session (Übertragung des CPs).
--)))
--|(((
--disarmSite
--)))|(((
--Freigabe von allen Reporter-Ressourcen für diese Session.
--)))
--|(((
--getResultValues
--)))|(((
--Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--getResultVariables
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
--)))
--
--== Anmeldung des LMS ==
--
--{{code language="xml" title="Anmeldung des LMS"}}
--@WebMethod(operationName = „armSite")
--public String armSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „userId") final String userId,
--@WebParam(name = „optionalRole") final Integer role,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „optionalUserLastName") final String userLastName,
--@WebParam(name = „optionalUserFirstName") final String userFirstName,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter armSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(((
--userId
--)))|(((
--UserId des anfragenden Reporter-Benutzers
--)))
--|(((
--optionalRole
--)))|(((
--Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--optionalUserLastName
--)))|(((
--Optional. Nachname des Benutzers.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--optionalUserFirstName
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Optional. Vorname des Benutzers.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--additionalParams
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Reserved for future use.
--)))
--
--=== ReturnValue armSite ===
--
--(% class="wrapped" %)
--|(((
--String
--)))|(((
--Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
--)))
--
--== Initialisierung durch LMS ==
--
--{{code language="xml" title="Initialisierung durch LMS"}}
--@WebMethod(operationName = „initiateSite")
--public String initiateSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
--@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter initiateSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--students
--)))|(((
--Liste der Studenten mit ihren Resultaten. Siehe unten.
--)))
--|(((
--optionalContentPackage
--)))|(((
--Optional. Content Package (gezippt) als Byte-Array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue initiateSite ===
--
--(% class="wrapped" %)
--|(((
--String
--)))|(((
--Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
--
--* sid: Session ID, wie von armSite zurück gegeben
--* uid: Student ID, wie in initiateSite beim Reporter angemeldet
--)))
--
--{{code language="xml"}}
--public class ResultsForStudent {
--   private String studentId = „";
--   private String firstname = „";
--   private String lastname = „";
--   private String groupname = „";
--   private String tutorname = „";
--   private File contentFile = null;
--   private byte[] resultsFile = null;
--}
--{{/code}}
--
--== Abmeldung durch LMS ==
--
--
--{{code}}
--@WebMethod(operationName = „disarmSite")
--public Boolean disarmSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--
--=== Parameter disarmSite ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue disarmSite ===
--
--(% class="wrapped" %)
--|(((
--Boolean
--)))|(((
--True bei Erfolg, sonst false.
--)))
--
--== Abfrage von Lernerresultaten durch LMS ==
--
--{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
-- @WebMethod(operationName = „getResultValues")
--public HashMapWrapper getResultValues(
--   @WebParam(name = „version") final Integer version,
--   @WebParam(name = „sessionId") final String sessionId,
--   @WebParam(name = „secretToShare") final String secretToShare,
--   @WebParam(name = „requestedValues") final HashMap<String, String>
--        requestedValues,
--   @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultValues ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, wie von armSite zurück geliefert.
--)))
--|(((
--secretToShare
--)))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
--)))
--|(((
--requestedValues
--)))|(((
--Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultValues ===
--
--(% class="wrapped" %)
--|(((
--HashMap<String, String>
--)))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
--)))
--
--== Abfrage von Ergebnisvariablen durch LMS ==
--
--{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
-- @WebMethod(operationName = „getResultVariables")
--public HashMapWrapper getResultVariables(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „contentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultVariables ===
--
--(% class="wrapped" %)
--|(((
--version
--)))|(((
--Angefragte Version: 1
--)))
--|(((
--contentPackage
--)))|(((
--Content Package (gezippt) als Byte-Array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultVariables ===
--
--(% class="wrapped" %)
--|(((
--HashMap<String, String>
--)))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
--)))
--
--== Wrapper ==
--
--Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
--
--=== Wrapper für die HashMap<String, String> ===
--
--HashMapWrapper.java:
--
--[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--=== Wrapper für die ArrayList<ResultsForStudent> ===
--
--ResultsForStudentsWrapper.java:
--
--[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--{{/layout-cell}}
--)))
--
  {{layout-section ac:type="single"}}
  {{layout-cell}}
  == Allgemeines ==
@@ -944,6 +944,7 @@
  == Abmeldung durch LMS ==
++\\
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -955,6 +955,7 @@
  }
  {{/code}}
++\\
  === Parameter disarmSite ===
@@ -1092,103 +1092,73 @@
  HashMapWrapper.java:
--[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:HashMapWrapperjava.png]]
--[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:HashMapWrapperjava2.png]]
  === Wrapper für die ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:
--[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:ResultsForStudentsWrapperjava.png]]
  {{/layout-cell}}
  {{/layout-section}}
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--)))
--
--{{layout-cell}}
--
--{{/layout-cell}}
--
--(% data-xwiki-non-generated-content="java.util.List" %)
--(((
--" data-xwiki-wikimacrocontent="true" class="xwiki-metadata-container">
--
--====== relevante Links: ======
--
--* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--)))
--
--{{layout-cell}}
--====== relevante Links: ======
--
--* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--{{/layout-cell}}
--)))
--
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
++\\
  {{/layout-cell}}
  {{layout-cell}}
  ====== relevante Links: ======
--* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
++* [[doc:ONYX Player Interface]]
  {{/layout-cell}}
  {{/layout-section}}
--)))
++{{/layout}}
++{{/sv-translation}}
++{{sv-translation language="en"}}
  {{layout}}
--{{layout-section ac:type="two_right_sidebar"}}
++{{layout-section ac:type="two_equal"}}
  {{layout-cell}}
--
--{{/layout-cell}}
++====== Content: ======
--{{layout-cell}}
--{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--{{toc start="2"/}}
-- **Weitere Informationen:**
--* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--{{/panel}}
++{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
  {{/layout-cell}}
++
++{{layout-cell}}
++
++{{/layout-cell}}
  {{/layout-section}}
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--== Allgemeines ==
++== General information ==
--Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
++The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
--(% class="wrapped" %)
  |(((
  armSite
  )))|(((
--Anmeldung von Folgerequests beim ONYX Reporter.
++Registration of sequence requests at the ONYX Reporter
  )))
  |(((
  initiateSite
  )))|(((
--Initiiert die Reporter-Session (Übertragung des CPs).
++Initiates the Reporter session (transmission of the CP).
  )))
  |(((
  disarmSite
  )))|(((
--Freigabe von allen Reporter-Ressourcen für diese Session.
++Release of all Reporter resources for this session.
  )))
  |(((
  getResultValues
  )))|(((
--Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
++Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1195,12 +1195,12 @@
  getResultVariables
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
++Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
  )))
--== Anmeldung des LMS ==
++== Login through the LMS ==
--{{code language="xml" title="Anmeldung des LMS"}}
++{{code language="xml" title="Login through the LMS"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -1215,31 +1215,30 @@
  === Parameter armSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(((
  userId
  )))|(((
--UserId des anfragenden Reporter-Benutzers
++UserId of the requested Reporter user
  )))
  |(((
  optionalRole
  )))|(((
--Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
++Optional. User role. 0 = student, 1 = tutor
  )))
  |(((
  secretToShare
  )))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  optionalUserLastName
  )))|(((
--Optional. Nachname des Benutzers.
++Optional. Last name of the user.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1246,7 +1246,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. Vorname des Benutzers.
++Optional. First name of the user.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1258,16 +1258,15 @@
  === ReturnValue armSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
--Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
++Session ID which has to be used to mark any other Reporter call.
  )))
--== Initialisierung durch LMS ==
++== Initialisation through LMS ==
--{{code language="xml" title="Initialisierung durch LMS"}}
++{{code language="xml" title="Initialisation through LMS"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -1281,11 +1281,10 @@
  === Parameter initiateSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1292,22 +1292,22 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, wie von armSite zurück geliefert.
++SessionId, as returned by armSite.
  )))
  |(((
  secretToShare
  )))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  students
  )))|(((
--Liste der Studenten mit ihren Resultaten. Siehe unten.
++List of students and their results. See below.
  )))
  |(((
  optionalContentPackage
  )))|(((
--Optional. Content Package (gezippt) als Byte-Array.
++Optional. Content package (zipped) as byte array.
  )))
  |(((
  additionalParams
@@ -1317,15 +1317,16 @@
  === ReturnValue initiateSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
--Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
++Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
--* sid: Session ID, wie von armSite zurück gegeben
--* uid: Student ID, wie in initiateSite beim Reporter angemeldet
++* sid: Session ID, as returned by armSite
++* (((
++uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
  )))
++)))
  {{code language="xml"}}
  public class ResultsForStudent {
@@ -1339,8 +1339,9 @@
  }
  {{/code}}
--== Abmeldung durch LMS ==
++== Logout through the LMS ==
++
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -1352,14 +1352,14 @@
  }
  {{/code}}
++
  === Parameter disarmSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1366,12 +1366,12 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, wie von armSite zurück geliefert.
++SessionId, as returned by armSite.
  )))
  |(((
  secretToShare
  )))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  additionalParams
@@ -1381,16 +1381,15 @@
  === ReturnValue disarmSite ===
--(% class="wrapped" %)
  |(((
  Boolean
  )))|(((
--True bei Erfolg, sonst false.
++True in the case of success, otherwise false.
  )))
--== Abfrage von Lernerresultaten durch LMS ==
++== Request of learner results through the LMS ==
--{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
++{{code language="xml" title="Request of learner results through the LMS"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -1404,11 +1404,10 @@
  === Parameter getResultValues ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -1415,17 +1415,17 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, wie von armSite zurück geliefert.
++SessionId, as returned by armSite.
  )))
  |(((
  secretToShare
  )))|(((
--Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  requestedValues
  )))|(((
--Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
++Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
  )))
  |(((
  additionalParams
@@ -1435,16 +1435,15 @@
  === ReturnValue getResultValues ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
++Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
  )))
--== Abfrage von Ergebnisvariablen durch LMS ==
++== Request of result variables through the LMS ==
--{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
++{{code language="xml" title="Request of result variables through the LMS"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -1455,16 +1455,15 @@
  === Parameter getResultVariables ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(((
  contentPackage
  )))|(((
--Content Package (gezippt) als Byte-Array.
++Content package (zipped) as byte array.
  )))
  |(((
  additionalParams
@@ -1474,42 +1474,30 @@
  === ReturnValue getResultVariables ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
--Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
++Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
  )))
  == Wrapper ==
--Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
++Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
--=== Wrapper für die HashMap<String, String> ===
++=== Wrapper for HashMap<String, String> ===
  HashMapWrapper.java:
--[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:HashMapWrapperjava.png]]
--[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:HashMapWrapperjava2.png]]
--=== Wrapper für die ArrayList<ResultsForStudent> ===
++=== Wrapper for the ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:
--[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
++[[image:attach:ResultsForStudentsWrapperjava.png]]
  {{/layout-cell}}
  {{/layout-section}}
--
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--
--{{/layout-cell}}
--
--{{layout-cell}}
--====== relevante Links: ======
--
--* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
--{{/layout-cell}}
--{{/layout-section}}
  {{/layout}}
++{{/sv-translation}}

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht