Skip to main content
Version: 4.1 (2026 H2)

Microsoft SharePoint App Installation

Overview​

primedocs can be called directly from a SharePoint document library. The primedocs SharePoint app integrates itself into the toolbar:

Via the toolbar button the user is redirected to the primedocs web application, which stores the created documents directly in the respective SharePoint list:

Installation​

Requirements​

  • The SharePoint app only works with Office 365 / Entra ID (Alt: Azure Active Directory) logins, as generated files are stored in the user's name.
  • The Entra ID App Registration needs the scopes Sites.ReadWrite.All, Files.ReadWrite.All as delegate permissions (see Entra ID Apps).
  • Only web-enabled templates are supported (templates released for the web touchpoints and server-side document generation).

.sppkg Installation​

A SharePoint app package (.sppkg, primedocs-sharepoint-extension.sppkg) is available for the installation. It is part of the primedocs server package (in the _Clients subfolder) and can alternatively be obtained from PrimeSoft.

Installation is done via the App Catalog of the SharePoint administration:

  1. Upload the .sppkg to the tenant App Catalog.
  2. Deploy the app in the dialog that appears. As the app is deployed tenant-wide, no per-site activation is required.
  3. The toolbar button is then available in the document libraries of the SharePoint sites.

Configuration​

Operating the primedocs SharePoint App requires a configuration in the root of the SharePoint site.

Create the SharePoint list​

  1. In the root of the SharePoint site, create a list named primedocsSettings.
  2. Add a column named Value of type Single line of text to this list.

Add the configuration entry​

  1. Create a new item in the list:
    • Title: TemplatePickerUrl
    • Value: URL to the primedocs web application in this format https://{INSTANCE-NAME}/app/web/sharepoint

This URL is used by the SharePoint App to redirect the user to the corresponding primedocs web application when the toolbar button is clicked.

Technical details​

The installed SharePoint app adds additional parameters (saveLocationSharePointSiteId, saveLocationSharePointSiteName, saveLocationSharePointFolderPath, saveLocationSharePointListId, saveLocationSharePointListName, saveLocationSharePointUrl) to the configured URL when the button is triggered, so that primedocs can store the documents in the correct document library.

Troubleshooting​

General notes on the rollout (deployment duration, reachability of the primedocs instance) can be found under Troubleshooting: add-in rollout.