Acionar manualmente um Playbook

Use um script de servidor para acionar manualmente um playbook.

Acionar a função do Playbook

Acione manualmente um Playbook usando uma função de script do servidor com o seguinte código:

sn_playbook.PlaybookExperience.triggerPlaybook('<scoped name>',parentRecord);

Substituir<scoped name> com o nome com escopo do seu playbook. Você pode encontrar o nome com escopo localizando a definição do processo na tabela sys_pd_process_definition e copiando os campos de nome e escopo da aplicação. Substitua parentRecord pelo registro primário/de entrada no qual você deseja executar o processo.

O script do servidor gera uma exceção em caso de falha. Você pode adicionar uma mensagem informativa quando for bem-sucedido e uma mensagem de erro em caso de falha.

Funções de ajuda

Use a seguinte função programável para determinar se um Playbook já está em execução em um registro antes de exibir uma ação de IU ou ação declarativa para acioná-lo.

sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(parentRecord, '<scoped name>')

Para exibir todos os playbooks em execução em um determinado registro primário, use o seguinte código:

sn_playbook.PlaybookExperience.getPlaybooksForParentRecord(parentRecord)

Essas informações podem ser usadas para controlar quando mostrar uma ação do playbook de gatilho, como uma ação de IU.

A seção a seguir é um exemplo de como usar a função de playbook do gatilho para criar um botão Adicionar playbook.

Criar uma ação de IU Adicionar playbook

Crie uma ação de IU Adicionar playbook no espaço.

Antes de Iniciar

Função necessária: workspace_admin

Procedimento

1. Navegar até Todos > Definições do sistema > Ações de IU.
2. Clique em Nova.
3. No formulário, preencha os campos.
   Nota:

   Outros campos além dos na tabela a seguir aparecem no formulário, mas não funcionam em espaços. Para obter mais informações sobre cada campo no formulário Ações de IU, consulte Configurar ações de IU personalizadas no espaço legado.

   Tabela 1. Formulário de ação de IU

   Campo	Descrição
   Nome	Nome da ação de IU. Isso aparece na IU do espaço, por exemplo, Adicionar Playbookde integração .
   Tabela	Tabela à qual a ação de IU se aplica. Toda vez que um agente exibe um registro desta tabela, esta ação de IU é exibida.
   Ordem	Posicionamento na lista horizontal de ações de IU. Da esquerda para a direita, os números de pedido vão de pequeno a grande.
   Nome da Ação	Equivalente ao Nome que aparece em logs e colunas da tabela, por exemplo, interaction_add_onboarding
   Ativo	Alterne para fazer a ação de IU aparecer.
   Mostrar atualização	Alternar para mostrar a atualização na tabela.
   Condição	Condições que devem ser atendidas para que a Ação de IU apareça, por exemplo, current.canWrite() && !sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current, 'sn_pad_demo.playbook_onboarding_demo').
   Script	Script do lado do servidor que implementa a ação de IU.
   Aplicação	Aplicação à qual este componente se aplica. Global significa que o componente se aplica a todas as aplicações.

4. Para criar um script do lado do servidor que implemente a ação adicionar playbook, insira o script no campo Script.

   try{
   	current.update();
   	sn_playbook.PlaybookExperience.triggerPlaybook('sn_pad_demo.playbook_onboarding_demo',current);
   	gs.addInfoMessage(gs.getMessage("Onboarding Playbook added to Interaction."));
   } catch(e){
   		gs.addErrorMessage(e.getMessage());
   }

   O sistema ignora todos os scripts de cliente incluídos neste campo. Você só pode usar o campo de client scripts do espaço para client scripts. Substitua sn_pad_demo.playbook_onboarding_demo pelo nome com escopo do seu playbook. Você pode encontrar o nome com escopo localizando a definição do processo na tabela sys_pd_process_definition e copiando os campos de nome e escopo da aplicação.

5. Na guia Espaço, selecione: Botão de formulário do espaço para que o botão Adicionar playbook apareça na linha de ações de IU ou Menu de formulário do espaço para que ele apareça como uma lista na lista de menus.
6. No campo Client script do espaço, crie um client script específico do espaço.
   O espaço tem limitações de script de cliente semelhantes às Portal de serviços. Por exemplo, para abrir um formulário clicando nele, você pode adicionar o seguinte client script:

   function onClick(g_form) {
   
   }