Version 26.2.9636

• 核心功能
• 概述
• 先决条件
• 端口配置
  • 设置选项卡
    • 设置
    • TLS 设置
    • 客户端身份验证
    • 其他设置
  • 高级页面
    • 消息
    • 日志
    • 其它设置
    • 特殊设置
  • 自动化选项卡
    • 自动化设置
    • 性能
  • 通知选项卡
  • SLA 选项卡
• 建立连接
• 发送消息
• 接收消息
• 宏
  • 示例

IBM MQ 端口通过 REST API 提供对 IBM MQ 队列的访问。

核心功能

• 通过 IBM MQ REST API 集成实现企业级消息队列功能
• 支持具有 TLS 加密功能的队列管理器（Queue Manager）连接
• 支持双向消息处理，并具备可配置的身份验证功能
• 自动重试逻辑，可配置重试间隔及最大尝试次数

概述

IBM MQ 端口配置有特定的队列，消息可以推送到该队列或从中检索消息。到达端口的交易选项卡的文件作为消息推送到队列，而从队列中提取的消息作为文件写入交易选项卡。每个端口实例只能配置一个队列。

先决条件

要与 IBM MQ 建立连接，用户至少必须具备：

• 一台 IBM MQ 服务器，以及从 知行之桥 到该服务器的清晰网络路径

• 至少有一个活动队列的队列管理器

注意：我们不提供创建或配置 IBM MQ 服务器的设置帮助或支持。有关 IBM MQ 服务器设置的疑问，请参阅 IBM MQ 简介 文档。

端口配置

本节包含所有可配置的端口属性。

设置选项卡

设置

与端口核心配置相关的设置。

• 端口 Id 端口的静态、唯一标识符。
• 端口类型 显示端口类型及其用途的描述。
• 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
• 远程主机地址 托管 MQ 服务的系统的主机名或 IP 地址。
• 远程主机端口 MQ 服务正在侦听的远程主机上的端口。
• 队列管理器 所需队列的本地队列管理器的名称。
• 队列 将消息推送到或从中提取消息的队列的名称。

TLS 设置

与传输安全相关的设置。

• 连接 IBM MQ 服务器时使用 TLS 连接和与 IBM MQ 服务器通信时是否使用 TLS 加密作为传输安全。禁用时，所有通信都将以明文形式进行。
• 服务器公共证书 启用 TLS 时，应将此字段设置为 IBM MQ 提供的 TLS/SSL 证书以验证其身份。这可以设置为“任何证书”以隐式信任目标服务器。

客户端身份验证

与针对远程服务进行身份验证相关的设置。

• 用户名 用于对远程服务器进行身份验证的用户名凭据。
• 密码 用于对远程服务器进行身份验证的密码凭据。

其他设置

未包含在先前类别中的设置。

• 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息，请参阅宏。

高级页面

消息

• 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
• 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口，使用子文件夹有助于保持消息的组织性并提高性能。

日志

• 日志级别 端口生成的日志详尽程度。请求支持时，请将此项设置为 Debug。
• 日志子文件夹方案：指示端口根据所选的时间间隔对日志（Logs）文件夹中的文件进行分组。每周（Weekly）选项（默认设置）指示端口每周创建一个新子文件夹，并将该周的所有日志存储在其中。如果此设置留空，则端口将所有日志直接保存在日志文件夹中。对于处理大量事务的端口，使用子文件夹有助于保持日志井然有序并提高性能。
• 日志消息 勾选此项后，处理文件的日志条目将包含该文件本身的副本。如果禁用此项，可能无法从交易选项卡下载文件副本。

其它设置

• 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统，而不是此设置。

特殊设置

特殊设置 适用于特定用例。

• 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置，例如setting1=value1;setting2=value2。 正常的端口用例和功能不需要使用这些设置。

自动化选项卡

自动化设置

与端口自动处理文件相关的设置。

• 发送 到达端口的文件是否会自动发送。
• 重试间隔 重试发送失败之前的时间量。
• 最大重试次数 端口处理输入文件的最大次数。是否成功基于服务器相应和回执的验证（如需要回执）。如果设置为 0，那么端口将无限次尝试处理失败文件。
• 接收 端口是否应自动轮询请求数据源。
• 间隔 自动接收尝试之间的间隔。
• 分 每次执行等待的分钟数。仅当执行间隔被设置为 Minute 时适用。
• 第几分钟/小时 每小时计划的分钟偏移量。仅当执行间隔被设置为 Hourly 时适用。例如，如果将此值设置为 5，将在 1:05、2:05、3:05 自动执行脚本。
• 时 在指定的某一天内进行消息处理的时间。仅当执行间隔被设置为 Daily 或 Weekly 或 Monthly 时适用。
• 天 进行消息处理的某一天。仅当执行间隔被设置为 Weekly 或 Monthly 时适用。
• Cron 表达式 表示 cron 表达式的任意字符串，用于确定何时执行。仅当执行间隔被设置为 Advanced 时适用。

性能

与端口资源分配相关的设置。

• 最大工作线程数 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。
• 最大文件数 分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。

通知选项卡

与配置通知相关的设置。

在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥使用 通知 选项卡上的全局设置。要为此端口使用其他设置，请启用覆盖全局设置。

默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中启用复选框。

输入主题（必填），然后（可选）输入以逗号分隔的收件人电子邮件列表。

SLA 选项卡

与配置服务级别协议 (SLA) 相关的设置。

SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥会发送电子邮件警告用户，并将 SLA 标记为_存在风险_，这意味着如果 SLA 未能尽快达到，则会被标记为_已违反_。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为_已违反_，并再次通知用户。

要定义 SLA，请启用预期数据量，然后点击设置选项卡。

• 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
• 在窗口的预计至少部分中：
  • 设置预计处理的最小事务数量（交易量）
  • 使用每个字段指定时间范围
  • 指示 SLA 生效的时间。如果选择开始于，请填写日期和时间字段。
  • 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择每天。
• 在窗口的将状态设置为“有风险”部分中，指定应将 SLA 标记为有风险的时间。
  • 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选发送“有风险”通知。

以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。

注意：如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的设置，然后跳转到通知 > 通用通知。点击平板和铅笔图标进行编辑，并取消勾选 SLA 通知设置。

建立连接

建立连接需要以下设置：

• 远程主机
• 远程端口
• 队列管理器
• 队列

如果需要客户端身份验证，还必须设置以下设置：

• 用户名
• 密码

测试连接 按钮可用于验证与服务器的成功连接。

发送消息

到达端口交易选项卡的文件将作为消息推送到配置的队列。 文件可以通过直接放置到此文件夹中，也可以从 工作流 中较早的另一个端口到达此文件夹。

如需要设置多个 IBM MQ 端口以将消息推送到多个队列。 可以使用 Branch 端口 等端口将文件路由到适当的 IBM MQ 端口。

接收消息

可以将 IBM MQ 端口配置为自动轮询远程队列以获取要下载的消息。 使用自动化 上的 接收自动化 和 接收 设置。 启用后，端口会等待指定的时间间隔，然后尝试从队列中检索消息并将其推送到输出文件夹。

如果 IBM MQ 端口连接到流中的其他端口，下载的消息将自动传递到下一个端口。 否则，消息将保留在输出文件夹中。

宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。 通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。 这有助于确保文件名反映对组织重要的详细信息。

知行之桥 支持这些宏，它们都使用以下语法：%Macro%。

宏	描述
ConnectorID	替换为端口的 ConnectorID。
Ext	替换为端口当前正在处理的文件的文件扩展名。
Filename	替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt	替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId	计算端口输出的消息的 MessageId。
RegexFilename:pattern	将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:headername	替换为端口正在处理的当前消息的目标消息头 (headername) 的值。
LongDate	以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate	以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:format	以指定格式（format）计算系统的当前日期时间。 有关可用的日期时间格式，请参阅示例日期格式
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 中项目的名称。 例如，%Vault:companyname%解析为存储在保管库中的companyname项的值。
• %DateFormat:format%：其中 format 是可接受的日期格式（有关详细信息，请参阅示例日期格式）。 例如，%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%