ONYX Player Interface

)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)

65

(((

66

{{sv-metadata default-text="Workflow Status" type="workflow-status"/}}

67

)))

68

|=(% colspan="1" %)(% colspan="1" %)

69

(((

70

Varianten

71

)))|(% colspan="1" %)(% colspan="1" %)

(((

)))

|=(% colspan="1" %)(% colspan="1" %)

76

(((

77

Attribute

78

)))|(% colspan="1" %)(% colspan="1" %)

(((

)))

|=(% colspan="1" %)(% colspan="1" %)

83

(((

84

Pagekey

85

)))|(% colspan="1" %)(% colspan="1" %)

(((

)))

|=(% colspan="1" %)(% colspan="1" %)

90

(((

91

Autorenbemerkung

92

)))|(% colspan="1" %)(% colspan="1" %)

(((

)))

== Allgemeines ==

Der ONYX Player definiert einen WebService. Dieser ist über die URL **<ONYXWebPlayer-URL>/onyx/onyxexamservices** erreichbar.

109

110

Link zur WSDL der öffentlichen Demo-Runtime: (% class="nolink" %)**http:~/~/demo.bps-system.de/onyx/onyxexamservices?wsdl**

111

112

== Anmeldung eines Tests ==

113

114

Bevor Teilnehmer Tests belegen können, müssen diese zuerst bei ONYX angemeldet werden.

115

116

117

