1. Installation
2. Configuration
3. How to add the Dashlet
4. How the Dashlet Works
A. Filtering
B. Drilldown Drawer
1. Installation
Before installing the Sales History Dashlet to your SugarCRM instance please make sure you have the following items at hand:
· FBSG | Licensing installation package
· FBSG | Sales History Dashlet installation package
· Sales History Dashlet License Key
Please follow the steps in this guide to install both packages.
2. Configuration
1. The configuration details are set in the Administration section. Log in to Sugar as a System Administrator User.
2. Open the menu next to your profile picture in the upper right-hand corner and select Admin.
3. Scroll down to the bottom of the Administration screen and click on the link for the FayeBSG Sales History Dashlet Configuration.
4. There are a number of different configuration options which we will cover below.
A. General Configuration
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.
The field is used in the before-save logic hook that calculates the YTD value based on the configuration provided.
2. Accounts 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.
It is used in the before-save logic hook that calculates the Lifetime value based on the configuration provided.
3. Accounts to Sales History Module Link Name
This is the link between the Accounts module and the Sales History.
4. Sales History Module Name (read-only)
This value is calculated based on the link selected in the Accounts to Sales History Module Link Name field.
5. Include 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 choose a second sales history relationship.
Please Note: the second relationship must be from the same module as the first sales history link.
6. Second Accounts to Sales History Module Link Name
This must be a link to the same Sales History module as the first sales history link.
7. Sales 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 dashlet.
8. Sales 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 values.
9. Sales History Filter Field Value (optional)
When a Sales History Filter Field is selected you will be given the option to provide the value or values you want to filter on. For pool/checkbox type fields you will be presented with 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/date-time 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.
10. Sales History to Line Items Link Name
This is the link between the Sales History module and the line items module.
11. Line Items Module Name (read-only)
This value is calculated based on the link selected in the Sales History to Line Items Link Name field.
12. Line 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 dashlet.
13. Line 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 values.
14. Line Items Filter Field Value (optional)
When a Line Items Filter Field is selected you will be given the option to 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/date-time 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.
B. Item Configuration
Product Details Location
There are two options 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 Item
1. When the Product Catalog option is selected you will be presented with two additional fields, only one needs to be filled in.
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 related field.
If the module only has a related field you will need to use the second option: Line Items Product Catalog ID Field Name.
b. Line 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.
2. 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 are 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.
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 product.
b. Line 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 product.
c. Line Item Manufacturer Field
When this field is used it will be treated as both the name value and ID value for the manufacturer.
d. Line Item Category Field
When this field is used it will be treated as both the name value and ID value for the product category.
e. Line Item Type Field
When this field is used it will be treated as both the name value and ID value for the product type.
C. Projection Configuration
Projection Data Source
There are two options 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 Module.
1. When 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 months.
This is the link between the Accounts module and the Projection module.
b. Projection Module Name (read-only)
This value is calculated based on the link selected in the Projection Module Link field.
c. Projection Sales Date Field
This dropdown will display all of the date-type fields from the Projection Module.
d. 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 dashlet.
e. Projected Sales Filter Field Value (optional)
When a Projected Sales Filter Field is selected you will be given the option to 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/date-time 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.
f. Projected Product Details Location
Just like the Line Items Product Details location, there are two options 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 Module.
When the Product Catalog option is selected you will be presented with two additional 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 should 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.
3. How to add the Dashlet
1. The dashlet is only available for the Accounts module record view.
2. To add the dashlet open an existing account record and add a new dashlet.
4. In the list of Dashlets select the FayeBSG Account Sales History dashlet.
5. Then click the Save button.
6. The dashlet will appear on the right-hand side of the account record view.
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 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 average 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 the 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 ranking.
The Lifetime Value 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 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.
The dashlet also provides a series of filters that are 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.
Example:
Example:
Hovering over any of the bars or the line will display a popup with the details for the element that is being hovered over.
Example:
Previous Actual
Just as described above clicking on a bar or point will re-render the pie chart.
B. Drilldown Drawer
Double-clicking on a bar, point, or pie slice will open up the drill-down drawer and display the line items that make up the given bar, point, or pie slice.
Once in the drill-down drawer, you can click between the bars, points, and pie slices to update the drawer data.
Comments
0 comments
Please sign in to leave a comment.