- Java EE application server e.g. Apache Tomcat
- Java 7 and above
Deploy the web application
Deploy the ART web application to the application server. If you don't already have a java application server set up, you can download and use Apache Tomcat.
You can get Tomcat from http://tomcat.apache.org/
The /usr/local/tomcat directory will be referred to as TOMCAT_HOME.
- Go to TOMCAT_HOME/bin and run ./startup.sh to start Tomcat.
- To stop Tomcat, go to TOMCAT_HOME/bin and run ./shutdown.sh
- Download and install the Windows Service Installer package
- Change the default install location from C:\Program Files, e.g. install to C:\tomcat.
- To start Tomcat, start the service e.g. type "net start tomcat7" in a command prompt window. You may need to open the command prompt window using the "Run as administrator" option.
- To stop Tomcat, stop the service e.g. type "net stop tomcat7" in a command prompt window
Once Tomcat is installed and started, open a browser and navigate to localhost:8080. You should see the Tomcat welcome page. This indicates that the Tomcat installation was successful.
Deployment on Tomcat
You can deploy web applications to Tomcat via a browser using the Tomcat Manager utility available from localhost:8080, or by copying the .war file to the TOMCAT_HOME\webapps directory.
- Ensure Tomcat is running
- Copy the file PACKAGE_PATH\art.war to TOMCAT_HOME\webapps. This will cause the web application to be deployed and a new directory TOMCAT_HOME\webapps\art to be created. This directory will be referred to as ART_HOME.
- Using a browser, navigate to localhost:8080/art
- Click on the Settings button
- ART needs a database to store details about queries, users etc (the ART repository). The application comes with an already configured sample database. Click on the Submit button to use this default database
- Click on the Log Off link. You need to log off at this point so that you can log in as an actual user.
- Log in using the username/password admin/admin
Installation is complete.
Using the default database
ART comes with a sample database embedded within the application. This allows you to explore the application's functionality without having to set up your own database and queries first. The database is a HSQLDB database that is run in standalone mode. The files for the database are contained in the ART_HOME\WEB-INF\hsqldb directory of the deployed application. To use this database as the ART repository,
- From the Admin Console, click on the Settings button
- Set the ART database username/password to ART/ART (both username and password are case sensitive)
- Set the jdbc driver field to "default"
- Set the jdbc url field to "default"
- Make any other application settings as you like and click on the Submit button
- If you decide to use the default database in a live/production environment, be careful. If you undeploy the application, accidentally or otherwise (e.g. when doing an application upgrade), you will lose the database as the database files will be deleted along with all other application files when the application is undeployed/redeployed.
The default database has 2 users configured - admin and auser. To login, use one of the following username/password combinations
- admin/admin (a super admin user)
- auser/auser (a normal user who can schedule jobs)
The default database has 2 datasources configured - ArtRepository and SampleDB.
- ArtRepository allows you to query ART repository tables e.g. ART_USERS, ART_QUERIES etc. The username/password for this datasource is ART/ART
- SampleDB allows you to query a sample target database. It has tables like ORDERS, ITEMS, REGIONS, CITIES. Most of the sample queries use this datasource. The username/password for this datasource is SAMPLE/SAMPLE.
The default database comes with a number of queries. These sample queries help to illustrate some of the query types and features of the application e.g. charts, dashboards etc
Using your own RDBMS
You can use a different RDBMS for the ART repository, instead of the sample one that comes with the application. The following steps are required to use a different database.
- Deploy the JDBC driver for your database to the application server. e.g. For Apache Tomcat, you can copy the driver to TOMCAT_HOME\lib or TOMCAT_HOME\webapps\art\WEB-INF\lib. ART comes with JDBC drivers for CUBRID, PostgreSQL, MySQL and HSQLDB.
- Create a database in your RDBMS to be used for the ART repository
- Run the SQL statements in the file PACKAGE_PATH\database\art_tables.sql to create the ART repository schema. Read the comments at the beginning of the file before running it to see if any modifications are needed for your RDBMS
- Run the SQL file for your RDBMS located in the PACKAGE_PATH\database\quartz directory
- Configure your database details in the Settings page
- Create a super admin user to administer the application
A variety of databases can be used including Oracle, MySQL, PostgreSQL, HSQLDB, SQL Server, CUBRID.
Create the database
Using MySQL on Windows
The database name, user and password can be set to anything you wish.
Using PostgreSQL on Windows
- Ensure the path to the PostgreSQL bin folder is included in the PATH environment variable
Open a command prompt window
When prompted for a password, enter the password for the postgres database user created when installing PostgreSQL. If the username of the account is not "postgres", use the appropriate name in place of postgres in the -U switch of the command.
postgres=# create user artuser password 'artpassword';
postgres=# create database art owner artuser;
postgres=# \c art
art=# \i 'c:/somepath/database/art_tables.sql'
art=# \i 'c:/somepath/database/quartz/tables_postgres.sql'
For the path to the sql scripts, use forward slashes instead of back slashes, and enclose the path in single quotes in case it contains spaces.
Using CUBRID on Windows
CUBRID is a comprehensive open source relational database management system highly optimized for Web Applications.
Using the CUBRID Manager application,
- Connect to your host
- Right click on Databases and select Create Database.... Provide the required details for database creation.
- Right click on the created database and select Login Database. Login with the username public and blank password. This will ensure that tables will be created with owner as "public", making access to them more straight forward.
- Right click on the database and select Run SQL File. Select the PACKAGE_PATH\database\art_tables.sql file and click on OK. Do the same for the PACKAGE_PATH\database\quartz\tables_cubrid.sql file.
- Once the database is created, navigate to localhost:8080/art using your browser
- Ensure that the JDBC driver for your database is available to the application. The following drivers are included with the application (in the ART_HOME\WEB-INF\lib directory). CUBRID, PostgreSQL, MySQL, HSQLDB, SQL Server (jTDS)
- Click on the Settings button, enter the appropriate details for your database and other application details and click on the Submit button
- From the Admin Console, click on the Users button and then create a super admin user to be used for administering the application
- Log off
- Log in as the newly created super admin user
- Create and publish queries as required
ART patches replace specific files in an ART installation in order to resolve specific issues.
If patches are available for your ART version, take the following steps.
- Download the latest patch for your version
- Stop the application server
- Backup the ART installation
- Extract the patch zip package to a temporary location
- Copy the art directory contained in the patch over the existing ART installation directory, overwriting existing files.
- New files in the patch with update relevant files, leaving all other files as they are were
- Start the application server
Only the latest patch for a particular version needs to be applied as the latest patch contains all the fixes in the previous patches.