Zoho CreatorでDelugeを使って署名タスクを自動化する

Zoho CreatorでDelugeを使って署名タスクを自動化する

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Zoho Signでは、独自のオンラインスクリプト言語であるDelugeを活用し、署名タスクを自動化することが可能です。ユーザーは処理にロジックを追加し、署名タスクやワークフローを自動でトリガーできます。例えば、Zoho Creatorで開発した新規ユーザーのオンボーディングアプリケーションで、従業員がデータを入力し送信ボタンをクリックすると、NDAドキュメントが即座に送信され、署名依頼が行われます。また、Delugeをサポートする他のアプリケーション向けに、カスタム関数を作成して署名タスクをトリガーすることも可能です。

メモ:
  1. Zoho Sign Delugeタスクを利用した自動化によって作成された各ドキュメント署名リクエストごとに、Zoho Signのご契約プランに応じて、5件の無料Zoho SignクレジットまたはZoho Signクレジットが消費されます。無料クレジットは、ライセンスユーザー数に比例して、エンタープライズプランの組織に毎月付与されます。
  2. 組織の無料クレジットがなくなった場合、以降の該当ドキュメントごとにZoho Signクレジットが消費されます。追加クレジットは別途購入が必要です。

この内容は、カスタム関数、ワークフロー、その他すべてのDelugeを通じた自動化（現在Zoho Signがサポートする各種Zohoアプリ連携）に適用されます。

仕組みについて
  1. Deluge Script Builderはドラッグ＆ドロップによるユーザーインターフェイスを提供し、ユーザーがDelugeの構文や関数を参照したり覚えたりすることなく、Delugeスクリプトを追加できます。
  2. 要件に応じてアプリケーションを作成できます。例えば、採用管理アプリや在庫管理アプリなどを作成することが可能です。
  3. 採用管理アプリでは、NDAやソーシャルメディア規定、ITサービス規定などの署名タスクを自動化するロジックを利用できます。
  4. 各ロジックごとに署名タスクを割り当て、従業員に署名用ドキュメントを送信できます。
  5. Delugeが全体のプロセスを自動化し、より簡単にします。
  6. Zoho Sign用Delugeタスクの手順については、このセクションのヘルプドキュメントを参照してください。
Zoho Signでよく使われるDelugeタスク
  1. ドキュメントを署名用に送信する
  2. Zoho Sign テンプレートを使用してドキュメントを送信する
  3. 既に送信済みドキュメントのステータスを確認する
  4. 既に送信済みドキュメントに関連付けられたファイルをダウンロードする

ドキュメントを署名用に送信する

ドキュメントを署名用に送信するには、3つのステップがあります。ドキュメントのアップロード、項目タイプの取得、宛先の追加と、項目の宛先への関連付けです。

ドキュメントのアップロード:
  1. ドキュメントをアップロードします。ドキュメントはZoho Creatorのファイル項目として保存されているもの、またはダウンロード可能な第三者のURLから取得することができます。
  2. ファイルオブジェクトを取得した後、uploadDocumentタスクを使用します。
コード: 
  1. file = getUrl(<ファイルのパス> ); </ファイルのパス>
  2. res = Zoho.sign。uploadDocument(file);
  3. [または]
  4. res = Zoho.sign。uploadDocument(input。File_field);
レスポンスには、完了または失敗のいずれかのステータスを含むマップが返されます。完了の場合、作成されたドキュメントの詳細と、以降の処理に必要なrequest_idが返されます。さらに、項目を追加するドキュメントを指定するために必要なdocument_idも含まれています。

項目タイプの取得: 

Zoho Signでは、多くの項目をドキュメントに追加できます。各項目の種類には、ユーザーごとに固有の項目type_idが割り当てられています。ご自身のアカウント用に項目タイプとIDを取得してください。
  1. getFieldIdsタスクを使用して、項目タイプおよびIDを取得します。
  2. レスポンスには、項目タイプと対応する項目種類IDが含まれます。
  3. この情報は、別のマップに保持して、項目の追加や次の手順でドキュメントを出力する際に利用できます。
コード：
  1. fieldIds = Zoho.sign。getFieldIds();
  2. fieldTypes = fieldIds.取得する('field_types');
  3. 項目 = Map();
  4. for each 項目 in fieldTypes
  5. {
  6. fieldJson = 項目.toMap();
  7. 項目.put(fieldJson.取得する('field_type_name'), fieldJson.取得する('field_type_id'));
  8. }

受信者の追加：
最後の手順は、ドキュメントを送信する受信者およびその受信者向けの項目を指定することです。
  1. submitRequest タスクを使用して、この手順を実行します。
  2. 受信者や項目に関するデータは、マップ形式でこのタスクに渡す必要があります。
送信するデータの形式は以下の通りです：
処理 - 各受信者の詳細を含む配列
各受信者オブジェクトに含まれる内容：
action_id - 前回の呼び出しで保存されたaction_id
項目 - 受信者が署名者の場合に関連するすべての項目の詳細を含むJSONオブジェクト
text_fields - テキスト、会社、役職名、氏名、メールなど、すべてのテキスト項目を含む配列
image_fields - 署名など画像項目を含む配列
date_fields - すべての日付項目の詳細を含む配列

各項目に関連するデータ：
document_id
page_no - 項目が開始するページ 差出人 +10、-10
field_name - 項目に表示される名前
x_value - 項目のページ左下からのx位置
y_value - 項目のページ左下からのy位置
width - ページに対する幅（%）
height - ページに対する高さ（%）
field_type_id - 項目の種類を特定するfield_type_id
is_mandatory
name_format （フル名前項目のみ）- 名前の形式 - FULL 名前/FIRSTNAME/姓
date_format （日付項目のみ）- 日付入力時に使用する日付の形式
text_property （すべてのテキスト項目・日付項目）- 含まれるテキストプロパティ

フォント
font_size
font_color - テキストに適用する色のHexコード
is_bold
is_italic
is_read_only（種類が「Text」の項目のみ）- 項目が表示専用かどうか
default_value（種類が「Text」の項目のみ）- 項目の初期値

コード： 
  1. actionMap = Map();
  2. actionMap。put('request_name','test_AddFields');
  3. textFields = List();
  4. textField1 = Map();
  5. textField1。put('field_name', 'Company');
  6. textField1。put('is_mandatory', '真');
  7. textField1。put('field_type_id', 項目.取得する('Company'));
  8. textField1。put('document_id', doc_id);
  9. textFields.追加する(textField1);
  10. fieldMap = Map();
  11. fieldMap。put('項目',{'text_fields':textFields});
  12. fieldMap。put('recipient_name', 'John');
  13. fieldMap。put('recipient_email','john@zylker。com');
  14. fieldMap。put('action_type','SIGN');
  15. fieldList= List();
  16. fieldList.追加する(fieldMap);
  17. actionMap。put('処理',fieldList);
  18. submitMap = Map();
  19. submitMap。put('requests', actionMap);
  20. response = Zoho.sign。submitRequest(, {'data':submitMap});
レスポンスには、ステータスが完了となっているマップが含まれ、ドキュメントが正常に送信済みの場合に表示されます。エラーが発生した場合はステータスがfailureとなり、メッセージキーにエラーの詳細が示されます。

Zoho Sign テンプレートを使用してドキュメントを送信する

Zoho Sign テンプレートを利用すると、一度ドキュメントを作成し、項目を追加して、必要なときに何度でも再利用できます。テンプレートを使う際は、受信者の詳細情報や、設定済みのプリフィル項目のみ入力するだけで済みます。同じドキュメントをDeluge経由で送信する場合も特に便利です。ファイルのアップロードや項目設定を毎回行う必要はありません。
メモ:この機能はプロフェッショナル版およびエンタープライズ版でのみ利用可能です。
Delugeを使ってZoho Sign テンプレートを利用するには、3つの手順があります。
  1. Zoho Sign内のテンプレート一覧を取得する（任意）
  2. 必要なZoho Sign テンプレートの詳細を取得する
  3. Zoho Sign テンプレートを使ってドキュメントを送信する
Zoho Sign内のテンプレート一覧を取得する: 
このタスクは、アプリケーション内でテンプレート一覧を取得する必要がある場合に役立ちます。常に同じテンプレートでドキュメントを作成する場合は、この手順を省略できます。

getTemplatesタスクを使用して、Zoho Signアカウント内ですべて作成されたテンプレートの一覧を取得します。この操作により、テンプレートキーの下にすべてのZoho Sign テンプレートのリストを持つオブジェクトが返されます。各テンプレートにはtemplate_idが付与されており、以降の手順で必要となります。利用するテンプレートを選択したら、そのテンプレートのtemplate_idを保存してください。

