intra-mart Accel Platform アカウント インポート・エクスポート仕様書 第5版 2016-04-01

オプション

インポート・エクスポートで扱うファイルなどの設定や、インポート・エクスポート処理の動作を変更するためのオプションが用意されています。
この章では、インポート・エクスポート時に使用できるオプションについて説明します。

XMLインポートオプション

この項では、XMLファイルでインポートを行う際に使用可能なオプションについて説明します。

設定可能項目一覧

名前 キー名 デフォルト値 導入バージョン
エンコーディング encoding 文字列 UTF-8 2012 Autumn
ファイルパス file 文字列 (なし) 2012 Autumn
コミット件数 commit-count 数値 0 2012 Autumn
日付/時刻フォーマットパターン date-time-format-pattern 文字列 yyyy-MM-dd HH:mm:ss.SSS 2013 Summer
日付/時刻フォーマットロケールID date-time-locale-id 文字列 en 2013 Summer
日付フォーマットパターン date-format-pattern 文字列 yyyy-MM-dd 2013 Summer
日付フォーマットロケールID date-locale-id 文字列 en 2013 Summer
XML検証フラグ validate-xml 真偽値 true 2012 Autumn
データ検証フラグ validate-data 真偽値 true 2013 Winter

エンコーディング

キー名 encoding
インポートするXMLファイルの文字エンコーディングを指定します。

ファイルパス

キー名 file
インポートするXMLファイルのパス(パブリックストレージのルートからの相対パス)を指定します。

コミット件数

キー名 commit-count
インポート処理で、コミットを行うまでのデータ件数を指定します。
コミット件数に「0」(デフォルト値)が指定された場合は、インポート処理が完了するまでコミットが行われません。

注意

commit-count を指定した場合、インポート実行元で管理しているトランザクションがコミットされる可能性があります。

日付/時刻フォーマットパターン

キー名 date-time-format-pattern
インポートするXMLファイル内の日時項目のフォーマットを指定します。
アカウント情報」の「アカウントロック日付」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付/時刻フォーマットロケールID

キー名 date-time-locale-id
インポートするXMLファイル内の日時項目のロケールIDを指定します。
日付/時刻フォーマットパターン と一緒に指定します。
アカウント情報」の「アカウントロック日付」で利用します。

日付フォーマットパターン

キー名 date-format-pattern
インポートするXMLファイル内の日付項目のフォーマットを指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付フォーマットロケールID

キー名 date-locale-id
インポートするXMLファイル内の日付項目のロケールIDを指定します。
日付フォーマットパターン と一緒に指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。

XML検証フラグ

キー名 validate-xml
インポートするXMLファイルの構文を検証するかどうかを指定します。
指定する値 説明
true XML構文の検証を行います。(デフォルト値)
false XML構文の検証を行いません。

データ検証フラグ

キー名 validate-data
インポートするデータの検証を行うかどうかを指定します。
指定する値 説明
true データの検証を行います。(デフォルト値)
false データの検証を行いません。

XMLエクスポートオプション

この項では、XMLファイルでエクスポートを行う際に使用可能なオプションについて説明します。

設定可能項目一覧

名前 キー名 デフォルト値 導入バージョン
エンコーディング encoding 文字列 UTF-8 2012 Autumn
ファイルパス file 文字列 (なし) 2012 Autumn
読み込み件数 fetch-count 数値 5000 2012 Autumn
日付/時刻フォーマットパターン date-time-format-pattern 文字列 yyyy-MM-dd HH:mm:ss.SSS 2013 Summer
日付/時刻フォーマットロケールID date-time-locale-id 文字列 en 2013 Summer
日付フォーマットパターン date-format-pattern 文字列 yyyy-MM-dd 2013 Summer
日付フォーマットロケールID date-locale-id 文字列 en 2013 Summer
XML整形フラグ format-xml 真偽値 false 2012 Autumn
ルートタグ名 root-tag-name 文字列 root 2012 Autumn
書き込み件数 flush-count 数値 5000 2012 Autumn

エンコーディング

キー名 encoding
エクスポートするXMLファイルの文字エンコーディングを指定します。

ファイルパス

キー名 file
エクスポートするXMLファイルのパス(パブリックストレージのルートからの相対パス)を指定します。

読み込み件数

キー名 fetch-count
データベースからエクスポート対象のデータを一度に読み込む件数を指定します。

日付/時刻フォーマットパターン

キー名 date-time-format-pattern
エクスポートするXMLファイル内の日時項目のフォーマットを指定します。
アカウント情報」の「アカウントロック日付」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付/時刻フォーマットロケールID

キー名 date-time-locale-id
エクスポートするXMLファイル内の日時項目のロケールIDを指定します。
日付/時刻フォーマットパターン と一緒に指定します。
アカウント情報」の「アカウントロック日付」で利用します。

日付フォーマットパターン

キー名 date-format-pattern
エクスポートするXMLファイル内の日付項目のフォーマットを指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付フォーマットロケールID

キー名 date-locale-id
エクスポートするXMLファイル内の日付項目のロケールIDを指定します。
日付フォーマットパターン と一緒に指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。

XML整形フラグ

キー名 format-xml
エクスポートするXMLファイルを整形するかどうかを指定します。
指定する値 説明
true XMLの整形を行います。
false XMLの整形を行いません。(デフォルト値)

ルートタグ名

キー名 root-tag-name
エクスポートするXMLファイルのルートタグ名を指定します。

書き込み件数

キー名 flush-count
エクスポートするXMLファイルに一度に書き込むデータ件数を指定します。

CSVインポートオプション

この項では、CSVファイルでインポートを行う際に使用可能なオプションについて説明します。

設定可能項目一覧

名前 キー名 デフォルト値 導入バージョン
エンコーディング encoding 文字列 UTF-8 2013 Summer
ファイルパス file 文字列 (なし) 2013 Summer
コミット件数 commit-count 数値 0 2013 Summer
日付/時刻フォーマットパターン date-time-format-pattern 文字列 yyyy-MM-dd HH:mm:ss.SSS 2013 Summer
日付/時刻フォーマットロケールID date-time-locale-id 文字列 en 2013 Summer
日付フォーマットパターン date-format-pattern 文字列 yyyy-MM-dd 2013 Summer
日付フォーマットロケールID date-locale-id 文字列 en 2013 Summer
データ検証フラグ validate-data 真偽値 true 2013 Winter
ヘッダ行有無フラグ with-header 真偽値 false 2013 Summer
区切り文字 delimiter-code 文字列 , (半角カンマ) 2013 Summer
引用符 quote-code 文字列 (半角ダブルクォート) 2013 Summer
CSVフォーマットパターン csv-format-pattern 文字列 standard 2013 Summer
更新モード update-mode 文字列 merge 2013 Summer
null代替文字列 null-string 文字列 (空文字列) 2013 Summer

エンコーディング

キー名 encoding
インポートするCSVファイルの文字エンコーディングを指定します。

ファイルパス

キー名 file
インポートするCSVファイルのパス(パブリックストレージのルートからの相対パス)を指定します。

コミット件数

キー名 commit-count
インポート処理で、コミットを行うまでのデータ件数を指定します。
コミット件数に「0」(デフォルト値)が指定された場合は、インポート処理が完了するまでコミットが行われません。

注意

commit-count を指定した場合、インポート実行元で管理しているトランザクションがコミットされる可能性があります。

日付/時刻フォーマットパターン

キー名 date-time-format-pattern
インポートするCSVファイル内の日時項目のフォーマットを指定します。
アカウント情報」の「アカウントロック日付」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付/時刻フォーマットロケールID

キー名 date-time-locale-id
インポートするCSVファイル内の日時項目のロケールIDを指定します。
日付/時刻フォーマットパターン と一緒に指定します。
アカウント情報」の「アカウントロック日付」で利用します。

日付フォーマットパターン

キー名 date-format-pattern
インポートするXMLファイル内の日付項目のフォーマットを指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付フォーマットロケールID

キー名 date-locale-id
インポートするXMLファイル内の日付項目のロケールIDを指定します。
日付フォーマットパターン と一緒に指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。

データ検証フラグ

キー名 validate-data
インポートするデータの検証を行うかどうかを指定します。
指定する値 説明
true データの検証を行います。(デフォルト値)
false データの検証を行いません。

ヘッダ行有無フラグ

キー名 with-header
インポートするCSVファイルがヘッダ行を含むかどうかを指定します。
指定する値 説明
true ヘッダ行(最初の1件)を除いてインポートします。
false 最初の1行からデータとみなしてインポートします。(デフォルト値)

区切り文字

キー名 delimiter-code
インポートするCSVファイルの各項目を区切る文字列を指定します。

コラム

このオプションには、以下の特殊文字を指定できます。
\t タブ文字
\r CR
\n LF
\\ 半角バックスラッシュ

注意

csv-format-pattern オプションを明示的に指定した場合は、このオプションは利用できません。

引用符

キー名 quote-code
インポートするCSVファイルの各項目を囲むための引用符の文字列を指定します。

注意

csv-format-pattern オプションを明示的に指定した場合は、このオプションは利用できません。

CSVフォーマットパターン

キー名 csv-format-pattern
インポートするCSVファイルのフォーマット情報を指定します。
区切り文字(delimiter-code)、引用符(quote-code)オプションがあらかじめ定義されたフォーマットのセットを指定できます。
指定する値 説明 区切り文字 引用符
standard 標準的なCSVフォーマットです。(デフォルト値) , (半角カンマ) (半角ダブルクォート)
excel Excelで使用されるCSVフォーマットです。 , (半角カンマ) (半角ダブルクォート)
excel-north-europe 北ヨーロッパのExcelで使用されるCSVフォーマットです。 ; (半角セミコロン) (半角ダブルクォート)

更新モード

キー名 update-mode
インポートするデータの更新モードを指定します。
全件のデータに影響します。1件ごとの指定はできません。
指定する値 説明
merge 既存のデータにマージして更新します。(デフォルト値)
replace 既存のデータを置き換えて更新します。

null代替文字列

