SugarCRM SupportProduct GuidesSugar Versions10.010.0 UltimateSugar Ultimate 10.0 Application GuideHome

Home

Overview

Sugar's Home page houses the dashboard and activity stream which allows users to view pertinent record information via various dashlets and activity stream posts. Every user in Sugar can configure their dashlets based on the display options and filters available from their dashboard. Users can also personalize their activity stream to only view posts specific to records that are important to them. This documentation will go over the basics of the Home page as well as the various options available to customize the Home page to best fit your individual needs.

Home Module Tab

The Home module tab, represented by the Cube icon, is the first tab on the Sugar navigation bar. Click the Cube icon to navigate to the Home page or click the triangle next to the cube to perform additional actions. The following options are available in the Home module tab's actions menu:

  • Create Dashboard : Create a new dashboard and build out its layout and dashlet set. Refer to the Dashboards and Dashlets documentation for more information.
  • Activity Stream : View your activity stream for all enabled modules. Refer to the Activity Stream section for more information.
  • Manage Dashboards : Access the Dashboards module to share dashboards, pull dashboards to your Home page, etc. Refer to the Dashboards and Dashlets documentation for more information.
  • Dashboards List : Choose one of the available Home page dashboards to view. Admin-designated default dashboards, shared dashboards you have pulled to your Home page view, and personal dashboards you have created will be displayed. For more information, refer to the Dashboards and Dashlets documentation.
    Note: Up to 50 dashboards can be displayed in the Home module tab's menu. 
  • Recent Records : The three records you most recently viewed, from across all Sugar modules, are displayed at the bottom of the menu. Click a record name to navigate to its record view. Clicking "More recents..." will display a fourth record. 

Home HomeModuleTab

Dashboards

Sugar's Home page allows you to build full-page dashboards by combining dashlets and configuring the dashboard layout to suit your business needs. 

Dashboards and dashlets are thoroughly documented in the Dashboards and Dashlets documentation, which covers dashboards both on the Home page and dashboards on list view and record view intelligence panes. Home page dashboards are unique in that they allow the user to split the board into up to three columns. Refer to the Changing Home Dashboard Layouts section below for more information.

Instances that are upgraded from Sugar 6.x to Sugar 7.x will have their legacy dashboards migrated over. Users will be able to view these by selecting "My Legacy Dashboard" from the Sugar cube icon. For more information regarding the legacy dashboard, please refer to the My Legacy Dashboard section.

Changing Home Dashboard Layouts

Users can change the number of columns on their Home dashboards depending on how they wish to view the information. You can organize the dashlets into one, two, or three columns. 

The following steps cover changing a dashboard to display two columns as an example:

  1. Click the triangle next to the Create button then select "Edit".
    Home Dashboards ChangingDashboardLayout Edit2
  2. Select the two-column layout icon on the upper left of the dashboard.
    • The second column will open up to the right of the existing column allowing users to add a new dashlet or move an existing one into it. For more information on adding dashlets, please refer to the Adding Dashlets section of the Dashboards and Dashlets documentation.
    Home Dashboard 2ColumnLayout
  3. Click "Save" once the appropriate changes have been made to the dashboard.
  4. The dashboard will now display the dashlets across two columns.
    Home Dashboard 2Columns

Dashlets

Dashlets reside within the dashboard and provide users with valuable information about their records in Sugar. By default, there are stock dashlets that come out-of-the-box with Sugar and users can easily add them to various dashboards per their viewing preference. Please note that each dashlet can be configured to display the necessary information you wish to view. For more information on configuring the dashlet, please refer to the Editing Dashlets section of the Dashboards and Dashlets documentation.

Commonly Used Dashlets

By default, the "My Dashboard" will display on your Home page and include stock dashlets such as "My Contacts", "Pipeline", etc. Users have the option to add various types of dashlets to each dashboard to view information that is of importance to them. For more information on adding dashlets, please refer to the Adding Dashlets section of the Dashboards and Dashlets documentation.

