Gestionar un glosario empresarial

En este documento se describe cómo crear y gestionar un glosario de términos empresariales de Dataplex Universal Catalog en Dataplex Universal Catalog. Usa un glosario empresarial para establecer un vocabulario estandarizado para tus recursos de datos, lo que reduce la ambigüedad y mejora la detección y la gestión de datos en toda tu organización.

Casos prácticos del glosario de empresa de Dataplex Universal Catalog

Si creas un lenguaje común para los datos con el glosario de empresa de Dataplex Universal Catalog, puedes hacer lo siguiente:

  • Definir una jerarquía clara de categorías y términos empresariales.
  • Vincula conceptos mediante sinónimos y muestra las relaciones entre los términos.
  • Busca recursos de datos en función de conceptos empresariales, no solo de nombres técnicos.

El glosario empresarial de Universal Catalog de Dataplex ayuda a optimizar el descubrimiento de datos y a reducir la ambigüedad, lo que se traduce en una mejor gobernanza, análisis más precisos y estadísticas más rápidas.

Elementos de un glosario empresarial

En esta sección se describen los elementos clave que puedes usar para estructurar un glosario de empresa.

Glosario

Un glosario tiene las siguientes propiedades:

  • Introducción. Describe el propósito y el contenido del glosario empresarial. Puedes añadir imágenes, enlaces y tablas. Aunque no se admite el formato HTML, puedes incluir código HTML con formato de código o añadir un enlace a una página HTML. También puedes usar opciones de formato de texto enriquecido, como negrita, cursiva, subrayado, listas con viñetas, párrafos, encabezados y bloques de código. El tamaño máximo admitido es de 120 KB.

  • Descripción. Describe el glosario. El texto de este campo se indexa para las búsquedas. El tamaño máximo admitido es de 1 KB.

  • Región. Especifica la región en la que se encuentra el glosario.

Categoría

Las categorías le permiten organizar y estructurar varias categorías y términos. Las categorías se definen en un glosario empresarial. Puedes anidar categorías hasta tres niveles.

Una categoría tiene las propiedades de un glosario, así como las siguientes:

  • Contactos Especifica la persona responsable de mantener la categoría. Esta propiedad es descriptiva y no afecta a los permisos de la categoría.
  • Padre o madre. Especifica una relación que se usa para establecer el elemento superior de la categoría actual. Puedes anidar hasta tres categorías.

La región de una categoría es la misma que la del glosario que la contiene.

Término

Un término (abreviatura de "término de glosario") describe un concepto que se usa en una rama de actividad concreta de tu empresa. Por ejemplo, el departamento de marketing de una empresa puede crear un término que describa el coste por clic. Los términos se definen en un glosario de empresa, ya sea directamente en el glosario o en cualquier categoría que se encuentre en él.

Un término tiene las propiedades de una categoría, así como las siguientes propiedades:

  • Sinónimos. Especifica los enlaces entre términos que tienen el mismo significado. Consulta los términos sinónimos.
  • Términos relacionados. Especifica los enlaces entre términos que están relacionados conceptualmente entre sí, pero que tienen significados diferentes. Consulta los términos relacionados.
  • Entradas relacionadas Especifica los vínculos entre términos y recursos de datos, o entre términos y columnas de recursos de datos.
  • Contactos Especifica la persona responsable de mantener el término. Los términos no heredan los contactos definidos en las categorías.

La región de un término es la misma que la de la glosario que lo contiene.

Términos sinónimos

Un sinónimo es una relación que indica la equivalencia entre dos términos diferentes. Usa sinónimos cuando dos términos con el mismo significado estén definidos por diferentes equipos en diferentes glosarios. Por ejemplo, puedes crear un sinónimo para vincular los términos "beneficio" y "ganancias".

Un término relacionado es una relación que indica que dos términos están asociados entre sí, pero tienen significados diferentes. Por ejemplo, puede crear un término relacionado para vincular los términos "ingresos" y "beneficios".

Limitaciones

Roles obligatorios

Para obtener los permisos que necesitas para crear y gestionar glosarios, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos (IAM) en tu proyecto:

  • Los administradores de datos pueden obtener acceso completo a glosarios, categorías, términos, sinónimos y términos relacionados, así como definir políticas de gestión de identidades y accesos: Administrador de catálogo de Dataplex (roles/dataplex.catalogAdmin)
  • Los responsables o propietarios de los datos pueden crear, editar o eliminar glosarios, categorías, términos y enlaces entre términos, así como enlaces entre términos y recursos de datos, y buscar: Editor de Dataplex Catalog (roles/dataplex.catalogEditor)
  • Los analistas o consumidores de datos pueden obtener acceso de solo lectura a glosarios, categorías, términos, enlaces entre términos y entre términos y recursos de datos, así como buscar: Visor del catálogo de Dataplex (roles/dataplex.catalogViewer)

Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar acceso a proyectos, carpetas y organizaciones.

Estos roles predefinidos contienen los permisos necesarios para crear y gestionar glosarios. Para ver los permisos exactos que se necesitan, despliega la sección Permisos necesarios:

Permisos obligatorios

Para crear y gestionar glosarios, se necesitan los siguientes permisos:

  • Crea, lee, actualiza y elimina un glosario de empresa, una categoría y términos de tu proyecto:
    • dataplex.glossaries.list
    • dataplex.glossaries.create
    • dataplex.glossaries.get
    • dataplex.glossaries.update
    • dataplex.glossaries.delete
    • dataplex.glossaryCategories.create
    • dataplex.glossaryCategories.list
    • dataplex.glossaryCategories.get
    • dataplex.glossaryCategories.update
    • dataplex.glossaryCategories.delete
    • dataplex.glossaryTerms.create
    • dataplex.glossaryTerms.list
    • dataplex.glossaryTerms.get
    • dataplex.glossaryTerms.update
    • dataplex.glossaryTerms.delete
  • Crear y eliminar enlaces de sinónimos en tu proyecto:
    • dataplex.entryLinks.create en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentre cualquiera de los términos del glosario. El enlace se crea en el grupo de entradas para el que se ha concedido el permiso.
    • dataplex.entryGroups.useSynonymEntryLink en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentre cualquiera de los términos del glosario. El enlace se crea en el grupo de entradas para el que se ha concedido el permiso.
    • dataplex.glossaryTerms.use en los glosarios cuyos términos deban asociarse.
    • dataplex.entryLinks.delete en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentra el enlace.
  • Crea y elimina enlaces entre términos relacionados en tu proyecto:
    • dataplex.entryLinks.create en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentre cualquiera de los términos del glosario. El enlace se crea en el grupo de entradas para el que se ha concedido el permiso.
    • dataplex.entryGroups.useRelatedEntryLink en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentre cualquiera de los términos del glosario. El enlace se crea en el grupo de entradas para el que se ha concedido el permiso.
    • dataplex.entries.link en el grupo de entradas de Dataplex Universal Catalog de los proyectos en los que haya entradas correspondientes a términos del glosario.
    • dataplex.entryLinks.delete en el grupo de entradas de Dataplex Universal Catalog del proyecto en el que se encuentra el enlace.
  • Crea enlaces entre los términos y los recursos de datos o las columnas de tu proyecto:
    • dataplex.entryLinks.create en el grupo de entradas del sistema correspondiente a los recursos de datos o las columnas del proyecto. El enlace se crea en el proyecto para el que se ha concedido el permiso.
    • dataplex.entryGroups.useDefinitionEntryLink en el grupo de entradas del sistema correspondiente a los recursos de datos o las columnas del proyecto. El enlace se crea en el proyecto para el que se ha concedido el permiso.
    • dataplex.entries.link en el grupo de entradas del sistema correspondiente a los recursos de datos o las columnas del proyecto. El enlace se crea en el proyecto para el que se ha concedido el permiso.
    • dataplex.glossaryTerms.use en el glosario cuyo término deba asociarse.
    • dataplex.entryLinks.delete en el grupo de entradas del sistema en el que se encuentra el enlace.

También puedes obtener estos permisos con roles personalizados u otros roles predefinidos.

Para obtener más información, consulta los roles de gestión de identidades y accesos de Dataplex Universal Catalog.

Crear y gestionar glosarios empresariales

En las siguientes secciones se describe cómo crear, ver, editar y eliminar un glosario de empresa.

Crear un glosario empresarial

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Haz clic en Crear glosario empresarial.

  3. En la página Crear glosario empresarial, especifica un nombre y una ubicación para el glosario empresarial. Una vez que hayas creado el glosario, no podrás cambiar la ubicación.

  4. Haz clic en Crear. El glosario se crea en el proyecto actual.

  5. Opcional: Añade una descripción breve en Descripción (hasta 1024 caracteres) o una descripción larga en Resumen (hasta 120 KB).

REST

