Integración con servicios de INTEGRADOC
Al diseñar el flujo del proceso puedes integrarlo con distintas aplicaciones ya sea a través de Integración Zapier para conectar con otras aplicaciones Web o Invocar Web Services desde el flujo del proceso o de tu propia organización.
Pero además tienes la posibilidad de invocar los servicios de la API de INTEGRADOC para interactuar con tus Bases de Datos o con otras instancias creadas.
Lo primero que debes hacer es colocar una Tarea de Servicio en la etapa del flujo donde quieras agregar la interacción y seleccionar la opción INTEGRADOC Services.
En la integración con Bases de Datos tendrás tres operaciones disponibles:
Crear un nuevo registro
Editar un registro existente
Obtener datos de un registro existente
Esta acción agregará una nueva fila a la Base de Datos seleccionada, completando cada columna con datos de los campos de tu formulario o con datos predefinidos en el servicio.
Al invocar esta operación deberás completar lo siguiente:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo (1).
Selecciona la Base de Datos a la que quieres agregar el registro ( 2 ).
En la pestaña Datos de Entrada deberás configurar la columna a completar y el campo del formulario desde donde se obtendrá el dato de origen ( 3 ). Alternativamente podrás indicar un valor fijo a cargar para toda las instancias del proceso haciendo click en el ícono del lápiz y escribiendo allí el valor fijo a cargar.
Este servicio retorna como salida el ID del nuevo registro, el cual puedes agregar opcionalmente a tu formulario desde la pestaña Datos de Salida ( 4 ).
Con esta acción podrás seleccionar el registro de la Base de Datos a editar y modificarlo con los nuevos datos de tu formulario o datos fijos para todas las instancias del proceso.
Para configurar esta integración deberás completar lo siguiente:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona la Base de Datos a la que pertenece el registro que quieres editar ( 2 ).
En la pestaña Datos de Entrada deberás configurar en primer lugar, el ID del registro y a continuación las columnas de la Base de Datos y los campos del formulario desde donde se obtendrá el dato de origen ( 3 ). Clickeando en el ícono del lápiz, podrás configurar un valor fijo a cargar para todas las instancias del proceso.
Este servicio retorna como salida el valor true si el registro se actualizó correctamente o el valor false en caso contrario. Opcionalmente puedes capturar este dato y guardarlo en un campo del formulario ( 4 ).
Ten presente que al editar un registro de Base de Datos, los valores ingresados sobreescribirán cualquier valor existente.
Si el ID seleccionado no existe puedes indicarle al servicio que agregue el dato como una nueva fila, marcando la casilla de verificación Insertar registro si no existe .
Con la acción de Obtener Registro podrás buscar dentro de una Base de Datos y guardar los valores de un registro dentro de los campos de tu formulario.
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona la Base de Datos a la que pertenece el registro que quieres buscar ( 2 ).
En la pestaña Filtro deberás configurar la columna de la Base y el valor a buscar. El valor se puede obtener de un campo del formulario o se puede elegir fijo para todas las instancias del proceso ( 3 ).
El servicio devolverá como respuesta los valores de las columnas del registro que coincida con el filtro, los cuales podrás guardar en tu formulario desde la pestaña Datos de Salida ( 4 ).
Si el filtro seleccionado obtiene como resultado más de una registro, solo se devolverán los datos del primero de ellos. Para evitar comportamientos no deseados recomendamos filtrar por alguna columna cuyos datos no se repitan (Por ejemplo: ID)
INTEGRADOC también te permite realizar acciones sobre las instancias de los procesos de tu organización. En esta integración tendrás tres operaciones disponibles:
Crear una nueva instancia de proceso
Editar una instancia existente
Obtener datos de una instancia existente
Con una simple llamada de servicio podrás crear automáticamente una instancia del mismo poceso en ejecución o de otro distinto, Para hacerlo sigue estos pasos:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso que quieres crear ( 2 ).
En Datos de Entrada podrás elegir los campos de la instancia que se cargarán automáticamente. El valor se puede obtener de un campo del formulario o se puede elegir fijo para todas las instancias del proceso ( 3 ).
El servicio devolverá como respuesta el identificador de la instancia creada y su fecha de inicio, los cuales podrás opcionalmente almacenar en tu propio formulario desde la pestaña Datos de Salida ( 4 ).
No es recomendable ubicar este servicio en el flujo inmediatamente después del Inicio del Proceso a menos que estés seguro de que no genera loops. Para más información puedes ver la sección Posibles problemas
Esta acción te permite modificar campos de instancias de tus procesos de forma automática invocando la acción en el flujo del proceso.
Recuerda que solo podrás modificar instancias ACTIVAS, es decir aquellas que aún no hayan finalizado.
Con esta acción no podrás modificar la misma instancia que se está ejecutando. En ese caso deberás utilizar el servicio ECHO de la API de INTEGRADOC. Puedes ver ejemplos de cómo usar este servicio en: Agrega una Fecha de creación a tu formulario automáticamente y Agrega una Fecha de finalización a tu formulario automáticamente o ¿Puedo asignar etiquetas de forma automática? de forma automática.
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso de la instancia que quieres modificar ( 2 ).
En Datos de Entrada se te pedirá que ingreses como primer parámetro el Identificador de la instancia que quieres modificar, referenciado en un campo de tu formulario o clikeando en el lápiz podrás escribir una referencia fija. Los siguientes parámetros serán los campos a modificar y el valor origen (desde un campo o también puede ser un valor fijo) ( 3 ).
Este servicio retorna como salida el valor true si la instancia se actualizó correctamente o el valor false en caso contrario. Opcionalmente puedes capturar este dato y guardarlo en un campo del formulario ( 4 ).
Ten presente que esta acción sobreescribe los campos de la instancia indicada.
Obtener instancia te permite acceder a los datos de una determinada instancia y guardarlos en tu formulario, simplemente con la ejecución de una tarea de servicio, y sin modificar ninguno de los datos de origen. Para configurarlo sigue estos pasos:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso de la instancia que quieres obtener ( 2 ).
En Filtro deberás ingresar como parámetro el Identificador de la instancia que quieres acceder, referenciado en un campo de tu formulario o clikeando en el lápiz podrás escribir una referencia fija ( 3 ).
En los Datos de Salida podrás elegir qué campo de la instancia obtenida (Resultado) quieres guardar en tu formulario (Campo a cargar) ( 4 ).
Para interactuar con las Bases de Datos o instancias de otra organización en INTEGRADOC, deberás invocar los servicios de la ¿Dispone INTEGRADOC de una API pública? configurando el servicio con los datos que te proporcione un Administrador de la organización.
¿Cuándo sucede?
Sucede si la primera tarea del flujo es una Tarea de Servicio que crea una nueva instancia del mismo proceso.
Descripción
En este caso cada instancia creada podría invocar al servicio creando una nueva instancia que inicia nuevamente el ciclo, generando un loop.
Este comportamiento es detectado por INTEGRADOC que te mostrará un mensaje de error y no permitirá continuar con la ejecución.
¿Cuándo sucede?
Ocurre si tu organización tiene dos procesos A y B cuya primera acción de los respectivos flujos es crear una instancia del otro proceso.
Descripción
En este caso la instancia creada del proceso A podría crear una instancia del proceso B que a su vez volvería a crear una del proceso A generando un loop.
Este comportamiento es detectado por INTEGRADOC que te mostrará un mensaje de error y no permitirá continuar con la ejecución.
Pero además tienes la posibilidad de invocar los servicios de la API de INTEGRADOC para interactuar con tus Bases de Datos o con otras instancias creadas.
¿Cómo invocar un servicio INTEGRADOC?
Lo primero que debes hacer es colocar una Tarea de Servicio en la etapa del flujo donde quieras agregar la interacción y seleccionar la opción INTEGRADOC Services.
Integración con Bases de Datos INTEGRADOC
En la integración con Bases de Datos tendrás tres operaciones disponibles:
Crear un nuevo registro
Editar un registro existente
Obtener datos de un registro existente
Crear registro
Esta acción agregará una nueva fila a la Base de Datos seleccionada, completando cada columna con datos de los campos de tu formulario o con datos predefinidos en el servicio.
Al invocar esta operación deberás completar lo siguiente:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo (1).
Selecciona la Base de Datos a la que quieres agregar el registro ( 2 ).
En la pestaña Datos de Entrada deberás configurar la columna a completar y el campo del formulario desde donde se obtendrá el dato de origen ( 3 ). Alternativamente podrás indicar un valor fijo a cargar para toda las instancias del proceso haciendo click en el ícono del lápiz y escribiendo allí el valor fijo a cargar.
Este servicio retorna como salida el ID del nuevo registro, el cual puedes agregar opcionalmente a tu formulario desde la pestaña Datos de Salida ( 4 ).
Editar registro
Con esta acción podrás seleccionar el registro de la Base de Datos a editar y modificarlo con los nuevos datos de tu formulario o datos fijos para todas las instancias del proceso.
Para configurar esta integración deberás completar lo siguiente:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona la Base de Datos a la que pertenece el registro que quieres editar ( 2 ).
En la pestaña Datos de Entrada deberás configurar en primer lugar, el ID del registro y a continuación las columnas de la Base de Datos y los campos del formulario desde donde se obtendrá el dato de origen ( 3 ). Clickeando en el ícono del lápiz, podrás configurar un valor fijo a cargar para todas las instancias del proceso.
Este servicio retorna como salida el valor true si el registro se actualizó correctamente o el valor false en caso contrario. Opcionalmente puedes capturar este dato y guardarlo en un campo del formulario ( 4 ).
Ten presente que al editar un registro de Base de Datos, los valores ingresados sobreescribirán cualquier valor existente.
Si el ID seleccionado no existe puedes indicarle al servicio que agregue el dato como una nueva fila, marcando la casilla de verificación Insertar registro si no existe .
Obtener registro
Con la acción de Obtener Registro podrás buscar dentro de una Base de Datos y guardar los valores de un registro dentro de los campos de tu formulario.
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona la Base de Datos a la que pertenece el registro que quieres buscar ( 2 ).
En la pestaña Filtro deberás configurar la columna de la Base y el valor a buscar. El valor se puede obtener de un campo del formulario o se puede elegir fijo para todas las instancias del proceso ( 3 ).
El servicio devolverá como respuesta los valores de las columnas del registro que coincida con el filtro, los cuales podrás guardar en tu formulario desde la pestaña Datos de Salida ( 4 ).
Si el filtro seleccionado obtiene como resultado más de una registro, solo se devolverán los datos del primero de ellos. Para evitar comportamientos no deseados recomendamos filtrar por alguna columna cuyos datos no se repitan (Por ejemplo: ID)
Integración con Instancias de Procesos
INTEGRADOC también te permite realizar acciones sobre las instancias de los procesos de tu organización. En esta integración tendrás tres operaciones disponibles:
Crear una nueva instancia de proceso
Editar una instancia existente
Obtener datos de una instancia existente
Crear instancia de proceso
Con una simple llamada de servicio podrás crear automáticamente una instancia del mismo poceso en ejecución o de otro distinto, Para hacerlo sigue estos pasos:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso que quieres crear ( 2 ).
En Datos de Entrada podrás elegir los campos de la instancia que se cargarán automáticamente. El valor se puede obtener de un campo del formulario o se puede elegir fijo para todas las instancias del proceso ( 3 ).
El servicio devolverá como respuesta el identificador de la instancia creada y su fecha de inicio, los cuales podrás opcionalmente almacenar en tu propio formulario desde la pestaña Datos de Salida ( 4 ).
No es recomendable ubicar este servicio en el flujo inmediatamente después del Inicio del Proceso a menos que estés seguro de que no genera loops. Para más información puedes ver la sección Posibles problemas
Editar instancia
Esta acción te permite modificar campos de instancias de tus procesos de forma automática invocando la acción en el flujo del proceso.
Recuerda que solo podrás modificar instancias ACTIVAS, es decir aquellas que aún no hayan finalizado.
Con esta acción no podrás modificar la misma instancia que se está ejecutando. En ese caso deberás utilizar el servicio ECHO de la API de INTEGRADOC. Puedes ver ejemplos de cómo usar este servicio en: Agrega una Fecha de creación a tu formulario automáticamente y Agrega una Fecha de finalización a tu formulario automáticamente o ¿Puedo asignar etiquetas de forma automática? de forma automática.
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso de la instancia que quieres modificar ( 2 ).
En Datos de Entrada se te pedirá que ingreses como primer parámetro el Identificador de la instancia que quieres modificar, referenciado en un campo de tu formulario o clikeando en el lápiz podrás escribir una referencia fija. Los siguientes parámetros serán los campos a modificar y el valor origen (desde un campo o también puede ser un valor fijo) ( 3 ).
Este servicio retorna como salida el valor true si la instancia se actualizó correctamente o el valor false en caso contrario. Opcionalmente puedes capturar este dato y guardarlo en un campo del formulario ( 4 ).
Ten presente que esta acción sobreescribe los campos de la instancia indicada.
Obtener instancia
Obtener instancia te permite acceder a los datos de una determinada instancia y guardarlos en tu formulario, simplemente con la ejecución de una tarea de servicio, y sin modificar ninguno de los datos de origen. Para configurarlo sigue estos pasos:
Agrega un título opcional para que puedas identificar fácilmente la acción desde el flujo ( 1 ).
Selecciona el proceso de la instancia que quieres obtener ( 2 ).
En Filtro deberás ingresar como parámetro el Identificador de la instancia que quieres acceder, referenciado en un campo de tu formulario o clikeando en el lápiz podrás escribir una referencia fija ( 3 ).
En los Datos de Salida podrás elegir qué campo de la instancia obtenida (Resultado) quieres guardar en tu formulario (Campo a cargar) ( 4 ).
Para interactuar con las Bases de Datos o instancias de otra organización en INTEGRADOC, deberás invocar los servicios de la ¿Dispone INTEGRADOC de una API pública? configurando el servicio con los datos que te proporcione un Administrador de la organización.
Posibles problemas
Loop al crear instancia de un mismo proceso
¿Cuándo sucede?
Sucede si la primera tarea del flujo es una Tarea de Servicio que crea una nueva instancia del mismo proceso.
Descripción
En este caso cada instancia creada podría invocar al servicio creando una nueva instancia que inicia nuevamente el ciclo, generando un loop.
Este comportamiento es detectado por INTEGRADOC que te mostrará un mensaje de error y no permitirá continuar con la ejecución.
Loop al crear instancia entre dos procesos
¿Cuándo sucede?
Ocurre si tu organización tiene dos procesos A y B cuya primera acción de los respectivos flujos es crear una instancia del otro proceso.
Descripción
En este caso la instancia creada del proceso A podría crear una instancia del proceso B que a su vez volvería a crear una del proceso A generando un loop.
Este comportamiento es detectado por INTEGRADOC que te mostrará un mensaje de error y no permitirá continuar con la ejecución.
Actualizado el: 16/05/2022
¡Gracias!