Excel Add-In for DocuSign

Build 23.0.8839

接続の確立

接続プロファイルの設定

[CData]リボンから[データの取得]をクリックし、[取得元:DocuSign]> 設定済みの接続 を選択してCData クエリウィンドウを起動します。新しい接続を設定するには、[新しいDocuSign 接続]をクリックします。ここでは、接続の設定、接続のテスト、および接続プロファイルの保存を行うことができます。

DocuSign への接続

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

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

DocuSign への認証

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

OAuth

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

デスクトップアプリケーション

下記の手順に従って、カスタムOAuth アプリの資格情報を使用して認証します。カスタムOAuth アプリの作成 を参照してください。

OAuth アクセストークンの取得およびリフレッシュ

次を設定して、接続してください。

  • OAuthClientId:アプリの登録時に割り当てられたIntegrator Key に設定。
  • OAuthClientSecret:アプリの登録時に割り当てられたSecret Key に設定。
  • CallbackURL:アプリの登録時に定義されたリダイレクトURI に設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

OAuth JWT

AuthSchemeOAuthJWT に設定します。

Obtaining a User ID

Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.

Obtaining an Integration Key

Follow the procedure below to obtain an integration key:

  1. Log in to a DocuSign developer account.
  2. Navigate to My Apps and Keys.
  3. You will see a dialog box to enter your application's name. Give your application a short, but descriptive name.
  4. Click ADD to add your application. Your application is automatically assigned an integration key (GUID) value that cannot be changed. Save this value.

Application Consent

In order to connect, you must give consent to the application. DocuSign offers three different software patterns for granting consent to an integration key. Grant consent to your application using one of the following methods.

Method 1: Administrative Consent

This is the best option for customer-oriented developers, because it requires nothing from your users.

Note: This pattern can't be used by ISVs.

This method of obtaining consent has the following prerequisites:

  • Your account must include the Access Management with SSO feature, though it is not required that you install SSO.
    • If your developer demo account (demo.docusign.net) does not include this feature, send an email to go-live@docusign.com and request that the feature be added to your account. Remember to include your developer demo account ID.
  • You must claim your email DNS domain via the DocuSign administration tool. A domain can be claimed both by the DocuSign developer demo system (for testing and development), and by your production DocuSign account.
  • Your users’ email domains must match the claimed email domain.
  • Your integration key’s management account must be one of the accounts in the DocuSign organization.

If you meet these requirements, grant consent as follows:

  1. In DocuSign Admin, open your organization home page.
  2. In the navigation pane on the left side of the page, select Connected Apps.
  3. Click Authorize Application and choose an application from the drop-down menu.
  4. In the Add New Application dialog, specify the permissions you want to grant to your application.
  5. Click ADD.

Method 2: Individual Consent

This option has no prerequisites and can be used by customer-oriented developers and the customers of ISVs. Each user must perform the following steps.

To obtain individual consent:

  1. Run the GetConsentURL stored procedure. The procedure returns a URL.
  2. Open the returned URL in your browser. A permissions page will display.
  3. Click Accept to grant consent.
Method 3: Administrative Consent for Third-party (ISV) Applications

You can grant administrative consent to third party (ISV) applications.

This method of obtaining consent has the following prerequisites:

  • All prerequisites for standard Administrative Consent apply (see section above).
  • ISVs should also support individual consent as a backup, since SSO not all customers will be able to use administative consent.
  • If you are an ISV using the JWT grant flow, then the management account tied to your application’s integration key should be a DocuSign account that your company controls.

If you meet these requirements, obtain consent as follows. Each user must perform the following steps.

  1. Run the GetConsentURL stored procedure. The procedure returns a URL.
  2. Open the returned URL in your browser. A permissions page will display.
  3. Click Accept to grant consent.

Configuring OAuth JWT Credentials

Using the information you gathered in the above sections, set the following connection properties in the 本製品:
  • OAuthJWTCert: The location of your private key. This should end with ".key".
  • OAuthJWTCertType: PEMKEY_FILE
  • OAuthJWTSubject: Your user ID.
  • OAuthJWTIssuer: Your integration key.

接続プロパティ

最後に、Connection プロパティを参照してください。接続の確立に使用できるさまざまなオプションの説明があります。

接続の管理

DocuSign への認証に成功すると、インポートするデータをカスタマイズすることができます。詳しくは、接続の管理 を参照してください。

関連項目

  • データのクエリ:[データ選択]ウィザードを使用してスプレッドシートにデータをプルします。また、ここではスケジュールされたデータのリフレッシュも設定できます。
  • Excel アドインの使用:利用可能なCData Excel 関数 を使用するなど、DocuSign データとやり取りする他の方法が見つかります。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839