2.2.2 ユーザプラグイン
ユーザプラグインとは,ナビゲーション プラットフォームが提供するAPIを使用して開発するプラグインです。ユーザプラグインには,次の種類があります。
-
入出力プラグイン
システムプラグインでは制御できない,任意の外部プログラムとの間のデータの入出力を制御します。
-
中断再開プラグイン
利用者が業務実行画面で入力した情報を一時保存して,業務を再開したときに一時保存した情報を復元するためのプラグインです。中断再開プラグインを開発すると,利用者が業務の途中にほかの業務を参照したり,ログアウトしたりしても,一時保存した状態から業務を再開できるようになります。
-
カスタム画面プラグイン
カスタム画面プラグインは,新規画面を開発するためのプラグインです。ログイン後にナビゲーション プラットフォームの画面のほかに,独自に作成した別画面(カスタム画面)を表示できるようになります。
(1) 入出力プラグイン(ユーザプラグイン)の処理と動作イメージ
入出力プラグイン(ユーザプラグイン)の概要を次に示します。
入出力プラグイン(ユーザプラグイン)と連携すると,次のような処理ができます。
-
業務フローの工程と工程の間で,データの受け渡しをする
-
ガイドに入力した値をデータベースへ登録する
例えば,次のような流れの業務があるとします。
-
契約内容の変更
-
変更内容の確認
1. 契約内容の変更でガイドに入力した値を,2. 変更内容の確認でガイドに表示させたい場合に,入出力プラグイン(ユーザプラグイン)とガイドを関連づけます。入出力プラグイン(ユーザプラグイン)とガイドを関連づけた場合の業務実行画面の動作イメージを次に示します。
入出力プラグイン(ユーザプラグイン)を使用するには,プラグインを開発することのほかに,業務編集画面で入出力プラグインとガイドを関連づける操作が必要です。この作業の詳細は,マニュアル「ナビゲーション プラットフォーム コンテンツ作成ガイド」を参照してください。
(2) 中断再開プラグイン(ユーザプラグイン)の動作イメージ
中断再開プラグインを使用した場合の業務実行画面の動作イメージを次に示します。
利用者は,業務実行画面の右上にある[一時保存]ボタンをクリックすることで,入力した情報を保存できます。業務を再開するときは,次に示す情報(中断情報)が復元されます。
-
一時保存したときに実行していた工程
一時保存したときに実行していた工程が,実行中の工程として復元されます。また,実行中の工程が表示されるように,業務フローが自動的にスクロール※1されます。
-
直接遷移できる工程※2
クリックして直接遷移できる工程の状態が復元されます。
-
ガイドに入力した情報
各工程のガイドに入力した情報が復元されます。
- 注※1
-
ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.autoscrollプロパティがtrueの場合に,自動的にスクロールされます。
- 注※2
-
ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.directjump.enableプロパティがtrueの場合に,直接遷移できるノードが表示されます。
中断再開プラグインを使用するには,プラグインを開発することのほかに,次の作業が必要です。なお,括弧内には,詳細についての参照先を示しています。
-
中断情報の容量を見積もる(「3.4.3 中断再開プラグインを使用する場合の容量の見積もり」を参照)
-
次のユーザプロパティを設定する(「8.5 ユーザプロパティファイル(ucnp_user.properties)の設定」を参照)
-
必須:ucnp.base.client.suspend.enable(中断再開プラグインの使用有無)
-
任意:ucnp.base.client.viewer.confirm.discardinput.enable(入力情報の破棄確認ダイアログの表示有無)
-
-
業務コンテンツまたはユーザを追加,変更したときに,中断情報を運用する(「5.6 中断情報の運用」を参照)