コード: 
  1. response= Zoho.sign。getTemplates();
  2. {
  3. 'コード': +10、-10,
  4. 'メッセージ': 'テンプレートリストの取得に成功しました',
  5. 'page_context': {
  6. 'sort_column': 'template_name',
  7. 'has_more_rows': 無効,
  8. 'start_index': 1,
  9. 'total_count': 1,
  10. 'sort_order': 'ASC',
  11. 'row_count': 1
  12. },
  13. 'テンプレート': [
  14. '{\'owner_email\':\'john@zylker。com\',\'created_time\':1521109119330,\'email_reminders\':真,\'document_ids\':[{\'document_name\':\'Zoho Sign.pdf\',\'document_size\':59808,\'document_order\':\'+10、-10\',\'total_pages\':1,\'document_id\':\'32076000000002005\'}],\'メモ\':\'\',\'reminder_period\':1,\'owner_id\':\'32076000000002003\',\'説明\':\'\',\'template_name\':\'Template1\',\'modified_time\':1521110073225,\'is_deleted\':無効,\'expiration_days\':15,\'is_sequential\':無効,\'template_id\':\'32076000000002011\',\'request_type_name\':\'その他\',\'owner_first_name\':\'John\',\'request_type_id\':\'32076000000000135\',\'owner_last_name\':\'Mathews\',\'処理\':[{\'ishost\':無効,\'verify_recipient\':無効,\'役割\':\'CEO\',\'action_id\':\'32076000000002014\',\'action_type\':\'SIGN\',\'private_notes\':\'\',\'recipient_email\':\'john@zylker。com\',\'signing_order\':-1,\'recipient_name\':\'John Mathews\',\'recipient_phonenumber\':\'\',\'recipient_countrycode\':\'\'}]}'
  15. ],
  16. 'ステータス': '完了'
  17. }
テンプレートの詳細を取得:
  1. 使用したいテンプレートとそのtemplate_idが分かったら、該当テンプレートの詳細を取得します。詳細情報を取得することで、必須メールアドレスをテンプレート内の差し込み項目の役割に割り当てることができます。
  2. また、テンプレート内にある必須のPre-fill項目も入力しやすくなります。
  3. getTemplateByIdタスクを使用して、テンプレートIDから詳細を取得します。
  4. レスポンスにはテンプレートの詳細が含まれます。テンプレートに設定された受信者の詳細や、設定済みのPre-fill項目が含まれます。
テンプレートオブジェクトには操作リストがあります。このリストには、テンプレートに設定された受信者の数だけ要素が含まれます。

また、document_fieldsリストも存在します。テンプレート内の各ドキュメントはオブジェクトとして関連付けられています。それぞれのオブジェクトには、該当するPre-fill項目を含む項目リストがあります。

サンプルレスポンス：
  1. {
  2. 'コード': +10、-10,
  3. 'メッセージ': 'テンプレート一覧の取得に成功しました',
  4. 'page_context': {
  5. 'sort_column': 'template_name',
  6. 'has_more_rows': 無効,
  7. 'start_index': 1,
  8. 'total_count': 1,
  9. 'sort_order': 'ASC',
  10. 'row_count': 1
  11. },
  12. 'テンプレート': [
  13. '{\'owner_email\':\'john@zylker。com\',\'created_time\':1521109119330,\'email_reminders\':真,\'document_ids\':[{\'document_name\':\'Zoho Sign.pdf\',\'document_size\':59808,\'document_order\':\'+10、-10\',\'total_pages\':1,\'document_id\':\'32076000000002005\'}],\'メモ\':\'\',\'reminder_period\':1,\'owner_id\':\'32076000000002003\',\'説明\':\'\',\'template_name\':\'Template1\',\'modified_time\':1521110073225,\'is_deleted\':無効,\'expiration_days\':15,\'is_sequential\':無効,\'template_id\':\'32076000000002011\',\'request_type_name\':\'その他\',\'owner_first_name\':\'John\',\'request_type_id\':\'32076000000000135\',\'owner_last_name\':\'Mathews\',\'処理\':[{\'ishost\':無効,\'verify_recipient\':無効,\'役割\':\'CEO\',\'action_id\':\'32076000000002014\',\'action_type\':\'SIGN\',\'private_notes\':\'\',\'recipient_email\':\'john@zylker。com\',\'signing_order\':-1,\'recipient_name\':\'John Mathews\',\'recipient_phonenumber\':\'\',\'recipient_countrycode\':\'\'}]}'
  14. ],
  15. 'ステータス': '完了'
  16. }
  17. {

コード：
  1. template_id = ;
  2. response = Zoho.sign。getTemplateById(template_id);
  3. prefill_fields = List();
  4. if(response.取得する('ステータス')contains('完了'))
  5. {
  6. recipients = response.取得する('テンプレート').取得する('処理');
  7. document_fields = response.取得する('テンプレート').取得する('document_fields');
  8. for each ドキュメント in document_fields
  9. {
  10. prefill_fields。addall(ドキュメント.取得する('項目'));
  11. }
  12. }

Zoho Sign テンプレートを使用してドキュメントを送信する: 
これが最終手順です。ここでは、テンプレートを送信する宛先や、設定されたその他の事前入力項目を割り当てることができます。処理リストと項目リストが、この手順で役立ちます。createUsingTemplate タスクをこの手順で使用してください。ここでは、template_idとして必須テンプレートのIDも必要です。

このタスクに必要なパラメーターは以下の構造になります:

パラメーターは、キーが data で値が下記の値を含むマップに追加する必要があります。
  1. 処理: テンプレートに関連付けられているすべての役割の詳細を含むリストです。各操作マップには以下が含まれている必要があります：
  2. recipient_name- 受信者の名前
  3. recipient_email- 受信者のメールアドレス
  4. action_id- getTemplateByIdの前回結果の処理配列で返されるactions_idの値
  5. 役割- テンプレートで指定された役割名
  6. action_type- サイン/表示：その人物が署名者かコピー受領者か（テンプレートで指定）
  7. field_data- テンプレートに追加された事前入力項目のデータを含みます
  8. field_text_data- 事前入力で追加されたすべてのテキスト項目の項目名と値を含むマップ
  9. 項目-boolean_data- 事前入力で追加されたすべてのチェックボックス項目の項目名と真/無効の値を含むマップ
  10. is_quicksend- ブール値。真の場合、テンプレートが送信されます。偽の場合、ドキュメントは下書きとして保存され、Zoho SignのWebユーザーインターフェースから手動で送信する必要があります。
コード：
テンプレートに事前入力項目としてtextField_1が1つあり、受信者が2名追加されていると仮定します。
  1. actionMap = Map();
  2. fieldTextData = Map();
  3. fieldTextData。put('TextField_1', 'ドキュメント to 確認する');
  4. actionMap。put('field_data',{'field_text_data':fieldTextData});
  5. eachActionMap1 = Map();
  6. eachActionMap1。put('recipient_name','James');
  7. eachActionMap1。put('recipient_email','james@Zoho.com');
  8. eachActionMap1。put('action_type','SIGN');
  9. eachActionMap1。put('action_id','32076000000002014');
  10. eachActionMap1。put('役割','Reviewer');
  11. eachActionMap1。put('verify_recipient','無効');
  12. eachActionMap2 = Map();
  13. eachActionMap2。put('recipient_name','Tony');
  14. eachActionMap2。put('recipient_email','tony@Zoho.com');
  15. eachActionMap2。put('action_type','SIGN');
  16. eachActionMap2。put('action_id','32076000000014006');
  17. eachActionMap2。put('役割','Manager');
  18. eachActionMap2。put('verify_recipient','無効');
  19. fieldList = List();
  20. fieldList.追加する(eachActionMap1);
  21. fieldList.追加する(eachActionMap2);
  22. actionMap。put('処理',fieldList);
  23. submitMap = Map();
  24. submitMap。put('テンプレート',actionMap);
  25. パラメーター = Map();
  26. パラメーター.put('is_quicksend','真');
  27. パラメーター.put('data',submitMap);
  28. response = Zoho.sign。createUsingTemplate(32076000000002011, パラメーター);
レスポンスには、ドキュメントが正常に送信された場合、ステータスが完了となるmapが含まれます。エラーが発生した場合は、ステータスがfailureとなり、メッセージキーにエラーの詳細が表示されます。

ドキュメントステータスの取得

ヘッダーにOAuthアクセス トークンを付与し、取得する ドキュメントの詳細 APIを使用することで、ステータスを含むドキュメントの詳細情報を取得できます。
レスポンス形式:
  1. {
  2. 'コード': +10、-10,
  3. 'requests':
  4. {
  5. 'request_status': '進行中',
  6. 'メモ': 'Hi\nA メモ\nMr. Tester\nお元気ですか？',
  7. 'owner_id': '2000000002002',
  8. '説明': '',
  9. 'request_name': '移動する a メモ テスト',
  10. 'modified_time': 1522746018025,
  11. 'action_time': 1522746018310,
  12. 'is_deleted': 無効,
  13. 'expiration_days': 1,
  14. 'is_sequential': 真,
  15. 'sign_submitted_time': 1522746018310,
  16. 'owner_first_name': 'V********',
  17. 'sign_percentage': 33.34,
  18. 'expire_by': 1522866540000,
  19. 'is_expiring': 真,
  20. 'owner_email': 'v******@***.com',
  21. 'created_time': 1522746018025,
  22. 'document_ids': [
  23. {
  24. 'document_name': '従業員 NDA。pdf',
  25. 'document_size': 26591,
  26. 'document_order': '+10、-10',
  27. 'total_pages': 2,
  28. 'document_id': '2000000492171'
  29. }
  30. ],
  31. 'self_sign': 無効,
  32. 'in_process': 無効,
  33. 'request_type_name': 'その他',
  34. 'request_id': '2000000492177',
  35. 'request_type_id': '2000000000135',
  36. 'owner_last_name': '',
  37. '処理': [
  38. {
  39. 'verify_recipient': 無効,
  40. 'action_id': '2000000492180',
  41. 'action_type': '署名',
  42. 'private_notes': '',
  43. 'recipient_name': 'S**********',
  44. 'recipient_email': 's*******@***.com',
  45. 'signing_order': +10、-10,
  46. 'allow_signing': 真,
  47. 'action_status': '未開封',
  48. 'recipient_phonenumber': '',
  49. 'recipient_countrycode': ''
  50. }
  51. ]
  52. },
  53. 'メッセージ': 'ドキュメントが取得されました',
  54. 'ステータス': '完了'
  55. }
コード：
  1. resp = invokeurl
  2. [
  3. url :'https://sign.Zoho.com/api/v1/requests/[Requestid]'
  4. 種類 :取得する
  5. ヘッダー:ヘッダー
  6. ];
  7. if(resp.取得する('ステータス').contains('完了'))
  8. {
  9. docStatus = resp.取得する('requests').取得する('request_status');
  10. }

送信済みドキュメントに関連付けられたファイルのダウンロード

ドキュメントが署名され、完了すると、署名済みドキュメントをダウンロードしてアプリケーションやCRMデータ、その他の場所に保存できます。downloadDocument deluge タスクがこの操作をサポートします。タスクを利用するにはドキュメントのrequest_idが必要です。複数のドキュメントがある場合は、すべてのドキュメントを含むZIPファイルが受け取れます。

コード：
  1. if(docStatus。contains('完了'))
  2. {
  3. response = Zoho.sign。downloadDocument(request_id);
  4. //ドキュメントをZoho CreatorのFileUpload項目にアップロードします
  5. insert into 文書[input。FileUpload = response]
  6. }

    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts






                          Latest Feature Updates



                                  • Related Articles

                                  • Zoho SignとZoho Booksの統合

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 US、EU、AU、JP、CAデータセンターで利用可能 Zoho SignがZoho Booksとの連携に対応しました。この連携により、組織内のユーザーはZoho ...

                                  • Zoho WorkDriveとZoho Signの統合

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho WorkDriveは、ファイルの同期、クラウドストレージ、およびコンテンツ共同作業プラットフォーム（CCP）です。チームのための安全な共有ワークスペースとして、また個人のための信頼性の高いクラウドストレージとして利用できます。Zoho SignとZoho ...

                                  • Zoho FlowとのZoho Sign統合

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho SignがZoho Flowで利用可能になりました。Zoho FlowはiPaaS型の統合プラットフォームであり、ワークフローによる業務の自動化ツールとしても機能し、ユーザーはプロセスを自動化するワークフローを作成できます。 Zoho SignとZoho ...

                                  • Zoho RecruitとZoho Signの統合

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho Recruitは、すべてを備えた応募者追跡システム（ATS）および人材派遣会社・採用担当者向けの採用管理ソフトウェアです。包括的なATSには、再開するパース、求人掲示板への自動投稿、カスタマイズ可能な企業キャリアページ、再開する保存、面接スケジューリングが含まれています。 ...

                                  • Zoho Billing向けのZoho Sign統合

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 提供範囲: 全ての有料プラン Zoho SignとZoho Billingの連携により、安全で法的に準拠した署名体験を提供し、請求プロセスを向上させ、法人ワークフローを効率化します。この連携により、組織ユーザーは請求書やクレジットノートを送信前にデジタル署名し、Zoho ...

                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.