「kintone アプリのカスタマイズ」で、やること「kintone Webhook を起動する」を使用すると、Job Runnerの「kintoneアプリのWebhook」のカスタマイズをkintoneの画面から呼び出すことができます。
この方法でJob Runnerの「kintoneアプリのWebhook」のカスタマイズを呼び出した場合、次のような特徴があります。
kintone の Webhook の通知を介さずに、直接 Job Runner の 「kintone アプリのWebhook」 のカスタマイズが呼び出される
⇒そのため、この方法でのみ呼び出す場合は kintone アプリの「アプリの設定 >Webhook」での設定は必要ありません。kintone の Webhook の通知は、1 レコード単位で発生するため Job Runner の 「kintone アプリの Webhook」 のカスタマイズでひとつのジョブで受け取る Webhook のレコードは 1 レコードだが、この方法で呼び出した場合は複数レコードを受け取る(渡す)ことができる
⇒画面で選択した複数のレコードをまとめて Job Runner の 「kintone アプリの Webhook」 のカスタマイズに渡し、処理することができます。
アプリ
注:この記事で用いるアプリは、カスタマインの歩き方 カスタマイズお試し用ファイルダウンロード の Job Runner 編にアプリテンプレートがありますので、そちらをご利用頂く事もできます。
はじめから自分でアプリを作成したい場合は、次のようにアプリを作成してください。
※本カスタマイズに影響のあるフィールドのみ記載しています
セミナー予約アプリ
※フィールド名とフィールドコードは同じものを指定します
カスタマイズ
下記のカスタマイズでは、一覧画面にチェックボックスを表示し、選択されたレコードを Job Runnerの「kintoneアプリのWebhook」のカスタマイズに渡しています。
やること「kintone Webhook を起動する」のパラメーターは、下記のように設定します。
kintone Webhook のカスタマイズ
Job Runner であらかじめ作成しておいた「kintoneアプリのWebhook」のカスタマイズを選択します。
gusuku API キー
操作の種類
レコードに対してどのような操作を行ったとみなして kintone アプリの Webhook のカスタマイズを呼び出すのかを指定します。
これは、kintone の Webhook の設定や Job Runner の 条件「Webhookの発生がレコードの追加によるならば」などの条件と対応していますので、詳しくは次のドキュメントをご確認ください。kintoneヘルプ
Webhookを設定する | kintone ヘルプ (cybozu.help)Customineドキュメントへようこそ > Job Runner > 「条件」一覧
「Webhook」(追加条件)
アプリ
どのアプリを Webhook の発生元とみなして 「kintone アプリの Webhook」 のカスタマイズを呼び出すのかを指定します。呼び出す 「kintone アプリのWebhook」 のカスタマイズでカスタマイズの作成時に選択した kintone アプリと同じアプリを指定する必要があります。
レコード
「kintone アプリの Webhook」 のカスタマイズに渡すレコードを指定します。例では、一覧で選択したレコードを指定しています。
同時実行
同じカスタマイズから作成したジョブの同時実行を許可するかどうかを指定します。
実際の動作画面
kintone アプリのカスタマイズを登録すると、このような画面になります。
「選択したレコードを一括で自動採番する」ボタンをクリックすると、チェックボックスで選択したレコードが 「kintone アプリの Webhook」 のカスタマイズに渡され、一括で自動採番されます。
なお、定期実行タスクと同様に、「kintoneアプリのWebhook」のカスタマイズのジョブの終了を kintone の画面から知るすべはありません。
従って、たとえばボタンを押すと やること「読み込み中画面を表示する」で読み込み中と表示し、定期実行タスクのジョブが終了したら やること「読み込み中画面を終了する」で読み込み中画面を消す、といったことはできません。
ジョブが終わったかどうかはジョブ実行履歴画面や定期実行タスクのカスタマイズの実行履歴から確認してください。
【参考】セミナー予約の Webhookカスタマイズ
画面のカスタマイズで呼び出しているWebhookカスタマイズの例は次のようになります。
また上述の画面のカスタマイズに加え、このWebhookカスタマイズを含めて試す場合は、kintoneアプリのAPIトークンに次のようにアクセス権(レコード閲覧、レコード編集)を設定してください。
おわりに
「kintone アプリのカスタマイズ」で、やること「kintone Webhook を起動する」を使用すると、Job Runnerの「kintoneアプリのWebhook」のカスタマイズをkintoneの画面から呼び出すことができる事を、ご確認いただけたかと思います。
レコードの更新は簡単にできる分、思いもよらない大量のレコードを、意図しない内容で更新したりすることもできてしまうものです。実際にカスタマイズを作成される際には、テストアプリとテストデータでよくテストを行った上で、実際のアプリ・運用に適用していくことをおすすめします。
ご不明な点がございましたら、チャットでお問い合わせください。
Customineドキュメントやサポートページも、ぜひご活用ください。