Personalización de bloques de Marketplace de Looker

Looker BlocksTM son modelos de datos prediseñados para patrones de análisis y fuentes de datos comunes. En esta página, se describe cómo los desarrolladores pueden personalizar los bloques de Looker que se instalan desde Looker Marketplace. Looker Marketplace es una ubicación central para encontrar, implementar y administrar muchos tipos de contenido de Looker, como aplicaciones, visualizaciones y complementos.

Para obtener más información sobre todos los bloqueos de Looker disponibles, incluidos los que no están disponibles en Looker y los métodos de personalización de bloques alternativos, consulta la página de documentación de Bloqueos de Looker.

Requisitos para instalar y administrar bloques de Looker de Looker Marketplace

Antes de que puedas instalar y usar algunos bloques de Looker Marketplace, tu administrador de Looker debe habilitar estas funciones:

  • Si instalas tu bloqueo mediante Looker Marketplace, tu administrador de Looker debe habilitar la función Marketplace.
  • Si el bloque específico contiene un parámetro local_dependency, tu administrador de Looker también debe habilitar la función Importación de proyectos locales Labs. Estos bloques contienen un parámetro local_dependency:

    • Analítica de marketing digital
    • Estadísticas de ventas
    • Estadísticas web

Los usuarios deben tener permisos develop, manage_models y deploy para instalar y administrar paquetes de Marketplace.

Consulta la página de documentación de Looker Marketplace para obtener información sobre cómo instalar y administrar bloques de Looker desde Looker Marketplace.

Cómo acceder a LookML para un bloque de Marketplace

Los bloques que se basan en proyectos que utilizan mejoras se instalan desde Marketplace como un único proyecto de CONFIG editable que importa de forma remota el proyecto de CORE, que contiene todo el código de LookML y la parametrización constante.

Una vez que se instala un bloque desde Marketplace, puede acceder a su proyecto desde el menú Desarrollar haciendo clic en el nombre del proyecto en la lista de proyectos. El nombre de un bloque de mejoras de Marketplace suele estar precedido por marketplace_ seguido del ID de la ficha.

Si bien no puedes modificar directamente el proyecto de CORE de solo lectura de un bloque, puedes usar el LookML que se define en los archivos de CORE de solo lectura como referencia cuando personalizas los archivos CONFIG del bloque. Puedes ver los archivos CORE del bloque si navegas a los archivos del proyecto del bloque en el IDE y expandes el directorio imported_projects en el navegador de archivos IDE.

Bloquear la estructura del archivo

Cuando instalas un bloque creado para mejoras, estos archivos se crean automáticamente como parte del CONFIG del proyecto de bloque:

Nombre del archivo Acceso Función
<model_name>.model.lkml Solo lectura para todos los usuarios Archivo de modelo virtual que está vinculado a la instalación del bloque; controla la importación de cualquier modelo del proyecto CORE del bloque. Cuando se desinstala o actualiza un bloque, se borran los archivos asociados del modelo, lo que evita conflictos de modelos entre varias instalaciones de bloques.
manifest.lkml Editable para usuarios con permisos develop Describe el proyecto y sus dependencias externas. Contiene el ID de la ficha de Marketplace para la instalación en bloque y facilita la importación remota de los archivos del proyecto de CORE del bloque a través de la palabra clave marketplace.
marketplace_lock.lkml Solo lectura para todos los usuarios Contiene una referencia a la palabra clave marketplace_ref del archivo de manifiesto que controla la importación remota del proyecto CORE. Proporciona la información específica del modelo, la versión y la ficha que está asociada con la instalación. Contiene información sobre las constantes que se configuran durante la instalación (y que se pueden actualizar con la opción Administrar en la IU de Marketplace).
refinements.lkml Editable para usuarios con permisos develop Permite a los desarrolladores definir mejor las vistas y exploraciones definidas en los archivos del proyecto CORE importados.

Cómo personalizar un bloque de Marketplace

Habilite el Modo de desarrollo para personalizar los archivos editables del bloque.

