Questetra BPM Suite の外からプロセスを開始する（curl編）

• Questetra BPM Suite の外からプロセスを開始する（準備編）
• Questetra BPM Suite の外からプロセスを開始する（curl編）
• Questetra BPM Suite の外からプロセスを開始する（Python編）
• Questetra BPM Suite の外からプロセスを開始する（エラー対処編）

curl コマンドを用いてプロセスを開始する

データ転送を行えるコマンドである curl を用いて、Questetra BPM Suite にアクセスしてプロセスを開始しましょう。curl コマンドは Mac や Linux ではターミナル上でインストール不要で使用できます。Windows でも Windows10 以降では標準で curl がインストールされています。本記事は Windows のコマンドプロンプトで curl コマンドを用いる前提で進めます。

まずは curl コマンドを実行して特定の URL にアクセスすることで、プロセスを開始してみましょう。作成したアプリに設置した［メッセージ開始イベント (HTTP)］のエンドポイント URL などが必要になるので、「メッセージ開始イベント (HTTP) 詳細」を開いておいてください。

［メッセージ開始イベント (HTTP)］へのリクエストは POST メソッドで送信する必要があります。-X オプションを使ってリクエストメソッドをPOSTに指定します。

今回はプロセスを開始すると同時に、データ項目「件名」に入力する内容も送信することにします。エンドポイント URL の末尾にパラメータを付与し、アプリに送信したいデータを渡すことができます。例えば件名を「test」にするならば、次のようになります。

curl -X POST "https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start?key={API キー}&title=test"

エンドポイント URL と API キーは置き換えてください。「メッセージ開始イベント (HTTP) 詳細」の受信パラメータ一覧に記載されているので、そこからコピー＆ペーストしてください。受信パラメータ名も受信パラメータ一覧に列挙されています。エンドポイント URL の末尾に ? を付け、その後ろに name=content の形式でデータを付与します。

コマンドを実行すると、プロンプト画面に開始したプロセスの ID が返されます。あなたのアカウント（処理担当者）で Questetra BPM Suite にログインすれば、開始されたプロセスの「確認」タスクが届いているはずです。このとき、件名がパラメータに渡したものになっているかどうか確認してください。

さまざまなデータを送信する

では、件名以外のデータを送るにはどうすればいいでしょうか？　データ項目には文字やユーザなど多くの種類が用意されていますが、それらのほとんどは件名と同じように送信できます。アプリのデータ項目を追加して確かめてみましょう。

アプリの設定

以下のようにデータ項目を追加してください。必須のチェックはいずれも不要です。データ編集許可は件名と同じように、メッセージ開始イベント (HTTP) に対して「編集可」、「確認」タスクに対しては「表示のみ」に設定してください。

ファイル以外を curl で送信する

では、追加したデータ項目も curl で送信してみましょう。ファイル型だけはやや方法が異なるので、別項で取り上げます。

先ほどのコマンドでは ? と name=content の形式でデータを付与しましたが、今回は –data-urlencode オプションを使用します。API キーや title=test も含めて、1つずつ –data-urlencode オプションを使って追加します。

なお、 –data-urlencode オプションを指定した場合は自動的に POST メソッドでの送信となるので、 -X POST は省略できます。

複数のデータ項目に送信するときは、次のように書けます。

curl https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start ^
--data-urlencode "key={API キー}" ^
--data-urlencode "name1=content1" ^
--data-urlencode  "name2=content2" ^
 ...

例えば次のようなコマンドで、件名 (title) に「test」、数値 (q_float) に「1.23」を入力した状態でプロセスを開始できます。

curl https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start ^
--data-urlencode "key={API キー}" ^
--data-urlencode "title=test" ^
--data-urlencode "q_float=1.23"

各データ型に対する具体的な記入例などは以下の表を参考にしてください。

ファイルを送信する

上にもある通り、ファイル型のデータ項目にデータを送信しない場合は、–data-urlencode オプションでの POST 送信がおすすめです。しかし application/x-www-form-urlencoded 形式でデータを送信する –data-urlencode オプションではファイルを取り扱えません。そのため、ファイル型のデータ項目を扱う時は、 multipart/form-data 形式でデータ送信を行う -F オプションを使用する必要があります。また、–data-urlencode オプションと -F オプションを同時に使用することはできません。

curl https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start ^
-F "key={API キー}" ^
-F "{ファイル型項目のパラメータ}=@{ファイルのパス}" ^
-F "name1=content1" ^
 ...

例えば次のように書くと、件名 (title) を「test」とした上で、ques-kun.png をアップロードしてプロセスを開始できます。

curl https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start ^
-F "key={API キー}" ^
-F "title=test" ^
-F "q_file=@ques-kun.png"

これまでの内容をまとめると、次のようなコマンドも書けます。

curl https://example.questetra.net/System/Event/MessageStart/{processModelInfoId}/{nodeNumber}/start ^
-F "key={API キー}" ^
-F "title=テスト" ^
-F "q_str=プロセス開始テストです" ^
-F "q_float=1.23" ^
-F "q_selects=false" ^
-F "q_date=2018-04-01" ^
-F "q_datetime=2018-04-01 12:34" ^
-F "q_file=@ques-kun-01.png" ^
-F "q_file=@ques-kun-02.png" ^
-F "q_email=questetra+Canarias@gmail.com" ^
-F "q_group=10 管理部"

ファイル型／ユーザ型データに渡す値については

• ques-kun-01.png / ques-kun-02.png は適当なファイル名に
• questetra+Canarias@gmail.com はあなたのアカウントのメールアドレスなど、ご利用のシステム内にあるアカウントのメールアドレスに

それぞれ置き換えて、実行してください。このコマンドを実行すると、次のようにプロセスが開始されます。

このように、プロセスを開始するのに curl コマンドを利用することができます。シェルスクリプトや cron などを用いれば自動化の幅も拡がります。ぜひ様々に工夫して、メッセージ開始イベント (HTTP) を活用してください。次回は Python から HTTP リクエストを送る場合のコード例を紹介します。

次: Questetra BPM Suite の外からプロセスを開始する（Python編）