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

# ZUGFeRD 端口

> 知行之桥ZUGFeRD 端口的配置和使用指南。

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 siteNameShort = "知行之桥";

export const siteName = "知行之桥";

ZUGFeRD 端口从 PDF 和 XML 发票文件生成 ZUGFeRD 文件，或从 ZUGFeRD 文件中提取发票 XML 文件。

## 核心功能

* 德国电子发票标准，结合 PDF 与 XML，并支持双向处理（提取 XML 或生成 ZUGFeRD 文件）
* 支持版本 1.0、2.0、2.1，以及多种一致性级别（MINIMUM、BASIC、EN 16931、EXTENDED 和 XRECHNUNG）
* 支持 PDF/A-3 格式，可在人工可读 PDF 中嵌入机器可读 XML，并支持批处理组处理

## 概述

ZUGFeRD 端口通过集成 ZUGFeRD（Zentraler User Guide des Forums elektronische Rechnung Deutschland）标准来促进电子发票交换，该标准将人类可读和机器可读的数据结合在单个文档中。它基于 PDF/A-3 标准，允许将 XML 数据嵌入 PDF 文件。这种混合格式确保发票既可以被人轻松阅读，也可以由计算机系统自动处理。ZUGFeRD 端口允许你通过两种方式与 ZUGFeRD 文件交互：

* [解析 ZUGFeRD 文件](#解析-zugferd-文件)
* [生成 ZUGFeRD 文件](#生成-zugferd-文件)

端口会根据提供的输入类型确定要执行的操作。

## 端口配置

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

### 设置选项卡

#### 配置

*与建立连接相关的设置。*

| 设置        | 说明                             |
| --------- | ------------------------------ |
| **端口 ID** | 端口的静态唯一标识符。                    |
| **端口类型**  | 显示端口名称及其功能说明。                  |
| **端口说明**  | 可选字段，用于自由描述端口及其在工作流中的作用。       |
| **版本**    | 生成的 ZUGFeRD 文件中使用的 ZUGFeRD 版本。 |

#### 高级设置

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

| 设置        | 说明                                                                               |
| --------- | -------------------------------------------------------------------------------- |
| **一致性级别** | 生成的 ZUGFeRD 文件中使用的一致性级别。选项包括：BASIC、EXTENDED、MINIMUM、BASIC WL、EN 16931、XRECHNUNG。 |
| **发票说明**  | 生成的 ZUGFeRD 文件中使用的自由文本说明。                                                        |

### 高级选项卡

#### 消息

<Message />

#### 日志

<Logging />

#### 其他设置

| 设置       | 说明                                                                                                                                           |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **处理延迟** | 放入 **交易** 选项卡的文件在处理前延迟的时间（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](../flows/designing-a-flow#interacting-with-the-local-file-system)来管理本地文件系统，而不是使用此设置。 |

#### 杂项

<MiscConnector />

### 自动化选项卡

#### 自动化设置

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

| 设置     | 说明                    |
| ------ | --------------------- |
| **发送** | 勾选此项，使端口在文件准备就绪后自动发送。 |

#### 性能

<Performance />

### 警报选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 解析 ZUGFeRD 文件

端口期望接收 PDF 文件作为输入，并读取该文件以提取附加的 XML，然后发送到工作流下游。

### 处理多个附件

你可能会收到包含多个附件的 PDF 文件。默认情况下，端口会将所有附件传递到工作流下游，并为每条消息添加消息头：

* ZUGFeRD-File-Index：每个附件的附件编号
* ZUGFeRD-File-Count：电子邮件中的附件总数
* ZUGFeRD-File-Name：原始 PDF 文件名
* ZUGFeRD-File-Description：发票 XML 和附件的说明
* ZUGFeRD-File-Parameters：发票 XML 和附件的其他文件参数
* ZUGFeRD-File-Relationship：发票 XML 和附件的文件关系。发票 XML 通常为 "Alternative"，附件通常为 "Data"、"Supplement" 等。
* ZUGFeRD-File-Subtype：发票 XML 和附件的文件子类型。这通常是文件的 MIME-Type，例如 text\xml 或 application\pdf。

## 生成 ZUGFeRD 文件

端口期望接收一个批处理组，其中恰好包含一条 PDF 批处理消息和一条 XML 批处理消息。在工作流中将这些批处理组发送到 ZUGFeRD 端口之前，请使用 [Batch Create](./batch-create) 端口创建它们。如果包含多于一条 PDF 或 XML 批处理消息，或者批处理组中缺少其中任意一种消息，则会引发错误。

UI 中所有 ZUGFeRD 特定设置（版本、一致性级别和发票说明）仅用于生成 ZUGFeRD 文件。解析完全不涉及这些设置。

* **版本**：控制生成文件时使用的 ZUGFeRD 版本。{siteNameShort} 支持版本 1.0、2.0 和 2.1。

* **一致性级别**：ZUGFeRD 标准主要包括以下一致性级别：
  * MINIMUM
    * 包含最基本的发票信息，例如发票号、日期和金额。
    * 数据以 PDF/A-3 格式嵌入，便于人类阅读和简单系统处理。

  * BASIC
    * 在 MINIMUM 级别的基础上包含更多结构化数据，例如买方和卖方详细信息、税务信息和付款条件。
    * 适用于需要适度自动化的场景。

  * BASIC WL
    * 与 BASIC 类似，但针对特定用例定制，通常包含某些行业或地区的附加字段。
    * 增强专门场景中的互操作性。

  * EN 16931 (COMFORT)
    * 符合欧盟标准 EN 16931，为高度自动化处理提供完整的结构化数据。
    * 适合复杂业务流程和系统集成。

  * EXTENDED
    * 在 EN 16931 的基础上扩展，允许包含行业或公司特定的附加信息。
    * 专为具有独特需求的企业设计。

  * XRECHNUNG
    * 基于 ZUGFeRD 的德国特定配置文件，符合公共部门发票的 XRechnung 标准。
    * 确保符合德国公共采购法规。

* **发票说明**：PDF 阅读器会显示 PDF 附件的可选说明。此设置控制 XML 附件使用的说明。

### 生成示例文件

若要生成可用于测试的示例文件，请导航到端口的 **交易** 选项卡，然后点击 **生成示例文件** <img src="https://mintcdn.com/qiao/bVtjD3fvHFZBo1vE/public/images/generate_test_file.png?fit=max&auto=format&n=bVtjD3fvHFZBo1vE&q=85&s=250e20ebd1ff1fe29af3ae32e63458f7" alt="生成示例文件" noZoom style={{ display: "inline-block", verticalAlign: "middle", height: "0.9em", margin: 0 }} width="26" height="29" data-path="public/images/generate_test_file.png" /> 按钮。这会在 Send 文件夹中创建一个 PDF 文件。端口处理该 PDF 时，会生成一个 XML 输出文件，其中包含从 PDF 中提取的发票数据。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />