Download TRUE - Installation guide

INSTALLATION GUIDE
TRUE: Testing platfoRm for mUltimedia Evaluation
Santi Planet ([email protected])
13/06/2008
PRELIMINARY VERSION
Instructions to install TRUE in your web server
TRUE 2
INSTALLATION GUIDE
1. Getting started
The first thing you must know is that TRUE is a web service. What this means is that it is not a stand-alone
application, you need a web server to execute it. This guide does not give you detailed explanations about
how to configure a web server, but it gives you some fundamental steps that you must bear in mind before
installing and using TRUE. Perhaps you already have a web server able to execute Java Servlets and Java
Server Pages with the MySQL database manage system installed. If this is your case, you can omit this
section.
1.1.
•
•
•
•
•
What do you need?
A computer with Internet connection with a static IP address
A Java environment configured in this computer
The JavaMail API and the MySQL Connector/J (and, depending on your Java environment
version, the Java Activation Framework)
A web server implementing Servlet and Java Server Pages specifications from Java Software (such
as Tomcat, for example)
The MySQL database management system
Check the TRUE website for updated information and links to get this software:
http://www.salle.url.edu/tsenyal/true
1.2.
Setting up the Java environment
TRUE is a web service implemented in Java. The first step when configuring your server is to install the
appropriate JDK in your computer. TRUE has been developed and tested using Java EE 5 SDK so you can
use the same version in your computer.
Download the JDK for free from http://java.sun.com
Although you had installed previously Java in your computer, you must be sure that you have installed the
following Java libraries. Refer to the corresponding documentation to installation instructions and
configuration of environment variables.
•
JavaMail API. This API allows sending emails through a mail server.
Download the JavaMail API for free from http://java.sun.com/products/javamail/
•
Java Activation Framework. It is required by the JavaMail API. Depending on the version of your
Java environment it is possible that you already have this extension installed.
Download the Java Activation Framework extension for free from
http://java.sun.com/javase/technologies/desktop/javabeans/jaf/
•
MySQL Connector/J. This connector allows communication between the Java applications and
the MySQL database management system.
Download the MySQL Connector/J for free from http://dev.mysql.com/downloads/connector/j/
TRUE 3
INSTALLATION GUIDE
1.3.
Installing MySQL
MySQL is a free1 database management system that is used by TRUE to store all the information related to
the tests.
Follow the steps for the installation of MySQL in your computer and remember to indicate a password at
the end of the process. This password will be needed when configuring TRUE.
Download the MySQL database (MySQL Community Edition for free) from http://www.mysql.com
Although it is not explicitly required for the TRUE usage, you can find useful the installation of a GUI
front end for creation and administration of the MySQL database, like MySQL Control Center, for
example.
Download the MySQL Control Center for free from http://sourceforge.net/projects/mysqlcc/
1.4.
Installing the web server
The web server is the software in your computer that listens to one of its ports for upcoming requests.
There are several web servers available but you must choose one implementing Java Servlets and Java
Server Pages specifications. TRUE has been developed and tested using the Apache Tomcat 4.1 web
server.
Download the Apache Tomcat Server from http://tomcat.apache.org
Be sure that you assign a reachable port for your server from any computer, including those outside your
LAN (if it is the case, and you want everybody in Internet to access your tests).
2. Installing TRUE
2.1.
What is needed?
These are the required elements to install TRUE in your system:
•
•
classes folder: including .class files and configuration files
jsp folder: including .jsp files and other files related to the website
In addition, you would have the following elements:
•
2.2.
Language packs: including files to configure TRUE to other languages
Installing program files
These are generic steps to install TRUE in the Apache Tomcat 4.1 web server. Please, refer the manual of
your server for more detailed explanation for a customized installation.
1. Copy nouavaluadorcorpus folder from the classes folder in the webapps\examples\WEB-INF\classes
directory.
1
MySQL Community Edition. For non-commercial purposes.
TRUE 4
INSTALLATION GUIDE
2. Copy nouAvaluadorCorpus folder from the jsp folder in the webapps\examples\jsp directory.
3. If you have downloaded any language pack, you must copy the folder named with the ISO 639-1
code of the language in the webapps\examples\WEB-INF\classes\nouavaluadorcorpus\config\langs
directory.
2.3.
Configuring TRUE installation
1. Create a new database in your MySQL server. This database will store all the information related
to the created tests. You can easily create it by executing this creation sentence (you can copy and
paste it in your MySQL management system):
CREATE TABLE `descripcio` (
`id` int(11) NOT NULL auto_increment,
`creador` varchar(255) NOT NULL default '',
`dataCreacio` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
`nomTaulaAssociada` varchar(100) NOT NULL default '',
`idioma` char(2) NOT NULL default '',
`plantilla` varchar(25) NOT NULL default '',
`tipusPlantilla` varchar(25) NOT NULL default '',
`tipusPlugin` varchar(100) NOT NULL default '',
`plugin` varchar(255) NOT NULL default '',
`argumentsPlugin` text NOT NULL,
`pluginWidth` varchar(4) NOT NULL default '',
`pluginHeight` varchar(4) NOT NULL default '',
`pluginBackground` varchar(7) NOT NULL default '',
`pluginParametres` text NOT NULL,
`pluginAuto` smallint(6) NOT NULL default '0',
`tipusTest` varchar(100) NOT NULL default '1',
`tipusMedia` varchar(15) NOT NULL default '',
`dispositiu` varchar(10) NOT NULL default '',
`tempsObservacio` int(11) NOT NULL default '-1',
`tempsAvaluacio` int(11) NOT NULL default '-1',
`numPreguntes` int(11) NOT NULL default '0',
`alineacio` varchar(12) NOT NULL default '',
`extensio` varchar(7) NOT NULL default '',
`amplada` int(10) NOT NULL default '0',
`alcada` int(10) NOT NULL default '0',
`ajustarVideo` smallint(6) default NULL,
`arrelAudio` varchar(100) NOT NULL default '',
`arxiuTextos` varchar(255) default '',
`barrejar` int(1) NOT NULL default '0',
`primerArxiu` int(11) NOT NULL default '0',
`darrerArxiu` int(11) NOT NULL default '0',
`classificacioReal` longtext NOT NULL,
`peuElement1` varchar(100) NOT NULL default '',
`peuElement2` varchar(100) NOT NULL default '',
`opcions` text NOT NULL,
`frase` text NOT NULL,
`opcions2` text NOT NULL,
`frase2` text NOT NULL,
`disposicioOpcions` varchar(15) NOT NULL default '',
`midaFont` varchar(20) NOT NULL default '',
`tipusBenvinguda` int(11) NOT NULL default '0',
`definicioBenvinguda` text NOT NULL,
`tipusDemo` int(11) NOT NULL default '0',
`arxiusDemo` varchar(100) NOT NULL default '',
`valorsDemo` varchar(255) NOT NULL default '',
`enquestaFinal` int(2) NOT NULL default '0',
`ecamp1` varchar(255) NOT NULL default '',
`etipus1` varchar(50) NOT NULL default '',
`eopcions1` varchar(255) NOT NULL default '',
`ecamp2` varchar(255) NOT NULL default '',
`etipus2` varchar(50) NOT NULL default '',
`eopcions2` varchar(255) NOT NULL default '',
`ecamp3` varchar(255) NOT NULL default '',
`etipus3` varchar(50) NOT NULL default '',
`eopcions3` varchar(255) NOT NULL default '',
`ecamp4` varchar(255) NOT NULL default '',
`etipus4` varchar(50) NOT NULL default '',
`eopcions4` varchar(255) NOT NULL default '',
`ecamp5` varchar(255) NOT NULL default '',
`etipus5` varchar(50) NOT NULL default '',
`eopcions5` varchar(255) NOT NULL default '',
`ecamp6` varchar(255) NOT NULL default '',
`etipus6` varchar(50) NOT NULL default '',
`eopcions6` varchar(255) NOT NULL default '',
`ecamp7` varchar(255) NOT NULL default '',
`etipus7` varchar(50) NOT NULL default '',
`eopcions7` varchar(255) NOT NULL default '',
`ecamp8` varchar(255) NOT NULL default '',
`etipus8` varchar(50) NOT NULL default '',
`eopcions8` varchar(255) NOT NULL default '',
`ecamp9` varchar(255) NOT NULL default '',
`etipus9` varchar(50) NOT NULL default '',
`eopcions9` varchar(255) NOT NULL default '',
`ecamp10` varchar(255) NOT NULL default '',
`etipus10` varchar(50) NOT NULL default '',
`eopcions10` varchar(255) NOT NULL default '',
`preguntaEnquesta` varchar(255) default NULL,
PRIMARY KEY (`id`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;
TRUE 5
INSTALLATION GUIDE
Depending on the version of your MySQL database (if you are using an old version), maybe you
ought to change the last line for this one:
) TYPE=MyISAM DEFAULT CHARSET=latin1;
2. Open,
with
any
text
editor,
the
file
webapps\examples\WEBINF\classes\nouavaluadorcorpus\config\avaluadorCorpusConfig.properties and modify the values of
each parameter:
a. Database connection
i. databaseMySQLServerName: Internet address where the MySQL server is installed
(e.g.: xxx.xxx.xxx or localhost)
ii. databaseName: name of the database created in step 1
iii. databaseUser: name of the user to access the database (e.g.: root)
iv. databasePassword: password to access the database
b. Mail server configuration
i. mailServer: Internet address of a mail server to send automatic messages (e.g.:
yyy.yyy.yyy)
ii. mailFrom: mail address to appear in the “From” field of the sent message
iii. mailUser: valid username to access the mail server
iv. mailPassword: password for the user indicated in the mailUser parameter
v. mailFormat: mail format (e.g.: text/plain)
vi. mailSubject: subject of the mail (e.g.: New test started)
vii. mailText: name of the text file including the body of the message (if no changes are
made, this file is WelcomeMailContent.txt, refer step 3 for more information)
c. Security settings
i. adminPassword: password for administration access
3. Customize the body of the automatic sent messages at the beginning of a test: when a user starts a
new test an automatic message is sent. You can customize this message for each language by
editing
the
file
webapps\examples\WEBINF\classes\nouavaluadorcorpus\config\langs\[language_code]\WelcomeMailContent.txt. You can
include the tag <!TEST_NAME> to be replaced automatically with the name of the test.
3. Accessing TRUE
Now you have installed TRUE in your server. You can access by means of a web browser following this
link: http://[your_server_name]:[port]/examples/jsp/nouAvaluadorCorpus.jsp. This link may differ
depending on your own web server configuration.
4. For more information…
If you need any more information or you have some problems installing this software, please visit the
TRUE website or contact us.
Visit TRUE website at http://www.salle.url.edu/tsenyal/true
Contact us at [email protected]