Form and Tool Widgets
This page covers the widgets for forms that collect information from shoppers, and the document scanning (OCR) tools. For each one it gives the steps to place it and the settings its form offers, in the words the form uses, so you can tell before you start which records and images you need to have ready.
Your job, and the screen for it
| The job | Screen or tab | Read |
|---|---|---|
| Add one of these widgets to a page | Design Panel › Elements › Forms & Tools | Configuration |
| Change a widget that is already on the page | Click it on the canvas, Design Panel › Selected Node | Its section under Configuration |
| Know which settings need an ID, JSON or rich text | Selected Node | Fields |
| Make a change reach the shop | SAVE NODE, then Publish | Configuring Widgets |
| Find out why a widget shows nothing | Troubleshooting |
Overview
The Forms & Tools group in the Elements tab holds 5 widgets: dynamic-form-widget, ocr-history-widget, ocr-upload-widget, ocr-view-widget, template-form-widget. Placing, saving and publishing work the same for every widget and are explained once in Configuring Widgets in the Website Builder; this page adds what is particular to each widget.
Where it fits
| Before | These widgets | After |
|---|---|---|
| You can open the Website Builder and the page exists — User Permission Manager, Layout Instance | Placed on a page and configured | Shoppers see them on the storefront after Publish |
Screens and menus
Open a page from the Layout Manager tile. In the Design Panel, the Elements tab lists these widgets under Forms & Tools, each with its one-line description; the search box matches the description too. Clicking a placed widget on the canvas opens its settings in Selected Node.
Configuration
Before you can use it
- Everything in Configuring Widgets › Before you can use it: CP Commerce Admin for your login, and the records the widgets point at.
- Check Platform before you drop a widget: it is added to that platform’s version of the page only.
dynamic-form-widget
Dynamic form with configurable questions.
- In Elements, open Forms & Tools (or search dynamic-form-widget) and drag dynamic-form-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Form field set GUID; Privacy URL; Show check box; Show title; Show contact details; Colored input background; Show background image; Background image URL; Document text; Internal padding
- Style — Color; Background; Text; Font
- Style check box text — Color; Text; Background; Font
- Contact details — Company name; Company reg no; Address; Phone; Email
- Style title — Color; Text; Background; Font
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
ocr-history-widget
History of scanned (OCR) documents.
- In Elements, open Forms & Tools (or search ocr-history-widget) and drag ocr-history-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Upload receipt page (pick a page); Receipt details page (pick a page); Per row listing; Per row listing md
- Button style — Color; Background
- Receipt style — Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
ocr-upload-widget
Upload a document for OCR.
- In Elements, open Forms & Tools (or search ocr-upload-widget) and drag ocr-upload-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Page after a successful upload (pick a page); Profile page (pick a page); Config; Requires first name; Requires last name; Requires gender; Requires DOB; Requires email; Requires phone; Terms and conditions page (pick a page)
- Button — Color; Background
- Terms and condition styles — Text decoration; Font weight; Color
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
ocr-view-widget
View a scanned (OCR) document.
- In Elements, open Forms & Tools (or search ocr-view-widget) and drag ocr-view-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Duplicated text; Review text; Failed text; Hide receipt no
- Button — Color; Background; Font; Page the button opens (pick a page)
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
template-form-widget
Form built from a template.
- In Elements, open Forms & Tools (or search template-form-widget) and drag template-form-widget onto the page.
- In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
- General — Title; Subject (comma-separated); Form template GUID
- Style — Color; Background
- Click SAVE NODE, then Preview and Publish (Steps 4 and 5).
Fields
The settings are listed with each widget above, in the form’s own words. Colours, lists and JSON behave as described in Configuring Widgets › Step 3.
Settings marked (pick a page) — their labels end in page — open a list of your pages when you click them and fill in the page’s address, /page/ and its code. You can also type any link instead, such as a full https:// address. Left empty, the widget uses its own default page where it has one.
The settings that pick a record, take JSON or hold rich text:
| Kind | Where | What to know |
|---|---|---|
| Typed IDs | dynamic-form-widget › Form field set GUID; template-form-widget › Form template GUID | No picker yet: paste the ID of the record. The form accepts any text, so copy it rather than typing it |
Lifecycle and effects
SAVE NODE keeps a change in your browser tab only; Publish sends the page to the shop, and a reload before publishing loses the change. A setting left empty is not saved and the widget uses its own behaviour for it; opening a widget and saving without changes leaves its stored settings as they were. The full sequence is in Configuring Widgets › Lifecycle and effects.
Related applets
- CP Commerce Admin — decides who may publish, and holds the same pages under Layout Instance.
- Media Library — where the images these widgets show are uploaded.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| The widget is empty on the shop | A record it shows is missing or inactive | Check the records its pickers point at |
| A change is gone after reload | The page was not published | Redo it and Publish before leaving |
| It shows on desktop but not on phones | It was added on a desktop platform only | Switch Platform and add it there too |
| SAVE NODE does nothing | Widget Config (JSON) holds invalid JSON | Fix or undo the JSON |
| A picker shows Not in the list — saved ID … | The record it saved was deleted, belongs to another website, or is not in the list as loaded | Publish what you have first (a reload loses unpublished changes), then reload; if it still shows, check the record before you pick a replacement |
| A picker shows The list is empty or could not be loaded | Nothing of that kind exists yet, or loading failed | Create the record first, or reload the page |
Related documentation
- Configuring Widgets in the Website Builder — placing, saving, previewing and publishing
- Website Builder — the other widget groups and the Website Builder pages