---
title: "Deploying AI"
canonical: "https://help.agiloft.com/space/HELP/43714933/Deploying+AI"
format: markdown
---
This guide is used to set up AI in Agiloft. While this is a relatively simple process, there are several different steps that can vary depending on the structure or release version of your KB, and this guide aims to cover all possible scenarios in a streamlined fashion. 

> Macro (toc)

# Check the release version> Macro (anchor)



<span style="color: #333333">Users are encouraged to upgrade Agiloft to the </span><span style="color: #333333">[latest version](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715649)</span><span style="color: #333333">, which includes integrated Screens access and more powerful vector label extractions.</span>

To check your release version:

1. Log in to your KB.
2. Click the Question Mark icon in the top right corner.
3. From the drop-down list, click About Agiloft.
4. The release version is indicated by the first two numbers that appear after the word Release.

# Check the template ID> Macro (anchor)



Your KB's template ID determines the steps you need to take to set up AI.

If the ID Format does not match with either of the first two CLM Template formats, <span style="color: #333333">speak with your Agiloft representative</span>.

To determine your template ID:

1. In your KB, navigate to **Setup > System > Manage Global Variables**.
2. In the Customized Variables tab, locate the Deployment ID variable. In older KBs, this may be called Deployment ID and Date.
3. Verify the number in the Value column against the ID Format in the table below to determine your template ID, and follow the  Steps column to proceed.

