ヘッダ項目出力(CSV)処理

オペレーション名

ヘッダ項目出力(CSV)

機能概要

様式ファイル(XML様式ファイル、およびfrm様式ファイル)から抽出したヘッダ項目名をファイルに出力します。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
データファイル 必須 使用可 ヘッダ項目を出力するデータファイルのパスを入力します。

[参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。
デリミタモード 必須 使用不可 デリミタの指定方法を選択します。
  • [一覧から選択]:(デフォルト)
    一覧からデリミタ文字を選択します。
  • [直接入力]:
    フィールドに直接デリミタ文字を入力します。
  • [文字コード入力]:
    フィールドに文字コードでデリミタ文字を入力します。
  • 選択した指定方法により、対応した入力フィールドに切り替わります。
一覧から選択/デリミタ文字 省略可 使用不可 デリミタ文字を選択します。
  • [半角カンマ]:(デフォルト)
    半角カンマ(,)を指定します。
  • [タブ]:
    タブを指定します。
  • [半角スペース]:
    半角スペース( )を指定します。
  • [半角セミコロン]:
    半角セミコロン(;)を指定します。
  • [半角スラッシュ]:
    半角スラッシュ(/)を指定します。
  • [半角バーティカルバー]:
    半角バーティカルバー(|)を指定します。
  • [デリミタモード][一覧から選択]を選択した場合、有効になります。
直接入力/デリミタ文字 必須 使用可 デリミタ文字を1文字入力します。
  • [デリミタモード][直接入力]を選択した場合、有効になります。
  • ダブルクォーテーションをデリミタ文字に指定することはできません。
文字コード入力/デリミタ文字 必須 使用可 文字コードを入力します。
入力した文字コードは[エンコード]で指定したエンコードで変換されます。

8進(接頭辞「0」<数字のゼロ>)、10進(接頭辞なし)、16進(接頭辞「0x」<数字のゼロとアルファベットのエックス>もしくは「#」)による入力が可能です。
パディングが複数のバイト列になる場合には、カンマで区切って入力します。例:0x10,0x13
  • [デリミタモード][文字コード入力]を選択した場合、有効になります。
  • 1文字に変換される文字コードを入力できます。
  • 改行コード、ダブルクォーテーションに変換される文字コードを指定することはできません。
ヘッダ項目 必須 - ヘッダ項目を指定します。

各ヘッダ項目は以下のボタンで操作することができます。
  • [追加]:
    ヘッダ項目を追加します。
  • [上へ]:
    選択しているヘッダ項目の順序を一つ上に上げます。
  • [下へ]:
    選択しているヘッダ項目の順序を一つ下に下げます。
  • [削除]:
    ヘッダ項目を削除します。
 
ヘッダ項目/ヘッダ項目名 必須 使用可 ヘッダ項目名を入力します。  
ヘッダ項目/クォーテーション 省略可 使用不可 各ヘッダ項目名をダブルクォーテーションで囲うかどうかを選択します。
  • [チェックあり]:
    ヘッダ項目名をダブルクォーテーションで囲みます。
  • [チェックなし]:(デフォルト)
    ヘッダ項目名をダブルクォーテーションで囲みません。
 
プロパティアクション
項目名 説明 備考
プレビュー プレビューアを起動して、[データファイル]で指定したファイルの内容を表示します。
  • 指定したファイルが存在しない場合、または[データファイル]に変数が設定されている場合は無効になります。
  • [エンコード]で指定したエンコードで表示されます。
  • ファイル内容の編集はできません。
  • プレビューアで表示できるファイルのサイズは最大1MBです。ファイルサイズが1MBを超える場合、ファイルの先頭から1MB分が表示されます。
様式ファイルからヘッダ項目名を読み取り ファイルチューザで様式ファイルを選択して、そのファイルからヘッダ項目名を抽出して設定します。
  • 様式ファイルが不正な場合、または様式ファイルにフィールドやバーコードが定義されていない場合には、[ヘッダ項目]の更新は行いません。
書き込み設定
項目名 必須/省略可 変数の使用 説明 備考
エンコード 必須 使用可 書き込むファイルのエンコードを選択または入力します。

入力する場合は、Java SE Runtime Environment 8でサポートされているエンコードを指定します。
詳細については、「Supported Encodings」(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html)を参照してください。
  • デフォルト値は「UTF-8」になります。
トランザクション
項目名 必須/省略可 変数の使用 説明 備考
トランザクション処理を行う 省略可 使用不可 トランザクション処理を行うかどうかを選択します。
  • [チェックあり]:
    トランザクション処理を行います。
  • [チェックなし]:(デフォルト)
    トランザクション処理を行いません。
詳細については、「ファイル系アダプタのトランザクション」を参照してください。
 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

ありません。

トランザクション

トランザクションをサポートしています。

[トランザクション][トランザクション処理を行う]にチェックを入れた場合のみトランザクションは有効になります。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
data_file_path [データファイル]で指定した、データファイルパスが格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • バージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • バージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • バージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

ありません。

主な例外

例外名 原因 対策
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。
[<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
InvalidPropertyConfigurationException
不正なデリミタ文字が指定されています。
[デリミタ文字]に不正な文字が入力されています。 [デリミタ文字]に正しい文字を入力してください。
PathIsNotAbsoluteException 指定されたパスが相対パスです。 絶対パスを入力してください。
FileIsDirectoryException [データファイル]に入力されたパスがディレクトリです。 [データファイル]にはファイルパスを入力してください。
FileIsLockedException [データファイル]に指定されたファイルがロックされています。 エクスプローラやCLIからロックの解除を行ってください。
java.io.FileNotFoundException
別のプロセスが使用中です。
[データファイル]に指定されたファイルが別のプロセスによって使用されています。 別のプロセスで使用されていないかを確認してください。
java.io.UnsupportedEncodingException [エンコード]にサポートされていないエンコードが指定されています。 Java SE Runtime Environment 8でサポートされているエンコードを指定してください。
詳細については、「Supported Encodings」(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html)を参照してください。