IBIS-Q System Documentation - Development EnvironmentThis page provides notes on the development environment which includes tools to use, where to get the tools, installation notes, and source files etc. This page also provides information about how to create the Web Archive deployment package. In the future CVS notes will be added as well. The items discussed on this page assume that the developer is using an Intel based PC running some form of the MS-Windows operating system. However, development can be performed on many different platforms including Linux, Unix, Mac, IBM workstations etc. Listed below are the key items that are needed:
The specific items listed below are specific to an Intel based PC running MS-Windows/XP with the Eclipse IDE, Tomcat, Sun Java JDK. This is not the only way to do this nor is it the best it is simply some general information on what is available and can be done. Also, specific versions and installation instructions are not given as versions change frequently and installation instructions are readily available and covered in much greater detail on the web. As of April, 2006, the IBIS-PH View System has been successfully deployed using Sun's JDK 5.x with Tomcat 5.x.
Java Development Kit with RuntimeGo to http://java.sun.com/ and download the latest JDK for your environment (http://java.sun.com/j2se/1.5.0/download.jsp and choose the latest Java 5.x follow screen as needed to accept choose Windows offline or online and proceed to install on PC). This will involve navigating through several web pages and selecting some sort of "Acceptance". As of April, 2006 this version was 1.5 Release 6. If the ".EXE" is downloaded (recommended), simply run this program and it will step through the installation of the JDK and JRE. If the ".ZIP" is downloaded then the instructions contained within the ZIP file will need to be followed. This may or may not require a reboot of the system. For the ".EXE", the files are typically installed to a directory like "C:\Program Files\Java\jre1.5.x".
Java DocsGo to http://java.sun.com/ and download the latest J2SE and J2EE doc API ZIP files. Put these files in the root directory that the JDK was installed to.
TomcatGo to http://tomcat.apache.org/ and download the latest Tomcat for Windows (get the .EXE). Run the downloaded EXE which will install the files and optionally install Tomcat as a service (select this option if you want Tomcat to auto start when your computer is booted). The default directory that Tomcat will be installed under is the "C:\Program Files\...". It is suggested that the software be installed in a directory closer to the root, something like "C:\tomcat". The reason is that the level of directories becomes fairly deep and harder to navigate to. If Tomcat is not installed as a Windows Service, then create a shortcut to the "tomcat/bin/startup.bat" file so that it is easily launched. To test Tomcat, start Tomcat and try the default link of http://localhost:8080/. This should display the Tomcat welcome page. See the Tomcat Setup page for more information and options.
IBIS-PH View System ApplicationGo to http://ibis.health.utah.gov/ibisph-view.zip and download the latest ibisph-view.zip file (or if not available could be a ".war" file). If it is a ".zip" file, create a directory typically "ibisph-view" under the "tomcat/webapps" directory and extract to this tomcat/webapps/ibisph-view directory. If it is a ".war" file then simply copy this file to the "tomcat/webapps" directory and restart Tomcat (which if auto deploy is enabled will cause Tomcat to extract the contents and build a application content of "ibisph-view"). Again see the Tomcat Setup page/Deployment for more detailed information. If the system has been properly deployed then the http://localhost:8080/home/welcome.html link should display the IBIS-PH Welcome Page.
XML EditorXML Editors are more than text editors. They all provide the ability to validate the XML file, tag highlighting and coloring, auto formatting, with most providing a tree or grid view/editor, auto tag generation and completion. Some have support for XSLT, SVG, XPath, XSD, DTD, and can even interface with databases or do convert to different XML structures. The three main IBIS-PH View System file types that are created and need to be maintained are the PAGE documents, the Query Module Selection documents, and the Query Module documents. The IBIS-PH View System also uses XSLT and SVG but these files do not need to be modified for the most page. Listed below are some of the many XML editor choices along with a brief overview of each. They are listed in order of perceived value with the bottom line being that there is NOT a perfect free XML editor that does it all (as of 4/2006) with the definition of "all" being real time validation with good meaningful messages, ability to jump to problem area, visual icon/clue for problems, DOM tree view, auto formatting, auto tag completion, support for XSD, DTD, SVG, XSLT, XPath evaluator, and last but not least a text edit view with line numbers, customizable fonts, and indenting control.
Other XML editors include IBM's XEENA (poor), Oxygen (which has allot of features but costs $180), Open XML Editor (Win32, Only saves UTF-8 and provides basic validation not much else, plus it is slow for Win32), XML Fox (free for those who have .Net), Cooktop is no long being developed/supported and has some short comings, Peter's XML Editor is limited, JEdit has decent reviews with XML but the current XML validation plugins do not work. There are many others as well as offerings from Microsoft and Oracle. Bottom line is that if an all in one solution is desired then you get what you pay for. If free is desired then some combination of the free tools will have to be used (as of 4/2006).
Java IDE (Eclipse)Go to http://www.eclipse.org/downloads/ and download the latest version of Eclipse. Eclipse is a very nice, free environment but is project oriented. That is, it can not be used as an editor. A project with all the directories etc. have to be setup before it can be used. There are hundreds of Eclipse plugins that provide everything from spell checking to database modeling (see http://eclipse-plugins.2y.net/eclipse/plugins.jsp).
Eclipse XML Editor Plugin:
Go to http://xmlbuddy.com/ and download the latest free (or commercial if you want to pay) version of XMLBuddy. Follow the instructions on how to install. XMLBuddy is a nice basic XML editor/ validator. It provides all of the core needs - element highlighting and coloring, validation, auto formatting etc.
Java Class ModelerESS-MODEL is an open source project that creates and views class diagrams from Java code. This is not a mandatory tool but can be helpful for seeing relationships and documenting the Java code.
ANTAnother Neat Tool (ANT) is widely used for cross platform Java application development control. This includes compiling Java class files, copying files, building deployments, and a host of odd scripting tasks that are commonly needed.