Veeva Vault-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.9039 des Connectors.

Erste Schritte

Versionsunterstützung für Veeva Vault

Der Connector nutzt die Versionen 21.1 und höher der VeevaVault API, um einen bidirektionalen Zugriff auf VeevaVault-Daten zu ermöglichen.

Herstellen einer Verbindung

Mit Veeva Vault verbinden

Um eine Verbindung zu Ihrem Veeva Vault-Konto herzustellen, müssen Sie zunächst die angeben URL Verbindungseigenschaft zum Host, die Sie in der Adressleiste nach der Anmeldung bei Ihrem Konto sehen, z. B. https://myvault.veevavault.com.

OpenID Connect mit Microsoft Entra ID

OpenID Connect mit Microsoft Entra ID ist ein Verbindungstyp, der über OAuth läuft. Setzen Sie die AuthScheme Zu AzureADOpenID und das OpenIDConnectProfileID Verbindungseigenschaft zur ID Ihres Open ID Connect-Profils, das Sie finden, indem Sie zu navigieren Admin > Settings > OAuth 2.0 / OpenID Connect Profiles und erweitern Sie die Details Ihres OpenID Connect-Profils.

Authentifizieren Sie sich bei Veeva Vault

Für die Verbindung mit Ihrer Veeva Vault Datenquelle stehen zwei Authentifizierungsmethoden zur Verfügung: Basic und OAuth 2.0/OpenID Connect mit dem Microsoft Entra ID Authentifizierungsanbieter.

Benutzeranmeldeinformationen

Setzen Sie die AuthScheme Zu Basic und setzen Sie die User Und Password zu Ihren Benutzeranmeldeinformationen.

OpenID mit Microsoft Entra ID

OpenID Connect mit Microsoft Entra ID ist ein Verbindungstyp, der über OAuth läuft. Setzen Sie die AuthScheme Zu AzureADOpenID. Die folgenden Abschnitte setzen voraus, dass Sie dies getan haben.

Desktop-Anwendungen

Befolgen Sie die nachstehenden Schritte, um sich mit den Anmeldeinformationen für eine benutzerdefinierte OAuth-App zu authentifizieren. Siehe Erstellen einer benutzerdefinierten Microsoft Entra ID App. Get an OAuth Access Token

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

1. Authenticating using a Client Secret
   • OAuthClientId: Legen Sie dies in Ihren App-Einstellungen auf die Client-ID fest.
   • OAuthClientSecret: Legen Sie dies in Ihren App-Einstellungen auf das Client-Geheimnis fest.
   • CallbackURL: Legen Sie dies in Ihren App-Einstellungen auf die Umleitungs URL fest.
   • InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeiden OAuthAccessToken..
   • Optional müssen Sie, abhängig von den erforderlichen Ansprüchen zum Abschließen der Authentifizierung mit der Veeva Vault Datenquelle, möglicherweise zusätzliche Bereiche über festlegen Scope Eigenschaft. Um beispielsweise den Benutzernamen und die Email Ansprüche vom UserInfo-Endpoint abzurufen, müssen Sie den Bereichswert auf „OpenID-Profil-Email Offlinezugriff“ festlegen.
2. Authenticating using a Certificate
   • OAuthClientId: Legen Sie dies in Ihren App-Einstellungen auf die Client-ID fest.
   • OAuthJWTCert: Stellen Sie dies auf den JWT-Zertifikatspeicher ein.
   • OAuthJWTCertType: Setzen Sie dies auf den Typ des Zertifikatspeichers, der durch angegeben ist OAuthJWTCert.
   • CallbackURL: Legen Sie dies in Ihren App-Einstellungen auf die Umleitungs URL fest.
   • InitiateOAuth: Setzen Sie dies auf GETANDREFRESH. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeiden OAuthAccessToken..
   • Optional müssen Sie, abhängig von den erforderlichen Ansprüchen zum Abschließen der Authentifizierung mit der Veeva Vault Datenquelle, möglicherweise zusätzliche Bereiche über festlegen Scope Eigenschaft. Um beispielsweise den Benutzernamen und die Email Ansprüche vom UserInfo-Endpoint abzurufen, müssen Sie den Bereichswert auf „OpenID-Profil-Email Offlinezugriff“ festlegen.

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

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

