Widget Use
Define the text for the button users will click when selecting a SignalR client; in this example, a printer enabled to print orders/invoices in PDF format.Example of Widget Use
Following is an example of the widget in use:
Where can the Widget be placed?
The widget can be used in the following templates:
- All
Recommended:
- Theme Layout Template
- Print Order Page Template
Implementation Guides
Widget Options
| 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 |
| Client Group Select Prompt | A prompt for the user to indicate what function the button provides | Default: Print Invoice As "client" is a SignalR term, we recommend changing this message to something more meaningful; in this example, Select Printer | 4.13.00 |
| Client Group Select Icon | The icon displayed next to the text prompt. | Default: cv-ico-general-flow-cascade | 4.13.00 |
| Hide Default Icon | Hides the Client Group Select Icon. | Default: OFF | 4.13.00 |
| Show Only Icon on Mobile? | Only display the icon (not the Client Group Select Prompt text) if you are on a mobile device. | Default: ON | 4.13.00 |
| Notifications | |||
| Client Group Cannot Be Communicated With Message | The system displays this message when the SignalR client is offline or unavailable. | Default: The selected Client Group is not available. Please select another if possible. | 4.13.00 |
| No Clients Online Message | The system displays this message if it cannot find any SignalR clients configured or running. | Default: Comes up if no "printer": There are no Clients currently online. | 4.13.00 |
| No Client Group Selected Message | The system displays this message if the user did not select a SignalR client. | Default: Please select a Client Group. | 4.13.00 |
Prerequisites
This widget works with the SignalR Print Order Button and Messages widgets.
You must contact CV Support to enable your system to use the SignalR functionality.
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.
