סביבת התוספים של Looker

‫סביבת התוספים של Looker היא מסגרת פיתוח שמפחיתה באופן משמעותי את המאמץ והמורכבות של בניית אפליקציות וכלים מותאמים אישית של נתונים ב-JavaScript, כמו:

  • אפליקציות פלטפורמה פנימיות לחברה שלכם
  • פלטפורמות חיצוניות ללקוחות, כמו פורטלים ללקוחות של אפליקציות של ניתוח נתונים מוטמעים שנבנו עם נתונים ב-Looker
  • כלים פנימיים מטורגטים
  • אפליקציות להטמעה באפליקציות חיצוניות

דוגמאות עדכניות לתוספים של Looker שזמינים ב-Looker Marketplace כוללות את מילון הנתונים של Looker ואת התרשים של LookML.

למה כדאי להשתמש במסגרת התוספים?

חלק מהשלבים בפיתוח אפליקציות לאינטרנט הם קלים ומהנים, בעוד שאחרים גוזלים יותר זמן ופחות מהנים. מסגרת התוספים עוזרת לכם לייעל הרבה מהמשימות האלה שלא כל כך כיף לעשות.

מסגרת התוספים מטפלת בחלק מההיבטים המייגעים יותר של בניית אפליקציית אינטרנט, כדי שתוכלו להתחיל לפתח אותה באופן מיידי. אפשר לגשת לאפליקציות ולכלים מותאמים אישית שנוצרו באמצעות סביבת התוספים מתוך Looker, וכך לאפשר ל-Looker לטפל בפונקציות מהסוגים הבאים, כמו:

תכונות של סביבת התוספים

סביבת התוספים של Looker כוללת את התכונות הבאות:

  • ‫Looker Extension SDK, שמספק פונקציות לגישה ל-Looker public API ולביצוע אינטראקציה בסביבת Looker.
  • רכיבי Looker, ספרייה של רכיבי React UI מוכנים מראש שאפשר להשתמש בהם בתוספים.
  • ‫Embed SDK, ספרייה שבה אפשר להשתמש כדי להטמיע לוחות בקרה, תצוגות וניתוחים בתוסף. אפשר לראות קוד לדוגמה בתוסף kitchen sink. אפשר גם להשתמש ב-Embed SDK כדי להטמיע את התוסף באפליקציות של צד שלישי. צריך להפעיל קובצי Cookie בדפדפן כשמטמיעים תכונות של Explore,‏ Looks או לוחות בקרה בתוסף.
  • כלי השירות create-looker-extension, שיוצר תוסף בסיסי שכולל את כל קובצי התוסף והתלויות הדרושים, ואפשר להשתמש בו כנקודת התחלה לבנייה.
  • מאגר הדוגמאות למסגרת התוספים של Looker, שכולל תבניות ותוספים לדוגמה שיעזרו לכם להתחיל במהירות.
  • היכולת לגשת לנקודות קצה של API של צד שלישי ולהוסיף נתונים של צד שלישי לתוסף.

  • האפשרות ליצור תוספים למסך מלא ב-Looker. אפשר להשתמש בתוספים במסך מלא עבור אפליקציות פלטפורמה פנימיות או חיצוניות.

    בתוסף במסך מלא, אתם יכולים למנוע מקבוצת משתמשים מסוימת לעבור לחלקים אחרים ב-Looker מהתוסף שלכם. לשם כך, אתם צריכים להוסיף את המשתמשים לקבוצת משתמשים מסוג Extensions Only (תוספים בלבד). אפשר גם להסיר את סרגל הניווט של Looker על ידי החלפת /extensions ב-/spartan בכתובת ה-URL של התוסף.

  • האפשרות להגדיר מפתח גישה לתוסף, כך שהמשתמשים יצטרכו להזין מפתח כדי להריץ את התוסף. האפשרות הזו שימושית אם רוצים לגבות תשלום על התוסף, אבל כדאי להשתמש בהרשאות רגילות של Looker כדי להגביל את הגישה לתוסף רק למשתמשים שצריכים אותה.

  • החל מ-Looker 24.0, אפשר לפתח תוספים שיפעלו במשבצת בלוחות בקרה. אפשר להוסיף תוספים בזמן שמרכז הבקרה במצב עריכה או לשמור אותם במרכז הבקרה כפריט ויזואלי מתוך Explore. אפשר גם להגדיר תוספים כמשבצות בלוחות בקרה של LookML.

דרישות לגבי סביבת התוספים

כדי לפתח באמצעות סביבת התוספים של Looker:

כדי להפעיל תוסף ב-Looker, כל תוסף, ללא קשר לפונקציה שלו, חייב לכלול את הרכיבים הבאים ב-Looker:

  • פרויקט LookML שעומד בדרישות הבאות:

  • בקובץ המודל LookML צריך להיות פרמטר connection שמפנה אל חיבור מסד נתונים תקין במופע שלכם.

  • קובץ המניפסט של הפרויקט צריך לכלול פרמטר application. הפרמטר application נותן לתוסף תווית, מציין ל-Looker איפה נמצא ה-JavaScript של התוסף ומספק רשימה של הרשאות לתוסף. הזכויות מגדירות את משאבי Looker שהתוסף יכול לגשת אליהם. התוסף לא יוכל לגשת למשאב Looker אלא אם המשאב הזה מופיע בהרשאות.

    זו דוגמה לקובץ מניפסט של פרויקט עם הפרמטר 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: []
    }
  }

    פרטים נוספים מופיעים בדף התיעוד של הפרמטר application.

תחילת העבודה עם פיתוח באמצעות סביבת התוספים של Looker

הדרך הכי קלה להתחיל היא ליצור תוסף חדש מתוך תבנית, ואז להתאים אותו אישית ולהוסיף לו פונקציונליות. כך אפשר לוודא שכל ההגדרות והאריזות נכונות, וזה יכול להיות מסובך לעשות את זה ידנית. במאמר יצירת תוסף Looker מוסבר איך ליצור פרויקט Looker חדש לתוסף וליצור תוסף התחלתי.

לקבלת תבניות מותאמות אישית או מתקדמות יותר, תוכלו לעיין במאגר הדוגמאות של סביבת התוספים של Looker. אפשר לשכפל כל תוסף במאגר הזה ולהשתמש בו כנקודת התחלה לפרויקט.

אחרי שיוצרים תוסף בסיסי ומוודאים שהכול פועל, אפשר להתחיל להוסיף פונקציות נוספות והתאמות אישיות:

  • בדף התיעוד עם דוגמאות קוד של React ו-JavaScript למסגרת התוספים מופיעה רשימה של תרחישי שימוש נפוצים עם קוד לדוגמה.

  • כדי להשתמש בספריית הרכיבים שלנו לפיתוח מהיר של ממשק משתמש ופריסה, אפשר לעיין באתר Looker UI Components.

  • ‫Looker Extension Kitchensink Template הוא תוסף שמספק דוגמאות למגוון רחב של פונקציות של תוספים. אפשר להשתמש בתבנית הזו כאנציקלופדיה או כמדריך עזר, אבל לא כנקודת התחלה או כתבנית בפועל. מומלץ להשתמש בכלי ליצירת תוספים או לשכפל אחת מהדוגמאות הבסיסיות יותר כדי להתחיל.

  • יש גם דוגמאות לתוספים שאפשר להשתמש בהם כמשבצות בלוח הבקרה. התוסף להמחשת משבצות מראה איך ליצור המחשה בהתאמה אישית באמצעות מסגרת התוסף. התוסף Tile SDK מציג את שיטות ה-API הזמינות שספציפיות לתוספי משבצות.

הסרה של תוספים

כדי להסיר לחלוטין אפליקציה של מסגרת הרחבות מרשימת האפליקציות בממשק המשתמש של Looker, צריך להסיר את ההגדרה של ההרחבה מפרויקט LookML שמגדיר אותה. מחיקת פרויקט שלא מוגדר בו התוסף לא תגרום להסרת התוסף מממשק המשתמש.

כדי להסיר תוסף, פועלים לפי השלבים הבאים:

  1. מזהים את פרויקט LookML שמגדיר את התוסף.

  2. בתור אדמין ב-Looker, עוברים אל Develop (פיתוח) > Projects (פרויקטים) ולוחצים על שם הפרויקט שזוהה כדי לפתוח אותו.

  3. מסירים את התוסף מהפרויקט:

    • כדי להסיר את התוסף אבל לשמור את פרויקט LookML: פותחים את קובץ המניפסט של הפרויקט (manifest.lkml), מאתרים את הבלוק application שמתאים למזהה התוסף (לדוגמה, application: my_extension_id { ... }), מוחקים את כל הבלוק application, שומרים את השינויים, מבצעים קומיט של השינויים ומפרסמים אותם בסביבת הייצור.
    • כדי להסיר את התוסף על ידי מחיקת הפרויקט כולו: אם כבר לא צריך את פרויקט LookML, אפשר למחוק אותו באופן סופי. הוראות למחיקת פרויקט מופיעות בדף התיעוד גישה לפרטי הפרויקט ועריכתם.