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.
Consult this section before you install the ACA, or if you have some problems during installation.
.docxfiles. Using any other type of file can result in but not be limited to tagged annotations no longer loading or issues with running Analyze Document. Handwritten contracts will not register with the ACA.
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.
For any KB created prior to 11/13/2020, using the ACA with the Clause Library requires extra Global Variables. This is especially important for enabling the markup feature that occurs when annotations are updated in the body of the contract document.
|For information about these global variables and how to add them, visit the Add new global variables section of Setting up KBs to use the ACA.|
No metadata_type_table configured" it is likely that you have upgraded your KB software but have not updated the manifest file. To do so, simply download a new manifest file from your KB, remove the unused manifest files from your shared 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.
|No metadata_type_table configured||Download 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.|
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.
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:
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.
C:/AgiloftWordAddInand select Properties.
|Cannot connect to catalog||Add the shared folder's network path to the Trusted Catalogs Table in Microsoft Word's Trust Center Settings.|
Consult this section if you find issues with the ACA after you've installed it.
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.
https:and all the way to the end of the URL. For reference, check out the example below.
|EWWrongDataException: Session could not be created||If 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.|
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.
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:
This section covers some system edits you may need to make if the ACA is not working as intended.
If you see error messages about annotations failing to sync after trying to sync to Agiloft, ensure that the user has View Own, View Others, and Create permissions for all of the tables included in the Word ACA configuration wizard.
If you receive the error message
No column with name "contract_clause_type_id.link" or similar, you 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.
A suggestion is to copy/export and then import the linked field set between the Contract Clause table and the Clause Type table from the standard system demo or another R22 template KB. The new linked field set must contain a column with the logical name
|No column with name "contract_clause_type_id.link" in table||You 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.|
The following troubleshooting techniques are less common, but are included in this article for comprehensive purposes. This section is not visible to clients.