集成包向导

重要

此版本的 Orchestrator 已结束支持,建议 升级到 Orchestrator 2019

集成包向导 (IP 向导 ") 允许您从 Command-Line 活动向导创建或通过 Orchestrator SDK 创建的现有程序集创建新的集成包。 IP 向导可以将程序集、依赖文件以及所需的元数据打包成一个 .OIP 文件,以便通过 Orchestrator Deployment Manager 进行部署。 通过 IP 向导,可以创建具有完整品牌和自定义图标的专业集成包,并可以简单地打包命令行活动,以便更轻松地进行部署。

确定创建集成包的时间

创建自定义活动以便在 Orchestrator 中使用时,决定将各个活动与 Toolkit 的 .NET 集成包配合使用的时间,以及创建和部署集成包的时间至关重要。

如果只有一个或几个活动,或者当前处于部署阶段并正对活动进行多项更改,则只需将程序集与 Toolkit IP 活动配合使用,即可测试这些活动的运行。 在部署过程中打包、注册、部署、卸载和升级集成包会产生许多不必要的开销。 此外,由于部署 IP 涉及到安装 Windows Installer 文件并对数据库进行更改,因此经常执行此操作可能会导致意外的结果,因此建议你使用虚拟机并经常还原,以确保干净的测试环境。

如果有一组活动要测试,或者接下来将进入开发周期并希望测试从安装、升级、卸载到使用已完成活动的整个完整过程,则创建集成是正确的选择途径。 集成包提供了更加友好的用户体验,包括在 Runbook Designer 的“活动”窗格中显示活动以及完整的安装体验。 集成包还可以将活动部署到整个组织的多台 Runbook Server 或 Runbook Designer,甚至外部客户。

创建新的集成包

集成包向导允许您从与 Orchestrator 兼容的现有程序集和依赖文件创建集成包。 如果尚未创建与 Orchestrator 兼容的程序集,请参阅 命令行活动向导

注意:集成工具包不再包括用于在集成包中创建 Windows Installer 文件的 Windows Installer XML (WiX) 工具集的二进制文件。 安装 Toolkit 之前,需要安装这组工具,这是先决条件。 但是,如果随后卸载 WiX,集成包向导将显示一条错误消息,指示下载并安装 WiX。 集成工具包支持3.5 版的 WiX 工具集。 可以从下载 WiX 工具集 http://wix.codeplex.com

创建新的集成包

  1. 启动集成包向导。 单击 " 开始 > 所有程序 > Microsoft System Center 2012 > orchestrator > 集成工具包 > Orchestrator 集成包向导"。 将显示 "欢迎" 页。

  2. 如果你有想要更新的现有集成包,请单击 " 导入集成包"。 有关该过程的详细信息,请参阅 更新现有集成包 。 若要创建新的集成包,请单击 "下一步"。

    重要

    如果要升级现有 IP,必须单击 " 导入集成包"。 如果单击 " 下一步",你创建的 IP 将具有新的唯一产品 id 和所有活动的新唯一 id,即使你重复使用以前的程序集并使用同一产品和文件名也是如此。

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

    字段名称 说明
    产品名称 在 Deployment Manager 中显示的 IP 名称
    类别名称 显示为 "活动" 窗格中的 IP 的类别标题的文本 Runbook Designer
    Company 公司的名称。 此信息显示在 "发布者" 下的 "添加/删除程序" 中
    EULA 文件 文件扩展名为的 RTF 格式的文本文件。协议. 在注册期间使用 Deployment Manager 向用户显示,并要求在注册之前接受。
    资源文件 一个包含图标和其他资源的程序集,用于提供类别和活动图标。 默认情况下,将使用标准工具包资源文件 ( # A0)
    版本 集成包的版本号,将在 Deployment Manager 中显示,并用于确定 IP 是否为升级。
    启用升级 如果导入了现有集成包,则默认情况下此复选框处于选中状态,从而使此集成包可以升级现有的已安装版本。 如果清除此复选框,则将为 IP 创建新产品和活动 Id,而不会升级现有版本。 如果要对多个版本的 IP 启用并行安装,请清除此复选框。
    说明 集成包的详细说明
    类别图标 将显示 "默认类别" 图标。 如果要选择另一个图标,请单击 " 修改 " 按钮,然后选择一个新图标,然后单击 "确定"
  4. 输入产品信息后,单击 " 下一步"。 显示 "活动" 页。 在 "活动" 页上,您将引用包含您使用 Command-Line 活动向导定义的活动的程序集或程序集,或使用 Orchestrator SDK 创建的活动页。

  5. 若要向 IP 中添加新的活动,请单击 " 添加"。

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

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

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

  9. 将显示活动的 "默认活动" 图标。 如果需要不同的图标,请单击 " 修改 ",然后从浏览器中选择另一个图标,然后单击 "确定"

  10. 单击 "确定" 保存活动定义。 活动名称和说明现在显示在 "活动" 列表中。

  11. 根据需要继续向列表中添加活动。 添加完活动后,单击 " 下一步"。 显示 "依赖项和包含的文件" 页。

  12. 在此页上,可以定义要与集成包一起打包的附加文件的列表。 这些文件可以是你的活动、脚本、文档或其他要部署到 Runbook 服务器和 Runbook designer 中的文件以及你的活动所需的其他程序集。 单击 " 添加 ",然后选择所需) (文件,然后单击 "确定" 将文件添加到列表。

  13. 向列表中添加完文件后,单击 " 下一步"。 将显示 "Orchestrator 集成包文件" 页。

  14. 在提供的文本框中,输入要创建的集成包的路径和文件名。 如果您输入的文件名已存在,则会被覆盖。 确保你有足够的权限写入指定的路径,否则进程将失败。 如果未指定路径,则会在 Documents 文件夹中创建 .OIP 文件, (C:\users \<用户名 > \Documents) 。 单击 " 下一步 " 开始建立 IP。

    重要

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

    重要

    指定集成包的名称,该名称不常用,以确保它与其他集成包的名称不匹配。 Orchestrator 无法安装两个名称相同的集成包。

  15. 成功生成 IP 后,向导的最后一页将显示新的 .OIP 文件的路径和文件名。 单击“完成”退出向导。 如果出现错误,您可以单击 " 返回 " 并根据需要更正任何信息,然后重试生成过程。

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

更新现有集成包

Orchestrator Integration Pack 向导允许您导入现有集成包,以便可以进行更改并将其重新打包为新版本。 如果要确保对现有 IP 的更改是对 IP 的升级,而不是创建新的集成包,则需要确保将现有 IP 导入到集成包向导中,并确保选中 "启用升级" 复选框。 如果无法执行这些操作,会导致使用新的产品 ID 和新的活动 Id 创建 IP,这会创建新版本的并行安装,而不是替换或升级以前安装的版本。

如果仍在开发活动,并且更改是固定的,则在初始产品开发期间,不建议创建和升级 IP 这一过程。 相反,更好的做法是使用集成工具包的 .NET 集成包中的活动来测试 IP 之外的活动。 有关详细信息,请参阅 确定何时创建集成包

有用的 IP 升级提示

更新基础程序集

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

如果要修改某一 IP 中的一个或多个活动的基础程序集(可能要添加参数或更改已发布数据),但不希望更改与该 IP 相关的任何其他设置,只需将新的程序集保存到与上一个程序集相同的路径和文件名, (该程序集将显示在 "活动信息") 对话框的 "库" 字段中 然后,只需将现有 IP 导入到向导并完成创建 IP 的过程,无需修改任何活动信息。

QIK 集成包迁移

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

在转换 IP 之前,必须完成以下步骤:

  • 如果你的 IP 中的活动是使用 QIK CLI 向导创建的,并且你尚未将它们转换为与 Orchestrator 兼容,则必须执行 QIK CLI 活动迁移中所述的步骤,然后再继续。 如果没有包含活动的程序集的单独副本,则需要首先将 IP 安装到 Opalis 6.3 服务器,然后在以下目录中找到程序集: "C:\Program Files (x86) \Common Files\Opalis Software\Opalis Integration Server\Extensions\Support\Quick Integration 工具包 3"。

  • 如果你的 IP 中的活动是使用 Opalis API 在 c # 中进行自定义开发的,并且你尚未将它们转换为与 Orchestrator 兼容,则必须执行迁移 QIK API 自定义活动中所述的步骤,然后再继续。

    备注

    集成工具包或 Orchestrator 不再支持使用适用于 Java 的 Opalis API 的基于 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 向导会按它们的原始路径引用这些文件。 对于所有文件,选择新路径是可行的,但为包含活动的程序集选择新路径将导致重置活动的某些详细信息,要求重新输入该信息。 通过使用文件的原始路径,只需重新使用现有信息,而无需重新输入。

转换 Opalis 兼容的集成包

  1. 启动集成包向导

  2. 单击 " 导入集成包"。

  3. 选择现有的 .OIP 文件,并单击 " 打开"。

  4. 你将看到一条警告消息,指示 IP 与 Orchestrator 不兼容。 单击“确定”。

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

  6. 在 "活动" 页上,遍历每个活动,并确保信息正确完成。 如果尚未迁移活动的程序集,或该程序集不在创建 IP 时的相同位置,则 " " 字段将为空。 若要防止重新键入任何信息,应在启动向导之前替换程序集。

  7. 完成编辑活动后,请单击 " 下一步"。

  8. 确保依赖文件仍位于与所示相同的位置,或将其删除并添加新的依赖文件。 单击“下一步”。

  9. 为新的 IP 文件输入路径和文件名。 不要使用与以前的 IP 相同的名称,因此可以确保保留以前 IP 的副本。 单击 " 下一步 " 生成 IP。

    你现在拥有与 Orchestrator 兼容的 IP,可以使用 Orchestrator Deployment Manager 进行注册和部署。

集成包-已知问题

文件名长度限制

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

Orchestrator 资源

除了为 System Center 2012 Orchestrator 提供的联机参考之外,还有许多资源可提供有关使用集成工具包和最佳做法构建 runbook 的其他信息。

资源 位置
System Center 主页 https://www.microsoft.com/en-us/cloud-platform/system-center
System Center 文档 https://docs.microsoft.com/system-center/
TechNet 上的 Orchestrator 团队博客 https://blogs.technet.microsoft.com/orchestrator/
CodePlex 上的 Orchestrator 社区发布 https://archive.codeplex.com/?p=orchestrator
TechNet 上的 Orchestrator 社区论坛 https://social.technet.microsoft.com/Forums/en-US/home?category=systemcenterorchestrator

另请参阅

Orchestrator 集成包
集成工具包文档
Orchestrator SDK