Webhook通知設定
Webhook通知とは？
i-Reporter運用で発生する各種通知（帳票のサーバー保存、承認クラスターの申請、差戻、承認など）のタイミングで、任意のURLを要求できる機能です。
Webhook機能を使って、他のWebアプリケーションへi-Reporterの帳票情報を渡すなどのシステム連携ができます。
通知のタイミング
申請・差戻・承認通知 「承認クラスター」を申請・差戻・承認に変更した時にWebhook通知します。
編集保存通知 i-Reporterアプリより入力帳票を「サーバーへ保存し編集継続」、「サーバーへ保存し編集終了」した時にWebhook通知します。
完了通知 入力帳票を「完了保存」した時にWebhook通知します。
変更通知 クラスターの入力値が変更された時に、 Webhook通知します。 ※入力値が特定の条件になった場合にだけ通知するよう設定することができます。
端末申請・承認通知 端末登録の申請・承認の各タイミングでWebhook通知します。
定義申請・差戻・承認通知 帳票定義の公開における申請・差戻・承認の各タイミングでWebhook通知します。
スケジュール登録通知 ユーザー別の作業スケジュールの登録・変更の各タイミングでWebhook通知します。
設定の流れ
基本設定
【手順】
ConMas Managerの「システム管理」タブ ＞左メニュー 「Webhook通知設定」をクリックします。 「Webhook通知設定一覧」画面右上の「追加(＋)」ボタンをクリックします。
「Webhook通知設定」画面が開きますので、「▼アプリケーション連携設定」 および 「▼通知設定」の右側にある「編集」ボタンをクリックし、それぞれの設定を行います。
アプリケーション連携設定
Webhookにて通知するURLへの要求内容を設定します。
設定項目「Webhook通知先」の選択肢にある「その他」は、過去に該当設定で使用していたお客様向けに残している設定項目です。 これから新規設定を行う場合、「その他」は非推奨です。
Webhook通知先が 「一般」 の場合の設定項目
Webhook通知先（必須） 連携するWebアプリケーションで “一般” を選択します。
通知設定名称（必須） 設定名称を入力します。
Endpoint(URL)（必須） 呼び出すWebAPIの（エンドポイント）URLを入力します。 この項目では置き換え文字が使用できます。
HTTP Method（必須） HTTPメソッドを “GET”、“POST”、“PUT”、“DELETE” から選択します。
Params パラメーターを “Key”、“Value” で設定します。 この項目では置き換え文字が使用できます。
Authentication 認証方法を “なし”、“基本認証”、“Bearer認証” から選択し、 HTTPのAuthorizationヘッダにセットする各値を設定します。
“なし” 認証を設定しません。
“基本認証” ユーザー名、パスワードを設定します。 Headersに編集不可の行 Key=“Authorization”、Value=“Basic <Value>” が追加されます。
“Bearer認証” トークンを設定します。 Headersに編集不可の行 Key=“Authorization”、Value=“Bearer <Token>” が追加されます。
Headers HTTPヘッダにセットするパラメーターを “Key”、“Value” で設定します。 この項目では “Value” に置き換え文字が使用できます。
Body “none”、“form-data”、“x-www-form-urlencoded”、 “raw” から選択します。 選択した項目に応じて、HTTPのボディにセットする各値を設定します。
“none” ボディを設定しません。
“form-data” パラメーターを “Key”、“Value” で設定します。 Headersに編集不可の行 Key=“Content-Type”、 Value=“multipart/form-data; boundary=...” が追加されます。 ”boundary=”以降は、送信時にランダムな文字列が自動で付与されます。 この項目では “Value” に置き換え文字が使用できます。
“x-www-form-urlencoded” パラメーターを “Key”、“Value” で設定します。 Headersに編集不可の行 Key=“Content-Type”、Value=“application/x-www-form-urlencoded” が追加されます。 この項目では “Value” に置き換え文字が使用できます。
“raw” テキストエリアにデータを設定します。 Headersに Key=“Content-Type”、Value=“text/plain” が追加されます。 “Key” は編集不可、“Value” は編集可能です。 この項目ではデータに置き換え文字が使用できます。
リトライ回数 リクエスト失敗時のリトライ回数を、リストから選択します。 0～5回まで設定できます。（デフォルト: 1）
テスト送信ボタン 入力された内容でURLをリクエストします。
Webhook通知先が「i-Repo Link」、「i-Repo WorkFlow」 の場合の設定項目
Webhook通知先（必須） 連携するWebアプリケーションを “i-Repo Link”、“i-Repo WorkFlow” から選択します。
Webhook通知設定名称（必須） 設定名称を入力します。
Webhook URL （必須） 呼び出すWebAPIの（エンドポイント）URLを入力します。
Webhook リクエスト（必須） HTTPメソッドを“GET”、“POST”から選択します。
Webhook パラメーター GET または POSTパラメーターをリストから選択します。 設定できる内容については、「Webhookパラメーター」をご参照ください。
Token HTTPのAuthorizationヘッダの Bearerにセットするtoken値をセットします。
テスト送信ボタン 入力された内容でURLをリクエストします。
Webhookパラメーター
使用できるパラメーター一覧です。 「パラメーター名」は、置き換え文字として使用できます。
帳票定義ID
def_top_id
帳票定義IDが値としてセットされます。
帳票定義ID
rep_top_id
入力帳票IDが値としてセットされます。
帳票定義名称
def_top_name
帳票定義名称が値としてセットされます。
入力帳票名称
rep_top_name
入力帳票名称が値としてセットされます。
帳票備考1
report_remarks1
入力帳票備考1が値としてセットされます。
帳票備考2
report_remarks2
入力帳票備考2が値としてセットされます。
…
…
…
帳票備考10
report_remarks10
入力帳票備考10が値としてセットされます。
システムキー1
system_key1
入力帳票のシステムキー1が値としてセットされます。
システムキー2
system_key2
入力帳票のシステムキー2が値としてセットされます。
…
…
…
システムキー5
system_key5
入力帳票のシステムキー5が値としてセットされます。
ログインユーザーID
Login_user_id
ログインユーザーIDが値としてセットされます。
Webhookパラメーターの追加、削除
Webhook通知先が 「一般」 の場合
“Params”、“Headers”、“Body” のパラメーターは、画面上の「追加」ボタンで追加、「削除」ボタンで削除します。
Webhook通知先が 「i-Repo Link」、「i-Repo WorkFlow」の場合
Webhookパラメーターは、画面上の「追加」ボタンで追加、選択値を空にして削除します。
デフォルトで「帳票定義ID」、「入力帳票ID」、「ログインユーザーID」が入りますが、不要な場合は削除して空にしてください。
Webhookパラメーターの注意点
Webhook通知先に 「i-Repo Link」、「i-Repo WorkFlow」、を選択している場合、Webhookパラメーターはリストから選択しますが、画面右側のボックスにはフリー入力が可能となっています。 {xxxxxx}の文字列は選択された項目の置換文字列として利用していますので、変更すると通知の際に選択された項目の内容として送信されず、フリー入力された文字列がそのまま送信されます。
【例】 「入力帳票ID」を選択。自動セットされた「{rep_top_id}」を「ＸＸＸＸ」に変更
WebhookでURL要求の際、パラメーターは以下となります。
各通知のOn/Off設定
Webhookを行いたい通知のOn/Offを設定します。
先にアプリケーション連携設定を行う必要があります。
使用されているWebhookパラメーターによっては、通知できない設定があります。 例えば、「定義承認通知」にはWebhookパラメーターの「入力帳票ID」は使用することはできません。 設定しようとしても通知設定画面では、以下画面のようにエラーメッセージを表示し設定保存できません。
各通知で使用できるWebhookパラメーター対応表
帳票定義ID
○
○
○
○
○
○
入力帳票ID
○
○
○
○
○
○
帳票定義名称
○
○
○
○
○
○
入力帳票名称
○
○
○
○
○
○
帳票備考1～10
○
○
○
○
○
○
システムキー1～10
○
○
○
○
○
○
ログインユーザーID
○
○
○
○
○
○
○
○
帳票定義ID
○
○
○
入力帳票ID
○
帳票定義名称
○
○
○
入力帳票名称
○
帳票備考1～10
システムキー1～10
ログインユーザーID
○
○
○
○
帳票定義への通知設定
申請、差戻、承認、変更、編集保存、完了通知を行うには、帳票定義への設定が必要です。 システム管理で作成したWebhook通知設定を帳票定義にセットします。
編集保存・完了通知は帳票定義単位にテンプレートを設定することができます。 「帳票定義に編集保存、完了通知テンプレートを設定」をご参照ください。
申請・差戻・承認通知はクラスター単位にテンプレートを設定することができます。 「帳票定義に申請・差戻・承認通知を設定」をご参照ください。
変更通知は承認、画像系以外のクラスター単位にテンプレートを設定することができます。 「帳票定義に変更通知を設定」をご参照ください。
帳票定義に編集保存、完了通知を設定
帳票定義の「基本情報編集画面」で設定します。
【手順】
ConMas Managerの「帳票定義」タブ ＞該当の帳票定義を選択 ＞ 画面左ツリーの「基本情報」をクリックします。
画面右上の「編集」ボタンをクリックします。
「▼基本情報」欄にある 「編集保存webhook通知」 および 「完了webhook通知」 に、任意のWebhook通知設定をセットします。
帳票定義に申請、差戻、承認通知を設定
帳票定義の「Webhook通知設定」画面で、承認クラスターごとに設定します。
【手順】
ConMas Managerの「帳票定義」タブ ＞該当の帳票定義を選択 ＞ 画面左ツリーの「Webhook通知設定」から、Webhook通知を設定したいクラスターが存在するシートをクリックします。
Webhook通知を設定したいクラスターの「編集」ボタンをクリックします。
任意のWebhook通知設定をセットし、「登録」ボタンをクリックします。
帳票定義に変更通知を設定
帳票定義の「Webhook通知設定」画面で、各クラスターごとに設定します。
【手順】
ConMas Managerの「帳票定義」タブ ＞該当の帳票定義を選択 ＞ 画面左ツリーの「Webhook通知設定」から、Webhook通知を設定したいクラスターが存在するシートをクリックします。
Webhook通知を設定したいクラスターの「編集」ボタンをクリックします。
任意のWebhook通知設定をセットし、「登録」ボタンをクリックします。
変更通知の条件設定
作成・査閲クラスターを除き、変更通知がセット可能クラスターについては、変更通知条件が設定できます。 変更通知条件を設定すると、クラスターの入力値が「ある値」になった時のみ通知することが可能になります。
通知条件は、クラスターの種別ごとに設定できる通知条件が異なります。 通知条件を設定していない場合は、クラスター入力値が変更された場合にすべて通知します。
キーワード条件
クラスター入力値に設定したキーワードが含まれていれば、Webhookを通知します。 キーワードは、１０個まで設定可能です。
設定可能なクラスター種別
キーボードテキスト
手書きデジタル
入力値がクリアされた時 チェックすると入力値をクリアした時にWebhookを通知します。 ※設定すると、キーワード設定はクリアされます。
範囲条件
クラスター入力値が設定したFrom,To範囲内 又は一致した時にWebhookを通知します。ｚFrom、Toにはそれぞれ、条件が設定可能です。
From条件
に等しい 入力値がFrom値に等しい時に通知します。符号=
より大きい 入力値がFrom値より大きい時に通知します。符号<
以上 入力値がFrom値以上の時に通知します。符号≦
To条件
より小さい 入力値がTo値より小さい時に通知を行います。符号>
以下 入力値がTo値以下の時に通知します。符号≧
設定可能なクラスター種別
数値選択
数値
時間数
年月日
カレンダー年月日
時刻
トグル集計
計算式
入力値がクリアされた時 チェックすると入力値をクリアした時に通知されます。 ※設定すると範囲設定はクリアされます。
チェック条件
入力値が設定した条件に、当てはまるとWebhookを通知します。 設定値には「選択値」と「条件」があり、この２つを組み合わせて条件設定を行います。
選択値 クラスター入力値を選択します。 チェッククラスターの場合は、「チェックあり」のみが選択出来ます。
条件
に一致する
に一致しない
設定可能なクラスター種別
チェッククラスター
選択条件
クラスター入力値が設定した条件に、当てはまるとWebhookを通知します。 設定値には「選択値」と「条件」があり、この２つを組み合わせて条件設定を行います。
選択値 クラスター入力値を選択します。
条件
に一致する
に一致しない
設定可能なクラスター種別
単一選択
トグル選択
入力値がクリアされた時 チェックすると入力値をクリアした時に通知されます。 ※設定すると、選択条件設定はクリアされます。
複数選択条件
クラスター入力値が設定した条件に、当てはまるとWebhookを通知します。 設定値には「選択値」と「条件」があり、この２つを組み合わせて条件設定を行います。
選択値 クラスター入力値を選択します。
条件
に一致する
に一致しない
のいずれかを含む
のいずれも含まない
設定可能なクラスター種別
複数選択
入力値がクリアされた時 チェックすると入力値をクリアした時に通知されます。 ※設定すると、複数選択条件設定はクリアされます。
入力帳票へのWebhook通知設定
入力帳票ごとに個別にWebhook通知設定を変更することもできます。 帳票定義で設定された各種Webhook通知設定は、設定情報が入力帳票に引き継がれます。 入力帳票ごとに個別に通知設定を変更したい場合は、帳票定義ではなく、入力帳票の通知設定を編集します。
入力帳票の編集保存、完了通知設定を変更
入力帳票の「基本情報編集」画面で変更します。
入力帳票の申請、差戻、承認、変更通知設定を変更
入力帳票の「Webhook通知設定」画面で、クラスターごとに通知設定を変更します。
送信履歴
Webhook通知の履歴を検索、参照します。 検索条件を指定して絞り込むことができます。 検索結果から再送信、削除、CSV出力ができます。 一度に出力できる最大件数を超えると、CSVファイルの最後に下記のメッセージが追加されます。
“Truncated to 100,000 records.”
最大件数以上のデータを出力したい場合は、一度出力した後、検索条件を変更して再度出力してください。
最終更新