Installing Salomé-TMF

Before installing the test management framework Salomé-TMF, you need to have access to a Java install JDK 1.4 or more, and to a database server MySQL.


Installing the tool Salomé-TMF

Installing Salomé-TMF can be done in two ways:

We will present in the two following sections an how-to for those two installation methods.


Automatic installation

Start the executable file salome_tmf_install.jar (enter the command java -jar salome_tmf_install.jar in a Linux environment). A first window pops up asking to choose your language for the installation parameters.

Figure: Language selection
Image selectLang

Choose your language (it will be the language kept for the remaining of the installation procedure and the language by default for Salomé-TMF), then press the "Ok" button. The following window welcomes you to the installation.

Figure:
Image welcomeInstall

Click the "Next" button for going to the next step. The new window asks your agreement for the GPL license (GNU General Public License) under which Salomé-TMF is distributed. If you wish to make a commercial distribution of Salomé-TMF, we will enter under a dual licensing scheme in the same way than the MySQL scheme.

Figure: GPL license
Image licenceGPL

Before proceeding with the installation procedure, you have to check the option "I agree with the termes of this license agreement", and to click the "Next" button. The next step deals with the installation directory for Salomé-TMF.

Figure: Choosing the installation directory
Image choiceInstallDir

Choose the installation directory, then click "Next". A new window proposes optional components for the tool.

Figure: Choosing components
Image installComp

After checking the optional components you wish, click "Next".

A window gives then the progress status for the installation procedure, including for the separate components.

Figure: Installation progress
Image progressInstall

When components are installed, click "Next". The following step will install the database of Salomé TMF, and will create the configuration file DB_Connexion.properties in the directory cfg/ put in the installation directory. This file enables to configure the linking of Salomé TMF to its MySQL database, and to tune some parameters for some features. This configuration file is created by filling the following form.

Figure: Configuration parameters for Salomé-TMF
Image configBDD

For configuring Salomé-TMF, you need to fill the following fields:

 

When all those fields are defined, click on "Save file". A message pops up for confirming the success of the writing of the configuration file.

Next, click on "Create the database", a new window pops up.

Figure: Creating Salomé-TMF database
Image createSalomeBDD

In this window, the user has got to fill the following fields:

 

When all those fields are filled, you click next on "Create the database". A message confirms then the success of the database creation.

After the database creation, click on "Next" in the installer program. A message says then than the installation procedure has proceeded correctly, you can click "Next" and "Finish".

If there is an error during the database installation, you should refer to the manual installation procedure.


Manual installation

After uncompressing the file salome_tmf-1.zip, you need to create the database and the MySQL user for Salomé TMF in the following steps.

Connection to the MySQL server

mysql -u root -p

After entering this command, you need to enter the MySQL administrator (root) password before connecting to the server.

When connected to the MySQL server, create Salomé-TMF database

mysql> CREATE DATABASE <salomeTMF_bdd>;

Where <salomeTMF_bdd> is the name of the database.

Creating the Salomé-TMF user

mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP, LOCK 
TABLES, CREATE TEMPORARY TABLES, REFERENCES ON <salomeTMF_bdd>.* TO 
<salomeTMF_user>@'%' IDENTIFIED BY '<salomeTMF_password>';

Where:

Refresh the users' privileges for making sure they are taken into account

mysql> FLUSH PRIVILEGES;

Connecting to the database

Connect to the database and execute the script for creating the database tables create_salome_bdd.sql which is put in the directory bdd_model/ of the installation directory:

mysql> connect <salomeTMF_bdd>; mysql> source 
<install_dir>\bdd_model\create_salome_bdd.sql;

Where <install_dir> is the installation directory for Salomé-TMF. If you are working under Linux, use "/" as separators.  

When those steps are done, you need to configure the file for connecting to the database, and the password encryption key. For this, execute the JAR file salome_tmf_tools.jar which is at the root of the installation directory. The window described in Figure [*] pops up. This is the same fields to fill than when configuring the database during the automatic installation (cf. section [*]). The name of the database, the user login and her password must be the same than those entered in the previous MySQL fields.

Fill those fields, then click on "Save file". A window asks to choose the directory in which the configuration file will be created. Choose the directory cfg/ of the installation directory of Salomé TMF, then click on "Validate". Installation is finished.


Installing a Salomé-TMF plug-in

Any Salomé-TMF plugin is given as a compressed file nom_du_plugin.zip. A utility given as a JAR file (pluginInstall.jar put in the plugins directory) enables to install the plugins.

For installing a plug-in, follow those steps:

  1. Uncompress the ZIP file in the directory plugins/ of the installation directory of Salomé TMF.
  2. Go to this directory and execute the command
     java -jar pluginInstall.jar 
    nom_du_plugin.zip
    

For some plugins (for example the Bugzilla one), other configurations are necessary (see the plugin documentation).


About this document ...

This document was generated using the LaTeX2HTML translator Version 2002-2-1 (1.71)

Copyright © 1993, 1994, 1995, 1996, Nikos Drakos, Computer Based Learning Unit, University of Leeds.
Copyright © 1997, 1998, 1999, Ross Moore, Mathematics Department, Macquarie University, Sydney.

The command line arguments were:
latex2html -split 1 -no_navigation -prefix c2 -dir ../.././src/docs/html/en -no_footnode en/installation.tex

The translation was initiated by on 2006-03-10


2006-03-10