Registra la actividad y los errores

En esta guía, se explica cómo escribir registros personalizados y mensajes de error que ayudan a solucionar problemas de un paso del flujo que no se ejecuta en la pestaña Actividad de los flujos.

De forma predeterminada, la pestaña Activity registra el nombre del paso que se ejecuta, tal como se define en su archivo de manifiesto. Para ayudarte a comprender lo que sucedió durante la ejecución de un paso, también debes escribir registros personalizados para tu paso. Si los usuarios experimentan un comportamiento inesperado mientras ejecutan tu paso, los registros pueden ayudarlos a comprender lo que sucedió.

Una entrada de registro útil tiene dos atributos:

  • Es un chip que contiene un hipervínculo al recurso que se creó o actualizó en el paso. Por ejemplo, si tu paso crea un documento de Google, usa el chip para vincularlo.
  • Es un mensaje de error detallado que describe por qué no se pudo ejecutar un paso y cómo resolver el problema.

En el siguiente ejemplo de código, se muestra cómo el onExecuteFunction() de un paso puede registrar una ejecución exitosa y un error en la pestaña Actividad:

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"
                }
              ]
            }
          }
        }
      }
    };
  }
}