Zum Inhalt springen

Änderungen von Dokument Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 05.03.2026
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 377.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,26 +2,6 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="two_right_sidebar"}}
4 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}}
20 -{{/layout-section}}
21 -
22 -{{layout-section ac:type="single"}}
23 -{{layout-cell}}
24 24  == System requirements ==
25 25  
26 26  === All components ===
... ... @@ -29,7 +29,7 @@
29 29  Linux-based OS
30 30  )))
31 31  * (((
32 -Java 11 (latest update, Oracle or OpenJDK)
12 +Java 17
33 33  )))
34 34  * (((
35 35  Apache Tomcat 9 (latest update)
... ... @@ -37,7 +37,7 @@
37 37  
38 38  === ONYX Editor (additionally) ===
39 39  
40 -* PostGreSQL (8.4.21 or later)
20 +* PostgreSQL 12
41 41  * Java unlimited security enabled
42 42  
43 43  {{code}}
... ... @@ -52,19 +52,29 @@
52 52  * Eclipse for JEE (Kepler or later)
53 53  * Maven2
54 54  * Eclipse Maven integration (m2)
35 +{{/layout-cell}}
55 55  
37 +{{layout-cell}}
38 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
39 +{{toc start="2"/}}
40 +
41 +
42 +{{/panel}}
43 +{{/layout-cell}}
44 +{{/layout-section}}
45 +
46 +{{layout-section ac:type="single"}}
47 +{{layout-cell}}
56 56  == Steps for build ==
57 57  
58 58  All ONYX parts are delivered as Eclipse projects
59 59  
60 -
61 61  
62 62  * preOnyx (ONYX QTI test player)
63 63  * preWebEditor (ONYX QTI test editor)
64 64  * onyx (ONYX QTI core)
65 65  * 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)
66 -
67 -
57 +\\
68 68  
69 69  * Use Eclipse
70 70  * Import -> Existing project, start with LaTeXRenderer project
... ... @@ -79,9 +79,9 @@
79 79  
80 80  {{/code}}
81 81  
82 -(% 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)
72 +(% 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)
83 83  
84 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
74 +(% style="line-height:1.4285715" %)**Setup database for ONYX Editor**
85 85  
86 86  * Locate setupdatabase.postgre.sql
87 87  * Log on to Postgres
... ... @@ -89,8 +89,6 @@
89 89  * Create database owe and assign to user owe
90 90  * Import setupdatabase.postgre.sql to this database
91 91  
92 -
93 -
94 94  Hint: you may use other user/database names, change configuration in
95 95  
96 96  {{code}}
... ... @@ -132,37 +132,13 @@
132 132  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.
133 133  
134 134  In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
135 -
136 -**
137 -**
138 138  {{/layout-cell}}
139 139  {{/layout-section}}
140 140  {{/layout}}
141 -{{/sv-translation}}
142 142  
143 -{{sv-translation language="en"}}
144 144  {{layout}}
145 -{{layout-section ac:type="two_equal"}}
128 +{{layout-section ac:type="two_right_sidebar"}}
146 146  {{layout-cell}}
147 -
148 -{{/layout-cell}}
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 166  == System requirements ==
167 167  
168 168  === All components ===
... ... @@ -171,7 +171,7 @@
171 171  Linux-based OS
172 172  )))
173 173  * (((
174 -Java 11 (Oracle or OpenJDK)
138 +Java 17
175 175  )))
176 176  * (((
177 177  Apache Tomcat 9
... ... @@ -179,7 +179,7 @@
179 179  
180 180  === ONYX WebEditor (additionally) ===
181 181  
182 -* PostGreSQL (8.4.21 or later)
146 +* PostgreSQL 12
183 183  * Java unlimited security enabled
184 184  
185 185  {{code}}
... ... @@ -194,29 +194,49 @@
194 194  * Eclipse for JEE (Kepler or later)
195 195  * Maven2
196 196  * Eclipse Maven integration (m2)
161 +{{/layout-cell}}
197 197  
163 +{{layout-cell}}
164 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
165 +{{toc maxLevel="4"/}}
166 +
167 +
168 +{{/panel}}
169 +{{/layout-cell}}
170 +{{/layout-section}}
171 +
172 +{{layout-section ac:type="single"}}
173 +{{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  * (((
179 +preWebOnyx (ONYX QTI test player)
180 +)))
181 +* (((
182 +preWebEditor (ONYX QTI test editor)
183 +)))
184 +* (((
185 +onyx (ONYX QTI core)
186 +)))
187 +* (((
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
193 +* (((
194 +Import -> Existing project, start with LaTeXRenderer project
195 +)))
196 +* (((
197 +Import all four projects
198 +)))
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 -
203 +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,14 +223,22 @@
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
210 +* (((
211 +Locate setupdatabase.postgre.sql
212 +)))
213 +* (((
214 +Log on to Postgres
215 +)))
216 +* (((
217 +Create user owe with password owe
218 +)))
219 +* (((
220 +Create database owe and assign to user owe
221 +)))
222 +* (((
223 +Import setupdatabase.postgre.sql to this database
224 +)))
231 231  
232 -
233 -
234 234  Hint: you may use other user/database names, change configuration in
235 235  
236 236  {{code}}
... ... @@ -237,37 +237,61 @@
237 237  applicationContext.xml (see below)
238 238  {{/code}}
239 239  
240 -== Changes on ONYX QTI core ==
232 +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 ==
236 +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
240 +* (((
241 +Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
242 +)))
243 +* (((
244 +Configure as needed
245 +)))
246 +* (((
247 +Service provider named “preview” is required if used as preview instance for ONYX WebEditor
248 +)))
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
252 +* (((
253 +applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
254 +)))
255 +* (((
256 +metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
257 +)))
258 +* (((
259 +moduleConfigurationContext.xml: repository configuration
260 +)))
261 +* (((
262 +pageModelContext.xml: normally no changes required, defines the main tabs in shown application
263 +)))
264 +* (((
265 +webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
266 +)))
259 259  
260 -== Deployment ==
268 +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  * (((
271 +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)
272 +)))
273 +* (((
274 +Configure Tomcat deployment to use different ports
275 +)))
276 +* (((
277 +Check path the applications are mounted to
278 +)))
279 +* (((
280 +Start Tomcat(s)
281 +)))
282 +* (((
267 267  Call http:~/~/localhost:<port>/<path> in browser
268 268  )))
269 269  
270 -== Important notes ==
286 +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  
... ... @@ -277,4 +277,3 @@
277 277  {{/layout-cell}}
278 278  {{/layout-section}}
279 279  {{/layout}}
280 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -301073193
1 +3342771
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/3342771/Projekt Setupguide ONYX