Orchestrator 用户指南
关于输入和输出参数
我们已经公开了 Studio 中您已熟悉的 In 和 Out 参数,以无缝集成您使用的工具(例如各种 DCM 或 BPM)。这意味着您创建的任何流程现在都可以通过 Orchestrator API 或接口接收输入参数,并向前面提到的所有流程返回输出。最后,这有助于将流程链接到一起。此可扩展性可帮助您更好地将 UiPath™ 集成到公司的生态系统中。
.xaml
的 In、Out 和 In/Out 参数才会公开给其他应用。
project.json
中。
在设计时,在 Studio 中,通过配置项目以接受输入或输出参数(带有或不带有默认值)的方式,使您可以在其他第三方应用程序或 Orchestrator 中使用它们。如果您事先在 Studio 项目中添加了相应的参数,则只能使用 Orchestrator 和其他第三方应用程序中的输入和输出参数。如果在 Studio 中未添加任何参数,则会显示以下消息:“没有为此版本定义输入参数。”
项目的 In、Out 或 In/Out 参数在发布到 Orchestrator 时将成为输入和输出参数。请注意,对于 In/Out 参数,系统将在 Orchestrator 中创建并显示两个不同的参数,即输入和输出参数,并使用相同的名称。
可以使用 Studio、Orchestrator 或 Orchestrator API,仅向输入参数提供值,如下所示:
创建参数时的默认值。简短示例请见此处。在 Studio 中为参数提供的默认值可以在 Orchestrator 中覆盖,无论是在流程还是工作级别。
- 在流程级别 - 在“查看流程”窗口的“参数”选项卡中,如此处所示。
- 在作业级别 - 在“开始作业”窗口的“参数”选项卡中,如此处所示。
-
在触发器级别 - 在“添加触发器”窗口的“参数”选项卡中,如此处所示。
注意:更新包时,只要新的包版本与参数的定义无关,系统就会保留为 Orchestrator 中流程级别的输入参数提供的值。输入/输出参数的存储限制为 1 MB。
如果您为 Orchestrator 中的输入参数提供值,请注意,必须以 JSON 格式提供这些值。以下是如何执行此操作的一些示例:
- String - 必须提供不带引号的值,例如
string
; - Int32 - 提供任何整数值,例如
11
; - Boolean - 显示两个单选按钮,让您选择 True 或 False;
- Double - 提供浮点值,例如
3.5
; - DateTime - 以有效 JSON 的形式提供值,例如
"2012-04-23T18:25:43.511Z"
; -
Array - 以有效 JSON 的形式提供值,例如
[1, 1, 2, 3, 5, 8]
或["firstString", "secondString"]
。注意:可以使用任何类型的 In 参数,但请记住,只有基元由 Orchestrator 验证。将枚举类型 (enum) 转换为 JSON 时,每个枚举成员都由整数值表示,而不是由其名称表示。这意味着枚举的 JSON 表示原始枚举中包含的每个成员的数值。
- 在包级别 - 前往 /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key') 端点;
- 在流程级别 - 作为对 /odata/Releases(Id) 端点的 PATCH 请求;
- 在作业级别 - 作为对 /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs 端点的 POST 请求;
-
注意:对于 API 调用,全部输入参数的 JSON 表示不得超过 10,000 个字符,包括参数名称、所有转义字符、空格、方括号和参数值。
输入参数的值标记如下:
- 无值 - 在流程,作业,计划或包级别(在 Studio 中)没有为参数提供值。
- “继承自包”- 如果在 Studio 中默认提供该值。此消息显示在特定包的“参数”窗口,以及“查看流程”、“开始作业”和“添加计划”窗口中。
-
继承自流程 - 如果在流程级别(在查看流程窗口中)提供该值。此消息显示在开始作业和添加计划窗口中。值本身显示在查看流程窗口中。
如果存在输入或输出参数值,则这些值将显示在“作业详细信息”窗口中。在以下情况下,输入值将显示在上述窗口中:
- 它们是在流程级别添加的;
- 它们是在作业级别添加的。
您还可以在“包版本”窗口中,在包级别查看输入和输出参数。有关更多信息,请参阅管理包。
Main.xaml
文件的 In 和 Out 参数。