Skip to main content
OutSystems

未処理のエラー発生時のページのカスタマイズ

OutSystemsは、予期しないエラーや未処理のエラーがアプリケーションで発生した場合に、これらを処理してエンドユーザーに対して適切なフィードバックページを表示します。このドキュメントでは、これらのページをカスタマイズして開発者のアプリケーション設計に合わせる方法について説明します。

はじめに

アプリケーションを設計するときの基本は、エラー処理です。これにより、誤動作やクラッシュを防ぎ、エンドユーザーにフィードバックを提供できます。しかし、予期しない(および未処理の)エラーがアプリケーションで発生する場合があります。そのため、OutSystemsプラットフォームでは、エンドユーザーに対して適切なフィードバックページを表示することでこれらが確実に処理されるようにします。このドキュメントでは、OutSystemsプラットフォームが提供するすべての種類のエラー処理と、アプリケーション設計に合わせてこれらをカスタマイズする方法について説明します。

エラー処理ページ

OutSystemsプラットフォームはエラーのタイプに応じて特定のページを表示し、内部エラー、リソース不明エラー、アプリケーションの一時的なオフラインエラー、アプリケーションの利用不可エラーを処理します。

内部エラー

これらのエラーは、アプリケーションによってエラーが処理されない場合、つまり、未処理のエラーの場合に発生します。OutSystemsでは以下のページが表示されます。1.png

リソース不明エラー

これらのエラーは、アプリケーションのスコープ内に存在しないページ(URL)に移動する場合に発生します。OutSystemsでは以下のページが表示されます。

2.png

アプリケーションの一時的なオフラインエラーページ

これらのエラーは、アプリケーションがデプロイされたときに、ライセンスにホットデプロイ機能が含まれていない場合に発生します。OutSystemsでは以下のページが表示されます。

3.png

アプリケーションの利用不可エラーページ

これらのエラーは、以下のいずれかの理由によりアプリケーションが利用できない場合に発生します。

  • Service Centerでアプリケーションがオフラインにされた。
    OutSystemsでは以下のページが表示されます。
    4.png
  • ライセンスの期限切れなどのライセンスの問題により、アプリケーションがOutSystemsプラットフォームによって自動的にシャットダウンされた。
    OutSystemsでは以下のページが表示されます。5.png

エラー処理ページをカスタマイズする

ファイルのカスタマイズ

エラー処理ページをカスタマイズするには、対応するファイルの内容を編集する必要があります。

  • 内部エラー: internalerror.aspx
  • リソース不明エラー: notfound.aspx
  • アプリケーションの一時的なオフラインエラー: app_offline_template.htm
  • アプリケーションの利用不可エラー: app_offline.aspx

これらのファイルはすべて、Platform Serverインストールディレクトリ(通常はC:\Program Files\OutSystems\Platform Server)にあるcustomHandlersフォルダにあります。

なお、OutSystemsプラットフォームをアップグレードしてもこれらのファイルは変更されないため、カスタマイズは保持されます。

使用可能なエディタ

ファイルの内容を編集してページを設計する場合、ファイルタイプに対応する任意のエディタを使用できます。

追加情報を使用する

アプリケーションの利用不可エラーページでは、リクエストパラメータをページに送信することにより、詳細情報や機能をページに追加できます。

  • contact: (Service Centerで構成された)Platform Server管理者のメールアドレス。
  • errorCode: 以下のいずれかの値でエラータイプを識別するために使用されます。
    • "APPLICATION_OFFLINE": Service Centerで意図的にアプリケーションがオフラインにされたことを示します。
    • "APPLICATION_LICENSING_ERROR": ライセンスエラーのためにアプリケーションがオフラインにされたことを示します。
  • errorDetail: ライセンスエラーに関する詳細情報。

新しいエラー処理ページをオンラインにする

エラー処理ページのファイルを変更すると、エンドユーザーに対するOutSystemsプラットフォームの表示内容にすぐに反映されます。このため、ファイルを直接操作する場合や未完成のバージョンを保存する場合は特に注意してください。OutSystemsでは、(1)ファイルを別のディレクトリにコピーし、(2)コピーしたファイルで作業し、(3)完成したファイルを元の場所にコピーするという手順を推奨しています。

ファーム環境では、カスタマイズしたページのファイルをすべてのフロントエンドノードに手動でコピーする必要があります。

 

  • Was this article helpful?