Adobe Analytics Verbindungsdetails
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8803 des Connectors.
Erste Schritte
Versionsunterstützung für Adobe Analytics
Der Connector nutzt die Adobe Analytics API v2.0, um den Zugriff auf Adobe Analytics Objekte wie Dimensionen, Metriken und Benutzer zu ermöglichen.
Herstellen einer Verbindung
Herstellen einer Verbindung mit Adobe Analytics
Um eine Verbindung zu Adobe Analytics herzustellen, GlobalCompanyId
Und RSID
müssen identifiziert werden. Standardmäßig versucht der Connector, Ihr Unternehmen und Ihre Berichtssuite automatisch zu identifizieren. Alternativ können Sie das Unternehmen und die Berichtssuite explizit identifizieren:
Globale Firmen-ID
GlobalCompanyId
ist eine optionale Verbindungseigenschaft. Wenn es leer gelassen wird, versucht der Connector, die Global Company ID automatisch zu erkennen.
So finden Sie die globale Unternehmens-ID:
- Suchen Sie in der Anforderungs URL nach
users/me
Endpoint auf der Swagger UI. - Erweitern Sie den Endpoint des Benutzers und klicken Sie dann auf
GET users/me
-Schaltfläche. - Klicken Sie auf die
Try it out > Execute
Schaltflächen. - Stellen Sie die
GlobalCompanyId
Verbindungseigenschaft zur globalen Firmen-ID, die in der Anforderungs URL unmittelbar vor dem angezeigt wirdusers/me
Endpoint.
Berichtssuite-ID
RSID
ist eine optionale Verbindungseigenschaft. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen. Um eine vollständige Liste Ihrer Report Suites mit ihren Kennungen neben dem Namen zu erhalten, navigieren Sie zu Admin > Report Suites
.
Authentifizieren bei Adobe Analytics
Adobe Analytics verwendet den OAuth-Authentifizierungsstandard. Sie können sich mit der OAuth-Integration oder der Service Account-Integration authentifizieren.
Benutzerkonten (OAuth)
AuthScheme
muss auf gesetzt werden OAuth
in allen Benutzerkonto-Flows.
Hinweis
Bei der Adobe-Authentifizierung über OAuth müssen Sie Ihr Aktualisierungstoken alle zwei Wochen aktualisieren. Wir empfehlen stattdessen die Verwendung von OAuthJWT.
Desktop-Anwendungen
Es wird eine eingebettete OAuth-Anwendung bereitgestellt, die die OAuth-Desktop-Authentifizierung vereinfacht. Alternativ können Sie eine benutzerdefinierte OAuth-Anwendung erstellen. Siehe Erstellen einer benutzerdefinierten OAuth-App für Informationen zum Erstellen benutzerdefinierter Anwendungen und Gründe dafür.
OAuth-Zugriffstoken abrufen und aktualisieren
Nachdem Sie Folgendes festgelegt haben, können Sie eine Verbindung herstellen:
InitiateOAuth
: Setzen Sie dies aufGETANDREFRESH
. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeidenOAuthAccessToken
.OAuthClientId
(nur benutzerdefinierte Anwendungen): Legen Sie hier die Client-ID fest, die Ihnen bei der Registrierung Ihrer App zugewiesen wurde.OAuthClientSecret
(nur benutzerdefinierte Anwendungen): Legen Sie hier das Client-Geheimnis fest, das Ihnen bei der Registrierung Ihrer App zugewiesen wurde.CallbackURL
(nur benutzerdefinierte Anwendung): Legen Sie hier die Umleitungs-URI fest, die Sie bei der Registrierung Ihrer App definiert haben. Beispiel:https://localhost:3333
Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Adobe Analytics in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen. Anschließend schließt der Connector den OAuth-Prozess ab:
- Der Connector erhält einen Zugriffstoken von Adobe Analytics und verwendet ihn, um Daten anzufordern.
- Die OAuth-Werte werden an dem in angegebenen Ort gespeichert
OAuthSettingsLocation
, um über mehrere Verbindungen hinweg bestehen zu bleiben.
Der Connector aktualisiert das Zugriffstoken automatisch, wenn es abläuft.
Dienstkonto (JWT OAuth)
Setzen Sie die AuthScheme
an OAuthJWT, um sich mit dieser Methode zu authentifizieren.
Dienstkonten verfügen über eine stille Authentifizierung, die keine Benutzerauthentifizierung im Browser erfordert.
Sie müssen in diesem Ablauf eine Anwendung erstellen. Siehe Erstellen einer benutzerdefinierten OAuth-App, um eine App zu erstellen und zu autorisieren. Sie können dann eine Verbindung zu Adobe Analytics Daten herstellen, auf die das Dienstkonto Zugriffsberechtigung hat.
Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:
InitiateOAuth
: Auf setzenGETANDREFRESH
.OAuthClientId
: In Ihren App-Einstellungen auf die Client-ID einstellen.OAuthClientSecret
: Stellen Sie das Client-Geheimnis in Ihren App-Einstellungen ein.OAuthJWTCertType
: Auf „PUBLIC_KEY_FILE“ setzen.OAuthJWTCert
: Auf den Pfad zur von Ihnen generierten .key-Datei setzen.OAuthJWTCertPassword
: Auf das Passwort der .key-Datei setzen.OAuthJWTIssuer
: Legen Sie Ihre Organisations-ID aus der Adobe I/O-Konsolenintegration im Format org_ident@AdobeOrg fest. Dies identifiziert die Organisation, die für den Zugriff auf die Adobe I/O API konfiguriert wurde.
Wenn Sie eine Verbindung herstellen, schließt der Connector den OAuth-Flow für ein Dienstkonto ab.
- Erstellt und signiert das JWT mit dem vom Connector benötigten Anspruchssatz.
- Tauscht das JWT gegen das Zugriffstoken aus.
- Speichert OAuth-Werte in
OAuthSettingsLocation
soll über mehrere Verbindungen hinweg bestehen bleiben. - Sendet das JWT für ein neues Zugriffstoken, wenn das Token abläuft.
Erstellen einer benutzerdefinierten OAuth-App
Sie müssen eine benutzerdefinierte OAuth-App erstellen, um eine Verbindung mit Adobe Analytics herzustellen.
Erstellen einer App für die OAuth-Integration
Befolgen Sie die nachstehenden Schritte, um eine benutzerdefinierte App zu erstellen und die Verbindungseigenschaften in einem bestimmten OAuth-Authentifizierungsfluss abzurufen.
- Navigieren Sie zur folgenden URL:
https://console.adobe.io/home
. - Klicken Sie auf
Create new project
-Schaltfläche. - Wählen Sie die-Schaltfläche aus
Add API
Option. - Auswählen
Adobe Analytics
, klickNext
, und wählen Sie dannOAuth
und dann klicken Sie aufNext
erneut. - Wählen Sie
Web
Option und füllen Sie die Umleitungs-URIs aus. Für eine Desktop-Anwendung können Sie eine Localhost-URL wiehttps://localhost:33333
. Geben Sie bei einer Webanwendung die URL der Seite auf Ihrer Website an, zu der weitergeleitet werden soll. - Klicken Sie auf
Save configured API
.
Ihr Client ist nun erstellt. Beachten Sie, dass Ihr Client eine Client-ID (API -Schlüssel) und ein Client-Geheimnis hat. Diese werden benötigt, um Ihren Authentifizierungscode abzurufen und Zugriffstoken zu generieren.
Erstellen einer App für die Servicekontointegration
Befolgen Sie die nachstehenden Schritte, um eine benutzerdefinierte App zu erstellen und die Verbindungseigenschaften in einem bestimmten Dienstkonto-Authentifizierungsfluss abzurufen.
- Navigieren Sie zur folgenden URL:
https://console.adobe.io/home
. - Klicken Sie auf
Create new project
-Schaltfläche. - Wählen Sie die-Schaltfläche aus
Add API
Option. - Auswählen
Adobe Analytics
, klickNext
, und wählen Sie dannService Account (JWT)
und dann klicken Sie aufNext
erneut. - Wählen Sie entweder
Generate a key pair
oderUpload your public key
. Wenn Sie sich dafür entscheidenGenerate a key pair
, speichern Sie die Datei config.zip lokal, da diese das Zertifikat enthält, das Sie zum Herstellen der Verbindung benötigen. Klicken Sie aufNext
nachdem der Schlüssel erstellt oder hochgeladen wurde. Creating Your Own Public Key Certificate
MacOS and Linux
Öffnen Sie ein Terminal und führen Sie den folgenden Befehl aus:
openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crtWindows
Laden Sie einen OpenSSL-Client wie OpenSSL Light herunter, um öffentliche Zertifikate zu generieren. Die folgenden Schritte gelten für OpenSSL Light
Öffnen Sie ein Befehlszeilenfenster und führen Sie die folgenden Befehle aus:
1) cd "C:\Programme\OpenSSL-Win64\bin"
2) .\openssl.exe req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
- Wählen Sie ein oder mehrere Produktprofile aus (in Produktprofilen können Sie Berechtigungen für die App festlegen) und klicken Sie dann auf
Save configured API
.
Ihr Client ist nun erstellt. Beachten Sie, dass Ihr Client eine Client-ID (API -Schlüssel), ein Client-Geheimnis, eine Organisations-ID und eine technische Konto-ID hat. Diese werden benötigt, um ein JWT-Token zu erhalten und Zugriffstoken zu generieren.
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 Adobe Analytics Connectors beschrieben.
Benutzerdefinierte Ansichten
Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.
SSL-Konfiguration
Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert
-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.
Proxy
So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings
Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.
Abfrageverarbeitung
Der Connector verlagert die Verarbeitung der SELECT-Anweisung so weit wie möglich auf Adobe Analytics und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).
Benutzerdefinierte Ansichten
Mit dem Adobe Analytics 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 SampleTable_1 WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie UserDefinedViews
Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Definieren von Ansichten mit DDL-Anweisungen
Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.
Erstellen einer Ansicht
Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:
CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;
Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews
Verbindungseigenschaft.
Ändern einer Ansicht
Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:
ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.
Löschen einer Ansicht
Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.
DROP LOCAL VIEW [MyViewName]
Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.
Schema für benutzerdefinierte Ansichten
Benutzerdefinierte Ansichten werden im angezeigt UserViews
Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie 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
Der Adobe Analytics Connector modelliert Adobe Analytics Objekte als relationale Tabellen und Ansichten. Die folgenden Abschnitte zeigen die verfügbaren API -Objekte und bieten weitere Informationen zur Ausführung von SQL für Adobe Analytics APIs.
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können verwendet werden, um auf zusätzliche Funktionen der Adobe Analytics API zuzugreifen.
Ansichten
Berichte werden als Ansichten angezeigt, also als Tabellen, die nicht geändert werden können. Im Gegensatz zu herkömmlichen Datenbankansichten ist es jedoch nicht sehr hilfreich, alle Metriken und Dimensionen in einer bestimmten Tabelle auszuwählen. Das Datum ist die Standarddimension für jeden Bericht, daher lautet die Abfrage:
SELECT * FROM MyReport
wird zu:
SELECT Date, {all the metrics here} FROM MyReport
Wenn die Abfrage jedoch Kriterien enthält, sind die Standarddimensionen die in den Kriterien verwendeten Dimensionen, beispielsweise:
SELECT * FROM MyReport WHERE Country = 'England'
wird zu:
SELECT Country, {all the metrics here} FROM MyReport WHERE Country = 'England'
Darüber hinaus begrenzt die Adobe Analytics API die Anzahl der Dimensionen, für die Sie Daten pro REST- API Aufruf anfordern können, auf eine. Dies bedeutet, dass der Anbieter Berichte mit mehreren Dimensionen nur erstellen kann, indem er die Dimensionen in Teile aufteilt.
Betrachten wir ein Abfrage:
SELECT Country, City, Visits FROM MyReport
- Zunächst fordert der Anbieter alle Werte der ersten Dimension „Land“ an, angenommen, es sind England und Deutschland.
- Zweitens versucht der Anbieter, England in Teile mit der Dimension „Stadt“ zu zerlegen, und erhält, nehmen wir an: London, Liverpool.
- Schließlich teilt es Deutschland in Städteteile und erhält: Berlin, Frankfurt.
Wenn wir eine dritte Dimension hätten, würde der Anbieter jede Stadt in Teile mit der dritten Dimension aufteilen (was bedeutet, dass er pro Stadt eine Anfrage stellen würde).
Stellen Sie sich nun einen vierdimensionalen Bericht vor, dessen Dimensionen viele Werte haben. Die Generierung dieses Berichts würde viele API Aufrufe erfordern.
Die Adobe Analytics API ermöglicht es uns jedoch, einige Filter bereitzustellen, die die Ausführungszeit der Abfrage enorm verkürzen können.
Adobe Analytics API verwendet die folgenden logischen Operatoren: „UND“, „ODER“, „NICHT“
und verwendet außerdem die folgenden Operatoren: „MATCH“, „CONTAINS“, „BEGINS-WITH“ und „ENDS-WITH“, was bedeutet, dass Kriterien wie die folgenden serverseitig verarbeitet werden:
... WHERE Dimension = 'Value'
... WHERE Dimension LIKE '%value%'
... WHERE Dimension1 LIKE '%value' AND Dimension2 = 'Value2'
... WHERE Dimension LIKE 'value%'
... WHERE Dimension1 = 'Value1' AND Dimension2 = 'Value2'
... WHERE Dimension = 'Value1' OR Dimension = 'Value2' OR Dimension = 'Value3'
... WHERE Dimension IN ('Value1', 'Value2', 'Value3', 'Value4')
... WHERE (Dimension1 = 'value1' OR Dimension1 = 'Value2') AND (Dimension2 = 'value3' OR Dimension2 = 'value4')
Es wird dringend empfohlen, so viele Filter wie möglich zu verwenden, da Abfragen mit vielen Dimensionen sonst viel Zeit in Anspruch nehmen können.
Definieren benutzerdefinierter Berichte
Um eine Berichtsansicht für eine Abfrage zu erstellen, können Sie die Funktion CreateReport verwenden gespeicherte Prozedur. Die CreateReport bietet eine einfache Möglichkeit, neue Ansichtsdefinitionen mit einer benutzerdefinierten Kombination aus Dimensionen und Metriken zu generieren. Durch den Aufruf wird eine neue Schema erstellt, die Sie wie jede andere Ansicht Abfrage können.
Die gespeicherte Prozedur verwendet als Eingaben einen Ansichtsnamen, eine durch Kommas getrennte Liste von Metriknamen, eine durch Kommas getrennte Liste von Metrik-IDs, eine durch Kommas getrennte Liste von Dimensionsnamen, eine durch Kommas getrennte Liste von Dimensions-IDs und einen Ausgabeordner. Sie müssen die Location
Verbindungseigenschaft zum Ordner mit den neuen Script, um auf diese zuzugreifen; die Location
kann anstelle des Ausgabeordners festgelegt werden.
Sie können die Metrik-/Dimensions-IDs abrufen, indem Sie Metrik-/Dimensionsansichten abfragen.
SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics
Um beispielsweise ein neues Schema zusammen mit den Standardschemata zu verwenden, setzen Sie die Location
-Eigenschaft zum Unterordner db im Installationsordner hinzufügen und folgenden Aufruf durchführen:
EXEC CreateReport Dimensions = 'Country, City', Metrics = 'PageViews, Visits', TableName = 'MyCustomReport'
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.
Adobe Analytics Connector-Ansichten
Name | Beschreibung |
---|---|
CalculatedMetrics | Abfrage der verfügbaren berechneten Metriken in AdobeAnalytics. |
CollectionSuites | Abfrage der verfügbaren Sammlungssuiten in AdobeAnalytics. |
Dimensions | Abfrage der verfügbaren Dimensionen in AdobeAnalytics. |
Metrics | Abfrage der verfügbaren Metriken in AdobeAnalytics. |
Segments | Abfrage der verfügbaren Segmente in AdobeAnalytics. |
Users | Abfrage der verfügbaren Benutzer in AdobeAnalytics. |
Berechnete Metriken
Fragen Sie die verfügbaren berechneten Metriken in AdobeAnalytics ab.
Spalten
Name | Typ | IsDimension | IsMetric | StandardDimension | Beschreibung |
---|---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung der berechneten Metrik. | |||
Name | String | Der Name der berechneten Metrik. | |||
ReportSuiteName | String | Der Name der Berichtssuite, in der sich die berechnete Metrik befindet. | |||
Description | String | Eine Beschreibung der berechneten Metrik. | |||
Created | Datetime | Das Datum und die Uhrzeit, zu der die berechnete Metrik erstellt wurde. | |||
Modified | Datetime | Das Datum und die Uhrzeit, zu der die berechnete Metrik geändert wurde. | |||
Type | String | Der Typ der berechneten Metrik. Beispielsweise int, Dezimalzahl, Prozentsatz usw. | |||
OwnerId | String | Eindeutige Kennung des Benutzers, der die berechnete Metrik erstellt hat. | |||
OwnerName | String | Name des Benutzers, der die berechnete Metrik erstellt hat. | |||
Category | String | Die Kategorie der berechneten Metrik. | |||
SiteTitle | String | Der Titel der Site. | |||
Polarity | String | Nimmt zwei Werte an: positiv und negativ. Bestimmt, ob es positiv ist oder nicht, wenn die Metrik steigt. | |||
Precision | Integer | Die Genauigkeit der berechneten Metrik. | |||
Template | String | Zusätzliches Attribut zum Identifizieren von Vorlagen, wenn IncludeType=templates. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IncludeType | String | Standardmäßig enthalten Antworten ohne diesen Parameter nur berechnete Metriken, die dem Benutzer gehören. Folgende Werte sind möglich: 1) all: Gibt alle berechneten Metriken zurück, die mit diesem Unternehmen verknüpft sind. 2) shared: Gibt berechnete Metriken zurück, die mit dem Benutzer geteilt wurden. 3) templates: Gibt alle berechneten Metrikvorlagen zurück. |
KollektionSuiten
Fragen Sie die verfügbaren Sammlungspakete in AdobeAnalytics ab.
Spalten
Name | Typ | IstDimension | IstMetrisch | StandardDimension | Beschreibung |
---|---|---|---|---|---|
Rsid [KEY] | String | Eindeutige Kennung der Sammlungssuite. | |||
Name | String | Der Name der Sammlungssuite. | |||
ParentRsid | String | Eindeutige Kennung des übergeordneten Elements dieser Sammlungssuite. | |||
Currency | String | In dieser Sammlungssuite verwendete Standardwährung. | |||
Type | String | Der Typ der Sammlungssuite. Beispielsweise Berichtssuite. | |||
Timezone | String | Die Zeitzone der Sammlungssuite. |
Maße
Fragen Sie die verfügbaren Dimensionen in AdobeAnalytics ab.
Spalten
Name | Typ | IsDimension | IsMetric | StandardDimension | Beschreibung |
---|---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung der Dimension. | |||
RSID | String | Eindeutige Kennung der Berichtssuite, in der sich die Dimension befindet. | |||
Title | String | Der Titel der Dimension. | |||
Name | String | Der Name der Dimension. | |||
Type | String | Der Typ der Dimension. Beispielsweise String, Int, Enum usw. | |||
Description | String | Eine Beschreibung der Dimension. | |||
Category | String | Die Kategorie der Dimension. | |||
Pathable | Boolean | Ob die Dimension durch einen Pfad erreichbar ist oder nicht. | |||
Segmentable | Boolean | Ob die Dimension segmentierbar ist oder nicht. | |||
ReportType | String | Der Typ der Berichte, in denen diese Dimension gültig ist. | |||
Support | String | Der Typ der Berichte, in denen diese Dimension unterstützt wird. |
Metriken
Fragen Sie die verfügbaren Metriken in AdobeAnalytics ab.
Spalten
Name | Typ | IsDimension | IsMetric | StandardDimension | Beschreibung |
---|---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung der Metrik. | |||
RSID | String | Eindeutige Kennung der Berichtssuite, in der sich die Metrik befindet. | |||
Title | String | Der Titel der Metrik. | |||
Name | String | Der Name der Metrik. | |||
Type | String | Der Typ der Metrik, z. B. Integer, Prozent, Währung usw. | |||
Description | String | Eine Beschreibung für die Metrik. | |||
Category | String | Die Kategorie der Metrik. | |||
Calculated | Boolean | Ob diese Metrik eine berechnete Metrik ist oder nicht. | |||
Segmentable | Boolean | Ob diese Metrik segmentierbar ist oder nicht. | |||
Polarity | String | Nimmt zwei Werte an: positiv und negativ. Bestimmt, ob es positiv ist oder nicht, wenn die Metrik steigt. | |||
Precision | Integer | Die Genauigkeit der Metrik. |
Segmente
Fragen Sie die verfügbaren Segmente in AdobeAnalytics ab.
Spalten
Name | Typ | IsDimension | IsMetric | StandardDimension | Beschreibung |
---|---|---|---|---|---|
Id [KEY] | String | Eindeutige Kennung des Segments. | |||
Name | String | Der Name des Segments. | |||
ReportSuiteName | String | Der Name der Berichtssuite, in der das Segment erstellt wurde. | |||
Description | String | Eine Beschreibung für das Segment. | |||
Created | Datetime | Das Datum und die Uhrzeit, zu der das Segment erstellt wurde. | |||
Modified | Datetime | Das Datum und die Uhrzeit der letzten Änderung des Segments. | |||
OwnerId | String | Die eindeutige Kennung des Benutzers, der das Segment erstellt hat. | |||
OwnerName | String | Der Name des Benutzers, der das Segment erstellt hat. | |||
Version | String | Die Version des Segments. | |||
Type | String | Eine durch Kommas getrennte Liste von Segmenttypen. Zulässige Werte sind: „shared“, „templates“, „curatedItem“. | |||
SiteTitle | String | Der Titel der Site. |
Benutzer
Fragen Sie die verfügbaren Benutzer in AdobeAnalytics ab.
Spalten
Name | Typ | IsDimension | IsMetric | StandardDimension | Beschreibung |
---|---|---|---|---|---|
LoginId [KEY] | String | Eindeutige Kennung des Benutzers. | |||
ImsUserId | String | Die IMS-Benutzer-ID. Diese wird nur für interne Benutzer wie Autoren, Prüfer, Administratoren, Entwickler usw. verwendet. | |||
CompanyId | String | Eindeutige Kennung des Unternehmens. | |||
CreateDate | Timestamp | Das Datum, an dem der Benutzer erstellt wurde. | |||
Disabled | Boolean | Ob das Konto dieses Benutzers deaktiviert ist oder nicht. | |||
Email | String | Die Email des Benutzers. | |||
FirstName | String | Der Vorname des Benutzers. | |||
LastName | String | Der Nachname des Benutzers. | |||
FullName | String | Der vollständige Name des Benutzers. | |||
LastAccess | Timestamp | Wann der Benutzer zum letzten Mal auf sein Konto zugegriffen hat. | |||
LastLogin | Timestamp | Wann sich der Benutzer zum letzten Mal angemeldet hat. | |||
Login | String | Anmeldename. | |||
PhoneNumber | String | Die Telefonnummer des Benutzers. | |||
Title | String | Der Titel des Benutzers. |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit Adobe Analytics hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Adobe Analytics zurück, zusammen mit einem Hinweis, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren im Adobe Analytics Connector
Name | Beschreibung |
---|---|
CreateReport | Erstellt einen benutzerdefinierten Bericht durch Angabe von Dimensionen und Messwerten. |
GetOAuthAccessToken | Ruft ein Authentifizierungstoken von AdobeAnalytics 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 den OAuthAccessToken von dieser URL an. |
RefreshOAuthAccessToken | Adobe Analytics unterstützt das Aktualisieren von Token nicht. Daher ruft diese gespeicherte Prozedur intern die Prozedur GetOAuthAccessToken auf, um den OAuth-Flow von Anfang an zu initiieren. |
Bericht erstellen
Erstellt einen benutzerdefinierten Bericht durch Angabe von Dimensionen und Metriken.
Gespeicherte Prozedurspezifische Informationen
Um eine Berichtsansicht für eine Abfrage zu erstellen, können Sie die Funktion CreateReport verwenden gespeicherte Prozedur. Die CreateReport bietet eine einfache Möglichkeit, neue Ansichtsdefinitionen mit einer benutzerdefinierten Kombination aus Dimensionen und Metriken zu generieren. Durch den Aufruf wird eine neue Schema erstellt, die Sie wie jede andere Ansicht Abfrage können.
Die gespeicherte Prozedur verwendet als Eingaben einen Ansichtsnamen, eine durch Kommas getrennte Liste von Metriknamen, eine durch Kommas getrennte Liste von Metrik-IDs, eine durch Kommas getrennte Liste von Dimensionsnamen, eine durch Kommas getrennte Liste von Dimensions-IDs und einen Ausgabeordner. Sie müssen das festlegen Location
Verbindungseigenschaft zum Ordner, der die neuen Script enthält, um auf diese zuzugreifen; die Location
kann anstelle des Ausgabeordners festgelegt werden.
Sie können die Metrik-/Dimensions-IDs abrufen, indem Sie Metrik-/Dimensionsansichten abfragen.
SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics
Um beispielsweise ein neues Schema zusammen mit den Standardschemata zu verwenden, setzen Sie die Location
-Eigenschaft zum Unterordner db im Installationsordner hinzufügen und folgenden Aufruf durchführen:
EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport'
Dimensionen und Metriken sollten ihre jeweiligen IDs in den DimensionIds- und MetricIds-Eingaben angegeben haben.
Eingang
Name | Typ | Erforderlich | Akzeptiert Ausgabestreams | Beschreibung |
---|---|---|---|---|
TableName | String | True | False | Der Name für die neue Tabelle. |
Description | String | Falsch | Falsch | Eine optionale Beschreibung für die Tabelle. |
WriteToFile | String | Falsch | Falsch | Ob der Inhalt dieser gespeicherten Prozedur in eine Datei geschrieben werden soll oder nicht (Standard = Wahr), muss auf „Falsch“ gesetzt werden, um den FileStream von FileData auszugeben |
DimensionIds | String | Wahr | Falsch | Eine durch Kommas getrennte Liste von Dimensions-IDs. |
MetricIds | String | Wahr | Falsch | Eine durch Kommas getrennte Liste von Metrik-IDs. |
FileStream | String | Falsch | Wahr | Eine Instanz eines Ausgabestreams, in den Dateidaten geschrieben werden. Wird nur verwendet, wenn OutputFolder nicht festgelegt ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
FileData | String | Wenn die OutputFolder-Eingabe leer ist. |
Success | String | Ob das Schema erfolgreich erstellt wurde oder nicht. |
SchemaFile | String | Die generierte Schema. |
GetOAuthAccessToken
Erhält ein Authentifizierungstoken von AdobeAnalytics.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | Falsch | Der zu verwendende Authentifizierungsmodustyp. Wählen Sie „App“, um Authentifizierungstoken über eine Desktop-App abzurufen. Wählen Sie „Web“, um Authentifizierungstoken über eine Web-App abzurufen. Die zulässigen Werte sind APP, WEB. Der Standardwert ist APP. |
Scopes | 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 AdobeAnalytics-API. Der Standardwert ist openid,AdobeID,read_organizations,additional_info.job_function,additional_info.projectedProductContext. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Weiterleitungs URL übereinstimmen, die Sie in den App-Einstellungen von AdobeAnalytics angegeben haben. Nur erforderlich, wenn der Authmode-Parameter „Web“ ist. |
Verifier | String | Falsch | Der von AdobeAnalytics zurückgegebene Prüfer, nachdem der Benutzer Ihrer App den Zugriff auf seine Daten gestattet hat. Dieser Wert wird als Parameter an die Rückruf-URL zurückgegeben. |
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 AdobeAnalytics-Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, Nonces und die Abwehr von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das Zugriffstoken, das für die Kommunikation mit AdobeAnalytics verwendet wird. |
OAuthRefreshToken | String | Das OAuth-Aktualisierungstoken. Dies ist dasselbe wie das Zugriffstoken im Fall von AdobeAnalytics. |
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 den OAuthAccessToken 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. Dieser Wert muss mit der Weiterleitungs-URL in den App-Einstellungen von AdobeAnalytics übereinstimmen. |
Scopes | String | Falsch | Eine durch Kommas getrennte Liste von Bereichen, die vom Benutzer angefordert werden sollen. Eine Liste der verfügbaren Berechtigungen finden Sie in der AdobeAnalytics API Dokumentation. Der Standardwert ist openid,AdobeID,read_organizations,additional_info.job_function,additional_info.projectedProductContext. |
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 AdobeAnalytics-Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, Nonces und die Abwehr 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
Adobe Analytics unterstützt das Aktualisieren von Token nicht. Daher ruft diese gespeicherte Prozedur intern die Prozedur GetOAuthAccessToken auf, um den OAuth-Flow von Anfang an zu initiieren.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | Falsch | Setzen Sie hier einen Testwert. Es macht keinen Unterschied, da dieser Vorgang den OAuth-Flow von Anfang an startet. Der Standardwert ist Test. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von AdobeAnalytics zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
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 Adobe Analytics 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 SampleTable_1 zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'
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 SampleTable_1 ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'
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:adobeanalytics:config:
Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.
Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:
SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name | Typ | Beschreibung |
---|---|---|
Name | String | Der Name der Verbindungseigenschaft. |
ShortDescription | String | Eine kurze Beschreibung. |
Type | String | Der Datentyp der Verbindungseigenschaft. |
Default | String | Der Standardwert, sofern nicht explizit einer festgelegt wurde. |
Values | String | Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben. |
Value | String | Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard. |
Required | Boolean | Ob für die Immobilie eine Anschlusspflicht besteht. |
Category | String | Die Kategorie der Verbindungseigenschaft. |
IsSessionProperty | String | Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird. |
Sensitivity | String | Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird. |
PropertyName | String | Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise. |
Ordinal | Int32 | Der Index des Parameters. |
CatOrdinal | Int32 | Der Index der Parameterkategorie. |
Hierarchy | String | Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen. |
Visible | Boolean | Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist. |
ETC | String | Verschiedene sonstige Informationen zum Objekt. |
Sys_sqlinfo
Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.
Entdecken der SELECT-Funktionen der Datenquelle
Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.
Name | Beschreibung | Mögliche Werte |
---|---|---|
AGGREGATE_FUNCTIONS | Unterstützte Aggregatfunktionen. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Ob die COUNT-Funktion unterstützt wird. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | ] |
SUPPORTED_OPERATORS | Eine Liste unterstützter SQL-Operatoren. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Unterstützte String-Funktionen. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Unterstützte numerische Funktionen. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Unterstützte Datums-/Uhrzeitfunktionen. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Zeigt an, dass während der Replikation Tabellen übersprungen wurden. | |
REPLICATION_TIMECHECK_COLUMNS | Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen. | |
IDENTIFIER_PATTERN | Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist. | |
SUPPORT_TRANSACTION | Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. | YES , NO |
DIALECT | Gibt den zu verwendenden SQL-Dialekt an. | |
KEY_PROPERTIES | Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren. | |
SUPPORTS_MULTIPLE_SCHEMAS | Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. | YES , NO |
DATASYNCVERSION | Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | Die Kategorie „Datensynchronisierung“ dieses Treiber. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Ob Charge Operationen unterstützt werden. | YES , NO |
SQL_CAP | Alle unterstützten SQL-Funktionen für diesen Treiber. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an. | |
ENABLE_EF_ADVANCED_QUERY | Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. | YES , NO |
PSEUDO_COLUMNS | Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt. | |
MERGE_ALWAYS | Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation. | |
REPLICATION_MIN_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll. | |
REPLICATION_START_DATE | Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben. | |
REPLICATION_MAX_DATE_QUERY | Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation. | |
REPLICATION_MAX_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird. | |
CHECKCACHE_USE_PARENTID | Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können. |
Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.
Spalten
Name | Typ | Beschreibung |
---|---|---|
NAME | String | Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann. |
VALUE | String | Details zum unterstützten SQL bzw. zur SQL-Syntax. |
Systemidentität
Gibt Informationen zu versuchten Änderungen zurück.
Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:
SELECT * FROM sys_identity
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die von einer Operation zurückgegebene, von der Datenbank generierte ID. |
Batch | String | Eine Kennung für den Charge. 1 für einen einzelnen Operation. |
Operation | String | Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT. |
Message | String | SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist. |
Erweiterte Konfigurationseigenschaften
Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der bei der Verbindung mit Adobe Analytics zu verwendende Authentifizierungstyp. |
GlobalCompanyId | Ihre Firmenkennung. Wenn nicht festgelegt, versucht der Treiber, sie automatisch zu erkennen. |
RSID | Ihre Report Suite-Kennung. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen. |
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 eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
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 |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
OAuthJWTIssuer | Der Herausgeber des Java Web Token. |
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 |
---|---|
IncludeSummaryData | Konfiguriert die für benutzerdefinierte Berichte angezeigten Daten. Standardmäßig sind die Zusammenfassungsdatensätze nicht enthalten. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der Ergebnisse, die pro Seite von Adobe Analytics zurückgegeben werden sollen. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
SkipEmptyRows | Schließt leere Datensätze in Berichtsdatensatzgruppen aus. |
SupportEnhancedBreakDown | Verwenden Sie einen Breitensuchealgorithmus, um die Anzahl der Dimensionsdatensätze zu maximieren, die pro einzelner Anforderung zur Aufschlüsselung gesendet werden. |
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 Adobe Analytics zu verwendende Authentifizierungstyp. |
GlobalCompanyId | Ihre Firmenkennung. Wenn nicht festgelegt, versucht der Treiber, sie automatisch zu erkennen. |
RSID | Ihre Report Suite-Kennung. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen. |
AuthScheme
Der bei der Verbindung mit Adobe Analytics zu verwendende Authentifizierungstyp.
Mögliche Werte
Auto
, OAuth
, OAuthJWT
, OAuthClient
Datentyp
string
Standardwert
Auto
Hinweise
- Automatisch: Lässt den Treiber automatisch basierend auf den anderen von Ihnen festgelegten Verbindungseigenschaften entscheiden.
- OAuth: Legen Sie diese Option fest, um die OAuth-Authentifizierung mit einem Standardbenutzerkonto durchzuführen.
- OAuthJWT: Legen Sie dies fest, um die OAuth-Authentifizierung mit einem OAuth-Dienstkonto durchzuführen.
(To be deprecated on January 1, 2025)
- OAuthClient: Legen Sie dies fest, um die OAuth-Authentifizierung mithilfe eines OAuth-Dienstkontos durchzuführen. (Server-zu-Server)
GlobalCompanyId
Ihre Firmenkennung. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen.
Datentyp
string
Standardwert
""
Hinweise
Ihre Firmenkennung. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen.
RSID
Ihre Report Suite-ID. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen.
Datentyp
string
Standardwert
""
Hinweise
Ihre Report Suite-ID. Wenn sie nicht festgelegt ist, versucht der Treiber, sie automatisch zu erkennen.
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 eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
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%\\CData\\Acumatica Data Provider\\OAuthSettings.txt
Hinweise
Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH
oder REFRESH
, der Treiber speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.
Anstatt einen Dateipfad anzugeben, können Sie auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit 'memory://'
gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_props
Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.
Der Standardspeicherort ist „%APPDATA%\\CData\\ Acumatica Data Provider\\OAuthSettings.txt“ mit %APPDATA%
auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.
Die folgende Tabelle listet den Wert von auf %APPDATA%
nach Operationssystem:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Linux | ~/.config |
Rückruf-URL
Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
Datentyp
string
Standardwert
http://localhost:33333
Hinweise
Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
OAuthVerifier
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
Datentyp
string
Standardwert
""
Hinweise
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.
Authentifizierung auf Headless-Maschinen
Siehe, um die zu erhalten OAuthVerifier
Wert.
OAuthSettingsLocation festlegen zusammen mit OAuthVerifier
. Beim Verbinden tauscht der Connector die OAuthVerifier
für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.
Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier
aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.
Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.
OAuthRefreshToken
Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
Datentyp
string
Standardwert
""
Hinweise
Der OAuthRefreshToken
Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.
OAuthLäuftAbIn
Die Lebensdauer des OAuth AccessToken in Sekunden.
Datentyp
string
Standardwert
""
Hinweise
Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.
OAuthTokenTimestamp
Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.
Datentyp
string
Standardwert
""
Hinweise
Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.
JWT OAuth
Dieser Abschnitt enthält eine vollständige Liste der JWT OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
OAuthJWTIssuer | Der Herausgeber des Java Web Token. |
OAuthJWTCert
Der JWT-Zertifikatspeicher.
Datentyp
string
Standardwert
""
Hinweise
Der Name des Zertifikatspeichers für das Client-Zertifikat.
Der OAuthJWTCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an OAuthJWTCert
. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in OAuthJWTCertPassword an.
OAuthJWTCert
wird in Verbindung mit OAuthJWTCertSubject verwendet
Feld, um Client-Zertifikate anzugeben. Wenn OAuthJWTCert
hat einen Wert und OAuthJWTCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Bitte beachten Sie das OAuthJWTCertSubject für weitere Einzelheiten.
Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.
Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:
Eigenschaft | Beschreibung |
---|---|
MY | Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält. |
CA | Zertifikate der Zertifizierungsstelle. |
ROOT | Stammzertifikate. |
SPC | Zertifikate von Softwareherstellern. |
In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.
Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei (d. h. PKCS12-Zertifikatsspeicher) gesetzt werden.
OAuthJWTCertType
Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.
Datentyp
string
Standardwert
PEMKEY_FILE
Hinweise
Diese Eigenschaft kann einen der folgenden Werte annehmen:
Eigenschaft | Beschreibung |
---|---|
USER | Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
MACHINE | Für Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
PFXFILE | Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält. |
PFXBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt. |
JKSFILE | Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
JKSBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im Java Key Store-Format (JKS) darstellt. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
PEMKEY_FILE | Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PEMKEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
PUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
SSHPUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält. |
SSHPUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält. |
P7BFILE | Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält. |
PPKFILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen PPK (PuTTY Private Key) enthält. |
XMLFILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält. |
XMLBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält. |
OAuthJWTCertPasswort
Das Passwort für das OAuth JWT-Zertifikat.
Datentyp
string
Standardwert
""
Hinweise
Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort anzugeben, damit der Zertifikatspeicher geöffnet werden kann.
OAuthJWTCertSubject
Der Betreff des OAuth JWT-Zertifikats.
Datentyp
string
Standardwert
*
Hinweise
Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.
Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten.
Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.
Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.
Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Zum Beispiel „CN=www.server.com, OU=test, C=US, E=example@jbexample.com“. Allgemeine Felder und ihre Bedeutungen werden unten angezeigt.
Feld | Bedeutung |
---|---|
CN | Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com. |
O | Organisation |
OU | Organisationseinheit |
L | Ort |
S | Staat |
C | Land |
E | Email Adresse |
Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.
OAuthJWTIssuisse
Der Herausgeber des Java Web Token.
Datentyp
string
Standardwert
""
Hinweise
Der Aussteller des Java Web Token. Dies ist normalerweise entweder die Client-ID oder die Email Adresse der OAuth-Anwendung.
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 per 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%\AdobeAnalytics 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%\AdobeAnalytics 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 |
---|---|
IncludeSummaryData | Konfiguriert die für benutzerdefinierte Berichte angezeigten Daten. Standardmäßig sind die Zusammenfassungsdatensätze nicht enthalten. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der Ergebnisse, die pro Seite von Adobe Analytics zurückgegeben werden sollen. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
SkipEmptyRows | Schließt leere Datensätze in Berichtsdatensatzgruppen aus. |
SupportEnhancedBreakDown | Verwenden Sie einen Breitensuchealgorithmus, um die Anzahl der Dimensionsdatensätze zu maximieren, die pro einzelner Anforderung zur Aufschlüsselung gesendet werden. |
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. |
IncludeSummaryData
Konfiguriert die für benutzerdefinierte Berichte angezeigten Daten. Standardmäßig sind die Zusammenfassungsdatensätze nicht enthalten.
Datentyp
bool
Standardwert
false
Hinweise
Konfiguriert die für benutzerdefinierte Berichte angezeigten Daten. Standardmäßig sind die Zusammenfassungsdatensätze nicht enthalten.
MaxRows
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Datentyp
int
Standardwert
-1
Hinweise
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Andere
Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
Datentyp
string
Standardwert
""
Hinweise
Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.
Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.
Integration und Formatierung
Eigenschaft | Beschreibung |
---|---|
DefaultColumnSize | Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000. |
ConvertDateTimeToGMT | Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen. |
RecordToFile=filename | Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei. |
Seitengröße
Die maximale Anzahl der Ergebnisse, die pro Seite von Adobe Analytics zurückgegeben werden sollen.
Datentyp
int
Standardwert
5000
Hinweise
Der Pagesize
Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von Adobe Analytics zurückgegeben werden. Wenn Sie einen höheren Wert festlegen, ist die Leistung möglicherweise besser, allerdings wird pro verbrauchter Seite zusätzlicher Speicher zugewiesen.
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. „*=*“.
SkipEmptyRows
Schließt leere Datensätze in Berichtsdatensätzen aus.
Datentyp
bool
Standardwert
true
Hinweise
Wenn dieser Wert auf „true“ gesetzt ist, werden Zeilen, für die kein Metrikwert vorhanden ist, im Bericht übersprungen. Dies wird empfohlen, wenn Sie SupportEnhancedBreakDown verwenden und Abfragen eines Berichts mit mehr als zwei Aufgliederungsebenen.
Wenn auf „false“ gesetzt, werden alle Zeilen in den Berichtsdatensatz aufgenommen.
UnterstützungEnhancedBreakDown
Verwenden Sie einen Breitensuchealgorithmus, um die Anzahl der Dimensionsdatensätze zu maximieren, die pro einzelner Anfrage zur Aufschlüsselung gesendet werden.
Datentyp
bool
Standardwert
false
Hinweise
Wenn „true“, verwendet der Connector einen Breitensuchealgorithmus, um die Anzahl der Dimensionsdatensätze zu maximieren, die zur Aufschlüsselung in einer einzigen Anfrage gesendet werden. Für jede Aufschlüsselungsebene werden alle Datensätze auf dieser Ebene in dieselbe Aufschlüsselungsanfrage aufgenommen. Verwenden Sie diese Option, wenn Sie Berichte über mehrere Dimensionen hinweg abfragen.
Wenn „false“, verwendet der Connector einen Tiefensuchealgorithmus, um Dimensionsdatensätze aufzuschlüsseln. Für jeden Datensatz in der Stammaufschlüsselung wird eine separate Anfrage gesendet. Verwenden Sie diese Option, wenn Sie nur Datensätze aus einer einzigen Dimension aufschlüsseln.
Dies wird nur auf Berichte angewendet, die über die gespeicherte Prozedur „CreateSchema“ erstellt wurden, und unterstützt nicht die Offenlegung der Zusammenfassungsdatenzeilen.
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 SampleTable_1 WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie UserDefinedViews
Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.