> ## Documentation Index > Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt > Use this file to discover all available pages before exploring further. # ICAP Connector > The ICAP connector enables integration with Internet Content Adaptation Protocol servers for real-time security scanning and content adaptation services. export const CommonProxySettings = () => <>

これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションはSecurity Settings ページのProxy Settings 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。

設定説明
Proxy Type プロキシベースのファイアウォールで使用されるプロトコル。
Proxy Host プロキシベースのファイアウォールの名前またはIP アドレス。
Proxy Port プロキシベースのファイアウォールのTCP ポート。
Proxy User プロキシベースのファイアウォールで認証するために使用するユーザー名。
Proxy Password プロキシベースのファイアウォールで認証するために使用するパスワード。
Authentication Scheme デフォルトのNone のままにするか、次の認証スキームのいずれかを選択します：Basic、Digest、Proprietary、またはNTLM。
; export const SlasTab = ({siteName = "CData Arc"}) => <>

サービスレベルアグリーメント（SLA）の設定に関する設定です。

SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA をAt Risk としてマークします。これは、SLA が間もなく達成されない場合にViolated としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。

SLA を定義するには、Expected Volume をオンに切り替え、Settings タブをクリックします。

SLA Empty

次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。

SLA Configuration Example 必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar でSettings をクリックし、Alerts > General Alerts に移動します。タブレットと鉛筆のアイコンをクリックして編集し、SLA Alerts 設定のチェックを外します。 ; export const AlertsTab = ({siteNameShort = "Arc"}) => <>

アラートの設定に関する設定です。

サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} はAlerts タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、Override global setting をオンに切り替えます。

デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、Enable チェックボックスのチェックを外します。

Subject（必須）を入力します。Allow {siteNameShort}Script in Subject をチェックすると、Subject フィールドで{siteNameShort}Script を使用できます。これを選択すると、{siteNameShort}Script エディタボタンが表示されます（arcscript editor button）。

必要に応じてRecipient のメールアドレスをカンマ区切りのリストで入力します。

; export const MiscConnector = () => <>

Miscellaneous 設定は、特定のユースケース向けの設定です。

設定 説明
Other Settings 非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：setting1=value1;setting2=value2）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。
; export const Logging = () => <>

ログの作成と保存を制御する設定です。

設定 説明
Log Level コネクタが生成するログの詳細度です。サポートを依頼する際は、これをDebug に設定してください。
Log Subfolder Scheme 選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。Weekly オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。
Log Messages 処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、Transactions タブからファイルのコピーをダウンロードできなくなる場合があります。
; export const MacrosExamples = ({extraMacros = []}) => <>

%Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。 引数を取るすべてのマクロは次の構文を使用します。%Macro:argument%

引数を取るマクロの例を次に示します。

次の例に示すように、より高度なマクロを作成することもできます。

; export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>

ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。 ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を 動的に含めることができ、各ファイルに有用な文脈を提供します。

{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。%Macro%

{extraMacros.map(item => )}
マクロ説明
ConnectorIDコネクタのConnectorID に評価されます。
ConnectorNameコネクタの名前に評価されます。ファイル名やパスに接続名を含めることができます。例えば、どのデータベース接続が生成したかによってバックアップファイルにタグを付けるために使用できます。
Extコネクタが現在処理しているファイルの拡張子に評価されます。
Filenameコネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。
FilenameNoExtコネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。
MessageIdコネクタが出力しているメッセージのMessageId に評価されます。
RegexFilename:patternコネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。
Header:headernameコネクタが現在処理しているメッセージ上の対象ヘッダー（headername）の値に評価されます。
LongDateシステムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。
ShortDateシステムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。
DateFormat:formatシステムの現在の日時を指定された形式（format）で評価します。利用可能な日時形式については、日付形式のサンプルを参照してください。
Vault:vaultitem指定されたVault アイテムの値に評価されます。
{item.name} {item.description}
; export const Performance = () => <>

コネクタへのリソースの割り当てに関する設定です。

設定 説明
Max Workers このコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。
Max Files コネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。
; export const siteNameShort = "Arc"; export const siteName = "CData Arc"; The ICAP connector enables seamless integration with Internet Content Adaptation Protocol (ICAP) servers in CData Arc. This connector facilitates content adaptation services, particularly real-time security scanning, by acting as an intermediary between your application and ICAP-compliant servers. ## Key Capabilities * Real-time content adaptation and security scanning * Support for both request modification (REQMOD) and response modification (RESPMOD) modes * TLS encryption support for secure communications * Customizable HTTP encapsulation for legacy system compatibility * Flexible authentication options including private certificate support * Functions as a Transform step in the flow. Files that are flagged as needing attention yield errors, while other files proceed down the flow as usual. ## Connector Configuration This section contains all of the configurable connector properties. ### Settings Tab *Settings related to the core configuration of the connector.* | Setting | Description | | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connector Id** | The static, unique identifier for the connector. | | **Connector Type** | Displays the connector name and a description of what it does. | | **Connector Description** | An optional field to provide a free-form description of the connector and its role in the flow. | | **ICAP URI** | (Required) The ICAP Uniform Resource Identifier (URI) of the ICAP server to connect to. Must be in this format: `icap://:/`. | | **Allow {siteNameShort}Script in ICAP URI** | Allows for the evaluation of {siteNameShort}Script expressions in the URI. When you select this, the **{siteNameShort}Script Editor** button appears (arcscript editor button), which enables you to build dynamic request URIs using {siteNameShort}Script. | | **ICAP Headers** | Optional headers for specialized server requirements. Use this to add custom ICAP request headers that you want to include in the outgoing ICAP request. | | **Allow {siteNameShort}Script in Headers** | Allows for the evaluation of {siteNameShort}Script expressions in the headers before the query is issued. For example, `[_ \| now('yyyy-MM-dd')]` evaluates the current date, and `[_message.header:headername]` evaluates the headername header from the input message context. | | **TLS Configuration** | Check this to enable TLS encryption for the ICAP connection. | | **TLS Server Certificate** | The public key certificate used to verify the identity of an TLS/SSL server. This is only necessary if the ICAP server has enabled TLS. Set it to `Any Certificate` to unconditionally trust the ICAP server's identity. Only relevant when **TLS Configuration** is enabled. | | **Local File Scheme** | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros). | ### Advanced Tab #### TLS Client Authentication | Setting | Description | | ------------------------ | ------------------------------------------------------------------------ | | **Private Certificate** | Select, create, or upload the TLS certificate to use for authentication. | | **Certificate Password** | The password required to access the **Private Certificate**. | #### Other Settings | Setting | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **ICAP Mode** | Specify the type of ICAP transaction: use REQMOD for request modification or RESPMOD for response modification. The default is REQMOD. | | **Preview size** | Controls the size of the message body preview sent to the ICAP server. `Automatic` makes your client query the server using an OPTIONS request to determine the optimal preview size. Alternatively, you can specify an exact number (in bytes) to use for the preview size. | | **Chunk size** | The maximum size (in bytes) of each data chunk sent after the preview phase (or for requests without a preview). The default is 16KB. | | **Timeout (seconds)** | The length of time in seconds that the connector waits for a connection response before throwing a timeout error. The default is 60 seconds. | | **Response Headers** | A comma-separated list of ICAP response header names (such as `X-Infection-Found,X-Scan-Result`) to be extracted and added as metadata to the processed message. | | **TLS Enabled Protocols** | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. SSL v2 and SSL v3 are considered vulnerable and should only be used if your partner does not support higher versions. Keep in mind that TLS v1.3 is not universally adopted, and might be refused if the destination server does not support it. | #### Proxy Settings #### Logging #### Miscellaneous ### Automation Tab #### Automation Settings *Settings related to the automatic processing of files by the connector.* | Setting | Description | | -------- | ------------------------------------------------------------------------------------ | | **Send** | Whether files arriving at the connector are automatically sent as ICAP transactions. | #### Performance ### Alerts Tab ### SLAs Tab ### Transactions Tab This tab lists all messages associated with the connector. Use the search bar to find specific messages, or click the funnel icon to apply a filter. You can filter by time, message direction, and/or status. Incoming responses appear on this tab. ### Events Tab | Event | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Response** | This event lets you extend the way the connector interprets replies from the ICAP server. By default, the connector finalizes messages based on the ICAP server's status code. However, since ICAP servers can also include scan details in response headers, the Response event lets you apply custom logic to those headers for more granular control. No output is created from this event; instead, you can use the `arc:throw` keyword to block the file (for example, if a particular header value indicates a failed scan). | | **Before Send** | This event fires after the connector has fully prepared a file to send/process a file, but before the sending/processing actually occurs. | | **After Receive** | This event fires after the connector has received a file. | The following are available in the Response event: * StatusCode: The ICAP response status code (such as 200, 204, or 4xx) * \_response: The ICAP response. You can use `[_response.header:xxx]` to get a specific header. * \_message: To refer to the input message (headers and body), and adding headers to the output. ## Macros ### Examples