Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 382.1 nach 383.1 Von 398.1 nach 399.1

Von Version 383.1

bearbeitet von sandra_riediger
am 15.12.2014

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

Auf Version 398.1

bearbeitet von Carina Enke
am 13.02.2024

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

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--Schnittstelle ONYX Reporter
++10 Schnittstelle ONYX Reporter

Übergeordnete Seite

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

Dokument-Autor

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

Inhalt

@@ -1,39 +2,17 @@
--{{sv-translation language="de"}}
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--====== Inhalt: ======
--
--
--
--{{toc maxLevel="5" style="square" 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" %)ENTWURF
--)))
--|=(((
--Aufgaben
--)))|(((
--
++{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
++{{toc start="2"/}}
--
--)))
--|=(((
--JIRA
--)))|(((
--
--)))
++ **Weitere Informationen:**
++
++* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
++{{/panel}}
  {{/layout-cell}}
  {{/layout-section}}
@@ -43,6 +43,7 @@
  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
++(% class="wrapped" %)
  |(((
  armSite
  )))|(((
@@ -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,
@@ -88,6 +88,7 @@
  === Parameter armSite ===
++(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -130,6 +130,7 @@
  === ReturnValue armSite ===
++(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -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,
@@ -152,6 +152,7 @@
  === Parameter initiateSite ===
++(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -187,6 +187,7 @@
  === ReturnValue initiateSite ===
++(% class="wrapped" %)
  |(((
  String
  )))|(((
@@ -210,7 +210,6 @@
  == Abmeldung durch LMS ==
--
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -222,10 +222,10 @@
  }
  {{/code}}
--
  === Parameter disarmSite ===
++(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -251,6 +251,7 @@
  === ReturnValue disarmSite ===
++(% class="wrapped" %)
  |(((
  Boolean
  )))|(((
@@ -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,
@@ -273,6 +273,7 @@
  === Parameter getResultValues ===
++(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -303,6 +303,7 @@
  === ReturnValue getResultValues ===
++(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -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,
@@ -322,6 +322,7 @@
  === Parameter getResultVariables ===
++(% class="wrapped" %)
  |(((
  version
  )))|(((
@@ -340,6 +340,7 @@
  === ReturnValue getResultVariables ===
++(% class="wrapped" %)
  |(((
  HashMap<String, String>
  )))|(((
@@ -348,21 +348,21 @@
  == 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> ===
  HashMapWrapper.java:
--[[image:attach:HashMapWrapperjava.png]]
++[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--[[image:attach:HashMapWrapperjava2.png]]
++[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
  === Wrapper für die ArrayList<ResultsForStudent> ===
  ResultsForStudentsWrapper.java:
--[[image:attach:ResultsForStudentsWrapperjava.png]]
++[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
  {{/layout-cell}}
  {{/layout-section}}
@@ -374,383 +374,7 @@
  {{layout-cell}}
  ====== relevante Links: ======
--* [[doc:Schnittstelle ONYX WebPlayer]]
++* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
--{{/sv-translation}}
--
--{{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}}
--|=(% colspan="1" %)(% colspan="1" %)
--(((
--Programmversion
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--
--)))
--|=(((
--Status
--)))|(((
--(% class="status-macro aui-lozenge aui-lozenge-error" %)DONE
--)))
--|=(((
--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:
--
--|(((
--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}}

HashMapWrapperjava.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Größe

...	...	@@ -1,0 +1,1 @@
	1	+135.3 KB

Inhalt

HashMapWrapperjava2.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Größe

...	...	@@ -1,0 +1,1 @@
	1	+187.3 KB

Inhalt

ResultsForStudentsWrapperjava.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Größe

...	...	@@ -1,0 +1,1 @@
	1	+83.3 KB

Inhalt

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3342922
++3342390

url

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht