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 类
   • 对于动态表窗口项：创建用于实施 com.ca.usm.plugins.apis.forms.FDTableDataProvider 接口的 Java 类

   这些接口和示例 Java 类都显示在 API 插件文档中。 您可以将 API 插件文档中的示例作为模型来创建自己的 Java 类。

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

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

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

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

9. 执行以下操作以激活插件：
   1. 停止 Service View 的 Windows 服务。 服务的名称为 CA Service View。
   2. 将您的文件夹（包括可能存在的所有子文件夹）复制到 %USM_HOME%\filestore\plug-in 文件夹中。
   3. 重新启动 Service View 的 Windows 服务。
10. 执行以下操作以确认已成功采用插件：
    1. 登录到 CA Service Catalog，依次选择“管理”、“工具”。
    2. 从左侧菜单中选择“插件”。
    3. 确认列出了插件而且显示的信息正确。

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