Testing your form

Last updated on November 22, 2024

You'll want to make sure your form is thoroughly tested before releasing it to the public.

On this page:

The 3 types of testing

Testing your form can be described in 3 categories:

The tools and steps are different in each type of testing.

Testing your form while you build it

As you build your form, you'll want to check out how it's looking and working. You can test your form and most interactions within the form editor.

To test your form in the editor:

  • Click the "Test" button in the button bar

The Form Preview window will open with a representation of your form. Under your form display is a section called "Console". This is where any errors detected with your various formulas or calcuations are identified.

CMS Lite not available?

If you click the Test button and see a message about CMS Lite being unavailable, it's not actually CMS Lite that's not working. It means that there's a logic error in your form that Orbeon can't resolve to figure out how to display your form.

Look for circular logic in your form. An example is when "Control-01" is a calculation that includes the value of "Control-02", but that value depends on the value of "Control-01".

To make it easier to discover these kinds of errors in your form, test your form frequently, such as whenever you complete some complex formula work or a section.

In this preview you can test things like:

Click the "Test PDF" button to see what your PDF will look like. (You can also access the PDF test directly using the arrow button on the right of the "Test" button.)

There are a few things to note about the Form Preview:

  • It currently uses a different set of styles than CMS Lite, so:
    • It's not an accurate representation of final appearance
    • Required fields are marked with a red star
    • The word "optional" appears after every label, even if it's not
  • You can't test things that need the Form Runner server such as:
    • Emails
    • Messages
    • Submission to an API

You can test final appearance and server functions through CMS Lite when preparing for acceptance testing with your client.

Try an "offline" test

Since some functions aren't available to unpublished forms, Orbeon added the ability to test forms fully from within the builder. This is still in the beta stage and has some limitations, but feel free to give it a try.

For additional information see:

Testing your form with the client

In order for the client business or program area to review and test the form, it will need to be available to them in CMS Lite.

To learn how to do this, see:

The purpose of this testing is for the client to confirm that business and technical requirements have been met and to approve its release to the public.

What needs to be tested, how carefully, and by how many people will depend on the type of form and whether it's new or a revision.

Generally, your clients will need to carefully check:

  • The text of all labels, hints, help, instructions and other body text.
  • All possible variations of a form's flow and interactivity through visibility
  • The data presented in any testing fields
  • The results of any calculations or combinations
  • The subject, body and attachments of all emails sent
  • The content of the success message, if custom
  • The content and presentation of the PDF and XML files

Feel free to the use the above list as a starting point for creating a checklist for client testing and reviews.

Once the client has confirmed that the form looks and works the way it should, you can:

Testing your form with users

Employees can test in QA

The website's QA environment is available to anyone with an IDIR. If you want to conduct a test with government employees outside the client business unit, you can provide them a link to the form in QA.

Private individuals and employees using BCeID only can only test a form that has been released.

Use caution when releasing a form for testing, especially if it's a revision of an existing form.

You may want to conduct user testing when:

  • Your form is completely new, not just an online version of a pre-existing form
  • Is a considerable departure in style or content from a previous form
  • To validate the design as part of a service design project

In these contexts, a user can be:

  • Government employees not familiar with your form or program
  • Selected members of the intended audience
  • Members of the general public who may or may not be familiar with the form or program

Don't forget a test script for users

Forms can be long, complex, and ask for personal information that someone testing your form may be uncomfortable providing.

Consider creating one or more test scripts that provide things like:

  • Sample data they can transcribe or paste into the form
  • Instructions on which options to select
  • A walkthrough of the particular "path" you want them to take
  • What results or interactions they should see at different points

If your form is especially complex with different completion flows, you can create different "identities" and flows for each user performing testing to help lower the effort on their part.

You can also choose to perform user testing:

  • Formally or informally
  • Before or after release to the public

Example approaches you can take include:

  • Provide internal government users with a link to the QA version of the form in CMS Lite
  • Release the form to the public without announcing or linking to it and inviting members of the intended audience or general public to test the form (known as a "soft launch")
  • Release the form to the public normally and provide opportunities for gathering feedback by:
    • Monitoring incoming questions related to the form or process
    • Watching for data errors that could suggest a question or options aren't clear
    • Inviting people to provide feedback in the form itself or through a separate one
    • Arranging one or more post-release surveys

For more information, guidance and support conducting tests, research and surveys, see the following web pages: