メッセージ開始・受信中間イベント(HTTP)

機能概要

機能一覧

項目説明

操作メニュー説明

表示		操作メニュー	説明
基本		[閉じる]ボタン	メッセージ開始・受信中間イベント(HTTP)のプロパティダイアログを閉じます。
詳細		[マニュアル表示]ボタン	このマニュアルページを表示します。
		[URL・パラメータ詳細]ボタン	外部システムまたはDataSpider BPMの他のプロセスから、このイベントを実行する際のURLおよびパラメータの詳細情報を表示します。 URLおよびパラメータは、リリース完了時に確定されます。よって、「(開発中)」バージョンでは、このボタンは無効となります。       リリースバージョンを選択した後、プロパティダイアログを開くことで有効となります。

メッセージ開始・受信中間イベント(HTTP)の処理仕様

URL・パラメータとデータ受信基本仕様

URL・パラメータ

外部システムまたはDataSpider BPMの他のプロセスから実行する際のURL・パラメータは、以下の手順により確認することができます。
システム管理権限を持つ管理者の場合は、[システム設定]-[プロセスモデル外部連携]メニューでも確認することができます。

1. メッセージ開始イベント(HTTP)またはメッセージ受信中間イベント(HTTP)を保持しているプロセスモデルをリリースします。
   プロセスモデルがリリースされていない状態では、URL・パラメータを確定することができません。
2. [バージョン一覧]から、「(開発中)」バージョンではなく、リリースしているバージョンの[詳細]ボタンを押下します。
3. [バージョン<バージョン番号>の詳細]に表示されるプロセス図から、メッセージ開始イベント(HTTP)およびメッセージ受信中間イベント(HTTP)のプロパティダイアログを表示します。
4. [URL・パラメータ詳細]ボタンを押下します。
5. メッセージ開始イベント(HTTP)またはメッセージ受信中間イベント(HTTP)の詳細画面が別のタブページで表示されます。
   URL・パラメータ詳細の表示例(下図はメッセージ開始イベント)
   


6. 表示される[URL]および[受信パラメータ]の値を確認します。
   
   • [URL]: このイベントを実行する際のリクエストURLを表示します。
     • メッセージ開始イベント(HTTP): <コンテキストパス>/System/Event/MessageStart/start
     • メッセージ受信中間イベント(HTTP): <コンテキストパス>/System/Event/IntermediateMessage/receive
   
   
   • [受信パラメータ]: このイベントを実行する際に受け取りたいパラメータの情報を表示します。
     

     受信パラメータ名	受け取りたい値を保持するパラメータ名を表示します。 以下のパラメータは、プロセスモデル共通のパラメータです。 processModelInfoId: プロセスモデルID(数値) ※メッセージ開始イベント(HTTP)のみ processInstanceId: プロセスID(数値) ※メッセージ受信中間イベント(HTTP)のみ nodeNumber: ノード番号(数値) key: セキュリティ鍵(文字) ※設定した場合のみ title: 件名(文字)
     詳細	受信パラメータの名称と値のデータ型を表示します。 data～で始まるパラメータ名の場合は、定義しているプロセスデータ項目名となります。
     必須	このイベントを実行する際に必要なパラメータには、「○」が表示されます。
     受信する値について	パラメータの補足説明を表示します。
     固定値	必須項目での指定すべき固定値を表示します。

     各パラメータの説明や指定方法の詳細については、こちらを参照してください。

データ受信基本仕様

• プロトコル: HTTP または HTTPS
• メソッド: POST または GET  ※POSTを推奨しています。
• 文字コード: UTF-8
• エンコード: multipart/form-data または application/x-www-form-urlencoded
  ファイル型のプロセスデータ受信時は、POST/multipart が必須となります。

受信可能なデータ(パラメータ)と指定方法

プロセスを特定するためのデータ

パラメータ名	指定例(外部システムから)	説明
processModelInfoId	?processModelInfoId=420	プロセスモデルID プロセスモデルを新規作成した際に付けられるシーケンス番号です。 メッセージ開始イベント(HTTP)で使用するパラメータです。 プロセスモデルのバージョンを更新してもこの値は変更されません。       ただし、テスト環境から本番環境への移行作業などで、別環境でアーカイブからの新規作成を行った際には、この値は変更されます。
processInstanceId	?processInstanceId=12345	プロセスID プロセスを開始した際に付けられるインスタンス管理番号です。 メッセージ受信中間イベント(HTTP)で使用するパラメータです。 プロセスIDは、プロセスを開始した際に付けられる番号であるため、作成時およびリリース時には確定されません。
nodeNumber	&nodeNumber=2	メッセージ開始・受信中間イベント(HTTP)ID リリースした際に、メッセージ開始・受信中間イベント(HTTP)それぞれに付けられるシーケンス番号です。 プロセスモデルのバージョンを更新してもこの値は変更されません。
key	&key=NOYU3xDtySJqDhYGf02gj5X2sF1Scoaj	セキュリティ鍵 外部システムから実行を行う際に必要なセキュリティ鍵の値です。 設定ファイル(qbpms.config)の「qbpms.api.keyRequied」が「true」の場合にのみ指定します。       設定ファイル(qbpms.config)に関する詳細は、「設定ファイル(qbpms.config)」を参照してください。 この値が漏えいしないよう注意してください。「プロセスID」や「メッセージ開始・受信中間イベント(HTTP)ID」も共に検知された場合は、外部からの不正アクセスの原因となります。

プロセスデータ

データ型	パラメータ名の書式	指定例(外部システムから)	説明
件名	title	&title=test	各プロセスモデルで共通に用意されている[件名]を指定します。 [件名]のパラメータ名は、「title」固定となります。 UTF-8の文字コードでURLエンコードしてください。
文字型	data[XX].input	&data[0].input=foo	文字列を指定します。 UTF-8の文字コードでURLエンコードしてください。
数値型	data[XX].input	&data[1].input=12.3	数値を指定します。 接頭文字や接尾文字の指定は必要ありません。 小数点の表記などはプロセスデータ項目の設定に依存します。
選択型	data[XX].selects	単一選択の場合: &data[2].selects=true 複数選択の場合: &data[2].selects=1&data[2].selects=2	「表示ラベル」ではなく、「選択肢ID」を指定します。 サブタイプが[チェックボックス]の場合で複数の選択肢を指定したい場合は、その数だけパラメータと値を送信するようにしてください。 サブタイプが[チェックボックス]の場合で何も選択しない場合は、パラメータを送信しないようにしてください。
日付型	data[XX].input	年月日の場合: &data[3].input=2012-03-12 年月の場合: &data[3].input=2012-03 年の場合: &data[3].input=2012 月日の場合: &data[3].input=03-12	プロセスモデルの設定に応じて、以下の形式で指定します。 年月日: yyyy-MM-dd 年月: yyyy-MM 年: yyyy 月日: MM-dd
日時型	data[XX].datetime または data[XX].input data[XX].time	datetimeを使用する場合: &data[4].datetime=2011-10-27 12:34 datetimeを使用しない場合: &data[4].input=2011-10-27&data[4].time=13:57	以下の形式で指定します。 datetimeを使用する場合: yyyy-MM-dd hh:mm datetimeを使用しない場合: input: yyyy-MM-dd time: hh:mm
ファイル型	data[XX].upload	(※1)	添付ファイル名を指定します。 ファイル送信時は POST/multipartで送信してください。 添付ファイルがない場合は、パラメータを送信しないようにしてください。
ユーザ型	data[XX].email	&data[6].email=sample@example.com	「ユーザID」または「ユーザ名」ではなく、「メールアドレス」を指定します。
組織型	data[XX].qgroupName	&data[7].qgroupName=Sales	組織名を指定します。 UTF-8の文字コードでURLエンコードしてください。
掲示板型	data[XX].console	&data[8].console=testcomment	文字列(追記したい1コメントのみ)を指定します。 UTF-8の文字コードでURLエンコードしてください。
テーブル型	data[XX].input	(※2)	テーブル型を表すXMLを指定します。 入力文字列・数値データ・選択肢IDが格納されたXMLを指定してください。 テーブル型として定義されている設定項目とXMLの項目が一致している必要があります。 テーブルのレコード値をすべてクリアする場合は、<list></list>という内容のXMLを指定してください。

上記の「XX」部分はプロセスデータ定義番号と呼ばれ、プロセスモデル作成時にプロセスデータ項目を定義した順番に依存します。
       プロセスデータ定義番号に関する詳細は、

※1 メッセージ開始イベント(HTTP): ファイル型の指定例(外部システムから)

※1 メッセージ受信中間イベント(HTTP): ファイル型の指定例(外部システムから)

※2 共通: テーブル型の指定例(外部システムから)

• XMLに記述される数値データは以下の形式でなければなりません。
  • 接頭文字・接尾文字: なし
  • 桁区切り文字: なし
• <list>...</list>: テーブル
• <row>...</row>: 行
  • 各行について、<col>...</col>の数が等しくなければなりません。
• <col>...</col>: 列
• <summary>...</summary>: レコード集計
  • 集約値の表示を設定していない列には、<summary>要素内に<col />または<col></col>が記述される必要があります。

イベント実行時の応答メッセージ

レスポンスコード

処理失敗(エラー)の通知先

注意事項

• 設定ファイル(qbpms.config)にて、指定間隔に指定数を超える数のプロセスを実行することはできません。
  • qbpms.quota.interval: プロセス数をカウントする間隔(分)を指定します。
  • qbpms.quota.limit: 「qbpms.quota.interval」で設定した間隔内で、開始できるプロセス数を制限します。
• デフォルトでは、1分間に10000プロセスを超えるプロセスは起動(開始)できません。
• 外部システムからプロセス開始を行う場合に、プロセス実行数を制限するためのものとなっております。