Xero
המחבר הזה מספק גישת SQL לחלק האחורי של Xero.
לפני שמתחילים
לפני שמשתמשים במחבר Xero, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-Google Cloud:
- מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM roles/connectors.admin.
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. המחבר וחשבון השירות צריכים להיות שייכים לאותו פרויקט. מידע נוסף זמין במאמר בנושא יצירת חשבון שירות.
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
הגדרות Xero
כדי להגדיר את Xero, צריך לבצע את המשימות הבאות:
הגדרת חשבון Xero וחברת הדגמה ב-Xero
- עוברים אל חשבון Xero כדי להירשם לחשבון Xero בחינם.
- כדי להפעיל את חברת ההדגמה של Xero, עוברים אל Xero Demo Company.
יצירת פרטי אימות של לקוח OAuth2.0
- מתחברים לחשבון הפיתוח ב-Xero.
- לוחצים על הרשמה ופועלים לפי ההנחיות. אם כבר יש לכם חשבון, מתחברים באמצעות פרטי הכניסה.
- עוברים אל הפורטל למפתחים של Xero מהקטע האפליקציות שלי במרכז השליטה למפתחים.
- כדי ליצור אפליקציה חדשה, לוחצים על אפליקציה חדשה או על יצירת אפליקציה חדשה.
- מזינים את הפרטים הנדרשים של האפליקציה, כמו שם האפליקציה, התיאור, כתובת ה-URL של החברה, כתובת ה-URL של מדיניות הפרטיות, כתובת ה-URL של תנאי השימוש וכתובת ה-URL של הקריאה החוזרת.
- חשוב לבחור את סוג האפליקציה המתאים ואת ההרשאות הנדרשות לשילוב עם חברת ההדגמה של Xero.
- שומרים את מזהה הלקוח ואת סוד הלקוח במיקום מאובטח לשימוש עתידי.
אחרי הכניסה, תועברו למרכז הבקרה למפתחים של Xero.
אחרי שיוצרים את האפליקציה, מקבלים את פרטי הכניסה ל-OAuth, כולל מזהה לקוח וסוד לקוח.
כשיוצרים את השילוב, חשוב לבחור בקפידה את ההיקפים הנדרשים לכל סכימה כדי לוודא שלאפליקציה יש את ההרשאות המתאימות לגישה אל כלי השירות הנדרשים ולשימוש בהם.
מידע על אימות ועל אחזור מזהה לקוח וסוד לקוח מופיע במאמר אחזור מזהה לקוח וסוד לקוח.
הגדרת פרטי הסכימה
אפשר לבחור את הסכימה על סמך המודול. הסכימות הזמינות הן ACCOUNTING, ASSETS, PAYROLLAUS, FILES ו-PROJECTS. יש לנו חמישה מודולים שונים, ולכן צריך ליצור קישורים שונים לכל מודול.
מידע על היקפים שאפשר לציין כשיוצרים חיבור זמין במאמר היקפים.
הגדרת פרטי האישור
מידע על הגדרת כתובת URL לאישור זמין במאמר הגדרת כתובת URL לאישור.
הגדרת המחבר
החיבור ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
אזורים נתמכים למחברים:
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- כלי לחיבור: בוחרים באפשרות Xero מהרשימה הנפתחת של כלי החיבור הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- אפשר גם להזין תיאור למופע החיבור.
- אופציונלי: מפעילים את Cloud logging ובוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-
Error. - חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- אופציונלי: מגדירים את ההגדרות של צומת החיבור:
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר טרנזקציות לחיבור מסוים, צריך יותר צמתים, ולהפך – כדי לעבד פחות טרנזקציות, צריך פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- Schema: ה-Xero API שרוצים לגשת אליו כסכימת מסד נתונים.
- Tenant (דייר): הגדרת הארגון ב-Xero שאליו רוצים להתחבר. יכול להיות שם או מזהה דייר (tenant).
- רמת הפירוט: רמת הפירוט של החיבור, משתנה מ-1 עד 5. רמת פירוט גבוהה יותר תתעד את כל פרטי התקשורת (בקשה,תגובה ואישורי SSL).
- אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
החיבור ל-Xero תומך בסוגי האימות הבאים:
- פרטי כניסה של לקוח OAuth 2.0
- הרשאת קוד אימות OAuth 2.0
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- בדיקה: בודקים את פרטי החיבור והאימות.
- לוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
-
פרטי לקוח OAuth 2.0
- מזהה לקוח: מזהה הלקוח שסופק על ידי כלי החיבור לאפליקציה שיצרתם.
- סוד הלקוח: סוד ב-Secret Manager שמכיל את סוד הלקוח של האפליקציה המקושרת שיצרתם.
-
הרשאת קוד אימות OAuth 2.0
- אסימון גישה: אסימון הגישה שמשמש לאימות בקשות עם חיבורים שמבוססים על תהליך הרשאה עם קוד.
- Client ID: מזהה הלקוח שמשמש לבקשת אסימוני גישה.
- סוד הלקוח: סוד הלקוח שמשמש לבקשת אסימוני גישה.
הגדרת חיבור
בקטע הזה מפורטים ערכי הדוגמה של השדות השונים שאתם מגדירים כשאתם יוצרים את החיבור ל-Xero.
סוג החיבור לשרת הנהלת החשבונות
| שם השדה | פרטים |
|---|---|
| אזור | us-central1 |
| מחבר | Xero |
| גרסת המחבר | 1 |
| שם החיבור | google-cloud-xero-accounting-connection |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| סכימה | ACCOUNTING |
| רמת הפירוט | 5 |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | offline_access openid profile email accounting.transactions, accounting.reports.read, accounting.attachments, accounting.journals.read, accounting.settings, accounting.contacts, accounting.budgets.read |
| סוד לקוח | CLIENT_SECRET |
| גרסת הסוד | 1 |
| כתובת אתר להרשאה | https://login.xero.com/identity/connect/authorize |
סוג החיבור לשרת הנכסים
| שם השדה | פרטים |
|---|---|
| אזור | us-central1 |
| מחבר | Xero |
| גרסת המחבר | 1 |
| שם החיבור | google-cloud-xero-assets-connection |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| סכימה | נכסים |
| רמת הפירוט | 5 |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | assets.read, assets |
| סוד לקוח | CLIENT_SECRET |
| גרסת הסוד | 1 |
| כתובת אתר להרשאה | https://login.xero.com/identity/connect/authorize |
סוג החיבור לשרת הקבצים
| שם השדה | פרטים |
|---|---|
| אזור | us-central1 |
| מחבר | Xero |
| גרסת המחבר | 1 |
| שם החיבור | google-cloud-xero-files-connection |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| סכימה | FILES |
| רמת הפירוט | 5 |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | files, files.read |
| סוד לקוח | CLIENT_SECRET |
| גרסת הסוד | 1 |
| כתובת אתר להרשאה | https://login.xero.com/identity/connect/authorize |
סוג החיבור לשרת Payrollaus
| שם השדה | פרטים |
|---|---|
| אזור | us-central1 |
| מחבר | Xero |
| גרסת המחבר | 1 |
| שם החיבור | google-cloud-xero-payroll-connection |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| סכימה | PAYROLLAUS |
| רמת הפירוט | 5 |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | payroll.employees, payroll.payruns, payroll.payslip, payroll.timesheets, payroll.settings |
| סוד לקוח | CLIENT_SECRET |
| גרסת הסוד | 1 |
| כתובת אתר להרשאה | https://login.xero.com/identity/connect/authorize |
סוג החיבור לשרת של הפרויקטים
| שם השדה | פרטים |
|---|---|
| אזור | us-central1 |
| מחבר | Xero |
| גרסת המחבר | 1 |
| שם החיבור | google-cloud-xero-projects-connection |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| סכימה | פרויקטים |
| רמת הפירוט | 5 |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | projects, projects.read |
| סוד לקוח | CLIENT_SECRET |
| גרסת הסוד | 1 |
| כתובת אתר להרשאה | https://login.xero.com/identity/connect/authorize |
ישויות, פעולות ופעולות
כל Integration Connectors מספקים שכבת הפשטה לאובייקטים של האפליקציה המחוברת. אפשר לגשת לאובייקטים של אפליקציה רק דרך ההפשטה הזו. ההפשטה מוצגת לכם כישויות, פעולות ופעילויות.
- ישות: ישות היא אובייקט או אוסף של מאפיינים באפליקציה או בשירות המקושרים. ההגדרה של ישות משתנה ממחבר למחבר. לדוגמה, במחבר של מסד נתונים, הטבלאות הן הישויות. במחבר של שרת קבצים, התיקיות הן הישויות. במחבר של מערכת הודעות, התורים הם הישויות.
עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה
Entitiesתהיה ריקה. - פעולה: פעולה היא הפעילות שאפשר לבצע על ישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:
בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה
Operations. - פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה
Actionsתהיה ריקה.
שימוש בחיבור Xero בשילוב
מגבלות המערכת
מחבר Xero יכול לעבד 5 עסקאות בשנייה, לכל צומת, ומגביל את מספר העסקאות מעבר למגבלה הזו. עם זאת, מספר העסקאות שהמחבר של Xero יכול לעבד תלוי גם במגבלות שהוגדרו במופע של Xero. מידע נוסף זמין במאמר בנושא מגבלות קצב ב-Xero API. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.
מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.
פעולות
בקטע הזה מפורטות חלק מהפעולות שהמחבר תומך בהן. כדי להבין איך להגדיר את הפעולות, אפשר לעיין בדוגמאות לפעולות.
הפעולה DownloadAttachment
הפעולה הזו מורידה קובץ מצורף.
פרמטרים של קלט לפעולה DownloadAttachment
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| שם קובץ | String | לא | שם הקובץ המצורף להורדה. |
| טבלה | String | לא | שם הטבלה שממנה צריך להוריד את הקובץ המצורף. |
| ObjectId | String | לא | מזהה האובייקט של הקובץ המצורף. |
פרמטרים של הפלט של הפעולה DownloadAttachment
הפעולה הזו מחזירה את הסטטוס 200 (OK) אם ההורדה מתבצעת בהצלחה.
במאמר דוגמאות לפעולות מוסבר איך להגדיר את הפעולה DownloadAttachment.
הפעולה UploadAttachment
הפעולה הזו מאפשרת להעלות קובץ מצורף.
פרמטרים של קלט לפעולה UploadAttachment
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| שם קובץ | String | לא | שם הקובץ המצורף להעלאה. |
| ObjectId | String | לא | מזהה האובייקט של הקובץ המצורף. |
| ContentType | String | לא | סוג התוכן של הקובץ המצורף. |
| טבלה | String | לא | שם הטבלה שאליה צריך להעלות את הקובץ המצורף. |
| תוכן | String | לא | תוכן הקובץ המצורף |
פרמטרים של פלט הפעולה UploadAttachment
הפעולה הזו מחזירה את הסטטוס 200 (OK) אם העלאת האובייקט מתבצעת בהצלחה.
במאמר דוגמאות לפעולות מוסבר איך להגדיר את הפעולה UploadAttachment.
פעולת ListAttachment
הפעולה הזו מאפשרת לכם להציג רשימה של כל הקבצים המצורפים בטבלה.
פרמטרי הקלט של הפעולה ListAttachment
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| ObjectId | String | לא | מזהה האובייקט של הקובץ המצורף. |
| טבלה | String | לא | שם הטבלה שממנה צריך להציג את הקבצים המצורפים. |
פרמטרים של פלט הפעולה ListAttachment
אם המחיקה מתבצעת בהצלחה, הפעולה הזו מחזירה את הסטטוס 200 (OK).
במאמר דוגמאות לפעולות מוסבר איך להגדיר את הפעולה ListAttachment.
הפעולה SendInvoiceMail
הפעולה הזו מאפשרת לשלוח אימיילים למי שמוציא את החשבונית.
פרמטרים של קלט של הפעולה SendInvoiceMail
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| InvoiceId | String | לא | המזהה של החשבונית שעבורה צריך לשלוח את האימייל. |
פרמטרים של הפלט של הפעולה SendInvoiceMail
אם פעולת ההעברה בוצעה בהצלחה, הפעולה הזו מחזירה את הסטטוס 200 (OK).
במאמר דוגמאות לפעולות מוסבר איך להגדיר את הפעולה SendInvoiceMail.
הפעולה UploadFile
הפעולה הזו מאפשרת להעלות קובץ.
פרמטרים של קלט לפעולה UploadFile
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| שם | String | לא | השם של הקובץ שרוצים להעלות. |
| תוכן | String | לא | תוכן הקובץ שרוצים להעלות. |
פרמטרים של פלט של הפעולה UploadFile
הפעולה הזו מחזירה את הסטטוס 200 (OK) אם העלאת האובייקט מתבצעת בהצלחה.
במאמר דוגמאות לפעולות מוסבר איך להגדיר את הפעולה UploadFile.
דוגמאות לפעולות
בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.
דוגמה – הורדת קובץ מצורף
בדוגמה הזו מתבצעת הורדה של קובץ מצורף.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DownloadAttachmentולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Filename": "Xero_Test.txt", "Table": "Contacts", "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41" }
אם הפעולה מצליחה, לפרמטר התגובה DownloadAttachment של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "True", "Content": "Test content" }]
דוגמה – העלאת קובץ מצורף
בדוגמה הזו מועלה קובץ מצורף.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UploadAttachmentולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Filename": "Xero_Test.txt", "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41", "ContentType": "txt", "Table": "Contacts", "Content": "Test content upload attachment" }
אם הפעולה מצליחה, לפרמטר התגובה UploadAttachment של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": null, "AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5", "FileName": "Xero_Test.txt", "URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt", "MimeType": "text/plain", "ContentLength": "27", "IncludeOnline": null, "_": "" }, { "Success": null, "AttachmentId": null, "FileName": null, "URL": null, "MimeType": null, "ContentLength": null, "IncludeOnline": null, "_": null }]
דוגמה – רשימת קבצים מצורפים
בדוגמה הזו מפורטים הקבצים המצורפים של הטבלה שצוינה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
ListAttachmentולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41", "Table": "Contacts" }
אם הפעולה מצליחה, לפרמטר התגובה ListAttachment של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5", "FileName": "Xero_Limit_Testing.txt", "URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt", "MimeType": "text/plain", "ContentLength": "27" }]
דוגמה – שליחת אימייל עם חשבונית
בדוגמה הזו נשלח אימייל לגבי החשבונית שצוינה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
SendInvoiceMailולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566" }
אם הפעולה מצליחה, לפרמטר התגובה SendInvoiceMail של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true" }]
דוגמה – העלאת קובץ
בדוגמה הזו מעלים קובץ.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UploadFileולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "Sample1.txt", "Content": "This is a sample file" }
אם הפעולה מצליחה, לפרמטר התגובה UploadFile של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true", "FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460", "Name": "Sample1.txt", "FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d", "MimeType": "text/plain", "Size": 26.0, "User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6", "User_Name": "test_user_1@test.com", "User_FirstName": "John", "User_LastName": "Smith", "User_FullName": "John Smith", "Created": "2023-12-18 17:38:53.01", "Updated": "2023-12-18 17:38:53.01" }]
דוגמאות לפעולות על ישויות
בקטע הזה מוסבר איך לבצע חלק מהפעולות על ישויות במחבר הזה.
דוגמה – הצגת כל הרשומות
בדוגמה הזו מוצגת רשימה של כל הרשומות בישות Accounts.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
AccountsמהרשימהEntity. - בוחרים את הפעולה
Listולוחצים על סיום. - אופציונלי: בקטע Task Input (קלט משימה) במשימה Connectors (מחברים), אפשר לסנן את קבוצת התוצאות על ידי ציון filter clause (סעיף מסנן).
לדוגמה,
City='Bangalore'. אפשר גם לציין כמה תנאי סינון באמצעות אופרטורים לוגיים. לדוגמה,City='Bangalore' and region='asia-south2'.
דוגמה – קבלת חשבונית
בדוגמה הזו מתקבלת חשבונית עם המזהה שצוין מהישות Invoices.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
InvoicesמהרשימהEntity. - בוחרים את הפעולה
Getולוחצים על סיום. - בקטע Task Input (קלט של המשימה) במשימה Connectors (מחברים), לוחצים על EntityId (מזהה הישות) ואז מזינים
1|016a64c7-be0b-45a2-acae-13057fdf1566בשדה Default Value (ערך ברירת המחדל).כאן,
1|016a64c7-be0b-45a2-acae-13057fdf1566הוא ערך של מפתח ראשי בישותInvoices.
דוגמה – יצירת חשבונית
בדוגמה הזו נוצרת חשבונית בישות Invoices.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
InvoicesמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Type": "ACCPAY", "ContactName": "ContactName1", "LineItem_Description": "LineItemDescription" }
אם השילוב יצליח, בשדה
connectorOutputPayloadשל משימת המחבר יופיע ערך שדומה לערך הבא:{ "Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de" }
דוגמה – עדכון רשומה
בדוגמה הזו מעדכנים רשומה בישות AssetTypes.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
AssetTypesמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "BookDepreciationSetting_DepreciationRate": 10.0 }
- לוחצים על entityId ואז מזינים
f8d43548-25b0-4cc3-8f59-d97106974fe8בשדה ערך ברירת מחדל.אם השילוב יצליח, בשדה
connectorOutputPayloadשל משימת המחבר יופיע ערך שדומה לערך הבא:{ "AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8" }
דוגמה – מחיקת קובץ
בדוגמה הזו נמחק הקובץ עם המזהה שצוין מהישות Files.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
FilesמהרשימהEntity. - בוחרים את הפעולה
Deleteולוחצים על סיום. - בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על entityId ואז מזינים
421c82f0-38fb-4074-a679-63b04c0d8832בשדה Default Value (ערך ברירת מחדל).
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור באינטגרציה באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת Connectors ב-Application Integration זמין במאמר משימת Connectors.