Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 379.1 nach 380.1 Von 390.9 nach 390.10

Von Version 380.1

bearbeitet von sandra_riediger
am 17.12.2014

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

Auf Version 390.9

bearbeitet von Carina Enke
am 18.12.2023

Änderungskommentar: Renamed from xwiki:Hilfe.Systeminformationen.Schnittstelle ONYX Reporter.WebHome

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (3 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

Übergeordnete Seite

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

Dokument-Autor

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

Inhalt

@@ -1,39 +1,22 @@
  {{sv-translation language="de"}}
  {{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}{{/layout-cell}}
++{{/layout-section}}
++
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--====== Inhalt: ======
--
--
--
--{{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" %)ENTWURF
--)))
--|=(((
--Aufgaben
--)))|(((
--
++{{scroll-ignore}}
++{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
--
--)))
--|=(((
--JIRA
--)))|(((
--
--)))
++
++{{toc/}}
++{{/panel}}
++{{/scroll-ignore}}
  {{/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,7 @@
  == Abmeldung durch LMS ==
--
++\\
  {{code}}
  @WebMethod(operationName = „disarmSite")
@@ -222,10 +222,11 @@
  }
  {{/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,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> ===
@@ -368,13 +368,13 @@
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
++\\
  {{/layout-cell}}
  {{layout-cell}}
  ====== relevante Links: ======
--* [[doc:Schnittstelle ONYX WebPlayer]]
++* [[doc:ONYX Player Interface]]
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
@@ -388,7 +388,7 @@
--{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
++{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
  {{/layout-cell}}
  {{layout-cell}}
@@ -398,31 +398,29 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--
++== General information ==
--== General ==
++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" %)
  (((
@@ -429,12 +429,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,
@@ -457,22 +457,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" %)
  (((
@@ -479,7 +479,7 @@
  optionalUserFirstName
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--Optional. User firstname.
++Optional. First name of the user.
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -494,12 +494,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,
@@ -528,17 +528,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
@@ -551,11 +551,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
  )))
  )))
@@ -571,7 +571,7 @@
  }
  {{/code}}
--== Deconnection through the LMS ==
++== Logout through the LMS ==
@@ -604,7 +604,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
@@ -617,12 +617,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,
@@ -651,12 +651,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
@@ -669,12 +669,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,
@@ -706,13 +706,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> ===

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 @@
--3342937
++3342390

url

@@ -1,1 +1,1 @@
--https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/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ü