Schnittstelle ONYX Reporter

author	version	line-number	content
		1	{{layout}}
		2	{{layout-section ac:type="two_right_sidebar"}}
		3	{{layout-cell}}
		4	====== Inhalt: ======
		5
		6
		7
		8	{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
		9	{{/layout-cell}}
		10
		11	{{layout-cell}}
		12	\|=(% colspan="1" %)(% colspan="1" %)
		13	(((
		14	Programmversion
		15	)))\|(% colspan="1" %)(% colspan="1" %)
		16	(((
		17
		18	)))
		19	\|=(((
		20	Status
		21	)))\|(((
		22	(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
		23	)))
		24	\|=(((
		25	Aufgaben
		26	)))\|(((
		27
		28
		29
		30	)))
		31	\|=(((
		32	JIRA
		33	)))\|(((
		34
		35	)))
		36	{{/layout-cell}}
		37	{{/layout-section}}
		38
		39	{{layout-section ac:type="single"}}
		40	{{layout-cell}}
		41	== Allgemeines ==
		42
		43	Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
		44
		45	\|(((
		46	armSite
		47	)))\|(((
		48	Anmeldung von Folgerequests beim ONYX Reporter.
		49	)))
		50	\|(((
		51	initiateSite
		52	)))\|(((
		53	Initiiert die Reporter-Session (Übertragung des CPs).
		54	)))
		55	\|(((
		56	disarmSite
		57	)))\|(((
		58	Freigabe von allen Reporter-Ressourcen für diese Session.
		59	)))
		60	\|(((
		61	getResultValues
		62	)))\|(((
		63	Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung:
		64
		65	Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
		66	)))
		67	\|(% colspan="1" %)(% colspan="1" %)
		68	(((
		69	getResultVariables
		70	)))\|(% colspan="1" %)(% colspan="1" %)
		71	(((
		72	Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
		73	)))
		74
		75	== Anmeldung des LMS ==
		76
		77	{{code title="Anmeldung des LMS" language="xml"}}
		78	@WebMethod(operationName = „armSite")
		79	public String armSite(
		80	@WebParam(name = „version") final Integer version,
		81	@WebParam(name = „userId") final String userId,
		82	@WebParam(name = „optionalRole") final Integer role,
		83	@WebParam(name = „secretToShare") final String secretToShare,
		84	@WebParam(name = „optionalUserLastName") final String userLastName,
		85	@WebParam(name = „optionalUserFirstName") final String userFirstName,
		86	@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
		87	}
		88	{{/code}}
		89
		90	=== Parameter armSite ===
		91
		92	\|(((
		93	version
		94	)))\|(((
		95	Angefragte Version: 1
		96	)))
		97	\|(((
		98	userId
		99	)))\|(((
		100	UserId des anfragenden Reporter-Benutzers
		101	)))
		102	\|(((
		103	optionalRole
		104	)))\|(((
		105	Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
		106	)))
		107	\|(((
		108	secretToShare
		109	)))\|(((
		110	Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
		111	)))
		112	\|(((
		113	optionalUserLastName
		114	)))\|(((
		115	Optional. Nachname des Benutzers.
		116	)))
		117	\|(% colspan="1" %)(% colspan="1" %)
		118	(((
		119	optionalUserFirstName
		120	)))\|(% colspan="1" %)(% colspan="1" %)
		121	(((
		122	Optional. Vorname des Benutzers.
		123	)))
		124	\|(% colspan="1" %)(% colspan="1" %)
		125	(((
		126	additionalParams
		127	)))\|(% colspan="1" %)(% colspan="1" %)
		128	(((
		129	Reserved for future use.
		130	)))
		131
		132	=== ReturnValue armSite ===
		133
		134	\|(((
		135	String
		136	)))\|(((
		137	Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
		138	)))
		139
		140	== Initialisierung durch LMS ==
		141
		142	{{code title="Initialisierung durch LMS" language="xml"}}
		143	@WebMethod(operationName = „initiateSite")
		144	public String initiateSite(
		145	@WebParam(name = „version") final Integer version,
		146	@WebParam(name = „sessionId") final String sessionId,
		147	@WebParam(name = „secretToShare") final String secretToShare,
		148	@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
		149	@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
		150	@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
		151	}
		152	{{/code}}
		153
		154	=== Parameter initiateSite ===
		155
		156	\|(((
		157	version
		158	)))\|(((
		159	Angefragte Version: 1
		160	)))
		161	\|(% colspan="1" %)(% colspan="1" %)
		162	(((
		163	sessionId
		164	)))\|(% colspan="1" %)(% colspan="1" %)
		165	(((
		166	SessionId, wie von armSite zurück geliefert.
		167	)))
		168	\|(((
		169	secretToShare
		170	)))\|(((
		171	Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
		172	)))
		173	\|(((
		174	students
		175	)))\|(((
		176	Liste der Studenten mit ihren Resultaten. Siehe unten.
		177	)))
		178	\|(((
		179	optionalContentPackage
		180	)))\|(((
		181	Optional. Content Package (gezippt) als Byte-Array.
		182	)))
		183	\|(((
		184	additionalParams
		185	)))\|(((
		186	Reserved for future use.
		187	)))
		188
		189	=== ReturnValue initiateSite ===
		190
		191	\|(((
		192	String
		193	)))\|(((
		194	Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
		195
		196	* sid: Session ID, wie von armSite zurück gegeben
		197	* uid: Student ID, wie in initiateSite beim Reporter angemeldet
		198	)))
		199
		200	{{code language="xml"}}
		201	public class ResultsForStudent {
		202	private String studentId = „";
		203	private String firstname = „";
		204	private String lastname = „";
		205	private String groupname = „";
		206	private String tutorname = „";
		207	private File contentFile = null;
		208	private byte[] resultsFile = null;
		209	}
		210	{{/code}}
		211
		212	{{code title="Initialisierung durch LMS" language="xml"}}
		213	@WebMethod(operationName = „initiateSite")
		214	public String initiateSite(
		215	@WebParam(name = „version") final Integer version,
		216	@WebParam(name = „sessionId") final String sessionId,
		217	@WebParam(name = „secretToShare") final String secretToShare,
		218	@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
		219	@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
		220	@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
		221	}
		222	{{/code}}
		223	{{/layout-cell}}
		224	{{/layout-section}}
		225
		226	{{layout-section ac:type="two_right_sidebar"}}
		227	{{layout-cell}}
		228	====== untergeordnete Seiten: ======
		229
		230
		231
		232	{{children all="true"/}}
		233	{{/layout-cell}}
		234
		235	{{layout-cell}}
		236	====== relevante Links: ======
		237
		238	* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL\|\|shape="rect"]]
		239	{{/layout-cell}}
		240	{{/layout-section}}
		241	{{/layout}}