Skip to content

Commit

Permalink
[DOCS] Add Cases connector details
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Mar 9, 2022
1 parent 79905ba commit 2576a2f
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 3 deletions.
104 changes: 104 additions & 0 deletions docs/management/cases/add-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
[[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*. Alternatively, select a case then click
*Add connector*.
+
[role="screenshot"]
image::images/add-case-connector.png[]

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

. Select an external incident management system.

. Enter your required settings. Refer to
<<jira-connector-configuration,Jira>> connector configuration details.
////
+
|===
| *Connector name* | Name for the connector.
| *URL* | The URL of the external system.
| *ServiceNow instance URL* | (ServiceNow only) The URL of the ServiceNow instance.
| *API URL* | ({swimlane} only) The URL of the {swimlane} instance.
| *Organization ID* | (IBM Resilient only) Your organization's IBM Resilient ID number.
| *Application ID* | ({swimlane} only) The application ID of your {swimlane} application. From {swimlane}, you can find the application
ID by checking your application's settings or at the end of your application's URL after you've opened it.
| *Username* | (ServiceNow only) The username of the ServiceNow account that is used to access the ServiceNow instance.
| *Password* | (ServiceNow only) The password of the ServiceNow account that is used to access the ServiceNow instance.
| *Project key* | (Jira only) The key of the Jira project.
| *Email or Username* | (Jira only) The Jira account username or email.
| *API token or Password* | (Jira only) The API token or password that is used to authenticate Jira updates.
| *API key ID* | (IBM Resilient only) The API key that is used to authenticate IBM Resilient updates.
| *API key secret* | (IBM Resilient only) The API key secret that is used to authenticate IBM Resilient updates.
| *API token* | ({swimlane} only) The {swimlane} API authentication token that is used for HTTP Basic authentication.
This is the personal access token for your user role.
|===
////
. Choose the connector type ({swimlane} only):
+
|===

| *All* | You can choose to set all or no field mappings when creating your new {swimlane} connector. However, note that if
you don't set field mappings now, you'll be prompted to do so when you want to use the connector for a case or a rule. The prompts no longer display after you set up the required mappings.

| *Alerts* | Provide an alert ID and rule name.

| *Cases* | Provide a case ID, a case name, comments, and a description.

|===

. 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]

0 comments on commit 2576a2f

Please sign in to comment.