プロパティ

• 目的・用途

本機能は、アイテムタイプのメタデータが持つプロパティを管理する機能である。新規登録、および保存済みプロパティの更新ができる。

• 利用方法

【Administration > アイテムタイプ管理（Item Types） > プロパティ（Properties）画面】にて操作する。

• 利用可能なロール

• 機能内容

• 【Administration > Item Types > Properties画面】：プロパティを新規登録、保存済みプロパティを更新する画面である

• プロパティを追加する

  • 【Administration > Item Types > Properties画面】にプロパティを新規登録できる

  • 入力項目は以下の通りである

    • 「プロパティ名」（Property Name）テキストボックス
      
      プロパティ名を入力する

    • 「+Add」ボタンを押すことで、プロパティ属性の入力エリアを表示する

      • 項目名のテキストエリア

        • デフォルト：空白

      • 入力形式プルダウン

        • デフォルト：「Text」

        • 「Text」：1行のテキストで値を入力する

        • 「Textarea」：複数行のテキストで値を入力する

        • 「Checkboxes」：複数選択のチェックボックスで値を入力する

        • 「Radios」：単一選択のラジオボタンで値を入力する

        • 「Select」：単一選択のプルダウンメニューで値を入力する

        • 「Datetime」：以下の形式で値を入力する

          • yyyy-mm-dd、yyyy-mm、yyyy形式で入力

          • エリアフォーカス時に表示するカレンダーで日付を選択して入力する

        • 「List」：複数の項目を繰り返し入力できる。入力項目がセットになっている
          
          例：「権利者情報」プロパティの「権利者識別子」が該当する

        • 「Object」：複数の項目を入力する。入力項目がセットになっている
          
          例：「作成者」プロパティの「作成者所属」が該当する

        • 注意事項

          • 入力形式で、「Checkboxes」、「Radios」、または「Select」を選択した場合、選択肢入力欄が表示される。選択肢入力欄には、各選択肢を「|」（半角パイプ）区切りでする
            
            例：AAA|BBB|CCC

          • また、選択式(プルダウン)を選択した場合、選択肢を選択した後未選択状態に戻るため、選択肢の先頭に空白が追加される

    • 入力が必須な属性を設定できるように、「Required」チェックボックスを設ける

    • 「JSONスキーマ」（Json Schema）ボタンを押すと、設定したプロパティ情報が、項目の下のテキストエリア、「フォーム(単数)」（Form(Singular)）及び「フォーム(複数)」（Form(Multiple)）にJSON形式で表示する

      • 注意事項

        • システムプロパティとして追加する場合、該当subitemに「"system_prop" : true 」を追加する

          • 課金ファイルのプロパティとして追加する場合、該当subitemに「"billing_file_prop":true」を追加する

        • 入力形式で、「Checkboxes」、「Radios」、または「Select」を選択した場合、該当subitemに「"editAble": true」を追加することで［Meta］画面に選択肢を編集できるようになる

    • 項目の下のテキストエリアに直接設定した後、「リセット」（Reset）を押すと、設定した内容がプロパティ情報に反映される

  • 「保存」（Save）ボタンを押すと、プロパティを追加し、メッセージを表示する
    
    メッセージ：「Saved property successfully.」

  • プロパティIDは、item_type_propertyテーブルでシーケンスのnextvalによって払い出される。

• プロパティを編集する

  • 【Administration > Item Types > Properties画面】に保存されたプロパティを更新できる

  • 保存されたプロパティのプルダウンを画面の上部に設ける

  • プロパティのプルダウンからプロパティを選択すると、プロパティの情報を表示する

  • プロパティの情報を編集してから、「保存」（Save）ボタンを押すと、プロパティの情報を更新し、メッセージを表示する
    
    メッセージ：「Saved property successfully.」

  • 注意事項

    • 編集不可として、プルダウンに表示されないプロパティがある。

      • システムプロパティ（subitemに「"system_prop" : true 」が含まれるもの）は表示されない。

      • 課金ファイルをプロパティ画面に表示しない設定であるとき、課金ファイルのプロパティ（subitemに「"billing_file_prop":true」が含まれるもの）は表示されない。

各プロパティの構成

• ファイル

  • アイテム登録画面でファイルをアップロードすると、表示名、フォーマット、サイズを自動設定する

  • アップロードしたファイルのフォーマット・ファイルサイズをDBに格納する
    
    **Meta画面のAllow Multipleのオプションはオンに設定し非活性

• 課金ファイル

  • コンテンツのアクセスを「ログインユーザのみ」とした場合、グループと金額を入力するエリアを表示する

  • グループと金額は複数設定でき、[New]ボタン押下で追加できる

  • 削除時は[×]ボタンで削除する(他の要素と同じ仕様にする)

  • アイテム登録画面でファイルをアップロードすると、表示名を自動設定する

  • アップロードしたファイルのフォーマット・ファイルサイズをDBに格納する

  • Meta画面のAllow Multipleのオプションはオンに設定し非活性

