Getting started with SEAF
SEAF pre-requisites
The following needs to be installed on a machine to start working with SEAF:
- J2SE Core SDK 1.4, downloadable e.g. from http://java.sun.com.
- Ant, downloadable from http://ant.apache.org. Note that when using certain IDEs, Ant is already included in them (e.g. Eclipse).
- A J2EE application server. SEAF was developed with JBoss
(http://www.jboss.org). JBoss versions 3.2.3 and 3.2.7 have been used and work just fine. JBoss v. 4.x.x are not supported yet.
Sun Java Application Server bundled with J2EE SDK was used for development in past, so it sould be also working OK, but is not used anymore.
JBoss server is recommended, however, a "J2EE.jar" file is needed for application development, which only comes with the Sun J2EE package.
Installing SEAF
To install SEAF, just unzip the download file into a directory of your choice.
Directory structure of SEAF
The following table summarizes the directory structure of SEAF. SEAF is included in the download file in subdirectory seaf.
Directory
|
Content
|
app
|
Contains the application-specific configuration files:
- The SLIS xml configuration file
- The language-specific properties files to localize the application into multiple languages
|
appsrc
|
Contains the application Java source files.
|
build
|
The main build directory of the application. The SEAF runtime framework classes are pre-filled into the build directory.
|
functional
|
Contains the functional test suite automated using Canoo WebTest and DBUnit.
|
generator
|
Contains the SEAF XSLT generator files.
|
resources
|
Contains the application-specific files to be included into the web context path, e.g. the HTML Cascading Style Sheet file.
|
SEAF root
|
Contains the Ant build file – build.xml.
|
Running the provided application on JBoss
1. After installing SEAF, customize the Ant build file. Go to the SEAF directory (the directory with the build.xml file) and edit the build.xml file. Set the following properties in section "Development environment-specific settings" as follows:
- Set property "deploy" to the hot deploy directory of your JBoss installation
- Set property "cp.j2ee.jar" to point to the J2EE JAR file of the JBoss application server
2. Now build the provided application: execute ant in the SEAF directory (type 'ant' and press Enter). This generates the application files, builds the application distribution EAR file and hot deploys the application on your JBoss application server.
3. Start the JBoss application server, if not already started.
4. Point your web browser to http://localhost:8080/csvc. This should bring up the screens of the application. Follow these instructions to start working with the application.
Running the provided application on Sun Java Application Server
1. After installing SEAF, customize the Ant build file. Go to the SEAF directory (the directory with the build.xml file) and edit the build.xml file. Set the following properties in section "Development environment-specific settings" as follows:
- Set property "deploy" to "dist"
- Set property "cp.j2ee.jar" to point to the J2EE JAR file of the Sun Java Application Server
2. Now build the provided application: execute ant in the SEAF directory (type 'ant' and press Enter). This generates the application files and builds the application distribution EAR file.
3. Start the Sun Java Application Server, if not already started:
- Choose "Start default server" from the corresponding menu
- Choose "Start PointBase" from the corresponding menu
4. Deploy the application:
- Start the Deploy Tool, if not already started: choose "Deploytool" from the corresponding menu
- Open the generated EAR file (File – Open, and select the csvc.ear file from the dist directory)
- Save the application (File – Save). This should add some Sun-specific files to EAR. Verify this by opening the META-INF item in the tree named Contents: it should contain file named sun-application.xml. If not, repeat the previous step again (open and save).
- Select the EJB item under the EAR file in the tree on the left side.
- Invoke "Sun-specific Settings…" button down on the right side. A dialog is displayed.
- Invoke the "Create Database Mappings…" button. Another dialog pops up.
- Confirm the dialog with OK button.
- Select "Enterprise Bean" as "Sequence".
- Invoke button "Advanced settings…". A dialog pops up.
- Select "Consistency Level" as "Lock when Loaded".
- Confirm the dialog with OK button.
- Close the dialog with Close button.
- Select the main application item (named CustomerServices) in the tree on the left side.
- Save the application (File – Save).
- Deploy the application (Tools – Deploy, press OK).
5. Point your web browser to http://localhost:8080/csvc. This should bring up the screens of the application. Follow these instructions to start working with the application.
Back to SEAF home page…