intra-mart Accel Platform UIデザインガイドライン(PC版) 第6版 2022-12-01

6.5.2. 汎用メッセージ画面

アプリケーション内で発生したエラーによっては、回復不能な場合があります。
このような場合に表示する画面と、その画面に遷移するための API を提供します。

6.5.2.1. API

表示できるメッセージ表示画面の種類、その画面に遷移するための API は以下のとおりです。
  • エラー
  • Transfer.toErrorPage
  • 警告
  • Transfer.toWarningPage
  • インフォメーション
  • Transfer.toInformationPage
メッセージ表示画面に表示できるのは、以下 3 つです。
  • タイトル
  • メッセージ
  • 詳細なエラーメッセージ
また、メッセージ表示画面表示後の遷移先を指定することも可能です。
遷移先 URL、遷移先 URL のラベルを指定すると、画面遷移のボタンが表示されます。
遷移先 URL へ引き渡すパラメータを指定すると、そのパラメータが遷移先に引き渡されます。
メッセージ表示画面へはリダイレクトを利用して遷移します。

6.5.2.2. 実装例

エラー画面へ遷移するための例を示します。
パラメータの詳細は、API リファレンスを参照してください。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
function error(request) {
  Transfer.toErrorPage({
    title: 'タイトル',
    message: 'メッセージ',
    detail: ['詳細メッセージ1', '詳細メッセージ2'],
    returnUrl: '/login', // 戻り先 URL
    returnUrlLabel: 'ログイン画面へ戻る',
    parameter: {
      key: 'value',
      list: ['1','2','3']
    }
  });
}

コラム

上記パラメータのメッセージは多言語対応していません。多言語対応したい場合は、MessageManager から取得したメッセージをセットしてください。

コラム

テーマを適用させたくない場合には、API を呼び出す前に request.setAttribute(‘imui-theme-builder-module’, ‘notheme’) を実行し、テーマを適用しないようにしてください。

6.5.2.3. 汎用エラー画面表示後の戻り先画面

汎用メッセージ画面 の仕組みで表示したエラー画面の戻り先を説明します。

注意

本章は、基本ルールです。個別の機能の事情で従うのが無理な場合は従う必要はありません。
ただし、機能内での統一性は担保してください。

6.5.2.3.1. 汎用エラー画面の「戻る」ボタンを表示する場合

(例)「メニュー」⇒「一覧画面」⇒「登録/更新画面」の様な画面遷移
  • 「登録/更新画面」でエラーが発生し、汎用エラー画面に遷移した場合
  • エラーが発生した画面の遷移元に戻る。(「一覧画面」)
  • ※ 遷移元が複数階層ある場合は、(可能であれば)エラーが発生した画面に一番近い遷移元に遷移します。

6.5.2.3.2. エラー画面の「戻る」ボタンを表示しない場合

(例)「メニュー」⇒「一覧画面」⇒「登録/更新画面」の様な画面遷移
  • 「一覧画面」でエラーが発生し、汎用エラー画面に遷移した場合。
  • 「戻る」ボタンを表示しません。