Actividades HTTP¶
Introducción¶
Una actividad HTTP recupera datos o envía datos a un extremo HTTP y está destinada a usarse como fuente para proporcionar datos a una operación o como destino para consumir datos en una operación. Las actividades HTTP también se pueden llamar en secuencias de comandos. Después de configurar una conexión HTTP, puede configurar tantas actividades HTTP como desee para cada conexión HTTP. Las actividades HTTP se pueden configurar para utilizar métodos estándar como GET, PUT, POST o DELETE, o se pueden configurar para utilizar una acción personalizada.
El hecho de que la actividad se pueda utilizar como origen o destino en una operación o secuencia de comandos depende del servicio web específico y de las estructuras de solicitud y respuesta, si están presentes. Para obtener más información sobre lo que determina si una actividad se puede utilizar como origen o destino, consulte Partes de una operación en Creación y configuración de operaciones.
Nota
Una versión beta de Jitterbit HTTP v2 (Beta) también está disponible un conector (un conector de aplicación). Para obtener más información, consulte Consideraciones sobre el conector basado en REST.
Crear una Actividad HTTP¶
Una instancia de una actividad se crea a partir de una conexión utilizando un tipo de actividad.
Para crear una instancia de una actividad, arrastre el tipo de actividad al tela de diseño o cópielo y péguelo en el tela de diseño. Para obtener más información, consulte Creación de una instancia de actividad en Reutilización de componentes.
Una actividad existente se puede editar desde estas ubicaciones:
- El tela de diseño (consulte Menú de acciones del componente en Tela de Diseño).
- La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña Componentes del panel de proyecto).
Configurar una Actividad HTTP¶
Siga estos pasos para configurar una actividad HTTP, incluidas actividades GET, PUT, POST, DELETE o personalizadas:
- Paso 1: Ingrese un nombre, seleccione el verbo HTTP y especifique la configuración
- Paso 2: Proporcionar el esquema de solicitud
- Paso 3: Proporcionar el esquema de respuesta
- Paso 4: revisar los esquemas de datos
Paso 1: Ingrese un Nombre, Seleccione el Verbo HTTP y Especifique la Configuración¶
Consejo
Campos con un ícono de variable Ícono de variable admite el uso de variables globales, variables del proyecto, y variables de Jitterbit. Comience escribiendo un corchete abierto [
en el campo o haciendo clic en el icono de variable para mostrar una lista de las variables existentes para elegir.
-
Nombre: Introduzca un nombre que se utilizará para identificar la actividad HTTP. El nombre debe ser único para cada actividad HTTP GET, PUT, POST, DELETE o personalizada y no debe contener barras diagonales (
/
) o dos puntos (:
). -
Verbo HTTP: Se muestra el verbo HTTP del tipo de actividad para una actividad GET, PUT, POST o DELETE. El verbo HTTP no se puede cambiar. Este campo no está presente para una actividad HTTP personalizada.
Nota
Para una POST HTTP utilizada como fuente, se publica una solicitud vacía en la URL y la respuesta se utiliza como fuente.
Para un HTTP POST utilizado como destino, se puede incluir prácticamente cualquier tipo de carga útil, pero el servidor web que la recibe debe entenderla. Se devuelve una respuesta basada en la solicitud HTTP y Jitterbit Harmony la analiza. Si la respuesta indica éxito, no se hace nada más. Si se recibe un mensaje de error, se utiliza como parte del proceso de registro de errores para la operación y se informa en registros de operación.
-
Verbo personalizado: Ingrese el verbo personalizado (por ejemplo, PATCH) en el cuadro de texto. Este campo está presente solo para una actividad HTTP personalizada.
-
Ruta: Ingrese una ruta y/o parámetros de consultar que deben agregarse a la URL base que se especificó en la configuración de la conexión HTTP. Si proporciona parámetros de consultar, especifíquelos como lo haría en un navegador web, como
/queryrecord?id=10
. -
URL: La URL creada como una concatenación de la URL base y la ruta ingresada anteriormente se proporciona como referencia. Para editar la URL, realice cambios en la URL base en la conexión HTTP o a la ruta ingresada arriba.
-
Parámetros de solicitud: Haga clic en el botón Agregar para agregar una línea y luego ingrese un Nombre y un Valor específicos para los parámetros solicitados. Haga clic en el botón Eliminar para eliminar una línea existente. Los parámetros de solicitud proporcionados se codificarán automáticamente en URL.
-
Solicitar encabezados: Haga clic en el botón Agregar para agregar una línea y luego ingrese un Nombre y un Valor específicos para la información del encabezado solicitado. Haga clic en el botón Eliminar para eliminar una línea existente.
-
Guardar y salir: Si está habilitado, haga clic para guardar la configuración para este paso y cerrar la configuración de la actividad.
-
Siguiente: Haga clic para almacenar temporalmente la configuración para este paso y continuar con el siguiente. 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: Proporcione el Esquema de Solicitud¶
-
Proporcionar esquema de solicitud: El esquema de solicitud define la estructura de los datos de la solicitud que utiliza la actividad HTTP. Si se requiere un esquema de solicitud depende de si la actividad se utiliza como objetivo de una transformación y si el servicio web espera datos de solicitud estructurados (consulte Uso del esquema). Para obtener instrucciones sobre cómo completar esta sección de configuración de actividad, consulte Esquemas definidos en una actividad.
-
Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.
-
Siguiente: Haga clic para almacenar temporalmente la configuración para este paso y continuar con el siguiente. 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 3: Proporcione el Esquema de Respuesta¶
-
Proporcionar esquema de respuesta: El esquema de respuesta define la estructura de los datos de respuesta que utiliza la actividad HTTP. Si se requiere un esquema de respuesta depende de si la actividad se utiliza como fuente de una transformación y si el servicio web devuelve datos de respuesta estructurados (consulte Uso del esquema). Para obtener instrucciones sobre cómo completar esta sección de configuración de actividad, consulte Esquemas definidos en una actividad.
-
Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.
-
Siguiente: Haga clic para almacenar temporalmente la configuración para este paso y continuar con el siguiente. 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 4: Revisar los Esquemas de Datos¶
-
Esquema de datos: Si se proporciona durante la configuración de la actividad, se muestran los esquemas de datos de solicitud y/o respuesta. Si la operación utiliza una transformación, los esquemas de datos se muestran nuevamente más adelante durante la asignación de transformación proceso, donde puede asignar campos de destino utilizando objetos de origen, secuencias de comandos, variables, valores personalizados y más. También puede definir esquemas directamente en una transformación.
-
Agregar complemento(s): Los complementos son aplicaciones de Jitterbit o proporcionadas por el usuario que amplían las capacidades nativas de Harmony. Para aplicar un complemento a la actividad, haga clic para expandir esta sección y seleccione la casilla de verificación junto al complemento que se utilizará. Para obtener instrucciones adicionales sobre el uso de complementos, incluidos detalles sobre cómo configurar las variables requeridas utilizadas por el complemento, consulte Complementos agregados a una actividad.
-
Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.
-
Terminado: Haga 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, 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.
Variables de Jitterbit Que Afectan el Envío HTTP¶
El sistema Jitterbit Harmony define ciertas variables globales que siempre están disponibles a lo largo de un proyecto, conocidas como variables Jitterbit o variables globales predefinidas. Las variables Jitterbit que se enumeran a continuación son particularmente útiles para actividades HTTP. Para obtener más información sobre el uso de variables Jitterbit, consulte Variables Jitterbit.
Estas variables de Jitterbit afectan la forma en que se realizan los envíos de fuentes HTTP:
jitterbit.source.max_redirs
jitterbit.source.http.ssl_cert_id
jitterbit.source.http.transfer_timeout
Estas variables de Jitterbit afectan la forma en que se realizan los envíos de destino HTTP:
jitterbit.target.http.form_data
jitterbit.target.http.form_data.ContentType
jitterbit.target.http.form_data.filename
jitterbit.target.http.form_data.name
jitterbit.target.http.max_redirs
jitterbit.target.http.remove_trailing_linebreaks
jitterbit.target.http.ssl_cert_id
jitterbit.target.http.transfer_timeout
Próximos Pasos¶
Después de configurar una actividad HTTP, puede usarla dentro de una operación o secuencia de comandos como se describe a continuación. Es posible que también desee configurar la fragmentación de datos para dividir los datos en porciones más pequeñas para su procesamiento.
Completa la Operación¶
Después de configurar una actividad HTTP, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de operación de una operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en diferentes flujos de trabajo.
Una vez que se ha creado una actividad HTTP, se puede acceder a las acciones del menú para esa actividad desde el panel del proyecto en las pestañas Flujos de Trabajo o Componentes, y desde el tela de diseño. Consulte Menú de acciones de actividad para detalles.
Los patrones de operación con las que se pueden usar las actividades HTTP dependen de si la actividad proporciona datos (como fuente) o recibe datos (como destino) en una operación, como se describe a continuación en Usado como fuente y Usado como objetivo.
Aunque es típico que las actividades GET se utilicen como fuente y que las actividades PUT, POST y DELETE se utilicen como destino, es posible utilizar una actividad GET como destino y utilizar PUT, POST y DELETE. actividades como fuentes. Si el servicio web específico proporciona esquemas de solicitud o respuesta para cada método determina si una actividad se puede utilizar como origen o destino, como se describe en Partes de una operación en Creación y configuración de operaciones.
Nota
Cuando una actividad HTTP GET se utiliza como Actividad de destino 1 / Actividad de origen 2 en el Patrón de archivo HTTP de dos objetivos, la actividad devuelve un mensaje indicando éxito {"success": true}
o fracaso {"success": false}
en lugar de la respuesta real.
Cuando esté listo, desplegar y ejecute la operación y valide el comportamiento comprobando los registros de operación.
Utilizado Como Fuente¶
Las actividades HTTP que se utilizan como origen se pueden utilizar con estos patrones de operación:
- Patrón de archivo
- Patrón de Transformación
- Patrón de archivo de dos objetivos (solo como primera fuente)
- Patrón de archivo HTTP de dos objetivos (como primera o segunda fuente)
- Patrón de dos transformaciones (solo como primera fuente)
- Patrón de destino masivo de Salesforce
Otros patrones no son válidos utilizando actividades HTTP que se utilizan como fuente.
Un caso de uso típico que utiliza una actividad HTTP como fuente es utilizar una actividad HTTP GET en el Patrón de Transformación. En este ejemplo, la actividad HTTP GET (GET Request) proporciona los datos dentro de la operación, que luego se reciben mediante la transformación (HTTP a Variable). La actividad de escritura variable (Write Response) se utiliza como destino, recibiendo datos dentro de la operación. Luego, el secuencia de comandos Write to Operation Log registra un mensaje:
Utilizado Como Objetivo¶
Las actividades HTTP que se utilizan como destino se pueden utilizar con estos patrones de operación:
- Patrón de archivo
- Patrón de Secuencia de Comandos
- Patrón de Transformación
- Patrón de archivo de dos objetivos (solo como segundo objetivo)
- Patrón de archivo HTTP de dos objetivos (como primer o segundo objetivo)
- Patrón de dos transformaciones (solo como segundo objetivo)
- Patrón de origen masivo de Salesforce
Otros patrones no son válidos utilizando actividades HTTP que se utilizan como destino.
Un caso de uso típico que utiliza una actividad HTTP como destino es utilizar una actividad POST HTTP para recuperar un token REST y escribir esa respuesta en una variable global para usarla en una operación abajo en la cadena.
En este ejemplo, en la operación Get Token, la transformación (Format JSON) crea una estructura de solicitud que se pasa a la actividad HTTP POST (POST), que luego se escribe en una variable mediante una actividad de escritura variable (Write Token).
Si la operación Inbound Get Token se realiza correctamente, se ejecuta la operación Parse Token. Una actividad de lectura de variable (Read Token) genera una estructura de respuesta que recibe la transformación (Parse Response JSON).
Uso de Actividades HTTP en Secuencias de Comandos¶
También se puede hacer referencia a las actividades HTTP en un secuencia de comandos para usar con funciones de secuencia de comandos que utilizan un sourceId
o targetId
como parámetro, incluidos estos:
Funciones Jitterbit
ArchiveFile
Base64EncodeFile
DBLoad
DBWrite
DeleteFile
DeleteFiles
DirList
FileList
FlushAllFiles
FlushFile
ReadFile
SfLookupAllToFile
WriteFile
Funciones Jitterbit de JavaScript
Para obtener más detalles sobre cómo hacer referencia a actividades en secuencias de comandos, consulte Extremos en Jitterbit Script o Extremos en JavaScript.
Usar Fragmentación¶
Muchas APIs de servicios web tienen limitaciones de tamaño. Si se encuentra con límites de registros impuestos por la API, es posible que desee utilizar fragmentación de datos para dividir los datos de origen en múltiples fragmentos. Luego, la transformación se realiza en cada fragmento por separado, y cada fragmento de origen produce un fragmento de destino. Los fragmentos de objetivo resultantes se combinan para producir el objetivo final.
Para obtener instrucciones y mejores prácticas sobre el uso de fragmentación de datos, consulte Opciones de operación.