{
   "$schema":"http://json-schema.org/draft-07/schema#",
   "description":"Pizza Order Schema",
   "title":"Pizza Order Schema",
   "type":"object",
   "properties":{
      "size":{
         "description":"The pizza size",
         "type":"string"
      },
      "orderid":{
         "description":"The pizza orderid",
         "type":"string"
      },
      "type":{
         "description":"The pizza type",
         "type":"string"
      },
      "topping":{
         "description":"The pizza topping",
         "type":"string"
      }
   }
}

Pour que la compétence réponde à l'événement, vous ajoutez un flux pour cet événement et utilisez l'état Aviser l'utilisateur pour afficher un message lorsque l'événement se produit :

1. Dans la compétence à utiliser pour l'événement, cliquez sur , puis sur + Add Flow (Ajouter un flux).
2. Entrez un nom de flux et cliquez sur Créer.
3. Cliquez sur le menu dans le démarrage du flux, puis cliquez sur Ajouter un état de début pour ouvrir la boîte de dialogue Ajouter un état.
   
   
   
   
4. Sélectionnez Intégration de services > Aviser l'utilisateur, entrez un nom pour l'état, puis cliquez sur Insérer.
5. Dans l'inspecteur de propriétés pour l'état Aviser l'utilisateur inséré, sélectionnez l'onglet Composant et remplissez le champ Message d'avis avec un message à afficher lorsque l'événement se produit.

   Dans le message, vous pouvez utiliser des expressions dans le format suivant pour accéder aux données de l'événement :

   ${skill.system.event.value.application.data.<propertyName>}

   Note
   
   Vous pouvez également accéder aux informations de contexte à partir de l'événement à l'aide du type d'expression suivant :

   ${skill.system.event.value.application.context.<attributeName>}

   Voir Attributs de contexte d'événement pour plus d'informations sur les attributs de contexte disponibles.
6. Facultativement, remplissez la propriété ID utilisateur avec un ID pour un utilisateur spécifique que vous pouvez déterminer dynamiquement à partir du flux (par exemple, au moyen d'un composant personnalisé). Cette propriété est principalement utile si l'ID utilisateur n'est pas envoyé dans les données utiles de l'événement et si l'utilisateur est un utilisateur unifié qui a été authentifié au moyen d'une autorisation à l'aide du composant OAuth 2.0 où la propriété Associer à l'utilisateur unifié a été réglée à Vrai. Pour plus d'informations sur les utilisateurs unifiés, voir Configuration de l'identité d'utilisateur unifié.

Si l'événement doit être ciblé sur un utilisateur spécifique mais que cet utilisateur n'est pas spécifié dans l'événement lui-même, il peut être possible de déterminer l'utilisateur dans le flux qui gère l'événement. Voici les étapes générales pour que cela fonctionne :

1. Au début du flux qui gère l'événement, ajoutez un composant personnalisé qui détermine l'ID utilisateur (en fonction des données utiles de l'événement ou d'une logique personnalisée) et assigne cet ID à une variable.
2. Après l'état du composant personnalisé, insérez un composant Aviser l'utilisateur et réglez la propriété ID utilisateur de ce composant à la variable retournée par le composant personnalisé.

Pour qu'une compétence reçoive un événement, vous créez un programme de traitement d'événements pour cet événement dans le flux principal. Dans le programme de traitement d'événements, vous mappez l'événement au flux contenant l'état Aviser l'utilisateur que vous avez créé pour recevoir l'événement :

1. Dans la liste des flux, sélectionnez Flux principal.
2. Dans l'onglet Événements de ce flux, à côté de la section Événements d'application, cliquez sur .
3. Dans la boîte de dialogue Créer un programme de traitement d'événements d'application, sélectionnez le type d'événement, la version du type d'événement et le flux auquel vous voulez mapper l'événement, puis cliquez sur Fermer.
   Note
   
   Seuls les types d'événement finalisés sont offerts dans le champ Type d'événement non résolu.

Pour qu'une compétence consomme un événement externe, elle doit faire partie d'un assistant numérique. Pour ajouter une compétence configurée pour consommer un événement dans un assistant numérique :

1. Cliquez sur pour ouvrir le menu latéral, sélectionnez Development > Digital Assistants et cliquez deux fois sur l'assistant numérique à utiliser.

2. Cliquez sur Ajouter une compétence.

3. Dans la vignette de la compétence configurée pour consommer l'événement, sélectionnez .

   Si vous ne trouvez pas la compétence que vous recherchez, elle peut avoir un mode linguistique qui n'est pas compatible avec celui de votre assistant numérique. Voir Conditions pour ajouter une compétence à un assistant numérique.

4. Cliquez sur le bouton Done (Terminé) pour fermer le catalogue et afficher la page de la compétence dans l'assistant numérique.

5. Faites défiler la page vers le bas jusqu'à la section Interaction Model (Modèle d'interaction) et assurez-vous que la valeur Invocation (Appel) est le nom que vous voulez utiliser pour appeler la compétence.

   Ce nom doit respecter les directives relatives aux noms d'appel.

6. Entrez quelques exemples d'énoncés pouvant être utilisés pour appeler la compétence.

   Ces énoncés seront utilisés comme options sélectionnables dans les états d'accueil et d'aide par défaut de l'assistant numérique.

L'exemple suivant illustre l'utilisation d'un formulaire structuré pour l'envoi d'événements :

curl --location --request POST 'https://<server>/events/v2/listeners/appevent/channels/<id>' \
--header 'Content-Type: application/cloudevents+json' \
--header 'X-Hub-Signature: sha256=<SHA256 encoded request body using the channel's secret key>' \
--data-raw \

'{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}'

async pushEvent(eventName, eventVersion, userId, channelName, eventData){
  try {

    // Build event data
    const event = {
      specversion: "1.0",           //Version # of Digital Assistant's Events support
      type: eventName, // Name of Event you created in ODA
	  source: "< event source>",    //URI-reference - identifies the context in which an event happened
      id: "<event id>",             //Unique id for the event
      time: "2022-09-07T21:19:24Z", // Any Date value will do now
      channelname: <channelName>,   // Can be set to System_Global_Test if you want to test in tester
      version: <eventVersion>, // version of the event that you defined in Digital Assistant
      userid: <userId>,
      datacontenttype: "application/json",
      data: <eventData> // JSON object represting your payload which should confirm to the event's JSON schema
    };

    // Build Required headers
    const headers = {
      "X-Hub-Signature" : this._buildSignatureHeader(event, <EVENTS_CHANNEL_SECRET_KEY> , "utf8"),
      "Content-Type" : "application/cloudevents+json"
    };

    // POST to EVENT_LISTENER_CHANNEL_URL
    ....
    
  } catch (error) {
    logger.error(error.message);
    const errorMessage = `Error pushing event [ ${eventData} ] to Digital Assistant`;
    logger.debug(errorMessage);

    throw new Error(error.message);	
  }
}



_buildSignatureHeader(body, secret, encoding) {
  const buf = Buffer.from(JSON.stringify(body), "utf8");
  return "sha256=" + this._buildSignature(buf, secret, encoding);
}

_buildSignature(buf, secret, encoding) {
  const hmac = crypto.createHmac("sha256", Buffer.from(secret || "", encoding || "utf8"));
  if (buf) {
    hmac.update(buf);
  }
  return hmac.digest("hex");
}

Voici les attributs communs que vous pouvez utiliser dans les données utiles d'un événement :

• specversion : (Obligatoire) Numéro de version de la prise en charge des événements de Digital Assistant. Actuellement, la seule valeur valide est 1.0.
• type : (Obligatoire) Type d'événement que la compétence écoute. Cela doit correspondre au nom du type d'événement que vous avez spécifié dans la tâche Définir un type d'événement.
• source : (Obligatoire) Identifie le contexte dans lequel un événement s'est produit. Il peut s'agir d'une chaîne à structure libre.
• id : (Obligatoire) ID unique généré pour l'événement par l'application.
• version : (Obligatoire) Nom de la version du type d'événement envoyé. Vous devez inclure une valeur pour cet attribut dans les données utiles de l'événement et il doit correspondre à la valeur que vous avez fournie pour la version de type d'événement que vous avez fournie dans la tâche Créer un programme de traitement pour l'événement externe.
  Note
  
  Cet attribut est l'un des attributs d'extension, ce qui signifie qu'il ne fait pas partie de la spécification CloudEvent.
