Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 366.1 nach 367.1 Von 378.1 nach 379.1

Von Version 367.1

bearbeitet von sandra_riediger
am 18.12.2014

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

Auf Version 378.1

bearbeitet von sandra_riediger
am 15.12.2014

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

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

@@ -6,7 +6,7 @@
--{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
++{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
  {{/layout-cell}}
  {{layout-cell}}
@@ -392,35 +392,60 @@
  {{/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 ==
++
--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 or all requested results for the test. Condition: there is exactly one student in list transmitted in the 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" %)
  (((
@@ -427,10 +427,10 @@
  getResultVariables
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
++Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
  )))
--== Connection to the LMS ==
++== Anmeldung des LMS ==
  {{code title="Anmeldung des LMS" language="xml"}}
  @WebMethod(operationName = „armSite")
@@ -450,27 +450,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
  )))|(((
--Shared secret. Has to remain identical for every communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  optionalUserLastName
  )))|(((
--Optional. User lastname.
++Optional. Nachname des Benutzers.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -477,7 +477,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. User firstname.
++Optional. Vorname des Benutzers.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -492,10 +492,10 @@
  |(((
  String
  )))|(((
--Session ID that has to be used to mark any further reporter call.
++Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
  )))
--== Initialisation through LMS ==
++== Initialisierung durch LMS ==
  {{code title="Initialisierung durch LMS" language="xml"}}
  @WebMethod(operationName = „initiateSite")
@@ -514,7 +514,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -521,22 +521,22 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every 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 with 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
@@ -549,13 +549,11 @@
  |(((
  String
  )))|(((
--Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
++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 {
@@ -569,7 +569,7 @@
  }
  {{/code}}
--== Deconnection through the LMS ==
++== Abmeldung durch LMS ==
@@ -590,7 +590,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -597,12 +597,12 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every communication.
++Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
  )))
  |(((
  additionalParams
@@ -615,10 +615,10 @@
  |(((
  Boolean
  )))|(((
--True if successful, otherwise false.
++True bei Erfolg, sonst false.
  )))
--== Request of learning results through the LMS ==
++== Abfrage von Lernerresultaten durch LMS ==
  {{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultValues")
@@ -637,7 +637,7 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -644,17 +644,17 @@
  sessionId
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--SessionId, as returned by armSite.
++SessionId, wie von armSite zurück geliefert.
  )))
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every 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, thus all result variables will be returned. If it contains keys, only those will be returned.
++Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
  )))
  |(((
  additionalParams
@@ -667,10 +667,10 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value the corresponding 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 title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
   @WebMethod(operationName = „getResultVariables")
@@ -686,12 +686,12 @@
  |(((
  version
  )))|(((
--Requested version: 1
++Angefragte Version: 1
  )))
  |(((
  contentPackage
  )))|(((
--Content package (zipped) as byte array.
++Content Package (gezippt) als Byte-Array.
  )))
  |(((
  additionalParams
@@ -704,15 +704,14 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value the corresponding
--value (HashMap is wrapped).
++Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
  )))
  == Wrapper ==
--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.
++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:
@@ -720,7 +720,7 @@
  [[image:attach:HashMapWrapperjava2.png]]
--=== Wrapper for the ArrayList<ResultsForStudent> ===
++=== Wrapper für die ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3343039
++3342793

url

@@ -1,1 +1,1 @@
--https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3343039/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