API 插件 › 如何编写 API 插件并将其用于表单

如何编写 API 插件并将其用于表单

要编写 API 插件并将其用于表单，请遵循以下过程：

1. 定义插件的用途，例如，使用用户可以在指定时间段内预约的会议室来填充选择窗口项。 其他示例包括会议室的选项，如投影仪、视频会议设备和麦克风。
2. 满足先决条件。 即能熟练地执行以下操作：
   • 用 Java 编程
   • 使用表单设计器创建表单
   • 在表单设计器表单中创建以下窗口项：
     • 单选、多选和双列表窗口项
     • 动态表窗口项
3. 按如下所示审查 API 插件文档：
   1. 登录到 CA Service Catalog，依次选择“管理”、“工具”。
   2. 在左侧的菜单中选择“链接”。
   3. 单击“插件文档”。

   API 文档自动基于 Java 类方法为插件生成 Java 文档。 您可以使用接口、类、方法等来实施插件。

4. 针对应用插件的表单设计器窗口项的类型创建 Java 类，如下所示：
   • 对于单选、多选和双列表窗口项：创建用于实施 com.ca.usm.plugins.apis.forms.FDSelectDataProvider 接口的 Java 类。 此接口的实施示例在“选择插件示例”中提供，ID 为 ca.catalog.samples.select-plugin。
   • 对于动态表窗口项：创建用于实施 com.ca.usm.plugins.apis.forms.FDTableDataProvider 接口的 Java 类。 此接口的实施示例在“表插件示例”中提供，ID 为 ca.catalog.samples.table-plugin。

   要访问接口的 Java 文档，请依次单击“管理”、“工具”、“插件”，然后单击“API 文档”。

   要下载源代码示例，请单击同一页面上的插件示例，然后单击“下载源代码”。

5. 为插件创建属性文件，如下所示：
   • 可以使用插件示例作为您的属性文件的模型。 在这种情况下，请在 plugin.properties 文件中更改插件 ID 属性。
   • 要使用包括的生成文件来编译插件示例或修改其版本，请使用 Java Development Kit 1.6（或更高版本）和 Apache Ant 1.8（或更高版本）。
   • 为获得最佳效果，请为您的插件使用专用的类加载器。 要使用专用类装载器，请将下列行添加到您的 plugin.properties 文件中：

     classloader.type=private
     

     注意：在升级 CA Service Catalog 之后，使用 CA Service Catalog R12.7 的自定义插件不需要任何更新。 这些插件继续运行如初。

6. （可选）如果您使用内容配置表单，则可以检索这些表单上字段的值并在需要时使用。
7. 若适用，请执行下列操作之一：
   • 为静态表配置排序和分页参数
   • 为动态表配置排序和分页参数
   • 为选择框配置分页参数的“页面大小”属性
8. 创建文件夹以存储以下内容：
   • 属性文件

     重要信息！ 将属性文件存储在顶级文件夹中， 不要存储到子文件夹中。

   • 提供类和支持库的任何 JAR 文件

     如有必要，您可以将这些文件存储到子文件夹中。

9. 执行以下操作以激活插件：
   1. 将您的文件夹（包括可能存在的所有子文件夹）复制到 filestore 的 plugins 文件夹。

      注意：有关文件存储的详细信息，请参阅《实施指南》。

   2. 依次选择“管理”、“工具”、“插件”，然后单击“重新加载插件”方式。
10. 执行以下操作以确认已成功采用插件：
    1. 登录到 CA Service Catalog，依次选择“管理”、“工具”。
    2. 从左侧菜单中选择“插件”。
    3. 确认列出了插件而且显示的信息正确。

至此，您已准备好针对在表单窗口项中的使用测试该 API。