Acesso de API a Flow Designer

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

    • Os desenvolvedores de aplicações podem acessar a funcionalidade Flow Designer por meio de APIs para fluxos, subfluxos e ações. Os designers de fluxo podem habilitar fluxos, subfluxos e ações individuais para ser cliente chamável durante o design.

    APIs Flow Designer disponíveis

    Acione fluxos, subfluxos e ações usando essas APIs de scripts de servidor ou cliente.

    Lado do servidor
    FlowAPI: acione um fluxo, subfluxo ou ação usando métodos síncronos ou assíncronos, com ou sem detalhes de execução.
    Lado do cliente
    GlideFlow: realize interações do lado do cliente com ações, fluxos e subfluxos. Os designers de fluxo devem habilitar um fluxo, subfluxo e ação a serem chamados do cliente.

    Métodos rápidos FlowAPI

    Use métodos rápidos na classe FlowAPI para executar uma ação, fluxo ou subfluxo de um script do lado do servidor sem criar detalhes de execução ou outros registros relacionados. Use esses métodos para aumentar a velocidade do processamento de alto volume em um ambiente de produção e para melhorar o desempenho, eliminando a sobrecarga de manutenção de registros. Os métodos incluem:

    • executeActionQuick(), executeFlowQuick(), executeSubflowQuick(): execute uma ação, fluxo ou subfluxo de um script do lado do servidor de forma síncrona a partir da sessão do usuário atual.
    • startActionQuick(), startFlowQuick(), startSubflowQuick(): execute uma ação, fluxo ou subfluxo de um script do lado do servidor de forma assíncrona.

    APIs de fluxo de XML e JSON

    Crie uma carga JSON ou XML grande com ou sem streaming para usar em uma solicitação REST ou SOAP para enviar dados em massa para uma API de terceiros. Por exemplo, você pode usar essas APIs para criar uma carga JSON na etapa de script ServiceNow® Flow Designer e passar o valor retornado para a etapa REST para enviar a solicitação a um serviço de terceiros. Para obter mais informações, consulte JSONStreamingBuilder e XMLStreamingBuilder .

    APIs de cliente chamável

    Por padrão, os fluxos, subfluxos e ações só podem ser chamados pela FlowAPI dentro de um script de servidor. Os designers de fluxo e de ação podem disponibilizar fluxos, subfluxos ou ações individuais para chamadas de cliente, habilitando a opção de Cliente chamável durante o processo de design.

    Executar como suporte

    Fluxos e subfluxos podem ser executados como o usuário do sistema ou o usuário que inicia a sessão. Defina este comportamento nas propriedades do fluxo. Todos os métodos rápidos de API ignoram a propriedade executar como e sempre são executados como o usuário do sistema.

    As ações sempre são executadas como o usuário que inicia a sessão.

    Snippets de código

    Os desenvolvedores de aplicações podem gerar uma função JavaScript que chama um fluxo, subfluxo ou ação específica com a opção Snippet de código. Use o snippet de código em scripts, como regras de negócios ou o módulo Scripts - Backgound para chamar elementos Flow Designer específicos. O sistema gera somente snippets de código para fluxos, subfluxos e ações publicados. Flow Designer elementos no status de rascunho ou modificado não geram snippets de código.