Invocar una Tarea API en un formulario

Cree un formulario para invocar Tarea API y asigne las variables de Tarea API a los campos necesarios del formulario.

Antes de empezar

  • Debe tener una licencia Bot Creator.
  • Primero debe crear una Tarea API para invocarlo en el formulario.
En este tema, se describe cómo invocar una Tarea API en un formulario. En este ejemplo, creará un formulario de código postal que invoque una Tarea API para recuperar los detalles del lugar y el estado en función de la entrada de código postal proporcionada. El formulario creado puede ejecutarse mediante un proceso. Puede crear un formulario con los campos específicos de su caso de uso.

Procedimiento

  1. Navegue hasta un formulario o cree uno en el que quiera invocar un Tarea API. Para obtener más información, consulte Crear un formulario.
    Póngale el nombre Formulario de código postal a este formulario.
  2. Diseñar un formulario: Utilice los elementos de formulario para crear un formulario interactivo basado en su caso de uso. En este ejemplo, el formulario está diseñado para asignar las variables de código postal de la Tarea API.
    1. Desde la columna Elementos, arrastre el elemento Área de texto y suéltelo en su diseñador de formularios.
      Aparecerá la pestaña Propiedades con los campos correspondientes en la parte derecha de la pantalla.
    2. Introduzca una Etiqueta de elemento. Por ejemplo: Código postal.
    3. Si lo desea, introduzca un valor Mín. y Máx. para el Límite de caracteres. Por ejemplo, escriba 1 en el campo Mín. y 5 en el campo Máx.
    4. Además, arrastre otros dos elementos Área de texto y nómbrelos Lugar y Estado.
    5. Desde la columna Elementos, arrastre un elemento Botón y suéltelo en su diseñador de formularios. Ingrese un nombre para este botón en el campo Texto-botón (obligatorio) (por ejemplo: Restablecer). En la siguiente imagen, se muestra un formulario completo:
      Ejemplo de tarea API de código postal
  3. Agregue las Reglas del formulario. Las reglas de formulario proporcionan las condiciones necesarias para cada elemento del formulario. Puede establecer reglas de formulario mediante las condicionessiyentoncesy especificar las acciones que se ejecutarán cuando se cumplan las condiciones. En este ejemplo, las reglas de formulario se configuran de modo que el valor del elemento de código postal sea mayor o igual que cinco. Si se cumple esta condición, el cuadro de elemento Lugar y Estado recuperará los valores de las variables de Tarea API. Durante la ejecución, la Tarea API no funcionará como se esperaba si no se cumplen las condiciones de la regla de formulario.
    1. Haga clic en la pestaña Reglas del formulario.
    2. Si lo desea, introduzca un nombre para la regla. Por ejemplo, Invocar Tarea API.
    3. Introduzca una condición Si para validar el código postal ingresado. Por ejemplo, puede comprobar si el código postal ingresado tiene un mínimo de 5 caracteres.
      Ejemplo de tarea API de código postal comprueba que tenga un mínimo de 5 caracteres.
    4. Para definir la cláusula Entonces, seleccione Acciones del formulario y, a continuación, en el menú desplegable, seleccione Obtener valor de la llamada API.
      Tarea API de código postal Condición entonces del formulario
    5. Puede asignar variables asociadas a la Tarea API a un formulario mediante la opción Agregar asignación de variables.
      Nota: Si edita una variable de Tarea API publicada y agrega variables adicionales después de haber ingresado la tarea, las variables no se mostrarán en el formulario. Debe ingresar la Tarea API después de agregar las variables
    6. Haga clic en Explorar para seleccionar un Tarea API específico a fin de realizar una operación especificada. En este ejemplo, se selecciona un Tarea API (Tarea de código postal) para recuperar el Lugar y el Estado de cualquier Código postal.
  4. Agregue una regla para el botón Restablecer. En este ejemplo, las reglas de formulario para el botón de restablecimiento se definen para borrar los valores de todos los campos al hacer clic en el botón Restablecer.
    1. Haga clic en el botón Agregar regla.
    2. Introduzca una condición Si para capturar el estado Ya se hizo clic del botón. Esta condición se cumple siempre que se pulsa el botón.
      Ejemplo de tarea API de código postal comprueba que tenga un mínimo de 5 caracteres.
    3. Para definir la cláusula Entonces, haga clic en Agregar acción y, luego, en el menú desplegable Seleccionar elemento para seleccionar todos elementos Cuadro de texto que se tienen que borrar al hacer clic en el botón Restablecer.
      Tarea API de código postal Restablecer el formulario
    4. Haga clic en el menú desplegable situado debajo de Seleccionar elemento y seleccione Borrar valor.
      Nota: Cuando invoca un Tarea API en un formulario varias veces en una sola sesión, es posible que se produzca un error. Para resolver este error, agregue un botón de restablecimiento al formulario para borrar los valores existentes.