-
Notifications
You must be signed in to change notification settings - Fork 27
Dashboard import feature #758
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.
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
Changes from all commits
21f313b
29e8848
37f88e7
620479a
200303e
6abd688
b2646a2
3fbec0a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
= Import | ||
:description: This page holds information about import options for dashboards. | ||
|
||
When you create a dashboard, you can choose to **Import**. | ||
|
||
In the **Import dashboard** dialog, you have several options to source the dashboard JSON for the import: | ||
|
||
* Browse for a JSON file on your machine. | ||
* Select a dashboard JSON that is stored in your database. | ||
* Drag and drop or paste a dashboard JSON to the editor. | ||
|
||
.Import dashboard dialog | ||
image::dashboards/import/import-dashboard-dialog.png[] | ||
|
||
[NOTE] | ||
==== | ||
Note that you only have the option to select a stored dashboard JSON when there are stored dashboards in your database. | ||
|
||
It is not possible to delete stored dashboards from the database through the dashboard application. | ||
==== | ||
|
||
If the dashboard JSON 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. | ||
|
||
|
||
== Supported reports | ||
|
||
[cols="9,^4",options="header",grid="cols"] | ||
|=== | ||
| NeoDash | Aura dashboards | ||
|
||
| Table | ✅ | ||
| Graph | ✅ | ||
| Bar chart | ✅ | ||
| Pie chart | ✅ | ||
| Line chart | ✅ | ||
| Map | Converted to graph | ||
| Single value | ✅ | ||
| Raw JSON | ❌ | ||
| Parameter select | Only node and relationship properties | ||
| Form | ❌ | ||
| iFrame | ❌ | ||
| Markdown | ✅ | ||
|
||
|=== | ||
|
||
Advanced NeoDash reports added via the Advanced visualization extension are not supported. | ||
|
||
|
||
== Summary | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can this be a list? or something more concise? it feels like a lot to digest |
||
|
||
Data fields relevant to the import are displayed under **Summary**. | ||
|
||
The latest version of both NeoDash Labs and NeoDash commercial are supported. | ||
However, the import procedure can always attempt to import a dashboard JSON, even if the version differs from those. | ||
|
||
The summary includes: | ||
|
||
* the number of imported pages, cards, parameters and filters. | ||
* the number of cards and filters that were _migrated_, _converted_ or _skipped_. | ||
** _Migrated_ cards and filters have a type that is supported by Aura dashboards. | ||
** _Converted_ cards and filters have a closest supported similar type available in Aura dashboards. | ||
For example a NeoDash commercial map report is converted to an Aura dashboard graph visualization. | ||
** The import procedure _skips_ any types it can neither migrate nor convert. | ||
|
||
Note that not all settings from NeoDash reports have a counterpart in Aura dashboards. | ||
Any such settings do not affect the import and are not preserved by the import procedure. | ||
|
||
|
||
== Details | ||
|
||
Expand the **Details** to inspect incidents reported during the import. | ||
|
||
Entries include the location of the incident in the dashboard JSON, that is, the specific page and report, as well as a description what went wrong or is of note. | ||
|
||
Descriptions can be, for example: | ||
|
||
* Unsupported parameter select types, resulting in skipped filters. | ||
* Missing entity and/or property types, missing parameter names. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,15 +15,18 @@ The number of dashboards you can create depends on your Aura tier: | |
|
||
== 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**. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this UI will change: https://linear.app/neo4j/issue/DASH-337/improve-quality-of-empty-states There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. when will it be available? asking because i think i need to retake some screenshots :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it's planned for this DevCycle, so probably in the next 2-3 weeks. |
||
Alternatively, select **Create with AI**. | ||
|
||
.Create your first dashboard | ||
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**. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here, UI will change |
||
|
||
**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. | ||
|
||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added this note, but let's avoid making promises in the docs :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lets remember to remove this note in a couple of weeks