Integrating with ServiceNow
ServiceNow helps you monitor, debug, and improve your entire stack.
Configure an integration with ServiceNow to view topology data from ServiceNow in the following products and derive actionable insights:
- BMC Helix Discovery
- BMC Helix AIOps
We recommend that you collect only the topology data from ServiceNow in your production environment.
As a tenant administrator, perform the following steps to integrate with ServiceNow, verify the integration, and view the collected topology data in various BMC products.
Before you begin
- Have the egress IP of your tenant. Request the egress IP from BMC Software if you don't already have it.
- Ensure that you have a firewall rule to allow traffic from the egress IP to the ServiceNow host on the listening port (default is 443).
- Ensure that you have read permission for the following REST API endpoints in ServiceNow:
- /api/now/table/[type], where
typeis determined by querying
For information about permissions and API endpoints, see the ServiceNow documentation.
To integrate with ServiceNow
In BMC Helix Intelligent Integrations, on the CONNECTORS tab, click in the SOURCES panel.
- Click ServiceNow.
- Specify the following source connection details:
Specify a unique instance name.
We recommend that you specify the instance name in the following format:
The instance qualifier helps you to distinguish the multiple instances configured from the same source server. For example, you can name your instances as, SN_Host_PROD, SN_Host_TEST, and so on.
- Specify the ServiceNow host name and port number (default value is 443).
- Specify the user name and password. Ensure that the specified user can access the ServiceNow REST API.
- Ensure that the HTTPS check box is selected to indicate that you plan to use an https connection to the ServiceNow host.
- Click VALIDATE AND CREATE.
The specified connection details are validated and the corresponding source connection is created in the Source Connection list.
Select the source connection that you created from the list if it is not selected already.
The destination host connection is created and configured automatically when you create a connection for a source.
- Clear the options for which you don't want to collect data.
Click the topology data type and specify the configuration parameters in the Collectors section as described in the following table:
Parameter Name Data Type
Specify the data collection frequency (in minutes).
For example, if you set this parameter to 5 mins, the collector runs every 5 mins.
For more information about this parameter, see Data collection schedule.
BMC recommendation: 60 minutes
Data Collection Window
Specify the historical time period (in minutes) from the current time for which the data should be collected from ServiceNow.
For example, if you set Collection Schedule parameter to 5 mins (considering 00:32 as the current time) and the Data Collection Window parameter to 5 mins, data is extracted from 00:27 to 00:32.
For more information about this parameter, see Data collection window.
BMC recommendation: 60 minutes
Specify the time (in minutes) by which the data time window should be shifted far back on the timeline.
This parameter is useful in slow, late data availability situations.
For example, if you set the Collection Schedule parameter to 5 mins, the Data Collection Window parameter to 5 mins, and the Data Latency parameter to 2 mins, data is extracted from 00:23 to 00:28, when run from just after 00:30.
For more information about this parameter, see Data latency.
Configuration Item Type
Add configuration item types and the instances.
- Click CREATE COLLECTORS to create the required collector streams for the topology data type.
- Click the topology data type and specify the configuration parameters in the Distributors section as described in the following table:
Parameter Name Default
Max Batching Size
Specify the maximum number of data items to send in a single POST request to the destination API. The batch size depends on the destination’s ability to buffer the incoming data.
Max Batching Delay
Specify the maximum time (in seconds) to wait before building a batch and processing.
Base Retry Delay
Specify the initial time (in seconds) for which to wait before retrying to build a batch and processing. The waiting time increases in the following sequence: n1, n2, n3, and so on, where n indicates the number of seconds.
For example, if you set the value to 2 seconds, retry is performed after 2, 4, 8, 16, ... seconds.
Max Intra-Retry Delay
Specify the maximum limit for the base retry delay. For example, if you set the value of this parameter to 60 seconds and the value of the Base Retry Delay parameter to 2 seconds, retries would be performed 2, 4, 8, 16, 32, 64, 64,...seconds later again.
Max Retry Duration
Specify the total time for retrying a delivery. For REST destinations, a delivery is a batch of data items in one POST request.
For example, if you set the value of this parameter to 8 hours, and the value of the Base Retry Delay parameter to 2 seconds, requests are sent for 2+4+8+16+32+64+132... until 8 hours in total duration is reached. After that, no subsequent attempts are made to retry the delivery.
The assumption here is that if there is an outage or other issue with the destination tool, recovery should take less than the value of the Max Retry Duration parameter to complete.
- Click CREATE DISTRIBUTORS to create the required distributor streams for the topology data type.
- Click one of the following buttons:
- SAVE STREAM: Click this button if you want to edit the integration details before creating the instance. After you save the stream, the instance that you created is listed in the SOURCES panel. Move the slider to the right to start the topology data stream.
- SAVE AND START STREAM: Click this button if you want to save the integration details and start receiving topology data immediately.
For more information about data streams, see Starting or stopping data streams.
To verify the integration
In BMC Helix Intelligent Integrations, on the SOURCES panel, confirm that the topology data stream for the integration you created is running. Data streaming is indicated by moving colored arrows.
A moving light blue arrow () indicates that topology data is being streamed.
To view the topology data in BMC Helix Discovery
In BMC Helix Discovery, select Explore > Data, and click <count> Import Records in the Miscellaneous section. The Import Record List page shows the CI records received from ServiceNow. For information about records, see .
To view services in BMC Helix AIOps
Before you view services in BMC Helix AIOps, create a Business Service model in BMC Helix Discovery. For information about creating models, see .
In BMC Helix AIOps, on the Overview page to view the services for topology data received from ServiceNow.