What is ServiceNow? #
ServiceNow is a software company that provides a cloud-based, AI-driven platform for automating multiple management workflows in enterprises. ServiceNow provides IT service management, IT operations management (ITOM), and IT business management (ITBM).
Why Should You Use the ServiceNow Connector? #
The ServiceNow connector provides visibility into the assets in your environment. You can use this visibility to:
-
ensure assets are managed per your security policies
-
derive relationships between assets, users, applications, and data
How Does This Connector Work? #
Lucidum executes read-only requests to the ServiceNow REST API and ingests only meta-data about ServiceNow devices. Lucidum does not retrieve any data stored on your assets.
Configuring the Connector in Lucidum #
| Field | Description | Example |
|---|---|---|
| URL | The URL for the ServiceNow server. </p | https://lucidum1.service-now.com |
| Data Lookback in Days | Number of previous days to ingest data for.Default value is 2.Set this field to -1 to disable the filter. | 3 |
| Other Tables | ServiceNow CMDB tables to fetch data from. | IP switch table, router table, application table or database table |
| Core Tables | Core ServiceNow CMDB tables to fetch data from. | computer table, server table, or hardware table |
| Username | If not using OAuth authentication, provide a user name for a ServiceNow account with the roles:
| tonystark |
| Password | If not using OAuth authentication, provide a password for a ServiceNow account with the roles:
| IAmIronMan2008 |
| Client ID | If using OAuth authentication, provide a Client ID for the Meridian application. | 90e9fcc0ceca811037b08f0f2b9cdc37 |
| Client Secret | If using OAuth authentication, provide a Client Secret for the Meridian application. | s@vRtwh*OA |
| Refresh Token | If using OAuth authentication, provide a refresh token for the Meridian application. | |
| User Table Filter | Filter to apply to the ServiceNow users table (sys_user_table) to retrieve only users who match the filter. Use ServiceNow to create the encoded query. For details, see the section below on Encoded Queries/Filters in ServiceNow. For example, to retrieve only users with a valid value in the department column, you could enter: &sysparm_query=department!=” | &sysparm_query=department!=” |
| Asset Table Filter – Tables | List of one or more ServiceNow CMDB CI table names to apply custom filters to. The list of tables can include only tables listed in the Other Tables field and the Core Tables field. | IP switch table, Computer table |
| Asset Table Filter – Queries | List of custom filters to apply to the tables listed in the field Asset Table Filter – Tables. Use ServiceNow to create the encoded query. For details, see the section below on Encoded Queries/Filters in ServiceNow. Each query should be aligned with a table in the field Asset Table Filter – Tables. For example, if I specify two queries: &sysparm_query=operational_status=1, &sysparm_query=install_status=1
| &sysparm_query=operational_status=1, &sysparm_query=install_status=1 |
Adding Values to the Other Tables field and Core Tables field #
To add a table to the Other Tables field or Core Tables field:
- Put your cursor in the Other Tables or Core Tables field.
- Enter the name of the table.
- Press Enter.
- A new chip with the table name appears in the field.
Source Documentation #
Creating Credentials #
To create a user in ServiceNow for the Lucidum connector to use:
Before configuring the ServiceNow connector in Lucidum, you must first create a user with read permissions for all ServiceNow assets. Lucidum will use that account to access ServiceNow.
To create a user in ServiceNow:
-
As an administrator, log into the ServiceNow admin panel and go to the User Administration panel.
-
Click “Users” and then “New”. Fill in the details for this user.
-
Create the user and then search for it in the users screen, to configure it. Click “Edit” to edit the user’s attached roles.
-
Assign the “itil”, “rest_api_explorer”, “web_service_admin” roles and then click “Save” and finally “Update” to save the user.
To generate an OAuth client ID and Oauth client secret for your ServiceNow instance:
Encoded Queries/Filters in ServiceNow #
For details on creating encoded filters in ServiceNow syntax, see https://developer.servicenow.com/dev.do#!/learn/learning-plans/australia/servicenow_application_developer/app_store_learnv2_rest_australia_more_about_query_parameters
Required Permissions #
When creating a user for the Lucidum connector, assign these roles to the user.
| Object | Permissions |
|---|---|
| Role | itil |
| Role | rest_api_explorer |
| Role | web_service_admin |
API Documentation #
https://developer.servicenow.com/dev.do#!/reference/api/australia/rest/