4.13.43 文字列の置換
機能
WindowsまたはUNIX環境で，指定したファイルの特定の文字列を，すべて指定した文字列に置換します。実行対象サーバがWindowsの場合SJISで，UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードで文字列置換を行います。
指定したファイルは，指定した置換処理を実施した内容で上書きされます。
ファイル内に，置換対象文字列に合致する文字列が存在しない場合は，ファイルの内容は変更しません。
この部品では，次のサーバを前提とします。
・実行対象サーバ
この部品を実行する対象となるサーバです。
common.replaceTargetプロパティの指定について
・正規表現の使用はサポートしていません。
・実行対象サーバのOSがWindowsの場合に｢¥｣，｢[｣，｢]｣，｢?｣，｢^｣，｢+｣，｢*｣，｢.｣，｢@｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。ただし，｢¥」を文字列の末尾または1文字のみ指定する場合は，「¥¥¥¥」と入力してください。また，｢#｣，｢{｣，｢}｣，｢'｣，｢;｣，｢&｣，｢,｣，｢`｣，｢<｣，｢>｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。ただし，1文字以上のスペースだけを指定する場合は，「'」(シングルクォート)で囲む必要があります（例：「' '」）。｢(｣，｢)｣，｢|｣，｢$｣を指定する場合は，｢¥`｣(円記号とバッククォート)でエスケープしてください。
・実行対象サーバのOSがUNIXの場合に｢¥｣(円記号)を指定する場合は，｢¥¥｣と入力してください。また，｢!｣，｢$｣，｢[｣，｢]｣，｢/｣，｢.｣，｢^｣，｢*｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。
・またWindowsおよびUNIXに関係なく｢"｣は入力しないでください。｢"｣を指定する場合は，｢¥0x22｣と入力してください。
common.replaceStrプロパティの指定について
・実行対象サーバのOSがWindowsの場合，｢`t｣(タブ)および｢`r`n｣(改行)のメタ文字を使用できます。また，｢¥｣を文字列の末尾または1文字のみ指定する場合は，｢¥¥｣と入力してください。｢`｣，｢#｣，｢,｣，｢@｣，｢|｣，｢{｣，｢}｣，｢'｣，｢;｣，｢&｣，｢(｣，｢)｣，｢<｣，｢>｣，｢$｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。ただし，1文字以上のスペースだけを指定する場合は，「'」(シングルクォート)で囲む必要があります（例：「' '」）。
・実行対象サーバのOSがUNIXの場合，｢¥t｣(タブ)および｢¥n｣(改行)のメタ文字を使用できます。文字列内に｢¥｣(円記号)を指定する場合は，｢¥¥｣と入力してください。また，文字列内に｢!｣，｢/｣，｢$｣，｢&｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。
・またWindowsおよびUNIXに関係なく｢"｣は入力しないでください。｢"｣を指定する場合は，｢¥0x22｣と入力してください。
利用場面
定義ファイルを編集する場合に利用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
(12) AIX V6
(13) AIX V7
【実行対象サーバの使用条件】
なし。
注意事項
(1) この部品を同一ファイルに対して同時に実行しないでください。
(2) サロゲートペア文字および制御文字は指定できません。
(3) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。
バージョン
03.01.00
部品のタグ
Control OS,Windows,Linux,AIX
タスクログに表示される部品の名称
osReplaceString
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
14 |
異常(ユーザーミス) ファイルアクセス不可 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.strFilePath |
文字列を置換するファイルのパス |
文字列を置換するファイルのパスをフルパスで指定します。 |
− |
入力 |
○ |
|
common.replaceTarget |
置換対象の文字列 |
ファイル内の置換対象の文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。 |
− |
入力 |
○ |
|
common.replaceStr |
置換後の文字列 |
置換後の文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |