通知ロボット
通知ロボットは、プロセスとアクティビティの情報を、Webhookで送信する際に利用するアクティビティです。
図 通知ロボットのフロー図例
通知ロボットのプロパティ画面
表 通知ロボットの項目
番号 | 項目名 | 説明 |
---|---|---|
① | アクティビティ名 | アクティビティの名前を入力します。必須項目です。 |
② | 種別 | 種別「通知ロボット」が表示されます。変更はできません。 |
③ | キー | アクティビティキーを入力します。アクティビティキーは業務プロセス定義内で一意である必要があります。 ※現在は利用していない項目です。 |
④ | 説明 | アクティビティの説明を入力します。 |
⑤ | 担当者 | アクティビティを実施するロール「直前アクティビティ実施者」が設定されています。変更はできません。 |
⑥ | デフォルト遷移先のキー | SmartDBバインダの「実施履歴部品」に今後の実施予定を表示する際に使用される、デフォルトの遷移先キーを明示的に設定します。 |
⑦ | 通知方式 | Webhookにチェックをつけると、Webhook固有データ欄(URL、HmacSHA256キー、Basic認証、ヘッダ、終了条件)が表示されます。必須項目です。 |
⑧ | URL | Webhookで呼び出すURLを設定します。「http://」または「https://」で始まる必要があります。必須項目です。 変数をダブルクリックすると、自動的にURLに挿入されます。下記の変数が使用可能です。 ・processId(プロセスインスタンスID) ・activityId(アクティビテインスタンスID) ・processDefNum(プロセス定義番号) ・docxx_BinderId(文書格納先のバインダID) ・docxx_RecordId(文書格納先の文書ID) ※文書格納先の変数はデフォルトでdoc01、明示的に指定する場合は{doc02_binderId}または{doc02_recordId}のように指定してください。 |
⑨ | HmacSHA256キー | HmacSHA256キーとして任意のキーを入力します。 送信時に、指定したキーとHmacSHA256アルゴリズムでJSON文に対して、証明コードを計算し、拡張ヘッダ「X-SmartDB-Signature」に保存します。 (証明コードはBase64でエンコードされます。) |
⑩ | Basic認証 | Basic認証を利用するかどうかを設定します。 「使用する」にチェックをつけると、認証ためのユーザ名とパスワードが設定できます。 |
⑪ | ヘッダ | ヘッダをカスタマイズします。 チェックボックスにチェックを入れるとカスタマイズ可能になります。 KEY/VALUEの組み合わせを追加します。 |
⑫ | 終了条件 | WebhookのURLを呼び出した後、そのレスポンスを待つかどうかを設定します。 |
⑬ | イベントハンドラ | アクティビティ開始時およびアクティビティ終了時の自動処理・分岐を設定できます。 |
⑭ | 適用ボタン | アクティビティの設定を変更した際の内容を更新します。 |
Webhookのリクエスト内容について
Webhook実行時にSmartDBから送信されるリクエストの内容について記載しています。 実際に送信した内容は実施履歴から通知ロボットを選択してWebhook実施履歴の「詳細」から確認が可能です。
リクエスト情報
項目 | 値 | 説明 |
---|---|---|
メソッド | POST | 固定 |
ヘッダ情報
項目 | 値 | 説明 |
---|---|---|
X-SmartDB-Event | NOTIFY_ROBOT | 固定 |
X-SmartDB-Signature | [HmacSHA256キー] | Webhook設定画面で指定したHmacSHA256キーをBase64でエンコードした値 |
X-SmartDB-Request-ID | [ユニークID] | 1234 などWebhookリクエストのユニークID |
X-SmartDB-Version | [version番号] | 5.3.0 などSmartDBのバージョン番号 |
Content-Type | application/json; charset=UTF-8 | 固定 |
ー | ||
カスタムヘッダ | [設定内容] | Webhook設定画面のヘッダで指定したKEY/VALUE |
ボディ情報
ボディで送信される情報について記載しています。
一部の項目については省略されている場合があります。
ボディの要素
項目 | 説明 |
---|---|
activities | アクティビティ情報。詳細はアクティビティ情報を参照。 |
process | プロセス情報。詳細はプロセス情報を参照。 |
startDoc | 開始文書の情報。詳細は開始文書情報を参照。 |
docs | 文書作成ロボットで作成した文書の情報を配列で保持。詳細は文書情報を参照。※ |
※同一の文書作成ロボットで複数の文書を作成した場合、最後に作成した文書の情報のみが取得されます。
アクティビティ情報
アクティビティ情報はここまで実行されたアクティビティが"activity"オブジェクトとして含まれ、配列で表現されます。
項目 | 説明 |
---|---|
id | アクティビティインスタンスID |
name | アクティビティ名 |
ended | 実施ユーザの情報 |
ended_at | アクティビティの終了日時 |
started_at | アクティビティの開始日時 |
status | アクティビティの状態。 RUNNABLE :アクティビティ実施中 が送信される |
※ユーザ情報についてはwebhookの実行結果については、バインダ作成ガイドの【webhook】を参照してください。
プロセス情報
項目 | 説明 |
---|---|
id | プロセスインスタンスID |
name | プロセスの見出し |
number | プロセス定義ID |
started | 業務開始者の情報 |
started_at | プロセスの開始日時 |
status | プロセスの状態。 WORKING :プロセス実施中 が送信される |
文書の情報
項目 | 説明 |
---|---|
binderId | バインダID |
recordId | 文書番号 |
document | 【FS/KK/KP】文書情報※ |
pVarName | 【FS/KK/KP】該当文書が定義された文書情報格納先 |
※文書情報の詳細は、バインダ作成ガイドの【webhook】の文書情報を参照してください。
実施履歴
業務プロセスの実施履歴一覧より、通知ロボットの処理結果を確認することができます。
業務プロセスの実施履歴(実施履歴部品の場合は、ロボットアクティビティを表示する設定であること)で、「通知ロボット」の履歴を表示します。
通知ロボットのアクティビティ名をクリックすると、通知ロボットの詳細情報が表示されます。
通知ロボットの詳細情報の中で「詳細」リンクをクリックすると、さらにWebhook実施の詳細情報が表示されます。 Webhookのリクエスト内容と応答結果を確認することができます。
webhookの実行結果については、バインダ作成ガイドの【webhook】も参照してください。
※通知ロボットのwebhookでは再送信ボタンは表示されません。
イベントハンドラ
「開始時」「終了時」のタイミングで、イベントハンドラによる自動処理の設定を行う事ができます。
イベントハンドラについての詳細は、【イベントハンドラ】を参照してください。