SOAP 端口
Version 24.3.9111
Version 24.3.9111
SOAP 端口
SOAP 端口支持向远程 web 服务器发送 SOAP 消息并检索响应。
概述
SOAP 端口的输入应该是发送给 web 服务的完整 SOAP 消息。SOAP 消息的模板可以通过为目标 web 服务导入 WSDL 来生成,更多信息可以在 SOAP 模板部分找到。
SOAP 端口支持 HTTP 身份验证、令牌身份验证和 TLS 客户端身份验证,并且可以向传出 SOAP 消息添加数字加密和签名以确保 Web 服务安全。 发送 SOAP 请求后,端口存储响应或将其传递到知行之桥工作流中的下一个端口。
端口配置
本节包含所有可配置的端口属性。
设置
交易伙伴信息
用于标识目标网络服务的设置。
- 端口 Id 端口的静态、唯一标识符。
- 端口类型 显示端口类型及其用途的描述。
- 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
- 服务地址 SOAP 请求应该发送到的 URL 。
- SOAP 操作 要在远程服务器上触发的 web 服务操作。
- SOAP 版本 The version of SOAP you are using.
- 从 WSDL 导入 WSDL 可以从一个网址或本地文件导入,并自动填充端口中的配置字段。此外,导入 WSDL 允许在连接到 XML Map 端口时为 SOAP 请求生成 XML 模板。请参阅 SOAP 模板部分了解更多详细信息。
WS-Security
与保护网络服务传输相关的设置。
- 消息发送安全性 是否签名和/或加密传出的 SOAP 请求。
- 消息接收安全性 是否要求对传入的 SOAP 响应提供签名和加密。如果收到的消息没有所需的安全参数,将引发错误。
- 生存时间 端口在引发超时错误之前等待连接响应的时间长度。
客户端证书
与本地私有证书相关的设置。
- 私钥证书 用于签名发送请求和解密接收响应的私有证书。
- 证书密码 访问私有证书的密码。
服务器证书
与服务器的公钥证书相关的设置。
- 加密证书 发送消息时用于加密,接收响应时用于签名验证的公共证书。
- TLS 服务器证书 用于验证 TLS/SSL 服务器身份的公共证书。只有在通过 HTTPS 发送请求时才需要(而不是通过 HTTP )。在没有特定服务器证书的情况下,此设置可以保留为空白,以允许基础 OS/JVM 执行证书验证,也可以将其设置为
Any Certificate
以无条件地信任目标服务器的身份。
自动化
自动化设置
与端口自动化处理文件相关的设置。
- 发送 到达端口的文件是否会作为 SOAP 请求自动发送。
- 重试间隔 重试发送失败之前的时间。当服务器没有对发送尝试做出响应,或者对未收到文件做出否定响应时,会触发重试。
- 最大次数 端口发送传出请求的最大次数。 成功是根据成功的服务器确认来衡量的。 如果将此设置为 0,端口将无限期地重试请求。
性能
与端口资源分配相关的设置。
- 最大线程数 从线程池中消耗用于处理此端口上的文件的最大工作线程数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。
- 最大文件数 分配给端口的每个线程发送的最大文件数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。
通知
与配置警报和服务等级协议 (SLA) 相关的设置。
端口邮件设置
在执行 SLA 之前,需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口,转到 系统设置,可以在其中设置系统范围的警报。 有关详细信息,请参阅通知。
服务等级协议 (SLA) 配置
SLA 能够配置期望工作流中的端口发送或接收的数量,并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户,并将 SLA 标记为 有风险,这意味着如果很快不满足 SLA,则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因,并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA,则将 SLA 标记为违反,并再次通知用户。
要定义 SLA,请单击 添加预期数量条件。
- 如果端口具有单独的发送和接收操作,请使用单选按钮指定 SLA 所属的方向。
- 将 期待至少 设置为期望处理的最小交易数量(交易量),然后使用 每 字段指定时间范围。
- 默认情况下,SLA 每天都有效。 要更改此设置,请取消选中每日,然后选中想要的一周中的几天的框。
- 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
- 默认情况下,在违反 SLA 之前不会发送通知。 要更改此设置,请选中 发送“有风险”通知。
以下示例显示为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。 如果尚未收到 1000 个文件,则会在该时间段结束前 1 小时发送风险通知。
高级设置
Token Authentication
Settings related to token client authentication.
- 令牌身份验证 选中此项可为传出消息启用令牌身份验证。 如果启用,传出消息将包含下面设置的用户凭据。
- 用户名 访问令牌所需的用户名。
- 密码 访问令牌所需的密码。
- 密码类型 使用单选按钮指定密码是纯文本 (Text) 还是加密 (Digest)。
TLS 客户端认证
需要双向 TLS 身份验证时,与客户端身份验证相关的设置。
- 私钥证书 在 TLS 客户端身份验证期间提供的私有证书。
- 证书密码 访问 TLS 客户端证书所需的密码。
HTTP 身份认证
与 HTTP 客户端身份验证相关的设置。
- HTTP 认证 是否启用客户端 HTTP 身份验证。
- HTTP 认证类型 是否以加密格式(摘要认证)还是以纯文本格式(基本认证)提供 HTTP 身份验证凭据。只有当连接是 HTTPS 连接(而不是 HTTP )时,才应该使用基本身份验证。
- 用户名 用于 HTTP 客户端身份验证的用户名。
- 密码 用于 HTTP 客户端身份验证的密码。
自定义头
要作为传出消息的一部分包含的任意一组自定义头。
代理设置
这些是一组设置,用于识别并验证代理(SOAP 连接应通过该代理进行路由)。 默认情况下,此部分使用设置页面上的全局设置。 清除该复选框以提供特定于你的 SOAP 端口的设置。
- 代理类型 基于代理的防火墙使用的协议。
- 代理主机 基于代理的防火墙的名称或 IP 地址。
- 代理端口 基于代理的防火墙的 TCP 端口。
- 代理用户 用于通过基于代理的防火墙进行身份验证的用户名。
- 代理密码 用于对基于代理的防火墙进行身份验证的密码。
- 身份验证方案 保留默认值 None 或选择以下身份验证方案之一:Basic、Digest、Proprietary或NTLM。
高级设置
设置不包括在以前的类别中。
- 连接超时 端口在抛出超时错误之前等待连接响应的时间长度。
- 加密算法 加密发送消息时使用的算法。
- 标准化证书颁发者 证书颁发者数据是否应规范化为简单字符串,以便由 Web 服务进行验证。
- 在 URL 中允许 ArcScript 允许在发出查询之前运行 URL 中的 ArcScript 表达式。 例如,
[_|now('yyyy-MM-dd')]
计算当前日期。 - 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。
- 签名算法 签名发送消息时使用的算法。将为相应的 MDN 回执请求相同的算法。
- 签名头部 默认情况下,端口仅对 SOAP 消息的正文进行签名。 检查此项以使端口也对消息头进行签名。
- 安全令牌格式 确定 SOAP 有效负载中安全令牌使用的格式。
X509 引用包含 DN(专有名称)格式的证书主题。
Binary令牌使用整个公钥的 Base64 编码内容。
KeyIdentifier 引用包含 X509 主题-密钥-标识符格式。 - 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅宏。
- 启用 TLS 建立传出连接时支持的 TLS/SSL 协议列表。 最佳实践是仅使用 TLS 协议。 请记住,某些过时的操作系统不支持 TLS 1.2。
消息
- 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
- 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如,Weekly 选项指示端口每周创建一个新的子文件夹,并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口,使用子文件夹有助于保持消息的组织性并提高性能。
日志
- 日志级别 端口生成的日志的详细程度。 当端口请求支持时,请将其设置为 调试。
- 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如,Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口,使用子文件夹有助于保持日志井井有条并提高性能。
- 保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能,端口可能无法从 输入 或 输出 选项卡下载文件的副本。
特殊设置
特殊设置 适用于特定用例。
- 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置,例如
setting1=value1;setting2=value2
。 正常的端口用例和功能不需要使用这些设置。
建立连接
需要为目标网络服务的服务地址和服务操作来建立连接。一些网络服务可能需要一个或多个安全功能来处理 SOAP 请求:
- 加密/签名 (WS-Security)
- 客户端 SSL 身份验证
- HTTP 身份验证
SOAP 模板
通过使用 WSDL 文件和连接到工作流中的 SOAP 端口的 XML Map 端口, SOAP 端口可以简化生成 SOAP 请求的过程。WSDL 文件为 SOAP 请求定义了适当的 XML 结构,XML Map 端口可以将任意 XML 结构转换成这个目标结构。
使用导入 WSDL
按钮导入文件后,将一个 XML Map 端口连接到 SOAP 端口(这样,由 XML Map 端口处理的文件将被发送到 SOAP 端口)。保存这些工作流更改后, XML Map 端口可以动态读取 WSDL XML,并将其用作目标文件模板。然后,将任意源 XML 结构作为源文件上传到 XML Map 端口中。
在 XML Map 端口中设置源文件和目标文件后,可视化设计器将填充源和目标结构。将元素从源拖放到目标,以映射两个 XML 结构之间的关系。映射完成后,匹配源文件的文件将由 XML Map 端口自动转换为 SOAP 请求。
宏
在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。 通过将宏合并到文件名中,可以动态地包含相关信息,例如标识符、时间戳和消息头信息,从而为每个文件提供有价值的上下文。 这有助于确保文件名反映对组织重要的详细信息。
知行之桥 支持这些宏,它们都使用以下语法:%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%