SharePoint

Der SharePoint-Connector bietet SQL-Zugriff auf SharePoint-Dienste und -Server.

Unterstützte Versionen

Dieser Connector unterstützt Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 und höher sowie SharePoint Online.

Hinweise

Führen Sie vor der Verwendung des SharePoint-Connectors die folgenden Aufgaben aus:

  • In Ihrem Google Cloud-Projekt:
    • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkverbindung.
    • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
    • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

    • Aktivieren Sie die folgenden Dienste:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

    Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

SharePoint-Anwendung in Azure (AD) konfigurieren

Wenn Sie Azure Active Directory (AD) für die Onlineversion von SharePoint verwenden möchten, führen Sie die folgenden Schritte aus, um die SharePoint-Anwendung in Azure AD zu konfigurieren:

  1. Wählen Sie im Azure AD-Portal das Verzeichnis Ihrer Organisation aus.
  2. Klicken Sie im Abschnitt Verwalten auf App-Registrierungen und dann auf Neue Registrierung.
  3. Registrieren Sie die Anwendung in Azure AD. Geben Sie dazu die Registrierungsdetails ein:
    1. Wählen Sie für Unterstützte Kontotypen die Option Nur Konten in diesem Organisationsverzeichnis aus.
    2. Wählen Sie für Weiterleitungs-URI (optional) die Option Web aus und fügen Sie https://your_connections_host.spo.index.html als URI für Ihre Verbindungsnutzer hinzu, die ihre Authentifizierungsantwort erhalten.
    3. Klicken Sie auf Registrieren.
    4. Weitere Informationen zum Registrieren einer Anwendung in Azure

  4. Klicken Sie auf der Übersichtsseite Ihrer App auf API-Berechtigungen und dann auf Berechtigung hinzufügen.
  5. So konfigurieren Sie Ihre Anwendung für den Zugriff auf eine Web-API:
    1. Wählen Sie für API-Berechtigungen anfordern auf dem Tab Microsoft APIs die Option SharePoint aus.
    2. Wählen Sie unter Delegierte Berechtigungen die Optionen Nutzerdateien lesen und schreiben und Elemente in allen Websitesammlungen lesen und schreiben aus.
    3. Klicken Sie auf Berechtigungen hinzufügen.
    4. Wählen Sie auf dem Bildschirm mit den konfigurierten API-Berechtigungen Administratoreinwilligung für your_organizational_directory erteilen aus.
  6. Fügen Sie einen Weiterleitungs-URI für die mobile SharePoint-App Ihrer Organisation hinzu:
    1. Klicken Sie auf Authentifizierung.
    2. Klicken Sie unter Web auf URI hinzufügen und fügen Sie https://your_connections_host/spo/mobile.html als Antwort-URL für mobile Nutzer hinzu.
    3. Wählen Sie unter Implizite Gewährung sowohl Zugriffstokens als auch ID-Token aus.
    4. Klicken Sie auf Speichern.
  7. Bearbeiten Sie das Azure Active Directory-App-Manifest, um die von der App verwendete offene Authentifizierung zuzulassen:
    1. Klicken Sie auf der Seite Übersicht der App auf den Bereich Manifest.
    2. Ändern Sie das Attribut oauth2AllowImplicitFlow in true.
    3. Klicken Sie auf Speichern.
  8. Notieren Sie sich auf der Seite Übersicht Ihrer App die Anwendungs-ID (Client-ID). Sie müssen sie im Abschnitt „Authentifizierung“ angeben, wenn Sie den Azure AD-Authentifizierungstyp auswählen, während Sie den SharePoint-Connector konfigurieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

  1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Seite „Verbindungen“

  2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
  3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
    1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Unterstützte Regionen für Connectors:

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Klicken Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie SharePoint aus der Drop-down-Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
    3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 49 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Aktivieren Sie optional Cloud Logging. und wählen Sie dann eine Logebene aus. Die Logebene ist standardmäßig auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:

      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

    8. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    9. Klicken Sie auf Weiter.
  5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
    1. Zieltyp: Wählen Sie einen Zieltyp aus. Die Hostadresse ist beispielsweise https://xxxxx.sharepoint.com.
      • Wählen Sie aus der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse für das Ziel anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang aus der Liste Endpunktanhang aus.

      Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.

      Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + Ziel hinzufügen.

    2. Klicken Sie auf Weiter.
  6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
    1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der SharePoint-Verbindung unterstützt:

      • Windows-Anmeldedaten: Wählen Sie diese Option aus, wenn Sie eine lokale Version von SharePoint verwenden.
      • AzureAD: Wählen Sie diese Option aus, wenn Sie die Onlineversion von SharePoint verwenden.
      • OAuth 2.0-Clientanmeldedaten mit JWT-Inhaber Wählen Sie diese Option aus, wenn Sie für die Authentifizierung OAuth 2.0-Clientanmeldedaten mit JWT-Inhaber verwenden.
      • OAuth 2.0-Clientanmeldedaten mit Clientschlüssel Wählen Sie diese Option aus, wenn Sie OAuth 2.0-Clientanmeldedaten mit Clientschlüssel für die Authentifizierung verwenden.
    2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    3. Klicken Sie auf Next (Weiter).
  7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

  • Windows-Anmeldedaten
    • Nutzername: Geben Sie den Nutzernamen ein.
    • Passwort: Wählen Sie das Passwort aus.
    • Secret-Version: Geben Sie die Secret-Version ein.
  • AzureAD
    • Client-ID: Geben Sie die Client-ID ein, die zum Anfordern von Zugriffstokens verwendet wird. Sie können die Client-ID abrufen, indem Sie die SharePoint-Anwendung in Azure AD konfigurieren.
    • Bereiche: Geben Sie eine durch Kommas getrennte Liste der gewünschten Bereiche ein. z. B. Sites.FullControl.All.
    • Clientschlüssel: Geben Sie das Secret ein, das den Clientschlüssel für die verbundene App enthält, die Sie erstellt haben.
    • Secret-Version: Secret-Version für das oben ausgewählte Secret.
    • Authorization URL (Autorisierungs-URL): Die beim Erstellen des Clients generierte Autorisierungs-URL. Geben Sie die URL im folgenden Format ein: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Beispiel: https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize
  • OAuth 2.0-Clientanmeldedaten mit JWT-Inhaber
    • Client-ID: Geben Sie die Client-ID ein, die zum Anfordern von Zugriffstokens verwendet wird. Dies ist der Consumer-Key, der vom Connector für die von Ihnen erstellte verbundene Anwendung bereitgestellt wird.
    • Privater Schlüssel: Wählen Sie das Secret Manager-Secret aus, das den Inhalt der privaten Schlüsseldatei im PEM-Format enthält. Der private Schlüssel sollte mit dem Public-Key-Zertifikat übereinstimmen, das für Connector bereitgestellt wird.
    • Secret-Version: Secret-Version für das oben ausgewählte Secret.
    • Private Key Password (Passwort für privaten Schlüssel): Wählen Sie das Secret Manager-Secret aus, das das Passwort (die Umschreibung) der privaten Schlüsseldatei enthält.
    • Secret-Version: Secret-Version für das oben ausgewählte Secret.
    • Azure-Mandant: Der Microsoft Online-Mandant, der für den Zugriff auf Daten verwendet wird.
  • OAuth 2.0-Clientanmeldedaten mit Clientschlüssel
    • Client-ID: Geben Sie die Client-ID ein, die vom Connector für die von Ihnen erstellte Anwendung bereitgestellt wird.
    • Client Secret: Wählen Sie das Secret Manager-Secret mit dem Clientschlüssel für die verbundene App aus, die Sie erstellt haben.
    • Secret-Version: Wählen Sie die Version des Clientschlüssels aus.

Für den Authentifizierungstyp Authorization code geben Sie nach dem Erstellen der Verbindung Folgendes an: muss zur Konfiguration der Authentifizierung einige zusätzliche Schritte ausführen. Weitere Informationen finden Sie unter Zusätzliche Schritte nach dem Erstellen der Verbindung.

Beispiele für Verbindungskonfiguration

In diesem Abschnitt finden Sie Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der Verbindung konfigurieren.

Art der Internetverbindung

Feldname Details
Region us-central1
Connector SharePoint
Connector-Version 1
Verbindungsname sharepoint-gcp-con
Dienstkonto ********@*******.gserviceaccount.com
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50 (Hinweis: abhängig von Ihren Tests)
Zieltyp Hostadresse
host 1 http://z8**.sharepoint.com
Authentifizierung AzureAD
Client-ID eda*****-****-****-****-*******2797
Bereiche Sites.FullControl.All
Clientschlüssel *************
Secret-Version 1
Autorisierungs-URL https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

PSC-Verbindungstyp

Feldname Details
Region us-central1
Connector SharePoint
Connector-Version 1
Verbindungsname sharepoint-stagging-psc
Dienstkonto ******@*******.gserviceaccount.com
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50 (Hinweis: abhängig von Ihren Tests)
Zieltyp Hostadresse
Host 1 http://10.***.0.**
Anschluss 1 ****
Authentifizierung Anmeldedaten für Windows
Nutzername *************
Passwort *************
Secret-Version 1

Verbindungstyp für Clientanmeldedaten

Feldname Details
Region europe-west1
Connector SharePoint
Connector-Version 1
Verbindungsname sharepoint-client-credentials
Dienstkonto ******@*******.gserviceaccount.com
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50 (Hinweis: abhängig von Ihren Tests)
Zieltyp Hostadresse
host 1 http://z8**.sharepoint.com
Port 1 ****
Authentifizierung OAuth 2.0-Clientanmeldedaten mit Clientschlüssel
Client-ID 83ca***********
Clientschlüssel *************
Secret-Version 1

Verbindungstyp für JWT-Inhaberzertifikat

Feldname Details
Region europe-west1
Connector SharePoint
Connector-Version 1
Verbindungsname sharepoint-jwt-certificate
Dienstkonto ******@*******.gserviceaccount.com
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50 (Hinweis: abhängig von Ihren Tests)
Zieltyp Hostadresse
host 1 http://z8**.sharepoint.com
Port 1 ****
Authentifizierung OAuth 2.0-Clientanmeldedaten mit JWT-Inhaber
OAuth-Client-ID e34d***********
Privater Schlüssel *************
Secret-Version 1
Passwort für den privaten Schlüssel *************
Secret-Version 1
Azure-Mandanten 9b25************

Zusätzliche Schritte nach dem Erstellen der Verbindung

Wenn Sie OAuth 2.0 - Authorization code für die Authentifizierung ausgewählt haben, müssen Sie nach dem Erstellen der Verbindung die folgenden zusätzlichen Schritte ausführen:

  1. Suchen Sie auf der Seite Verbindungen nach der neu erstellten Verbindung.

    Der Status des neuen Connectors lautet Autorisierung erforderlich.

  2. Klicken Sie auf Autorisierung erforderlich.

    Daraufhin wird der Bereich Autorisierung bearbeiten angezeigt.

  3. Kopieren Sie den Wert Weiterleitungs-URI in Ihre externe Anwendung.
  4. Überprüfen Sie die Autorisierungsdetails.
  5. Klicken Sie auf Autorisieren.

    Ist die Autorisierung erfolgreich, wird der Verbindungsstatus im Seite „Verbindungen“.

Weiterleitungs-URL hinzufügen

Wenn Sie den Azure AD-Authentifizierungstyp verwenden, fügen Sie die Weiterleitungs-URL über das Azure-Portal hinzu.
  1. Klicken Sie im Azure-Portal unter „Azure services“ auf „Anwendungsregistrierungen“.
  2. Klicken Sie auf den Namen Ihrer App.
  3. Klicken Sie auf „Weiterleitungs-URI hinzufügen“.
  4. Klicken Sie auf Plattform hinzufügen.
  5. Fügen Sie im Dialogfeld Web den Weiterleitungs-URI ein, den Sie beim Autorisieren der Verbindung in Google Cloud kopiert haben.

Erneute Autorisierung für Autorisierungscode

Wenn Sie den Authentifizierungstyp Authorization code verwenden und Änderungen an der Konfiguration in Ihrer SharePoint-Anwendung vorgenommen haben, Sie müssen Ihre SharePoint-Verbindung noch einmal autorisieren. So autorisieren Sie eine Verbindung noch einmal:

  1. Klicken Sie auf der Seite Verbindungen auf die erforderliche Verbindung.

    Die Seite mit den Verbindungsdetails wird geöffnet.

  2. Klicken Sie auf Bearbeiten, um die Verbindungsdetails zu bearbeiten.
  3. Überprüfen Sie die Angaben unter OAuth 2.0 – Autorisierungscode im Abschnitt Authentifizierung.

    Nehmen Sie gegebenenfalls die erforderlichen Änderungen vor.

  4. Klicken Sie auf Speichern. Die Seite mit den Verbindungsdetails wird geöffnet.
  5. Klicken Sie im Abschnitt Authentifizierung auf Autorisierung bearbeiten. Daraufhin wird der Bereich Authorize (Autorisieren) angezeigt.
  6. Klicken Sie auf Autorisieren.

    Wenn die Autorisierung erfolgreich war, wird der Verbindungsstatus auf der Seite Verbindungen auf Aktiv gesetzt.

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

  • Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

    Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

  • Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:

    Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Unterstützt ein Connector jedoch keine Entitätsvorgänge, Vorgänge sind nicht in der Operations-Liste aufgeführt.

  • Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und eine Ausgabe . Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Aktionen

In diesem Abschnitt sind einige der vom Connector unterstützten Aktionen aufgeführt. Um zu verstehen, wie die siehe Beispiele für Aktionen.

Aktion „DeleteAttachment“

Durch diese Aktion wird ein Anhang gelöscht.

Eingabeparameter der Aktion „DeleteAttachment“

Parametername Datentyp Erforderlich Beschreibung
ListTitle String Ja Titel des Listenelements.
ItemId String Ja ID des Listenelements.
FileName String Ja Name der Datei, die aus der Dokumentbibliothek gelöscht werden soll.

So konfigurieren Sie die Aktion DeleteAttachment: Siehe Aktionsbeispiele.

Aktion „CheckInDocument“

Mit dieser Aktion können Sie ein Dokument einchecken.

Eingabeparameter der CheckInDocument-Aktion

Parametername Datentyp Erforderlich Beschreibung
RelativeURL String Ja Relative URL des Ordners.
DocumentName String Ja Name der Datei, die eingecheckt werden soll.
Kommentar String Nein Eine optionale Check-in-Nachricht.

Informationen zum Konfigurieren der CheckInDocument-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CheckOutDocument“

Mit dieser Aktion können Sie eine Datei auschecken.

Eingabeparameter der Aktion „CheckOutDocument“

Parametername Datentyp Erforderlich Beschreibung
RelativeURL String Ja Relative URL des Ordners.
DocumentName String Ja Name der Datei, die auscheckt werden soll.

So konfigurieren Sie die Aktion CheckOutDocument: Siehe Aktionsbeispiele.

Aktion „VerwerfenCheckOutDocument“

Dadurch können Sie die Ausleihe einer Datei rückgängig machen.

Eingabeparameter der Aktion „VerwerfenCheckOutDocument“

Parametername Datentyp Erforderlich Beschreibung
RelativeURL String Ja Relative URL des Ordners.
DocumentName String Ja Name der Datei, für die die Ausleihe rückgängig gemacht werden soll.

So konfigurieren Sie die Aktion DiscardCheckOutDocument: Siehe Aktionsbeispiele.

CopyDocument-Aktion

So können Sie eine Datei von einem Speicherort an einen anderen kopieren.

Eingabeparameter der CopyDocument-Aktion

Parametername Datentyp Erforderlich Beschreibung
SourceFileRelativeUrl String Ja Relative URL der Quelldatei.
DestFileRelativeUrl String Ja Relative URL der Zieldatei.

Informationen zum Konfigurieren der CopyDocument-Aktion finden Sie unter Beispiele für Aktionen.

UploadDocument-Aktion

Mit dieser Aktion können Sie eine Datei hochladen.

Eingabeparameter der UploadDocument-Aktion

Parametername Datentyp Erforderlich Beschreibung
FileName String Ja Name der Datei, die hochgeladen werden soll.
RelativeUrl String Ja Relative URL des Ordners.
Inhalt String Nein Inhalte, die als Datei hochgeladen werden sollen.
ContentBytes String Nein Byte-Inhalt (als Base64-String), der als Datei hochgeladen werden soll. Hiermit können Sie Binärdaten hochladen.
HasBytes Boolesch Nein Gibt an, ob die hochzuladenden Inhalte binär sind. Der Standardwert ist false.

Informationen zum Konfigurieren der UploadDocument-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „DownloadDocument“

Durch diese Aktion können Sie eine Datei herunterladen.

Eingabeparameter der Aktion „DownloadDocument“

Parametername Datentyp Erforderlich Beschreibung
RemoteFile String Ja Vollständige URL der Datei, die heruntergeladen werden soll.
Bibliothek String Ja Name der Bibliothek auf dem SharePoint-Server.
HasBytes Boolesch Nein Gibt an, ob die Inhalte als Bytes heruntergeladen werden sollen. Der Standardwert ist false.

Informationen zum Konfigurieren der DownloadDocument-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „MoveAttachmentOrDocument“

