Índice

Objetivo

Este guia tem o propósito de mostrar como iniciar uma solicitação de processo a partir de uma página pública por meio de um formulário público. Vamos apresentar um exemplo e detalhar todos os passos da integração.

TOTVS Fluig > Iniciar uma solicitação a partir de uma página pública utilizando Forms > Esquemas.png

Passo a passo

O caso de uso selecionado é o de recrutamento de novos colaboradores. Você pode conferir mais informações sobre essa aplicação por meio desse webinar.

Confira a seguir os passos necessários para realizar essa configuração.

Passo 1 - Configuração do processo

O primeiro passo é definir qual o processo que deve ser iniciado. Você pode utilizar um processo já existente ou configurar um novo, caso necessário.

Para verificar como criar o processo, verifique a documentação sobre Adicionar processo.

Neste exemplo, vamos criar um processo simples, porém sua empresa pode evoluir o fluxograma para atender completamente as necessidades.

TOTVS Fluig > Iniciar uma solicitação a partir de uma página pública utilizando Forms > construir processo.png

Não se esqueça de configurar o formulário do seu processo! E fique atento ao nome dos campos do formulário, iremos precisar dele mais pra frente.

TOTVS Fluig > Iniciar uma solicitação a partir de uma página pública utilizando Forms > formulário.png

Passo 2 - Configuração do serviço

O próximo passo para iniciar uma solicitação é por meio do cadastro do serviço REST de processos. Lembrando que se deseja fazer integração de um formulário com outro serviço é possível, basta cadastrar o serviço desejado.

Para verificar como criar o serviço, verifique a documentação sobre Adicionar serviço.

No caso do exemplo, será utilizado um serviço REST configurado conforme a seguir.

Para recuperar a informação do arquivo Swagger, siga os passo abaixo:

Acesse a URl do seu ambiente fluig adicionar /api-rest. Ex: http://suaempresa.fluig.com/api-rest
Selecione o serviço que deseja, nesse caso utilizamos o de Process Management. Ver imagem abaixo:

Após acessar a página, copiar a URL e adicionar ao final a swagger.json. O resultado final será algo semelhante a: http://suaempresa.fluig.com/process-management/swagger-ui/swagger.json

No campo Domínio você adicionará a URL da fluig da sua empresa junto com a Base URL que você pode recuperar na página do serviço (Process Management).

Nosso exemplo utiliza o tipo de autenticação Rest oAuth 1, porém nessa documentação são apresentados os detalhes de cada autenticação para atender a sua necessidade. Ao selecionar autenticação do tipo Rest oAuth 1 é preciso preencher algumas informações (Consumer Key, Consumer Secret, Token de acesso e Token Secret).

Acesse essa documentação para saber onde encontrar essas informações.

A URL de teste de serviço não é uma informação obrigatória, porém serve para testar se as configurações do serviço estão corretas. A única particularidade é que precisa ser um método GET.

Passo 3 - Configuração da operação

Nesse passo é realizada a inclusão da operação que será necessária para integrar com o formulário.

Para verificar como criar a operação, verifique a documentação sobre Adicionar operação.

No exemplo dessa documentação, será incluída a operação de iniciar solicitação de processos.

As operações são os métodos retornados da documentação Swagger da API, cadastrado no serviço selecionado. No caso será escolhida a operação start, que é o método de inicialização de uma solicitação de processo.

Os parâmetros também são recuperados da documentação Swagger e o campo Label permite que sejam definidos nome mais amigáveis, que irão aparecer na integração do formulário, facilitando assim o entendimento de usuários das áreas de negócio.

Passo 4 - Configuração do formulário

Nesse passo será como configurado um formulário, tornando-o público e integrado com a operação de iniciar a solicitação de um processo.

Para verificar como criar o formulário, verifique a documentação sobre Construção de formulário.

1 - Para criar o formulário basta arrastar e soltar os campos desejados, criamos para nosso exemplo um formulário com alguns campos e na configuração dos campos definimos as informações como obrigatórias.

2 - Como vamos adicionar o formulário numa página pública é necessário realizar a configuração para tornar o formulário público. Basta acessar as configurações de segurança do formulário e defini-lo como público.

3 - Na mesma aba de configurações agora vamos adicionar a operação a ser integrada.

Selecionar a operação desejada
Configurar os campos para a integração: no caso preenchemos apenas os campos necessário para a integração que são, codigoProcesso com o valor do código de processo a ser iniciado (nesse caso o código de processo é o do processo criado no passo 1) e os campos que serão preenchidos no formulario público e enviados para o formulário do processo.

Após configurar os campos é possível definir as mensagens relacionadas a integração

Passo 5 - Criar página

Para criar páginas acessar o menu Soluções > Pages, adicionar uma nova página, arrastar os componentes e configurar de acordo com a identidade da sua empresa.

E para que a solução fique completa basta adicionar formulário criado no passo 4, arrastando um componente de Conteúdo externo para a página e adicionando a URL do formulário que posso ser capturada na listagem de formulários.