How to use timeout mechanism

How to use timeout mechanism#

Introduction#

The Docupedia Fetcher is equipped with a custom timeout mechanism, allowing the user to choose the period of time after which the fetching operations are interrupted. The timeout has a default value of 590 s, in case it was not configured by the user.

Adjust the qg-config.yml file#

  1. Start with the example configuration file from Getting Started with Docupedia Autopilot

  2. Add the timeout environment variable, shown at line 15. By setting DOCUPEDIA_TIMEOUT to 300 the fetcher will have a cut-off period of 300 seconds configured. After this period of time passes, the fetching operations will be interrupted and the autopilot’s status will be set to FAILED.

 6autopilots:
 7  docupedia-autopilot:
 8    run: |
 9      docupedia-fetcher
10      filecheck exists "${{ env.OUTPUT_NAME }}.html"
11    env:
12      DOCUPEDIA_PAGE_ID: ${{ env.DOCUPEDIA_PAGE_ID }}
13      DOCUPEDIA_PAT: ${{ secrets.DOCUPEDIA_PAT }}
14      DOCUPEDIA_URL: ${{ env.DOCUPEDIA_URL }}
15      DOCUPEDIA_TIMEOUT: 300
16      OUTPUT_NAME: docupedia_content

Upload and run the config#

You can now upload the config to the Yaku service and run it. You should then find the downloaded content in the evidence zip file.