ZUGFeRD 端口

Version 26.1.9526


ZUGFeRD 端口


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,并支持批处理组(Batch Group)处理。

概述

ZUGFeRD 端口通过集成 ZUGFeRD(Zentraler User Guide des Forums elektronische Rechnung Deutschland)标准来促进电子发票的交换,该标准将人可读和机器可读的数据结合在一个文档中。它基于 PDF/A-3 标准,允许将 XML 数据嵌入 PDF 文件中。这种混合格式确保发票既可以被人类轻松读取,也可以由计算机系统自动处理。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 文件中使用的自由文本说明。

自动化

自动化设置

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

  • 发送 到达端口的消息是否自动处理。

性能

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

  • 最大工作线程数 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置,则会覆盖 高级设置 页面的 性能设置 部分的默认设置。
  • 最大文件数 分配给端口的每个线程发送的最大文件数。如果设置,则会覆盖 高级设置 页面的 性能设置 部分的默认设置。

通知选项卡

与配置通知相关的设置。

在执行服务级别协议 (SLA) 之前,需要设置电子邮件通知以接收通知。默认情况下,知行之桥使用 通知 选项卡上的全局设置。要为此端口使用其他设置,请启用覆盖全局设置

默认情况下,错误通知处于启用状态,这意味着每当出现错误时都会发送电子邮件。要关闭错误通知,请取消选中启用复选框。

输入主题(必填),然后(可选)输入以逗号分隔的收件人电子邮件列表。

SLA 选项卡

与配置服务级别协议 (SLA) 相关的设置。

SLA 允许配置预期流程中端口发送或接收的数据量,并设置预期达到该数据量的时间范围。当 SLA 未达到时,知行之桥会发送电子邮件警告用户,并将 SLA 标记为_存在风险_,这意味着如果 SLA 未能尽快达到,则会被标记为_已违反_。这让用户有机会介入并确定 SLA 未达到的原因,并采取适当的措施。如果在风险时间段结束时仍未达到 SLA,则会将 SLA 标记为_已违反_,并再次通知用户。

要定义 SLA,请启用预期数据量,然后点击设置选项卡。

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

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

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

高级页面

消息

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

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

日志

  • 日志级别 端口生成的日志详细程度。当您请求技术支持时,请将其设置为 Debug
  • 日志子文件夹方案:指示端口根据所选的时间间隔对日志(Logs)文件夹中的文件进行分组。每周(Weekly)选项(默认设置)指示端口每周创建一个新子文件夹,并将该周的所有日志存储在其中。如果此设置留空,则端口将所有日志直接保存在日志文件夹中。对于处理大量事务的端口,使用子文件夹有助于保持日志井然有序并提高性能。
  • 记录消息内容 勾选此项后,已处理文件的日志条目将包含该文件本身的副本。如果禁用此项,您可能无法从输入输出页面下载该文件的副本。

其他设置

  • 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。

特殊设置

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

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

解析 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 类型,例如 text\xml 或 application\pdf。

生成 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 附件使用什么说明。

生成示例文件

若要生成可用于测试的示例文件,请导航至该端口的交易(Transactions)标签页,然后点击生成示例文件 生成示例文件 按钮。这将在“发送(Send)”文件夹中创建一个 PDF 文件。当端口处理该 PDF 时,它会生成一个 XML 输出文件,其中包含从该 PDF 中提取的发票数据。

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

知行之桥 支持这些宏,它们都使用以下语法:%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%:其中 vaultitemvault 中项目的名称。 例如,%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%