The Report Builder allows you to create, save, and share customized reports for you and your team.
Topics covered in this article:
- Accessing the Report Builder
- Using the Report Builder
Accessing the Report Builder
To access the Report Builder, log into your MachineMetrics account, hover over Reports in the main navigation, and select Report Builder.
Using the Report Builder
The Report Builder offers flexible reporting, meaning you have the ability to customize the metrics, the groups, and the filters of your report.
Would you like to see a step-by-step guide inside the MachineMetrics App? Check out the walkthrough in the link below.
**Please note that you do have to be a MachineMetrics customer, and you must also be logged in to the application for this guide to work properly.
If not, let's keep exploring the Report Builder below:
Select your Date and Time Range
To build a report, start by selecting the date, date range, and/or time range you wish to include in the report, then select Apply.
Reports that include custom time ranges may take a few minutes to load because of the large amount of data and added specificity. Only grouping by a custom time range will show a report that includes hourly results. Choosing a date range including only days will report the data in 24 hour blocks instead of hourly.
Note: The exact range of dates and times included in the report will be included when you build the report and is based on your "Start of Day" configured in your company settings.
Use Controls to Select Data Items and Filters
Next, use the Controls in the left sidebar to select the data you are interested in reporting on. If you would like to include all data under a specific heading you can choose Select All. There is also an option to Deselect All as an easy way to clear selections within a section.
To hide the sidebar controls, select Hide Controls on the left side of the screen which will make the report display area larger.
Now, choose how your data will be organized by making selections under the Group By tab. Select a minimum of zero and a maximum of three groups for each report. If no Groups are selected, the report will return a company-wide roll-up. The grouping hierarchy is determined by the order in which you select them, so to reorder, de-select, and reselect in the order you wish to include.
There is also an option to group by time. You can choose three options from Quarter, Month, Week, Day, or Hour. The order in which these are selected will determine the grouping hierarchy as outlined above.
With the Group By Time options, there are some considerations to keep in mind.
The Group By Hour option will only be available for Reports that include one week or less within the scope of time. When using Group By Hour, you will not be able to group by other time intervals or by shift. Additionally, you will not be able to select Downtime in the Selected Data if you have Grouped By Hour. This is because of current data limitations in our system.
You cannot choose a time interval that is longer than the selected date range in the calendar picker.
When nesting your Group By selections, you can only nest smaller time intervals under larger time intervals so that it makes logical sense in the Report. For example, our system will not let you add Month and then Quarter.
Downtime in the Report Builder (Beta)
The Report Builder now supports grouping by Downtime Category for certain metrics.
When using the Selected Data tab and grouping by Downtime Category, the available metrics that can be selected are currently limited to Downtime and Job Run metrics, Time in Cycle, Total Time, Total Setup, and Expected Setup.
Use the Filter By tab to add optional filters which will narrow the report results. When you use a filter that has a large number of options for its parameter, you can use the search bar to enter a particular search term.
Build & Clear Reports
Once your data, grouping, and filters are entered, select Build Report. This will create and display the report containing the information you have selected. There is an option to Clear Report which will clear the current report and your selections within the controls.
If you wish to make edits to the report, adjust your selections in the Controls, and select Build Report again which will display a report reflecting any changes made.
Once you build your report, the left side of the report will display the grouping hierarchy you selected for the report. For this example, a report was created to group by Machine > Job > Job Run. According to the order, Machine is displayed first, and the arrow next to the Machine name can be used to drop down to the second grouping parameter which is Job. From there you can use the arrow to get to the third level, Job Run.
The Report Range is determined by your "Start of Day" configured in your Company Settings, and will display the exact dates and times included in your Report, as shown below:
Using Charts in the Report Builder to visualize your data
Charts within the Report Builder add a visual representation of your data. To learn more about charts, watch the demo below:
Export your Report
Selecting Export CSV will export the report data to a CSV file that can then be saved and shared with others at your organization.
Note: In order to export a report to a CSV file, you must have either Manager or Executive-level access. For a guide on user roles and permissions, you can review our Users Knowledge Base article.
Save & Load Reports
If there is a Report that you use often, we recommend that you Save Report for easy access. Saving a Report allows you to Load the Report at any time.
In order to Save a Report, you must first Build Report. Once you have built a Report, you will have the ability to select Save Report, as shown below.
Note: To save a report that includes a chart, you must have the chart open when you save the report. Learn more about Charts in the Report Builder here.
Choose Public or Private Visibility to determine who will be able to see the Report. Choosing Private will make the Report only visible to your user account. Choosing Public will make your Report visible to everyone on your MachineMetrics company account, but you will be the author and the only one that can make changes to the Report or delete the Report.
Select Load Report to load a Report that has been previously saved.
This will display the list of Saved Reports including the Reports you have saved as well as the Reports your team has saved with Public Visibility.
Global Report Templates
Global Report Templates are available in the Report Builder. These report templates allow you to select the date range you would like to include on the report. You can select Current Range, which will include the current range you have selected in the builder, or Report Range, which will load the report for the date range native to the template, as shown below. Once you load the report, you will have the ability to customize the report, including the date range.
Learn more about Global Report Templates in the video below:
How can I change the name of a report?
In order to change the name on a Report, you can Load the Report and then select Save Report again, giving the Report a new name. Keep in mind, this does not replace your existing report but will create a duplicate Report with a new name. You can then delete the original report from the list of your saved reports.
How can I revise the data and filters included in a report?
If you Load a Report and would like to make changes to the Data or Filters that are included, you must 1) update the data in the Controls 2) Build Report again before you 3) Save Report using the same name. Using the same name for a report will override the existing Report (not case sensitive).
*Note that you must select the same Visibility to override the existing Report. If the original Report was saved as Public, and you override the Report and select Private, it will create a second Report instead of overriding the original Report.
If you have any questions regarding the Report Builder feel free to reach out to us any time at firstname.lastname@example.org.