After you configure Consult this page for information about how to install the Agiloft Contract Assistant for Microsoft Word, after configuring the app 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 a large A icon. This icon can often have Agiloft, the name of your KB, or both beneath it. If the ACA does not appear in Microsoft Word, simply restart Microsoft Word or sign out and back in to your O365 account.
Info |
---|
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 main use cases for installing the manifest file. The client receives a zip file prepared by Agiloft containing instructions, scripts, and a manifest file. Then:
- If the client wants multiple users to have access instantly, they publish the manifest file to an O365 access group. The employees of the customer company who would be using the ACA are added to that access group. This is the preferred method, but is not suitable for some customers.
- The client only wants individual installation, 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.
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.
Hide If | ||
---|---|---|
| ||
The zip file provided to Agiloft employees at the end of this article contains the default instructions and scripts. The manifest file is downloaded from the KB and added to the zip file before providing it to the client. |
O365 Group Installation
The IT professional who receives the custom manifest file must have Admin access to their company's O365 account. The group installation process is called centralized deployment. 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:
.
You may need to sign out of your Microsoft O365 account and then sign back in for the app to appear after installation.
Choosing an Installation Method
This section contains information about the two preferred installation methods. Both of these methods involve accessing the app from the Office Add-in store. If you don't see the Store tab in the Add-in manager, you may need to turn on connected experiences.
The two methods in this section are only available in Release 23 and beyond. If your KB is running a version of
Companyname |
---|
Office Add-in Store
The best way for an individual user to install the Agiloft app for Word is to download it from the Office Add-in store.
To install the add-in:
- Open Microsoft Word.
- Click Get Add-ins.
- Click the Store tab.
- Search for Agiloft and select it when it appears.
- Click Add.
O365
The best way to install the app for many users at once is through an O365 access group. You can also use this method for individual installation by creating an O365 group and including one user. This method is generally performed by an Office admin who can download the app from the Office Add-in store.
To install:
- Log in to O365 as an admin and follow Microsoft's how-to documentation on deploying add-ins in the admin center.
- Once you get to step 3 in the Microsoft documentation, click Choose from Store.
- Search for Agiloft and click the app.
- Click Add.
- Click Continue.
- Proceed to step 5 of the Microsoft documentation.
- Under Assign Users, if this is the initial installation, choose either "Just me" or "Specific users/groups" instead of "Everyone" in order to test the app 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.
- Under Deployment Method, choose if the app will appear by default, or if designated users need to install it.
- Complete the remaining steps of the Microsoft documentation.
If you chose the "Available" option in step 6b, your users need to complete the additional three steps below. If you chose a different option, it can take up to 24 hours for the app to appear on user ribbons.
- Open Microsoft Word.
- For Desktop, open the Home ribbon and click Get Add-ins on Mac or Browse Add-ins on PC.
- For Web, click the three dots found on the far-right of an email message and click Get Add-Ins.
- Click Admin-managed.
- Click the Agiloft app and click Add.
Alternative Installation Methods
This section contains information about the two alternative installation methods. Both of these methods involve installing the app with a manifest file. If you don't already have a manifest file, you can find that information in the Download Manifest section of Configuring the Agiloft Contract Assistant.
Show If | ||
---|---|---|
| ||
This note is visible to internal users only. You can find detailed information about obtaining a manifest file in the Working with Manifest Files section that becomes visible at the bottom of this page when you are logged in. |
The two methods in this section are only used if your KB is running a version of
Companyname |
---|
O365 with Manifest File
The best alternative way to deploy the app to multiple users, or a single user, is by adding a manifest file to an O365 access group and adding the users to that group.
- Open the Microsoft documentation and complete steps 1 and 2 of "Deploy an Office Add-in using the admin center".
- To complete step 3, follow these substeps:
- Click Upload custom apps.
- Select
- Once you get to step 3 in the Microsoft documentation, click Upload custom apps.
- Choose
- the "I have the manifest file (.xml) on this device" option.
- Select the
- manifest file.
- Click Upload.
- Skip step 4 of the Microsoft documentation and proceed to step 5.
- Click Upload.
- When you reach To clarify step 5 of the Microsoft documentation:
- Under Assign Users, if this is the initial installation,
- choose either "Just me" or "Specific users/groups" instead of "Everyone" in order to test the
- app 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.
...
- Under Deployment Method, choose if the app will appear by default, or if designated users need to install it.
- Complete the remaining steps of the Microsoft documentation.
If you chose the "Available" option in step 3b, your users need to complete the additional three steps below. If you chose a different option, it can take up to 24 hours for the app to appear on user ribbons.
- Open Microsoft Word.
- For Desktop, open the Home ribbon and click Get Add-ins on Mac or Browse Add-ins on PC.
- For Web, click the three dots found on the far-right of an email message and click Get Add-Ins.
- Click Admin-managed.
- Click the Agiloft app and click Add.
Note |
---|
To use either O365 |
...
installation method, ensure that the |
...
relevant user groups are selected in the REST groups |
...
multi-choice field |
...
at Setup > System > Manage Web Services. |
...
Local Installation
...
Companyname |
---|
...
with Manifest File
Another alternative way for an individual user to install the app uses a zip file and a manifest file. This method should only be used if no other methods are possible, and is generally for an individual user who can't access the Office Add-in store or doesn't have access to an O365 access group or admin. This method is not compatible with Mac computers.
To install the app:
- Check
...
- the Local Disk section of your File Explorer to see if you have a folder called
C:\AgiloftWordAddIn
. If you do,
...
- skip
...
- to
...
title | Prerequisites |
---|
...
Companyname |
---|
...
Companyname |
---|
...
- step 6 below. Otherwise, you must have admin permissions or an admin available to assist you for steps
...
- 2
...
Companyname |
---|
...
- and 3. Log into Windows as the user who requires access to the ACA add-inapp.
- Run the
ShareFolder_byAdmin.bat
script by right-clicking the script file and clicking "Run as Administrator" from the drop-down list. - If a warning appears, click More Info. Click the Run Anyway button at the bottom right of the window.
- Run the
ConfigureWordAddin_byUser.bat
script. - Select More Info from the dialog box that appearsIf a warning appears, click More Info. Click the Run Anyway button at the bottom right of the window.
- Add the manifest file to the
C:\AgiloftWordAddIn
Shared Folder. - Restart Microsoft Word.
- Once Microsoft Word re-opens, click the Insert tab.
- Click Add-ins, and then click My Add-ins.
- 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.
- Select the Agiloft add-inicon. Press the Add the Add button in the lower right corner of the window, and then click Closeclick Close.
- Check the Home tab of the ribbon in Microsoft Word to ensure that the ACA add-in app was added successfully.
Show If | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
To generate the zip file:
There are important components necessary for installing the ACA add-in. The most important component, the manifest file, is critical for both of the installation processes explained in the previous section. If you are performing an Individual Installation process, the aspiring ACA user receives a zip file that contains the manifest file, among a few other files. The zip file containsfollowing files:
Editing Manifest FilesYou can edit a manifest file so that it can be used by a KB other than the one it was generated from. If you make changes to a manifest file, clear your Office cache before you add the new version of the file. In Word, you can clear your cache via File > Options > Save > Cache Settings. You can also add new manifest files to the shared folder (e.g. C:\AgiloftWordAddin). You don't need to clear your cache, and these new add-in instances show up automatically in the Word ribbon. The only other time you should clear your office cache is if you need to remove add-ins from Microsoft Word. Unfortunately, at this time there is no way to remove individual instances of the add-in without removing others while clearing your cache, but you can right-click and remove the app in some cases. To modify the manifest file:
There are several elements implementers may need to change, depending on the circumstances of the manifest file. ID, Version, Taskpane.Url, CommandsGroup.Label, DisplayName, or ProviderName are some of the most prominent.
If you use the O365 with Manifest File provisioning method, you can modify the manifest file to also contain the server and KB Name, to make it easier for users to connect to
r25-stable ) and replace them all with appsource . Note that this might require replacing any existing O365 deployment with a new deployment in order to allow the admin to upload the modified manifest file to O365 and push it out to users. |
Hide If | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Related articles
|
...