> ## Documentation Index > Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt > Use this file to discover all available pages before exploring further. # ICAP 端口 > ICAP 端口支持与互联网内容适配协议 (ICAP) 服务器集成，提供实时安全扫描和内容适配服务。 ICAP 端口支持与 知行之桥 中的互联网内容适配协议 (ICAP) 服务器无缝集成。此端口充当应用程序和 ICAP 兼容服务器之间的中介，从而促进内容适配服务，尤其是实时安全扫描。 ## 关键功能 * 实时内容适配和安全扫描 * 支持请求修改 (REQMOD) 和响应修改 (RESPMOD) 模式 * 支持 TLS 加密，确保安全通信 * 可自定义 HTTP 封装，兼容旧系统 * 灵活的身份验证选项，包括私有证书支持 * 可用作流程中的"转换"步骤。标记为需要注意的文件会产生错误，而其他文件则照常继续执行流程。 ## 端口配置 此部分包含所有可配置的端口属性。 ### 设置 *与端口核心配置相关的设置。* | 设置 | 描述 | | - | - | | **端口 ID** | 端口的静态唯一标识符。 | | **端口类型** | 显示端口名称及其功能描述。 | | **端口描述** | 可选字段，用于对端口及其在工作流中的角色进行自由格式描述。 | | **ICAP URI** | （必需）要连接的 ICAP 服务器的 ICAP 统一资源标识符 (URI)。必须采用以下格式：`icap://:/`。 | | **ICAP 头** | 可选标头，用于满足特定服务器的要求。使用此选项可添加要包含在传出 ICAP 请求中的自定义 ICAP 请求标头。 | | **TLS 配置** | 勾选此项可为 ICAP 连接启用 TLS 加密。 | | **TLS 服务器证书** | 用于验证 TLS/SSL 服务器身份的公钥证书。仅当 ICAP 服务器启用了 TLS 时才需要此项。将其设置为 `Any Certificate` 可无条件信任 ICAP 服务器的身份。仅在启用 **TLS 配置** 时才相关。 | | **本地文件命名方案** | 为端口输出消息分配文件名的方案。可以在文件名中使用宏来动态包含标识符和时间戳等信息。更多信息，请参阅[宏](#宏)。 | ### 高级选项卡 #### TLS 客户端身份验证 | 设置 | 描述 | | - | - | | **私钥证书** | 选择、创建或上传用于身份验证的 TLS 证书。 | | **证书密码** | 访问 **私钥证书** 所需的密码。 | #### 其他设置 | 设置 | 描述 | | - | - | | **ICAP 模式** | 指定 ICAP 事务的类型：使用 REQMOD 进行请求修改，或使用 RESPMOD 进行响应修改。默认为 REQMOD。 | | **Allow ArcScript in ICAP URI** | 允许计算 URI 中的 ArcScript 表达式。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_arcscript_editor.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=9113829cbe1ae9572316802c46a91bec)），可用于通过 ArcScript 构建动态请求 URI。 | | **Allow ArcScript in Headers** | 允许在发出查询之前计算标头中的 ArcScript 表达式。例如，`[_ \| now('yyyy-MM-dd')]` 计算当前日期，`[_message.header:headername]` 计算输入消息上下文中的 headername 标头。 | | **预览大小** | 控制发送到 ICAP 服务器的消息正文预览的大小。`Automatic` 选项会让客户端使用 OPTIONS 请求查询服务器，以确定最佳预览大小。或者，可以指定预览大小的确切数字（以字节为单位）。 | | **数据块大小** | 预览阶段后发送的每个数据块的最大大小（以字节为单位）（或对于没有预览的请求）。默认值为 16KB。 | | **超时（秒）** | 端口在抛出超时错误之前等待连接响应的时间（以秒为单位）。默认值为 60 秒。 | | **响应标头** | 以逗号分隔的 ICAP 响应标头名称列表（例如 `X-Infection-Found,X-Scan-Result`）将被提取并作为元数据添加到已处理的消息中。 | | **TLS 已启用协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有在贸易伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持它，可能会被拒绝。 | #### 代理设置 这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 页面的 [代理设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。
设置描述
**代理类型** 基于代理的防火墙使用的协议。
**代理主机** 基于代理的防火墙的名称或 IP 地址。
**代理端口** 基于代理的防火墙的 TCP 端口。
**代理用户** 用于通过基于代理的防火墙进行身份验证的用户名。
**代理密码** 用于对基于代理的防火墙进行身份验证的密码。
**身份验证方案** 保留默认值 **None** 或选择以下身份验证方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。
#### 日志 *用于管理日志创建和存储的设置。*
设置 描述
**日志级别** 指定要记录在端口日志目录中的信息类型：
  • **None** - 不创建任何日志。
  • **Error** - 仅当端口遇到错误时才创建日志。
  • **Warning** - 仅当端口发出警告时才创建日志。
  • **Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。
  • **Debug** - 记录成功和失败工作流的详细调试信息。
  • **Trace** - 记录成功和失败工作流的详细跟踪信息。
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
**日志文件夹结构** 指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
**保留消息副本** 指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。
#### 杂项 *特殊设置适用于特定用例。*
设置 描述
**其他设置** 允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。
### 自动化 #### 自动化设置 *与端口自动处理文件相关的设置。* | 设置 | 描述 | | - | - | | **发送** | 到达端口的文件是否自动作为 ICAP 事务发送。 | #### 性能 *与端口资源分配相关的设置。*
设置 描述
**最大工作线程数** 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。
**最大文件数** 分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。
### 告警选项卡 *与配置通知相关的设置。* 在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。 默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 **启用** 复选框。 输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。 （可选）输入以逗号分隔的**收件人**电子邮件地址列表。 ### SLA 选项卡 *与配置服务级别协议 (SLA) 相关的设置。* SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥 会发送电子邮件警告用户，并将 SLA 标记为 *存在风险*，这意味着如果 SLA 未能尽快达到，则会被标记为 *已违反*。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。 SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。 要定义 SLA，请启用 **预期数据量**，然后点击 **设置** 选项卡。 ![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png)
  • 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
  • 在窗口的 **预计至少** 部分中：
    • 设置预计处理的最小事务数量（交易量）
    • 使用 **每个** 字段指定时间范围
    • 指示 SLA 生效的时间。如果选择 **开始于**，请填写日期和时间字段。
    • 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 **每天**。
  • 在窗口的 **将状态设置为“有风险”** 部分中，指定应将 SLA 标记为有风险的时间。
    • 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 **发送“有风险”通知**。
