Etapa de script

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 6 min. de leitura

    • Adicione JavaScript personalizado para executar em uma ação reutilizável. Embora a maioria das ações e etapas principais se enquadre em casos de uso comuns, você pode criar uma etapa de script para executar o comportamento não satisfeito pelas etapas principais.

    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.
    Nota:
    IntegrationHub Consulte Solicitação IntegrationHub para obter informações sobre IntegrationHub uso e assinaturas.

    Campos

    A etapa Script inclui variáveis de entrada e saída separadas que permitem mapear dados JavaScript para Workflow Studio dados. Ao definir variáveis de entrada e saída na etapa, você pode definir o que Workflow Studio os dados estão disponíveis em seu script e quais variáveis de script estão disponíveis para outras etapas em sua ação.

    Campo Descrição
    Tempo de execução necessário
    O ambiente de tempo de execução necessário para oferecer suporte ao script. As opções incluem:
    • Instância: a etapa da ação executa o script da instância. Selecione esta opção quando o script precisar de acesso à API ServiceNow ou aos dados da instância. Este é o valor padrão.
    • MID: a etapa de ação executa o script a partir do MID Server. Selecione esta opção quando o script precisar de acesso aos arquivos de script do MID Server e APIs. Selecionar esta opção exibe o campo Selecionar MID Server usando.
    • Vanilla (JavaScript core): a etapa de ação executa o script a partir da instância ou do MID Server. Selecione esta opção quando o script só precisar de acesso a APIs do JavaScript core e não à API ServiceNow ou aos dados da instância.

    O tempo de execução selecionado determina os objetos e métodos JavaScript exibidos no Ajuda contextual .

    Nota:
    Este campo só fica visível quando IntegrationHub está ativado.
    Selecionar MID Server usando
    Especifique o processo de seleção do MID Server a ser usado. As opções incluem:
    • Qualquer MID . O sistema executa a etapa de ação em qualquer MID Server disponível.
    • Usar alias de conexão . O sistema executa a ação usando o alias de conexão especificado. A seleção desta opção exibe Alias de conexão campo.
    • Use a seleção em linha . O sistema executa a ação usando os detalhes de conexão especificados na ação. A seleção desta opção exibe Host , MID e. . campos.
    Nota:
    Este campo só fica visível quando IntegrationHub está ativado e você seleciona MID de Tempo de execução necessário .
    Alias de Conexão Registro de alias de conexão e credencial que o sistema usa para executar a etapa de ação. Os usuários com a função flow_designer ou admin 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 . Há suporte para aliases do tipo de conexão Básico.
    Nota:
    Este campo só fica visível quando IntegrationHub está ativado e você seleciona Usar alias de conexão de Selecione o MID Server usando .
    Host O nome de domínio totalmente qualificado do MID Server em que o sistema executa a etapa de ação. Por exemplo, mid-server.domain.com.
    Nota:
    Este campo só fica visível quando IntegrationHub está ativado e você seleciona Use a seleção em linha de Selecione o MID Server usando .
    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 ServiceNow a instância seleciona o. MID Server sem entrada manual.
    • MID Server específico : Seu ServiceNow usos da instância MID Server que você especificar.
    • MID Cluster específico : Seu ServiceNow A instância usa o cluster DO MID que você especificar.

      Um cluster DO MID é um grupo de MID Servers que habilita seu ServiceNow instâ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 estará disponível quando MID Está selecionado na lista Tempo de execução obrigatório, e. Use a seleção em linha Está selecionado na lista Selecionar MID Server usando.
    Cluster do MID Cápsula de dados para o cluster MID que você deseja usar. Este campo estará disponível quando MID Está selecionado na lista Tempo de execução obrigatório, e. Use a seleção em linha Está selecionado na lista Selecionar MID Server usando.
    Aplicação de MID Especifique a aplicação que o MID Server deve oferecer suporte para ser qualificado para seleção. O sistema executa a etapa de ação a partir de um MID Server que oferece suporte à aplicação selecionada. Este campo só fica visível quando IntegrationHub está ativado, MID Server de seleção automática É selecionado na lista Seleção DO MID e você seleciona Use a seleção em linha de Selecione o MID Server usando .
    Capacidades . MID Server deve ser compatível para ser elegível para a seleção. O sistema executa a etapa de ação de um MID Server que oferece suporte às capacidades selecionadas. Este campo só fica visível quando IntegrationHub está ativado, MID Server de seleção automática É selecionado na lista Seleção DO MID e você seleciona Use a seleção em linha de Selecione o MID Server usando .
    MID Server específico Cápsula de dados do necessário MID Server. Este campo só fica visível quando IntegrationHub está ativado, MID Server específico É selecionado na lista Seleção DO MID e você seleciona Use a seleção em linha de Selecione o MID Server usando .
    Variáveis de entrada Pares nome-valor que representam dados da ação, permitindo que você use entradas de ação e dados de outras etapas em um script.
    Script
    Script que é executado na ação. Para acessar variáveis de entrada e saída no script, use os objetos globais entradas e. saídas . Por exemplo, Inputs.myVariable .
    Nota:
    Os nomes de entrada e saída da etapa de script não podem incluir nenhum dos seguintes nomes de sistema reservados:
    • sys_id
    • sys_created_by
    • sys_created_on
    • sys_updated_on
    • sys_updated_by
    • sys_mod_count
    Em geral, não crie uma variável que tenha o mesmo nome de um campo do sistema. A etapa de script pode confundir essa variável de entrada para um nome de campo e usar o valor errado.
    A etapa Script sempre converte dados armazenados no entradas e. saídas objetos globais em cadeias de caracteres. Se sua etapa de script precisar funcionar com dados JSON, você poderá usar o. entradas Objeto global para converter os dados JSON em uma cadeia de caracteres. Como alternativa, você pode definir uma variável JavaScript como uma cadeia de caracteres em vez de um objeto JavaScript. Por exemplo, este script ilustra duas maneiras de gerar dados JSON.
    (function execute(inputs, outputs) {
  outputs.json_object_1 = inputs.json_input;
  var array_of_objs = '[{"name1":"value1"}, {"id":"abcd"}]';
  outputs.json_object_2 = array_of_objs;
})(inputs, outputs);

    Por padrão, Workflow Studio execute scripts na instância. Para executar script de um MID Server, é necessário um IntegrationHub assinatura.

    Workflow Studio executa o script do domínio a partir do qual ele é acionado ou iniciado. Consulte Separação de domínios e Workflow Studio.

    Para classes e métodos disponíveis, consulte Ajuda sensível ao contexto da API JavaScript ou o. API reference.
    Variáveis de saída Mapeie a saída JavaScript para Workflow Studio cápsulas de dados. Defina variáveis de saída quando quiser que outras etapas na ação usem a saída do script.

    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 Avaliação de erro de ação.

    Exemplo

    Este exemplo cria uma carga JSON que pode ser facilmente atualizada ou alterada e adicionada a uma etapa REST subsequente.

    Nota:
    Etapa REST não está disponível no sistema básico e requer a assinatura de ServiceNow® IntegrationHub.

    Etapa de script de exemplo em uma ação.

    Ao criar uma variável de saída que representa a carga, você pode arrastar o. [Carga] Cápsula de dados para a etapa REST Corpo campo.