关于库

A library is a project which contains one or more workflows that can be reused as activities in other projects. Libraries are saved as NUPKG files when published and can be installed as dependencies from the Package Manager.

For example, you could create a library that collects data from an Excel spreadsheet and appends it to another, as explained in the Creating a Basic Library page. Next, the library can be packaged and used in other processes as an activity.

创建库

1. 转到“Studio 后台视图”>“开始”>“库”。这将打开新建空白库窗口。

2. 填写库的名称并为库选择一个位置。默认位置为 C:\Users\<current_user>\Documents\UiPath。添加描述，选择项目兼容性和语言，然后选择“创建”。系统将创建新库并将其保存在本地计算机上。

   备注：

   • 库名称不能超过 128 个字符，描述不能超过 500 个字符。
   • 不要使用 lib 作为库名称，因为这将导致安装库的项目中出现编译错误。

3. “项目”面板显示一个树视图，其中包括“项目”文件夹、“依赖项”以及包含实际工作流的 NewActivity.xaml。

   在将库作为依赖项安装的项目中，库中的每个工作流文件都可作为活动提供。如果要将某个文件设为私有，请右键单击该文件，然后选择“设为私有”。在本例中，该文件包含在库包中，但是在“活动”面板中不能作为可重用组件使用。

   备注：

   默认情况下，可用于新库的依赖项与具有“最低适用版本”运行时规则的新项目的依赖项相同。

将项目提取为库

您可以将任何流程或测试自动化项目提取为库，以在其他项目中重用。例如，您可以将测试自动化项目转换为在其他自动化项目中使用其模板。

1. 在 Studio 中打开项目。

2. 在“设计”功能区中，选择“导出为”，然后选择“库”。

   

3. 选择要导出为库的工作流。默认情况下，取消选择整个项目以及入口点（主工作流和测试用例）。

   

4. 配置以下提取选项：

   • Include Test Cases: By default, this option is enabled for a Process project and disabled for a Test Automation project. You should enable this option if you want to include test cases as part of the extracted library.
   • Publish and install the library: Automatically selected to publish the package to a shared feed and install the library as a project dependency. You can disable this option if you want to create the library without publishing it. If disabled, the remainder options are not available for configuration.
   • “安装包后更改工作流”：选择此项可使用已从库编译的活动修改工作流。
   • “替换模式”：选择工作流替换方法。

     • 选择“替换调用的工作流内容”以更改从入口点调用的工作流，或使用提取的库中的相应活动更改测试用例。

     • 如果您使用“调用工作流”活动的“隔离会话”和“目标会话”属性以分别在单独的 Windows 流程中运行和在不同的会话中启动，请使用此选项。

     • 选择“替换调用工作流”活动，将“调用工作流”活动更改为提取的库中的活动。

       警告：

       如果您将“隔离会话”和“目标会话”属性用于“调用工作流”活动，请不要选择此选项。

   • “删除替换的工作流”：删除已被提取的库活动替换的工作流。
   • Set Execution Templates from library: Add execution templates to the library.

5. 单击“导出”以确认库选项。

   

6. 单击“创建”以完成库创建。

   

7. (Optional) Publish the library if you've selected Publish and install the library in step 3, and then click Publish.

   

   备注：

   In case you didn't enable the Publish and install the library option, you'll be prompted to open the library or continue with the current project.

   

   重要提示：

   Replacing workflows or invoked activities from the extracted library will not take place for workflows where mock testing is used.

配置活动的布局

您在库中定义的参数将成为将库作为依赖项安装的项目中的活动属性。

要配置在项目中使用活动时的外观和行为，请右键单击库“项目”面板中的工作流文件，然后选择“活动布局”。根据库的兼容性（Windows - 旧版、Windows 或跨平台），活动属性窗口将显示不同的选项。

Windows 和跨平台库的选项

在左侧菜单中选择“活动属性”，然后输入以下内容：

• “显示名称” - “活动”面板中显示的活动名称。在项目中使用库时，不应更改显示名称。

• Tooltip - The tooltip that is visible when you hover over the activity in the Activities and Designer panels in projects where the library is installed.

• Help Link - The help link that opens when you select the activity in the Designer panel and press F1 on your keyboard.

• SVG Icon - The SVG icon to display next to the activity name.

  备注：

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

• Color - The highlight color displayed for the activity in the Designer panel.

工作流文件中定义的参数列在左侧菜单的“活动属性”下。

• 要自定义生成的属性，请选择该属性并配置以下内容：

  • 显示名称 - 活动中显示的属性标签。
  • Tooltip - The tooltip that is visible when you hover over the activity property.
  • Input Type - The type of input for the property. You can use the default input for the property type or select an input option depending on the type:
    • 布尔值 - 使用默认值、切换（默认）、条件构建器、单选按钮。
    • 数字（int、double、decimal、long、short、sbyte、byte、ulong、ushort、unit、float） - 使用默认值、数字编辑器、下拉列表。在下拉列表中，通过按键盘上的 Enter 键，在“值”字段中输入每个单独的值。
    • 字符串 - 使用默认值、文本编辑器（默认）、富文本编辑器、下拉列表、自动完成、单选按钮。对于下拉列表、自动完成和单选按钮，请在“值”字段中按键盘上的 Enter 键，输入每个单独的值。
    • String[] - 使用默认值、字符串数组。
    • 日期时间 - 使用默认值、日期时间。
    • 时间跨度 - 使用默认值、时间跨度。
    • - 使用默认值、字典。
    • 所有其他类型 - 使用默认值、输入。
  • 占位符 - 未选择任何值时在输入处显示的占位符文本。
  • 必需 - 是否需要该属性。
  • 仅限高级 - 是否应仅在活动的高级选项部分中显示属性。高级选项部分中的属性也可以按类别进行组织。

• 要添加用于对多个相关属性进行分组的类别，请选择窗口左下方的“新建类别”。类别仅在所生成活动的高级选项部分中可用，并且可以展开或折叠。如果类别为空，则单击“保存”以关闭窗口时，系统会将其删除。

• 要更改属性和类别的顺序，或向类别添加属性，请拖放列表中的项目。

  

Windows 旧版库的选项

Select Activity Properties in the left-side menu and enter the following:

• Tooltip - The tooltip that is visible when you hover over the activity in the Activities and Designer panels in projects where the library is installed.
• Help Link - The help link that opens when you select the activity in the Designer panel and press F1 on your keyboard.

工作流文件中定义的参数显示在左侧菜单的“活动属性”下。

• 要自定义生成的属性，请选择该属性并配置以下内容：

  • 显示名称 - 活动中显示的属性标签。
  • Tooltip - The tooltip that is visible when you hover over the activity property.
  • 必需 - 是否需要该属性。
  • 仅限高级 - 是否应仅在“属性”面板中显示属性。如果选中，则所生成活动的“设计器”面板中不会显示该属性。

• 要更改属性在活动中的显示顺序，请将其拖放到列表中。

  备注：

  • 就库而言，建议使用 Nothing（而非 ""）将 null 值分配给变量。如此一来，在将打包的库作为依赖项用于项目中时，便能避免发生任何不一致的情况。
  • 不支持 System.Activities.ActivityBuilder 对象的“实现版本”属性。为该属性设置值将导致参数无法保存。当您选择“设计”面板的空白区域，该对象显示在“属性”面板中。

调整库设置

要配置库项目的设置，请单击“项目”面板中的“设置”，打开“项目设置”窗口。

“常规”选项卡中提供以下选项：

• 名称 - 编辑项目的名称。

• 描述 - 编辑项目的描述。

• Automation Hub URL - URL of an Automation Hub idea linked to the project. For more information, see Linking a Project to an Idea in Automation Hub.

• 项目图标 -（可选）定义项目的自定义图标。您可以浏览并选择一个文件，或者为大小至多 1MB 的 ico、jpeg、jpg 或 png 文件输入路径或公共 URL。

  After the project is published, the icon is displayed next to the package in the Manage Packages window in Studio.

• 编译活动表达式 - 设置为“是”以编译所有活动表达式并将其与库打包。这可缩短执行时间。可用于 Windows - 仅旧版库。

• 准备运行 - 设置为“是”以优化生成的程序集，以便在运行时更快地进行 JIT 编译。仅可用于 Windows - 旧版库。

• Modern Design Experience - set to Yes to enable a modern experience of working with UI Automation, including new and improved activities, recorders, and wizards, as well as the Object Repository.

发布库

Publishing libraries is similar to publishing processes. For more information, see About Publishing Automation Projects. Unlike processes, publishing a library creates two NUPKG files – a design time package and a runtime package. This applies only to Windows and cross-platform libraries if the Separate Runtime DependenciesProject Settings option is enabled.

备注：

• 由于设计时包和运行时包之间存在分离，不保证在 Studio 2023.4 中发布的自定义库与早期的 Studio 版本兼容。
• 您只能在项目中安装设计时包，因为在发布时设计时包会替换为运行时包。仅安装运行时包将导致 Studio 中出现意外问题。

使用库时的限制

使用库时，请考虑以下限制：

• 由于 NuGet 的限制：

  • 您无法使用 Windows 环境路径变量将库发布到包含用户受限的子文件夹所在的位置。
  • 已发布库的发行说明仅在 Orchestrator 中可见。

• 如果库中 .xaml 文件的名称中包含特殊字符，则该库可能无法成功发布。

• 如果库包含名称相同的 .xaml 文件和参数，则无法发布该库。

• 如果库项目包含“调用工作流文件”活动并选择“隔离”选项，则无法发布具有 Windows - 旧版兼容性的项目。 尝试发布时，“输出”面板中会显示一条错误消息。此限制不适用于使用 Windows 或跨平台兼容性的库。

• 在使用“调用工作流文件”活动时，请确保所调用的文件与库项目位于同一个文件夹中。

• 库不支持“启动工作流交互式”活动。

• 不支持在库中使用“调用工作流文件”来引用库本身。

• 如果库包含接受文件路径作为输入的活动，为确保在安装了库的项目中正确解析路径，请在引用路径时添加 UiPath.Constants.Project.Location 全局常量（使用确切的大写字母）。这将禁止在开始执行库活动时将 Environment.CurrentDirectory 更改为库文件夹，并改用常量。

  例如，如果在“读取文件”活动中使用库项目的 InputData 子文件夹中名为 Employee.txt 的文件，请提供如下路径：

  UiPath.Constants.Project.Location+"InputData\Employee.txt"

  备注：

  在库中的调用工作流文件活动中不得使用常量。

• 要从安装库的项目文件夹中引用位置，请将库的路径作为参数传递。

向自动化项目中添加可重用组件

1. 打开现有项目，或创建一个新项目。
2. 在“所有包”类别下，选择保存库的订阅源并安装包。
3. 选择“确定”，然后包将被添加到项目定义中。
4. 该活动位于“活动”面板中的自定义类别中。

在项目中安装库的注意事项

• Libraries with the cross-platform compatibility can be installed in cross-platform and Windows projects. Windows - Legacy and Windows libraries can only be installed in processes that have the same compatibility.

• 当您运行的项目包含自定义活动的项目时，可能会发生错误，这些自定义活动来自在 2019.10.1 之前的 Studio 版本中创建并通过 Studio 2019.10.1 或更高版本发布的库中。在这种情况下，您必须重新创建并重新发布库。

• 在库项目中，当使用“导入工作流”来添加包含库的工作流时，不会导入库中引用的依赖项。

• 将同一自定义库的两个版本导入项目时，仅包含在第二个库中的额外自定义活动在“活动”面板中不可见，除非您删除第一个导入的库。

• 在活动面板中查看库时，使用库名称中的句点 (.) 将库分为多个嵌套的组。

• 使用库中的自定义活动时，当活动添加到工作流中时，为参数定义的任何默认值都会自动预填充到活动的“属性”面板中。如果从工作流中的“属性”字段清除该值，运行时不会使用对应的默认值。在这种情况下，会明确传递一个空值。

  相反，使用“调用工作流”活动时，在“导入参数”面板中将输入保留为空白时，运行时会使用被调用工作流中定义的默认值。