Amazon Kendra is a extremely correct and simple-to-use clever search service powered by machine studying (ML). Amazon Kendra affords a collection of information supply connectors to simplify the method of ingesting and indexing your content material, wherever it resides.
Invaluable knowledge in organizations is saved in each structured and unstructured repositories. An enterprise search resolution ought to have the ability to pull collectively knowledge throughout a number of structured and unstructured repositories to index and search on.
One such knowledge repository is ServiceNow. As the muse for all digital workflows, the ServiceNow Platform® connects folks, features, and programs throughout your group. As knowledge accumulates over time, a whole lot of crucial data is saved in service catalogs, information articles, and incidents together with attachments for every entry.
We’re excited to announce that we have now up to date the ServiceNow connector for Amazon Kendra so as to add much more capabilities. On this model (V2), now you can crawl information articles, service catalog paperwork, and incidents, and likewise herald identification/ACL data to make your searches extra granular. The connector additionally helps ServiceNow variations of Tokyo, Rome, San Diego, and others, and two sync modes: Full Sync mode, which does pressured full syncs, and New, Modified, and Deleted mode, which does incremental syncs.
Answer overview
With Amazon Kendra, you may configure a number of knowledge sources to offer a central place to index and search throughout your doc repository. For our resolution, we exhibit learn how to index a ServiceNow repository utilizing the Amazon Kendra connector for ServiceNow. The answer consists of the next steps:
- Configure an app on ServiceNow and get the connection particulars.
- Retailer the main points in AWS Secrets and techniques Supervisor.
- Create a ServiceNow knowledge supply through the Amazon Kendra console.
- Index the info within the ServiceNow repository.
- Run a pattern question to get the data.
Conditions
To check out the Amazon Kendra connector for ServiceNow, you want the next:
Configure a ServiceNow app and collect connection particulars
Earlier than we arrange the ServiceNow knowledge supply, we’d like just a few particulars about your ServiceNow repository. Let’s collect these upfront.
- Go to https://developer.servicenow.com/.
- Check in along with your credentials.
- Create a ServiceNow occasion by selecting Begin Constructing.
- When you’re at present logged in because the App Engine Studio Creator position, select Change Consumer Function.
- Choose Admin and select Change Consumer Function.
- Select Handle Occasion Password and log in utilizing the occasion URL utilizing the admin consumer and password offered.
- Save the displayed occasion identify, URL, consumer identify, and password for later use.
- Log in to the occasion utilizing the admin URL and credentials from the earlier step.
- Select All and seek for Software Registry.
- Select New to create new OAuth credentials.
- Select Create an OAuth API endpoint for exterior purchasers.
- For Identify, enter
myKendraConnector
and go away the opposite fields clean.The
myKendraConnector
OAuth is now created. - Copy and retailer the consumer ID and consumer secret to make use of when configuring the connector in a later step.
The session token is legitimate for as much as half-hour. It’s important to generate a brand new session token every time you index the content material, or you may configure Entry Token Lifespan with an extended time.
Retailer ServiceNow credentials in Secrets and techniques Supervisor
To retailer your ServiceNow credentials in Secrets and techniques Supervisor, compete the next steps:
- On the Secrets and techniques Supervisor console, select Retailer a brand new secret.
- Select Different kind of secret.
- Create six key-value pairs for
hostUrl
,clientId
,clientSecret
,userName
,password
, andauthType
, and enter the values saved from ServiceNow. - Select Save.
- For Secret identify, enter a reputation (for instance,
AmazonKendra-ServiceNow-secret
). - Enter an non-obligatory description.
- Select Subsequent.
- Within the Configure rotation part, hold all settings at their defaults and select Subsequent.
- On the Overview web page, select Retailer.
Configure the Amazon Kendra connector for ServiceNow
To configure the Amazon Kendra connector, full the next steps:
- On the Amazon Kendra console, select Create an Index.
- For Index identify, enter a reputation for the index (for instance,
my-ServiceNow-index
). - Enter an non-obligatory description.
- For Function identify, enter an IAM position identify.
- Configure non-obligatory encryption settings and tags.
- Select Subsequent.
- Within the Configure consumer entry management part, go away the settings at their defaults and select Subsequent.
- For Provisioning editions, choose Developer version.
- Select Create.This creates and propagates the IAM position after which creates the Amazon Kendra index, which might take as much as half-hour.
- Select Knowledge sources within the navigation pane.
- Underneath ServiceNow Index, select Add connector.
- For Knowledge supply identify, enter a reputation (for instance,
my-ServiceNow-connector
). - Enter an non-obligatory description.
- Select Subsequent.
- For ServiceNow host, enter
xxxxx.service-now.com
(the occasion URL from the ServiceNow setup). - For Sort of authentication token, choose OAuth 2.0 Authentication.
- For AWS Secrets and techniques Supervisor secret, select the key you created earlier.
- For IAM position, select Create a brand new position.
- For Function identify, enter a reputation (for instance,
AmazonKendra-ServiceNow-role
). - Select Subsequent.
- For Choose entities or content material varieties, select your content material varieties.
- For Frequency, select Run on demand.
- Select Subsequent.
- Set any non-obligatory discipline mappings and select Subsequent.
- Select Overview and Create and select Add knowledge supply.
- Select Sync now.
- Anticipate the sync to finish.
Take a look at the answer
Now that you’ve ingested the content material out of your ServiceNow account into your Amazon Kendra index, you may take a look at some queries.
Go to your index and select Search listed content material. Enter a pattern search question and take a look at out your search outcomes (your question will fluctuate based mostly on the contents of your account).
The ServiceNow connector additionally optionally crawls native identification data from ServiceNow. For customers, it units the consumer e-mail ID as principal. For teams, it units the group ID as principal. When you flip off identification crawling, then it is advisable to add the consumer and group mapping to the principal retailer utilizing the PutPrincipalMapping
API. To filter search outcomes by customers or teams, full the next steps:
- Navigate to the search console.
- Increase Take a look at question with consumer identify or teams and select Apply consumer identify or teams.
- Enter the consumer or group names and select Apply.
- Subsequent, enter the search question and press Enter.
This brings you a filtered set of outcomes based mostly in your standards.
Congratulations! You might have efficiently used Amazon Kendra to floor solutions and insights based mostly on the content material listed out of your ServiceNow account.
Clear up
It’s good observe to wash up (delete) any assets you now not need to use. Cleansing up AWS assets prevents your account from incurring any additional fees.
- On the Amazon Kendra console, select Indexes within the navigation pane.
- Select the index to delete.
- Select Delete to delete the chosen index.
Conclusion
With the ServiceNow connector for Amazon Kendra, organizations can faucet into the repository of knowledge saved of their account securely utilizing clever search powered by Amazon Kendra.
On this submit, we launched you to the fundamentals, however there are a lot of further options that we didn’t cowl. For instance:
- You may allow user-based entry management in your Amazon Kendra index and prohibit entry to customers and teams that you simply configure
- You may map further fields to Amazon Kendra index attributes and allow them for faceting, search, and show within the search outcomes
- You may combine the ServiceNow knowledge supply with the Customized Doc Enrichment (CDE) functionality in Amazon Kendra to carry out further attribute mapping logic and even customized content material transformation throughout ingestion
To find out about these prospects and extra, consult with the Amazon Kendra Developer Information.
Concerning the authors
Senthil Ramachandran is an Enterprise Options Architect at AWS, supporting clients within the US North East. He’s primarily centered on Cloud adoption and Digital Transformation in Monetary Providers Business. Senthil’s space of curiosity is AI, particularly Deep Studying and Machine Studying. He focuses on software automations with steady studying and bettering human enterprise expertise. Senthil enjoys watching Autosport, Soccer and spending time along with his household.
Ashish Lagwankar is a Senior Enterprise Options Architect at AWS. His core pursuits embody AI/ML, serverless, and container applied sciences. Ashish is predicated within the Boston, MA, space and enjoys studying, open air, and spending time along with his household.