Orbeon Forms
  • Getting started
  • Installation
    • Logging
    • Configuration banner
    • Docker
    • Azure
    • Tomcat
    • WildFly
    • WebSphere
    • WebLogic
    • GlassFish
    • Caches
    • Replication
    • Upgrading
  • Configuration
    • Properties
      • General
        • HTTP client
      • Form Runner
        • Detail page
          • Attachments
          • Email
          • PDF
          • Table of contents
        • Persistence
        • Summary page
      • Form Builder
      • XForms
    • Advanced
      • Workflows
      • Session management
      • State handling
      • Client-side error handling
      • Clustering and High Availability
      • Configuring a Form Runner eXist database
      • Creating a production WAR
      • Environments
      • JavaScript and CSS assets
      • Limiter filter
      • Run modes
      • Security
        • Content-Security-Policy header
      • SAP Hybris Module
      • XForms logging
    • Troubleshooting
      • Troubleshooting with the orbeon.log
      • Memory and threads
      • Relational database logging
      • Misc
  • Form Builder
    • Form settings
      • Time window
    • Form editor
      • Form area
      • Toolbox
      • Buttons bar
      • Control settings
      • Dependent fields and sections
      • Validation
      • Choices editor
      • Publishing
      • Cut, copy and paste
      • Section and grid settings
      • Section settings
      • Grid settings
      • Quick control search
      • Repeat settings
      • Repeated grids
      • Undo and redo
      • Keyboard shortcuts
    • Formulas
      • Examples of formulas
      • Formulas inspector
      • Formulas console
    • Summary page
    • Form localization
    • Advanced
      • Edit source
      • Services and actions
        • HTTP services
        • Database services
        • Simple Actions
        • Action Syntax
        • Action Syntax examples
        • Synchronizing repeated content
      • Testing a form in web mode
      • Testing PDF production
      • Testing offline functionality
      • Email settings
      • Field-level encryption
      • Messages
      • Section templates
      • Template syntax
      • XML Schemas support
      • Extensibility
        • Extension API
        • Integration
        • Toolbox component metadata
  • Form Runner
    • Overview
      • Terminology
    • Pages
      • Landing page
      • Published Forms page
      • Forms Admin page
      • Summary page
    • Components
      • Alert dialog
      • Attachment
      • Autocomplete
      • Captcha
      • Character counter
      • Checkbox input
      • Currency
      • Date
      • Dropdown date
      • Static and dynamic dropdown
      • Error summary
      • Grid
      • Handwritten signature
      • Hidden field
      • Image
      • Image annotation
      • Image attachment
      • Number
      • Open selection
      • Repeater
      • Formatted Text / Rich Text Editor
      • Section
      • Single-selection tree
      • Source code editor
      • Time
      • US phone
      • US state
      • Video
      • Video attachment
      • Wizard
      • XForms inspector
      • Yes/No answer
    • Features
      • Automatic calculations dependencies
      • Datasets
      • Excel and XML import
      • Excel and XML export
      • Summary page Excel Export
      • Form definitions and form data Zip Export
      • Purging historical data
      • Lease
      • Localization
      • Supported languages
      • Mobile support
      • Multitenancy
      • Form Runner navigation bar
      • PDF production
        • Automatic PDF
        • Automatic PDF header and footer configuration
        • PDF templates
      • Responsive design
      • Revision history
      • S3 storage
      • Simple data migration
      • TIFF production
      • Versioning
      • Wizard view
      • Workflow stage
    • Persistence
      • Using a relational database
      • Relational database schema
      • Purging old data using SQL
      • Auditing
      • Autosave
      • Database support
      • Flat view
    • Linking and embedding
      • Linking
      • Java Embedding API
      • JavaScript Embedding API
      • Liferay full portlet
      • Liferay proxy portlet
      • Securing Form Runner access
      • Form Runner offline embedding API
      • Angular component
      • React component
    • Access control and permissions
      • Users
      • Login & Logout
      • Deployed forms
      • Form fields
      • Editing forms
      • Owner and group member
      • Organizations
      • Scenarios
      • Token-based permissions
    • Styling
      • CSS
      • Grids CSS
      • Automatic PDF styling and CSS
    • APIs
      • Authentication of server-side service APIs
      • Persistence API
        • CRUD API
        • Search API
        • List form data attachments API
        • Form Metadata API
        • Lease API
        • Reindexing API
        • Caching
        • Versioning
        • Revision History API
        • Zip Export API
        • Custom persistence providers
      • Other APIs
        • Connection context API
        • Duplicate form data API
        • File scan API
        • Form Runner JavaScript API
        • Generate XML Schema API
        • PDF API
        • Publish form definition API
        • Run form in the background API
      • Data formats
        • Form data
        • Date and time
        • Form definition
    • Architecture and integration
      • Architecture
      • Access form data
      • Integration
    • Advanced
      • Buttons and processes
        • Simple process syntax
        • Core actions
        • Form Runner actions
          • Save action
          • Send action
          • Email action
        • XForms actions
        • Predefined buttons, processes and dialogs
        • Summary page buttons and processes
      • Custom dialogs/model logic
      • Services
      • Singleton form
      • Monitoring HTTP requests
  • XForms
    • Core
      • Attribute Value Templates (AVTs)
      • Binds
      • Validation
      • Variables
      • Keyboard focus
      • XForms JavaScript API
      • Error handling
        • Detailed behavior
      • Model-Bind variables
      • XForms 2.0 support
    • Events
      • Standard support
      • UI refresh events
      • Keyboard events
      • Extension events
      • Extension context information
      • Other event extensions
    • Actions
      • Repeat, insert and delete
      • Scripting actions
      • Extensions
    • Controls
      • Label, hint, help
      • Input
      • Output
      • Text area
      • Button
      • Upload
      • Dialog
    • Submission
      • Standard support
      • JSON support
      • Asynchronous submissions
      • Caching extension
      • Other submission extensions
    • XPath
      • Type annotations
      • Expression analysis
      • Tips
      • Compatibility
      • Standard functions
      • Maps and arrays Functions
      • Extension functions
        • Core functions
        • Utility functions
        • Model functions
        • Controls functions
        • XML functions
        • JSON functions
        • HTTP functions
        • Form Runner functions
        • Other functions
        • Deprecated functions
    • XBL components
      • FAQ
      • Guide
        • XBL Tutorial
        • Bindings
        • XForms models
        • Including content
        • Event handling
        • Conventions
        • Map XBL example
        • Learning from existing components
      • Advanced topics
        • XBL Modes
        • JavaScript companion classes
        • XBL library
        • Extensions
        • Attachment controls
    • XForms tutorial
      • Introduction
      • Installation
      • The Hello application
      • The Bookcast application
        • The basic app
        • Database access
        • Polishing the app
        • Adding a feed
    • Using XForms from Java apps
  • XML Platform
    • Page Flow Controller
      • Basics
      • XML submission
      • Navigating between pages
      • Paths and matchers
      • Other configuration elements
      • Typical combinations of page model and page view
      • Examples
      • Authorizing pages and services
    • Processors
      • URL generator
      • Request generator
      • PDF to image converter
    • Resources
      • Resource managers
      • Setting up an external resources directory
    • Other
      • Binary and text documents
  • FAQ
    • Licensing
    • PE and Dev Support
    • Form Builder and Form Runner
    • Resources and support
    • Other technical questions
  • Contributors
    • Automated tests
    • Building Orbeon Forms
    • Localizing Orbeon Forms
    • Validation functions
    • Contributor License Agreement
  • Release notes
    • Orbeon Forms 2022.1.9
    • Orbeon Forms 2024.1.1
    • Orbeon Forms 2023.1.7
    • Orbeon Forms 2024.1
    • Orbeon Forms 2023.1.6
    • Orbeon Forms 2023.1.5
    • Orbeon Forms 2021.1.11
    • Orbeon Forms 2022.1.8
    • Orbeon Forms 2023.1.4
    • Orbeon Forms 2023.1.3
    • Orbeon Forms 2023.1.2
    • Orbeon Forms 2022.1.7
    • Orbeon Forms 2023.1.1
    • Orbeon Forms 2023.1
    • Orbeon Forms 2022.1.6
    • Orbeon Forms 2021.1.10
    • Orbeon Forms 2022.1.5
    • Orbeon Forms 2021.1.9
    • Orbeon Forms 2022.1.4
    • Orbeon Forms 2022.1.3
    • Orbeon Forms 2021.1.8
    • Orbeon Forms 2022.1.2
    • Orbeon Forms 2022.1.1
    • Orbeon Forms 2022.1
    • Orbeon Forms 2021.1.7
    • Orbeon Forms 2021.1.6
    • Orbeon Forms 2021.1.5
    • Orbeon Forms 2021.1.4
    • Orbeon Forms 2021.1.3
    • Orbeon Forms 2021.1.2
    • Orbeon Forms 2021.1.1
    • Orbeon Forms 2021.1
    • Orbeon Forms 2020.1.6
    • Orbeon Forms 2019.2.4
    • Orbeon Forms 2019.1.2
    • Orbeon Forms 2018.2.5
    • Orbeon Forms 2018.1.4
    • Orbeon Forms 2020.1.5
    • Orbeon Forms 2020.1.4
    • Orbeon Forms 2020.1.3
    • Orbeon Forms 2020.1.2
    • Orbeon Forms 2019.2.3
    • Orbeon Forms 2020.1.1
    • Orbeon Forms 2020.1
    • Orbeon Forms 2019.2.2
    • Orbeon Forms 2019.2.1
    • Orbeon Forms 2019.1.1
    • Orbeon Forms 2019.2
    • Orbeon Forms 2019.1
    • Orbeon Forms 2018.2.4
  • Release history
  • Use cases
  • Product roadmap
  • Index of features
