NCV5-预警平台技术红皮书.doc

预警平台技术红皮书 NC-UAP 5.02 用友NC-UAP 2013-05-12 目 录 第一章 前言 1 第二章 预警类型注册 2 1. 功能简介 2 2. 操作说明 2 2.1 增加/编辑预警类型 2 2.2 关于多语的说明 4 第三章 预警条目注册 5 1. 功能简介 5 2. 操作说明 5 2.1 增加/编辑预警条目 5 2.2 复制预警条目 11 3. 其它 12 第四章 预警平台查询 13 第五章 插件开发指南 14 1. 简介及开发步骤 14 2. 预警平台业务插件接口 14 2.1 业务插件接口1 14 2.2 业务插件接口2 15 2.3 业务插件接口3 16 3. 返回格式化消息接口(可选) 16 3.1 实现切入点 16 3.2 术语解析 16 3.3 接口声明 17 4. 多语支持 18 4.1 预警类型注册的多语 18 4.2 预警消息文件的多语 18 第六章 程序实现举例 19 1. 业务插件举例 19 1.1 格式消息举例 21 第七章 系统环境配置 24 1. 调度引擎的配置 24 2. 邮件发送相关的配置 24 3. 消息文件存放路径 24 4. 预警日志 25 第八章 V5新特性及与以前版本区别 26 1. 系统登录的即时预警 26 2. 升级(从3.5-5.0) 26 2.1 升级的必要性 26 2.2 升级先决条件 26 2.3 升级操作 26 附录 28 1. 预警平台相关表 28 前言 现代企业要在激烈的市场竞争中生存并发展，就需要对自身的优势与缺陷都有一个清楚的了解，所谓知己知彼，企业要想在市场竞争中立于不败之地，就必须及时地发现自己的优势与缺陷，发挥自身的优势，弥补存在的缺陷，为企业的发展与壮大扫除障碍。 如何及时地发现自身的优势与缺陷，向来是企业界和理论界倾力研究的重点问题之一。于是NC的预警平台应求而生。NC预警平台分成两种类型的预警。一为定时预警。即用户可以指定何时或者以何周期去执行某项任务，并依照设置的阈值决定是否产生预警提示,致使企业及时合理做出正确的决策。二为即时预警。顾名思义即时是立即发生，NC中主要支持用户登录和打开节点两种，所作事情与定时预警一样。 NC预警服务的整体示意图如图1-1. 图1-1预警平台服务示意图 由上图可知，预警平台主要由预警类型、预警条目以及预警消息三个组成部分。于是想要使用预警平台的预警功能，需要做两步工作：1.预警类型注册；2.预警条目注册。分别在本文档第二章和第三章介绍。预警消息是在条目配置的时候配置的。 注意：从V502开始，预警平台功能并入任务中心。  预警类型注册 功能简介 预警类型就是一种预警的一个插件类型（由开发人员开发，具体如何开发插件见插件开发指南）。它目的是对某个业务或操作的抽象，其可以定义一系列阈值。(这里也只是定义，真正的值还是由条目来设置的)。 定义一个预警类型需要提供：名称、所属系统、业务插件、描述、阈值名称、编辑类型、参照名称(如果编辑类型为参照)。 操作说明 打开节点:[客户化]-[预警平台]-[预警条件配置] 鼠标指向“类型配置”菜单，单击增加，可以增加一个预警类型。 选中一条已注册的预警类型，单击“删除”、“编辑”，可以对已有预警类型进行删除或修改的操作。双击一条预警类型，也可以对其进行编辑。 图2-1预警首界面 增加/编辑预警类型 增加/编辑一个预警类型，预警类型编辑界面如下图所示： 图2-2预警类型编辑界面 项目说明： 名称：输入预警类型的名称。必填项。 所属模块：是区分各产品组模块的标识，即通常说的模块名。这值对应的是中间件/modules目录下的子目录。按规定模块名都是小写的。必填项。 业务插件：输入业务插件的类名，此项不能为空。此类中需实现预警平台接口。且可以放在业务模块中任何地方(即不限制Public/Client/Private).该类遵循开发规范见插件开发指南。必填项。 描述：指对预警类型的文字描述。 阈值名称：也就是条件的名称。阈值含义：对阈值名称的说明。 编辑类型：此处定义输入阈值的样式，系统提供五个选择：字符型、逻辑型、整型、Double型和参照基础档案类型。如果将某个阈值的编辑类型定义为逻辑型，那么在进行预警条目设置时，此阈值的值以下拉框的形式出现，有是和否两个选择；如果选择编辑类型为基础档案，还要在后面的参照名称栏中选择参照哪个基础档案，这样当用户输入该阈值时会弹出相应的基础档案参照。 参照名称：如果编辑类型选择为参照基础档案，那么参数名称变为可选项，提供选择的项有人员档案、部门档案、客户档案等等。 关于多语的说明 这里指对NC预置的插件支持多语，对于后来增加的没有这个支持。想多了解多语的这一特性，参见高级操作。  预警条目注册 功能简介 预警条目一般由实施人员