ServiceNow AI Search Configuration

Raytion Connector Hub for AI Search

Install the Raytion Connector Hub for AI Search

To enable the integration of external third-party content information, the Raytion Connector Hub for AI Search needs to be installed on your Now platform. Download the app from app store and it allows you to start with the integration of your third-party content immediately after the installation. It will create Source System specific content schema in AI Search and will define the corresponding Indexed Source.

To install the Connector Hub App, follow the instructions below:

  • Navigate to menu My Company Application

My Company Application

  • The button Find in Store will navigate you to the Store App

  • Search for Raytion Connector Hub

My Company Application

  • Request App or Trial

Details about the installation can be retrieved from our Store App Installation Guide.

Install the User Mapping Table

The User Mapping Table installed by the Connector Hub requires a execution of a Fix Script once after the initial installation of the app to link it to the corresponding Indexed Source. To run the script, navigate to the Fix Script Overview and search for the script named Raytion Confluence m2m Record.

Fix Script

Make sure to switch to the Application Scope Raytion Connector Hub for AI Search before executing the script.

Fix Script Execution

Create Technical User Account

The connector requires an user account with at least the role ais_external_content to ingest items into AI Search. It is recommended to setup a dedicated technical user account with web service access only.

Technical User Account

Service Portal Search

In order to make the ingested items searchable in your Service Portal Search, a new Search Source needs to be created and linked to the Default Search Profile.

Create and Link Search Source

  • Navigate to the Search Profile Overview under AI Search Menu.

Search Profiles Overview

  • Create and link a new Search Source with name of your preference referencing the Indexed Source created by the Connector Hub. The Indexed Source installed by the Connector Hub is named according to the Source System to synchronize with the Connector.

Default Search Profile
Link Search Source

  • Publish the Default Profile to apply the changes.

Define Facets (Optional)

Once, the Search Source is created in the Default Search Profile, you can create facets in the Default Search Application.

Default Search Application
Facet Defintion

The list of fields defined in the schema can be retrieved from Store App Installation Guide.

Link Search Result Configuration (Optional)

The Connector Hub installs a Search Result Configuration Bundle which can be added to the Default Search Result Configuration to enrich the view in the search result.

  • Open the Search Result Configuration Record of the Service Portal

Service Portal

  • Link the installed EVAM View Config Bundle M2M

Service Portal
Service Portal

Modify AI Search Constraints (Optional)

Rate Limiting

The Rate Limiting restricts the number of requests sent to AI Search to 3600 requests per hour by default. In order to allow more requests to be sent by the connector, navigate to System Webservices → REST → Rate Limit Rules.

Modify the rate limit rules for AIS EC Ingest Document and AIS EC Store Content.

AI Search Rate Limiting
Ingest Document Rate Limiting

Apply the changes also in the connector configuration under Advanced Configuration → ServiceNow AI Search → ServiceNow AI Search Connection Settings → Requests per second.

Extend Content Schema (Optional)

Only metadata defined in the external content schema is accepted and processed by AI Search. As the connector provides further metadata in addition to the properties defined in the schema, you can add a new custom property to the schema in order to index and integrate it into your Search Application.

  • Login as user with the role ais_admin.

  • Navigate to the Tables Menu.

  • Select the respective external content table (can be retrieved from the connector configuration under Basic Configuration → ServiceNow AI Search Settings → Schema).

External Content Table

  • Make sure you have the App Scope Raytion Connector Hub for AI Search selected.

  • Add a new column based on the list of additional metadata provided by the connector.

Add new column
If you use the Raytion Search Result Configuration provided by the Raytion Connector Hub App, do not delete any of the existing property defined in the schema.

The external content table x_ragmh_connector_confluence defines the following columns by default:

Key Label Description Type

source_name

Source Name

Value set to Confluence for all documents.

String (Full UTF-8)

source_type

Source Type

Value set to Confluence for all documents.

String (Full UTF-8)

title

Title

Title of the document

String

item_type

Item Type

Document Type, one of:

Attachment, Blog Post, Comments, Blog Post, Label, Page Comments, Page, User Profile, Space.

String (Full UTF-8)

url

URL

Click URL of the document in Confluence.

String

author

Author

Display Name of the author for the document.

String (Full UTF-8)

last_modified_date

Last Modified Date

Last Modification Date of the document.

Date/Time

space_title

Space Title

Title of the Confluence Space documents belong to.

String (Full UTF-8)

You can extend the schema with following additional metadata provided by the connector:

Key Label Description Type

mime_type

Mime Type

Mime Type of the document e.g. text/html.

String (Full UTF-8)

file_extension

File Extension

File Extension of the document e.g. html.

String (Full UTF-8)

preview_url

Preview URL

Click URL of the document in Confluence.

String (Full UTF-8)

contributors

Contributors

Comma separated names of contributors.

String (Full UTF-8)

created_date

Created Date

Creation Date of the document in Confluence.

Date/Time

breadcrumbs

Breadcrumbs

Comma separated breadcrumb titles.

String (Full UTF-8)

breadcrumb_urls

Breadcrumb URLs

Comma separated breadcrumb URLs.

String (Full UTF-8)

spaceKey

Space Key

Space key for Spaces or for Pages, Attachment and Comments the key of the parent space.

String (Full UTF-8)

spaceTitle

Space Title

Space title for Spaces or for Pages, Attachment and Comments the title of the parent space.

String (Full UTF-8)

spaceUrl

Space URL

Space click URL for Spaces or for Pages, Attachment and Comments the click URL of the parent space.

String (Full UTF-8)

contentStatus

Content Status

Content Status of the document e.g. current.

String (Full UTF-8)

internalId

Internal ID

Unique Identifier of the document in Confluence.

String (Full UTF-8)

excerpt

Excerpt Text attached to the document.

Space click URL for Spaces or for Pages, Attachment and Comments the click URL of the parent space.

String (Full UTF-8)

version

Version

Version Number of the document.

String (Full UTF-8)