Changes for page Form Builder

Last modified by Sachin Patil on 2024/08/30 07:28

From version 5.1
edited by rijo
on 2022/08/23 13:34
Change comment: There is no comment for this version
To version 20.1
edited by Admin
on 2023/08/03 14:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.rijo
1 +XWiki.Admin
Content
... ... @@ -38,19 +38,32 @@
38 38  
39 39  \\
40 40  
41 -1. Required: Give your Form a title. You will have an option to use this title when designing the form in Phase D. If you want to use a different title when designing the form you may do so by using a custom “text section” content block when designing the form.[[image:attach:FB Title.png||height="250"]]
42 -1. Give your Form a description. You will have an option to use this title when designing the form in Phase D. If you want to use a different title when designing the form you may do so by using a custom “text” content block when designing the form.
43 -1. Required: Assign a source code to a Form. To add or change existing source codes, go to the source code manager in the inventory tab of the navigation bar at the top. If you do not have a source code for this form then use a generic source code.
44 -1. If choosing popup as the 'Form Type', for best viewing experiences, please ensure that the minimum width and height used are 350-400.
45 -1. OPTIONAL: If you want to direct users to a specific page after submitting the form, then place the url into the "Thank you page URL" field.
46 -1. Select a submission option ~*~*~*~*~*~*~*~*~*~**
47 -1. Show only relevant products ~*~*~*~*~*~*~*~**
48 -1. Enter the text/message to be displayed if an email already exists.
49 -1. Body markers that may be used in the text are as follows:
41 +**Required:** First, give your Form a title. You will have an option to use this title when designing the form in Phase D. If you want to use a different title when designing the form you may do so by using a custom “text section” content block when designing the form.[[image:attach:FB Title.png||height="250"]]
42 +
43 +Give your Form a description. You will have an option to use this title when designing the form in Phase D. If you want to use a different title when designing the form you may do so by using a custom “text” content block when designing the form.
44 +
45 +**Required: **Assign a source code to a Form. To add or change existing source codes, go to the source code manager in the inventory tab of the navigation bar at the top. If you do not have a source code for this form then use a generic source code.
46 +
47 +If choosing popup as the 'Form Type', for best viewing experiences, please ensure that the minimum width and height used are 350-400.
48 +
49 +OPTIONAL: If you want to direct users to a specific page after submitting the form, then place the url into the "Thank you page URL" field.
50 +
51 +Select a submission option. Submission Option is a feature that allows ONEcount to require a user to subscribe to a product or package in order to submit the form. There are three settings:
52 +
53 +[[image:attach:selection-required.png||height="216"]]
54 +
55 +The first option allows the user to submit the form without subscribing to a product, but a message is displayed telling the user that they did not subscribe to a product before hitting submit. The second option allows the user to submit the form without any warning. The third option is effective in cases where the forms are pre-populated, and users might be tempted to hit "Submit" without subscribing to anything. This option issues a warning and forces the user to return to the form and subscribe to a product.
56 +
57 +Show only relevant products ~*~*~*~*~*~*~*~**
58 +
59 +Enter the text/message to be displayed if an email already exists.
60 +
61 +Body markers that may be used in the text are as follows:
50 50  %%TEXT%% – will link to Sign in page%%
51 51  ~#~#TEXT - will be linked to Password Reset page~#~#
52 -1. STATUS: Activate the Form for user access or disable the form.
53 53  
65 +STATUS: Activate the Form for user access or disable the form.
66 +
54 54  \\
55 55  
56 56  \\
... ... @@ -111,6 +111,8 @@
111 111  
112 112  PHASE D: Designing the Form
113 113  
127 +This is an example of a form built using the form builder.
128 +
114 114  [[image:attach:Editori-main-menu copy.png||height="250"]]
115 115  
116 116  Use the editor to customize the look and feel of your form webpage. To add page and form elements, drag the element(s) from the menu on the right to where you want them to appear. Sections of the Elements menu can be collapsed for ease of use to drag in content blocks that are located lower in the menu.
... ... @@ -123,6 +123,82 @@
123 123  
124 124  \\
125 125  
141 +BUILD FORMS FROM SCRATCH
142 +
143 +Form Building is a multi-step process. 
144 +
145 +Form can be built from scratch.  It requires, at the very minimum, a Captcha and Submit button, if building from scratch.  If choosing to do so,
146 +
147 +1. Navigate to the 'Form Design' tab, after you have filled out the basic information as required by the 'Form Definition,' 'Add Demographics,' and 'Add Products/Packages' tabs.
148 +1. The canvas can be populated by dragging-and-dropping elements/components from the right-hand panel.  
149 +11. Simply select your choice of component from the options in the right-hand panel with your mouse
150 +11. Drag it over to the spot on the canvas, as you prefer
151 +
152 +\\
153 +
154 +Let's start with selecting a grid format from the 'Grid Templates' option in the right-hand panel. This helps with adding elements to the canvas, eventually your form, in an organized/disciplined manner.
155 +
156 +Below is a screen-shot where the 'Grid Templates' expands on beings selected, and the 'three column' grid is chosen
157 +
158 +[[image:attach:formbuilder-three-column-demosAug23.png||height="250"]]
159 +
160 +\\
161 +
162 +1. First, let's expand the 'Grid Templates' option by selecting it.
163 +1. From there, select the preferred column type, then drag it to the canvas, as shown below (three-column grid selected)
164 +
165 +(% style="margin-left: 40.0px;" %)
166 +[[image:attach:formbuilder-drag-a-grid-onto-canvas.png||height="250"]]
167 +
168 +(% style="margin-left: 40.0px;" %)
169 +\\
170 +
171 +(% style="margin-left: 40.0px;" %)
172 +3. To populate the columns, let's choose from the 'Demographics' option.
173 +
174 +1.
175 +11. Select First Name and drag it to the left-most cell, followed by Last Name to the middle cell, next email to the last one.
176 +
177 +(% style="margin-left: 40.0px;" %)
178 +[[image:attach:formbuilder-drag-fields-from-toolbar-onto-canvasAug23.png||height="250"]]
179 +
180 +\\
181 +
182 +(% style="margin-left: 40.0px;" %)
183 +4. The three-column grid will look as follows:
184 +
185 +(% style="margin-left: 40.0px;" %)
186 +[[image:attach:formbuilder-three-column-demosAug23.png||height="250"]]
187 +
188 +(% style="margin-left: 40.0px;" %)
189 +5. To add Captcha to the form:
190 +
191 +1.
192 +11. Select 'Form' from the right-hand panel[[image:attach:Screen Shot 2022-08-23 at 4.52.47 PM.png||thumbnail="true" width="150"]]
193 +11. Select Captcha and drag it over to the spot on the canvas.  In this case, we choose below the 3-column grid
194 +
195 +(% style="margin-left: 40.0px;" %)
196 +[[image:attach:formbuilder-add-captchaAug23.png||height="250"]]
197 +
198 +(% style="margin-left: 40.0px;" %)
199 +6. To add a 'Submit' button:
200 +
201 +1.
202 +11. Select it from the 'Form' option and,
203 +11. Drag it to the spot you prefer on the canvas,
204 +11. Eventually this position will impact how your final form is displayed)
205 +
206 +(% style="margin-left: 40.0px;" %)
207 +7. Below is what the final form/pop-up will look like after the additions/modifications described in steps 1-7.
208 +
209 +(% style="margin-left: 40.0px;" %)
210 +[[image:attach:formbuilder-completed-formAug23.png||height="250"]]
211 +
212 +(% style="margin-left: 40.0px;" %)
213 +\\
214 +
215 +\\
216 +
126 126  ELEMENTS MENU
127 127  
128 128  \\
... ... @@ -132,6 +132,7 @@
132 132  1. Begin creating a layout by first adding **Grid Templates. **First add One Column Grid Templates to define the basic layout. For multiple columns, add a one column Grid Template before dragging 2 or 3 column Grid Templates into the form.
133 133  1. To add a Title and Description, drag in the “Title” or “Description” content blocks from the “Form Info” section of the Elements menu. The “Title and Description” will be what you have entered during Phase 1, Form Definition.
134 134  11. To create a custom heading or text block, add a “Text” or “Text Section” from the list of products near the lower part of the Elements menu.
226 +11. Click [[here>>attach:formbuilder-R-YTVideo-Aug23.mp4]] to view how you can add a Youtube video to your form.
135 135  11. To add Products/Packages drag in the Product or Package from the Elements menu on the right. The layout of Products or Packages will be based on what Template Type you selected during Phase 3, Add Products & Packages.
136 136  11. Adding Images, first drag the image icon from the Elements Menu and place it where you want an image to be placed.
137 137  111. A pop-up window will open with a library of images already added.
... ... @@ -138,14 +138,64 @@
138 138  111. To add a new image, click the left-hand side of the image pop-up window. Using the folder browser, choose an image from your files that you would like to upload.
139 139  111. After uploading an image file, select the image from the image library list on the right hand side.
140 140  111. After selecting your image, click the “X” button to close the image library. Your image will be placed in the image content block.
233 +111. Here is a video showing how to select images to your canvas: [[How to upload image video>>attach:formbuilder-AddImage-R-Aug23.mp4]]
141 141  111. To add Questions/Fields drag the questions you have selected during Phase 2, “Add Demographics”, from the “Demographics” section of the Elements menu.
142 142  1111. It is recommended to place each Question in individual Grid Templates (single or multiple column).
143 -1111. To add additional questions, return to Phase 2 “Add Demographics”.
236 +1111. To add additional questions, return to Phase 2 “Add Demographics”.
144 144  
238 +Once created, we can edit the added elements to the canvas.  Let us see how URL links can be added and how to the 'paint brush' icon can be used.
239 +
240 +1. URL links can be added to components that use the 'Link' feature. 
241 +11. To add or modify a URL link, use the 'Components Settings' option on the toolbar, denoted by a 'gear' icon [[image:attach:Screen Shot 2022-08-23 at 2.25.10 PM.png||thumbnail="true" width="20"]]on the above toolbar.
242 +11. You can add URL to the 'Href' field, which will then link the selected component to the URL specified in this field.
243 +11. Please [[click here>>attach:formbuilder-R-GearsURL-Aug23.mp4]] to view a video showing how to create a URL link.
244 +1. Components can be modified in terms of typography(text-related features such as fonts, alignment), dimensions (height, width, padding, etc.) or background decorations (color, radius, etc.). 
245 +11. To do so, select the component, then click on the 'paintbrush' icon on the above toolbar, denoted by[[image:attach:Screen Shot 2022-08-23 at 2.28.56 PM.png||thumbnail="true" width="20"]].  In the screen shot below, the image on the right is selected and edited.
246 +
247 +(% style="margin-left: 80.0px;" %)
248 +[[image:attach:formbuilder-edit-object-propertiesAug23.png||height="400"]]
249 +
250 +(% style="margin-left: 80.0px;" %)
251 +b. Please [[click here>>attach:formbuilder-R-PaintBrush-Aug23.mp4]] to view a video showing how a button's background color was changed.
252 +
253 +(% style="margin-left: 80.0px;" %)
145 145  \\
146 146  
147 -TEMPLATES MENU
256 +(% style="margin-left: 80.0px;" %)
257 +\\
148 148  
259 +===
260 + ===
261 +
262 +{{id name="click-thru-button"/}}
263 +
264 +===
265 + ===
266 +
267 +{{id name="click-thru-button"/}}
268 +
269 +=== Click-Thru Button ===
270 +
271 +Often users will want to create a pop-up or landing page that has a button that clicks through to another site or page. The specific use-case could be clicking to a partner site to download a digital edition, clicking to a non-ONEcount form, or clicking off-site to a thid-party application.
272 +
273 +To create a click-thru button, click in the cell or grid where you want the button to appear, and from the tool-bar on the right, select Form Options, and then Submit. ONEcount will place a button on your form.
274 +
275 +[[image:attach:submit-button-tool.png||thumbnail="true" height="250"]]
276 +
277 +\\
278 +
279 +Now click on the button, and click on the gear icon above the tool bar.
280 +
281 +[[image:attach:click-thru-button.png||height="250"]]
282 +
283 +Click on the Action Pull-down and select Clickthrough. In the box for Label, add whatever text you would like to appear on the button. In the URL box, put the full URL where you would like the user to be sent when they click on the button. Please note that this URL will open in a new window, leaving the pop-up on the screen. The user will need to close the pop-up.
284 +
285 +A future version of ONEcount will track these click-throughs as "completions" in both the form and segment analytics, giving you insights into how many people are clicking through to the URL.
286 +
287 +\\
288 +
289 +=== TEMPLATES MENU ===
290 +
149 149  The Templates menu contains a set of four pre-designed set of templates you can choose from. Clicking on the Templates option, (found on the right-hand panel) displays the template set.
150 150  
151 151  [[image:attach:TEMPLATES menu Aug22.png||thumbnail="true" height="250"]]
... ... @@ -152,8 +152,16 @@
152 152  
153 153  \\
154 154  
155 -To use a template, drag-n-drop the preferred template from the right-hand panel to the canvas.  The various types of templates include:
297 +To use a template, drag-n-drop the preferred template from the right-hand panel to the canvas.
156 156  
299 +To drag-n-drop a template, first click on the 'Templates' option in the right-hand panel.  This will display the templates.  Now, choose a template and drag it to the canvas to the left, as shown below.
300 +
301 +[[image:attach:Drag-n-DropTemplate.png||height="250"]]
302 +
303 +\\
304 +
305 +The various types of templates include:
306 +
157 157  1. Three-column with graphic
158 158  1. Two-column with graphic
159 159  1. One column/graphic on top
... ... @@ -229,10 +229,16 @@
229 229  
230 230  The 'ThankYou Page Design' tab helps in designing a thank you page after form has been submitted.
231 231  
382 +Below is a screen-shot of the default Thank you page template, that is automatically populated in the 'Thank you Page Design' tab.
383 +
232 232  [[image:attach:TYPageDesign-Aug22.png||height="400"]]
233 233  
234 -Up to four templates, that are drag-n-droppable, are provided in the right-hand panel.  These can be further customized using the components from the form builder, such as the Submit button, Captcha, Demographics components, and such.
386 +Up to four templates, that are drag-n-droppable, are provided in the right-hand panel.  To view them, please click on the 'Thank you Templates' option in the right-hand panel.
235 235  
388 +[[image:attach:TYClosePanelAug23.png||height="250"]]
389 +
390 +These templates can be further customized using the components from the form builder, such as the Submit button, Captcha, Demographics components, and such.
391 +
236 236  So, we now have three ways for designating a Thank you page:
237 237  
238 238  ~1. Provide a URL in the 'Thank you Page URL' field found in the 'Form Definition' tab.  This has priority over the following two steps (2. and 3.)
... ... @@ -255,10 +255,18 @@
255 255  
256 256  The default values in the Thank you page are populated from the Config Manager.
257 257  
414 +To delete a template from the canvas, click on the 'trash can' icon found on the above toolbar.
415 +
416 +[[image:attach:TYDeleteIconAug23.png||height="250"]]
417 +
258 258  \\
259 259  
420 +Please [[click here>>attach:formBuilder-TYSelectDelete-Rayaan-OC2201.mp4]] to view video showing how to select and delete a 'Thankyou Page Design.'
421 +
260 260  \\
261 261  
424 +\\
425 +
262 262  TO DUPLICATE A FORM
263 263  
264 264  1. From the “Manage Forms” page click the copy icon at the end of the row for the form you wish to copy. ()
... ... @@ -370,10 +370,16 @@
370 370  
371 371  One use for these boxes is to add Javascript code to your form that will change the questions and/or question responses based on a user’s response to a question on the form.
372 372  
373 -**Code for altering responses based on select type demographics:**
537 += ADVANCED FORM TECHNIQUES: =
374 374  
539 +With Extra Scripts/Extra Styles, you can add features to your form or popup to enhance its look-and-feel as well as operations.  Following are examples of how this can be achieved.
540 +
375 375  \\
376 376  
543 +**Example 1: Code for altering responses based on select type demographics:**
544 +
545 +\\
546 +
377 377  **Example:** If a form contains a question which ask whether the user is a doctor or a patient. If the user selects doctor the demographic fields which are related to doctor will appear (type of specialty, NPI #, medical degree achieved, etc.). Otherwise, demographic fields for a patient will appear on the form. This modifications helps to show user only those demographic fields which are related to their previous answers.
378 378  
379 379  \\
... ... @@ -445,4 +445,79 @@
445 445  * removeInitial is assigned only once at the beginning of the script.
446 446  * All the code must be included in form extra script area.
447 447  
618 +**Example 2: Code for removing an option from the form**
619 +
448 448  \\
621 +
622 +**Example:** A form contains a collection of questions.  The client decides that a question/option needs to be done away with, but without disturbing the rest of the form. You want to have it removed or hidden.  You can make this field invisible without changing anything else about the form, using the Extra Script option.  Without re-designing the form, we are able to remove the unwanted option by using the sample code below. 
623 +
624 +\\
625 +
626 +**Example Sample Code:**
627 +
628 +(% class="p1" %)
629 +var removeId = document.getElementsByClassName("labelId");
630 +
631 +(% class="p1" %)
632 +for(var i = 0; i < removeId.length; i++){
633 +
634 +(% class="p1" %)
635 +if(removeId[i].innerText(% class="apple-converted-space" %)  (%%)== "RemoveMePlaceHolder"){
636 +
637 +(% class="p1" %)
638 +removeId[i].parentNode.style.display="none";
639 +
640 +(% class="p1" %)
641 +}
642 +
643 +(% class="p1" %)
644 +}~/~/end of for loop
645 +
646 +\\
647 +
648 +**Steps:**
649 +
650 +* Initialize a variable to grab all the instances of the id from the form you want hidden. 
651 +** var removeId = document.getElementsByClassName("labelId"); //(notice the semi-color)//
652 +** removeId: name of variable (//you can choose a name of your choice, but remember to be consistent with the use through the code//)
653 +** labelId: replace this with the id of the field you want checked/removed
654 +** getElementsByClassName: property of javascript that allows you to get elements by the class name property
655 +* Traverse through the array of the gathered instances (of removeId), and check for the corresponding text by comparing the innerText property to  "RemoveMePlaceHolder"
656 +** removeId[i].innerText(% class="apple-converted-space" %)  (%%)== "RemoveMePlaceHolder" (//check for matches//)
657 +** RemoveMePlaceHolder: replace this with the text you want hidden
658 +* If a match is found, then grab its parentNode
659 +** removeId[i].parentNode
660 +** [i] is the index of the array where the match was found, during traversal
661 +* Change the style of the parentNode to display it as none.  This keeps the field hidden in your forms.
662 +** removeId[i].parentNode.style.display="none"; (//notice the semi-color//)
663 +
664 +\\
665 +
666 +**Note:**
667 +
668 +* All the code must be included in the form Extra Script field.
669 +* The code is to be inserted in the forms in which the value need not been shown or hidden
670 +
671 += DYNAMIC/PROGRESSIVE LOOK-UP: =
672 +
673 +This is a feature provided by ONECount.
674 +
675 +A check is performed after two pieces of data is entered in the form.
676 +
677 +This check looks-up the database till a match is found.  Once it does, the user is asked to confirm.
678 +
679 +The user can choose to log in by clicking on the 'Lookup' link.
680 +
681 +[[image:attach:VerifyBox-LookupOption1.png||height="150"]]
682 +
683 +If the Lookup is clicked, the user is taken to the Lookup/Sign-in page, that may appear as shown below:
684 +
685 +[[image:attach:Sign in:Lookup page.png||height="150"]]
686 +
687 +This is similar to the Verification Box that pops up if the 'Email Exists' tag is selected when adding Demographic 'Email'.  A similar pop-up as shown below appears:
688 +
689 +[[image:attach:VerifyEmailExists-2.png||height="150"]]
690 +
691 +The Lookup link takes you to the login/sign-in page.
692 +
693 +\\
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -77496381
1 +103120946
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/77496381/Copy of New Form Builder
1 +https://info.onecount.net//wiki/spaces/OD/pages/103120946/Copy of New Form Builder