Delen via

executeEvent (client-API-verwijzing) (preview)

Belangrijk

  • Dit is een preview-functie.
  • Preview-functies zijn niet bedoeld voor productiegebruik en bieden mogelijk beperkte functionaliteit. Voor deze functies gelden aanvullende gebruiksvoorwaarden. Bovendien zijn ze beschikbaar vóór een officiële release zodat klanten vroeg toegang kunnen krijgen en feedback kunnen geven.

Voert een Microsoft Copilot Studio-onderwerp uit op basis van de geregistreerde gebeurtenisnaam. Retourneert een matrix van het type MCSResponse.

Syntaxis

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

Parameterwaarden

Parameternaam Typologie Verplicht Description
eventName touw Yes Gebeurtenisnaam geregistreerd in het onderwerp Microsoft Copilot Studio
eventParameters Onbekend Yes Parameters die nodig zijn voor de uitvoering van de gebeurtenis. Deze zijn afhankelijk van wat het onderwerp doet.
successCallback Functie Yes Een functie om aan te roepen wanneer de bewerking is geslaagd.
errorCallback Functie Yes Een functie om aan te roepen wanneer de bewerking mislukt.

Retourwaarde

Een matrix van MCSResponse

Toegang tot app-context

Wanneer een Agent-API wordt aangeroepen, wordt de context voor de app via een set variabelen doorgegeven aan het Copilot Studio-onderwerp. Hieronder staan contextvariabelen die beschikbaar zijn als globale variabelen van Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID van het tabelrecord op het hoofdformulier
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logische naam van de tabel op de hoofdpagina
Global.PA__Copilot_Model_PageContext.pageContext.pageName Naam van de hoofdpagina
Global.PA__Copilot_Model_PageContext.pageContext.pageType Type van de hoofdpagina
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Unieke naam van de modelgestuurde app

Als u bijvoorbeeld de record van het formulier gebruikt Global.PA__Copilot_Model_PageContext.pageContext.id.guid en Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNamegebruikt, kunt u deze ophalen uit Dataverse.

Toegang tot eventParameters

In het Copilot Studio-onderwerp kan de eventParameters api-aanroep worden geopend met behulp van de variabele Activity.Value. Gebruik het knooppunt Waarde parseren om de JSON te converteren naar een record met een of meer velden. Als u van voorbeeldgegevens voor gegevenstype selecteert, kunt u een JSON-voorbeeld instellen om de record te maken.

Example

In Microsoft Copilot Studio, waarbij een onderwerp is geregistreerd dat een id (entiteitsrecord-id) accepteert als invoerparameter. Op basis van de invoer worden de gerelateerde activiteiten van die entiteitsrecord opgehaald en worden de resultaten geretourneerd als een Copilot Studio-gebeurtenisactiviteit.

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

Reactie

[
    {
        "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 (client-API-verwijzing)

  • Last updated on