Skip to end of metadata
Go to start of metadata

Atenção

Esta página foi revisada para considerar as configurações da atualização 1.6.5 (Liquid) e superiores.

Í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. 

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.

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.

Atenção!

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 nos próximos passos.


Configuração do serviço

O segundo  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:

    1. Acesse a URl do seu ambiente fluig adicionar /api-rest. Ex: http://suaempresa.fluig.com/api-rest

    2. 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.


    Configuração da operação

    No terceiro 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.

      Configuração do formulário

      Nesse 4º passo será apresentada a configuração do formulário, que inclui torná-lo público e integrado com a operação de iniciar a solicitação.

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

      No exemplo dessa documentação, foi criado um formulário com alguns campos. Na configuração dos campos, foram definidas as informações como obrigatórias:

        Como o formulário será adicionado a uma página pública, é necessário realizar a configuração para torná-lo formulário público. Basta acessar as configurações de segurança do formulário e defini-lo como público.

        Nessa mesma aba de configurações é realizada a inclusão da operação a ser integrada, basta selecionar a operação desejada (no caso, aquela de start) e configurar os campos para a integração. Serão preenchidos apenas os campos necessários para a integração, que são 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), o parâmetro targetState (código da atividade que se encontra após a atividade inicio), o parâmetro targetAssignee (pessoa responsável pela atividade) e os campos que serão preenchidos no formulário público e enviados para o formulário do processo.

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

        Configuração da página

        O último passo é configurar a página pública, arrastando os componentes e personalizando o layout de acordo com a identidade da empresa.

        Para verificar como criar a página, verifique a documentação sobre Adicionar página.

        E para que a solução fique completa, basta adicionar o formulário criado no passo 4. Para fazer isso, siga os passos a seguir:

          Arraste um componente de Conteúdo externo para a página.

          Acesse o seu formulário e acione a opção Compartilhar URL, para copiar a URL do formulário para a área de transferência.


          Volte na tela de configuração da página e insira a URL do formulário na configuração do componente de Conteúdo externo.


          Conheça mais: Webinar

          Assista ao webinar gravado pelo time fluig, para obter mais detalhes sobre o funcionamento deste procedimento:



          • No labels