কার্যকলাপ এবং ত্রুটি লগ করুন

এই নির্দেশিকাটি ব্যাখ্যা করে যে কীভাবে কাস্টম লগ এবং ত্রুটি বার্তা লিখতে হয় যা ফ্লো অ্যাক্টিভিটি ট্যাবে চালানো ব্যর্থ হওয়া ফ্লো ধাপের সমস্যা সমাধানে সহায়তা করে।

ডিফল্টরূপে, অ্যাক্টিভিটি ট্যাবটি তার ম্যানিফেস্ট ফাইলে বর্ণিত ধাপের নাম লগ করে। ধাপে দৌড়ানোর সময় কী ঘটেছিল তা বুঝতে সাহায্য করার জন্য, আপনার ধাপের জন্য কাস্টম লগও লিখতে হবে। যদি ব্যবহারকারীরা আপনার ধাপ চালানোর সময় অপ্রত্যাশিত আচরণের সম্মুখীন হন, তাহলে আপনার লগগুলি তাদের কী ঘটেছে তা বুঝতে সাহায্য করতে পারে।

একটি সহায়ক লগ এন্ট্রির দুটি বৈশিষ্ট্য রয়েছে:

  • ধাপটি তৈরি বা আপডেট করা রিসোর্সের হাইপারলিঙ্ক সম্বলিত একটি চিপ। উদাহরণস্বরূপ, যদি আপনার ধাপটি একটি Google ডক তৈরি করে, তাহলে তৈরি করা Google ডকের সাথে লিঙ্ক করতে চিপটি ব্যবহার করুন।
  • একটি ধাপ কেন সম্পন্ন হয়নি এবং কীভাবে সমস্যাটি সমাধান করা যায় তা বর্ণনা করে একটি বিস্তারিত ত্রুটি বার্তা।

নিচের কোড নমুনাটি দেখায় কিভাবে একটি ধাপের onExecuteFunctionCreateDocument() একটি সফল রান এবং একটি ত্রুটি Activity ট্যাবে লগ করতে পারে:

অ্যাপস স্ক্রিপ্ট 

// 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);
  }
}