Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 341.1 nach 340.1 Von 357.1 nach 356.1

Von Version 356.1

bearbeitet von tleu
am 11.03.2015

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

Auf Version 341.1

bearbeitet von Carina Enke
am 15.10.2018

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

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,5 +1,16 @@
  {{sv-translation language="de"}}
  {{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++
++
++(% class="removedPlaceholderWrapper" %)
++
++
++
++{{/layout-cell}}
++{{/layout-section}}
++
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
  ====== Inhalt: ======
@@ -6,34 +6,11 @@
--{{toc maxLevel="5" style="square" 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}}
@@ -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,
@@ -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,
@@ -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,
@@ -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,
@@ -348,7 +348,7 @@
  == 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> ===
@@ -388,7 +388,7 @@
--{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
++{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
  {{/layout-cell}}
  {{layout-cell}}
@@ -398,29 +398,29 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--== General ==
++== General information ==
--The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
++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
++Registration of sequence requests at the ONYX Reporter
  )))
  |(((
  initiateSite
  )))|(((
--Initiates the reporter session (transmission of the CP).
++Initiates the Reporter session (transmission of the CP).
  )))
  |(((
  disarmSite
  )))|(((
--Release of all reporter resources for this session.
++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.
++Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -427,12 +427,12 @@
  getResultVariables
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
++Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
  )))
--== Connection to the LMS ==
++== Login through the LMS ==
--{{code title="Anmeldung des LMS" language="xml"}}
++{{code language="xml" title="Login through the LMS"}}
  @WebMethod(operationName = „armSite")
  public String armSite(
  @WebParam(name = „version") final Integer version,
@@ -455,22 +455,22 @@
  |(((
  userId
  )))|(((
--UserId of the requested reporter user
++UserId of the requested Reporter user
  )))
  |(((
  optionalRole
  )))|(((
--Optional. User role. 0=student, 1=tutor
++Optional. User role. 0 = student, 1 = tutor
  )))
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical for every communication.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  optionalUserLastName
  )))|(((
--Optional. User lastname.
++Optional. Last name of the user.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -477,7 +477,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. User firstname.
++Optional. First name of the user.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -492,12 +492,12 @@
  |(((
  String
  )))|(((
--Session ID that has to be used to mark any further reporter call.
++Session ID which has to be used to mark any other Reporter call.
  )))
  == Initialisation through LMS ==
--{{code title="Initialisierung durch LMS" language="xml"}}
++{{code language="xml" title="Initialisation through LMS"}}
  @WebMethod(operationName = „initiateSite")
  public String initiateSite(
  @WebParam(name = „version") final Integer version,
@@ -526,17 +526,17 @@
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every communication.
++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 with their results. See below.
++List of students and their results. See below.
  )))
  |(((
  optionalContentPackage
  )))|(((
--Optional. Content Package (zipped) as byte array.
++Optional. Content package (zipped) as byte array.
  )))
  |(((
  additionalParams
@@ -549,11 +549,11 @@
  |(((
  String
  )))|(((
--Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
++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
++* sid: Session ID, as returned by armSite
  * (((
--uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
++uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
  )))
  )))
@@ -569,7 +569,7 @@
  }
  {{/code}}
--== Deconnection through the LMS ==
++== Logout through the LMS ==
@@ -602,7 +602,7 @@
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every communication.
++A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
  )))
  |(((
  additionalParams
@@ -615,12 +615,12 @@
  |(((
  Boolean
  )))|(((
--True if successful, otherwise false.
++True in the case of success, otherwise false.
  )))
--== Request of learning results through the LMS ==
++== Request of learner results through the LMS ==
--{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
++{{code language="xml" title="Request of learner results through the LMS"}}
   @WebMethod(operationName = „getResultValues")
  public HashMapWrapper getResultValues(
     @WebParam(name = „version") final Integer version,
@@ -649,12 +649,12 @@
  |(((
  secretToShare
  )))|(((
--Shared secret. Has to remain identical at every communication.
++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, thus all result variables will be returned. If it contains keys, only those will be returned.
++Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
  )))
  |(((
  additionalParams
@@ -667,12 +667,12 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
++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 title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
++{{code language="xml" title="Request of result variables through the LMS"}}
   @WebMethod(operationName = „getResultVariables")
  public HashMapWrapper getResultVariables(
  @WebParam(name = „version") final Integer version,
@@ -704,13 +704,12 @@
  |(((
  HashMap<String, String>
  )))|(((
--Map of result variables, key is the variable name, value the corresponding
--value (HashMap is wrapped).
++Map of result variables, key is the variable name, value is the respective variable's 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.
++Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
  === Wrapper for HashMap<String, String> ===

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--6919009
++182518281

url

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

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht