Changes for page Embedded Forms - How to Create an Embedded Form

Last modified by Admin on 2023/08/14 16:54

From 6.1 to 7.1 From 19.1 to 20.1

From version 7.1

edited by melanie@one-count_com
on 2016/12/07 19:42

Change comment: There is no comment for this version

To version 19.1

edited by Admin
on 2020/01/23 14:14

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Forms - How to Create a Form (v12.x)
++Embedded Forms - How to Create an Embedded Form

Author

@@ -1,1 +1,1 @@
--XWiki.melanie@one-count_com
++XWiki.Admin

Content

@@ -1,17 +1,15 @@
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
--
--
--
  {{id name="Start ScreenSteps Content"/}}
-- The Forms tool allows you to create, edit, delete, and manage forms and questions. Creating a form is as simple as defining basic form information, setting the number of rows and columns in the form, dragging and dropping questions into defined layout, and setting optional vaidations for each question. When a user completes and submits a form, all of the demographic and transaction information from the form is saved in the ONEcount database.
++The Embedded Forms tool allows you to create, edit, delete, and manage forms that are embedded within a brand, or within an iframe on a web page that you host on your site. The Embedded Form Builder is NOT designed to be a full-featured, WYSIWYG form builder. For that functionality, please see the [[Form Builder>>doc:New Form Builder]].
--Please refer to the Quick Start Guide~-~- Questions and Forms for information on basic concepts and rules relating to forms.
++Creating an embedded form is as simple as defining basic form information, setting the number of rows and columns in the form, dragging and dropping questions into defined layout, and setting optional vaidations for each question. When a user completes and submits a form, all of the demographic and transaction information from the form is saved in the ONEcount database.
++Please refer to the [[Quick Start Guide~~-~~- Questions and Forms>>doc:Quick Start Guide - Questions and Forms]] for information on basic concepts and rules relating to forms.
++
  (% style="color: rgb(0,0,0);" %)When a user completes and submits a form, all of the information gathered from the form is entered into the ONEcount database. Plan forms carefully to ensure that you include questions and possible responses that will provide you with all the data you wish to collect from subscribers/purchasers.
  (% style="color: rgb(255,0,0);" %)**Questions are shared among ALL forms, so any changes made to question type, text, responses, alias, report header (See Question Builder - Create and Manage Questions for more detail) will change ALL forms, not just the form you are working on. Deleting a question will remove that question from ALL forms as well. **(%%)
@@ -19,23 +19,23 @@
  Form-related tasks include:
--* creating database fields/questions available for placement in online forms; (See Question Builder - Create and Manage Questions for more detail.)
++* creating database fields/questions available for placement in online forms; (See [[doc:Demographics - Create and Manage Demographic Fields in Your Database]] for more detail.)
  * creating new forms;
  * managing existing forms;
  * creating source codes that are used to track the source of a name/transaction;
  * and creating individually branded forms.
--The first task listed above – creating questions is accomplished using the Question Builder tool. The next two tasks – creating new forms and managing existing forms – are carried out using the Form Builder tool under INVENTORY. Creating source codes is handled under Source Codes and creating branded forms is handled under Brands. All of these tools are found under INVENTORY.
++The first task listed above – creating questions is accomplished using the Question Builder tool. The next two tasks – creating new forms and managing existing forms – are carried out using the Form Builder tool under INVENTORY. Creating source codes is handled under [[Source Codes>>doc:Source Codes - How to Create and Manage Source Codes]] and creating branded forms is handled under [[Brands>>doc:Brand - How to Create and Manage Brands]]. All of these tools are found under INVENTORY.
  Note that there are two methods you can use for a form to display in your brand's look and feel.
  (% style="text-decoration: underline;" %)**Method 1**(%%)
-- Use Brand tool in ONEcount. Using the Brand tool, you create a blank page in your CMS with only the header and footer for your brand, then create a code for that brand that will fetch that page when the form is called. The code you create using the Brand tool allows you to use that brand's look and feel for any form simply by appending &brand=[[CODE>>doc:CODE]] to the URL.
++Use Brand tool in ONEcount. Using the Brand tool, you create a blank page in your CMS with only the header and footer for your brand, then create a code for that brand that will fetch that page when the form is called. The code you create using the Brand tool allows you to use that brand's look and feel for any form simply by appending &brand=[[CODE>>doc:CODE]] to the URL.
  (% style="color: rgb(0,0,0);" %)You must include the following markers on the brand page you create in your CMS:
  (% style="color: rgb(37,81,115);" %)**<!-**(% style="color: rgb(37, 81, 115); text-decoration: line-through" %)**onecount_header**(% style="color: rgb(37,81,115);" %)**->**(%%) Place in the page where the header will END
-- (% style="color: rgb(37,81,115);" %)**<!-**(% style="color: rgb(37, 81, 115); text-decoration: line-through" %)**onecount_footer**(% style="color: rgb(37,81,115);" %)**->**(%%) Place in the page where the footer will START
++(% style="color: rgb(37,81,115);" %)** <!-**(% style="color: rgb(37, 81, 115); text-decoration: line-through" %)**onecount_footer**(% style="color: rgb(37,81,115);" %)**->**(%%) Place in the page where the footer will START
  If you require a separate header/footer page for mobile, you must also create that page.
@@ -42,22 +42,26 @@
  Because ONEcount uses SSL, there may be issues with non-SSL brand pages using this method, so you may choose to use method 2 described below. (See ONEcount SSL and non-SSL Client Brand Pages for more detail.)
  (% style="text-decoration: underline;" %)**Method 2**(%%)
-- Create a custom header and/or footer when creating a form.
++Create a custom header and/or footer when creating a form.
--=== OPENING THE "CREATE NEW" FORM WINDOW ===
++=== OPEN THE MANAGE FORMS WINDOW ===
--=== Select INVENTORY from the main menu. ===
++**Select INVENTORY from the main menu.**
  [[image:attach:media_1430428383541.png||align="center"]]
--=== Select "Forms" from the sub-menu. ===
++\\
++**Select "Forms" from the sub-menu.**
++
  [[image:attach:media_1430428408807.png||align="center"]]
  This will open the Manage Forms window where you can select to create a new form. (See below.)
--=== Click "Create Form". ===
++\\
++**Click "Create Form"**.
++
  [[image:attach:media_1430428555772.png||align="center"]]
  This will ope the "Form Builder - Part 1" window where you begin creation of your new form.
@@ -64,7 +64,7 @@
  === CREATE FORM PART 1 - INFORMATION ===
--=== Enter Form Information. (See items #1-6 below.) ===
++==== Enter Form Information. (See items #1-6 below.) ====
  [[image:attach:Screen Shot 2016-12-07 at 5.43.26 PM.png||width="666" align="center"]]
@@ -96,51 +96,59 @@
  (10)** ** Enter a **Subscription Header.  **A **Subscription Section Header  **allows you to create a custom header for the section of the form where your products/packages are displayed for selection, e.g. "Subscription Term", "Select Your Package" or any descriptive/instructional text.  You can add html here to style the text and/or background of the header.
--(11)  **Email Confirmation (Yes/No) **is where you select whether a confirmation email will be sent upon subscription to/registration for any products listed on the form..
++(11)  **Email Confirmation (Yes/No) **is where you select whether a confirmation email will be sent upon subscription to/registration for any products listed on the form.
--=== Front-End View Screenshots ===
++\\
--[[image:attach:media_1430763892412.png||align="center"]]
++(% style="text-align: center;" %)
++**Front-End View Screenshots**
--[[image:attach:media_1430764964000.png||align="center"]]
++[[image:attach:Form Top.png||width="666" align="center"]]
--[[image:attach:media_1430765247198.png||align="center"]]
++\\
++[[image:attach:Form Bottom.png||width="666" align="center"]]
++\\
++
  [[image:attach:media_1430765149355.png||align="center"]]
--=== Enter Acknowledgement Email Information. (See Items #7-10 below.) ===
++\\
++\\
++
++\\
++
++==== Enter Acknowledgement Email Information. (See Items #7-10 below.) ====
++
  [[image:attach:media_1430766909283.png||align="center"]]
  (% style="color: rgb(255,0,0);" %)This is where you can create customized acknowledgement emails specific to the form/product attached to the form. Creating these customized emails is optional, as default acknowledgement emails not specific to any form and/or product are configured in the Configuration Manager.
  (7) Enter the subject of the email in "New Thank You Email Subject" field.
-- (8) Enter the content of the email in "New Thank You Email" field.
++(8) Enter the content of the email in "New Thank You Email" field.
  Body markers that may be used in the text are as follows:
-- %%USERNAME%% – will replace the body marker %%USERNAME%% with the subscriber's username.
-- %%PASSWORD%% – will replace the body marker %%PASSWORD%% with the subscriber's password.
-- %%ONECOUNTID%% – will relace the body marker %%ONECOUNTID%% with the subscribers account number/ONEcount ID.
-- %%RECEIPTDISPLAY%% – will replace the body marker %%RECEIPTDISPLAY%% with a receipt for purchase amount, if any.
-- (9) Enter the subject of the email in the "Updae Thank You Email Subject" field.
-- (10) Enter the content of the email in the "Update Thank You Email" field.
++%%USERNAME%% – will replace the body marker %%USERNAME%% with the subscriber's username.
++%%PASSWORD%% – will replace the body marker %%PASSWORD%% with the subscriber's password.
++%%ONECOUNTID%% – will relace the body marker %%ONECOUNTID%% with the subscribers account number/ONEcount ID.
++%%RECEIPTDISPLAY%% – will replace the body marker %%RECEIPTDISPLAY%% with a receipt for purchase amount, if any.
++(9) Enter the subject of the email in the "Updae Thank You Email Subject" field.
++(10) Enter the content of the email in the "Update Thank You Email" field.
  As with Form Description text, Email content may be styled using the pop-up styling toolbar that appears when you click in the Form Description field, including images, special characters, and links.
--=== Click the red "Next" button when done with Form Information. ===
++**Click the red "Next" button when done with Form Information.**  This will open the "Build Form" window, as shown below.
--This will open the "Build Form" window, as shown below.
--
  === CREATE FORM PART 2 - BUILD FORM ===
  [[image:attach:media_1430938547197.png||align="center"]]
  (1) **Rows** and **Columns.** Determine the number of rows and how many columns in each of those rows. The number of columns may be set on a row-by-row basis, i.e. the number of columns does not necessarily have to be the same for each row, and rows may be added at any time during form construction.
-- (2) Drag **Questions** into the **workspace (3).** You can quickly find questions by searching by name or question ID #.
++(2) Drag **Questions** into the **workspace (3).** You can quickly find questions by searching by name or question ID #.
  (4) Set **Question Options** and validations for each question.
  More detail on each of the above steps is provided below.
--=== Set the number of rows and columns. ===
++==== Set the number of rows and columns. ====
  [[image:attach:media_1430938787682.png||align="center"]]
@@ -148,46 +148,45 @@
  As stated in the previous step, the number of rows and columns can be set on a row-by-row basis and can be done at any time during form construction.
--=== Drag and Drop Questions into Workspace. ===
++==== Drag and Drop Questions into Workspace. ====
  [[image:attach:media_1430938961950.png||align="center"]]
  First Name, Last Name, Email, Address1, Address2, City, and State have been dragged and dropped into the form.
  Once a question is placed in a form, it is removed from the list of questions.
-- Notice that the "Zip/Postal Code:" question was found by doing a quick search for "zip". This question can now be dragged and dropped into column 3 of row 6, as shown below.
-- To return to the full list questions not yet placed on the form, delete "zip" from the search box.
++Notice that the "Zip/Postal Code:" question was found by doing a quick search for "zip". This question can now be dragged and dropped into column 3 of row 6, as shown below.
++To return to the full list questions not yet placed on the form, delete "zip" from the search box.
  Note that you can create a new question here by clicking on **+Create New Question**. This will bring up a pop-up where you can create a question on the fly.
-- You can also edit questions here, but be careful! (% style="color: rgb(255,0,0);" %)**Any changes made to the Question Text, Response Type, Question Alias, Question Tage, and Lookup Question are universal and will change ALL forms in the system, not just the form you are working on.**
++You can also edit questions here, but be careful! (% style="color: rgb(255,0,0);" %)**Any changes made to the Question Text, Response Type, Question Alias, Question Tage, and Lookup Question are universal and will change ALL forms in the system, not just the form you are working on.**
  [[image:attach:media_1430939101634.png||align="center"]]
  Once all questions are placed on the form, set Question Options. Alternatively, question options may be completed as each question is placed on the form.
-- To set options, simply click on the question and select options.
++To set options, simply click on the question and select options.
--=== Set Question Options ===
++==== Set Question Options ====
  [[image:attach:media_1430939154859.png||align="center"]]
  Available **Question Options** are:
-- **Auto Populate:** (% style="color: rgb(0,0,0);" %)This check box allows you to tell the form what fields to pre-populate from information already in the database when a user clicks a link to a form. If audited, per audit rules, you cannot pre-populate certain demographics, even if the information is in your database. Auto Populate works in conjunction with the "&renewal=true" string in form linkouts. (Find more about form linkouts in the Quick Start Guide-Questions and Forms or Links section of How to Mange Forms.) When the Auto Populate box is checked and the form linkout has "&renewal=true" appended to the end, the only information that will be pre-populated on the form is the information for the questions that have the Auto Populate box checked. If "&renewal=true" is not appended to the link to the form, then all questions on the form that have responses in the ONEcount database will be pre-populated, even if the Auto Populate box is not checked. If audited, use this feature carefully to be sure you are following audit bureau reporting rules on what fields can be pre-populated in a renewal (or any) form.
++**Auto Populate:** (% style="color: rgb(0,0,0);" %)This check box allows you to tell the form what fields to pre-populate from information already in the database when a user clicks a link to a form. If audited, per audit rules, you cannot pre-populate certain demographics, even if the information is in your database. Auto Populate works in conjunction with the "&renewal=true" string in form linkouts. (Find more about form linkouts in the Quick Start Guide-Questions and Forms or Links section of How to Mange Forms.) When the Auto Populate box is checked and the form linkout has "&renewal=true" appended to the end, the only information that will be pre-populated on the form is the information for the questions that have the Auto Populate box checked. If "&renewal=true" is not appended to the link to the form, then all questions on the form that have responses in the ONEcount database will be pre-populated, even if the Auto Populate box is not checked. If audited, use this feature carefully to be sure you are following audit bureau reporting rules on what fields can be pre-populated in a renewal (or any) form.
  (% style="text-decoration: underline; color: rgb(0, 0, 0)" %)**Validations**(% style="color: rgb(0,0,0);" %)**:~*~***(%%)
-- (% style="color: rgb(0,0,0);" %)**Required **– Do you want this to be a required (not optional) question on the form. All required questions will be identified by a(% style="color: rgb(164,10,10);" %) ~*~** (% style="color: rgb(0,0,0);" %)on the form. If a user doesn't complete a required question, he/she will be prompted to do so.(%%)
-- (% style="color: rgb(0,0,0);" %)**Email **– Requires that the information entered on the form be in email format, i.e. c.lechien@dogmail.com. It does not validate whether the email is a real email or not, only that it is in the correct email format.(%%)
-- (% style="color: rgb(0,0,0);" %)**Number Only **– Only numbers can be entered, i.e. for a numbers-only code.(%%)
-- (% style="color: rgb(0,0,0);" %)**Text Only **– Only text can be entered, i.e. for a text-only code.(%%)
-- (% style="color: rgb(0,0,0);" %)**Number and Text** – Numbers and text can be entered.(%%)
-- (% style="color: rgb(0,0,0);" %)**Match Email** – For an email field, this will add a "Confirm Email" entry on the form.
++(% style="color: rgb(0,0,0);" %)**Required **– Do you want this to be a required (not optional) question on the form. All required questions will be identified by a(% style="color: rgb(164,10,10);" %) ~*~** (% style="color: rgb(0,0,0);" %)on the form. If a user doesn't complete a required question, he/she will be prompted to do so.(%%)
++(% style="color: rgb(0,0,0);" %)**Email **– Requires that the information entered on the form be in email format, i.e. c.lechien@dogmail.com. It does not validate whether the email is a real email or not, only that it is in the correct email format. Validation looks to match following REGEX :  /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i (%%)
++(% style="color: rgb(0,0,0);" %)**Number Only **– Only numbers can be entered, i.e. for a numbers-only code.(%%)
++(% style="color: rgb(0,0,0);" %)**Text Only **– Only text can be entered, i.e. for a text-only code.(%%)
++(% style="color: rgb(0,0,0);" %)**Number and Text** – Numbers and text can be entered.(%%)
++(% style="color: rgb(0,0,0);" %)**Match Email** – For an email field, this will add a "Confirm Email" entry on the form.
  (% style="color: rgb(0,0,0);" %)~*~* Note that for checkbox- and radio button-type questions, an extra option to set the number of columns for responses appears. For example, if you have a checkbox-type question with 9 possible responses, you can set those checkbox responses to appear within two columns rather than one long list. (See second screenshot below for a front-end view.)
  (% style="color: rgb(0,0,0);" %)You can add multiple validations to a question, e.g. for an Email question you can set validations to required, email, and match email.(%%)
-- (% style="color: rgb(0,0,0);" %)To remove a validation, place the cursor to the right of the validation and press your "backspace" or "delete" key.
++(% style="color: rgb(0,0,0);" %)To remove a validation, place the cursor to the right of the validation and press your "backspace" or "delete" key.
  (% style="color: rgb(255,0,0);" %)**Options and validations will NOT universally change forms – these changes will be applied only to the form you are working on.**(%%)
--
--(% style="color: rgb(0,0,0);" %)In the example below, the Email question has been set to Auto Populate with multiple validations (Email, Match Email, Required).
++\\(% style="color: rgb(0,0,0);" %)In the example below, the Email question has been set to Auto Populate with multiple validations (Email, Match Email, Required).
  [[image:attach:media_1430939226453.png||align="center"]]
@@ -195,7 +195,7 @@
  Checkbox-type question set for responses to appear in two columns.
--=== Move and/or Remove Questions ===
++==== Move and/or Remove Questions ====
  [[image:attach:media_1430939299804.png||align="center"]]
@@ -202,14 +202,14 @@
  To remove a question from a form, click the "x" icon above the question name. This will remove the question, but not the row.
  To move a question to a different location on the form, click the checkered gray area at the left of the row, drag, and drop.
--=== Delete a Row ===
++==== Delete a Row ====
  [[image:attach:media_1430939444248.png||align="center"]]
  To delete a row, click the trash can icon at the far right of the row.
-- **Note: You must remove the question(s) before deleting a row.** If you try to delete a row with a question(s), you'll get a pop-up message asking you to "Please remove questions to remove the row."
++**Note: You must remove the question(s) before deleting a row.** If you try to delete a row with a question(s), you'll get a pop-up message asking you to "Please remove questions to remove the row."
--=== Once all questions have been placed on the form and options and validations set, click the red "Next" button to move on to Part 3 - Review and Save. ===
++**Once all questions have been placed on the form and options and validations set, click the red "Next" button to move on to Part 3 - Review and Save.**
  If you wish to go back to Part 1 - Information, click on the red "Back" button. Your work on Part 2 will not be lost, and you can return to it from Part 1 by clicking on "Next". Just be sure to go to Part 3 and save the form before exiting.
@@ -223,23 +223,27 @@
  [[image:attach:media_1431545519730.png||align="center"]]
  The Review and Save window provides a basic preview of the form and allows you to adjust question response field lengths.
-- To see a full preview of the form in your site's look and feel, click "Save" and
++To see a full preview of the form in your site's look and feel, click "Save".
--=== Below is an example of what a form might look like on your web site. ===
++\\
++(% style="text-align: center;" %)
++**Example of what a form might look like on your web site.**
++
  [[image:attach:media_1431550698440.png||align="center"]]
  **1 ~-~-** Form Name
-- **2 ~-~-** Form Description
-- **3 ~-~-** Questions in custom layout
-- **4 ~-~-** Product Prompt Text
-- **5 ~-~-** Products attached to the form (notice products subscribed to are identified with "You are currenty receiving:" highlighted in green.
++**2 ~-~-** Form Description
++**3 ~-~-** Questions in custom layout
++**4 ~-~-** Product Prompt Text
++**5 ~-~-** Products attached to the form (notice products subscribed to are identified with "You are currenty receiving:" highlighted in green.
--=== The screen shot below is an example of the customized acknowledgement email with receipt confirmation (shown in screen shot above) sent to a NEW subscriber/purchaser. ===
++(% style="text-align: center;" %)
++==== Example of the customized acknowledgement email with receipt confirmation sent to a NEW subscriber/purchaser. ====
  [[image:attach:media_1352398034919.png||align="center"]]
--[[image:attach:media_1477585237131.png||align="center"]]
++\\
@@ -247,33 +247,26 @@
  {{/layout-cell}}
  {{layout-cell}}
--**Search all Documentation:**
++{{panel title="Search all Documentation:"}}
++{{livesearch/}}
++{{/panel}}
--{{livesearch/}}
++{{panel title="Search INVENTORY Documentation:"}}
--
--**Search INVENTORY Documentation:**
++{{pagetreesearch rootPage="Create and Manage Your Inventory"/}}
++{{/panel}}
++{{panel title="On this page:"}}
--{{pagetreesearch/}}
--
--
--
--**On this page:**
--
--
--
  {{toc/}}
++{{/panel}}
--
--
--
--
--{{expand title="More INVENTORY Documentation"}}
++{{panel title="More INVENTORY Documentation:"}}
++{{expand}}
  (% style="margin-left: 30.0px;" %)
  [[Inventory - Getting Started>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=66180||shape="rect"]]
@@ -325,6 +325,29 @@
  (% style="margin-left: 30.0px;" %)
  [[Source Codes - How to Create and Manage Source Codes>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=66463||shape="rect"]]
  {{/expand}}
++{{/panel}}
++
++\\
++
++\\
++
++**
++**
++
++\\
++
++\\
++
++\\
++
++\\
++
++**
++**
++
++\\
++
++\\
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--66841
++54198302

url

@@ -1,1 +1,1 @@
--https://info.onecount.net//wiki/spaces/OD/pages/66841/Forms - How to Create a Form (v12.x)
++https://info.onecount.net//wiki/spaces/OD/pages/54198302/Embedded Forms - How to Create an Embedded Form