Creating a Custom Form

Last Updated: 29 Aug 2017

The following example will create a Contact Us Custom Form page on our web site. This form will contain a security CAPTCHA field and will automatically send an email to both the user who completed the form and the site administrator.

Bookmarks

Setting Up the Custom Form

The Personal Information Section
The Personal Information Section

  1. Add a Custom Form under your Site, titled Contact Us.
  2. Right click on the Custom Form's Form Contents asset in the Asset Map and select the Form Contents screen.
  3. On the Form Contents screen, create a new section on the form, titled Personal Information.

    To do this, enter Personal Information in the Add Sections field and click Commit. A new Section asset will appear in the Asset Map, as shown in the figure above.

Adding the Form Questions

The Question Assets
The Question assets

  1. Right click on the Personal Information Section asset in the Asset Map and select the Details screen.
  2. Add three Text type questions.

    To do this, in the Add Questions field, select the Text question type in the first list,in the second list and click Commit. Three question assets will appear in the Asset Map and be added to the Current Questions list, as shown in the figures to the right and below.

    Questions added to the Current Questions List
    The Questions added to the Current Questions list

  3. Add a Select type question.

    To do this, in the Add Questions field, select the Select question type in the first list, 1 in the second list and click Commit. A fourth Question asset will appear in the Asset Map and be added to the Current Questions list.
  4. Repeat these steps to add three more questions: two Numeric type questions and one Email Address type question.

    Once you have done this, seven Question assets will appear in the Asset Map and be listed in the Current Questions list, as shown in the figure below.

    The Current Questions List listing the form Questions
    The Questions for the form in the Current Questions list

    The Unattached Question asset
    The Unattached Question asset

  5. Add another question to the form, outside of the Personal Information section.

    To do this:

    i) Right click on the Form Contents asset in the Asset Map and select the Form Contents screen.

    ii) In the Add Questions field, select Text in the first list, in the second list and click Commit. A Question asset will appear in the Asset Map and be added to the Current Questions section, as shown in the figures to the right and below.

    The Unattached Question in the Current Questions ListThe Unattached Question in the Current Questions list

Setting Up Each Question

First Name Question

