Installation of AI Search on SaaS
This guide explains how to enable AI Search in your Aras Innovator SaaS instance.
The AI Search application (API, indexer worker, embeddings) is deployed and operated on the platform side. To turn it on for your instance you need to add two things to your Work repository and run your deployment pipeline:
- AI Search AML package: adds the “Search” command and its configuration to Innovator.
- The OAuth transformation: registers the indexer as a trusted OAuth client so it can read your data.
- An active Aras InnovatorEdge AI Subscription (AS-1242).
- AI Search must be entitled for your SDE (Standard Development Environment). Before starting, open a support incident to request that it be enabled, as it is not enabled by default for all customers.
- Aras DevOps version 1.15 or later.
- Access to your Work repository, the Aras DevOps repository your instance is built from.
- The AI Search release package provided by Aras, a folder named AISearch containing an Import subfolder. Contact your Aras Customer Success Manager or download from the Aras Subscriber Portal to obtain this package.
- Copy the released
AISearchfolder into your Work repository at:
~WorkRepository/AML-packages/AISearch
After copying, the structure looks like this:
~WorkRepository/AML-packages/AISearch/Import/CommandBarItem/ais_search.xml
~WorkRepository/AML-packages/AISearch/Import/CommandBarSectionItem/...
~WorkRepository/AML-packages/AISearch/Import/Method/ais_search_click.xml
~WorkRepository/AML-packages/AISearch/Import/Variable/ais_SearchUIUrl.xml
- Register the package in the imports manifest
~WorkRepository/AML-packages/imports.mf.Add the following entry inside theimportselement, after the other solution packages. This file already exists; the entry is added to it, not a replacement of the file.
<package name="com.aras.innovator.solution.AISearch" path="AISearch\Import" />
Create a new transformation file at the path below, or modify the existing one if it is already present. Add the following clientRegistry block inside the existing clientRegistries element:
~WorkRepositories/TransformationsOfConfigFiles/OAuthServer/OAuth.config
Paste this content exactly:
<?xml version="1.0" encoding="utf-8"?>
<oauth xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
<server>
<clientRegistries>
<clientRegistry id="IndexerWorker" enabled="true"
xdt:Transform="InsertIfMissing" xdt:Locator="Match(id)">
<secrets>
<secret type="JwtBearerAssertionServerSecret">
<certificate filePath="App_Data/Certificates/IndexerWorker.cer">
</certificate>
</secret>
</secrets>
<allowedScopes>
<scope name="Innovator"></scope>
</allowedScopes>
<allowedGrantTypes>
<grantType name="impersonate"></grantType>
</allowedGrantTypes>
<tokenLifetime accessTokenLifetime="3600"></tokenLifetime>
</clientRegistry>
</clientRegistries>
</server>
</oauth>
This transformation registers the AI Search indexer as a trusted OAuth client in Innovator. The IndexerWorker.cer certificate referenced here is deployed automatically to your Innovator instance by the platform during deployment; no manual certificate handling is required. The transformation is idempotent: it inserts the IndexerWorker client only if it is not already present, so re-running the pipeline is safe.
- Commit both changes to your Work repository:
~WorkRepository/AML-packages/AISearch/**and the updatedWork/AML-packages/imports.mf~WorkRepository/TransformationsOfConfigFiles/OAuthServer/OAuth.config
- Push the changes to your online SDE.
- Run your deployment pipeline as usual.
The pipeline applies the AML package and the OAuth transformation to your instance. When it completes, the Search command is available in Aras Innovator.
- Open Aras Innovator and confirm the Search command (AI Search) is present.
- Open the AI Search Configurator using the gear icon and configure at least one ItemType for indexing before running a search. See the AI Search Configurator - Admin Guide for the full configuration procedure.
If the Search command does not appear, or the indexer cannot authenticate, re-run the pipeline and confirm both files were committed to the paths shown above.