TRADACOMS 端口
Version 24.3.9111
Version 24.3.9111
TRADACOMS 端口
TRADACOMS 端口支持从 XML 生成 TRADACOMS 文件并将 TRADACOMS 文件转换为 XML。
概览
解析 TRADACOMS 文件时,TRADACOMS 端口会验证文件中交换头的信息,并将 TRADACOMS 文件转换为 XML 文件。这个转换步骤非常有用,因为 XML 是知行之桥用于处理工作流中数据的主要格式。TRADACOMS 端口自动读取输入文件以确定适当的版本,然后根据该版本解析文件。
生成 TRADACOMS 文件时,TRADACOMS 端口将 XML 文件转换符合标准语法的 TRADACOMS 文件,并匹配适当的交换头信息。这里的 XML 文件已在工作流中的其它位置被转换获取,这一步对于创建 TRADACOMS 文件非常重要。
端口配置
本节包含所有可配置的端口属性。
设置
转换配置
与端口核心操作相关的设置。
- 端口 Id 端口的静态、唯一标识符。
- 端口类型 显示端口类型及其用途的描述。
- 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
- 转换类型 端口是将 TRADACOMS 文件转换为 XML,还是将 XML 数据转换为 TRADACOMS 文件。
传输设置
与 TRADACOMS 文件的交换头有关的设置。生成 TRADACOMS 文件时,这些设置将作为交换头信息应用于文件中。解析 TRADACOMS 文件时,交换头设置用于验证输入的文件。
- 语法标识符(STDS ID) 标识 TRADACOMS 文件中使用的语法规则。
- 发送方编码(FROM 编码) 标识发送 TRADACOMS 文件的一方。从 XML 生成 TRADACOMS 时,这应该是你的代码。
- 发送方名称(FROM 名称) 发送 TRADACOMS 文件一方的可选名称。从 XML 生成 TRADACOMS 时,这应该是你的名字。可选。
- 接收方编码(UNTO 编码) 标识接收 TRADACOMS 文件的一方。将 TRADACOMS 转换为 XML 时,这应该是你的代码。
- 接收方名称(UNTO 名称) 接收 TRADACOMS 文件一方的可选名称。当将 TRADACOMS 转换为 XML 时,这应该是你的名字。可选。
- 发送方传输参考(SNRF) 用于引用 TRADACOMS 文件发送方的 ID。
- 接收方传输参考(RCRF) 用于引用 TRADACOMS 文件收件方的 ID。
- 应用程序参考(APRF) 用于参考 TRADACOMS 应用程序进行此文件交换的 ID。
- 传输优先级代码(PRCD) 代表 TRADACOMS 传输优先级的代码。
自动化
自动化设置
与自动化处理文件相关的设置。
- 发送 切换后,端口将在文件准备好时自动发送文件。
- 重发间隔 端口在重新发送收到否定 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 分隔符
指定文件中各元素、段之间分隔符的设置。
- 数据元素分隔符 文件中各个数据元素间的分隔符。
- 组件元素分隔符 文件中复合数据结构内各元素间的分隔符。
- 段终止符 表示文件中某段结束的字符。
- 转义字符 “释放”或“转义”下一个字符的字符,覆盖其通常的含义。只要保留字符前面带有转义字符,就可以将其与数据一起显示在文件中。
- 后缀 附加到段终止符以区分多个段。
高级设置
先前类别中未包含的设置。
- 批处理 一次数据交换可以包含多个事务。如果不启用,端口将为交换中的每个事务创建单独的输出文件。如果启用该配置,本次交换中的所有事务都会被组合在一个文件中输出。
- 编码 指定字符编码(例如 ASCII 或 UTF-8)。
- 扩展限定符值 在将 TRADACOMS 转换为 XML 时,包含 EDI 限定符的元素是否有子元素 “Code” 和 “Value” 来表示限定符代码和值。例如:
<N101>
<Code>ST</Code>
<Value>Ship To</Value>
</N101> - 将描述生成为 将 TRADACOMS 转换为 XML 时,可以添加 TRADCOMS 文件中段和元素的描述信息,可以作为 XML 注释添加,也可作为 XML 元素中的属性值添加。在这里可以根据需要选择使用哪一种方式,或者两者都不使用。
- 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅宏。
- 嵌套循环 选中后,端口会检测 EDI 数据中嵌入了层次关系的 EDI 结构,并生成 XML,其中这些层次关系表示为父子关系。
- 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。
- 严格模式验证 检测到以下错误时,端口应忽略、提示警告或失败:重复计数超过允许的数目;缺少必需的元素/段;限定符和代码值无效;不允许的元素长度;无效的元素值。
- 跟踪事务类型 是否将事务类型作为跟踪消息头添加到已处理的消息中。 运行 报表 时需要这些消息头。
- 验证标识符 检查此项以确保已翻译文档中的标识符与端口配置中的标识符匹配。
- 上传 Schema 使用此选项可上传架构并将其安装在端口的架构文件夹中。如果架构已存在,系统会询问您是否要覆盖它。
- 重置状态 EDI 端口会跟踪已使用的控制编号并增加该编号以确保将来的运行不会重复数据。使用此按钮可将计数器重置为其初始状态,而无需更改任何配置的设置。
消息
- 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
- 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如,Weekly 选项指示端口每周创建一个新的子文件夹,并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口,使用子文件夹有助于保持消息的组织性并提高性能。
日志
- 日志级别 端口生成的日志的详细程度。 当端口请求支持时,请将其设置为 调试。
- 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如,Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口,使用子文件夹有助于保持日志井井有条并提高性能。
- 保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能,端口可能无法从 输入 或 输出 选项卡下载文件的副本。
特殊设置
特殊设置 适用于特定用例。
- 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置,例如
setting1=value1;setting2=value2
。 正常的端口用例和功能不需要使用这些设置。
TRADACOMS 转换为 XML
生成 XML 时,将 转换类型 设置为 TRADACOMS 转换为 XML。端口将处理存放在 输入文件夹中的 TRADACOMS 文件。端口将根据配置中的传输设置来验证 TRADACOMS 消息头。验证传输后,TRADACOMS 段根据消息中指定的模式转换为 XML。生成的 XML 文件放在端口的 Receive 文件夹中。
XML 转换为 TRADACOMS
生成 TRADACOMS 文件时,将 转换类型 设置为 XML 转换为 TRADACOMS。放在 输入文件夹中的 XML 文件将由端口处理。端口将表示 TRADACOMS 文件的 XML 元素转换为 TRADACOMS 段,然后使用传输设置字段来生成传输头。要创建生成 TRADACOMS 文件所需的 XML 结构示例,请从一个示例 TRADACOMS 文件开始,并以 TRADACOMS 转换为 XML 模式通过 TRADACOMS 端口发送。生成的 XML 可以用作 XML Map 端口中的模板,将任意 XML 结构转换为 TRADACOMS 结构。
与 XML Map 端口一起使用
TRADACOMS 端口执行两项操作之一:接收 XML 输入或生成 XML 输出。为确保输入和输出文件具有正确的 XML 结构,我们强烈建议在生成出站 TRADACOMS 文档时将 XML Map 端口 用作流程中的上一步,或在接收入站 TRADACOMS 文档时将其用作流程中的下一步。下面描述的 上传测试文件 功能使 XML Map 端口和 TRADACOMS 端口之间的交互变得简单。
上传测试文件
按照以下步骤生成输入文件的 XML 模板:
- 在转换端口的 输入 选项卡中,单击 更多 下拉菜单,然后单击 上传测试文件。
- 导航到磁盘上要建模为 XML 的文件,选择它,然后单击 OK。
- 将 EDI 端口连接到流中的 XML Map 端口。此连接可以在任一方向进行——入站到 XML Map 端口,或从 XML Map 端口出站。
XML Map 端口会自动检测测试文件的结构。该文件将出现在 XML Map 端口的 源文件 或 目标文件 下拉菜单中。
注意:XML Map 端口需要源模板和目标模板,因此必须根据数据来源结构或应转换为的结构来设置剩余模板。例如,如果需要将 TRADACOMS 文档中的数据插入数据库,则 XML Map 端口中的另一个模板将是数据库插入的 XML 模型。有关在两个模板文件之间创建映射的更多信息,请参阅 XML Map 端口的 使用映射编辑器。
宏
在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。 通过将宏合并到文件名中,可以动态地包含相关信息,例如标识符、时间戳和消息头信息,从而为每个文件提供有价值的上下文。 这有助于确保文件名反映对组织重要的详细信息。
知行之桥 支持这些宏,它们都使用以下语法:%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%