framework de extensiones de Looker

El framework de extensiones de Looker es un framework de desarrollo que reduce significativamente el esfuerzo y la complejidad de la compilación de herramientas y aplicaciones de datos personalizadas de JavaScript, como las siguientes:

  • Aplicaciones de plataforma interna para tu empresa
  • Plataformas externas para tus clientes, como portales de clientes para aplicaciones de estadísticas incorporadas creadas con datos en Looker
  • Herramientas internas segmentadas
  • Aplicaciones para incorporar en aplicaciones externas

Entre los ejemplos actuales de extensiones de Looker disponibles en Looker Marketplace, se incluyen el Diccionario de datos y el Diagrama de LookML de Looker.

¿Por qué usar el framework de extensiones?

Algunas partes de la compilación de aplicaciones web son fáciles y divertidas, mientras que otras, obviamente, requieren más tiempo y no son tan divertidas. El framework de extensiones te ayuda a optimizar muchas de estas tareas no tan divertidas.

El framework de extensiones se encarga de algunos de los aspectos más tediosos de la compilación de una aplicación web para que puedas enfocarte en comenzar el desarrollo de inmediato. Se puede acceder a las aplicaciones y herramientas personalizadas creadas con el framework de extensiones desde Looker, lo que le permite controlar los siguientes tipos de funciones, como las siguientes:

Funciones del framework de extensiones

El framework de extensiones de Looker incluye las siguientes funciones:

  • El SDK de extensiones de Looker, que proporciona funciones para el acceso a la API pública de Looker y para interactuar en el entorno de Looker.
  • Componentes de Looker: Una biblioteca de componentes de IU de React precompilados que puedes usar en tus extensiones.
  • El SDK de incorporación, una biblioteca que puedes usar para incorporar paneles, looks y exploraciones en tu extensión. Consulta la extensión de cocina para ver un ejemplo de código. También puedes usar el SDK de incorporación para incorporar tu extensión en aplicaciones de terceros. Las cookies deben estar habilitadas en el navegador cuando incorporas Exploraciones, Looks o paneles en una extensión.
  • La utilidad create-looker-extension, que crea una extensión básica que incluye todos los archivos y dependencias de extensión necesarios, y que puedes usar como punto de partida para compilar.
  • Nuestro repositorio de ejemplos de frameworks de extensiones de Looker, que incluye plantillas y extensiones de muestra para ayudarte a comenzar rápidamente.
  • La capacidad de acceder a extremos de API de terceros y agregar datos de terceros a tu extensión

  • La capacidad de crear extensiones de pantalla completa en Looker. Las extensiones de pantalla completa se pueden usar para aplicaciones de plataforma internas o externas.

    En una extensión de pantalla completa, puedes evitar que un conjunto de usuarios navegue a otras partes de Looker desde tu extensión. Para ello, agrega usuarios a un grupo de usuarios de solo extensiones. También puedes quitar la barra de navegación de Looker reemplazando /extensions por /spartan en la URL de la extensión.

  • La capacidad de configurar una clave de acceso para tu extensión de modo que los usuarios deban ingresar una clave para ejecutarla. Esto es útil si quieres cobrar por tu extensión, pero debes usar los permisos estándar de Looker para restringir el acceso a quienes nunca deberían poder acceder a una extensión.

  • A partir de Looker 24.0, las extensiones se pueden desarrollar para ejecutarse en una tarjeta de los paneles. Las extensiones que admiten ejecutarse como tarjetas o visualizaciones se pueden agregar mientras el panel está en modo de edición o guardar en un panel como una visualización desde Explorar. Las extensiones también se pueden configurar como tarjetas en los paneles de LookML.

Requisitos del framework de extensiones

Para desarrollar con el framework de extensiones de Looker, sigue estos pasos:

Para ejecutarse en Looker, cada extensión, independientemente de su función, debe incluir los siguientes elementos:

  • Un proyecto de LookML que cumpla con estos requisitos:

  • El archivo del modelo de LookML necesita un parámetro connection que apunte a una conexión de base de datos válida en tu instancia.

  • El archivo de manifiesto del proyecto requiere un parámetro application. El parámetro application le asigna una etiqueta a la extensión, le indica a Looker dónde encontrar el código JavaScript de la extensión y proporciona una lista de derechos para la extensión. Los derechos definen los recursos de Looker a los que puede acceder la extensión. La extensión no podrá acceder a un recurso de Looker, a menos que ese recurso aparezca en los derechos.

    El siguiente es un ejemplo de un archivo de manifiesto de proyecto con un parámetro application:

      project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    mount_points: {
      standalone: no
    }
    entitlements: {
      local_storage: no
      navigation: no
      new_window: no
      new_window_external_urls: []
      use_form_submit: yes
      use_embeds: no
      use_downloads: no
      core_api_methods: []
      external_api_urls: []
      oauth2_urls: []
      scoped_user_attributes: []
      global_user_attributes: []
    }
  }

    Para obtener más información, consulta la página de documentación del parámetro application.

Cómo comenzar a desarrollar con el framework de extensión de Looker

La forma más fácil de comenzar es generar una nueva extensión de partida desde una plantilla y, luego, personalizarla y agregarle funcionalidad. Esto garantiza que toda la configuración y el empaquetado sean correctos, lo que puede ser difícil de hacer de forma manual. Consulta la página de documentación Cómo compilar una extensión de Looker para obtener instrucciones sobre cómo crear un nuevo proyecto de Looker para tu extensión y generar una extensión de partida.

Para obtener plantillas más personalizadas o avanzadas, puedes explorar el repositorio de ejemplos de Framework de extensiones de Looker. Cualquier extensión de ese repositorio se puede clonar y reutilizar como punto de partida para tu proyecto.

Una vez que hayas creado una extensión simple y verificado que todo funciona, puedes comenzar a agregar funciones y personalizaciones adicionales:

  • Puedes ver una lista de casos de uso comunes con código de ejemplo en la página de documentación Ejemplos de código del framework de extensiones de Looker.

  • Consulta el sitio Looker UI Components para usar nuestra biblioteca de componentes y desarrollar rápidamente la IU y el diseño.

  • La plantilla Kitchensink de la extensión de Looker es una extensión que proporciona ejemplos de una gran variedad de funciones de extensión. Puedes usar esta plantilla como una enciclopedia o una guía de referencia, pero no como punto de partida ni como plantilla real. Para comenzar, te recomendamos que uses nuestro generador de extensiones o que crees una copia de uno de los ejemplos más simples.

  • También hay ejemplos de extensiones que se pueden usar como tarjetas de panel. En la extensión de visualización de tarjetas, se muestra cómo crear una visualización personalizada con el framework de extensiones. La extensión del SDK de tarjetas muestra los métodos de API disponibles que son específicos de las extensiones de tarjetas.