Zum Inhalt springen

Wiki-Quellcode von 03 Installation ONYX Editor

Version 428.2 von Carina Enke am 13.02.2024
Zeige letzte Bearbeiter
1 Documentation to install ONYX Editor as a productive instance on a Linux server.
2
3 (% class="macro-border macro-panel" style="border: solid; border-color: #ddd; border-width: 1px; border-radius: 8px 8px 0px 0px;" %)
4 (((
5 (% class="macro-panel-title" %)
6 (((
7 Inhalt
8 )))
9
10 (% class="macro-panel-content" style="background-color: #f0f0f0;" %)
11 (((
12 (% class="wikitoc" %)
13 * [[Requirements>>path:#HRequirements]]
14 * [[Download and installation of requirements>>path:#HDownloadandinstallationofrequirements]]
15 ** [[Download and install Tomcat>>path:#HDownloadandinstallTomcat]]
16 ** [[Download and install PostgreSQL>>path:#HDownloadandinstallPostgreSQL]]
17 ** [[Download and install libraries>>path:#HDownloadandinstalllibraries]]
18 * [[Deployment>>path:#HDeployment]]
19 ** [[New installation>>path:#HNewinstallation]]
20 ** [[Installation update>>path:#HInstallationupdate]]
21 ** [[Creation of super user account>>path:#HCreationofsuperuseraccount]]
22 * [[Configuration>>path:#HConfiguration]]
23 ** [[Repository Configuration>>path:#HRepositoryConfiguration]]
24 *** [[File system repository>>path:#HFilesystemrepository]]
25 *** [[OPAL repository>>path:#HOPALrepository]]
26 ** [[General configuration>>path:#HGeneralconfiguration]]
27 *** [[General stuff, preview, self-registration, licence>>path:#HGeneralstuff2Cpreview2Cself-registration2Clicence]]
28 *** [[System message>>path:#HSystemmessage]]
29 *** [[Publish>>path:#HPublish]]
30 **** [[Check of the publish configuration>>path:#HCheckofthepublishconfiguration]]
31 *** [[LTI>>path:#HLTI]]
32 *** [[Database connection>>path:#HDatabaseconnection]]
33 ** [[Reporter configuration>>path:#HReporterconfiguration]]
34 * [[MAXIMA for calculations>>path:#HMAXIMAforcalculations]]
35 * [[Log files>>path:#HLogfiles]]
36
37
38 )))
39 )))
40
41
42
43 == Requirements ==
44
45 * Java 17 (Oracle or OpenJDK)
46 * Apache Tomcat 9
47 * PostgreSQL 12
48 * MAXIMA for the use of calculations (mandatory)
49 * libraries
50
51 == Download and installation of requirements ==
52
53 Download and install OpenJDK 17 ([[https:~~/~~/jdk.java.net/java-se-ri/17>>url:https://jdk.java.net/java-se-ri/17||shape="rect"]] ) or Oracle JDK17 ([[https:~~/~~/jdk.java.net/17>>url:https://jdk.java.net/17/||shape="rect"]])
54
55 (% class="box" %)
56 (((
57 (% class="code" %)
58 (((
59 tar xfz jdk-xyz-linux-x64.tar.gz -C /opt
60 )))
61 )))
62
63 **Let the environment variable $JAVA_HOME point to the JDK directory:**
64
65 (% class="box" %)
66 (((
67 (% class="code" %)
68 (((
69 export JAVA_HOME=/opt/jdkX.Y..Z
70 )))
71 )))
72
73 === Download and install Tomcat ===
74
75 [[https:~~/~~/tomcat.apache.org/download-90.cgi>>url:https://tomcat.apache.org/download-90.cgi||shape="rect"]]
76
77 (% class="box" %)
78 (((
79 (% class="code" %)
80 (((
81 tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt
82 )))
83 )))
84
85 === Download and install PostgreSQL ===
86
87 [[http:~~/~~/www.enterprisedb.com/products-services-training/pgdownload>>url:http://www.enterprisedb.com/products-services-training/pgdownload||rel="nofollow" shape="rect" title="Verknüpfung folgen"]]
88
89 (% class="box" %)
90 (((
91 (% class="code" %)
92 (((
93 chmod u+x postgresql-12.X-linux-x64.run
94 )))
95 )))
96
97 === Download and install libraries ===
98
99 (% class="Y2IQFc box code" lang="en" %)yum install atk nss at-spi2-atk libXcomposite alsa-lib libXrandr libxkbcommon libXdamage cups-libs
100
101
102 {{{
103 }}}
104
105 == Deployment ==
106
107 === New installation ===
108
109 Extract the webeditor-X.X.war to $ {TOMCAT_HOME}/webapps/webeditor
110
111 (% class="box" %)
112 (((
113 (% class="code" %)
114 (((
115 unzip webeditor-X.X.war -d /opt/apache-tomcat-X.X.XX/webapps/webeditor
116 )))
117 )))
118
119 Create database user and database
120
121 (% class="box" %)
122 (((
123 (% class="code" %)
124 (((
125 su postgres
126 /opt/PostgreSQL/X.X/bin/createuser -P onyxeditor
127 /opt/PostgreSQL/X.X/bin/createdb -O onyxeditor onyxeditor(% style="border:1px solid #ff0000" %)
128 )))
129 )))
130
131 Initialize database
132
133 (% class="box" %)
134 (((
135 (% class="code" %)
136 (((
137 psql (% style="color:#666666" %)-(%%)h localhost (% style="color:#666666" %)-(%%)U onyxeditor onyxeditor (% style="color:#666666" %)<(%%) (% style="color:#666666" %)/(%%)opt(% style="color:#666666" %)/(%%)apache(% style="color:#666666" %)-(%%)tomcat(% style="color:#666666" %)-(%%)X.X.XX(% style="color:#666666" %)/(%%)webapps(% style="color:#666666" %)/(%%)webeditor(% style="color:#666666" %)/(%%)WEB(% style="color:#666666" %)-(%%)INF(% style="color:#666666" %)/(%%)classes(% style="color:#666666" %)/(% style="color:#008000; font-weight:bold" %)**database**(% style="color:#666666" %)/(%%)setupdatabase.(% style="color:#008000; font-weight:bold" %)**sql**
138 )))
139 )))
140
141 === Installation update ===
142
143 Delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps
144
145 It might be useful to clear the work and temp directory of the Tomcat Server:
146
147 (% class="box" %)
148 (((
149 (% class="code" %)
150 (((
151 rm -rf (% style="color:#bc7a00" %)${(%%)TOMCAT_HOME(% style="color:#bc7a00" %)}(%%)/temp/* (% style="color:#bc7a00" %)${(%%)TOMCAT_HOME(% style="color:#bc7a00" %)}(%%)/work/*
152 )))
153 )))
154
155 Start your Tomcat
156
157 (% class="box" %)
158 (((
159 (% class="code" %)
160 (((
161 (% style="color:#666666" %)/(%%)opt(% style="color:#666666" %)/(%%)apache(% style="color:#666666" %)-(%%)tomcat(% style="color:#666666" %)-(%%)X.X.XX(% style="color:#666666" %)/(%%)bin(% style="color:#666666" %)/(%%)startup.sh
162 )))
163 )))
164
165 Open the following URL in your browser: [[http:~~/~~/localhost:8080/webeditor>>url:http://localhost:8080/webeditor||shape="rect"]]
166
167 === Creation of super user account ===
168
169 Register a new user on homescreen
170
171 Connect to database and select the new user
172
173 (% class="box" %)
174 (((
175 (% class="code" %)
176 (((
177 (% style="color:#008000; font-weight:bold" %)**select**(%%) (% style="color:#666666" %)*(%%) (% style="color:#008000; font-weight:bold" %)**from**(%%) users;
178 (% style="color:#008000; font-weight:bold" %)**UPDATE**(%%) users (% style="color:#008000; font-weight:bold" %)**SET**(%%) (% style="color:#008000; font-weight:bold" %)**role**(% style="color:#666666" %)=0(%%) (% style="color:#008000; font-weight:bold" %)**WHERE**(%%) ID (% style="color:#666666" %)=(%%) XXX;
179 )))
180 )))
181
182 == Configuration ==
183
184 The configuration files can be found inside the webeditor folder in your tomcat installation (see "/opt/apache-tomcat-X.X.XX/webapps/webeditor/").
185
186 === Repository Configuration ===
187
188 (% class="box" %)
189 (((
190 (% class="code" %)
191 (((
192 WEB-INF/classes/de/bps/onyx/context/moduleConfigurationContext.xml
193 )))
194 )))
195
196 This file is the config for ONYX Editor repository configurations.
197
198 (% class="box" %)
199 (((
200 (% class="code" %)
201 (((
202 ...
203 (% style="color:#008000; font-weight:bold" %)**<bean**(%%) (% style="color:#7d9029" %)id=(% style="color:#ba2121" %)"de.bps.onyx.manager.RepositoryConfigurationManager"(%%) (% style="color:#7d9029" %)class=(% style="color:#ba2121" %)"de.bps.onyx.manager.RepositoryConfigurationManager"(% style="color:#008000; font-weight:bold" %)**>**(%%)
204 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"modules"(% style="color:#008000; font-weight:bold" %)**>**(%%)
205 (% style="color:#008000; font-weight:bold" %)**<map>**(%%)
206 (% style="color:#008000; font-weight:bold" %)**<entry**(%%) (% style="color:#7d9029" %)key=(% style="color:#ba2121" %)"FileSystemModule"(%%) (% style="color:#7d9029" %)value-ref=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.FileSystemModule"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
207 (% style="color:#008000; font-weight:bold" %)**<entry**(%%) (% style="color:#7d9029" %)key=(% style="color:#ba2121" %)"OLATRepoModule"(%%) (% style="color:#7d9029" %)value-ref=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.OPALRepoModule"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
208 (% style="color:#008000; font-weight:bold" %)**<entry**(%%) (% style="color:#7d9029" %)key=(% style="color:#ba2121" %)"PREOLATCERepoConfiguration"(%%) (% style="color:#7d9029" %)value-ref=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.PREOLATCERepoConfiguration"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
209 (% style="color:#008000; font-weight:bold" %)**</map>**(%%)
210 (% style="color:#008000; font-weight:bold" %)**</property>**(%%)
211 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"defaultModule"(%%) (% style="color:#7d9029" %)ref=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.OPALRepoModule"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
212 (% style="color:#008000; font-weight:bold" %)**</bean>**(%%)
213 ...
214 )))
215 )))
216
217 * defines the repositories available:
218 ** key defines the internal repository ID. It may be named as you want.
219 ** value-ref references the bean which defines the repository configuration:
220
221 (% class="box" %)
222 (((
223 (% class="code" %)
224 (((
225 ...
226 (% style="color:#008000; font-weight:bold" %)**<bean**(%%) (% style="color:#7d9029" %)id=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.FileSystemModule"(%%) (% style="color:#7d9029" %)class=(% style="color:#ba2121" %)"de.bps.onyx.manager.modules.FileSystemModule"(% style="color:#008000; font-weight:bold" %)**>**(%%)
227 (% style="color:#008000; font-weight:bold" %)**<constructor-arg**(%%) (% style="color:#7d9029" %)index=(% style="color:#ba2121" %)"0"(%%) (% style="color:#7d9029" %)ref=(% style="color:#ba2121" %)"FileSystemConfiguration"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
228 (% style="color:#008000; font-weight:bold" %)**</bean>**(%%)
229 ...
230 )))
231 )))
232
233 * instantiates the repository configuration depending on repository type:
234 ** de.bps.onyx.manager.modules.FileSystemModule: value-ref from above
235 ** class="...": One of:
236 *** de.bps.onyx.manager.modules.FileSystemModule (local file system repository)
237 *** de.bps.onyx.manager.modules.OPALRepoModule (uses an OLAT LMS as repository)
238 ** constructor-arg: ref references the configuration bean as follows:
239
240 ==== File system repository ====
241
242 (% class="box" %)
243 (((
244 (% class="code" %)
245 (((
246 ...
247 (% style="color:#008000; font-weight:bold" %)**<bean**(%%) (% style="color:#7d9029" %)id=(% style="color:#ba2121" %)"FileSystemConfiguration"(%%) (% style="color:#7d9029" %)class=(% style="color:#ba2121" %)"de.bps.onyx.model.repo.RepositoryModuleConfiguration"(% style="color:#008000; font-weight:bold" %)**>**(%%)
248 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"name"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"FileSystemModule"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
249 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"typeKey"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"FileSystemModule"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
250 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"description"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"File system module"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
251 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"canHandleGuest"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"true"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
252 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"serviceTarget"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"/opt/owe/fsr"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
253 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"displayname"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"Repository PRE/OLATCE"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
254 (% style="color:#008000; font-weight:bold" %)**</bean>**(%%)
255 ...
256 )))
257 )))
258
259 * name: Name which is used internal in ONYX Editor as identifier (**must** match key in line <entry key="FileSystemModule" value-ref="de.bps.onyx.manager.modules.FileSystemModule" /> above)
260 * typeKey: Repository type definition
261 * description: Some description (not used at the moment)
262 * canHandleGuest: set to true if this repository can handle guest users (without logon)
263 * serviceTarget: File system path
264 * displayname: String to show as repository name in ONYX Editor (if not given, some internal translation will be done to show a generic and type dependent name)
265
266 ==== OPAL repository ====
267
268 (% class="box" %)
269 (((
270 (% class="code" %)
271 (((
272 ...
273 <bean id=(% style="color:#ba2121" %)"OPALRepoConfiguration"(%%) class=(% style="color:#ba2121" %)"de.bps.onyx.model.repo.RepositoryModuleConfiguration"(%%)>
274 <property name=(% style="color:#ba2121" %)"name"(%%) value=(% style="color:#ba2121" %)"OLATRepoModule"(%%) />
275 <property name=(% style="color:#ba2121" %)"typeKey"(%%) value=(% style="color:#ba2121" %)"OLATRepoModule"(%%) />
276 <property name=(% style="color:#ba2121" %)"serviceTarget"(%%) value=(% style="color:#ba2121" %)"https:~/~/my.server.edu/opal/services/"(%%) />
277 ...
278 </bean>
279 ...(% style="border:1px solid #ff0000" %)
280 )))
281 )))
282
283 * name: Repo name as configured in OPAL
284 * typeKey: Must be OLATRepoModule
285 * serviceTarget: OPAL URL
286 * Other properties as stated above for File system repository
287
288 === General configuration ===
289
290 (% class="box" %)
291 (((
292 (% class="code" %)
293 (((
294 WEB-INF/classes/de/bps/onyx/context/applicationContext.xml
295 )))
296 )))
297
298 This file contains the main configuration for the application.
299
300 ==== General stuff, preview, self-registration, licence ====
301
302 This section contains the configuration for: the connection to the ONYX Player (used for preview) as well as some other configuration.
303
304 (% class="box" %)
305 (((
306 (% class="code" %)
307 (((
308 ...
309 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"system"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"myonyxeditor"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
310 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"previewAddress"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"http:~/~/my.server.edu/onyx"(% style="color:#008000; font-weight:bold" %)**/>**(%%)
311 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"selfRegistrationEnabled"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"false"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
312 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"defaultLicences"(% style="color:#008000; font-weight:bold" %)**>**(%%)
313 (% style="color:#008000; font-weight:bold" %)**<list>**(%%)
314 (% style="color:#008000; font-weight:bold" %)**<value>**(%%)YourRepoConfiguration;SINGLE;20270731(% style="color:#008000; font-weight:bold" %)**</value>**(%%)
315 (% style="color:#008000; font-weight:bold" %)**</list>**(%%)
316 (% style="color:#008000; font-weight:bold" %)**</property>**(%%)
317 (% style="color:#408080; font-style:italic" %)//<!~-~- URL of Onyx reporter for statistics ~-~->//(%%)
318 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"reporterUrl"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"https:~/~/demo.bps-system.de/onyx"(% style="color:#008000; font-weight:bold" %)**/>**(%%)
319 (% style="color:#408080; font-style:italic" %)//<!~-~- ID of Onyx Editors registration at Onyx reporter for statistics ~-~->//(%%)
320 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"reporterProviderId"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"myInstanceId"(% style="color:#008000; font-weight:bold" %)**/>**(%%)
321 (% style="color:#408080; font-style:italic" %)//<!~-~- Source for HTML entities list. This is used to transform users unicode input in valid XML. ~-~->//(%%)
322 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"htmlEntitiesList"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"https:~/~/html.spec.whatwg.org/multipage/entities.json"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
323 ...
324 )))
325 )))
326
327 Explanation:
328
329 (% class="wrapped" %)
330 |=(((
331 Key
332 )))|=(((
333 Example
334 )))|=(% colspan="1" %)(% colspan="1" %)
335 (((
336 Since version
337 )))|=(((
338 Description
339 )))
340 |(((
341 system
342 )))|(((
343 myonyxeditor
344 )))|(% colspan="1" %)(% colspan="1" %)
345 (((
346 3.0
347 )))|(((
348 Mandatory. The serviceprovider name (used by ONYX Player)and must be adopted to your Onyx Player configuration.
349 )))
350 |(((
351 previewAddress
352 )))|(((
353 (% class="nolink" %)https:~/~/demo.bps-system.de/onyx
354 )))|(% colspan="1" %)(% colspan="1" %)
355 (((
356 3.0
357 )))|(((
358 Mandatory. The ONYX Player to use as preview component. In this example is the ONYX Player used at URL (% class="external free nolink" %)https:~/~/demo.bps-system.de/onyx
359 )))
360 |(((
361 selfRegistrationEnabled
362 )))|(((
363 false
364 )))|(% colspan="1" %)(% colspan="1" %)
365 (((
366 6.0
367 )))|(((
368 Optional. Should users be able to register themselves? Default is true.
369 )))
370 |(% colspan="1" %)(% colspan="1" %)
371 (((
372 defaultLicences
373 )))|(% colspan="1" %)(% colspan="1" %)
374 (((
375 see above
376 )))|(% colspan="1" %)(% colspan="1" %)
377 (((
378 6.0
379 )))|(% colspan="1" %)(% colspan="1" %)
380 (((
381 Optional. This defines whether or not new users should automatically be assigned to a licence, and if, of which type that licence should be.
382
383 This only works with the integrated login e.g. with OLAT, which come with a repository parameter in the ONYX Editor call. This repository name is the key and must match to the //name// attribute of one of the repository definitions in //moduleConfigurationContext.xml//.
384
385 **Format:** There are three parts per line, separates by semicolons
386 //Repository name~:// As stated. In Example above: YourRepoConfiguration
387 //Licence type~:// One of DEMO, SINGLE, CAMPUS, PUBLISHER
388 //Valid until date~:// Date in format yyyyMMdd, e.g. 20270731. This will be the date until which the licence is valid for the user.
389 )))
390 |(% colspan="1" %)(% colspan="1" %)
391 (((
392 reporterUrl
393 )))|(% colspan="1" %)(% colspan="1" %)
394 (((
395 https:~/~/demo.bps-system.de/onyx
396 )))|(% colspan="1" %)(% colspan="1" %)
397 (((
398 6.3
399 )))|(% colspan="1" %)(% colspan="1" %)
400 (((
401 URL of an ONYX Reporter. This is used for all statistics and evaluation views. The ONYX Reporter instance needs to be configured to be usabe as such, especially the reporterProviderId (see next line) must be known.
402 )))
403 |(% colspan="1" %)(% colspan="1" %)
404 (((
405 reporterProviderId
406 )))|(% colspan="1" %)(% colspan="1" %)
407 (((
408 myInstanceId
409 )))|(% colspan="1" %)(% colspan="1" %)
410 (((
411 6.3
412 )))|(% colspan="1" %)(% colspan="1" %)
413 (((
414 Config name of this ONYX Editors instance in the ONYX Reporter configuration. This configuration contains ONYX Editor data as the URL to send results to. Please contact the ONYX Reporters administrator and negotiate this value.
415
416 Note: In earlier versions of the ONYX Editor this was configured in an addtional config file (webServiceContext.xml), which was removed in version 6.3
417 )))
418 |(% colspan="1" %)(% colspan="1" %)
419 (((
420 htmlEntitiesList
421 )))|(% colspan="1" %)(% colspan="1" %)
422 (((
423 (% class="nolink nolink" %)https:~/~/html.spec.whatwg.org/multipage/entities.json(%%)
424 or /tmp/entities.json
425 )))|(% colspan="1" %)(% colspan="1" %)
426 (((
427 6.3
428 )))|(% colspan="1" %)(% colspan="1" %)
429 (((
430 Optional. Source for HTML entities list. This is used to transform users unicode input in valid XML. Provide a valid URL or file path here.
431
432 To avoid Onyx from downloading this file from an external server just do this by yourself and configure the absolute path to this file. Please always keep this file up-to-date since entities may change and non-existent entities will cause XML failures which will destroy user contents.
433
434 Default is (% class="nolink nolink" %)[[https:~~/~~/html.spec.whatwg.org/multipage/entities.json>>url:https://html.spec.whatwg.org/multipage/entities.json||shape="rect"]]
435 )))
436
437 ==== System message ====
438
439 The next section contains the system message configuration which can be used to display a static informational message to inform all users about nightly application restarts. Remove all keys to not show anything.
440
441 (% class="box" %)
442 (((
443 (% class="code" %)
444 (((
445 ...
446 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
447 (% style="color:#408080; font-style:italic" %)//<!~-~- System message ~-~->//(%%)
448 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
449 (% style="color:#408080; font-style:italic" %)//<!~-~- May be a localstring key or a final message (without localization). May contain escaped HTML. ~-~->//(%%)
450 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"message"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"sysmsg.nightly"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
451 (% style="color:#408080; font-style:italic" %)//<!~-~- Parameters for localization if message above is a localstring key. Optional. ~-~->//(%%)
452 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"messageParams"(% style="color:#008000; font-weight:bold" %)**><list><value>**(%%)3(% style="color:#008000; font-weight:bold" %)**</value></list></property>**(%%)
453 (% style="color:#408080; font-style:italic" %)//<!~-~- When should the message be displayed? Date in form yyyyMMdd HHmm or only HHmm. Optional. ~-~->//(%%)
454 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"messageFrom"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"2359"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
455 (% style="color:#408080; font-style:italic" %)//<!~-~- Duration of display starting from value given in <from> (in minutes). Optional. ~-~->//(%%)
456 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"messageDurationInMinutes"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"1"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
457 ...
458 )))
459 )))
460
461 Explanation:
462
463 (% class="wrapped" %)
464 |=(((
465 Key
466 )))|=(((
467 Example
468 )))|=(((
469 Description
470 )))
471 |(((
472 message
473 )))|(((
474 Attention! Application restarts at 3 pm!
475 )))|(((
476 The fully localized message or a localization key defined in the messages_xy.properties files.
477 )))
478 |(((
479 messageParams
480 )))|(((
481 3
482 )))|(((
483 If //message// is a localization key defined in the messages_xy.properties files, this option can be used to populate variable placeholders. If the key maps th a localized string "Attention! Application restarts at {1} pm!" and //messageParams// contains a value "3", the user will see the message as given as example at the //message// option. This way you are able to show fully localized messages.
484 )))
485 |(((
486 messageFrom
487 )))|(((
488 0300
489 )))|(((
490 A time in Java defined format HHmm (this means two digits hours in 24 hours format, immediately followed by the minutes value). This defines the point in time from which user will see the //message//. Must have exactly 4 digits.
491
492 If not given the //message// will be shown all the time.
493 )))
494 |(((
495 messageDurationInMinutes
496 )))|(((
497 90
498 )))|(((
499 Defines how long the message will be shown, starting at //messageFrom//.
500 )))
501
502 All keys are optional. If message is missing, no message will be show at all. Changes to the values configured require a restart of the application to be acknowledged.
503
504 ==== Publish ====
505
506 All property keys starting with //publish// are used in the context of the **publish functionality**. Publish functionality can be disabled by completely remove all of the //publish// keys.
507
508 (% class="box" %)
509 (((
510 (% class="code" %)
511 (((
512 ...
513 (% style="color:#408080; font-style:italic" %)//<!~-~- Directory to publish the published tests to. Leave empty to deactivate publish. Must end with / ~-~->//(%%)
514 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishDirectory"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"/intern/instances/onyxeditor/data/publish/"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
515 (% style="color:#408080; font-style:italic" %)//<!~-~- Prefix to use for test runs in player registration. An underscore will be appended automatically. ~-~->//(%%)
516 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishUniqueIdPrefix"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"owe"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
517 (% style="color:#408080; font-style:italic" %)//<!~-~- Service provider Onyx WS location. No trailing slash! ~-~->//(%%)
518 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishProviderWs"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"http:~/~/my.hot.system.edu/onyx"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
519 (% style="color:#408080; font-style:italic" %)//<!~-~- Service provider name referenced in Onyx configuration ~-~->//(%%)
520 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishProviderId"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"owePublishedRun"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
521 (% style="color:#408080; font-style:italic" %)//<!~-~- Path in URI to published tests. As the "published" in http:~/~/my.hot.system.edu/owe/published/ ~-~->//(%%)
522 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishPath"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"published"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
523 (% style="color:#408080; font-style:italic" %)//<!~-~- License dependent published test starts limits ~-~->//(%%)
524 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishLimitBase"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"20"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
525 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishLimitDemo"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"200"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
526 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishLimitPro"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"200"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
527 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishLimitCampus"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"200"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
528 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"publishLimitPublisher"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"2500"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
529 ...
530 )))
531 )))
532
533 Explanation:
534
535 (% class="wrapped" %)
536 |=(((
537 **Key**
538 )))|=(% colspan="1" %)(% colspan="1" %)
539 (((
540 Example
541 )))|=(((
542 **Description**
543 )))
544 |(% colspan="1" %)(% colspan="1" %)
545 (((
546 publishDirectory
547 )))|(% colspan="1" %)(% colspan="1" %)
548 (((
549 /intern/instances/onyxeditor/data/publish/
550 )))|(% colspan="1" %)(% colspan="1" %)
551 (((
552 Hard disc directory to copy the published tests to.
553
554 Leave empty to deactivate publish. Must end with / and must be writable for tomcat user.
555 )))
556 |(% colspan="1" %)(% colspan="1" %)
557 (((
558 publishUniqueIdPrefix
559 )))|(% colspan="1" %)(% colspan="1" %)
560 (((
561 owe
562 )))|(% colspan="1" %)(% colspan="1" %)
563 (((
564 Prefix to use for test runs in player registration. An underscore will be appended automatically.
565
566 These keys will be used in communication with Onyx player. This is configurable to adopt this according to your needs, e.g. to be able to distinguish published test runs from other ones in the Onyx player. If you do not need this just leave to value //owe//.
567 )))
568 |(% colspan="1" %)(% colspan="1" %)
569 (((
570 publishProviderWs
571 )))|(% colspan="1" %)(% colspan="1" %)
572 (((
573 [[http:~~/~~/my.hot.system.edu/onyx>>url:http://my.hot.system.edu/onyx||shape="rect"]]
574 )))|(% colspan="1" %)(% colspan="1" %)
575 (((
576 Service provider Onyx WS location. If not there the preview player instance will be used.
577
578 This is the URL to the Onyx player. May be the same as the preview player instance. Please do not enter a trailing slash!
579 )))
580 |(% colspan="1" %)(% colspan="1" %)
581 (((
582 publishProviderId
583 )))|(% colspan="1" %)(% colspan="1" %)
584 (((
585 owePublishedRun
586 )))|(% colspan="1" %)(% colspan="1" %)
587 (((
588 Service provider name referenced in Onyx configuration.
589
590 This value must be configured in Onyx player configuration as a valid service provider and with the Onyx Editor URL as results destination.
591 )))
592 |(% colspan="1" %)(% colspan="1" %)
593 (((
594 publishPath
595 )))|(% colspan="1" %)(% colspan="1" %)
596 (((
597 published
598 )))|(% colspan="1" %)(% colspan="1" %)
599 (((
600 Path in URI to published tests. As the "published" in [[http:~~/~~/my.hot.system.edu/owe/published/>>url:http://my.hot.system.edu/owe/published/||shape="rect"]]
601
602 This the last part of the URLs communicated to the users to use the published tests. The server domain is automatically taken from the current system.
603 )))
604 |(% colspan="1" %)(% colspan="1" %)
605 (((
606 publishLimitBase
607 publishLimitDemo
608 publishLimitPro
609 publishLimitCampus
610 publishLimitPublisher
611 )))|(% colspan="1" %)(% colspan="1" %)
612 (((
613 200
614 )))|(% colspan="1" %)(% colspan="1" %)
615 (((
616 License dependent published test starts limits.
617
618 The test start count of published tests is restricted according to the publishing users license. The default values are configurable here.
619 )))
620
621 ===== Check of the publish configuration =====
622
623 Few seconds after application startup there is a publish functionality check log printed to webeditor.log looking like this:
624
625 (% class="box" %)
626 (((
627 (% class="code" %)
628 (((
629 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~**(%%)
630 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) Publish functionality initialization (% style="color:#666666" %)*(%%)
631 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="border:1px solid #ff0000" %)°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°(%%) (% style="color:#666666" %)*(%%)
632 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="color:#666666" %)*(%%)
633 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) Directory(% style="color:#666666" %):(%%) (% style="color:#bb6688" %)/.../onyxeditor/data/publish/(%%)
634 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="color:#666666" %)*(%%)
635 (% style="color:#666666" %)04:26:59,301-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) Statistics from file system (% style="color:#666666" %)((%%)may differ from DB(% style="color:#666666" %)):(%%) (% style="color:#666666" %)*(%%)
636 (% style="color:#666666" %)04:26:59,304-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="color:#666666" %)*(%%) Published tests(% style="color:#666666" %):(%%) (% style="color:#666666" %)18(%%)
637 (% style="color:#666666" %)04:26:59,306-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="color:#666666" %)*(%%) Stored results (% style="color:#666666" %):(%%) (% style="color:#666666" %)15(%%)
638 (% style="color:#666666" %)04:26:59,306-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-*(%%) (% style="color:#666666" %)*(%%)
639 (% style="color:#666666" %)04:26:59,306-[(%%)localhost(% style="color:#666666" %)-(%%)startStop(% style="color:#666666" %)-1](%%) INFO (% style="color:#666666" %)-(%%)PublishManager (% style="color:#666666" %)-~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~**
640 )))
641 )))
642
643 If there were problems with publish configuration or initialization such as missing write access rights this will be mentioned here.
644
645 ==== LTI ====
646
647 LTI functionality can be configured using the following XML:
648
649 (% class="box" %)
650 (((
651 (% class="code" %)
652 (((
653 ...
654 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
655 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI ~-~->//(%%)
656 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
657 (% style="color:#408080; font-style:italic" %)//<!~-~- For documentation of LTI parameters see https:~/~/www.imsglobal.org/specs/ltiv2p0/implementation-guide ~-~->//(%%)
658 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
659 (% style="color:#408080; font-style:italic" %)//<!~-~- All parameters are mandatory unless explicitly stated otherwise. ~-~->//(%%)
660 (% style="color:#408080; font-style:italic" %)//<!~-~- ~-~->//(%%)
661 (% style="color:#408080; font-style:italic" %)//<!~-~- Name of the product instance. Must be unique for every ONYX Editor instances acting as LTI tool provider. ~-~->//(%%)
662 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductInstance"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX Testsuite (Live)"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
663 (% style="color:#408080; font-style:italic" %)//<!~-~- Name of the tool as can be displayed by tool consumer. ~-~->//(%%)
664 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductInfoToolName"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX Testsuite"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
665 (% style="color:#408080; font-style:italic" %)//<!~-~- Description of the tool as can be displayed by tool consumer. ~-~->//(%%)
666 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductInfoToolDescription"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX Testsuite is a professional IMS QTI 2.1 assessment system for authoring, delivery and reporting exercises and exams."(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
667 (% style="color:#408080; font-style:italic" %)//<!~-~- Optional. If not configured the ONYX version will be used ~-~->//(%%)
668 (% style="color:#408080; font-style:italic" %)//<!~-~- <property name="ltiProductInfoVersion" value="10.0" /> ~-~->//(%%)
669 (% style="color:#408080; font-style:italic" %)//<!~-~- Technical description of the tool as can be displayed by tool consumer. ~-~->//(%%)
670 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductInfoToolTechnical"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX Testsuite is an IMS QTI 2.1 delivery engine. It integrates the ONYX Editor for authoring IMS QTI 2.1 item and test files."(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
671 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool provider product family id ~-~->//(%%)
672 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductFamilyId"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
673 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool provider product family code. ~-~->//(%%)
674 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiProductFamilyCode"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
675 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers vendor code ~-~->//(%%)
676 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiVendorCode"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"BPS"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
677 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers vendor name ~-~->//(%%)
678 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiVendorName"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"BPS Bildungsportal Sachsen GmbH"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
679 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers vendor description ~-~->//(%%)
680 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiVendorDescription"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"BPS Bildungsportal Sachsen GmbH develops professional e-learning services for educational organizations, companies and public institutions. We assist you with our high-quality products and services."(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
681 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers vendor website ~-~->//(%%)
682 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiVendorWebsite"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"https:~/~/www.onyx-testsuite.de/"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
683 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers resource handler name. This is what the end users in LTI tool consumer can select from. ~-~->//(%%)
684 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiResourceHandlerName"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"ONYX Testsuite"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
685 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool provider URI. This is transmitted from LTI tool provider to tool consumer for backend communication. ~-~->//(%%)
686 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiUrl"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"https:~/~/onyx-editor.de/editor"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
687 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers internal port (the one listening on server side). Must be given. ~-~->//(%%)
688 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiInternalPort"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"20000"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
689 (% style="color:#408080; font-style:italic" %)//<!~-~- LTI tool providers external port (the one which is SSL enabled and will be communicated by LTI TP to TC to use in GUI. Must be given, but may be the same as internal port if this is already SSL enabled. ~-~->//(%%)
690 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"ltiExternalPort"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"8443"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
691 ...
692 )))
693 )))
694
695 Explanation:
696
697 (% class="wrapped" %)
698 |=(((
699 Key
700 )))|=(((
701 Example
702 )))|=(((
703 Description
704 )))
705 |(((
706 {{{ltiProductInstance}}}
707 )))|(((
708 ONYX Customer X
709 )))|(((
710 Name of the product instance. Must be unique for every ONYX Editor instances acting as LTI tool provider.
711
712 **This is also the main config key. If this is not given, the whole LTI functionality will be disabled.**
713 )))
714 |(((
715 {{{ltiProductInfoToolName}}}
716 )))|(((
717 ONYX
718 )))|(((
719 Name of the tool as can be displayed by tool consumer.
720 )))
721 |(((
722 {{{ltiProductInfoToolDescription}}}
723 )))|(((
724 ONYX shows and automatically evaluates tests.
725 )))|(((
726 Description of the tool as can be displayed by tool consumer.
727 )))
728 |(((
729 {{{ltiProductInfoVersion}}}
730 )))|(((
731 10.0
732 )))|(((
733 Optional. If not configured the ONYX version will be used
734 )))
735 |(((
736 {{{ltiProductInfoToolTechnical}}}
737 )))|(((
738 ONYX imports QTI test files and show them to users very fancyly.
739 )))|(((
740 Technical description of the tool as can be displayed by tool consumer.
741 )))
742 |(% colspan="1" %)(% colspan="1" %)
743 (((
744 {{{ltiProductFamilyId}}}
745 )))|(% colspan="1" %)(% colspan="1" %)
746 (((
747 {{{https://www.bps-system.de/cms/index.php?id=43&amp;L=1}}}
748 )))|(% colspan="1" %)(% colspan="1" %)
749 (((
750 LTI tool provider product family id
751 )))
752 |(% colspan="1" %)(% colspan="1" %)
753 (((
754 {{{ltiProductFamilyCode}}}
755 )))|(% colspan="1" %)(% colspan="1" %)
756 (((
757 onyx
758 )))|(% colspan="1" %)(% colspan="1" %)
759 (((
760 LTI tool provider product family code.
761 )))
762 |(% colspan="1" %)(% colspan="1" %)
763 (((
764 {{{ltiVendorCode}}}
765 )))|(% colspan="1" %)(% colspan="1" %)
766 (((
767 BPS
768 )))|(% colspan="1" %)(% colspan="1" %)
769 (((
770 LTI tool providers vendor code.
771 )))
772 |(% colspan="1" %)(% colspan="1" %)
773 (((
774 {{{ltiVendorName}}}
775 )))|(% colspan="1" %)(% colspan="1" %)
776 (((
777 BPS Bildungsportal Sachsen GmbH
778 )))|(% colspan="1" %)(% colspan="1" %)
779 (((
780 LTI tool providers vendor name
781 )))
782 |(% colspan="1" %)(% colspan="1" %)
783 (((
784 {{{ltiVendorDescription}}}
785 )))|(% colspan="1" %)(% colspan="1" %)
786 (((
787 BPS GmbH develops professional e-learning services...
788 )))|(% colspan="1" %)(% colspan="1" %)
789 (((
790 LTI tool providers vendor description
791 )))
792 |(% colspan="1" %)(% colspan="1" %)
793 (((
794 {{{ltiVendorWebsite}}}
795 )))|(% colspan="1" %)(% colspan="1" %)
796 (((
797 {{{https://www.bps-system.de/cms/en/welcome/}}}
798 )))|(% colspan="1" %)(% colspan="1" %)
799 (((
800 LTI tool providers vendor website
801 )))
802 |(% colspan="1" %)(% colspan="1" %)
803 (((
804 {{{ltiResourceHandlerName}}}
805 )))|(% colspan="1" %)(% colspan="1" %)
806 (((
807 ONYX
808 )))|(% colspan="1" %)(% colspan="1" %)
809 (((
810 LTI tool providers resource handler name. This is what the end users in LTI tool consumer can select from.
811 )))
812 |(% colspan="1" %)(% colspan="1" %)
813 (((
814 {{{ltiUrl}}}
815 )))|(% colspan="1" %)(% colspan="1" %)
816 (((
817 {{{https://next.bps-system.de}}}
818 )))|(% colspan="1" %)(% colspan="1" %)
819 (((
820 LTI tool provider URI. This is transmitted from LTI tool provider to tool consumer for backend communication.
821 )))
822 |(% colspan="1" %)(% colspan="1" %)
823 (((
824 {{{ltiInternalPort}}}
825 )))|(% colspan="1" %)(% colspan="1" %)
826 (((
827 20000
828 )))|(% colspan="1" %)(% colspan="1" %)
829 (((
830 LTI tool providers internal port (the one listening on server side). Must be given.
831 )))
832 |(% colspan="1" %)(% colspan="1" %)
833 (((
834 {{{ltiExternalPort}}}
835 )))|(% colspan="1" %)(% colspan="1" %)
836 (((
837 8443
838 )))|(% colspan="1" %)(% colspan="1" %)
839 (((
840 LTI tool providers external port (the one which is SSL enabled and will be communicated by LTI TP to TC to use in GUI. Must be given, but may be the same as internal port if this is already SSL enabled.
841 )))
842
843 For documentation of LTI specific parameters as product info tool name, see [[https:~~/~~/www.imsglobal.org/specs/ltiv2p0/implementation-guide>>url:https://www.imsglobal.org/specs/ltiv2p0/implementation-guide||shape="rect"]]
844
845 ==== Database connection ====
846
847 The connection to database example:
848
849 (% class="box" %)
850 (((
851 (% class="code" %)
852 (((
853 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"dbDriverClass"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"org.postgresql.Driver"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
854 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"dbConnectionUrl"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"jdbc:postgresql:~/~/localhost:5432/dbname"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
855 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"dbUserName"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"username"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
856 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"dbPassword"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"userpassword"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
857 (% style="color:#008000; font-weight:bold" %)**<property**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"dbDialect"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"org.hibernate.dialect.PostgreSQLDialect"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
858 )))
859 )))
860
861 === Reporter configuration ===
862
863 *
864 ** ===
865
866 (% class="box" %)
867 (((
868 (% class="code" %)
869 (((
870 WEB-INF/classes/de/bps/onyx/context/webServiceContext.xml
871 )))
872 )))
873
874 This file contains the configuration for the connection of the ONYX Player (include the ONYX Reporter). This ONYX Reporter is used for statistic issues.
875
876 Example:
877
878 (% class="box" %)
879 (((
880 (% class="code" %)
881 (((
882 ...
883 (% style="color:#008000; font-weight:bold" %)**<bean**(%%) (% style="color:#7d9029" %)id=(% style="color:#ba2121" %)"OnyxReporterTarget"(%%) (% style="color:#7d9029" %)class=(% style="color:#ba2121" %)"de.bps.onyx.manager.reporter.service.OnyxReporterTarget"(% style="color:#008000; font-weight:bold" %)**>**(%%)
884 (% style="color:#008000; font-weight:bold" %)**<constructor-arg**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"target"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"https:~/~/onyx.bps-system.de/preview/reporterservices"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
885 (% style="color:#008000; font-weight:bold" %)**</bean>**(%%)
886 \\(% style="color:#008000; font-weight:bold" %)**<bean**(%%) (% style="color:#7d9029" %)id=(% style="color:#ba2121" %)"OnyxReporterProvider"(%%) (% style="color:#7d9029" %)class=(% style="color:#ba2121" %)"de.bps.onyx.manager.reporter.service.OnyxReporterProvider"(% style="color:#008000; font-weight:bold" %)**>**(%%)
887 (% style="color:#008000; font-weight:bold" %)**<constructor-arg**(%%) (% style="color:#7d9029" %)name=(% style="color:#ba2121" %)"id"(%%) (% style="color:#7d9029" %)value=(% style="color:#ba2121" %)"previewid"(%%) (% style="color:#008000; font-weight:bold" %)**/>**(%%)
888 (% style="color:#008000; font-weight:bold" %)**</bean>**(%%)
889 ...
890 )))
891 )))
892
893 In this example is the ONYX Player used at URL [[https:~~/~~/onyx.bps-system.de/preview/ .>>url:https://onyx.bps-system.de/preview/.&nbsp||rel="nofollow" shape="rect" class="external text"]] The serviceprovider name (used by ONYX Player) is: previewed
894
895 == MAXIMA for calculations ==
896
897 Install MAXIMA, if you like to use calculations. MAXIMA is used for the interaction types [[calculation >>path:/wiki/bin/create/ONYX/Systeminformationen/Installation%20ONYX%20Editor/Berechnungsaufgabe?parent=ONYX.Systeminformationen.Installation+ONYX+Editor.WebHome]]and [[formula comparison>>path:/wiki/bin/create/ONYX/Systeminformationen/Installation%20ONYX%20Editor/Formelvergleich?parent=ONYX.Systeminformationen.Installation+ONYX+Editor.WebHome]] and also for(% class="confluence-link" %)variable[[ >>path:/wiki/bin/create/ONYX/Systeminformationen/Installation%20ONYX%20Editor/Variablen%20verwenden?parent=ONYX.Systeminformationen.Installation+ONYX+Editor.WebHome]] (%%)support.
898
899 Installation on RHEL/Fedora/CentOS:
900
901 (% class="box" %)
902 (((
903 (% class="code" %)
904 (((
905 sudo yum install maxima
906 )))
907 )))
908
909 Installation on Debian/Ubuntu/Mint:
910
911 (% class="box" %)
912 (((
913 (% class="code" %)
914 (((
915 sudo aptitude install maxima
916 )))
917 )))
918
919 Or visit [[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files
920
921 == Log files ==
922
923 (% class="box" %)
924 (((
925 (% class="code" %)
926 (((
927 (% style="color:#666666" %)[(%%)root@bps0206 logs(% style="color:#666666" %)](% style="border:1px solid #ff0000" %)#(% style="color:#bbbbbb" %) (% style="color:#008000; font-weight:bold" %)**less**(% style="color:#bbbbbb" %) (% style="color:#666666" %)/(%%)opt(% style="color:#666666" %)/(%%)apache(% style="color:#666666" %)-(%%)tomcat(% style="color:#666666" %)-(%%)X.X.X(% style="color:#666666" %)/(%%)logs(% style="color:#666666" %)/(%%)webeditor.(% style="color:#0000ff" %)log(%%)
928 (% style="color:#666666" %)[(%%)root@bps0206 logs(% style="color:#666666" %)](% style="border:1px solid #ff0000" %)#(% style="color:#bbbbbb" %) (% style="color:#008000; font-weight:bold" %)**less**(% style="color:#bbbbbb" %) (% style="color:#666666" %)/(%%)opt(% style="color:#666666" %)/(%%)apache(% style="color:#666666" %)-(%%)tomcat(% style="color:#666666" %)-(%%)X.X.X(% style="color:#666666" %)/(%%)logs(% style="color:#666666" %)/(%%)catalina.(% style="color:#008000; font-weight:bold" %)**out**
929 )))
930 )))