Cuando creas un glosario, Dataplex Universal Catalog crea una entrada para representarlo.

  1. Crea el glosario.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

    Haz los cambios siguientes:

    • PROJECT_ID: el ID del proyecto en el que quieres crear el glosario
    • LOCATION_ID: el ID de la ubicación en la que quieres crear el glosario
    • GLOSSARY_ID: el ID del glosario
    • DISPLAY_NAME: el nombre visible del glosario
    • DESCRIPTION: descripción del glosario, con un máximo de 1024 caracteres.

  2. Opcional: Añade una descripción general al glosario.

    1. Busca la entrada de tu glosario:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID
\
\&view=ALL

      Sustituye PROJECT_NUMBER por el número del proyecto en el que se ha creado tu glosario.

    2. Añadir una descripción general al glosario:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview \
--data @- << EOF
{
"aspects": {
   "dataplex-types.global.overview": {
      "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/overview",
      "data": {
      "content": "OVERVIEW",
      "links": []
      },
   }
}
}
EOF

      Sustituye OVERVIEW por texto sin formato o HTML para describir la categoría o el término del glosario.

Ver las glosarios disponibles

Consola

  • En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

    En el panel Mis glosarios se muestran todos los glosarios de la organización que tienes permiso para ver, junto con sus descripciones y las marcas de tiempo de la última modificación.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries

Editar un glosario

Puedes editar el nombre y la descripción de un glosario.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Haz clic en el glosario que quieras editar.

  3. Haz clic en Editar junto al nombre, la descripción o el resumen y, a continuación, haz el cambio.

  4. Haz clic en Guardar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Eliminar un glosario

Antes de eliminar un glosario, primero debes eliminar todas las categorías y los términos del glosario.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Haz clic en la glosario que quieras eliminar.

  3. Haz clic en Eliminar y, a continuación, confirma la acción cuando se te pida.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID

Crear y gestionar categorías

En las siguientes secciones se describe cómo crear, ver, actualizar y eliminar categorías.

Crear una categoría en un glosario

Un glosario de empresa puede tener un máximo de 200 categorías.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Seleccione el glosario en el que quiera crear una categoría y, a continuación, haga clic en Crear categoría.

  3. Escribe el nombre de la categoría.

  4. Haz clic en Crear.

  5. Opcional: Añade una descripción breve en Descripción (hasta 1024 caracteres) o una descripción larga en Resumen (hasta 120 KB).

REST

Cuando creas una categoría, Dataplex Universal Catalog crea una entrada para representarla.

  1. Crea la categoría.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "CATEGORY_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
}
EOF

    Haz los cambios siguientes:

    • CATEGORY_ID: el ID de la categoría
    • CATEGORY_DISPLAY_NAME: el nombre visible de la categoría
    • CATEGORY_DESCRIPTION: la descripción de la categoría

  2. Opcional: Añade una descripción general a la categoría.

    1. Busca la entrada de tu categoría:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

    2. Añade una descripción general a tu categoría:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Sustituye OVERVIEW por texto sin formato o HTML para describir la categoría o el término del glosario.

  3. Opcional: Añadir contactos

    1. Busca la entrada de tu categoría:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

    2. Actualiza la entrada de tu categoría con los contactos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Crear una categoría anidada

Un glosario empresarial puede tener un máximo de tres niveles de categorías anidadas, sin incluir el nivel raíz del glosario.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Despliega el glosario en el que quieras crear una categoría.

  3. Seleccione la categoría principal en la que quiera crear otra categoría y haga clic en Crear categoría.

  4. Escribe el nombre de la categoría.

  5. Haz clic en Crear.

  6. Opcional: Añade una descripción breve en Descripción (hasta 1024 caracteres) o una descripción larga en Resumen (hasta 120 KB).

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
  "displayName": "CATEGORY_DISPLAY_NAME",
  "description": "CATEGORY_DESCRIPTION",
  "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

Sustituye PARENT_CATEGORY_ID por el ID de la categoría principal.

Ver las categorías que pertenecen a un glosario

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Para ver las categorías de un glosario, despliégalo.

  3. Para ver las categorías anidadas de una categoría, despliégala.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories

Editar una categoría

Puedes editar el nombre, la descripción y los contactos de una categoría. En el caso de las categorías anidadas, también puedes editar la categoría principal.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Despliega el glosario y haz clic en la categoría que quieras editar.

  3. Haz clic en Editar junto al nombre, la descripción o el resumen y, a continuación, haz el cambio.

  4. Haz clic en Guardar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Eliminar una categoría

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Despliega el glosario y haz clic en la categoría que quieras eliminar.

  3. Haz clic en Eliminar y, a continuación, confirma la acción cuando se te pida.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID

Crear y gestionar términos

En las siguientes secciones se describe cómo crear, ver, acceder, editar y eliminar términos.

Crear un término en un glosario empresarial

Un glosario empresarial puede tener un máximo de 5000 términos.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Para crear un término a nivel de glosario, selecciona el glosario en el que quieras crear un término y, a continuación, haz clic en Crear término.

  3. Escribe un nombre para el término.

  4. Haz clic en Crear.

  5. Opcional: Añade una descripción breve en Descripción (hasta 1024 caracteres) o una descripción larga en Resumen (hasta 120 KB).

  6. Opcional: Para añadir contactos, haga clic en Editar y, a continuación, proporcione una lista de direcciones de correo de los responsables, los propietarios o los propietarios del dominio de datos. A continuación, haz clic en Guardar.

REST

Cuando creas un término, Dataplex Universal Catalog crea una entrada para representarlo.

  1. Crea el término.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
{
"displayName": "TERM_DISPLAY_NAME",
"description": "TERM_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
}
EOF

    Haz los cambios siguientes:

    • TERM_ID: el ID del término que estás creando
    • TERM_DISPLAY_NAME: el nombre visible del término que estás creando
    • TERM_DESCRIPTION: la descripción del término que estás creando

  2. Opcional: Añade una descripción general al término.

    1. Busca la entrada de tu término:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Añade una descripción general del término:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Sustituye OVERVIEW por texto sin formato o HTML para describir la categoría o el término del glosario.

  3. Opcional: añade contactos.

    1. Busca la entrada de tu término:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Para actualizar la entrada de tu mandato con los contactos, sigue estos pasos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Crear un término en una categoría

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Para crear un término en una categoría, selecciona la categoría en la que quieras crear un término y, a continuación, haz clic en Añadir término.

  3. Escribe un nombre para el término.

  4. Haz clic en Crear.

  5. Opcional: Añade una descripción breve en Descripción (hasta 1024 caracteres) o una descripción larga en Resumen (hasta 120 KB).

  6. Opcional: Para añadir contactos, haga clic en Editar y, a continuación, proporcione una lista de direcciones de correo de los responsables, los propietarios o los propietarios del dominio de datos. A continuación, haz clic en Guardar.

REST

Cuando creas un término, Dataplex Universal Catalog crea una entrada para representarlo.

  1. Crear un término.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
{
"displayName": "TERM_DISPLAY_NAME",
"description": "TERM_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

    Haz los cambios siguientes:

    • TERM_ID: el ID del término que estás creando
    • TERM_DISPLAY_NAME: el nombre visible del término que estás creando
    • TERM_DESCRIPTION: la descripción del término que estás creando

  2. Opcional: Añade una descripción general al término.

    1. Busca la entrada de tu término:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Añade una descripción general del término:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Sustituye OVERVIEW por texto sin formato o HTML para describir la categoría o el término del glosario.

  3. Opcional: añade contactos.

    1. Busca la entrada de tu término:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Para actualizar la entrada de tu mandato con los contactos, sigue estos pasos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Añadir un aspecto a un término

Puedes añadir aspectos a los términos para proporcionar contexto o metadatos adicionales.

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Despliega el glosario y haz clic en el término al que quieras añadir un aspecto.

  3. En la sección Aspectos, haz clic en Añadir.

  4. Busca el aspecto, proporciona detalles sobre él y, a continuación, haz clic en Guardar.

REST

Los términos del glosario son entradas. Para adjuntar un aspecto, parchea el recurso de entrada. El grupo de entradas de los glosarios es @dataplex.

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
{
 "aspects": {
   "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
     "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
     "data": {
       "sensitivity": "HIGH",
       "data_owner": "achalg@google.com"
     }
   }
 }
}
EOF

Haz los cambios siguientes:

  • PROJECT_NUMBER: el número del proyecto que contiene el término del glosario.
  • LOCATION_ID: la ubicación del término del glosario.
  • GLOSSARY_ID: ID de la glosario que contiene el término.
  • TERM_ID: ID del término al que se va a asociar el aspecto.
  • ASPECT_PROJECT_ID: ID del proyecto que contiene el tipo de aspecto.
  • ASPECT_LOCATION_ID: la ubicación del tipo de aspecto.
  • ASPECT_TYPE_ID: ID del tipo de aspecto.

Ver los términos en un glosario o una categoría

Consola

  1. En la Google Cloud consola, ve a la página Glosarios de Dataplex Universal Catalog.

    Ir a Glosarios

  2. Para ver los términos de un glosario, despliega el glosario. Para ver los términos de una categoría de este glosario, despliégala. Para ver los términos de una categoría anidada, amplíala.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/