Zuora

המחבר של Zuora מאפשר לכם להתחבר למופע Zuora ולגשת לנתוני Zuora כמו אל מסד נתונים רגיל.

גרסאות נתמכות

המחבר הזה משתמש בגרסה v1 של Zuora API כדי לאפשר גישה דו-כיוונית ל-Zuora.

לפני שמתחילים

לפני שמשתמשים במחבר Zuora, צריך לבצע את המשימות הבאות:

  • בפרויקט שלכם ב-Google Cloud:
    • מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
    • נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM‏ roles/connectors.admin.
    • מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

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

    • מפעילים את השירותים הבאים:
      • ‫secretmanager.googleapis.com (Secret Manager API)
      • ‫connectors.googleapis.com (Connectors API)

      במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.

    אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.

הגדרת המחבר

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

  1. במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.

    כניסה לדף Connections

  2. לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
  3. בקטע מיקום, בוחרים את המיקום של החיבור.
    1. אזור: בוחרים מיקום מהרשימה הנפתחת.

      אזורים נתמכים למחברים:

      רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.

    2. לוחצים על הבא.
  4. בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
    1. מחבר: בוחרים באפשרות Zuora מהרשימה הנפתחת של המחברים הזמינים.
    2. גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
    3. בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.

      השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:

      • שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
      • האותיות צריכות להיות קטנות.
      • שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
      • שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
    4. אופציונלי: מזינים תיאור למופע החיבור.
    5. אופציונלי: מפעילים את Cloud Logging ואז בוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-Error.
    6. חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
    7. אופציונלי: מגדירים את ההגדרות של צומת החיבור:

      • מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
      • מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.

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

    8. ‫Tenant: מגדירים את הערך הזה לדייר שלכם ב-Zuora. כברירת מחדל, אנחנו משתמשים בדייר USProduction.
    9. כתובת URL: חובה רק אם יש לכם סביבת עותק ייצור בארה"ב. אם הנכס הזה מסופק, לערך של נכס הדייר אין השפעה בתהליך האימות.
    10. ‫ZuoraService: מציין באיזה שירות או סכימה של ביצוע להשתמש
    11. שימוש בהחלפה לדף בצד הלקוח: האם ספק CData ADO.NET ל-SAP Cloud for Customer צריך להשתמש בהחלפה לדף בצד הלקוח.
    12. Use Custom Service (שימוש בשירות מותאם אישית): מציין אם צריך להשתמש בשירות OData מותאם אישית של SAP Cloud for Customer.
    13. תצוגות שהוגדרו על ידי המשתמש: נתיב לקובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית.
    14. אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
    15. לוחצים על הבא.
  5. בקטע אימות, מזינים את פרטי האימות.
    1. בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.

      החיבור ל-Zuora תומך בסוגי האימות הבאים:

      • פרטי כניסה של לקוח ב-OAuth 2.0

      2. כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.

    2. לוחצים על הבא.
  6. בדיקה: בודקים את פרטי החיבור והאימות.
  7. לוחצים על יצירה.

הגדרת אימות

כדי להפעיל אימות באמצעות פרטי כניסה של לקוח OAuth 2.0:

  1. יוצרים פרטי כניסה של לקוח ב-Zuora ומקבלים את מזהה הלקוח ואת הסוד של הלקוח.
  2. מציינים את פרטי הכניסה ב- Google Cloud.

יצירת פרטי כניסה של לקוח ב-Zuora

  1. בפורטל OneID, לוחצים על סמל הדמות ואז על הגדרות.
  2. לוחצים על Manage OAuth 2.0 Clients (ניהול לקוחות OAuth 2.0).
  3. בדף Manage OAuth 2.0 Clients (ניהול לקוחות OAuth 2.0), לוחצים על New (חדש).
  4. בחלון New OAuth 2.0 Client (לקוח חדש של OAuth 2.0), מציינים את השדות הבאים:
    • שם: מזינים שם ללקוח.
    • Type: בוחרים באפשרות Client Credentials מהרשימה.
  5. לוחצים על Save. אחרי שהלקוח נוצר בהצלחה, מופיע חלון עם מזהה הלקוח והסוד של הלקוח.

    שומרים את מזהה הלקוח ואת הסוד של הלקוח לשימוש מאוחר יותר. למידע נוסף, ראו ניהול לקוחות OAuth 2.0 .

מציינים את פרטי הכניסה ב Google Cloud

כשיוצרים את החיבור ב-Integration Connectors , צריך לציין את הפרטים הבאים:

בקטע אימות, מזינים את הפרטים הבאים:

  • Client ID: מזהה הלקוח של האפליקציה שיצרתם.
  • סוד לקוח: סוד ב-Secret Manager שמכיל את סוד הלקוח של האפליקציה המקושרת שיצרתם.

