Connectors

Using the connectors, you can ingest content into the application from diverse sources, including third-party repositories like ServiceNow, Microsoft SharePoint, Atlassian’s Confluence, IBM Domino, etc., and provide your users with a seamless search experience.

Search AI provides in-built connectors to enable crawling specific third-party content management applications, CRM systems, web database applications, or cloud-based applications. The application can be configured to connect to multiple systems simultaneously using a connector for each third-party application.

Understanding Connectors

Connectors enable the application to establish a connection with the third-party application. After the connection is established and authentication is complete, the data from the third-party application is ingested, indexed, and ready to answer in response to search queries. The access privileges of the content are maintained as per the privileges assigned to the user in the third-party repository. This implies that only the files accessible to the user can appear in the answers. During each synchronization cycle of the connector, Search AI only retrieves newly added or modified data from the application, determined by the timestamp of changes. If data has previously been indexed and remains unchanged, it is not retrieved again.

Currently, Search AI provides a connector for ServiceNow. The list will continue to grow with future releases and will provide out-of-the-box support for most of the commonly used enterprise applications. For any specific integration requirements, please contact us.

Authorization Support for Connectors

Search AI supports two types of authorization mechanisms.

1. Basic: Basic Authorization involves sending a username and password with each request. These credentials are encoded and sent as a Base64-encoded string in the request header. To use this type of authorization, provide your username and password.

2. OAuth 2.0: The OAuth 2.0 framework allows third-party applications to access resources on behalf of a user without sharing the credentials. It involves the exchange of access tokens between the client application and the authorization server. To use this type of authorization mechanism, register Search AI as an Inbound OAuth client in your backend application.

OAuth 2.0 protocol defines several grant types for different use cases. Each grant type is designed to address specific authorization scenarios.

Currently, SearchAI supports the following grant types:

1. Client credentials Grant Type: In this type, the client application(SearchAI, here) directly accesses the resources from the backend application. The client sends the client ID and client secret and gets an access token to access the resources directly. For this type of authentication, provide the client ID and client secret generated after registering Search AI as an OAuth client application.

2. Authorization Code Grant Type: In the type, the client application(SearchAI) accesses the resources on behalf of a user. Here’s how it works:

   • The client application (in this case, Search AI) initiates the OAuth flow by redirecting the user to the authorization server's authorization endpoint, where the user is prompted to log in to the authorization server.
   • If the login is successful, the authorization server redirects the user back to the client application's redirect URI, along with an authorization code.
   • Upon receiving the authorization code, the client application makes a POST request to the authorization server's token endpoint.
   • The authorization server verifies the authorization code, client credentials, and a redirect URI and responds with an access token and optionally a refresh token in the body of the response.
   • The client application can now use the access token to make authorized requests to the resources.
   • When an access token expires, the client application can use the refresh token to obtain the new token.

   For this type of authentication, provide the client credentials, and on the consent screen, log in with your user credentials to access the resources.

3. Password Grant Type: This type of authorization allows the client application to exchange the user's credentials for an access token. Here’s how it works:

   • The client application authenticates itself to the authorization server by sending its client ID and client secret to the token endpoint.
   • The resource owner provides their credentials (username and password) directly to the client application. The client application sends a POST request to the authorization server's token endpoint, including the user's credentials.
   • If the user's credentials are valid and authorized to access the requested resources, the authorization server responds with an access token.
   • The client application can now use the access token to make authorized requests to the resource server on behalf of the user.

   For this type of authorization, provide the client credentials as well as user credentials with access to the required resources.

Managing Connectors

Adding a content source using Connector

To configure a new connector, go to the Connectors page under Content. For a new connector, click on the +Connect button.

The following page shows the list of available connectors. Choose the connector corresponding to the third-party application that you want to connect to and configure it. For detailed instructions on configuring connectors, refer to the respective documentation.

Ingesting Content

By default when a connector is added, the content is not ingested from the third-party application until a Sync operation is performed. You can either initiate a sync operation manually or schedule an automatic sync.

To initiate a sync operation manually, go to the Configurations tab in the Connector details and click on Sync Now. This initiates the sync operation immediately and ingests new or updated content from the application.

You can also schedule an automatic sync operation for a future time. Automatic Sync ensures that the data stays up-to-date and also reduces the administrative overhead of performing manual sync regularly.

The automatic sync can be scheduled as a one-time activity or to be performed at regular intervals. To schedule a sync operation, enable the Schedule Sync option and provide the date and time of the beginning of the event.

To set up a recurring sync schedule, provide the synchronization frequency along with the date and time of the first sync operation. Once set, the scheduler automatically ingests content using the connector at regular intervals.

To disable automatic synchronization at any time, use the Schedule Sync slider button.

Enabling/Disabling Connectors

After the connector is configured and the source is connected, you can enable or disable the connection temporarily. When a connector is disabled, sync operation is temporarily disabled. This may be useful for testing, particularly when there is more than one connector configured with your Search AIst application.

Note

Disabling a connector does not delete the ingested content. It disables any future data synchronization operation with the third-party application. The sync is resumed based on the configuration after the connector is enabled again.

To enable or disable a connector, use the corresponding Action buttons.

View and Edit Connector Details

To view or edit the connector configuration, i.e., connection settings, sync schedule, etc., click the corresponding connector from the list. The details page shows the config details of the connector under different tabs.

Content

The Content tab lists all the pages crawled from the connector source along with their URL and timestamp of the last update.

Jobs

This tab lists the synchronization-related tasks initiated by Search AI on the connector.

Removing the content source integrated using Connector

To permanently remove a content source and corresponding connector from Search AI, go to the Authorization tab and click the Remove Source button. This will also delete any data in Search AI indexed from the content source.