The development details of orbeon form integration with third-party applications via url

Form Builder and Form Runner integrate with other systems in a variety of ways. This article introduces the implementation details of URL integration.

When you use Form Builder to create a form, you can choose an application name and form name for the form. For example, for marriage registration, you can choose clerk as the application name and marriage registration as the form name.

When you publish the form, assuming you have deployed Orbeon Forms on the server http://www.city.gov/forms , citizens will be able to fill out a new marriage registration http://www.city , The url of this registration form is:

http://www.city.gov/forms/fr/clerk/marriage-registration/new

In a typical deployment, users will access this page from another part of your website or web application, which contains a link to a form provided by Orbeon Forms.

For example, a city government may have a page on its website that lists forms that citizens can fill out. The page links to http://www.city.gov/forms/fr/clerk/marriage-registration/new Marriage registration form.

Technology agnostic

The link does not make any assumptions about the technology used by the website or application you are linking to. Your site can use Drupal, WordPress, serve by IIS, use .NET or any other technology. For example, the following figure applies to the following situation: your website is served by Microsoft IIS, implemented in .NET, and linked to a form served by Orbeon Forms.

Paths

In our example, /fr/clerk/marriage-registration/new is what is called the path below. For a given form, there are multiple such paths. Understanding these paths is particularly important because it allows you to link from your website or web application to the form you created with Form Builder. All paths are related to the deployment context, that is, where you deploy Orbeon Forms, which in our example is http://www.city.gov/forms.

url specification

Summary page for a given form definition:

• For the summary page defined by the specified form: /fr/[APPLICATION_NAME]/[FORM_NAME]/summary
• Create an empty form: /fr/[APPLICATION_NAME]/[FORM_NAME]/new
• Edit existing form data: /fr/[APPLICATION_NAME]/[FORM_NAME]/edit/[DOCUMENT_ID]
• Display the HTML view in read-only mode:
  /fr/[APPLICATION_NAME]/[FORM_NAME]/view/[DOCUMENT_ID]
• Display form in read-only PDF format:
  /fr/[APPLICATION_NAME]/[FORM_NAME]/pdf/[DOCUMENT_ID]
• Display form in read-only TIFF format:
  /fr/[APPLICATION_NAME]/[FORM_NAME]/tiff/[DOCUMENT_ID]

We can use the form-version parameter to pass in the specified version number:

/fr/[APPLICATION_NAME]/[FORM_NAME]/summary?form-version=2

Use the parameter fr-language to specify the language.

More original articles by Jerry, all in: "Wang Zixi":