Use the following resources to ensure that the configuration and installation of the Agiloft Contract Assistant for Microsoft Word are completed successfully. This resource, along with the hyperlinked pages throughout it, should include everything you need when setting up the ACA to work with a KB. Error messages and their solutions are included in tables specific to each section. 

General

Consult this section before you install the ACA, or if you have some problems during installation.

Basic KB

This section assures that you have some basic settings in your KB turned on, as well as to ensure that your version and structure of Agiloft is compatible with the ACA.

Error MessageSolution
No metadata_type_table configuredDownload a new manifest file from your KB, remove the unused manifest files from your Ssared Folder, clear your Office add-in cache, and then move the newly downloaded file to your shared Folder. Then, add the new ACA in Microsoft Word. 

Tables

This section assures that you have the basic KB structure necessary to configure and use the ACA.

If you intend to use the ACA with AI, there are a few additional system items you need, such as the AI Clause Types table. You can use the Preparing your KB section of the Configuring the Agiloft Contract Assistant - Word article for in-depth information about these tables.

Microsoft Word Trust Center Settings

When installing the ACA, you may find that the Shared Folder tab doesn't appear in the shared folder in the Microsoft Word add-in manager. When you try to click Refresh, you receive an error message that says "Cannot Connect to Catalog." To make manifests available in the shared folder in MS Word's add-in manager, the shared folder's network path must appear in the "Trusted Catalogs Table" in the Trust Center Settings. To fix this issue:

  1. In file explorer, navigate to the shared folder called C:/AgiloftWordAddIn. This folder automatically added to your computer after the ShareFolder_byAdmin.bat script and the ConfigureWordAddin_byUser.bat script run during the Installation process.
  2. Right-click C:/AgiloftWordAddIn and select Properties.
  3. Navigate to the Sharing tab and copy the entire string under Network Path.
  4. Open Microsoft Word.
  5. Navigate to File > Options.
  6. On the left-hand side, select Trust Center. 
  7. Click the Trust Center Settings... button.
  8. On the left-hand side of the new window, select Trusted Add-in Catalogs.
  9. Paste the Network Path string from step 3 into the Catalog Url field and click Add Catalog.
Error MessageSolution
Cannot connect to catalogAdd the shared folder's network path to the Trusted Catalogs Table in Microsoft Word's Trust Center Settings.

Post-Installation

Consult this section if you find issues with the ACA after you've installed it.

Logging In

This section covers issues you may encounter when logging in. If you can't log in at all, it is likely a REST issue with your Group permissions, but if you can log in with a username and password, there is an issue with your SSO configuration.

Error MessageSolution
EWWrongDataException: Session could not be createdIf you get this error message when logging in, check your REST group permissions with the information mentioned above. If you can successfully login in with a username and password, but still get this error message when logging in with SSO, then it is your SSO configuration that requires attention.

Manifest File Updates

If you don't see the new icon in your ribbon after your manifest file has been updated, you need to make sure you are logged in to O365. After the new manifest file has been uploaded, you need to connect with O365 in order to get the new version of the ACA onto your local instance of Microsoft Word. You can tell you are signed in by looking for your name at the very top of Microsoft Word.

Addin Diagnostic Log Table

The Addin Diagnostic Log table is a System table that allows you to track your Word ACA usage in Agiloft. This table is useful because it gives you a visual track record for the behavior of the ACA in the System Logs field of the Addin Diagnostic Log record. You can turn on this feature to help  representatives diagnose issues you may be having with your ACA. For example, if you want the Engineering or Support team to help you with an issue that isn't already listed in this article, you should turn on diagnostics logging, reproduce the undesirable behavior, and then create a Support ticket or contact your  representative. This feature is especially helpful if your issue involves Microsoft Word crashing.

To complete this process:

  1. Log in to the ACA for Word.
  2. Click the menu icon on the top right-hand corner and select Settings.
  3. Toggle Enable Diagnostic Logging to Yes to create an Addin Diagnostics Log record. Take note of the new Addin Diagnostic Log record's ID.
  4. Repeat whatever behavior led the problem with the Word ACA. Ideally, these steps should be written down somewhere so they can be easily shared and reproduced.
  5. After the behavior has been repeated, copy the log text from the Settings page and attach it to a Support ticket. If the ACA for Word crashed and the Settings pane is no longer open, you can access the log text by checking the corresponding record in the Addin Diagnostic Log table. This table can be found under System.

Edits/Permissions

This section covers some system edits you may need to make if the ACA is not working as intended.

Error MessageSolution
No column with name "contract_clause_type_id.link" in tableYou may need to reestablish the link between the Contract Clause table and the Clause Type table. To do so, create a new linked field set between the Contract Clause table and the Clause Type table.

Miscellaneous Troubleshooting

The following troubleshooting techniques are less common, but are included in this article for comprehensive purposes. This section is not visible to clients.

Error MessageSolution
An error occurred when trying to check key term extraction result: Operation failedThis error appears when you try to analyze a document that is already associated with records in a different KB. This generally only occurs to internal Agiloft employees who use multiple KBs. To fix this issue, either ensure you are working with the correct KB, or, if you have accidentally associated a document with the wrong KB, simply delete the document's Contract and Attachment records in the incorrect KB.