Install Document Converter for SharePoint

Microsoft retired SharePoint Add-Ins on 1 July 2024, so you can no longer acquire them from the public marketplace.

Nutrient Document Converter for SharePoint (Online) uses a SharePoint Framework (SPFx) web part and extension with Microsoft Entra ID authentication.

Use this guide to deploy the SPFx app in your SharePoint Online tenant.

Prerequisites before deployment

Before you deploy the Nutrient SharePoint Framework extension, confirm that you have:

  • Global administrator privileges in your SharePoint Online tenant (or tenant administrator privileges).
  • Administrator privileges on your Windows machine to run the installer script.
  • Execution policy for external scripts set in your PowerShell session: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force
  • An app catalog in your tenant. If you don’t have one, refer to the create an app catalog(opens in a new tab) guide.

Installation files

Download the installation script(opens in a new tab) and application package(opens in a new tab). Place both files in the same folder.

Step 1: Register the Entra ID app

Open PowerShell 7 as an administrator, go to the folder that contains the files, and run PDFConverterForSPOnlineInstallationScript.ps1.

PowerShell installer script menu for Document Converter

The script shows 17 options.

If this is your first setup, use option 16:

  1. Press 16 to register an Entra ID app with a new certificate.
  2. Enter the application name, or press Enter to use the default: PnPPowerShellAppForSPFxInstallation(Nutrient).
  3. Enter your Entra tenant domain (for example, yourcompany.onmicrosoft.com).
  4. Enter a password for the certificate.
  5. Authenticate to your Microsoft 365 tenant when prompted.
  6. Grant consent on behalf of your organization.
  7. The script creates a new certificate in the same folder and registers the Entra ID app.
  8. The script displays the client ID and tenant ID in PowerShell.

Option B: Use an existing certificate

If you already have a .pfx certificate, use option 17:

  1. Press 17 to register by using an existing certificate.
  2. Provide the full path to your .pfx certificate file.
  3. Enter the certificate password.
  4. Authenticate to your Microsoft 365 tenant when prompted.
  5. Grant consent on behalf of your organization.
  6. The script registers a new Entra ID app by using the certificate you provided.
  7. The script displays the client ID and tenant ID in PowerShell.

Save these values — After registration, save the application (client) ID, tenant domain, and certificate path. The script stores these values only for the current PowerShell session.

Option C: Use an existing Entra ID app

If you already registered an Entra ID app, press 15 and provide the client ID when prompted.

Step 2: Install the SPFx app

After you register the Entra ID app, install the SPFx app.

  1. Press 1 to run a fresh installation.

  2. Choose the upload location:

    • Press 1 for the tenant app catalog (recommended). The script doesn’t deploy to all sites automatically; it asks in the next step.
    • Press 2 for a site app catalog (single-site deployment).

  3. Enter your SharePoint URL:

    • Tenant: https://yourcompany.sharepoint.com
    • Site: https://yourcompany.sharepoint.com/sites/yoursite

  4. When prompted with “Do you want to deploy the app to all sites in the tenant?” select:

    • [Y] for tenant-wide deployment
    • [N] for site-specific deployment
      If you select N, the script asks whether to install on a specific site collection.

    Tenant-wide deployment prompt in the installer


  5. After installation on a site collection, the script asks:


    “Do you want to create a page and add the Muhimbi Features web part to this site collection?”


    • Select [Y] to add the web part. The script creates a page in the Site Pages library and adds the web part.
    • Select [N] if you want to add the web part later. You can add it later by pressing 2 when you run the script.

    Prompt to add the Muhimbi Features web part to a site collection


  6. Approve API permissions in SharePoint Admin Center, if prompted:

    • Go to https://<yourtenant>-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement.
    • Grant the required permissions.
    • A global administrator must complete this step.

  7. Elevate app permissions in the site collection and enable custom scripting:

    • Press 8 to elevate permissions.
    • When prompted to enable custom scripts, select [Y].
    • The web part requires custom scripts. You can also enable it later by pressing 12 when you run the script.
    • The web part won’t work until you enable custom scripts. Elevate permissions and enable custom scripts prompt

    The application is now installed.


  8. Verify the installation:

    • Go to the Site Contents page for the site collection where you installed the app.
    • Confirm that the Muhimbi PDF Converter SPFx app (now Nutrient Document Converter) appears in the list.

  9. Use the Convert to PDF action in document libraries:

    • Select a document.
    • Click Convert to PDF in the list view command set or content menu.

    Convert to PDF action in a SharePoint document library

    • The first time you use Convert to PDF, the script prompts you to authenticate and grant permissions for SharePoint access.
    • A global administrator should complete this step.

    Authentication and permissions prompt for the app

  10. If this is a new tenant, after you grant permissions, the app prompts you to start a trial. After signing up, you’ll receive a confirmation email to activate the trial.

    Trial sign-up prompt for new tenants

    Confirmation email to activate the trial

After activation, you can convert, secure, watermark, and merge documents in the SharePoint interface.