סוג החיבור לאינטרנט

בטבלה הבאה מפורטים ערכי ההגדרה לדוגמה של סוג החיבור לאינטרנט של Zuora:

שם השדה פרטים
מיקום us-central1
מחבר Zuora
גרסת המחבר 1
שם החיבור zuora-con
חשבון השירות account@my-project.iam.gserviceaccount.com
דייר TENANT
מספר הצמתים המינימלי 2
מספר הצמתים המקסימלי 4
מזהה לקוח CLIENT_ID
סוד לקוח CLIENT_SECRET
Secret Version 1

ישויות, פעולות ופעולות

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

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

    עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה Entities תהיה ריקה.

  • פעולה: פעולה היא הפעילות שאפשר לבצע בישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:

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

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

דוגמאות לפעולות על ישויות

בקטע הזה מוסבר איך לבצע חלק מהפעולות על ישויות במחבר הזה.

דוגמה – הצגת כל הרשומות ב-Refunds

בדוגמה הזו מוצגת רשימה של כל הרשומות בישות Refunds.

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Refunds מהרשימה Entity.
  3. בוחרים את הפעולה List ולוחצים על סיום.
  4. אופציונלי: בקטע Task Input (קלט משימה) במשימה Connectors (מחברים), אפשר לסנן את קבוצת התוצאות על ידי ציון filter clause (סעיף סינון).

דוגמה – קבלת רשומה של תעודת חיוב

בדוגמה הזו מאחזרים רשומה עם המזהה 45 מהישות Debit_Memo.

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Debit_Memo מהרשימה Entity.
  3. בוחרים את הפעולה Get ולוחצים על סיום.
  4. בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על EntityId (מזהה ישות) ואז מזינים 45 בשדה Default Value (ערך ברירת מחדל).

    כאן, 45 הוא ערך של מפתח ראשי בישות Debit_Memo.

דוגמה – יצירת כרטיס

בדוגמה הזו נוצר כרטיס בפעולה Ticket.

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Tickets מהרשימה Entity.
  3. בוחרים את הפעולה Create ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך שדומה לערך הבא בשדה Default Value: 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

    אם השילוב יצליח, בשדה connectorOutputPayload של משימת המחבר יופיע ערך שדומה לערך הבא:

    {
"Name": "Test1695971640609"
}

דוגמה – עדכון של רשומה של עסקה

בדוגמה הזו מעדכנים את הרשומה שמזהה שלה הוא 97 בישות Deals.

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Deals מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Description": "New description"
}
  5. לוחצים על entityId ואז מזינים 97 בשדה ערך ברירת מחדל.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause ל-97.

דוגמה – מחיקת טופס

בדוגמה הזו נמחק הרשומה עם המזהה 78 בישות Forms.

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Forms מהרשימה Entity.
  3. בוחרים את הפעולה Delete ולוחצים על סיום.
  4. בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על entityId ואז מזינים 78 בשדה Default Value (ערך ברירת מחדל).

יצירת חיבורים באמצעות Terraform

אפשר להשתמש במשאב של Terraform כדי ליצור חיבור חדש.

כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.

כדי לראות תבנית לדוגמה של Terraform ליצירת חיבור, אפשר לעיין בתבנית לדוגמה.

כשיוצרים את החיבור הזה באמצעות Terraform, צריך להגדיר את המשתנים הבאים בקובץ ההגדרות של Terraform:

שם הפרמטר סוג נתונים חובה תיאור
דייר (tenant) ENUM לא נכון מגדירים את זה לדייר ב-Zuora. כברירת מחדל, אנחנו משתמשים בדייר USProduction. הערכים הנתמכים הם: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url מחרוזת לא נכון המאפיין הזה חובה רק אם יש לכם סביבת עותק ייצור בארה"ב. אם הנכס הזה מסופק, לערך של נכס הדייר אין השפעה בתהליך האימות.
zuora_service ENUM לא נכון מציין באיזה שירות או סכימה של ביצוע להשתמש. הערכים הנתמכים הם: DataQuery, ‏ AQuADataExport
use_client_side_paging בוליאני לא נכון האם CData ADO.NET Provider for SAP Cloud for Customer צריך להשתמש בהחלפה לדפים בצד הלקוח.
use_custom_service בוליאני לא נכון מציין אם צריך להשתמש בשירות OData מותאם אישית של SAP Cloud for Customer.
user_defined_views מחרוזת לא נכון נתיב קובץ שמצביע על קובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית.

שימוש בחיבור ל-Zuora בשילוב

אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.

  • כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
  • מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.

קבלת עזרה מקהילת Google Cloud

אתם יכולים לפרסם את השאלות שלכם ולדון במחבר הזה בקהילת Google Cloud בפורומים של Cloud.

המאמרים הבאים