| the Apache XML site |

| Home |

| Community |

| Samples |

# How to build an XMLForm Wizard

PDF

This How-To will guide your through the steps needed to create a validating form which saves the data collected as a JavaBean. It shows the components needed to do this within the Cocoon framework, Schematron validation and XMLForm wizard. XMLForm is a Cocoon form extension mechanism which was inspired by Struts and XForms. It was written by Ivelin Ivanov and is currently included in the scratchpad of Cocoon 2.0.2. Using the XMLForm wizard makes form validation a quick and easy task.

- Overview
- Intended audience
- Purpose
- Prerequisites
- Five Steps
- Real World Extension
- Tips
- Related Resources
- Feedback
- Revisions

### Overview

This How-To will guide your through the steps needed to create a validating form which saves the data collected as a JavaBean. It shows the components needed to do this within the Cocoon framework, Schematron validation and XMLForm wizard. XMLForm is a Cocoon form extension mechanism which was inspired by Struts and XForms. It was written by Ivelin Ivanov and is currently included in the scratchpad of Cocoon 2.0.2. Using the XMLForm wizard makes form validation a quick and easy task.

### Intended audience

This How-To is aimed at users who have developed an understanding of the basics of Cocoon and wish to incorporate dynamic and self validating forms into their sites. You will need to understand and be familiar with XML, XSL, HTML, XPath, JXPath, actions, action sets, cocoon-form format, Java, XForms. If you are unfamiliar with these technologies it is advised that you learn these concepts first.

### Purpose

You will be able to automate two-way mapping between their HTML forms, XML and JavaBeans. The XML schema language is used to validate the form input. The forms can display different options depending on the users previous input. For example if a user ticks the checkbox to say they are interest in Cooking then they will later have the option to join Cookery mailing lists. If they did not tick the Cookery box they will not see the cookery mailing lists page.

### Prerequisites

Configuration requirements:

- A servlet engine such as Tomcat.
- JDK 1.2 or later
- Cocoon 2.0.2 CVS with scratchpad to be installed with the command: build webapp -Dinclude.webapp.libs=true -Dinclude.scratchpad.libs=true webapp

Requisite skills:

- basic Cocoon concepts, including Cocoon actions
- XML, XSL, HTML
- Java, JavaBeans
- XForms, XPath, JXPath

### Five Steps

Now you want to know how to create your own forms using the Wizard. Below are the steps you can follow:

- Step 1: XML forms
- Step 2: Validation
- Step 3: JavaBean
- Step 4: HowtoWizardAction.java
- Step 5: Sitemap

### Real World Extension

Now you have created the Mailing list forms you should know which files are needed to create your own validating forms. The possibities are endless now that you can add dynamic forms to your Cocoon run site.

- A simple shopping cart could be created using an XML database such as Xindice.
- Your site can now become more personalised and interactive for your visitors. They can create their own login details and set their own preferences with a few simple forms. Making your web site a home from home for them.
- You can now run surveys and tests from your site
- Add a voting system for new features to be added on your site
- A suggestions/ feedback form
- A simple form asking for more information to be sent regarding your products

### Tips

If you have a problem running the example given you can try the following tips:

- Check the logs sometimes they have more information than displayed in your browser.
- Check the mail archive as the chances are somebody else has had a similar problem too!
- Email me I will try to help you. Again please send the entire error message and all relevant information. Please use the title "XMLForm Help" in your emails.
- Try the Cocoon users mail list and remember to post the whole error message and try to supply all relevant information for a quick reply.

### Related Resources

Cocoon resources

- For all Cocoon basics see the Cocoon Web site.
- For actions take a look at the actions page. Actions are Avalon Components, so you may want to read Avalon's Whitepaper for more information.

XPath is simple to learn and the basis of JXPath.

- The W3C has a clear and simple tutorial.

JXPath is now at beta stage and is based on XPath.

- To learn more vist the home of JXPath

### Feedback

Needless to say this How-To was written with no intentional mistakes or errors but if you find any faults or can see any improvements, please email me, Heidi with them. I will do my upmost to keep this HowTo uptodate and error free.

### Revisions

Find a problem with this document? Consider contacting the mailing lists or submitting your own revision. For instructions, read the How To Submit a Revision.

- Revision, 2003-09-14 10:56
- Revision, 2003-09-14 10:56

by Heidi Brannan

Copyright © 2002-2003 The Apache Software Foundation. All rights reserved.