Etapa SOAP

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 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 Workflow Studio. 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.
      • Selecione WSDL
      • Carregar novo WSDL
      • Selecione uma política WS-Security

    Campos

    Campo Descrição
    Detalhes da Conexão
    Conexão O tipo de conexão a ser usado.
    • Defina a 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 flow_designer ou administrador 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 mudarem, 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 em 2 vias) 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 flow_designer ou administrador 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 mudarem, 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 em 2 vias) no painel de dados.
    Nota:
    Este campo está disponível quando Defina a 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 Seleção DE MID , Aplicação MID e . campos.
    Nota:
    Este campo está disponível quando Usar Alias de Conexão Selecionado na lista Conexão.
    Endpoint O endpoint de URL da solicitação SOAP. Se Usar Alias de Conexão Selecionado, este campo é somente leitura e exibe o URL do endpoint associado ao alias. Se Defina a conexão em linha Estiver selecionado, insira uma URL de endpoint para a conexão.
    Testar etapa SOAP Botão para testar a etapa SOAP. Para testar, selecione Etapa SOAP de teste botão. Insira os valores de entrada necessários e selecione Executar teste botão. Após a execução do teste, todas as saídas de etapa ou mensagens de erro são exibidas na seção Resultados de teste 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 fizer uma conexão bem-sucedida durante esse tempo, a solicitação de conexão atingirá o tempo limite. Se Defina a conexão em linha 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.
    Nota:
    Evite definir Tempo limite de conexão valor zero, pois isso pode causar uma conexão obsoleta.
    Seleção de MID Opção para selecionar um MID Server ou cluster DO MID específico. Escolha qualquer uma das opções a seguir.
    • MID Server de seleção automática : Seu ServiceNowa instância seleciona o. MID Serversem entrada manual.
    • MID Server específico : Seu ServiceNowusos da instância MID Serverque você especificar.
    • MID Cluster específico : Seu ServiceNowA instância usa o cluster DO MID que você especificar.

      Um cluster DO MID é um grupo de MID Servers que habilita seu ServiceNowinstância para lidar com várias integrações e melhorar a velocidade de integração. Para obter mais informações, consulte Configure a MID Server cluster.

    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 Selecione um WSDL e. Operação campos.
    • Manualmente : Selecione esta opção para inserir ou colar manualmente o texto 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 do Operação , Ação SOAP e Envelope SOAP campos.
    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 a partir do WSDL selecionado. Cada WSDL tem sua própria lista de operações disponíveis.
    Ações de SOAP A URL para executar a ação SOAP. Se Criar envelope está definido como Do WSDL Este campo é somente leitura e exibe o URL para executar a ação SOAP. Se Criar envelope está 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 está definido como Do WSDL , O sistema adiciona o XML necessário para Operação que você seleciona. Se Criar envelope está 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 em <short_description> elemento.
    Nota:
    Este campo está disponível quando 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 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 para 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 WSDL.
    • Download da URL : Selecione para exibir URL DO WSDL , Nome de usuário e Senha Campos para recuperar o WSDL de uma origem externa, normalmente o provedor de serviços da Web.
    • Preencher manualmente o conteúdo WSDL : Selecione para exibir Conteúdo do WSDL Campo para inserir ou colar manualmente o texto WSDL.
    URL do WSDL O URL para o serviço web SOAP.
    Nota:
    Este campo está disponível quando você seleciona Download da URL Na lista Método de importação.
    Nome de usuário O nome de usuário a ser autenticado com o serviço web SOAP.
    Nota:
    Este campo está disponível quando você seleciona Download da URL Na lista Método de importação.
    Senha A senha para autenticar com o serviço web SOAP. O sistema sempre mascara senhas na interface do usuário e impede a exportação delas como texto sem formatação.
    Nota:
    Este campo está disponível quando você seleciona Download da 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 WSDL Na lista Método de importação.
    Importar Opção para adicionar o WSDL do serviço web SOAP à instância.
    WS-Security
    Habilitar Políticas de segurança de serviços web Opção para restringir o serviço web SOAP a uma política de segurança. Marque esta caixa de seleção para exibir Política campo.
    Política O registro de política que você deseja usar para restringir conexões de serviço web. Selecione um registro de política existente.
    Tentar Política Novamente
    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.
    Tentar Política Novamente 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 nome-valor a serem incluídos na mensagem SOAP como cabeçalhos HTTP. Clique no ícone de adição Ícone de maispara adicionar cabeçalhos. Adicione um Nome e. Valor Para cada cabeçalho HTTP.
    Cabeçalhos > Omitir se vazio Opção para excluir um cabeçalho se o valor estiver vazio ou nulo.
    Nota:
    Esta caixa de seleção fica disponível depois de clicar na seta para baixo para exibir as opções avançadas.

    Avaliação de erro de ação

    Se esta etapa falhar
    Tipo de dados: Choice

    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 Action error evaluation.

    Limite de tamanho da resposta SOAP

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