Skip to content

ServiceNow Connector

You can connect to the ServiceNow application to enable users to fetch query results using the knowledge articles managed by ServiceNow.

Specifications

Type of Repository Cloud
Answer Support knowledge articles managed by ServiceNow.
RACL Support Yes.

To configure the ServiceNow connector, follow the steps listed below.

Step 1: Configure an OAuth endpoint in ServiceNow

If you are using Basic authentication, you can skip this step. To use OAuth 2.0 for authentication, set up an OAuth endpoint in your ServiceNow instance. Refer to this documentation for step-by-step instructions to do the same.

Step 2: Configure the ServiceNow connector in Search AI

  • Select the ServiceNow connector from the list of available connectors.
  • Go to the Authorization tab and enter the following details:

ServiceNow Authorization

  • Name: Give a unique name to the connector
  • Authorization Type: Search AI supports two types of authentication: Basic and OAuth 2.0.
  • Grant Type: For OAuth 2.0, Search AI supports the following two Grant Types for Service Now:
  • Authorization Code: If you are using this grant type, enter the client ID and client secret, generated in the above step.

  • Password Grant Type: If you are using this grant type, enter user credentials along with the client ID and client secret, generated in the above step.

  • Host URL: Host of your ServiceNow instance

Click the Connect button to initiate authorization with the application. After the connection is established, go to the Configurations tab and click Sync Now to ingest content to the application.

RACL Support

SearchAI offers access control for content ingested from ServiceNow Knowledgebases. Currently, SearchAI enforces access control at the knowledge base level.

To learn the basics of RACL in SearchAI, refer to this.

Understanding User Permissions in ServiceNow

In ServiceNow, user access to knowledge base articles can be defined in three ways:

  1. Owners of the Knowledgebase
  2. Managers of the Knowledgebase
  3. User Criteria with specific access permissions (Can Read and Can Contribute) \

User criteria \ \ User Criteria in ServiceNow is a method to group users based on specific conditions. Users can be added directly or included based on conditions such as department, role, etc. \ Individual Users

Handling User Permissions in SearchAI

By default, SearchAI grants access to the following:

* **Owners **of the Knowledgebase – This list of owners will be added directly in racl field(sourceACL) in the indexed content.
* **Managers **of the Knowledgebase – This list of managers will be added directly in racl field of the indexed content.
* **Individual users** listed under each **User Criteria** with Can Read and Can Contribute permissions.

Individual Users \ Each User Criteria is retrieved as a Permission Entity. The permission entity ID is added and is visible in the racl fields of the indexed content. Only users directly listed in the criteria are retrieved as part of the Permission Entity by default. Users associated with other conditions (e.g., department or role) are not automatically included. Therefore, these users cannot access articles unless they are explicitly added to the permission entity using the Permission Entity APIs. For instance, if the owner of a knowledgebase is John@example.com and the knowledgebase can be accessed by users who fulfil a given user criteria, the indexed content will look something like this. "sourceAcl": [

```
 "25431493ff4221009b20ffffffffffe0",
 "John@example.com"
],
```



    The alphanumeric field “25431493ff4221009b20ffffffffffe0” in the indexed content refers to the Permission Entity corresponding to the user criteria for the article.


    ` \

`If there are any identities directly added as Users inside the user criteria, those users will be automatically added to the permission entity. To grant access to all others within the user criteria, those added through other conditions, use the Permission Entity API to associate them with the permission entity.

Advanced Filters

Search AI allows setting up advanced filters to select the content for ingestion. Selective content ingestion can be done using the content properties like status, type, number, knowledge base, source, etc. To set up advanced filtering, go to the Configuration tab, select Sync Specific Content, and click the Configure link.

Configuration

Use the Parameter, Operator, and Value fields to add a filter. The commonly used parameters are listed in the drop-down menu. You can also add other parameters. Refer to this for the complete list of parameters. \ \ For instance, to ingest articles with a given sys ID, use the filter as shown below.

Example

Click on Test and Save to enable the filter. The filter is used on the next scheduled or manual sync with the ServiceNow application.

Note:

  • You can define one or more rules to create a filter. Content that satisfies any one of the rules in the filter is selected for ingestion. For instance, the following filter can be used to select articles where sys ID is either of the list.

Example

  • Every rule can have one or more conditions. The conditions in a rule are linked with a logical AND which suggests that specific content is selected for ingestion when all the conditions in the rule are satisfied. For instance, the following filter can be used to select published articles with a given Sys Id.

Example