Plugins

Os Plugins são uma NoCode para usuários do BPM, que podem integrar seus fluxos utilizando os Plugins disponíveis na XPlatform, sem necessidade de desenvolvimento.

Com os Plugins as integrações ocorrem de forma facilitada, bastando informar os parâmetros de entrada e saída para que o plugin comece a funcionar. Além disso, é possível configurar novos Plugins e acompanhar a saúde dos já existentes, consultando suas versões, logs de chamada, tempos de resposta e usuários.

Utilizando Plugins

A configuração é simples: basta selecionar o plugin e informar os parâmetros que serão atribuídos como variáveis do fluxo, processo e constantes. Depois de inserir as variáveis no plugin, é necessário salvar e publicar o fluxo que fará uso da integração. O processo é demonstrado no gif abaixo.

Se houver a necessidade de configurar um plugin sem usá-lo imediatamente, é possível acessar o novo menu da plataforma em XPlatform> Configurações > Serviços de integração.

Nessa tela, é possível configurar Plugins e serviços externos, além de alterar as versões dos Plugins como mostrado no gif abaixo.

Para encerrar o uso dos Plugins, é possível visualizar sua saúde por meio do menu XPlatform > Plugins. Nesse menu é possível consultar suas versões, parâmetros, logs de chamada, tempo de resposta e usuário, como mostrado no gif abaixo.

Criando Plugins

Para disponibilizar um novo plugin, é necessário abrir um Merge Request neste repositório no GitLab. É importante lembrar que este processo é voltado para desenvolvedores.

Para começar, é necessário clonar o repositório e instalar o Node 14.5.0. Em seguida, execute os seguintes comandos:

1. "npm install -g serveless" em qualquer diretório;
2. "npm install" na pasta do projeto.

O Merge Request deve conter três arquivos para ser aceito e o novo plugin entrar em operação: swagger.yaml, index.ts e handler.ts.

No arquivo swagger.yaml, devem estar contidas as informações sobre parâmetros, título e descrição do plugin, que serão exibidos dentro da Senior X. Já no arquivo index.ts, deve ser definida a forma de chamada do plugin, seja ela um POST, GET, PUT ou DELETE, bem como o caminho da requisição. Por fim, no arquivo handler.ts, deve existir um método chamado handler, no qual serão implementadas todas as funções que o plugin deve realizar.

Ao criar os arquivos, é importante seguir alguns padrões:

• Todos eles devem estar dentro da pasta plugin;
• Deve-se criar uma subpasta contendo o nome do plugin, que deve ser o mesmo utilizado no swagger e no caminho dentro do index.ts. Por exemplo, se a pasta se chama obter-cep, o swagger deve conter um item /obter-cep na opção paths, e o atributo path do index.ts deve ser obter-cep.

Antes de realizar o commit e tornar o plugin disponível, é possível testá-lo localmente usando o comando sls offline, sem a necessidade da infraestrutura da AWS.

Plugin G5

Com o objetivo de simplificar a integração, foram desenvolvidos Plugins para facilitar a interação entre a plataforma e os sistemas G5 da Senior, que incluem: Gestão Empresarial | ERP, Gestão Empresarial PME | GOUP, Gestão de Pessoas | HCM e Ronda Senior. O plugin G5 tem como principal função inserir dados disponíveis por API na G5.

Este plugin permite configurar parâmetros globais com valores padrão. Se você não informar um valor específico durante a configuração do plugin, o BPM usará o valor padrão configurado automaticamente.

Também é possível criar configurações personalizadas para este plugin, permitindo integrá-lo com serviços da G5. Confira um exemplo de configuração no vídeo abaixo.

Para selecionar o plugin com as configurações desejadas do bpm, confira o exemplo abaixo.

Visualizar Log e Payload

Através do menu XPlatform> Plugins, está disponível a funcionalidade visualizar detalhes avançados de erros do plugin. Para visualizar a mensagem de erro, basta selecionar um plugin e, na guia Histórico de execução, clicar no botão Ver mensagem de erro.

Uma mensagem de erro será exibida, um exemplo dessa mensagem seria: requestid3c2cecee-0738-4d12-9339-d5c682cf5d03.

Além disso, o plugin é compatível com o Dataset de API, permitindo acesso ao payload do plugin através de XPlatform> Plugins. Para visualizar as informações, selecione um plugin e clique na guia Payload. As informações estarão disponíveis para visualização.

Utilizando Fonte de Dados através de um plugin

Configurar um plugin com as fontes de dados desejadas é rápido e simples. Basta escolher uma das fontes já criadas nos plugins e informar os parâmetros relevantes, que podem ser atribuídos como variáveis, fluxo, processo ou constantes.

Os Plugins disponíveis para configuração são: Listar contas (CRM), Listar oportunidades (CRM), Listar Estados do Brasil (IBGE) e Lista de usuários SeniorX.

Você pode acessar o menu XPlatform> Plugins para visualizar a saúde dos Plugins, consultar suas versões, parâmetros, logs de chamadas e tempo de resposta, bem como o usuário responsável.

Para criar uma nova fonte de dados através de um plugin e disponibilizá-lo para uso em um novo processo, é necessário configurá-lo no campo desejado do formulário. Depois de configurado, é preciso salvar as alterações para que a fonte de dados fique visível na solicitação do novo processo.

Para selecionar uma fonte de dados com um plugin já configurado dentro do BPM, basta escolher a fonte desejada nas opções disponíveis.