Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 351.1 nach 350.1 Von 370.1 nach 369.1

Von Version 369.1

bearbeitet von sandra_riediger
am 15.12.2014

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

Auf Version 351.1

bearbeitet von tleu
am 23.06.2015

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

Inhalt

@@ -1,3 +1,4 @@
++{{sv-translation language="de"}}
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
@@ -5,34 +5,11 @@
--{{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" %)ENTWURF
--)))
--|=(((
--Aufgaben
--)))|(((
--
--
--
--)))
--|=(((
--JIRA
--)))|(((
--
--)))
  {{/layout-cell}}
  {{/layout-section}}
@@ -72,7 +72,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,
@@ -137,7 +137,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,
@@ -209,7 +209,7 @@
  == Abmeldung durch LMS ==
--Abfrage von Lernerresultaten durch LMS
++
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -258,7 +258,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,
@@ -310,7 +310,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,
@@ -373,7 +373,358 @@
  {{layout-cell}}
  ====== relevante Links: ======
--* [[doc:Schnittstelle ONYX WebPlayer]]
++* [[doc:Schnittstelle ONYX Player]]
  {{/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}}
++== 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 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
++)))|(((
++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 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
++)))|(((
++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 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
++)))|(((
++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 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
++)))|(((
++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 @@
--3342789
++146964903

url

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht