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 crear herramientas y aplicaciones de datos personalizadas en JavaScript, como las siguientes:

  • Aplicaciones de la 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 la incorporación en aplicaciones externas

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

¿Por qué usar el framework de extensiones?

Algunas partes de la creación de aplicaciones web son fáciles y divertidas, mientras que otras son obviamente más lentas y no tan divertidas. El marco de trabajo 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 herramientas y aplicaciones personalizadas creadas con el framework de extensiones desde Looker, lo que permite que Looker controle los siguientes tipos de funciones:

Funciones del framework de extensión

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 dentro del entorno de Looker
  • Componentes de Looker, una biblioteca de componentes de IU de React prediseñados que puedes usar en tus extensiones
  • El SDK de Embed, una biblioteca que puedes usar para incorporar paneles, Looks y Explorar en tu extensión Consulta la extensión de prueba para ver un ejemplo de código. También puedes usar el SDK de Embed para incorporar tu extensión en aplicaciones de terceros. Las cookies deben estar habilitadas en el navegador cuando incorporas Explorar, Looks o paneles en una extensión.
  • La utilidad de create-looker-extension, que crea una extensión básica que incluye todos los archivos y las dependencias necesarios de la extensión, y que puedes usar como punto de partida para desarrollar tu extensión.
  • Nuestro repositorio de ejemplos del framework de extensiones de Looker, que incluye plantillas y extensiones de ejemplo 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 plataformas internas o externas.

    En una extensión de pantalla completa, puedes impedir que un conjunto de usuarios navegue a otras partes de Looker desde tu extensión agregándolos 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 que se ejecuten en un mosaico de los paneles. Las extensiones que admiten ejecutarse como mosaico o visualización se pueden agregar mientras el panel está en modo de edición o guardar en un panel como visualización desde un 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, haz lo siguiente:

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

  • Un proyecto de LookML que cumpla con los siguientes 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 da una etiqueta a la extensión, le indica a Looker dónde encontrar el 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 este se encuentre en la lista de derechos.

    El siguiente es un ejemplo de un archivo de manifiesto del 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.

Primeros pasos para desarrollar con el framework de extensión de Looker

La forma más sencilla de comenzar es generar primero una nueva extensión de inicio a partir de 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 inicio.

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