Subscribe

UiPath Activities

The UiPath Activities Guide

DocuSign Scope

UiPath.DocuSign.Activities.DocuSignScopeActivity

The DocuSign activities use the JWT authentication to establish a connection between UiPath and your DocuSign environment. This connection authorizes a Robot to call the DocuSign eSignature APIs and access resources on your behalf.

To enable authentication, you can create a DocuSign App with JWT authentication. You can also choose to create use DocuSign with OAuth authentication. For more information and before you build your first automation project, see the DocuSign Setup guide.

The DocuSign activities use the authentication information you entered to establish an authenticated connection between UiPath and your DocuSign environment. This connection authorizes a Robot to call the DocuSign eSignature APIs and access resources on your behalf.

After establishing a connection, a parent DocuSign Scope activity can output a record of the connection in a Connection object (Connection) that you can use in subsequent child scope activities.

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the DocuSign Scope activity to your project.
  3. Enter values for the properties located [in the body of the activity](doc:docusign-scope#section-in-the-body-of-the-activity].
  4. Create and enter a Connection variable for Output property. You can use this variable in subsequent uses of the DocuSign Scope activity.

In the Body of the Activity

  • Auth Type - The type of authentication to use for the connection. Select one of the following three options: OAuth2AuthorizationCode, OAuthJWT, ExistingConnection.
  • Base Url - The base url for the connection. This field supports only Strings or String variables. The value for production environments will be different.
  • Client Id - The client identifier issued to the client. This field supports only Strings or String variables.
  • Client Secret - The client secret issued to the client. Enter a SecureString or SecureString variable.
  • Config File Client - Content of the config file. This field supports only Strings or String variables.
  • Config File Path - The path of the config file. This field supports only Strings or String variables.
  • ExistingConnection - Enter a Connection or Connection variable. The Connection variable must be from a previously run DocuSign Scope activity (parent) that still has an active connection.

Properties

Common

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

  • Environment Type - The environment type you are authenticating against. Select one of the two options: Development and Production.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

  • ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When not selected, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution

Output

  • Connection - The connection which can be passed to a child application scope. This field supports only Connection variables.

Updated 2 months ago


DocuSign Scope


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.