Si tienes permisos develop, puedes personalizar el LookML en el archivo refinements.lkml del proyecto CONFIG del bloque. Puedes definir mejor las vistas y las exploraciones que ya están definidas en el proyecto de CORE del bloque o, incluso, agregar nuevas vistas y exploraciones que aún no están definidas en ese proyecto. Todo lo que sea posible con los refinamientos de LookML en otros proyectos de LookML se puede realizar en el archivo refinements.lkml del bloque. La combinación del perfeccionamiento y el LookML original se comporta como si fuera el LookML original del objeto.

También puedes realizar cambios en el archivo manifest.lkml del proyecto CONFIG a fin de especificar las dependencias que se deben capturar para ese bloque.

No está limitado a modificar estos archivos para lograr las personalizaciones que desees. También puedes crear archivos nuevos en el proyecto CONFIG. Solo debes asegurarte de include los archivos nuevos en el archivo refinements.lkml.

Cómo personalizar el archivo de mejoras

Si tienes permisos develop, puedes agregar LookML al proyecto CONFIG para combinar datos adicionales o cambiar el modelo analítico principal del bloque. Puedes crear vistas nuevas y unirlas a exploraciones existentes, definir campos nuevos o redefinir campos existentes, o aplicar etiquetas según sea necesario a fin de crear un modelo para el análisis que quieras proporcionar. Si creaste archivos nuevos en el proyecto CONFIG, debes include en el archivo de mejoras.

Por ejemplo, supongamos que instalaste un bloque y su archivo refinements.lkml contiene lo siguiente:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

En el comando anterior, listing_id es el valor del parámetro listing del archivo manifest.lkml.

Puedes usar mejoras para agregar una dimensión nueva a una vista llamada flights:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

view: +flights {
  dimension: air_carrier {
    type: string
    sql: ${TABLE}.air_carrier ;;
  }
}

También puedes aplicar una etiqueta a una exploración llamada aircraft de modo que aparezca en la IU como Aircraft Simplifica:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

explore: +aircraft {
  label: "Aircraft Simplified"
}

El archivo refinements.lkml se incluye automáticamente en el archivo del modelo "virtual" del bloque, que básicamente importa los modelos del proyecto CORE.

Consulta la documentación de refinamientos de LookML para obtener más información sobre este tema avanzado.

Cómo personalizar el archivo de manifiesto editable

En los bloques que usan mejoras, los proyectos de CORE y CONFIG tienen archivos de manifiesto. Sin embargo, solo el archivo de manifiesto del proyecto CONFIG se puede editar.

Puedes editar el archivo CONFIG manifest.lkml para agregar parámetros de proyecto a los que ya aparecen en el archivo de manifiesto del proyecto de CORE. Por ejemplo, puedes agregar un local_dependency para unir tu bloque a otro bloque en la misma instancia de Looker.

Antes de que puedas usar o compilar un bloque que contenga un parámetro local_dependency, un administrador de Looker debe habilitar la función Importación de proyectos locales en Labs.

Actualiza valores de constantes

Las constantes del bloque se definen en el archivo de manifiesto del proyecto CORE importado. Si se permite, se puede anular el valor de una constante en la IU de Marketplace durante la configuración o mediante la actualización del bloque. Para actualizar un bloqueo, los usuarios deben tener permisos develop, manage_models y deploy.

Para anular el valor de una constante mediante la actualización de un bloque:

  1. En Looker Marketplace, navega al bloque que deseas actualizar.
  2. Haz clic en el botón Administrar.
  3. Junto al nombre del bloque que deseas actualizar, haz clic en el ícono de ajustes. Se abrirá la ventana de configuración de bloques.
  4. Realiza cambios en los valores constantes según sea necesario.
  5. Haga clic en Actualizar para cerrar la ventana de configuración del bloque y actualice el bloque con sus cambios.

Los cambios se reflejarán en el archivo marketplace_lock.lkml de solo lectura del proyecto instalado.

Preservación de las personalizaciones de un bloque de Marketplace que use extensiones