Erstellen einer benutzerdefinierten Microsoft Entra ID App

Erstellen einer Microsoft Entra ID Anwendung

Veeva Vault unterstützt benutzerbasierte Authentifizierung mit Microsoft Entra ID. Diese Authentifizierung basiert auf OAuth.

Um über das Web eine Verbindung zu Veeva Vault herzustellen, müssen Sie immer eine benutzerdefinierte Anwendung erstellen, wie hier beschrieben.

Benutzerdefinierte OAuth-Anwendungen sind nützlich, wenn Sie:

• Kontrollieren Sie das Branding des Authentifizierungsdialogs.
• Steuern Sie die Umleitungs-URI, zu der die Anwendung den Benutzer nach seiner Authentifizierung umleitet.
• Passen Sie die Berechtigungen an, die Sie vom Benutzer anfordern.

Authentifizieren mit Microsoft Entra ID

In <https://portal.azure.com>:

1. Wählen Sie im linken Navigationsbereich Microsoft Entra ID > App registrations.

2. Klicken Sie auf New registration.

3. Geben Sie einen Namen für die Anwendung ein.

4. Geben Sie die Kontotypen an, die diese Anwendung unterstützen soll:

   • Für Anwendungen zur privaten Nutzung wählen Sie Accounts in this organization directory only.
   • Für verteilte Anwendungen wählen Sie eine der Multi-Tenant-Optionen.

1. Setzen Sie die Umleitungs-URI auf http://localhost:33333 (Standard) ODER, wenn Sie möchten

   anderen Port angeben, gewünschten Port angeben und einstellen CallbackURL zur genauen Antwort URL, die Sie gerade definiert haben.

2. Um die neue Anwendung zu registrieren, klicken Sie auf Register. Ein Anwendungsverwaltungsbildschirm wird angezeigt. Notieren Sie diese Werte zur späteren Verwendung. (Sie verwenden die Application (client) IDWert zum Festlegen von OAuthClientId Parameter und die Directory (tenant) IDWert zum Festlegen von AzureTenant Parameter.)

3. Navigieren Sie zu Certificates & Secrets. Wählen New Client Secret für diese Anwendung und geben Sie die gewünschte Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt die Azure App-Registrierung den Schlüsselwert an. Dieser Wert wird nur einmal angezeigt, notieren Sie ihn also für die zukünftige Verwendung. (Sie werden ihn verwenden, um den festzulegen OAuthClientSecret.)

4. Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist, können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.

Aktualisieren Sie Ihre benutzerdefinierte Microsoft Entra ID App

Wann Sie eine benutzerdefinierte Microsoft Entra ID App verwenden sollten

Bevor Sie die App verwenden, die Sie zuvor erstellt haben, um den Microsoft Entra ID Authentifizierungsanbieter für Ihre Veeva Vault Datenquelle zu konfigurieren, müssen Sie sie aktualisieren, um eine Umleitungs URL einzuschließen. Auf diese Weise kann der Connector den Prüfcode aus der geöffneten Browser-Tab abrufen und den Ablauf abschließen. Um dies zu tun und die OAuth-Werte für Ihre App abzurufen, OAuthClientId Und OAuthClientSecret, Sie können die folgenden Schritte ausführen.

Schritte zum Aktualisieren Ihrer benutzerdefinierten Microsoft Entra ID App

Befolgen Sie die nachstehenden Schritte, um eine Umleitungs URL hinzuzufügen und die OAuth-Werte für Ihre App abzurufen. OAuthClientId Und OAuthClientSecret.

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

