Form Runner - URIs Format

Nomenclature

Forms are organized in a hierarchy:
  1. app - This is the top level of the hierarchy, in which you will have a number of forms. When choosing a name for an app keep in mind that this name will show in the URL. In general you'll have just one app for a given project and will choose the name to either reflect:
    • The company for which the forms are creates (e.g. acme)
    • The project/application name (e.g. federal-tax)
  2. form - The name of a particular form (e.g. form-1040).
  3. document - A particular "instance" of a form. That is a (possibly partially) filled out form. Unique IDs are automatically assigned to documents when they are created.
  4. mode - The mode in which a document is displayed (e.g. print-mode).

Automatic URIs

Custom URIs

Form Runner implements out of the box a number of pages and services. If you wish to extend Form Runner and implement your own pages and services, going with the following convention will make your code easier to understand to those already familiar with Form Runner.
  • Pages
    • Pages are typically implemented with XHTML+XForms (but from the perspective of the page flow, they are just "views").
    • URIs for pages will be accessible by end users from their browser.
    • URIs will have the form: /fr/page/custom/app/page-name
    • In the resources, your page need to be implemented with /forms/app/page/page-name.xhtml
  • Services
    • Services are typically implemented with XPL (but from the perspective of the page flow, they are just "views").
    • URIs for services can be prevented from being accessed by end users from their browser (e.g. with rules setup in a front-end Apache server).
    • URIs will have the form: /fr/service/custom/app/service-name
    • In the resources, your page need to be implemented with /forms/app/service/service-name.xhtml
Comments