IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic S3 connector reference Elastic SharePoint Online connector reference »
Elastic Docs › ›Elastic connectors

Elastic ServiceNow connector reference

edit

Elastic ServiceNow connector reference

edit

The Elastic ServiceNow connector is a connector for ServiceNow.

Availability and prerequisites

edit

The ServiceNow connector was introduced in Elastic version 8.9.0. This connector is available as a connector client from the Python connectors framework. To use this connector as a connector client, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usage

edit

To use this connector as a connector client, use the Customized connector workflow.

Compatibility

edit

The ServiceNow connector is compatible with the following versions of ServiceNow:

  • ServiceNow "Tokyo"
  • ServiceNow "San Diego"
  • ServiceNow "Rome"

Configuration

edit

When using the connector client workflow, initially these fields will use the default configuration set in the connector source code. These are set in the get_default_configuration function definition.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

url
The host url of the ServiceNow instance.
username
The username of the account for ServiceNow.
password
The password of the account used for ServiceNow.
services

Comma-separated list of services to fetch data from ServiceNow. If the value is *, the connector will fetch data from the list of basic services provided by ServiceNow:

retry_count
The number of retry attempts after a failed request to ServiceNow. Default value is 3.
concurrent_downloads
The number of concurrent downloads for fetching the attachment content. This speeds up the content extraction of attachments. Defaults to 10.

Documents and syncs

edit

All services and records the user has access to will be indexed according to the configurations provided. The connector syncs the following ServiceNow object types:

  • Records
  • Attachments
  • Content of files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Deployment using Docker

edit

You can deploy the ServiceNow connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-python-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.password
  • connector_id
  • service_type

Use servicenow as the service_type value. Don’t forget to uncomment "servicenow" in the sources section of the yaml file.

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

elasticsearch:
  host: http://host.docker.internal:9200
  username: elastic
  password: <YOUR_PASSWORD>

connector_id: <CONNECTOR_ID_FROM_KIBANA>
service_type: servicenow

sources:
  # UNCOMMENT "servicenow" below to enable the ServiceNow connector

  #mongodb: connectors.sources.mongo:MongoDataSource
  #s3: connectors.sources.s3:S3DataSource
  #dir: connectors.sources.directory:DirectoryDataSource
  #mysql: connectors.sources.mysql:MySqlDataSource
  #network_drive: connectors.sources.network_drive:NASDataSource
  #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource
  #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource
  #postgresql: connectors.sources.postgresql:PostgreSQLDataSource
  #oracle: connectors.sources.oracle:OracleDataSource
  #mssql: connectors.sources.mssql:MSSQLDataSource

Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you. Normally you’ll only need to update elasticsearch.host, elasticsearch.password, connector_id and service_type to run the connector service.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-python-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.9.2.0-SNAPSHOT \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to this guide in the Python framework repository for more details.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not currently available for this connector. Filtering is controlled via ingest pipelines.

Connector Client operations

edit

End-to-end Testing

edit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the ServiceNow connector, run the following command:

$ make ftest NAME=servicenow

Generate performance reports using the following flag: PERF8=yes. Toggle test data set size between SMALL, MEDIUM and LARGE with the argument DATA_SIZE=. By default, it is set to MEDIUM.

Users do not need to have a running Elasticsearch instance or a ServiceNow source to run this test. Docker Compose manages the complete setup of the development environment.

Known issues

edit

There are no known issues for this connector. Refer to Known issues for a list of known issues that impact all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Content extraction

edit

See Content extraction.

Framework and source

edit

This connector is included in the Python connectors framework.

View the source code for this connector (branch 8.9, compatible with Elastic 8.9).

« Elastic S3 connector reference Elastic SharePoint Online connector reference »