Widget UseDefine 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:
- Theme Layout Template
- Print Order Page Template
|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.
|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
|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.|
|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|
|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|
Account Payment Detail Widget — Renders the payment detail information in the body of the various Account Payment confirmation emails. Information includes (but is not limited to) the order number, account number, invoice, and amount paid.
Dashboard Recent Invoices Widget — Displays the logged in user's 5 most recent invoices, with a link to each invoice in detail, as well as a 'View All' option.
Dashboard Account Status Widget — Displays a list of the user's customer account status, including balance owing and payment terms, as well as links to statements and the account payment page.
Dashboard Articles Widget — Displays a list of the site's news articles, with an image, title, a 'read more' link, and the article expiry date.
Dashboard Product Favourites Widget — Displays a list of the user's top 5 favourite products, with links to each product page, as well as an add to cart button.
Dashboard Back Orders Widget — Displays a list of the user's backorders with links to the order detail page.
Return Lines Widget — Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the return entry page.
Return Information Widget — Where product Returns functionality is in use, renders the details input section (reason, number of parcels) on the returns entry page.
Return Confirmation Summary and Lines Static Widget — Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the confirmation page after the user submits their return request.
Return Confirmation Return Info Widget — Where product Returns functionality is in use, renders the return details (reason, number of parcels) on the confirmation page after the user submits their return request.
Return Confirmation Address Widget — Where product Returns functionality is in use, renders the pickup address details on the confirmation page after the user submits their return request.
Return Confirmation Message Widget — Where product Returns functionality is in use, renders messages to the user on the confirmation page to advise that their return is in progress + next steps.