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

機能概要

機能一覧

項目説明

項目名		必須	説明
工程名		任意	イベントの名称を入力します。
メモ		任意	イベントの注意点や目的などに関するメモを入力します。
編集の可否	データ項目	-	データ項目の一覧を表示します。
	編集の可否	必須	このイベントでのデータ項目のデータ編集許可を設定することができます。 データ項目ごとに、データを受信できるかについて設定します。 データ編集許可の種類と動作は以下の3通りです。 [編集可]: データを受信することができます。 [表示なし]: データを受信しません。 ガイドパネル型は「表示なし」を対応しています。
API キー	API キー	任意	アクセスURLの一部であるAPIキーを入力します。 セキュリティを考慮した値を入力してください。 APIキーの値を自動生成することができます。 半角英数字のみで構成し、100文字以下にしてください。

操作メニュー説明

表示	操作メニュー	説明
	[ヘルプ]アイコン	このマニュアルページを表示します。
	[URL, 受信パラメータ]ボタン	このイベントを呼び出す際の処理仕様を表示します。 「(開発中)」バージョンでは、このボタンは無効となります。       アプリをリリース後にリリースバージョンを選択し、プロパティ設定ダイアログを開くことで有効となります。
	[キーを自動生成]アイコン	[API キー]の値を自動生成します。
	[適用して閉じる]ボタン	設定した値を適用して、プロパティ設定ダイアログを閉じます。
	[適用する]ボタン	設定した値を適用します。
	[キャンセル]ボタン	設定した値を適用せずに、プロパティ設定ダイアログを閉じます。

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

処理仕様の確認とデータ受信基本仕様

処理仕様の確認

このイベントを呼び出す際の処理仕様は、以下の手順により確認することができます。
システム管理権限を持つユーザの場合は、[システム設定]-[アプリ外部連携]メニューでも確認することができます。

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


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

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

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

データ受信基本仕様

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

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

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

パラメータ名	指定例(外部システムから)	説明
processInstanceId	?processInstanceId=12345	プロセスID プロセスを開始した際に付けられるインスタンス管理番号です。 プロセスインスタンスIDとも呼ばれます。 メッセージ受信中間イベント(HTTP)で使用するパラメータです。 プロセスIDは、プロセスを開始した際に付けられる番号であるため、作成時およびリリース時には確定されません。
key	&key=NOYU3xDtySJqDhYGf02gj5X2	API キー 外部システムから実行を行う際に必要なAPI キーの値です。 この値が漏えいしないよう注意してください。「プロセスID」や「メッセージ開始・受信中間イベント(HTTP)ID」も共に検知された場合は、外部からの不正アクセスの原因となります。

データ項目

データ型	パラメータ名の書式	指定例(外部システムから)	説明
件名	title	&title=test	各アプリで共通に用意されている[件名]を指定します。 [件名]のパラメータ名は、「title」固定となります。 UTF-8の文字コードでURLエンコードしてください。
文字型	<フィールド名> または data[XX].input	&q_string=foo または &data[0].input=foo	文字列を指定します。 UTF-8の文字コードでURLエンコードしてください。
数値型	<フィールド名> または data[XX].usdecimal	&q_number=12.3 または &data[1].usdecimal=12.3	数値を指定します。 接頭文字や接尾文字の指定は必要ありません。 小数点は「ピリオド」、桁区切り文字は「なし」で指定します。
選択型	<フィールド名> または data[XX].selects	単一選択の場合: &data[2].selects=true 複数選択の場合: &q_selection=1&q_selection=2 または &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 または &q_date=2012-03-12	アプリの設定に応じて、以下の形式で指定します。 年月日: yyyy-MM-dd 年月: yyyy-MM 年: yyyy 月日: MM-dd
日時型	<フィールド名> または data[XX].datetime	フィールド名を使用する場合: &q_datetime=2011-10-27 12:34 datetimeを使用する場合: &data[4].datetime=2011-10-27 12:34	以下の形式で指定します。 フィールド名を使用する場合: yyyy-MM-dd hh:mm datetimeを使用する場合: yyyy-MM-dd hh:mm
ファイル型	<フィールド名> または data[XX].upload	(※1)	添付ファイル名を指定します。 ファイル送信時は POST/multipartで送信してください。 添付ファイルがない場合は、パラメータを送信しないようにしてください。 ファイル以外のデータを送信した場合は、値を反映しません。
ユーザ型	<フィールド名> または data[XX].email	&q_useremail=sample@example.com または &data[6].email=sample@example.com	「ユーザID」または「ユーザ名」ではなく、「メールアドレス」を指定します。
組織型	<フィールド名> または data[XX].qgroupName	&q_group_name=Sales または &data[7].qgroupName=Sales	組織名を指定します。 UTF-8の文字コードでURLエンコードしてください。
掲示板型	<フィールド名> または data[XX].console	&q_board=testcomment または &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分間に10,000プロセスを超えるプロセスは起動(開始)できません。
• 外部システムからプロセス開始を行う場合に、プロセス実行数を制限するためのものとなっております。