@WebMethod(operationName = „registerTest")

118

public Long registerTest(

119

@WebParam(name = „testSessionId") final Long testSessionId,

120

@WebParam(name = „providerId") final String providerId,

121

@WebParam(name = „contentPackage") final byte[] contentPackage,

122

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter registerTest ===

|(((

testSessionId

)))|(((

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für diesen Test

darstellt.

)))

|(((

providerId

)))|(((

Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.

)))

|(((

contentPackage

)))|(((

Das IMS QTI v2.1 CP (ZIP-File als byte-Array).

)))

|(((

parameters

)))|(((

Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden ([[registerStudent>>doc:||anchor="AnmeldungeinesStudenten"]]).

149

150

Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.

151

152

153

Seit der ONYX Version 5.15 lässt sich die Feedback- und Auswertungsanzeige für den Teilnehmer während der Testdurchführung genauer steuern. Für diese Funktionalität wurde die Schnittstelle angepasst. Eine detaillierte Beschreibung der Funktionalität aus Anwendersicht bietet der Abschnitt "[[doc:Konfiguration der Testdurchfuehrung]]"(% class="error" %) (%%).

154

155

156

* showSolution [true|**false**] Soll dem Nutzer die korrekte Antwort anzeigbar sein?

157

* isSynchronized [true|**false**] Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?

158

* (((

159

continuationAllowed [true|**false**] Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.

160

)))

161

* suspendAllowed [true|**false**] Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.

162

* Templateid: Derzeit einzig unterstützt: onyxwithoutnav – führt zur Nichtanzeige des Navigationsbaumes.

163

* dontShowItemTitles (% class="error" %)[true|**false**]: Sollen die Titel der Aufgaben nicht angezeigt werden?

Folgende Parameter sind seit **ONYX Version** **5.15** verfügbar:

168

169

170

* testShowScore [**true**|false] Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche alle ermittelten Punktwerte, wie die Gesamtpunktzahl des Tests und ggf. Punkte pro Testabschnitt, (nicht) enthält.

171

* testShowPassed (% class="error" %)[true|false](%%) Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, die die Information (nicht) enthält, ob der Test bestanden wurde. Standard ist der in testShowScore gegebene Wert bzw. dessen Standard.

172

* testShowFeedback [**true**|false] Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.

173

* itemShowFeedback [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.

174

* itemShowScore [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat..

175

* itemShowCorrect [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.

176

* itemShowSolution [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.

177

178

179

Werden keine Auswertungsinformationen auf Aufgaben-Ebene angezeigt (itemShowFeedback = false, itemShowScore = false, itemShowCorrect =false, itemShowSolution = false), wird dem Teilnehmer während der Testdurchführung kein Button zur Aufgaben-Abgabe angezeigt. Die Antworten werden zu jeder Zeit gespeichert und nach Test-Abgabe ausgewertet.

Folgende Parameter sind seit **ONYX Version 5.15 (% style="color: rgb(255,0,0);" %)__nicht mehr__(%%)** verfügbar:

184

185

186

* showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)

187

* showFeedback [**true** |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback

188

)))

189

190

=== ReturnValue registerTest ===

|(((

Long

)))|(((

**Einer der folgenden Werte:**

196

197

* WAITING(0) – Warten auf Teststart

198

* WORKING(1) – bearbeitet Test

199

* FINISHED(2) – hat Test abgegeben

200

* RESUME_ALLOWED(3) – Fortsetzen erlaubt

201

* NOT_ENTERED(4) – hat Test noch nicht betreten

202

* CANCELED(5) – hat Testbearbeitung abgebrochen

203

* RESUME_REQUESTED(6) – möchte fortsetzen

204

* RESUMED(7) – hat fortgesetzt

205

* DISCONNECTED(8) – Client nicht (mehr) erreichbar

206

* SUSPENDED(9) – Testbearbeitung unterbrochen

207

* RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt

* OK(42) – OK

)))

|(((

)))|(((

**Fehlercodes:**

* ERROR_RETURN_RESULTS(0xFF01)

216

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

217

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

218

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

219

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

220

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

221

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Anmeldung eines Studenten ==

226

227

Nach Anmeldung eines Test können Studenten diesen nutzen. Dazu müssen auch diese angemeldet werden.

228

229

230

@WebMethod(operationName = „registerStudent")

231

public Long registerStudent(

232

@WebParam(name = „testSessionId", partName = „testSessionId") final Long test

233

SessionId,

234

@WebParam(name = „studentId", partName = „studentId") final Long studentId,

235

@WebParam(name = „payload", partName = „payload") final byte[] payload,

236

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter registerStudent ===

|(((

testSessionId

)))|(((

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

)))

|(((

studentId

)))|(((

Eindeutige Kennung für Testteilnehmer. Diese wird von ONYX zurück gemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.

251

)))

252

|(% colspan="1" %)(% colspan="1" %)

253

(((

254

payload

255

)))|(% colspan="1" %)(% colspan="1" %)

256

(((

257

Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung von unterbrochenen Tests)

258

)))

259

|(% colspan="1" %)(% colspan="1" %)

260

(((

261

parameters

262

)))|(% colspan="1" %)(% colspan="1" %)

263

(((

264

Liste von Parametern zur Teststeuerung (alle optional, fett gedruckt = Standard):

265

266

* language [**de**|en|fr|es] Sprache des Benutzerinterfaces von ONYX.

267

* status: Initialer Status des Teilnehmers (aktuell wird nur RESUME_SUSPENDED(10) unterstützt).

268

)))

269

270

=== ReturnValue registerStudent ===

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

)))

== Teststeuerung ==

Für registrierte Testteilnehmer kann der Status durch die Lernplattform kontrolliert werden, bspw. um nach der Freigabe durch den Betreuer für alle den Test zu starten, am Ende zu beenden oder fortzusetzen.

281

282

283

@WebMethod(operationName = „testControl")

284

public Long testControl(

285

@WebParam(name = „testSessionId") final Long testSessionId,

286

@WebParam(name = „studentIds") final StudentIdsWrapper students,

287

@WebParam(name = „status") final Integer status,

288

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter testControl ===

|(((

testSessionId

)))|(((

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

)))

|(((

studentIds

)))|(((

Liste eindeutiger Kennungen für Testteilnehmer.

)))

|(((

status

)))|(((

Neu zu setzender Status für die gegebenen Testteilnehmer.

)))

|(((

parameters

)))|(((

Liste von Parametern zur Teststeuerung (alle optional):

313

314

* addTime: Time in minutes to add to the test session.

315

)))

316

317

=== ReturnValue testControl ===

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

323

)))

324

325

== Speicher aufräumen ==

326

327

Haben alle Teilnehmer den Test durchgeführt, so kann die Lernplattform ONYX mitteilen, dass dieses den Test deregistrieren und den Speicher aufräumen kann.

328

329

330

@WebMethod(operationName = „deregisterTest")

331

public Long deregisterTest(

332

@WebParam(name = „testSessionId") final Long testSessionId,

333

@WebParam(name = „providerId") final String providerId,

334

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter deregisterTest ===

|(((

testSessionId

)))|(((

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

)))

|(((

providerId

)))|(((

Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.

)))

|(((

parameters

)))|(((

Aktuell nicht verwendet.

354

)))

355

356

=== ReturnValue deregisterTest ===

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

362

)))

363

364

== Anzeige des Tests ==

365

366

367

Nachdem ein Test beim Player angemeldet wurde, kann er vom Nutzer** exakt ein Mal** angezeigt werden. Dazu muss er von der Lernplattform im Browserfenster einen IFrame mit der Ziel-URL <ONYXWebPlayer-URL>/onyx/onyxrun?id=696302471 angezeigt bekommen, wobei <UID> die bei der Testanmeldung verwendete eindeutige studentId sein muss. Der Test wird dann wieder gegeben. Beendet der Nutzer den Test, so erfolgt eine Rückgabe der Resultate an die Lernplattform. Diese muss dazu eine Webservice-Schnittstelle definieren, welche exakt der unter der folgenden URL verfügbaren WSDL entspricht:

368

369

370

[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]

371

Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.

372

373

374

== Konfiguration des ONYX Players ==

375

376

Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen. Sie ist wie folgt definiert:

377

378

[[image:attach:SchnittstellePlayer.png]]

\\

Sowohl die WSDL des ONYX Player als auch die der Lernplattform sollten „nach außen“ nicht erreichbar/sichtbar sein. Dies gilt ebenso für die jeweiligen WebServices. Die Web-GUI der Lernplattform und ONYX Player hingegen müssen unabhängig davon für alle Nutzer sichtbar und zugreifbar sein. Kommt bei der Testdurchführung HTTPS zum Einsatz (wozu unbedingt zu raten ist), muss der jeweiligen Java VM der Lernplattform und des ONYX Players das entsprechende Zertifikat bekannt sein. Sonst ist die WebService-Kommunikation nicht möglich.

The API between the ONYX Player and the LMS consists of the following components:

395

396

* registration of test at the ONYX Player through the LMS

397

* registration of a participant at the ONYX Player through the LMS

398

* test monitoring

399

* return of test results to the LMS by the ONYX Player

400

* deconnection of the test

{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}

== General ==

The ONYX Player therefore defines a web service. This one is reachable via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.

419

420

Link to the WSDL of the public demo runtime: [[http:~~/~~/demo.bps-system.de/onyx/>>url:http://demo.bps-system.de/onyx/||shape="rect"]][[onyxexamservices?wsdl>>url:http://demo.bps-system.de/onyx/onyxexamservices?wsdl||shape="rect"]]

421

422

== Registration of a test ==

423

424

425

Before participants can execute tests those have to be registrated in ONYX.

426

427

428

@WebMethod(operationName = „registerTest")

429

public Long registerTest(

430

@WebParam(name = „testSessionId") final Long testSessionId,

431

@WebParam(name = „providerId") final String providerId,

432

@WebParam(name = „contentPackage") final byte[] contentPackage,

433

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter registerTest ===

|(((

testSessionId

)))|(((

Unique ID attributed by the LMS that is the identification of the test.

)))

|(((

providerId

)))|(((

Identification through which the requesting LMS is registrated in ONYX.

)))

|(((

contentPackage

)))|(((

The IMS QTI v2.1 CP (zip file as byte array).

)))

|(((

parameters

)))|(((

List of parameters to monitor the test (all optional, bold printed = standard):

458

459

* showSolution [true|false] Do you want show the user the correct answer?

460

* showFeedback [true|false] Do you want to show the user the feedback for the task?

461

* isSurvey [true|false] Is it a questionnaire (true) or a normal test?

462

* isSynchronized [true|false] Is it a test to be used in the exam mode for which the test start is synchronized for all users?

463

* continuationAllowed [true|false] Is it allowed to continue the test session at any time? If not, any test start has to be executed through the LMS.

464

* suspendAllowed [true|false] Is it allowed to interrupt the test? In this case a additional button „Suspend“ will be displayed

465

* Templateid: currently only onyxwithoutnav supported - hides the navigation tree.

466

)))

467

468

=== ReturnValue registerTest ===

|(((

Long

)))|(((

**One of the following values:**

474

475

* WAITING(0) – waiting for test start

476

* WORKING(1) – is executing test

477

* FINISHED(2) – delivered test

478

* RESUME_ALLOWED(3) – continuation allowed

479

* NOT_ENTERED(4) – did not enter the test yet

480

* CANCELED(5) – interrupted test execution

481

* RESUME_REQUESTED(6) – wants to continue

482

* RESUMED(7) – continued

483

* DISCONNECTED(8) – customer (no longer) reachable

484

* SUSPENDED(9) – text execution interrupted

485

* RESUME_SUSPENDED(10) – interrupted execution continued

* OK(42) – OK

)))

|(((

)))|(((

**Error codes:**

* ERROR_RETURN_RESULTS(0xFF01)

494

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

495

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

496

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

497

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

498

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

499

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Registration of a student ==

504

505

After having registrated a test, users are able to use it. Therefore, they have to be registrated as well.

506

507

508

@WebMethod(operationName = „registerStudent")

509

public Long registerStudent(

510

@WebParam(name = „testSessionId", partName = „testSessionId") final Long test

511

SessionId,

512

@WebParam(name = „studentId", partName = „studentId") final Long studentId,

513

@WebParam(name = „payload", partName = „payload") final byte[] payload,

514

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter registerStudent ===

|(((

testSessionId

)))|(((

Unique ID attributed by the LMS that is the identification of the test (see registerTest).

)))

|(((

studentId

)))|(((

Unique identification for a test participant. It will be returned by ONYX when status changes or results are transmitted.

529

)))

530

|(% colspan="1" %)(% colspan="1" %)

531

(((

532

payload

533

)))|(% colspan="1" %)(% colspan="1" %)

534

(((

535

Optional. Results of participant (in case of continuing an interrupted test).

536

)))

537

|(% colspan="1" %)(% colspan="1" %)

538

(((

539

parameters

540

)))|(% colspan="1" %)(% colspan="1" %)

541

(((

542

List of parameters to monitor the test (all optional, bold printed = standard):

543

544

* language [de|en|fr|es] language of the user interface in ONYX.

545

* initial status of the participant (currently only RESUME_SUSPENDED(10) supported).

546

)))

547

548

=== ReturnValue registerStudent ===

|(((

Long

)))|(((

One of the values is described under registerTest.

554

)))

555

556

== Test monitoring ==

557

558

For registrated participants the status can be controlled by the LMS, e.g. to start, finish or continue the test for all after the tutor having release the test.

559

560

561

@WebMethod(operationName = „testControl")

562

public Long testControl(

563

@WebParam(name = „testSessionId") final Long testSessionId,

564

@WebParam(name = „studentIds") final StudentIdsWrapper students,

565

@WebParam(name = „status") final Integer status,

566

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter testControl ===

|(((

testSessionId

)))|(((

Unique ID attributed by the LMS that is the identification of the test (see registerTest).

)))

|(((

studentIds

)))|(((

List of unique identifications for test participants.

)))

|(((

status

)))|(((

New status to be set for given test participants.

)))

|(((

parameters

)))|(((

List of parameters to monitor the test (all optional)

591

592

* addTime: Time in minutes to add to the test session.

593

)))

594

595

=== ReturnValue testControl ===

|(((

Long

)))|(((

One of the values is described under registerTest.

)))

== Clear storage ==

When all participants have finished the test the LMS is able to inform ONYX to deregistrate the test and to clear the storage.

606

607

608

@WebMethod(operationName = „deregisterTest")

609

public Long deregisterTest(

610

@WebParam(name = „testSessionId") final Long testSessionId,

611

@WebParam(name = „providerId") final String providerId,

612

@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {

}

=== Parameter deregisterTest ===

|(((

testSessionId

)))|(((

Unique ID attributed by the LMS that is the identification of the test (see registerTest).

)))

|(((

providerId

)))|(((

Identification through which the requesting LMS is registrated in ONYX.

)))

|(((

parameters

)))|(((

Currently not used.

)))

=== ReturnValue deregisterTest ===

|(((

Long

)))|(((

One of the values is described under registerTest.

)))

== Test display ==

After a test having been registrated at the Player it will be displayed to the user** exact one time**. Therefore, the LMS will show in a browser window an Iframe with the target URL <ONYX-Player-URL>/onyx/onyxrun?id=696302471 for which <UID> has to be mandatory the used unique

647

studentID that has been attributed during the test registration. The test will then be displayed. If the user finishes the test, the results are returned to the LMS. The LMS has to define therefore a web service API that has to correspond mandatory to the available WSDL in th following URL:

\\

[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]

652

Only the URL in the lower part has to be adjusted to the LMS.

653

654

655

== Configuration of the ONYX Players ==

656

657

The ONYX Player uses a configuration file named onyxplugin.config.xml. It has to be stored in the Java Classpath. It i defined as follows:

658

659

[[image:attach:SchnittstellePlayer.png]]

== Hint ==

The WSDL of the ONYX Player as well as those of the LMS shall not be visible/reachable from the outside. This is also valid for the corresponding web services. The web GUI of the LMS and the ONYX Player have to be independently visible and accessible for all users.

664

If HTTPS is used for the test execution (recommended) the corresponding Java VM of the LMS and ONYX Player should know the corresponding certificate. Otherwise the web service communication will not be possible.

Wiki-Quellcode von ONYX Player Interface

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht