Skip to content

Commit

Permalink
[DOCS] Add Cases connector details (#127232)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Mar 10, 2022
1 parent 62c2082 commit 61a84ed
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 6 deletions.
56 changes: 56 additions & 0 deletions docs/management/cases/add-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
[[add-case-connectors]]
== Add connectors

preview::[]

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

* IBM Resilient
* Jira
* ServiceNow ITSM
* ServiceNow SecOps
* {swimlane}

NOTE: To create connectors and send cases to external systems, you must have the
appropriate {kib} feature privileges. Refer to <<setup-cases>>.

[discrete]
[[create-case-connectors]]
== Create connectors

You can create connectors in *Management > {stack-manage-app} > {rules-ui}*, as
described in <<action-types>>. Alternatively, you can create them in
*Management > {stack-manage-app} > Cases*:

. Click *Edit external connection*.
+
[role="screenshot"]
image::images/cases-connectors.png[]

. From the *Incident management system* list, select *Add new connector*.

. Select an external incident management system.

. Enter your required settings. Refer to <<resilient-action-type>>,
<<jira-action-type>>, <<servicenow-action-type>>, <<servicenow-sir-action-type>>,
or <<swimlane-action-type>> for connector configuration details.

. Click *Save*.

[discrete]
[[edit-case-connector-settings]]
== Edit connector settings

You can create additional connectors, update existing connectors, change
the default connector, and change case closure options.

. Go to *Management > {stack-manage-app} > Cases*, click *Edit external connection*.

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

. To change the default connector for new cases, select the connector from the
*Incident management system* list.

. To update a connector, click *Update <connector name>* and edit the connector fields as required.
6 changes: 4 additions & 2 deletions docs/management/cases/cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ preview::[]

Cases are used to open and track issues directly in {kib}. All cases list
the original reporter and all the users who contribute to a case (_participants_).
You can also send cases to third party systems by configuring external connectors.
You can also send cases to external incident management systems by configuring
connectors.

[role="screenshot"]
image::images/cases.png[Cases page]
Expand All @@ -17,4 +18,5 @@ You also cannot attach alerts from the {observability} or {security-app} to
cases in *{stack-manage-app}*.

* <<setup-cases>>
* <<manage-cases>>
* <<manage-cases>>
* <<add-case-connectors>>
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/management/cases/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include::cases.asciidoc[]
include::setup-cases.asciidoc[leveloffset=+1]
include::manage-cases.asciidoc[leveloffset=+1]
//=== Configure external connectors
include::add-connectors.asciidoc[leveloffset=+1]
5 changes: 2 additions & 3 deletions docs/management/cases/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ TIP: In the `Description` area, you can use
https://www.markdownguide.org/cheat-sheet[Markdown] syntax to create formatted
text.

. For *External incident management system*, select a connector. If you've
previously added one, that connector displays as the default selection.
Otherwise, the default setting is `No connector selected`.
. For *External incident management system*, select a connector. For more
information, refer to <<add-case-connectors>>.

. After you've completed all of the required fields, click *Create case*.

Expand Down

0 comments on commit 61a84ed

Please sign in to comment.