Histórico da Página

As configurações disponíveis são exibidas na lateral direita.

Título
Nome da etapa que representa a execução de um serviço externo. O nome também pode ser alterado diretamente no componente, clicando sobre seu nome atual e depois em EditarImage Added– localizado no lado direito.

Selecione o serviço
Serviço externo que será utilizado para executar alguma ação. É possível selecionar serviços do tipo SOAP que já existem no recurso Serviços do Painel de controle.

Tipo de execução
Forma como a requisição do serviço externo será executada. As opções disponíveis são:

• Automatizado: a requisição é executada de forma assíncrona. Deve ser utilizado quando a execução não necessita de um retorno imediato sobre a operação ter sido ou não executada com êxito;

• Imediato: a requisição é executada de forma síncrona. Deve ser utilizado quando a execução necessita de um retorno imediato sobre a operação para que o processo possa seguir adiante.

Tentativas
Número de vezes que o componente deve tentar executar a operação do serviço antes que seja encaminhado para o evento intermediário de captura de erro. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado.

A cada
Intervalo que o componente deve considerar entre uma tentativa e outra de execução. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado.

Frequência
Unidade de tempo que o componente deve considerar para fazer os intervalos e as tentativas de execução. Esse campo somente é exibido ao selecionar o tipo de execução Automatizado. As opções disponíveis são:

• Minuto;
• Hora;
• Dia.

Mensagem
Mensagem que será exibida na conclusão da execução da operação do serviço.

Selecione a ação (operação)
Método do serviço correspondente à ação que será feita a partir da integração.

Defina o tempo de resposta
Tempo que a requisição pode aguardar para obter resposta sobre a execução da operação do serviço.

Ativar conexão segura (SSL)
Quando ativada, determina que a comunicação com o serviço será segura e evitará que terceiros acessem os dados trocados durante a integração.

Ativar Chunking
Quando ativada, determina que a resposta do serviço será dividida em partes menores, evitando que o processo fique pesado ou apresente inconsistências.

Os headers ou cabeçalhos são informações adicionais ou metadados que são enviados juntos com a requisição do serviço para que a integração funcione corretamente. Mais detalhes e exemplos podem ser obtidos em Headers.

Nome do header
Nome para identificação do header que será adicionado.

Objeto
Objeto do serviço que possui informações que precisam ser enviadas junto com a requisição. São exibidos para seleção apenas os objetos que possuem campos.

Para editar as configurações do header adicionado, basta clicar em Editar header Image Added– localizado no lado direito.

Também é possível excluir o header adicionado clicando em Excluir header Image Added.

Os parâmetros exibidos são os que pertencem ao método/operação que foi selecionado em Selecione a ação (operação) na aba Geral.

Esses parâmetros são os dados que o método/operação precisa receber para ser executado. Mais detalhes e exemplos podem ser obtidos em Parâmetros.

As opções disponíveis são:

• Campo de formulário: quando selecionada, determina que o valor que será passado para o parâmetro será obtido de um campo do formulário do processo. Essa opção somente é exibida quando existe um formulário vinculado ao processo e não é exibida para parâmetros do tipo lista ou objeto;

• Variável: quando selecionada, determina que o valor que será passado para o parâmetro será obtido de uma variável padrão existente no contexto do processo. Essa opção não é exibida para parâmetros do tipo lista ou objeto;

• Nulo: quando selecionada, determina que nenhum valor será passado para esse parâmetro;

• Fixo: quando selecionada, determina que o valor que será passado para o parâmetro é um valor fixo que será informado no componente.

Se a origem selecionada foi:

• Campo de formulário: selecione o campo do formulário do processo do qual será obtido o valor que será passado para o parâmetro. São exibidos todos os campos que pertencem ao formulário vinculado ao processo;