• data : (Obligatoire) Données d'affaires correspondant au schéma défini pour l'événement.

Pour chaque événement généré, Digital Assistant ajoute des attributs d'extension qui décrivent le contexte dans lequel l'événement est généré. Les outils et les codes d'application peuvent ensuite utiliser ces informations pour identifier des éléments tels que la source des événements générés et leur relation avec d'autres événements. Vous pouvez également spécifier des valeurs pour ces attributs dans les données utiles de l'événement.

Voici une liste des attributs d'extension (tous de type String) :

• version : Nom de la version du type d'événement envoyé. Vous devez inclure une valeur pour cet attribut dans les données utiles de l'événement et il doit correspondre à la valeur que vous avez fournie pour la version de type d'événement que vous avez fournie dans la tâche Créer un programme de traitement pour l'événement externe.
• userid : ID de l'utilisateur cible du message. Il peut prendre l'une des deux formes suivantes :
  • Un ID utilisateur IAM pour OCI. Dans ce cas, vous devez également inclure l'attribut usertenancy dans les données utiles.
  • ID utilisateur fourni par le canal. Dans ce cas, vous devez également inclure l'attribut channelname dans les données utiles.
    Note
    
    Pour Twilio, cette valeur correspond au numéro de téléphone cellulaire de l'utilisateur.
• usertenancy : Nom de la location IAM OIC du fournisseur d'identités de l'utilisateur.
• channelname : Nom du canal par lequel l'assistant numérique est exposé.
• tenancy : Nom de la location Oracle Cloud Infrastructure pour l'instance Digital Assistant. (En général, vous n'avez pas besoin d'inclure explicitement cet attribut, car les informations sur la location sont transmises dans les en-têtes de demande.)

{
    "specversion": "1.0",
    "type": "com.pizzastore.pizza.ordercreated",
    "source": "pizzastore/orders",
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "time": "2022-08-10T12:31:00Z",
    "contenttype": "application/json",
    "tenancy": "mydigitalassistantinstance",
    "version": "1.0",
    "data": {"size": "Large",
            "type": "Veg"
          }
}

Si vous devez transmettre l'ID utilisateur IAM OCI pour l'utilisateur dans les données utiles, vous spécifiez également les attributs userid et usertenancy :

{
    "specversion": "1.0",           //Version # of Digital Assistant's Events support
    "type": "<event_name>",         //The event type that the skill is listening for
    "source": "< event source>",    //URI-reference - identifies the context in which an event happened
    "id": "<event id>",             //Unique id for the event
    "version":"<event version>",    //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<IAM user id>",      //An extension attribute(not part of CloudEvent spec) for the user ID  
    "usertenancy":<IAM tenancy>",  //Extension attribute, IAM
    "data": {                       //The business data that matches with the schema defined for the event  
           
          }
}

Pour les assistants numériques exposés au moyen des canaux Twilio et Web, l'application externe peut également aviser les utilisateurs en spécifiant le nom du canal et l'ID utilisateur fourni par le canal.

{
    "specversion": "1.0",            //Version # of Digital Assistant's Events support
    "type": "<name_of_event_type>",  //The event type that the skill is listening for
    "source": "< event source>",     //URI-reference - identifies the context in which an event happened
    "id": "<event id>",              //Unique id for the event
    "version":"<event version>",     //An extension attribute(not part of CloudEvent spec) for the version # of the event type
    "userid":"<channel user id>",    //An extension attribute(not part of CloudEvent spec) for the user ID
    "channelname":"<channel name>",  //Name of the channel through which the digital assistant is exposed
    "data": {                        //The business data that matches with the schema defined for the event  
           
          }
}