Skip to main content

SharePoint API

Diese Schnittstelle bietet die Möglichkeit bidirektional mit dem SharePoint System zu interagieren. 

Kompatibilität

  • SharePoint Online
  • SharePoint On-Premises (2013-2019)

Konfiguration

Um ein Sharepoint System per REST/OData anzusprechen und Aktionen auszuführen, muss an der Squeeze Dokumentenklasse ein Export definiert werden:

image-1613569319628.png

Authentifizierung

Meist wird als Authentifizierungsart die Benutzerauthentifizierung genutzt:

image-1613569510547.png

Beim Authentication Type ist "Benutzer" auszuwählen und die Felder "Benutzername" sowie "Passwort", eines Benutzers der dem SharePoint System bekannt ist, auszufüllen.

Die Felder "ClientId" sowie "Client Secret" sind nur bei dem Authentication Type "App" relevant.

Entität

Um in das System zu exportieren, muss zunächst die Entität bestimmt werden, in welche exportiert werden soll:

  • Dokumentenbibliothek?
  • Liste?

Nachdem dies ausgewählt wurde, kann im Feld "Entity ID" die entsprechende Liste oder Dokumentenbibliothek angegeben werden in der letztendlich der Export stattfindet.
Für Dokumentenbibliotheken muss der technische Name angegeben werden, bei Listen der Anzeigename.

image-1613570041538.png

Dokumentenbibilothek

Für die Dokumentenbibliotheken gibt es noch zwei weitere Einstellungen. 

Export Folder Structure gibt den Pfad in der Dokumentenbibliothek an, in den exportiert werden soll. Dieser kann dynamisch aus Feldwerten der Felder der jeweiligen Dokumentenklasse angegeben werden. Hierzu in dem Feld den Pfad von links nach rechts mit Feldern der Dokumentenklasse auswählen:

image-1613570206614.png

Die letzte Einstellungsmöglichkeit gibt an, ob SQUEEZE den Export-Pfad erstellen soll, falls dieser nicht vorhanden ist.
Ist der Pfad nicht vorhanden und SQUEEZE soll diesen nicht erstellen, wird ein Fehler beim Export eines Vorgangs durch den SharePoint zurückgegeben.

Feldwerte exportieren

Mit den Namen im Zielsystem (externe Feldnamen) können die Spalten eines Listeneintrages bzw. weitere Spalten/Details eines Eintrags einer Dokumentenbibliothek angegeben werden.

image-1613570520380.png

Diese können in der Dokumentenklasse bei den Feldern angegeben werden.

Positionen exportieren

Jedes "Table"-Feld (in dem Beispiel die "LineItems") kann als JSON exportiert werden, wenn ein Zielname definiert wurde.
Dabei muss das Zielfeld mehrzeilig sein.

Reservierte Zielnamen

Der reservierte Zielname "ContentTypeID" gibt das SQUEEZE Feld an, welches den Inhaltstyp des exportierten Vorgangs angibt. Hier reicht es, den Namen anzugeben, SQUEEZE holt sich die ID selbst vom SharePoint. 
Hierbei handelt es sich um die globalen Inhaltstypen (Root) des SharePoints.

 

No Comments
Back to top