RSS

• 目的・用途

本機能は、WEKO RSS配信新着情報を取得し、インデックス単位で購読が可能となる機能である。

• 利用方法

インデックス検索を行った際、検索結果のインデックスに対応するRSSアイコンを押下することで、WEKO RSS配信新着情報を取得し、該当アイテム一覧のRSSを出力できる。
また、新着アイテムのウィジェットが設定されている画面にアクセスした際に、画面に表示されているRSSアイコンを押下することで、該当アイテム一覧のRSSを出力できる。

• 利用可能なロール

• 機能内容

• インデックス検索をした際に表示されるトップページ画面［トップ（Top）］タブ内の［インデックスリスト(Index List）］エリアに、RSSアイコンを表示する設定としているインデックスが表示された時、当該インデックスの右側にRSSアイコンを表示する。

  • RSSアイコンの表示設定は【Administration > インデックスツリー管理 > ツリー編集（Edit Tree）画面】で行う。設定についてはADMIN-3-1: ツリー編集を参照。

    • RSSアイコンのデフォルト表示設定：非表示

新着アイテムのウィジェットが設定されており、RSS配信を行う設定である場合、［新着アイテムウィジェット］エリア内右上にRSSアイコンを表示する。

• 新着アイテムのウィジェット、RSS配信の設定は【Administration > ウェブデザイン管理 > ウィジェット　画面】で行う。設定についてはADMIN-4-1: ウィジェットを参照。

  • RSS配信のデフォルト設定：配信しない

RSSアイコンを押下すると、WEKO RSS配信情報を取得し、該当アイテム一覧のRSSを出力する。

• RSSの文書は、ブラウザの別タブに表示する。

• RSS文書には、以下の情報を記載する。

  • タイトル（WEKO3）

  • RSS文書のリンク

  • （インデックスが指定されている場合）当該インデックスに設定されているコメント

    • 当該インデックスにコメントが設定されていない場合は、インデックスの名前

    • インデックスが指定されていない場合はサイト名（WEKO3）

  • RSSで配信するデータを取得した日時

  • 条件に合致するアイテムの登録データ

    • インデックス検索結果で表示されているRSSアイコンを押下した場合、対応するインデックスの配下に登録されているアイテムのデータを設定されている条件で取得し、表示する。

      • UIから登録アイテムのデータを取得する条件を変更することはできない。

      • デフォルト設定は、選択したインデックスの配下に存在するアイテム検索結果のうち、2週間前以降に登録されたアイテムデータを20件まで取得し、言語データは英語を取得することとする。

    • 新着アイテムウィジェットで表示されているRSSアイコンを押下した場合、【Administration > ウェブデザイン管理 > ウィジェット　画面】で設定した日数前の日時以降に登録されたアイテムのデータを、設定した表示件数まで取得し表示する。

    • アイテムの登録データとして表示するのは以下の項目とする。

      • 論文情報

      • アイテムタイトル

      • パーマリンク

      • rdfへのURL

      • 著者名

      • 出版社

      • 雑誌名

      • ISSN

      • 巻

      • 号

      • 開始ページ

      • 終了ページ

      • 発行年月日

      • 抄録

      • 発行年月日

• 対応するインデックスの配下に登録されているアイテムの各項目は、対応する登録データがない場合は空タグとして表示する。

• 関連モジュール

• weko_index_tree：RSS出力するデータを取得する

• weko_records：検索結果をRSS形式にシリアライズする

• weko_gridlayout：RSS形式のデータをXMLフォーマットでビルドする

• weko_search_ui：検索結果をUIに表示する

• weko_schema_ui：検索用のJPCOARスキーマのマッピングを行う

• weko_items_ui

• weko_theme：ウィジェットのテンプレートを作成する

• 処理概要

• インデックス検索をした際に表示されるトップページ画面［トップ（Top）］タブ内の［インデックスリスト(Index List）］エリアに、RSSアイコンを表示する設定としているインデックスが表示された時、当該インデックス配下に登録されているアイテムの情報を配信するRSSアイコンを表示する。

• 新着アイテムのウィジェットが設定されており、RSS配信を行う設定である場合、［新着アイテムウィジェット］エリア内右上に新着アイテムの情報を配信するRSSアイコンを表示する。

• RSSアイコンを押下すると、それぞれ対応するapiリクエストを送信することで該当するアイテムの登録データを取得し、RSS文書として別タブに出力する。

• WEKO RSS配信新着情報取得APIについて

  • ［インデックスリスト（Index List）］エリアに表示されるRSSアイコンの押下で呼び出すAPIと、［新着アイテムウィジェット］エリアに表示されるRSSアイコンの押下で呼び出すAPIは異なる。

  • エンドポイント（URI）

    • ［インデックスリスト（Index List）］エリアのRSS

/api/rss.xml

• ［新着アイテムウィジェット］エリアのRSS

/rss/records

• RSSのバージョンは1.0に対応することとする。

• リクエストパラメータ

  • RSS配信を行う新着アイテム情報の取得に用いるパラメータを、表 1-6‑1に示す。

表 1-6‑1 WEKO RSS配信を行う新着アイテム情報取得に用いるパラメータ

• ［インデックスリスト（Index List）］エリアでの RSS配信時にアイテム情報を取得するリクエストパラメータについて

  • パラメータはindex_id, page, count, term, langの5項目とする。

  • 各パラメータのデフォルト値はweko_index_tree/config.pyで設定し、変更可能とする。
    パス：
    https://github.com/RCOSDP/weko/blob/v0.9.22/modules/weko-index-tree/weko_index_tree/config.py#L69-L82

  • 選択されたインデックスのインデックスIDをパラメータindex_idに設定し、他のパラメータはデフォルト値を設定する。

  • 表示件数の設定値の上限はweko_index_tree/config.pyで設定し、変更可能とする。

    • 表示件数の設定値の上限の値は100とする。

WEKO_INDEX_TREE_RSS_COUNT_LIMIT = 100

• 指定されたインデックスの配下のインデックスもデータの取得対象に含める。

• ［新着アイテムウィジェット］エリアでのRSS配信時にアイテム情報を取得するリクエストパラメータについて

  • termの値は【Administration > ウェブデザイン管理 > ウィジェット　画面】の「New date」の値を使用する。

  • countの値は新着ウィジェットの「Display Results」の値を使用する。

• 取得したアイテムデータをRSS文書に出力するための処理は、［インデックスリスト(Index List）］エリアのRSSアイコンを押下した場合も［新着アイテムウィジェット］エリアのRSSアイコンを押下した場合も共通であり、weko_gridlayout/utils.pyのbuild_rss_xmlで行っている。

• レスポンスフォーマット
  【ソートキー】
  　第1ソートキー： 公開日
  　第2ソートキー： タイトル

• 新着アイテムのRSSの配信仕様は、別紙「新着アイテムのRSSの配信仕様.xlsx」を参照。RSS表示条件

  • アイテムが直接紐づいているインデックスとその上位のインデックスについて、１つでも非公開の設定のものがある場合の挙動は表 1-6‑2の通りである。

表 1-6‑2 非公開のインデックスに紐づくアイテムのRSS表示

• 登録されているアイテムが非公開の場合、当該アイテム登録者もしくは管理者ユーザーがRSS出力操作を行った際にのみ、アイテム情報は出力される。

• 更新履歴