Zum Inhalt springen

Details zur Microsoft Excel Online Verbindung

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8803 des Connectors.

Erste Schritte

Unterstützung der Microsoft Excel Online Version

Der Connector modelliert Tabellen und Bereiche als bidirektionale Tabellen, die mit SQL abgefragt werden können.

Herstellen einer Verbindung

Herstellen einer Verbindung mit Microsoft Excel Online

Für die Verbindung mit der Microsoft Excel Online Datenquelle stehen zwei Authentifizierungsmethoden zur Verfügung:

  • OAuth 2.0-basierte Methoden: Microsoft Excel Online bietet OAuth 2.0-basierte Authentifizierung sowohl über die Entra-ID als auch über den Microsoft Entra-Dienstprinzipal.
    • Für die Entra-ID-Authentifizierung setzen Sie AuthScheme Zu AzureAD.
    • Für die Microsoft Entra-Dienstprinzipalauthentifizierung legen Sie fest AuthScheme Zu AzureServicePrincipal.
  • Managed Service Identity (MSI)-Authentifizierung. Um diese Methode zu verwenden, setzen Sie AuthScheme Zu AzureMSI.
Microsoft Entra ID

Entra ID ist eine benutzerbasierte Authentifizierung. Es werden Anmeldeinformationen bereitgestellt, um Microsoft Entra ID über eine Desktop-Anwendung mit Microsoft Excel Online zu verbinden. Um die eingebetteten Anmeldeinformationen zur Authentifizierung zu verwenden, lassen Sie die OAuth-Anmeldeinformationen (OAuthClientId Und OAuthClientSecret) leer.

Für die Verbindung über eine Webanwendung müssen Sie eine benutzerdefinierte OAuth Entra ID-Anwendung erstellen. Durch die Erstellung einer benutzerdefinierten Entra ID-Anwendung werden die OAuth-Anmeldeinformationen festgelegt OAuthClientId Und OAuthClientSecret. Eine Erläuterung zum Erstellen einer benutzerdefinierten Microsoft Entra ID Anwendung und Gründe, warum dies vorteilhaft sein kann, auch wenn Sie die Verbindung nicht über eine Webanwendung herstellen, finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Microsoft Entra-Dienstprinzipal

Die Authentifizierung als Microsoft Entra-Dienstprinzipal wird über den OAuth-Clientanmeldeinformationsfluss abgewickelt. Es handelt sich dabei nicht um eine direkte Benutzerauthentifizierung. Stattdessen werden Anmeldeinformationen nur für die Anwendung selbst erstellt. Alle von der App ausgeführten Aufgaben werden ohne Standardbenutzerkontext, sondern basierend auf den zugewiesenen Rollen ausgeführt. Der Anwendungszugriff auf die Ressourcen wird über die Berechtigungen der zugewiesenen Rollen gesteuert.

Erstellen Sie eine Microsoft Entra ID App und einen Microsoft Entra-Dienstprinzipal

Wenn Sie sich mit einem Microsoft Entra-Dienstprinzipal authentifizieren, müssen Sie eine Entra-ID-Anwendung erstellen und bei einem Entra-ID-Mandanten registrieren. Siehe Erstellen einer benutzerdefinierten OAuth-Anwendung für weitere Einzelheiten.

In Ihrer App-Registrierung in portal.azure.com, navigieren Sie zu API Berechtigungen und wählen Sie die Microsoft Graph permissions. Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.

Der Anwendung eine Rolle zuweisen

Um auf Ressourcen in Ihrem Abonnement zuzugreifen, müssen Sie der Anwendung eine Rolle zuweisen.

  1. Öffnen Sie das Subscriptions Seite, indem Sie den Abonnementdienst in der Suchleiste suchen und auswählen.
  2. Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
  3. Öffnen Sie die Access control (IAM) und wählen Sie Add > Add role assignment zum Öffnen der Add role assignment Seite.
  4. Wählen Sie Owner als Rolle, die Ihrer erstellten Entra ID-App zugewiesen werden soll.

Authentifizierung abschließen

Wählen Sie, ob Sie ein Clientgeheimnis oder ein Zertifikat verwenden möchten, und befolgen Sie die entsprechenden Schritte unten.

Client-Geheimnis

Legen Sie die folgenden Verbindungseigenschaften fest:

  • AuthScheme: AzureServicePrincipal um ein Client-Geheimnis zu verwenden.
  • InitiateOAuth: GETANDREFRESH. Sie können verwenden InitiateOAuth um den OAuth-Austausch und das manuelle Setzen der zu vermeiden OAuthAccessToken.
  • AzureTenant: Der Mandant, mit dem Sie sich verbinden möchten.
  • OAuthClientId: Die Client-ID in Ihren Anwendungseinstellungen.
  • OAuthClientSecret: Das Client-Geheimnis in Ihren Anwendungseinstellungen.

Zertifikat

Legen Sie diese Verbindungseigenschaften fest:

  • AuthScheme: AzureServicePrincipalCert um ein Zertifikat zu verwenden.
  • InitiateOAuth: GETANDREFRESH. Sie können verwenden InitiateOAuth um eine Wiederholung des OAuth-Austauschs und das manuelle Festlegen des OAuthAccessTokens zu vermeiden.
  • AzureTenant: Der Mandant, mit dem Sie sich verbinden möchten.
  • OAuthJWTCert: Der JWT-Zertifikatspeicher.
  • OAuthJWTCertType: Der Typ des Zertifikatspeichers angegeben durch OAuthJWTCert.

Sie sind jetzt bereit, eine Verbindung herzustellen. Die Authentifizierung mit Client-Anmeldeinformationen erfolgt automatisch wie bei jeder anderen Verbindung, außer dass kein Fenster geöffnet wird, das den Benutzer auffordert. Da kein Benutzerkontext vorhanden ist, ist kein Browser-Popup erforderlich. Verbindungen werden hergestellt und intern gehandhabt.

Verwaltete Dienstidentität (MSI)

Wenn Sie Microsoft Excel Online auf einer Azure-VM ausführen und MSI zur Verbindung nutzen möchten, setzen Sie AuthScheme Zu AzureMSI.

Vom Benutzer verwaltete Identitäten

Um ein Token für eine verwaltete Identität zu erhalten, verwenden Sie OAuthClientId Eigenschaft zur Angabe der „client_id“ der verwalteten Identität.

Wenn Ihre VM über mehrere benutzerzugewiesene verwaltete Identitäten verfügt, müssen Sie außerdem angeben OAuthClientId.

Herstellen einer Verbindung mit einer Arbeitsmappe

Der Connector stellt Arbeitsmappen und Arbeitsblätter von Laufwerken bereit, die Sie in Ihrem Microsoft-Konto angeben. Sie können eine Verbindung mit einer Arbeitsmappe herstellen, indem Sie sich bei Excel Online authentifizieren und eine der folgenden Eigenschaften festlegen.

So steuern Sie, welche Laufwerke erkannt werden:

  • Drive: Die ID eines bestimmten Laufwerks. Sie können die Ansichten „Laufwerke“ und „SharePointSites“ verwenden, um alle Sites und Laufwerke anzuzeigen, auf die Sie Zugriff haben.
  • SharepointURL: Die Browser-URL einer SharePoint-Site. Der Treiber stellt alle Laufwerke unter der Site bereit.
  • OAuthClientId: Wenn AuthScheme ist gesetzt auf AzureServicePrincipal oder wenn OAuthGrantType ist gesetzt auf CLIENT, das mit Ihrer OAuth-App verknüpfte Laufwerk wird freigegeben.

Wenn keines der oben genannten Elemente angegeben ist, ist der Zugriff auf das persönliche Laufwerk des authentifizierten Benutzers beschränkt.

So steuern Sie, welche Arbeitsmappen und Arbeitsblätter freigegeben werden ODER welche Laufwerke freigegeben werden:

  • Workbook: Der Name oder die ID der Arbeitsmappe. Ein authentifizierter Benutzer kann eine Liste mit Informationen zu den verfügbaren Arbeitsmappen anzeigen, indem er eine Abfrage an die Ansicht „Arbeitsmappen“ ausführt.
  • UseSandbox: True um eine Verbindung zu einer Arbeitsmappe in einem Sandbox-Konto herzustellen; andernfalls leer lassen.
  • BrowsableSchemas: Eine Liste der anzuzeigenden Laufwerksnamen.
  • Tables: Eine Liste der anzuzeigenden Tabellennamen.

Ausführen von SQL für Arbeitsblattdaten

Informationen zum Ausführen von SQL zur Datenmanipulation für Arbeitsblätter und Bereiche finden Sie unter:

Einzelheiten dazu, wie der Connector Arbeitsblätter und Zellen als Tabellen und Spalten modelliert, finden Sie unter Datenmodell.

Abrufen von Daten aus SharePoint-Excel Dateien

Um Daten aus Sharepoint-Excel Dateien abzurufen, setzen Sie die SharepointURL Verbindungseigenschaft zur URL Ihrer Sharepoint-Site. Beispiel:

SharepointURL=https://mysite.sharepoint.com/

Der Treiber sucht automatisch nach jeder Dokumentbibliothek, die Sie in SharePoint haben, und listet sie als Schema auf. Einzelne Excel Arbeitsmappen und-Arbeitsblätter werden als Tabellen im Format Arbeitsmappe_Arbeitsblatt unter ihrer entsprechenden Dokumentbibliothek aufgelistet. Dies funktioniert auf die gleiche Weise wie das Auflisten Ihrer eigenen persönlichen Excel Dokumente, wenn SharepointURL ist nicht gesetzt.

Erstellen einer benutzerdefinierten OAuth-Anwendung

Erstellen einer benutzerdefinierten OAuth-Anwendung

Microsoft Excel Online unterstützt die Authentifizierung mit Entra ID und Microsoft Entra Service Principal, die beide OAuth-basiert sind.

In diesem Thema wird Folgendes beschrieben:

  • Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für Entra ID oder Microsoft Entra-Dienstprinzipal
  • Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
  • Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID

In portal.azure.com:

  1. Melden Sie sich an bei https://portal.azure.com.
  2. Wählen Sie im linken Navigationsbereich Microsoft Entra ID, Dann applicationRegistrations.
  3. Klicken Sie auf New registration.
  4. Geben Sie einen Namen für die Anwendung ein.
  5. Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
    • Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die AzureTenant Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft Excel Online-Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl.
    • Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an Accounts in this organization directory only.
    • Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
  6. Setzen Sie die Weiterleitungs URL auf http://localhost:33333 (Standard des Connectors) ODER geben Sie einen anderen Port an und setzen Sie CallbackURL an die genaue Antwort-URL, die Sie definiert haben.
  7. Klicken Sie auf Register, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
    Notieren Sie den Wert in Application (client) ID als OAuthClientId und das Directory (tenant) ID als AzureTenant.
  8. Navigieren Sie zu Certificates & Secrets und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.
    • Für die Zertifikatauthentifizierung: In Certificates & Secrets, wählen Upload certificate, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch.
    • Zum Erstellen eines neuen Client-Geheimnisses: In Certificates & Secrets, wählen New Client Secret für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft Excel Online den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zum OAuthClientSecret.
  9. Auswählen API Permissions > Add > Delegated permissions.
  10. Fügen Sie die folgenden Anwendungsberechtigungen hinzu: Sites.Read.All, Files.Read, Files.Read.All, Files.Read.Selected, Files.ReadWrite, Files.ReadWrite.All, Files.ReadWrite.AppFolder, Files.ReadWrite.Selected und offline_access.
  11. Speichern Sie Ihre Änderungen.
  12. Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal

Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.

Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.

In portal.azure.com:

  1. Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
  2. Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
  3. Öffnen Sie die Subscriptions Seite.
  4. Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
  5. Öffnen Sie die Access control (IAM).
  6. Auswählen Add > Add role assignment. Microsoft Excel Online öffnet das Add role assignment Seite.
  7. Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu Owner.

Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.

So erteilen Sie die Administratoreinwilligung:

  1. Lassen Sie einen Administrator sich anmelden bei portal.azure.com.
  2. Navigieren Sie zu App Registrations und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben.
  3. Unter API Permissions, klick Grant Consent.

Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.

OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.

Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.

Hinweis

Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht

in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.

In portal.azure.com:

  1. Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
  2. Navigieren Sie zu App Registrations.
  3. Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie API Permissions.
  4. Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
  5. Unter Application Permissions, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.

Wählen Sie ExcelOnline-Daten

Die folgenden Verbindungseigenschaften ermöglichen Ihnen die Ausführung von SELECT-Abfragen, die der Organisation Ihres Blatts möglichst genau entsprechen.

Spaltenüberschriften auswählen

Wenn Ihr Arbeitsblatt Spaltenüberschriften hat, können Sie die Header Eigenschaft, um Spaltennamen zu verwenden, die in einer Header definiert sind. Dann können Sie wie folgt Abfrage:

SELECT Id, Name, Item, Quantity, Amount FROM Test_xlsx_Sheet1 WHERE Amount = 50

Die obige Abfrage geht davon aus, dass die erste Zeile des Arbeitsblatts die Spaltennamen „ID“, „Name“, „Menge“ und „Betrag“ enthält. Das Arbeitsblatt kann mehr Spalten enthalten als ausgewählt wurden und die Reihenfolge kann beliebig sein.

Alphabetische Spalten auswählen

Wenn eine Arbeitsmappe keine Headern hat oder Sie die Headern ignorieren möchten, können Sie das setzen Header-Eigenschaft auf „false“. In diesem Fall wird jede Spalte durch alphabetische Namen dargestellt. Beispiel:

SELECT A, B, C, D FROM Test_xlsx_Sheet1 WHERE D = 50

Bereiche auswählen

Anstatt mit der Tabelle als einzelner Tabelle zu arbeiten, können Sie mit Bereichen als Tabellen arbeiten. Einige Beispiele: In einer spärlich gefüllten Arbeitsmappe können Sie Bereiche verwenden, um Daten ohne die leeren Zeilen auszuwählen. Oder in einem Arbeitsblatt, das nicht oben links ausgerichtet ist, können Sie einen Bereich verwenden, um Daten in der Mitte des Blatts auszuwählen.

Um einen Datenbereich auf dem Arbeitsblatt auszuwählen, hängen Sie den Bereich mit dem Zeichen # an den Tabellennamen an. Beispielsweise wählt der folgende Befehl den Zellbereich zwischen A1 und E5 aus:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Um einem Bereich einen Tabellennamen zuzuweisen und die wiederholte Angabe des Bereichs zu vermeiden, siehe Tables Eigentum.

ExcelOnline-Daten einfügen

Sie können INSERT-Anweisungen ausführen, wenn Sie mit Arbeitsblättern als Tabellen arbeiten. Sie können die aus einer Header erkannten Spaltennamen angeben oder die alphabetischen Spaltennamen in Excel Online angeben. Sie können auch konfigurieren, wie der Connector die Eingabewerte in Microsoft Excel Online Zellenformate analysiert.

Setzen Sie den Header Eigenschaft zum Konfigurieren von Spaltennamen. Festlegen ValueInputOption zum Konfigurieren der Eingabeanalyse.

Beachten Sie, dass das Einfügen in Bereiche nicht unterstützt wird. Verwenden Sie stattdessen Batch-Einfügungen oder temporäre Tabellen.

Einfügen mit Überschriften

Wenn der Header-Eigenschaft auf „true“ gesetzt ist, können Sie Zellen in einer Header als Spaltennamen angeben.

INSERT INTO Test_xlsx_Sheet1 (Name, Amount) VALUES ('Test', 10)

Einfügen ohne Überschriften

Wenn der Header Eigenschaft ist auf „false“ gesetzt, geben Sie die alphabetischen Spaltennamen an.

INSERT INTO Test_xlsx_Sheet1 (A, B) VALUES ('Test', 10)

Konfigurieren der Eingabeanalyse

Standardmäßig analysiert der Connector alle Werte, die Sie in die SQL-Anweisung eingeben, so, als ob Sie die Eingabe in der Microsoft Excel Online-Benutzeroberfläche vorgenommen hätten. Beispielsweise können Zeichenfolgen in Zahlen, Daten usw. konvertiert werden.

Um die Analyse der Eingabewerte zu deaktivieren, setzen Sie ValueInputOption. Siehe außerdem Verwenden von Formeln, um die Formelauswertung zu konfigurieren.

Beispiel: Masseneinfügungen mit temporären Tabellen

Wenn temporäre Tabellen verwendet werden, müssen diese innerhalb derselben Verbindung definiert und eingefügt werden. Durch Schließen der Verbindung werden alle temporären Tabellen im Speicher gelöscht.

Temporäre Tabellen erstellen

Fügen Sie die benötigten Zeilen in eine temporäre Tabelle ein. Fügen Sie dann alle Zeilen aus dieser temporären Tabelle in die eigentliche Tabelle ein.

Codebeispiel

Nachfolgend finden Sie den vollständigen Code zum Einfügen von 2 Zeilen in Test_xlsx_Sheet1:

Connection conn = DriverManager.getConnection("jdbc:excelonline:InitiateOAuth=GETANDREFRESH;");
Statement stat = conn.createStatement();

