リネーム処理

オペレーション名

リネーム

機能概要

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

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
パス 必須 - パスを指定します。

各列は以下のボタンで操作することができます。
  • [追加]:
    列を追加します。
  • [上へ]:
    選択している列の順序を一つ上に上げます。
  • [下へ]:
    選択している列の順序を一つ下に下げます。
  • [削除]:
    列を削除します。
 
パス/リネーム前パス 必須 使用可 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」
  • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Cloudのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
RemoteFileListParseException
リモートファイル一覧の解析処理に失敗しました。エンコードが正しくない可能性があります。
リモートファイル一覧の解析処理に失敗しました。 [接続先]で選択した[エンコード]やFTPサーバの設定などを確認してください。
MalformedRemotePathException
リネーム前パスが不正です。リネーム前パスは「/」から始まる絶対パスで入力してください。
[リネーム前パス]が「/」から始まっていません。 [リネーム前パス]は「/」から始まる絶対パスで入力してください。
MalformedRemotePathException
リネーム後パスが不正です。リネーム後パスは「/」から始まる絶対パスで入力してください。
[リネーム後パス]が「/」から始まっていません。 [リネーム後パス]は「/」から始まる絶対パスで入力してください。
FTPException FTPサーバが何らかのエラーを返した場合の例外です。 メッセージの内容を確認してください。
com.enterprisedt.net.ftp.FTPException FTPサーバが何らかのエラーを返した場合の例外です。 メッセージの内容を確認してください。
java.net.UnknownHostException 指定したFTPサーバが見つからない例外です。 FTPサーバの設定を確認してください。
java.net.ConnectException FTPサーバに接続できない例外です。 ポート番号、あるいは、FTPサーバが起動していることを確認してください。

注意事項