Ações do Playbook personalizadas

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 7 min. de leitura
  • Personalize as interações do Playbook configurando condições que adicionam botões, menus suspensos, itens de lista e ícones clicáveis. Essa personalização permite que você envie formulários, abra registros e conclua e ignore atividades em todas as experiências do Playbook.

    Visão geral

    As ações do playbook podem executar scripts de servidor, expedir ações de cliente ou renderizar componentes de IU quando acionadas. Ao executar scripts de servidor, a variável atual é vinculada ao registro associado da atividade. Se você quiser que as ações do cliente acionem eventos em Construtor de IU, consulte Configurar ações do cliente UXF para playbook.

    Os registros de Dados de fluxo (sys_flow_data) geralmente são usados como registros associados para controlar a configuração de um fluxo por meio de um script de servidor de ação. Esses scripts de servidor podem definir o estado dos fluxos como concluídos ou ignorados, permitindo que um agente afete diretamente a lógica em um fluxo.

    Os registros de Dados de fluxo também podem coletar dados do usuário de um agente para usar em um fluxo.

    Um registro associado pode ser vinculado a qualquer tabela. Você pode definir suas próprias ações além dessas ações padrão para realizar a lógica de fluxo de trabalho do processo de negócios desejada.

    Você pode habilitar o recurso salvar e depois em qualquer ação de script que não seja do servidor marcando a caixa de seleção Campos de formulário obrigatórios. Uma ação com o recurso salvar e depois envia um formulário, executa client scripts e validações de regra de negócio e executa a ação quando o registro é salvo com sucesso. A ação não será executada se alguma validação ou regra de negócio impedir o registro de ser salvo. Por padrão, isso acionará a ação de IU sysverb_ws_save para enviar o formulário, mas pode ser substituído especificando outra ação de IU em uma propriedade uiActionName da carga de ação do cliente.

    Ações padrão

    As ações padrão a seguir são compatíveis com o Playbook.
    Nome da Ação Descrição
    Omitir

    ignorar_instrucional

    Ignora uma etapa do processo instrucional
    Omitir

    ignorar_e-mail

    Ignora o envio de um e-mail
    Omitir

    ignorar_conhecimento

    Ignora uma etapa do processo de conhecimento
    Omitir

    ignorar_atualização

    Ignora uma etapa do processo de registro de atualização
    Omitir

    ignorar_lista

    Ignora uma etapa do processo de lista
    Omitir

    ignorar_criar

    Ignora uma etapa do processo de criação de registro
    Marcar como Concluído

    atividade_concluída

    Marcar uma atividade como concluída
    Criar registro

    criar_registro

    Criar um novo registro a partir de um novo formulário de registro
    Enviar e-mail

    enviar_e-mail

    Informa a automação do processo para enviar e-mail
    Reiniciar

    reiniciar_atividade

    Reinicia a atividade
    Omitir

    ignorar_atividade

    Marque as atividades usando um registro de status de experiência como ignoradas.
    Exibir registro

    Exibir registro

    Exibir o registro atual
    Salvar

    salvar_registro

    Salvar o registro atual
    Exibir Aprovadores

    Aprovadores de exibição do playbook

    Exibir aprovadores para este registro
    Marcar como Concluído

    marca_completa_conhecimento

    Marca uma etapa do processo de conhecimento como concluída
    Marcar como Concluído

    marca_completa_instrucional

    Marca uma etapa do processo instrucional como concluída
    Marcar como Concluído

    marcar_concluída_lista

    Marca uma etapa do processo de lista como concluída
    Marcar como Concluído

    marcar_completo

    Marca o processo atual como concluído
    Marcar como Concluído

    salvar_e_completar_atividade

    Salvar o registro atual e marcar o processo como concluído

    Personalizar ações do Playbook

    Personalize ações do Playbook usando formulários, condições e scripts, componentes ou ações do cliente. Essa personalização permite que os usuários enviem formulários, abram registros e concluam e pulem atividades.

    Antes de Iniciar

    Função necessária: playbook_experience.admin

    Por Que e Quando Desempenhar Esta Tarefa

    • Ações padrão não podem ser editadas. Essas ações são exibidas como somente leitura.
    • As ações só podem operar em um registro.

    Procedimento

    1. Crie a ação e especifique os detalhes.
      1. Navegar até Playbook Experience > Ações Ações do Playbook, Açõesde Faseou Ações de Atividade.
      2. Selecione uma atribuição de ação ou clique em Novo para criar uma nova.
        Nota:
        Para obter uma lista de ações padrão, consulte Ações do Playbook.
      3. No formulário, preencha os campos.
        Tabela 1. Formulário Atribuição de ação
        Campo Descrição
        Rótulo de Ação Rótulo que aparece no botão criado por meio da ação.
        Nome da Ação Nome da ação que aparece na lista de atribuições de ação. Uma atribuição de ação substitui outras com o mesmo nome.
        Implementados como Tipo de ação implementada. Por exemplo, Componente de IU.
        Especificar componente de IU Quando o campo Implementado como é definido como Componente de IU, esse campo especifica um componente de IU que é exibido quando a ação é acionada.
        Dica da ferramenta Texto exibido quando um agente aponta o cursor sobre um botão ou ícone.
        Ícone Ícone exibido no cartão de atividade.
        Modo de renderização Modo de renderização em um cartão do Playbook. Especifique como a ação é renderizada no cartão do Playbook. Selecione Botão, Menu suspenso do cabeçalhoou Íconedo cabeçalho .
        Tipo de botão Tipo de botão exibido na IU do Playbook. Selecione Primário, Secundárioou Terciário.
        Campos de formulário obrigatórios Opção que comunica que a ação requer dados do usuário para prosseguir.
        Este campo é consumido na IU da Playbook Experience das seguintes maneiras.
        1. Quando uma atividade contém um formulário grande demais para caber em um cartão, o formulário fica oculto em um modal.
        2. Quando uma atividade contém um formulário, mas não tem ações que exigem campos de formulário, o formulário não é renderizado. Em vez disso, os campos no formulário são renderizados como uma coleção empilhada de pares de rótulo-valor.
        Este campo pode ser substituído criando um renderizador de atividade personalizado.
        Descrição Descrição da ação exibida na lista Atribuições de ação.
        Aplicação Aplicação para a atribuição de ação.
        Espaço Espaço ao qual a ação do playbook está associada. Por exemplo, ServiceNow® ITSM ou RH.
        Nota:
        Este campo não é obrigatório.
        Tabela Campo para limitar esta ação a atividades com esta tabela associada.
        Exibição Campo para limitar esta ação a atividades com esta exibição de formulário.
        Ativo Opção para ativar a ação.
        Ordem Número inteiro que determina a precedência desta ação em relação às ações correspondentes com o mesmo nome. Quanto menor o número, maior a probabilidade de ser selecionado em relação a outras ações. Essa ordem permite que você substitua outras ações pela sua própria. A prática típica é usar números na casa das centenas. Por exemplo, 100, 200, 300 ou 400.
    2. Configure as condições para a ação.
      1. Clique na guia Condições.
      2. No formulário, preencha os campos.
        Tabela 2. Formulário Condições
        Campo Descrição
        Condição de Script Condição de script para a atribuição de ação. Insira sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current). Este script permite que você mostre um Playbook somente quando o registro tiver acionado uma execução de processo.
        Nota:
        Adicionar consultas que envolvem várias junções pode prejudicar o desempenho.
        Condições do Cliente Escolha condições para limitar as colisões com base no seu caso de uso.
        Condições de Registros Escolha condições para limitar as colisões com base no seu caso de uso.
        Funções necessárias Funções para limitar o acesso ao Playbook.
        Requer acessos de criação Opções para exigir acesso de criação.
        Requer acessos de leitura Opção para exigir acesso de leitura.
        Requer acesso de gravação Opções para exigir acesso de gravação.
        Requer acesso de exclusão Opções para exigir acesso de exclusão.
    3. Se Script do servidor estiver selecionado no campo Implementado como, forneça um script para a ação.
      • Os scripts do servidor podem fazer referência ao registro associado de uma atividade usando a variável Current.
      • Chamar current.update() atualiza o registro associado com valores que o usuário fornece de formulários incorporados em cartões do Playbook.
    4. Se a Ação do cliente estiver selecionada no campo Implementado como, especifique opcionalmente o mapeamento da carga na guia Atributos da ação.

      O mapeamento de carga permite que você substitua partes da carga expedida pela ação do cliente. Por exemplo, a ação do cliente Visualizar registro permite que você abra um registro em uma nova guia Espaço. Usando o mapeamento de carga, você pode especificar uma guia de item relacionado que é exibida quando o formulário é aberto. Defina defaultTab para fazer isso.

    5. Se Componente de IU estiver selecionado no campo Implementado como, opcionalmente, especifique os atributos do componente na guia Atributos do componente.
    6. Clique em Enviar.

    Aplicar ações do playbook às experiências do playbook

    Aplique ações de playbook padrão ou personalizadas a experiências de playbook.

    Antes de Iniciar

    Função necessária: playbook_experience_admin

    Procedimento

    1. Navegar até Todos > Playbook Experience > Playbook Experiences.
    2. Selecione uma Playbook Experience.
    3. Clique na lista relacionada Mapeamento de ação.
    4. Clique em Nova.
    5. No formulário, preencha os campos.
      Tabela 3. Mapa de atribuição de ações de Playbook Experience
      Campo Descrição
      Atribuição de ação Selecione a atribuição de ação declarativa
      Playbook Experience Escolha em qual Playbook Experience a ação será aplicada
      Aplicação Aplicação na qual a ação é aplicada
      Definição de Atividade Selecione a definição de atividade para aplicar a ação
    6. Clique em Enviar.
    7. Na seção de links relacionados, selecione a guia Mapeamento da Playbook Experience.
    8. Verifique se a experiência do playbook foi adicionada à tabela.

    O que Fazer Depois

    Integre sua Playbook Experience com Espaço.