Workflow Sample

Workflow Sample
Workflow Sample

Contact

外部連携APIのパラメータ

1. データタイプごとの送受信パラメータ


1-1. 送信パラメータ一覧: メッセージ送信中間イベント(HTTP)

  • 「送信パラメータ名」を設定したデータのみ、送信対象となります。
  • パラメータ名はメッセージ送信中間イベント(HTTP)のプロパティ設定画面にて、プロセスデータ項目ごとに設定した値になります。
  • 選択型とユーザ型では複数の種類のデータを送ることが可能ですが、パラメータ名を設定した種類のデータのみが送信されます。
  • Questetra BPM Suite からはHTTP POSTメソッド、enctype=multipart/form-data で送信されます。

データタイプ

送信される値について

件名
  • そのプロセスの「件名」
プロセスID
  • そのプロセスの「プロセスID」
文字
  • 保存されている文字列
数値
  • 保存されている数値
  • 接頭文字・接尾文字は送信されません。
  • 小数点・桁区切り文字の表現は、プロセスデータ項目定義の際のプロセスモデルの設定に依存します。設定の詳細については、[数値]型の説明を参照してください。
選択
  • 選択されている「選択肢の値」または「選択肢名」
  • 「選択肢の値」「選択肢名」のそれぞれに、送信パラメータ名を設定可能です。
  • 送信パラメータ名を設定しなかったものについては、送信対象になりません。「選択肢名」のみに送信パラメータ名を設定した場合は、選択肢名のみが送信されます。
  • サブタイプが[チェックボックス]の場合、複数の項目が選択されているとき、選択されている数だけ、パラメータが送信されます。
    • 例 : 2項目が選択されていて、「選択肢の値」にパラメータ名として "value" を設定した場合、2つのパラメータが送信されます。
      • value : 1項目目の選択肢の値
      • value : 2項目目の選択肢の値
  • 何も選択されていない場合、パラメータは送信されません。
日付
  • サブタイプの設定に応じて、以下のフォーマットで送信されます。
    • 年月日(yyyy-MM-dd)
    • 年月(yyyy-MM)
    • 年(yyyy)
    • 月日(MM-dd)
日時
  • 以下のフォーマットで送信されます。
    • 年月日時分(yyyy-MM-dd hh:mm)
ファイル
  • 添付されたファイル
  • 複数ファイルが添付されている場合、添付されているファイルの数だけ、パラメータと値が送信されます。
  • ファイルが添付されていない場合、パラメータは送信されません。
ユーザ
  • 選択されているユーザの「ユーザID」・「メールアドレス」・「名前」
  • 「ユーザID」「メールアドレス」「名前」のそれぞれに、送信パラメータ名を設定可能です。
  • 送信パラメータ名を設定しなかったものについては、パラメータは送信されません。「メールアドレス」のみに送信パラメータ名を設定した場合は、メールアドレスのみが送信されます。
  • ユーザIDは将来のバージョンで削除される予定なので、送信パラメータとして使用している場合には変更をお願いします。
掲示板
  • 掲示板内に入力されている全ての文字列(コメント日時・ユーザ名を含む)
HTMLパネル
  •  このデータタイプはメッセージ送信中間イベントの対象外です。
テーブル


1-2. 受信パラメータ一覧: メッセージ開始イベント・メッセージ受信中間イベント

  • これらのパラメータを利用するためには、対象のメッセージ開始イベント・メッセージ受信中間イベントにおけるプロセスデータ項目の読み書き設定が、[読み書き]となっている必要があります。
  • [読み書き]と設定したデータ項目については、パラメータと値を必ず、メッセージ開始イベント・メッセージ受信中間イベントに渡すようにしてください。
    • ただし、[選択]型(チェックボックスのみ)・[ファイル]型については、その例外となる場合があります。
  • [掲示板]型をのぞき、指定された値で上書きします。
  • 値に文字列を指定する場合は、UTF-8の文字コードで表現された文字列をURLエンコードするようにしてください。
  • プロセスデータ定義番号とは、プロセスモデルのプロセスデータ項目を特定するためのユニークな番号で、バージョンアップに伴って変更されることはありません。その詳細については、Modeler-04 : プロセスデータ項目を参照してください。

データタイプ

パラメータ名

指定する値について

件名 title
  • 文字列を指定してください。
  • UTF-8の文字コードで表現された文字列をURLエンコードするようにしてください。
プロセスID processInstanceId
  • そのプロセスのプロセスIDを指定してください。
  • メッセージ受信中間イベントでは必須のパラメータです。
文字 data[<プロセスデータ定義番号>].input
  • 文字列を指定してください(複数行も可)。
  • UTF-8の文字コードで表現された文字列をURLエンコードするようにしてください。
数値 data[<プロセスデータ定義番号>].input
  • 数値を指定してください。
  • 接頭文字・接尾文字は含まないようにしてください。
  • 小数点・桁区切り文字の表現は、プロセスモデルの設定に従うようにしてください。詳細は、[数値]型の説明を参照してください。
選択 data[<プロセスデータ定義番号>].selects

(data[<プロセスデータ定義番号>].input)
  • 「選択肢の値」を指定してください。
  • サブタイプが[チェックボックス]の場合、複数の選択肢を指定したいときは、その数だけパラメータと値を送信するようにしてください。
  • サブタイプが[チェックボックス]の場合、何も選択しないときは、パラメータを送信しないようにしてください。
  • 以前のバージョンからの移行の関係で、「data[<プロセスデータ定義番号>].input」をパラメータとして使用することも可能です。ただしこちらは1つしか選択肢を指定することができません。新しく設定する場合は、利用しないようにして下さい。
日付

data[<プロセスデータ定義番号>].input

  • サブタイプの設定に応じて、以下の形式で指定してください。
    • 年月日(yyyy-MM-dd)
    • 年月(yyyy-MM)
    • 年(yyyy)
    • 月日(MM-dd)
日時 data[<プロセスデータ定義番号>].datetime (8.1.0以降)

または

data[<プロセスデータ定義番号>].input
data[<プロセスデータ定義番号>].time
  • datetimeパラメータを使用する場合、以下の形式で指定してください。
    • yyyy-MM-dd hh:mm
  • datetimeパラメータを使用しない場合、2つのパラメータそれぞれに関して、以下の形式で指定してください。
    • input: 年月日(yyyy-MM-dd)
    • time: 時刻(hh:mm)
ファイル data[<プロセスデータ定義番号>].upload
  • 添付ファイル名を指定してください。
  • ファイル型を含む場合は、HTTP POST メソッド、enctype = multipart/form-data で通信するようにしてください。
  • 添付ファイルがない場合は、パラメータを送信しないようにしてください。
ユーザ data[<プロセスデータ定義番号>].email
  • ユーザのメールアドレスを指定してください。
掲示板 data[<プロセスデータ定義番号>].console
  • 文字列(追記したい1コメントのみ)を指定してください。
  • UTF-8の文字コードで表現された文字列をURLエンコードするようにしてください。
HTMLパネル なし
  •  このデータタイプはメッセージ開始イベント・メッセージ受信中間イベントの対象外です。
テーブル data[<プロセスデータ定義番号>].input
  • 入力文字列・数値データ・選択肢の値が格納されたXMLを指定してください。
  • テーブル型として定義されている設定項目とXMLの項目が一致している必要があります。
  • XMLのフォーマットは、2. テーブル型のデータフォーマットのサンプルを参照してください。
  • テーブルのレコード値をすべて空にする場合は、<list></list> という内容のXMLを指定してください。
 

2. テーブル型のデータフォーマットのサンプル



<list>
  <row>
    <col>Apple</col><col>2.5</col><col>3</col><col>7.50</col>
  </row>
  <row>
    <col>Orange</col><col>1.3</col><col>2</col><col>2.60</col>
  </row>
  <summary>
    <col /><col /><col /><col>10.10</col>
  </summary>
</list>
  • テーブル型のプロセスデータについて、
    • タスク実行画面で入力されたもの(左上)
    • パラメータで送受信されるXMLのフォーマット(左下)
  • XMLに記述される数値データは以下の形式でなければなりません。
    • 接頭文字・接尾文字: なし
    • 小数点: ピリオド
    • 桁区切り文字: なし
  • <list>...</list> : テーブル
  • <row>...</row> : 行
    • 各行について、<col>...</col>の数が等しくなければなりません。
  • <col>...</col> : 列
  • <summary>...</summary> : レコード集計
    • 集約値の表示を設定していない列には、<summary>要素内に<col />または<col></col>が記述される必要があります。