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

# VDA 端口

> VDA 端口的配置和使用指南。

VDA 端口提供了 VDA 文件与 XML 文件相互转换的功能。

## 核心功能

* 支持德国汽车行业 EDI 标准，具备双向 VDA/XML 转换功能
* 支持自动架构检测与验证，以及交换头生成
* 支持 VDA 特定的段结构、嵌套循环和限定符扩展

## 概述

当接收 VDA 文档时，VDA 端口验证交换头，并将 VDA 文档转换为 XML。这是很有用的过渡步骤，因为 XML 是 知行之桥 用于处理工作流中数据的主要格式。VDA 端口会自动读取输入文件以确定合适的架构，然后根据该架构解析文档。

生成 VDA 文档时，VDA 端口将 XML 转换为 VDA 文档语法并应用适当的交换头部信息。在获取 XML 数据并在工作流的其它地方转换之后，这作为创建 VDA 文档的最后一步非常有用。

## 端口配置

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

### 设置选项卡

#### 转换配置

*与端口核心操作相关的设置。*

| 设置 | 说明 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能描述。 |
| **端口描述** | 可选字段，用于自由填写端口的描述及其在工作流中的作用。 |
| **转换类型** | 端口应将 VDA 文档转换为 XML，还是从 XML 生成 VDA 文档。 |

#### 头部配置

*与 VDA 交换头部信息有关的设置。将 VDA 文档转换为 XML 时，根据这些设置验证文档的头部信息；从 XML 生成 VDA 文档时，使用这些设置生成 VDA 文档的头部。*

| 设置 | 说明 |
| - | - |
| **发送方标识** | VDA 通信中标识发送方的唯一 ID（生成 VDA 文档时，这是你的标识符）。 |
| **接收方标识** | VDA 通信中标识接收方的唯一 ID（生成 VDA 文档时，这是交易伙伴的标识符）。 |

### 样本文件选项卡

*上传示例文件可以方便地在任何连接的 CSV Map 或 XML Map 端口中进行映射。*

使用 **示例文件** 选项卡生成用于 [CSV Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/map.md) 或 [XML Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 端口的源或目标 XML 模板。单击 **添加示例文件**。

1. 如果您已有反映数据预期格式和结构的示例文件，请选择 **文件上传** 并浏览到您的文件。或者，选择 **手动创建** 直接在应用程序中创建文件。如果您选择 **手动创建**，请为示例文件命名。单击 **下一步**。

2. 如果您浏览到现有文件，**查看文件** 选项卡将填充其内容。如果您选择手动创建文件，请在此选项卡上输入示例数据。单击 **下一步**。

3. **翻译和预览** 选项卡显示将示例数据转换为 XML 的预览。当您对示例满意时，单击 **添加**。

### 高级设置选项卡

#### EDI 分隔符

*指定分隔元素、段等的字符设置。*

| 设置 | 说明 |
| - | - |
| **后缀** | 出现在段末尾以区分不同的段。 |

#### 高级设置

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

| 设置 | 说明 |
| - | - |
| **批处理** | 一个文档可以包含多个交易。如果未选中此选项，端口将为交换中的每笔交易创建一个单独的输出文件。选中后，端口会将所有事务分组到单个输出文件中。仅当**转换类型**为 VDA 转换为 XML 时适用。 |
| **编码** | 指定字符编码（例如 ASCII 或 UTF-8）。 |
| **扩展限定符值** | 选中后，包含 VDA 限定符的 XML 元素将包括包含限定符代码和值的子元素。例如： `<N101>`   `<Code>ST</Code>`   `<Value>Ship To</Value>` `</N101>` |
| **功能确认** | 默认情况下，所有功能确认（997、999）都会路由到流程图中选择的端口，且**交易**选项卡中不会接收 XML 翻译。选中此项以使翻译后的确认也包含在**交易**选项卡中。除了新的 EDI 文档之外，这还允许将功能确认集成到目标源中。 |
| **将描述生成为** | 将 VDA 转换为 XML 时，将提供 VDA 段和元素的描述作为 VDA 数据的上下文。使用此下拉菜单选择是将此上下文作为 XML 注释添加，还是作为 XML 属性包含在 XML 元素中。 |
| **本地文件命名方案** | 为端口输出的消息分配文件名的方案。您可以在文件名中动态使用宏，以包含标识符和时间戳等信息。详见[宏](#宏)。 |
| **嵌套循环** | 选中后，端口会检测 VDA 数据中嵌入了层次关系的 VDA 结构，并生成 XML，其中这些层次关系表示为父子关系。 |
| **处理延迟** | 放置在**交易**选项卡中的文件被延迟处理的时间（秒）。这是一个遗留设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)来管理本地文件系统，而不是使用此设置。 |
| **严格模式验证** | 当检测到以下情况时，端口是否应忽略、警告或失败：重复计数高于允许的数目；缺少必需的元素/段；无效的限定符和代码值；不允许的元素长度；无效的元素值。选择"禁用"可关闭架构验证检查。 |
| **上传架构** | 用于上传架构并安装到端口的架构文件夹中。如果架构已存在，系统会询问您是否覆盖。 |
| **重置状态** | EDI 端口会跟踪已使用的控制号并递增，以确保后续运行不会产生重复数据。使用此按钮将计数器重置为初始状态，而不更改任何已配置的设置。 |

#### 消息

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

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [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>

### 自动化选项卡

#### 自动化设置

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

| 设置 | 说明 |
| - | - |
| **发送** | 指示端口在文件准备好时自动发送文件的开关。 |
| **重发间隔** | 端口在重新发送收到否定 ACK 的文件之前等待的时间间隔。例如，如果交易伙伴收到文件但文件有误并发回否定 ACK，此设置指定在再次发送文件之前等待多长时间。 |
| **最大尝试次数 (async)** | 请求功能 ACK 时端口处理输入文件的最大次数。成功基于在**重发间隔**内返回功能 ACK。如果未返回成功的功能 ACK，端口会重新发送文件，直到达到**最大尝试次数**。如果设置为 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 通知** 设置。

## VDA 转换为 XML

生成 XML 时，将**转换类型**设置为 *VDA 转换为 XML*。端口随后处理放置在**交易**选项卡的 VDA 文件。端口将根据[头部配置](#头部配置)中配置的**发送方标识**和**接收方标识**验证 VDA 消息头。验证传输后，VDA 段将根据消息中指定的架构转换为 XML。生成的 XML 文件放在端口的**交易**选项卡中。

## XML 转换为 VDA

生成 VDA 文件时，将**转换类型**设置为 *XML 转换为 VDA*。端口随后处理放在**交易**选项卡中的 XML 文件。端口将表示 VDA 文件的 XML 元素转换为 VDA 段，然后使用[头部配置](#头部配置)中配置的**发送方标识**和**接收方标识**字段生成传输的头部。要创建生成 VDA 文档所需的 XML 结构的示例，首先需要创建一个示例 VDA 文档，并以 *VDA 转换为 XML* 模式通过 VDA 端口发送该文档。生成的 XML 可以用作 [XML Map 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md)中的模板，将任意 XML 结构转换为 VDA 结构。

## 配合 XML Map 端口使用

VDA 端口执行两项操作之一：接收 XML 输入或生成 XML 输出。为确保输入和输出文件具有正确的 XML 结构，我们强烈建议在生成出站 VDA 文档时将 [XML Map 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 用作流程中的上一步，或在接收入站 VDA 文档时将其用作流程中的下一步。下面描述的 **上传测试文件** 功能使 XML Map 端口和 VDA 端口之间的交互变得简单。

### 上传测试文件

按照以下步骤生成输入文件的 XML 模板：

1. 在端口的 **交易** 选项卡中，单击 **更多** 下拉菜单，然后单击 **上传测试文件**。

2. 导航到磁盘上要建模为 XML 的文件，选择它，然后单击 **OK**。

3. 将 VDA 端口连接到流中的 XML Map 端口。此连接可以在任一方向进行——入站到 XML Map 端口，或从 XML Map 端口出站。

XML Map 端口会自动检测测试文件的结构。根据您放置 VDA 端口的位置，该文件将出现在 XML Map 端口的 **源文件** 或 **目标文件** 下拉菜单中。

> [!NOTE]
>
> XML Map 端口需要源模板和目标模板，因此必须根据数据来源结构或应转换为的结构来设置剩余模板。例如，如果需要将 VDA 文档中的数据插入数据库，则 XML Map 端口中的另一个模板将是数据库插入的 XML 模型。有关在两个模板文件之间创建映射的更多信息，请参阅 XML Map 端口的 [使用映射编辑器](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map-designer.md)。

## 宏

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

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