• Java 5 or greater
• a servlet 1.4 container or greater (such as Apache Tomcat 5.5 or greater)

Hardware requirements

• If you are running Orbeon Forms CE, you don't need to install a license file.
• If you are running Orbeon Forms PE:
• complete the steps for your application server below
• you can obtain a full licence from Orbeon, or get a trial license from:
  http://www.orbeon.com/orbeon/fr/orbeon/register/new
• before starting your servlet container, copy your license file under the Orbeon Forms WAR file as:
  WEB-INF/resources/config/license.xml

BEA WebLogic 9.1

1. Select a directory where you want to store your web application. Let's assume the path you chose is C:/WebApps/orbeon.
2. Unzip orbeon.war into C:/WebApps/orbeon. There should now be a directory called WEB-INF under C:/WebApps/orbeon.
3. Start WebLogic's administration console.
4. Use the console to install a new Web application. When prompted to select a WAR file, point to the directory C:/WebApps/orbeon. When prompted for a context path, choose a value such as orbeon. Complete the installation and start the web application.
5. You should now be able to access the Orbeon Forms example applications by pointing your browser to the address of your WebLogic server followed by the context path you chose, for example: http://localhost:7001/orbeon/.

IBM WebSphere 5 and 6

1. Launch WebSphere server.
   
   
• Let's assume WSAS_HOME represents the location of your WebSphere installation.
• On Windows:
• To run WebSphere from the command line, execute WSAS_HOME/bin/startServer server1 (on WebSphere 5).
• To run WebSphere as a service: go to Control Panel, Administrative Tools, Services, Look for IBM WebSphere Application Server and make sure it is started.
• On Linux/UNIX:
• Run WSAS_HOME/profiles/default/bin/startServer.sh server1.
• Note:
• The default heap size is likely to be too low. You can increase the heap size from the WebSphere Administrative Console, by going to Server / Application Servers / server1 / Process Definition / Java Virtual Machine. There we recommend you set the Initial Heap Size and Maximum Heap Size to the same value.
  
  
2. Log in to the administrative console.
   
   
1. On WebSphere 5: got to http://localhost:9090/admin/.
2. On WebSphere 6: got to http://localhost:9060/ibm/console/.
3. The default administrator login is admin.
   
   
3. Install and deploy Orbeon Forms (orbeon.war).
   
   
• Click on Applications / Install New Application.
• Select the orbeon.war to upload, choose a context path like /orbeon (from now on we will assume this was your choice).
• Hit "next" until you get to the end of the wizard, then hit "finish". You can leave the defaults everywhere while going through the wizard.
• Save the configuration.
• Click on Applications / Enterprise Applications.
• Select orbeon_war and click on the "start" button.
• Note:
• One important log file (if something goes wrong when the application starts) is: WSAS_HOME/logs/server1/SystemOut.log on WebSphere 5.
• The WAR file is uncompressed by WebSphere in WSAS_HOME/installedApps/NODE_NAME/orbeon_war.ear/orbeon.war on WebSphere 5, where NODE_NAME if usualy your machine name.
  
  
4. Run and modify the example applications.
   
   
   • Go to http://localhost:9080/orbeon/.
   • You can view the log from Orbeon Forms in WSAS_HOME/profiles/default/logs/server1/SystemOut.log.
   • You can modify the example applications resources as the application sever is running and see the results of your modifications on the fly. The resources are stored under WSAS_HOME/profiles/default/installedApps/yourmachineNode01Cell/orbeon_war.ear/orbeon.war/WEB-INF/resources. For instance, try to modify apps/xforms-hello/view.xhtml: replace "Please enter your first name:" by your own message, and reload the page in the browser to see the result.
     

JBoss

1. Assuming that JBOSS_HOME represents the location of your JBoss installation: create a new JBOSS_HOME/server/default/deploy/orbeon.war directory.
   
2. Unzip the orbeon.war file in the orbeon.war directory you just created.
   
3. Depending on the version of JBoss you are using:
   
   
   • With JBoss 7: At this point JBoss 7 is not supported.
     
     
   • With JBoss 6:
     
     
   1. Create a file orbeon.war/WEB-INF/jboss-scanning.xml with the following content. This is get around a bug happening in the JBoss scanner when it goes through Scala classes.
      
      
      <scanning xmlns="urn:jboss:scanning:1.0">
    <path name="WEB-INF/lib/scala-library-2.8.1.jar">
        <exclude name="scala" recurse="true"/>
    </path>
</scanning>
      
      
   2. Edit orbeon.war/WEB-INF/jboss-web.xml and comment the 4 lines that start with <resource-ref> and end with </resource-ref>. This resource-ref is only useful if you want to setup Orbeon Forms to store data in a relational database. If this is the first time you are installing Orbeon Forms on JBoss, even if you ultimately want Orbeon Forms to store data in a relation database, we recommend you first get it up and running without this configuration. Once everything works, you can come back, uncomment this, and follow the steps in point #7 below to get Orbeon Forms to access your relational database.
      
   
   
   • With JBoss 5.0: no special configuration is needed.
     
     
   • With JBoss 4.0 / JBoss 4.2:
     
     
     1. Set the following parameter in web.xml:
        
        
        <context-param>
    <param-name>oxf.initialize-logging</param-name>
    <param-value>false</param-value>
</context-param>
        
        
     2. Rename the default Orbeon Forms log4j JAR file under WEB-INF/lib from log4j-*.jar to log4j-*.jar.bak. Additionally, you can remove this JAR file altogether.
        
        
   • With JBoss 4.0:
     
     
     1. Create a file jboss-web.xml in JBOSS_HOME/server/default/deploy/orbeon.war/WEB-INF with the following content:
        
        
        <jboss-web>
    <class-loading java2ClassLoadingCompliance="false">
        <loader-repository>
            orbeon.war:loader=orbeon.war
            <loader-repository-config>java2ParentDelegation=false</loader-repository-config>
        </loader-repository>
    </class-loading>
</jboss-web>
        
        
   • With JBoss 3.2:
     
     
     1. In JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/META-INF/jboss-service.xml and change the value in <attribute name="UseJBossWebLoader"> from false to true.
        
        
4. Start JBoss by running JBOSS_HOME/bin/run.bat (or run.sh on UNIX).
   
5. Run and modify the example applications.
   
   
1. Go to http://localhost:8080/orbeon/
2. You can modify the example applications resources as the application sever is running and see the results of your modifications on the fly. The resources are stored under JBOSS_HOME/server/default/deploy/orbeon.war/WEB-INF/resources.
   
   
6. Optionally, to run the authentication sample:
   
   
1. Open JBOSS_HOME/server/default/deploy/orbeon.war/WEB-INF/web.xml and uncomment the security-constraint, login-config and security-role declarations at the end of the file.
2. Open JBOSS_HOME/server/default/deploy/orbeon.war/WEB-INF/jboss-web.xml and uncomment the security-domain element near the end of bottom of the file.
3. Open JBOSS_HOME/server/default/conf/login-config.xml and add the following aplication policy to the list of policies:
   
   
   <application-policy name="orbeon-demo">
    <authentication>
        <login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" flag="required">
            <module-option name="usersProperties">jboss-orbeon-example-users.properties</module-option>
            <module-option name="rolesProperties">jboss-orbeon-example-roles.properties</module-option>
        </login-module>
    </authentication>
</application-policy>
   
   
7. Optionally, you might want to setup a JDBC data source if your application is using the SQL Processor. What follows assumes you are configuring the SQL Processor with <sql:datasource>my-datasource</sql:datasource>.
   
   
1. Look at the files JBOSS_HOME/docs/examples/jca/*-ds.xml. You should find one that correspond to the database you are using. Copy it to JBOSS_HOME/server/default/deploy.
2. Edit the file you copied and change the parameters to match your database configuration. Also assign a JNDI name to this data source with: <jndi-name>my-database</jndi-name> (instead of my-database you might want to use a name which is descriptive of your database).
3. Edit WEB-INF/web.xml and uncomment the <resource-ref>. Also change there the content of <res-ref-name> to match the name you are using in the SQL Processor prefixed with jdbc/: <res-ref-name>jdbc/my-datasource</res-ref-name>.
4. Edit WEB-INF/jboss-web.xml. In that file you should have <res-ref-name>jdbc/my-datasource</res-ref-name> (the same name you use to configure the SQL Processor and that you have in the web.xml) and <jndi-name>java:/my-database</jndi-name> (the same name you declared in the ...-ds.xml file).
5. Copy the JAR files with the JDBC driver for your database in JBOSS_HOME/server/default/lib.

Oracle Application Server and OC4J

Installation and runtime issues

Session not found when running both Tomcat and WebLogic

• Tomcat creates one JSESSIONID per web application, with the cookie path set to the context of the application. When an application invalidates the session, Tomcat sends a new JSESSIONID to the browser.
• WebLogic stores one cookie JSESSIONID with cookie path / for all the applications. This cookie doesn't change when a session is invalidated, and hence there is no one-to-one mapping between a JSESSIONID cookie and a session in WebLogic.

1. You first access your application deployed on /myapp with Tomcat. Tomcat sets a JSESSIONID cookie for /myapp.
2. You then access your application on the same server deployed on /myapp with WebLogic. Tomcat sets a JSESSIONID cookie for /.
3. In subsequent requests, the browser sends the Tomcat JSESSIONID as it is more specific (for /myapp instead of just /), but WebLogic doesn't recognize it, hence the error you're getting.