Financial Edge NXT Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8803 des Connectors.

Erste Schritte

Unterstützung für die Blackbaud Financial Edge NXT -Version

Der Connector nutzt die Blackbaud FinancialEdge NXT SKY API V1, um bidirektionalen Zugriff auf Blackbaud Financial Edge NXT zu ermöglichen.

Herstellen einer Verbindung

Authentifizieren Sie sich bei Blackbaud Financial Edge NXT

Blackbaud Financial Edge NXT verwendet den OAuth-Authentifizierungsstandard. Blackbaud Financial Edge NXT muss auf einem Autorisierungskonto aktiviert werden, um Ergebnisse abzurufen.

Sie können eine Verbindung herstellen, nachdem Sie die erforderlichen Verbindungseigenschaften für Ihre Benutzeranmeldeinformationen festgelegt und die erforderlichen Zugriffstoken mit einem Tool wie Postman abgerufen haben.

Siehe OAuth-Authentifizierung verwenden für eine Authentifizierungsanleitung und Einzelheiten zum OAuth-Authentifizierungsablauf.

Erstellen einer benutzerdefinierten OAuth-App

Weitere Informationen zu den ersten beiden Schritten finden Sie in der Blackbaud-Anleitung für den Einstieg: BlackBaud-Dokumentation für den Einstieg.

Um eine Anwendung zum Abrufen der OAuth-Clientanmeldeinformationen zu erstellen, OAuthClientId Und OAuthClientSecret:

1. Richten Sie ein Entwickler ein

Gehen Sie dazu zu BlackBaud Sign Up.

2. Erhalten Sie einen Abonnementschlüssel

1. Fordern Sie ein Abonnement für eine API von der BlackBaud-Produktseite an und wählen Sie SKY API Standard Edition.

2. Wählen Sie Subscribe. Ein Bestätigungsbildschirm wird angezeigt.

3. Um Ihre Anfrage zu übermitteln, wählen Sie Confirm.

   BlackBaud sendet eine Email Benachrichtigung, wenn Ihre Anfrage genehmigt wurde. Nach der Genehmigung können Sie den Abonnementschlüssel in Ihrem Entwickler anzeigen.

3. Registrieren Sie Ihre App

1. Von My Applications (sehen https://developer.blackbaud.com/apps), wählen Register app.
2. Geben Sie Ihre Anwendungsdetails ein, einschließlich der Umleitungs-URI:
   • Für Desktop-Anwendungen verwenden Sie http://localhost:33333 oder ein anderer Port Ihrer Wahl.
   • Verwenden Sie für Webanwendungen eine URL, unter der Benutzer landen sollen, nachdem sie Ihnen Zugriff auf Ihre benutzerdefinierte Anwendung gewährt haben.
3. Klicken Sie auf Save.

Sie können jetzt Ihre Anwendungs-Client-ID und Ihr Client-Geheimnis abrufen. Notieren Sie diese für die zukünftige Verwendung.

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 Blackbaud Financial Edge NXT -Connectors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert möglichst viel der Verarbeitung der SELECT-Anweisung auf Blackbaud Financial Edge NXT und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Benutzerdefinierte Ansichten

Mit dem Jitterbit Connector für Blackbaud Financial Edge NXT können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

• Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
• DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

• Jedes Stammelement definiert den Namen einer Ansicht.
• Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie 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 Jitterbit Connector für Blackbaud Financial Edge NXT modelliert Blackbaud Financial Edge NXT Objekte als relationale Ansichten. Ein Blackbaud Financial Edge NXT Objekt hat Beziehungen zu anderen Objekten; in den Ansichten werden diese Beziehungen durch Fremdschlüssel ausgedrückt. Die folgenden Abschnitte zeigen die verfügbaren API Objekte und bieten weitere Informationen zum Ausführen von SQL für Blackbaud Financial Edge NXT APIs.

Schemata für die meisten Datenbankobjekte werden in einfachen, textbasierten Konfigurationsdateien definiert. Für die Ansichten, die benutzerdefinierte Felder enthalten können, werden die Spalten dynamisch aufgelistet. Wenn der authentifizierte Benutzer benutzerdefinierte Felder für einige Objekte ändert, werden diese in den entsprechenden Ansichten angezeigt.

Ansichten

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

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

Jitterbit-Connector für Blackbaud Financial Edge NXT Ansichten

KontoCashflows

Gibt die Liste der verfügbaren Cashflow-Werte zurück

Spalten

Kontocodes

Gibt die Kontocodes zurück.

Spalten

Kontodeckungsanforderungen

Gibt die Anforderungen für die Kontomittel zurück.

Spalten

KontoGuthaben

Gibt das Kontoguthaben zurück.

Spalten

Konten

Konten abrufen und Abfrage.

Der Connector verwendet die Blackbaud Financial Edge NXT 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 den Operator '='. Diese Spalte wird nach Servereport Suite ID (RSID) gefiltert, wenn dies der einzige angegebene Filter in den Kriterien ist.
• DateModified unterstützt die folgenden Operatoren: >,>=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Accounts WHERE AccountId = 123
SELECT * FROM Accounts WHERE DateModified >= '2010-01-01 10:10:10'
SELECT * FROM Accounts WHERE DateModified > '2010-01-01 10:10:10'

Spalten

Kontosegmente

Gibt den angegebenen Kontosegmentwert zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• SegmentId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM AccountSegments WHERE SegmentId = 123

Spalten

Kontostrukturen

Gibt eine Liste von Kontostrukturen zurück.

Spalten

KontoOperationskapital

Gibt die Liste der verfügbaren Operationskapitalwerte zurück

Spalten

Batchvalidierungen

Gibt die Ergebnisse der Charge zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BatchId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM BatchValidations WHERE BatchId = 123

Spalten

Haushaltskonten

Gibt Details für jeden Geschäftsjahr und jedes Konto im Szenario zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId, AccountNumber unterstützt den Operator '='. Eine Suche mit leerem Inhalt wird nicht unterstützt.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BudgetAccounts WHERE BudgetScenarioId = 123
SELECT * FROM BudgetAccounts WHERE BudgetScenarioId = 123 AND AccountNumber = 'abc'

Spalten

BudgetDetails

Gibt die angegebenen Budgetdetails zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM BudgetDetails WHERE BudgetScenarioId = 123

Spalten

BudgetGeschäftsperioden

Gibt Details für jeden Geschäftsjahr in einem Budgetszenario zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123

Spalten

BudgetZuschüsse

Gibt Details für jeden Haushaltszeitraum und jede Bewilligung im Szenario zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId, Grant unterstützt den Operator '='. Eine leere Suche wird nicht unterstützt.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BudgetGrants WHERE BudgetScenarioId = 123
SELECT * FROM BudgetGrants WHERE BudgetScenarioId = 123 AND Grant = 'abc'

Spalten

BudgetLines

Gibt die angegebenen Budgetzeilen zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM BudgetLines WHERE BudgetScenarioId = 123

Spalten

BudgetProjekte

Gibt Details für jeden Geschäftsjahr und jedes Projekt im Szenario zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BudgetScenarioId, UiProjectId unterstützt den Operator '='. Eine Suche mit leerem Inhalt wird nicht unterstützt.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BudgetProjects WHERE BudgetScenarioId = 123
SELECT * FROM BudgetProjects WHERE BudgetScenarioId = 123 AND UiProjectId = 'abc'

Spalten

Budgets

Gibt eine Übersicht auf oberster Ebene über jedes Budgetszenario zurück.

Spalten

Budgetszenarien

Gibt Details für jede Szenario-ID zurück.

Spalten

CashManagementDistributionSetLineItemProjekte

Die Projektverteilung für die Einzelposten in den Cash-Management-Verteilungssätzen.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• SetId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123

Spalten

CashManagementDistributionSets

Gibt die Liste der Cash-Management-Verteilungssätze und deren Einzelposten zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• SetId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM CashManagementDistributionSets WHERE SetId = 123

Spalten

Klassen

Die Liste der Klassen

Spalten

Kundennamen

Gibt die Clienttypnamen zurück.

Spalten

Geschäftsjahre

Gibt die Liste mit den Angaben zum Geschäftsjahr zurück.

Spalten

GrantCustomFields

Gibt die Liste der benutzerdefinierten Feldoptionen für die Gewährung zurück.

Spalten

Gewährungsstatus

Gibt die Liste der Bewilligungsstatus zurück.

Spalten

Zuschussarten

Gibt die Liste der Bewilligungsarten zurück.

Spalten

JournalCodes

Gibt die Liste aller verfügbaren Journalcodes zurück.

Spalten

Tagebucheinträge

Abrufen und Abfrage von Journaleinträgen.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BatchId unterstützt den Operator '='. Dies ist die einzige unterstützte Spalte.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM JournalEntries WHERE BatchId = 123

Spalten

JournaleintragStapel

Gibt die Liste der Journaleintragsstapel zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BatchId unterstützt den Operator '='. Diese Spalte wird nach der Servereport Suite-ID (RSID) gefiltert, wenn sie der einzige angegebene Filter in den Kriterien ist.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM JournalEntryBatches WHERE BatchId = 123

Spalten

LedgerSummaries

Listet Hauptbuchzusammenfassungen für das angegebene Geschäftsjahr und die angegebenen Kriterien auf. Beachten Sie, dass Zusammenfassungsdatensätze nur für abgeschlossene, optimierte Geschäftsjahre vorhanden sind. Wenn in einem Geschäftsjahr eine Aktivität auftritt, die seitdem nicht abgeschlossen und optimiert wurde, wird sie nicht in die Hauptbuchzusammenfassungsdatensätze aufgenommen.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• FiscalYearId, AccountNumber Und UiProjectId unterstützt den '='-Operator. Eine leere Suche wird nicht unterstützt.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM LedgerSummaries WHERE FiscalYearId = 1 AND AccountNumber = 'abc' AND UiProjectId = 'def'

Spalten

Medientypen

Gibt eine Liste mit Medientypoptionen zurück.

Spalten

Periodenübersichten

Sobald der Zusammenfassungsprozess abgeschlossen ist, erhalten Sie die Daten auf diese Weise zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• FiscalYear, FiscalPeriod, AccountNumber Und UiProjectId unterstützt den '='-Operator. Eine leere Suche wird nicht unterstützt.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM PeriodSummaries WHERE FiscalYear = 'year' AND FiscalPeriod = 'period' AND  AccountNumber = 'abc' AND UiProjectId = 'def'

Spalten

PeriodenzusammenfassungenVerarbeitungsinformationen

Dieser Endpoint meldet den aktuellen Status der Zusammenfassungsanforderung, ob sie abgeschlossen ist, noch ausgeführt wird oder fehlgeschlagen ist.

Spalten

Projektanhänge

Gibt die Liste der Anhänge für das angegebene Projekt zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• ProjectId unterstützt den Operator '='. Diese Spalte ist erforderlich, um die Projektanhänge abzurufen.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

Spalten

ProjektKontaktMethoden

Adressdaten der Ansprechpartner für Projekte.

Spalten

ProjektKontakte

Die Kontakte zu einem Projekt.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• ProjectId unterstützt den Operator '='. Diese Spalte ist der einzige unterstützte Filter.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM ProjectContacts WHERE ProjectId = 1

Spalten

Projektabteilungen

Gibt die Liste der Projektabteilungen zurück.

Spalten

Projektabteilungen

Gibt die Liste der Projektabteilungen zurück.

Spalten

ProjektStandorte

Gibt die Liste der Projektstandorte zurück.

Spalten

Projekte

Projekte abrufen und Abfrage.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• ProjectId unterstützt den Operator '='. Diese Spalte wird nach Servereport Suite ID (RSID) gefiltert, wenn dies der einzige angegebene Filter in den Kriterien ist.
• Location,Type,Division Und Department unterstützt den Operator '='. Eine Suche mit leerem Inhalt wird nicht unterstützt.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Projects WHERE ProjectId = 1
SELECT * FROM Projects WHERE Location = 'abc' AND Type = 'def' AND Division = 'abc' AND Department = 'abc'

Spalten

Projektstatus

Gibt die Liste der Projektstatus zurück.

Spalten

Projekttypen

Gibt die Liste der Projekttypen zurück.

Spalten

Transaktionscodes

Gibt die Liste aller verfügbaren Transaktionscodes zurück.

Spalten

Transaktionscodewerte

Gibt die Liste aller Werte für den angegebenen Transaktionscode zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• TransactionCodeId unterstützt den Operator '='. Diese Spalte ist der einzige unterstützte Filter.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1

Spalten

Transaktionsverteilungen

Gibt eine Liste der Transaktionen zurück, die den Suchkriterien entsprechen

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• BatchId, AccountNumber, UiProjectId, TypeCode, Encumbrance, Journal, Und PostStatus unterstützt den Operator '='. Eine Suche mit leerem Inhalt wird nicht unterstützt.
• PostDate unterstützt die folgenden Operatoren: <,<=,=,>=,>.
• DateModified unterstützt die folgenden Operatoren: >,>=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM TransactionDistributions WHERE BatchId = 123 AND PostDate < '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE AccountNumber = 'abc' AND Journal = 'def' AND PostDate <= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE UiProjectId = 'abc' AND PostStatus = 'def' AND PostDate = '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE TypeCode = 'abc' AND DateModified > '2010-01-01 08:10:10' AND PostDate >= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE Encumbrance = 'abc' AND PostDate > '2010-01-01 10:10:10'

Spalten

Transaktionsverteilungssätze

Gibt die Liste der Transaktionsverteilungssätze zurück.

Der Connector verwendet die Blackbaud Financial Edge NXT 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.

• SetId unterstützt den Operator '='. Diese Spalte ist der einzige unterstützte Filter.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1

Spalten

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit Blackbaud Financial Edge NXT hinaus erweitern.

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

Jitterbit-Connector für gespeicherte Prozeduren von Blackbaud Financial Edge NXT

GetOAuthAccessToken

Ruft ein Authentifizierungstoken von Blackbaud Financial Edge NXT ab.

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 mit Blackbaud Financial Edge NXT 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 Blackbaud Financial Edge NXT 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 „Konten“ zurück:

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

Spalten

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

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

SELECT * FROM sys_procedures

Spalten

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

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

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

Spalten

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

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

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

Spalten

Sys_foreignkeys

Beschreibt die Fremdschlüssel.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Spalten

Sys_primarykeys

Beschreibt die Primärschlüssel.

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

SELECT * FROM sys_primarykeys

Spalten

Sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Spalten

Sys_connection_props

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

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:financialedgenxt: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

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.

OAuth

SSL

Schema

Verschiedenes

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.

Abonnementschlüssel

Abonnementschlüssel, der Zugriff auf die API ermöglicht. Zu finden in Ihrem Profil.

Datentyp

string

Standardwert

""

Hinweise

Abonnementschlüssel, der Zugriff auf die API ermöglicht. Zu finden in Ihrem Profil.

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 behalten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

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

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Treiber speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.

Anstatt einen Dateipfad anzugeben, können Sie auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

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

• Windows: "register://%DSN"
• Unix: "%AppData%..."

wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.

Die folgende Tabelle listet den Wert von auf %APPDATA% nach Operationssystem:

Rückruf-URL

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

Datentyp

string

Standardwert

""

Hinweise

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

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

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%\FinancialEdgeNXT 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%\FinancialEdgeNXT 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 Anzahl der Ergebnisse, die pro Seite mit aus Blackbaud Financial Edge NXT abgerufenen Daten zurückgegeben werden sollen.

Datentyp

string

Standardwert

""

Hinweise

Die Seitengröße wird automatisch bestimmt, wenn Sie sie nicht manuell festlegen. Es ist im Allgemeinen nicht notwendig, diesen Wert jemals festzulegen.

Pseudospalten

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

Datentyp

string

Standardwert

""

Hinweise

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

Zeitüberschreitung

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

Datentyp

int

Standardwert

60

Hinweise

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

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

BenutzerdefinierteAnsichten

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

Datentyp

string

Standardwert

""

Hinweise

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

• Jedes Stammelement definiert den Namen einer Ansicht.
• Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Accounts 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.