{
   "$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"
      }
   }
}

Para que la aptitud responda al evento, agregue un flujo para ese evento y utilice un estado Notificar a usuario para mostrar un mensaje cuando se produzca el evento:

1. En la aptitud que desee utilizar el evento, haga clic en y, a continuación, en + Agregar flujo.
2. Introduzca un nombre de flujo y haga clic en Crear.
3. Haga clic en el menú en el inicio del flujo y, a continuación, haga clic en Agregar estado de inicio para abrir el cuadro de diálogo Agregar estado.
   
   
   
   
4. Seleccione Service Integration > Notificar a usuario, rellene un nombre para el estado y haga clic en Insertar.
5. En el inspector de propiedades para el estado Notificar a usuario insertado, seleccione el separador Componente y rellene el campo Mensaje de notificación con un mensaje que desea que el usuario vea cuando se produzca el evento.

   En el mensaje, puede utilizar expresiones con el siguiente formato para acceder a los datos del evento:

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

   Nota
   
   También puede acceder a la información de contexto desde el evento mediante el siguiente tipo de expresión:

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

   Consulte Atributos de contexto de evento para obtener información sobre los atributos de contexto disponibles.
6. De manera opcional, rellene la propiedad ID de usuario con un ID para un usuario específico que pueda determinar de forma dinámica desde el flujo (por ejemplo, a través de un componente personalizado). Esta propiedad es principalmente útil si el ID de usuario no se envía en la carga útil del evento y el usuario es un usuario unificado que se ha autenticado mediante una autorización mediante el componente OAuth 2.0, donde la propiedad Associate With Unified User se ha definido en true. Consulte Configuración de identidad de usuario unificada para obtener más información sobre los usuarios unificados.

Si el evento debe estar dirigido a un usuario específico pero ese usuario no está especificado en el evento en sí, puede ser posible determinar el usuario en el flujo que maneja el evento. Estos son los pasos generales para que esto funcione:

1. Al principio del flujo que gestiona el evento, agregue un componente personalizado que determine el ID de usuario (según la carga útil del evento y/o alguna lógica personalizada) y asigne ese ID a una variable.
2. Después del estado del componente personalizado, inserte un componente Notificar a usuario y defina la propiedad ID de usuario de ese componente en la variable devuelta por el componente personalizado.

Para que una aptitud reciba un evento, cree un manejador de eventos para ese evento en el flujo principal. En el gestor de eventos, asigne el evento al flujo que contiene el estado Notificar a usuario que ha creado para recibir el evento:

1. En la lista de flujos, seleccione Flujo principal.
2. En el separador Eventos de ese flujo, junto a la sección Eventos de aplicación, haga clic en .
3. En el cuadro de diálogo Crear manejador de eventos de aplicación, seleccione el tipo de evento, la versión del tipo de evento y el flujo al que desea asignar el evento y, a continuación, haga clic en Cerrar.
   Nota
   
   Solo se ofrecen tipos de eventos finalizados en el campo Tipo de evento no resuelto.

Para que una aptitud consuma un evento externo, debe formar parte de un asistente digital. Para agregar una aptitud configurada para consumir un evento a un asistente digital:

1. Haga clic en para abrir el menú lateral, seleccione Development > Digital Assistants y haga doble clic en el asistente digital que desea utilizar.

2. Haga clic en Agregar aptitud.

3. En el mosaico de la aptitud configurada para consumir el evento, seleccione .

   Si no encuentra la aptitud que está buscando, puede tener un modo de idioma que no sea compatible con el modo de idioma del asistente digital. Consulte Condiciones para agregar una aptitud a un asistente digital.

4. Haga clic en el botón Listo para cerrar el catálogo de aptitudes y mostrar la página de la aptitud en el asistente digital.

5. Desplácese hacia abajo, hasta la sección Modelo de interacción de la página, y asegúrese de que el valor de Llamada se corresponda con el nombre que quiera que utilicen los usuarios para llamar a la aptitud.

   Este nombre debe cumplir estas Directrices sobre el nombre de llamada.

6. Ofrezca algunas expresiones de ejemplo que un usuario utilizaría habitualmente para llamar a una aptitud.

   Estas expresiones se utilizarán como opciones seleccionables en los estados de ayuda y bienvenida por defecto del asistente digital.

En el siguiente ejemplo se muestra el uso de un formulario estructurado para enviar eventos:

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");
}

Los siguientes son atributos comunes que puede utilizar en una carga útil de evento:

• specversion: (necesario) número de versión del soporte de eventos de Digital Assistant. Actualmente, el único valor válido es 1.0.
• type: (necesario) tipo de evento que recibe la aptitud. Esto debe corresponder con el nombre del tipo de evento especificado en la tarea Definir un tipo de evento.
• source: (necesario) identifica el contexto en el que se ha producido un evento. Puede ser una cadena de formato libre.
• id: (necesario) identificador único que genera la aplicación para el evento.
• version: (necesario) nombre de la versión del tipo de evento que se está enviando. Debe incluir un valor para este atributo en la carga útil del evento y debe coincidir con el valor proporcionado para la versión de tipo de evento que ha proporcionado en la tarea Crear un manejador para el evento externo.
  Nota
  
  Este atributo es uno de los atributos de extensión, lo que significa que no forma parte de la especificación CloudEvent.
• data: (necesario) datos de negocio que coinciden con el esquema definido para el evento.

Para cada evento generado, Digital Assistant agrega atributos de extensión que describen el contexto en el que se genera el evento. Las herramientas y los códigos de aplicación pueden utilizar esta información para identificar cosas como el origen de los eventos generados y su relación con otros eventos. También puede especificar valores para estos atributos en la carga útil del evento.

A continuación, se muestra una lista de los atributos de extensión (todos del tipo String):

• version: nombre de la versión del tipo de evento que se está enviando. Debe incluir un valor para este atributo en la carga útil del evento y debe coincidir con el valor proporcionado para la versión de tipo de evento que ha proporcionado en la tarea Crear un manejador para el evento externo.
• userid: ID del usuario al que se dirige el mensaje. Puede tomar una de las dos formas siguientes:
  • ID de usuario de OCI IAM. En este caso, también debe incluir el atributo usertenancy en la carga útil.
  • ID de usuario proporcionado por el canal. En este caso, también debe incluir el atributo channelname en la carga útil.
    Nota
    
    Para Twilio, este valor sería el número de teléfono móvil del usuario.
• usertenancy: nombre del arrendamiento de IAM de OIC del proveedor de identidad del usuario.
• channelname: nombre del canal a través del cual se muestra el asistente digital.
• tenancy: nombre del arrendamiento de Oracle Cloud Infrastructure para la instancia de Digital Assistant. (Por lo general, no es necesario incluir explícitamente este atributo, ya que la información sobre el arrendamiento se transfiere en las cabeceras de solicitud).

{
    "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 necesita transferir el ID de usuario de OCI IAM para el usuario en la carga útil, también debe especificar los atributos userid y 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  
           
          }
}

Para los asistentes digitales expuestos a través de los canales de Twilio y Web, la aplicación externa también puede notificar a los usuarios especificando el nombre del canal y el ID de usuario que proporciona el 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  
           
          }
}