Act-On Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8936 des Connectors.

Erste Schritte

Act-On Versionsunterstützung

Der Connector nutzt V1 der Act-On API, um einen bidirektionalen Zugriff auf Act-On-Daten zu ermöglichen.

Herstellen einer Verbindung

Authentifizieren bei Act-On

Act-On verwendet den OAuth-Authentifizierungsstandard. Um sich mit OAuth zu authentifizieren, müssen Sie eine App erstellen, um die OAuthClientId, OAuthClientSecret, Und CallbackURL Verbindungseigenschaften.

Desktop-Anwendungen

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

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

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

• InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können verwenden InitiateOAuth um den OAuth-Austausch und das manuelle Setzen der zu vermeiden OAuthAccessToken.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Stellen Sie die Client-ID in Ihren Anwendungseinstellungen ein.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Stellen Sie in Ihren Anwendungseinstellungen das Client-Geheimnis ein.

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

• Extrahiert den Zugriffstoken aus der Rückruf URL.
• Erhält einen neuen Zugriffstoken, wenn der alte abläuft.
• Speichert OAuth-Werte in OAuthSettingsLocation die über Verbindungen hinweg bestehen bleiben.

Webanwendungen

Wenn Sie eine Verbindung über eine Webanwendung herstellen, müssen Sie eine benutzerdefinierte OAuth-Anwendung bei Act-On registrieren. Siehe Erstellen einer benutzerdefinierten OAuth-App für weitere Informationen. Sie können dann den Treiber verwenden, um die OAuth-Tokenwerte abzurufen und zu verwalten.

Holen Sie sich zuerst ein OAuthAccessToken durch Festlegen der folgenden Verbindungseigenschaften:

• OAuthClientId: In Ihren Anwendungseinstellungen auf die Client-ID einstellen.
• OAuthClientSecret: Stellen Sie es in Ihren Anwendungseinstellungen auf das Client-Geheimnis ein.

Rufen Sie dann gespeicherte Prozeduren auf, um den OAuth-Austausch abzuschließen:

1. Rufen Sie GetOAuthAuthorizationURL auf gespeicherte Prozedur. Legen Sie den CallbackURL-Eingang auf die Rückruf URL fest, die Sie in Ihren Anwendungseinstellungen angegeben haben. Legen Sie bei Bedarf den Scope-Parameter fest, um benutzerdefinierte Berechtigungen anzufordern. Die gespeicherte Prozedur gibt die URL des OAuth-Endpoint zurück.
2. Öffnen Sie die URL, melden Sie sich an und autorisieren Sie die Anwendung. Sie werden zurück zur Rückruf-URL geleitet.
3. Rufen Sie den GetOAuthAccessToken gespeicherte Prozedur. Setzen Sie den AuthMode-Eingang auf WEB. Setzen Sie den Verifier-Eingang auf den Parameter „Code“ in der Abfrage der Rückruf URL. Legen Sie bei Bedarf den Scope-Parameter fest, um benutzerdefinierte Berechtigungen anzufordern.

Nachdem Sie die Zugriffs- und Aktualisierungstoken erhalten haben, können Sie eine Verbindung zu Daten herstellen und das OAuth-Zugriffstoken entweder automatisch oder manuell aktualisieren.

Automatische Aktualisierung des OAuth-Zugriffstokens

Damit der Treiber den OAuth-Zugriffstoken automatisch aktualisiert, legen Sie bei der ersten Datenverbindung Folgendes fest:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: Stellen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID ein.
• OAuthClientSecret: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.
• OAuthAccessToken: Setzen Sie dies auf den von GetOAuthAccessToken zurückgegebenen Zugriffstoken.
• OAuthRefreshToken: Setzen Sie dies auf das von GetOAuthAccessToken zurückgegebene Aktualisierungstoken.
• OAuthSettingsLocation: Legen Sie hier den Speicherort fest, an dem der Connector die OAuth-Tokenwerte speichert, die über Verbindungen hinweg bestehen bleiben.

Bei nachfolgenden Datenverbindungen werden die Werte für OAuthAccessToken und OAuthRefreshToken von übernommen OAuthSettingsLocation.

Manuelle Aktualisierung des OAuth-Zugriffstokens

Der einzige Wert, der zum manuellen Aktualisieren des OAuth-Zugriffstokens bei der Verbindung mit Daten benötigt wird, ist das OAuth-Aktualisierungstoken.

Verwenden Sie das RefreshOAuthAccessToken gespeicherte Prozedur zum manuellen Aktualisieren der OAuthAccessToken nach dem von GetOAuthAccessToken zurückgegebenen ExpiresIn-Parameterwert abgelaufen ist, legen Sie die folgenden Verbindungseigenschaften fest:

• OAuthClientId: Stellen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID ein.
• OAuthClientSecret: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.

Rufen Sie dann RefreshOAuthAccessToken auf mit OAuthRefreshToken gesetzt auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken. Nachdem die neuen Token abgerufen wurden, öffnen Sie eine neue Verbindung, indem Sie die Eigenschaft OAuthAccessToken auf den von RefreshOAuthAccessToken zurückgegebenen Wert setzen.

Speichern Sie abschließend das OAuth-Aktualisierungstoken, damit Sie es nach Ablauf des OAuth-Zugriffstokens manuell aktualisieren können.

Kopflose Maschinen

Um den Treiber für die Verwendung von OAuth mit einem Benutzerkonto auf einem Headless-Computer zu konfigurieren, müssen Sie sich auf einem anderen Gerät authentifizieren, das über einen Internetbrowser verfügt.

1. Wählen Sie eine von zwei Optionen:
   • Option 1: Erhalten Sie die OAuthVerifierWert wie unten unter „Erhalten und Umtauschen eines Prüfcodes“ beschrieben.
   • Option 2: Installieren Sie den Connector auf einem Computer mit einem Browser und übertragen Sie die OAuth-Authentifizierungswerte, nachdem Sie sich über den üblichen browserbasierten Ablauf authentifiziert haben, wie unten unter „OAuth-Einstellungen übertragen“ beschrieben.
2. Konfigurieren Sie dann den Connector so, dass der Zugriffstoken auf der Headless-Maschine automatisch aktualisiert wird.

Option 1: Einen Verifier-Code erhalten und umtauschen

Um einen Prüfcode zu erhalten, müssen Sie sich bei der OAuth-Autorisierungs URL authentifizieren.

Befolgen Sie die nachstehenden Schritte, um sich vom Computer aus mit einem Internetbrowser zu authentifizieren und die OAuthVerifier Verbindungseigenschaft.

1. Wählen Sie eine dieser Optionen:

   • Wenn Sie die eingebettete OAuth-Anwendung verwenden, klicken Sie auf Act-On OAuth-Endpoint, um den Endpoint in Ihrem Browser zu öffnen.

   • Wenn Sie eine benutzerdefinierte OAuthd-Anwendung verwenden, erstellen Sie die Autorisierungs-URL, indem Sie die folgenden Eigenschaften festlegen:

     • InitiateOAuth: Auf setzen OFF.
     • OAuthClientId: Auf die Client-ID eingestellt, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
     • OAuthClientSecret: Auf das Client-Geheimnis einstellen, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.

     Rufen Sie dann die gespeicherte Prozedur GetOAuthAuthorizationURL mit der entsprechenden CallbackURL auf. Öffnen Sie die von der gespeicherten Prozedur zurückgegebene URL in einem Browser. 2. Melden Sie sich an und erteilen Sie dem Connector die entsprechenden Berechtigungen. Sie werden dann zur Callback-URL weitergeleitet, die den Prüfcode enthält. 3. Speichern Sie den Wert des Prüfcodes. Später setzen Sie diesen in OAuthVerifier Verbindungseigenschaft.

Als Nächstes müssen Sie den OAuth-Verifiziercode gegen OAuth-Aktualisierungs- und Zugriffstoken austauschen. Legen Sie die folgenden Eigenschaften fest:

Legen Sie auf der Headless-Maschine die folgenden Verbindungseigenschaften fest, um die OAuth-Authentifizierungswerte abzurufen.

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthVerifier: Setzen Sie dies auf den Prüfcode.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den Einstellungen Ihrer benutzerdefinierten OAuth-Anwendung auf die Client-ID fest.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den benutzerdefinierten OAuth-Anwendungseinstellungen auf das Client-Geheimnis fest.
• OAuthSettingsLocation: Legen Sie dies fest, um die verschlüsselten OAuth-Authentifizierungswerte am angegebenen Speicherort beizubehalten.

Nachdem die OAuth-Einstellungsdatei generiert wurde, müssen Sie die folgenden Eigenschaften neu festlegen, um eine Verbindung herzustellen:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie hier die Client-ID fest, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie hier das Client-Geheimnis fest, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthSettingsLocation: Legen Sie dies auf den Speicherort fest, der die verschlüsselten OAuth-Authentifizierungswerte enthält. Stellen Sie sicher, dass dieser Speicherort dem Connector Lese- und Schreibberechtigungen erteilt, um die automatische Aktualisierung des Zugriffstokens zu ermöglichen.

Option 2: OAuth-Einstellungen übertragen

Bevor Sie eine Verbindung auf einem Headless-Computer herstellen, müssen Sie den Treiber auf einem Gerät installieren und eine Verbindung mit ihm herstellen, das einen Internetbrowser unterstützt. Legen Sie die Verbindungseigenschaften wie oben unter „Desktop-Anwendungen“ beschrieben fest.

Nach Abschluss der Anweisungen unter „Desktopanwendungen“ werden die resultierenden Authentifizierungswerte verschlüsselt und an den durch angegebenen Speicherort geschrieben OAuthSettingsLocation. Der Standarddateiname ist OAuthSettings.txt.

Nachdem Sie die Verbindung erfolgreich getestet haben, kopieren Sie die OAuth-Einstellungsdatei auf Ihren Headless-Rechner.

Legen Sie auf dem Headless-Rechner die folgenden Verbindungseigenschaften fest, um eine Verbindung zu Daten herzustellen:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie hier die Client-ID fest, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie hier das Client-Geheimnis fest, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthSettingsLocation: Legen Sie hier den Speicherort Ihrer OAuth-Einstellungsdatei fest. Stellen Sie sicher, dass dieser Speicherort dem Connector Lese- und Schreibberechtigungen erteilt, um die automatische Aktualisierung des Zugriffstokens zu ermöglichen.

Authentifizierung mit Kennwortgewährung

Wenn zwischen dem Benutzer und der Anwendung eine Vertrauensbeziehung besteht, kann der Benutzer den Kennwort-Zuweisungstyp verwenden, um sich

entweder von einer Desktop-Anwendung oder dem Web aus zu authentifizieren. Um dieses Authentifizierungsschema zu aktivieren, setzen Sie AuthScheme Zu OAuthPassword.

Die Authentifizierung durch Kennwortzuweisung ähnelt OAuth. Tatsächlich ist es erforderlich, dass Sie bereits eine benutzerdefinierte OAuth-Anwendung eingerichtet haben, wie in Erstellen einer benutzerdefinierten OAuth-App beschrieben - aber sobald es eingerichtet ist, ist keine Benutzerinteraktion mehr erforderlich.

Um eine Verbindung herzustellen, legen Sie diese Eigenschaften fest:

• InitiateOAuth: GETANDREFRESH. Sie können InitiateOAuth verwenden, um den OAuth-Austausch und das manuelle Festlegen des Zugriffstokens in der Verbindungszeichenfolge zu vermeiden.
• AuthScheme: Setzen Sie die AuthScheme Zu OAuthPassword um die Authentifizierung mit dem Kennwort-Zuteilungstyp durchzuführen.
• User: Der Benutzername des Benutzers, der in Ihrer benutzerdefinierten OAuth-Anwendung angegeben ist.
• Password: Das Passwort des Benutzers, der in Ihrer benutzerdefinierten OAuth-Anwendung angegeben ist.
• OAuthClientId: Die in Ihrer benutzerdefinierten OAuth-Anwendung angegebene Client-ID.
• OAuthClientSecret: Das in Ihrer benutzerdefinierten OAuth-Anwendung angegebene Client-Geheimnis.

Erstellen einer benutzerdefinierten OAuth-App

Wann sollte eine benutzerdefinierte OAuth-App erstellt werden?

bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die bei der Verbindung über eine Desktop-Anwendung oder von einem Headless-Computer aus verwendet werden können. Bei Verwendung einer Webanwendung ist jedoch das Erstellen einer benutzerdefinierten OAuth-Anwendung erforderlich.

Sie können Ihre eigenen OAuth-Anwendungsanmeldeinformationen erstellen, wenn Sie Folgendes möchten:

• das Branding des Authentifizierungsdialogs steuern
• die Umleitungs-URI steuern, zu der die Anwendung den Benutzer nach der Authentifizierung umleitet
• die Berechtigungen anpassen möchten, die Sie vom Benutzer anfordern

Befolgen Sie die nachstehenden Schritte, um eine benutzerdefinierte OAuth-App zu erstellen und die Verbindungseigenschaften in einem bestimmten OAuth-Authentifizierungsablauf abzurufen.

Erstellen einer benutzerdefinierten OAuth-App: Desktop

Melden Sie sich an bei https://developer.act-on.com/provision/. Nachdem Sie Ihr Konto bei Act-On registriert haben, erhalten Sie eine Email mit den folgenden Verbindungseigenschaften:

• OAuthClientId
• OAuthClientSecret

Der Standardwert für die Rückruf URL ist http://localhost:80. Wenn Sie es ändern möchten, müssen Sie sich an den API Support für Act-On wenden.

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

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Act-On-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 Images 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

Der Act-On-Connector modelliert Entitäten in der Act-On API als Tabellen, Ansichten und gespeicherte Prozeduren. Diese werden in Schema definiert, bei denen es sich um einfache, textbasierte Konfigurationsdateien handelt.
Listen in Act-On werden als Ansichten mit der Konvention List_ListName angezeigt. Für jede Liste gibt es eine weitere Ansicht List_ListName_Score, in der Sie die Punktzahl der Personen in der Liste sehen können.
Dieselbe Logik für Segmente in Act-On, sie werden als Ansichten als Segment_SegmentName angezeigt. Und haben eine entsprechende Ansicht Segment_SegmentName_Score.
Alle Änderungen, die Sie an Ihrem Act-On-Konto vornehmen, wie z. B. das Hinzufügen einer neuen Liste, das Hinzufügen neuer Spalten oder das Ändern des Datentyps einer Spalte, werden sofort übernommen
wenn Sie die Verbindung über den Treiber herstellen.

Verwenden der Abfrageverarbeitung

Der Connector verlagert die Verarbeitung der SELECT-Anweisungen so weit wie möglich auf die Act-On APIs und verarbeitet den Rest der Abfrage dann innerhalb des Connectors. In den folgenden Abschnitten werden API Einschränkungen und-Anforderungen dokumentiert.

Ansichten

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

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen in der Datenquelle verwendet werden.

Tabellen

Der Connector modelliert die Daten in Act-On als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.

Act-On Connector-Tabellen

Liste_MeineListe

Erstellen, aktualisieren, löschen und Abfrage Datensätze einer Liste.

Tabellenspezifische Informationen

Jede Liste, die in Ihrem Act-On-Konto erstellt wird, wird durch eine neue Tabelle dargestellt, die dynamisch aus Ihrem Act-On-Konto abgerufen wird. Der Name der Tabelle hat das folgende Format:

ListennameDerListe

Wenn die Liste in der Act-On-Benutzeroberfläche beispielsweise „MyList“ heißt, wäre der Name der Tabelle im Treiber „List_MyList“.

Dies ist ein Beispiel, wie eine Liste als Tabelle angezeigt wird.

Wählen

Datensätze der angegebenen Tabelle abfragen:

SELECT * FROM [List_MyList]

EINFÜGEN

Erstellen Sie einen neuen Datensatz in der Tabelle.

Alle Felder, die nicht schreibgeschützt sind, können angegeben werden.

INSERT INTO`[Liste_MeineListe] `([First Name],`[Nachname], `[E-mail Address], [ListId]) VALUES ('John', 'Doe', 'john.doe@act-on.com', 'l-000d')

Aktualisieren

Details eines bestimmten Datensatzes aktualisieren.

Alle Felder, die nicht schreibgeschützt sind, können angegeben werden.

UPDATE`[Liste_MeineListe] `SET` [Vorname] `= 'Mohit',`[Nachname] `= 'Chaturvedi', [E-Mail-Adresse] = 'mohit@act-on.comm' WHERE`[Listen-ID] `= 'l-000d' AND [E-Mail-Adresse] = 'john.doe@act-on.comm'

Upsert

Aktualisieren Sie die Details eines bestimmten Datensatzes, falls dieser vorhanden ist. Andernfalls wird ein neuer Datensatz eingefügt.

Alle Felder, die nicht schreibgeschützt sind, können angegeben werden.

UPSERT INTO`[Liste_MeineListe] `([First Name],`[Nachname], `[E-mail Address], [ListId]) VALUES ('Shubham', 'Prakash', 'shubhamtesting@cdata.com', 'l-000a')

Löschen

Einen Datensatz einer Tabelle löschen.

Alle Felder, die nicht schreibgeschützt sind, können angegeben werden.

DELETE FROM List_MyList WHERE`[Listen-ID] `= 'l-000d' AND`[_Kontakt-ID_] `= 'l-000d:10'

Spalten

Opt-out

Aktualisieren, Löschen und Abfrage von Datensätzen einer Optout-Liste.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Timestamp unterstützt die Operatoren '>=', '>', '<=' und '<'.

Beispiel:

SELECT * FROM Optout WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Optout WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Upsert

Upsert kann durch Angabe der Spalte „Email“ ausgeführt werden. Nachfolgend finden Sie ein Beispiel, wie Sie eine einzelne Email in diese Tabelle einfügen können.

UPSERT INTO Optout(Email) VALUES ('ym@cdata.com')

Es können auch mehrere Emails hinzugefügt oder aktualisiert werden. Nachfolgend finden Sie ein Beispiel, wie Sie mehrere Emails in diese Tabelle einfügen können.

UPSERT INTO Optout(Email) VALUES ('jk@cdata.com;mk@cdata.com')

LÖSCHEN

Das Löschen kann durch Angabe der Email-Spalte in der WHERE-Klausel ausgeführt werden. Nachfolgend finden Sie ein Beispiel zum Löschen einer einzelnen Email aus dieser Tabelle

DELETE FROM Optout WHERE Email = 'ym@cdata.com'

Es können auch mehrere Emails gelöscht werden. Nachfolgend finden Sie ein Beispiel zum Löschen mehrerer Emails in dieser Tabelle.

DELETE FROM Optout WHERE Email = 'jk@cdata.com;mk@cdata.com'

Spalten

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.

Act-On Connector-Ansichten

Kampagnen

Fragen Sie die verfügbaren ActOn-Kampagnen ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Id unterstützt die Operatoren '=' und 'IN'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Campaigns WHERE Id = 0001
SELECT * FROM Campaigns WHERE ID IN (0001, 0002)

Spalten

Kategorien

Fragen Sie die verfügbaren Abonnementkategorien in ActOn ab.

Spezifische Informationen anzeigen

Act-On unterstützt keine Spalte zum Filtern dieser Ansicht.

Spalten

DrilldownBerichte

Fragen Sie detaillierte Berichte zu Nachrichten in ActOn ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• MessageId unterstützt die = Betreiber.
• Drilldown unterstützt die = Operator.

Zur Auswahl aus dieser Ansicht sind „MessageId“ und „Drilldown“ erforderlich. Diese werden durch die Act-On API gefiltert.

SELECT * FROM DrilldownReports WHERE MessageId = 's-0003-1803' AND Drilldown = 'SENT'

Spalten

Harter Bounce

Datensätze einer Hardbounce-Liste abfragen.

Spezifische Informationen anzeigen

Wählen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Timestamp unterstützt die Operatoren '>=', '>', '<=' und '<'.

Beispiel:

SELECT * FROM Hardbounce WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Hardbounce WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Spalten

Bilder

Fragen Sie die verfügbaren Bilder in Ihrem ActOn-Konto ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• FolderName unterstützt die Operatoren '=' und 'IN'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Images WHERE FolderName = 'New Folder'
SELECT Name, FolderName FROM Images WHERE FolderName IN ('New Folder', 'Default Folder')

Spalten

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.

Medien

Fragen Sie die verfügbaren Medien auf Ihrem ActOn-Konto ab.

Spezifische Informationen anzeigen

Act-On unterstützt keine Spalte zum Filtern dieser Ansicht.

Spalten

Nachrichten

Fragen Sie die verfügbaren Nachrichten in ActOn ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Type unterstützt die = Operator.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Messages WHERE Type = 'SENT'

Der Typ kann einer der folgenden sein: GESENDET, ENTWURF, VORLAGE, AUSGELÖST, FEHLGESCHLAGEN, GEPLANT

Spalten

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.

AndereListen

Fragen Sie die Hardbounce-, Spam-Beschwerde- und Optout-Listen auf ActOn ab. Diese Ansicht ist veraltet.

Spezifische Informationen anzeigen

Um Daten aus dieser Ansicht Abfrage, müssen Sie den Typ angeben.
Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Type unterstützt die = Betreiber.
• CreatedAfter unterstützt die = Betreiber.
• CreatedBefore unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM`[AndereListen] `WHERE Type = 'OPTOUT'
SELECT * FROM`[AndereListen] `WHERE Type = 'OPTOUT' AND CreatedAfter = '2018-08-28T14:37:48.923+02:00' AND CreatedBefore = '2018-08-28T14:37:48.925+02:00'
SELECT * FROM`[AndereListen] `WHERE Type = 'HARDBOUNCE' AND CreatedBefore = '2019-09-28T14:39:48.924+02:00'

Spalten

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.

Programme

Fragen Sie die verfügbaren Programme auf ActOn ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Type unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Programs WHERE Type = 'RACK'

Spalten

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.

Berichte

Fragen Sie die verfügbaren Berichte in ActOn ab.

Spezifische Informationen anzeigen

Um Daten aus dieser Ansicht Abfrage, müssen Sie die MessageId angeben.
Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• MessageId unterstützt die Operatoren '=' und 'IN'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Reports WHERE MessageId = 'd-0008'
SELECT * FROM Reports WHERE MessageId IN ('d-0008', 's-0004-1809')

Spalten

BerichteNachZeitraum

Fragen Sie die mit Nachrichten in ActOn verknüpften Berichte ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Period unterstützt die Operatoren '=' und 'IN'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ReportsByPeriod WHERE Period = 'January 2018'
SELECT * FROM ReportsByPeriod WHERE Period IN ('January 2018', 'March 2018')

Wenn nicht angegeben, ist der Zeitraum der aktuelle Monat.

Spalten

Punktedetails

Fragen Sie die Score-Details eines Kontakts ab.

Spezifische Informationen anzeigen

Um Daten aus dieser Ansicht Abfrage, müssen Sie die Kontakt-ID angeben.
Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• ContactId unterstützt die Operatoren '=' und 'IN'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ScoreDetails WHERE ContactId = 'l-0004:2'
SELECT * FROM ScoreDetails WHERE ContactId IN ('l-0004:2', 'l-0004:3')

Spalten

Spambeschwerde

Abfrage von Datensätzen einer Spambeschwerdeliste.

Spezifische Informationen anzeigen

Wählen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Timestamp unterstützt die Operatoren '>=', '>', '<=' und '<'.

Beispiel:

SELECT * FROM Spamcomplaint WHERE Timestamp >= '2022-09-15 08:53:50.111' AND Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Spamcomplaint WHERE Timestamp > '2022-09-15 08:53:50.111' AND Timestamp < '2022-09-16 00:30:33.14'

Spalten

Abmeldungen von Abonnements

Fragen Sie die verfügbaren Abonnements in ActOn ab.

Spezifische Informationen anzeigen

Der Connector verwendet die Act-On API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Category unterstützt die = Operator.

Zur Auswahl aus dieser Ansicht ist eine Kategorie erforderlich. Die folgende Abfrage wird beispielsweise serverseitig verarbeitet:

SELECT * FROM SubscriptionOptOuts WHERE Category = 'test'

Spalten

Benutzer

Fragen Sie die Email Absender für das aktuelle Konto in ActOn ab.

Spezifische Informationen anzeigen

Act-On unterstützt keine Spalte zum Filtern dieser Ansicht.

