ONYX Player Interface

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

62

(((

63

(% class="content-wrapper" %)

64

(((

65

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

66

)))

67

)))

68

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

69

(((

70

Varianten

71

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

72

(((

73

(% class="content-wrapper" %)

(((

)))

)))

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

79

(((

80

Attribute

81

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

82

(((

83

(% class="content-wrapper" %)

(((

)))

)))

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

89

(((

90

Pagekey

91

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

92

(((

93

(% class="content-wrapper" %)

(((

)))

)))

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

99

(((

100

Autorenbemerkung

101

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

(((

\\

)))

\\

\\

== Allgemeines ==

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

118

119

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

120

121

== Anmeldung eines Tests ==

122

123

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

124

125

126

@WebMethod(operationName = „registerTest")

127

public Long registerTest(

128

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

129

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

130

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

131

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

}

=== Parameter registerTest ===

136

137

(% class="wrapped" %)

|(((

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

)))|(((

(% class="content-wrapper" %)

159

(((

160

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

161

162

Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.

163

164

165

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" %) (%%).

166

167

168

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

169

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

170

* (((

171

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

172

)))

173

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

174

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

175

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

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

180

181

182

* 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.

183

* 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.

184

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

185

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

186

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

187

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

188

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

189

190

191

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:

196

197

198

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

199

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

)))

)))

=== ReturnValue registerTest ===

204

205

(% class="wrapped" %)

|(((

Long

)))|(((

**Einer der folgenden Werte:**

210

211

* WAITING(0) – Warten auf Teststart

212

* WORKING(1) – bearbeitet Test

213

* FINISHED(2) – hat Test abgegeben

214

* RESUME_ALLOWED(3) – Fortsetzen erlaubt

215

* NOT_ENTERED(4) – hat Test noch nicht betreten

216

* CANCELED(5) – hat Testbearbeitung abgebrochen

217

* RESUME_REQUESTED(6) – möchte fortsetzen

218

* RESUMED(7) – hat fortgesetzt

219

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

220

* SUSPENDED(9) – Testbearbeitung unterbrochen

221

* RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt

* OK(42) – OK

)))

|(((

\\

)))|(((

**Fehlercodes:**

* ERROR_RETURN_RESULTS(0xFF01)

230

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

231

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

232

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

233

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

234

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

235

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Anmeldung eines Studenten ==

240

241

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

242

243

244

@WebMethod(operationName = „registerStudent")

245

public Long registerStudent(

246

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

247

SessionId,

248

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

249

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

250

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

}

=== Parameter registerStudent ===

255

256

(% class="wrapped" %)

|(((

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.

266

)))

267

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

268

(((

269

payload

270

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

271

(((

272

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

273

)))

274

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

275

(((

276

parameters

277

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

278

(((

279

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

280

281

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

282

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

283

)))

284

285

=== ReturnValue registerStudent ===

286

287

(% class="wrapped" %)

|(((

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.

297

298

299

@WebMethod(operationName = „testControl")

300

public Long testControl(

301

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

302

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

303

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

304

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

}

=== Parameter testControl ===

309

310

(% class="wrapped" %)

|(((

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):

330

331

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

332

)))

333

334

=== ReturnValue testControl ===

335

336

(% class="wrapped" %)

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

341

)))

342

343

== Speicher aufräumen ==

344

345

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

346

347

348

@WebMethod(operationName = „deregisterTest")

349

public Long deregisterTest(

350

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

351

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

352

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

}

=== Parameter deregisterTest ===

357

358

(% class="wrapped" %)

|(((

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.

373

)))

374

375

=== ReturnValue deregisterTest ===

376

377

(% class="wrapped" %)

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

382

)))

383

384

== Anzeige des Tests ==

385

386

387

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=<UID> 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:

388

389

390

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

391

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

392

393

394

== Konfiguration des ONYX Players ==

395

396

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

397

398

[[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:

415

416

* Registration of a test in the ONYX Player through the LMS

417

* Registration of a participant in the ONYX Player through the LMS

418

* Test control

419

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

420

* Deregistration of the test

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

== General information ==

437

438

The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.

439

440

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"]]

441

442

== Registration of a test ==

443

444

445

Before participants can take tests, the tests need to be registered with ONYX.

446

447

448

@WebMethod(operationName = „registerTest")

449

public Long registerTest(

450

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

451

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

452

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

453

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

}

=== Parameter registerTest ===

|(((

testSessionId

)))|(((

Unique ID assigned by the LMS, which serves as an identifier for this test.

)))

|(((

providerId

)))|(((

Identification under which the requesting LMS is registrated with ONYX.

)))

|(((

contentPackage

)))|(((

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

)))

|(((

parameters

)))|(((

(% class="TableParagraph" %)

478

List of parameters to control the test. Additional parameters can be set for individual participants ((% style="color: rgb(13,78,168);" %)registerStudent(%%)).

479

480

(% class="TableParagraph" %)

481

All parameters are optional. The default setting is shown in bold.

482

483

484

Since ONYX version 5.15, the feedback and assessment display for the participant can be controlled more precisely during the test execution. The interface has been adapted for this functionality. For a more detailed description of the functionality from the user perspective, see section "[[Configuration of the test implementation>>url:https://www.bps-system.de/help/display/ONYXintern/.Konfiguration+der+Testdurchfuehrung+v1.11||shape="rect"]]".

485

486

487

* showSolution [true|**false**] Should the correct answer be displayed to the user?

488

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

489

* continuationAllowed [true|**false**] Is it allowed to continue the test session at any time? If not, each test start must be performed via the LMS.

490

* suspendAllowed [true|f**alse**] Is it is allowed to interrupt the test? If this is the case, the additional button "Suspend" will be displayed.

491

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

492

* dontShowItemTitles [true|**false**]: Are the titles of the tasks supposed to be displayed?

\\

The following parameters are available since **version 5.15:**

497

498

499

* testShowScore [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain all determined point values, such as the total test score and the points per test section.

500

* testShowPassed [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain information about the passed status of this test. Default is the value given in testShowScore or its default.

501

* testShowFeedback [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain the test feedback defined by the author.

502

* itemShowFeedback [**true**|false] The task feedback defined by the author is displayed to the participant after the task has been answered.

503

* itemShowScore [**true**|false] The participant is shown the number of points achieved for the task after the submission of their answer.

504

* itemShowCorrect [**true**|false] The participant is shown whether their answer was correct or wrong after the submission of their answer. Implies itemShowScore=true.

505

* itemShowSolution [**true**|false] The participant is shown the correct solution after the submission of their answer. Implies itemShowCorrect=true and itemShowScore=true.

\\

If no evaluation information is displayed on task level (itemShowFeedback = false, itemShowScore = false, itemShowCorrect = false, itemShowSolution = false), the participant will not be shown the button to submit the task during the test implementation. The answers are saved at any time and assessed after the submission of the test.

The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__**(%%)** **available since **ONYX** **version 5.15**:

514

515

516

* showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)

517

* showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback

518

)))

519

520

=== ReturnValue registerTest ===

|(((

Long

)))|(((

**One of the following values:**

526

527

* WAITING(0) – waiting for test start

528

* WORKING(1) – is processing the test

529

* FINISHED(2) – handed in the test

530

* RESUME_ALLOWED(3) – resuming allowed

531

* NOT_ENTERED(4) – has not yet entered the test

532

* CANCELED(5) – has interrupted the testing process

533

* RESUME_REQUESTED(6) – wants to continue

534

* RESUMED(7) – has continued

535

* DISCONNECTED(8) – client is not / no longer reachable

536

* SUSPENDED(9) – testing process has been interrupted

537

* RESUME_SUSPENDED(10) – interrupted testing is continued

* OK(42) – OK

)))

|(((

)))|(((

**Error codes:**

* ERROR_RETURN_RESULTS(0xFF01)

546

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

547

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

548

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

549

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

550

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

551

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Registration of a student ==

556

557

After a test has been registered, students can use it. Provided that they have been registered themselves.

558

559

560

@WebMethod(operationName = „registerStudent")

561

public Long registerStudent(

562

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

563

SessionId,

564

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

565

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

566

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

}

=== Parameter registerStudent ===

|(((

testSessionId

)))|(((

(% class="TableParagraph" %)

576

Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).

)))

|(((

studentId

)))|(((

(% class="TableParagraph" %)

582

Unique identification for test participants. ID will be returned by ONYX when status changes or results are transmitted.

583

)))

584

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

585

(((

586

payload

587

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

588

(((

589

(% class="TableParagraph" %)

590

Optional. Results for the participant (e.g. if interrupted tests are continued)

591

)))

592

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

593

(((

594

parameters

595

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

596

(((

597

(% class="TableParagraph" %)

598

List of parameters to control the test (all optional, bold = default):

599

600

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

601

* Status: Initial status of the participant (currently only RESUME_SUSPENDED(10) is supported).

602

)))

603

604

=== ReturnValue registerStudent ===

|(((

Long

)))|(((

One of the values as described under registration of a test.

)))

== Test control ==

For registered test participants, the status can be controlled by the LMS, for example, to start, finish, or continue the test after its release by the tutor.

615

616

617

@WebMethod(operationName = „testControl")

618

public Long testControl(

619

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

620

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

621

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

622

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

}

=== Parameter testControl ===

|(((

testSessionId

)))|(((

Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).

)))

|(((

studentIds

)))|(((

List of unique IDs for test participants.

)))

|(((

status

)))|(((

New status to be set for the given test participants.

)))

|(((

parameters

)))|(((

List of parameters to control the test (all optional):

647

648

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

649

)))

650

651

=== ReturnValue testControl ===

|(((

Long

)))|(((

One of the values as described under registration of a test.

)))

== Clear storage ==

When all participants have finished the test, the LMS can inform ONYX to deregister the test and to clear the storage.

662

663

664

@WebMethod(operationName = „deregisterTest")

665

public Long deregisterTest(

666

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

667

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

668

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

}

=== Parameter deregisterTest ===

|(((

testSessionId

)))|(((

Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).

)))

|(((

providerId

)))|(((

Identification under which the requesting LMS is registered with ONYX.

)))

|(((

parameters

)))|(((

Currently not used.

)))

=== ReturnValue deregisterTest ===

|(((

Long

)))|(((

One of the values as described under registration of a test.

)))

== Test display ==

After a test has been registered with the Player, it will be displayed to the user **exactly once**. For this reason, the LMS will show an IFrame with the target URL <ONYXWebPlayer-URL>/onyx/onyxrun?id=<UID> in the browser window. The <UID> must be the unique studentId used in the test registration. The test will then be started. If the user finishes the test, the results are returned to the LMS. The LMS then needs to define a web service API that exactly matches the WSDL available under the following URL:

701

702

703

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

704

Only the URL in the lower part of the WSDL has to be adapted to the LMS.

705

706

707

== Configuration of the ONYX Player ==

708

709

The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath. It is defined as follows:

710

711

[[image:attach:SchnittstellePlayer.png]]

712

713

714

Both the WSDL of the ONYX Player and the LMS should not be accessible/visible from the outside. This also applies to the respective web services. The web GUI of the LMS and the ONYX Player, in contrast, must be visible to and accessible for all users. If HTTPS is used during the test execution (recommended), the appropriate certificate must be known to the corresponding JVM of the LMS and the ONYX Player. Otherwise web service communication is not possible.

Wiki-Quellcode von ONYX Player Interface