Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 279.1 nach 278.1 Von 376.1 nach 375.1

Von Version 375.1

bearbeitet von tleu
am 01.12.2014

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

Auf Version 279.1

bearbeitet von Carina Enke
am 08.05.2019

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

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.tleu
++XWiki.carina

Inhalt

@@ -1,68 +1,409 @@
++{{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: ======
++
++{{/layout-cell}}
++{{layout-cell}}
++{{scroll-ignore}}
++{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
++{{toc/}}
++{{/panel}}
++{{/scroll-ignore}}
  {{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
  {{layout-cell}}
--|=(% colspan="1" %)(% colspan="1" %)
++== Allgemeines ==
++
++Ü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.
++)))
++|(((
++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" %)
  (((
--Programmversion
++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.
  )))
--|=(((
--Status
++
++== 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 ===
++
++|(((
++version
  )))|(((
--(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
++Angefragte Version: 1
  )))
--|=(((
--Aufgaben
++|(((
++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 ===
++
++|(((
++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 ===
++
++|(((
++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 ===
++
++|(((
++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 ===
++
++|(((
++version
++)))|(((
++Angefragte Version: 1
  )))
--|=(((
--JIRA
++|(% 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 ===
++
++|(((
++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 ===
++
++|(((
++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 ===
++
++|(((
++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 ===
++
++|(((
++version
++)))|(((
++Angefragte Version: 1
++)))
++|(((
++contentPackage
++)))|(((
++Content Package (gezippt) als Byte-Array.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
++
++=== ReturnValue getResultVariables ===
++
++|(((
++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]]
++
++[[image:attach:HashMapWrapperjava2.png]]
++
++=== Wrapper für die ArrayList<ResultsForStudent> ===
++
++ResultsForStudentsWrapper.java:
++
++[[image:attach:ResultsForStudentsWrapperjava.png]]
  {{/layout-cell}}
  {{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
++
++{{/layout-cell}}
++
++{{layout-cell}}
++====== relevante Links: ======
++
++* [[doc:ONYX Player Interface]]
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}
++{{/sv-translation}}
++
++{{sv-translation language="en"}}
++{{layout}}
++{{layout-section ac:type="two_equal"}}
++{{layout-cell}}
++====== Content: ======
++
++
++
++{{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:
  |(((
  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" %)
  (((
@@ -69,12 +69,13 @@
  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 title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite")
++{{code language="xml" title="Login through the LMS"}}
++@WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
  @WebParam(name = „userId") final String userId,
@@ -83,53 +83,289 @@
  @WebParam(name = „optionalUserLastName") final String userLastName,
  @WebParam(name = „optionalUserFirstName") final String userFirstName,
  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}{{/code}}Parameter armSite
++}
++{{/code}}
++=== Parameter armSite ===
++
  |(((
--
++version
  )))|(((
--
++Requested version: 1
  )))
  |(((
--
++userId
  )))|(((
--
++UserId of the requested Reporter user
  )))
  |(((
--
++optionalRole
  )))|(((
--
++Optional. User role. 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.
  )))
  |(((
--
++optionalUserLastName
  )))|(((
++Optional. Last name of the user.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++optionalUserFirstName
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Optional. First name of the user.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++additionalParams
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Reserved for future use.
++)))
++
++=== ReturnValue armSite ===
++
++|(((
++String
++)))|(((
++Session ID which has to be used to mark any other Reporter call.
++)))
++
++== Initialisation through LMS ==
++
++{{code language="xml" title="Initialisation through 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 ===
++
++|(((
++version
++)))|(((
++Requested version: 1
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++sessionId
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++SessionId, as returned by armSite.
++)))
++|(((
++secretToShare
++)))|(((
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++)))
++|(((
++students
++)))|(((
++List of students and their results. See below.
++)))
++|(((
++optionalContentPackage
++)))|(((
++Optional. Content package (zipped) as byte array.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
++
++=== ReturnValue initiateSite ===
++
++|(((
++String
++)))|(((
++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, as returned by armSite
++* (((
++uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
++)))
++)))
++
++{{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}}
++
++== Logout through the 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 ===
++
++|(((
++version
++)))|(((
++Requested version: 1
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++sessionId
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++SessionId, as returned by armSite.
++)))
++|(((
++secretToShare
++)))|(((
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
--= Überschrift2 =
++=== ReturnValue disarmSite ===
--Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.
--{{/layout-cell}}
--{{/layout-section}}
++|(((
++Boolean
++)))|(((
++True in the case of success, otherwise false.
++)))
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--====== untergeordnete Seiten: ======
++== Request of learner results through the LMS ==
++{{code language="xml" title="Request of learner results through the 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 ===
--{{children all="true"/}}
--{{/layout-cell}}
++|(((
++version
++)))|(((
++Requested version: 1
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++sessionId
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++SessionId, as returned by armSite.
++)))
++|(((
++secretToShare
++)))|(((
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
++)))
++|(((
++requestedValues
++)))|(((
++Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
--{{layout-cell}}
--====== relevante Links: ======
++=== ReturnValue getResultValues ===
--* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
++|(((
++HashMap<String, String>
++)))|(((
++Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
++)))
++
++== Request of result variables through the LMS ==
++
++{{code language="xml" title="Request of result variables through the 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 ===
++
++|(((
++version
++)))|(((
++Requested version: 1
++)))
++|(((
++contentPackage
++)))|(((
++Content package (zipped) as byte array.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
++
++=== ReturnValue getResultVariables ===
++
++|(((
++HashMap<String, String>
++)))|(((
++Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
++)))
++
++== Wrapper ==
++
++Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
++
++=== Wrapper for HashMap<String, String> ===
++
++HashMapWrapper.java:
++
++[[image:attach:HashMapWrapperjava.png]]
++
++[[image:attach:HashMapWrapperjava2.png]]
++
++=== Wrapper for the ArrayList<ResultsForStudent> ===
++
++ResultsForStudentsWrapper.java:
++
++[[image:attach:ResultsForStudentsWrapperjava.png]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
++{{/sv-translation}}

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3342392
++226231103

url

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht