Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
  • Confluence.Code.ConfluencePageClass[0]

Details

Seiteneigenschaften

Inhalt

...	...	@@ -58,7 +58,7 @@
58	58	(% class="task-list" %)
59	59	(((
60	60	{{task reference="/Tasks/Task_9" status="Done"}}
61		-carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-phXzt"/}}: Übersetzung offen
	61	+carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-uVFeS"/}}: Übersetzung offen
62	62	{{/task}}
63	63	)))
64	64	)))
...	...	@@ -442,29 +442,29 @@
442	442
443	443	{{layout-section ac:type="single"}}
444	444	{{layout-cell}}
445		-== General ==
	445	+== General information ==
446	446
447		-The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
	447	+The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
448	448
449	449	|(((
450	450	armSite
451	451	)))|(((
452		-Registration of sequence requests at the ONYX reporter
	452	+Registration of sequence requests at the ONYX Reporter
453	453	)))
454	454	|(((
455	455	initiateSite
456	456	)))|(((
457		-Initiates the reporter session (transmission of the CP).
	457	+Initiates the Reporter session (transmission of the CP).
458	458	)))
459	459	|(((
460	460	disarmSite
461	461	)))|(((
462		-Release of all reporter resources for this session.
	462	+Release of all Reporter resources for this session.
463	463	)))
464	464	|(((
465	465	getResultValues
466	466	)))|(((
467		-Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
	467	+Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
468	468	)))
469	469	|(% colspan="1" %)(% colspan="1" %)
470	470	(((
...	...	@@ -471,12 +471,12 @@
471	471	getResultVariables
472	472	)))|(% colspan="1" %)(% colspan="1" %)
473	473	(((
474		-Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
	474	+Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
475	475	)))
476	476
477		-== Connection to the LMS ==
	477	+== Login through the LMS ==
478	478
479		-{{code language="xml" title="Anmeldung des LMS"}}
	479	+{{code language="xml" title="Login through the LMS"}}
480	480	@WebMethod(operationName = „armSite")
481	481	public String armSite(
482	482	@WebParam(name = „version") final Integer version,
...	...	@@ -499,22 +499,22 @@
499	499	|(((
500	500	userId
501	501	)))|(((
502		-UserId of the requested reporter user
	502	+UserId of the requested Reporter user
503	503	)))
504	504	|(((
505	505	optionalRole
506	506	)))|(((
507		-Optional. User role. 0=student, 1=tutor
	507	+Optional. User role. 0 = student, 1 = tutor
508	508	)))
509	509	|(((
510	510	secretToShare
511	511	)))|(((
512		-Shared secret. Has to remain identical for every communication.
	512	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
513	513	)))
514	514	|(((
515	515	optionalUserLastName
516	516	)))|(((
517		-Optional. User lastname.
	517	+Optional. Last name of the user.
518	518	)))
519	519	|(% colspan="1" %)(% colspan="1" %)
520	520	(((
...	...	@@ -521,7 +521,7 @@
521	521	optionalUserFirstName
522	522	)))|(% colspan="1" %)(% colspan="1" %)
523	523	(((
524		-Optional. User firstname.
	524	+Optional. First name of the user.
525	525	)))
526	526	|(% colspan="1" %)(% colspan="1" %)
527	527	(((
...	...	@@ -536,12 +536,12 @@
536	536	|(((
537	537	String
538	538	)))|(((
539		-Session ID that has to be used to mark any further reporter call.
	539	+Session ID which has to be used to mark any other Reporter call.
540	540	)))
541	541
542	542	== Initialisation through LMS ==
543	543
544		-{{code language="xml" title="Initialisierung durch LMS"}}
	544	+{{code language="xml" title="Initialisation through LMS"}}
545	545	@WebMethod(operationName = „initiateSite")
546	546	public String initiateSite(
547	547	@WebParam(name = „version") final Integer version,
...	...	@@ -570,17 +570,17 @@
570	570	|(((
571	571	secretToShare
572	572	)))|(((
573		-Shared secret. Has to remain identical at every communication.
	573	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
574	574	)))
575	575	|(((
576	576	students
577	577	)))|(((
578		-List of students with their results. See below.
	578	+List of students and their results. See below.
579	579	)))
580	580	|(((
581	581	optionalContentPackage
582	582	)))|(((
583		-Optional. Content Package (zipped) as byte array.
	583	+Optional. Content package (zipped) as byte array.
584	584	)))
585	585	|(((
586	586	additionalParams
...	...	@@ -593,11 +593,11 @@
593	593	|(((
594	594	String
595	595	)))|(((
596		-Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
	596	+Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
597	597
598		-* sid: Session ID as returned by armSite
	598	+* sid: Session ID, as returned by armSite
599	599	* (((
600		-uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
	600	+uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
601	601	)))
602	602	)))
603	603
...	...	@@ -613,7 +613,7 @@
613	613	}
614	614	{{/code}}
615	615
616		-== Deconnection through the LMS ==
	616	+== Logout through the LMS ==
617	617
618	618
619	619
...	...	@@ -646,7 +646,7 @@
646	646	|(((
647	647	secretToShare
648	648	)))|(((
649		-Shared secret. Has to remain identical at every communication.
	649	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
650	650	)))
651	651	|(((
652	652	additionalParams
...	...	@@ -659,12 +659,12 @@
659	659	|(((
660	660	Boolean
661	661	)))|(((
662		-True if successful, otherwise false.
	662	+True in the case of success, otherwise false.
663	663	)))
664	664
665		-== Request of learning results through the LMS ==
	665	+== Request of learner results through the LMS ==
666	666
667		-{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
	667	+{{code language="xml" title="Request of learner results through the LMS"}}
668	668	@WebMethod(operationName = „getResultValues")
669	669	public HashMapWrapper getResultValues(
670	670	@WebParam(name = „version") final Integer version,
...	...	@@ -693,12 +693,12 @@
693	693	|(((
694	694	secretToShare
695	695	)))|(((
696		-Shared secret. Has to remain identical at every communication.
	696	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
697	697	)))
698	698	|(((
699	699	requestedValues
700	700	)))|(((
701		-Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
	701	+Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
702	702	)))
703	703	|(((
704	704	additionalParams
...	...	@@ -711,12 +711,12 @@
711	711	|(((
712	712	HashMap<String, String>
713	713	)))|(((
714		-Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
	714	+Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
715	715	)))
716	716
717	717	== Request of result variables through the LMS ==
718	718
719		-{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
	719	+{{code language="xml" title="Request of result variables through the LMS"}}
720	720	@WebMethod(operationName = „getResultVariables")
721	721	public HashMapWrapper getResultVariables(
722	722	@WebParam(name = „version") final Integer version,
...	...	@@ -748,13 +748,12 @@
748	748	|(((
749	749	HashMap<String, String>
750	750	)))|(((
751		-Map of result variables, key is the variable name, value the corresponding
752		-value (HashMap is wrapped).
	751	+Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
753	753	)))
754	754
755	755	== Wrapper ==
756	756
757		-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.
	756	+Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
758	758
759	759	=== Wrapper for HashMap<String, String> ===
760	760

Confluence.Code.ConfluencePageClass[0]

id

...	...	@@ -1,1 +1,1 @@
1		-178880909
	1	+202113242

url

...	...	@@ -1,1 +1,1 @@
1		-https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/178880909/Schnittstelle ONYX Reporter
	1	+https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/202113242/Schnittstelle ONYX Reporter