Die SharePoint Online DMS Schnittstelle erlaubt die Integration mit SharePoint Online.
- Vertec-generierte Legacy Office-Berichte und Office-Berichte können ihre Ausgabe direkt in SharePoint speichern. Das Ergebnis wird in Microsoft 365 Online angezeigt und kann direkt weiterverarbeitet werden.
- Dokumente und E-Mails können mittels Vertec Explorer Addin via Vertec in SharePoint gespeichert werden. Dabei werden die Dokumentenpfade in Vertec berücksichtigt, wie weiter unten erläutert.
- Dokumente können aus Vertec heraus in Microsoft 365 Online geöffnet und bearbeitet werden.
- Es können auch Metadaten geschrieben werden. Die Informationen dazu finden Sie unter SharePoint Metadaten schreiben.
Folgende Vorgänge sind nicht möglich:
- Speichern von Office-generierten Legacy Berichten in SharePoint
- Verwenden von Berichtsvorlagen aus SharePoint
Für den Betrieb der Schnittstelle wird ein SharePoint Online benötigt. Darin muss mindestens ein Hauptuser / Administrator mit Login vorhanden sein.
Zur Inbetriebnahme der Schnittstelle sind folgende Schritte nötig:
Schnittstelle in Vertec installieren
Um die Schnittstelle zu installieren, öffnen Sie im Ordner Einstellungen > Extensions die SharePoint Online DMS Extension und klicken auf Installieren
.
Die Schnittstelle legt folgende Systemeinstellungen CRM/Aktivitäten an:
DMS SharePoint Application ID
Anwendungs-ID der Vertec Applikation in Microsoft 365, siehe Vertec Applikation in Microsoft 365 registrieren.
PropertyName: DmsSharePointApplicationId . StringProperty.
|
DMS SharePoint Application Secret
Registrierungs-Schlüssel der Vertec Applikation in Microsoft 365, siehe Vertec Applikation in Microsoft 365 registrieren.
PropertyName: DmsSharePointApplicationSecret . StringProperty.
|
DMS SharePoint Library URL
Pfad zur SharePoint Dokumentbibliothek, in welcher die Dokumente aus Vertec abgelegt werden sollen. Siehe Abbildung in den Vertec Dokumentenpfaden.
Der hier eingetragene Wert wird in den Vertec Dokumentenpfaden mit SharePoint:\ repräsentiert.
PropertyName: DmsSharePointLibraryUrl . StringProperty.
|
DMS SharePoint OAuth individuelle Anmeldung verwenden
Aktiviert die individuelle Authentisierung, siehe Berechtigungen festlegen und erteilen
Ab Version 6.5.0.1. Falls Sie die SharePoint Online DMS Schnittstelle bereits vor dieser Version installiert hatten, muss diese deinstalliert und neu installiert werden, damit diese Systemeinstellung sichtbar wird.
PropertyName: DmsSharePointUseIndividualLogin . BooleanProperty. Standardeinstellung: Nein.
|
Bei Änderungen an den SharePoint Systemeinstellungen muss die Schnittstelle neu geladen werden: Unter Einstellungen > Schnittstellen > Extensions die SharePoint Online DMS Extension öffnen und auf den Button Reload
klicken.
Vertec Applikation in Microsoft 365 registrieren
Damit die Vertec Applikation auf SharePoint zugreifen kann, muss sie in Microsoft 365 registriert werden:
- https://portal.azure.com/ öffnen und auf
Microsoft Entra ID verwalten
klicken
- Links auf
App-Registrierungen
klicken
- Auf
+ Neue Registrierung
klicken
- Namen eingeben, z.B. Vertec
- Auf den Button
Registrieren
klicken
- Danach sollte Home > Kunde AG | App-Registrierung > Vertec offen sein, mit
Vertec
= Name der soeben erstellen App
- Die Anwendungs-ID (Client) (nicht die Object ID) in den Vertec Systemeinstellungen unter DMS SharePoint Application ID eintragen.
Schlüssel erstellen
- Links auf
Zertifikate und Geheimnisse
klicken
- Unter Geheime Clientschlüssel auf
Neuer geheimer Clientschlüssel
klicken
- Im Feld Beschreibung einen Namen für den Schlüssel eingeben, z.B.
VertecSharePointKey
- Gültigkeitsdauer des Schlüssels wählen (das Maximum beträgt 24 Monate) und den entsprechenden Ablauftermin merken, um vor Ablauf einen neuen Schlüssel zu erstellen.
- Auf
Hinzufügen
klicken
- Der Schlüssel, der in der Spalte
Wert
erscheint, muss in den Vertec Systemeinstellungen unter DMS SharePoint Application Secret eingegeben werden. Der Schlüssel ist später nicht mehr abrufbar.
Berechtigungen festlegen und erteilen
Die SharePoint Online DMS Schnittstelle stellt zwei verschiedene Betriebsmodi der Benutzer-Authentisierung zur Verfügung:
Modus "Als Vertec App"
Dieser Modus kommt zur Anwendung, wenn die Systemeinstellung DMS SharePoint OAuth individuelle Anmeldung verwenden deaktiviert
ist (Standardeinstellung).
In diesem Fall legt Vertec die Dokumente für alle Benutzer unter dem gleichen Benutzeraccount ab, mit dem in der App Registrierung konfigurierten Namen als "Vertec App". Mittels Berechtigungen kann nicht unterschieden werden, wer das Dokument hochgeladen hat.
- Für diese Konfiguration sind Administratorberechtigungen erforderlich. Dieser Schritt muss erfolgreich sein, sonst funktioniert die Anbindung später nicht.
- Auf
API-Berechtigungen
> Berechtigung hinzufügen
klicken
- In der Liste Microsoft Graph auswählen
- Folgende Berechtigungen hinzufügen, als Typ
Anwendung
wählen:
API/Berechtigungsname |
Beschreibung |
Files.ReadWrite.All
|
Read and write files in all site collections |
Sites.FullControl.All
|
Have full control of all site collections |
Sites.Manage.All
|
Create, edit, and delete items and lists in all site collections |
Sites.ReadWrite.All
|
Read and write items in all site collections |
Modus "Individuelle Anmeldung"
Dieser Modus kommt zur Anwendung, wenn die Systemeinstellung DMS SharePoint OAuth individuelle Anmeldung verwenden aktiviert
ist.
In diesem Fall meldet sich Vertec bei SharePoint zwar auch als "Vertec App" an, die Dateien werden aber mit dem SharePoint Account des individuellen Benutzers abgelegt.
- Für diese Konfiguration sind Administratorberechtigungen erforderlich. Dieser Schritt muss erfolgreich sein, sonst funktioniert die Anbindung später nicht.
- Auf
API-Berechtigungen
> Berechtigung hinzufügen
klicken
- In der Liste Microsoft Graph auswählen
- Folgende Berechtigungen hinzufügen, als Typ
Delegiert
wählen:
API/Berechtigungsname
|
Beschreibung |
Sites.FullControl.All
|
Verfügt über Vollzugriff auf alle Sitesammlungen |
Sites.Manage.All
|
Elemente und Listen in allen Websitesammlungen erstellen, bearbeiten und löschen |
Sites.ReadWrite.All
|
Elemente in allen Websitesammlungen bearbeiten oder löschen |
User.Read
|
Anmelden und Benutzerprofil lesen |
Ausserdem muss für diesen Modus eine Umleitungs-URI eingerichtet werden:
- Links auf
Authentifizierung
klicken
+ Plattform hinzufügen
klicken und Web
auswählen
- Als Umleitungs-URI die URL eintragen, unter der die Vertec Instanz erreichbar ist, gefolgt von
callback
. Beispiel: https://mycompany.vertec-cloud.com/callback
.
- Auf
Konfigurieren
klicken.
Damit dies funktioniert, muss sich jeder Benutzer erstmalig über die Vertec Cloud App oder die Vertec Web App an SharePoint anmelden. Die Anmeldedaten werden dann zurück an Vertec geschickt. Danach kann mit allen Vertec Apps gearbeitet werden.
Nach der Registrierung in Microsoft 365 muss die Schnittstelle in Vertec neu geladen werden: Unter Einstellungen > Schnittstellen > Extensions die SharePoint Online DMS Extension öffnen und auf den Button Reload
klicken.
Aufbau der SharePoint Dokumentablage
Damit die Dokumente, die aus Vertec in SharePoint abgelegt werden, am richtigen Ort ankommen, muss die Seiten-Struktur von SharePoint bekannt sein und in den Vertec Dokumentenpfaden entsprechend abgebildet werden.
In SharePoint gibt es Sites (Webseiten), innerhalb der Sites gibt es Libraries (Dokumentbibliotheken), und innerhalb der Libraries gibt es Folders (Ordner). Die Dokumente aus Vertec werden immer in einer Library (Dokumentbibliothek) bzw. einem ihrer Unterordner abgelegt.
Der Aufbau der Struktur hängt von den Anforderungen an die Dateiablage und die Zugriffsberechtigungen ab. Berechtigungen können auf Ebene Site (Webseite) und Library (Dokumentbibliothek) vergeben werden. Auf Ebene Ordner bzw. Unterordner können keine Berechtigungen vergeben werden.
Es ergeben sich also folgende Szenarien:
|
Site |
Library |
Ordner |
Berechtigungen |
1 |
Eine Site |
Eine Library |
Ordnerstruktur aus Vertec, z.B. nach Kunden, nach Projekten etc. |
Berechtigungen für alle User gleich |
2 |
Eine Site |
Mehrere Libraries, z.B. nach Projekttypen, nach Branchen etc. |
Passende Ordnerstruktur, z.B. nach Projekten, Kunden etc. |
Berechtigungen können pro Library vergeben werden |
3 |
Mehrere Sites, z.B. nach Projekttypen |
Je eine oder mehrere Libraries |
Passende Ordnerstruktur |
Berechtigungen können pro Site und pro Library vergeben werden |
Hinweis: In Vertec Versionen vor 6.4.0.21 liegt die maximale Anzahl Libraries bei 200.
Abbildung in den Vertec Dokumentenpfaden
Für die Verbindung mit Sharepoint wird in den Systemeinstellungen CRM/Aktivitäten die DMS SharePoint Library URL angegeben. Hier wird der SharePoint Basispfad eingetragen. Dieser ist so gewählt, dass er jeweils die oberste gemeinsame Ebene in SharePoint repräsentiert, je nach Aufbau der SharePoint Dokumentablage (es kann also auch sein, dass keine "Library" dort eingetragen wird, sondern z.B. eine Site).
In den Vertec Dokumentenpfaden wird diese DMS SharePoint Library URL mit dem Präfix SharePoint:\
angesprochen. Ansonsten werden die Pfade gleich aufgebaut wie im Artikel Dokumentenverwaltung mit Vertec beschrieben.
Für oben genannte Szenarien bedeutet das:
|
DMS SharePoint Library URL |
Systemeinstellungen Dokumentenpfad |
Klasseneinstellungen |
1 |
Pfad zur Library, z.B. https://mycompany.sharepoint.com/sites/Vertec/Freigegebene Dokumente |
SharePoint:\ |
Passend zur gewählten Ordnerstruktur, z.B. Projekte\%code% in den Klasseneinstellungen Projekt. |
2 |
Pfad zur Site, z.B. https://mycompany.sharepoint.com/sites/Vertec |
SharePoint:\ |
In den Klasseneinstellungen der Klasse, nach der die Libraries aufgeteilt werden, z.B. %bezeichnung% in den Klasseneinstellungen Projekttyp.
Die Ordnerstruktur darin muss darauf Bezug nehmen, z.B. %typ.dokpfad%\%code% auf Projekt etc.
|
3 |
SharePoint Basis-Pfad, z.B. https://mycompany.sharepoint.com/sites |
Standard-Pfad, z.B.
SharePoint:\Projekttyp1\Freigegebene Dokumente
Wird für alle Objekte verwendet, die nicht einen anderen Pfad hinterlegt haben. |
Bei allen Klassen, deren Dokumente in einem vom Standard-Pfad abweichenden Verzeichnis abgelegt werden sollen, wird in den Klasseneinstellungen wieder auf SharePoint:\ Bezug genommen und der Rest entsprechend angepasst, z.B. SharePoint:\%bezeichnung%\Freigegebene Dokumente auf Projekttyp.
Die Verzeichnis bzw. Ordnerstruktur darin muss darauf Bezug nehmen, siehe oben.
|
Die Ordner bzw. Unterordner werden von Vertec automatisch erstellt, wenn sie Teil des Dokumentenpfads und noch nicht vorhanden sind. Sites und Libraries müssen in SharePoint vorgängig erstellt werden.
Das System ist so angelegt, dass der SharePoint:
Präfix auch nur bei einzelnen Klassen eingesetzt werden kann. Es ist also auch möglich, nur bestimmte Dokumente in SharePoint zu speichern, ohne den generellen Dokumentenpfad auf SharePoint umzustellen.