Esportare i glossari aziendali in un foglio Google

L'utilità di esportazione del glossario aziendale consente di estrarre glossari, categorie e termini da Knowledge Catalog (in precedenza Dataplex Universal Catalog) in un foglio Google. In seguito, potrai gestire i metadati collettivamente e generare report.

Prima di iniziare

Prima di esportare i glossari, completa i seguenti prerequisiti.

Configurare il service account

Per eseguire l'utilità di esportazione, devi configurare un account di servizio con le autorizzazioni necessarie per accedere all'API Google Sheets e simulare l'identità delle tue credenziali utente:

  1. Identifica o crea un account di servizio.

    Seleziona un account di servizio esistente o creane uno nuovo nel progetto in cui esegui l'utilità di importazione. Per ulteriori informazioni, consulta Crea service account. Prendi nota dell'indirizzo email del account di servizio (ad esempio, SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

  2. Configura la simulazione dell'identità dei account di servizio.

    Per eseguire lo script dell'utilità di esportazione in locale, il tuo account utente deve disporre dell'autorizzazione per simulare l'identità del account di servizio. Concedi al tuo account utente il ruolo Creatore token account di servizio (roles/iam.serviceAccountTokenCreator) sul service account.

    Per saperne di più, consulta Gestisci l'accesso ai service account.

  3. Concedi al account di servizio Editor l'accesso al foglio Google.

    Apri il foglio Google che vuoi utilizzare per la procedura di importazione, fai clic su Condividi e aggiungi l'indirizzo email dell'account di servizio come Editor. Questa autorizzazione consente al account di servizio di leggere o scrivere dati nel foglio.

Ruoli obbligatori

Per assicurarti che il account di servizio disponga delle autorizzazioni necessarie per esportare i glossari in un foglio Google, chiedi all'amministratore di concedere i seguenti ruoli IAM al account di servizio:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

L'amministratore potrebbe anche assegnare al account di servizio le autorizzazioni richieste tramite ruoli personalizzati o altri ruoli predefiniti.

Abilita API

Per esportare i glossari, abilita le seguenti API nel tuo progetto:

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Configura il repository Git

Clona il 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

Installa le dipendenze

Installa le dipendenze Python richieste:

pip3 install -r requirements.txt

Se riscontri problemi con l'installazione del pacchetto, configura un nuovo ambiente di sviluppo Python.

Autentica e configura la simulazione dell'identità dei account di servizio

Inizializza Google Cloud CLI ed esegui l'autenticazione utilizzando le credenziali predefinite dell'applicazione (ADC) con la simulazione dell'identità dei account di servizio:

# 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"

Sostituisci SERVICE_ACCOUNT_EMAIL con l'ID email del account di servizio. Ad esempio:

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Configura il foglio Google di destinazione per l'esportazione

Crea un foglio Google vuoto o utilizzane uno esistente. Lo script di esportazione scrive nel primo foglio. Assicurati di aver concesso al account di servizio Editor l'accesso al foglio Google.

Esporta il glossario nel foglio Google

Esegui lo script glossary-export.py. Durante l'esecuzione, l'utilità ti chiede di specificare il foglio Google di destinazione e il nome del glossario specifico che vuoi esportare:

python3 glossary-export.py

Puoi esaminare i log di esecuzione nella directory logs/ nel percorso di esecuzione locale. Questi log ti aiutano a controllare il processo di trasferimento e a identificare voci saltate o avvisi di formattazione.

Verifica i dati del glossario esportati

Lo script di esportazione recupera i metadati dal glossario aziendale di Knowledge Catalog e compila il foglio Google con uno schema strutturato, che include descrizioni, data stewardship ed etichette. Verifica i dati esportati nelle seguenti colonne:

Campo Descrizione
id Un identificatore univoco per il termine o la categoria all'interno del glossario.
parent L'ID della categoria principale.
display_name Il nome visualizzato del termine o della categoria.
description Una breve descrizione del termine o della categoria.
overview Una descrizione in formato RTF del termine o della categoria (supporta i tag HTML).
type Il tipo di riga: TERM o CATEGORY.
contact1_email Indirizzo email del data steward principale per il termine o la categoria.
contact1_name Nome del data steward principale per il termine o la categoria.
contact2_email Indirizzo email del data steward secondario per il termine o la categoria.
contact2_name Nome del data steward secondario per il termine o la categoria.
label1_key Chiave per la prima etichetta assegnata.
label1_value Valore della prima etichetta assegnata.
label2_key Chiave per la seconda etichetta assegnata.
label2_value Valore della seconda etichetta assegnata.

Passaggi successivi