Web-Integration

Owned by Robert Mühsig
Last updated: Apr 19, 2024

Konzept

primedocs basic ermöglicht es, die primedocs Vorlagen in anderen Webapplikationen zu integrieren.

Microsoft SharePoint

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

primedocs Integration in SharePoint Toolbar

Über die Toolbar Schaltfläche werden Sie in die primedocs basic-Applikation weitergeleitet, welche nun alle Dokument direkt in der jeweiligen SharePoint Liste abgelegt:

primedocs basic im SharePoint Modus

Technische Details

Für die Konfiguration wird im SharePoint “Root” eine Liste primedocsSettings hinterlegt mit einem Element TemplatePickerUrl, das auf https://{INSTANCE-NAME}/app/web/sharepoint zeigt.

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 basic die Dokumente in der richtigen Dokumentenbibliothek ablegen kann.

Die Azure AD App benötigt hierfür die Scopes: Sites.Read.All, Files.ReadWrite.All.

CMI

Für die Integration in das Produkt CMI ist folgendes nötig:

Im CMI muss primedocs als Applikation registriert sein (Scope templateManager) und die ClientId und das ClientSecret wird benötigt.

Diese Daten müssen dann in der primedocs.config hinterlegt werden:

<primedocs ...> ... <cmi tokenEndpointHost="https://[sts-cmihost.com]" uploadEndpointHost="https://[cmihost.com]" clientId="[Client Id von CMI]" clientSecret="[Client Secret von CMI]" /> ... </primedocs>

Eine Demonstration dieser Integration finden Sie auf unserem YouTube Kanal.

Einbinden von CMI Daten in Vorlagen

Möchte man Daten aus CMI in primedocs Vorlagen anzeigen, kann man diese als Platzhalter über Word PlainText Content Controls mit dem Namensschema CMI_[FELDNAME] bzw. können auch Bookmarks genutzt werden. Sowohl die Content Controls mit dem CMI Naming als auch Bookmarks werden von CMI automatisch mit den richtigen Inhalten befüllt.

Technische Details

Beim Auswahl des primedocs “Template-Picker” wird ein iFrame erzeugt, welches auf die primedocs Web-Applikation zeigt.
Zusätzlich wird der Parameter saveLocationCmiTenant sowie saveLocationCmiToken mitgegeben. Im einfachsten Fall erzeugt die CMI Applikation solch ein iFrame:

<iframe src="https://{INSTANCE-NAME}/app/web/cmi?saveLocationCmiTenant=[CMI-Tenant]&saveLocationCmiToken=[CMI-Token]" style="height: 700px; width: 700px; border: 1px solid;"> </iframe>

Nach dem Erzeugen des Dokuments wird es automatisch an den uploadEndpointHost hochgeladen.

Beim Hochladen geschehen noch folgende Zwischenschritte:

  • Über die ClientId und ClientSecret wird vom [tokenEndpointHost]/[CMI-Tenant]/identity/connect/token mit dem Scope templateManager via client_credentials ein AccessToken angefordert.

  • Das AccessToken wird für den Dateiupload an [uploadEndpointHost]/[CMI-Tenant]/Template/[CMI-Token] angehangen und der Upload wird via HTTP POST ausgeführt.

Nach dem Hochladen wird per Javascript an CMI dieses Objekt geliefert, sodass der Prozess im CMI fortgesetzt werden kann.

window.parent.postMessage({ type: "template-chooser-document-uploaded", name: result.name, }, "*");

 

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland