Widget Use
| Excerpt |
|---|
The dashboard widget is used to display the users' account settings and personal information in tile Displays the user's account pages and profile information in a tiled format. |
Example of Widget Use
Where can the Widget be placed?
The widget can be used in the following templates:
Widget Options
| Option | Use | Comments | Available from Version |
|---|
| Description |
The | A short description of the widget |
It is recommended to use this so the reason for use of the widget is seem | '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 |
that will be shown on| 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 |
, but different configuration |
is are 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 |
| Dashboard Menu Item Code |
| Determines which page tiles are displayed, based on the menu items (e.g. Order History, My Favourites, etc). | Default |
is| : THEME_BPDTHEME01_Dashboard |
| All |
| My Details Field Group | Specifies the JSON Field Group to use for the User Details tile. | Default: contact-details | All |
| My Preferences Field Group | Specifies the JSON Field Group to use for the My Preferences tile. | Default: my-preferences | All |
| Enable Postcode Validation | Determines whether postcode validation is used for address maintenance. | Default: enabled Toggle to disable | All |
| Show Company Name In Address | When ticked, allows the B2C user to update the Company name in the Billing and Delivery Address sections. | Default: disabled Toggle to enable | 3.84 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Titles | Use | Comment |
|
|---|
| User Profile Heading |
This determines the text of | The heading text displayed above the user's profile |
heading. Also known as | pages. Shown above the first section of the dashboard. | Default |
is | All |
| Password Title |
| Default: Change Password | All |
| Password Subtitle |
| Default: Reset & update your password | All |
| Details Title |
| Default: My Details | All |
| Details Subtitle |
| Default: Update your personal details | All |
| Preferences Title |
| Default: My Preferences | All |
| Preferences Subtitle |
| Default: Update your personal preferences | All |
| Address Title |
| Default: My Address | All |
| Address Subtitle |
| Default: Update your delivery details | All |
| Set Default Address Subtitle |
| Default: Set your default delivery address | All |
| My Pages Heading |
This determines the text of the pages heading. Also known as | The heading text displayed above the user's account pages. Shown above the second section of the dashboard. | Default |
is: My pages | | My Details Field Group | | Default is: contact-details | |
| My Preferences Field Group | | Default is: my-preferences | |
| Billing Details Heading | | Default is: Contact / Billing Address | |
| Delivery Details Heading | | Default is: Delivery Address | |
| Enable Postcode Validation | | Default is: Ticked Untick to disable | |
...
| : My Pages | All |
| Billing Details Heading | The heading text displayed above the Billing Address input fields (generally for B2C user address maintenance). | Default: Contact / Billing Address | All |
| Delivery Details Heading | The heading text displayed above the Delivery Address input fields (generally for B2C user address maintenance). | Default: Delivery Address | All |
| Set Default Address Heading |
| Default: Set Your Default Delivery Address | All |
| Set Default Address Heading Icon |
| Default: cv-ico-general-truck | All |
| My Address Title |
| Default: Delivery Address Book | All |
| Set Default Delivery Address Title |
| Default: Your Delivery Addresses | All |
| Set Default Delivery Address Subtitle |
| Default: Select an address to set it as your default | All |
| Maintain Third Party Delivery Addresses Title |
| Default: Drop Ship Delivery Addresses | All |
| Maintain Third Party Delivery Addresses Subtitle |
| Default: Maintain your drop ship addresses | All |
| Edit Third Party Delivery Address Heading |
| Default: Edit Your Drop Ship Address | All |
| Third Party Delivery Address Delete Confirm Heading |
| Default: Confirm to Delete | All |
| Prompts | Use | Comment |
|
|---|
| Current Password Prompt | The placeholder text in the Current Password field. | Default: Current Password | All |
| New Password Prompt | The placeholder text in the New Password field. | Defaults to the value of the system resource 'NewPassword'. Updating this value will update the resource, which may be used by other widgets. | 3.83 |
| Confirm Password Prompt | The placeholder text in the Confirm Password field. | Defaults to the value of system resource 'ConfirmPassword'. Updating this value will update the resource, which may be used by other widgets. | 3.83 |
| Notification Email Prompt | The placeholder text in the Notification Email field. | Default: Notification Email Address | 3.83 |
| Delivery Address Message |
| Default: n/a (blank) |
|
| Third Party Delivery Address Delete Confirm Message |
| Default: Are you sure you want to delete the following drop ship address? |
|
| Empty Address Message |
| Default: No addresses found |
|
Related help
| Content by Label |
|---|
| showLabels | false |
|---|
| spaces | KB |
|---|
| showSpace | false |
|---|
| sort | creation |
|---|
| excerpt | true |
|---|
| reverse | true |
|---|
| excludeCurrent | true |
|---|
| operator | AND |
|---|
| cql | label = "dashboard" and space = "KB" |
|---|
| labels | widget cms |
|---|
|
| Content by Label |
|---|
| showLabels | false |
|---|
| spaces | KB |
|---|
| showSpace | false |
|---|
| sort | creation |
|---|
| excerpt | true |
|---|
| reverse | true |
|---|
| excerptexcludeCurrent | true |
|---|
| operator | AND |
|---|
| cql | label = "field-groups" and space = "KB" |
|---|
| labels | widget cms |
|---|
|
| Content by Label |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| title | Related widgets |
|---|
| excludeCurrent | true |
|---|
| cql | label = "widget" and title ~ "Dashboard" |
|---|
|