Actividad BULK de HTTP v2

Introducción

Una actividad HTTP v2 BULK, utilizando su conexión HTTP v2, envía múltiples solicitudes a un servicio accesible a través del protocolo HTTP o HTTPS, y puede ser utilizada tanto como fuente (para proporcionar datos en una operación) como destino (para consumir datos en una operación).

Crear una actividad BULK de HTTP v2

Una instancia de una actividad HTTP v2 BULK se crea a partir de una conexión HTTP v2 utilizando su tipo de actividad BULK.

Para crear una instancia de una actividad, arrastra el tipo de actividad al lienzo de diseño o copia el tipo de actividad y pégalo en el lienzo de diseño. Para más detalles, consulta Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad HTTP v2 BULK existente se puede editar desde estas ubicaciones:

• El lienzo de diseño (consulta Menú de acciones de componentes en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (consulta Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).

Configurar una actividad BULK de HTTP v2

Sigue estos pasos para configurar una actividad HTTP v2 BULK:

• Paso 1: Ingresa un nombre y especifica configuraciones
  Proporciona un nombre para la actividad y especifica el método, la ruta, los parámetros de solicitud, los encabezados de solicitud y configuraciones adicionales.

• Paso 2: Revisa los esquemas de datos
  Se mostrarán los esquemas de solicitud o respuesta.

Paso 1: Ingresa un nombre y especifica configuraciones

En este paso, proporciona un nombre para la actividad y especifica el método, la ruta, los parámetros de solicitud, los encabezados de solicitud y configuraciones adicionales. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Menú de endpoint: Si tienes múltiples endpoints del mismo tipo de conector configurados, un menú en la parte superior de la pantalla muestra el nombre del endpoint actual. Haz clic en el menú para cambiar a un endpoint diferente. Para más información, consulta Cambiar el endpoint asignado en Pantallas de configuración.

  • Editar endpoint: Aparece cuando pasas el cursor sobre el nombre del endpoint actual. Haz clic para editar la configuración de conexión del endpoint seleccionado actualmente.

• Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad BULK de HTTP v2 y no debe contener barras diagonales / o dos puntos :.

• Configuraciones opcionales: Haz clic para expandir configuraciones adicionales opcionales:

  • Método: Especifica el método HTTP que se utilizará, uno de POST, PUT, GET, DELETE, HEAD, PATCH o OPTIONS.

  • Ruta: Ingresa una URL para usar en la actividad:

    • Si se deja en blanco, se utilizará la URL base configurada en la conexión HTTP v2 en tiempo de ejecución.
    • Si se especifica una ruta parcial, se añadirá a la URL base configurada en la conexión HTTP v2.
    • Si se especifica una URL completa, sobrescribirá la URL base configurada en la conexión HTTP v2.

    Los parámetros de solicitud se pueden incluir encerrándolos entre llaves { }. También se pueden usar parámetros de consulta (como /queryrecord?id=10).

    • URL: Muestra la URL completa que se utilizará en tiempo de ejecución.

  • Parámetros de solicitud: Haz clic en el ícono de agregar para añadir una fila a la tabla de abajo e ingresa un Nombre y un Valor para cada parámetro de solicitud. Los parámetros de solicitud proporcionados se codificarán automáticamente en URL.

Alternativamente, se pueden proporcionar parámetros de solicitud en la transformación de solicitud. Los parámetros de solicitud que no comparten una clave se envían de manera acumulativa, independientemente de dónde se especifiquen. Si la misma clave de parámetro se especifica tanto en este campo como en la transformación de solicitud, la especificada en la transformación tiene prioridad.

Para guardar la fila, haga clic en el ícono de enviar en la columna más a la derecha.

Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de editar o el ícono de eliminar .

Para eliminar todas las filas, haga clic en Limpiar todo.

• Encabezados de Solicitud: Haga clic en el ícono de agregar para agregar una fila a la tabla a continuación e ingrese un Nombre y un Valor para cada encabezado de solicitud.

  Alternativamente, los encabezados se pueden definir en otros campos de configuración de la interfaz de usuario o proporcionarse en la transformación de solicitud. Los encabezados que no comparten una clave se envían de manera acumulativa, independientemente de dónde se especifiquen.

  Si la misma clave de encabezado se especifica en múltiples lugares, se sigue este orden de precedencia:

  1. Un encabezado proporcionado en la transformación de solicitud anula todos los campos a continuación.
  2. Un encabezado proporcionado en el campo de Encabezados de Solicitud de una actividad HTTP v2 BULK (este campo) anula el resto de los campos a continuación.

  3. Un encabezado proporcionado en el campo de Encabezados de Solicitud de una conexión HTTP v2, si Enviar Encabezados de Solicitud en la Ejecución de Actividad está habilitado, tiene la menor prioridad.

     Nota

     Si un encabezado se define en múltiples ubicaciones, cada instancia del encabezado se agregará a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente los encabezados duplicados en una solicitud.

     Advertencia

     No defina manualmente los encabezados de solicitud Authorization en actividades HTTP v2 si la conexión HTTP v2 está configurada para enviar sus propios encabezados de solicitud Authorization dependiendo del tipo de autenticación seleccionado. Hacerlo resulta en la terminación de la operación y falla antes de alcanzar el punto final objetivo y se registra como un error 400 Bad Request.

     Si se requiere autenticación dinámica a nivel de actividad, configure el tipo de autenticación de la conexión a No Auth y configure los encabezados de solicitud Authorization de la actividad según sea necesario.

     Para guardar la fila, haga clic en el ícono de enviar en la columna más a la derecha.

     Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de editar o el ícono de eliminar .

     Para eliminar todas las filas, haga clic en Clear All.

     Importante

     Los campos en la tabla Request Headers muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

     Los campos en la tabla Request Headers no admiten el uso de variables para pasar JSON sin procesar. Si su caso de uso no admite definir JSON sin procesar en los campos directamente, escape el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

  4. Additional Settings: Haga clic en el ícono de agregar para agregar una fila a la tabla a continuación e ingrese un Nombre y un Valor para cada configuración adicional.

     Estas configuraciones adicionales son compatibles:

     Clave	Valor por Defecto	Tipo de Dato	Descripción
     connection-timeout	30000	Entero	El tiempo de espera de transferencia en milisegundos. Si esta configuración no se especifica, el tiempo de espera de transferencia por defecto es de 30000 milisegundos (30 segundos). Establecer en 0 para un tiempo de espera ilimitado.
     content-type	—	Cadena	El tipo de contenido de la estructura de solicitud que se espera por la API en particular. Por ejemplo, text/plain, application/json, application/x-www-form-urlencoded, etc. Si esta configuración no se especifica, no hay valor por defecto.
     max-redirect	50	Entero	El número máximo de redireccionamientos a seguir. Si esta configuración no se especifica, el valor por defecto es seguir 50 redireccionamientos. Establecer en 0 o un número negativo para evitar seguir cualquier redireccionamiento.
     trailing-linebreaks	false	Cadena	Elimina los espacios en blanco y los saltos de línea al principio y al final cuando se establece en true. Si esta configuración no se especifica o se establece en false, los datos permanecen sin cambios.

     Alternativamente, se pueden proporcionar configuraciones adicionales en la transformación de la solicitud. Las configuraciones adicionales que no comparten una clave se envían de manera acumulativa, independientemente de dónde se especifiquen. Para todas las configuraciones excepto para el tipo de contenido, si la misma clave de configuración se especifica tanto en este campo como en la transformación de la solicitud, la especificada en la transformación tiene prioridad.

     Para content-type, un valor especificado aquí tiene prioridad sobre todos los demás lugares en la interfaz de usuario donde se puede especificar el content-type. Si el content-type se especifica en múltiples lugares, se sigue este orden de precedencia:

     1. Un encabezado Content-Type proporcionado en la tabla de Configuraciones Adicionales de una actividad HTTP v2 BULK (esta tabla) anula todos los campos a continuación.
     2. El campo bodyContentType especificado en una transformación de solicitud anula los campos restantes a continuación.
     3. Un encabezado Content-Type proporcionado en el nodo headers de la transformación de solicitud anula los campos restantes a continuación.
     4. Un encabezado Content-Type proporcionado en el campo Encabezados de Solicitud de una actividad HTTP v2 BULK anula el campo restante a continuación.
     5. Un encabezado Content-Type proporcionado en el campo Encabezados de Solicitud de una conexión HTTP v2, si Enviar Encabezados de Solicitud en la Ejecución de Actividad está habilitado, tiene la menor prioridad.

     Nota

     Si un encabezado se define en múltiples ubicaciones, cada instancia del encabezado se añadirá a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente encabezados duplicados en una solicitud.

     Para guardar la fila, haga clic en el ícono de enviar en la columna más a la derecha.

     Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de editar o el ícono de eliminar .

     Para eliminar todas las filas, haga clic en Limpiar Todo.

     Importante

     Los campos en la tabla de Configuraciones Adicionales muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se llenen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

     Los campos en la tabla de Configuraciones Adicionales no admiten el uso de variables para pasar JSON sin procesar. Si su caso de uso no admite definir JSON sin procesar en los campos directamente, escape el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

  5. Ignorar error de operación en caso de código de estado no exitoso: Seleccionar para que las operaciones informen un estado exitoso incluso si se devuelve un código de estado no exitoso de la API que se está llamando. El valor predeterminado es no seleccionado.

  6. Seleccionar código de estado HTTP que se considerará exitoso en tiempo de ejecución de la operación: Seleccionar ya sea Agrupado por Clase o Granular (Entrada Manual) para considerar los códigos de estado especificados como exitosos en registros de operaciones.

     • Agrupado por Clase: Cuando se selecciona, se muestra un menú desplegable con clases de códigos de estado no exitosos que se tratarán como exitosos. Las opciones del menú desplegable incluyen Redirección 3xx, Error del Cliente 4xx, y Error del Servidor 5xx. El valor predeterminado del menú desplegable es no seleccionado.

     • Granular (Entrada Manual): Cuando se selecciona, se muestra un campo para ingresar manualmente una lista delimitada por comas de códigos de estado no exitosos que se tratarán como exitosos. Esta lista puede incluir diferentes clases de códigos de estado al mismo tiempo. El valor predeterminado del campo está en blanco.

  7. Multipart: Seleccionar para soportar solicitudes multipart/form-data al usar esquemas predeterminados. Esto es necesario para solicitudes que incluyen cargas de formularios RFC 1867.

  8. Continuar en Error: Seleccionar para continuar la ejecución de la actividad si se encuentra un error para un conjunto de datos en una solicitud por lotes. Si se encuentran errores, se escriben en el registro de operaciones.

• Guardar y Salir: Si está habilitado, haga clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea descartar los cambios.

Paso 2: Revisar los esquemas de datos

Se muestran los esquemas de solicitud o respuesta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquemas de Datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

  Nota

  Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

  Los esquemas de solicitud y respuesta predeterminados constan de estos nodos y campos:

  • Solicitud:

    Nodo/Campo del Esquema de Solicitud	Notas
    json	Formato del esquema de solicitud
    requests	Nodo de solicitudes
    item	Nodo de elementos
    request	Nodo de una solicitud específica
    root	Nodo de la raíz de una solicitud
    identifier	Identificador de la solicitud
    path	Ruta de la solicitud, sin incluir la URL base del endpoint
    headers	Nodo de encabezados
    item	Nodo de un encabezado específico
    key	Clave del encabezado
    value	Valor del encabezado
    method	Método de la solicitud
    requestParameters	Nodo de parámetros de solicitud
    item	Nodo de un parámetro de solicitud específico
    key	Clave del parámetro de solicitud
    value	Valor del parámetro de solicitud
    body	Cuerpo de la solicitud

  • Respuesta:

    Nodo/Campo del Esquema de Respuesta	Notas
    json	Formato del esquema de respuesta
    responses	Nodo de respuestas
    items	Nodo de elementos
    response	Nodo de una respuesta específica
    responseItem	Nodo de un elemento de respuesta
    identifier	Identificador de la respuesta
    headers	Nodo de encabezados
    item	Nodo de un encabezado específico
    key	Clave del encabezado
    value	Valor del encabezado
    error	Nodo de error
    statusCode	Código de estado HTTP de la respuesta
    statusMessage	Mensaje de estado de la respuesta
    details	Detalles de la respuesta
    properties	Propiedades de la respuesta
    responseContent	El cuerpo de la respuesta o carga útil de contenido
    status	Un booleano que indica si se devolvió una respuesta

• Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el endpoint HTTP v2. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

• Regresar: Haz clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

• Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Siguientes pasos

Después de configurar una actividad HTTP v2 BULK, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulta el menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades HTTP v2 BULK que se utilizan como fuente pueden ser utilizadas con estos patrones de operación:

• Patrón de transformación
• Patrón de archivo de dos objetivos (como la primera fuente únicamente)
• Patrón de archivo HTTP de dos objetivos (como la primera fuente únicamente)
• Patrón de dos transformaciones (como la primera o segunda fuente)

HTTP v2 BULK actividades que se utilizan como objetivo se pueden usar con estos patrones de operación:

• Patrón de transformación
• Patrón de dos transformaciones (como el primer o segundo objetivo)

Para usar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego utiliza esa ubicación temporal en la función de scripting.

Cuando estés listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de operación.