Home > コンポーネント シリーズ > ファイル管理 > ファイル管理 - 設定 > ファイル管理 - メソッド

ファイル管理 - メソッド

以下のメソッドを使用してファイル管理コンポーネントを構成します。

次の表では、使用できるメソッドおよびパラメータを一覧にしています。太字表示のパラメータは必須です。

メソッド

パラメタ

説明

Append BLOB to File

対象ファイルがない場合は、データを新規ファイルに書き込みます。また任意のBLOBまたは文字列を既存のファイルの終わりに追加します。

対象ファイル名

添付されるファイルの名前とフルパスを入力します。

エンコーディング

ファイルに書き込むデータのエンコーディングを入力します。デフォルト値はKeep Existingです。

サポートされているエンコーディング値は、Keep ExistingUTF-8 with BOMUTF-8UnicodeAnsiBinaryCustomです。

実行時変換はデータBLOBに対して行われます。(参照:変換テーブル

Since version: 4.7

コードページ

使用したいコードページの値を入力します。[エンコーディング]パラメータでCustomオプションが選択されている場合は、コードページを選択する必要があります。

デフォルトのコードページは、ibm-930_P120-1999です。

参考:サポートされるコードページ一覧

Since version: 4.9

データ

ファイルに添付されるデータを入力します。

エラーコード

をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Command Line

コマンドの実行可能ファイルをスキャンします。

実行ファイル名

実行するコマンドのフルパスおよび名前を入力します。

del *.*のような一部のコマンドはユーザ入力が必要です。しかし、Magic xpiサーバはバックグラウンドモードで動作するため、コマンドラインでのユーザ入力ができません。このため、ユーザ入力が必要なコマンドを使用する場合は、コマンドを消音モード(Windowsでは /Q)で実行する必要があります。

消音モードの場合、Magic xpiはコマンドのデフォルト形式を利用することことを前提とします。例えばDeleteコマンドを使用した場合、ユーザは削除の確認(Y/N)を求められます。消音モードではMagic xpiはコマンドのデフォルト形式、つまりYの入力を仮定してファイルを削除します。

Deleteコマンドを消音モードで実行するには以下のように入力します。

del /Q *.*

IBM iの場合、このメソッドはサポートされません。IBM i コネクタのRunコマンドメソッドを使用してください。

コマンドラインパラメータ

コマンドのパラメータのリストを入力します。

タイムアウト

コンポーネントが次のステップに進む前にコマンドを実行するまでの待機時間(秒単位)を入力します。

ログファイル場所

コマンドに対するログファイルのフルパスおよび名前を入力します。

戻り値

をクリックして変数リストを開きます。バッチファイルの実行から返される変数の戻り値コードを選択し、[選択]をクリックします。

この機能は、Windowsベースのプラットフォームでのみ有効で、[タイムアウト]パラメータは0に設定されています。

制限事項

  • 別のバッチファイルからバッチファイルを呼び出すときは、呼び出すバッチファイルを絶対パスで指定するか、<XPI_INST>/Runtimeフォルダに保存する必要があります。

  • バッチファイルまたはスクリプトファイルが存在しない場合、ファイル管理コンポーネントのコマンドラインメソッドは、実際の値ではなくエラーコード1を返します。

Since version: 4.9

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Copy File

選択したコピー先にファイルをコピーします。

ファイル名From

コピーするファイルのフルパスおよび名前を入力します。

ファイル名To

コピー先にファイルのフルパスおよび名前を入力します。

コピー先に同じファイルがある場合、ファイルは上書きされます。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Copy Folder

コピー元フォルダの中身を全てコピー先フォルダにコピーします。

送り元フォルダ

ファイルコピー元のフォルダ

送り先フォルダ

ファイルコピー先のフォルダ。このフォルダが存在しない場合、作成されます。

サブフォルダもコピー

サブフォルダもコピーする場合は、Yesを選択します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Create File

データを新規ファイルに書き込みます。

対象ファイル名

作成するファイルのフルパスおよび名前を入力します。

ファイル名は、半角の英数字かOSの対応言語に基づく文字で指定してください。

エンコーディング

ファイルに書き込むデータのエンコーディングを入力します。デフォルト値はKeep Existingです。

サポートされているエンコーディング値は、Keep ExistingUTF-8 with BOMUTF-8UnicodeAnsiBinaryCustomです。

実行時変換はデータBLOBに対して行われます。(参照:変換テーブル

Since version: 4.7

コードページ

使用したいコードページの値を入力します。[エンコーディング]パラメータでCustomオプションが選択されている場合は、コードページを選択する必要があります。

デフォルトのコードページは、ibm-930_P120-1999です。

参考:サポートされるコードページ一覧

Since version: 4.9

データ

作成するファイルに含まれるデータ

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

対象ファイルが存在する場合は、エラーが送られます。

Create Folder

新しいフォルダを作成します。

フォルダ名

作成するフォルダの名前を入力します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Delete File

指定したファイルを削除します。

ファイル名

削除するファイルの名前を入力します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Delete Folder

フォルダとその中身を削除します。

フォルダ名

削除するフォルダの名前を入力します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Log File

ログデータ文字列の内容でUTF-8形式でログファイルの生成、編集を行ないます。

ログファイル名

作成されるログファイルのフルパスとファイル名を入力します。

ログデータ文字列

ログデータ文字列に送られるデータ。この情報はログファイルの作成と編集に使用されます。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Read File

選択されたファイルのデータを読み込みます。

ファイル名From

読み込まれるファイルのフルパスおよび名前を入力します。

データ

読み込まれるファイルの内容を格納するデータBLOB

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Read Folder

フォルダの中身を読み込み、ファイル名を含むファイルを返します。ファイル名ごとに一行のファイルになります。フォルダ名は頭に\がつきます。例:\TEMP

フォルダ名

読み込むフォルダの名前を入力します。

サブフォルダを含める

サブフォルダも読み込ませたい場合、Yesを選択します。

フォルダリスト

このBLOBは指定されたフォルダのファイルを格納します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Rename File

指定したファイルの名前を変更します。

ファイル名From

移動または名前を変更するファイルのフルパスおよび名前を入力します。

ファイル名To

名前変更するファイルのフルパスおよび名前を入力します。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

対象ファイルが存在する場合は、エラーが送られます。

Rename Folder

特定のフォルダをリネームします。

フォルダ名From

名前を変更するフォルダの名前を入力します。

フォルダ名To

変更するフォルダの名前。既に存在するフォルダの名前は使用できません。新しいドライブやパスを含めることはできません。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Write File

指定したファイルに書き込みを行います。

対象ファイル名

書き出されるデータを取得するファイルのフルパスおよび名前

エンコーディング

ファイルに書き込むデータのエンコーディングを入力します。デフォルト値はKeep Existingです。

サポートされているエンコーディング値は、Keep ExistingUTF-8 with BOMUTF-8UnicodeAnsiBinaryCustomです。

実行時変換はデータBLOBに対して行われます。(参照:変換テーブル

Since version: 4.7

コードページ

使用したいコードページの値を入力します。[エンコーディング]パラメータでCustomオプションが選択されている場合は、コードページを選択する必要があります。

デフォルトのコードページは、ibm-930_P120-1999です。

参考:サポートされるコードページ一覧

Since version: 4.9

データ

ファイルに書き込まれるデータを入力します。

ファイルが存在しない場合、新しいファイルが作成されます。ファイルが存在した場合、上書きされます。

エラーコード

 をクリックして変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

関連トピック:

ダイレクトアクセスメソッドの使い方