Algunos de los bloques disponibles en Looker Marketplace están compuestos por proyectos que usan extendidas de LookML. Looker convertirá todos los bloques de Marketplace en instancias de Looker 21.8 o una versión posterior a una estructura de proyecto que use refinamientos de LookML. Además, se quitará la compatibilidad con los bloqueos basados en extends.

Looker recomienda que instale la versión basada en mejoras de cualquier bloque de Marketplace que tenga en su instancia a medida que estén disponibles, reemplazando los bloques creados con extensiones. Si bien este proceso de reemplazo es simple: puedes instalar el nuevo bloque (de perfeccionamiento) de la ficha de bloqueo de Looker Marketplace y desinstalar el bloque original (se extiende) en la página Manage de Looker Marketplace, pero no conservará ninguna de las personalizaciones que se hayan realizado en el bloque que se creó con extensiones. Además, Looker no transferirá el contenido ni las funciones de Looker basadas en ese contenido (paneles, exploraciones, entregas de contenido programadas o alertas) del bloque original al nuevo bloque.

En esta sección, se describe cómo preservar cualquier personalización en un bloque compilado con proyectos que usan extensiones que, de otro modo, serían difíciles o difíciles de replicar desde cero.

Para conservar las personalizaciones de tu bloque, un usuario con la capacidad de instalar y administrar paquetes desde Marketplace debe hacer lo siguiente:

  1. Actualiza el proyecto CONFIG del bloque original a fin de prepararte para la migración
  2. Instala la versión nueva del bloque desde Looker Marketplace.
  3. Transfiera las personalizaciones al nuevo bloque de Marketplace
  4. Cómo recrear el contenido de Looker basado en el bloque original
  5. Desinstala la versión del bloque que se creó con las extensiones

Actualiza un bloque personalizado a fin de prepararte para la migración

