Skip to main content

CollectorsCloud Collectors Administration Guide

Prerequisites to Configure the ServiceNow Cloud Collector

Before you configure the ServiceNow cloud collector, you must complete the following prerequisites:

  • Ensure that you have ServiceNow Fuji release version or later.

  • Create a new user and set the ServiceNow time zone as GMT.

  • Enable the client credential flow and obtain the client ID and secret.

  • Provide read permission for the following tables:

    • sysevent (login events)

    • sys_audit (user lockout and update related events)

    • sys_audit_role (roles related events)

    • sys_user (user added events)

    • pwd_reset_request (password reset events)

    • sys_attachment (attachment events)

    • syslog_transaction (resource views events)

    • report_view (report run events)

    • sys_user_role (roles defined, data enrichment)

    • change_request

    • change_task

    • incident

    • interaction

    • problem

    • sc_request

    • sc_task

  • Ensure that you enable table auditing for the following system tables to track changes:

    • sysevent (login events)

    • sys_audit_delete (user deleted events)

    • sys_audit (user lockout and update related events)

    • sys_audit_role (roles related events)

    • sys_user (user added events)

    • pwd_reset_request (password reset events)

    • sys_attachment (attachment events)

    • syslog_transaction (resource views events)

    • report_view (report run events)

    • change_request

    • change_task

    • incident

    • interaction

    • problem

    • sc_request

    • sc_task

Create a New User and Set the Time Zone

Use the following steps to create a new user and set the ServiceNow time zone.

  1. Log in to the ServiceNow console as an administrator.

  2. Navigate to User Administration > Users.

  3. Click New. Then specify the details such as user ID, name, and email. Then set the TimeZone to GMT.

    servicenow_1.png

  4. Note the user ID.

  5. Click Submit.

  6. Navigate to User Administration > Users.

  7. Search for the user ID for the user that you created and click the user ID.

  8. Click Role and click Edit.

    servicenow_2.png

  9. Add the admin role, and click Save.

    servicenow3.png

  10. Click Set Password.

    servicenow_3.png

  11. Generate the password and note the password for later use.

  12. Click Save Password and Close.

  13. Click Update.

Enable the Client Credential Flow

Using OAuth, you log in once by providing a user ID and password. Then use a token for future REST requests instead of entering your credentials each time. For more information obtaining the client ID, secret and access token, see Enable OAuth with inbound REST in the ServiceNow documentation.

  1. Activate the OAuth 2.0 plugin. For more information, see Activate a plugin in the ServiceNow documentation.

  2. Set the value for system property com.snc.platform.security.oauth.is.active to true.

  3. Navigate to System OAuth > Application Registry. Then click New.

  4. Click Create an OAuth API endpoint for external clients.

  5. Record values for the client_id and client_secret for later use for requesting an access token.

  6. To obtain the access token, send a request to the OAuth endpoint (oauth_token.do) using a REST client like CURL (a command-line tool) or Postman (a GUI-based API testing tool).

    The API returns a response containing the access token, which you can use in future API requests to authenticate.

  7. Record the access token for later use.

Enable Auditing for a Table

To enable auditing for a table:

  1. Log in to the ServiceNow console as an administrator.

  2. Navigate to System Definition > Dictionary.

  3. Select the table you want to audit, in the list of dictionary entries. For example, cmdb_ci_computer or sys_user.

  4. Select the dictionary entry for the table.

  5. Select Audit to enable table auditing.

  6. Click Update.

    Note

    Follow this procedure to enable and verify table auditing for multiple tables for which you want to get audit.