Dadurch können Sie eine Datei von einem Ordner in einen anderen Ordner verschieben.

Eingabeparameter der Aktion „MoveAttachmentOrDocument“

Parametername Datentyp Erforderlich Beschreibung
SourceFileURL String Ja URL der Quelldatei, die verschoben werden soll
DestinationFolderURL String Ja URL des Zielordners.

So konfigurieren Sie die Aktion MoveAttachmentOrDocument: Siehe Aktionsbeispiele.

Aktion „CreateFolder“

Dadurch können Sie einen Ordner erstellen.

Eingabeparameter der CreateFolder-Aktion

Parametername Datentyp Erforderlich Beschreibung
RelativeURL String Ja Relative URL des Ordners.
FolderName String Ja Name des zu erstellenden Ordners.

Informationen zum Konfigurieren der CreateFolder-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „AddAttachments“

Mit dieser Aktion können Sie einen Anhang hinzufügen.

Eingabeparameter der AddAttachments-Aktion

Parametername Datentyp Erforderlich Beschreibung
ListTitle String Ja Name der Anhangsliste.
FileName String Ja Name der Anhangsdatei.
ItemId String Ja ID des hinzuzufügenden Anhangs.
Inhalt String Ja Inhalt des Anhangs.
ContentBytes String Nein Byte-Inhalt (als Base64-String), der als Anhang hochgeladen werden soll. Hiermit können Sie Binärdaten hochladen.
HasBytes Boolesch Nein Gibt an, ob die hochzuladenden Inhalte binär sind. Der Standardwert ist false.

Informationen zum Konfigurieren der AddAttachments-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „DownloadAttachments“

Durch diese Aktion können Sie Anhänge herunterladen.

Eingabeparameter der Aktion „DownloadAttachments“

Parametername Datentyp Erforderlich Beschreibung
RemoteFile String Ja Relative URL der Datei.
HasBytes Boolesch Nein Gibt an, ob die heruntergeladenen Inhalte binär sind. Der Standardwert ist false.

Informationen zum Konfigurieren der DownloadAttachments-Aktion finden Sie unter Beispiele für Aktionen.

Aktionsbeispiele

In diesem Abschnitt wird beschrieben, wie Sie einige Aktionen in diesem Connector ausführen.

Beispiel – Anhang löschen

In diesem Beispiel wird die angegebene Datei gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DeleteAttachment aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "ListTitle": "My lists",
    "ItemId": "1",
    "FileName": "sitepages.txt"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von DeleteAttachment hat einen Wert ähnlich dem folgenden:

    [{
    "Status": "Success"
    }]

Beispiel: Dokument einchecken

In diesem Beispiel wird ein Dokument geprüft.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CheckInDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.txt",
    "Comment": "Comment test"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von CheckInDocument hat einen Wert ähnlich dem folgenden:

    [{
    "Status": "Success"
    }]

Beispiel – Eine Datei ansehen

In diesem Beispiel wird eine Datei auscheckt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CheckOutDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.txt"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe CheckOutDocument einen Wert, der in etwa so aussieht:

    [{
    "Status": "Success"
    }]

Beispiel – Bezahlvorgang verwerfen

In diesem Beispiel wird eine Dateiausleihe rückgängig gemacht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DiscardCheckOutDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.docx"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe DiscardCheckOutDocument einen Wert, der in etwa so aussieht:

    [{
    "Status": "Success"
    }]

Beispiel: Datei kopieren

In diesem Beispiel wird eine Datei von einem Speicherort an einen anderen kopiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CopyDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
    "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von CopyDocument hat einen Wert ähnlich dem folgenden:

    [{
    "Status": "Success"
    }]

Beispiel – Textdatei hochladen

In diesem Beispiel wird eine Textdatei an den angegebenen Speicherort hochgeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "FileName": "test.txt",
    "RelativeUrl": "/Shared Documents/TestFolder",
    "Content": "abcd"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe UploadDocument einen Wert, der in etwa so aussieht:

    [{
    "Status": "Success"
    }]

Beispiel: Binärdatei hochladen

In diesem Beispiel wird eine Binärdatei an den angegebenen Speicherort hochgeladen. Beim Hochladen einer Binärdatei -Datei, geben Sie den hochzuladenden Inhalt als Base64-codierten String an.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "FileName": "test.txt",
    "RelativeUrl": "/Shared Documents/TestFolder",
    "ContentBytes": "SGVsbG8gd29ybGQK",
    "HasBytes": "true"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe UploadDocument einen Wert, der in etwa so aussieht:

    [{
    "Status": "Success"
    }]

