Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

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

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.carina
Inhalt
... ... @@ -1,38 +1,21 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -====== Inhalt: ======
5 -
6 -
7 -
8 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
5 +
9 9  {{/layout-cell}}
10 10  
11 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 -
9 +{{scroll-ignore}}
10 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
28 28  
29 -
30 -)))
31 -|=(((
32 -JIRA
33 -)))|(((
34 -
35 -)))
12 +
13 +{{toc/}}
14 +
15 +**
16 +**
17 +{{/panel}}
18 +{{/scroll-ignore}}
36 36  {{/layout-cell}}
37 37  {{/layout-section}}
38 38  
... ... @@ -46,13 +46,13 @@
46 46  Linux-based OS
47 47  )))
48 48  * (((
49 -Oracle Java7 (latest update)
32 +Java 11 (latest update, Oracle or OpenJDK)
50 50  )))
51 51  * (((
52 -Apache Tomcat7 (latest update)
35 +Apache Tomcat 9 (latest update)
53 53  )))
54 54  
55 -=== ONYX WebEditor (additionally) ===
38 +=== ONYX Editor (additionally) ===
56 56  
57 57  * PostGreSQL (8.4.21 or later)
58 58  * Java unlimited security enabled
... ... @@ -59,13 +59,13 @@
59 59  
60 60  {{code}}
61 61  http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
62 -Download from http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html
45 +Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
63 63  {{/code}}
64 64  
65 65  === Build process ===
66 66  
67 67  * Linux-based OS
68 -* Oracle Java7 (latest update)
51 +* Java 11 (latest update, Oracle or OpenJDK)
69 69  * Eclipse for JEE (Kepler or later)
70 70  * Maven2
71 71  * Eclipse Maven integration (m2)
... ... @@ -76,7 +76,7 @@
76 76  
77 77  
78 78  
79 -* preWebOnyx (ONYX QTI test player)
62 +* 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)
... ... @@ -97,22 +97,201 @@
97 97  {{/code}}
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)
83 +
84 +(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
85 +
86 +* Locate setupdatabase.postgre.sql
87 +* Log on to Postgres
88 +* Create user owe with password owe
89 +* Create database owe and assign to user owe
90 +* Import setupdatabase.postgre.sql to this database
91 +
92 +
93 +
94 +Hint: you may use other user/database names, change configuration in
95 +
96 +{{code}}
97 +applicationContext.xml (see below)
98 +{{/code}}
99 +
100 +== Changes on ONYX QTI core ==
101 +
102 +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.
103 +
104 +== Configuration ==
105 +
106 +**preWebOnyx**
107 +
108 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
109 +* Configure as needed
110 +* Service provider named “preview” is required if used as preview instance for ONYX Editor
111 +
112 +**preWebEditor**
113 +
114 +* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
115 +* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
116 +* moduleConfigurationContext.xml: repository configuration
117 +* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
118 +* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
119 +
120 +== Deployment ==
121 +
122 +* 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)
123 +* Configure Tomcat deployment to use different ports
124 +* Check path the applications are mounted to
125 +* Start Tomcat(s)
126 +* Call http:~/~/localhost:<port>/<path> in browser
127 +
128 +== Important notes ==
129 +
130 +**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.
131 +
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 +
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 +**
100 100  {{/layout-cell}}
101 101  {{/layout-section}}
140 +{{/layout}}
141 +{{/sv-translation}}
102 102  
103 -{{layout-section ac:type="two_right_sidebar"}}
143 +{{sv-translation language="en"}}
144 +{{layout}}
145 +{{layout-section ac:type="two_equal"}}
104 104  {{layout-cell}}
105 -====== untergeordnete Seiten: ======
147 +
148 +{{/layout-cell}}
106 106  
150 +{{layout-cell}}
151 +{{scroll-ignore}}
152 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
107 107  
108 108  
109 -{{children all="true"/}}
155 +{{toc maxLevel="4"/}}
156 +
157 +**
158 +**
159 +{{/panel}}
160 +{{/scroll-ignore}}
110 110  {{/layout-cell}}
162 +{{/layout-section}}
111 111  
164 +{{layout-section ac:type="single"}}
112 112  {{layout-cell}}
113 -====== relevante Links: ======
166 +== System requirements ==
114 114  
115 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
168 +=== All components ===
169 +
170 +* (((
171 +Linux-based OS
172 +)))
173 +* (((
174 +Java 11 (Oracle or OpenJDK)
175 +)))
176 +* (((
177 +Apache Tomcat 9
178 +)))
179 +
180 +=== ONYX WebEditor (additionally) ===
181 +
182 +* PostGreSQL (8.4.21 or later)
183 +* Java unlimited security enabled
184 +
185 +{{code}}
186 +http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
187 +Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
188 +{{/code}}
189 +
190 +=== Build process ===
191 +
192 +* Linux-based OS
193 +* Java 11 (Oracle or OpenJDK)
194 +* Eclipse for JEE (Kepler or later)
195 +* Maven2
196 +* Eclipse Maven integration (m2)
197 +
198 +== Steps for build ==
199 +
200 +All ONYX parts are delivered as Eclipse projects:
201 +
202 +* preWebOnyx (ONYX QTI test player)
203 +* preWebEditor (ONYX QTI test editor)
204 +* onyx (ONYX QTI core)
205 +* (((
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 +)))
208 +
209 +Use Eclipse:
210 +
211 +* Import -> Existing project, start with LaTeXRenderer project
212 +* Import all four projects
213 +
214 +Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
215 +
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 +
220 +{{/code}}
221 +
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 +
224 +**Setup database for ONYX WebEditor**
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
231 +
232 +
233 +
234 +Hint: you may use other user/database names, change configuration in
235 +
236 +{{code}}
237 +applicationContext.xml (see below)
238 +{{/code}}
239 +
240 +== Changes on ONYX QTI core ==
241 +
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 +
244 +== Configuration ==
245 +
246 +**preWebOnyx**
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
251 +
252 +**preWebEditor**
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
259 +
260 +== Deployment ==
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 +* (((
267 +Call http:~/~/localhost:<port>/<path> in browser
268 +)))
269 +
270 +== Important notes ==
271 +
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 +
274 +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.
275 +
276 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
116 116  {{/layout-cell}}
117 117  {{/layout-section}}
118 118  {{/layout}}
280 +{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342781
1 +301073193
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342781/ONYX project setup guide
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073193/Projekt Setupguide ONYX