Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 366.1 nach 367.1 Von 370.1 nach 371.1

Von Version 367.1

bearbeitet von sandra_riediger
am 18.12.2014

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

Auf Version 370.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

@@ -1,4 +2,3 @@
--{{sv-translation language="de"}}
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
@@ -378,354 +378,3 @@
  {{/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}}
--
--{{/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 @@
--3343039
++3342791

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht