openForm (חומר עזר ל- API של JavaScript) עבור Dynamics 365 Channel Integration Framework 2.0

פתיחת טופס ישות או טופס יצירה מהירה.

תחביר

Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);

פרמטרים

שם	Type	חובה	תיאור‬‏‫‬
entityFormOptions	אובייקט JSON	כן	אפשרויות טופס ישות לפתיחת הטופס. האובייקט מכיל את התכונות הבאות: - cmdbar - createFromEntity - entityId - שם ישות - formId -גובה - בר ניווט - openInNewWindow - חלוןמיקום - מזהה תהליך - processInstanceId -מערכת יחסים - selectStageId - השתמש ב-QuickCreateForm -רוחב עיין בטבלת האובייקטיםentityFormOptions לקבלת מידע אודות התכונות.
formParameters	אובייקט	לא	אובייקט מילון המעביר פרמטרים נוספים לטופס. פרמטרים לא חוקיים יגרמו לשגיאה. לקבלת מידע אודות העברת פרמטרים לטופס, ראה הגדרת ערכי שדה באמצעות פרמטרים המועברים לטופסוקביעת תצורה של טופס לקבלת פרמטרים מותאמים אישית של מחרוזת שאילתה.
הצלחההתקשרות חוזרת	פונקציה	לא	פונקציה לביצוע כאשר הפעולה מצליחה.
errorהתקשרות חוזרת	פונקציה	לא	פונקציה לביצוע כאשר הפעולה נכשלת.

entityFormOptions תכונות אובייקט

הטבלה הבאה מתארת את התכונות של הפרמטר entityFormOptions .

הערה

התכונות הן אופציונליות.

שם תכונה	Type	תיאור‬‏‫‬
cmdבר	בוליאני	מציין אם להציג את סרגל הפקודות. אם לא תציין פרמטר זה, סרגל הפקודות יוצג כברירת מחדל.
createFromEntity	בדיקת מידע	מציין רשומה שתספק ערכי ברירת מחדל בהתבסס על ערכי תכונה ממופים. אובייקט בדיקת המידע כולל את המאפיינים הבאים מסוג מחרוזת: entityType, idו- name (אופציונלי).
entityId	String	מזהה של רשומת הישות שעבורה יש להציג את הטופס.
שם ישות	String	שם לוגי של הישות שעבורה יש להציג את הטופס.
formId	String	מזהה מופע הטופס שיוצג.
גובה	מספר	גובה חלון הטופס שיוצג בפיקסלים.
navBar	String	קובע אם סרגל הניווט מוצג ואם ניווט באפליקציה זמין באמצעות האזורים ואזורי המשנה המוגדרים במפת האתר. ערכים חוקיים הם: onסרגל הניווט מוצג.: זוהי התנהגות ברירת המחדל אם navBar לא נעשה שימוש בפרמטר. offסרגל הניווט אינו מוצג.: המשתמש יכול לנווט באמצעות רכיבי ממשק משתמש אחרים או הלחצנים אחורה וקדימה. entityבטופס ישות, רק אפשרויות הניווט עבור ישויות קשורות זמינות.: לאחר ניווט לישות קשורה, לחצן 'הקודם' מוצג בסרגל הניווט כדי לאפשר חזרה לרשומה המקורית.
openInNewWindow	בוליאני	מציין אם להציג את הטופס בחלון חדש.
חלוןמיקום	מספר	מציין את מיקום הטופס בחלון. ערכים חוקיים הם: 1 עבור מיקום מרכז ועבור 2 מיקום צד.
מזהה תהליך	String	מזהה התהליך העסקי שיוצג בטופס.
processInstanceId	String	מזהה של מופע התהליך העסקי שיוצג בטופס.
קשרי גומלין	אובייקט JSON	מציין אובייקט קשר להצגת הרשומות הקשורות בטופס. עיין בטבלת האובייקטיםrelationship לקבלת מידע אודות התכונות.
selectStageId	String	מזהה השלב שנבחר במופע התהליך העסקי.
useQuickCreateForm	מספר	רוחב חלון הטופס שיוצג בפיקסלים.

relationship תכונות אובייקט

הטבלה הבאה מתארת את התכונות של תכונת האובייקט relationship של הפרמטר entityFormOptions .

הערה

התכונות הן אופציונליות.

שם תכונה	Type	תיאור‬‏‫‬
שם תכונה	String	שם התכונה המשמשת לקשר.
שם	String	שם קשר הגומלין.
navigationמאפיין	String	שם מאפיין הניווט עבור קשר הגומלין.
סוג קשר	מספר	סוג קשר. ערכים חוקיים הם: 0 עבור קשר גומלין של יחיד לרבים ועבור 1 קשרי גומלין של רבים לרבים.
סוג תפקיד	מספר	סוג תפקיד בקשר הגומלין. הערכים החוקיים הם: 1 עבור הפניה ועבור 2 AssociationEntity.

ערך החזרה

לאחר הצלחה, החזרת אובייקט Promise המכיל מחרוזת.

דוגמה

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

var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
    entityFormOptions["entityName"] = "incident";
    
var formParameters = {};
    //pre-populate some fields based on the context
    formParameters["title"] = title;
    formParameters["customerid"] = id;
    formParameters["customeridtype"] = "contact";
    formParameters["caseorigincode"] = 1;
    formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";

//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
      function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    }
  );