Get Started with JSX Prerequisities Download Installation Exploded Installation JAR file Installation Get Started with SynapticFaces Library Dependencies Installation Other Considerations

Get Started with JSX

To get started with the JavaScript Extension toolkit is very easy. There are a couple of prerequisities we assume one already satisfies.

Prerequisities

This documentation has been written with a user that is already familiar with JavaScript, that way he/she can follow the topics here.

Download

The JSX JavaScript library can be downloaded here. Depending on your specific installation scenario, you can download either a .jar or a .zip archive. Beside the archive files that contain the JSX library, you will also find a .war archive that contains configured WEB application showcasing the various JSX components and technologies.

Installation

The installation of JSX is actually quite trivial. There are two installation scenarios.

Exploded Installation

After downloading one of the distribution archives, all a developer needs to do is extract the contents of the archive into the root of his web application directory.

JAR file Installation

The installation of a .jar file is actually easier than in section above, but it assumes extra configuration.

• Install the .jar file in your web application, simply make sure to place it inside of your WEB-INF/lib directory.
• Configure the web.xml web application configuration file to use a ResourceServlet to access the archive contents.

NOTE: The JSXShowcase.war sample application is configured in this way.

Get Started with SynapticFaces

In this get started section we assume that you already know about J2EE web applications and are familiar with Java Server Faces. The SynapticFaces product has been tested to work on all major JSF implementations.

SynapticFaces requires Java JDK1.5 or later, sorry no 1.4 and earlier.

Library Dependencies

• jsxtoolkit-x.x.x.jar
• jsf-api.jar
• jsp-api.jar
• servlet-api.jar
• log4j.jar
• dom4j.jar

If you don't know where to get above libraries, download the showcase application SynapticShowcase.war, it contains all of the libraries and can be used as a reference.

Installation

This section assumes that you have already installed a web server such as Apache Tomcat, or an application server such as JBOSS. An installed server will generally give you access, with the exception of JSF, to most prerequisite libraries. JBOSS has the MyFaces implementation of JSF included.

• Download and install Java Server Faces implementation such as the Apache MyFaces.
• Download the JSX jsxtoolkit-x.x.x.jar.
• Download synapticfaces-x.x.x.jar.
• Download dom4j.jar and other prerequisite libraries as needed.
• Place the synapticfaces-x.x.x.jar and jsxtoolkit-x.x.x.jar libraries and all prerequisite libraries into the WEB-INF/lib directory.

NOTE: If you are unsure where to obtain prerequisite libraries, you can download the showcase application SynapticShowcase.war and extract the libraries already in it.

If you are using an IDE such as Eclipse to develop your application, some helpful pointers can be found here.

Other Considerations

The installation instructions show where in your web application to place the library files. Most of the time you will need to adapt the installation steps to your specific development environment and build process.