メンテナンスモード切り替え

最終更新日: 2022年6月23日

概要

Webアプリケーションの状態を切り替えることができます。
「メンテナンスモード」にすると、管理者権限以外のアカウントではログオンはできますがメンテナンス画面が表示されるのみで操作が制限されます。
データのエクスポート処理や、インポート処理を行う際にユーザに操作をさせないようにする場合に有効です。

メンテナンスモード切り替えボタン

メンテナンスモードへの切り替え条件

メンテナンス画面切り替え時に、次のオプションを選択することができます。

オプションの選択

ログオンしているアカウントを強制ログアウトさせる

これによって(自分自身を除く)すべてのログオンが無効になります。更新画面を開いていた場合、ロックも解除されます。ただしCSV・Excelアップロード更新途中の処理は継続されます。

ログオンしているアカウントがいれば、メンテナンスモードに入れない

この場合、何人のアカウントがログオンしているため、というエラーメッセージが表示され、処理は中断されます。

ログオンしているアカウントはそのままに、モードを切り替える

ログオン中のユーザは、ページタイトル部分が赤くなることで、メンテナンスモードに入ったことがわかります。

メンテナンスモードに切り替える

「現在の状態」を「メンテナンスモード」に変更します。
メンテナンスモードが設定されるとタイトル部が赤く表示され、一目でメンテナンスモードであることが分かります。(図3,図4)

メンテナンスモードに入った状態
その他の画面でもタイトル部が赤く表示される

操作の制限

メンテナンスモード時、管理者権限以外のユーザでログオンしようとすると、図5の画面が表示されます。 管理者権限以外のユーザがすでにログオンしていた場合も接続が強制的に解除されているため、継続して操作しようとすると、同様に図5の画面が表示されます。

システムがメンテナンスモードになっていることを示すメッセージ
メンテナンスモード中は一般ユーザは操作できなくなります。メンテナンスモードで「新規のログオンは許可しないが、ログオン中のアカウントの操作は許可する」といったことはできません。

時間指定でメンテナンスモードに切り替える

メンテナンスモードへ入るためのジョブを利用します。詳細は「ジョブ管理 > メンテナンスモードを有効にする」をお読みください。

表示メッセージを変更する

メンテナンスモード時のメッセージが記述されたファイルは $(DEVHOME)\env\webpage\system\underMaintenance.html として用意されています。 同ファイルを修正し、再ビルドするとオリジナルのメンテナンスモード画面を用意することができます。

すでに稼働中の Web アプリケーションに対して変更を行う場合は、wagbyapp\webapps\$(APPNAME)\system\underMaintenance.html を直接、修正してください。

起動時にメンテナンスモードを有効にする 8.5.2

Windows OS

wagbyapp\bin\setenv.bat に次のように記載することで、Tomcat起動時にメンテナンスモードを有効にすることができます。

CATALINA_OPTS=..(省略).. "-Duser.timezone=Asia/Tokyo" "-Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false" "-Dwagby.startupmode=maintenance"

末尾に wagby.startupmode=maintenance を加えています。ダブルクォーテーションで囲んでください。

Unix OS

wagbyapp\bin\setenv.sh に次のように記載することで、Tomcat起動時にメンテナンスモードを有効にすることができます。

CATALINA_OPTS=..(省略).. -Duser.timezone=Asia/Tokyo\ -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false\ -Dwagby.startupmode=maintenance

末尾に wagby.startupmode=maintenance を加えています。-D 指定の前にバックスラッシュを含めることを忘れないでください。

application.propertiesによる指定

上の環境変数の指定とは別に、application.propertiesに記述することもできます。

再起動時の動作

Wagbyアプリケーションを再起動したとき、メンテナンスモードの状態は常に「通常モード」になります。(前回の状態を記憶しません。)

メンテナンスモードの状態で再起動したい場合は「起動時にメンテナンスモードを有効にする」で説明したようにパラメータを追加してください。

オートスケール環境での動作 8.3.1

オートスケール環境でメンテナンスモード切り替えを行なった場合、次の動作となります。

  1. 画面操作したインスタンスでメンテナンスモードが切り替えられる。
  2. 他のインスタンスへ、メンテナンスモードを切り替えるようメッセージが発信される。(メッセージキューを経由する)
  3. 他のインスタンスは(メッセージを受け取ったのち)切り替えられる。

時間指定ジョブによるメンテナンスモード切り替えも、オートスケールに対応しています。