Preparing to run the ServiceNow collector
Setting up pre-requisites for running the collector
Make sure that the machine from where you are running the collector meets the following hardware and software requirements.
Item | Requirement |
|---|---|
Hardware (for on-premise runs only) Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time. | |
RAM | 8 GB |
CPU | 2 Ghz processor |
Software (for on-premise runs only) Docker or Java Runtime Environment | |
Docker | Click here to get Docker. |
Java Runtime Environment | OpenJDK 17 is supported and available here. |
data.world specific objects (for both cloud and on-premise runs) | |
Dataset | You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector. If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors. |
Network connection | |
Allowlist IPs and domains | |
Setting up authentication for cataloging ServiceNow
The collector supports Basic Authentication with username and password. To harvest metadata from ServiceNow, you must create a ServiceNow user account with appropriate permissions.
ServiceNow determines authorization based on roles. To harvest the full range of metadata available, the following permissions are required.
To create a user account for the collector:
Log in to the ServiceNow instance.
Browse to All > System Security > Users and Groups > User.
Click New to create a new user. Fill in the required details and save the user.
Next, set a strong password for the user.
Finally, assign the following two roles to the user: rest_api_explorer and admin. With the admin and rest_api_explorer roles, the user account will have read access to the following tables:
Standard metadata tables: sys_app (System Applications), sys_scope (Application Scopes), sys_db_object (Tables), sys_dictionary (Fields), sys_db_view (Views), sys_db_view_table (View Table Mappings), sys_user (Users - used for connection testing)
Data Fabric tables: sn_df_connector (Data Fabric Connectors), sys_df_connection_metadata (Connection Metadata), sys_df_data_dictionary (Data Dictionary), sys_df_connection_data (Connection Data), sn_df_connection_attributes (Connection Attributes), sys_variable_value (Variable Values)