• サムネイル

  • サムネイルプロパティがアイテムタイプに含まれていると、アイテム登録時にサムネイルアップロードエリアが表示される

  • オプションHideのチェックがオフの場合に、アイテム詳細画面でサムネイル画像が表示される

• 作成者

  • 作成者識別子SchemeをID Prefixから自動で取得する (v2.0.0)

  • 作成者識別子と作成者識別子Schemeから自動設定されるため、作成者識別子URIは非活性項目になっている

  • アイテム詳細画面でリンク形式（押下後ポップアップ）として表示される

• 寄与者

  • 寄与者識別子SchemeをID Prefixから自動で取得する (v2.0.0)

  • 寄与者識別子と寄与者識別子Schemeから自動設定されるため、寄与者識別子URIは非活性項目になっている

• 権利者情報

  • 権利者識別子SchemeをID Prefixから自動で取得する (v2.0.0)

  • 権利者識別子と権利者識別子Schemeから自動設定されるため、権利者識別子URIは非活性項目になっている

• 書誌情報

  • アイテム詳細画面で巻・号・ページ数などをまとめて表示する

• 資源タイプ

  • 資源タイプ識別子が非活性項目になっている

  • 資源タイプを選択すると、対応する資源タイプ識別子が自動で設定される

• ID登録

  • 非活性項目になっている

  • ワークフローの IdentifierGrant を経てアイテム登録が完了後、編集画面で入力された値を確認できる

• 出版タイプ

  • 出版タイプresourceが非活性項目になっている

  • 出版タイプを選択すると、対応する出版タイプresourceが自動で設定される

• アクセス権

  • アクセス権URIが非活性項目になっている

  • アクセス権を選択すると、対応するアクセス権URIが自動で設定される

• 識別子

  • OAI-PMH出力として用意されているもの

  • メタデータのエリアには表示せず、Permalink欄に「DOI > HDL > URI」の優先順で表示する（永続識別子）

• 公開日

  • WEKO3のアイテムの表示／非表示として管理しているもの

  • アイテム登録時の必須項目であり、アイテム詳細画面に表示される

  • 「Hide」オプションの制御に従って、アイテムの「公開日」をOAI-PMH出力する

• 関連モジュール

• weko-itemtypes-ui

• 関連テーブル

• 画面の一番上のプルダウン：item_type_propertyテーブルから取得したプロパティ一覧

  • １つプロパティを選択する場合、item_type_propertyテーブルから該当のプロパティの情報を読み取る。

• 画面の「保存」ボタンを押下する場合、画面に設定している情報をitem_type_propertyテーブルの該当プロパティに反映する。

• 処理概要

• HTMLテンプレート

  • パス: https://github.com/RCOSDP/weko/blob/hfix/modules/weko-itemtypes-ui/weko_itemtypes_ui/config.py#L33-L35　

    • 設定キー: WEKO_ITEMTYPES_UI_ADMIN_CREATE_PROPERTY = \
      
      'weko_itemtypes_ui/admin/create_property.html'
      
      """Create property template."""

• 課金ファイルをプロパティ画面に表示する・しないかの設定

  • パス: https://github.com/RCOSDP/weko/blob/hfix/modules/weko-itemtypes-ui/weko_itemtypes_ui/config.py#L57-L58

    • 設定キー: WEKO_BILLING_FILE_ACCESS = 1
      
      """Show billing file property in list."""
      
      1: システム管理者のユーザーID。
      
      1のみ表示する。1以外、プロパティ画面に表示しない。

• 課金ファイルのプロパティであるかどうか判断するための設定

  • パス: https://github.com/RCOSDP/weko/blob/b81efc2b8d1b3af838c0910798050c25a19f1f41/modules/weko-itemtypes-ui/weko_itemtypes_ui/config.py#L60-L61

    • 設定キー: WEKO_BILLING_FILE_PROP_ATT = 'billing_file_prop'
      
      """Attribute to detect billing file property."""
      
      （課金ファイルをプロパティ画面に表示する・しない時に合わせて利用される。）

• システムプロパティであるかどうか判断するための設定

  • パス: https://github.com/RCOSDP/weko/blob/hfix/modules/weko-itemtypes-ui/weko_itemtypes_ui/config.py#L63-L64

    • 設定キー: WEKO_ITEMTYPES_UI_DEFAULT_PROPERTIES_ATT = 'system_prop'
      
      """Attribute to detect property is default property which is not shown at properties screen."""

• 更新履歴