To set up the First Name question:

  1. Right click on the Question 1 (text type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter First Name.
  3. In the Maximum Length field, enter 50. This will mean that users will only be able to enter up to fifty characters in this field.
  4. In the Required Entry field, select Required. This will mean that users will be required to answer this question on the form.
  5. In the Custom Required Error field, enter Please enter your first name. This will be displayed on the form if the user does not answer this question.
  6. Click Commit. The name of the asset in the Asset Map will change to First Name.

Surname Question

To set up the Surname question:

  1. Right click on the Question 2 (text type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter Surname.
  3. In the Maximum Length field, enter 50. This will mean that users will only be able to enter up to fifty characters in this field.
  4. In the Required Entry field, select Required. This will mean that users will be required to answer this question on the form.
  5. In the Custom Required Error field, enter Please enter your surname. This will be displayed on the form if the user does not answer this question.
  6. Click Commit. The name of the asset in the Asset Map will change to Surname.

Address Question

To set up the Address question:

  1. Right click on the Question 3 (text type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter Address.
  3. In the Height field, enter 3. This will display a multi-line text field on the form for this question.
  4. Click Commit. The name of the asset in the Asset Map will change to Address.

State Question

The Options field for the State question
The Options field

To set up the State question:

  1. Right click on the Question 4 (select type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter State.
  3. In the Options field, enter the following options into the fields provided: QLD, NSW, ACT, VIC, TAS, NT, SA and WA.
  4. Click Commit. The name of the asset in the Asset Map will change to State.

Postcode Question

To set up the Postcode question:

  1. Right click on the Question 5 (numeric type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter Postcode.
  3. In the Width field, enter 4. This will mean that the question field will be four characters wide.
  4. In the Maximum Length field, enter 4. This will mean that users will only be able to enter up to four characters in this field.
  5. Click Commit. The name of the asset in the Asset Map will change to Postcode.

Email Address Question

To set up the Email Address question:

  1. Right click on the Question 6 (email address type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter Email Address.
  3. In the Required Entry field, select Required. This will mean that users will be required to answer this question on the form.
  4. In the Custom Required Error field, enter Please enter your email address. This will be displayed on the form if the user does not answer this question.
  5. Click Commit. The name of the asset in the Asset Map will change to Email Address.

Phone Number Question

To set up the Phone Number question:

  1. Right click on the Question 7 (numeric type) asset under the Personal Information section in the Asset Map and select the Details screen.
  2. In the Title field, enter Phone Number.
  3. In the Width field, enter 10. This will mean that the question field will be ten characters wide.
  4. In the Maximum Length field, enter 10. This will mean that users will only be able to enter up to ten characters in this field.
  5. Click Commit. The name of the asset in the Asset Map will change to Phone Number.

Comments Question

To set up the Comments question:

  1. Right click on the Question 1 (text type) asset under the Form Contents asset in the Asset Map and select the Details screen.
  2. In the Title field, enter Comments.
  3. In the Height field, enter 3. This will display a multi-line text field on the form for this question.
  4. Click Commit. The name of the asset in the Asset Map will change to Comments.

Defining the Layout of the Custom Form

Page Contents Layout

The default layout of the Contact Us form is shown in the figure below.

The default layout of the Custom Form
The default layout of the Contact Us form

The Comments question in this layout appears at the top of the form and there is no heading for the page. We need to change this layout to move the Comments question to the bottom of the page and add a heading, as well as include additional features.

The Page Contents Bodycopy
The Page Contents Bodycopy

To change this layout:

  1. Add the Page Contents Bodycopy. To do this:

    i) Right click on the Form Contents asset and select the Form Contents screen.

    ii) In the Use Bodycopy field, select Page Contents and click Commit. A Bodycopies Folder will appear in the Asset Map, containing the Page Contents Bodycopy, as shown in the figure to the right.
  2. Right click on the Page Contents Bodycopy and select Edit Contents.
  3. Enter the following content into the WYSIWYG Editor.

    The WYSIWYG Editor on the Page Contents Bodycopy
    The WYSIWYG Editor on the Page Contents Bodycopy

    The List of Submission errors keyword replacement is added to the top of the form so that errors will be displayed when the form is not completed correctly. The Submit Button is also added so that the user can submit the form.

    The new layout of the Contact Us is shown in the figure below.

    The new layout of the Custom Form
    The new layout of the Contact Us form

Thank You Layout

The default layout of the Thank You page on the Contact Us form is shown in the figure below. This layout is shown when the user submits the form.

The default layout of the Thank You page
The default layout of the Thank You page

The Comments response in this layout appears at the top of the form and there is no heading for the page. We need to change this layout to move the Comments question to the bottom of the page and add a heading, as well as include additional features.

The Thank You Bodycopy
The Thank You Bodycopy

To change this layout:

  1. Add the Thank You Bodycopy. To do this:

    i) Right click on the Form Contents asset and select the Form Contents screen.

    ii) In the Use Bodycopy field, select Thank You and click Commit. The Thank You Bodycopy will be added to the Bodycopies Folder, as shown in the figure to the right.
  2. Right click on the Thank You Bodycopy and select Edit Contents.
  3. The content shown in the figure below is entered into the WYSIWYG Editor.

    The WYSIWYG Editor on the Thank You Bodycopy
    The WYSIWYG Editor on the Thank You Bodycopy

    The new thank you layout of the Contact Us is shown in the figure below.

    The new layout of the Thank You page
    The new layout of the Thank You page

Adding the CAPTCHA Fields

To add the CAPTCHA field to the Contact Us form:

  1. Right click on the Form Contents asset in the Asset Map and select the Form Contents screen.
  2. In the Require CAPTCHA field, select Yes.
  3. In the CAPTCHA Key Length field, enter 6. This will mean that the CAPTCHA image will display six characters.
  4. In the CAPTCHA Character Zoom field, enter 3. This will mean that the CAPTCHA characters will be randomly zoomed between sizes 1 and 3.
  5. Click Commit.
  6. Add the CAPTCHA keyword replacement on the Page Contents Bodycopy, as shown in the figure below.

    The CAPTCHA keyword Replacement added to the Page Contents Bodycopy
    The CAPTCHA keyword replacement

    The CAPTCHA field will now appear on the Contact Us form.

    The CAPTCHA field on the Custom Form
    The CAPTCHA field on the Contact Us form

Setting Up the Emails

Recipient Email

The recipient email needs to be set up so that an email is sent to the site administrator.

To do this:

  1. Right click on the Form Contents asset in the Asset Map and select Email Options.
  2. Navigate to the Recipient Email Options section of the screen.
  3. In the To field, enter the email address of the site administrator, for example admin@squiz.com.au.
  4. In the From field, enter the 'from' email address. You can use the email address form question keyword replacement in this field (e.g. %response_100_q6%). This will use the email address that the user enters on the form.
  5. In the Subject field, enter a subject for the email, for example %response_100_q1% %response_100_q2% has contacted Squiz. In this example we are using the user's responses to the first name and surname questions in the subject of the recipient email.
  6. In the Body field, the content shown in the figure below is added to the HTML version of the email.

    The Body content of the Recipient email
    The Body content of the Recipient Email

The keyword replacements for each question can be found by clicking on the list of keywords available for use in emails hyperlink under the Keyword Replacements section on the screen.

Receipt Email

The receipt email needs to be set up so that an email is sent to the form user.

To do this:

  1. Right click on the Form Contents asset in the Asset Map and select Email Options.
  2. Navigate to the Receipt Email Options section of the screen.
  3. In the Receipt Recipient Question field, select the Email Address question. This will send an email to the address that the user enters on the form.
  4. In the From field, enter the 'from' email address, for example admin@squiz.com.au.
  5. In the Subject field, enter a subject for the email, for example Thank you for contacting Squiz.
  6. In the Body field, the content shown in the figure below is added to the HTML version of the email.

    The Body content of the Receipt email
    The Body content of the Receipt Email

The keyword replacements for each question can be found by clicking on the list of keywords available for use in emails hyperlink under the Keyword Replacements section on the screen.

Final Steps

Before making the Contact Us form Live to the public, check the following:

  • The layout of the page contents is correct
  • The required questions are validated and the error messages appear on the form
  • That you can fill out and submit the form
  • The layout of the thank you layout is correct
  • The recipient email is sent to the contact within the organisation
  • The receipt email is sent to the user who filled out the form
  • The submission is logged to the database.

Once you are sure the Custom Form is working correctly, change its Status to Live and grant Public Read Permission.

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.