Conexão SOAP
Introdução
Uma conexão SOAP, criada usando o conector SOAP, estabelece conexões usando o Simple Object Access Protocol (SOAP). Após configurar uma conexão, você pode criar instâncias de atividades SOAP associadas a essa conexão para serem usadas como origens (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).
Criar ou editar uma conexão SOAP
Uma nova conexão SOAP é criada usando o conector SOAP em um destes locais:
- A guia Project endpoints and connectors da paleta de componentes de design (consulte Paleta de componentes de design).
- A página Global Endpoints (consulte Criar um endpoint global em Global Endpoints).
Uma conexão SOAP existente pode ser editada nestes locais:
- A guia Project endpoints and connectors da paleta de componentes de design (consulte Paleta de componentes de design).
- A guia Components do painel de projetos (consulte Menu de ações de componentes em Guia Components do painel de projetos).
- A página Global Endpoints (consulte Editar um endpoint global em Global Endpoints).
Configurar uma conexão SOAP
Cada elemento da interface do usuário da tela de configuração da conexão SOAP é descrito abaixo.
Nota
Não é possível editar configurações que afetam atividades já em uso. Essas configurações aparecem desativadas na interface.
Dica
Campos com um ícone de variável permitem usar variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete de abertura [ no campo ou clique no ícone de variável para exibir um menu com as variáveis existentes para escolher.
-
Connection name: Digite um nome para identificar a conexão SOAP. O nome deve ser único para cada conexão SOAP e não deve conter barras (
/) ou dois-pontos (:). Esse nome também é usado para identificar o endpoint SOAP, que se refere tanto a uma conexão específica quanto a suas atividades. -
Upload URL, Upload file ou Select existing: Use o botão de opção para selecionar a origem do arquivo WSDL a ser enviado ou reutilizado. Arquivos com até 5 MB de tamanho podem ser enviados.
-
Upload URL: Digite a URL do arquivo WSDL na caixa de texto e clique no botão Upload. A URL deve ser acessível sem autenticação. Se a URL exigir autenticação ou não retornar um arquivo WSDL válido, o Studio exibe um erro no envio (consulte Requisitos de upload de WSDL). Se estiver enviando um WSDL com o mesmo nome de um WSDL existente, consulte Substituir um WSDL enviado adiante nesta página.
-
Upload file: Clique em Browse para selecionar um arquivo WSDL ou ZIP. Um arquivo ZIP pode incluir arquivos XSD dos quais o WSDL depende. Se o arquivo ZIP contiver mais de um arquivo WSDL, selecione o WSDL raiz quando solicitado. Em seguida, clique em Upload. Se o envio exibir um erro de validação, consulte Requisitos de upload de WSDL. Para enviar um WSDL com o mesmo nome de um já existente, consulte Substituir um WSDL enviado abaixo.
Nota
Qualquer
schemaLocationdeve apontar para um arquivo local usando uma referência relativa. Isso geralmente significa que em vez de fornecer uma tupla como esta:xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'
-
Isto deve ser fornecido em seu lugar:
xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'
No exemplo acima, o arquivo XSD wsdlmime-2004-08-24.xsd está localizado no mesmo diretório ou em um caminho relativo ao WSDL sendo carregado.
-
Selecionar existente: Escolha entre arquivos WSDL usados anteriormente no projeto atual.
-
Porta: Selecione a porta apropriada no menu suspenso.
Nota
Ao editar uma conexão, este campo fica desabilitado se você já tiver atividades para o endpoint em uso.
-
URL do serviço web: Digite a URL do serviço web. Por padrão, este campo é preenchido com a URL do WSDL.
-
Serviço e Vinculação: Estes campos são preenchidos automaticamente com base no WSDL e na porta e não podem ser editados.
-
Configurações opcionais: Clique para expandir configurações opcionais adicionais.
-
Ativar codificação de conteúdo: Quando selecionado, envia o cabeçalho Accept-Encoding com a codificação suportada pelo Harmony (atualmente Gzip).
-
Ativar codificação de transferência em fragmentos: Quando selecionado, envia o cabeçalho Transfer-Encoding: chunked. Isto é útil ao transferir grandes conjuntos de dados.
-
Enviar Expect: 100-continue: Quando selecionado, envia o cabeçalho Expect: 100-continue. Isto garante que o servidor HTTP valide os cabeçalhos antes de qualquer dado ser enviado. Isto é útil para enviar grandes quantidades de dados sem codificação de transferência em fragmentos.
-
Permitir criptografia fraca: Selecione para se comunicar com servidores HTTP usando criptografia fraca (DES/3DES e RC4).
-
Definir Accept-Encoding como Gzip: Selecionado por padrão, isto informa ao servidor HTTP que o Harmony pode aceitar respostas compactadas com Gzip. O Harmony segue o padrão RFC 1952 e descompacta automaticamente as respostas HTTP compactadas com Gzip. Se o servidor não usar Gzip, o Harmony percebe que a resposta não está compactada e a trata normalmente.
Nota
Esta configuração não está relacionada ao conector Gzip.
-
Versão SSL: Selecione uma versão SSL específica se o servidor HTTP exigir.
-
Cabeçalhos de solicitação: Digite os cabeçalhos HTTP, com cada cabeçalho em sua própria linha, a menos que encapsulados de acordo com os padrões HTTP. Este campo aceita variáveis globais, variáveis de projeto e variáveis Jitterbit usando colchetes
[ ].
-
-
Nome de usuário e Senha: Digite as credenciais para acessar o WSDL, se necessário. Deixe em branco se nenhuma autenticação for necessária.
Por padrão, o Harmony negocia com o endpoint para determinar quais métodos de autenticação são suportados e usa as credenciais fornecidas contra um dos protocolos. O Harmony aceita estas opções de autenticação HTTP:
- HTTP Basic
- HTTP Digest
- HTTP Digest com autenticação com sabor IE
-
Certificado: Selecione um certificado para se autenticar com o servidor HTTP. Você pode gerenciar certificados SSL do lado do cliente no Console de Gerenciamento em Personalizações > Certificados do cliente.
-
Tentar novamente: Esta configuração é funcional apenas em ambientes que usam um grupo de agente privado. Ela tenta novamente as solicitações quando um endpoint SOAP retorna estes códigos de status:
500,501,502,503ou504.Os agentes privados devem estar na versão 10.29 ou posterior para este recurso funcionar. Versões de agente anteriores ignoram esta configuração.
Marque a caixa de seleção Tentar novamente para expandir opções de configuração adicionais.
- Intervalo de repetição (segundos): Digite quanto tempo esperar (máximo 5 segundos) entre as tentativas de repetição.
-
Máx. de tentativas: Digite quantas vezes (máximo 5) tentar novamente a requisição. Se a requisição ainda falhar após todas as tentativas, uma exceção aparece no registro de operações. O agente privado também registra cada tentativa no arquivo
jitterbit.log.Todas as tentativas contam como parte da mesma execução de operação, com um único registro no registro de operações. Qualquer ação de operação para operações subsequentes é acionada com base no status final após todas as tentativas.
Nota
Essas configurações substituem as variáveis do Jitterbit
jitterbit.web_service_call.retry_wait_secondsejitterbit.web_service_call.number_of_retriesse essas variáveis estiverem definidas. -
Selecionar métodos: Selecione os métodos que deseja disponibilizar como origens ou destinos em operações.
Nota
Não é possível remover métodos selecionados anteriormente que já estão em uso por atividades SOAP.
-
Atividade selecionada e Nome de exibição: Conforme você seleciona os métodos acima, eles são adicionados à tabela abaixo, mostrando cada método selecionado que será renderizado como um bloco de atividade na conexão SOAP na paleta de componentes. Para editar um Nome de exibição, clique no ícone de edição e digite um novo nome.
Nota
Atividades selecionadas anteriormente que estão configuradas como um componente do projeto não podem ser removidas.
-
Testar: Clique para verificar a conexão usando a configuração fornecida.
-
Salvar: Clique para salvar e fechar a configuração de conexão.
-
Descartar alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem solicita que você confirme que deseja descartar as alterações.
-
Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (consulte Dependências de componentes, exclusão e remoção). Uma mensagem solicita que você confirme que deseja excluir a conexão.
Requisitos para carregamento de WSDL
O Studio valida um arquivo ou URL ao carregá-lo. Um erro de validação no carregamento significa que o arquivo ou URL não atende aos seguintes requisitos:
-
Tipo de arquivo: Ao usar Carregar arquivo, o arquivo deve ser um arquivo WSDL ou ZIP. Outros tipos de arquivo exibem um diálogo Tipo de arquivo não suportado.
-
URL: Ao usar Carregar URL, a URL deve retornar um arquivo WSDL e estar acessível sem autenticação. Uma URL que requer autenticação exibe um erro que começa com
Request failed with status codeseguido pelo código de status HTTP, como401. -
WSDL: O WSDL deve ser um documento WSDL válido com um elemento raiz
<definitions>. Um esquema XSD não é um WSDL válido. Itens aos quais o WSDL se refere, como mensagens, devem estar definidos no WSDL. Um WSDL que não pode ser analisado exibe um erro que começa comFailed to parse WSDLseguido pelo problema específico. -
Arquivo ZIP: Um arquivo ZIP deve conter pelo menos um arquivo WSDL e pode incluir arquivos XSD dos quais o WSDL depende. Um arquivo ZIP sem um WSDL válido, como um que contém apenas arquivos XSD, exibe um erro. O WSDL pode estar em uma pasta dentro do arquivo ZIP. Se o arquivo ZIP contiver mais de um arquivo WSDL, o Studio exibe um diálogo Selecionar WSDL raiz onde você escolhe o arquivo raiz.
-
Arquivos XSD importados: Arquivos XSD que o WSDL importa devem usar caminhos relativos em
schemaLocatione ser carregados em um arquivo ZIP junto com o WSDL, no local relativo queschemaLocationespecifica. Se um arquivo importado estiver faltando, o erro incluino such file or directorye termina com o nome do arquivo que está faltando. Para detalhes, consulte SOAP WSDL: schemaLocation deve usar referências relativas.
Substituir um WSDL carregado
Ao substituir um WSDL carregando um com o mesmo nome, suas operações WSDL devem ter os mesmos nomes que qualquer operação atualmente em uso por atividades existentes. Se não tiverem os mesmos nomes ou se as operações WSDL em uso estiverem faltando no WSDL de substituição, a seguinte mensagem de erro instruirá você a excluir essas atividades primeiro e listará quais atividades precisam ser excluídas:
Texto do diálogo
Não é possível fazer upload do WSDL
Não é possível substituir este WSDL porque está faltando operações WSDL utilizadas pelas atividades existentes listadas abaixo. Delete estas atividades na aba Componentes do painel do projeto e tente novamente.
-
Atividades que devem ser deletadas
Activity 1 (SOAP Endpoint) -
Operações WSDL indefinidas que estão em uso por estas atividades
Operation 1
Após a exclusão, a seguinte mensagem de confirmação lista as atividades que podem ser afetadas pela substituição do WSDL para revisar as transformações adjacentes em busca de possíveis erros de mapeamento. Ao confirmar a mensagem, o WSDL será substituído em todos os locais onde é utilizado em todo o projeto:
Texto do diálogo
Substituir arquivo?
Este WSDL possui operações WSDL que substituirão as utilizadas pelas atividades existentes listadas abaixo. Como as transformações podem herdar esquemas de atividades, revise as transformações adjacentes em busca de erros de mapeamento.
-
Atividades que podem ser afetadas
Activity 1 -
Operações WSDL definidas que estão em uso por estas atividades
Operation 1
Solução de problemas
O deployment de um projeto que inclui uma conexão SOAP pode falhar com um erro similar a este:
Texto do erro
Failed to deploy - Internal Error: No WSDL with locator '0a12b345-6c7d-8e9f-0ghi-1jkl23m4567n.wsdl' has been added to this project. Upgrade to the 8.4.0 Studio or higher and deploy the project again. Try the operation again, if the problem persists please contact Jitterbit support.
Isto significa que o projeto referencia um WSDL que não está mais disponível, e fazer o re-upload do WSDL resolve o problema. Antes da versão Harmony 12.9, fazer o deployment de um projeto podia também deletar arquivos WSDL que ainda estavam em uso, geralmente aparecendo após o projeto ser transferido para outro ambiente. A versão 12.9 impede essa exclusão, mas um WSDL deletado antes disso ainda deve ser feito o re-upload.
O mesmo erro pode ocorrer para as atividades SOAP Request e SOAP Response da API, que fazem upload de um WSDL na atividade em vez de em uma conexão.
Se fez upload de múltiplos WSDLs, pode-se identificar qual tem o problema seguindo estas etapas:
-
Exporte o projeto como um arquivo JSON.
-
Abra o arquivo JSON em um editor de texto.
-
Procure pelo locator sem o sufixo
.wsdl. Por exemplo:0a12b345-6c7d-8e9f-0ghi-1jkl23m4567n -
A correspondência aparecerá em um objeto com uma chave
wsdlDocumentId:"wsdlDocumentId": "0a12b345-6c7d-8e9f-0ghi-1jkl23m4567n" -
Encontre informações de identificação de endpoint próximas, em um bloco
endpoint-configurationou em campos comolabel,name,portName, etc. Também podem ser vistos nomes de operações associados ao WSDL (importAccount,importInventory, etc.) para confirmar qual endpoint é.Caution
O campo
duplicateRefpode aparecer em exports como um campo de linhagem de duplicação (não um identificador WSDL) e pode referenciar componentes não relacionados (scripts/transformações).
Para fazer o re-upload do WSDL:
-
Re-importe o WSDL através das opções Upload URL ou Upload file. Não selecione Select existing. Se o upload exibir um erro de validação, veja Requisitos de upload WSDL.
-
Revise a configuração do endpoint SOAP. Pode ser necessário re-selecionar a porta SOAP e os métodos. Depois clique em Save.
-
Revise a configuração de qualquer atividade SOAP que utilize o endpoint SOAP para regenerar seus esquemas.
-
Atualize a configuração de qualquer transformação downstream para mudanças de mapeamento.
Recomendamos deletar o WSDL com erro após remover quaisquer atividades dependentes.
Próximas etapas
As ações de menu para uma conexão e seus tipos de atividade são acessíveis no painel de projeto e na paleta de componentes de design. Para detalhes, consulte Menus de ações em Conceitos básicos de conector.
Após configurar uma conexão SOAP, você pode configurar uma ou mais atividades SOAP associadas a essa conexão para serem usadas como uma fonte que fornece dados a uma operação ou como um destino que consome dados em uma operação, ou você pode usar a conexão SOAP em um script.
Para mais informações, consulte Atividades SOAP.