frevvo Latest - This documentation is for frevvo v10.3. v10.3 is a Cloud Only release. Not for you? Earlier documentation is available too.

Integrating with REST Applications

From the point of view of the user interface, most web applications can be thought of simply as CRUD (Create, Retrieve, Update & Delete) operations on documents. In the diagram below, the form is being used to initially display a Customer and Order and then to update them. If you think in REST terms, the form is a View Resource that composes multiple Entity Resources (in this case a Customer Resource and an Order Resource), displays their current state and allows you to update them.

frevvo provides a very flexible and powerful mechanism for interacting with documents (and the web in general).

Integrating with HTTP Servers via Form & Document Actions

frevvo can POST form or workflow data to your web server for processing. There are two options available Form Action Post and Doc Action Post. The difference between the two is that the Form Action POST displays the response from the web server to the user whereas the Doc Action POST does not.

Processing form data POSTed to your web server is described in the Submissions Stored Outside of frevvo.

HTTP Wait-Notify

HTTP Wait-Notify is a step, configured with a post url, that can be added to a workflow. The workflow data is posted to this url when the task is executed. A call-back url is included in the post. The workflow and task are suspended until the receiver posts back.

Document URIs

For each Document Type that you add to your form, frevvo permits you to assign

  • a document URI Template resolved either using query parameters or form fields.
  • a Read method and
  • a Write method.

This is best described using several examples. Consider the example above. Here are the interactions a Customer Resource supports:

Customer ListGETList of customers (may be criteria-based)XML list of customers
Customer ListPOSTCreate new customerURI of newly created customer
CustomerGETGet customer dataXML representation of customer
CustomerPUTUpdate customer
CustomerDELETERemove customer

Updating a document

