メタデータ API 開発者ガイド
jESignatureEnvelopeConfig
親種別
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ESignatureEnvelopeConfig コンポーネントのサフィックスは .eSignatureEnvelopeConfig で、eSignatureEnvelopeConfigs フォルダに保存されます。
バージョン
ESignatureEnvelopeConfig コンポーネントは、API バージョン 54.0 以降で使用できます。
特別なアクセスルール
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| expirationPeriod | integer | 署名の有効期限期間。 |
| expirationWarningPeriod | integer | 警告通知の有効期限までの日数。 |
| firstReminderPeriod | integer | エンベロープの配信から���初のアラームメールまでの日数。 |
| isExpirationEnabled | 有効期限が有効になっているかどうかを示します。 | |
| isReminderEnabled | boolean | アラームが有効になっているかどうかを示します。 |
| isVendorDefaultNtfcnEnabled | boolean | エンベロープでアカウントのデフォルトの通知設定を使用するかどうかを示します。 |
| masterLabel | string | 必須。設定の名前。 |
| reminderIntervalPeriod | integer | アラームメール間の間隔 (日数)。 |
| targetObjectName | string | 必須。eSignature を適用するオブジェクト (商談、見積、注文など)。 |
| vendor | Vendor(string 型の 列挙) | 必須。構成設定が属するプロバイダタイプ。現在、DocuSign のみがサポートされています。 |
| vendorAccountIdentifier | string | eSignature ブランド設定識別子。 |
宣言的なメタデータの定義のサンプル
ESignatureEnvelopeConfig コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ESignatureEnvelopeConfig xmlns="http://soap.sforce.com/2021/10/metadata">
3 <masterLabel>DocuSign_Contract</masterLabel>
4 <targetObjectName>Contract</targetObjectName>
5 <vendorAccountIdentifier>vai</vendorAccountIdentifier>
6 <isExpirationEnabled>true</isExpirationEnabled>
7 <expirationPeriod>2</expirationPeriod>
8 <expirationWarningPeriod>2</expirationWarningPeriod>
9 <isReminderEnabled>true</isReminderEnabled>
10 <firstReminderPeriod>2</firstReminderPeriod>
11 <reminderIntervalPeriod>2</reminderIntervalPeriod>
12 <isVendorDefaultNtfcnEnabled>true</isVendorDefaultNtfcnEnabled>
13 <vendor>DocuSign</vendor>
14</ESignatureEnvelopeConfig>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2021/10/metadata">
3 <types>
4 <members>*</members>
5 <name>ESignatureEnvelopeConfig</name>
6 </types>
7 <version>54.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。