Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 354.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 339.1
bearbeitet von tleu
am 11.03.2015
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.0.

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -ONYX project setup guide
1 +Projekt Setupguide ONYX
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.tleu
Inhalt
... ... @@ -1,3 +1,4 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
... ... @@ -5,7 +5,7 @@
5 5  
6 6  
7 7  
8 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
9 +{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
9 9  {{/layout-cell}}
10 10  
11 11  {{layout-cell}}
... ... @@ -52,7 +52,7 @@
52 52  Apache Tomcat8 (latest update)
53 53  )))
54 54  
55 -=== ONYX WebEditor (additionally) ===
56 +=== ONYX Editor (additionally) ===
56 56  
57 57  * PostGreSQL (8.4.21 or later)
58 58  * Java unlimited security enabled
... ... @@ -76,7 +76,7 @@
76 76  
77 77  
78 78  
79 -* preWebOnyx (ONYX QTI test player)
80 +* preOnyx (ONYX QTI test player)
80 80  * preWebEditor (ONYX QTI test editor)
81 81  * onyx (ONYX QTI core)
82 82  * 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)
... ... @@ -98,7 +98,7 @@
98 98  
99 99  (% 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)
100 100  
101 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX WebEditor**
102 +(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
102 102  
103 103  * Locate setupdatabase.postgre.sql
104 104  * Log on to Postgres
... ... @@ -124,7 +124,7 @@
124 124  
125 125  * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
126 126  * Configure as needed
127 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
128 +* Service provider named “preview” is required if used as preview instance for ONYX Editor
128 128  
129 129  **preWebEditor**
130 130  
... ... @@ -154,20 +154,139 @@
154 154  **
155 155  {{/layout-cell}}
156 156  {{/layout-section}}
158 +{{/layout}}
159 +{{/sv-translation}}
157 157  
158 -{{layout-section ac:type="two_right_sidebar"}}
161 +{{sv-translation language="en"}}
162 +{{layout}}
163 +{{layout-section ac:type="two_equal"}}
159 159  {{layout-cell}}
160 -====== untergeordnete Seiten: ======
165 +====== Content: ======
161 161  
162 162  
163 163  
164 -{{children all="true"/}}
169 +{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
165 165  {{/layout-cell}}
166 166  
167 167  {{layout-cell}}
168 -====== relevante Links: ======
173 +
174 +{{/layout-cell}}
175 +{{/layout-section}}
169 169  
170 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
177 +{{layout-section ac:type="single"}}
178 +{{layout-cell}}
179 +== System requirements ==
180 +
181 +=== All components ===
182 +
183 +* (((
184 +Linux-based OS
185 +)))
186 +* (((
187 +Oracle Java8 (latest update)
188 +)))
189 +* (((
190 +Apache Tomcat8 (latest update)
191 +)))
192 +
193 +=== ONYX WebEditor (additionally) ===
194 +
195 +* PostGreSQL (8.4.21 or later)
196 +* Java unlimited security enabled
197 +
198 +{{code}}
199 +http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
200 +Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
201 +{{/code}}
202 +
203 +=== Build process ===
204 +
205 +* Linux-based OS
206 +* Oracle Java7 (latest update)
207 +* Eclipse for JEE (Kepler or later)
208 +* Maven2
209 +* Eclipse Maven integration (m2)
210 +
211 +== Steps for build ==
212 +
213 +All ONYX parts are delivered as Eclipse projects:
214 +
215 +* preWebOnyx (ONYX QTI test player)
216 +* preWebEditor (ONYX QTI test editor)
217 +* onyx (ONYX QTI core)
218 +* (((
219 +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)
220 +)))
221 +
222 +Use Eclipse:
223 +
224 +* Import -> Existing project, start with LaTeXRenderer project
225 +* Import all four projects
226 +
227 +Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
228 +
229 +{{code}}
230 +Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
231 +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)
232 +
233 +{{/code}}
234 +
235 +**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)
236 +
237 +**Setup database for ONYX WebEditor**
238 +
239 +* Locate setupdatabase.postgre.sql
240 +* Log on to Postgres
241 +* Create user owe with password owe
242 +* Create database owe and assign to user owe
243 +* Import setupdatabase.postgre.sql to this database
244 +
245 +
246 +
247 +Hint: you may use other user/database names, change configuration in
248 +
249 +{{code}}
250 +applicationContext.xml (see below)
251 +{{/code}}
252 +
253 +== Changes on ONYX QTI core ==
254 +
255 +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.
256 +
257 +== Configuration ==
258 +
259 +**preWebOnyx**
260 +
261 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
262 +* Configure as needed
263 +* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
264 +
265 +**preWebEditor**
266 +
267 +* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
268 +* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
269 +* moduleConfigurationContext.xml: repository configuration
270 +* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
271 +* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
272 +
273 +== Deployment ==
274 +
275 +* 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)
276 +* Configure Tomcat deployment to use different ports
277 +* Check path the applications are mounted to
278 +* Start Tomcat(s)
279 +* (((
280 +Call http:~/~/localhost:<port>/<path> in browser
281 +)))
282 +
283 +== Important notes ==
284 +
285 +**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.
286 +
287 +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.
288 +
289 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
171 171  {{/layout-cell}}
172 172  {{/layout-section}}
173 173  {{/layout}}
293 +{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342785
1 +6919006
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342785/ONYX project setup guide
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/6919006/Projekt Setupguide ONYX