Actividad HTTP v2 OPTIONS

Introducción

Una actividad HTTP v2 OPTIONS, utilizando su conexión HTTP v2, recupera información sobre las opciones de comunicación para un recurso en 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 objetivo (para consumir datos en una operación).

Crear una actividad HTTP v2 OPTIONS

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

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 OPTIONS 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 HTTP v2 OPTIONS

Sigue estos pasos para configurar una actividad HTTP v2 OPTIONS:

• Paso 1: Ingresa un nombre y especifica configuraciones
  Proporciona un nombre para la actividad y especifica la URL, parámetros de solicitud, encabezados de solicitud y configuraciones adicionales.

• Paso 2: Proporciona el esquema de solicitud
  Proporciona un esquema de solicitud personalizado (opcional). Si no proporcionas un esquema de respuesta personalizado, se utilizará el esquema de respuesta predeterminado del conector.

• Paso 3: Proporcionar el esquema de respuesta
  Proporcione un esquema de respuesta personalizado (opcional). Si no proporciona un esquema de respuesta personalizado, se utilizará el esquema de respuesta predeterminado del conector.

• Paso 4: Revisar los esquemas de datos
  Se muestran los esquemas de solicitud y respuesta configurados.

Paso 1: Ingrese un nombre y especifique configuraciones

En este paso, proporcione un nombre para la actividad y especifique la URL, 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.

• Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad HTTP v2 OPTIONS y no debe contener barras diagonales / ni dos puntos :.

• Ruta: Ingrese 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, anulará 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, los parámetros de solicitud se pueden proporcionar 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, haz clic en el ícono de enviar en la columna más a la derecha.

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

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

  Importante

  Los campos en la tabla de Parámetros de Solicitud 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 de Parámetros de Solicitud no admiten el uso de variables para pasar JSON sin procesar. Si tu caso de uso no admite definir JSON sin procesar directamente en los campos, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Encabezados 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 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 se especifica la misma clave de encabezado en múltiples lugares, se sigue este orden de precedencia:

1. Un encabezado proporcionado en la transformación de la solicitud anula todos los campos a continuación.
2. Un encabezado proporcionado en el campo Encabezados de Solicitud de una actividad OPTIONS de HTTP v2 (este campo) anula el resto de los campos a continuación.
3. Un encabezado proporcionado en el campo Encabezados de Solicitud de una conexión HTTP v2, si Enviar Encabezados de Solicitud en la Ejecución de la Actividad está habilitado, tiene la menor precedencia.

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.

• Configuraciones Adicionales: Haz clic en el ícono de agregar para añadir una fila a la tabla de abajo e ingresar un Nombre y un Valor para cada configuración adicional.

  Estas configuraciones adicionales son compatibles:

  Clave	Valor Predeterminado	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 predeterminado 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 particular. Por ejemplo, text/plain, application/json, application/x-www-form-urlencoded, etc. Si esta configuración no se especifica, no hay valor predeterminado.
  max-redirect	50	Entero	El número máximo de redireccionamientos a seguir. Si esta configuración no se especifica, el valor predeterminado 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 OPTIONS de HTTP v2 (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 OPTIONS de HTTP v2 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, haz clic en el ícono de enviar en la columna más a la derecha.

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

  Para eliminar todas las filas, haz 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 completen 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 tu caso de uso no admite definir JSON sin procesar en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

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

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

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

    • 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 no está 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.

      

• 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 Finalizado 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 pide que confirmes que deseas descartar los cambios.

Paso 2: Proporcionar el esquema de solicitud

En este paso, puedes proporcionar un esquema de solicitud personalizado. Si no proporcionas un esquema de solicitud personalizado, se utilizará el esquema de solicitud predeterminado del conector.

• Proporcionar Esquema de Solicitud: El esquema de solicitud define la estructura de los datos de solicitud que se utilizan en la actividad OPTIONS de HTTP v2. Para obtener 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. Si no proporciona un esquema de respuesta personalizado, se utilizará el esquema de respuesta predeterminado del conector.

• Proporcionar Esquema de Respuesta: El esquema de respuesta define la estructura de los datos de respuesta que se utilizan en la actividad OPTIONS de HTTP v2. Para obtener instrucciones sobre cómo completar esta sección de la configuración de la actividad, consulte Esquemas definidos en una actividad.

• Incluir Propiedades Adicionales de la Respuesta HTTP en el Esquema: Cuando se selecciona Sí, Usar Esquema Guardado o Sí, Proporcionar Nuevo Esquema y el esquema utilizado tiene un tipo de archivo XML o JSON, se muestra la casilla de verificación Incluir Propiedades Adicionales de la Respuesta HTTP en el Esquema. Cuando se selecciona, el esquema se envuelve dentro de una estructura definida por Jitterbit, lo que permite que parámetros adicionales sean accesibles en el esquema:

  

  JSONXML

  {
    "__jitterbit_aditional_properties__": {
      "__jitterbit_api_headers__": [
        {
          "key": "",
          "value": ""
        },
        {
          "key": "",
          "value": ""
        }
      ],
      "__jitterbit_api_statuscode__": 200,
      "__jitterbit_api_errorbody__": ""
    },
    "root": {
      // Original JSON
    }
  }
  

  <__jitterbitResponse__>
      <__jitterbit_aditional_properties__>
          <__jitterbit_api_headers__>
              <key>headerKey1</key>
              <value>headerValue1</value>
          </__jitterbit_api_headers__>
          <__jitterbit_api_headers__>
              <key>headerKey2</key>
              <value>headerValue2</value>
          </__jitterbit_api_headers__>
          <__jitterbit_api_statuscode__>200</__jitterbit_api_statuscode__>
          <__jitterbit_api_errorbody__>
          </__jitterbit_api_errorbody__>
      </__jitterbit_aditional_properties__>
      <root>
          <!-- Original XML -->
      </root>
  </__jitterbitResponse__>
  

  • __jitterbit_api_headers__: Devuelve los encabezados proporcionados por la llamada de solicitud.

  • __jitterbit_api_statuscode__: Devuelve el código de estado de la llamada de solicitud.

  • __jitterbit_api_errorbody__: Devuelve el cuerpo de respuesta de la llamada de solicitud en formato de cadena si la llamada de solicitud devuelve un código de estado no exitoso.

  • root: Alberga la estructura original del esquema de respuesta.

  Nota

  Al seleccionarse, se genera un nuevo esquema con el envoltorio. La estructura del esquema original se preserva dentro de root. Debido a que se genera un nuevo esquema para este propósito, el original sin el envoltorio se puede utilizar más tarde si es necesario.

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

• Next: 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 Finished en el último paso.

• Discard Changes: 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.

Step 4: Revisar los esquemas de datos

Los esquemas de solicitud y respuesta configurados se muestran.

• Data Schemas: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante transformation mapping.

  Si se proporcionaron esquemas personalizados en los pasos anteriores, se mostrarán. Si no se proporcionaron esquemas personalizados, se mostrarán los esquemas predeterminados incluidos con el conector.

  Para actividades de HTTP v2, los esquemas de datos se regeneran automáticamente en función de las actualizaciones realizadas a los esquemas definidos en pasos anteriores.

  Advertencia

  Las actividades de HTTP v2 creadas antes del lanzamiento de Harmony 10.85 / 11.23 pueden tener un botón de Actualizar manual presente debido a metadatos de proyecto definidos anteriormente. Si está presente, no interactúe con este botón. Cree una nueva instancia de una actividad afectada para eliminarlo.

  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
    request	Nodo de solicitud
    root	Nodo raíz
    headers	Nodo de encabezados
    item	Nodo de un encabezado específico
    key	Clave del encabezado
    value	Valor del encabezado
    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
    additionalSettings	Nodo de configuraciones adicionales
    item	Nodo de una configuración adicional específica
    key	Clave de la configuración adicional
    value	Valor de la configuración adicional
    body	Cuerpo de la solicitud
    bodyContentType	Content-Type del cuerpo de la solicitud Nota Este campo tiene prioridad sobre un encabezado Content-Type proporcionado en el nodo headers.

  • Respuesta:

    Nodo/Campo del Esquema de Respuesta	Notas
    json	Formato del esquema de respuesta
    response	Nodo de respuesta
    responseItem	Nodo del ítem de respuesta
    status	Un booleano que indica si se devolvió una respuesta
    properties	Propiedades de la respuesta
    headers	Nodo de encabezados
    item	Nodo de un encabezado específico
    key	Clave del encabezado
    value	Valor del encabezado
    responseContent	Contenido de la respuesta
    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

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar 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.

Próximos pasos

Después de configurar una actividad HTTP v2 OPTIONS, completa la configuración de la operación añadiendo y configurando otras actividades o herramientas como pasos de la 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 OPTIONS que se utilizan como fuente pueden usarse 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)

Las actividades HTTP v2 OPTIONS que se utilizan como objetivo pueden usarse con estos patrones de operación:

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

Para utilizar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego usa 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 la operación.