The commonly-used dashlets are available to use on your Home page:

Dashlet Description
List View Dashlet Enables users to view a list of records for a specific module (e.g. Accounts, Contacts, Leads) in Sugar
Planned Activities Dashlet  Provides users with a list of open or upcoming calls and meetings that are assigned to them
Active Tasks Dashlet  Allows users to view outstanding tasks that require attention and need to be completed on a future or current date
History Dashlet Allows users to view a history of record's related activities (e.g. calls, meetings, emails) that have already taken place
Saved Reports Chart Dashlet Displays charts from your saved or pre-defined reports and allows users to drill through to view associated records
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.
Forecast Pipeline Chart Dashlet Illustrates the flow of open sales opportunities through the various sales stages by displaying the total dollar amounts for open records grouped by sales stage.

Adding Dashlets to Home Dashboards

Additional dashlets can be added by clicking the triangle next to the Create button on the upper right of the dashboard then selecting "Edit". The dashboards edit layout will display open "Add a Row" boxes where you can add new dashlets. For each row you add, you will have the option to select the column (+1 column) and add the desired dashlet. You can select and add from the list of available dashlets (e.g. My Accounts) to the specific column on the dashboard row. For more information on adding dashlets to dashboards, please refer to the Adding Dashlets section of the Dashboards and Dashlets documentation.

Please note that you can add the same dashlet multiple times in the dashboard with different configurations to show different records or information.
Home Dashboard AddARow

My Legacy Dashboard

The user's existing dashboard in 6.x will be migrated over to 7.x upon upgrade and can be viewed via the My Legacy Dashboard on the Home page. The My Legacy Dashboard enables users to view information from their existing 6.x dashlets and allows them to similarly configure dashlets (e.g. My Accounts, My Calls, etc.) that are supported for 7.x in the new dashboard (e.g. My Dashboard). The overall layout of the legacy dashboard will be the same as it was in 6.x, but dashlets such as My Activity Stream, My Project Tasks, and any forecast-specific dashlets will not appear as they are not compatible with 7.x. Please note that the My Activity Stream dashlet does not appear upon upgrade as it is replaced with the new activity stream view on the 7.x Home page. For more information on viewing and managing the activity stream, please refer to the Activity Streams documentation. The legacy dashlets will migrate over with the same configurations applied and will function in a similar fashion. For example, you can close meetings from the My Meetings dashlet by clicking the Close icon, click the Pencil icon next to records in the dashlet to edit via the module's record view/detail view, create new calls/meetings in the My Calendar dashlet, etc.
MyLegacyDashboard1

Simply click the triangle next to the Sugar cube icon and select "My Legacy Dashboard" to view and access your 6.x dashboard. Please note that you will not be able to configure (e.g. change layout, add tabs, add dashlets, etc.) the legacy dashboard, but will be able to modify the existing dashlets by clicking the Edit icon at the top of the dashlet menu bar. This will display the pop-up Options box with various options (e.g. Title, Display Rows, etc.) and filters (e.g. Only My Items, Assigned to, etc.) to make any necessary changes. Unlike 6.x, administrators will not be able to configure the Filters options or the dashlet list view display columns via Admin > Studio as the Sugar Dashlet layout in Studio is not available.

Activity Stream

Sugar's activity stream allows users to view a list of activities performed on records, create posts, preview posts, comment on posts, etc. Users can easily track the most recent updates across their entire organization via the record and user posts on the Home page activity stream. You can also personalize the activity stream by specifying which records' posts you wish to view in the activity stream. Please note that the modules currently enabled to generate record posts for the activity stream are Accounts, Contacts, Leads, Opportunities, Revenue Line Items, Bugs, and Cases. For more information on viewing posts, creating posts, etc. via the activity stream, please refer to the Activity Streams documentation.
Home ActivityStream

Note: If you cannot access activity streams, the feature may have been disabled via Admin > System Settings. For more information, refer to the System documentation in the Administration Guide.

Last modified: 2020-03-11 00:11:43