From eecd6db644679f688cf49c38d904e77720a6bcb4 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 Aug 2022 12:48:42 -0700 Subject: [PATCH 1/4] [DOCS] Add Webhook Case Managaement connector to Cases --- .../create-observability-connectors.asciidoc | 55 +++---------------- 1 file changed, 7 insertions(+), 48 deletions(-) diff --git a/docs/en/observability/create-observability-connectors.asciidoc b/docs/en/observability/create-observability-connectors.asciidoc index 5834d81ab9..a2a6f1a796 100644 --- a/docs/en/observability/create-observability-connectors.asciidoc +++ b/docs/en/observability/create-observability-connectors.asciidoc @@ -8,6 +8,7 @@ You can send cases to these third-party systems: * {jira} (including {jira} Service Desk) * {ibm-r} * {swimlane} +* {webhook-cm} IMPORTANT: To send cases to external systems, you need the appropriate license, and your role must have the *Cases* {kib} privilege as a user. For more details, refer to <>. @@ -27,56 +28,14 @@ automatically close when they are sent to an external system. [role="screenshot"] image::images/add-case-connector.png[] . From the *Incident management system* list, select *Add new connector*. -. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, or *{swimlane}*. +. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*, +or {webhook-cm} -. Enter your required settings. -+ -|=== - -| *Connector name* | Name for the connector. - -| *URL* | The URL of the external system to which you want to send cases. - -| *API URL* | ({swimlane} only) The URL of the {swimlane} instance to which you want to send cases. - -| *Organization ID* | ({ibm-r} only) Your organization’s {ibm-r} 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* | ({sn} only) The username of the {sn} account is used to access the {sn} instance. - -| *Password* | ({sn} only) The password of the {sn} account is used to access the {sn} instance. - -| *Project key* | ({jira} only) The key of the {jira} project to which you are sending cases. - -| *Email or Username* | ({jira} only) The {jira} account username or email. - -| *API token or Password* | ({jira} only) The API token or password is used to authenticate {jira} updates. +. Enter your required settings. Refer to <>, +<>, <>, <>, +or <> for connector configuration details. +// or <> -| *API key ID* | ({ibm-r} only) The API key is used to authenticate {ibm-r} updates. - -| *API key secret* | ({ibm-r} only) The API key secret is used to authenticate {ibm-r} updates. - -| *API token* | ({swimlane} only) The {swimlane} API authentication token 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 if you want to use the connector for a case or a rule. This -is because the prompts no longer display once 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] From 1a51e3b707e5dfe824700eb287eeb19d52e26c9a Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 Aug 2022 13:09:38 -0700 Subject: [PATCH 2/4] [DOCS] Fix links --- .../create-observability-connectors.asciidoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/en/observability/create-observability-connectors.asciidoc b/docs/en/observability/create-observability-connectors.asciidoc index a2a6f1a796..960b04c9e5 100644 --- a/docs/en/observability/create-observability-connectors.asciidoc +++ b/docs/en/observability/create-observability-connectors.asciidoc @@ -31,10 +31,13 @@ image::images/add-case-connector.png[] . Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*, or {webhook-cm} -. Enter your required settings. Refer to <>, -<>, <>, <>, -or <> for connector configuration details. -// or <> +. Enter your required settings. For connector configuration details, refer to +{kibana-ref}/resilient-action-type.html[{ibm-r} connector], +{kibana-ref}/jira-action-type.html[{jira} connector], +{kibana-ref}/servicenow-action-type.html[{sn-itsm} connector], +{kibana-ref}/servicenow-sir-action-type.html[{sn-sir} connector], +or {kibana-ref}/swimlane-action-type.html[{swimlane} connector]. +// or {kibana-ref}/cases-webhook-action-type.html[{webhook-cm} connector]. . Click *Save*. From c962a0fa26c99fdcf14af26131aa4d89931fca42 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 Aug 2022 13:44:06 -0700 Subject: [PATCH 3/4] [DOCS] Fixes highlighting --- docs/en/observability/create-observability-connectors.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/create-observability-connectors.asciidoc b/docs/en/observability/create-observability-connectors.asciidoc index 960b04c9e5..a457a2b41a 100644 --- a/docs/en/observability/create-observability-connectors.asciidoc +++ b/docs/en/observability/create-observability-connectors.asciidoc @@ -29,7 +29,7 @@ automatically close when they are sent to an external system. image::images/add-case-connector.png[] . 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} +or *{webhook-cm}*. . Enter your required settings. For connector configuration details, refer to {kibana-ref}/resilient-action-type.html[{ibm-r} connector], From d8f3f5a9848790cae643c193d62c8bc6b0bb97d8 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 12 Aug 2022 12:25:59 -0700 Subject: [PATCH 4/4] [DOCS] Add link to connector details --- .../en/observability/create-observability-connectors.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/create-observability-connectors.asciidoc b/docs/en/observability/create-observability-connectors.asciidoc index a457a2b41a..387f3bd377 100644 --- a/docs/en/observability/create-observability-connectors.asciidoc +++ b/docs/en/observability/create-observability-connectors.asciidoc @@ -36,8 +36,8 @@ or *{webhook-cm}*. {kibana-ref}/jira-action-type.html[{jira} connector], {kibana-ref}/servicenow-action-type.html[{sn-itsm} connector], {kibana-ref}/servicenow-sir-action-type.html[{sn-sir} connector], -or {kibana-ref}/swimlane-action-type.html[{swimlane} connector]. -// or {kibana-ref}/cases-webhook-action-type.html[{webhook-cm} connector]. +{kibana-ref}/swimlane-action-type.html[{swimlane} connector], or +{kibana-ref}/cases-webhook-action-type.html[{webhook-cm} connector]. . Click *Save*.