TRANSFORMAR PRODUTO LEGADO NUM SERVIÇO CLOUD. MODELOS DE EXTENSÕES NUM SISTEMA SAAS MULTITENANT EM CLOUD

Abstract

A Link Consulting é uma empresa de consultoria e de desenvolvimento de software, sendo que um dos seus produtos principais é o sistema edoclink, um software de gestão documental e de processos. Este produto foi subscrito e está em uso em muitas empresas, particularmente nos países de expressão portuguesa. A motivação para melhorar o edoclink é muito grande. Está em desenvolvimento uma nova versão baseada numa arquitetura SaaS multitenant. Uma funcionalidade em que existe a intenção de investir muito esforço é a possibilidade de dar ao utilizador a opção de escrever, ele mesmo, algum código para estender o sistema com novas funcionalidades que resolvam problemas locais. Este é o tema central desta dissertação. Este é um problema interessante, visto existir muito pouca literatura técnica sobre este assunto. A par deste facto, são raras as empresas que desenvolvem software SaaS multitenant que tenham suporte com extensibilidade. Este documento apresenta uma solução possível para este problema, implementada na nova versão do edoclink. As ideias principais são as seguintes: • Todas as extensões são executadas localmente, no servidor do cliente. • Desenvolver SDKs para as linguagens de programação mais usadas por forma a ajudar o utilizador a criar extensões sem demasiada dificuldade, maximizando a sua produtividade. • Cada SDK conterá métodos tanto para o envio de dados, utilizando a API disponibilizada pelo edoclink, como para receber dados, através de eventos utilizando WebHooks. Além disso, a questão da segurança terá de ser tratada. • Aproveitar a opção que agora existe de gerar SDKs completos através do OpenAPI codegen. Muito recentemente ocorreu um importante anúncio de uma evolução da especificação do OpenAPI que passa a permitir o uso deWebHooks. Este relatório também contém uma introdução, uma descrição bastante completa de conceitos, técnicas que foram necessárias considerar, metodologia de trabalho da equipa do edoclink e um resumo bastante completo da implementação deste projeto.

Link Consulting is a consulting and software development company, and one of its main products is the edoclink system, a document management and process software. This product has been subscribed and is in use by many companies, particularly in Portuguesespeaking countries. The motivation to improve edoclink is very high. Anewversion based on a multitenant SaaS architecture is being developed. One functionality in which there is a intention to invest a lot of effort is the possibility of giving the user the option to write their own code to extend the system with new functionality that solves local problems. This is the central theme of this dissertation. This is an interesting problem, as there is very little technical literature on this subject. In addition to this fact, there are few companies that develop multitenant SaaS software with extensibility support. This document contains a possible solution for this problem, implemented in the new edoclink version. This dissertation main ideas are as follows: • Every extension will be run on the user environment • Develop SDKs for the most commonly used programming languages in order to help the user create extensions without too much difficulty, maximizing their productivity. • Each SDK will contain methods both for sending data using the API provided by edoclink, as well as for receiving data through events usingWebHooks. In addition, the issue of security will have to be addressed. • Take advantage of the option that now exists to generate complete SDKs through OpenAPI codegen. Indeed, very recently there was a significant announcement of an evolution of the OpenAPI specification that now allows the use of WebHooks This report also contains an introduction, a fairly comprehensive description of concepts and techniques that were necessary to consider, edoclink team work methodology and a very comprehensive summary of the implementation of this project.