Etapa SOAP

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 8 min. de leitura

    • Habilite os designers de ação para enviar solicitações de serviço de saída web SOAP para sistemas externos.

    Nota:
    Etapa SOAP não está disponível no sistema básico e requer a assinatura de ServiceNow® IntegrationHub. Depois que o plug-in necessário for ativado, a etapa ficará visível em Integrações.

    Funções e disponibilidade

    • Disponível como uma etapa de ação de Designer de ações. Usuários com a função action_designer podem criar uma ação personalizada com uma ou mais etapas de ação.
    • Os designers de ação precisam da função web_service_admin para executar essas tarefas de serviços Web.
      • Selecionar WSDL
      • Carregar novo WSDL
      • Selecione uma política de WS-Security
    • O ServiceNow® MID Server não é compatível com as políticas de WS-Security.

    Campos

    Campo Descrição
    Detalhes da Conexão
    Conexão O tipo de conexão a ser usado.
    • Definir conexão em linha: Defina as informações de conexão na etapa de ação.
    • Usar alias de conexão: Defina as informações de conexão usando a tabela de alias de conexão. Usar um alias elimina a necessidade de configurar várias credenciais e perfis de informações de conexão ao usar uma ação em vários ambientes. Da mesma forma, se as informações de conexão forem alteradas, você não precisará atualizar sua ação personalizada.

    Para saber mais sobre conexões e credenciais, consulte Introdução a credenciais, conexões e aliases.
    Alias de Conexão Registro de alias de conexão e credencial que o sistema usa para executar a etapa de ação. Usuários com a função de administrador ou flow_designer podem criar ou selecionar um registro de conexão associado. Usar um alias elimina a necessidade de configurar várias credenciais e perfis de informações de conexão ao usar uma ação em vários ambientes. Da mesma forma, se as informações de conexão forem alteradas, você não precisará atualizar sua ação personalizada. Para saber mais sobre conexões e credenciais, consulte credenciais, conexões e aliases. O valor da credencial é exibido como uma cápsula de dados de Senha (criptografada bidirecionalmente) no painel de dados.
    Nota:
    Este campo está disponível quando Usar Alias de Conexão é selecionado na lista Conexão.
    Alias de credencial Alias de credencial que o sistema usa para executar a etapa de ação. Usuários com a função de administrador ou flow_designer podem criar ou selecionar um registro de conexão associado. Usar um alias elimina a necessidade de configurar várias credenciais ao usar uma ação em vários ambientes. Da mesma forma, se as informações de credencial forem alteradas, você não precisará atualizar sua ação personalizada. Para saber mais sobre conexões e credenciais, consulte credenciais, conexões e aliases. O valor da credencial é exibido como uma cápsula de dados de Senha (criptografada bidirecionalmente) no painel de dados.
    Nota:
    Este campo está disponível quando Definir conexão em linha é selecionado na lista Conexão.
    Usar MID Opção para usar um MID Server para executar o Etapa SOAP. Marque esta caixa de seleção para exibir os campos SeleçãodeMID, Aplicaçãode MID e Recursos.
    Nota:
    Este campo está disponível quando Usar Alias de Conexão é selecionado na lista Conexão.
    Endpoint O endpoint do URL para a solicitação SOAP. Se Usar Alias de Conexão estiver selecionado, este campo será somente leitura e exibirá o URL do endpoint associado ao alias. Se Definir conexão em linha estiver selecionado, insira um URL de endpoint para a conexão.
    Testar etapa SOAP Botão para testar a etapa SOAP. Para testar, selecione o botão Testar etapa SOAP. Insira os valores de entrada necessários e selecione o botão Executar teste. Após as execuções de teste, todas as saídas de etapa ou mensagens de erro são exibidas na seção Resultados de testes da janela de teste.
    Tempo limite de conexão Número de milissegundos que o sistema espera por uma conexão de host bem-sucedida. Se a etapa não estabelecer uma conexão bem-sucedida durante esse tempo, a solicitação de conexão expirará. Se Definir conexão em linha estiver selecionado, insira um valor de tempo limite para a conexão. Deixe este campo em branco para usar o valor de tempo limite de conexão padrão do sistema.
    Seleção de MID Opção para selecionar o MID Server ou Cluster do MID específico.
    • Seleção automática do MID Server: seleciona o MID Server automaticamente.
    • MID Server específico: usa o MID Server selecionado.
    • Cluster do MID específico: usa o Cluster do MID selecionado.
    Este campo fica disponível quando Definir conexão em linha é selecionado na lista Conexão e Usar MID estiver marcado
    Cluster do MID Cápsula de dados para o cluster MID que você deseja usar. Este campo fica disponível quando Definir conexão em linha é selecionado na lista Conexão, Usar MID estiver marcado e Cluster de MID específico estiver selecionado na lista Seleção de MID.
    Detalhes da Solicitação
    Criar os Envelopes O método a ser usado ao criar o envelope SOAP.
    • Do WSDL: selecione esta opção para exibir os campos Selecionar um WSDL e Operação.
    • Manualmente: selecione esta opção para inserir ou colar manualmente o texto do WSDL.
    Selecionar um WSDL O WSDL a ser usado para criar o envelope SOAP. Selecione um registro WSDL existente ou clique em Carregar novo WSDL para baixar ou inserir manualmente um arquivo WSDL. O WSDL selecionado preenche os valores dos campos Operação, AçãoSOAP e Envelope SOAP.
    Nota:
    Este campo está disponível quando você seleciona Do WSDL na lista Criar envelope.
    Carregar Novo WSDL Opção para baixar ou inserir manualmente um arquivo WSDL.
    Operação A operação a ser executada no WSDL selecionado. Cada WSDL tem sua própria lista de operações disponíveis.
    Ações de SOAP O URL para executar a ação SOAP. Se Criar envelope estiver definido como Do WSDL, este campo será somente leitura e exibirá o URL para executar a ação SOAP. Se Criar envelope estiver definido como Manualmente, insira um URL para executar a ação SOAP.
    Tipo de solicitação Formato da solicitação. As opções incluem.
    • Texto: uma solicitação em JSON, XML ou outro formato de texto.
    • Binário: uma solicitação em formato de arquivo binário.
    Envelopes de SOAP O texto XML enviado para o endpoint. Se Criar Envelope estiver definido como Do WSDL, o sistema adicionará o XML necessário para a Operação selecionada. Se Criar envelope estiver definido como Manualmente, insira o texto XML que você deseja usar. Insira valores de registro nos elementos de envelope SOAP apropriados. Por exemplo, insira uma descrição resumida do incidente no<short_description> elemento.
    Nota:
    Este campo está disponível quando o Tipo de solicitação é Texto.
    Anexo Registro de anexo que contém a solicitação. Você pode pesquisar ou criar este registro em uma etapa anterior e defini-lo como uma variável de entrada. Crie-o usando as APIs JSONStreamingBuilder e XMLStreamingBuilder na etapa de Script.
    Nota:
    Este campo está disponível quando o Tipo de solicitação é Binário.
    Redefinir Envelope Opção para descartar todas as mudanças manuais feitas no envelope SOAP. Marque esta caixa de seleção para reverter o envelope SOAP ao seu estado original.
    Nota:
    Este campo está disponível quando você seleciona Do WSDL na lista Criar envelope.
    Novo WSDL
    Nome O nome do registro WSDL que você deseja criar.
    Método de Importação O método para inserir o WSDL.
    • Baixar da URL: selecione para exibir a URL do WSDL, os campos Nome de usuárioe Senha para recuperar o WSDL de uma fonte externa, normalmente o provedor de serviços da Web.
    • Preencher manualmente o conteúdo do WSDL: selecione para exibir o campo Conteúdo do WSDL para inserir ou colar manualmente o texto do WSDL.
    URL do WSDL O URL para o serviço Web SOAP.
    Nota:
    Este campo está disponível quando você seleciona Baixar do URL na lista Método de importação.
    Nome de usuário O nome de usuário para autenticar com o SOAP Web Services.
    Nota:
    Este campo está disponível quando você seleciona Baixar do URL na lista Método de importação.
    Senha A senha para autenticar com o SOAP Web Services. O sistema sempre mascara as senhas na interface do usuário e impede sua exportação como texto simples.
    Nota:
    Este campo está disponível quando você seleciona Baixar do URL na lista Método de importação.
    Conteúdo WSDL O documento XML que descreve o serviço Web SOAP e suas operações.
    Nota:
    Este campo está disponível quando você seleciona Preencher manualmente o conteúdo do WSDL na lista Método de importação.
    Importar Opção para adicionar o WSDL do SOAP Web Services à instância.
    WS-Security
    Habilitar Política de Segurança WS Opção para restringir o SOAP Web Services a uma política de segurança. Marque esta caixa de seleção para exibir o campo Política.
    Política O registro de política que você deseja usar para restringir as conexões de serviço da Web. Selecione um registro de política existente.
    Política de nova tentativa
    Habilitar políticas de novas tentativas para habilitar a política de nova tentativa. Para obter mais informações, consulte Política de nova tentativa.
    Substituir política padrão para alias Opção para substituir a política de nova tentativa padrão. Esta caixa de seleção não é aplicável quando Definir conexão em linha é selecionado na lista de conexão.
    Política de nova tentativa Política de repetição padrão associada ao Alias de conexão. Se a opção Substituir política padrão para alias estiver selecionada, será possível substituir a política de nova tentativa padrão e selecionar outra política de nova tentativa existente com base em seus requisitos.
    Opções avançadas
    Cabeçalhos Os pares de nome-valor a serem incluídos na mensagem SOAP como cabeçalhos HTTP. Clique no ícone de adição Ícone de adição para adicionar cabeçalhos. Adicione um Nome e um Valor para cada cabeçalho HTTP.
    Cabeçalhos > Omitir se vazio Opção para excluir um cabeçalho se o valor for vazio ou nulo.
    Nota:
    Esta caixa de seleção está disponível depois de clicar na seta para baixo para exibir as opções avançadas.

    Campos de avaliação de erro de ação

    Campo Descrição
    Se esta etapa falhar Opção para continuar executando a próxima etapa ou ir para a avaliação de erro. Para usar o código de status da etapa ou a mensagem para uma condição de erro de ação personalizada, consulte Avaliação de erro de ação.

    Limite de tamanho da resposta SOAP

    O sistema limita o tamanho das respostas SOAP a 5 MB. As respostas SOAP diretas que excedem esse limite geram um erro. Para oferecer suporte a tamanhos de resposta maiores, aumente o limite de tamanho de resposta com a propriedade do sistema glide.pf.soap.response_payload_max_size. Esta propriedade do sistema oferece suporte a um valor máximo de 10 MB.