Getting Started with Custom Reporting
This guide is designed to help you get started with custom reporting, from access controls, basic concepts, and understanding the language used in data and reporting tools.
Understanding Reporting Concepts
Metabase Reports - a few key concepts
Next steps - Building your first custom report
With Metabase in Projectworks, you can create, save, and share custom reports using live data from your environment. Before you begin, check that your access controls are set up correctly. If you need assistance, reach out to your Projectworks Administrator.
Access Controls
When setting permissions for custom reports, be aware that this can grant users access to sensitive details like costs or margins that they might not normally see. Always review user access levels and report-specific permissions carefully.
Custom report access is controlled by Users Access Levels and Metabase report access
-
Users Access Levels access determines if users can see the:
-
'Reports (New)' tab - user has ‘Can View’ Reporting access
-
‘Manage Reports’ button - user has ‘Can Manage’ Reporting access, or
-
‘Create Reports’ button - user has ‘Can Edit’ Reporting access.
-
-
Metabase report access controls the specific Dashboards users can see either through
-
their Role; or
-
as an individual.
-
Users MUST have the ‘Can View’ permission to be able to have either ‘Can Manage’ and/or ‘Can Edit' permission
Individual permission trumps the Roles with Access permission; i.e if your User Access Level does not have access to a Report, you can be given individual access to the Report.
Users Access Levels is managed via Admin → Access Levels → Reporting.
Make sure the reporting option is ticked in the header - that will show the reporting button below.
Metabase report access is managed via ‘Manage Reports’ via the ‘Reports (New)’ tab.
-
Navigate to the Reports (New) page;
-
Select “Manage Reports” button;
-
Select the three dot menu on any available Report;
-
Select “Manage” option;
-
A modal pop up that allows you to select Roles with Access (User Level Access) and individual users to be granted access to the report.
Understanding Reporting Concepts
Before you start using Metabase, it's helpful to get familiar with the key components of a report. If you have experience with Excel, many of these concepts will be intuitive.
Reporting Term |
What It Means |
Excel Analogy |
---|---|---|
Table |
A collection of related data |
An Excel worksheet (or structured table), e.g., |
Row |
A single record in a table |
One row in your spreadsheet e.g., a single time entry |
Field (Column) |
A specific piece of data for every row |
A column like |
Filter |
Limits which/what data you see |
Using Excel’s Filter tool or applying formulas like |
Group By |
Buckets data by shared values |
Creating row groups in a Pivot Table, like grouping by |
Aggregate (Sum, Count, Avg) |
Crunches data within a group |
Functions like |
Join |
Combines data from multiple tables using a shared field |
Using |
Dashboard |
A visual summary of key reports |
A summary tab with charts, slicers, and key figures in Excel |
Metabase Reports - a few key concepts
Metabase Reports in Projectworks are built from queries that pull live data from your environment. Each query is saved as a Question, which you can add to a Dashboard. Dashboards present your Questions as interactive reports accessible within Projectworks.
Term | Definition | Reporting User Access Level required | Metabase report access required |
Report |
A Report is how a Dashboard is displayed in Projectworks. A User with access to a Report can see this in the Reports list when they navigate to the “Reports (Beta)” tab Tags can be added to a Report by Users who have the “Can Manage” Reporting User Level Access. |
Can View
|
Must have:
|
Dashboard |
Questions can saved to a Dashboard. Dashboards saved in the:
are displayed in Projectworks as a Report.
Filters can be added to a Dashboard, so that the Report can be filtered by the User accessing it. Access to Dashboards saved in the:
can be shared with:
|
Can Edit
|
n/a |
Question |
A query on the Projectworks data is saved as a Question to form the basis of a Report in Projectworks. A Question:
A saved Question can be used as the basis of an alternate Question.
Questions saved in the:
can be accessed by other users who have the “Can Edit” Reporting User Level Access. |
Can Edit
|
n/a |
Visualization |
The visual representation of a Question. This can be selected when a User is creating or editing a Question. If a User has access to a Dashboard, this is how the Question will be displayed in the Projectworks Report. |
Can Edit
|
n/a |
Collection |
A Collection is how Questions and Dashboards are grouped. When you are creating a Question or Dashboard, you can save them to:
The Projectworks Collection cannot be edited, but you can:
|
Can Edit
|
n/a |
Next steps - Building your first custom report
Now you have ensured you have the correct access controls and have an understanding of the general concepts around reporting we recommend building your first custom report.