Widget Use
Provides input field and button configurations for the Report Generator feature. You can customise the widget to determine display options and edit text to suit your website style.Example of Widget Use
The following is an example of the widget in use.
| Report Generator Search and Search Results |
|---|
|
Where can the Widget be placed?
The widget can be used in the following templates:
- Report Generator Template
Implementation guides
Widget Options
Note - some fields display only if in use
| Option | Use | Comments | Available from Version |
|---|---|---|---|
| Description | A short description of the widget's use. | We recommend this field be updated so the widget's purpose is clear at a glance from the template page. | All |
| Layer | The layer the widget is valid for. | The layering technology allows for the content to be shown to specific audiences. This is handy if the content is only valid for a certain type of user, or if the same widget is required for more than one audience, but different configuration is needed. The widget can be added to the zone more than once and the layer feature can determine which audience can see each widget. | All |
| Show Active And Inactive Reports Flags? | By default, the system selects active reports only for Search. If toggled ON, the 'Show Active Reports' and 'Show Inactive Reports' checkboxes appear in the Search Reports function.
| Default: ON ON: Both checkboxes appear. This allows users to find both active and inactive reports, or just inactive reports. OFF: Checkboxes do not appear. Users cannot select inactive reports. | 4.23.00 |
| Page Size | This sets the maximum number of pages to display search results. | Default: 20 | All |
| Labels | |||
| |||
| The heading displayed for the Reports Search field. | Default: Report Search | 4.23 |
2. Search Show Active Label | Labels for the Active/Inactive Reports checkboxes. | Default: Show Active Reports | 4.23 |
| 3. Search Show Inactive Label | Default: Show Inactive Reports | 4.23 | |
| 4. Report Name Label | |||
| Prompts | |||
| Search Button Text | The text displayed on the search button. | Default is: Search | 4.03 |
| Notifications | |||
| Search Place Holder | This is the text that will appear in the search bar as free text, and will disappear after the user has clicked in the field. | Default is: Product Search | All |
| Search Prior Purchases | The prompt text that appears next to the prior purchase search option (where Prior Purchase is enabled). | Default is: Prior Purchase Search | 3.88 |
| Search User Favourites Text | The prompt text that appears next to the user favourites search option (where Search Favourites is enabled). | Default is: User Favourites Search | 4.03 |
Other Widgets
-
Order Payment Links Form Widget — Renders an order details stepper with an order form that can be automatically populated with query strings, and/or manually entered by the user. The form doesn't validate the order details are accurate in order to stay both secure and accessible to unauthenticated users.
-
Magic Link Authentication Message Widget — Renders the Magic Link authentication message.
-
CUSTOM_Side by Side Content Tiles Widget — Renders two side by side content tiles in a zone with widget options for selecting or adding background colour, image, text and link/button positioning.
-
Stock Dialog Widget — Displays the Stock to Receive Detail dialog window.
-
Stock to Receive Widget — Displays the Stock to Receive page.
-
Stock Levels Widget — Displays Stock Levels page.
-
Order Declined Pending 3rd Party Installment Msg Widget — Renders the message body for the email sent when the user selects to sign up and pay with a Buy Now Pay Later provider but approval is subject to further checks.
-
Order Field Static Widget — Renders an additional order field in email templates.
-
Online Quote Validation Widget — Renders the appropriate message to the user after the current status of an online quote accessed via an email link is validated.
-
Header Level Cost Centre Widget — Renders the cost centre input field on the order header in the shopping cart.
-
Openpay Summary Widget — Renders Openpay marketing information for a product on the product detail page. Use this widget instead of the Product Purchase Details widget if you want to customise tagline placement on the template.
-
Order Line Availability - Click and Collect Widget — Displays product availability and delivery methods at the order line level in dynamic scenarios such as the cart when Click & Collect is enabled.
-
Account Activation Email Content Widget — Renders the message content in the Invitation to Register an Account email.
-
Order Template Cost Centre Widget — Renders the cost centre input field on each product line in an order template.
-
BPAY Account Payment Detail Widget — Renders BPAY payment information in the body of the BPAY Account Payment email. This email is sent to users who pay invoices or pay down their account balance using BPAY.
