サイトライセンス

• 目的・用途

本機能は、サイトライセンスユーザーによる操作ログの集計、解析を行い、その結果をサイトライセンス管理者にメールで送信する機能である。

• 利用方法

【Administration > 統計（Statistics） > サイトライセンス（Site License）画面】にて操作を行う。

• 利用可能なロール

• 機能内容

• 【Administration > 統計（Statistics） > サイトライセンス（Site License）画面】にてサイトライセンスの集計メール送信設定を管理する

  • 表示項目は以下の通りである

    • サイトライセンス機関

      • 【Administration > 設定（Setting） > サイトライセンス（Site License）画面】に登録された機関名のリストを表示し、チェックボックスを用意する

        • 機関名の表示情報は以下の通りである

          • 「Organization」：機関名

          • 「メールアドレス」（Email Address）

      • リポジトリ管理者は、送信したい機関にチェックボックスでチェックできる

      • 初期値は全てのチェックボックスにチェックがついていない状態とする

      • 選択状態を変更すると、［保存（Save）］ボタンを押すまで［メール手動送信（Manual Send）］ボタンが非活性になる

    • 「Automatic Send」

      • 自動送信を「送信／無効」（Enable／Disable）のラジオボタンを設ける

      • ラジオボタンの初期値は「無効」（Disable）とする

      • 送信する期間（from-to）はコンフィグで設定し、初期値は１ヶ月分（先月）とする。
        例：7月にメールを送信する場合は、6月分のデータを集計して送信する

      • 選択状態を変更すると、［保存（Save）］ボタンを押すまで［メール手動送信（Manual Send）］ボタンが非活性になる

    • 「メール手動送信」（Manual Send）

      • 画面上に集計年と月を設定するプルダウンを表示し、年月を選択できる

      • 集計月は単月以外も集計できるようにfromとtoをそれぞれ設定する

      • from-toの初期値は１ヶ月分（先月）とする。たとえば、2019年7月に本画面を開いた場合は、from-toの初期値は「2019/06 - 2019/06」となる

      • ［メール手動送信（Manual Send）］ボタンを押すと、メール送信確認ダイヤログを表示する
        確認メッセージ：「Are you sure you want to send an email?」

        • ［Confirm］ボタンを押すと、後述の送信時の処理に従って、対象機関にメールを発信する

        • ［閉じる（Close）］ボタンを押すと、ダイヤログを閉じる

    • ［保存（Save）］ボタンを押すと、設定内容を保存し、メッセージを表示する
      メッセージ：「Update successfully」

    • 送信時の処理(v0.9.22)

      • 宛先：チェックした機関のメールアドレス

      • 件名：[○○機関リポジトリ]YYYY.MM-yyyy.mm statistics report
        ※YYYY.MMは集計月(from), yyyy.mmは集計月(to)を表示

      • メールのテンプレート： https://github.com/RCOSDP/weko/blob/v0.9.22/modules/weko-admin/weko\_admin/templates/weko\_admin/email\_templates/site\_license\_report.html

      • 本文：サイトライセンス利用統計の内容

        • WEKO Top Page Access Count

        • Number Of Searches

        • Number Of Views

        • Number Of File download

        • Number Of File Regeneration

    • 送信時の処理(※)

      • ※0.9.22には取り込まれていないが、メールの内容が既存の機能仕様書の通りになるよう修正されているので、以下に既存の機能仕様を残しておく。

      • 宛先：チェックした機関のメールアドレス

      • 件名：[○○機関リポジトリ]YYYY.MM-yyyy.mm 利用統計レポート
        ※YYYY.MMは集計月(from), yyyy.mmは集計月(to)を表示

      • メールのテンプレート： サイトライセンス利用統計メールひな形.docx

      • サイトライセンス利用統計の内容

• 関連モジュール

• weko-admin

• invenio-stats：サイトアクセスレポートを取得する

• invenio-mail：メールを送信する

• 処理概要

画面表示したとき、［保存（Save）］ボタンを押したときの処理は、以下で行う。

• パス：https://github.com/RCOSDP/weko/blob/v0.9.22/modules/weko-admin/weko_admin/admin.py

• SiteLicenseSendMailSettingsViewクラスのindexメソッド

  • ［保存（Save）］ボタンを押したときは、画面からPOSTで呼び出される。POSTで呼ばれたときに限り、データの更新を行う。

    • 「Automatic Send」ラジオボタンの選択状態によって、admin_settingsテーブルの、nameが「site_license_mail_settings」であるレコードを更新する。

    • サイトライセンス機関のチェック状態によって、sitelicense_infoテーブル各行のreceive_mail_flagカラムを更新する。

  • POSTで呼ばれたときのデータ更新後、およびGETで呼ばれたとき、以下の情報を取得する。

    • サイトライセンス機関の情報として、sitelicense_infoテーブルのレコード全件（organization_id昇順）

    • 自動送信設定として、admin_settingsテーブルの、nameが「site_license_mail_settings」であるレコード

    • メール手動送信の集計月の初期値として、「現在のUTC日付のdayを1にした日付の前日」のdayを1にした日付

  • 呼び出し元の画面では、POSTの結果にかかわらず、画面を更新する。

［メール手動送信（Manual Send）］ボタンを押したときの処理は、以下で行う。

• パス：https://github.com/RCOSDP/weko/blob/v0.9.22/modules/weko-admin/weko_admin/views.py

• manual_send_site_license_mailメソッド

  • sitelicense_infoテーブルから、receive_mail_flagの値が「T」であるレコード全件を取得する。

  • レコードが取得できたら、以下の処理を行う。

    • 集計月の入力値より、fromの月の1日を「start_date」、toの月の最終日を「end_date」とする。

    • QueryCommonReportsHelper.getメソッドによって、サイトアクセスレポートを取得する。

    • 取得したサイトアクセスレポートを用いて、send_site_license_mailメソッドでサイトライセンス機関のメールアドレスに対してメールを送信する。

      • サイトライセンス機関のアクセスレポートが取得できなかった場合は、各項目を０件とする。

    • 送信が失敗した場合は、エラーログを出力する。送信結果にかかわらず、’finish’を返す。

• 更新履歴