---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PDAutomationProvider - com escopo, global

# PDAutomationProvider - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 10 min. de leitura

A API PDAutomationProvider permite inserir uma atividade opcional em um processo enquanto ele está sendo executado.

Esta API faz parte do plug-in Playbooks (com.glide.pad.core) e é executada no namespace `sn_pad`.  
Chamar scripts com esta API requer pelo menos um dos itens a seguir:

* O solicitante deve estar no mesmo escopo em que o gatilho de atividade opcional foi criado.
* Privilégios de administrador.
{#PDAutomationProviderBothAPI__ul_glp_zx2_5rb}

Um processo é uma série de atividades ordenadas por raias. Uma atividade opcional é predefinida durante o design de processo. As atividades não estão programadas para serem executadas em um horário preciso. Uma atividade pode ser atribuída a uma raia e disponibilizada para execução durante a execução da raia. Uma atividade pode ser atribuída a um processo e disponibilizada para execução durante a execução da raia.

Para criar uma atividade opcional, ela deve ter a regra de início definida como Manual na tabela Atividades \[sys_pd_activity\]. Playbooks No momento, não é compatível com a criação de atividades manuais.

Um agente adiciona a atividade opcional a uma raia ou atividade relativa a outra atividade. O processo deve estar em execução para inserir uma atividade opcional.  
Consulte também:

* [Projetar um processo automatizado](https://www.servicenow.com/docs/access?context=design-automated-process&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US)
* [Pistas e atividades do Designer de automação de processos](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US)
{#PDAutomationProviderBothAPI__ul_a1m_lxj_5rb}

## PDAutomationProvider -- ativarProcesso(cadeia de caracteres processDefinitionSysId) {#ariaid-title2}

Ativa um playbook.
{#PDAuto-activateProcess_S__table_zkb_lbs_1cc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| processDefinitionSysId | Cadeia de caracteres | O sys_id de um playbook localizado na tabela Definições de processo \[sys_pd_process_definition\]. |
[Tabela 1. Parâmetros]

{#PDAuto-activateProcess_S__table_zkb_lbs_1cc} {#PDAuto-activateProcess_S__table_alb_lbs_1cc__entry__2}

| Propriedade | Descrição |
|-|-|
| Objeto | Objeto que contém detalhes de ativação da definição de processo. { "errors": [Array] "process_definition": {Object}, "state": "String" } |
| erros | Lista de erros. Vazio se for bem-sucedido. Tipo de dados: matriz de cadeias de caracteres |
| process_definition | O playbook ativado e suas propriedades. Tipo de dados: objeto "process_definition": { "active": Boolean, "snapshot": {Object}, "status": "String" } |
| process_definition.active | Sinalizador que indica se a definição de processo do playbook desativado está ativa. Encontre definições de processo na lista Definições de processo \[sys_pd_process_definition\]. Valores válidos: * verdadeiro: a definição de processo do playbook desativado está ativa. * falso: a definição de processo do playbook desativado está inativa. {#PDAuto-activateProcess_S__ul_vl4_xtp_ccc} Tipo de dados: booliano |
| process_definition.snapshot | Contém detalhes sobre a definição do processo no momento da ativação. Tipo de dados: objeto { "snapshot": { "created": "String", "processDefinitionSysId": "String" } } |
| process_definition. snapshot. criado | A data em que o playbook foi criado. Tipo de dados: cadeia de caracteres |
| process_definition. snapshot. processDefinitionSysId | O sys_id do playbook ativado. Tipo de dados: cadeia de caracteres |
| process_definition.status | Indica o status de publicação do playbook. Valores possíveis: * rascunho: o playbook está no estado de rascunho. * publicado: o playbook está no estado publicado. {#PDAuto-activateProcess_S__ul_exj_hj3_2cc} Tipo de dados: cadeia de caracteres |
| estado | Indica se sua solicitação de ativação foi bem-sucedida ou não. Valores possíveis: * SUCESSO -- O playbook foi ativado com sucesso. * FALHA: o ID do playbook não foi encontrado. Tipo de dados: objeto |
[Tabela 2. Retorna]

{#PDAuto-activateProcess_S__table_alb_lbs_1cc}  
O exemplo a seguir mostra como ativar um playbook.

    var myPlaybook = sn_pad.PDAutomationProvider.activateProcess('cdd1b85e43000210d96e29c28ab8f275');
    gs.info(JSON.stringify(myPlaybook));

Saída:

    {
      "process_definition": {
        "active": true,
        "snapshot": {
          "processDefinitionId": "cdd1b85e43000210d96e29c28ab8f275",
          "created": "2024-02-19 22:58:12"
        },
        "status": "published"
      },
      "state": "SUCCESS",
      "errors": []
    }

## PDAutomationProvider -- addOptionalActivityRelativeToActivityContext(cadeia de caracteres contextID, cadeia de caracteres activityId, cadeia de caracteres em que, cadeia de caracteres relativa a Id) {#ariaid-title3}

Adiciona uma atividade opcional especificada a um processo a ser executado em relação a outra atividade durante a execução do processo.
Um contexto de atividade é criado para cada atividade quando um processo é executado. O contexto também lida com a forma como a atividade lida com a execução. Para obter informações, consulte [Pistas e atividades do Designer de automação de processos](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).
{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoParms__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| contextID | Cadeia de caracteres | Sys_id da execução da atividade à qual a atividade opcional será adicionada. Para acessar, clique no processo listado na tabela Execuções de processo \[sys_pd_context\]. A execução selecionada deve estar em um estado Em andamento. |
| activityId | Cadeia de caracteres | Sys_id da atividade opcional listada na tabela Atividades \[sys_pd_activity\]. Nota: Para criar uma atividade opcional, ela deve ter a regra de início definida como Manual na tabela Atividades \[sys_pd_activity\]. |
| onde | Cadeia de caracteres | Indica onde colocar a atividade no processo. Valores válidos: * DEPOIS -- execute esta atividade após a atividade relativa contexto. * COM -- Executar a atividade ao mesmo tempo que outra atividade relativa contexto. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_tlq_mdl_lrb} |
| RelativeToId | Cadeia de caracteres | ID do contexto de atividade relativa em que a atividade opcional será executada após ou com. Listado na tabela Contexto de atividades \[sys_pd_activity_context\]. |
[Tabela 3. Parâmetros]

{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoParms} {#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoReturns__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se a atividade foi programada para ser executada com sucesso. Valores válidos: * verdadeiro: a atividade foi programada com sucesso para ser executada. A saída é uma cadeia de caracteres informando sucesso. * falso: a atividade não está programada para ser executada com sucesso. A saída é uma matriz de uma ou mais mensagens de erro. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_a4j_yvl_nrb} Se houver erros, lista de uma ou mais mensagens de erro. Mensagem informando matriz de 0 ou mais elementos, caso contrário. |
| Matriz | Se houver erros, lista de uma ou mais mensagens de erro. Mensagem informando matriz de 0 ou mais elementos, caso contrário. Possíveis mensagens de erro: * ID de atividade opcional inválido -- o sys_id fornecido para o parâmetro activityId é inválido. * ID de contexto de PD inválido -- o sys_id do Designer de processos (PD) fornecido no parâmetro contextID é inválido. * Tipo de posição inválido -- O tipo de posição fornecido é inválido. Consulte a descrição do parâmetro where para tipos válidos. * ID relativo a inválido -- o sys_id fornecido para o parâmetro relativeToId é inválido. * Atividade opcional não encontrada -- o sys_id fornecido para o parâmetro activityId não foi encontrado. * O processo ainda deve estar ativo -- O processo que contém esta atividade deve estar ativo para executar a atividade opcional. * Contexto de atividade relativa não encontrado -- o sys_id fornecido para o parâmetro relativeToId não foi encontrado. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_o5f_p12_5rb} |
[Tabela 4. Retorna]

{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoReturns}  
O exemplo a seguir mostra como executar uma atividade opcional simultaneamente com o contexto de atividade relativa.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'WITH'; // options AFTER, WITH
    var relativeToId = '<relative_activity_context_id>'; // relative activity context ID

    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);

    gs.info(JSUtil.describeObject(response));

Saída (sucesso):

    success: boolean = true
    errors: Array of 0 elements

## PDAutomationProvider -- addOptionalActivityRelativeToLaneContext(cadeia de caracteres contextID, cadeia de caracteres activityId, cadeia de caracteres em que, cadeia de caracteres relativa a Id) {#ariaid-title4}

Atribui uma atividade opcional a uma raia a ser executada durante o contexto de execução dessa raia.
Um contexto de raia é criado para cada raia quando um processo é executado. O contexto também lida com a forma como a raia lida com a execução. Para obter informações, consulte [Pistas e atividades do Designer de automação de processos](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).
{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoParms__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| contextID | Cadeia de caracteres | Sys_id da execução da atividade à qual a atividade opcional será adicionada. Para acessar, clique no processo listado na tabela Execuções de processo \[sys_pd_context\]. A execução selecionada deve estar em um estado Em andamento. |
| activityId | Cadeia de caracteres | Sys_id da atividade opcional listada na tabela Atividades \[sys_pd_activity\]. Nota: Para criar uma atividade opcional, ela deve ter a regra de início definida como Manual na tabela Atividades \[sys_pd_activity\]. |
| onde | Cadeia de caracteres | Indica onde colocar a atividade no processo. Valores válidos: * LAST - executa como a atividade final em uma raia contexto. * PRÓXIMO -- executa na próxima atividade em uma raia contexto. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_tlq_mdl_lrb} |
| RelativeToId | Cadeia de caracteres | ID do contexto da raia relativa no qual a atividade opcional será executada. Listado na tabela Contexto da raia \[sys_pd_lane_context\]. |
[Tabela 5. Parâmetros]

{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoParms} {#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoReturns__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se a atividade foi programada para ser executada com sucesso. Valores válidos: * verdadeiro: a atividade foi programada com sucesso para ser executada. A saída é uma cadeia de caracteres informando sucesso. * falso: a atividade não está programada para ser executada com sucesso. A saída é uma matriz de uma ou mais mensagens de erro. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_a4j_yvl_nrb} |
| Matriz | Se houver erros, lista de uma ou mais mensagens de erro. Mensagem informando matriz de 0 ou mais elementos, caso contrário. Possíveis mensagens de erro: * ID de atividade opcional inválido -- o sys_id fornecido para o parâmetro activityId é inválido. * ID de contexto de PD inválido -- o sys_id do Designer de processos (PD) fornecido no parâmetro contextID é inválido. * Tipo de posição inválido -- O tipo de posição fornecido é inválido. Consulte a descrição do parâmetro where para tipos válidos. * ID relativo a inválido -- o sys_id fornecido para o parâmetro relativeToId é inválido. * A atividade opcional não pode ser adicionada à raia - A atividade opcional fornecida no parâmetro activityId não pode ser adicionada em relação à raia fornecida no parâmetro relativeToId. Certifique-se de que a Execução de atividade selecionada esteja no estado Em andamento. * Atividade opcional não encontrada -- o sys_id fornecido para o parâmetro activityId não foi encontrado. * O processo ainda deve estar ativo -- O processo que contém esta atividade deve estar ativo para executar a atividade opcional. * Contexto da raia relativa não encontrado -- o sys_id fornecido para o parâmetro relativeToId não foi encontrado. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_xw3_422_5rb} |
[Tabela 6. Retorna]

{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoReturns}  
O exemplo a seguir mostra como executar uma atividade opcional como a atividade final em um contexto de raia.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'LAST'; // options LAST, NEXT
    var relativeToId = '<relative_lane_context_id>'; // relative lane context ID

    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);

    gs.info(JSUtil.describeObject(response));

Saída (sucesso):

    success: boolean = true
    errors: Array of 0 elements

## PDAutomationProvider -- deactivateProcess(cadeia de caracteres processDefinitionSysId) {#ariaid-title5}

Desativa um playbook.
{#PDAuto-deactivateProcess_S__table_zkb_lbs_1cc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| processDefinitionSysId | Cadeia de caracteres | O sys_id de um playbook localizado na tabela Definições de processo \[sys_pd_process_definition\]. |
[Tabela 7. Parâmetros]

{#PDAuto-deactivateProcess_S__table_zkb_lbs_1cc} {#PDAuto-deactivateProcess_S__table_alb_lbs_1cc__entry__2}

| Propriedade | Descrição |
|-|-|
| Objeto | Objeto que contém detalhes de desativação da definição de processo. { "errors": [Array] "process_definition": {Object}, "state": "String" } |
| erros | Lista de erros. Vazio se for bem-sucedido. Tipo de dados: matriz de cadeias de caracteres |
| process_definition | O playbook desativado e suas propriedades. Tipo de dados: objeto "process_definition": { "active": Boolean, "snapshot": {Object}, "status": "String" } |
| process_definition.active | Indica se a definição de processo para o playbook desativado está ativa. Encontre definições de processo na lista Definições de processo \[sys_pd_process_definition\]. Valores possíveis: * verdadeiro: a definição de processo do playbook desativado está ativa. * falso: a definição de processo do playbook desativado está inativa. {#PDAuto-deactivateProcess_S__ul_idr_br3_2cc} Tipo de dados: booliano |
| process_definition.description | Detalhes sobre o playbook desativado. Tipo de dados: cadeia de caracteres |
| process_definition.label | O nome do playbook desativado que os usuários veem na interface. Tipo de dados: cadeia de caracteres |
| process_definition.name | O nome do playbook desativado no código. Usado somente como um parâmetro de solicitação em script. Tipo de dados: cadeia de caracteres |
| process_definition.scope | O sys_id do escopo da aplicação para o qual seu playbook está desativado. Tipo de dados: cadeia de caracteres |
| process_definition.status | Se o playbook for publicado, ele mudará novamente para um rascunho. Tipo de dados: cadeia de caracteres |
| estado | Indica se a desativação foi bem-sucedida. Valores possíveis: * SUCESSO: o playbook foi desativado com sucesso. * FALHA: o ID do playbook não foi encontrado. {#PDAuto-deactivateProcess_S__ul_zfl_k34_2cc} Tipo de dados: cadeia de caracteres |
[Tabela 8. Retorna]

{#PDAuto-deactivateProcess_S__table_alb_lbs_1cc}  
Desative o playbook.

    sn_pad.PDAutomationProvider.deactivateProcess('cdd1b85e43000210d96e29c28ab8f275')

Saídas:

    {"process_definition":{"scope":"global","name":"test","active":true,"description":"","label":"test","status":"draft"},"state":"SUCCESS"}

## PDAutomationProvider -- duplicaProcess(cadeia de caracteres processDefinitionSysId, rótulo de cadeia de caracteres, descrição de cadeia de caracteres, scopeId de cadeia de caracteres, triggerTypeId de cadeia de caracteres) {#ariaid-title6}

Duplica um playbook.
{#PDAuto-duplicateProcess_S_S_S_S_S__table_zkb_lbs_1cc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| processDefinitionSysId | Cadeia de caracteres | O sys_id de um playbook localizado na tabela Definições de processo \[sys_pd_process_definition\]. |
| rótulo | Cadeia de caracteres | O nome do playbook duplicado. |
| descrição | Cadeia de caracteres | Opcional. Adicione detalhes sobre seu playbook. |
| scopeId | Cadeia de caracteres | O sys_id do escopo da aplicação em que você deseja que o playbook seja executado. O nome com escopo é da tabela Definição de processo \[sys_pd_process_definition\] no formato `scope.name`. Inserir o sys_id para o escopo global permite que o playbook seja executado em qualquer escopo da aplicação. |
| gatilhoTipoId | Cadeia de caracteres | O sys_id do gatilho a partir do qual iniciar execuções do playbook. Encontre o tipo de gatilho na tabela Tipo de gatilho \[sys_pd_trigger_type\] e copie seu sys_id. |
[Tabela 9. Parâmetros]

{#PDAuto-duplicateProcess_S_S_S_S_S__table_zkb_lbs_1cc} {#PDAuto-duplicateProcess_S_S_S_S_S__table_alb_lbs_1cc__entry__2}

| Propriedade | Descrição |
|-|-|
| Objeto | Objeto que contém detalhes de duplicação da definição de processo. { "errors": [Array] "processDefinitionSysId": "String", "state": "String" } |
| erros | Lista de erros. Vazio se for bem-sucedido. Tipo de dados: matriz de cadeias de caracteres Possíveis mensagens de erro: * Escopo não encontrado para scopeId: xyz * Definição de processo não encontrada para o ID: xyz * Tipo de gatilho não encontrado para triggerTypeId: xyz {#PDAuto-duplicateProcess_S_S_S_S_S__ul_df4_hkt_bcc} |
| processDefinitionSysId | O sys_id do novo playbook na tabela Definições de processo \[sys_pd_process_definition\]. Tipo de dados: cadeia de caracteres |
| estado | Indica se a duplicação do playbook foi bem-sucedida. Valores possíveis: * SUCESSO: o playbook foi duplicado com sucesso. * FALHA -- O ID do playbook, escopo da aplicação ou gatilho não foi encontrado. {#PDAuto-duplicateProcess_S_S_S_S_S__ul_zq2_434_2cc} Tipo de dados: objeto |
[Tabela 10. Retorna]

{#PDAuto-duplicateProcess_S_S_S_S_S__table_alb_lbs_1cc}  
Este exemplo mostra como duplicar um playbook com o sys_id `f8ca6192ec210210f8772cbd595eab20`. O novo playbook é chamado Playbook 2.0, tem um escopo de aplicação Globale é acionado quando um registro é criado. O tipo de gatilho Criação de registro tem um sys_id de `ab6951170f1200108c87f4f0ff767e4f`.

    sn_pad.PDAutomationProvider.duplicateProcess('f8ca6192ec210210f8772cbd595eab20', 'Playbook 2.0', '', 'global', 'ab6951170f1200108c87f4f0ff767e4f');

Saída:

    {"processDefinitionSysId":"6e4f0b8fece9c210f8772cbd595eabda","state":"SUCCESS"}