模块插件的应用系统设计说明书.doc

模块插件的应用系统设计说明书一、模块插件的应用描述1.1 接口的功能描述插件接口是为了A6协同的扩展功能编码而设计的，它主要实现以下功能：l 在系统启动时动态加载扩展应用的初始化代码。l 设定用户菜单和系统管理员菜单。1.2 接口结构图1.2.1 插件初始化加载流程注意：init方法返回为false会停止A6协同的运行。如果插件不能正常装载也需要运行A6协同，那么init方法的返回值必须是true.1.2.2 菜单的插件结构1.3 插件代码的规范插件作为系统的扩展必须按照一定的规范进行编码。才能保证与其它的插件不冲突，与系统升级不冲突。1.3.1 JSP路径命名规范插件的页面文件,都放到ext的目录里。路径格式为yyoa/ext/sae注意插件名的大小写是要进行区分的1.3.2 JAVA代码命名规范插件的java初始化代码必须使用包net.btdz.oa.ext包名为net.btdz.oa.ext.插件名称,如sae插件目录为 net.btdz.oa.ext.sae注意java代码的包名要跟JSP的路径名一致，大小写都不能有差异1.3.3 数据字典ex_vote_topic(选举主题表)字段类型默认备注t_id(PK)decimal(11,0)0选举IDper_iddecimal(11,0)NULL发起者IDdep_iddecimal(11,0)NULL所属上一级部门或单位IDvote_titlevarchar(100)NULL选举主题名称：定义所发起选举的名称vote_discriptiontextNULL选举说明，对选举相关事项进行说明，提供选举背景资料等（提供电子资料上传）vote_uploadfilevarchar(255)NULL电子资料保存路径vote_typeint(4)0选举方式，根据值的不同处理不同的业务逻辑，0：投票，1：提名，2：不记名，3：记名vote_ numint(4)0选举名额vote_item_typeint(4)0选举项选举类型(单选，多选)vote_areatextNULL选举范围，主要包括用户ID，用户登录后首先判断用户ID是否在这个范围内，在的话才能显示选举主题，否则无权查看选举主题vote_ starttimedatetimeNULL选举开始时间vote_ endtimedatetimeNULL选举结束时间vote_ flagint(4)1选举主题开关1：开，0：关ex_vote_ item(选举项目表)字段类型默认备注i_id(PK)decimal(11,0)0选举项目IDt_iddecimal(11,0)NULL选举主题IDitem_namevarchar(50)NULL选举项目名称ex_vote_ result(选举结果表)字段类型默认备注r_id(PK)decimal(11,0)0选举结果IDcreator_iddecimal(11,0)NULL选举发起者IDprocessor_iddecimal(11,0)NULL选举范围中的用户IDt_iddecimal(11,0)NULL选举主题IDi_iddecimal(11,0)NULL选举项目IDitem_valueint(4)0默认为0，同意为1vote_timedatetimedatetime选举投票时间vote_noteInformationvarchar(255)NULL选举备注信息，发给发起者ex_appraisal_topic(考核主题表)字段类型默认备注t_id(PK)decimal(11,0)0考核主题IDper_iddecimal(11,0)NULL考核发起者IDappraisal_titlevarchar(100)NULL考核主题名称标题appraisal_contenttextNULL考核内容appraisal_uploadfilevarchar(255)NULL电子资料保存路径method1int(4)0自评考核方式默认为0，选择为1weight1int(4)0自评考核权重，对应考核方式（应保存为小数格式）method2int(4)0群众评议考核方式默认为0，选择为1weight2int(4)0群众评议考核权重，对应考核方式（应保存为小数格式）method3int(4)0关联部门测评考核方式默认为0，选择为1weight3int(4)0关联部门测评考核权重，对应考核方式（应保存为小数格式）method4int(4)0领导综合评价考核方式默认为0，选择为1weight4int(4)0领导综合评价考核权重，对应考核方式（应保存为小数格式）grade_idint(4)0考核等级表中的ID号object_iddecimal(11,0)NULL考核对象(可以是被考核人也可是被考核部门)appraisal_areatextNULL考核范围appraisal_starttimedatetimeNULL考核开始时间appraisal_endtimedatetimeNULL考核结束时间appraisal_flagint(4)1考核主题开关2：待发，1：开，0：关ex_ appraisal_ grade(考核等级表，由系统管理员设置修改)字段类型默认备注g_id(PK)decimal(11,0)0考核等级项目IDgrade_confignamevarchar(20)NULL考核等级项目配置名称grade_namevarchar(20)NULL考核等级项目名称grade_scoresint(4)0考核等级对应分数ex_ appraisal_ result (考核结果表)字段类型默认备注r_id(PK)decimal(11,0)0考核结果IDcreator_iddecimal(11,0)NULL考核发起者IDprocessor_iddecimal(11,0)NULL考核范围中的用户IDt_iddecimal(11,0)NULL考核主题IDmethod1_scoreint(4)0自评考核方式的考核分数method2_scoreint(4)0群众评议考核方式的考核分数method3_scoreint(4)0关联部门测评考核方式的考核分数method4_scoreint(4)0领导综合评价考核方式的考核分数grade_scoreint(4)0考核等级分数object_iddecimal(11,0)NULL考核对象IDappraisal _timedatetimedatetime考核时间appraisal _opinionsvarchar(255)NULL考核意见1.3.4 用户配置文件的存储规范对于要存储的用户配置文件，应存放与“usercfgextvote”的路径下其中usercfg的路径可以通过net.btdz.oa.tools.OAAppInfo.getInstance().getUserConfigPath()方法获取到“extvote”是需要插件编制者自己建立的，系统不会自动建立，而且在没有相应配置文件的情况下系统应该给这些设定一个缺省配置。1.4 插件配置说明在插件JSP路径根目录下必须有一个PlugIn.xml的文件，用于记录插件的相关信息，如 yyoaextvote PlugIn.xml1.4.1 PlugIn.xml 高校选评插件 插件的PlugIn.xml由PLAGIN_INFO和USER_DATA两大部分组成。PLAGIN_INFO是指插件的系统信息USER_DATA是插件的自定义信息下面是插件初始化类设定信息 高校选评插件 下面是系统管理员菜单定义信息下面是用户菜单定义信息插件自定义信息已经废弃，为固定的以下信息，不要更改1.4.2 标记说明l 标记描述插件的挂接信息l 标记描述插件的界面信息l 标记挂接菜单的信息MENUTYPE菜单类型 =”USERLEFT” 表示在用户登陆时左边的菜单栏中显示=”SYSTEMLEFT” 表示在系统管理员登陆时左边的菜单栏中显示MAINMENU主菜单的名称NAME菜单项的名称CHECKUSER检查用户是否可以显示本菜单项=”FALSE” 不检查都可以显示=TRUE 要检查，下面必须有CHECKUSER标记要检查用户可否显示菜单的类，这个类必须实现net.btdz.oa.plugIn .IPlugIn_CheckUser接口URL菜单的超链接信息l 标记系统信息l 标记系统初始化标记CLASSNAME系统初始化装载的类这个类必须实现net.btdz.oa.plugIn .IPlugIn_SystemInit接口l 描述插件自己的扩展信息,由用户自己定义(已经废弃，请用固定值填充)1.5 插件编码1.5.1 编写插件初始化类这是一个插件的例程。首先要求初始化类实现接口IPlugIn_SystemInit并且在PlugIn.xml的相应位置写上初始化类的名字这个类必须有不带参数的构建方法，不然插件管理器无法创建这个类的实例。接口的初始化方法其中红色部分是插件菜单的初始化代码。二、 选评模块插件的界面UI功能描述1选举模块界面UI功能描述1.1用户点击选举按钮后出现OA系统顶部菜单协同工作点击“更多”查看本区域的其它选举,点击待发列表可以查看当前没有发出的选举项目。点击选举标题进入该选举表单应用公文管理选举列表(属于用户自己的选举主题) 发起选举 待发列表 更多电子邮件选评选举1.2发起者点击发起选举后出现OA系统顶部菜单协同工作发起选举 保存待发 预览表单应用选举标题：文本框选举方式：下拉列表框选举说明：文本框，再加一个文件上传按钮电子资料：文本框，用于保存文件上传的相对路径，不可编辑，可为空选举名额:文本框，限数字选举范围：与OA系统一致开始时间：文本框加时间选择结束时间：文本框加时间选择公文管理电子邮件选评选举添加选举项目(点击一次在下面动态增加一个文本框)文本框 删除按钮1.3选举发起者点击选举主题后出现OA系统顶部菜单协同工作提交选举 统计选举表单应用选举标题：文本框(不可编辑)选举方式：下拉列表框选举说明：文本框(不可编辑)电子资料：URL链接选举名额：文本框(不可编辑)开始时间：文本框(不可编辑)结束时间：文本框(不可编辑)公文管理电子邮件选评选举选举项目列表(根据选举项中的类型确定为单选或者多选)选举项目1选举项目2选举项目31.4选举范围中的OA用户点击选举主题后出现OA系统顶部菜单协同工作提交选举 表单应用选举标题：文本框(不可编辑)选举方式：下拉列表框选举说明：文本框(不可编辑)电子资料：URL链接选举名额：文本框(不可编辑)开始时间：文本框(不可编辑)结束时间：文本框(不可编辑)公文管理电子邮件选评选举选举项目列表(根据选举项中的类型确定为单选或者多选)选举项目1选举项目2选举项目31.5选举发起者点击统计选举后出现OA系统顶部菜单协同工作统计选举表单应用选举结果统计表详细统计图表(根据选举主题表中的t_id为主键进行分表项目统计)公文管理电子邮件选评选举此部分开发说明:（1） 在ex_vote_topic(选举主题表)中的vote_type字段代表选举方式，根据值的不同处理不同的业务逻辑，0：投票，1：提名，2：不记名，3：记名。普通用户提交选举项目时进行不同的业务逻辑处理。（2） vote_area字段由选举范围中的用户ID号连接而成，多个用户ID用“、”分隔， OA用户在点击浏览选举主题的时候先检查自己的ID号是否在选举范围字段中，在的话才有权查看选举结果和进行选举投票。（3） vote_ flag代表当前选举主题开关和选举主题状态，可以由发起者设置主题开关状态，值为2时表示为保存待发，值为1时表示公开发起，值为0时表示选举主题关闭。（4） 点击发起选举时，提交整个表单数据，在程序中先接收所有数据，然后首先把数据插入选举主题表，之后，用插入的主题表ID再循环插入选举项目表中。（5） 普通OA用户点击选举按钮的时候首先检查用户是否在选举范围中，如果在选举范围中的话就读取此选举主题，点击选举主题可以详细查看选举内容并投票选举。（6） 选举发起者点击统计选举时用程序动态生成统计结果。2考核模块界面UI功能描述2.1用户点击考核按钮后出现OA系统顶部菜单协同工作点击“更多”查看本区域的其它考核,点击待发列表可以查看当前没有发出的考核主题。点击考核标题进入该考核主题表单应用公文管理考核主题列表(属于用户的考核主题) 发起考核 待发列表 更多电子邮件选评考核2.2发起者点击发起考核后出现OA系统顶部菜单协同工作发起考核 保存待发 预览表单应用考核名称：文本框考核内容：多行文本框，再加一个文件上传按钮电子资料：文本框，用于保存文件上传的相对路径，不可编辑，可为空考核方式：(复选框) 自评 自评权重,文本框设置 群众评议 群众评议权重,文本框设置 关联部门测评 关联部门测评权重,文本框设置领导综合评价 领导综合评价权重,文本框设置考核等级：下拉列表框考核对象：与OA系统一致(用户选择模块)选举范围：与OA系统一致(用户选择模块)开始时间：文本框加时间选择结束时间：文本框加时间选择公文管理电子邮件选评考核2.3考核发起者点击考核主题后出现OA系统顶部菜单协同工作提交考核 统计考核表单应用考核名称：文本框(不可编辑)考核内容：多行文本框(不可编辑)电子资料：URL链接考核方式：(根据勾选情况动态显示) 自评 自评得分,文本框输入 群众评议 群众评议得分,文本框输入 关联部门测评 关联部门测评得分,文本框输入领导综合评价 领导综合评价得分,文本框输入考核等级：下拉列表框选择考核对象：显示被考核人名字，文本框(不可编辑)考核意见：多行文本框输入公文管理电子邮件选评考核2.4参与考核者点击考核主题后出现OA系统顶部菜单协同工作提交考核表单应用考核名称：文本框(不可编辑)考核内容：多行文本框(不可编辑)电子资料：URL链接考核方式：(根据勾选情况动态显示) 自评 自评得分,文本框输入 群众评议 群众评议得分,文本框输入 关联部门测评 关联部门测评得分,文本框输入领导综合评价 领导综合评价得分,文本框输入考核等级：下拉列表框选择考核对象：显示被考核人名字，文本框(不可编辑)考核意见：多行文本框输入公文管理电子邮件选评考核2.5考核发起者点击统计考核后出现OA系统顶部菜单协同工作统计考核表单应用考核名称