Web Forms

From LongJump Support Wiki
Revision as of 00:18, 16 September 2011 by imported>Aeric (→‎Add a Web Form)

Designer > Presentation > Web Forms

A Web Form is a collection of fields a user can fill in on another site, after which data is sent to the platform. You can use a Web Form on your corporate website, your intranet, or even a blog. Use it to plug visitor data directly into a platform application.

How Web Forms Work

A Web Form is part of an Object. You generate a Web Form, put it on your site, and when the user enters data, a record is created in that Object. (No database code needed!) An auto-response and/or an email can be delivered to let the user know that the data was received. From there, your Data Policies can take over to initiate additional processing. (For example, send an Order to the fulfillment center.)

Error Handling

In your Web Form, you identify fields that are required. If any information is missing when the user clicks Submit, the error is handled in the form: A message is displayed, and the fields that are missing values are highlighted. Nothing goes to the platform server until all required information is present.

Other errors can occur during "backend" processing on the server:

  • A validation error could occur, for example, if a zip code is greater than 99999.
  • A Data Policy could throw an exception (accompanied by a message) if an order contains an entry for fireworks in a state where such sales are illegal.

By default, such messages are delivered to the user in a plain page that contains the error message(s), accompanied by a [Return] button that takes them back to the form.

Successful Submission

After successfully submitting data, the user goes to either a page you specify, or to a plain page that acknowledges receipt of the data. (From there, the [Return] button goes back to the original data entry form--so specifying a destination page of your own is almost always a good idea.)

Types of Web Forms

There are two types of web forms you can generate:

  • Script - A script is created that runs on the platform. You add a link to your web page to access it as a generic page, or add a line of Javascript to invoke the script inside your page. The platform does all of the processing and error handling. This is the easiest kind of Web Form to use.
  • HTML - A complete form is generated in HTML code. You can copy that code into a page on your site and use the default processing, or you can modify it in a variety ways. For example, you can:
  • Take control of the CSS styling.
  • Change the layout (for example, to create two columns of field)
  • Change the label of the Submit button. (The default text is "Send Request".)
  • Take control of the error handling.

Notepad.png

Note: Error handling requires an experienced web designer. To make it work, you get the error page back as data, parse the page to identify the error(s), and then manage the way in which those errors are displayed. It's unlikely that you'll want to go that far, but the capacity is there, if you need it.

Working with Web Forms

Lock-tiny.gif

Users that have the Customize Objects permission can manage Web Forms. 
Generated Web Form

In the Web Form, you specify the input fields you want to embed in an HTML page. You put the resulting form into the page, and that page is dynamically linked to your application.

Fields in the Web Form are automatically validated according to the rules defined by the application, and you can generate an auto-response to the person submitting the form, or redirect them to a specific URL. You can also notify designated members of your team that someone has submitted the web form.

Follow the steps in the Web Form wizard to design and preview the form layout and begin collecting information.

Considerations
  • Web Forms can be created for Custom Objects only.
  • To create a Web Form, the object must be specified as Web-enabled in the Object Properties.
  • Web Forms can be disabled in the Object Properties by turning off Web-enabled
  • Lookup fields cannot be selected for use in a Web Form
  • In Prospect objects, you can use Assignment Policies to assign record ownership, send trigger email notifications, and generate an auto-response.

Best Practices

Here are some pointers to making web forms work for your business.

  • Make sure you have a landing page for people to go to after they fill out the form, since in most cases it is their only confirmation that the submission was a success
  • When someone fills in a form, you can automatically email a thank you to them if you include a field of type Email
  • Likewise, you can alert a member of your team that someone has filled in the form with a notification - this is great for inquiries that need more interaction
  • If you want to fully customize the layout of the form, use HTML snippets instead of the one-line JavaScript as the final format - it gives you more control to layout the form as well as style controls
  • When using HTML snippets, you'll want to make sure you don't delete any INPUT tags marked HIDDEN or any embedded SCRIPT tags since these are what drive data into your application database
  • If you include an Email field in the form, the address can be used in email campaigns, allowing the user to register for newsletters, announcements, and product updates.

With a Web Form, you can collect information from your company web site that directly flows into the platform. The Web Form Wizard helps you generate a customized HTML/JSP (JavaServer Pages) that you can embed into your web site.

Web Form Wizard

The wizard walks you through the process to create a web form.

Add a Web Form

To launch the web form wizard:

  • Click Designer > Data > Objects > {object} > Web Forms.
  • Click the [New Web Form] button, or open an existing web form. The web form wizard opens.
Steps in the Wizard Instructions
1. Select Fields
  • Select the field(s) you want to include in the web form from the Fields list.
  • Click [Next]
Note: When you select a File Field or an Image Field, the form automatically includes a file-chooser dialog that lets the user browse for the file to include. ('Learn more: Field Display Types)
2. Mark Required Fields
  • Click the Required check box next for values the user must supply when filling out the form. (Fields that are identified as "Required" in the Default Layout, or marked "Always Required" in the Field definition are pre-selected automatically.)
  • Click [Next].
3. Notifications
  • In the Record Owner Information section, select the record owner from the Lookup field.
  • Optionally, click the check box to Send Email Notification to record owner when the web form is received.
  • Optionally, select additional user(s) to receive the email notification.
  • In the Email Notification Details section, enter the text you want to appear as the Subject of the email. Enter the text you want to appear as the email message in the Description fields. You can customize the message content, and include Template Variables. Use the Template Variable Tool to get the names of variables you can use in the template:
TemplateVariableTool.jpg
  • Click [Next].
4. Auto Response If an email address field was included in the web form, it is a good practice to create an auto response to acknowledge receipt of the web form information.
  • Complete the following information:
Email Field (To)
Choose from None or Email
  • If None, no auto response message is sent
  • If Email, the Subject and Description fields are required
Subject
Description for the auto response email message
Editor Type (Plain Text or HTML Editor)
If you select HTML Editor, the HTML formatting tools become available.
Description
Enter the body of the message, and optionally include Template Variables.
  • Click Next.
5. Save and Generate
  • Enter the Title of this Web Form.
    (Only used in the platform. In the list of Web Forms for this Object, it appears in the Name column.)
  • Choose Type: Script or HTML.
Script
Hosts the Web Form on the platform. Generates a script and a link to access it.
  • Either the script or the link can be embedded into a web page on your site.
  • When you use the link, you can pre-fill values for selected fields in the Web Form by appending them as parameters: &field1=value&field2=value....
  • Special characters (characters other than alphanumerics) need to be encoded.
    For example, to include "&" in a value use %26. To include a space use %20.
    So for company "A & B" specify company_name=A%20%26%20B.
  • Learn more: Specifying Parameters in a URL
  • The button label is "Send Request"
HTML
Generates HTML code that can be embedded into a web page on your site.
  • You can then modify the layout, or change the label on the button the user clicks to submit the form.
  • Specify the URL of the page the user goes to after successfully submitting the form.
  • Required for HTML forms
  • For scripts, the user is directed to a plain "Thank You" page by default.)
  • Click the [Save and Generate] button.
    The form (or the script and link) appears, along with a Preview.

Copy and Paste

  • If the Web Form you generated was of type HTML, copy the generated code and paste it into your web page.
  • If the selected type was Script, you can copy the code, or you can copy the generated link and paste that into your web page. (The link accesses the code, which is stored on the platform.)
  • When using a link, pre-filled values are embedded in the query-string of the URL. Those variables can be modified dynamically at your site, allowing you to pre-fill different values in different circumstances.