Skip to content

Commit

Permalink
[DOCS] Additional fields in ServiceNow ITSM and SecOps connectors (#1…
Browse files Browse the repository at this point in the history
…95122)

(cherry picked from commit 3b70d99)
  • Loading branch information
lcawl committed Oct 7, 2024
1 parent 4ea7003 commit 353c348
Showing 8 changed files with 38 additions and 3 deletions.
18 changes: 17 additions & 1 deletion docs/management/connectors/action-types/servicenow-sir.asciidoc
Original file line number Diff line number Diff line change
@@ -64,12 +64,28 @@ The username for HTTP basic authentication.
You can test connectors as you're creating or editing the connector in {kib}. For example:

[role="screenshot"]
image::management/connectors/images/servicenow-sir-params-test.png[{sn-sir} params test]
image::management/connectors/images/servicenow-sir-params-test.png[{sn-sir} params test, width=75%]

{sn-sir} actions have the following configuration properties.

Additional comments::
Additional information for the client, such as how to troubleshoot the issue.
Additional fields::
An object that contains custom field identifiers and their values.
These fields must exist in the Elastic ServiceNow application and must be specified in JSON format.
+
--
For example:
[source,sh]
----
{
"u_cmdb_ci": "host-a",
"u_company": "My company",
"u_assignment_group": "Testing"
}
----
Note that the default source field names in the Elastic ServiceNow application are prefixed with "u_".
--
Category::
The category of the incident.
Correlation display::
23 changes: 21 additions & 2 deletions docs/management/connectors/action-types/servicenow.asciidoc
Original file line number Diff line number Diff line change
@@ -64,12 +64,28 @@ The username for HTTP basic authentication.
When you create or edit a connector, use the *Test* tab to test its actions:

[role="screenshot"]
image::management/connectors/images/servicenow-params-test.png[ServiceNow params test]
image::management/connectors/images/servicenow-params-test.png[ServiceNow params test, width=75%]

{sn-itsm} actions have the following configuration properties.

Additional comments::
Additional information for the client, such as how to troubleshoot the issue.
Additional fields::
An object that contains custom field identifiers and their values.
+
--
These fields must exist in the Elastic ServiceNow application and must be specified in JSON format.
For example:
[source,sh]
----
{
"u_cmdb_ci": "host-a",
"u_company": "My company",
"u_assignment_group": "Testing"
}
----
Note that the default source field names in the Elastic ServiceNow application are prefixed with "u_".
--
Category::
The category of the incident.
Correlation display::
@@ -86,6 +102,9 @@ NOTE: Using the default configuration of `{{ruleID}}:{{alert ID}}` ensures that

Description::
The details about the incident.
Event action::
The type of action to test: resolve or trigger.
When you test a resolve action, you must provide a correlation identifier.
Impact::
The effect an incident has on business.
It can be measured by the number of affected users or by how critical it is to the business in question.
@@ -94,7 +113,7 @@ The severity of the incident.
Short description::
A short description for the incident, used for searching the contents of the knowledge base.
Subcategory::
The category of the incident.
The subcategory of the incident.
Urgency::
The extent to which the incident resolution can delay.

Binary file modified docs/management/connectors/images/servicenow-connector-basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/management/connectors/images/servicenow-params-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 353c348

Please sign in to comment.