Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 379.1 nach 378.1 Von 390.7 nach 390.6

Von Version 390.6

bearbeitet von Carina Enke
am 18.12.2023

Änderungskommentar: Update document after refactoring.

Auf Version 379.1

bearbeitet von sandra_riediger
am 15.12.2014

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

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (3 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

Übergeordnete Seite

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

Dokument-Autor

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

Inhalt

@@ -1,22 +1,39 @@
  {{sv-translation language="de"}}
  {{layout}}
--{{layout-section ac:type="single"}}
--{{layout-cell}}{{/layout-cell}}
--{{/layout-section}}
--
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--\\
++====== Inhalt: ======
++
++
++
++{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
  {{/layout-cell}}
  {{layout-cell}}
--{{scroll-ignore}}
--{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
++|=(% colspan="1" %)(% colspan="1" %)
++(((
++Programmversion
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|=(((
++Status
++)))|(((
++(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
++)))
++|=(((
++Aufgaben
++)))|(((
++
--
--{{toc/}}
--{{/panel}}
--{{/scroll-ignore}}
++
++)))
++|=(((
++JIRA
++)))|(((
++
++)))
  {{/layout-cell}}
  {{/layout-section}}
@@ -26,7 +26,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
  )))|(((
@@ -57,7 +57,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,
@@ -72,7 +72,6 @@
  === Parameter armSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -115,7 +115,6 @@
  === ReturnValue armSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -124,7 +124,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,
@@ -138,7 +138,6 @@
  === Parameter initiateSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -174,7 +174,6 @@
  === ReturnValue initiateSite ===
--(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -198,7 +198,7 @@
  == Abmeldung durch LMS ==
--\\
++
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -210,11 +210,10 @@
  }
  {{/code}}
--\\
++
  === Parameter disarmSite ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -240,7 +240,6 @@
  === ReturnValue disarmSite ===
--(% class="wrapped" %)
  |(((
  Boolean
  )))|(((
@@ -249,7 +249,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,
@@ -263,7 +263,6 @@
  === Parameter getResultValues ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -294,7 +294,6 @@
  === ReturnValue getResultValues ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -303,7 +303,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,
@@ -314,7 +314,6 @@
  === Parameter getResultVariables ===
--(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -333,7 +333,6 @@
  === ReturnValue getResultVariables ===
--(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -342,7 +342,7 @@
  == 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> ===
@@ -362,13 +362,13 @@
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--\\
++
  {{/layout-cell}}
  {{layout-cell}}
  ====== relevante Links: ======
--* [[doc:ONYX Player Interface]]
++* [[doc:Schnittstelle ONYX WebPlayer]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
@@ -382,39 +382,64 @@
--{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
++{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
  {{/layout-cell}}
  {{layout-cell}}
++|=(% colspan="1" %)(% colspan="1" %)
++(((
++Programmversion
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++)))
++|=(((
++Status
++)))|(((
++(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT
++)))
++|=(((
++Aufgaben
++)))|(((
++
++
++
++)))
++|=(((
++JIRA
++)))|(((
++
++)))
  {{/layout-cell}}
  {{/layout-section}}
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--== General information ==
++
--The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
++== Allgemeines ==
++Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
++
  |(((
  armSite
  )))|(((
--Registration of sequence requests at the ONYX Reporter
++Anmeldung von Folgerequests beim ONYX Reporter.
  )))
  |(((
  initiateSite
  )))|(((
--Initiates the Reporter session (transmission of the CP).
++Initiiert die Reporter-Session (Übertragung des CPs).
  )))
  |(((
  disarmSite
  )))|(((
--Release of all Reporter resources for this session.
++Freigabe von allen Reporter-Ressourcen für diese Session.
  )))
  |(((
  getResultValues
  )))|(((
--Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
++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" %)
  (((
@@ -421,12 +421,12 @@
  getResultVariables
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
++Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
  )))
--== Login through the LMS ==
++== Anmeldung des LMS ==
--{{code language="xml" title="Login through the LMS"}}
++{{code title="Anmeldung des LMS" language="xml"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -444,27 +444,27 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(((
  userId
  )))|(((
--UserId of the requested Reporter user
++UserId des anfragenden Reporter-Benutzers
  )))
  |(((
  optionalRole
  )))|(((
--Optional. User role. 0 = student, 1 = tutor
++Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
  )))
  |(((
  secretToShare
  )))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  optionalUserLastName
  )))|(((
--Optional. Last name of the user.
++Optional. Nachname des Benutzers.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -471,7 +471,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. First name of the user.
++Optional. Vorname des Benutzers.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -486,12 +486,12 @@
  |(((
  String
  )))|(((
--Session ID which has to be used to mark any other Reporter call.
++Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
  )))
--== Initialisation through LMS ==
++== Initialisierung durch LMS ==
--{{code language="xml" title="Initialisation through LMS"}}
++{{code title="Initialisierung durch LMS" language="xml"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -508,7 +508,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -515,22 +515,22 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  students
  )))|(((
--List of students and their results. See below.
++Liste der Studenten mit ihren Resultaten. Siehe unten.
  )))
  |(((
  optionalContentPackage
  )))|(((
--Optional. Content package (zipped) as byte array.
++Optional. Content Package (gezippt) als Byte-Array.
  )))
  |(((
  additionalParams
@@ -543,13 +543,11 @@
  |(((
  String
  )))|(((
--Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
++Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
--* sid: Session ID, as returned by armSite
--* (((
--uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
++* sid: Session ID, wie von armSite zurück gegeben
++* uid: Student ID, wie in initiateSite beim Reporter angemeldet
  )))
--)))
  {{code language="xml"}}
  public class ResultsForStudent {
@@ -563,7 +563,7 @@
  }
  {{/code}}
--== Logout through the LMS ==
++== Abmeldung durch LMS ==
@@ -584,7 +584,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -591,12 +591,12 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  additionalParams
@@ -609,12 +609,12 @@
  |(((
  Boolean
  )))|(((
--True in the case of success, otherwise false.
++True bei Erfolg, sonst false.
  )))
--== Request of learner results through the LMS ==
++== Abfrage von Lernerresultaten durch LMS ==
--{{code language="xml" title="Request of learner results through the LMS"}}
++{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -631,7 +631,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -638,17 +638,17 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  requestedValues
  )))|(((
--Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
++Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
  )))
  |(((
  additionalParams
@@ -661,12 +661,12 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
++Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
  )))
--== Request of result variables through the LMS ==
++== Abfrage von Ergebnisvariablen durch LMS ==
--{{code language="xml" title="Request of result variables through the LMS"}}
++{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -680,12 +680,12 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(((
  contentPackage
  )))|(((
--Content package (zipped) as byte array.
++Content Package (gezippt) als Byte-Array.
  )))
  |(((
  additionalParams
@@ -698,14 +698,14 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
++Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
  )))
  == Wrapper ==
--Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
++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 for HashMap<String, String> ===
++=== Wrapper für die HashMap<String, String> ===
  HashMapWrapper.java:
@@ -713,7 +713,7 @@
  [[image:attach:HashMapWrapperjava2.png]]
--=== Wrapper for the ArrayList<ResultsForStudent> ===
++=== Wrapper für die ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:

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
++3342793

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/3342793/Schnittstelle ONYX Reporter

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht