Page tree
Skip to end of metadata
Go to start of metadata

Installing the Agiloft Contract Assistant for Word

After you configure the Agiloft Contract Assistant for Microsoft Word in your KB, the manifest file needs to be installed in your instance of Microsoft Word. As an end user, you can usually tell if you have the add-in installed by simply opening up a Microsoft Word file and checking the upper right corner for the  Agiloft icon. This icon might be labeled "Agiloft," the name of your KB, or both. If the ACA does not appear in Microsoft Word, restart Microsoft Word or sign out and back in to your O365 account. If you've already installed the ACA for Word, but need to update it, visit the Word ACA Update section.

If you enable AI in your system after installing the ACA, you do not need to download or install a new manifest file. Once you've enabled AI, return to the Word Add-in configuration wizard, complete the AI Fields tab, and the AI capabilities will appear in the ACA.

Installation Processes

There are two paths for installing the manifest file. The client receives a zip file prepared by Agiloft containing instructions, scripts, and a manifest file. Then:

  • If you want multiple users to have access instantly, publish the manifest file to an O365 access group and add the appropriate users to that access group so they can use the ACA. This is the preferred method, but is not suitable in every situation. O365 group installation is the only option for Mac users to gain access to the ACA, but can also be used for PCs.
  • If you want to install the ACA individually, each user reads the instructions in the zip file and follows a series of steps to install the manifest file to their local instance of Microsoft Word. These steps are explained in further detail in the next section. Individual installation is not compatible with Mac computers.

If you've followed either of the processes below to install the ACA, and it still isn't appearing in Microsoft Word, sign out of O365 and then sign back in.


O365 Group Installation

The IT professional who receives the custom manifest file must have Admin access to the company's O365 account. The group installation process is called centralized deployment, and can be used to the install the ACA for PC and Mac users. This is the only current option for Mac users who want the ACA for Word. You can find a shareable, comprehensive view of the O365 installation process by consulting this document. You can also find similar information in Microsoft's how-to documentation on deploying add-ins in the admin center. However, step 3 requires more context:

  1. Once you get to step 3 in the Microsoft documentation, click Upload custom apps.
  2. Choose the "I have the manifest file (.xml) on this device" option. Upload the correct manifest file.
  3. Click Upload.
  4. Skip step 4 of the Microsoft documentation and proceed to step 5.
  5. To clarify step 5 of the Microsoft documentation: If this is the initial installation, you should usually choose either "Just me" or "Specific users/groups" in order to test the add-in before full deployment. Testing with a small group of users usually consists of a small set of business stakeholders or users from your IT department.
To use this installation method, ensure that the relevant user groups are selected in the REST groups multi-choice field at Setup > System > Manage Web Services.

Individual Installation

If necessary, users can add the Agiloft Contract Assistant to Microsoft Word on an individual basis. The individual installation process utilizes a zip file that must be provided by Agiloft. This zip file contains an instance of the manifest file and several .bat scripts, both of which are critical to installation. You can add the ACA to Microsoft Word manually by following the steps outlined below. This process is not compatible with Mac computers. These steps are also included in the zip file's README.

Prerequisites

  • Check the Local Disk section of your File Explorer to see if you have a folder called C:\AgiloftWordAddIn. If you do, you can skip the first few steps below; instead, start from step 5.
  • Confirm that you have received a zip file from Agiloft containing a manifest.xml file.
  • If you don't have admin permissions, make sure you have an admin available to assist you for steps 1 and 2. In most cases, individual installation is performed by admins.
  • Ensure your Agiloft representative has taken the necessary steps to prepare your KB to work with the ACA.
  1. Log into Windows as the user who requires access to the ACA add-in.
  2. Run the ShareFolder_byAdmin.bat script by right-clicking the script file and clicking "Run as Administrator" from the drop-down list.
  3. If a warning appears, click More Info. Click the Run Anyway button at the bottom right of the window.
  4. Run the ConfigureWordAddin_byUser.bat script.
  5. If a warning appears, click More Info. Click the Run Anyway button at the bottom right of the window.
  6. Add the manifest file to the C:\AgiloftWordAddIn Shared Folder.
  7. Restart Microsoft Word. 
  8. Once Microsoft Word re-opens, click the Insert tab.
  9. Click Add-ins, and then click My Add-ins.
  10. Click Shared Folder. If the Shared Folder tab is missing from the add-in manager, there may be an issue with the Trust Center Settings for the shared folder's network path. For more information, visit the Microsoft Word Trust Center Settings section of Troubleshooting the Agiloft Contract Assistant.
  11. Select the Agiloft add-in. Press the Add button in the lower right corner of the window, and then click Close.
  12. Check the Home tab of the ribbon in Microsoft Word to ensure that the ACA add-in was added successfully.


Word ACA Update

If you need to update the Word ACA to a newer version, follow the steps below. This update process is for users who installed the ACA using the individual installation process.

  1. Make sure all instances of Microsoft Word are not running.
  2. Locate the shared folder that currently stores the manifest file you originally used to install the ACA. This folder is generally called C:\AgiloftWordAddin.
  3. Remove the old manifest file from the folder. This manifest file can be deleted, but you can also simply move it to another folder.
  4. Now, move the new manifest file to the shared folder. The new manifest file may have been provided to you by Agiloft, but you can also download one yourself from your KB by following these steps:
    1. Navigate to Settings.
    2. Click Integrations.
    3. Under Word Addin, click Configure.
    4. Visit the Download Manifest file tab. Select whichever version of the ACA matches your server code. To check your server code:
      1. Click the Question Mark button in the top right-hand corner of Agiloft, and select About Agiloft.
      2. A window appears. Look at the area highlighted below to determine your release number.
  5. Click Download Manifest file.
  6. Add the new manifest file to the shared folder.
  7. Clear the Office addin cache using the steps found on this Microsoft web page. The biggest takeaway is to ensure that you delete everything inside a folder called %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\.
  8. Open Word. There should not be any ACA icons on your ribbon. On the Insert tab, click My Add-ins.
  9. Select the Shared Folder tab, and click the lone instance of the ACA icon. Click Add.

A new ACA icon should now appear on your ribbon.