Enregistrer l'activité et les erreurs

Ce guide explique comment écrire des journaux et des messages d'erreur personnalisés qui vous aideront à résoudre les problèmes liés à une étape de flux qui ne s'exécute pas dans l'onglet "Activité" des flux.

Par défaut, l'onglet "Activité" enregistre le nom de l'étape exécutée, tel qu'il est défini dans son fichier manifeste. Pour vous aider à comprendre ce qui s'est passé lors de l'exécution d'une étape, vous devez également écrire des journaux personnalisés pour votre étape. Si les utilisateurs rencontrent un comportement inattendu lors de l'exécution de votre étape, vos journaux peuvent les aider à comprendre ce qui s'est passé.

Une entrée de journal utile comporte deux attributs :

  • Chip contenant un lien hypertexte vers la ressource créée ou mise à jour par l'étape. Par exemple, si votre étape crée un document Google Docs, utilisez le chip pour créer un lien vers le document Google Docs créé.
  • Message d'erreur détaillé expliquant pourquoi une étape n'a pas pu s'exécuter et comment résoudre le problème.

L'exemple de code suivant montre comment le onExecuteFunction() d'une étape peut enregistrer une exécution réussie et une erreur dans l'onglet "Activité" :

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