Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 345.1 nach 344.1 Von 379.1 nach 378.1

Von Version 378.1

bearbeitet von sandra_riediger
am 15.12.2014

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

Auf Version 345.1

bearbeitet von Carina Enke
am 08.03.2018

Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

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

Inhalt

@@ -1,5 +1,9 @@
  {{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: ======
@@ -6,34 +6,11 @@
--{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
++{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
  {{/layout-cell}}
  {{layout-cell}}
--|=(% colspan="1" %)(% colspan="1" %)
--(((
--Programmversion
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--)))
--|=(((
--Status
--)))|(((
--(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
--)))
--|=(((
--Aufgaben
--)))|(((
--
--
--
--)))
--|=(((
--JIRA
--)))|(((
--
--)))
  {{/layout-cell}}
  {{/layout-section}}
@@ -73,7 +73,7 @@
  == Anmeldung des LMS ==
--{{code title="Anmeldung des LMS" language="xml"}}
++{{code language="xml" title="Anmeldung des LMS"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -138,7 +138,7 @@
  == Initialisierung durch LMS ==
--{{code title="Initialisierung durch LMS" language="xml"}}
++{{code language="xml" title="Initialisierung durch LMS"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -259,7 +259,7 @@
  == Abfrage von Lernerresultaten durch LMS ==
--{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
++{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -311,7 +311,7 @@
  == Abfrage von Ergebnisvariablen durch LMS ==
--{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
++{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -348,7 +348,7 @@
  == Wrapper ==
--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.
++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> ===
@@ -374,7 +374,7 @@
  {{layout-cell}}
  ====== relevante Links: ======
--* [[doc:Schnittstelle ONYX WebPlayer]]
++* [[doc:ONYX Player Interface]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
@@ -388,64 +388,39 @@
--{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
++{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
  {{/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 ==
--== Allgemeines ==
++The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
--Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
--
  |(((
  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 or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -452,12 +452,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 or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
  )))
--== Anmeldung des LMS ==
++== Connection to the LMS ==
--{{code title="Anmeldung des LMS" language="xml"}}
++{{code language="xml" title="Anmeldung des LMS"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -475,27 +475,27 @@
  |(((
  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.
++Shared secret. Has to remain identical for every communication.
  )))
  |(((
  optionalUserLastName
  )))|(((
--Optional. Nachname des Benutzers.
++Optional. User lastname.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -502,7 +502,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. Vorname des Benutzers.
++Optional. User firstname.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -517,12 +517,12 @@
  |(((
  String
  )))|(((
--Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
++Session ID that has to be used to mark any further reporter call.
  )))
--== Initialisierung durch LMS ==
++== Initialisation through LMS ==
--{{code title="Initialisierung durch LMS" language="xml"}}
++{{code language="xml" title="Initialisierung durch LMS"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -539,7 +539,7 @@
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -546,22 +546,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.
++Shared secret. Has to remain identical at every communication.
  )))
  |(((
  students
  )))|(((
--Liste der Studenten mit ihren Resultaten. Siehe unten.
++List of students with their results. See below.
  )))
  |(((
  optionalContentPackage
  )))|(((
--Optional. Content Package (gezippt) als Byte-Array.
++Optional. Content Package (zipped) as byte array.
  )))
  |(((
  additionalParams
@@ -574,11 +574,13 @@
  |(((
  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 frame. It has to be enriched by the LMS with the following URLparameters:
--* 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 {
@@ -592,7 +592,7 @@
  }
  {{/code}}
--== Abmeldung durch LMS ==
++== Deconnection through the LMS ==
@@ -613,7 +613,7 @@
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -620,12 +620,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.
++Shared secret. Has to remain identical at every communication.
  )))
  |(((
  additionalParams
@@ -638,12 +638,12 @@
  |(((
  Boolean
  )))|(((
--True bei Erfolg, sonst false.
++True if successful, otherwise false.
  )))
--== Abfrage von Lernerresultaten durch LMS ==
++== Request of learning results through the LMS ==
--{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
++{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -660,7 +660,7 @@
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -667,17 +667,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.
++Shared secret. Has to remain identical at every 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, thus all result variables will be returned. If it contains keys, only those will be returned.
  )))
  |(((
  additionalParams
@@ -690,12 +690,12 @@
  |(((
  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 the corresponding value (HashMap is wrapped)
  )))
--== Abfrage von Ergebnisvariablen durch LMS ==
++== Request of result variables through the LMS ==
--{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
++{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -709,12 +709,12 @@
  |(((
  version
  )))|(((
--Angefragte Version: 1
++Requested version: 1
  )))
  |(((
  contentPackage
  )))|(((
--Content Package (gezippt) als Byte-Array.
++Content package (zipped) as byte array.
  )))
  |(((
  additionalParams
@@ -727,14 +727,15 @@
  |(((
  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 the corresponding
++value (HashMap is wrapped).
  )))
  == Wrapper ==
--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.
++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.
--=== Wrapper für die HashMap<String, String> ===
++=== Wrapper for HashMap<String, String> ===
  HashMapWrapper.java:
@@ -742,7 +742,7 @@
  [[image:attach:HashMapWrapperjava2.png]]
--=== Wrapper für die ArrayList<ResultsForStudent> ===
++=== Wrapper for the ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3342793
++147882402

url

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht