DocuSign RetrieveDocument

You can use this activity to download the signed document from the envelope.

Settings

The Settings tab has the following field:

Field Description
Connection Name of the connection.

Input Settings

The Input Settings tab has the following field:

Field Description
Get All Documents

Select one of the following two choices:

  • True: Retrieves all the documents from the envelope.

  • False: Retrieves single document from the envelope specified by envelope ID and document ID.

Input

The Input element on the Input tab displays the input schema of the activity as a tree structure. The input values vary depending on the configurations selected on the Settings tab. On the Input tab, you can specify the following information:

Field Description
envelopeId Enter the envelope ID to retrieve the document details.
documentId

Enter the document ID returned as output in the DocuSignListDocument activity.

Note: This is an optional field. If this field is empty, the activity returns document with ID 1.

Output Settings

The Output Settings tab has the following field:

Field Description
Output file Type

Select the file type from the drop-down list:

  • PDF

  • ZIP

Output

The Output tab displays the output schema of the activity as a tree structure. The output is read-only. The information in the schema varies based on the fields selected on the Settings tab. The properties that are displayed in the schema correspond to the output of this activity and can be used as input by subsequent activities in the flow.

Field Description
fileContent The file content. The file content is in base64 string format.
errorCode Displays the error code if the activity fails.
message Displays the error message if the activity fails.

Loop

If you want this activity to iterate multiple times within the flow, enter an expression that evaluates the iteration details. Select a type of iteration from the Type menu. The default type is None, which means the activity does not iterate.

Retry on Error

For more information, see the “Using the Retry on Error Feature in an Activity” section in the TIBCO Flogo® app documentation.