リネーム処理

オペレーション名

リネーム

機能概要

FTPサーバー上にあるファイルを指定してリネームします。

データモデル

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

プロパティ

= 備考 =

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	コネクションリソースを選択します。 [追加] 新規にコネクションリソースを追加します。 [一覧の編集] > HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。
パス	必須	-	パスを指定します。各列は以下のボタンで操作することができます。 [上へ] 選択している列の順序を一つ上に上げます。 [下へ] 選択している列の順序を一つ下に下げます。 [追加] 列を追加します。 [削除] 列を削除します。
パス/リネーム前パス	必須	使用可	FTPサーバー上のファイル/ディレクトリーを「/」から始まる絶対パスで入力します。	大文字小文字を区別します。
パス/リネーム後パス	必須	使用可	FTPサーバー上のリネーム後のファイル/ディレクトリーを「/」から始まる絶対パスで入力します。	大文字小文字を区別します。

リネーム処理設定

項目名	必須/省略可	変数の使用	説明	備考
リネーム後のファイル/ディレクトリーが既に存在する場合はリネームしない	省略可	使用不可	[パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合にリネームを行わないようにするかどうかを選択します。 [チェックあり] (デフォルト) [パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合、リネームを行いません。 [チェックなし] [パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合も、リネームを行います。	注意ファイル/ディレクトリーがすでに存在する状態でリネームを行った場合の動作は、接続先のFTPサーバーによって異なります。
親ディレクトリーが存在しない場合は作成	省略可	使用不可	[パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合に自動的に作成するかどうかを選択します。 [チェックあり] [パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合、自動的に作成します。 [チェックなし] (デフォルト) [パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合、自動的に作成しません。

項目名

必須/省略可

変数の使用

説明

備考

リネーム後のファイル/ディレクトリーが既に存在する場合はリネームしない

省略可

使用不可

[パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合にリネームを行わないようにするかどうかを選択します。

[チェックあり]

(デフォルト)

[パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合、リネームを行いません。

[チェックなし]

[パス/リネーム後パス]で指定したファイル/ディレクトリーがすでに存在する場合も、リネームを行います。

注意

ファイル/ディレクトリーがすでに存在する状態でリネームを行った場合の動作は、接続先のFTPサーバーによって異なります。

親ディレクトリーが存在しない場合は作成

省略可

使用不可

[パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合に自動的に作成するかどうかを選択します。

[チェックあり]

[パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合、自動的に作成します。

[チェックなし]

(デフォルト)

[パス/リネーム後パス]で指定したファイル/ディレクトリーの親ディレクトリーが存在しない場合、自動的に作成しません。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このコネクターの簡単な説明を記述することができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<ftpserver name="" port="" user="">
  <pathnames>
    <pathname date="" filetype="" local="" remote="" size="" status="" type=""/>
  </pathnames>
</ftpserver>

要素名	属性名	説明
ftpserver	-
	name	接続したFTPサーバーのホスト名を出力します。
	port	接続したFTPサーバーのポート番号を出力します。
	user	FTPサーバーに接続する際に使用したユーザ名を出力します。
pathnames	-
pathname	-	リネーム対象となったファイル/ディレクトリーごとに出現します。
	date	常に空データが出力されます。
	filetype	リネーム対象となったファイル/ディレクトリーのファイルタイプを出力します。 File ファイル Directory ディレクトリー
	local	常に空データが出力されます。
	remote	リネーム対象となったファイル/ディレクトリーのFTPサーバー上の絶対パス(リネーム後)を出力します。
	size	常に空データが出力されます。
	status	リネーム状態を出力します。 Renamed FTPサーバー上でリネームされた状態です。 Exists リネームされなかった状態です。[リネーム後のファイル/ディレクトリーがすでに存在する場合はリネームしない]にチェックを入れ、[パス/リネーム後パス]で指定したファイル/ディレクトリーがFTPサーバー上に存在した場合に出力されます。 NG エラーが発生したため、リネームされなかった状態です。
	type	常に空データが出力されます。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

= 備考 =

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名	説明	備考
count	リネーム対象となったファイル/ディレクトリーの数が格納されます。	デフォルト値はnullです。「directory_count」と「file_count」の合計です。
directory_count	リネーム対象となったディレクトリーの数が格納されます。	デフォルト値はnullです。
file_count	リネーム対象となったファイルの数が格納されます。	デフォルト値はnullです。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター	メッセージコード	例外メッセージ	制限事項
FTP コネクターのメッセージおよび制限事項