設計情報

投稿者: SPIRERS ナレッジ向上チーム 2023年9月25日 (月)

ログイン制限を使用してメンテナンス画面を表示する方法

認証エリアのログイン制限機能で条件を設定することで、認証エリアにログインできる会員を制限することができます。
この機能を使用して、会員サイトなどのシステムメンテナンス時にログインをできないようにし、メンテナンスのお知らせ画面を表示する方法を紹介いたします。

注意点

クリックログインURL認証APIのワンタイムURLからのアクセスでログイン制限に引っかかった場合は、エラーページ(403 Forbidden)が表示されます。
任意のページに変更することはできません。
ログイン制限に引っかかった場合の遷移先については、ログイン制限によりログインを制限している場合の挙動についてをご確認ください。

設定方法

ログイン制限を設定する
認証エリアを開き、歯車マークをクリックして認証エリア設定を開きます。
今回は認証DBに「テストデータフラグ」フィールドを追加し、テストデータと設定されているユーザ以外はログインをできないように設定します。
▼テストデータフラグ
表示名 識別名 タイプ 詳細設定
テストデータフラグ testDataFlg セレクト 【セレクト項目】
1:テストデータ
メンテナンス用ブロックを作成する
フリーコンテンツブロックを使用して、メンテナンス用のブロックを作成します。 フリーコンテンツブロックの作成方法や、ビジュアル設定での操作については下記の記事やサポートサイトを参考にしてください。
動画で学ぶ SPIRAL ver.2 基本機能 ~【サイト管理】フリーコンテンツブロック ~
サポートサイト フリーコンテンツブロック
メンテナンスお知らせブロックを設置する
設置が必要なページは最大で下記の3ページです。
・ログインページ
ログインフォームを非表示にし、メンテナンスお知らせブロックを設置します。
・セッションエラーページ
既にログイン中のユーザーがログイン制限によってはじかれた場合、メンテナンス画面を表示するために、メンテナンスお知らせブロックを設置します。
デフォルトではセッションエラーページはログインページに設定されています。
ログインページを変更していない場合は、ログインページ=セッションエラーページとなるため設置は不要です。
・パスワード再登録ページ
パスワード再登録もログイン制限の対象となるため、パスワード再登録ページを作成している場合はメンテナンスお知らせブロックを設置します。
設置方法(ビジュアル設定のページの場合)
「ブロック設定」タブの「+」ボタンから「フリーコンテンツ」を選択し、 既存フリーコンテンツ選択から作成したメンテナンス用お知らせブロックを追加します。
既存のブロックのゴミ箱アイコンをクリックしてページから除外します。(ブロック自体は削除されません。)
除外したブロックはメンテナンス解除時に戻すため、ブロックの表示名と識別名はメモしておくことを推奨します。
設置方法(ソース設定のページの場合)
「body」タブの「+」ボタンから「フリーコンテンツ」を選択し、 既存フリーコンテンツ選択から作成したメンテナンス用お知らせブロックを追加します。
既存のブロックの記述は削除せずに、
<!-- <sp:block name="xxb0XXXX"></sp:block> -->
のようにコメントアウトすることで、メンテナンス解除時にブロックを再度追加する手間を省くことができます。
チェック&リリース
これまでの設定が完了したら、テスト環境でログイン制限が正しく機能しているか、メンテナンスお知らせブロックが正しく表示されるかなどをチェックのうえ、リリースをしてください。
解決しない場合はこちら コンテンツに関しての
要望はこちら