Registrar atividade e erros

Este guia explica como escrever registros e mensagens de erro personalizados que ajudam a resolver problemas de uma etapa de fluxo que não é executada na guia "Atividade" dos fluxos.

Por padrão, a guia "Atividade" registra o nome da etapa executada, conforme definido no arquivo de manifesto. Para ajudar você a entender o que aconteceu durante uma execução de etapa, escreva registros personalizados para sua etapa também. Se os usuários encontrarem um comportamento inesperado ao executar sua etapa, os registros poderão ajudar a entender o que aconteceu.

Uma entrada de registro útil tem dois atributos:

  • Um ícone que contém um hiperlink para o recurso criado ou atualizado pela etapa. Por exemplo, se a etapa criar um documento Google, use o ícone para vincular ao documento criado.
  • Uma mensagem de erro detalhada que descreve por que uma etapa não foi executada e como resolver o problema.

A amostra de código a seguir mostra como o onExecuteFunction() de uma etapa pode registrar uma execução bem-sucedida e um erro na guia "Atividade":

Apps Script

function onExecuteFunctionCreateDocument(e) {

  // true if the document is successfully created, false if something goes wrong.
  var successfulRun = createDocument();

  // If successful, return an activity log linking to the created document.
  if (successfulRun == true) {
    return {
      "hostAppAction": {
        "workflowAction": {
          "returnOutputVariablesAction": {
            "variableValues": [
              {}
            ],
            "log": {
              "textFormatElements": [
                {
                  "text": "Created Google Doc"
                },
                {
                  "chip": {
                    "icon": {
                      "materialIconName": "edit_document"
                    },
                    "url": "https://docs.google.com/document/d/{DOCUMENT}",
                    "label": "{NAMEOFDOCUMENT}"
                  }
                },
                {
                  "text": "Created doc detailing how to improve product."
                }
              ]
            },
            "trigger_log": {
              "textFormatElements": [
                {
                  "text": "Email log "
                }
              ]
            }
          }
        }
      }
    };
  }

  // Otherwise, return an activity log containing an error explaining what happened and how to resolve the issue.
  else {
    return {
      "hostAppAction": {
        "workflowAction": {
          "returnElementErrorAction": {
            "errorActionability": "NOT_ACTIONABLE",
            "errorRetryability": "NOT_RETRYABLE",
            "error_log": {
              "textFormatElements": [
                {
                  "text": "Failed to create Google Doc"
                },
                {
                  "chip": {
                    "icon": {
                      "materialIconName": "document"
                    },
                    "label": "{NAMEOFDOCUMENT}"
                  }
                },
                {
                  "text": "Unable to create Google Document because OAuth verification failed. Grant one of these authorization scopes and try again: https://www.googleapis.com/auth/documents, https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/drive.file"
                }
              ]
            }
          }
        }
      }
    };
  }
}