Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: removing r23 information published erroneously

Consult this page for information about how to install the Agiloft Contract Assistant for Outlook, after configuring the app in your KB.

You can install the ACA for Outlook using a universally-applicable URL, or a manifest file if you are using Agiloft version r22 or earlier. If you require a manifest file, refer to Configuring the ACA for Outlook for information on how download one. Otherwise, https://outlookaddin.agiloft.com/manifest.xml is the URL.

Installation Processes

There are two main use cases for installing the ACA:

  • If the client wants multiple users to have access instantly, they publish a 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.
  • If the client only wants installation on individual machines, each user follows a series of steps to install a manifest file or URL containing the ACA to their local instance of Microsoft Outlook. 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 Outlook, 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 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:

may need to sign out of your Microsoft O365 account and then sign back in for the app to appear after installation:

  • In the Outlook desktop app, you can find the Agiloft app on the far right-hand side of the Home tab.
  • In the web version of Outlook, you can find the Agiloft app using the three-dot menu on the right-hand side of an open email, near the Reply buttons.

Choosing an Installation Method

The following sections contain 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 you are not running Release 23, or cannot access the Office Add-in store, visit Alternative Installation Methods.

Office Add-in Store

The best way for an individual user to install the Agiloft app for Outlook is to download it from the Office Add-in store.

To install the add-in:

  1. Open Microsoft Outlook.
  2. Click Get Add-ins.
  3. Click the Store tab.
  4. Search for Agiloft and select it when it appears.
  5. Click Add.
    Image Added

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:

  1. Log in to O365 as an admin and follow Microsoft's how-to documentation on deploying add-ins in the admin center.
  2. Once you get to step 3 in the Microsoft documentation, click Choose from Store.
  3. Search for Agiloft and click the app.
  4. Click Add.
  5. Click Continue.
  6. Proceed to step 5 of the Microsoft documentation.
    1. Under Assign Users, if this is the initial installation, you should usually 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.
    2. Under Deployment Method, you can choose if the app will appear by default, or if designated users need to install it.

If you chose the "Available" option in step 6b, your users need to complete the three substeps below. If you chose a different option, it can take up to 24 hours for the app to appear on user ribbons.

  1. Open Microsoft Outlook.
    • 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.
  2. Click Admin-managed.
    My add-insImage Added
  3. Click the Agiloft app and click Add.

Alternative Installation Methods

This sections contains information about three alternative installation methods.

These alternative methods involve installing the app using a URL or a manifest file. The URL method is only available in Release 23 and beyond.

Consult the sections below for installation methods that don't require access to the Office Add-in store. While app functionality isn't compromised, installations using manifest files should only be considered as a last resort due to complexity.

  • If you need to install the app for multiple users, consult the O365 section and use the URL.
  • If you need to install the app individually, consult the Local Installation with URL section.
  • If you are running a version of Agiloft prior to release 23 and need to add multiple users, consult the O365 section and use a manifest file.
  • If you are running a version of Agiloft prior to release 23 and need to install the app individually, consult the Local Installation with Manifest File section.

Anchor
1
1
O365 with URL or Manifest File

The best alternative way to install the app for multiple users is with an O365 access group and a URL. If you can't use a URL, you can instead use a manifest file. 

  1. Open the Microsoft documentation and complete steps 1 and 2 of "Deploy an Office Add-in using the admin center".
  2. To complete step 3 in the Microsoft documentation, follow these substeps:
    1. Click Upload custom apps.
    2. If you are using a URL, paste this URL: https://outlookaddin.agiloft.com/manifest.xml. If you are using a manifest file, upload the correct manifest file.
    3. Click Upload.
  3. Proceed to step 5 of the Microsoft documentation.
    1. Under Assign Users, if this is the initial installation, you should usually
  4. Once you get to step 3 in the Microsoft documentation, click Upload custom apps.
  5. Choose the "I have the manifest file (.xml) on this device" option. Upload the correct manifest file.
  6. Click Upload.
  7. Skip step 4 of the Microsoft documentation and proceed to step 5.
  8. To clarify step 5 of the Microsoft documentation: if this is the initial installation, you will likely want to
    1. choose either "Just me" or "Specific users/groups" instead of "Everyone" in order to test the
    add-in individually or among
    1. app before full deployment. Testing with a small group of users
    , respectively. It's likely the Specific users/groups will consist of a
    1. usually consists of a small set of business stakeholders
    or users
    1. or users from your IT department.
    2. Under Deployment Method, you can choose if the app will appear by default, or if designated users need to install it.

...

  1. Complete the remaining steps of the Microsoft documentation. 

If you chose the "Available" option in step 3b, your users need to complete an additional process for the app to appear. If you chose a different option, it can take up to 24 hours for the app to appear on user ribbons.

  1. Open Microsoft Outlook.
    • 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.
  2. Click Admin-managed.
    My add-insImage Added
  3. Click the Agiloft app and click Add.
Note
To use this installation method, ensure that the group in question is selected in the REST groups

...

multi-choice field at Setup > System > Manage Web Services.

...

Anchor
indv
indv
Local Installation with URL

The best alternative way to install the app for an individual user is with these steps.

  1. Copy this URL:

Individual Installation

There are two ways to individually install the ACA for Outlook. For Release 23 and up, you can do so with a universally-applicable URL. For earlier releases, you must use a manifest file. You can find both installation methods described below.

URL Installation

Follow the steps below to get the ACA for Outlook to appear on the Home ribbon of Microsoft Outlook using the universally-applicable URL. 

  1. Copy this URL, not including the parentheses (https://outlookaddin.agiloft.com/manifest.xml). 
  2. Open Microsoft Outlook.
    • For Desktop,
    from the Home ribbon, click 
    • open the Home ribbon and click Get Add-ins
     on the ribbon
    • .
    • For Web, click the three dots found on the far-right of an email message
    ,
    • and
    click 
    • click Get Add-Ins.
  3. Click My Click My add-ins.
    My add-insImage Modified
  4. Scroll down the page and click Add down and click Add a custom add-in.
    Add a custom add-inImage Modified
  5. Click Click Add from link...
  6. Copy Paste the URL from step 1 into the URL field.
  7. Restart Outlook. Make sure the ACA Agiloft icon appears either on the Home ribbon for Desktop or as an option under the three dots to the far-right of an email message for Web.Image Removed

Anchor
alt
alt
Local Installation with Manifest File

...

If you can't use a URL, and want to install the app locally, follow the steps below.

  1. Make sure

Follow the steps below to get the ACA for Outlook to appear on the Home ribbon of Microsoft Outlook.

  1. Ensure you have a copy of the ACA for Outlook manifest file saved in an easily accessible locationaccessible location. 
  2. Open Microsoft Outlook.
    • For Desktop,
    from
    • open the Home ribbon
    ,
    • and click Get Add-ins
    on the ribbon
    • .
    • For Web, click the three dots found on the far-right of an email message
    ,
    • and click Get Add-Ins.
  3. Click My Click My add-ins.
    My add-insImage Modified
  4. Scroll down the page and click Add a custom add-in.
    Add a custom add-inImage Modified
  5. Click Add Click Add from file...
  6. Locate the manifest file and select it.
  7. Restart Outlook. Make sure the ACA Agiloft icon appears either on the Home ribbon for Desktop or as an option under the three dots to the far-right of an email message for Web.
    Image Removed
Hide If
displayprintable

Content by Label
showLabelsfalse
max7
showSpacefalse
cqllabel = "acaoutlookapp" and space = currentSpace()