Consider the case where a form is used to update a particular customer. To create the form: 

  1. Upload your customer schema to the designer, add the customer element to the document types for the form and add the customer to the form (which automatically generates controls). See the section on Adding Controls from Schema for further details.
  2. Drag/drop, change labels etc. directly in the browser
  3. Specify URI template .../customers/{customer}, choose Read Method GET and Write Method PUT
  4. Specify a Form Action URI if desired (we'll get to this later).

That's it. As usual, you access the form using its URl. When the form is used (instantiated), you may specify one or more query parameters along with the URI. For this example, we might use a URI and query parameter: .../form/1234?customer=02. frevvo will resolve the URI template above to: .../customers/02, GET the customer, and display the initialized form. When the form is submitted, frevvo will automatically PUT the customer document to the same URI thereby updating the customer. The diagram below shows the interactions.

Creating a new document

Consider the case where a form is used to create a new customer. Follow the same steps above, except use the appropriate URI template .../customers and change the Read method to POST. That's it. As usual, you access the form using its URl . When the form is used (instantiated), frevvo will perform the POST and create the customer. It will then follow the server redirect (to the URI of the new customer) and display the form. When the user enters customer information and submits the form, frevvo will automatically PUT the resulting XML document to the URI of the newly created customer resource thereby updating it. The diagram below shows the interactions:

Dynamic documents

A document URI template can also be linked to a form control. To do this, use the Control Name. Consider the Updating a document example above.

The form has a Customer document and we have specified URI template .../customers/{customer} and Read method GET. In this form, there is a control that has Type ID 'customer' as shown in the figure below.

If you enter a value in this control, frevvo will automatically resolve the URI template using the new value and attempt to GET a new document. If it succeeds, the form will be initialized with the new document and all relevant control values will automatically update. In the example above, try changing the value to 03 or 04. Notice how the customer information fields change to reflect the new document that is being edited by the form.

If you enter an ID that does not exist, the GET will fail (return an empty document or a 404 HTTP status code). In this case, frevvo will automatically revert back to the default document with default values as specified by the designer.

In either case, if you modify/fill in fields and submit the form, it will PUT (since we chose PUT as the Write Method, the form will send an HTTP PUT) the resulting XML document to the resolved URI.

For example, if you enter ID 03, frevvo will GET .../customers/03, display the form with fields initialized from the returned XML document and PUT the modified XML document to the same URI when the form is submitted. This PUT will update the customer with ID 03.

If you enter ID 99 (which does not exist), frevvo will GET .../customers/99, which returns an empty document. The form will be displayed with default values (as entered originally by the designer). When submitted, the resulting XML document will be PUT to .../customers/99. This PUT will create a new customer with ID 99 (the behavior depends on the implementation on the server - in our example, the PUT creates the customer).


The frevvo database connector is a working example of a restful service. You can Download the database connector which comes with source code. Refer to the db connector tutorial to see how this restful service is used.

Initializing Forms with XML Documents

Forms and workflows can be initialized by an XML document. This is most commonly done when the form is created from an XSD data source but can also be used with forms created from frevvo's palette controls. The most common method is to connect the XML document to the form via the form's doc action and manually set document URls wizard.

XML document from Doc URI

The form designer ensures the XML document used to initialize the form is valid for the XSD schema used to create the form. If the XML document is invalid your form will fail to initialize and will display the message

"At least one document URI used to initialize the form is invalid. Please check the document at the URI and check it against any schema. Unexpected namespace http://localhost/ddform.xml: was expecting"

One example of an invalid XML document is when the XSD contains a repeating element. If minOccurs=3 and the XML document contains only 2 elements then the document is invalid and your form will display the standard error message.

The XML document must also use UTF-8 format encoding.

 Click here for an example showing how to initialize a form with the Submission XML and the Doc URI wizard

One way to initialize a form using the xml from a submission is to use the form URL shown in the Documents tab in conjunction with the document URls wizard. For example, let's say you want to display the form with data from an old submission to your users so they can edit it and create a new submission if needed. Follow these steps to populate a blank form with data from a previous submission.

  1. Open the submission that you want to use to populate the form.
  2. Click on the Documents tab.
  3. Copy the form link at the top of the xml. This link may show as the name of your document if the form was created from schema.

  4. Change the //host:port of the URI to frevvo://

    form URL from the Documents tab

  5. Replace /<host:port> with frevvo:// in the URI.


  6. Copy the modified link to the Manually Set Doc URIs wizard. Remember to set the method to GET.

  7.  Save the changes and test your form.

Date/Time Controls

Here is an example of XML code that can be used to initialize a form with Date, Time and Date/Time controls. The Date and Time data are not affected by the time zone. The Date/Time control is time zone dependent, and will behave differently depending on how the time zone is provided:

  • If the time zone is provided in the Date/Time value of the XML document, the value will be converted to the timezone of the browser and displayed in the form accordingly. The time for the Date/Time control is proceeded by a capital "T" (Time Zone) and followed by a "Z" (UTC timezone). 
  • If the time zone is provided in the URL using the _formTz parameter, the Date/Time value will be converted to and displayed in the time zone specified in the parameter. This will also override the browser time zone.
  • If the time zone is not provided using either method, you will see a parsing error such as "Severe: Unable to Initialize form." This applies to Date/Time controls only.

Successful initialization cannot be guaranteed if the time zone for a Date/Time control is not provided (either in the XML document or in the _formTz URL Parameter). This does not apply if your form only has Date and/or Time controls.

<?xml version="1.0" encoding="UTF-8"?>
 <p0:default_format xmlns:p0="">

For example, the XML document shown below provides initialization data for the Product Order form via a Doc URI set up by the form designer. 

<p0:form xmlns:p0="" name="CopyofProductOrderForm">
  <Message14>&lt;center&gt;Best Company&lt;br/&gt;Product Order Form&lt;/center&gt;</Message14>

Browsing the Product Order Share ULR without the &_formTz=<tz> will display the form with the date and time controls initialized with the exact value passed in the XML. The Date/Time control also has the exact value (in UTC) but displays the Date/Time in the user's browser time zone. Here we are viewing the form in EDT (UTC-4).

Date/Time data in a form is always converted from the browser's timezone to a valid UTC format when posted in the form XML document in the submissions database. You may see the time in UTC format with a trailing "Z" (UTC) time or the time value plus or minus the UTC offset. Refer to Viewing XML Documents for more information on the Submissions Database and the XML document. 

Single digits for month and day in a rule or an xml document used to initialize a form will work only for the Date control. The Date/Time control requires a valid xml for successful initialization. See Rules Examples for more information. 

XML document from Post payload

In addition to chaining multiple forms with common data sources from XSD together via the Form Action Post as described above, it is also possible to write a servlet or other web code that does a Post request with a form Url to the frevvo Form Server. This request can also be coded to contain an XML document. If the XML document conforms to and is in the same namespace as one of the form's documents (either from-scratch palette controls or from XSD schema datasource), then the Form Server will use that XML document to initialize the form's fields.