Introducción al marco de trabajo de la extensión de Looker

El marco de trabajo de extensiones de Looker es un marco de trabajo de desarrollo que reduce significativamente el esfuerzo y la complejidad de compilar aplicaciones y herramientas de datos personalizadas de JavaScript, como las siguientes:

  • Aplicaciones de plataformas internas para su empresa
  • Plataformas externas para tus clientes, como portales de clientes para aplicaciones de estadísticas incorporadas compiladas con datos en Looker
  • Herramientas internas orientadas
  • Aplicaciones para incorporaciones en aplicaciones externas

Los ejemplos actuales de extensiones de Looker disponibles en Looker Marketplace incluyen el diccionario de datos de Looker y el diagrama de LookML.

¿Por qué usar el marco de trabajo de extensiones?

Algunas partes de la creación de aplicaciones web son fáciles y divertidas, mientras que otras son, por supuesto, más lentas y no exactamente divertidas. El marco de trabajo de extensiones te ayuda a optimizar muchas de estas tareas no tan divertidas.

El marco de trabajo de extensiones se encarga de algunos de los aspectos más tediosos de la compilación de aplicaciones web, de modo que puedas concentrarte en iniciar 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 a Looker manejar los siguientes tipos de funciones, como las siguientes:

Características del framework de extensiones

El framework de extensiones de Looker incluye las siguientes funciones:

  • El SDK de extensión de Looker, que proporciona funciones para el acceso público a la API de Looker y para interactuar dentro del entorno de Looker
  • Componentes de Looker, una biblioteca de componentes de IU precompilados de React que puedes usar en tus extensiones.
  • El SDK de incorporación, una biblioteca que puedes usar para incorporar paneles, apariencias y exploraciones en tu extensión. Consulta la extensión del receptor de la cocina para ver el código de ejemplo. 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 incorpores la función Explorar, Apariencia o paneles en una extensión.
  • La utilidad create-looker-extension, que crea una extensión básica que incluye todos los archivos y las dependencias necesarios, y que puedes usar como punto de partida para compilar.
  • Nuestro repositorio de ejemplos del marco de trabajo de extensiones de Looker, que incluye plantillas y extensiones de muestra para ayudarlo a comenzar rápidamente.
  • La capacidad de acceder a extremos de API de terceros y agregar datos de terceros a su extensión.

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

    En una extensión de pantalla completa, puede evitar que un conjunto de usuarios navegue hacia otras partes de Looker desde su extensión. Para ello, debe agregar usuarios a un grupo de usuarios Solo extensiones. También puedes quitar la barra de navegación de Looker si reemplazas /extensions por /spartan en la URL de extensión.

  • La capacidad de configurar una clave de acceso para tu extensión, de modo que los usuarios deban ingresar una clave para ejecutar la extensión. Esto resulta útil si deseas cobrar por una extensión, pero debes usar permisos estándares de Looker para habilitar el acceso a quienes nunca podrán acceder a una extensión.

Requisitos del framework de extensiones

Sigue estos pasos para desarrollar con el framework de extensión de Looker:

Para ejecutarse en Looker, todas las extensiones, independientemente de su función, deben incluir los siguientes elementos en Looker:

  project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    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.

Comienza a desarrollar con el marco de trabajo de extensiones de Looker

La manera más fácil de comenzar es generar primero una nueva extensión inicial a partir de una plantilla y, luego, personalizarla y agregarle funcionalidad. Esto garantiza que la configuración y el empaquetado sean correctos, lo que a veces es difícil de hacer. Consulta la página de documentación Introducción a la compilación de una extensión de Looker para obtener instrucciones sobre cómo crear un proyecto de Looker nuevo para tu extensión y generar una extensión inicial.

Para obtener plantillas más personalizadas o avanzadas, puede explorar el repositorio de ejemplos del marco de trabajo 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 hayas verificado que todo funciona correctamente, puedes agregar funciones y personalizaciones adicionales:

  • Puede 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 marco de trabajo de extensión de Looker.

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

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