# ADOBESIGNCHECK Workflow Application

## Overview

The **ADOBESIGNCHECK** workflow application lets you verify the status of an agreement and download its associated file, which is a concatenation of attached files.

## How it works

* You can verify the status of an agreement and download the file from Adobe Sign based on your status criteria.<br>
* Application logs are available. These can be specified by setting the value of the `AdobeSignCheckLogLevel` parameter in the `web.config` file to `0` to deactivate logs, `1` for error logs, `2` for information logs, or `3` for debug logs; the default value is `0`.

## Configuring the Adobe Sign API

For instructions on how to configure the Adobe Sign API, see the [Configuring the Adobe Sign API](https://docs.workflowgen.com/admin/8.0/adobesignsend-workflow-application#configuring-the-adobe-sign-api) section in the [ADOBESIGNSEND Workflow Application](https://docs.workflowgen.com/admin/8.0/adobesignsend-workflow-application) chapter.

## Required parameter

| Parameter                | Type | Direction | Description                              |
| ------------------------ | ---- | --------- | ---------------------------------------- |
| `ADOBESIGN_AGREEMENT_ID` | TEXT | IN        | ID of the Adobe Sign agreement to verify |

## Optional parameters

### Adobe Sign configuration

| Parameters                | Type | Direction | Description                                                                                                                                                                                                                                                                                                                        |
| ------------------------- | ---- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ADOBESIGN_CLIENT_ID`     | TEXT | IN        | <p>Adobe Sign client ID<br></p><p>By default, this value comes from the <code>AdobeSignClientId</code> parameter in the <code>web.config</code> file.</p>                                                                                                                                                                          |
| `ADOBESIGN_CLIENT_SECRET` | TEXT | IN        | <p>Adobe Sign client secret</p><p></p><p>By default, this value comes from the <code>AdobeSignClientSecret</code> parameter in the <code>web.config</code> file.</p>                                                                                                                                                               |
| `ADOBESIGN_REFRESH_TOKEN` | TEXT | IN        | <p>Authentication refresh token</p><p><br>By default, this value comes from the <code>AdobeSignAuthServer</code> parameter in the <code>web.config</code> file. </p><p></p><p>To obtain it, see the <a href="../adobesignsend-workflow-application#configuring-the-adobe-sign-api">Configuring the Adobe Sign API</a> section.</p> |
| `ADOBESIGN_HOST_SERVER`   | TEXT | IN        | <p>Adobe Sign host server (e.g. <code><https://api.naX.adobesign.com></code>, where <code>x</code> is the server ID)</p><p></p><p>By default, this value comes from the <code>AdobeSignHostServer</code> parameter in the <code>web.config</code> file.</p>                                                                        |

### General

| Parameters           | Type | Direction | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------------------- | ---- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `VALID_STATUS_LIST`  | TEXT | IN        | <p>Valid status to download the document<br></p><p><strong>Possible values:</strong></p><ul><li><code>OUT\_FOR\_SIGNATURE</code></li><li><code>OUT\_FOR\_DELIVERY</code></li><li><code>OUT\_FOR\_ACCEPTANCE</code></li><li><code>OUT\_FOR\_FORM\_FILLING</code></li><li><code>OUT\_FOR\_APPROVAL</code></li><li><code>AUTHORING</code></li><li><code>CANCELLED</code></li><li><code>SIGNED</code></li><li><code>APPROVED</code></li><li><code>DELIVERED</code></li><li><code>ACCEPTED</code></li><li><code>FORM\_FILLED</code></li><li><code>EXPIRED</code></li><li><code>ARCHIVED</code></li><li><code>PREFILL</code></li><li><code>WIDGET\_WAITING\_FOR\_VERIFICATION</code></li><li><code>DRAFT</code></li><li><code>DOCUMENTS\_NOT\_YET\_PROCESSED</code></li><li><code>WAITING\_FOR\_FAXIN</code></li><li><code>WAITING\_FOR\_VERIFICATION</code></li></ul><p><strong>Default:</strong> <code>SIGNED,APPROVED,CANCELLED,EXPIRED,ARCHIVED</code></p> |
| `ADOBESIGN_DOCUMENT` | FILE | OUT       | Adobe Sign document                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ADOBESIGN_STATUS`   | TEXT | OUT       | Agreement status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

## Example with ADOBESIGNSEND

In the following example, the ADOBESIGNSEND action is directly followed  by the ADOBESIGNCHECK action. This action will loop back onto itself until the status changes to `SIGNED`, `APPROVED`, `CANCELLED`, `EXPIRED`, or `ARCHIVED`.

If the status returned meets the condition, the document will be downloaded from Adobe Sign.

![](https://3810463125-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ0OuyalhD4eRB31PgV%2F-MbS_UTRu7oxF8-fmCSZ%2F-MbSa5Z99vPtKv6qYIPt%2Fimage.png?alt=media\&token=c98c4a51-3251-466a-a66c-a11fe3f8df4a)

With the system loop action function, the ADOBESIGNCHECK action will be executed every `x` seconds until the OUT condition is met.

![Configuring an ADOBESIGNCHECK action](https://3810463125-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQ0OuyalhD4eRB31PgV%2F-MbS_UTRu7oxF8-fmCSZ%2F-MbSaN-UzBctHbvVd4ig%2Fimage.png?alt=media\&token=cbe1fbca-e682-4ed2-8609-f3bec0799ad2)