Getting Started

Prerequisites

Before installing the Outlook Add-in:

1. Your organization must have the Matter Planner add-on enabled on your Athenty account. Check under Settings → Billing or contact your account admin.
2. You must be logged in to the Athenty admin portal as a user with at least Member role.
3. You must have access to Outlook Web, new Outlook for Windows, classic Outlook for Windows, or Outlook for Mac.

---

Step 1 — Generate a Pairing Code

Each installation requires a one-time 6-digit pairing code.

1. Log in to app.athenty.com.
2. Go to Settings → General.
3. Scroll to the Matter Planner Add-ins section.
4. Click Pair Outlook Add-In — a 6-digit code appears with a 5-minute countdown.

Keep this tab open. You will enter the code in Step 3.

---

Step 2 — Install the Add-in

Admin-Deployed (Recommended for Organizations)

If your IT or Athenty admin is deploying the add-in organization-wide:

1. Log in to the Microsoft 365 Admin Center.
2. Go to Settings → Integrated apps → Upload custom apps.
3. Upload the Athenty manifest XML file (provided by your Athenty account manager).
4. Assign to the relevant users or groups.
5. The add-in will appear in Outlook automatically within 24 hours.

Self-Install (Individual Users)

To install the add-in yourself in Outlook Web or new Outlook for Windows:

1. Open Outlook Web (outlook.live.com or your Microsoft 365 mail).
2. Open any email.
3. Click the Apps button (or the three-dot menu → Get Add-ins).
4. Click My add-ins → Add a custom add-in → Add from file…
5. Upload the manifest XML file provided by your admin or Athenty account manager.
6. The Athenty Matter Planner add-in appears in your add-ins list.

Contact us at athenty.com/contact to request the manifest XML file if you have not already received it.

---

Step 3 — Pair the Add-in with Your Account

1. Open any email in Outlook.
2. Click Athenty Matter Planner in the add-ins toolbar (or in the reading pane overflow menu).
3. The task pane opens showing a 6-digit code prompt.
4. Enter the code you generated in Step 1.
5. The task pane confirms your organization name and your name.

The add-in is now paired. It will use this session going forward and refresh its token automatically.

---

Managing Paired Add-ins

View Active Add-ins

Go to Settings → General → Matter Planner Add-ins in your Athenty dashboard to see a list of all currently paired extensions and add-ins, including channel (outlook, gmail, snap) and last-used date.

Revoke an Add-in

To remove access for a specific Outlook installation:

1. Go to Settings → General → Matter Planner Add-ins.
2. Find the entry labelled Outlook Add-in.
3. Click Revoke.

Revoking one add-in installation does not affect other users or channels. The next time that add-in tries to load, it will return to the pairing screen.

Sign Out from Within the Add-in

1. Open the Athenty Matter Planner task pane.
2. Click the Settings gear icon in the top right of the task pane.
3. Click Sign out.

This removes the local token and returns the add-in to the pairing screen.

---

Troubleshooting

The add-in does not appear in Outlook. If admin-deployed, allow up to 24 hours for the deployment to propagate. If self-installed, check that the manifest uploaded without errors under My add-ins in Outlook.

The pairing code says “Invalid or expired”. Pairing codes expire after 5 minutes. Return to Settings → General → Matter Planner Add-ins in your dashboard and generate a new code.

The task pane shows “Session expired. Please re-pair.” Generate a new pairing code and repeat Step 3. This can happen if the refresh token was revoked from the dashboard or expired.

Outlook Web works but classic Outlook does not. Check that your version of classic Outlook supports web add-ins (Outlook 2016 or later with Microsoft 365 subscription). Older perpetual-license versions of Outlook have limited add-in support.