Installation for MySQL
The DQA is designed to be most easily installed on MySQL. Installations on other databases such as Oracle and PostGres are supported and can be accomplished by a technical team. These instructions are only for those installing the simpliest version on an MySQL database.
Please Note: These instructions assume that you are generally comfortable with installing your own software, have some experience working with databases, and have admnistrative rights to your system. If one or both of these do not apply you will want to ask for assistance from other team members or your information systems department to help you with this process.
MySQL is available as a free community download. This will work well for local and small installations. (Please note that these directions are subject to change. MySQL may change their download and installation process at any time with no notice to this project. )
- Navigate to http://www.mysql.com/.
- Select Downloads.
- Scroll to the bottom section titled "MySQL Community Edition (GPL)" and select Community (GPL) Downloads.
- Select Download under the MySQL Community Server section.
- Follow the installation instructions for your operating system.
For more information or help with MySQL downloads, please follow the links and help documents given on the MySQL page. Installation of MySQL is straightforward and standard/default options should be selected.
Once MySQL is installed you will need to decide on which type of client to use to access it for administrative purposes. Here are your choices:
- Use the already installed client that MySQL provides: MySQL Command-Line Tool. If you are comfortable with command line tools you will find this easy to use. The directions in the next section will assume you are using this tool.
- Find your own third party client. A good list of them can be found here: Top 10 MySQL GUI Tools.
- Use your own client you are familar with. You may already have a database software you use now that can connect to MySQL.
Once you have MySQL installed you should ensure the following:
- MySQL should be running in the background. In Windows MySQL will be installed as a Service. Open your Services panel (Windows Services) and verify that you can see MySQL listed there and that it is running. You may also want to configure it to automatically start whenever your system starts.
- You should have established an admin username and password during installation of MySQL. Please save this for future use. Without this username and password you can not setup the database in the next step.
- You can access MySQL through your favorite client.
Now that MySQL is installed and you have access to your new database, it is time to install the DQA specific database that the DQA will need to do its work. This database will also hold the data imported in which you can directly access by connecting to the database using your favorite MySQL client.
These instructions require that you connect to your database using your client. The examples given will be shown on the MySQL Command-Line Tool. Instructions for other clients will vary from these instructions.
The MySQL database scripts can be found at https://svn.code.sf.net/p/ois-dqa/code/database/mysql/trunk/ . For this installation you will need the following files:
Download, modify and then run each of these scripts:
- Download the two scripts to your local system.
- Open the create-user.sql script in a text editor, such as Notepad, and modify the changme password to a secure password that you will remember. This is the username and password you will give to access the DQA when it is running.
- Run the create-user.sql script and verify there are no errors.
- Open the initial-v1.08.sql script and modify line 44 to indicate the user information for the admin user. Change dqa_admin to a user name of your choosing, change_this_password to a secure password, and email@example.com to your email address.
- Run the initial-v1.08.sql script and verify there are no errors.
Note: To run a script into MySQL you can use a command like this:
mysql -uroot -ppassword < script.sql
are replaced with the username and password you created when installing MySQL and the file name
is replaced with the name of the file you want to import. The -u and -p should remain on front of the username and password.
Installation instructions for java are maintained by Oracle and can be found here: How do I install Java?. Install the default or latest version pointed to by this site.
Installation instructions for Tomcat are maintained by the Apache Software Foundation here: Installation. Install the Tomcat version 7 or later.
Once Tomcat is installed it would normally be configured to run automatically in the services panel, if running on a Windows system. Ensure that Tomcat is up and running before downloading the DQA. You can confirm that Tomcat is running by visiting localhost:8080.
In this last step everything comes together for a working system. You should have Tomcat and MySQL up and running.
- Download the software application from the DQA Download site. Note:
you will need to enter the URL, username and password to download the software. The URL will probably be:
jdbc:mysql://localhost/dqa, if the database and Tomcat are installed on the same system. The username and password were set by you in the Setup Database stage. Setting these values here allows the downloading software to your database connection parameters in the DQA version you get.
- Save the dqa.war file into the Tomcat/webapps directory. In a windows system this can be found here: C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps
- Confirm that after a few seconds Tomcat has created a Tomcat/webapps/dqa directory to match the dqa.war file that you just copied in. This indicates that Tomcat is running and was able to unpack the DQA application and deploy it.
- Login to the DQA via your web browser . You will use the password you setup in the Setup Database stage.
Configure the DQA
Once you have successfully logged in you will want to configure the DQA to start working for you.