ONYX Player Interface

(% class="wrapped" %)

9

|=(((

Verantwortlicher

)))|(((

\\

)))

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

15

(((

16

Status

17

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

18

(((

19

(% class="content-wrapper" %)

(((

)))

)))

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

27

(((

28

Varianten

29

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

30

(((

31

(% class="content-wrapper" %)

(((

)))

)))

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

37

(((

38

Attribute

39

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

40

(((

41

(% class="content-wrapper" %)

(((

)))

)))

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

47

(((

48

Pagekey

49

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

50

(((

51

(% class="content-wrapper" %)

(((

)))

)))

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

57

(((

58

Übersetzung

59

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

60

(((

61

(% class="content-wrapper" %)

62

(((

63

ONYX Player Interface

)))

)))

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

69

(((

70

TODOs

71

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

72

(((

73

(% class="content-wrapper" %)

74

(((

75

(% class="task-list" %)

76

(((

77

78

carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-kEmjX"/}}: Übersetzung offen

carina: Kleine Anpassungen. {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-uDQAw"/}} Schau mal wo du noch deutsche Texte entdeckst. Der Rest bestand schon und wurde nciht geändert. {{date value="2020-10-15" format="yyyy-MM-dd"/}}

)))

)))

)))

Die Schnittstelle zwischen ONYX Player und der Lernplattform besteht aus folgenden Komponenten:

94

95

* Anmeldung eines Tests durch die Lernplattform beim ONYX Player

96

* Anmeldung eines Teilnehmers durch die Lernplattform beim ONYX Player

97

* Teststeuerung

98

* Ergebnisrückgabe der Testresultate durch den ONYX Player an die Lernplattform

99

* Abmeldung des Tests

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

== 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" %)

157

(((

158

Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).

159

160

Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.

161

162

(% class="wrapped" %)

|=(((

Parameter

)))|=(((

Beschreibung

)))

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

169

(((

170

showSolution [true|**false**]

171

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

172

(((

173

Soll dem Nutzer die korrekte Antwort anzeigbar sein?

174

)))

175

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

176

(((

177

isSynchronized [true|**false**]

178

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

179

(((

180

Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?

181

)))

182

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

183

(((

184

continuationAllowed [true|**false**]

185

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

186

(((

187

Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.

188

)))

189

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

190

(((

191

suspendAllowed [true|**false**]

192

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

193

(((

194

Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.

195

)))

196

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

197

(((

198

Templateid

199

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

200

(((

201

Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.

202

)))

203

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

204

(((

205

dontShowItemTitles (% class="error" %)[true|**false**]

206

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

207

(((

208

(% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?

)))

\\

Mit folgenden Parametern lässt sich seit ONYX Version 5.15 die Feedback- und Auswertungsanzeige für den Teilnehmer während der Testdurchführung steuern. Eine detaillierte Beschreibung der Funktionalität aus Anwendersicht bietet der Abschnitt "Konfiguration der Testdurchführung".

Aufgabenauswertung:

(% class="wrapped" %)

|=(((

Parameter

)))|=(((

Beschreibung

)))

|(((

itemShowFeedback [**true**|false]

227

)))|(((

228

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.

229

)))

230

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

231

(((

232

itemShowMaxScore [**true**|false]

233

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

234

(((

235

Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.

236

)))

237

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

238

(((

239

itemShowScore [**true**|false]

240

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

241

(((

242

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.

243

)))

244

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

245

(((

246

itemShowCorrect [**true**|false]

247

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

248

(((

249

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.

250

)))

251

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

252

(((

253

itemShowSolution [**true**|false]

254

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

255

(((

256

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.

)))

Testauswertung:

(% class="wrapped" %)

|=(((

Parameter

)))|=(((

Beschreibung

)))

|(((

testShowFeedback [**true**|false]

269

)))|(((

270

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.

271

)))

272

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

273

(((

274

testShowScore [**true**|false]

275

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

276

(((

277

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche alle ermittelten Punktwerte wie die Gesamtpunktzahl des Tests und ggf. die Punkte pro Testabschnitt (nicht) enthält.

278

)))

279

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

280

(((

281

testShowPassed (% class="error" %)[**true**|false]

282

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

283

(((

284

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche die Information (nicht) enthält, ob der Test bestanden wurde. Standard ist der in testShowScore gegebene Wert bzw. dessen Standard.

)))

\\

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:

295

296

297

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

298

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

)))

)))

=== ReturnValue registerTest ===

303

304

(% class="wrapped" %)

|(((

Long

)))|(((

**Einer der folgenden Werte:**

309

310

* WAITING(0) – warten auf Teststart

311

* WORKING(1) – bearbeitet Test

312

* FINISHED(2) – hat Test abgegeben

313

* RESUME_ALLOWED(3) – Fortsetzen erlaubt

314

* NOT_ENTERED(4) – hat Test noch nicht betreten

315

* CANCELED(5) – hat Testbearbeitung abgebrochen

316

* RESUME_REQUESTED(6) – möchte fortsetzen

317

* RESUMED(7) – hat fortgesetzt

318

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

319

* SUSPENDED(9) – Testbearbeitung unterbrochen

320

* RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt

* OK(42) – OK

)))

|(((

\\

)))|(((

**Fehlercodes:**

* ERROR_RETURN_RESULTS(0xFF01)

329

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

330

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

331

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

332

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

333

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

334

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Anmeldung eines Studenten ==

339

340

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

341

342

343

@WebMethod(operationName = „registerStudent")

344

public Long registerStudent(

345

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

346

SessionId,

347

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

348

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

349

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

}

=== Parameter registerStudent ===

354

355

(% 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ückgemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.

365

)))

366

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

367

(((

368

payload

369

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

370

(((

371

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

372

)))

373

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

374

(((

375

parameters

376

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

377

(((

378

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

379

380

* language [**de**|en|fr|es]: Sprache des Benutzer-Interfaces von ONYX.

381

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

382

)))

383

384

=== ReturnValue registerStudent ===

385

386

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

396

397

398

@WebMethod(operationName = „testControl")

399

public Long testControl(

400

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

401

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

402

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

403

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

}

=== Parameter testControl ===

408

409

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

429

430

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

431

)))

432

433

=== ReturnValue testControl ===

434

435

(% class="wrapped" %)

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

440

)))

441

442

== Speicher aufräumen ==

443

444

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

445

446

447

@WebMethod(operationName = „deregisterTest")

448

public Long deregisterTest(

449

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

450

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

451

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

}

=== Parameter deregisterTest ===

456

457

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

472

)))

473

474

=== ReturnValue deregisterTest ===

475

476

(% class="wrapped" %)

|(((

Long

)))|(((

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

481

)))

482

483

== Anzeige des Tests ==

484

485

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 wiedergegeben. 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:

486

487

488

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

489

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

490

491

492

== Konfiguration des ONYX Players ==

493

494

Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.

\\

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 des 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 Player das entsprechende Zertifikat bekannt sein. Sonst ist die WebService-Kommunikation nicht möglich.

----

\\

(% class="auto-cursor-target" %)

516

Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.

517

518

519

**[[image:attach:BPS-Logo-web.png]]

520

**

521

522

**Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**

523

E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]

524

525

Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.

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

538

539

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

540

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

541

* Test control

542

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

543

* Deregistration of the test

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

== General information ==

560

561

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

562

563

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

564

565

== Registration of a test ==

566

567

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

568

569

570

@WebMethod(operationName = „registerTest")

571

public Long registerTest(

572

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

573

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

574

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

575

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

}

=== Parameters registerTest ===

580

581

(% class="wrapped" %)

|(((

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="content-wrapper" %)

601

(((

602

(% class="TableParagraph" %)

603

List of parameters to control the test. It is also possible to set additional parameters for the individual participant (registerStudent).

604

605

(% class="TableParagraph" %)

606

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

607

608

(% class="wrapped" %)

|=(((

Paramter

)))|=(((

Description

)))

|(((

showSolution [true|**false**]

616

)))|(((

617

Should the correct answer be displayed to the user?

618

)))

619

|(((

620

isSynchronized [true|**false**]

621

)))|(((

622

Is the test for which the test start is synchronised across all users in the exam mode?

623

)))

624

|(((

625

continuationAllowed [true|**false**]

626

)))|(((

627

Is it allowed to continue the test session at any time? If not, each test start must be performed via the LMS.

628

)))

629

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

630

(((

631

suspendAllowed [true|**false**]

632

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

633

(((

634

Is it is allowed to interrupt the test? If this is the case, the button "Suspend" will additionally be displayed.

635

)))

636

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

637

(((

638

Templateid:

639

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

640

(((

641

Currently only supported: onyxwithoutnav - hides the navigation tree.

642

)))

643

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

644

(((

645

dontShowItemTitles [true|**false**]

646

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

647

(((

648

Should the titles of the questions not be displayed?

)))

\\

Since ONYX version 5.15, the following parameters can be used to control the feedback and evaluation display for the participant while taking the test. A detailed description of the functionality from the user's perspective is provided in the section "Test procedure configuration".

655

656

657

Questions evaluation:

658

659

(% class="wrapped" %)

|=(((

Parameter

)))|=(((

Description

)))

|(((

itemShowFeedback [**true**|false]

667

)))|(((

668

The question feedback defined by the author is displayed to the participant after submitting an answer to the question.

669

)))

670

|(((

671

itemShowMaxScore [**true**|false]

672

)))|(((

673

The participant is shown the maximum possible score for each question.

674

)))

675

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

676

(((

677

itemShowScore [**true**|false]

678

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

679

(((

680

The participant is shown the number of points achieved for the question after submitting their answer.

681

)))

682

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

683

(((

684

itemShowCorrect [**true**|false]

685

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

686

(((

687

The participant is shown whether their answer was correct or incorrect after submitting their answer. Implies itemShowScore=true.

688

)))

689

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

690

(((

691

itemShowSolution [**true**|false]

692

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

693

(((

694

The participant is shown the correct solution after submitting their answer. Implies itemShowCorrect=true and itemShowScore=true.

)))

Test evaluation:

(% class="wrapped" %)

|=(((

Parameter

)))|=(((

Description

)))

|(((

testShowFeedback [**true**|false]

707

)))|(((

708

After submitting the test, the participant is shown a test completion page, which does (not) contain the test feedback defined by the author.

709

)))

710

|(((

711

testShowScore [**true**|false]

712

)))|(((

713

After submitting the test, the participant is shown a test completion page, which does (not) contain all determined point values, such as the total test score and the points per test section, if applicable.

714

)))

715

|(((

716

testShowPassed [**true**|false]

717

)))|(((

718

After submitting the test, the participant is shown a test completion page, which does (not) contain information about whether or not the test was passed. The default is the value given in testShowScore or its default.

)))

\\

If no evaluation information is displayed on question level (itemShowFeedback = false, itemShowScore = false, itemShowCorrect = false, itemShowSolution = false), then the participant will not be shown the button to submit questions while taking the test. Instead, the answers are saved at any time and assessed after test submission.

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

729

730

731

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

732

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

)))

)))

=== ReturnValue registerTest ===

737

738

(% class="wrapped" %)

|(((

Long

)))|(((

**One of the following values:**

743

744

* WAITING(0) – waiting for test start

745

* WORKING(1) – is processing the test

746

* FINISHED(2) – submitted the test

747

* RESUME_ALLOWED(3) – resuming allowed

748

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

749

* CANCELED(5) – has cancelled the testing process

750

* RESUME_REQUESTED(6) – wishes to continue

751

* RESUMED(7) – has continued

752

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

753

* SUSPENDED(9) – testing process has been interrupted

754

* RESUME_SUSPENDED(10) – interrupted testing process is continued

* OK(42) – OK

)))

|(((

\\

)))|(((

**Error codes:**

* ERROR_RETURN_RESULTS(0xFF01)

763

* ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)

764

* ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)

765

* ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)

766

* ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)

767

* ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)

768

* ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)

* UNKNOWN(-1)

)))

== Registration of a student ==

773

774

Students can use a test after it has been registered, provided that they have been registered as well.

775

776

777

@WebMethod(operationName = „registerStudent")

778

public Long registerStudent(

779

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

780

SessionId,

781

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

782

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

783

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

}

=== Parameters registerStudent ===

788

789

(% class="wrapped" %)

|(((

testSessionId

)))|(((

(% class="TableParagraph" %)

794

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

)))

|(((

studentId

)))|(((

(% class="TableParagraph" %)

800

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

801

)))

802

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

803

(((

804

payload

805

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

806

(((

807

(% class="TableParagraph" %)

808

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

809

)))

810

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

811

(((

812

parameters

813

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

814

(((

815

(% class="TableParagraph" %)

816

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

817

818

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

819

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

820

)))

821

822

=== ReturnValue registerStudent ===

823

824

(% class="wrapped" %)

|(((

Long

)))|(((

One of the values as described under "Registration of a test".

)))

== Test control ==

The status of registered test participants can be controlled by the LMS, e. g. to start, finish, or continue the test for everyone after the tutor has approved of it.

834

835

836

@WebMethod(operationName = „testControl")

837

public Long testControl(

838

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

839

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

840

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

841

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

}

=== Parameters testControl ===

846

847

(% class="wrapped" %)

|(((

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 test control parameters (all optional):

867

868

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

869

)))

870

871

=== ReturnValue testControl ===

872

873

(% class="wrapped" %)

|(((

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.

883

884

885

@WebMethod(operationName = „deregisterTest")

886

public Long deregisterTest(

887

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

888

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

889

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

}

=== Parameters deregisterTest ===

894

895

(% class="wrapped" %)

|(((

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

913

914

(% class="wrapped" %)

|(((

Long

)))|(((

One of the values as described under "Registration of a test".

)))

== Test display ==

After a test has been registered with the Player, the user can display it **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 will be returned to the LMS. The LMS then needs to define a web service API that exactly matches the WSDL available under the following URL:

924

925

926

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

927

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

928

929

930

== Configuration of the ONYX Player ==

931

932

The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.

933

934

935

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 by all users. If HTTPS is used during the test process (which is strongly recommended), then the appropriate certificate must be known to the corresponding JVM of the LMS and the ONYX Player. Otherwise web service communication will not be possible.

----