Einrichten des Openflow Connector for Veeva Vault

Unter diesem Thema werden die Schritte zur Einrichtung des Openflow Connector for Veeva Vault beschrieben.

Voraussetzungen

  1. Lesen Sie About the Openflow Connector for Veeva Vault.

  2. Richten Sie Ihre Laufzeitumgebung ein.

  3. Stellen Sie bei der Verwendung von Openflow - Snowflake Deployments sicher, dass Sie Konfigurieren der erforderlichen Domänen gelesen haben und Zugriff auf die erforderlichen Domänen für den Konnektor gewährt haben.

  4. Sie haben Zugriff auf die Rolle des Openflow-Admins oder eine ähnliche Rolle, die Sie zur Verwaltung von Openflow verwenden.

  5. Wenn Sie einen Snowflake-Dienstbenutzenden zum Verwalten des Konnektors erstellen, haben Sie eine Schlüsselpaar-Authentifizierung erstellt. Weitere Informationen finden Sie unter Schlüsselpaar-Authentifizierung.

Erforderliche Endpunkte

Der folgende Endpunkt ist erforderlich, damit der Konnektor funktioniert:

  • <your_vault_hostname>:443 (z. B. myvault.veevavault.com:443)

Wenn Sie Openflow - BYOC Deployments verwenden, konfigurieren Sie den ausgehenden Cloud-Netzwerkverkehr so, dass TLS-Zugriff auf Port 443 für diesen Endpunkt zugelassen wird. Wenn Sie Openflow - Snowflake Deployments verwenden, müssen Sie eine Netzwerkregel und eine Integration für den externen Zugriff (EAI) erstellen. Weitere Informationen erhalten Sie unter Erstellen einer Netzwerkregel (nur Openflow Snowflake-Bereitstellungen).

Einrichten von Veeva Vault

Der Konnektor verwendet die Direct Data-API zum Abrufen von Daten. Bevor Sie den Konnektor verwenden können, muss Ihr Vault-Administrator die folgenden Aufgaben erledigen.

Aktivieren von Direct Data

Direct Data muss in Ihrem Vault aktiviert sein. Dies ist ein Feature auf Vault-Ebene, das es externen Systemen ermöglicht, Datenexporte über die Direct Data-API abzurufen.

Um zu überprüfen, ob Direct Data aktiviert ist, kann Ihr Vault-Administrator Admin`|ra|:extui:`Settings`|ra|:extui:`General Settings`|ra|:extui:`Direct Data in der Veeva Vault-UI überprüfen.

Weitere Informationen dazu finden Sie in der Direct Data-API-Dokumentation.

Erstellen eines Servicekontos

Erstellen Sie ein dediziertes Veeva Vault-Benutzerkonto für den Konnektor. Weitere Informationen zum Konfigurieren dieses Kontos finden Sie in der Dokumentation zu Direct Data-API-Berechtigungen.

Notieren Sie sich den Benutzernamen und das Kennwort für dieses Servicekonto. Sie benötigen diese Werte für die Konfiguration des Konnektors.

Bemerkung

Snowflake empfiehlt, ein dediziertes Servicekonto anstelle eines persönlichen Benutzerkontos. Dadurch wird sichergestellt, dass der Konnektor weiterhin funktioniert, wenn ein persönliches Konto deaktiviert oder sein Kennwort geändert wird.

Einrichten Ihres Snowflake-Kontos

Führen Sie als Openflow-Administrator die folgenden Aufgaben aus, um Ihr Snowflake-Konto einzurichten:

Erstellen eines Snowflake-Dienstbenutzers (nur OpenflowBYOC)

Bemerkung

Dieser Schritt ist nur erforderlich, wenn Sie den Konnektor in Openflow - BYOC Deployments bereitstellen. Für Openflow - Snowflake Deployments wird er nicht benötigt.

  1. Erstellen eines Dienstbenutzers:

    USE ROLE USERADMIN;
    CREATE USER <openflow_service_user>
      TYPE=SERVICE
      COMMENT='Service user for the Veeva Vault connector';
    
  2. Speichern Sie den privaten Schlüssel für diesen Benutzenden in einer Datei, um sie für die Konfiguration des Konnektors bereitzustellen. Weitere Informationen finden Sie unter Schlüsselpaar-Authentifizierung.

    ALTER USER <openflow_service_user> SET RSA_PUBLIC_KEY = '<pubkey>';
    

