> ## 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 端口的配置和使用指南。

export const SampleFilesTab = () => <>
    <p><em>上传示例文件可以方便地在任何连接的 CSV Map 或 XML Map 端口中进行映射。</em></p>

    <p>使用 <strong>示例文件</strong> 选项卡生成用于 <a href="/26.2/self-hosted/zh/connectors/map">CSV Map</a> 或 <a href="/26.2/self-hosted/zh/connectors/xml-map/xml-map">XML Map</a> 端口的源或目标 XML 模板。单击 <strong>添加示例文件</strong>。</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>1. 如果您已有反映数据预期格式和结构的示例文件，请选择 <strong>文件上传</strong> 并浏览到您的文件。或者，选择 <strong>手动创建</strong> 直接在应用程序中创建文件。如果您选择 <strong>手动创建</strong>，请为示例文件命名。单击 <strong>下一步</strong>。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>2. 如果您浏览到现有文件，<strong>查看文件</strong> 选项卡将填充其内容。如果您选择手动创建文件，请在此选项卡上输入示例数据。单击 <strong>下一步</strong>。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>3. <strong>翻译和预览</strong> 选项卡显示将示例数据转换为 XML 的预览。当您对示例满意时，单击 <strong>添加</strong>。</p>
  </>;

export const EdiUploadTestFile = ({fileFormat = "EDI", documentType}) => {
  const docLabel = documentType || fileFormat;
  return <>
      <p>按照以下步骤生成输入文件的 XML 模板：</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>1. 在端口的 <strong>交易</strong> 选项卡中，单击 <strong>更多</strong> 下拉菜单，然后单击 <strong>上传测试文件</strong>。</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>2. 导航到磁盘上要建模为 XML 的文件，选择它，然后单击 <strong>OK</strong>。</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>3. 将 {fileFormat} 端口连接到流中的 XML Map 端口。此连接可以在任一方向进行——入站到 XML Map 端口，或从 XML Map 端口出站。</p>
      <p>XML Map 端口会自动检测测试文件的结构。根据您放置 {fileFormat} 端口的位置，该文件将出现在 XML Map 端口的 <strong>源文件</strong> 或 <strong>目标文件</strong> 下拉菜单中。</p>
      <Note>XML Map 端口需要源模板和目标模板，因此必须根据数据来源结构或应转换为的结构来设置剩余模板。例如，如果需要将 {docLabel} 文档中的数据插入数据库，则 XML Map 端口中的另一个模板将是数据库插入的 XML 模型。有关在两个模板文件之间创建映射的更多信息，请参阅 XML Map 端口的 <a href="/26.2/self-hosted/zh/connectors/xml-map/xml-map-designer">使用映射编辑器</a>。</Note>
    </>;
};

export const EdiXmlMapIntro = ({fileFormat = "EDI"}) => <p>{fileFormat} 端口执行两项操作之一：接收 XML 输入或生成 XML 输出。为确保输入和输出文件具有正确的 XML 结构，我们强烈建议在生成出站 {fileFormat} 文档时将 <a href="/26.2/self-hosted/zh/connectors/xml-map/xml-map">XML Map 端口</a> 用作流程中的上一步，或在接收入站 {fileFormat} 文档时将其用作流程中的下一步。下面描述的 <strong>上传测试文件</strong> 功能使 XML Map 端口和 {fileFormat} 端口之间的交互变得简单。</p>;

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</strong></td>
          <td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 <code>setting1=value1;setting2=value2</code>。正常的端口用例和功能不需要使用这些设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

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

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：<code>%Macro:argument%</code>
    </p>

    <p>以下是带有参数的宏的一些示例：</p>

    <ul>
      <li>%Header:headername%：其中 <code>headername</code> 是消息上消息头的名称。</li>
      <li>%Header:mycustomheader% 解析为输入消息上设置的 <code>mycustomheader</code> 消息头的值。</li>
      <li>%Header:ponum% 解析为输入消息上设置的 <code>ponum</code> 消息头的值。</li>
      <li>%RegexFilename:pattern%：其中 <code>pattern</code> 是正则表达式模式。例如，<code>%RegexFilename:^([\w][A-Za-z]+)%</code> 匹配并解析为文件名中的第一个单词，并且不区分大小写（<code>test_file.xml</code> 解析为 <code>test</code>）。</li>
      <li>%Vault:vaultitem%：其中 <code>vaultitem</code> 是 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#sample-date-formats">示例日期格式</a>）。例如，<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> 解析为文件上的日期和时间戳。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

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

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

export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
    <p>
      在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
    </p>

    <p>{siteName} 支持这些宏，它们都使用以下语法：<code>%Macro%</code>。</p>

    <table>
      <thead>
        <tr><th>宏</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</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:<em>pattern</em></td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>替换为端口正在处理的当前消息的目标消息头（<code>headername</code>）的值。</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:<em>format</em></td><td>以指定格式（<code>format</code>）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>与端口资源分配相关的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>最大工作线程数</strong></td>
          <td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
        <tr>
          <td><strong>最大文件数</strong></td>
          <td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const companyName = "知行软件";

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

export const fileFormat = "VDA";
export const documentType = "VDA";

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

## 核心功能

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

## 概述

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

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

## 端口配置

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

### 设置选项卡

#### 转换配置

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

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

#### 头部配置

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

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

### 样本文件选项卡

<SampleFilesTab />

### 高级设置选项卡

#### EDI 分隔符

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

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

#### 高级设置

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

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

#### 消息

<Message />

#### 日志

<Logging />

#### 杂项设置

<MiscConnector />

### 自动化选项卡

#### 自动化设置

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

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

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 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 端口](./xml-map/xml-map)中的模板，将任意 XML 结构转换为 VDA 结构。

## 配合 XML Map 端口使用

<EdiXmlMapIntro fileFormat={fileFormat} />

### 上传测试文件

<EdiUploadTestFile fileFormat={fileFormat} documentType={documentType} />

## 宏

<MacrosTable />

### 示例

<MacrosExamples />