Sugar Dashlets

Overview 

Sugar dashlets allow users to build specific data, insights, and useful visualizations into their Sugar views. Dashlets live within dashboards that are available on the Home page, list view and record view intelligence panes, and focus drawers. Please note that the dashlets available to view and add will vary between the modules in Sugar. This documentation will cover information on the dashlets available throughout Sugar. For information specific to managing dashboards and dashlets in your Sugar instance, refer to the Dashboards and Dashlets documentation.

Note: You may not see dashlet Gear menus, including the Edit, Remove, and Refresh options, if you are not the containing dashboard's Assigned To user or system admin user. Any change to a shared dashboard will update the dashboard for all users.

Active Subscriptions Dashlet

• A one-to-one or many-to-one relationship to the Accounts module
• A relate field targeting the Accounts module

The dashlet shows a list of all of the current account's purchases that are marked "Service", have a start date in the past, and an end date in the future. The dashlet shows each purchase's name, quantity of units, and purchased line item calculated revenue amount next to "Total". A simple bar chart visualizes the time elapsed and time remaining for the subscription, which you can explicitly view by hovering your mouse over the bar. To learn more, review the Purchases and Purchased Line Items documentation.

Active Tasks Dashlet

The Active Tasks dashlet allows users to view open tasks that require attention and need to be completed on a future or current date. Open tasks have a status of "Not Started", "In Progress", or "Pending Input". The dashlet is broken up into three tabs: "Due Now", "Upcoming", and "To Do", and displays a number on each tab to indicate the count of open tasks falling into each due-date range.

• Due Now: Open tasks that are due today and open tasks where the due date is in the past
• Upcoming: Open tasks that have a due date in the future
• To Do: Open tasks that have no due date specified

When placed on a user's Home page dashboard, the Active Tasks dashlet will show all active tasks assigned to the logged-in user or all active tasks that the logged-in user has team permission to view, depending on how the user has configured the dashlet's settings.

When the Active Tasks dashlet is placed on the record view for a related module (e.g., Accounts, Contacts), it will only show the active tasks that have a relationship with the current record. For example, if the Active Tasks dashlet is placed on the Account module's record view, when a user views ABC Account, the Active Tasks dashlet will only show the active tasks that are related to ABC Account.

You can close tasks as completed directly from the dashlet by clicking the Completed button to the right of the task's row. In addition, if the dashlet is on a record view dashboard, you can delete the task's relationship with the record by clicking the Unlink button to the right of the Completed button.
 

To access a task's record view, simply click the task's subject in the dashlet. You can also hover over the linked task subject and click the Focus icon to open the focus drawer, which displays a 360-degree view of the linked record through a set of dashlets containing pertinent information. There are two buttons on the upper right of the Active Tasks dashlet which allow you to toggle between viewing tasks assigned to you and all tasks to which you have access. You can click the one-person button to quickly view task records for which you are the assigned user. To remove this filter and view tasks assigned to others as well as yourself, simply click the group button to the right of the one-person button. You can also relate new tasks to the record by clicking the Plus icon on the upper right of the dashlet and selecting "Create Task". Complete the Tasks record view layout and save to create the new task. The Gear icon to the right of the Plus icon allows you to edit, refresh, close, and remove the dashlet. To collapse the dashlet, click the Gear icon then select the Close option. To expand the dashlet, simply click the Gear icon again and select "Open". 

Calendar Scheduler Dashlet

The Calendar Scheduler dashlet allows you to conveniently view your calendars of choice within Sugar dashboards. The Calendar Scheduler dashlet behaves similarly to the Sidecar Calendar module. 

When you add the dashlet, the following fields are available for configuration:

You can edit the configuration of these fields at any time by clicking the gear icon in the top right corner of the dashlet. 

When viewing the Calendar Scheduler, there are several options along the top and bottom of the dashlet to help you navigate and adjust the appearance of the calendar. These options are defined as follows:

You can create, update, or delete events from the dashlet if allowed based on the calendar settings, which are defined in the Calendar module. Refer to the Calendars documentation for more information about configuring the behavior and appearance of calendars.

Cases Summary Dashlet

The Cases Summary dashlet also appears in the intelligence pane of the Accounts record view. It allows users to view status information for cases related to the specific account record. The case summary is broken up into multiple tabs (Summary, New, Pending Input, Assigned) and displays a number on each tab to indicate the relevant count of the open, closed, new, and pending cases. Please note that the record must have at least one related case in order for data to appear within the dashlet and the status tabs (Pending Input, New, Assigned) will appear if there is a related case meeting that particular status.

The dashlet is not available for Sugar Sell users. For more information on license types and the functionality available for each, refer to the User Management documentation.

The Gear icon on the upper right of the dashlet allows you to edit, refresh, and remove the dashlet accordingly. To collapse the dashlet, click the Up arrow to the left of the Gear icon. To open up the dashlet, simply click the arrow again.

Note: Dashlet Gear menus, including the Edit, Refresh, and Remove options in the Case Summary dashlet, are only available to the containing dashboard's Assigned To user and system admin users.

The Summary tab displays a donut chart that shows the breakdown of open cases versus closed cases. If you hover over the breakdown it will display the number of open and closed cases for the record. The Pending Input tab displays a list of all pending cases related to the current record. The New tab displays a list of all new cases related to the current record. The Assigned tab displays a list of all open cases related to the current record. Users can easily view the case details by clicking the record's subject link under each tab. Please note that you can also mark a case as a favorite by clicking the star icon to the left of the case subject under each tab (Pending Input, New, Assigned).

Cloud Drive Dashlet

The Cloud Drive dashlet provides users with a way to upload, download, and view documents in their connected Dropbox, Google Drive, Microsoft OneDrive, or Microsoft SharePoint accounts. Admins must set up the Dropbox, Google, and/or Microsoft connector before end users can connect to their Dropbox, Google, or Microsoft accounts. For more information, please refer to the Cloud Drive documentation.

Comment Log Dashlet

DocuSign Dashlet

The DocuSign dashlet provides users with a way to manage DocuSign envelopes and drafts and send new documents to DocuSign. For more information, please refer to the DocuSign Integration documentation.

History Dashlet

The History dashlet allows users to view a history of the record's related activities (e.g., calls, meetings, emails) that have already taken place. The activity types are broken up into three tabs (Meetings, Emails, Calls) and a number on each tab indicates the relevant count of historical activity records. You can also filter (Last 7 Days, Last 30 Days, Last Quarter) the History dashlet to only display a specific subset of the activities meeting the set time frame.

Clicking the Plus icon on the upper right of the dashlet displays the Archive Email option which allows users to manually enter received emails for historical purposes. An explicit relationship is formed between an archived email and the current record while implicit relationships are also created to other records based on any email addresses entered in the email. Simply enter the required information (e.g., Date Sent, From, Subject) along with the email body in the Compose Email window, then click "Archive" to save the email record. Please note that the archived email will display in the record's Emails subpanel as well as in the History dashlet. The Gear icon to the right of the Plus icon allows you to edit, refresh, close, and remove the dashlet accordingly. To collapse the dashlet, click the Gear icon then select the Close option. To expand the dashlet, you can simply click the Gear icon again and select "Open".

Hovering over the linked call, meeting, or email subject will display a Focus icon, which can be clicked to open the focus drawer. In addition, there are two buttons on the upper right of the History dashlet which allow you to toggle between viewing the record's activities assigned to you and activities assigned to users in other teams. You can click the one-person button to quickly view the record's calls, meetings, and emails for which you are the owner. To view the record's activities for all users on your team, simply click the group button to the right of the one-person button.

Inactive Tasks Dashlet

The Inactive Tasks dashlet allows users to view tasks that are on hold or have already been completed. The dashlet is broken up into two tabs, "Deferred" and "Completed", and displays a number on each tab to indicate the count of tasks falling into each status.

When placed on a user's Home page dashboard, the Inactive Tasks dashlet will show all inactive tasks assigned to the logged-in user or all inactive tasks that the logged-in user has team permission to view, depending on how the user has configured the dashlet's settings.

When the Inactive Tasks dashlet is placed on the record view for a related module (e.g., Accounts, Contacts), it will only show the inactive tasks that have a relationship with the current record. For example, if the Inactive Tasks dashlet is placed on the Account module's record view, when a user views ABC Account, the Inactive Tasks dashlet will only show the inactive tasks that are related to ABC Account.

When the dashlet is on a record view dashboard, you can delete the task's relationship with the record by clicking the Unlink button on the task's row. 

To access a task's record view, simply click the task's subject in the dashlet. You can also hover over the linked task subject and click the Focus icon to open the focus drawer, which displays a 360-degree view of the linked record through a set of dashlets containing pertinent information. There are two buttons on the upper right of the Inactive Tasks dashlet which allow you to toggle between viewing tasks assigned to you and all tasks to which you have access. You can click the one-person button to quickly view task records for which you are the assigned user. To remove this filter and view tasks assigned to others as well as yourself, simply click the group button to the right of the one-person button. You can also relate new tasks to the record by clicking the Plus icon on the upper right of the dashlet and selecting "Create Task". Complete the Tasks record view layout and save it to create the new task. The Gear icon to the right of the Plus icon allows you to edit, refresh, close, and remove the dashlet. To collapse the dashlet, click the Gear icon then select the Close option. To expand the dashlet, simply click the Gear icon again and select "Open". 

Knowledge Base Search Dashlet

List View Dashlet

The List View dashlet enables users to view a filtered list of records belonging to a specific module (e.g., Accounts, Contacts, Leads). When configuring the dashlet, simply select the primary module (e.g., Accounts, Contacts, Leads) you wish to view a list of records for along with the filters (e.g., columns, display rows) you wish to apply. Please note that the dashlet title (e.g., My Accounts, My Contacts) will vary based on the primary module selected when adding the dashlet. Certain modules (e.g., Accounts, Contacts, Leads) in Sugar display the List View dashlet by default in their list view's intelligence pane. For example, if you navigate to the Contacts list view, the My Accounts dashlet will appear in the intelligence pane dashboard.

Once added, you can configure the dashlet as necessary by clicking the Gear icon on the upper right if you wish to change the designated module for the dashlet, apply predefined or custom filters, etc. Please note that any changes made by the administrator to the List View layout in Studio affect the list of available fields in the module's list view dashlet layout. The deployed changes will not display automatically in the corresponding module dashlet and users will need to edit the dashlet in order to view the changes in the Columns field, add new fields to the layout, etc. For more information on editing the List View layout in Studio, please refer to the Studio documentation in the Administration Guide.

The following are the most common options available when filtering and configuring the list view dashlet:

• Title: Change the displayed name of the dashlet.
• Module: Change the module that the dashlet is displaying records from by selecting a different module from the list.
• Columns: Choose the field columns you wish to display on the dashlet. To remove a field column, simply click the "x" to the right of the field name.
  Note: The field columns available to add to the dashlet are based on the specified fields in the List View layout in Studio. Any changes made to the List View layout in Studio will be reflected in the Columns field. For more information on configuring the List View layout, please refer to the Studio documentation in the Administration Guide.
• Freeze First Column: Specify whether or not the first column of the list should remain visible when scrolling horizontally within the dashlet. Note that an admin can disable this feature for the whole Sugar instance. See the User Interface page for details on column freezing and the System page for details on the system-wide admin setting.
• Display Rows: Specify how many rows or results this dashlet will display at once. Please note that the maximum is twenty rows.
• Auto Refresh: Choose a time frame to have the dashlet query automatically refresh.
• Filter: Click the Filter option to select a pre-defined filter or create a new filter to be applied to the List View dashlet.
  Note: The My filter (e.g., My Accounts) is selected by default.

The following are options that are only available when configuring a list view dashlet on a record view:

• Relate to current record: Specify if the dashlet will be filtered to only list records related to the record you are viewing.
• Linked field: This field is shown only when "Relate to current record" is enabled; the dropdown will display all of the fields in the selected module that link back to the current record. In most cases, there will only be one field listed, but there are a few exceptions. For example, a Quotes list view dashlet on the Accounts record view can link to quotes where the account is either the billing account or the shipping account. Specify which of these account fields should link to the current record.

Creating a Filter

The Filters section of the Configuration Options page allows you to filter your dashlet based on pre-defined filters (e.g., My Favorites, Recently Created) as well as create custom filters. For example, if you select "My Contacts" in the Filter options, the List View dashlet will only display contact records that are assigned to you. To see all records to which you have access, simply select the All option in the filter.

The following Filter options are available to filter the List View dashlet:

• Create: Create a new custom filter that you can use to filter the List View dashlet
• All "Module": Select this filter to display all records in the module to which you have access
• My Favorites: Select this filter to only display records you have marked as favorites
• My "Module": Select this filter to only display records assigned to you
• Recently Created: Select this filter to only display records you created in the module within the last 7 days
• Recently Viewed: Select this filter to only display records you have viewed in the module within the last 7 day

Users can also create new filters via the Create option in the Filter list. This allows users to add custom, complex filter options when filtering the List View dashlet. You have the option to add multiple fields to your new filter by clicking the Plus button to the right of the filter selection dropdown lists. Please note that each one of the filter's criteria needs to be true for a record in order for it to appear in the List View dashlet. The fields available to filter the dashlet are based on specified fields in the Search layout in Studio. Any changes made to the Search layout in Studio will be reflected in the filter's field dropdown list. For more information on configuring the Search layout, please refer to the Studio documentation in the Administration Guide.

The following steps cover creating a new filter for contacts assigned to Will Westin as an example:

1. Click the Filter option on the Configuration Options page then select "Build Filter".
2. Select the field (e.g., Assigned to) you wish to add to your filter as well as the condition (e.g., is) and matching criteria (e.g., Will Westin).
   Note: Only fields you have view access for will be available to add to the Filter list.
3. To add additional fields to the new filter, click the Plus button to the right of the filter.
   • To remove fields from the new filter, click the Minus button to the right of the filter.
   • To clear any filter values (e.g., Will Westin), simply click the "x" to the right of the value.
   

4. Enter a name for the new filter (e.g., "Contacts assigned to Will Westin").

5. Click "Save" to add this filter to the dashlet list view's Filter options.
   

The custom filter will automatically be applied to the dashlet upon saving and all records meeting the filter criteria will display. Please note that you can edit the custom filters at any time by selecting the filter (e.g., Contacts assigned to Will Westin) from the Configuration Options page, then clicking the name that appears to the right of the Filter option. Simply make the necessary changes to the custom filter then click "Save" to preserve and apply the changes to the dashlet.

When viewing the List View dashlet, the first set of records meeting the filter criteria will be displayed, and you can use the pagination controls at the bottom of the dashlet to navigate to different pages of results. The number of records per page depends on the display row number (5, 10, 15, 20) selected in the Configuration Options page. See the User Interface documentation for details on the pagination controls in different list views.

Steps to Edit a Dashlet

Every user can configure their dashlet(s) to only display the information they wish to view via the display options and filters available in the Configuration Options page.

The following steps cover updating the title, display rows, columns, and only my favorites filter for the My Accounts dashlet as an example:

1. Click the Gear icon at the top of the My Accounts dashlet menu bar then select "Edit".
   
2. Change the "Title" (e.g., My Favorite Accounts) and the display rows from 5 to 10.
   
3. Click the "x" next to "Billing Country" to remove the field from the display column.
   • To add columns, simply click your mouse in the Columns field then select from the list of available fields that appear below the dropdown list.
   
4. Click the Filter option then select  "My Favorites".
5. Once the update is complete, click "Save" and the dashlet will reflect the changes made.
   • Click "Save" on the dashboard's edit layout to apply the changes to your final dashlet view.
   

Multiple List View dashlets can be added to the intelligence pane as well if you wish to view the list of records for various modules. For more information on adding dashlets, please refer to the Dashboards and Dashlets page. You can also refresh and remove the dashlet by clicking the Gear icon. To collapse the dashlet, simply click the Up arrow to the left of the Gear icon.

Maps Dashlet

The Maps dashlet is available for list view and record view intelligence panes. When it is used on a list view intelligence pane, the dashlet displays pins for the geocoded records in the current list.

On a record view when the record is geocoded, the dashlet displays the location of the geocoded record.

When adding a dashlet to your dashboard, you can set the default map type and zoom level. The Map Type can be “Road” (display roads and some topographical shading), “Aerial” (satellite imagery), or “Dark Road” (dark mode of the Road style). 

For information on how to interact with the options in the map interface, as well as general information on using maps in Sugar, refer to the Sugar Maps documentation.

My Activity Stream Dashlet

The My Activity Stream dashlet displays the user's main Activity Stream within a dashboard, eliminating the need to navigate to the Activity Streams view to monitor the most recent stream activities. Like other Activity Stream views, the dashlet supports inline commenting on specific stream activities, but it does not allow record previews. For more information on Activity Streams, please refer to the Activity Streams documentation.

Note: Activity Streams are disabled by default. If you cannot access activity streams, the feature may be enabled via Admin > System Settings. For more information, refer to the System documentation in the Administration Guide.

The Gear icon on the upper right of the dashlet allows you to edit, refresh, and remove the dashlet accordingly. To collapse the dashlet, click the Up arrow to the left of the Gear icon. To open up the dashlet, you can simply click the arrow again.

When added to an Intelligence Pane, the My Activity Stream dashlet will display stream items in context to the data within the main container of the page. For example, if you add the dashlet to a dashboard on the main Accounts module page, the main container of the page contains the Accounts list view. Therefore, the My Activity Stream dashlet will restrict activity stream items to only those activities related to the Accounts module. Similarly, if the dashlet is added to the Opportunity module's Intelligence Pane, the My Activity Stream dashlet will restrict activity stream items to only those activities related to the Opportunities module. If the My Activity Stream dashlet is added to any record view's Intelligence Pane dashboard, the dashlet will restrict activity stream items to only those activities related to the record displayed in the main container on the page.

To filter the My Activity Stream dashlet, edit the dashlet and click once on the Filter button. Choose any of the pre-defined Activity Stream filters, such as "Messages for Post", which will restrict the stream to only items that were posted by users, and then click "Save". For more information on Activity Stream filters, please refer to the Activity Streams documentation.

It is good practice to also rename an edited dashlet accordingly so that it is clear that this dashlet is displaying a filtered view. To change the dashlet's title, edit the dashlet, type a new name into the text box that contains the words "My Activity Stream", and then click "Save". 

To add a comment or reply to the Activity Stream via the My Activity Stream dashlet, click on the Comment button next to the relevant stream entry, type your reply, and then press the Reply button. For more information about interacting with Activity Streams, please refer to the Activity Streams documentation.

Notes & Attachments Dashlet

The Notes & Attachments dashlet allows users to relate an existing note as well as a new note record to the module record. To create a new note, click the Plus icon on the upper right of the Notes & Attachments dashlet then select "Create Related Record". Once the Notes record view layout opens, enter the necessary information then click "Save". For more information on creating notes, please refer to the Creating Records section of the User Interface documentation. To relate an existing note, click the Plus icon then select "Link Existing Record". The Search and Select Notes page will open allowing you to select the note record you wish to relate to the module record.

To delete the record's relationship to a note record, click the Unlink button to the right of the attached note post. Please note that this removes the relationship, but does not delete the record itself.

The Gear icon on the upper right of the dashlet allows you to edit, refresh, close, and remove the dashlet accordingly. To collapse the dashlet, click the Gear icon then select the Close option. To open up the dashlet, you can simply click the Gear icon again then select "Open".

Organization Chart Dashlet

The Organization Chart dashlet illustrates the reporting structure of your organization as determined by the Reports To field in the employee records. You will only see the users who report to you and the users who report to them (i.e., two levels of employees). Click on the tile of an employee to be taken to the employee record or the minus icon on the tile to collapse their reportees' tiles.

The icons along the top of the dashlet allow you to perform the following actions:

Option	Description
	Choose a user to focus the chart on. Names with a folder icon next to them have employees reporting to them; you can click their names to reveal the reportees' names.
	Zoom in and out on the chart.
	Change the orientation of the organization chart from top to bottom to left to right.
	Display all name tiles.
	Fit the organization chart to the dashlet size.

Planned Activities Dashlet

The Planned Activities dashlet provides users with a list of open or upcoming calls and meetings that are related to the current record you are viewing. The activity types are broken up into two tabs (Meeting and Calls) and a number on each tab indicates the relevant count of planned activity records. You can filter the dashlet to view either the current day's scheduled activities or upcoming activities in the future by toggling between the Today or Future button. Please note that any open activities where the start date is prior to the current date will display an Overdue status for the specific activity in the dashlet. Once the activities have taken place or are completed, they will appear within the History dashlet.

Note: Hovering over the linked call or meeting subject in the dashlet will display a Focus icon, which can be clicked to open the focus drawer.

In addition, there are two buttons to the right which allow you to toggle between viewing the record's scheduled activities assigned to you and activities assigned to users in other teams. Please note that you can use both sets of buttons (Today, Future, one person, group) concurrently to further filter and view the information you need. For example, you can click the one-person button plus the Future button if you wish to view all upcoming activities specifically assigned to you for the current record.

To create a new meeting or call, simply click the Plus icon on the upper right of the dashlet and select either "Schedule Meeting" or "Log Call". Once the Meeting or Call record view layout opens, enter the necessary information and click "Save" to create the activity. For more information on creating calls and meetings in Sugar, please refer to the Creating Records section of the User Interface documentation.

The Gear icon on the upper right of the dashlet allows you to edit, refresh, close, and remove the dashlet accordingly. To collapse the dashlet, click the Gear icon then select the Close option. To open up the dashlet, you can simply click the Gear icon again and then select "Open".

To the right of the meeting and call record's row is a set of buttons that allow you to mark the activity as held, delete the call or meeting's relationship with the current record, as well as accept, tentatively accept, or decline the call or meeting. 

Processes Dashlet

From the Processes dashlet, you can view running processes if there is anything for you to approve or review, in addition to any self-service processes waiting to be claimed in the Self Service Processes tab. All users who may be engaged in a process should place the Processes dashlet on their home screens. Process users will not receive an email notification when an activity is ready for them (unless the administrator has explicitly configured this within the process definition). The dashlet makes it easy for users to know when it is their turn to participate in a process and to take the appropriate action.

Note: Users (including administrators) will see only the processes that immediately require their attention in the Processes dashlet.

After saving the dashlet and its containing dashboard, the dashlet will offer several Processes-specific filtering tools:

• Current: Click on this button to view processes that are running within the expected timeframe.
• Overdue: Click on this button to view processes that have a due date in the past. The label "Overdue" and the due date will be displayed adjacent to the Process description.
• My Processes: Enable this tab to view only the running processes upon which the logged-in user must act. To execute the Process, click on the name of the process. Please note that admin users can not see processes running for other users via the dashlet. To access the system's exhaustive list of running and completed processes, please refer to the Process Management section of the Administration Guide.
• Self Service Processes: Enable this tab to view only the running processes in the queue to be claimed by a user. Self-Service processes are configured inside the User Activity element settings of the related process definition.
• Process Description: Running processes are displayed in list view format with descriptive fields including the unique process number, the name of the affected Sugar record, the process title, the responsible user's name, and the label of the relevant process step.
• Due Date: When a due date exists it will appear adjacent to the process description.

