SDK

Low-Code

Workflow

DWS API

Install Document Editor for SharePoint Online

This guide outlines the installation steps and general administrative topics related to the Document Editor for SharePoint Online web part.

Prerequisites

Before installing the Nutrient Document Editor for SharePoint Online web part, ensure you have all the required prerequisites — outlined below — installed on your computer.

  • Windows permissions — Windows administrator privileges to run the installer (EXE).

  • Office 365 permissions — Global administrator (or tenant administrator) privileges.

  • As of 9 September 2024, the multi-tenant Entra ID application used by PnP PowerShell has been deleted. It has always been a recommended practice to register your own Entra ID application to use with PnP PowerShell. This has now become a mandatory step. Document Editor installers need to connect to your SharePoint Online environment, and you’ll be asked for a client ID, certificate path, certificate password, and tenant domain. If you’ve already created an app registration in your tenant, you can use its credentials. If not, follow this guide to create an app registration to use with PnP PowerShell.

  • Node.js — You need Node.js installed on your computer.

  • SharePoint Online app catalog — Make sure you have an app catalog in your tenant. If not, follow these instructions to create one.

Installing Document Editor

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

New installation

  1. Download the installation archive and unarchive it to the folder of your choice.

  2. In that folder, find and run the Nutrient Document Editor for SharePoint Online (web part).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, if they aren’t already installed. Agree to both of these to continue.

  4. In the PowerShell window, press 1 to perform a fresh installation. In the next step, the installer will ask where you want to upload the app.

    • Press 1 to upload the app in the tenant app catalog.

    • Press 2 to upload the app in a site app catalog.

Uploading the app in the tenant app catalog

  1. To upload the app in the tenant app catalog, press 1.

  2. Next, enter the SharePoint tenant URL, e.g. https://tenant.sharepoint.com.

  3. Enter your PnP PowerShell app registration credentials from prerequisites.

  4. You’ll then be asked if you want to deploy the app to all sites in the tenant. Choose Y.

  5. You’ll be asked to enter a site page. By default, it’ll use the tenant URL. Enter Y.

  6. Next, you’ll be asked if you want to open PDF files from all sites in the webpage. Enter Y.

If you set the webpage URL, all documents will be loaded on that page, even if they’re in different site collections. As such, you have to ensure that the site containing the page with the web part can open documents from other sites by setting the appropriate permissions.

  1. Enter your web part URL. It must end with ./nutrient.aspx, e.g. https://tenant.sharepoint.com/SitePages/nutrient.aspx.

  2. In this step, you’ll be prompted to update the license key. If you have the license key, enter Y and paste your license key in the next step. If you don’t have the license key, enter N. In this case, the product will be fully functional but will have a trial watermark.

Uploading the app in a site app catalog

  1. To upload the app in a site app catalog, press 2.

  2. Next, enter your SharePoint site URL.

  3. Enter your PnP PowerShell app registration credentials from prerequisites.

  4. If the SharePoint site doesn’t have an app catalog, you’ll be prompted to create one. Enter Y.

  5. You’ll be prompted to install the app on this site, and it’ll add appropriate permissions and deploy the Nutrient artifacts to the app catalog. Enter Y.

  6. You’ll then be prompted to create a page and add the Nutrient Document Editor web part. Enter Y.

  7. You’ll be asked if you want to open PDF files from all sites on this webpage. As the deployment is specific to a site collection, enter N.

  8. In this step, you’ll be prompted to update the license key. If you have the license key, enter Y and paste your license key in the next step. If you don’t have the license key, enter N.

Creating a web part page on a site

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

  1. Download the installation archive and unarchive it to the folder of your choice.

  2. In that folder, find and run the Nutrient Document Editor for SharePoint Online (web part).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.

If the NuGet provider and repository are installed, this step won’t appear.

  1. In the PowerShell window, press 2 to create a web part page in the site.

  2. In the next step, enter the SharePoint tenant URL.

  3. Enter your PnP PowerShell app registration credentials from prerequisites.

  4. Next, you’ll be asked if you want to open PDF files from all sites in the web page. Enter Y.

If you set the web page URL, all documents will be loaded on that page, even if they’re in different site collections. As such, you have to ensure that the site containing the page with the web part can open documents from other sites by setting the appropriate permissions.

  1. Enter your web part URL (it must end with ./nutrient.aspx).

  2. The page and web part will be added to SharePoint Online.

