Zip Connector
Version 24.3.9106
Version 24.3.9106
Zip Connector
The Zip Connector supports automatic compression and decompression of archives in various formats.
Overview
Zip Connectors automatically compress or decompress incoming files depending on the Operation setting of the connector. In Compress mode, each file is zipped independently, so the number of output Zip archives is equal to the number of input files. In Decompress mode, all files are extracted from input archives and output as an individual file; folder structure is ignored.
Zip Connectors can be configured to compress and decompress archives in a variety of formats, including 7zip, Bzip2, Gzip, and Tar.
Connector Configuration
This section contains all of the configurable connector properties.
Settings Tab
Configuration
Settings related to the core operation of the connector.
- コネクタId コネクタの静的な一意の識別子。
- コネクタの種類 コネクタ名とその機能の説明が表示されます。
- コネクタの説明 コネクタとフローにおけるロールについて自由形式の説明を記載するオプションのフィールド。
- Operation Whether the connector is compressing or decompressing incoming files. Trying to decompress files that are not compressed in a supported format results in an error.
Archive Options
Settings related to the archive being processed or created.
- Archive Format The expected format of the input archive (when decompressing), or the format of the archive that is created (when compressing).
- Compression Method The specific algorithm to use when compressing.
- Compression Level The level of compression to apply when compressing. Higher values allow better compression; lower values allow faster compression. A value of 0 stores the file without compression.
Encryption
Settings related to encrypting archives during compression, if allowed by the archive format.
- Encryption Algorithm The algorithm to use when encrypting.
- Password The password required to decrypt the archive.
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.
By default, the Enable automation checkbox is checked. If you uncheck it, you cannot use the other automation settings.
- Send Whether messages arriving at the connector are automatically processed.
- Scheduled Send Whether to process incoming messages at a scheduled interval. This allows multiple files to accumulate in the input folder, then all be zipped together in the same archive.
Note: The following archive formats do not support compressing multiple files: Bzip, Gzip, and Zcompress. An error is generated if this setting is enabled on those archive formats. - Send Interval The interval at which to compress all available input files into the same archive. Only available if Scheduled Send is enabled.
- 毎時何分 時間単位のスケジュールの分オフセット。上記の受信間隔の設定が Hourly に設定されている場合にのみ適用されます。例えば、この値を5 に設定すると、自動的に1:05、2:05、3:05 のようにダウンロードを行います。
- 時 試行が行われる時刻。上記の受信間隔の設定が Daily 、Weekly、または Monthly に設定されている場合にのみ適用されます。
- 曜日/日付 試行が行われる日。上記の受信間隔の設定が Weekly または Monthly に設定されている場合にのみ適用されます。
- 分 ダウンロードを試行するまでの待機時間。上記の受信間隔の設定が Minute に設定されている場合にのみ適用されます。
- Cron 式 いつ試行するかを決定するcron 式を表す5つの欄の文字列。上記の受信間隔の設定が Advanced に設定されている場合にのみ適用されます。
Performance
コネクタへのリソースの割り当てに関する設定。
- 最大ワーカー数 このコネクタでファイルを処理するためにスレッドプールで消費されるワーカースレッドの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。
- 最大ファイル数 コネクタに割り当てられた各スレッドが送信するファイルの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。
アラートタブ
アラートとサービスレベル(SLA)の設定に関連する設定。
コネクタのE メール設定
サービスレベル(SLA)を実行する前に、通知用のE メールアラートを設定する必要があります。アラートを設定をクリックすると、新しいブラウザウィンドウで設定ページが開き、システム全体のアラートを設定することができます。詳しくは、アラートを参照してください。
サービスレベル(SLA)の設定
サービスレベルでは、フロー内のコネクタが送受信すると予想される処理量を設定し、その量が満たされると予想される時間枠を設定できます。CData Arc は、サービスレベルが満たされていない場合にユーザーに警告するE メールを送信し、SLA を At Risk(危険) としてマークします。これは、サービスレベルがすぐに満たされない場合に Violated(違反) としてマークされることを意味します。これにより、ユーザーはサービスレベルが満たされていない理由を特定し、適切な措置を講じることができます。At Risk の期間内にサービスレベルが満たされなかった場合、SLA はViolated としてマークされ、ユーザーに再度通知されます。
サービスレベルを定義するには、予想処理量の条件を追加をクリックします。
- コネクタに個別の送信アクションと受信アクションがある場合は、ラジオボタンを使用してSLA に関連する方向を指定します。
- 検知基準(最小)を、処理が予想されるトランザクションの最小値(量)に設定し、毎フィールドを使用して期間を指定します。
- デフォルトでは、SLA は毎日有効です。これを変更するには、毎日のチェックをOFF にし、希望する曜日のチェックをON にします。
- 期間終了前にステータスを’At Risk’ に設定するタイミングを使用して、SLA がAt Risk としてマークされるようにします。
- デフォルトでは、通知はSLA が違反のステータスになるまで送信されません。これを変更するには、‘At Risk’ 通知を送信のチェックをON にします。
次の例は、月曜日から金曜日まで毎日1000ファイルを受信すると予想されるコネクタに対して構成されたSLA を示しています。1000ファイルが受信されていない場合、期間終了の1時間前にAt Risk 通知が送信されます。
Advanced Tab
Other Settings
Settings not included in the previous categories.
- Extract To Folder The folder where the connector should place files extracted from an archive.
- 処理の遅延 インプットフォルダに置かれたファイルの処理を遅延させる時間(秒)。これは旧式の設定です。代替として、ローカルファイルシステムの管理にはFile コネクタの使用がベストプラクティスです。
- ローカルファイルスキーム コネクタがアウトプットするメッセージにファイル名を割り当てるスキーム。ファイル名にマクロを動的に使用して、識別子やタイムスタンプなどの情報を含めることができます。詳しくは、マクロ を参照してください。
Message
Message settings determine how the connector searches for messages and manages them after processing. You can save messages to your Sent folder or you can group them based on a Sent folder scheme, as described below.
- Sent フォルダに保存 チェックすると、コネクタで処理されたファイルをコネクタのSent フォルダにコピーします。
- Sent Folder Scheme Instructs the connector to group files in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the Sent folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.
Logging
- Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
- Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
- Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.
Miscellaneous
Miscellaneous settings are for specific use cases.
- Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example,
setting1=value1;setting2=value2
). Normal connector use cases and functionality should not require the use of these settings.
Subfolder Headers
The Zip connector makes use of the Subfolder header for reading from and writing to compressed files. A Subfolder header is added any time there are subfolders in the zip structure.
Note: When compressing files, the Subfolder header is only used when you set Scheduled Send on the Automation tab.
For example, this image from the Message Details page for a log entry shows the path to the subfolder in the Other Headers section.
When decompressing a file:
- The message for each file that is in a subfolder in the compressed file contains a Subfolder header in its metadata.
- This header displays the path to the subfolder in the zip folder structure.
- This subfolder header is supported by other connectors that support a subfolder header in Send operations.
When compressing files, the connector looks for a Subfolder header on messages that it processes to determine where to place the files inside the compressed structure.
Macros
ファイルの命名規則にマクロを使用することで、組織の効率とデータの文脈的理解を高めることができます。マクロをファイル名に組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を動的に含めることができ、各ファイルに有益なコンテキストを付与できます。これにより、組織にとって重要な詳細をファイル名に反映させることができます。
CData Arc はこれらのマクロをサポートしており、すべて次の構文を使用します:%Macro%
Macro | 説明 |
---|---|
ConnectorID | コネクタのConnectorID を返します。 |
Ext | コネクタが処理中のファイルの拡張子を返します。 |
Filename | コネクタが処理中のファイルのファイル名(拡張子を含む)を返します。 |
FilenameNoExt | コネクタが処理中のファイルのファイル名(拡張子なし)を返します。 |
MessageId | コネクタがアウトプットするメッセージのMessageId を返します。 |
RegexFilename:pattern | コネクタで処理中のファイルのファイル名にRegEx パターンを適用します。 |
Header:headername | コネクタが処理中のメッセージのヘッダー(headername )の値を返します。 |
LongDate | システムの現在の日時を長い形式(例:Wednesday, January 24, 2024)で返します。 |
ShortDate | システムの現在の日時をyyyy-MM-dd 形式(例:2024-01-24)で返します。 |
DateFormat:format | システムの現在の日時を指定されたフォーマット(format )で返します。使用可能な日付フォーマットについては、サンプル日付フォーマット を参照してください。 |
Vault:vaultitem | 指定されたvault 項目の値を返します。 |
例
%Ext% や%ShortDate% などの引数を必要としないマクロもありますが、引数を必要とするマクロもあります。引数を渡すマクロはすべて次の構文を用います:%Macro:argument%
以下は、引数を渡すマクロの例です。
- %Header:headername%:
headername
はメッセージのヘッダー名です。 - %Header:mycustomheader% は、インプットメッセージで設定された
mycustomheader
ヘッダーの値を返します。 - %Header:ponum% は、インプットメッセージで設定された
ponum
ヘッダーの値に対応します。 - %RegexFilename:pattern%:
pattern
は正規表現パターンです。例えば、%RegexFilename:^([\w][A-Za-z]+)%
はファイル名の最初の単語と照合し、大文字と小文字を区別せずに結果を返します(test_file.xml
はtest
に変換されます)。 - %Vault:vaultitem%:
vaultitem
は、vault のアイテム名です。例えば、%Vault:companyname%
はVault に保存されているcompanyname
アイテムの値を返します。 - %DateFormat:format%:
format
は使用可能な日付フォーマットです(詳細はサンプル日付フォーマット を参照してください)。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
はファイルの日付とタイムスタンプを返します。
以下の例に示すように、より詳細なマクロを作成することもできます。
- 複数のマクロを1つのファイル名にまとめる:
%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
- マクロの外側にテキストを含める:
MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
- マクロ内にテキストを含める:
%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%