SOAP V2

Conheça o componente e saiba como utilizá-lo.

O SOAP V2 invoca endpoints SOAP de um pipeline. Expressões em Double Braces são suportadas.

Além disso, o componente utiliza templates Apache FreeMaker para gerar a mensagem de chamada que converte o retorno de SOAP para JSON, tentando ao máximo não corromper a conversão.

Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
URL (DB)	URL a ser chamada pode conter os parâmetros seguindo o padrão {:param1}, que serão substituídos pela propriedade correspondente da mensagem de entrada.	https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente	String
Account	Conta a ser usada pelo componente. Tipos de conta suportadas: Basic e Certificate Chain. Leia a documentação sobre Contas (Accounts) para saber mais sobre os tipos de contas disponíveis.	N/A	String
Custom Account #1	Conta adicional a ser usada pelo componente via Double Braces {{ account.custom-1.value }}. Leia o artigo Funções Double Braces para saber mais sobre o tema.	N/A	String
Custom Account #2	Conta adicional a ser usada pelo componente via Double Braces {{ account.custom-2.value }}. Leia o artigo Funções Double Braces para saber mais sobre o tema.	N/A	String
Send the Request Body from a File	Se habilitada, a opção considera o conteúdo a ser enviado na chamada através de um arquivo; do contrário, será considerado o que for especificado em Template.	False	Booleano
File Name	Informa o nome do arquivo a ser enviado na chamada SOAP, se a opção Send the Request Body from a File estiver ativada.	N/A	String
Template (XML)	Template Apache FreeMarker para que a mensagem SOAP seja enviada na solicitação	N/A	String
Headers	Headers da chamada.	N/A	Object/Map
Query Params	Query parameters da chamada.	N/A	Object/Map
Connect Timeout	Tempo de expiração da conexão (em milissegundos).	30000	Inteiro
Read Timeout	Tempo máximo para leitura (em milissegundos).	30000	Inteiro
Stop On Client Error	Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.	False	Booleano
Stop On Server Error	Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.	False	Booleano
All Values As String	Se ativada, a opção vai retornar todos os valores dentro das propriedades XML em string.	False	Booleano
With Namespace	Se ativada, a opção mantém os namespaces no retorno do XML.	True	Booleano
Advanced Settings	Configurações avançadas.	False	Booleano
Allow Insecure Calls To HTTPS Endpoints	Quando ativada, a opção permite que chamadas não seguras a endpoints HTTPS sejam feitas.	False	Booleano
Raw Mode	Se ativada, a opção recebe ou passa um payload sem ser JSON.	False	Booleano
Save As Local File	Quando ativada, a opção salva o retorno como um arquivo no diretório local do pipeline. O arquivo será salvo apenas quando houver sucesso na chamada SOAP, ou seja, quando o http status code da resposta estiver entre 200 e 399.	False	Booleano
Response File Name (DB)	Nome do arquivo ou caminho completo do arquivo (ex.: tmp/processed/file.txt) onde será salva a resposta da chamada SOAP. Double Braces são suportados.	N/A	String
Enable Retries	Quando ativada, a opção permite que sejam feitas novas tentativas.	False	Booleano
Maximum Number Of Retries Before Giving Up	Número máximo de tentativas antes de desistir da chamada.	0	Inteiro
Time To Wait Before Each Retry	Tempo máximo entre tentativas (em milissegundos).	0	Inteiro
Override Response Charset	Quando ativada, a opção irá sobrescrever o charset retornado do endpoint para o charset especificado na propriedade Response Charset. Quando desabilitada ela respeitará o retorno do charset no header Content-Type. Caso não retorne nenhum charset no content type o padrão utilizado será UTF-8.	True	Booleano
Response Charset	Utilizado somente quando a opção Override Response Charset estiver ativa e forçará o uso do charset especificado nesta propriedade.	UTF-8	String

Fluxo de mensagens

Entrada

body: “<a><b>{{ message.b }}</b><#list><references as reference><c>${reference.name}</c></references></#list></a>”

Saída

{
    headers: {{ message.headers }},
    queryParams: {{ message.queryParams }},
    references: [
        {name:1},
        {name:2}
    ],
    b: “test”
}

SOAP V2 em ação

Sobre o template variável

O nome da variável também pode conter sinal de menos (-), ponto (.) e dois pontos (:) em qualquer posição, desde que eles sejam acompanhados de uma barra invertida (\) logo antes. Do contrário, os sinais podem ser interpretados como operadores.

Sobre substituição de números

Entrada

<#assign x=42>
  ${x}
  ${x?string}  <#-- the same as ${x} -->
  ${x?string.number}
  ${x?string.currency}
  ${x?string.percent}
  ${x?string.computer}

Saída

42
42
42
$42.00
4,200%
42

Formato de número

<#setting number_format="0.####">

Para verificar se o campo não é nulo

<#if varTest??>${varTest}</#if>