Onit Documentation

Configuring the Outlook Plugin 2.0

by David Goldfarb Updated

Make sure that Extensions are enabled, and turn on the beta feature

Go to Administration. You should see a node labeled “Extensions”.

If you don't see this node, you won't be able to continue further. Contact Onit Support.

Under Corporation Settings, find the Beta Features node. Make sure that the box labeled "Enable Outlook Plugin" is checked.

Configure a JSON Web Token auth provider

Go to the Designer of any app. Click on Auth Providers, under Global Configuration.

Click the + icon and select “JSON Web Token”. Give your provider a name and a display name. Set Active User to DYNAMIC. The expiration time controls how long an add-in user can remain logged in; we recommend that you set this to the same value as a session for a user in the corporation. Make sure that the “Enabled” box is checked.

Configure an Office Extension

In Administration, go to the Extensions node. Use the + icon to create an Office Extension. Give it a name, and set the JSON Web Token Provider to the auth provider you just created. Set the Fully Qualified Domain Name to:


Configure Your Apps

The latest version of Onit’s Outlook Add-in simplifies the initial setup and configuration by providing basic settings easily accessible through the Settings page for any App.

To enable the add-in for a particular App, go to the App Settings in Advanced Designer and select ‘Enable Outlook Add-in’ from Outlook Add-in section as shown below.

Summary Fields: The Fields specified in this property will be used to search for Records and provide the information returned in search results.

Details Fields: The Fields specified in this property will display in the Record detail view.

Email Field: Select the appropriate email Field from your App.

Repeat these steps as necessary for each App that will work with the Add-in.

Add-in installation

The latest version of the Onit Outlook Add-in can be installed as a custom add-in using the URL below:


From Outlook desktop, a custom add-in can be added via “Get Add-ins” as shown below:

Supply the URL, described above, to install the add-in. Links to the Onit Outlook Connect add-in will appear in the toolbar as shown below:

Click on ‘Onit Outlook Connect’ to open the add-in.

Logging in

When first opening the add-in, it will appear on the right side of the screen with a login prompt as shown below.

Click Continue to Login to authenticate as you normally would to any Onit instance. After logging in, you will automatically be redirected back to the add-in where you will see a tabbed menu of options.

Pinning the add-in open 

To keep the add-in open at all times as you navigate between e-mails, click the push pin icon in the top right corner of the add-in


After a successful login, you will be navigated to list of your Recently Viewed Records. This list is generated automatically as you access records within the Onit system. You will also be able to access any Records that you have favorited from the Favorites tab.

Add-in Actions

The following actions can be taken directly from each entry (shown above) on the recent or favorites list:

  • Linking – use the link icon to send a copy of the current email to the selected Record. Once a link has been made, navigating to this email in Outlook will automatically retrieve the details for the selected Record.
  • Favoriting – use the star icon to add this entry to your list of favorites.
  • Editing – use the pencil icon to open Onit in a pop-up browser. You will be automatically navigated to the current Record where you can edit it, add child Records or take other available actions.

Clicking on the entry will navigate you to the detail for the current Record.

Viewing record detail

A sample Record detail screen is shown below:

The detail displayed on this screen will vary based on App configuration. From this screen, you can take the same actions described above:

  • Linking
  • Favoriting
  • Editing

To return the previous list, click Back to [Recent/Favorites/Search] in the top right corner of the panel.

Searching for records

You can search for Records in your system by navigating to the Search tab, pictured below.

Searches can only be performed one App and one Field at a time. The available search fields will vary based on App configuration.

To start a search, enter a value in the ‘Search’ field and click ‘Search’. All matching results are returned as shown.

If you are unable to find a match and would like to create a new Record, click the Create Record link to launch the Onit form used to create records. Once record creation is complete you will be re-directed back to the add-in.

Previous Article Configuring a NetDocuments Integration
Next Article Using Badges to Enhance App Orchestration Visibility and Workflow

© 2022 Onit, Inc.

docs.onit.com contains proprietary and confidential information owned by Onit, Inc. that is subject to copyright. Onit presents it exclusively to you for your sole use in conjunction with using Onit products. No portion of the materials contained herein may be used for any other purpose. No portion of the materials contained herein may be shared with third parties or reproduced in any form.