PDF Editor File Handler Installation Guide

This guide outlines how to install and configure the PDF Editor for SharePoint in your Office 365 environment.

Before installing the PDF Editor for SharePoint file handler, ensure you have all the required prerequisites — outlined below — installed on your computer.

Prerequisites

• SharePoint Online App Catalog: Make sure you have an app catalog in your tenant. If not, follow these instructions to create one.
• Node.js: You need Node.js installed on your computer.
• Office 365 Permissions: Global administrator (or tenant administrator) privileges.
• Windows Permissions: Windows administrator privileges to run the installer (EXE).
• A Vercel account: If you don’t already have one:
  • Open vercel.com
  • Click Sign Up and complete the registration.
  • Once you register for a Vercel account, open the Vercel CLI page.
  • Copy the following command and run it in the command prompt to install Vercel on your computer: npm i -g vercel
  • If you already have Vercel installed, use the following command to check its version and update it if necessary: vercel --version

New Installation

To install PDF Editor for SharePoint Online, follow the instructions outlined in the next sections.

Installing

1. Download the installation archive and unarchive it to the folder of your choice.
2. In that folder, find and run the PSPDFKit Editor for SharePoint Online (file handler).exe file. Make sure you’re running the file as an administrator.
3. When you launch the installer, it’ll prompt you to install the minimum version of the NuGet provider, along with modules from a repository. Agree to both of these to continue.
4. In the PowerShell window, press 1 to perform a fresh installation.
5. In the next step, enter your Office 365 login credentials (email and password). Be sure to enter your administrator credentials — not your user credentials — because you’ll need them to log in to your Azure account and create an app registration.
6. Now, log in to your Vercel account using the PowerShell window. Use the login credentials you created during the registration step above.
7. Once you log in to Vercel, go back to the PowerShell window and confirm the deployment by typing Y into the command prompt.
8. Proceed with the default scope (which needs to be an account you’re using) as long as it 08 matches the account you previously created.
9. When asked if you want to link to an existing project, enter N.
10. Next, give your new project a name (lowercase only).
11. When asked in which directory your code is located, leave the field blank — it’ll automatically 11 point to the root directory where the code is located.
12. When asked if you want to modify settings, enter N.
13. Now the installation will try to deploy your project to Vercel. You can always check its status 13 on your account page on the Vercel website.

Now that installation is complete, you can go back to the browser and log in to Microsoft Azure using your credentials for this project.

Once logged in, you’ll be redirected to two pages (two tabs in your browser will open): • Azure API permissions tab • Refresh URL tab

Granting Azure Permissions

On the Azure API permissions page, grant all permissions the PDF Editor file handler needs by clicking Grant admin consent.

Then, go to the Refresh URL tab.

Forcing an Admin Refresh

You can refresh the URL on this tab every hour to see if the file handler was successfully provisioned in Azure.

If successful, you’ll see values propagated like shown in the screenshot below.

Note that Microsoft might take up to 72 hours to propagate the values and deploy the PDF Editor’s file handler.

Updating the License

1. Run the PSPDFKit Editor for SharePoint Online (file handler).exe file in the folder. Make sure you’re running the file as an administrator.
2. In the PowerShell window, press 2 to update the web application and/or the license file.
3. Log in to your Vercel account using the PowerShell window. Use the login credentials you created during the registration step above.
4. Once you log in to Vercel, go back to the PowerShell window and confirm the deployment by typing Y into the command prompt. Then, enter your PSPDFKit Editor license key.

Uninstalling PDF Editor for SharePoint

To uninstall PDF Editor for SharePoint, both parts of the solution — the Azure app registration and the Vercel application — need to be removed. The next sections outline how to do that.

Removing the PSPDFKit App Registration

1. Run the PSPDFKit Editor for SharePoint Online (file handler).exe file in the folder. Make sure you’re running the file as an administrator.
2. In the PowerShell window, press to remove the PSPDFKit App Registration from Azure.
3. In the next step, enter your login credentials (email and password). Be sure to enter your administrator credentials — not your user credentials — because you’ll need to log in to your Azure account to delete the app registration.
4. Press Q to Quit.

Removing the Vercel Application

1. Open your browser and log in to vercel.com
2. Navigate to the Project Overview page of the project where the specific deployment is located, and click the Deployments tab.
3. Select the deployment you’d like to delete from the list, and choose Settings.
4. Scroll down to the bottom of the page and click Delete. Enter the project name in the 04 first field, and type delete my project in the second field.

WARNING: Deleting an individual deployment is a permanent, irreversible action.