Skip to content

Dashboards import feature update #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 4, 2025
Merged

Dashboards import feature update #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b3e53f
updates for the import feature
rsill-neo4j Sep 1, 2025
65e98b9
screenshot update
rsill-neo4j Sep 1, 2025
e38c6e9
made it clearer when it is a NeoDash dashboard JSON
rsill-neo4j Sep 2, 2025
e37a1b0
reorganized the import page according to review suggestions
rsill-neo4j Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/content-nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Generic Start
** xref:dashboards/index.adoc[Overview]
** xref:dashboards/getting-started.adoc[Getting started]
** xref:dashboards/managing-dashboards.adoc[Managing dashboards]
** xref:dashboards/import.adoc[Import]
** xref:dashboards/import.adoc[Import and export]
** xref:dashboards/ai-dashboards.adoc[AI dashboards]
** xref:dashboards/parameters-and-filters.adoc[Parameters and filters]
** xref:dashboards/sharing-dashboards.adoc[Sharing dashboards]
Expand Down
Binary file modified modules/ROOT/images/dashboards/create-first-dashboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/ROOT/images/dashboards/import/import-dashboard-dialog.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 15 additions & 5 deletions modules/ROOT/pages/dashboards/import.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
= Import
= Import and export
:description: This page holds information about import options for dashboards.


== Importing a dashboard

When you create a dashboard, you can choose to **Import**.
You can import from NeoDash commercial and NeoDash Labs or from a previously exported dashboard JSON.

In the **Import dashboard** dialog, you have several options to source the dashboard JSON for the import:

Expand All @@ -23,7 +27,7 @@ If the dashboard JSON selected for the import is syntactically correct, the **Im
This means that the import can be run.


== Supported reports
=== Supported legacy NeoDash reports

[cols="9,^4",options="header",grid="cols"]
|===
Expand All @@ -47,7 +51,7 @@ This means that the import can be run.
Advanced NeoDash reports added via the Advanced visualization extension are not supported.


== Summary
=== Summary

Data fields relevant to the import are displayed under **Summary**.

Expand All @@ -67,7 +71,7 @@ Note that not all settings from NeoDash reports have a counterpart in Aura dashb
Any such settings do not affect the import and are not preserved by the import procedure.


== Details
=== Details

Expand the **Details** to inspect incidents reported during the import.

Expand All @@ -76,4 +80,10 @@ Entries include the location of the incident in the dashboard JSON, that is, the
Descriptions can be, for example:

* Unsupported parameter select types, resulting in skipped filters.
* Missing entity and/or property types, missing parameter names.
* Missing entity and/or property types, missing parameter names.


== Exporting a dashboard

In the dashboards tile page, use the more menu *[...]* of a dashboard tile and select **Export file...**.
Neo4j Aura creates a dashboard JSON file with the following format: `[dashboard title]_[current date as YYYY-MM-DD].json`.
21 changes: 16 additions & 5 deletions modules/ROOT/pages/dashboards/managing-dashboards.adoc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to add a section here Importing a dashboard that just links to the Import docs?

Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ The number of dashboards you can create depends on your Aura tier:

== Creating a dashboard

If you have no dashboards, select **Create dashboard** and either **Create from scratch** or **Import**.
Alternatively, select **Create with AI**.
If you have no dashboards, select **Create with AI**, **Create from scratch** or **Import**.

.Create your first dashboard
image::dashboards/create-first-dashboard.png[]

If you already have a dashboard and want to create another, use **Create Dashboard** at the top right, and select **Create from scratch**, **Import** or **Create with AI**.
If you already have a dashboard and want to create another, use either **Import** or **Create** and then **Create from scratch**, or **Create with AI** at the top right.

See xref::/dashboards/ai-dashboards.adoc[] for advice how to create a dashboard via prompt.

**Create from scratch** takes you directly to a new and empty dashboard.

See xref:/dashboards/import.adoc[] to learn more about importing dashboards.

See xref::/dashboards/ai-dashboards.adoc[] for advice how to create a dashboard via prompt.


== Editing a dashboard
Expand Down Expand Up @@ -57,4 +57,15 @@ Use the six dots at the top left of a card to drag and drop it within the grid o

== Deleting a dashboard

In the dashboards tile page, use the more menu *[...]* of a dashboard tile and select **Delete**, then confirm.
In the dashboards tile page, use the more menu *[...]* of a dashboard tile and select **Delete**, then confirm.


== Exporting the dashboard JSON as a file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have a page for import that is seperate from 'managing dashboards', maybe we should also have an individual page for export? Or merge the import/export pages into one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have a page for import that is seperate from 'managing dashboards', maybe we should also have an individual page for export? Or merge the import/export pages into one?

it's not a lot of text - i added the actual description to the "Managing dashboards" page, and then referred to those in the "Import" page.

How about changing "Import" to "Import and export", and then make it clearer in terms of subheadings?


In the dashboards tile page, use the more menu *[...]* of a dashboard tile and select **Export file...**.
Neo4j Aura creates a dashboard JSON file with the following format: `[dashboard title]_[current date as YYYY-MM-DD].json`.


== Copying the dashboard JSON to clipboard

In the dashboards tile page, use the more menu *[...]* of a dashboard tile and select **Copy to clipboard**.