Actividad personalizada HTTP
Introducción
Una actividad HTTP Personalizada, utilizando su conexión HTTP, realiza un método HTTP específico en un servicio accesible a través del protocolo HTTP o HTTPS y puede ser utilizada como fuente o destino en una operación.
Importante
Con el lanzamiento del conector HTTP v2, recomendamos convertir las conexiones y actividades HTTP existentes a HTTP v2. Aprende más sobre los beneficios del conector HTTP v2 en nuestro artículo de blog sobre HTTP v2 o consulta una comparación de características entre el conector HTTP y HTTP v2.
La intención a largo plazo de Jitterbit es descontinuar el conector HTTP, lo cual se anunciará de acuerdo con la política de fin de vida de Jitterbit. En la actualidad, no hay un cronograma para la descontinuación y el conector HTTP sigue siendo totalmente compatible. Recomendamos que conviertas las conexiones y actividades HTTP existentes a HTTP v2 cuando sea posible.
Crear una actividad personalizada HTTP
Una instancia de una actividad HTTP Personalizada se crea a partir de una conexión HTTP utilizando su tipo de actividad personalizada.
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 en Reutilización de componentes.
Una actividad HTTP Personalizada 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 personalizada HTTP
Sigue estos pasos para configurar una actividad Personalizada HTTP:
-
Paso 1: Ingresa un nombre y especifica configuraciones
Proporciona un nombre para la actividad y especifica el verbo, la URL, los parámetros de la solicitud y los encabezados de la solicitud. -
Paso 2: Proporciona el esquema de la solicitud
Proporciona un esquema de solicitud personalizado. Esto puede ser necesario, dependiendo de cómo se use la actividad en una operación y lo que el servicio web espera. -
Paso 3: Proporciona el esquema de la respuesta
Proporciona un esquema de respuesta personalizado. Esto puede ser necesario, dependiendo de cómo se use la actividad en una operación y lo que el servicio web espera. -
Paso 4: Revisa los esquemas de datos
Se muestran los esquemas de solicitud y respuesta configurados (si se proporcionaron).
Paso 1: Ingresa un nombre y especifica configuraciones
Proporciona un nombre para la actividad y especifica el verbo, la URL, los parámetros de la solicitud y los encabezados de la solicitud. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
Consejo
Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes de las que elegir.
Importante
Los campos en las tablas 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.
-
Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad HTTP Personalizada y no debe contener barras diagonales
/
ni dos puntos:
. -
Verbo Personalizado: Ingresa el verbo personalizado (por ejemplo, PATCH) en el cuadro de texto.
-
Ruta: Ingresa una ruta y/o parámetros de consulta que deben ser añadidos a la URL base que se especificó en la configuración de la conexión HTTP. Si proporcionas parámetros de consulta, especifícalos como lo harías en un navegador web, como
/queryrecord?id=10
. -
URL: La URL creada como una concatenación de la URL base y la ruta ingresada arriba se proporciona como referencia. Para editar la URL, realiza cambios ya sea en la URL base en la conexión HTTP o en la ruta ingresada arriba.
-
Parámetros de Solicitud: Haz clic en el botón Agregar para añadir una línea y luego ingresa un Nombre y Valor específicos para los parámetros solicitados. Haz clic en el botón Eliminar para quitar una línea existente. Los parámetros de solicitud proporcionados se codificarán automáticamente en URL.
-
Encabezados de Solicitud: Haz clic en el botón Agregar para añadir una línea y luego ingresa un Nombre y Valor específicos para la información del encabezado solicitado. Haz clic en el botón Eliminar para quitar una línea existente.
-
Guardar y Salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.
-
Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Terminado en el último paso.
-
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 pedirá que confirmes que deseas descartar los cambios.
Paso 2: Proporcionar el esquema de solicitud
En este paso, puedes proporcionar un esquema de solicitud personalizado (opcional).
-
Proporcionar Esquema de Solicitud: El esquema de solicitud define la estructura de los datos de solicitud que utiliza la actividad HTTP. Si se requiere un esquema de solicitud depende de si la actividad se utiliza como el objetivo de una transformación y si el servicio web espera datos de solicitud estructurados (ver Uso de esquemas). Para instrucciones sobre cómo completar esta sección de la configuración de la actividad, consulte Esquemas definidos en una actividad.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
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 3: Proporcionar el esquema de respuesta
En este paso, puede proporcionar un esquema de respuesta personalizado (opcional).
-
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 la fuente de una transformación y si el servicio web devuelve datos de respuesta estructurados (ver Uso de esquemas). Para instrucciones sobre cómo completar esta sección de la configuración de la actividad, consulte Esquemas definidos en una actividad.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
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 4: Revisar los esquemas de datos
Los esquemas de solicitud y respuesta configurados (si se proporcionaron) se muestran.
-
Esquema de Datos: Si se proporcionó 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 mostrarán nuevamente más adelante durante el proceso de mapeo de transformación, donde puede mapear a campos de destino utilizando objetos de origen, scripts, variables, valores personalizados y más. También puede definir esquemas directamente en una transformación.
-
Agregar Plugin(s): Los plugins son aplicaciones proporcionadas por Jitterbit o por el usuario que amplían las capacidades nativas de Harmony. Para aplicar un plugin a la actividad, haga clic para expandir esta sección y seleccione la casilla junto al plugin que se utilizará. Para obtener instrucciones adicionales sobre el uso de plugins, incluidos los detalles sobre la configuración de cualquier variable requerida utilizada por el plugin, consulte Plugins añadidos a una actividad.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Finalizado: 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 la presentación HTTP
El sistema Harmony define ciertas variables globales que siempre están disponibles a lo largo de un proyecto, conocidas como variables de Jitterbit o como variables globales predefinidas. Las variables de Jitterbit que se enumeran a continuación son particularmente útiles para actividades HTTP. Para obtener más información sobre el uso de variables de Jitterbit, consulte Variables de Jitterbit.
Estas variables de Jitterbit afectan la forma en que se realizan las presentaciones de origen 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 las presentaciones 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
Siguientes pasos
Después de configurar una actividad HTTP personalizada, se puede utilizar dentro de una operación o script como se describe a continuación. También puede querer configurar el fragmentado para dividir los datos en partes más pequeñas para su procesamiento.
Completar la operación
Después de configurar una actividad HTTP personalizada, complete la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puede configurar la configuración de operación de una operación, que incluye la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.
Una vez que se ha creado una actividad HTTP personalizada, las acciones del menú para esa actividad son accesibles desde el panel del proyecto en las pestañas Flujos de trabajo o Componentes, y desde el lienzo de diseño. Consulte Menú de acciones de actividad para más detalles.
Los patrones de operación con los que se pueden utilizar 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 destino.
Si el servicio web específico proporciona esquemas de solicitud o respuesta para cada método determina si una actividad puede ser utilizada como fuente o destino, como se describe en Partes de una operación en Creación y configuración de operaciones.
Cuando esté listo, despliegue y ejecute la operación y valide el comportamiento revisando los registros de operación.
Usado como fuente
Las actividades HTTP que se utilizan como fuente pueden emplearse con estos patrones de operación:
- Patrón de archivo
- Patrón de transformación
- Patrón de archivo de dos destinos (como la primera fuente únicamente)
- Patrón de archivo HTTP de dos destinos (como la primera o segunda fuente)
- Patrón de dos transformaciones (como la primera fuente únicamente)
- Patrón de destino masivo de Salesforce
Otros patrones no son válidos utilizando actividades HTTP que se usan como fuente.
Usado como destino
Las actividades HTTP que se utilizan como destino pueden emplearse con estos patrones de operación:
- Patrón de archivo
- Patrón de script
- Patrón de transformación
- Patrón de archivo de dos objetivos (como el segundo objetivo únicamente)
- Patrón de archivo HTTP de dos objetivos (como el primer o segundo objetivo)
- Patrón de dos transformaciones (como el segundo objetivo únicamente)
- Patrón de origen masivo de Salesforce
Otros patrones no son válidos utilizando actividades HTTP que se usan como objetivo.
Usando actividades HTTP en scripts
Las actividades HTTP también se pueden referenciar en un script para su uso con funciones de script que utilizan un sourceId
o targetId
como parámetro, incluyendo estas:
Funciones de Jitterbit
ArchiveFile
Base64EncodeFile
DBLoad
DBWrite
DeleteFile
DeleteFiles
DirList
FileList
FlushAllFiles
FlushFile
ReadFile
SfLookupAllToFile
WriteFile
Funciones de Jitterbit en JavaScript
Para más detalles sobre cómo referenciar actividades en scripts, consulta Endpoints en Jitterbit Script o Endpoints en JavaScript.
Uso de fragmentación
Muchas API de servicios web tienen limitaciones de tamaño. Si te enfrentas a límites de registros impuestos por la API, puede que desees utilizar la fragmentación para dividir los datos de origen en múltiples fragmentos. La transformación se realiza entonces en cada fragmento por separado, con cada fragmento de origen produciendo un fragmento de destino. Los fragmentos de destino resultantes se combinan para producir el destino final.
Para instrucciones y mejores prácticas sobre el uso de la fragmentación, consulta Opciones de operación.