本主题仅适用于 IBM Business Process Manager Advanced 配置。

提供您自己的外部服务或数据向导插件

您可以提供针对贵组织的需求进行定制的自己的外部服务或者数据向导插件。然后,集成开发者可以采用与使用外部服务向导或外部数据向导相同的方式,使用您的插件。

以下主题描述为您提供的扩展点插件。扩展这些插件就可以创建自己独特版本的插件。

概述

两个可扩展的插件(通常称为扩展点)用于创建您自己的外部服务或数据向导。

  • com.ibm.wbit.adapter.templates.ui.wizard - 该扩展点描述您可以采用自己的添加内容进行扩展的外部服务或数据向导。
  • com.ibm.wbit.adapter.templates.ui.category - 该扩展点描述向导第一页上您将使用自己的添加内容进行扩展的分层类别。

这两个扩展点共同构成向导。关系是向导插件引用类别插件。

向导扩展点

向导扩展点用于提供新的向导实现,这可从外部服务或外部数据向导调用。

表 1. 向导定义属性
向导定义属性 必需?
能力 (capability) 必需 指定向导的功能。如果设置为 ExternalService,那么向导将显示为外部服务向导中的选项。如果设置为 ExternalData,那么向导将显示为外部数据向导中的选项。
类别 (category) 必需 该向导所属类别的标识。 这些是 com.ibm.wbit.adapter.templates.ui.category 扩展的标识。 显示的名称在类别扩展本身中定义。子类别可以用双斜杠分隔(例如,BPEL.id//eForms.id)。
class 必需 该类实现接口 com.ibm.wbit.adapter.templates.ui.IExternalServiceWizard(对于 capability = "ExternalService")或 com.ibm.wbit.adapter.templates.ui.IExternalDataWizard(对于 capability= "ExternalData")。如果您希望了解从中启动向导的上下文,那么从 getWizard() 方法返回的 IWizard 类必须实现接口 com.ibm.wbit.adapter.templates.ui.IContextualWizard
configuration 可选 限定名 (QName),指定将使用的配置。该配置定义用于生成工件的发现代理和资源写程序。这只适用于设置为 capability = "ExternalData" 的向导。
description 必需 有关向导功能的描述。该描述显示在窗口描述中,如果未在 preview_html 字段中指定任何 HTML 文件,那么此描述文本就会显示在该位置。
help_id 可选 用户在预览窗口中单击或在向导中按下 F1 按钮时可以调用的根帮助标识。这是在帮助系统中定义的 F1 帮助标识。
图标 可选 外部服务或外部数据向导导航树中与该向导关联的图标。
id 必需 该向导的唯一标识。
keywords 可选 在填充关键字过滤输入字段期间使用的任何标记或关键字。首选使用多个单一词汇(以逗号分隔)。
名称 必需 外部服务或外部数据向导导航树中与该向导关联的显示名称。
preview_html 可选 这是向导的格式化 HTML 预览的可选文件名。仍然需要指定常规文本描述,但是指定该属性后,使得向导只要有空间就会显示视觉效果更好的格式化文本。这是插件根目录的相对路径。您还必须通过将构建添加到插件的二进制构建属性中,确保 HTML 文件包含在构建中(例如,html/index.html 就是这种情况的一个典型条目)。您还可以为该条目指定 .txt 文件。该文件会正确显示。最后,如果没有为此指定任何条目,那么描述框只显示此扩展点的 description 字段中的文本。
product 可选 一个关键字,指定此向导所针对的产品。值是以空格分隔的多个单一单词。如果未指定,那么假设该向导可用于所有已安装的产品。
qname 可选 指定用于标识向导的唯一限定名 (QName)。该限定名的格式为 <.namespace>:<.localName>。 qname 只适用于设置为 capability = "ExternalData" 的向导。
target_id 可选 target_id 是子标识,每当仅在另一个特定插件操作或向导中调用该向导时,就会使用该标识。只要设置了该属性,它就不会出现在全局视图中。插件可以使用 templates.ui,返回具有特定标识的 TemplateWizardType
使用该扩展点的外部服务向导的示例:
<extension point="com.ibm.wbit.adapter.templates.ui.wizard">
 <wizardDefinition
  capability="ExternalService"
  category="com.ibm.wbit.adapter.external.category.adapters"
  class="com.ibm.wbit.adapter.emd.ui.template.wizards.CICSService"
  description="%CICS_SERVICE_DESCRIPTION"
  help_id="com.ibm.wbit.adapter.emd.ui.CICSService"
  icon="icons/etool16/cicsecirar_obj.gif"
  id="com.ibm.wbit.adapter.external.service.CICSService"
  name="%CICS_SERVICE">
 </wizardDefinition>
</extension>
使用该扩展点的外部数据向导的示例:
<extension point="com.ibm.wbit.adapter.templates.ui.wizard">
 <wizardDefinition
  capability="ExternalData"
  category="com.ibm.wbit.adapter.external.category.languages"
  class="com.ibm.wbit.adapter.emd.ui.template.wizards.CICSData"
  description="%COBOL_DATA_DESCRIPTION"
  icon="icons/etool16/cicsimsbo_obj.gif"
  id="com.ibm.wbit.adapter.external.data.Cobol"
  name="%COBOL_DATA"
  configuration="com/ibm/wbit/adapter/emd/cobol/writer:COBOL_TO_XSD"/>
 </wizardDefinition>
</extension>

类别扩展点

类别扩展点为外部服务和外部数据向导中的导航树提供类别和子类别。 这些类别由向导 (com.ibm.wbit.adapter.templates.ui.wizard) 扩展点使用。

表 2. 类别定义属性
类别定义属性 必需?
图标 必需 用于在导航树中表示此类别的图标(16 x 16 像素)。
id 必需 此类别的唯一标识。
名称 必需 类别的显示名称。
parent_category 可选 如果该类别是子类别,那么这是其父类别的标识。
使用此扩展点的类别的示例:
<extension point="com.ibm.wbit.adapter.templates.ui.category">
 <category
  icon="icons/obj16/adapters.gif"
  id="com.ibm.wbit.adapter.external.category.adapters"
  name="%CATEGORY_ADAPTERS"/>
 <category
  icon="icons/obj16/ios_obj.gif"
  id="com.ibm.wbit.adapter.external.category.languages"
  name="%CATEGORY_LANGUAGES"/>
</extension>

引用

创建 Eclipse 插件(例如这个插件)时,应遵循在 PDE Does Plug-ins 中描述的标准过程。在 IBM® Integration Designer 内,提供自己的调解原语插件 的示例部分向您展示用于创建插件项目、修改 plugin.xml 文件等的确切步骤,这类似于您在创建自己的外部服务或数据向导插件时必须执行的操作。