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

Removed filtering for Case owned ServiceNow actions from the Management UI and make it usable for Alerts. Added documentation. #71579

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c780a39
Removed filtering for Case owned ServiceNow actions from the Manageme…
YulNaumenko Jul 14, 2020
1dd0965
extended docs
YulNaumenko Jul 14, 2020
18ddca7
Fixed docs
YulNaumenko Jul 14, 2020
d8334fc
Merge remote-tracking branch 'upstream/master' into actions-serviceno…
YulNaumenko Jul 14, 2020
a750f77
fixed connector page
YulNaumenko Jul 14, 2020
1d890f3
Changed SN variables components
YulNaumenko Jul 14, 2020
aa3af15
Fixed issues
YulNaumenko Jul 14, 2020
31bb00e
fixed order
YulNaumenko Jul 14, 2020
38b8308
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
ae505ea
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
44a36ac
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
590cb52
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
feea435
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
732553e
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
7174a7d
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
41881d3
Update docs/user/alerting/action-types/servicenow.asciidoc
YulNaumenko Jul 14, 2020
6632c1c
-
YulNaumenko Jul 14, 2020
4248bab
Merge branch 'actions-servicenow-case-connector-usage-fix' of github.…
YulNaumenko Jul 14, 2020
87f124f
fixed tests
YulNaumenko Jul 14, 2020
98683ca
Merge remote-tracking branch 'upstream/master' into actions-serviceno…
YulNaumenko Jul 14, 2020
d45cc15
Merge remote-tracking branch 'upstream/master' into actions-serviceno…
YulNaumenko Jul 15, 2020
c5ae2b9
Merge remote-tracking branch 'upstream/master' into actions-serviceno…
YulNaumenko Jul 15, 2020
04fa858
Merge master
YulNaumenko Jul 15, 2020
d94353b
Merge remote-tracking branch 'upstream/master' into actions-serviceno…
YulNaumenko Jul 15, 2020
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
5 changes: 5 additions & 0 deletions docs/user/alerting/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ a| <<slack-action-type, Slack>>

| Send a message to a Slack channel or user.

a| <<servicenow-action-type, ServiceNow>>
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

| Create new ServiceNow incident.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

a| <<webhook-action-type, Webhook>>

| Send a request to a web service.
Expand Down Expand Up @@ -55,3 +59,4 @@ include::action-types/server-log.asciidoc[]
include::action-types/slack.asciidoc[]
include::action-types/webhook.asciidoc[]
include::action-types/pre-configured-connectors.asciidoc[]
include::action-types/servicenow.asciidoc[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this so it is in between serverlog and slack.

72 changes: 72 additions & 0 deletions docs/user/alerting/action-types/servicenow.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
[role="xpack"]
[[servicenow-action-type]]
=== ServiceNow action

ServiceNow action type using [V2 Table API](https://developer.servicenow.com/app.do#!/rest_api_doc?v=orlando&id=c_TableAPI) to create ServiceNow incidents.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[servicenow-connector-configuration]]
==== Connector configuration

ServiceNow connectors have the following configuration properties:

Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
URL:: The from address for all emails sent with this connector, specified in `user@host-name` format.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
Username:: username for 'login' type authentication.
Password:: password for 'login' type authentication.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[Preconfigured-servicenow-configuration]]
==== Preconfigured action type

[source,text]
--
my-servicenow:
name: preconfigured-servicenow-action-type
actionTypeId: .servicenow
config:
apiUrl: https://dev94428.service-now.com/
secrets:
user: testuser
password: passwordkeystorevalue
--

`config` defines the action type specific to the configuration and contains the following properties:

[cols="2*<"]
|===

| `apiUrl`
| An address that corresponds to *Sender*.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

|===

`secrets` defines sensitive information for the action type:

[cols="2*<"]
|===

| `user`
| A string that corresponds to *User*.

| `password`
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.

|===

[[servicenow-action-configuration]]
==== Action configuration

ServiceNow actions have the following configuration properties:

Urgency:: Each is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name <user@host-name>` format. One of To, CC, or BCC must contain an entry.
Severity:: The subject line of the email.
Impact:: The message text of the email. Markdown format is supported.
Short description:: The message text of the email. Markdown format is supported.
Description:: The message text of the email. Markdown format is supported.
Additional comments:: The message text of the email. Markdown format is supported.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[[configuring-servicenow]]
==== Configuring ServiceNow

The email action can send email using many popular SMTP email services.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const pushToServiceHandler = async ({

let incident = {};
// TODO: should be removed later but currently keep it for the Case implementation support
if (mapping) {
if (mapping && !params.externalObject) {
const fields = prepareFieldsForTransformation({
externalCase: params.externalObject,
mapping,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,7 @@ export const ActionForm = ({
try {
setIsLoadingConnectors(true);
const loadedConnectors = await loadConnectors({ http });
setConnectors(
loadedConnectors.filter(
(action) =>
action.actionTypeId !== ServiceNowConnectorConfiguration.id ||
(action.actionTypeId === ServiceNowConnectorConfiguration.id &&
!action.config.isCaseOwned)
)
);
setConnectors(loadedConnectors);
} catch (e) {
toastNotifications.addDanger({
title: i18n.translate(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,7 @@ export const ActionsConnectorsList: React.FunctionComponent = () => {
setIsLoadingActions(true);
try {
const actionsResponse = await loadAllActions({ http });
setActions(
actionsResponse.filter(
(action) =>
action.actionTypeId !== ServiceNowConnectorConfiguration.id ||
(action.actionTypeId === ServiceNowConnectorConfiguration.id &&
!action.config.isCaseOwned)
)
);
setActions(actionsResponse);
} catch (e) {
toastNotifications.addDanger({
title: i18n.translate(
Expand Down