Interfaz del Editor de conectores en detalle

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Asistente de Procesos > Integrar > Integración con aplicaciones > Integrar APIs o código personalizado en Bizagi > Conectores de Bizagi > Crear conectores >

Interfaz del Editor de conectores en detalle

Introducción

Bizagi presenta un kit de desarrollo de software el cuál le permite fácilmente crear y modificar conectores, llamado el Editor de Conectores

El Editor de Conectores únicamente requiere de un navegador y de conexión a Internet (www.Bizagi.com como sitio seguro).

Recuerde que existen 2 tipos de conectores: Asistidos REST que no requieren de código (acercamiento preferido), y los Personalizados que le permiten incluir librerías de terceros e implementar su propio código.

Para mayor información sobre estos conceptos, consulte Crear conectores.

 

ConnectorEditor_start

 

Beneficios principales

A través del Editor de Conectores usted podrá crear conectores de manera asistida, iniciando de una plantilla con lo básico.

Los beneficios principales que le permiten agilizar el proceso de implementación de sus requerimientos puntuales de integración son:

 

1.Apoyarse en opciones poderosas como por ejemplo: la posibilidad de importar librerías de terceros, el uso del API de Bizagi de inmediato, o poder empaquetar y descargar su conector final.

2.Aprovechar al máximo una interfaz gráfica de usuario que es amigable y le permite definir fácilmente la estructura de entradas, salidas o de manejo de error.

 

Acceso al Editor de Conectores

Utilice el navegador de su elección para acceder en línea al Editor de Conectores, ingresando la siguiente URL:

http://connector.bizagi.com 

 

Comenzando a utilizar el Editor de Conectores

En las opciones iniciales, con el Editor de Conectores podrá fácilmente iniciar:

Creando un conector Asistido REST.

Creando un conector Personalizado.

Abriendo un conector existente.

 

Creando un conector Asistido REST

Cree un nuevo conector, al seleccionar la opción marcada como fácil (Easy):
 

ConnectorEditor_REST00

 

De esta manera podrá ingresar los detalles generales del conector nuevo:

 

ConnectorEditor_REST01

 

OPCIÓN

DESCRIPCIÓN

Ícono (Icon)

El ícono que enseña el conector (opcional) que podrá ser cargada o modificada en cualquier momento de la creación del conector por el usuario.

Este ícono se enseña al configurarlo desde Bizagi Studio.

Nombre (Name)

 

El nombre del conector (obligatorio) que identifica al conector de cara al usuario.

Podrá ser modificado en cualquier momento de la creación del conector.

Autor (Author)

 

El nombre del autor (opcional) que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

Sitio web (Website)

 

La URL del sitio web del autor (opcional), que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

Descripción (Description)

 

Una descripción significativa sobre las acciones que realiza el conector (opcional), que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

Métodos de autenticación (Authentication Methods)

 

El método o conjunto de métodos de autenticación que soporta el conector (opcional) y que podrán ser modificados en cualquier momento de la creación del conector por el usuario.

Para información detallada acerca de las opciones de autenticación, consulte los Métodos de autenticación y conectores REST.

 

Una vez que haya identificado las propiedades básicas de su nuevo conector, dé clic sobre el botón de Crear (Create).

Las opciones que se presentan a continuación en el área de trabajo, serán únicamente las relevantes a los conectores de tipo Asistido REST.

Consulte las siguientes secciones para conocer a detalle estas opciones del área de trabajo.

 

Creando un conector Personalizado

Cree un nuevo conector, al seleccionar la opción marcada como Experto (Expert):
 

ConnectorEditor_Custom00

 

De esta manera podrá ingresar los detalles generales del conector nuevo:

 

ConnectorEditor_Custom01

 

OPCIÓN

DESCRIPCIÓN

Ícono (Icon)

El ícono que enseña el conector (opcional) que podrá ser cargada o modificada en cualquier momento de la creación del conector por el usuario.

Este ícono se enseña al configurarlo desde Bizagi Studio.

Nombre (Name)

 

El nombre del conector (obligatorio) que identifica al conector de cara al usuario.

Podrá ser modificado en cualquier momento de la creación del conector.

Autor (Author)

 

El nombre del autor (opcional) que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

Sitio web (Website)

 

La URL del sitio web del autor (optional), que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

Descripción (Description)

 

Una descripción significativa sobre las acciones que realiza el conector (opcional), que podrá ser modificado en cualquier momento de la creación del conector por el usuario.

 

Una vez que haya identificado las propiedades básicas de su nuevo conector, dé clic sobre el botón de Crear (Create).

Las opciones que se presentan a continuación en el área de trabajo, serán únicamente las relevantes a los conectores de tipo Personalizado.

Consulte las siguientes secciones para conocer a detalle estas opciones del área de trabajo.

 

Abriendo un conector existente

Al haber descargado un conector como archivo .bizc (por ejemplo, desde el Connector Xchange para modificar y personalizarlo), usted podrá abrirlo y realizar cambios (produciendo una nueva versión).

Para abrirlo, utilice la opción de Abrir el conector que se enseña a continuación:

 

ConnectorEditor_open

 

 

Al abrir el conector, el Editor de Conectores automáticamente identificará si su conector es de tipo Asistido REST o Personalizado, y así abrir la interfaz de usuario apropiada.

El detalle de ese conector se enseñará igualmente y podrá ser modificado.

 

note_pin

Considere:

Bizagi no guarda su trabajo en progreso. Por lo tanto, recuerde descargar el conector antes de cerrar el Editor de Conectores, para tener el progreso almacenado localmente.

Usted podrá cargar conectores así no esté finalizada su implementación.

Si crea un nuevo conector a partir de uno existente (modificándolo), asegúrese de no reutilizar las acciones sino que debe crear nuevas a su interior.

 

 

Opciones de la interfaz del Editor en detalle

Sea al momento de crear un nuevo conector, o al abrir uno existente para realizar modificaciones, el área de trabajo presentará las siguientes opciones dependiendo del tipo de conector (algunas opciones aplican exclusivamente al conector Asistido REST mientras que otras lo hacen para el Personalizado).

 

1. Información general del conector

Contiene información general del conector -incluyendo la que se definió desde su creación como lo son ícono, nombre, versión, autor, sitio web o descripción  (icon, name, version, author, website URL, description).

Esta información la puede modificar en cualquier momento.

 

Para conectores Asistidos REST, usted podrá notar que el método de Autenticación (Authentication method) se enseña:

 

Easy01

 

Para conectores Personalizados, el método de Autenticación no es aplicable (Authentication method):

 

Expert01

 

2. Acciones y área de trabajo

Despliega las acciones definidas para el conector mientras se muestran sus propiedades.

El panel de la mano izquierda lista las acciones y le permite administrarlas (crear nuevas o eliminarlas).

 

Nótese que para conectores Asistidos REST, usted podrá identificar fácilmente las acciones que usan un método HTTP de tipo GET, POST, PUT o DELETE (según su color verde, naranja, azul o rojo respectivamente).

 

Easy03

 

Para conectores Personalizados, estos tipos de método HTTP no son aplicables visualmente dado que usted se encarga de implementar cómo invoca un servicio.

 

Expert03

 

Al seleccionar una acción, el área de trabajo hacia la derecha enseña los detalles de implementación para esa acción.

Para los conectores Personalizados, donde los detalles de la implementación implican el mismo código de la acción:

 

Expert02

 

Para ambos tipos de conectores, la parte baja de la derecha enseñará puntualmente las propiedades (properties), entradas (inputs) y salidas (outputs).

 

3. Propiedades

Despliega las características relevantes para cada acción, las cuales podrá modificar en cualquier momento.

Para los conectores Personalizados, esto significa principalmente el nombre y la descripción de la acción dado que la implementación completa es via código personalizado (como se ilustró anteriormente).

 

Para los conectores Asistidos REST, este panel incluye:

Nombre (Name): El nombre para mostrar de la acción.

URL: La URL de servicio donde la acción está disponible (como un servicio REST). Asegúrese de utilizar los siguientes corchetes dos veces: { }, para encerrar la variable que será dinámica y configurable para la ejecución (por ejemplo, {{su_parametro}} ).

Método HTTP (HTTP method): GET, POST, PUT, o DELETE. Nótese que únicamente para métodos POST o PUT la configuración de entradas será aplicable.

Descripción (Description): Un texto descriptivo.

Content type: Seleccione de acuerdo a cómo el servicio externo maneja la información, a manera de:

oapplication/json

oapplication/x-www-form-urlencoded

otext/plain

Uso de autenticación (Use authentication): Prenda la propiedad para habilitar que esa acción utiliza la autenticación especificada para el conector.

 

Easy02

 

4. Entradas y salidas

La definición para entradas se realiza igual que la definición para la salidas de las acciones.

Esto significa que usted debe definir la estructura jerárquica (compatible a un formato JSON) que sigue la información de entrada y de salida para ese sistema externo.

Recuerde que para métodos HTTP de tipo GET o DELETE en conectores Asisitidos REST, no hay definición de entradas.

 

Easy04

 

Para construir una definición, utilice el ícono Easy05 que le permite adicionar nodos del tipo Objeto (Object).

Nótese que podrá definir para cada elemento de información si su ocurrencia es única (tipo single) o múltiple (tipo list)

 

note_pin

Los tipos de datos definidos deben corresponder a los que utiliza su sistema externo, usualmente consultable desde la documentación del API de ese sistema.

Los posibles tipos de datos simples son:

Boolean

Byte

Date

Decimal

Double

Integer

String

 

Los tipos de datos que no son simples sino que son complejos, deben ser definidos como Object, de forma que puedan contener a su vez a otros elmeentos que serán datos simples o complejos anidados.

 

5. Librerías (aplica a conectores Personalizados)

Administra las librerías en uso del connector (importadas) .

Nótese que estas librerías (junto con otras dependencias internas que a su vez cada librería use), usted las podrá visualizar en la lista, incluyendo la librería por defecto que proporciona Bizagi para todos los conectores (bz-util):

 

Expert04

 

Nótese que aunque esta opción importa una librería (será empaquetada dentro del conector), usted igualmente debe incluir la linea de código donde se referencia esa librería (es decir, de manera análoga a un import o using de la programación en Java o C# respectivamente).

 

6. Parámetros globales (aplica a conectores Personalizados)

Le permite especificar en general, los parámetros de la conectividad (connector), de autenticación (authentication) o para manejo de error (errors) que utilizará su conector para cualquier cantidad de acciones.

 

Expert05

 

Administre estos parámetros adicionando nuevos, eliminándolos o editando su nombre, valor por defecto, si son requeridos o si se muestran protegidos en Bizagi Studio (name, default value, required y propiedad encrypted).

 

Nótese que para los parámetros de tipo Connector, usted podrá definir una lista de valores.

Para hacerlo, ingrese cada uno de los posibles valores en el campo de valor por defecto (default value) y presionando Enter después de cada uno:

 

Expert06

 

La definición de parámetros de error, le permite definir un listado conocido de errores para un mejor manejo de excepciones dentro de la lógica de su propio conector.

Al definir un nuevo código único y mensaje de error (para poderlo utilizar dentro de su implementación posteriormente), tenga en cuenta que Bizagi ya provee por defecto una serie de códigos de errores comunes para su uso.

 

ConnectorErrors

 

No deberá nombrar nuevos errores con los códigos de errores ya existentes, que se listan a continuación:

GLB.EXCEPTION

GLB.IS_NOT_A

GLB.IS_NOT_AN

GLB.UNKNOW_ACTION

GLB.RESOURCE_REDIRECT

GLB.RESOURCE_NOT_FOUND

GLB.RESPONSE_ERROR

VAL.REQUIRED_PARAM

VAL.REQUIRED_ELEMENT

VAL.REQUIRED_PARAMS

VAL.PARAM_TYPE

 

Opciones adicionales y recomendaciones

Considere las siguientes recomendaciones:

 

1. Guarde periódicamente su trabajo, utilizando la opción de Gurdar (Download).

Esta opción guarda una copia local del archivo del conector .bizc, de manera que usted pueda re-abrir en cualquier momento dicho conector con las opciones del Editor de Conectores, ya sea en la misma máquina o en otra.

 

DownloadButton

 

Nótese que es recomendable ya que si usted se sale de la página y navega a otra, perderá el trabajo que no haya guardado.

 

2. Maximice su área de trabajo si lo desea.

Al utilizar el área de trabajo, nótese que podrá ajustar el tamaño de cada panel u optar por esconderlo.

Para esconder o reabrir cada panel, haga clic en las lineas divisorias, específicamente donde lo resalta la imagen a continuación:

 

dashboard_patch_B_frame_size

 

Estas lineas divisorias se visualicen en el borde de la ventana de manera que en cualquier momento puede restaurar el panel a su tamaño/posición original.

Existe un atajo de teclado para esta opción, la cuál es CTRL + <Flecha>, donde la <Flecha> indica la posición del panel que se desea esconder/restaurar.

El atajo no está disponible si el foco está en un campo de texto.