メッセージ開始イベント(Webhook)

機能概要

プロセスにおいて、システムが処理する自動工程を表します。
外部サービス側のWebhook通知の受信を起点とし、プロセスを自動的に開始します。

アプリ管理権限を持つユーザが対象です。

機能一覧

ワークフロー図 ワークフロー図の作成を行います。
スイムレーンや各ノードを配置し、フローを作成して、作業の順序を定義します。
ヒューマンタスク プロセスにおいて、処理担当者が作業する手動工程を表します。
プロセス実行時に、データを入力するフォーム(タスク処理画面)が表示されます。
サービスタスク
(データ設定)
プロセスにおいて、システムが処理する自動工程を表します。
数値型、日付型/日時型、文字型、選択型データ項目に、動的な値や演算結果を代入します。
サービスタスク
(PDF生成)
プロセスにおいて、システムが処理する自動工程を表します。
業務データ(各データ項目に保持されている値)を埋め込んだPDF帳票を生成します。
サービスタスク
(選択肢マスタ更新)
プロセスにおいて、システムが処理する自動工程を表します。
指定の選択型データ項目の内容を、アプリ共有アドオンの[選択型データ項目で使用する選択肢マスタ]として更新します。
スクリプトタスク プロセスにおいて、システムが処理する自動工程を表します。
ECMAスクリプトを使用して、業務データ(各データ項目に保持されている値)を編集します。
受信タスク
(フォーム)
プロセスにおいて、システムが処理する自動工程を表します。
アカウントを持たないユーザに対して、プロセスの途中での入力フォームを提供します。
メッセージ開始イベント(フォーム)を使用してユーザにWeb入力フォームを提供したあとに、メールによる本人確認を経て、詳細情報を入力するようなWeb入力フォームを表示します。
受信タスク
(Webhook)
プロセスにおいて、システムが処理する自動工程を表します。
外部サービス側のWebhook通知の受信まで待機し、受信後にトークンが進みます。
サービスタスク
(Add-on)
プロセスにおいて、システムが処理する自動工程を表します。
ユーザ独自定義のサービスタスクを処理します。
タイマー開始イベント プロセスにおいて、システムが処理する自動工程を表します。
設定した日時にプロセスを自動的に開始します。
タイマー中間イベント プロセスにおいて、システムが処理する自動工程を表します。
指定した日時まで待機し、指定日時を経過するとトークンが進みます。
メッセージ開始・
受信中間イベント(HTTP)
プロセスにおいて、システムが処理する自動工程を表します。
メッセージ開始イベント(HTTP): 外部システムまたはDataSpider BPMの他のプロセスから受け取ったメッセージをもとにプロセスを開始します。
メッセージ受信中間イベント(HTTP): プロセスの実行途中で、外部システムまたはDataSpider BPMの他のプロセスから受け取ったメッセージをもとにデータを入力できます。
メッセージ開始イベント
(フォーム)
プロセスにおいて、システムが処理する自動工程を表します。
Webページの入力フォームから受け取ったメッセージをもとにプロセスを開始します。
入力フォームは、データ項目のレイアウトをWebページに埋め込んで使用します。
メッセージ開始イベント
(Webhook)
プロセスにおいて、システムが処理する自動工程を表します。
外部サービス側のWebhook通知の受信を起点とし、プロセスを自動的に開始します。
メッセージ送信中間イベント
(HTTP)
プロセスにおいて、システムが処理する自動工程を表します。
指定したURLに、HTTPリクエストを送信します。
外部システムまたはDataSpider BPMの他のプロセスへのデータ送信が可能となります。
メッセージ送信中間イベント
(メール)
プロセスにおいて、システムが処理する自動工程を表します。
設定した内容でメールを送信します。
送信先は任意に設定できます。
メール本文に、データ項目の入力内容を埋め込むことができます。
メッセージ送信中間イベント
(DataSpider Servista)
プロセスにおいて、システムが処理する自動工程を表します。
指定したDataSpider Servistaのスクリプトを実行することができます。
イベントの実行時には、DataSpider BPM側のデータ項目の値を、DataSpider Servista側で定義されている入力変数へ渡すことができます。
スクリプト終了時には、DataSpider Servista側で定義されている出力変数の値を、DataSpider BPM側のデータ項目の値として受け取ることができます。
スクリプトの実行結果(結果の戻り値:ExitStatusおよびエラー内容)を受け取り、その後のタスクや条件分岐処理等で使用することができます。
分岐 ワークフロー図に分岐がある場合、分岐・遷移先の設定を行います。

項目説明

項目名 必須 説明
工程名 任意 イベントの名称を入力します。
メモ 任意 イベントの注意点や目的などに関するメモを入力します。
URL - このイベントを呼び出す際のアクセスURL(Webhook URL)を表示します。
API キー 必須 アクセスURL(Webhook URL)の一部であるAPIキーを入力します。
セキュリティを考慮した値を入力してください。

APIキーの値を自動生成することができます。
半角英数字のみで構成し、100文字以下にしてください。
受信する HTTP リクエストのメソッド 必須 受信するHTTPリクエストのメソッドを選択します。
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
受信する HTTP リクエストの Content-Type 必須 受信するHTTPリクエストのContent-Typeを選択または入力します。
  • application/json
  • text/xml
  • application/x-www-form-urlencoded
  • 任意に入力
HTTPリクエストのメソッドが、[POST]、[PUT]および[PATCH]の場合は入力必須となります。
リクエストボディ保存先のデータ項目 任意 受信するHTTPリクエストのリクエストボディに保持しているデータの保存先を選択します。
  • 保存しない
  • 文字型(複数行)のデータ項目
定義した文字型(複数行)のデータ項目がリスト表示されます。
HTTP レスポンスの Content-Type 必須 呼び出し元にレスポンスとして返すデータのContent-Typeを選択または入力します。
  • application/json;charset=UTF-8
  • text/xml;charset=UTF-8
  • 任意に入力
HTTP レスポンスの内容 任意 呼び出し元にレスポンスとして返すデータの内容を入力します。

各種プロセス情報を参照することができます。
各種プロセス情報を基準に、動的な値(EL式)による指定も行えます。
動的な値(EL式)に関する詳細は、「サービスタスク(データ設定)」-「動的な値(EL式)の例: 文字型(件名含む)」を参照してください。

操作メニュー説明

表示
(HTML5版)
表示
(Flash版)
操作メニュー 説明
- [ヘルプ]アイコン
このマニュアルページを表示します。
[適用して閉じる]ボタン
[閉じる]ボタン
設定した値を適用して、メッセージ開始イベント(Webhook)のプロパティ設定ダイアログを閉じます。
- [適用する]ボタン 設定した値を適用します。
- [キャンセル]ボタン 設定した値を適用せずに、メッセージ開始イベント(Webhook)のプロパティ設定ダイアログを閉じます。
[IP アドレス制限など、その他の情報]ボタン
[詳細]ボタン
このイベントを呼び出す際の処理仕様を表示します。
「(開発中)」バージョンでは、このボタンは無効となります。
      アプリをリリース後にリリースバージョンを選択し、プロパティ設定ダイアログを開くことで有効となります。
[クリップボードにコピー]アイコン
[クリップボードにコピー]ボタン
[URL]の値をクリップボードにコピーします。
[キーを自動生成]アイコン
[キーを自動生成]ボタン
[API キー]の値を自動生成します。
[参照を挿入する...]アイコン
[データの参照を挿入する...]リストボックス
[HTTP レスポンスの内容]に、プロセス情報の参照を挿入します。
  • [件名]: #{processInstanceTitle}
  • [プロセスID]: #{processInstanceId}
  • [プロセス開始ユーザ]: #{processInstanceInitQuserName}
  • [プロセス開始組織]: #{processInstanceInitQgroupName}
  • [プロセス開始日時]: #{processInstanceStartDatetime}
  • [プロセス連番]: #{processInstanceSequenceNumber}
  • [アプリID]: #{processModelInfoId}
  • [アプリ名]: #{processModelInfoName}
  • [<データ項目>]: #{#<データ項目の[フィールド名]>}

メッセージ開始イベント(Webhook)の処理仕様

処理仕様の確認

このイベントを呼び出す際の処理仕様は、以下の手順により確認することができます。
システム管理権限を持つユーザの場合は、[システム設定]-[アプリ外部連携]メニューでも確認することができます。
  1. メッセージ開始イベント(Webhook)を保持しているアプリをリリースします。
  2. [バージョン一覧]から、「(開発中)」バージョンではなく、リリースしているバージョンの[詳細]ボタンを押下します。
  3. [バージョン<バージョン番号>の詳細]に表示されるワークフロー図から、メッセージ開始イベント(Webhook)のプロパティ設定ダイアログを表示します。
  4. [IP アドレス制限など、その他の情報]ボタンを押下します。
  5. メッセージ開始イベント(Webhook)の詳細画面が別のタブページで表示されます。
    処理仕様の表示例

注意事項

DataSpider BPMでは、一度にプロセスを開始できる数に関して以下の設定および制限を設けています。
メッセージ開始イベント(Webhook)を使用して、Webhook通知の受信からプロセスを開始する際に影響します。 使用頻度および状況を考慮し、設定値を適宜変更してください。
設定ファイル(qbpms.config)に関する詳細は、
「設定ファイル(qbpms.config)」を参照してください。