BOCCC Hong Kong
Developer Guide
For
Palms Plugin Develop Document
Last Update: June 04, 2022
CONFIDENTIAL
Project Reference:
Issue Date:
Author:
Department:
2011-11-28
Allen, Terry.tang
PALMS
PALMS Plugin Develop Document – Plugin Develop Document
Revision History
Version
Primary Author
1.0
1.1
Terry.tang
Allen
Descriptions
Document Created
Document Update
Date Completed
2011-11-28
2011-12-19
Distribution List
Name
Department
Title
Reviewer List
Name
Title
Department
Signature
Date
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.1
Page 2 of 37
PLAMS PLUGIN DEVELOP – System and Technical Specification
目 录
Revision History................................................................................................................ 2
Distribution List................................................................................................................ 2
Reviewer List..................................................................................................................... 2
1 简介.................................................................................................................................5
1.1 目的............................................................................................................................................5
1.2 范围............................................................................................................................................5
1.3 背景............................................................................................................................................5
1.4 预期的读者和阅读建议............................................................................................................5
1.5 定义、首字母缩写词和缩略语............................................................................................... 5
1.5.1 定义 .................................................................................................................................5
1.5.2 首字母缩写词和缩略语 ................................................................................................ 6
1.6 参考数据....................................................................................................................................6
1.7 假定............................................................................................................................................6
2 搭建插件开发环境.........................................................................................................7
2.1 install your java(配置 java 环境略去)。................................................................................7
2.2 Install the Atlassian Plugin SDK 3.0.1....................................................................................... 7
3 Configuring eclipse to user the SDK...........................................................................10
3.1 用命令进入一个插件开发工作空间目录 cd /…/工作空间目录 ........................................10
3.2 接着上面的命令在目前所在工作空间中再输入:atlas-create-jira-plugin........................ 10
4 Generate Project Files for your IDE...........................................................................16
4.1 先创建一个插件的工作空间................................................................................................. 16
4.2 把 TestPluginProject 目录变成项目工程 ...............................................................................17
5 插件依赖到外部 jar 时开发步骤................................................................................20
5.1 在本地我们先在开发插件环境中安装上依赖的 xxx.jar,方法是在命令行执行:.............. 20
5.2 如果上面命令执行成功,此时 xxx.jar 就放入到了此目录下:..............................................20
5.3 在插件工程中加上依赖到的这个 jar 来编译.......................................................................21
5.4 然后关键一步: 此外部 xxx.jar 和我们本插件工程怎么相互关联,打开工程下的 pom.xml
.........................................................................................................................................................21
5.5 然后代码编写完成后再执行 atlas-cli 命令和 pi 命令 打插件 jar 包................................22
6 插件开发中遇到的一些问题.......................................................................................23
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
Version V.1.0
Page 3 of 37
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
PLAMS PLUGIN DEVELOP – System and Technical Specification
6.1 插件初始进入页面开发配置................................................................................................. 24
6.2 插件进入初始页面对应的类开发步骤:................................................................................ 27
6.3 关于调用 Action 的配置.........................................................................................................28
6.4 关于请求到 servlet 的配置 .....................................................................................................34
6.5 其他问题..................................................................................................................................35
7 总结...............................................................................................................................36
8 附录...............................................................................................................................37
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.0
Page 4 of 37
PLAMS PLUGIN DEVELOP – System and Technical Specification
1 简介
1.1 目的
本文档是 Palms 插件开发步骤的技术说明书,描述了插件开发的步骤,开发原理,出错原
因,插件安装步骤以及如何与 eclipse 集成开发,用以指导后续的产品设计和开发。
1.2 范围
该文档将仅仅描述是 Palms 插件开发步骤的技术说明,不涉及到其它相关 Application 的详
细描述,关于其它相关 Application 的详细描述请参阅相应的技术说明书。本文档描述的 Palms
插件开发步骤的技术说明适用于整个插件模块开发初期对开发步骤的掌握和插件开发基本原
理,旨在为插件开发工作提供系统的步骤和技术解决方案的依据。本文的设计方案不仅覆盖了
Palms Plugin 插件开发的步骤,而且考虑了适应今后所有操作维护插件系统的实现结构及错误
追踪,从而增加插件开发平台的稳定性和可扩展性。
1.3 背景
当前 PALMS 的上层应用(如自定义字段等)需要用到一些适合公司业务逻辑的应用并且在
PALMS 前台展示操作,Palms Plugin Develop Document 提供一种公共的开发说明供开发者应
用指导,于是出现了用户插件开发文档。
1.4 预期的读者和阅读建议
Palms Plugin 模块架构人员、测试人员及维护人员,卡司系统部署及系统支持人员。
Palms Plugin 模块开发的 Application 系统设计人员、开发人员及维护人员。
1.5 定义、首字母缩写词和缩略语
1.5.1 定义
N/A
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.0
Page 5 of 37
PLAMS PLUGIN DEVELOP – System and Technical Specification
1.5.2 首字母缩写词和缩略语
序号 缩略语
1
2
V+
PALMS
全 称
Host
中 文 译 名
说明
主机
Project And Log Manager
项 目 及 日 志 管 理
System
系统
1.6 参考数据
N/A
1.7 假定
N/A
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.0
Page 6 of 37
PLAMS PLUGIN DEVELOP – System and Technical Specification
2 搭建插件开发环境
以下是搭建插件开发环境的步骤.
目前开发的PALMS的Plugin插件主要是想在Palms System下的Browser Project中显示。
准备:JDK1.5,Atlassian Plugin SDK 3.0.1,JIRA 4.0.1(无所谓)。最好机子能连上网,
我在公司可是悲剧的了,总是拷来拷去的。
Setting up your Plugin Development Environment:
2.1 install your java(配置 java 环境略去)。
2.2 Install the Atlassian Plugin SDK 3.0.1
Download:
https://maven.atlassian.com/content/repositories/atlassian-public/com/atlassian/am
ps/atlassian-plugin-sdk/ 选择符合你要求的版本,一个看你使用JIRA版本、JDK版本。
download 完了,unzip Atlassian Plugin SDK3.0.1zip 到你想的目录下。如
(D:\Atlassian\atlassian-plugin-sdk-3.0.1,接下来我们把路径
D:\Atlassian\atlassian-plugin-sdk-3.0.1\bin与
D:\Atlassian\atlassian-plugin-sdk-3.0.1\apache-maven\bin添加到我的环境变量Path下。
右键“我的电脑”-“属性”-“高级”-“环境变量”-选择“系统变量”或当前用户“用户变
量”,选择“Path”-“编辑”,将其上粘贴上即可。如下图
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.0
Page 7 of 37
PLAMS PLUGIN DEVELOP – System and Technical Specification
好啦,现在Atlassian Plugin SDK3.0.1安装好了。看看能不能用吧。
Open a command window(window+R:输入cmd),键入c:\>mvn -v可查看JDK版本及其他信
息,再键入c:\>mvn,回车后看到一大堆信息,显而易见的有个Build Error信息。没关系,出
现这个就是说该安装环境很Ok的啦。如图:
Date: 6/4/22
© BOC Credit Card 2009 - All Rights Reserved
CONFIDENTIAL AND PROPRIETARY TO BOC Credit Card
For Internal Use Only - Do Not Duplicate
Version V.1.0
Page 8 of 37