Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 237.1
bearbeitet von Carina Enke
am 19.05.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.0.
Auf Version 276.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,70 +1,25 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
3 +{{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 +
6 +{{/layout-cell}}
5 5  
8 +{{layout-cell}}
9 +{{scroll-ignore}}
10 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
6 6  
7 -{{details}}
8 -(% class="wrapped" %)
9 -|=(((
10 -Verantwortlicher
11 -)))|(((
12 -\\
13 -)))
14 -|=(% 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" %)
20 -(((
21 -{{sv-metadata type="workflow-status"/}}
22 22  
23 -{{status colour="Green" title="Fertig"/}}
24 -)))
25 -)))
26 -|=(% colspan="1" %)(% colspan="1" %)
27 -(((
28 -Varianten
29 -)))|(% colspan="1" %)(% colspan="1" %)
30 -(((
31 -(% class="content-wrapper" %)
32 -(((
33 -{{sv-metadata type="variants"/}}
34 -)))
35 -)))
36 -|=(% colspan="1" %)(% colspan="1" %)
37 -(((
38 -Attribute
39 -)))|(% colspan="1" %)(% colspan="1" %)
40 -(((
41 -(% class="content-wrapper" %)
42 -(((
43 -{{sv-metadata type="attributes"/}}
44 -)))
45 -)))
46 -|=(% colspan="1" %)(% colspan="1" %)
47 -(((
48 -Pagekey
49 -)))|(% colspan="1" %)(% colspan="1" %)
50 -(((
51 -(% class="content-wrapper" %)
52 -(((
53 -{{sv-metadata type="pagekey"/}}
54 -)))
55 -)))
56 -|=(% colspan="1" %)(% colspan="1" %)
57 -(((
58 -TODOs
59 -)))|(% colspan="1" %)(% colspan="1" %)
60 -(((
61 -\\
62 -)))
63 -{{/details}}
13 +{{toc/}}
14 +
15 +**
16 +**
17 +{{/panel}}
18 +{{/scroll-ignore}}
64 64  {{/layout-cell}}
65 65  {{/layout-section}}
66 66  
67 -{{layout-section ac:type="two_right_sidebar"}}
22 +{{layout-section ac:type="single"}}
68 68  {{layout-cell}}
69 69  == System requirements ==
70 70  
... ... @@ -97,29 +97,12 @@
97 97  * Eclipse for JEE (Kepler or later)
98 98  * Maven2
99 99  * Eclipse Maven integration (m2)
100 -{{/layout-cell}}
101 101  
102 -{{layout-cell}}
103 -{{scroll-ignore}}
104 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
105 -
106 -
107 -{{toc/}}
108 -
109 -**
110 -**
111 -{{/panel}}
112 -{{/scroll-ignore}}
113 -{{/layout-cell}}
114 -{{/layout-section}}
115 -
116 -{{layout-section ac:type="single"}}
117 -{{layout-cell}}
118 118  == Steps for build ==
119 119  
120 120  All ONYX parts are delivered as Eclipse projects
121 121  
122 -\\
60 +
123 123  
124 124  * preOnyx (ONYX QTI test player)
125 125  * preWebEditor (ONYX QTI test editor)
... ... @@ -151,7 +151,7 @@
151 151  * Create database owe and assign to user owe
152 152  * Import setupdatabase.postgre.sql to this database
153 153  
154 -\\
92 +
155 155  
156 156  Hint: you may use other user/database names, change configuration in
157 157  
... ... @@ -204,10 +204,29 @@
204 204  
205 205  {{sv-translation language="en"}}
206 206  {{layout}}
207 -{{layout-section ac:type="two_right_sidebar"}}
145 +{{layout-section ac:type="two_equal"}}
208 208  {{layout-cell}}
209 -== System requirements ==
147 +
148 +{{/layout-cell}}
210 210  
150 +{{layout-cell}}
151 +{{scroll-ignore}}
152 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
153 +
154 +
155 +{{toc maxLevel="4"/}}
156 +
157 +**
158 +**
159 +{{/panel}}
160 +{{/scroll-ignore}}
161 +{{/layout-cell}}
162 +{{/layout-section}}
163 +
164 +{{layout-section ac:type="single"}}
165 +{{layout-cell}}
166 +== System requirements ==
167 +
211 211  === All components ===
212 212  
213 213  * (((
... ... @@ -237,54 +237,29 @@
237 237  * Eclipse for JEE (Kepler or later)
238 238  * Maven2
239 239  * Eclipse Maven integration (m2)
240 -{{/layout-cell}}
241 241  
242 -{{layout-cell}}
243 -{{scroll-ignore}}
244 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
245 -
246 -
247 -{{toc maxLevel="4"/}}
248 -
249 -**
250 -**
251 -{{/panel}}
252 -{{/scroll-ignore}}
253 -{{/layout-cell}}
254 -{{/layout-section}}
255 -
256 -{{layout-section ac:type="single"}}
257 -{{layout-cell}}
258 258  == Steps for build ==
259 259  
260 260  All ONYX parts are delivered as Eclipse projects:
261 261  
202 +* preWebOnyx (ONYX QTI test player)
203 +* preWebEditor (ONYX QTI test editor)
204 +* onyx (ONYX QTI core)
262 262  * (((
263 -preWebOnyx (ONYX QTI test player)
264 -)))
265 -* (((
266 -preWebEditor (ONYX QTI test editor)
267 -)))
268 -* (((
269 -onyx (ONYX QTI core)
270 -)))
271 -* (((
272 272  LaTeXRenderer (LaTeX image renderer connector, used to render LaTeX math formulas to images, which can be included in PDFs. This project only offers an interface to connect whatever lib you want, e.g. jlatexmath (GPL, delivered as example)
273 273  )))
274 274  
275 275  Use Eclipse:
276 276  
277 -* (((
278 -Import -> Existing project, start with LaTeXRenderer project
279 -)))
280 -* (((
281 -Import all four projects
282 -)))
211 +* Import -> Existing project, start with LaTeXRenderer project
212 +* Import all four projects
283 283  
284 284  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
285 285  
286 286  {{code}}
287 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled. Ensure that project LaTeXRenderer exports all libs in /libs folder (you may get ClassNotFoundExceptions in Tomcat otherwise, if you still get them add all libs from project LaTeXRenderer to Tomcat classpath manually)
217 +Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
218 +Ensure that project LaTeXRenderer exports all libs in /libs folder (you may get ClassNotFoundExceptions in Tomcat otherwise, if you still get them add all libs from project LaTeXRenderer to Tomcat classpath manually)
219 +
288 288  {{/code}}
289 289  
290 290  **Maven will build all projects automatically** (you can do this manually on console, anyhow this is not tested in development environment and may disturb Eclipse Maven integration)
... ... @@ -291,23 +291,13 @@
291 291  
292 292  **Setup database for ONYX WebEditor**
293 293  
294 -* (((
295 -Locate setupdatabase.postgre.sql
296 -)))
297 -* (((
298 -Log on to Postgres
299 -)))
300 -* (((
301 -Create user owe with password owe
302 -)))
303 -* (((
304 -Create database owe and assign to user owe
305 -)))
306 -* (((
307 -Import setupdatabase.postgre.sql to this database
308 -)))
226 +* Locate setupdatabase.postgre.sql
227 +* Log on to Postgres
228 +* Create user owe with password owe
229 +* Create database owe and assign to user owe
230 +* Import setupdatabase.postgre.sql to this database
309 309  
310 -\\
232 +
311 311  
312 312  Hint: you may use other user/database names, change configuration in
313 313  
... ... @@ -315,61 +315,37 @@
315 315  applicationContext.xml (see below)
316 316  {{/code}}
317 317  
318 -Changes on ONYX QTI core
240 +== Changes on ONYX QTI core ==
319 319  
320 320  Since all ONYX components are managed by Maven, the ONYX QTI core from BPS Maven artifactory is used by default. If you want to change some code you are required to create a JAR from project onyx on your own and either adopt the pom.xml references in preWebOnyx and preWebEditor to your own artifactory or put the JAR in classpath.
321 321  
322 -Configuration
244 +== Configuration ==
323 323  
324 324  **preWebOnyx**
325 325  
326 -* (((
327 -Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
328 -)))
329 -* (((
330 -Configure as needed
331 -)))
332 -* (((
333 -Service provider named “preview” is required if used as preview instance for ONYX WebEditor
334 -)))
248 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
249 +* Configure as needed
250 +* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
335 335  
336 336  **preWebEditor**
337 337  
338 -* (((
339 -applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
340 -)))
341 -* (((
342 -metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
343 -)))
344 -* (((
345 -moduleConfigurationContext.xml: repository configuration
346 -)))
347 -* (((
348 -pageModelContext.xml: normally no changes required, defines the main tabs in shown application
349 -)))
350 -* (((
351 -webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
352 -)))
254 +* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
255 +* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
256 +* moduleConfigurationContext.xml: repository configuration
257 +* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
258 +* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
353 353  
354 -Deployment
260 +== Deployment ==
355 355  
262 +* Deploy preWebOnyx and preWebEditor to Tomcat in Eclipse (it is recommended to use two Tomcat servers in Eclipse to be able to restart both independently)
263 +* Configure Tomcat deployment to use different ports
264 +* Check path the applications are mounted to
265 +* Start Tomcat(s)
356 356  * (((
357 -Deploy preWebOnyx and preWebEditor to Tomcat in Eclipse (it is recommended to use two Tomcat servers in Eclipse to be able to restart both independently)
358 -)))
359 -* (((
360 -Configure Tomcat deployment to use different ports
361 -)))
362 -* (((
363 -Check path the applications are mounted to
364 -)))
365 -* (((
366 -Start Tomcat(s)
367 -)))
368 -* (((
369 369  Call http:~/~/localhost:<port>/<path> in browser
370 370  )))
371 371  
372 -Important notes
270 +== Important notes ==
373 373  
374 374  **Before running any ONYX application** in Eclipse/Tomcat, always **clean Tomcat Work Directory** first. This is also required in server environment after each update. Since ONYX creates large amounts of temporary files in server environment it is also strictly recommended to clean servers and tomcat temp directory before each application starts.
375 375  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -337413502
1 +301073193
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/337413502/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073193/Projekt Setupguide ONYX