Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、DocuSign への接続を作成します。DocuSign アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからDocuSign コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

重要な接続プロパティ

UseSandbox
UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントを使用する場合はtrue に設定します。以下のOAuth フローはすべて、UseSandbox が事前に設定済みであることを前提として書かれています。

AccountId
AccountId はオプションの接続プロパティです。認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。

DocuSign への認証

DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、カスタムアプリを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。カスタムアプリケーションの作成について詳しくは、カスタムOAuth アプリの作成 を参照してください。

Web アプリケーション

Web アプリケーション経由で接続する場合は、DocuSign にカスタムOAuth アプリを登録する必要があります。カスタムOAuth アプリの作成 を参照してください。それからSync App を使用してOAuth トークンの値を取得および管理します。 OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

• OAuthClientId：アプリの登録時に割り当てられたIntegrator Key に設定。
• OAuthClientSecret：アプリの登録時に割り当てられたSecret Key に設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。

   ストアドプロシージャがOAuth エンドポイントのURL を返します。

2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。

OAuth アクセストークンのリフレッシュ

InitiateOAuth をREFRESH に設定してOAuth アクセストークンの期限が切れたときに自動的にリフレッシュするか、RefreshOAuthAccessToken ストアドプロシージャを呼び出してトークンを手動でリフレッシュできます。

自動リフレッシュ

InitiateOAuth でトークンをリフレッシュするには、最初のデータ接続で次のように設定します。

• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
• InitiateOAuth：REFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
• OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパスを設定。これらの値は接続間で永続化されます。
• OAuthClientId：アプリの登録時に割り当てられたIntegrator Key に設定。
• OAuthClientSecret：アプリの登録時に割り当てられたSecret Key に設定。
• OAuthRefreshToken：これをGetOAuthAccessToken によって返されたリフレッシュトークンに設定します。

その後のデータ接続では、次を設定します。

• InitiateOAuth
• OAuthSettingsLocation

手動でリフレッシュ

RefreshOAuthAccessToken ストアドプロシージャを使用してOAuthAccessToken を手動でリフレッシュできます。GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後にストアドプロシージャを呼び出します。次の接続プロパティを設定する必要があります。

• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthClientSecret：アプリ設定のクライアントシークレットに設定。

次に、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuthRefreshToken を指定してRefreshOAuthAccessToken を呼び出します。

データアクセスのファインチューニング

• AccountId：複数アカウントにアクセスできる場合に指定できるオプションのアカウントId。
• DirectoryRetrievalDepth：使用可能なフォルダをリストするときにスキャンするフォルダの深さ（つまり、サブフォルダの深さ）。
• IncludeCustomFields：エンベロープまたはテンプレートのカスタムフィールド値を取得する場合は、True に設定。
• Url：アカウントに関連付けられたBase API URL。AccountId 同様にデフォルト設定。
• UseSandbox：サンドボックスを使用する場合はTrue に設定。

このセクションでは、DocuSign Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、DocuSign にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、DocuSign API へのSQL の実行について詳しく説明します。

主要機能

• Sync App はドキュメント、フォルダ、およびグループなどのDocuSign エンティティをリレーショナルビューとしてモデル化し、SQL を記述してDocuSign データをクエリできるようにします。
• ストアドプロシージャを使用すると、アクセストークンの取得やOAuth 2.0でのリフレッシュの維持など、DocuSign の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Sync App を使用するとDocuSign アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Accounts、Documents、Folders などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、DocuSign のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、DocuSign の操作を実行できます。

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

DocuSign Connector for CData Sync ビュー

Name	Description
AccountBrands	The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.
AccountCustomFields	The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.
Accounts	The Accounts resource provides methods that allow you to manage your accounts.
BulkEnvelopes	Retrieves status information about all the bulk recipient batches.
BulkRecipients	The BulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope or template.
CloudStorageProviders	The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.
CustomTabs	The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.
Documents	The Documents resource provides methods that manage documents in an envelope or template.
DocumentTabs	The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.
DocumentVisibility	The Document Visibility resource provides methods that manage document views and insights in an envelope or template.
EnvelopeAttachments	The EnvelopeAttachments resource provides methods that allow you to manage attachments.
EnvelopeConsumerDisclosures	The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.
Envelopes	The Envelope resource provides methods that allow you to manage envelopes.
EnvelopeTemplates	The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.
Folders	Retrieves a list of the folders for the account.
GroupBrands	The GroupBrands resource provides methods that allow you to manage brands in a group.
Groups	The Groups resource provides methods that allow you to manage groups for the account.
GroupUsers	The GroupUsers resource provides methods that allow you to manage the users in a group.
Locks	The Locks resource provides methods that allow you to manage locks on an envelope or template.
PowerForms	The PowerForms resource provides methods that allow you to manage power forms.
Recipients	The Recipients resource allows you manage the recipients of an envelope or template.
RecipientTabs	The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.
SigningGroups	Returns data from a sample table.
SigningGroupUsers	The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.
Templates	The Template resource provides methods that allow you to manage templates.
UserInfo	The UserInfo resource provides methods that allow you to manage your current user info.
Users	The Users resource provides methods that allow you to manage users for an account.
UserSignatures	The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.
Workspaces	The Workspaces resource provides methods that allow you to manage workspaces.

The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM AccountBrands WHERE BrandId = '4701f9c2-1038-45cf-bf35-66ae143a5656'

Columns

Name	Type	References	Description
BrandId [KEY]	String		Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.
IsOverridingCompanyName	Boolean		When is set to true, brand name is the name of the company.
IsSendingDefault	Boolean		When is set to true, it is sending default.
IsSigningDefault	Boolean		When is set to true, it is signing default.

The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FieldId [KEY]	Integer		An ID used to specify a custom field.
Name	String		The name of the custom field.
CustomFieldType	String		Type of the custom field.
ListOfValues	String		Comma separated value of the .
Show	Boolean		A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.
Required	Boolean		When set to true, the signer is required to fill out this tab
ConfigurationType	String		If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

The Accounts resource provides methods that allow you to manage your accounts.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
AccountId [KEY]	Integer		Id of the account.
AccountIdGuid	String		The GUID associated with the account ID.
AccountName	String		The name of the current account.
CreatedDate	Datetime		The date when account was created.
CurrencyCode	String		Specifies the ISO currency code for the account.
CurrentPlanId	String		Identifies the plan that was used create this account.
PlanName	String		The name of the Billing Plan.
PlanClassification	String		Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.
PlanStartDate	Datetime		The date that the Account started using the current plan.
PlanEndDate	Datetime		The date that the current plan will end.
PaymentMethod	String		Method of the payment.
EnvelopeUnitPrice	String		Price of an envelope.
EnvelopeSendingBlocked	Boolean		When set to true, user can not send envelopes.
BillingProfile	String		The name of the Billing Profile.
BillingPeriodStartDate	Datetime		The UTC DateTime that account billing started.
BillingPeriodEndDate	Datetime		The UTC DateTime that account billing finish.
BillingPeriodDaysRemaining	Integer		Number of remaining billing days.
BillingPeriodEnvelopesSent	Integer		Number of sent envelopes.
BillingPeriodEnvelopesAllowed	String		Specifies the allowed number of sent envelopes.
CanCancelRenewal	Boolean		When set to true, specifies that you can cancel renewal.
CanUpgrade	Boolean		When set to true, specifies that you can upgrade the account through the API.
IsDowngrade	Boolean		When set to true, specifies that your account is downgraded.
AllowTransactionRooms	Boolean		When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.

Retrieves status information about all the bulk recipient batches.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• BatchId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BulkEnvelopes WHERE BatchId = 'eaf12958-f1c8-4636-9a29-42c63fa80ab5'

Columns

Name	Type	References	Description
BatchId [KEY]	String		Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
BatchSize	Integer		The number of items returned in this response.
BulkEnvelopesBatchUri	String		Uri of the bulk envelopes.
SubmittedDate	Datetime		The date that it is submitted.
Sent	Integer		The number of entries with a status of sent.
Failed	Integer		The number of entries with a status of failed.
Queued	Integer		The number of entries with a status of queued.

The BulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM BulkRecipients WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544
SELECT * FROM BulkRecipients WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544

Columns

Name	Type	References	Description
Type	String		Specifies where the bulk is applied. Possible options are envelopes or templates
Id	String		Id of the Envelope or Template.
RecipientId	Integer	Recipients.RecipientId	Unique Id for the recipient.
Email	String		Specifies the recipient's email address.
Name	String		Specifies the recipient's name.
RowNumber [KEY]	Integer		Specifies the row number of the recipient in the list.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
PhoneNumber	String		This is only used if the Identification field value is Phone or SMS.
Identification	String		Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer.The acceptable values are: KBA: Enables the normal ID check authentication set up for your account. Phone: Enables phone authentication. SMS: Enables SMS authentication.

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM CloudStorageProviders WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• ServiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CloudStorageProviders WHERE userId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a' AND ServiceId = '440189'

Columns

Name	Type	References	Description
UserId	String		Id of the user account
ServiceId	String		The DocuSign generated ID for the cloud storage provider
Service [KEY]	String		The service name for the cloud storage provider.
AuthenticationUrl	String		The authentication URL used for the cloud storage provider.
RedirectUrl	String		The URL the user is redirected to after the cloud storage provider authenticates the user.

The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• CustomTabId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CustomTabs WHERE CustomTabId = '926770b6-1cb6-487c-918c-dacf8c9caa2a'

Columns

Name	Type	References	Description
CustomTabId [KEY]	String		The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Type	String		The type of this tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
Width	Integer		Width of the tab in pixels.
Height	Integer		Height of the tab in pixels.
Editable	Boolean		When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.
DisableAutoSize	Boolean		When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
CreatedByUserId	String		The userId of the DocuSign user who created this object.
CreatedByDisplayName	String		The user name of the DocuSign user who created this object.
Locked	Boolean		When set to true, the signer cannot change the data of the custom tab.
LastModified	Datetime		The UTC DateTime this object was last modified. This is in ISO8601 format.
LastModifiedByUserId	String		The userId of the DocuSign user who last modified this object.
LastModifiedByDisplayName	String		The User Name of the DocuSign user who last modified this object.

The Documents resource provides methods that manage documents in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Documents WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * FROM Documents WHERE Type = 'templates' AND Id = 'd5c67830-b37a-4171-9e87-3de377b35a90'

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId [KEY]	String		Specifies the document Id number that the tab is placed on. This must refer to an existing Document's ID attribute.
DocumentName	String		Specifies the document name.
DocumentType	String		Specifies the document type.
Uri	String		Uri of the document.
Display	String		This string sets the display and behavior properties of the document during signing. The possible values are: modal - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. download - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. inline - The document is shown in the normal signing window.
Order	Integer		An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order. desc = descending sort order.
Pages	Integer		Number of pages in a document.
DocumentGroup	String		Group of the document.
AttachmentTabId	String		Id of the attachment tab.
AuthoritativeCopy	Boolean		Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.
ContainsPdfFormFields	String		Indicates pdf form fields.
IncludeInDownload	Boolean		When set to true, the document is included in the combined document download. The default value is true.
SignerMustAcknowledge	String		Sets how the signer interacts with the supplemental document. The possible values are: no_interaction - No recipient action is required. view- The recipient is required to view the document. accept - The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. view_accept - The recipient is required to view and accept the document.

The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• DocumentId - Id of the document.

For example:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1'
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PageNumber supports the '='.

For example, the following queries are processed server side:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1' AND PageNumber = 1
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1' AND PageNumber = 3

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID that the tab is placed on.
RecipientId	String		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String		The DocuSign generated custom tab ID for the custom tab to be applied.
TabName	String		Name of the tab.
Value	String		Specifies the value of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	Boolean		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.

The Document Visibility resource provides methods that manage document views and insights in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM DocumentVisibility WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544
SELECT * FROM DocumentVisibility WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544

Columns

Name	Type	References	Description
Id [KEY]	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
RecipientId	Integer		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Visible	Boolean		When set to true, the document is visible.
Rights	String		Rights of the recipient for this document.

The EnvelopeAttachments resource provides methods that allow you to manage attachments.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeAttachments WHERE EnvelopeId = '56e3ca38-8008-441e-a29e-eb23dd3269e1'

Columns

Name	Type	References	Description
EnvelopeId	String	Envelopes.EnvelopeId	The envelope ID.
AttachmentId [KEY]	String		Id of the attachment.
AttachmentType	String		Type of the attachment.
Name	String		Name of the attachment.
Label	String		Label of the attachment.
AccessControl	String		AccessControl of the attachment.

The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId and RecipientId.

For example:

SELECT * FROM [EnvelopeConsumerDisclosures] WHERE EnvelopeId = '7cc4251f-31ca-4a79-8221-53451222292d' AND RecipientId = 68364179

Columns

Name	Type	References	Description
EnvelopeId	String		The envelope ID.
RecipientId	String		Unique Id for the recipient.
AccountEsignId [KEY]	String		A GUID identifying the account associated with the consumer disclosure.
CompanyName	String		The name of the company associated with the consumer disclosure.
CompanyPhone	String		The phone number of the company associated with the consumer disclosure.
ChangeEmail	String		Email of the account.
ChangeEmailOther	String		Other email information.
CopyCostPerPage	String		Copy cost for a page.
CopyFeeCollectionMethod	String		Specifies the fee collection method for cases in which the customer requires paper copies of the document.
EnableEsign	String		When is set to true, Esign is enabled.
EsignAgreement	String		The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
EsignText	String		Text of the Esign.
MustAgreeToEsign	String		When is set ti true, customer must agree.
PdfId	String		The pdfId property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored.
AllowCDWithdraw	String		Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
WithdrawAddressLine1	String		Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawAddressLine2	String		Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawByEmail	String		Indicates whether the customer can withdraw consent by email.
WithdrawByMail	String		Indicates whether the customer can withdraw consent by postal mail.
WithdrawByPhone	String		Indicates whether the customer can withdraw consent by phone.
WithdrawCity	String		Contains the city of the postal address to which a customer can send a consent withdrawal notification.
WithdrawConsequences	String		Indicates the consequences of withdrawing consent.
WithdrawEmail	String		Contains the email address to which a customer can send a consent withdrawal notification.
WithdrawOther	String		Indicates other information need to withdraw consent.
WithdrawPhone	String		Contains the phone number which a customer can call to register consent withdrawal notification.
withdrawPostalCode	String		Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.
WithdrawState	String		Contains the state of the postal address to which a customer can send a consent withdrawal notification.

The Envelope resource provides methods that allow you to manage envelopes.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EnvelopeId supports the '='.
• Status supports the '='.
• StartDateToSearch supports the '='.
• EndDateToSearch supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00'
SELECT * FROM Envelopes WHERE StartDateToSearch = '2019-6-24T10:00:04-00:00' AND EndDateToSearch = '2019-8-24T10:00:04-00:00' AND Status = 'sent'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String		The envelope ID.
EnvelopeUri	String		Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Status	String		Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
EnvelopeIdStamping	String		When set to true, Envelope ID Stamping is enabled.
EmailSubject	String		Specifies the subject of the email that is sent to all recipients.
EmailBlurb	String		This is the same as the email body.
DocumentsUri	String		Contains a URI for an endpoint that you can use to retrieve the documents.
DocumentsCombinedUri	String		Contains a URI for an endpoint that you can use to retrieve the combined documents.
AttachmentsUri	String		Contains a URI for an endpoint that you can use to retrieve the attachments.
RecipientsUri	String		Contains a URI for an endpoint that you can use to retrieve the recipients.
CustomFieldsUri	String		Contains a URI for an endpoint to retrieve the custom fields.
CertificateUri	String		Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.
NotificationUri	String		Contains a URI for an endpoint that you can use to retrieve the notifications.
SigningLocation	String		Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
BrandId	String		The unique identifier of a brand.
BrandLock	String		Lock of the brand.
SentDateTime	Datetime		The date and time the envelope was sent.
CompletedDateTime	Datetime		Specifies the date and time this item was completed.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
DeclinedDateTime	Datetime		The date and time the recipient declined the document.
LastModifiedDateTime	Datetime		The date and time the item was last modified.
DeletedDateTime	Datetime		Specifies the data and time the item was deleted.
StatusChangedDateTime	Datetime		The data and time the status changed.
VoidedDateTime	Datetime		The date and time the envelope was voided.
VoidedReason	String		The reason the envelope was voided.
MessageLock	String		When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.
RecipientsLock	String		When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
PurgeState	String		Shows the current purge state for the envelope. The possible values are: unpurged: There has been no successful request to purge documents. documents_queued: The envelope documents have been added to the purge queue, but have not been purged. documents_dequeued: The envelope documents have been taken out of the purge queue. documents_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. documents_purged: The envelope documents have been successfully purged. documents_and_metadata_purged: The envelope documents and metadata have been successfully purged.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AllowMarkup	String		When set to true, Document Markup is enabled for envelope.
Asynchronous	String		When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
AuthoritativeCopy	String		Specifies whether all documents in this envelope are authoritative copies.
AuthoritativeCopyDefault	String		The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set.
AutoNavigation	String		Specifies whether auto navigation is set for the recipient.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
FolderId	String		Id of the folder where envelope is located.
GetFullInfo	Bool		Id of the folder where envelope is located.

The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = '11dc472d-5675-47b7-ac4e-96c47e473dfe'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = 'cd7a0feb-2911-4595-a28e-deaa4a51f55d' AND DocumentId = '3'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String	Envelopes.EnvelopeId	The envelope ID.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Name	String		Name of the template.
DocumentId	String	Documents.DocumentId	Specifies the document ID number.
DocumentName	String		Name of the document.
Applied	Boolean		When set to true, template is applied.
Uri	String		Uri of the template.

Retrieves a list of the folders for the account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FolderId [KEY]	String		The ID of the folder being accessed.
ParentFolderId	String		Id of the parent folder.
ParentFolderUri	String		Uri of the parent folder.
Name	String		Name of the folder.
Type	String		Type of the folder.
Uri	String		Uri of the folder.
OwnerUserId	String		Owner id of the folder.
OwnerUserName	String		Owner name of the folder.
OwnerEmail	String		Owner email of the folder.

The GroupBrands resource provides methods that allow you to manage brands in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupBrands WHERE GroupId = 6160665

Columns

Name	Type	References	Description
GroupId	Integer	Groups.GroupId	The DocuSign group ID for the group.
BrandId [KEY]	String	AccountBrands.BrandId	Id of the brand.
InternalId	String		Internal Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.

The Groups resource provides methods that allow you to manage groups for the account.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• GroupType supports the '='.

For example, the following query is processed server side:

SELECT * FROM Groups WHERE GroupType = 'everyoneGroup'

Columns

Name	Type	References	Description
GroupId [KEY]	Integer		The DocuSign group ID for the group.
GroupName	String		The name of the group.
GroupType	String		The group type.
UsersCount	Integer		Total number of users of the group.
PermissionProfileId	String		The ID of the permission profile associated with the group.

The GroupUsers resource provides methods that allow you to manage the users in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupUsers WHERE GroupId = 6071932

Columns

Name	Type	References	Description
GroupId	Integer	Groups.GroupId	The DocuSign group ID for the group.
UserId [KEY]	String	Users.UserId	Id of the user account
UserName	String		Name of the user account
Email	String		Email of the user account
UserType	String		Type of the user account
UserStatus	String		Status of the user account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
Uri	String		Uri of the user account
LoginStatus	String		Status of login.
SendActivationEmail	Boolean		When set to true, an activation email can be sent.
ActivationAccessCode	String		Activation code for access.

The Locks resource provides methods that allow you to manage locks on an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Locks WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Locks WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Id [KEY]	String	Envelopes.EnvelopeId or Templates.TemplateId	Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
LockedByUserName	String		Name of the user.
LockedByUserId	String		The user ID of the user being accessed.
LockedByUserEmail	String		Email of the user.
LockedByUri	String		Uri of the user.
LockedByApp	String		Specifies the friendly name of the application that is locking the envelope.
LockType	String		The type of envelope lock. Currently
LockToken	String		A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
LockedUntilDateTime	Datetime		The datetime until the envelope lock expires.
LockDurationInSeconds	String		Sets the time, in seconds, until the lock expires when there is no activity on the envelope.
UseScratchPad	String		Indicates whether a scratchpad is used for editing information.

The PowerForms resource provides methods that allow you to manage power forms.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PowerFormId supports the '='.

For example, the following query is processed server side:

SELECT * FROM PowerForms WHERE PowerFormId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
PowerFormId [KEY]	String		The unique identifier of the power form.
Name	String		PowerForm name.
PowerFormUrl	String		Contains a URI for an endpoint that you can use to retrieve the PowerForms.
PowerFormV2Url	String		Contains V2 URI for an endpoint that you can use to retrieve the PowerForms.
Uri	String		Uri of the powerforms.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
TemplateName	String		Name of the template.
CreatedBy	String		Creator name.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
SenderName	String		Name of the sender.
SenderUserId	String		User Id of the sender.
EmailBody	String		Email body of the message sent to the recipient.
EmailSubject	String		The subject of the email that is sent to all recipients.
SigningMode	String		Specifies the mode of the signing.
Instructions	String		Specifies the PowerForm instructions.
IsActive	Boolean		Indicates the status of the PowerForm.
TimesUsed	Integer		Indicates number of times the item was used.
LastUsed	Datetime		Indicates the date and time the item was used for the last time.
MaxUseEnabled	Boolean		The maximum of using times for the item.
UsesRemaining	Integer		The remaining number of times the item can be used.
LimitUseIntervalEnabled	Boolean		Status of the LimitUseInterval.
LimitUseInterval	String		Specifies the interval of the uses limit.
LimitUseIntervalUnits	String		Unit type of the LimitUseInterval.

The Recipients resource allows you manage the recipients of an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Recipients WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Recipients WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
Id	String		Id of the Envelope or Template.
RecipientId [KEY]	Integer		Unique Id for the recipient.
RecipientIdGuid	String		Id guid of the recipient.
RecipientType	String		Type of the recipient.
UserId	String		The user ID of the user being accessed.
Name	String		Name of the recipient.
Email	String		Email of the recipient.
RoleName	String		Optional element. Specifies the role name associated with the recipient.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
CreationReason	String		Reason of the creation.
ClientUserId	String		Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
RequireIdLookup	Boolean		When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
DeliveryMethod	String		Method of the delivery.
DeliveredDateTime	Datetime		Date and time of the delivery.
SignedDateTime	Datetime		The date and time the envelope was signed.
SigningGroupId	String		The display Id for the signing group.
SigningGroupName	String		The display name for the signing group.
CanSignOffline	Boolean		When set to true, specifies that the signer can perform the signing ceremony offline.
Status	String		Recipient status.

The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM RecipientTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND RecipientId = 7296558
SELECT * FROM RecipientTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND RecipientId = 44407249

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on.
RecipientId	Integer	Recipients.RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String	CustomTabs.CustomTabId	The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
TabOrder	String		A positive integer that sets the order the tab is navigated to during signing.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	String		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.

Returns data from a sample table.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
SigningGroupId [KEY]	String		Id of the signing group.
GroupName	String		The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
GroupType	String		The group type.
GroupEmail	String		Email of the group.
Created	String		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		Creator of the group.
Modified	Datetime		The UTC DateTime when the workspace user authorization was modified.
ModifiedBy	String		Modifier of the group.

The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.

View Specific Information

In order to make a successful request on this view, you have to specify SigningGroupId.

For example:

SELECT * FROM SigningGroupUsers WHERE SigningGroupId = '6071932'

Columns

Name	Type	References	Description
SigningGroupId	String	SigningGroups.SigningGroupId	Id of the signing group.
UserName	String		The name of the group member.
Email [KEY]	String		The email of the group member.

The Template resource provides methods that allow you to manage templates.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• TemplateId supports the '='.
• FolderId supports the '=' and 'IN'. In order to filter by FolderId, showCustomFiled property must be set to false.
• FolderName supports the '='. In order to filter by FolderName, showCustomFiled property must be set to false.

For example, the following queries are processed server side:

SELECT * FROM Templates WHERE TemplateId = '5fe47399-31e9-4ddc-bbd1-5200760e4658'
SELECT * FROM Templates WHERE FolderId = '7137682d-f33c-4425-96a2-d556389df80f'
SELECT * FROM Templates WHERE FolderId IN ('7137682d-f33c-4425-96a2-d556389df80f', 'ff7cc98e-4502-4009-93ce-8d3ad96485a6')
SELECT * FROM Templates WHERE FolderName = 'testTemplate'

Columns

Name	Type	References	Description
TemplateId [KEY]	String		Id of the template.
Name	String		Name of the template.
Password	String		Password of the template.
Description	String		Description of the template.
Shared	String		When set to true, this template is shared.
Created	Datetime		The date and time the item was created.
LastModified	Datetime		The date and time the item was last modified.
PageCount	String		Number of pages.
Uri	String		Contains a URI to retrieve the templates.
FolderName	String		Name of the template folder.
FolderId	String	Folders.FolderId	Id of the folder.
FolderUri	String		Uri of the folder.
OwnerUserName	String		Name of the user.
OwnerEmail	String		Email of the user.
OwnerUserId	String		Id of the user.
EmailBlurb	String		Blurb of the email
EmailSubject	String		Subject of the email.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AuthoritativeCopy	String		Specifies whether all documents in this template are authoritative copies. A document can set its own authoritativeCopy property to override this value.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document.

The UserInfo resource provides methods that allow you to manage your current user info.

Columns

Name	Type	References	Description
AccountId [KEY]	String		The ID of the account.
AccountName	String		The name associated with this account.
Url	String		The base URI that is used for making API calls on behalf of this account.
IsDefault	Boolean		If true, this account is the account holder's default account.

The Users resource provides methods that allow you to manage users for an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Users supports the '='.
• Email supports the '='.
• UserStatus supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE UserId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'
SELECT * FROM Users WHERE Email = '[email protected]'
SELECT * FROM Users WHERE UserStatus = 'Active'
SELECT * FROM Users WHERE UserStatus = 'Active' AND Email = '[email protected]'"

Columns

Name	Type	References	Description
UserId [KEY]	String		The user ID of the user being accessed.
UserName	String		The user's full name.
UserStatus	String		Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserType	String		The user type.
IsAdmin	Boolean		Determines if the feature set is actively set as part of the plan.
Email	String		The user's email address.
Uri	String		Uri of the user.
PermissionProfileId	Integer		User's permission profile id.
permissionProfileName	String		User's permission profile name.
JobTitle	String		Title of the job.
Title	String		Salutation for the user, such as Ms, Dr, Capt., etc.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
LastLogin	Datetime		The date-time when the user last logged on to the system.

The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM UserSignatures WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

Columns

Name	Type	References	Description
UserId	String	Users.UserId	The user ID of the user being accessed.
SignatureId [KEY]	String		Specifies the signature ID associated with the signature name.
SignatureImageUri	String		Contains the URI for an endpoint that you can use to retrieve the signature image.
InitialsImageUri	String		Contains the URI for an endpoint that you can use to retrieve the initials image.
SignatureInitials	String		The initials associated with the signature.
UserSignatureName	String		Specifies the user signature name.
SignatureType	String		Type of the signature.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
AdoptedDateTime	Datetime		The date and time the user adopted their signature.
IsDefault	Boolean		Specifies if the signature is default or not.

The Workspaces resource provides methods that allow you to manage workspaces.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
WorkspaceId [KEY]	String		The id of the workspace, always populated.
WorkspaceName	String		The name of the workspace.
WorkspaceUri	String		The relative URI that may be used to access the workspace.
WorkspaceBaseUrl	String		The relative URL that may be used to access the workspace.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
LastModified	Datetime		Utc date and time the comment was last updated (can only be done by creator.)
Status	String		Workspace status.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
AccountId	AccountId of the currently authenticated user.
DirectoryRetrievalDepth	The depth to scan for available folders.
IncludeCustomFields	Set to true if you want to retrieve custom fields values for an envelope or template.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
URL	Base API url associated with your account.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSandbox	Set to true if you you are using sandbox account.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はDocuSign への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\DocuSign Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
AccountId	AccountId of the currently authenticated user.
DirectoryRetrievalDepth	The depth to scan for available folders.
IncludeCustomFields	Set to true if you want to retrieve custom fields values for an envelope or template.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
URL	Base API url associated with your account.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSandbox	Set to true if you you are using sandbox account.

AccountId of the currently authenticated user.

解説

If it's not specified, it will be set by default. Please query the UserInfo view if you want to set it manually.

The depth to scan for available folders.

解説

This property must be set in the connection string or the driver will use a default of Depth=-1 (specifies that all subfolders are scanned).

Set to true if you want to retrieve custom fields values for an envelope or template.

解説

Set to true if you want to retrieve custom fields values for an envelope or template.

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

Base API url associated with your account.

解説

If it's not specified, it will be set by default. Please query UserInfo view if you want to set it manually.

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Set to true if you you are using sandbox account.

解説

Set to true if you you are using sandbox account.