GISB 端口

Version 26.2.9636

GISB 端口

GISB 端口支持使用气体工业标准委员会 (GISB) 协议发送和接收消息。

核心功能

支持用于能源行业 B2B 通信的 GISB 协议
具备数字签名和加密功能，并支持密钥管理
提供回执处理和确认管理，确保可靠交付
支持多个 GISB 版本，具备可配置的协议选项

概览

GISB 连接在两个位置进行配置。使用本地 GISB 标识符、个人密钥和所有 GISB 连接的全局信息配置 GISB 个人设置页面。然后使用特定于单个贸易伙伴的连接设置配置各个 GISB 端口。当 GISB 端口处理输入文件时，会将其打包并发送给指定的贸易伙伴。

当知行之桥通过 GISB 接收到文件时，它会尝试将该文件路由到特定的 GISB 端口。应用程序使用消息中的 GISB ID 来确定哪个 GISB 端口应该接收该文件。当文件被路由到 GISB 端口时，该文件被放置在端口的交易选项卡中，或者被传递到工作流中的下一个连接的端口。

个人设置

必须先配置 GISB 配置文件，然后才能与各个 GISB 端口建立连接。单击顶部菜单栏上的 个人设置 > GISB。

GISB 页

个人信息

用于识别本地配置文件的设置。

GISB ID 的 GISB 标识符。由知行之桥发送的消息包含此值作为“GISB-From”消息头。传入消息必须将此值作为“GISB-To”消息头才能成功接收。 GISB 标识符区分大小写。

个人密钥

私有解密和签名证书相关的设置。

密钥用于解密传入消息和签署传出消息的密钥。
密码访问本地密钥所需的密码。

应用程序 URL

与从公共网络访问知行之桥相关的设置和显示值。

接收 URL 知行之桥侦听传入 GISB 消息的 URL。与的所有贸易伙伴共享此 URL。

特殊设置

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

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

端口配置

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

个人设置

交易伙伴信息

用于识别和连接特定交易伙伴的设置。

端口 Id 端口的静态、唯一标识符。
端口类型 显示端口类型及其用途的描述。
端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
GISB ID 目标交易伙伴的 ID。此值包含在传出消息中，还用于将传入消息路由到适当的 GISB 端口。
交易伙伴 URL 应该发送传出消息的交易伙伴的公共 URL。
GISB 版本 GISB 客户端的协议版本。

连接信息

为指定的交易伙伴设置相关的连接参数。

消息发送安全性 是否对传出消息进行签名和/或加密。强烈建议使用签名和加密。
消息接收安全性 是否要求对传入消息进行签名和加密。如果收到的消息没有所需的安全参数，将引发错误。
客户端超时 端口在引发超时错误之前等待连接响应的时间。

接收方

与发送和请求消息回执相关的设置。

安全性 收据是否应包括验证消息完整性和接收者身份的签名块。

交易伙伴密钥／证书

与交易伙伴提供的公共证书相关的设置。

接收方密钥用于加密和签名验证的公钥。可以通过“导入密钥”按钮导入密钥，然后从下拉菜单中选择。
TLS 服务器证书 用于验证 TLS／SSL 服务器身份的公钥证书。仅当交易伙伴的系统需要 HTTPS (而不是 HTTP)时才需要。如果交易伙伴未提供 TLS 服务器证书，则可以将该设置留空以允许底层 OS ／ JVM执行证书验证，也可以将其设置为 “Any Certificate” 以无条件地信任目标服务器的身份。

高级设置

首选个人设置

在此 GISB 端口的个人设置页面中覆盖 GISB 配置的设置。设置首选个人设置允许对某些交易伙伴使用不同的密钥和 ID。

本地 GISB ID 个人 GISB ID。
密钥将用于解密传入消息和签名传出消息的密钥。
密码访问本地密钥所需的密码。

TLS 客户端认证

需要双向 TLS 身份认证时，与客户端身份认证相关的设置。

私钥证书 在 TLS 客户端身份验证期间提供的私钥证书。
证书密码 访问 TLS 客户端证书所需的密码。

HTTP 认证

与 HTTP 客户端身份验证相关的设置。

HTTP 认证 是否启用客户端 HTTP 认证。
HTTP 认证类型 是以加密格式（摘要认证）还是以纯文本格式(基本认证)提供 HTTP 身份验证凭据。只有当连接是 HTTPS 连接（而不是HTTP）时，才应该使用基本认证。
用户名 用于 HTTP 客户端认证的用户凭据。
密码用于 HTTP 客户端认证的密码凭据。

代理配置

这些是一组设置的集合，用于识别和验证代理，GISB 连接应通过该代理进行路由。默认情况下，此部分在安全设置页面的代理设置。清除该复选框可提供特定于的端口的设置。

代理类型 基于代理的防火墙使用的协议。
代理主机 基于代理的防火墙的名称或 IP 地址。
代理端口 基于代理的防火墙的 TCP 端口。
代理用户 用于通过基于代理的防火墙进行身份验证的用户名。
代理密码 用于对基于代理的防火墙进行身份验证的密码。
身份验证方案 保留默认值 None 或选择以下身份验证方案之一：Basic、Digest、Proprietary或NTLM。

高级设置

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

压缩方法 压缩传出有效负载时使用的算法。
EDI 类型 要使用的 EDI 消息类型。默认值为 X12。
加密算法 加密传出消息时使用的算法。
折叠头部 如果头部超过一定长度，请选中此选项以使端口折叠头部。
数据包类型 选中此选项可让端口从 收件人密钥证书 读取功能，以确定是否需要旧的数据包类型。如果密钥需要较旧的数据包类型，则使用它。
签名和加密 如果启用，端口将在同一步骤中执行签名和加密。
签名算法 签名传出消息时使用的算法。
TLS 启用协议 建立出站连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在安全隐患，仅在合作伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持该协议，连接可能会被拒绝。
临时文件 启用后，端口将数据写入临时文件中进行处理，然后在临时文件完全写入后将其移入处理。
本地文件名格式 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关详细信息，请参阅宏。
延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。这是一个遗留设置。最佳实践是使用 File 端口来管理本地文件系统，而不是此设置。

消息

消息设置 确定端口如何搜索消息并在处理后管理它们。可以将消息保存到你的 已发送 文件夹，或者可以根据 已发送 文件夹方案将它们保存，如下所述。

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

日志

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

特殊设置

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

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

自动化

自动化设置

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

发送到达端口的文件是否会作为 GISB 消息自动发送。
重试间隔 发送失败重试之前的时间。当服务器没有对发送尝试做出响应，或者对未收到文件的通信做出否定响应时，会触发重试。
最大重试次数 端口处理输入文件的最大次数。是否成功基于服务器相应和回执的验证（如需要回执）。如果设置为 0，那么端口将无限次尝试处理失败文件。

性能

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

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

通知选项卡

与配置通知相关的设置。

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

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

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

SLA 选项卡

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

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

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

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

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

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

交易伙伴设置

交易伙伴必须共享配置新的 GISB 端口时所需的一些连接细节。这些细节至少应包括:

GISB ID
交易伙伴 URL
交易伙伴密钥／证书

发送和接收文件

在配置了 GISB 个人设置和特定于交易伙伴的 GISB 端口之后，可以安全地发送和接收文件。

发送文件

在 GISB 端口中，事务选项卡显示应该发送给目标交易伙伴的文件。如果启用了自动化选项卡的发送，到达此选项卡的文件将被自动打包并发送。绿色 “Sent” 状态表示传输成功，黄色和红色表示警告和错误状态。失败或成功传输的日志文件可以通过扩展与传输文件相关联的行来访问。

创建测试文件按钮可用于生成一系列简单的测试文件，以发送给交易伙伴。

接收文件

在 GISB 端口中，事务选项卡显示由应用程序接收并路由到端口的文件（基于传入的 GISB 消息中的 GISB ID）。每个文件行都可以展开，以显示传输可用日志的列表。

这些文件位于端口的事务选项卡中。如果端口连接到流中的其它端口，文件将自动从 GISB 端口的事务选项卡移动到工作流中下一个端口的交易选项卡。

宏

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

知行之桥支持这些宏，它们都使用以下语法：%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%