4.13.27 ファイルの文字エンコード変換
機能
この部品は，対象のテキストファイルを指定した変換前の文字エンコードで読み込み，指定した変換後の文字エンコードで別のテキストファイルに出力します。
対象ファイルパス(common.targetFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。
文字エンコード種別(変換前)(common.characterEncodingFromプロパティ)に指定された文字エンコード種別で対象ファイルパス(common.targetFilePathプロパティ)に指定されたファイルを読み込み，出力ファイルのパス(common.outputFilePathプロパティ)に指定されたパスに文字エンコード種別(変換後)(common.characterEncodingToプロパティ)に指定された文字エンコード種別でファイルを出力します。
出力先ファイルパス(common.outputFilePathプロパティ)に指定されたパスにフォルダが存在しない場合，フォルダを作成します。
また，出力ファイルのパス(common.outputFilePathプロパティ)に指定したパスに既にファイルが存在する場合は，部品は異常終了します。
指定できるエンコード種別は"JIS"，"SJIS"，"EUC-JP"，"UTF-8"の4種類です。これ以外のエンコード種別を指定した場合は，部品は異常終了します。また，文字エンコード種別(変換後)(common.characterEncodingToプロパティ)に"UTF-8"を指定した場合は，BOM無しでテキストファイルに出力します。
利用場面
OS間のファイル移動などの際に，特定の文字エンコード種別で出力されたファイルを，移動先で使用できる文字エンコード種別へ変換したい場合などに使用します。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
【実行対象サーバの使用条件】
なし。
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)変換する文字エンコード種別によっては，OS間で文字コードが異なり，文字化けする場合があります。
(3)実行対象サーバがUNIXの場合，BOM有りのUTF-8のテキストファイルを変換前の対象ファイルに指定しないでください。その場合，部品が異常終了したり，変換後のテキストファイルが文字化けする場合があります。
(4)対象のファイルパス(common.targetFilePathプロパティ)で指定したファイルが空の場合，実行対象サーバがWindowsの場合は出力ファイルのパス(common.outputFilePathプロパティ)で指定した場所に空ファイルを作成し，UNIXの場合はファイルの作成を行いません。
(5)文字エンコード種別の変換対象として機種依存文字および文字エンコード種別の範囲外の文字を指定しないでください。その場合，部品が異常終了したり，変換後のテキストファイルが文字化けする場合があります。
(6)対象のファイルパス(common.targetFilePathプロパティ)で指定したファイル内の文字の文字エンコード種別と文字エンコード種別(変換前)(common.characterEncodingFrom)で指定した文字エンコード種別は同一のものを指定してください。別の文字エンコード種別を指定した場合，部品が異常終了したり，文字化けが発生するおそれがあります。
バージョン
02.00.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osConvertFileCharacterEncoding
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.targetFilePath |
対象ファイルのパス |
対象ファイルをフルパスで指定します。 |
− |
入力 |
○ |
|
common.characterEncodingFrom |
文字エンコード種別(変換前) |
変換対象ファイルの文字エンコード種別として"JIS"，"SJIS"，"EUC-JP"，"UTF-8"のどれかを指定します。 |
− |
入力 |
○ |
|
common.characterEncodingTo |
文字エンコード種別(変換後) |
変換後の文字エンコード種別として"JIS"，"SJIS"，"EUC-JP"，"UTF-8"のどれかを指定します。 |
− |
入力 |
○ |
|
common.outputFilePath |
出力ファイルのパス |
出力するファイルをフルパスで指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |