Questetra BPM Suite API資料

1 Copyright © Questetra,Inc. All right Reserved.

Questetra BPM Suite における API 利用

～次世代ワークフローシステム～～次世代ワークフローシステム～

Questetra BPM Suiteにおける

API利用

株式会社クエステトラ

Ver.2014051501

API の種類


・プロセスモデル接続API データ受信でプロセス開始プロセスの途中でデータ送受信

・ソフト開発API

－ワークフローAPIs カスタマイズUIからプロセス実行プロセス実行結果や入力データの検索・取得

－システム設定APIs 外部の認証基盤との連携外部のマスタデータとの連携 ※詳細はこちら http://www.questetra.com/ja/tour/m4/

プロセスモデル接続API

ワークフローAPIs

システム設定APIs

http://www.questetra.com/ja/tour/m4/



Ｊ

HTTP Email

自動起動

【データ受信プロセススタート】

メッセージ開始イベント

外部システムからHTTP・メールでデータを受信し、そのデータを入力した状態でプロセスを自動起動する。

【プロセス実行中にデータ送信】

HTTP Email

【プロセス実行中にデータ待ち受け】

HTTP

外部システム

外部システム

外部システム

基幹システムで異常値を検知した場合、異常内容を格納した状態でシステム異常対応プロセスが自動的に起動する。

連携事例メッセージ送信中間イベント

プロセス実行中に、入力されたデータを外部システムにHTTP・メールで送信する。

受注プロセスで受注承認されると、受注データが販売管理システムに送信される。

連携事例

メッセージ受信中間イベント

プロセス実行中に外部システムからデータが入力されるのを待ち受ける。通信はHTTPで行う。

サービス申込プロセスで、受付処理後に、本人確認に関する情報の入力を待ち受ける。

連携事例

他システムとの連携パターン（１）


プロセスモデル接続API プロセスモデル接続API


HTTP

【ユーザ組織情報の参照更新】

ユーザ・組織設定API

ユーザ・組織のデータの追加／変更／削除する。通信はHTTPで行う。

【実行画面のラッピング】

HTTP

外部システム

外部システム

認証サーバにあるユーザ情報を定期的に反映する。

連携事例

タスク確認・実行API

プロセス開始、タスク一覧取得、タスク実行等を行うことで独自の処理画面を作成する。通信はHTTPで行う。

専用のタブレット向け画面を作成して、プロセス実行する。イントラネットでタスク一覧を表示させる。

連携事例

他システムとの連携パターン（２）




【プロセス実行データ取得】

HTTP

外部システム

モニタリングAPI

プロセス実行データをJSON形式で取得する。通信はHTTPで行う。

プロセス実行結果をBIツールで分析する。

連携事例


HTTP

【外部DBマスタデータ取り込み】

外部システム

選択肢HTTP取得機能

プロセスモデル設計において、XML形式の選択肢データをHTTPで取得する。

問い合わせ対応プロセスで使用する「サービス」の選択肢に、毎月バッチ生成される「サービス」マスタデータを取り込む。

連携事例



プロセスモデル接続API 一覧

分類 API種類名実現可能動作

受信メッセージ開始イベント（HTTP）

外部システムからのデータをHTTPリ

クエスト・メールを受信してプロセスが開始・進行します。

メッセージ開始イベント（メール）

メッセージ受信中間イベント（HTTP）

送信メッセージ送信中間イベント（HTTP）

外部システムからのデータをHTTPリ

クエスト・メールを送信してプロセスが進行します。メッセージ送信中間イベン

ト（メール）

※API利用にあたって認証は必要ありません ※メッセージ開始イベント（メール）はSaaS Editionのみ利用可能です


A B C

D

AP

I

API

AP

I

各種ID管理システム

アダプタープログラム

アカウント開設申請フォーム


ウェブフォームからの申請開始

アカウントの自動発行やデータ更新

申請者へ処理結果通知

アカウント開設申請プロセス


マスタからマスタデータ取込

API

プロセスモデル接続API 利用システム例１


Copyright © Questetra, Inc. All Rights Reserved. 7

※SaaS Editionのみ

A B C

D

Questetra BPM Suite SaaS Edition

各種業務フロー

各種申請・作業依頼

システムアラート・受注情報・請求情報

Webサイト各種受付・問い合わせ

メール受信をトリガにもれなく業務を実行

＜社内利用外部サービス＞

等々契約書作成依頼・

見積依頼

他システムとの連携にも利用可能

プロセスモデル接続API 利用システム例２


プロセスモデル接続API を用いたモデル例

チェックNG時は

申請者に再申請するようメール

申請者に結果をメール


システム管理者

ログイン後の申請画面

対象システムごとにスイムレーンは分割人手でメールを確認して進める

依頼受付時にメール

DBにステータス書き込み

実際にはあともういくつかスイムレーンが必要

HTTP

プロセスid受領

HTTP

スクリプトタスクも利用した外部連携例


＜見積承認プロセス＞＜ERP や SFA 等のシステム＞

顧客情報

見積情報

管理情報

<<HTTPレスポンス(JSON形式等)>>

・管理No.

・過去アクセス情報

・システム閲覧用 URL

外部システムとの連携実装がスムーズに行えます！

管理情報 1. を解析し、しかるべきプロセス

データ項目へセット

2. 次タスク「3.提出結果入力」タスクにて

セットされたを利用管理情報


ワークフローAPIs 一覧(１)


プロセス開始API

開始可能プロセスモデル一覧外部システム端末(スマホ・社内ポータル等)において業務プロセスの開始(申請開始)が可能となります。

新規プロセスの開始

タスク確認API マイタスク一覧外部システム端末(スマホ・社内ポータル等)において業務管理、実行が可能となります。

オファータスク一覧

オファータスク引受

プロセス詳細情報取得

タスク実行API タスク実行画面フォーム情報取得

マイタスク実行

※API利用にあたって認証が必要です



ワークフローAPIs 一覧(２)


モニタリングAPI

タスク実績の検索外部システムから蓄積された入力データを取り出す・制御することが可能となります。

プロセス実績の検索

プロセス詳細情報取得

プロセスにひもづくファイル型データ取得

タスクのスター追加／削除

タスクの強制割当

プロセスの強制終了

プロセスの削除

※API利用にあたって認証が必要です



ワークフローAPIs 利用例(イメージ１) ＜スマートフォン利用例(iPhone)＞＜社内ポータルサイト等で表示＞

Questetra BPM Suite タスク実行画面へ

任意の場所に＊割り振られているタスク＊オファーされているタスク＊締切情報が表示されます。

iPhone アプリケー

ションのプログラムコードを公開

社内認証システムを利用可能し認証情報の引継ぎ可能



ワークフローAPIs 利用例(イメージ２)

BIツールにデータを取り込んでクロス分析

A B C

D

Questetra BPM Suite

API

指定された条件のデータだけを抽出

BIツール


システム設定APIs 一覧(１)


認証ユーザ認証導入企業内で利用されているユーザ管理システム、認証システムとの連携が可能となります。

ユーザ設定API ユーザ情報追加・変更・削除

ユーザ情報検索・一覧

組織設定API 組織情報追加・変更・削除

組織情報検索・一覧

メンバーシップ設定API

ユーザの組織所属情報の追加・変更・削除・一覧

ユーザの組織所属情報の一覧

※API利用にあたって認証が必要です ※ロールに関するAPIは準備中です



システム設定APIs 一覧(２)


マスタ取込選択肢のHTTP経由取得外部システムからのマスタデータをHTTP経由で取得して選択肢に利用します。

システム管理API

キャッシュされている選択肢情報の取得

キャッシュされている選択肢情報のクリア

※API利用にあたって認証は必要ありません


システム設定APIs を用いた認証システム実現例(イメージ)


Sign in

ID

Password

＜企業内認証システム(フロント)＞

認証システム

A B C

D

Questetra BPM Suite

＜企業内認証システム(基幹)＞

（1）ID/Password

による認証

（2）認証結果・必要な情報送信 • 認証結果

• メールアドレス

• 名前

• 所属グループ

• 所属グループメールアドレス

API−1

ユーザ存在確認

API−2

ユーザ情報追加

API−3

ユーザ情報更新

第1 STEP

（4）ユーザ存在確認 ※メールアドレスをキー

第2 STEP

（5）ユーザ情報追加 ※ユーザが存在しない場合

第3 STEP

（6）ユーザ情報変更 ※ユーザが存在する場合

API−4

ユーザ認証

第4 STEP

（7）認証＊メールアドレス

* ワンタイムパスワード

第0 STEP A

PI−

0

＜認証確認画面＞

Start!

（3）API 利用認証


NO API名称詳細動作送信・返信情報

０ API利用認証 OAuthもしくはBasic認証のいずれかの方式で行います。

(認証方式詳細を参照)

１ユーザ存在確認メールアドレスをキーに(Q)に該当ユーザが存在するかを確認し存在情報を返します。

(送信) メールアドレス (返信) 存在情報

２ユーザ情報追加指定されたユーザ情報を追加します。 (送信) メールアドレスユーザ名所属組織

３ユーザ情報更新メールアドレスをキーに(Q)に存在するユーザ情報を指定内容で変更します。

(送信) メールアドレスユーザ名所属組織

４ユーザ認証メールドレス・パスワードを元に認証処理 (ログイン処理)を行ないます。

(送信) メールアドレスパスワード(*2)

前提情報・技術情報

• API へのアクセスは http/https でのアクセスとなります。

• レスポンス情報は JSON(*1) フォーマットにて返されます。

• 組織(グループ)情報は事前投入して頂く必要があります。

(*1)Java Script Object Notation

(*2)ワンタイムパスワードを想定しています。

システム設定APIs を用いた認証システム実現例(一覧)

<items> <item value=“1” display=“情報システム課" /> <item value=“2” display=“システム基盤課" /> ： </items>

18 Copyright © Questetra, Inc. All Rights Reserved.

別システム

アダプタプログラム

HTTP経由で静的な選択マスタ（xmlファイル形式）を取得

システム設定APIsを用いた外部マスタ取得の利用例

Business

Questetra BPM Suite API資料