Dashboard
Added in Version 12
The Dashboard in ERPNext offers a strong, glance-at-a-time overview of important performance indicators (KPIs) for different business processes across modules. It presents users with a unified and interactive graphical overview of all key data, facilitating faster and better-informed decision-making. Dashboards are very much suitable for department heads, managers, and executives who need to keep track of trends and performance measurements without drilling down into underlying reports. The current version improves interactivity, chart responsiveness, and modular dashboard sharing capabilities.
Each Dashboard contains a single or multiple Dashboard Charts, each of which is set up with a data source referred to as a Dashboard Chart Source. Sources may be Doctypes, reports, or custom scripts that specify how the data will be retrieved and displayed.
To create a new Dashboard, go to:
1. Creating a New Dashboard
- Navigate to the Dashboards List and click on New.
- Enter the Module Name you would like to view the Dashboard for. This will set the focus area, e.g., Sales, Purchase, Projects, HR, etc.
- Enter the Dashboard Charts you would like parameterized for this Dashboard. These might be line charts, bar charts, heatmaps, percentage graphs, and other data representations applicable to that module.
- Save.
After saving, click Show Dashboard to see the layout and data. You can view your dashboard showing a graphical view of transactions and key figures in real time. Users can use filters or date ranges where possible, and options for layout allow you to customize chart placement.
2. Adding Charts to Dashboard
Add this dashboard with charts either by picking an existing Dashboard Chart from the system or defining new ones via the Dashboard Chart DocType. You can create new charts based on any of your standard or custom Doctypes, and you can set filters, timespan, chart type, group field, and aggregation type (such as sum, count, average).
The new version of ERPNext also includes conditional coloring, enhanced chart interactivity, and better mobile compatibility, enhancing the use of dashboards on different devices.
Save changes and press the Show Dashboard button to view the new dashboard.
3. Adding a New Dashboard Chart
To add a new Dashboard Chart, navigate to:
Begin by giving the chart a significant name—this will be the chart label shown on the dashboard. Choose the Chart Type (for example, Line, Bar, Percentage, Heatmap, and so on) or select Custom if you are setting up your own data source and format. Next, choose a Dashboard Chart Source as the data source from where the chart will pull data.
Note: Defining a new Dashboard Chart Source is a developer activity and can be created by only an Administrator User if in Developer Mode. This is to ensure system integrity and restrict access to backend customization.
Once you have established the Chart Source, the Filters Table will become visible below. Click into the table to set up filters for the data query.
You will get a modal window by which you can define particular filter conditions like field values, date ranges, or statuses.
Click Set to set the filters. The table will display your set parameters once the filters are established. This provides dynamic and fine-grained control over what data is shown in the chart.
In the above case, we created a custom Dashboard Chart based on an existing Dashboard Chart Source. ERPNext accommodates flexible use cases where pre-defined data structures can be depicted in no time.
Aside from custom chart sources, you can make basic charts such as:
- Count / Sum / Average / Group By based on creation or last modified dates of any Doctype (e.g., ToDo, Sales Invoice, Projects).
To achieve this:
- Choose Count / Sum / Average / Group By as Chart Type.
- Employ Document Type to select the source Doctype (e.g., "\"ToDo"\").
- Configure Time Series Based On to fields such as creation or modified.
Note: When you choose a Child Table Doctype from the Document Type field, you must also choose the Parent Document Type. The extra field is only shown once a child table Doctype is selected, to ensure relational context to fetch data accurately.
For Sum and Average types of charts:
- You have to specify the Based On Value from the Value Based On field. This would usually be a numerical field like amount, total, or hours.
For Group By charts:
- Select Group By Type (Count, Sum, or Average).
- Select Group By Based On (Created By, Owner, Status, etc.).
- Set the Number of Groups to display on the chart (e.g., Top 5 or Top 10 records).
This flexible system allows you to obtain strong visual findings directly out of your transactional information.
4. Using Dashboards
All the charts within the dashboard are drawn by using the Dashboard Chart configuration of whoever the respective counterpart. For performance optimization, ERPNext caches the result of the chart source so that it does not make repetitive queries which may slow down the system.
But what this results in is that chart data may become slightly stale, particularly in high-transaction environments. In order to keep users up-to-date, each chart includes the Last Synced Time, showing when the data was most recently fetched or updated.