Ação Aguardar mensagem

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • Pausar um fluxo até que ele receba uma mensagem específica da API de fluxo. Especifique a mensagem de cadeia de caracteres que retoma a execução do fluxo e, opcionalmente, forneça um valor de tempo limite para retomar o fluxo se nenhuma mensagem for recebida após um determinado período de tempo.

    Funções e disponibilidade

    Disponível como uma ação principal de Workflow Studio ServiceNow. Usuários com a função flow_designer ou admin podem adicionar uma ação a um fluxo e definir detalhes de configuração.

    Entradas

    Forneça um valor para cada entrada necessária para sua ação. Para adicionar valores dinâmicos, você também pode arrastar cápsulas do painel Dados ou selecioná-las no seletor de cápsula.

    Mensagem
    Tipo de dados: String

    A cadeia de caracteres de texto que o fluxo está aguardando para receber da API sendMessage(). A ação usa esta mensagem para retomar a execução do fluxo. Para obter mais informações sobre a API sendMessage(), consulte FlowAPI - sendMessage(String contextSysID, String message, String payload).

    Habilitar tempo limite
    Tipo de dados: True/False
    Opção para limitar o tempo que o fluxo espera pela conclusão da ação antes de continuar.
    Nota:
    Use a opção Habilitar tempo limite para ajudar a impedir que o fluxo espere infinitamente. Se a mensagem não for recebida, um valor de tempo limite especifica quando o sistema pode ignorar a ação Aguardar mensagem e ir para o próximo item no fluxo. Você deve definir um valor de Duração para habilitar um tempo limite.
    Duração
    Tipo de dados: Duration

    Quantidade de tempo que o fluxo espera antes de continuar quando a opção Habilitar tempo limite está selecionada. Insira o tempo de espera em horas, minutos e segundos. Se você deixar este campo em branco, o fluxo não aguardará.

    Saídas

    Essas saídas aparecem no painel de dados. Você pode usá-las como entradas em outro lugar em seu fluxo.

    Carga
    Tipo de dados: String

    Uma cadeia de caracteres de texto retornada pela API sendMessage(). O fluxo primário pode usar valores de carga como entradas para outras ações ou lógica de fluxo.

    Estado
    Tipo de dados: Choice
    O status de conclusão da ação como um valor numérico.
    • 0 (sucesso)
    • 1 (erro)

    Diretrizes gerais

    Use estas diretrizes gerais ao criar fluxos que aguardam uma mensagem.
    Converter atividades em espera de evento de fluxo de trabalho usando esta ação
    Converta fluxos de trabalho clássicos que usam a atividade Aguardar Evento de WF em fluxos que usam a ação Aguardar Mensagem. Você pode usar o nome do evento como o texto da mensagem que retoma o fluxo.
    Use o método sendMessage() para criar mensagens
    Crie mensagens para fluxos de espera usando o método sendMessage(). Se você quiser que o fluxo gere a mensagem para retomar a execução, crie uma ação personalizada com uma etapa de script para gerar a mensagem. Como alternativa, crie alguma lógica de script que seja executada fora do fluxo, como um evento para gerar a mensagem. Para obter mais informações sobre a API sendMessage(), consulte FlowAPI - sendMessage(String contextSysID, String message, String payload).

    Aguarde a execução da mensagem Voltar para a lógica de fluxo

    Detalhes de execução da ação Aguardar mensagem no estado Aguardando. As outras etapas do fluxo estão no estado Não executado.

    Neste fluxo de exemplo, o estado de aprovação determina se a ação Aguardar mensagem deve ser executada. Se o estado de aprovação for ignorado ou rejeitado, o fluxo aguardará uma mensagem da API sendMessage() antes de continuar. Você pode usar essa lógica para corrigir uma solicitação de aprovação rejeitada e reenviá-la para aprovação.

    Neste exemplo, Fred Luddy rejeitou a aprovação e solicitou mais informações. Para retomar o fluxo, alguém precisa abordar os comentários de Fred e executar a API sendMessage() para enviar a mensagem apropriada Retomar fluxo.

    Detalhes de execução da ação Aguardar mensagem no estado Concluído. A carga tem um valor de tempo de execução de Reenviado para aprovação.

    Depois de corrigir a solicitação de mudança, alguém executou a API sendMessage() para enviar a mensagem Retomar fluxo e também enviar ao fluxo um valor de Carga de Reenviado para aprovação. Para obter mais informações sobre a API sendMessage(), consulte FlowAPI - sendMessage(String contextSysID, String message, String payload).

    Como o valor da mensagem da API correspondeu às condições da ação Aguardar mensagem, a execução do fluxo foi retomada. Nesse caso, o fluxo usou um bloco de lógica Voltar ao fluxo para executar novamente a ação Solicitar aprovação.

    Exemplo de fluxo de atividades de um registro de mudança com o texto Reenviado para aprovação.

    Aqui está o log de atividades da solicitação de mudança. O valor da carga Reenviado para aprovação foi adicionado ao campo Comentários adicionais.