Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von 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.
Auf 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.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,25 +1,70 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-section ac:type="single"}}
4 4  {{layout-cell}}
5 -
6 -{{/layout-cell}}
7 7  
8 -{{layout-cell}}
9 -{{scroll-ignore}}
10 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
11 11  
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"/}}
12 12  
13 -{{toc/}}
14 -
15 -**
16 -**
17 -{{/panel}}
18 -{{/scroll-ignore}}
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}}
19 19  {{/layout-cell}}
20 20  {{/layout-section}}
21 21  
22 -{{layout-section ac:type="single"}}
67 +{{layout-section ac:type="two_right_sidebar"}}
23 23  {{layout-cell}}
24 24  == System requirements ==
25 25  
... ... @@ -52,12 +52,29 @@
52 52  * Eclipse for JEE (Kepler or later)
53 53  * Maven2
54 54  * Eclipse Maven integration (m2)
100 +{{/layout-cell}}
55 55  
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}}
56 56  == Steps for build ==
57 57  
58 58  All ONYX parts are delivered as Eclipse projects
59 59  
60 -
122 +\\
61 61  
62 62  * preOnyx (ONYX QTI test player)
63 63  * preWebEditor (ONYX QTI test editor)
... ... @@ -89,7 +89,7 @@
89 89  * Create database owe and assign to user owe
90 90  * Import setupdatabase.postgre.sql to this database
91 91  
92 -
154 +\\
93 93  
94 94  Hint: you may use other user/database names, change configuration in
95 95  
... ... @@ -142,29 +142,10 @@
142 142  
143 143  {{sv-translation language="en"}}
144 144  {{layout}}
145 -{{layout-section ac:type="two_equal"}}
207 +{{layout-section ac:type="two_right_sidebar"}}
146 146  {{layout-cell}}
147 -
148 -{{/layout-cell}}
209 +== System requirements ==
149 149  
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 -
168 168  === All components ===
169 169  
170 170  * (((
... ... @@ -194,29 +194,54 @@
194 194  * Eclipse for JEE (Kepler or later)
195 195  * Maven2
196 196  * Eclipse Maven integration (m2)
240 +{{/layout-cell}}
197 197  
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}}
198 198  == Steps for build ==
199 199  
200 200  All ONYX parts are delivered as Eclipse projects:
201 201  
202 -* preWebOnyx (ONYX QTI test player)
203 -* preWebEditor (ONYX QTI test editor)
204 -* onyx (ONYX QTI core)
205 205  * (((
263 +preWebOnyx (ONYX QTI test player)
264 +)))
265 +* (((
266 +preWebEditor (ONYX QTI test editor)
267 +)))
268 +* (((
269 +onyx (ONYX QTI core)
270 +)))
271 +* (((
206 206  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)
207 207  )))
208 208  
209 209  Use Eclipse:
210 210  
211 -* Import -> Existing project, start with LaTeXRenderer project
212 -* Import all four projects
277 +* (((
278 +Import -> Existing project, start with LaTeXRenderer project
279 +)))
280 +* (((
281 +Import all four projects
282 +)))
213 213  
214 214  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
215 215  
216 216  {{code}}
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 -
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)
220 220  {{/code}}
221 221  
222 222  **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)
... ... @@ -223,13 +223,23 @@
223 223  
224 224  **Setup database for ONYX WebEditor**
225 225  
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
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 +)))
231 231  
232 -
310 +\\
233 233  
234 234  Hint: you may use other user/database names, change configuration in
235 235  
... ... @@ -237,37 +237,61 @@
237 237  applicationContext.xml (see below)
238 238  {{/code}}
239 239  
240 -== Changes on ONYX QTI core ==
318 +Changes on ONYX QTI core
241 241  
242 242  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.
243 243  
244 -== Configuration ==
322 +Configuration
245 245  
246 246  **preWebOnyx**
247 247  
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
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 +)))
251 251  
252 252  **preWebEditor**
253 253  
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
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 +)))
259 259  
260 -== Deployment ==
354 +Deployment
261 261  
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)
266 266  * (((
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 +* (((
267 267  Call http:~/~/localhost:<port>/<path> in browser
268 268  )))
269 269  
270 -== Important notes ==
372 +Important notes
271 271  
272 272  **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.
273 273  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -301073193
1 +337413502
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073193/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/337413502/Projekt Setupguide ONYX