Unternehmensglossare aus einer Google-Tabelle importieren

In diesem Dokument wird beschrieben, wie Sie mit dem Glossar-Importprogramm Glossare, Kategorien und Begriffe aus einem Google-Tabellenblatt in Knowledge Catalog (früher Dataplex Universal Catalog) importieren.

Das glossary_import-Tool parst und validiert Daten aus einer Google-Tabelle, konvertiert sie in ein Format, das mit der CreateMetadataJob API des Knowledge Catalog kompatibel ist, und lädt sie in einen Cloud Storage-Bucket hoch, bevor der Importjob ausgelöst wird.

Hinweis

Bevor Sie Glossare importieren, müssen Sie die folgenden Voraussetzungen erfüllen.

Dienstkonto einrichten

Wenn Sie das Importprogramm mit einem Google-Tabellenblatt ausführen möchten, müssen Sie ein Dienstkonto mit den erforderlichen Berechtigungen für den Zugriff auf die Google Sheets API einrichten und Ihre Nutzeranmeldedaten übernehmen:

  1. Identifizieren oder erstellen Sie ein Dienstkonto.

    Wählen Sie ein vorhandenes Dienstkonto aus oder erstellen Sie ein neues in dem Projekt, in dem Sie das Importprogramm ausführen. Weitere Informationen finden Sie unter Dienstkonten erstellen. Notieren Sie sich die E-Mail-Adresse des Dienstkontos (z. B. SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

  2. Identitätsübernahme des Dienstkontos konfigurieren

    Wenn Sie das Import-Utility-Script lokal ausführen möchten, muss Ihr Nutzerkonto die Berechtigung haben, die Identität des Dienstkontos zu übernehmen. Weisen Sie Ihrem Nutzerkonto die Rolle Ersteller von Dienstkonto-Tokens (roles/iam.serviceAccountTokenCreator) für das Dienstkonto zu.

    Weitere Informationen finden Sie unter Zugriff auf Dienstkonten verwalten.

  3. Gewähren Sie dem Dienstkonto Editor Zugriff auf das Google-Tabellenblatt.

    Öffnen Sie die Google-Tabelle, die Sie für den Import verwenden möchten, klicken Sie auf Freigeben und fügen Sie die E-Mail-Adresse des Dienstkontos als Editor hinzu. Mit dieser Berechtigung kann das Dienstkonto Daten aus Ihrem Tabellenblatt lesen oder Daten in Ihr Tabellenblatt schreiben.

Cloud Storage-Bucket erstellen

Erstellen Sie einen Cloud Storage-Bucket, der als Stagingbereich für Importdateien dient.

Erforderliche Rollen

Damit das Dienstkonto die erforderlichen Berechtigungen zum Importieren von Glossaren aus einem Google-Tabellenblatt hat, bitten Sie Ihren Administrator, dem Dienstkonto die folgenden IAM-Rollen zu gewähren:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Ihr Administrator kann dem Dienstkonto möglicherweise auch die erforderlichen Berechtigungen über benutzerdefinierte Rollen oder andere vordefinierte Rollen erteilen.

APIs aktivieren

Aktivieren Sie die folgenden APIs in Ihrem Projekt, um Glossare zu importieren:

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin), die die Berechtigung serviceusage.services.enable enthält. Weitere Informationen zum Zuweisen von Rollen

APIs aktivieren

Git-Repository einrichten

Klonen Sie das Repository dataplex-labs:

git clone https://github.com/GoogleCloudPlatform/dataplex-labs.git
cd dataplex-labs/dataplex-quickstart-labs/00-resources/scripts/python/business-glossary-import/dataplex-glossary/import

Abhängigkeiten installieren

Installieren Sie die erforderlichen Python-Abhängigkeiten:

pip3 install -r requirements.txt

Wenn Sie Probleme bei der Installation des Pakets haben, richten Sie eine neue Python-Entwicklungsumgebung ein.

Identitätsübernahme des Dienstkontos authentifizieren und konfigurieren

Initialisieren Sie die Google Cloud CLI und authentifizieren Sie sich mit Standardanmeldedaten für Anwendungen (ADC) und der Identitätsübernahme des Dienstkontos:

# Set your service account email address
SA_EMAIL="SERVICE_ACCOUNT_EMAIL"

# Authenticate ADC using service account impersonation and required scopes
gcloud auth application-default login \
  --impersonate-service-account="${SA_EMAIL}" \
  --scopes="https://www.googleapis.com/auth/spreadsheets"

Ersetzen Sie SERVICE_ACCOUNT_EMAIL durch die E-Mail-ID des Dienstkontos. Beispiel:

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Google-Tabelle für den Import erstellen und strukturieren

Damit ein Bulk-Import erfolgreich ausgeführt werden kann, müssen Sie eine neue Google-Tabelle mit einem genauen Spaltenschema erstellen, damit das Importprogramm Ihre Metadatenfelder erfolgreich parsen und validieren kann. Achten Sie darauf, dass Sie dem Dienstkonto Editor Zugriff auf das Google-Tabellenblatt gewährt haben.

Die erste Zeile des Tabellenblatts muss die folgenden Schemaüberschriften enthalten, die genau so geschrieben werden müssen (Groß-/Kleinschreibung beachten):

Feld Erforderlich oder optional Beschreibung
id Erforderlich Eine eindeutige Kennung für den Begriff oder die Kategorie im Glossar.
parent Optional Die ID der übergeordneten Kategorie. Wenn leer, ist das Element ein untergeordnetes Element auf Stammebene des Glossars. Die referenzierte übergeordnete ID muss im Tabellenblatt vorhanden sein und zu einer Kategorie gehören.
display_name Erforderlich Der Anzeigename des Begriffs oder der Kategorie.
description Optional Eine kurze Beschreibung des Begriffs oder der Kategorie.
overview Optional Eine RTF-Beschreibung des Begriffs oder der Kategorie (unterstützt HTML-Tags).
type Erforderlich Der Zeilentyp. Gültige Werte sind TERM und CATEGORY.
contact1_email Optional E-Mail-Adresse des primären Datenverwalters für den Begriff oder die Kategorie.
contact1_name Optional Name des primären Datenverantwortlichen für den Begriff oder die Kategorie.
contact2_email Optional E-Mail-Adresse des sekundären Datenverantwortlichen für den Begriff oder die Kategorie.
contact2_name Optional Name des sekundären Datenverantwortlichen für den Begriff oder die Kategorie.
label1_key Optional Schlüssel für das erste zugewiesene Label.
label1_value Optional Wert für das erste zugewiesene Label.
label2_key Optional Schlüssel für das zweite zugewiesene Label.
label2_value Optional Wert für das zweite zugewiesene Label.

Glossar aus der Google-Tabelle importieren

Nachdem Sie Ihre Umgebung eingerichtet und Ihre Google-Tabelle vorbereitet haben, führen Sie das glossary_import.py-Skript aus:

python3 bg_import/dataplex-glossary/glossary_import.py

Das Importtool gibt das Ergebnis der Ausführung der CreateMetadataJob API direkt in Ihrem Terminal aus. Prüfen Sie, ob der Jobstatus „Erfolgreich“ lautet.

Sie können die Ausführungslogs im Verzeichnis logs/ in Ihrem lokalen Ausführungspfad aufrufen. Mithilfe dieser Logs können Sie den Übertragungsvorgang prüfen und übersprungene Einträge oder Formatierungswarnungen erkennen.

Nächste Schritte