Atividade API SOAP Response no Jitterbit Studio
Introdução
Uma atividade API SOAP Response, usando sua conexão API pré-configurada, retorna dados para uma API personalizada do API Manager e destina-se a ser usada como um alvo para consumir dados em uma operação.
A atividade API SOAP Response pode ser configurada usando apenas um esquema WSDL. Para interagir com uma conexão API usando um esquema JSON, XML, CSV ou XSD, use uma atividade API Response que não seja SOAP. Para interagir com uma conexão SOAP sem usar uma API personalizada, use o conector SOAP.
Para obter informações sobre a relação entre as atividades do conector API e as APIs do API Manager, consulte estes recursos:
Criar uma atividade API SOAP Response
Uma instância de uma atividade API SOAP Response é criada a partir da conexão API pré-configurada usando seu tipo de atividade SOAP Response.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para mais detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.
Uma atividade API SOAP Response existente pode ser editada a partir destes locais:
- A tela de design (consulte Menu de ações do componente em Tela de design).
- A aba Components do painel de projeto (consulte Menu de ações do componente em Aba Components do painel de projeto).
Configurar uma atividade API SOAP Response
Siga estas etapas para configurar uma atividade API SOAP Response:
- Etapa 1: Inserir um nome e especificar configurações
Forneça um nome para a atividade e selecione o método a ser usado para fazer upload do esquema WSDL. - Etapa 2: Revisar os esquemas de dados
Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.
Etapa 1: Inserir um nome e especificar configurações
Nesta etapa, forneça um nome para a atividade e selecione o método a ser usado para fazer upload do esquema WSDL. Cada elemento da interface do usuário desta etapa é descrito a seguir.
-
Name: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade API SOAP Response e não deve conter barras
/ou dois-pontos:. -
Upload URL, Upload file ou Select existing: Use o botão de opção para selecionar a fonte do arquivo WSDL (Web Services Description Language) para fazer upload ou reutilizar. Arquivos de até 5 MB podem ser enviados.
-
Upload URL: Insira a URL do arquivo WSDL na caixa de texto e clique no botão Upload. A URL deve estar 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 upload (consulte Requisitos de upload de WSDL). Se estiver fazendo upload de um WSDL com o mesmo nome de um WSDL existente, consulte Possíveis erros mais adiante nesta página.
-
Upload file: Use o botão Browse à direita para procurar localmente um arquivo WSDL ou ZIP. Um arquivo ZIP pode conter qualquer arquivo XSD do qual o WSDL depende. Se o arquivo ZIP contiver mais de um arquivo WSDL, selecione o WSDL raiz quando solicitado. Em seguida, clique no botão Upload. Se o upload exibir um erro de validação, consulte Requisitos de upload de WSDL. Se estiver fazendo upload de um WSDL com o mesmo nome de um WSDL existente, consulte Possíveis erros mais adiante nesta página.
-
Nota
Qualquer schemaLocation deve ser resolvido para um arquivo local usando uma referência relativa. Geralmente, em vez de fornecer uma tupla como:
xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'
você forneceria:
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: Use o menu suspenso para selecionar um arquivo WSDL existente que foi usado anteriormente no projeto atual.
-
Porta: Use o menu suspenso para selecionar a porta apropriada.
-
Serviço e Binding: Por padrão, esses campos são preenchidos automaticamente com base no WSDL e na porta fornecidos e não podem ser editados.
-
Operação: Use o menu suspenso para selecionar o método do WSDL fornecido que você deseja executar com essa atividade.
-
Salvar e Sair: Se habilitado, clique para salvar a configuração dessa etapa e feche a configuração da atividade.
-
Próximo: Clique para armazenar temporariamente a configuração dessa etapa e prossiga para a próxima etapa. A configuração não será salva até você clicar no botão Concluído na última etapa.
-
Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme se deseja descartar as alterações.
Etapa 2: Revisar os esquemas de dados
Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos:
-
Esquemas de dados: Os esquemas de solicitação e resposta dessa atividade são exibidos. Esses esquemas de dados são herdados por transformações adjacentes e exibidos novamente durante o mapeamento de transformação.
Nota
Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.
-
Voltar: Clique para armazenar temporariamente a configuração dessa etapa e retorne à etapa anterior.
-
Concluído: Clique para salvar a configuração de todas as etapas e feche a configuração da atividade.
-
Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme se deseja descartar as alterações.
Possíveis erros
As seções a seguir cobrem erros que podem ocorrer durante a configuração da atividade.
Não é possível fazer upload do WSDL
Ao substituir um WSDL fazendo upload de um com o mesmo nome usando Upload de URL ou Upload de Arquivo, e as operações do WSDL de substituição não tiverem os mesmos nomes daqueles em uso pelas atividades existentes, ou se operações WSDL em uso estiverem faltando no WSDL de substituição, este erro pode ocorrer:
Texto do diálogo
Não é possível fazer upload do WSDL
Este WSDL não pode ser substituído porque está faltando operações WSDL usadas pelas atividades existentes listadas abaixo. Delete essas atividades da guia Componentes do painel do projeto e tente novamente.
-
Atividades que devem ser deletadas
Atividade 1 (API) -
Operações WSDL indefinidas em uso por essas atividades
Operação 1
Para resolver, certifique-se de que as operações WSDL tenham os mesmos nomes daquelas em uso pelas atividades existentes.
Falha ao implantar
Ao implantar uma operação cujo arquivo WSDL da atividade SOAP Request foi substituído, você pode receber este erro:
Falha ao implantar - Erro do cliente: Não há arquivo carregado com caminho do cliente ... Atualize para o Studio 8.4.0 ou superior e implante o projeto novamente.
Para resolver, siga estas etapas:
-
Abra a atividade em que o arquivo WSDL foi substituído.
-
Na etapa 1, reselecione o arquivo WSDL a ser usado pela atividade e clique em Próximo.
-
Na etapa 2, clique em Concluído.
-
Implante a operação.
Se você receber Failed to deploy - Internal Error: No WSDL with locator, consulte Erro de implantação SOAP: "No WSDL with locator" no guia de resolução de problemas do Connector.
Próximas etapas
Após configurar uma atividade de Resposta SOAP da API, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as definições da operação, que incluem a capacidade de encadear operações que estão nos mesmos workflows ou em workflows diferentes.
As ações de menu para uma atividade são acessíveis no painel do projeto e na tela de design. Para mais detalhes, consulte Menu de ações da atividade em Noções básicas do Connector.
As atividades de Resposta SOAP da API podem ser usadas como destino com estes padrões de operação:
- Padrão de arquivo
- Padrão de script
- Padrão de transformação
- Padrão de arquivo com dois destinos (apenas como segundo destino)
- Padrão de arquivo HTTP com dois destinos (apenas como segundo destino)
- Padrão de transformação com dois destinos (apenas como segundo destino)
Quando pronto, implante a operação e valide o comportamento verificando os logs da operação.
Importante
As operações acionadas por uma API personalizada do API Manager possuem logs adicionais que podem ser habilitados. Para detalhes sobre o que aparece nos logs da operação e como habilitar logs adicionais, consulte Dados de solicitação e resposta da API em Logs da operação.
Configurar uma API personalizada do API Manager
Após a operação estar configurada e implantada, configure uma API personalizada usando o API Manager.
Nota
Após configurar uma API personalizada para chamar uma operação do Studio, você não poderá deletar a operação sem deletar a API ou alterar a configuração da API para que ela não chame mais a operação.