---
sourceDocument: Interface do usuário da Now Platform Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-user-interface

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Interface do usuário da Now Platform Yokohama

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Acionar manualmente um playbook

# Acionar manualmente um playbook {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

Use um script de servidor para acionar manualmente um playbook.

## Acionar a função do playbook {#manually-trigger-playbook__section_t1m_vb2_zpb}

Acionar manualmente um playbook usando uma função de script de 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 no sys_pd_process_definition e copiando os campos de nome e escopo da aplicação. Substituir `Registro de parent `com o registro primário/de entrada em que você deseja executar o processo.

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

## Funções de ajuda {#manually-trigger-playbook__section_k5v_5b2_zpb}

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 uma ação declarativa para acioná-lo.

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

Para exibir cada playbook 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 do gatilho, como uma ação de IU. A seção a seguir é um exemplo de como usar a função de acionar playbook para criar um botão Adicionar playbook.

## Crie uma ação de Adicionar IU do playbook {#ariaid-title2}

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

### Antes de Iniciar

Função necessária: Workspace_admin

### Procedimento

1. Navegar até TudoDefinições do SistemaAções de IU.
2. Clique em Novo.
3. No formulário, preencha os campos.  
   Nota:  
   Outros campos além dos da tabela a seguir aparecem no formulário, mas não funcionam em espaços de trabalho. Para obter mais informações sobre cada campo no formulário Ações de IU, consulte [Configure ações de IU personalizadas em espaço legado](https://servicenow-prod.fluidtopics.net/IhhVp9MuX~ihypohkL4YPg "Configure ações de IU para personalizar espaço legadopara sua organização. As ações de IU incluem botões personalizados, itens de menu e limitação de acesso a formulários com base na função de um usuário.").
   {#add-playbook-button__table_ypm_hyh_wnb__entry__2}

   | Campo | Descrição |
   |-|-|
   | Nome | Nome da ação de IU. Isso aparece na IU do espaço, por exemplo, <kbd class="ph userinput">Adicionar playbook de integração </kbd>. |
   | Tabela | Tabela à qual a ação de IU se aplica. Sempre 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 dos pedidos vão de pequeno a grande. |
   | Nome da Ação | Equivalente de Nome que aparece em logs e colunas da tabela, por exemplo, <kbd class="ph userinput">interaction_add_onboarding </kbd> |
   | Ativo | Alterne para fazer a ação de IU aparecer. |
   | Mostrar atualização | Alterne para mostrar a atualização no 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, 'n_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. |
   [Tabela 1. Formulário de ação de IU]

   {#add-playbook-button__table_ypm_hyh_wnb}
4. Para criar um script do lado do servidor que implementa a ação Adicionar playbook, insira o script no Script campo.  

       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 script do cliente do espaço para scripts do cliente. Substituir `sn_pad_demo.playbook_onboarding_demo `com o nome com escopo do seu playbook. Você pode encontrar o nome com escopo localizando a definição do processo no sys_pd_process_definition e copiando os campos de nome e escopo da aplicação.
5. Em Espaço selecione: Botão de formulário do espaço Para fazer com 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. Em Script do cliente do espaço crie um script de cliente específico do espaço.  
   O espaço tem limitações de script de cliente semelhantes a Portal de serviços. Por exemplo, para abrir um formulário clicando nele, você pode adicionar o seguinte client script:

       function onClick(g_form) {

       }