Spalten

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Act-On Connector

GetOAuthAccessToken

Erhält ein Authentifizierungstoken von ActOn.

Eingang

Ergebnissatzspalten

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

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Basecamp-Diensten verwendet wird.

Eingang

Ergebnissatzspalten

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 Act-On 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

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas

Spalten

Sys_tables

Listet die verfügbaren Tabellen auf.

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

SELECT * FROM sys_tables

Spalten

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

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

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

Spalten

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

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

SELECT * FROM sys_procedures

Spalten

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

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

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

Spalten

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

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

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

Spalten

Sys_foreignkeys

Beschreibt die Fremdschlüssel.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Spalten

Sys_primarykeys

Beschreibt die Primärschlüssel.

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

SELECT * FROM sys_primarykeys

Spalten

Sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Spalten

Sys_connection_props

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

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:acton:config:

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Spalten

Sys_sqlinfo

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

Entdecken der SELECT-Funktionen der Datenquelle

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Spalten

Systemidentität

Gibt Informationen zu versuchten Änderungen zurück.

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

SELECT * FROM sys_identity

Spalten

Systeminformationen

Beschreibt die verfügbaren Systeminformationen.

Die folgende Abfrage ruft alle Spalten ab:

SELECT * FROM sys_information

Spalten

Erweiterte Konfigurationseigenschaften

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

Authentifizierung

OAuth

SSL

Schema

Verschiedenes

Authentifizierung

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

AuthScheme

Der bei der Verbindung mit Act-On zu verwendende Authentifizierungstyp.

Mögliche Werte

OAuth, OAuthPassword

Datentyp

string

Standardwert

OAuth

Hinweise

• OAuth: Legen Sie dies fest, um OAuth mit dem Code-Grant-Typ auszuführen.

• OAuthPassword: Legen Sie dies fest, um OAuth mit dem Passwort-Grant-Typ auszuführen.

Benutzer

Das zur Authentifizierung verwendete Act-On-Benutzerkonto.

Datentyp

string

Standardwert

""

Hinweise

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

Passwort

Das zur Authentifizierung des Benutzers verwendete Passwort.

Datentyp

string

Standardwert

""

Hinweise

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

OAuth

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

OAuth initiieren

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

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

OFF

Hinweise

Folgende Optionen stehen zur Verfügung:

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

OAuthClientId

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

Datentyp

string

Standardwert

""

Hinweise

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

OAuthClientSecret

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

Datentyp

string

Standardwert

""

Hinweise

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

OAuth-Zugriffstoken

Der Zugriffstoken für die Verbindung per OAuth.

Datentyp

string

Standardwert

""

Hinweise

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

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

OAuthSettingsLocation

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

Datentyp

string

Standardwert

%APPDATA%\ActOn 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 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%\ActOn 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:

Rückruf-URL

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

Datentyp

string

Standardwert

""

Hinweise

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

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.

SSLServerCert

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

Datentyp

string

Standardwert

""

Hinweise

Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.

Diese Eigenschaft kann folgende Formen annehmen:

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

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

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

Schema

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

Standort

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

Datentyp

string

Standardwert

%APPDATA%\ActOn 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%\ActOn Data Provider\Schema“ mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

DurchsuchbareSchemas

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

Datentyp

string

Standardwert

""

Hinweise

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

Tabellen

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

Datentyp

string

Standardwert

""

Hinweise

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

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

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

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

Ansichten

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

Datentyp

string

Standardwert

""

Hinweise

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

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

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

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

Verschiedenes

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

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

Seitengröße

Die maximale Anzahl der Ergebnisse, die pro Seite von Act-On zurückgegeben werden sollen.

Datentyp

int

Standardwert

1000

Hinweise

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

Pseudospalten

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

Datentyp

string

Standardwert

""

Hinweise

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

Zeilenscantiefe

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

Datentyp

int

Standardwert

50

Hinweise

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

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

Zeitüberschreitung

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

Datentyp

int

Standardwert

60

Hinweise

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

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

Typerkennungsschema

Bestimmt, wie der Datentyp von Spalten ermittelt wird.

Mögliche Werte

None, RowScan

Datentyp

string

Standardwert

RowScan

Hinweise

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