Änderungen von Dokument 03 Projekt Setupguide ONYX
Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 337.1
bearbeitet von Carina Enke
am 08.03.2018
am 08.03.2018
Änderungskommentar:
Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.
Auf Version 377.1
bearbeitet von Carina Enke
am 13.02.2024
am 13.02.2024
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
-
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Übergeordnete Seite
-
... ... @@ -1,0 +1,1 @@ 1 +ONYX.Systeminformationen.WebHome - Inhalt
-
... ... @@ -1,23 +2,6 @@ 1 -{{sv-translation language="de"}} 2 2 {{layout}} 3 3 {{layout-section ac:type="two_right_sidebar"}} 4 4 {{layout-cell}} 5 -====== Inhalt: ====== 6 - 7 - 8 - 9 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}} 10 -{{/layout-cell}} 11 - 12 -{{layout-cell}} 13 - 14 - 15 - 16 -{{/layout-cell}} 17 -{{/layout-section}} 18 - 19 -{{layout-section ac:type="single"}} 20 -{{layout-cell}} 21 21 == System requirements == 22 22 23 23 === All components === ... ... @@ -26,15 +26,15 @@ 26 26 Linux-based OS 27 27 ))) 28 28 * ((( 29 - OracleJava8(latest update)12 +Java 17 30 30 ))) 31 31 * ((( 32 -Apache Tomcat 8(latest update)15 +Apache Tomcat 9 (latest update) 33 33 ))) 34 34 35 35 === ONYX Editor (additionally) === 36 36 37 -* Post GreSQL(8.4.21or later)20 +* PostgreSQL 12 38 38 * Java unlimited security enabled 39 39 40 40 {{code}} ... ... @@ -45,23 +45,33 @@ 45 45 === Build process === 46 46 47 47 * Linux-based OS 48 -* OracleJava7(latest update)31 +* Java 11 (latest update, Oracle or OpenJDK) 49 49 * Eclipse for JEE (Kepler or later) 50 50 * Maven2 51 51 * Eclipse Maven integration (m2) 35 +{{/layout-cell}} 52 52 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}} 53 53 == Steps for build == 54 54 55 55 All ONYX parts are delivered as Eclipse projects 56 56 57 - 58 58 59 59 * preOnyx (ONYX QTI test player) 60 60 * preWebEditor (ONYX QTI test editor) 61 61 * onyx (ONYX QTI core) 62 62 * 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) 63 - 64 - 57 +\\ 65 65 66 66 * Use Eclipse 67 67 * Import -> Existing project, start with LaTeXRenderer project ... ... @@ -76,9 +76,9 @@ 76 76 77 77 {{/code}} 78 78 79 -(% style="line-height: ;" %)**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) 80 80 81 -(% style="line-height: ;" %)**Setup database for ONYX Editor**74 +(% style="line-height:1.4285715" %)**Setup database for ONYX Editor** 82 82 83 83 * Locate setupdatabase.postgre.sql 84 84 * Log on to Postgres ... ... @@ -86,8 +86,6 @@ 86 86 * Create database owe and assign to user owe 87 87 * Import setupdatabase.postgre.sql to this database 88 88 89 - 90 - 91 91 Hint: you may use other user/database names, change configuration in 92 92 93 93 {{code}} ... ... @@ -128,33 +128,14 @@ 128 128 129 129 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. 130 130 131 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**. 132 - 133 -** 134 -** 122 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**. 135 135 {{/layout-cell}} 136 136 {{/layout-section}} 137 137 {{/layout}} 138 -{{/sv-translation}} 139 139 140 -{{sv-translation language="en"}} 141 141 {{layout}} 142 -{{layout-section ac:type="two_e qual"}}128 +{{layout-section ac:type="two_right_sidebar"}} 143 143 {{layout-cell}} 144 -====== Content: ====== 145 - 146 - 147 - 148 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}} 149 -{{/layout-cell}} 150 - 151 -{{layout-cell}} 152 - 153 -{{/layout-cell}} 154 -{{/layout-section}} 155 - 156 -{{layout-section ac:type="single"}} 157 -{{layout-cell}} 158 158 == System requirements == 159 159 160 160 === All components === ... ... @@ -163,15 +163,15 @@ 163 163 Linux-based OS 164 164 ))) 165 165 * ((( 166 - OracleJava8(latest update)138 +Java 17 167 167 ))) 168 168 * ((( 169 -Apache Tomcat 8(latest update)141 +Apache Tomcat 9 170 170 ))) 171 171 172 172 === ONYX WebEditor (additionally) === 173 173 174 -* Post GreSQL(8.4.21or later)146 +* PostgreSQL 12 175 175 * Java unlimited security enabled 176 176 177 177 {{code}} ... ... @@ -182,33 +182,53 @@ 182 182 === Build process === 183 183 184 184 * Linux-based OS 185 -* OracleJava7(latestupdate)157 +* Java 11 (Oracle or OpenJDK) 186 186 * Eclipse for JEE (Kepler or later) 187 187 * Maven2 188 188 * Eclipse Maven integration (m2) 161 +{{/layout-cell}} 189 189 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}} 190 190 == Steps for build == 191 191 192 192 All ONYX parts are delivered as Eclipse projects: 193 193 194 -* preWebOnyx (ONYX QTI test player) 195 -* preWebEditor (ONYX QTI test editor) 196 -* onyx (ONYX QTI core) 197 197 * ((( 179 +preWebOnyx (ONYX QTI test player) 180 +))) 181 +* ((( 182 +preWebEditor (ONYX QTI test editor) 183 +))) 184 +* ((( 185 +onyx (ONYX QTI core) 186 +))) 187 +* ((( 198 198 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) 199 199 ))) 200 200 201 201 Use Eclipse: 202 202 203 -* Import -> Existing project, start with LaTeXRenderer project 204 -* Import all four projects 193 +* ((( 194 +Import -> Existing project, start with LaTeXRenderer project 195 +))) 196 +* ((( 197 +Import all four projects 198 +))) 205 205 206 206 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually. 207 207 208 208 {{code}} 209 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled. 210 -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) 211 - 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) 212 212 {{/code}} 213 213 214 214 **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) ... ... @@ -215,14 +215,22 @@ 215 215 216 216 **Setup database for ONYX WebEditor** 217 217 218 -* Locate setupdatabase.postgre.sql 219 -* Log on to Postgres 220 -* Create user owe with password owe 221 -* Create database owe and assign to user owe 222 -* 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 +))) 223 223 224 - 225 - 226 226 Hint: you may use other user/database names, change configuration in 227 227 228 228 {{code}} ... ... @@ -229,44 +229,67 @@ 229 229 applicationContext.xml (see below) 230 230 {{/code}} 231 231 232 - ==Changes on ONYX QTI core==232 +Changes on ONYX QTI core 233 233 234 234 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. 235 235 236 - ==Configuration==236 +Configuration 237 237 238 238 **preWebOnyx** 239 239 240 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml// 241 -* Configure as needed 242 -* 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 +))) 243 243 244 244 **preWebEditor** 245 245 246 -* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...) 247 -* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required 248 -* moduleConfigurationContext.xml: repository configuration 249 -* pageModelContext.xml: normally no changes required, defines the main tabs in shown application 250 -* 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 +))) 251 251 252 - ==Deployment==268 +Deployment 253 253 254 -* 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) 255 -* Configure Tomcat deployment to use different ports 256 -* Check path the applications are mounted to 257 -* Start Tomcat(s) 258 258 * ((( 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 +* ((( 259 259 Call http:~/~/localhost:<port>/<path> in browser 260 260 ))) 261 261 262 - ==Important notes==286 +Important notes 263 263 264 264 **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. 265 265 266 266 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. 267 267 268 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with 4GB each**.292 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**. 269 269 {{/layout-cell}} 270 270 {{/layout-section}} 271 271 {{/layout}} 272 -{{/sv-translation}}
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 - 1478825061 +3342771 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/ 147882506/Projekt Setupguide ONYX1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX