Auto Light Dark
Auto Light Dark

Install the Word add-in

The OneApproval Word add-in lets people request, review and track approvals from a task pane next to their Word document. During early access it isn't available on Microsoft AppSource, so a Microsoft 365 admin deploys it as a custom app for your organisation.

We recommend deploying in two stages: first to yourself, to check it works, and then to the people taking part in early access.

Before you start

  • Admin role: You need a Microsoft 365 admin role that can deploy custom apps from Integrated apps, such as Global Administrator or Azure Application Administrator. See Microsoft's guide to deploying apps in the integrated apps portal for the roles each app type needs.

  • Manifest file: The OneApproval manifest is a .zip file.

💾

Download the latest manifest from this link 🔗

  • Who will use it: If you plan to deploy to a group, make sure it's a top-level Microsoft 365 group, distribution list or mail-enabled security group. Microsoft doesn't support nested groups, dynamic distribution groups or non-mail-enabled security groups here.

  • Document location: OneApproval works with documents saved to a cloud location, such as OneDrive or SharePoint.

Step 1: Upload the add-in in Integrated apps

  1. Sign in to the Microsoft 365 admin center.

  2. Go to Settings > Integrated apps.

  3. Below the app list, select Upload custom apps.

  4. Under App type, choose Teams app. Don't choose Office add-in, which is an older app type.

  5. Under Upload manifest file (.zip), select Choose File and select the OneApproval manifest.

  6. Select Next.

Step 2: Deploy to yourself first

  1. On the Users step, choose to deploy to yourself only (Just me).

  2. Select Next.

  3. On the Deployment step, review the permissions OneApproval requests and accept them.

  4. Finish the deployment.

  5. Once the add-in appears in Word, open a test document saved to OneDrive or SharePoint and check that you can open OneApproval and sign in (see Open the add-in in Word).

Step 3: Deploy to your early access users

When you're happy it works, widen the deployment to the people taking part in early access.

  1. In Integrated apps, select OneApproval from the list of deployed apps.

  2. Edit the users it's deployed to and add the specific users or group taking part in early access.

  3. Save your changes.

We recommend using a group rather than individual users. People added to the group get the add-in automatically, and lose it when they're removed.

How long until users see it

Microsoft notes that deployed add-ins can take up to 72 hours to appear in Word, although it's often much quicker. Users may need to close and reopen Word. If they use the Word desktop app rather than Word on the web, they should also check they're signed in to Word.

If you can't use Integrated apps

If your organisation doesn't have access to the integrated apps portal, you can deploy the add-in from the add-ins page in the Microsoft 365 admin center instead. Follow Microsoft's guide to deploying an Office add-in using the admin center.

  1. In the Microsoft 365 admin center, go to Settings > Integrated apps, then select the Add-ins link at the top of the page.

  2. Select Deploy Add-in, then Next.

  3. Choose to upload a custom add-in, and upload the OneApproval manifest file.

  4. Choose who gets the add-in. As above, we recommend Just me first, then the users or group taking part in early access.

  5. Select Deploy.

Open the add-in in Word

Once the add-in is deployed, everyone it's deployed to can use it.

  1. Open a Word document saved to OneDrive or SharePoint.

  2. Select OneApproval on the Home tab of the ribbon to open the task pane. In Word on the web, the OneApproval button may be under the … (more options) menu.

Ask your team to connect their Microsoft accounts

Each person should also connect their Microsoft account in the OneApproval web app so they can see document details and make decisions there. See Sign in and connect your accounts.

Removing the add-in

In Integrated apps, select OneApproval from the list of deployed apps and remove it from its configuration. Only the admin who deployed it, or a Global Administrator, can remove it.

Troubleshooting

  • The add-in doesn't appear in Word: Allow time for the deployment to reach users (up to 72 hours), then close and reopen Word. Check the user is in the deployment, or in a supported group.

Next step

Invite people to your organisation.