> ## 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.

# GISB 端口

> 知行之桥GISB 端口的配置与使用指南，支持使用气体工业标准委员会 (GISB) 协议发送和接收消息。

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

## 核心功能

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

## 概览

GISB 连接在两个位置进行配置。使用本地 GISB 标识符、个人密钥和所有 GISB 连接的全局信息配置 GISB [个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md) 页面。然后使用特定于单个贸易伙伴的连接设置配置各个 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。 |

#### 杂项

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

## 端口配置

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

### 设置

#### 交易伙伴信息

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

| 设置 | 描述 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能描述。 |
| **端口描述** | 可选字段，用于对端口及其在工作流中的角色进行自由格式描述。 |
| **GISB ID** | 目标交易伙伴的 ID。此值包含在传出消息中，还用于将传入消息路由到适当的 GISB 端口。 |
| **交易伙伴 URL** | 应该发送传出消息的交易伙伴的公共 URL。 |
| **GISB 版本** | GISB 客户端的协议版本。 |

#### 连接信息

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

| 设置 | 描述 |
| - | - |
| **消息发送安全性** | 是否对传出消息进行签名和/或加密。知行软件强烈建议使用签名和加密。 |
| **消息接收安全性** | 是否要求对传入消息进行签名和加密。如果收到的消息没有所需的安全参数，将引发错误。 |
| **客户端超时** | 端口在引发超时错误之前等待连接响应的时间（以秒为单位）。 |

#### 接收方

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

| 设置 | 描述 |
| - | - |
| **安全性** | 收据是否应包括验证消息完整性和接收者身份的签名块。 |

#### 交易伙伴密钥／证书

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

| 设置 | 描述 |
| - | - |
| **接收方密钥** | 用于加密和签名验证的公钥。使用 **导入密钥** 按钮，然后浏览到要导入的密钥。 |
| **TLS 服务器证书** | 用于验证 TLS/SSL 服务器身份的公钥证书。仅当交易伙伴的 GISB 系统需要 HTTPS（而非 HTTP）时才需要。如果交易伙伴未提供 TLS 服务器证书，可以将该设置留空以允许底层 OS/JVM 执行证书验证，也可以将其设置为 `Any Certificate` 以无条件信任目标服务器的身份。 |

### 高级设置

#### 首选个人设置

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

| 设置 | 描述 |
| - | - |
| **本地 GISB ID** | 您的 GISB 标识符。 |
| **密钥** | 用于解密传入消息和签名传出消息的密钥。 |
| **密码** | 访问本地密钥所需的密码。 |

#### TLS 客户端认证

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

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**私有证书**</td>
<td>TLS 客户端身份验证期间提供的私有证书。</td></tr>
<tr><td>**证书密码**</td>
<td>访问 TLS 客户端证书所需的密码。</td></tr></tbody></table>

#### HTTP 认证

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

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

#### 代理配置

这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](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) 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。

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

#### 高级设置

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

