Skip to content

Commit 966c104

Browse files
nastasha-solomonbenironsidenatasha-moore-elastic
authored
[Request] [8.18, 9.0, and Serverless] Observables can be added to cases (#6477)
* First draft * fixed anchor ref * Fixes minor heading issues * Adds reqs for Serverless and ESS * Revisions to text * Fixes error * Refreshes images * more new images * Fixed reference to image * Resizes images * Moves images down * Update docs/cases/cases-manage.asciidoc Co-authored-by: Benjamin Ironside Goldstein <[email protected]> * Update docs/cases/cases-manage.asciidoc Co-authored-by: Benjamin Ironside Goldstein <[email protected]> * Ben's edits * Update docs/cases/cases-manage-settings.asciidoc * Applying more of Ben's edits * Update docs/cases/cases-manage.asciidoc Co-authored-by: natasha-moore-elastic <[email protected]> * Update docs/cases/cases-manage.asciidoc Co-authored-by: natasha-moore-elastic <[email protected]> * Update docs/cases/cases-manage-settings.asciidoc Co-authored-by: natasha-moore-elastic <[email protected]> * Nat's edits and other syntax edits --------- Co-authored-by: Benjamin Ironside Goldstein <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]>
1 parent 31791b5 commit 966c104

20 files changed

+116
-2
lines changed

docs/cases/cases-manage-settings.asciidoc

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:frontmatter-tags-content-type: [how-to]
66
:frontmatter-tags-user-goals: [analyze]
77

8-
To change case closure options and add custom fields, templates, and connectors for external incident management systems, find **Cases** in the navigation menu or search for `Security/Cases` by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then click **Settings**.
8+
To change case closure options, add custom fields, templates, and connectors for external incident management systems, and create custom observable types, find **Cases** in the navigation menu or search for `Security/Cases` by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field], then click **Settings**.
99

1010
[role="screenshot"]
1111
image::images/cases-settings.png[Shows the case settings page]
@@ -123,3 +123,27 @@ image::images/cases-add-template.png[Add a template in case settings]
123123
When users create cases, they can optionally select a template and use its values or override them.
124124

125125
NOTE: If you update or delete templates, existing cases are unaffected.
126+
127+
[float]
128+
[[cases-observable-types]]
129+
=== Observable types
130+
131+
.Requirements
132+
[sidebar]
133+
--
134+
To use observables, you must have a https://www.elastic.co/pricing[Platinum subscription] or higher.
135+
--
136+
137+
Create custom observable types for enhanced case collaboration.
138+
139+
. In the **Observable types** section, click **Add observable type**.
140+
. Enter a descriptive label for the observable type, then click **Save**.
141+
142+
After creating a new observable type, you can remove or edit it from the **Settings** page.
143+
144+
NOTE: You can create up to 10 custom observable types.
145+
146+
IMPORTANT: Deleting a custom observable type deletes all instances of it.
147+
148+
[role="screenshot"]
149+
image::images/cases-observable-types.png[Add an observable type in case settings]

docs/cases/cases-manage.asciidoc

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ TIP: Comments can contain Markdown. For syntax help, click the Markdown icon (im
101101
* <<cases-lens-visualization>>
102102
* Modify the case's description, assignees, category, severity, status, and tags.
103103
* <<cases-ui-integrations,Manage connectors>> and send updates to external systems (if you've added a connector to the case)
104+
* <<cases-add-observables>>
104105
* <<cases-copy-case-uuid>>
105106
* Refresh the case to retrieve the latest updates
106107

@@ -194,14 +195,46 @@ After a visualization has been added to a case, you can modify or interact with
194195
[role="screenshot"]
195196
image::images/cases-open-vis.png[Shows where the Open Visualization option is]
196197

198+
[float]
199+
[[cases-add-observables]]
200+
=== Add observables
201+
202+
.Requirements
203+
[sidebar]
204+
--
205+
To use observables, you must have a https://www.elastic.co/pricing[Platinum subscription] or higher.
206+
--
207+
208+
An observable is a piece of information about an investigation, for example, a suspicious URL or a file hash. Use observables to identify correlated events and better understand the severity and scope of a case.
209+
210+
To create an observable:
211+
212+
. Click the **Observables** tab, then click **Add observable**.
213+
+
214+
NOTE: Each case can have a maximum of 50 observables.
215+
+
216+
. Provide the necessary details:
217+
** **Type**: Select a type for the observable. You can choose a preset type or a <<cases-observable-types,custom one>>.
218+
** **Value**: Enter a value for the observable. The value must align with the type you select.
219+
** **Description** (Optional): Provide additional information about the observable.
220+
221+
. Click **Add observable**.
222+
223+
After adding an observable to a case, you can remove or edit it by using the **Actions** menu (**…**).
224+
225+
TIP: Go to the **Similar cases** tab to access other cases with the same observables.
226+
227+
[role="screenshot"]
228+
image::images/cases-add-observables.png[Shows you where to add observables]
229+
197230
[float]
198231
[[cases-copy-case-uuid]]
199232
=== Copy the case UUID
200233

201234
Each case has a universally unique identifier (UUID) that you can copy and share. To copy a case's UUID to a clipboard, go to the Cases page and select *Actions* -> *Copy Case ID* for the case you want to share. Alternatively, go to a case's details page, then from the *More actions* menu (…​), select *Copy Case ID*.
202235

203236
[role="screenshot"]
204-
image::images/cases-copy-case-id.png[Copy Case ID option in More actions menu 40%,40%]
237+
image::images/cases-copy-case-id.png[Copy Case ID option in More actions menu 30%,30%]
205238

206239
[float]
207240
[[cases-export-import]]
68.2 KB
Loading
129 KB
Loading

docs/cases/images/cases-home-page.png

2.48 KB
Loading
12.2 KB
Loading
80.2 KB
Loading

docs/cases/images/cases-settings.png

118 KB
Loading

docs/cases/images/cases-summary.png

44.8 KB
Loading

docs/cases/images/cases-ui-open.png

37.6 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/serverless/investigate/cases-open-manage.asciidoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ Comments can contain Markdown. For syntax help, click the Markdown icon (image:i
108108
* <<cases-lens-visualization,Add a Lens visualization>>
109109
* Modify the case's description, assignees, category, severity, status, and tags.
110110
* Manage connectors and send updates to external systems (if you've added a connector to the case)
111+
* <<cases-add-observables>>
111112
* <<cases-copy-case-uuid,Copy the case UUID>>
112113
* Refresh the case to retrieve the latest updates
113114

@@ -212,6 +213,38 @@ After a visualization has been added to a case, you can modify or interact with
212213
[role="screenshot"]
213214
image::images/cases-open-manage/-cases-cases-open-vis.png[Shows where the Open Visualization option is]
214215

216+
[float]
217+
[[cases-add-observables]]
218+
=== Add observables
219+
220+
.Requirements
221+
[sidebar]
222+
--
223+
To use observables, you must have the Security Analytics Essentials <<elasticsearch-manage-project,project feature>>.
224+
--
225+
226+
An observable is a piece of information about an investigation, for example, a suspicious URL or a file hash. Use observables to identify correlated events and better understand the severity and scope of a case.
227+
228+
To create an observable:
229+
230+
. Click the **Observables** tab, then click **Add observable**.
231+
+
232+
NOTE: Each case can have a maximum of 50 observables.
233+
+
234+
. Provide the necessary details:
235+
** **Type**: Select a type for the observable. You can choose a preset type or a <<security-cases-observable-types,custom one>>.
236+
** **Value**: Enter a value for the observable. The value must align with the type you select.
237+
** **Description** (Optional): Provide additional information about the observable.
238+
239+
. Click **Add observable**.
240+
241+
After adding an observable to a case, you can remove or edit it by using the **Actions** menu (**…**).
242+
243+
TIP: Go to the **Similar cases** tab to access other cases with the same observables.
244+
245+
[role="screenshot"]
246+
image::images/cases-open-manage/-cases-cases-add-observables.png[Shows you where to add observables]
247+
215248
[discrete]
216249
[[cases-copy-case-uuid]]
217250
=== Copy the case UUID

docs/serverless/investigate/cases-settings.asciidoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,3 +124,27 @@ When users create cases, they can optionally select a template and use its field
124124
====
125125
If you update or delete templates, existing cases are unaffected.
126126
====
127+
128+
[float]
129+
[[security-cases-observable-types]]
130+
== Observable types
131+
132+
.Requirements
133+
[sidebar]
134+
--
135+
To use observables, you must have the Security Analytics Essentials <<elasticsearch-manage-project,project feature>>.
136+
--
137+
138+
Create custom observable types for enhanced case collaboration.
139+
140+
. In the **Observable types** section, click **Add observable type**.
141+
. Enter a descriptive label for the observable type, then click **Save**.
142+
143+
After creating a new observable type, you can remove or edit it from the **Settings** page.
144+
145+
NOTE: You can create up to 10 custom observable types.
146+
147+
IMPORTANT: Deleting a custom observable type deletes all instances of it.
148+
149+
[role="screenshot"]
150+
image::images/cases-settings/security-cases-observable-types.png[Add an observable type in case settings]

0 commit comments

Comments
 (0)