Zum Inhalt springen

Details zur Microsoft SharePoint Server Verbindung

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8690 des Connectors.

Erste Schritte

Versionsunterstützung für Microsoft SharePoint

Der Connector unterstützt alle Versionen von Microsoft SharePoint, die die SOAP API unterstützen. Dazu gehören: Windows SharePoint Services 3.0, SharePoint Server 2007+ (2010, 2013 usw.) und SharePoint Online. Der Connector modelliert die benutzerdefinierten Listen Ihrer SharePoint-Site als bidirektionale Tabellen. Wenn Sie eine Verbindung herstellen, ruft der Connector die Metadaten für diese Tabellen ab, indem er SharePoint-Webdienste aufruft. Unterstützte Authentifizierungsschemata sind NTLM, Basic, Digest, Forms, Kerberos, SSO, STS (Security Token Services) und SharePoint-Authentifizierungscookies.

Herstellen einer Verbindung

Herstellen einer Verbindung mit Microsoft SharePoint

Unabhängig davon, ob Sie eine Online- oder Vor-Ort-Verbindung herstellen, welche Architektur verwendet wird und auf welche Listen und Dokumente zugegriffen wird, erfordert die Verbindung mit Microsoft SharePoint genau zwei Dinge:

  • Festlegen der URL Verbindungseigenschaft.
  • Legen Sie die entsprechenden Authentifizierungseigenschaften für Ihre Umfeld fest.

Einstellung URL:

Microsoft SharePoint funktioniert mit allen Listen und Dokumenten auf der globalen Microsoft SharePoint-Site oder mit allen Listen und Dokumenten auf einzelnen Sites.

Um mit allen Listen und Dokumenten auf der globalen Microsoft Sharepoint-Site zu arbeiten, setzen Sie die URL Verbindungseigenschaft zu Ihrer Site Collection-URL. Beispiel:

https://teams.contoso.com

Um mit allen Listen und Dokumenten auf einer einzelnen Site zu arbeiten, setzen Sie URL Verbindungseigenschaft zu Ihrer individuellen Site-URL. Beispiel:

https://teams.contoso.com/TeamA

In den folgenden Abschnitten wird beschrieben, wie Sie die entsprechenden Authentifizierungseigenschaften für Ihre Umfeld festlegen. Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung (erforderlich für die Verwendung mit Microsoft Entra ID in einer Webanwendung; optional für den Zugriff auf Microsoft Entra ID über eine Desktopanwendung oder einen Headless-Server) finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Microsoft SharePoint Online

Satz SharePointEdition auf „SharePoint Online“ und setzen Sie die User Und Password auf die Anmeldeinformationen, die Sie für die Anmeldung bei SharePoint verwenden, beispielsweise die Anmeldeinformationen für Ihr Microsoft Online Services-Konto.

Microsoft SharePoint Online unterstützt eine Reihe von Cloud-basierten Architekturen, von denen jede einen anderen Satz von Authentifizierungsschemata unterstützt:

  • Microsoft Entra ID
  • Single Sign-On (SSO) über den SSO-Identitätsanbieter ADFS, Okta, OneLogin oder PingFederate
  • Verwaltete Identitäten für Azure-Ressourcen
  • Azure-Passwort
  • OAuthJWT
  • SharePointOAuth

Wenn sich die Domäne des Benutzerkontos von der beim Identitätsanbieter konfigurierten Domäne unterscheidet, legen Sie fest SSODomain für Letzteres. Diese Eigenschaft kann für jedes SSO erforderlich sein.

Microsoft Entra ID

Microsoft Entra ID ist ein Verbindungstyp, der OAuth zur Authentifizierung nutzt. OAuth erfordert, dass der authentifizierende Benutzer über einen Internetbrowser mit Microsoft SharePoint interagiert. Der Treiber erleichtert dies auf verschiedene Weise, wie unten beschrieben. Setzen Sie Ihr AuthScheme auf AzureAD. Die unten beschriebenen Microsoft Entra ID Abläufe setzen voraus, dass Sie dies getan haben.

Ihre Organisation benötigt möglicherweise die Zustimmung des Administrators, wenn sie eine neue App-Registrierung für Ihren Azure-Mandanten autorisiert. In allen Microsoft Entra ID Flows erfordert jede Erstinstallation und Verwendung einer App-Registrierung, dass ein Administrator die Anwendung für seinen Azure-Mandanten genehmigt. Weitere Informationen finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Desktop-Anwendungen

Es wird eine eingebettete OAuth-Anwendung bereitgestellt, die die OAuth-Desktop-Authentifizierung vereinfacht. Alternativ können Sie eine benutzerdefinierte App-Registrierung erstellen. Siehe Erstellen einer benutzerdefinierten OAuth-Anwendung für Informationen zum Erstellen benutzerdefinierter Anwendungen und Gründe dafür.

Der einzige Unterschied zwischen den beiden Methoden zur Authentifizierung besteht darin, dass Sie bei Verwendung benutzerdefinierter App-Registrierungen zwei zusätzliche Verbindungseigenschaften festlegen müssen.

Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:

  • InitiateOAuth: GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeiden OAuthAccessToken.
  • CallbackURL: Die Weiterleitungs URL in Ihren Anwendungseinstellungen.
  • Custom applications only:
    • OAuthClientId: Die Client-ID in Ihren Anwendungseinstellungen.
    • OAuthClientSecret: Das Client-Geheimnis in Ihren Anwendungseinstellungen.

Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen. Der Connector schließt dann den OAuth-Prozess ab:

  1. Extrahiert das Zugriffstoken aus der Rückruf URL und authentifiziert Anfragen.
  2. Erhält einen neuen Zugriffstoken, wenn der alte abläuft.
  3. Speichert OAuth-Werte in OAuthSettingsLocation. Diese gespeicherten Werte bleiben über Verbindungen hinweg bestehen.
Single Sign-On-Identitätsanbieter

ADFS

Setzen Sie die AuthScheme Zu ADFS. Sie müssen die folgenden Verbindungseigenschaften festlegen:

  • User: Der ADFS-Benutzer.
  • Password: Das ADFS-Passwort des Benutzers.
  • SSODomain (optional): Die mit dem ADFS-Identitätsanbieter konfigurierte Domäne.

Beispiel-Verbindungszeichenfolge:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';

Okta

Setzen Sie den AuthScheme Zu Okta. Die folgenden Verbindungseigenschaften werden zum Herstellen einer Verbindung mit Okta verwendet:

  • User: Der Okta Benutzer.
  • Password: Das Okta-Passwort des Benutzers.
  • SSODomain (optional): Die mit dem OKTA-Identitätsanbieter konfigurierte Domäne.

Beispiel-Verbindungszeichenfolge:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';

OneLogin

Setzen Sie AuthScheme Zu OneLogin. Die folgenden Verbindungseigenschaften werden zum Herstellen einer Verbindung mit OneLogin verwendet:

  • User: Der OneLogin-Benutzer.
  • Password: Das OneLogin-Passwort des Benutzers.
  • SSODomain (optional): Die mit dem OneLogin-Identitätsanbieter konfigurierte Domäne.

Beispiel-Verbindungszeichenfolge:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';

PingFederate

Setzen Sie AuthScheme Zu PingFederate. Die folgenden Verbindungseigenschaften werden zum Herstellen einer Verbindung mit PingFederate verwendet:

  • User: Der PingFederate-Benutzer.
  • Password: PingFederate-Passwort für den Benutzer.
  • SSODomain (optional): Die mit dem Identitätsanbieter PingFederate konfigurierte Domäne.

Beispiel-Verbindungszeichenfolge:

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
Verwaltete Identitäten für Azure-Ressourcen

Wenn Sie Microsoft SharePoint auf einer Azure-VM ausführen, können Sie die MSI-Anmeldeinformationen (Azure Managed Service Identity) für die Verbindung nutzen:

  • AuthScheme: AzureMSI.

Die MSI-Anmeldeinformationen werden zur Authentifizierung automatisch abgerufen.

Azure Kennwort

Um eine direkte Verbindung mithilfe Ihrer Azure-Dredentials herzustellen, geben Sie die folgenden Verbindungseigenschaften an:

  • AuthScheme: AzurePassword
  • User: Das Benutzerkonto, das für die Verbindung mit Azure verwendet wird
  • Password: Das für die Verbindung mit Azure verwendete Kennwort
  • AzureTenant: Directory (tenant) ID, zu finden auf der Übersichtsseite der OAuth-Anwendung, die zur Authentifizierung bei Microsoft SharePoint auf Azure verwendet wird.
OAuthJWT-Zertifikat

Setzen Sie die AuthScheme Zu OAUTHJWT. Die folgenden Verbindungseigenschaften werden zum Herstellen einer Verbindung mit Microsoft SharePoint verwendet:

  • OAuthGrantType: CLIENT.
  • AzureTenant: Der Mandant, mit dem Sie sich verbinden möchten.
  • OAuthJWTCert: Der JWT-Zertifikatspeicher.
  • OAuthJWTIssuer: Die OAuth-Client-ID.
SharePointOAuth

Setzen Sie die AuthScheme Zu SharePointOAuth. Die folgenden Verbindungseigenschaften werden zum Herstellen einer Verbindung mit SharePointOAuth verwendet:

  • Schema: REST.
  • InitiateOAuth: GETANDREFRESH.
  • OAuthClientId: Die Identität/Client-ID der Anwendung.
  • OAuthClientSecret: Das Client-Geheimnis der Anwendung.

Beispiel-Verbindungszeichenfolge:

SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;

Dieses AuthScheme funktioniert mit der benutzerdefinierten OAuth-Anwendung. Informationen zum Generieren von Anmeldeinformationen aus einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Microsoft SharePoint vor Ort

Microsoft SharePoint On-Premises unterstützt eine Reihe von lokalen Architekturen:

Windows (NTLM) Kerberos - ADFS - Anonymer Zugriff

Satz SharePointEdition zu „SharePoint On-Premises“, um die folgenden Authentifizierungstypen zu verwenden.

Windows (NTLM)

Dies ist der am häufigsten verwendete Authentifizierungstyp. Daher ist der Connector so vorkonfiguriert, dass er NTLM als Standard verwendet. Stellen Sie einfach die Windows User Und Password zum Verbinden.

Kerberos

Setzen Sie die AuthScheme Zu NEGOTIATE, und legen Sie dann die folgenden Kerberos-Verbindungseigenschaften fest:

  • KerberosKDC: Der Host oder die IP-Adresse Ihrer Kerberos-KDC-Maschine.
  • KerberosRealm: Der Bereich des Microsoft SharePoint Kerberos-Prinzipals. Dies ist der Wert nach dem '@'-Symbol (z. B. EXAMPLE.COM) des Prinzipalwerts (z. B. MyService/MyHost@EXAMPLE.COM).
  • KerberosSPN: Der Dienst und Host des Microsoft SharePoint Kerberos-Prinzipals. Dies ist der Wert vor dem Symbol „@“ (z. B. MyService/MyHost) des Prinzipalwerts (z. B. MyService/MyHost@EXAMPLE.COM).

Einzelheiten zur Authentifizierung mit Kerberos finden Sie unter Verwenden von Kerberos.

ADFS

Setzen Sie die AuthScheme Zu ADFS, und legen Sie dann die folgenden Verbindungseigenschaften fest:

  • User: Der ADFS-Benutzer.
  • Password: ADFS-Passwort für den Benutzer.
  • SSOLoginURL: Der WS-Trust-Endpoint des ADFS-Servers.

Sie müssen außerdem das setzen SSOProperties zur Authentifizierung bei ADFS. Geben Sie den Wert des RelyingParty-Parameters an; er befindet sich auf dem ADFS-Server für Sharepoint. Beispiel-Verbindungszeichenfolge:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;SSOLoginURL='https://<authority>/adfs/services/trust/2005/usernamemixed';SSO Properties ='RelyingParty=urn:sharepoint:sp2016;';
Anonymer Zugriff

Setzen Sie die AuthScheme Zu NONE zusammen mit der URL.

Erstellen einer benutzerdefinierten OAuth-Anwendung

Erstellen einer benutzerdefinierten OAuth-Anwendung

bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die verwendet werden können, wenn Azure verwendet wird, um eine Verbindung über eine Desktopanwendung oder eine Headless-Maschine herzustellen. In allen Fällen erfordert die Verbindung mit Azure über eine Webanwendung jedoch die Erstellung einer benutzerdefinierten OAuth-Anwendung.

Möglicherweise möchten Sie auch eine benutzerdefinierte OAuth-Anwendung erstellen, um:

  • Kontrolle des Brandings des Authentifizierungsdialogs,
  • die Umleitungs-URI steuern, zu der die Anwendung den Benutzer nach der Authentifizierung umleitet, oder
  • Passen Sie die Berechtigungen an, die Sie vom Benutzer anfordern.

In den folgenden Abschnitten wird beschrieben, wie Sie mit dem Azure-Portal oder der Sharepoint-App eine benutzerdefinierte OAuth-Anwendung erstellen.

Azure Portal

Um OAuth-Werte für Ihre App zu erhalten, OAuthClientId Und OAuthClientSecret, und registrieren Sie eine benutzerdefinierte OAuth-Anwendung:

  1. Melden Sie sich beim Azure Portal an.

  2. Navigieren Sie im linken Navigationsbereich zu Microsoft Entra ID > App-Registrierungen.

  3. Klicken Sie auf Add.

  4. Geben Sie einen Anwendungsnamen ein.

  5. Wählen Sie Konten in einem beliebigen Organisationsverzeichnis (Jeder Microsoft Entra ID Mandant - Multitenant).

  6. Setzen Sie die Weiterleitungs URL auf http://localhost:33333 (Standardeinstellung des Anschlusses) oder legen Sie einen anderen Port Ihrer Wahl fest.

  7. Satz CallbackURL an die genaue Antwort-URL, die Sie definiert haben.

    Das Portal erstellt die neue Anwendung.

  8. Navigieren Sie zum Abschnitt „Zertifikate und Geheimnisse“.

  9. Erstellen Sie ein Client-Geheimnis für die Anwendung und wählen Sie eine Dauer aus.

  10. Nachdem Sie den Schlüssel gespeichert haben, wird der Schlüsselwert einmal angezeigt. Setzen Sie sofort OAuthClientSecret auf den angezeigten Wert. Setze OAuthClientId zur Anwendungs-ID.

  11. Wählen Sie API Permissions.

  12. Klicken Sie auf Add. Wenn Ihre Anwendung nur innerhalb eines Benutzerkontexts eine Verbindung herstellt, geben Sie delegierte Berechtigungen an.

  13. Klicken Sie im Abschnitt API Berechtigungen auf Add a permission und wählen Sie SharePoint. Wählen Sie die Berechtigungen aus, die Ihre App haben soll. Um Listen anzuzeigen und zu bearbeiten, müssen Sie (mindestens) die auswählen AllSites.Manage Erlaubnis.

  14. Speichern Sie Ihre Änderungen.

Notiz

Wenn Sie Berechtigungen ausgewählt haben, die eine Administratorzustimmung erfordern, können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen. Andernfalls lesen Sie weiter unten „OAuth: Administratorzustimmung“.

Administratorzustimmung bezieht sich darauf, wenn der Administrator für einen Microsoft Entra ID Mandanten Berechtigungen für eine Anwendung erteilt, für die die Zustimmung eines Administrators in Ihrer Organisation zum Anwendungsfall erforderlich ist.

Die eingebettete Anwendung im Jitterbit Connector für Microsoft SharePoint enthält keine Berechtigungen, die die Zustimmung des Administrators erfordern. Daher gelten diese Informationen nur für benutzerdefinierte Anwendungen.

Wenn Sie im Azure-Portal eine neue OAuth-Anwendung erstellen, müssen Sie angeben, welche Berechtigungen die Anwendung benötigt. Einige Berechtigungen können mit „Administratorzustimmung erforderlich“ gekennzeichnet sein. Beispielsweise erfordern alle Gruppenberechtigungen die Administratorzustimmung. Wenn Ihre Anwendung die Administratorzustimmung erfordert, können Sie dies auf zwei Arten tun.

Die einfachste Möglichkeit, die Administratorzustimmung zu erteilen, besteht darin, dass sich ein Administrator beim Azure Portal anmeldet und navigieren Sie zu der Anwendung, die Sie in App-Registrierungen erstellt haben. Klicken Sie unter API -Berechtigungen auf Grant Consent, das Berechtigungen für den Mandanten erteilt, unter dem es erstellt wurde.

Wenn Ihre Organisation mehrere Mandanten hat oder Sie Anwendungsberechtigungen für andere Mandanten außerhalb Ihrer Organisation erteilen müssen, verwenden Sie GetAdminConsentURL gespeicherte Prozedur*, um die Administratorautorisierungs URL zu generieren. Nachdem die OAuth-Anwendung erfolgreich autorisiert wurde, gibt sie einen Booleschen Wert zurück, der angibt, dass Berechtigungen erteilt wurden.

Nachdem der Administrator die OAuth-Anwendung genehmigt hat, können Sie mit der Authentifizierung fortfahren.

Sharepoint App

Um eine benutzerdefinierte OAuth-App zu erstellen und die Verbindungseigenschaften für die OAuth-Authentifizierung mithilfe der Sharepoint-App abzurufen, müssen Sie zuerst das Add-In registrieren und diesem Add-In dann Berechtigungen erteilen.

Registrieren des Add-Ins
  1. Navigieren Sie zur Seite „Add-In registrieren“, indem Sie die URL folgendermaßen eingeben: https://{sitename}.SharePoint.com/_layouts/15/appregnew.aspx.
  2. Klicken Sie im Abschnitt „App-Informationen“ auf Generate, das sich neben den Textfeldern „Client-ID“ und „Client-Geheimnis“ befindet, um die entsprechenden Werte zu generieren.
  3. Legen Sie Titel, App-Domäne und Umleitungs-URI fest, indem Sie die entsprechenden Textfelder ausfüllen.
  4. Klicken Sie auf Create.

Das Add-In wird registriert und die Sharepoint-App zeigt die erstellten Informationen an.

Erteilen von Berechtigungen für das Add-In
  1. Navigieren Sie zur SharePoint-Site.

  2. Geben Sie die URL ein: https://{sitename}-admin.sharepoint.com/_layouts/15/appinv.aspx im Browser. Dadurch werden Sie auf die Seite „Berechtigung erteilen“ weitergeleitet.

  3. Bei App Id, geben Sie die zuvor generierte Client-ID ein und klicken Sie auf Lookup.

    Dadurch werden die Werte in die anderen Textfelder (Titel, App-Domäne und Umleitungs-URL) eingetragen.

  4. Geben Sie die folgende Berechtigungsanfrage im XML-Format ein:

        <AppPermissionRequests AllowAppOnlyPolicy="true">
         <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
    </AppPermissionRequests>
    
  5. Klicken Sie auf Create. Die Sharepoint-App zeigt einen Berechtigungsbestätigungsdialog an. Um die Berechtigungen zu erteilen, klicken Sie auf Trust It.

Mit REST- API verbinden

Microsoft SharePoint REST API wird sowohl auf Sharepoint OnPremise als auch auf Sharepoint Online unterstützt. Um eine Verbindung über die REST API herzustellen, setzen Sie Schema zum RUHEN.

Die Immobilie SharePointEdition kann verwendet werden, um die Edition von Sharepoint zu definieren.

Sharepoint Online

SharePoint Online verwendet den OAuth-Standard zur Authentifizierung. Befolgen Sie die Schritte unter „Authentifizierung bei SharePoint Online“ in Herstellen einer Verbindung für weitere Informationen.

SharePoint OnPremise

Folgen Sie den Schritten unter „Authentifizierung bei SharePoint vor Ort“ in Herstellen einer Verbindung für weitere Informationen.

Kerberos verwenden

Kerberos

Für die Authentifizierung bei Microsoft SharePoint über Kerberos müssen Sie Authentifizierungseigenschaften definieren und auswählen, wie Kerberos Authentifizierungstickets abrufen soll.

Festlegen der Authentifizierungseigenschaften

Um sich mit Kerberos bei Microsoft SharePoint zu authentifizieren, legen Sie diese Eigenschaften fest:

  • hive.server2.authentication: Kerberos.
  • AuthScheme: NEGOTIATE.
  • KerberosKDC: Der Host oder die IP-Adresse Ihrer Kerberos-KDC-Maschine.
  • KerberosRealm: Der Bereich des Microsoft SharePoint Kerberos-Prinzipals. Suchen Sie diesen Wert direkt nach dem '@'-Symbol des Prinzipalwerts.
  • KerberosSPN: Der Dienst und Host des Microsoft SharePoint Kerberos-Prinzipals. Suchen Sie diesen Wert direkt vor dem Symbol „@“ des Prinzipalwerts.
Abrufen von Kerberos-Tickets

Kerberos-Tickets werden verwendet, um die Identität des Anforderers zu authentifizieren. Durch die Verwendung von Tickets anstelle von formellen Logins/Passwörtern entfällt die Notwendigkeit, Passwörter lokal zu speichern oder über ein Netzwerk zu senden. Benutzer werden erneut authentifiziert (Tickets werden aktualisiert), wenn sie sich an ihrem lokalen Computer anmelden oder kinit USER in der Eingabeaufforderung.

Der Connector bietet drei Möglichkeiten, das erforderliche Kerberos-Ticket abzurufen, je nachdem, ob das KRB5CCNAME und/oder KerberosKeytabFile Variablen sind in Ihrer Umfeld vorhanden.

MIT Kerberos-Anmeldeinformations-Cache-Datei

Mit dieser Option können Sie den MIT Kerberos Ticket Manager verwenden oder kinit Befehl zum Abrufen von Tickets. Mit dieser Option ist es nicht erforderlich, den User oder Password Verbindungseigenschaften.

Diese Option erfordert, dass KRB5CCNAME wurde in Ihrem System erstellt.

So aktivieren Sie den Ticketabruf über MIT Cerberos Credential Cache Files:

  1. Stellen Sie sicher, dass KRB5CCNAME Variable ist in Ihrer Umfeld vorhanden.
  2. Satz KRB5CCNAME zu einem Pfad, der auf Ihre Anmeldeinformations-Cachedatei verweist. (Beispiel: C:\krb_cache\krb5cc_0 oder /tmp/krb5cc_0.) Die Anmeldeinformations-Cachedatei wird erstellt, wenn Sie den MIT Kerberos Ticket Manager zum Generieren Ihres Tickets verwenden.
  3. So erhalten Sie ein Ticket:

    1. Öffnen Sie die Anwendung MIT Kerberos Ticket Manager.
    2. Klicken Sie auf Get Ticket.
    3. Geben Sie Ihren Hauptnamen und Ihr Passwort ein.
    4. Klicken Sie auf OK.

    Wenn das Ticket erfolgreich abgerufen wurde, werden die Ticketinformationen im Kerberos Ticket Manager angezeigt und in der Anmeldeinformations-Cachedatei gespeichert.

Der Connector verwendet die Cachedatei, um das Kerberos-Ticket für die Verbindung mit Microsoft SharePoint abzurufen.

Hinweis

Wenn Sie nichts bearbeiten möchten KRB5CCNAME, Sie können verwenden KerberosTicketCache-Eigenschaft, um den Dateipfad manuell festzulegen. Nachdem dies festgelegt wurde, verwendet der Connector die angegebene Cache-Datei, um das Kerberos-Ticket für die Verbindung mit Microsoft SharePoint abzurufen.

Keytab-Datei

Wenn in Ihrer Umfeld die KRB5CCNAME Umfeld, Sie können ein Kerberos-Ticket mithilfe einer Keytab-Datei abrufen.

Um diese Methode zu verwenden, setzen Sie die User Eigenschaft auf den gewünschten Benutzernamen und legen Sie die KerberosKeytabFile-Eigenschaft auf einen Dateipfad, der auf die mit dem Benutzer verknüpfte Keytab-Datei verweist.

Benutzer und Passwort

Wenn in Ihrer Umfeld die KRB5CCNAME Umfeld und die KerberosKeytabFile-Eigenschaft nicht festgelegt wurde, können Sie ein Ticket mithilfe einer Benutzer- und Passwortkombination abrufen.

Um diese Methode zu verwenden, legen Sie die-Eigenschaft fest User Und Password Eigenschaften für die Benutzer-/Passwortkombination, die Sie zur Authentifizierung bei Microsoft SharePoint verwenden.

Cross-Realm-Authentifizierung aktivieren

Komplexere Kerberos-Umgebungen können eine Cross-Realm-Authentifizierung erfordern, wenn mehrere Realms und KDC-Server verwendet werden. Beispielsweise können sie einen Realm/KDC für die Benutzerauthentifizierung und einen anderen Realm/KDC zum Abrufen des Servicetickets verwenden.

Um diese Art der Cross-Realm-Authentifizierung zu aktivieren, setzen Sie das KerberosRealm Und KerberosKDC Eigenschaften auf die Werte, die für die Benutzerauthentifizierung erforderlich sind. Setzen Sie außerdem die KerberosServiceRealm Und KerberosServiceKDC Eigenschaften auf die Werte, die zum Erhalt des Servicetickets erforderlich sind.

Optimieren des Datenzugriffs

Feinabstimmung der Microsoft SharePoint-Verbindung

Um den Datenzugriff in erweiterten Integrationen zu vereinfachen, verwenden Sie die folgenden Verbindungseigenschaften, um Spaltennamenkennungen und andere Aspekte des Datenzugriffs zu steuern:

  • UseDisplayNames: Setzen Sie dies auf „true“, um Spaltennamen zurückzugeben, die mit den Feldnamen in der zugrunde liegenden API übereinstimmen
    . Standardmäßig verwendet der Connector Spaltennamen, die mit den in SharePoint definierten Feldnamen übereinstimmen.
  • UseSimpleNames: Setzen Sie dies auf „true“, um Ersetzungen für Sonderzeichen in Spaltennamen vorzunehmen, die SharePoint zulässt, viele Datenbanken jedoch normalerweise nicht.
  • ShowPredefinedColumns: Setzen Sie dies auf „false“, um Felder auszuschließen, die von Feldern in der Liste abgeleitet sind, z. B. „Author“ und „CreatedAt
    . Diese Einstellung schließt die vordefinierten Felder von der Rückgabe aus in SELECT * Anweisungen und Schema.
  • ShowHiddenColumns: Wenn wahr, werden in SharePoint als ausgeblendet markierte Spalten vom Connector angezeigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des Microsoft SharePoint-Connectors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert die Verarbeitung der SELECT-Anweisung so weit wie möglich auf Microsoft SharePoint und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Jitterbit Connector für Microsoft SharePoint können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

  • Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
  • DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definieren von Ansichten mit DDL-Anweisungen

Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.

Erstellen einer Ansicht

Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:

CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;

Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews Verbindungseigenschaft.

Ändern einer Ansicht

Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:

ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.

Löschen einer Ansicht

Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.

DROP LOCAL VIEW [MyViewName]

Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.

Schema für benutzerdefinierte Ansichten

Benutzerdefinierte Ansichten werden im angezeigt UserViews Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName Eigentum.

Arbeiten mit benutzerdefinierten Ansichten

Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers listet nur Kunden in Raleigh auf:

SELECT * FROM Customers WHERE City = 'Raleigh';

Ein Beispiel für eine Abfrage an den Treiber:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Daraus ergibt sich die effektive Abfrage an die Quelle:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.

SSL-Konfiguration

Anpassen der SSL-Konfiguration

Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.

Um ein anderes Zertifikat anzugeben, siehe SSLServerCert Eigenschaft für die verfügbaren Formate, um dies zu tun.

Client-SSL-Zertifikate

Der Microsoft SharePoint-Connector unterstützt auch das Festlegen von Client-Zertifikaten. Legen Sie Folgendes fest, um eine Verbindung mithilfe eines Client-Zertifikats herzustellen.

  • SSLClientCert: Der Name des Zertifikatspeichers für das Client-Zertifikat.
  • SSLClientCertType: Der Typ des Schlüsselspeichers, der das TLS/SSL-Clientzertifikat enthält.
  • SSLClientCertPassword: Das Passwort für das TLS/SSL-Client-Zertifikat.
  • SSLClientCertSubject: Der Betreff des TLS/SSL-Client-Zertifikats.

SOAP Datenmodell

Der Jitterbit Connector für Microsoft SharePoint modelliert Microsoft SharePoint-Entitäten in relationalen Tabellen, Ansichten und gespeicherten Prozeduren. Die Tabellendefinitionen werden dynamisch basierend auf Ihrer Microsoft SharePoint-Site abgerufen. Alle von Ihnen vorgenommenen Änderungen, z. B. das Hinzufügen eines benutzerdefinierten Felds oder das Ändern des Datentyps eines Felds, werden automatisch übernommen, wenn Sie eine Verbindung herstellen.

Anpassen des Datenmodells

Der Connector legt Standardwerte fest, um die maximale Anzahl von Integrationen zu ermöglichen. Die folgenden Verbindungseigenschaften ermöglichen jedoch eine größere Anpassungsgranularität, die bei erweiterten Integrationen nützlich ist:

  • CalculatedDataType: Der für berechnete Felder zu verwendende Datentyp.
  • CreateIDColumns: Gibt an, ob zusätzliche ID-Spalten für SharePoint-Spalten erstellt werden sollen, die Werte aus in anderen Listen gespeicherten Informationen verwenden.
  • FolderOption: Eine Option, um festzulegen, wie Ordner in Ergebnissen angezeigt werden. Geben Sie entweder „FilesOnly“, „FilesAndFolders“, „Recursive“ oder „RecursiveAll“ ein.
  • PseudoColumns: Gibt an, ob Pseudospalten als Spalten in den Tabellenmetadaten gemeldet werden sollen oder nicht.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Der Connector kann benutzerdefinierte Listen aus Microsoft SharePoint verfügbar machen, die in den Tabellen nicht erwähnt werden. Das Datenmodell zeigt ein Beispiel, wie Ihre SharePoint-Site aussehen könnte. Das eigentliche Datenmodell wird dynamisch basierend auf Ihren Benutzeranmeldeinformationen und Ihrer SharePoint-Site abgerufen.

Ansichten

Normalerweise werden Entitäten, die nicht geändert werden können, als Ansichten dargestellt oder schreibgeschützte Tabellen. Sie können auch auf benutzerdefinierte Ansichten einer Liste als relationale Ansichten zugreifen.

Um Daten aus einer benutzerdefinierten Ansicht einer Liste abzurufen, können Sie die Pseudospalte ViewID in der WHERE-Klausel festlegen.

SELECT * FROM ListName WHERE ViewID='ID of the view'

Die ID der Ansicht können Sie unter Ansichten abrufen Liste. Sie müssen die Pseudospalte „Liste“ angeben, um eine Liste der Ansichten für diese Liste zu erhalten. Beispiel:

SELECT * FROM Views WHERE List ='ListName'

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie bieten zusätzliche Funktionen der Microsoft SharePoint-API, beispielsweise das Suchen, Aktualisieren und Ändern von Informationen.

Tabellen

Der Connector modelliert die Daten in Microsoft SharePoint in eine Liste von Tabellen, die mit Standard-SQL-Anweisungen abgefragt werden können.

Im Allgemeinen ist das Abfragen von Microsoft SharePoint-Tabellen dasselbe wie das Abfragen einer Tabelle in einer relationalen Datenbank. Manchmal gibt es Sonderfälle, beispielsweise kann das Einfügen einer bestimmten Spalte in die WHERE-Klausel erforderlich sein, um Daten für bestimmte Spalten in der Tabelle abzurufen. Dies ist normalerweise in Situationen erforderlich, in denen für jede Zeile eine separate Anfrage gestellt werden muss, um bestimmte Spalten abzurufen. Diese Arten von Situationen sind oben auf der unten verlinkten Tabellenseite klar dokumentiert.

Jitterbit-Connector für Microsoft SharePoint-Tabellen

Name Beschreibung
Attachments Anhänge für das angegebene Element in der angegebenen Liste lesen oder löschen.
Groups Erstellen, aktualisieren, löschen und Abfrage Gruppen aus SharePoint.
Roles Rollen aus SharePoint erstellen, aktualisieren, löschen und Abfrage.
Users Benutzer aus SharePoint aktualisieren, löschen und Abfrage.
Views Erstellen, aktualisieren, löschen und Abfrage die verfügbaren Listen in SharePoint.

Anlagen

Anhänge für das angegebene Element in der angegebenen Liste lesen oder löschen.

Tabellenspezifische Informationen
Wählen

Liste und Artikel-ID sind erforderlich, um Anhänge zurückzugeben.

Einfügen

Rufen Sie die AddAttachments gespeicherte Prozedur*, um einem Listenelement neue Anhänge hinzuzufügen.

Spalten
Name Typ Nur Lesen Beschreibung
Url [KEY] String True Beschreibung des Begriffssatzes.
List String True Der interne Name der Liste, aus der Anhänge abgerufen werden sollen.
ListDisplayName String True Der Anzeigename der Liste, aus der Anhänge abgerufen werden sollen.
ItemID String True Die ID des Elements in der Liste, von dem Anhänge abgerufen werden sollen.
Name String True Der Name des Anhangs zum Element.

Gruppen

Erstellen, aktualisieren, löschen und Abfrage Gruppen aus SharePoint ab.

Tabellenspezifische Informationen
Einfügen

Die Spalten Name, DefaultLogin und OwnerLogin müssen in diese Tabelle eingefügt werden.

Um die Pseudospalte UserName zu verwenden, müssen Sie den Wert auf den LoginName des Benutzers setzen. Sie können den LoginNamen abrufen, indem Sie die Tabelle Users abfragen.

Spalten
Name Typ Nur Lesen Beschreibung
Name# [KEY] String Falsch Der Name der Gruppe.
Description# String Falsch Eine Beschreibung der Gruppe.
OwnerLogin# String Falsch Der Benutzername des Gruppenbesitzers. Dieser Wert sollte das Format DOMAIN\Benutzername haben.
OwnerType# String Falsch Der Typ des Besitzers. Benutzer oder Gruppe.
DefaultLogin# String Falsch Der Benutzername des Standardbenutzers für die Gruppe. Dieser Wert sollte das Format DOMAIN\Benutzername haben.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
UserName String Der logische Name des Benutzers, für den Gruppen zurückgegeben werden sollen. Geben Sie diesen Wert in der SELECT-Anweisung an, um nur Gruppen zurückzugeben, in denen sich der angegebene Benutzer befindet.

Rollen

Erstellen, aktualisieren, löschen und Abfrage Rollen aus SharePoint ab.

Tabellenspezifische Informationen
Wählen

Um die Pseudospalte „UserName“ zu verwenden, müssen Sie den Wert auf den LoginName des Benutzers setzen. Sie können den LoginNamen abrufen, indem Sie die Tabelle „Benutzer“ abfragen.

Einfügen

Um eine Rolle einzufügen, ist mindestens der Name erforderlich:

INSERT INTO Roles (Name) VALUES ('My Role')
Spalten
Name Typ Nur Lesen Beschreibung
Name# [KEY] String Falsch Der Name der Rolle.
Description# String Falsch Eine Beschreibung der Rolle.
Permissions# Long False Eine Long-Zahl, die die Berechtigungen für die Rolle darstellt.
RoleType String True Der Rolle.
IsHidden Boolean True Ein Boolescher Wert, der angibt, ob die Rolle ausgeblendet ist.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
UserName String Der Anmeldename des Benutzers, für den Rollen zurückgegeben werden sollen. Geben Sie diesen Wert in einer SELECT-Anweisung an, um nur Rollen zurückzugeben, die dem angegebenen Benutzer zugewiesen sind.
GroupName String Der Name der Gruppe, für die Rollen zurückgegeben werden sollen. Geben Sie diesen Wert in einer SELECT-Anweisung an, um nur Rollen zurückzugeben, die der angegebenen Gruppe zugewiesen sind.

Benutzer

Aktualisieren, löschen und Abfrage Benutzer aus SharePoint.

Tabellenspezifische Informationen
Wählen

Alle für das SharePoint-Konto erstellten Benutzer abrufen:

SELECT * FROM Users

Sie können Benutzer abrufen, die zu einer bestimmten Gruppe gehören. Geben Sie in diesem Fall den Gruppennamen an.

SELECT * FROM Users WHERE`[Gruppe] `= "GroupName"

Oder Sie können Benutzer abrufen, die eine bestimmte Rolle haben. Geben Sie in diesem Fall den Rollennamen an

SELECT * FROM Users WHERE`[Rolle] `= "RoleName"
Spalten
Name Typ Nur Lesen Beschreibung
ID String True Die ID des Benutzers.
LoginName# [KEY] String False Der Anmeldename des Benutzers.
Name# String Falsch Der Name des Benutzers.
Email# String False Die Email Adresse des Benutzers.
IsInDomainGroup Boolean True Ein Boolescher Wert, der angibt, ob der Benutzer in der Domänengruppe ist.
IsSiteAdmin Boolean True Ein Boolescher Wert, der angibt, ob der Benutzer ein Site-Administrator ist.
Notes# String False Optionale Anmerkungen zum Benutzer.
SecurityId String True Die Sicherheits-ID (SID) für den Benutzer.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
Group String Die Gruppe, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.
Role String Die Rolle, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.

Ansichten

Erstellen, aktualisieren, löschen und Abfrage die verfügbaren Listen in SharePoint ab.

Tabellenspezifische Informationen

Ansichten ist eine spezielle Tabelle. Sie kann verwendet werden, um Ansichten aus einer angegebenen Liste abzurufen, zu aktualisieren, einzufügen und zu löschen.

Wählen

Um Ergebnisse aus Ansichten zurückzugeben, muss entweder die ID oder die Liste in der SELECT-Anweisung angegeben werden. Beispiel:

SELECT * FROM Views WHERE List = 'MyListName'
Einfügen

Die Spalten „Liste“, „Name“, „Typ“ und „Felder“ müssen in diese Tabelle eingefügt werden.

Spalten
Name Typ Nur Lesen Beschreibung
ID [KEY] String True Die ID der Ansicht.
List String True Die Liste, mit der die Ansicht verknüpft ist. Wenn bei SELECT-Anweisungen keine ID angegeben ist, muss eine Liste angegeben werden.
ViewID String True Die ID der Ansicht. Darf nur für die jeweilige Liste eindeutig sein.
Name String Falsch Der Name der Ansicht.
Type String Falsch Der Ansichtstyp. Dieser muss bei Einfügungen und Aktualisierungen einen Wert haben. Die zulässigen Werte sind CALENDAR, GRID, HTML. Der Standardwert ist HTML.
Fields String Falsch Eine durch Kommas getrennte Liste der mit der Ansicht verknüpften Felder. Leerzeichen werden dabei beachtet.
IsDefault Boolean Falsch Ein Boolescher Wert, der angibt, ob die Ansicht die Standardansicht für die Liste ist.
Query String Falsch Eine Abfrage für die Ansicht.

Ansichten

Ansichten bestehen aus Spalten und Pseudospalten. Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten unterstützen jedoch keine Aktualisierungen. Entitäten, die als Ansichten dargestellt werden, sind normalerweise schreibgeschützte Entitäten. Häufig wird eine gespeicherte Prozedur* ist verfügbar, um die Daten zu aktualisieren, wenn diese Funktionalität auf die Datenquelle anwendbar ist.

Abfragen können für eine Ansicht ausgeführt werden, als wäre es eine normale Tabelle, und die zurückgegebenen Daten sind in dieser Hinsicht ähnlich.

Dynamische Ansichten, wie Abfragen, die als Ansichten angezeigt werden, und Ansichten zum Nachschlagen bestimmter Kombinationen von Projektteam-Arbeitselementen werden unterstützt.

Jitterbit-Connector für Microsoft SharePoint-Ansichten

Name Beschreibung
FileVersions Listet die auf SharePoint verfügbaren Dateiversionen auf.
GetValidTerms Ruft eine Liste gültiger Begriffe für die angegebene Spalte in der angegebenen Tabelle ab.
Lists Listet die in SharePoint verfügbaren Listen auf.
Permissions Die Berechtigungen für eine Site oder Liste. Hinweis: Wenn die ItemID leer ist, sollte der ObjectType auf List oder Web gesetzt werden (wenn der ObjectType List ist, muss ein ObjectName angegeben werden). Wenn nicht, muss der ObjectName zusammen mit der ItemID angegeben werden.
Subsites Hier werden die verfügbaren Unterwebsites aufgelistet.

Dateiversionen

Listet die auf SharePoint verfügbaren Dateiversionen auf.

Ansichtsspezifische Informationen

Bibliothek und Datei müssen angegeben werden, um Ergebnisse aus dieser Ansicht zurückzugeben.

Spalten
Name Typ Beschreibung
ID [KEY] String Die ID der Version.
Comments String Kommentare zur jeweiligen Version.
CreateBy String Der Benutzername des SharePoint-Benutzers, der diese Version der Datei geändert hat.
Date Datetime Wann die Datei geändert wurde.
Size String Die Größe dieser Version der Datei.
Url String Die URL zu dieser Version der Datei.
Library String Der Name der Bibliothek auf SharePoint, aus der Sie Versionen auflisten. Um die Versionen für eine Datei abzurufen, muss eine Bibliothek angegeben werden. Der Standardwert ist „Shared Documents“.
File String Der Name der Datei in SharePoint, für die Versionen aufgelistet werden sollen. Um die Versionen für eine Datei abzurufen, muss eine Datei angegeben werden.

GetValidTerms

Ruft eine Liste gültiger Begriffe für die angegebene Spalte in der angegebenen Tabelle ab.

Tabellenspezifische Informationen

GetValidTerms ist eine spezielle Ansicht. Sie kann verwendet werden, um gültige Begriffe für eine Taxonomie- oder verwaltete Metadatenspalte einer bestimmten Liste abzurufen. Um die Ansicht zu verwenden, geben Sie sowohl den Namen der Tabelle als auch die Spalte an, für die Sie gültige Begriffe abrufen möchten. Beispiel:

SELECT * FROM GetValidTerms WHERE List = 'MyListName' AND ColumnName = 'MyManagedMetadataColumn'
Spalten
Name Typ Beschreibung
ID [KEY] String Die Kennung des Begriffs.
TermLabelValue String Die Bezeichnung des Begriffs.
Description String Beschreibung des Begriffssatzes.
NameInRequestedLang String Der Name des Begriffssatzes in der vom Client gewünschten Sprache.
IsOpen Boolean Boolescher Wert, der angibt, ob der Begriffssatz geöffnet ist.
Deprecated Boolean Boolescher Wert, der angibt, ob der Begriff veraltet ist.
InternalId String Interner Bezeichner für den Begriff.
TermSetContact String Begriffssatzkontakt.
ContainerDesc String Containerknoten für die Beschreibung.
SingleTermLabelDesc String Dies beschreibt eine einzelne Begriffsbezeichnung vollständig.
IsDefaultLabel Boolean Wahr, wenn die Begriffsbezeichnung die Standardbegriffsbezeichnung ist.
BelongsTo String Dieses Element beschreibt einen Begriffssatz, zu dem ein Begriff gehört.
IsTaggingAvailable Boolean Wenn der Ausdruckssatz zum Markieren verfügbar ist, ist dieser Wert „true“.
TermPath String Begriffspfad des Begriffs mit Begriffsbezeichnungen.
TermpathoftermwithIds String Begriffspfad des Begriffs mit Bezeichnern.
ChildTerms String Ein Zeichenfolgenwert, der eine benutzerdefinierte Sortierreihenfolge für die untergeordneten Begriffe des durch „PertainingToTerm“ identifizierten Begriffs angibt.
HasChildTerms Boolean Wahr, wenn der Begriff untergeordnete Begriffe hat.
PertainingToTerm String Bezeichner des Begriffs, auf den sich diese Begriffssatzinformationen beziehen.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
List String Der Name der Liste, für die gültige Begriffe abgerufen werden sollen.
ColumnName String Der Name der Spalte, für die gültige Begriffe abgerufen werden sollen.
LocaleId String Die Gebietsschema-ID für den Begriff. Der Standardwert ist 1033.

Listen

Listet die verfügbaren Listen in SharePoint auf.

Tabellenspezifische Informationen

Listen können verwendet werden, um die Tabellen in SharePoint aufzulisten. Dadurch werden nur tatsächliche Listen in SharePoint zurückgegeben und keine speziellen Tabellen, die mit dem Connector verknüpft sind.

Die folgenden Spalten können in der WHERE-Klausel verwendet werden: Titel und BaseTemplate.

Spalten
Name Typ Beschreibung
ID [KEY] String Die ID der Liste.
Title String Der Titel der Liste. Diese Spalte kann in der WHERE-Klausel und mit einem Platzhalterzeichen (*) verwendet werden.
Description String Eine Beschreibung für die Liste.
BaseTemplate String Gibt den Typ der Vorlage an, die zum Erstellen der Liste verwendet wurde. Diese Spalte kann in der WHERE-Klausel verwendet werden.
Version Double Die Version der Liste.
Url String Die Standard URL der Liste.
EmailAlias String Der Email Alias der Liste.
ImageUrl String Die Bild URL der Liste.
ItemCount Integer Die Anzahl der Elemente in der Liste.
Item_Deleted Datetime Der letzte Zeitpunkt, zu dem ein Element aus dieser Liste gelöscht wurde.
Item_Modified Datetime Der Zeitpunkt, zu dem ein Element aus dieser Liste zum letzten Mal geändert wurde.
SendToUrl String Die Sende-URL der Liste.
Created Datetime Der Zeitpunkt, zu dem die Liste erstellt wurde.
AllowDeletion String Ob Elemente gelöscht werden können.
AllowMultiResponses Boolean Boolescher Wert, der angibt, ob Mehrfachantworten für die Umfrage aktiviert sind.
Direction String Eine Zeichenfolge, die „LTR“ enthält, wenn die Lesereihenfolge von links nach rechts ist, „RTL“, wenn sie von rechts nach links ist, oder „Keine“.
EnableAssignedToEmail Boolean Boolescher Wert, der angibt, ob Zugewiesen-Emails aktiviert sind. Gilt nur für Problemlisten.
EnableAttachments Boolean Boolescher Wert, der angibt, ob den Elementen in der Liste Anhänge hinzugefügt werden können. Gilt nicht für Dokumentbibliotheken.
EnableModeration Boolean Boolescher Wert, der angibt, ob die Inhaltsgenehmigung für die Liste aktiviert ist.
EnableVersioning Boolean Boolescher Wert, der angibt, ob die Versionierung für die Liste aktiviert ist.
Hidden Boolean Boolescher Wert, der angibt, ob die Liste ausgeblendet ist, sodass sie auf der Seite „Dokumente und Listen“, in der Schnellstartleiste, auf der Seite „Site-Inhalt ändern“ oder der Seite „Spalte hinzufügen“ nicht als Option für Nachschlagefelder angezeigt wird.
MultipleDataList Boolean Boolescher Wert, der angibt, ob eine Besprechungsarbeitsbereichssite Daten für mehrere Besprechungsinstanzen innerhalb der Site enthält.
Ordered Boolean Boolescher Wert, der angibt, ob Elemente in der Liste auf der Seite „Ansicht bearbeiten“ sortiert werden können.
Showuser Boolean Boolescher Wert, der angibt, ob die Namen der Benutzer in den Ergebnissen der Umfrage angezeigt werden.

Berechtigungen

Die Berechtigungen für eine Site oder Liste. Hinweis: Wenn die ItemID leer ist, sollte der ObjectType auf List oder Web gesetzt werden (ein ObjectName muss angegeben werden, wenn der ObjectType eine Liste ist). Wenn nicht, muss der ObjectName zusammen mit der ItemID angegeben werden.

Spalten
Name Typ Beschreibung
MemberID [KEY] String Die ID der Berechtigung.
Mask Long Eine 32-Bit-Ganzzahl im Format 0x00000000, die einen Microsoft.SharePoint.SPRights-Wert darstellt und die Berechtigung definiert. Verwenden Sie das Pipe-Symbol ('|') in C# oder „Oder“ in Microsoft Visual Basic, um Werte abzugrenzen, wenn Sie eine benutzerdefinierte Berechtigungsmaske erstellen, die Berechtigungen kombiniert.
MemberIsUser Bool Geben Sie an, ob es sich um die Berechtigung für den Benutzer handelt.
MemberGlobal Bool Geben Sie an, ob es sich um die Berechtigung für eine Gruppe handelt.
RoleName String Eine Zeichenfolge, die den Namen der Site-Gruppe, den Namen der siteübergreifenden Gruppe oder den Benutzernamen (DOMAIN\Benutzeralias) des Benutzers enthält, für den die Berechtigung gilt.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ObjectName String Eine Zeichenfolge, die den Namen der Liste oder Site enthält.
ObjectType String Eine Zeichenfolge, die entweder „Liste“ oder „Web“ angibt.
ItemID String ID des Artikels.

Unterwebsites

Hier werden die verfügbaren Unterwebsites aufgelistet.

Spalten
Name Typ Beschreibung
Title String Der Name der Unterwebsite.
Url String Die URL der Unterseite.

Gespeicherte Prozeduren

Gespeicherte Prozeduren* sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Microsoft SharePoint hinaus erweitern.

Gespeicherte Prozeduren* akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Microsoft SharePoint zurück, zusammen mit einer Angabe, ob der Vorgang erfolgreich war oder fehlgeschlagen ist.

Jitterbit-Connector für gespeicherte Prozeduren in Microsoft SharePoint

Name Beschreibung
AddAttachment Einem SharePoint-Listenelement einen Anhang hinzufügen.
AddList Erstellt eine Liste auf einer SharePoint-Site.
AddListColumn Fügt der angegebenen Liste eine neue Spalte hinzu.
AddUserToGroup Den Benutzer der angegebenen Gruppe hinzufügen.
AddUserToRole Fügt den Benutzer der angegebenen Rolle hinzu.
CheckInDocument Checkt ein Dokument in SharePoint ein und hebt die Sperre für das Dokument auf.
CheckOutDocument Checkt ein Dokument aus SharePoint aus.
CopyDocument Kopiert ein Dokument aus der SharePoint-Bibliothek.
CreateFolder Fügt einer Dokumentbibliothek auf einer SharePoint-Site einen Ordner hinzu.
CreateSchema Erstellt die Schema für die angegebene SharePoint-Liste. Die Schema kann manuell angepasst werden, um unerwünschte Spalten auszuschließen oder zusätzliche Informationen zu Spalten einzuschließen.
DeleteAttachment Löschen Sie einen Anhang aus einem SharePoint-Listenelement.
DeleteDocument Löschen Sie ein Dokument in der SharePoint-Bibliothek.
DeleteList Löscht eine Liste dauerhaft von einer SharePoint-Site.
DeleteListColumn Löscht eine Spalte aus der angegebenen Liste.
DeleteUserFromGroup Löscht den Benutzer aus der angegebenen Gruppe.
DeleteUserFromRole Löscht den Benutzer aus der angegebenen Rolle.
DiscardCheckOutDocument Verwirft das Auschecken eines Dokuments in SharePoint. Dadurch wird keine neue Datei in SharePoint eingecheckt. Es wird nur die Sperre des Dokuments aufgehoben.
DownloadAttachment Laden Sie ein Dokument aus der SharePoint-Liste herunter.
DownloadDocument Laden Sie ein Dokument aus der SharePoint-Bibliothek herunter.
MoveAttachmentOrDocument Verschiebt ein Dokument oder einen Anhang von einem Quellordner in einen Zielordner.
RenameAttachmentOrDocument Benennt ein Dokument oder einen Anhang um.
UpdateList Aktualisiert eine Liste auf einer SharePoint-Site.
UpdateListColumn Aktualisiert eine Spalte der angegebenen Liste.
UploadDocument Laden Sie ein Dokument in die SharePoint-Bibliothek hoch.

Anhang hinzufügen

Fügen Sie einem SharePoint-Listenelement einen Anhang hinzu.

Eingang
Name Typ Akzeptiert Eingabeströme Beschreibung
File String Falsch Der Pfad der hinzuzufügenden lokalen Datei.
List String Falsch Der Name der Liste auf dem SharePoint-Server.
ItemID String Falsch Die ID des Elements in der Liste, für das Anhänge hinzugefügt werden sollen.
Content String True Der Inhalt als InputStream, der hochgeladen werden soll, wenn keine Datei angegeben ist.
FileName String Falsch Name der hochzuladenden Datei. Dies wird verwendet, wenn der Inhalt nicht null ist. Beispiel: test.csv
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL des neu erstellten Elements.
Result String Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Liste hinzufügen

Erstellt eine Liste auf einer SharePoint-Site.

Eingang
Name Typ Beschreibung
Name String Der Name der Liste auf dem SharePoint-Server.
Template String Der Name der Vorlage, die für die Listenerstellung verwendet werden soll. Die zulässigen Werte sind GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks. Der Standardwert ist GenericList.
Description String Die Beschreibung der hinzuzufügenden Liste.
Columns String Die Definition der hinzuzufügenden Spalten unterstützt json/xml/tempTable
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Listenspalte hinzufügen

Fügt der angegebenen Liste eine neue Spalte hinzu.

Eingang
Name Typ Beschreibung
List String Der Name der Liste auf dem SharePoint-Server.
ColumnName String Der Name der hinzuzufügenden Spalte.
DisplayName String Der Anzeigename der hinzuzufügenden Spalte.
DefaultValue String Der Standardwert der hinzuzufügenden Spalte.
ColumnType String Der Datentyp der hinzuzufügenden Spalte. Die gültigen Optionen werden durch die in der SharePoint-API verfügbaren Feldtypen definiert: https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15).
MaxLength String Die maximale Länge der Werte der hinzuzufügenden Spalte.
PrimaryKey String Boolescher Wert, der angibt, ob die Spalte ein Primärschlüssel sein soll oder nicht.
ReadOnly String Boolescher Wert, der angibt, ob die Spalte schreibgeschützt ist oder nicht.
Required String Boolescher Wert, der angibt, ob die Spalte erforderlich ist oder nicht.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

BenutzerZurGruppe Hinzufügen

Fügen Sie den Benutzer der angegebenen Gruppe hinzu.

Eingang
Name Typ Beschreibung
LoginName String Der Anmeldename des Benutzers.
Group String Die Gruppe, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.
Ergebnissatzspalten
Name Typ Beschreibung
Result Boolean Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Benutzer zur Rolle hinzufügen

Fügen Sie den Benutzer der angegebenen Rolle hinzu.

Eingang
Name Typ Beschreibung
LoginName String Der Anmeldename des Benutzers.
Role String Die Rolle, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.
Ergebnissatzspalten
Name Typ Beschreibung
Result Boolean Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Dokument einchecken

Checkt ein Dokument in SharePoint ein und hebt die Sperre des Dokuments auf.

Eingang
Name Typ Beschreibung
File String Der Pfad der Datei, mit der Sie das Dokument auf SharePoint überschreiben möchten. Beispiel: C:\myfolder\myfile.txt.
Library String Der Name der Bibliothek auf dem SharePoint-Server. Beispiel: „Freigegebene Dokumente“.
Comment String Ein Kommentar, der beim Einchecken der Datei hinterlassen werden soll.
RemoteFile String Der Pfad der Datei auf dem Server. Dies kann die vollständige URL oder einfach der Dateiname sein.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Dokument auschecken

Checkt ein Dokument aus SharePoint aus.

Eingang
Name Typ Beschreibung
Library String Der Name der Bibliothek auf dem SharePoint-Server.
RemoteFile String Der Pfad der Datei auf dem Server. Dies kann die vollständige URL oder einfach der Dateiname sein.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Dokument kopieren

Kopiert ein Dokument aus der SharePoint-Bibliothek.

Hinweis

Dieses Verfahren verwendet indexed parameters. Diese Eingabeparameter sind mit einem gekennzeichnet #-Zeichen am Ende ihrer Namen.

Indizierte Parameter erleichtern die Bereitstellung mehrerer Instanzen eines einzelnen Parameters als Eingaben für die Prozedur.

Angenommen, es gibt einen Eingabeparameter mit dem Namen Param#. Geben Sie mehrere Instanzen eines indizierten Parameters wie folgt ein:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Eingang
Name Typ Beschreibung
DocumentName String Der Name des zu kopierenden Dokuments in der Dokumentbibliothek.
DocumentLibrary String Der Name der Dokumentbibliothek, in der das Dokument aktuell gespeichert ist.
NewDocumentLibrary String Der Name der Dokumentbibliothek, in die das Dokument kopiert wird.
NewDocumentName String Der neue Name des Dokuments, nachdem es kopiert wurde. Wenn dieses Feld leer gelassen wird, entspricht es dem Dokumentnamen.
MetadataName# String Der Name eines Metadatenfelds, das für das Dokument festgelegt werden soll.
ReturnID String Die Rückgabe-ID des Dokuments.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.
\_dlc_DocId String Die Dokument-ID.
\_dlc_DocIdUrl String Die URL der Dokument-ID.
Vti_author String Der Ersteller des Dokuments.
Vti_etag String Das E-Tag des Dokuments.
ID String Die ID des Dokuments.
FileRef String Die Aktenzeichen des Dokuments.

Ordner erstellen

Fügt einer Dokumentbibliothek auf einer SharePoint-Site einen Ordner hinzu.

Eingang
Name Typ Beschreibung
Library String Der Name der Bibliothek auf dem SharePoint-Server.
Name String Name des Ordners, zu dem das Dokument hinzugefügt werden soll.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Schema erstellen

Erstellt die Schema für die angegebene SharePoint-Liste. Die Schema kann manuell angepasst werden, um unerwünschte Spalten auszuschließen oder zusätzliche Informationen zu Spalten einzuschließen.

Eingang
Name Typ Akzeptiert Ausgabeströme Beschreibung
Table String Falsch Der Name der Tabelle, für die ein Schema erstellt werden soll.
TableDescription String Falsch Eine optionale Beschreibung der Tabelle.
FileStream String True OutputStream zum Schreiben des erstellten Schema
WriteToFile String Falsch Ob in eine Ausgabedatei geschrieben werden soll oder nicht. Standardmäßig auf „true“ gesetzt, muss auf „false“ gesetzt werden, um in FileStream oder FileData zu schreiben.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Gibt „Erfolg“ oder „Fehler“ zurück.
SchemaFile String Die generierte Schema.
Columns String Die Anzahl der gefundenen Spalten.
FileData String Das generierte Schema ist in Base64 kodiert. Wird nur zurückgegeben, wenn WriteToFile auf „false“ gesetzt ist und FileStream nicht festgelegt ist.

Anhang löschen

Löschen Sie einen Anhang aus einem SharePoint-Listenelement.

Eingang
Name Typ Beschreibung
URL String Vollständige URL zum zu löschenden Anhang.
List String Der Name der Liste auf dem SharePoint-Server.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Dokument löschen

Löschen Sie ein Dokument in der SharePoint-Bibliothek.

Eingang
Name Typ Beschreibung
Library String Der Name der Bibliothek auf dem SharePoint-Server.
Path String Der Pfad der Datei (oder des Ordners), die aus der Dokumentbibliothek entfernt werden soll.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Liste löschen

Löscht eine Liste dauerhaft von einer SharePoint-Site.

Eingang
Name Typ Beschreibung
List String Der Name der Liste auf dem SharePoint-Server.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Listenspalte löschen

Löscht eine Spalte aus der angegebenen Liste.

Eingang
Name Typ Beschreibung
List String Der Name der Liste auf dem SharePoint-Server.
ColumnName String Der Name der zu löschenden Spalte.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Benutzer aus Gruppe löschen

Löschen Sie den Benutzer aus der angegebenen Gruppe.

Eingang
Name Typ Beschreibung
LoginName String Der Anmeldename des Benutzers.
Group String Die Gruppe, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.
Ergebnissatzspalten
Name Typ Beschreibung
Result Boolean Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Benutzer aus Rolle löschen

Löschen Sie den Benutzer aus der angegebenen Rolle.

Eingang
Name Typ Beschreibung
LoginName String Der Anmeldename des Benutzers.
Role String Die Rolle, zu der Sie einen Benutzer hinzufügen und aus der Sie einen Benutzer auswählen oder löschen. Dies ist ein Nur-Eingabe-Wert und für Einfügungen und Auswahlen muss entweder „Gruppe“ oder „Rolle“ angegeben werden, für Löschungen kann dies jedoch optional angegeben werden.
Ergebnissatzspalten
Name Typ Beschreibung
Result Boolean Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.

Auschecken von Dokumenten verwerfen

Verwirft das Auschecken eines Dokuments in SharePoint. Dadurch wird keine neue Datei in SharePoint eingecheckt. Es wird nur die Sperre des Dokuments aufgehoben.

Eingang
Name Typ Beschreibung
Library String Der Name der Bibliothek auf dem SharePoint-Server.
RemoteFile String Der Name der ausgecheckten Datei.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Anhang herunterladen

Laden Sie ein Dokument aus der SharePoint-Liste herunter.

Eingang
Name Typ Akzeptiert Ausgabeströme Beschreibung
File String Falsch Der Pfad der zu speichernden Datei.
RemoteFile String Falsch Der Pfad der Datei auf dem Server. Dies kann die vollständige URL oder einfach der Dateiname sein. Wenn Sie den Namen der Datei verwenden, wird die neueste Version heruntergeladen.
FileStream String True OutputStream zum Schreiben des heruntergeladenen Anhangs. Wird nur zurückgegeben, wenn File nicht festgelegt ist.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Der heruntergeladene BASE64-codierte Dateiinhalt. Wird nur zurückgegeben, wenn „File“ und „FileStream“ nicht festgelegt sind.

Dokument herunterladen

Laden Sie ein Dokument aus der SharePoint-Bibliothek herunter.

Eingang
Name Typ Akzeptiert Ausgabeströme Beschreibung
File String Falsch Der Pfad der zu speichernden Datei.
Library String Falsch Der Name der Bibliothek auf dem SharePoint-Server.
RemoteFile String Falsch Der Pfad der Datei auf dem Server. Dies kann die vollständige URL oder einfach der Dateiname sein. Wenn Sie den Namen der Datei verwenden, wird die neueste Version heruntergeladen.
FileStream String True OutputStream zum Schreiben des heruntergeladenen Dokuments. Wird nur zurückgegeben, wenn File nicht festgelegt ist.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Der heruntergeladene Dateiinhalt. Wird nur zurückgegeben, wenn File und FileStream nicht festgelegt sind.

Anhang oder Dokument verschieben

Verschiebt ein Dokument oder einen Anhang aus einem Quellordner in einen Zielordner.

Die MoveAttachmentOrDocument gespeicherte Prozedur* erfordert die Parameter List, SourceFileURL und DestinationFolderURL, um einen Anhang oder ein Dokument zu verschieben.

Beispiel:

EXEC MoveAttachmentOrDocument List = 'Test134', SourceFileURL = '/Shared Documents/Dummy.txt', DestinationFolderURL = '/Shared Documents/MySite'
Eingang
Name Typ Beschreibung
Liste Zeichenfolge Name der Liste, aus der Sie das Dokument oder den Anhang verschieben möchten.
SourceFileURL String URL der Quelldatei, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnisdatei: /Shared Documents/filename.txt Unterverzeichnisdatei:/Shared Documents/MyFolder/filename.txt Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der Site, die in der URL angegeben ist.
DestinationFolderURL String URL des Zielordners, in den Sie die Datei verschieben möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnis: /Shared Documents/ Unterverzeichnis:/Shared Documents/MyFolder/ Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der in der URL angegebenen Site.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Wert, der angibt, ob der Operation erfolgreich war.

Anhang oder Dokument umbenennen

Benennt ein Dokument oder einen Anhang um.

Die RenameAttachmentOrDocument gespeicherte Prozedur* erfordert die Parameter List, SourceFileURL und NewFileName, um einen Anhang oder ein Dokument umzubenennen.

Beispiel:

EXEC RenameAttachmentOrDocument List = 'Test134', SourceFileURL = '/Shared Documents/Dummy.txt', NewFileName = 'Dummy1.txt'
Eingang
Name Typ Beschreibung
Liste Zeichenfolge Name der Liste, die das Dokument oder den Anhang enthält, das/den Sie umbenennen möchten.
SourceFileURL String URL der Datei, die Sie umbenennen möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnisdatei: /Shared Documents/filename.txt Unterverzeichnisdatei:/Shared Documents/MyFolder/filename.txt Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der in der URL angegebenen Site.
NewFileName String Neuer Name der Datei, mit Erweiterung.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Wert, der angibt, ob der Operation erfolgreich war.

Liste aktualisieren

Aktualisiert eine Liste auf einer SharePoint-Site.

Eingang
Name Typ Beschreibung
List String Der Name der Liste auf dem SharePoint-Server.
AllowMultiResponses String Auf „True“ setzen, um mehrere Antworten auf die Umfrage zuzulassen.
Description String Eine Zeichenfolge, die die Beschreibung der Liste enthält.
Direction String Eine Zeichenfolge, die „LTR“ enthält, wenn die Lesereihenfolge von links nach rechts ist, „RTL“, wenn sie von rechts nach links ist, oder „Keine“.
EnableAssignedToEmail String Auf „True“ setzen, um Zugewiesen-E-Mails für die Problemliste zu aktivieren.
EnableAttachments String Auf „True“ setzen, um Anhänge an Elemente in der Liste zu aktivieren. Gilt nicht für Dokumentbibliotheken.
EnableModeration String Auf „True“ setzen, um die Inhaltsgenehmigung für die Liste zu aktivieren.
EnableVersioning String Auf „True“ setzen, um die Versionierung für die Liste zu aktivieren.
Hidden String Auf „True“ setzen, um die Liste auszublenden, sodass sie nicht auf der Seite „Dokumente und Listen“, in der Schnellstartleiste, auf der Seite „Site-Inhalt ändern“ oder der Seite „Spalte hinzufügen“ als Option für Nachschlagefelder angezeigt wird.
MultipleDataList String Auf „True“ setzen, um anzugeben, dass die Liste in einer Besprechungsarbeitsbereichssite Daten für mehrere Besprechungsinstanzen innerhalb der Site enthält.
Ordered String Auf „True“ setzen, um anzugeben, dass die Option, die Benutzern das Neuanordnen von Elementen in der Liste gestattet, auf der Seite „Ansicht bearbeiten“ für die Liste verfügbar ist.
ShowUser String Auf „True“ setzen, um anzugeben, dass die Namen der Benutzer in den Ergebnissen der Umfrage angezeigt werden.
Title String Eine Zeichenfolge, die den Titel der Liste enthält.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Listenspalte aktualisieren

Aktualisiert eine Spalte der angegebenen Liste.

Eingang
Name Typ Beschreibung
List String Der Name der Liste auf dem SharePoint-Server.
ColumnName String Der Name der zu aktualisierenden Spalte.
DisplayName String Der aktualisierte Wert des Anzeigenamens.
DefaultValue String Der aktualisierte Standardwert der angegebenen Spalte.
ColumnType String Der aktualisierte Datentyp der angegebenen Spalte.
MaxLength String Die aktualisierte maximale Länge der angegebenen Spalte.
PrimaryKey String Verwenden Sie dies, um die vorhandene Spalte zum Primärschlüssel zu machen oder nicht.
ReadOnly String Verwenden Sie dies, um die vorhandene Spalte schreibgeschützt zu machen oder nicht.
Required String Verwenden Sie dies, um festzulegen, ob die vorhandene Spalte erforderlich ist oder nicht.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.

Dokument hochladen

Laden Sie ein Dokument in die SharePoint-Bibliothek hoch.

Hinweis

Dieses Verfahren verwendet indexed parameters. Diese Eingabeparameter sind mit einem gekennzeichnet #-Zeichen am Ende ihrer Namen.

Indizierte Parameter erleichtern die Bereitstellung mehrerer Instanzen eines einzelnen Parameters als Eingaben für die Prozedur.

Angenommen, es gibt einen Eingabeparameter mit dem Namen Param#. Geben Sie mehrere Instanzen eines indizierten Parameters wie folgt ein:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Eingang
Name Typ Akzeptiert Eingabeströme Beschreibung
Datei Zeichenfolge Falsch Der Pfad der hinzuzufügenden Datei.
FileContent Zeichenfolge Falsch Base64 codierter Inhalt der hinzuzufügenden Datei. Wenn angegeben, wird der Wert der Eingabe „Datei“ ignoriert.
Bibliothek Zeichenfolge Falsch Die URL des Verzeichnisses, in das Sie Dateien hochladen möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnis: Freigegebene Dokumente Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der Site, die in der URL angegeben ist.
Name Zeichenfolge Falsch Der der neuen Datei zugewiesene Name. Geben Sie beim Hochladen in das Stammverzeichnis der Site nur den Dateinamen an. Beim Hochladen in einen Ordner, der auf einer Ebene innerhalb des Stammverzeichnisses verschachtelt ist, stellen Sie das vollständige übergeordnete Unterverzeichnis voran. Beispiel: Stammverzeichnis: Dateiname.txt Unterverzeichnis:MeinOrdner/Dateiname.txt
Inhalt String True Der Inhalt als InputStream, der hochgeladen werden soll, wenn keine Datei angegeben ist.
ReturnID String False Boolescher Wert, der angibt, ob die ID und andere Metadatenfelder des neu erstellten Datensatzes zurückgegeben werden sollen. Um diesen Wert abzurufen, ist eine zusätzliche API Anfrage erforderlich. Der Standardwert ist false.
MetadataName# String False Der Name eines Metadatenfelds, das für das Dokument festgelegt werden soll. Es muss der Spaltenname sein, der in der Tabelle der Bibliothek vorhanden ist.
MetadataValue# String False Der Wert eines Metadatenfelds, das für das Dokument festgelegt werden soll.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob die gespeicherte Prozedur* war erfolgreich.
ID String Die interne ID des Dokuments.
\_dlc_DocId String Die Dokument-ID.
\_dlc_DocIdUrl String Die URL der Dokument-ID.
Vti_author String Der Ersteller des Dokuments.
Vti_etag String Das E-Tag des Dokuments.
FileRef String Die Aktenzeichen des Dokuments.

REST-Datenmodell

Der Jitterbit Connector für Microsoft SharePoint modelliert Microsoft SharePoint-Entitäten in relationalen Tabellen, Ansichten und gespeicherten Prozeduren. Die Tabellendefinitionen werden dynamisch basierend auf Ihrer Microsoft SharePoint-Site abgerufen. Alle von Ihnen vorgenommenen Änderungen, z. B. das Hinzufügen eines benutzerdefinierten Felds oder das Ändern des Datentyps eines Felds, werden automatisch übernommen, wenn Sie eine Verbindung herstellen.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Listen auf Ihrer Microsoft SharePoint-Site werden dynamisch als relationale Tabellen angezeigt. Das bedeutet, dass jede Änderung, die Sie an Ihren Listen vornehmen, z. B. das Hinzufügen neuer Listen oder Felder, im Treiber widergespiegelt wird.

Ansichten

Ansichten sind Tabellen, die nicht geändert werden können. Normalerweise werden schreibgeschützte Daten als Ansichten angezeigt.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie bieten zusätzliche Funktionen der Microsoft SharePoint-API, beispielsweise das Suchen, Aktualisieren und Ändern von Informationen.

OData Standard verwenden

Da die REST- API auf OData basiert, werden serverseitige Filter mit dem OData-Standard durchgeführt. Der Treiber übernimmt also die Serverfilterung optimal, indem er die Metadatendatei liest und feststellt, welche Filter auf dem Server durchgeführt werden können.

Notiz

Beim Ausführen von „SELECT *“-Abfragen gibt die Microsoft SharePoint REST API -Antwort nicht alle verfügbaren Felder zurück. Um zu viele Nullwerte zu vermeiden, wählt der Anbieter alle Spalten explizit mithilfe von aus $select Filter. Der Anbieter wird dies jedoch nur tun, wenn der $select Die Filterlänge darf 1500 nicht überschreiten, um einen Fehler der Microsoft SharePoint REST API bezüglich der URL Länge zu vermeiden. Dies ist eine Einschränkung der Microsoft SharePoint REST API. In diesen Fällen besteht die einzige Möglichkeit, den tatsächlichen Wert einiger Spalten anzuzeigen, darin, sie in Ihrer Abfrage explizit auszuwählen.

Ansichten

Ansichten bestehen aus Spalten und Pseudospalten. Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten unterstützen jedoch keine Aktualisierungen. Entitäten, die als Ansichten dargestellt werden, sind normalerweise schreibgeschützte Entitäten. Häufig wird eine gespeicherte Prozedur* ist verfügbar, um die Daten zu aktualisieren, wenn diese Funktionalität auf die Datenquelle anwendbar ist.

Abfragen können für eine Ansicht ausgeführt werden, als wäre es eine normale Tabelle, und die zurückgegebenen Daten sind in dieser Hinsicht ähnlich.

Dynamische Ansichten, wie Abfragen, die als Ansichten angezeigt werden, und Ansichten zum Nachschlagen bestimmter Kombinationen von Projektteam-Arbeitselementen werden unterstützt.

Jitterbit-Connector für Microsoft SharePoint-Ansichten

Name Beschreibung
Attachments Anhänge für das angegebene Element in der angegebenen Liste lesen.
Files Fragen Sie die verfügbaren Dateien auf Ihrer SharePoint-Site ab.
Groups Fragen Sie die verfügbaren Gruppen auf Ihrer SharePoint-Site ab.
Lists Fragen Sie die verfügbaren Listen auf Ihrer SharePoint-Site ab.
RoleAssignmentMember Web RoleAssignments-Mitglied abrufen.
RoleAssignments Web-Rollenzuweisungen abrufen.
RoleDefinitionBindings Bindung für Webrollendefinition abrufen.
Roles Fragen Sie die Rollen ab, die Ihre Benutzer haben können.
Subsites Hier werden die verfügbaren Unterwebsites aufgelistet.
Users Fragen Sie die verfügbaren Benutzer auf Ihrer SharePoint-Site ab.

Anlagen

Anhänge für das angegebene Element in der angegebenen Liste lesen.

Tabellenspezifische Informationen
Wählen

Hinweis

Liste und Artikel-ID sind erforderlich, um Anhänge zurückzugeben.

Die Liste kann aus der Listenansicht (Spalte „Titel“) abgerufen werden.

SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1
Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die ID des Anhangs zum Element.
Updated Datetime Das Aktualisierungsdatum des Anhangs zum Element.
FileName String Der Dateiname des Anhangs zum Element.
ServerRelativePath_DecodedUrl String Die ServerRelativePath DecodedUrl des Anhangs des Elements.
FileNameAsPath_DecodedUrl String Die FileNameAsPath DecodedUrl des Anhangs des Elements.
ServerRelativeUrl String Die ServerRelativeUrl des Anhangs des Elements.
List String Der interne Name der Liste, aus der Anhänge abgerufen werden sollen.
ItemID String Die ID des Elements in der Liste, von dem Anhänge abgerufen werden sollen.

Dateien

Fragen Sie die verfügbaren Dateien auf Ihrer SharePoint-Site ab.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String
CreatedBy_Id String
CreatedBy_Name String
CreatedBy_Puid String
ETag String
LastModifiedBy_Id String
LastModifiedBy_Name String
LastModifiedBy_Puid String
Name String
Size Int
TimeCreated Datetime
TimeLastModified Datetime
Url String

Gruppen

Fragen Sie die verfügbaren Gruppen auf Ihrer SharePoint-Site ab.

Tabellenspezifische Informationen
Wählen
SELECT * FROM Groups
Spalten
Name Typ Referenzen Beschreibung
Id [KEY] Int Die Gruppen-ID.
AllowMembersEditMembership Bool
AllowRequestToJoinLeave Bool
AutoAcceptRequestToJoinLeave Bool
CanCurrentUserEditMembership Bool
CanCurrentUserManageGroup Bool
CanCurrentUserViewMembership Bool
Description String
OnlyAllowMembersViewMembership Bool
OwnerTitle String
RequestToJoinLeaveEmailSetting String
LinkedOwner String
LinkedUsers String

Listen

Fragen Sie die verfügbaren Listen auf Ihrer SharePoint-Site ab.

Spalten
Name Typ Referenzen Beschreibung
HasUniqueRoleAssignments [KEY] Bool
LinkedFirstUniqueAncestorSecurableObject String
LinkedRoleAssignments String
ServerRelativeUrl String Die relative URL der Datei basierend auf der URL für den Server. Diese Spalte ist verfügbar, wenn die URL eine Unterwebsite ist.
Id [KEY] String
AllowContentTypes Bool
AllowDeletion Bool
BaseTemplate Int
BaseType Int
BrowserFileHandling Int
ContentTypesEnabled Bool
CrawlNonDefaultViews Bool
Created Datetime
CurrentChangeToken_StringValue String
CustomActionElements_Items String
DataSource_Properties String
DefaultContentApprovalWorkflowId String
DefaultDisplayFormUrl String
DefaultEditFormUrl String
DefaultItemOpenUseListSetting Bool
DefaultNewFormUrl String
DefaultViewPath_DecodedUrl String
DefaultViewUrl String
Description String
Direction String
DisableGridEditing Bool
DocumentTemplateUrl String
DraftVersionVisibility Int
EffectiveBasePermissions_High Long
EffectiveBasePermissions_Low Long
EffectiveBasePermissionsForUI_High Long
EffectiveBasePermissionsForUI_Low Long
EnableAssignToEmail Bool
EnableAttachments Bool
EnableFolderCreation Bool
EnableMinorVersions Bool
EnableModeration Bool
EnableRequestSignOff Bool
EnableVersioning Bool
EntityTypeName String
ExcludeFromOfflineClient Bool
ExemptFromBlockDownloadOfNonViewableFiles Bool
FileSavePostProcessingEnabled Bool
ForceCheckout Bool
HasExternalDataSource Bool
Hidden Bool
ImagePath_DecodedUrl String
ImageUrl String
IrmEnabled Bool
IrmExpire Bool
IrmReject Bool
IsApplicationList Bool
IsCatalog Bool
IsEnterpriseGalleryLibrary Bool
IsPrivate Bool
IsSiteAssetsLibrary Bool
IsSystemList Bool
ItemCount Int
LastItemDeletedDate Datetime
LastItemModifiedDate Datetime
LastItemUserModifiedDate Datetime
ListExperienceOptions Int
ListItemEntityTypeFullName String
MajorVersionLimit Int
MajorWithMinorVersionsLimit Int
MultipleDataList Bool
NoCrawl Bool
OnQuickLaunch Bool
PageRenderType Int
ParentWebPath_DecodedUrl String
ParentWebUrl String
ParserDisabled Bool
ReadSecurity Int
SchemaXml String
ServerTemplateCanCreateFolders Bool
TemplateFeatureId String
Title String
ValidationFormula String
ValidationMessage String
WriteSecurity Int
LinkedContentTypes String
LinkedCreatablesInfo String
LinkedDefaultView String
LinkedDescriptionResource String
LinkedEventReceivers String
LinkedFields String
LinkedForms String
LinkedInformationRightsManagementSettings String
LinkedItems String
LinkedParentWeb String
LinkedRootFolder String
LinkedSubscriptions String
LinkedTitleResource String
LinkedUserCustomActions String
LinkedViews String
LinkedWorkflowAssociations String

Rollenzuweisungsmitglied

Web RoleAssignments-Mitglied erhalten.

Tabellenspezifische Informationen
Wählen

Hinweis

PrincipalId ist erforderlich, um RoleAssignmentMember zurückzugeben.

SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3

SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Spalten
Name Typ Referenzen Beschreibung
ID [KEY] String Die ID des Mitglieds, dem die Rolle zugewiesen ist.
Updated Datetime Das Aktualisierungsdatum für das Mitglied mit zugewiesener Rolle.
IsHiddenInUI Boolean Ein Boolescher Wert, der angibt, ob das zugewiesene Rolle in der Benutzeroberfläche ausgeblendet ist.
LoginName String Der Anmeldename des Mitglieds mit zugewiesener Rolle.
Title String Der Titel des Mitglieds, dem die Rolle zugewiesen ist.
AllowMembersEditMembership Boolean Ein Boolescher Wert, der angibt, ob Mitgliedern die Bearbeitung der Mitgliedschaft gestattet wird.
AllowRequestToJoinLeave Boolean Ein Boolescher Wert, der angibt, ob der Antrag auf Beitritt zum Urlaub zugelassen wird.
AutoAcceptRequestToJoinLeave Boolean Ein Boolescher Wert, der angibt, ob die Urlaubsanfrage automatisch angenommen werden soll.
Description String Die Beschreibung des Mitglieds, dem die Rolle zugewiesen ist.
OnlyAllowMembersViewMembership Boolean Ein Boolescher Wert, der angibt, ob nur Mitgliedern die Anzeige der Mitgliedschaft gestattet wird.
OwnerTitle String Der Besitzertitel des Mitglieds, dem die Rolle zugewiesen ist.
RequestToJoinLeaveEmailSetting String Die Beitrittsanfrage hinterlässt die Email Einstellungen des Mitglieds mit zugewiesener Rolle.
PrincipalId String Rollenzuweisungen.PrincipalId Die Haupt-ID.
List String Listen.Titel Der interne Name der Liste, aus der das Mitglied mit zugewiesener Rolle abgerufen werden soll.
ItemId String Listenelement-ID für Rolle.

Rollenzuweisungen

Web-Rollenzuweisungen erhalten.

Tabellenspezifische Informationen
Wählen
SELECT * FROM RoleAssignments WHERE List = 'TestApp'

SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Spalten
Name Typ Referenzen Beschreibung
ID [KEY] String Die ID der zugewiesenen Rolle.
PrincipalId Long Die Haupt-ID für die zugewiesene Rolle.
Updated Datetime Das aktualisierte Datum für die zugewiesene Rolle.
List String Listen.Titel Der interne Name der Liste, aus der die zugewiesene Rolle abgerufen werden soll.
ItemId String Listenelement-ID für Rolle.

Rollendefinitionsbindungen

Bindung der Webrollendefinition abrufen.

Tabellenspezifische Informationen
Wählen

Hinweis

PrincipalId ist erforderlich, um RoleDefinitionBindings zurückzugeben.

SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3

SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Spalten
Name Typ Referenzen Beschreibung
ID [KEY] String Die ID des Mitglieds, dem die Rolle zugewiesen ist.
BasePermissions_High Int64 Die Basisberechtigungen sind hoch.
BasePermissions_Low Int64 Die Basisberechtigungen sind niedrig.
Description String Die Beschreibung.
Hidden Boolean Ein Boolescher Wert, der angibt, ob es ausgeblendet ist.
Name String Der Name.
Order Int Die Bestellung.
RoleTypeKind Int Die Art des Rolle.
PrincipalId String Rollenzuweisungen.PrincipalId Die Haupt-ID.
List String Listen.Titel Der interne Name der Liste, aus der das Mitglied mit zugewiesener Rolle abgerufen werden soll.
ItemId String Listenelement-ID zur Rolle.

Rollen

Fragen Sie ab, welche Rollen Ihre Benutzer haben können.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] Int
BasePermissions_High Long
BasePermissions_Low Long
Description String
Hidden Bool
Name String
Order Int
RoleTypeKind Int

Unterwebsites

Hier werden die verfügbaren Unterwebsites aufgelistet.

Tabellenspezifische Informationen
Wählen
SELECT * FROM Subsites
Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die ID der Unterseite.
AllowRssFeeds Boolean Die AllowRssFeeds der Unterseite.
AlternateCssUrl String Die AlternateCssUrl der Unterseite.
AppInstanceId String Die AppInstanceId der Subsite.
ClassicWelcomePage String Die ClassicWelcomePage der Unterseite.
Configuration Int Die Konfiguration der Unterseite.
Created Datetime Das Erstellen der Unterseite.
CurrentChangeToken_StringValue String Der CurrentChangeToken_StringValue der Subsite.
CustomMasterUrl String Die CustomMasterUrl der Unterseite.
Description String Die Beschreibung der Unterseite.
DesignPackageId String Die DesignPackageId der Subsite.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Boolean Die DocumentLibraryCalloutOfficeWebAppPreviewersDisabled der Unterseite.
EnableMinimalDownload Boolean Das EnableMinimalDownload der Unterseite.
FooterEmphasis Int Die Footer-Hervorhebung der Unterseite.
FooterEnabled Boolean Das FooterEnabled der Unterseite.
FooterLayout Int Das FooterLayout der Unterseite.
HeaderEmphasis Int Die HeaderEmphasis der Subsite.
HeaderLayout Int Das HeaderLayout der Unterseite.
HideTitleInHeader Boolean Der HideTitleInHeader der Subsite.
HorizontalQuickLaunch Boolean Der HorizontalQuickLaunch der Subsite.
IsHomepageModernized Boolean Die IsHomepageModernized der Unterseite.
IsMultilingual Boolean Das IsMultilingual der Unterseite.
IsRevertHomepageLinkHidden Boolean Der IsRevertHomepageLinkHidden der Unterseite.
KeepFieldUserResources Boolean Die KeepFieldUserResources der Subsite.
Language Int Die Sprache der Unterseite.
LastItemModifiedDate Datetime Das LastItemModifiedDate der Subsite.
LastItemUserModifiedDate Datetime Das LastItemUserModifiedDate der Subsite.
LogoAlignment Int Das LogoAlignment der Unterseite.
MasterUrl String Die MasterUrl der Unterseite.
MegaMenuEnabled Boolean Das MegaMenuEnabled der Unterseite.
NavAudienceTargetingEnabled Boolean Das NavAudienceTargetingEnabled der Unterseite.
NoCrawl Boolean Das NoCrawl der Unterseite.
ObjectCacheEnabled Boolean Das ObjectCacheEnabled der Subsite.
OverwriteTranslationsOnChange Boolean Das OverwriteTranslationsOnChange der Subsite.
ResourcePath_DecodedUrl String Die ResourcePath_DecodedUrl der Unterseite.
QuickLaunchEnabled Boolean Das QuickLaunchEnabled der Subsite.
RecycleBinEnabled Boolean Das RecycleBinEnabled der Subsite.
SearchScope Int Der Suchbereich der Subsite.
ServerRelativeUrl String Die ServerRelativeUrl der Unterseite.
SiteLogoUrl String Die SiteLogoUrl der Unterseite.
SyndicationEnabled Boolean Das SyndicationEnabled der Unterseite.
TenantAdminMembersCanShare Int Der TenantAdminMembersCanShare der Unterwebsite.
Title String Der Titel der Unterseite.
TreeViewEnabled Boolean Das TreeViewEnabled der Subsite.
UIVersion Int Die UI-Version der Subsite.
UIVersionConfigurationEnabled Boolean Die UIVersionConfigurationEnabled der Subsite.
Url String Die URL der Unterseite.
WebTemplate String Das WebTemplate der Unterseite.
WelcomePage String Die Willkommensseite der Unterseite.

Benutzer

Fragen Sie die verfügbaren Benutzer auf Ihrer SharePoint-Site ab.

Tabellenspezifische Informationen
Wählen
SELECT * FROM Users // Fetch all the Users

SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group
Spalten
Name Typ Referenzen Beschreibung
AadObjectId_NameId String
AadObjectId_NameIdIssuer String
Email String
Expiration String
IsEmailAuthenticationGuestUser Bool
IsShareByEmailGuestUser Bool
IsSiteAdmin Bool
UserId_NameId String
UserId_NameIdIssuer String
UserPrincipalName String
LinkedAlerts String
LinkedGroups String
LoginName String Der Anmeldename des Benutzers.
Title String Der Titel des Benutzers.
IsHiddenInUI Boolean Ein Boolescher Wert, der angibt, ob der Benutzer in der Benutzeroberfläche ausgeblendet ist.
GroupId Int Die Gruppen-ID, zu der der Benutzer hinzugefügt wird.

Gespeicherte Prozeduren

Gespeicherte Prozeduren* sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Microsoft SharePoint hinaus erweitern.

Gespeicherte Prozeduren* akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Microsoft SharePoint zurück, zusammen mit einer Angabe, ob der Vorgang erfolgreich war oder fehlgeschlagen ist.

Jitterbit-Connector für gespeicherte Prozeduren in Microsoft SharePoint

Name Beschreibung
AddAttachment Fügen Sie einer SharePoint-Liste einen Anhang hinzu.
CheckInDocument Bestimmtes Dokument in der Dokumentbibliothek einchecken.
CheckOutDocument Bestimmtes Dokument in der Dokumentbibliothek auschecken.
CopyDocument Kopiert die Datei zur Ziel URL..
CreateFolder Fügt einer Dokumentbibliothek auf einer SharePoint-Site einen Ordner hinzu.
DeleteAttachment Löscht einen Anhang aus der Sharepoint-Liste.
DeleteDocument Löschen Sie ein Dokument aus der SharePoint-Dokumentbibliothek.
DiscardCheckOutDocument Macht einen vorhandenen Auscheckvorgang für die Datei rückgängig.
DownloadAttachment Laden Sie ein Dokument aus der SharePoint-Liste herunter.
DownloadDocument Laden Sie ein Dokument aus der SharePoint-Bibliothek herunter.
GetAdminConsentURL Ruft die Administratoreinwilligungs URL ab, die von einem Administrator einer bestimmten Domäne separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Nur erforderlich, wenn benutzerdefinierte OAuth-Anmeldeinformationen verwendet werden.
GetCurrentUser Ruft Informationen über den aktuell angemeldeten Benutzer ab.
GetOAuthAccessToken Ruft das OAuth-Zugriffstoken von SharePoint ab.
GetOAuthAuthorizationURL Ruft die SharePoint-Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu SharePoint verwendet werden kann.
MoveAttachmentOrDocument Verschiebt ein Dokument oder einen Anhang von einem Quellordner in einen Zielordner.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei SharePoint verwendet wird.
RenameAttachmentOrDocument Benennt ein Dokument oder einen Anhang um.
UploadDocument Lädt ein Dokument in die SharePoint-Bibliothek hoch.

Anhang hinzufügen

Fügen Sie einen Anhang zu einer SharePoint-Liste hinzu.

Eingang
Name Typ Akzeptiert Eingabeströme Beschreibung
ListTitle String Falsch Titel des Listenelements.
ItemId String Falsch ID des Listenelements.
FileName String Falsch Name der Datei, die zur Dokumentbibliothek hinzugefügt werden soll
InputFilePath String Falsch Speicherort der anzuhängenden Datei.
Content String True Der Inhalt als InputStream, der hochgeladen werden soll, wenn InputFilePath nicht angegeben ist.
Ergebnissatzspalten
Name Typ Beschreibung
RelativeUrl String Relative URL des hinzugefügten Anhangs.
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Dokument einchecken

Ein bestimmtes Dokument in der Dokumentbibliothek einchecken.

Eingang
Name Typ Beschreibung
RelativeURL String Relative URL des Ordners.
DocumentName String Name der einzucheckenden Datei.
Comment String Optionale Nachricht beim Einchecken des Dokuments.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Dokument auschecken

Schauen Sie sich ein bestimmtes Dokument in der Dokumentbibliothek an.

Eingang
Name Typ Beschreibung
RelativeURL String Relative URL des Ordners.
DocumentName String Name der einzucheckenden Datei.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Dokument kopieren

Kopiert die Datei zur Ziel URL.

Eingang
Name Typ Beschreibung
SourceFileRelativeUrl String Relative URL der Quelldatei.
DestFileRelativeUrl String Relative URL der Zieldatei.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Ordner erstellen

Fügt einer Dokumentbibliothek auf einer SharePoint-Site einen Ordner hinzu.

Eingang
Name Typ Beschreibung
RelativeURL String Relative URL des Ordners.
FolderName String Name des zu erstellenden Ordners.
Ergebnissatzspalten
Name Typ Beschreibung
Id String Eindeutiger Identifikator. Wert. Wird nach Abschluss der Operation zurückgegeben.
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Anhang löschen

Löscht einen Anhang aus der Sharepoint-Liste.

Eingang
Name Typ Beschreibung
ListTitle String Titel des Listenelements.
ItemId String ID des Listenelements.
FileName String Name der Datei, die zur Dokumentbibliothek hinzugefügt werden soll
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Dokument löschen

Löschen Sie ein Dokument aus der SharePoint-Dokumentenbibliothek.

Eingang
Name Typ Beschreibung
RelativeURL String Relative URL des Ordners.
DocumentName String Name der zu löschenden Datei.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

VerwerfenCheckOutDocument

Macht einen bestehenden Checkout für die Datei rückgängig.

Eingang
Name Typ Beschreibung
RelativeURL String Relative URL des Ordners.
DocumentName String Name der einzucheckenden Datei.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Anhang herunterladen {: #pg_restsp-downloadattachment}##### Stored Procedure* Spezifische Informationen

Laden Sie ein Dokument aus der SharePoint-Liste herunter.

Gespeicherte Prozedur* Spezifische Informationen
Einfügen

RemoteFile kann relativ zum Server sein oder die vollständige URL der Datei. Nachfolgend einige Beispiele:

EXECUTE DownloadAttachment File = 'C:/Users/User/Desktop/DownloadedFile.txt', RemoteFile = 'https://mysite.sharepoint.com/Lists/MyCustomList/Attachments/1/FileToDownload.txt';

EXECUTE DownloadAttachment File = 'C:/Users/User/Desktop/DownloadedFile.txt', RemoteFile = '/Lists/MyCustomList/Attachments/1/FileToDownload.txt';
Eingabe
Name Typ Akzeptiert Ausgabeströme Beschreibung
File String Falsch Der Pfad der zu speichernden Datei.
RemoteFile String Falsch Der Pfad der Datei auf dem Server. Dies kann die vollständige URL oder einfach der Dateiname sein. Wenn Sie den Namen der Datei verwenden, wird die neueste Version heruntergeladen.
Encoding String Falsch Die Daten werden in der angegebenen Kodierung in FileData ausgegeben. Die zulässigen Werte sind NONE, BASE64. Der Standardwert ist BASE64.
FileStream String True OutputStream zum Schreiben des heruntergeladenen Anhangs. Wird nur verwendet, wenn keine Datei angegeben ist.
ReadTimeout String Falsch Wie viele Sekunden der Download dauern darf. Wenn dieser Wert angegeben wird, schlägt der Download immer fehl, wenn er länger dauert. Im Gegensatz zu Timeout, das nur ausgelöst wird, wenn der Download ins Stocken gerät.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Der heruntergeladene Dateiinhalt. Wird nur zurückgegeben, wenn File und FileStream nicht festgelegt sind.

DownloadDocument

Laden Sie ein Dokument aus der SharePoint-Bibliothek herunter.

Stored Procedure* Spezifische Informationen
Einfügen

RemoteFile kann relativ zur Bibliothek sein oder die vollständige URL der Datei. Nachfolgend einige Beispiele:

EXECUTE DownloadDocument File = 'C:/Users/User/Desktop/DownloadedFile.txt', Library = 'Shared Documents', RemoteFile = 'https://mysite.sharepoint.com/Shared Documents/newFolder/FileToDownload.txt';

EXECUTE DownloadDocument File = 'C:/Users/User/Desktop/DownloadedFile.txt', Library = 'Shared Documents', RemoteFile = '/newFolder/FileToDownload.txt';
Eingabe
Name Typ Akzeptiert Ausgabeströme Beschreibung
File String Falsch Der Pfad der zu speichernden Datei. Sie sollten den neuen Dateinamen angeben. Beispiel: „C:/Benutzer/Benutzer/Desktop/DownloadedFile.txt“.
Library String Falsch Der Name der Bibliothek auf dem SharePoint-Server. Beispiel: „Gemeinsame Dokumente“.
RemoteFile String Falsch Dies kann entweder der relative Pfad zur Bibliothek oder die vollständige URL der Datei sein.
Encoding String Falsch Die Daten werden in der angegebenen Kodierung in FileData ausgegeben. Die zulässigen Werte sind NONE, BASE64. Der Standardwert ist BASE64.
FileStream String True OutputStream zum Schreiben des heruntergeladenen Dokuments. Wird nur zurückgegeben, wenn File nicht festgelegt ist.
ReadTimeout String Falsch Wie viele Sekunden der Download dauern darf. Wenn dieser Wert angegeben wird, schlägt der Download immer fehl, wenn er länger dauert. Im Gegensatz zu Timeout, das nur ausgelöst wird, wenn der Download ins Stocken gerät.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Der heruntergeladene Dateiinhalt. Wird nur zurückgegeben, wenn File und FileStream nicht festgelegt sind.

GetAdminConsentURL

Ruft die Administratoreinwilligungs URL ab, die von einem Administrator einer bestimmten Domäne separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Nur erforderlich, wenn benutzerdefinierte OAuth-Anmeldeinformationen verwendet werden.

Eingabe
Name Typ Beschreibung
CallbackUrl String Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Antwort URL in den Microsoft Entra ID App-Einstellungen übereinstimmen.
State String Derselbe Wert für den Status, den Sie gesendet haben, als Sie den Autorisierungscode angefordert haben.
Scope String Der Umfang oder die Berechtigungen, die Sie vom Administrator anfordern. Der Standardwert ist AllSites.Manage.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren.

GetCurrentUser

Ruft Informationen über den aktuell angemeldeten Benutzer ab.

Ergebnissatzspalten
Name Typ Beschreibung
Id Int Die ID des Benutzers.
Title String Der Titel des Benutzers.
Email String Die Email des Benutzers.
IsSiteAdmin Boolean Ob der Benutzer ein Site-Administrator ist oder nicht.

GetOAuthAccessToken

Ruft das OAuth-Zugriffstoken von SharePoint ab.

Input
Name Typ Beschreibung
AuthMode String Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP und WEB.
Verifier String Das von SharePoint zurückgegebene Prüftoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
CallbackUrl String Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird.
Scope String Der Umfang oder die Berechtigungen, die Sie vom Benutzer anfordern.
State String Jeder Wert, der mit dem Rückruf gesendet werden soll.
Prompt String Die Standardeinstellung ist „select_account“, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, damit keine Eingabeaufforderung erfolgt, auf „login“, damit der Benutzer zur Eingabe seiner Anmeldeinformationen gezwungen wird, oder auf „consent“, damit nach der Anmeldung des Benutzers das OAuth-Zustimmungsdialogfeld ausgelöst wird, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von SharePoint zurückgegebene Authentifizierungstoken.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens in Sekunden.

GetOAuthAuthorizationURL

Ruft die SharePoint-Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu SharePoint verwendet werden kann.

Eingabe
Name Typ Beschreibung
CallbackUrl String Die URL, zu der Sharepoint zurückkehrt, nachdem der Benutzer Ihre App autorisiert hat.
Scope String Der Umfang oder die Berechtigungen, die Sie vom Benutzer anfordern. Der Standardwert ist AllSites.Manage.
State String Jeder Wert, der mit dem Rückruf gesendet werden soll.
Prompt String Die Standardeinstellung ist „select_account“, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, damit keine Eingabeaufforderung erfolgt, auf „login“, damit der Benutzer zur Eingabe seiner Anmeldeinformationen gezwungen wird, oder auf „consent“, damit nach der Anmeldung des Benutzers das OAuth-Zustimmungsdialogfeld ausgelöst wird, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL, die in einen Webbrowser eingegeben werden muss, um das Prüftoken abzurufen und den Datenanbieter damit zu autorisieren.

MoveAttachmentOrDocument

Verschiebt ein Dokument oder einen Anhang von einem Quellordner in einen Zielordner.

Die MoveAttachmentOrDocument gespeicherte Prozedur* erfordert die Parameter SourceFileURL und DestinationFolderURL, um einen Anhang oder ein Dokument zu verschieben.

Beispiel:

EXEC MoveAttachmentOrDocument SourceFileURL = '/Shared Documents/Dummy.txt', DestinationFolderURL = '/Shared Documents/MySite'
Eingabe
Name Typ Beschreibung
SourceFileURL String URL der Quelldatei, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnisdatei: /Shared Documents/filename.txt Unterverzeichnisdatei:/Shared Documents/MyFolder/filename.txt Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der Site, die in der URL angegeben ist.
DestinationFolderURL String URL des Zielordners, in den Sie die Datei verschieben möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnis: /Shared Documents/ Unterverzeichnis:/Shared Documents/MyFolder/ Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der in der URL angegebenen Site.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Wert, der angibt, ob der Operation erfolgreich war.

RefreshOAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung mit SharePoint verwendet wird.

Input
Name Typ Beschreibung
OAuthRefreshToken String Das alte Token, das aktualisiert werden soll.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von SharePoint zurückgegebene Authentifizierungstoken.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.

RenameAttachmentOrDocument

Benennt ein Dokument oder einen Anhang um.

Die RenameAttachmentOrDocument gespeicherte Prozedur* erfordert die Parameter SourceFileURL und NewFileName, um einen Anhang oder ein Dokument umzubenennen.

Beispiel:

EXEC RenameAttachmentOrDocument  SourceFileURL = '/Shared Documents/Dummy.txt', NewFileName = 'Dummy1.txt'
Eingabe
Name Typ Beschreibung
SourceFileURL String URL der Datei, die Sie umbenennen möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammverzeichnisdatei: /Shared Documents/filename.txt Unterverzeichnisdatei:/Shared Documents/MyFolder/filename.txt Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der in der URL angegebenen Site.
NewFileName String Neuer Name der Datei, mit Erweiterung.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Wert, der angibt, ob der Operation erfolgreich war.

UploadDocument

Lädt ein Dokument in die SharePoint-Bibliothek hoch.

Input
Name Typ Akzeptiert Eingabeströme Beschreibung
RelativeUrl String False Die URL des Ordners, in den Sie Dateien hochladen möchten, relativ zur Basis- URL, die in den Verbindungseigenschaften des Connectors angegeben ist. Beispiel: Stammordner: Shared Documents Unterordner: Shared Documents/MyFolder Wenn Sie die Verbindungseigenschaft URL auf eine Sitesammlung festlegen, entspricht die relative URL einem Pfad auf der Basissite. Wenn die Verbindungseigenschaft URL auf eine bestimmte Site verweist, ist die relative URL relativ zu der in der URL angegebenen Site.
InputFilePath String False Der Speicherort der hochzuladenden Datei.
Dateiname Zeichenfolge Falsch Name der zu erstellenden Datei.
Überschreiben String False Boolescher Wert zum Überschreiben der vorhandenen Dateidaten.
Inhalt String True Der Inhalt als InputStream, der hochgeladen werden soll, wenn InputFilePath nicht angegeben ist.
Ergebnissatzspalten
Name Typ Beschreibung
Id String Eindeutiger Identifikator. Wert. Wird nach Abschluss der Operation zurückgegeben.
Status String Meldung, die angibt, ob der Operation erfolgreich war oder nicht.

Systemtabellen

Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.

Schematabellen

Die folgenden Tabellen geben Datenbankmetadaten für Microsoft SharePoint zurück:

Datenquellentabellen

Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:

  • sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
  • sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.

Abfrageinformationstabellen

Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück, einschließlich Charge:

  • Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.

sys_catalogs

Listet die verfügbaren Datenbanken auf.

Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:

SELECT * FROM sys_catalogs
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.

sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.
SchemaName String Der Schema.

sys_tables

Listet die verfügbaren Tabellen auf.

Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:

SELECT * FROM sys_tables
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht.
TableType String Der Tabellentyp (Tabelle oder Ansicht).
Description String Eine Beschreibung der Tabelle oder Ansicht.
IsUpdateable Boolean Ob die Tabelle aktualisiert werden kann.

sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

Die folgende Abfrage gibt die Spalten und Datentypen für die Kalendertabelle zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Calendar' 
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht, die die Spalte enthält.
ColumnName String Der Spaltenname.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Speichergröße der Spalte.
DisplaySize Int32 Die normale Maximalbreite der angegebenen Spalte in Zeichen.
NumericPrecision Int32 Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt.
IsNullable Boolean Ob die Spalte Null enthalten kann.
Description String Eine kurze Beschreibung der Spalte.
Ordinal Int32 Die Sequenznummer der Spalte.
IsAutoIncrement String Ob der Spaltenwert in festen Schritten zugewiesen wird.
IsGeneratedColumn String Ob die Spalte generiert wird.
IsHidden Boolean Ob die Spalte ausgeblendet ist.
IsArray Boolean Ob die Spalte ein Array ist.

sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:

SELECT * FROM sys_procedures
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Das Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur.
Description String Eine Beschreibung der gespeicherten Prozedur.
ProcedureType String Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION.

sys_procedureparameters

Beschreibt gespeicherte Prozedur* Parameter.

Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur ListItems zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='ListItems' AND Direction=1 OR Direction=2
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Der Name des Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur*, das den Parameter enthält.
ColumnName String Der Name der gespeicherten Prozedur* Parameter.
Direction Int32 Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern.
NumericPrecision Int32 Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten.
IsNullable Boolean Ob der Parameter Null enthalten kann.
IsRequired Boolean Ob der Parameter zur Ausführung der Prozedur erforderlich ist.
IsArray Boolean Ob der Parameter ein Array ist.
Description String Die Beschreibung des Parameters.
Ordinal Int32 Der Index des Parameters.

sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Kalendertabelle ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Calendar'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
IsKey Boolean Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird.
IsForeignKey Boolean Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.

sys_foreignkeys

Beschreibt die Fremdschlüssel.

Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.
ForeignKeyType String Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist.

sys_primarykeys

Beschreibt die Primärschlüssel.

Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:

SELECT * FROM sys_primarykeys
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
KeySeq String Die Sequenznummer des Primärschlüssels.
KeyName String Der Name des Primärschlüssels.

sys_indexes

Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.

Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Index enthält.
SchemaName String Der Name des Schema, das den Index enthält.
TableName String Der Name der Tabelle, die den Index enthält.
IndexName String Der Indexname.
ColumnName String Der Name der mit dem Index verknüpften Spalte.
IsUnique Boolean Wahr, wenn der Index eindeutig ist. Andernfalls falsch.
IsPrimary Boolean Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch.
Type Int16 Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3).
SortOrder String Die Sortierreihenfolge: A für aufsteigend oder D für absteigend.
OrdinalPosition Int16 Die Sequenznummer der Spalte im Index.

sys_connection_props

Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:sharepoint:config:

Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.

Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:

SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name Typ Beschreibung
Name String Der Name der Verbindungseigenschaft.
ShortDescription String Eine kurze Beschreibung.
Type String Der Datentyp der Verbindungseigenschaft.
Default String Der Standardwert, sofern nicht explizit einer festgelegt wurde.
Values String Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben.
Value String Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard.
Required Boolean Ob für die Immobilie eine Verbindung erforderlich ist.
Category String Die Kategorie der Verbindungseigenschaft.
IsSessionProperty String Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird.
Sensitivity String Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird.
PropertyName String Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise.
Ordinal Int32 Der Index des Parameters.
CatOrdinal Int32 Der Index der Parameterkategorie.
Hierarchy String Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen.
Visible Boolean Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist.
ETC String Diverse sonstige Informationen zum Objekt.

sys_sqlinfo

Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.

Entdecken Sie die SELECT-Funktionen der Datenquelle

Unten sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.

Name Beschreibung Mögliche Werte
AGGREGATE_FUNCTIONS Unterstützte Aggregatfunktionen. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Ob die COUNT-Funktion unterstützt wird. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. [
IDENTIFIER_QUOTE_CLOSE_CHAR Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. ]
SUPPORTED_OPERATORS Eine Liste unterstützter SQL-Operatoren. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Unterstützte String-Funktionen. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Unterstützte numerische Funktionen. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Unterstützte Datums-/Uhrzeitfunktionen. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Zeigt an, dass während der Replikation Tabellen übersprungen wurden.
REPLICATION_TIMECHECK_COLUMNS Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen.
IDENTIFIER_PATTERN Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist.
SUPPORT_TRANSACTION Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. YES, NO
DIALECT Gibt den zu verwendenden SQL-Dialekt an.
KEY_PROPERTIES Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren.
SUPPORTS_MULTIPLE_SCHEMAS Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. YES, NO
DATASYNCVERSION Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY Die Kategorie „Datensynchronisierung“ dieses Treiber. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Ob Charge Operationen unterstützt werden. YES, NO
SQL_CAP Alle unterstützten SQL-Funktionen für diesen Treiber. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an.
ENABLE_EF_ADVANCED_QUERY Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. YES, NO
PSEUDO_COLUMNS Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt.
MERGE_ALWAYS Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation.
REPLICATION_MIN_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll.
REPLICATION_START_DATE Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben.
REPLICATION_MAX_DATE_QUERY Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation.
REPLICATION_MAX_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird.
CHECKCACHE_USE_PARENTID Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Zeigt gespeicherte Prozeduren*, die zum Generieren von Schema verwendet werden können.

Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; weitere Informationen finden Sie im SOAP Datenmodell Abschnitt für weitere Informationen.

Spalten
Name Typ Beschreibung
NAME String Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann.
VALUE String Details zum unterstützten SQL bzw. zur SQL-Syntax.

sys_identity

Gibt Informationen zu versuchten Änderungen zurück.

Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:

SELECT * FROM sys_identity
Spalten
Name Typ Beschreibung
Id String Die von einer Operation zurückgegebene, von der Datenbank generierte ID.
Batch String Eine Kennung für den Charge. 1 für einen einzelnen Operation.
Operation String Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT.
Message String SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist.

Datentypzuordnung

Datentypzuordnungen

Der Connector ordnet Typen aus der Datenquelle dem entsprechenden im Schema verfügbaren Datentyp zu. Die folgende Tabelle dokumentiert diese Zuordnungen.

Microsoft SharePoint Schema
Choice (menu) Zeichenfolge
Currency schweben
Date and Time Datum/Uhrzeit
Hyperlink or Picture Zeichenfolge
Lookup Zeichenfolge
Multiple lines of text Zeichenfolge
Number schweben
Person or Group Zeichenfolge
Single line of text Zeichenfolge
Task Outcome Zeichenfolge
Yes/No

Erweiterte Konfigurationseigenschaften

Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.

Authentifizierung

Eigenschaft Beschreibung
AuthScheme Das zur Authentifizierung bei SharePoint verwendete Schema.
URL Die Basis URL für die Site.
SharePointEdition Die verwendete SharePoint-Edition. Legen Sie entweder „SharePoint Online“ oder „SharePoint On-Premise“ fest.
User Das zur Authentifizierung verwendete SharePoint-Benutzerkonto.
Password Das zur Authentifizierung des Benutzers verwendete Kennwort.

Azure-Authentifizierung

Eigenschaft Beschreibung
AzureTenant Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standardmandant verwendet.
AzureEnvironment Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung.

SSO

Eigenschaft Beschreibung
SSOLoginURL Die Anmelde URL des Identitätsanbieters.
SSODomain Die Domäne des Benutzers bei Verwendung von Single Sign-On (SSO).
SSOProperties Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.

OAuth

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthAccessToken Der Zugriffstoken für die Verbindung mittels OAuth.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren Add-In-Einstellungen angeben.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
Scope Der für den OAuth-Flow verwendete Bereich, um auf Daten aus der Anwendung zuzugreifen.
State Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.
OAuthGrantType Der Berechtigungstyp für den OAuth-Flow.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

JWT OAuth

Eigenschaft Beschreibung
OAuthJWTCert Der JWT-Zertifikatspeicher.
OAuthJWTCertType Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.
OAuthJWTIssuer Der Herausgeber des Java Web Token.

Kerberos

Eigenschaft Beschreibung
KerberosKDC Der Kerberos Key Distribution Center (KDC)-Dienst, der zur Authentifizierung des Benutzers verwendet wird.
KerberosRealm Der Kerberos-Bereich, der zur Authentifizierung des Benutzers verwendet wird.
KerberosSPN Der Service Principal Name (SPN) für den Kerberos-Domänencontroller.
KerberosKeytabFile Die Keytab-Datei, die Ihre Paare aus Kerberos-Prinzipalen und verschlüsselten Schlüsseln enthält.
KerberosServiceRealm Der Kerberos-Bereich des Dienstes.
KerberosServiceKDC Das Kerberos-KDC des Dienstes.
KerberosTicketCache Der vollständige Dateipfad zu einer Cachedatei für MIT Kerberos-Anmeldeinformationen.

SSL

Eigenschaft Beschreibung
SSLClientCert Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).
SSLClientCertType Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält.
SSLClientCertPassword Das Passwort für das TLS/SSL-Client-Zertifikat.
SSLClientCertSubject Der Betreff des TLS/SSL-Client-Zertifikats.
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

Schema

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.
Schema Der zu verwendende Schema.

Verschiedenes

Eigenschaft Beschreibung
CalculatedDataType Der für berechnete Felder zu verwendende Datentyp.
ContinueOnError Gibt an, ob nach einem Fehler mit der Aktualisierung von Elementen in einem Charge fortgefahren werden soll oder nicht.
CreateIDColumns Gibt an, ob zusätzliche ID-Spalten für SharePoint-Spalten erstellt werden sollen, die Werte aus in anderen Listen gespeicherten Informationen verwenden.
DisableFilterLimit Microsoft SharePoint unterstützt nativ die Auflistung von bis zu 5000 Datensätzen, wie sie in Ihrem Listenfilter erscheinen. Aktivieren Sie diese Eigenschaft, um mehr als 5000 Datensätze aus dem Listenfilter abzurufen. Dies geht jedoch zu Lasten der zusätzlichen Leistung.
FolderOption Eine Option zum Festlegen, wie Ordner in Ergebnissen angezeigt werden. Geben Sie entweder „FilesOnly“, „FilesAndFolders“, „Recursive“ oder „RecursiveAll“ ein.
IncludeLookupColumns Diese Option steuert, ob der Treiber die in einer Tabelle definierten Nachschlagespalten zurückgibt.
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
Pagesize Die maximale Anzahl der Ergebnisse, die pro Seite von Microsoft SharePoint zurückgegeben werden sollen.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
ShowHiddenColumns Boolescher Wert, der bestimmt, ob ausgeblendete Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle ausgeblendeten Spalten aus der Spaltenliste entfernt.
ShowPredefinedColumns Boolescher Wert, der bestimmt, ob vordefinierte Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle von einem Basistyp abgeleiteten Spalten aus der Spaltenliste entfernt.
ShowVersionViews Geben Sie an, ob die Ansicht der Listenversionen angezeigt werden soll. Beispielsweise ListA_Versions.
STSURL Die URL des Security Token Service (STS) bei Verwendung von Single Sign-On (SSO).
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UseDisplayNames Boolescher Wert, der bestimmt, ob in SOAP und REST-Schemas die Anzeigenamen für die Spalten anstelle der API -Namen verwendet werden sollen.
UseEntityTypeName Boolescher Wert, der bestimmt, ob der Tabellenname im REST- Schema„EntityTypeName“ statt des Titels sein soll.
UseNTLMV1 Bestimmt, ob der Treiber versucht, eine Verbindung mit NTLMv1 oder NTLMv2 herzustellen (Standard).
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.
UseSimpleNames Boolescher Wert, der bestimmt, ob für Tabellen und Spalten einfache Namen verwendet werden sollen.

Authentifizierung

Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
AuthScheme Das zur Authentifizierung bei SharePoint verwendete Schema.
URL Die Basis URL für die Site.
SharePointEdition Die verwendete SharePoint-Edition. Legen Sie entweder „SharePoint Online“ oder „SharePoint On-Premise“ fest.
User Das zur Authentifizierung verwendete SharePoint-Benutzerkonto.
Password Das zur Authentifizierung des Benutzers verwendete Kennwort.

AuthScheme

Das Schema, das zur Authentifizierung bei SharePoint verwendet wird.

Datentyp

string

Standardwert

NTLM

Bemerkungen

Bei der Authentifizierung gegenüber der Sharepoint On-Premise-Instanz zusammen mit Passwort und Benutzer, wird dieses Feld zur Authentifizierung gegenüber dem Server verwendet. NTLM ist die Standardoption. Verwenden Sie die folgenden Optionen, um Ihr Authentifizierungsschema auszuwählen:

  • NTLM: Legen Sie dies fest, um Ihre Windows Anmeldeinformationen zur Authentifizierung zu verwenden.
  • Verhandeln: Wenn AuthScheme auf Aushandeln eingestellt ist, verhandelt der Connector einen Authentifizierungsmechanismus mit dem Server. Setzen Sie AuthScheme um auszuhandeln, ob Sie die Kerberos-Authentifizierung verwenden möchten.
  • Keine: Legen Sie dies fest, um eine anonyme Authentifizierung zu verwenden, beispielsweise für den Zugriff auf eine öffentliche Site.
  • Basic: Legen Sie dies fest, um die HTTP-Basic-Authentifizierung zu verwenden.
  • ADFS: Legen Sie dies fest, um die Single Sign-On-Authentifizierung mit ADFS zu verwenden.

Bei der Authentifizierung gegenüber Sharepoint Online ist OAuth die Standardoption. Verwenden Sie die folgenden Optionen, um Ihr Authentifizierungsschema auszuwählen:

  • Microsoft Entra ID: Legen Sie dies fest, um die Microsoft Entra ID -OAuth-Authentifizierung durchzuführen.
  • AzurePassword: Legen Sie dies fest, um die Authentifizierung per OAuth mit Password GrantType durchzuführen.
  • OAuthJWT: Wenn AuthScheme auf OAuthJWT eingestellt ist, versucht der Connector, eine Verbindung mit einem selbstsignierten Zertifikat mit der Microsoft Entra ID herzustellen.
  • PingFederate: Legen Sie dies fest, um die Single Sign-On-Authentifizierung mit PingFederate zu verwenden.
  • ADFS: Legen Sie dies fest, um die Single Sign-On-Authentifizierung mit ADFS zu verwenden.
  • OneLogin: Legen Sie dies fest, um die Single Sign-On-Authentifizierung mit OneLogin zu verwenden.
  • OKTA: Legen Sie dies fest, um die Single Sign-On-Authentifizierung mit OKTA zu verwenden.
  • OAuth: Legen Sie dies fest, um die OAuth 2-Authentifizierung mit GrantType CODE oder PASSWORD zu verwenden.
  • AzureMSI: Legen Sie dies fest, um beim Ausführen auf einer Azure-VM automatisch Anmeldeinformationen für die verwaltete Dienstidentität abzurufen.
  • SharePointOAuth: Legen Sie dies fest, um die OAuth-Authentifizierung mit der Sharepoint-App für Client-Anmeldeinformationen zu verwenden.

URL

Die Basis URL für die Site.

Datentyp

string

Standardwert

""

Bemerkungen

Nachfolgend sind Beispiele für gültige URLs aufgeführt:

  • http://server/SharePoint/- http://server/Sites/mysite/- http://server:90/

Der Anbieter verwendet URL um URLs für andere Aufrufe des Servers abzuleiten.

SharePointEdition

Die verwendete SharePoint-Edition. Legen Sie entweder „SharePoint Online“ oder „SharePoint On-Premise“ fest.

Datentyp

string

Standardwert

SharePoint OnPremise

Bemerkungen

Die verwendete SharePoint-Edition. Legen Sie entweder SharePoint Online oder SharePoint On-Premise fest.

Benutzer

Das zur Authentifizierung verwendete SharePoint-Benutzerkonto.

Datentyp

string

Standardwert

""

Bemerkungen

Zusammen mit Passwort, dieses Feld wird zur Authentifizierung gegenüber dem SharePoint-Server verwendet.

Für SharePoint On-Premise sollte der Benutzer die Domäne enthalten und sieht ungefähr so aus: DOMAIN\Benutzername.

Für SharePoint Online sieht der Benutzer ungefähr so aus: username@domain.onmicrosoft.com.

Passwort

Das Passwort, das zur Authentifizierung des Benutzers verwendet wird.

Datentyp

string

Standardwert

""

Bemerkungen

Der Benutzer Und Password werden zusammen zur Authentifizierung beim Server verwendet.

Azure-Authentifizierung

Dieser Abschnitt enthält eine vollständige Liste der Azure-Authentifizierungseigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
AzureTenant Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standardmandant verwendet.
AzureEnvironment Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung.

AzureTenant

Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standard-Mandant verwendet.

Datentyp

string

Standardwert

""

Bemerkungen

Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Beispiel: contoso.onmicrosoft.com. Alternativ können Sie die Mandanten-ID angeben. Dieser Wert ist die Verzeichnis-ID im Azure-Portal > Microsoft Entra ID > Eigenschaften.

Normalerweise ist es nicht notwendig, den Mandanten anzugeben. Dies kann von Microsoft automatisch ermittelt werden, wenn der OAuthGrantType verwendet wird auf CODE (Standard) eingestellt. Es kann jedoch fehlschlagen, wenn der Benutzer mehreren Mandanten angehört. Zum Beispiel, wenn ein Administrator von Domäne A einen Benutzer von Domäne B als Gastbenutzer einlädt. Der Benutzer gehört nun beiden Mandanten an. Es ist eine gute Praxis, den Mandanten anzugeben, obwohl es im Allgemeinen funktionieren sollte, ohne ihn angeben zu müssen.

AzureTenant ist beim Festlegen von OAuthGrantType erforderlich zu CLIENT. Bei der Verwendung von Client-Anmeldeinformationen gibt es keinen Benutzerkontext. Die Anmeldeinformationen werden aus dem Kontext der App selbst übernommen. Microsoft erlaubt zwar weiterhin den Abruf von Client-Anmeldeinformationen ohne Angabe des Mandanten, aber die Wahrscheinlichkeit, den spezifischen Mandanten auszuwählen, mit dem Sie arbeiten möchten, ist viel geringer. Aus diesem Grund benötigen wir AzureTenant muss bei allen Client-Anmeldeinformationen-Verbindungen ausdrücklich angegeben werden, um sicherzustellen, dass Sie Anmeldeinformationen erhalten, die für die Domäne gelten, mit der Sie eine Verbindung herstellen möchten.

AzureUmgebung

Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung.

Mögliche Werte

GLOBAL, CHINA, USGOVT, USGOVTDOD

Datentyp

string

Standardwert

GLOBAL

Bemerkungen

In den meisten Fällen funktioniert es, die Umfeld auf global eingestellt zu lassen. Wenn Sie Ihr Azure-Konto jedoch einer anderen Umfeld hinzugefügt haben, können Sie verwenden AzureEnvironment um die Umfeld anzugeben. Die verfügbaren Werte sind GLOBAL, CHINA, USGOVT, USGOVTDOD.

Verwenden Sie diese Eigenschaft, um Probleme mit dem URL Suffix zu beheben (z. B. setzen Sie es auf USGOVT, wenn Ihre URL auf .us endet), je nachdem, welche Cloud Sie verwenden. Weitere Informationen zu dieser Einstellung finden Sie in der Microsoft-Dokumentation zu nationalen Clouds

SSO

Dieser Abschnitt enthält eine vollständige Liste der SSO-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
SSOLoginURL Die Anmelde URL des Identitätsanbieters.
SSODomain Die Domäne des Benutzers bei Verwendung von Single Sign-On (SSO).
SSOProperties Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.

SSOLoginURL

Die Anmelde-URL des Identitätsanbieters.

Datentyp

string

Standardwert

""

Bemerkungen

Die Anmelde-URL des Identitätsanbieters.

SSODomain

Die Domäne des Benutzers bei Verwendung von Single Sign-On (SSO).

Datentyp

string

Standardwert

""

Bemerkungen

Diese Eigenschaft ist nur anwendbar, wenn Single Sign-On (AuthScheme verwendet wird ist für die Verwendung eines SSO-Authentifizierungsschemas konfiguriert) und wenn die Domäne des Benutzers (z. B. user@mydomain.com) unterscheidet sich von der im SSO-Dienst konfigurierten Domäne (z. B. user@myssodomain.com).

Diese Eigenschaft kann bei Verwendung der SSO-Dienste ADFS, OneLogin oder OKTA erforderlich sein.

SSOProperties

Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.

Datentyp

string

Standardwert

""

Bemerkungen

Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste. wird in Verbindung mit SSOLoginURL verwendet.

Die SSO-Konfiguration wird ausführlicher unter erläutert.

OAuth

Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthAccessToken Der Zugriffstoken für die Verbindung mittels OAuth.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren Add-In-Einstellungen angeben.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
Scope Der für den OAuth-Flow verwendete Bereich, um auf Daten aus der Anwendung zuzugreifen.
State Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.
OAuthGrantType Der Berechtigungstyp für den OAuth-Flow.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

InitiateOAuth

Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens zu starten, wenn Sie eine Verbindung herstellen.

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

OFF

Bemerkungen

Folgende Optionen stehen zur Verfügung:

  1. OFF: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.
  2. GETANDREFRESH: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.
  3. REFRESH: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshTokens selbst übernehmen.

OAuthClientId

Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Bemerkungen

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.

OAuthClientSecret

Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Bemerkungen

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret Eigenschaft.

OAuthAccessToken

Der Zugriffstoken für die Verbindung über OAuth.

Datentyp

string

Standardwert

""

Bemerkungen

Die OAuthAccessToken Eigenschaft wird für die Verbindung über OAuth verwendet. Die OAuthAccessToken wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es verfügt über ein serverabhängiges Timeout und kann zwischen Anfragen wiederverwendet werden.

Der Zugriffstoken wird anstelle Ihres Benutzernamens und Kennworts verwendet. Der Zugriffstoken schützt Ihre Anmeldeinformationen, indem er sie auf dem Server speichert.

Rückruf-URL

Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren Add-In-Einstellungen angeben.

Datentyp

string

Standardwert

""

Bemerkungen

Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren Add-In-Einstellungen angeben.

OAuthSettingsLocation

Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

%APPDATA%\SharePoint Data Provider\OAuthSettings.txt

Bemerkungen

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.

Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_props Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

Der Standardspeicherort ist „%APPDATA%\SharePoint Data Provider\OAuthSettings.txt“ mit %APPDATA% auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."
  • Mac: "%AppData%..."

wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.

Die folgende Tabelle listet den Wert von auf %APPDATA% nach Operationssystem:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Mac ~/Bibliothek/Anwendungsunterstützung
Linux ~/.config

Bereich

Der Bereich, der für den OAuth-Flow verwendet wird, um auf Daten aus der Anwendung zuzugreifen.

Mögliche Werte

NONE, AllSites.Manage, AllSites.Read, AllSites.Write, .default

Datentyp

string

Standardwert

NONE

Bemerkungen

Der für den OAuth-Flow verwendete Bereich, um auf Daten aus der Anwendung zuzugreifen.

Hinweis

Wenn nicht angegeben oder auf „NONE“ belassen, legt der Connector den Standardbereich abhängig von OAuthGrantType fest. Der Standardwert ist „AllSites.Manage“, sofern nicht JWT OAuth, Microsoft Entra-Dienstprinzipal oder CLIENT-Berechtigungstyp verwendet werden. Die verfügbaren Werte sind:

  • AllSites.Read: Ermöglicht das Lesen benutzerdefinierter Listen
  • AllSites.Write: Ermöglicht das Lesen und Schreiben von benutzerdefinierten Listen
  • AllSites.Manage: Ermöglicht das Lesen, Schreiben und Erstellen benutzerdefinierter Listen
  • .default: Fordert Anwendungsberechtigungen ohne Benutzerkontext an. Alle Anwendungsberechtigungen, die für diese Web API erteilt wurden, sind im abgerufenen OAuthAccessToken enthalten.

Status

Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.

Datentyp

string

Standardwert

""

Bemerkungen

Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.

OAuthGrantType

Der Berechtigungstyp für den OAuth-Flow.

Mögliche Werte

CODE, PASSWORD, SAML_1, CLIENT

Datentyp

string

Standardwert

CLIENT

Bemerkungen

Folgende Optionen stehen zur Verfügung: CODE,PASSWORD,SAML_1,CLIENT

OAuthVerifier

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.

Datentyp

string

Standardwert

""

Bemerkungen

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.

Authentifizierung auf Headless-Maschinen

Siehe, um die zu erhalten OAuthVerifier Wert.

OAuthSettingsLocation festlegen zusammen mit OAuthVerifier. Beim Verbinden tauscht der Connector die OAuthVerifier für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.

Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.

Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.

OAuthRefreshToken

Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.

Datentyp

string

Standardwert

""

Bemerkungen

Die OAuthRefreshToken Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.

OAuthExpiresIn

Die Lebensdauer des OAuth-AccessTokens in Sekunden.

Datentyp

string

Standardwert

""

Bemerkungen

Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann das AccessToken abläuft.

OAuthTokenTimestamp

Der Unix-Epochen-Zeitstempel in Millisekunden, als das aktuelle AccessToken erstellt wurde.

Datentyp

string

Standardwert

""

Bemerkungen

Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.

JWT OAuth

Dieser Abschnitt enthält eine vollständige Liste der JWT OAuth-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
OAuthJWTCert Der JWT-Zertifikatspeicher.
OAuthJWTCertType Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.
OAuthJWTIssuer Der Herausgeber des Java Web Token.

OAuthJWTCert

Der JWT-Zertifikatspeicher.

Datentyp

string

Standardwert

""

Bemerkungen

Der Name des Zertifikatspeichers für das Client-Zertifikat.

Der OAuthJWTCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an OAuthJWTCert. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in OAuthJWTCertPassword an.

OAuthJWTCert wird in Verbindung mit OAuthJWTCertSubject verwendet

Feld, um Client-Zertifikate anzugeben. Wenn OAuthJWTCert hat einen Wert und OAuthJWTCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Bitte beachten Sie das OAuthJWTCertSubject für weitere Einzelheiten.

Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.

Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:

Eigenschaft Beschreibung
MY Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält.
CA Zertifikate der Zertifizierungsstelle.
ROOT Stammzertifikate.
SPC Zertifikate von Softwareherstellern.

In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.

Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei (d. h. PKCS12-Zertifikatsspeicher) gesetzt werden.

OAuthJWTCertType

Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.

Datentyp

string

Standardwert

USER

Bemerkungen

Diese Eigenschaft kann einen der folgenden Werte annehmen:

Eigenschaft Beschreibung
USER Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar.
MACHINE Für Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar.
PFXFILE Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält.
PFXBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt.
JKSFILE Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Hinweis: Dieser Speichertyp ist nur in Java verfügbar.
JKSBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im Java Key Store-Format (JKS) darstellt. Hinweis: Dieser Speichertyp ist nur in Java verfügbar.
PEMKEY_FILE Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PEMKEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
PUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
SSHPUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält.
SSHPUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält.
P7BFILE Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält.
PPKFILE Der Zertifikatsspeicher ist der Name einer Datei, die einen PPK (PuTTY Private Key) enthält.
XMLFILE Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält.
XMLBLOB Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält.

OAuthJWTIssuer

Der Aussteller des Java Web Token.

Datentyp

string

Standardwert

""

Bemerkungen

Der Aussteller des Java Web Token. In den meisten Fällen wird hier der Wert der Verbindungseigenschaft OAuth App ID (Client-ID) verwendet und muss nicht einzeln festgelegt werden.

Kerberos

Dieser Abschnitt enthält eine vollständige Liste der Kerberos-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
KerberosKDC Der Kerberos Key Distribution Center (KDC)-Dienst, der zur Authentifizierung des Benutzers verwendet wird.
KerberosRealm Der Kerberos-Bereich, der zur Authentifizierung des Benutzers verwendet wird.
KerberosSPN Der Service Principal Name (SPN) für den Kerberos-Domänencontroller.
KerberosKeytabFile Die Keytab-Datei, die Ihre Paare aus Kerberos-Prinzipalen und verschlüsselten Schlüsseln enthält.
KerberosServiceRealm Der Kerberos-Bereich des Dienstes.
KerberosServiceKDC Das Kerberos-KDC des Dienstes.
KerberosTicketCache Der vollständige Dateipfad zu einer Cachedatei für MIT Kerberos-Anmeldeinformationen.

KerberosKDC

Der Kerberos Key Distribution Center (KDC)-Dienst, der zur Authentifizierung des Benutzers verwendet wird.

Datentyp

string

Standardwert

""

Bemerkungen

Die Kerberos-Eigenschaften werden bei Verwendung von SPNEGO oder Windows Authentifizierung verwendet. Der Connector fordert Sitzungstickets und temporäre Sitzungsschlüssel vom Kerberos-KDC-Dienst an. Der Kerberos-KDC-Dienst befindet sich üblicherweise am selben Standort wie der Domänencontroller.

Wenn Kerberos KDC nicht angegeben ist, versucht der Connector, diese Eigenschaften automatisch an den folgenden Standorten zu erkennen:

  • KRB5 Config File (krb5.ini/krb5.conf): Wenn die Umfeld KRB5_CONFIG gesetzt ist und die Datei existiert, ruft der Connector den KDC aus der angegebenen Datei ab. Andernfalls versucht er, basierend auf dem Operationssystem vom Standard-MIT-Speicherort zu lesen: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) oder /etc/krb5.conf (Linux).
  • Java System Properties: Verwenden der Systemeigenschaften java.security.krb5.realm Und java.security.krb5.kdc.
  • Domain Name and Host: Wenn Kerberos Realm und Kerberos KDC nicht von einem anderen Standort abgeleitet werden konnten, leitet der Connector sie vom konfigurierten Domänennamen und Host ab.

Notiz

Die Windows Authentifizierung wird nur in JRE 1.6 und höher unterstützt.

Die Kerberos-Eigenschaften werden bei Verwendung von SPNEGO oder Windows Authentifizierung verwendet. Der Connector fordert Sitzungstickets und temporäre Sitzungsschlüssel vom Kerberos-KDC-Dienst an. Der Kerberos-KDC-Dienst befindet sich üblicherweise am selben Standort wie der Domänencontroller.

Wenn Kerberos KDC nicht angegeben ist, versucht der Connector, diese Eigenschaften automatisch an den folgenden Standorten zu erkennen:

  • KRB5 Config File (krb5.ini/krb5.conf): Wenn die Umfeld KRB5_CONFIG gesetzt ist und die Datei existiert, ruft der Connector den KDC aus der angegebenen Datei ab. Andernfalls versucht er, basierend auf dem Operationssystem vom Standard-MIT-Speicherort zu lesen: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) oder /etc/krb5.conf (Linux).
  • Java System Properties: Verwenden der Systemeigenschaften java.security.krb5.realm Und java.security.krb5.kdc.
  • Domain Name and Host: Wenn Kerberos Realm und Kerberos KDC nicht von einem anderen Standort abgeleitet werden konnten, leitet der Connector sie vom konfigurierten Domänennamen und Host ab.

Notiz

Die Windows Authentifizierung wird nur in JRE 1.6 und höher unterstützt.

KerberosRealm

Der Kerberos-Bereich, der zur Authentifizierung des Benutzers verwendet wird.

Datentyp

string

Standardwert

""

Bemerkungen

Die Kerberos-Eigenschaften werden bei Verwendung von SPNEGO oder Windows-Authentifizierung verwendet. Der Kerberos-Bereich wird verwendet, um den Benutzer mit dem Kerberos Key Distribution Service (KDC) zu authentifizieren. Der Kerberos-Bereich kann von einem Administrator als beliebige Zeichenfolge konfiguriert werden, basiert jedoch üblicherweise auf dem Domänennamen.

Wenn kein Kerberos-Bereich angegeben ist, versucht der Connector, diese Eigenschaften automatisch an den folgenden Standorten zu erkennen:

  • KRB5 Config File (krb5.ini/krb5.conf): Wenn die Umfeld KRB5_CONFIG gesetzt ist und die Datei existiert, erhält der Connector den Standardbereich aus der angegebenen Datei. Andernfalls versucht er, basierend auf dem Operationssystem vom MIT-Standardspeicherort zu lesen: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) oder /etc/krb5.conf (Linux)
  • Java System Properties: Verwenden der Systemeigenschaften java.security.krb5.realm Und java.security.krb5.kdc.
  • Domain Name and Host: Wenn der Kerberos-Realm und der Kerberos-KDC nicht von einem anderen Standort abgeleitet werden konnten, leitet der Connector sie vom benutzerkonfigurierten Domänennamen und Host ab. Dies kann in einigen Windows Umgebungen funktionieren.

Hinweis

Kerberos-basierte Authentifizierung wird nur in JRE 1.6 und höher unterstützt.

KerberosSPN

Der Service Principal Name (SPN) für den Kerberos-Domänencontroller.

Datentyp

string

Standardwert

""

Bemerkungen

Wenn der SPN auf dem Kerberos-Domänencontroller nicht mit der URL übereinstimmt, bei der Sie sich authentifizieren, verwenden Sie diese Eigenschaft, um den SPN festzulegen.

Wenn der SPN auf dem Kerberos-Domänencontroller nicht mit der URL übereinstimmt, bei der Sie sich authentifizieren, verwenden Sie diese Eigenschaft, um den SPN festzulegen.

KerberosKeytabFile

Die Keytab-Datei, die Ihre Paare aus Kerberos-Prinzipalen und verschlüsselten Schlüsseln enthält.

Datentyp

string

Standardwert

""

Bemerkungen

Die Keytab-Datei, die Ihre Paare aus Kerberos-Prinzipalen und verschlüsselten Schlüsseln enthält.

KerberosServiceRealm

Der Kerberos-Bereich des Dienstes.

Datentyp

string

Standardwert

""

Bemerkungen

Die KerberosServiceRealm ist die Angabe des Kerberos-Realms des Dienstes bei Verwendung einer realmübergreifenden Kerberos-Authentifizierung.

In den meisten Fällen werden ein einzelner Realm und eine KDC-Maschine zur Durchführung der Kerberos-Authentifizierung verwendet und diese Eigenschaft ist nicht erforderlich.

Diese Eigenschaft ist für komplexe Setups verfügbar, bei denen ein anderer Realm und eine andere KDC-Maschine zum Abrufen eines Authentifizierungstickets (AS-Anforderung) und eines Diensttickets (TGS-Anforderung) verwendet werden.

KerberosServiceKDC

Das Kerberos-KDC des Dienstes.

Datentyp

string

Standardwert

""

Bemerkungen

Die KerberosServiceKDC wird verwendet, um den Dienst Kerberos KDC anzugeben, wenn eine bereichsübergreifende Kerberos-Authentifizierung verwendet wird.

In den meisten Fällen werden ein einzelner Bereich und eine KDC-Maschine verwendet, um die Kerberos-Authentifizierung durchzuführen, und diese Eigenschaft ist nicht erforderlich.

Diese Eigenschaft ist für komplexe Setups verfügbar, bei denen ein anderer Bereich und eine andere KDC-Maschine verwendet werden, um ein Authentifizierungsticket (AS-Anforderung) und ein Dienstticket (TGS-Anforderung) zu erhalten.

KerberosTicketCache

Der vollständige Dateipfad zu einer MIT Kerberos-Anmeldeinformationscachedatei.

Datentyp

string

Standardwert

""

Bemerkungen

Diese Eigenschaft kann festgelegt werden, wenn Sie eine Anmeldeinformations-Cachedatei verwenden möchten, die mit dem MIT Kerberos Ticket Manager oder dem Befehl kinit erstellt wurde.

SSL

Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
SSLClientCert Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).
SSLClientCertType Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält.
SSLClientCertPassword Das Passwort für das TLS/SSL-Client-Zertifikat.
SSLClientCertSubject Der Betreff des TLS/SSL-Client-Zertifikats.
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

SSLClientCert

Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).

Datentyp

string

Standardwert

""

Bemerkungen

Der Name des Zertifikatspeichers für das Client-Zertifikat.

Der SSLClientCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an SSLClientCert. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in SSLClientCertPassword an.

SSLClientCert wird in Verbindung mit SSLClientCertSubject verwendet, um Client-Zertifikate anzugeben. Wenn SSLClientCert hat einen Wert und SSLClientCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Siehe SSLClientCertSubject für weitere Informationen.

Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.

Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:

Eigenschaft Beschreibung
MY Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält.
CA Zertifikate der Zertifizierungsstelle.
ROOT Stammzertifikate.
SPC Zertifikate von Softwareherstellern.

In Java ist der Zertifikatspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.

Wenn der Zertifikatspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei gesetzt werden (z. B. PKCS12-Zertifikatspeicher).

SSLClientCertType

Der Typ des Schlüsselspeichers, der das TLS/SSL-Clientzertifikat enthält.

Mögliche Werte

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Datentyp

string

Standardwert

USER

Bemerkungen

Diese Eigenschaft kann einen der folgenden Werte annehmen:

Eigenschaft Beschreibung
USER - default Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist.
MACHINE Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist.
PFXFILE Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält.
PFXBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt.
JKSFILE Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist.
JKSBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (base-64-codiert), die einen Zertifikatsspeicher im JKS-Format darstellt. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist.
PEMKEY_FILE Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PEMKEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
PUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
SSHPUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält.
SSHPUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält.
P7BFILE Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält.
PPKFILE Der Zertifikatsspeicher ist der Name einer Datei, die einen privaten PuTTY-Schlüssel (PPK) enthält.
XMLFILE Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält.
XMLBLOB Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält.

SSLClientCertPassword

Das Passwort für das TLS/SSL-Client-Zertifikat.

Datentyp

string

Standardwert

""

Bemerkungen

Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort zum Öffnen des Zertifikatspeichers anzugeben.

SSLClientCertSubject

Der Betreff des TLS/SSL-Clientzertifikats.

Datentyp

string

Standardwert

*

Bemerkungen

Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu finden.

Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten. Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und es wird kein Zertifikat ausgewählt.

Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.

Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Beispiel: „CN=www.server.com, OU=test, C=US, E=support@company.com“. Die allgemeinen Felder und ihre Bedeutungen werden unten angezeigt.

Feld Bedeutung
CN Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com.
O Organisation
OU Organisationseinheit
L Ort
S Staat
C Land
E Email Adresse

Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.

SSLServerCert

Das vom Server zu akzeptierende Zertifikat bei einer Verbindung über TLS/SSL.

Datentyp

string

Standardwert

""

Bemerkungen

Wenn Sie eine TLS/SSL-Verbindung verwenden, können Sie mit dieser Eigenschaft das TLS/SSL-Zertifikat angeben, das vom Server akzeptiert werden soll. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.

Diese Eigenschaft kann folgende Formen annehmen:

Beschreibung Beispiel
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält C:\cert.cer
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
Der MD5-Fingerabdruck (Hexadezimalwerte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) ecadbdda5a1529c58a1e9e09828d70e4
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.

Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).

Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.

Schema

Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.
Schema Der zu verwendende Schema.

Standort

Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.

Datentyp

string

Standardwert

%APPDATA%\SharePoint Data Provider\Schema

Bemerkungen

Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.

Notiz

Da dieser Connector mehrere Schemas unterstützt, ist die Struktur für benutzerdefinierte Schema von Microsoft SharePoint wie folgt:

  • Jedem Schema wird ein Ordner zugewiesen, der diesem Schema entspricht.
  • Diese Schema sind in einem übergeordneten Ordner enthalten.
  • Der parent folder sollte als gesetzt werden Location, nicht der Ordner eines einzelnen Schemas.

Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\SharePoint Data Provider\Schema“ mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Mac ~/Bibliothek/Anwendungsunterstützung
Linux ~/.config

BrowsableSchemas

Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Datentyp

string

Standardwert

""

Bemerkungen

Das Auflisten der Schemata aus Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.

Tabellen

Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.

Datentyp

string

Standardwert

""

Bemerkungen

Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären, mit denen Sie arbeiten könnten.

Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Ansichten

Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.

Datentyp

string

Standardwert

""

Bemerkungen

Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung mit einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Schema

Der zu verwendende Schema.

Mögliche Werte

SOAP, REST

Datentyp

string

Standardwert

SOAP

Bemerkungen

Die verfügbaren Schemas sind REST (zur Verwendung der SharePoint-REST- API) und SOAP (zur Verwendung der SharePoint-SOAP API).

Verschiedenes

Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
CalculatedDataType Der für berechnete Felder zu verwendende Datentyp.
ContinueOnError Gibt an, ob nach einem Fehler mit der Aktualisierung von Elementen in einem Charge fortgefahren werden soll oder nicht.
CreateIDColumns Gibt an, ob zusätzliche ID-Spalten für SharePoint-Spalten erstellt werden sollen, die Werte aus in anderen Listen gespeicherten Informationen verwenden.
DisableFilterLimit Microsoft SharePoint unterstützt nativ die Auflistung von bis zu 5000 Datensätzen, wie sie in Ihrem Listenfilter erscheinen. Aktivieren Sie diese Eigenschaft, um mehr als 5000 Datensätze aus dem Listenfilter abzurufen. Dies geht jedoch zu Lasten der zusätzlichen Leistung.
FolderOption Eine Option zum Festlegen, wie Ordner in Ergebnissen angezeigt werden. Geben Sie entweder „FilesOnly“, „FilesAndFolders“, „Recursive“ oder „RecursiveAll“ ein.
IncludeLookupColumns Diese Option steuert, ob der Treiber die in einer Tabelle definierten Nachschlagespalten zurückgibt.
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
Pagesize Die maximale Anzahl der Ergebnisse, die pro Seite von Microsoft SharePoint zurückgegeben werden sollen.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
ShowHiddenColumns Boolescher Wert, der bestimmt, ob ausgeblendete Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle ausgeblendeten Spalten aus der Spaltenliste entfernt.
ShowPredefinedColumns Boolescher Wert, der bestimmt, ob vordefinierte Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle von einem Basistyp abgeleiteten Spalten aus der Spaltenliste entfernt.
ShowVersionViews Geben Sie an, ob die Ansicht der Listenversionen angezeigt werden soll. Beispielsweise ListA_Versions.
STSURL Die URL des Security Token Service (STS) bei Verwendung von Single Sign-On (SSO).
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UseDisplayNames Boolescher Wert, der bestimmt, ob in SOAP und REST-Schemas die Anzeigenamen für die Spalten anstelle der API -Namen verwendet werden sollen.
UseEntityTypeName Boolescher Wert, der bestimmt, ob der Tabellenname im REST- Schema„EntityTypeName“ statt des Titels sein soll.
UseNTLMV1 Bestimmt, ob der Treiber versucht, eine Verbindung mit NTLMv1 oder NTLMv2 herzustellen (Standard).
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.
UseSimpleNames Boolescher Wert, der bestimmt, ob für Tabellen und Spalten einfache Namen verwendet werden sollen.

CalculatedDataType

Der für berechnete Felder zu verwendende Datentyp.

Mögliche Werte

Calculated, Boolean, Date, DateTime, Double, Integer, String

Datentyp

string

Standardwert

Calculated

Bemerkungen

Der für berechnete Felder zu verwendende Datentyp. Standardmäßig (Berechnet) wird der Datentyp durch den Typ des berechneten Felds in SharePoint bestimmt. In einigen Fällen können diese berechneten Felder jedoch Werte zurückgeben, die für den angegebenen Typ nicht geeignet sind. In diesen Fällen möchten Sie den berechneten Datentyp möglicherweise auf den entsprechenden Typ festlegen.

Bei Fehler fortfahren

Gibt an, ob nach einem Fehler mit der Aktualisierung von Elementen in einem Charge fortgefahren werden soll.

Datentyp

bool

Standardwert

true

Bemerkungen

Wenn diese Eigenschaft auf True (Standard) gesetzt ist, wird der Connector weiterhin Elemente hinzufügen, aktualisieren oder löschen, wenn bei einem der Elemente ein Fehler auftritt. Wenn sie auf False gesetzt ist, wird der Connector das Hinzufügen, Aktualisieren oder Löschen von Elementen beenden, nachdem ein Fehler aufgetreten ist (Einträge vor dem problematischen Eintrag werden weiterhin hinzugefügt, aktualisiert oder gelöscht).

CreateIDColumns

Gibt an, ob zusätzliche ID-Spalten für SharePoint-Spalten erstellt werden sollen, die Werte aus in anderen Listen gespeicherten Informationen verwenden.

Datentyp

bool

Standardwert

true

Bemerkungen

Gibt an, ob zusätzliche ID-Spalten für SharePoint-Spalten erstellt werden sollen, die Werte aus in anderen Listen gespeicherten Informationen verwenden (z. B. Spalten „Nachschlagen“ oder „Person oder Gruppe“). Die erstellte ID-Spalte enthält die ID des zugehörigen Eintrags (im Kontext seiner ursprünglichen Liste). Wenn diese Eigenschaft auf „false“ gesetzt ist, werden die ID-Spalten nicht erstellt, die ID wird ignoriert und nur der Wert der referenzierten Spalte wird zurückgegeben.

DisableFilterLimit

Microsoft SharePoint unterstützt nativ das Auflisten von bis zu 5000 Datensätzen, wie sie in Ihrem Listenfilter erscheinen. Aktivieren Sie diese Eigenschaft, um mehr als 5000 Datensätze aus dem Listenfilter zu ziehen, was jedoch zu zusätzlichen Leistungseinbußen führt.

Datentyp

bool

Standardwert

false

Bemerkungen

Unabhängig davon, ob diese Eigenschaft auf „true“ oder „false“ gesetzt ist, wird für Listenfilter mit 5.000 oder weniger Datensätzen die serverseitige Verarbeitung von Listenfilterabfragen von Microsoft SharePoint unterstützt, was zu der schnellstmöglichen Leistung führt.

Wenn diese Eigenschaft auf „true“ gesetzt ist und der Listenfilter 5.000 Einträge überschreitet, verarbeitet der Connector die Abfrage clientseitig, was zusätzliche Leistungseinbußen mit sich bringt.

Wenn diese Eigenschaft jedoch auf „false“ gesetzt ist und der Listenfilter 5000 Einträge überschreitet, führt der Connector die Abfrage aus der Liste selbst aus (und nicht aus dem Listenfilter). Dies führt dazu, dass der Spaltensatz im Abfrage die Spalten in der Liste und nicht den Listenfilter widerspiegelt.

Ordneroption

Eine Option zum Festlegen, wie Ordner in Ergebnissen angezeigt werden. Geben Sie entweder „FilesOnly“, „FilesAndFolders“, „Recursive“ oder „RecursiveAll“ ein.

Mögliche Werte

FilesOnly, FilesAndFolders, RecursiveAll

Datentyp

string

Standardwert

RecursiveAll

Bemerkungen

Eine Option zum Festlegen, wie Ordner in Ergebnissen angezeigt werden. „FilesOnly“ zeigt nur Dateien in angegebenen Listen oder Bibliotheken an. „FilesAndFolders“ zeigt Dateien und Ordner in der angegebenen Liste an. „RecursiveAll“ zeigt Dateien in der angegebenen Liste und allen Unterordnern an.

IncludeLookupColumns

Diese Option steuert, ob der Treiber die in einer Tabelle definierten Nachschlagespalten zurückgibt.

Datentyp

bool

Standardwert

true

Bemerkungen

Mit dieser Option wird gesteuert, ob der Treiber die in einer Tabelle definierten Nachschlagespalten zurückgibt. Der SharePoint-Server lehnt die Anforderung möglicherweise ab, wenn eine einzelne Abfrage zu viele Nachschlagespalten enthält.

MaxRows

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Datentyp

int

Standardwert

-1

Bemerkungen

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Andere

Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.

Datentyp

string

Standardwert

""

Bemerkungen

Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.

Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.

Integration und Formatierung
Eigenschaft Beschreibung
DefaultColumnSize Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000.
ConvertDateTimeToGMT Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen.
RecordToFile=filename Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei.

Seitengröße

Die maximale Anzahl von Ergebnissen, die pro Seite von Microsoft SharePoint zurückgegeben werden sollen.

Datentyp

int

Standardwert

1000

Bemerkungen

Die Pagesize Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von Microsoft SharePoint zurückgegeben werden. Das Festlegen eines höheren Wertes kann zu einer besseren Leistung führen, allerdings auf Kosten des zusätzlichen Speichers, der pro verbrauchter Seite zugewiesen wird.

PseudoColumns

Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.

Datentyp

string

Standardwert

""

Bemerkungen

Diese Einstellung ist besonders hilfreich im Entity Framework, wo Sie keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.

ShowHiddenColumns

Boolescher Wert, der bestimmt, ob ausgeblendete Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle ausgeblendeten Spalten aus der Spaltenliste entfernt.

Datentyp

bool

Standardwert

false

Bemerkungen

Boolescher Wert, der bestimmt, ob ausgeblendete Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle ausgeblendeten Spalten aus der Spaltenliste entfernt.

ShowPredefinedColumns

Boolescher Wert, der bestimmt, ob vordefinierte Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle von einem Basistyp abgeleiteten Spalten aus der Spaltenliste entfernt.

Datentyp

bool

Standardwert

true

Bemerkungen

Boolescher Wert, der bestimmt, ob vordefinierte Spalten angezeigt werden sollen oder nicht. Wenn „false“, werden alle von einem Basistyp abgeleiteten Spalten aus der Spaltenliste entfernt. Diese Spalten sind normalerweise Systemspalten wie „CreatedBy“ und „Author“. Vordefinierte Spalten können jedoch auch allgemeine Spalten wie „Title“ enthalten.

ShowVersionViews

Geben Sie an, ob die Ansicht von Listenversionen angezeigt werden soll. Wie z. B. „ListA_Versions“.

Datentyp

bool

Standardwert

false

Bemerkungen

Geben Sie an, ob die Ansicht der Listenversionen angezeigt werden soll. Beispielsweise ListA_Versions.

STSURL

Die URL des Sicherheitstokendienstes (STS) bei Verwendung von Single Sign-On (SSO).

Datentyp

string

Standardwert

""

Bemerkungen

Die URL des Security Token Service (STS) bei Verwendung von Single Sign-On (SSO). Diese muss nur selten explizit festgelegt werden.

Zeitüberschreitung

Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.

Datentyp

int

Standardwert

60

Bemerkungen

Wenn Timeout = 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.

Wenn Timeout abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.

UseDisplayNames

Boolescher Wert, der bestimmt, ob in SOAP und REST-Schemas die Anzeigenamen für die Spalten anstelle der API -Namen verwendet werden sollen.

Datentyp

bool

Standardwert

true

Bemerkungen

Boolescher Wert, der bestimmt, ob die Anzeigenamen für die Spalten anstelle der API -Namen verwendet werden sollen. Im REST- Schema funktioniert diese Eigenschaft mit allen Listen. Beachten Sie, dass die Aktivierung die Leistung beeinträchtigen und den Spaltendatentyp ändern kann.

UseEntityTypeName

Boolescher Wert, der bestimmt, ob der Tabellenname im REST- Schema„EntityTypeName“ statt des Titels sein soll.

Datentyp

bool

Standardwert

false

Bemerkungen

Boolescher Wert, der bestimmt, ob der Tabellenname im REST- Schema„EntityTypeName“ statt des Titels sein soll.

UseNTLMV1

Bestimmt, ob der Treiber versucht, eine Verbindung mit NTLMv1 oder NTLMv2 herzustellen (Standard).

Datentyp

bool

Standardwert

false

Bemerkungen

Bestimmt, ob der Treiber versucht, eine Verbindung mit NTLMv1 oder NTLMv2 herzustellen (Standard).

Benutzerdefinierte Ansichten

Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Datentyp

string

Standardwert

""

Bemerkungen

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

UseSimpleNames

Boolescher Wert, der bestimmt, ob einfache Namen für Tabellen und Spalten verwendet werden sollen.

Datentyp

bool

Standardwert

false

Bemerkungen

Microsoft SharePoint-Tabellen und-Spalten können Sonderzeichen in Namen verwenden, die in Standarddatenbanken normalerweise nicht zulässig sind. UseSimpleNames macht den Connector mit herkömmlichen Datenbanktools einfacher zu verwenden.

Einstellung UseSimpleNames auf true vereinfacht die Namen der zurückgegebenen Tabellen und Spalten. Es wird ein Benennungsschema erzwungen, sodass nur alphanumerische Zeichen und der Unterstrich für die angezeigten Tabellen- und Spaltennamen gültig sind. Alle nicht alphanumerischen Zeichen werden in einen Unterstrich umgewandelt.