---
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


---

# WFActivityHandler - Global

# WFActivityHandler - Global {#ariaid-title1}

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

A inclusão de script WFActivityHandler é a classe base para todas as atividades de fluxo de trabalho.

Como a classe base para todas as atividades de fluxo de trabalho, este código sempre é executado como parte de uma atividade.

Ao desenvolver suas próprias atividades de fluxo de trabalho, crie seu objeto de script derivando desta classe e substituindo os métodos conforme necessário para obter a funcionalidade desejada. O código do cliente deve substituir o método onExecute() para executar o processamento de atividades significativas.

## WFActivityHandler - debug (cadeia de caracteres mensagem, cadeia de caracteres args) {#ariaid-title2}

Registra em log uma mensagem de depuração.
{#r_WFAH-debug_S_S__table_xdr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Cadeia de caracteres | Cadeia de caracteres a ser enviada para o log |
[Tabela 1. Parâmetros]

{#r_WFAH-debug_S_S__table_xdr_nf5_4t} {#r_WFAH-debug_S_S__table_ydr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 2. Retorna]

{#r_WFAH-debug_S_S__table_ydr_nf5_4t}

## WFActivityHandler - debug (cadeia de caracteres, argumentos de matriz) {#ariaid-title3}

Registra em log uma mensagem de depuração.
{#r_WFAH-debug_S_A__table_bv2_sh5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Matriz | Matriz de valores a serem enviados para o log |
[Tabela 3. Parâmetros]

{#r_WFAH-debug_S_A__table_bv2_sh5_4t} {#r_WFAH-debug_S_A__table_cv2_sh5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 4. Retorna]

{#r_WFAH-debug_S_A__table_cv2_sh5_4t}

## WFActivityHandler - generate(cadeia de caracteres activityId, ordem de cadeia de caracteres, GlideDateTime startAtDspValue, booliano noCreateFlag) {#ariaid-title4}

Gera aprovações e tarefas antes que a atividade seja executada para uma visualização dos próximos trabalhos.
Habilita a geração de objetos no início de um fluxo de trabalho em um estado pendente. Para obter informações relacionadas, consulte [Gerar atividade de fluxo](https://www.servicenow.com/docs/access?context=r_Generate&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US)de trabalho.
{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| activityId | Cadeia de caracteres | Sys_id desta atividade em execução. Localizado na tabela Atividades de fluxo de trabalho \[wf_activity\]. |
| pedido | Cadeia de caracteres | O número do pedido associado à tarefa ou aprovação. |
| startAtDspValue | Cadeia de caracteres | A hora de início da tarefa ou aprovação no formato [GlideDateTime](https://servicenow-prod.fluidtopics.net/74dRL3OB4d2gb46mm9hgnw#c_GlideDateTimeAPI "A classe GlideDateTime fornece métodos para executar operações em objetos GlideDateTime."). |
| noCreateFlag | Booliano | Sinalizador que indica se a criação de um registro de aprovação deve ser ignorada. Valores válidos: * verdadeiro: não crie um registro de aprovação. * falso: crie um registro de aprovação. {#r_WFAH-generate_S_S_GDT_B__ul_cbr_ds4_f4b} Padrão: verdadeiro |
[Tabela 5. Parâmetros]

{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t} {#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto de pré-geração salvo no bloco de anotações do fluxo de trabalho. Por exemplo, o objeto pode ser uma matriz de IDs de aprovação. Quando a atividade executa a função onExecute, ela pode solicitar o objeto de pré-geração para determinar uma das seguintes condições: * As aprovações já foram criadas em um estado pendente. * A atividade deve criar as aprovações usando a função onExecute. {#r_WFAH-generate_S_S_GDT_B__ul_u13_mdp_f4b} |
[Tabela 6. Retorna]

{#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t}

## WFActivityHandler - info (cadeia de caracteres mensagem, cadeia de caracteres args) {#ariaid-title5}

Registra em log uma mensagem informativa.
{#r_WFAH-info_S_S__table_pdr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Cadeia de caracteres | Cadeia de caracteres a ser enviada para o log. |
[Tabela 7. Parâmetros]

{#r_WFAH-info_S_S__table_pdr_nf5_4t} {#r_WFAH-info_S_S__table_qdr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 8. Retorna]

{#r_WFAH-info_S_S__table_qdr_nf5_4t}

## WFActivityHandler - info(cadeia de caracteres, argumentos de matriz) {#ariaid-title6}

Registra em log uma mensagem informativa.
{#r_WFAH-info_S_A__table_rdr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Matriz | Matriz de valores a serem enviados para o log |
[Tabela 9. Parâmetros]

{#r_WFAH-info_S_A__table_rdr_nf5_4t} {#r_WFAH-info_S_A__table_qdr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 10. Retorna]

{#r_WFAH-info_S_A__table_qdr_nf5_4t}

## WFActivityHandler - js(String str) {#ariaid-title7}

Avalia variáveis de atividade no script.
Usado para avaliar cadeias de caracteres que contêm el, como `${some script}` ou cadeias de caracteres que começam com `javascript:`. Veja quase todas as atividades existentes, por exemplo, uso.
{#r_WFAH-js_S__table_ndr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| str | Cadeia de caracteres | Cadeia de caracteres que possivelmente contém el incorporado. |
[Tabela 11. Parâmetros]

{#r_WFAH-js_S__table_ndr_nf5_4t} {#r_WFAH-js_S__table_odr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | A cadeia de caracteres avaliada. |
[Tabela 12. Retorna]

{#r_WFAH-js_S__table_odr_nf5_4t}

## WFActivityHandler - onCancel() {#ariaid-title8}

Manipulador de eventos para o evento cancel.
A classe base do script de atividade define esta atividade como cancelada. Classes derivadas (atividades) podem substituir este método se o processamento adicional for necessário para cancelar esta atividade. A atividade Manual Approvals é um exemplo de substituição deste método para executar processamento adicional para cancelar esta atividade.
{#r_WFAH-onCancel__table_pqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 13. Parâmetros]

{#r_WFAH-onCancel__table_pqd_1b5_4t} {#r_WFAH-onCancel__table_qqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 14. Retorna]

{#r_WFAH-onCancel__table_qqd_1b5_4t}

## WFActivityHandler - onExecute() {#ariaid-title9}

Método virtual. As subclasses de atividade devem substituir este método para executar o trabalho apropriado para a atividade.
{#r_WFAH-onExecute__table_nqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 15. Parâmetros]

{#r_WFAH-onExecute__table_nqd_1b5_4t} {#r_WFAH-onExecute__table_oqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 16. Retorna]

{#r_WFAH-onExecute__table_oqd_1b5_4t}

## WFActivityHandler - runScript (script de cadeia de caracteres) {#ariaid-title10}

Permite que as atividades executem um script contido em uma variável de atividade do tipo script.
Exemplos de atividades que usam este método incluem If, Wait for conditione Approval - User.
{#r_WFAH-runScript_S__table_rqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| script | Cadeia de caracteres | Cadeia de caracteres que contém Javascript válido. |
[Tabela 17. Parâmetros]

{#r_WFAH-runScript_S__table_rqd_1b5_4t} {#r_WFAH-runScript_S__table_sqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| variável | Se o script definir a <var class="keyword varname">resposta</var> da variável de fluxo de trabalho, este valor será retornado. Caso contrário, o resultado da execução do script será retornado. |
[Tabela 18. Retorna]

{#r_WFAH-runScript_S__table_sqd_1b5_4t}

## WFActivityHandler - setActivityOutput() {#ariaid-title11}

Define a propriedade de saída da atividade.
Consulte a atividade SOAP Message.
{#r_WFAH-setActivityOutput__table_lqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 19. Parâmetros]

{#r_WFAH-setActivityOutput__table_lqd_1b5_4t} {#r_WFAH-setActivityOutput__table_mqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 20. Retorna]

{#r_WFAH-setActivityOutput__table_mqd_1b5_4t}

## WFActivityHandler - setResultFailed(String reason) {#ariaid-title12}

Define o resultado da atividade como falha com uma cadeia de caracteres de motivo opcional.
Consulte Atividade SOAP Message.
{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| motivo | Cadeia de caracteres | (Opcional) Descrição do motivo da falha desta atividade. |
[Tabela 21. Parâmetros]

{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t} {#r_WFAH-setResultFailed_S__table_iqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 22. Retorna]

{#r_WFAH-setResultFailed_S__table_iqd_1b5_4t}

## WFActivityHandler - setResultSucceeded() {#ariaid-title13}

Define o resultado desta atividade como bem-sucedido.
{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 23. Parâmetros]

{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t} {#r_WFAH-setResultSucceeded__table_kqd_1b5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 24. Retorna]

{#r_WFAH-setResultSucceeded__table_kqd_1b5_4t}

## WFActivityHandler - aviso (cadeia de caracteres mensagem, cadeia de caracteres args) {#ariaid-title14}

Registra em log uma mensagem de aviso.
{#r_WFAH-warn_S_S__table_tdr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Cadeia de caracteres | Cadeia de caracteres a ser enviada para o log |
[Tabela 25. Parâmetros]

{#r_WFAH-warn_S_S__table_tdr_nf5_4t} {#r_WFAH-warn_S_S__table_udr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 26. Retorna]

{#r_WFAH-warn_S_S__table_udr_nf5_4t}

## WFActivityHandler - aviso (cadeia de caracteres, argumentos de matriz) {#ariaid-title15}

Registra em log uma mensagem de aviso.
{#r_WFAH-warn_S_A__table_vdr_nf5_4t__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| msg | Cadeia de caracteres | Mensagem a ser enviada para o log. |
| args | Matriz | Matriz de valores a serem enviados para o log |
[Tabela 27. Parâmetros]

{#r_WFAH-warn_S_A__table_vdr_nf5_4t} {#r_WFAH-warn_S_A__table_udr_nf5_4t__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 28. Retorna]

{#r_WFAH-warn_S_A__table_udr_nf5_4t}