Beispiel – Datei herunterladen

In diesem Beispiel wird eine Datei heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RemoteFile": "/TestFolder/test.txt",
    "Library": "Shared Documents"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von DownloadDocument hat einen Wert ähnlich dem folgenden:

    [{
    "Success": "True",
    "Content": "Test File",
    }]

Beispiel: Binärdatei herunterladen

In diesem Beispiel wird eine Binärdatei heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RemoteFile": "/TestFolder/test1.png",
    "Library": "Shared Documents"
    "HasBytes": "true"  
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von DownloadDocument hat einen Wert ähnlich dem folgenden:

    [{
    "Success": "True",
    "ContentBytes": "VGVzdCBGaWxl",
    }]

Beispiel: Anhang verschieben

In diesem Beispiel wird ein Anhang von einem Speicherort an einen anderen verschoben.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion MoveAttachmentOrDocument aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "SourceFileURL": "/Shared Documents/test.txt",
    "DestinationFolderURL": "/Shared Documents/TestFolder"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von MoveAttachmentOrDocument hat einen Wert ähnlich dem folgenden:

    [{
    "Result": "Success"
    }]

Beispiel: Ordner erstellen

In diesem Beispiel wird ein Ordner am angegebenen Speicherort erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CreateFolder aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "FolderName": "TestFolder123"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von CreateFolder hat einen Wert ähnlich dem folgenden:

    [{
    "Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
    "Status": "Success"
    }]

Beispiel: Anhang hinzufügen

In diesem Beispiel wird der angegebenen Liste ein Anhang hinzugefügt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion AddAttachments aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "ListTitle": "My Lists",
    "FileName": "TestAttachment2",
    "Content": "abcd text",
    "ItemId": "1"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe AddAttachments einen Wert, der in etwa so aussieht:

    [{
    "RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
    "Status": "Success"
    }]

Beispiel: Binären Anhang hinzufügen

In diesem Beispiel wird der angegebenen Liste ein binärer Anhang hinzugefügt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion AddAttachments aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "ListTitle": "My Lists",
    "FileName": "TestAttachment3",
    "ContentBytes": "VGVzdCBGaWxl",
    "HasBytes": "true",  
    "ItemId": "1"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von AddAttachments hat einen Wert ähnlich dem folgenden:

    [{
    "RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
    "Status": "Success"
    }]

Beispiel – Anhang herunterladen

In diesem Beispiel wird ein Anhang heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadAttachments aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RemoteFile": "/Shared Documents/Document.txt"
    }
  4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von DownloadAttachments hat einen Wert ähnlich dem folgenden:

    [{
    "Success": "True",
    "Content": "Test File",
    }]

Beispiel – Binäranhang herunterladen

In diesem Beispiel wird ein binärer Anhang heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadAttachments aus und klicken Sie auf Fertig.
  3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "RemoteFile": "/Shared Documents/Document.docx",
    "HasBytes": "true"
    }
  4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe DownloadAttachments einen Wert, der in etwa so aussieht:

    [{
    "Success": "True",
    "ContentBytes": "VGVzdCBGaWxl",
    }]

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird gezeigt, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel – Alle Dateien auflisten

In diesem Beispiel werden alle Dateien in der Entität Files aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Files aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
  4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors einen Filter angeben, um den Ergebnissatz einzugrenzen. Mithilfe der Logikoperatoren können Sie auch mehrere Filterbedingungen angeben.

Beispiel – Liste abrufen

In diesem Beispiel wird eine Liste mit der angegebenen ID aus der Entität My Lists abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle My Lists aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 3 in das Feld Standardwert ein.

    Hier ist 3 ein Primärschlüssel/Wert in der Entität My Lists.

Beispiel – Datensatz erstellen

In diesem Beispiel wird ein Datensatz in der Entität My Lists erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option My Lists aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:
    {
    "AuthorId": 11.0, 
    "BaseName": "3_",
    "Attachments": false,
    "Title": "Created List New"
    }

    Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der in etwa so aussieht:

    [{
    "ID": 3.0
    }]

Beispiel – Datensatz löschen

In diesem Beispiel wird der Datensatz mit der angegebenen ID in der Entität My Lists gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle My Lists aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und Geben Sie dann 2 in das Feld Default Value (Standardwert) ein.

SharePoint-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Tasks für Connectors.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte