Skip to content

Commit 5e11332

Browse files
committed
[E&A] Refines Cases section.
1 parent 38b121a commit 5e11332

File tree

3 files changed

+45
-75
lines changed

3 files changed

+45
-75
lines changed

explore-analyze/alerts-cases/cases/manage-cases-settings.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,22 @@ If you close cases in your external incident management system, they will remain
2020

2121
To change whether cases are automatically closed after they are sent to an external system, update the case closure options.
2222

23-
2423
## External incident management systems [case-connectors]
2524

2625
You can add connectors to cases to push information to these external incident management systems:
2726

28-
* {ibm-r}
29-
* {jira}
30-
* {sn-itsm}
31-
* {sn-sir}
32-
* {swimlane}
33-
* {hive}
34-
* {webhook-cm}
27+
* {{ibm-r}}
28+
* {{jira}}
29+
* {{sn-itsm}}
30+
* {{sn-sir}}
31+
* {{swimlane}}
32+
* {{hive}}
33+
* {{webhook-cm}}
3534

3635
::::{note}
3736
To create connectors and send cases to external systems, you must have the appropriate {{kib}} feature privileges. Refer to [Configure access to cases](setup-cases.md).
3837
::::
3938

40-
4139
You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}**, as described in [*Connectors*](../../../deploy-manage/manage-connectors.md). Alternatively, you can create them in **{{stack-manage-app}} > Cases > Settings**:
4240

4341
1. From the **Incident management system** list, select **Add new connector**.
@@ -48,44 +46,39 @@ You can subsequently choose the connector when you create cases and use it in ca
4846

4947
To update a connector, click **Update <connector name>** and edit the connector fields as required.
5048

51-
5249
## Custom fields [case-custom-fields]
5350

5451
You can add optional and required fields for customized case collaboration. [8.15.0]
5552

5653
To create a custom field:
5754

5855
1. In the **Custom fields** section, click **Add field**.
59-
60-
:::{image} ../../../images/kibana-cases-custom-fields-add.png
61-
:alt: Add a custom field in case settings
62-
:class: screenshot
63-
:::
56+
:::{image} ../../../images/kibana-cases-custom-fields-add.png
57+
:alt: Add a custom field in case settings
58+
:class: screenshot
59+
:::
6460

6561
2. You must provide a field label and type (text or toggle). You can optionally designate it as a required field and provide a default value.
6662

6763
When you create a custom field, it’s added to all new and existing cases. Existing cases have null values for new text fields until you set them in each case.
6864

6965
You can subsequently remove or edit custom fields on the **Settings** page.
7066

71-
7267
## Templates [case-templates]
7368

7469
::::{warning}
7570
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
7671
::::
7772

78-
7973
You can make the case creation process faster and more consistent by adding templates. A template defines values for one or all of the case fields (such as severity, tags, description, and title) as well as any custom fields.
8074

8175
To create a template:
8276

8377
1. In the **Templates** section, click **Add template**.
84-
85-
:::{image} ../../../images/kibana-cases-templates-add.png
86-
:alt: Add a template in case settings
87-
:class: screenshot
88-
:::
78+
:::{image} ../../../images/kibana-cases-templates-add.png
79+
:alt: Add a template in case settings
80+
:class: screenshot
81+
:::
8982

9083
2. You must provide a template name and case severity. You can optionally add template tags and a description, values for each case field, and a case connector.
9184

@@ -94,6 +87,3 @@ When users create cases, they can optionally select a template and use its value
9487
::::{note}
9588
If you update or delete templates, existing cases are unaffected.
9689
::::
97-
98-
99-

explore-analyze/alerts-cases/cases/manage-cases.md

Lines changed: 30 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,16 @@ To perform these tasks, you must have [full access](setup-cases.md) to the appro
1212
Open a new case to keep track of issues and share their details with colleagues.
1313

1414
1. Go to **Management > {{stack-manage-app}} > Cases**, then click **Create case**.
15-
16-
:::{image} ../../../images/kibana-cases-create.png
17-
:alt: Create a case in {stack-manage-app}
18-
:class: screenshot
19-
:::
15+
:::{image} ../../../images/kibana-cases-create.png
16+
:alt: Create a case in {stack-manage-app}
17+
:class: screenshot
18+
:::
2019

2120
2. If you defined [templates](manage-cases-settings.md#case-templates), you can optionally select one to use its default field values. [preview]
2221
3. Give the case a name, severity, and description.
23-
24-
::::{tip}
25-
In the `Description` area, you can use [Markdown](https://www.markdownguide.org/cheat-sheet) syntax to create formatted text.
26-
::::
22+
::::{tip}
23+
In the `Description` area, you can use [Markdown](https://www.markdownguide.org/cheat-sheet) syntax to create formatted text.
24+
::::
2725

2826
4. Optionally, add a category, assignees, and tags. You can add users only if they meet the necessary [prerequisites](setup-cases.md).
2927
5. If you defined any [custom fields](manage-cases-settings.md#case-custom-fields), they appear in the **Additional fields** section. [8.15.0]
@@ -32,7 +30,6 @@ Open a new case to keep track of issues and share their details with colleagues.
3230

3331
[preview] Alternatively, you can configure your rules to automatically create cases by using [case actions](https://www.elastic.co/guide/en/kibana/current/cases-action-type.html). By default, the rule adds all of the alerts within a specified time window to a single case. You can optionally choose a field to group the alerts and create separate cases for each group. You can also choose whether you want the rule to reopen cases or open new ones when the time window elapses.
3432

35-
3633
## Add email notifications [add-case-notifications]
3734

3835
You can configure email notifications that occur when users are assigned to cases.
@@ -43,38 +40,35 @@ For hosted {{kib}} on {{ess}}:
4340

4441
You do not need to take any more steps to configure an email connector or update {{kib}} user settings, since the preconfigured Elastic-Cloud-SMTP connector is used by default.
4542

46-
4743
For self-managed {{kib}}:
4844

4945
1. Create a preconfigured email connector.
50-
51-
::::{note}
52-
At this time, email notifications support only preconfigured connectors, which are defined in the `kibana.yml` file. For examples, refer to [Email connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html#preconfigured-email-configuration) and [Configure email accounts for well-known services](https://www.elastic.co/guide/en/kibana/current/email-action-type.html#configuring-email).
53-
::::
46+
::::{note}
47+
At this time, email notifications support only preconfigured connectors, which are defined in the `kibana.yml` file. For examples, refer to [Email connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html#preconfigured-email-configuration) and [Configure email accounts for well-known services](https://www.elastic.co/guide/en/kibana/current/email-action-type.html#configuring-email).
48+
::::
5449

5550
2. Set the `notifications.connectors.default.email` {{kib}} setting in kibana.yml to the name of your email connector.
5651

57-
```js
58-
notifications.connectors.default.email: ‘mail-dev’
59-
60-
xpack.actions.preconfigured:
61-
mail-dev:
62-
name: preconfigured-email-notification-maildev
63-
actionTypeId: .email
64-
config:
65-
service: other
66-
from: from address
67-
host: host name
68-
port: port number
69-
secure: true/false
70-
hasAuth: true/false
71-
```
72-
73-
1. If you want the email notifications to contain links back to the case, you must configure the [server.publicBaseUrl](../../../deploy-manage/deploy/self-managed/configure.md#server-publicBaseUrl) setting.
52+
```js
53+
notifications.connectors.default.email: ‘mail-dev’
54+
55+
xpack.actions.preconfigured:
56+
mail-dev:
57+
name: preconfigured-email-notification-maildev
58+
actionTypeId: .email
59+
config:
60+
service: other
61+
from: from address
62+
host: host name
63+
port: port number
64+
secure: true/false
65+
hasAuth: true/false
66+
```
67+
68+
3. If you want the email notifications to contain links back to the case, you must configure the [server.publicBaseUrl](../../../deploy-manage/deploy/self-managed/configure.md#server-publicBaseUrl) setting.
7469

7570
When you subsequently add assignees to cases, they receive an email.
7671

77-
7872
## Add files [add-case-files]
7973

8074
After you create a case, you can upload and manage files on the **Files** tab:
@@ -95,8 +89,6 @@ Uploaded files are also accessible in **{{stack-manage-app}} > Files**. When you
9589

9690
::::
9791

98-
99-
10092
## Add visualizations [add-case-visualization]
10193

10294
You can also optionally add visualizations. For example, you can portray event and alert data through charts and graphs.
@@ -110,10 +102,9 @@ To add a visualization to a comment within your case:
110102

111103
1. Click the **Visualization** button. The **Add visualization** dialog appears.
112104
2. Select an existing visualization from your Visualize Library or create a new visualization.
113-
114-
::::{important}
115-
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 viewers.
116-
::::
105+
::::{important}
106+
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 viewers.
107+
::::
117108

118109
3. After you’ve finished creating your visualization, click **Save and return** to go back to your case.
119110
4. Click **Preview** to see how the visualization will appear in the case comment.
@@ -123,7 +114,6 @@ Alternatively, while viewing a [dashboard](../../dashboards.md) you can open a p
123114

124115
After a visualization has been added to a case, you can modify or interact with it by clicking the **Open Visualization** option in the case’s comment menu.
125116

126-
127117
## Manage cases [manage-case]
128118

129119
In **Management > {{stack-manage-app}} > Cases**, you can search cases and filter them by attributes such as assignees, categories, severity, status, and tags. You can also select multiple cases and use bulk actions to delete cases or change their attributes.
@@ -141,5 +131,3 @@ To view a case, click on its name. You can then:
141131
* Change the severity.
142132
* Close or delete the case.
143133
* Reopen a closed case.
144-
145-

explore-analyze/alerts-cases/cases/setup-cases.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ mapped_pages:
77

88
To access cases in **{{stack-manage-app}}**, you must have the appropriate {{kib}} privileges:
99

10-
1110
## Give full access to manage cases and settings [_give_full_access_to_manage_cases_and_settings]
1211

1312
**{{kib}} privileges**
@@ -22,8 +21,6 @@ By default, `All` for the **Cases** feature includes authority to delete cases a
2221

2322
::::
2423

25-
26-
2724
## Give assignee access to cases [_give_assignee_access_to_cases]
2825

2926
**{{kib}} privileges**
@@ -37,8 +34,6 @@ This privilege is also required to add [case actions](https://www.elastic.co/gui
3734

3835
::::
3936

40-
41-
4237
## Give view-only access to cases [_give_view_only_access_to_cases]
4338

4439
**{{kib}} privileges**
@@ -49,15 +44,12 @@ This privilege is also required to add [case actions](https://www.elastic.co/gui
4944
You can customize sub-feature privileges for deleting cases and comments, editing case settings, adding case comments and attachments, and re-opening cases.
5045
::::
5146

52-
53-
5447
## Revoke all access to cases [_revoke_all_access_to_cases]
5548

5649
**{{kib}} privileges**
5750

5851
`None` for the **Cases** feature under **Management**.
5952

60-
6153
## More details [_more_details_2]
6254

6355
For more details, refer to [{{kib}} privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md).

0 commit comments

Comments
 (0)