WildFly was formerly known as JBoss.

The following instructions should work with recent versions of WildFly.

Deploy Orbeon Forms

To install Orbeon Forms:

  1. For Orbeon Forms PE only, either:

    • place your license file under ~/.orbeon/license.xml (see License installation),

    • or add your license.xml to the orbeon.war under WEB-INF/resources/config/license.xml

  2. Start a standalone server with bin/standalone.sh

  3. Move the orbeon.war file into the WildFly standalone/deployments folder

  4. Check whether the deployment was successful by watching standalone/log/server.log

Creating an jboss-deployment-structure.xml

With Orbeon Forms 2018.2.2 and earlier, with some versions of WildFly, a jboss-deployment-structure.xml under the Orbeon Forms WAR's WEB-INF directory is needed:

<?xml version="1.0" encoding="UTF-8"?>
<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.1">
            <system export="true">
                    <path name="org/w3c/dom/css"/>             

Orbeon Forms 2018.2.3 and later, as well as Orbeon Forms 2019.1, already include this descriptor.

Setup a JDBC datasource

To setup a datasource, if you'd like Orbeon Forms to connect to your relational database, do the following:

  1. Setup Orbeon Forms to use a WildFly datasource (configured in the following steps):

    1. Set the oxf.fr.persistence.provider.*.*.* property in your properties-local.xml

      1. If you already created a WEB-INF/resources/config/properties-local.xml unzip it and add the property per the example below. Otherwise create that file with the following content:

         <properties xmlns:xs="http://www.w3.org/2001/XMLSchema"
             <property as="xs:string"
      2. Change the value of the property according to the database you're using, setting it either to oracle, mysql, sqlserver, postgresql, or db2.

      3. Update WEB-INF/resources/config/properties-local.xml inside the orbeon.war with the version you edited.

    2. Update the web.xml

      1. Unzip the WEB-INF/web.xml inside the orbeon.war.

      2. Editing WEB-INF/web.xml, towards the end of the file, uncomment the following:

      3. Inside <resource-ref>, replace oracle by the name of your database.

      4. Update WEB-INF/web.xml inside the orbeon.war with the version you edited.

    3. Update the jboss-web.xml

      1. Unzip the WEB-INF/jboss-web.xml inside the orbeon.war.

      2. Editing WEB-INF/jboss-web.xml, uncomment the following:

      3. Change the <res-ref-name> to match what the <res-ref-name> in yourweb.xml`.

      4. In <jndi-name>java:jboss/datasources/oracle</jndi-name>, replace oracle by the database name you used in <res-ref-name>.

      5. Update WEB-INF/jboss-web.xml inside the orbeon.war with the version you edited.

  2. In WildFly, install the JDBC driver:

    1. Download the MySQL JDBC driver, say oracle-driver.jar, and place it in the standalone/deployments directory.

    2. Start the server, and check you see the message Deployed "oracle-driver.jar" (runtime-name : "oracle-driver.jar").

  3. In WildFly, define the datasource:

    1. Editing standalone/configuration/standalone.xml, inside the <datasources> add the following:

       <datasource jndi-name="java:jboss/datasources/oracle" pool-name="oracle" enabled="true">
    2. In the jndi-name attribute, replace oracle by the name of your database. The value of this attribute must match the value you set earlier inside <jndi-name> when editing the jboss-web.xml.

    3. In <connection-url>, put the JDBC URL to your database.

    4. In <driver>, put the "runtime-name" of your driver as it shows in the log (it was oracle-driver.jar in our example above).

    5. In <security>, fill in the proper username and password.

Finally, you might want to double check the configuration you just did, ensuring names match across files, per the following diagram.

Last updated