Etapa de script

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 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 ajuste a casos de uso comuns, você pode criar uma etapa de script para executar um 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:
    Integration Hub Ver Solicitação Integration Hub para obter informações sobre Integration Hub 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 quais Workflow Studio 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 na Ajuda sensível ao contexto.

    Nota:
    Este campo só está visível quando Integration Hub 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 de 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 o campo Alias de conexão.
    • Usar seleção em linha. O sistema executa a ação usando os detalhes da conexão especificados na ação. A seleção desta opção exibe os campos Host, Aplicação de MIDe Capacidades.
    Nota:
    Este campo só está visível quando Integration Hub está ativado e você seleciona MID em 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. 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. Somente aliases do tipo de conexão Básica são compatíveis.
    Nota:
    Este campo só está visível quando Integration Hub está ativado e você seleciona Usar alias de conexão em Selecionar 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ó está visível quando Integration Hub está ativado e você seleciona Usar seleção em linha em Selecionar MID Server usando.
    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 está disponível quando MID é selecionado na lista Tempo de execução necessário e Usar seleção em linha é selecionado na lista Selecionar MID Server usando.
    Cluster do MID Cápsula de dados para o cluster MID que você deseja usar. Este campo está disponível quando MID é selecionado na lista Tempo de execução necessário e Usar seleção em linha é selecionado na lista Selecionar MID Server usando.
    Aplicação de MID Especifique a aplicação que o MID Server deve suportar para estar qualificado para seleção. O sistema executa a etapa de ação de um MID Server que oferece suporte à aplicação selecionada. Este campo só está visível quando Integration Hub está ativado, Seleção automática de MID Server está selecionado na lista Seleção de MID e você seleciona Usar seleção em linha em Selecionar MID Server usando.
    Capacidades Capacidades que o MID Server deve oferecer suporte para estar qualificado para seleção. O sistema executa a etapa de ação a partir de um MID Server que oferece suporte aos recursos selecionados. Este campo só está visível quando Integration Hub está ativado, Seleção automática de MID Server está selecionado na lista Seleção de MID e você seleciona Usar seleção em linha em Selecionar MID Server usando.
    MID Server específico Cápsula de dados do MID Servernecessário. Este campo só está visível quando Integration Hub está ativado, o MID Server específico está selecionado na lista Seleção de MID e você seleciona Usar seleção em linha em Selecionar MID Server usando.
    Variáveis de entrada Pares de 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 dentro da ação. Para acessar variáveis de entrada e saída em seu script, use as entradas e saídasde objetos globais. 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 com um nome de campo e usar o valor incorreto.
    A etapa Script sempre converte os dados armazenados nas entradas e gera objetos globais em cadeias de caracteres. Se a etapa de script precisar funcionar com dados JSON, você poderá usar o objeto global de entradas 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 executa scripts na instância. Para executar o script de um MID Server, é necessária uma assinatura Integration Hub.

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

    Para obter classes e métodos disponíveis, consulte a ajuda sensível ao contexto da API JavaScript ou o API reference.
    Variáveis de saída Mapeie a saída do 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® Integration Hub.

    Exemplo Etapa de script em uma ação.

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