Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 362.1 nach 361.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 362.1

bearbeitet von sandra_riediger
am 15.12.2014

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

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.sandra_riediger

Inhalt

@@ -1,3 +1,4 @@
++{{sv-translation language="de"}}
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
@@ -60,9 +60,7 @@
  |(((
  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.
++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" %)
  (((
@@ -74,7 +74,8 @@
  == Anmeldung des LMS ==
--{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite")
++{{code title="Anmeldung des LMS" language="xml"}}
++@WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
  @WebParam(name = „userId") final String userId,
@@ -83,53 +83,674 @@
  @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
  )))|(((
--
++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 ===
++
++|(((
++String
++)))|(((
++Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
++)))
++
++== Initialisierung durch LMS ==
++
++{{code title="Initialisierung durch LMS" language="xml"}}
++@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
  )))
++|(% 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.
++)))
--= Ü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.
++|(((
++Boolean
++)))|(((
++True bei Erfolg, sonst false.
++)))
++
++== 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,
++   @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 title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
++ @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 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]]
++
++[[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}}
--====== untergeordnete Seiten: ======
++
++{{/layout-cell}}
++{{layout-cell}}
++====== relevante Links: ======
++* [[doc:Schnittstelle ONYX WebPlayer]]
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}
++{{/sv-translation}}
--{{children all="true"/}}
++{{sv-translation language="en"}}
++{{layout}}
++{{layout-section ac:type="two_equal"}}
++{{layout-cell}}
++====== Content: ======
++
++
++
++{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
  {{/layout-cell}}
  {{layout-cell}}
--====== relevante Links: ======
++|=(% colspan="1" %)(% colspan="1" %)
++(((
++Programmversion
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++
++)))
++|=(((
++Status
++)))|(((
++(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT
++)))
++|=(((
++Aufgaben
++)))|(((
++
--* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
++
++)))
++|=(((
++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:
++
++|(((
++armSite
++)))|(((
++Registration of sequence requests at the ONYX reporter
++)))
++|(((
++initiateSite
++)))|(((
++Initiates the reporter session (transmission of the CP).
++)))
++|(((
++disarmSite
++)))|(((
++Release of all reporter resources for this session.
++)))
++|(((
++getResultValues
++)))|(((
++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" %)
++(((
++getResultVariables
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
++)))
++
++== Connection to the LMS ==
++
++{{code title="Anmeldung des LMS" language="xml"}}
++@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
++)))|(((
++Requested version: 1
++)))
++|(((
++userId
++)))|(((
++UserId of the requested reporter user
++)))
++|(((
++optionalRole
++)))|(((
++Optional. User role. 0=student, 1=tutor
++)))
++|(((
++secretToShare
++)))|(((
++Shared secret. Has to remain identical for every communication.
++)))
++|(((
++optionalUserLastName
++)))|(((
++Optional. User lastname.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++optionalUserFirstName
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Optional. User firstname.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++additionalParams
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Reserved for future use.
++)))
++
++=== ReturnValue armSite ===
++
++|(((
++String
++)))|(((
++Session ID that has to be used to mark any further reporter call.
++)))
++
++== Initialisation through LMS ==
++
++{{code title="Initialisierung durch LMS" language="xml"}}
++@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
++)))|(((
++Shared secret. Has to remain identical at every communication.
++)))
++|(((
++students
++)))|(((
++List of students with 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 frame. It has to be enriched by the LMS with the following URLparameters:
++
++* 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}}
++
++== Deconnection 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
++)))|(((
++Shared secret. Has to remain identical at every communication.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
++
++=== ReturnValue disarmSite ===
++
++|(((
++Boolean
++)))|(((
++True if successful, otherwise false.
++)))
++
++== Request of learning 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,
++   @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
++)))|(((
++Requested version: 1
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++sessionId
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++SessionId, as returned by armSite.
++)))
++|(((
++secretToShare
++)))|(((
++Shared secret. Has to remain identical at every communication.
++)))
++|(((
++requestedValues
++)))|(((
++Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
++)))
++|(((
++additionalParams
++)))|(((
++Reserved for future use.
++)))
++
++=== ReturnValue getResultValues ===
++
++|(((
++HashMap<String, String>
++)))|(((
++Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
++)))
++
++== 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,
++@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 the corresponding
++value (HashMap is wrapped).
++)))
++
++== 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.
++
++=== 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
++3342826

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht