Verbindungsdetails zu Wave Financial
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8895 des Connectors.
Erste Schritte
Unterstützung für Wave Financial Version
Der Connector nutzt die Wave Financial API, um einen bidirektionalen Zugriff auf Wave Financial zu ermöglichen.
Herstellen einer Verbindung
Verbinden Sie sich mit Wave Financial
Wave Financial bietet zwei Möglichkeiten zum Herstellen einer Verbindung zu Daten: durch Angabe des API Tokens oder durch Verwendung von OAuth-Anmeldeinformationen.
API Token
So erhalten Sie das Wave Financial API Token:
- Melden Sie sich bei Ihrem Wave Financial Konto an.
- Navigieren Sie im linken Bereich zu „Anwendungen verwalten“.
- Wählen Sie die Anwendung aus, für die Sie ein Token erstellen möchten. Möglicherweise müssen Sie zuerst eine Anwendung erstellen.
- Um das API Token zu generieren, klicken Sie auf
Create token
.
OAuth
Wave Financial unterstützt nur die OAuth-Authentifizierung. Um diese Authentifizierung für alle OAuth-Flows zu aktivieren, müssen Sie Folgendes festlegen: AuthScheme
Zu OAuth
.
In den folgenden Unterabschnitten wird die Authentifizierung bei Wave Financial anhand von drei gängigen Authentifizierungsabläufen beschrieben:
Desktop
: eine Verbindung zu einem Server auf dem lokalen Computer des Benutzers, die häufig zum Testen und Prototyping verwendet wird. Authentifiziert entweder über eingebettetes OAuth oder benutzerdefiniertes OAuth.Web
: Zugriff auf Daten über eine gemeinsam genutzte Website. Authentisierung nur über benutzerdefiniertes OAuth.Headless Server
: ein dedizierter Computer, der Dienste für andere Computer und deren Benutzer bereitstellt und so konfiguriert ist, dass er ohne Monitor und Tastatur funktioniert. Authentifiziert über eingebettetes OAuth oder benutzerdefiniertes OAuth.
Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung und warum Sie möglicherweise eine solche sogar für Authentifizierungsabläufe mit eingebetteten OAuth-Anmeldeinformationen erstellen möchten, finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.
Eine vollständige Liste der in Wave Financial verfügbaren Verbindungszeichenfolgeneigenschaften finden Sie unter Connection.
Desktop-Anwendungen
bietet eine eingebettete OAuth-Anwendung, die die Authentifizierung am Desktop vereinfacht.
Sie können sich auch vom Desktop aus über eine benutzerdefinierte OAuth-Anwendung authentifizieren, die Sie in der Wave Financial Konsole konfigurieren und registrieren. Weitere Informationen finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.
Legen Sie vor dem Verbinden die folgenden Variablen fest:
InitiateOAuth
=GETANDREFRESH
. Wird verwendet, um automatisch die abzurufen und zu aktualisierenOAuthAccessToken
.Custom OAuth applications only
:OAuthClientId
= die Client-ID, die Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.OAuthClientSecret
= das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.CallbackURL
= die Umleitungs-URI, die bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung definiert wurde.
Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Wave Financial in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen.
Nachdem Sie der Anwendung Berechtigungen erteilt haben, schließt der Connector den OAuth-Prozess ab:
- Der Connector erhält einen Zugriffstoken von Wave Financial und verwendet ihn, um Daten anzufordern.
- Die OAuth-Werte werden im in angegebenen Pfad gespeichert
OAuthSettingsLocation
. Diese Werte bleiben über Verbindungen hinweg bestehen.
Der Connector aktualisiert das Zugriffstoken automatisch, wenn es abläuft.
Automatische Aktualisierung des OAuth-Zugriffstokens
Damit der Connector das OAuth-Zugriffstoken automatisch aktualisiert, gehen Sie wie folgt vor:
- Legen Sie beim ersten Herstellen einer Verbindung zu Daten die folgenden Verbindungsparameter fest:
InitiateOAuth
=REFRESH
.OAuthClientId
= die Client-ID in Ihren Anwendungseinstellungen.OAuthClientSecret
= das Client-Geheimnis in Ihren Anwendungseinstellungen.OAuthAccessToken
= der von GetOAuthAccessToken zurückgegebene Zugriffstoken.OAuthSettingsLocation
= der Pfad, in dem der Connector die OAuth-Werte speichern soll, die über Verbindungen hinweg bestehen bleiben.
- Legen Sie bei nachfolgenden Datenverbindungen Folgendes fest:
InitiateOAuth
OAuthSettingsLocation
Manuelle Aktualisierung des OAuth-Zugriffstokens
Der einzige Wert, der zur manuellen Aktualisierung des OAuth-Zugriffstokens benötigt wird, ist das OAuth-Aktualisierungstoken.
- Um das OAuthAccessToken nach dem ExpiresIn-Zeitraum (zurückgegeben von GetOAuthAccessToken manuell zu aktualisieren) abgelaufen ist, rufen Sie den RefreshOAuthAccessToken gespeicherte Prozedur.
- Legen Sie die folgenden Verbindungseigenschaften fest:
OAuthClientId
= die Client-ID in Ihren Anwendungseinstellungen.OAuthClientSecret
= das Client Secret in Ihren Anwendungseinstellungen.
- Rufen Sie RefreshOAuthAccessToken auf mit OAuthRefreshToken auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken gesetzt.
- Nachdem die neuen Token abgerufen wurden, setzen Sie das
OAuthAccessToken
Eigenschaft auf den von RefreshOAuthAccessToken zurückgegebenen Wert. Dadurch wird eine neue Verbindung geöffnet.
Speichern Sie das OAuth-Aktualisierungstoken, damit Sie es verwenden können, um das OAuth-Zugriffstoken nach Ablauf manuell zu aktualisieren.
Erstellen einer benutzerdefinierten OAuth-Anwendung
Erstellen einer benutzerdefinierten OAuth-Anwendung
bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die bei der Verbindung mit Wave Financial über einen Desktop verwendet werden können
Anwendung oder eine Headless-Maschine. Um die eingebetteten Anmeldeinformationen von einem Desktop- oder Headless-Server zu verwenden, müssen Sie nur Folgendes tun:
- Satz
AuthScheme
ZuOAuth
, - holen und setzen Sie die
OAuthAccessToken
, und - legen Sie die erforderlichen Konfigurationsparameter fest.
(Informationen zum Abrufen und Festlegen von finden Sie hier OAuthAccessToken
und andere Konfigurationsparameter finden Sie im Abschnitt „Desktop-Authentifizierung“ unter „Herstellen einer Verbindung mit Wave Financial“.)
Sie müssen jedoch eine benutzerdefinierte OAuth-Anwendung erstellen, um über das Web eine Verbindung zu Wave Financial herzustellen. Und da benutzerdefinierte OAuth-Anwendungen alle drei häufig verwendeten Authentifizierungsabläufe nahtlos unterstützen, möchten Sie für diese Authentifizierungsabläufe möglicherweise ohnehin benutzerdefinierte OAuth-Anwendungen erstellen (verwenden Sie Ihre eigenen OAuth-Anwendungsanmeldeinformationen).
Benutzerdefinierte OAuth-Anwendungen sind nützlich, wenn Sie:
- Steuerung des Brandings des Authentifizierungsdialogs;.
- die Umleitungs-URI steuern, zu der die Anwendung den Benutzer nach seiner Authentifizierung umleitet; oder
- Passen Sie die Berechtigungen an, die Sie vom Benutzer anfordern.
Verfahren
- Melden Sie sich bei Ihrem Wave Financial Konto an.
- Navigieren Sie zu WaveApps Konsole.
- Klicken Sie auf
Create an application
. - Geben Sie Ihre Bewerbungsdetails ein. Wir empfehlen die Zuweisung einer Weiterleitungs URL von
http://localhost:33333/
(Standard für dieses Tool). - Speichern Sie die neue Anwendung.
- Rufen Sie die ab
OAuthClientId
UndOAuthClientSecret
.
GraphQL Einschränkungen
Jede GraphQL API hat ihre eigenen Einschränkungen und wir können nicht beliebig viele Knoten Abfrage, da jede Abfrage Kosten verursacht und die API einen Fehler zurückgibt, wenn der Connector die maximalen Kosten überschreitet. Die Abfrage ist direkt von den Seitengrößen abhängig. Der Connector verwendet seine eigenen Algorithmen zum Ermitteln der Seitengrößen, gibt Ihnen aber auch die Freiheit, diese nach Ihren Bedürfnissen anzupassen. Es gibt zwei Möglichkeiten, dieses Verhalten zu erreichen:
- Geben Sie benutzerdefinierte Seitengrößengewichte an, indem Sie einschließen
"other:pageSizeWeights"
Attribut. Nehmen wir an, wir haben eine Tabelle „Kunden“, die zwei verschachtelte GraphQl-Verbindungen hat, Unternehmen und Kunden. Wenn Sie ein bestimmtes Verhältnis zwischen diesen beiden Entitäten pro Abfrage wünschen, sagen wir 200 Kunden pro 1 Unternehmen, sollten Sie im entsprechenden Script„other:pageSizeWeights=1:200“ angeben. Der Vorteil dieses Attributs besteht darin, dass Sie unsere Logik zum Finden der optimalen Seitengröße basierend auf den Abfrage nicht umgehen. - Geben Sie benutzerdefinierte Seitengrößen an, indem Sie einfügen
"other:pageSizes"
Attribut. Durch die Angabe dieses Attributs umgehen Sie jede Prüfung, die wir für die Abfrage durchführen. Seien Sie also vorsichtig, da es zu API Fehlern kommt, wenn Sie die maximalen Kosten pro Abfrage überschreiten. Beispiel: „other:pageSizeWeights=10,30“, ruft maximal 10 Unternehmen und maximal 30 Kunden pro Unternehmen in einer Abfrage ab.
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 Wave Financial 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 möglichst viel der Verarbeitung der SELECT-Anweisung auf Wave Financial und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).
Siehe Abfrageverarbeitung für weitere Informationen.
Benutzerdefinierte Ansichten
Mit dem Wave Financial 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 Invoices 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 festlegen UserViewsSchemaName
Eigentum.
Arbeiten mit benutzerdefinierten Ansichten
Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers
listet nur Kunden in Raleigh auf:
SELECT * FROM Customers WHERE City = 'Raleigh';
Ein Beispiel für eine Abfrage an den Treiber:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Daraus ergibt sich die effektive Abfrage an die Quelle:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.
SSL-Konfiguration
Anpassen der SSL-Konfiguration
Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.
Um ein anderes Zertifikat anzugeben, siehe SSLServerCert
Eigenschaft für die verfügbaren Formate, um dies zu tun.
Datenmodell
Überblick
Der Wave Financial Connector modelliert Wave Financial Objekte als relationale Tabellen und Ansichten.
Ein Wave Financial Objekt hat Beziehungen zu anderen Objekten; in den Tabellen werden diese Beziehungen durch Fremdschlüssel ausgedrückt. Die folgenden Abschnitte zeigen die verfügbaren API Objekte und bieten weitere Informationen zur Ausführung von SQL für Wave Financial APIs.
Schemas für die meisten Datenbankobjekte werden in einfachen, textbasierten Konfigurationsdateien definiert.
Ansichten
Ansichten beschreibt die verfügbaren Ansichten. Ansichten werden statisch definiert, um Konten, Kunden, Produkte und mehr zu modellieren.
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.
Wave Financial Connector-Ansichten
Name | Beschreibung |
---|---|
Accounts | Kontenplan für das Unternehmen. |
AccountSubtypes | Untertypen von Konten auflisten. |
AccountTypes | Kontotypen auflisten. |
Businesses | Unternehmen auflisten. |
Countries | Länder auflisten. |
Currencies | Währungen auflisten. |
Customers | Liste der Kunden des Unternehmens. |
InvoiceItems | Die Einzelposten (Produkt, Einheit und Preis), aus denen sich der in Rechnung gestellte Verkauf zusammensetzt. |
InvoiceItemTaxes | Liste der auf einen Rechnungsposten angewendeten Steuern. |
Invoices | Liste der Rechnungen des Unternehmens. |
ProductDefaultSalesTaxes | Standardmäßig auf das Produkt anzuwendende Umsatzsteuer. |
ProductDefaultSalesTaxRates | Steuersätze mit ihren jeweiligen Geltungsbeginn. |
Products | Liste der Produkte (und Dienstleistungen) für das Unternehmen. |
Provinces | Liste der wichtigsten Unterteilungen. |
SalesTaxes | Liste der Umsatzsteuern für das Unternehmen. |
SalesTaxRates | Steuersätze mit ihren Geltungszeitpunkten |
Vendors | Liste der Anbieter für das Unternehmen. |
Konten
Kontenplan für das Unternehmen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Accounts WHERE Id = 'QWNjb3VudDo4MDEyMDg4OD3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE BusinessId = 'QnVzaW5lc3M6MDU3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE Name = 'Accounting Fees'
SELECT * FROM Accounts WHERE TypeValue = 'EXPENSE'
SELECT * FROM Accounts WHERE SubtypeValue = 'CASH_AND_BANK'
SELECT * FROM Accounts WHERE IsArchived = true
SELECT * FROM Accounts WHERE TypeValue IN ('EXPENSE', 'LIABILITY')
SELECT * FROM Accounts WHERE SubtypeValue IN ('COST_OF_GOODS_SOLD', 'EXPENSE')
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung für das Konto. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name des Kontos. | ||
Description | String | Benutzerdefinierte Beschreibung für das Konto. | ||
DisplayId | String | Benutzerdefinierte ID für das Konto. | ||
CurrencyCode | String | Währungen.Code | Währungscode. | |
TypeValue | String | Wert des Kontotyps. | ||
SubtypeValue | String | Wert des Kontountertyps. | ||
NormalBalanceType | String | Gutschrift oder Lastschrift. | ||
IsArchived | Bool | Gibt an, ob das Konto standardmäßig ausgeblendet ist. | ||
Sequence | Int | Numerisch aufsteigende Version, die jeweils eine Revision der Kontodaten darstellt. Sobald etwas ein Konto ändert, wird seine Sequenz hochgezählt. | ||
Balance | Decimal | Der Kontostand zum aktuellen Datum. | ||
BalanceInBusinessCurrency | Decimal | Der Kontostand zum aktuellen Datum in der Geschäftswährung. |
Konto-Untertypen
Untertypen von Konten auflisten.
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Value [KEY] | String | Wert des Kontountertyps. | ||
Name | String | Name des Kontountertyps. | ||
AccountTypeName | String | Kontotypname für den Untertyp. | ||
Archivable | Bool | Gibt an, ob Konten dieses Untertyps archiviert werden können. | ||
SystemCreated | Bool | Gibt an, ob es sich bei Konten dieses Untertyps um vom System erstellte Konten handelt. |
Kontotypen
Liste der Kontotypen.
WÄHLEN
SELECT * FROM AccountTypes
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Value [KEY] | String | Wert des Kontotyps. | ||
Name | String | Name des Kontotyps. | ||
NormalBalanceType | String | Normaler Saldotyp des Kontotyps. |
Unternehmen
Unternehmen auflisten.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT name FROM Businesses WHERE ID = 'QnVzaW5lc3M6MDU3MWUwYWYtGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung für das Unternehmen. | ||
Name | String | Der Name des Unternehmens. | ||
IsPersonal | Bool | Handelt es sich bei dem Unternehmen um ein Privatunternehmen mit eingeschränkter Funktionalität im Vergleich zu normalen Unternehmen? | ||
OrganizationalType | String | Die Organisationsart des Unternehmens. | ||
TypeName | String | Die Beschreibung der Geschäftsart in benutzerfreundlicher Form. | ||
TypeValue | String | Der Enumerationswert des Geschäftstyps. | ||
SubtypeName | String | Die Beschreibung des Geschäftsuntertyps in benutzerfreundlicher Form. | ||
SubtypeValue | String | Der Enumerationswert des Geschäftsuntertyps. | ||
CurrencyCode | String | Währungen.Code | Währungscode. | |
Timezone | String | Die Zeitzone des Unternehmens. | ||
AddressLine1 | String | Adresszeile 1 (Straßenadresse/ Box/Firmenname). | ||
AddressLine2 | String | Adresszeile 2 (Wohnung/Suite/Einheit/Gebäude). | ||
AddressCity | String | Stadt/Bezirk/Vorort/Ort/Dorf. | ||
AddressProvinceCode | String | Provinzen.Code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | |
AddressCountryCode | String | Länder.Code | Ländercode. | |
AddressPostalCode | String | Postleitzahl. | ||
Phone | String | Die Telefonnummer des Unternehmens. | ||
Fax | String | Die Faxnummer des Unternehmens. | ||
Mobile | String | Die Mobil-/Handynummer des Unternehmens. | ||
TollFree | String | Die gebührenfreie Nummer des Unternehmens. | ||
Website | String | Die Website des Unternehmens. | ||
IsClassicAccounting | Bool | Verwendet das Unternehmen ein klassisches Buchhaltungssystem? | ||
IsClassicInvoicing | Bool | Verwendet das Unternehmen ein klassisches Rechnungssystem? | ||
IsArchived | Bool | Ist das Unternehmen standardmäßig ausgeblendet. | ||
CreatedAt | Datetime | Wann das Unternehmen gegründet wurde. | ||
ModifiedAt | Datetime | Wann das Unternehmen zuletzt geändert wurde. |
Länder
Länder auflisten.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Countries WHERE Code = 'US'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Code [KEY] | String | Ländercode. | ||
Name | String | Darstellung in einfacher Sprache. | ||
CurrencyCode | String | Währungen.Code | Währungscode. | |
NameWithArticle | String | Ländername mit dazugehörigem Artikel. |
Währungen
Währungen auflisten.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Currencies WHERE Code = 'USD'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Code [KEY] | String | Währungscode. | ||
Symbol | String | Symbol, das anzeigt, dass es sich bei einer Zahl um einen Geldwert handelt. | ||
Name | String | Darstellung in einfacher Sprache. | ||
Plural | String | Pluralform des Währungsnamens. | ||
Exponent | Int | Drückt die Beziehung zwischen einer Hauptwährungseinheit und ihrer Nebenwährungseinheit aus. Die Anzahl der Ziffern rechts von der Dezimalstelle, die den Bruchteil dieser Währung darstellen (nimmt eine Basis von 10 an). |
Kunden
Kundenliste des Unternehmens.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Customers WHERE Id = 'QnVzaW5lc3M6NjE2MtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTY1'
SELECT * FROM Customers WHERE BusinessId = 'QnVYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Customers WHERE ModifiedAt > '2019-10-30 07:14:55.0' AND ModifiedAt < '2019-10-30 07:18:03.0'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung für den Kunden. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name oder Firmenname des Kunden. | ||
FirstName | String | Vorname des Hauptansprechpartners. | ||
LastName | String | Nachname des Hauptansprechpartners. | ||
Email | String | Email des Hauptansprechpartners. | ||
AddressAddressLine1 | String | Adresszeile 1 (Straßenadresse/ Box/Firmenname). | ||
AddressAddressLine2 | String | Adresszeile 2 (Wohnung/Suite/Einheit/Gebäude). | ||
AddressCity | String | Stadt/Bezirk/Vorort/Ort/Dorf. | ||
AddressProvinceCode | String | Provinzen.Code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | |
AddressCountryCode | String | Länder.Code | Ländercode. | |
AddressPostalCode | String | Postleitzahl. | ||
DisplayId | String | Benutzerdefinierte ID für den Kunden. Allgemein als Kontonummer bezeichnet. | ||
Mobile | String | Mobiltelefonnummer des Hauptansprechpartners. | ||
Phone | String | Telefonnummer des Kunden. | ||
Fax | String | Faxnummer des Kunden. | ||
TollFree | String | Kostenlose Rufnummer des Kunden. | ||
Website | String | Website-Adresse des Kunden. | ||
InternalNotes | String | Interne Notizen zum Kunden. | ||
CurrencyCode | String | Währungen.Code | Währungscode. | |
ShippingName | String | Name oder Firmenname des Kunden. | ||
ShippingAddressLine1 | String | Adresszeile 1 (Straßenadresse/ Box/Firmenname). | ||
ShippingAddressLine2 | String | Adresszeile 2 (Wohnung/Suite/Einheit/Gebäude). | ||
ShippingAddressCity | String | Stadt/Bezirk/Vorort/Ort/Dorf. | ||
ShippingAddressProvinceCode | String | Provinzen.Code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | |
ShippingAddressCountryCode | String | Länder.Code | Ländercode. | |
ShippingAddressPostalCode | String | Postleitzahl. | ||
ShippingPhone | String | Telefonnummer des Kunden. | ||
ShippingInstructions | String | Lieferanweisungen zur Handhabung. | ||
CreatedAt | Datetime | Wann der Kunde erstellt wurde. | ||
ModifiedAt | Datetime | Wann der Kunde zuletzt geändert wurde. | ||
IsArchived | Bool | Ob der Kunde archiviert ist oder nicht. |
Rechnungspositionen
Die Einzelposten (Produkt, Einheit und Preis), aus denen sich der in Rechnung gestellte Verkauf zusammensetzt.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM InvoiceItems WHERE InvoiceId = 'QnVzaW5lc3M6MTY4NTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
ProductId [KEY] | String | Produkte.Id | Eindeutige Kennung für das zugehörige Produkt. | |
InvoiceId [KEY] | String | Rechnungen.Id | Eindeutige Kennung für die Rechnung. | |
Quantity | Decimal | Anzahl der Einheiten. | ||
Price | Decimal | Preis pro Einheit. | ||
SubtotalValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
SubtotalCurrencyCode | String | Währungen.Code | Währungscode. | |
TotalValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
TotalCurrencyCode | String | Währungen.Code | Währungscode. | |
AccountId | String | Eindeutige Kennung für das Konto. |
RechnungspostenSteuern
Liste der auf einen Rechnungsposten erhobenen Steuern.
WÄHLEN
SELECT * FROM InvoiceItemTaxes
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
SalesTaxId [KEY] | String | Die eindeutige Kennung für die Umsatzsteuer. | ||
ProductId [KEY] | String | Produkte.Id | Zugehörige Produkt-ID. | |
AmountValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
AmountCurrencyCode | String | Währungen.Code | Währungscode. |
Rechnungen
Liste der Rechnungen für das Unternehmen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Invoices WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Invoices WHERE CustomerID = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Invoices WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM Invoices WHERE InvoiceDate >= '2020-07-03'
SELECT * FROM Invoices WHERE Status = 'SENT'
SELECT * FROM Invoices WHERE CurrencyCode = 'USD'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung für die Rechnung. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
CreatedAt | Datetime | Wann die Rechnung erstellt wurde. | ||
ModifiedAt | Datetime | Wann die Rechnung zuletzt geändert wurde. | ||
PdfUrl | String | URL für den Zugriff auf die PDF-Darstellung der Rechnung. | ||
ViewUrl | String | URL zum Online-Anzeigen der Rechnung aus der Sicht eines Kunden. | ||
CustomerId | String | Kunden.id | Eindeutige Kennung für den Kunden. | |
CustomerName | String | Der Name des Kunden. | ||
Status | String | Status der Rechnung. Die zulässigen Werte sind ENTWURF, ÜBERFÄLLIG, BEZAHLT, TEILWEISE, GESPEICHERT, GESENDET, UNBEZAHLT, ANGESEHEN. | ||
Title | String | Rechnungstitel oben im Dokument. | ||
Subhead | String | Text der Unterüberschrift der Rechnung. | ||
InvoiceNumber | String | Der Rechnung wird eine eindeutige Nummer zugewiesen. | ||
PoNumber | String | Bestell- oder Verkaufsauftragsnummer für die Rechnung. | ||
InvoiceDate | Date | Datum der Rechnungsausstellung. | ||
DueDate | Date | Datum, an dem die Zahlung fällig ist. | ||
AmountDueValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
AmountDueCurrencyCode | String | Währungen.Code | Währungscode. | |
AmountPaidValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
AmountPaidCurrencyCode | String | Währungen.Code | Währungscode. | |
TaxTotalValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
TaxTotalCurrencyCode | String | Währungen.Code | Währungscode. | |
TotalValue | Decimal | Betrag dargestellt als Kombination aus Haupt- und Nebenwährungseinheit (verwendet ein Dezimaltrennzeichen). | ||
TotalCurrencyCode | String | Währungen.Code | Währungscode. | |
CurrencyCode | String | Währungen.Code | Währungscode. | |
ExchangeRate | Decimal | Umrechnungskurs von der Rechnungswährung in die Unternehmenswährung. Wird zur Bewertung des Rechnungsertrags in den Buchhaltungstransaktionen von Wave verwendet. | ||
Memo | String | Text des Rechnungsmemos (Notizen). | ||
Footer | String | Fußzeilentext der Rechnung. | ||
DisableCreditCardPayments | Bool | Gibt in einem Unternehmen, das Kreditkartenzahlungen akzeptieren kann, an, ob diese einzelne Rechnung als nicht per Karte zahlbar gekennzeichnet wurde. | ||
DisableBankPayments | Bool | Gibt in einem Unternehmen, das Bankzahlungen akzeptieren darf, an, ob diese einzelne Rechnung als nicht per Bankzahlung zahlbar gekennzeichnet wurde. | ||
ItemTitle | String | Die Bezeichnung für die Spalte „Artikel“ in der Einzelpostenliste. | ||
UnitTitle | String | Die Bezeichnung für die Spalte „Einheit“ in der Auflistung der Rechnungspositionen. | ||
PriceTitle | String | Die Bezeichnung für die Spalte „Preis“ in der Auflistung der Rechnungspositionen. | ||
AmountTitle | String | Die Bezeichnung für die Spalte „Betrag“ (= Einheit x Preis) in der Auflistung der Rechnungspositionen. | ||
HideName | Bool | Gibt an, ob der Produktname des Artikels in der Artikelspalte in der Einzelartikelliste ausgeblendet ist. | ||
HideDescription | Bool | Gibt an, ob die Artikelbeschreibung in der Artikelspalte in der Einzelartikelliste ausgeblendet ist. | ||
HideUnit | Bool | Gibt an, ob die Einheit des Artikels in der Einzelpostenliste ausgeblendet ist. | ||
HidePrice | Bool | Gibt an, ob der Artikelpreis in der Einzelpostenliste ausgeblendet ist. | ||
HideAmount | Bool | Gibt an, ob der Artikelbetrag in der Einzelpostenliste ausgeblendet ist. | ||
LastSentAt | Datetime | Wann die Rechnung zuletzt versendet wurde. | ||
LastSentVia | String | Wie die Rechnung zuletzt versendet wurde. | ||
LastViewedAt | Datetime | Wann die Rechnung zuletzt vom Kunden angesehen wurde. | ||
DisableAmexPayments | Bool | Gibt in einem Unternehmen, das Kreditkartenzahlungen akzeptieren kann, an, ob diese einzelne Rechnung als nicht zahlbar durch American Express gekennzeichnet wurde. |
ProduktStandardUmsatzSteuern
Standardmäßige Umsatzsteuer, die auf das Produkt erhoben wird.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM ProductDefaultSalesTaxes WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung für die Umsatzsteuer. | ||
ProductId [KEY] | String | Produkte.Id | Eindeutige Kennung für das Produkt. | |
BusinessId | String | Unternehmen.Id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name der Steuer. | ||
Abbreviation | String | Eine Kurzform oder ein Code, der die Umsatzsteuer darstellt. | ||
Description | String | Benutzerdefinierte Beschreibung für die Umsatzsteuer. | ||
TaxNumber | String | Die von einer Steuerbehörde ausgestellte Steueridentifikationsnummer. | ||
ShowTaxNumberOnInvoices | Bool | Steuernummer neben dem Steuernamen auf einer Rechnung anzeigen. | ||
Rate | Decimal | Steuersatz gültig ab Datum oder aktuellem Datum, wenn kein Parameter vorhanden ist, als Dezimalzahl (z. B. entspricht 0,15 15 %). | ||
IsCompound | Bool | Ist eine zusammengesetzte Steuer oder gestapelte Steuer. Diese Steuer wird zusätzlich zum Zwischenbetrag und anderen Steuerbeträgen berechnet. | ||
IsRecoverable | Bool | Ist eine erstattungsfähige Steuer. Sie ist erstattungsfähig, wenn Sie die Steuer, die Sie als Unternehmen bezahlt haben, von der Steuer, die Sie eingenommen haben, abziehen können. | ||
IsArchived | Bool | Ist die Umsatzsteuer standardmäßig ausgeblendet? | ||
CreatedAt | Datetime | Wann die Umsatzsteuer eingeführt wurde. | ||
ModifiedAt | Datetime | Wann die Umsatzsteuer zuletzt geändert wurde. |
ProduktStandardUmsatzSteuerSätze
Steuersätze mit ihren jeweiligen Geltungsterminen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM ProductDefaultSalesTaxRates WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxRates WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
SalesTaxId [KEY] | String | ProductDefaultSalesTaxes.Id | Die eindeutige Kennung für die Umsatzsteuer. | |
ProductId [KEY] | String | Produkte.Id | Eindeutige Kennung für das Produkt. | |
BusinessId | String | Unternehmen.Id | Die eindeutige Kennung für das Unternehmen. | |
Effective | Date | Datum, ab dem der Umsatzsteuersatz gilt. | ||
Rate | Decimal | Ab dem Inkrafttreten gilt der Steuersatz als Dezimalzahl (z. B. 0,15 entspricht 15 %). |
Produkte
Liste der Produkte (und Dienstleistungen) für das Unternehmen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Products WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Products WHERE Id = 'QzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Products WHERE IsSold = true
SELECT * FROM Products WHERE IsBought = true
SELECT * FROM Products WHERE IsArchived = true
SELECT * FROM Products WHERE ModifiedAt < '2020-07-03 08:28:56.0'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung für das Produkt. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name des Produkts. | ||
Description | String | Beschreibung des Produkts. | ||
UnitPrice | Decimal | Preis pro Einheit in der Hauptwährungseinheit. | ||
IsSold | Bool | Ist ein vom Unternehmen verkauftes Produkt. Erlauben Sie, dass dieses Produkt oder diese Dienstleistung zu Rechnungen hinzugefügt wird. | ||
IsBought | Bool | Ist ein vom Unternehmen gekauftes Produkt. Erlauben Sie, dass dieses Produkt oder diese Dienstleistung zu den Rechnungen hinzugefügt wird. | ||
IncomeAccountId | String | Konten.Id | Eindeutige Kennung für das Konto. | |
ExpenseAccountId | String | Konten.Id | Eindeutige Kennung für das Konto. | |
IsArchived | Bool | Ist das Produkt standardmäßig ausgeblendet? | ||
CreatedAt | Datetime | Wann das Produkt erstellt wurde. | ||
ModifiedAt | Datetime | Wann das Produkt zuletzt geändert wurde. |
Provinzen
Liste der wichtigsten Unterteilungen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Provinces WHERE CountryCode = 'US'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Code [KEY] | String | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | ||
CountryCode | String | Länder.Code | Ländercode. | |
Slug | String | Informeller Name zur Identifizierung. | ||
Name | String | Darstellung in einfacher Sprache. |
Umsatzsteuer
Liste der Umsatzsteuern für das Unternehmen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM SalesTaxes WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM SalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM SalesTaxes WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM SalesTaxes WHERE IsArchived = true
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung für die Umsatzsteuer. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name der Steuer. | ||
Abbreviation | String | Eine Kurzform oder ein Code, der die Umsatzsteuer darstellt. | ||
Description | String | Benutzerdefinierte Beschreibung für die Umsatzsteuer. | ||
TaxNumber | String | Die von einer Steuerbehörde ausgestellte Steueridentifikationsnummer. | ||
ShowTaxNumberOnInvoices | Bool | Steuernummer neben dem Steuernamen auf einer Rechnung anzeigen. | ||
Rate | Decimal | Steuersatz gültig ab Datum oder aktuellem Datum, wenn kein Parameter vorhanden ist, als Dezimalzahl (z. B. entspricht 0,15 15 %). | ||
IsCompound | Bool | Ist eine zusammengesetzte Steuer oder gestapelte Steuer. Diese Steuer wird zusätzlich zum Zwischenbetrag und anderen Steuerbeträgen berechnet. | ||
IsRecoverable | Bool | Ist eine erstattungsfähige Steuer. Sie ist erstattungsfähig, wenn Sie die Steuer, die Sie als Unternehmen bezahlt haben, von der Steuer, die Sie eingenommen haben, abziehen können. | ||
IsArchived | Bool | Ist die Umsatzsteuer standardmäßig ausgeblendet? | ||
CreatedAt | Datetime | Wann die Umsatzsteuer eingeführt wurde. | ||
ModifiedAt | Datetime | Wann die Umsatzsteuer zuletzt geändert wurde. |
Umsatzsteuersätze
Steuersätze mit ihren jeweiligen Geltungsbeginnen
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
SalesTaxId [KEY] | String | Umsatzsteuer.Id | Die eindeutige Kennung für die Umsatzsteuer. | |
BusinessId | String | Unternehmen.Id | Die eindeutige Kennung für das Unternehmen. | |
Effective | Date | Datum, ab dem der Umsatzsteuersatz gilt. | ||
Rate | Decimal | Ab dem Inkrafttreten gilt der Steuersatz als Dezimalzahl (z. B. 0,15 entspricht 15 %). |
Anbieter
Liste der Lieferanten für das Unternehmen.
Tabellenspezifische Informationen
Der Connector verwendet die Wave Financial API, um einige der Filter zu verarbeiten. Der Connector verarbeitet andere Filter clientseitig innerhalb des Connectors. Sie können die clientseitige Ausführung der Abfrage deaktivieren, indem Sie SupportEnhancedSQL auf „false“ setzen. In diesem Fall führen alle Suchkriterien, die auf andere Spalten verweisen, zu inkonsistenten Daten. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet.
WÄHLEN
SELECT * FROM Vendors WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2DM4MTcyNTdl'
SELECT * FROM Vendors WHERE ModifiedAt < '2020-02-26 18:02:06.171'
Spalten
Name | Typ | Referenzen | UnterstützteOperatoren | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung für den Kunden. | ||
BusinessId | String | Unternehmen.id | Die eindeutige Kennung für das Unternehmen. | |
Name | String | Name oder Firmenname des Verkäufers. | ||
AddressLine1 | String | Adresszeile 1 (Straßenadresse/ Box/Firmenname). | ||
AddressLine2 | String | Adresszeile 2 (Wohnung/Suite/Einheit/Gebäude). | ||
AddressCity | String | Stadt/Bezirk/Vorort/Ort/Dorf. | ||
AddressProvinceCode | String | Provinzen.Code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | |
AddressCountryCode | String | Länder.Code | Ländercode. | |
AddressPostalCode | String | Postleitzahl. | ||
FirstName | String | Der Vorname des Hauptansprechpartners. | ||
LastName | String | Der Nachname des Hauptansprechpartners. | ||
DisplayId | String | Benutzerdefinierte ID für den Lieferanten. Allgemein als Kontonummer bezeichnet. | ||
Email | String | Email des Hauptverkäufers. | ||
Mobile | String | Die Mobiltelefonnummer des Verkäufers. | ||
Phone | String | Die Telefonnummer des Verkäufers. | ||
Fax | String | Faxnummer des Verkäufers. | ||
TollFree | String | Kostenlose Rufnummer des Anbieters. | ||
Website | String | Website-Adresse des Anbieters. | ||
InternalNotes | String | Interne Notizen zum Lieferanten. | ||
CurrencyCode | String | Währungen.Code | Währungscode. | |
ShippingName | String | Name oder Firmenname des Kunden. | ||
ShippingAddressLine1 | String | Adresszeile 1 (Straßenadresse/ Box/Firmenname). | ||
ShippingAddressLine2 | String | Adresszeile 2 (Wohnung/Suite/Einheit/Gebäude). | ||
ShippingAddressCity | String | Stadt/Bezirk/Vorort/Ort/Dorf. | ||
ShippingAddressProvinceCode | String | Provinzen.Code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) Kennung. | |
ShippingAddressCountryCode | String | Länder.Code | Ländercode. | |
ShippingAddressPostalCode | String | Postleitzahl. | ||
ShippingPhone | String | Telefonnummer des Kunden. | ||
ShippingInstructions | String | Lieferanweisungen zur Handhabung. | ||
CreatedAt | Datetime | Wann der Lieferant erstellt wurde. | ||
ModifiedAt | Datetime | Wann der Anbieter zuletzt geändert wurde. | ||
IsArchived | Bool | Ob der Lieferant archiviert ist oder nicht. |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit Wave Financial hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Wave Financial zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren für den Wave Financial Connector
Name | Beschreibung |
---|---|
GetOAuthAccessToken | Ruft ein Authentifizierungstoken von WaveFinancial ab. |
GetOAuthAuthorizationURL | Ruft die Autorisierungs-URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern das Authentifizierungstoken von dieser URL an. |
RefreshOAuthAccessToken | Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei WaveFinancial verwendet wird. |
GetOAuthAccessToken
Erhält ein Authentifizierungstoken von WaveFinancial.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | Falsch | Geben Sie entweder APP oder WEB ein. Der zu verwendende Authentifizierungsmodustyp. Auf APP setzen, um Authentifizierungstoken über eine Desktop-App abzurufen. Auf WEB setzen, um Authentifizierungstoken über eine Web-App abzurufen. Der Standardwert ist APP. |
Scope | String | Falsch | Eine durch Kommas getrennte Liste von Berechtigungen, die vom Benutzer angefordert werden sollen. Eine Liste der verfügbaren Berechtigungen finden Sie in der WaveFinancial API. Der Standardwert ist account:read business:read customer:read invoice:read product:read sales_tax:read user:read vendor:read. |
Verifier | String | Falsch | Das von WaveFinancial zurückgegebene Verifizierungstoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Weiterleitungs-URL in den WaveFinancial-App-Einstellungen übereinstimmen. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Der Zugriffstoken, der für die Kommunikation mit WaveFinancial verwendet wird. |
OAuthRefreshToken | String | Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft. |
GetOAuthAuthorizationURL
Ruft die Autorisierungs URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern das Authentifizierungstoken von dieser URL an.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. |
Scope | String | Falsch | Eine durch Kommas getrennte Liste von Berechtigungen, die vom Benutzer angefordert werden sollen. Eine Liste der verfügbaren Berechtigungen finden Sie in der WaveFinancial API. Der Standardwert ist account:read business:read customer:read invoice:read product:read sales_tax:read user:read vendor:read. |
State | String | Falsch | Gibt einen beliebigen Status an, der für Ihre Anwendung nach Erhalt der Antwort nützlich sein kann. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum QuickBooksOnline-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. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren. |
Aktualisieren Sie das OAuthAccessToken
Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei WaveFinancial verwendet wird.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | True | Setzen Sie dies auf den abgelaufenen Tokenwert. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von WaveFinancial zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Dies ist dasselbe wie das Zugriffstoken. |
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 Wave Financial 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:
- Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.
Sys_catalogs
Listet die verfügbaren Datenbanken auf.
Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:
SELECT * FROM sys_catalogs
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
Sys_schemas
Listet die verfügbaren Schemas auf.
Die folgende Abfrage ruft alle verfügbaren Schemata ab:
SELECT * FROM sys_schemas
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
SchemaName | String | Der Schema. |
Sys_tables
Listet die verfügbaren Tabellen auf.
Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:
SELECT * FROM sys_tables
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht. |
TableType | String | Der Tabellentyp (Tabelle oder Ansicht). |
Description | String | Eine Beschreibung der Tabelle oder Ansicht. |
IsUpdateable | Boolean | Ob die Tabelle aktualisiert werden kann. |
Sys_tablecolumns
Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle „Rechnungen“ zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
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 SampleProcedure zurück:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' 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 „Rechnungen“ ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
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:wavefinancial: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. |
Systeminformationen
Beschreibt die verfügbaren Systeminformationen.
Die folgende Abfrage ruft alle Spalten ab:
SELECT * FROM sys_information
Spalten
Name | Typ | Beschreibung |
---|---|---|
Product | String | Der Name des Produkts. |
Version | String | Die Versionsnummer des Produkts. |
Datasource | String | Der Name der Datenquelle, mit der das Produkt eine Verbindung herstellt. |
NodeId | String | Die eindeutige Kennung der Maschine, auf der das Produkt installiert ist. |
HelpURL | String | Die URL zur Hilfedokumentation des Produkts. |
License | String | Die Lizenzinformationen für das Produkt. (Wenn diese Informationen nicht verfügbar sind, kann das Feld leer gelassen oder als „N/A“ markiert werden.) |
Location | String | Der Dateipfad, in dem die Produktbibliothek gespeichert ist. |
Environment | String | Die Version der Umfeld oder Rumtine, unter der das Produkt derzeit ausgeführt wird. |
DataSyncVersion | String | Die zur Verwendung dieses Connectors erforderliche Synchronisierungsebene. |
DataSyncCategory | String | Die Kategorie der Synchronisierungsfunktionalität (z. B. Quelle, Ziel). |
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.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der bei der Verbindung mit Wave Financial zu verwendende Authentifizierungstyp. |
APIToken | Das API Token, das Sie erhalten, wenn Sie eine Wave Financial Anwendung registrieren. |
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://' . |
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. |
Eigenschaft | Beschreibung |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
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. |
Eigenschaft | Beschreibung |
---|---|
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. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der bei der Verbindung mit Wave Financial zu verwendende Authentifizierungstyp. |
APIToken | Das API Token, das Sie erhalten, wenn Sie eine Wave Financial Anwendung registrieren. |
AuthScheme
Der bei der Verbindung mit Wave Financial zu verwendende Authentifizierungstyp.
Mögliche Werte
OAuth
, Token
Datentyp
string
Standardwert
OAuth
Hinweise
- Token: Legen Sie dies fest, um die Token-Authentifizierung von Wave Financial durchzuführen.
- OAuth: Legen Sie dies fest, um die Wave Financial OAuth-Authentifizierung durchzuführen.
APIToken
Das API Token, das Sie erhalten, wenn Sie eine Wave Financial Anwendung registrieren.
Datentyp
string
Standardwert
""
Hinweise
Sie können mit den folgenden Schritten ein API Token erhalten:
- Melden Sie sich bei Ihrem Wave Financial Konto an und navigieren Sie zu
Manage Applications
im linken Bereich. - Wählen Sie die Anwendung aus, für die Sie ein Token erstellen möchten. Möglicherweise müssen Sie zuerst eine Anwendung erstellen.
- Klicken Sie auf
Create token
Schaltfläche zum Generieren einesAPIToken
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://' . |
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:
OFF
: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.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.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%\WaveFinancial Data Provider\OAuthSettings.txt
Hinweise
Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH
oder REFRESH
, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.
Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://'
gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um 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_props
Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.
Der Standardspeicherort ist „%APPDATA%\WaveFinancial Data Provider\OAuthSettings.txt“ mit %APPDATA%
auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.
Die folgende Tabelle listet den Wert von auf %APPDATA%
nach Operationssystem:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
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.
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%\WaveFinancial 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%\WaveFinancial 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 |
---|---|
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. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
MaxRows
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Datentyp
int
Standardwert
-1
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. |
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.
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 Invoices 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.