4.15. ポートレットを設定する¶
IM-Workflow のポートレットを利用することにより、ポータル上で下記の操作を行えます。
- 処理待ちタスクの総件数の確認
- 案件の申請、処理、および確認の実行
利用可能なポートレットは次のとおりです。
名称 概要 タスク通知ポートレット 処理待ちタスクの総数を待ち状態ごとに確認できます。 申請一覧ポートレット 特定フローグループ配下の申請可能なフローを一覧表示できます。 未処理タスク一覧ポートレット 特定フローグループ配下の処理待ち状態のタスクを一覧表示できます。 未確認案件一覧(未完了案件)ポートレット 特定フローグループ配下の確認待ち状態の未完了案件を一覧表示できます。 未確認案件一覧(完了案件)ポートレット 特定フローグループ配下の確認待ち状態の完了案件を一覧表示できます。 申請ポートレット すべての申請可能なフローを一覧表示できます。 新着処理ポートレット すべての処理待ち状態のタスクを一覧表示できます。 ここからは、個々のポートレットの特徴を、製品が推奨するポータル設定を交えて紹介します。配置先のポータルはあくまで例ですので、運用に応じて設定を検討してください。なお、ポートレットおよびポータルの具体的な設定方法については「 ポータル 管理者操作ガイド 」を参照してください。
目次
4.15.1. グループポータルを設定する¶
部門ごとのポータルを用意し、それぞれに関連のあるフローや処理待ちのタスクのみを表示できます。関連情報の絞り込みはフローグループを利用することで実現します。グループポータルを設定するうえで有用なポートレットを紹介します。
4.15.1.1. タスク通知ポートレット¶
ログインユーザが抱える処理待ちタスクの総数を、待ち状態ごとに確認可能なポートレットです。待ち状態を表すタイルをクリックすることで、案件一覧画面に遷移し、対応する情報を一覧表示できます。表示対象のタスク(案件)の状態は次のとおりです。
- 一時保存
- 未処理
- 未確認(未完了案件)
- 未確認(完了案件)
ポートレットの設定方法は次のとおりです。
ポートレット名 非同期ページポートレット 名称 [任意の名称を設定してください]例: タスク通知アプリケーション [任意の名称を設定してください]例: IM-WorkflowURL im_workflow/iframe-components/task-notifications コラム
表示対象のタスク(案件)の状態それぞれの表示有無および表示順序は、ワークフローパラメータで制御できます。制御用のパラメータは「「案件一覧」で利用するタスクステータス」です。当該パラメータの詳細に関しては次のドキュメントを参照してください。
4.15.1.2. 申請一覧ポートレット¶
申請可能なフローを一覧表示するポートレットです。特定のフローグループ配下の情報のみを表示します。次の操作を行えます。
- フロー情報の参照
- 案件の申請
- 申請一覧画面への遷移
当ポートレットの表示情報は一覧表示パターン定義による制御を受けません。一覧情報は「フロー名」の昇順で初期表示します。一覧表示する情報の検索条件はフローグループのみです。ポートレットの設定方法は次のとおりです。
ポートレット名 非同期ページポートレット 名称 [任意の名称を設定してください]例: 申請一覧(フローグループA)アプリケーション [任意の名称を設定してください]例: IM-WorkflowURL im_workflow/iframe-components/applications/group/%表示対象のフローグループID%例: im_workflow/iframe-components/applications/group/flow-group-Aコラム
ブラウザのローカルストレージが有効な場合は、一覧表示する情報のソート条件をブラウザのローカルストレージに保存します。保存済みのソート条件が存在する場合、ソート条件を復元して初期表示します。保存はフローグループ単位で行います。
4.15.1.3. 未処理タスク一覧ポートレット¶
処理待ち状態のタスクを一覧表示するポートレットです。特定のフローグループ配下の情報のみを表示します。次の操作を行えます。
- 案件情報の参照
- 案件に対する処理
- 案件一覧画面への遷移
一覧表示する項目や初期ソート順序は、表示対象のフローグループに関連する一覧表示パターン定義の設定に準拠します。一覧表示する情報の検索条件はフローグループのみです。一覧表示パターン定義の「初期検索条件」は適用しません。ポートレットの設定方法は次のとおりです。
ポートレット名 非同期ページポートレット 名称 [任意の名称を設定してください]例: 未処理タスク一覧(フローグループA)アプリケーション [任意の名称を設定してください]例: IM-WorkflowURL im_workflow/iframe-components/tasks/status/active-matter-tasks/group/%表示対象のフローグループID%例: im_workflow/iframe-components/tasks/status/active-matter-tasks/group/flow-group-Aコラム
一度に取得するタスク数を制御できます。任意の件数に変更する場合は、ポートレットの「ページ引数」を次の形式で設定してください。
- fetch=n
n には 1 以上の整数を指定してください。(設定例: fetch=15)未指定の場合は 30 件で動作します。コラム
ブラウザのローカルストレージが有効な場合は、一覧表示する情報のソート条件をブラウザのローカルストレージに保存します。保存済みのソート条件が存在する場合、ソート条件を復元して初期表示します。保存はフローグループ単位で行います。コラム
「振替」処理は実行できません。必要に応じて「案件一覧」画面を利用してください。
4.15.1.4. 未確認案件一覧(未完了案件)ポートレット¶
確認待ち状態の未完了案件を一覧表示するポートレットです。特定のフローグループ配下の情報のみを表示します。次の操作を行えます。
- 案件情報の参照
- 案件に対する確認処理
- 案件一覧画面への遷移
一覧表示する項目や初期ソート順序は、表示対象のフローグループに関連する一覧表示パターン定義の設定に準拠します。一覧表示する情報の検索条件はフローグループのみです。一覧表示パターン定義の「初期検索条件」は適用しません。ポートレットの設定方法は次のとおりです。
ポートレット名 非同期ページポートレット 名称 [任意の名称を設定してください]例: 未確認案件一覧(未完了案件)(フローグループA)アプリケーション [任意の名称を設定してください]例: IM-WorkflowURL im_workflow/iframe-components/tasks/status/active-matters-unconfirmed/group/%表示対象のフローグループID%例: im_workflow/iframe-components/tasks/status/active-matters-unconfirmed/group/flow-group-Aコラム
一度に取得する案件数を制御できます。任意の件数に変更する場合は、ポートレットの「ページ引数」を次の形式で設定してください。
- fetch=n
n には 1 以上の整数を指定してください。(設定例: fetch=15)未指定の場合は 30 件で動作します。コラム
ブラウザのローカルストレージが有効な場合は、一覧表示する情報のソート条件をブラウザのローカルストレージに保存します。保存済みのソート条件が存在する場合、ソート条件を復元して初期表示します。保存はフローグループ単位で行います。
4.15.1.5. 未確認案件一覧(完了案件)ポートレット¶
確認待ち状態の完了案件を一覧表示するポートレットです。特定のフローグループ配下の情報のみを表示します。次の操作を行えます。
- 案件情報の参照
- 案件に対する確認処理
- 案件一覧画面への遷移
一覧表示する項目や初期ソート順序は、表示対象のフローグループに関連する一覧表示パターン定義の設定に準拠します。一覧表示する情報の検索条件はフローグループのみです。一覧表示パターン定義の「初期検索条件」は適用しません。ポートレットの設定方法は次のとおりです。
ポートレット名 非同期ページポートレット 名称 [任意の名称を設定してください]例: 未確認案件一覧(完了案件)(フローグループA)アプリケーション [任意の名称を設定してください]例: IM-WorkflowURL im_workflow/iframe-components/tasks/status/completed-matters-unconfirmed/group/%表示対象のフローグループID%例: im_workflow/iframe-components/tasks/status/completed-matters-unconfirmed/group/flow-group-Aコラム
一度に取得する案件数を制御できます。任意の件数に変更する場合は、ポートレットの「ページ引数」を次の形式で設定してください。
- fetch=n
n には 1 以上の整数を指定してください。(設定例: fetch=15)未指定の場合は 30 件で動作します。コラム
ブラウザのローカルストレージが有効な場合は、一覧表示する情報のソート条件をブラウザのローカルストレージに保存します。保存済みのソート条件が存在する場合、ソート条件を復元して初期表示します。保存はフローグループ単位で行います。
4.15.2. ユーザポータル向けポートレットを設定する¶
一般ユーザが作成する「ユーザポータル」に主に配置されることを想定したポートレットを紹介します。
4.15.2.1. 申請ポートレット¶
すべての申請可能なフローを一覧表示するポートレットです。次の操作を行えます。
- フロー情報の参照
- 案件の申請
- 申請一覧画面への遷移
当ポートレットの表示情報は一覧表示パターン定義による制御を受けません。一覧情報は「フロー名」の昇順で初期表示します。当ポートレットはテナント環境セットアップで登録されます。そのため、利用にあたってポートレットの新規設定は不要です。ポートレットを削除してしまった場合は、次の設定で新規登録してください。
ポートレット名 スクリプト開発モデルポートレット 名称 [任意の名称を設定してください]例: 申請ポートレットアプリケーション [任意の名称を設定してください]例: IM-Workflowページパス /im_workflow_portlet/user/apply/apply_list コラム
当ポートレットから申請画面に遷移した後、申請画面から戻る、または申請処理を行って次の画面に遷移をする際、遷移先画面は次の機構によって決定します。
- 「 IM-Workflow 仕様書 」 - 「 遷移先プラグインの設定 」
結果としては、遷移元であるホーム画面やポータル画面ではなく、申請一覧画面に遷移します。2019 Summer(Waltz) より、上述の操作後の遷移先を、本来の遷移元であるホーム画面やポータル画面に切り替えられます。この動作に切り替える場合は、ポートレットの「ページ引数」に次の値を設定してください。
- return=current
4.15.2.2. 新着処理ポートレット¶
すべての処理待ち状態のタスクを一覧表示するポートレットです。次の操作を行えます。
- 案件情報の参照
- 案件に対する処理
- 案件一覧画面への遷移
当ポートレットの表示情報は一覧表示パターン定義による制御を受けません。一覧情報は「到達日」の昇順で初期表示します。当ポートレットはテナント環境セットアップで登録されます。そのため、利用にあたってポートレットの新規設定は不要です。ポートレットを削除してしまった場合は、次の設定で新規登録してください。
ポートレット名 スクリプト開発モデルポートレット 名称 [任意の名称を設定してください]例: 新着処理ポートレットアプリケーション [任意の名称を設定してください]例: IM-Workflowページパス /im_workflow_portlet/user/process/process_list コラム
当ポートレットから処理画面に遷移した後、処理画面から戻る、または案件処理を行って次の画面に遷移をする際、遷移先画面は次の機構によって決定します。
- 「 IM-Workflow 仕様書 」 - 「 遷移先プラグインの設定 」
結果としては、遷移元であるホーム画面やポータル画面ではなく、未処理一覧画面や案件一覧画面に遷移します。2019 Summer(Waltz) より、上述の操作後の遷移先を、本来の遷移元であるホーム画面やポータル画面に切り替えられます。この動作に切り替える場合は、ポートレットの「ページ引数」に次の値を設定してください。
- return=current
コラム
当ポートレットのデフォルトでのソートは到達日の昇順です。2023 Spring(Gerbera) より、デフォルトでのソートキーやソート順を切り替えられます。この動作に切り替える場合は、ポートレットの「ページ引数」に次の値を設定してください。到達日をソートキーとしてポートレットに表示させたい場合は、以下のように設定します。
- sortName=startDate
案件名をソートキーとしてポートレットに表示させたい場合は、以下のように設定します。
- sortName=matterName
申請者をソートキーとしてポートレットに表示させたい場合は、以下のように設定します。
- sortName=applyAuthUserName
ソート順を降順でポートレットに表示させたい場合は、以下のように設定します。
- sortOrder=desc
例)案件名の降順でポートレットに表示させたい場合、「ページ引数」には “sortName=matterName&sortOrder=desc” と指定してください。