ESignatureConfig

Represents the settings for integrating with external eSignature providers.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ESignatureConfig components have the suffix .eSignatureConfig and are stored in the eSignatureConfigs folder.

Version

ESignatureConfig components are available in API version 54.0 and later.

Special Access Rules

Fields

configType

Type: ConfigType (enumeration of type string)

Description: Required.

Indicates the configured setting.

Possible values are AnchorString, CalloutTimeout, EnvelopesLastPollDate, SignerRoles, or SyncFileSizeLimit

configValue

Type: string

Description: Required.

Indicates the value of the configured setting.

description

Type: string

Description: The description for the configuration setting.

groupType

Type: ConfigGroup (enumeration of type string)

Description: The description for the configuration setting.

Possible values are AnchorTabSetting, CalloutConfigurationSetup, Envelope, or EnvelopeObjectLimits

masterLabel

Type: string

Description: Required.

Indicates the name of the setting.

vendor

Type: Vendor (enumeration of type string)

Description: Required.

The provider type to which the configuration setting belongs. Currently only DocuSign is supported.

Declarative Metadata Sample Definition

The following is an example of an ESignatureConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ESignatureConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <configType>AnchorString</configType>
4    <groupType>AnchorTabSetting</groupType>
5    <configValue>12345</configValue>
6    <masterLabel>DocuSignAnchorString</masterLabel>
7    <vendor>DocuSign</vendor>
8    <description>testdescription</description>
9</ESignatureConfig>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ESignatureConfig</name>
6    </types>
7    <version>54.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.