• Variável: selecione a variável padrão do contexto do processo da qual será obtido o valor que será passado para o parâmetro. As variáveis disponíveis são:
  • WKCompany;
  • WKUser;
  • WKCardId;
  • WKCurrentState;
  • WKDef;
  • WKFormId;
  • WKNextState;
  • WKNumProcess;
  • WKNumState;
  • WKUserComment;

• Fixo: informe o valor fixo que será passado para o parâmetro.

Os parâmetros exibidos são os que pertencem ao objeto em questão. É possível configurar todos os parâmetros do objeto da mesma forma que é feito para os demais parâmetros.

Se um dos parâmetros do objeto também for do tipo objeto, é possível configurar seus respectivos parâmetros da mesma forma, clicando em Editar objeto Image Added e configurando os respectivos valores para cada parâmetro. E assim sucessivamente para cada parâmetro que for do tipo objeto.

Se um dos parâmetros do objeto for do tipo lista, é possível configurar seus parâmetros clicando em Adicionar via lista Image Added e configurando os respectivos valores para cada parâmetro da lista.

Os parâmetros exibidos são os que pertencem à lista em questão. É possível configurar todos os parâmetros da lista da mesma forma que é feito para os demais parâmetros.

Se um dos parâmetros da lista for do tipo objeto, é possível configurar seus parâmetros clicando em Editar objeto Image Added e configurando os respectivos valores para cada parâmetro do objeto. E assim sucessivamente para cada parâmetro que for do tipo objeto.

Para excluir um valor adicionado, basta clicar em Excluir Image Added– localizado na coluna Ação.

As opções disponíveis são:

• Campo de formulário: quando selecionada, determina que o valor para esse atributo será obtido de um campo do formulário do processo. Essa opção somente é exibida quando existe um formulário vinculado ao processo;

• Variável: quando selecionada, determina que o valor para esse atributo será obtido de uma variável padrão existente no contexto do processo;

• Fixo: quando selecionada, determina que o valor para esse atributo é um valor fixo que será informado no componente.

Se a origem selecionada foi:

• Campo de formulário: selecione o campo do formulário do processo do qual será obtido o valor para o atributo. São exibidos todos os campos que pertencem ao formulário vinculado ao processo;

• Variável: selecione a variável padrão do contexto do processo da qual será obtido o valor para o atributo. As variáveis disponíveis são:
  • WKCompany;
  • WKUser;
  • WKCardId;
  • WKCurrentState;
  • WKDef;
  • WKFormId;
  • WKNextState;
  • WKNumProcess;
  • WKNumState;
  • WKUserComment;

• Fixo: informe o valor fixo para o atributo.

Os dados de retorno exibidos são os que pertencem ao método/operação que foi selecionado em Selecione a ação (operação) na aba Geral.

Eles são os dados que a operação retorna depois de ser executada. Mais detalhes e exemplos podem ser obtidos em Retorno.

As opções disponíveis são:

• Descartar: quando selecionada, determina que o valor que será retornado por esse parâmetro do método/operação não será utilizado em nenhum momento no processo e, por isso, pode ser descartado. Essa opção somente é exibida quando existe um formulário vinculado ao processo;

• Formulário: quando selecionada, determina que o valor que será retornado por esse parâmetro do método/operação deve ser armazenado em um campo do formulário do processo. Essa opção somente é exibida quando existe um formulário vinculado ao processo.

Se o destino selecionado foi:

• Formulário: selecione o campo do formulário do processo no qual o valor retornado pelo método/operação deve ser armazenado. São exibidos todos os campos que pertencem ao formulário vinculado ao processo.

Os parâmetros exibidos são os que pertencem ao objeto retornado em questão. É possível configurar todos os parâmetros do objeto retornado da mesma forma que é feito para os demais parâmetros de retorno.

Se um dos parâmetros do objeto retornado também for do tipo complexo, como objeto ou lista, é possível configurar seus respectivos parâmetros da mesma forma, clicando em Editar objeto Image Added. E assim sucessivamente para cada parâmetro do objeto retornado que for do tipo complexo, como objeto ou lista.