Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 389.1 nach 388.1 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 389.1

bearbeitet von tleu
am 01.12.2014

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

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (4 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 0 hinzugefügt, 3 gelöscht)
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
- Confluence.Code.ConfluencePageClass[0]

Details

Seiteneigenschaften

Titel

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

Übergeordnete Seite

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

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.carina
++XWiki.tleu

Inhalt

@@ -1,1168 +1,41 @@
--(% 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">
--
--(% 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}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
--{{/layout-cell}}
++====== Inhalt: ======
--{{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 style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
  {{/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" %)
++|=(% colspan="1" %)(% colspan="1" %)
  (((
--getResultVariables
++Programmversion
  )))|(% 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
++|=(((
++Status
  )))|(((
--Angefragte Version: 1
++(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
  )))
--|(((
--userId
++|=(((
++Aufgaben
  )))|(((
--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
++|=(((
++JIRA
  )))|(((
--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 ==
--
--Ü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}}
--
--(% 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]]
--{{/layout-cell}}
  {{/layout-section}}
--)))
--{{layout}}
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--
--{{/layout-cell}}
--
--{{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}}
--
  {{layout-section ac:type="single"}}
  {{layout-cell}}
  == Allgemeines ==
@@ -1169,7 +1169,6 @@
  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
--(% class="wrapped" %)
  |(((
  armSite
  )))|(((
@@ -1200,7 +1200,7 @@
  == Anmeldung des LMS ==
--{{code language="xml" title="Anmeldung des LMS"}}
++{{code title="Anmeldung des LMS" language="xml"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -1215,7 +1215,6 @@
  === Parameter armSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -1258,7 +1258,6 @@
  === ReturnValue armSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -1267,7 +1267,7 @@
  == Initialisierung durch LMS ==
--{{code language="xml" title="Initialisierung durch LMS"}}
++{{code title="Initialisierung durch LMS" language="xml"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -1281,7 +1281,6 @@
  === Parameter initiateSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -1317,7 +1317,6 @@
  === ReturnValue initiateSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -1341,21 +1341,10 @@
  == Abmeldung durch LMS ==
++Abfrage von Lernerresultaten 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
  )))|(((
@@ -1381,7 +1381,6 @@
  === ReturnValue disarmSite ===
--(% class="wrapped" %)
  |(((
  Boolean
  )))|(((
@@ -1390,7 +1390,7 @@
  == Abfrage von Lernerresultaten durch LMS ==
--{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
++{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -1404,7 +1404,6 @@
  === Parameter getResultValues ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -1435,7 +1435,6 @@
  === ReturnValue getResultValues ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -1444,7 +1444,7 @@
  == Abfrage von Ergebnisvariablen durch LMS ==
--{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
++{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -1455,7 +1455,6 @@
  === Parameter getResultVariables ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -1474,7 +1474,6 @@
  === ReturnValue getResultVariables ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -1483,21 +1483,21 @@
  == Wrapper ==
--Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
++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.
  === 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: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}}
@@ -1509,7 +1509,7 @@
  {{layout-cell}}
  ====== relevante Links: ======
--* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
++* [[doc:Schnittstelle ONYX WebPlayer]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}

HashMapWrapperjava.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.XWikiGuest

Größe

...	...	@@ -1,1 +1,0 @@
1		-135.3 KB

Inhalt

HashMapWrapperjava2.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.XWikiGuest

Größe

...	...	@@ -1,1 +1,0 @@
1		-187.3 KB

Inhalt

ResultsForStudentsWrapperjava.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.XWikiGuest

Größe

...	...	@@ -1,1 +1,0 @@
1		-83.3 KB

Inhalt

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3342390
++3342787

url

@@ -1,1 +1,1 @@
--https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter
++https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342787/Schnittstelle ONYX Reporter

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht