UiPath Documentation
studio
2024.10
false
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。

Studio 用户指南

关于发布自动化项目

发布自动化项目意味着将项目文件夹存档,以便将其发送到机器人,然后执行。

默认情况下,将发布项目文件夹中的所有文件,测试用例除外。如果要防止已发布的包中包含特定文件,请在“项目”面板中右键单击该文件,然后选择“从发布中忽略”(不适用于库项目中的工作流文件)。对于库,要防止在项目中安装已发布的库时,工作流文件在“活动”面板中显示为可重用组件,请在“项目”面板中右键单击该文件,然后选择“设为私有”

您可以将自动化项目发布到 Orchestrator、自定义 NuGet 订阅源或在本地发布。发布到 Orchestrator 后,已归档的项目将显示在“包”页面上,您可以创建要分发给机器人的流程。当您将自动化流程发布到 Orchestrator 个人工作区或发布测试用例时,如果一个流程不存在,则会自动创建一个流程,并且现有流程会自动更新为最新发布的版本。

此外,自动化项目可以发布到自定义 NuGet 订阅源,如果订阅源需要身份验证,还可以使用添加 API 密钥的选项。

如果在本地发布项目,那么会要求您在本地计算机上提供与发布流程包的位置不同的路径。从这里开始,您之后可以手动将包发送给机器人,这样就可以执行包了。默认的本地发布位置是 %ProgramData%\UiPath\Packages

要发布项目,项目文件夹中的 project.jsondesign.json 文件不得位于只读位置(例如,如果项目受源代码管理,则您必须签出文件以进行编辑)。

您可以通过 Studio命令行发布项目。要更新多个项目的依赖项并一次发布所有依赖项,请使用项目依赖项批量更新工具

备注:

如果将以句点 (.) 开头的文件夹隐藏起来,从而在发布时将其忽略,则其他软件应用程序可能会干扰发布流程。

从 Studio 发布项目

要发布项目,请在Studio 的“设计”选项卡功能区中选择“发布”。

要发布自动化项目,请执行以下操作:

  1. 在 Studio 中,创建一个新项目。

  2. In the Design ribbon tab, select Publish. The Publish window opens. Notice that the window's title bar changes depending on the context:

    • 发布流程(发布流程时);
    • 发布库(发布库项目时);
    • 发布用户界面库项目时发布用户界面库;
    • 发布测试用例(发布测试用例时)。
    • 发布模板时发布模板
  3. 在“包属性”选项卡中:

    • 输入包名称。下拉列表最多包含您先前发布的包的 5 个最新名称。

    • “版本”部分中,查看项目的当前版本,并根据需要键入“新版本”。选中“是预发行”框,将版本标记为 alpha。请注意,这将自动将项目的版本架构更改为语义。 在本地发布新版本的文件时,请确保自定义位置中尚未包含建议版本号相同的文件。 有关项目版本控制的更多详细信息,请查看“关于自动化项目”页面。

    • (可选)使用“项目图标“选项定义项目的自定义图标。您可以浏览并选择一个文件,或者为大小至多 1MB 的 jpegjpgpng 文件输入路径或公共 URL。 项目发布后,图标显示如下:

      • 对于进程,在“进程名称”旁的“助手”中显示,以便更轻松地在进程列表中识别进程。

      • 对于模板,在“主页(Studio 后台视图)”>“模板”中的模板旁边显示。

      • 对于库,该图标将在 Studio 中“管理包”窗口中的程序包旁显示。

        备注:

        如果本地文件用于发布到 Orchestrator 的库或不支持嵌入式图标的订阅源,则在“管理包”中不可见。 在这种情况下,请使用 URL 指明该图标。

    • 在“项目标签”对话框中,您可以通过创建新标签或重用 Orchestrator 中已定义的标签来向项目添加一个或多个标签。标签有两种类型:“标签”和“属性”(键值对)。标签包含在已发布的包中,它们有助于描述项目并对其进行分类。例如,它们可以引用自动化应用程序(Excel 标签)或部门(department:accounting 键值属性)。

当您开始输入时,系统会根据已定义的标签建议可能的匹配项,您可以通过从匹配项列表中选择一个标签来重复使用它。对于属性匹配,首先显示后跟 :(冒号)字符的键,并在选择键后显示关联的值。要添加新标签,请在输入名称后,单击名称旁边带有加号的条目。通过使用 :(冒号)字符分隔字符串,您可以添加属性,而不包含 : 的条目则可以添加标签。

标签和键值属性不得超过 256 个字符。 标签名称不能包含以下字符:<>%&\?/:

项目标签可以自动应用于 Orchestrator 中的流程。有关使用标签的更多信息,请参阅 Orchestrator 指南中的“使用标签组织资源”

  • 在“发行说明”文本框中,输入有关版本的详细信息以及其他相关信息。已发布项目的发行说明可在 Orchestrator 的“包”部分中查看。请注意,“发行说明”字段最多可接受 10,000 个字符。

  1. Select Next. If you are publishing a template, the Template info tab opens next (step 5). Otherwise, proceed to step 6.

  2. (For templates only) In the Template info tab, provide the following information, and then select Next:

    • 名称 - 模板的名称。

    • 说明 - 模板选项卡中的模板说明。

    • 默认项目名称 - 使用此模板创建新项目时的默认项目名称。

      备注:

      避免使用标点符号、分隔符和文件名中不允许使用的字符。 使用模板时,可能会从默认名称中删除这些字符。

    • Default Project Description

      • 使用此模板创建新项目时的默认描述。

  3. 在“发布选项”选项卡中,选择发布项目的位置。可用的选项取决于您要发布的项目的类型:

    • 对于流程(包括 StudioX 项目):
      • Orchestrator 租户流程订阅源Orchestrator 个人工作区订阅源以及如果 Studio 状态栏中的“文件夹”菜单中选择了具有单独包订阅源的第一级文件夹或其子文件夹,则会显示该文件夹层次结构的订阅源。 如果 Studio 已连接到 Orchestrator,则这些选项可用。仅当您的用户在 Orchestrator 中启用了个人工作区功能时,Orchestrator 个人工作区订阅源才可用。

        如果在 Studio 中选择了“个人工作区”或具有单独包订阅源的层次结构中的文件夹,则该文件夹的订阅源是默认选项。否则,租户订阅源是默认选项。如果您已在当前会话中发布项目,则在您关闭 Studio 或从 Studio 状态栏更改 Orchestrator 文件夹之前,系统会默认选择您上次使用的发布位置。

      • Assistant (机器人默认设置)
        • 机器人和 Assistant 的默认包位置,C:\ProgramData\UiPath\Packages。此处发布的项目会自动显示在 Assistant 中。如果 Studio 连接到 Orchestrator,则该选项不可用。
      • 自定义 - 自定义 NuGet 订阅源 URL 或本地文件夹。添加 API 密钥是可选的。
    • 对于测试用例
      • 可用于流程的相同选项,但 Orchestrator 个人工作区订阅源除外。
    • 对于用户界面库
      • Orchestrator 租户库订阅源Orchestrator 共享库订阅源 - 在 Studio 连接到 Orchestrator 时可用。可用选项取决于是否已在 Orchestrator 中启用租户库订阅源。
      • 自定义 - 自定义 NuGet 订阅源 URL 或本地文件夹。添加 API 密钥是可选的。
    • 对于模板
      • Orchestrator 租户库订阅源Orchestrator 共享库订阅源 - 在 Studio 连接到 Orchestrator 时可用。可用选项取决于是否已在 Orchestrator 中启用租户库订阅源。
      • 本地 - 默认情况下,在本地发布模板的位置:C:\Users\User\Documents\UiPath\.templates
      • 自定义 - 自定义 NuGet 订阅源 URL 或本地文件夹。添加 API 密钥是可选的。

如果要发布库或任何具有 Windows 或跨平台兼容性(模板除外)的项目,则可以在“编译设置”下的“发布选项”选项卡中使用其他设置:

  • (仅适用于库)活动根类别 - 输入类别的名称,在该类别下可重用组件将在“活动”面板中列出。

  • (仅适用于 Windows 旧版库)编译活动表达式 - 选择此选项可编译并打包所有活动表达式。这可缩短执行时间。

  • (对于 Windows - 仅限旧版库) 准备运行 - 选择此选项可优化生成的程序集,以便在运行时更快地进行 JIT 编译。

    备注:

    要了解可能阻止库成功发布的原因,请阅读有关发布库时的限制

  1. Select Next to advance to the Certificate signing tab, or Publish to publish your project.

  2. (可选)“证书签名”选项卡中,在“证书”框旁边添加本地证书路径。 此外,根据需要添加证书密码和可选的证书时间戳。 如需更多详细信息,请查阅“为包签名”页面。

    备注:

    目前,接受将 .pfx.p12 证书扩展程序用于为项目签名。

  3. Select Publish. A NUPKG file is created and uploaded to Orchestrator, the custom NuGet feed, or saved in the local directory. For libraries, if the Separate Runtime Dependencies Project Settings option is enabled, two NUPKG files are created: one file is the design time package used in Studio and the other file is the runtime package used by the Robot when executing the automation. Depending on the project, the package contains:

    • 对于具有 Windows - 旧版兼容性的模板项目和流程,为项目源文件。
    • 对于具有 Windows 或跨平台兼容性的库和项目,经过编译的 DLL 文件。
  4. 如果项目已成功发布,则将显示“信息”对话框,并且项目将复制到 UiPath.settings 文件中的 NuGetServerUrl 参数中设置的 NuGet 位置。

系统将显示“信息”对话框:

  • 包发布时采用的名称。

  • 包发布时采用的版本号。

  • 如果是在本地或在机器人默认位置发布项目,则其即为项目的发布位置。单击路径可转至包,除非发布位置是 Orchestrator。

  • “详情”选项中会列出已发布的项目文件的名称列表。

  • “复制到剪贴板”选项。

在发布过程中添加的信息(例如发布位置)将会保留在窗口中,以便将其用于后续针对同一类型项目执行的发布操作。每次单击“发布”时,都会创建项目的新版本,并将其发送到包订阅源。发布到安全订阅源时,可以通过机器人密钥、Orchestrator 凭据、Windows 身份验证或 API 密钥进行身份验证。

重要提示:

已发布的项目一定不能解压缩。要进行任何更改,请在 Studio 中打开最初的 .xaml 文件执行更改,然后再次发布项目。

通过命令行发布项目

可以使用 UiPath.Studio.CommandLine.exe 发布命令发布项目。

UiPath.Studio.CommandLine.exe 位于安装文件夹中:

  • 对于每台计算机的安装,默认路径为 C:\Program Files\UiPath\Studio。
  • 对于按用户安装,默认路径为 %localappdata%\Programs\UiPath\Studio。

以下参数可用于发布命令:

参数 描述
-p, --project-path 要发布的 project.json 的路径。此为必选参数。
-g, --target
  • 自定义 - 自定义 URL 或本地文件夹。使用“-f”、“--feed”参数定义位置。
  • 机器人 - 机器人的默认发布位置(如果未连接到 Orchestrator)。不适用于发布库或模板。
  • Orchestrator 租户 - Orchestrator 租户流程订阅源(对于流程和测试用例)或 Orchestrator 库订阅源(对于库和模板)。
  • Orchestrator 个人文件夹 - Orchestrator 个人工作区订阅源。不适用于发布库、模板或测试用例。
  • Orchestrator 文件夹层次结构 - 如果是有单独包订阅源的一级文件夹,或者如果在 Studio 状态栏中,一个文件夹的子文件夹是从文件夹菜单中选择的,则为该文件夹层次结构的订阅源。不适用于发布库或模板。
-f, --feed 用于发布项目的自定义 URL。 这也可以是自定义本地目录,类似于 Studio 中“发布选项”选项卡中的路径。
-a, --api-key 用于发布项目的 API 密钥。此参数可用于自定义目标。
-i, --icon 用于包的自定义图标的路径。
-n, --notes 包含引入到项目中的更改的发行说明。
-v, --new-version 项目的新版本。如果未提供,版本将自动递增。
-t, --timeout 指定发布项目的超时值。默认超时为 30 秒。此设置仅适用于指示将包传输到 Orchestrator 的持续时间。
--cer-path 用于包签名的证书的本地路径。
--cer-password 证书的密码。
--timestamper-url 时间戳记程序的 URL。
--incl-all-feeds 非必填。
--help 查看可用于每个命令的参数。
版本 检查 UiPath.Studio.CommandLine.exe 的版本。

例如:

  • 以下命令将示例流程发布到 Orchestrator 租户流程馈送:UiPath.Studio.CommandLine.exe publish --project-path "C:\Users\username\Documents\UiPath\Sample\project.json" --target OrchestratorTenant --notes "Fixed a couple of bugs."
  • 以下命令将同一流程发布到本地文件夹:UiPath.Studio.CommandLine.exe publish --project-path "C:\Users\username\Documents\UiPath\Sample\project.json" --target Custom --feed "C:\Users\username\Desktop\myfeed" --notes "Fixed a couple of bugs."

有关 CommandLine.exe 实用程序的更多信息,请参见批量更新命令行参数

  • 从 Studio 发布项目
  • 通过命令行发布项目

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新