Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024

Von Version 279.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 275.1
bearbeitet von Carina Enke
am 22.01.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.9.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,25 +1,10 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
4 -{{layout-cell}}
5 -
6 -{{/layout-cell}}
7 -
8 -{{layout-cell}}
9 -{{scroll-ignore}}
10 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
11 -
12 -
13 -{{toc/}}
14 -
15 -**
16 -**
17 -{{/panel}}
18 -{{/scroll-ignore}}
19 -{{/layout-cell}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
20 20  {{/layout-section}}
21 21  
22 -{{layout-section ac:type="single"}}
7 +{{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)
40 +{{/layout-cell}}
55 55  
42 +{{layout-cell}}
43 +{{scroll-ignore}}
44 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
45 +
46 +
47 +{{toc/}}
48 +
49 +**
50 +**
51 +{{/panel}}
52 +{{/scroll-ignore}}
53 +{{/layout-cell}}
54 +{{/layout-section}}
55 +
56 +{{layout-section ac:type="single"}}
57 +{{layout-cell}}
56 56  == Steps for build ==
57 57  
58 58  All ONYX parts are delivered as Eclipse projects
59 59  
60 -
62 +\\
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 -
94 +\\
93 93  
94 94  Hint: you may use other user/database names, change configuration in
95 95  
... ... @@ -142,24 +142,10 @@
142 142  
143 143  {{sv-translation language="en"}}
144 144  {{layout}}
145 -{{layout-section ac:type="two_equal"}}
147 +{{layout-section ac:type="two_right_sidebar"}}
146 146  {{layout-cell}}
147 -====== Content: ======
149 +== System requirements ==
148 148  
149 -
150 -
151 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
152 -{{/layout-cell}}
153 -
154 -{{layout-cell}}
155 -
156 -{{/layout-cell}}
157 -{{/layout-section}}
158 -
159 -{{layout-section ac:type="single"}}
160 -{{layout-cell}}
161 -== System requirements ==
162 -
163 163  === All components ===
164 164  
165 165  * (((
... ... @@ -166,10 +166,10 @@
166 166  Linux-based OS
167 167  )))
168 168  * (((
169 -Oracle Java8 (latest update)
157 +Java 11 (Oracle or OpenJDK)
170 170  )))
171 171  * (((
172 -Apache Tomcat8 (latest update)
160 +Apache Tomcat 9
173 173  )))
174 174  
175 175  === ONYX WebEditor (additionally) ===
... ... @@ -185,33 +185,58 @@
185 185  === Build process ===
186 186  
187 187  * Linux-based OS
188 -* Oracle Java7 (latest update)
176 +* Java 11 (Oracle or OpenJDK)
189 189  * Eclipse for JEE (Kepler or later)
190 190  * Maven2
191 191  * Eclipse Maven integration (m2)
180 +{{/layout-cell}}
192 192  
182 +{{layout-cell}}
183 +{{scroll-ignore}}
184 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
185 +
186 +
187 +{{toc maxLevel="4"/}}
188 +
189 +**
190 +**
191 +{{/panel}}
192 +{{/scroll-ignore}}
193 +{{/layout-cell}}
194 +{{/layout-section}}
195 +
196 +{{layout-section ac:type="single"}}
197 +{{layout-cell}}
193 193  == Steps for build ==
194 194  
195 195  All ONYX parts are delivered as Eclipse projects:
196 196  
197 -* preWebOnyx (ONYX QTI test player)
198 -* preWebEditor (ONYX QTI test editor)
199 -* onyx (ONYX QTI core)
200 200  * (((
203 +preWebOnyx (ONYX QTI test player)
204 +)))
205 +* (((
206 +preWebEditor (ONYX QTI test editor)
207 +)))
208 +* (((
209 +onyx (ONYX QTI core)
210 +)))
211 +* (((
201 201  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)
202 202  )))
203 203  
204 204  Use Eclipse:
205 205  
206 -* Import -> Existing project, start with LaTeXRenderer project
207 -* Import all four projects
217 +* (((
218 +Import -> Existing project, start with LaTeXRenderer project
219 +)))
220 +* (((
221 +Import all four projects
222 +)))
208 208  
209 209  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
210 210  
211 211  {{code}}
212 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
213 -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)
214 -
227 +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)
215 215  {{/code}}
216 216  
217 217  **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)
... ... @@ -218,13 +218,23 @@
218 218  
219 219  **Setup database for ONYX WebEditor**
220 220  
221 -* Locate setupdatabase.postgre.sql
222 -* Log on to Postgres
223 -* Create user owe with password owe
224 -* Create database owe and assign to user owe
225 -* Import setupdatabase.postgre.sql to this database
234 +* (((
235 +Locate setupdatabase.postgre.sql
236 +)))
237 +* (((
238 +Log on to Postgres
239 +)))
240 +* (((
241 +Create user owe with password owe
242 +)))
243 +* (((
244 +Create database owe and assign to user owe
245 +)))
246 +* (((
247 +Import setupdatabase.postgre.sql to this database
248 +)))
226 226  
227 -
250 +\\
228 228  
229 229  Hint: you may use other user/database names, change configuration in
230 230  
... ... @@ -232,43 +232,67 @@
232 232  applicationContext.xml (see below)
233 233  {{/code}}
234 234  
235 -== Changes on ONYX QTI core ==
258 +Changes on ONYX QTI core
236 236  
237 237  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.
238 238  
239 -== Configuration ==
262 +Configuration
240 240  
241 241  **preWebOnyx**
242 242  
243 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
244 -* Configure as needed
245 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
266 +* (((
267 +Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
268 +)))
269 +* (((
270 +Configure as needed
271 +)))
272 +* (((
273 +Service provider named “preview” is required if used as preview instance for ONYX WebEditor
274 +)))
246 246  
247 247  **preWebEditor**
248 248  
249 -* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
250 -* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
251 -* moduleConfigurationContext.xml: repository configuration
252 -* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
253 -* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
278 +* (((
279 +applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
280 +)))
281 +* (((
282 +metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
283 +)))
284 +* (((
285 +moduleConfigurationContext.xml: repository configuration
286 +)))
287 +* (((
288 +pageModelContext.xml: normally no changes required, defines the main tabs in shown application
289 +)))
290 +* (((
291 +webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
292 +)))
254 254  
255 -== Deployment ==
294 +Deployment
256 256  
257 -* 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)
258 -* Configure Tomcat deployment to use different ports
259 -* Check path the applications are mounted to
260 -* Start Tomcat(s)
261 261  * (((
297 +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)
298 +)))
299 +* (((
300 +Configure Tomcat deployment to use different ports
301 +)))
302 +* (((
303 +Check path the applications are mounted to
304 +)))
305 +* (((
306 +Start Tomcat(s)
307 +)))
308 +* (((
262 262  Call http:~/~/localhost:<port>/<path> in browser
263 263  )))
264 264  
265 -== Important notes ==
312 +Important notes
266 266  
267 267  **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.
268 268  
269 269  When run from Eclipse/Tomcat ONYX applications may not shut down properly. In this case just “kill” them using the red “Terminate” button in console view.
270 270  
271 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
318 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
272 272  {{/layout-cell}}
273 273  {{/layout-section}}
274 274  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226231250
1 +301073241
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226231250/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073241/Projekt Setupguide ONYX