4.13.22 ファイルの圧縮
機能
この部品は，WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルおよびフォルダを圧縮します。実行対象サーバがWindowsの場合はzip，実行対象サーバがUNIXの場合はtarでアーカイブしたあとにgzipで圧縮します。ファイルの拡張子は，実行対象サーバがWindowsの場合は「zip」，実行対象サーバがUNIXの場合は「tgz」となります。出力ファイル名は圧縮対象のファイル名(Windowsの場合は拡張子を除いたファイル名)またはフォルダ名に拡張子を付加したものとなります。圧縮されたファイルおよびフォルダは，出力先のフォルダパス(common.outputDestFolderPathプロパティ)に指定したフォルダ配下に出力されます。圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)で指定したパス先のファイルおよびフォルダについては，削除されません。圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。
圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)について，次に示します。
・圧縮対象のファイルまたはフォルダをフルパスで指定してください。
出力先のフォルダパス(common.outputDestFolderPathプロパティ)について，次に示します。
・出力先のフォルダをフルパスで指定してください。フォルダパスが存在しない場合は，この部品でフォルダを作成します。
利用場面
ログファイルなどのデータを圧縮し，別のサーバに転送する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働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)
【実行対象サーバの使用条件】
実行対象サーバがWindowsの場合は，.NET Framework 4.5.2以降とWindows PowerShell 3.0以降がインストールされていること。
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)実行対象サーバがUNIXの場合は，プロパティに半角の「¥」を使用しないでください。
(3)複数のファイルおよびフォルダを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。
(4)ショートカットとシンボリックリンクを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。
(5)実行対象サーバがWindowsの場合は，上位のフォルダにリンクされているシンボリックリンクを含むフォルダを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。部品が異常終了します。
(6)実行対象サーバがUNIXの場合は，圧縮コマンド失敗時に出力先のフォルダパス(common.outputDestFolderPathプロパティ)にjp1ao_plug-in_error.logというファイルを作成し，エラー内容を出力します。不要な場合は削除してください。なお，jp1ao_plug-in_error.logは上書きされます。
(7)部品が異常終了して次のエラーがタスクログに表示された場合は，jp1ao_plug-in_error.logを参照して，エラー要因を取り除いてください。「KNAE08132-E コマンドの標準出力のサイズが上限値を超えたため，処理を中断しました（上限値：100キロバイト）。」
(8)実行対象サーバがWindowsの場合はドライブパス，実行対象サーバがUNIXの場合はルートを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。
(9)圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定したフォルダまたはフォルダ配下を出力先のフォルダパス(common.outputDestFolderPathプロパティ)に指定することはできません。部品が異常終了します。
(10)出力先のフォルダパス(common.outputDestFolderPathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きしません。部品が異常終了します。
(11)実行対象サーバがWindowsの場合は，出力先のフォルダパスが「248文字以上」，出力先のフォルダパスと出力ファイル名の合計が「260文字以上」となると圧縮できません。部品が異常終了します。
(12)ファイル単体を圧縮する場合はメモリ容量に依存するため圧縮できない場合があります。ファイル容量が大きい場合はフォルダに格納してから圧縮してください。
(13)この部品は同期処理のため，圧縮が完了するまで待つ必要があります。
(14)圧縮に掛かる時間は，ファイルの容量に比例します。
バージョン
02.00.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osCompressFile
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.compressSourceFilePath |
圧縮対象のファイルパス |
圧縮対象のファイルまたはフォルダをフルパスで指定してください。 |
− |
入力 |
○ |
|
common.outputDestFolderPath |
出力先のフォルダパス |
出力先のフォルダをフルパスで指定してください。 |
− |
入力 |
○ |
|
common.returnCompressFilePath |
圧縮ファイルパス |
出力した圧縮ファイルのフルパスが格納されます。 |
− |
出力 |
− |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |