Sales History Dashlet User Guide
- Todd Hedrick (Unlicensed)
- Simon Hemkes (Deactivated)
Installation
Log into Sugar as a System Administrator User
Open the menu next to your profile picture in the upper right-hand corner and select Admin
On the Administration page, scroll until you find the Developer Tools section, then select Module Loader
From the Module Loader screen press the Choose File button and select the .zip file provided to you by FayeBSG., then after you have selected the file press the Upload button.
In the list of available modules to be loaded, find the item that you just uploaded and press the Install button.
You will be presented information about the End User License and Readme file.
After reading the License, select the Accept option and then press the Commit button to proceed.Once the installation is complete your screen should look similar to the one below
After it displays the 100%/Module Installed Successfully please return the administration screen (repeat step 2)
From the administration screen scroll until you find the System section, then click on the RepairFrom the Repair screen click on the Quick Repair and Rebuild link
Once the Quick Repair and Rebuild is complete you are ready to set the configuration details
Configuration
The configuration details are set from the Administration section.
Log into Sugar as a System Administrator UserOpen the menu next to your profile picture in the upper right-hand corner and select Admin
Scroll down towards the bottom of the Administration screen and click on the link for the FayeBSG Sales History Dashlet Configuration
There are a number of different configuration options which we will cover below
General Configuration
Accounts Year to Date Sales Field
This field can be a currency, decimal, or varchar type field, the dropdown will display the available field options.
This field value will be displayed in the dashlet in the “Year to Date” section.
And this field is used int he before save logic hook that calculates the YTD value based on the configuration providedAccounts Lifetime Value Field
This field can be a currency, decimal, or varchar type field, the dropdown will display the available field options.
This field value will be displayed in the dashlet in the “Lifetime Value” section.
And this field is used int he before save logic hook that calculates the Lifetime value based on the configuration providedAccounts to Sales History Module Link Name
This is the link between the Accounts module and the Sales historySales History Module Name (readonly)
This value is calculated based on the link selected in the Accounts to Sales History Module Link Name fieldInclude Child Sales History?
The options are “None” (default), “Child Accounts”, and “Second Relationship”.
If “Child Accounts” is selected the accounts listed in the member organizations subpanel sales history will be included in the graph
If “Second Relationship” is selected then chose a second sales history relationship. Please Note: the second relationship must be from the same module as the first sales history link.Second Accounts to Sales History Module Link Name
Must be a link to the same Sales History module as the first sales history linkSales History Sales Date Field
This dropdown will display all of the date type fields from the “Sales History Module“
The field selected here will be used to determine the YTD and Lifetime values in addition to being used to determine which values to display in the dashletSales History Filter Field (optional)
This optional setting will allow you to choose a field to filter the sales history records on.
An example of this would be to filter for only “Closed Won” Opportunities, this way only those opportunities would be selected for both the dashlet and for the YTD and Lifetime valuesSales History Filter Field Value (optional)
When a “Sales History Filter Field“ is selected you will be given the option provide the value or values you want to filter on. For bool/checkbox type fields you will be presented a checkbox to check or not check. For varchar/text fields you will be provided a text field to put the value into, For dates/datetimes you will be provided a date field to select the date to filter on. And for enum/dropdowns you will be provided a multi-select with the options in that enum/dropdown field.Sales History to Line Items Link Name
This is the link between the Sales History module and the line items moduleLine Items Module Name (readonly)
This value is calculated based on the link selected in the Sales History to Line Items Link Name fieldLine Items Amount Field
This field can be a currency, decimal, or varchar type field, the dropdown will display the available field options from the “Line Items Module”
The field selected here will be used to calculate the YTD and Lifetime values in addition to being used to calculate which values to display in the dashletLine Items Filter Field (optional)
This optional setting will allow you to choose a field to filter the line item records on.
An example of this would be to filter for only “Closed Won” Revenue Line Items, this way only those revenue line items would be selected for both the dashlet and for the YTD and Lifetime valuesLine Items Filter Field Value (optional)
When a “Line Items Filter Field“ is selected you will be given the option provide the value or values you want to filter on. For bool/checkbox type fields you will be presented a checkbox to check or not check. For varchar/text fields you will be provided a text field to put the value into, For dates/datetimes you will be provided a date field to select the date to filter on. And for enum/dropdowns you will be provided a multi-select with the options in that enum/dropdown field.
Item Configuration
Product Details Location
There are two option for this field, depending on which option is selected you will be presented with different fields to fill out
The first option is Product Catalog and the second option is Line ItemWhen the Product Catalog option is selected you will be presented with two addition fields, only one needs to be filled in
Product Catalog Link
This is the link between the Line Item module and the Product Catalog module.
Not every Line Item module has a relationship to the Product Catalog, some only have a relate field.
If the module only has a relate field you will need to use the second option Line Items Product Catalog ID Field NameLine Items Product Catalog ID Field Name
Select the field that contains the Product Catalog ID.
If this field is used ensure that the Product Catalog Link field is empty
When the Line Item option is selected you will be presented with five additional fields to fill in. You can choose to fill in one or more of the additional fields.
The Line Item options is to be selected when the Line Items module does NOT have a link or an ID that relates to the Sugar Product Catalog.
The additional fields will be used to determine the Part Number, Name, Manufacturer, Category, and Type. Normally these values would be retrieved from the related Product Catalog Item, but in this case they will be retrieved from the line item itself.Line Item Part Number Field
When this field is used it will be treated as the ID value and name value (unless the “Line Item Name Field” is also being used) for the productLine Item Name Field
When this field is used it will be treated as the name value and ID value (unless the “Line Item Part Number Field” is also being used) for the productLine Item Manufacturer Field
When this field is used it will be treated as both the name value and ID value for the manufacturerLine Item Category Field
When this field is used it will be treated as both the name value and ID value for the product categoryLine Item Type Field
When this field is used it will be treated as both the name value and ID value for the product type
Projection Configuration
Projection Data Source
There are two option for this field, depending on which option is selected you will be presented with different fields to fill out
The first option is Project Averages and the second option is Projection ModuleWhen the Projected Averages option is selected there will be nothing else to fill out.
With this option selected the dashlet will average the sales amount over the previous 12 monthsWhen the Projection Module option is selected you will be presented with a number of additional fields to fill in
Projection Module Link
This is the link between the Accounts module and the Projection moduleProjection Module Name (readonly)
This value is calculated based on the link selected in the Projection Module Link fieldProjection Sales Date Field
This dropdown will display all of the date type fields from the “Projection Module“Projected Sales Filter Field (optional)
This optional setting will allow you to choose a field to filter the sales history records on.
An example of this would be to filter for only “Pending” Opportunities, this way only those opportunities would be selected for the dashletProjected Sales Filter Field Value (optional)
When a “Projected Sales Filter Field“ is selected you will be given the option provide the value or values you want to filter on. For bool/checkbox type fields you will be presented a checkbox to check or not check. For varchar/text fields you will be provided a text field to put the value into, For dates/datetimes you will be provided a date field to select the date to filter on. And for enum/dropdowns you will be provided a multi-select with the options in that enum/dropdown field.Projected Product Details Location
Just like the Line Items Product Details location there are two option for this field, depending on which option is selected you will be presented with different fields to fill out
The first option is Product Catalog and the second option is Projection ModuleWhen the Product Catalog option is selected you will be presented with two addition fields, only one needs to be filled in
When the Projection Module option is selected you will be presented with five additional fields to fill in. You can choose to fill in one or more of the additional fields.
The Projection Module options is to be selected when the Projection Module does NOT have a link or an ID that relates to the Sugar Product Catalog.
The additional fields will be used to determine the Part Number, Name, Manufacturer, Category, and Type. Normally these values would be retrieved from the related Product Catalog Item, but in this case they will be retrieved from the line item itself.
How to add the Dashlet
The dashlet is only available for the Accounts module record view.
To add the dashlet open an existing account record and either create or edit an existing record view dashboard
Create:
Edit:Then click “Add a new row”
Then click “Add a Sugar Dashlet”. This will cause a drawer to appear with all of the available dashlets for this module and view
In the list of Dashlets select the FayeBSG Account Sales History dashlet
Then click the save button for the dashboard and the dashlet will appear
How the Dashlet Works
The Dashlet works by compiling the sales data related to the Sugar Account that you are actively viewing and displaying it to you in the form of a bar and line graph.
The bar and line graph display a few different sets of data for you to review.
The blue bars (Actual) represent the sales data from the current starting position going back one year. The starting position by default is either the current quarter or current month, but this can be changed based on the time filter (more on the filtering later)
The green bar (Current Period to Date) will always be the current (real world) time period. This would either be the current quarter or the current month. If you select a time filter option that does not include the current month or quarter there will not be a green bar.
The orange bar(s) will display the projected or projected averages values based on the configuration settings.
The projected averages are calculated based on a rolling 12 month average. For example; if we are going to do a projected average for January 2020 (2020-01-01) the dashlet code will compile the average from 2019-01-01 through 2019-12-31 and provide that value for the January 2020 bar. Continuing the example the projection for February 2020 (2020-02-01) will be based on the data from 2019-02-01 through 2020-01-31. The February projected average will take into consideration the projected average for January 2020.
The projected values will be based on the projection module data which is a configuration setting. When there is future projection data for the account it will be compiled and displayed for the next (future) quarter or for the next 3 (future) months depending on which time filter option is selected.
The black line (Previous) displays he sales data from the previous year for the same time period. For example. The line that is over the 2020-Q2 bar will display the value from 2019-Q2.
The previous value line helps you quickly visualize the sales from a year over year perspective.
In addition to the graph the dashlet will display the lifetime value, year to date value, and the ranking.
The Lifetime Value is is calculated by a before save logic hook that comes with our tool, it determines the total amount ever sold to the account based on the configuration settings that were set in the admin section.
The Year to Date value is is calculated by a before save logic hook that comes with our tool, it determines the total amount sold to the account in the current year based on the configuration settings that were set in the admin section.
The Ranking value is determined when the dashlet is loaded. When the dashlet is loaded the system will take the Lifetime Value of the account and determine where this account ranks against all of the other accounts in the system.
Filtering
The dashlet also provides a series of filters that built based on the sales history and projection data provided.
There are filters for Product, Manufacturer/Brand, Product Category, and Product Type.
These additional filters are displayed dynamically based on the sales data provided. For example if there were no data provided for Manufacturer then the filter for that would not be displayed, whereas there is data and it is being displayed
All of the filters can be used at the same time to narrow down the data being displayed in the dashlet.
Example:
Any changes to the filters will also re-render the pie chart below the graph. Also when you click on a bar or point in the graph the pie chart will be re-rendered to display the values for that bar group by either Product, Product Type, Product Category, or Manufacturer
Examples
Clicking the reset option on the pie chart will reset the pie chart back to displaying the values from the full range of the graph (minus projected values)
Hovering over any of the bars or the line will display a popup with the details for the element that is being hovered over
Examples:
Previous
Actual
Actual Period to Date
(Projected)
You will notice that when hovering over the bars, points, or pie slices the popup shows that a single and/or double click can trigger different action.
Just as described above clicking on a bar or point will re-render the pie chart.
Drilldown Drawer
Double clicking on a bar, point, or pie slice will open up the drilldown drawer and display the line items that make up the given bar, point, or pie slice.
Once in the drilldorn drawer you can click between the bars, points, and pie slices to update the drawer data