IATA 端口
Version 24.3.9111
Version 24.3.9111
IATA 端口
国际航空运输协会 (IATA) 乘客和机场数据交换标准 (PADIS) 端口支持从 XML 生成 PADIS 文档以及将 PADIS 文档转换为 XML。
概述
当收到 IATA 文档时,IATA 端口验证文件交换头,并将 IATA 文件转换成 XML。这样分步实现很有用,因为 XML 是知行之桥用于处理工作流中数据的主要格式。IATA 端口自动读取输入文件以确定适当的 PADIS schema,然后根据该 schema 解析文档。IATA 是 EDIFACT 标准的一个子集,IATA 端口的许多特性和功能与更通用的 EDIFACT 端口共享。
在生成 IATA 文档时,IATA 端口将 XML 转换为 IATA 文档语法,并应用适当的交换头。在工作流中的其它地方提取并转换了 XML 数据之后,这是创建 IATA 文档的最后一步,非常有用。
注意: 通过启用测试指示器设置,可以避免交换头验证。
IATA 端口还可以对收到的 IATA 文件自动生成 ACK。如需了解更多信息,请参阅 IATA PADIS ACK。
端口配置
本节包含所有可配置的端口属性。
设置
转换配置
与端口核心操作相关的设置。
- 端口 Id 端口的静态、唯一标识符。
- 端口类型 显示端口类型及其用途的描述。
- 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
- 转换类型 端口是否应将 PADIS 文档转换为 XML,或从 XML 生成 PADIS 文档。
交换头配置
与 IATA PADIS 交换头相关的设置。 从 XML 生成 PADIS 文档时,这些设置用于生成文档标题。 解析 PADIS 文档时,这些设置用于验证传入文档。
- 语法标识符(UNB1.1) 标识 PADIS 文档中使用的字符集。
- 语法版本(UNB1.2) 与 语法标识符 结合使用,确定 PADIS 文档中使用的语法。 根据在此处的选择,其他交换设置选项会在 高级 选项卡上出现或消失。
- 发送方标识符(UNB2.1) 在通信中标识发送方的唯一标识(当生成 PADIS 文档时,这应该是你的标识符)。
- 发送方代码限定词(UNB2.2) 发送方标识符的限定词,提供值的上下文(例如 EAN 位置号)。
- 接收方标识符(UNB3.1) 在通信中识别接收方的唯一标识(生成 PADIS 文档时,这应该是你合作伙伴的标识符)。
- 接收方代码限定符(UNB3.2) 接收方标识符的限定符,提供值的上下文(例如 EAN 位置号)。
- 测试指示器(UNB11) 交换处于测试模式还是生产模式。 如果选中此选项,则在收到文档时不会验证交换头。
- 功能组 选中此选项可自动将发件人和收件人标识符添加到 高级 选项卡上的 功能组设置。
ACK
与生成和请求 ACK 相关的设置。
- 请求技术性 ACK(CONTRL) 是否应该返回(接收时)和请求(发送时)技术性 ACK。技术性 ACK 作为交换的凭据。
- 请求功能性 ACK(CONTRL) 是否应返回(接收时)和请求(发送时)功能性 ACK。功能性 ACK 作为接收交换/交易集的接受/拒绝的指示。
自动化
自动化设置
与端口自动处理文件相关的设置。
- 发送 切换后,端口将在文件准备好时自动发送文件。
- 重发间隔 端口在重新发送收到否定 ACK 的文件之前等待的时间间隔。 例如,如果交易伙伴收到文件但出现问题并且发回否定 ACK,则此设置指定再次发送文件之前等待的时间。
- 最大次数(异步) 当请求功能性 ACK 时,端口处理输入文件的最大次数。 成功取决于在重发间隔内返回功能性 ACK。 如果未返回成功的功能 ACK,端口将重新发送文件,直到达到最大次数。 如果将此设置为 0,端口将无限期地重新发送文件。
性能
与端口资源分配相关的设置。
- 最大线程数 从线程池中消耗用于处理此端口上的文件的最大工作线程数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。
- 最大文件数 分配给端口的每个线程发送的最大文件数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。
通知
与配置警报和服务等级协议 (SLA) 相关的设置。
端口邮件设置
在执行 SLA 之前,需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口,转到 系统设置,可以在其中设置系统范围的警报。 有关详细信息,请参阅通知。
服务等级协议 (SLA) 配置
SLA 能够配置期望工作流中的端口发送或接收的数量,并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户,并将 SLA 标记为 有风险,这意味着如果很快不满足 SLA,则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因,并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA,则将 SLA 标记为违反,并再次通知用户。
要定义 SLA,请单击 添加预期数量条件。
- 如果端口具有单独的发送和接收操作,请使用单选按钮指定 SLA 所属的方向。
- 将 期待至少 设置为期望处理的最小交易数量(交易量),然后使用 每 字段指定时间范围。
- 默认情况下,SLA 每天都有效。 要更改此设置,请取消选中每日,然后选中想要的一周中的几天的框。
- 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
- 默认情况下,在违反 SLA 之前不会发送通知。 要更改此设置,请选中 发送“有风险”通知。
以下示例显示为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。 如果尚未收到 1000 个文件,则会在该时间段结束前 1 小时发送风险通知。
高级设置
EDI 分隔符
指定了段、元素等的分隔设置。
- 数据元素分隔符 分隔文档中各个数据元素的字符。
- 组件元素分隔符 分隔文件中复合数据结构内元素的字符。
- 段终止符 指示文件中段结尾的字符。
- 转义字符 “释放”或“转义”下一个字符的字符,覆盖其通常的含义。只要保留字符前面带有版本字符,它就可以将它们与数据一起显示在文档中。
- 重复元素分隔符 标识元素值重复的字段。
- 后缀 追加到段终止符后,区分多个段。
交换头配置
与 IATA PADIS 交换头相关的其他设置。 这些选项的显示或消失取决于“设置”选项卡上指定的 语法版本。
- 服务代码列表目录版本号(UNB1.3) 进一步规定了 IATA 文档中使用的语法。仅适用于 EDIFACT 语法版本 4。
- 字符编码(UNB1.4) 指定字符的编码方式(例如,ASCII、UTF-8)。仅适用于 EDIFACT 语法版本 4。
- 反向路由地址(UNB2.3) 发送方系统内的可选地址,响应交换应发送至该地址。仅适用于版本 4 之前的 EDIFACT 语法版本。
- 发送方内部标识(UNB2.3) 一个额外的发送方标识符,用于响应交换的内部路由。仅适用于 EDIFACT 语法版本 4。
- 发送方内部子标识(UNB2.4) 进一步标识发送方,以便在需要子级别标识时使用。仅适用于 EDIFACT 语法版本 4。
- 路由地址(UNB3.3) 接收方系统内的可选地址,交换应路由至该地址。仅适用于版本 4 之前的 EDIFACT 语法版本。
- 接收方内部标识(UNB3.3) 一个额外的接收方标识符,以方便接收到的交换的内部路由。仅适用于 EDIFACT 语法版本 4。
- 接收方内部子标识(UNB3.4) 进一步标识接收方,以便在需要子级别标识时使用。仅适用于 EDIFACT 语法版本4。
- 接收方密码(UNB6.1) 进入接收方系统的参考或密码。
- 接收方密码限定符(UNB6.2) 为 接收方密码(如果适用)提供上下文的限定符。
- 应用程序引用标识(UNB7) 标识交换中的消息所涉及的应用程序组。
- 处理优先级代码(UNB8) 请求交换处理优先级的代码。
- 通信协议(UNB10) 定义控制交换的通信协议类型。
功能组配置
与 IATA PADIS 文档的功能组标题相关的设置。这些可选的标识符可能有助于将类似的交换组在一起,或者有助于组织内的子寻址。
- 应用程序发送方 ID(UNG2.1) 标识发送文档的应用程序(例如部门、分支机构或计算机系统)。
- 应用程序收件方 ID(UNG2.1) 标识文档所针对的应用程序。
高级设置
未包含在先前类别中的设置。
- 批处理 一个交换可以包含多个事务。 如果未选中此选项,端口将为交换中的每个事务创建一个单独的输出文件。 选中后,端口会将所有事务分组到单个输出文件中。 仅当 转换类型 为 PADIS 到 XML 时适用。
- 使用标准 ID 命名 选中后,将 PADIS 转换为 XML 时,引用 Id 将用于命名 XML 元素。 仅当 转换类型 为 PADIS 到 XML 时适用。 例如:
<_143>value</_143>
如果未选中此选项,则引用指示符将用于命名 XML 元素:<BEG03>value</BEG03>
- 编码 指定字符编码(例如 ASCII 或 UTF-8)。
- 扩展限定符值 选中时,包含 PADIS 限定符的 XML 元素包括包含限定符代码和值的子元素。 例如:
<N101>
<Code>ST</Code>
<Value>Ship To</Value>
</N101> - 功能性 ACK 默认情况下,所有功能确认(997、999)都会路由到流程图中选择的端口,并且“输出”选项卡中不会接收 XML 转换。 选中此项以使转换后的确认也包含在“输出”选项卡中。 除了新的 PADIS 文档之外,这还允许将功能确认集成到目标源中。
- 将描述生成为 将 PADIS 转换为 XML 时,可以提供 PADIS 段和元素的描述作为 PADIS 数据的上下文。 使用此下拉列表可以选择是否将此上下文添加为 XML 注释或 XML 属性。
- 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅宏。
- 嵌套循环 选中时,端口会检测 PADIS 数据中嵌入了层次关系的 PADIS 结构,并生成 XML,其中这些层次关系表示为父子关系。 有关详细信息,请参阅主-明细层级:转换 CPS 和 HYN 循环。
- 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。
- 严格模式验证 当检测到以下情况时,端口是否应忽略、警告或失败:重复计数超过允许的数量、缺少必需的元素或段、无效的限定符和代码值、不允许的元素长度以及无效元素 价值观。 选择“禁用”会关闭 scheme 验证检查。
- 跟踪 UNB2.1 是否将 UNB2.1 值作为跟踪头添加到已处理的消息中。 运行 PADIS 报告 时需要这些头。
- 跟踪 UNB3.1 是否将 UNB3.1 值作为跟踪头添加到已处理的消息中。 运行 PADIS 报告 时需要这些头。
- 跟踪事务类型 是否将事务类型作为跟踪头添加到已处理的消息中。 运行 PADIS 报告 时需要这些头。
- 验证标识符 检查此项以确保翻译文档中的标识符与端口配置中的标识符匹配。
- 上传 Schema 使用此选项可上传架构并将其安装在端口的架构文件夹中。如果架构已存在,系统会询问您是否要覆盖它。
- 重置状态 EDI 端口会跟踪已使用的控制编号并增加该编号以确保将来的运行不会重复数据。使用此按钮可将计数器重置为其初始状态,而无需更改任何配置的设置。
消息
- 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
- 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如,Weekly 选项指示端口每周创建一个新的子文件夹,并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口,使用子文件夹有助于保持消息的组织性并提高性能。
日志
- 日志级别 端口生成的日志的详细程度。 当请求支持时,请将其设置为 Debug。
- 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如,Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口,使用子文件夹有助于保持日志井井有条并提高性能。
- 保留消息副本 检查此项以使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能,可能无法从 输入 或 输出 选项卡下载文件的副本。
特殊设置
特殊设置 适用于特定用例。
- 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置,例如
setting1=value1;setting2=value2
。 正常的端口用例和功能不需要使用这些设置。
转换类型
以下各节详细介绍了将 IATA 转换为 XML 的过程,以及将 XML 转换为 IATA 的过程。
PADIS to XML
将 转换类型 设置为 IATA to XML 指示端口将传入的 PADIS 文档解析为 XML。 端口首先读取文档的“交换”和“功能组”部分的所有消息头信息,并根据配置的端口设置对其进行验证(除非启用了测试指示器)。 然后,端口解析文档中使用的特定 PADIS Schema ,并从磁盘上的“edifact_schemas”文件夹加载 Schema (其他 Schema 文件,请联系 support@kasoftware.cn)。
使用该模式,端口生成表示文档结构的 XML,使用文档中的值填充 XML,并以 XML 注释或 XML 元素中的属性的形式为每个值提供上下文(基于值 将描述生成为)。
要通过一组测试 PADIS 文档查看此过程,请导航到 IATA PADIS 端口的“输入”选项卡(将 转换类型 设置为 IATA to XML)并选择 更多 > 创建测试文件。 发票、采购订单、采购订单确认和发货通知的 PADIS 文档会自动生成并放置在输入目录中。 端口处理这些测试文件后,导航到“输出”选项卡以查看生成的 XML。
PADIS 文档转换为 XML 后,可以通过多种方式转换和操作数据。 通常,PADIS数据需要存储在数据库或其他后端应用系统中。 由于知行之桥使用 XML 来表示对这些后端系统的插入(inserts)
,因此存储 PADIS 数据就变成了将一种 XML 结构映射到另一种 XML 结构的问题。 这通常是通过可视化设计器驱动的 XML Map端口 完成的。
XML to PADIS
将 转换类型 设置为 XML to IATA 指示端口根据文档的 XML 表示形式生成 PADIS 文档。 端口根据从 XML 解析的数据构建 PADIS 消息后,会根据配置的端口设置添加功能组和交换消息头。
要使用一组测试 XML 文件查看此过程,请导航到 IATA PADIS 端口的“输入”选项卡(将 转换类型 设置为 XML to IATA)并选择 更多 > 创建测试文件。 代表发票、采购订单、采购订单确认和发货通知的 XML 文件会自动生成并放置在输入目录中。 端口处理这些测试文件后,导航到“输出”选项卡以查看生成的 PADIS 文档。
与 XML Map 端口一起使用
IATA PADIS 端口执行两项操作之一:接收 XML 输入或生成 XML 输出。为确保输入和输出文件具有正确的 XML 结构,我们强烈建议在生成出站 IATA PADIS 文档时将 XML Map 端口 用作流程中的上一步,或在接收入站 IATA PADIS 文档时将其用作流程中的下一步。下面描述的 上传测试文件 功能使 XML Map 端口和 IATA PADIS 端口之间的交互变得简单。
上传测试文件
按照以下步骤生成输入文件的 XML 模板:
- 在转换端口的 输入 选项卡中,单击 更多 下拉菜单,然后单击 上传测试文件。
- 导航到磁盘上要建模为 XML 的文件,选择它,然后单击 OK。
- 将 EDI 端口连接到流中的 XML Map 端口。此连接可以在任一方向进行——入站到 XML Map 端口,或从 XML Map 端口出站。
XML Map 端口会自动检测测试文件的结构。该文件将出现在 XML Map 端口的 源文件 或 目标文件 下拉菜单中。
注意:XML Map 端口需要源模板和目标模板,因此必须根据数据来源结构或应转换为的结构来设置剩余模板。例如,如果需要将 IATA PADIS 文档中的数据插入数据库,则 XML Map 端口中的另一个模板将是数据库插入的 XML 模型。有关在两个模板文件之间创建映射的更多信息,请参阅 XML Map 端口的 使用映射编辑器。
IATA PADIS ACK
以下各节详细介绍了两种类型的 IATA PADIS,以及知行之桥期望、处理和生成的ACK。
技术性 ACK 与功能性 ACK
技术性 ACK,有时称为交换 ACK,是双方之间已经发生交换的一种表示,尽管不一定表示已经交换了任何单独的消息。这些作为发送者的收据,指示成功接收到 IATA PADIS 消息,但是它没有指定在处理消息内容时是否存在任何问题。
功能性 ACK 是接收方已经处理了交换的指示。它可以报告接受、有问题的接受或拒绝接收的文件。这些既可以作为交换成功接收的收据,也可以作为交换被完全处理的收据。
期待 ACK、处理 ACK 和生成 ACK
请求 ACK
可以配置以 XML 到 IATA 模式运行的 IATA PADIS 端口,以便消息能够收到技术和/或功能 ACK。 在“设置”选项卡的 ACK 部分中选中 请求技术性 ACK(CONTRL)/请求功能性 ACK(CONTRL) 之一或两者时,端口将保持传输的待处理 ACK 状态 直到返回并处理了适当的 ACK。 这意味着端口状态可用于确定收件人是否已确认他们收到了交换。 有关 EDIFACT 端口中此功能的详细说明,请参阅预期确认。 IATA PADIS 端口的工作原理相同。
处理 ACK
在典型工作流中,PADIS ACK 到达以 IATA 到 XML 模式运行的 IATA PADIS 端口。 此 IATA PADIS 端口可配置为自动将任何收到的确认路由到最初生成被确认文档的 IATA PADIS 端口。 IATA PADIS 端口之间的路由 ACK 可以在 工作流 画布上进行可视化配置,方法是将 IATA 到 XML 模式下的 IATA PADIS 端口底部的灰点拖动到 XML 模式下的 IATA PADIS 端口上。
XML 到 IATA 模式下的端口收到路由的 ACK 后,会将 ACK 与原始消息配对,并将其状态从 Pending ACK 更改为已发送。
生成 ACK
当 IATA to XML 模式下的 IATA PADIS 端口接收消息并生成相应的 XML 时,它可以自动为接收到的消息生成 CONTRL 确认。 为此,请检查“设置”选项卡的 ACK 部分中的 请求技术性 ACK(CONTRL)/请求功能性 ACK(CONTRL)。 这些确认必须路由到另一个 IATA PADIS 端口(以 XML 到 IATA 模式)以最终确定 ACK。 ACK 路由到的端口应用交换标题,并将 ACK 传递到流中的下一个端口,就像任何其他 IATA PADIS 消息一样。 要正确路由 ACK,请将 IATA 到 XML 模式下的 IATA PADIS 端口底部的灰点拖到 XML 到 IATA 模式下的 IATA PADIS 端口上。
有关 EDIFACT 端口中此功能的详细说明,请参阅生成ACK。 IATA PADIS 端口的工作原理相同。
宏
在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。 通过将宏合并到文件名中,可以动态地包含相关信息,例如标识符、时间戳和消息头信息,从而为每个文件提供有价值的上下文。 这有助于确保文件名反映对组织重要的详细信息。
知行之桥 支持这些宏,它们都使用以下语法:%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%