For additional information about executing processes, please refer to the Processes documentation

Product Catalog Dashlet

The following sections explain the various features and components of the Product Catalog dashlet.

Note: The Product Catalog records must be created before users can select products when adding line items. The Product Catalog, Product Categories, Product Types, and Manufacturers modules are accessible by all users. For more information on adding and modifying products in the product catalog, please refer to the Product Catalog documentation. When you select an item from the Product Catalog dashlet, the line item's tax class, cost, and manufacturer information will be pre-filled by values set by your administrator and therefore cannot be edited.

Viewing Products and Categories via Dashlet

In the Product Catalog dashlet, product categories are represented as folders and are organized to reflect the structure of the customer's category hierarchy. Users can search for products and categories and click on individual folders to reveal the products contained in each category. To close an expanded category folder, click on the open-folder icon.

Note: Only products with a status of "Active" are displayed in the Product Catalog dashlet.

Searching for Products and Categories via Dashlet

Users can also search for products with an active status using the Search field on the Product Catalog dashlet. Upon entering a search term, a list of matching product categories and matching products will be shown in the dashlet. If the user clicks on a category (e.g., a folder) in the list of search results, all products in the category are loaded, not only the products that match the search terms.

Previewing Products via Dashlet

Click on the Preview icon to the right of a product name to view the complete details of its Product Catalog record. After clicking the icon, the record's detail view opens. Click "Cancel" to close the Product Catalog record's details.

Favoriting Products via Dashlet

For products in the product catalog that you use often and would like easier access to, you can mark the product as a favorite when viewing the details of the record. Simply click the star icon to the right of the product's name in the upper left of the record view to designate it as a favorite. If you wish to remove the product as a favorite, click the star again to revert it to white. To close the product catalog record's details, simply click the Cancel button. After a product is marked as a favorite, it will appear under the Favorites tab of the Product Catalog Quick Picks dashlet.

Purchase History Dashlet

• A one-to-one or many-to-one relationship to the Accounts module
• A relate field targeting the Accounts module

The dashlet shows all of the current account's purchases regardless of the start or end date of the purchase record. The dashlet shows each purchase's name, date range, quantity, and total. Clicking the purchase name takes you to the purchase record view. The number of purchased line item records related to the purchase is shown above the total and can be expanded or collapsed to display or hide the purchased line item records. When expanded, the purchased line item records are displayed with their respective date ranges, quantities, and line item totals. Clicking the date ranges takes you to the purchased line item record view.

Note: You can hover over the linked purchase name or date (for purchased line items) and click the Focus icon to reveal the focus drawer dashboard, which displays a 360-degree view of the linked record through a set of dashlets containing pertinent information.

Searching and Sorting Purchase Records

The purchase records displayed in the Purchase History dashlet can be searched and sorted to make records easier to find. Search and sort can be used separately or together and will be applied to all of the related account's purchases, not only those visible in the dashlet's default view.

The dashlet search bar uses a partial string match, meaning it will return records that contain the letters you type anywhere in the name, and displays matching results as you type. For example, searching for the string "widget" would return both "Camping Widget" and "Fishing Widget". To clear the search results, click the "x" in the right side of the search bar.

When sorting the records, you have the option to sort by the following:

• Date (Last Purchase): The default sort order that displays purchases in descending order based on the value in the purchase's End Date field.
• Date (First Purchase): Displays purchases in ascending order based on the value in the purchase's End Date field.
• Price (Highest Total): Displays purchases in descending order based on the value in the purchase's Total Revenue field.
• Price (Lowest Total): Displays purchases in ascending order based on the value in the purchase's Total Revenue field.

Record View Dashlet

Working in the Dashlet

The Record View dashlet uses a tabbed view to allow users to see the current record view and records related to the one they are viewing. Users can configure up to six dashlet tabs including the current module (e.g., This Account) and related modules (e.g., Contacts). To open a different tab, click the name of the tab across the top. Depending on the nature of the relationship, you will see related record(s) as either a detailed record view or a list view layout.

Note: Hovering over links to Sidecar module records (e.g., contacts, emails, calls) in the dashlet will display a Focus icon, which can be clicked to reveal a focus drawer.  

Single Record View

The single record view in the dashlet displays a detailed view of an individual record. This can be either the current record or a related record if the modules have a one-to-one or many-to-one relationship (i.e., there is only one possible related record to show). When viewing a single record tab, it can be edited directly in the dashlet by clicking an individual field or clicking the Edit button. Once you are done editing, click the Save button to preserve your changes. Additionally, an Actions menu is available in the Record View dashlet for modules that can be escalated (e.g., Accounts). For more information, refer to the Escalations documentation.  If you wish to access the record's full-page record view, simply hover over the record's name in the single-record Record View dashlet tab, and click the arrow icon that appears to navigate to the record.

Related Records List View

If the current record may be related to many records in the dashlet's selected module (i.e., one-to-many and many-to-many relationships), a list view is displayed even if there is only one related record to show. When viewing a list of related records, records can be edited directly in the dashlet by clicking on the Edit button that appears to the right when hovering over the record or by double-clicking the row.

You can make in-line edits to the records and click the X icon to discard your changes or the Check icon to save your changes.

Configuring the Dashlet

