executeEvent (הפניה ל- API של לקוח) (תצוגה מקדימה)

חשוב

• ‏‫‏‫זוהי תכונת Preview.‬‬
• תכונות Preview אינן מיועדות לשימוש בייצור וייתכן שיש להן פונקציונליות מוגבלת. תכונות אלה כפופות לתנאי השימוש המשלימים והן זמינות לפני הפצה רשמית, כך שהלקוחות יכולים לקבל גישה מוקדמת ולספק משוב.

ביצוע נושא של Microsoft Copilot Studio בהתבסס על שם האירוע הרשום. החזרת מערך מסוג MCSResponse.

תחביר

Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Parameters

שם פרמטר	Type	נדרש	תיאור
eventName	מחרוזת	כן	שם אירוע רשום בנושא Microsoft Copilot Studio
eventParameters	Unknown	כן	פרמטרים הדרושים לביצוע האירוע. אלה תלויים במה שהנושא עושה.
successCallback	פונקציה	כן	פונקציה שיש לקרוא לה כאשר הפעולה מצליחה.
errorCallback	פונקציה	כן	פונקציה שיש לקרוא לה כאשר הפעולה נכשלת.

ערך החזרה

מערך של MCSResponse

גישה להקשר יישום

כאשר מתבצעת קריאה ל- API של סוכן, ההקשר עבור היישום מועבר לנושא Copilot Studio באמצעות ערכה של משתנים. להלן משתני הקשר הזמינים כמשתנים כלליים של Copilot Studio.

משתנה	תיאור
Global.PA__Copilot_Model_PageContext.pageContext.id.guid	מזהה רשומת הטבלה בטופס הראשי
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName	שם לוגי של הטבלה בעמוד הראשי
Global.PA__Copilot_Model_PageContext.pageContext.pageName	שם העמוד הראשי
Global.PA__Copilot_Model_PageContext.pageContext.pageType	סוג העמוד הראשי
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName	שם ייחודי של היישום מונחה המודלים

לדוגמה, ניתן Global.PA__Copilot_Model_PageContext.pageContext.id.guid לאחזר Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNameאת רשומת הטופס באמצעות ו- , מ- Dataverse.

גישה לפרמטרים של אירוע

בתוך הנושא Copilot Studio, ניתן לגשת eventParameters לשיחה מה- API באמצעות המשתנה Activity.Value. השתמש בצומת ערך ניתוח כדי להמיר את ה- JSON לתוך רשומה עם שדה אחד או יותר. בחירה מתוך נתונים לדוגמהעבור סוג נתונים מאפשרת לספק דוגמה של JSON ליצירת הרשומה.

דוגמה

ב- Microsoft Copilot Studio, כאשר רשום נושא שמקבל מזהה (מזהה רשומת ישות) פרמטר קלט. בהתבסס על הקלט, הוא מאחזר את הפעילויות הקשורות של אותה רשומת ישות ומחזיר את התוצאות כפעילות אירוע של Copilot Studio.

const response = await Xrm.Copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"}); 

השב

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

מאמרים קשורים

Xrm.Copilot (חומר עזר עבור API של לקוח)