Web巡回・通知システム 使用ガイド.html

Web巡回・通知システム 使用ガイド

Web巡回・通知システム 使用ガイド

このガイドでは、Web巡回・通知システムの基本的な操作方法と機能について説明します。

1. トップページ

システムのダッシュボードとして機能します。以下の情報が表示されます。

  • 各管理ページ(ユーザー、ホームページ、巡回履歴)へのリンクボタン。
  • **巡回・通知 自動実行制御**: Cronによる自動巡回と通知のON/OFFを切り替えるボタン。
    • 「巡回・通知 自動実行を開始」: 自動実行を有効にします。
    • 「巡回・通知 自動実行を停止」: 自動実行を一時的に無効にします。
    • **重要**: この設定はデータベースに保存され、Cronジョブが実行されるたびに確認されます。
  • **Cronログ (リアルタイム更新)**: バックエンドのCronジョブによる巡回スクリプトの実行ログをリアルタイムで表示します(5秒ごとに更新)。
    • 実際に巡回が実行されたサイトの情報や、Chatwork通知の有無などが表示されます。
    • 間隔未達でスキップされた巡回はログに表示されません。
    • Cronが停止中の場合は、その旨のみがログに表示されます。

2. ユーザー管理

Chatwork通知を受け取る担当者ユーザーを管理します。

2.1. ユーザー一覧

  • 登録されているユーザーが一覧で表示されます。
  • 「新しいユーザーを追加」ボタンから新規登録フォームへ移動できます。
  • 各ユーザーの行にある「編集」ボタンから編集フォームへ移動できます。
  • 各ユーザーの行にある「削除」ボタンからユーザーを削除できます。
    • **注意**: ユーザーに紐づくホームページが存在する場合、そのユーザーは削除できません。先に紐づくホームページを非アクティブ化または削除してください。

2.2. 新しいユーザーを登録

通知を受け取る担当者の情報を入力します。

  • **名前**: 担当者の名前を入力します。
  • **Chatwork通知設定**:
    • **社内通知(共通API利用)**: システム共通のChatwork APIトークンを使用して通知します。この場合、APIトークン入力欄は `****` と表示され、編集できません。
    • **個別API利用**: このユーザー専用のChatwork APIトークンを使用して通知します。APIトークン入力欄が入力可能になります。
  • **ChatworkルームID**: 通知を送るChatworkルームのIDを入力します。
    • **個人通知の場合(推奨)**: 担当者ご自身のマイチャットを開き、ブラウザのURL (例: https://www.chatwork.com/#!ridXXXXXXXXX) の**数字部分**がルームIDです。
    • **グループ通知の場合**: 通知を送りたいグループチャットを開き、ブラウザのURL (例: https://www.chatwork.com/#!ridYYYYYYYYY) の**数字部分**がルームIDです。
  • **アクティブ**: このユーザーからの通知を有効にするかどうかを設定します。

2.3. ユーザーを編集

既存のユーザー情報を更新します。

  • 入力欄の初期値は現在のユーザー情報が表示されます。
  • **Chatwork通知設定**:
    • 「社内通知」ユーザーの場合、APIトークンは `****` で編集不可です。
    • 「個別API利用」ユーザーの場合、APIトークンが表示され編集可能です。
    • 「社内通知」に切り替えて更新すると、APIトークンは `****` に戻ります。
    • 「個別API利用」に切り替えてトークンを入力すると、そのトークンが保存されます。
  • その他のフィールドも同様に更新できます。
  • 「更新」ボタンで変更を保存します。

3. ホームページ管理

巡回対象のWebサイトを管理します。

3.1. ホームページ一覧

  • 登録されているホームページが一覧で表示されます。
  • **表示フィルター**: 画面上部のラジオボタンで、表示するホームページを「アクティブのみ」「非アクティブのみ」「すべて表示」で切り替えられます。デフォルトは「アクティブのみ」です。
  • 「新しいホームページを追加」ボタンから新規登録フォームへ移動できます。
  • 各ホームページの行にある「詳細/編集」ボタンから詳細/編集フォームへ移動できます。

3.2. 新しいホームページを登録

巡回させたいWebサイトの情報を入力します。

  • **担当ユーザー**: Chatwork通知を受け取る担当者を選択します。
  • **URL**: 巡回対象のWebサイトのURLを入力します。
  • **名前**: Webサイトを識別するための名前を入力します。
  • **巡回間隔 (分)**: 通常時に何分おきに巡回するかを設定します(デフォルト: 60分)。
  • **エラー時再試行間隔 (分)**: エラー検出後に何分おきに再試行するかを設定します(デフォルト: 5分)。
  • **通知までの最大再試行回数**: エラーが何回連続した場合にChatworkに通知するかを設定します(デフォルト: 1回。0は初回エラーで即通知)。
  • **アクティブ**: 巡回を有効にするかどうかを設定します。チェックを外すと巡回対象から一時的に除外されます。

3.3. ホームページ詳細/編集

既存のホームページ情報を更新します。

  • 入力欄の初期値は現在のホームページ情報が表示されます。
  • 各設定(URL、巡回間隔など)を変更し、「更新」ボタンで保存します。
  • **アクティブ/非アクティブの切り替え**: 「アクティブ」チェックボックスの状態を変更して更新することで、巡回対象に含めるか含めないかを制御できます。
  • **ホームページの非アクティブ化**:
    • ページ下部の「非アクティブ化」ボタンをクリックすると、ホームページが巡回対象から除外されます。
    • **重要**: この操作はデータベースからホームページのレコードを物理的に削除するのではなく、is_activeフラグをFalseに設定する論理削除です。そのため、関連する巡回履歴は保持されます。

4. 巡回履歴

Webサイトの巡回結果の履歴を表示します。

4.1. 巡回履歴一覧

  • すべての巡回履歴が新しい順に表示されます。
  • 表示される情報: ID、ホームページ名、確認日時、HTTPステータス、成功/失敗、Chatwork通知済、操作。
  • 「ホームページ名」をクリックすると、そのホームページの詳細/編集ページへ移動できます。