ドキュメントへの署名

ロボット ワークフローの「PDF」ステップには、署名付きドキュメントを作成する SignDoc が統合されています。

必要条件
  • SignDoc 標準 2.2.1.2 または SignDoc API v7 をサポートする他のバージョン。

  • SignDoc ユーザー アカウントおよび対応する API キー。

ワークフロー

SignDoc を使用するロボット ワークフローは、次のようになります。

  1. PDF ドキュメントを開く (「PDF」ステップ)。

  2. SignDoc 署名セッション ([SignDoc で署名] または [SignDoc で署名 (テンプレート)] アプリケーション アクション) を開始します。

  3. ドキュメントの処理:

    • PDF ドキュメントを参照して、署名フィールドを追加します ([SignDoc 署名フィールドを挿入] アクション)。

    • SignDoc ([SignDoc 署名者の割り当て] および [フィールドを更新する] コンポーネント アクション) で処理するために PDF ドキュメントのフィールドを操作します。

  4. 制御を SignDoc に転送します ([SignDoc リクエストを完了] アプリケーション アクション)。

ロボットは開いている PDF ドキュメントごとに SignDoc セッションを 1 つ開くことができます。複数の PDF ドキュメントが署名のために開かれている場合は、複数の SignDoc セッションが終了することがあります。

アクション

SignDoc で署名

このステップは、SignDoc セッションを作成し、PDF ドキュメントをすぐに送信します。このステップの前にロボットによって PDF ファイルが変更された場合、ドキュメントは保存されます。それ以外の場合、元のドキュメントは SignDoc に送信されます。

プロパティ

説明

SignDoc サーバーの URL

SignDoc サーバーの URL (プロトコル + ホスト + ポート)

API キー

サーバーにアクセスするための API キー。API キーに関連付けられているユーザー アカウントが署名パッケージの所有者になります。

SignDoc パッケージ ID (オプション)

このパッケージに割り当てられた SignDoc のパッケージ ID。省略した場合、SignDoc によって一意の ID が割り当てられます。

名前

署名者/レビュー担当者に表示される SignDoc パッケージの名前。

説明

署名者/レビュー担当者に表示される SignDoc パッケージの説明。

件名

署名者/レビュー担当者に送信される通知メールに使用される件名。

メッセージ

署名者/レビュー担当者に送信される通知メールに使用される本文。

ドキュメントの説明

ドキュメントの説明。これは、SignDoc の署名者/レビュー担当者に表示されます。

ドキュメント ファイル名

ドキュメントの名前。これは、署名者/レビュー担当者がドキュメントをダウンロードするときに表示されます。

レビュー担当者 (オプション)

レビュー担当者のリスト。詳細については、テーブル 1 を参照してください。

署名順序を適用

ドキュメントを順番に処理する必要があることを示します。このオプションが選択されていない場合は、すべての署名者とレビュー担当者が同時に処理を実行できます。詳細については、順序 を参照してください。

ドキュメントを閉じるときにパッケージを保持

ロボットが PDF ドキュメントを (手動、またはエラーによって) 閉じた場合、あるいは終了した場合に、署名パッケージを SignDoc サーバーに残しておく必要があることを示します。このオプションが選択されていない場合は、ロボットの終了時にパッケージが削除されます。

有効期限 (日数) (オプション)

署名パッケージの有効期限 (日数)。

フォーム フィールドをロック

PDF ドキュメントの既存のすべてのフィールドに読み取り専用のマークを付ける必要があることを示します。これは、SignDoc 内の署名セッション中のドキュメントにのみ影響します。「フィールドの更新」アクションを使用して、フィールドごとに読み取り専用属性を変更することができます。

存在する場合にオーバーライド

セッションの開始時に既存のパッケージを破棄する必要があることを示します。この設定は、[SignDoc パッケージ ID] オプションを使用している場合のみ有効です。

テーブル 1. レビュー担当者

プロパティ

説明

名前 レビュー担当者の名前。
電子メール レビュー担当者の電子メール アドレス。
表示言語 (オプション) SignDoc がレビュー担当者と通信するために使用する構成済み言語をオーバーライドします。サポートされている BCP 47 言語コードの中の 1 つを指定してください。詳細については、表示言語 を参照してください。
電子署名への同意が必要 レビュー担当者が電子署名への同意ページに同意する必要があることを示します。
GDPR への同意が必要 レビュー担当者が GDPR への同意ページに同意する必要があることを示します。
順序 レビュー担当者の相対的な順序。詳細については、順序 を参照してください。

SignDoc で署名 (テンプレート)

SignDoc テンプレートに基づいて SignDoc セッションを作成し、すぐに PDF ドキュメントを送信します。このステップの前にロボットによって PDF ファイルが変更された場合、ドキュメントは保存されます。それ以外の場合、元のドキュメントは SignDoc に送信されます。

プロパティ

説明

SignDoc サーバーの URL

SignDoc サーバーの URL (プロトコル + ホスト + ポート)

API キー

サーバーにアクセスするための API キー。API キーに関連付けられているユーザー アカウントが署名パッケージの所有者になります。

SignDoc パッケージ ID (オプション)

このパッケージに割り当てられた SignDoc のパッケージ ID。省略した場合、SignDoc によって一意の ID が割り当てられます。

テンプレート

パッケージのベースとなる SignDoc テンプレートの名前または ID。

名前 (オプション)

署名者/レビュー担当者に表示される SignDoc パッケージの名前。

説明 (オプション)

署名者/レビュー担当者に表示される SignDoc パッケージの説明。

件名 (オプション)

署名者/レビュー担当者に送信される通知メールに使用される件名。

メッセージ (オプション)

署名者/レビュー担当者に送信される通知メールに使用される本文。

ドキュメントの説明

ドキュメントの説明。これは、SignDoc の署名者/レビュー担当者に表示されます。

ドキュメント ファイル名

ドキュメントの名前。これは、署名者/レビュー担当者がドキュメントをダウンロードするときに表示されます。

レビュー担当者 (オプション)

レビュー担当者のリスト。詳細については、テーブル 1 を参照してください。

署名順序を適用

ドキュメントを順番に処理する必要があることを示します。このオプションが選択されていない場合は、すべての署名者とレビュー担当者が同時に処理を実行できます。詳細については、順序 を参照してください。

ドキュメントを閉じるときにパッケージを保持

ロボットが PDF ドキュメントを (手動、またはエラーによって) 閉じた場合、あるいは終了した場合に、署名パッケージを SignDoc サーバーに残しておく必要があることを示します。このオプションが選択されていない場合は、ロボットの終了時にパッケージが削除されます。

有効期限 (日数) (オプション)

署名パッケージの有効期限 (日数)。

フォーム フィールドをロック

PDF ドキュメントの既存のすべてのフィールドに読み取り専用のマークを付ける必要があることを示します。これは、SignDoc 内の署名セッション中のドキュメントにのみ影響します。「フィールドの更新」アクションを使用して、フィールドごとに読み取り専用属性を変更することができます。

存在する場合にオーバーライド

セッションの開始時に既存のパッケージを破棄する必要があることを示します。この設定は、[SignDoc パッケージ ID] オプションを使用している場合のみ有効です。

オプション パラメータの [名前]、[説明]、[件名]、および [メッセージ] を使用して、テンプレートの設定を上書きできます。

ロボットは、テンプレートから作成されたパッケージに PDF ドキュメントを挿入します。以前に SignDoc ステップで作成されたドキュメントに基づくテンプレートを使用している場合、ロボットはそのテンプレートから作成されたドキュメントを置き換えます。この場合、ドキュメントのプロパティはすべて保持されます。

SignDoc 署名フィールドを挿入 (アプリケーション アクション)

PDF ドキュメントの現在のページに署名フィールドを挿入します。これらのフィールドはページには表示されませんが、アプリケーション ツリーには SignDoc フィールドとして表示されます。

プロパティ

説明

名前

署名フィールドの名前。

説明

署名フィールドの説明。この値は、署名者がフィールドに署名するときにツールチップとして表示されます。

ラベル (オプション)

署名フィールドのラベル。SignDoc のクライアント インターフェイスには説明が表示され、管理インターフェイスには ID が使用されます。この値は PDF ビューアに表示されます。

署名者の名前

署名者の名前。

署名者の電子メール

署名者の電子メール アドレス。

表示言語 (オプション)

SignDoc が署名者と通信するために使用する設定済みの言語を上書きします。サポートされている BCP 47 言語コードの中の 1 つを指定してください。詳細については、表示言語 を参照してください。

電子署名への同意が必要

署名者が電子署名への同意ページに同意する必要があることを示します。

GDPR への同意が必要

署名者が GDPR への同意ページに同意する必要があることを示します。

クライアント証明書が必要

署名者がクライアント証明書を提供する必要があることを示します。

署名者の順序

署名者の相対的な順序。詳細については、順序 を参照してください。

許可された署名モード (オプション)

フィールドで許可される署名モードを制限します。どの署名モードも選択されていない場合、SignDoc は設定済みのデフォルト署名モードを使用します。

ユニット

署名用のボックスを作成するための X、Y、幅、および高さの単位を指定します。詳細については、寸法 を参照してください。

X

Y

署名フィールドの左上隅の位置を設定します。

高さ

署名フィールドの寸法を設定します。

署名が必要

署名が必要であることを示します。

SignDoc ID (オプション)

署名フィールドの ID。省略した場合、SignDoc によって一意の ID が割り当てられます。

補足ドキュメント

署名者に補足ドキュメントを提供するよう求めます。詳細については、テーブル 2を参照してください。

署名者が複数回追加された場合は、最初の出現箇所以降の [表示言語]、[電子署名への同意が必要]、[GDPR への同意が必要]、および [署名者の順序] フィールドは無視されます。

補足ドキュメントに、同じ署名者、同じドキュメント タイプに対するリクエストが複数含まれている場合 (テーブル 2)、これらのリクエストは SignDoc パッケージ内で結合されます。いずれかの出現箇所が必須に設定されている場合、このリクエストは必須に設定されます。ファイルの最大数は、すべての出現箇所の最大数に設定されます。

テーブル 2. 補足ドキュメント

プロパティ

説明

ドキュメント タイプ

リクエストされたドキュメントのタイプ。

必須

署名者がドキュメントをアップロードする必要があることを示します。

名前 (オプション)

SignDoc に示されているドキュメント タイプの名前。その他のタイプ (SignDoc では汎用) を除くすべてのドキュメント タイプで、このパラメータは無視されます。

説明 (オプション)

リクエストの説明 (手順を含む)。その他のタイプ (SignDoc では汎用) を除くすべてのドキュメント タイプで、このパラメータは無視されます。

ファイルの最大数 (オプション)

アップロード可能なドキュメントの最大数。その他のタイプ (SignDoc では汎用) を除くすべてのドキュメント タイプで、このパラメータは無視されます。

使用可能なドキュメント タイプのリストは、SignDoc サーバーから取得されます。Design Studio でローカライズされているのは、SignDoc の事前定義されたドキュメント タイプの名前のみです。

SignDoc 署名フィールドを挿入 (コンポーネント アクション)

このアクションにより、コンポーネント ファインダーに基づいて署名フィールドを挿入します。これらのフィールドはページには表示されませんが、アプリケーション ツリーには SignDoc フィールドとして表示されます。

署名フィールドは、コンポーネント ファインダーによって配置された領域に表示されますが、位置はパラメータで調整できます。

プロパティ

説明

名前

署名フィールドの名前。

説明

署名フィールドの説明。この値は、署名者がフィールドに署名するときにツールチップとして表示されます。

ラベル (オプション)

署名フィールドのラベル。このフィールドが設定されていない場合、SignDoc のクライアント インターフェイスには説明が表示され、管理インターフェイスには ID が使用されます。この値は PDF ビューアに表示されます。

署名者の名前

署名者の名前。

署名者の電子メール

署名者の電子メール アドレス。

表示言語 (オプション)

SignDoc が署名者と通信するために使用する設定済みの言語を上書きします。サポートされている BCP 47 言語コードの中の 1 つを指定する必要があります。詳細については、表示言語 を参照してください。

電子署名への同意が必要

署名者が電子署名への同意ページに同意する必要があることを示します。

GDPR への同意が必要

署名者が GDPR への同意ページに同意する必要があることを示します。

クライアント証明書が必要

署名者がクライアント証明書を提供する必要があることを示します。

署名者の順序

署名者の相対的な順序。詳細については、順序 を参照してください。

許可された署名モード (オプション)

フィールドで許可される署名モードを制限します。どの署名モードも選択されていない場合、SignDoc は設定済みのデフォルト署名モードを使用します。

水平オフセット (オプション)

コンポーネントを基準にして、署名フィールドを左または右にシフトするスペースの量。

垂直オフセット (オプション)

コンポーネントを基準にして、署名フィールドを上下にシフトするスペースの量。

目的の幅 (オプション)

署名フィールドの幅を上書きします。この値が指定されていない場合、フィールドの幅はコンポーネントの幅になります。

目的の高さ (オプション)

署名フィールドの高さを設定します。この値が指定されていない場合、フィールドの高さはコンポーネントの高さになります。

最小の幅 (オプション)

署名フィールドの最小幅を指定します。フィールドの幅がこれよりも小さい場合、フィールドは右に拡張されます。[目的の幅] が設定されている場合、このパラメータは無視されます。

最小の高さ (オプション)

署名フィールドの最小の高さを指定します。フィールドの高さがこれよりも小さい場合、フィールドは下に拡張されます。[目的の高さ] が設定されている場合、このパラメータは無視されます。

署名が必要

署名が必要であることを示します。

SignDoc ID (オプション)

署名フィールドの ID。省略した場合、SignDoc によって一意の ID が割り当てられます。

補足ドキュメント

署名者に補足ドキュメントを提供するよう求めます。詳細については、テーブル 2を参照してください。

署名者が複数回追加された場合は、最初の出現箇所以降の [表示言語]、[電子署名への同意が必要]、[GDPR への同意が必要]、および [署名者の順序] フィールドは無視されます。

すべての調整は、ツリー座標で指定する必要があります。PDF ドライバーは、ツリー座標の基礎として 144 DPI 解像度を使用します。

補足ドキュメントに、同じ署名者、同じドキュメント タイプに対するリクエストが複数含まれている場合 (テーブル 2)、これらのリクエストは SignDoc パッケージ内で結合されます。いずれかの出現箇所が必須に設定されている場合、このリクエストは必須に設定されます。ファイルの最大数は、すべての出現箇所の最大数に設定されます。

SignDoc 署名者の割り当て (コンポーネント アクション)

PDF ファイルに既存の署名フィールドに署名者を割り当てます。これらのフィールドはページには表示されませんが、アプリケーション ツリーには SignDoc フィールドとして表示されます。

このステップは、SignDoc フィールドと FormBox フィールドで使用できます。このステップにより、SignDoc で署名者が作成され、設定されます。既存の署名者を割り当てるには、「フィールドの更新」アクションを使用します。

プロパティ

説明

署名者の名前

署名者の名前。

署名者の電子メール

署名者の電子メール アドレス。

表示言語 (オプション)

SignDoc が署名者と通信するために使用する設定済み言語を上書きします。サポートされている BCP 47 言語コードの中の 1 つを指定する必要があります。詳細については、表示言語 を参照してください。

電子署名への同意が必要

署名者が電子署名への同意ページに同意する必要があることを示します。

GDPR への同意が必要

署名者が GDPR への同意ページに同意する必要があることを示します。

クライアント証明書が必要

署名者がクライアント証明書を提供する必要があることを示します。

署名者の順序

署名者の相対的な順序。詳細については、順序 を参照してください。

許可された署名モード (オプション)

フィールドで許可される署名モードを制限します。どの署名モードも選択されていない場合、SignDoc は設定済みのデフォルト署名モードを使用します。

署名が必要

署名が必要であることを示します。

補足ドキュメント

署名者に補足ドキュメントを提供するよう求めます。詳細については、テーブル 2を参照してください。

署名者が複数回追加された場合は、最初の出現箇所以降の [表示言語]、[電子署名への同意が必要]、[GDPR への同意が必要]、および [署名者の順序] フィールドは無視されます。

補足ドキュメントに、同じ署名者、同じドキュメント タイプに対するリクエストが複数含まれている場合 (テーブル 2)、これらのリクエストは SignDoc パッケージ内で結合されます。いずれかの出現箇所が必須に設定されている場合、このリクエストは必須に設定されます。ファイルの最大数は、すべての出現箇所の最大数に設定されます。

コンポーネントが SignatureText タイプの SignDoc フィールドである場合、このフィールドは更新されます。それ以外の場合、ステップはページ上で、まったく同じ寸法を持つ、このようなフィールドを見つけようとします。このフィールドが見つからない場合、ステップは失敗します。

使用可能なドキュメント タイプのリストは、SignDoc サーバーから取得されます。Design Studio でローカライズされているのは、SignDoc の事前定義されたドキュメント タイプの名前のみです。

フィールドを更新する (コンポーネント アクション)

このステップは、サポート対象であると SignDoc で識別された PDF ドキュメント内のフォーム フィールドの属性を更新します。サポートされているフィールドは、アプリケーション ツリーの SignDoc ノードの下に表示されます。

プロパティ

説明

必須 (オプション)

必須属性を変更します。

読み取り専用 (オプション)

読み取り専用属性を変更します。

チェック済み (オプション)

チェック ボックスの状態を設定します。他のタイプのフィールドでは無視されます。

説明 (オプション)

フィールドの説明を変更します。この値は、署名者がフィールドを操作するときにツールチップとして表示されます。

ラベル (オプション)

フィールドのラベルを変更します。この値は PDF ビューアに表示されます。

値 (オプション)

テキスト フィールドの値を設定します。他のタイプのフィールドでは無視されます。

割り当て先 (オプション)

電子メール アドレスまたは名前で識別される署名者にフィールドを割り当てます。署名者は、セッション内ですでに認識されている必要があります。既存の割り当てを削除するには、特別な値「Any」を使用します。

フィールドの変更は SignDoc 署名セッション中に行われます。変更は PDF ドキュメント自体には適用されず、アプリケーション ツリーの外部には表示されません。
SignDoc リクエストを完了

「SignDoc リクエストを完了」ステップは SignDoc セッションを閉じて、SignDoc パッケージの処理方法を判別します。

プロパティ

説明

リクエストを閉じる

セッションは閉じますが、SignDoc サーバーにはドラフト モードのパッケージが残ります。このオプションは、[SignDoc で署名] ステップと [SignDoc で署名 (テンプレート)] ステップの [ドキュメントを閉じるときにパッケージを保持] オプションを上書きします。

スケジュール リクエスト

セッションを閉じて署名手順を開始するように、SignDoc パッケージにスケジュールを設定します。

リクエストのキャンセル

セッションを閉じて、SignDoc サーバーから SignDoc パッケージを削除します。これ以上のアクションは実行されません。

SignDoc プロパティを取得

このステップは、SignDoc セッションのプロパティを照会します。

プロパティ

説明

プロパティ

プロパティの名前

デフォルト値 (オプション)

失敗時に返される値。この値が指定されておらず、プロパティを取得できない場合、エラーが生成されます。

結果の変数

サポートされているプロパティ
  • [セッション中]: PDF ドキュメントにアクティブな SignDoc セッションがすでに存在する場合は、「Y」を返します。それ以外の場合は「N」を返します。

  • [パッケージ ID]: SignDoc のパッケージ ID を返します。

  • [パッケージの URL]: REST API コールで使用する SignDoc パッケージの URL を返します。

    パッケージ URL には、SignDoc で構成されたホスト名が含まれています。このホスト名は、ロボットが接続に使用するホスト名と一致しない場合があります。

アクティブな SignDoc セッションがない場合は、[セッション中] を除くすべてのプロパティがエラーを返します。

表示言語

次に、SignDoc が [表示言語] フィールドに受け入れる値を示します。

BCP 47 コード

言語

de

ドイツ語

en

英語

es

スペイン語

fr

フランス語

it

イタリア語

nl

オランダ語

pt-BR

ポルトガル語 (ブラジル)

ja

Japanese

このリストは今後の SignDoc バージョンで拡張される可能性があります。

順序

[SignDoc で署名] で [署名順序を適用] オプションが選択されている場合、または [SignDoc で署名 (テンプレート)] ステップで指定されたテンプレートが順次署名するように設定されている場合、レビュー担当者と署名者が PDF ドキュメントに署名するよう順次招待されます。それぞれの参加者は、前の参加者が処理したドキュメントを受け取ります。署名者とレビュー担当者が処理される順序は、[順序] フィールドに基づきます。つまり、順序値が最も低い署名者またはレビュー担当者が最初に処理されます。複数のユーザーの順序値が同じである場合は、ロボットがパッケージに追加した順序で処理されます。テンプレート内のレビュー担当者と署名者は、ロボットによって追加されたレビュー担当者と署名者の前に処理されます。

[署名順序を適用] オプションが選択されていない場合、レビュー担当者と署名者は同時に招待されます。これらのすべての参加者に PDF ドキュメントが元の状態で送信されます。

寸法

署名フィールドの場所と寸法は、ロボットが指定します。計算には以下の単位を使用できます。

  • [ツリー座標]: アプリケーション ツリーで使用され、Design Studio に表示される座標。

  • [インチ] または [センチメートル]: PDF ドキュメントの物理的な寸法。

  • [ページ サイズ (%)]: PDF ドキュメントの寸法を基準とする相対的なサイズ。

値は、ページの左上隅を基準にして計算されます。フィールドに負の値が含まれている場合は、ページに適した寸法を基準にして計算されます。[幅] または [高さ] が 0 に設定されている場合は、代わりにページの寸法が使用されます。

次の例では、ロボットは左上隅から下および右に 1 インチの位置にある、3.5 インチ x 2 インチの領域を選択します。



次の例では、ロボットはすべての辺の 10% マージンを除いた、ページ全体を選択します。