data view side panel explore button #135224

ppisljar · 2022-06-27T13:51:59Z

Summary

Adds explore button to create dataview side panel which creates an ad-hoc dataview.
The button is only shown if allowAdHocDataView prop is set to true.
Clicking the button returns a dataview instance to the caller but does not create a saved object.

resolves #132709

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

flash1293 · 2022-06-28T07:36:40Z

I think this is great as a first step 👍

I think it would make sense to show a tooltip when hovering over the button (something like "Use Kibana without persisting the data view. You can always save it later on")

ppisljar · 2022-06-28T09:29:47Z

currently the tooltip says Explore creates a DataView without persisting it in a saved object. @ghudgins what should we set this to ?

lukasolson

I'm not sure how much feedback you want on the UX right now, but clicking "explore" doesn't select the ad-hoc data view (the previously-selected data view stays active), and it still says "Saved ." Can we make the notification text conditional on whether a saved object was actually created, and switch to the ad-hoc data view when "explore" is clicked?

ppisljar · 2022-06-30T05:09:48Z

@lukasolson no application is integrated with this jet, so explore button should never show up yet. If you would to enable it you would also need to correctly handle the ad hoc dataview (show it in the dropdown etc).

@ghudgins what do you think about changing the notification text ?

lukasolson

LGTM

kertal · 2022-07-05T15:09:19Z

I'm not sure how much feedback you want on the UX right now, but clicking "explore" doesn't select the ad-hoc data view (the previously-selected data view stays active), and it still says "Saved ." Can we make the notification text conditional on whether a saved object was actually created, and switch to the ad-hoc data view when "explore" is clicked?

+1 for that, I'm currently having hands on this PR, and I think the text should be conditional
Also have a question, the ad-hoc data view is getting an id ... if it is persisted is this id kept?
Another question, the wording "Save data view to Kibana" are we sure users know what we mean with that, just was wondering if we have similar wording in other parts of our software?

flash1293 · 2022-07-05T15:33:30Z

and switch to the ad-hoc data view when "explore" is clicked?

I think this is out of scope for this PR - the consumer has to take care of that (Discover / Lens / ...)

ppisljar · 2022-07-05T15:41:04Z

yes, adhoc data view gets an id and its not going to change if the dataview is persisted.

kertal · 2022-07-05T18:33:51Z

FYI, very hacky, but I managed to convince consumer Discover to use it, here is the first ad-hoc one that worked

:

mdefazio · 2022-07-06T13:37:17Z

What if the 'Explore' button instead said 'Preview data view'? And then the tooltip text:

Preview this DataView without creating a saved object

Could maybe even go so far as to shorten them to be Preview | Save data view?

If we show a toast following these actions, when clicking 'Preview' we should mention it's not saved yet.

This is a preview of the data view. To use it in Kibana, save it first."

^^ That's not great copy, so just getting the idea down.

flash1293 · 2022-07-06T13:52:03Z

We planned to also allow the user to save a Lens vis / discover search together with the ad-hoc data view - it won't show up in the data view listing, it's basically part of the vis/search. Not sure whether "preview" fully captures this, it sounds like you have to turn it into a "real" data view before being able to do anything else with it

mdefazio · 2022-07-06T15:26:46Z

At what point would this ad-hoc view be discarded? If I'm able to create a Lens vis, and save it, does that then also save this data view? Apologies as I think I'm jumping into the middle here.

How can I get this to show up if I run this PR locally? Or can we include the toast(s) in the pr description?

Let me know if I'm expanding outside the scope of this PR :)

gchaps · 2022-07-06T20:21:15Z

+1 to Preview | Save data view

Here's another suggestion for the tooltip:

View what's inside this data view before saving it.

I don't usually see a tooltip on a button. Is there another way we can present this information?

ppisljar · 2022-07-07T06:56:12Z

@kertal can you share your code in a PR ? i am wondering why runtime fields etc are not working as it should come out of the box .

kertal · 2022-07-07T07:00:50Z

@ppisljar sure! #135770

mdefazio · 2022-07-07T11:22:21Z

I don't usually see a tooltip on a button. Is there another way we can present this information?

Discussed with @gchaps and we are aligned on showing this tooltip on a button. There was some initial confusion on how this was presented, but having an EuiTooltip on a button is fine.

mdefazio · 2022-07-07T11:26:17Z

here you can test it...

This is so awesome 🙌

flash1293 · 2022-07-07T11:29:33Z

@gchaps Can you explain why you think "Preview" is the right wording in the context of #135224 (comment) ? I can totally imagining this way being a common approach of using Discover / Visualize at some point and at least to me "Preview" has a kind of temporary / "not the actual thing" feeling to it

mdefazio · 2022-07-07T12:20:16Z

Here's a flow showing a complete path from creating an ad hoc view to saving it. When you all get a chance, do you mind reviewing it to make sure I am understanding the complete context?

Hopefully this will also help lend some insight into what to label the buttons.

I know that some of this is outside this PR and depends on the consumer of this, but thought it'd be good to nail down our preferred full flow for it regardless.

Again, perhaps outside the scope here, but I didn't see how to save an ad hoc view once I've gone down the path of 'exploring' it.

Whimsical flow
Screenshot:

mattkime · 2022-07-07T13:58:56Z

This is a nice step forward but I wonder if long term it would make more sense to have a smaller UI for creating ad hoc data views. There's a lot of functionality in the main data view creation flow that we could reasonably expect a user to ignore if they're working quickly - ad hoc data views are unlikely to need a name (could just use the index pattern), field formatting and other field level options.

flash1293 · 2022-07-07T14:33:30Z

@mattkime That's definitely the plan - @cchaos actually prepared some mockups for that already, but we decided to go with just the bare functionality and the existing UI first to de-risk shipping this. Then in a follow-up we can add an inline-ui (it's planned to live in the data view selection popover of unified search)

ghudgins · 2022-07-07T16:26:52Z

I agree with @flash1293 that Preview seems too temporary given you can save the UI with an ad hoc data view permanently. Said another way, I might click this temporary option and be totally happy that it's only in use on this one visualization and never return to save it as a data view

I also agree with @gchaps that Explore is ambiguous when compared to the other option which is pretty clear (Save this data view).

Maybe we could come up with other ideas that are more explicit? I can't seem to get away with not changing the existing "Save data view to Kibana" because, technically, they're both data views in different states of re-use

Here's an alternative:

Use this selection | Save selection as data view
Use this selection | Save data view to Kibana (what it is today)
Use this selection | Save to Data View menu
Use without saving | Save to Data View Menu

...but i'm not sure I love it. ideas?

flash1293 · 2022-07-07T16:30:09Z

Maybe we need to introduce the notion of the “data view library” to disambiguate?

ghudgins · 2022-07-07T16:33:32Z

Maybe we need to introduce the notion of the “data view library” to disambiguate?

isn't the data view menu the library in this case? that's where you'll see data views. not sure we need another listing experience....but i'm also not sure the menu has a name for anyone but us

flash1293 · 2022-07-07T16:43:47Z

That’s what I meant - we call the data views management page the “data view library” and refer to it as such everywhere. “Save to library” will have a clear meaning and it’s consistent with visualize library

gchaps · 2022-07-07T18:01:13Z

@flash1293 Sorry I missed your previous comment about "preview", and I see your point. Given your and Graham's suggestions, I wonder if this combination might work:

Use without saving | Save to library

jughosta · 2022-07-07T18:12:43Z

Hi! Sorry for jumping in here. As I understand we are introducing ad-hoc data views to make it easier/faster to start seeing data, right? I think having an option to not save a data view in a modal with "Create Data View" title looks confusing. Also we are integrating it inside the flyout which can be opened only after pressing "Create a data view" button in the data view switcher. User would have to make an extra decision at the end of the flow.

What do you think about introducing a separate entry point? This way user decides first to save or not to save and then proceeds with entering an index pattern and a time field. And we could render a modal title and a single bottom button depending on that entry point.

ghudgins · 2022-07-07T18:15:07Z

@jughosta we have plans for this in a subsequent phase. happy to share some designs to get your feedback! edit: this first phase is really about getting the minimum user interface in so we can work through the backend changes

jughosta · 2022-07-07T18:17:20Z

@jughosta we have plans for this in a subsequent phase. happy to share some designs to get your feedback!

Great! Thanks @ghudgins !

ppisljar · 2022-07-11T03:48:52Z

This is a nice step forward but I wonder if long term it would make more sense to have a smaller UI for creating ad hoc data views. There's a lot of functionality in the main data view creation flow that we could reasonably expect a user to ignore if they're working quickly - ad hoc data views are unlikely to need a name (could just use the index pattern), field formatting and other field level options.

i would argue that everything you want to do with the saved one you want to do with the ad-hoc one. Yes possibly we want to have a quicker way to get there, but making some options not available at all just sets us back and gets us in this bad place again where the user experience is different based on wether you work with ad hoc or normal dataview.

thats also the reason why i think the flow diagram @mdefazio posted is over complicated. It brings in lens, discover, ....
I think its important here to understand that what happens with the dataview once its created is completely open and should not depend on wether the dataview is saved or ad hoc. For user it shouldn't matter that he is creating a lens chart of the saved search that uses an ad hoc dataview for example.

ppisljar · 2022-07-11T09:10:37Z

@kertal it looks fieldAttrs can't be extended on the dataview instance returned by the data view editor. cc @mattkime do you have any idea why that would be ? if i override fieldAttrs inside the create method with an empty object {} this starts to work. I don't understand how this worked in my PoC where i tested this :|

ppisljar · 2022-07-12T09:03:01Z

@ghudgins to move forward with this, what do you think about:

we rename the button to use without saving
the tooltip says Use this DataView without creating a Kibana saved object

we leave the save dataview button for now and in a follow up we can rename the dataview management to dataview library and update all the other texts accordingly.

ghudgins · 2022-07-12T14:24:03Z

sounds reasonable. I agree the library change is a bigger one