Making a web part page accessible from other sites and site collections

If you want the documents from different site collections to be loaded on a site containing the page with the web part, follow the steps outlined below.

If this property isn’t set, create a page in each site collection under the SitePages library and name it nutrient.aspx.

  1. Download the installation archive and unarchive it to the folder of your choice.

  2. In that folder, find and run the Nutrient Document Editor for SharePoint Online (web part).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.

If the NuGet provider and repositories are installed, this step won’t appear.

  1. In the PowerShell window, press 3 to make a web part page accessible from other sites and site collections.

  2. Then, enter the SharePoint tenant URL.

If you set the web page URL, all documents will be loaded on that page, even if they’re in different site collections. As such, you have to ensure that the site containing the page with the web part can open documents from other sites by setting the appropriate permissions.

  1. You’ll be asked if you want to open PDF files from all sites on this web page. Enter Y.

  2. Next, enter the SharePoint tenant URL, https://tenant.sharepoint.com.

  3. Enter your web part URL (it must end with ./nutrient.aspx) e.g. https://tenant.sharepoint.com/sites/allcompany/SitePages/nutrient.aspx, and the web part will be added to the page.

Preventing a web part page from being accessible from other sites and site collections

If you want to prevent documents from being loaded on a common site containing the page with the web part, follow the steps outlined below.

  1. Download the installation archive and unarchive it to the folder of your choice.

  2. In that folder, find and run the Nutrient Document Editor for SharePoint Online (web part).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.

If the NuGet provider and repositories are installed, this step won’t appear.

  1. In the PowerShell window, press 4 to stop a web part page from being accessible from other sites and site collections.

  2. Then, enter the SharePoint tenant URL.

  3. You’ll be asked if you want to remove the web page from being accessible from other sites. Enter Y.

  4. Note: Now that you’ve removed the site, you’ll need to create the nutrient.aspx page on each site where you want to use Nutrient Document Editor. The access to the page will be removed.

Updating the license key

If you want to prevent documents from being loaded on a common site containing the page with the web part, follow the steps outlined below.

  1. Run the Nutrient Document Editor for SharePoint Online (web part).exe file in the folder. Make sure you’re running the file as an administrator.

  2. In the PowerShell window, press 3 to update the web application and/or the license file.

  3. Next, enter the SharePoint tenant URL, https://tenant.sharepoint.com.

  4. Enter your Nutrient Document Editor license key where it asks for you to update the license key.

Uninstalling Document Editor

To uninstall Nutrient Document Editor for SharePoint Online, follow the steps outlined below.

Removing a web part page from a site

  1. Run the Nutrient Document Editor for SharePoint Online (web part).exe file in the folder. Make sure you’re running the file as an administrator.

  2. In the PowerShell window, press 6 to remove a web part page from a site.

  3. Enter the site URL from where to remove the web part page nutrient.aspx.

  4. Enter the PnP PowerShell app registration credentials from prerequisites.

  5. You’ll be asked if you want to remove a client-side page. Enter Y. The web part page will be removed from the site.

Removing the Nutrient Document Editor app from the app catalog

  1. Run the Nutrient Document Editor for SharePoint Online (web part).exe file in the folder. Make sure you’re running the file as an administrator.

  2. In the PowerShell window, press 7 to remove the Nutrient Document Editor app from the app catalog.

  3. Then, enter the site URL from where to remove the web part page nutrient.aspx.

  4. You’ll be prompted where to remove it from: Press 1 to remove it from the tenant app catalog, and 2 to remove it from the site app catalog.

  5. Select the appropriate option. In this scenario, press 1. The Nutrient Document Editor app will be removed from the tenant app catalog.

Granting access to a guest user

The Nutrient Document Editor for SharePoint Online web part supports guest users. By default, the Everyone group is deactivated in the tenant, so you’ll need to activate this group at the tenant level by running the command below and giving Read permissions on the app catalog site to the Everyone group:

Connect-PnPOnline -URL https://tenant-admin.sharepoint.com

Set-PnPTenant -ShowEveryoneClaim $true

Go to Site Permissions in the app catalog, and add the Everyone group with Read permissions. Then, clear the browser cache. The Nutrient Document Editor for SharePoint Online web part will then be available for guest users.