Dashboard import feature #758

rsill-neo4j · 2025-07-22T17:04:50Z

No description provided.

FilipLeonard · 2025-07-23T07:18:38Z

modules/ROOT/pages/dashboards/import.adoc

+| Single value                                 | ✅ 
+| Raw JSON                                     | ❌ 
+| Parameter select                             | Only node and relationship properties  
+| Form                                         | Only node and relationship properties 


NeoDash reports of type form are skipped.

FilipLeonard

Overall looks good to me. As we discussed the details will change a bit, in particular I'll make the detail path in the JSON more human-friendly.

I wonder if we should add a note stating that for the moment we only support NeoDash imports but Aura dashboards imports are coming soon.

modules/ROOT/pages/dashboards/import.adoc

rsill-neo4j · 2025-07-23T08:18:16Z

modules/ROOT/pages/dashboards/import.adoc

+
+If the dashboard specification selected for the import is syntactically correct, the **Import dashboard** dialog displays a **Summary** and **Details** for the import.
+This means that the import can be run.
+


Suggested change

[NOTE]

====

Currently, Aura dashboards only support the import of NeoDash dashboard specifications.

====

added this note, but let's avoid making promises in the docs :)

lets remember to remove this note in a couple of weeks

nielsdejong · 2025-07-23T11:07:01Z

modules/ROOT/pages/dashboards/import.adoc

+In the **Import dashboard** dialog, you have several options to source the dashboard specification for the import:
+
+* Browse for a JSON file on your machine.
+* Select a dashboard specification that is stored in your database.


'dashboard specification' sounds a bit awkward - is dashboard instance/dashboard save better?

Maybe also explicitly call out that dashboards stored in the database is a legacy storage mechanism

hm... what do we call it internally?
it's not quite the dashboard itself, rather the stored version of it, or the JSON representation of a dashboard

legacy storage mechanism as in we discourage users?

Imo, good options are "dashboard JSON" or more verbose "dashboard JSON representation".

When "sourcing" a JSON, we show a toast saying "Dashboard loaded successfully". Should we use "load" instead of "source"?

^ agree with Leo that "dashboard JSON" makes sense.
I also prefer load over source.

nielsdejong · 2025-07-23T11:08:01Z

modules/ROOT/pages/dashboards/import.adoc

+.Import dashboard dialog
+image::dashboards/import/import-dashboard-dialog.png[]
+
+Note that you only have the option to select a stored dashboard specification when there are stored dashboards in your database.


can this note and the next paragraph be boxed in?

nielsdejong · 2025-07-23T11:08:57Z

modules/ROOT/pages/dashboards/import.adoc

+
+If the dashboard specification selected for the import is syntactically correct, the **Import dashboard** dialog displays a **Summary** and **Details** for the import.
+This means that the import can be run.
+


lets remember to remove this note in a couple of weeks

nielsdejong · 2025-07-23T11:09:25Z

modules/ROOT/pages/dashboards/import.adoc

+This means that the import can be run.
+
+
+== Supported types


call out that advanced types (via extension) are not supported

nielsdejong · 2025-07-23T11:10:06Z

modules/ROOT/pages/dashboards/import.adoc

+|===
+
+
+== Summary


can this be a list? or something more concise? it feels like a lot to digest

nielsdejong · 2025-07-23T11:13:19Z

modules/ROOT/pages/dashboards/import.adoc

+Entries include the location of the incident in the JSON specification, that is, the specific page and report, as well as a description what went wrong or is of note.
+
+
+== Example


i'm not sure how i feel about having an (non-ideal migration) example in the docs.
Should we just skip it? I know we discussed otherwise, but I don't see the added value if we can make the details section easier to comprehend

removed the example, and added a list to the details section. we should probably add some entries to this list

nielsdejong · 2025-07-23T11:13:57Z

modules/ROOT/pages/dashboards/managing-dashboards.adoc

 == Creating a dashboard

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


this UI will change: https://linear.app/neo4j/issue/DASH-337/improve-quality-of-empty-states

when will it be available? asking because i think i need to retake some screenshots :)

it's planned for this DevCycle, so probably in the next 2-3 weeks.

nielsdejong · 2025-07-23T11:14:08Z

modules/ROOT/pages/dashboards/managing-dashboards.adoc

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

-If you want to create another dashboard: use **Create Dashboard** at the top right, and select either **Create from scratch** or **Create with AI**.
+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**.


Same here, UI will change

nielsdejong · 2025-07-25T05:49:04Z

modules/ROOT/pages/dashboards/import.adoc

+In the **Import dashboard** dialog, you have several options to source the dashboard specification for the import:
+
+* Browse for a JSON file on your machine.
+* Select a dashboard specification that is stored in your database.


^ agree with Leo that "dashboard JSON" makes sense.
I also prefer load over source.

nielsdejong · 2025-07-25T05:49:36Z

modules/ROOT/pages/dashboards/managing-dashboards.adoc

 == Creating a dashboard

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


it's planned for this DevCycle, so probably in the next 2-3 weeks.

neo4j-docops-agent · 2025-08-04T07:39:18Z

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

text + screenshots

21f313b

rsill-neo4j requested review from FilipLeonard, fiquick and nielsdejong July 22, 2025 17:04

Merge branch 'console' into dashboards-import

29e8848

FilipLeonard reviewed Jul 23, 2025

View reviewed changes

rsill-neo4j commented Jul 23, 2025

View reviewed changes

Update modules/ROOT/pages/dashboards/import.adoc

37f88e7

nielsdejong requested changes Jul 23, 2025

View reviewed changes

rsill-neo4j and others added 3 commits July 23, 2025 17:36

review suggestions

620479a

Merge branch 'console' into dashboards-import

200303e

review suggestions (2)

6abd688

nielsdejong approved these changes Jul 25, 2025

View reviewed changes

rsill-neo4j and others added 2 commits July 25, 2025 09:42

changed wording to 'dashboard JSON'

b2646a2

Merge branch 'console' into dashboards-import

3fbec0a

rsill-neo4j merged commit 8a58b55 into console Aug 4, 2025
4 checks passed

rsill-neo4j deleted the dashboards-import branch August 4, 2025 07:39

FlorentinD mentioned this pull request Sep 23, 2025

Clarify marketplace support for aura graph analytics #809

Closed


		If the dashboard specification selected for the import is syntactically correct, the Import dashboard dialog displays a Summary and Details for the import.
		This means that the import can be run.

+[NOTE]
+====
+Currently, Aura dashboards only support the import of NeoDash dashboard specifications.
+====

		Entries include the location of the incident in the JSON specification, that is, the specific page and report, as well as a description what went wrong or is of note.


		== Example

		\|===


		== Summary

Dashboard import feature #758

Dashboard import feature #758

Uh oh!

Conversation

rsill-neo4j commented Jul 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FilipLeonard left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FilipLeonard Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neo4j-docops-agent commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

FilipLeonard Jul 23, 2025 •

edited

Loading

neo4j-docops-agent commented Aug 4, 2025 •

edited

Loading