Skip to end of metadata
Go to start of metadata

Índice


Falando de operações...

As operações são um pré-cadastro para simplificar o uso de uma operação/método de um serviço cadastrado. Esse recurso oferece ao administrador da plataforma a possibilidade de gerenciar as operações de serviços, para que outros usuários possam utilizar integrações externas. As operações são utilizadas, por exemplo, na configuração de um Forms Beta, incluindo a operação como integração externa.

Por enquanto, o cadastro de operações é permitido para serviços SOAP ou REST com swagger.



Operações


01. No menu principal, acionar Painel de Controle, logo depois verificar o agrupador Desenvolvimento e acionar Operações.

02. Visualizar as operações existentes.


Adicionar operação


01. Na tela de Operações, acionar a opção Nova Operação.

02. Inserir as informações necessárias.

Os campos destacados com um asterisco (*) são de preenchimento obrigatório.

  • Código: insira o código para a operação.
  • Nome: adicione um nome para a operação.
  • Serviço: selecione o serviço (SOAP ou REST com swagger) que será utilizado na operação.

      Ao selecionar um serviço do tipo SOAP, preencha os seguintes campos:

      Operação
      Ao selecionar o ícone de lupa, permitirá selecionar uma das operações disponíveis. As operações estarão listadas por Nome e PortType.

      Configurar
      Nas configurações da operação selecionada, podem ser configuradas as Propriedades, SOAP Headers e Tratamento retorno.

      Propriedades

      • Autenticação Básica - selecionar se a autenticação for necessária, nesse caso será requisitado usuário e senha.
      • SSL - habilitar quando o serviço SOAP exigir utilização de SSL (camada extra de segurança).
      • Desabilitar Chunking - desabilitar o envio do envelope SOAP inteiro.
      • Listar mensagens SOAP - habilitar para mostrar as mensagens de envio e recebimento no log.
      • Tempo de resposta - habilitar para mostrar o tempo que a requisição aguarda pela resposta.

      SOAP Headers
      Permite adicionar um header (cabeçalho).

      Tratamento Retorno

      • Extrair resultado - permite selecionar esta opção para extrair um relatório em formato XML e incluir uma tag.

      Acionar Salvar para concluir a configuração.

      Ao selecionar o tipo de serviço REST, preencha os seguintes campos:

      Operação
      Ao selecionar o ícone de lupa, permitirá selecionar uma das operações disponíveis. As operações estarão listadas por Nome, Método(GET) e API.

      Configurar
      Nas configurações da operação selecionada, podem ser configuradas as Propriedades, Headers e Tratamento retorno.

      Propriedades

      • SSL - habilitar quando o serviço exigir utilização de SSL (camada extra de segurança).
      • Listar mensagens - habilitar para mostrar as mensagens de envio e recebimento no log.
      • Tempo de resposta - habilitar para mostrar o tempo que a requisição aguarda pela resposta.

      Headers

      Permite adicionar um header (cabeçalho).

      Tratamento Retorno

      • Extrair resultado: Permite selecionar esta opção para extrair um relatório em formato JSON e incluir um caminho.

      Acionar Salvar para concluir a configuração.

      Após selecionar a operação, os parâmetros de entrada e de saída serão carregados em tela. Caso necessário, é possível alterar o label desses campos.

    03. Pressione Salvar para concluir a inclusão.


    Editar operação


    01. Na janela Operações, localizar a operação a ser editada.

    02. Acionar Editar, localizado no canto direito da tela, indicado pelo símbolo de lápis.

    03. Alterar as informações desejadas.

     Essa tela apresenta os mesmos campos para configuração, conforme apresentado na ação Adicionar operação.

    04. Acionar Salvar.


    Remover operação


    01. Na janela Operações, localizar a operação a ser removida.

    02. Acionar Remover, localizado no canto direito da tela, indicado pelo símbolo de lixeira.

    03. Acionar Sim, remover a operação para confirmar a exclusão.



    Fique atento!

    Esta documentação é válida a partir da atualização 1.6.5 - Liquid. Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma.