一括出力
目的・用途
本機能は、著者DBの情報を一括出力する機能である。
利用方法
本画面にある [エクスポート(Export)] ボタンを押下することで、著者DBに登録されている著者情報をtsvファイルで出力する。
tsvファイルのダウンロードURLにアクセスすることでtsvファイルを取得することができる。
利用可能なロール
ロール | システム 管理者 |
リポジトリ 管理者 |
コミュニティ 管理者 |
登録ユーザー | 一般ユーザー | ゲスト (未ログイン) |
---|---|---|---|---|---|---|
利用可否 | ○ |
機能内容
(1) 一括出力画面の画面構成
【Administration > 著者DB管理(Author Management) > 一括出力(Export)】 を選択すると表示される。
画面構成は以下の通り
全件エクスポート(Export all creator)
ダウンロードURL(Download URL)
全件エクスポート(Export all creator)
全件エクスポートを実行する。以下の2種類のボタンがある。
[エクスポート(Export)] ボタン
ボタンを押下すると、以下のポップアップのメッセージとボタンが表示される
- 「著者DBの全件エクスポートを実行してよいですか?(Are you sure you want to export all creator?)」
[実行(Execute)] ボタン:著者DBの全件エクスポートを実行し、自画面に戻る
[キャンセル(Cancel)] ボタン:何も処理はせずに自画面に戻る
- 「著者DBの全件エクスポートを実行してよいですか?(Are you sure you want to export all creator?)」
著者DBの全件エクスポート実行中は、ボタンは非活性となる
[キャンセル(Cancel)] ボタン
- 著者DBの全件エクスポートを中断する。エクスポート実行中以外は非活性である。
著者DBの全件エクスポート実行中にボタンが活性化される。ボタンを押下すると、以下のポップアップのメッセージとボタンが表示される。
「メッセージ」
日本語:著者DBの全件エクスポートの処理をキャンセルしてよいです か?
英語:Are you sure you want to cancel process of exporting all creator?
「ボタン」
[実行(Execute)] ボタン:著者DBの全件エクスポートを中断し、自画面に戻る。
[キャンセル(Cancel)] ボタン:中断はせずに自画面に戻る(全件エクスポート処理を継続する)。ダウンロードURL(Download URL)全件エクスポートが完了すると、出力ファイル(tsv形式)をダウンロードできるURLが表示される
最後に出力されたダウンロードURLが表示される(初期の全件エクスポート実行前は何も表示されない)
ダウンロードのURLの例(初期値)としては以下の通り(出力ファイル名はConfigで設定できるものとする)
- (2) 出力ファイル
全件エクスポートされたファイルはtsv形式で出力される。
tsvファイルの構成は以下の通り
ヘッダ行
ラベル(英語)
ラベル(日本語)
データ行(著者1)
データ行(著者2)
…
文字コードはUTF-8(BOM付き),改行コードはCR+LFとする。
1行目はヘッダ行とし、システム管理するものである。先頭に"#"が付いている。
2行目と3行目はラベルを表示し、TSV入力の補助をする。先頭に"#"が付いている。
4行目以降に著者の情報を出力する。1著者の情報を1行で出力する。
- 各ヘッダの情報は以下の通り
# | ヘッダ項目 | ラベル(日本語) | ラベル(英語) | 概要 |
---|---|---|---|---|
1 | pk_id | WEKO ID | WEKO ID | WEKO3の著者ID(author_link)を出力する |
2 | authorNameInfo[0...n].familyName | 姓[0...n] | Family Name[0...n] | 著者の姓を出力する |
3 | authorNameInfo[0...n].firstName | 名[0...n] | Given name[0...n] | 著者の名を出力する |
4 | authorNameInfo[0...n].language | 言語[0...n] | Language[0...n] | 著者の言語を出力する |
5 | authorNameInfo[0...n].nameFormat | フォーマット[0...n] | name Format[0...n] | 著者の姓名のフォーマットを出力する ※現状(SP67時点)は「familyNmAndNm」固定 |
6 | authorNameInfo[0...n].nameShowFlg | 姓名・言語 表示/非表示[0...n] |
Name Display[0...n] | 著者の姓名と言語の表示/非表示を出力する 表示する: "Y" 表示しない: "N" |
7 | authorNameInfo[0...n].idType | 外部著者ID 識別子[0...n] | Identifier Scheme[0...n] | 外部著者IDの識別子を出力する |
8 | authorNameInfo[0...n].authorId | 外部著者ID URI[0...n] | Identifier URI[0...n] | 外部著者IDの値を出力する |
9 | authorNameInfo[0...n].authorIdShowFlg | 外部著者ID 表示/非表示[0...n] |
Identifier Display[0...n] | 外部著者IDの表示/非表示を出力する 表示する: "Y" 表示しない: "N" |
10 | emailInfo[0...n].email | メールアドレス[0...n] | Mail Address[0...n] | 著者のメールアドレスを出力する |
11 | is_deleted | 削除フラグ | Delete Flag | 著者を削除する場合に "D" と出力する ※論理削除された著者情報は出力しないため、全件エクスポートではすべて空欄となる |
【補足】
・同じ項目名を複数持つ場合は、各項目名の後ろに[0],[1],…,[N]と記載された状態で出力される。
※1つ目の項目名には [0] が記載されている。
・WEKO ID, Delete Flagは繰り返し記載することはできない。
(3) エラーメッセージ
全件エクスポート処理においてエラーが発生した場合はその制御を行う
エラーメッセージは画面上部に赤く表示される。
本画面でチェックしているエラー内容は以下の通り。
エラー発生条件 | 表示されるエラーメッセージ |
---|---|
エクスポートのキャンセルに失敗した場合 (キャンセル中にエラーが発生した、またはキャンセルが実行される前にエクスポートが完了した場合) |
エクスポートのキャンセルに失敗しました。 (Failed to cancel export.) |
他のユーザが全件エクスポート処理を実行中の場合 | 他の端末でエクスポートを実行中です。 (Export is in progress on another device.) |
予期せぬエラーが発生した場合 (ネットワークに問題があった場合など) |
サーバ内部エラー (Internal server error) |
(4) その他
バックグラウンドでエクスポート処理を実行する。
論理削除された著者情報は出力されない。
全件エクスポートで出力されたファイルと、著者の一括登録で登録するファイルの形式は同じものとする。
実行結果をサーバ上(オブジェクトストレージのファイルインスタンス)に配置することで、管理者がダウンロードできるようにする。
関連モジュール
weko-authors
処理概要
modules/weko-authors/weko_authors/config.py
全件エクスポートのファイル名の設定値
WEKO_AUTHORS_EXPORT_FILE_NAME = 'Creator_export_all.tsv'
[(Export)]ボタンを押下すると、weko_authors.admin.ExportView.exportが呼び出され、著者情報のファイルのURIのidをdb内のfilies_filesテーブルのidカラムから取得する。(URIがない場合は、invenio_files_rest.models.FileInstance.createが呼び出され作成される。)
次に、weko_authors.admin.ExportView.check_statusが呼び出され、Download URLが作成される。Download URLを押下することで、weko_authors.admin.ExportView.downloadが呼び出されてファイルがダウンロードされる。
更新履歴
日付 | GitHubコミットID | 更新内容 |
---|---|---|
|
353ba1deb094af5056a58bb40f07596b8e95a562 | 初版作成 |