Zum Inhalt springen

Wiki-Quellcode von ONYX project setup guide

Version 354.1 von sandra_riediger am 15.12.2014
Verstecke letzte Bearbeiter
Carina Enke 124.1 1 {{layout}}
Carina Enke 276.1 2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
Carina Enke 288.1 4 ====== Inhalt: ======
5
6
7
sandra_riediger 352.1 8 {{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
Carina Enke 276.1 9 {{/layout-cell}}
10
11 {{layout-cell}}
tleu 338.1 12 |=(% colspan="1" %)(% colspan="1" %)
13 (((
14 Programmversion
15 )))|(% colspan="1" %)(% colspan="1" %)
16 (((
Carina Enke 288.1 17
tleu 338.1 18 )))
19 |=(((
20 Status
21 )))|(((
22 (% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
23 )))
24 |=(((
25 Aufgaben
26 )))|(((
27
Carina Enke 276.1 28
Carina Enke 288.1 29
tleu 338.1 30 )))
31 |=(((
32 JIRA
33 )))|(((
34
35 )))
Carina Enke 276.1 36 {{/layout-cell}}
Carina Enke 124.1 37 {{/layout-section}}
38
Carina Enke 276.1 39 {{layout-section ac:type="single"}}
Carina Enke 124.1 40 {{layout-cell}}
41 == System requirements ==
42
43 === All components ===
44
45 * (((
46 Linux-based OS
47 )))
48 * (((
Carina Enke 288.1 49 Oracle Java8 (latest update)
Carina Enke 124.1 50 )))
51 * (((
Carina Enke 288.1 52 Apache Tomcat8 (latest update)
Carina Enke 124.1 53 )))
54
tleu 346.1 55 === ONYX WebEditor (additionally) ===
Carina Enke 124.1 56
Carina Enke 168.1 57 * PostGreSQL (8.4.21 or later)
Carina Enke 124.1 58 * Java unlimited security enabled
59
60 {{code}}
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/jce8-download-2133166.html
63 {{/code}}
64
65 === Build process ===
66
67 * Linux-based OS
Carina Enke 288.1 68 * Oracle Java7 (latest update)
Carina Enke 124.1 69 * Eclipse for JEE (Kepler or later)
70 * Maven2
71 * Eclipse Maven integration (m2)
72
73 == Steps for build ==
74
75 All ONYX parts are delivered as Eclipse projects
76
Carina Enke 276.1 77
Carina Enke 124.1 78
tleu 346.1 79 * preWebOnyx (ONYX QTI test player)
Carina Enke 124.1 80 * preWebEditor (ONYX QTI test editor)
81 * onyx (ONYX QTI core)
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)
83
84
85
86 * Use Eclipse
87 * Import -> Existing project, start with LaTeXRenderer project
88 * Import all four projects
89
90 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
91
92 {{code}}
93 Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
94 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)
95
96
97 {{/code}}
98
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
tleu 346.1 101 (% style="line-height: 1.4285715;" %)**Setup database for ONYX WebEditor**
Carina Enke 124.1 102
103 * Locate setupdatabase.postgre.sql
104 * Log on to Postgres
105 * Create user owe with password owe
106 * Create database owe and assign to user owe
107 * Import setupdatabase.postgre.sql to this database
108
Carina Enke 276.1 109
Carina Enke 124.1 110
111 Hint: you may use other user/database names, change configuration in
112
113 {{code}}
114 applicationContext.xml (see below)
115 {{/code}}
116
117 == Changes on ONYX QTI core ==
118
119 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.
120
121 == Configuration ==
122
123 **preWebOnyx**
124
125 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
126 * Configure as needed
tleu 346.1 127 * Service provider named “preview” is required if used as preview instance for ONYX WebEditor
Carina Enke 124.1 128
129 **preWebEditor**
130
131 * applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
132 * metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
133 * moduleConfigurationContext.xml: repository configuration
134 * pageModelContext.xml: normally no changes required, defines the main tabs in shown application
135 * webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
136
137 == Deployment ==
138
139 * 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)
140 * Configure Tomcat deployment to use different ports
141 * Check path the applications are mounted to
142 * Start Tomcat(s)
143 * Call http:~/~/localhost:<port>/<path> in browser
144
145 == Important notes ==
146
147 **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.
148
149 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.
150
Carina Enke 288.1 151 In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
Carina Enke 124.1 152
153 **
154 **
155 {{/layout-cell}}
156 {{/layout-section}}
tleu 346.1 157
158 {{layout-section ac:type="two_right_sidebar"}}
159 {{layout-cell}}
160 ====== untergeordnete Seiten: ======
161
162
163
164 {{children all="true"/}}
165 {{/layout-cell}}
166
167 {{layout-cell}}
168 ====== relevante Links: ======
169
170 * [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
171 {{/layout-cell}}
172 {{/layout-section}}
Carina Enke 124.1 173 {{/layout}}