Saltar al contenido

Actividad API SOAP Response en Jitterbit Studio

Introducción

Una actividad SOAP Response de API, usando su conexión de API preconfigurada, devuelve datos a una API personalizada de API Manager y está diseñada para usarse como destino para consumir datos en una operación.

La actividad SOAP Response de API puede configurarse usando solo un esquema WSDL. Para interactuar con una conexión de API usando un esquema JSON, XML, CSV o XSD, utiliza una actividad API Response que no sea SOAP. Para interactuar con una conexión SOAP sin usar una API personalizada, utiliza el conector SOAP.

Para obtener información sobre la relación entre las actividades del conector de API y las API de API Manager, consulta estos recursos:

Crear una actividad API SOAP Response

Una instancia de una actividad SOAP Response de API se crea a partir de la conexión de API preconfigurada usando su tipo de actividad SOAP Response.

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 obtener más detalles, consulta Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad SOAP Response de API existente puede editarse desde estas ubicaciones:

Configurar una actividad API SOAP Response

Sigue estos pasos para configurar una actividad SOAP Response de API:

Paso 1: Ingresa un nombre y especifica la configuración

En este paso, proporciona un nombre para la actividad y selecciona el método que se usará para cargar el esquema WSDL. A continuación se describe cada elemento de la interfaz de usuario de este paso.

  • Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad SOAP Response de API y no debe contener barras inclinadas / ni dos puntos :.

  • Cargar URL, Cargar archivo o Seleccionar existente: Usa el botón de opción para seleccionar la fuente del archivo WSDL (Web Services Description Language) a cargar o reutilizar. Se pueden cargar archivos de hasta 5 MB de tamaño.

    • Cargar URL: Ingresa la URL del archivo WSDL en el cuadro de texto y luego haz clic en el botón Cargar. La URL debe ser accesible sin autenticación. Si la URL requiere autenticación o no devuelve un archivo WSDL válido, Studio muestra un error al cargar (consulta Requisitos de carga de WSDL). Si cargas un WSDL con el mismo nombre que un WSDL existente, consulta Posibles errores más adelante en esta página.

    • Cargar archivo: Usa el botón Examinar a la derecha para buscar localmente un archivo WSDL o ZIP. Un archivo ZIP puede contener cualquier archivo XSD del que dependa el WSDL. Si el archivo ZIP contiene más de un archivo WSDL, selecciona el WSDL raíz cuando se te solicite. Luego haz clic en el botón Cargar. Si la carga muestra un error de validación, consulta Requisitos de carga de WSDL. Si cargas un WSDL con el mismo nombre que un WSDL existente, consulta Posibles errores más adelante en esta página.

Nota

Cualquier schemaLocation debe resolverse a un archivo local mediante una referencia relativa. Esto normalmente significa que en lugar de proporcionar una tupla como:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'

se proporciona:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'

En el ejemplo anterior, el archivo XSD wsdlmime-2004-08-24.xsd se encuentra en el mismo directorio o en una ruta relativa al WSDL que se carga.

  • Seleccionar existente: Usa la lista desplegable para seleccionar un archivo WSDL existente que se haya utilizado anteriormente en el proyecto actual.

  • Puerto: Usa la lista desplegable para seleccionar el puerto apropiado.

  • Servicio y Vinculación: Por defecto, estos campos se completan automáticamente en función del WSDL y el puerto proporcionados y no pueden editarse.

  • Operación: Usa la lista desplegable para seleccionar el método del WSDL proporcionado que deseas ejecutar con esta actividad.

  • 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 con el siguiente. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

  • Descartar cambios: Después de hacer 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: Revisar los esquemas de datos

Se muestran los esquemas de solicitud o respuesta generados a partir del punto de conexión:

  • Esquemas de datos: Se muestran los esquemas de solicitud y respuesta para esta actividad. Estos esquemas de datos son heredados por las transformaciones adyacentes y se muestran nuevamente durante la asignación de transformación.

    Nota

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

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

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

  • Descartar cambios: Después de hacer 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.

Posibles errores

Las siguientes secciones cubren errores que pueden ocurrir durante la configuración de la actividad.

No se puede cargar WSDL

Al reemplazar un WSDL cargando uno con el mismo nombre usando Cargar URL o Cargar archivo, y si las operaciones del WSDL de reemplazo no tienen los mismos nombres que los utilizados por las actividades existentes, o si las operaciones de WSDL en uso faltan en el WSDL de reemplazo, este error puede ocurrir:

Texto del diálogo

No se puede cargar WSDL
Este WSDL no puede reemplazarse porque falta las operaciones de WSDL que utilizan las actividades existentes que se enumeran a continuación. Elimina estas actividades de la pestaña Componentes del panel del proyecto e intenta de nuevo.

  • Actividades que deben eliminarse
    Actividad 1 (API)

  • Operaciones de WSDL sin definir que estas actividades utilizan
    Operación 1

Para resolverlo, asegúrate de que las operaciones de WSDL tengan los mismos nombres que las que están actualmente en uso por las actividades existentes.

Fallo en la implementación

Al implementar una operación cuyo archivo WSDL de la actividad Solicitud SOAP ha sido reemplazado, podrías recibir este error:

Fallo en la implementación - Error del cliente: No hay ningún archivo cargado con la ruta del cliente ... Actualiza a Studio 8.4.0 o superior e implementa el proyecto nuevamente.

Para resolverlo, sigue estos pasos:

  1. Abre la actividad donde el archivo WSDL ha sido reemplazado.

  2. En el paso 1, vuelve a seleccionar el archivo WSDL que se usará para la actividad y luego haz clic en Siguiente.

  3. En el paso 2, haz clic en Finalizado.

  4. Implementa la operación.

Si en su lugar recibes Failed to deploy - Internal Error: No WSDL with locator, consulta Error de implementación de SOAP: "No WSDL with locator" en la guía de solución de problemas de conectores.

Próximos pasos

Después de configurar una actividad SOAP Response de API, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de la operación. También puedes configurar los parámetros de la operación, que incluyen la capacidad de encadenar operaciones que se encuentran en los mismos flujos de trabajo o en flujos de trabajo diferentes.

Las acciones de menú para una actividad son accesibles desde el panel de proyecto y el lienzo de diseño. Para obtener más información, consulta Activity actions menu en Connector basics.

Las actividades SOAP Response de API se pueden usar como destino con estos patrones de operación:

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

Importante

Las operaciones activadas por un API personalizada de API Manager tienen un registro adicional que se puede habilitar. Para obtener información sobre lo que aparece en los registros de operación y cómo habilitar el registro adicional, consulta Datos de solicitud y respuesta de API en Operation logs.

Configura un API Manager personalizada

Una vez que la operación esté configurada e implementada, configura un API personalizada usando API Manager.

Nota

Después de haber configurado un API personalizada para llamar a una operación de Studio, no es posible eliminar la operación sin eliminar el API o cambiar la configuración del API para que ya no llame a la operación.