How to Schedule a Task for Retrieve using the Task Scheduler in Windows

NOTE: DocuSign monitors usage of this application very closely. DocuSign Retrieve should not be used at an interval more frequent than once per hour. Running DocuSign Retrieve on an interval shorter than one hour can result in revoked access to the Retrieve application. If you are needing a service with real time results and retrieval of DocuSign documents, envelopes, and statuses, DocuSign Connect should be used in place of Retrieve.
 
  1. Open Retrieve.
  2. Log in and set up your query, just as you would do if you wanted to run it right now.
  3. Select Tools menu and choose ‘Console Script Builder’
  4. You will get an output of your current query. Notice the /span parameter in the query is set to -1.
    Commandline
  5. Copy the bottom part that is highlighted above. This is what you will need for the Windows task scheduler.
  6. Open up Task Scheduler (press the Start menu button and type ‘task’ in the search, it should be the first option)
  7. Click the Create Task option on the right hand side.
  8. Under the General tab, enter a name for your task.
  9. Under the Triggers tab, click new and choose a time schedule for your task to run. Most people will want this to run nightly, or possibly weekly/monthly. Please select your desired settings but for no less than 1 hour intervals.
  10. Under the Actions tab, click new.
  11. In the Action drop down, make sure it is set to ‘Start a Program
  12. For ‘Program/Script’ specify the path to Retrieve. Example: "C:\Program Files (x86)\DocuSign, Inc\Retrieve 3.2\DocuSignRetrieve.exe" with the quotes. You may also need to paste the folder in Start In without the quotes.
    User-added image
  13. In ‘Add Arguments’ paste your script but DO NOT include DocuSignRetrieve.exe 
  14. Under the Conditions tab, configure your desired settings.
  15. Under the Settings tab, configure your desired settings.
  16. Click OK.