इस पेज का अनुवाद Cloud Translation API से किया गया है.

गतिविधि और गड़बड़ियों को लॉग करना

इस गाइड में, कस्टम लॉग और गड़बड़ी के ऐसे मैसेज लिखने का तरीका बताया गया है जिनसे फ़्लो के उस चरण की समस्या हल करने में मदद मिलती है जो फ़्लो की गतिविधि टैब में नहीं चलता है.

डिफ़ॉल्ट रूप से, गतिविधि टैब में उस चरण का नाम लॉग होता है जो मेनिफ़ेस्ट फ़ाइल में तय किया गया है. किसी चरण के दौरान क्या हुआ, यह समझने के लिए आपको अपने चरण के लिए कस्टम लॉग भी लिखने चाहिए. अगर उपयोगकर्ताओं को आपके चरण को चलाते समय कोई समस्या आती है, तो आपके लॉग से उन्हें यह समझने में मदद मिल सकती है कि क्या हुआ.

काम की लॉग एंट्री में दो एट्रिब्यूट होते हैं:

इस चिप में, उस संसाधन का हाइपरलिंक होता है जिसे चरण में बनाया या अपडेट किया गया था. उदाहरण के लिए, अगर आपके चरण में कोई Google दस्तावेज़ बनाया जाता है, तो बनाए गए Google दस्तावेज़ से लिंक करने के लिए चिप का इस्तेमाल करें.
गड़बड़ी का मैसेज, जिसमें यह बताया गया है कि कोई चरण क्यों नहीं चला और समस्या को कैसे ठीक किया जाए.

यहां दिए गए कोड सैंपल में बताया गया है कि किसी चरण का onExecuteFunctionCreateDocument(), गतिविधि टैब में किसी टास्क के पूरा होने और गड़बड़ी की जानकारी कैसे लॉग कर सकता है:

Apps Script

// A helper method to return host app actions
function returnActionHelper(action) {
  let hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(action);

  let renderAction = AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();

  return renderAction;
}

function createDocument() {
  let randomInt = Math.floor(Math.random() * 2)
  console.log("The random generated integer is: ", randomInt);
  if (randomInt == 0) {
    console.log("Mock document creation failed.");
    return false;
  } else if (randomInt == 1) {
    console.log("Mock document creation succeeded.");
    return true;
  }
}

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) {
    let logChip = AddOnsResponseService.newTextFormatChip()
      .setTextFormatIcon(
        AddOnsResponseService.newTextFormatIcon()
          .setMaterialIconName("edit_document")
      )
      .setUrl("https://docs.google.com/document/d/{DOCUMENT}")
      .setLabel("{NAMEOFDOCUMENT}");

    const workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
      // Set the user-facing error log
      .setLog(
        AddOnsResponseService.newWorkflowTextFormat()
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setText("Created Google Doc")
          )
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setTextFormatChip(logChip)
          )
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setText("Created doc detailing how to improve product.")
          )
      );

    returnActionHelper(workflowAction);
  }
  // Otherwise, return an activity log containing an error explaining what happened and how to resolve the issue.
  else {
    let errorChip = AddOnsResponseService.newTextFormatChip()
      .setTextFormatIcon(
        AddOnsResponseService.newTextFormatIcon()
          .setMaterialIconName("document")
      )
      .setLabel("{NAMEOFDOCUMENT}");

    const workflowAction = AddOnsResponseService.newReturnElementErrorAction()
      .setErrorActionability(AddOnsResponseService.ErrorActionability.NOT_ACTIONABLE)
      .setErrorRetryability(AddOnsResponseService.ErrorRetryability.NOT_RETRYABLE)
      // Set the user-facing error log
      .setErrorLog(
        AddOnsResponseService.newWorkflowTextFormat()
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setText("Failed to create Google Doc.")
          )
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setTextFormatChip(errorChip)
          )
          .addTextFormatElement(
            AddOnsResponseService.newTextFormatElement()
              .setText("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")
          )
      );

    returnActionHelper(workflowAction);
  }
}

Apps Script

मिलते-जुलते विषय