CSV出力
バインダに登録されている文書をCSV形式で出力することができます。CSV出力できる箇所は2ヶ所あり、場所によって動作が異なります。
表 CSV出力ができる箇所
出力箇所 | 利用権限 | 出力対象文書 | 出力対象部品 |
---|---|---|---|
サイドメニュー | バインダ概要の「文書アクセス権限」で指定。 一括操作権限をもつユーザのサイドメニューにCSV出力メニューが表示される。 |
バインダに登録されている全文書(削除文書除く) | フォームに定義されている全部品(レイアウトブロック制御、退避エリア除く) |
文書一覧 | バインダ属性の「CSV入力」の「対象ユーザ」で指定。 権限をもつユーザの文書一覧の下部に「CSV出力」ボタンが表示される。 |
出力時に文書一覧に表示されている文書 | 文書一覧に表示されており、CSV出力権限のあるレイアウトブロック内にある部品 |
また、CSV出力処理をバックグラウンドで行うことが出来ます。詳細は【CSV出力バックグラウンド化機能】を参照してください。
手順
CSV出力を行う文書が登録されているバインダの文書一覧画面を開きます。サイドメニューから「CSV出力」メニューをクリックします。
※「CSV出力」メニューは、文書一覧画面に表示される「CSV出力」ボタンとは役割が異なります。「CSV出力」メニューは当該バインダに登録されているすべての文書をCSVファイル形式にて出力するためのメニューであり、「CSV出力」ボタンは現在、一覧表に表示されている情報のみをCSVファイル形式にて出力するためのボタンです。
CSV出力画面が開きます。「文字コード」項目を選択しCSVファイルのリンクをクリックします。
ファイルのダウンロードダイアログが表示されますので、ファイルをアプリケーションで開くかディスクに保存するか指定します。
CSVファイルのフォーマット
CSVファイル名
main_[binder-key/binder-id].csv
例:main_bunsyokanri.csv / main_10008.csv
CSVファイルのフォーマット
※CSVファイルのフォーマットは機能追加によって変更される場合があります。
表 サイドメニューからの出力ファイル
ヘッダ | 出力例 | 備考 |
---|---|---|
バインダID | 10008 | 固定 |
文書番号 | 1 | 固定 |
最終更新日時 | 2011-04-05 11:34:48 | 固定 |
最終更新ユーザ | 情報 夢子 | 固定 |
登録日時 | 2011-04-04 11:34:48 | 固定 |
登録ユーザ | 情報 夢子 | 固定 |
文書タイトル | タイトル | フォーム属性編集にて文書タイトルを設定した場合に出力されます。 |
(空列) | 固定 | |
[部品キー(部品ID)]項目名(部品名) | 各部品の出力フォーマットについては「【表 各部品のCSV入出力フォーマット】」を参照してください。 |
※サイドメニューから出力したCSVの項目順は、フォーム定義で部品を作成した順(部品番号順)となります。この順番を変更することはできません。
表 文書一覧からの出力ファイル
ヘッダ | 出力例 | 備考 |
---|---|---|
バインダID | 10008 | 固定 |
[部品キー(部品ID)]項目名(部品名) | 文書一覧に表示している項目。 各部品の出力フォーマットについては「【表 各部品のCSV入出力フォーマット】」を参照してください。 |
※文書一覧から出力したCSVの項目順は、ビュー定義の「表示項目設定」で指定した順となります。
各部品のCSV入出力フォーマット
各部品の対応とCSVファイルでの指定形式については下表の通りです。
リッチテキスト、アカウント選択(ポップアップ)、アカウント選択(メニュー)、カテゴリ部品はそれぞれ2列出力されます。
表 各部品の出力フォーマット
部品 | CSV対応 | 入力データ例 | 備考 |
---|---|---|---|
ラベル | - | - | |
デザインイメージ | - | - | |
デザインリンク | - | - | |
文字列入力ボックス | ◯ | AAA | |
数値入力ボックス | ◯ | 123 | |
文章入力エリア | ◯ | AAA BBB |
改行は保持される |
リッチテキスト | ◯ | <!-- Created by DA_Richtext v2.0 --><!-- start default style --><style>(途中略)</style> <div class=""rTxt1324347861439""> <!-- end default style --> <P>リッチテキスト</P> <P>入力項目</P> </div> |
タグ付き |
リッチテキスト 入力項目 |
タグなし | ||
複数選択 | ◯ | a b |
複数の場合は改行する |
単一選択(項目) | ◯ | A | |
単一選択(メニュー) | ◯ | B | |
入力可能な単一選択(メニュー) | ◯ | AAAA | |
日付選択 | ◯ | ||
ファイルフォルダ | △ | 0729.xslx | ファイル名を出力 ※ファイルを出力する場合は、「ファイルフォルダ部品、画像部品にアップロードしたファイルの出力」を参照のこと |
画像 | △ | Image01.png | ファイル名を出力 ※ファイルを出力する場合は、「ファイルフォルダ部品、画像部品にアップロードしたファイルの出力)」を参照のこと |
アカウント選択(ポップアップ) | ◯ | [1000030][1000014] | [アカウントID] |
アカウントA,アカウントB | |||
アカウント選択(メニュー) | ◯ | [1000030][1000014] | [アカウントID] |
アカウントA,アカウントB | |||
リンク | ◯ | http://sina.com title | URL タイトル |
文書リンク | ◯ | 10006-9,10006-8,10006-7 | バインダID-文書番号 |
バインダリンク | ◯ | 10008 | バインダID |
自動採番 | ◯ | 17 | |
バインダ参照ボタン | ◯ | 2 | 文書番号 未選択の場合は0 |
自動更新部品 | ◯ | ABC | 参照先の値 |
カテゴリ | ◯ | 3861 category1-1 | カテゴリID カテゴリ名 |
トップ>>Category1 >> category1-1 | カテゴリ | ||
アクション部品 | - | - | |
実施履歴 | - | - |
ファイルフォルダ部品、画像部品にアップロードしたファイルの出力
下記設定を行うことで、ファイルフォルダ部品や画像部品にアップロードしたファイルをCSVファイルと一緒に出力することが可能となります。
-
バインダ属性編集画面で「CSV入出力」をクリックし、「CSV入出力 定義情報」を表示します。
-
「CSV入出力 定義情報」が表示されるので、ファイルと画像欄の「許可する」をチェックします。
-
出力されるファイルの最大合計サイズを指定してください。空の状態で保存した場合には、システムのデフォルト値が設定されます。デフォルト値を変更する場合は、default.xml上の下記項目を設定してください。
表 出力ファイルの最大合計サイズの設定
ファイル | default.xml | ||
---|---|---|---|
親要素 | hibiki.brd.csv.export | ||
要素 | 名称 | 初期値 | 説明 |
max-attachment-total-file-size | 1G | CSV出力時に一緒に出力されるファイルの最大合計サイズを指定します。(最大:100GB) | |
記述例 | <max-attachment-total-file-size>1G</max-attachment-total-file-size> |
-
バインダ属性を「保存」します。
-
「CSV出力」する際に「ファイルを圧縮してダウンロード」するためのリンクが表示されます。そのリンク下に「ファイルと画像を含む」チェックが表示されます。
-
「ファイルと画像を含む」にチェックを入れると、ファイルサイズのチェックが行われます。ファイルサイズが最大合計サイズ以内であれば、ダウンロードリンクが有効になります。
-
「ファイルを圧縮してダウンロード」リンクをクリックし、ファイルをダウンロードします。
CSV出力処理のバックグラウンド化
※当機能はDBがOracleの場合にのみ有効です。
default.xmlで下記の設定を行うことにより、CSV出力処理がバックグラウンドで行われます。それにより、CSV出力処理と並行して他の操作をすることが可能となります。
表 CSV出力処理実施方法の設定
ファイル | default.xml | ||
---|---|---|---|
親要素 | default-values.hibiki.brd.background.csvExport | ||
要素 | 名称 | 初期値 | 説明 |
backgroundEnable | false | CSV出力処理の実施方法:「同期で実施 / バックグラウンドで実施(初期値:同期で実施) | |
記述例 | <backgroundEnable>true</backgroundEnable> |
-
処理の流れ
-
サイドバーのCSV出力、もしくは文書一覧画面のCSV出力ボタンを押下するとダウンロードファイル選択画面に遷移します。
-
「すべてのファイルを一括ダウンロード」を選択した場合
メインファイルと関連ファイルを一つにまとめた圧縮ファイルが作成されます。ファイルを個別で選択することはできません。
バインダ属性で「一括ダウンロードファイルのパスワード有無」を「パスワード付き圧縮ファイルにする」に設定している場合、パスワード入力欄が表示されます。
- 「CSVファイルを個別でダウンロードする」を選択した場合
ダウンロードするファイルを選択することが出来ます。
-
「CSV出力」ボタンを押下すると、CSV出力受付画面に遷移します。
-
処理が完了したら、処理一覧画面からファイルをダウンロードします。
-
完了時の通知処理について
- ポップアップ通知
ポップアップ通知を設定している場合、CSVファイルの作成完了時に以下のような画面がポップアップで表示されます。
「処理一覧画面を表示する」ボタンを押下すると、処理一覧画面をポップアップで表示します。
- メール通知
メール通知を設定している場合、処理完了時に下記のようなメールが処理を実行したユーザに送信されます。
通知方法の設定方法は以下の通りです。
表 処理完了時の通知方法
ファイル | default.xml | ||
---|---|---|---|
親要素 | default-values.hibiki.brd.background.csvExport.notification | ||
要素 | 名称 | 初期値 | 説明 |
popup | true | 完了時にポップアップで通知するか否かの設定 | |
要素 | 名称 | 初期値 | 説明 |
true | 完了時にメールで通知するか否かの設定 | ||
記述例 | <notification> <mail>false</mail> <popup>true</popup> </notification> |
- 履歴削除処理
CSV出力バックグラウンド化機能を使用している場合にdefault.xmlに下記の設定を行うことにより、定期処理でバックグラウンド処理の履歴削除とCSVファイルの削除を行うことが可能です。
表 CSV出力履歴自動削除機能設定
ファイル | default.xml | ||
---|---|---|---|
親要素 | default-values.hibiki.brd.background.csvExport | ||
要素 | 名称 | 初期値 | 説明 |
enable-delete-past-job-data | true | CSV出力処理の履歴自動削除機能を有効にするかどうかを設定します。初期値:有効にする | |
記述例 | <csvExport> <enable-delete-past-job-data>true</enable-delete-past-job-data> </csvExport> |
CSV簡易出力機能
properties-definition.xmlに下記の設定をすることにより、文書一覧から直にCSVファイルを出力することが可能になります。
表 CSV簡易出力設定
ファイル | properties-definition.xml | ||
---|---|---|---|
親要素 | csv.export | ||
要素 | 名称 | 初期値 | 説明 |
enable-direct-csv-download | false | CSV簡易出力設定 trueの場合、文書一覧からCSVの簡易出力を行う | |
charset | Shift_JIS | CSV簡易出力設定時の文字コード Shift_JISもしくはUTF-8 を設定する | |
記述例 | <binder-properties-def name=”PatternA”> <csv> <export> <enable-direct-csv-download>true</enable-direct-csv-download> <charset>Shift_JIS</charset> </export> </csv> </binder-properties-def> |
上記をtrueに設定した場合、文書一覧のCSV出力ボタンを押下すると、下記のメッセージが表示されます。
このダイアログでOKを押下すると、メインフォームのCSVをダウンロードします。
※ この機能を使用する場合、CSV出力バックグラウンド化機能、関連ファイル出力機能、パスワード保護機能は使用できません。