| 设置 | 描述 |
| - | - |
| **压缩方法** | 压缩传出有效负载时使用的算法。 |
| **EDI 类型** | 要使用的 EDI 消息类型。默认值为 X12。 |
| **加密算法** | 加密传出消息时使用的算法。 |
| **折叠头部** | 选中此项可让端口在头部超过一定长度时折叠头部。 |
| **数据包类型** | 选中此项可让端口从 **接收方密钥证书** 读取功能，以确定是否需要旧的数据包类型。如果密钥需要较旧的数据包类型，则使用它。 |
| **签名和加密** | 选中此项可让端口在同一步骤中执行签名和加密。 |
| **签名算法** | 签名传出消息时使用的算法。 |
| **TLS 已启用协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有在贸易伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持它，可能会被拒绝。 |
| **临时文件** | 选中此项可让端口将要处理的数据写入临时文件，然后在临时文件完全写入后将其移入处理。 |
| **本地文件命名方案** | 为端口输出消息分配文件名的方案。可以在文件名中使用宏来动态包含标识符和时间戳等信息。更多信息，请参阅[宏](#宏)。 |
| **处理延迟** | 放置在 **交易** 选项卡中的文件处理延迟的时间量（以秒为单位）。这是一个旧版设置。最佳实践是[使用文件端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)来管理本地文件系统，而不是此设置。 |

#### 消息

*消息设置确定端口如何搜索消息并在处理后管理它们。*

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**保存到已发送文件夹**（已弃用）</td>
<td>将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。</td></tr>
<tr><td>**已发送文件夹方案**（已弃用）</td>
<td>按所选时间间隔对 **Sent** 文件夹中的文件进行分组。仅在启用**保存到已发送文件夹**时适用。</td></tr></tbody></table>

#### 日志

*用于管理日志创建和存储的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日志级别**</td>
<td>指定要记录在端口日志目录中的信息类型：
<ul><li>**None** - 不创建任何日志。</li>
<li>**Error** - 仅当端口遇到错误时才创建日志。</li>
<li>**Warning** - 仅当端口发出警告时才创建日志。</li>
<li>**Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
<li>**Debug** - 记录成功和失败工作流的详细调试信息。</li>
<li>**Trace** - 记录成功和失败工作流的详细跟踪信息。</li></ul>
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td></tr>
<tr><td>**日志文件夹结构**</td>
<td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td></tr>
<tr><td>**保留消息副本**</td>
<td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td></tr></tbody></table>

#### 杂项

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

### 自动化

#### 自动化设置

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

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

#### 性能

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

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**最大工作线程数**</td>
<td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](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) 部分的默认设置。</td></tr>
<tr><td>**最大文件数**</td>
<td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](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) 部分的默认设置。</td></tr></tbody></table>

### 告警选项卡

*与配置通知相关的设置。*

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

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

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

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

## 交易伙伴设置

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

* GISB ID
* 交易伙伴 URL
* 接收方密钥证书

## 发送和接收文件

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

### 发送文件

在 GISB 端口中，**事务** 选项卡显示应该发送给目标交易伙伴的文件。如果启用了[自动化](#自动化)选项卡的 **发送**，到达此选项卡的文件将被自动打包并发送。通过展开与传输文件相关联的行，可以访问所有传输的日志文件。

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

### 接收文件

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

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

## 宏

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

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

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
<tr><td>ConnectorName</td><td>替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。</td></tr>
<tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
<tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
<tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
<tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
<tr><td>RegexFilename:*pattern*</td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
<tr><td>Header:*headername*</td><td>替换为端口正在处理的当前消息的目标消息头（`headername`）的值。</td></tr>
<tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
<tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
<tr><td>DateFormat:*format*</td><td>以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>计算指定保管库项目的值。</td></tr></tbody></table>

### 示例

某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：`%Macro:argument%`

以下是带有参数的宏的一些示例：

<ul><li>%Header:headername%：其中 `headername` 是消息上消息头的名称。</li>
<li>%Header:mycustomheader% 解析为输入消息上设置的 `mycustomheader` 消息头的值。</li>
<li>%Header:ponum% 解析为输入消息上设置的 `ponum` 消息头的值。</li>
<li>%RegexFilename:pattern%：其中 `pattern` 是正则表达式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 匹配并解析为文件名中的第一个单词，并且不区分大小写（`test_file.xml` 解析为 `test`）。</li>
<li>%Vault:vaultitem%：其中 `vaultitem` 是 [vault](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中项目的名称。例如，`%Vault:companyname%` 解析为存储在保管库中的 `companyname` 项的值。</li>
<li>%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%` 解析为文件上的日期和时间戳。</li></ul>

还可以创建更复杂的宏，如以下示例所示：

<ul><li>将多个宏组合在一个文件名中：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`</li>
<li>包括宏之外的文本：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`</li>
<li>在宏中包含文本：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`</li></ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.