{
   "$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 brique réponde à l'événement, vous ajoutez un flux pour cet événement et utilisez un état Notifier l'utilisateur pour afficher un message lorsque l'événement se produit :

1. Dans la brique à utiliser pour l'événement, cliquez sur , puis sur + Ajouter un flux.
2. Saisissez un nom de flux et cliquez sur Créer.
3. Cliquez sur le menu dans le démarrage du flux, puis sur Ajouter un état de début pour ouvrir la boîte de dialogue Ajouter un état.
   
   
   
   
4. Sélectionnez Intégration de service > Notifier l'utilisateur, indiquez le nom de l'état, puis cliquez sur Insérer.
5. Dans l'inspecteur de propriétés de l'état Notifier l'utilisateur inséré, sélectionnez l'onglet Composant et remplissez le champ Message de notification avec un message que vous souhaitez que l'utilisateur voie lorsque l'événement se produit.

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

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

   Remarque
   
   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>}

   Pour plus d'informations sur les attributs de contexte disponibles, reportez-vous à Attributs de contexte d'événement.
6. Vous pouvez éventuellement renseigner la propriété ID utilisateur avec un ID pour un utilisateur spécifique que vous pouvez déterminer dynamiquement à partir du flux (par exemple via un composant personnalisé). Cette propriété est principalement utile si l'ID utilisateur n'est pas envoyé dans la charge utile d'événement et si l'utilisateur est un utilisateur unifié qui a été authentifié via une autorisation à l'aide du composant OAuth 2.0 où la propriété Associer à un utilisateur unifié a été définie sur True. Pour plus d'informations sur les utilisateurs unifiés, reportez-vous à Configuration de l'identité d'un 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. Pour ce faire, procédez comme suit :

1. Au début du flux qui gère l'événement, ajoutez un composant personnalisé qui détermine l'ID utilisateur (en fonction de la charge utile de l'événement et/ou d'une logique personnalisée) et affectez cet ID à une variable.
2. Après l'état du composant personnalisé, insérez un composant Notifier l'utilisateur et définissez la propriété ID utilisateur de ce composant sur la variable renvoyée par le composant personnalisé.

Pour qu'une brique reçoive un événement, vous créez un gestionnaire d'événements pour cet événement dans le flux principal. Dans le gestionnaire d'événements, vous mappez l'événement avec le flux contenant l'état Notifier 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 Evénements de ce flux, en regard de la section Evénements d'application, cliquez sur .
3. Dans la boîte de dialogue Créer un gestionnaire d'événements d'application, sélectionnez le type d'événement, la version du type d'événement et le flux vers lequel mettre en correspondance l'événement, puis cliquez sur Fermer.
   Remarque
   
   Seuls les types d'événement finalisés sont proposés dans le champ Type d'événement non résolu.

Pour qu'une brique utilise un événement externe, elle doit faire partie d'un assistant numérique. Pour ajouter une brique configurée pour utiliser un événement à un assistant numérique, procédez comme suit :

1. Cliquez sur pour ouvrir le menu latéral, sélectionnez Développement > Assistants numériques, puis cliquez deux fois sur l'assistant numérique à utiliser.

2. Cliquez sur ajouter une brique.

3. Dans la mosaïque de la brique configurée pour consommer l'événement, sélectionnez .

   Si vous ne trouvez pas la brique que vous recherchez, elle peut avoir un mode de langue non compatible avec le mode de langue de votre assistant numérique. Reportez-vous à Conditions d'ajout d'une brique à un assistant numérique.

4. Cliquez sur le bouton Terminé pour fermer le catalogue de compétences et afficher la page de la brique dans l'assistant numérique.

5. Faites défiler la page jusqu'à la section Modèle d'interaction et assurez-vous que la valeur Appel correspond au nom que les utilisateurs doivent utiliser pour appeler la brique.

   Ce nom doit être conforme aux instructions relatives aux noms d'appel.

6. Indiquez quelques exemples de variation standard de la façon dont un utilisateur appelle la brique.

   Ces variations seront utilisées comme options pouvant être sélectionnées dans les états de bienvenue 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");
}

Les attributs suivants sont courants que vous pouvez utiliser dans une charge utile d'événement :

• specversion : (requis) numéro de version de la prise en charge des événements de l'assistant numérique. Actuellement, la seule valeur valide est 1.0.
• type : (obligatoire) type d'événement que la brique é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 de forme 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 la charge utile d'événement et elle 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 gestionnaire pour l'événement externe.
  Remarque
  
  Cet attribut fait partie de l'attribut d'extension, ce qui signifie qu'il ne fait pas partie de la spécification CloudEvent.
• data : (obligatoire) données métier 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 indiquer des valeurs pour ces attributs dans la charge utile de l'événement.

Voici la 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 la charge utile d'événement et elle 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 gestionnaire pour l'événement externe.
• userid : ID de l'utilisateur cible du message. Il peut prendre l'une des deux formes suivantes :
  • ID utilisateur OCI IAM. Dans ce cas, vous devez également inclure l'attribut usertenancy dans la charge utile.
  • ID utilisateur fourni par le canal. Dans ce cas, vous devez également inclure l'attribut channelname dans la charge utile.
    Remarque
    
    Pour Twilio, cette valeur correspond au numéro de téléphone portable de l'utilisateur.
• usertenancy : nom de la location OIC IAM du fournisseur d'identités de l'utilisateur.
• channelname : nom du canal via 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 OCI IAM de l'utilisateur dans la charge utile, vous devez également indiquer 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 via les canaux Twilio et Web, l'application externe peut également notifier les utilisateurs en indiquant le nom du canal et l'ID utilisateur fournis 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  
           
          }
}