Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 24.11.2025
Von Version 166.1
bearbeitet von Carina Enke
am 08.03.2022
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 354.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Projekt Setupguide ONYX
1 +ONYX project setup guide
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.carina
1 +XWiki.sandra_riediger
Inhalt
... ... @@ -1,12 +2,42 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
2 +{{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -\\
4 +====== Inhalt: ======
5 +
6 +
7 +
8 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
6 6  {{/layout-cell}}
10 +
11 +{{layout-cell}}
12 +|=(% colspan="1" %)(% colspan="1" %)
13 +(((
14 +Programmversion
15 +)))|(% colspan="1" %)(% colspan="1" %)
16 +(((
17 +
18 +)))
19 +|=(((
20 +Status
21 +)))|(((
22 +(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
23 +)))
24 +|=(((
25 +Aufgaben
26 +)))|(((
27 +
28 +
29 +
30 +)))
31 +|=(((
32 +JIRA
33 +)))|(((
34 +
35 +)))
36 +{{/layout-cell}}
7 7  {{/layout-section}}
8 8  
9 -{{layout-section ac:type="two_right_sidebar"}}
39 +{{layout-section ac:type="single"}}
10 10  {{layout-cell}}
11 11  == System requirements ==
12 12  
... ... @@ -16,15 +16,15 @@
16 16  Linux-based OS
17 17  )))
18 18  * (((
19 -Java 17
49 +Oracle Java8 (latest update)
20 20  )))
21 21  * (((
22 -Apache Tomcat 9 (latest update)
52 +Apache Tomcat8 (latest update)
23 23  )))
24 24  
25 -=== ONYX Editor (additionally) ===
55 +=== ONYX WebEditor (additionally) ===
26 26  
27 -* PostgreSQL 12
57 +* PostGreSQL (8.4.21 or later)
28 28  * Java unlimited security enabled
29 29  
30 30  {{code}}
... ... @@ -35,47 +35,18 @@
35 35  === Build process ===
36 36  
37 37  * Linux-based OS
38 -* Java 11 (latest update, Oracle or OpenJDK)
68 +* Oracle Java7 (latest update)
39 39  * Eclipse for JEE (Kepler or later)
40 40  * Maven2
41 41  * Eclipse Maven integration (m2)
42 -{{/layout-cell}}
43 43  
44 -{{layout-cell}}
45 -(% class="auto-cursor-target" %)
46 -\\
47 -
48 -{{scroll-ignore}}
49 -(% class="auto-cursor-target" %)
50 -\\
51 -
52 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
53 -
54 -
55 -{{toc/}}
56 -
57 -**
58 -**
59 -{{/panel}}
60 -
61 -(% class="auto-cursor-target" %)
62 -\\
63 -{{/scroll-ignore}}
64 -
65 -(% class="auto-cursor-target" %)
66 -\\
67 -{{/layout-cell}}
68 -{{/layout-section}}
69 -
70 -{{layout-section ac:type="single"}}
71 -{{layout-cell}}
72 72  == Steps for build ==
73 73  
74 74  All ONYX parts are delivered as Eclipse projects
75 75  
76 -\\
77 +
77 77  
78 -* preOnyx (ONYX QTI test player)
79 +* preWebOnyx (ONYX QTI test player)
79 79  * preWebEditor (ONYX QTI test editor)
80 80  * onyx (ONYX QTI core)
81 81  * 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)
... ... @@ -97,7 +97,7 @@
97 97  
98 98  (% style="line-height: 1.4285715;" %)**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)
99 99  
100 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
101 +(% style="line-height: 1.4285715;" %)**Setup database for ONYX WebEditor**
101 101  
102 102  * Locate setupdatabase.postgre.sql
103 103  * Log on to Postgres
... ... @@ -105,7 +105,7 @@
105 105  * Create database owe and assign to user owe
106 106  * Import setupdatabase.postgre.sql to this database
107 107  
108 -\\
109 +
109 109  
110 110  Hint: you may use other user/database names, change configuration in
111 111  
... ... @@ -123,7 +123,7 @@
123 123  
124 124  * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
125 125  * Configure as needed
126 -* Service provider named “preview” is required if used as preview instance for ONYX Editor
127 +* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
127 127  
128 128  **preWebEditor**
129 129  
... ... @@ -147,190 +147,26 @@
147 147  
148 148  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.
149 149  
150 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
151 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
151 151  
152 152  **
153 153  **
154 154  {{/layout-cell}}
155 155  {{/layout-section}}
156 -{{/layout}}
157 -{{/sv-translation}}
158 158  
159 -{{sv-translation language="en"}}
160 -{{layout}}
161 161  {{layout-section ac:type="two_right_sidebar"}}
162 162  {{layout-cell}}
163 -== System requirements ==
160 +====== untergeordnete Seiten: ======
164 164  
165 -=== All components ===
166 166  
167 -* (((
168 -Linux-based OS
169 -)))
170 -* (((
171 -Java 11 (Oracle or OpenJDK)
172 -)))
173 -* (((
174 -Apache Tomcat 9
175 -)))
176 176  
177 -=== ONYX WebEditor (additionally) ===
178 -
179 -* PostGreSQL (8.4.21 or later)
180 -* Java unlimited security enabled
181 -
182 -{{code}}
183 -http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
184 -Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
185 -{{/code}}
186 -
187 -=== Build process ===
188 -
189 -* Linux-based OS
190 -* Java 11 (Oracle or OpenJDK)
191 -* Eclipse for JEE (Kepler or later)
192 -* Maven2
193 -* Eclipse Maven integration (m2)
164 +{{children all="true"/}}
194 194  {{/layout-cell}}
195 195  
196 196  {{layout-cell}}
197 -{{scroll-ignore}}
198 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
168 +====== relevante Links: ======
199 199  
200 -
201 -{{toc maxLevel="4"/}}
202 -
203 -**
204 -**
205 -{{/panel}}
206 -{{/scroll-ignore}}
170 +* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
207 207  {{/layout-cell}}
208 208  {{/layout-section}}
209 -
210 -{{layout-section ac:type="single"}}
211 -{{layout-cell}}
212 -== Steps for build ==
213 -
214 -All ONYX parts are delivered as Eclipse projects:
215 -
216 -* (((
217 -preWebOnyx (ONYX QTI test player)
218 -)))
219 -* (((
220 -preWebEditor (ONYX QTI test editor)
221 -)))
222 -* (((
223 -onyx (ONYX QTI core)
224 -)))
225 -* (((
226 -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)
227 -)))
228 -
229 -Use Eclipse:
230 -
231 -* (((
232 -Import -> Existing project, start with LaTeXRenderer project
233 -)))
234 -* (((
235 -Import all four projects
236 -)))
237 -
238 -Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
239 -
240 -{{code}}
241 -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)
242 -{{/code}}
243 -
244 -**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)
245 -
246 -**Setup database for ONYX WebEditor**
247 -
248 -* (((
249 -Locate setupdatabase.postgre.sql
250 -)))
251 -* (((
252 -Log on to Postgres
253 -)))
254 -* (((
255 -Create user owe with password owe
256 -)))
257 -* (((
258 -Create database owe and assign to user owe
259 -)))
260 -* (((
261 -Import setupdatabase.postgre.sql to this database
262 -)))
263 -
264 -\\
265 -
266 -Hint: you may use other user/database names, change configuration in
267 -
268 -{{code}}
269 -applicationContext.xml (see below)
270 -{{/code}}
271 -
272 -Changes on ONYX QTI core
273 -
274 -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.
275 -
276 -Configuration
277 -
278 -**preWebOnyx**
279 -
280 -* (((
281 -Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
282 -)))
283 -* (((
284 -Configure as needed
285 -)))
286 -* (((
287 -Service provider named “preview” is required if used as preview instance for ONYX WebEditor
288 -)))
289 -
290 -**preWebEditor**
291 -
292 -* (((
293 -applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
294 -)))
295 -* (((
296 -metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
297 -)))
298 -* (((
299 -moduleConfigurationContext.xml: repository configuration
300 -)))
301 -* (((
302 -pageModelContext.xml: normally no changes required, defines the main tabs in shown application
303 -)))
304 -* (((
305 -webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
306 -)))
307 -
308 -Deployment
309 -
310 -* (((
311 -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)
312 -)))
313 -* (((
314 -Configure Tomcat deployment to use different ports
315 -)))
316 -* (((
317 -Check path the applications are mounted to
318 -)))
319 -* (((
320 -Start Tomcat(s)
321 -)))
322 -* (((
323 -Call http:~/~/localhost:<port>/<path> in browser
324 -)))
325 -
326 -Important notes
327 -
328 -**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.
329 -
330 -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.
331 -
332 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
333 -{{/layout-cell}}
334 -{{/layout-section}}
335 335  {{/layout}}
336 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -545783843
1 +3342785
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/545783843/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342785/ONYX project setup guide