Polling envelope status

In this task, the workflow uses the DocuSign retrieve envelope status workflow action to poll, once per minute, the status of the DocuSign envelope that contains the document that was sent earlier in the workflow, as part of the previous task. For more information about the previous task, see Sending the document.

To configure the workflow to poll envelope status

  1. Add a new Set Workflow Variable workflow action to the design canvas, and configure it so that it sets the value of the Status workflow variable to "In Process".

    This workflow variable tracks the status of the DocuSign envelope containing the document sent to an attendee.

  2. Add a new Set Workflow Status workflow action to the design canvas, and configure it so that the value of Status is set to "Polling Status".

  3. Add a new Loop with Condition workflow action to the design canvas, and configure it so that the loop occurs while the value of the Status workflow variable equals "In Process".

  4. Add a new Log to History List workflow action to the design canvas, within the Loop with Condition workflow action added in the previous step, and configure it so that the value of Message is set to "Polling for status on Envelope ID: ", and then append a reference to the EnvelopeId workflow variable.

  5. Add and configure a new DocuSign retrieve envelope status workflow action.

    The DocuSign retrieve envelope status workflow action uses the DocuSign API to check the status of a specified DocuSign envelope and retrieve the current status code and status message for that envelope. In this case, the workflow action checks the status of the DocuSign envelope for the sample document that was sent to the current attendee from the sample list.

    Note: To retrieve the unique identifier for a DocuSign envelope, log into DocuSign and view the full history of the document contained in that envelope. The envelope ID is presented, along with other details, in the Document Details section of the Document History dialog box for that document on the DocuSign web site.

    1. Add the workflow action to the design canvas, immediately after the workflow action added in the previous step.

    2. Click the dropdown arrow for the workflow action, and then click Configure.

    3. In the DocuSign Retrieve Envelope Status dialog box, perform the following actions:

      1. Set the value of Authorizing user to the AuthorizingUser workflow variable.

      2. Set the value of Envelope ID to the EnvelopeId workflow variable.

      3. Set the value of Status to the Status workflow variable.

      4. Set the value of Message to the Message workflow variable.

      5. Click Save.

  6. Add a new Run If workflow action, immediately after the workflow action added in the previous step, and configure it so that it runs if the value of the Status workflow variable equals "In Process".

  7. Add a new Log to History List workflow action, inside the Run If workflow action added in the previous step, and configure it so that the value of Message is set to "Pausing for 15 minutes".

  8. Add a new Pause for Duration workflow action, immediately after the workflow action added in the previous step, and configure it so that it pauses for 15 minutes.

  9. Add a new Log to History List workflow action, immediately after (but not inside) the Loop with Condition workflow action added in step 3, configure it so that the value of Message is set to "Polling Completed - Envelope Status: ", and then append a reference to the Status workflow variable to the value.

    The following diagram illustrates the location, relative to the Loop with Condition workflow action, at which the new Log to History List workflow action should be placed (circled in green.)