En esta sección, se describe cómo actualizar los archivos de proyecto clave en un bloque que se creó con extensiones para que puedas copiar las personalizaciones del bloque en una nueva versión basada en mejoras del bloque. Un bloque que se basa en un proyecto que usa extensiones se instala desde Marketplace como un proyecto de CORE de solo lectura y un proyecto editable de CONFIG.

  1. Navega al proyecto CONFIG del bloque desde la sección Develop de una de las siguientes maneras:

    • Haga clic en la opción Proyectos y, luego, en el nombre del proyecto.
    • Haz clic en el nombre del proyecto CONFIG del bloque en la lista de proyectos.

    Los nombres de proyectos de CONFIG suelen terminar en _config, mientras que el nombre del proyecto de CORE suele no tener un sufijo.

  2. Abre el archivo del modelo del proyecto, que puede ser similar al siguiente:


    explore: ga_sessions_config {
      extends: [ga_sessions_core]
      extension: required
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: future_input_config {
      extends: [future_input_core]
      extension: required
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. En Development Mode, haz lo siguiente:

    1. Borra las líneas extends y extension completas.
    2. Borra _config de los nombres explore.
    3. Antepón + a los nombres explore.

    El ejemplo del archivo de modelo anterior se vería de la siguiente manera:


    explore: +ga_sessions {
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: +future_input {
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. Copia y conserva el contenido de este archivo para un paso futuro.

Cómo instalar el nuevo bloque de Marketplace

Un bloque que se basa en un proyecto que usa mejoras se instala desde Marketplace como un único proyecto de LookML editable que importa de manera remota el proyecto que contiene todo LookML y parametrización constante.

  1. Selecciona el ícono de compra en la barra de menú de Looker para navegar a Looker Marketplace.
  2. Haga clic en la ficha del nuevo bloque de Marketplace basado en mejoras. Este bloque tiene el mismo nombre que el bloque existente que se creó con extensiones.
  3. Haz clic en Instalar para instalar el nuevo bloque. Una vez que el bloque esté instalado, verás dos fichas idénticas en la página Administrar de Looker Marketplace.

Transfiriendo las personalizaciones al nuevo bloque de Marketplace

En esta sección, se describe cómo transferir las actualizaciones que realizaste al bloque original (se extiende) al nuevo bloque (perfeccionamientos).

  1. En la sección Desarrollo, abre el proyecto del bloque nuevo de una de las siguientes maneras:

    • Haga clic en la opción Proyectos y, luego, en el nombre del proyecto.
    • Haz clic en el nombre del proyecto del bloque en la lista de proyectos.

    El nombre de un bloque de mejoras de Marketplace suele estar precedido por marketplace_ seguido del ID de la ficha.

  2. En el archivo refinements.lkml, pega el contenido actualizado del archivo de modelo del bloque original (se extiende). Asegúrate de conservar todas las sentencias include que ya se encuentran en el archivo de mejoras.

Recrea contenido de Looker basado en el bloque original

El último paso para adoptar la versión basada en mejoras de un bloque de Marketplace es desinstalar la versión original basada en extensiones del bloque. Algunos bloques basados en extensiones contienen paneles prediseñados de LookML y exploraciones. Si los usuarios crearon alertas o entregas programadas basadas en paneles de LookML definidos en el bloque original (se extiende), esas alertas o programaciones se inhabilitarán o fallarán, respectivamente, una vez que ese bloqueo se desinstale de Looker Marketplace.

Debe volver a crear estas alertas o entregas programadas en los paneles de LookML del nuevo bloque (de perfeccionamientos). Los administradores y usuarios de Looker que tengan los permisos adecuados para programas y alertas pueden usar las páginas Alertas y programas de la sección Administrador a fin de buscar los nombres de los paneles del bloque (extendidos) y, luego, crear alertas nuevas o entregas programadas según sea necesario en los paneles correspondientes del bloque (de perfeccionamiento).

También debes modificar cualquier otro contenido de Looker que haga referencia al panel Explorar (se extiende) del panel original o a los paneles de LookML para apuntar al nuevo bloque (de perfeccionamiento) según sea necesario.

Desinstala el bloque original

Para desinstalar la versión del bloque que se compiló, sigue estos pasos:

  1. Selecciona el ícono de compra en la barra de menú de Looker para navegar a Looker Marketplace.

  2. En Looker Marketplace, selecciona Administrar en el panel de navegación izquierdo para abrir la página Administrar.

  3. En la página Administrar, haz clic en el ícono de papelera para desinstalar el bloque original (se extiende). Puedes diferenciar los resultados de la lista de bloqueos para ampliar de la lista de bloqueos de mejoras mediante la observación de los números de versión. El bloque extender será una versión principal detrás del bloque de mejoras. Por ejemplo, el bloque de extensiones puede ser la versión 1.0.4, y el bloque de mejoras puede ser la versión 2.0.0.

Una vez que se desinstale el bloque, la ficha de bloque original (extendida) desaparecerá de la barra de navegación izquierda en la instancia de Looker, sus exploraciones desaparecerán de la sección Explorar, sus paneles de LookML desaparecerán de la carpeta Paneles de LookML y se inhabilitarán o fallarán, respectivamente, las alertas o las entregas programadas.

Soluciona problemas de bloqueos

Si un bloque de Marketplace muestra errores, es posible que su esquema no coincida con la estructura del bloque.

Es posible que también desees verificar que las constantes que se proporcionaron durante la instalación del bloque, que representan la conexión, la base de datos o el esquema del bloque, se hayan definido correctamente. Para hacerlo, puedes hacer lo siguiente:

  1. Selecciona el ícono de compra en la barra de menú de Looker para navegar a Looker Marketplace.

  2. En Looker Marketplace, selecciona Administrar en el panel de navegación izquierdo para abrir la página Administrar.

  3. En la página Administrar, haz clic en el ícono de ajustes del bloque para ver sus parámetros de configuración.

  4. En la ventana Actualizar configuraciones, confirme que el bloque esté configurado correctamente. Haz clic en Actualizar después de realizar los cambios para guardar las actualizaciones y cerrar la ventana de configuración de bloques.