Microsoft Dataverse v2-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8858 des Connectors.

Erste Schritte

Versionsunterstützung für Microsoft Dataverse

Der Connector unterstützt Lese-/Schreibzugriff auf Microsoft Dataverse über die Microsoft Dataverse Web-API.

Herstellen einer Verbindung

Schema

Microsoft Dataverse unterstützt Schema von „System“ und „Entitäten“ und können mit dem Schema Eigenschaft.

Verwende „System“ für SchemaEigenschaft verwendet die Web API zum Abfrage von Entitäten/Tabellen.

Verwenden von „Entitäten“ für Schema Eigenschaft verwendet die EntityDefinitions Entity legt Pfad fest und ruft Informationen über EntityMetadata EntityType-Entitäten/-Tabellen ab. Dies führt häufig zu benutzerfreundlicheren Namen, erfordert jedoch zusätzliche Metadatenanforderungen.

Herstellen einer Verbindung mit Microsoft Dataverse

Um sich bei der Microsoft Dataverse Quelle zu authentifizieren, sollten Sie zuerst die OrganizationUrl zur URL der Organisation, mit der Sie sich verbinden, wie zum Beispiel https://\[organization\].crm.dynamics.com.

Microsoft Entra ID

Entra ID ist ein Verbindungstyp, der OAuth zur Authentifizierung nutzt. OAuth erfordert, dass der authentifizierende Benutzer über einen Internetbrowser mit Microsoft Dataverse interagiert. Der Connector erleichtert dies auf verschiedene Weise, wie unten beschrieben. Legen Sie Ihre AuthScheme Zu AzureAD. Die restlichen Microsoft Entra ID Abläufe setzen voraus, dass Sie dies getan haben.

Desktop-Anwendungen

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

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

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

• InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeiden OAuthAccessToken.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID fest.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.
• CallbackURL: Legen Sie dies in Ihren Anwendungseinstellungen auf die Umleitungs URL fest.

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

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

Client-Anmeldeinformationen

Client-Anmeldeinformationen beziehen sich auf einen Ablauf in OAuth, bei dem keine direkte Benutzerauthentifizierung stattfindet. Stattdessen werden Anmeldeinformationen nur für die App selbst erstellt.

Alle von der App ausgeführten Aufgaben werden ohne Standardbenutzerkontext ausgeführt. Dadurch weicht der Authentifizierungsablauf etwas vom Standard ab.

Client-OAuth-Flow

Für alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow ist die Zustimmung des Administrators erforderlich. Dies bedeutet, dass die mit dem Jitterbit Connector für Microsoft Dataverse eingebettete App nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen Ihre eigene OAuth-App erstellen, um Client-Anmeldeinformationen verwenden zu können. Siehe Erstellen einer benutzerdefinierten OAuth-Anwendung für weitere Einzelheiten.

Navigieren Sie in Ihrer App-Registrierung in portal.azure.com zu API -Berechtigungen und wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegierte und Anwendungsberechtigungen. Die während der Clientanmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen. Wählen Sie die entsprechenden Berechtigungen aus, die Sie für Ihre Integration benötigen.

Sie können eine Verbindung herstellen, nachdem Sie je nach Authentifizierungstyp eine der folgenden Verbindungseigenschaftengruppen festgelegt haben.

1. Client Secret
   • InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Setzen von zu vermeiden OAuthAccessToken.
   • AzureTenant: Stellen Sie dies auf den Mandanten ein, mit dem Sie sich verbinden möchten.
   • OAuthGrantType: Setzen Sie dies auf CLIENT.
   • OAuthClientId: Legen Sie dies in Ihren App-Einstellungen auf die Client-ID fest.
   • OAuthClientSecret: Legen Sie dies in Ihren App-Einstellungen auf das Client-Geheimnis fest.
2. Certificate
   • InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Setzen von zu vermeiden OAuthAccessToken.
   • AzureTenant: Stellen Sie dies auf den Mandanten ein, mit dem Sie sich verbinden möchten.
   • OAuthGrantType: Setzen Sie dies auf CLIENT.
   • OAuthClientId: Legen Sie dies in Ihren App-Einstellungen auf die Client-ID fest.
   • OAuthJWTCert: Stellen Sie dies auf den JWT-Zertifikatspeicher ein.
   • OAuthJWTCertType: Setzen Sie dies auf den Typ des Zertifikatspeichers, der durch angegeben ist OAuthJWTCert.

Die Authentifizierung mit Client-Anmeldeinformationen erfolgt automatisch wie bei jeder anderen Verbindung, außer dass kein Fenster mit einer Benutzeraufforderung geöffnet wird. Da kein Benutzerkontext vorhanden ist, ist kein Browser-Popup erforderlich. Verbindungen werden hergestellt und intern abgewickelt.

Microsoft Entra-Dienstprinzipal

Azure Service Principal ist eine rollenbasierte, anwendungsbasierte Authentifizierung. Das bedeutet, dass die Authentifizierung pro Anwendung und nicht pro Benutzer erfolgt. Alle von der Anwendung übernommenen 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.

Informationen zum Einrichten der Microsoft Entra-Dienstprinzipalauthentifizierung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Verwaltete Dienstidentität (MSI)

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

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

Erstellen einer benutzerdefinierten OAuth-Anwendung

Erstellen einer benutzerdefinierten OAuth-Anwendung

Microsoft Dataverse unterstützt die Authentifizierung mit Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.

In diesem Thema wird Folgendes beschrieben:

• Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für Entra ID oder Microsoft Entra-Dienstprinzipal
• 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 zur ID des Microsoft Entra ID Mandanten beim Herstellen einer Verbindung mit dem Jitterbit Connector für Microsoft Dataverse. 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 Zertifikatsauthentifizierung: 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 Client-Geheimnis gespeichert wurde, zeigt Microsoft Dataverse 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. Wählen Sie unter „API auswählen“ die Dynamics CRM Online-Berechtigungen aus, wenn Sie die Authentifizierung über eine Desktop-App durchführen, oder wählen Sie die Dynamics CRM Online-Berechtigungen aus, wenn Sie die Authentifizierung über Web-Apps oder Headless-Computer durchführen.
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 Dataverse öffnet die Add role assignment Seite.
7. Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu Owner.

Zustimmung zu Kundenanmeldeinformationen

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.

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.

Erstellen einer benutzerdefinierten Microsoft Entra ID Service Principal-App

Bei der Authentifizierung mit einem Microsoft Entra-Dienstprinzipal ist das Erstellen einer benutzerdefinierten App-Registrierung und eines Dienstprinzipals erforderlich, das auf die erforderlichen Ressourcen zugreifen kann.

Schritte zum Erstellen einer Microsoft Entra ID SP-App

Befolgen Sie die nachstehenden Schritte, um eine benutzerdefinierte App-Registrierung zu erstellen und die Verbindungseigenschaften für die Microsoft Entra-Dienstprinzipalauthentifizierung abzurufen.

1. Melden Sie sich an bei https://portal.azure.com.

2. Wählen Sie im linken Navigationsbereich Microsoft Entra ID > App Registrations und klick New registration.

3. Geben Sie einen Anwendungsnamen ein und wählen Sie Konten in einem beliebigen Organisationsverzeichnis (Jeder Microsoft Entra ID Mandant - Multitenant). Legen Sie dann die Umleitungs URL fest auf http://localhost:33333, der Standard des Connectors oder eine URL Ihrer Wahl.

4. Kopieren Sie nach dem Erstellen der App den Wert der Anwendungs-ID (Client-ID), der im Abschnitt „Übersicht“ angezeigt wird, da dieser Wert als verwendet wird OAuthClientId

5. Definieren Sie den Anwendungsauthentifizierungstyp, indem Sie zum Abschnitt „Zertifikate und Geheimnisse“ navigieren. Es stehen zwei Arten der Authentifizierung zur Verfügung: Clientgeheimnis und Zertifikat.

   Die empfohlene Authentifizierungsmethode ist über ein Zertifikat.

   • Option 1 - Upload a certificate: Wählen Sie unter „Zertifikate und Geheimnisse“ Upload certificate und das Zertifikat zum Hochladen von Ihrem lokalen Computer.
   • Option 2 - Create a new application secret: Wählen Sie unter „Zertifikate und Geheimnisse“ New Client Secret für die Anwendung und geben Sie deren Dauer an. Nach dem Speichern des Client-Geheimnisses wird der Schlüsselwert angezeigt. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Sie verwenden ihn als OAuthClientSecret.

6. Auf der Authentication Tab, stellen Sie sicher, dass Sie die Option auswählen Access tokens (wird für implizite Flows verwendet).

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 Dataverse-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 Dataverse und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Jitterbit Connector für Microsoft Dataverse 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 Accounts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die UserDefinedViews Verbindungseigenschaft zur Angabe des Speicherorts Ihrer JSON-Konfigurationsdatei. 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

Überblick

In diesem Abschnitt werden die verfügbaren API Objekte angezeigt und weitere Informationen zur Ausführung von SQL für Microsoft Dataverse APIs bereitgestellt.

Der Jitterbit Connector für Microsoft Dataverse modelliert Microsoft Dataverse Entitäten in relationalen Tabellen, Ansichten und gespeicherten Prozeduren. Die Tabellendefinitionen werden dynamisch vom OData-Dienst abgerufen, mit dem Sie eine Verbindung herstellen. Alle Änderungen in den Metadaten, z. B. hinzugefügte oder entfernte Spalten oder Änderungen im Datentyp, können durch erneutes Verbinden geladen werden.

Tabellen

Der Connector modelliert die im Service-Metadatendokument beschriebenen beschreibbaren Entitäten als bidirektionale Tabellen.

Gespeicherte Prozeduren

Sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können verwendet werden, um zusätzliche Vorgänge auszuführen, die außerhalb des Standard-CRUD-Modells liegen, wie z. B. das Abrufen eines OAuth-Zugriffstokens.

Microsoft Dataverse Entities-Datenmodell

Entitäten-Datenmodell beschreibt die Schemata, die für die Verbindung mit Microsoft Dataverse verfügbar sind. Sie können Tabellen verwenden, um mit Live-Daten von Microsoft Dataverse zu arbeiten. Sie können gespeicherte Prozeduren verwenden, die von Jitterbit Connector für Microsoft Dataverse bereitgestellt werden, um die Arbeit mit Microsoft Dataverse Daten zu automatisieren.

Microsoft Dataverse-Systemdatenmodell

Systemdatenmodell beschreibt die Schemas, die für die Verbindung mit Microsoft Dataverse verfügbar sind. Sie können Tabellen verwenden, um mit Live-Daten von Microsoft Dataverse zu arbeiten. Sie können gespeicherte Prozeduren verwenden, die von Jitterbit Connector für Microsoft Dataverse bereitgestellt werden, um die Arbeit mit Microsoft Dataverse Daten zu automatisieren.

Entitäten-Datenmodell

Ansichten

Ansichten beschreibt die verfügbaren Ansichten.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu Microsoft Dataverse. Gespeicherte Prozeduren ermöglichen Ihnen die Ausführung von Vorgängen in Microsoft Dataverse, wie z. B. das Abrufen des OAuth-Zugriffstokens.

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.

Jitterbit-Connector für Microsoft Dataverse Ansichten

MultiSelectPickListAttributeMetaData

Enthält die Picklist-Metadaten für einen Attributtyp „MultiSelect OptionSet“.

Spalten

Mehrfachauswahl-Auswahllistenoptionen

Enthält den Optionswert von MultiSelect PicklistMetadata.

Spalten

PickListAttributeMetaData

Enthält die Metadaten für einen Attributtyp „Auswahlliste“.

Spalten

Auswahllistenoptionen

Enthält den Optionswert von PickListMetaData

Spalten

StateAttributeMetadata

Enthält die Metadaten für einen Attributtyp „Status“.

Spalten

Statusattributoptionen

Enthält den Optionswert des Statusattributs.

Spalten

StatusAttributeMetadata

Enthält die Metadaten für einen Attributtyp „Status“.

Spalten

StatusAttributOptions

Enthält den Optionswert des Statusattributs.

Spalten

Gespeicherte Prozeduren

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

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

Jitterbit-Connector für gespeicherte Prozeduren in Microsoft Dataverse

GetOAuthAccessToken

Ruft das Authentifizierungstoken ab, das zur Authentifizierung beim Dienst verwendet wird.

Eingang

Ergebnissatzspalten

GetOAuthAuthorizationUrl

Ruft eine Autorisierungs-URL aus der Datenquelle ab. Die Autorisierungs URL kann verwendet werden, um einen Prüfer zu generieren, der zum Abrufen des OAuth-Tokens erforderlich ist.

Eingang

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Erhält einen aktualisierten OAuthAccessToken, wenn ein Token zum Aktualisieren übergeben wird.

Eingang

Ergebnissatzspalten

Systemdatenmodell

Ansichten

Beschreibt die verfügbaren Ansichten.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu Microsoft Dataverse. Gespeicherte Prozeduren ermöglichen Ihnen die Ausführung von Vorgängen in Microsoft Dataverse, wie z. B. das Abrufen des OAuth-Zugriffstokens.

Gespeicherte Prozeduren

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

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

Jitterbit-Connector für gespeicherte Prozeduren in Microsoft Dataverse

Verein erstellen

Erstellt eine Verbindung zwischen zwei Entitäten basierend auf einer Navigationseigenschaft.

Eingang

GetOAuthAccessToken

Ruft das Authentifizierungstoken ab, das zur Authentifizierung beim Dienst verwendet wird.

Eingang

Ergebnissatzspalten

GetOAuthAuthorizationUrl

Ruft eine Autorisierungs URL aus der Datenquelle ab. Die Autorisierungs URL kann verwendet werden, um einen Prüfer zu generieren, der zum Abrufen des OAuth-Tokens erforderlich ist.

Eingang

Ergebnissatzspalten

ListeVerbände

Listet Assoziationen für eine bestimmte Tabelle und Navigationseigenschaft auf.

Eingang

Ergebnissatzspalten

ListNavigationProperties

Listet Navigationseigenschaften für eine bestimmte Tabelle und die Tabellen auf, mit denen sie verknüpft sind. Navigationseigenschaften werden von den gespeicherten Zuordnungsprozeduren verwendet.

Eingang

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Erhält einen aktualisierten OAuthAccessToken, wenn ein Token zum Aktualisieren übergeben wird.

Eingang

Ergebnissatzspalten

Zuordnung entfernen

Entfernt eine Verknüpfung zwischen zwei Entitäten basierend auf einer Navigationseigenschaft.

Eingang

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 Dataverse zurück:

• sys_catalogs: Listet die verfügbaren Datenbanken auf.
• sys_schemas: Listet die verfügbaren Schemata auf.
• sys_tables: Listet die verfügbaren Tabellen und Ansichten auf.
• sys_tablecolumns: Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
• sys_procedures: Beschreibt die verfügbaren gespeicherten Prozeduren.
• sys_procedureparameters: Beschreibt Parameter gespeicherter Prozeduren.
• sys_keycolumns: Beschreibt die Primär- und Fremdschlüssel.
• sys_indexes: Beschreibt die verfügbaren Indizes.

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

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas

Spalten

Sys_tables

Listet die verfügbaren Tabellen auf.

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

SELECT * FROM sys_tables

Spalten

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle „Konten“ zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'

Spalten

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

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

SELECT * FROM sys_procedures

Spalten

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2

Spalten

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Tabelle „Konten“ ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'

Spalten

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

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

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

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:cds: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

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.

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

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

Datentypzuordnung

Datentypzuordnungen

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

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

Azure-Authentifizierung

OAuth

JWT OAuth

SSL

Schema

Verschiedenes

Authentifizierung

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

AuthScheme

Der bei der Verbindung mit Microsoft Dataverse 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.

OrganisationURL

Die URL zu Ihren Microsoft Dataverse Daten. Beispiel: https://abc123.crm.dynamics.com/.

Datentyp

string

Standardwert

""

Hinweise

Die URL, die Sie verwenden, um sich bei Ihren Microsoft Dataverse Daten anzumelden. Beispiel: https://abc123.crm.dynamics.com/. Dies kann auch als Ressource bezeichnet werden.

Mieter

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

Datentyp

string

Standardwert

""

Hinweise

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

Azure Authentifizierung

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

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.

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 die 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:

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.

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.

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:

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.

Mögliche Werte

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

Datentyp

string

Standardwert

USER

Hinweise

Diese Eigenschaft kann einen der folgenden Werte annehmen:

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.

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

SSL

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

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:

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.

Standort

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

Datentyp

string

Standardwert

%APPDATA%\CDS 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.

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

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

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.

Schema

Zu verwendendes Schema: System, Entitäten.

Mögliche Werte

System, Entities

Datentyp

string

Standardwert

System

Hinweise

Schema zur Verwendung von System, Entitäten

Verschiedenes

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

API-Version

Die verwendete API Version. Diese kann angegeben werden, um auf eine neue Version der API zuzugreifen, sobald diese veröffentlicht wird.

Datentyp

string

Standardwert

9.0

Hinweise

Die verwendete API Version. Diese kann angegeben werden, um auf eine neue Version der API zuzugreifen, sobald diese veröffentlicht wird. Andernfalls können Sie die Standardeinstellung verwenden.

Formatierte Werte einschließen

Gibt an, ob Spalten mit formatierten Werten angezeigt werden sollen.

Datentyp

bool

Standardwert

false

Hinweise

Für jede Spalte wird eine zusätzliche Spalte hinzugefügt, um den formatierten Wert anzuzeigen. Neue Spalten haben das Suffix „_display“.

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

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. „*=*“.

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.

Anzeigenamen verwenden

Wenn auf „true“ gesetzt, verwendet der Anbieter für einige Vorgänge Anzeigenamen.

Datentyp

bool

Standardwert

false

Hinweise

Wenn auf „true“ gesetzt, verwendet der Connector für einige Vorgänge Anzeigenamen. Diese Eigenschaft wird nur für das Entities Schema verwendet.

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

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

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

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