Erstellen von Datenbank, Schema und Warehouse

  1. Erstellen der Zieldatenbank:

    USE ROLE ACCOUNTADMIN;
    CREATE DATABASE IF NOT EXISTS <veeva_database>;
    
  2. Erstellen des Zielschemas:

    CREATE SCHEMA IF NOT EXISTS <veeva_database>.<veeva_schema>;
    
  3. Erstellen Sie eine Rolle für den Konnektor, und erteilen Sie die erforderlichen Berechtigungen:

    CREATE ROLE IF NOT EXISTS <veeva_connector_role>;
    
    GRANT USAGE ON DATABASE <veeva_database> TO ROLE <veeva_connector_role>;
    GRANT USAGE ON SCHEMA <veeva_database>.<veeva_schema> TO ROLE <veeva_connector_role>;
    GRANT CREATE TABLE ON SCHEMA <veeva_database>.<veeva_schema> TO ROLE <veeva_connector_role>;
    
  4. Erstellen Sie ein Warehouse (oder nutzen Sie ein bestehendes), und erteilen Sie Berechtigungen für die Nutzung:

    CREATE WAREHOUSE IF NOT EXISTS <veeva_warehouse>
      WITH
        WAREHOUSE_SIZE = 'SMALL'
        AUTO_SUSPEND = 300
        AUTO_RESUME = TRUE;
    
    GRANT USAGE, OPERATE ON WAREHOUSE <veeva_warehouse> TO ROLE <veeva_connector_role>;
    
  5. Bei Verwendung von Openflow - BYOC Deployments, weisen Sie dem Dienstbenutzer die Rolle zu:

    GRANT ROLE <veeva_connector_role> TO USER <openflow_service_user>;
    ALTER USER <openflow_service_user> SET DEFAULT_ROLE = <veeva_connector_role>;
    

Erstellen einer Netzwerkregel (nur Openflow Snowflake-Bereitstellungen)

Vorsicht

Wenn Ihre Laufzeit in Openflow - BYOC Deployments ausgeführt wird, müssen Sie keine Integration für den externen Zugriff (EAI) erstellen. Konfigurieren Sie stattdessen den Netzwerkausgang Ihrer Cloud so, dass Sie TLS 443-Zugriff auf Ihren Veeva Vault-Hostnamen zulassen.

Um dem Konnektor zu ermöglichen, die Veeva Vault-API aus einer von Snowflake gehosteten Laufzeitumgebung aufzurufen, erstellen Sie eine Netzwerkregel und eine Integration für den externen Zugriff (EAI) und gewähren Sie der Snowflake-Rolle anschließend Nutzungsberechtigungen für die EAI.

  1. Erstellen einer Netzwerkregel:

    USE ROLE ACCOUNTADMIN;
    
    CREATE OR REPLACE NETWORK RULE openflow_<runtime_name>_veeva_network_rule
      TYPE = HOST_PORT
      MODE = EGRESS
      VALUE_LIST = ('<your_vault_hostname>:443');
    
  2. Erstellen einer Integration für den externen Zugriff:

    CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION openflow_<runtime_name>_veeva_eai
      ALLOWED_NETWORK_RULES = (openflow_<runtime_name>_veeva_network_rule)
      ENABLED = TRUE;
    
  3. Zuweisen der USAGE-Berechtigung zur Ihrer Snowflake-Rolle für die Integration:

    GRANT USAGE ON INTEGRATION openflow_<runtime_name>_veeva_eai
      TO ROLE openflow_runtime_role_<runtime_name>;
    

Konnektor installieren

Um den Konnektor zu installieren, gehen Sie als Data Engineer wie folgt vor:

  1. Navigieren Sie zur Übersichtsseite von Openflow. Wählen Sie im Abschnitt Featured connectors die Option View more connectors aus.

  2. Suchen Sie auf der Seite Openflow-Konnektoren den Konnektor und wählen Sie Add to runtime.

  3. Wählen Sie im Dialogfeld Select runtime Ihre Laufzeitumgebung aus der Dropdown-Liste Available runtimes aus, und klicken Sie auf Add.

    Bemerkung

    Bevor Sie den Konnektor installieren, stellen Sie sicher, dass Sie in Snowflake eine Datenbank und ein Schema für den Konnektor erstellt haben, in dem die aufgenommenen Daten gespeichert werden.

  4. Authentifizieren Sie sich bei der Bereitstellung mit den Anmeldedaten Ihres Snowflake-Kontos und wählen Sie Allow, wenn Sie dazu aufgefordert werden, damit die Laufzeitanwendung auf Ihr Snowflake-Konto zugreifen kann. Die Installation des Konnektors nimmt einige Minuten in Anspruch.

  5. Authentifizieren Sie sich bei der Laufzeit mit den Anmeldeinformationen Ihres Snowflake-Kontos.

Das Openflow-Canvas wird mit der hinzugefügten Prozessgruppe des Konnektors angezeigt.

Konnektor konfigurieren

Um den Konnektor zu konfigurieren, führen Sie die folgenden Schritte aus:

  1. Klicken Sie mit der rechten Maustaste auf die Prozessgruppe des Konnektors, und wählen Sie Parameters aus.

  2. Füllen Sie die erforderlichen Parameterwerte aus, wie in den Abschnitten unten beschrieben.

Veeva Vault-Parameter

Parameter

Beschreibung

Veeva Vault-Basis-URL

Basis-URL für die Veeva Vault-Umgebung. Muss eine gültige URL einschließlich des Protokolls sein.

Beispiel: https://myvault.veevavault.com

Veeva Vault-Benutzername

Benutzername des Servicekontos für die Veeva Vault-Authentifizierung.

Veeva Vault-Kennwort

Kennwort des Servicekontos für die Veeva Vault-Authentifizierung. Sicher als sensibler Parameter gespeichert.

Veeva Vault-Datenaufnahmemodus

Legt fest, wie Direct Data-Dateien genutzt werden. Zulässige Werte:

  • SNAPSHOT_AND_INCREMENTAL (Standard): Laden Sie zuerst das neueste vollständige Archiv, und fahren Sie dann mit den inkrementellen Archiven fort.

  • SNAPSHOT: Nur für das neueste vollständige Archiv abgerufen.

  • INCREMENTAL: Abfragen nur für inkrementelle Archive.

Inkrementelle Startzeit von Veeva Vault

Optionaler Startzeitstempel für das inkrementelle Abrufen. Nur anwendbar, wenn der Aufnahmemodus INCREMENTAL lautet. Wenn nicht eingestellt, beginnt das inkrementelle Abrufen mit der aktuellen Uhrzeit. Erwartetes Format: yyyy-MM-dd'T'HH:mmZ.

Beispiel: 2025-01-15T08:30Z

Veeva Vault enthält Überwachungsprotokolle

Ob auch Direct Data-Überwachungsprotokolldateien aufgenommen werden sollen.

Standard: true

Snowflake-Zielparameter

Parameter

Beschreibung

Snowflake Authentication Strategy

Authentifizierungsstrategie für den Konnektor zur Verbindung mit Snowflake.

  • SNOWFLAKE_MANAGED (Standard): Verwendet das von Snowflake verwaltete Token, das der angegebenen Snowflake-Laufzeitrolle zugeordnet ist. Dies ist die empfohlene Strategie für Openflow - Snowflake Deployments und Openflow - BYOC Deployments.

  • KEY_PAIR: Verwendet eine vom Benutzer bereitgestelltes RSA-Schlüsselpaar. Nur auf Openflow - BYOC Deployments verfügbar, für kontoübergreifende Szenarien, in denen der Konnektor in ein Snowflake-Konto schreibt, das sich von dem Konto unterscheidet, das die Openflow-Laufzeitumgebung hostet.

Snowflake Account

Snowflake-Kontobezeichner, formatiert als <organization>-<account>. Erforderlich, wenn die Authentifizierungsstrategie KEY_PAIR ist.

Beispiel: MYORG-MYACCOUNT

Snowflake-Benutzername

Der Snowflake–Benutzer für die Authentifizierung. Erforderlich, wenn die Authentifizierungsstrategie KEY_PAIR ist.

Snowflake Private Key

PEM-kodierter Inhalt des privaten Schlüssels für die Authentifizierung des Snowflake-Schlüsselpaares. Erforderlich, wenn die Authentifizierungsstrategie KEY_PAIR ist. Dieser Wert wird sicher als sensibler Parameter gespeichert.

Sie können die private Schlüsseldatei auch hochladen, indem Sie das Kontrollkästchen Reference asset aktivieren, die Datei als Asset hochladen und das Asset als Wert für den Parameter auswählen.

Snowflake Private Key Password

Kennwort zum Entschlüsseln des privaten Snowflake-Schlüssels, wenn der Schlüssel verschlüsselt ist. Nur anwendbar, wenn die Authentifizierungsstrategie KEY_PAIR lautet.

Snowflake Role

Die Snowflake-Rolle, die für die Tabellenerstellung, die Datenaufnahme und die Zugriffsprüfung verwendet wird. Bei Verwendung von SNOWFLAKE_MANAGED ist dies die Snowflake-Rolle für Openflow-Laufzeitumgebungen. Bei Verwendung von``KEY_PAIR`` ist dies die Rolle, die dem angegebenen Snowflake-Benutzer zugewiesen ist.

Snowflake-Datenbank

Name der Zieldatenbank in Snowflake. Die Datenbank muss vor dem Starten des Konnektors vorhanden sein.

Snowflake Schema

Name des Zielschemas in Snowflake. Das Schema muss vor dem Starten des Konnektors vorhanden sein.

Snowflake Warehouse

Das Snowflake-Warehouse, das für Tabellenverwaltungsoperationen wie CREATE TABLE und MERGE verwendet wird.

Snowflake-Tabellenpräfix

Optionales Präfix, das auf alle Zieltabellennamen in Snowflake angewendet wird. Verwenden Sie dies, um Tabellen mit einem Namespace zu versehen, wenn mehrere Konnektoren in dasselbe Schema schreiben.

Snowflake-Löschstrategie

Vorgehensweise zum Anwenden von Veeva-Löschextrakten in Snowflake.

  • Hard Delete (Standard): Permanentes Entfernen von Zeilen aus der Tabelle.

  • Soft Delete: Setzen Sie __SNOWFLAKE_DELETED auf TRUE und __SNOWFLAKE_DELETED_AT auf den aktuellen Zeitstempel. Die Spalten werden automatisch hinzugefügt, wenn sie nicht vorhanden sind.

Parameter der Schemaentwicklung

Parameter

Beschreibung

Strategie zur Entfernung von Spalten

Definiert die Strategie, wenn eine Spalte in der Zieltabelle auf der Grundlage des letzten empfangenen Schemas entfernt werden soll.

  • Drop Column (Standard): Löschen Sie die Spalte aus der Snowflake-Tabelle.

  • Rename Column: Benennen Sie die Spalte in der Snowflake-Tabelle um, indem Sie das im Parameter Removed Column Name Suffix definierte Suffix anhängen.

  • Ignore Column: Lassen Sie die Spalte in der Snowflake-Tabelle unverändert.

Entferntes Spaltennamensuffix

Suffix, das an den Spaltennamen angehängt wird, wenn:ui:Column Removal Strategy auf Rename Column festgelegt ist.

Standard: __deleted

Führen Sie den Ablauf aus

  1. Klicken Sie mit der rechten Maustaste auf einen leeren Bereich im Arbeitsbereich, und wählen Sie Enable all Controller Services aus.

  2. Klicken Sie mit der rechten Maustaste auf die Prozessgruppe des Konnektors, und wählen Sie Start aus.

Der Konnektor beginnt, Veeva Vault für Direct Data-Dateien abzufragen und Daten in Snowflake zu laden.

Nächste Schritte

  • Informationen zu Aufgaben, die Sie nach der Installation des Konnektors ausführen können, finden Sie unter Konnektor verwenden.

  • Informationen zur Überwachung des Ablaufs finden Sie unter Ablauf überwachen.