API関数定義出力(CSV)処理

オペレーション名

API関数定義出力(CSV)

機能概要

データファイルの中で指定可能なAPI関数の設定をファイルに出力します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

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

[参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。
API関数 必須 - データファイルに出力するAPI関数の名前と引数の数を指定します。

各クエリパラメータは以下のボタンで操作することができます。
  • [追加]:
    API関数を追加します。
  • [上へ]:
    選択しているAPI関数の順序を一つ上に上げます。
  • [下へ]:
    選択しているAPI関数の順序を一つ下に下げます。
  • [削除]:
    API関数を削除します。
  
API関数/名前 必須 使用可 API関数の名前を入力します。  
API関数/引数の数 必須 使用不可 API関数の引数の数を入力します。
  • 「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」になります。
トランザクション
項目名 必須/省略可 変数の使用 説明 備考
トランザクション処理を行う 必須 使用不可 トランザクション処理を行うかどうかを選択します。
  • [チェックあり]:
    トランザクション処理を行います。
  • [チェックなし]:(デフォルト)
    トランザクション処理を行いません。
詳細については、「ファイル系アダプタのトランザクション」を参照してください。 		 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

<?xml version="1.0" encoding="UTF-8"?>
<apis>
  <api>
    <argument>API関数の引数</argument>
    　:
    <argument>API関数の引数</argument>
  </api>
     :
</apis>
要素名 属性名 説明 備考
apis -    
api - API関数を表す要素です。 要素数は[API関数]で設定した数になります。
argument - API関数の引数に渡す値を入力してください。 要素数は[API関数/引数の数]で入力した数になります。

出力スキーマ

ありません。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

トランザクション

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

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

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です。
  • バージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
InputDataNotFoundException [入力データ]が指定されていません。 [入力データ]を指定する、またはデータフローを引いてください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
PathIsNotAbsoluteException 指定されたパスが相対パスです。 絶対パスを入力してください。
FileIsDirectoryException [データファイル]に入力されたパスがディレクトリです。 [データファイル]にはファイルパスを入力してください。
FileIsLockedException [データファイル]に指定されたファイルがロックされています。 エクスプローラやCLIからロックの解除を行ってください。
InvalidSchemaException [入力データ]のスキーマが不正です。 [入力データ]のスキーマを確認してください。
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)を参照してください。