初期設定手順
最終更新
SignDKの初期設定手順です。
ここでは、SignDK for Docusign eSignatureを利用してkintone と Docusign を連携するための初期設定方法について解説します。
まずは、システム管理者が kintone に SignDK のプラグインを追加します。
❶ kintoneにログインし、kintoneのトップページを表示します。
❷ 画面右上の歯車アイコンをクリックし、「kintoneシステム管理」をクリックします。
❸ サイドメニューの「その他」セクションの「プラグイン」をクリックします。
❹ 左上の「読み込む」ボタンをクリックします。
❺ 「参照」ボタンをクリックしてSignDKのプラグインファイル（例：SignDK_v1.0.13.zip）を選択した後、「読み込む」ボタンをクリックしてください。
❻ 以上で完了です。
システム管理者がkintoneにプラグインを追加すると、アプリにSignDKを追加して利用できるようになります。できるようになります。 を利用するアプリごとに設定を行います。まずは、SignDK を利用するアプリにプラグインを追加します。
❶ SignDKを追加するアプリを開きます
❷ アプリ内右上の歯車アイコンをクリックします。
❸ 「設定タブ」をクリックします。
❹ 「カスタマイズ/サービス連携」セクションの「プラグイン」をクリックします。
❺ 「＋追加する」をクリックします。
❻ kintoneに追加したプラグイン「SignDK for Docusign」が表示されますので、チェックボックスにチェックを入れ、右下の「追加」ボタンをクリックします。
❼ 以上で完了です。
続いて、Docusign 側の設定に入ります。 SignDKを利用してkintoneとDosusignを連携するには、Docusign側でアプリとインテグレーションキーの作成が必要ですが、Docusign は仕様上、本番環境上で直接作成するのではなく、まず開発環境＝サンドボックスでのレビューを行い、合格する必要があります。 開発環境を利用するには「開発者向けアカウント」が必要ですが、これは誰でも無料で作成することができます。
❶ 「https://go.docusign.com/sandbox/productshot/」にアクセスし、必要事項を記入した後「GET STARTED」ボタンをクリックします。
❷ 確認メールが届きますので、「ACTIVATE」ボタンをクリックします。
❸ パスワードと入力し、ログインします。
❹ パスワードを設定しアカウントをアクティブ化すると、自動的にサンドボックス環境にログインした状態になります。 （後からログインし直す場合には、以下の URL からアクセスしてください。 https://appdemo.docusign.com/ ） 初期状態では言語設定が英語になっているので、日本語に変更してから作業するとわかりやすくなります。
画面右上のアイコンをクリックし、「My Preferences」をクリックします。
❺ サイドメニューの「Regional Settings」をクリックします。
❼ 「Language」で「日本語」を選択し、「Save」ボタンをクリックします。
Docusign の設定のために、SignDK を利用する（Docusignと連携したい） kintone アプリのリダイレクト URI を取得します。
❶ SignDKを追加するアプリを開きます
❷ アプリ内右上の歯車アイコンをクリックします。
❸ 「設定タブ」をクリックします。
❹ 「カスタマイズ/サービス連携」セクションの「プラグイン」をクリックします。
❺ プラグイン「SignDK for Docusign」の歯車アイコンをクリックします。
❻ 「プラグインの設定を開く」ボタンをクリックします。
❼ 「Docusign連携設定」セクションのリダイレクトURLを控えておきます。
「Docusign連携設定」の各種項目は後ほど戻ってきて再度設定を行いますので、この時点では設定を行う必要はありません。
続いて、Docusign のサンドボックス環境とkintoneアプリとの連携設定を行います。
❶ 「4-1. 「開発者向けアカウント」と「サンドボックス」の作作成したサンドボックス環境にログインします。
❷ 「設定」タブをクリックします。
❷ サイドメニューの「インテグレーション」セクションの「アプリとキー」をクリックします。
❸ 「アプリとインテグレーションキーの追加」ボタンをクリックします。
❹ 「アプリ名」を入力し、「アプリの作成」ボタンをクリックします。
アプリ名は自由に決めていただけますが、わかりやすく「SignDK」としておくのがおすすめです。
❺ 「インテグレーションキー」をコピーし、控えておきます。
❻ 「このアプリケーションはクライアントシークレットを安全に保管できますか?」は「はい」を選択し、「＋秘密鍵の追加」ボタンをクリックして秘密鍵を生成します。
生成した秘密鍵は後ほど設定で利用しますので、控えておきます。
❼ 「そのほかの設定」セクションの「リダイレクトURI」に「4-2. kintone アプリの「リダイレクト URI」の取得」で控えておいたリダイレクトURLを入力します。
❽ 画面下部の「保存」ボタンをクリックします。
Docusign のエンベロープと、kintone のレコードとの紐付けを一覧で表示するためのテーブルをを作成していきます。
❶ SignDKを利用するアプリを開きます
❷ アプリ内右上の歯車アイコンをクリックします。
❸ 任意の場所に「ラベル」と「テーブル」を追加します。ラベルについては必須ではありませんが、追加しておいた方が分かりやすくなるかと思います。
❹ テーブルには以下のフィールドが追加できます。
「エンベロープへのリンク」「ファイル名」「最終更新日時」の追加は必須です。その他のフィールドは、必須ではありませんが、追加を推奨しています。フィールド名については下記以外の名称でも問題ありません。
まず、テーブルに「リッチエディター」を追加します。
❺ リッチエディターの設定を開きます。
❼ 「フィールド名」は「エンべロープへのリンク」、「フィールドコード」を「SignDK_EnvelopeLink」とし、「保存」ボタンをクリックします。
❽ 続いて、テーブルに「文字列（複数行）」を追加します。
❾ 文字列（複数行）の設定を開きます。
➓ 「フィールド名」は「ファイル名」、「フィールドコード」を「SignDK_AttachmentName」とし、「保存」ボタンをクリックします。
⓫ テーブルに「日時」を追加します。
⓬ 日時の設定を開きます。
⓭ 「フィールド名」は「最終更新日時」、「フィールドコード」を「SignDK_LastModifiedDateTime」とし、「保存」ボタンをクリックします。
⓮ その他、必要に応じて「件名」「宛名」「ステータス」「作成日時」を追加してください。
⓯ 続いて、テーブルの設定を開きます。
⓰ 「テーブル名」には任意のテーブル名を（「テーブル名を表示しない」はどちらでも構いません）、「フィールドコード」も任意ので問題ありませんが、この「フィールドコード」（下図の例だと「DocusignEnvelope」）は、この後の設定で使いますので、メモ帳などにコピペして控えておきます。入力が完了したら「保存」ボタンをクリックします。
⓱ 「フォームを保存」ボタンをクリックし、ここまでの設定を保存します。
続いて、kintone から DocuSignに送信する添付ファイルフィールドに関する設定を行います。この例では、「先方担当者」と「メールアドレス」をDocusignのエンベロープの受信者の名前・メールとして連携します。「契約書」に添付されたファイルをDocusignで送信するファイルとして連携し、送信します。
❶ これらのDocusignとの連携に利用するフィールドの「フィールドコード」を控えておきます。
❷ このままの流れでSignDKプラグインの設定を行なっていきます。
❶ 「設定」タブをクリックします。
❷ 「プラグイン」をクリックします。
❸ プラグイン「SignDK for Docusign」の歯車アイコンをクリックします。
❹ 「プラグインの設定を開く」をクリックします。
❺ 「ライセンスの設定」セクションの 「ライセンスキー」に弊社（株式会社co-meeting）が発行したライセンスキーを入力します。
❻ 「Docusign環境設定」セクションの「環境」で「Sandbox」を選択します。
❼ 「インテグレーションキー」「秘密鍵」に「4-3. DocuSign の「アプリとキー」の設定」で控えておいたインテグレーションキーと秘密鍵を入力します。
❽ 「Docusign送信履歴を表示するテーブルフィールドの要素ID」に「4-4. ⓰」で控えておいたテーブルの「フィールドコード」を入力します。
❾ 「送信対象添付ファイル設定」の「添付ファイル項目」「宛先の名前に使用する項目」「宛先のメールアドレスに使用する項目」に「4-2. ❶」で控えておいたフィールドコードをにそれぞれ入力し、「保存」ボタンをクリックします。
➓ 「宛先のロール名」に「宛先」と入力します。
⓫ 「保存」ボタンをクリックします。
⓬ 「アプリの設定」に移動します。
⓭ 「アプリの更新」ボタンをクリックします。
⓮ 内容を確認して「アプリを更新」ボタンをクリックします。
ここまでの設定が完了したら、実際に kintone のレコード上でDocusignとの連携確認を行います。
❶ プラグインの設定を行ったアプリの任意のレコードを開きます。
❷ 「Docusignログイン」をクリックし、サンドボックス環境のアカウントでログインします。
❸ ログイン後、「Allow Access」をクリックします。
❹ 添付ファイルフィールドに「Docusignに送信」ボタンが表示されていること、「4-4. kintone のフォームの設定」で設置したテーブルの上部にDocusignにログインされていることを示す情報が表示されていることを確認します。
❺ 次に、添付ファイルフィールド下の「Docusignに送信」ボタンをクリックします。
❻Docusignの画面が開きますので、 「文書の追加」セクションにkintoneレコードの添付ファイルフィールドに添付されたファイルが、「受信者の追加」セクションの「ロール」「名前」「メールアドレス」に指定した値が表示されていることを確認します。
❼ kintoneのレコード詳細画面に戻り、テーブルにエンベロープの情報が表示されていることを確認します。
❽ 次に、Docusignで編集したエンベロープを、kintoneへ取り込めるかのテストをします。DocuSignのエンベロープを開きます。
❾ 「メッセージの追加」セクションの「メールの件名」に任意の件名を入力し、「今すぐ送信」ボタンをクリックします。
➓ 「フィールドがない状態で送信」ボタンをクリックします。
⓫ kintoneのレコード詳細画面に戻り、「最新のエンベロープ一覧を取得」ボタンをクリックします。
⓬ 「OK」ボタンをクリックします。
⓭ 「件名」や「ステータス」が更新されていることを確認します。
ここまで、Docusign のサンドボックス環境を利用して設定を行ってきましたが、ここからは本番環境と連携するための設定を行っていきます。
Docusign のAPI キーを Docusign の本番環境で使用するには、サンドボックス環境で作成したAPI キーをレビューし、合格する必要があります。まずは、このレビューに合格するための作業を行います。
❶ SignDKを利用するアプリを開きます
❷ アプリ内右上の歯車アイコンをクリックします。
❸ 「設定タブ」をクリックします。
❹ 「カスタマイズ/サービス連携」セクションの「プラグイン」をクリックします。
❺ プラグイン「SignDK for Docusign」の歯車アイコンをクリックします。
❻ 「APIキーのレビューを開く」ボタンをクリックします。
❼ Docusignにログインしていない場合は「Docusignログイン」をクリックし、Docusignにログインします。
すでにログインしている場合は以下のように表示されます。その場合は❽に進んでください。
❽ 「レビュー用にDocusign APIを実行」ボタンをクリックします。
❾ Docusign APIの実行が完了すると、画面上部に緑のダイアログが表示されます。
続いて、Docusign 側で API のレビューを開始し、レビューを行います。
❶ Docusignのサンドボックス環境にログインします。
❷ 「設定」タブをクリックします。
❸ サイドメニューから「アプリとキー」をクリックします。
❹ 「4-3. Docusign の「アプリとキー」の設定」で作成したインテグレーションキー横の「アクション」ボタンをクリックし、「Go Liveレビューの開始」をクリックします。
❺ 「レビューへの送信」ボタンをクリックします。
❻ しばらく待ってからブラウザを再読み込みし、「レビュー合格」と表示されたら完了です。
レビューが無事完了したら、Docusign の本番環境へのリリース作業を行います。
❶ レビューに合格したインテグレーションキー右の「アクション」ボタンをクリック後、「Go-Liveアカウントの選択」をクリックします。
❷ 同意画面のチェックボックスにチェックを入れ、「同意する」ボタンをクリックします。
❸ Docusignの本番環境にログインします。
❹ 接続するアカウントを選択し、「選択」ボタンをクリックします。
❺ 完了すると、Go Liveステータスが「アプリが公開されました」に変わります。
❻ 「実稼働環境で表示」をクリックすることで、本番環境に追加されていることも確認可能です。
続いて、本番環境で「アプリとキー」の設定を行います。
『4-3. DocuSign の「アプリとキー」の設定』にて行った手順と同一ですが、本番環境にリリースしたアプリは、秘密鍵の取得などの設定を再度行う必要があります。
❶ Docusignの本番環境にログインします。
❷ 「設定」タブをクリックします。
❷ サイドメニューの「アプリとキー」をクリックします。
❸ 追加したアプリの「アクション」ボタンをクリックし、「編集」をクリックします。
❹ 「このアプリケーションはクライアントシークレットを安全に保管できますか?」は「はい」を選択し、「＋秘密鍵の追加」ボタンをクリックして秘密鍵を生成します。
生成した秘密鍵は後ほど設定で利用しますので、控えておきます。
❺ 「そのほかの設定」セクションの「リダイレクトURI」に「4-2. kintone アプリの「リダイレクト URI」の取得」で控えておいたリダイレクトURLを入力します。
❻ 画面下部の「保存」ボタンをクリックします。
続いて、kintone のプラグイン設定に入力されている「秘密鍵」を、「7-2. 本番環境にて「アプリとキー」を設定する」の手順で取得した本番環境のものに更新します。
❶ 「設定」タブをクリックします。
❷ 「プラグイン」をクリックします。
❸ プラグイン「SignDK for Docusign」の歯車アイコンをクリックします。
❹ 「プラグインの設定を開く」をクリックします。
❺ 「Docusign環境設定」セクションの「環境」で「Production」を選択します。
❻ 「秘密鍵」に「7-2. 本番環境にて「アプリとキー」を設定する」で控えておいた秘密鍵を入力します。
❼ 「保存」ボタンをクリックします。
❽ 「アプリの設定」に移動します。
❾ 「アプリの更新」ボタンをクリックします。
➓ 内容を確認して「アプリを更新」ボタンをクリックします。
「5. サンドボックス環境における動作確認」にて、kintone 上でDocusign のサンドボックス環境にログインしたままになっているので、本番環境へログインし直します。
❶ インストール対象のkintoneアプリを開き、何か適当なレコードを表示します。
❷ 「ログアウト」をクリックします。
❸ 「Docusignログイン」をクリックし、サンドボックス環境のアカウントでログインします。
❸ ログイン後、「Allow Access」をクリックします。
最後に、「5. サンドボックス環境における動作確認」と同様に、kintone と Docusign の本番環境とが問題なく連携できているか、動作を確認します。
以上で、SignDK の初期設定は完了です。
| 必須 | フィールド名 | フィールドの種類 | フィールドコード |
|---|---|---|---|
| フィールド名 | フィールドの種類 | フィールドコード |
|---|---|---|
◯
エンベロープへのリンク
リッチエディター
SignDK_EnvelopeLink
◯
ファイル名
文字列（複数行）
SignDK_AttachmentName
件名
文字列（1行）
SignDK_Subject
宛名
文字列（複数行）
SignDK_Recipients
ステータス
文字列（1行）
SignDK_Status
作成日時
日時
SignDK_CreatedDate
◯
最終更新日時
日時
SignDK_LastModifiedDateTime
件名
文字列（1行）
SignDK_Subject
宛名
文字列（複数行）
SignDK_Recipients
ステータス
文字列（1行）
SignDK_Status
作成日時
日時
SignDK_CreatedDate
