En este instructivo vas a conocer cómo usar Deals en Finnegans GO.
¿Quiénes pueden hacerlo?
Esta documentación está dirigida al usuario con el rol de administrador en DEALS
En esta entrada se encontrarán los lineamientos necesarios para comenzar a utilizar esta herramienta y realizar las primeras configuraciones para hacer uso de sus funcionalidades.
25 min
Deals: ¿Qué es?
Deals es un middleware de integración digital. Es la forma de dar más eficiencia al trabajo que realizan en conjunto, para beneficio mutuo y consolidación de sus relaciones de negocios. Permite conectar diferentes sistemas digitales tanto internos como externos a través de opciones No-Code, Low-Code y Guest-Code.
Su esencia es enviar, almacenar temporalmente, traducir y recibir información.
Arquitectura de Deals:
Basadas en métodos POST y GET.
Deals se ubica en el medio, con Deals se conectan para ingresar información a través de métodos de entrada, y para sacar la información de deals utilizan métodos de salida.
Beneficios
Deals es una aplicación que simplifica la integración entre sistemas, facilitando la comunicación con servicios externos y proporcionando capacidades de gestión de datos. Por ende Deals nos brinda:
- Facilidad de la conexión entre sistemas: con configurar tus métodos de entrada y salida ya estás conectado con un externo y es bastante “no-code” esto debido a que no hay que meter mucho codigo, solo armar tu JSON y la estructura de datos, se necesita un mínimo conocimiento de microservicios, de como conectar pero no necesitas tocar el código de Finnegans o solicitar un desarrollador de Finnegans para poner codigo.
- Automatización de procesos de importación/exportación de datos: procesos de procesamiento de datos entre diferentes entornos de trabajo y reduce errores en la gestión de datos.
- Flexibilidad para adaptarse: se adapta fácilmente a las necesidades de los que necesitan utilizar deals, tiene muchas posibilidades.
- Mejora la eficiencia y reduce errores en la gestión de datos: esto debido a que deja de ser manual para ser automatizado.
- Monitorización para una mejor visibilidad y control: permite monitorear las actividades de integración.
- Mejora la interacción con servicios externos.
¿Cómo acceder a Deals?
- En Finnegans GO, ir a: Menú → Deals
Configurar Empresa
Lo primero que debemos hacer es configurar nuestra empresa.
Para integrarse al ecosistema de Deals, es necesario ser parte de Finnegans GO. Además, para poder operar, se debe dar de alta la empresa correspondiente. Si la empresa no está activada, no se dispondrá del CFU (Clave Única Finnegans), la cual es esencial para enviar información y realizar operaciones dentro de Deals.
La sección “Configurar Empresa” permite mostrar y registrar los datos necesarios de tu empresa y proceder con su activación. Los campos requeridos incluyen:
Razón social: Es el nombre oficial y legal bajo el cual una empresa está registrada y realiza sus actividades comerciales. Es el nombre que aparece en documentos legales, contratos y registros oficiales, viene dada por default.
Identificación fiscal: Es un número único asignado a tu empresa para fines fiscales y de identificación, viene dado por default.
CFU: que es la clave única finnegans, se puede utilizar para recibir información y para operar dentro de Deals.
Secret Key: Podemos generar un bearer token para deals en conjunto a el CFU, que por ejemplo se usan para hacer publicaciones o descargas en postman, de forma manual.
Dirección de mail: viene dada por default.
Aclaración: en caso de que tu empresa ya esté activada/dada de alta, el botón “Activar” estará bloqueado en un color gris, por lo que no podremos interactuar con ese botón.
Catálogo de Documentos
Deals opera y conecta los métodos de entrada y de salida a través de un documento, sin este, los métodos carecen de sentido.
En el catálogo se encuentran todos los documentos que ya existen para la empresa y se pueden dar de alta nuevos, es una funcionalidad que permite gestionar diversos documentos dentro de la plataforma Deals.
Al seleccionar “Catálogo de Documentos” nos lleva a la pantalla de Catálogo de Documentos.
Cada documento en el catálogo contiene la siguiente información:
- Nombre del Documento: Identificación única del documento.
- URLs:
- URL de Publicación: Enlace para publicar el documento.
- URL de Descarga: Enlace para descargar el documento.
- Descripción: Breve texto descriptivo del documento.
- Campo de Carga Manual: (Función no completamente definida).
Configuraciones Adicionales
- Schema: Utilizado para el preprocesamiento del documento, este otorga la estructura de la información que esperamos recibir (JSON). En caso de no tener uno definido, no se podrá publicar vía mapeo dinámico y sólo será posible vía API.
- Métodos HTTP:
- POST: Para enviar datos.
- GET: Para obtener datos.
Estas configuraciones permiten gestionar y manipular los documentos dentro del entorno de Deals.
Tipos de Documentos
- Documentos Privados: Son los creados por el cliente, estos documentos son accesibles para los usuarios dentro de la empresa en la que fueron creados.
- Documentos Públicos: Son los documentos disponibles para todas las empresas, creados y mantenidos por Finnegans.
Notas Importantes
- Documentos Privados con Métodos Públicos: Esta combinación no es posible. Los documentos privados sólo tendrán métodos privados, esto debido a que el listado de documentos de Integration Server solo muestra los documentos públicos. El propósito es porque las configuraciones privadas son de uso solo para la empresa determinada, el cliente no quiere que se comparta entre todos los espacios de trabajo.
- Métodos en Documentos Públicos: Si se generan métodos en un documento en Integration Server, estos métodos serán públicos y visibles para todos los espacios de trabajo.
Publicaciones ¿Para que lo hago?
Las publicaciones actúan como métodos de entrada de información.
Existen dos formas de publicaciones:
- Publicaciones de Terceros: hace referencia a casos donde subís publicaciones a otra empresa, a un tercero.
- Publicaciones Propias: hace referencia a casos en los que un usuario sube documentos a sí mismo (propia empresa).
Para configurarlo debes ir a: Menú → Deals → Publicaciones.
Aclaración: Las pantallas que mostramos una vez ingresamos a publicaciones, son las mismas para Publicaciones a terceros y Publicaciones propias, solo se filtraran los métodos que son creados para cada tipo de publicación
Publicaciones de terceros y Publicaciones propias
Esta grilla muestra el listado de publicaciones de los documentos que tienen configurado un método post.
En la sección de acciones, contamos con “Ver en el monitor” la cual nos muestra detalles de la publicación que estoy visualizando.
El monitor muestra información relacionada a las publicaciones y descargas que se realizan dentro de Deals. Las comunas que podemos visualizar son: Fecha, Hora, ID de Transacción, Nombre del Documento, Request, Status code, Response y Llamada API.
En la columna Request se visualizan los parámetros con los que se ejecutó el método GET y en la columna Response muestra lo que ingresa el microservicio que realiza la publicación (método POST), Y en caso de que una transacción haya sido ejecutada con un método GET, se puede llegar a reprocesar una transacción sin importar su estado.
Nuevo
Para disponibilizar un método de publicación (utilizando el botón de “Nuevo”):
Selecciono el documento y los métodos de publicación posibles son: Los métodos post creados para ese documento y la opción de crear nuevo método.
Al seleccionar el método de publicación la opción “Crear Nuevo:”
Al ir completando los campos, se disponibilizaran configuraciones y secciones relacionadas a nuestra configuracion, a modo de ejemplo visualizamos la siguiente pantalla:
Nombre del método: Seleccionamos el nombre que queremos que tenga nuestro metodo.
Origen de la información:
Este campo sirve para identificar de dónde viene la información y hacer un filtro, la única opción disponible es: Código del método.
- Código del método: el usuario define un código que lo hace único.
- Campo JSON: se define según el valor de un campo del json que se publica.
- CFU Remitente: en caso de publicaciones de terceros cuando publica para otros.
Código id: Sirve para hacerlo único dentro de deals dentro de tu espacio de trabajo.
Acceso: como lo publicamos a nuestro método dentro de Deals
- Directo: el microservicio se encarga de postear sobre una API en deals en el documento en el cual estamos creando el método.
- Archivo: el microservicio trabaja con archivos. Tenemos las opciones de elegir email, ftp o manual.
- Email: Los archivos se publican a través de email.
- FTP: Los archivos se publican a través de FTP.
- Manual: El archivo será cargado de forma manual por el usuario.
- Archivo pdf con IA: archivos tipo pdf únicamente y los va a saber interpretar una IA, también tenemos disponibles las opciones de Email, FTP o Manual.
Generar Job: significa que cuando lo prendemos, al momento de configurar el método para usarlo genera un servicio programable para activarse cada 12 hs (Esto es configurable dentro del servicio programable de go).
URL procesamiento: al momento de configurar el documento, deals te ofrece la posibilidad de enviar tu archivo a un microservicio, en este campo poder poner la url de tu microservicio. Esto permite recibir la información de deals.
En la sección de Parámetros, tenemos la opción de agregar parámetros a nuestro método de entrada en caso de ser necesario.
En caso de haber elegido Email, visualizamos una sección llamada “Configuración de Email”:
Esta sección contiene los siguientes campos:
Dirección de Email: tenemos por defecto una casilla de correo que genera Deals de manera dinámica.
Asunto: es configurable por el usuario y este estará asociado a la carga de archivos.
Notificar errores: este checkbox nos permite notificar errores en la carga de archivo, al habilitarlo nos mostrara mas campos:
Notificar errores a: nos permite notificar errores en la carga de archivo a los usuarios que seleccionemos.
Asunto de error: asunto de los correos de notificación sobre errores en la carga de archivos.
Aplicar mapeos:
este checkbox al habilitarlo nos permitirá visualizar una nueva sección para relacionar el archivo al formato estándar del schema, la pantalla y las configuraciones son las mismas que en el caso de seleccionar Email, FTP o Manual:
En esta sección podemos crear un mapeo dinámico o seleccionar uno en caso de ya tenerlo configurado, en caso de tenerlo configurado, podremos visualizarlo, eliminarlo o editarlo. Si elegimos crear uno, hacemos clic en el botón de “Nuevo” veremos el siguiente popup:
Subimos un archivo para nuestro mapeo y hacemos clic en siguiente:
En la sección consideraciones del archivo:
Fila de inicio de datos: representa la fila donde inician los títulos de las columnas a relacionar
Presenta títulos en una fila de datos: este checkbox se marca si nuestro archivo presenta título. En caso de no marcarlo, deberemos completar el campo “Cantidad de columnas a mapear” para indicarle cuantas columnas debemos relacionar con el mapeo dinámico. Una vez completado, hacemos clic en “Relacionar campos”:
En esta última sección, podemos asignarle un nombre a nuestro mapeo y una breve descripción, luego veremos los documentos y los campos a relacionar. Al terminar, hacemos click en guardar y podremos visualizar nuestro mapeo en la sección de Mapeos dinámicos.
Para dejar activo nuestro mapeo debemos seleccionarlo de nuestra lista de mapeos posibles para el método.
Al guardar, volveremos a ver el popup inicial pero con nuestro método de publicación ya cargado, al confirmar podremos visualizarlo en la grilla. Si hacemos click en cancelar, el método de publicación no se guardará en la grilla.
En caso de haber elegido FTP: Visualizamos una nueva sección llamada: “Configuración de FTP”
En esta sección debemos completar los siguientes campos:
Host: Es la dirección del servidor FTP
Usuario: nombre de usuario
Clave: clave de acceso.
Puerto: número de puerto
Directorio Origen: ruta del directorio de origen
Directorio procesada: ruta del directorio de procesados
Mantener archivos con error: al marcar este checkbox, si el procesamiento falla el archivo no se moverá del directorio de origen
Generar archivos con detalle de errores: genera un archivo con el detalle de los errores en el directorio de procesados.
Aplicar mapeos: descrito anteriormente.
En caso de haber elegido Manual: Visualizamos una nueva sección llamada: “Configuración Manual”
Cuando es de configuración manual el usuario se encarga de cargar manualmente los archivos.
Aplicar mapeos: descrito anteriormente.
Descargas
Descargas actúa como métodos de salida, estos sirven para utilizar la información almacenada en Deals. Se va a activar cuando esté programado por un scheduler o se dispare un webhook, notificandonos que llegó información.
Para ingresar a Descargas tienes que ir a : Menú → Deals → Descargas → Mis descargas
Al ingresar a Mis Descargas se visualiza una grilla que contiene las siguientes columnas:
- Documento: lista todos los documentos disponibles en uso por la empresa.
- Método de descarga: lista los métodos de descarga posibles para este documento. Incluye métodos get y la posibilidad de crear un nuevo método get.
- Cantidad de descargados: lista la cantidad de descargas que contiene el documento
Al seleccionar en “Nuevo” nos muestra un pop up con la siguiente información:
- Documento: Nos permite seleccionar el documento configurado anteriormente en el catálogo de documentos.
- Método de descarga: Nos permite seleccionar los métodos GET ya configurados o crear uno nuevo.
Al seleccionar “Crear nuevo”:
A medida que completamos se verán nuevos campos y secciones para completar. A modo de ejemplo:
En esta sección debemos completar los siguientes campos:
Código id: Sirve para hacerlo único dentro de deals en tu espacio de trabajo.
Nombre del método: Nombre que le queramos asignar a nuestro método.
Tipo URL: Hay dos opciones, Preprocesamiento y Finnegans, dependiendo de la opción elegida, se visualizan distintos campos.
Si elegimos Tipo URL preprocesamiento se habilitará la solapa de parámetros y tendremos que completar nuestra URL de procesamiento.
En el caso de Tipo URL Finnegans, lo que hay que completar es que API definida queremos direccionar.
Generar Job: significa que cuando lo seleccionamos, al momento de configurar el método para usarlo genera un servicio programable para activarse cada 12 hs (Esto es configurable dentro del servicio programable de go).
Activar webhook: una vez seleccionado, se habilitará la sección “Orígenes permitidos”
URL Procesamiento: al momento de configurar el documento, deals te ofrece la posibilidad de enviar tu archivo a un microservicio, en este campo poder poner la url de tu microservicio. Esto permite recibir la información de deals.
En la sección de Parámetros, tenemos la opción de agregar parámetros a nuestro método de entrada en caso de ser necesario.
Si anteriormente elegimos Tipo URL preprocesamiento, tendremos la posibilidad de agregar parámetros a nuestro método GET, En la sección de Parámetros tendremos el campo “URL de validación”: Esta URL se utiliza para enviar los parámetros a la dirección especificada y validar si los datos son válidos o no.
Y también tenemos una grilla con las siguientes columnas:
Nombre: nombre que le asignamos a nuestro parámetro
Tipo: Tipo de variable, puede ser Texto, Contraseña, Booleano, Archivo, Fecha, Fecha de ejecución y Fecha dinámica modificable
Valor por defecto: Permite asignarle un valor por defecto a nuestro parámetro en caso de que sea necesario.
Visible: Este checkbox en caso de marcarlo le otorga visibilidad a nuestro parámetro mientras que si no lo marcamos nuestro parámetro no permanecerá visible.
En la sección “Orígenes permitidos”, podemos configurar el tipo de origen Nombre del método, a modo de ejemplo:
Luego, hacemos click en confirmar para finalizar la creación de nuestro método de salida y volveremos a visualizar el popup de Registro de descargas, solamente tenemos que darle click a confirmar y podremos visualizar nuestro método de salida en la grilla de mis descargas.
