ZUGFeRD 端口

Version 25.1.9222

概述
端口配置
- 设置
- 自动化
- 通知
解析 ZUGFeRD 文件
生成 ZUGFeRD 文件
宏
- 示例

ZUGFeRD 端口

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

概述

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

解析 ZUGFeRD 文件
生成 ZUGFeRD 文件

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

端口配置

此部分包含所有可配置的端口属性。

设置

配置

确定如何访问端口的设置。

端口 Id 端口的静态、唯一标识符。
端口类型 显示端口类型及其用途的描述。
端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
版本生成的 ZURFeRD 文件中使用的 ZUGFeRD 版本。

高级设置

Settings not included in the previous categories.

一致性级别（Conformance Level） 生成的 ZUGFeRD 文件中使用的一致性级别。选项包括：BASIC、EXTENDED、MINIMUM、BASIC WL、EN 16931、XRECHNUNG。
Invoice Description 生成的 ZUGFeRD 文件中使用的自由文本说明。

消息

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

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

日志

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

特殊设置

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

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

自动化

自动化设置

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

发送选中此项可以让端口在组准备就绪时自动发送组。

性能

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

最大线程数 从线程池中消耗用于处理此端口上的文件的最大工作线程数。如果设置，这将覆盖 设置 > 自动化 页面上的默认设置。
最大文件数 分配给端口的每个线程发送的最大文件数。如果设置，这将覆盖 设置 > 自动化 页面上的默认设置。

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前，需要设置电子邮件警报以获取通知。单击 配置通知 将打开一个新的浏览器窗口，转到系统设置，可以在其中设置系统范围的警报。有关详细信息，请参阅通知。

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量，并设置期望满足该数量的时间范围。知行之桥在不满足 SLA 时发送电子邮件警告用户，并将 SLA 标记为 有风险，这意味着如果很快不满足 SLA，则会将其标记为 已违反。这使用户有机会介入并确定未满足 SLA 的原因，并采取适当的措施。如果在风险时间段结束时仍未满足 SLA，则将 SLA 标记为违反，并再次通知用户。

要定义 SLA，请单击 添加预期数量条件。

如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
将 期待至少 设置为期望处理的最小交易数量（交易量），然后使用每字段指定时间范围。
默认情况下，SLA 每天都有效。要更改此设置，请取消选中每日，然后选中想要的一周中的几天的框。
使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
默认情况下，在违反 SLA 之前不会发送通知。要更改此设置，请选中 发送“有风险”通知。

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

解析 ZUGFeRD 文件

端口需要接收 PDF 文件作为输入，然后读取该文件以提取附加的 XML 以发送到流程中。

生成 ZUGFeRD 文件

端口需要包含一个 PDF 批处理消息和一个 XML 批处理消息的批处理组。使用批处理创建端口创建这些批处理组，然后将它们发送到流程中的 ZUGFeRD 端口。如果包含多个 PDF 或 XML 批处理消息，或者批处理组中缺少任何一个，则会引发错误。

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

版本：控制生成文件时使用的 ZUGFeRD 版本。知行之桥支持版本 1.0、2.0 和 2.1。
一致性级别（Conformance Level）：ZUGFeRD 标准主要包括以下一致性级别：
- MINIMUM
  - 包含最基本的发票信息，例如发票号、日期和金额。
  - 数据嵌入 PDF/A-3 格式，便于人类阅读和简化系统处理。
- BASIC
  - 在最低级别的基础上构建，包括更多结构化数据，例如买方和卖方详细信息、税务信息和付款条件。
  - 适用于需要适度自动化的场景。
- BASIC WL
  - 与 BASIC 类似，但针对特定用例量身定制，通常包括针对某些行业或地区的附加字段。
  - 增强专业环境中的互操作性。
- EN 16931 (COMFORT)
  - 符合欧盟标准 EN 16931，为高度自动化处理提供完整的结构化数据。
  - 适用于复杂的业务流程和系统集成。
- EXTENDED
  - 在 EN 16931 的基础上进行扩展，允许包含特定于行业或公司的附加信息。
  - 专为具有独特要求的企业而设计。
- XRECHNUNG
  - 基于 ZUGFeRD 的德国特定配置文件，符合公共部门发票的 XRechnung 标准。
  - 确保符合德国公共采购法规。
发票说明：PDF 阅读器会在 PDF 上显示附件的可选说明。此设置控制对 XML 附件使用什么说明。

宏

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

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