集成包向导

  • 项目

重要

此版本的 Orchestrator 已终止支持。 建议 升级到 Orchestrator 2019。

使用集成包向导 (IP 向导) ，可以从现有的集成 程序集创建新的集成包。 可以使用Command-Line活动向导 (CLIActivityWizard) 或使用 Orchestrator SDK 创作集成程序集。 IP 向导 (IPWizard) 程序集、依赖文件和所需元数据打包到 .OIP 可通过 Orchestrator 部署管理器部署的文件中。 可以使用完整的品牌和自定义图标创建具有专业外观的集成包，或者只需打包命令行活动，以便可以使用 IP 向导更轻松地部署它们。

决定何时创建集成包

请务必确定是适合将活动与工具包的 .NET 集成包 活动一起使用，还是最好在集成包中创建和部署所有活动。

如果只有少量活动，或者处于开发阶段并在活动中创建许多更改，则应仅将程序集与 Toolkit .NET Integration Pack 活动一起使用，以在 Runbook 中执行这些活动。 打包、注册、部署、卸载和升级集成包会在开发过程中产生大量开销。

如果你有一组要测试的活动，或者你正在开发周期中更进一步，并且想要测试整个端到端的安装或升级过程，则创建集成包是更好的方法。 集成包提供更友好的用户体验和完整的安装体验。 集成包还允许将活动部署到组织中的多个 Runbook 服务器或 Runbook 设计器或外部客户。

创建新的集成包

使用集成包向导，可以从与业务流程协调程序兼容的现有程序集和依赖文件创建集成包。 如果尚未创建与 Orchestrator 兼容的程序集，请参阅 命令行活动向导。

注意

Integration Toolkit 不再包含 Windows Installer XML (WiX) 工具集的二进制文件，该集由 IP 向导用于创建自定义集成包。 请在使用 IP 向导之前安装最新版本 (v3.11) 的 WiX 工具集 。

创建新的集成包

  1. 启动集成包向导。 选择“ 启动 > Orchestrator 集成包向导”。 将显示欢迎页。

  2. 如果已有要更新的集成包，请选择“ 导入集成包”。 有关详细信息，请参阅 更新现有集成包。 若要创建新的集成包，请选择“ 下一步”。

    重要

    如果要升级现有 IP，则必须选择“ 导入集成包”。 如果选择“ 下一步”，则创建的 IP 将具有所有活动的新唯一产品 ID 和新的唯一 ID，即使你重复使用以前的程序集并使用相同的产品和文件名也是如此。

  3. 在“ 产品详细信息” 页上，根据需要输入或修改信息，以自定义有关集成包的信息。 下表描述了这些字段及其说明：

    字段名称 说明
    产品名称 部署管理器中显示的 IP 的名称
    类别名称 在 Runbook Designer 的“活动”窗格中显示为 IP 的类别标题的文本
    Company 公司的名称。 此信息显示在“发布者”下的“添加/删除程序”中
    EULA 文件 扩展名为 RTF 格式的 .EULA 文本文件。 EULA 在使用部署管理器注册期间向用户显示，并且需要在注册之前接受。
    资源文件 包含用于提供类别和活动图标的图标和其他资源的程序集。 默认情况下，使用标准工具包资源文件 (Microsoft.SystemCenter.Orchestrator.Integration.Toolkit.Wizard.Images.dll)
    版本 集成包的版本号，该版本号将显示在部署管理器中，用于确定 IP 是否为升级。
    启用升级 如果导入了现有集成包，则默认选中此复选框，使此集成包能够升级现有的已安装版本。 如果清除此复选框，将为 IP 创建新的产品和活动 ID， (它不会升级现有版本) 。 如果要启用多个 IP 版本的并行安装，请清除此复选框。
    说明 集成包的详细说明
    类别图标 将显示默认类别图标。 如果要选择其他图标，请选择“ 修改 ”按钮并选择一个新图标，然后选择“ 确定”。

  4. 输入完产品信息后，选择“ 下一步”。 将显示“活动”页。 在“活动”页中，将引用包含使用 Command-Line 活动向导定义或使用 Orchestrator SDK 创建的活动的程序集。

  5. 若要向 IP 添加新活动，请选择“ 添加”。

  6. 若要打开并添加程序集文件，请选择“库”右侧的省略号 (...) 按钮。 浏览到所需的程序集文件，将其选中，然后选择“ 打开”。 文件名和路径显示在“库”字段中。

  7. 若要从程序集中选择活动，请选择“ 类 ”下拉箭头，然后从列表中选择相应的活动名称。 活动中定义的名称和说明显示在“显示名称”和“说明”字段中。

  8. 如果需要，请修改活动的显示名称和说明。

  9. 将显示活动的默认活动图标。 如果需要其他图标，请选择“ 修改”，从浏览器中选择另一个图标，然后选择“ 确定”。

  10. 选择“ 确定 ”以保存活动定义。 活动名称和说明现在显示在“活动”列表中。

  11. 根据需要继续向列表添加活动。 添加完活动后，选择“ 下一步”。 将显示“依赖项和包含的文件”页。

  12. 在此页上，可以定义要与集成包一起打包的额外文件的列表。 这些文件可能是活动、脚本、文档或要连同活动一起部署到 Runbook 服务器和 Runbook 设计器的其他文件所需的额外程序集。 选择“ 添加”，选择所需的文件 () ，然后选择“ 确定 ”将文件添加到列表。

  13. 完成将文件添加到列表后，选择“ 下一步”。 将显示 Orchestrator 集成包文件页。

  14. 在提供的文本框中，输入要创建的集成包的路径和文件名。 如果输入的文件名已存在，它将被覆盖。 确保有足够的访问权限来写入指定的路径，否则进程将失败。 如果未指定路径，则将在 Documents 文件夹中创建 OIP 文件， (C:\users\<your username>\Documents) 。 选择“ 下一步 ”开始生成 IP。

    重要

    文件名中的字符必须对操作系统上安装的语言有效。

    重要

    为集成包指定一个不常见的名称，以确保它与另一个集成包的名称不匹配。 Orchestrator 无法安装两个同名的集成包。

  15. 成功生成 IP 后，向导的最后一页将显示新 OIP 文件的路径和文件名。 选择“完成”退出向导。 如果出现错误，可以选择“ 返回 ”，然后重试生成过程。

    有关部署集成包的信息，请参阅 文章如何添加集成包。

更新现有集成包

Orchestrator 集成包向导允许导入现有集成包，以便进行更改并将其重新打包为新版本。 确保检查“启用升级”复选框，否则将创建新的 IP，而不是替换或升级以前安装的版本。

有用的 IP 升级提示

更新基础程序集

创建集成包时，有关 IP 的元数据存储在包中，以便向导可以在后续升级期间读取它。 更新某些项（例如活动或这些活动的基础程序集）时，需要重新生成 IP。 但是，如果修改活动设置并选择新的程序集文件，它将重置“活动信息”页上的字段，要求你再次输入信息。

可以在仅修改程序集时保留 IP 配置设置。 将新程序集保存到与上一个程序集相同的路径和文件名 (该路径和文件名显示在“活动信息”对话框) 的“库”字段中。

QIK 集成包迁移

如果使用 Opalis QIK 向导创建了集成包，则需要先将其转换为与 Orchestrator 兼容，然后才能导入和由 Orchestrator 使用。

转换 IP 之前，必须完成以下步骤：

  • 如果 IP 中的活动是使用 QIK CLI 向导创建的，则必须遵循 QIK CLI 活动迁移 中概述的步骤，使其与 Orchestrator 兼容。 如果没有包含活动的程序集的单独副本，则需要先将 IP 安装到 Opalis 6.3 服务器，然后在以下目录中找到该程序集： C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions\Support\Quick Integration Kit 3。

  • 如果 IP 中的活动是使用 Opalis API 在 C# 中自定义开发的，则必须遵循 迁移 QIK API 自定义活动 中所述的步骤，使其与 Orchestrator 兼容。

    注意

    Integration Toolkit 或 Orchestrator 不再支持使用 Opalis API for Java 的基于 Java 的活动。

  • 如果 IP 包含依赖文件或其他包含的文件，则这些文件必须可用于重新打包到新 IP 中。 如果没有这些文件的单独副本，则需要先将 IP 安装到 Opalis 6.3 服务器，然后在以下目录中找到文件： C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions\Support\Bin。

  • 如果 IP 包含用于活动和类别图标的自定义资源文件，则该文件必须可用于新 IP。 如果没有此文件的单独副本，则需要先将 IP 安装到 Opalis 6.3 服务器，然后在以下目录中找到该文件： C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions。

  • 如果你的 IP 使用 QIK 为类别或活动图标提供的标准图标，并且你希望继续使用这些图标，而不是使用 Orchestrator 中提供的新图标，则需要获取 Opalis.QIK.Wizard.Images.dll 该文件，并像使用自定义资源文件一样使用它。 如果没有此文件的单独副本，则需要先将 IP 安装到 Opalis 6.3 服务器，然后在以下目录中找到该文件： C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions。

注意

对于最简单的转换过程，应在启动 IP 向导之前，将所有这些文件放在最初打包 IP 时它们的位置。 IP 向导按文件的原始路径引用这些文件。 所有文件都可以选择新路径，但为包含活动的程序集选择新路径将导致重置活动的某些详细信息，因此需要再次输入信息。 通过使用文件的原始路径，只需重复使用现有信息，而无需重新输入。

转换与 Opalis 兼容的集成包

  1. 启动集成包向导

  2. 选择“ 导入集成包”。

  3. 选择现有 OIP 文件，然后选择“ 打开”。

  4. 你将看到一条警告消息，指示该 IP 与 Orchestrator 不兼容。 选择“确定” 。

  5. 根据需要修改产品详细信息以反映任何更改。 IP 的版本号会自动递增，并选中“升级”复选框。 选择“下一步”。

  6. 在“活动”页上，浏览每个活动并确保信息正确完成。 如果活动的程序集尚未迁移或与创建 IP 时不在同一位置，则 “类 ”字段将为空。 若要防止必须重新键入任何信息，应在启动向导之前替换程序集。

  7. 完成编辑活动后，选择“ 下一步”。

  8. 确保依赖文件仍位于所示的同一位置，或者将其删除并添加新的依赖文件。 选择“下一步”。

  9. 输入新 IP 文件的路径和文件名。 不要使用与以前的 IP 相同的名称，以便可以确保保留以前的 IP 的副本。 选择“ 下一步 ”生成 IP。

    现在，你有一个与 Orchestrator 兼容的 IP，可以使用 Orchestrator 部署管理器进行注册和部署。

集成包 - 已知问题

文件名长度限制

在集成包中包含程序集时，安装程序会自动将其添加到注册表中。 由于注册表项名称长度的限制，程序集的组合路径和文件名不能超过 234 个字符。 给定放置 IP 中的程序集的默认路径，包含的程序集文件的最大文件名长度不能超过 80 个字符。 如果安装中包含文件名超过 80 个字符的程序集，则安装将失败。

Orchestrator 资源

除了为 System Center Orchestrator 提供的此联机参考外，还有许多资源可以提供有关生成 Runbook、使用 Integration Toolkit 和最佳做法的其他信息。

另请参阅