キー名 null-string
インポートする項目のうち、null として扱う代替文字列を指定します。

CSVエクスポートオプション

この項では、CSVファイルでエクスポートを行う際に使用可能なオプションについて説明します。

設定可能項目一覧

名前 キー名 デフォルト値 導入バージョン
エンコーディング encoding 文字列 UTF-8 2013 Summer
ファイルパス file 文字列 (なし) 2013 Summer
読み込み件数 fetch-count 数値 5000 2013 Summer
日付/時刻フォーマットパターン date-time-format-pattern 文字列 yyyy-MM-dd HH:mm:ss.SSS 2013 Summer
日付/時刻フォーマットロケールID date-time-locale-id 文字列 en 2013 Summer
日付フォーマットパターン date-format-pattern 文字列 yyyy-MM-dd 2013 Summer
日付フォーマットロケールID date-locale-id 文字列 en 2013 Summer
UTF BOM with-utf-bom 真偽値 false 2013 Summer
ヘッダ行有無フラグ with-header 真偽値 false 2013 Summer
区切り文字 delimiter-code 文字列 , (半角カンマ) 2013 Summer
引用符 quote-code 文字列 (半角ダブルクォート) 2013 Summer
改行文字 newline-code 文字列 \r\n (CRLF) 2013 Summer
CSVフォーマットパターン csv-format-pattern 文字列 standard 2013 Summer
null代替文字列 null-string 文字列 (空文字列) 2013 Summer

エンコーディング

キー名 encoding
エクスポートするCSVファイルの文字エンコーディングを指定します。

ファイルパス

キー名 file
エクスポートするCSVファイルのパス(パブリックストレージのルートからの相対パス)を指定します。

読み込み件数

キー名 fetch-count
データベースからエクスポート対象のデータを一度に読み込む件数を指定します。

日付/時刻フォーマットパターン

キー名 date-time-format-pattern
エクスポートするCSVファイル内の日時項目のフォーマットを指定します。
アカウント情報」の「アカウントロック日付」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付/時刻フォーマットロケールID

キー名 date-time-locale-id
エクスポートするCSVファイル内の日時項目のロケールIDを指定します。
日付/時刻フォーマットパターン と一緒に指定します。
アカウント情報」の「アカウントロック日付」で利用します。

日付フォーマットパターン

キー名 date-format-pattern
エクスポートするXMLファイル内の日付項目のフォーマットを指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。
フォーマットに使用可能なパターン文字については「日付/時刻フォーマットパターンに指定可能な文字 」を参照してください。

日付フォーマットロケールID

キー名 date-locale-id
エクスポートするXMLファイル内の日付項目のロケールIDを指定します。
日付フォーマットパターン と一緒に指定します。
アカウント情報」の「有効開始日」「有効終了日」および「アカウント付与ロール情報」の「有効開始日」「有効終了日」で利用します。

UTF BOM

キー名 with-utf-bom
エクスポートするCSVファイルのエンコーディングが UTF-8、UTF-16、UTF-32 のいずれかの場合にBOMを含ませるかどうかを指定します。
指定する値 説明
true BOMを含めます。
false BOMを含めません。(デフォルト値)

ヘッダ行有無フラグ

キー名 with-header
エクスポートするCSVファイルにヘッダ行を含ませるかどうかを指定します。
指定する値 説明
true ヘッダ行(最初の1件)を出力します。
false ヘッダ行を出力しません。(デフォルト値)

区切り文字

キー名 delimiter-code
エクスポートするCSVファイルの各項目を区切る文字列を指定します。

コラム

このオプションには、以下の特殊文字を指定できます。
\t タブ文字
\r CR
\n LF
\\ 半角バックスラッシュ

注意

csv-format-pattern オプションを明示的に指定した場合は、このオプションは利用できません。

引用符

キー名 quote-code
エクスポートするCSVファイルの各項目を囲むための引用符の文字列を指定します。

注意

csv-format-pattern オプションを明示的に指定した場合は、このオプションは利用できません。

改行文字

キー名 newline-code
エクスポートするCSVファイルの改行文字列を指定します。

コラム

このオプションには、以下の特殊文字を指定できます。
\r CR
\n LF

注意

csv-format-pattern オプションを明示的に指定した場合は、このオプションは利用できません。

CSVフォーマットパターン

キー名 csv-format-pattern
エクスポートするCSVファイルのフォーマット情報を指定します。
区切り文字(delimiter-code)、引用符(quote-code)、改行文字(newline-code)オプションがあらかじめ定義されたフォーマットのセットを指定できます。
指定する値 説明 区切り文字 引用符 改行文字
standard 標準的なCSVフォーマットです。(デフォルト値) , (半角カンマ) (半角ダブルクォート) \r\n (CRLF)
excel Excelで使用されるCSVフォーマットです。 , (半角カンマ) (半角ダブルクォート) \n (LF)
excel-north-europe 北ヨーロッパのExcelで使用されるCSVフォーマットです。 ; (半角セミコロン) (半角ダブルクォート) \n (LF)

null代替文字列

キー名 null-string
エクスポートする項目のうち、null として扱う代替文字列を指定します。