Powered by GitBook
On this page
  • Rationale
  • How it works
  • With Tomcat
  • With WebLogic
  • With any container
  1. XML Platform
  2. Resources

Setting up an external resources directory

PreviousResource managersNextOther

Rationale

In some cases, you want to keep the files from Orbeon Forms completely separate from those of your application. You want to deploy the Orbeon Forms web archive (war) and use it without having to make any change to any of the file inside that archive. This approach has several benefits, including:

  • Upgrading (or downgrading) Orbeon Forms is easier, as you can just re-deploy an version, without having to do any further changes.

  • Since you are not going to directly change any of the files inside the Orbeon Forms web archive, you can look at it as one module, and don't need to worry at all about any of the files it contains.

How it works

Orbeon Forms uses to load most of the files that configure or implement your forms. You can use different resource managers, which look for files in different places, say in a sub-directory inside the web archive (e.g. WEB-INF/resources), or from the class path (e.g. inside jar files), or in a specific directory on disk. Different resources managers can also be chained, so you can configure Orbeon Forms to look for in location A first, and then in location B next. This is configured with context parameters, which you typically set in the WEB-INF/web.xml.

To be able to override resources that come with Orbeon Forms without changing any of the files inside the web archive:

  1. Create a directory on disk, in which you put the resources you want to override. Let's assume this directory is /home/myapp/resources. So if you want to override properties, you create your own /home/myapp/resources/config/properties-local.xml. To deploy your PE license, place it in /home/myapp/resources/config/license.xml.

  2. You will instruct Orbeon Forms to first try using a resource manager that is file system based, and that looks for resources in the base directory /home/myapp/resources. This is done by setting the following two context parameters:

    • First added context parameter:

      • Name: oxf.resources.priority.0

      • Value: org.orbeon.oxf.resources.FilesystemResourceManagerFactory

    • Second added context parameter:

      • Name: oxf.resources.priority.0.oxf.resources.filesystem.sandbox-directory

      • Value: /home/myapp/resources

You typically set context parameters in the web.xml, but don't want to do so here, as you don't want to change any of the files inside the web archive. So you will be setting those context parameters at the application server level, and the way you do this depends on what application server you use. See the section below that corresponds to your application server.

With Tomcat

In Tomcat's server.xml, add the two <parameter> elements to the <context> you have there for Orbeon Forms (add a <context> for Orbeon Forms, if you don't have one already):

<Context
        path="/orbeon"
        docBase="path/to/orbeon-war"
        reloadable="false"
        override="true"
        crossContext="true">
    <Parameter
        override="false"
        name="oxf.resources.priority.0"
        value="org.orbeon.oxf.resources.FilesystemResourceManagerFactory"/>
    <Parameter
        override="false"
        name="oxf.resources.priority.0.oxf.resources.filesystem.sandbox-directory"
        value="/home/myapp/resources"/>
</Context>

With WebLogic

  1. Save the XML file below in to an XML file (say plan.xml). This is going to be your WebLogic deployment plan. You keep it in a directory if your choice, separate from Orbeon Forms. (If you are already using a deployment for Orbeon Forms, then amend as appropriate.)

     <?xml version='1.0' encoding='UTF-8'?>
     <deployment-plan xmlns="http://xmlns.oracle.com/weblogic/deployment-plan"
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                      xsi:schemaLocation="http://xmlns.oracle.com/weblogic/deployment-plan http://xmlns.oracle.com/weblogic/deployment-plan/1.0/deployment-plan.xsd"
                      global-variables="false">
         <application-name>orbeon-ear</application-name>
         <variable-definition>
             <variable>
                 <name>filesystem_resource_manager</name>
                 <value>org.orbeon.oxf.resources.FilesystemResourceManagerFactory</value>
             </variable>
             <variable>
                 <name>filesystem_sandbox_directory</name>
                 <value>/home/myapp/resources</value>
             </variable>
         </variable-definition>
         <module-override>
             <module-name>orbeon</module-name>
             <module-type>war</module-type>
             <module-descriptor external="false">
                 <root-element>web-app</root-element>
                 <uri>WEB-INF/web.xml</uri>
                 <variable-assignment>
                     <name>filesystem_resource_manager</name>
                     <xpath>/web-app/context-param/[param-name="oxf.resources.priority.0"]/param-value</xpath>
                     <operation>add</operation>
                 </variable-assignment>
                 <variable-assignment>
                     <name>filesystem_sandbox_directory</name>
                     <xpath>/web-app/context-param/[param-name="oxf.resources.priority.0.oxf.resources.filesystem.sandbox-directory"]/param-value</xpath>
                     <operation>add</operation>
                 </variable-assignment>
             </module-descriptor>
         </module-override>
     </deployment-plan>
  2. From the WebLogic Console, under Deployments, click the checkbox next to orbeon-ear, and click on the Update button.

  3. On the next screen, choose Redeploy the application using the following deployment files. The Source path will most likely be pre-populated with the path in which you have your Orbeon Forms enterprise archive (exploded or as an ear file). For the Deployment plan path, select the file you created in step 1. Click Finish to redeploy Orbeon Forms taking into account the context parameters set in the deployment plan.

Step 2 and 3 above assume you use the WebLogic Console to deploy Orbeon Forms. If instead you use java weblogic.Deployer, on the command line, just add the following parameter to the command you normally use to deploy Orbeon Forms: -plan plan.xml.

With any container

Web app context parameters are typically defined in the WEB-INF/web.xml, and some containers provide a mechanism for you to override those parameters without having to change the WEB-INF/web.xml. We've seen earlier how to do this on Tomcat and WebLogic.

If your container does not provide such a mechanism, or updating the WEB-INF/web.xml isn't a problem for you, you can point your container to an external resource directory by adding the following to your WEB-INF/web.xml:

<context-param>
    <param-name>oxf.resources.priority.0</param-name>
    <param-value>org.orbeon.oxf.resources.FilesystemResourceManagerFactory</param-value>
</context-param>
<context-param>
    <param-name>oxf.resources.priority.0.oxf.resources.filesystem.sandbox-directory</param-name>
    <param-value>/home/myapp/resources</param-value>
</context-param>

This assumes that you are deploying Orbeon Forms in WebLogic as an enterprise archive (ear), as described in .

resource managers
Installation with WebLogic