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

[8.15](backport #4069) Restructure case settings page #4074

Merged
merged 1 commit into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/en/observability/images/cases-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ include::grant-cases-access.asciidoc[leveloffset=+2]

include::manage-cases.asciidoc[leveloffset=+2]

include::create-observability-connectors.asciidoc[leveloffset=+2]
include::manage-cases-settings.asciidoc[leveloffset=+2]

include::ci-cd-observability.asciidoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
[[manage-cases-settings]]
= Configure case settings

To change case closure options and add custom fields, templates, and connectors for external incident management systems, go to *Cases* -> *Settings*.

[role="screenshot"]
image::images/cases-settings.png[View case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

[discrete]
[[close-connector-observability]]
== Case closures

If you close cases in your external incident management system, the cases will remain open in Elastic Observability until you close them manually.

To close cases when they are sent to an external system, select *Automatically close cases when pushing new incident to external system*.

[discrete]
[[cases-external-connectors]]
= Configure external connectors
== External incident management systems

If you are using an external incident management system, you can integrate Elastic Observability
cases with that system using _connectors_. These third-party systems are supported:
Expand All @@ -18,19 +36,12 @@ You need to create a connector to send cases, which stores the information requi
with an external system.

After creating a connector, you can set your cases to
automatically close when they are sent to an external system.
<<close-connector-observability,automatically close>> when they are sent to an external system.

[discrete]
[[new-connector-observability]]
== Create a connector
=== Create a connector

. Go to *Cases* -> *Settings*.
+
--
[role="screenshot"]
image::images/cases-settings.png[View case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
--
. From the *Incident management system* list, select *Add new connector*.
. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*,
or *{webhook-cm}*.
Expand All @@ -47,15 +58,14 @@ or *{webhook-cm}*.

[discrete]
[[Edit-connector-observability]]
== Edit a connector
=== Edit a connector

You can create additional connectors, update existing connectors, and change the connector used to send cases to external systems.

TIP: You can also configure which connector is used for each case individually. See <<new-case-observability,Open a new case>>.

To change the default connector used to send cases to external systems:

. Go to *Cases* -> *Settings*.
. Select the required connector from the *Incident management system* list.

To update an existing connector:
Expand All @@ -64,14 +74,21 @@ To update an existing connector:
. Update the connector fields as required.

[discrete]
[[close-connector-observability]]
== Sending and closing cases
[[observability-case-templates]]
== Templates

preview::[]

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 <<case-custom-fields,custom fields>>.

To create a template:

. In the *Templates* section, click *Add template*.

To send a case to an external system, click the **Push as <connector name> incident** button from the individual case page.
This information is not sent automatically. If you make further changes to the shared case fields, you should push the case again.
. 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.

If you close cases in your external incident management system, the cases will remain open in Elastic Observability until you close them
manually.
When users create cases, they can optionally select a template and use its field values or override them.

To close cases when they are sent to an external system, select
*Automatically close cases when pushing new incident to external system* when adding a connector to a case.
NOTE: If you update or delete templates, existing cases are unaffected.
10 changes: 10 additions & 0 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,16 @@ Uploaded files are also accessible in *{stack-manage-app} > Files*.
When you export cases as {kibana-ref}/managing-saved-objects.html[saved objects], the case files are not exported.
============================================================================

[discrete]
[[push-observability-case]]
== Send cases to external incident management systems

To send a case to an external system, click the button in the *External incident management system* section of the individual case page.
This information is not sent automatically.
If you make further changes to the shared case fields, you should push the case again.

For more information about configuring connections to external incident management systems, refer to <<manage-cases-settings>>.

[discrete]
[[manage-case-observability]]
== Manage existing cases
Expand Down
Loading