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

Add Custom Fields to ServiceNow ITSM connector #183609

Closed
adcoelho opened this issue May 16, 2024 · 1 comment · Fixed by #184023
Closed

Add Custom Fields to ServiceNow ITSM connector #183609

adcoelho opened this issue May 16, 2024 · 1 comment · Fixed by #184023
Assignees
Labels
Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@adcoelho
Copy link
Contributor

adcoelho commented May 16, 2024

As a follow-up to #171320 (and similar to #176919) we want the ServiceNow ITSM connector to support an Additional fields field that allows the user to define additional values in the action in JSON format. Users, to use the ServiceNow ITSM connector, need to install the Elastic for ITSM ServiceNow application in their ServiceNow instance. The application creates an import set table and a corresponding transformation map. Kibana will import the incident to the import set table and the transformation map will transform the data before adding them to the Incident table. By convention, all fields we add are prefixed by u_. So if a user needs to set the cmdb_ci by using the Additional fields field she should set it as { "u_cmdb_ci": "my-host-name" }. Also, users can extend the import set table and the transformation map and add their custom fields. We need to educate users about this behavior by documenting it.

DoD

  • Users should be able to set any field in JSON format.
  • Do not support additional fields for legacy ITSM connectors.
  • Tooltip and/or documentation that explains to users about the prefixing fields with u_

Example

Screenshot 2024-05-21 at 3 53 31 PM
@adcoelho adcoelho added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework labels May 16, 2024
@adcoelho adcoelho self-assigned this May 16, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@cnasikas cnasikas assigned cnasikas and unassigned adcoelho May 22, 2024
cnasikas added a commit that referenced this issue Jun 13, 2024
…eNow ITSM and SecOps (#184023)

## Summary

This PR adds support for additional fields for the ServiceNow ITSM and
SecOps connector. The additional fields will not be available to the
recovered action.

<img width="607" alt="Screenshot 2024-05-27 at 6 29 26 PM"
src="https://github.com/elastic/kibana/assets/7871006/7d397d7b-2b0b-4399-8d3a-0725ad04a10d">

## Testing

Verify that:

1. Existing rules with ITSM and SecOps configured continue working as
expected.
2. Can create rules with an ITSM action and set some additional fields
supported by ITSM. You can find the available in the Elastic
transformation map inside ServiceNow.
3. The "additional fields" verification in the UI is working as
expected.
4. The "additional fields" are not shown when you set a recovered
action.

Fixes: #183609

### Checklist

Delete any items that are not applicable to this PR.

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

## Release notes

Pass any field to ServiceNow using the ServiceNow ITSM and SecOps
connectors with a JSON field called "additional fields".

---------

Co-authored-by: kibanamachine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
3 participants