Uso de Serviços Externos
Sumário
1. Conceito
O BPM permite a utilização de serviços externos para fazer consultas ou persistência de dados. Esse tipo de serviço pode ser utilizado para por exemplo, alimentar uma variável do processo.
2. Menu de Acesso
- Acesse
- Em seguida, BPM
- Selecione, Configurações
- Clique em Serviço Externo
3. Configurações
3.1 Configurar um Serviço
Informe o Nome do serviço, o Tipo de Requisição GET ou POST (consulte o fornecedor do serviço para saber o tipo) e a URL. O Tipo de Execução será Execução Tarefa e o Protocolo do Serviço Rest, conforme padrão. O serviço deve ser https por questões de segurança.
Conforme na URL de exemplo acima, o ID é um parâmetro de entrada. E a resposta do serviço (saída) retorna o próprio ID e o atributo estado. Em um serviço devem ser definidas entradas e saídas, podendo ter apenas entradas ou apenas saídas. Serviços com apenas entradas são comum em cenários em que realizam a persistência de dados. Quando possuem apenas saídas, são comuns em cenários que provêm informações sobre algum contexto, como dados sobre o usuário corrente.
No modelo de processos, selecione a engrenagem da ligação que irá executar o serviço externo. Na aba Serviço Externo, clique em Configurar para que a tela de configuração seja exibida, e o que tiver sido definido de entrada e saída neste serviço, será apresentado nessa tela para conectar com o processo.
Os parâmetros de entrada podem ser de 3 tipos:
- Variável de processo: variáveis definidas no formulário no na interface web;
- Constante: valor fixo;
- Variável de execução: disponibiliza 4 informações: instância do processo, nome do processo, usuário solicitante e usuário responsável atual da tarefa.
Ao BPM realizar a requisição, os seguintes headers são adicionados:
| Header | Descrição |
|---|---|
| X-bpm-tenant | O tenant corrente do processo que está chamando o serviço. |
| X-bpm-tenantDomain | O domínio do tenant corrente do processo que está chamando o serviço. |
| X-bpm-user | O usuário corrente da plataforma que está chamando o serviço. |
| X-bpm-authorization | O token de autorização do usuário corrente da plataforma que está chamando o serviço. |
Importante
- É importante que as saídas configuradas no serviço externo estejam com o seu tipo corretamente configurado de acordo com o retorno do serviço externo. Caso essas parametrizações não estejam de acordo com o esperado, será gerada uma mensagem de alerta na saúde do processo em questão, para que seja realizada a correção dos tipos esperados. É de extrema importância que a correção seja realizada, pois, futuramente o o serviço externo pode ser atualizado para tratar estes cenários como erro de execução do serviço em novas versões de processos.
- Listas e arrays não são suportadas como respostas.
- Os dados estão disponíveis por apenas 7 dias. Após 30 dias, eles são arquivados e podem ser consultados somente mediante a abertura de um ticket para a Senior. Depois de 5 anos, os dados são apagados definitivamente.
3.2 Exemplo de Variável do Processo
https://br-cidade-estado-nodejs.glitch.me/estados
[{
“id”: “AC”,
“estado”: “Acre”
},
{
“id”: “AL”,
“estado”: “Alagoas”
},
{
“id”: “AM”,
“estado”: “Amazonas”
}, …
Esse serviço retorna todos os estados do Brasil. Poderia ser utilizado inclusive como datasource. Porém nesse caso o serviço suporta filtro para retornar um registro único.
https://br-cidade-estado-nodejs.glitch.me/estados?id=SP
No exemplo acima, é informada a sigla SP no atributo id para filtrar apenas o estado específico que vai retornar.
[{
“id”: “SC”,
“estado”: “São Paulo”
}]
Com isso, podemos usar o campo estado para alimentar algum campo do processo.
English
Español
