Microsoft SharePoint App-Installation

Überblick

primedocs kann direkt aus einer SharePoint Dokumentbibliothek aufgerufen werden. Die primedocs SharePoint App integriert sich hierbei in die Toolbar:

Über die Toolbar-Schaltfläche wird der Benutzer in die primedocs Web-Applikation weitergeleitet, welche die erstellten Dokumente direkt in der jeweiligen SharePoint-Liste ablegt:

Installation

Voraussetzungen

• Die SharePoint App funktioniert nur mit Office 365 / Entra ID (Alt: Azure Active Directory) Logins, da generierte Dateien im Namen des Benutzers gespeichert werden.
• Die Entra ID App Registration braucht hierfür die Scopes Sites.ReadWrite.All, Files.ReadWrite.All als Delegate Permissions (siehe Entra ID Apps).
• Es werden nur webfähige Vorlagen unterstützt (Vorlagen, die für die Web-Touchpoints und die serverseitige Dokumentgenerierung freigegeben sind).

.sppkg Installation

Für die Installation steht ein SharePoint-App-Paket (.sppkg, primedocs-sharepoint-extension.sppkg) zur Verfügung. Es ist Bestandteil des primedocs-Server-Pakets (im Unterordner _Clients) und kann alternativ bei PrimeSoft bezogen werden.

Die Installation erfolgt über den App-Katalog der SharePoint-Administration:

1. Das .sppkg in den App-Katalog des Mandanten (Tenant App Catalog) hochladen.
2. Die App im erscheinenden Dialog bereitstellen («Deploy»). Da die App mandantenweit bereitgestellt wird, ist keine Aktivierung pro Site erforderlich.
3. Anschliessend steht die Toolbar-Schaltfläche in den Dokumentbibliotheken der SharePoint-Sites zur Verfügung.

Konfiguration

Für den Betrieb der primedocs SharePoint App ist eine Konfiguration im Root der SharePoint Site erforderlich.

SharePoint-Liste anlegen

1. Legen Sie im Root der SharePoint Site eine Liste mit dem Namen primedocsSettings an.
2. Ergänzen Sie in dieser Liste eine Spalte mit dem Namen Value vom Typ Einfacher Text.

Konfigurationseintrag hinterlegen

1. Erstellen Sie in der Liste einen neuen Eintrag:
   • Titel: TemplatePickerUrl
   • Value: URL zur primedocs Web-Applikation in diesem Format https://{INSTANCE-NAME}/app/web/sharepoint

Diese URL wird von der SharePoint App verwendet, um den Benutzer beim Klick auf die Toolbar-Schaltfläche an die entsprechende primedocs Web-Applikation weiterzuleiten.

Technische Details

Die installierte SharePoint-App fügt der konfigurierten URL beim Auslösen der Schaltfläche weitere Parameter (saveLocationSharePointSiteId, saveLocationSharePointSiteName, saveLocationSharePointFolderPath, saveLocationSharePointListId, saveLocationSharePointListName, saveLocationSharePointUrl) hinzu, sodass primedocs die Dokumente in der richtigen Dokumentenbibliothek ablegen kann.

Troubleshooting

Allgemeine Hinweise zum Rollout (Bereitstellungsdauer, Erreichbarkeit der primedocs-Instanz) finden sich unter Troubleshooting: Add-In-Rollout.