gchaps · 2022-07-12T14:38:45Z

We write data view as two words and try to avoid using Kibana in our copy. So if it is not necessary here, I suggest:

Use this data view without creating a saved object.

kibana-ci · 2022-07-13T04:25:34Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dataViewEditor`	30.7KB	31.6KB	+928.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`dataViewEditor`	10.2KB	10.2KB	+87.0B

Unknown metric groups

API count

id	before	after	diff
`dataViewEditor`	14	15	+1

History

💚 Build #56915 succeeded 82d2480
💔 Build #56894 failed da5fda4
💛 Build #56516 was flaky 61b52f0
💔 Build #55805 failed a878c93
💚 Build #55144 succeeded 168e381
💛 Build #53796 was flaky ed32da8

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

ppisljar requested a review from a team as a code owner June 27, 2022 13:51

ppisljar added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.4.0 WIP Work in progress labels Jun 27, 2022

ppisljar force-pushed the adhocdataviews/sidebar branch from a269e39 to 1fe308f Compare June 27, 2022 14:27

ppisljar requested a review from a team as a code owner June 27, 2022 14:27

ppisljar removed the request for review from a team June 27, 2022 14:55

ppisljar force-pushed the adhocdataviews/sidebar branch from 85526a2 to dfda7e2 Compare June 28, 2022 05:43

ppisljar added 4 commits June 28, 2022 03:40

data view side panel explore button

0711ffb

reverting discover changes

ddc522e

fix wording and color

d26ade5

fix

ed32da8

ppisljar force-pushed the adhocdataviews/sidebar branch from 1b6c0c9 to ed32da8 Compare June 28, 2022 10:44

ppisljar removed the WIP Work in progress label Jun 28, 2022

ppisljar requested a review from ghudgins June 28, 2022 12:57

lukasolson reviewed Jun 29, 2022

View reviewed changes

Merge branch 'main' into adhocdataviews/sidebar

168e381

lukasolson approved these changes Jul 5, 2022

View reviewed changes

KOTungseth added the ui-copy Review of UI copy with docs team is recommended label Jul 5, 2022

Merge branch 'main' into adhocdataviews/sidebar

a878c93

Merge branch 'main' into adhocdataviews/sidebar

61b52f0

ppisljar added 2 commits July 12, 2022 06:05

Merge branch 'main' into adhocdataviews/sidebar

da5fda4

Merge branch 'main' into adhocdataviews/sidebar

82d2480

update wording

4a5307b

ppisljar removed the request for review from ghudgins July 13, 2022 03:14

ppisljar merged commit 6f9d771 into elastic:main Jul 13, 2022

data view side panel explore button #135224

data view side panel explore button #135224

Conversation

ppisljar commented Jun 27, 2022 • edited Loading

Summary

Checklist

flash1293 commented Jun 28, 2022

ppisljar commented Jun 28, 2022

lukasolson left a comment

Choose a reason for hiding this comment

ppisljar commented Jun 30, 2022

lukasolson left a comment

Choose a reason for hiding this comment

kertal commented Jul 5, 2022 • edited Loading

flash1293 commented Jul 5, 2022

ppisljar commented Jul 5, 2022

kertal commented Jul 5, 2022

mdefazio commented Jul 6, 2022

flash1293 commented Jul 6, 2022 • edited Loading

mdefazio commented Jul 6, 2022

gchaps commented Jul 6, 2022 • edited Loading

ppisljar commented Jul 7, 2022

kertal commented Jul 7, 2022

mdefazio commented Jul 7, 2022

mdefazio commented Jul 7, 2022

flash1293 commented Jul 7, 2022

mdefazio commented Jul 7, 2022

mattkime commented Jul 7, 2022

flash1293 commented Jul 7, 2022

ghudgins commented Jul 7, 2022 • edited Loading

flash1293 commented Jul 7, 2022

ghudgins commented Jul 7, 2022

flash1293 commented Jul 7, 2022

gchaps commented Jul 7, 2022 • edited Loading

jughosta commented Jul 7, 2022 • edited Loading

ghudgins commented Jul 7, 2022 • edited Loading

jughosta commented Jul 7, 2022

ppisljar commented Jul 11, 2022

ppisljar commented Jul 11, 2022

ppisljar commented Jul 12, 2022 • edited Loading

ghudgins commented Jul 12, 2022

gchaps commented Jul 12, 2022 • edited Loading

kibana-ci commented Jul 13, 2022

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

API count

History

ppisljar commented Jun 27, 2022 •

edited

Loading

kertal commented Jul 5, 2022 •

edited

Loading

flash1293 commented Jul 6, 2022 •

edited

Loading

gchaps commented Jul 6, 2022 •

edited

Loading

ghudgins commented Jul 7, 2022 •

edited

Loading

gchaps commented Jul 7, 2022 •

edited

Loading

jughosta commented Jul 7, 2022 •

edited

Loading

ghudgins commented Jul 7, 2022 •

edited

Loading

ppisljar commented Jul 12, 2022 •

edited

Loading

gchaps commented Jul 12, 2022 •

edited

Loading