Skip to content

Commit 5fc8caa

Browse files
lcawlmergify[bot]
authored andcommitted
Add TheHive connector for cases (#4292)
* Add TheHive connector for cases * Add TheHive connector for serverless cases * Refresh automated screenshot * Update docs/en/serverless/cases/manage-cases-settings.mdx Co-authored-by: DeDe Morton <[email protected]> --------- Co-authored-by: DeDe Morton <[email protected]> (cherry picked from commit 241b955) # Conflicts: # docs/en/serverless/cases/manage-cases-settings.mdx # docs/en/serverless/images/observability-cases-add-connector.png
1 parent 855ef55 commit 5fc8caa

File tree

3 files changed

+132
-3
lines changed

3 files changed

+132
-3
lines changed

docs/en/observability/manage-cases-settings.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ cases with that system using _connectors_. These third-party systems are support
2727
* {jira} (including {jira} Service Desk)
2828
* {ibm-r}
2929
* {swimlane}
30+
* TheHive
3031
* {webhook-cm}
3132

3233
IMPORTANT: To send cases to external systems, you need the appropriate license, and your role must
@@ -43,15 +44,15 @@ After creating a connector, you can set your cases to
4344
=== Create a connector
4445

4546
. From the *Incident management system* list, select *Add new connector*.
46-
. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*,
47-
or *{webhook-cm}*.
47+
. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*, *TheHive*, or *{webhook-cm}*.
4848

4949
. Enter your required settings. For connector configuration details, refer to
5050
{kibana-ref}/resilient-action-type.html[{ibm-r} connector],
5151
{kibana-ref}/jira-action-type.html[{jira} connector],
5252
{kibana-ref}/servicenow-action-type.html[{sn-itsm} connector],
5353
{kibana-ref}/servicenow-sir-action-type.html[{sn-sir} connector],
54-
{kibana-ref}/swimlane-action-type.html[{swimlane} connector], or
54+
{kibana-ref}/swimlane-action-type.html[{swimlane} connector],
55+
{kibana-ref}/thehive-action-type.html[TheHive connector], or
5556
{kibana-ref}/cases-webhook-action-type.html[{webhook-cm} connector].
5657

5758
. Click *Save*.
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
slug: /serverless/observability/case-settings
3+
title: Configure case settings
4+
description: Change the default behavior of ((observability)) cases by adding connectors, custom fields, templates, and closure options.
5+
tags: [ 'serverless', 'observability', 'how-to' ]
6+
---
7+
8+
<p><DocBadge template="technical preview" /></p>
9+
10+
import Roles from '../partials/roles.mdx'
11+
12+
<Roles role="Editor" goal="create and edit connectors" />
13+
14+
To access case settings in an ((observability)) project, go to **Cases****Settings**.
15+
16+
![View case settings](../images/observability-cases-settings.png)
17+
{/* NOTE: This is an autogenerated screenshot. Do not edit it directly. */}
18+
19+
## Case closures
20+
21+
If you close cases in your external incident management system, the cases will remain open in Elastic Observability until you close them manually (the information is only sent in one direction).
22+
23+
To close cases when they are sent to an external system, select **Automatically close cases when pushing new incident to external system**.
24+
25+
## External incident management systems
26+
27+
If you are using an external incident management system, you can integrate Elastic Observability
28+
cases with this system using connectors. These third-party systems are supported:
29+
30+
* ((ibm-r))
31+
* ((jira)) (including ((jira)) Service Desk)
32+
* ((sn-itsm))
33+
* ((sn-sir))
34+
* ((swimlane))
35+
* TheHive
36+
* ((webhook-cm))
37+
38+
You need to create a connector to send cases, which stores the information required to interact
39+
with an external system. For each case, you can send the title, description, and comment when
40+
you choose to push the case — for the **Webhook - Case Management** connector, you can also
41+
send the status and severity fields.
42+
43+
<DocCallOut title="Important" color="warning">
44+
{/* TODO: Verify user roles needed to create connectors... */}
45+
To add, modify, or delete a connector, you must have the Admin user role for the project
46+
(or a more permissive role).
47+
</DocCallOut>
48+
49+
After creating a connector, you can set your cases to
50+
automatically close when they are sent to an external system.
51+
52+
### Create a connector
53+
54+
1. From the **Incident management system** list, select **Add new connector**.
55+
1. Select the system to send cases to: **((sn))**, **((jira))**, **((ibm-r))**,
56+
**((swimlane))**, **TheHive**, or **((webhook-cm))**.
57+
58+
![Add a connector to send cases to an external source](../images/observability-cases-add-connector.png)
59+
{/* NOTE: This is an autogenerated screenshot. Do not edit it directly. */}
60+
61+
1. Enter your required settings. For connector configuration details, refer to:
62+
- [((ibm-r)) connector](((kibana-ref))/resilient-action-type.html)
63+
- [((jira)) connector](((kibana-ref))/jira-action-type.html)
64+
- [((sn-itsm)) connector](((kibana-ref))/servicenow-action-type.html)
65+
- [((sn-sir)) connector](((kibana-ref))/servicenow-sir-action-type.html)
66+
- [((swimlane)) connector](((kibana-ref))/swimlane-action-type.html)
67+
- [TheHive connector](((kibana-ref))/thehive-action-type.html)
68+
- [((webhook-cm)) connector](((kibana-ref))/cases-webhook-action-type.html)
69+
70+
1. Click **Save**.
71+
72+
### Edit a connector
73+
74+
You can create additional connectors, update existing connectors, and change the connector used to send cases to external systems.
75+
76+
<DocCallOut title="Tip">
77+
You can also configure which connector is used for each case individually. Refer to <DocLink slug="/serverless/observability/create-a-new-case"/>.
78+
</DocCallOut>
79+
80+
To change the default connector used to send cases to external systems:
81+
82+
1. Select the required connector from the **Incident management system** list.
83+
84+
To update an existing connector:
85+
86+
1. Click **Update \<connector name>**.
87+
1. Update the connector fields as required.
88+
89+
## Custom fields
90+
91+
You can add optional and required fields for customized case collaboration.
92+
93+
To create a custom field:
94+
95+
1. In the **Custom fields** section, click **Add field**.
96+
97+
![Add a custom field](../images/observability-cases-custom-fields.png)
98+
{/* NOTE: This is an autogenerated screenshot. Do not edit it directly. */}
99+
100+
1. You must provide a field label and type (text or toggle).
101+
You can optionally designate it as a required field and provide a default value.
102+
103+
When you create a custom field, it's added to all new and existing cases.
104+
In existing cases, new custom text fields initially have null values.
105+
106+
You can subsequently remove or edit custom fields on the **Settings** page.
107+
108+
## Templates
109+
110+
<DocCallOut template="technical_preview" />
111+
112+
You can make the case creation process faster and more consistent by adding templates.
113+
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.
114+
115+
To create a template:
116+
117+
1. In the **Templates** section, click **Add template**.
118+
119+
![Add a case template](../images/observability-cases-templates.png)
120+
{/* NOTE: This is an autogenerated screenshot. Do not edit it directly. */}
121+
122+
1. 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.
123+
124+
When users create cases, they can optionally select a template and use its field values or override them.
125+
126+
<DocCallOut>
127+
If you update or delete templates, existing cases are unaffected.
128+
</DocCallOut>
337 KB
Loading

0 commit comments

Comments
 (0)