Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Multiexcerpt
hiddentrue
MultiExcerptNameFeature Title

Common Options Tab for Custom Widgets

...

MultiExcerptNameFeature Overview

...

Advanced content creators can add custom widgets for non-standard functions. 


Step-by-step guide

  1. In the CMS, navigate go to Advanced ContentCustom Widgets.

  2. Click Edit next to a widget that is in use (depicted by Used n time indicator in the In Use? column).
    Image Removed
    If we look at the DashboardBackOrders custom widget, then we see that the Include Common Options parameter is OFF.
    Image Removed
    You can check where that widget is used by clicking Options → Where is it used?
    Image Removed
    Click the Template directly from the Where is this widget used? pop-up, or navigate to the page location: Content → Pages & Templates → Accounts → Dashboard Page
    Find the widget in the Page Template and click Edit.
    Image Removed
    You can see that there are only two tabs: General Options and Personalisation.
    Image Removed
    View the HTML code (Chrome: Inspect; Firefox: Inspect Element). Take note of the lines between the  highlighted line:<div class="content-box dashboard-module dashboard-back-orders"...> and the <header class="box-title"... "Back Orders" </header>.
    Image Removed
    Exit out of the widget and head back to the DashboardBackOrders custom widget by clicking Options and selecting <>View Source Code or navigating to Advanced Content → Custom Widgets.
    Image Removed
    Click Edit on the DashboardBackOrders widget, and this time, toggle Include 'Common Options' to ON.
  3. Save your changes and return to ContentPages & TemplatesAccountsDashboard Page.
  4. Edit the DashboardBackOrders widget and click on the Common Options tab.
    Image Removed
    You will see all the options available on the Common Options tab that is available on all non-Custom widgets.
    View the HTML code (Chrome: Inspect; Firefox: Inspect Element).
    Note the addition of the '<div>' tag for the Dashboard Back Order Custom Widget surrounding the <div class="content-box dashboard-module dashboard-back-orders"...> and the <header class="box-title"... "Back Orders" </header> highlighted in the pre-enabled view.
    Image Removed
    To test it, edit the CUSTOM:DashboardBackOrders widget again and toggle Show On Mobile? to OFF.
    Image Removed
    Save your changes and notice the difference to the widget.
    Image Removed
InfoYou can read more about the device icon display in the Widget Device Display Indication: Mobile, Tablet, and Desktop help page
  1. Add New Widget.

    Image Added
  2. In Name, enter a name for the widget.

  3. In Description, add a description of what the widget does.

  4. If caching is needed, in Cache Mode, select a cache option.  

    Session - Single cached record for individual user based on cached variant.
    Application - Single cached record for all users of the same type based on cache variant.
    ApplicationSession - Application cached for public users, Session cached for logged in users
    Global - Single cached record for all users.



  5. To include 'Common Options' standard in widgets, toggle ON Common Options.

  6. In Configuration Option Xml, you can check where that widget is used by clicking Options → Where is it used?

  7. In Source Code, enter the source code for the custom widget.

  8. To save the widget, click Save or Save & Exit.



Additional Information

Multiexcerpt
MultiExcerptNameAdditional Info
Contact CV Support if Commerce Vision if you have any questions or issues enabling this option.

...

MultiExcerptNameMinimum Version Requirements

...

.

...

...

MultiExcerptNamePre reqs

...

--

...

Multiexcerpt
MultiExcerptNameSelf Configurable

Yes

...

Multiexcerpt
MultiExcerptNameBusiness Function

Behaviour & Personalisation

...

Multiexcerpt
MultiExcerptNameBPD Only

Yes

...

Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both

...

Multiexcerpt
MultiExcerptNameBallpark Hours From CV (if opting for CV to complete self config component)

Contact CV Support

...


Multiexcerpt
MultiExcerptNameBallpark Hours From CV (in addition to any self config required)

Contact CV Support

...

Multiexcerpt
MultiExcerptNameThird Party Costs

n/a or Fees apply

...

Multiexcerpt
MultiExcerptNameCMS Category

Custom Widgets

Related help

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel = "widget-custom" and type = "page" and space = "KB"
labelsnew ver41500 how-to

...

Content by Label

...

showLabels

...

false

...

max

...

Macro Instructions for carrying Article Information through to Feature List

...

Minimum

Version

Requirements

BPD

ONLY

...

Business Function

...

CMS Category

...

B2B
B2C

BOTH

...

Feature

...

Feature Description

(Written for our customers and can be pasted into comms sent to them)

...

Additional info

...

Pre-Reqs/
Gotchas

...

Ballpark Hours
From CV

(if opting for CV to complete self config component)

...

Ballpark Hours
From CV

(in addition to any self config required)

...

Third Party Costs

Instructions for carrying Excerpts through from this page to the Feature List

Article Page:

Add macro  / Multiexcerpt (or copy and existing excerpt and edit) or (Copy existing page and place content into existing excerpt macros)

On Features List page:

...

10
spacesKB
showSpacefalse
sortmodified
reversetrue
titleSite Design
typepage
excludeCurrenttrue
cqllabel = "site-design" and type = "page" and space = "KB"
labelshow-to cms banners