stat.executeUpdate("INSERT INTO`[Test_xlsx_Sheet1#TEMP] `(Column1, Column2) VALUES ('value1', 'value2')");
stat.executeUpdate("INSERT INTO`[Test_xlsx_Sheet1#TEMP] `(Column1, Column2) VALUES ('value3', 'value4')");

stat.executeUpdate("INSERT INTO`[Test_xlsx_Tabelle1] `(Column1, Column2) SELECT Column1, Column2 FROM [Test_xlsx_Sheet1#TEMP]");

stat.close();

ExcelOnline-Daten aktualisieren

In UPDATE-Anweisungen können Sie die aus einer Header erkannten Spaltennamen angeben oder die alphabetischen Spaltennamen in Microsoft Excel Online angeben. Sie können auch konfigurieren, wie der Connector die Eingabewerte in Microsoft Excel Online Zellenformate analysiert.

Setzen Sie den Header Eigenschaft zum Konfigurieren von Spaltennamen. Der Primärschlüssel ist die Zeilennummer. Geben Sie den Primärschlüssel mit der ID-Spalte an. Set ValueInputOption um die Eingabeanalyse zu konfigurieren.

Update mit Headern

Wenn der Header-Eigenschaft auf „true“ gesetzt ist, aktualisieren Sie Spalten, indem Sie die erkannten Spaltennamen angeben.

UPDATE Customers SET Col1='value' WHERE Id=7

Update ohne Header

Wenn der Header ist auf „false“ gesetzt, geben Sie die alphabetischen Spaltennamen an:

UPDATE Customers SET H='value' WHERE Id=7

Bereiche aktualisieren

Legen Sie die Spalten entsprechend dem Bereich fest und geben Sie die Zeilennummer als ID an:

UPDATE`[Kunden#A15:C15] `SET A='Ana Trujilo', B='Northwind, Inc.', C='100,000' WHERE Id='15'

Konfigurieren der Eingabeanalyse

Standardmäßig analysiert der Connector alle Werte, die Sie in die SQL-Anweisung eingeben, so, als ob Sie die Eingabe in der Microsoft Excel Online-Benutzeroberfläche vorgenommen hätten. Beispielsweise können Zeichenfolgen in Zahlen, Daten usw. konvertiert werden.

Um die Analyse der Eingabewerte zu deaktivieren, setzen Sie ValueInputOption. Siehe außerdem Verwenden von Formeln, um die Formelauswertung zu konfigurieren.

ExcelOnline-Daten löschen

Wenn Sie eine ganze Datenzeile löschen, müssen Sie unbedingt die Tabellendaten aktualisieren. Dies liegt daran, dass die IDs auf Zeilenbasis zugewiesen werden. Wenn es beispielsweise fünf Zeilen mit den IDs 1 bis 5 gibt und Sie Zeile 3 löschen, wird Zeile 4 zu 3 und 5 zu 4.

Verwenden Sie Formeln

Legen Sie die folgenden Eigenschaften fest, um die Formelauswertung beim Ausführen von SELECT-, INSERT- und UPDATE-Anweisungen zu konfigurieren.

Formeln auswählen

Der Connector kann entweder das Ergebnis der Formel oder die Formel selbst zurückgeben. Konfigurieren Sie dieses Verhalten mit ValueRenderOption Verbindungseigenschaft.

Einfügen und Aktualisieren von Formeln

Satz AllowFormula auf true, um Formeln einzufügen (Standard). Andernfalls werden alle in Einfügungen und Aktualisierungen verwendeten Werte als Zeichenfolgenliterale eingefügt.

Zum Beispiel mit AllowFormula auf true gesetzt, fügt das Folgende eine Formel in die Spalte B ein, die die Zellen B1:B5 summiert:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Hinweis

Wenn AllowFormula auf true gesetzt ist, wird jede Spalte, die eine Formel enthält, als Typ String angezeigt, unabhängig von der Einstellung TypeDetectionScheme.

Wichtige Hinweise

Konfigurationsdateien und ihre Pfade

  • Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des Microsoft Excel Online-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 Excel Online und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Benutzerdefinierte Ansichten

Mit dem Microsoft Excel Online Connector 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 Test_xlsx_Sheet1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die 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 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.

Datenmodell

Arbeitsmappen als Tabellen

Der Connector modelliert die Arbeitsblätter und Bereiche in Ihren Arbeitsmappen als bidirektionale Tabellen. Wenn Sie eine Verbindung herstellen, ruft der Connector die Metadaten aus Microsoft Excel Online ab und spiegelt alle Änderungen an den Tabellenschemata wider.

Schnellstarts zum Ausführen von SQL für die Tabellen finden Sie im Abschnitt „Erste Schritte“. Dieser Abschnitt enthält zusätzliche Details zum Connectorverhalten.

Tabellen

In diesem Abschnitt erfahren Sie mehr darüber, wie der Connector die Tabellen modelliert. Siehe Spalten für Einzelheiten zur Spaltenerkennung.

Gespeicherte Prozeduren

Zusätzlich zur Arbeit mit den Daten in der Arbeitsmappe können Sie die verfügbaren gespeicherten Prozeduren verwenden, um auf Funktionen in der Microsoft Excel Online API zuzugreifen, die nicht als SELECT-, INSERT-, UPDATE- oder DELETE-Anweisungen modelliert sind. Beispielsweise die Anweisung AddWorksheet gespeicherte Prozedur.

Systemtabellen

Abfrage der verfügbaren Systemtabellen, um auf die verfügbaren Connector-Metadaten, einschließlich Schema, zuzugreifen.

Bewährte Vorgehensweisen

1) Wenn Sie derzeit viele Arbeitsmappen oder Tabellen in Ihrem Konto haben, kann es lange dauern, bis alle Daten abgerufen werden. Sie können diese Zeit verkürzen, indem Sie das Workbook Verbindungseigenschaft zu Ihrer Verbindungszeichenfolge.

2) Wenn Sie nach INSERT oder BATCH INSERT eine SELECT Operation ausführen, warten Sie unbedingt 3-5 Sekunden, bevor Sie sie ausführen. Die API benötigt einige Sekunden, um alle Daten zu registrieren, die Sie der Datenbank hinzufügen. Daher ist das Warten erforderlich, um Teilergebnisse zu vermeiden.

Schemas

Der Connector stellt Arbeitsblätter aus Arbeitsmappen als Tabellen bereit. Dazu stellt er die Laufwerke, die diese Arbeitsmappen und Arbeitsblätter enthalten, als Schemata für diese Tabellen bereit. Wie Laufwerke als Schemata bereitgestellt werden, hängt von den Verbindungseigenschaften für den Connector ab.

Die folgenden Verbindungseigenschaften legen fest, welche Laufwerke vom Treiber als Schemata verfügbar gemacht werden. Sie werden in der Reihenfolge ihrer Priorität aufgelistet, wobei nur die Eigenschaft mit der höchsten Priorität zum Verfügbarmachen von Schemata verwendet wird:

  • Drive: Setzen Sie dies auf die ID eines bestimmten Laufwerks. Nur dieses Laufwerk wird als Schema angezeigt.
  • SharepointURL: Legen Sie dies auf die Browser-URL einer SharePoint-Site fest. Der Treiber zeigt alle Laufwerke unter der Site an. Alle diese Laufwerke werden als Schemata angezeigt.
  • OAuthClientId: Wenn AuthScheme ist gesetzt auf AzureServicePrincipal oder wenn OAuthGrantType ist gesetzt auf CLIENT, das mit Ihrer OAuth-App verknüpfte Laufwerk wird angezeigt. Nur dieses Laufwerk wird als Schema angezeigt.
  • Wenn keine der oben genannten Optionen angegeben ist, wird das persönliche Laufwerk des authentifizierten Benutzers verwendet. Nur dieses Laufwerk wird als Schema angezeigt.

Sie können die Ansichten „Laufwerke“ und „SharePointSites“ verwenden, um alle Sites und Laufwerke anzuzeigen, auf die Sie Zugriff haben.

Wenn Sie die Schemata filtern möchten, die der Treiber bereitstellt, können Sie den BrowsableSchemas Verbindungseigenschaft. Geben Sie für diese Eigenschaft eine Liste mit Laufwerksnamen an. Die Filterung erfolgt clientseitig, d. h. die angegebenen Namen sollten die Namen sein, die normalerweise vom Connector für die Laufwerke zurückgegeben werden.

Tabellen

Der Connector ermöglicht es Ihnen, ein oben links ausgerichtetes Arbeitsblatt oder einen benutzerdefinierten Bereich als Datenbanktabelle darzustellen.

Oben links ausgerichtete Arbeitsblätter

Sie können den Connector verwenden, um sofort mit der Arbeit mit oben links ausgerichteten Arbeitsblättern zu beginnen:

  • Der Tabellenname für ein oben links ausgerichtetes Arbeitsblatt ist der Name des Arbeitsblatts.
  • Standardmäßig gibt der Connector alle Zeilen bis zur ersten leeren Zeile zurück. Hinweis: Eine leere Zeile zwischen den Daten verhindert die Rückgabe weiterer Daten.
  • Die erste Datenzeile im Arbeitsblatt kann die Spaltennamen enthalten. Siehe Spalten für weitere Informationen.

Benutzerdefinierte Bereiche

Bereichsnotation ist nur in einer SELECT- oder UPDATE-Anweisung verfügbar. Bereiche werden für DELETE- und INSERT-Befehle nicht unterstützt.

Sie können SELECT- oder UPDATE-Befehle für einen bestimmten Bereich mit einer Referenz im folgenden Format ausführen: WORKSHEET#RANGE. Sie können auch festlegen Tables-Eigenschaft, um einem Bereich einen Tabellennamen zuzuweisen.

Beispielsweise wählt der folgende Befehl den Zellbereich zwischen A1 und E5 aus:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Auf freigegebene Dokumente als Datenbanktabelle zugreifen

Sie können die Verbindungseigenschaft verwenden ShowSharedDocuments um freigegebene Excel-Arbeitsmappen als Datenbanktabellen aufzulisten. Die Tabellen werden neben den Arbeitsmappen aufgelistet, die dem Benutzer gehören.

Ausführen von SQL für Arbeitsblattdaten

Weitere Informationen zum Ausführen von SQL zur Datenmanipulation für Arbeitsblätter und Bereiche finden Sie im Folgenden:

Spalten

Wenn Sie eine Verbindung herstellen, erkennt der Connector die verfügbaren Spalten und spiegelt sowohl Änderungen in Microsoft Excel Online als auch Konfigurationsänderungen wider, die Sie mit den folgenden Verbindungseigenschaften vornehmen. Informationen zum Konfigurieren von Aspekten der Spaltenerkennung, die für Microsoft Excel Online spezifisch sind, finden Sie in den folgenden Abschnitten.

Konfigurieren der Spaltennamenerkennung

Sie können festlegen Header um Spaltennamen in einer Header zu erkennen, oder Sie können Spalten alphabetisch referenzieren.

Header=True (Standard)

Nachfolgend finden Sie weitere Einzelheiten dazu, wie der Connector Spaltennamen aus einer Header erkennt, wenn Header ist auf true gesetzt.

  • Der Connector ermittelt Spalten aus der ersten Zeile des Arbeitsblatts. Wenn für die erste Zeile des Arbeitsblatts keine Werte angegeben sind, erstellt der Connector eindeutige, alphabetisch geordnete Spaltennamen, die nur im Rahmen dieser Anfrage verfügbar sind.
  • Überschriften dürfen keine Sonderzeichen enthalten.
  • Aufgrund einer Einschränkung der Excel Online API dürfen keine der Spaltenüberschriften leer sein.
Header=Falsch

Wann Header ist auf „false“ gesetzt, alphabetische Spaltennamen werden dynamisch zugewiesen.

Primärschlüssel

Der Connector meldet die Zeilennummer als Primärschlüssel. Die ID-Spalte für jede Zeile stellt die Zeilennummer vom oberen Rand des Blatts dar.

Wenn Sie beispielsweise einen Bereich A3:E6 angeben, werden die Zeilen 3, 4, 5 und 6 zurückgegeben.

Konfigurieren der Spaltenwertanalyse

Der ValueRenderOption Und ValueInputOption Mit den Verbindungseigenschaften kann konfiguriert werden, wie der Connector die Zellenformate von Microsoft Excel Online in den Vorgängen „SELECT“, „INSERT“ und „UPDATE“ analysiert.

Wertwiedergabeoptionen für SELECT-Operationen

Setzen Sie die ValueRenderOption um zu konfigurieren, wie der Connector Werte in der Ausgabe einer SELECT Operation rendert. Die verfügbaren Optionen zum Rendern von Werten sind wie folgt.

  • FormattedValue: Werte werden berechnet und in der Ausgabe entsprechend der Formatierung der Zelle formatiert. Die Formatierung basiert auf dem Gebietsschema der Arbeitsmappe, nicht auf dem Gebietsschema des anfordernden Benutzers. Dies ist die Standardeinstellung ValueRenderOption.
  • UnformattedValue: Werte werden berechnet, aber in der Ausgabe nicht formatiert.
  • Formula: Es werden keine Werte berechnet, stattdessen enthält die Ausgabe die Formeln. Aus diesem Grund wird jede Spalte, die eine Formel enthält, unabhängig vom Satz als String-Typ angezeigt TypeDetectionScheme.
Werteingabeoptionen für INSERT- und UPDATE-Operationen

Setzen Sie die ValueInputOption um zu konfigurieren, wie der Connector Werte analysiert, die der Benutzer für INSERT- und UPDATE-Vorgänge an die Microsoft Excel Online Quelle übermittelt. Die verfügbaren Werteingabeoptionen sind wie unten aufgeführt.

  • UserEntered: Die Werte werden so analysiert, als ob der Benutzer sie in die Benutzeroberfläche eingegeben hätte. Zahlen bleiben Zahlen, aber Zeichenfolgen können in Zahlen, Daten usw. umgewandelt werden, wobei dieselben Regeln gelten, die beim Eingeben von Text in eine Zelle über die Microsoft Excel Online-Benutzeroberfläche gelten. Dies ist die Standardeinstellung ValueInputOption.
  • Raw: Die vom Benutzer eingegebenen Werte werden nicht analysiert und unverändert gespeichert.

Konfigurieren der Datentyperkennung

Setzen Sie die TypeDetectionScheme um die Methode zur Datentyperkennung zu konfigurieren. Die verfügbaren Typerkennungsschemata sind wie folgt.

  • RowScan: Der Connector durchsucht die Zeilen, um den Datentyp heuristisch zu bestimmen. Die Anzahl der Zeilen, die der Connector durchsucht, kann durch bestimmt werden RowScanDepth Eigenschaft. Dies ist die Standardeinstellung TypeDetectionScheme.
  • ColumnFormat: Der Connector meldet den Datentyp basierend auf dem Zellenformat der Spalte. Diese Option ist nur für „UnformattedValue“ und „Formula“ anwendbar. ValueRenderOption-s. Wenn die ValueRenderOption ist auf „FormattedValue“ eingestellt, alle Spalten werden als String-Typen angezeigt.
  • None: Der Connector gibt alle Spalten als Zeichenfolgentyp zurück.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

Microsoft Excel Online Connector-Ansichten

Name Beschreibung
Drives Eine Liste der Laufwerkobjekte abrufen.
SharedDocuments Ruft die Liste aller freigegebenen Dokumente ab. Nicht jedes in dieser Ansicht aufgelistete Element kann als Arbeitsmappe verwendet werden, da der Treiber Nicht-Excel-Dateien herausfiltert. Weitere Informationen finden Sie in den Ansichten „Arbeitsmappe“ und „Arbeitsblätter“.
SharePointSites Rufen Sie die Liste aller Sites in Ihrem SharePoint-Konto ab.
Workbooks Ruft eine Liste der Arbeitsmappenobjekte ab.
Worksheets Rufen Sie eine Liste der Arbeitsblattobjekte ab. Wenn Sie Blätter in einer Arbeitsmappe auflisten, die nicht zum Laufwerk des Benutzers gehören, geben Sie die Laufwerks-ID mithilfe der Laufwerksverbindungseigenschaft an.

Laufwerke

Eine Liste der Laufwerkobjekte abrufen.

Wählen

Die folgende Abfrage gibt die Laufwerke mit der angegebenen SharePointSite-ID zurück.

SELECT * FROM Drives WHERE SiteId = 'rssbus.onmicrosoft.com,988a3-343a-4064-996a-d2a30559f,4233d-dfcd-4910-b7f0-71f1dc03a'
Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die eindeutige Kennung des Laufwerks.
SiteId String SharePointSites.Id Die ID der SharePoint-Site oder-Untersite, zu der dieses Laufwerk gehört.
ListId String Die ID der Liste, zu der dieses Laufwerk gehört.
Name String Der Name des Laufwerks.
Description String Die Beschreibung des Laufwerks.
CreatedByName String Der Anzeigename der Identität.
CreatedById String Eindeutige Kennung für die Identität.
CreatedDateTime Datetime Datum und Uhrzeit der Erstellung des Laufwerks.
LastModifiedDateTime Datetime Datum und Uhrzeit der letzten Änderung des Laufwerks.
WebUrl String URL, die die Ressource im Browser anzeigt.

Gemeinsam genutzte Dokumente

Rufen Sie die Liste aller freigegebenen Dokumente ab. Nicht jedes in dieser Ansicht aufgelistete Element kann als Arbeitsmappe verwendet werden, da der Treiber Nicht-Excel-Dateien herausfiltert. Weitere Informationen finden Sie in den Ansichten „Arbeitsmappe“ und „Arbeitsblätter“.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die ID des freigegebenen Dokuments
SharedFileId String Die freigegebene Datei-ID des Dokuments.
DriveId String Die Laufwerk-ID, auf der sich dieses Dokument befindet.
Name String Der Name des freigegebenen Dokuments.
Size String Die Größe des freigegebenen Dokuments.
SharedByUserName String Der Name des Benutzers, der dieses Dokument freigegeben hat.
SharedDateTime String Datum und Uhrzeit der Freigabe dieses Dokuments.
CreatedDateTime Datetime Datum und Uhrzeit der Erstellung dieses Dokuments.
LastModifiedDateTime Datetime Datum und Uhrzeit der letzten Änderung dieses Dokuments.
WebUrl String Die Web URL dieses freigegebenen Dokuments.

SharePoint-Sites

Rufen Sie die Liste aller Sites in Ihrem SharePoint-Konto ab.

Tabellenspezifische Informationen

Im Gegensatz zu fast allen anderen verfügbaren Tabellen und Ansichten implementiert diese Ansicht keinen Microsoft Graph-Endpoint, sondern den Endpoint '/ Abfrage /search' der SharePoint REST- API. Aus diesem Grund müssen Sie in den meisten Fällen den angeben SharepointURL Verbindungseigenschaft vor dem Initiieren des OAuth-Flows. Während des Autorisierungsflusses erhält der Connector die erforderlichen Berechtigungen, um Ihre SharePoint-Ressourcen zu nutzen.

Wählen

Der Connector verwendet die SharePoint-REST- API, um WHERE-Klauselbedingungen zu verarbeiten, die mit fast jeder Spalte außer der ID erstellt wurden, und nur für den Operator EQUALS (=). Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

Die folgende Abfrage gibt die SharePoint-Site mit der angegebenen SiteId und WebId zurück.

SELECT SiteId, SiteName, Title, SiteDescription FROM SharePointSites WHERE SiteId = '9839b8a3-343a-4064-996a-d2a300bc559f' AND WebId = '427d733d-dfcd-4910-b7f0-771f1d4cc03a'
Einschränkungen

So Abfrage diese Ansicht mit „AzureAD“ ab: AuthScheme mit dem 'CLIENT' OAuthGrantType oder mithilfe von „AzureServicePrincipal“ AuthScheme, Sie müssen angeben, OAuthJWTCert anstelle von OAuthClientSecret Verbindungseigenschaft. Die Einschränkung wird durch die SharePoint REST API auferlegt, die keine akzeptiert OAuthAccessToken wird abgerufen, wenn ein angegeben wird OAuthClientSecret für die oben genannten Authentifizierungsabläufe.

Eine Anleitung zur Authentifizierung mit einem Zertifikat für die AuthSchemes „AzureAD“ und „AzureServicePrincipal“ finden Sie unter „Client-Anmeldeinformationen“ in „Erste Schritte“.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die vollständige Kennung der Site.
SiteId String Die eindeutige Kennung der Websitesammlung.
WebId String Die Web-ID der Site.
SiteName String Der Name der Site.
Title String Der Titel der Site.
SiteDescription String Die Beschreibung der Site.
Description String Die Beschreibung des Artikels.
CreatedDateTime Datetime Datum und Uhrzeit der Site-Erstellung.
LastModifiedDateTime Datetime Datum und Uhrzeit der letzten Änderung der Site.
SPWebUrl String URL, die die Ressource im Browser anzeigt.
Author String Der Autor der Site.
DocumentSignature String Die Dokumentsignatur der Site.
FileExtension String Die Erweiterung der Site-Datei.
SecondaryFileExtension String Die sekundäre Erweiterung der Site-Datei.
FileType String Der Dateityp der Site.
DocId Long Die eindeutige Kennung der Site innerhalb eines geografischen Standorts.
GeoLocationSource String Der geografische Standort der Site.
HitHighlightedSummary String Die ausführliche Zusammenfassung der Site.
Importance Long Die Bedeutung des Standorts.
IsContainer Bool Gibt an, ob die Site ein Ordner ist.
IsDocument Bool Gibt an, ob es sich bei der Site um ein Dokument handelt.
OriginalPath String Der ursprüngliche Sitepfad.
Path String Der aktuelle Sitepfad.
Rank Double Der Rang der Site.
RenderTemplateId String Der Name der Steuerelement-Rendervorlage der Site.
SiteLogo String Die URI des Site-Logos.
ViewsLifeTime Long Die Gesamtzahl der Aufrufe seit der Erstellung der Site.
ViewsRecent Long Die Gesamtzahl der Aufrufe der Site in den letzten 14 Tagen.
WebTemplate String Die Webvorlage, aus der die Site erstellt wird.

Arbeitsmappen

Eine Liste von Arbeitsmappenobjekten abrufen.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Die eindeutige Kennung des Elements innerhalb des Laufwerks.
Name String Der Name des Artikels.
CreatedByName String Der Anzeigename der Identität.
CreatedById String Eindeutige Kennung für die Identität.
CreatedDateTime Datetime Datum und Uhrzeit der Elementerstellung.
LastModifiedDateTime Datetime Datum und Uhrzeit der letzten Änderung des Elements.
Size Long Größe des Elements in Bytes.
WebUrl String URL, die die Ressource im Browser anzeigt.
DriveId String Laufwerke.Id Die ID des Laufwerks, zu dem diese Arbeitsmappe gehört.

Arbeitsblätter

Rufen Sie eine Liste von Arbeitsblattobjekten ab. Wenn Sie Blätter in einer Arbeitsmappe auflisten, die nicht zum Laufwerk des Benutzers gehören, geben Sie die Laufwerks-ID mithilfe der Laufwerksverbindungseigenschaft an.

Spalten
Name Typ Referenzen Beschreibung
Id [KEY] String Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.
WorkbookId String Arbeitsmappen.Id Die ID der Arbeitsmappe, die dieses Arbeitsblatt enthält.
Name String Der Anzeigename des Arbeitsblatts.
Position Integer Die nullbasierte Position des Arbeitsblatts innerhalb der Arbeitsmappe.
Visibility String Die Sichtbarkeit des Arbeitsblatts. Mögliche Werte sind: Sichtbar, Verborgen, Sehr Verborgen.

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren im Microsoft Excel Online Connector

Name Beschreibung
AddWorksheet Fügen Sie einer vorhandenen Excel Online-Arbeitsmappe ein Arbeitsblatt hinzu.
CreateSchema Erstellt eine Schema für die angegebene Tabelle oder Ansicht.
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.
GetOAuthAccessToken Ruft das OAuth-Zugriffstoken von Excel Online ab.
GetOAuthAuthorizationURL Ruft die Autorisierungs URL für Excel Online 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 für Excel Online verwendet werden kann.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei Excel Online verwendet wird.

Arbeitsblatt hinzufügen

Fügen Sie einer vorhandenen Excel Online-Arbeitsmappe ein Arbeitsblatt hinzu.

Eingang
Name Typ Beschreibung
WorkbookId String Die ID der Arbeitsmappe. Muss zu einem Laufwerk gehören, auf das mit den aktuellen Verbindungseigenschaften zugegriffen werden kann.
Title String Der Name des Arbeitsblattes.
Ergebnissatzspalten
Name Typ Beschreibung
Success String Dieser Wert zeigt an, ob der Operation erfolgreich war oder nicht.

Schema erstellen

Erstellt eine Schema für die angegebene Tabelle oder Ansicht.

Schema erstellen

Erstellt eine lokale Schema (.rsd) aus einer vorhandenen Tabelle oder Ansicht im Datenmodell.

Die Schema wird in dem Verzeichnis erstellt, das in festgelegt ist Location Verbindungseigenschaft, wenn dieses Verfahren ausgeführt wird. Sie können die Datei bearbeiten, um Spalten ein- oder auszuschließen, Spalten umzubenennen oder Spaltendatentypen anzupassen.

Der Connector überprüft die Location um zu bestimmen, ob die Namen von .rsd-Dateien mit einer Tabelle oder Ansicht im Datenmodell übereinstimmen. Wenn ein Duplikat vorhanden ist, hat die Schema Vorrang vor der Standardinstanz dieser Tabelle im Datenmodell. Wenn eine Schema in vorhanden ist Location das nicht mit einer vorhandenen Tabelle oder Ansicht übereinstimmt, wird dem Datenmodell des Connectors ein neuer Tabellen- oder Ansichtseintrag hinzugefügt.

Eingang
Name Typ Akzeptiert Ausgabeströme Beschreibung
TableName String Falsch Der Name der Tabelle oder Ansicht.
FileName String Falsch Der vollständige Dateipfad und Name des zu generierenden Schema. Beispiel: „C:\Benutzer\Benutzer\Desktop\SmartSheet\sheet.rsd“
FileStream String True Eine Instanz eines Ausgabestreams, in den Dateidaten geschrieben werden. Wird nur verwendet, wenn FileName nicht festgelegt ist.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Gibt „Erfolg“ oder „Fehler“ zurück.
FileData String Wenn die Eingabe „FileName“ leer ist.

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.

Eingang
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 App-Einstellungen von Microsoft Entra ID übereinstimmen.
State String Derselbe Wert für den Status, den Sie gesendet haben, als Sie den Autorisierungscode angefordert haben.
Scope String Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Administrator angefordert werden können. Eine Liste der verfügbaren Berechtigungen finden Sie in der Microsoft Graph-API Dokumentation.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die Autorisierungs-URL, die vom Administrator in einen Webbrowser eingegeben wird, um Berechtigungen für Ihre App zu erteilen.

GetOAuthAccessToken

Ruft das OAuth-Zugriffstoken von Excel Online ab.

Eingang
Name Typ Beschreibung
AuthMode String Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP und WEB.
Verifier String Das von Excel Online 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 Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Benutzer angefordert werden sollen, wenn OAuthGrantType='CODE'. Eine Liste der verfügbaren Berechtigungen finden Sie in der Microsoft Graph-API Dokumentation. Wenn OAuthGrantType='CLIENT', wird ein Bereich von ' https://graph.microsoft.com/.default ' verwendet. '/.default' übernimmt alle Berechtigungen, die Ihre App bereits hat.
State String Ein in der Anfrage enthaltener Wert, der auch in der Token-Antwort zurückgegeben wird. Es kann sich um eine Zeichenfolge mit beliebigem Inhalt handeln.
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 Excel Online 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 Autorisierungs-URL für Excel Online 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 für Excel Online verwendet werden kann.

Eingang
Name Typ Beschreibung
CallbackUrl String Die URL, zu der Excel Online zurückkehrt, nachdem der Benutzer Ihre App autorisiert hat.
Scope String Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Benutzer angefordert werden sollen, wenn OAuthGrantType='CODE'. Eine Liste der verfügbaren Berechtigungen finden Sie in der Microsoft Graph-API Dokumentation. Wenn OAuthGrantType='CLIENT', wird ein Bereich von ' https://graph.microsoft.com/.default ' verwendet. '/.default' übernimmt alle Berechtigungen, die Ihre App bereits hat.
State String Dieses Feld zeigt alle Zustände an, die für Ihre Anwendung nach Erhalt der Antwort nützlich sein können. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery.
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.

Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei Excel Online verwendet wird.

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

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 Excel Online 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 Schemas 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 Tabelle Test_xlsx_Sheet1 zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Test_xlsx_Sheet1'
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.
IsReadOnly Boolean Ob die Spalte schreibgeschützt ist.
IsKey Boolean Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle 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 Parameter gespeicherter Prozeduren.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddWorksheet' 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, die den Parameter enthält.
ColumnName String Der Name des gespeicherten Prozedurparameters.
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 Tabelle Test_xlsx_Sheet1 ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Test_xlsx_Sheet1'
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:excelonline: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 Anschlusspflicht besteht.
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 Verschiedene sonstige Informationen zum Objekt.

Sys_sqlinfo

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

Entdecken der SELECT-Funktionen der Datenquelle

Nachfolgend 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 Gibt gespeicherte Prozeduren an, 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; siehe 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.

Systemidentität

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.

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 Der für die Verbindung mit Microsoft Excel Online zu verwendende Authentifizierungstyp.
UseSandbox Ein Boolescher Wert, der angibt, ob Sie ein Sandbox-Konto verwenden. Der Anbieter stellt standardmäßig Anfragen an die Umfeld.

Verbindung

Eigenschaft Beschreibung
DefineTables Tabellennamen den Bereichen zuweisen.
Workbook Der Name oder die ID der Arbeitsmappe.
Drive Die ID des Laufwerks.
IncludeSharePointSites Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist.

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.

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.
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://'.
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 App-Einstellungen angeben.
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.
OAuthJWTCertPassword Das Passwort für das OAuth JWT-Zertifikat.
OAuthJWTCertSubject Der Betreff des OAuth-JWT-Zertifikats.
OAuthJWTIssuer Der Herausgeber des Java Web Token.
OAuthJWTSubject Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert.

SSL

Eigenschaft Beschreibung
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.

Verschiedenes

Eigenschaft Beschreibung
AllowFormula Ob Werte, die mit einem Gleichheitszeichen (=) beginnen, bei Einfügungen und Aktualisierungen als Formeln behandelt werden sollen oder nicht.
Header Gibt an, ob der Anbieter Spaltennamen aus der ersten Zeile erkennen soll oder nicht.
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 Excel Online zurückgegeben werden sollen, wenn UsePagination True ist.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
RowScanDepth Die maximale Anzahl der zu scannenden Zeilen, um nach den in einer Tabelle verfügbaren Spalten zu suchen.
SharepointURL Die Basis URL Ihres Sharepoint-Servers.
ShowSharedDocuments Ob freigegebene Dokumente angezeigt werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
TypeDetectionScheme Bestimmt, wie die Datentypen von Spalten ermittelt werden.
UsePagination Ob der ADO.NET-Provider für Microsoft Excel Online clientseitiges Paging verwenden soll oder nicht.
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.
ValueInputOption Bestimmt, wie der Anbieter die Werte analysiert, die der Benutzer an Microsoft Excel Online übermittelt.
ValueRenderOption Bestimmt, wie der Anbieter Werte in der Ausgabe rendert.

Authentifizierung

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

Eigenschaft Beschreibung
AuthScheme Der für die Verbindung mit Microsoft Excel Online zu verwendende Authentifizierungstyp.
UseSandbox Ein Boolescher Wert, der angibt, ob Sie ein Sandbox-Konto verwenden. Der Anbieter stellt standardmäßig Anfragen an die Umfeld.

AuthScheme

Der bei der Verbindung mit Microsoft Excel Online zu verwendende Authentifizierungstyp.

Mögliche Werte

AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert

Datentyp

string

Standardwert

AzureAD

Hinweise
  • Microsoft Entra ID: Legen Sie dies fest, um die Microsoft Entra ID OAuth-Authentifizierung durchzuführen.
  • AzureMSI: Legen Sie dies fest, um beim Ausführen auf einer Azure-VM automatisch Anmeldeinformationen für die verwaltete Dienstidentität abzurufen.
  • AzureServicePrincipal: Legen Sie dies fest, um die Authentifizierung als Microsoft Entra-Dienstprinzipal unter Verwendung eines Clientgeheimnisses durchzuführen.
  • AzureServicePrincipalCert: Legen Sie dies fest, um sich mithilfe eines Zertifikats als Microsoft Entra-Dienstprinzipal zu authentifizieren.

Sandbox verwenden

Ein Boolescher Wert, der angibt, ob Sie ein Sandbox-Konto verwenden. Der Anbieter stellt standardmäßig Anforderungen an die Umfeld.

Datentyp

bool

Standardwert

false

Hinweise

Wenn Sie ein Produktionskonto verwenden, können Sie diese Eigenschaft leer lassen. Wenn Sie ein Entwickler verwenden, setzen Sie dies auf „true“.

Verbindung

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

Eigenschaft Beschreibung
DefineTables Tabellennamen den Bereichen zuweisen.
Workbook Der Name oder die ID der Arbeitsmappe.
Drive Die ID des Laufwerks.
IncludeSharePointSites Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist.

Tabellen definieren

Tabellennamen Bereichen zuweisen.

Datentyp

string

Standardwert

""

Hinweise

Mit dieser Eigenschaft werden die Bereiche innerhalb eines Arbeitsblatts definiert, die als Tabellen angezeigt werden. Der Wert ist eine durch Semikolon getrennte Liste von Name-Wert-Paaren in der Form [Table Name]=[Catalog].[Schema].[{Workbook Name}_{Worksheet Name}!{Range}]Der Wert kann auch in der Form [Table Name]=[{Workbook Name}_{Worksheet Name}!{Range}]. Beachten Sie, dass der Treiber in diesem Fall versucht, die definierte Tabelle für jedes identifizierte Schema zu pushen, sofern die angegebene Arbeitsmappe und das angegebene Arbeitsblatt im Schema vorhanden sind. Für Angaben von DefineTables, einige Zeichen, wie . sind reservierte Zeichen. Um diese Zeichen zu maskieren und sicherzustellen, dass der Name, der sie enthält, richtig analysiert wird, schließen Sie den enthaltenen Namen in Klammern ein, wie in [work.book_work.sheet!A1:Z50]. In diesem Beispiel sucht der Treiber ordnungsgemäß nach der Arbeitsmappe und dem Arbeitsblatt, die durch work.book_work.sheet, obwohl die Spezifikation reservierte Zeichen enthält.

Hier ist ein Beispielwert für DefineTables:

DefineTables="Table1=Test_xlsx_Sheet1!A1:N25,Table2=[].[MySchema].[Spreadsheet1_Sheet2!C3:M53],Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"

Nach dem Einstellen DefineTables, können Sie dann Abfragen ausführen, die auf den angegebenen Tabellennamen verweisen. Beachten Sie, dass Sie die Bereichssyntax auch direkt in der SQL-Anweisung verwenden können: Hängen Sie den Bereich mit dem Zeichen # an den Arbeitsblattnamen an.

Beispielsweise wählt der folgende Befehl den Zellbereich zwischen A1 und E5 aus:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Arbeitsmappe

Der Name oder die ID der Arbeitsmappe.

Datentyp

string

Standardwert

""

Hinweise

Gibt den Namen oder die ID der Arbeitsmappe an. Eine Liste aller Arbeitsmappen ist in der Ansicht „Arbeitsmappen“ verfügbar.

Fahren

Die ID des Laufwerks.

Datentyp

string

Standardwert

""

Hinweise

Gibt die ID des Laufwerks an. Eine Liste aller Laufwerke ist in der Laufwerksansicht verfügbar. Diese Eigenschaft hat Vorrang vor SharepointURL. Das bedeutet, dass wenn SharepointURL Und Drive angegeben sind, wird ein Schema nur für das durch angegebene Laufwerk identifiziert Drive, und Tabellen werden nur anhand der Arbeitsblätter in Arbeitsmappen auf diesem Laufwerk identifiziert.

SharePoint-Sites einschließen

Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist.

Datentyp

bool

Standardwert

false

Hinweise

Diese Eigenschaft betrifft nur Laufwerksansichten.

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 Standardmandant verwendet.

Datentyp

string

Standardwert

""

Hinweise

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 explizit angegeben werden, um sicherzustellen, dass Sie Anmeldeinformationen erhalten, die für die Domäne gelten, mit der Sie eine Verbindung herstellen möchten.

Azure-Umgebung

Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung.

Mögliche Werte

GLOBAL, CHINA, USGOVT, USGOVTDOD

Datentyp

string

Standardwert

GLOBAL

Hinweise

In den meisten Fällen funktioniert es, die Umfeld auf global eingestellt zu lassen. Wenn Ihr Azure-Konto jedoch einer anderen Umfeld hinzugefügt wurde, wird die AzureEnvironment kann verwendet werden, um die Umfeld anzugeben. Die verfügbaren Werte sind GLOBAL, CHINA, USGOVT, USGOVTDOD.

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.
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://'.
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 App-Einstellungen angeben.
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.

OAuth initiieren

Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

OFF

Hinweise

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 OAuthRefreshToken übernehmen.

OAuthClientId

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

Datentyp

string

Standardwert

""

Hinweise

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

""

Hinweise

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 Eigentum.

OAuth-Zugriffstoken

Der Zugriffstoken für die Verbindung per OAuth.

Datentyp

string

Standardwert

""

Hinweise

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

Das Zugriffstoken wird anstelle Ihres Benutzernamens und Passworts verwendet. Das Zugriffstoken schützt Ihre Anmeldeinformationen, indem es sie auf dem Server speichert.

OAuthSettingsLocation

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

Datentyp

string

Standardwert

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Treiber 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 auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit '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_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

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

  • Windows: "register://%DSN"
  • Unix: "%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
Linux ~/.config

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 App-Einstellungen angeben.

Datentyp

string

Standardwert

""

Hinweise

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 App-Einstellungen angeben.

Zustand

Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.

Datentyp

string

Standardwert

""

Hinweise

Optionaler Wert zur Darstellung zusätzlicher OAuth-Statusinformationen.

OAuthGrantType

Der Berechtigungstyp für den OAuth-Flow.

Mögliche Werte

CODE, CLIENT, PASSWORD

Datentyp

string

Standardwert

CLIENT

Hinweise

Folgende Optionen stehen zur Verfügung: CODE,CLIENT,PASSWORT

OAuthVerifier

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

Datentyp

string

Standardwert

""

Hinweise

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

""

Hinweise

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

OAuthLäuftAbIn

Die Lebensdauer des OAuth AccessToken in Sekunden.

Datentyp

string

Standardwert

""

Hinweise

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

OAuthTokenTimestamp

Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

Datentyp

string

Standardwert

""

Hinweise

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.
OAuthJWTCertPassword Das Passwort für das OAuth JWT-Zertifikat.
OAuthJWTCertSubject Der Betreff des OAuth-JWT-Zertifikats.
OAuthJWTIssuer Der Herausgeber des Java Web Token.
OAuthJWTSubject Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert.

OAuthJWTCert

Der JWT-Zertifikatspeicher.

Datentyp

string

Standardwert

""

Hinweise

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

Hinweise

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.

OAuthJWTCertPasswort

Das Passwort für das OAuth JWT-Zertifikat.

Datentyp

string

Standardwert

""

Hinweise

Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort anzugeben, damit der Zertifikatspeicher geöffnet werden kann.

OAuthJWTCertSubject

Der Betreff des OAuth JWT-Zertifikats.

Datentyp

string

Standardwert

*

Hinweise

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

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 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. Zum Beispiel „CN=www.server.com, OU=test, C=US, E=example@jbexample.com“. Allgemeine 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.

OAuthJWTIssuisse

Der Herausgeber des Java Web Token.

Datentyp

string

Standardwert

""

Hinweise

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.

OAuthJWT-Betreff

Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert.

Datentyp

string

Standardwert

""

Hinweise

Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert. In den meisten Fällen wird hier der Wert der Verbindungseigenschaft OAuth App ID (Client-ID) verwendet und muss nicht einzeln festgelegt werden.

SSL

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

Eigenschaft Beschreibung
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

SSLServerCert

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

Datentyp

string

Standardwert

""

Hinweise

Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. 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.

Standort

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

Datentyp

string

Standardwert

%APPDATA%\ExcelOnline Data Provider\Schema

Hinweise

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.

Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\ExcelOnline 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

DurchsuchbareSchemas

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

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Schemata aus Datenbanken kann aufwändig 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

""

Hinweise

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.

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

""

Hinweise

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 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.

Verschiedenes

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

Eigenschaft Beschreibung
AllowFormula Ob Werte, die mit einem Gleichheitszeichen (=) beginnen, bei Einfügungen und Aktualisierungen als Formeln behandelt werden sollen oder nicht.
Header Gibt an, ob der Anbieter Spaltennamen aus der ersten Zeile erkennen soll oder nicht.
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 Excel Online zurückgegeben werden sollen, wenn UsePagination True ist.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
RowScanDepth Die maximale Anzahl der zu scannenden Zeilen, um nach den in einer Tabelle verfügbaren Spalten zu suchen.
SharepointURL Die Basis URL Ihres Sharepoint-Servers.
ShowSharedDocuments Ob freigegebene Dokumente angezeigt werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
TypeDetectionScheme Bestimmt, wie die Datentypen von Spalten ermittelt werden.
UsePagination Ob der ADO.NET-Provider für Microsoft Excel Online clientseitiges Paging verwenden soll oder nicht.
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.
ValueInputOption Bestimmt, wie der Anbieter die Werte analysiert, die der Benutzer an Microsoft Excel Online übermittelt.
ValueRenderOption Bestimmt, wie der Anbieter Werte in der Ausgabe rendert.

Formel zulassen

Ob Werte, die mit einem Gleichheitszeichen (=) beginnen, bei Einfügungen und Aktualisierungen als Formeln behandelt werden sollen oder nicht.

Datentyp

bool

Standardwert

true

Hinweise

Setzen Sie diesen Wert auf „true“, um Werte, die mit einem Gleichheitszeichen (=) beginnen, bei Einfügungen und Aktualisierungen als Formeln zu behandeln. Setzen Sie den Wert auf „false“, um alle bei Einfügungen und Aktualisierungen verwendeten Werte als Zeichenfolgen zu behandeln.

Zum Beispiel mit AllowFormula auf true gesetzt, fügt das Folgende eine Formel in die Spalte B ein, die die Zellen B1:B5 summiert:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Hinweis

Wenn True, wird jede Spalte, die eine Formel enthält, als String-Typ angezeigt, unabhängig vom eingestellten TypeDetectionScheme.

Kopfbereich

Gibt an, ob der Anbieter Spaltennamen aus der ersten Zeile erkennen soll oder nicht.

Datentyp

bool

Standardwert

true

Hinweise

Wenn wahr, wird die erste Zeile als Header verwendet. Andernfalls werden die Pseudospaltennamen A, B, C usw. verwendet.

Der Connector befolgt die folgenden zusätzlichen Spezifikationen, um Spaltenüberschriften zu erkennen:

  • Überschriften dürfen keine Sonderzeichen enthalten.
  • Aufgrund einer Einschränkung der Excel Online API dürfen keine der Spaltenüberschriften leer sein.

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

Hinweise

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

""

Hinweise

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 der Ergebnisse, die pro Seite von Microsoft Excel Online zurückgegeben werden sollen, wenn UsePagination True ist.

Datentyp

int

Standardwert

-1

Hinweise

Der Pagesize Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von Microsoft Excel Online zurückgegeben werden. Wenn Sie einen höheren Wert festlegen, kann dies zu einer besseren Leistung führen, allerdings wird pro Seite mehr Speicher verbraucht. Der Wert -1 gibt die maximal mögliche Seitengröße für den Treiber an.

Pseudospalten

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

Datentyp

string

Standardwert

""

Hinweise

Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort 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. „*=*“.

Zeilenscantiefe

Die maximale Anzahl zu scannender Zeilen, um nach den in einer Tabelle verfügbaren Spalten zu suchen.

Datentyp

int

Standardwert

50

Hinweise

Die Spalten in einer Tabelle müssen durch das Scannen der Tabellenzeilen ermittelt werden. Dieser Wert bestimmt die maximale Anzahl der zu scannenden Zeilen.

Das Festlegen eines hohen Wertes kann die Leistung beeinträchtigen. Das Festlegen eines niedrigen Wertes kann dazu führen, dass der Datentyp nicht richtig ermittelt wird, insbesondere wenn Nulldaten vorhanden sind.

SharepointURL

Die Basis URL Ihres Sharepoint-Servers.

Datentyp

string

Standardwert

""

Hinweise

Zum Abfrage der SharePointSites, muss diese Basis URL Ihres Sharepoint-Servers angegeben werden. Ein Protokollpräfix, entweder "http://" oder "https://", muss im für diese Eigenschaft angegebenen Wert angegeben werden.

Beispiel: https://SomeTenantName.sharepoint.com. Mit dieser Eigenschaft können Sie auch steuern, welche Laufwerke, Arbeitsmappen und Arbeitsblätter vom Connector angezeigt werden. Wenn Sie angeben SharepointURL und geben Sie nicht Laufwerk an, listet der Connector Laufwerke der angegebenen Site als Schemata auf und listet alle Arbeitsblätter aller Arbeitsmappen in jedem Laufwerk als Tabellen in ihrem jeweiligen Schema auf. Wenn diese Eigenschaft bei Verwendung der AzureServicePrincipal- oder AzureServicePrincipalCert-Authentifizierung angegeben wird, wird der Endpoint nicht verwendet. Diese Eigenschaft muss angegeben werden, wenn mit einer benutzerdefinierten Anwendung gearbeitet wird, deren höchste Berechtigung „Sites.Selected“ ist.

Geteilte Dokumente anzeigen

Ob freigegebene Dokumente angezeigt werden sollen oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Ob freigegebene Dokumente angezeigt werden sollen oder nicht. Wenn diese Option auf „true“ gesetzt ist, werden freigegebene Dokumente neben den Arbeitsmappen des Benutzers als Datenbanktabellen aufgelistet. Letztendlich sollte den spezifischen Dateien direkter Zugriff gewährt oder sie sollten explizit mit dem authentifizierten Benutzer geteilt worden sein.

Zeitüberschreitung

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

Datentyp

int

Standardwert

60

Hinweise

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.

Typerkennungsschema

Bestimmt, wie die Datentypen von Spalten ermittelt werden.

Mögliche Werte

None, RowScan, ColumnFormat

Datentyp

string

Standardwert

RowScan

Hinweise

Der Connector kann Datentypen anhand des Zellenformats (Zahl, Währung, Datum usw.) oder durch Scannen von Zeilen erkennen.

Eigenschaft Beschreibung
None Einstellung TypeDetectionScheme to None gibt alle Spalten als Zeichenfolgentyp zurück.
RowScan Einstellung TypeDetectionScheme to RowScan scannt Zeilen, um den Datentyp heuristisch zu bestimmen. Die RowScanDepth bestimmt die Anzahl der Zeilen, die der Connector scannt.
ColumnFormat Einstellung TypeDetectionScheme to ColumnFormat meldet den Datentyp basierend auf dem Zellenformat der Spalte. Hinweis: Diese Option ist nur für die ValueRenderOption „UnformattedValue“ und „Formula“ anwendbar-s. Wenn die ValueRenderOption auf „FormattedValue“ gesetzt ist, werden alle Spalten als String-Typen angezeigt.

Seitennummerierung verwenden

Gibt an, ob der ADO.NET-Provider für Microsoft Excel Online clientseitiges Paging verwenden soll oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Ob der Microsoft Excel Online-Connector clientseitiges Paging verwenden soll oder nicht. Wir empfehlen, dies bei großen Datensätzen auf „true“ zu setzen.

BenutzerdefinierteAnsichten

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

Datentyp

string

Standardwert

""

Hinweise

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 Test_xlsx_Sheet1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

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

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

Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.

UseSimpleNames

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

Datentyp

bool

Standardwert

false

Hinweise

In Microsoft Excel Online-Tabellen und-Spalten können in Namen Sonderzeichen verwendet werden, 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.

Werteingabeoption

Bestimmt, wie der Anbieter Werte analysiert, die der Benutzer an Microsoft Excel Online übermittelt.

Mögliche Werte

UserEntered, Raw

Datentyp

string

Standardwert

UserEntered

Hinweise

Bestimmt, wie der Connector die Werte analysiert, die der Benutzer an Microsoft Excel Online übermittelt.

Eigenschaft Beschreibung
Raw Die vom Benutzer eingegebenen Werte werden nicht analysiert und unverändert gespeichert.
UserEntered Die Werte werden so analysiert, als hätte der Benutzer sie in die Benutzeroberfläche eingegeben. Zahlen bleiben Zahlen, aber Zeichenfolgen können in Zahlen, Daten usw. umgewandelt werden. Dabei gelten die gleichen Regeln, die beim Eingeben von Text in eine Zelle über die Excel Online-Benutzeroberfläche gelten.

WertRenderOption

Bestimmt, wie der Anbieter Werte in der Ausgabe rendert.

Mögliche Werte

FormattedValue, UnformattedValue, Formula

Datentyp

string

Standardwert

FormattedValue

Hinweise

Bestimmt, wie der Connector Werte in der Ausgabe rendert.

Eigenschaft Beschreibung
FormattedValue Die Werte werden in der Antwort entsprechend der Formatierung der Zelle berechnet und formatiert. Die Formatierung basiert auf dem Gebietsschema der Arbeitsmappe, nicht auf dem Gebietsschema des anfordernden Benutzers. Wenn beispielsweise A1 1,23 und A2 "=A1" ist und als Währung formatiert ist, würde A2 "$1,23" zurückgeben.
UnformattedValue Die Werte werden berechnet, aber in der Antwort nicht formatiert. Wenn beispielsweise A1 1,23 und A2 "=A1" ist und als Währung formatiert ist, dann würde A2 die Zahl 1,23 zurückgeben.
Formula Werte werden nicht berechnet, stattdessen enthält die Antwort die Formeln. Wenn beispielsweise A1 1,23 und A2 "=A1" ist und als Währung formatiert ist, dann würde A2 "=A1" zurückgeben. Aus diesem Grund wird jede Spalte, die eine Formel enthält, als String-Typ angezeigt, unabhängig vom eingestellten TypeDetectionScheme.