| **ID Format** | **Example** | **Template** | **Steps** |
| --- | --- | --- | --- |
| 0000.0 | 1234.0 | CLM Template | [Proceed to the Request help section.](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#3) |
| A0000.0 | A1234.0 | CLM AI Template | [Proceed to the Request help section.](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#3) |
| I0000.0 | I1234.0 | ITIL Template | Speak with your Agiloft representative. |
| P0000.0 | P1234.0 | Project Management Template | Speak with your Agiloft representative. |
| Other | Other | Pre-2021 General Template | Speak with your Agiloft representative. |


# Request help from Support> Macro (anchor)



Agiloft AI requires additional licenses. If you are unsure if AI is part of your package, reach out to your Agiloft representative.

#### Generate licenses and deploy Cloud OCR

First, you need several licenses. To check your licenses:

1. Navigate to **Setup > Licenses > Manage Licenses**.
2. Check the table and confirm you have an AI Platform license. If you don't, follow the remaining steps to request it.
3. Reach out to your Agiloft representative, and request the license that you are currently missing. In the request, you should also mention that you need to have Cloud OCR deployed.
4. Navigate to **Setup > Licenses > Manage Licenses **to check your licenses.

Once the licenses are all there, check to see if OCR has been deployed.

1. Navigate to **Setup > Integration > OCR Cloud Services**.
2. In the AWS User Name field, check to make sure that the value uses the same URL as your KB.
3. If the value uses the same URL, proceed to [Setting up your KB](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#thisone). Otherwise, contact your Agiloft representative.

If you have AI deployed without OCR Cloud Services, you will receive a message saying “OCR Cloud service should be configured to integrate it with AI functionality. Configure now?” when you log in to Agiloft. Clicking the Configure button takes you directly to the **Setup > Integration > OCR Cloud Services **page and follow the three step process above.

# Update your KB> Macro (anchor)



Your KB almost certainly requires some manual infrastructure work to take full advantage of AI. Complete the steps in this section to update your KB. If you find you're missing some of the fields mentioned, go to **Setup > Integrations** and click **Deploy** under AI. This will update your system.

#### Update the Navigation menu

In your KB:

1. Navigate to **Setup > Look and Feel > Navigation Menu Setup**.
2. Click New.
3. Under Menu Settings Label, enter AI Platform as the value.
4. Under Navigation Bundle, enter ai_platform as the value.
5. Click Next.
6. Select the following tables individually and click Add for each.
  - AI Projects
  - AI Project Documents
  - Label Library
  - Label Models
7. Click New Grouping.
8. Enter Background Tables and click Finish.
9. Under Navigation Bar Selection, select the new Background Tables grouping.
10. Select the following tables individually and click Add for each.
  - AI Credentials
  - AI Document Types
  - Model Versions
11. Navigate to the Apply tab
12. Click Finish.

#### Update the Contract table

In your KB:

1. Navigate to Setup Contracts.
2. Navigate to the Layout tab.
3. Move the Document Source field from the Attachments tab to the Details tab under the Contract Information section.
4. Add the following fields to the Details tab under the Contract Information section:
  - Upload Document
  - Button: Upload and Analyze
  - Governing Law (extracted)
5. Select a vacant box at the very top of the Details tab and click Insert Heading.
6. Enter Extracted Key Terms and click Finish.
7. Add the following fields to the Details tab under the Extracted Key Terms section:
  - Button: Hide Extracted Key Terms
  - Contract Title (extracted)
  - Duration (extracted)
  - Effective Date (extracted)
  - End Date (extracted)
  - Party 1 Name (extracted)
  - Party 1 Address (extracted)
  - Party 2 Name (extracted)
  - Party 2 Address (extracted)
  - Button: Convert Party 1 to Counterparty
  - Button: Convert Party 2 to Counterparty
8. Click Finish.

#### Update the Attachment table

In your KB:

1. Navigate to Setup Attachments.
2. Add the following fields to the Common Area:
  - Button: Analyze Contract
  - Button: Predict Document Type
3. Add the following fields to the Attachment tab under the Document Analysis section:
  - DA Status
  - DA Error
  - Annotations JSON

# Deploy AI> Macro (anchor)



Once you have licenses installed and Cloud OCR deployed, we need to deploy ConvoAI.

#### Deploy AI

Follow these steps to deploy:

1. Navigate to **Setup > Integration**.
2. Locate the AI section.
3. Click Configure.

#### Verify global variables

Now, we need to verify the following two variables.

1. Navigate to **Setup > System > Manage Global Variables**.
2. In the Variables with Default Values section, locate and edit the variable called Hotlink Server Root URL variable. If it's not there, check the Customized Variables section.
3. In the Global Variable Value field, enter the first part of the KB's URL, beginning with `https://` and ending with `.com` or similar. An example is `https://example.agiloft.com`. Be careful NOT to include a backslash at the end of the URL.

# Test AI deployment> Macro (anchor)



If you completed the previous steps correctly, you should be able to test part of the AI setup now.

All of the following tests should be ran with an admin user, or user with Word app Group permissions.

#### Creating a test contract

To test, it's recommended you create a test contract, if you don't have one already:

1. Create a new Contract in the Contract table.
2. Assign it a Contract Type, and/or any other required fields.
3. Navigate to the Attachments tab. In the File(s) to Upload field, click Attach/Manage.
4. Click Attach File(s).
5. Select a contract document file you'd like to use as the test contract document.
6. Click Finish.
7. Click Add File.

#### Testing import features

To test Legacy and Bulk import:

1. Navigate to **Setup > Licenses > Manage Licenses**.
2. Check to make sure AI Platform (Core) is visible. If yes, continue testing. If not, consult your representative.
3. Navigate to **Setup > Integrations**.
  1. Check that the AI section has the Configure option available beneath it. If it says Deploy, click Deploy.
  2. Check that the OCR section has the Configure option available beneath it. If it says Deploy, click Deploy.
4. Navigate to the Label Models table and check to make sure there are over 100 records. If not, delete all the records. To refresh the list, return to **Setup > Integrations** and click Configure under AI.
5. Navigate to the AI Projects table and create a new record.
  1. Under Type, select Legacy Import.
  2. Give the project a title.
  3. Click Upload Documents. Then, click Attach/Manage to add a test contract.
  4. Wait for the Document Status of Processing to change to Ready for Review.
6. Open the AI Project Document record by clicking the ID number.
7. Navigate to the Advanced tab and do a Ctrl+F search for VSL to check if vector labels are available in your KB. If you see results with VSL, that indicates vector labels are available. If not, reach out to your representative. A large Excluded Labels sections under DAA Errors is to be expected, and isn't generally an indication of error. Click Close.
8. Back in the AI Project record, select the contract and click Mark Reviewed. If prompted, click Run the Action.
9. Select the contract and click Publish Changes. If prompted, click Run the Action. The status should now be Published, although you may need to refresh the page.
10. Navigate to the Contract table and check for a new Contract record. This will be the same document as the AI Project Document. Contract information should populate on the Details tab as well as to any mapped fields, and clauses should be sent to the Contract Clause table.
11. Navigate to Setup > Integrations and click Configure under OCR Cloud service.
12. At the bottom, check to make sure that the count is not 0, as the following steps would have caused the document to be OCR'd. If the count is 0, consult your Agiloft representative.

#### Testing GenAI Prompt Lab setup

To check that Prompt Lab is available:

1. Navigate to **Setup > Licenses > Manage Licenses**.
2. Check to make sure AI Platform (Core) is visible. If yes, continue testing. If not, consult your representative.
3. Navigate to the Setup menu of any table and click the Actions tab.
4. Near the bottom, check for Generative AI action. If it's there, GenAI Prompt Lab is available. If it's not, consult your representative.

#### Testing Word app connection

To test the Word app:

1. Open the test contract file by clicking Checkout and Edit.
2. In Microsoft Word, click the Agiloft icon and log in to the Word app.
3. Highlight a basic key term such as Contract Title and click Tag Selection. Do the same for a clause.
4. Click an area of the document where you can test inserting a clause, and then click Insert Clause. Search for a clause you want to insert, and click Use library clause.
5. Click Publish Changes. In your KB, verify that the tagged clause was sent to the Contract Clause table, and the tagged key term was mapped to the Contract record.
6. Open the test contract again by clicking Checkout and Edit.
7. In the Word app, click the menu icon at the top of the pane and select Manage Clause Library.
8. Highlight a clause and click Tag Selection.
9. Add the Clause Type and Clause Title, then click Add.
10. Click Publish Changes. Check your KB to ensure the the new Clause Library record was created.

#### Testing extraction

To test contract extraction:

1. > Macro (anchor)

Navigate to the Attachments tab of a Contract record.
2. Click the Analyze Contract button. If it's not there:
  1. Click the Attachments table drop-down icon.
  2. Click Setup Attachments.
  3. Navigate to the Layout tab.
  4. Search for Button: Analyze Contract.
  5. If it appears, add it to the layout and click Finish. If it doesn't contact, your Agiloft representative.
3. After you click the Analyze button, proceed to Labels. If you receive an error message that references <span style="color: #333333">AWS textract, </span>proceed to the substeps below:
  1. Take a screenshot of the message.
  2. Consult your Agiloft representative.
  3. Indicate that the message appeared when you were attempting to analyze a PDF file with AI using the Analyze Contract button.
  4. In the same consultation, request a reset of the secret for the OCR Deployment.
  5. When you get the verification from your representative that the secret was reset, create a new Contract, add the attachment again, and click Analyze Contract.
  6. You should be redirected to the Contract record, with a success message displayed near the top of the record.
  7. Open the Contract record, and open the attached document.
  8. Check to make sure there are tags in the document. If there are, proceed to the [next section](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#6). If there aren't, proceed to the substeps below:
    1. Navigate to the Attachment record.
    2. Scroll down. You should see information about the status of the [Document Analysis Action](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718436) used, as well as any errors.
    3. Send this information to your Agiloft representative in a Support ticket.
    4. When your Agiloft representative completes the ticket, return to [step 8](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#swag) and proceed from there.

#### Testing 3rd party paper capabilities

To test working with 3rd party paper:

1. Navigate to the Contracts table and create a new record.
2. Fill out the basic required fields. In the Document Source field, select 3rd Party.
3. Click Attach/Manage in the Upload Document field.
4. Click Attach File(s) and add the file you want to upload.
5. Click Finish. Now, click Upload and Analyze.
6. Check the Contract record to ensure details from your contract were mapped properly. These details should include:
  1. Key term data such as Contract Title mapped to the correct field in Agiloft
  2. New Contract Clause records appear in the Contract Clause table
  3. A new Attachment record linked to the Contract record appears

# Optimize handling of clause labels> Macro (anchor)



The following steps show you how to optimize how your system handles labels.

#### Checking label data

First, check the number of labels in the Label Library against the labels found in [AI Analysis Labels](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714366). If they're different, follow the steps below. Otherwise, skip to the next section.

1. Navigate to the Label Library table.
2. In the Views dropdown list, click Edit.
3. Mark the Display checkbox for Clause Type and Label Model IDs. There is a field called Label Models, but make sure to select Label Model IDs. It is usually found at the bottom of the page.
4. Click Finish.
5. Click the Search icon.
6. Under Label Type, select Clause and click Apply.
7. Delete any duplicate labels, as well as any with no Label Model ID. To determine which one to delete, check the Label Model ID. Delete whichever one does not have a Label Model ID. If they both have a Label Model ID, look at the record ID. Delete the duplicate with the lower record ID number.
8. Navigate to **Setup > Integrations** and click **Configure** under AI. This refreshes the Label Library.
9. Return to the Label Library table.
10. Click the Search icon.
11. Under Label Type, select Clause and click Apply. All the non-duplicate labels that were deleted should now be assigned a Label Model ID.

#### Adding a Data to Conversion action

Now, it's time to add an action to the table.

1. Navigate to Setup Label Library and click Actions.
2. Click Data Conversion Action.
3. Name the action Convert to Clause Type or something similar and click Next.
4. Under Conversions, click New.
5. Name the conversion Convert to Clause Type or something similar.
6. Select the Clause Type table from the table list.
7. Click Next.
8. Locate the Name field, and select Clause Type from the dropdown list to map it.
9. Click Finish.
10. Navigate to the Options tab.
11. Select "Silently with no confirmation" and click Finish.

#### Adding an action button for the new action

Now, add an action button.

1. Navigate to the Fields tab.
2. Under New, select Action Button.
3. Name the field "Button: Convert Library Entry to Clause Type" or something similar.
4. Make the button text "Convert Library Entry to Clause Type" or something similar.
5. Select Execute Actions and click Add Action.
6. Choose Convert to Clause Type and click Finish.
7. Click Finish in the action wizard.

#### Finalize clause optimization

Follow these steps to round out the configuration.

1. Navigate to the Action Bar tab.
2. Edit the Default action bar and navigate to the Design tab.
3. In the Type of Action dropdown list, select Action Button Item.
4. Select the button you just made and click Add. Optionally, move the button to the More folder.
5. Click Finish.
6. Navigate to the Label Library table.
7. Click the Search icon.
8. Under Label Type, select Clause and click Apply.
9. Run the action you just added to the action bar.
10. Select the same clauses, and click Edit Fields.
11. Select Clause Type, and then navigate to the Update tab.
12. Select A formula and input the following: `$_name`
13. Click Next and then click Finish.

# Set up Screens

To deploy the [Screens app](https://agiloft-public.atlassian.net/wiki/spaces/astradrafts/pages/44019136):

1. Log in to your KB as an admin.
2. Navigate to **Setup > Integrations**.
3. Under Screens, click **Deploy**.

Clicking the Deploy button does the following in your KB:

- Creates two new tables, the Screen Run and Screen Result tables. Screens results are automatically mapped into these tables.
- Creates fields in these tables to capture Screens results, as well as a linked set of fields to the Attachment table. You might want to edit your Attachment table layout to add this linked set to the record form.
- Links screen result data to an Attachment record ID as long as the user opened the attachment from within Agiloft.

<span style="color: #333333">We recommend granting administrators permission to view Screens results from other users. You can do so by following the steps below.</span>

1. Navigate to **Setup > Tables**.
2. Open the Screen Result table.
3. Navigate to the Permissions tab.
4. Under View others' Screen Results, select your admin group. This is likely "admin" and perhaps others. <span style="color: #333333">To select multiple groups, hold Ctrl.</span>  
> Macro (inline-media-image)
5. Under Edit others' Screen Results, select your admin group. This is likely "admin" and perhaps others. <span style="color: #333333">To select multiple groups, hold Ctrl.</span>
6. Click Finish.
7. Repeat these steps for the Screen Runs table as well.

#### Connect to Agiloft

To open Screens:

1. Open Microsoft Word.
2. If it's not already there, install the Screens app from the Microsoft App Store.
3. Once it's installed, click the Screens app in the top right corner.  
> Macro (inline-media-image)
4. Click Sign In.
5. Click Sign In with Agiloft Account.
6. Input your Agiloft KB credentials.
  1. For Server URL, copy your KB's URL, only copying from `https://` to `.com/`, or similar.
  2. For KB Name, copy the name of the KB located in the right corner of your KB.  
> Macro (inline-media-image)
  3. Use the same login and password you'd use to access Agiloft.
  4. The first time you sign in, you must select data residency from the drop-down list. This choice is applied to the rest of your organization, and cannot be changed.  
> Macro (inline-media-image)

Once you've signed in, you can screen documents that have been opened with the Checkout & Edit feature in Agiloft. These results will populate into the Screen Result and Screen Run tables. Any time a user checks out a document and runs a screen, the results flow into the Screens tables in your KB. For more information on Screens, visit [Screens](https://agiloft-public.atlassian.net/wiki/spaces/astradrafts/pages/44019136).

# KB Infrastructure

When you click the Deploy button under AI in **Setup > Integrations**, it automatically creates some additional infrastructure in your KB, such as new tables and new fields in existing tables. This information is laid out in the [Deploy Button](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#9) section below.

Depending on when your KB was created, you may also need to add some additional infrastructure manually. Details on how to do so are laid out in the sections following the Deploy Button list below.

## Deploy button> Macro (anchor)



The Deploy button adds new tables, as well as new details to existing tables.

The following tables are added:

- AI Projects
- AI Project documents
- Label Library
- Label Models
- Model Versions
- AI Document Types

The following tables are modified. For more information about the respective changes, click a table or scroll down below.

- [Attachments](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#11)
- [Contracts](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#12)
- [Locations](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#13)
- [Contract Clauses](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#14)
- [Groups](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#15)
- [Teams](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714933/Deploying+AI#16)

### Attachments> Macro (anchor)



<details>
<summary>This process adds fields, actions, and rules to the Attachments table.</summary>

#### Fields

The following fields are added:

- DA Status
- DA Error
- Annotations JSON
- Trigger Extraction
- Button: Analyze Contract
- Button: Predict Document Type

#### Actions

The following actions are added:

- Set Attachment Title from AI Project Document
- Set Trigger Extraction to No
- Set Trigger Extraction to Yes
- Unlink Existing Contract Clauses
- Cloud OCR
- Document Title and Type on OCR File
- Document Title and Type on Attached File
- DAA on OCR File
- DAA on Attached File
- Publish Extracted Data to Contract
- Convert to AI Document
- MS Word to Annotations JSON
- Perform OCR if PDF and no OCR File
- Document Title and Type on Attached File or OCR File
- DAA on Attached File or OCR File

#### Rules

The following rules are added:

- Create/Edit: Analyze Document and Publish Data to Contract
- Create: All create actions except OCR
</details>

### Contracts> Macro (anchor)



<details>
<summary>This process adds fields, actions, and rules to the Contracts table.</summary>

#### Fields

The following fields are added:

- All Internal Company Names
- Extracted Effective Date Format
- Extracted End Date Format
- AI Platform Update
- Show AI Extracted Fields
- Show Upload and Analyze Button
- Button: Hide Extracted Key Terms
- Contract Title (extracted)
- Duration (extracted)
- Effective Date (extracted)
- End Date (extracted)
- Party 1 Name (extracted)
- Button: Convert Party 1 to Counterparty
- Party 1 Address (extracted)
- Party 2 Name (extracted)
- Button: Convert Party 2 to Counterparty
- Party 2 Address (extracted)
- Upload Document
- Button: Upload and Analyze
- Extracted Governing Law

The following fields are removed:

- Extracted/Tagged Clauses
- Contract Clauses from Library
- All Contract Clauses Linked to the Contract

#### Actions

The following actions are added:

- Set Show AI Extracted Fields to No
- Set Show AI Extracted Fields to Yes
- Set AI Platform Update to No
- Set Attachment Type to Uploaded Contract Document
- Clear Upload Document
- Hide Upload and Analyze Button
- Set Extracted Effective Date Format
- Set Extracted End Date Format
- Set Contract Title Based on Extracted Contract Title
- Set Contract Term in Months Based on Extracted Duration
- Set Internal Entity to Extracted Party 1 Name
- Set Set Contract Start Date To to Specific Start Date
- <span style="color: #292a2e">Set Set Contract End Date Using to Specific End Date</span>
- <span style="color: #292a2e">Set Contract Start Date with Day of Date Format</span>
- <span style="color: #292a2e">Set Contract Start Date with ##.##.#### Date Format</span>
- <span style="color: #292a2e">Set Contract Start Date with #/#, # Date Format</span>
- <span style="color: #292a2e">Set Contract Start Date with Other Date Format</span>
- <span style="color: #292a2e">Set Contract End Date with Day of Date Format</span>
- <span style="color: #292a2e">Set Contract End Date with ##.##.#### Date Format</span>
- <span style="color: #292a2e">Set Contract End Date with #/#, # Date Format</span>
- <span style="color: #292a2e">Set Contract End Date with Other Date Format</span>
- <span style="color: #292a2e">Convert Party 1 to Company</span>
- <span style="color: #292a2e">Convert Party 1 Address to Location</span>
- <span style="color: #292a2e">Convert Party 2 to Company</span>
- <span style="color: #292a2e">Convert Party 2 Address to Location</span>
- <span style="color: #292a2e">Create AI Attachment</span>
- <span style="color: #292a2e">Extracted Party must have value for conversion</span>
- <span style="color: #292a2e">Convert Extracted Party 1 to Counterparty Validations and Actions</span>
- <span style="color: #292a2e">Convert Extracted Party 2 to Counterparty Validations and Actions</span>
- <span style="color: #292a2e">Process Extracted Data</span>
- <span style="color: #292a2e">Set Dates Based on Format</span>

#### Rules

The following rules are added:

- Create/Edit: Process Data when AI Platform Update is Yes
</details>

### Locations> Macro (anchor)



<details>
<summary>This process adds fields to the Locations table.</summary>

#### Fields

- Extracted Address
- Complete Address
</details>

### Contract Clause> Macro (anchor)



<details>
<summary>This process adds an action to the Contract Clauses table.</summary>

#### Actions

The following action is added:

- Blank Out Contract ID
</details>

### Groups> Macro (anchor)



<details>
<summary>This process adds two groups to the Groups table.</summary>

#### Groups

- AI Project Annotator
- AI Project Owner
</details>

### Teams> Macro (anchor)



<details>
<summary>This process adds a team to the Teams table.</summary>

#### Teams

- AI Project Team
</details>