Create graph powered reports in seconds with Ardoq’s Report Builder. Choose between Advanced Search and Gremlin Search to query one or more workspaces at once. Next, invite key stakeholders to your report and assign them Administrator, Writer, or Read-only permissions.
Once your report is ready, add it to a dashboard to visualize your data and communicate critical metrics and actionable insights.
Table of contents:
What is a Report
A report in Ardoq is where you can:
Build queries using the Report Builder to:
Find components or references of a certain type or with specific field values using Advanced Search. Additionally, you can find components using references to other components and component types with the new version of Advanced search.
Analyze the relationships between the components in your graph data model, and their properties using Gremlin Graph Search
Invite key stakeholders to a report and keep control of who has access to the data
Assign dedicated report permissions and manage what users can do
Calculate aggregated data in just a few clicks
With reports, you decide what data to share and with who, and eliminate data silos. Access to the report data does not require permission to the workspaces that the report is based on.
How To Create A Report
To create a report, make sure you have the Administrator or Writer user role.
1. Open the Report Builder
You can open the Report Builder from two places:
From the “Home” page. Click on the “Create New” button located at the top right corner. Next, choose “Report”.
From Analytics > Reports Overview. Select "Create New" at the top right corner of the screen.
2. Fill out each section in the Report Builder
Name report and add a description
Give your report a name and a description to provide stakeholders with the context they need to understand key findings and insights.
Select the type of search you want to use. Choose between:
Advanced search (new): Find components using field values and references to other components and component types. Additionally, you can search for references using field values too. The new version of Advanced search supports reference-based operators that enable you to find components based on their references. Moreover, the "contains phrase" operator has been discontinued as the new Advanced search uses an enhanced "contains substring". Learn more about the new version of Advanced search in this KB article.
Advanced search (old): Find components and references using field values. The old version of Advanced search will be eventually discontinued. Find out next steps following the retirement of the old version of Advanced search in this KB article.
Gremlin search: Analyze the relationships between the components in your model and their properties with graph traversal language Gremlin.
Define the workspace(s) you want to search for components or references.
Build your query using the Advanced search query builder or type in your Gremlin query in the text box. You can preview the metamodel of sourced workspaces to aid in the design of the query.
Tip: Take a look at the “Gremlin Graph Search Examples” KB article and get useful tips to start solving business questions with Ardoq Graph Search.
Click "Search" to execute the query.
Select the columns to include in the final report
Search using the respective query language
Select default column to sort by and whether in ascending or descending order
Select default aggregate for columns with a numerical value. Choose between:
Minimum: Displays the lowest value gathered for the relevant numerical field
Maximum: Displays the highest value gathered for the relevant numerical field
Average: Calculates the average value for the relevant numerical field
Sum: Adds up all the values gathered for the relevant numerical field
Count: Enumerates the total number of values gathered for the relevant numerical field
Click "Preview report" to see how your report will look like with the selected columns, default sorting, and aggregate applied.
Lastly, invite key stakeholders to your report and grant them the Administrator, Writer, or Read-only permissions. Add Permission Groups to speed up the invite process or enter the name or email address of individual users.
👉 See the Report Permissions section below to know what each report permission enables users to do.
3. Save your report
Click on the “Save” button at the top right corner of your screen to save your report and share it with the people you added in the previous step.
From here, you can either view your report in the Report Reader or go back to the Home page to see an overview of your reports.
Report permissions work together with the user roles to help manage what users can do in a given report.
In some cases, the report permission will be pre-defined and won't be possible to change it:
Users with the Administrator user role are automatically granted the Administrator report permission. All users with the Administrator user role can access all reports whether they are added to it or not. Their report permission can't be changed.
Users with the Writer user role can be granted the Administrator, Writing, or Read-only report permission.
Users with the Reader user role are automatically granted the Read-only report permission. Their report permission can't be changed.
Report permissions and their rights:
Administrator report permission: Users with admin report permission are able to perform the following actions provided they at least have read-only permissions on the workspaces the report queries:
Change the name of the report
Update the type of data source
Modify the workspace or survey to run the search on
Edit the report query
Display fields and aggregates
Invite or remove users from the report
Update report permissions
Delete the report
Writing report permission: Users with the Writing report permission are able to do the following actions provided they at least have read-only permission on the underlying workspace(s):
Change the name of the report
Update the type of data source
Modify the workspace or survey to run the search on provided they at least have read access to the workspaces or surveys defined in the report
Edit the report query provided the user at least has read access to the underlying workspace(s)
Display fields and aggregates
Read-only report permission: Users with the Read-only report permission can only see the results of your query. The report loads in core Ardoq's Report Reader.
Reports permissions enable you to:
Take control of your data
Decide what workspace or survey data to share in your report
Invite team members to the report
Assign Administrator, Writing or Read-only report permissions
Reveal underlying data regardless of your workspace permissions, understand the fine details and:
Confidently make informed business decisions
Increase trust of analytics
Get stakeholder buy-in for your planned changes
Answer critical business questions
Inspect your data and spot incorrect values
Use the Report Reader to:
You can access the Report Reader:
Right after saving a report
When drilling down a dashboard widget
When opening a report
Filtering and Sorting
In the Report Reader, filter your data by clicking on the filter icon next to a column name.
By default, your report results are all set to be sorted alphabetically according to your chosen language in Preferences > Account settings > Locale. If no language is selected, the sorting order of your report results is determined by the locale selected in your browser.
Additionally, you can sort your report results in ascending and descending order by clicking on the name of a column in the Report Reader. An arrow will show next to the name indicating whether the order is ascending or descending.
The field types that support filtering are:
For Text fields, only sorting by "not set" is available. You can use it to check for any empty text fields.
How to Add a Report to a Presentation
Once you've saved your report, you can add a report as a slide in a presentation.
To add a report to a presentation:
Open a report.
Click on the "Add to a presentation" button at the top right corner of your screen.
Type in the name of the presentation you want to add your report to or create a new one by typing in a new name.
How to Create a Report Alert Broadcast
Get notified about changes on key metrics to stay on top of your portfolio performance and identify areas where improvements can be made.
To create a report alert broadcast, open a report and click on the "Create Broadcast" button at the top right corner of the screen. You will be taken to the Broadcast Builder where you can further configure the report alert broadcast.
How to Export Reports as .xls and JSON Files
After saving your report, you'll be directed to the Report Reader, where you can export your report as an .xls file or JSON files. Choose:
Export to Excel (report data only) when you need to download an .xls file that includes the selected columns in the report only and lists names instead of IDs for source, type, target, and reference columns.
Export to Excel (import format) when you need to re-import the .xls file into Ardoq using the Excel integration
JSON when you need the data in a computer readable format
To see a full list of your reports, navigate to Analytics > Reports Overview.
Alternatively, click on the “Home” icon on the left side navigation bar and select “Reports”. This will filter the asset manager in the Home page to show only reports.
From here, you can invite users to multiple reports at once, assign them a report permission, and delete several reports simultaneously.
If you have any questions, reach out via our website or by using the in-app chat. 💬 We're happy to help.