Surjey 0.3.1 Administrator's Guide Overview top of document Surjey is a Web application for survey management. Currently, Surjey supports the ability for any user to create new surveys and edit existing ones, and to select, complete and submit a survey. Future revisions will support response summarization and collation, authentication of specific users for survey administration, and capture of user contact information. This document describes how to obtain, install, and configure the application. Contents top of document Minimum Requirements Obtaining the Application Installing the Application Changes in Recent Releases Known Issues Participate in Development License and Copyright Information Minimum Requirements top of document In order to use this application, you must obtain the following components, install them, and configure them to interoperate (which is beyond the scope of this manual): An application server that supports the following: Java Servlet Specification 2.3 or later Java Server Pages Specification 1.2 or later For example: Apache Jakarta Tomcat (tested on 4.1.27 through 4.1.29) JBoss AS Macromedia Coldfusion or Macromedia JRun Enhydra Server A database server that supports the following: JDBC 2.0 or later Auto-increment/auto-generation of primary keys. For example: MySQL (tested on 4.0.16 through 4.1.11) and MySQL Connector/J (tested on 3.1.1 through 3.1.8). Consult your user support services team, system administrator, or account provider if you are unsure whether or not your systems meet these minimum requirements. Obtaining the Application top of document After you have ensured that you meet the minimum requirements, download the latest release from SourceForge. Unpack the distribution using an appropriate unarchiving tool. 7-Zip is one such utility, and is also free, light-weight, and feature-rich. Installing the Application top of document After you have obtained a release, you will need to install it. The following instructions are fairly general to allow for variations between databases and container products and configurations. If you are installing this application for the first time, you will need to create the database instance, named surjey, all the tables, and populate it with some sample data. If you are using MySQL for your database, you can use the provided SQL script, tools/db/init_database.sql, to do so. If you are using a different database, you can customize the SQL scripts in the tools/db directory, or inspect them to determine how to create the tables manually. Deploy the application WAR file, dist/surjey.war, into your application server. Access the application using a Web browser at the server path for your container followed by the context path you chose when you deployed the application in the previous step. For example, if you are using Tomcat with the default configuration, this address should be: http://localhost:8080/surjey/. Changes in Recent Releases top of document Release 0.3 simplifies the process of building a survey by combining the many of the separate screens together into master/detail screens. Release 0.3 includes some enhancements in the look and feel one experiences while building a survey. Release 0.2 includes a complete refactoring of the code within the Model, which is transparent for users, but is a significant improvement for developers. Known Issues top of document None. Participate in Development top of document Please consult the Developer's Guide to find out how to participate in development. License and Copyright Information top of document All files provided with this application are © 2004-5, Casey Heckman and Bennett Yates. All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. © 2004-5, Casey Heckman and Bennett Yates. All rights reserved.