以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。 ![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png) > [!NOTE] > > 如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 **设置**，然后跳转到 **通知 > 通用通知**。点击平板和铅笔图标进行编辑，并取消勾选 **SLA 通知** 设置。 ### 事务 此选项卡列出了与端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。您可以按时间、消息方向和／或状态进行过滤。 收到的响应会显示在此选项卡上。 ### 事件 | 事件 | 描述 | | - | - | | **Response** | 此事件允许扩展端口解析来自 ICAP 服务器的回复的方式。默认情况下，端口会根据 ICAP 服务器的状态代码最终确定消息。但是，由于 ICAP 服务器也可以在响应标头中包含扫描详细信息，因此可以通过 Response 事件对这些标头应用自定义逻辑，以实现更精细的控制。此事件不会创建任何输出；但是，可以使用 `arc:throw` 关键字来阻止文件（例如，如果特定标头值指示扫描失败）。 | | **Before Send** | 此事件在端口完全准备好文件以发送/处理文件之后，但在实际发送/处理发生之前触发。 | | **After Receive** | 此事件在端口收到文件之后触发。 | Response 事件中可用的参数如下： * StatusCode：ICAP 响应状态代码（例如 200、204 或 4xx） * \_response：ICAP 响应。您可以使用 `[_response.header:xxx]` 获取特定的响应头。 * \_message：用于引用输入消息（响应头和正文），并将响应头添加到输出中。 ## 宏 在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。 知行之桥 支持这些宏，它们都使用以下语法：`%Macro%`。
宏描述
ConnectorID替换为端口的 ConnectorID。
ConnectorName替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。
Ext替换为端口当前正在处理的文件的文件扩展名。
Filename替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId计算端口输出的消息的 MessageId。
RegexFilename:*pattern*将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:*headername*替换为端口正在处理的当前消息的目标消息头（`headername`）的值。
LongDate以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:*format*以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。
Vault:*vaultitem*计算指定保管库项目的值。
### 示例 某些宏（例如 %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](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中项目的名称。例如，`%Vault:companyname%` 解析为存储在保管库中的 `companyname` 项的值。
  • %DateFormat:format%：其中 `format` 是可接受的日期格式（有关详细信息，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#sample-date-formats)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 解析为文件上的日期和时间戳。
还可以创建更复杂的宏，如以下示例所示：
  • 将多个宏组合在一个文件名中：`%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%`
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.