To configure the tabs on the dashlet, click the Gear icon in the top right corner and select "Edit". On the screen that opens, you can specify which tabs you would like displayed in the dashlet by selecting the desired modules in the Tabs field on top. The first option will start with the word "This" and represents a record view tab of the record currently in focus. When applying the dashlet to a record view, it is recommended to remove the "This..." tab so that information is not duplicated on the screen and a related records tab can be shown first. Click the Tabs field to select more tabs or click a tab's X icon to remove it. Beneath the Tabs field, a preview of the dashlet is available. Clicking each tab allows you to view how the tab will be displayed and, for list view tabs, allows you to configure the tab. You can specify which columns to display, how many rows to display, and how often the list view data should be automatically refreshed. Tabs showing a single record cannot be configured in the dashlet as they are controlled by the module's Record View Dashlet layout which can be configured by admin users via Studio.

Report Dashlet

The Report Dashlet allows you to view your reports from any dashboard in Sugar. When adding a Report Dashlet, you can select any report to which you have access. Summation-type, summation with details-type, and matrix-type reports can be viewed as a chart or data table, while a rows and columns-type report can be viewed only as a data table.

When adding the Report Dashlet, you must first select your desired report via the Select a Report option on the General tab. You can either type the first few characters of the report's name and select from the type-ahead results or click "Search and Select..." below the search box to select your desired report from the Search and Select Reports drawer.

In addition, the following configuration options allow you to define how the dashlet will display. The available configuration options may vary slightly between the report types.
Note: Any time the originating report is modified, the dashlet's configurations are reset to the default values for all users and a notice is displayed the next time the dashlet is refreshed.

The General tab has controls for which report is displayed, the default view, and the refresh rate:

• Select a Report: The report to display. Type in the field or use the Search and Select Reports drawer to select a report.
• Default selected view: The default visible tab (Chart, Data Table, Filter) of the dashlet. The selected view is visible whenever the page with the dashlet is refreshed or you select "Reset to Dashlet Defaults" or "Refresh Results" from the dashlet's three-dots menu.
• Auto Refresh: The time frame (e.g., Every 30 Minutes) for the dashlet query to automatically refresh.
• Related to current record: Available only when the dashlet is on a record view or focus drawer dashboard. Filter the dashlet based on the currently-displayed record. Checking this box will reveal the Linked field dropdown for you to choose which relationship to use.
• Linked field: Choose the linked field or module subpanel to use to filter your dashlet report.

The Chart tab has options that control the look of the chart (if available for the chosen report). If the report you chose does not contain a chart (e.g., a rows and columns-type report), this tab is disabled. The Chart Preview on the right side shows how the options you choose affect a generic report (i.e., the data from your report is not displayed).

• Chart type: The type of chart (e.g., Pie Chart, Funnel Chart) to display.
  • The chart type defaults to the chart type defined in the originating report. 
  • The available chart types may vary between reports.
  • For more information on chart types, please refer to the Reports documentation.
• Options: Enable the appropriate options based on how you want to display data on the chart.
  • Primary Chart Sort Order: The chart's sort order. Use the buttons next to the dropdown to choose whether to sort ascending or descending. The options are either the first group-by field listed in the Define Group By step of the Report Wizard or the first summary function (e.g., Count, SUM) listed in the Choose Display Summaries step (matrix, summation, or summation report with details report type) of the Report Wizard. Click the i icon next to the dropdown to view the field's location.
  • Secondary Chart Sort Order: Available only for bar charts with more than one group-by field. You can choose whether to use the second group-by field listed in the Define Group By step of the Report Wizard.
  • Bar chart value placement: Select where the chart values (e.g., End, Middle) will be positioned for bar-type charts.
• Labels: Enable the appropriate options based on how you want to display the labels and legend on the chart.
  • Show total: Enable the checkbox to display the report's total value on the dashlet.
    • The total value in the report chart dashlet dynamically updates to display the total as reflected in the originating report.
  • Show legend: Enable the checkbox to display the full chart's legend on the dashlet.
  • Show y-axis label: Enable the checkbox to display the chart's y-axis title on the dashlet.
  • A title from the originating report will populate automatically, but you can specify a different title for display in the dashlet by entering a new value in the open text box.
  • This option only applies to bar charts and line charts.
  • Show x-axis label: Mark the checkbox to display the chart's x-axis title on the dashlet.
  • A title from the originating report will populate automatically, but you can specify a different title for display in the dashlet by entering a new value in the open text box.
  • This option only applies to bar charts and line charts.

The Data Table tab has options that control the sort order and display of the data table. The Data Table Preview on the right side shows how the options you choose affect a generic report (i.e., the data from your report is not displayed).

• Sort Order: The data table's sort order. Use the buttons next to the dropdown to choose whether to sort ascending or descending. The default option is the sort order of the originating report. The options are the columns listed in the Choose Display Summaries step (matrix or summation report type) or the Choose Display Columns step (summation report with details and rows and columns report type) of the Report Wizard. The sorted column has a blue background on the dashlet.
• Rows display limit: The number of rows to display in the data table. This option is available only for rows and columns-type reports.
• Show total record count: Enable the checkbox to display the data table's total record count on the dashlet.

Once the dashlet is added, click the Gear icon on the upper right to edit or remove the dashlet as necessary. To collapse the dashlet, simply click the Up arrow to the left of the three-dots menu icon. 

Use the three-dots menu in the upper right of the dashlet to access the following actions:

• View Report: Open the report in the Reports module.
• Reset to Dashlet Defaults: Reset the dashlet sorting and filters to those defined when configuring the dashlet. This action resets only the current dashlet. If the dashlet is on a shared dashboard, another user's dashboard is not affected.
• Refresh Results: Refresh the report results.
• Download Chart: Download the chart image as a PNG file. The file will be named with the report name, your name, and the download date and time.

When viewing the report dashlet, use the chart (if available), table, and filter icons in the top left to toggle between the tabs. Any changes you make in these tabs are unique to your dashlet on the current dashboard. If the dashlet is on a shared dashboard, another user's dashboard is not affected.

On the chart tab, you can click the colored circles in the chart legend to toggle whether or not that segment appears in the chart. Users can also drill through to view a list of records associated with a particular chart section by clicking on the section. For more information about drilling through report charts, please refer to the Reports documentation.

You can use the data table tab to view and change the sorting of your data table. Click the column headers to change which column is sorted. Click the header again to change the sort direction of the column. Use the three-dots icon in the last column of the table to choose whether to freeze column 1. If available, you can drill into the data table using the hyperlinked text. Note that if your report is large, you may need to choose whether to view a simplified table or export the results as a CSV. Refer to the Reports documentation for more information.

The filter tab shows the run-time filters on the current report. You can modify the filters on this tab but you cannot add new ones. Click the Open/Close arrow in the top right corner of each run-time filter and then edit the filter as desired. Click the Apply button to apply any changes you have made.

When a Report dashlet is added to a Home dashboard, dashboard filters allow you to control the run-time filters on many dashlets at once. Please refer to the Dashboards and Dashlets documentation for more information.

RSS Feed Dashlet

The RSS Feed dashlet allows you to view external RSS or Blog feeds via the dashboard on the intelligence pane. When adding the dashlet, you will need to enter in the desired feed URL (e.g., "https://news.google.com/news/headlines/section/topic/TECHNOLOGY?ned=us&hl=en&gl=US") in the Feed URL field. You can also select a value in the "Number of entries to show" field to display the most recent 5, 10, 15, or 20 entries from the feed and specify an auto-refresh interval (e.g., Every Hour) if desired. Once the dashlet is added to the intelligence pane, the applicable feeds will display and you can click the title of each feed to access the full story on the parent site. If you wish to access the full site where the RSS feeds originate from, simply click the title (e.g., Technology - Google News) below the dashlet header.

The Gear icon on the upper right of the dashlet allows you to edit, refresh, and remove the dashlet accordingly. To collapse the dashlet, click the Up arrow to the left of the Gear icon. To open up the dashlet, you can simply click the arrow again.

Smart Guide Momentum Dashlet

Sugar Automate's Smart Guide Momentum dashlet is available only on the record view dashboard for Smart Guide enabled modules. The dashlet offers an alternative, gauge-chart view of the Momentum Bar, which represents how efficiently a smart guide is moving toward completion based on the expected time-to-complete that has been defined for each activity. If the administrator has not assigned any momentum point values to the activities in your smart guide, the Momentum Bar will always display a 100% momentum value.

Keep in mind that the Momentum dashlet will not always show a 100% value for completed smart guides. Once a smart guide loses momentum points, the points cannot be recovered, permanently impacting the overall momentum of the active smart guide. 

Note: If a user adds activities or stages to an active smart guide, that smart guide's momentum point value will adjust accordingly.

For more information on progress and momentum, please refer to the Sugar Automate documentation in the Administration Guide. For detailed information on using Smart Guides in Sugar, refer to the Sugar Automate documentation.

Smart Guide Progress Dashlet

Sugar Automate's Smart Guide Progress dashlet displays a pie-chart summary of the current record's smart guide in the intelligence pane.

For more information on progress and momentum, please refer to the Sugar Automate documentation in the Administration Guide. For detailed information on using Smart Guides in Sugar, refer to the Sugar Automate documentation.

Sugar Automate: Smart Guides (Focus Drawers & Console) Dashlet

Users with access to Sugar Automate can view active smart guides for their accounts, cases, or opportunities on the Case Detail drawer on the Service Console and the Account Detail drawer and Opportunity Detail drawer on the Sales Console. You can also add a dashlet to the Focus Drawer dashboard for Smart Guide enabled modules.

To add the Smart Guide dashlet to a console, follow these steps:

1. Navigate to the Case, Opportunity, or Account tab on the Service or Sales Console.
2. Click on a record in the list and view the detail drawer for that record.
3. Expand the floating actions button and select "Add Dashlet".
4. Select the "Smart Guide - FocusDrawer & Sell/Serve Console Dashlet" from the available dashlets and then click "Save".

To add the Smart Guide dashlet to a focus drawer dashboard, follow these steps:

1. Locate a link to a record (e.g., the account name) for which the module (e.g., Accounts) has Smart Guides enabled.
2. Expand the focus drawer by clicking on the Focus icon.
3. Click on Add Dashlet in the floating actions button.
4. Select "Smart Guide - FocusDrawer & Sell/Serve Console Dashlet" from the available dashlets and then click "Save".

Sugar Hint Insights Dashlet

The Sugar Hint Insights dashlet displays breaking news for accounts as configured in the Hint Insights Preference Center and can be added to any list view, record view, or Home dashboard. If you do not have a Hint license but are viewing a dashboard where the dashboard owner has added the Sugar Hint Insights dashlet, you will see the dashlet but be unable to access the content. If you do have a Hint license, you can add the dashlet and update your Hint Insights preferences before saving. Once the dashlet is added and new stories are displayed in it, click any headline to open the full article in a new window or scroll down to load additional stories.

The dashlet is one of several ways in which Hint Insights can notify you of breaking news; other options include desktop notifications and email. Once you have configured your Hint Insights preferences to show stories in the dashlet, they will begin to appear as they are released. This means that the dashlet only shows stories starting from the moment you turn on the setting. While the setting is enabled, the dashlet is continuously refreshed.

Note: The dashlet is not context-sensitive and always shows the same content regardless of where it is located. In addition, the content may not match that of the News section of the Sugar Hint panel because the Hint Insights service only includes breaking stories released after setup.

If a new story is released while you are scrolled down in the list, a notification will appear in the dashlet briefly. Clicking the notification returns you to the top of the list where the new story has been added.

The stories can be searched by entering a keyword into the text field in the top right corner and pressing Return or clicking the Search button. The stories with headlines containing the keyword you searched will be displayed, including those not currently loaded in the dashlet. Please note that the dashlet only displays stories that were released after you enabled dashlet notifications for the relevant accounts. To clear a keyword search, click the X button that appears.

The gear icon to the right of the search field opens a dropdown menu with options for managing the dashlet. Choosing "Edit" navigates to the Hint Insights Preference Center where you can configure your notification preferences for news stories related to accounts, including what you see in the Sugar Hint Insights dashlet.

When using a shared dashboard with the Sugar Hint Insights dashlet on it, the gear icon is not displayed. However, you can access the Hint Insights Preference Center from the gear icon on the Sugar Hint panel's News section instead. Using a shared dashboard containing the dashlet does not affect your preferences.

For more information on Sugar Hint and the Hint Insights Preference Center, refer to the Sugar Hint documentation.

Timeline Dashlet

Note: The Timeline dashlet was known as the Interactions dashlet in Sugar versions 11.0.x and lower.

Note: The relationship must be visible in Navigation Bar and Subpanels and additionally enabled in Studio > {Module} > Timeline for the card to appear in the timeline. Having several relationships enabled for the Timeline dashlet may cause performance issues; if this happens, please disable some module(s). For further information, please see the Studio documentation.

You can filter the Timeline dashlet to show only certain card types by clicking on "Related" below the dashlet header and selecting the desired card type. To see all the current record's related activities and select field updates, select "All" in the Related options. Next to "Related", a search bar allows you to search for specific activities in the timeline using the same search functionality available in list view. To learn more, please see the Search documentation. 

When you hover over a card, an Actions menu, represented by three vertical dots, appears and contains additional options for each type of record card. Nearly all cards allow you to unlink the record (i.e., delete the relationship). Additionally, when hovering over most record names, you can click a Focus icon to view more data about a specific record.

When you hover over the Timeline dashlet's header, you will see four icons to create activities, refresh the timeline, collapse the dashlet, and access the settings.

The different record cards, their content, and the date the card is sorted by are described below. In addition, you may see cards representing updates to specific fields. See the Understanding Field Updates section for the list of fields that are tracked in this way.

¹ This module is only in Sugar Enterprise and Sugar Sell.
² This module is only in Sugar Serve. 
³ For instances with call transcripts set up, add the Customer Sentiment field to the preview layout for the Calls module in order to display the information on the Call card.
⁴ Message cards are only shown in the Timeline dashlet if the Start Date field is populated on the message.

Understanding Field Updates

When select module fields are updated, you will see an update card in the Timeline dashlet that will alert you to what has changed, including the previous field value and the new value. For example, if the Office Phone field is updated on an account, you will see an update card showing the old and new phone numbers. The field must be enabled for audit at the time the update occurs for it to appear in the Timeline dashlet. Additionally, please note that not all modules have field updates. For Information on enabling fields for audit, please see the Fields documentation.

The following table details the fields that will populate update cards if they are enabled for audit:  

¹ This module is only in Sugar Enterprise and Sugar Sell.
² This module is only in Sugar Serve. 
³  This is a Sugar Market module.
⁴ This is a SugarPredict field, found only in Sugar Sell Advanced and Premier. SugarPredict Predictive Insight must be enabled for changes to be seen in the timeline.

Creating Activities via Timeline

You can create new activities (i.e., records) directly from the Timeline dashlet by clicking the plus (+) sign in the dashlet header and selecting the type of record you wish to create. A quick-create drawer will open where you can enter the activity's details; the new activity will be automatically related to the originating record and the timeline will refresh to show the newly created activity.

Refer to the Calls, Emails, Messages, Meetings, Tasks, and Notes documentation for more information on creating these records.

Editing Timeline Card Layouts

The Preview layout in Studio can be used to make certain changes to the Timeline card layout. Specifically, an administrator can remove a field from a Timeline dashlet card by removing the field from the Preview layout for the card's module via Admin > Studio > {Module} > Layouts > Preview. Please be aware that you cannot add any fields to the Timeline dashlet, with the sole exception being the Customer Sentiment field in the Calls module. For more information on editing the Preview layout, please refer to the Layouts documentation in the Administration Guide.

The modules displayed in the Timeline dashlet are set on a per-module basis, and only ten modules can be enabled at once. Admins can enable the relationships in Studio > {Module} > Timeline. 

Timeline Dashlet with Sugar Market

If your Sugar instance is integrated with Sugar Market, you can configure the Sugar Market sync settings to show the full customer journey in the Timeline dashlet on Account, Lead, and Contact record view dashboards. The Sugar Market activities will be chronologically juxtaposed with the record's CRM activities, offering an uninterrupted view of the entire customer journey. Please refer to the Sugar Market Integration Guide for more information. 

Timeline Dashlet with Custom Modules

Custom modules can be displayed as cards in the timeline as well as having their own Timeline dashlet. The relationships will show different data and field updates depending on if the module was created in Module Builder or via code customization, and depending on the module type. 

Upcoming Exceptions Dashlet

The Upcoming Exceptions dashlet is shown by default on the intelligence pane in the Shifts list view. It lists all enabled shift exceptions that do not occur in the past; this offers the ability to see a summary of upcoming shift exceptions that will impact your employees' working hours. For more information, refer to the Shifts documentation.

Web Page Dashlet

The Web Page dashlet allows users to load content from an external website in Sugar's dashboard. When adding this dashlet, you will need to enter the desired URL (e.g., https://example.com) in the URL field then select the display rows value to define the size of the dashlet. Please note that Sugar will only load content from trusted domains that the system administrator has approved in Admin > Content Security Policy Settings. If you get an error indicating that the content has not been approved, please reach out to your administrator as they will need to update your system's Content Security Policy settings. If the CSP settings get updated while you are logged in to Sugar, you will need to refresh your browser for the changes to take effect in your session.