FinancialForce
מחבר Financial Force מאפשר לכם לבצע פעולות של הוספה, מחיקה, עדכון וקריאה במסד נתונים של Financial Force.
לפני שמתחילים
לפני שמשתמשים במחבר FinancialForce, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-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)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
הגדרת המחבר
החיבור הוא ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
אזורים נתמכים למחברים:
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- מחבר: בוחרים באפשרות FinancialForce מהרשימה הנפתחת של המחברים הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- אופציונלי: מזינים תיאור למופע החיבור.
- אופציונלי: מפעילים את Cloud Logging ואז בוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-
Error. - חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- אופציונלי: מגדירים את ההגדרות של צומת החיבור:
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר עסקאות לחיבור נדרשים יותר צמתים, ולהפך: כדי לעבד פחות עסקאות נדרשים פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- אסימון אבטחה: אסימון האבטחה שמשמש לאימות הגישה לחשבון FinancialForce.
- גרסת ה-API: הגרסה של FinancialForce API שבה נעשה שימוש.גרסת ברירת המחדל של FinancialForce API היא 40.0.
- All Or None: ערך בוליאני שמציין אם אתם רוצים שכל ההוספות, העדכונים או המחיקות בבקשה ייכשלו אם אפילו רשומה אחת תיכשל.
- מצב ארכיון: ערך בוליאני שמציין אם לכלול רשומות שנמחקו והועברו לארכיון בשאילתת SELECT רגילה.
- מצב מקבילי של Bulk API: מצב מקבילי לעיבוד שורות בכמות גדולה באמצעות BULK API v1.
- Bulk API Version: הגרסה של Bulk API שבה יש להשתמש לעיבוד שאילתות.
- Bulk Polling Interval: מרווח הזמן באלפיות השנייה בין בקשות שבודקות את הזמינות של התגובה לשאילתת הכמות הגדולה. ערך ברירת המחדל הוא 500 אלפיות השנייה.
- Bulk Query Timeout: פרק הזמן הקצוב בדקות שהספק ימתין לתגובה לשאילתה בכמות גדולה. ערך ברירת המחדל הוא 25 דקות.
- Continue On Alter Exception: האם רוצים להמשיך אחרי שמשפט ALTER נכשל.
- היקף הסינון: היקף אופציונלי להגבלת הרשומות שמוחזרות משאילתות.
- Include Metadata Description (הכללת תיאור מטא-נתונים): מגדירים את המאפיין הזה לערך שאינו NONE אם רוצים לאחזר את התיאורים של העמודות, הטבלאות או שניהם מ-Metadata API.
- Server Side Aggregation: ערך בוליאני שקובע אם להשתמש בצבירה בצד השרת.
- זמן קצוב לתפוגה של סשן: הזמן בדקות שבו נעשה שימוש חוזר בסשן התחברות ל-FinancialForce.
- Skip Formula Fields (דילוג על שדות נוסחה): מגדירים את הערך כ-true אם רוצים לדלג על שדות נוסחה כשמציגים רשימה של עמודות.
- Use Display Names (שימוש בשמות לתצוגה): ערך בוליאני שקובע אם להשתמש בשמות לתצוגה של העמודות במקום בשמות ה-API.
- שימוש בסביבת בדיקה: ערך בוליאני שקובע אם ליצור את החיבור לחשבון סביבת בדיקה של FinancialForce.
- תצוגות שהוגדרו על ידי המשתמש: נתיב לקובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית.
- Wait For Bulk Results (המתנה לתוצאות בכמות גדולה): האם להמתין לתוצאות בכמות גדולה כשמשתמשים ב-API אסינכרוני. ההגדרה פעילה רק אם UseBulkAPI היא true.
- (אופציונלי) בקטע הגדרות מתקדמות, מסמנים את התיבה שימוש ב-proxy כדי להגדיר שרת proxy לחיבור, ומגדירים את הערכים הבאים:
-
סכימת אימות של שרת proxy: בוחרים את סוג האימות לאימות מול שרת ה-proxy. אלה סוגי האימות שנתמכים:
- בסיסי: אימות HTTP בסיסי.
- Digest: אימות HTTP מסוג Digest.
- משתמש proxy: שם משתמש שישמש לאימות בשרת ה-proxy.
- סיסמת ה-Proxy: הסוד במנהל הסודות של סיסמת המשתמש.
-
סוג ה-SSL של ה-Proxy: סוג ה-SSL שבו יש להשתמש כשמתחברים לשרת ה-Proxy. אלה סוגי האימות שנתמכים:
- אוטומטי: הגדרת ברירת המחדל. אם כתובת ה-URL היא כתובת HTTPS, נעשה שימוש באפשרות Tunnel. אם כתובת ה-URL היא כתובת HTTP, נעשה שימוש באפשרות NEVER.
- תמיד: החיבור תמיד מופעל באמצעות SSL.
- לעולם לא: החיבור לא מופעל באמצעות SSL.
- מנהור: החיבור הוא דרך שרת proxy למנהור. שרת ה-proxy פותח חיבור למארח המרוחק, והתנועה זורמת הלוך ושוב דרך ה-proxy.
- בקטע שרת Proxy, מזינים את פרטי שרת ה-Proxy.
- לוחצים על + הוספת יעד.
- בוחרים סוג יעד.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
כדי ליצור חיבור פרטי למערכת העורפית, פועלים לפי השלבים הבאים:
- יוצרים קובץ מצורף לשירות PSC.
- יוצרים endpoint attachment ואז מזינים את הפרטים שלו בשדה Host address.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
- אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
- בקטע יעדים, מזינים את הפרטים של המארח המרוחק (מערכת העורף) שאליו רוצים להתחבר.
- סוג היעד: בוחרים סוג יעד.
- כדי לציין את שם המארח או את כתובת ה-IP של היעד, בוחרים באפשרות כתובת המארח ומזינים את הכתובת בשדה מארח 1.
- כדי ליצור חיבור פרטי, בוחרים באפשרות Endpoint attachment (צירוף נקודת קצה). ברשימה Endpoint Attachment, בוחרים את קובץ ה-Endpoint Attachment שנוצר עבור מערכת ה-Backend.
אם רוצים ליצור חיבור ציבורי למערכות העורפיות עם אבטחה נוספת, אפשר להגדיר כתובות IP סטטיות יוצאות לחיבורים, ואז להגדיר את כללי חומת האש כך שרק כתובות ה-IP הסטטיות הספציפיות יופיעו ברשימת ההיתרים.
כדי להזין יעדים נוספים, לוחצים על +הוספת יעד.
- לוחצים על הבא.
- סוג היעד: בוחרים סוג יעד.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
החיבור ל-FinancialForce תומך בסוגי האימות הבאים:
- שם משתמש וסיסמה
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- בדיקה: בודקים את פרטי החיבור והאימות.
- לוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
-
שם משתמש וסיסמה
- שם משתמש: שם המשתמש של המחבר
- סיסמה: סוד ב-Secret Manager שמכיל את הסיסמה שמשויכת למחבר.
ישויות, פעולות ופעולות
כל Integration Connectors מספקים שכבת הפשטה לאובייקטים של האפליקציה המחוברת. אפשר לגשת לאובייקטים של אפליקציה רק דרך ההפשטה הזו. ההפשטה מוצגת לכם כישויות, פעולות ופעולות.
- ישות: ישות היא אובייקט או אוסף של מאפיינים באפליקציה או בשירות המקושרים. ההגדרה של ישות משתנה ממחבר למחבר. לדוגמה, במחבר של מסד נתונים, הטבלאות הן הישויות, במחבר של שרת קבצים, התיקיות הן הישויות, ובמחבר של מערכת הודעות, התורים הם הישויות.
עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה
Entitiesתהיה ריקה. - פעולה: פעולה היא הפעילות שאפשר לבצע בישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:
בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה
Operations. - פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה
Actionsתהיה ריקה.
יצירת חיבורים באמצעות Terraform
אפשר להשתמש במשאב של Terraform כדי ליצור חיבור חדש.
כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.
כדי לראות תבנית לדוגמה של Terraform ליצירת חיבור, אפשר לעיין בתבנית לדוגמה.
כשיוצרים את החיבור הזה באמצעות Terraform, צריך להגדיר את המשתנים הבאים בקובץ ההגדרות של Terraform:
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| security_token | SECRET | לא נכון | אסימון האבטחה שמשמש לאימות הגישה לחשבון FinancialForce. |
| apiversion | מחרוזת | לא נכון | הגרסה של FinancialForce API שבה נעשה שימוש.גרסת FinancialForce API שמשמשת כברירת מחדל היא 40.0. |
| all_or_none | בוליאני | לא נכון | ערך בוליאני שמציין אם רוצים שכל ההוספות, העדכונים או המחיקות ייכשלו בבקשה אם אפילו רשומה אחת נכשלת. |
| archive_mode | בוליאני | לא נכון | ערך בוליאני שמציין אם לכלול רשומות שנמחקו או הועברו לארכיון בשאילתת SELECT רגילה. |
| bulk_apiconcurrency_mode | ENUM | לא נכון | מצב המקבילות לעיבוד שורות בכמות גדולה באמצעות BULK API v1. הערכים הנתמכים הם: Serial, Parallel |
| bulk_apiversion | ENUM | לא נכון | הגרסה של Bulk API שבה יש להשתמש לעיבוד שאילתות. הערכים הנתמכים הם: v1, v2 |
| bulk_polling_interval | מחרוזת | לא נכון | מרווח הזמן באלפיות השנייה בין בקשות שבודקות את הזמינות של התשובה לשאילתה בכמות גדולה. ערך ברירת המחדל הוא 500 אלפיות השנייה. |
| bulk_query_timeout | מחרוזת | לא נכון | פרק הזמן הקצוב לתפוגה בדקות שבו הפלאגין שמתממשק עם שירותים חיצוניים ימתין לתשובה לשאילתת נפח. ערך ברירת המחדל הוא 25 דקות. |
| continue_on_alter_exception | בוליאני | לא נכון | האם רוצים להמשיך אחרי שמשפט ALTER נכשל. |
| filter_scope | ENUM | לא נכון | היקף אופציונלי להגבלת הרשומות שמוחזרות משאילתות. הערכים הנתמכים הם: None, Delegated, Everything, Mine, MineAndMyGroups, My_Territory, My_Team_Territory, Team |
| include_metadata_description | ENUM | לא נכון | אם רוצים לאחזר את התיאורים של העמודות, הטבלאות או שניהם מ-Metadata API, צריך להגדיר את המאפיין הזה לערך שאינו NONE. הערכים הנתמכים הם: NONE, Columns, Tables, TablesAndColumns |
| server_side_aggregation | בוליאני | לא נכון | ערך בוליאני שקובע אם צריך להשתמש בצבירה בצד השרת. |
| session_timeout | מחרוזת | לא נכון | הזמן בדקות שבו נעשה שימוש חוזר בסשן התחברות ל-FinancialForce. |
| skip_formula_fields | בוליאני | לא נכון | הערך צריך להיות true אם רוצים לדלג על שדות של נוסחאות כשמציגים רשימה של עמודות. |
| use_display_names | בוליאני | לא נכון | ערך בוליאני שקובע אם להשתמש בשמות התצוגה של העמודות במקום בשמות ה-API. |
| use_sandbox | בוליאני | נכון | ערך בוליאני שקובע אם החיבור צריך להתבצע לחשבון סביבת ארגז חול של FinancialForce. |
| user_defined_views | מחרוזת | לא נכון | נתיב קובץ שמצביע על קובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית. |
| wait_for_bulk_results | בוליאני | לא נכון | האם להמתין לתוצאות בכמות גדולה כשמשתמשים ב-API אסינכרוני. ההגדרה פעילה רק אם UseBulkAPI היא true. |
| proxy_enabled | בוליאני | לא נכון | מסמנים את תיבת הסימון הזו כדי להגדיר שרת Proxy לחיבור. |
| proxy_auth_scheme | ENUM | לא נכון | סוג האימות שבו יש להשתמש כדי לבצע אימות לשרת ה-proxy ProxyServer. הערכים הנתמכים הם: BASIC, DIGEST, NONE |
| proxy_user | מחרוזת | לא נכון | שם משתמש שישמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_password | SECRET | לא נכון | סיסמה שתשמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_ssltype | ENUM | לא נכון | סוג ה-SSL שבו צריך להשתמש כשמתחברים לשרת ה-proxy של ProxyServer. הערכים הנתמכים הם: AUTO, ALWAYS, NEVER, TUNNEL |
שימוש בחיבור FinancialForce בשילוב
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.