Introducción
La configuración de interfaces en Bizagi, obedece al uso del Conector de servicios web genérico para servicios tipo SOAP o REST.
Bizagi ofrece la posibilidad de gestionar los puntos de integración en los procesos en un ambiente de pruebas o de producción que utilicen el Conector de servicios web, como se describe en Administración de sistemas externos.
|
A través de las opciones presentadas en la vista del módulo en la opción de Sistemas, en un ambiente de desarrollo usted puede definir interfaces nuevas que se integran a los procesos Bizagi, o editar la información de las existentes (esta última opción, para gestionar los ambientes de producción o de pruebas). |
Las interfaces enumeradas en un sistema, consideran tanto las que invocan un servicio web SOAP y servicios REST.
Interfaces de servicios web SOAP se identifican con este icono: 
Interfaces para servicios REST se identifican con este icono: 
Editando una interface existente
Una vez que se hayan definido interfaces ya configuradas en algún punto de los procesos, es posible también editar su información desde esta vista.
De manera similar a la creación de la misma, las opciones para editar una interface permitirán principalmente: editar o incluir las credenciales usadas en la autenticación HTTP básica, o administrar la URL del servicio.
Para localizar este grupo de interfaces, vaya a la vista de Experto y dé clic en el módulo Sistemas.
Para editar una interface existente, dé clic derecho sobre la interface y seleccione sus Propiedades.
Se le mostrará la siguiente ventana:
Tenga en cuenta que, por defecto, la nueva interface será tratada como una interfaz de servicio web SOAP (Servicio type = SOAP).
|
La edición de servicios REST contempla ciertas consideraciones al momento de editar la URL Base. Vea las consideraciones relacionadas a interfaces de servicios REST. |
Los siguientes campos se presentan:
•Nombre : Nombre único y requerido que identifica a la interface. Éste no debe contener espacios.
•Tipo de Servicio: Opciones de SOAP o REST. Al elegir resto como el tipo de servicio, no habrá campo para especificar método del servicio.
•Interfaz de propiedades de la tabla:. Un conjunto de valores de configuración orientada a entornos del proyecto (desarrollo, prueba o producción Este conjunto incluye:
Propiedad |
Descripción |
|---|---|
URL Servicio Web |
La URL de acceso al servicio. Para servicios REST, este campo tendrá la URL Base |
Nombre de usuario |
Cuando el servicio requiere autenticación HTTP básico, este nombre de usuario se requiere para el acceso al servicio. |
Contraseña |
Cuando el servicio requiera la autenticación básica HTTP, esta contraseña se requiere para el acceso al servicio. |
Dominio |
Cuando el servicio requiera autenticación HTTP básica, este campo es opcional para complementar el nombre de usuario, para el acceso al servicio. |
Umbral para registro (en seg) |
El tiempo en segundos que define un umbral de servicio esperado para la interfaz. Si la invocación supera esta definición en ejecución, entonces se registra una línea de trace en el registro .csv log en .\Temporary\SOA\Log\ de su proyecto (por defecto, queda una archivo por cada servicio web, creado como C:\Bizagi\Projects\[su_proyecto]\Temporary\SOA\Log\[su_interface]Log_1.csv). Este log es especialmente útil para el monitoreo dado que cada invocación que exceda o produzca un timeout dejará registro con el siguiente detalle: Fecha (DateTime), Descripción (ErrorDescription), idCase, Tarea (Task_Name), URL, Método (Method_Name), y Registro de tiempo (InterfaceTime) en formato MM:ss:mmm.
El valor predeterminado se establece en 30 segundos, por lo que siempre se registra si la invocación tarda más que este tiempo. |
Tiempo de espera (en seg) |
El tiempo en segundos que define el tiempo de espera para cualquier intento de invocación de una interfaz. Si la invocación supera esta definición en ejecución, se genera un error y se registra en una línea de trace en el registro. csv en .\Temporary\SOA\Log\ de su proyecto (por defecto, queda una archivo por cada servicio web, creado como C:\Bizagi\Projects\[su_proyecto]\Temporary\SOA\Log\[su_interface]Log_1.csv). Este log es especialmente útil para el monitoreo dado que cada invocación que exceda o produzca un timeout dejará registro con el siguiente detalle: Fecha (DateTime), Descripción (ErrorDescription), idCase, Tarea (Task_Name), URL, Método (Method_Name), y Registro de tiempo (InterfaceTime) en formato MM:ss:mmm.
Por defecto esta opción no se utiliza (su valor inicial es -1). La invocación hará timeout de acuerdo a esta propiedad, o la propiedad en la actividad si la invocación se realiza en una actividad asíncrona (se disparará cualquier timeout de los 2, el cual tenga el menor valor). |
Nombre del puerto |
Cuando el usuario necesita ejecutar una interfaz SOAP en la cuál, el servicio tiene diferentes puertos (p.ej, SOAP 1.1, SOAP 2.0, etc.), este campo permite al usuario escribir el nombre específico del puerto por donde se conectará el servicio. Este nombre del puerto puede ser configurado de acuerdo al ambiente en donde se ejecuta la interfaz. Los nombres de los puertos se especifican al final del WSDL del servicio:
|
Máximo de bytes del búfer |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxBufferSize del elemento bindings del archivo de configuración del Windows Communication Foundation (WCF). Establece el tamaño máximo de los encabezados SOAP. |
Máximo de memoria en el pool del búfer |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxBufferPoolSize del elemento bindings del archivo de configuración del Windows Communication Foundation (WCF). Establece la máxima cantidad permitida de memoria (en bytes). |
Máximo de caracteres permitidos en el XML |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxStringContentLength del elemento readerQuotas del archivo de configuración del Windows Communication Foundation (WCF). Establece la longitud máxima de la cadena de respuesta. |
Máximo de longitud de matriz en los datos recibidos |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxArrayLength del elemento readerQuotas del archivo de configuración del Windows Communication Foundation (WCF). Establece la longitud máxima permitida del arreglo de datos. |
Máximo de bytes permitidos por lectura |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxBytesPerRead del elemento readerQuotas del archivo de configuración del Windows Communication Foundation (WCF). Establece el máximo de bytes permitido que se retorna en cada lectura. |
Máximo de caracteres en el nombre de tabla |
Edite su valor (por incrementar) en caso de que necesite enviar información muy extensa a su servicio Web (p.e un adjunto de gran tamaño). Útil cuando se excede el límite por defecto de la cantidad de información que se permite en el envio. Corresponde al atributo maxNameTableCharCout del elemento readerQuotas del archivo de configuración del Windows Communication Foundation (WCF). Establece el numero máximo de caracteres en el nombre de una tabla. |
|
Los valores y tipos de datos de los atributos de la especificación Windows Communication Foundation (WCF) de Microsoft explicados anteriormente (por ej. correspondientes a los parámetros finales como: maxbuffersize, maxbufferpoolsize, maxstringcontentlength, maxarraylength, maxbytesperread, y maxnametablecharcount), corresponden a la definición del archivo de configuración XML como se presentan en la siguiente imagen:
Esta será la estructura que Bizagi construye para la invocación del Web Service. |
•Opciones avanzadas para la seguridad del servicio web:
Dé clic en el enlace para configurar el tipo de seguridad que se utiliza en su servicio web.
Tenga presente que esta definición difiere de las credenciales que se especifican en las propiedades anteriores (usuario, contraseña y dominio) ya que las anteriores son utilizadas principalmente para que Bizagi acceda a los recursos físicos (p.e el WSDL) de la definición del servicio web, mientras que esta configuración determinará cómo debe Bizagi autenticarse ante la ejecución del servicio web.
Las opciones que podrá editar y administrar para una interface ya definida en su ambiente son:
Opción |
Descripción |
Especificación |
|---|---|---|
Plain Header Token |
Envía el token de usuario (usernameToken) en el encabezado del mensaje SOAP de acuerdo a la especificación de WS-Security. |
Según la definición en: https://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf |
Secure Conversation Header Token |
Envía el token de usuario de acuerdo a la especificación, teniendo un certificado adecuado instalado en el cliente. |
Según la definición en: http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512 |
Basic HTTP Authentication |
Envía las credenciales que aplican cuando el end-point especificado del servicio está protegido (a nivel de autenticación básica).
Por defecto, Bizagi intentará usar este tipo de seguridad si no se especifica alguno, y se cuenta con autenticación básica a nivel del recurso (usando las credenciales definidas en las propiedades de usuario, contraseña y dominio). |
Según la definición en: |
•No generar proxy en ejecución (generarlo ahora):
•
Bizagi genera una definición (.cs, .dll) del proxy de cada servicio Web que se integra al proceso cuando éste se ejecuta sobre una plataforma .NET.
Por defecto, este proxy se genera la primera vez que se haga el look-up y se invoque el servicio durante la ejecución.
Al utilizar esta opción y si desea generarlo previamente (desde Bizagi Studio), Bizagi utilizará esta definición en ejecución en vez de generar una nueva en ese momento.
Esta opción es muy útil cuando el servicio Web en el ambiente de producción está muy restringido y sus recursos no pueden ser accedidos de manera sencilla (hay esquemas o el WSDL que tienen restricciones importantes de seguridad).
Con esta opción, puede generar el proxy a partir del WSDL configurado para otro ambiente (p.e ambiente de desarrollo).
Para hacerlo, utilice la opción Use y genérelo desde para seleccionar el ambiente a partir del cuál se generará el proxy.
|
Para la correcta ejecución al utilizar esta característica, deberá cerciorarse de que el WSDL utilizado para generar el proxy sea exactamente el mismo que se utilizará en ejecución, en dicho ambiente. |