Connecting ServiceNow

ServiceNow is a cloud-based IT Service Management (ITSM) platform focusing on workflow automation and internal organizational support. The ServiceNow connector provided with Workplace Search automatically captures, syncs and indexes the following items:

Configuring the ServiceNow connector is the first step prior to connecting the ServiceNow service to Workplace Search, and requires that you create an OAuth App from the ServiceNow platform. To get started, first log in to ServiceNow and access your administrative dashboard:

Step 1. Use the search bar on the left-hand side to search for Application Registry:

Figure 80. Connecting ServiceNow

Step 2. We will need a new application. Click the New button:

Figure 81. Connecting ServiceNow

Step 3. A trio of text links appears. Select Create an OAuth API endpoint for external clients:

Figure 82. Connecting ServiceNow

Step 4. Next, provide a name for the application. Then add the appropriate redirect URL.

The redirect URL required varies by which user interface you are using to manage Enterprise Search. Enterprise Search in Kibana and standalone Enterprise Search use different redirect URLs. See user interfaces for details on each UI.

When using standalone Enterprise Search, add the following redirect URL, substituting <WS_BASE_URL> with the base URL at which Workplace Search is hosted (scheme + host, no path).

<WS_BASE_URL>/ws/org/sources/service_now/create

Examples:

# Deployment using a custom domain name
https://www.example.com/ws/org/sources/service_now/create

# Deployment using a default Elastic Cloud domain name
https://c3397e558e404195a982cb68e84fbb42.ent-search.us-east-1.aws.found.io:443/ws/org/sources/service_now/create

# Unsecured local development environment
http://localhost:3002/ws/org/sources/service_now/create

When using Enterprise Search in Kibana, use the following redirect URL, substituting <KIBANA_BASE_URL> with the base URL of your Kibana instance. This should correspond with the value of kibana.external_url in your enterprise-search.yml:

<KIBANA_BASE_URL>/app/enterprise_search/workplace_search/sources/added

Examples:

# Deployment using a custom domain name for Kibana
https://www.example.com/app/enterprise_search/workplace_search/sources/added

# Deployment using a default Elastic Cloud domain name for Kibana
https://c3397e558e404195a982cb68e84fbb42.kb.us-east-1.aws.found.io:443/app/enterprise_search/workplace_search/sources/added

# Unsecured local Kibana environment
http://localhost:5601/app/enterprise_search/workplace_search/sources/added

Step 5. Once the information has been properly entered, click Submit:

Figure 83. Connecting ServiceNow

The app is created, and we may now retrieve the Client ID and Client Secret. Find your app within the list and access it:

Figure 84. Connecting ServiceNow

Step 6. From the Workplace Search administrative dashboard’s Sources area, locate ServiceNow and provide both the Client ID and Client Secret. Voilà! The ServiceNow connector is now configured, and ready to be used to synchronize content. In order to capture data, you must now connect a ServiceNow instance with the adequate authentication credentials.

Once the ServiceNow connector has been configured, you may connect a ServiceNow instance to your organization.

Step 1. Head to your organization’s Workplace Search administrative dashboard, and locate the Sources tab.

Step 2. Click Add a new source.

Step 3. Select ServiceNow in the Configured Sources list, and follow the ServiceNow authentication flow as presented.

Step 4. Upon the successful authentication flow, you will be redirected to Workplace Search, and your organization’s ServiceNow content will now be captured and will be ready for search gradually as it is synced. Once successfully configured and connected, the ServiceNow synchronization automatically occurs every 2 hours.