Skip to content
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

[DOCS] Lens Visualization Plugin Available for Cases #1018

Merged
merged 10 commits into from
Sep 21, 2021
36 changes: 35 additions & 1 deletion docs/cases/cases-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ timeline link (click the icon in the top right corner of the area).
external system.

[role="screenshot"]
image::images/cases-ui-open.png[]
image::images/cases-ui-open.png[Shows an open case]

[float]
[[cases-ui-manage]]
Expand All @@ -59,6 +59,7 @@ You can search existing cases and filter them by tags, reporter, and status
To view a case, click on its name. You can then:

* Add a new comment
* <<cases-lens-visualization>>
* Edit existing comments and the case's description
* Add a connector (if you did not select one while creating the case)
* Send updates to external systems (if external connections are configured)
Expand All @@ -68,3 +69,36 @@ To view a case, click on its name. You can then:
* Refresh the case to retrieve the latest updates

NOTE: Comments can also contain Markdown syntax and Timeline links.

[float]
[[cases-lens-visualization]]
== Add a Lens visualization

beta[]

Add a Lens visualization to your case to portray event and alert data through charts and graphs.

[role="screenshot"]
image::images/add-vis-to-case.gif[Shows how to add a visualization to a case]

To add a Lens visualization to a comment within your case:

. Click the *Visualization* button. The Add visualization dialog appears. 
. Select an existing visualization from your Visualize Library or create a new visualization.

+

IMPORTANT: Set an absolute time range for your visualization. This ensures your visualization doesn't change over time after you save it to your case and provides important context for other viewers.

+
. Save the visualization to your Visualize Library by clicking the *Save to library* button (optional).
.. Enter a title and description for the visualization. 
.. Choose whether you want to keep the *Update panel on Security* activated. This option is activated by default and automatically adds the visualization to your Visualize Library.
. After you've finished creating your visualization, click *Save and return* to go back to your case.
. Click *Preview* to see how the visualization will appear in the case comment.
. Click *Add Comment* to add the visualization to your case. 

NOTE: Once a visualization has been added to a case, it cannot be modified or deleted. However, you can interact with the visualization by clicking the *Open Visualization* option in the comment menu.

[role="screenshot"]
image::images/cases-open-vis.png[Shows where the Open Visualization option is]
Binary file added docs/cases/images/add-vis-to-case.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/cases/images/cases-lens-vis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/cases/images/cases-open-vis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.