Schnittstellen & Integrationen
primedocs kann sich sowohl in bestehende Systeme integrieren als auch von anderen Systemen aufgerufen werden, vom Datenbezug über die Web-Einbettung bis zur automatisierten Dokumentgenerierung. Die Benutzerdaten können zusätzlich über die Benutzersynchronisierung aktuell gehalten werden.
Schnittstellenoptionen
- Connect: Dokumenterstellungsprozesse über die Connect-Schnittstelle automatisieren. Connect ermöglicht die teilweise oder vollständige Automatisierung der Dokumentgenerierung.
- Select: Adressdaten und generische Daten von diversen Systemen beziehen via primedocs Select.
- API: Informationen und Dokumentgenerierung in primedocs via Web API aufrufen (Admin API, Connect API, Connect Session API).
- MCP: primedocs-Funktionen über das Model Context Protocol für KI-Agenten (z.B. Microsoft 365 Copilot) bereitstellen.
- Connected Services: externe Dienste, gegen die sich primedocs im Namen des Benutzers authentifiziert (genutzt von InvokeUrl, HttpDataProvider und Connect Sessions).
- Export als Vorlage: primedocs-Vorlagen für Fremdsysteme als «normale» Office-Vorlagen mit Metainformationen exportieren, falls das Zielsystem keine Erweiterungsmöglichkeiten bietet.
- Protokollhandler: den primedocs Desktop Client aus anderen Anwendungen, Links oder Skripten über das
primedocs:-URL-Protokoll aufrufen (neues Dokument erstellen, Fenster steuern, Connect anstossen). - Anwendungsfälle: wie einzelne Drittsysteme und Dienste konkret angebunden werden (primedocs Web in CMI, SharePoint, Teams oder eine eigene Webapplikation einbetten, Dokumente für E-Signatur-Dienste vorbereiten).
3rd Party / Produktintegrationen
primedocs lässt sich je nach Produkt auf unterschiedlichen Wegen an Fachapplikationen und Umsysteme anbinden. Die meisten Anbindungen folgen einem von vier Mustern. Die Liste darunter zeigt, welches Muster für welches Produkt eingesetzt wird.
Integrationsmuster
| Muster | Bausteine | Typischer Einsatz |
|---|---|---|
| Start: Dokument aus der Fachapplikation erstellen | Connect, Connect API, Connect Session API mit Connect Session Templates, Protokollhandler | Die Fachapplikation übergibt Daten wie Fallnummer, Empfänger oder Betreff und stösst die Dokumenterstellung an (siehe Connect Varianten). |
| Daten: Daten in primedocs abrufen | Select mit HttpDataProvider, SqlDataProvider, LdapDataProvider, ExcelDataProvider, CsvDataProvider und ProviderPipeline | Benutzer suchen Adressen oder Stammdaten direkt im Umsystem. Bei REST-APIs mit OAuth-Anmeldung übernimmt ein Connected Service die Authentifizierung im Namen des Benutzers. |
| Weitergabe: Dokument nach der Erstellung übergeben oder ablegen | Commands nach der Dokumentgenerierung (z. B. InvokeUrl), Output Management | Das fertige Dokument geht an ein DMS, einen Signatur- oder Versanddienst oder zurück an die Fachapplikation. |
| Anmeldung und Benutzer | Active Directory bzw. Entra ID, Benutzersynchronisierung, SCIM | Benutzer melden sich mit ihrem bestehenden Konto an, und ihre Daten werden aus dem Verzeichnis übernommen. |
Ein System, das in der folgenden Liste fehlt, lässt sich in der Regel über eines dieser Muster anbinden. Bietet es eine REST-API, ist der HttpDataProvider (bei Bedarf mit einem Connected Service) der übliche Weg für den Datenabruf und die Connect Session API der übliche Weg für den Start aus dem System heraus.
Integrationsbeispiele
info
Die folgende Liste ist nicht abschliessend und zeigt beispielhafte Integrationen in Fachapplikationen und Umsysteme auf.
Die Spalte Umsetzung zeigt, wie die Anbindung zustande kommt:
- Produktintegration: primedocs bringt für dieses Produkt einen eigenen Baustein mit, etwa eine fertige Einbettung, einen eigenen DataProvider oder eine eigene Adressschnittstelle.
- Konfiguration: Die Anbindung nutzt allgemeine Bausteine wie den HttpDataProvider, die Connect Session API oder das Output Management.
- Integrationsansatz: Die Anbindung lässt sich mit allgemeinen Bausteinen umsetzen, ist aber projektspezifisch zu prüfen.
| Produkt | Muster | Umsetzung | Beschreibung |
|---|---|---|---|
| Microsoft Office | Kernbestandteil | Produktintegration | primedocs integriert sich sowohl über COM-Add-Ins als auch über Office.js-basierte Web-Add-Ins in Office. |
| Active Directory / Entra ID | Anmeldung und Benutzer | Produktintegration | Für die Anmeldung (siehe Server-Installation) greift primedocs auf die bestehende Active-Directory- bzw. Entra-ID-Infrastruktur zu. Zugleich dient sie als Quelle für die Benutzersynchronisierung, etwa über LDAP / AD oder Microsoft Graph. |
| SCIM | Anmeldung und Benutzer | Produktintegration | Siehe SCIM. |
| LDAP-Verzeichnisse | Daten, Anmeldung und Benutzer | Produktintegration | Kontaktdaten über den LdapDataProvider abrufen und Benutzer über LDAP / AD synchronisieren. |
| CMI | Start, Daten, Weitergabe | Produktintegration | Dokumenterstellung aus CMI Desktop (Connect) oder CMI Web (Connect Session Template) starten, CMI-Geschäfte als Datenquelle nutzen und Dokumente nach CMI zurückschreiben. Siehe CMI. |
| Microsoft SharePoint | Start | Produktintegration | primedocs Web in SharePoint einbetten. Siehe SharePoint. |
| Microsoft Teams | Start | Produktintegration | primedocs Web in Teams einbetten. Siehe Teams. |
| Microsoft 365 Copilot | Start | Produktintegration | primedocs-Funktionen über das Model Context Protocol für Copilot bereitstellen. Siehe MCP. |
| Microsoft Information Protection (Purview) | Kernbestandteil | Produktintegration | Vertraulichkeitsbezeichnungen beim Generieren anwenden. Siehe Dokumentfunktion MIP. |
| Microsoft Dynamics 365 | Daten, Weitergabe | Konfiguration | Daten über den HttpDataProvider mit einem Connected Service (Entra ID) aus der Web-API von Dynamics 365 abrufen. In primedocs Desktop stehen zusätzlich die Adressschnittstelle Dynamics CRM und die Dokumentfunktion «Dynamics CRM Integration» zur Verfügung. Letztere speichert das Word-Dokument über die Schaltfläche «In Dynamics CRM speichern» im CRM. Sie verwendet den Organisationsdienst klassischer Dynamics-CRM-Installationen mit Windows-Anmeldung. |
| Salesforce | Start, Daten | Integrationsansatz | Dokumenterstellung über die Connect Session API aus Salesforce starten, etwa über eine Schaltfläche, die primedocs Web mit den übergebenen Daten öffnet. Daten über den HttpDataProvider mit einem Connected Service (OAuth) aus der REST-API von Salesforce abrufen. |
| Odoo | Start, Daten | Integrationsansatz | Daten über den HttpDataProvider aus der Web-API von Odoo abrufen und die Dokumenterstellung über die Connect Session API starten. |
| innosolv (innosolvcity, innosolvenergy) | Daten, Weitergabe | Produktintegration | Kontaktdaten über die Adressschnittstelle innosolv abrufen. In classic-Word-Vorlagen übernimmt die Dokumentfunktion «nest/is-e» beim Start über Connect einen Zielpfad, dessen Verzeichnis bereits existieren muss. Über die Schaltfläche «Zur Weiterverarbeitung freigeben» speichert primedocs das Dokument dort, als .docx oder bei der Endung .pdf als PDF/A. |
| Vertec | Daten | Konfiguration | Daten über den HttpDataProvider abrufen, der auch XML-Antworten verarbeitet. Für classic-Vorlagen gibt es die Adressschnittstellen VerTec und Generic HTTP. |
| search.ch (TelSearch) | Daten | Konfiguration | Siehe Beispiel im HttpDataProvider. Für classic-Vorlagen gibt es zusätzlich eine eigene Adressschnittstelle. |
| Zefix | Daten | Konfiguration | Firmendaten über eine ProviderPipeline abrufen. Siehe Beispiel. |
| Microsoft SQL Server | Kernbestandteil, Daten, Anmeldung und Benutzer | Produktintegration | Datenbank von primedocs. Daten über den SqlDataProvider abrufen und Benutzer über SQL synchronisieren. |
| Oracle, MySQL, MariaDB, IBM System i | Daten, Anmeldung und Benutzer | Produktintegration | Siehe SqlDataProvider und Benutzersynchronisierung über SQL. |
| Microsoft Excel / CSV | Daten, Anmeldung und Benutzer | Produktintegration | Siehe ExcelDataProvider, CsvDataProvider, ExistingListDataProvider und Benutzersynchronisierung über CSV. |
| DeepSign / Adobe Acrobat Sign / DocuSign | Weitergabe | Konfiguration | E-Signatur-Dienste über Platzhaltertexte in den Vorlagen ansteuern. Siehe Elektronische Signaturen. |
| ePost | Weitergabe | Integrationsansatz | Dokumente über das Output Management an die ePost Communication Platform übergeben. Siehe ePost. |
Adressschnittstellen (classic)
Für classic-Vorlagen (Word, Excel, PowerPoint und Outlook) bringt primedocs zusätzlich Adressschnittstellen mit, die Kontaktdaten direkt aus einem Drittsystem laden. Sie werden weiterhin ausgeliefert. Für neue Vorlagen ist die Datenschnittstelle mit ihren DataProvidern der empfohlene Weg.
| Adressschnittstelle | System |
|---|---|
| Abacus | Abacus ERP |
| Cobra CRM Plus | cobra CRM |
| Creativ OM | OM von Creativ |
| Dynamics CRM | Microsoft Dynamics CRM |
| Microsoft Dynamics Navision | Microsoft Dynamics NAV |
| ETV Access | Verzeichnisdaten von directoriesDATA |
| Exchange | Kontakte aus Microsoft Exchange |
| Generic HTTP | beliebige HTTP-Schnittstelle mit JSON- oder XML-Antworten |
| Generic SQL | SQL-Datenbanken |
| innosolv | innosolvcity (ehemals NEST) |
| LDAP | LDAP-Verzeichnisse, Active Directory |
| Lotus Notes | HCL Notes (ehemals IBM Lotus Notes) |
| Outlook | Kontakte aus Outlook |
| RUF wwSoft/geSoft | wwSoft und geSoft von RUF Informatik |
| SAP C4C | SAP Cloud for Customer |
| SAP Puls | Personaldaten aus SAP |
| SharePoint | Adresslisten in Microsoft SharePoint |
| search.ch | Telefonverzeichnis search.ch |
| Excel- und CSV-Listen | eigene Adresslisten als Excel- oder CSV-Datei |
| VerTec | Vertec |
| Zefix | Zentraler Firmenindex (Zefix) |
hinweis
Fehlt ein Anwendungsfall in dieser Liste, oder gibt es Fragen zur konkreten Umsetzung? Der Helpdesk hilft weiter. Neue Integrationsmöglichkeiten sind willkommen.
Connect Varianten
Damit eine Fachapplikation direkt den Dokumentgenerierungsprozess anstossen kann, kann die Integrationsmöglichkeit primedocs Connect angewendet werden. Je nach Art der Fachapplikation und des Anwendungsfalls gibt es dabei unterschiedliche Varianten:
| Art der Fachapplikation | Art primedocs Client | Integrationsmöglichkeit | Datenlieferung | Bemerkung |
|---|---|---|---|---|
| Desktop Applikation | primedocs desktop | Connect (siehe Dokumentgenerierung starten) | Ja | |
| Desktop Applikation | primedocs Document Creation Server | Connect API (siehe Connect API) | Ja | Serverseitige Dokumentgenerierung ohne Bearbeitung des Dokuments durch den User |
| Web Applikation | primedocs web | Connect Session Template (siehe Connect Session Templates) | Ja | Integration unserer Webapp in die eigene Webanwendung (siehe Anwendungsfälle). Die Datenlieferung erfolgt über URL-Parameter und die Initializers des Connect Session Templates. |
| Web Applikation | primedocs Document Creation Server | Connect API (siehe Connect API) | Ja | Serverseitige Dokumentgenerierung ohne Bearbeitung des Dokuments durch den User |
| Web Applikation | primedocs desktop | Connect Aufruf via Protokollhandler | Ja | Die Webapplikation kann den primedocs desktop Client via den Protokollhandler aufrufen und als Argument eine URL auf eine API mitgeben, welche das Connect File generiert |