Unternehmensglossare in eine Google-Tabelle exportieren

In diesem Dokument wird beschrieben, wie Sie mit dem Exportdienstprogramm für das Unternehmensglossar Glossare, Kategorien und Begriffe aus Knowledge Catalog (ehemals Dataplex Universal Catalog) in ein Google-Tabellenblatt exportieren, um sie in großen Mengen zu verwalten und Berichte zu erstellen.

Mit dem glossary_export-Tool werden Metadaten aus dem Unternehmensglossar Ihres Knowledge Catalog abgerufen und in ein Google-Tabellenblatt mit einem strukturierten Schema eingefügt, einschließlich Beschreibungen, Datenverantwortlichen und Labels.

Hinweis

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

Dienstkonto einrichten

Damit Sie das Exporttool ausführen können, müssen Sie ein Dienstkonto mit den erforderlichen Berechtigungen für den Zugriff auf die Google Sheets API einrichten und die Identität Ihrer 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

    Damit Sie das Exportdienstprogramm-Script lokal ausführen können, 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 das Google-Tabellenblatt, das 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.

Erforderliche Rollen

Damit das Dienstkonto die erforderlichen Berechtigungen zum Exportieren von Glossaren in ein Google-Tabellenblatt hat, bitten Sie Ihren Administrator, dem Dienstkonto die folgenden IAM-Rollen zuzuweisen:

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

Wenn Sie Glossare exportieren möchten, aktivieren Sie die folgenden APIs in Ihrem Projekt:

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. 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/export

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 Export einrichten

Erstellen Sie eine leere Google-Tabelle oder verwenden Sie eine vorhandene. Das Exportskript schreibt in das erste Tabellenblatt. Achten Sie darauf, dass Sie dem Dienstkonto Editor-Zugriff auf die Google-Tabelle gewährt haben.

Glossar in die Google-Tabelle exportieren

Führen Sie das Script glossary-export.py aus: Während der Ausführung werden Sie vom Dienstprogramm aufgefordert, die Ziel-Google-Tabelle und den spezifischen Glossarnamen anzugeben, den Sie exportieren möchten:

python3 glossary-export.py

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

Exportierte Glossardaten prüfen

Das Exportskript füllt das Google-Tabellenblatt mit den folgenden Spalten aus. Exportierte Daten prüfen

Feld Beschreibung
id Eine eindeutige Kennung für den Begriff oder die Kategorie im Glossar.
parent Die ID der übergeordneten Kategorie.
display_name Der Anzeigename des Begriffs oder der Kategorie.
description Eine kurze Beschreibung des Begriffs oder der Kategorie.
overview Eine RTF-Beschreibung des Begriffs oder der Kategorie (unterstützt HTML-Tags).
type Der Zeilentyp: TERM oder CATEGORY.
contact1_email E-Mail-Adresse des primären Datenverantwortlichen für den Begriff oder die Kategorie.
contact1_name Name des primären Datenverantwortlichen für den Begriff oder die Kategorie.
contact2_email E-Mail-Adresse des sekundären Datenverantwortlichen für den Begriff oder die Kategorie.
contact2_name Name des sekundären Datenverantwortlichen für den Begriff oder die Kategorie.
label1_key Schlüssel für das erste zugewiesene Label.
label1_value Wert für das erste zugewiesene Label.
label2_key Schlüssel für das zweite zugewiesene Label.
label2_value Wert für das zweite zugewiesene Label.

Nächste Schritte