Журнал активности и ошибок

В этом руководстве объясняется, как писать пользовательские журналы и сообщения об ошибках, помогающие устранять неполадки в шаге потока, который не запускается на вкладке «Активность» потоков.

По умолчанию на вкладке «Активность» регистрируется имя выполняемого шага, как определено в его файле манифеста. Чтобы лучше понять, что произошло во время выполнения шага, вам также следует вести собственные журналы для вашего шага. Если пользователи сталкиваются с непредвиденным поведением во время выполнения вашего шага, ваши журналы могут помочь им понять, что произошло.

Полезная запись в журнале имеет два атрибута:

  • Чип, содержащий гиперссылку на ресурс, созданный или обновлённый на данном этапе. Например, если ваш этап создаёт документ Google, используйте чип для ссылки на созданный документ Google.
  • Подробное сообщение об ошибке, описывающее, почему не удалось выполнить шаг и как решить проблему.

В следующем примере кода показано, как onExecuteFunction() шага может регистрировать успешное выполнение и ошибку на вкладке Activity:

Скрипт приложений 

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