マイクロアプリ

DocuSignの統合

DocuSign統合を展開して、Citrix Workspaceを使用する任意のデバイスからデジタル署名のエンベロープを送受信します。ユーザーは、署名用の新しいテンプレートを開始し、保留中の新しいドキュメントの通知を受信し、DocuSignの受信ボックスで以前に送受信されたエンベロープの一覧を表示できます。

注:

ご意見・ご要望をお待ちしています。この統合テンプレートに関するフィードバックをお送りください。また、問題についてはサポートチームが専用フォーラムを毎日確認いたします。

すぐに利用可能なDocuSign用のマイクロアプリの包括的な詳細については、「DocuSignマイクロアプリの使用 」 を参照してください。

必須条件の確認

これらの前提条件は、管理者が組織のDocuSign統合セットアップの一部であることを前提としています。このDocuSign管理者アカウントには、ユーザー情報の完全な読み取り権限が必要です。

DocuSignとのこの統合を設定した後、Citrix Workspaceマイクロアプリに統合を追加するには、これらのアーティファクト、特にOAuth統合を設定するための次のパラメーターの一覧が必要になります:

  • ベースURL:エンドポイントパスが追加されるベースURL。[Apps and Keys] のサービスアカウントからベースURLを収集できます。ベースURL形式:{baseURL fetched from sevice account}/restapi/2.1/。ベースURLの検索方法については、「OAuthサーバーの構成」を参照してください。
  • DocuSignアカウントID:DocuSignの管理者アカウントID。「OAuthサーバーの構成」を参照してください。
  • 環境URL:たとえば、ベースURLのうちのhttps://{yourEnvironmentalURL}.docusign.net/restapi/v2.1/
  • 認証URLhttps://account-d.docusign.com/oauth/auth
  • トークンURLhttps://account-d.docusign.com/oauth/token
  • クライアントID:クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。また、DocuSignのすべてのアプリケーションキーは、DocuSignのGo-Liveプロセスに合格する必要があります。これは、統合キーClientId)に適用されます。これには最大1週間かかる場合があります。DocuSignのGo-Liveプロセスについて詳しくは、「https://developers.docusign.com/docs/esign-rest-api/go-live/」を参照してください。
  • クライアントシークレット:クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。

注:

利用可能な場合は、サービス認証方法として常にOAuth 2.0を使用することをお勧めします。OAuth 2.0は、統合が、構成済みのマイクロアプリとの最大限のセキュリティコンプライアンスを満たすことを保証します。

Citrix GatewayがDocuSignのシングルサインオンに対応するように構成して、ユーザーがログインすると、再度資格情報を入力しなくても自動的に再ログインできるようにします。SSOの構成について詳しくは、「Citrix Gatewayサービス」を参照してください。

特定のリソースに対して実行できるAPI要求の数は限られているため、以下をお勧めします:

DocuSign API制限フォームのリンク:https://developers.docusign.com/docs/esign-soap-api/esign101/security/call-limits/

新しいサービスアカウントの作成

ここから登録します: https://admin.docusign.com。 ここでユーザー権限プロファイルを表示できます:https://support.docusign.com/en/guides/ndse-admin-guide-permission-sets。eSignature Adminのデモバージョンにアクセスする場合は、代わりに次のURLを使用してください:https://admindemo.docusign.com。新しいサービスアカウントについて詳しくは、https://support.docusign.com/en/guides/org-admin-guide-getting-startedを参照してください。

OAuthサーバーの構成

DocuSign統合を介してデータを読み取るようにOAuthサーバーを構成します。

  1. サービスアカウントを使用してeSignature Adminにログインします:https://admin.docusign.com。eSignature Adminのデモバージョンの場合:https://admindemo.docusign.com。詳しくは、https://support.docusign.com/en/guides/ndse-admin-guide-accessおよびhttps://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administrationを参照してください。
  2. ナビゲーションバーの [Setting] に移動します。
  3. 設定ページで、[Apps and Keys][ADD APP & INTEGRATION KEY] の順に選択します。
  4. アプリ名を入力し、[ADD] を選択します。
  5. [+Add Secret Key] を選択して秘密キーを生成します。
  6. [Redirect URI] を入力します:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. 画面に表示されている統合キー秘密キーClientIdSecret)をコピーして保存します。統合を構成するときに、これらの詳細をサービス認証に使用します。
  8. アカウントのベースURIをコピーして保存します。
  9. DocuSignアカウントIDをコピーして保存します。

また、DocuSignのすべてのアプリケーションキーは、DocuSignのGo-Liveプロセスに合格する必要があります。これは、統合キーClientId)に適用されます。これには最大1週間かかる場合があります。DocuSignのGo-Liveプロセスについて詳しくは、「https://developers.docusign.com/docs/esign-rest-api/go-live/」を参照してください。

OAuthクライアントの構成

DocuSign統合を通じてデータをライトバックするようにOAuthクライアントを構成します。

  1. サービスアカウントを使用してeSignature Adminにログインします:https://admin.docusign.com。eSignature Adminのデモバージョンの場合:https://admindemo.docusign.com。詳しくは、https://support.docusign.com/en/guides/ndse-admin-guide-accessおよびhttps://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administrationを参照してください。
  2. ナビゲーションバーの [Setting] に移動します。
  3. 設定ページで、[Apps and Keys][ADD APP & INTEGRATION KEY] の順に選択します。
  4. アプリ名を入力し、[ADD] を選択します。
  5. [+Add Secret Key] を選択して秘密キーを生成します。
  6. [Redirect URI] を入力します:https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  7. 画面に表示されている統合キー秘密キーClientIdSecret)をコピーして保存します。統合を構成するときに、これらの詳細をサービスアクション認証に使用します。

また、DocuSignのすべてのアプリケーションキーは、DocuSignのGo-Liveプロセスに合格する必要があります。これは、統合キーClientId)に適用されます。これには最大1週間かかる場合があります。DocuSignのGo-Liveプロセスについて詳しくは、「https://developers.docusign.com/docs/esign-rest-api/go-live/」を参照してください。

組織の構成

アカウントを組織に関連付けます。組織の作成に使用したアカウントは自動的に関連付けられます。

  1. eSignature Adminのホームページで [GET STARTED] を選択します。DocuSignアカウントにこのオプションが表示されない場合、DocuSign Adminはアカウントで有効になっていません。DocuSignアカウントマネージャーにサポートを依頼してください。
  2. 表示された [Organization Name] フィールドと任意の [Description] フィールドに入力し、[NEXT] を選択します。
  3. [CREATE] を選択して、組織の作成を完了します。詳しくは、「https://support.docusign.com/en/guides/org-admin-guide-create-org」を参照してください。
  4. [Organization Admin] ダッシュボードに移動します。[Connected Apps][AUTHORIZE APPLICATION] の順に選択します。
  5. OAuthサーバーとクライアントの構成中に入力および作成したアプリ名を選択します。[ADD] を選択して、権限を指定します。
  6. 以下のスコープを入力します。詳しくは、「https://developers.docusign.com/platform/auth/reference/scopes」を参照してください。
    • サービス認証の場合、OAuthサーバーの構成で作成したアプリ名を選択し、user_read権限を指定し、[ADD] を選択します。
    • サービスアクション認証の場合、OAuthクライアントの構成で作成したアプリ名を選択し、user_write権限を指定し、[ADD] を選択します。

Citrix Workspaceマイクロアプリへの統合の追加

DocuSign統合をCitrix Workspaceマイクロアプリに追加して、アプリケーションに接続します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。これにより、通知とアクションが設定済みとなっている追加設定不要のマイクロアプリを、Workspace内で使用できるようになります。

次の手順を実行します:

  1. [マイクロアプリ統合] ページで [新しい統合を追加] および [Citrix提供のテンプレートから新しい統合を追加する] を選択します。
  2. DocuSignタイルを選択します。
  3. 統合の [統合名] を入力します。
  4. コネクタのパラメーターを入力します。
    • インスタンスの [ベースURL] を入力します:
    • アイコンライブラリから統合のアイコンを選択するか、デフォルトのアイコンのままにしておきます。

    DocuSignパラメーター

  5. DocuSignアカウントIDを入力します。「OAuthサーバーの構成」を参照してください。
  6. [サービス認証][認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。OAuth 2.0セキュリティプロトコルを使用して、委任されたアクセスの要求/承認トークンを生成します。利用可能な場合は、サービス認証方法として常にOAuth 2.0を使用することをお勧めします。OAuth 2.0は、統合が、構成済みのマイクロアプリとの最大限のセキュリティコンプライアンスを満たすことを保証します。

    1. [許可の種類] メニューで [認証コード] を選択します。これによって、クライアントが交換するアクセストークン用の一時コードが付与されます。コードは認証サーバーから取得され、そこでクライアントが要求している情報を確認できます。この許可の種類のみが、安全なユーザーの偽装を有効にします。これにより、アプリケーションの登録時に使用する [コールバックURL] が表示されます
    2. [トークン認証] メニューから [要求の本文] を選択します。
    3. [認証URL] は事前に入力されています。
    4. [トークンURL] は事前に入力されています。
    5. スコープに次のように入力されていることを確認します:user_read
    6. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。OAuthサーバーを構成したときに、クライアントIDとシークレットを収集します。統合構成ページに表示される [コールバックURL] を追加する必要があります。
    7. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。

    サービス認証

  7. [サービスアクション認証][[アクション]で個別のユーザー認証を使用する] トグルを有効にします。サービスアクション認証は、サービスアクションレベルで認証します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。

    1. [認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。
    2. [許可の種類] メニューで [認証コード] を選択します。これによって、クライアントが交換するアクセストークン用の一時コードが付与されます。コードは認証サーバーから取得され、そこでクライアントが要求している情報を確認できます。この許可の種類のみが、安全なユーザーの偽装を有効にします。これにより、アプリケーションの登録時に使用する [コールバックURL] が表示されます
    3. [トークン認証] メニューから [要求の本文] を選択します。
    4. [認証URL] は事前に入力されています。
    5. [トークンURL] は事前に入力されています。
    6. スコープに次のように入力されていることを確認します:user_write
    7. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。OAuthクライアントを構成したときに、クライアントIDとシークレットを収集します。統合構成ページに表示される [コールバックURL] を追加する必要があります。
    8. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。

    サービスアクション認証

  8. [要求レート制限を有効にする] を有効にします。[要求数] に「400」と入力し、[時間間隔][1分] にします。 1..[要求タイムアウト] は、デフォルトで「120」に設定されています。
  9. (オプション)サポートのために24時間のログを保持するには、[ログ] を有効にします。

    サービス認証

  10. [保存] を選択して続行します。
  11. [OAuth認証][承認] を選択して、サービスアカウントにログインします。Googleのログイン画面がポップアップで表示されます。
    1. サービスアカウントのユーザー名とパスワードを入力し、[ログイン] を選択します。
    2. [同意] を選択します。

    承認

ボタンへのアクションの追加

以下のボタンで [移動先URL] アクションを構成して[エンベロープに署名] および [エンベロープを表示する] ボタンの機能を有効にします。この [移動先URL] の構成は、ユーザーアクションをDocuSignの特定のエンベロープの詳細ページにリダイレクトします。

  1. ページビルダーで次のボタンに移動して選択します。以下の各ボタンに対してこの手順を実行します:

    • 自分が受信したエンベロープマイクロアプリ:[保留中のエンベロープの詳細] ページ:[エンベロープに署名] ボタン
    • 自分が送信したエンベロープマイクロアプリ:[受信者のエンベロープの表示] ページ:[エンベロープに署名] ボタン
    • 自分が送信したエンベロープマイクロアプリ:[送信者のエンベロープの表示] ページ:[エンベロープを表示する] ボタン
  2. 右側の [アクション] タブを選択します。
  3. [アクション] で、[移動先URL] を選択します。
  4. [URLテンプレート] フィールドでURLの{yourEnvironmentName}部分を環境URLに置き換えます。ベースURLで環境URLを見つけます:https://{yourEnvironmentName}.docusign.net/restapi/v2.1/。例:https://appdemo.docusign.com/documents/details/\{\{nested_table_envelopes_recipients_sign.envelope_id\}\}

    環境URL

  5. 他のボタンに対してもこの手順を繰り返します。

これで、最初のデータ同期を設定して実行する準備ができました。同期ルール、スケジュールを満たさない同期、および拒否ルールの詳細については、「データの同期」を参照してください。

APIエンドポイントとテーブルエンティティについて詳しくは、「DocuSignコネクタの仕様」を参照してください。

DocuSignマイクロアプリの使用

既存のアプリケーション統合には、追加設定不要のマイクロアプリが付属しています。これらのマイクロアプリから開始して、ニーズに合わせてカスタマイズします。

注:

[エンベロープに署名] および [エンベロープを表示する] ボタンの機能を有効にするには、[保留中のエンベロープの詳細]ページ、[受信者のエンベロープの表示]ページ、[送信者のエンベロープの表示]ページの [アクション] ボタンを環境URLに置き換える必要があります。「ボタンへのアクションの追加」を参照してください。

自分が受信したエンベロープ: ユーザーの受信した、署名を待機しているエンベロープを表示します。ユーザーは、自分自身を認証し、DocuSignでエンベロープを表示できます。

通知またはページ ユースケースワークフロー
自分の保留中のエンベロープ ページ メールの件名または送信者名でエンベロープをフィルタリングする検索オプションを使用して、ユーザーの署名が保留されているすべてのエンベロープを含むテーブルを提供します。ユーザーは、ステータスがSentおよびDeliveredのエンベロープを表示できます。
保留中のエンベロープの詳細ページ メールの件名、送信者名、有効期限(日数)など、署名が保留されているエンベロープの詳細を提供します。ユーザーは、DocuSignのエンベロープを [エンベロープに署名] ボタンを使用して表示できます。

テンプレートを送信する: 既存の署名のテンプレートを送信します。

通知またはページ ユースケースワークフロー
すべてのテンプレートページ ユーザーのすべてのテンプレートが含まれたテーブルを提供します。この統合では、テンプレート一覧でSharedテンプレートがサインインしたユーザーに表示されません。
Template Detailsページ テンプレートを受信者に送信するためのフォームを提供します。送信者は、エンベロープを送信するために、名前、メール、役割の詳細を指定します。エンベロープは、一度に最大3人の受信者に送信できます。テンプレートを使用してエンベロープを送信するためには、テンプレートにドキュメントが含まれている必要があります。

自分が送信したエンベロープ: ユーザーが送信したエンベロープの一覧を表示します。ユーザーは、エンベロープの詳細を表示したり、受信者を追加、編集、削除したりすることもできます。

注:

通知は、作成後2日で期限切れになります。

通知またはページ ユースケースワークフロー
エンベロープステータスの変更通知 エンベロープのステータスがCompletedまたはDeclinedに変更されると通知が生成され、エンベロープの送信者に送信されます。レコードがCitrixマイクロアプリデータベースに追加されたときに、エンベロープのステータスが既にCompletedまたはDeclinedになっていた場合、送信者に対して通知は生成されません。
[新しいエンベロープ]通知 新しいエンベロープを受信すると、エンベロープのステータスと受信者のステータスがSentまたはDeliveredのいずれかになり、通知が生成されて関連する受信者に送信されます。
受信者の追加ページ 受信者をエンベロープに追加するためのフォームを提供します。名前、メール、役割などの入力フィールドが含まれます。
受信者の編集ページ 名前やメールなどの入力フィールドを編集するためのフォームを提供します。ユーザーが名前またはメールを変更すると、[保存時手再送信] ボタンが表示され、メールが受信者に送信されます。
エンベロープの詳細ページ メールの件名、作成日、ステータスなどのエンベロープの詳細を提供します。また、エンベロープに関連付けられている受信者のリストと、[受信者の追加] ボタンも表示されます。ユーザーは、無効になったまたは拒否されたエンベロープに対して編集を加えたり、受信者を追加したりすることはできません。
自分のエンベロープページ ステータス(送信済み、配信済み、完了、拒否、無効)を含めた、ユーザーが送信したすべてのエンベロープの一覧が表示されます。また検索バーから、メールの件名またはエンベロープのステータスでエンベロープをフィルタリングできます。
受信者の詳細ページ 名前、メール、ステータスなどの受信者の詳細を、次のボタンとともに提供します:受信者の編集、エンベロープを再送信する、受信者の削除。
受信者のエンベロープの表示ページ メールの件名、送信者名、有効期限(日数)など、署名が保留されているエンベロープの詳細を提供します。ユーザーは、DocuSignのエンベロープを [エンベロープに署名] ボタンを使用して表示してから署名できます。
送信者のエンベロープの表示ページ メールの件名、作成日、ステータスなどのエンベロープの詳細を提供します。エンベロープに関連付けられている受信者の一覧と [エンベロープに署名 ] ボタンも表示されます。
DocuSignの統合