はじめに

「DocuSign」とAPI連携でドキュメントのダウンロードをするサンプルシナリオ(以降、本サンプルシナリオ)について説明します。

本サンプルシナリオの概要

本サンプルシナリオは、以下の処理を行います。

• DocuSignとAPI連携し、アクセストークンの確認を行います。
• アクセストークンの有効期限が切れていた場合、再発行処理を行います。
• DocuSignとAPI連携し、ドキュメントの情報取得とファイルダウンロードを実行します。

使用するWinActorモジュール

本サンプルシナリオでは、以下のWinActorモジュールを使用します。

• ノード/変数/変数値コピー
• ノード/変数/変数値設定
• ノード/変数/カウントアップ
• 07_文字列操作/01_変形整形/括弧書きの内側を取り出す.ums6
• 07_文字列操作/02_切り出し分割/文字列を前後に分割.ums6
• 07_文字列操作/03_連結/文字列の連結（２つ）.ums6
• 07_文字列操作/03_連結/文字列の連結（３つ）.ums6
• 07_文字列操作/03_連結/文字列の連結（５つ）.ums6
• 13_ファイル関連/01_テキストファイル操作/テキストファイル書込.ums6
• 13_ファイル関連/01_テキストファイル操作/テキストファイル読込.ums6
• 13_ファイル関連/02_ファイル操作/ファイル削除.ums6
• 13_ファイル関連/03_フォルダ操作/フォルダ作成.ums6
• 98_構造データ関連/JSONファイル 配列サイズ.ums6
• 98_構造データ関連/JSONファイル 配列読み取り.ums6
• 98_構造データ関連/JSON変数 読み取り.ums6
• 99_外部サービス連携/02_HTTP関連/HTTP.ums6

本サンプルシナリオの想定レベル

本ドキュメントは、以下の技術レベルのユーザを対象としています。

• DocuSignの使い方について理解している。

動作確認環境

本サンプルシナリオは以下の環境で確認しています。

• Windows 10、WinActor 6.3.0
• Windows 10、WinActor 7.2.0

制約事項

• 本サンプルシナリオを実行するためには、DocuSignにアクセスするためのインターネット環境が必要です。
• 本サンプルシナリオおよびドキュメントは、DocuSignにログインできる状態を前提に記載されています。

本サンプルシナリオの使い方

本サンプルシナリオの実施方法は以下の通りです。

Step1.シナリオ実行事前設定

本サンプルシナリオではシナリオ実行前の手順として、「「DocuSign」とAPI連携の初期設定を行うサンプルシナリオ」を実行し、「Basic認証キー.txt」「アクセストークン.txt」「リフレッシュトークン.txt」を生成しておく必要があります。

Step2.WinActorで本サンプルシナリオを読み込み

任意のディレクトリに本サンプルシナリオのシナリオファイルとStep1で生成した「Basic認証キー.txt」「アクセストークン.txt」「リフレッシュトークン.txt」を配置します。
その後、本サンプルシナリオをWinActorで読み込みます。

Step3.WinActorで本サンプルシナリオを実行

本サンプルシナリオを実行します。
シナリオ実行後、同フォルダにダウンロードしたドキュメントが配置されます。

Step4.サンプルシナリオ実行終了後の確認

シナリオ実行終了後、シナリオファイルと同じフォルダにドキュメント格納フォルダが作成されていることを確認してください。
フォルダ名は「[日付]_[エンベロープID]」の形式になっています。
例：2021-01-01_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

トラブルシューティング

本サンプルシナリオでは、HTTPリクエストを使用しています。
シナリオ実行中にエラーが表示される場合はお手数ですが、WinActor本体のプロキシ設定のご確認や、「応答ステータス」変数の値に格納されたレスポンスステータスコードのご確認をお願いします。

サンプルシナリオ解説

本サンプルシナリオで使用している実装テクニックについて説明します。

受信フォルダのドキュメントにフィルタリングする処理

本サンプルシナリオでは、DocuSign上にあるドキュメントのうち受信フォルダにあるものだけを対象とするよう、シナリオ内でフィルタリングを行っています。
条件分岐をなくすことで、すべてのドキュメントを対象にすることができます。また検索条件を「sentitems」にすることで送信フォルダのみに限定することができます。

ドキュメントのフィルタリング

ドキュメントの詳細情報について

本サンプルシナリオでは、受信フォルダのすべてのドキュメントをダウンロードの対象としていますが、ドキュメントの情報をもとに追加でフィルタリングを行うことも可能です。
以下の「JSONからデータ読み込み」グループ内でDocuSignから取得できる情報を変数に格納していますので、その値をもとに条件分岐を追加することで、必要なドキュメントのみをダウンロードするよう改造できます。

ドキュメント情報を取得する処理

初期配置ファイルの配置場所

本サンプルシナリオでは、シナリオファイルと同じフォルダに「Basic認証キー.txt」「アクセストークン.txt」「リフレッシュトークン.txt」を配置することとしています。
これらのファイル配置場所を移動したい場合は、変数一覧の「Basic認証キーファイル」「アクセストークンファイル」「リフレッシュトークンファイル」をそれぞれ任意のファイルパスに変更することで実現可能です。

ファイルパスの変更