Skip to end of metadata
Go to start of metadata

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

OptionUseCommentsAvailable from Version
DescriptionA 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
LayerThe 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 PromptA 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 IconThe icon displayed next to the text prompt.Default: cv-ico-general-flow-cascade4.13.00
Hide Default IconHides 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: ON4.13.00
Notifications
Client Group Cannot Be Communicated With MessageThe 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 MessageThe 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 MessageThe 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

  • Page:
  • Page:
    Token Customer Credit Card Info Widget — Displays the message in credit card expiry reminder emails to Customers who have existing token payment set up.
  • Page:
    Email Credit Card Verification Link Widget Adds credit card verification instructions in order confirmation and verification reminder emails, and includes a link to the validation page.
  • Page:
    Report Subscription Widget Provides input field and button configurations for the Report Subscription screen. You can customise the widget to display field labels, headings and text to suit your website needs and style.
  • Page:
    SignalR Group Message Selector Widget 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.
  • Page:
    Page Content Search Result Widget Customise the 'no results returned' message when the keyword search does not match any static content on your pages or products.
  • Page:
    Scripts & Styles Widget — The new Scripts & Styles widget allows you to bundle related scripts and styles into one widget to function as a unit, or add multiple Scripts & Styles widgets to a page so they operate independently. Due to its name, and because the widget functions to run scripts or apply styles only, you know at a glance if a page is using customised JavaScript or Style Sheets.
  • Page:
    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.
  • Page:
    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.
  • Page:
    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.
  • 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.
  • Page:
    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.
  • Page:
    Dashboard Back Orders Widget — Displays a list of the user's backorders with links to the order detail page.
  • Page:
    Social Sharing Plugin Widget — Acts as a placeholder to output customised javascript based on content from Add This (social network Share buttons, for example).
  • Page:
    Widget finder — In a previous CMS release, we added a new feature which allows users to quickly locate where on their site Custom Widgets are being used.

    Now, we're pleased to announce that positive feedback on this feature has led us to expand the functionality to ALL widgets! (thumbs up)