2. Wählen Sie im linken Navigationsbereich Microsoft Entra ID, dann App-Registrierungen und klicken Sie auf die App, die Sie zuvor erstellt haben, um die Azure

   AD-Authentifizierungsanbieter.

3. Aus dem Abschnitt Übersicht können Sie die Anwendungs-ID (Client-ID) kopieren, die der entspricht OAuthClientId-Eigenschaft.

4. Im Abschnitt „Zertifikate und Geheimnisse“ können Sie optional einen neuen App-Authentifizierungstyp definieren oder den bereits vorhandenen verwenden. Es stehen zwei Arten der Authentifizierung zur Verfügung: mithilfe eines Client-Geheimnisses und mithilfe eines Zertifikats. Die empfohlene Authentifizierungsmethode ist über ein Zertifikat, Sie können jedoch auch ein Anwendungsgeheimnis erstellen.

   • Option 1 - Upload a certificate: Wählen Sie im Abschnitt „Zertifikate und Geheimnisse“ die Option „Zertifikat hochladen“ und wählen Sie das Zertifikat aus, das von Ihrem lokalen Computer hochgeladen werden soll.
   • Option 2 - Create a new application secret: Wählen Sie im Abschnitt „Zertifikate und Geheimnisse“ „Neues Client-Geheimnis“ für die App und legen Sie deren Dauer fest. Nach dem Speichern des Client-Geheimnisses wird der Schlüsselwert angezeigt. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird und als verwendet wird OAuthClientSecret.

5. Im Abschnitt Authentifizierung können Sie unter den Umleitungs-URIs der vorhandenen Webplattform eine neue Umleitungs-URL hinzufügen, beispielsweise http://localhost:33333, der Standard des Connectors. Oder legen Sie einen anderen Port Ihrer Wahl fest und setzen Sie CallbackURL an die genaue Antwort-URL, die Sie definiert haben.

6. Speichern Sie Ihre Änderungen.

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

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Veeva Vault-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 Documents 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 Veeva Vault Connector modelliert Veeva Vault Objekte als relationale Ansichten. Ein Veeva Vault-Objekt hat Beziehungen zu anderen Objekten; in den Ansichten werden diese Beziehungen durch Fremdschlüssel ausgedrückt. Die folgenden Abschnitte zeigen die statischen Endpoints der Veeva Vault API.

Die übrigen Ansichten werden jedoch dynamisch bestimmt, indem die Metadaten verwendet werden, die über die Veeva Vault API verfügbar gemacht werden. Alle Vault-Objekte werden vom Veeva Vault Connector verfügbar gemacht. Allerdings listen wir in der Hilfe nur Ansichten für Typen auf, bei denen wir zur Entwurfszeit alle verfügbaren Spalten bestimmen können. Beispiele für Veeva-Objekte, die mit dem Veeva Vault Connector verfügbar sind, aber nicht in der Hilfe angezeigt werden, sind:

• Documents (Frage die verfügbaren Dokumente ab, VQL wird verwendet, wenn dies für dieses Objekt möglich ist.)
• Users (Frage die vorhandenen Benutzer ab, VQL wird, wenn möglich, für dieses Objekt verwendet.)
• Groups (Frage die vorhandenen Gruppen ab, VQL wird, wenn möglich, für dieses Objekt verwendet.)
• {Every Vault Object} (Frage jedes Tresorobjekt in seiner eigenen Ansicht ab. Zum Abfrage der Ansichten von Tresorobjekten wird immer VQL verwendet.)

Über Veeva Vault Query

Veeva Vault Query (VQL) ist eine SQL-ähnliche Abfrage. Sie kann über die Veeva Vault API verwendet werden. Wenn die Abfrage serverseitig verarbeitet werden kann, wandelt der Anbieter SQL in VQL um und sendet es an Veeva Vault. Durch diese Optimierung wird die Ausführungszeit verkürzt, da die Filterung serverseitig erfolgt.

Außerdem unterstützt der Anbieter QueryPassthrough, was bedeutet, dass Sie eine VQL Abfrage schreiben und direkt an Veeva Vault senden können. Dies können Sie tun, indem Sie die Verbindungseigenschaft QueryPassthrough auf true setzen.

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.

Veeva Vault Connector-Ansichten

Prüfhistorie

Rufen Sie den vollständigen Prüfverlauf für ein einzelnes Dokument oder einen einzelnen Objektdatensatz ab.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen entweder die Spalte „DocumentId“ oder die Spalten „ObjectName“ und „ObjectRecordId“ angegeben werden.

Der Connector verwendet die Veeva Vault 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.

• DocumentId unterstützt die = Betreiber.
• ObjectName unterstützt die = Betreiber.
• ObjectRecordId unterstützt die = Betreiber.
• StartDate unterstützt die = Betreiber.
• EndDate unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM AuditHistory WHERE DocumentId = '8'
SELECT * FROM AuditHistory WHERE ObjectName = 'product__v' AND ObjectRecordId = '00P000000000601'
SELECT * FROM AuditHistory WHERE DocumentId = '3258' AND StartDate = '2020-01-01T01:13:36' AND EndDate = '2020-01-06T01:3:32'

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.

Dokumentbeziehungen

Gibt alle Beziehungen pro Dokument zurück.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen DocumentId, MajorVersion und MinorVersion angegeben werden. Um diese Werte zu finden, können Sie die folgende Abfrage ausführen:

SELECT version_id FROM Documents

Und die Versions-ID-Werte entsprechen diesem Muster: {DocumentId}_{MajorVersion}_{MinorVersion}

Einige Abfrage:

SELECT * FROM DocumentRelationships WHERE SourceDocumentId = '122' AND MajorVersion = 1 AND MinorVersion = 0
SELECT * FROM DocumentRelationships WHERE SourceDocumentId = '101' AND MajorVersion = 0 AND MinorVersion = 1

Spalten

Dokumentrollen

Manuelles Abrufen zugewiesener Rollen in einem Dokument und der ihnen zugewiesenen Benutzer und Gruppen.

Spezifische Informationen anzeigen

Der Connector verwendet die Veeva Vault 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.

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

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM DocumentRoles WHERE DocumentId = '100'
SELECT * FROM DocumentRoles WHERE DocumentId IN ('99', '98', '876', '873', '867', '1')

Es wird empfohlen, DocumentId anzugeben, da der Anbieter sonst für jedes Dokument eine neue Anfrage stellt, wodurch die Ausführung der Abfrage einige Zeit in Anspruch nehmen kann.

Spalten

Dokumentbenutzeraktionen

Rufen Sie alle verfügbaren Benutzeraktionen für bestimmte Versionen mehrerer Dokumente oder Ordner ab.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen DocumentId, MajorVersion und MinorVersion angegeben werden. Um diese Werte zu finden, können Sie die folgende Abfrage ausführen:

SELECT version_id FROM Documents

Und die Versions-ID-Werte entsprechen diesem Muster: {DocumentId}_{MajorVersion}_{MinorVersion}

Einige Abfrage:

SELECT * FROM DocumentUserActions WHERE SourceDocumentId = '122' AND MajorVersion = 1 AND MinorVersion = 0
SELECT * FROM DocumentUserActions WHERE SourceDocumentId = '101' AND MajorVersion = 0 AND MinorVersion = 1

Spalten

Lebenszyklen

Kurzinformationen zu den verfügbaren Lebenszyklen abrufen.

Spezifische Informationen anzeigen

Der Connector verwendet die Veeva Vault 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.

• Lifecycle unterstützt die = Betreiber.
• Role unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Lifecycles WHERE lifecycle = 'draft_to_effective_lifecycle_supporting__c'
SELECT * FROM Lifecycles WHERE Role = 'qa__vs'

Spalten

Objektbeziehungen

Gibt alle Beziehungen für jedes Objekt zurück. Zum Abfrage dieser Ansicht ist ein Objektname erforderlich.

Spalten

Objektrollen

Manuelles Abrufen zugewiesener Rollen in einem Objektdatensatz und der ihnen zugewiesenen Benutzer und Gruppen.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen ObjectName und RecordId angegeben werden.

Einige Abfrage:

SELECT * FROM ObjectRoles WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'
SELECT * FROM ObjectRoles WHERE ObjectName = 'activity__v' AND RecordId = '0AC000000001D27'

Spalten

Objekttypen

Gibt kurze Details zu allen möglichen Objekttypen zurück.

Spezifische Informationen anzeigen

Für diese Ansicht sind keine serverseitigen Filter verfügbar.

Spalten

ObjektWorkflows

Rufen Sie die Workflows eines Objekts oder die Workflows eines Benutzers ab.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen ObjectName und RecordId oder UserId angegeben werden.

Der Connector verwendet die Veeva Vault 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.

• UserId unterstützt die Operatoren '=' und 'IN'.
• ObjectName unterstützt die = Betreiber.
• RecordId unterstützt die = Betreiber.
• Status unterstützt die = Operator.

Beispielsweise werden folgende Abfragen serverseitig verarbeitet:
Einige Abfrage:

SELECT * FROM ObjectWorkflows WHERE UserId IN (SELECT id FROM Users)
SELECT * FROM ObjectWorkflows WHERE UserId IN ('1069977', '115731')
SELECT * FROM ObjectWorkflows WHERE UserId = '1069977'
SELECT * FROM ObjectWorkflows WHERE UserId = '349101' AND Status = 'completed__v'
SELECT * FROM ObjectWorkflows WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'

Spalten

ObjektWorkflowAufgaben

Rufen Sie die Workflows eines Objekts oder die Workflows eines Benutzers ab.

Spezifische Informationen anzeigen

Um diese Ansicht Abfrage, müssen ObjectName und RecordId oder AssigneeId angegeben werden.

Der Connector verwendet die Veeva Vault 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.

• AssigneeId unterstützt die Operatoren '=' und 'IN'.
• ObjectName unterstützt die = Betreiber.
• RecordId unterstützt die = Betreiber.
• Status unterstützt die = Operator.

Beispielsweise werden folgende Abfragen serverseitig verarbeitet:
Einige Abfrage:

SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId IN (SELECT id FROM Users)
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId IN ('1069977', '115731')
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId = '1069977'
SELECT * FROM ObjectWorkflowTasks WHERE AssigneeId = '349101' AND Status = 'completed__v'
SELECT * FROM ObjectWorkflowTasks WHERE ObjectName = 'product__v' AND RecordId = '00P000000000201'

Spalten

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit Veeva Vault hinaus erweitern.

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

Gespeicherte Prozeduren für den Veeva Vault Connector

Dokument erstellen

Erstellen Sie ein einzelnes Dokument.

Um die API Namen der Tabelle „Dokumente“ zu finden, rufen Sie die Spalte „Beschreibung“ für die Tabelle „Dokumente“ ab:

SELECT Description FROM`[sys_tablecolumns] `WHERE TableName = 'Documents'

Die Spalte Beschreibung enthält die API -Namen der Tabelle Dokumente. Verwenden Sie nun diese API Namen, um beispielsweise ein Dokument zu aktualisieren:

EXEC CreateDocument File = 'C:/Users/Public/document1.docx', Type__v = 'Promotional Piece', Subtype__v = 'Advertisement'

Eingang

Ergebnissatzspalten

Dokumentversion erstellen

Fügen Sie eine neue Entwurfsversion eines vorhandenen Dokuments hinzu. Sie können entweder die vorhandene Quelldatei oder eine neue Quelldatei verwenden. Diese Aktionen erhöhen die Nebenversionsnummer des Dokuments. Dies ist analog zur Verwendung der Aktion „Entwurf erstellen“ in der Benutzeroberfläche. Beachten Sie, dass nicht alle Dokumente als Entwurf erstellt werden können. Sie können beispielsweise keinen Entwurf eines ausgecheckten Dokuments erstellen.

EXEC CreateDocumentVersion File = 'C:/Users/Public/document2.docx', DocumentId = '514', CreateDraft = 'uploadedContent', Description = 'This is a description', suppressRendition = 'true'

Eingang

Ergebnissatzspalten

HerunterladenDokumentDatei

Laden Sie eine Dokumentdatei herunter.

Beispiel:

EXEC DownloadDocumentFile DocumentId = '1234', DownloadLocation = 'C:/Users/Public/cover.png'

Hinweis zu LockDocument: Der Benutzer, der das Dokument ausgecheckt hat, und der Dokumentbesitzer können es wieder einchecken. Wenn der Benutzer oder der Dokumentbesitzer nicht verfügbar ist, muss ein Tresorbesitzer oder Administrator das Auschecken rückgängig machen. Andernfalls kann das Dokument nicht fortgesetzt werden.

Eingang

Ergebnissatzspalten

GetOAuthAccessToken

Ruft das OAuth-Zugriffstoken vom Microsoft Entra ID -Authentifizierungsanbieter ab.

Eingang

Ergebnissatzspalten

GetOAuthAuthorizationURL

Ruft die Autorisierungs-URL für Microsoft Entra ID ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge für den Microsoft Entra ID Authentifizierungsanbieter verwendet werden kann.

Eingang

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung mit dem Microsoft Entra ID -Authentifizierungsanbieter verwendet wird.

Eingang

Ergebnissatzspalten

Dokument aktualisieren

Aktualisieren Sie bearbeitbare Feldwerte in der neuesten Version eines einzelnen Dokuments.

Um die API Namen der Tabelle „Dokumente“ zu finden, rufen Sie die Spalte „Beschreibung“ für die Tabelle „Dokumente“ ab:

SELECT Description FROM`[sys_tablecolumns] `WHERE TableName = 'Documents'

Die Spalte Beschreibung enthält die API -Namen der Tabelle Dokumente. Verwenden Sie nun diese API Namen, um beispielsweise ein Dokument zu aktualisieren:

EXEC UpdateDocument DocumentId = '123', name__v = 'new name', product__v = 'new product'

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 Veeva Vault 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 „Dokumente“ zurück:

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

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' 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 „Dokumente“ ab:

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

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

Verbindung

Azure-Authentifizierung

OAuth

JWT OAuth

SSL

Schema

Verschiedenes

Authentifizierung

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

AuthScheme

Das zur Authentifizierung verwendete Schema. Akzeptierte Einträge sind Basic und Microsoft Entra IDOpenID.

Mögliche Werte

Auto, Basic, AzureADOpenID

Datentyp

string

Standardwert

Auto

Hinweise

• Automatisch: Lässt den Treiber automatisch basierend auf den anderen von Ihnen festgelegten Verbindungseigenschaften entscheiden.
• Basic: Legen Sie dies fest, um die Authentifizierung mit dem Basic Schema durchzuführen. Sie müssen die Verbindungseigenschaften „Benutzer“ und „Passwort“ für dieses Schema angeben.
• Microsoft Entra IDOpenID: Eingestellt auf Authentifizierung mithilfe des OpenID Connect-Schema mit dem Microsoft Entra ID Authentifizierungsanbieter.

URL

Den Host sehen Sie in der URL, nachdem Sie sich bei Veeva Vault angemeldet haben.

Datentyp

string

Standardwert

""

Hinweise

Den Host sehen Sie in der URL, nachdem Sie sich bei Veeva Vault angemeldet haben.

Benutzer

Das zur Authentifizierung verwendete Veeva Vault-Benutzerkonto.

Datentyp

string

Standardwert

""

Hinweise

Zusammen mit Passwort, wird dieses Feld zur Authentifizierung gegenüber dem Veeva Vault 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.

OpenIDConnectProfileID

Die ID Ihres OAuth2.0-/Open ID Connect-Profils.

Datentyp

string

Standardwert

""

Hinweise

Die ID Ihres OAuth2.0-/Open ID Connect-Profils. Diese Verbindungseigenschaft ist nur erforderlich, wenn Microsoft Entra IDOpenID AuthScheme verwendet wird.

Verbindung

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

APIVersion

Die verwendete Version der Veeva Vault API.

Datentyp

string

Standardwert

21.1

Hinweise

Die standardmäßig verwendete Veeva Vault API Version ist „21.1“.

Es werden Versionen 21.1 und höher unterstützt.

Azure Authentifizierung

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

AzureTenant

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

Datentyp

string

Standardwert

""

Hinweise

Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Beispiel: contoso.onmicrosoft.com. Alternativ können Sie die Mandanten-ID angeben. Dieser Wert ist die Verzeichnis-ID im Azure-Portal > Microsoft Entra ID > Eigenschaften.

Normalerweise ist es nicht notwendig, den Mandanten anzugeben. Dies kann von Microsoft automatisch ermittelt werden, wenn der OAuthGrantType verwendet wird auf CODE (Standard) eingestellt. Es kann jedoch fehlschlagen, wenn der Benutzer mehreren Mandanten angehört. Zum Beispiel, wenn ein Administrator von Domäne A einen Benutzer von Domäne B als Gastbenutzer einlädt. Der Benutzer gehört nun beiden Mandanten an. Es ist eine gute Praxis, den Mandanten anzugeben, obwohl es im Allgemeinen funktionieren sollte, ohne ihn angeben zu müssen.

AzureTenant ist beim Festlegen von OAuthGrantType erforderlich zu CLIENT. Bei der Verwendung von Client-Anmeldeinformationen gibt es keinen Benutzerkontext. Die Anmeldeinformationen werden aus dem Kontext der App selbst übernommen. Microsoft erlaubt zwar weiterhin den Abruf von Client-Anmeldeinformationen ohne Angabe des Mandanten, aber die Wahrscheinlichkeit, den spezifischen Mandanten auszuwählen, mit dem Sie arbeiten möchten, ist viel geringer. Aus diesem Grund benötigen wir AzureTenant muss bei allen Client-Anmeldeinformationen-Verbindungen ausdrücklich angegeben werden, um sicherzustellen, dass Sie Anmeldeinformationen erhalten, die für die Domäne gelten, mit der Sie eine Verbindung herstellen möchten.

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 per 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%\VeevaVault 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%\VeevaVault 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.

JWT OAuth

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

OAuthJWTCert

Der JWT-Zertifikatspeicher.

Datentyp

string

Standardwert

""

Hinweise

Der Name des Zertifikatspeichers für das Client-Zertifikat.

Der OAuthJWTCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an OAuthJWTCert. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in OAuthJWTCertPassword an.

OAuthJWTCert wird in Verbindung mit OAuthJWTCertSubject verwendet

Feld, um Client-Zertifikate anzugeben. Wenn OAuthJWTCert hat einen Wert und OAuthJWTCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Bitte beachten Sie das OAuthJWTCertSubject für weitere Einzelheiten.

Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.

Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:

In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.

Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei (d. h. PKCS12-Zertifikatsspeicher) gesetzt werden.

OAuthJWTCertType

Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.

Mögliche Werte

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

Datentyp

string

Standardwert

USER

Hinweise

Diese Eigenschaft kann einen der folgenden Werte annehmen:

OAuthJWTCertPasswort

Das Passwort für das OAuth JWT-Zertifikat.

Datentyp

string

Standardwert

""

Hinweise

Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort anzugeben, damit der Zertifikatspeicher geöffnet werden kann.

OAuthJWTCertSubject

Der Betreff des OAuth JWT-Zertifikats.

Datentyp

string

Standardwert

*

Hinweise

Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.

Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten.

Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.

Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.

Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Zum Beispiel „CN=www.server.com, OU=test, C=US, E=example@jbexample.com“. Allgemeine Felder und ihre Bedeutungen werden unten angezeigt.

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

SSL

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

SSLServerCert

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

Datentyp

string

Standardwert

""

Hinweise

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

Diese Eigenschaft kann folgende Formen annehmen:

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

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

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

Schema

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

Standort

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

Datentyp

string

Standardwert

%APPDATA%\VeevaVault 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 nicht angegeben, ist der Standardspeicherort „%APPDATA%\VeevaVault 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.

Spaltennamen-Gebietsschema

Konfigurieren Sie die Sprache der Spaltennamen. Funktioniert nur bei Ansichten, die Vault-Objekte darstellen.

Datentyp

string

Standardwert

""

Hinweise

Verwenden Sie diese Eigenschaft für die Ansichten, die Vault-Objekte darstellen, um die Sprache der Spaltennamen zu konfigurieren. Beispiel: ColumnNamesLocale=de gibt die Spaltennamen auf Deutsch zurück. Beachten Sie, dass diese Eigenschaft nicht funktioniert, wenn Sie QueryPassThrough verwenden.

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 Veeva Vault zurückgegeben werden sollen.

Datentyp

int

Standardwert

1000

Hinweise

Der Pagesize Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von Veeva Vault 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. „*=*“.

QueryPassthrough

Ob der Anbieter die Abfrage unverändert an Veeva Vault weiterleitet oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Ob der Connector die Abfrage unverändert an Veeva Vault weiterleitet. Diese Abfragen sollten die richtige VQL-Syntax verwenden.

Veeva Vault unterstützt eine Reihe von Abfragen, die nicht im regulären SQL-92-Standard angegeben sind. Um diese Abfragen auszuführen, setzen Sie einfach QueryPassthrough auf true. Dadurch wird die Abfrage direkt an Veeva Vault weitergeleitet, ohne sie intern zu analysieren.

Zeitüberschreitung

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

Datentyp

int

Standardwert

60

Hinweise

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

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

Anzeigenamen verwenden

Wenn der Wert auf „false“ gesetzt ist, verwendet der Anbieter für einige Vorgänge API-Namen.

Datentyp

bool

Standardwert

true

Hinweise

Wenn auf „false“ gesetzt, verwendet der Connector für einige Vorgänge API-Namen. Diese Eigenschaft wird für benutzerdefinierte Module verwendet: Der API Name für benutzerdefinierte Module unterscheidet sich von einem benutzerdefinierten Modulnamen in der Veeva Vault-Benutzeroberfläche. Wenn Sie beispielsweise ein benutzerdefiniertes Potentials-Modul in Veeva Vault erstellen, stellt der Connector die zugrunde liegenden Anforderungen an den API Namen, z. B. CustomModule_1.

Setzen Sie diese Eigenschaft auf „False“, um den API-Namen in SQL-Abfragen zu verwenden.

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

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

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

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

UseSimpleNames

Boolescher Wert, der bestimmt, ob einfache Namen für Tabellen und Spalten verwendet werden sollen.

Datentyp

bool

Standardwert

false

Hinweise

Veeva Vault-Tabellen und-Spalten können Sonderzeichen in Namen verwenden, die in Standarddatenbanken normalerweise nicht zulässig sind. UseSimpleNames macht den Connector mit herkömmlichen Datenbanktools einfacher zu verwenden.

Einstellung UseSimpleNames auf true vereinfacht die Namen der zurückgegebenen Tabellen und Spalten. Es wird ein Benennungsschema erzwungen, sodass nur alphanumerische Zeichen und der Unterstrich für die angezeigten Tabellen- und Spaltennamen gültig sind. Alle nicht alphanumerischen Zeichen werden in einen Unterstrich umgewandelt.